Log-structured File System (LFS)¶

“A log-structured file system writes all modifications to disk sequentially ina log-like structure, thereby speeding up both file writing and crash recovery.The log is the only structure on disk; it contains indexing information so thatfiles can be read back from the log efficiently. In order to maintain large freeareas on disk for fast writing, we divide the log into segments and use asegment cleaner to compress the live information from heavily fragmentedsegments.” from Rosenblum, M. and Ousterhout, J. K., 1992, “The design andimplementation of a log-structured file system”, ACM Trans. Computer Systems10, 1, 26–52.

Wandering Tree Problem¶

In LFS, when a file data is updated and written to the end of log, its directpointer block is updated due to the changed location. Then the indirect pointerblock is also updated due to the direct pointer block update. In this manner,the upper index structures such as inode, inode map, and checkpoint block arealso updated recursively. This problem is called as wandering tree problem [1],and in order to enhance the performance, it should eliminate or relax the updatepropagation as much as possible.

[1] Bityutskiy, A. 2005. JFFS3 design issues.http://www.linux-mtd.infradead.org/

Cleaning Overhead¶

Since LFS is based on out-of-place writes, it produces so many obsolete blocksscattered across the whole storage. In order to serve new empty log space, itneeds to reclaim these obsolete blocks seamlessly to users. This job is calledas a cleaning process.

The process consists of three operations as follows.

1. A victim segment is selected through referencing segment usage table.

2. It loads parent index structures of all the data in the victim identified bysegment summary blocks.

3. It checks the cross-reference between the data and its parent index structure.

4. It moves valid data selectively.

This cleaning job may cause unexpected long delays, so the most important goalis to hide the latencies to users. And also definitely, it should reduce theamount of valid data to be moved, and move them quickly as well.

Flash Awareness¶

• Enlarge the random write area for better performance, but provide the highspatial locality

• Align FS data structures to the operational units in FTL as best efforts

Wandering Tree Problem¶

• Use a term, “node”, that represents inodes as well as various pointer blocks

• Introduce Node Address Table (NAT) containing the locations of all the “node”blocks; this will cut off the update propagation.

Cleaning Overhead¶

• Support a background cleaning process

• Support greedy and cost-benefit algorithms for victim selection policies

• Support multi-head logs for static/dynamic hot and cold data separation

• Introduce adaptive logging for efficient block allocation

mkfs.f2fs¶

The mkfs.f2fs is for the use of formatting a partition as the f2fs filesystem,which builds a basic on-disk layout.

The quick options consist of:

Note: please refer to the manpage of mkfs.f2fs(8) to get full option list.

fsck.f2fs¶

The fsck.f2fs is a tool to check the consistency of an f2fs-formattedpartition, which examines whether the filesystem metadata and user-made dataare cross-referenced correctly or not.Note that, initial version of the tool does not fix any inconsistency.

The quick options consist of:

-d debug level [default:0]

Note: please refer to the manpage of fsck.f2fs(8) to get full option list.

dump.f2fs¶

The dump.f2fs shows the information of specific inode and dumps SSA and SIT tofile. Each file is dump_ssa and dump_sit.

The dump.f2fs is used to debug on-disk data structures of the f2fs filesystem.It shows on-disk inode information recognized by a given inode number, and isable to dump all the SSA and SIT entries into predefined files, ./dump_ssa and./dump_sit respectively.

The options consist of:

