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 truned off.
 106                        Default value for this option is on. So garbage
 107                        collection is on by default.
 108 disable_roll_forward   Disable the roll-forward recovery routine
 109 discard                Issue discard/TRIM commands when a segment is cleaned.
 110 no_heap                Disable heap-style segment allocation which finds free
 111                        segments for data from the beginning of main area, while
 112                        for node from the end of main area.
 113 nouser_xattr           Disable Extended User Attributes. Note: xattr is enabled
 114                        by default if CONFIG_F2FS_FS_XATTR is selected.
 115 noacl                  Disable POSIX Access Control List. Note: acl is enabled
 116                        by default if CONFIG_F2FS_FS_POSIX_ACL is selected.
 117 active_logs=%u         Support configuring the number of active logs. In the
 118                        current design, f2fs supports only 2, 4, and 6 logs.
 119                        Default number is 6.
 120 disable_ext_identify   Disable the extension list configured by mkfs, so f2fs
 121                        does not aware of cold files such as media files.
 122
 123 ================================================================================
 124 DEBUGFS ENTRIES
 125 ================================================================================
 126
 127 /sys/kernel/debug/f2fs/ contains information about all the partitions mounted as
 128 f2fs. Each file shows the whole f2fs information.
 129
 130 /sys/kernel/debug/f2fs/status includes:
 131  - major file system information managed by f2fs currently
 132  - average SIT information about whole segments
 133  - current memory footprint consumed by f2fs.
 134
 135 ================================================================================
 136 SYSFS ENTRIES
 137 ================================================================================
 138
 139 Information about mounted f2f2 file systems can be found in
 140 /sys/fs/f2fs.  Each mounted filesystem will have a directory in
 141 /sys/fs/f2fs based on its device name (i.e., /sys/fs/f2fs/sda).
 142 The files in each per-device directory are shown in table below.
 143
 144 Files in /sys/fs/f2fs/<devname>
 145 (see also Documentation/ABI/testing/sysfs-fs-f2fs)
 146 ..............................................................................
 147  File                         Content
 148
 149  gc_max_sleep_time            This tuning parameter controls the maximum sleep
 150                               time for the garbage collection thread. Time is
 151                               in milliseconds.
 152
 153  gc_min_sleep_time            This tuning parameter controls the minimum sleep
 154                               time for the garbage collection thread. Time is
 155                               in milliseconds.
 156
 157  gc_no_gc_sleep_time          This tuning parameter controls the default sleep
 158                               time for the garbage collection thread. Time is
 159                               in milliseconds.
 160
 161  gc_idle                      This parameter controls the selection of victim
 162                               policy for garbage collection. Setting gc_idle = 0
 163                               (default) will disable this option. Setting
 164                               gc_idle = 1 will select the Cost Benefit approach
 165                               & setting gc_idle = 2 will select the greedy aproach.
 166
 167 ================================================================================
 168 USAGE
 169 ================================================================================
 170
 171 1. Download userland tools and compile them.
 172
 173 2. Skip, if f2fs was compiled statically inside kernel.
 174    Otherwise, insert the f2fs.ko module.
 175  # insmod f2fs.ko
 176
 177 3. Create a directory trying to mount
 178  # mkdir /mnt/f2fs
 179
 180 4. Format the block device, and then mount as f2fs
 181  # mkfs.f2fs -l label /dev/block_device
 182  # mount -t f2fs /dev/block_device /mnt/f2fs
 183
 184 mkfs.f2fs
 185 ---------
 186 The mkfs.f2fs is for the use of formatting a partition as the f2fs filesystem,
 187 which builds a basic on-disk layout.
 188
 189 The options consist of:
 190 -l [label]   : Give a volume label, up to 512 unicode name.
 191 -a [0 or 1]  : Split start location of each area for heap-based allocation.
 192                1 is set by default, which performs this.
 193 -o [int]     : Set overprovision ratio in percent over volume size.
 194                5 is set by default.
 195 -s [int]     : Set the number of segments per section.
 196                1 is set by default.
 197 -z [int]     : Set the number of sections per zone.
 198                1 is set by default.
 199 -e [str]     : Set basic extension list. e.g. "mp3,gif,mov"
 200 -t [0 or 1]  : Disable discard command or not.
 201                1 is set by default, which conducts discard.
 202
 203 fsck.f2fs
 204 ---------
 205 The fsck.f2fs is a tool to check the consistency of an f2fs-formatted
 206 partition, which examines whether the filesystem metadata and user-made data
 207 are cross-referenced correctly or not.
 208 Note that, initial version of the tool does not fix any inconsistency.
 209
 210 The options consist of:
 211   -d debug level [default:0]
 212
 213 dump.f2fs
 214 ---------
 215 The dump.f2fs shows the information of specific inode and dumps SSA and SIT to
 216 file. Each file is dump_ssa and dump_sit.
 217
 218 The dump.f2fs is used to debug on-disk data structures of the f2fs filesystem.
 219 It shows on-disk inode information reconized by a given inode number, and is
 220 able to dump all the SSA and SIT entries into predefined files, ./dump_ssa and
 221 ./dump_sit respectively.
 222
 223 The options consist of:
 224   -d debug level [default:0]
 225   -i inode no (hex)
 226   -s [SIT dump segno from #1~#2 (decimal), for all 0~-1]
 227   -a [SSA dump segno from #1~#2 (decimal), for all 0~-1]
 228
 229 Examples:
 230 # dump.f2fs -i [ino] /dev/sdx
 231 # dump.f2fs -s 0~-1 /dev/sdx (SIT dump)
 232 # dump.f2fs -a 0~-1 /dev/sdx (SSA dump)
 233
 234 ================================================================================
 235 DESIGN
 236 ================================================================================
 237
 238 On-disk Layout
 239 --------------
 240
 241 F2FS divides the whole volume into a number of segments, each of which is fixed
 242 to 2MB in size. A section is composed of consecutive segments, and a zone
 243 consists of a set of sections. By default, section and zone sizes are set to one
 244 segment size identically, but users can easily modify the sizes by mkfs.
 245
 246 F2FS splits the entire volume into six areas, and all the areas except superblock
 247 consists of multiple segments as described below.
 248
 249                                             align with the zone size <-|
 250                  |-> align with the segment size
 251      _________________________________________________________________________
 252     |            |            |   Segment   |    Node     |   Segment  |      |
 253     | Superblock | Checkpoint |    Info.    |   Address   |   Summary  | Main |
 254     |    (SB)    |   (CP)     | Table (SIT) | Table (NAT) | Area (SSA) |      |
 255     |____________|_____2______|______N______|______N______|______N_____|__N___|
 256                                                                        .      .
 257                                                              .                .
 258                                                  .                            .
 259                                     ._________________________________________.
 260                                     |_Segment_|_..._|_Segment_|_..._|_Segment_|
 261                                     .           .
 262                                     ._________._________
 263                                     |_section_|__...__|_
 264                                     .            .
 265                                     .________.
 266                                     |__zone__|
 267
 268 - Superblock (SB)
 269  : It is located at the beginning of the partition, and there exist two copies
 270    to avoid file system crash. It contains basic partition information and some
 271    default parameters of f2fs.
 272
 273 - Checkpoint (CP)
 274  : It contains file system information, bitmaps for valid NAT/SIT sets, orphan
 275    inode lists, and summary entries of current active segments.
 276
 277 - Segment Information Table (SIT)
 278  : It contains segment information such as valid block count and bitmap for the
 279    validity of all the blocks.
 280
 281 - Node Address Table (NAT)
 282  : It is composed of a block address table for all the node blocks stored in
 283    Main area.
 284
 285 - Segment Summary Area (SSA)
 286  : It contains summary entries which contains the owner information of all the
 287    data and node blocks stored in Main area.
 288
 289 - Main Area
 290  : It contains file and directory data including their indices.
 291
 292 In order to avoid misalignment between file system and flash-based storage, F2FS
 293 aligns the start block address of CP with the segment size. Also, it aligns the
 294 start block address of Main area with the zone size by reserving some segments
 295 in SSA area.
 296
 297 Reference the following survey for additional technical details.
 298 https://wiki.linaro.org/WorkingGroups/Kernel/Projects/FlashCardSurvey
 299
 300 File System Metadata Structure
 301 ------------------------------
 302
 303 F2FS adopts the checkpointing scheme to maintain file system consistency. At
 304 mount time, F2FS first tries to find the last valid checkpoint data by scanning
 305 CP area. In order to reduce the scanning time, F2FS uses only two copies of CP.
 306 One of them always indicates the last valid data, which is called as shadow copy
 307 mechanism. In addition to CP, NAT and SIT also adopt the shadow copy mechanism.
 308
 309 For file system consistency, each CP points to which NAT and SIT copies are
 310 valid, as shown as below.
 311
 312   +--------+----------+---------+
 313   |   CP   |    SIT   |   NAT   |
 314   +--------+----------+---------+
 315   .         .          .          .
 316   .            .              .              .
 317   .               .                 .                 .
 318   +-------+-------+--------+--------+--------+--------+
 319   | CP #0 | CP #1 | SIT #0 | SIT #1 | NAT #0 | NAT #1 |
 320   +-------+-------+--------+--------+--------+--------+
 321      |             ^                          ^
 322      |             |                          |
 323      `----------------------------------------'
 324
 325 Index Structure
 326 ---------------
 327
 328 The key data structure to manage the data locations is a "node". Similar to
 329 traditional file structures, F2FS has three types of node: inode, direct node,
 330 indirect node. F2FS assigns 4KB to an inode block which contains 923 data block
 331 indices, two direct node pointers, two indirect node pointers, and one double
 332 indirect node pointer as described below. One direct node block contains 1018
 333 data blocks, and one indirect node block contains also 1018 node blocks. Thus,
 334 one inode block (i.e., a file) covers:
 335
 336   4KB * (923 + 2 * 1018 + 2 * 1018 * 1018 + 1018 * 1018 * 1018) := 3.94TB.
 337
 338    Inode block (4KB)
 339      |- data (923)
 340      |- direct node (2)
 341      |          `- data (1018)
 342      |- indirect node (2)
 343      |            `- direct node (1018)
 344      |                       `- data (1018)
 345      `- double indirect node (1)
 346                          `- indirect node (1018)
 347                                       `- direct node (1018)
 348                                                  `- data (1018)
 349
 350 Note that, all the node blocks are mapped by NAT which means the location of
 351 each node is translated by the NAT table. In the consideration of the wandering
 352 tree problem, F2FS is able to cut off the propagation of node updates caused by
 353 leaf data writes.
 354
 355 Directory Structure
 356 -------------------
 357
 358 A directory entry occupies 11 bytes, which consists of the following attributes.
 359
 360 - hash          hash value of the file name
 361 - ino           inode number
 362 - len           the length of file name
 363 - type          file type such as directory, symlink, etc
 364
 365 A dentry block consists of 214 dentry slots and file names. Therein a bitmap is
 366 used to represent whether each dentry is valid or not. A dentry block occupies
 367 4KB with the following composition.
 368
 369   Dentry Block(4 K) = bitmap (27 bytes) + reserved (3 bytes) +
 370                       dentries(11 * 214 bytes) + file name (8 * 214 bytes)
 371
 372                          [Bucket]
 373              +--------------------------------+
 374              |dentry block 1 | dentry block 2 |
 375              +--------------------------------+
 376              .               .
 377        .                             .
 378   .       [Dentry Block Structure: 4KB]       .
 379   +--------+----------+----------+------------+
 380   | bitmap | reserved | dentries | file names |
 381   +--------+----------+----------+------------+
 382   [Dentry Block: 4KB] .   .
 383                  .               .
 384             .                          .
 385             +------+------+-----+------+
 386             | hash | ino  | len | type |
 387             +------+------+-----+------+
 388             [Dentry Structure: 11 bytes]
 389
 390 F2FS implements multi-level hash tables for directory structure. Each level has
 391 a hash table with dedicated number of hash buckets as shown below. Note that
 392 "A(2B)" means a bucket includes 2 data blocks.
 393
 394 ----------------------
 395 A : bucket
 396 B : block
 397 N : MAX_DIR_HASH_DEPTH
 398 ----------------------
 399
 400 level #0   | A(2B)
 401            |
 402 level #1   | A(2B) - A(2B)
 403            |
 404 level #2   | A(2B) - A(2B) - A(2B) - A(2B)
 405      .     |   .       .       .       .
 406 level #N/2 | A(2B) - A(2B) - A(2B) - A(2B) - A(2B) - ... - A(2B)
 407      .     |   .       .       .       .
 408 level #N   | A(4B) - A(4B) - A(4B) - A(4B) - A(4B) - ... - A(4B)
 409
 410 The number of blocks and buckets are determined by,
 411
 412                             ,- 2, if n < MAX_DIR_HASH_DEPTH / 2,
 413   # of blocks in level #n = |
 414                             `- 4, Otherwise
 415
 416                              ,- 2^n, if n < MAX_DIR_HASH_DEPTH / 2,
 417   # of buckets in level #n = |
 418                              `- 2^((MAX_DIR_HASH_DEPTH / 2) - 1), Otherwise
 419
 420 When F2FS finds a file name in a directory, at first a hash value of the file
 421 name is calculated. Then, F2FS scans the hash table in level #0 to find the
 422 dentry consisting of the file name and its inode number. If not found, F2FS
 423 scans the next hash table in level #1. In this way, F2FS scans hash tables in
 424 each levels incrementally from 1 to N. In each levels F2FS needs to scan only
 425 one bucket determined by the following equation, which shows O(log(# of files))
 426 complexity.
 427
 428   bucket number to scan in level #n = (hash value) % (# of buckets in level #n)
 429
 430 In the case of file creation, F2FS finds empty consecutive slots that cover the
 431 file name. F2FS searches the empty slots in the hash tables of whole levels from
 432 1 to N in the same way as the lookup operation.
 433
 434 The following figure shows an example of two cases holding children.
 435        --------------> Dir <--------------
 436        |                                 |
 437     child                             child
 438
 439     child - child                     [hole] - child
 440
 441     child - child - child             [hole] - [hole] - child
 442
 443    Case 1:                           Case 2:
 444    Number of children = 6,           Number of children = 3,
 445    File size = 7                     File size = 7
 446
 447 Default Block Allocation
 448 ------------------------
 449
 450 At runtime, F2FS manages six active logs inside "Main" area: Hot/Warm/Cold node
 451 and Hot/Warm/Cold data.
 452
 453 - Hot node      contains direct node blocks of directories.
 454 - Warm node     contains direct node blocks except hot node blocks.
 455 - Cold node     contains indirect node blocks
 456 - Hot data      contains dentry blocks
 457 - Warm data     contains data blocks except hot and cold data blocks
 458 - Cold data     contains multimedia data or migrated data blocks
 459
 460 LFS has two schemes for free space management: threaded log and copy-and-compac-
 461 tion. The copy-and-compaction scheme which is known as cleaning, is well-suited
 462 for devices showing very good sequential write performance, since free segments
 463 are served all the time for writing new data. However, it suffers from cleaning
 464 overhead under high utilization. Contrarily, the threaded log scheme suffers
 465 from random writes, but no cleaning process is needed. F2FS adopts a hybrid
 466 scheme where the copy-and-compaction scheme is adopted by default, but the
 467 policy is dynamically changed to the threaded log scheme according to the file
 468 system status.
 469
 470 In order to align F2FS with underlying flash-based storage, F2FS allocates a
 471 segment in a unit of section. F2FS expects that the section size would be the
 472 same as the unit size of garbage collection in FTL. Furthermore, with respect
 473 to the mapping granularity in FTL, F2FS allocates each section of the active
 474 logs from different zones as much as possible, since FTL can write the data in
 475 the active logs into one allocation unit according to its mapping granularity.
 476
 477 Cleaning process
 478 ----------------
 479
 480 F2FS does cleaning both on demand and in the background. On-demand cleaning is
 481 triggered when there are not enough free segments to serve VFS calls. Background
 482 cleaner is operated by a kernel thread, and triggers the cleaning job when the
 483 system is idle.
 484
 485 F2FS supports two victim selection policies: greedy and cost-benefit algorithms.
 486 In the greedy algorithm, F2FS selects a victim segment having the smallest number
 487 of valid blocks. In the cost-benefit algorithm, F2FS selects a victim segment
 488 according to the segment age and the number of valid blocks in order to address
 489 log block thrashing problem in the greedy algorithm. F2FS adopts the greedy
 490 algorithm for on-demand cleaner, while background cleaner adopts cost-benefit
 491 algorithm.
 492
 493 In order to identify whether the data in the victim segment are valid or not,
 494 F2FS manages a bitmap. Each bit represents the validity of a block, and the
 495 bitmap is composed of a bit stream covering whole blocks in main area.