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