]> git.ozlabs.org Git - ccan/blobdiff - ccan/tal/tal.c
tal: add xor into child_parent pointer.
[ccan] / ccan / tal / tal.c
index 79476772c585564b7e0840f215b59d09844723f1..177e06f4c71301be66737e298be5c9d51c826afa 100644 (file)
@@ -2,18 +2,22 @@
 #include <ccan/tal/tal.h>
 #include <ccan/compiler/compiler.h>
 #include <ccan/list/list.h>
-#include <ccan/take/take.h>
 #include <ccan/alignof/alignof.h>
 #include <assert.h>
 #include <stdio.h>
 #include <stddef.h>
 #include <string.h>
 #include <limits.h>
+#include <stdint.h>
 #include <errno.h>
 
 //#define TAL_DEBUG 1
 
 #define NOTIFY_IS_DESTRUCTOR 512
+#define NOTIFY_EXTRA_ARG 1024
+
+/* This makes our parent_child ptr stand out for to_tal_hdr checks */
+#define TAL_PTR_OBFUSTICATOR ((intptr_t)0x1984200820142016ULL)
 
 /* 32-bit type field, first byte 0 in either endianness. */
 enum prop_type {
@@ -26,7 +30,8 @@ enum prop_type {
 struct tal_hdr {
        struct list_node list;
        struct prop_hdr *prop;
-       struct children *parent_child;
+       /* XOR with TAL_PTR_OBFUSTICATOR */
+       intptr_t parent_child;
 };
 
 struct prop_hdr {
@@ -56,14 +61,23 @@ struct notifier {
        union {
                void (*notifyfn)(tal_t *, enum tal_notify_type, void *);
                void (*destroy)(tal_t *); /* If NOTIFY_IS_DESTRUCTOR set */
+               void (*destroy2)(tal_t *, void *); /* If NOTIFY_EXTRA_ARG */
        } u;
 };
 
+/* Extra arg */
+struct notifier_extra_arg {
+       struct notifier n;
+       void *arg;
+};
+
+#define EXTRA_ARG(n) (((struct notifier_extra_arg *)(n))->arg)
+
 static struct {
        struct tal_hdr hdr;
        struct children c;
 } null_parent = { { { &null_parent.hdr.list, &null_parent.hdr.list },
-                   &null_parent.c.hdr, NULL },
+                   &null_parent.c.hdr, TAL_PTR_OBFUSTICATOR },
                  { { CHILDREN, NULL },
                    &null_parent.hdr,
                    { { &null_parent.c.children.n,
@@ -84,19 +98,19 @@ static inline void COLD call_error(const char *msg)
        errorfn(msg);
 }
 
-static bool get_destroying_bit(struct children *parent_child)
+static bool get_destroying_bit(intptr_t parent_child)
 {
-       return (size_t)parent_child & 1;
+       return parent_child & 1;
 }
 
-static void set_destroying_bit(struct children **parent_child)
+static void set_destroying_bit(intptr_t *parent_child)
 {
-       *parent_child = (void *)((size_t)*parent_child | 1);
+       *parent_child |= 1;
 }
 
-static struct children *ignore_destroying_bit(struct children *parent_child)
+static struct children *ignore_destroying_bit(intptr_t parent_child)
 {
-       return (void *)((size_t)parent_child & ~(size_t)1);
+       return (void *)((parent_child ^ TAL_PTR_OBFUSTICATOR) & ~(intptr_t)1);
 }
 
 /* This means valgrind can see leaks. */
@@ -203,7 +217,8 @@ static struct tal_hdr *debug_tal(struct tal_hdr *tal)
 #endif
 
 static void notify(const struct tal_hdr *ctx,
-                  enum tal_notify_type type, const void *info)
+                  enum tal_notify_type type, const void *info,
+                  int saved_errno)
 {
         const struct prop_hdr *p;
 
@@ -216,9 +231,14 @@ static void notify(const struct tal_hdr *ctx,
                        continue;
                n = (struct notifier *)p;
                if (n->types & type) {
-                       if (n->types & NOTIFY_IS_DESTRUCTOR)
-                               n->u.destroy(from_tal_hdr(ctx));
-                       else
+                       errno = saved_errno;
+                       if (n->types & NOTIFY_IS_DESTRUCTOR) {
+                               if (n->types & NOTIFY_EXTRA_ARG)
+                                       n->u.destroy2(from_tal_hdr(ctx),
+                                                     EXTRA_ARG(n));
+                               else
+                                       n->u.destroy(from_tal_hdr(ctx));
+                       } else
                                n->u.notifyfn(from_tal_hdr(ctx), type,
                                              (void *)info);
                }
@@ -274,13 +294,22 @@ static struct notifier *add_notifier_property(struct tal_hdr *t,
                                              enum tal_notify_type types,
                                              void (*fn)(void *,
                                                         enum tal_notify_type,
-                                                        void *))
+                                                        void *),
+                                             void *extra_arg)
 {
-       struct notifier *prop = allocate(sizeof(*prop));
+       struct notifier *prop;
+
+       if (types & NOTIFY_EXTRA_ARG)
+               prop = allocate(sizeof(struct notifier_extra_arg));
+       else
+               prop = allocate(sizeof(struct notifier));
+
        if (prop) {
                init_property(&prop->hdr, t, NOTIFIER);
                prop->types = types;
                prop->u.notifyfn = fn;
+               if (types & NOTIFY_EXTRA_ARG)
+                       EXTRA_ARG(prop) = extra_arg;
        }
        return prop;
 }
@@ -288,24 +317,33 @@ static struct notifier *add_notifier_property(struct tal_hdr *t,
 static enum tal_notify_type del_notifier_property(struct tal_hdr *t,
                                                  void (*fn)(tal_t *,
                                                             enum tal_notify_type,
-                                                            void *))
+                                                            void *),
+                                                 bool match_extra_arg,
+                                                 void *extra_arg)
 {
         struct prop_hdr **p;
 
         for (p = (struct prop_hdr **)&t->prop; *p; p = &(*p)->next) {
                struct notifier *n;
+               enum tal_notify_type types;
 
                 if (is_literal(*p))
                        break;
                 if ((*p)->type != NOTIFIER)
                        continue;
                n = (struct notifier *)*p;
-               if (n->u.notifyfn == fn) {
-                       enum tal_notify_type types = n->types;
-                       *p = (*p)->next;
-                       freefn(n);
-                       return types & ~NOTIFY_IS_DESTRUCTOR;
-               }
+               if (n->u.notifyfn != fn)
+                       continue;
+
+               types = n->types;
+               if ((types & NOTIFY_EXTRA_ARG)
+                   && match_extra_arg
+                   && extra_arg != EXTRA_ARG(n))
+                       continue;
+
+               *p = (*p)->next;
+               freefn(n);
+               return types & ~(NOTIFY_IS_DESTRUCTOR|NOTIFY_EXTRA_ARG);
         }
         return 0;
 }
@@ -323,7 +361,7 @@ static struct name *add_name_property(struct tal_hdr *t, const char *name)
 }
 
 static struct children *add_child_property(struct tal_hdr *parent,
-                                          struct tal_hdr *child)
+                                          struct tal_hdr *child UNNEEDED)
 {
        struct children *prop = allocate(sizeof(*prop));
        if (prop) {
@@ -344,11 +382,11 @@ static bool add_child(struct tal_hdr *parent, struct tal_hdr *child)
                        return false;
        }
        list_add(&children->children, &child->list);
-       child->parent_child = children;
+       child->parent_child = (intptr_t)children ^ TAL_PTR_OBFUSTICATOR;
        return true;
 }
 
-static void del_tree(struct tal_hdr *t, const tal_t *orig)
+static void del_tree(struct tal_hdr *t, const tal_t *orig, int saved_errno)
 {
        struct prop_hdr **prop, *p, *next;
 
@@ -359,7 +397,7 @@ static void del_tree(struct tal_hdr *t, const tal_t *orig)
         set_destroying_bit(&t->parent_child);
 
        /* Call free notifiers. */
-       notify(t, TAL_NOTIFY_FREE, (tal_t *)orig);
+       notify(t, TAL_NOTIFY_FREE, (tal_t *)orig, saved_errno);
 
        /* Now free children and groups. */
        prop = find_property_ptr(t, CHILDREN);
@@ -369,7 +407,7 @@ static void del_tree(struct tal_hdr *t, const tal_t *orig)
 
                while ((i = list_top(&c->children, struct tal_hdr, list))) {
                        list_del(&i->list);
-                       del_tree(i, orig);
+                       del_tree(i, orig, saved_errno);
                }
        }
 
@@ -426,7 +464,7 @@ void *tal_alloc_(const tal_t *ctx, size_t size,
        }
        debug_tal(parent);
        if (notifiers)
-               notify(parent, TAL_NOTIFY_ADD_CHILD, from_tal_hdr(child));
+               notify(parent, TAL_NOTIFY_ADD_CHILD, from_tal_hdr(child), 0);
        return from_tal_hdr(debug_tal(child));
 }
 
