r2744: ben elliston taught me about gcov today, which allows you to measure
[bbaumbach/samba-autobuild/.git] / source4 / include / 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
8    
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 2 of the License, or
12    (at your option) any later version.
13    
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18    
19    You should have received a copy of the GNU General Public License
20    along with this program; if not, write to the Free Software
21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 */
23
24 /* this is only needed for compatibility with the old talloc */
25 typedef void TALLOC_CTX;
26
27 /*
28   this uses a little trick to allow __LINE__ to be stringified
29 */
30 #define _STRING_LINE_(s)    #s
31 #define _STRING_LINE2_(s)   _STRING_LINE_(s)
32 #define __LINESTR__       _STRING_LINE2_(__LINE__)
33 #define __location__ __FILE__ ":" __LINESTR__
34
35 /* useful macros for creating type checked pointers */
36 #define talloc(ctx, size) talloc_named_const(ctx, size, __location__)
37 #define talloc_realloc(ctx, ptr, size) _talloc_realloc(ctx, ptr, size, __location__)
38 #define talloc_p(ctx, type) (type *)talloc_named_const(ctx, sizeof(type), #type)
39 #define talloc_array_p(ctx, type, count) (type *)talloc_array(ctx, sizeof(type), count, __location__)
40 #define talloc_realloc_p(ctx, p, type, count) (type *)talloc_realloc_array(ctx, p, sizeof(type), count, __location__)
41 #define talloc_memdup(t, p, size) _talloc_memdup(t, p, size, __location__)
42
43 #define talloc_destroy(ctx) talloc_free(ctx)
44
45 #define malloc_p(type) (type *)malloc(sizeof(type))
46 #define malloc_array_p(type, count) (type *)realloc_array(NULL, sizeof(type), count)
47 #define realloc_p(p, type, count) (type *)realloc_array(p, sizeof(type), count)
48
49 #define data_blob(ptr, size) data_blob_named(ptr, size, __location__)
50 #define data_blob_talloc(ctx, ptr, size) data_blob_talloc_named(ctx, ptr, size, __location__)
51
52 #ifndef PRINTF_ATTRIBUTE
53 #define PRINTF_ATTRIBUTE(a1, a2)
54 #endif
55
56
57 /* The following definitions come from lib/talloc.c  */
58 void *_talloc(const void *context, size_t size);
59 void talloc_set_destructor(const void *ptr, int (*destructor)(void *));
60 void talloc_increase_ref_count(const void *ptr);
61 void *talloc_reference(const void *context, const void *ptr);
62 void *talloc_unreference(const void *context, const void *ptr);
63 void talloc_set_name(const void *ptr, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
64 void talloc_set_name_const(const void *ptr, const char *name);
65 void *talloc_named(const void *context, size_t size, 
66                    const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
67 void *talloc_named_const(const void *context, size_t size, const char *name);
68 const char *talloc_get_name(const void *ptr);
69 void *talloc_init(const char *fmt, ...) PRINTF_ATTRIBUTE(1,2);
70 int talloc_free(void *ptr);
71 void *_talloc_realloc(const void *context, void *ptr, size_t size, const char *name);
72 void *talloc_steal(const void *new_ctx, const void *ptr);
73 off_t talloc_total_size(const void *ptr);
74 off_t talloc_total_blocks(const void *ptr);
75 void talloc_report_full(const void *ptr, FILE *f);
76 void talloc_report(const void *ptr, FILE *f);
77 void talloc_enable_leak_report(void);
78 void talloc_enable_leak_report_full(void);
79 void *talloc_zero(const void *ctx, size_t size);
80 void *_talloc_memdup(const void *t, const void *p, size_t size, const char *name);
81 char *talloc_strdup(const void *t, const char *p);
82 char *talloc_strndup(const void *t, const char *p, size_t n);
83 char *talloc_vasprintf(const void *t, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
84 char *talloc_asprintf(const void *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
85 char *talloc_asprintf_append(char *s,
86                              const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
87 void *talloc_array(const void *ctx, size_t el_size, unsigned count, const char *name);
88 void *talloc_realloc_array(const void *ctx, void *ptr, size_t el_size, unsigned count, const char *name);
89 void *talloc_ldb_alloc(void *context, void *ptr, size_t size);
90
91 #endif
92