libosmocore  0.9.3
Osmocom core library
include/osmocom/core/talloc.h
00001 #pragma once
00002 /* 
00003    Unix SMB/CIFS implementation.
00004    Samba temporary memory allocation functions
00005 
00006    Copyright (C) Andrew Tridgell 2004-2005
00007    Copyright (C) Stefan Metzmacher 2006
00008    
00009      ** NOTE! The following LGPL license applies to the talloc
00010      ** library. This does NOT imply that all of Samba is released
00011      ** under the LGPL
00012    
00013    This library is free software; you can redistribute it and/or
00014    modify it under the terms of the GNU Lesser General Public
00015    License as published by the Free Software Foundation; either
00016    version 3 of the License, or (at your option) any later version.
00017 
00018    This library is distributed in the hope that it will be useful,
00019    but WITHOUT ANY WARRANTY; without even the implied warranty of
00020    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00021    Lesser General Public License for more details.
00022 
00023    You should have received a copy of the GNU Lesser General Public
00024    License along with this library; if not, see <http://www.gnu.org/licenses/>.
00025 */
00026 
00027 #include <stdlib.h>
00028 #include <stdio.h>
00029 #include <stdarg.h>
00030 
00031 #define HAVE_VA_COPY
00032 
00033 /* this is only needed for compatibility with the old talloc */
00034 typedef void TALLOC_CTX;
00035 
00036 /*
00037   this uses a little trick to allow __LINE__ to be stringified
00038 */
00039 #ifndef __location__
00040 #define __TALLOC_STRING_LINE1__(s)    #s
00041 #define __TALLOC_STRING_LINE2__(s)   __TALLOC_STRING_LINE1__(s)
00042 #define __TALLOC_STRING_LINE3__  __TALLOC_STRING_LINE2__(__LINE__)
00043 #define __location__ __FILE__ ":" __TALLOC_STRING_LINE3__
00044 #endif
00045 
00046 #ifndef TALLOC_DEPRECATED
00047 #define TALLOC_DEPRECATED 0
00048 #endif
00049 
00050 #ifndef PRINTF_ATTRIBUTE
00051 #if (__GNUC__ >= 3)
00052 
00056 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
00057 #else
00058 #define PRINTF_ATTRIBUTE(a1, a2)
00059 #endif
00060 #endif
00061 
00062 /* try to make talloc_set_destructor() and talloc_steal() type safe,
00063    if we have a recent gcc */
00064 #if (__GNUC__ >= 3)
00065 #define _TALLOC_TYPEOF(ptr) __typeof__(ptr)
00066 #define talloc_set_destructor(ptr, function)                                  \
00067         do {                                                                  \
00068                 int (*_talloc_destructor_fn)(_TALLOC_TYPEOF(ptr)) = (function);       \
00069                 _talloc_set_destructor((ptr), (int (*)(void *))_talloc_destructor_fn); \
00070         } while(0)
00071 /* this extremely strange macro is to avoid some braindamaged warning
00072    stupidity in gcc 4.1.x */
00073 #define talloc_steal(ctx, ptr) ({ _TALLOC_TYPEOF(ptr) __talloc_steal_ret = (_TALLOC_TYPEOF(ptr))_talloc_steal((ctx),(ptr)); __talloc_steal_ret; })
00074 #else
00075 #define talloc_set_destructor(ptr, function) \
00076         _talloc_set_destructor((ptr), (int (*)(void *))(function))
00077 #define _TALLOC_TYPEOF(ptr) void *
00078 #define talloc_steal(ctx, ptr) (_TALLOC_TYPEOF(ptr))_talloc_steal((ctx),(ptr))
00079 #endif
00080 
00081 #define talloc_reference(ctx, ptr) (_TALLOC_TYPEOF(ptr))_talloc_reference((ctx),(ptr))
00082 #define talloc_move(ctx, ptr) (_TALLOC_TYPEOF(*(ptr)))_talloc_move((ctx),(void *)(ptr))
00083 
00084 /* useful macros for creating type checked pointers */
00085 #define talloc(ctx, type) (type *)talloc_named_const(ctx, sizeof(type), #type)
00086 #define talloc_size(ctx, size) talloc_named_const(ctx, size, __location__)
00087 #define talloc_ptrtype(ctx, ptr) (_TALLOC_TYPEOF(ptr))talloc_size(ctx, sizeof(*(ptr)))
00088 
00089 #define talloc_new(ctx) talloc_named_const(ctx, 0, "talloc_new: " __location__)
00090 
00091 #define talloc_zero(ctx, type) (type *)_talloc_zero(ctx, sizeof(type), #type)
00092 #define talloc_zero_size(ctx, size) _talloc_zero(ctx, size, __location__)
00093 
00094 #define talloc_zero_array(ctx, type, count) (type *)_talloc_zero_array(ctx, sizeof(type), count, #type)
00095 #define talloc_array(ctx, type, count) (type *)_talloc_array(ctx, sizeof(type), count, #type)
00096 #define talloc_array_size(ctx, size, count) _talloc_array(ctx, size, count, __location__)
00097 #define talloc_array_ptrtype(ctx, ptr, count) (_TALLOC_TYPEOF(ptr))talloc_array_size(ctx, sizeof(*(ptr)), count)
00098 #define talloc_array_length(ctx) (talloc_get_size(ctx)/sizeof(*ctx))
00099 
00100 #define talloc_realloc(ctx, p, type, count) (type *)_talloc_realloc_array(ctx, p, sizeof(type), count, #type)
00101 #define talloc_realloc_size(ctx, ptr, size) _talloc_realloc(ctx, ptr, size, __location__)
00102 
00103 #define talloc_memdup(t, p, size) _talloc_memdup(t, p, size, __location__)
00104 
00105 #define talloc_set_type(ptr, type) talloc_set_name_const(ptr, #type)
00106 #define talloc_get_type(ptr, type) (type *)talloc_check_name(ptr, #type)
00107 #define talloc_get_type_abort(ptr, type) (type *)_talloc_get_type_abort(ptr, #type, __location__)
00108 
00109 #define talloc_find_parent_bytype(ptr, type) (type *)talloc_find_parent_byname(ptr, #type)
00110 
00111 #if TALLOC_DEPRECATED
00112 #define talloc_zero_p(ctx, type) talloc_zero(ctx, type)
00113 #define talloc_p(ctx, type) talloc(ctx, type)
00114 #define talloc_array_p(ctx, type, count) talloc_array(ctx, type, count)
00115 #define talloc_realloc_p(ctx, p, type, count) talloc_realloc(ctx, p, type, count)
00116 #define talloc_destroy(ctx) talloc_free(ctx)
00117 #define talloc_append_string(c, s, a) (s?talloc_strdup_append(s,a):talloc_strdup(c, a))
00118 #endif
00119 
00120 #define TALLOC_FREE(ctx) do { talloc_free(ctx); ctx=NULL; } while(0)
00121 
00122 /* The following definitions come from talloc.c  */
00123 void *_talloc(const void *context, size_t size);
00124 void *talloc_pool(const void *context, size_t size);
00125 void _talloc_set_destructor(const void *ptr, int (*_destructor)(void *));
00126 int talloc_increase_ref_count(const void *ptr);
00127 size_t talloc_reference_count(const void *ptr);
00128 void *_talloc_reference(const void *context, const void *ptr);
00129 int talloc_unlink(const void *context, void *ptr);
00130 const char *talloc_set_name(const void *ptr, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
00131 void talloc_set_name_const(const void *ptr, const char *name);
00132 void *talloc_named(const void *context, size_t size, 
00133                    const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
00134 void *talloc_named_const(const void *context, size_t size, const char *name);
00135 const char *talloc_get_name(const void *ptr);
00136 void *talloc_check_name(const void *ptr, const char *name);
00137 void *_talloc_get_type_abort(const void *ptr, const char *name, const char *location);
00138 void *talloc_parent(const void *ptr);
00139 const char *talloc_parent_name(const void *ptr);
00140 void *talloc_init(const char *fmt, ...) PRINTF_ATTRIBUTE(1,2);
00141 int talloc_free(void *ptr);
00142 void talloc_free_children(void *ptr);
00143 void *_talloc_realloc(const void *context, void *ptr, size_t size, const char *name);
00144 void *_talloc_steal(const void *new_ctx, const void *ptr);
00145 void *_talloc_move(const void *new_ctx, const void *pptr);
00146 size_t talloc_total_size(const void *ptr);
00147 size_t talloc_total_blocks(const void *ptr);
00148 void talloc_report_depth_cb(const void *ptr, int depth, int max_depth,
00149                             void (*callback)(const void *ptr,
00150                                              int depth, int max_depth,
00151                                              int is_ref,
00152                                              void *private_data),
00153                             void *private_data);
00154 void talloc_report_depth_file(const void *ptr, int depth, int max_depth, FILE *f);
00155 void talloc_report_full(const void *ptr, FILE *f);
00156 void talloc_report(const void *ptr, FILE *f);
00157 void talloc_enable_null_tracking(void);
00158 void talloc_disable_null_tracking(void);
00159 void talloc_enable_leak_report(void);
00160 void talloc_enable_leak_report_full(void);
00161 void *_talloc_zero(const void *ctx, size_t size, const char *name);
00162 void *_talloc_memdup(const void *t, const void *p, size_t size, const char *name);
00163 void *_talloc_array(const void *ctx, size_t el_size, unsigned count, const char *name);
00164 void *_talloc_zero_array(const void *ctx, size_t el_size, unsigned count, const char *name);
00165 void *_talloc_realloc_array(const void *ctx, void *ptr, size_t el_size, unsigned count, const char *name);
00166 void *talloc_realloc_fn(const void *context, void *ptr, size_t size);
00167 void *talloc_autofree_context(void);
00168 size_t talloc_get_size(const void *ctx);
00169 void *talloc_find_parent_byname(const void *ctx, const char *name);
00170 void talloc_show_parents(const void *context, FILE *file);
00171 int talloc_is_parent(const void *context, const void *ptr);
00172 
00173 char *talloc_strdup(const void *t, const char *p);
00174 char *talloc_strdup_append(char *s, const char *a);
00175 char *talloc_strdup_append_buffer(char *s, const char *a);
00176 
00177 char *talloc_strndup(const void *t, const char *p, size_t n);
00178 char *talloc_strndup_append(char *s, const char *a, size_t n);
00179 char *talloc_strndup_append_buffer(char *s, const char *a, size_t n);
00180 
00181 char *talloc_vasprintf(const void *t, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
00182 char *talloc_vasprintf_append(char *s, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
00183 char *talloc_vasprintf_append_buffer(char *s, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
00184 
00185 char *talloc_asprintf(const void *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
00186 char *talloc_asprintf_append(char *s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
00187 char *talloc_asprintf_append_buffer(char *s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
00188 
00189 void talloc_set_abort_fn(void (*abort_fn)(const char *reason));