source4/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 2 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, write to the Free Software
  26    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  27 */
  28
  29 /* this is only needed for compatibility with the old talloc */
  30 typedef void TALLOC_CTX;
  31
  32 /*
  33   this uses a little trick to allow __LINE__ to be stringified
  34 */
  35 #define _STRING_LINE_(s)    #s
  36 #define _STRING_LINE2_(s)   _STRING_LINE_(s)
  37 #define __LINESTR__       _STRING_LINE2_(__LINE__)
  38 #define __location__ __FILE__ ":" __LINESTR__
  39
  40 #ifndef TALLOC_DEPRECATED
  41 #define TALLOC_DEPRECATED 0
  42 #endif
  43
  44 #ifndef PRINTF_ATTRIBUTE
  45 #if (__GNUC__ >= 3)
  46 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
  47  * the parameter containing the format, and a2 the index of the first
  48  * argument. Note that some gcc 2.x versions don't handle this
  49  * properly **/
  50 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
  51 #else
  52 #define PRINTF_ATTRIBUTE(a1, a2)
  53 #endif
  54 #endif
  55
  56 /* try to make talloc_set_destructor() and talloc_steal() type safe,
  57    if we have a recent gcc */
  58 #if (__GNUC__ >= 3)
  59 #define _TALLOC_TYPEOF(ptr) __typeof__(ptr)
  60 #define talloc_set_destructor(ptr, function)                                  \
  61         do {                                                                  \
  62                 int (*_talloc_destructor_fn)(_TALLOC_TYPEOF(ptr)) = (function);       \
  63                 _talloc_set_destructor((ptr), (int (*)(void *))_talloc_destructor_fn); \
  64         } while(0)
  65 /* this extremely strange macro is to avoid some braindamaged warning
  66    stupidity in gcc 4.1.x */
  67 #define talloc_steal(ctx, ptr) ({ _TALLOC_TYPEOF(ptr) __talloc_steal_ret = (_TALLOC_TYPEOF(ptr))_talloc_steal((ctx),(ptr)); __talloc_steal_ret; })
  68 #define talloc_reference(ctx, ptr) (_TALLOC_TYPEOF(ptr))_talloc_reference((ctx),(ptr))
  69 #else
  70 #define talloc_set_destructor(ptr, function) \
  71         _talloc_set_destructor((ptr), (int (*)(void *))(function))
  72 #define _TALLOC_TYPEOF(ptr) void *
  73 #define talloc_steal(ctx, ptr) (_TALLOC_TYPEOF(ptr))_talloc_steal((ctx),(ptr))
  74 #define talloc_reference(ctx, ptr) (_TALLOC_TYPEOF(ptr))_talloc_reference((ctx),(ptr))
  75 #endif
  76
  77 /* useful macros for creating type checked pointers */
  78 #define talloc(ctx, type) (type *)talloc_named_const(ctx, sizeof(type), #type)
  79 #define talloc_size(ctx, size) talloc_named_const(ctx, size, __location__)
  80 #define talloc_ptrtype(ctx, ptr) (_TALLOC_TYPEOF(ptr))talloc_size(ctx, sizeof(*(ptr)))
  81
  82 #define talloc_new(ctx) talloc_named_const(ctx, 0, "talloc_new: " __location__)
  83
  84 #define talloc_zero(ctx, type) (type *)_talloc_zero(ctx, sizeof(type), #type)
  85 #define talloc_zero_size(ctx, size) _talloc_zero(ctx, size, __location__)
  86
  87 #define talloc_zero_array(ctx, type, count) (type *)_talloc_zero_array(ctx, sizeof(type), count, #type)
  88 #define talloc_array(ctx, type, count) (type *)_talloc_array(ctx, sizeof(type), count, #type)
  89 #define talloc_array_size(ctx, size, count) _talloc_array(ctx, size, count, __location__)
  90 #define talloc_array_ptrtype(ctx, ptr, count) (_TALLOC_TYPEOF(ptr))talloc_array_size(ctx, sizeof(*(ptr)), count)
  91
  92 #define talloc_realloc(ctx, p, type, count) (type *)_talloc_realloc_array(ctx, p, sizeof(type), count, #type)
  93 #define talloc_realloc_size(ctx, ptr, size) _talloc_realloc(ctx, ptr, size, __location__)
  94
  95 #define talloc_memdup(t, p, size) _talloc_memdup(t, p, size, __location__)
  96
  97 #define talloc_set_type(ptr, type) talloc_set_name_const(ptr, #type)
  98 #define talloc_get_type(ptr, type) (type *)talloc_check_name(ptr, #type)
  99
 100 #define talloc_find_parent_bytype(ptr, type) (type *)talloc_find_parent_byname(ptr, #type)
 101
 102 #if TALLOC_DEPRECATED
 103 #define talloc_zero_p(ctx, type) talloc_zero(ctx, type)
 104 #define talloc_p(ctx, type) talloc(ctx, type)
 105 #define talloc_array_p(ctx, type, count) talloc_array(ctx, type, count)
 106 #define talloc_realloc_p(ctx, p, type, count) talloc_realloc(ctx, p, type, count)
 107 #define talloc_destroy(ctx) talloc_free(ctx)
 108 #endif
 109
 110 /* The following definitions come from talloc.c  */
 111 void *_talloc(const void *context, size_t size);
 112 void _talloc_set_destructor(const void *ptr, int (*destructor)(void *));
 113 int talloc_increase_ref_count(const void *ptr);
 114 size_t talloc_reference_count(const void *ptr);
 115 void *_talloc_reference(const void *context, const void *ptr);
 116 int talloc_unlink(const void *context, void *ptr);
 117 const char *talloc_set_name(const void *ptr, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 118 void talloc_set_name_const(const void *ptr, const char *name);
 119 void *talloc_named(const void *context, size_t size,
 120                    const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
 121 void *talloc_named_const(const void *context, size_t size, const char *name);
 122 const char *talloc_get_name(const void *ptr);
 123 void *talloc_check_name(const void *ptr, const char *name);
 124 void *talloc_parent(const void *ptr);
 125 void *talloc_init(const char *fmt, ...) PRINTF_ATTRIBUTE(1,2);
 126 int talloc_free(void *ptr);
 127 void talloc_free_children(void *ptr);
 128 void *_talloc_realloc(const void *context, void *ptr, size_t size, const char *name);
 129 void *_talloc_steal(const void *new_ctx, const void *ptr);
 130 size_t talloc_total_size(const void *ptr);
 131 size_t talloc_total_blocks(const void *ptr);
 132 void talloc_report_depth_cb(const void *ptr, int depth, int max_depth,
 133                             void (*callback)(const void *ptr,
 134                                              int depth, int max_depth,
 135                                              int is_ref,
 136                                              void *private_data),
 137                             void *private_data);
 138 void talloc_report_depth_file(const void *ptr, int depth, int max_depth, FILE *f);
 139 void talloc_report_full(const void *ptr, FILE *f);
 140 void talloc_report(const void *ptr, FILE *f);
 141 void talloc_enable_null_tracking(void);
 142 void talloc_disable_null_tracking(void);
 143 void talloc_enable_leak_report(void);
 144 void talloc_enable_leak_report_full(void);
 145 void *_talloc_zero(const void *ctx, size_t size, const char *name);
 146 void *_talloc_memdup(const void *t, const void *p, size_t size, const char *name);
 147 char *talloc_strdup(const void *t, const char *p);
 148 char *talloc_strndup(const void *t, const char *p, size_t n);
 149 char *talloc_append_string(const void *t, char *orig, const char *append);
 150 char *talloc_vasprintf(const void *t, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
 151 char *talloc_vasprintf_append(char *s, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
 152 char *talloc_asprintf(const void *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 153 char *talloc_asprintf_append(char *s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
 154 void *_talloc_array(const void *ctx, size_t el_size, unsigned count, const char *name);
 155 void *_talloc_zero_array(const void *ctx, size_t el_size, unsigned count, const char *name);
 156 void *_talloc_realloc_array(const void *ctx, void *ptr, size_t el_size, unsigned count, const char *name);
 157 void *talloc_realloc_fn(const void *context, void *ptr, size_t size);
 158 void *talloc_autofree_context(void);
 159 size_t talloc_get_size(const void *ctx);
 160 void *talloc_find_parent_byname(const void *ctx, const char *name);
 161 void talloc_show_parents(const void *context, FILE *file);
 162 int talloc_is_parent(const void *context, const void *ptr);
 163
 164 #endif
 165