d103d6f4f200d4a3c307fca84c37b1dc85a48b91
[ira/wip.git] / 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 /** \mainpage
33  *
34  * \section intro_sec Introduction
35  *
36  * Talloc is a hierarchical, reference counted memory pool system with
37  * destructors. Quite a mouthful really, but not too bad once you get used to
38  * it.
39  *
40  * Perhaps the biggest difference from other memory pool systems is that there
41  * is no distinction between a "talloc context" and a "talloc pointer". Any
42  * pointer returned from talloc() is itself a valid talloc context. This means
43  * you can do this:
44  *
45  * \code
46  * struct foo *X = talloc(mem_ctx, struct foo);
47  * X->name = talloc_strdup(X, "foo");
48  * \endcode
49  *
50  * and the pointer X->name would be a "child" of the talloc context "X" which
51  * is itself a child of mem_ctx. So if you do talloc_free(mem_ctx) then it is
52  * all destroyed, whereas if you do talloc_free(X) then just X and X->name are
53  * destroyed, and if you do talloc_free(X->name) then just the name element of
54  * X is destroyed.
55  *
56  * If you think about this, then what this effectively gives you is an n-ary
57  * tree, where you can free any part of the tree with talloc_free().
58  *
59  * To start, you should probably first look at the definitions of
60  * ::TALLOC_CTX, talloc_init(), talloc() and talloc_free().
61  *
62  * \section named_blocks Named blocks
63  *
64  * Every talloc chunk has a name that can be used as a dynamic type-checking
65  * system. If for some reason like a callback function you had to cast a
66  * "struct foo *" to a "void *" variable, later you can safely reassign the
67  * "void *" pointer to a "struct foo *" by using the talloc_get_type() or
68  * talloc_get_type_abort() macros.
69  *
70  * \code
71  * struct foo *X = talloc_get_type_abort(ptr, struct foo);
72  * \endcode
73  *
74  * This will abort if "ptr" does not contain a pointer that has been created
75  * with talloc(mem_ctx, struct foo).
76  *
77  * \section multi_threading Multi-Threading
78  *
79  * talloc itself does not deal with threads. It is thread-safe (assuming the
80  * underlying "malloc" is), as long as each thread uses different memory
81  * contexts.
82  *
83  * If two threads uses the same context then they need to synchronize in order
84  * to be safe. In particular:
85  *
86  *
87  * - when using talloc_enable_leak_report(), giving directly NULL as a
88  *   parent context implicitly refers to a hidden "null context" global
89  *   variable, so this should not be used in a multi-threaded environment
90  *   without proper synchronization
91  * - the context returned by talloc_autofree_context() is also global so
92  *   shouldn't be used by several threads simultaneously without
93  *   synchronization.
94  */
95
96 /** \defgroup talloc_basic Basic Talloc Routines
97  *
98  * This module contains the basic talloc routines that are used in everyday
99  * programming.
100  */
101
102 /**
103  * \defgroup talloc_ref Talloc References
104  *
105  * This module contains the definitions around talloc references
106  */
107
108 /**
109  * \defgroup talloc_array Array routines
110  *
111  * Talloc contains some handy helpers for handling Arrays conveniently
112  */
113
114 /**
115  * \defgroup talloc_string String handling routines
116  *
117  * Talloc contains some handy string handling functions
118  */
119
120 /**
121  * \defgroup talloc_debug Debugging support routines
122  *
123  * To aid memory debugging, talloc contains routines to inspect the currently
124  * allocated memory hierarchy.
125  */
126
127 /**
128  * \defgroup talloc_internal Internal routines
129  *
130  * To achieve type-safety, talloc.h defines a lot of macros with type
131  * casts. These macros define the user interface to the internal routines you
132  * find here. You should not really use these routines directly but go through
133  * the external API.
134  */
135
136 /**
137  * \defgroup talloc_undoc Default group of undocumented stuff
138  *
139  * This should be empty...
140  */
141
142 /*\{*/
143
144 /**
145  * \typedef TALLOC_CTX
146  * \brief Define a talloc parent type
147  * \ingroup talloc_basic
148  *
149  * As talloc is a hierarchial memory allocator, every talloc chunk is a
150  * potential parent to other talloc chunks. So defining a separate type for a
151  * talloc chunk is not strictly necessary. TALLOC_CTX is defined nevertheless,
152  * as it provides an indicator for function arguments. You will frequently
153  * write code like
154  *
155  * \code
156  * struct foo *foo_create(TALLOC_CTX *mem_ctx)
157  * {
158  *      struct foo *result;
159  *      result = talloc(mem_ctx, struct foo);
160  *      if (result == NULL) return NULL;
161  *      ... initialize foo ...
162  *      return result;
163  * }
164  * \endcode
165  *
166  * In this type of allocating functions it is handy to have a general
167  * TALLOC_CTX type to indicate which parent to put allocated structures on.
168  */
169 typedef void TALLOC_CTX;
170
171 /*
172   this uses a little trick to allow __LINE__ to be stringified
173 */
174 #ifndef __location__
175 #define __TALLOC_STRING_LINE1__(s)    #s
176 #define __TALLOC_STRING_LINE2__(s)   __TALLOC_STRING_LINE1__(s)
177 #define __TALLOC_STRING_LINE3__  __TALLOC_STRING_LINE2__(__LINE__)
178 #define __location__ __FILE__ ":" __TALLOC_STRING_LINE3__
179 #endif
180
181 #ifndef TALLOC_DEPRECATED
182 #define TALLOC_DEPRECATED 0
183 #endif
184
185 #ifndef PRINTF_ATTRIBUTE
186 #if (__GNUC__ >= 3)
187 /** Use gcc attribute to check printf fns.  a1 is the 1-based index of
188  * the parameter containing the format, and a2 the index of the first
189  * argument. Note that some gcc 2.x versions don't handle this
190  * properly **/
191 #define PRINTF_ATTRIBUTE(a1, a2) __attribute__ ((format (__printf__, a1, a2)))
192 #else
193 #define PRINTF_ATTRIBUTE(a1, a2)
194 #endif
195 #endif
196
197 /**
198  * \def talloc_set_destructor
199  * \brief Assign a function to be called when a chunk is freed
200  * \param ptr The talloc chunk to add a destructor to
201  * \param function The destructor function to be called
202  * \ingroup talloc_basic
203  *
204  * The function talloc_set_destructor() sets the "destructor" for the pointer
205  * "ptr". A destructor is a function that is called when the memory used by a
206  * pointer is about to be released. The destructor receives the pointer as an
207  * argument, and should return 0 for success and -1 for failure.
208  *
209  * The destructor can do anything it wants to, including freeing other pieces
210  * of memory. A common use for destructors is to clean up operating system
211  * resources (such as open file descriptors) contained in the structure the
212  * destructor is placed on.
213  *
214  * You can only place one destructor on a pointer. If you need more than one
215  * destructor then you can create a zero-length child of the pointer and place
216  * an additional destructor on that.
217  *
218  * To remove a destructor call talloc_set_destructor() with NULL for the
219  * destructor.
220  *
221  * If your destructor attempts to talloc_free() the pointer that it is the
222  * destructor for then talloc_free() will return -1 and the free will be
223  * ignored. This would be a pointless operation anyway, as the destructor is
224  * only called when the memory is just about to go away.
225  */
226
227 /**
228  * \def talloc_steal(ctx, ptr)
229  * \brief Change a talloc chunk's parent
230  * \param ctx The new parent context
231  * \param ptr The talloc chunk to move
232  * \return ptr
233  * \ingroup talloc_basic
234  *
235  * The talloc_steal() function changes the parent context of a talloc
236  * pointer. It is typically used when the context that the pointer is
237  * currently a child of is going to be freed and you wish to keep the
238  * memory for a longer time.
239  *
240  * The talloc_steal() function returns the pointer that you pass it. It
241  * does not have any failure modes.
242  *
243  * NOTE: It is possible to produce loops in the parent/child relationship
244  * if you are not careful with talloc_steal(). No guarantees are provided
245  * as to your sanity or the safety of your data if you do this.
246  *
247  * To make the changed hierarchy less error-prone, you might consider to use
248  * talloc_move().
249  *
250  * talloc_steal (ctx, NULL) will return NULL with no sideeffects.
251  */
252
253 /* try to make talloc_set_destructor() and talloc_steal() type safe,
254    if we have a recent gcc */
255 #if (__GNUC__ >= 3)
256 #define _TALLOC_TYPEOF(ptr) __typeof__(ptr)
257 #define talloc_set_destructor(ptr, function)                                  \
258         do {                                                                  \
259                 int (*_talloc_destructor_fn)(_TALLOC_TYPEOF(ptr)) = (function);       \
260                 _talloc_set_destructor((ptr), (int (*)(void *))_talloc_destructor_fn); \
261         } while(0)
262 /* this extremely strange macro is to avoid some braindamaged warning
263    stupidity in gcc 4.1.x */
264 #define talloc_steal(ctx, ptr) ({ _TALLOC_TYPEOF(ptr) __talloc_steal_ret = (_TALLOC_TYPEOF(ptr))_talloc_steal((ctx),(ptr)); __talloc_steal_ret; })
265 #else
266 #define talloc_set_destructor(ptr, function) \
267         _talloc_set_destructor((ptr), (int (*)(void *))(function))
268 #define _TALLOC_TYPEOF(ptr) void *
269 #define talloc_steal(ctx, ptr) (_TALLOC_TYPEOF(ptr))_talloc_steal((ctx),(ptr))
270 #endif
271
272 /**
273  * \def talloc_reference(ctx, ptr)
274  * \brief Create an additional talloc parent to a pointer
275  * \param ctx The additional parent
276  * \param ptr The pointer you want to create an additional parent for
277  * \return ptr
278  * \ingroup talloc_ref
279  *
280  * The talloc_reference() function makes "context" an additional parent of
281  * "ptr".
282  *
283  * The return value of talloc_reference() is always the original pointer
284  * "ptr", unless talloc ran out of memory in creating the reference in which
285  * case it will return NULL (each additional reference consumes around 48
286  * bytes of memory on intel x86 platforms).
287  *
288  * If "ptr" is NULL, then the function is a no-op, and simply returns NULL.
289  *
290  * After creating a reference you can free it in one of the following ways:
291  *
292  * - you can talloc_free() any parent of the original pointer. That
293  *   will reduce the number of parents of this pointer by 1, and will
294  *   cause this pointer to be freed if it runs out of parents.
295  *
296  * - you can talloc_free() the pointer itself. That will destroy the
297  *   most recently established parent to the pointer and leave the
298  *   pointer as a child of its current parent.
299  *
300  * For more control on which parent to remove, see talloc_unlink()
301  */
302 #define talloc_reference(ctx, ptr) (_TALLOC_TYPEOF(ptr))_talloc_reference((ctx),(ptr))
303
304
305 /**
306  * \def talloc_move(ctx, ptr)
307  * \brief Change a talloc chunk's parent
308  * \param ctx The new parent context
309  * \param ptr Pointer to the talloc chunk to move
310  * \return ptr
311  * \ingroup talloc_basic
312  *
313  * talloc_move() has the same effect as talloc_steal(), and additionally sets
314  * the source pointer to NULL. You would use it like this:
315  *
316  * \code
317  * struct foo *X = talloc(tmp_ctx, struct foo);
318  * struct foo *Y;
319  * Y = talloc_move(new_ctx, &X);
320  * \endcode
321  */
322 #define talloc_move(ctx, ptr) (_TALLOC_TYPEOF(*(ptr)))_talloc_move((ctx),(void *)(ptr))
323
324 /* useful macros for creating type checked pointers */
325
326 /**
327  * \def talloc(ctx, type)
328  * \brief Main entry point to allocate structures
329  * \param ctx The talloc context to hang the result off
330  * \param type The type that we want to allocate
331  * \return Pointer to a piece of memory, properly cast to "type *"
332  * \ingroup talloc_basic
333  *
334  * The talloc() macro is the core of the talloc library. It takes a memory
335  * context and a type, and returns a pointer to a new area of memory of the
336  * given type.
337  *
338  * The returned pointer is itself a talloc context, so you can use it as the
339  * context argument to more calls to talloc if you wish.
340  *
341  * The returned pointer is a "child" of the supplied context. This means that
342  * if you talloc_free() the context then the new child disappears as
343  * well. Alternatively you can free just the child.
344  *
345  * The context argument to talloc() can be NULL, in which case a new top
346  * level context is created.
347  */
348 #define talloc(ctx, type) (type *)talloc_named_const(ctx, sizeof(type), #type)
349
350 /**
351  * \def talloc_size(ctx, size)
352  * \brief Untyped allocation
353  * \param ctx The talloc context to hang the result off
354  * \param size Number of char's that you want to allocate
355  * \return The allocated memory chunk
356  * \ingroup talloc_basic
357  *
358  * The function talloc_size() should be used when you don't have a convenient
359  * type to pass to talloc(). Unlike talloc(), it is not type safe (as it
360  * returns a void *), so you are on your own for type checking.
361  */
362 #define talloc_size(ctx, size) talloc_named_const(ctx, size, __location__)
363
364 /**
365  * \def talloc_ptrtype(ctx, ptr)
366  * \brief Allocate into a typed pointer
367  * \param ctx The talloc context to hang the result off
368  * \param ptr The pointer you want to assign the result to
369  * \result The allocated memory chunk, properly cast
370  * \ingroup talloc_basic
371  *
372  * The talloc_ptrtype() macro should be used when you have a pointer and
373  * want to allocate memory to point at with this pointer. When compiling
374  * with gcc >= 3 it is typesafe. Note this is a wrapper of talloc_size()
375  * and talloc_get_name() will return the current location in the source file.
376  * and not the type.
377  */
378 #define talloc_ptrtype(ctx, ptr) (_TALLOC_TYPEOF(ptr))talloc_size(ctx, sizeof(*(ptr)))
379
380 /**
381  * \def talloc_new(ctx)
382  * \brief Allocate a new 0-sized talloc chunk
383  * \param ctx The talloc parent context
384  * \return A new talloc chunk
385  * \ingroup talloc_basic
386  *
387  * This is a utility macro that creates a new memory context hanging off an
388  * exiting context, automatically naming it "talloc_new: __location__" where
389  * __location__ is the source line it is called from. It is particularly
390  * useful for creating a new temporary working context.
391  */
392 #define talloc_new(ctx) talloc_named_const(ctx, 0, "talloc_new: " __location__)
393
394 /**
395  * \def talloc_zero(ctx, type)
396  * \brief Allocate a 0-initizialized structure
397  * \param ctx The talloc context to hang the result off
398  * \param type The type that we want to allocate
399  * \return Pointer to a piece of memory, properly cast to "type *"
400  * \ingroup talloc_basic
401  *
402  * The talloc_zero() macro is equivalent to:
403  *
404  * \code
405  * ptr = talloc(ctx, type);
406  * if (ptr) memset(ptr, 0, sizeof(type));
407  * \endcode
408  */
409 #define talloc_zero(ctx, type) (type *)_talloc_zero(ctx, sizeof(type), #type)
410
411 /**
412  * \def talloc_zero_size(ctx, size)
413  * \brief Untyped, 0-initialized allocation
414  * \param ctx The talloc context to hang the result off
415  * \param size Number of char's that you want to allocate
416  * \return The allocated memory chunk
417  * \ingroup talloc_basic
418  *
419  * The talloc_zero_size() macro is equivalent to:
420  *
421  * \code
422  * ptr = talloc_size(ctx, size);
423  * if (ptr) memset(ptr, 0, size);
424  * \endcode
425  */
426
427 #define talloc_zero_size(ctx, size) _talloc_zero(ctx, size, __location__)
428
429 #define talloc_zero_array(ctx, type, count) (type *)_talloc_zero_array(ctx, sizeof(type), count, #type)
430
431 /**
432  * \def talloc_array(ctx, type, count)
433  * \brief Allocate an array
434  * \param ctx The talloc context to hang the result off
435  * \param type The type that we want to allocate
436  * \param count The number of "type" elements you want to allocate
437  * \return The allocated result, properly cast to "type *"
438  * \ingroup talloc_array
439  *
440  * The talloc_array() macro is equivalent to::
441  *
442  * \code
443  * (type *)talloc_size(ctx, sizeof(type) * count);
444  * \endcode
445  *
446  * except that it provides integer overflow protection for the multiply,
447  * returning NULL if the multiply overflows.
448  */
449 #define talloc_array(ctx, type, count) (type *)_talloc_array(ctx, sizeof(type), count, #type)
450
451 /**
452  * \def talloc_array_size(ctx, size, count)
453  * \brief Allocate an array
454  * \param ctx The talloc context to hang the result off
455  * \param size The size of an array element
456  * \param count The number of "type" elements you want to allocate
457  * \return The allocated result, properly cast to "type *"
458  * \ingroup talloc_array
459  *
460  * The talloc_array_size() function is useful when the type is not
461  * known. It operates in the same way as talloc_array(), but takes a size
462  * instead of a type.
463  */
464 #define talloc_array_size(ctx, size, count) _talloc_array(ctx, size, count, __location__)
465
466 /**
467  * \def talloc_array_ptrtype(ctx, ptr, count)
468  * \brief Allocate an array into a typed pointer
469  * \param ctx The talloc context to hang the result off
470  * \param ptr The pointer you want to assign the result to
471  * \param count The number of elements you want to allocate
472  * \result The allocated memory chunk, properly cast
473  * \ingroup talloc_array
474  *
475  * The talloc_array_ptrtype() macro should be used when you have a pointer to
476  * an array and want to allocate memory of an array to point at with this
477  * pointer. When compiling with gcc >= 3 it is typesafe. Note this is a
478  * wrapper of talloc_array_size() and talloc_get_name() will return the
479  * current location in the source file.  and not the type.
480  */
481 #define talloc_array_ptrtype(ctx, ptr, count) (_TALLOC_TYPEOF(ptr))talloc_array_size(ctx, sizeof(*(ptr)), count)
482
483 /**
484  * \def talloc_array_length(ctx)
485  * \brief Return the number of elements in a talloc'ed array
486  * \param ctx The talloc'ed array
487  * \return The number of elements in ctx
488  * \ingroup talloc_array
489  *
490  * A talloc chunk carries its own size, so for talloc'ed arrays it is not
491  * necessary to store the number of elements explicitly.
492  */
493 #define talloc_array_length(ctx) ((ctx) ? talloc_get_size(ctx)/sizeof(*ctx) : 0)
494
495 /**
496  * \def talloc_realloc(ctx, p, type, count)
497  * \brief Change the size of a talloc array
498  * \param ctx The parent context used if "p" is NULL
499  * \param p The chunk to be resized
500  * \param type The type of the array element inside p
501  * \param count The intended number of array elements
502  * \return The new array
503  * \ingroup talloc_array
504  *
505  * The talloc_realloc() macro changes the size of a talloc
506  * pointer. The "count" argument is the number of elements of type "type"
507  * that you want the resulting pointer to hold.
508  *
509  * talloc_realloc() has the following equivalences::
510  *
511  * \code
512  * talloc_realloc(context, NULL, type, 1) ==> talloc(context, type);
513  * talloc_realloc(context, NULL, type, N) ==> talloc_array(context, type, N);
514  * talloc_realloc(context, ptr, type, 0)  ==> talloc_free(ptr);
515  * \endcode
516  *
517  * The "context" argument is only used if "ptr" is NULL, otherwise it is
518  * ignored.
519  *
520  * talloc_realloc() returns the new pointer, or NULL on failure. The call
521  * will fail either due to a lack of memory, or because the pointer has
522  * more than one parent (see talloc_reference()).
523  */
524 #define talloc_realloc(ctx, p, type, count) (type *)_talloc_realloc_array(ctx, p, sizeof(type), count, #type)
525
526 /**
527  * \def talloc_realloc_size(ctx, ptr, size)
528  * \brief Untyped realloc
529  * \param ctx The parent context used if "ptr" is NULL
530  * \param ptr The chunk to be resized
531  * \param size The new chunk size
532  * \return The new chunk
533  * \ingroup talloc_array
534  *
535  * The talloc_realloc_size() function is useful when the type is not known so
536  * the typesafe talloc_realloc() cannot be used.
537  */
538 #define talloc_realloc_size(ctx, ptr, size) _talloc_realloc(ctx, ptr, size, __location__)
539
540 /**
541  * \def talloc_memdup(t, p, size)
542  * \brief Duplicate a memory area into a talloc chunk
543  * \param t The talloc context to hang the result off
544  * \param p The memory chunk you want to duplicate
545  * \param size Number of char's that you want copy
546  * \return The allocated memory chunk
547  * \ingroup talloc_basic
548  *
549  * The talloc_memdup() function is equivalent to::
550  *
551  * \code
552  * ptr = talloc_size(ctx, size);
553  * if (ptr) memcpy(ptr, p, size);
554  * \endcode
555  */
556 #define talloc_memdup(t, p, size) _talloc_memdup(t, p, size, __location__)
557
558 /**
559  * \def talloc_set_type(ptr, type)
560  * \brief Assign a type to a talloc chunk
561  * \param ptr The talloc chunk to assign the type to
562  * \param type The type to assign
563  * \ingroup talloc_basic
564  *
565  * This macro allows you to force the name of a pointer to be a
566  * particular type. This can be used in conjunction with
567  * talloc_get_type() to do type checking on void* pointers.
568  *
569  * It is equivalent to this::
570  *
571  * \code
572  * talloc_set_name_const(ptr, #type)
573  * \endcode
574  */
575 #define talloc_set_type(ptr, type) talloc_set_name_const(ptr, #type)
576
577 /**
578  * \def talloc_get_type(ptr, type)
579  * \brief Get a typed pointer out of a talloc pointer
580  * \param ptr The talloc pointer to check
581  * \param type The type to check against
582  * \return ptr, properly cast, or NULL
583  * \ingroup talloc_basic
584  *
585  * This macro allows you to do type checking on talloc pointers. It is
586  * particularly useful for void* private pointers. It is equivalent to
587  * this:
588  *
589  * \code
590  * (type *)talloc_check_name(ptr, #type)
591  * \endcode
592  */
593
594 #define talloc_get_type(ptr, type) (type *)talloc_check_name(ptr, #type)
595
596 /**
597  * \def talloc_get_type_abort(ptr, type)
598  * \brief Helper macro to safely turn a void * into a typed pointer
599  * \param ptr The void * to convert
600  * \param type The type that this chunk contains
601  * \return Same value as ptr, type-checked and properly cast
602  * \ingroup talloc_basic
603  *
604  * This macro is used together with talloc(mem_ctx, struct foo). If you had to
605  * assing the talloc chunk pointer to some void * variable,
606  * talloc_get_type_abort() is the recommended way to get the convert the void
607  * pointer back to a typed pointer.
608  */
609 #define talloc_get_type_abort(ptr, type) (type *)_talloc_get_type_abort(ptr, #type, __location__)
610
611 /**
612  * \def talloc_find_parent_bytype(ptr, type)
613  * \brief Find a parent context by type
614  * \param ptr The talloc chunk to start from
615  * \param type The type of the parent to look for
616  * \ingroup talloc_basic
617  *
618  * Find a parent memory context of the current context that has the given
619  * name. This can be very useful in complex programs where it may be
620  * difficult to pass all information down to the level you need, but you
621  * know the structure you want is a parent of another context.
622  *
623  * Like talloc_find_parent_byname() but takes a type, making it typesafe.
624  */
625 #define talloc_find_parent_bytype(ptr, type) (type *)talloc_find_parent_byname(ptr, #type)
626
627 #if TALLOC_DEPRECATED
628 #define talloc_zero_p(ctx, type) talloc_zero(ctx, type)
629 #define talloc_p(ctx, type) talloc(ctx, type)
630 #define talloc_array_p(ctx, type, count) talloc_array(ctx, type, count)
631 #define talloc_realloc_p(ctx, p, type, count) talloc_realloc(ctx, p, type, count)
632 #define talloc_destroy(ctx) talloc_free(ctx)
633 #define talloc_append_string(c, s, a) (s?talloc_strdup_append(s,a):talloc_strdup(c, a))
634 #endif
635
636 /**
637  * \def TALLOC_FREE(ctx)
638  * \brief talloc_free a chunk and NULL out the pointer
639  * \param ctx The chunk to be freed
640  * \ingroup talloc_basic
641  *
642  * TALLOC_FREE() frees a pointer and sets it to NULL. Use this if you want
643  * immediate feedback (i.e. crash) if you use a pointer after having free'ed
644  * it.
645  */
646 #define TALLOC_FREE(ctx) do { talloc_free(ctx); ctx=NULL; } while(0)
647
648 /**
649  * \brief Allocate untyped, unnamed memory
650  * \param context The talloc context to hang the result off
651  * \param size Number of char's that you want to allocate
652  * \return The allocated memory chunk
653  * \ingroup talloc_internal
654  *
655  * Essentially the same as talloc_size() without setting the chunk name to the
656  * current file/line number.
657  */
658 void *_talloc(const void *context, size_t size);
659
660 /**
661  * \brief Allocate a talloc pool
662  * \param context The talloc context to hang the result off
663  * \param size Size of the talloc pool
664  * \result The talloc pool
665  * \ingroup talloc_basic
666  *
667  * A talloc pool is a pure optimization for specific situations. In the
668  * release process for Samba 3.2 we found out that we had become considerably
669  * slower than Samba 3.0 was. Profiling showed that malloc(3) was a large CPU
670  * consumer in benchmarks. For Samba 3.2 we have internally converted many
671  * static buffers to dynamically allocated ones, so malloc(3) being beaten
672  * more was no surprise. But it made us slower.
673  *
674  * talloc_pool() is an optimization to call malloc(3) a lot less for the use
675  * pattern Samba has: The SMB protocol is mainly a request/response protocol
676  * where we have to allocate a certain amount of memory per request and free
677  * that after the SMB reply is sent to the client.
678  *
679  * talloc_pool() creates a talloc chunk that you can use as a talloc parent
680  * exactly as you would use any other ::TALLOC_CTX. The difference is that
681  * when you talloc a child of this pool, no malloc(3) is done. Instead, talloc
682  * just increments a pointer inside the talloc_pool. This also works
683  * recursively. If you use the child of the talloc pool as a parent for
684  * grand-children, their memory is also taken from the talloc pool.
685  *
686  * If you talloc_free() children of a talloc pool, the memory is not given
687  * back to the system. Instead, free(3) is only called if the talloc_pool()
688  * itself is released with talloc_free().
689  *
690  * The downside of a talloc pool is that if you talloc_move() a child of a
691  * talloc pool to a talloc parent outside the pool, the whole pool memory is
692  * not free(3)'ed until that moved chunk is also talloc_free()ed.
693  */
694 void *talloc_pool(const void *context, size_t size);
695 void _talloc_set_destructor(const void *ptr, int (*destructor)(void *));
696
697 /**
698  * \brief Increase the reference count of a talloc chunk
699  * \param ptr
700  * \return success?
701  * \ingroup talloc_ref
702  *
703  * The talloc_increase_ref_count(ptr) function is exactly equivalent to:
704  *
705  * \code
706  * talloc_reference(NULL, ptr);
707  * \endcode
708  *
709  * You can use either syntax, depending on which you think is clearer in
710  * your code.
711  *
712  * It returns 0 on success and -1 on failure.
713  */
714 int talloc_increase_ref_count(const void *ptr);
715
716 /**
717  * \brief Return the number of references to a talloc chunk
718  * \param ptr The chunk you are interested in
719  * \return Number of refs
720  * \ingroup talloc_ref
721  */
722 size_t talloc_reference_count(const void *ptr);
723 void *_talloc_reference(const void *context, const void *ptr);
724
725 /**
726  * \brief Remove a specific parent from a talloc chunk
727  * \param context The talloc parent to remove
728  * \param ptr The talloc ptr you want to remove the parent from
729  * \ingroup talloc_ref
730  *
731  * The talloc_unlink() function removes a specific parent from ptr. The
732  * context passed must either be a context used in talloc_reference() with
733  * this pointer, or must be a direct parent of ptr.
734  *
735  * Note that if the parent has already been removed using talloc_free() then
736  * this function will fail and will return -1.  Likewise, if "ptr" is NULL,
737  * then the function will make no modifications and return -1.
738  *
739  * Usually you can just use talloc_free() instead of talloc_unlink(), but
740  * sometimes it is useful to have the additional control on which parent is
741  * removed.
742  */
743 int talloc_unlink(const void *context, void *ptr);
744
745 /**
746  * \brief Assign a name to a talloc chunk
747  * \param ptr The talloc chunk to assign a name to
748  * \param fmt Format string for the name
749  * \param ... printf-style additional arguments
750  * \return The assigned name
751  * \ingroup talloc_basic
752  *
753  * Each talloc pointer has a "name". The name is used principally for
754  * debugging purposes, although it is also possible to set and get the name on
755  * a pointer in as a way of "marking" pointers in your code.
756  *
757  * The main use for names on pointer is for "talloc reports". See
758  * talloc_report() and talloc_report_full() for details. Also see
759  * talloc_enable_leak_report() and talloc_enable_leak_report_full().
760  *
761  * The talloc_set_name() function allocates memory as a child of the
762  * pointer. It is logically equivalent to:
763  *
764  * \code
765  * talloc_set_name_const(ptr, talloc_asprintf(ptr, fmt, ...));
766  * \endcode
767  *
768  * Note that multiple calls to talloc_set_name() will allocate more memory
769  * without releasing the name. All of the memory is released when the ptr is
770  * freed using talloc_free().
771  */
772 const char *talloc_set_name(const void *ptr, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
773
774 /**
775  * \brief Assign a name to a talloc chunk
776  * \param ptr The talloc chunk to assign a name to
777  * \param name Format string for the name
778  * \ingroup talloc_basic
779  *
780  * The function talloc_set_name_const() is just like talloc_set_name(), but it
781  * takes a string constant, and is much faster. It is extensively used by the
782  * "auto naming" macros, such as talloc_p().
783  *
784  * This function does not allocate any memory. It just copies the supplied
785  * pointer into the internal representation of the talloc ptr. This means you
786  * must not pass a name pointer to memory that will disappear before the ptr
787  * is freed with talloc_free().
788  */
789 void talloc_set_name_const(const void *ptr, const char *name);
790
791 /**
792  * \brief Create a named talloc chunk
793  * \param context The talloc context to hang the result off
794  * \param size Number of char's that you want to allocate
795  * \param fmt Format string for the name
796  * \param ... printf-style additional arguments
797  * \return The allocated memory chunk
798  * \ingroup talloc_basic
799  *
800  * The talloc_named() function creates a named talloc pointer. It is
801  * equivalent to:
802  *
803  * \code
804  * ptr = talloc_size(context, size);
805  * talloc_set_name(ptr, fmt, ....);
806  * \endcode
807  *
808  */
809 void *talloc_named(const void *context, size_t size, 
810                    const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
811
812 /**
813  * \brief Basic routine to allocate a chunk of memory
814  * \param context The parent context
815  * \param size The number of char's that we want to allocate
816  * \param name The name the talloc block has
817  * \return The allocated chunk
818  * \ingroup talloc_basic
819  *
820  * This is equivalent to:
821  *
822  * \code
823  * ptr = talloc_size(context, size);
824  * talloc_set_name_const(ptr, name);
825  * \endcode
826  */
827 void *talloc_named_const(const void *context, size_t size, const char *name);
828
829 /**
830  * \brief Return the name of a talloc chunk
831  * \param ptr The talloc chunk
832  * \return The name
833  * \ingroup talloc_basic
834  *
835  * This returns the current name for the given talloc pointer. See
836  * talloc_set_name() for details.
837  */
838 const char *talloc_get_name(const void *ptr);
839
840 /**
841  * \brief Verify that a talloc chunk carries a specified name
842  * \param ptr The talloc chunk to check
843  * \param name The name to check agains
844  * \ingroup talloc_basic
845  *
846  * This function checks if a pointer has the specified name. If it does
847  * then the pointer is returned. It it doesn't then NULL is returned.
848  */
849 void *talloc_check_name(const void *ptr, const char *name);
850
851 void *_talloc_get_type_abort(const void *ptr, const char *name, const char *location);
852 void *talloc_parent(const void *ptr);
853 const char *talloc_parent_name(const void *ptr);
854
855 /**
856  * \brief Create a new top level talloc context
857  * \param fmt Format string for the name
858  * \param ... printf-style additional arguments
859  * \return The allocated memory chunk
860  * \ingroup talloc_basic
861  *
862  * This function creates a zero length named talloc context as a top level
863  * context. It is equivalent to:
864  *
865  * \code
866  *   talloc_named(NULL, 0, fmt, ...);
867  * \endcode
868  */
869 void *talloc_init(const char *fmt, ...) PRINTF_ATTRIBUTE(1,2);
870
871 /**
872  * \brief Free a chunk of talloc memory
873  * \param ptr The chunk to be freed
874  * \return success?
875  * \ingroup talloc_basic
876  *
877  * The talloc_free() function frees a piece of talloc memory, and all its
878  * children. You can call talloc_free() on any pointer returned by talloc().
879  *
880  * The return value of talloc_free() indicates success or failure, with 0
881  * returned for success and -1 for failure. The only possible failure
882  * condition is if the pointer had a destructor attached to it and the
883  * destructor returned -1. See talloc_set_destructor() for details on
884  * destructors.
885  *
886  * If this pointer has an additional parent when talloc_free() is called
887  * then the memory is not actually released, but instead the most
888  * recently established parent is destroyed. See talloc_reference() for
889  * details on establishing additional parents.
890  *
891  * For more control on which parent is removed, see talloc_unlink()
892  *
893  * talloc_free() operates recursively on its children.
894  */
895 int talloc_free(void *ptr);
896
897 /**
898  * \brief Free a talloc chunk's children
899  * \param ptr The chunk that you want to free the children of
900  * \return success?
901  * \ingroup talloc_basic
902  *
903  * The talloc_free_children() walks along the list of all children of a talloc
904  * context and talloc_free()s only the children, not the context itself.
905  */
906 void talloc_free_children(void *ptr);
907 void *_talloc_realloc(const void *context, void *ptr, size_t size, const char *name);
908 void *_talloc_steal(const void *new_ctx, const void *ptr);
909 void *_talloc_move(const void *new_ctx, const void *pptr);
910
911 /**
912  * \brief Return the total size of a talloc chunk including its children
913  * \param ptr The talloc chunk
914  * \return The total size
915  * \ingroup talloc_basic
916  *
917  * The talloc_total_size() function returns the total size in bytes used
918  * by this pointer and all child pointers. Mostly useful for debugging.
919  *
920  * Passing NULL is allowed, but it will only give a meaningful result if
921  * talloc_enable_leak_report() or talloc_enable_leak_report_full() has
922  * been called.
923  */
924 size_t talloc_total_size(const void *ptr);
925
926 /**
927  * \brief Return the number of talloc chunks hanging off a chunk
928  * \param ptr The talloc chunk
929  * \return The total size
930  * \ingroup talloc_basic
931  *
932  * The talloc_total_blocks() function returns the total memory block
933  * count used by this pointer and all child pointers. Mostly useful for
934  * debugging.
935  *
936  * Passing NULL is allowed, but it will only give a meaningful result if
937  * talloc_enable_leak_report() or talloc_enable_leak_report_full() has
938  * been called.
939  */
940 size_t talloc_total_blocks(const void *ptr);
941
942 /**
943  * \brief Walk a complete talloc hierarchy
944  * \param ptr The talloc chunk
945  * \param depth Internal parameter to control recursion. Call with 0.
946  * \param max_depth Maximum recursion level.
947  * \param callback Function to be called on every chunk
948  * \param private_data Private pointer passed to callback
949  * \ingroup talloc_debug
950  *
951  * This provides a more flexible reports than talloc_report(). It
952  * will recursively call the callback for the entire tree of memory
953  * referenced by the pointer. References in the tree are passed with
954  * is_ref = 1 and the pointer that is referenced.
955  *
956  * You can pass NULL for the pointer, in which case a report is
957  * printed for the top level memory context, but only if
958  * talloc_enable_leak_report() or talloc_enable_leak_report_full()
959  * has been called.
960  *
961  * The recursion is stopped when depth >= max_depth.
962  * max_depth = -1 means only stop at leaf nodes.
963  */
964 void talloc_report_depth_cb(const void *ptr, int depth, int max_depth,
965                             void (*callback)(const void *ptr,
966                                              int depth, int max_depth,
967                                              int is_ref,
968                                              void *private_data),
969                             void *private_data);
970
971 /**
972  * \brief Print a talloc hierarchy
973  * \param ptr The talloc chunk
974  * \param depth Internal parameter to control recursion. Call with 0.
975  * \param max_depth Maximum recursion level.
976  * \param f The file handle to print to
977  * \ingroup talloc_debug
978  *
979  * This provides a more flexible reports than talloc_report(). It
980  * will let you specify the depth and max_depth.
981  */
982 void talloc_report_depth_file(const void *ptr, int depth, int max_depth, FILE *f);
983
984 /**
985  * \brief Print a summary report of all memory used by ptr
986  * \param ptr The talloc chunk
987  * \param f The file handle to print to
988  * \ingroup talloc_debug
989  *
990  * This provides a more detailed report than talloc_report(). It will
991  * recursively print the ensire tree of memory referenced by the
992  * pointer. References in the tree are shown by giving the name of the
993  * pointer that is referenced.
994  *
995  * You can pass NULL for the pointer, in which case a report is printed
996  * for the top level memory context, but only if
997  * talloc_enable_leak_report() or talloc_enable_leak_report_full() has
998  * been called.
999  */
1000 void talloc_report_full(const void *ptr, FILE *f);
1001
1002 /**
1003  * \brief Print a summary report of all memory used by ptr
1004  * \param ptr The talloc chunk
1005  * \param f The file handle to print to
1006  * \ingroup talloc_debug
1007  *
1008  * The talloc_report() function prints a summary report of all memory
1009  * used by ptr. One line of report is printed for each immediate child of
1010  * ptr, showing the total memory and number of blocks used by that child.
1011  *
1012  * You can pass NULL for the pointer, in which case a report is printed
1013  * for the top level memory context, but only if
1014  * talloc_enable_leak_report() or talloc_enable_leak_report_full() has
1015  * been called.
1016  */
1017 void talloc_report(const void *ptr, FILE *f);
1018
1019 /**
1020  * \brief Enable tracking the use of NULL memory contexts
1021  * \ingroup talloc_debug
1022  *
1023  * This enables tracking of the NULL memory context without enabling leak
1024  * reporting on exit. Useful for when you want to do your own leak
1025  * reporting call via talloc_report_null_full();
1026  */
1027 void talloc_enable_null_tracking(void);
1028
1029 /**
1030  * \brief Disable tracking of the NULL memory context
1031  * \ingroup talloc_debug
1032  *
1033  * This disables tracking of the NULL memory context.
1034  */
1035
1036 void talloc_disable_null_tracking(void);
1037
1038 /**
1039  * \brief Enable calling of talloc_report(NULL, stderr) when a program exits
1040  * \ingroup talloc_debug
1041  *
1042  * This enables calling of talloc_report(NULL, stderr) when the program
1043  * exits. In Samba4 this is enabled by using the --leak-report command
1044  * line option.
1045  *
1046  * For it to be useful, this function must be called before any other
1047  * talloc function as it establishes a "null context" that acts as the
1048  * top of the tree. If you don't call this function first then passing
1049  * NULL to talloc_report() or talloc_report_full() won't give you the
1050  * full tree printout.
1051  *
1052  * Here is a typical talloc report:
1053  *
1054 \verbatim
1055 talloc report on 'null_context' (total 267 bytes in 15 blocks)
1056          libcli/auth/spnego_parse.c:55  contains     31 bytes in   2 blocks
1057          libcli/auth/spnego_parse.c:55  contains     31 bytes in   2 blocks
1058          iconv(UTF8,CP850)              contains     42 bytes in   2 blocks
1059          libcli/auth/spnego_parse.c:55  contains     31 bytes in   2 blocks
1060          iconv(CP850,UTF8)              contains     42 bytes in   2 blocks
1061          iconv(UTF8,UTF-16LE)           contains     45 bytes in   2 blocks
1062          iconv(UTF-16LE,UTF8)           contains     45 bytes in   2 blocks
1063 \endverbatim
1064  */
1065 void talloc_enable_leak_report(void);
1066
1067 /**
1068  * \brief Enable calling of talloc_report(NULL, stderr) when a program exits
1069  * \ingroup talloc_debug
1070  *
1071  * This enables calling of talloc_report_full(NULL, stderr) when the
1072  * program exits. In Samba4 this is enabled by using the
1073  * --leak-report-full command line option.
1074  *
1075  * For it to be useful, this function must be called before any other
1076  * talloc function as it establishes a "null context" that acts as the
1077  * top of the tree. If you don't call this function first then passing
1078  * NULL to talloc_report() or talloc_report_full() won't give you the
1079  * full tree printout.
1080  *
1081  * Here is a typical full report:
1082 \verbatim
1083 full talloc report on 'root' (total 18 bytes in 8 blocks)
1084     p1                             contains     18 bytes in   7 blocks (ref 0)
1085         r1                             contains     13 bytes in   2 blocks (ref 0)
1086             reference to: p2
1087         p2                             contains      1 bytes in   1 blocks (ref 1)
1088         x3                             contains      1 bytes in   1 blocks (ref 0)
1089         x2                             contains      1 bytes in   1 blocks (ref 0)
1090         x1                             contains      1 bytes in   1 blocks (ref 0)
1091 \endverbatim
1092 */
1093 void talloc_enable_leak_report_full(void);
1094 void *_talloc_zero(const void *ctx, size_t size, const char *name);
1095 void *_talloc_memdup(const void *t, const void *p, size_t size, const char *name);
1096 void *_talloc_array(const void *ctx, size_t el_size, unsigned count, const char *name);
1097 void *_talloc_zero_array(const void *ctx, size_t el_size, unsigned count, const char *name);
1098 void *_talloc_realloc_array(const void *ctx, void *ptr, size_t el_size, unsigned count, const char *name);
1099
1100 /**
1101  * \brief Provide a function version of talloc_realloc_size
1102  * \param context The parent context used if "ptr" is NULL
1103  * \param ptr The chunk to be resized
1104  * \param size The new chunk size
1105  * \return The new chunk
1106  * \ingroup talloc_array
1107  *
1108  * This is a non-macro version of talloc_realloc(), which is useful as
1109  * libraries sometimes want a ralloc function pointer. A realloc()
1110  * implementation encapsulates the functionality of malloc(), free() and
1111  * realloc() in one call, which is why it is useful to be able to pass around
1112  * a single function pointer.
1113 */
1114 void *talloc_realloc_fn(const void *context, void *ptr, size_t size);
1115
1116 /**
1117  * \brief Provide a talloc context that is freed at program exit
1118  * \return A talloc context
1119  * \ingroup talloc_basic
1120  *
1121  * This is a handy utility function that returns a talloc context
1122  * which will be automatically freed on program exit. This can be used
1123  * to reduce the noise in memory leak reports.
1124  */
1125 void *talloc_autofree_context(void);
1126
1127 /**
1128  * \brief Get the size of a talloc chunk
1129  * \param ctx The talloc chunk
1130  * \return The size
1131  * \ingroup talloc_basic
1132  *
1133  * This function lets you know the amount of memory alloced so far by
1134  * this context. It does NOT account for subcontext memory.
1135  * This can be used to calculate the size of an array.
1136  */
1137 size_t talloc_get_size(const void *ctx);
1138
1139 /**
1140  * \brief Find a parent context by name
1141  * \param ctx The talloc chunk to start from
1142  * \param name The name of the parent we look for
1143  * \ingroup talloc_basic
1144  *
1145  * Find a parent memory context of the current context that has the given
1146  * name. This can be very useful in complex programs where it may be
1147  * difficult to pass all information down to the level you need, but you
1148  * know the structure you want is a parent of another context.
1149  */
1150 void *talloc_find_parent_byname(const void *ctx, const char *name);
1151 void talloc_show_parents(const void *context, FILE *file);
1152 int talloc_is_parent(const void *context, const void *ptr);
1153
1154 /**
1155  * \brief Duplicate a string into a talloc chunk
1156  * \param t The talloc context to hang the result off
1157  * \param p The string you want to duplicate
1158  * \return The duplicated string
1159  * \ingroup talloc_string
1160  *
1161  * The talloc_strdup() function is equivalent to:
1162  *
1163  * \code
1164  * ptr = talloc_size(ctx, strlen(p)+1);
1165  * if (ptr) memcpy(ptr, p, strlen(p)+1);
1166  * \endcode
1167  *
1168  * This functions sets the name of the new pointer to the passed
1169  * string. This is equivalent to:
1170  *
1171  * \code
1172  * talloc_set_name_const(ptr, ptr)
1173  * \endcode
1174  */
1175 char *talloc_strdup(const void *t, const char *p);
1176 char *talloc_strdup_append(char *s, const char *a);
1177 char *talloc_strdup_append_buffer(char *s, const char *a);
1178
1179 /**
1180  * \brief Duplicate a length-limited string into a talloc chunk
1181  * \param t The talloc context to hang the result off
1182  * \param p The string you want to duplicate
1183  * \param n The maximum string length to duplicate
1184  * \return The duplicated string
1185  * \ingroup talloc_string
1186  *
1187  * The talloc_strndup() function is the talloc equivalent of the C
1188  * library function strndup()
1189  *
1190  * This functions sets the name of the new pointer to the passed
1191  * string. This is equivalent to:
1192  *
1193  * \code
1194  * talloc_set_name_const(ptr, ptr)
1195  * \endcode
1196  */
1197 char *talloc_strndup(const void *t, const char *p, size_t n);
1198 char *talloc_strndup_append(char *s, const char *a, size_t n);
1199 char *talloc_strndup_append_buffer(char *s, const char *a, size_t n);
1200
1201 /**
1202  * \brief Format a string given a va_list
1203  * \param t The talloc context to hang the result off
1204  * \param fmt The format string
1205  * \param ap The parameters used to fill fmt
1206  * \return The formatted string
1207  * \ingroup talloc_string
1208  *
1209  * The talloc_vasprintf() function is the talloc equivalent of the C
1210  * library function vasprintf()
1211  *
1212  * This functions sets the name of the new pointer to the new
1213  * string. This is equivalent to:
1214  *
1215  * \code
1216  * talloc_set_name_const(ptr, ptr)
1217  * \endcode
1218  */
1219 char *talloc_vasprintf(const void *t, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
1220 char *talloc_vasprintf_append(char *s, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
1221 char *talloc_vasprintf_append_buffer(char *s, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
1222
1223 /**
1224  * \brief Format a string
1225  * \param t The talloc context to hang the result off
1226  * \param fmt The format string
1227  * \param ... The parameters used to fill fmt
1228  * \return The formatted string
1229  * \ingroup talloc_string
1230  *
1231  * The talloc_asprintf() function is the talloc equivalent of the C
1232  * library function asprintf()
1233  *
1234  * This functions sets the name of the new pointer to the new
1235  * string. This is equivalent to:
1236  *
1237  * \code
1238  * talloc_set_name_const(ptr, ptr)
1239  * \endcode
1240  */
1241 char *talloc_asprintf(const void *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
1242
1243 /**
1244  * \brief Append a formatted string to another string
1245  * \param s The string to append to
1246  * \param fmt The format string
1247  * \param ... The parameters used to fill fmt
1248  * \return The formatted string
1249  * \ingroup talloc_string
1250  *
1251  * The talloc_asprintf_append() function appends the given formatted string to
1252  * the given string. Use this varient when the string in the current talloc
1253  * buffer may have been truncated in length.
1254  *
1255  * This functions sets the name of the new pointer to the new
1256  * string. This is equivalent to:
1257  *
1258  * \code
1259  * talloc_set_name_const(ptr, ptr)
1260  * \endcode
1261  */
1262 char *talloc_asprintf_append(char *s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
1263
1264 /**
1265  * \brief Append a formatted string to another string
1266  * \param s The string to append to
1267  * \param fmt The format string
1268  * \param ... The parameters used to fill fmt
1269  * \return The formatted string
1270  * \ingroup talloc_string
1271  *
1272  * The talloc_asprintf_append() function appends the given formatted string to
1273  * the end of the currently allocated talloc buffer. This routine should be
1274  * used if you create a large string step by step. talloc_asprintf() or
1275  * talloc_asprintf_append() call strlen() at every
1276  * step. talloc_asprintf_append_buffer() uses the existing buffer size of the
1277  * talloc chunk to calculate where to append the string.
1278  *
1279  * This functions sets the name of the new pointer to the new
1280  * string. This is equivalent to:
1281  *
1282  * \code
1283  * talloc_set_name_const(ptr, ptr)
1284  * \endcode
1285  */
1286 char *talloc_asprintf_append_buffer(char *s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
1287
1288 void talloc_set_abort_fn(void (*abort_fn)(const char *reason));
1289
1290 #endif
1291
1292 /*\}*/