a3a1549153fe4f42636b116d33162c774982df46
[ccan] / ccan / tal / tal.h
1 /* Licensed under BSD-MIT - see LICENSE file for details */
2 #ifndef CCAN_TAL_H
3 #define CCAN_TAL_H
4 #include "config.h"
5 #include <ccan/compiler/compiler.h>
6 #include <ccan/likely/likely.h>
7 #include <ccan/typesafe_cb/typesafe_cb.h>
8 #include <ccan/str/str.h>
9 #include <ccan/take/take.h>
10 #include <stdlib.h>
11 #include <stdbool.h>
12 #include <stdarg.h>
13
14 /**
15  * tal_t - convenient alias for void to mark tal pointers.
16  *
17  * Since any pointer can be a tal-allocated pointer, it's often
18  * useful to use this typedef to mark them explicitly.
19  */
20 typedef void tal_t;
21
22 /**
23  * tal - basic allocator function
24  * @ctx: NULL, or tal allocated object to be parent.
25  * @type: the type to allocate.
26  *
27  * Allocates a specific type, with a given parent context.  The name
28  * of the object is a string of the type, but if CCAN_TAL_DEBUG is
29  * defined it also contains the file and line which allocated it.
30  *
31  * tal_count() of the return will be 1.
32  *
33  * Example:
34  *      int *p = tal(NULL, int);
35  *      *p = 1;
36  */
37 #define tal(ctx, type)                                                  \
38         tal_label(ctx, type, TAL_LABEL(type, ""))
39
40 /**
41  * talz - zeroing allocator function
42  * @ctx: NULL, or tal allocated object to be parent.
43  * @type: the type to allocate.
44  *
45  * Equivalent to tal() followed by memset() to zero.
46  *
47  * Example:
48  *      p = talz(NULL, int);
49  *      assert(*p == 0);
50  */
51 #define talz(ctx, type)                                                 \
52         talz_label(ctx, type, TAL_LABEL(type, ""))
53
54 /**
55  * tal_free - free a tal-allocated pointer.
56  * @p: NULL, or tal allocated object to free.
57  *
58  * This calls the destructors for p (if any), then does the same for all its
59  * children (recursively) before finally freeing the memory.  It returns
60  * NULL, for convenience.
61  *
62  * Note: errno is preserved by this call, and also saved and restored
63  * for any destructors or notifiers.
64  *
65  * Example:
66  *      p = tal_free(p);
67  */
68 void *tal_free(const tal_t *p);
69
70 /**
71  * tal_arr - allocate an array of objects.
72  * @ctx: NULL, or tal allocated object to be parent.
73  * @type: the type to allocate.
74  * @count: the number to allocate.
75  *
76  * tal_count() of the returned pointer will be @count.
77  *
78  * Example:
79  *      p = tal_arr(NULL, int, 2);
80  *      p[0] = 0;
81  *      p[1] = 1;
82  */
83 #define tal_arr(ctx, type, count)                                       \
84         tal_arr_label(ctx, type, count, TAL_LABEL(type, "[]"))
85
86 /**
87  * tal_arrz - allocate an array of zeroed objects.
88  * @ctx: NULL, or tal allocated object to be parent.
89  * @type: the type to allocate.
90  * @count: the number to allocate.
91  *
92  * Equivalent to tal_arr() followed by memset() to zero.
93  *
94  * Example:
95  *      p = tal_arrz(NULL, int, 2);
96  *      assert(p[0] == 0 && p[1] == 0);
97  */
98 #define tal_arrz(ctx, type, count) \
99         tal_arrz_label(ctx, type, count, TAL_LABEL(type, "[]"))
100
101 /**
102  * tal_resize - enlarge or reduce a tal object.
103  * @p: A pointer to the tal allocated array to resize.
104  * @count: the number to allocate.
105  *
106  * This returns true on success (and may move *@p), or false on failure.
107  * On success, tal_count() of *@p will be @count.
108  *
109  * Note: if *p is take(), it will still be take() upon return, even if it
110  * has been moved.
111  *
112  * Example:
113  *      tal_resize(&p, 100);
114  */
115 #define tal_resize(p, count) \
116         tal_resize_((void **)(p), sizeof**(p), (count), false)
117
118 /**
119  * tal_resizez - enlarge or reduce a tal object; zero out extra.
120  * @p: A pointer to the tal allocated array to resize.
121  * @count: the number to allocate.
122  *
123  * This returns true on success (and may move *@p), or false on failure.
124  *
125  * Example:
126  *      tal_resizez(&p, 200);
127  */
128 #define tal_resizez(p, count) \
129         tal_resize_((void **)(p), sizeof**(p), (count), true)
130
131 /**
132  * tal_steal - change the parent of a tal-allocated pointer.
133  * @ctx: The new parent.
134  * @ptr: The tal allocated object to move, or NULL.
135  *
136  * This may need to perform an allocation, in which case it may fail; thus
137  * it can return NULL, otherwise returns @ptr.  If @ptr is NULL, this function does
138  * nothing.
139  */
140 #if HAVE_STATEMENT_EXPR
141 /* Weird macro avoids gcc's 'warning: value computed is not used'. */
142 #define tal_steal(ctx, ptr) \
143         ({ (tal_typeof(ptr) tal_steal_((ctx),(ptr))); })
144 #else
145 #define tal_steal(ctx, ptr) \
146         (tal_typeof(ptr) tal_steal_((ctx),(ptr)))
147 #endif
148
149 /**
150  * tal_add_destructor - add a callback function when this context is destroyed.
151  * @ptr: The tal allocated object.
152  * @function: the function to call before it's freed.
153  *
154  * This is a more convenient form of tal_add_notifier(@ptr,
155  * TAL_NOTIFY_FREE, ...), in that the function prototype takes only @ptr.
156  *
157  * Note that this can only fail if your allocfn fails and your errorfn returns.
158  */
159 #define tal_add_destructor(ptr, function)                                     \
160         tal_add_destructor_((ptr), typesafe_cb(void, void *, (function), (ptr)))
161
162 /**
163  * tal_del_destructor - remove a destructor callback function.
164  * @ptr: The tal allocated object.
165  * @function: the function to call before it's freed.
166  *
167  * If @function has not been successfully added as a destructor, this returns
168  * false.  Note that if we're inside the destructor call itself, this will
169  * return false.
170  */
171 #define tal_del_destructor(ptr, function)                                     \
172         tal_del_destructor_((ptr), typesafe_cb(void, void *, (function), (ptr)))
173
174 /**
175  * tal_add_destructor2 - add a 2-arg callback function when context is destroyed.
176  * @ptr: The tal allocated object.
177  * @function: the function to call before it's freed.
178  * @arg: the extra argument to the function.
179  *
180  * Sometimes an extra argument is required for a destructor; this
181  * saves the extra argument internally to avoid the caller having to
182  * do an extra allocation.
183  *
184  * Note that this can only fail if your allocfn fails and your errorfn returns.
185  */
186 #define tal_add_destructor2(ptr, function, arg)                         \
187         tal_add_destructor2_((ptr),                                     \
188                              typesafe_cb_cast(void (*)(tal_t *, void *), \
189                                               void (*)(__typeof__(ptr), \
190                                                        __typeof__(arg)), \
191                                               (function)),              \
192                              (arg))
193
194 /**
195  * tal_del_destructor - remove a destructor callback function.
196  * @ptr: The tal allocated object.
197  * @function: the function to call before it's freed.
198  *
199  * If @function has not been successfully added as a destructor, this returns
200  * false.  Note that if we're inside the destructor call itself, this will
201  * return false.
202  */
203 #define tal_del_destructor(ptr, function)                                     \
204         tal_del_destructor_((ptr), typesafe_cb(void, void *, (function), (ptr)))
205
206 /**
207  * tal_del_destructor2 - remove 2-arg callback function.
208  * @ptr: The tal allocated object.
209  * @function: the function to call before it's freed.
210  * @arg: the extra argument to the function.
211  *
212  * If @function has not been successfully added as a destructor with
213  * @arg, this returns false.
214  */
215 #define tal_del_destructor2(ptr, function, arg)                         \
216         tal_del_destructor2_((ptr),                                     \
217                              typesafe_cb_cast(void (*)(tal_t *, void *), \
218                                               void (*)(__typeof__(ptr), \
219                                                        __typeof__(arg)), \
220                                               (function)),              \
221                              (arg))
222 enum tal_notify_type {
223         TAL_NOTIFY_FREE = 1,
224         TAL_NOTIFY_STEAL = 2,
225         TAL_NOTIFY_MOVE = 4,
226         TAL_NOTIFY_RESIZE = 8,
227         TAL_NOTIFY_RENAME = 16,
228         TAL_NOTIFY_ADD_CHILD = 32,
229         TAL_NOTIFY_DEL_CHILD = 64,
230         TAL_NOTIFY_ADD_NOTIFIER = 128,
231         TAL_NOTIFY_DEL_NOTIFIER = 256
232 };
233
234 /**
235  * tal_add_notifier - add a callback function when this context changes.
236  * @ptr: The tal allocated object, or NULL.
237  * @types: Bitwise OR of the types the callback is interested in.
238  * @callback: the function to call.
239  *
240  * Note that this can only fail if your allocfn fails and your errorfn
241  * returns.  Also note that notifiers are not reliable in the case
242  * where an allocation fails, as they may be called before any
243  * allocation is actually done.
244  *
245  * TAL_NOTIFY_FREE is called when @ptr is freed, either directly or
246  * because an ancestor is freed: @info is the argument to tal_free().
247  * It is exactly equivalent to a destructor, with more information.
248  * errno is set to the value it was at the call of tal_free().
249  *
250  * TAL_NOTIFY_STEAL is called when @ptr's parent changes: @info is the
251  * new parent.
252  *
253  * TAL_NOTIFY_MOVE is called when @ptr is realloced (via tal_resize)
254  * and moved.  In this case, @ptr arg here is the new memory, and
255  * @info is the old pointer.
256  *
257  * TAL_NOTIFY_RESIZE is called when @ptr is realloced via tal_resize:
258  * @info is the new size, in bytes.  If the pointer has moved,
259  * TAL_NOTIFY_MOVE callbacks are called first.
260  *
261  * TAL_NOTIFY_ADD_CHILD/TAL_NOTIFY_DEL_CHILD are called when @ptr is
262  * the context for a tal() allocating call, or a direct child is
263  * tal_free()d: @info is the child.  Note that TAL_NOTIFY_DEL_CHILD is
264  * not called when this context is tal_free()d: TAL_NOTIFY_FREE is
265  * considered sufficient for that case.
266  *
267  * TAL_NOTIFY_ADD_NOTIFIER/TAL_NOTIFIER_DEL_NOTIFIER are called when a
268  * notifier is added or removed (not for this notifier): @info is the
269  * callback.  This is also called for tal_add_destructor and
270  * tal_del_destructor.
271  */
272 #define tal_add_notifier(ptr, types, callback)                          \
273         tal_add_notifier_((ptr), (types),                               \
274                           typesafe_cb_postargs(void, tal_t *, (callback), \
275                                                (ptr),                   \
276                                                enum tal_notify_type, void *))
277
278 /**
279  * tal_del_notifier - remove a notifier callback function.
280  * @ptr: The tal allocated object.
281  * @callback: the function to call.
282  */
283 #define tal_del_notifier(ptr, callback)                                 \
284         tal_del_notifier_((ptr),                                        \
285                           typesafe_cb_postargs(void, void *, (callback), \
286                                                (ptr),                   \
287                                                enum tal_notify_type, void *), \
288                           false, NULL)
289
290 /**
291  * tal_set_name - attach a name to a tal pointer.
292  * @ptr: The tal allocated object.
293  * @name: The name to use.
294  *
295  * The name is copied, unless we're certain it's a string literal.
296  */
297 #define tal_set_name(ptr, name)                               \
298     tal_set_name_((ptr), (name), TAL_IS_LITERAL(name))
299
300 /**
301  * tal_name - get the name for a tal pointer.
302  * @ptr: The tal allocated object.
303  *
304  * Returns NULL if no name has been set.
305  */
306 const char *tal_name(const tal_t *ptr);
307
308 /**
309  * tal_count - get the count of objects in a tal object.
310  * @ptr: The tal allocated object (or NULL)
311  *
312  * Returns 0 if @ptr is NULL.  Note that if the allocation was done as a
313  * different type to @ptr, the result may not match the @count argument
314  * (or implied 1) of that allocation!
315  */
316 #define tal_count(p) (tal_bytelen(p) / sizeof(*p))
317
318 /**
319  * tal_bytelen - get the count of bytes in a tal object.
320  * @ptr: The tal allocated object (or NULL)
321  *
322  * Returns 0 if @ptr is NULL.
323  */
324 size_t tal_bytelen(const tal_t *ptr);
325
326 /**
327  * tal_first - get the first immediate tal object child.
328  * @root: The tal allocated object to start with, or NULL.
329  *
330  * Returns NULL if there are no children.
331  */
332 tal_t *tal_first(const tal_t *root);
333
334 /**
335  * tal_next - get the next immediate tal object child.
336  * @prev: The return value from tal_first or tal_next.
337  *
338  * Returns NULL if there are no more immediate children.  This should be safe to
339  * call on an altering tree unless @prev is no longer valid.
340  */
341 tal_t *tal_next(const tal_t *prev);
342
343 /**
344  * tal_parent - get the parent of a tal object.
345  * @ctx: The tal allocated object.
346  *
347  * Returns the parent, which may be NULL.  Returns NULL if @ctx is NULL.
348  */
349 tal_t *tal_parent(const tal_t *ctx);
350
351 /**
352  * tal_dup - duplicate an object.
353  * @ctx: The tal allocated object to be parent of the result (may be NULL).
354  * @type: the type (should match type of @p!)
355  * @p: the object to copy (or reparented if take())
356  */
357 #define tal_dup(ctx, type, p)                                   \
358         tal_dup_label(ctx, type, p, TAL_LABEL(type, ""))
359
360 /**
361  * tal_dup_arr - duplicate an array.
362  * @ctx: The tal allocated object to be parent of the result (may be NULL).
363  * @type: the type (should match type of @p!)
364  * @p: the array to copy (or resized & reparented if take())
365  * @n: the number of sizeof(type) entries to copy.
366  * @extra: the number of extra sizeof(type) entries to allocate.
367  */
368 #define tal_dup_arr(ctx, type, p, n, extra)                     \
369         tal_dup_arr_label(ctx, type, p, n, extra, TAL_LABEL(type, "[]"))
370
371
372
373 /* Lower-level interfaces, where you want to supply your own label string. */
374 #define tal_label(ctx, type, label)                                             \
375         ((type *)tal_alloc_((ctx), sizeof(type), false, label))
376 #define talz_label(ctx, type, label)                                            \
377         ((type *)tal_alloc_((ctx), sizeof(type), true, label))
378 #define tal_arr_label(ctx, type, count, label)                                  \
379         ((type *)tal_alloc_arr_((ctx), sizeof(type), (count), false, label))
380 #define tal_arrz_label(ctx, type, count, label)                                 \
381         ((type *)tal_alloc_arr_((ctx), sizeof(type), (count), true, label))
382 #define tal_dup_label(ctx, type, p, label)                      \
383         ((type *)tal_dup_((ctx), tal_typechk_(p, type *),       \
384                           sizeof(type), 1, 0,                   \
385                           label))
386 #define tal_dup_arr_label(ctx, type, p, n, extra, label)        \
387         ((type *)tal_dup_((ctx), tal_typechk_(p, type *),       \
388                           sizeof(type), (n), (extra),           \
389                           label))
390
391 /**
392  * tal_set_backend - set the allocation or error functions to use
393  * @alloc_fn: allocator or NULL (default is malloc)
394  * @resize_fn: re-allocator or NULL (default is realloc)
395  * @free_fn: free function or NULL (default is free)
396  * @error_fn: called on errors or NULL (default is abort)
397  *
398  * The defaults are set up so tal functions never return NULL, but you
399  * can override erorr_fn to change that.  error_fn can return, and is
400  * called if alloc_fn or resize_fn fail.
401  *
402  * If any parameter is NULL, that function is unchanged.
403  */
404 void tal_set_backend(void *(*alloc_fn)(size_t size),
405                      void *(*resize_fn)(void *, size_t size),
406                      void (*free_fn)(void *),
407                      void (*error_fn)(const char *msg));
408
409 /**
410  * tal_expand - expand a tal array with contents.
411  * @a1p: a pointer to the tal array to expand.
412  * @a2: the second array (can be take()).
413  * @num2: the number of elements in the second array.
414  *
415  * Note that *@a1 and @a2 should be the same type.  tal_count(@a1) will
416  * be increased by @num2.
417  *
418  * Example:
419  *      int *arr1 = tal_arrz(NULL, int, 2);
420  *      int arr2[2] = { 1, 3 };
421  *
422  *      tal_expand(&arr1, arr2, 2);
423  *      assert(tal_count(arr1) == 4);
424  *      assert(arr1[2] == 1);
425  *      assert(arr1[3] == 3);
426  */
427 #define tal_expand(a1p, a2, num2)                               \
428         tal_expand_((void **)(a1p), (a2), sizeof**(a1p),        \
429                     (num2) + 0*sizeof(*(a1p) == (a2)))
430
431 /**
432  * tal_cleanup - remove pointers from NULL node
433  *
434  * Internally, tal keeps a list of nodes allocated from @ctx NULL; this
435  * prevents valgrind from noticing memory leaks.  This re-initializes
436  * that list to empty.
437  *
438  * It also calls take_cleanup() for you.
439  */
440 void tal_cleanup(void);
441
442
443 /**
444  * tal_check - sanity check a tal context and its children.
445  * @ctx: a tal context, or NULL.
446  * @errorstr: a string to prepend calls to error_fn, or NULL.
447  *
448  * This sanity-checks a tal tree (unless NDEBUG is defined, in which case
449  * it simply returns true).  If errorstr is not null, error_fn is called
450  * when a problem is found, otherwise it is not.
451  *
452  * See also:
453  *      tal_set_backend()
454  */
455 bool tal_check(const tal_t *ctx, const char *errorstr);
456
457 #ifdef CCAN_TAL_DEBUG
458 /**
459  * tal_dump - dump entire tal tree to stderr.
460  *
461  * This is a helper for debugging tal itself, which dumps all the tal internal
462  * state.
463  */
464 void tal_dump(void);
465 #endif
466
467 /* Internal support functions */
468 #ifndef TAL_LABEL
469 #ifdef CCAN_TAL_NO_LABELS
470 #define TAL_LABEL(type, arr) NULL
471 #else
472 #ifdef CCAN_TAL_DEBUG
473 #define TAL_LABEL(type, arr) \
474         __FILE__ ":" stringify(__LINE__) ":" stringify(type) arr
475 #else
476 #define TAL_LABEL(type, arr) stringify(type) arr
477 #endif /* CCAN_TAL_DEBUG */
478 #endif
479 #endif
480
481 #if HAVE_BUILTIN_CONSTANT_P
482 #define TAL_IS_LITERAL(str) __builtin_constant_p(str)
483 #else
484 #define TAL_IS_LITERAL(str) (sizeof(&*(str)) != sizeof(char *))
485 #endif
486
487 bool tal_set_name_(tal_t *ctx, const char *name, bool literal);
488
489 #if HAVE_TYPEOF
490 #define tal_typeof(ptr) (__typeof__(ptr))
491 #if HAVE_STATEMENT_EXPR
492 /* Careful: ptr can be const foo *, ptype is foo *.  Also, ptr could
493  * be an array, eg "hello". */
494 #define tal_typechk_(ptr, ptype) ({ __typeof__((ptr)+0) _p = (ptype)(ptr); _p; })
495 #else
496 #define tal_typechk_(ptr, ptype) (ptr)
497 #endif
498 #else /* !HAVE_TYPEOF */
499 #define tal_typeof(ptr)
500 #define tal_typechk_(ptr, ptype) (ptr)
501 #endif
502
503 void *tal_alloc_(const tal_t *ctx, size_t bytes, bool clear, const char *label);
504 void *tal_alloc_arr_(const tal_t *ctx, size_t bytes, size_t count, bool clear,
505                      const char *label);
506
507 void *tal_dup_(const tal_t *ctx, const void *p TAKES, size_t size,
508                size_t n, size_t extra, const char *label);
509
510 tal_t *tal_steal_(const tal_t *new_parent, const tal_t *t);
511
512 bool tal_resize_(tal_t **ctxp, size_t size, size_t count, bool clear);
513 bool tal_expand_(tal_t **ctxp, const void *src TAKES, size_t size, size_t count);
514
515 bool tal_add_destructor_(const tal_t *ctx, void (*destroy)(void *me));
516 bool tal_add_destructor2_(const tal_t *ctx, void (*destroy)(void *me, void *arg),
517                           void *arg);
518 bool tal_del_destructor_(const tal_t *ctx, void (*destroy)(void *me));
519 bool tal_del_destructor2_(const tal_t *ctx, void (*destroy)(void *me, void *arg),
520                           void *arg);
521
522 bool tal_add_notifier_(const tal_t *ctx, enum tal_notify_type types,
523                        void (*notify)(tal_t *ctx, enum tal_notify_type,
524                                       void *info));
525 bool tal_del_notifier_(const tal_t *ctx,
526                        void (*notify)(tal_t *ctx, enum tal_notify_type,
527                                       void *info),
528                        bool match_extra_arg, void *arg);
529 #endif /* CCAN_TAL_H */