vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/common/memleak.h

70 lines
2.2 KiB
C
Raw Normal View History

lightningd: tal memleak detection, dev-memleak command. This is a primitive mark-and-sweep-style garbage detector. The core is in common/ for later use by subdaemons, but for now it's just lightningd. We initialize it before most other allocations. We walk the tal tree to get all the pointers, then search the `ld` object for those pointers, recursing down. Some specific helpers are required for hashtables (which stash bits in the unused pointer bits, so won't be found). There's `notleak()` for annotating things that aren't leaks: things like globals and timers, and other semi-transients. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:17:54 +00:00
#ifndef LIGHTNING_COMMON_MEMLEAK_H
#define LIGHTNING_COMMON_MEMLEAK_H
#include "config.h"
Re-enable builds with DEVELOPER=0 Two changes: - Fixed the function signature of noleak_ to match in both configurations - Added memleak.o to linker for tests Generating the stubs for the unit tests doesn't really work since the stubs are checked in an differ between the two configurations, so adding memleak to the linker fixes that, by not requiring stubs to be generated in the first place. Signed-off-by: Christian Decker <decker.christian@gmail.com>
2017-12-15 13:26:06 +00:00
#include <ccan/cast/cast.h>
lightningd: tal memleak detection, dev-memleak command. This is a primitive mark-and-sweep-style garbage detector. The core is in common/ for later use by subdaemons, but for now it's just lightningd. We initialize it before most other allocations. We walk the tal tree to get all the pointers, then search the `ld` object for those pointers, recursing down. Some specific helpers are required for hashtables (which stash bits in the unused pointer bits, so won't be found). There's `notleak()` for annotating things that aren't leaks: things like globals and timers, and other semi-transients. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:17:54 +00:00
#include <ccan/tal/tal.h>
common/memleak: add dynamic hooks for assisting memleak. Rather than reaching into data structures, let them register their own callbacks. This avoids us having to expose "memleak_remove_xxx" functions, and call them manually. Under the hood, this is done by having a specially-named tal child of the thing we want to assist, containing the callback. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-09-06 05:42:05 +01:00
#include <ccan/typesafe_cb/typesafe_cb.h>
memleak: add backtrace to allocations. We use the tal notifiers to attach a `backtrace` object on every allocation. This also means moving backtrace_state from log.c into lightningd.c, so we can hand it to memleak_init(). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:18:54 +00:00
#include <inttypes.h>
lightningd: tal memleak detection, dev-memleak command. This is a primitive mark-and-sweep-style garbage detector. The core is in common/ for later use by subdaemons, but for now it's just lightningd. We initialize it before most other allocations. We walk the tal tree to get all the pointers, then search the `ld` object for those pointers, recursing down. Some specific helpers are required for hashtables (which stash bits in the unused pointer bits, so won't be found). There's `notleak()` for annotating things that aren't leaks: things like globals and timers, and other semi-transients. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:17:54 +00:00
common/memleak: add dynamic hooks for assisting memleak. Rather than reaching into data structures, let them register their own callbacks. This avoids us having to expose "memleak_remove_xxx" functions, and call them manually. Under the hood, this is done by having a specially-named tal child of the thing we want to assist, containing the callback. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-09-06 05:42:05 +01:00
struct htable;
lightningd: tal memleak detection, dev-memleak command. This is a primitive mark-and-sweep-style garbage detector. The core is in common/ for later use by subdaemons, but for now it's just lightningd. We initialize it before most other allocations. We walk the tal tree to get all the pointers, then search the `ld` object for those pointers, recursing down. Some specific helpers are required for hashtables (which stash bits in the unused pointer bits, so won't be found). There's `notleak()` for annotating things that aren't leaks: things like globals and timers, and other semi-transients. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:17:54 +00:00
#if HAVE_TYPEOF
#define memleak_typeof(var) typeof(var)
#else
#define memleak_typeof(var) void *
#endif /* !HAVE_TYPEOF */
/* Mark a pointer as not being leaked. */
memleak: allow marking of entire tal trees to be noleak. In particular, the pay command attaches all kinds of stuff to the struct command; they're not really a leak, since commands expire. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:22:40 +00:00
#define notleak(p) ((memleak_typeof(p))notleak_((p), false))
/* Mark a pointer and all its tal children as not being leaked. */
#define notleak_with_children(p) ((memleak_typeof(p))notleak_((p), true))
lightningd: tal memleak detection, dev-memleak command. This is a primitive mark-and-sweep-style garbage detector. The core is in common/ for later use by subdaemons, but for now it's just lightningd. We initialize it before most other allocations. We walk the tal tree to get all the pointers, then search the `ld` object for those pointers, recursing down. Some specific helpers are required for hashtables (which stash bits in the unused pointer bits, so won't be found). There's `notleak()` for annotating things that aren't leaks: things like globals and timers, and other semi-transients. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:17:54 +00:00
memleak: allow marking of entire tal trees to be noleak. In particular, the pay command attaches all kinds of stuff to the struct command; they're not really a leak, since commands expire. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:22:40 +00:00
void *notleak_(const void *ptr, bool plus_children);
lightningd: tal memleak detection, dev-memleak command. This is a primitive mark-and-sweep-style garbage detector. The core is in common/ for later use by subdaemons, but for now it's just lightningd. We initialize it before most other allocations. We walk the tal tree to get all the pointers, then search the `ld` object for those pointers, recursing down. Some specific helpers are required for hashtables (which stash bits in the unused pointer bits, so won't be found). There's `notleak()` for annotating things that aren't leaks: things like globals and timers, and other semi-transients. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:17:54 +00:00
common/memleak: add dynamic hooks for assisting memleak. Rather than reaching into data structures, let them register their own callbacks. This avoids us having to expose "memleak_remove_xxx" functions, and call them manually. Under the hood, this is done by having a specially-named tal child of the thing we want to assist, containing the callback. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2019-09-06 05:42:05 +01:00
/* Mark a helper to be called to scan this structure for mem references */
/* For update-mock: memleak_add_helper_ mock empty */
void memleak_add_helper_(const tal_t *p, void (*cb)(struct htable *memtable,
const tal_t *));
#if DEVELOPER
#define memleak_add_helper(p, cb) \
memleak_add_helper_((p), \
typesafe_cb_preargs(void, const tal_t *, \
(cb), (p), \
struct htable *))
#else
/* Don't refer to cb at all if !DEVELOPER */
#define memleak_add_helper(p, cb)
#endif
lightningd: tal memleak detection, dev-memleak command. This is a primitive mark-and-sweep-style garbage detector. The core is in common/ for later use by subdaemons, but for now it's just lightningd. We initialize it before most other allocations. We walk the tal tree to get all the pointers, then search the `ld` object for those pointers, recursing down. Some specific helpers are required for hashtables (which stash bits in the unused pointer bits, so won't be found). There's `notleak()` for annotating things that aren't leaks: things like globals and timers, and other semi-transients. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:17:54 +00:00
memleak: don't require a root pointer. We can just track everything from NULL (the ultimate parent) down. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-08-24 06:20:06 +01:00
/* Initialize memleak detection */
void memleak_init(void);
lightningd: tal memleak detection, dev-memleak command. This is a primitive mark-and-sweep-style garbage detector. The core is in common/ for later use by subdaemons, but for now it's just lightningd. We initialize it before most other allocations. We walk the tal tree to get all the pointers, then search the `ld` object for those pointers, recursing down. Some specific helpers are required for hashtables (which stash bits in the unused pointer bits, so won't be found). There's `notleak()` for annotating things that aren't leaks: things like globals and timers, and other semi-transients. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:17:54 +00:00
/* Allocate a htable with all the memory we've allocated. */
memleak: add second exclude arg to exclude current commands' jcon. This is not a child of cmd, since they have independent lifetimes, but we don't want to noleak them all, since it's only the one currently in progress (and its children) that we want to exclude. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:20:54 +00:00
struct htable *memleak_enter_allocations(const tal_t *ctx,
const void *exclude1,
const void *exclude2);
lightningd: tal memleak detection, dev-memleak command. This is a primitive mark-and-sweep-style garbage detector. The core is in common/ for later use by subdaemons, but for now it's just lightningd. We initialize it before most other allocations. We walk the tal tree to get all the pointers, then search the `ld` object for those pointers, recursing down. Some specific helpers are required for hashtables (which stash bits in the unused pointer bits, so won't be found). There's `notleak()` for annotating things that aren't leaks: things like globals and timers, and other semi-transients. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:17:54 +00:00
/* Remove any pointers to memory under root */
void memleak_remove_referenced(struct htable *memtable, const void *root);
memleak: create and use a generic htable helper and generic intmap helper. memleak can't see into htables, as it overloads unused pointer bits. And it can't see into intmap, since they use malloc (it only looks for tal pointers). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-08-24 06:20:02 +01:00
/* Remove any pointers inside this htable (which is opaque to memleak). */
void memleak_remove_htable(struct htable *memtable, const struct htable *ht);
/* Remove any pointers inside this uintmap (which is opaque to memleak). */
#define memleak_remove_uintmap(memtable, umap) \
memleak_remove_intmap_(memtable, uintmap_unwrap_(umap))
struct intmap;
void memleak_remove_intmap_(struct htable *memtable, const struct intmap *m);
lightningd: tal memleak detection, dev-memleak command. This is a primitive mark-and-sweep-style garbage detector. The core is in common/ for later use by subdaemons, but for now it's just lightningd. We initialize it before most other allocations. We walk the tal tree to get all the pointers, then search the `ld` object for those pointers, recursing down. Some specific helpers are required for hashtables (which stash bits in the unused pointer bits, so won't be found). There's `notleak()` for annotating things that aren't leaks: things like globals and timers, and other semi-transients. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:17:54 +00:00
/* Mark this pointer as being referenced, and search within for more. */
memleak: allow for scanning non-talloc regions. For some daemons we'll be handing it non-talloc memory to scan for pointers. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2018-08-24 06:20:06 +01:00
void memleak_scan_region(struct htable *memtable,
const void *p, size_t bytelen);
lightningd: tal memleak detection, dev-memleak command. This is a primitive mark-and-sweep-style garbage detector. The core is in common/ for later use by subdaemons, but for now it's just lightningd. We initialize it before most other allocations. We walk the tal tree to get all the pointers, then search the `ld` object for those pointers, recursing down. Some specific helpers are required for hashtables (which stash bits in the unused pointer bits, so won't be found). There's `notleak()` for annotating things that aren't leaks: things like globals and timers, and other semi-transients. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:17:54 +00:00
/* Get (and remove) a leak from memtable, or NULL */
memleak: add backtrace to allocations. We use the tal notifiers to attach a `backtrace` object on every allocation. This also means moving backtrace_state from log.c into lightningd.c, so we can hand it to memleak_init(). Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:18:54 +00:00
const void *memleak_get(struct htable *memtable, const uintptr_t **backtrace);
lightningd: tal memleak detection, dev-memleak command. This is a primitive mark-and-sweep-style garbage detector. The core is in common/ for later use by subdaemons, but for now it's just lightningd. We initialize it before most other allocations. We walk the tal tree to get all the pointers, then search the `ld` object for those pointers, recursing down. Some specific helpers are required for hashtables (which stash bits in the unused pointer bits, so won't be found). There's `notleak()` for annotating things that aren't leaks: things like globals and timers, and other semi-transients. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2017-12-15 10:17:54 +00:00
#endif /* LIGHTNING_COMMON_MEMLEAK_H */