tal: store length in bytes, not count, and always store if CCAN_TAL_DEBUG.

[ccan] / ccan / tal / tal.h

diff --git a/ccan/tal/tal.h b/ccan/tal/tal.h
index 86b56d35a3c26280a9915216a5443ebef78626e1..bdaa3f67381ee2e93a1fb87c7a3746fe6fa69ac9 100644 (file)
--- 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.
@@ -110,7 +110,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.
@@ -241,13 +256,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!
+ */
+#define tal_count(p) (tal_len(p) / sizeof(*p))
+
+/**
+ * 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_count(const tal_t *ptr);
+size_t tal_len(const tal_t *ptr);
 
 /**
- * tal_first - get the first tal object child.
+ * 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 +279,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 const tal_t *prev);
 
 /**
  * tal_parent - get the parent of a tal object.
@@ -274,14 +296,25 @@ 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, "[]")))
@@ -340,13 +373,16 @@ void tal_cleanup(void);
 
 
 /**
- * tal_check - set the allocation or error functions to use
+ * 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 +432,18 @@ 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));