btrfs: document what the spinlock unused_bgs_lock protects

Add some comments to struct btrfs_fs_info to explicitly document which
members are protected by the spinlock unused_bgs_lock. It is currently
used to protect two linked lists, the reclaim_bgs and unused_bgs lists.

So add an explicit comment on top of each list to mention its protected
by unused_bgs_lock, as well as comment on top of unused_bgs_lock to
mention the lists it protects.

Reviewed-by: Johannes Thumshirn <johannes.thumshirn@wdc.com>
Reviewed-by: Josef Bacik <josef@toxicpanda.com>
Reviewed-by: Boris Burkov <boris@bur.io>
Signed-off-by: Filipe Manana <fdmanana@suse.com>
Reviewed-by: David Sterba <dsterba@suse.com>
Signed-off-by: David Sterba <dsterba@suse.com>

diff --git a/fs/btrfs/fs.h b/fs/btrfs/fs.h
index b747134fac7742bb881689a731b9f4f3126813be..97d10ed4b2c12c8b54369e1a704d33101390ae3d 100644 (file)
--- a/fs/btrfs/fs.h
+++ b/fs/btrfs/fs.h
@@ -731,10 +731,13 @@ struct btrfs_fs_info {
 
        /* Reclaim partially filled block groups in the background */
        struct work_struct reclaim_bgs_work;
+       /* Protected by unused_bgs_lock. */
        struct list_head reclaim_bgs;
        int bg_reclaim_threshold;
 
+       /* Protects the lists unused_bgs and reclaim_bgs. */
        spinlock_t unused_bgs_lock;
+       /* Protected by unused_bgs_lock. */
        struct list_head unused_bgs;
        struct mutex unused_bg_unpin_mutex;
        /* Protect block groups that are going to be deleted */