source: trunk/samba/source/lib/talloc/talloc.h @ 30

Last change on this file since 30 was 30, checked in by Paul Smedley, 14 years ago

Code updated to Samba 3.0.25rc2 level

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