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