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 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 2 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 <sys/types.h> 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 /* useful macros for creating type checked pointers */ 45 #define talloc(ctx, type) (type *)talloc_named_const(ctx, sizeof(type), #type) 46 #define talloc_size(ctx, size) talloc_named_const(ctx, size, __location__) 47 48 #define talloc_new(ctx) talloc_named_const(ctx, 0, "talloc_new: " __location__) 49 50 #define talloc_zero(ctx, type) (type *)_talloc_zero(ctx, sizeof(type), #type) 51 #define talloc_zero_size(ctx, size) _talloc_zero(ctx, size, __location__) 52 53 #define talloc_zero_array(ctx, type, count) (type *)_talloc_zero_array(ctx, sizeof(type), count, #type) 54 #define talloc_array(ctx, type, count) (type *)_talloc_array(ctx, sizeof(type), count, #type) 55 #define talloc_array_size(ctx, size, count) _talloc_array(ctx, size, count, __location__) 56 57 #define talloc_realloc(ctx, p, type, count) (type *)_talloc_realloc_array(ctx, p, sizeof(type), count, #type) 58 #define talloc_realloc_size(ctx, ptr, size) _talloc_realloc(ctx, ptr, size, __location__) 59 60 #define talloc_memdup(t, p, size) _talloc_memdup(t, p, size, __location__) 61 62 #define malloc_p(type) (type *)malloc(sizeof(type)) 63 #define malloc_array_p(type, count) (type *)realloc_array(NULL, sizeof(type), count) 64 #define realloc_p(p, type, count) (type *)realloc_array(p, sizeof(type), count) 65 66 #if 0 67 /* Not correct for Samba3. */ 68 #define data_blob(ptr, size) data_blob_named(ptr, size, "DATA_BLOB: "__location__) 69 #define data_blob_talloc(ctx, ptr, size) data_blob_talloc_named(ctx, ptr, size, "DATA_BLOB: "__location__) 70 #define data_blob_dup_talloc(ctx, blob) data_blob_talloc_named(ctx, (blob)->data, (blob)->length, "DATA_BLOB: "__location__) 71 #endif 72 73 #define talloc_set_type(ptr, type) talloc_set_name_const(ptr, #type) 74 #define talloc_get_type(ptr, type) (type *)talloc_check_name(ptr, #type) 75 76 #define talloc_find_parent_bytype(ptr, type) (type *)talloc_find_parent_byname(ptr, #type) 77 78 79 #if TALLOC_DEPRECATED 80 #define talloc_zero_p(ctx, type) talloc_zero(ctx, type) 81 #define talloc_p(ctx, type) talloc(ctx, type) 82 #define talloc_array_p(ctx, type, count) talloc_array(ctx, type, count) 83 #define talloc_realloc_p(ctx, p, type, count) talloc_realloc(ctx, p, type, count) 84 #define talloc_destroy(ctx) talloc_free(ctx) 85 #endif 86 87 #ifndef PRINTF_ATTRIBUTE 88 #if (__GNUC__ >= 3) 89 /** Use gcc attribute to check printf fns. a1 is the 1-based index of 90 * the parameter containing the format, and a2 the index of the first 91 * argument. Note that some gcc 2.x versions don't handle this 92 * properly **/ 93 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2))) 94 #else 95 #define PRINTF_ATTRIBUTE(a1, a2) 96 #endif 97 #endif 98 99 100 /* The following definitions come from talloc.c */ 101 void *_talloc(const void *context, size_t size); 102 void talloc_set_destructor(const void *ptr, int (*destructor)(void *)); 103 void talloc_increase_ref_count(const void *ptr); 104 void *talloc_reference(const void *context, const void *ptr); 105 int talloc_unlink(const void *context, void *ptr); 106 void talloc_set_name(const void *ptr, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3); 107 void talloc_set_name_const(const void *ptr, const char *name); 108 void *talloc_named(const void *context, size_t size, 109 const char *fmt, ...) PRINTF_ATTRIBUTE(3,4); 110 void *talloc_named_const(const void *context, size_t size, const char *name); 111 const char *talloc_get_name(const void *ptr); 112 void *talloc_check_name(const void *ptr, const char *name); 113 void talloc_report_depth(const void *ptr, FILE *f, int depth); 114 void *talloc_parent(const void *ptr); 115 void *talloc_init(const char *fmt, ...) PRINTF_ATTRIBUTE(1,2); 116 int talloc_free(void *ptr); 117 void *_talloc_realloc(const void *context, void *ptr, size_t size, const char *name); 118 void *talloc_steal(const void *new_ctx, const void *ptr); 119 off_t talloc_total_size(const void *ptr); 120 off_t talloc_total_blocks(const void *ptr); 121 void talloc_report_full(const void *ptr, FILE *f); 122 void talloc_report(const void *ptr, FILE *f); 123 void talloc_enable_null_tracking(void); 124 void talloc_enable_leak_report(void); 125 void talloc_enable_leak_report_full(void); 126 void *_talloc_zero(const void *ctx, size_t size, const char *name); 127 void *_talloc_memdup(const void *t, const void *p, size_t size, const char *name); 128 char *talloc_strdup(const void *t, const char *p); 129 char *talloc_strndup(const void *t, const char *p, size_t n); 130 char *talloc_append_string(const void *t, char *orig, const char *append); 131 char *talloc_vasprintf(const void *t, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0); 132 char *talloc_asprintf(const void *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3); 133 char *talloc_asprintf_append(char *s, 134 const char *fmt, ...) PRINTF_ATTRIBUTE(2,3); 135 void *_talloc_array(const void *ctx, size_t el_size, unsigned count, const char *name); 136 void *_talloc_zero_array(const void *ctx, size_t el_size, unsigned count, const char *name); 137 void *_talloc_realloc_array(const void *ctx, void *ptr, size_t el_size, unsigned count, const char *name); 138 void *talloc_realloc_fn(const void *context, void *ptr, size_t size); 139 void *talloc_autofree_context(void); 140 size_t talloc_get_size(const void *ctx); 141 void *talloc_find_parent_byname(const void *ctx, const char *name); 142 void talloc_show_parents(const void *context, FILE *file); 143 144 #endif 145 146