@@ -466,9 +504,9 @@ void *tal_free(const tal_t *ctx)
                t = debug_tal(to_tal_hdr(ctx));
                if (notifiers)
                        notify(ignore_destroying_bit(t->parent_child)->parent,
-                              TAL_NOTIFY_DEL_CHILD, ctx);
+                              TAL_NOTIFY_DEL_CHILD, ctx, saved_errno);
                list_del(&t->list);
-               del_tree(t, ctx);
+               del_tree(t, ctx, saved_errno);
                errno = saved_errno;
        }
        return NULL;
@@ -495,7 +533,7 @@ void *tal_steal_(const tal_t *new_parent, const tal_t *ctx)
                }
                debug_tal(newpar);
                if (notifiers)
-                       notify(t, TAL_NOTIFY_STEAL, new_parent);
+                       notify(t, TAL_NOTIFY_STEAL, new_parent, 0);
         }
         return (void *)ctx;
 }
@@ -504,9 +542,19 @@ bool tal_add_destructor_(const tal_t *ctx, void (*destroy)(void *me))
 {
        tal_t *t = debug_tal(to_tal_hdr(ctx));
        return add_notifier_property(t, TAL_NOTIFY_FREE|NOTIFY_IS_DESTRUCTOR,
-                                    (void *)destroy);
+                                    (void *)destroy, NULL);
+}
+
+bool tal_add_destructor2_(const tal_t *ctx, void (*destroy)(void *me, void *arg),
+                         void *arg)
+{
+       tal_t *t = debug_tal(to_tal_hdr(ctx));
+       return add_notifier_property(t, TAL_NOTIFY_FREE|NOTIFY_IS_DESTRUCTOR
+                                    |NOTIFY_EXTRA_ARG,
+                                    (void *)destroy, arg);
 }
 
