Documentation/ABI/testing/sysfs-fs-f2fs

   1 What:           /sys/fs/f2fs/<disk>/gc_max_sleep_time
   2 Date:           July 2013
   3 Contact:        "Namjae Jeon" <namjae.jeon@samsung.com>
   4 Description:    Controls the maximum sleep time for gc_thread. Time
   5                 is in milliseconds.
   6
   7 What:           /sys/fs/f2fs/<disk>/gc_min_sleep_time
   8 Date:           July 2013
   9 Contact:        "Namjae Jeon" <namjae.jeon@samsung.com>
  10 Description:    Controls the minimum sleep time for gc_thread. Time
  11                 is in milliseconds.
  12
  13 What:           /sys/fs/f2fs/<disk>/gc_no_gc_sleep_time
  14 Date:           July 2013
  15 Contact:        "Namjae Jeon" <namjae.jeon@samsung.com>
  16 Description:    Controls the default sleep time for gc_thread. Time
  17                 is in milliseconds.
  18
  19 What:           /sys/fs/f2fs/<disk>/gc_idle
  20 Date:           July 2013
  21 Contact:        "Namjae Jeon" <namjae.jeon@samsung.com>
  22 Description:    Controls the victim selection policy for garbage collection.
  23                 Setting gc_idle = 0(default) will disable this option. Setting
  24                 gc_idle = 1 will select the Cost Benefit approach & setting
  25                 gc_idle = 2 will select the greedy approach.
  26
  27 What:           /sys/fs/f2fs/<disk>/reclaim_segments
  28 Date:           October 2013
  29 Contact:        "Jaegeuk Kim" <jaegeuk.kim@samsung.com>
  30 Description:    This parameter controls the number of prefree segments to be
  31                 reclaimed. If the number of prefree segments is larger than
  32                 the number of segments in the proportion to the percentage
  33                 over total volume size, f2fs tries to conduct checkpoint to
  34                 reclaim the prefree segments to free segments.
  35                 By default, 5% over total # of segments.
  36
  37 What:           /sys/fs/f2fs/<disk>/main_blkaddr
  38 Date:           November 2019
  39 Contact:        "Ramon Pantin" <pantin@google.com>
  40 Description:
  41                  Shows first block address of MAIN area.
  42
  43 What:           /sys/fs/f2fs/<disk>/ipu_policy
  44 Date:           November 2013
  45 Contact:        "Jaegeuk Kim" <jaegeuk.kim@samsung.com>
  46 Description:    Controls the in-place-update policy.
  47                 updates in f2fs. User can set:
  48                 0x01: F2FS_IPU_FORCE, 0x02: F2FS_IPU_SSR,
  49                 0x04: F2FS_IPU_UTIL,  0x08: F2FS_IPU_SSR_UTIL,
  50                 0x10: F2FS_IPU_FSYNC, 0x20: F2FS_IPU_ASYNC,
  51                 0x40: F2FS_IPU_NOCACHE.
  52                 Refer segment.h for details.
  53
  54 What:           /sys/fs/f2fs/<disk>/min_ipu_util
  55 Date:           November 2013
  56 Contact:        "Jaegeuk Kim" <jaegeuk.kim@samsung.com>
  57 Description:    Controls the FS utilization condition for the in-place-update
  58                 policies. It is used by F2FS_IPU_UTIL and F2FS_IPU_SSR_UTIL policies.
  59
  60 What:           /sys/fs/f2fs/<disk>/min_fsync_blocks
  61 Date:           September 2014
  62 Contact:        "Jaegeuk Kim" <jaegeuk@kernel.org>
  63 Description:    Controls the dirty page count condition for the in-place-update
  64                 policies.
  65
  66 What:           /sys/fs/f2fs/<disk>/min_seq_blocks
  67 Date:           August 2018
  68 Contact:        "Jaegeuk Kim" <jaegeuk@kernel.org>
  69 Description:    Controls the dirty page count condition for batched sequential
  70                 writes in writepages.
  71
  72 What:           /sys/fs/f2fs/<disk>/min_hot_blocks
  73 Date:           March 2017
  74 Contact:        "Jaegeuk Kim" <jaegeuk@kernel.org>
  75 Description:    Controls the dirty page count condition for redefining hot data.
  76
  77 What:           /sys/fs/f2fs/<disk>/min_ssr_sections
  78 Date:           October 2017
  79 Contact:        "Chao Yu" <yuchao0@huawei.com>
  80 Description:    Controls the free section threshold to trigger SSR allocation.
  81                 If this is large, SSR mode will be enabled early.
  82
  83 What:           /sys/fs/f2fs/<disk>/max_small_discards
  84 Date:           November 2013
  85 Contact:        "Jaegeuk Kim" <jaegeuk.kim@samsung.com>
  86 Description:    Controls the issue rate of discard commands that consist of small
  87                 blocks less than 2MB. The candidates to be discarded are cached until
  88                 checkpoint is triggered, and issued during the checkpoint.
  89                 By default, it is disabled with 0.
  90
  91 What:           /sys/fs/f2fs/<disk>/discard_granularity
  92 Date:           July 2017
  93 Contact:        "Chao Yu" <yuchao0@huawei.com>
  94 Description:    Controls discard granularity of inner discard thread. Inner thread
  95                 will not issue discards with size that is smaller than granularity.
  96                 The unit size is one block(4KB), now only support configuring
  97                 in range of [1, 512]. Default value is 4(=16KB).
  98
  99 What:           /sys/fs/f2fs/<disk>/umount_discard_timeout
 100 Date:           January 2019
 101 Contact:        "Jaegeuk Kim" <jaegeuk@kernel.org>
 102 Description:    Set timeout to issue discard commands during umount.
 103                 Default: 5 secs
 104
 105 What:           /sys/fs/f2fs/<disk>/max_victim_search
 106 Date:           January 2014
 107 Contact:        "Jaegeuk Kim" <jaegeuk.kim@samsung.com>
 108 Description:    Controls the number of trials to find a victim segment
 109                 when conducting SSR and cleaning operations. The default value
 110                 is 4096 which covers 8GB block address range.
 111
 112 What:           /sys/fs/f2fs/<disk>/migration_granularity
 113 Date:           October 2018
 114 Contact:        "Chao Yu" <yuchao0@huawei.com>
 115 Description:    Controls migration granularity of garbage collection on large
 116                 section, it can let GC move partial segment{s} of one section
 117                 in one GC cycle, so that dispersing heavy overhead GC to
 118                 multiple lightweight one.
 119
 120 What:           /sys/fs/f2fs/<disk>/dir_level
 121 Date:           March 2014
 122 Contact:        "Jaegeuk Kim" <jaegeuk.kim@samsung.com>
 123 Description:    Controls the directory level for large directory. If a
 124                 directory has a number of files, it can reduce the file lookup
 125                 latency by increasing this dir_level value. Otherwise, it
 126                 needs to decrease this value to reduce the space overhead.
 127                 The default value is 0.
 128
 129 What:           /sys/fs/f2fs/<disk>/ram_thresh
 130 Date:           March 2014
 131 Contact:        "Jaegeuk Kim" <jaegeuk.kim@samsung.com>
 132 Description:    Controls the memory footprint used by free nids and cached
 133                 nat entries. By default, 1 is set, which indicates
 134                 10 MB / 1 GB RAM.
 135
 136 What:           /sys/fs/f2fs/<disk>/batched_trim_sections
 137 Date:           February 2015
 138 Contact:        "Jaegeuk Kim" <jaegeuk@kernel.org>
 139 Description:    Controls the trimming rate in batch mode.
 140                 <deprecated>
 141
 142 What:           /sys/fs/f2fs/<disk>/cp_interval
 143 Date:           October 2015
 144 Contact:        "Jaegeuk Kim" <jaegeuk@kernel.org>
 145 Description:    Controls the checkpoint timing, set to 60 seconds by default.
 146
 147 What:           /sys/fs/f2fs/<disk>/idle_interval
 148 Date:           January 2016
 149 Contact:        "Jaegeuk Kim" <jaegeuk@kernel.org>
 150 Description:    Controls the idle timing of system, if there is no FS operation
 151                 during given interval.
 152                 Set to 5 seconds by default.
 153
 154 What:           /sys/fs/f2fs/<disk>/discard_idle_interval
 155 Date:           September 2018
 156 Contact:        "Chao Yu" <yuchao0@huawei.com>
 157 Contact:        "Sahitya Tummala" <stummala@codeaurora.org>
 158 Description:    Controls the idle timing of discard thread given
 159                 this time interval.
 160                 Default is 5 secs.
 161
 162 What:           /sys/fs/f2fs/<disk>/gc_idle_interval
 163 Date:           September 2018
 164 Contact:        "Chao Yu" <yuchao0@huawei.com>
 165 Contact:        "Sahitya Tummala" <stummala@codeaurora.org>
 166 Description:    Controls the idle timing for gc path. Set to 5 seconds by default.
 167
 168 What:           /sys/fs/f2fs/<disk>/iostat_enable
 169 Date:           August 2017
 170 Contact:        "Chao Yu" <yuchao0@huawei.com>
 171 Description:    Controls to enable/disable IO stat.
 172
 173 What:           /sys/fs/f2fs/<disk>/ra_nid_pages
 174 Date:           October 2015
 175 Contact:        "Chao Yu" <chao2.yu@samsung.com>
 176 Description:    Controls the count of nid pages to be readaheaded.
 177                 When building free nids, F2FS reads NAT blocks ahead for
 178                 speed up. Default is 0.
 179
 180 What:           /sys/fs/f2fs/<disk>/dirty_nats_ratio
 181 Date:           January 2016
 182 Contact:        "Chao Yu" <chao2.yu@samsung.com>
 183 Description:    Controls dirty nat entries ratio threshold, if current
 184                 ratio exceeds configured threshold, checkpoint will
 185                 be triggered for flushing dirty nat entries.
 186
 187 What:           /sys/fs/f2fs/<disk>/lifetime_write_kbytes
 188 Date:           January 2016
 189 Contact:        "Shuoran Liu" <liushuoran@huawei.com>
 190 Description:    Shows total written kbytes issued to disk.
 191
 192 What:           /sys/fs/f2fs/<disk>/features
 193 Date:           July 2017
 194 Contact:        "Jaegeuk Kim" <jaegeuk@kernel.org>
 195 Description:    Shows all enabled features in current device.
 196
 197 What:           /sys/fs/f2fs/<disk>/inject_rate
 198 Date:           May 2016
 199 Contact:        "Sheng Yong" <shengyong1@huawei.com>
 200 Description:    Controls the injection rate of arbitrary faults.
 201
 202 What:           /sys/fs/f2fs/<disk>/inject_type
 203 Date:           May 2016
 204 Contact:        "Sheng Yong" <shengyong1@huawei.com>
 205 Description:    Controls the injection type of arbitrary faults.
 206
 207 What:           /sys/fs/f2fs/<disk>/dirty_segments
 208 Date:           October 2017
 209 Contact:        "Jaegeuk Kim" <jaegeuk@kernel.org>
 210 Description:    Shows the number of dirty segments.
 211
 212 What:           /sys/fs/f2fs/<disk>/reserved_blocks
 213 Date:           June 2017
 214 Contact:        "Chao Yu" <yuchao0@huawei.com>
 215 Description:    Controls target reserved blocks in system, the threshold
 216                 is soft, it could exceed current available user space.
 217
 218 What:           /sys/fs/f2fs/<disk>/current_reserved_blocks
 219 Date:           October 2017
 220 Contact:        "Yunlong Song" <yunlong.song@huawei.com>
 221 Contact:        "Chao Yu" <yuchao0@huawei.com>
 222 Description:    Shows current reserved blocks in system, it may be temporarily
 223                 smaller than target_reserved_blocks, but will gradually
 224                 increase to target_reserved_blocks when more free blocks are
 225                 freed by user later.
 226
 227 What:           /sys/fs/f2fs/<disk>/gc_urgent
 228 Date:           August 2017
 229 Contact:        "Jaegeuk Kim" <jaegeuk@kernel.org>
 230 Description:    Do background GC agressively when set. When gc_urgent = 1,
 231                 background thread starts to do GC by given gc_urgent_sleep_time
 232                 interval. It is set to 0 by default.
 233
 234 What:           /sys/fs/f2fs/<disk>/gc_urgent_sleep_time
 235 Date:           August 2017
 236 Contact:        "Jaegeuk Kim" <jaegeuk@kernel.org>
 237 Description:    Controls sleep time of GC urgent mode. Set to 500ms by default.
 238
 239 What:           /sys/fs/f2fs/<disk>/readdir_ra
 240 Date:           November 2017
 241 Contact:        "Sheng Yong" <shengyong1@huawei.com>
 242 Description:    Controls readahead inode block in readdir. Enabled by default.
 243
 244 What:           /sys/fs/f2fs/<disk>/gc_pin_file_thresh
 245 Date:           January 2018
 246 Contact:        Jaegeuk Kim <jaegeuk@kernel.org>
 247 Description:    This indicates how many GC can be failed for the pinned
 248                 file. If it exceeds this, F2FS doesn't guarantee its pinning
 249                 state. 2048 trials is set by default.
 250
 251 What:           /sys/fs/f2fs/<disk>/extension_list
 252 Date:           Feburary 2018
 253 Contact:        "Chao Yu" <yuchao0@huawei.com>
 254 Description:    Used to control configure extension list:
 255                 - Query: cat /sys/fs/f2fs/<disk>/extension_list
 256                 - Add: echo '[h/c]extension' > /sys/fs/f2fs/<disk>/extension_list
 257                 - Del: echo '[h/c]!extension' > /sys/fs/f2fs/<disk>/extension_list
 258                 - [h] means add/del hot file extension
 259                 - [c] means add/del cold file extension
 260
 261 What:           /sys/fs/f2fs/<disk>/unusable
 262 Date            April 2019
 263 Contact:        "Daniel Rosenberg" <drosen@google.com>
 264 Description:    If checkpoint=disable, it displays the number of blocks that
 265                 are unusable.
 266                 If checkpoint=enable it displays the enumber of blocks that
 267                 would be unusable if checkpoint=disable were to be set.
 268
 269 What:           /sys/fs/f2fs/<disk>/encoding
 270 Date            July 2019
 271 Contact:        "Daniel Rosenberg" <drosen@google.com>
 272 Description:    Displays name and version of the encoding set for the filesystem.
 273                 If no encoding is set, displays (none)
 274
 275 What:           /sys/fs/f2fs/<disk>/free_segments
 276 Date:           September 2019
 277 Contact:        "Hridya Valsaraju" <hridya@google.com>
 278 Description:    Number of free segments in disk.
 279
 280 What:           /sys/fs/f2fs/<disk>/cp_foreground_calls
 281 Date:           September 2019
 282 Contact:        "Hridya Valsaraju" <hridya@google.com>
 283 Description:    Number of checkpoint operations performed on demand. Available when
 284                 CONFIG_F2FS_STAT_FS=y.
 285
 286 What:           /sys/fs/f2fs/<disk>/cp_background_calls
 287 Date:           September 2019
 288 Contact:        "Hridya Valsaraju" <hridya@google.com>
 289 Description:    Number of checkpoint operations performed in the background to
 290                 free segments. Available when CONFIG_F2FS_STAT_FS=y.
 291
 292 What:           /sys/fs/f2fs/<disk>/gc_foreground_calls
 293 Date:           September 2019
 294 Contact:        "Hridya Valsaraju" <hridya@google.com>
 295 Description:    Number of garbage collection operations performed on demand.
 296                 Available when CONFIG_F2FS_STAT_FS=y.
 297
 298 What:           /sys/fs/f2fs/<disk>/gc_background_calls
 299 Date:           September 2019
 300 Contact:        "Hridya Valsaraju" <hridya@google.com>
 301 Description:    Number of garbage collection operations triggered in background.
 302                 Available when CONFIG_F2FS_STAT_FS=y.
 303
 304 What:           /sys/fs/f2fs/<disk>/moved_blocks_foreground
 305 Date:           September 2019
 306 Contact:        "Hridya Valsaraju" <hridya@google.com>
 307 Description:    Number of blocks moved by garbage collection in foreground.
 308                 Available when CONFIG_F2FS_STAT_FS=y.
 309
 310 What:           /sys/fs/f2fs/<disk>/moved_blocks_background
 311 Date:           September 2019
 312 Contact:        "Hridya Valsaraju" <hridya@google.com>
 313 Description:    Number of blocks moved by garbage collection in background.
 314                 Available when CONFIG_F2FS_STAT_FS=y.
 315
 316 What:           /sys/fs/f2fs/<disk>/avg_vblocks
 317 Date:           September 2019
 318 Contact:        "Hridya Valsaraju" <hridya@google.com>
 319 Description:    Average number of valid blocks.
 320                 Available when CONFIG_F2FS_STAT_FS=y.