X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Ftal%2Ftal.h;h=42245f68660277c990561502f50b00f94297bcb5;hp=d511e88aa7b637c7dc8d98b1cccf3ad923025c92;hb=d873aaec1339baf45c37db7cbaa2d687656343ba;hpb=0e34459a02e2615f50bac2767c7dce6632470946 diff --git a/ccan/tal/tal.h b/ccan/tal/tal.h index d511e88a..42245f68 100644 --- a/ccan/tal/tal.h +++ b/ccan/tal/tal.h @@ -5,6 +5,7 @@ #include #include #include +#include #include #include #include @@ -22,9 +23,16 @@ typedef void tal_t; * @ctx: NULL, or tal allocated object to be parent. * @type: the type to allocate. * - * Allocates a specific type, with a given parent context. + * Allocates a specific type, with a given parent context. The name + * of the object is a string of the type, but if CCAN_TAL_DEBUG is + * defined it also contains the file and line which allocated it. + * + * Example: + * int *p = tal(NULL, int); + * *p = 1; */ -#define tal(ctx, type) tal_arr((ctx), type, 1) +#define tal(ctx, type) \ + ((type *)tal_alloc_((ctx), sizeof(type), false, TAL_LABEL(type, ""))) /** * talz - zeroing allocator function @@ -32,46 +40,70 @@ typedef void tal_t; * @type: the type to allocate. * * Equivalent to tal() followed by memset() to zero. + * + * Example: + * p = talz(NULL, int); + * assert(*p == 0); */ -#define talz(ctx, type) tal_arrz((ctx), type, 1) +#define talz(ctx, type) \ + ((type *)tal_alloc_((ctx), sizeof(type), true, TAL_LABEL(type, ""))) /** * tal_free - free a tal-allocated pointer. * @p: NULL, or tal allocated object to free. * * This calls the destructors for p (if any), then does the same for all its - * children (recursively) before finally freeing the memory. + * children (recursively) before finally freeing the memory. It returns + * NULL, for convenience. + * + * Note: errno is preserved by this call. + * + * Example: + * p = tal_free(p); */ -void tal_free(const tal_t *p); +void *tal_free(const tal_t *p); /** * tal_arr - allocate an array of objects. * @ctx: NULL, or tal allocated object to be parent. * @type: the type to allocate. * @count: the number to allocate. + * + * Example: + * p = tal_arr(NULL, int, 2); + * p[0] = 0; + * p[1] = 1; */ #define tal_arr(ctx, type, count) \ - ((type *)tal_alloc_((ctx), tal_sizeof_(sizeof(type), (count)), false)) + ((type *)tal_alloc_((ctx), tal_sizeof_(sizeof(type), (count)), false, \ + TAL_LABEL(type, "[]"))) /** * tal_arrz - allocate an array of zeroed objects. * @ctx: NULL, or tal allocated object to be parent. * @type: the type to allocate. * @count: the number to allocate. + * + * Example: + * p = tal_arrz(NULL, int, 2); + * assert(p[0] == 0 && p[1] == 0); */ #define tal_arrz(ctx, type, count) \ - ((type *)tal_alloc_((ctx), tal_sizeof_(sizeof(type), (count)), true)) + ((type *)tal_alloc_((ctx), tal_sizeof_(sizeof(type), (count)), true, \ + TAL_LABEL(type, "[]"))) /** - * tal_resize - enlarge or reduce a tal_arr(z). - * @p: The tal allocated array to resize. + * tal_resize - enlarge or reduce a tal_arr[z]. + * @p: A pointer to the tal allocated array to resize. * @count: the number to allocate. * - * This returns the new pointer, or NULL (and destroys the old one) - * on failure. + * This returns true on success (and may move *@p), or false on failure. + * + * Example: + * tal_resize(&p, 100); */ #define tal_resize(p, count) \ - ((tal_typeof(p) tal_realloc_((p), tal_sizeof_(sizeof(*p), (count))))) + tal_resize_((void **)(p), tal_sizeof_(sizeof**(p), (count))) /** * tal_steal - change the parent of a tal-allocated pointer. @@ -80,10 +112,9 @@ void tal_free(const tal_t *p); * * This may need to perform an allocation, in which case it may fail; thus * it can return NULL, otherwise returns @ptr. - * - * Weird macro avoids gcc's 'warning: value computed is not used'. */ #if HAVE_STATEMENT_EXPR +/* Weird macro avoids gcc's 'warning: value computed is not used'. */ #define tal_steal(ctx, ptr) \ ({ (tal_typeof(ptr) tal_steal_((ctx),(ptr))); }) #else @@ -140,29 +171,35 @@ tal_t *tal_next(const tal_t *root, const tal_t *prev); * tal_parent - get the parent of a tal object. * @ctx: The tal allocated object. * - * Returns the parent, which may be NULL. + * Returns the parent, which may be NULL. Returns NULL if @ctx is NULL. */ tal_t *tal_parent(const tal_t *ctx); /** - * tal_memdup - duplicate memory. - * @ctx: NULL, or tal allocated object to be parent. - * @p: the memory to copy - * @n: the number of bytes. + * tal_dup - 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. */ -void *tal_memdup(const tal_t *ctx, const void *p, size_t n); +#define tal_dup(ctx, type, p, n, extra) \ + ((type *)tal_dup_((ctx), tal_typechk_(p, type *), \ + tal_sizeof_(sizeof(type), (n)), \ + tal_sizeof_(sizeof(type), (extra)), \ + TAL_LABEL(type, "[]"))) /** - * tal_strdup - duplicate a string. + * tal_strdup - duplicate a string * @ctx: NULL, or tal allocated object to be parent. - * @p: the string to copy + * @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 + * @p: the string to copy (can be take()). * @n: the maximum length to copy. * * Always gives a nul-terminated string, with strlen() <= @n. @@ -172,14 +209,14 @@ 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. + * @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. + * @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) @@ -227,6 +264,19 @@ void tal_dump(void); #endif /* Internal support functions */ +#ifndef TAL_LABEL +#ifdef CCAN_TAL_NO_LABELS +#define TAL_LABEL(type, arr) NULL +#else +#ifdef CCAN_TAL_DEBUG +#define TAL_LABEL(type, arr) \ + __FILE__ ":" stringify(__LINE__) ":" stringify(type) arr +#else +#define TAL_LABEL(type, arr) stringify(type) arr +#endif /* CCAN_TAL_DEBUG */ +#endif +#endif + #if HAVE_BUILTIN_CONSTANT_P #define TAL_IS_LITERAL(str) __builtin_constant_p(str) #else @@ -252,15 +302,26 @@ static inline size_t tal_sizeof_(size_t size, size_t count) #if HAVE_TYPEOF #define tal_typeof(ptr) (__typeof__(ptr)) +#if HAVE_STATEMENT_EXPR +/* Careful: ptr can be const foo *, ptype is foo *. Also, ptr could + * be an array, eg "hello". */ +#define tal_typechk_(ptr, ptype) ({ __typeof__((ptr)+0) _p = (ptype)(ptr); _p; }) #else +#define tal_typechk_(ptr, ptype) (ptr) +#endif +#else /* !HAVE_TYPEOF */ #define tal_typeof(ptr) +#define tal_typechk_(ptr, ptype) (ptr) #endif -void *tal_alloc_(const tal_t *ctx, size_t bytes, bool clear); +void *tal_alloc_(const tal_t *ctx, size_t bytes, bool clear, const char *label); + +void *tal_dup_(const tal_t *ctx, const void *p, size_t n, size_t extra, + const char *label); tal_t *tal_steal_(const tal_t *new_parent, const tal_t *t); -void *tal_realloc_(tal_t *ctx, size_t size); +bool tal_resize_(tal_t **ctxp, size_t size); bool tal_add_destructor_(tal_t *ctx, void (*destroy)(void *me));