added copies of libs so can be built standalone
[vlendec/samba-autobuild/.git] / ctdb / lib / talloc / talloc.3
1 .\"     Title: talloc
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.71.0 <>
4 .\"      Date: 12/09/2006
5 .\"    Manual: 
6 .\"    Source: 
7 .\"
8 .TH "TALLOC" "3" "12/09/2006" "" ""
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 talloc \- hierarchical reference counted memory pool system with destructors
16 .sp
17 .RS 3n
18 .nf
19 #include <talloc/talloc.h>
20 .fi
21 .RE
23 .PP
24 If you are used to talloc from Samba3 then please read this carefully, as talloc has changed a lot.
25 .PP
26 The new talloc is a hierarchical, reference counted memory pool system with destructors. Quite a mouthful really, but not too bad once you get used to it.
27 .PP
28 Perhaps the biggest change from Samba3 is that there is no distinction between a "talloc context" and a "talloc pointer". Any pointer returned from talloc() is itself a valid talloc context. This means you can do this:
29 .sp
30 .RS 3n
31 .nf
32     struct foo *X = talloc(mem_ctx, struct foo);
33     X\->name = talloc_strdup(X, "foo");
35 .fi
36 .RE
37 .PP
38 and the pointer
39 X\->name
40 would be a "child" of the talloc context
41 X
42 which is itself a child of
43 mem_ctx. So if you do
44 talloc_free(mem_ctx)
45 then it is all destroyed, whereas if you do
46 talloc_free(X)
47 then just
48 X
49 and
50 X\->name
51 are destroyed, and if you do
52 talloc_free(X\->name)
53 then just the name element of
54 X
55 is destroyed.
56 .PP
57 If you think about this, then what this effectively gives you is an n\-ary tree, where you can free any part of the tree with talloc_free().
58 .PP
59 If you find this confusing, then I suggest you run the
60 testsuite
61 program to watch talloc in action. You may also like to add your own tests to
62 testsuite.c
63 to clarify how some particular situation is handled.
65 .PP
66 The following is a complete guide to the talloc API. Read it all at least twice.
67 .SS "(type *)talloc(const void *ctx, type);"
68 .PP
69 The talloc() macro is the core of the talloc library. It takes a memory
70 \fIctx\fR
71 and a
72 \fItype\fR, and returns a pointer to a new area of memory of the given
73 \fItype\fR.
74 .PP
75 The returned pointer is itself a talloc context, so you can use it as the
76 \fIctx\fR
77 argument to more calls to talloc() if you wish.
78 .PP
79 The returned pointer is a "child" of the supplied context. This means that if you talloc_free() the
80 \fIctx\fR
81 then the new child disappears as well. Alternatively you can free just the child.
82 .PP
83 The
84 \fIctx\fR
85 argument to talloc() can be NULL, in which case a new top level context is created.
86 .SS "void *talloc_size(const void *ctx, size_t size);"
87 .PP
88 The function talloc_size() should be used when you don't have a convenient type to pass to talloc(). Unlike talloc(), it is not type safe (as it returns a void *), so you are on your own for type checking.
89 .SS "(typeof(ptr)) talloc_ptrtype(const void *ctx, ptr);"
90 .PP
91 The talloc_ptrtype() macro should be used when you have a pointer and want to allocate memory to point at with this pointer. When compiling with gcc >= 3 it is typesafe. Note this is a wrapper of talloc_size() and talloc_get_name() will return the current location in the source file. and not the type.
92 .SS "int talloc_free(void *ptr);"
93 .PP
94 The talloc_free() function frees a piece of talloc memory, and all its children. You can call talloc_free() on any pointer returned by talloc().
95 .PP
96 The return value of talloc_free() indicates success or failure, with 0 returned for success and \-1 for failure. The only possible failure condition is if
97 \fIptr\fR
98 had a destructor attached to it and the destructor returned \-1. See
99 \(lqtalloc_set_destructor()\(rq
100 for details on destructors.
101 .PP
102 If this pointer has an additional parent when talloc_free() is called then the memory is not actually released, but instead the most recently established parent is destroyed. See
103 \(lqtalloc_reference()\(rq
104 for details on establishing additional parents.
105 .PP
106 For more control on which parent is removed, see
107 \(lqtalloc_unlink()\(rq.
108 .PP
109 talloc_free() operates recursively on its children.
110 .SS "void *talloc_reference(const void *ctx, const void *ptr);"
111 .PP
112 The talloc_reference() function makes
113 \fIctx\fR
114 an additional parent of
115 \fIptr\fR.
116 .PP
117 The return value of talloc_reference() is always the original pointer
118 \fIptr\fR, unless talloc ran out of memory in creating the reference in which case it will return NULL (each additional reference consumes around 48 bytes of memory on intel x86 platforms).
119 .PP
120 If
121 \fIptr\fR
122 is NULL, then the function is a no\-op, and simply returns NULL.
123 .PP
124 After creating a reference you can free it in one of the following ways:
125 .PP
126 .TP 3n
127 \(bu
128 you can talloc_free() any parent of the original pointer. That will reduce the number of parents of this pointer by 1, and will cause this pointer to be freed if it runs out of parents.
129 .TP 3n
130 \(bu
131 you can talloc_free() the pointer itself. That will destroy the most recently established parent to the pointer and leave the pointer as a child of its current parent.
132 .sp
133 .RE
134 .PP
135 For more control on which parent to remove, see
136 \(lqtalloc_unlink()\(rq.
137 .SS "int talloc_unlink(const void *ctx, const void *ptr);"
138 .PP
139 The talloc_unlink() function removes a specific parent from
140 \fIptr\fR. The
141 \fIctx\fR
142 passed must either be a context used in talloc_reference() with this pointer, or must be a direct parent of ptr.
143 .PP
144 Note that if the parent has already been removed using talloc_free() then this function will fail and will return \-1. Likewise, if
145 \fIptr\fR
146 is NULL, then the function will make no modifications and return \-1.
147 .PP
148 Usually you can just use talloc_free() instead of talloc_unlink(), but sometimes it is useful to have the additional control on which parent is removed.
149 .SS "void talloc_set_destructor(const void *ptr, int (*destructor)(void *));"
150 .PP
151 The function talloc_set_destructor() sets the
152 \fIdestructor\fR
153 for the pointer
154 \fIptr\fR. A
155 \fIdestructor\fR
156 is a function that is called when the memory used by a pointer is about to be released. The destructor receives
157 \fIptr\fR
158 as an argument, and should return 0 for success and \-1 for failure.
159 .PP
160 The
161 \fIdestructor\fR
162 can do anything it wants to, including freeing other pieces of memory. A common use for destructors is to clean up operating system resources (such as open file descriptors) contained in the structure the destructor is placed on.
163 .PP
164 You can only place one destructor on a pointer. If you need more than one destructor then you can create a zero\-length child of the pointer and place an additional destructor on that.
165 .PP
166 To remove a destructor call talloc_set_destructor() with NULL for the destructor.
167 .PP
168 If your destructor attempts to talloc_free() the pointer that it is the destructor for then talloc_free() will return \-1 and the free will be ignored. This would be a pointless operation anyway, as the destructor is only called when the memory is just about to go away.
169 .SS "int talloc_increase_ref_count(const void *\fIptr\fR);"
170 .PP
171 The talloc_increase_ref_count(\fIptr\fR) function is exactly equivalent to:
172 .sp
173 .RS 3n
174 .nf
175 talloc_reference(NULL, ptr);
176 .fi
177 .RE
178 .PP
179 You can use either syntax, depending on which you think is clearer in your code.
180 .PP
181 It returns 0 on success and \-1 on failure.
182 .SS "size_t talloc_reference_count(const void *\fIptr\fR);"
183 .PP
184 Return the number of references to the pointer.
185 .SS "void talloc_set_name(const void *ptr, const char *fmt, ...);"
186 .PP
187 Each talloc pointer has a "name". The name is used principally for debugging purposes, although it is also possible to set and get the name on a pointer in as a way of "marking" pointers in your code.
188 .PP
189 The main use for names on pointer is for "talloc reports". See
190 \(lqtalloc_report_depth_cb()\(rq,
191 \(lqtalloc_report_depth_file()\(rq,
192 \(lqtalloc_report()\(rq
193 \(lqtalloc_report()\(rq
194 and
195 \(lqtalloc_report_full()\(rq
196 for details. Also see
197 \(lqtalloc_enable_leak_report()\(rq
198 and
199 \(lqtalloc_enable_leak_report_full()\(rq.
200 .PP
201 The talloc_set_name() function allocates memory as a child of the pointer. It is logically equivalent to:
202 .sp
203 .RS 3n
204 .nf
205 talloc_set_name_const(ptr, talloc_asprintf(ptr, fmt, ...));
206 .fi
207 .RE
208 .PP
209 Note that multiple calls to talloc_set_name() will allocate more memory without releasing the name. All of the memory is released when the ptr is freed using talloc_free().
210 .SS "void talloc_set_name_const(const void *\fIptr\fR, const char *\fIname\fR);"
211 .PP
212 The function talloc_set_name_const() is just like talloc_set_name(), but it takes a string constant, and is much faster. It is extensively used by the "auto naming" macros, such as talloc_p().
213 .PP
214 This function does not allocate any memory. It just copies the supplied pointer into the internal representation of the talloc ptr. This means you must not pass a
215 \fIname\fR
216 pointer to memory that will disappear before
217 \fIptr\fR
218 is freed with talloc_free().
219 .SS "void *talloc_named(const void *\fIctx\fR, size_t \fIsize\fR, const char *\fIfmt\fR, ...);"
220 .PP
221 The talloc_named() function creates a named talloc pointer. It is equivalent to:
222 .sp
223 .RS 3n
224 .nf
225 ptr = talloc_size(ctx, size);
226 talloc_set_name(ptr, fmt, ....);
227 .fi
228 .RE
229 .SS "void *talloc_named_const(const void *\fIctx\fR, size_t \fIsize\fR, const char *\fIname\fR);"
230 .PP
231 This is equivalent to:
232 .sp
233 .RS 3n
234 .nf
235 ptr = talloc_size(ctx, size);
236 talloc_set_name_const(ptr, name);
237 .fi
238 .RE
239 .SS "const char *talloc_get_name(const void *\fIptr\fR);"
240 .PP
241 This returns the current name for the given talloc pointer,
242 \fIptr\fR. See
243 \(lqtalloc_set_name()\(rq
244 for details.
245 .SS "void *talloc_init(const char *\fIfmt\fR, ...);"
246 .PP
247 This function creates a zero length named talloc context as a top level context. It is equivalent to:
248 .sp
249 .RS 3n
250 .nf
251 talloc_named(NULL, 0, fmt, ...);
252 .fi
253 .RE
254 .SS "void *talloc_new(void *\fIctx\fR);"
255 .PP
256 This is a utility macro that creates a new memory context hanging off an exiting context, automatically naming it "talloc_new: __location__" where __location__ is the source line it is called from. It is particularly useful for creating a new temporary working context.
257 .SS "(\fItype\fR *)talloc_realloc(const void *\fIctx\fR, void *\fIptr\fR, \fItype\fR, \fIcount\fR);"
258 .PP
259 The talloc_realloc() macro changes the size of a talloc pointer. It has the following equivalences:
260 .sp
261 .RS 3n
262 .nf
263 talloc_realloc(ctx, NULL, type, 1) ==> talloc(ctx, type);
264 talloc_realloc(ctx, ptr, type, 0)  ==> talloc_free(ptr);
265 .fi
266 .RE
267 .PP
268 The
269 \fIctx\fR
270 argument is only used if
271 \fIptr\fR
272 is not NULL, otherwise it is ignored.
273 .PP
274 talloc_realloc() returns the new pointer, or NULL on failure. The call will fail either due to a lack of memory, or because the pointer has more than one parent (see
275 \(lqtalloc_reference()\(rq).
276 .SS "void *talloc_realloc_size(const void *ctx, void *ptr, size_t size);"
277 .PP
278 the talloc_realloc_size() function is useful when the type is not known so the type\-safe talloc_realloc() cannot be used.
279 .SS "TYPE *talloc_steal(const void *\fInew_ctx\fR, const TYPE *\fIptr\fR);"
280 .PP
281 The talloc_steal() function changes the parent context of a talloc pointer. It is typically used when the context that the pointer is currently a child of is going to be freed and you wish to keep the memory for a longer time.
282 .PP
283 The talloc_steal() function returns the pointer that you pass it. It does not have any failure modes.
284 .PP
285 NOTE: It is possible to produce loops in the parent/child relationship if you are not careful with talloc_steal(). No guarantees are provided as to your sanity or the safety of your data if you do this.
286 .SS "TYPE *talloc_move(const void *\fInew_ctx\fR, TYPE **\fIptr\fR);"
287 .PP
288 The talloc_move() function is a wrapper around talloc_steal() which zeros the source pointer after the move. This avoids a potential source of bugs where a programmer leaves a pointer in two structures, and uses the pointer from the old structure after it has been moved to a new one.
289 .SS "size_t talloc_total_size(const void *\fIptr\fR);"
290 .PP
291 The talloc_total_size() function returns the total size in bytes used by this pointer and all child pointers. Mostly useful for debugging.
292 .PP
293 Passing NULL is allowed, but it will only give a meaningful result if talloc_enable_leak_report() or talloc_enable_leak_report_full() has been called.
294 .SS "size_t talloc_total_blocks(const void *\fIptr\fR);"
295 .PP
296 The talloc_total_blocks() function returns the total memory block count used by this pointer and all child pointers. Mostly useful for debugging.
297 .PP
298 Passing NULL is allowed, but it will only give a meaningful result if talloc_enable_leak_report() or talloc_enable_leak_report_full() has been called.
299 .SS "void talloc_report(const void *ptr, FILE *f);"
300 .PP
301 The talloc_report() function prints a summary report of all memory used by
302 \fIptr\fR. One line of report is printed for each immediate child of ptr, showing the total memory and number of blocks used by that child.
303 .PP
304 You can pass NULL for the pointer, in which case a report is printed for the top level memory context, but only if talloc_enable_leak_report() or talloc_enable_leak_report_full() has been called.
305 .SS "void talloc_report_full(const void *\fIptr\fR, FILE *\fIf\fR);"
306 .PP
307 This provides a more detailed report than talloc_report(). It will recursively print the entire tree of memory referenced by the pointer. References in the tree are shown by giving the name of the pointer that is referenced.
308 .PP
309 You can pass NULL for the pointer, in which case a report is printed for the top level memory context, but only if talloc_enable_leak_report() or talloc_enable_leak_report_full() has been called.
310 .SS ""
311 .HP 28
312 .BI "void talloc_report_depth_cb(" "const\ void\ *ptr" ", " "int\ depth" ", " "int\ max_depth" ", " "void\ (*callback)(const\ void\ *ptr,\ int\ depth,\ int\ max_depth,\ int\ is_ref,\ void\ *priv)" ", " "void\ *priv" ");"
313 .PP
314 This provides a more flexible reports than talloc_report(). It will recursively call the callback for the entire tree of memory referenced by the pointer. References in the tree are passed with
315 \fIis_ref = 1\fR
316 and the pointer that is referenced.
317 .PP
318 You can pass NULL for the pointer, in which case a report is printed for the top level memory context, but only if talloc_enable_leak_report() or talloc_enable_leak_report_full() has been called.
319 .PP
320 The recursion is stopped when depth >= max_depth. max_depth = \-1 means only stop at leaf nodes.
321 .SS ""
322 .HP 30
323 .BI "void talloc_report_depth_file(" "const\ void\ *ptr" ", " "int\ depth" ", " "int\ max_depth" ", " "FILE\ *f" ");"
324 .PP
325 This provides a more flexible reports than talloc_report(). It will let you specify the depth and max_depth.
326 .SS "void talloc_enable_leak_report(void);"
327 .PP
328 This enables calling of talloc_report(NULL, stderr) when the program exits. In Samba4 this is enabled by using the \-\-leak\-report command line option.
329 .PP
330 For it to be useful, this function must be called before any other talloc function as it establishes a "null context" that acts as the top of the tree. If you don't call this function first then passing NULL to talloc_report() or talloc_report_full() won't give you the full tree printout.
331 .PP
332 Here is a typical talloc report:
333 .sp
334 .RS 3n
335 .nf
336 talloc report on 'null_context' (total 267 bytes in 15 blocks)
337 libcli/auth/spnego_parse.c:55  contains   31 bytes in   2 blocks
338 libcli/auth/spnego_parse.c:55  contains   31 bytes in   2 blocks
339 iconv(UTF8,CP850)              contains   42 bytes in   2 blocks
340 libcli/auth/spnego_parse.c:55  contains   31 bytes in   2 blocks
341 iconv(CP850,UTF8)              contains   42 bytes in   2 blocks
342 iconv(UTF8,UTF\-16LE)           contains   45 bytes in   2 blocks
343 iconv(UTF\-16LE,UTF8)           contains   45 bytes in   2 blocks
345 .fi
346 .RE
347 .SS "void talloc_enable_leak_report_full(void);"
348 .PP
349 This enables calling of talloc_report_full(NULL, stderr) when the program exits. In Samba4 this is enabled by using the \-\-leak\-report\-full command line option.
350 .PP
351 For it to be useful, this function must be called before any other talloc function as it establishes a "null context" that acts as the top of the tree. If you don't call this function first then passing NULL to talloc_report() or talloc_report_full() won't give you the full tree printout.
352 .PP
353 Here is a typical full report:
354 .sp
355 .RS 3n
356 .nf
357 full talloc report on 'root' (total 18 bytes in 8 blocks)
358 p1               contains     18 bytes in   7 blocks (ref 0)
359     r1               contains     13 bytes in   2 blocks (ref 0)
360         reference to: p2
361     p2               contains      1 bytes in   1 blocks (ref 1)
362     x3               contains      1 bytes in   1 blocks (ref 0)
363     x2               contains      1 bytes in   1 blocks (ref 0)
364     x1               contains      1 bytes in   1 blocks (ref 0)
366 .fi
367 .RE
368 .SS "(\fItype\fR *)talloc_zero(const void *\fIctx\fR, \fItype\fR);"
369 .PP
370 The talloc_zero() macro is equivalent to:
371 .sp
372 .RS 3n
373 .nf
374 ptr = talloc(ctx, type);
375 if (ptr) memset(ptr, 0, sizeof(type));
376 .fi
377 .RE
378 .SS "void *talloc_zero_size(const void *\fIctx\fR, size_t \fIsize\fR)"
379 .PP
380 The talloc_zero_size() function is useful when you don't have a known type.
381 .SS "void *talloc_memdup(const void *\fIctx\fR, const void *\fIp\fR, size_t size);"
382 .PP
383 The talloc_memdup() function is equivalent to:
384 .sp
385 .RS 3n
386 .nf
387 ptr = talloc_size(ctx, size);
388 if (ptr) memcpy(ptr, p, size);
389 .fi
390 .RE
391 .SS "char *talloc_strdup(const void *\fIctx\fR, const char *\fIp\fR);"
392 .PP
393 The talloc_strdup() function is equivalent to:
394 .sp
395 .RS 3n
396 .nf
397 ptr = talloc_size(ctx, strlen(p)+1);
398 if (ptr) memcpy(ptr, p, strlen(p)+1);
399 .fi
400 .RE
401 .PP
402 This function sets the name of the new pointer to the passed string. This is equivalent to:
403 .sp
404 .RS 3n
405 .nf
406 talloc_set_name_const(ptr, ptr)
407 .fi
408 .RE
409 .SS "char *talloc_strndup(const void *\fIt\fR, const char *\fIp\fR, size_t \fIn\fR);"
410 .PP
411 The talloc_strndup() function is the talloc equivalent of the C library function strndup(3).
412 .PP
413 This function sets the name of the new pointer to the passed string. This is equivalent to:
414 .sp
415 .RS 3n
416 .nf
417 talloc_set_name_const(ptr, ptr)
418 .fi
419 .RE
420 .SS "char *talloc_vasprintf(const void *\fIt\fR, const char *\fIfmt\fR, va_list \fIap\fR);"
421 .PP
422 The talloc_vasprintf() function is the talloc equivalent of the C library function vasprintf(3).
423 .SS "char *talloc_asprintf(const void *\fIt\fR, const char *\fIfmt\fR, ...);"
424 .PP
425 The talloc_asprintf() function is the talloc equivalent of the C library function asprintf(3).
426 .PP
427 This function sets the name of the new pointer to the passed string. This is equivalent to:
428 .sp
429 .RS 3n
430 .nf
431 talloc_set_name_const(ptr, ptr)
432 .fi
433 .RE
434 .SS "char *talloc_asprintf_append(char *s, const char *fmt, ...);"
435 .PP
436 The talloc_asprintf_append() function appends the given formatted string to the given string.
437 .SS "(type *)talloc_array(const void *ctx, type, uint_t count);"
438 .PP
439 The talloc_array() macro is equivalent to:
440 .sp
441 .RS 3n
442 .nf
443 (type *)talloc_size(ctx, sizeof(type) * count);
444 .fi
445 .RE
446 .PP
447 except that it provides integer overflow protection for the multiply, returning NULL if the multiply overflows.
448 .SS "void *talloc_array_size(const void *ctx, size_t size, uint_t count);"
449 .PP
450 The talloc_array_size() function is useful when the type is not known. It operates in the same way as talloc_array(), but takes a size instead of a type.
451 .SS "(typeof(ptr)) talloc_array_ptrtype(const void *ctx, ptr, uint_t count);"
452 .PP
453 The talloc_ptrtype() macro should be used when you have a pointer to an array and want to allocate memory of an array to point at with this pointer. When compiling with gcc >= 3 it is typesafe. Note this is a wrapper of talloc_array_size() and talloc_get_name() will return the current location in the source file. and not the type.
454 .SS "void *talloc_realloc_fn(const void *ctx, void *ptr, size_t size)"
455 .PP
456 This is a non\-macro version of talloc_realloc(), which is useful as libraries sometimes want a realloc function pointer. A realloc(3) implementation encapsulates the functionality of malloc(3), free(3) and realloc(3) in one call, which is why it is useful to be able to pass around a single function pointer.
457 .SS "void *talloc_autofree_context(void);"
458 .PP
459 This is a handy utility function that returns a talloc context which will be automatically freed on program exit. This can be used to reduce the noise in memory leak reports.
460 .SS "void *talloc_check_name(const void *ptr, const char *name);"
461 .PP
462 This function checks if a pointer has the specified
463 \fIname\fR. If it does then the pointer is returned. It it doesn't then NULL is returned.
464 .SS "(type *)talloc_get_type(const void *ptr, type);"
465 .PP
466 This macro allows you to do type checking on talloc pointers. It is particularly useful for void* private pointers. It is equivalent to this:
467 .sp
468 .RS 3n
469 .nf
470 (type *)talloc_check_name(ptr, #type)
471 .fi
472 .RE
473 .SS "talloc_set_type(const void *ptr, type);"
474 .PP
475 This macro allows you to force the name of a pointer to be a particular
476 \fItype\fR. This can be used in conjunction with talloc_get_type() to do type checking on void* pointers.
477 .PP
478 It is equivalent to this:
479 .sp
480 .RS 3n
481 .nf
482 talloc_set_name_const(ptr, #type)
483 .fi
484 .RE
486 .PP
487 All the additional features of talloc(3) over malloc(3) do come at a price. We have a simple performance test in Samba4 that measures talloc() versus malloc() performance, and it seems that talloc() is about 10% slower than malloc() on my x86 Debian Linux box. For Samba, the great reduction in code complexity that we get by using talloc makes this worthwhile, especially as the total overhead of talloc/malloc in Samba is already quite small.
488 .SH "SEE ALSO"
489 .PP
490 malloc(3), strndup(3), vasprintf(3), asprintf(3),
491 \fI\%\fR
493 .PP
494 Copyright (C) Andrew Tridgell 2004
495 .PP
496 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
497 .PP
498 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
499 .PP
500 You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.