xref: /linux/Documentation/ABI/testing/sysfs-fs-f2fs (revision a4db59ac9058207cea77df7d7893aab5c3009f87)
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
34*a4db59acSJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/max_blkaddr
35*a4db59acSJaegeuk KimDate:		November 2019
36*a4db59acSJaegeuk KimContact:	"Ramon Pantin" <pantin@google.com>
37*a4db59acSJaegeuk KimDescription:
38*a4db59acSJaegeuk Kim		 Shows first block address of MAIN area.
39*a4db59acSJaegeuk Kim
403bac380cSJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/ipu_policy
413bac380cSJaegeuk KimDate:		November 2013
423bac380cSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk.kim@samsung.com>
433bac380cSJaegeuk KimDescription:
443bac380cSJaegeuk Kim		 Controls the in-place-update policy.
453bac380cSJaegeuk Kim
463bac380cSJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/min_ipu_util
473bac380cSJaegeuk KimDate:		November 2013
483bac380cSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk.kim@samsung.com>
493bac380cSJaegeuk KimDescription:
503bac380cSJaegeuk Kim		 Controls the FS utilization condition for the in-place-update
513bac380cSJaegeuk Kim		 policies.
523bac380cSJaegeuk Kim
53c1ce1b02SJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/min_fsync_blocks
54c1ce1b02SJaegeuk KimDate:		September 2014
55c1ce1b02SJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
56c1ce1b02SJaegeuk KimDescription:
57c1ce1b02SJaegeuk Kim		 Controls the dirty page count condition for the in-place-update
58c1ce1b02SJaegeuk Kim		 policies.
59c1ce1b02SJaegeuk Kim
60853137ceSJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/min_seq_blocks
61853137ceSJaegeuk KimDate:		August 2018
62853137ceSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
63853137ceSJaegeuk KimDescription:
64853137ceSJaegeuk Kim		 Controls the dirty page count condition for batched sequential
65853137ceSJaegeuk Kim		 writes in ->writepages.
66853137ceSJaegeuk Kim
67853137ceSJaegeuk Kim
68b32d73abSChao YuWhat:		/sys/fs/f2fs/<disk>/min_hot_blocks
69b32d73abSChao YuDate:		March 2017
70b32d73abSChao YuContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
71b32d73abSChao YuDescription:
72b32d73abSChao Yu		 Controls the dirty page count condition for redefining hot data.
73b32d73abSChao Yu
74a2a12b67SChao YuWhat:		/sys/fs/f2fs/<disk>/min_ssr_sections
75a2a12b67SChao YuDate:		October 2017
76a2a12b67SChao YuContact:	"Chao Yu" <yuchao0@huawei.com>
77a2a12b67SChao YuDescription:
78a2a12b67SChao Yu		 Controls the fee section threshold to trigger SSR allocation.
79a2a12b67SChao Yu
803bac380cSJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/max_small_discards
813bac380cSJaegeuk KimDate:		November 2013
823bac380cSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk.kim@samsung.com>
833bac380cSJaegeuk KimDescription:
843bac380cSJaegeuk Kim		 Controls the issue rate of small discard commands.
853bac380cSJaegeuk Kim
86969d1b18SChao YuWhat:          /sys/fs/f2fs/<disk>/discard_granularity
87969d1b18SChao YuDate:          July 2017
88969d1b18SChao YuContact:       "Chao Yu" <yuchao0@huawei.com>
89969d1b18SChao YuDescription:
90969d1b18SChao Yu		Controls discard granularity of inner discard thread, inner thread
91969d1b18SChao Yu		will not issue discards with size that is smaller than granularity.
92969d1b18SChao Yu		The unit size is one block, now only support configuring in range
93969d1b18SChao Yu		of [1, 512].
94969d1b18SChao Yu
9503f2c02dSJaegeuk KimWhat:          /sys/fs/f2fs/<disk>/umount_discard_timeout
9603f2c02dSJaegeuk KimDate:          January 2019
9703f2c02dSJaegeuk KimContact:       "Jaegeuk Kim" <jaegeuk@kernel.org>
9803f2c02dSJaegeuk KimDescription:
9903f2c02dSJaegeuk Kim		Set timeout to issue discard commands during umount.
10003f2c02dSJaegeuk Kim		Default: 5 secs
10103f2c02dSJaegeuk Kim
1023bac380cSJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/max_victim_search
1033bac380cSJaegeuk KimDate:		January 2014
1043bac380cSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk.kim@samsung.com>
1053bac380cSJaegeuk KimDescription:
1063bac380cSJaegeuk Kim		 Controls the number of trials to find a victim segment.
107cdfc41c1SJaegeuk Kim
10834655575SChao YuWhat:		/sys/fs/f2fs/<disk>/migration_granularity
10934655575SChao YuDate:		October 2018
11034655575SChao YuContact:	"Chao Yu" <yuchao0@huawei.com>
11134655575SChao YuDescription:
11234655575SChao Yu		 Controls migration granularity of garbage collection on large
11334655575SChao Yu		 section, it can let GC move partial segment{s} of one section
11434655575SChao Yu		 in one GC cycle, so that dispersing heavy overhead GC to
11534655575SChao Yu		 multiple lightweight one.
11634655575SChao Yu
11791796825SJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/dir_level
11891796825SJaegeuk KimDate:		March 2014
11991796825SJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk.kim@samsung.com>
12091796825SJaegeuk KimDescription:
12191796825SJaegeuk Kim		 Controls the directory level for large directory.
12291796825SJaegeuk Kim
123cdfc41c1SJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/ram_thresh
124cdfc41c1SJaegeuk KimDate:		March 2014
125cdfc41c1SJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk.kim@samsung.com>
126cdfc41c1SJaegeuk KimDescription:
127cdfc41c1SJaegeuk Kim		 Controls the memory footprint used by f2fs.
128bba681cbSJaegeuk Kim
1296f6d9fe2SChao YuWhat:		/sys/fs/f2fs/<disk>/batched_trim_sections
130bba681cbSJaegeuk KimDate:		February 2015
131bba681cbSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
132bba681cbSJaegeuk KimDescription:
133bba681cbSJaegeuk Kim		 Controls the trimming rate in batch mode.
134377224c4SChao Yu		 <deprecated>
13560b99b48SJaegeuk Kim
13660b99b48SJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/cp_interval
13760b99b48SJaegeuk KimDate:		October 2015
13860b99b48SJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
13960b99b48SJaegeuk KimDescription:
14060b99b48SJaegeuk Kim		 Controls the checkpoint timing.
141ea1a29a0SChao Yu
142d0239e1bSJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/idle_interval
143d0239e1bSJaegeuk KimDate:		January 2016
144d0239e1bSJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
145d0239e1bSJaegeuk KimDescription:
146a7d10cf3SSahitya Tummala		 Controls the idle timing for all paths other than
147a7d10cf3SSahitya Tummala		 discard and gc path.
148a7d10cf3SSahitya Tummala
149a7d10cf3SSahitya TummalaWhat:		/sys/fs/f2fs/<disk>/discard_idle_interval
150a7d10cf3SSahitya TummalaDate:		September 2018
151a7d10cf3SSahitya TummalaContact:	"Chao Yu" <yuchao0@huawei.com>
152a7d10cf3SSahitya TummalaContact:	"Sahitya Tummala" <stummala@codeaurora.org>
153a7d10cf3SSahitya TummalaDescription:
154a7d10cf3SSahitya Tummala		 Controls the idle timing for discard path.
155a7d10cf3SSahitya Tummala
156a7d10cf3SSahitya TummalaWhat:		/sys/fs/f2fs/<disk>/gc_idle_interval
157a7d10cf3SSahitya TummalaDate:		September 2018
158a7d10cf3SSahitya TummalaContact:	"Chao Yu" <yuchao0@huawei.com>
159a7d10cf3SSahitya TummalaContact:	"Sahitya Tummala" <stummala@codeaurora.org>
160a7d10cf3SSahitya TummalaDescription:
161a7d10cf3SSahitya Tummala		 Controls the idle timing for gc path.
162d0239e1bSJaegeuk Kim
163b32d73abSChao YuWhat:		/sys/fs/f2fs/<disk>/iostat_enable
164b32d73abSChao YuDate:		August 2017
165b32d73abSChao YuContact:	"Chao Yu" <yuchao0@huawei.com>
166b32d73abSChao YuDescription:
167b32d73abSChao Yu		 Controls to enable/disable IO stat.
168b32d73abSChao Yu
169ea1a29a0SChao YuWhat:		/sys/fs/f2fs/<disk>/ra_nid_pages
170ea1a29a0SChao YuDate:		October 2015
171ea1a29a0SChao YuContact:	"Chao Yu" <chao2.yu@samsung.com>
172ea1a29a0SChao YuDescription:
173ea1a29a0SChao Yu		 Controls the count of nid pages to be readaheaded.
1742304cb0cSChao Yu
1752304cb0cSChao YuWhat:		/sys/fs/f2fs/<disk>/dirty_nats_ratio
1762304cb0cSChao YuDate:		January 2016
1772304cb0cSChao YuContact:	"Chao Yu" <chao2.yu@samsung.com>
1782304cb0cSChao YuDescription:
1792304cb0cSChao Yu		 Controls dirty nat entries ratio threshold, if current
1802304cb0cSChao Yu		 ratio exceeds configured threshold, checkpoint will
1812304cb0cSChao Yu		 be triggered for flushing dirty nat entries.
1828f1dbbbbSShuoran Liu
1838f1dbbbbSShuoran LiuWhat:		/sys/fs/f2fs/<disk>/lifetime_write_kbytes
1848f1dbbbbSShuoran LiuDate:		January 2016
1858f1dbbbbSShuoran LiuContact:	"Shuoran Liu" <liushuoran@huawei.com>
1868f1dbbbbSShuoran LiuDescription:
1878f1dbbbbSShuoran Liu		 Shows total written kbytes issued to disk.
18856412894SChao Yu
1899ac19faaSEric BiggersWhat:		/sys/fs/f2fs/<disk>/features
190b32d73abSChao YuDate:		July 2017
191b32d73abSChao YuContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
192b32d73abSChao YuDescription:
193b32d73abSChao Yu		 Shows all enabled features in current device.
194b32d73abSChao Yu
19556412894SChao YuWhat:		/sys/fs/f2fs/<disk>/inject_rate
19656412894SChao YuDate:		May 2016
19756412894SChao YuContact:	"Sheng Yong" <shengyong1@huawei.com>
19856412894SChao YuDescription:
19956412894SChao Yu		 Controls the injection rate.
20056412894SChao Yu
20156412894SChao YuWhat:		/sys/fs/f2fs/<disk>/inject_type
20256412894SChao YuDate:		May 2016
20356412894SChao YuContact:	"Sheng Yong" <shengyong1@huawei.com>
20456412894SChao YuDescription:
20556412894SChao Yu		 Controls the injection type.
206daeb433eSChao Yu
207daeb433eSChao YuWhat:		/sys/fs/f2fs/<disk>/reserved_blocks
208daeb433eSChao YuDate:		June 2017
209daeb433eSChao YuContact:	"Chao Yu" <yuchao0@huawei.com>
210daeb433eSChao YuDescription:
21180d42145SYunlong Song		 Controls target reserved blocks in system, the threshold
21280d42145SYunlong Song		 is soft, it could exceed current available user space.
21380d42145SYunlong Song
21480d42145SYunlong SongWhat:		/sys/fs/f2fs/<disk>/current_reserved_blocks
21580d42145SYunlong SongDate:		October 2017
21680d42145SYunlong SongContact:	"Yunlong Song" <yunlong.song@huawei.com>
21780d42145SYunlong SongContact:	"Chao Yu" <yuchao0@huawei.com>
21880d42145SYunlong SongDescription:
21980d42145SYunlong Song		 Shows current reserved blocks in system, it may be temporarily
22080d42145SYunlong Song		 smaller than target_reserved_blocks, but will gradually
22180d42145SYunlong Song		 increase to target_reserved_blocks when more free blocks are
22280d42145SYunlong Song		 freed by user later.
223d9872a69SJaegeuk Kim
224d9872a69SJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/gc_urgent
225d9872a69SJaegeuk KimDate:		August 2017
226d9872a69SJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
227d9872a69SJaegeuk KimDescription:
228d9872a69SJaegeuk Kim		 Do background GC agressively
229d9872a69SJaegeuk Kim
230d9872a69SJaegeuk KimWhat:		/sys/fs/f2fs/<disk>/gc_urgent_sleep_time
231d9872a69SJaegeuk KimDate:		August 2017
232d9872a69SJaegeuk KimContact:	"Jaegeuk Kim" <jaegeuk@kernel.org>
233d9872a69SJaegeuk KimDescription:
234d9872a69SJaegeuk Kim		 Controls sleep time of GC urgent mode
235f6df8f23SSheng Yong
236f6df8f23SSheng YongWhat:		/sys/fs/f2fs/<disk>/readdir_ra
237f6df8f23SSheng YongDate:		November 2017
238f6df8f23SSheng YongContact:	"Sheng Yong" <shengyong1@huawei.com>
239f6df8f23SSheng YongDescription:
240f6df8f23SSheng Yong		 Controls readahead inode block in readdir.
241846ae671SChao Yu
242846ae671SChao YuWhat:		/sys/fs/f2fs/<disk>/extension_list
243846ae671SChao YuDate:		Feburary 2018
244846ae671SChao YuContact:	"Chao Yu" <yuchao0@huawei.com>
245846ae671SChao YuDescription:
246846ae671SChao Yu		 Used to control configure extension list:
247846ae671SChao Yu		 - Query: cat /sys/fs/f2fs/<disk>/extension_list
248b6a06cbbSChao Yu		 - Add: echo '[h/c]extension' > /sys/fs/f2fs/<disk>/extension_list
249b6a06cbbSChao Yu		 - Del: echo '[h/c]!extension' > /sys/fs/f2fs/<disk>/extension_list
250b6a06cbbSChao Yu		 - [h] means add/del hot file extension
251b6a06cbbSChao Yu		 - [c] means add/del cold file extension
2524d3aed70SDaniel Rosenberg
2534d3aed70SDaniel RosenbergWhat:		/sys/fs/f2fs/<disk>/unusable
2544d3aed70SDaniel RosenbergDate		April 2019
2554d3aed70SDaniel RosenbergContact:	"Daniel Rosenberg" <drosen@google.com>
2564d3aed70SDaniel RosenbergDescription:
2574d3aed70SDaniel Rosenberg		If checkpoint=disable, it displays the number of blocks that are unusable.
2584d3aed70SDaniel Rosenberg                If checkpoint=enable it displays the enumber of blocks that would be unusable
2594d3aed70SDaniel Rosenberg                if checkpoint=disable were to be set.
2605aba5430SDaniel Rosenberg
2615aba5430SDaniel RosenbergWhat:		/sys/fs/f2fs/<disk>/encoding
2625aba5430SDaniel RosenbergDate		July 2019
2635aba5430SDaniel RosenbergContact:	"Daniel Rosenberg" <drosen@google.com>
2645aba5430SDaniel RosenbergDescription:
2655aba5430SDaniel Rosenberg		Displays name and version of the encoding set for the filesystem.
2665aba5430SDaniel Rosenberg                If no encoding is set, displays (none)
267