Fix typos detected by github.com/client9/misspell
[ccan] / ccan / tal / tal.c
1 /* Licensed under BSD-MIT - see LICENSE file for details */
2 #include <ccan/tal/tal.h>
3 #include <ccan/compiler/compiler.h>
4 #include <ccan/list/list.h>
5 #include <ccan/alignof/alignof.h>
6 #include <assert.h>
7 #include <stdio.h>
8 #include <stddef.h>
9 #include <string.h>
10 #include <limits.h>
11 #include <stdint.h>
12 #include <errno.h>
13
14 //#define TAL_DEBUG 1
15
16 #define NOTIFY_IS_DESTRUCTOR 512
17 #define NOTIFY_EXTRA_ARG 1024
18
19 /* This makes our parent_child ptr stand out for to_tal_hdr checks */
20 #define TAL_PTR_OBFUSTICATOR ((intptr_t)0x1984200820142016ULL)
21
22 /* 32-bit type field, first byte 0 in either endianness. */
23 enum prop_type {
24         CHILDREN = 0x00c1d500,
25         NAME = 0x00111100,
26         NOTIFIER = 0x00071f00,
27 };
28
29 struct tal_hdr {
30         struct list_node list;
31         struct prop_hdr *prop;
32         /* XOR with TAL_PTR_OBFUSTICATOR */
33         intptr_t parent_child;
34         size_t bytelen;
35 };
36
37 struct prop_hdr {
38         enum prop_type type;
39         struct prop_hdr *next;
40 };
41
42 struct children {
43         struct prop_hdr hdr; /* CHILDREN */
44         struct tal_hdr *parent;
45         struct list_head children; /* Head of siblings. */
46 };
47
48 struct name {
49         struct prop_hdr hdr; /* NAME */
50         char name[];
51 };
52
53 struct notifier {
54         struct prop_hdr hdr; /* NOTIFIER */
55         enum tal_notify_type types;
56         union {
57                 void (*notifyfn)(tal_t *, enum tal_notify_type, void *);
58                 void (*destroy)(tal_t *); /* If NOTIFY_IS_DESTRUCTOR set */
59                 void (*destroy2)(tal_t *, void *); /* If NOTIFY_EXTRA_ARG */
60         } u;
61 };
62
63 /* Extra arg */
64 struct notifier_extra_arg {
65         struct notifier n;
66         void *arg;
67 };
68
69 #define EXTRA_ARG(n) (((struct notifier_extra_arg *)(n))->arg)
70
71 static struct {
72         struct tal_hdr hdr;
73         struct children c;
74 } null_parent = { { { &null_parent.hdr.list, &null_parent.hdr.list },
75                     &null_parent.c.hdr, TAL_PTR_OBFUSTICATOR, 0 },
76                   { { CHILDREN, NULL },
77                     &null_parent.hdr,
78                     { { &null_parent.c.children.n,
79                         &null_parent.c.children.n } }
80                   }
81 };
82
83
84 static void *(*allocfn)(size_t size) = malloc;
85 static void *(*resizefn)(void *, size_t size) = realloc;
86 static void (*freefn)(void *) = free;
87 static void (*errorfn)(const char *msg) = (void *)abort;
88 /* Count on non-destrutor notifiers; often stays zero. */
89 static size_t notifiers = 0;
90
91 static inline void COLD call_error(const char *msg)
92 {
93         errorfn(msg);
94 }
95
96 static bool get_destroying_bit(intptr_t parent_child)
97 {
98         return parent_child & 1;
99 }
100
101 static void set_destroying_bit(intptr_t *parent_child)
102 {
103         *parent_child |= 1;
104 }
105
106 static struct children *ignore_destroying_bit(intptr_t parent_child)
107 {
108         return (void *)((parent_child ^ TAL_PTR_OBFUSTICATOR) & ~(intptr_t)1);
109 }
110
111 /* This means valgrind can see leaks. */
112 void tal_cleanup(void)
113 {
114         struct tal_hdr *i;
115
116         while ((i = list_top(&null_parent.c.children, struct tal_hdr, list))) {
117                 list_del(&i->list);
118                 memset(i, 0, sizeof(*i));
119         }
120
121         /* Cleanup any taken pointers. */
122         take_cleanup();
123 }
124
125 /* We carefully start all real properties with a zero byte. */
126 static bool is_literal(const struct prop_hdr *prop)
127 {
128         return ((char *)prop)[0] != 0;
129 }
130
131 #ifndef NDEBUG
132 static const void *bounds_start, *bounds_end;
133
134 static void update_bounds(const void *new, size_t size)
135 {
136         if (unlikely(!bounds_start)) {
137                 bounds_start = new;
138                 bounds_end = (char *)new + size;
139         } else if (new < bounds_start)
140                 bounds_start = new;
141         else if ((char *)new + size > (char *)bounds_end)
142                 bounds_end = (char *)new + size;
143 }
144
145 static bool in_bounds(const void *p)
146 {
147         return !p
148                 || (p >= (void *)&null_parent && p <= (void *)(&null_parent + 1))
149                 || (p >= bounds_start && p <= bounds_end);
150 }
151 #else
152 static void update_bounds(const void *new, size_t size)
153 {
154 }
155
156 static bool in_bounds(const void *p)
157 {
158         return true;
159 }
160 #endif
161
162 static void check_bounds(const void *p)
163 {
164         if (!in_bounds(p))
165                 call_error("Not a valid header");
166 }
167
168 static struct tal_hdr *to_tal_hdr(const void *ctx)
169 {
170         struct tal_hdr *t;
171
172         t = (struct tal_hdr *)((char *)ctx - sizeof(struct tal_hdr));
173         check_bounds(t);
174         check_bounds(ignore_destroying_bit(t->parent_child));
175         check_bounds(t->list.next);
176         check_bounds(t->list.prev);
177         if (t->prop && !is_literal(t->prop))
178                 check_bounds(t->prop);
179         return t;
180 }
181
182 static struct tal_hdr *to_tal_hdr_or_null(const void *ctx)
183 {
184         if (!ctx)
185                 return &null_parent.hdr;
186         return to_tal_hdr(ctx);
187 }
188
189 static void *from_tal_hdr(const struct tal_hdr *hdr)
190 {
191         return (void *)(hdr + 1);
192 }
193
194 #ifdef TAL_DEBUG
195 static void *from_tal_hdr_or_null(struct tal_hdr *hdr)
196 {
197         if (hdr == &null_parent.hdr)
198                 return NULL;
199         return from_tal_hdr(hdr);
200 }
201
202 static struct tal_hdr *debug_tal(struct tal_hdr *tal)
203 {
204         tal_check(from_tal_hdr_or_null(tal), "TAL_DEBUG ");
205         return tal;
206 }
207 #else
208 static struct tal_hdr *debug_tal(struct tal_hdr *tal)
209 {
210         return tal;
211 }
212 #endif
213
214 static void notify(const struct tal_hdr *ctx,
215                    enum tal_notify_type type, const void *info,
216                    int saved_errno)
217 {
218         const struct prop_hdr *p;
219
220         for (p = ctx->prop; p; p = p->next) {
221                 struct notifier *n;
222
223                 if (is_literal(p))
224                         break;
225                 if (p->type != NOTIFIER)
226                         continue;
227                 n = (struct notifier *)p;
228                 if (n->types & type) {
229                         errno = saved_errno;
230                         if (n->types & NOTIFY_IS_DESTRUCTOR) {
231                                 if (n->types & NOTIFY_EXTRA_ARG)
232                                         n->u.destroy2(from_tal_hdr(ctx),
233                                                       EXTRA_ARG(n));
234                                 else
235                                         n->u.destroy(from_tal_hdr(ctx));
236                         } else
237                                 n->u.notifyfn(from_tal_hdr(ctx), type,
238                                               (void *)info);
239                 }
240         }
241 }
242
243 static void *allocate(size_t size)
244 {
245         void *ret = allocfn(size);
246         if (!ret)
247                 call_error("allocation failed");
248         else
249                 update_bounds(ret, size);
250         return ret;
251 }
252
253 static struct prop_hdr **find_property_ptr(const struct tal_hdr *t,
254                                            enum prop_type type)
255 {
256         struct prop_hdr **p;
257
258         for (p = (struct prop_hdr **)&t->prop; *p; p = &(*p)->next) {
259                 if (is_literal(*p)) {
260                         if (type == NAME)
261                                 return p;
262                         break;
263                 }
264                 if ((*p)->type == type)
265                         return p;
266         }
267         return NULL;
268 }
269
270 static void *find_property(const struct tal_hdr *parent, enum prop_type type)
271 {
272         struct prop_hdr **p = find_property_ptr(parent, type);
273
274         if (p)
275                 return *p;
276         return NULL;
277 }
278
279 static void init_property(struct prop_hdr *hdr,
280                           struct tal_hdr *parent,
281                           enum prop_type type)
282 {
283         hdr->type = type;
284         hdr->next = parent->prop;
285         parent->prop = hdr;
286 }
287
288 static struct notifier *add_notifier_property(struct tal_hdr *t,
289                                               enum tal_notify_type types,
290                                               void (*fn)(void *,
291                                                          enum tal_notify_type,
292                                                          void *),
293                                               void *extra_arg)
294 {
295         struct notifier *prop;
296
297         if (types & NOTIFY_EXTRA_ARG)
298                 prop = allocate(sizeof(struct notifier_extra_arg));
299         else
300                 prop = allocate(sizeof(struct notifier));
301
302         if (prop) {
303                 init_property(&prop->hdr, t, NOTIFIER);
304                 prop->types = types;
305                 prop->u.notifyfn = fn;
306                 if (types & NOTIFY_EXTRA_ARG)
307                         EXTRA_ARG(prop) = extra_arg;
308         }
309         return prop;
310 }
311
312 static enum tal_notify_type del_notifier_property(struct tal_hdr *t,
313                                                   void (*fn)(tal_t *,
314                                                              enum tal_notify_type,
315                                                              void *),
316                                                   bool match_extra_arg,
317                                                   void *extra_arg)
318 {
319         struct prop_hdr **p;
320
321         for (p = (struct prop_hdr **)&t->prop; *p; p = &(*p)->next) {
322                 struct notifier *n;
323                 enum tal_notify_type types;
324
325                 if (is_literal(*p))
326                         break;
327                 if ((*p)->type != NOTIFIER)
328                         continue;
329                 n = (struct notifier *)*p;
330                 if (n->u.notifyfn != fn)
331                         continue;
332
333                 types = n->types;
334                 if ((types & NOTIFY_EXTRA_ARG)
335                     && match_extra_arg
336                     && extra_arg != EXTRA_ARG(n))
337                         continue;
338
339                 *p = (*p)->next;
340                 freefn(n);
341                 return types & ~(NOTIFY_IS_DESTRUCTOR|NOTIFY_EXTRA_ARG);
342         }
343         return 0;
344 }
345
346 static struct name *add_name_property(struct tal_hdr *t, const char *name)
347 {
348         struct name *prop;
349
350         prop = allocate(sizeof(*prop) + strlen(name) + 1);
351         if (prop) {
352                 init_property(&prop->hdr, t, NAME);
353                 strcpy(prop->name, name);
354         }
355         return prop;
356 }
357
358 static struct children *add_child_property(struct tal_hdr *parent,
359                                            struct tal_hdr *child UNNEEDED)
360 {
361         struct children *prop = allocate(sizeof(*prop));
362         if (prop) {
363                 init_property(&prop->hdr, parent, CHILDREN);
364                 prop->parent = parent;
365                 list_head_init(&prop->children);
366         }
367         return prop;
368 }
369
370 static bool add_child(struct tal_hdr *parent, struct tal_hdr *child)
371 {
372         struct children *children = find_property(parent, CHILDREN);
373
374         if (!children) {
375                 children = add_child_property(parent, child);
376                 if (!children)
377                         return false;
378         }
379         list_add(&children->children, &child->list);
380         child->parent_child = (intptr_t)children ^ TAL_PTR_OBFUSTICATOR;
381         return true;
382 }
383
384 static void del_tree(struct tal_hdr *t, const tal_t *orig, int saved_errno)
385 {
386         struct prop_hdr **prop, *p, *next;
387
388         /* Already being destroyed?  Don't loop. */
389         if (unlikely(get_destroying_bit(t->parent_child)))
390                 return;
391
392         set_destroying_bit(&t->parent_child);
393
394         /* Call free notifiers. */
395         notify(t, TAL_NOTIFY_FREE, (tal_t *)orig, saved_errno);
396
397         /* Now free children and groups. */
398         prop = find_property_ptr(t, CHILDREN);
399         if (prop) {
400                 struct tal_hdr *i;
401                 struct children *c = (struct children *)*prop;
402
403                 while ((i = list_top(&c->children, struct tal_hdr, list))) {
404                         list_del(&i->list);
405                         del_tree(i, orig, saved_errno);
406                 }
407         }
408
409         /* Finally free our properties. */
410         for (p = t->prop; p && !is_literal(p); p = next) {
411                 next = p->next;
412                 freefn(p);
413         }
414         freefn(t);
415 }
416
417 void *tal_alloc_(const tal_t *ctx, size_t size, bool clear, const char *label)
418 {
419         struct tal_hdr *child, *parent = debug_tal(to_tal_hdr_or_null(ctx));
420
421         child = allocate(sizeof(struct tal_hdr) + size);
422         if (!child)
423                 return NULL;
424         if (clear)
425                 memset(from_tal_hdr(child), 0, size);
426         child->prop = (void *)label;
427         child->bytelen = size;
428
429         if (!add_child(parent, child)) {
430                 freefn(child);
431                 return NULL;
432         }
433         debug_tal(parent);
434         if (notifiers)
435                 notify(parent, TAL_NOTIFY_ADD_CHILD, from_tal_hdr(child), 0);
436         return from_tal_hdr(debug_tal(child));
437 }
438
439 static bool adjust_size(size_t *size, size_t count)
440 {
441         const size_t extra = sizeof(struct tal_hdr);
442
443         /* Multiplication wrap */
444         if (count && unlikely(*size * count / *size != count))
445                 goto overflow;
446
447         *size *= count;
448
449         /* Make sure we don't wrap adding header. */
450         if (*size + extra < extra)
451                 goto overflow;
452         return true;
453 overflow:
454         call_error("allocation size overflow");
455         return false;
456 }
457
458 void *tal_alloc_arr_(const tal_t *ctx, size_t size, size_t count, bool clear,
459                      const char *label)
460 {
461         if (!adjust_size(&size, count))
462                 return NULL;
463
464         return tal_alloc_(ctx, size, clear, label);
465 }
466
467 void *tal_free(const tal_t *ctx)
468 {
469         if (ctx) {
470                 struct tal_hdr *t;
471                 int saved_errno = errno;
472                 t = debug_tal(to_tal_hdr(ctx));
473                 if (unlikely(get_destroying_bit(t->parent_child)))
474                         return NULL;
475                 if (notifiers)
476                         notify(ignore_destroying_bit(t->parent_child)->parent,
477                                TAL_NOTIFY_DEL_CHILD, ctx, saved_errno);
478                 list_del(&t->list);
479                 del_tree(t, ctx, saved_errno);
480                 errno = saved_errno;
481         }
482         return NULL;
483 }
484
485 void *tal_steal_(const tal_t *new_parent, const tal_t *ctx)
486 {
487         if (ctx) {
488                 struct tal_hdr *newpar, *t, *old_parent;
489
490                 newpar = debug_tal(to_tal_hdr_or_null(new_parent));
491                 t = debug_tal(to_tal_hdr(ctx));
492
493                 /* Unlink it from old parent. */
494                 list_del(&t->list);
495                 old_parent = ignore_destroying_bit(t->parent_child)->parent;
496
497                 if (unlikely(!add_child(newpar, t))) {
498                         /* We can always add to old parent, because it has a
499                          * children property already. */
500                         if (!add_child(old_parent, t))
501                                 abort();
502                         return NULL;
503                 }
504                 debug_tal(newpar);
505                 if (notifiers)
506                         notify(t, TAL_NOTIFY_STEAL, new_parent, 0);
507         }
508         return (void *)ctx;
509 }
510
511 bool tal_add_destructor_(const tal_t *ctx, void (*destroy)(void *me))
512 {
513         tal_t *t = debug_tal(to_tal_hdr(ctx));
514         return add_notifier_property(t, TAL_NOTIFY_FREE|NOTIFY_IS_DESTRUCTOR,
515                                      (void *)destroy, NULL);
516 }
517
518 bool tal_add_destructor2_(const tal_t *ctx, void (*destroy)(void *me, void *arg),
519                           void *arg)
520 {
521         tal_t *t = debug_tal(to_tal_hdr(ctx));
522         return add_notifier_property(t, TAL_NOTIFY_FREE|NOTIFY_IS_DESTRUCTOR
523                                      |NOTIFY_EXTRA_ARG,
524                                      (void *)destroy, arg);
525 }
526
527 /* We could support notifiers with an extra arg, but we didn't add to API */
528 bool tal_add_notifier_(const tal_t *ctx, enum tal_notify_type types,
529                        void (*callback)(tal_t *, enum tal_notify_type, void *))
530 {
531         tal_t *t = debug_tal(to_tal_hdr(ctx));
532         struct notifier *n;
533
534         assert(types);
535         assert((types & ~(TAL_NOTIFY_FREE | TAL_NOTIFY_STEAL | TAL_NOTIFY_MOVE
536                           | TAL_NOTIFY_RESIZE | TAL_NOTIFY_RENAME
537                           | TAL_NOTIFY_ADD_CHILD | TAL_NOTIFY_DEL_CHILD
538                           | TAL_NOTIFY_ADD_NOTIFIER
539                           | TAL_NOTIFY_DEL_NOTIFIER)) == 0);
540
541         /* Don't call notifier about itself: set types after! */
542         n = add_notifier_property(t, 0, callback, NULL);
543         if (unlikely(!n))
544                 return false;
545
546         if (notifiers)
547                 notify(t, TAL_NOTIFY_ADD_NOTIFIER, callback, 0);
548
549         n->types = types;
550         if (types != TAL_NOTIFY_FREE)
551                 notifiers++;
552         return true;
553 }
554
555 bool tal_del_notifier_(const tal_t *ctx,
556                        void (*callback)(tal_t *, enum tal_notify_type, void *),
557                        bool match_extra_arg, void *extra_arg)
558 {
559         struct tal_hdr *t = debug_tal(to_tal_hdr(ctx));
560         enum tal_notify_type types;
561
562         types = del_notifier_property(t, callback, match_extra_arg, extra_arg);
563         if (types) {
564                 notify(t, TAL_NOTIFY_DEL_NOTIFIER, callback, 0);
565                 if (types != TAL_NOTIFY_FREE)
566                         notifiers--;
567                 return true;
568         }
569         return false;
570 }
571
572 bool tal_del_destructor_(const tal_t *ctx, void (*destroy)(void *me))
573 {
574         return tal_del_notifier_(ctx, (void *)destroy, false, NULL);
575 }
576
577 bool tal_del_destructor2_(const tal_t *ctx, void (*destroy)(void *me, void *arg),
578                           void *arg)
579 {
580         return tal_del_notifier_(ctx, (void *)destroy, true, arg);
581 }
582
583 bool tal_set_name_(tal_t *ctx, const char *name, bool literal)
584 {
585         struct tal_hdr *t = debug_tal(to_tal_hdr(ctx));
586         struct prop_hdr **prop = find_property_ptr(t, NAME);
587
588         /* Get rid of any old name */
589         if (prop) {
590                 struct name *name = (struct name *)*prop;
591                 if (is_literal(&name->hdr))
592                         *prop = NULL;
593                 else {
594                         *prop = name->hdr.next;
595                         freefn(name);
596                 }
597         }
598
599         if (literal && name[0]) {
600                 struct prop_hdr **p;
601
602                 /* Append literal. */
603                 for (p = &t->prop; *p && !is_literal(*p); p = &(*p)->next);
604                 *p = (struct prop_hdr *)name;
605         } else if (!add_name_property(t, name))
606                 return false;
607
608         debug_tal(t);
609         if (notifiers)
610                 notify(t, TAL_NOTIFY_RENAME, name, 0);
611         return true;
612 }
613
614 const char *tal_name(const tal_t *t)
615 {
616         struct name *n;
617
618         n = find_property(debug_tal(to_tal_hdr(t)), NAME);
619         if (!n)
620                 return NULL;
621
622         if (is_literal(&n->hdr))
623                 return (const char *)n;
624         return n->name;
625 }
626
627 size_t tal_bytelen(const tal_t *ptr)
628 {
629         /* NULL -> null_parent which has bytelen 0 */
630         struct tal_hdr *t = debug_tal(to_tal_hdr_or_null(ptr));
631
632         return t->bytelen;
633 }
634
635 /* Start one past first child: make stopping natural in circ. list. */
636 static struct tal_hdr *first_child(struct tal_hdr *parent)
637 {
638         struct children *child;
639
640         child = find_property(parent, CHILDREN);
641         if (!child)
642                 return NULL;
643
644         return list_top(&child->children, struct tal_hdr, list);
645 }
646
647 tal_t *tal_first(const tal_t *root)
648 {
649         struct tal_hdr *c, *t = debug_tal(to_tal_hdr_or_null(root));
650
651         c = first_child(t);
652         if (!c)
653                 return NULL;
654         return from_tal_hdr(c);
655 }
656
657 tal_t *tal_next(const tal_t *prev)
658 {
659         struct tal_hdr *next, *prevhdr = debug_tal(to_tal_hdr(prev));
660         struct list_head *head;
661
662         head = &ignore_destroying_bit(prevhdr->parent_child)->children;
663         next = list_next(head, prevhdr, list);
664         if (!next)
665                 return NULL;
666         return from_tal_hdr(next);
667 }
668
669 tal_t *tal_parent(const tal_t *ctx)
670 {
671         struct tal_hdr *t;
672
673         if (!ctx)
674                 return NULL;
675
676         t = debug_tal(to_tal_hdr(ctx));
677         if (ignore_destroying_bit(t->parent_child)->parent == &null_parent.hdr)
678                 return NULL;
679         return from_tal_hdr(ignore_destroying_bit(t->parent_child)->parent);
680 }
681
682 bool tal_resize_(tal_t **ctxp, size_t size, size_t count, bool clear)
683 {
684         struct tal_hdr *old_t, *t;
685         struct children *child;
686
687         old_t = debug_tal(to_tal_hdr(*ctxp));
688
689         if (!adjust_size(&size, count))
690                 return false;
691
692         t = resizefn(old_t, sizeof(struct tal_hdr) + size);
693         if (!t) {
694                 call_error("Reallocation failure");
695                 return false;
696         }
697
698         /* Clear between old end and new end. */
699         if (clear && size > t->bytelen) {
700                 char *old_end = (char *)(t + 1) + t->bytelen;
701                 memset(old_end, 0, size - t->bytelen);
702         }
703
704         /* Update length. */
705         t->bytelen = size;
706         update_bounds(t, sizeof(struct tal_hdr) + size);
707
708         /* If it didn't move, we're done! */
709         if (t != old_t) {
710                 /* Fix up linked list pointers. */
711                 t->list.next->prev = t->list.prev->next = &t->list;
712
713                 /* Fix up child property's parent pointer. */
714                 child = find_property(t, CHILDREN);
715                 if (child) {
716                         assert(child->parent == old_t);
717                         child->parent = t;
718                 }
719                 *ctxp = from_tal_hdr(debug_tal(t));
720                 if (notifiers)
721                         notify(t, TAL_NOTIFY_MOVE, from_tal_hdr(old_t), 0);
722         }
723         if (notifiers)
724                 notify(t, TAL_NOTIFY_RESIZE, (void *)size, 0);
725
726         return true;
727 }
728
729 bool tal_expand_(tal_t **ctxp, const void *src, size_t size, size_t count)
730 {
731         size_t old_len;
732         bool ret = false;
733
734         old_len = debug_tal(to_tal_hdr(*ctxp))->bytelen;
735
736         /* Check for additive overflow */
737         if (old_len + count * size < old_len) {
738                 call_error("dup size overflow");
739                 goto out;
740         }
741
742         /* Don't point src inside thing we're expanding! */
743         assert(src < *ctxp
744                || (char *)src >= (char *)(*ctxp) + old_len);
745
746         if (!tal_resize_(ctxp, size, old_len/size + count, false))
747                 goto out;
748
749         memcpy((char *)*ctxp + old_len, src, count * size);
750         ret = true;
751
752 out:
753         if (taken(src))
754                 tal_free(src);
755         return ret;
756 }
757
758 void *tal_dup_(const tal_t *ctx, const void *p, size_t size,
759                size_t n, size_t extra, const char *label)
760 {
761         void *ret;
762         size_t nbytes = size;
763
764         if (!adjust_size(&nbytes, n)) {
765                 if (taken(p))
766                         tal_free(p);
767                 return NULL;
768         }
769
770         /* Beware addition overflow! */
771         if (n + extra < n) {
772                 call_error("dup size overflow");
773                 if (taken(p))
774                         tal_free(p);
775                 return NULL;
776         }
777
778         if (taken(p)) {
779                 if (unlikely(!p))
780                         return NULL;
781                 if (unlikely(!tal_resize_((void **)&p, size, n + extra, false)))
782                         return tal_free(p);
783                 if (unlikely(!tal_steal(ctx, p)))
784                         return tal_free(p);
785                 return (void *)p;
786         }
787
788         ret = tal_alloc_arr_(ctx, size, n + extra, false, label);
789         if (ret)
790                 memcpy(ret, p, nbytes);
791         return ret;
792 }
793
794 void tal_set_backend(void *(*alloc_fn)(size_t size),
795                      void *(*resize_fn)(void *, size_t size),
796                      void (*free_fn)(void *),
797                      void (*error_fn)(const char *msg))
798 {
799         if (alloc_fn)
800                 allocfn = alloc_fn;
801         if (resize_fn)
802                 resizefn = resize_fn;
803         if (free_fn)
804                 freefn = free_fn;
805         if (error_fn)
806                 errorfn = error_fn;
807 }
808
809 #ifdef CCAN_TAL_DEBUG
810 static void dump_node(unsigned int indent, const struct tal_hdr *t)
811 {
812         unsigned int i;
813         const struct prop_hdr *p;
814
815         for (i = 0; i < indent; i++)
816                 printf("  ");
817         printf("%p len=%zu", t, t->bytelen);
818         for (p = t->prop; p; p = p->next) {
819                 struct children *c;
820                 struct name *n;
821                 struct notifier *no;
822                 if (is_literal(p)) {
823                         printf(" \"%s\"", (const char *)p);
824                         break;
825                 }
826                 switch (p->type) {
827                 case CHILDREN:
828                         c = (struct children *)p;
829                         printf(" CHILDREN(%p):parent=%p,children={%p,%p}\n",
830                                p, c->parent,
831                                c->children.n.prev, c->children.n.next);
832                         break;
833                 case NAME:
834                         n = (struct name *)p;
835                         printf(" NAME(%p):%s", p, n->name);
836                         break;
837                 case NOTIFIER:
838                         no = (struct notifier *)p;
839                         printf(" NOTIFIER(%p):fn=%p", p, no->u.notifyfn);
840                         break;
841                 default:
842                         printf(" **UNKNOWN(%p):%i**", p, p->type);
843                 }
844         }
845         printf("\n");
846 }
847
848 static void tal_dump_(unsigned int level, const struct tal_hdr *t)
849 {
850         struct children *children;
851
852         dump_node(level, t);
853
854         children = find_property(t, CHILDREN);
855         if (children) {
856                 struct tal_hdr *i;
857
858                 list_for_each(&children->children, i, list)
859                         tal_dump_(level + 1, i);
860         }
861 }
862
863 void tal_dump(void)
864 {
865         tal_dump_(0, &null_parent.hdr);
866 }
867 #endif /* CCAN_TAL_DEBUG */
868
869 #ifndef NDEBUG
870 static bool check_err(struct tal_hdr *t, const char *errorstr,
871                       const char *errmsg)
872 {
873         if (errorstr) {
874                 /* Try not to malloc: it may be corrupted. */
875                 char msg[strlen(errorstr) + 20 + strlen(errmsg) + 1];
876                 sprintf(msg, "%s:%p %s", errorstr, from_tal_hdr(t), errmsg);
877                 call_error(msg);
878         }
879         return false;
880 }
881
882 static bool check_node(struct children *parent_child,
883                        struct tal_hdr *t, const char *errorstr)
884 {
885         struct prop_hdr *p;
886         struct name *name = NULL;
887         struct children *children = NULL;
888
889         if (!in_bounds(t))
890                 return check_err(t, errorstr, "invalid pointer");
891
892         if (ignore_destroying_bit(t->parent_child) != parent_child)
893                 return check_err(t, errorstr, "incorrect parent");
894
895         for (p = t->prop; p; p = p->next) {
896                 if (is_literal(p)) {
897                         if (name)
898                                 return check_err(t, errorstr,
899                                                  "has extra literal");
900                         break;
901                 }
902                 if (!in_bounds(p))
903                         return check_err(t, errorstr,
904                                          "has bad property pointer");
905
906                 switch (p->type) {
907                 case CHILDREN:
908                         if (children)
909                                 return check_err(t, errorstr,
910                                                  "has two child nodes");
911                         children = (struct children *)p;
912                         break;
913                 case NOTIFIER:
914                         break;
915                 case NAME:
916                         if (name)
917                                 return check_err(t, errorstr,
918                                                  "has two names");
919                         name = (struct name *)p;
920                         break;
921                 default:
922                         return check_err(t, errorstr, "has unknown property");
923                 }
924         }
925         if (children) {
926                 struct tal_hdr *i;
927
928                 if (!list_check(&children->children, errorstr))
929                         return false;
930                 list_for_each(&children->children, i, list) {
931                         if (!check_node(children, i, errorstr))
932                                 return false;
933                 }
934         }
935         return true;
936 }
937
938 bool tal_check(const tal_t *ctx, const char *errorstr)
939 {
940         struct tal_hdr *t = to_tal_hdr_or_null(ctx);
941
942         return check_node(ignore_destroying_bit(t->parent_child), t, errorstr);
943 }
944 #else /* NDEBUG */
945 bool tal_check(const tal_t *ctx, const char *errorstr)
946 {
947         return true;
948 }
949 #endif