← Back to branch summary

~zulcss/samba/server-dailies-3.4

« back to all changes in this revision

Viewing changes to lib/talloc/talloc.h

  • Committer: Chuck Short
  • Date: 2010-09-28 20:38:39 UTC
  • Revision ID: zulcss@ubuntu.com-20100928203839-pgjulytsi9ue63x1
Initial version

Show diffs side-by-side

added added

removed removed

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