X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Ftal%2Ftal.h;h=af3943eebafec9b593e15a8fe5c951cc138a2481;hp=efe21bc5eb1c619b1ad74c68b9505a2518279fd7;hb=ba89419ac9074d930eec7ba72c378831c56ed060;hpb=83c75170a2be2e3fa58a139f866e957aa6b82995 diff --git a/ccan/tal/tal.h b/ccan/tal/tal.h index efe21bc5..af3943ee 100644 --- a/ccan/tal/tal.h +++ b/ccan/tal/tal.h @@ -32,7 +32,7 @@ typedef void tal_t; * *p = 1; */ #define tal(ctx, type) \ - ((type *)tal_alloc_((ctx), sizeof(type), false, TAL_LABEL(type, ""))) + ((type *)tal_alloc_((ctx), sizeof(type), false, false, TAL_LABEL(type, ""))) /** * talz - zeroing allocator function @@ -46,7 +46,7 @@ typedef void tal_t; * assert(*p == 0); */ #define talz(ctx, type) \ - ((type *)tal_alloc_((ctx), sizeof(type), true, TAL_LABEL(type, ""))) + ((type *)tal_alloc_((ctx), sizeof(type), true, false, TAL_LABEL(type, ""))) /** * tal_free - free a tal-allocated pointer. @@ -56,7 +56,8 @@ typedef void tal_t; * children (recursively) before finally freeing the memory. It returns * NULL, for convenience. * - * Note: errno is preserved by this call. + * Note: errno is preserved by this call, and also saved and restored + * for any destructors or notifiers. * * Example: * p = tal_free(p); @@ -110,7 +111,22 @@ void *tal_free(const tal_t *p); * tal_resize(&p, 100); */ #define tal_resize(p, count) \ - tal_resize_((void **)(p), sizeof**(p), (count)) + tal_resize_((void **)(p), sizeof**(p), (count), false) + +/** + * tal_resizez - enlarge or reduce a tal_arr[z]; zero out extra. + * @p: A pointer to the tal allocated array to resize. + * @count: the number to allocate. + * + * This returns true on success (and may move *@p), or false on failure. + * If @p has a length property, it is updated on success. + * On expand, new elements are memset to 0 bytes. + * + * Example: + * tal_resizez(&p, 200); + */ +#define tal_resizez(p, count) \ + tal_resize_((void **)(p), sizeof**(p), (count), true) /** * tal_steal - change the parent of a tal-allocated pointer. @@ -179,6 +195,7 @@ enum tal_notify_type { * TAL_NOTIFY_FREE is called when @ptr is freed, either directly or * because an ancestor is freed: @info is the argument to tal_free(). * It is exactly equivalent to a destructor, with more information. + * errno is set to the value it was at the call of tal_free(). * * TAL_NOTIFY_STEAL is called when @ptr's parent changes: @info is the * new parent. @@ -241,13 +258,22 @@ const char *tal_name(const tal_t *ptr); * tal_count - get the count of objects in a tal_arr. * @ptr: The tal allocated object array. * - * Returns 0 if @ptr has no length property, but we aware that that is + * Returns 0 if @ptr has no length property, but be aware that that is * also a valid size! */ -size_t tal_count(const tal_t *ptr); +#define tal_count(p) (tal_len(p) / sizeof(*p)) /** - * tal_first - get the first tal object child. + * tal_len - get the count of bytes in a tal_arr. + * @ptr: The tal allocated object array. + * + * Returns 0 if @ptr has no length property, but be aware that that is + * also a valid size! + */ +size_t tal_len(const tal_t *ptr); + +/** + * tal_first - get the first immediate tal object child. * @root: The tal allocated object to start with, or NULL. * * Returns NULL if there are no children. @@ -255,15 +281,13 @@ size_t tal_count(const tal_t *ptr); tal_t *tal_first(const tal_t *root); /** - * tal_next - get the next tal object child. - * @root: The tal allocated object to start with, or NULL. + * tal_next - get the next immediate tal object child. * @prev: The return value from tal_first or tal_next. * - * Returns NULL if there are no more children. This should be safe to - * call on an altering tree unless @prev is no longer a descendent of - * @root. + * Returns NULL if there are no more immediate children. This should be safe to + * call on an altering tree unless @prev is no longer valid. */ -tal_t *tal_next(const tal_t *root, const tal_t *prev); +tal_t *tal_next(const tal_t *prev); /** * tal_parent - get the parent of a tal object. @@ -274,51 +298,29 @@ tal_t *tal_next(const tal_t *root, const tal_t *prev); tal_t *tal_parent(const tal_t *ctx); /** - * tal_dup - duplicate an array. + * tal_dup - duplicate an object. + * @ctx: The tal allocated object to be parent of the result (may be NULL). + * @type: the type (should match type of @p!) + * @p: the object to copy (or reparented if take()) + */ +#define tal_dup(ctx, type, p) \ + ((type *)tal_dup_((ctx), tal_typechk_(p, type *), \ + sizeof(type), 1, 0, \ + false, TAL_LABEL(type, ""))) + +/** + * tal_dup_arr - duplicate an array. * @ctx: The tal allocated object to be parent of the result (may be NULL). * @type: the type (should match type of @p!) * @p: the array to copy (or resized & reparented if take()) * @n: the number of sizeof(type) entries to copy. * @extra: the number of extra sizeof(type) entries to allocate. */ -#define tal_dup(ctx, type, p, n, extra) \ +#define tal_dup_arr(ctx, type, p, n, extra) \ ((type *)tal_dup_((ctx), tal_typechk_(p, type *), \ sizeof(type), (n), (extra), \ true, TAL_LABEL(type, "[]"))) -/** - * tal_strdup - duplicate a string - * @ctx: NULL, or tal allocated object to be parent. - * @p: the string to copy (can be take()). - */ -char *tal_strdup(const tal_t *ctx, const char *p); - -/** - * tal_strndup - duplicate a limited amount of a string. - * @ctx: NULL, or tal allocated object to be parent. - * @p: the string to copy (can be take()). - * @n: the maximum length to copy. - * - * Always gives a nul-terminated string, with strlen() <= @n. - */ -char *tal_strndup(const tal_t *ctx, const char *p, size_t n); - -/** - * tal_asprintf - allocate a formatted string - * @ctx: NULL, or tal allocated object to be parent. - * @fmt: the printf-style format (can be take()). - */ -char *tal_asprintf(const tal_t *ctx, const char *fmt, ...) PRINTF_FMT(2,3); - -/** - * tal_vasprintf - allocate a formatted string (va_list version) - * @ctx: NULL, or tal allocated object to be parent. - * @fmt: the printf-style format (can be take()). - * @va: the va_list containing the format args. - */ -char *tal_vasprintf(const tal_t *ctx, const char *fmt, va_list ap) - PRINTF_FMT(2,0); - /** * tal_set_backend - set the allocation or error functions to use @@ -338,15 +340,51 @@ void tal_set_backend(void *(*alloc_fn)(size_t size), void (*free_fn)(void *), void (*error_fn)(const char *msg)); +/** + * tal_expand - expand a tal array with contents. + * @a1p: a pointer to the tal array to expand. + * @a2: the second array (can be take()). + * @num2: the number of elements in the second array. + * + * Note that *@a1 and @a2 should be the same type. tal_count(@a1) will + * be increased by @num2. + * + * Example: + * int *arr1 = tal_arrz(NULL, int, 2); + * int arr2[2] = { 1, 3 }; + * + * tal_expand(&arr1, arr2, 2); + * assert(tal_count(arr1) == 4); + * assert(arr1[2] == 1); + * assert(arr1[3] == 3); + */ +#define tal_expand(a1p, a2, num2) \ + tal_expand_((void **)(a1p), (a2), sizeof**(a1p), \ + (num2) + 0*sizeof(*(a1p) == (a2))) /** - * tal_check - set the allocation or error functions to use + * tal_cleanup - remove pointers from NULL node + * + * Internally, tal keeps a list of nodes allocated from @ctx NULL; this + * prevents valgrind from noticing memory leaks. This re-initializes + * that list to empty. + * + * It also calls take_cleanup() for you. + */ +void tal_cleanup(void); + + +/** + * tal_check - sanity check a tal context and its children. * @ctx: a tal context, or NULL. * @errorstr: a string to prepend calls to error_fn, or NULL. * * This sanity-checks a tal tree (unless NDEBUG is defined, in which case * it simply returns true). If errorstr is not null, error_fn is called * when a problem is found, otherwise it is not. + * + * See also: + * tal_set_backend() */ bool tal_check(const tal_t *ctx, const char *errorstr); @@ -396,17 +434,19 @@ bool tal_set_name_(tal_t *ctx, const char *name, bool literal); #define tal_typechk_(ptr, ptype) (ptr) #endif -void *tal_alloc_(const tal_t *ctx, size_t bytes, bool clear, const char *label); +void *tal_alloc_(const tal_t *ctx, size_t bytes, bool clear, + bool add_length, const char *label); void *tal_alloc_arr_(const tal_t *ctx, size_t bytes, size_t count, bool clear, - bool add_count, const char *label); + bool add_length, const char *label); void *tal_dup_(const tal_t *ctx, const void *p, size_t size, - size_t n, size_t extra, bool add_count, + size_t n, size_t extra, bool add_length, const char *label); tal_t *tal_steal_(const tal_t *new_parent, const tal_t *t); -bool tal_resize_(tal_t **ctxp, size_t size, size_t count); +bool tal_resize_(tal_t **ctxp, size_t size, size_t count, bool clear); +bool tal_expand_(tal_t **ctxp, const void *src, size_t size, size_t count); bool tal_add_destructor_(const tal_t *ctx, void (*destroy)(void *me)); bool tal_del_destructor_(const tal_t *ctx, void (*destroy)(void *me));