r17895: - talloc_increase_ref_count() can fail
[samba.git] / source4 / lib / talloc / talloc.3.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
3 <refentry>
4   <refmeta>
5     <refentrytitle>talloc</refentrytitle>
6     <manvolnum>3</manvolnum>
7   </refmeta>
8   <refnamediv>
9     <refname>talloc</refname>
10 <refpurpose>hierarchical reference counted memory pool system with destructors</refpurpose>
11   </refnamediv>
12   <refsynopsisdiv>
13 <synopsis>#include &lt;talloc/talloc.h&gt;</synopsis>
14   </refsynopsisdiv>
15   <refsect1><title>DESCRIPTION</title>
16     <para>
17       If you are used to talloc from Samba3 then please read this
18       carefully, as talloc has changed a lot.
19     </para>
20     <para>
21       The new talloc is a hierarchical, reference counted memory pool
22       system with destructors.  Quite a mouthful really, but not too bad
23       once you get used to it.
24     </para>
25     <para>
26       Perhaps the biggest change from Samba3 is that there is no
27       distinction between a "talloc context" and a "talloc pointer".  Any
28       pointer returned from talloc() is itself a valid talloc context. 
29       This means you can do this:
30     </para>
31     <programlisting>
32     struct foo *X = talloc(mem_ctx, struct foo);
33     X->name = talloc_strdup(X, "foo");
34     </programlisting>
35     <para>
36       and the pointer <literal role="code">X-&gt;name</literal>
37       would be a "child" of the talloc context <literal
38       role="code">X</literal> which is itself a child of
39       <literal role="code">mem_ctx</literal>.  So if you do
40       <literal role="code">talloc_free(mem_ctx)</literal> then
41       it is all destroyed, whereas if you do <literal
42       role="code">talloc_free(X)</literal> then just <literal
43       role="code">X</literal> and <literal
44       role="code">X-&gt;name</literal> are destroyed, and if
45       you do <literal
46       role="code">talloc_free(X-&gt;name)</literal> then just
47       the name element of <literal role="code">X</literal> is
48       destroyed.
49     </para>
50     <para>
51       If you think about this, then what this effectively gives you is an
52       n-ary tree, where you can free any part of the tree with
53       talloc_free().
54     </para>
55     <para>
56       If you find this confusing, then I suggest you run the <literal
57       role="code">testsuite</literal> program to watch talloc
58       in action.  You may also like to add your own tests to <literal
59       role="code">testsuite.c</literal> to clarify how some
60       particular situation is handled.
61     </para>
62   </refsect1>
63   <refsect1><title>TALLOC API</title>
64     <para>
65       The following is a complete guide to the talloc API. Read it all at
66       least twice.
67     </para>
68     <refsect2><title>(type *)talloc(const void *ctx, type);</title>
69         <para>
70           The talloc() macro is the core of the talloc library.  It takes a
71           memory <emphasis role="italic">ctx</emphasis> and a <emphasis
72           role="italic">type</emphasis>, and returns a pointer to a new
73           area of memory of the given <emphasis
74           role="italic">type</emphasis>.
75         </para>
76         <para>
77           The returned pointer is itself a talloc context, so you can use
78           it as the <emphasis role="italic">ctx</emphasis> argument to more
79           calls to talloc() if you wish.
80         </para>
81         <para>
82           The returned pointer is a "child" of the supplied context.  This
83           means that if you talloc_free() the <emphasis
84           role="italic">ctx</emphasis> then the new child disappears as
85           well.  Alternatively you can free just the child.
86         </para>
87         <para>
88           The <emphasis role="italic">ctx</emphasis> argument to talloc()
89           can be NULL, in which case a new top level context is created.
90         </para>
91     </refsect2>
92     <refsect2><title>void *talloc_size(const void *ctx, size_t size);</title>
93         <para>
94           The function talloc_size() should be used when you don't have a
95           convenient type to pass to talloc().  Unlike talloc(), it is not
96           type safe (as it returns a void *), so you are on your own for
97           type checking.
98         </para>
99     </refsect2>
100     <refsect2><title>(typeof(ptr)) talloc_ptrtype(const void *ctx, ptr);</title>
101         <para>
102           The talloc_ptrtype() macro should be used when you have a pointer and
103           want to allocate memory to point at with this pointer. When compiling
104           with gcc >= 3 it is typesafe. Note this is a wrapper of talloc_size()
105           and talloc_get_name() will return the current location in the source file.
106           and not the type.
107         </para>
108     </refsect2>
109     <refsect2><title>int talloc_free(void *ptr);</title>
110         <para>
111           The talloc_free() function frees a piece of talloc memory, and
112           all its children.  You can call talloc_free() on any pointer
113           returned by talloc().
114         </para>
115         <para>
116           The return value of talloc_free() indicates success or failure,
117           with 0 returned for success and -1 for failure.  The only
118           possible failure condition is if <emphasis
119           role="italic">ptr</emphasis> had a destructor attached to it and
120           the destructor returned -1.  See <link
121           linkend="talloc_set_destructor"><quote>talloc_set_destructor()</quote></link>
122           for details on destructors.
123         </para>
124         <para>
125           If this pointer has an additional parent when talloc_free() is
126           called then the memory is not actually released, but instead the
127           most recently established parent is destroyed.  See <link
128           linkend="talloc_reference"><quote>talloc_reference()</quote></link>
129           for details on establishing additional parents.
130         </para>
131         <para>
132           For more control on which parent is removed, see <link
133           linkend="talloc_unlink"><quote>talloc_unlink()</quote></link>.
134         </para>
135         <para>
136           talloc_free() operates recursively on its children.
137         </para>
138     </refsect2>
139     <refsect2 id="talloc_reference"><title>void *talloc_reference(const void *ctx, const void *ptr);</title>
140         <para>
141           The talloc_reference() function makes <emphasis
142           role="italic">ctx</emphasis> an additional parent of <emphasis
143           role="italic">ptr</emphasis>.
144         </para>
145         <para>
146           The return value of talloc_reference() is always the original
147           pointer <emphasis role="italic">ptr</emphasis>, unless talloc ran
148           out of memory in creating the reference in which case it will
149           return NULL (each additional reference consumes around 48 bytes
150           of memory on intel x86 platforms).
151         </para>
152         <para>
153           If <emphasis role="italic">ptr</emphasis> is NULL, then the
154           function is a no-op, and simply returns NULL.
155         </para>
156         <para>
157           After creating a reference you can free it in one of the
158           following ways:
159         </para>
160       <para>
161         <itemizedlist>
162           <listitem>
163             <para>
164               you can talloc_free() any parent of the original pointer. 
165               That will reduce the number of parents of this pointer by 1,
166               and will cause this pointer to be freed if it runs out of
167               parents.
168             </para>
169           </listitem>
170           <listitem>
171             <para>
172               you can talloc_free() the pointer itself.  That will destroy
173               the most recently established parent to the pointer and leave
174               the pointer as a child of its current parent.
175             </para>
176           </listitem>
177         </itemizedlist>
178       </para>
179       <para>
180         For more control on which parent to remove, see <link
181         linkend="talloc_unlink"><quote>talloc_unlink()</quote></link>.
182       </para>
183     </refsect2>
184     <refsect2 id="talloc_unlink"><title>int talloc_unlink(const void *ctx, const void *ptr);</title>
185         <para>
186           The talloc_unlink() function removes a specific parent from
187           <emphasis role="italic">ptr</emphasis>. The <emphasis
188           role="italic">ctx</emphasis> passed must either be a context used
189           in talloc_reference() with this pointer, or must be a direct
190           parent of ptr.
191         </para>
192         <para>
193           Note that if the parent has already been removed using
194           talloc_free() then this function will fail and will return -1. 
195           Likewise, if <emphasis role="italic">ptr</emphasis> is NULL, then
196           the function will make no modifications and return -1.
197         </para>
198         <para>
199           Usually you can just use talloc_free() instead of
200           talloc_unlink(), but sometimes it is useful to have the
201           additional control on which parent is removed.
202         </para>
203     </refsect2>
204     <refsect2 id="talloc_set_destructor"><title>void talloc_set_destructor(const void *ptr, int (*destructor)(void *));</title>
205         <para>
206           The function talloc_set_destructor() sets the <emphasis
207           role="italic">destructor</emphasis> for the pointer <emphasis
208           role="italic">ptr</emphasis>.  A <emphasis
209           role="italic">destructor</emphasis> is a function that is called
210           when the memory used by a pointer is about to be released.  The
211           destructor receives <emphasis role="italic">ptr</emphasis> as an
212           argument, and should return 0 for success and -1 for failure.
213         </para>
214         <para>
215           The <emphasis role="italic">destructor</emphasis> can do anything
216           it wants to, including freeing other pieces of memory.  A common
217           use for destructors is to clean up operating system resources
218           (such as open file descriptors) contained in the structure the
219           destructor is placed on.
220         </para>
221         <para>
222           You can only place one destructor on a pointer.  If you need more
223           than one destructor then you can create a zero-length child of
224           the pointer and place an additional destructor on that.
225         </para>
226         <para>
227           To remove a destructor call talloc_set_destructor() with NULL for
228           the destructor.
229         </para>
230         <para>
231           If your destructor attempts to talloc_free() the pointer that it
232           is the destructor for then talloc_free() will return -1 and the
233           free will be ignored.  This would be a pointless operation
234           anyway, as the destructor is only called when the memory is just
235           about to go away.
236         </para>
237     </refsect2>
238     <refsect2><title>int talloc_increase_ref_count(const void *<emphasis role="italic">ptr</emphasis>);</title>
239         <para>
240           The talloc_increase_ref_count(<emphasis
241           role="italic">ptr</emphasis>) function is exactly equivalent to:
242         </para>
243         <programlisting>talloc_reference(NULL, ptr);</programlisting>
244         <para>
245           You can use either syntax, depending on which you think is
246           clearer in your code.
247         </para>
248         <para>
249           It returns 0 on success and -1 on failure.
250         </para>
251     </refsect2>
252     <refsect2 id="talloc_set_name"><title>void talloc_set_name(const void *ptr, const char *fmt, ...);</title>
253         <para>
254           Each talloc pointer has a "name".  The name is used principally
255           for debugging purposes, although it is also possible to set and
256           get the name on a pointer in as a way of "marking" pointers in
257           your code.
258         </para>
259         <para>
260           The main use for names on pointer is for "talloc reports".  See
261           <link
262           linkend="talloc_report"><quote>talloc_report()</quote></link>
263           and <link
264           linkend="talloc_report_full"><quote>talloc_report_full()</quote></link>
265           for details.  Also see <link
266           linkend="talloc_enable_leak_report"><quote>talloc_enable_leak_report()</quote></link>
267           and <link
268           linkend="talloc_enable_leak_report_full"><quote>talloc_enable_leak_report_full()</quote></link>.
269         </para>
270         <para>
271           The talloc_set_name() function allocates memory as a child of the
272           pointer.  It is logically equivalent to:
273         </para>
274         <programlisting>talloc_set_name_const(ptr, talloc_asprintf(ptr, fmt, ...));</programlisting>
275         <para>
276           Note that multiple calls to talloc_set_name() will allocate more
277           memory without releasing the name.  All of the memory is released
278           when the ptr is freed using talloc_free().
279         </para>
280     </refsect2>
281     <refsect2><title>void talloc_set_name_const(const void *<emphasis role="italic">ptr</emphasis>, const char *<emphasis role="italic">name</emphasis>);</title>
282         <para>
283           The function talloc_set_name_const() is just like
284           talloc_set_name(), but it takes a string constant, and is much
285           faster.  It is extensively used by the "auto naming" macros, such
286           as talloc_p().
287         </para>
288         <para>
289           This function does not allocate any memory.  It just copies the
290           supplied pointer into the internal representation of the talloc
291           ptr. This means you must not pass a <emphasis
292           role="italic">name</emphasis> pointer to memory that will
293           disappear before <emphasis role="italic">ptr</emphasis> is freed
294           with talloc_free().
295         </para>
296     </refsect2>
297     <refsect2><title>void *talloc_named(const void *<emphasis role="italic">ctx</emphasis>, size_t <emphasis role="italic">size</emphasis>, const char *<emphasis role="italic">fmt</emphasis>, ...);</title>
298         <para>
299           The talloc_named() function creates a named talloc pointer.  It
300           is equivalent to:
301         </para>
302         <programlisting>ptr = talloc_size(ctx, size);
303 talloc_set_name(ptr, fmt, ....);</programlisting>
304     </refsect2>
305     <refsect2><title>void *talloc_named_const(const void *<emphasis role="italic">ctx</emphasis>, size_t <emphasis role="italic">size</emphasis>, const char *<emphasis role="italic">name</emphasis>);</title>
306         <para>
307           This is equivalent to:
308         </para>
309         <programlisting>ptr = talloc_size(ctx, size);
310 talloc_set_name_const(ptr, name);</programlisting>
311     </refsect2>
312     <refsect2><title>const char *talloc_get_name(const void *<emphasis role="italic">ptr</emphasis>);</title>
313         <para>
314           This returns the current name for the given talloc pointer,
315           <emphasis role="italic">ptr</emphasis>. See <link
316           linkend="talloc_set_name"><quote>talloc_set_name()</quote></link>
317           for details.
318         </para>
319     </refsect2>
320     <refsect2><title>void *talloc_init(const char *<emphasis role="italic">fmt</emphasis>, ...);</title>
321         <para>
322           This function creates a zero length named talloc context as a top
323           level context.  It is equivalent to:
324         </para>
325         <programlisting>talloc_named(NULL, 0, fmt, ...);</programlisting>
326     </refsect2>
327     <refsect2><title>void *talloc_new(void *<emphasis role="italic">ctx</emphasis>);</title>
328         <para>
329           This is a utility macro that creates a new memory context hanging
330           off an exiting context, automatically naming it "talloc_new:
331           __location__" where __location__ is the source line it is called
332           from.  It is particularly useful for creating a new temporary
333           working context.
334         </para>
335     </refsect2>
336     <refsect2><title>(<emphasis role="italic">type</emphasis> *)talloc_realloc(const void *<emphasis role="italic">ctx</emphasis>, void *<emphasis role="italic">ptr</emphasis>, <emphasis role="italic">type</emphasis>, <emphasis role="italic">count</emphasis>);</title>
337         <para>
338           The talloc_realloc() macro changes the size of a talloc pointer. 
339           It has the following equivalences:
340         </para>
341         <programlisting>talloc_realloc(ctx, NULL, type, 1) ==> talloc(ctx, type);
342 talloc_realloc(ctx, ptr, type, 0)  ==> talloc_free(ptr);</programlisting>
343         <para>
344           The <emphasis role="italic">ctx</emphasis> argument is only used
345           if <emphasis role="italic">ptr</emphasis> is not NULL, otherwise
346           it is ignored.
347         </para>
348         <para>
349           talloc_realloc() returns the new pointer, or NULL on failure. 
350           The call will fail either due to a lack of memory, or because the
351           pointer has more than one parent (see <link
352           linkend="talloc_reference"><quote>talloc_reference()</quote></link>).
353         </para>
354     </refsect2>
355     <refsect2><title>void *talloc_realloc_size(const void *ctx, void *ptr, size_t size);</title>
356         <para>
357           the talloc_realloc_size() function is useful when the type is not
358           known so the type-safe talloc_realloc() cannot be used.
359         </para>
360     </refsect2>
361     <refsect2><title>void *talloc_steal(const void *<emphasis role="italic">new_ctx</emphasis>, const void *<emphasis role="italic">ptr</emphasis>);</title>
362         <para>
363           The talloc_steal() function changes the parent context of a
364           talloc pointer.  It is typically used when the context that the
365           pointer is currently a child of is going to be freed and you wish
366           to keep the memory for a longer time.
367         </para>
368         <para>
369           The talloc_steal() function returns the pointer that you pass it.
370            It does not have any failure modes.
371         </para>
372         <para>
373           NOTE: It is possible to produce loops in the parent/child
374           relationship if you are not careful with talloc_steal().  No
375           guarantees are provided as to your sanity or the safety of your
376           data if you do this.
377         </para>
378     </refsect2>
379     <refsect2><title>size_t talloc_total_size(const void *<emphasis role="italic">ptr</emphasis>);</title>
380         <para>
381           The talloc_total_size() function returns the total size in bytes
382           used by this pointer and all child pointers.  Mostly useful for
383           debugging.
384         </para>
385         <para>
386           Passing NULL is allowed, but it will only give a meaningful
387           result if talloc_enable_leak_report() or
388           talloc_enable_leak_report_full() has been called.
389         </para>
390     </refsect2>
391     <refsect2><title>size_t talloc_total_blocks(const void *<emphasis role="italic">ptr</emphasis>);</title>
392         <para>
393           The talloc_total_blocks() function returns the total memory block
394           count used by this pointer and all child pointers.  Mostly useful
395           for debugging.
396         </para>
397         <para>
398           Passing NULL is allowed, but it will only give a meaningful
399           result if talloc_enable_leak_report() or
400           talloc_enable_leak_report_full() has been called.
401         </para>
402     </refsect2>
403     <refsect2 id="talloc_report"><title>void talloc_report(const void *ptr, FILE *f);</title>
404         <para>
405           The talloc_report() function prints a summary report of all
406           memory used by <emphasis role="italic">ptr</emphasis>.  One line
407           of report is printed for each immediate child of ptr, showing the
408           total memory and number of blocks used by that child.
409         </para>
410         <para>
411           You can pass NULL for the pointer, in which case a report is
412           printed for the top level memory context, but only if
413           talloc_enable_leak_report() or talloc_enable_leak_report_full()
414           has been called.
415         </para>
416     </refsect2>
417     <refsect2 id="talloc_report_full"><title>void talloc_report_full(const void *<emphasis role="italic">ptr</emphasis>, FILE *<emphasis role="italic">f</emphasis>);</title>
418         <para>
419           This provides a more detailed report than talloc_report().  It
420           will recursively print the entire tree of memory referenced by
421           the pointer. References in the tree are shown by giving the name
422           of the pointer that is referenced.
423         </para>
424         <para>
425           You can pass NULL for the pointer, in which case a report is
426           printed for the top level memory context, but only if
427           talloc_enable_leak_report() or talloc_enable_leak_report_full()
428           has been called.
429         </para>
430     </refsect2>
431     <refsect2 id="talloc_enable_leak_report"><title>void talloc_enable_leak_report(void);</title>
432         <para>
433           This enables calling of talloc_report(NULL, stderr) when the
434           program exits.  In Samba4 this is enabled by using the
435           --leak-report command line option.
436         </para>
437         <para>
438           For it to be useful, this function must be called before any
439           other talloc function as it establishes a "null context" that
440           acts as the top of the tree.  If you don't call this function
441           first then passing NULL to talloc_report() or
442           talloc_report_full() won't give you the full tree printout.
443         </para>
444         <para>
445           Here is a typical talloc report:
446         </para>
447         <screen format="linespecific">talloc report on 'null_context' (total 267 bytes in 15 blocks)
448 libcli/auth/spnego_parse.c:55  contains   31 bytes in   2 blocks
449 libcli/auth/spnego_parse.c:55  contains   31 bytes in   2 blocks
450 iconv(UTF8,CP850)              contains   42 bytes in   2 blocks
451 libcli/auth/spnego_parse.c:55  contains   31 bytes in   2 blocks
452 iconv(CP850,UTF8)              contains   42 bytes in   2 blocks
453 iconv(UTF8,UTF-16LE)           contains   45 bytes in   2 blocks
454 iconv(UTF-16LE,UTF8)           contains   45 bytes in   2 blocks
455       </screen>
456     </refsect2>
457     <refsect2 id="talloc_enable_leak_report_full"><title>void talloc_enable_leak_report_full(void);</title>
458         <para>
459           This enables calling of talloc_report_full(NULL, stderr) when the
460           program exits.  In Samba4 this is enabled by using the
461           --leak-report-full command line option.
462         </para>
463         <para>
464           For it to be useful, this function must be called before any
465           other talloc function as it establishes a "null context" that
466           acts as the top of the tree.  If you don't call this function
467           first then passing NULL to talloc_report() or
468           talloc_report_full() won't give you the full tree printout.
469         </para>
470         <para>
471           Here is a typical full report:
472         </para>
473         <screen format="linespecific">full talloc report on 'root' (total 18 bytes in 8 blocks)
474 p1               contains     18 bytes in   7 blocks (ref 0)
475     r1               contains     13 bytes in   2 blocks (ref 0)
476         reference to: p2
477     p2               contains      1 bytes in   1 blocks (ref 1)
478     x3               contains      1 bytes in   1 blocks (ref 0)
479     x2               contains      1 bytes in   1 blocks (ref 0)
480     x1               contains      1 bytes in   1 blocks (ref 0)
481       </screen>
482     </refsect2>
483     <refsect2><title>(<emphasis role="italic">type</emphasis> *)talloc_zero(const void *<emphasis role="italic">ctx</emphasis>, <emphasis role="italic">type</emphasis>);</title>
484         <para>
485           The talloc_zero() macro is equivalent to:
486         </para>
487         <programlisting>ptr = talloc(ctx, type);
488 if (ptr) memset(ptr, 0, sizeof(type));</programlisting>
489     </refsect2>
490     <refsect2><title>void *talloc_zero_size(const void *<emphasis role="italic">ctx</emphasis>, size_t <emphasis role="italic">size</emphasis>)</title>
491         <para>
492           The talloc_zero_size() function is useful when you don't have a
493           known type.
494         </para>
495     </refsect2>
496     <refsect2><title>void *talloc_memdup(const void *<emphasis role="italic">ctx</emphasis>, const void *<emphasis role="italic">p</emphasis>, size_t size);</title>
497         <para>
498           The talloc_memdup() function is equivalent to:
499         </para>
500         <programlisting>ptr = talloc_size(ctx, size);
501 if (ptr) memcpy(ptr, p, size);</programlisting>
502     </refsect2>
503     <refsect2><title>char *talloc_strdup(const void *<emphasis role="italic">ctx</emphasis>, const char *<emphasis role="italic">p</emphasis>);</title>
504         <para>
505           The talloc_strdup() function is equivalent to:
506         </para>
507         <programlisting>ptr = talloc_size(ctx, strlen(p)+1);
508 if (ptr) memcpy(ptr, p, strlen(p)+1);</programlisting>
509         <para>
510           This function sets the name of the new pointer to the passed
511           string. This is equivalent to:
512         </para>
513         <programlisting>talloc_set_name_const(ptr, ptr)</programlisting>
514     </refsect2>
515     <refsect2><title>char *talloc_strndup(const void *<emphasis role="italic">t</emphasis>, const char *<emphasis role="italic">p</emphasis>, size_t <emphasis role="italic">n</emphasis>);</title>
516         <para>
517           The talloc_strndup() function is the talloc equivalent of the C
518           library function strndup(3).
519         </para>
520         <para>
521           This function sets the name of the new pointer to the passed
522           string. This is equivalent to:
523         </para>
524         <programlisting>talloc_set_name_const(ptr, ptr)</programlisting>
525     </refsect2>
526     <refsect2><title>char *talloc_vasprintf(const void *<emphasis role="italic">t</emphasis>, const char *<emphasis role="italic">fmt</emphasis>, va_list <emphasis role="italic">ap</emphasis>);</title>
527         <para>
528           The talloc_vasprintf() function is the talloc equivalent of the C
529           library function vasprintf(3).
530         </para>
531     </refsect2>
532     <refsect2><title>char *talloc_asprintf(const void *<emphasis role="italic">t</emphasis>, const char *<emphasis role="italic">fmt</emphasis>, ...);</title>
533         <para>
534           The talloc_asprintf() function is the talloc equivalent of the C
535           library function asprintf(3).
536         </para>
537         <para>
538           This function sets the name of the new pointer to the passed
539           string. This is equivalent to:
540         </para>
541         <programlisting>talloc_set_name_const(ptr, ptr)</programlisting>
542     </refsect2>
543     <refsect2><title>char *talloc_asprintf_append(char *s, const char *fmt, ...);</title>
544         <para>
545           The talloc_asprintf_append() function appends the given formatted
546           string to the given string.
547         </para>
548     </refsect2>
549     <refsect2><title>(type *)talloc_array(const void *ctx, type, uint_t count);</title>
550         <para>
551           The talloc_array() macro is equivalent to:
552         </para>
553         <programlisting>(type *)talloc_size(ctx, sizeof(type) * count);</programlisting>
554         <para>
555           except that it provides integer overflow protection for the
556           multiply, returning NULL if the multiply overflows.
557         </para>
558     </refsect2>
559     <refsect2><title>void *talloc_array_size(const void *ctx, size_t size, uint_t count);</title>
560         <para>
561           The talloc_array_size() function is useful when the type is not
562           known. It operates in the same way as talloc_array(), but takes a
563           size instead of a type.
564         </para>
565     </refsect2>
566     <refsect2><title>(typeof(ptr)) talloc_array_ptrtype(const void *ctx, ptr, uint_t count);</title>
567         <para>
568           The talloc_ptrtype() macro should be used when you have a pointer to an array
569           and want to allocate memory of an array to point at with this pointer. When compiling
570           with gcc >= 3 it is typesafe. Note this is a wrapper of talloc_array_size()
571           and talloc_get_name() will return the current location in the source file.
572           and not the type.
573         </para>
574     </refsect2>
575     <refsect2><title>void *talloc_realloc_fn(const void *ctx, void *ptr, size_t size)</title>
576         <para>
577           This is a non-macro version of talloc_realloc(), which is useful
578           as libraries sometimes want a realloc function pointer.  A
579           realloc(3) implementation encapsulates the functionality of
580           malloc(3), free(3) and realloc(3) in one call, which is why it is
581           useful to be able to pass around a single function pointer.
582         </para>
583     </refsect2>
584     <refsect2><title>void *talloc_autofree_context(void);</title>
585         <para>
586           This is a handy utility function that returns a talloc context
587           which will be automatically freed on program exit.  This can be
588           used to reduce the noise in memory leak reports.
589         </para>
590     </refsect2>
591     <refsect2><title>void *talloc_check_name(const void *ptr, const char *name);</title>
592         <para>
593           This function checks if a pointer has the specified <emphasis
594           role="italic">name</emphasis>.  If it does then the pointer is
595           returned.  It it doesn't then NULL is returned.
596         </para>
597     </refsect2>
598     <refsect2><title>(type *)talloc_get_type(const void *ptr, type);</title>
599         <para>
600           This macro allows you to do type checking on talloc pointers.  It
601           is particularly useful for void* private pointers.  It is
602           equivalent to this:
603         </para>
604         <programlisting>(type *)talloc_check_name(ptr, #type)</programlisting>
605     </refsect2>
606     <refsect2><title>talloc_set_type(const void *ptr, type);</title>
607         <para>
608           This macro allows you to force the name of a pointer to be a
609           particular <emphasis>type</emphasis>.  This can be
610           used in conjunction with talloc_get_type() to do type checking on
611           void* pointers.
612         </para>
613         <para>
614           It is equivalent to this:
615         </para>
616         <programlisting>talloc_set_name_const(ptr, #type)</programlisting>
617     </refsect2>
618   </refsect1>
619   <refsect1><title>PERFORMANCE</title>
620     <para>
621       All the additional features of talloc(3) over malloc(3) do come at a
622       price.  We have a simple performance test in Samba4 that measures
623       talloc() versus malloc() performance, and it seems that talloc() is
624       about 10% slower than malloc() on my x86 Debian Linux box.  For
625       Samba, the great reduction in code complexity that we get by using
626       talloc makes this worthwhile, especially as the total overhead of
627       talloc/malloc in Samba is already quite small.
628     </para>
629   </refsect1>
630   <refsect1><title>SEE ALSO</title>
631     <para>
632       malloc(3), strndup(3), vasprintf(3), asprintf(3), 
633       <ulink url="http://talloc.samba.org/"/>
634     </para>
635   </refsect1>
636   <refsect1><title>COPYRIGHT/LICENSE</title>
637     <para>
638       Copyright (C) Andrew Tridgell 2004
639     </para>
640     <para>
641       This program is free software; you can redistribute it and/or modify
642       it under the terms of the GNU General Public License as published by
643       the Free Software Foundation; either version 2 of the License, or (at
644       your option) any later version.
645     </para>
646     <para>
647       This program is distributed in the hope that it will be useful, but
648       WITHOUT ANY WARRANTY; without even the implied warranty of
649       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
650       General Public License for more details.
651     </para>
652     <para>
653       You should have received a copy of the GNU General Public License
654       along with this program; if not, write to the Free Software
655       Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
656     </para>
657   </refsect1>
658 </refentry>