talloc: use the system pytalloc-util for python3 as well
[sfrench/samba-autobuild/.git] / lib / talloc / talloc_guide.txt
1 Using talloc in Samba4
2 ======================
3
4 .. contents::
5
6 Andrew Tridgell
7 August 2009
8
9 The most current version of this document is available at
10    http://samba.org/ftp/unpacked/talloc/talloc_guide.txt
11
12 If you are used to the "old" talloc from Samba3 before 3.0.20 then please read
13 this carefully, as talloc has changed a lot. With 3.0.20 (or 3.0.14?) the
14 Samba4 talloc has been ported back to Samba3, so this guide applies to both.
15
16 The new talloc is a hierarchical, reference counted memory pool system
17 with destructors. Quite a mouthful really, but not too bad once you
18 get used to it.
19
20 Perhaps the biggest change from Samba3 is that there is no distinction
21 between a "talloc context" and a "talloc pointer". Any pointer
22 returned from talloc() is itself a valid talloc context. This means
23 you can do this::
24
25   struct foo *X = talloc(mem_ctx, struct foo);
26   X->name = talloc_strdup(X, "foo");
27
28 and the pointer X->name would be a "child" of the talloc context "X"
29 which is itself a child of "mem_ctx". So if you do talloc_free(mem_ctx)
30 then it is all destroyed, whereas if you do talloc_free(X) then just X
31 and X->name are destroyed, and if you do talloc_free(X->name) then
32 just the name element of X is destroyed.
33
34 If you think about this, then what this effectively gives you is an
35 n-ary tree, where you can free any part of the tree with
36 talloc_free().
37
38 If you find this confusing, then I suggest you run the testsuite to
39 watch talloc in action. You may also like to add your own tests to
40 testsuite.c to clarify how some particular situation is handled.
41
42
43 Performance
44 -----------
45
46 All the additional features of talloc() over malloc() do come at a
47 price. We have a simple performance test in Samba4 that measures
48 talloc() versus malloc() performance, and it seems that talloc() is
49 about 4% slower than malloc() on my x86 Debian Linux box. For Samba,
50 the great reduction in code complexity that we get by using talloc
51 makes this worthwhile, especially as the total overhead of
52 talloc/malloc in Samba is already quite small.
53
54
55 talloc API
56 ----------
57
58 The following is a complete guide to the talloc API. Read it all at
59 least twice.
60
61 Multi-threading
62 ---------------
63
64 talloc itself does not deal with threads. It is thread-safe (assuming  
65 the underlying "malloc" is), as long as each thread uses different  
66 memory contexts.
67 If two threads use the same context then they need to synchronize in
68 order to be safe. In particular:
69 - when using talloc_enable_leak_report(), giving directly NULL as a  
70 parent context implicitly refers to a hidden "null context" global  
71 variable, so this should not be used in a multi-threaded environment  
72 without proper synchronization. In threaded code turn off null tracking using
73 talloc_disable_null_tracking(). ;
74 - the context returned by talloc_autofree_context() is also global so  
75 shouldn't be used by several threads simultaneously without  
76 synchronization.
77
78 talloc and shared objects
79 -------------------------
80
81 talloc can be used in shared objects. Special care needs to be taken
82 to never use talloc_autofree_context() in code that might be loaded
83 with dlopen() and unloaded with dlclose(), as talloc_autofree_context()
84 internally uses atexit(3). Some platforms like modern Linux handles
85 this fine, but for example FreeBSD does not deal well with dlopen()
86 and atexit() used simultaneously: dlclose() does not clean up the list
87 of atexit-handlers, so when the program exits the code that was
88 registered from within talloc_autofree_context() is gone, the program
89 crashes at exit.
90
91
92 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
93 (type *)talloc(const void *context, type);
94
95 The talloc() macro is the core of the talloc library. It takes a
96 memory context and a type, and returns a pointer to a new area of
97 memory of the given type.
98
99 The returned pointer is itself a talloc context, so you can use it as
100 the context argument to more calls to talloc if you wish.
101
102 The returned pointer is a "child" of the supplied context. This means
103 that if you talloc_free() the context then the new child disappears as
104 well. Alternatively you can free just the child.
105
106 The context argument to talloc() can be NULL, in which case a new top
107 level context is created. 
108
109
110 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
111 void *talloc_size(const void *context, size_t size);
112
113 The function talloc_size() should be used when you don't have a
114 convenient type to pass to talloc(). Unlike talloc(), it is not type
115 safe (as it returns a void *), so you are on your own for type checking.
116
117 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
118 (typeof(ptr)) talloc_ptrtype(const void *ctx, ptr);
119
120 The talloc_ptrtype() macro should be used when you have a pointer and
121 want to allocate memory to point at with this pointer. When compiling
122 with gcc >= 3 it is typesafe. Note this is a wrapper of talloc_size()
123 and talloc_get_name() will return the current location in the source file.
124 and not the type.
125
126 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
127 int talloc_free(void *ptr);
128
129 The talloc_free() function frees a piece of talloc memory, and all its
130 children. You can call talloc_free() on any pointer returned by
131 talloc().
132
133 The return value of talloc_free() indicates success or failure, with 0
134 returned for success and -1 for failure. A possible failure condition
135 is if the pointer had a destructor attached to it and the destructor
136 returned -1. See talloc_set_destructor() for details on
137 destructors. Likewise, if "ptr" is NULL, then the function will make
138 no modifications and returns -1.
139
140 From version 2.0 and onwards, as a special case, talloc_free() is
141 refused on pointers that have more than one parent associated, as talloc
142 would have no way of knowing which parent should be removed. This is
143 different from older versions in the sense that always the reference to
144 the most recently established parent has been destroyed. Hence to free a
145 pointer that has more than one parent please use talloc_unlink().
146
147 To help you find problems in your code caused by this behaviour, if
148 you do try and free a pointer with more than one parent then the
149 talloc logging function will be called to give output like this:
150
151   ERROR: talloc_free with references at some_dir/source/foo.c:123
152         reference at some_dir/source/other.c:325
153         reference at some_dir/source/third.c:121
154
155 Please see the documentation for talloc_set_log_fn() and
156 talloc_set_log_stderr() for more information on talloc logging
157 functions.
158
159 talloc_free() operates recursively on its children.
160
161 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
162 void talloc_free_children(void *ptr);
163
164 The talloc_free_children() walks along the list of all children of a
165 talloc context and talloc_free()s only the children, not the context
166 itself.
167
168 A NULL argument is handled as no-op.
169
170 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
171 void *talloc_reference(const void *context, const void *ptr);
172
173 The talloc_reference() function makes "context" an additional parent
174 of "ptr".
175
176 The return value of talloc_reference() is always the original pointer
177 "ptr", unless talloc ran out of memory in creating the reference in
178 which case it will return NULL (each additional reference consumes
179 around 48 bytes of memory on intel x86 platforms).
180
181 If "ptr" is NULL, then the function is a no-op, and simply returns NULL.
182
183 After creating a reference you can free it in one of the following
184 ways:
185
186   - you can talloc_free() any parent of the original pointer. That
187     will reduce the number of parents of this pointer by 1, and will
188     cause this pointer to be freed if it runs out of parents.
189
190   - you can talloc_free() the pointer itself if it has at maximum one
191     parent. This behaviour has been changed since the release of version
192     2.0. Further informations in the description of "talloc_free".
193
194 For more control on which parent to remove, see talloc_unlink()
195
196
197 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
198 int talloc_unlink(const void *context, void *ptr);
199
200 The talloc_unlink() function removes a specific parent from ptr. The
201 context passed must either be a context used in talloc_reference()
202 with this pointer, or must be a direct parent of ptr. 
203
204 Note that if the parent has already been removed using talloc_free()
205 then this function will fail and will return -1.  Likewise, if "ptr"
206 is NULL, then the function will make no modifications and return -1.
207
208 You can just use talloc_free() instead of talloc_unlink() if there
209 is at maximum one parent. This behaviour has been changed since the
210 release of version 2.0. Further informations in the description of
211 "talloc_free".
212
213 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
214 void talloc_set_destructor(const void *ptr, int (*destructor)(void *));
215
216 The function talloc_set_destructor() sets the "destructor" for the
217 pointer "ptr". A destructor is a function that is called when the
218 memory used by a pointer is about to be released. The destructor
219 receives the pointer as an argument, and should return 0 for success
220 and -1 for failure.
221
222 The destructor can do anything it wants to, including freeing other
223 pieces of memory. A common use for destructors is to clean up
224 operating system resources (such as open file descriptors) contained
225 in the structure the destructor is placed on.
226
227 You can only place one destructor on a pointer. If you need more than
228 one destructor then you can create a zero-length child of the pointer
229 and place an additional destructor on that.
230
231 To remove a destructor call talloc_set_destructor() with NULL for the
232 destructor.
233
234 If your destructor attempts to talloc_free() the pointer that it is
235 the destructor for then talloc_free() will return -1 and the free will
236 be ignored. This would be a pointless operation anyway, as the
237 destructor is only called when the memory is just about to go away.
238
239
240 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
241 int talloc_increase_ref_count(const void *ptr);
242
243 The talloc_increase_ref_count(ptr) function is exactly equivalent to:
244
245   talloc_reference(NULL, ptr);
246
247 You can use either syntax, depending on which you think is clearer in
248 your code.
249
250 It returns 0 on success and -1 on failure.
251
252 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
253 size_t talloc_reference_count(const void *ptr);
254
255 Return the number of references to the pointer.
256
257 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
258 void talloc_set_name(const void *ptr, const char *fmt, ...);
259
260 Each talloc pointer has a "name". The name is used principally for
261 debugging purposes, although it is also possible to set and get the
262 name on a pointer in as a way of "marking" pointers in your code.
263
264 The main use for names on pointer is for "talloc reports". See
265 talloc_report() and talloc_report_full() for details. Also see
266 talloc_enable_leak_report() and talloc_enable_leak_report_full().
267
268 The talloc_set_name() function allocates memory as a child of the
269 pointer. It is logically equivalent to:
270   talloc_set_name_const(ptr, talloc_asprintf(ptr, fmt, ...));
271
272 Note that multiple calls to talloc_set_name() will allocate more
273 memory without releasing the name. All of the memory is released when
274 the ptr is freed using talloc_free().
275
276
277 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
278 void talloc_set_name_const(const void *ptr, const char *name);
279
280 The function talloc_set_name_const() is just like talloc_set_name(),
281 but it takes a string constant, and is much faster. It is extensively
282 used by the "auto naming" macros, such as talloc_p().
283
284 This function does not allocate any memory. It just copies the
285 supplied pointer into the internal representation of the talloc
286 ptr. This means you must not pass a name pointer to memory that will
287 disappear before the ptr is freed with talloc_free().
288
289
290 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
291 void *talloc_named(const void *context, size_t size, const char *fmt, ...);
292
293 The talloc_named() function creates a named talloc pointer. It is
294 equivalent to:
295
296    ptr = talloc_size(context, size);
297    talloc_set_name(ptr, fmt, ....);
298
299
300 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
301 void *talloc_named_const(const void *context, size_t size, const char *name);
302
303 This is equivalent to::
304
305    ptr = talloc_size(context, size);
306    talloc_set_name_const(ptr, name);
307
308
309 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
310 const char *talloc_get_name(const void *ptr);
311
312 This returns the current name for the given talloc pointer. See
313 talloc_set_name() for details.
314
315
316 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
317 void *talloc_init(const char *fmt, ...);
318
319 This function creates a zero length named talloc context as a top
320 level context. It is equivalent to::
321
322   talloc_named(NULL, 0, fmt, ...);
323
324
325 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
326 void *talloc_new(void *ctx);
327
328 This is a utility macro that creates a new memory context hanging
329 off an exiting context, automatically naming it "talloc_new: __location__"
330 where __location__ is the source line it is called from. It is
331 particularly useful for creating a new temporary working context.
332
333
334 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
335 (type *)talloc_realloc(const void *context, void *ptr, type, count);
336
337 The talloc_realloc() macro changes the size of a talloc
338 pointer. The "count" argument is the number of elements of type "type"
339 that you want the resulting pointer to hold. 
340
341 talloc_realloc() has the following equivalences::
342
343   talloc_realloc(context, NULL, type, 1) ==> talloc(context, type);
344   talloc_realloc(context, NULL, type, N) ==> talloc_array(context, type, N);
345   talloc_realloc(context, ptr, type, 0)  ==> talloc_free(ptr);
346
347 The "context" argument is only used if "ptr" is NULL, otherwise it is
348 ignored.
349
350 talloc_realloc() returns the new pointer, or NULL on failure. The call
351 will fail either due to a lack of memory, or because the pointer has
352 more than one parent (see talloc_reference()).
353
354
355 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
356 void *talloc_realloc_size(const void *context, void *ptr, size_t size);
357
358 the talloc_realloc_size() function is useful when the type is not 
359 known so the typesafe talloc_realloc() cannot be used.
360
361
362 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
363 void *talloc_steal(const void *new_ctx, const void *ptr);
364
365 The talloc_steal() function changes the parent context of a talloc
366 pointer. It is typically used when the context that the pointer is
367 currently a child of is going to be freed and you wish to keep the
368 memory for a longer time. 
369
370 The talloc_steal() function returns the pointer that you pass it. It
371 does not have any failure modes.
372
373 NOTE: It is possible to produce loops in the parent/child relationship
374 if you are not careful with talloc_steal(). No guarantees are provided
375 as to your sanity or the safety of your data if you do this.
376
377 talloc_steal (new_ctx, NULL) will return NULL with no sideeffects.
378
379 Note that if you try and call talloc_steal() on a pointer that has
380 more than one parent then the result is ambiguous. Talloc will choose
381 to remove the parent that is currently indicated by talloc_parent()
382 and replace it with the chosen parent. You will also get a message
383 like this via the talloc logging functions:
384
385   WARNING: talloc_steal with references at some_dir/source/foo.c:123
386         reference at some_dir/source/other.c:325
387         reference at some_dir/source/third.c:121
388
389 To unambiguously change the parent of a pointer please see the
390 function talloc_reparent(). See the talloc_set_log_fn() documentation
391 for more information on talloc logging.
392
393 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
394 void *talloc_reparent(const void *old_parent, const void *new_parent, const void *ptr);
395
396 The talloc_reparent() function changes the parent context of a talloc
397 pointer. It is typically used when the context that the pointer is
398 currently a child of is going to be freed and you wish to keep the
399 memory for a longer time.
400
401 The talloc_reparent() function returns the pointer that you pass it. It
402 does not have any failure modes.
403
404 The difference between talloc_reparent() and talloc_steal() is that
405 talloc_reparent() can specify which parent you wish to change. This is
406 useful when a pointer has multiple parents via references.
407
408 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
409 void *talloc_parent(const void *ptr);
410
411 The talloc_parent() function returns the current talloc parent. This
412 is usually the pointer under which this memory was originally created,
413 but it may have changed due to a talloc_steal() or talloc_reparent()
414
415 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
416 size_t talloc_total_size(const void *ptr);
417
418 The talloc_total_size() function returns the total size in bytes used
419 by this pointer and all child pointers. Mostly useful for debugging.
420
421 Passing NULL is allowed, but it will only give a meaningful result if
422 talloc_enable_leak_report() or talloc_enable_leak_report_full() has
423 been called.
424
425
426 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
427 size_t talloc_total_blocks(const void *ptr);
428
429 The talloc_total_blocks() function returns the total memory block
430 count used by this pointer and all child pointers. Mostly useful for
431 debugging.
432
433 Passing NULL is allowed, but it will only give a meaningful result if
434 talloc_enable_leak_report() or talloc_enable_leak_report_full() has
435 been called.
436
437 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
438 void talloc_report_depth_cb(const void *ptr, int depth, int max_depth,
439                             void (*callback)(const void *ptr,
440                                              int depth, int max_depth,
441                                              int is_ref,
442                                              void *priv),
443                             void *priv);
444
445 This provides a more flexible reports than talloc_report(). It
446 will recursively call the callback for the entire tree of memory
447 referenced by the pointer. References in the tree are passed with
448 is_ref = 1 and the pointer that is referenced.
449
450 You can pass NULL for the pointer, in which case a report is
451 printed for the top level memory context, but only if
452 talloc_enable_leak_report() or talloc_enable_leak_report_full()
453 has been called.
454
455 The recursion is stopped when depth >= max_depth.
456 max_depth = -1 means only stop at leaf nodes.
457
458
459 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
460 void talloc_report_depth_file(const void *ptr, int depth, int max_depth, FILE *f);
461
462 This provides a more flexible reports than talloc_report(). It
463 will let you specify the depth and max_depth.
464
465
466 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
467 void talloc_report(const void *ptr, FILE *f);
468
469 The talloc_report() function prints a summary report of all memory
470 used by ptr. One line of report is printed for each immediate child of
471 ptr, showing the total memory and number of blocks used by that child.
472
473 You can pass NULL for the pointer, in which case a report is printed
474 for the top level memory context, but only if
475 talloc_enable_leak_report() or talloc_enable_leak_report_full() has
476 been called.
477
478
479 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
480 void talloc_report_full(const void *ptr, FILE *f);
481
482 This provides a more detailed report than talloc_report(). It will
483 recursively print the entire tree of memory referenced by the
484 pointer. References in the tree are shown by giving the name of the
485 pointer that is referenced.
486
487 You can pass NULL for the pointer, in which case a report is printed
488 for the top level memory context, but only if
489 talloc_enable_leak_report() or talloc_enable_leak_report_full() has
490 been called.
491
492
493 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
494 void talloc_enable_leak_report(void);
495
496 This enables calling of talloc_report(NULL, stderr) when the program
497 exits. In Samba4 this is enabled by using the --leak-report command
498 line option.
499
500 For it to be useful, this function must be called before any other
501 talloc function as it establishes a "null context" that acts as the
502 top of the tree. If you don't call this function first then passing
503 NULL to talloc_report() or talloc_report_full() won't give you the
504 full tree printout.
505
506 Here is a typical talloc report:
507
508 talloc report on 'null_context' (total 267 bytes in 15 blocks)
509         libcli/auth/spnego_parse.c:55  contains     31 bytes in   2 blocks
510         libcli/auth/spnego_parse.c:55  contains     31 bytes in   2 blocks
511         iconv(UTF8,CP850)              contains     42 bytes in   2 blocks
512         libcli/auth/spnego_parse.c:55  contains     31 bytes in   2 blocks
513         iconv(CP850,UTF8)              contains     42 bytes in   2 blocks
514         iconv(UTF8,UTF-16LE)           contains     45 bytes in   2 blocks
515         iconv(UTF-16LE,UTF8)           contains     45 bytes in   2 blocks
516
517
518 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
519 void talloc_enable_leak_report_full(void);
520
521 This enables calling of talloc_report_full(NULL, stderr) when the
522 program exits. In Samba4 this is enabled by using the
523 --leak-report-full command line option.
524
525 For it to be useful, this function must be called before any other
526 talloc function as it establishes a "null context" that acts as the
527 top of the tree. If you don't call this function first then passing
528 NULL to talloc_report() or talloc_report_full() won't give you the
529 full tree printout.
530
531 Here is a typical full report:
532
533 full talloc report on 'root' (total 18 bytes in 8 blocks)
534     p1                             contains     18 bytes in   7 blocks (ref 0)
535         r1                             contains     13 bytes in   2 blocks (ref 0)
536             reference to: p2
537         p2                             contains      1 bytes in   1 blocks (ref 1)
538         x3                             contains      1 bytes in   1 blocks (ref 0)
539         x2                             contains      1 bytes in   1 blocks (ref 0)
540         x1                             contains      1 bytes in   1 blocks (ref 0)
541
542
543 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
544 void talloc_enable_null_tracking(void);
545
546 This enables tracking of the NULL memory context without enabling leak
547 reporting on exit. Useful for when you want to do your own leak
548 reporting call via talloc_report_null_full();
549
550 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
551 void talloc_disable_null_tracking(void);
552
553 This disables tracking of the NULL memory context.
554
555 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
556 (type *)talloc_zero(const void *ctx, type);
557
558 The talloc_zero() macro is equivalent to::
559
560   ptr = talloc(ctx, type);
561   if (ptr) memset(ptr, 0, sizeof(type));
562
563
564 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
565 void *talloc_zero_size(const void *ctx, size_t size)
566
567 The talloc_zero_size() function is useful when you don't have a known type
568
569
570 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
571 void *talloc_memdup(const void *ctx, const void *p, size_t size);
572
573 The talloc_memdup() function is equivalent to::
574
575   ptr = talloc_size(ctx, size);
576   if (ptr) memcpy(ptr, p, size);
577
578
579 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
580 char *talloc_strdup(const void *ctx, const char *p);
581
582 The talloc_strdup() function is equivalent to::
583
584   ptr = talloc_size(ctx, strlen(p)+1);
585   if (ptr) memcpy(ptr, p, strlen(p)+1);
586
587 This functions sets the name of the new pointer to the passed
588 string. This is equivalent to::
589
590    talloc_set_name_const(ptr, ptr)
591
592 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
593 char *talloc_strndup(const void *t, const char *p, size_t n);
594
595 The talloc_strndup() function is the talloc equivalent of the C
596 library function strndup()
597
598 This functions sets the name of the new pointer to the passed
599 string. This is equivalent to:
600    talloc_set_name_const(ptr, ptr)
601
602 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
603 char *talloc_append_string(const void *t, char *orig, const char *append);
604
605 The talloc_append_string() function appends the given formatted
606 string to the given string.
607
608 This function sets the name of the new pointer to the new
609 string. This is equivalent to::
610
611    talloc_set_name_const(ptr, ptr)
612
613 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
614 char *talloc_vasprintf(const void *t, const char *fmt, va_list ap);
615
616 The talloc_vasprintf() function is the talloc equivalent of the C
617 library function vasprintf()
618
619 This functions sets the name of the new pointer to the new
620 string. This is equivalent to::
621
622    talloc_set_name_const(ptr, ptr)
623
624
625 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
626 char *talloc_asprintf(const void *t, const char *fmt, ...);
627
628 The talloc_asprintf() function is the talloc equivalent of the C
629 library function asprintf()
630
631 This functions sets the name of the new pointer to the new
632 string. This is equivalent to::
633
634    talloc_set_name_const(ptr, ptr)
635
636
637 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
638 char *talloc_asprintf_append(char *s, const char *fmt, ...);
639
640 The talloc_asprintf_append() function appends the given formatted
641 string to the given string.
642 Use this variant when the string in the current talloc buffer may
643 have been truncated in length.
644
645 This functions sets the name of the new pointer to the new
646 string. This is equivalent to::
647
648    talloc_set_name_const(ptr, ptr)
649
650
651 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
652 char *talloc_asprintf_append_buffer(char *s, const char *fmt, ...);
653
654 The talloc_asprintf_append() function appends the given formatted 
655 string to the end of the currently allocated talloc buffer.
656 Use this variant when the string in the current talloc buffer has
657 not been changed.
658
659 This functions sets the name of the new pointer to the new
660 string. This is equivalent to::
661
662    talloc_set_name_const(ptr, ptr)
663
664
665 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
666 ((type *)talloc_array(const void *ctx, type, unsigned int count);
667
668 The talloc_array() macro is equivalent to::
669
670   (type *)talloc_size(ctx, sizeof(type) * count);
671
672 except that it provides integer overflow protection for the multiply,
673 returning NULL if the multiply overflows.
674
675
676 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
677 void *talloc_array_size(const void *ctx, size_t size, unsigned int count);
678
679 The talloc_array_size() function is useful when the type is not
680 known. It operates in the same way as talloc_array(), but takes a size
681 instead of a type.
682
683 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
684 (typeof(ptr)) talloc_array_ptrtype(const void *ctx, ptr, unsigned int count);
685
686 The talloc_ptrtype() macro should be used when you have a pointer to an array
687 and want to allocate memory of an array to point at with this pointer. When compiling
688 with gcc >= 3 it is typesafe. Note this is a wrapper of talloc_array_size()
689 and talloc_get_name() will return the current location in the source file.
690 and not the type.
691
692 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
693 void *talloc_realloc_fn(const void *ctx, void *ptr, size_t size);
694
695 This is a non-macro version of talloc_realloc(), which is useful 
696 as libraries sometimes want a ralloc function pointer. A realloc()
697 implementation encapsulates the functionality of malloc(), free() and
698 realloc() in one call, which is why it is useful to be able to pass
699 around a single function pointer.
700
701
702 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
703 void *talloc_autofree_context(void);
704
705 This is a handy utility function that returns a talloc context
706 which will be automatically freed on program exit. This can be used
707 to reduce the noise in memory leak reports.
708
709
710 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
711 void *talloc_check_name(const void *ptr, const char *name);
712
713 This function checks if a pointer has the specified name. If it does
714 then the pointer is returned. It it doesn't then NULL is returned.
715
716
717 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
718 (type *)talloc_get_type(const void *ptr, type);
719
720 This macro allows you to do type checking on talloc pointers. It is
721 particularly useful for void* private pointers. It is equivalent to
722 this::
723
724    (type *)talloc_check_name(ptr, #type)
725
726
727 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
728 talloc_set_type(const void *ptr, type);
729
730 This macro allows you to force the name of a pointer to be of a
731 particular type. This can be used in conjunction with
732 talloc_get_type() to do type checking on void* pointers.
733
734 It is equivalent to this::
735
736    talloc_set_name_const(ptr, #type)
737
738 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
739 talloc_get_size(const void *ctx);
740
741 This function lets you know the amount of memory allocated so far by
742 this context. It does NOT account for subcontext memory.
743 This can be used to calculate the size of an array.
744
745 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
746 void *talloc_find_parent_byname(const void *ctx, const char *name);
747
748 Find a parent memory context of the current context that has the given
749 name. This can be very useful in complex programs where it may be
750 difficult to pass all information down to the level you need, but you
751 know the structure you want is a parent of another context.
752
753 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
754 (type *)talloc_find_parent_bytype(ctx, type);
755
756 Like talloc_find_parent_byname() but takes a type, making it typesafe.
757
758 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
759 void talloc_set_log_fn(void (*log_fn)(const char *message));
760
761 This function sets a logging function that talloc will use for
762 warnings and errors. By default talloc will not print any warnings or
763 errors.
764
765 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
766 void talloc_set_log_stderr(void)
767
768 This sets the talloc log function to write log messages to stderr.