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