Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 1d2beaa9 authored by Qu Wenruo's avatar Qu Wenruo Committed by David Sterba
Browse files

btrfs: qgroup: Add comments explaining how btrfs qgroup works 



Add explaination how btrfs qgroups work.

Qgroup is split into 3 main phrases:
1) Reserve
   To ensure qgroup doesn't exceed its limit

2) Trace
   To info qgroup to trace which extent

3) Account
   Calculate qgroup number change for each traced extent.

This should save quite some time for new developers.

Signed-off-by: default avatarQu Wenruo <quwenruo@cn.fujitsu.com>
Reviewed-by: default avatarGoldwyn Rodrigues <rgoldwyn@suse.com>
Signed-off-by: default avatarDavid Sterba <dsterba@suse.com>
parent 1621f8f3

fs/btrfs/qgroup.h

+28 −0
Original line number Diff line number Diff line
@@ -22,6 +22,34 @@ 
#include "ulist.h"

#include "delayed-ref.h"



/*

 * Btrfs qgroup overview

 *

 * Btrfs qgroup splits into 3 main part:

 * 1) Reserve

 *    Reserve metadata/data space for incoming operations

 *    Affect how qgroup limit works

 *

 * 2) Trace

 *    Tell btrfs qgroup to trace dirty extents.

 *

 *    Dirty extents including:

 *    - Newly allocated extents

 *    - Extents going to be deleted (in this trans)

 *    - Extents whose owner is going to be modified

 *

 *    This is the main part affects whether qgroup numbers will stay

 *    consistent.

 *    Btrfs qgroup can trace clean extents and won't cause any problem,

 *    but it will consume extra CPU time, it should be avoided if possible.

 *

 * 3) Account

 *    Btrfs qgroup will updates its numbers, based on dirty extents traced

 *    in previous step.

 *

 *    Normally at qgroup rescan and transaction commit time.

 */



/*

 * Record a dirty extent, and info qgroup to update quota on it

 * TODO: Use kmem cache to alloc it.