[PATCH] f2fs: add missing doc for fault injection sysfs

[PATCH] f2fs: add missing doc for fault injection sysfs

[Chao Yu]

We supported configuring fault injection parameter via sysfs w/
below commits, however, we forgot to add doc entry, fix it.

commit 087968974fcd ("f2fs: add fault injection to sysfs")
/sys/fs/f2fs/fault_injection/fault_*

commit 1ecc0c5c50ce ("f2fs: support configuring fault injection per superblock")
/sys/fs/f2fs/<device>/fault_*

Cc: Sheng Yong <shengyong@oppo.com>
Signed-off-by: Chao Yu <chao@kernel.org>
---
 Documentation/ABI/testing/sysfs-fs-f2fs | 63 +++++++++++++++----------
 1 file changed, 37 insertions(+), 26 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-fs-f2fs b/Documentation/ABI/testing/sysfs-fs-f2fs
index 9e3756625a81..3ce58d0c4f2e 100644
--- a/Documentation/ABI/testing/sysfs-fs-f2fs
+++ b/Documentation/ABI/testing/sysfs-fs-f2fs
@@ -642,30 +642,41 @@ Contact:	"Daeho Jeong" <daehojeong@google.com>
 Description:	Show the accumulated total revoked atomic write block count after boot.
 		If you write "0" here, you can initialize to "0".
 
-What:		/sys/fs/f2fs/<disk>/gc_mode
-Date:		October 2022
-Contact:	"Yangtao Li" <frank.li@vivo.com>
-Description:	Show the current gc_mode as a string.
-		This is a read-only entry.
+What:		/sys/fs/f2fs/<disk>/fault_rate
+Date:		May 2016
+Contact:	"Sheng Yong" <shengyong@oppo.com>
+Contact:	"Chao Yu" <chao@kernel.org>
+Description:	Enable fault injection in all supported types with
+		specified injection rate.
 
-What:		/sys/fs/f2fs/<disk>/discard_urgent_util
-Date:		November 2022
-Contact:	"Yangtao Li" <frank.li@vivo.com>
-Description:	When space utilization exceeds this, do background DISCARD aggressively.
-		Does DISCARD forcibly in a period of given min_discard_issue_time when the number
-		of discards is not 0 and set discard granularity to 1.
-		Default: 80
-
-What:		/sys/fs/f2fs/<disk>/hot_data_age_threshold
-Date:		November 2022
-Contact:	"Ping Xiong" <xiongping1@xiaomi.com>
-Description:	When DATA SEPARATION is on, it controls the age threshold to indicate
-		the data blocks as hot. By default it was initialized as 262144 blocks
-		(equals to 1GB).
-
-What:		/sys/fs/f2fs/<disk>/warm_data_age_threshold
-Date:		November 2022
-Contact:	"Ping Xiong" <xiongping1@xiaomi.com>
-Description:	When DATA SEPARATION is on, it controls the age threshold to indicate
-		the data blocks as warm. By default it was initialized as 2621440 blocks
-		(equals to 10GB).
+What:		/sys/fs/f2fs/<disk>/fault_type
+Date:		May 2016
+Contact:	"Sheng Yong" <shengyong@oppo.com>
+Contact:	"Chao Yu" <chao@kernel.org>
+Description:	Support configuring fault injection type, should be
+		enabled with fault_injection option, fault type value
+		is shown below, it supports single or combined type.
+
+		===================      ===========
+		Type_Name                Type_Value
+		===================      ===========
+		FAULT_KMALLOC            0x000000001
+		FAULT_KVMALLOC           0x000000002
+		FAULT_PAGE_ALLOC         0x000000004
+		FAULT_PAGE_GET           0x000000008
+		FAULT_ALLOC_BIO          0x000000010 (obsolete)
+		FAULT_ALLOC_NID          0x000000020
+		FAULT_ORPHAN             0x000000040
+		FAULT_BLOCK              0x000000080
+		FAULT_DIR_DEPTH          0x000000100
+		FAULT_EVICT_INODE        0x000000200
+		FAULT_TRUNCATE           0x000000400
+		FAULT_READ_IO            0x000000800
+		FAULT_CHECKPOINT         0x000001000
+		FAULT_DISCARD            0x000002000
+		FAULT_WRITE_IO           0x000004000
+		FAULT_SLAB_ALLOC         0x000008000
+		FAULT_DQUOT_INIT         0x000010000
+		FAULT_LOCK_OP            0x000020000
+		FAULT_BLKADDR            0x000040000
+		===================      ===========
-- 
2.36.1

