options: support --leak-report (double dash form)
[mplayer.git] / talloc.h
blob8c6d4050405a59d9f6eee100875955e6b1fb892b
1 #ifndef _TALLOC_H_
2 #define _TALLOC_H_
3 /*
4 Unix SMB/CIFS implementation.
5 Samba temporary memory allocation functions
7 Copyright (C) Andrew Tridgell 2004-2005
8 Copyright (C) Stefan Metzmacher 2006
10 ** NOTE! The following LGPL license applies to the talloc
11 ** library. This does NOT imply that all of Samba is released
12 ** under the LGPL
14 This library is free software; you can redistribute it and/or
15 modify it under the terms of the GNU Lesser General Public
16 License as published by the Free Software Foundation; either
17 version 3 of the License, or (at your option) any later version.
19 This library is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 Lesser General Public License for more details.
24 You should have received a copy of the GNU Lesser General Public
25 License along with this library; if not, see <http://www.gnu.org/licenses/>.
28 #include <stdlib.h>
29 #include <stdio.h>
30 #include <stdarg.h>
32 /* HACK: libsmbclient uses dynamically linked libtalloc.so which has
33 * identically named symbols. This name collision caused a crash under
34 * stream_smb when trying to play anything with smb://. This hack
35 * prevents the symbols declared here from being visible to outside
36 * shared libraries and fixes the crash.
38 #pragma GCC visibility push(hidden)
40 /* this is only needed for compatibility with the old talloc */
41 typedef void TALLOC_CTX;
44 this uses a little trick to allow __LINE__ to be stringified
46 #ifndef __location__
47 #define __TALLOC_STRING_LINE1__(s) #s
48 #define __TALLOC_STRING_LINE2__(s) __TALLOC_STRING_LINE1__(s)
49 #define __TALLOC_STRING_LINE3__ __TALLOC_STRING_LINE2__(__LINE__)
50 #define __location__ __FILE__ ":" __TALLOC_STRING_LINE3__
51 #endif
53 #ifndef TALLOC_DEPRECATED
54 #define TALLOC_DEPRECATED 0
55 #endif
57 #ifndef PRINTF_ATTRIBUTE
58 #if (__GNUC__ >= 3)
59 /** Use gcc attribute to check printf fns. a1 is the 1-based index of
60 * the parameter containing the format, and a2 the index of the first
61 * argument. Note that some gcc 2.x versions don't handle this
62 * properly **/
63 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
64 #else
65 #define PRINTF_ATTRIBUTE(a1, a2)
66 #endif
67 #endif
69 /* try to make talloc_set_destructor() and talloc_steal() type safe,
70 if we have a recent gcc */
71 #if (__GNUC__ >= 3)
72 #define _TALLOC_TYPEOF(ptr) __typeof__(ptr)
73 #define talloc_set_destructor(ptr, function) \
74 do { \
75 int (*_talloc_destructor_fn)(_TALLOC_TYPEOF(ptr)) = (function); \
76 _talloc_set_destructor((ptr), (int (*)(void *))_talloc_destructor_fn); \
77 } while(0)
78 /* this extremely strange macro is to avoid some braindamaged warning
79 stupidity in gcc 4.1.x */
80 #define talloc_steal(ctx, ptr) ({ _TALLOC_TYPEOF(ptr) __talloc_steal_ret = (_TALLOC_TYPEOF(ptr))_talloc_steal((ctx),(ptr)); __talloc_steal_ret; })
81 #else
82 #define talloc_set_destructor(ptr, function) \
83 _talloc_set_destructor((ptr), (int (*)(void *))(function))
84 #define _TALLOC_TYPEOF(ptr) void *
85 #define talloc_steal(ctx, ptr) (_TALLOC_TYPEOF(ptr))_talloc_steal((ctx),(ptr))
86 #endif
88 #define talloc_reference(ctx, ptr) (_TALLOC_TYPEOF(ptr))_talloc_reference((ctx),(ptr))
89 #define talloc_move(ctx, ptr) (_TALLOC_TYPEOF(*(ptr)))_talloc_move((ctx),(void *)(ptr))
91 /* useful macros for creating type checked pointers */
92 #define talloc(ctx, type) (type *)talloc_named_const(ctx, sizeof(type), #type)
93 #define talloc_size(ctx, size) talloc_named_const(ctx, size, __location__)
94 #define talloc_ptrtype(ctx, ptr) (_TALLOC_TYPEOF(ptr))talloc_size(ctx, sizeof(*(ptr)))
96 #define talloc_new(ctx) talloc_named_const(ctx, 0, "talloc_new: " __location__)
98 #define talloc_zero(ctx, type) (type *)_talloc_zero(ctx, sizeof(type), #type)
99 #define talloc_zero_size(ctx, size) _talloc_zero(ctx, size, __location__)
101 #define talloc_zero_array(ctx, type, count) (type *)_talloc_zero_array(ctx, sizeof(type), count, #type)
102 #define talloc_array(ctx, type, count) (type *)_talloc_array(ctx, sizeof(type), count, #type)
103 #define talloc_array_size(ctx, size, count) _talloc_array(ctx, size, count, __location__)
104 #define talloc_array_ptrtype(ctx, ptr, count) (_TALLOC_TYPEOF(ptr))talloc_array_size(ctx, sizeof(*(ptr)), count)
106 #define talloc_realloc(ctx, p, type, count) (type *)_talloc_realloc_array(ctx, p, sizeof(type), count, #type)
107 #define talloc_realloc_size(ctx, ptr, size) _talloc_realloc(ctx, ptr, size, __location__)
109 #define talloc_memdup(t, p, size) _talloc_memdup(t, p, size, __location__)
111 #define talloc_set_type(ptr, type) talloc_set_name_const(ptr, #type)
112 #define talloc_get_type(ptr, type) (type *)talloc_check_name(ptr, #type)
114 #define talloc_find_parent_bytype(ptr, type) (type *)talloc_find_parent_byname(ptr, #type)
116 #if TALLOC_DEPRECATED
117 #define talloc_zero_p(ctx, type) talloc_zero(ctx, type)
118 #define talloc_p(ctx, type) talloc(ctx, type)
119 #define talloc_array_p(ctx, type, count) talloc_array(ctx, type, count)
120 #define talloc_realloc_p(ctx, p, type, count) talloc_realloc(ctx, p, type, count)
121 #define talloc_destroy(ctx) talloc_free(ctx)
122 #define talloc_append_string(c, s, a) (s?talloc_strdup_append(s,a):talloc_strdup(c, a))
123 #endif
125 /* The following definitions come from talloc.c */
126 void *_talloc(const void *context, size_t size);
127 void *talloc_pool(const void *context, size_t size);
128 void _talloc_set_destructor(const void *ptr, int (*destructor)(void *));
129 int talloc_increase_ref_count(const void *ptr);
130 size_t talloc_reference_count(const void *ptr);
131 void *_talloc_reference(const void *context, const void *ptr);
132 int talloc_unlink(const void *context, void *ptr);
133 const char *talloc_set_name(const void *ptr, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
134 void talloc_set_name_const(const void *ptr, const char *name);
135 void *talloc_named(const void *context, size_t size,
136 const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
137 void *talloc_named_const(const void *context, size_t size, const char *name);
138 const char *talloc_get_name(const void *ptr);
139 void *talloc_check_name(const void *ptr, const char *name);
140 void *talloc_parent(const void *ptr);
141 const char *talloc_parent_name(const void *ptr);
142 void *talloc_init(const char *fmt, ...) PRINTF_ATTRIBUTE(1,2);
143 int talloc_free(void *ptr);
144 void talloc_free_children(void *ptr);
145 void *_talloc_realloc(const void *context, void *ptr, size_t size, const char *name);
146 void *_talloc_steal(const void *new_ctx, const void *ptr);
147 void *_talloc_move(const void *new_ctx, const void *pptr);
148 size_t talloc_total_size(const void *ptr);
149 size_t talloc_total_blocks(const void *ptr);
150 void talloc_report_depth_cb(const void *ptr, int depth, int max_depth,
151 void (*callback)(const void *ptr,
152 int depth, int max_depth,
153 int is_ref,
154 void *private_data),
155 void *private_data);
156 void talloc_report_depth_file(const void *ptr, int depth, int max_depth, FILE *f);
157 void talloc_report_full(const void *ptr, FILE *f);
158 void talloc_report(const void *ptr, FILE *f);
159 void talloc_enable_null_tracking(void);
160 void talloc_disable_null_tracking(void);
161 void talloc_enable_leak_report(void);
162 void talloc_enable_leak_report_full(void);
163 void *_talloc_zero(const void *ctx, size_t size, const char *name);
164 void *_talloc_memdup(const void *t, const void *p, size_t size, const char *name);
165 void *_talloc_array(const void *ctx, size_t el_size, unsigned count, const char *name);
166 void *_talloc_zero_array(const void *ctx, size_t el_size, unsigned count, const char *name);
167 void *_talloc_realloc_array(const void *ctx, void *ptr, size_t el_size, unsigned count, const char *name);
168 void *talloc_realloc_fn(const void *context, void *ptr, size_t size);
169 void *talloc_autofree_context(void);
170 size_t talloc_get_size(const void *ctx);
171 void *talloc_find_parent_byname(const void *ctx, const char *name);
172 void talloc_show_parents(const void *context, FILE *file);
173 int talloc_is_parent(const void *context, const void *ptr);
175 char *talloc_strdup(const void *t, const char *p);
176 char *talloc_strdup_append(char *s, const char *a);
177 char *talloc_strdup_append_buffer(char *s, const char *a);
179 char *talloc_strndup(const void *t, const char *p, size_t n);
180 char *talloc_strndup_append(char *s, const char *a, size_t n);
181 char *talloc_strndup_append_buffer(char *s, const char *a, size_t n);
183 char *talloc_vasprintf(const void *t, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
184 char *talloc_vasprintf_append(char *s, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
185 char *talloc_vasprintf_append_buffer(char *s, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
187 char *talloc_asprintf(const void *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
188 char *talloc_asprintf_append(char *s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
189 char *talloc_asprintf_append_buffer(char *s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
191 // end of visibility hack from above
192 #pragma GCC visibility pop
193 #endif