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