Re: [PATCH] f2fs: add missing doc for fault injection sysfs

[Yangtao Li]

Hi Chao,

> -What:		/sys/fs/f2fs/<disk>/gc_mode
> -Date:		October 2022
> -Contact:	"Yangtao Li" <frank.li@vivo.com>
> -Description:	Show the current gc_mode as a string.
> -		This is a read-only entry.
 
> -What:		/sys/fs/f2fs/<disk>/discard_urgent_util
> -Date:		November 2022
> -Contact:	"Yangtao Li" <frank.li@vivo.com>
> -Description:	When space utilization exceeds this, do background DISCARD aggressively.
> -		Does DISCARD forcibly in a period of given min_discard_issue_time when the number
> -		of discards is not 0 and set discard granularity to 1.
> -		Default: 80
> -
> -What:		/sys/fs/f2fs/<disk>/hot_data_age_threshold
> -Date:		November 2022
> -Contact:	"Ping Xiong" <xiongping1@xiaomi.com>
> -Description:	When DATA SEPARATION is on, it controls the age threshold to indicate
> -		the data blocks as hot. By default it was initialized as 262144 blocks
> -		(equals to 1GB).
> -
> -What:		/sys/fs/f2fs/<disk>/warm_data_age_threshold
> -Date:		November 2022
> -Contact:	"Ping Xiong" <xiongping1@xiaomi.com>
> -Description:	When DATA SEPARATION is on, it controls the age threshold to indicate
> -		the data blocks as warm. By default it was initialized as 2621440 blocks
> -		(equals to 10GB).

Why delete other node descriptions, mistake?

Thx,
Yangtao

Re: [PATCH] f2fs: add missing doc for fault injection sysfs

[Chao Yu]

On 2022/12/15 22:14, Yangtao Li wrote:
> Hi Chao,
> 
>> -What:		/sys/fs/f2fs/<disk>/gc_mode
>> -Date:		October 2022
>> -Contact:	"Yangtao Li" <frank.li@vivo.com>
>> -Description:	Show the current gc_mode as a string.
>> -		This is a read-only entry.
>   
>> -What:		/sys/fs/f2fs/<disk>/discard_urgent_util
>> -Date:		November 2022
>> -Contact:	"Yangtao Li" <frank.li@vivo.com>
>> -Description:	When space utilization exceeds this, do background DISCARD aggressively.
>> -		Does DISCARD forcibly in a period of given min_discard_issue_time when the number
>> -		of discards is not 0 and set discard granularity to 1.
>> -		Default: 80
>> -
>> -What:		/sys/fs/f2fs/<disk>/hot_data_age_threshold
>> -Date:		November 2022
>> -Contact:	"Ping Xiong" <xiongping1@xiaomi.com>
>> -Description:	When DATA SEPARATION is on, it controls the age threshold to indicate
>> -		the data blocks as hot. By default it was initialized as 262144 blocks
>> -		(equals to 1GB).
>> -
>> -What:		/sys/fs/f2fs/<disk>/warm_data_age_threshold
>> -Date:		November 2022
>> -Contact:	"Ping Xiong" <xiongping1@xiaomi.com>
>> -Description:	When DATA SEPARATION is on, it controls the age threshold to indicate
>> -		the data blocks as warm. By default it was initialized as 2621440 blocks
>> -		(equals to 10GB).
> 
> Why delete other node descriptions, mistake?

Oh, my bad, I missed to handle merge confilct correctly, will
fix in v2.

Thanks,

> 
> Thx,
> Yangtao