lib/talloc/talloc_guide.txt

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