+/* We could support notifiers with an extra arg, but we didn't add to API */
 bool tal_add_notifier_(const tal_t *ctx, enum tal_notify_type types,
                       void (*callback)(tal_t *, enum tal_notify_type, void *))
 {
@@ -521,12 +569,12 @@ bool tal_add_notifier_(const tal_t *ctx, enum tal_notify_type types,
                          | TAL_NOTIFY_DEL_NOTIFIER)) == 0);
 
        /* Don't call notifier about itself: set types after! */
-        n = add_notifier_property(t, 0, callback);
+        n = add_notifier_property(t, 0, callback, NULL);
        if (unlikely(!n))
                return false;
 
        if (notifiers)
-               notify(t, TAL_NOTIFY_ADD_NOTIFIER, callback);
+               notify(t, TAL_NOTIFY_ADD_NOTIFIER, callback, 0);
 
        n->types = types;
        if (types != TAL_NOTIFY_FREE)
@@ -535,14 +583,15 @@ bool tal_add_notifier_(const tal_t *ctx, enum tal_notify_type types,
 }
 
 bool tal_del_notifier_(const tal_t *ctx,
-                      void (*callback)(tal_t *, enum tal_notify_type, void *))
+                      void (*callback)(tal_t *, enum tal_notify_type, void *),
+                      bool match_extra_arg, void *extra_arg)
 {
        struct tal_hdr *t = debug_tal(to_tal_hdr(ctx));
        enum tal_notify_type types;
 
-        types = del_notifier_property(t, callback);
+        types = del_notifier_property(t, callback, match_extra_arg, extra_arg);
        if (types) {
-               notify(t, TAL_NOTIFY_DEL_NOTIFIER, callback);
+               notify(t, TAL_NOTIFY_DEL_NOTIFIER, callback, 0);
                if (types != TAL_NOTIFY_FREE)
                        notifiers--;
                return true;
@@ -552,7 +601,13 @@ bool tal_del_notifier_(const tal_t *ctx,
 
 bool tal_del_destructor_(const tal_t *ctx, void (*destroy)(void *me))
 {
-       return tal_del_notifier_(ctx, (void *)destroy);
+       return tal_del_notifier_(ctx, (void *)destroy, false, NULL);
+}
+
+bool tal_del_destructor2_(const tal_t *ctx, void (*destroy)(void *me, void *arg),
+                         void *arg)
+{
+       return tal_del_notifier_(ctx, (void *)destroy, true, arg);
 }
 
 bool tal_set_name_(tal_t *ctx, const char *name, bool literal)
@@ -582,7 +637,7 @@ bool tal_set_name_(tal_t *ctx, const char *name, bool literal)
 
        debug_tal(t);
        if (notifiers)
-               notify(t, TAL_NOTIFY_RENAME, name);
+               notify(t, TAL_NOTIFY_RENAME, name, 0);
        return true;
 }
 
@@ -603,6 +658,9 @@ size_t tal_len(const tal_t *ptr)
 {
        struct length *l;
 
+       if (!ptr)
+               return 0;
+
        l = find_property(debug_tal(to_tal_hdr(ptr)), LENGTH);
        if (!l)
                return 0;
@@ -720,10 +778,10 @@ bool tal_resize_(tal_t **ctxp, size_t size, size_t count, bool clear)
                }
                *ctxp = from_tal_hdr(debug_tal(t));
                if (notifiers)
-                       notify(t, TAL_NOTIFY_MOVE, from_tal_hdr(old_t));
+                       notify(t, TAL_NOTIFY_MOVE, from_tal_hdr(old_t), 0);
        }
        if (notifiers)
-               notify(t, TAL_NOTIFY_RESIZE, (void *)size);
+               notify(t, TAL_NOTIFY_RESIZE, (void *)size, 0);
 
        return true;
 }