7 The most current version of this document is available at
8 http://samba.org/ftp/unpacked/samba4/source/lib/talloc/talloc_guide.txt
10 If you are used to talloc from Samba3 then please read this carefully,
11 as talloc has changed a lot.
13 The new talloc is a hierarchical, reference counted memory pool system
14 with destructors. Quite a mounthful really, but not too bad once you
17 Perhaps the biggest change from Samba3 is that there is no distinction
18 between a "talloc context" and a "talloc pointer". Any pointer
19 returned from talloc() is itself a valid talloc context. This means
22 struct foo *X = talloc(mem_ctx, struct foo);
23 X->name = talloc_strdup(X, "foo");
25 and the pointer X->name would be a "child" of the talloc context "X"
26 which is itself a child of mem_ctx. So if you do talloc_free(mem_ctx)
27 then it is all destroyed, whereas if you do talloc_free(X) then just X
28 and X->name are destroyed, and if you do talloc_free(X->name) then
29 just the name element of X is destroyed.
31 If you think about this, then what this effectively gives you is an
32 n-ary tree, where you can free any part of the tree with
35 If you find this confusing, then I suggest you run the testsuite to
36 watch talloc in action. You may also like to add your own tests to
37 testsuite.c to clarify how some particular situation is handled.
43 All the additional features of talloc() over malloc() do come at a
44 price. We have a simple performance test in Samba4 that measures
45 talloc() versus malloc() performance, and it seems that talloc() is
46 about 10% slower than malloc() on my x86 Debian Linux box. For Samba,
47 the great reduction in code complexity that we get by using talloc
48 makes this worthwhile, especially as the total overhead of
49 talloc/malloc in Samba is already quite small.
55 The following is a complete guide to the talloc API. Read it all at
59 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
60 (type *)talloc(const void *context, type);
62 The talloc() macro is the core of the talloc library. It takes a
63 memory context and a type, and returns a pointer to a new area of
64 memory of the given type.
66 The returned pointer is itself a talloc context, so you can use it as
67 the context argument to more calls to talloc if you wish.
69 The returned pointer is a "child" of the supplied context. This means
70 that if you talloc_free() the context then the new child disappears as
71 well. Alternatively you can free just the child.
73 The context argument to talloc() can be NULL, in which case a new top
74 level context is created.
77 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
78 void *talloc_size(const void *context, size_t size);
80 The function talloc_size() should be used when you don't have a
81 convenient type to pass to talloc(). Unlike talloc(), it is not type
82 safe (as it returns a void *), so you are on your own for type checking.
85 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
86 int talloc_free(void *ptr);
88 The talloc_free() function frees a piece of talloc memory, and all its
89 children. You can call talloc_free() on any pointer returned by
92 The return value of talloc_free() indicates success or failure, with 0
93 returned for success and -1 for failure. The only possible failure
94 condition is if the pointer had a destructor attached to it and the
95 destructor returned -1. See talloc_set_destructor() for details on
98 If this pointer has an additional parent when talloc_free() is called
99 then the memory is not actually released, but instead the most
100 recently established parent is destroyed. See talloc_reference() for
101 details on establishing additional parents.
103 For more control on which parent is removed, see talloc_unlink()
105 talloc_free() operates recursively on its children.
108 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
109 void *talloc_reference(const void *context, const void *ptr);
111 The talloc_reference() function makes "context" an additional parent
114 The return value of talloc_reference() is always the original pointer
115 "ptr", unless talloc ran out of memory in creating the reference in
116 which case it will return NULL (each additional reference consumes
117 around 48 bytes of memory on intel x86 platforms).
119 If "ptr" is NULL, then the function is a no-op, and simply returns NULL.
121 After creating a reference you can free it in one of the following
124 - you can talloc_free() any parent of the original pointer. That
125 will reduce the number of parents of this pointer by 1, and will
126 cause this pointer to be freed if it runs out of parents.
128 - you can talloc_free() the pointer itself. That will destroy the
129 most recently established parent to the pointer and leave the
130 pointer as a child of its current parent.
132 For more control on which parent to remove, see talloc_unlink()
135 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
136 int talloc_unlink(const void *context, const void *ptr);
138 The talloc_unlink() function removes a specific parent from ptr. The
139 context passed must either be a context used in talloc_reference()
140 with this pointer, or must be a direct parent of ptr.
142 Note that if the parent has already been removed using talloc_free()
143 then this function will fail and will return -1. Likewise, if "ptr"
144 is NULL, then the function will make no modifications and return -1.
146 Usually you can just use talloc_free() instead of talloc_unlink(), but
147 sometimes it is useful to have the additional control on which parent
151 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
152 void talloc_set_destructor(const void *ptr, int (*destructor)(void *));
154 The function talloc_set_destructor() sets the "destructor" for the
155 pointer "ptr". A destructor is a function that is called when the
156 memory used by a pointer is about to be released. The destructor
157 receives the pointer as an argument, and should return 0 for success
160 The destructor can do anything it wants to, including freeing other
161 pieces of memory. A common use for destructors is to clean up
162 operating system resources (such as open file descriptors) contained
163 in the structure the destructor is placed on.
165 You can only place one destructor on a pointer. If you need more than
166 one destructor then you can create a zero-length child of the pointer
167 and place an additional destructor on that.
169 To remove a destructor call talloc_set_destructor() with NULL for the
172 If your destructor attempts to talloc_free() the pointer that it is
173 the destructor for then talloc_free() will return -1 and the free will
174 be ignored. This would be a pointless operation anyway, as the
175 destructor is only called when the memory is just about to go away.
178 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
179 void talloc_increase_ref_count(const void *ptr);
181 The talloc_increase_ref_count(ptr) function is exactly equivalent to:
183 talloc_reference(NULL, ptr);
185 You can use either syntax, depending on which you think is clearer in
189 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
190 void talloc_set_name(const void *ptr, const char *fmt, ...);
192 Each talloc pointer has a "name". The name is used principally for
193 debugging purposes, although it is also possible to set and get the
194 name on a pointer in as a way of "marking" pointers in your code.
196 The main use for names on pointer is for "talloc reports". See
197 talloc_report() and talloc_report_full() for details. Also see
198 talloc_enable_leak_report() and talloc_enable_leak_report_full().
200 The talloc_set_name() function allocates memory as a child of the
201 pointer. It is logically equivalent to:
202 talloc_set_name_const(ptr, talloc_asprintf(ptr, fmt, ...));
204 Note that multiple calls to talloc_set_name() will allocate more
205 memory without releasing the name. All of the memory is released when
206 the ptr is freed using talloc_free().
209 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
210 void talloc_set_name_const(const void *ptr, const char *name);
212 The function talloc_set_name_const() is just like talloc_set_name(),
213 but it takes a string constant, and is much faster. It is extensively
214 used by the "auto naming" macros, such as talloc_p().
216 This function does not allocate any memory. It just copies the
217 supplied pointer into the internal representation of the talloc
218 ptr. This means you must not pass a name pointer to memory that will
219 disappear before the ptr is freed with talloc_free().
222 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
223 void *talloc_named(const void *context, size_t size, const char *fmt, ...);
225 The talloc_named() function creates a named talloc pointer. It is
228 ptr = talloc_size(context, size);
229 talloc_set_name(ptr, fmt, ....);
232 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
233 void *talloc_named_const(const void *context, size_t size, const char *name);
235 This is equivalent to:
237 ptr = talloc_size(context, size);
238 talloc_set_name_const(ptr, name);
241 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
242 const char *talloc_get_name(const void *ptr);
244 This returns the current name for the given talloc pointer. See
245 talloc_set_name() for details.
248 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
249 void *talloc_init(const char *fmt, ...);
251 This function creates a zero length named talloc context as a top
252 level context. It is equivalent to:
254 talloc_named(NULL, 0, fmt, ...);
257 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
258 void *talloc_new(void *ctx);
260 This is a utility macro that creates a new memory context hanging
261 off an exiting context, automatically naming it "talloc_new: __location__"
262 where __location__ is the source line it is called from. It is
263 particularly useful for creating a new temporary working context.
266 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
267 (type *)talloc_realloc(const void *context, void *ptr, type, count);
269 The talloc_realloc() macro changes the size of a talloc
270 pointer. It has the following equivalences:
272 talloc_realloc(context, NULL, type, 1) ==> talloc(context, type);
273 talloc_realloc(context, ptr, type, 0) ==> talloc_free(ptr);
275 The "context" argument is only used if "ptr" is not NULL, otherwise it
278 talloc_realloc() returns the new pointer, or NULL on failure. The call
279 will fail either due to a lack of memory, or because the pointer has
280 more than one parent (see talloc_reference()).
283 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
284 void *talloc_realloc_size(const void *context, void *ptr, size_t size);
286 the talloc_realloc_size() function is useful when the type is not
287 known so the typesafe talloc_realloc() cannot be used.
290 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
291 void *talloc_steal(const void *new_ctx, const void *ptr);
293 The talloc_steal() function changes the parent context of a talloc
294 pointer. It is typically used when the context that the pointer is
295 currently a child of is going to be freed and you wish to keep the
296 memory for a longer time.
298 The talloc_steal() function returns the pointer that you pass it. It
299 does not have any failure modes.
301 NOTE: It is possible to produce loops in the parent/child relationship
302 if you are not careful with talloc_steal(). No guarantees are provided
303 as to your sanity or the safety of your data if you do this.
306 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
307 off_t talloc_total_size(const void *ptr);
309 The talloc_total_size() function returns the total size in bytes used
310 by this pointer and all child pointers. Mostly useful for debugging.
312 Passing NULL is allowed, but it will only give a meaningful result if
313 talloc_enable_leak_report() or talloc_enable_leak_report_full() has
317 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
318 off_t talloc_total_blocks(const void *ptr);
320 The talloc_total_blocks() function returns the total memory block
321 count used by this pointer and all child pointers. Mostly useful for
324 Passing NULL is allowed, but it will only give a meaningful result if
325 talloc_enable_leak_report() or talloc_enable_leak_report_full() has
329 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
330 void talloc_report(const void *ptr, FILE *f);
332 The talloc_report() function prints a summary report of all memory
333 used by ptr. One line of report is printed for each immediate child of
334 ptr, showing the total memory and number of blocks used by that child.
336 You can pass NULL for the pointer, in which case a report is printed
337 for the top level memory context, but only if
338 talloc_enable_leak_report() or talloc_enable_leak_report_full() has
342 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
343 void talloc_report_full(const void *ptr, FILE *f);
345 This provides a more detailed report than talloc_report(). It will
346 recursively print the ensire tree of memory referenced by the
347 pointer. References in the tree are shown by giving the name of the
348 pointer that is referenced.
350 You can pass NULL for the pointer, in which case a report is printed
351 for the top level memory context, but only if
352 talloc_enable_leak_report() or talloc_enable_leak_report_full() has
356 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
357 void talloc_enable_leak_report(void);
359 This enables calling of talloc_report(NULL, stderr) when the program
360 exits. In Samba4 this is enabled by using the --leak-report command
363 For it to be useful, this function must be called before any other
364 talloc function as it establishes a "null context" that acts as the
365 top of the tree. If you don't call this function first then passing
366 NULL to talloc_report() or talloc_report_full() won't give you the
369 Here is a typical talloc report:
371 talloc report on 'null_context' (total 267 bytes in 15 blocks)
372 libcli/auth/spnego_parse.c:55 contains 31 bytes in 2 blocks
373 libcli/auth/spnego_parse.c:55 contains 31 bytes in 2 blocks
374 iconv(UTF8,CP850) contains 42 bytes in 2 blocks
375 libcli/auth/spnego_parse.c:55 contains 31 bytes in 2 blocks
376 iconv(CP850,UTF8) contains 42 bytes in 2 blocks
377 iconv(UTF8,UTF-16LE) contains 45 bytes in 2 blocks
378 iconv(UTF-16LE,UTF8) contains 45 bytes in 2 blocks
381 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
382 void talloc_enable_leak_report_full(void);
384 This enables calling of talloc_report_full(NULL, stderr) when the
385 program exits. In Samba4 this is enabled by using the
386 --leak-report-full command line option.
388 For it to be useful, this function must be called before any other
389 talloc function as it establishes a "null context" that acts as the
390 top of the tree. If you don't call this function first then passing
391 NULL to talloc_report() or talloc_report_full() won't give you the
394 Here is a typical full report:
396 full talloc report on 'root' (total 18 bytes in 8 blocks)
397 p1 contains 18 bytes in 7 blocks (ref 0)
398 r1 contains 13 bytes in 2 blocks (ref 0)
400 p2 contains 1 bytes in 1 blocks (ref 1)
401 x3 contains 1 bytes in 1 blocks (ref 0)
402 x2 contains 1 bytes in 1 blocks (ref 0)
403 x1 contains 1 bytes in 1 blocks (ref 0)
406 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
407 (type *)talloc_zero(const void *ctx, type);
409 The talloc_zero() macro is equivalent to:
411 ptr = talloc(ctx, type);
412 if (ptr) memset(ptr, 0, sizeof(type));
415 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
416 void *talloc_zero_size(const void *ctx, size_t size)
418 The talloc_zero_size() function is useful when you don't have a known type
421 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
422 void *talloc_memdup(const void *ctx, const void *p, size_t size);
424 The talloc_memdup() function is equivalent to:
426 ptr = talloc_size(ctx, size);
427 if (ptr) memcpy(ptr, p, size);
430 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
431 char *talloc_strdup(const void *ctx, const char *p);
433 The talloc_strdup() function is equivalent to:
435 ptr = talloc_size(ctx, strlen(p)+1);
436 if (ptr) memcpy(ptr, p, strlen(p)+1);
438 This functions sets the name of the new pointer to the passed
439 string. This is equivalent to:
440 talloc_set_name_const(ptr, ptr)
442 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
443 char *talloc_strndup(const void *t, const char *p, size_t n);
445 The talloc_strndup() function is the talloc equivalent of the C
446 library function strndup()
448 This functions sets the name of the new pointer to the passed
449 string. This is equivalent to:
450 talloc_set_name_const(ptr, ptr)
453 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
454 char *talloc_vasprintf(const void *t, const char *fmt, va_list ap);
456 The talloc_vasprintf() function is the talloc equivalent of the C
457 library function vasprintf()
460 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
461 char *talloc_asprintf(const void *t, const char *fmt, ...);
463 The talloc_asprintf() function is the talloc equivalent of the C
464 library function asprintf()
466 This functions sets the name of the new pointer to the passed
467 string. This is equivalent to:
468 talloc_set_name_const(ptr, ptr)
471 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
472 char *talloc_asprintf_append(char *s, const char *fmt, ...);
474 The talloc_asprintf_append() function appends the given formatted
475 string to the given string.
478 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
479 (type *)talloc_array(const void *ctx, type, uint_t count);
481 The talloc_array() macro is equivalent to:
483 (type *)talloc_size(ctx, sizeof(type) * count);
485 except that it provides integer overflow protection for the multiply,
486 returning NULL if the multiply overflows.
489 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
490 void *talloc_array_size(const void *ctx, size_t size, uint_t count);
492 The talloc_array_size() function is useful when the type is not
493 known. It operates in the same way as talloc_array(), but takes a size
497 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
498 void *talloc_realloc_fn(const void *ctx, void *ptr, size_t size);
500 This is a non-macro version of talloc_realloc(), which is useful
501 as libraries sometimes want a ralloc function pointer. A realloc()
502 implementation encapsulates the functionality of malloc(), free() and
503 realloc() in one call, which is why it is useful to be able to pass
504 around a single function pointer.
507 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
508 void *talloc_autofree_context(void);
510 This is a handy utility function that returns a talloc context
511 which will be automatically freed on program exit. This can be used
512 to reduce the noise in memory leak reports.
515 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
516 void *talloc_check_name(const void *ptr, const char *name);
518 This function checks if a pointer has the specified name. If it does
519 then the pointer is returned. It it doesn't then NULL is returned.
522 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
523 (type *)talloc_get_type(const void *ptr, type);
525 This macro allows you to do type checking on talloc pointers. It is
526 particularly useful for void* private pointers. It is equivalent to
529 (type *)talloc_check_name(ptr, #type)
532 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
533 talloc_set_type(const void *ptr, type);
535 This macro allows you to force the name of a pointer to be a
536 particular type. This can be used in conjunction with
537 talloc_get_type() to do type checking on void* pointers.
539 It is equivalent to this:
540 talloc_set_name_const(ptr, #type)