libosmocore  0.9.3
Osmocom core library
talloc.h
1 #pragma once
2 /*
3  Unix SMB/CIFS implementation.
4  Samba temporary memory allocation functions
5 
6  Copyright (C) Andrew Tridgell 2004-2005
7  Copyright (C) Stefan Metzmacher 2006
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 3 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, see <http://www.gnu.org/licenses/>.
25 */
26 
27 #include <stdlib.h>
28 #include <stdio.h>
29 #include <stdarg.h>
30 
31 #define HAVE_VA_COPY
32 
33 /* this is only needed for compatibility with the old talloc */
34 typedef void TALLOC_CTX;
35 
36 /*
37  this uses a little trick to allow __LINE__ to be stringified
38 */
39 #ifndef __location__
40 #define __TALLOC_STRING_LINE1__(s) #s
41 #define __TALLOC_STRING_LINE2__(s) __TALLOC_STRING_LINE1__(s)
42 #define __TALLOC_STRING_LINE3__ __TALLOC_STRING_LINE2__(__LINE__)
43 #define __location__ __FILE__ ":" __TALLOC_STRING_LINE3__
44 #endif
45 
46 #ifndef TALLOC_DEPRECATED
47 #define TALLOC_DEPRECATED 0
48 #endif
49 
50 #ifndef PRINTF_ATTRIBUTE
51 #if (__GNUC__ >= 3)
52 
56 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
57 #else
58 #define PRINTF_ATTRIBUTE(a1, a2)
59 #endif
60 #endif
61 
62 /* try to make talloc_set_destructor() and talloc_steal() type safe,
63  if we have a recent gcc */
64 #if (__GNUC__ >= 3)
65 #define _TALLOC_TYPEOF(ptr) __typeof__(ptr)
66 #define talloc_set_destructor(ptr, function) \
67  do { \
68  int (*_talloc_destructor_fn)(_TALLOC_TYPEOF(ptr)) = (function); \
69  _talloc_set_destructor((ptr), (int (*)(void *))_talloc_destructor_fn); \
70  } while(0)
71 /* this extremely strange macro is to avoid some braindamaged warning
72  stupidity in gcc 4.1.x */
73 #define talloc_steal(ctx, ptr) ({ _TALLOC_TYPEOF(ptr) __talloc_steal_ret = (_TALLOC_TYPEOF(ptr))_talloc_steal((ctx),(ptr)); __talloc_steal_ret; })
74 #else
75 #define talloc_set_destructor(ptr, function) \
76  _talloc_set_destructor((ptr), (int (*)(void *))(function))
77 #define _TALLOC_TYPEOF(ptr) void *
78 #define talloc_steal(ctx, ptr) (_TALLOC_TYPEOF(ptr))_talloc_steal((ctx),(ptr))
79 #endif
80 
81 #define talloc_reference(ctx, ptr) (_TALLOC_TYPEOF(ptr))_talloc_reference((ctx),(ptr))
82 #define talloc_move(ctx, ptr) (_TALLOC_TYPEOF(*(ptr)))_talloc_move((ctx),(void *)(ptr))
83 
84 /* useful macros for creating type checked pointers */
85 #define talloc(ctx, type) (type *)talloc_named_const(ctx, sizeof(type), #type)
86 #define talloc_size(ctx, size) talloc_named_const(ctx, size, __location__)
87 #define talloc_ptrtype(ctx, ptr) (_TALLOC_TYPEOF(ptr))talloc_size(ctx, sizeof(*(ptr)))
88 
89 #define talloc_new(ctx) talloc_named_const(ctx, 0, "talloc_new: " __location__)
90 
91 #define talloc_zero(ctx, type) (type *)_talloc_zero(ctx, sizeof(type), #type)
92 #define talloc_zero_size(ctx, size) _talloc_zero(ctx, size, __location__)
93 
94 #define talloc_zero_array(ctx, type, count) (type *)_talloc_zero_array(ctx, sizeof(type), count, #type)
95 #define talloc_array(ctx, type, count) (type *)_talloc_array(ctx, sizeof(type), count, #type)
96 #define talloc_array_size(ctx, size, count) _talloc_array(ctx, size, count, __location__)
97 #define talloc_array_ptrtype(ctx, ptr, count) (_TALLOC_TYPEOF(ptr))talloc_array_size(ctx, sizeof(*(ptr)), count)
98 #define talloc_array_length(ctx) (talloc_get_size(ctx)/sizeof(*ctx))
99 
100 #define talloc_realloc(ctx, p, type, count) (type *)_talloc_realloc_array(ctx, p, sizeof(type), count, #type)
101 #define talloc_realloc_size(ctx, ptr, size) _talloc_realloc(ctx, ptr, size, __location__)
102 
103 #define talloc_memdup(t, p, size) _talloc_memdup(t, p, size, __location__)
104 
105 #define talloc_set_type(ptr, type) talloc_set_name_const(ptr, #type)
106 #define talloc_get_type(ptr, type) (type *)talloc_check_name(ptr, #type)
107 #define talloc_get_type_abort(ptr, type) (type *)_talloc_get_type_abort(ptr, #type, __location__)
108 
109 #define talloc_find_parent_bytype(ptr, type) (type *)talloc_find_parent_byname(ptr, #type)
110 
111 #if TALLOC_DEPRECATED
112 #define talloc_zero_p(ctx, type) talloc_zero(ctx, type)
113 #define talloc_p(ctx, type) talloc(ctx, type)
114 #define talloc_array_p(ctx, type, count) talloc_array(ctx, type, count)
115 #define talloc_realloc_p(ctx, p, type, count) talloc_realloc(ctx, p, type, count)
116 #define talloc_destroy(ctx) talloc_free(ctx)
117 #define talloc_append_string(c, s, a) (s?talloc_strdup_append(s,a):talloc_strdup(c, a))
118 #endif
119 
120 #define TALLOC_FREE(ctx) do { talloc_free(ctx); ctx=NULL; } while(0)
121 
122 /* The following definitions come from talloc.c */
123 void *_talloc(const void *context, size_t size);
124 void *talloc_pool(const void *context, size_t size);
125 void _talloc_set_destructor(const void *ptr, int (*_destructor)(void *));
126 int talloc_increase_ref_count(const void *ptr);
127 size_t talloc_reference_count(const void *ptr);
128 void *_talloc_reference(const void *context, const void *ptr);
129 int talloc_unlink(const void *context, void *ptr);
130 const char *talloc_set_name(const void *ptr, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
131 void talloc_set_name_const(const void *ptr, const char *name);
132 void *talloc_named(const void *context, size_t size,
133  const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
134 void *talloc_named_const(const void *context, size_t size, const char *name);
135 const char *talloc_get_name(const void *ptr);
136 void *talloc_check_name(const void *ptr, const char *name);
137 void *_talloc_get_type_abort(const void *ptr, const char *name, const char *location);
138 void *talloc_parent(const void *ptr);
139 const char *talloc_parent_name(const void *ptr);
140 void *talloc_init(const char *fmt, ...) PRINTF_ATTRIBUTE(1,2);
141 int talloc_free(void *ptr);
142 void talloc_free_children(void *ptr);
143 void *_talloc_realloc(const void *context, void *ptr, size_t size, const char *name);
144 void *_talloc_steal(const void *new_ctx, const void *ptr);
145 void *_talloc_move(const void *new_ctx, const void *pptr);
146 size_t talloc_total_size(const void *ptr);
147 size_t talloc_total_blocks(const void *ptr);
148 void talloc_report_depth_cb(const void *ptr, int depth, int max_depth,
149  void (*callback)(const void *ptr,
150  int depth, int max_depth,
151  int is_ref,
152  void *private_data),
153  void *private_data);
154 void talloc_report_depth_file(const void *ptr, int depth, int max_depth, FILE *f);
155 void talloc_report_full(const void *ptr, FILE *f);
156 void talloc_report(const void *ptr, FILE *f);
157 void talloc_enable_null_tracking(void);
158 void talloc_disable_null_tracking(void);
159 void talloc_enable_leak_report(void);
160 void talloc_enable_leak_report_full(void);
161 void *_talloc_zero(const void *ctx, size_t size, const char *name);
162 void *_talloc_memdup(const void *t, const void *p, size_t size, const char *name);
163 void *_talloc_array(const void *ctx, size_t el_size, unsigned count, const char *name);
164 void *_talloc_zero_array(const void *ctx, size_t el_size, unsigned count, const char *name);
165 void *_talloc_realloc_array(const void *ctx, void *ptr, size_t el_size, unsigned count, const char *name);
166 void *talloc_realloc_fn(const void *context, void *ptr, size_t size);
167 void *talloc_autofree_context(void);
168 size_t talloc_get_size(const void *ctx);
169 void *talloc_find_parent_byname(const void *ctx, const char *name);
170 void talloc_show_parents(const void *context, FILE *file);
171 int talloc_is_parent(const void *context, const void *ptr);
172 
173 char *talloc_strdup(const void *t, const char *p);
174 char *talloc_strdup_append(char *s, const char *a);
175 char *talloc_strdup_append_buffer(char *s, const char *a);
176 
177 char *talloc_strndup(const void *t, const char *p, size_t n);
178 char *talloc_strndup_append(char *s, const char *a, size_t n);
179 char *talloc_strndup_append_buffer(char *s, const char *a, size_t n);
180 
181 char *talloc_vasprintf(const void *t, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
182 char *talloc_vasprintf_append(char *s, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
183 char *talloc_vasprintf_append_buffer(char *s, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
184 
185 char *talloc_asprintf(const void *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
186 char *talloc_asprintf_append(char *s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
187 char *talloc_asprintf_append_buffer(char *s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
188 
189 void talloc_set_abort_fn(void (*abort_fn)(const char *reason));
uint16_t size
max number of messages to store
Definition: strrb.h:42