blob: b640a3764cfad2e5a51245ad80a4c08ae42c1efc [file] [log] [blame]
Jaegeuk Kim98e4da82012-11-02 17:05:42 +09001================================================================================
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
Changman Leed51a7fb2013-07-04 17:12:47 +090021The following git tree provides the file system formatting tool (mkfs.f2fs),
22a consistency checking tool (fsck.f2fs), and a debugging tool (dump.f2fs).
Jaegeuk Kim5bb446a2012-11-27 14:36:14 +090023>> 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
Jaegeuk Kim98e4da82012-11-02 17:05:42 +090027
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
Namjae Jeon696c0182013-06-16 09:48:48 +0900101background_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
Masanari Iida4bb99982015-11-16 20:46:28 +0900105 will be turned off. If background_gc=sync, it will turn
Jaegeuk Kim6aefd932015-10-05 11:02:54 -0700106 on synchronous garbage collection running in background.
Namjae Jeon696c0182013-06-16 09:48:48 +0900107 Default value for this option is on. So garbage
108 collection is on by default.
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900109disable_roll_forward Disable the roll-forward recovery routine
Jaegeuk Kim2d834bf2015-01-23 18:33:46 -0800110norecovery Disable the roll-forward recovery routine, mounted read-
111 only (i.e., -o ro,disable_roll_forward)
Chao Yu64058be2016-07-03 22:05:14 +0800112discard/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.
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900115no_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.
118nouser_xattr Disable Extended User Attributes. Note: xattr is enabled
119 by default if CONFIG_F2FS_FS_XATTR is selected.
120noacl Disable POSIX Access Control List. Note: acl is enabled
121 by default if CONFIG_F2FS_FS_POSIX_ACL is selected.
122active_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.
125disable_ext_identify Disable the extension list configured by mkfs, so f2fs
126 does not aware of cold files such as media files.
Jaegeuk Kim66e960c2013-11-01 11:20:05 +0900127inline_xattr Enable the inline xattrs feature.
Huajun Lie4024e82013-11-10 23:13:21 +0800128inline_data Enable the inline data feature: New created small(<~3.4k)
129 files can be written into inode block.
Chao Yud37a8682014-09-24 18:20:23 +0800130inline_dentry Enable the inline dir feature: data in new created
131 directory entries can be written into inode block. The
132 space of inode block which is used to store inline
133 dentries is limited to ~3.4k.
Chao Yu97c17942016-05-09 19:56:34 +0800134noinline_dentry Diable the inline dentry feature.
Jaegeuk Kim6b4afdd2014-04-02 15:34:36 +0900135flush_merge Merge concurrent cache_flush commands as much as possible
136 to eliminate redundant command issues. If the underlying
137 device handles the cache_flush command relatively slowly,
138 recommend to enable this option.
Jaegeuk Kim0f7b2ab2014-07-23 09:57:31 -0700139nobarrier This option can be used if underlying storage guarantees
140 its cached data should be written to the novolatile area.
141 If this option is set, no cache_flush commands are issued
142 but f2fs still guarantees the write ordering of all the
143 data writes.
Jaegeuk Kimd5053a342014-10-30 22:47:03 -0700144fastboot This option is used when a system wants to reduce mount
145 time as much as possible, even though normal performance
146 can be sacrificed.
Chao Yu89672152015-02-05 17:55:51 +0800147extent_cache Enable an extent cache based on rb-tree, it can cache
148 as many as extent which map between contiguous logical
149 address and physical address per inode, resulting in
Jaegeuk Kim7daaea22015-06-25 17:43:04 -0700150 increasing the cache hit ratio. Set by default.
Masanari Iida4bb99982015-11-16 20:46:28 +0900151noextent_cache Disable an extent cache based on rb-tree explicitly, see
Jaegeuk Kim7daaea22015-06-25 17:43:04 -0700152 the above extent_cache mount option.
Wanpeng Li75342792015-03-24 10:20:27 +0800153noinline_data Disable the inline data feature, inline data feature is
154 enabled by default.
Chao Yu343f40f2015-12-16 13:12:16 +0800155data_flush Enable data flushing before checkpoint in order to
156 persist data of regular and symlink.
Chao Yu0ef692e2018-08-08 17:36:41 +0800157fault_injection=%d Enable fault injection in all supported types with
158 specified injection rate.
159fault_type=%d Support configuring fault injection type, should be
160 enabled with fault_injection option, fault type value
161 is shown below, it supports single or combined type.
162 Type_Name Type_Value
163 FAULT_KMALLOC 0x000000001
164 FAULT_KVMALLOC 0x000000002
165 FAULT_PAGE_ALLOC 0x000000004
166 FAULT_PAGE_GET 0x000000008
167 FAULT_ALLOC_BIO 0x000000010
168 FAULT_ALLOC_NID 0x000000020
169 FAULT_ORPHAN 0x000000040
170 FAULT_BLOCK 0x000000080
171 FAULT_DIR_DEPTH 0x000000100
172 FAULT_EVICT_INODE 0x000000200
173 FAULT_TRUNCATE 0x000000400
Chao Yu40292b92018-09-12 09:22:29 +0800174 FAULT_READ_IO 0x000000800
Chao Yu0ef692e2018-08-08 17:36:41 +0800175 FAULT_CHECKPOINT 0x000001000
176 FAULT_DISCARD 0x000002000
Chao Yu40292b92018-09-12 09:22:29 +0800177 FAULT_WRITE_IO 0x000004000
Jaegeuk Kim36abef42016-06-03 19:29:38 -0700178mode=%s Control block allocation mode which supports "adaptive"
179 and "lfs". In "lfs" mode, there should be no random
180 writes towards main area.
Chao Yu09c3a722017-07-09 00:13:07 +0800181io_bits=%u Set the bit size of write IO requests. It should be set
182 with "mode=lfs".
183usrquota Enable plain user disk quota accounting.
184grpquota Enable plain group disk quota accounting.
Chao Yu5647b302017-07-26 00:01:41 +0800185prjquota Enable plain project quota accounting.
Chao Yu41ad73f2017-08-08 10:54:31 +0800186usrjquota=<file> Appoint specified file and type during mount, so that quota
187grpjquota=<file> information can be properly updated during recovery flow,
188prjjquota=<file> <quota file>: must be in root directory;
189jqfmt=<quota type> <quota type>: [vfsold,vfsv0,vfsv1].
190offusrjquota Turn off user journelled quota.
191offgrpjquota Turn off group journelled quota.
192offprjjquota Turn off project journelled quota.
193quota Enable plain user disk quota accounting.
194noquota Disable all plain disk quota option.
Jaegeuk Kim78c1fc22018-02-18 08:50:49 -0800195whint_mode=%s Control which write hints are passed down to block
196 layer. This supports "off", "user-based", and
197 "fs-based". In "off" mode (default), f2fs does not pass
198 down hints. In "user-based" mode, f2fs tries to pass
199 down hints given by users. And in "fs-based" mode, f2fs
200 passes down hints with its policy.
201alloc_mode=%s Adjust block allocation policy, which supports "reuse"
202 and "default".
Jaegeuk Kim3a38cf12018-05-25 18:02:58 -0700203fsync_mode=%s Control the policy of fsync. Currently supports "posix",
204 "strict", and "nobarrier". In "posix" mode, which is
205 default, fsync will follow POSIX semantics and does a
206 light operation to improve the filesystem performance.
207 In "strict" mode, fsync will be heavy and behaves in line
208 with xfs, ext4 and btrfs, where xfstest generic/342 will
209 pass, but the performance will regress. "nobarrier" is
210 based on "posix", but doesn't issue flush command for
211 non-atomic files likewise "nobarrier" mount option.
Sheng Yongaa5bcfd2018-03-15 18:51:42 +0800212test_dummy_encryption Enable dummy encryption, which provides a fake fscrypt
213 context. The fake fscrypt context is used by xfstests.
Daniel Rosenbergf22f93a2018-08-20 19:21:43 -0700214checkpoint=%s Set to "disable" to turn off checkpointing. Set to "enable"
215 to reenable checkpointing. Is enabled by default. While
216 disabled, any unmounting or unexpected shutdowns will cause
217 the filesystem contents to appear as they did when the
218 filesystem was mounted with that option.
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900219
220================================================================================
221DEBUGFS ENTRIES
222================================================================================
223
224/sys/kernel/debug/f2fs/ contains information about all the partitions mounted as
225f2fs. Each file shows the whole f2fs information.
226
227/sys/kernel/debug/f2fs/status includes:
228 - major file system information managed by f2fs currently
229 - average SIT information about whole segments
230 - current memory footprint consumed by f2fs.
231
232================================================================================
Namjae Jeonb59d0ba2013-08-04 23:09:40 +0900233SYSFS ENTRIES
234================================================================================
235
236Information about mounted f2f2 file systems can be found in
237/sys/fs/f2fs. Each mounted filesystem will have a directory in
238/sys/fs/f2fs based on its device name (i.e., /sys/fs/f2fs/sda).
239The files in each per-device directory are shown in table below.
240
241Files in /sys/fs/f2fs/<devname>
242(see also Documentation/ABI/testing/sysfs-fs-f2fs)
243..............................................................................
244 File Content
245
246 gc_max_sleep_time This tuning parameter controls the maximum sleep
247 time for the garbage collection thread. Time is
248 in milliseconds.
249
250 gc_min_sleep_time This tuning parameter controls the minimum sleep
251 time for the garbage collection thread. Time is
252 in milliseconds.
253
254 gc_no_gc_sleep_time This tuning parameter controls the default sleep
255 time for the garbage collection thread. Time is
256 in milliseconds.
257
Namjae Jeond2dc0952013-08-04 23:10:15 +0900258 gc_idle This parameter controls the selection of victim
259 policy for garbage collection. Setting gc_idle = 0
260 (default) will disable this option. Setting
261 gc_idle = 1 will select the Cost Benefit approach
Masanari Iida4bb99982015-11-16 20:46:28 +0900262 & setting gc_idle = 2 will select the greedy approach.
Namjae Jeond2dc0952013-08-04 23:10:15 +0900263
Jaegeuk Kimbd2ffc22017-08-06 22:09:00 -0700264 gc_urgent This parameter controls triggering background GCs
265 urgently or not. Setting gc_urgent = 0 [default]
266 makes back to default behavior, while if it is set
267 to 1, background thread starts to do GC by given
268 gc_urgent_sleep_time interval.
269
270 gc_urgent_sleep_time This parameter controls sleep time for gc_urgent.
271 500 ms is set by default. See above gc_urgent.
272
Jaegeuk Kimea91e9b2013-10-24 15:49:07 +0900273 reclaim_segments This parameter controls the number of prefree
274 segments to be reclaimed. If the number of prefree
Jaegeuk Kim58c41032014-03-19 14:17:21 +0900275 segments is larger than the number of segments
276 in the proportion to the percentage over total
277 volume size, f2fs tries to conduct checkpoint to
278 reclaim the prefree segments to free segments.
279 By default, 5% over total # of segments.
Jaegeuk Kimea91e9b2013-10-24 15:49:07 +0900280
Jaegeuk Kimba0697e2013-12-19 17:44:41 +0900281 max_small_discards This parameter controls the number of discard
282 commands that consist small blocks less than 2MB.
283 The candidates to be discarded are cached until
284 checkpoint is triggered, and issued during the
285 checkpoint. By default, it is disabled with 0.
286
Jaegeuk Kimbba681c2015-01-26 17:41:23 -0800287 trim_sections This parameter controls the number of sections
288 to be trimmed out in batch mode when FITRIM
289 conducts. 32 sections is set by default.
290
Jaegeuk Kim216fbd62013-11-07 13:13:42 +0900291 ipu_policy This parameter controls the policy of in-place
292 updates in f2fs. There are five policies:
Jaegeuk Kim9b5f1362014-09-16 18:30:54 -0700293 0x01: F2FS_IPU_FORCE, 0x02: F2FS_IPU_SSR,
294 0x04: F2FS_IPU_UTIL, 0x08: F2FS_IPU_SSR_UTIL,
295 0x10: F2FS_IPU_FSYNC.
Jaegeuk Kim216fbd62013-11-07 13:13:42 +0900296
297 min_ipu_util This parameter controls the threshold to trigger
298 in-place-updates. The number indicates percentage
299 of the filesystem utilization, and used by
300 F2FS_IPU_UTIL and F2FS_IPU_SSR_UTIL policies.
301
Jaegeuk Kimc1ce1b02014-09-10 16:53:02 -0700302 min_fsync_blocks This parameter controls the threshold to trigger
303 in-place-updates when F2FS_IPU_FSYNC mode is set.
304 The number indicates the number of dirty pages
305 when fsync needs to flush on its call path. If
306 the number is less than this value, it triggers
307 in-place-updates.
308
Jaegeuk Kim3bac3802014-01-09 21:00:06 +0900309 max_victim_search This parameter controls the number of trials to
310 find a victim segment when conducting SSR and
311 cleaning operations. The default value is 4096
312 which covers 8GB block address range.
313
Jaegeuk Kimab9fa662014-02-27 20:09:05 +0900314 dir_level This parameter controls the directory level to
315 support large directory. If a directory has a
316 number of files, it can reduce the file lookup
317 latency by increasing this dir_level value.
318 Otherwise, it needs to decrease this value to
319 reduce the space overhead. The default value is 0.
320
Jaegeuk Kimcdfc41c2014-03-19 13:31:37 +0900321 ram_thresh This parameter controls the memory footprint used
322 by free nids and cached nat entries. By default,
323 10 is set, which indicates 10 MB / 1 GB RAM.
324
Namjae Jeonb59d0ba2013-08-04 23:09:40 +0900325================================================================================
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900326USAGE
327================================================================================
328
3291. Download userland tools and compile them.
330
3312. Skip, if f2fs was compiled statically inside kernel.
332 Otherwise, insert the f2fs.ko module.
333 # insmod f2fs.ko
334
3353. Create a directory trying to mount
336 # mkdir /mnt/f2fs
337
3384. Format the block device, and then mount as f2fs
339 # mkfs.f2fs -l label /dev/block_device
340 # mount -t f2fs /dev/block_device /mnt/f2fs
341
Changman Leed51a7fb2013-07-04 17:12:47 +0900342mkfs.f2fs
343---------
344The mkfs.f2fs is for the use of formatting a partition as the f2fs filesystem,
345which builds a basic on-disk layout.
346
347The options consist of:
Changman Lee1571f842013-04-03 15:26:49 +0900348-l [label] : Give a volume label, up to 512 unicode name.
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900349-a [0 or 1] : Split start location of each area for heap-based allocation.
350 1 is set by default, which performs this.
351-o [int] : Set overprovision ratio in percent over volume size.
352 5 is set by default.
353-s [int] : Set the number of segments per section.
354 1 is set by default.
355-z [int] : Set the number of sections per zone.
356 1 is set by default.
357-e [str] : Set basic extension list. e.g. "mp3,gif,mov"
Changman Lee1571f842013-04-03 15:26:49 +0900358-t [0 or 1] : Disable discard command or not.
359 1 is set by default, which conducts discard.
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900360
Changman Leed51a7fb2013-07-04 17:12:47 +0900361fsck.f2fs
362---------
363The fsck.f2fs is a tool to check the consistency of an f2fs-formatted
364partition, which examines whether the filesystem metadata and user-made data
365are cross-referenced correctly or not.
366Note that, initial version of the tool does not fix any inconsistency.
367
368The options consist of:
369 -d debug level [default:0]
370
371dump.f2fs
372---------
373The dump.f2fs shows the information of specific inode and dumps SSA and SIT to
374file. Each file is dump_ssa and dump_sit.
375
376The dump.f2fs is used to debug on-disk data structures of the f2fs filesystem.
Masanari Iida4bb99982015-11-16 20:46:28 +0900377It shows on-disk inode information recognized by a given inode number, and is
Changman Leed51a7fb2013-07-04 17:12:47 +0900378able to dump all the SSA and SIT entries into predefined files, ./dump_ssa and
379./dump_sit respectively.
380
381The options consist of:
382 -d debug level [default:0]
383 -i inode no (hex)
384 -s [SIT dump segno from #1~#2 (decimal), for all 0~-1]
385 -a [SSA dump segno from #1~#2 (decimal), for all 0~-1]
386
387Examples:
388# dump.f2fs -i [ino] /dev/sdx
389# dump.f2fs -s 0~-1 /dev/sdx (SIT dump)
390# dump.f2fs -a 0~-1 /dev/sdx (SSA dump)
391
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900392================================================================================
393DESIGN
394================================================================================
395
396On-disk Layout
397--------------
398
399F2FS divides the whole volume into a number of segments, each of which is fixed
400to 2MB in size. A section is composed of consecutive segments, and a zone
401consists of a set of sections. By default, section and zone sizes are set to one
402segment size identically, but users can easily modify the sizes by mkfs.
403
404F2FS splits the entire volume into six areas, and all the areas except superblock
405consists of multiple segments as described below.
406
407 align with the zone size <-|
408 |-> align with the segment size
409 _________________________________________________________________________
Huajun Li9268cc32012-12-31 13:59:04 +0800410 | | | Segment | Node | Segment | |
411 | Superblock | Checkpoint | Info. | Address | Summary | Main |
412 | (SB) | (CP) | Table (SIT) | Table (NAT) | Area (SSA) | |
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900413 |____________|_____2______|______N______|______N______|______N_____|__N___|
414 . .
415 . .
416 . .
417 ._________________________________________.
418 |_Segment_|_..._|_Segment_|_..._|_Segment_|
419 . .
420 ._________._________
421 |_section_|__...__|_
422 . .
423 .________.
424 |__zone__|
425
426- Superblock (SB)
427 : It is located at the beginning of the partition, and there exist two copies
428 to avoid file system crash. It contains basic partition information and some
429 default parameters of f2fs.
430
431- Checkpoint (CP)
432 : It contains file system information, bitmaps for valid NAT/SIT sets, orphan
433 inode lists, and summary entries of current active segments.
434
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900435- Segment Information Table (SIT)
436 : It contains segment information such as valid block count and bitmap for the
437 validity of all the blocks.
438
Huajun Li9268cc32012-12-31 13:59:04 +0800439- Node Address Table (NAT)
440 : It is composed of a block address table for all the node blocks stored in
441 Main area.
442
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900443- Segment Summary Area (SSA)
444 : It contains summary entries which contains the owner information of all the
445 data and node blocks stored in Main area.
446
447- Main Area
448 : It contains file and directory data including their indices.
449
450In order to avoid misalignment between file system and flash-based storage, F2FS
451aligns the start block address of CP with the segment size. Also, it aligns the
452start block address of Main area with the zone size by reserving some segments
453in SSA area.
454
455Reference the following survey for additional technical details.
456https://wiki.linaro.org/WorkingGroups/Kernel/Projects/FlashCardSurvey
457
458File System Metadata Structure
459------------------------------
460
461F2FS adopts the checkpointing scheme to maintain file system consistency. At
462mount time, F2FS first tries to find the last valid checkpoint data by scanning
463CP area. In order to reduce the scanning time, F2FS uses only two copies of CP.
464One of them always indicates the last valid data, which is called as shadow copy
465mechanism. In addition to CP, NAT and SIT also adopt the shadow copy mechanism.
466
467For file system consistency, each CP points to which NAT and SIT copies are
468valid, as shown as below.
469
470 +--------+----------+---------+
Huajun Li9268cc32012-12-31 13:59:04 +0800471 | CP | SIT | NAT |
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900472 +--------+----------+---------+
473 . . . .
474 . . . .
475 . . . .
476 +-------+-------+--------+--------+--------+--------+
Huajun Li9268cc32012-12-31 13:59:04 +0800477 | CP #0 | CP #1 | SIT #0 | SIT #1 | NAT #0 | NAT #1 |
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900478 +-------+-------+--------+--------+--------+--------+
479 | ^ ^
480 | | |
481 `----------------------------------------'
482
483Index Structure
484---------------
485
486The key data structure to manage the data locations is a "node". Similar to
487traditional file structures, F2FS has three types of node: inode, direct node,
Huajun Lid08ab082012-12-05 16:45:32 +0800488indirect node. F2FS assigns 4KB to an inode block which contains 923 data block
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900489indices, two direct node pointers, two indirect node pointers, and one double
490indirect node pointer as described below. One direct node block contains 1018
491data blocks, and one indirect node block contains also 1018 node blocks. Thus,
492one inode block (i.e., a file) covers:
493
494 4KB * (923 + 2 * 1018 + 2 * 1018 * 1018 + 1018 * 1018 * 1018) := 3.94TB.
495
496 Inode block (4KB)
497 |- data (923)
498 |- direct node (2)
499 | `- data (1018)
500 |- indirect node (2)
501 | `- direct node (1018)
502 | `- data (1018)
503 `- double indirect node (1)
504 `- indirect node (1018)
505 `- direct node (1018)
506 `- data (1018)
507
508Note that, all the node blocks are mapped by NAT which means the location of
509each node is translated by the NAT table. In the consideration of the wandering
510tree problem, F2FS is able to cut off the propagation of node updates caused by
511leaf data writes.
512
513Directory Structure
514-------------------
515
516A directory entry occupies 11 bytes, which consists of the following attributes.
517
518- hash hash value of the file name
519- ino inode number
520- len the length of file name
521- type file type such as directory, symlink, etc
522
523A dentry block consists of 214 dentry slots and file names. Therein a bitmap is
524used to represent whether each dentry is valid or not. A dentry block occupies
5254KB with the following composition.
526
527 Dentry Block(4 K) = bitmap (27 bytes) + reserved (3 bytes) +
528 dentries(11 * 214 bytes) + file name (8 * 214 bytes)
529
530 [Bucket]
531 +--------------------------------+
532 |dentry block 1 | dentry block 2 |
533 +--------------------------------+
534 . .
535 . .
536 . [Dentry Block Structure: 4KB] .
537 +--------+----------+----------+------------+
538 | bitmap | reserved | dentries | file names |
539 +--------+----------+----------+------------+
540 [Dentry Block: 4KB] . .
541 . .
542 . .
543 +------+------+-----+------+
544 | hash | ino | len | type |
545 +------+------+-----+------+
546 [Dentry Structure: 11 bytes]
547
548F2FS implements multi-level hash tables for directory structure. Each level has
549a hash table with dedicated number of hash buckets as shown below. Note that
550"A(2B)" means a bucket includes 2 data blocks.
551
552----------------------
553A : bucket
554B : block
555N : MAX_DIR_HASH_DEPTH
556----------------------
557
558level #0 | A(2B)
559 |
560level #1 | A(2B) - A(2B)
561 |
562level #2 | A(2B) - A(2B) - A(2B) - A(2B)
563 . | . . . .
564level #N/2 | A(2B) - A(2B) - A(2B) - A(2B) - A(2B) - ... - A(2B)
565 . | . . . .
566level #N | A(4B) - A(4B) - A(4B) - A(4B) - A(4B) - ... - A(4B)
567
568The number of blocks and buckets are determined by,
569
570 ,- 2, if n < MAX_DIR_HASH_DEPTH / 2,
571 # of blocks in level #n = |
572 `- 4, Otherwise
573
Chao Yubfec07d2014-05-28 08:56:09 +0800574 ,- 2^(n + dir_level),
575 | if n + dir_level < MAX_DIR_HASH_DEPTH / 2,
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900576 # of buckets in level #n = |
Chao Yubfec07d2014-05-28 08:56:09 +0800577 `- 2^((MAX_DIR_HASH_DEPTH / 2) - 1),
578 Otherwise
Jaegeuk Kim98e4da82012-11-02 17:05:42 +0900579
580When F2FS finds a file name in a directory, at first a hash value of the file
581name is calculated. Then, F2FS scans the hash table in level #0 to find the
582dentry consisting of the file name and its inode number. If not found, F2FS
583scans the next hash table in level #1. In this way, F2FS scans hash tables in
584each levels incrementally from 1 to N. In each levels F2FS needs to scan only
585one bucket determined by the following equation, which shows O(log(# of files))
586complexity.
587
588 bucket number to scan in level #n = (hash value) % (# of buckets in level #n)
589
590In the case of file creation, F2FS finds empty consecutive slots that cover the
591file name. F2FS searches the empty slots in the hash tables of whole levels from
5921 to N in the same way as the lookup operation.
593
594The following figure shows an example of two cases holding children.
595 --------------> Dir <--------------
596 | |
597 child child
598
599 child - child [hole] - child
600
601 child - child - child [hole] - [hole] - child
602
603 Case 1: Case 2:
604 Number of children = 6, Number of children = 3,
605 File size = 7 File size = 7
606
607Default Block Allocation
608------------------------
609
610At runtime, F2FS manages six active logs inside "Main" area: Hot/Warm/Cold node
611and Hot/Warm/Cold data.
612
613- Hot node contains direct node blocks of directories.
614- Warm node contains direct node blocks except hot node blocks.
615- Cold node contains indirect node blocks
616- Hot data contains dentry blocks
617- Warm data contains data blocks except hot and cold data blocks
618- Cold data contains multimedia data or migrated data blocks
619
620LFS has two schemes for free space management: threaded log and copy-and-compac-
621tion. The copy-and-compaction scheme which is known as cleaning, is well-suited
622for devices showing very good sequential write performance, since free segments
623are served all the time for writing new data. However, it suffers from cleaning
624overhead under high utilization. Contrarily, the threaded log scheme suffers
625from random writes, but no cleaning process is needed. F2FS adopts a hybrid
626scheme where the copy-and-compaction scheme is adopted by default, but the
627policy is dynamically changed to the threaded log scheme according to the file
628system status.
629
630In order to align F2FS with underlying flash-based storage, F2FS allocates a
631segment in a unit of section. F2FS expects that the section size would be the
632same as the unit size of garbage collection in FTL. Furthermore, with respect
633to the mapping granularity in FTL, F2FS allocates each section of the active
634logs from different zones as much as possible, since FTL can write the data in
635the active logs into one allocation unit according to its mapping granularity.
636
637Cleaning process
638----------------
639
640F2FS does cleaning both on demand and in the background. On-demand cleaning is
641triggered when there are not enough free segments to serve VFS calls. Background
642cleaner is operated by a kernel thread, and triggers the cleaning job when the
643system is idle.
644
645F2FS supports two victim selection policies: greedy and cost-benefit algorithms.
646In the greedy algorithm, F2FS selects a victim segment having the smallest number
647of valid blocks. In the cost-benefit algorithm, F2FS selects a victim segment
648according to the segment age and the number of valid blocks in order to address
649log block thrashing problem in the greedy algorithm. F2FS adopts the greedy
650algorithm for on-demand cleaner, while background cleaner adopts cost-benefit
651algorithm.
652
653In order to identify whether the data in the victim segment are valid or not,
654F2FS manages a bitmap. Each bit represents the validity of a block, and the
655bitmap is composed of a bit stream covering whole blocks in main area.