X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Ftal%2Ftal.c;h=79476772c585564b7e0840f215b59d09844723f1;hp=350b34be9d902ee2ae531cdf04bbe531cc2c7943;hb=8f8c8b8804110b09c98f44b439d14303cc36542d;hpb=0f6d854ab9d85ac7e4487ff3eee464be6bb528aa diff --git a/ccan/tal/tal.c b/ccan/tal/tal.c index 350b34be..79476772 100644 --- a/ccan/tal/tal.c +++ b/ccan/tal/tal.c @@ -3,9 +3,9 @@ #include #include #include +#include #include #include -#include #include #include #include @@ -13,11 +13,14 @@ //#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, + LENGTH = 0x00515300 }; struct tal_hdr { @@ -37,16 +40,25 @@ 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 len; +}; + +struct notifier { + struct prop_hdr hdr; /* NOTIFIER */ + enum tal_notify_type types; + union { + void (*notifyfn)(tal_t *, enum tal_notify_type, void *); + void (*destroy)(tal_t *); /* If NOTIFY_IS_DESTRUCTOR set */ + } u; +}; + static struct { struct tal_hdr hdr; struct children c; @@ -64,6 +76,8 @@ 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; +/* Count on non-destrutor notifiers; often stays zero. */ +static size_t notifiers = 0; static inline void COLD call_error(const char *msg) { @@ -85,26 +99,20 @@ 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) +void tal_cleanup(void) { struct tal_hdr *i; - while ((i = list_top(&null_parent.c.children, struct tal_hdr, list))) + while ((i = list_top(&null_parent.c.children, struct tal_hdr, list))) { list_del(&i->list); + memset(i, 0, sizeof(*i)); + } /* Cleanup any taken pointers. */ take_cleanup(); } -/* For allocation failures inside ccan/take */ -static void take_alloc_failed(const void *p) -{ - tal_free(p); -} - /* We carefully start all real properties with a zero byte. */ static bool is_literal(const struct prop_hdr *prop) { @@ -154,11 +162,11 @@ static struct tal_hdr *to_tal_hdr(const void *ctx) t = (struct tal_hdr *)((char *)ctx - sizeof(struct tal_hdr)); check_bounds(t); - if (t->prop && !is_literal(t->prop)) - check_bounds(t->prop); check_bounds(ignore_destroying_bit(t->parent_child)); check_bounds(t->list.next); check_bounds(t->list.prev); + if (t->prop && !is_literal(t->prop)) + check_bounds(t->prop); return t; } @@ -169,9 +177,9 @@ static struct tal_hdr *to_tal_hdr_or_null(const void *ctx) return to_tal_hdr(ctx); } -static void *from_tal_hdr(struct tal_hdr *hdr) +static void *from_tal_hdr(const struct tal_hdr *hdr) { - return hdr + 1; + return (void *)(hdr + 1); } #ifdef TAL_DEBUG @@ -194,17 +202,32 @@ static struct tal_hdr *debug_tal(struct tal_hdr *tal) } #endif -static void *allocate(size_t size) +static void notify(const struct tal_hdr *ctx, + enum tal_notify_type type, const void *info) { - void *ret; + const struct prop_hdr *p; - /* Don't hand silly sizes to malloc. */ - if (size >> (CHAR_BIT*sizeof(size) - 1)) { - call_error("allocation size overflow"); - return NULL; + for (p = ctx->prop; p; p = p->next) { + struct notifier *n; + + if (is_literal(p)) + break; + if (p->type != NOTIFIER) + continue; + n = (struct notifier *)p; + 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); + } } +} - ret = allocfn(size); +static void *allocate(size_t size) +{ + void *ret = allocfn(size); if (!ret) call_error("allocation failed"); else @@ -247,17 +270,46 @@ static void init_property(struct prop_hdr *hdr, parent->prop = hdr; } -static struct destructor *add_destructor_property(struct tal_hdr *t, - void (*destroy)(void *)) +static struct notifier *add_notifier_property(struct tal_hdr *t, + enum tal_notify_type types, + void (*fn)(void *, + enum tal_notify_type, + void *)) { - struct destructor *prop = allocate(sizeof(*prop)); + struct notifier *prop = allocate(sizeof(*prop)); if (prop) { - init_property(&prop->hdr, t, DESTRUCTOR); - prop->destroy = destroy; + init_property(&prop->hdr, t, NOTIFIER); + prop->types = types; + prop->u.notifyfn = fn; } return prop; } +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; + + for (p = (struct prop_hdr **)&t->prop; *p; p = &(*p)->next) { + struct notifier *n; + + 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; + } + } + return 0; +} + static struct name *add_name_property(struct tal_hdr *t, const char *name) { struct name *prop; @@ -287,11 +339,6 @@ static bool add_child(struct tal_hdr *parent, struct tal_hdr *child) struct children *children = find_property(parent, CHILDREN); if (!children) { - if (unlikely(!initialized)) { - atexit(tal_cleanup); - take_allocfail(take_alloc_failed); - initialized = true; - } children = add_child_property(parent, child); if (!children) return false; @@ -301,7 +348,7 @@ static bool add_child(struct tal_hdr *parent, struct tal_hdr *child) return true; } -static void del_tree(struct tal_hdr *t) +static void del_tree(struct tal_hdr *t, const tal_t *orig) { struct prop_hdr **prop, *p, *next; @@ -311,13 +358,8 @@ static void del_tree(struct tal_hdr *t) 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); /* Now free children and groups. */ prop = find_property_ptr(t, CHILDREN); @@ -327,44 +369,106 @@ static void del_tree(struct tal_hdr *t) while ((i = list_top(&c->children, struct tal_hdr, list))) { list_del(&i->list); - del_tree(i); + del_tree(i, orig); } } /* Finally free our properties. */ for (p = t->prop; p && !is_literal(p); p = next) { next = p->next; - freefn(p); + /* LENGTH is appended, so don't free separately! */ + if (p->type != LENGTH) + freefn(p); } freefn(t); } -void *tal_alloc_(const tal_t *ctx, size_t size, bool clear, const char *label) +static size_t extra_for_length(size_t size) { + size_t extra; + const size_t align = ALIGNOF(struct length); + + /* Round up size, and add tailer. */ + extra = ((size + align-1) & ~(align-1)) - size; + extra += sizeof(struct length); + return extra; +} + +void *tal_alloc_(const tal_t *ctx, size_t size, + bool clear, bool add_length, const char *label) +{ + size_t req_size = size; struct tal_hdr *child, *parent = debug_tal(to_tal_hdr_or_null(ctx)); +#ifdef CCAN_TAL_DEBUG + /* Always record length if debugging. */ + add_length = true; +#endif + if (add_length) + size += extra_for_length(size); + child = allocate(sizeof(struct tal_hdr) + size); if (!child) return NULL; if (clear) - memset(from_tal_hdr(child), 0, size); + memset(from_tal_hdr(child), 0, req_size); child->prop = (void *)label; + + if (add_length) { + struct length *lprop; + lprop = (struct length *)((char *)(child+1) + size) - 1; + init_property(&lprop->hdr, child, LENGTH); + lprop->len = req_size; + } if (!add_child(parent, child)) { freefn(child); return NULL; } debug_tal(parent); + 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) +{ + const size_t extra = sizeof(struct tal_hdr) + sizeof(struct length)*2; + + /* Multiplication wrap */ + if (count && unlikely(*size * count / *size != count)) + goto overflow; + + *size *= count; + + /* Make sure we don't wrap adding header/tailer. */ + if (*size + extra < extra) + 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_length, const char *label) +{ + if (!adjust_size(&size, count)) + return NULL; + + return tal_alloc_(ctx, size, clear, add_length, label); +} + void *tal_free(const tal_t *ctx) { if (ctx) { struct tal_hdr *t; int saved_errno = errno; t = debug_tal(to_tal_hdr(ctx)); + if (notifiers) + notify(ignore_destroying_bit(t->parent_child)->parent, + TAL_NOTIFY_DEL_CHILD, ctx); list_del(&t->list); - del_tree(t); + del_tree(t, ctx); errno = saved_errno; } return NULL; @@ -390,13 +494,65 @@ void *tal_steal_(const tal_t *new_parent, const tal_t *ctx) return NULL; } debug_tal(newpar); + 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_notifier_property(t, TAL_NOTIFY_FREE|NOTIFY_IS_DESTRUCTOR, + (void *)destroy); +} + +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)); + struct notifier *n; + + assert(types); + assert((types & ~(TAL_NOTIFY_FREE | TAL_NOTIFY_STEAL | TAL_NOTIFY_MOVE + | TAL_NOTIFY_RESIZE | TAL_NOTIFY_RENAME + | TAL_NOTIFY_ADD_CHILD | TAL_NOTIFY_DEL_CHILD + | TAL_NOTIFY_ADD_NOTIFIER + | TAL_NOTIFY_DEL_NOTIFIER)) == 0); + + /* Don't call notifier about itself: set types after! */ + n = add_notifier_property(t, 0, callback); + if (unlikely(!n)) + return false; + + if (notifiers) + notify(t, TAL_NOTIFY_ADD_NOTIFIER, callback); + + n->types = types; + if (types != TAL_NOTIFY_FREE) + notifiers++; + return true; +} + +bool tal_del_notifier_(const tal_t *ctx, + void (*callback)(tal_t *, enum tal_notify_type, void *)) { - return add_destructor_property(debug_tal(to_tal_hdr(ctx)), destroy); + struct tal_hdr *t = debug_tal(to_tal_hdr(ctx)); + enum tal_notify_type types; + + types = del_notifier_property(t, callback); + if (types) { + notify(t, TAL_NOTIFY_DEL_NOTIFIER, callback); + if (types != TAL_NOTIFY_FREE) + notifiers--; + return true; + } + return false; +} + +bool tal_del_destructor_(const tal_t *ctx, void (*destroy)(void *me)) +{ + return tal_del_notifier_(ctx, (void *)destroy); } bool tal_set_name_(tal_t *ctx, const char *name, bool literal) @@ -421,11 +577,12 @@ bool tal_set_name_(tal_t *ctx, const char *name, bool literal) /* Append literal. */ for (p = &t->prop; *p && !is_literal(*p); p = &(*p)->next); *p = (struct prop_hdr *)name; - return true; - } - if (!add_name_property(t, name)) + } else if (!add_name_property(t, name)) return false; + debug_tal(t); + if (notifiers) + notify(t, TAL_NOTIFY_RENAME, name); return true; } @@ -442,6 +599,16 @@ const char *tal_name(const tal_t *t) return n->name; } +size_t tal_len(const tal_t *ptr) +{ + struct length *l; + + l = find_property(debug_tal(to_tal_hdr(ptr)), LENGTH); + if (!l) + return 0; + return l->len; +} + /* Start one past first child: make stopping natural in circ. list. */ static struct tal_hdr *first_child(struct tal_hdr *parent) { @@ -464,31 +631,16 @@ tal_t *tal_first(const tal_t *root) return from_tal_hdr(c); } -tal_t *tal_next(const tal_t *root, const tal_t *prev) +tal_t *tal_next(const tal_t *prev) { - struct tal_hdr *c, *t = debug_tal(to_tal_hdr(prev)), *top; - - /* Children? */ - c = first_child(t); - if (c) - return from_tal_hdr(c); - - top = to_tal_hdr_or_null(root); - do { - struct tal_hdr *next; - struct list_node *end; - - end = &ignore_destroying_bit(t->parent_child)->children.n; + struct tal_hdr *next, *prevhdr = debug_tal(to_tal_hdr(prev)); + struct list_head *head; - next = list_entry(t->list.next, struct tal_hdr, list); - if (&next->list != end) - return from_tal_hdr(next); - - /* OK, go back to parent. */ - t = ignore_destroying_bit(t->parent_child)->parent; - } while (t != top); - - return NULL; + head = &ignore_destroying_bit(prevhdr->parent_child)->children; + next = list_next(head, prevhdr, list); + if (!next) + return NULL; + return from_tal_hdr(next); } tal_t *tal_parent(const tal_t *ctx) @@ -504,76 +656,124 @@ 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, bool clear) { struct tal_hdr *old_t, *t; struct children *child; + struct prop_hdr **lenp; + struct length len; + size_t extra = 0; 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)); + lenp = find_property_ptr(old_t, LENGTH); + if (lenp) { + /* Copy here, in case we're shrinking! */ + len = *(struct length *)*lenp; + extra = extra_for_length(size); + } else /* If we don't have an old length, we can't clear! */ + assert(!clear); + + t = resizefn(old_t, sizeof(struct tal_hdr) + size + extra); if (!t) { call_error("Reallocation failure"); return false; } - /* If it didn't move, we're done! */ - if (t == old_t) - return true; - update_bounds(t, size + sizeof(struct tal_hdr)); + /* Copy length to end. */ + if (lenp) { + struct length *new_len; + + /* Clear between old end and new end. */ + if (clear && size > len.len) { + char *old_end = (char *)(t + 1) + len.len; + memset(old_end, 0, size - len.len); + } - /* Fix up linked list pointers. */ - if (list_entry(t->list.next, struct tal_hdr, list) != old_t) + new_len = (struct length *)((char *)(t + 1) + size + + extra - sizeof(len)); + len.len = size; + *new_len = len; + + /* Be careful replacing next ptr; could be old hdr. */ + if (lenp == &old_t->prop) + t->prop = &new_len->hdr; + else + *lenp = &new_len->hdr; + } + + update_bounds(t, sizeof(struct tal_hdr) + size + extra); + + /* If it didn't move, we're done! */ + if (t != old_t) { + /* Fix up linked list pointers. */ t->list.next->prev = t->list.prev->next = &t->list; - /* Fix up child property's parent pointer. */ - child = find_property(t, CHILDREN); - if (child) { - assert(child->parent == old_t); - child->parent = t; + /* Fix up child property's parent pointer. */ + child = find_property(t, CHILDREN); + if (child) { + assert(child->parent == old_t); + child->parent = t; + } + *ctxp = from_tal_hdr(debug_tal(t)); + if (notifiers) + notify(t, TAL_NOTIFY_MOVE, from_tal_hdr(old_t)); } - *ctxp = from_tal_hdr(debug_tal(t)); + if (notifiers) + notify(t, TAL_NOTIFY_RESIZE, (void *)size); + return true; } -char *tal_strdup(const tal_t *ctx, const char *p) +bool tal_expand_(tal_t **ctxp, const void *src, size_t size, size_t count) { - /* We have to let through NULL for take(). */ - return tal_dup(ctx, char, p, p ? strlen(p) + 1: 1, 0); -} + struct length *l; + size_t old_len; + bool ret = false; -char *tal_strndup(const tal_t *ctx, const char *p, size_t n) -{ - size_t len; - char *ret; + l = find_property(debug_tal(to_tal_hdr(*ctxp)), LENGTH); + old_len = l->len; - /* We have to let through NULL for take(). */ - if (likely(p)) { - len = strlen(p); - if (len > n) - len = n; - } else - len = n; + /* Check for additive overflow */ + if (old_len + count * size < old_len) { + call_error("dup size overflow"); + goto out; + } - ret = tal_dup(ctx, char, p, len, 1); - if (ret) - ret[len] = '\0'; + /* Don't point src inside thing we're expanding! */ + assert(src < *ctxp + || (char *)src >= (char *)(*ctxp) + old_len); + + if (!tal_resize_(ctxp, size, old_len/size + count, false)) + goto out; + + memcpy((char *)*ctxp + old_len, src, count * size); + ret = true; + +out: + if (taken(src)) + tal_free(src); 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_length, const char *label) { void *ret; + size_t nbytes = size; + + if (!adjust_size(&nbytes, n)) { + if (taken(p)) + tal_free(p); + return NULL; + } - /* Beware overflow! */ - if (n + extra < n || n + extra + sizeof(struct tal_hdr) < n) { + /* Beware addition overflow! */ + if (n + extra < n) { call_error("dup size overflow"); if (taken(p)) tal_free(p); @@ -583,59 +783,19 @@ 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, false))) 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); - if (ret) - memcpy(ret, p, n); - return ret; -} - -char *tal_asprintf(const tal_t *ctx, const char *fmt, ...) -{ - va_list ap; - char *ret; - - va_start(ap, fmt); - ret = tal_vasprintf(ctx, fmt, ap); - va_end(ap); + ret = tal_alloc_arr_(ctx, size, n + extra, false, add_length, label); + if (ret) + memcpy(ret, p, nbytes); return ret; } -char *tal_vasprintf(const tal_t *ctx, const char *fmt, va_list ap) -{ - size_t max; - char *buf; - int ret; - - if (!fmt && taken(fmt)) - return NULL; - - /* A decent guess to start. */ - max = strlen(fmt) * 2; - buf = tal_arr(ctx, char, max); - while (buf) { - va_list ap2; - - va_copy(ap2, ap); - ret = vsnprintf(buf, max, fmt, ap2); - va_end(ap2); - - if (ret < max) - break; - if (!tal_resize(&buf, max *= 2)) - buf = tal_free(buf); - } - if (taken(fmt)) - tal_free(fmt); - return buf; -} - void tal_set_backend(void *(*alloc_fn)(size_t size), void *(*resize_fn)(void *, size_t size), void (*free_fn)(void *), @@ -662,8 +822,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; @@ -675,14 +836,18 @@ 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->u.notifyfn); + break; + case LENGTH: + l = (struct length *)p; + printf(" LENGTH(%p):len=%zu", p, l->len); + break; default: printf(" **UNKNOWN(%p):%i**", p, p->type); } @@ -730,6 +895,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"); @@ -742,7 +908,6 @@ static bool check_node(struct children *parent_child, if (name) return check_err(t, errorstr, "has extra literal"); - name = (struct name *)p; break; } if (!in_bounds(p)) @@ -756,7 +921,13 @@ 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: if (name)