aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/filesystems
diff options
context:
space:
mode:
authorLinus Torvalds <torvalds@linux-foundation.org>2013-09-06 12:04:34 -0400
committerLinus Torvalds <torvalds@linux-foundation.org>2013-09-06 12:04:34 -0400
commiteb97a784f02991cc3736d787511e788f32f0627f (patch)
treeb81bd078b145b9af6339269c8f77421e98894e03 /Documentation/filesystems
parent2e032852245b3dcfe5461d7353e34eb6da095ccf (diff)
parenta26b7c8a0149ce1e3b6a10f2801aada6e447e4e7 (diff)
Merge tag 'for-f2fs-3.12' of git://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs
Pull f2fs updates from Jaegeuk Kim: "This patch-set includes the following major enhancement patches: - support inline xattrs - add sysfs support to control GCs explicitly - add proc entry to show the current segment usage information - improve the GC/SSR performance The other bug fixes are as follows: - avoid the overflow on status calculation - fix some error handling routines - fix inconsistent xattr states after power-off-recovery - fix incorrect xattr node offset definition - fix deadlock condition in fsync - fix the fdatasync routine for power-off-recovery" * tag 'for-f2fs-3.12' of git://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs: (40 commits) f2fs: optimize gc for better performance f2fs: merge more bios of node block writes f2fs: avoid an overflow during utilization calculation f2fs: trigger GC when there are prefree segments f2fs: use strncasecmp() simplify the string comparison f2fs: fix omitting to update inode page f2fs: support the inline xattrs f2fs: add the truncate_xattr_node function f2fs: introduce __find_xattr for readability f2fs: reserve the xattr space dynamically f2fs: add flags for inline xattrs f2fs: fix error return code in init_f2fs_fs() f2fs: fix wrong BUG_ON condition f2fs: fix memory leak when init f2fs filesystem fail f2fs: fix a compound statement label error f2fs: avoid writing inode redundantly when creating a file f2fs: alloc_page() doesn't return an ERR_PTR f2fs: should cover i_xattr_nid with its xattr node page lock f2fs: check the free space first in new_node_page f2fs: clean up the needless end 'return' of void function ...
Diffstat (limited to 'Documentation/filesystems')
-rw-r--r--Documentation/filesystems/f2fs.txt75
1 files changed, 71 insertions, 4 deletions
diff --git a/Documentation/filesystems/f2fs.txt b/Documentation/filesystems/f2fs.txt
index b91e2f26b672..3cd27bed6349 100644
--- a/Documentation/filesystems/f2fs.txt
+++ b/Documentation/filesystems/f2fs.txt
@@ -18,8 +18,8 @@ according to its internal geometry or flash memory management scheme, namely FTL
18F2FS and its tools support various parameters not only for configuring on-disk 18F2FS and its tools support various parameters not only for configuring on-disk
19layout, but also for selecting allocation and cleaning algorithms. 19layout, but also for selecting allocation and cleaning algorithms.
20 20
21The file system formatting tool, "mkfs.f2fs", is available from the following 21The following git tree provides the file system formatting tool (mkfs.f2fs),
22git tree: 22a consistency checking tool (fsck.f2fs), and a debugging tool (dump.f2fs).
23>> git://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs-tools.git 23>> git://git.kernel.org/pub/scm/linux/kernel/git/jaegeuk/f2fs-tools.git
24 24
25For reporting bugs and sending patches, please use the following mailing list: 25For reporting bugs and sending patches, please use the following mailing list:
@@ -133,6 +133,38 @@ f2fs. Each file shows the whole f2fs information.
133 - current memory footprint consumed by f2fs. 133 - current memory footprint consumed by f2fs.
134 134
135================================================================================ 135================================================================================
136SYSFS ENTRIES
137================================================================================
138
139Information 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).
142The files in each per-device directory are shown in table below.
143
144Files 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
161 gc_idle This parameter controls the selection of victim
162 policy for garbage collection. Setting gc_idle = 0
163 (default) will disable this option. Setting
164 gc_idle = 1 will select the Cost Benefit approach
165 & setting gc_idle = 2 will select the greedy aproach.
166
167================================================================================
136USAGE 168USAGE
137================================================================================ 169================================================================================
138 170
@@ -149,8 +181,12 @@ USAGE
149 # mkfs.f2fs -l label /dev/block_device 181 # mkfs.f2fs -l label /dev/block_device
150 # mount -t f2fs /dev/block_device /mnt/f2fs 182 # mount -t f2fs /dev/block_device /mnt/f2fs
151 183
152Format options 184mkfs.f2fs
153-------------- 185---------
186The mkfs.f2fs is for the use of formatting a partition as the f2fs filesystem,
187which builds a basic on-disk layout.
188
189The options consist of:
154-l [label] : Give a volume label, up to 512 unicode name. 190-l [label] : Give a volume label, up to 512 unicode name.
155-a [0 or 1] : Split start location of each area for heap-based allocation. 191-a [0 or 1] : Split start location of each area for heap-based allocation.
156 1 is set by default, which performs this. 192 1 is set by default, which performs this.
@@ -164,6 +200,37 @@ Format options
164-t [0 or 1] : Disable discard command or not. 200-t [0 or 1] : Disable discard command or not.
165 1 is set by default, which conducts discard. 201 1 is set by default, which conducts discard.
166 202
203fsck.f2fs
204---------
205The fsck.f2fs is a tool to check the consistency of an f2fs-formatted
206partition, which examines whether the filesystem metadata and user-made data
207are cross-referenced correctly or not.
208Note that, initial version of the tool does not fix any inconsistency.
209
210The options consist of:
211 -d debug level [default:0]
212
213dump.f2fs
214---------
215The dump.f2fs shows the information of specific inode and dumps SSA and SIT to
216file. Each file is dump_ssa and dump_sit.
217
218The dump.f2fs is used to debug on-disk data structures of the f2fs filesystem.
219It shows on-disk inode information reconized by a given inode number, and is
220able to dump all the SSA and SIT entries into predefined files, ./dump_ssa and
221./dump_sit respectively.
222
223The options consist of:
224 -d debug level [default:0]
225 -i inode no (hex)
226 -s [SIT dump segno from #1~#2 (decimal), for all 0~-1]
227 -a [SSA dump segno from #1~#2 (decimal), for all 0~-1]
228
229Examples:
230# dump.f2fs -i [ino] /dev/sdx
231# dump.f2fs -s 0~-1 /dev/sdx (SIT dump)
232# dump.f2fs -a 0~-1 /dev/sdx (SSA dump)
233
167================================================================================ 234================================================================================
168DESIGN 235DESIGN
169================================================================================ 236================================================================================