xref: /linux/Documentation/ABI/testing/sysfs-fs-f2fs (revision 5aba54302a46fdd589040b928d5d010e5ace1234)
1b59d0baeSNamjae JeonWhat:		/sys/fs/f2fs/<disk>/gc_max_sleep_time
2b59d0baeSNamjae JeonDate:		July 2013
3b59d0baeSNamjae JeonContact:	"Namjae Jeon" <namjae.jeon@samsung.com>
4b59d0baeSNamjae JeonDescription:
5b59d0baeSNamjae Jeon		 Controls the maximun sleep time for gc_thread. Time
6b59d0baeSNamjae Jeon		 is in milliseconds.
7b59d0baeSNamjae Jeon
8b59d0baeSNamjae JeonWhat:		/sys/fs/f2fs/<disk>/gc_min_sleep_time
9b59d0baeSNamjae JeonDate:		July 2013
10b59d0baeSNamjae JeonContact:	"Namjae Jeon" <namjae.jeon@samsung.com>
11b59d0baeSNamjae JeonDescription:
12b59d0baeSNamjae Jeon		 Controls the minimum sleep time for gc_thread. Time
13b59d0baeSNamjae Jeon		 is in milliseconds.
14b59d0baeSNamjae Jeon
15b59d0baeSNamjae JeonWhat:		/sys/fs/f2fs/<disk>/gc_no_gc_sleep_time
16b59d0baeSNamjae JeonDate:		July 2013
17b59d0baeSNamjae JeonContact:	"Namjae Jeon" <namjae.jeon@samsung.com>
18b59d0baeSNamjae JeonDescription:
19b59d0baeSNamjae Jeon		 Controls the default sleep time for gc_thread. Time
20b59d0baeSNamjae Jeon		 is in milliseconds.
21d2dc095fSNamjae Jeon
22d2dc095fSNamjae JeonWhat:		/sys/fs/f2fs/<disk>/gc_idle
23d2dc095fSNamjae JeonDate:		July 2013
24d2dc095fSNamjae JeonContact:	"Namjae Jeon" <namjae.jeon@samsung.com>
25d2dc095fSNamjae JeonDescription:
26d2dc095fSNamjae Jeon		 Controls the victim selection policy for garbage collection.
273bac380cSJaegeuk Kim
283bac380cSJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/reclaim_segments
293bac380cSJaegeuk KimDate:		October 2013
303bac380cSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk.kim@samsung.com>
313bac380cSJaegeuk KimDescription:
323bac380cSJaegeuk Kim		 Controls the issue rate of segment discard commands.
333bac380cSJaegeuk Kim
343bac380cSJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/ipu_policy
353bac380cSJaegeuk KimDate:		November 2013
363bac380cSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk.kim@samsung.com>
373bac380cSJaegeuk KimDescription:
383bac380cSJaegeuk Kim		 Controls the in-place-update policy.
393bac380cSJaegeuk Kim
403bac380cSJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/min_ipu_util
413bac380cSJaegeuk KimDate:		November 2013
423bac380cSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk.kim@samsung.com>
433bac380cSJaegeuk KimDescription:
443bac380cSJaegeuk Kim		 Controls the FS utilization condition for the in-place-update
453bac380cSJaegeuk Kim		 policies.
463bac380cSJaegeuk Kim
47c1ce1b02SJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/min_fsync_blocks
48c1ce1b02SJaegeuk KimDate:		September 2014
49c1ce1b02SJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
50c1ce1b02SJaegeuk KimDescription:
51c1ce1b02SJaegeuk Kim		 Controls the dirty page count condition for the in-place-update
52c1ce1b02SJaegeuk Kim		 policies.
53c1ce1b02SJaegeuk Kim
54853137ceSJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/min_seq_blocks
55853137ceSJaegeuk KimDate:		August 2018
56853137ceSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
57853137ceSJaegeuk KimDescription:
58853137ceSJaegeuk Kim		 Controls the dirty page count condition for batched sequential
59853137ceSJaegeuk Kim		 writes in ->writepages.
60853137ceSJaegeuk Kim
61853137ceSJaegeuk Kim
62b32d73abSChao YuWhat:		/sys/fs/f2fs/<disk>/min_hot_blocks
63b32d73abSChao YuDate:		March 2017
64b32d73abSChao YuContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
65b32d73abSChao YuDescription:
66b32d73abSChao Yu		 Controls the dirty page count condition for redefining hot data.
67b32d73abSChao Yu
68a2a12b67SChao YuWhat:		/sys/fs/f2fs/<disk>/min_ssr_sections
69a2a12b67SChao YuDate:		October 2017
70a2a12b67SChao YuContact:	"Chao Yu" <yuchao0@huawei.com>
71a2a12b67SChao YuDescription:
72a2a12b67SChao Yu		 Controls the fee section threshold to trigger SSR allocation.
73a2a12b67SChao Yu
743bac380cSJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/max_small_discards
753bac380cSJaegeuk KimDate:		November 2013
763bac380cSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk.kim@samsung.com>
773bac380cSJaegeuk KimDescription:
783bac380cSJaegeuk Kim		 Controls the issue rate of small discard commands.
793bac380cSJaegeuk Kim
80969d1b18SChao YuWhat:          /sys/fs/f2fs/<disk>/discard_granularity
81969d1b18SChao YuDate:          July 2017
82969d1b18SChao YuContact:       "Chao Yu" <yuchao0@huawei.com>
83969d1b18SChao YuDescription:
84969d1b18SChao Yu		Controls discard granularity of inner discard thread, inner thread
85969d1b18SChao Yu		will not issue discards with size that is smaller than granularity.
86969d1b18SChao Yu		The unit size is one block, now only support configuring in range
87969d1b18SChao Yu		of [1, 512].
88969d1b18SChao Yu
8903f2c02dSJaegeuk KimWhat:          /sys/fs/f2fs/<disk>/umount_discard_timeout
9003f2c02dSJaegeuk KimDate:          January 2019
9103f2c02dSJaegeuk KimContact:       "Jaegeuk Kim" <jaegeuk@kernel.org>
9203f2c02dSJaegeuk KimDescription:
9303f2c02dSJaegeuk Kim		Set timeout to issue discard commands during umount.
9403f2c02dSJaegeuk Kim		Default: 5 secs
9503f2c02dSJaegeuk Kim
963bac380cSJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/max_victim_search
973bac380cSJaegeuk KimDate:		January 2014
983bac380cSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk.kim@samsung.com>
993bac380cSJaegeuk KimDescription:
1003bac380cSJaegeuk Kim		 Controls the number of trials to find a victim segment.
101cdfc41c1SJaegeuk Kim
10234655575SChao YuWhat:		/sys/fs/f2fs/<disk>/migration_granularity
10334655575SChao YuDate:		October 2018
10434655575SChao YuContact:	"Chao Yu" <yuchao0@huawei.com>
10534655575SChao YuDescription:
10634655575SChao Yu		 Controls migration granularity of garbage collection on large
10734655575SChao Yu		 section, it can let GC move partial segment{s} of one section
10834655575SChao Yu		 in one GC cycle, so that dispersing heavy overhead GC to
10934655575SChao Yu		 multiple lightweight one.
11034655575SChao Yu
11191796825SJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/dir_level
11291796825SJaegeuk KimDate:		March 2014
11391796825SJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk.kim@samsung.com>
11491796825SJaegeuk KimDescription:
11591796825SJaegeuk Kim		 Controls the directory level for large directory.
11691796825SJaegeuk Kim
117cdfc41c1SJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/ram_thresh
118cdfc41c1SJaegeuk KimDate:		March 2014
119cdfc41c1SJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk.kim@samsung.com>
120cdfc41c1SJaegeuk KimDescription:
121cdfc41c1SJaegeuk Kim		 Controls the memory footprint used by f2fs.
122bba681cbSJaegeuk Kim
1236f6d9fe2SChao YuWhat:		/sys/fs/f2fs/<disk>/batched_trim_sections
124bba681cbSJaegeuk KimDate:		February 2015
125bba681cbSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
126bba681cbSJaegeuk KimDescription:
127bba681cbSJaegeuk Kim		 Controls the trimming rate in batch mode.
128377224c4SChao Yu		 <deprecated>
12960b99b48SJaegeuk Kim
13060b99b48SJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/cp_interval
13160b99b48SJaegeuk KimDate:		October 2015
13260b99b48SJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
13360b99b48SJaegeuk KimDescription:
13460b99b48SJaegeuk Kim		 Controls the checkpoint timing.
135ea1a29a0SChao Yu
136d0239e1bSJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/idle_interval
137d0239e1bSJaegeuk KimDate:		January 2016
138d0239e1bSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
139d0239e1bSJaegeuk KimDescription:
140a7d10cf3SSahitya Tummala		 Controls the idle timing for all paths other than
141a7d10cf3SSahitya Tummala		 discard and gc path.
142a7d10cf3SSahitya Tummala
143a7d10cf3SSahitya TummalaWhat:		/sys/fs/f2fs/<disk>/discard_idle_interval
144a7d10cf3SSahitya TummalaDate:		September 2018
145a7d10cf3SSahitya TummalaContact:	"Chao Yu" <yuchao0@huawei.com>
146a7d10cf3SSahitya TummalaContact:	"Sahitya Tummala" <stummala@codeaurora.org>
147a7d10cf3SSahitya TummalaDescription:
148a7d10cf3SSahitya Tummala		 Controls the idle timing for discard path.
149a7d10cf3SSahitya Tummala
150a7d10cf3SSahitya TummalaWhat:		/sys/fs/f2fs/<disk>/gc_idle_interval
151a7d10cf3SSahitya TummalaDate:		September 2018
152a7d10cf3SSahitya TummalaContact:	"Chao Yu" <yuchao0@huawei.com>
153a7d10cf3SSahitya TummalaContact:	"Sahitya Tummala" <stummala@codeaurora.org>
154a7d10cf3SSahitya TummalaDescription:
155a7d10cf3SSahitya Tummala		 Controls the idle timing for gc path.
156d0239e1bSJaegeuk Kim
157b32d73abSChao YuWhat:		/sys/fs/f2fs/<disk>/iostat_enable
158b32d73abSChao YuDate:		August 2017
159b32d73abSChao YuContact:	"Chao Yu" <yuchao0@huawei.com>
160b32d73abSChao YuDescription:
161b32d73abSChao Yu		 Controls to enable/disable IO stat.
162b32d73abSChao Yu
163ea1a29a0SChao YuWhat:		/sys/fs/f2fs/<disk>/ra_nid_pages
164ea1a29a0SChao YuDate:		October 2015
165ea1a29a0SChao YuContact:	"Chao Yu" <chao2.yu@samsung.com>
166ea1a29a0SChao YuDescription:
167ea1a29a0SChao Yu		 Controls the count of nid pages to be readaheaded.
1682304cb0cSChao Yu
1692304cb0cSChao YuWhat:		/sys/fs/f2fs/<disk>/dirty_nats_ratio
1702304cb0cSChao YuDate:		January 2016
1712304cb0cSChao YuContact:	"Chao Yu" <chao2.yu@samsung.com>
1722304cb0cSChao YuDescription:
1732304cb0cSChao Yu		 Controls dirty nat entries ratio threshold, if current
1742304cb0cSChao Yu		 ratio exceeds configured threshold, checkpoint will
1752304cb0cSChao Yu		 be triggered for flushing dirty nat entries.
1768f1dbbbbSShuoran Liu
1778f1dbbbbSShuoran LiuWhat:		/sys/fs/f2fs/<disk>/lifetime_write_kbytes
1788f1dbbbbSShuoran LiuDate:		January 2016
1798f1dbbbbSShuoran LiuContact:	"Shuoran Liu" <liushuoran@huawei.com>
1808f1dbbbbSShuoran LiuDescription:
1818f1dbbbbSShuoran Liu		 Shows total written kbytes issued to disk.
18256412894SChao Yu
1839ac19faaSEric BiggersWhat:		/sys/fs/f2fs/<disk>/features
184b32d73abSChao YuDate:		July 2017
185b32d73abSChao YuContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
186b32d73abSChao YuDescription:
187b32d73abSChao Yu		 Shows all enabled features in current device.
188b32d73abSChao Yu
18956412894SChao YuWhat:		/sys/fs/f2fs/<disk>/inject_rate
19056412894SChao YuDate:		May 2016
19156412894SChao YuContact:	"Sheng Yong" <shengyong1@huawei.com>
19256412894SChao YuDescription:
19356412894SChao Yu		 Controls the injection rate.
19456412894SChao Yu
19556412894SChao YuWhat:		/sys/fs/f2fs/<disk>/inject_type
19656412894SChao YuDate:		May 2016
19756412894SChao YuContact:	"Sheng Yong" <shengyong1@huawei.com>
19856412894SChao YuDescription:
19956412894SChao Yu		 Controls the injection type.
200daeb433eSChao Yu
201daeb433eSChao YuWhat:		/sys/fs/f2fs/<disk>/reserved_blocks
202daeb433eSChao YuDate:		June 2017
203daeb433eSChao YuContact:	"Chao Yu" <yuchao0@huawei.com>
204daeb433eSChao YuDescription:
20580d42145SYunlong Song		 Controls target reserved blocks in system, the threshold
20680d42145SYunlong Song		 is soft, it could exceed current available user space.
20780d42145SYunlong Song
20880d42145SYunlong SongWhat:		/sys/fs/f2fs/<disk>/current_reserved_blocks
20980d42145SYunlong SongDate:		October 2017
21080d42145SYunlong SongContact:	"Yunlong Song" <yunlong.song@huawei.com>
21180d42145SYunlong SongContact:	"Chao Yu" <yuchao0@huawei.com>
21280d42145SYunlong SongDescription:
21380d42145SYunlong Song		 Shows current reserved blocks in system, it may be temporarily
21480d42145SYunlong Song		 smaller than target_reserved_blocks, but will gradually
21580d42145SYunlong Song		 increase to target_reserved_blocks when more free blocks are
21680d42145SYunlong Song		 freed by user later.
217d9872a69SJaegeuk Kim
218d9872a69SJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/gc_urgent
219d9872a69SJaegeuk KimDate:		August 2017
220d9872a69SJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
221d9872a69SJaegeuk KimDescription:
222d9872a69SJaegeuk Kim		 Do background GC agressively
223d9872a69SJaegeuk Kim
224d9872a69SJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/gc_urgent_sleep_time
225d9872a69SJaegeuk KimDate:		August 2017
226d9872a69SJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
227d9872a69SJaegeuk KimDescription:
228d9872a69SJaegeuk Kim		 Controls sleep time of GC urgent mode
229f6df8f23SSheng Yong
230f6df8f23SSheng YongWhat:		/sys/fs/f2fs/<disk>/readdir_ra
231f6df8f23SSheng YongDate:		November 2017
232f6df8f23SSheng YongContact:	"Sheng Yong" <shengyong1@huawei.com>
233f6df8f23SSheng YongDescription:
234f6df8f23SSheng Yong		 Controls readahead inode block in readdir.
235846ae671SChao Yu
236846ae671SChao YuWhat:		/sys/fs/f2fs/<disk>/extension_list
237846ae671SChao YuDate:		Feburary 2018
238846ae671SChao YuContact:	"Chao Yu" <yuchao0@huawei.com>
239846ae671SChao YuDescription:
240846ae671SChao Yu		 Used to control configure extension list:
241846ae671SChao Yu		 - Query: cat /sys/fs/f2fs/<disk>/extension_list
242b6a06cbbSChao Yu		 - Add: echo '[h/c]extension' > /sys/fs/f2fs/<disk>/extension_list
243b6a06cbbSChao Yu		 - Del: echo '[h/c]!extension' > /sys/fs/f2fs/<disk>/extension_list
244b6a06cbbSChao Yu		 - [h] means add/del hot file extension
245b6a06cbbSChao Yu		 - [c] means add/del cold file extension
2464d3aed70SDaniel Rosenberg
2474d3aed70SDaniel RosenbergWhat:		/sys/fs/f2fs/<disk>/unusable
2484d3aed70SDaniel RosenbergDate		April 2019
2494d3aed70SDaniel RosenbergContact:	"Daniel Rosenberg" <drosen@google.com>
2504d3aed70SDaniel RosenbergDescription:
2514d3aed70SDaniel Rosenberg		If checkpoint=disable, it displays the number of blocks that are unusable.
2524d3aed70SDaniel Rosenberg                If checkpoint=enable it displays the enumber of blocks that would be unusable
2534d3aed70SDaniel Rosenberg                if checkpoint=disable were to be set.
254*5aba5430SDaniel Rosenberg
255*5aba5430SDaniel RosenbergWhat:		/sys/fs/f2fs/<disk>/encoding
256*5aba5430SDaniel RosenbergDate		July 2019
257*5aba5430SDaniel RosenbergContact:	"Daniel Rosenberg" <drosen@google.com>
258*5aba5430SDaniel RosenbergDescription:
259*5aba5430SDaniel Rosenberg		Displays name and version of the encoding set for the filesystem.
260*5aba5430SDaniel Rosenberg                If no encoding is set, displays (none)
261