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