btrfs: move leak debug code to functions
PATCH 1/1 btrfs: move leak debug code to functions
There was a time when sprinkling #ifdefs around was bad form. ;) We can clean up the code a bit by moving the leak-list adds/removes into functions and make things more readable.
---
p.s. maybe _debug_ should be in the function names? *shrug*
fs/btrfs/extent_io.c +28 -31
@@ -30,6 +30,29 @@ static LIST_HEAD(states);#define LEAK_DEBUG 0#if LEAK_DEBUG static DEFINE_SPINLOCK (leak_lock); + +static inline +void btrfs_leak_list_add (struct list_head *new,struct list_head *head) +{ +unsigned long flags; + +spin_lock_irqsave (&leak_lock, flags); +list_add (new, head); +spin_unlock_irqrestore (&leak_lock, flags); +} + +static inline +void btrfs_leak_list_del (struct list_head *entry) +{ +unsigned long flags; + +spin_lock_irqsave (&leak_lock, flags); +list_del (entry); +spin_unlock_irqrestore (&leak_lock, flags); +} +#else +#define btrfs_leak_list_add (new, head) do {} while (0); +#define btrfs_leak_list_del (entry) do {} while (0);#endif #define BUFFER_LRU_MAX 64
@@ -96,7 +119,6 @@ void extent_io_exit(void) state->state, state->tree, atomic_read(&state->refs));list_del (&state->leak_list);kmem_cache_free (extent_state_cache, state); - }while (!list_empty (&buffers)) {
@@ -134,9 +156,6 @@ void extent_io_tree_init(struct extent_io_tree *tree,static struct extent_state *alloc_extent_state (gfp_t mask) {struct extent_state *state; -#if LEAK_DEBUG -unsigned long flags; -#endif state =kmem_cache_alloc (extent_state_cache, mask);if (!state)
@@ -144,11 +163,7 @@ static struct extent_state *alloc_extent_state(gfp_t mask) state->state =0 ; state->private =0 ; state->tree =NULL ; -#if LEAK_DEBUG -spin_lock_irqsave (&leak_lock, flags); -list_add (&state->leak_list, &states); -spin_unlock_irqrestore (&leak_lock, flags); -#endif +btrfs_leak_list_add (&state->leak_list, &states);atomic_set (&state->refs,1 );init_waitqueue_head (&state->wq);trace_alloc_extent_state (state, mask, _RET_IP_);
@@ -160,15 +175,8 @@ void free_extent_state(struct extent_state *state)if (!state)return ;if (atomic_dec_and_test (&state->refs)) { -#if LEAK_DEBUG -unsigned long flags; -#endif WARN_ON (state->tree); -#if LEAK_DEBUG -spin_lock_irqsave (&leak_lock, flags); -list_del (&state->leak_list); -spin_unlock_irqrestore (&leak_lock, flags); -#endif +btrfs_leak_list_del (&state->leak_list);trace_free_extent_state (state, _RET_IP_);kmem_cache_free (extent_state_cache, state); }
@@ -4010,12 +4018,7 @@ out:static void __free_extent_buffer (struct extent_buffer *eb) { -#if LEAK_DEBUG -unsigned long flags; -spin_lock_irqsave (&leak_lock, flags); -list_del (&eb->leak_list); -spin_unlock_irqrestore (&leak_lock, flags); -#endif +btrfs_leak_list_del (&eb->leak_list);kmem_cache_free (extent_buffer_cache, eb); }
@@ -4025,9 +4028,6 @@ static struct extent_buffer *__alloc_extent_buffer(struct extent_io_tree *tree, gfp_t mask) {struct extent_buffer *eb =NULL ; -#if LEAK_DEBUG -unsigned long flags; -#endif eb =kmem_cache_zalloc (extent_buffer_cache, mask);if (eb ==NULL )
@@ -4047,11 +4047,8 @@ static struct extent_buffer *__alloc_extent_buffer(struct extent_io_tree *tree,init_waitqueue_head (&eb->write_lock_wq);init_waitqueue_head (&eb->read_lock_wq); -#if LEAK_DEBUG -spin_lock_irqsave (&leak_lock, flags); -list_add (&eb->leak_list, &buffers); -spin_unlock_irqrestore (&leak_lock, flags); -#endif +btrfs_leak_list_add (&eb->leak_list, &buffers); +spin_lock_init (&eb->refs_lock);atomic_set (&eb->refs,1 );atomic_set (&eb->io_pages,0 );
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Quoted 2 lines · Eric Sandeen
+#define
btrfs_leak_list_add(new, head)do {} while (0); +#definebtrfs_leak_list_del(entry)do {} while (0);
Shouldn't the trailing semi-colons be omitted?
Roger
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
iEYEARECAAYFAlF0uAsACgkQmOOfHg372QSuKACfSSd2ufXyZHzuD8xLhGhcBYnp 6iMAn3NbhUgzIxbrVxHDAiWMChQOPJUx
=n9GF
-----END PGP SIGNATURE-----
PATCH v2 1/1 btrfs: move leak debug code to functions
In reply to Eric SandeenThere was a time when sprinkling #ifdefs around was
bad form. We can clean up the code a bit by moving
the leak-list adds/removes into functions and make things more readable.
---
V2: remove extra semicolons on no-op #defines,
thanks Roger!
p.s. maybe _debug_ should be in the function names? *shrug*
fs/btrfs/extent_io.c +28 -31
@@ -30,6 +30,29 @@ static LIST_HEAD(states);#define LEAK_DEBUG 0#if LEAK_DEBUG static DEFINE_SPINLOCK (leak_lock); + +static inline +void btrfs_leak_list_add (struct list_head *new,struct list_head *head) +{ +unsigned long flags; + +spin_lock_irqsave (&leak_lock, flags); +list_add (new, head); +spin_unlock_irqrestore (&leak_lock, flags); +} + +static inline +void btrfs_leak_list_del (struct list_head *entry) +{ +unsigned long flags; + +spin_lock_irqsave (&leak_lock, flags); +list_del (entry); +spin_unlock_irqrestore (&leak_lock, flags); +} +#else +#define btrfs_leak_list_add (new, head) do {} while (0) +#define btrfs_leak_list_del (entry) do {} while (0)#endif #define BUFFER_LRU_MAX 64
@@ -96,7 +119,6 @@ void extent_io_exit(void) state->state, state->tree, atomic_read(&state->refs));list_del (&state->leak_list);kmem_cache_free (extent_state_cache, state); - }while (!list_empty (&buffers)) {
@@ -134,9 +156,6 @@ void extent_io_tree_init(struct extent_io_tree *tree,static struct extent_state *alloc_extent_state (gfp_t mask) {struct extent_state *state; -#if LEAK_DEBUG -unsigned long flags; -#endif state =kmem_cache_alloc (extent_state_cache, mask);if (!state)
@@ -144,11 +163,7 @@ static struct extent_state *alloc_extent_state(gfp_t mask) state->state =0 ; state->private =0 ; state->tree =NULL ; -#if LEAK_DEBUG -spin_lock_irqsave (&leak_lock, flags); -list_add (&state->leak_list, &states); -spin_unlock_irqrestore (&leak_lock, flags); -#endif +btrfs_leak_list_add (&state->leak_list, &states);atomic_set (&state->refs,1 );init_waitqueue_head (&state->wq);trace_alloc_extent_state (state, mask, _RET_IP_);
@@ -160,15 +175,8 @@ void free_extent_state(struct extent_state *state)if (!state)return ;if (atomic_dec_and_test (&state->refs)) { -#if LEAK_DEBUG -unsigned long flags; -#endif WARN_ON (state->tree); -#if LEAK_DEBUG -spin_lock_irqsave (&leak_lock, flags); -list_del (&state->leak_list); -spin_unlock_irqrestore (&leak_lock, flags); -#endif +btrfs_leak_list_del (&state->leak_list);trace_free_extent_state (state, _RET_IP_);kmem_cache_free (extent_state_cache, state); }
@@ -4010,12 +4018,7 @@ out:static void __free_extent_buffer (struct extent_buffer *eb) { -#if LEAK_DEBUG -unsigned long flags; -spin_lock_irqsave (&leak_lock, flags); -list_del (&eb->leak_list); -spin_unlock_irqrestore (&leak_lock, flags); -#endif +btrfs_leak_list_del (&eb->leak_list);kmem_cache_free (extent_buffer_cache, eb); }
@@ -4025,9 +4028,6 @@ static struct extent_buffer *__alloc_extent_buffer(struct extent_io_tree *tree, gfp_t mask) {struct extent_buffer *eb =NULL ; -#if LEAK_DEBUG -unsigned long flags; -#endif eb =kmem_cache_zalloc (extent_buffer_cache, mask);if (eb ==NULL )
@@ -4047,11 +4047,8 @@ static struct extent_buffer *__alloc_extent_buffer(struct extent_io_tree *tree,init_waitqueue_head (&eb->write_lock_wq);init_waitqueue_head (&eb->read_lock_wq); -#if LEAK_DEBUG -spin_lock_irqsave (&leak_lock, flags); -list_add (&eb->leak_list, &buffers); -spin_unlock_irqrestore (&leak_lock, flags); -#endif +btrfs_leak_list_add (&eb->leak_list, &buffers); +spin_lock_init (&eb->refs_lock);atomic_set (&eb->refs,1 );atomic_set (&eb->io_pages,0 );
Quoted 5 lines · Eric Sandeen
There was a time when sprinkling #ifdefs around was
bad form. We can clean up the code a bit by moving
the leak-list adds/removes into functions and make things more readable.
Quoted 8 lines
Signed-off-by Eric Sandeen <[email protected]>---
V2: remove extra semicolons on no-op #defines,
thanks Roger!p.s. maybe _debug_ should be in the function names? *shrug*
I agree with that, makes things clear in the code, one does not need to look into that function.
The leak_list members of extent_state and extent_buffer are present even without LEAK_DEBUG and are taking space, I'd like to see them moved under an #ifdef, but as the define is now local to the .c file this would need to add eg. a CONFIG_ option or a comment that describes how it should be used.
Bug I'm fine with changing just the function names right now, the rest is optional and nice to have.
Quoted 15 lines · David Sterba
Quoted 5 lines · Eric Sandeen
There was a time when sprinkling #ifdefs around was
bad form. We can clean up the code a bit by moving
the leak-list adds/removes into functions and make things more readable.Quoted 8 lines
Signed-off-by Eric Sandeen <[email protected]>---
V2: remove extra semicolons on no-op #defines,
thanks Roger!p.s. maybe _debug_ should be in the function names? *shrug*
Quoted 8 lines
I agree with that, makes things clear in the code, one does not need to look into that function.
The
leak_listmembers ofextent_stateandextent_bufferare present even withoutLEAK_DEBUGand are taking space, I'd like to see them moved under an #ifdef, but as the define is now local to the .c file this would need to add eg. aCONFIG_option or a comment that describes how it should be used.
Yep I noticed that too, I'd be happy to elevate it to a CONFIG_ option if it's really something that will be kept around for a while.
Could maybe be lumped in to a CONFIG_BTRFS_DEBUG that catches other #define DEBUG behaviors as well?
-Eric
Quoted 5 lines
Bug I'm fine with changing just the function names right now, the rest is optional and nice to have.
Reviewed-by David Sterba <[email protected]>
Quoted 2 lines · Eric Sandeen
Yep I noticed that too, I'd be happy to elevate it to a
CONFIG_option if it's really something that will be kept around for a while.
We have (and will have) more code for debugging aid.
Quoted 2 lines
Could maybe be lumped in to a
CONFIG_BTRFS_DEBUGthat catches other #define DEBUG behaviors as well?
Yes please, feel free to use this
https://patchwork.kernel.org/patch/846462/
If there are really heavy debug checks we may separate them, but a single option should be fine for now.
thanks,
david
PATCH v3 1/1 btrfs: move leak debug code to functions
In reply to Eric SandeenClean up the leak debugging in extent_io.c by moving the debug code into functions. This also removes the list_heads used for debugging from the extent_buffer and extent_state structures when debug is not enabled.
Since we need a global debug config to do that last part, implement CONFIG_BTRFS_DEBUG to accommodate.
Thanks to Dave Sterba for the Kconfig bit.
---
Now we can move other #ifdef DEBUG under this same config, but not all of them; some look like they would be way too chatty. I'll need to review those before ending another patch to add any of them under CONFIG_BTRFS_DEBUG.
Thanks,
-Eric
fs/btrfs/Kconfig +10 -0
@@ -52,3 +52,13 @@ config BTRFS_FS_CHECK_INTEGRITY In most cases, unless you are a btrfs developer who needs to verify the integrity of (super)-block write requests during the run of a regression test, say N + +config BTRFS_DEBUG + bool "Btrfs debugging support" + depends on BTRFS_FS + help + Enable run-time debugging support for the btrfs filesystem. This may + enable additional and expensive checks with negative impact on + performance, or export extra information via sysfs. + + If unsure, say N.
fs/btrfs/extent_io.c +58 -55
166 lines not on this page · raw message
fs/btrfs/extent_io.h +5 -1
@@ -116,7 +116,9 @@ struct extent_state {/* for use by the FS */ u64 private; +#ifdef CONFIG_BTRFS_DEBUG struct list_head leak_list; +#endif };#define INLINE_EXTENT_BUFFER_PAGES 16
@@ -132,7 +134,6 @@ struct extent_buffer {atomic_t refs;atomic_t io_pages;int read_mirror; -struct list_head leak_list;struct rcu_head rcu_head;pid_t lock_owner;
@@ -159,6 +160,9 @@ struct extent_buffer {wait_queue_head_t read_lock_wq;wait_queue_head_t lock_wq;struct page *pages[INLINE_EXTENT_BUFFER_PAGES ]; +#ifdef CONFIG_BTRFS_DEBUG +struct list_head leak_list; +#endif }; static inline void extent_set_compress_type(unsigned long *bio_flags,
Quoted 11 lines · Eric Sandeen
Clean up the leak debugging in
extent_io.cby moving the debug code into functions. This also removes thelist_headsused for debugging from theextent_bufferandextent_statestructures when debug is not enabled.Since we need a global debug config to do that last part, implement
CONFIG_BTRFS_DEBUGto accommodate.Thanks to Dave Sterba for the
Kconfigbit.Signed-off-by Eric Sandeen <[email protected]>
Quoted 5 lines
Now we can move other #ifdef DEBUG under this same config, but not all of them; some look like they would be way too chatty. I'll need to review those before ending another patch to add any of them under
CONFIG_BTRFS_DEBUG.
Agreed. The number of extra checks should be reasonable so the fs is still usable.
david