tal: add del_destructor().
[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 <stdlib.h>
10 #include <stdbool.h>
11 #include <stdarg.h>
12
13 /**
14  * tal_t - convenient alias for void to mark tal pointers.
15  *
16  * Since any pointer can be a tal-allocated pointer, it's often
17  * useful to use this typedef to mark them explicitly.
18  */
19 typedef void tal_t;
20
21 /**
22  * tal - basic allocator function
23  * @ctx: NULL, or tal allocated object to be parent.
24  * @type: the type to allocate.
25  *
26  * Allocates a specific type, with a given parent context.  The name
27  * of the object is a string of the type, but if CCAN_TAL_DEBUG is
28  * defined it also contains the file and line which allocated it.
29  *
30  * Example:
31  *      int *p = tal(NULL, int);
32  *      *p = 1;
33  */
34 #define tal(ctx, type) \
35         ((type *)tal_alloc_((ctx), sizeof(type), false, TAL_LABEL(type, "")))
36
37 /**
38  * talz - zeroing allocator function
39  * @ctx: NULL, or tal allocated object to be parent.
40  * @type: the type to allocate.
41  *
42  * Equivalent to tal() followed by memset() to zero.
43  *
44  * Example:
45  *      p = talz(NULL, int);
46  *      assert(*p == 0);
47  */
48 #define talz(ctx, type) \
49         ((type *)tal_alloc_((ctx), sizeof(type), true, TAL_LABEL(type, "")))
50
51 /**
52  * tal_free - free a tal-allocated pointer.
53  * @p: NULL, or tal allocated object to free.
54  *
55  * This calls the destructors for p (if any), then does the same for all its
56  * children (recursively) before finally freeing the memory.  It returns
57  * NULL, for convenience.
58  *
59  * Note: errno is preserved by this call.
60  *
61  * Example:
62  *      p = tal_free(p);
63  */
64 void *tal_free(const tal_t *p);
65
66 /**
67  * tal_arr - allocate an array of objects.
68  * @ctx: NULL, or tal allocated object to be parent.
69  * @type: the type to allocate.
70  * @count: the number to allocate.
71  *
72  * Example:
73  *      p = tal_arr(NULL, int, 2);
74  *      p[0] = 0;
75  *      p[1] = 1;
76  */
77 #define tal_arr(ctx, type, count) \
78         ((type *)tal_alloc_((ctx), tal_sizeof_(sizeof(type), (count)), false, \
79                             TAL_LABEL(type, "[]")))
80
81 /**
82  * tal_arrz - allocate an array of zeroed objects.
83  * @ctx: NULL, or tal allocated object to be parent.
84  * @type: the type to allocate.
85  * @count: the number to allocate.
86  *
87  * Example:
88  *      p = tal_arrz(NULL, int, 2);
89  *      assert(p[0] == 0 && p[1] == 0);
90  */
91 #define tal_arrz(ctx, type, count) \
92         ((type *)tal_alloc_((ctx), tal_sizeof_(sizeof(type), (count)), true, \
93                             TAL_LABEL(type, "[]")))
94
95 /**
96  * tal_resize - enlarge or reduce a tal_arr[z].
97  * @p: A pointer to the tal allocated array to resize.
98  * @count: the number to allocate.
99  *
100  * This returns true on success (and may move *@p), or false on failure.
101  *
102  * Example:
103  *      tal_resize(&p, 100);
104  */
105 #define tal_resize(p, count) \
106         tal_resize_((void **)(p), tal_sizeof_(sizeof**(p), (count)))
107
108 /**
109  * tal_steal - change the parent of a tal-allocated pointer.
110  * @ctx: The new parent.
111  * @ptr: The tal allocated object to move.
112  *
113  * This may need to perform an allocation, in which case it may fail; thus
114  * it can return NULL, otherwise returns @ptr.
115  */
116 #if HAVE_STATEMENT_EXPR
117 /* Weird macro avoids gcc's 'warning: value computed is not used'. */
118 #define tal_steal(ctx, ptr) \
119         ({ (tal_typeof(ptr) tal_steal_((ctx),(ptr))); })
120 #else
121 #define tal_steal(ctx, ptr) \
122         (tal_typeof(ptr) tal_steal_((ctx),(ptr)))
123 #endif
124
125 /**
126  * tal_add_destructor - add a callback function when this context is destroyed.
127  * @ptr: The tal allocated object.
128  * @function: the function to call before it's freed.
129  */
130 #define tal_add_destructor(ptr, function)                                     \
131         tal_add_destructor_((ptr), typesafe_cb(void, void *, (function), (ptr)))
132
133 /**
134  * tal_del_destructor - remove a destructor callback function.
135  * @ptr: The tal allocated object.
136  * @function: the function to call before it's freed.
137  *
138  * If @function has not been successfully added as a destructor, this returns
139  * false.
140  */
141 #define tal_del_destructor(ptr, function)                                     \
142         tal_del_destructor_((ptr), typesafe_cb(void, void *, (function), (ptr)))
143
144 /**
145  * tal_set_name - attach a name to a tal pointer.
146  * @ptr: The tal allocated object.
147  * @name: The name to use.
148  *
149  * The name is copied, unless we're certain it's a string literal.
150  */
151 #define tal_set_name(ptr, name)                               \
152     tal_set_name_((ptr), (name), TAL_IS_LITERAL(name))
153
154 /**
155  * tal_name - get the name for a tal pointer.
156  * @ptr: The tal allocated object.
157  *
158  * Returns NULL if no name has been set.
159  */
160 const char *tal_name(const tal_t *ptr);
161
162 /**
163  * tal_first - get the first tal object child.
164  * @root: The tal allocated object to start with, or NULL.
165  *
166  * Returns NULL if there are no children.
167  */
168 tal_t *tal_first(const tal_t *root);
169
170 /**
171  * tal_next - get the next tal object child.
172  * @root: The tal allocated object to start with, or NULL.
173  * @prev: The return value from tal_first or tal_next.
174  *
175  * Returns NULL if there are no more children.  This should be safe to
176  * call on an altering tree unless @prev is no longer a descendent of
177  * @root.
178  */
179 tal_t *tal_next(const tal_t *root, const tal_t *prev);
180
181 /**
182  * tal_parent - get the parent of a tal object.
183  * @ctx: The tal allocated object.
184  *
185  * Returns the parent, which may be NULL.  Returns NULL if @ctx is NULL.
186  */
187 tal_t *tal_parent(const tal_t *ctx);
188
189 /**
190  * tal_dup - duplicate an array.
191  * @ctx: The tal allocated object to be parent of the result (may be NULL).
192  * @type: the type (should match type of @p!)
193  * @p: the array to copy (or resized & reparented if take())
194  * @n: the number of sizeof(type) entries to copy.
195  * @extra: the number of extra sizeof(type) entries to allocate.
196  */
197 #define tal_dup(ctx, type, p, n, extra)                         \
198         ((type *)tal_dup_((ctx), tal_typechk_(p, type *),       \
199                           tal_sizeof_(sizeof(type), (n)),       \
200                           tal_sizeof_(sizeof(type), (extra)),   \
201                           TAL_LABEL(type, "[]")))
202
203 /**
204  * tal_strdup - duplicate a string
205  * @ctx: NULL, or tal allocated object to be parent.
206  * @p: the string to copy (can be take()).
207  */
208 char *tal_strdup(const tal_t *ctx, const char *p);
209
210 /**
211  * tal_strndup - duplicate a limited amount of a string.
212  * @ctx: NULL, or tal allocated object to be parent.
213  * @p: the string to copy (can be take()).
214  * @n: the maximum length to copy.
215  *
216  * Always gives a nul-terminated string, with strlen() <= @n.
217  */
218 char *tal_strndup(const tal_t *ctx, const char *p, size_t n);
219
220 /**
221  * tal_asprintf - allocate a formatted string
222  * @ctx: NULL, or tal allocated object to be parent.
223  * @fmt: the printf-style format (can be take()).
224  */
225 char *tal_asprintf(const tal_t *ctx, const char *fmt, ...) PRINTF_FMT(2,3);
226
227 /**
228  * tal_vasprintf - allocate a formatted string (va_list version)
229  * @ctx: NULL, or tal allocated object to be parent.
230  * @fmt: the printf-style format (can be take()).
231  * @va: the va_list containing the format args.
232  */
233 char *tal_vasprintf(const tal_t *ctx, const char *fmt, va_list ap)
234         PRINTF_FMT(2,0);
235
236
237 /**
238  * tal_set_backend - set the allocation or error functions to use
239  * @alloc_fn: allocator or NULL (default is malloc)
240  * @resize_fn: re-allocator or NULL (default is realloc)
241  * @free_fn: free function or NULL (default is free)
242  * @error_fn: called on errors or NULL (default is abort)
243  *
244  * The defaults are set up so tal functions never return NULL, but you
245  * can override erorr_fn to change that.  error_fn can return, and is
246  * called if alloc_fn or resize_fn fail.
247  *
248  * If any parameter is NULL, that function is unchanged.
249  */
250 void tal_set_backend(void *(*alloc_fn)(size_t size),
251                      void *(*resize_fn)(void *, size_t size),
252                      void (*free_fn)(void *),
253                      void (*error_fn)(const char *msg));
254
255
256 /**
257  * tal_check - set the allocation or error functions to use
258  * @ctx: a tal context, or NULL.
259  * @errorstr: a string to prepend calls to error_fn, or NULL.
260  *
261  * This sanity-checks a tal tree (unless NDEBUG is defined, in which case
262  * it simply returns true).  If errorstr is not null, error_fn is called
263  * when a problem is found, otherwise it is not.
264  */
265 bool tal_check(const tal_t *ctx, const char *errorstr);
266
267 #ifdef CCAN_TAL_DEBUG
268 /**
269  * tal_dump - dump entire tal tree.
270  *
271  * This is a helper for debugging tal itself, which dumps all the tal internal
272  * state.
273  */
274 void tal_dump(void);
275 #endif
276
277 /* Internal support functions */
278 #ifndef TAL_LABEL
279 #ifdef CCAN_TAL_NO_LABELS
280 #define TAL_LABEL(type, arr) NULL
281 #else
282 #ifdef CCAN_TAL_DEBUG
283 #define TAL_LABEL(type, arr) \
284         __FILE__ ":" stringify(__LINE__) ":" stringify(type) arr
285 #else
286 #define TAL_LABEL(type, arr) stringify(type) arr
287 #endif /* CCAN_TAL_DEBUG */
288 #endif
289 #endif
290
291 #if HAVE_BUILTIN_CONSTANT_P
292 #define TAL_IS_LITERAL(str) __builtin_constant_p(str)
293 #else
294 #define TAL_IS_LITERAL(str) (sizeof(&*(str)) != sizeof(char *))
295 #endif
296
297 bool tal_set_name_(tal_t *ctx, const char *name, bool literal);
298
299 static inline size_t tal_sizeof_(size_t size, size_t count)
300 {
301         /* Multiplication wrap */
302         if (count && unlikely(size * count / size != count))
303                 return (size_t)-1024;
304
305         size *= count;
306
307         /* Make sure we don't wrap adding header. */
308         if (size > (size_t)-1024)
309                 return (size_t)-1024;
310
311         return size;
312 }
313
314 #if HAVE_TYPEOF
315 #define tal_typeof(ptr) (__typeof__(ptr))
316 #if HAVE_STATEMENT_EXPR
317 /* Careful: ptr can be const foo *, ptype is foo *.  Also, ptr could
318  * be an array, eg "hello". */
319 #define tal_typechk_(ptr, ptype) ({ __typeof__((ptr)+0) _p = (ptype)(ptr); _p; })
320 #else
321 #define tal_typechk_(ptr, ptype) (ptr)
322 #endif
323 #else /* !HAVE_TYPEOF */
324 #define tal_typeof(ptr)
325 #define tal_typechk_(ptr, ptype) (ptr)
326 #endif
327
328 void *tal_alloc_(const tal_t *ctx, size_t bytes, bool clear, const char *label);
329
330 void *tal_dup_(const tal_t *ctx, const void *p, size_t n, size_t extra,
331                const char *label);
332
333 tal_t *tal_steal_(const tal_t *new_parent, const tal_t *t);
334
335 bool tal_resize_(tal_t **ctxp, size_t size);
336
337 bool tal_add_destructor_(tal_t *ctx, void (*destroy)(void *me));
338 bool tal_del_destructor_(tal_t *ctx, void (*destroy)(void *me));
339
340 #endif /* CCAN_TAL_H */