r17886: add talloc_ptrtype() and talloc_array_ptrtype(),
[samba.git] / source / 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      ** NOTE! The following LGPL license applies to the talloc
10      ** library. This does NOT imply that all of Samba is released
11      ** under the LGPL
12    
13    This library is free software; you can redistribute it and/or
14    modify it under the terms of the GNU Lesser General Public
15    License as published by the Free Software Foundation; either
16    version 2 of the License, or (at your option) any later version.
17
18    This library is distributed in the hope that it will be useful,
19    but WITHOUT ANY WARRANTY; without even the implied warranty of
20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
21    Lesser General Public License for more details.
22
23    You should have received a copy of the GNU Lesser General Public
24    License along with this library; if not, write to the Free Software
25    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 */
27
28 /* this is only needed for compatibility with the old talloc */
29 typedef void TALLOC_CTX;
30
31 /*
32   this uses a little trick to allow __LINE__ to be stringified
33 */
34 #define _STRING_LINE_(s)    #s
35 #define _STRING_LINE2_(s)   _STRING_LINE_(s)
36 #define __LINESTR__       _STRING_LINE2_(__LINE__)
37 #define __location__ __FILE__ ":" __LINESTR__
38
39 #ifndef TALLOC_DEPRECATED
40 #define TALLOC_DEPRECATED 0
41 #endif
42
43 #ifndef PRINTF_ATTRIBUTE
44 #if (__GNUC__ >= 3)
45 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
46  * the parameter containing the format, and a2 the index of the first
47  * argument. Note that some gcc 2.x versions don't handle this
48  * properly **/
49 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
50 #else
51 #define PRINTF_ATTRIBUTE(a1, a2)
52 #endif
53 #endif
54
55 /* try to make talloc_set_destructor() and talloc_steal() type safe,
56    if we have a recent gcc */
57 #if (__GNUC__ >= 3)
58 #define _TALLOC_TYPEOF(ptr) __typeof__(ptr)
59 #define talloc_set_destructor(ptr, function)                                  \
60         do {                                                                  \
61                 int (*_talloc_destructor_fn)(_TALLOC_TYPEOF(ptr)) = (function);       \
62                 _talloc_set_destructor((ptr), (void *)_talloc_destructor_fn); \
63         } while(0)
64 /* this extremely strange macro is to avoid some braindamaged warning
65    stupidity in gcc 4.1.x */
66 #define talloc_steal(ctx, ptr) ({ _TALLOC_TYPEOF(ptr) __talloc_steal_ret = (_TALLOC_TYPEOF(ptr))_talloc_steal((ctx),(ptr)); __talloc_steal_ret; })
67 #else
68 #define talloc_set_destructor(ptr, function) \
69         _talloc_set_destructor((ptr), (int (*)(void *))(function))
70 #define _TALLOC_TYPEOF(ptr) void *
71 #define talloc_steal(ctx, ptr) (_TALLOC_TYPEOF(ptr))_talloc_steal((ctx),(ptr))
72 #endif
73
74 /* useful macros for creating type checked pointers */
75 #define talloc(ctx, type) (type *)talloc_named_const(ctx, sizeof(type), #type)
76 #define talloc_size(ctx, size) talloc_named_const(ctx, size, __location__)
77 #define talloc_ptrtype(ctx, ptr) (_TALLOC_TYPEOF(ptr))talloc_size(ctx, sizeof(*(ptr)))
78
79 #define talloc_new(ctx) talloc_named_const(ctx, 0, "talloc_new: " __location__)
80
81 #define talloc_zero(ctx, type) (type *)_talloc_zero(ctx, sizeof(type), #type)
82 #define talloc_zero_size(ctx, size) _talloc_zero(ctx, size, __location__)
83
84 #define talloc_zero_array(ctx, type, count) (type *)_talloc_zero_array(ctx, sizeof(type), count, #type)
85 #define talloc_array(ctx, type, count) (type *)_talloc_array(ctx, sizeof(type), count, #type)
86 #define talloc_array_size(ctx, size, count) _talloc_array(ctx, size, count, __location__)
87 #define talloc_array_ptrtype(ctx, ptr, count) (_TALLOC_TYPEOF(ptr))talloc_array_size(ctx, sizeof(*(ptr)), count)
88
89 #define talloc_realloc(ctx, p, type, count) (type *)_talloc_realloc_array(ctx, p, sizeof(type), count, #type)
90 #define talloc_realloc_size(ctx, ptr, size) _talloc_realloc(ctx, ptr, size, __location__)
91
92 #define talloc_memdup(t, p, size) _talloc_memdup(t, p, size, __location__)
93
94 #define talloc_set_type(ptr, type) talloc_set_name_const(ptr, #type)
95 #define talloc_get_type(ptr, type) (type *)talloc_check_name(ptr, #type)
96
97 #define talloc_find_parent_bytype(ptr, type) (type *)talloc_find_parent_byname(ptr, #type)
98
99 #if TALLOC_DEPRECATED
100 #define talloc_zero_p(ctx, type) talloc_zero(ctx, type)
101 #define talloc_p(ctx, type) talloc(ctx, type)
102 #define talloc_array_p(ctx, type, count) talloc_array(ctx, type, count)
103 #define talloc_realloc_p(ctx, p, type, count) talloc_realloc(ctx, p, type, count)
104 #define talloc_destroy(ctx) talloc_free(ctx)
105 #endif
106
107 /* The following definitions come from talloc.c  */
108 void *_talloc(const void *context, size_t size);
109 void _talloc_set_destructor(const void *ptr, int (*destructor)(void *));
110 void talloc_increase_ref_count(const void *ptr);
111 void *talloc_reference(const void *context, const void *ptr);
112 int talloc_unlink(const void *context, void *ptr);
113 const char *talloc_set_name(const void *ptr, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
114 void talloc_set_name_const(const void *ptr, const char *name);
115 void *talloc_named(const void *context, size_t size, 
116                    const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
117 void *talloc_named_const(const void *context, size_t size, const char *name);
118 const char *talloc_get_name(const void *ptr);
119 void *talloc_check_name(const void *ptr, const char *name);
120 void talloc_report_depth(const void *ptr, FILE *f, int depth);
121 void *talloc_parent(const void *ptr);
122 void *talloc_init(const char *fmt, ...) PRINTF_ATTRIBUTE(1,2);
123 int talloc_free(void *ptr);
124 void talloc_free_children(void *ptr);
125 void *_talloc_realloc(const void *context, void *ptr, size_t size, const char *name);
126 void *_talloc_steal(const void *new_ctx, const void *ptr);
127 size_t talloc_total_size(const void *ptr);
128 size_t talloc_total_blocks(const void *ptr);
129 void talloc_report_full(const void *ptr, FILE *f);
130 void talloc_report(const void *ptr, FILE *f);
131 void talloc_enable_null_tracking(void);
132 void talloc_enable_leak_report(void);
133 void talloc_enable_leak_report_full(void);
134 void *_talloc_zero(const void *ctx, size_t size, const char *name);
135 void *_talloc_memdup(const void *t, const void *p, size_t size, const char *name);
136 char *talloc_strdup(const void *t, const char *p);
137 char *talloc_strndup(const void *t, const char *p, size_t n);
138 char *talloc_append_string(const void *t, char *orig, const char *append);
139 char *talloc_vasprintf(const void *t, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
140 char *talloc_vasprintf_append(char *s, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
141 char *talloc_asprintf(const void *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
142 char *talloc_asprintf_append(char *s,
143                              const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
144 void *_talloc_array(const void *ctx, size_t el_size, unsigned count, const char *name);
145 void *_talloc_zero_array(const void *ctx, size_t el_size, unsigned count, const char *name);
146 void *_talloc_realloc_array(const void *ctx, void *ptr, size_t el_size, unsigned count, const char *name);
147 void *talloc_realloc_fn(const void *context, void *ptr, size_t size);
148 void *talloc_autofree_context(void);
149 size_t talloc_get_size(const void *ctx);
150 void *talloc_find_parent_byname(const void *ctx, const char *name);
151 void talloc_show_parents(const void *context, FILE *file);
152 int talloc_is_parent(const void *context, const char *ptr);
153
154 #endif
155