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