lib/talloc/talloc.c

   1 /*
   2    Samba Unix SMB/CIFS implementation.
   3
   4    Samba trivial allocation library - new interface
   5
   6    NOTE: Please read talloc_guide.txt for full documentation
   7
   8    Copyright (C) Andrew Tridgell 2004
   9    Copyright (C) Stefan Metzmacher 2006
  10
  11      ** NOTE! The following LGPL license applies to the talloc
  12      ** library. This does NOT imply that all of Samba is released
  13      ** under the LGPL
  14
  15    This library is free software; you can redistribute it and/or
  16    modify it under the terms of the GNU Lesser General Public
  17    License as published by the Free Software Foundation; either
  18    version 3 of the License, or (at your option) any later version.
  19
  20    This library is distributed in the hope that it will be useful,
  21    but WITHOUT ANY WARRANTY; without even the implied warranty of
  22    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  23    Lesser General Public License for more details.
  24
  25    You should have received a copy of the GNU Lesser General Public
  26    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  27 */
  28
  29 /*
  30   inspired by http://swapped.cc/halloc/
  31 */
  32
  33 #include "replace.h"
  34 #include "talloc.h"
  35
  36 #ifdef TALLOC_BUILD_VERSION_MAJOR
  37 #if (TALLOC_VERSION_MAJOR != TALLOC_BUILD_VERSION_MAJOR)
  38 #error "TALLOC_VERSION_MAJOR != TALLOC_BUILD_VERSION_MAJOR"
  39 #endif
  40 #endif
  41
  42 #ifdef TALLOC_BUILD_VERSION_MINOR
  43 #if (TALLOC_VERSION_MINOR != TALLOC_BUILD_VERSION_MINOR)
  44 #error "TALLOC_VERSION_MINOR != TALLOC_BUILD_VERSION_MINOR"
  45 #endif
  46 #endif
  47
  48 /* Special macros that are no-ops except when run under Valgrind on
  49  * x86.  They've moved a little bit from valgrind 1.0.4 to 1.9.4 */
  50 #ifdef HAVE_VALGRIND_MEMCHECK_H
  51         /* memcheck.h includes valgrind.h */
  52 #include <valgrind/memcheck.h>
  53 #elif defined(HAVE_VALGRIND_H)
  54 #include <valgrind.h>
  55 #endif
  56
  57 /* use this to force every realloc to change the pointer, to stress test
  58    code that might not cope */
  59 #define ALWAYS_REALLOC 0
  60
  61
  62 #define MAX_TALLOC_SIZE 0x10000000
  63 #define TALLOC_MAGIC_BASE 0xe814ec70
  64 #define TALLOC_MAGIC ( \
  65         TALLOC_MAGIC_BASE + \
  66         (TALLOC_VERSION_MAJOR << 12) + \
  67         (TALLOC_VERSION_MINOR << 4) \
  68 )
  69
  70 #define TALLOC_FLAG_FREE 0x01
  71 #define TALLOC_FLAG_LOOP 0x02
  72 #define TALLOC_FLAG_POOL 0x04           /* This is a talloc pool */
  73 #define TALLOC_FLAG_POOLMEM 0x08        /* This is allocated in a pool */
  74 #define TALLOC_MAGIC_REFERENCE ((const char *)1)
  75
  76 /* by default we abort when given a bad pointer (such as when talloc_free() is called
  77    on a pointer that came from malloc() */
  78 #ifndef TALLOC_ABORT
  79 #define TALLOC_ABORT(reason) abort()
  80 #endif
  81
  82 #ifndef discard_const_p
  83 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
  84 # define discard_const_p(type, ptr) ((type *)((intptr_t)(ptr)))
  85 #else
  86 # define discard_const_p(type, ptr) ((type *)(ptr))
  87 #endif
  88 #endif
  89
  90 /* these macros gain us a few percent of speed on gcc */
  91 #if (__GNUC__ >= 3)
  92 /* the strange !! is to ensure that __builtin_expect() takes either 0 or 1
  93    as its first argument */
  94 #ifndef likely
  95 #define likely(x)   __builtin_expect(!!(x), 1)
  96 #endif
  97 #ifndef unlikely
  98 #define unlikely(x) __builtin_expect(!!(x), 0)
  99 #endif
 100 #else
 101 #ifndef likely
 102 #define likely(x) (x)
 103 #endif
 104 #ifndef unlikely
 105 #define unlikely(x) (x)
 106 #endif
 107 #endif
 108
 109 /* this null_context is only used if talloc_enable_leak_report() or
 110    talloc_enable_leak_report_full() is called, otherwise it remains
 111    NULL
 112 */
 113 static void *null_context;
 114 static void *autofree_context;
 115
 116 /* used to enable fill of memory on free, which can be useful for
 117  * catching use after free errors when valgrind is too slow
 118  */
 119 static struct {
 120         bool initialised;
 121         bool enabled;
 122         uint8_t fill_value;
 123 } talloc_fill;
 124
 125 #define TALLOC_FILL_ENV "TALLOC_FREE_FILL"
 126
 127 /*
 128  * do not wipe the header, to allow the
 129  * double-free logic to still work
 130  */
 131 #define TC_INVALIDATE_FULL_FILL_CHUNK(_tc) do { \
 132         if (unlikely(talloc_fill.enabled)) { \
 133                 size_t _flen = (_tc)->size; \
 134                 char *_fptr = (char *)TC_PTR_FROM_CHUNK(_tc); \
 135                 memset(_fptr, talloc_fill.fill_value, _flen); \
 136         } \
 137 } while (0)
 138
 139 #if defined(DEVELOPER) && defined(VALGRIND_MAKE_MEM_NOACCESS)
 140 /* Mark the whole chunk as not accessable */
 141 #define TC_INVALIDATE_FULL_VALGRIND_CHUNK(_tc) do { \
 142         size_t _flen = TC_HDR_SIZE + (_tc)->size; \
 143         char *_fptr = (char *)(_tc); \
 144         VALGRIND_MAKE_MEM_NOACCESS(_fptr, _flen); \
 145 } while(0)
 146 #else
 147 #define TC_INVALIDATE_FULL_VALGRIND_CHUNK(_tc) do { } while (0)
 148 #endif
 149
 150 #define TC_INVALIDATE_FULL_CHUNK(_tc) do { \
 151         TC_INVALIDATE_FULL_FILL_CHUNK(_tc); \
 152         TC_INVALIDATE_FULL_VALGRIND_CHUNK(_tc); \
 153 } while (0)
 154
 155 #define TC_INVALIDATE_SHRINK_FILL_CHUNK(_tc, _new_size) do { \
 156         if (unlikely(talloc_fill.enabled)) { \
 157                 size_t _flen = (_tc)->size - (_new_size); \
 158                 char *_fptr = (char *)TC_PTR_FROM_CHUNK(_tc); \
 159                 _fptr += (_new_size); \
 160                 memset(_fptr, talloc_fill.fill_value, _flen); \
 161         } \
 162 } while (0)
 163
 164 #if defined(DEVELOPER) && defined(VALGRIND_MAKE_MEM_NOACCESS)
 165 /* Mark the unused bytes not accessable */
 166 #define TC_INVALIDATE_SHRINK_VALGRIND_CHUNK(_tc, _new_size) do { \
 167         size_t _flen = (_tc)->size - (_new_size); \
 168         char *_fptr = (char *)TC_PTR_FROM_CHUNK(_tc); \
 169         _fptr += (_new_size); \
 170         VALGRIND_MAKE_MEM_NOACCESS(_fptr, _flen); \
 171 } while (0)
 172 #else
 173 #define TC_INVALIDATE_SHRINK_VALGRIND_CHUNK(_tc, _new_size) do { } while (0)
 174 #endif
 175
 176 #define TC_INVALIDATE_SHRINK_CHUNK(_tc, _new_size) do { \
 177         TC_INVALIDATE_SHRINK_FILL_CHUNK(_tc, _new_size); \
 178         TC_INVALIDATE_SHRINK_VALGRIND_CHUNK(_tc, _new_size); \
 179 } while (0)
 180
 181 #define TC_UNDEFINE_SHRINK_FILL_CHUNK(_tc, _new_size) do { \
 182         if (unlikely(talloc_fill.enabled)) { \
 183                 size_t _flen = (_tc)->size - (_new_size); \
 184                 char *_fptr = (char *)TC_PTR_FROM_CHUNK(_tc); \
 185                 _fptr += (_new_size); \
 186                 memset(_fptr, talloc_fill.fill_value, _flen); \
 187         } \
 188 } while (0)
 189
 190 #if defined(DEVELOPER) && defined(VALGRIND_MAKE_MEM_UNDEFINED)
 191 /* Mark the unused bytes as undefined */
 192 #define TC_UNDEFINE_SHRINK_VALGRIND_CHUNK(_tc, _new_size) do { \
 193         size_t _flen = (_tc)->size - (_new_size); \
 194         char *_fptr = (char *)TC_PTR_FROM_CHUNK(_tc); \
 195         _fptr += (_new_size); \
 196         VALGRIND_MAKE_MEM_UNDEFINED(_fptr, _flen); \
 197 } while (0)
 198 #else
 199 #define TC_UNDEFINE_SHRINK_VALGRIND_CHUNK(_tc, _new_size) do { } while (0)
 200 #endif
 201
 202 #define TC_UNDEFINE_SHRINK_CHUNK(_tc, _new_size) do { \
 203         TC_UNDEFINE_SHRINK_FILL_CHUNK(_tc, _new_size); \
 204         TC_UNDEFINE_SHRINK_VALGRIND_CHUNK(_tc, _new_size); \
 205 } while (0)
 206
 207 #if defined(DEVELOPER) && defined(VALGRIND_MAKE_MEM_UNDEFINED)
 208 /* Mark the new bytes as undefined */
 209 #define TC_UNDEFINE_GROW_VALGRIND_CHUNK(_tc, _new_size) do { \
 210         size_t _old_used = TC_HDR_SIZE + (_tc)->size; \
 211         size_t _new_used = TC_HDR_SIZE + (_new_size); \
 212         size_t _flen = _new_used - _old_used; \
 213         char *_fptr = _old_used + (char *)(_tc); \
 214         VALGRIND_MAKE_MEM_UNDEFINED(_fptr, _flen); \
 215 } while (0)
 216 #else
 217 #define TC_UNDEFINE_GROW_VALGRIND_CHUNK(_tc, _new_size) do { } while (0)
 218 #endif
 219
 220 #define TC_UNDEFINE_GROW_CHUNK(_tc, _new_size) do { \
 221         TC_UNDEFINE_GROW_VALGRIND_CHUNK(_tc, _new_size); \
 222 } while (0)
 223
 224 struct talloc_reference_handle {
 225         struct talloc_reference_handle *next, *prev;
 226         void *ptr;
 227         const char *location;
 228 };
 229
 230 typedef int (*talloc_destructor_t)(void *);
 231
 232 struct talloc_chunk {
 233         struct talloc_chunk *next, *prev;
 234         struct talloc_chunk *parent, *child;
 235         struct talloc_reference_handle *refs;
 236         talloc_destructor_t destructor;
 237         const char *name;
 238         size_t size;
 239         unsigned flags;
 240
 241         /*
 242          * "pool" has dual use:
 243          *
 244          * For the talloc pool itself (i.e. TALLOC_FLAG_POOL is set), "pool"
 245          * marks the end of the currently allocated area.
 246          *
 247          * For members of the pool (i.e. TALLOC_FLAG_POOLMEM is set), "pool"
 248          * is a pointer to the struct talloc_chunk of the pool that it was
 249          * allocated from. This way children can quickly find the pool to chew
 250          * from.
 251          */
 252         void *pool;
 253 };
 254
 255 /* 16 byte alignment seems to keep everyone happy */
 256 #define TC_ALIGN16(s) (((s)+15)&~15)
 257 #define TC_HDR_SIZE TC_ALIGN16(sizeof(struct talloc_chunk))
 258 #define TC_PTR_FROM_CHUNK(tc) ((void *)(TC_HDR_SIZE + (char*)tc))
 259
 260 _PUBLIC_ int talloc_version_major(void)
 261 {
 262         return TALLOC_VERSION_MAJOR;
 263 }
 264
 265 _PUBLIC_ int talloc_version_minor(void)
 266 {
 267         return TALLOC_VERSION_MINOR;
 268 }
 269
 270 static void (*talloc_log_fn)(const char *message);
 271
 272 _PUBLIC_ void talloc_set_log_fn(void (*log_fn)(const char *message))
 273 {
 274         talloc_log_fn = log_fn;
 275 }
 276
 277 static void talloc_log(const char *fmt, ...) PRINTF_ATTRIBUTE(1,2);
 278 static void talloc_log(const char *fmt, ...)
 279 {
 280         va_list ap;
 281         char *message;
 282
 283         if (!talloc_log_fn) {
 284                 return;
 285         }
 286
 287         va_start(ap, fmt);
 288         message = talloc_vasprintf(NULL, fmt, ap);
 289         va_end(ap);
 290
 291         talloc_log_fn(message);
 292         talloc_free(message);
 293 }
 294
 295 static void talloc_log_stderr(const char *message)
 296 {
 297         fprintf(stderr, "%s", message);
 298 }
 299
 300 _PUBLIC_ void talloc_set_log_stderr(void)
 301 {
 302         talloc_set_log_fn(talloc_log_stderr);
 303 }
 304
 305 static void (*talloc_abort_fn)(const char *reason);
 306
 307 _PUBLIC_ void talloc_set_abort_fn(void (*abort_fn)(const char *reason))
 308 {
 309         talloc_abort_fn = abort_fn;
 310 }
 311
 312 static void talloc_abort(const char *reason)
 313 {
 314         talloc_log("%s\n", reason);
 315
 316         if (!talloc_abort_fn) {
 317                 TALLOC_ABORT(reason);
 318         }
 319
 320         talloc_abort_fn(reason);
 321 }
 322
 323 static void talloc_abort_magic(unsigned magic)
 324 {
 325         unsigned striped = magic - TALLOC_MAGIC_BASE;
 326         unsigned major = (striped & 0xFFFFF000) >> 12;
 327         unsigned minor = (striped & 0x00000FF0) >> 4;
 328         talloc_log("Bad talloc magic[0x%08X/%u/%u] expected[0x%08X/%u/%u]\n",
 329                    magic, major, minor,
 330                    TALLOC_MAGIC, TALLOC_VERSION_MAJOR, TALLOC_VERSION_MINOR);
 331         talloc_abort("Bad talloc magic value - wrong talloc version used/mixed");
 332 }
 333
 334 static void talloc_abort_access_after_free(void)
 335 {
 336         talloc_abort("Bad talloc magic value - access after free");
 337 }
 338
 339 static void talloc_abort_unknown_value(void)
 340 {
 341         talloc_abort("Bad talloc magic value - unknown value");
 342 }
 343
 344 /* panic if we get a bad magic value */
 345 static inline struct talloc_chunk *talloc_chunk_from_ptr(const void *ptr)
 346 {
 347         const char *pp = (const char *)ptr;
 348         struct talloc_chunk *tc = discard_const_p(struct talloc_chunk, pp - TC_HDR_SIZE);
 349         if (unlikely((tc->flags & (TALLOC_FLAG_FREE | ~0xF)) != TALLOC_MAGIC)) {
 350                 if ((tc->flags & (~0xFFF)) == TALLOC_MAGIC_BASE) {
 351                         talloc_abort_magic(tc->flags & (~0xF));
 352                         return NULL;
 353                 }
 354
 355                 if (tc->flags & TALLOC_FLAG_FREE) {
 356                         talloc_log("talloc: access after free error - first free may be at %s\n", tc->name);
 357                         talloc_abort_access_after_free();
 358                         return NULL;
 359                 } else {
 360                         talloc_abort_unknown_value();
 361                         return NULL;
 362                 }
 363         }
 364         return tc;
 365 }
 366
 367 /* hook into the front of the list */
 368 #define _TLIST_ADD(list, p) \
 369 do { \
 370         if (!(list)) { \
 371                 (list) = (p); \
 372                 (p)->next = (p)->prev = NULL; \
 373         } else { \
 374                 (list)->prev = (p); \
 375                 (p)->next = (list); \
 376                 (p)->prev = NULL; \
 377                 (list) = (p); \
 378         }\
 379 } while (0)
 380
 381 /* remove an element from a list - element doesn't have to be in list. */
 382 #define _TLIST_REMOVE(list, p) \
 383 do { \
 384         if ((p) == (list)) { \
 385                 (list) = (p)->next; \
 386                 if (list) (list)->prev = NULL; \
 387         } else { \
 388                 if ((p)->prev) (p)->prev->next = (p)->next; \
 389                 if ((p)->next) (p)->next->prev = (p)->prev; \
 390         } \
 391         if ((p) && ((p) != (list))) (p)->next = (p)->prev = NULL; \
 392 } while (0)
 393
 394
 395 /*
 396   return the parent chunk of a pointer
 397 */
 398 static inline struct talloc_chunk *talloc_parent_chunk(const void *ptr)
 399 {
 400         struct talloc_chunk *tc;
 401
 402         if (unlikely(ptr == NULL)) {
 403                 return NULL;
 404         }
 405
 406         tc = talloc_chunk_from_ptr(ptr);
 407         while (tc->prev) tc=tc->prev;
 408
 409         return tc->parent;
 410 }
 411
 412 _PUBLIC_ void *talloc_parent(const void *ptr)
 413 {
 414         struct talloc_chunk *tc = talloc_parent_chunk(ptr);
 415         return tc? TC_PTR_FROM_CHUNK(tc) : NULL;
 416 }
 417
 418 /*
 419   find parents name
 420 */
 421 _PUBLIC_ const char *talloc_parent_name(const void *ptr)
 422 {
 423         struct talloc_chunk *tc = talloc_parent_chunk(ptr);
 424         return tc? tc->name : NULL;
 425 }
 426
 427 /*
 428   A pool carries an in-pool object count count in the first 16 bytes.
 429   bytes. This is done to support talloc_steal() to a parent outside of the
 430   pool. The count includes the pool itself, so a talloc_free() on a pool will
 431   only destroy the pool if the count has dropped to zero. A talloc_free() of a
 432   pool member will reduce the count, and eventually also call free(3) on the
 433   pool memory.
 434
 435   The object count is not put into "struct talloc_chunk" because it is only
 436   relevant for talloc pools and the alignment to 16 bytes would increase the
 437   memory footprint of each talloc chunk by those 16 bytes.
 438 */
 439
 440 #define TALLOC_POOL_HDR_SIZE 16
 441
 442 #define TC_POOL_SPACE_LEFT(_pool_tc) \
 443         PTR_DIFF(TC_HDR_SIZE + (_pool_tc)->size + (char *)(_pool_tc), \
 444                  (_pool_tc)->pool)
 445
 446 #define TC_POOL_FIRST_CHUNK(_pool_tc) \
 447         ((void *)(TC_HDR_SIZE + TALLOC_POOL_HDR_SIZE + (char *)(_pool_tc)))
 448
 449 #define TC_POOLMEM_CHUNK_SIZE(_tc) \
 450         TC_ALIGN16(TC_HDR_SIZE + (_tc)->size)
 451
 452 #define TC_POOLMEM_NEXT_CHUNK(_tc) \
 453         ((void *)(TC_POOLMEM_CHUNK_SIZE(tc) + (char*)(_tc)))
 454
 455 /* Mark the whole remaining pool as not accessable */
 456 #define TC_INVALIDATE_FILL_POOL(_pool_tc) do { \
 457         if (unlikely(talloc_fill.enabled)) { \
 458                 size_t _flen = TC_POOL_SPACE_LEFT(_pool_tc); \
 459                 char *_fptr = (char *)(_pool_tc)->pool; \
 460                 memset(_fptr, talloc_fill.fill_value, _flen); \
 461         } \
 462 } while(0)
 463
 464 #if defined(DEVELOPER) && defined(VALGRIND_MAKE_MEM_NOACCESS)
 465 /* Mark the whole remaining pool as not accessable */
 466 #define TC_INVALIDATE_VALGRIND_POOL(_pool_tc) do { \
 467         size_t _flen = TC_POOL_SPACE_LEFT(_pool_tc); \
 468         char *_fptr = (char *)(_pool_tc)->pool; \
 469         VALGRIND_MAKE_MEM_NOACCESS(_fptr, _flen); \
 470 } while(0)
 471 #else
 472 #define TC_INVALIDATE_VALGRIND_POOL(_pool_tc) do { } while (0)
 473 #endif
 474
 475 #define TC_INVALIDATE_POOL(_pool_tc) do { \
 476         TC_INVALIDATE_FILL_POOL(_pool_tc); \
 477         TC_INVALIDATE_VALGRIND_POOL(_pool_tc); \
 478 } while (0)
 479
 480 static unsigned int *talloc_pool_objectcount(struct talloc_chunk *tc)
 481 {
 482         return (unsigned int *)((char *)tc + TC_HDR_SIZE);
 483 }
 484
 485 /*
 486   Allocate from a pool
 487 */
 488
 489 static struct talloc_chunk *talloc_alloc_pool(struct talloc_chunk *parent,
 490                                               size_t size)
 491 {
 492         struct talloc_chunk *pool_ctx = NULL;
 493         size_t space_left;
 494         struct talloc_chunk *result;
 495         size_t chunk_size;
 496
 497         if (parent == NULL) {
 498                 return NULL;
 499         }
 500
 501         if (parent->flags & TALLOC_FLAG_POOL) {
 502                 pool_ctx = parent;
 503         }
 504         else if (parent->flags & TALLOC_FLAG_POOLMEM) {
 505                 pool_ctx = (struct talloc_chunk *)parent->pool;
 506         }
 507
 508         if (pool_ctx == NULL) {
 509                 return NULL;
 510         }
 511
 512         space_left = TC_POOL_SPACE_LEFT(pool_ctx);
 513
 514         /*
 515          * Align size to 16 bytes
 516          */
 517         chunk_size = TC_ALIGN16(size);
 518
 519         if (space_left < chunk_size) {
 520                 return NULL;
 521         }
 522
 523         result = (struct talloc_chunk *)pool_ctx->pool;
 524
 525 #if defined(DEVELOPER) && defined(VALGRIND_MAKE_MEM_UNDEFINED)
 526         VALGRIND_MAKE_MEM_UNDEFINED(result, size);
 527 #endif
 528
 529         pool_ctx->pool = (void *)((char *)result + chunk_size);
 530
 531         result->flags = TALLOC_MAGIC | TALLOC_FLAG_POOLMEM;
 532         result->pool = pool_ctx;
 533
 534         *talloc_pool_objectcount(pool_ctx) += 1;
 535
 536         return result;
 537 }
 538
 539 /*
 540    Allocate a bit of memory as a child of an existing pointer
 541 */
 542 static inline void *__talloc(const void *context, size_t size)
 543 {
 544         struct talloc_chunk *tc = NULL;
 545
 546         if (unlikely(context == NULL)) {
 547                 context = null_context;
 548         }
 549
 550         if (unlikely(size >= MAX_TALLOC_SIZE)) {
 551                 return NULL;
 552         }
 553
 554         if (context != NULL) {
 555                 tc = talloc_alloc_pool(talloc_chunk_from_ptr(context),
 556                                        TC_HDR_SIZE+size);
 557         }
 558
 559         if (tc == NULL) {
 560                 tc = (struct talloc_chunk *)malloc(TC_HDR_SIZE+size);
 561                 if (unlikely(tc == NULL)) return NULL;
 562                 tc->flags = TALLOC_MAGIC;
 563                 tc->pool  = NULL;
 564         }
 565
 566         tc->size = size;
 567         tc->destructor = NULL;
 568         tc->child = NULL;
 569         tc->name = NULL;
 570         tc->refs = NULL;
 571
 572         if (likely(context)) {
 573                 struct talloc_chunk *parent = talloc_chunk_from_ptr(context);
 574
 575                 if (parent->child) {
 576                         parent->child->parent = NULL;
 577                         tc->next = parent->child;
 578                         tc->next->prev = tc;
 579                 } else {
 580                         tc->next = NULL;
 581                 }
 582                 tc->parent = parent;
 583                 tc->prev = NULL;
 584                 parent->child = tc;
 585         } else {
 586                 tc->next = tc->prev = tc->parent = NULL;
 587         }
 588
 589         return TC_PTR_FROM_CHUNK(tc);
 590 }
 591
 592 /*
 593  * Create a talloc pool
 594  */
 595
 596 _PUBLIC_ void *talloc_pool(const void *context, size_t size)
 597 {
 598         void *result = __talloc(context, size + TALLOC_POOL_HDR_SIZE);
 599         struct talloc_chunk *tc;
 600
 601         if (unlikely(result == NULL)) {
 602                 return NULL;
 603         }
 604
 605         tc = talloc_chunk_from_ptr(result);
 606
 607         tc->flags |= TALLOC_FLAG_POOL;
 608         tc->pool = TC_POOL_FIRST_CHUNK(tc);
 609
 610         *talloc_pool_objectcount(tc) = 1;
 611
 612         TC_INVALIDATE_POOL(tc);
 613
 614         return result;
 615 }
 616
 617 /*
 618   setup a destructor to be called on free of a pointer
 619   the destructor should return 0 on success, or -1 on failure.
 620   if the destructor fails then the free is failed, and the memory can
 621   be continued to be used
 622 */
 623 _PUBLIC_ void _talloc_set_destructor(const void *ptr, int (*destructor)(void *))
 624 {
 625         struct talloc_chunk *tc = talloc_chunk_from_ptr(ptr);
 626         tc->destructor = destructor;
 627 }
 628
 629 /*
 630   increase the reference count on a piece of memory.
 631 */
 632 _PUBLIC_ int talloc_increase_ref_count(const void *ptr)
 633 {
 634         if (unlikely(!talloc_reference(null_context, ptr))) {
 635                 return -1;
 636         }
 637         return 0;
 638 }
 639
 640 /*
 641   helper for talloc_reference()
 642
 643   this is referenced by a function pointer and should not be inline
 644 */
 645 static int talloc_reference_destructor(struct talloc_reference_handle *handle)
 646 {
 647         struct talloc_chunk *ptr_tc = talloc_chunk_from_ptr(handle->ptr);
 648         _TLIST_REMOVE(ptr_tc->refs, handle);
 649         return 0;
 650 }
 651
 652 /*
 653    more efficient way to add a name to a pointer - the name must point to a
 654    true string constant
 655 */
 656 static inline void _talloc_set_name_const(const void *ptr, const char *name)
 657 {
 658         struct talloc_chunk *tc = talloc_chunk_from_ptr(ptr);
 659         tc->name = name;
 660 }
 661
 662 /*
 663   internal talloc_named_const()
 664 */
 665 static inline void *_talloc_named_const(const void *context, size_t size, const char *name)
 666 {
 667         void *ptr;
 668
 669         ptr = __talloc(context, size);
 670         if (unlikely(ptr == NULL)) {
 671                 return NULL;
 672         }
 673
 674         _talloc_set_name_const(ptr, name);
 675
 676         return ptr;
 677 }
 678
 679 /*
 680   make a secondary reference to a pointer, hanging off the given context.
 681   the pointer remains valid until both the original caller and this given
 682   context are freed.
 683
 684   the major use for this is when two different structures need to reference the
 685   same underlying data, and you want to be able to free the two instances separately,
 686   and in either order
 687 */
 688 _PUBLIC_ void *_talloc_reference_loc(const void *context, const void *ptr, const char *location)
 689 {
 690         struct talloc_chunk *tc;
 691         struct talloc_reference_handle *handle;
 692         if (unlikely(ptr == NULL)) return NULL;
 693
 694         tc = talloc_chunk_from_ptr(ptr);
 695         handle = (struct talloc_reference_handle *)_talloc_named_const(context,
 696                                                    sizeof(struct talloc_reference_handle),
 697                                                    TALLOC_MAGIC_REFERENCE);
 698         if (unlikely(handle == NULL)) return NULL;
 699
 700         /* note that we hang the destructor off the handle, not the
 701            main context as that allows the caller to still setup their
 702            own destructor on the context if they want to */
 703         talloc_set_destructor(handle, talloc_reference_destructor);
 704         handle->ptr = discard_const_p(void, ptr);
 705         handle->location = location;
 706         _TLIST_ADD(tc->refs, handle);
 707         return handle->ptr;
 708 }
 709
 710 static void *_talloc_steal_internal(const void *new_ctx, const void *ptr);
 711
 712 static inline void _talloc_free_poolmem(struct talloc_chunk *tc,
 713                                         const char *location)
 714 {
 715         struct talloc_chunk *pool;
 716         void *next_tc;
 717         unsigned int *pool_object_count;
 718
 719         pool = (struct talloc_chunk *)tc->pool;
 720         next_tc = TC_POOLMEM_NEXT_CHUNK(tc);
 721
 722         tc->flags |= TALLOC_FLAG_FREE;
 723
 724         /* we mark the freed memory with where we called the free
 725          * from. This means on a double free error we can report where
 726          * the first free came from
 727          */
 728         tc->name = location;
 729
 730         TC_INVALIDATE_FULL_CHUNK(tc);
 731
 732         pool_object_count = talloc_pool_objectcount(pool);
 733
 734         if (unlikely(*pool_object_count == 0)) {
 735                 talloc_abort("Pool object count zero!");
 736                 return;
 737         }
 738
 739         *pool_object_count -= 1;
 740
 741         if (unlikely(*pool_object_count == 1 && !(pool->flags & TALLOC_FLAG_FREE))) {
 742                 /*
 743                  * if there is just one object left in the pool
 744                  * and pool->flags does not have TALLOC_FLAG_FREE,
 745                  * it means this is the pool itself and
 746                  * the rest is available for new objects
 747                  * again.
 748                  */
 749                 pool->pool = TC_POOL_FIRST_CHUNK(pool);
 750                 TC_INVALIDATE_POOL(pool);
 751         } else if (unlikely(*pool_object_count == 0)) {
 752                 /*
 753                  * we mark the freed memory with where we called the free
 754                  * from. This means on a double free error we can report where
 755                  * the first free came from
 756                  */
 757                 pool->name = location;
 758
 759                 TC_INVALIDATE_FULL_CHUNK(pool);
 760                 free(pool);
 761         } else if (pool->pool == next_tc) {
 762                 /*
 763                  * if pool->pool still points to end of
 764                  * 'tc' (which is stored in the 'next_tc' variable),
 765                  * we can reclaim the memory of 'tc'.
 766                  */
 767                 pool->pool = tc;
 768         }
 769 }
 770
 771 static inline void _talloc_free_children_internal(struct talloc_chunk *tc,
 772                                                   void *ptr,
 773                                                   const char *location);
 774
 775 /*
 776    internal talloc_free call
 777 */
 778 static inline int _talloc_free_internal(void *ptr, const char *location)
 779 {
 780         struct talloc_chunk *tc;
 781
 782         if (unlikely(ptr == NULL)) {
 783                 return -1;
 784         }
 785
 786         /* possibly initialised the talloc fill value */
 787         if (unlikely(!talloc_fill.initialised)) {
 788                 const char *fill = getenv(TALLOC_FILL_ENV);
 789                 if (fill != NULL) {
 790                         talloc_fill.enabled = true;
 791                         talloc_fill.fill_value = strtoul(fill, NULL, 0);
 792                 }
 793                 talloc_fill.initialised = true;
 794         }
 795
 796         tc = talloc_chunk_from_ptr(ptr);
 797
 798         if (unlikely(tc->refs)) {
 799                 int is_child;
 800                 /* check if this is a reference from a child or
 801                  * grandchild back to it's parent or grandparent
 802                  *
 803                  * in that case we need to remove the reference and
 804                  * call another instance of talloc_free() on the current
 805                  * pointer.
 806                  */
 807                 is_child = talloc_is_parent(tc->refs, ptr);
 808                 _talloc_free_internal(tc->refs, location);
 809                 if (is_child) {
 810                         return _talloc_free_internal(ptr, location);
 811                 }
 812                 return -1;
 813         }
 814
 815         if (unlikely(tc->flags & TALLOC_FLAG_LOOP)) {
 816                 /* we have a free loop - stop looping */
 817                 return 0;
 818         }
 819
 820         if (unlikely(tc->destructor)) {
 821                 talloc_destructor_t d = tc->destructor;
 822                 if (d == (talloc_destructor_t)-1) {
 823                         return -1;
 824                 }
 825                 tc->destructor = (talloc_destructor_t)-1;
 826                 if (d(ptr) == -1) {
 827                         tc->destructor = d;
 828                         return -1;
 829                 }
 830                 tc->destructor = NULL;
 831         }
 832
 833         if (tc->parent) {
 834                 _TLIST_REMOVE(tc->parent->child, tc);
 835                 if (tc->parent->child) {
 836                         tc->parent->child->parent = tc->parent;
 837                 }
 838         } else {
 839                 if (tc->prev) tc->prev->next = tc->next;
 840                 if (tc->next) tc->next->prev = tc->prev;
 841                 tc->prev = tc->next = NULL;
 842         }
 843
 844         tc->flags |= TALLOC_FLAG_LOOP;
 845
 846         _talloc_free_children_internal(tc, ptr, location);
 847
 848         tc->flags |= TALLOC_FLAG_FREE;
 849
 850         /* we mark the freed memory with where we called the free
 851          * from. This means on a double free error we can report where
 852          * the first free came from
 853          */
 854         tc->name = location;
 855
 856         if (tc->flags & TALLOC_FLAG_POOL) {
 857                 unsigned int *pool_object_count;
 858
 859                 pool_object_count = talloc_pool_objectcount(tc);
 860
 861                 if (unlikely(*pool_object_count == 0)) {
 862                         talloc_abort("Pool object count zero!");
 863                         return 0;
 864                 }
 865
 866                 *pool_object_count -= 1;
 867
 868                 if (unlikely(*pool_object_count == 0)) {
 869                         TC_INVALIDATE_FULL_CHUNK(tc);
 870                         free(tc);
 871                 }
 872         } else if (tc->flags & TALLOC_FLAG_POOLMEM) {
 873                 _talloc_free_poolmem(tc, location);
 874         } else {
 875                 TC_INVALIDATE_FULL_CHUNK(tc);
 876                 free(tc);
 877         }
 878         return 0;
 879 }
 880
 881 /*
 882    move a lump of memory from one talloc context to another return the
 883    ptr on success, or NULL if it could not be transferred.
 884    passing NULL as ptr will always return NULL with no side effects.
 885 */
 886 static void *_talloc_steal_internal(const void *new_ctx, const void *ptr)
 887 {
 888         struct talloc_chunk *tc, *new_tc;
 889
 890         if (unlikely(!ptr)) {
 891                 return NULL;
 892         }
 893
 894         if (unlikely(new_ctx == NULL)) {
 895                 new_ctx = null_context;
 896         }
 897
 898         tc = talloc_chunk_from_ptr(ptr);
 899
 900         if (unlikely(new_ctx == NULL)) {
 901                 if (tc->parent) {
 902                         _TLIST_REMOVE(tc->parent->child, tc);
 903                         if (tc->parent->child) {
 904                                 tc->parent->child->parent = tc->parent;
 905                         }
 906                 } else {
 907                         if (tc->prev) tc->prev->next = tc->next;
 908                         if (tc->next) tc->next->prev = tc->prev;
 909                 }
 910
 911                 tc->parent = tc->next = tc->prev = NULL;
 912                 return discard_const_p(void, ptr);
 913         }
 914
 915         new_tc = talloc_chunk_from_ptr(new_ctx);
 916
 917         if (unlikely(tc == new_tc || tc->parent == new_tc)) {
 918                 return discard_const_p(void, ptr);
 919         }
 920
 921         if (tc->parent) {
 922                 _TLIST_REMOVE(tc->parent->child, tc);
 923                 if (tc->parent->child) {
 924                         tc->parent->child->parent = tc->parent;
 925                 }
 926         } else {
 927                 if (tc->prev) tc->prev->next = tc->next;
 928                 if (tc->next) tc->next->prev = tc->prev;
 929                 tc->prev = tc->next = NULL;
 930         }
 931
 932         tc->parent = new_tc;
 933         if (new_tc->child) new_tc->child->parent = NULL;
 934         _TLIST_ADD(new_tc->child, tc);
 935
 936         return discard_const_p(void, ptr);
 937 }
 938
 939 /*
 940    move a lump of memory from one talloc context to another return the
 941    ptr on success, or NULL if it could not be transferred.
 942    passing NULL as ptr will always return NULL with no side effects.
 943 */
 944 _PUBLIC_ void *_talloc_steal_loc(const void *new_ctx, const void *ptr, const char *location)
 945 {
 946         struct talloc_chunk *tc;
 947
 948         if (unlikely(ptr == NULL)) {
 949                 return NULL;
 950         }
 951
 952         tc = talloc_chunk_from_ptr(ptr);
 953
 954         if (unlikely(tc->refs != NULL) && talloc_parent(ptr) != new_ctx) {
 955                 struct talloc_reference_handle *h;
 956
 957                 talloc_log("WARNING: talloc_steal with references at %s\n",
 958                            location);
 959
 960                 for (h=tc->refs; h; h=h->next) {
 961                         talloc_log("\treference at %s\n",
 962                                    h->location);
 963                 }
 964         }
 965
 966 #if 0
 967         /* this test is probably too expensive to have on in the
 968            normal build, but it useful for debugging */
 969         if (talloc_is_parent(new_ctx, ptr)) {
 970                 talloc_log("WARNING: stealing into talloc child at %s\n", location);
 971         }
 972 #endif
 973
 974         return _talloc_steal_internal(new_ctx, ptr);
 975 }
 976
 977 /*
 978    this is like a talloc_steal(), but you must supply the old
 979    parent. This resolves the ambiguity in a talloc_steal() which is
 980    called on a context that has more than one parent (via references)
 981
 982    The old parent can be either a reference or a parent
 983 */
 984 _PUBLIC_ void *talloc_reparent(const void *old_parent, const void *new_parent, const void *ptr)
 985 {
 986         struct talloc_chunk *tc;
 987         struct talloc_reference_handle *h;
 988
 989         if (unlikely(ptr == NULL)) {
 990                 return NULL;
 991         }
 992
 993         if (old_parent == talloc_parent(ptr)) {
 994                 return _talloc_steal_internal(new_parent, ptr);
 995         }
 996
 997         tc = talloc_chunk_from_ptr(ptr);
 998         for (h=tc->refs;h;h=h->next) {
 999                 if (talloc_parent(h) == old_parent) {
1000                         if (_talloc_steal_internal(new_parent, h) != h) {
1001                                 return NULL;
1002                         }
1003                         return discard_const_p(void, ptr);
1004                 }
1005         }
1006
1007         /* it wasn't a parent */
1008         return NULL;
1009 }
1010
1011 /*
1012   remove a secondary reference to a pointer. This undo's what
1013   talloc_reference() has done. The context and pointer arguments
1014   must match those given to a talloc_reference()
1015 */
1016 static inline int talloc_unreference(const void *context, const void *ptr)
1017 {
1018         struct talloc_chunk *tc = talloc_chunk_from_ptr(ptr);
1019         struct talloc_reference_handle *h;
1020
1021         if (unlikely(context == NULL)) {
1022                 context = null_context;
1023         }
1024
1025         for (h=tc->refs;h;h=h->next) {
1026                 struct talloc_chunk *p = talloc_parent_chunk(h);
1027                 if (p == NULL) {
1028                         if (context == NULL) break;
1029                 } else if (TC_PTR_FROM_CHUNK(p) == context) {
1030                         break;
1031                 }
1032         }
1033         if (h == NULL) {
1034                 return -1;
1035         }
1036
1037         return _talloc_free_internal(h, __location__);
1038 }
1039
1040 /*
1041   remove a specific parent context from a pointer. This is a more
1042   controlled variant of talloc_free()
1043 */
1044 _PUBLIC_ int talloc_unlink(const void *context, void *ptr)
1045 {
1046         struct talloc_chunk *tc_p, *new_p, *tc_c;
1047         void *new_parent;
1048
1049         if (ptr == NULL) {
1050                 return -1;
1051         }
1052
1053         if (context == NULL) {
1054                 context = null_context;
1055         }
1056
1057         if (talloc_unreference(context, ptr) == 0) {
1058                 return 0;
1059         }
1060
1061         if (context != NULL) {
1062                 tc_c = talloc_chunk_from_ptr(context);
1063         } else {
1064                 tc_c = NULL;
1065         }
1066         if (tc_c != talloc_parent_chunk(ptr)) {
1067                 return -1;
1068         }
1069
1070         tc_p = talloc_chunk_from_ptr(ptr);
1071
1072         if (tc_p->refs == NULL) {
1073                 return _talloc_free_internal(ptr, __location__);
1074         }
1075
1076         new_p = talloc_parent_chunk(tc_p->refs);
1077         if (new_p) {
1078                 new_parent = TC_PTR_FROM_CHUNK(new_p);
1079         } else {
1080                 new_parent = NULL;
1081         }
1082
1083         if (talloc_unreference(new_parent, ptr) != 0) {
1084                 return -1;
1085         }
1086
1087         _talloc_steal_internal(new_parent, ptr);
1088
1089         return 0;
1090 }
1091
1092 /*
1093   add a name to an existing pointer - va_list version
1094 */
1095 static inline const char *talloc_set_name_v(const void *ptr, const char *fmt, va_list ap) PRINTF_ATTRIBUTE(2,0);
1096
1097 static inline const char *talloc_set_name_v(const void *ptr, const char *fmt, va_list ap)
1098 {
1099         struct talloc_chunk *tc = talloc_chunk_from_ptr(ptr);
1100         tc->name = talloc_vasprintf(ptr, fmt, ap);
1101         if (likely(tc->name)) {
1102                 _talloc_set_name_const(tc->name, ".name");
1103         }
1104         return tc->name;
1105 }
1106
1107 /*
1108   add a name to an existing pointer
1109 */
1110 _PUBLIC_ const char *talloc_set_name(const void *ptr, const char *fmt, ...)
1111 {
1112         const char *name;
1113         va_list ap;
1114         va_start(ap, fmt);
1115         name = talloc_set_name_v(ptr, fmt, ap);
1116         va_end(ap);
1117         return name;
1118 }
1119
1120
1121 /*
1122   create a named talloc pointer. Any talloc pointer can be named, and
1123   talloc_named() operates just like talloc() except that it allows you
1124   to name the pointer.
1125 */
1126 _PUBLIC_ void *talloc_named(const void *context, size_t size, const char *fmt, ...)
1127 {
1128         va_list ap;
1129         void *ptr;
1130         const char *name;
1131
1132         ptr = __talloc(context, size);
1133         if (unlikely(ptr == NULL)) return NULL;
1134
1135         va_start(ap, fmt);
1136         name = talloc_set_name_v(ptr, fmt, ap);
1137         va_end(ap);
1138
1139         if (unlikely(name == NULL)) {
1140                 _talloc_free_internal(ptr, __location__);
1141                 return NULL;
1142         }
1143
1144         return ptr;
1145 }
1146
1147 /*
1148   return the name of a talloc ptr, or "UNNAMED"
1149 */
1150 _PUBLIC_ const char *talloc_get_name(const void *ptr)
1151 {
1152         struct talloc_chunk *tc = talloc_chunk_from_ptr(ptr);
1153         if (unlikely(tc->name == TALLOC_MAGIC_REFERENCE)) {
1154                 return ".reference";
1155         }
1156         if (likely(tc->name)) {
1157                 return tc->name;
1158         }
1159         return "UNNAMED";
1160 }
1161
1162
1163 /*
1164   check if a pointer has the given name. If it does, return the pointer,
1165   otherwise return NULL
1166 */
1167 _PUBLIC_ void *talloc_check_name(const void *ptr, const char *name)
1168 {
1169         const char *pname;
1170         if (unlikely(ptr == NULL)) return NULL;
1171         pname = talloc_get_name(ptr);
1172         if (likely(pname == name || strcmp(pname, name) == 0)) {
1173                 return discard_const_p(void, ptr);
1174         }
1175         return NULL;
1176 }
1177
1178 static void talloc_abort_type_mismatch(const char *location,
1179                                         const char *name,
1180                                         const char *expected)
1181 {
1182         const char *reason;
1183
1184         reason = talloc_asprintf(NULL,
1185                                  "%s: Type mismatch: name[%s] expected[%s]",
1186                                  location,
1187                                  name?name:"NULL",
1188                                  expected);
1189         if (!reason) {
1190                 reason = "Type mismatch";
1191         }
1192
1193         talloc_abort(reason);
1194 }
1195
1196 _PUBLIC_ void *_talloc_get_type_abort(const void *ptr, const char *name, const char *location)
1197 {
1198         const char *pname;
1199
1200         if (unlikely(ptr == NULL)) {
1201                 talloc_abort_type_mismatch(location, NULL, name);
1202                 return NULL;
1203         }
1204
1205         pname = talloc_get_name(ptr);
1206         if (likely(pname == name || strcmp(pname, name) == 0)) {
1207                 return discard_const_p(void, ptr);
1208         }
1209
1210         talloc_abort_type_mismatch(location, pname, name);
1211         return NULL;
1212 }
1213
1214 /*
1215   this is for compatibility with older versions of talloc
1216 */
1217 _PUBLIC_ void *talloc_init(const char *fmt, ...)
1218 {
1219         va_list ap;
1220         void *ptr;
1221         const char *name;
1222
1223         ptr = __talloc(NULL, 0);
1224         if (unlikely(ptr == NULL)) return NULL;
1225
1226         va_start(ap, fmt);
1227         name = talloc_set_name_v(ptr, fmt, ap);
1228         va_end(ap);
1229
1230         if (unlikely(name == NULL)) {
1231                 _talloc_free_internal(ptr, __location__);
1232                 return NULL;
1233         }
1234
1235         return ptr;
1236 }
1237
1238 static inline void _talloc_free_children_internal(struct talloc_chunk *tc,
1239                                                   void *ptr,
1240                                                   const char *location)
1241 {
1242         while (tc->child) {
1243                 /* we need to work out who will own an abandoned child
1244                    if it cannot be freed. In priority order, the first
1245                    choice is owner of any remaining reference to this
1246                    pointer, the second choice is our parent, and the
1247                    final choice is the null context. */
1248                 void *child = TC_PTR_FROM_CHUNK(tc->child);
1249                 const void *new_parent = null_context;
1250                 if (unlikely(tc->child->refs)) {
1251                         struct talloc_chunk *p = talloc_parent_chunk(tc->child->refs);
1252                         if (p) new_parent = TC_PTR_FROM_CHUNK(p);
1253                 }
1254                 if (unlikely(_talloc_free_internal(child, location) == -1)) {
1255                         if (new_parent == null_context) {
1256                                 struct talloc_chunk *p = talloc_parent_chunk(ptr);
1257                                 if (p) new_parent = TC_PTR_FROM_CHUNK(p);
1258                         }
1259                         _talloc_steal_internal(new_parent, child);
1260                 }
1261         }
1262 }
1263
1264 /*
1265   this is a replacement for the Samba3 talloc_destroy_pool functionality. It
1266   should probably not be used in new code. It's in here to keep the talloc
1267   code consistent across Samba 3 and 4.
1268 */
1269 _PUBLIC_ void talloc_free_children(void *ptr)
1270 {
1271         struct talloc_chunk *tc_name = NULL;
1272         struct talloc_chunk *tc;
1273
1274         if (unlikely(ptr == NULL)) {
1275                 return;
1276         }
1277
1278         tc = talloc_chunk_from_ptr(ptr);
1279
1280         /* we do not want to free the context name if it is a child .. */
1281         if (likely(tc->child)) {
1282                 for (tc_name = tc->child; tc_name; tc_name = tc_name->next) {
1283                         if (tc->name == TC_PTR_FROM_CHUNK(tc_name)) break;
1284                 }
1285                 if (tc_name) {
1286                         _TLIST_REMOVE(tc->child, tc_name);
1287                         if (tc->child) {
1288                                 tc->child->parent = tc;
1289                         }
1290                 }
1291         }
1292
1293         _talloc_free_children_internal(tc, ptr, __location__);
1294
1295         /* .. so we put it back after all other children have been freed */
1296         if (tc_name) {
1297                 if (tc->child) {
1298                         tc->child->parent = NULL;
1299                 }
1300                 tc_name->parent = tc;
1301                 _TLIST_ADD(tc->child, tc_name);
1302         }
1303 }
1304
1305 /*
1306    Allocate a bit of memory as a child of an existing pointer
1307 */
1308 _PUBLIC_ void *_talloc(const void *context, size_t size)
1309 {
1310         return __talloc(context, size);
1311 }
1312
1313 /*
1314   externally callable talloc_set_name_const()
1315 */
1316 _PUBLIC_ void talloc_set_name_const(const void *ptr, const char *name)
1317 {
1318         _talloc_set_name_const(ptr, name);
1319 }
1320
1321 /*
1322   create a named talloc pointer. Any talloc pointer can be named, and
1323   talloc_named() operates just like talloc() except that it allows you
1324   to name the pointer.
1325 */
1326 _PUBLIC_ void *talloc_named_const(const void *context, size_t size, const char *name)
1327 {
1328         return _talloc_named_const(context, size, name);
1329 }
1330
1331 /*
1332    free a talloc pointer. This also frees all child pointers of this
1333    pointer recursively
1334
1335    return 0 if the memory is actually freed, otherwise -1. The memory
1336    will not be freed if the ref_count is > 1 or the destructor (if
1337    any) returns non-zero
1338 */
1339 _PUBLIC_ int _talloc_free(void *ptr, const char *location)
1340 {
1341         struct talloc_chunk *tc;
1342
1343         if (unlikely(ptr == NULL)) {
1344                 return -1;
1345         }
1346
1347         tc = talloc_chunk_from_ptr(ptr);
1348
1349         if (unlikely(tc->refs != NULL)) {
1350                 struct talloc_reference_handle *h;
1351
1352                 if (talloc_parent(ptr) == null_context && tc->refs->next == NULL) {
1353                         /* in this case we do know which parent should
1354                            get this pointer, as there is really only
1355                            one parent */
1356                         return talloc_unlink(null_context, ptr);
1357                 }
1358
1359                 talloc_log("ERROR: talloc_free with references at %s\n",
1360                            location);
1361
1362                 for (h=tc->refs; h; h=h->next) {
1363                         talloc_log("\treference at %s\n",
1364                                    h->location);
1365                 }
1366                 return -1;
1367         }
1368
1369         return _talloc_free_internal(ptr, location);
1370 }
1371
1372
1373
1374 /*
1375   A talloc version of realloc. The context argument is only used if
1376   ptr is NULL
1377 */
1378 _PUBLIC_ void *_talloc_realloc(const void *context, void *ptr, size_t size, const char *name)
1379 {
1380         struct talloc_chunk *tc;
1381         void *new_ptr;
1382         bool malloced = false;
1383         struct talloc_chunk *pool_tc = NULL;
1384
1385         /* size zero is equivalent to free() */
1386         if (unlikely(size == 0)) {
1387                 talloc_unlink(context, ptr);
1388                 return NULL;
1389         }
1390
1391         if (unlikely(size >= MAX_TALLOC_SIZE)) {
1392                 return NULL;
1393         }
1394
1395         /* realloc(NULL) is equivalent to malloc() */
1396         if (ptr == NULL) {
1397                 return _talloc_named_const(context, size, name);
1398         }
1399
1400         tc = talloc_chunk_from_ptr(ptr);
1401
1402         /* don't allow realloc on referenced pointers */
1403         if (unlikely(tc->refs)) {
1404                 return NULL;
1405         }
1406
1407         /* don't let anybody try to realloc a talloc_pool */
1408         if (unlikely(tc->flags & TALLOC_FLAG_POOL)) {
1409                 return NULL;
1410         }
1411
1412         /* don't let anybody try to realloc a talloc_pool */
1413         if (unlikely(tc->flags & TALLOC_FLAG_POOLMEM)) {
1414                 pool_tc = (struct talloc_chunk *)tc->pool;
1415         }
1416
1417 #if (ALWAYS_REALLOC == 0)
1418         /* don't shrink if we have less than 1k to gain */
1419         if (size < tc->size) {
1420                 if (pool_tc) {
1421                         void *next_tc = TC_POOLMEM_NEXT_CHUNK(tc);
1422                         TC_INVALIDATE_SHRINK_CHUNK(tc, size);
1423                         tc->size = size;
1424                         if (next_tc == pool_tc->pool) {
1425                                 pool_tc->pool = TC_POOLMEM_NEXT_CHUNK(tc);
1426                         }
1427                         return ptr;
1428                 } else if ((tc->size - size) < 1024) {
1429                         /*
1430                          * if we call TC_INVALIDATE_SHRINK_CHUNK() here
1431                          * we would need to call TC_UNDEFINE_GROW_CHUNK()
1432                          * after each realloc call, which slows down
1433                          * testing a lot :-(.
1434                          *
1435                          * That is why we only mark memory as undefined here.
1436                          */
1437                         TC_UNDEFINE_SHRINK_CHUNK(tc, size);
1438
1439                         /* do not shrink if we have less than 1k to gain */
1440                         tc->size = size;
1441                         return ptr;
1442                 }
1443         } else if (tc->size == size) {
1444                 /*
1445                  * do not change the pointer if it is exactly
1446                  * the same size.
1447                  */
1448                 return ptr;
1449         }
1450 #endif
1451
1452         /* by resetting magic we catch users of the old memory */
1453         tc->flags |= TALLOC_FLAG_FREE;
1454
1455 #if ALWAYS_REALLOC
1456         if (pool_tc) {
1457                 new_ptr = talloc_alloc_pool(tc, size + TC_HDR_SIZE);
1458                 *talloc_pool_objectcount(pool_tc) -= 1;
1459
1460                 if (new_ptr == NULL) {
1461                         new_ptr = malloc(TC_HDR_SIZE+size);
1462                         malloced = true;
1463                 }
1464
1465                 if (new_ptr) {
1466                         memcpy(new_ptr, tc, MIN(tc->size,size) + TC_HDR_SIZE);
1467                         TC_INVALIDATE_FULL_CHUNK(tc);
1468                 }
1469         } else {
1470                 new_ptr = malloc(size + TC_HDR_SIZE);
1471                 if (new_ptr) {
1472                         memcpy(new_ptr, tc, MIN(tc->size, size) + TC_HDR_SIZE);
1473                         free(tc);
1474                 }
1475         }
1476 #else
1477         if (pool_tc) {
1478                 void *next_tc = TC_POOLMEM_NEXT_CHUNK(tc);
1479                 size_t old_chunk_size = TC_POOLMEM_CHUNK_SIZE(tc);
1480                 size_t new_chunk_size = TC_ALIGN16(TC_HDR_SIZE + size);
1481                 size_t space_needed;
1482                 size_t space_left;
1483                 unsigned int chunk_count = *talloc_pool_objectcount(pool_tc);
1484
1485                 if (!(pool_tc->flags & TALLOC_FLAG_FREE)) {
1486                         chunk_count -= 1;
1487                 }
1488
1489                 if (chunk_count == 1) {
1490                         /*
1491                          * optimize for the case where 'tc' is the only
1492                          * chunk in the pool.
1493                          */
1494                         space_needed = new_chunk_size;
1495                         space_left = pool_tc->size - TALLOC_POOL_HDR_SIZE;
1496
1497                         if (space_left >= space_needed) {
1498                                 size_t old_used = TC_HDR_SIZE + tc->size;
1499                                 size_t new_used = TC_HDR_SIZE + size;
1500                                 pool_tc->pool = TC_POOL_FIRST_CHUNK(pool_tc);
1501 #if defined(DEVELOPER) && defined(VALGRIND_MAKE_MEM_UNDEFINED)
1502                                 /*
1503                                  * we need to prepare the memmove into
1504                                  * the unaccessable area.
1505                                  */
1506                                 {
1507                                         size_t diff = PTR_DIFF(tc, pool_tc->pool);
1508                                         size_t flen = MIN(diff, old_used);
1509                                         char *fptr = (char *)pool_tc->pool;
1510                                         VALGRIND_MAKE_MEM_UNDEFINED(fptr, flen);
1511                                 }
1512 #endif
1513                                 memmove(pool_tc->pool, tc, old_used);
1514                                 new_ptr = pool_tc->pool;
1515
1516                                 tc = (struct talloc_chunk *)new_ptr;
1517                                 TC_UNDEFINE_GROW_CHUNK(tc, size);
1518
1519                                 /*
1520                                  * first we do not align the pool pointer
1521                                  * because we want to invalidate the padding
1522                                  * too.
1523                                  */
1524                                 pool_tc->pool = new_used + (char *)new_ptr;
1525                                 TC_INVALIDATE_POOL(pool_tc);
1526
1527                                 /* now the aligned pointer */
1528                                 pool_tc->pool = new_chunk_size + (char *)new_ptr;
1529                                 goto got_new_ptr;
1530                         }
1531
1532                         next_tc = NULL;
1533                 }
1534
1535                 if (new_chunk_size == old_chunk_size) {
1536                         TC_UNDEFINE_GROW_CHUNK(tc, size);
1537                         tc->flags &= ~TALLOC_FLAG_FREE;
1538                         tc->size = size;
1539                         return ptr;
1540                 }
1541
1542                 if (next_tc == pool_tc->pool) {
1543                         /*
1544                          * optimize for the case where 'tc' is the last
1545                          * chunk in the pool.
1546                          */
1547                         space_needed = new_chunk_size - old_chunk_size;
1548                         space_left = TC_POOL_SPACE_LEFT(pool_tc);
1549
1550                         if (space_left >= space_needed) {
1551                                 TC_UNDEFINE_GROW_CHUNK(tc, size);
1552                                 tc->flags &= ~TALLOC_FLAG_FREE;
1553                                 tc->size = size;
1554                                 pool_tc->pool = TC_POOLMEM_NEXT_CHUNK(tc);
1555                                 return ptr;
1556                         }
1557                 }
1558
1559                 new_ptr = talloc_alloc_pool(tc, size + TC_HDR_SIZE);
1560
1561                 if (new_ptr == NULL) {
1562                         new_ptr = malloc(TC_HDR_SIZE+size);
1563                         malloced = true;
1564                 }
1565
1566                 if (new_ptr) {
1567                         memcpy(new_ptr, tc, MIN(tc->size,size) + TC_HDR_SIZE);
1568
1569                         _talloc_free_poolmem(tc, __location__ "_talloc_realloc");
1570                 }
1571         }
1572         else {
1573                 new_ptr = realloc(tc, size + TC_HDR_SIZE);
1574         }
1575 got_new_ptr:
1576 #endif
1577         if (unlikely(!new_ptr)) {
1578                 tc->flags &= ~TALLOC_FLAG_FREE;
1579                 return NULL;
1580         }
1581
1582         tc = (struct talloc_chunk *)new_ptr;
1583         tc->flags &= ~TALLOC_FLAG_FREE;
1584         if (malloced) {
1585                 tc->flags &= ~TALLOC_FLAG_POOLMEM;
1586         }
1587         if (tc->parent) {
1588                 tc->parent->child = tc;
1589         }
1590         if (tc->child) {
1591                 tc->child->parent = tc;
1592         }
1593
1594         if (tc->prev) {
1595                 tc->prev->next = tc;
1596         }
1597         if (tc->next) {
1598                 tc->next->prev = tc;
1599         }
1600
1601         tc->size = size;
1602         _talloc_set_name_const(TC_PTR_FROM_CHUNK(tc), name);
1603
1604         return TC_PTR_FROM_CHUNK(tc);
1605 }
1606
1607 /*
1608   a wrapper around talloc_steal() for situations where you are moving a pointer
1609   between two structures, and want the old pointer to be set to NULL
1610 */
1611 _PUBLIC_ void *_talloc_move(const void *new_ctx, const void *_pptr)
1612 {
1613         const void **pptr = discard_const_p(const void *,_pptr);
1614         void *ret = talloc_steal(new_ctx, discard_const_p(void, *pptr));
1615         (*pptr) = NULL;
1616         return ret;
1617 }
1618
1619 /*
1620   return the total size of a talloc pool (subtree)
1621 */
1622 _PUBLIC_ size_t talloc_total_size(const void *ptr)
1623 {
1624         size_t total = 0;
1625         struct talloc_chunk *c, *tc;
1626
1627         if (ptr == NULL) {
1628                 ptr = null_context;
1629         }
1630         if (ptr == NULL) {
1631                 return 0;
1632         }
1633
1634         tc = talloc_chunk_from_ptr(ptr);
1635
1636         if (tc->flags & TALLOC_FLAG_LOOP) {
1637                 return 0;
1638         }
1639
1640         tc->flags |= TALLOC_FLAG_LOOP;
1641
1642         if (likely(tc->name != TALLOC_MAGIC_REFERENCE)) {
1643                 total = tc->size;
1644         }
1645         for (c=tc->child;c;c=c->next) {
1646                 total += talloc_total_size(TC_PTR_FROM_CHUNK(c));
1647         }
1648
1649         tc->flags &= ~TALLOC_FLAG_LOOP;
1650
1651         return total;
1652 }
1653
1654 /*
1655   return the total number of blocks in a talloc pool (subtree)
1656 */
1657 _PUBLIC_ size_t talloc_total_blocks(const void *ptr)
1658 {
1659         size_t total = 0;
1660         struct talloc_chunk *c, *tc;
1661
1662         if (ptr == NULL) {
1663                 ptr = null_context;
1664         }
1665         if (ptr == NULL) {
1666                 return 0;
1667         }
1668
1669         tc = talloc_chunk_from_ptr(ptr);
1670
1671         if (tc->flags & TALLOC_FLAG_LOOP) {
1672                 return 0;
1673         }
1674
1675         tc->flags |= TALLOC_FLAG_LOOP;
1676
1677         total++;
1678         for (c=tc->child;c;c=c->next) {
1679                 total += talloc_total_blocks(TC_PTR_FROM_CHUNK(c));
1680         }
1681
1682         tc->flags &= ~TALLOC_FLAG_LOOP;
1683
1684         return total;
1685 }
1686
1687 /*
1688   return the number of external references to a pointer
1689 */
1690 _PUBLIC_ size_t talloc_reference_count(const void *ptr)
1691 {
1692         struct talloc_chunk *tc = talloc_chunk_from_ptr(ptr);
1693         struct talloc_reference_handle *h;
1694         size_t ret = 0;
1695
1696         for (h=tc->refs;h;h=h->next) {
1697                 ret++;
1698         }
1699         return ret;
1700 }
1701
1702 /*
1703   report on memory usage by all children of a pointer, giving a full tree view
1704 */
1705 _PUBLIC_ void talloc_report_depth_cb(const void *ptr, int depth, int max_depth,
1706                             void (*callback)(const void *ptr,
1707                                              int depth, int max_depth,
1708                                              int is_ref,
1709                                              void *private_data),
1710                             void *private_data)
1711 {
1712         struct talloc_chunk *c, *tc;
1713
1714         if (ptr == NULL) {
1715                 ptr = null_context;
1716         }
1717         if (ptr == NULL) return;
1718
1719         tc = talloc_chunk_from_ptr(ptr);
1720
1721         if (tc->flags & TALLOC_FLAG_LOOP) {
1722                 return;
1723         }
1724
1725         callback(ptr, depth, max_depth, 0, private_data);
1726
1727         if (max_depth >= 0 && depth >= max_depth) {
1728                 return;
1729         }
1730
1731         tc->flags |= TALLOC_FLAG_LOOP;
1732         for (c=tc->child;c;c=c->next) {
1733                 if (c->name == TALLOC_MAGIC_REFERENCE) {
1734                         struct talloc_reference_handle *h = (struct talloc_reference_handle *)TC_PTR_FROM_CHUNK(c);
1735                         callback(h->ptr, depth + 1, max_depth, 1, private_data);
1736                 } else {
1737                         talloc_report_depth_cb(TC_PTR_FROM_CHUNK(c), depth + 1, max_depth, callback, private_data);
1738                 }
1739         }
1740         tc->flags &= ~TALLOC_FLAG_LOOP;
1741 }
1742
1743 static void talloc_report_depth_FILE_helper(const void *ptr, int depth, int max_depth, int is_ref, void *_f)
1744 {
1745         const char *name = talloc_get_name(ptr);
1746         FILE *f = (FILE *)_f;
1747
1748         if (is_ref) {
1749                 fprintf(f, "%*sreference to: %s\n", depth*4, "", name);
1750                 return;
1751         }
1752
1753         if (depth == 0) {
1754                 fprintf(f,"%stalloc report on '%s' (total %6lu bytes in %3lu blocks)\n",
1755                         (max_depth < 0 ? "full " :""), name,
1756                         (unsigned long)talloc_total_size(ptr),
1757                         (unsigned long)talloc_total_blocks(ptr));
1758                 return;
1759         }
1760
1761         fprintf(f, "%*s%-30s contains %6lu bytes in %3lu blocks (ref %d) %p\n",
1762                 depth*4, "",
1763                 name,
1764                 (unsigned long)talloc_total_size(ptr),
1765                 (unsigned long)talloc_total_blocks(ptr),
1766                 (int)talloc_reference_count(ptr), ptr);
1767
1768 #if 0
1769         fprintf(f, "content: ");
1770         if (talloc_total_size(ptr)) {
1771                 int tot = talloc_total_size(ptr);
1772                 int i;
1773
1774                 for (i = 0; i < tot; i++) {
1775                         if ((((char *)ptr)[i] > 31) && (((char *)ptr)[i] < 126)) {
1776                                 fprintf(f, "%c", ((char *)ptr)[i]);
1777                         } else {
1778                                 fprintf(f, "~%02x", ((char *)ptr)[i]);
1779                         }
1780                 }
1781         }
1782         fprintf(f, "\n");
1783 #endif
1784 }
1785
1786 /*
1787   report on memory usage by all children of a pointer, giving a full tree view
1788 */
1789 _PUBLIC_ void talloc_report_depth_file(const void *ptr, int depth, int max_depth, FILE *f)
1790 {
1791         if (f) {
1792                 talloc_report_depth_cb(ptr, depth, max_depth, talloc_report_depth_FILE_helper, f);
1793                 fflush(f);
1794         }
1795 }
1796
1797 /*
1798   report on memory usage by all children of a pointer, giving a full tree view
1799 */
1800 _PUBLIC_ void talloc_report_full(const void *ptr, FILE *f)
1801 {
1802         talloc_report_depth_file(ptr, 0, -1, f);
1803 }
1804
1805 /*
1806   report on memory usage by all children of a pointer
1807 */
1808 _PUBLIC_ void talloc_report(const void *ptr, FILE *f)
1809 {
1810         talloc_report_depth_file(ptr, 0, 1, f);
1811 }
1812
1813 /*
1814   report on any memory hanging off the null context
1815 */
1816 static void talloc_report_null(void)
1817 {
1818         if (talloc_total_size(null_context) != 0) {
1819                 talloc_report(null_context, stderr);
1820         }
1821 }
1822
1823 /*
1824   report on any memory hanging off the null context
1825 */
1826 static void talloc_report_null_full(void)
1827 {
1828         if (talloc_total_size(null_context) != 0) {
1829                 talloc_report_full(null_context, stderr);
1830         }
1831 }
1832
1833 /*
1834   enable tracking of the NULL context
1835 */
1836 _PUBLIC_ void talloc_enable_null_tracking(void)
1837 {
1838         if (null_context == NULL) {
1839                 null_context = _talloc_named_const(NULL, 0, "null_context");
1840                 if (autofree_context != NULL) {
1841                         talloc_reparent(NULL, null_context, autofree_context);
1842                 }
1843         }
1844 }
1845
1846 /*
1847   enable tracking of the NULL context, not moving the autofree context
1848   into the NULL context. This is needed for the talloc testsuite
1849 */
1850 _PUBLIC_ void talloc_enable_null_tracking_no_autofree(void)
1851 {
1852         if (null_context == NULL) {
1853                 null_context = _talloc_named_const(NULL, 0, "null_context");
1854         }
1855 }
1856
1857 /*
1858   disable tracking of the NULL context
1859 */
1860 _PUBLIC_ void talloc_disable_null_tracking(void)
1861 {
1862         if (null_context != NULL) {
1863                 /* we have to move any children onto the real NULL
1864                    context */
1865                 struct talloc_chunk *tc, *tc2;
1866                 tc = talloc_chunk_from_ptr(null_context);
1867                 for (tc2 = tc->child; tc2; tc2=tc2->next) {
1868                         if (tc2->parent == tc) tc2->parent = NULL;
1869                         if (tc2->prev == tc) tc2->prev = NULL;
1870                 }
1871                 for (tc2 = tc->next; tc2; tc2=tc2->next) {
1872                         if (tc2->parent == tc) tc2->parent = NULL;
1873                         if (tc2->prev == tc) tc2->prev = NULL;
1874                 }
1875                 tc->child = NULL;
1876                 tc->next = NULL;
1877         }
1878         talloc_free(null_context);
1879         null_context = NULL;
1880 }
1881
1882 /*
1883   enable leak reporting on exit
1884 */
1885 _PUBLIC_ void talloc_enable_leak_report(void)
1886 {
1887         talloc_enable_null_tracking();
1888         atexit(talloc_report_null);
1889 }
1890
1891 /*
1892   enable full leak reporting on exit
1893 */
1894 _PUBLIC_ void talloc_enable_leak_report_full(void)
1895 {
1896         talloc_enable_null_tracking();
1897         atexit(talloc_report_null_full);
1898 }
1899
1900 /*
1901    talloc and zero memory.
1902 */
1903 _PUBLIC_ void *_talloc_zero(const void *ctx, size_t size, const char *name)
1904 {
1905         void *p = _talloc_named_const(ctx, size, name);
1906
1907         if (p) {
1908                 memset(p, '\0', size);
1909         }
1910
1911         return p;
1912 }
1913
1914 /*
1915   memdup with a talloc.
1916 */
1917 _PUBLIC_ void *_talloc_memdup(const void *t, const void *p, size_t size, const char *name)
1918 {
1919         void *newp = _talloc_named_const(t, size, name);
1920
1921         if (likely(newp)) {
1922                 memcpy(newp, p, size);
1923         }
1924
1925         return newp;
1926 }
1927
1928 static inline char *__talloc_strlendup(const void *t, const char *p, size_t len)
1929 {
1930         char *ret;
1931
1932         ret = (char *)__talloc(t, len + 1);
1933         if (unlikely(!ret)) return NULL;
1934
1935         memcpy(ret, p, len);
1936         ret[len] = 0;
1937
1938         _talloc_set_name_const(ret, ret);
1939         return ret;
1940 }
1941
1942 /*
1943   strdup with a talloc
1944 */
1945 _PUBLIC_ char *talloc_strdup(const void *t, const char *p)
1946 {
1947         if (unlikely(!p)) return NULL;
1948         return __talloc_strlendup(t, p, strlen(p));
1949 }
1950
1951 /*
1952   strndup with a talloc
1953 */
1954 _PUBLIC_ char *talloc_strndup(const void *t, const char *p, size_t n)
1955 {
1956         if (unlikely(!p)) return NULL;
1957         return __talloc_strlendup(t, p, strnlen(p, n));
1958 }
1959
1960 static inline char *__talloc_strlendup_append(char *s, size_t slen,
1961                                               const char *a, size_t alen)
1962 {
1963         char *ret;
1964
1965         ret = talloc_realloc(NULL, s, char, slen + alen + 1);
1966         if (unlikely(!ret)) return NULL;
1967
1968         /* append the string and the trailing \0 */
1969         memcpy(&ret[slen], a, alen);
1970         ret[slen+alen] = 0;
1971
1972         _talloc_set_name_const(ret, ret);
1973         return ret;
1974 }
1975
1976 /*
1977  * Appends at the end of the string.
1978  */
1979 _PUBLIC_ char *talloc_strdup_append(char *s, const char *a)
1980 {
1981         if (unlikely(!s)) {
1982                 return talloc_strdup(NULL, a);
1983         }
1984
1985         if (unlikely(!a)) {
1986                 return s;
1987         }
1988
1989         return __talloc_strlendup_append(s, strlen(s), a, strlen(a));
1990 }
1991
1992 /*
1993  * Appends at the end of the talloc'ed buffer,
1994  * not the end of the string.
1995  */
1996 _PUBLIC_ char *talloc_strdup_append_buffer(char *s, const char *a)
1997 {
1998         size_t slen;
1999
2000         if (unlikely(!s)) {
2001                 return talloc_strdup(NULL, a);
2002         }
2003
2004         if (unlikely(!a)) {
2005                 return s;
2006         }
2007
2008         slen = talloc_get_size(s);
2009         if (likely(slen > 0)) {
2010                 slen--;
2011         }
2012
2013         return __talloc_strlendup_append(s, slen, a, strlen(a));
2014 }
2015
2016 /*
2017  * Appends at the end of the string.
2018  */
2019 _PUBLIC_ char *talloc_strndup_append(char *s, const char *a, size_t n)
2020 {
2021         if (unlikely(!s)) {
2022                 return talloc_strdup(NULL, a);
2023         }
2024
2025         if (unlikely(!a)) {
2026                 return s;
2027         }
2028
2029         return __talloc_strlendup_append(s, strlen(s), a, strnlen(a, n));
2030 }
2031
2032 /*
2033  * Appends at the end of the talloc'ed buffer,
2034  * not the end of the string.
2035  */
2036 _PUBLIC_ char *talloc_strndup_append_buffer(char *s, const char *a, size_t n)
2037 {
2038         size_t slen;
2039
2040         if (unlikely(!s)) {
2041                 return talloc_strdup(NULL, a);
2042         }
2043
2044         if (unlikely(!a)) {
2045                 return s;
2046         }
2047
2048         slen = talloc_get_size(s);
2049         if (likely(slen > 0)) {
2050                 slen--;
2051         }
2052
2053         return __talloc_strlendup_append(s, slen, a, strnlen(a, n));
2054 }
2055
2056 #ifndef HAVE_VA_COPY
2057 #ifdef HAVE___VA_COPY
2058 #define va_copy(dest, src) __va_copy(dest, src)
2059 #else
2060 #define va_copy(dest, src) (dest) = (src)
2061 #endif
2062 #endif
2063
2064 _PUBLIC_ char *talloc_vasprintf(const void *t, const char *fmt, va_list ap)
2065 {
2066         int len;
2067         char *ret;
2068         va_list ap2;
2069         char c;
2070
2071         /* this call looks strange, but it makes it work on older solaris boxes */
2072         va_copy(ap2, ap);
2073         len = vsnprintf(&c, 1, fmt, ap2);
2074         va_end(ap2);
2075         if (unlikely(len < 0)) {
2076                 return NULL;
2077         }
2078
2079         ret = (char *)__talloc(t, len+1);
2080         if (unlikely(!ret)) return NULL;
2081
2082         va_copy(ap2, ap);
2083         vsnprintf(ret, len+1, fmt, ap2);
2084         va_end(ap2);
2085
2086         _talloc_set_name_const(ret, ret);
2087         return ret;
2088 }
2089
2090
2091 /*
2092   Perform string formatting, and return a pointer to newly allocated
2093   memory holding the result, inside a memory pool.
2094  */
2095 _PUBLIC_ char *talloc_asprintf(const void *t, const char *fmt, ...)
2096 {
2097         va_list ap;
2098         char *ret;
2099
2100         va_start(ap, fmt);
2101         ret = talloc_vasprintf(t, fmt, ap);
2102         va_end(ap);
2103         return ret;
2104 }
2105
2106 static inline char *__talloc_vaslenprintf_append(char *s, size_t slen,
2107                                                  const char *fmt, va_list ap)
2108                                                  PRINTF_ATTRIBUTE(3,0);
2109
2110 static inline char *__talloc_vaslenprintf_append(char *s, size_t slen,
2111                                                  const char *fmt, va_list ap)
2112 {
2113         ssize_t alen;
2114         va_list ap2;
2115         char c;
2116
2117         va_copy(ap2, ap);
2118         alen = vsnprintf(&c, 1, fmt, ap2);
2119         va_end(ap2);
2120
2121         if (alen <= 0) {
2122                 /* Either the vsnprintf failed or the format resulted in
2123                  * no characters being formatted. In the former case, we
2124                  * ought to return NULL, in the latter we ought to return
2125                  * the original string. Most current callers of this
2126                  * function expect it to never return NULL.
2127                  */
2128                 return s;
2129         }
2130
2131         s = talloc_realloc(NULL, s, char, slen + alen + 1);
2132         if (!s) return NULL;
2133
2134         va_copy(ap2, ap);
2135         vsnprintf(s + slen, alen + 1, fmt, ap2);
2136         va_end(ap2);
2137
2138         _talloc_set_name_const(s, s);
2139         return s;
2140 }
2141
2142 /**
2143  * Realloc @p s to append the formatted result of @p fmt and @p ap,
2144  * and return @p s, which may have moved.  Good for gradually
2145  * accumulating output into a string buffer. Appends at the end
2146  * of the string.
2147  **/
2148 _PUBLIC_ char *talloc_vasprintf_append(char *s, const char *fmt, va_list ap)
2149 {
2150         if (unlikely(!s)) {
2151                 return talloc_vasprintf(NULL, fmt, ap);
2152         }
2153
2154         return __talloc_vaslenprintf_append(s, strlen(s), fmt, ap);
2155 }
2156
2157 /**
2158  * Realloc @p s to append the formatted result of @p fmt and @p ap,
2159  * and return @p s, which may have moved. Always appends at the
2160  * end of the talloc'ed buffer, not the end of the string.
2161  **/
2162 _PUBLIC_ char *talloc_vasprintf_append_buffer(char *s, const char *fmt, va_list ap)
2163 {
2164         size_t slen;
2165
2166         if (unlikely(!s)) {
2167                 return talloc_vasprintf(NULL, fmt, ap);
2168         }
2169
2170         slen = talloc_get_size(s);
2171         if (likely(slen > 0)) {
2172                 slen--;
2173         }
2174
2175         return __talloc_vaslenprintf_append(s, slen, fmt, ap);
2176 }
2177
2178 /*
2179   Realloc @p s to append the formatted result of @p fmt and return @p
2180   s, which may have moved.  Good for gradually accumulating output
2181   into a string buffer.
2182  */
2183 _PUBLIC_ char *talloc_asprintf_append(char *s, const char *fmt, ...)
2184 {
2185         va_list ap;
2186
2187         va_start(ap, fmt);
2188         s = talloc_vasprintf_append(s, fmt, ap);
2189         va_end(ap);
2190         return s;
2191 }
2192
2193 /*
2194   Realloc @p s to append the formatted result of @p fmt and return @p
2195   s, which may have moved.  Good for gradually accumulating output
2196   into a buffer.
2197  */
2198 _PUBLIC_ char *talloc_asprintf_append_buffer(char *s, const char *fmt, ...)
2199 {
2200         va_list ap;
2201
2202         va_start(ap, fmt);
2203         s = talloc_vasprintf_append_buffer(s, fmt, ap);
2204         va_end(ap);
2205         return s;
2206 }
2207
2208 /*
2209   alloc an array, checking for integer overflow in the array size
2210 */
2211 _PUBLIC_ void *_talloc_array(const void *ctx, size_t el_size, unsigned count, const char *name)
2212 {
2213         if (count >= MAX_TALLOC_SIZE/el_size) {
2214                 return NULL;
2215         }
2216         return _talloc_named_const(ctx, el_size * count, name);
2217 }
2218
2219 /*
2220   alloc an zero array, checking for integer overflow in the array size
2221 */
2222 _PUBLIC_ void *_talloc_zero_array(const void *ctx, size_t el_size, unsigned count, const char *name)
2223 {
2224         if (count >= MAX_TALLOC_SIZE/el_size) {
2225                 return NULL;
2226         }
2227         return _talloc_zero(ctx, el_size * count, name);
2228 }
2229
2230 /*
2231   realloc an array, checking for integer overflow in the array size
2232 */
2233 _PUBLIC_ void *_talloc_realloc_array(const void *ctx, void *ptr, size_t el_size, unsigned count, const char *name)
2234 {
2235         if (count >= MAX_TALLOC_SIZE/el_size) {
2236                 return NULL;
2237         }
2238         return _talloc_realloc(ctx, ptr, el_size * count, name);
2239 }
2240
2241 /*
2242   a function version of talloc_realloc(), so it can be passed as a function pointer
2243   to libraries that want a realloc function (a realloc function encapsulates
2244   all the basic capabilities of an allocation library, which is why this is useful)
2245 */
2246 _PUBLIC_ void *talloc_realloc_fn(const void *context, void *ptr, size_t size)
2247 {
2248         return _talloc_realloc(context, ptr, size, NULL);
2249 }
2250
2251
2252 static int talloc_autofree_destructor(void *ptr)
2253 {
2254         autofree_context = NULL;
2255         return 0;
2256 }
2257
2258 static void talloc_autofree(void)
2259 {
2260         talloc_free(autofree_context);
2261 }
2262
2263 /*
2264   return a context which will be auto-freed on exit
2265   this is useful for reducing the noise in leak reports
2266 */
2267 _PUBLIC_ void *talloc_autofree_context(void)
2268 {
2269         if (autofree_context == NULL) {
2270                 autofree_context = _talloc_named_const(NULL, 0, "autofree_context");
2271                 talloc_set_destructor(autofree_context, talloc_autofree_destructor);
2272                 atexit(talloc_autofree);
2273         }
2274         return autofree_context;
2275 }
2276
2277 _PUBLIC_ size_t talloc_get_size(const void *context)
2278 {
2279         struct talloc_chunk *tc;
2280
2281         if (context == NULL) {
2282                 context = null_context;
2283         }
2284         if (context == NULL) {
2285                 return 0;
2286         }
2287
2288         tc = talloc_chunk_from_ptr(context);
2289
2290         return tc->size;
2291 }
2292
2293 /*
2294   find a parent of this context that has the given name, if any
2295 */
2296 _PUBLIC_ void *talloc_find_parent_byname(const void *context, const char *name)
2297 {
2298         struct talloc_chunk *tc;
2299
2300         if (context == NULL) {
2301                 return NULL;
2302         }
2303
2304         tc = talloc_chunk_from_ptr(context);
2305         while (tc) {
2306                 if (tc->name && strcmp(tc->name, name) == 0) {
2307                         return TC_PTR_FROM_CHUNK(tc);
2308                 }
2309                 while (tc && tc->prev) tc = tc->prev;
2310                 if (tc) {
2311                         tc = tc->parent;
2312                 }
2313         }
2314         return NULL;
2315 }
2316
2317 /*
2318   show the parentage of a context
2319 */
2320 _PUBLIC_ void talloc_show_parents(const void *context, FILE *file)
2321 {
2322         struct talloc_chunk *tc;
2323
2324         if (context == NULL) {
2325                 fprintf(file, "talloc no parents for NULL\n");
2326                 return;
2327         }
2328
2329         tc = talloc_chunk_from_ptr(context);
2330         fprintf(file, "talloc parents of '%s'\n", talloc_get_name(context));
2331         while (tc) {
2332                 fprintf(file, "\t'%s'\n", talloc_get_name(TC_PTR_FROM_CHUNK(tc)));
2333                 while (tc && tc->prev) tc = tc->prev;
2334                 if (tc) {
2335                         tc = tc->parent;
2336                 }
2337         }
2338         fflush(file);
2339 }
2340
2341 /*
2342   return 1 if ptr is a parent of context
2343 */
2344 static int _talloc_is_parent(const void *context, const void *ptr, int depth)
2345 {
2346         struct talloc_chunk *tc;
2347
2348         if (context == NULL) {
2349                 return 0;
2350         }
2351
2352         tc = talloc_chunk_from_ptr(context);
2353         while (tc && depth > 0) {
2354                 if (TC_PTR_FROM_CHUNK(tc) == ptr) return 1;
2355                 while (tc && tc->prev) tc = tc->prev;
2356                 if (tc) {
2357                         tc = tc->parent;
2358                         depth--;
2359                 }
2360         }
2361         return 0;
2362 }
2363
2364 /*
2365   return 1 if ptr is a parent of context
2366 */
2367 _PUBLIC_ int talloc_is_parent(const void *context, const void *ptr)
2368 {
2369         return _talloc_is_parent(context, ptr, TALLOC_MAX_DEPTH);
2370 }