Documentation/filesystems/f2fs.txt

   1 ================================================================================
   2 WHAT IS Flash-Friendly File System (F2FS)?
   3 ================================================================================
   4
   5 NAND flash memory-based storage devices, such as SSD, eMMC, and SD cards, have
   6 been equipped on a variety systems ranging from mobile to server systems. Since
   7 they are known to have different characteristics from the conventional rotating
   8 disks, a file system, an upper layer to the storage device, should adapt to the
   9 changes from the sketch in the design level.
  10
  11 F2FS is a file system exploiting NAND flash memory-based storage devices, which
  12 is based on Log-structured File System (LFS). The design has been focused on
  13 addressing the fundamental issues in LFS, which are snowball effect of wandering
  14 tree and high cleaning overhead.
  15
  16 Since a NAND flash memory-based storage device shows different characteristic
  17 according to its internal geometry or flash memory management scheme, namely FTL,
  18 F2FS and its tools support various parameters not only for configuring on-disk
  19 layout, but also for selecting allocation and cleaning algorithms.
  20
  21 The following git tree provides the file system formatting tool (mkfs.f2fs),
  22 a consistency checking tool (fsck.f2fs), and a debugging tool (dump.f2fs).
  23 >> git://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs-tools.git
  24
  25 For reporting bugs and sending patches, please use the following mailing list:
  26 >> linux-f2fs-devel@lists.sourceforge.net
  27
  28 ================================================================================
  29 BACKGROUND AND DESIGN ISSUES
  30 ================================================================================
  31
  32 Log-structured File System (LFS)
  33 --------------------------------
  34 "A log-structured file system writes all modifications to disk sequentially in
  35 a log-like structure, thereby speeding up  both file writing and crash recovery.
  36 The log is the only structure on disk; it contains indexing information so that
  37 files can be read back from the log efficiently. In order to maintain large free
  38 areas on disk for fast writing, we divide  the log into segments and use a
  39 segment cleaner to compress the live information from heavily fragmented
  40 segments." from Rosenblum, M. and Ousterhout, J. K., 1992, "The design and
  41 implementation of a log-structured file system", ACM Trans. Computer Systems
  42 10, 1, 26–52.
  43
  44 Wandering Tree Problem
  45 ----------------------
  46 In LFS, when a file data is updated and written to the end of log, its direct
  47 pointer block is updated due to the changed location. Then the indirect pointer
  48 block is also updated due to the direct pointer block update. In this manner,
  49 the upper index structures such as inode, inode map, and checkpoint block are
  50 also updated recursively. This problem is called as wandering tree problem [1],
  51 and in order to enhance the performance, it should eliminate or relax the update
  52 propagation as much as possible.
  53
  54 [1] Bityutskiy, A. 2005. JFFS3 design issues. http://www.linux-mtd.infradead.org/
  55
  56 Cleaning Overhead
  57 -----------------
  58 Since LFS is based on out-of-place writes, it produces so many obsolete blocks
  59 scattered across the whole storage. In order to serve new empty log space, it
  60 needs to reclaim these obsolete blocks seamlessly to users. This job is called
  61 as a cleaning process.
  62
  63 The process consists of three operations as follows.
  64 1. A victim segment is selected through referencing segment usage table.
  65 2. It loads parent index structures of all the data in the victim identified by
  66    segment summary blocks.
  67 3. It checks the cross-reference between the data and its parent index structure.
  68 4. It moves valid data selectively.
  69
  70 This cleaning job may cause unexpected long delays, so the most important goal
  71 is to hide the latencies to users. And also definitely, it should reduce the
  72 amount of valid data to be moved, and move them quickly as well.
  73
  74 ================================================================================
  75 KEY FEATURES
  76 ================================================================================
  77
  78 Flash Awareness
  79 ---------------
  80 - Enlarge the random write area for better performance, but provide the high
  81   spatial locality
  82 - Align FS data structures to the operational units in FTL as best efforts
  83
  84 Wandering Tree Problem
  85 ----------------------
  86 - Use a term, “node”, that represents inodes as well as various pointer blocks
  87 - Introduce Node Address Table (NAT) containing the locations of all the “node”
  88   blocks; this will cut off the update propagation.
  89
  90 Cleaning Overhead
  91 -----------------
  92 - Support a background cleaning process
  93 - Support greedy and cost-benefit algorithms for victim selection policies
  94 - Support multi-head logs for static/dynamic hot and cold data separation
  95 - Introduce adaptive logging for efficient block allocation
  96
  97 ================================================================================
  98 MOUNT OPTIONS
  99 ================================================================================
 100
 101 background_gc=%s       Turn on/off cleaning operations, namely garbage
 102                        collection, triggered in background when I/O subsystem is
 103                        idle. If background_gc=on, it will turn on the garbage
 104                        collection and if background_gc=off, garbage collection
 105                        will be turned off. If background_gc=sync, it will turn
 106                        on synchronous garbage collection running in background.
 107                        Default value for this option is on. So garbage
 108                        collection is on by default.
 109 disable_roll_forward   Disable the roll-forward recovery routine
 110 norecovery             Disable the roll-forward recovery routine, mounted read-
 111                        only (i.e., -o ro,disable_roll_forward)
 112 discard/nodiscard      Enable/disable real-time discard in f2fs, if discard is
 113                        enabled, f2fs will issue discard/TRIM commands when a
 114                        segment is cleaned.
 115 no_heap                Disable heap-style segment allocation which finds free
 116                        segments for data from the beginning of main area, while
 117                        for node from the end of main area.
 118 nouser_xattr           Disable Extended User Attributes. Note: xattr is enabled
 119                        by default if CONFIG_F2FS_FS_XATTR is selected.
 120 noacl                  Disable POSIX Access Control List. Note: acl is enabled
 121                        by default if CONFIG_F2FS_FS_POSIX_ACL is selected.
 122 active_logs=%u         Support configuring the number of active logs. In the
 123                        current design, f2fs supports only 2, 4, and 6 logs.
 124                        Default number is 6.
 125 disable_ext_identify   Disable the extension list configured by mkfs, so f2fs
 126                        does not aware of cold files such as media files.
 127 inline_xattr           Enable the inline xattrs feature.
 128 noinline_xattr         Disable the inline xattrs feature.
 129 inline_data            Enable the inline data feature: New created small(<~3.4k)
 130                        files can be written into inode block.
 131 inline_dentry          Enable the inline dir feature: data in new created
 132                        directory entries can be written into inode block. The
 133                        space of inode block which is used to store inline
 134                        dentries is limited to ~3.4k.
 135 noinline_dentry        Disable the inline dentry feature.
 136 flush_merge            Merge concurrent cache_flush commands as much as possible
 137                        to eliminate redundant command issues. If the underlying
 138                        device handles the cache_flush command relatively slowly,
 139                        recommend to enable this option.
 140 nobarrier              This option can be used if underlying storage guarantees
 141                        its cached data should be written to the novolatile area.
 142                        If this option is set, no cache_flush commands are issued
 143                        but f2fs still guarantees the write ordering of all the
 144                        data writes.
 145 fastboot               This option is used when a system wants to reduce mount
 146                        time as much as possible, even though normal performance
 147                        can be sacrificed.
 148 extent_cache           Enable an extent cache based on rb-tree, it can cache
 149                        as many as extent which map between contiguous logical
 150                        address and physical address per inode, resulting in
 151                        increasing the cache hit ratio. Set by default.
 152 noextent_cache         Disable an extent cache based on rb-tree explicitly, see
 153                        the above extent_cache mount option.
 154 noinline_data          Disable the inline data feature, inline data feature is
 155                        enabled by default.
 156 data_flush             Enable data flushing before checkpoint in order to
 157                        persist data of regular and symlink.
 158 fault_injection=%d     Enable fault injection in all supported types with
 159                        specified injection rate.
 160 mode=%s                Control block allocation mode which supports "adaptive"
 161                        and "lfs". In "lfs" mode, there should be no random
 162                        writes towards main area.
 163 io_bits=%u             Set the bit size of write IO requests. It should be set
 164                        with "mode=lfs".
 165 usrquota               Enable plain user disk quota accounting.
 166 grpquota               Enable plain group disk quota accounting.
 167 prjquota               Enable plain project quota accounting.
 168 usrjquota=<file>       Appoint specified file and type during mount, so that quota
 169 grpjquota=<file>       information can be properly updated during recovery flow,
 170 prjjquota=<file>       <quota file>: must be in root directory;
 171 jqfmt=<quota type>     <quota type>: [vfsold,vfsv0,vfsv1].
 172 offusrjquota           Turn off user journelled quota.
 173 offgrpjquota           Turn off group journelled quota.
 174 offprjjquota           Turn off project journelled quota.
 175 quota                  Enable plain user disk quota accounting.
 176 noquota                Disable all plain disk quota option.
 177 whint_mode=%s          Control which write hints are passed down to block
 178                        layer. This supports "off", "user-based", and
 179                        "fs-based".  In "off" mode (default), f2fs does not pass
 180                        down hints. In "user-based" mode, f2fs tries to pass
 181                        down hints given by users. And in "fs-based" mode, f2fs
 182                        passes down hints with its policy.
 183 alloc_mode=%s          Adjust block allocation policy, which supports "reuse"
 184                        and "default".
 185 fsync_mode=%s          Control the policy of fsync. Currently supports "posix",
 186                        "strict", and "nobarrier". In "posix" mode, which is
 187                        default, fsync will follow POSIX semantics and does a
 188                        light operation to improve the filesystem performance.
 189                        In "strict" mode, fsync will be heavy and behaves in line
 190                        with xfs, ext4 and btrfs, where xfstest generic/342 will
 191                        pass, but the performance will regress. "nobarrier" is
 192                        based on "posix", but doesn't issue flush command for
 193                        non-atomic files likewise "nobarrier" mount option.
 194 test_dummy_encryption  Enable dummy encryption, which provides a fake fscrypt
 195                        context. The fake fscrypt context is used by xfstests.
 196
 197 ================================================================================
 198 DEBUGFS ENTRIES
 199 ================================================================================
 200
 201 /sys/kernel/debug/f2fs/ contains information about all the partitions mounted as
 202 f2fs. Each file shows the whole f2fs information.
 203
 204 /sys/kernel/debug/f2fs/status includes:
 205  - major file system information managed by f2fs currently
 206  - average SIT information about whole segments
 207  - current memory footprint consumed by f2fs.
 208
 209 ================================================================================
 210 SYSFS ENTRIES
 211 ================================================================================
 212
 213 Information about mounted f2fs file systems can be found in
 214 /sys/fs/f2fs.  Each mounted filesystem will have a directory in
 215 /sys/fs/f2fs based on its device name (i.e., /sys/fs/f2fs/sda).
 216 The files in each per-device directory are shown in table below.
 217
 218 Files in /sys/fs/f2fs/<devname>
 219 (see also Documentation/ABI/testing/sysfs-fs-f2fs)
 220 ..............................................................................
 221  File                         Content
 222
 223  gc_max_sleep_time            This tuning parameter controls the maximum sleep
 224                               time for the garbage collection thread. Time is
 225                               in milliseconds.
 226
 227  gc_min_sleep_time            This tuning parameter controls the minimum sleep
 228                               time for the garbage collection thread. Time is
 229                               in milliseconds.
 230
 231  gc_no_gc_sleep_time          This tuning parameter controls the default sleep
 232                               time for the garbage collection thread. Time is
 233                               in milliseconds.
 234
 235  gc_idle                      This parameter controls the selection of victim
 236                               policy for garbage collection. Setting gc_idle = 0
 237                               (default) will disable this option. Setting
 238                               gc_idle = 1 will select the Cost Benefit approach
 239                               & setting gc_idle = 2 will select the greedy approach.
 240
 241  gc_urgent                    This parameter controls triggering background GCs
 242                               urgently or not. Setting gc_urgent = 0 [default]
 243                               makes back to default behavior, while if it is set
 244                               to 1, background thread starts to do GC by given
 245                               gc_urgent_sleep_time interval.
 246
 247  gc_urgent_sleep_time         This parameter controls sleep time for gc_urgent.
 248                               500 ms is set by default. See above gc_urgent.
 249
 250  reclaim_segments             This parameter controls the number of prefree
 251                               segments to be reclaimed. If the number of prefree
 252                               segments is larger than the number of segments
 253                               in the proportion to the percentage over total
 254                               volume size, f2fs tries to conduct checkpoint to
 255                               reclaim the prefree segments to free segments.
 256                               By default, 5% over total # of segments.
 257
 258  max_small_discards           This parameter controls the number of discard
 259                               commands that consist small blocks less than 2MB.
 260                               The candidates to be discarded are cached until
 261                               checkpoint is triggered, and issued during the
 262                               checkpoint. By default, it is disabled with 0.
 263
 264  trim_sections                This parameter controls the number of sections
 265                               to be trimmed out in batch mode when FITRIM
 266                               conducts. 32 sections is set by default.
 267
 268  ipu_policy                   This parameter controls the policy of in-place
 269                               updates in f2fs. There are five policies:
 270                                0x01: F2FS_IPU_FORCE, 0x02: F2FS_IPU_SSR,
 271                                0x04: F2FS_IPU_UTIL,  0x08: F2FS_IPU_SSR_UTIL,
 272                                0x10: F2FS_IPU_FSYNC.
 273
 274  min_ipu_util                 This parameter controls the threshold to trigger
 275                               in-place-updates. The number indicates percentage
 276                               of the filesystem utilization, and used by
 277                               F2FS_IPU_UTIL and F2FS_IPU_SSR_UTIL policies.
 278
 279  min_fsync_blocks             This parameter controls the threshold to trigger
 280                               in-place-updates when F2FS_IPU_FSYNC mode is set.
 281                               The number indicates the number of dirty pages
 282                               when fsync needs to flush on its call path. If
 283                               the number is less than this value, it triggers
 284                               in-place-updates.
 285
 286  max_victim_search            This parameter controls the number of trials to
 287                               find a victim segment when conducting SSR and
 288                               cleaning operations. The default value is 4096
 289                               which covers 8GB block address range.
 290
 291  dir_level                    This parameter controls the directory level to
 292                               support large directory. If a directory has a
 293                               number of files, it can reduce the file lookup
 294                               latency by increasing this dir_level value.
 295                               Otherwise, it needs to decrease this value to
 296                               reduce the space overhead. The default value is 0.
 297
 298  ram_thresh                   This parameter controls the memory footprint used
 299                               by free nids and cached nat entries. By default,
 300                               10 is set, which indicates 10 MB / 1 GB RAM.
 301
 302 ================================================================================
 303 USAGE
 304 ================================================================================
 305
 306 1. Download userland tools and compile them.
 307
 308 2. Skip, if f2fs was compiled statically inside kernel.
 309    Otherwise, insert the f2fs.ko module.
 310  # insmod f2fs.ko
 311
 312 3. Create a directory trying to mount
 313  # mkdir /mnt/f2fs
 314
 315 4. Format the block device, and then mount as f2fs
 316  # mkfs.f2fs -l label /dev/block_device
 317  # mount -t f2fs /dev/block_device /mnt/f2fs
 318
 319 mkfs.f2fs
 320 ---------
 321 The mkfs.f2fs is for the use of formatting a partition as the f2fs filesystem,
 322 which builds a basic on-disk layout.
 323
 324 The options consist of:
 325 -l [label]   : Give a volume label, up to 512 unicode name.
 326 -a [0 or 1]  : Split start location of each area for heap-based allocation.
 327                1 is set by default, which performs this.
 328 -o [int]     : Set overprovision ratio in percent over volume size.
 329                5 is set by default.
 330 -s [int]     : Set the number of segments per section.
 331                1 is set by default.
 332 -z [int]     : Set the number of sections per zone.
 333                1 is set by default.
 334 -e [str]     : Set basic extension list. e.g. "mp3,gif,mov"
 335 -t [0 or 1]  : Disable discard command or not.
 336                1 is set by default, which conducts discard.
 337
 338 fsck.f2fs
 339 ---------
 340 The fsck.f2fs is a tool to check the consistency of an f2fs-formatted
 341 partition, which examines whether the filesystem metadata and user-made data
 342 are cross-referenced correctly or not.
 343 Note that, initial version of the tool does not fix any inconsistency.
 344
 345 The options consist of:
 346   -d debug level [default:0]
 347
 348 dump.f2fs
 349 ---------
 350 The dump.f2fs shows the information of specific inode and dumps SSA and SIT to
 351 file. Each file is dump_ssa and dump_sit.
 352
 353 The dump.f2fs is used to debug on-disk data structures of the f2fs filesystem.
 354 It shows on-disk inode information recognized by a given inode number, and is
 355 able to dump all the SSA and SIT entries into predefined files, ./dump_ssa and
 356 ./dump_sit respectively.
 357
 358 The options consist of:
 359   -d debug level [default:0]
 360   -i inode no (hex)
 361   -s [SIT dump segno from #1~#2 (decimal), for all 0~-1]
 362   -a [SSA dump segno from #1~#2 (decimal), for all 0~-1]
 363
 364 Examples:
 365 # dump.f2fs -i [ino] /dev/sdx
 366 # dump.f2fs -s 0~-1 /dev/sdx (SIT dump)
 367 # dump.f2fs -a 0~-1 /dev/sdx (SSA dump)
 368
 369 ================================================================================
 370 DESIGN
 371 ================================================================================
 372
 373 On-disk Layout
 374 --------------
 375
 376 F2FS divides the whole volume into a number of segments, each of which is fixed
 377 to 2MB in size. A section is composed of consecutive segments, and a zone
 378 consists of a set of sections. By default, section and zone sizes are set to one
 379 segment size identically, but users can easily modify the sizes by mkfs.
 380
 381 F2FS splits the entire volume into six areas, and all the areas except superblock
 382 consists of multiple segments as described below.
 383
 384                                             align with the zone size <-|
 385                  |-> align with the segment size
 386      _________________________________________________________________________
 387     |            |            |   Segment   |    Node     |   Segment  |      |
 388     | Superblock | Checkpoint |    Info.    |   Address   |   Summary  | Main |
 389     |    (SB)    |   (CP)     | Table (SIT) | Table (NAT) | Area (SSA) |      |
 390     |____________|_____2______|______N______|______N______|______N_____|__N___|
 391                                                                        .      .
 392                                                              .                .
 393                                                  .                            .
 394                                     ._________________________________________.
 395                                     |_Segment_|_..._|_Segment_|_..._|_Segment_|
 396                                     .           .
 397                                     ._________._________
 398                                     |_section_|__...__|_
 399                                     .            .
 400                                     .________.
 401                                     |__zone__|
 402
 403 - Superblock (SB)
 404  : It is located at the beginning of the partition, and there exist two copies
 405    to avoid file system crash. It contains basic partition information and some
 406    default parameters of f2fs.
 407
 408 - Checkpoint (CP)
 409  : It contains file system information, bitmaps for valid NAT/SIT sets, orphan
 410    inode lists, and summary entries of current active segments.
 411
 412 - Segment Information Table (SIT)
 413  : It contains segment information such as valid block count and bitmap for the
 414    validity of all the blocks.
 415
 416 - Node Address Table (NAT)
 417  : It is composed of a block address table for all the node blocks stored in
 418    Main area.
 419
 420 - Segment Summary Area (SSA)
 421  : It contains summary entries which contains the owner information of all the
 422    data and node blocks stored in Main area.
 423
 424 - Main Area
 425  : It contains file and directory data including their indices.
 426
 427 In order to avoid misalignment between file system and flash-based storage, F2FS
 428 aligns the start block address of CP with the segment size. Also, it aligns the
 429 start block address of Main area with the zone size by reserving some segments
 430 in SSA area.
 431
 432 Reference the following survey for additional technical details.
 433 https://wiki.linaro.org/WorkingGroups/Kernel/Projects/FlashCardSurvey
 434
 435 File System Metadata Structure
 436 ------------------------------
 437
 438 F2FS adopts the checkpointing scheme to maintain file system consistency. At
 439 mount time, F2FS first tries to find the last valid checkpoint data by scanning
 440 CP area. In order to reduce the scanning time, F2FS uses only two copies of CP.
 441 One of them always indicates the last valid data, which is called as shadow copy
 442 mechanism. In addition to CP, NAT and SIT also adopt the shadow copy mechanism.
 443
 444 For file system consistency, each CP points to which NAT and SIT copies are
 445 valid, as shown as below.
 446
 447   +--------+----------+---------+
 448   |   CP   |    SIT   |   NAT   |
 449   +--------+----------+---------+
 450   .         .          .          .
 451   .            .              .              .
 452   .               .                 .                 .
 453   +-------+-------+--------+--------+--------+--------+
 454   | CP #0 | CP #1 | SIT #0 | SIT #1 | NAT #0 | NAT #1 |
 455   +-------+-------+--------+--------+--------+--------+
 456      |             ^                          ^
 457      |             |                          |
 458      `----------------------------------------'
 459
 460 Index Structure
 461 ---------------
 462
 463 The key data structure to manage the data locations is a "node". Similar to
 464 traditional file structures, F2FS has three types of node: inode, direct node,
 465 indirect node. F2FS assigns 4KB to an inode block which contains 923 data block
 466 indices, two direct node pointers, two indirect node pointers, and one double
 467 indirect node pointer as described below. One direct node block contains 1018
 468 data blocks, and one indirect node block contains also 1018 node blocks. Thus,
 469 one inode block (i.e., a file) covers:
 470
 471   4KB * (923 + 2 * 1018 + 2 * 1018 * 1018 + 1018 * 1018 * 1018) := 3.94TB.
 472
 473    Inode block (4KB)
 474      |- data (923)
 475      |- direct node (2)
 476      |          `- data (1018)
 477      |- indirect node (2)
 478      |            `- direct node (1018)
 479      |                       `- data (1018)
 480      `- double indirect node (1)
 481                          `- indirect node (1018)
 482                                       `- direct node (1018)
 483                                                  `- data (1018)
 484
 485 Note that, all the node blocks are mapped by NAT which means the location of
 486 each node is translated by the NAT table. In the consideration of the wandering
 487 tree problem, F2FS is able to cut off the propagation of node updates caused by
 488 leaf data writes.
 489
 490 Directory Structure
 491 -------------------
 492
 493 A directory entry occupies 11 bytes, which consists of the following attributes.
 494
 495 - hash          hash value of the file name
 496 - ino           inode number
 497 - len           the length of file name
 498 - type          file type such as directory, symlink, etc
 499
 500 A dentry block consists of 214 dentry slots and file names. Therein a bitmap is
 501 used to represent whether each dentry is valid or not. A dentry block occupies
 502 4KB with the following composition.
 503
 504   Dentry Block(4 K) = bitmap (27 bytes) + reserved (3 bytes) +
 505                       dentries(11 * 214 bytes) + file name (8 * 214 bytes)
 506
 507                          [Bucket]
 508              +--------------------------------+
 509              |dentry block 1 | dentry block 2 |
 510              +--------------------------------+
 511              .               .
 512        .                             .
 513   .       [Dentry Block Structure: 4KB]       .
 514   +--------+----------+----------+------------+
 515   | bitmap | reserved | dentries | file names |
 516   +--------+----------+----------+------------+
 517   [Dentry Block: 4KB] .   .
 518                  .               .
 519             .                          .
 520             +------+------+-----+------+
 521             | hash | ino  | len | type |
 522             +------+------+-----+------+
 523             [Dentry Structure: 11 bytes]
 524
 525 F2FS implements multi-level hash tables for directory structure. Each level has
 526 a hash table with dedicated number of hash buckets as shown below. Note that
 527 "A(2B)" means a bucket includes 2 data blocks.
 528
 529 ----------------------
 530 A : bucket
 531 B : block
 532 N : MAX_DIR_HASH_DEPTH
 533 ----------------------
 534
 535 level #0   | A(2B)
 536            |
 537 level #1   | A(2B) - A(2B)
 538            |
 539 level #2   | A(2B) - A(2B) - A(2B) - A(2B)
 540      .     |   .       .       .       .
 541 level #N/2 | A(2B) - A(2B) - A(2B) - A(2B) - A(2B) - ... - A(2B)
 542      .     |   .       .       .       .
 543 level #N   | A(4B) - A(4B) - A(4B) - A(4B) - A(4B) - ... - A(4B)
 544
 545 The number of blocks and buckets are determined by,
 546
 547                             ,- 2, if n < MAX_DIR_HASH_DEPTH / 2,
 548   # of blocks in level #n = |
 549                             `- 4, Otherwise
 550
 551                              ,- 2^(n + dir_level),
 552                              |        if n + dir_level < MAX_DIR_HASH_DEPTH / 2,
 553   # of buckets in level #n = |
 554                              `- 2^((MAX_DIR_HASH_DEPTH / 2) - 1),
 555                                       Otherwise
 556
 557 When F2FS finds a file name in a directory, at first a hash value of the file
 558 name is calculated. Then, F2FS scans the hash table in level #0 to find the
 559 dentry consisting of the file name and its inode number. If not found, F2FS
 560 scans the next hash table in level #1. In this way, F2FS scans hash tables in
 561 each levels incrementally from 1 to N. In each levels F2FS needs to scan only
 562 one bucket determined by the following equation, which shows O(log(# of files))
 563 complexity.
 564
 565   bucket number to scan in level #n = (hash value) % (# of buckets in level #n)
 566
 567 In the case of file creation, F2FS finds empty consecutive slots that cover the
 568 file name. F2FS searches the empty slots in the hash tables of whole levels from
 569 1 to N in the same way as the lookup operation.
 570
 571 The following figure shows an example of two cases holding children.
 572        --------------> Dir <--------------
 573        |                                 |
 574     child                             child
 575
 576     child - child                     [hole] - child
 577
 578     child - child - child             [hole] - [hole] - child
 579
 580    Case 1:                           Case 2:
 581    Number of children = 6,           Number of children = 3,
 582    File size = 7                     File size = 7
 583
 584 Default Block Allocation
 585 ------------------------
 586
 587 At runtime, F2FS manages six active logs inside "Main" area: Hot/Warm/Cold node
 588 and Hot/Warm/Cold data.
 589
 590 - Hot node      contains direct node blocks of directories.
 591 - Warm node     contains direct node blocks except hot node blocks.
 592 - Cold node     contains indirect node blocks
 593 - Hot data      contains dentry blocks
 594 - Warm data     contains data blocks except hot and cold data blocks
 595 - Cold data     contains multimedia data or migrated data blocks
 596
 597 LFS has two schemes for free space management: threaded log and copy-and-compac-
 598 tion. The copy-and-compaction scheme which is known as cleaning, is well-suited
 599 for devices showing very good sequential write performance, since free segments
 600 are served all the time for writing new data. However, it suffers from cleaning
 601 overhead under high utilization. Contrarily, the threaded log scheme suffers
 602 from random writes, but no cleaning process is needed. F2FS adopts a hybrid
 603 scheme where the copy-and-compaction scheme is adopted by default, but the
 604 policy is dynamically changed to the threaded log scheme according to the file
 605 system status.
 606
 607 In order to align F2FS with underlying flash-based storage, F2FS allocates a
 608 segment in a unit of section. F2FS expects that the section size would be the
 609 same as the unit size of garbage collection in FTL. Furthermore, with respect
 610 to the mapping granularity in FTL, F2FS allocates each section of the active
 611 logs from different zones as much as possible, since FTL can write the data in
 612 the active logs into one allocation unit according to its mapping granularity.
 613
 614 Cleaning process
 615 ----------------
 616
 617 F2FS does cleaning both on demand and in the background. On-demand cleaning is
 618 triggered when there are not enough free segments to serve VFS calls. Background
 619 cleaner is operated by a kernel thread, and triggers the cleaning job when the
 620 system is idle.
 621
 622 F2FS supports two victim selection policies: greedy and cost-benefit algorithms.
 623 In the greedy algorithm, F2FS selects a victim segment having the smallest number
 624 of valid blocks. In the cost-benefit algorithm, F2FS selects a victim segment
 625 according to the segment age and the number of valid blocks in order to address
 626 log block thrashing problem in the greedy algorithm. F2FS adopts the greedy
 627 algorithm for on-demand cleaner, while background cleaner adopts cost-benefit
 628 algorithm.
 629
 630 In order to identify whether the data in the victim segment are valid or not,
 631 F2FS manages a bitmap. Each bit represents the validity of a block, and the
 632 bitmap is composed of a bit stream covering whole blocks in main area.
 633
 634 Write-hint Policy
 635 -----------------
 636
 637 1) whint_mode=off. F2FS only passes down WRITE_LIFE_NOT_SET.
 638
 639 2) whint_mode=user-based. F2FS tries to pass down hints given by
 640 users.
 641
 642 User                  F2FS                     Block
 643 ----                  ----                     -----
 644                       META                     WRITE_LIFE_NOT_SET
 645                       HOT_NODE                 "
 646                       WARM_NODE                "
 647                       COLD_NODE                "
 648 *ioctl(COLD)          COLD_DATA                WRITE_LIFE_EXTREME
 649 *extension list       "                        "
 650
 651 -- buffered io
 652 WRITE_LIFE_EXTREME    COLD_DATA                WRITE_LIFE_EXTREME
 653 WRITE_LIFE_SHORT      HOT_DATA                 WRITE_LIFE_SHORT
 654 WRITE_LIFE_NOT_SET    WARM_DATA                WRITE_LIFE_NOT_SET
 655 WRITE_LIFE_NONE       "                        "
 656 WRITE_LIFE_MEDIUM     "                        "
 657 WRITE_LIFE_LONG       "                        "
 658
 659 -- direct io
 660 WRITE_LIFE_EXTREME    COLD_DATA                WRITE_LIFE_EXTREME
 661 WRITE_LIFE_SHORT      HOT_DATA                 WRITE_LIFE_SHORT
 662 WRITE_LIFE_NOT_SET    WARM_DATA                WRITE_LIFE_NOT_SET
 663 WRITE_LIFE_NONE       "                        WRITE_LIFE_NONE
 664 WRITE_LIFE_MEDIUM     "                        WRITE_LIFE_MEDIUM
 665 WRITE_LIFE_LONG       "                        WRITE_LIFE_LONG
 666
 667 3) whint_mode=fs-based. F2FS passes down hints with its policy.
 668
 669 User                  F2FS                     Block
 670 ----                  ----                     -----
 671                       META                     WRITE_LIFE_MEDIUM;
 672                       HOT_NODE                 WRITE_LIFE_NOT_SET
 673                       WARM_NODE                "
 674                       COLD_NODE                WRITE_LIFE_NONE
 675 ioctl(COLD)           COLD_DATA                WRITE_LIFE_EXTREME
 676 extension list        "                        "
 677
 678 -- buffered io
 679 WRITE_LIFE_EXTREME    COLD_DATA                WRITE_LIFE_EXTREME
 680 WRITE_LIFE_SHORT      HOT_DATA                 WRITE_LIFE_SHORT
 681 WRITE_LIFE_NOT_SET    WARM_DATA                WRITE_LIFE_LONG
 682 WRITE_LIFE_NONE       "                        "
 683 WRITE_LIFE_MEDIUM     "                        "
 684 WRITE_LIFE_LONG       "                        "
 685
 686 -- direct io
 687 WRITE_LIFE_EXTREME    COLD_DATA                WRITE_LIFE_EXTREME
 688 WRITE_LIFE_SHORT      HOT_DATA                 WRITE_LIFE_SHORT
 689 WRITE_LIFE_NOT_SET    WARM_DATA                WRITE_LIFE_NOT_SET
 690 WRITE_LIFE_NONE       "                        WRITE_LIFE_NONE
 691 WRITE_LIFE_MEDIUM     "                        WRITE_LIFE_MEDIUM
 692 WRITE_LIFE_LONG       "                        WRITE_LIFE_LONG