mtd: rawnand.h: use nested union kernel-doc markups
[linux-2.6/btrfs-unstable.git] / Documentation / filesystems / f2fs.txt
blob12a147c9f87f208bc018419d50b4306ba907a017
1 ================================================================================
2 WHAT IS Flash-Friendly File System (F2FS)?
3 ================================================================================
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.
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.
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.
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
25 For reporting bugs and sending patches, please use the following mailing list:
26 >> linux-f2fs-devel@lists.sourceforge.net
28 ================================================================================
29 BACKGROUND AND DESIGN ISSUES
30 ================================================================================
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.
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.
54 [1] Bityutskiy, A. 2005. JFFS3 design issues. http://www.linux-mtd.infradead.org/
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.
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.
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.
74 ================================================================================
75 KEY FEATURES
76 ================================================================================
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
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.
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
97 ================================================================================
98 MOUNT OPTIONS
99 ================================================================================
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                        and "strict". In "posix" mode, which is default, fsync
187                        will follow POSIX semantics and does a light operation
188                        to improve the filesystem performance. In "strict" mode,
189                        fsync will be heavy and behaves in line with xfs, ext4
190                        and btrfs, where xfstest generic/342 will pass, but the
191                        performance will regress.
192 test_dummy_encryption  Enable dummy encryption, which provides a fake fscrypt
193                        context. The fake fscrypt context is used by xfstests.
195 ================================================================================
196 DEBUGFS ENTRIES
197 ================================================================================
199 /sys/kernel/debug/f2fs/ contains information about all the partitions mounted as
200 f2fs. Each file shows the whole f2fs information.
202 /sys/kernel/debug/f2fs/status includes:
203  - major file system information managed by f2fs currently
204  - average SIT information about whole segments
205  - current memory footprint consumed by f2fs.
207 ================================================================================
208 SYSFS ENTRIES
209 ================================================================================
211 Information about mounted f2fs file systems can be found in
212 /sys/fs/f2fs.  Each mounted filesystem will have a directory in
213 /sys/fs/f2fs based on its device name (i.e., /sys/fs/f2fs/sda).
214 The files in each per-device directory are shown in table below.
216 Files in /sys/fs/f2fs/<devname>
217 (see also Documentation/ABI/testing/sysfs-fs-f2fs)
218 ..............................................................................
219  File                         Content
221  gc_max_sleep_time            This tuning parameter controls the maximum sleep
222                               time for the garbage collection thread. Time is
223                               in milliseconds.
225  gc_min_sleep_time            This tuning parameter controls the minimum sleep
226                               time for the garbage collection thread. Time is
227                               in milliseconds.
229  gc_no_gc_sleep_time          This tuning parameter controls the default sleep
230                               time for the garbage collection thread. Time is
231                               in milliseconds.
233  gc_idle                      This parameter controls the selection of victim
234                               policy for garbage collection. Setting gc_idle = 0
235                               (default) will disable this option. Setting
236                               gc_idle = 1 will select the Cost Benefit approach
237                               & setting gc_idle = 2 will select the greedy approach.
239  gc_urgent                    This parameter controls triggering background GCs
240                               urgently or not. Setting gc_urgent = 0 [default]
241                               makes back to default behavior, while if it is set
242                               to 1, background thread starts to do GC by given
243                               gc_urgent_sleep_time interval.
245  gc_urgent_sleep_time         This parameter controls sleep time for gc_urgent.
246                               500 ms is set by default. See above gc_urgent.
248  reclaim_segments             This parameter controls the number of prefree
249                               segments to be reclaimed. If the number of prefree
250                               segments is larger than the number of segments
251                               in the proportion to the percentage over total
252                               volume size, f2fs tries to conduct checkpoint to
253                               reclaim the prefree segments to free segments.
254                               By default, 5% over total # of segments.
256  max_small_discards           This parameter controls the number of discard
257                               commands that consist small blocks less than 2MB.
258                               The candidates to be discarded are cached until
259                               checkpoint is triggered, and issued during the
260                               checkpoint. By default, it is disabled with 0.
262  trim_sections                This parameter controls the number of sections
263                               to be trimmed out in batch mode when FITRIM
264                               conducts. 32 sections is set by default.
266  ipu_policy                   This parameter controls the policy of in-place
267                               updates in f2fs. There are five policies:
268                                0x01: F2FS_IPU_FORCE, 0x02: F2FS_IPU_SSR,
269                                0x04: F2FS_IPU_UTIL,  0x08: F2FS_IPU_SSR_UTIL,
270                                0x10: F2FS_IPU_FSYNC.
272  min_ipu_util                 This parameter controls the threshold to trigger
273                               in-place-updates. The number indicates percentage
274                               of the filesystem utilization, and used by
275                               F2FS_IPU_UTIL and F2FS_IPU_SSR_UTIL policies.
277  min_fsync_blocks             This parameter controls the threshold to trigger
278                               in-place-updates when F2FS_IPU_FSYNC mode is set.
279                               The number indicates the number of dirty pages
280                               when fsync needs to flush on its call path. If
281                               the number is less than this value, it triggers
282                               in-place-updates.
284  max_victim_search            This parameter controls the number of trials to
285                               find a victim segment when conducting SSR and
286                               cleaning operations. The default value is 4096
287                               which covers 8GB block address range.
289  dir_level                    This parameter controls the directory level to
290                               support large directory. If a directory has a
291                               number of files, it can reduce the file lookup
292                               latency by increasing this dir_level value.
293                               Otherwise, it needs to decrease this value to
294                               reduce the space overhead. The default value is 0.
296  ram_thresh                   This parameter controls the memory footprint used
297                               by free nids and cached nat entries. By default,
298                               10 is set, which indicates 10 MB / 1 GB RAM.
300 ================================================================================
301 USAGE
302 ================================================================================
304 1. Download userland tools and compile them.
306 2. Skip, if f2fs was compiled statically inside kernel.
307    Otherwise, insert the f2fs.ko module.
308  # insmod f2fs.ko
310 3. Create a directory trying to mount
311  # mkdir /mnt/f2fs
313 4. Format the block device, and then mount as f2fs
314  # mkfs.f2fs -l label /dev/block_device
315  # mount -t f2fs /dev/block_device /mnt/f2fs
317 mkfs.f2fs
318 ---------
319 The mkfs.f2fs is for the use of formatting a partition as the f2fs filesystem,
320 which builds a basic on-disk layout.
322 The options consist of:
323 -l [label]   : Give a volume label, up to 512 unicode name.
324 -a [0 or 1]  : Split start location of each area for heap-based allocation.
325                1 is set by default, which performs this.
326 -o [int]     : Set overprovision ratio in percent over volume size.
327                5 is set by default.
328 -s [int]     : Set the number of segments per section.
329                1 is set by default.
330 -z [int]     : Set the number of sections per zone.
331                1 is set by default.
332 -e [str]     : Set basic extension list. e.g. "mp3,gif,mov"
333 -t [0 or 1]  : Disable discard command or not.
334                1 is set by default, which conducts discard.
336 fsck.f2fs
337 ---------
338 The fsck.f2fs is a tool to check the consistency of an f2fs-formatted
339 partition, which examines whether the filesystem metadata and user-made data
340 are cross-referenced correctly or not.
341 Note that, initial version of the tool does not fix any inconsistency.
343 The options consist of:
344   -d debug level [default:0]
346 dump.f2fs
347 ---------
348 The dump.f2fs shows the information of specific inode and dumps SSA and SIT to
349 file. Each file is dump_ssa and dump_sit.
351 The dump.f2fs is used to debug on-disk data structures of the f2fs filesystem.
352 It shows on-disk inode information recognized by a given inode number, and is
353 able to dump all the SSA and SIT entries into predefined files, ./dump_ssa and
354 ./dump_sit respectively.
356 The options consist of:
357   -d debug level [default:0]
358   -i inode no (hex)
359   -s [SIT dump segno from #1~#2 (decimal), for all 0~-1]
360   -a [SSA dump segno from #1~#2 (decimal), for all 0~-1]
362 Examples:
363 # dump.f2fs -i [ino] /dev/sdx
364 # dump.f2fs -s 0~-1 /dev/sdx (SIT dump)
365 # dump.f2fs -a 0~-1 /dev/sdx (SSA dump)
367 ================================================================================
368 DESIGN
369 ================================================================================
371 On-disk Layout
372 --------------
374 F2FS divides the whole volume into a number of segments, each of which is fixed
375 to 2MB in size. A section is composed of consecutive segments, and a zone
376 consists of a set of sections. By default, section and zone sizes are set to one
377 segment size identically, but users can easily modify the sizes by mkfs.
379 F2FS splits the entire volume into six areas, and all the areas except superblock
380 consists of multiple segments as described below.
382                                             align with the zone size <-|
383                  |-> align with the segment size
384      _________________________________________________________________________
385     |            |            |   Segment   |    Node     |   Segment  |      |
386     | Superblock | Checkpoint |    Info.    |   Address   |   Summary  | Main |
387     |    (SB)    |   (CP)     | Table (SIT) | Table (NAT) | Area (SSA) |      |
388     |____________|_____2______|______N______|______N______|______N_____|__N___|
389                                                                        .      .
390                                                              .                .
391                                                  .                            .
392                                     ._________________________________________.
393                                     |_Segment_|_..._|_Segment_|_..._|_Segment_|
394                                     .           .
395                                     ._________._________
396                                     |_section_|__...__|_
397                                     .            .
398                                     .________.
399                                     |__zone__|
401 - Superblock (SB)
402  : It is located at the beginning of the partition, and there exist two copies
403    to avoid file system crash. It contains basic partition information and some
404    default parameters of f2fs.
406 - Checkpoint (CP)
407  : It contains file system information, bitmaps for valid NAT/SIT sets, orphan
408    inode lists, and summary entries of current active segments.
410 - Segment Information Table (SIT)
411  : It contains segment information such as valid block count and bitmap for the
412    validity of all the blocks.
414 - Node Address Table (NAT)
415  : It is composed of a block address table for all the node blocks stored in
416    Main area.
418 - Segment Summary Area (SSA)
419  : It contains summary entries which contains the owner information of all the
420    data and node blocks stored in Main area.
422 - Main Area
423  : It contains file and directory data including their indices.
425 In order to avoid misalignment between file system and flash-based storage, F2FS
426 aligns the start block address of CP with the segment size. Also, it aligns the
427 start block address of Main area with the zone size by reserving some segments
428 in SSA area.
430 Reference the following survey for additional technical details.
431 https://wiki.linaro.org/WorkingGroups/Kernel/Projects/FlashCardSurvey
433 File System Metadata Structure
434 ------------------------------
436 F2FS adopts the checkpointing scheme to maintain file system consistency. At
437 mount time, F2FS first tries to find the last valid checkpoint data by scanning
438 CP area. In order to reduce the scanning time, F2FS uses only two copies of CP.
439 One of them always indicates the last valid data, which is called as shadow copy
440 mechanism. In addition to CP, NAT and SIT also adopt the shadow copy mechanism.
442 For file system consistency, each CP points to which NAT and SIT copies are
443 valid, as shown as below.
445   +--------+----------+---------+
446   |   CP   |    SIT   |   NAT   |
447   +--------+----------+---------+
448   .         .          .          .
449   .            .              .              .
450   .               .                 .                 .
451   +-------+-------+--------+--------+--------+--------+
452   | CP #0 | CP #1 | SIT #0 | SIT #1 | NAT #0 | NAT #1 |
453   +-------+-------+--------+--------+--------+--------+
454      |             ^                          ^
455      |             |                          |
456      `----------------------------------------'
458 Index Structure
459 ---------------
461 The key data structure to manage the data locations is a "node". Similar to
462 traditional file structures, F2FS has three types of node: inode, direct node,
463 indirect node. F2FS assigns 4KB to an inode block which contains 923 data block
464 indices, two direct node pointers, two indirect node pointers, and one double
465 indirect node pointer as described below. One direct node block contains 1018
466 data blocks, and one indirect node block contains also 1018 node blocks. Thus,
467 one inode block (i.e., a file) covers:
469   4KB * (923 + 2 * 1018 + 2 * 1018 * 1018 + 1018 * 1018 * 1018) := 3.94TB.
471    Inode block (4KB)
472      |- data (923)
473      |- direct node (2)
474      |          `- data (1018)
475      |- indirect node (2)
476      |            `- direct node (1018)
477      |                       `- data (1018)
478      `- double indirect node (1)
479                          `- indirect node (1018)
480                                       `- direct node (1018)
481                                                  `- data (1018)
483 Note that, all the node blocks are mapped by NAT which means the location of
484 each node is translated by the NAT table. In the consideration of the wandering
485 tree problem, F2FS is able to cut off the propagation of node updates caused by
486 leaf data writes.
488 Directory Structure
489 -------------------
491 A directory entry occupies 11 bytes, which consists of the following attributes.
493 - hash          hash value of the file name
494 - ino           inode number
495 - len           the length of file name
496 - type          file type such as directory, symlink, etc
498 A dentry block consists of 214 dentry slots and file names. Therein a bitmap is
499 used to represent whether each dentry is valid or not. A dentry block occupies
500 4KB with the following composition.
502   Dentry Block(4 K) = bitmap (27 bytes) + reserved (3 bytes) +
503                       dentries(11 * 214 bytes) + file name (8 * 214 bytes)
505                          [Bucket]
506              +--------------------------------+
507              |dentry block 1 | dentry block 2 |
508              +--------------------------------+
509              .               .
510        .                             .
511   .       [Dentry Block Structure: 4KB]       .
512   +--------+----------+----------+------------+
513   | bitmap | reserved | dentries | file names |
514   +--------+----------+----------+------------+
515   [Dentry Block: 4KB] .   .
516                  .               .
517             .                          .
518             +------+------+-----+------+
519             | hash | ino  | len | type |
520             +------+------+-----+------+
521             [Dentry Structure: 11 bytes]
523 F2FS implements multi-level hash tables for directory structure. Each level has
524 a hash table with dedicated number of hash buckets as shown below. Note that
525 "A(2B)" means a bucket includes 2 data blocks.
527 ----------------------
528 A : bucket
529 B : block
530 N : MAX_DIR_HASH_DEPTH
531 ----------------------
533 level #0   | A(2B)
534            |
535 level #1   | A(2B) - A(2B)
536            |
537 level #2   | A(2B) - A(2B) - A(2B) - A(2B)
538      .     |   .       .       .       .
539 level #N/2 | A(2B) - A(2B) - A(2B) - A(2B) - A(2B) - ... - A(2B)
540      .     |   .       .       .       .
541 level #N   | A(4B) - A(4B) - A(4B) - A(4B) - A(4B) - ... - A(4B)
543 The number of blocks and buckets are determined by,
545                             ,- 2, if n < MAX_DIR_HASH_DEPTH / 2,
546   # of blocks in level #n = |
547                             `- 4, Otherwise
549                              ,- 2^(n + dir_level),
550                              |        if n + dir_level < MAX_DIR_HASH_DEPTH / 2,
551   # of buckets in level #n = |
552                              `- 2^((MAX_DIR_HASH_DEPTH / 2) - 1),
553                                       Otherwise
555 When F2FS finds a file name in a directory, at first a hash value of the file
556 name is calculated. Then, F2FS scans the hash table in level #0 to find the
557 dentry consisting of the file name and its inode number. If not found, F2FS
558 scans the next hash table in level #1. In this way, F2FS scans hash tables in
559 each levels incrementally from 1 to N. In each levels F2FS needs to scan only
560 one bucket determined by the following equation, which shows O(log(# of files))
561 complexity.
563   bucket number to scan in level #n = (hash value) % (# of buckets in level #n)
565 In the case of file creation, F2FS finds empty consecutive slots that cover the
566 file name. F2FS searches the empty slots in the hash tables of whole levels from
567 1 to N in the same way as the lookup operation.
569 The following figure shows an example of two cases holding children.
570        --------------> Dir <--------------
571        |                                 |
572     child                             child
574     child - child                     [hole] - child
576     child - child - child             [hole] - [hole] - child
578    Case 1:                           Case 2:
579    Number of children = 6,           Number of children = 3,
580    File size = 7                     File size = 7
582 Default Block Allocation
583 ------------------------
585 At runtime, F2FS manages six active logs inside "Main" area: Hot/Warm/Cold node
586 and Hot/Warm/Cold data.
588 - Hot node      contains direct node blocks of directories.
589 - Warm node     contains direct node blocks except hot node blocks.
590 - Cold node     contains indirect node blocks
591 - Hot data      contains dentry blocks
592 - Warm data     contains data blocks except hot and cold data blocks
593 - Cold data     contains multimedia data or migrated data blocks
595 LFS has two schemes for free space management: threaded log and copy-and-compac-
596 tion. The copy-and-compaction scheme which is known as cleaning, is well-suited
597 for devices showing very good sequential write performance, since free segments
598 are served all the time for writing new data. However, it suffers from cleaning
599 overhead under high utilization. Contrarily, the threaded log scheme suffers
600 from random writes, but no cleaning process is needed. F2FS adopts a hybrid
601 scheme where the copy-and-compaction scheme is adopted by default, but the
602 policy is dynamically changed to the threaded log scheme according to the file
603 system status.
605 In order to align F2FS with underlying flash-based storage, F2FS allocates a
606 segment in a unit of section. F2FS expects that the section size would be the
607 same as the unit size of garbage collection in FTL. Furthermore, with respect
608 to the mapping granularity in FTL, F2FS allocates each section of the active
609 logs from different zones as much as possible, since FTL can write the data in
610 the active logs into one allocation unit according to its mapping granularity.
612 Cleaning process
613 ----------------
615 F2FS does cleaning both on demand and in the background. On-demand cleaning is
616 triggered when there are not enough free segments to serve VFS calls. Background
617 cleaner is operated by a kernel thread, and triggers the cleaning job when the
618 system is idle.
620 F2FS supports two victim selection policies: greedy and cost-benefit algorithms.
621 In the greedy algorithm, F2FS selects a victim segment having the smallest number
622 of valid blocks. In the cost-benefit algorithm, F2FS selects a victim segment
623 according to the segment age and the number of valid blocks in order to address
624 log block thrashing problem in the greedy algorithm. F2FS adopts the greedy
625 algorithm for on-demand cleaner, while background cleaner adopts cost-benefit
626 algorithm.
628 In order to identify whether the data in the victim segment are valid or not,
629 F2FS manages a bitmap. Each bit represents the validity of a block, and the
630 bitmap is composed of a bit stream covering whole blocks in main area.
632 Write-hint Policy
633 -----------------
635 1) whint_mode=off. F2FS only passes down WRITE_LIFE_NOT_SET.
637 2) whint_mode=user-based. F2FS tries to pass down hints given by
638 users.
640 User                  F2FS                     Block
641 ----                  ----                     -----
642                       META                     WRITE_LIFE_NOT_SET
643                       HOT_NODE                 "
644                       WARM_NODE                "
645                       COLD_NODE                "
646 *ioctl(COLD)          COLD_DATA                WRITE_LIFE_EXTREME
647 *extension list       "                        "
649 -- buffered io
650 WRITE_LIFE_EXTREME    COLD_DATA                WRITE_LIFE_EXTREME
651 WRITE_LIFE_SHORT      HOT_DATA                 WRITE_LIFE_SHORT
652 WRITE_LIFE_NOT_SET    WARM_DATA                WRITE_LIFE_NOT_SET
653 WRITE_LIFE_NONE       "                        "
654 WRITE_LIFE_MEDIUM     "                        "
655 WRITE_LIFE_LONG       "                        "
657 -- direct io
658 WRITE_LIFE_EXTREME    COLD_DATA                WRITE_LIFE_EXTREME
659 WRITE_LIFE_SHORT      HOT_DATA                 WRITE_LIFE_SHORT
660 WRITE_LIFE_NOT_SET    WARM_DATA                WRITE_LIFE_NOT_SET
661 WRITE_LIFE_NONE       "                        WRITE_LIFE_NONE
662 WRITE_LIFE_MEDIUM     "                        WRITE_LIFE_MEDIUM
663 WRITE_LIFE_LONG       "                        WRITE_LIFE_LONG
665 3) whint_mode=fs-based. F2FS passes down hints with its policy.
667 User                  F2FS                     Block
668 ----                  ----                     -----
669                       META                     WRITE_LIFE_MEDIUM;
670                       HOT_NODE                 WRITE_LIFE_NOT_SET
671                       WARM_NODE                "
672                       COLD_NODE                WRITE_LIFE_NONE
673 ioctl(COLD)           COLD_DATA                WRITE_LIFE_EXTREME
674 extension list        "                        "
676 -- buffered io
677 WRITE_LIFE_EXTREME    COLD_DATA                WRITE_LIFE_EXTREME
678 WRITE_LIFE_SHORT      HOT_DATA                 WRITE_LIFE_SHORT
679 WRITE_LIFE_NOT_SET    WARM_DATA                WRITE_LIFE_LONG
680 WRITE_LIFE_NONE       "                        "
681 WRITE_LIFE_MEDIUM     "                        "
682 WRITE_LIFE_LONG       "                        "
684 -- direct io
685 WRITE_LIFE_EXTREME    COLD_DATA                WRITE_LIFE_EXTREME
686 WRITE_LIFE_SHORT      HOT_DATA                 WRITE_LIFE_SHORT
687 WRITE_LIFE_NOT_SET    WARM_DATA                WRITE_LIFE_NOT_SET
688 WRITE_LIFE_NONE       "                        WRITE_LIFE_NONE
689 WRITE_LIFE_MEDIUM     "                        WRITE_LIFE_MEDIUM
690 WRITE_LIFE_LONG       "                        WRITE_LIFE_LONG