-d debug level [default:0]-i inode no (hex)-s [SIT dump segno from #1~#2 (decimal), for all 0~-1]-a [SSA dump segno from #1~#2 (decimal), for all 0~-1]

Examples:

# dump.f2fs -i [ino] /dev/sdx# dump.f2fs -s 0~-1 /dev/sdx (SIT dump)# dump.f2fs -a 0~-1 /dev/sdx (SSA dump)

Note: please refer to the manpage of dump.f2fs(8) to get full option list.

sload.f2fs¶

The sload.f2fs gives a way to insert files and directories in the existing diskimage. This tool is useful when building f2fs images given compiled files.

Note: please refer to the manpage of sload.f2fs(8) to get full option list.

resize.f2fs¶

The resize.f2fs lets a user resize the f2fs-formatted disk image, while preservingall the files and directories stored in the image.

Note: please refer to the manpage of resize.f2fs(8) to get full option list.

defrag.f2fs¶

The defrag.f2fs can be used to defragment scattered written data as well asfilesystem metadata across the disk. This can improve the write speed by givingmore free consecutive space.

Note: please refer to the manpage of defrag.f2fs(8) to get full option list.

f2fs_io¶

The f2fs_io is a simple tool to issue various filesystem APIs as well asf2fs-specific ones, which is very useful for QA tests.

Note: please refer to the manpage of f2fs_io(8) to get full option list.

On-disk Layout¶

F2FS divides the whole volume into a number of segments, each of which is fixedto 2MB in size. A section is composed of consecutive segments, and a zoneconsists of a set of sections. By default, section and zone sizes are set to onesegment size identically, but users can easily modify the sizes by mkfs.

F2FS splits the entire volume into six areas, and all the areas except superblockconsist of multiple segments as described below:

                                        align with the zone size <-|             |-> align with the segment size _________________________________________________________________________|            |            |   Segment   |    Node     |   Segment  |      || Superblock | Checkpoint |    Info.    |   Address   |   Summary  | Main ||    (SB)    |   (CP)     | Table (SIT) | Table (NAT) | Area (SSA) |      ||____________|_____2______|______N______|______N______|______N_____|__N___|                                                                   .      .                                                         .                .                                             .                            .                                ._________________________________________.                                |_Segment_|_..._|_Segment_|_..._|_Segment_|                                .           .                                ._________._________                                |_section_|__...__|_                                .            .                                .________.                                |__zone__|

• Superblock (SB)

  It is located at the beginning of the partition, and there exist two copiesto avoid file system crash. It contains basic partition information and somedefault parameters of f2fs.

• Checkpoint (CP)

  It contains file system information, bitmaps for valid NAT/SIT sets, orphaninode lists, and summary entries of current active segments.

• Segment Information Table (SIT)

  It contains segment information such as valid block count and bitmap for thevalidity of all the blocks.

• Node Address Table (NAT)

  It is composed of a block address table for all the node blocks stored inMain area.

• Segment Summary Area (SSA)

  It contains summary entries which contains the owner information of all thedata and node blocks stored in Main area.

• Main Area

  It contains file and directory data including their indices.

In order to avoid misalignment between file system and flash-based storage, F2FSaligns the start block address of CP with the segment size. Also, it aligns thestart block address of Main area with the zone size by reserving some segmentsin SSA area.

Reference the following survey for additional technical details.https://wiki.linaro.org/WorkingGroups/Kernel/Projects/FlashCardSurvey

File System Metadata Structure¶

F2FS adopts the checkpointing scheme to maintain file system consistency. Atmount time, F2FS first tries to find the last valid checkpoint data by scanningCP area. In order to reduce the scanning time, F2FS uses only two copies of CP.One of them always indicates the last valid data, which is called as shadow copymechanism. In addition to CP, NAT and SIT also adopt the shadow copy mechanism.

For file system consistency, each CP points to which NAT and SIT copies arevalid, as shown as below:

+--------+----------+---------+|   CP   |    SIT   |   NAT   |+--------+----------+---------+.         .          .          ..            .              .              ..               .                 .                 .+-------+-------+--------+--------+--------+--------+| CP #0 | CP #1 | SIT #0 | SIT #1 | NAT #0 | NAT #1 |+-------+-------+--------+--------+--------+--------+   |             ^                          ^   |             |                          |   `----------------------------------------'

Index Structure¶

The key data structure to manage the data locations is a “node”. Similar totraditional file structures, F2FS has three types of node: inode, direct node,indirect node. F2FS assigns 4KB to an inode block which contains 923 data blockindices, two direct node pointers, two indirect node pointers, and one doubleindirect node pointer as described below. One direct node block contains 1018data blocks, and one indirect node block contains also 1018 node blocks. Thus,one inode block (i.e., a file) covers:

4KB * (923 + 2 * 1018 + 2 * 1018 * 1018 + 1018 * 1018 * 1018) := 3.94TB. Inode block (4KB)   |- data (923)   |- direct node (2)   |          `- data (1018)   |- indirect node (2)   |            `- direct node (1018)   |                       `- data (1018)   `- double indirect node (1)                       `- indirect node (1018)                                    `- direct node (1018)                                               `- data (1018)

Note that all the node blocks are mapped by NAT which means the location ofeach node is translated by the NAT table. In the consideration of the wanderingtree problem, F2FS is able to cut off the propagation of node updates caused byleaf data writes.

Directory Structure¶

A directory entry occupies 11 bytes, which consists of the following attributes.

• hash hash value of the file name

• ino inode number

• len the length of file name

• type file type such as directory, symlink, etc

A dentry block consists of 214 dentry slots and file names. Therein a bitmap isused to represent whether each dentry is valid or not. A dentry block occupies4KB with the following composition.

Dentry Block(4 K) = bitmap (27 bytes) + reserved (3 bytes) +                    dentries(11 * 214 bytes) + file name (8 * 214 bytes)                       [Bucket]           +--------------------------------+           |dentry block 1 | dentry block 2 |           +--------------------------------+           .               .     .                             ..       [Dentry Block Structure: 4KB]       .+--------+----------+----------+------------+| bitmap | reserved | dentries | file names |+--------+----------+----------+------------+[Dentry Block: 4KB] .   .               .               .          .                          .          +------+------+-----+------+          | hash | ino  | len | type |          +------+------+-----+------+          [Dentry Structure: 11 bytes]

F2FS implements multi-level hash tables for directory structure. Each level hasa hash table with dedicated number of hash buckets as shown below. Note that“A(2B)” means a bucket includes 2 data blocks.

----------------------A : bucketB : blockN : MAX_DIR_HASH_DEPTH----------------------level #0   | A(2B)        |level #1   | A(2B) - A(2B)        |level #2   | A(2B) - A(2B) - A(2B) - A(2B)    .     |   .       .       .       .level #N/2 | A(2B) - A(2B) - A(2B) - A(2B) - A(2B) - ... - A(2B)    .     |   .       .       .       .level #N   | A(4B) - A(4B) - A(4B) - A(4B) - A(4B) - ... - A(4B)

The number of blocks and buckets are determined by:

                          ,- 2, if n < MAX_DIR_HASH_DEPTH / 2,# of blocks in level #n = |                          `- 4, Otherwise                           ,- 2^(n + dir_level),                           |        if n + dir_level < MAX_DIR_HASH_DEPTH / 2,# of buckets in level #n = |                           `- 2^((MAX_DIR_HASH_DEPTH / 2) - 1),                                    Otherwise

When F2FS finds a file name in a directory, at first a hash value of the filename is calculated. Then, F2FS scans the hash table in level #0 to find thedentry consisting of the file name and its inode number. If not found, F2FSscans the next hash table in level #1. In this way, F2FS scans hash tables ineach levels incrementally from 1 to N. In each level F2FS needs to scan onlyone bucket determined by the following equation, which shows O(log(# of files))complexity:

bucket number to scan in level #n = (hash value) % (# of buckets in level #n)

In the case of file creation, F2FS finds empty consecutive slots that cover thefile name. F2FS searches the empty slots in the hash tables of whole levels from1 to N in the same way as the lookup operation.

The following figure shows an example of two cases holding children:

    --------------> Dir <--------------    |                                 | child                             child child - child                     [hole] - child child - child - child             [hole] - [hole] - childCase 1:                           Case 2:Number of children = 6,           Number of children = 3,File size = 7                     File size = 7

Default Block Allocation¶

At runtime, F2FS manages six active logs inside “Main” area: Hot/Warm/Cold nodeand Hot/Warm/Cold data.

• Hot node contains direct node blocks of directories.

• Warm node contains direct node blocks except hot node blocks.

• Cold node contains indirect node blocks

• Hot data contains dentry blocks

• Warm data contains data blocks except hot and cold data blocks

• Cold data contains multimedia data or migrated data blocks

LFS has two schemes for free space management: threaded log and copy-and-compac-tion. The copy-and-compaction scheme which is known as cleaning, is well-suitedfor devices showing very good sequential write performance, since free segmentsare served all the time for writing new data. However, it suffers from cleaningoverhead under high utilization. Contrarily, the threaded log scheme suffersfrom random writes, but no cleaning process is needed. F2FS adopts a hybridscheme where the copy-and-compaction scheme is adopted by default, but thepolicy is dynamically changed to the threaded log scheme according to the filesystem status.

In order to align F2FS with underlying flash-based storage, F2FS allocates asegment in a unit of section. F2FS expects that the section size would be thesame as the unit size of garbage collection in FTL. Furthermore, with respectto the mapping granularity in FTL, F2FS allocates each section of the activelogs from different zones as much as possible, since FTL can write the data inthe active logs into one allocation unit according to its mapping granularity.

Cleaning process¶

F2FS does cleaning both on demand and in the background. On-demand cleaning istriggered when there are not enough free segments to serve VFS calls. Backgroundcleaner is operated by a kernel thread, and triggers the cleaning job when thesystem is idle.

F2FS supports two victim selection policies: greedy and cost-benefit algorithms.In the greedy algorithm, F2FS selects a victim segment having the smallest numberof valid blocks. In the cost-benefit algorithm, F2FS selects a victim segmentaccording to the segment age and the number of valid blocks in order to addresslog block thrashing problem in the greedy algorithm. F2FS adopts the greedyalgorithm for on-demand cleaner, while background cleaner adopts cost-benefitalgorithm.

In order to identify whether the data in the victim segment are valid or not,F2FS manages a bitmap. Each bit represents the validity of a block, and thebitmap is composed of a bit stream covering whole blocks in main area.

Write-hint Policy¶

F2FS sets the whint all the time with the below policy.

Fallocate(2) Policy¶

The default policy follows the below POSIX rule.

Allocating disk space

The default operation (i.e., mode is zero) offallocate() allocatesthe disk space within the range specified by offset and len. Thefile size (as reported by stat(2)) will be changed if offset+len isgreater than the file size. Any subregion within the range specifiedby offset and len that did not contain data before the call will beinitialized to zero. This default behavior closely resembles thebehavior of the posix_fallocate(3) library function, and is intendedas a method of optimally implementing that function.

However, once F2FS receives ioctl(fd, F2FS_IOC_SET_PIN_FILE) in prior tofallocate(fd, DEFAULT_MODE), it allocates on-disk block addresses havingzero or random data, which is useful to the below scenario where:

1. create(fd)

2. ioctl(fd, F2FS_IOC_SET_PIN_FILE)

3. fallocate(fd, 0, 0, size)

4. address = fibmap(fd, offset)

5. open(blkdev)

6. write(blkdev, address)

Compression implementation¶

• New term named cluster is defined as basic unit of compression, file canbe divided into multiple clusters logically. One cluster includes 4 << n(n >= 0) logical pages, compression size is also cluster size, each ofcluster can be compressed or not.

• In cluster metadata layout, one special block address is used to indicatea cluster is a compressed one or normal one; for compressed cluster, followingmetadata maps cluster to [1, 4 << n - 1] physical blocks, in where f2fsstores data including compress header and compressed data.

• In order to eliminate write amplification during overwrite, F2FS onlysupport compression on write-once file, data can be compressed only whenall logical blocks in cluster contain valid data and compress ratio ofcluster data is lower than specified threshold.

• To enable compression on regular inode, there are four ways:

  • chattr +c file

  • chattr +c dir; touch dir/file

  • mount w/ -o compress_extension=ext; touch file.ext

  • mount w/ -o compress_extension=*; touch any_file

• To disable compression on regular inode, there are two ways:

  • chattr -c file

  • mount w/ -o nocompress_extension=ext; touch file.ext

• Priority in between FS_COMPR_FL, FS_NOCOMP_FS, extensions:

  • compress_extension=so; nocompress_extension=zip; chattr +c dir; touchdir/foo.so; touch dir/bar.zip; touch dir/baz.txt; then foo.so and baz.txtshould be compresse, bar.zip should be non-compressed. chattr +c dir/bar.zipcan enable compress on bar.zip.

  • compress_extension=so; nocompress_extension=zip; chattr -c dir; touchdir/foo.so; touch dir/bar.zip; touch dir/baz.txt; then foo.so should becompresse, bar.zip and baz.txt should be non-compressed.chattr+c dir/bar.zip; chattr+c dir/baz.txt; can enable compress on bar.zipand baz.txt.

• At this point, compression feature doesn’t expose compressed space to userdirectly in order to guarantee potential data updates later to the space.Instead, the main goal is to reduce data writes to flash disk as much aspossible, resulting in extending disk life time as well as relaxing IOcongestion. Alternatively, we’ve added ioctl(F2FS_IOC_RELEASE_COMPRESS_BLOCKS)interface to reclaim compressed space and show it to user after setting aspecial flag to the inode. Once the compressed space is released, the flagwill block writing data to the file until either the compressed space isreserved via ioctl(F2FS_IOC_RESERVE_COMPRESS_BLOCKS) or the file size istruncated to zero.

Compress metadata layout:

                            [Dnode Structure]            +-----------------------------------------------+            | cluster 1 | cluster 2 | ......... | cluster N |            +-----------------------------------------------+            .           .                       .           .      .                      .                .                      ..         Compressed Cluster       .        .        Normal Cluster            .+----------+---------+---------+---------+  +---------+---------+---------+---------+|compr flag| block 1 | block 2 | block 3 |  | block 1 | block 2 | block 3 | block 4 |+----------+---------+---------+---------+  +---------+---------+---------+---------+           .                             .        .                                           .    .                                                           .    +-------------+-------------+----------+----------------------------+    | data length | data chksum | reserved |      compressed data       |    +-------------+-------------+----------+----------------------------+

Compression mode¶

f2fs supports “fs” and “user” compression modes with “compression_mode” mount option.With this option, f2fs provides a choice to select the way how to compress thecompression enabled files (refer to “Compression implementation” section for how toenable compression on a regular inode).

1. compress_mode=fs

   This is the default option. f2fs does automatic compression in the writeback of thecompression enabled files.

2. compress_mode=user

   This disables the automatic compression and gives the user discretion of choosing thetarget file and the timing. The user can do manual compression/decompression on thecompression enabled files using F2FS_IOC_DECOMPRESS_FILE and F2FS_IOC_COMPRESS_FILEioctls like the below.

To decompress a file:

fd = open(filename, O_WRONLY, 0);ret = ioctl(fd, F2FS_IOC_DECOMPRESS_FILE);

To compress a file:

fd = open(filename, O_WRONLY, 0);ret = ioctl(fd, F2FS_IOC_COMPRESS_FILE);

NVMe Zoned Namespace devices¶

• ZNS defines a per-zone capacity which can be equal or less than thezone-size. Zone-capacity is the number of usable blocks in the zone.F2FS checks if zone-capacity is less than zone-size, if it is, then anysegment which starts after the zone-capacity is marked as not-free inthe free segment bitmap at initial mount time. These segments are markedas permanently used so they are not allocated for writes andconsequently are not needed to be garbage collected. In case thezone-capacity is not aligned to default segment size(2MB), then a segmentcan start before the zone-capacity and span across zone-capacity boundary.Such spanning segments are also considered as usable segments. All blockspast the zone-capacity are considered unusable in these segments.

Device aliasing feature¶

f2fs can utilize a special file called a “device aliasing file.” This file allowsthe entire storage device to be mapped with a single, large extent, not usingthe usual f2fs node structures. This mapped area is pinned and primarily intendedfor holding the space.

Essentially, this mechanism allows a portion of the f2fs area to be temporarilyreserved and used by another filesystem or for different purposes. Once thatexternal usage is complete, the device aliasing file can be deleted, releasingthe reserved space back to F2FS for its own use.

# ls /dev/vd*/dev/vdb (32GB) /dev/vdc (32GB)# mkfs.ext4 /dev/vdc# mkfs.f2fs -c /dev/vdc@vdc.file /dev/vdb# mount /dev/vdb /mnt/f2fs# ls -l /mnt/f2fsvdc.file# df -h/dev/vdb                            64G   33G   32G  52% /mnt/f2fs# mount -o loop /dev/vdc /mnt/ext4# df -h/dev/vdb                            64G   33G   32G  52% /mnt/f2fs/dev/loop7                          32G   24K   30G   1% /mnt/ext4# umount /mnt/ext4# f2fs_io getflags /mnt/f2fs/vdc.fileget a flag on /mnt/f2fs/vdc.file ret=0, flags=nocow(pinned),immutable# f2fs_io setflags noimmutable /mnt/f2fs/vdc.fileget a flag on noimmutable ret=0, flags=800010set a flag on /mnt/f2fs/vdc.file ret=0, flags=noimmutable# rm /mnt/f2fs/vdc.file# df -h/dev/vdb                            64G  753M   64G   2% /mnt/f2fs

So, the key idea is, user can do any file operations on /dev/vdc, andreclaim the space after the use, while the space is counted as /data.That doesn’t require modifying partition size and filesystem format.