Add boot_option_copy routine
[petitboot] / lib / talloc / talloc.h
1 #ifndef _TALLOC_H_
2 #define _TALLOC_H_
3 /*
4    Unix SMB/CIFS implementation.
5    Samba temporary memory allocation functions
6
7    Copyright (C) Andrew Tridgell 2004-2005
8
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 2 of the License, or
12    (at your option) any later version.
13
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18
19    You should have received a copy of the GNU General Public License
20    along with this program; if not, write to the Free Software
21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 */
23
24 /* petitboot additions */
25 #include <stdarg.h>
26 #include <stdio.h>
27 #include <unistd.h>
28
29 /* this is only needed for compatibility with the old talloc */
30 typedef void TALLOC_CTX;
31
32 /*
33   this uses a little trick to allow __LINE__ to be stringified
34 */
35 #define _STRING_LINE_(s)    #s
36 #define _STRING_LINE2_(s)   _STRING_LINE_(s)
37 #define __LINESTR__       _STRING_LINE2_(__LINE__)
38 #define __location__ __FILE__ ":" __LINESTR__
39
40 #ifndef TALLOC_DEPRECATED
41 #define TALLOC_DEPRECATED 0
42 #endif
43
44 /* useful macros for creating type checked pointers */
45 #define talloc(ctx, type) (type *)talloc_named_const(ctx, sizeof(type), #type)
46 #define talloc_size(ctx, size) talloc_named_const(ctx, size, __location__)
47
48 #define talloc_new(ctx) talloc_named_const(ctx, 0, "talloc_new: " __location__)
49
50 #define talloc_zero(ctx, type) (type *)_talloc_zero(ctx, sizeof(type), #type)
51 #define talloc_zero_size(ctx, size) _talloc_zero(ctx, size, __location__)
52
53 #define talloc_zero_array(ctx, type, count) (type *)_talloc_zero_array(ctx, sizeof(type), count, #type)
54 #define talloc_array(ctx, type, count) (type *)_talloc_array(ctx, sizeof(type), count, #type)
55 #define talloc_array_size(ctx, size, count) _talloc_array(ctx, size, count, __location__)
56
57 #define talloc_realloc(ctx, p, type, count) (type *)_talloc_realloc_array(ctx, p, sizeof(type), count, #type)
58 #define talloc_realloc_size(ctx, ptr, size) _talloc_realloc(ctx, ptr, size, __location__)
59
60 #define talloc_memdup(t, p, size) _talloc_memdup(t, p, size, __location__)
61
62 #define malloc_p(type) (type *)malloc(sizeof(type))
63 #define malloc_array_p(type, count) (type *)realloc_array(NULL, sizeof(type), count)
64 #define realloc_p(p, type, count) (type *)realloc_array(p, sizeof(type), count)
65
66 #define data_blob(ptr, size) data_blob_named(ptr, size, "DATA_BLOB: "__location__)
67 #define data_blob_talloc(ctx, ptr, size) data_blob_talloc_named(ctx, ptr, size, "DATA_BLOB: "__location__)
68 #define data_blob_dup_talloc(ctx, blob) data_blob_talloc_named(ctx, (blob)->data, (blob)->length, "DATA_BLOB: "__location__)
69
70 #define talloc_set_type(ptr, type) talloc_set_name_const(ptr, #type)
71 #define talloc_get_type(ptr, type) (type *)talloc_check_name(ptr, #type)
72
73
74 #if TALLOC_DEPRECATED
75 #define talloc_zero_p(ctx, type) talloc_zero(ctx, type)
76 #define talloc_p(ctx, type) talloc(ctx, type)
77 #define talloc_array_p(ctx, type, count) talloc_array(ctx, type, count)
78 #define talloc_realloc_p(ctx, p, type, count) talloc_realloc(ctx, p, type, count)
79 #define talloc_destroy(ctx) talloc_free(ctx)
80 #endif
81
82 #ifndef PRINTF_ATTRIBUTE
83 #if (__GNUC__ >= 3)
84 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
85  * the parameter containing the format, and a2 the index of the first
86  * argument. Note that some gcc 2.x versions don't handle this
87  * properly **/
88 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
89 #else
90 #define PRINTF_ATTRIBUTE(a1, a2)
91 #endif
92 #endif
93
94
95 /* The following definitions come from talloc.c  */
96 void *_talloc(const void *context, size_t size);
97 void talloc_set_destructor(const void *ptr, int (*destructor)(void *));
98 void talloc_increase_ref_count(const void *ptr);
99 void *talloc_reference(const void *context, const void *ptr);
100 int talloc_unlink(const void *context, void *ptr);
101 void talloc_set_name(const void *ptr, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
102 void talloc_set_name_const(const void *ptr, const char *name);
103 void *talloc_named(const void *context, size_t size,
104                    const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
105 void *talloc_named_const(const void *context, size_t size, const char *name);
106 const char *talloc_get_name(const void *ptr);
107 void *talloc_check_name(const void *ptr, const char *name);
108 void talloc_report_depth(const void *ptr, FILE *f, int depth);
109 void *talloc_parent(const void *ptr);
110 void *talloc_init(const char *fmt, ...) PRINTF_ATTRIBUTE(1,2);
111 int talloc_free(void *ptr);
112 void *_talloc_realloc(const void *context, void *ptr, size_t size, const char *name);
113 void *talloc_steal(const void *new_ctx, const void *ptr);
114 off_t talloc_total_size(const void *ptr);
115 off_t talloc_total_blocks(const void *ptr);
116 void talloc_report_full(const void *ptr, FILE *f);
117 void talloc_report(const void *ptr, FILE *f);
118 void talloc_enable_null_tracking(void);
119 void talloc_enable_leak_report(void);
120 void talloc_enable_leak_report_full(void);
121 void *_talloc_zero(const void *ctx, size_t size, const char *name);
122 void *_talloc_memdup(const void *t, const void *p, size_t size, const char *name);
123 char *talloc_strdup(const void *t, const char *p);
124 char *talloc_strndup(const void *t, const char *p, size_t n);
125 char *talloc_vasprintf(const void *t, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
126 char *talloc_asprintf(const void *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
127 char *talloc_asprintf_append(char *s,
128                              const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
129 void *_talloc_array(const void *ctx, size_t el_size, unsigned count, const char *name);
130 void *_talloc_zero_array(const void *ctx, size_t el_size, unsigned count, const char *name);
131 void *_talloc_realloc_array(const void *ctx, void *ptr, size_t el_size, unsigned count, const char *name);
132 void *talloc_realloc_fn(const void *context, void *ptr, size_t size);
133 void *talloc_autofree_context(void);
134 size_t talloc_get_size(const void *ctx);
135
136 #endif
137