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