]> git.ozlabs.org Git - ccan/blobdiff - ccan/tal/tal.c
tal: add tal_count() and length properties for arrays.
[ccan] / ccan / tal / tal.c
index 9b84c6e17bdf9b94856157d54bbab4f648981406..c78185be01aa12715a0499088974ab8f561ccee6 100644 (file)
 
 //#define TAL_DEBUG 1
 
+#define NOTIFY_IS_DESTRUCTOR 512
+
 /* 32-bit type field, first byte 0 in either endianness. */
 enum prop_type {
        CHILDREN = 0x00c1d500,
-       DESTRUCTOR = 0x00de5700,
        NAME = 0x00111100,
-       NOTIFIER = 0x00071f00
+       NOTIFIER = 0x00071f00,
+       LENGTH = 0x00515300
 };
 
 struct tal_hdr {
@@ -38,20 +40,23 @@ struct children {
        struct list_head children; /* Head of siblings. */
 };
 
-struct destructor {
-       struct prop_hdr hdr; /* DESTRUCTOR */
-       void (*destroy)(void *me);
-};
-
 struct name {
        struct prop_hdr hdr; /* NAME */
        char name[];
 };
 
+struct length {
+       struct prop_hdr hdr; /* LENGTH */
+       size_t count;
+};
+
 struct notifier {
        struct prop_hdr hdr; /* NOTIFIER */
        enum tal_notify_type types;
-       void (*notifyfn)(tal_t *, enum tal_notify_type, void *);
+       union {
+               void (*notifyfn)(tal_t *, enum tal_notify_type, void *);
+               void (*destroy)(tal_t *); /* If NOTIFY_IS_DESTRUCTOR set */
+       } u;
 };
 
 static struct {
@@ -71,6 +76,9 @@ static void *(*allocfn)(size_t size) = malloc;
 static void *(*resizefn)(void *, size_t size) = realloc;
 static void (*freefn)(void *) = free;
 static void (*errorfn)(const char *msg) = (void *)abort;
+static bool initialized = false;
+/* Count on non-destrutor notifiers; often stays zero. */
+static size_t notifiers = 0;
 
 static inline void COLD call_error(const char *msg)
 {
@@ -92,8 +100,6 @@ static struct children *ignore_destroying_bit(struct children *parent_child)
        return (void *)((size_t)parent_child & ~(size_t)1);
 }
 
-static bool initialized = false;
-
 /* This means valgrind can see leaks. */
 static void tal_cleanup(void)
 {
@@ -214,22 +220,19 @@ static void notify(const struct tal_hdr *ctx,
                 if (p->type != NOTIFIER)
                        continue;
                n = (struct notifier *)p;
-               if (n->types & type)
-                       n->notifyfn(from_tal_hdr(ctx), type, (void *)info);
+               if (n->types & type) {
+                       if (n->types & NOTIFY_IS_DESTRUCTOR)
+                               n->u.destroy(from_tal_hdr(ctx));
+                       else
+                               n->u.notifyfn(from_tal_hdr(ctx), type,
+                                             (void *)info);
+               }
        }
 }
 
 static void *allocate(size_t size)
 {
-       void *ret;
-
-       /* Don't hand silly sizes to malloc. */
-       if (size >> (CHAR_BIT*sizeof(size) - 1)) {
-               call_error("allocation size overflow");
-               return NULL;
-       }
-
-       ret = allocfn(size);
+       void *ret = allocfn(size);
        if (!ret)
                call_error("allocation failed");
        else
@@ -272,39 +275,6 @@ static void init_property(struct prop_hdr *hdr,
        parent->prop = hdr;
 }
 
-static struct destructor *add_destructor_property(struct tal_hdr *t,
-                                                 void (*destroy)(void *))
-{
-       struct destructor *prop = allocate(sizeof(*prop));
-       if (prop) {
-               init_property(&prop->hdr, t, DESTRUCTOR);
-               prop->destroy = destroy;
-       }
-       return prop;
-}
-
-static bool del_destructor_property(struct tal_hdr *t,
-                                   void (*destroy)(void *))
-{
-        struct prop_hdr **p;
-
-        for (p = (struct prop_hdr **)&t->prop; *p; p = &(*p)->next) {
-               struct destructor *d;
-
-                if (is_literal(*p))
-                       break;
-                if ((*p)->type != DESTRUCTOR)
-                       continue;
-               d = (struct destructor *)*p;
-               if (d->destroy == destroy) {
-                       *p = (*p)->next;
-                       freefn(d);
-                       return true;
-               }
-        }
-        return false;
-}
-
 static struct notifier *add_notifier_property(struct tal_hdr *t,
                                              enum tal_notify_type types,
                                              void (*fn)(void *,
@@ -315,14 +285,15 @@ static struct notifier *add_notifier_property(struct tal_hdr *t,
        if (prop) {
                init_property(&prop->hdr, t, NOTIFIER);
                prop->types = types;
-               prop->notifyfn = fn;
+               prop->u.notifyfn = fn;
        }
        return prop;
 }
 
-static bool del_notifier_property(struct tal_hdr *t,
-                                 void (*fn)(tal_t *,
-                                            enum tal_notify_type, void *))
+static enum tal_notify_type del_notifier_property(struct tal_hdr *t,
+                                                 void (*fn)(tal_t *,
+                                                            enum tal_notify_type,
+                                                            void *))
 {
         struct prop_hdr **p;
 
@@ -334,13 +305,14 @@ static bool del_notifier_property(struct tal_hdr *t,
                 if ((*p)->type != NOTIFIER)
                        continue;
                n = (struct notifier *)*p;
-               if (n->notifyfn == fn) {
+               if (n->u.notifyfn == fn) {
+                       enum tal_notify_type types = n->types;
                        *p = (*p)->next;
                        freefn(n);
-                       return true;
+                       return types & ~NOTIFY_IS_DESTRUCTOR;
                }
         }
-        return false;
+        return 0;
 }
 
 static struct name *add_name_property(struct tal_hdr *t, const char *name)
@@ -355,6 +327,18 @@ static struct name *add_name_property(struct tal_hdr *t, const char *name)
        return prop;
 }
 
+static struct length *add_length_property(struct tal_hdr *t, size_t count)
+{
+       struct length *prop;
+
+       prop = allocate(sizeof(*prop));
+       if (prop) {
+               init_property(&prop->hdr, t, LENGTH);
+               prop->count = count;
+       }
+       return prop;
+}
+
 static struct children *add_child_property(struct tal_hdr *parent,
                                           struct tal_hdr *child)
 {
@@ -396,14 +380,6 @@ static void del_tree(struct tal_hdr *t, const tal_t *orig)
 
         set_destroying_bit(&t->parent_child);
 
-        /* Carefully call destructors, removing as we go. */
-        while ((prop = find_property_ptr(t, DESTRUCTOR))) {
-               struct destructor *d = (struct destructor *)*prop;
-                d->destroy(from_tal_hdr(t));
-                *prop = d->hdr.next;
-               freefn(d);
-        }
-
        /* Call free notifiers. */
        notify(t, TAL_NOTIFY_FREE, (tal_t *)orig);
 
@@ -442,18 +418,53 @@ void *tal_alloc_(const tal_t *ctx, size_t size, bool clear, const char *label)
                return NULL;
        }
        debug_tal(parent);
-       notify(parent, TAL_NOTIFY_ADD_CHILD, from_tal_hdr(debug_tal(child)));
+       if (notifiers)
+               notify(parent, TAL_NOTIFY_ADD_CHILD, from_tal_hdr(child));
        return from_tal_hdr(debug_tal(child));
 }
 
+static bool adjust_size(size_t *size, size_t count)
+{
+       /* Multiplication wrap */
+        if (count && unlikely(*size * count / *size != count))
+               goto overflow;
+
+        *size *= count;
+
+        /* Make sure we don't wrap adding header. */
+        if (*size + sizeof(struct tal_hdr) < sizeof(struct tal_hdr))
+               goto overflow;
+       return true;
+overflow:
+       call_error("allocation size overflow");
+       return false;
+}
+
+void *tal_alloc_arr_(const tal_t *ctx, size_t size, size_t count, bool clear,
+                    bool add_count, const char *label)
+{
+       void *ret;
+
+       if (!adjust_size(&size, count))
+               return NULL;
+
+       ret = tal_alloc_(ctx, size, clear, label);
+       if (likely(ret) && add_count) {
+               if (unlikely(!add_length_property(to_tal_hdr(ret), count)))
+                       ret = tal_free(ret);
+       }
+       return ret;
+}
+
 void *tal_free(const tal_t *ctx)
 {
         if (ctx) {
                struct tal_hdr *t;
                int saved_errno = errno;
                t = debug_tal(to_tal_hdr(ctx));
-               notify(ignore_destroying_bit(t->parent_child)->parent,
-                      TAL_NOTIFY_DEL_CHILD, ctx);
+               if (notifiers)
+                       notify(ignore_destroying_bit(t->parent_child)->parent,
+                              TAL_NOTIFY_DEL_CHILD, ctx);
                list_del(&t->list);
                del_tree(t, ctx);
                errno = saved_errno;
@@ -481,18 +492,20 @@ void *tal_steal_(const tal_t *new_parent, const tal_t *ctx)
                        return NULL;
                }
                debug_tal(newpar);
-               notify(t, TAL_NOTIFY_STEAL, new_parent);
+               if (notifiers)
+                       notify(t, TAL_NOTIFY_STEAL, new_parent);
         }
         return (void *)ctx;
 }
 
-bool tal_add_destructor_(tal_t *ctx, void (*destroy)(void *me))
+bool tal_add_destructor_(const tal_t *ctx, void (*destroy)(void *me))
 {
        tal_t *t = debug_tal(to_tal_hdr(ctx));
-        return add_destructor_property(t, destroy);
+       return add_notifier_property(t, TAL_NOTIFY_FREE|NOTIFY_IS_DESTRUCTOR,
+                                    (void *)destroy);
 }
 
-bool tal_add_notifier_(tal_t *ctx, enum tal_notify_type types,
+bool tal_add_notifier_(const tal_t *ctx, enum tal_notify_type types,
                       void (*callback)(tal_t *, enum tal_notify_type, void *))
 {
        tal_t *t = debug_tal(to_tal_hdr(ctx));
@@ -510,27 +523,34 @@ bool tal_add_notifier_(tal_t *ctx, enum tal_notify_type types,
        if (unlikely(!n))
                return false;
 
-       notify(t, TAL_NOTIFY_ADD_NOTIFIER, callback);
+       if (notifiers)
+               notify(t, TAL_NOTIFY_ADD_NOTIFIER, callback);
+
        n->types = types;
+       if (types != TAL_NOTIFY_FREE)
+               notifiers++;
        return true;
 }
 
-bool tal_del_notifier_(tal_t *ctx,
+bool tal_del_notifier_(const tal_t *ctx,
                       void (*callback)(tal_t *, enum tal_notify_type, void *))
 {
        struct tal_hdr *t = debug_tal(to_tal_hdr(ctx));
-       bool ret;
+       enum tal_notify_type types;
 
-        ret = del_notifier_property(t, callback);
-       if (ret)
+        types = del_notifier_property(t, callback);
+       if (types) {
                notify(t, TAL_NOTIFY_DEL_NOTIFIER, callback);
-       return ret;
+               if (types != TAL_NOTIFY_FREE)
+                       notifiers--;
+               return true;
+       }
+       return false;
 }
 
-bool tal_del_destructor_(tal_t *ctx, void (*destroy)(void *me))
+bool tal_del_destructor_(const tal_t *ctx, void (*destroy)(void *me))
 {
-       struct tal_hdr *t = debug_tal(to_tal_hdr(ctx));
-        return del_destructor_property(t, destroy);
+       return tal_del_notifier_(ctx, (void *)destroy);
 }
 
 bool tal_set_name_(tal_t *ctx, const char *name, bool literal)
@@ -559,7 +579,8 @@ bool tal_set_name_(tal_t *ctx, const char *name, bool literal)
                return false;
 
        debug_tal(t);
-       notify(t, TAL_NOTIFY_RENAME, name);
+       if (notifiers)
+               notify(t, TAL_NOTIFY_RENAME, name);
        return true;
 }
 
@@ -576,6 +597,16 @@ const char *tal_name(const tal_t *t)
        return n->name;
 }
 
+size_t tal_count(const tal_t *ptr)
+{
+       struct length *l;
+
+       l = find_property(debug_tal(to_tal_hdr(ptr)), LENGTH);
+       if (!l)
+               return 0;
+       return l->count;
+}
+
 /* Start one past first child: make stopping natural in circ. list. */
 static struct tal_hdr *first_child(struct tal_hdr *parent)
 {
@@ -638,18 +669,16 @@ tal_t *tal_parent(const tal_t *ctx)
         return from_tal_hdr(ignore_destroying_bit(t->parent_child)->parent);
 }
 
-bool tal_resize_(tal_t **ctxp, size_t size)
+bool tal_resize_(tal_t **ctxp, size_t size, size_t count)
 {
         struct tal_hdr *old_t, *t;
         struct children *child;
+       struct length *len;
 
         old_t = debug_tal(to_tal_hdr(*ctxp));
 
-       /* Don't hand silly sizes to realloc. */
-       if (size >> (CHAR_BIT*sizeof(size) - 1)) {
-               call_error("Reallocation size overflow");
+       if (!adjust_size(&size, count))
                return false;
-       }
 
         t = resizefn(old_t, size + sizeof(struct tal_hdr));
        if (!t) {
@@ -672,9 +701,14 @@ bool tal_resize_(tal_t **ctxp, size_t size)
                        child->parent = t;
                }
                *ctxp = from_tal_hdr(debug_tal(t));
-               notify(t, TAL_NOTIFY_MOVE, from_tal_hdr(old_t));
+               if (notifiers)
+                       notify(t, TAL_NOTIFY_MOVE, from_tal_hdr(old_t));
        }
-       notify(t, TAL_NOTIFY_RESIZE, (void *)size);
+       len = find_property(t, LENGTH);
+       if (len)
+               len->count = count;
+       if (notifiers)
+               notify(t, TAL_NOTIFY_RESIZE, (void *)size);
 
        return true;
 }
@@ -682,7 +716,8 @@ bool tal_resize_(tal_t **ctxp, size_t size)
 char *tal_strdup(const tal_t *ctx, const char *p)
 {
        /* We have to let through NULL for take(). */
-       return tal_dup(ctx, char, p, p ? strlen(p) + 1: 1, 0);
+       return tal_dup_(ctx, p, 1, p ? strlen(p) + 1: 1, 0, false,
+                       TAL_LABEL(char, "[]"));
 }
 
 char *tal_strndup(const tal_t *ctx, const char *p, size_t n)
@@ -698,19 +733,27 @@ char *tal_strndup(const tal_t *ctx, const char *p, size_t n)
        } else
                len = n;
 
-       ret = tal_dup(ctx, char, p, len, 1);
+       ret = tal_dup_(ctx, p, 1, len, 1, false, TAL_LABEL(char, "[]"));
        if (ret)
                ret[len] = '\0';
        return ret;
 }
 
-void *tal_dup_(const tal_t *ctx, const void *p, size_t n, size_t extra,
+void *tal_dup_(const tal_t *ctx, const void *p, size_t size,
+              size_t n, size_t extra, bool add_count,
               const char *label)
 {
        void *ret;
+       size_t nbytes = size;
 
-       /* Beware overflow! */
-       if (n + extra < n || n + extra + sizeof(struct tal_hdr) < n) {
+       if (!adjust_size(&nbytes, n)) {
+               if (taken(p))
+                       tal_free(p);
+               return NULL;
+       }
+
+       /* Beware addition overflow! */
+       if (n + extra < n) {
                call_error("dup size overflow");
                if (taken(p))
                        tal_free(p);
@@ -720,15 +763,16 @@ void *tal_dup_(const tal_t *ctx, const void *p, size_t n, size_t extra,
        if (taken(p)) {
                if (unlikely(!p))
                        return NULL;
-               if (unlikely(!tal_resize_((void **)&p, n + extra)))
+               if (unlikely(!tal_resize_((void **)&p, size, n + extra)))
                        return tal_free(p);
                if (unlikely(!tal_steal(ctx, p)))
                        return tal_free(p);
                return (void *)p;
        }
-       ret = tal_alloc_(ctx, n + extra, false, label);
+
+       ret = tal_alloc_arr_(ctx, size, n + extra, false, add_count, label);
        if (ret)
-               memcpy(ret, p, n);
+               memcpy(ret, p, nbytes);
        return ret;
 }
 
@@ -799,9 +843,9 @@ static void dump_node(unsigned int indent, const struct tal_hdr *t)
        printf("%p", t);
         for (p = t->prop; p; p = p->next) {
                struct children *c;
-               struct destructor *d;
                struct name *n;
                struct notifier *no;
+               struct length *l;
                 if (is_literal(p)) {
                        printf(" \"%s\"", (const char *)p);
                        break;
@@ -813,17 +857,17 @@ static void dump_node(unsigned int indent, const struct tal_hdr *t)
                               p, c->parent,
                               c->children.n.prev, c->children.n.next);
                        break;
-               case DESTRUCTOR:
-                       d = (struct destructor *)p;
-                       printf(" DESTRUCTOR(%p):fn=%p", p, d->destroy);
-                       break;
                case NAME:
                        n = (struct name *)p;
                        printf(" NAME(%p):%s", p, n->name);
                        break;
                case NOTIFIER:
                        no = (struct notifier *)p;
-                       printf(" NOTIFIER(%p):fn=%p", p, no->notifyfn);
+                       printf(" NOTIFIER(%p):fn=%p", p, no->u.notifyfn);
+                       break;
+               case LENGTH:
+                       l = (struct length *)p;
+                       printf(" LENGTH(%p):count=%zu", p, l->count);
                        break;
                default:
                        printf(" **UNKNOWN(%p):%i**", p, p->type);
@@ -872,6 +916,7 @@ static bool check_node(struct children *parent_child,
        struct prop_hdr *p;
        struct name *name = NULL;
        struct children *children = NULL;
+       struct length *length = NULL;
 
        if (!in_bounds(t))
                return check_err(t, errorstr, "invalid pointer");
@@ -898,7 +943,12 @@ static bool check_node(struct children *parent_child,
                                                 "has two child nodes");
                        children = (struct children *)p;
                        break;
-               case DESTRUCTOR:
+               case LENGTH:
+                       if (length)
+                               return check_err(t, errorstr,
+                                                "has two lengths");
+                       length = (struct length *)p;
+                       break;
                case NOTIFIER:
                        break;
                case NAME: