]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - Documentation/filesystems/vfs.txt
Merge branch 'sched-fixes-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[mirror_ubuntu-bionic-kernel.git] / Documentation / filesystems / vfs.txt
CommitLineData
1da177e4 1
5ea626aa 2 Overview of the Linux Virtual File System
1da177e4 3
5ea626aa 4 Original author: Richard Gooch <rgooch@atnf.csiro.au>
1da177e4 5
0746aec3 6 Last updated on June 24, 2007.
1da177e4 7
5ea626aa
PE
8 Copyright (C) 1999 Richard Gooch
9 Copyright (C) 2005 Pekka Enberg
1da177e4 10
5ea626aa 11 This file is released under the GPLv2.
1da177e4 12
1da177e4 13
cc7d1f8f
PE
14Introduction
15============
1da177e4 16
cc7d1f8f
PE
17The Virtual File System (also known as the Virtual Filesystem Switch)
18is the software layer in the kernel that provides the filesystem
19interface to userspace programs. It also provides an abstraction
20within the kernel which allows different filesystem implementations to
21coexist.
1da177e4 22
cc7d1f8f
PE
23VFS system calls open(2), stat(2), read(2), write(2), chmod(2) and so
24on are called from a process context. Filesystem locking is described
25in the document Documentation/filesystems/Locking.
1da177e4 26
1da177e4 27
cc7d1f8f
PE
28Directory Entry Cache (dcache)
29------------------------------
1da177e4 30
cc7d1f8f
PE
31The VFS implements the open(2), stat(2), chmod(2), and similar system
32calls. The pathname argument that is passed to them is used by the VFS
33to search through the directory entry cache (also known as the dentry
34cache or dcache). This provides a very fast look-up mechanism to
35translate a pathname (filename) into a specific dentry. Dentries live
36in RAM and are never saved to disc: they exist only for performance.
37
38The dentry cache is meant to be a view into your entire filespace. As
39most computers cannot fit all dentries in the RAM at the same time,
40some bits of the cache are missing. In order to resolve your pathname
41into a dentry, the VFS may have to resort to creating dentries along
42the way, and then loading the inode. This is done by looking up the
43inode.
44
45
46The Inode Object
47----------------
48
49An individual dentry usually has a pointer to an inode. Inodes are
50filesystem objects such as regular files, directories, FIFOs and other
51beasts. They live either on the disc (for block device filesystems)
52or in the memory (for pseudo filesystems). Inodes that live on the
53disc are copied into the memory when required and changes to the inode
54are written back to disc. A single inode can be pointed to by multiple
55dentries (hard links, for example, do this).
56
57To look up an inode requires that the VFS calls the lookup() method of
58the parent directory inode. This method is installed by the specific
59filesystem implementation that the inode lives in. Once the VFS has
60the required dentry (and hence the inode), we can do all those boring
61things like open(2) the file, or stat(2) it to peek at the inode
62data. The stat(2) operation is fairly simple: once the VFS has the
63dentry, it peeks at the inode data and passes some of it back to
64userspace.
65
66
67The File Object
68---------------
1da177e4
LT
69
70Opening a file requires another operation: allocation of a file
71structure (this is the kernel-side implementation of file
5ea626aa 72descriptors). The freshly allocated file structure is initialized with
1da177e4
LT
73a pointer to the dentry and a set of file operation member functions.
74These are taken from the inode data. The open() file method is then
75called so the specific filesystem implementation can do it's work. You
cc7d1f8f
PE
76can see that this is another switch performed by the VFS. The file
77structure is placed into the file descriptor table for the process.
1da177e4
LT
78
79Reading, writing and closing files (and other assorted VFS operations)
80is done by using the userspace file descriptor to grab the appropriate
cc7d1f8f
PE
81file structure, and then calling the required file structure method to
82do whatever is required. For as long as the file is open, it keeps the
83dentry in use, which in turn means that the VFS inode is still in use.
1da177e4 84
5ea626aa
PE
85
86Registering and Mounting a Filesystem
cc7d1f8f 87=====================================
1da177e4 88
cc7d1f8f
PE
89To register and unregister a filesystem, use the following API
90functions:
1da177e4 91
cc7d1f8f 92 #include <linux/fs.h>
1da177e4 93
cc7d1f8f
PE
94 extern int register_filesystem(struct file_system_type *);
95 extern int unregister_filesystem(struct file_system_type *);
1da177e4 96
cc7d1f8f
PE
97The passed struct file_system_type describes your filesystem. When a
98request is made to mount a device onto a directory in your filespace,
99the VFS will call the appropriate get_sb() method for the specific
100filesystem. The dentry for the mount point will then be updated to
101point to the root inode for the new filesystem.
1da177e4 102
cc7d1f8f
PE
103You can see all filesystems that are registered to the kernel in the
104file /proc/filesystems.
1da177e4
LT
105
106
5ea626aa 107struct file_system_type
cc7d1f8f 108-----------------------
1da177e4 109
0746aec3 110This describes the filesystem. As of kernel 2.6.22, the following
1da177e4
LT
111members are defined:
112
113struct file_system_type {
114 const char *name;
115 int fs_flags;
5d8b2ebf
JC
116 int (*get_sb) (struct file_system_type *, int,
117 const char *, void *, struct vfsmount *);
5ea626aa
PE
118 void (*kill_sb) (struct super_block *);
119 struct module *owner;
120 struct file_system_type * next;
121 struct list_head fs_supers;
0746aec3
BP
122 struct lock_class_key s_lock_key;
123 struct lock_class_key s_umount_key;
1da177e4
LT
124};
125
126 name: the name of the filesystem type, such as "ext2", "iso9660",
127 "msdos" and so on
128
129 fs_flags: various flags (i.e. FS_REQUIRES_DEV, FS_NO_DCACHE, etc.)
130
5ea626aa 131 get_sb: the method to call when a new instance of this
1da177e4
LT
132 filesystem should be mounted
133
5ea626aa
PE
134 kill_sb: the method to call when an instance of this filesystem
135 should be unmounted
136
137 owner: for internal VFS use: you should initialize this to THIS_MODULE in
138 most cases.
1da177e4 139
5ea626aa
PE
140 next: for internal VFS use: you should initialize this to NULL
141
0746aec3
BP
142 s_lock_key, s_umount_key: lockdep-specific
143
5ea626aa 144The get_sb() method has the following arguments:
1da177e4 145
0746aec3
BP
146 struct file_system_type *fs_type: decribes the filesystem, partly initialized
147 by the specific filesystem code
5ea626aa
PE
148
149 int flags: mount flags
150
151 const char *dev_name: the device name we are mounting.
1da177e4
LT
152
153 void *data: arbitrary mount options, usually comes as an ASCII
f84e3f52 154 string (see "Mount Options" section)
1da177e4 155
0746aec3 156 struct vfsmount *mnt: a vfs-internal representation of a mount point
1da177e4 157
5ea626aa 158The get_sb() method must determine if the block device specified
0746aec3
BP
159in the dev_name and fs_type contains a filesystem of the type the method
160supports. If it succeeds in opening the named block device, it initializes a
161struct super_block descriptor for the filesystem contained by the block device.
162On failure it returns an error.
1da177e4
LT
163
164The most interesting member of the superblock structure that the
5ea626aa 165get_sb() method fills in is the "s_op" field. This is a pointer to
1da177e4
LT
166a "struct super_operations" which describes the next level of the
167filesystem implementation.
168
e3e1bfe4
JC
169Usually, a filesystem uses one of the generic get_sb() implementations
170and provides a fill_super() method instead. The generic methods are:
5ea626aa
PE
171
172 get_sb_bdev: mount a filesystem residing on a block device
1da177e4 173
5ea626aa
PE
174 get_sb_nodev: mount a filesystem that is not backed by a device
175
176 get_sb_single: mount a filesystem which shares the instance between
177 all mounts
178
179A fill_super() method implementation has the following arguments:
180
181 struct super_block *sb: the superblock structure. The method fill_super()
182 must initialize this properly.
183
184 void *data: arbitrary mount options, usually comes as an ASCII
f84e3f52 185 string (see "Mount Options" section)
5ea626aa
PE
186
187 int silent: whether or not to be silent on error
188
189
cc7d1f8f
PE
190The Superblock Object
191=====================
192
193A superblock object represents a mounted filesystem.
194
195
5ea626aa 196struct super_operations
cc7d1f8f 197-----------------------
1da177e4
LT
198
199This describes how the VFS can manipulate the superblock of your
422b14c2 200filesystem. As of kernel 2.6.22, the following members are defined:
1da177e4
LT
201
202struct super_operations {
5ea626aa
PE
203 struct inode *(*alloc_inode)(struct super_block *sb);
204 void (*destroy_inode)(struct inode *);
205
5ea626aa
PE
206 void (*dirty_inode) (struct inode *);
207 int (*write_inode) (struct inode *, int);
5ea626aa
PE
208 void (*drop_inode) (struct inode *);
209 void (*delete_inode) (struct inode *);
210 void (*put_super) (struct super_block *);
211 void (*write_super) (struct super_block *);
212 int (*sync_fs)(struct super_block *sb, int wait);
213 void (*write_super_lockfs) (struct super_block *);
214 void (*unlockfs) (struct super_block *);
726c3342 215 int (*statfs) (struct dentry *, struct kstatfs *);
5ea626aa
PE
216 int (*remount_fs) (struct super_block *, int *, char *);
217 void (*clear_inode) (struct inode *);
218 void (*umount_begin) (struct super_block *);
219
5ea626aa
PE
220 int (*show_options)(struct seq_file *, struct vfsmount *);
221
222 ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
223 ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
1da177e4
LT
224};
225
226All methods are called without any locks being held, unless otherwise
227noted. This means that most methods can block safely. All methods are
228only called from a process context (i.e. not from an interrupt handler
229or bottom half).
230
5ea626aa 231 alloc_inode: this method is called by inode_alloc() to allocate memory
341546f5
N
232 for struct inode and initialize it. If this function is not
233 defined, a simple 'struct inode' is allocated. Normally
234 alloc_inode will be used to allocate a larger structure which
235 contains a 'struct inode' embedded within it.
5ea626aa
PE
236
237 destroy_inode: this method is called by destroy_inode() to release
341546f5
N
238 resources allocated for struct inode. It is only required if
239 ->alloc_inode was defined and simply undoes anything done by
240 ->alloc_inode.
5ea626aa 241
5ea626aa 242 dirty_inode: this method is called by the VFS to mark an inode dirty.
1da177e4
LT
243
244 write_inode: this method is called when the VFS needs to write an
245 inode to disc. The second parameter indicates whether the write
246 should be synchronous or not, not all filesystems check this flag.
247
1da177e4
LT
248 drop_inode: called when the last access to the inode is dropped,
249 with the inode_lock spinlock held.
250
5ea626aa 251 This method should be either NULL (normal UNIX filesystem
1da177e4
LT
252 semantics) or "generic_delete_inode" (for filesystems that do not
253 want to cache inodes - causing "delete_inode" to always be
254 called regardless of the value of i_nlink)
255
5ea626aa 256 The "generic_delete_inode()" behavior is equivalent to the
1da177e4
LT
257 old practice of using "force_delete" in the put_inode() case,
258 but does not have the races that the "force_delete()" approach
259 had.
260
261 delete_inode: called when the VFS wants to delete an inode
262
1da177e4
LT
263 put_super: called when the VFS wishes to free the superblock
264 (i.e. unmount). This is called with the superblock lock held
265
266 write_super: called when the VFS superblock needs to be written to
267 disc. This method is optional
268
5ea626aa
PE
269 sync_fs: called when VFS is writing out all dirty data associated with
270 a superblock. The second parameter indicates whether the method
271 should wait until the write out has been completed. Optional.
272
cc7d1f8f
PE
273 write_super_lockfs: called when VFS is locking a filesystem and
274 forcing it into a consistent state. This method is currently
275 used by the Logical Volume Manager (LVM).
5ea626aa
PE
276
277 unlockfs: called when VFS is unlocking a filesystem and making it writable
278 again.
279
1da177e4
LT
280 statfs: called when the VFS needs to get filesystem statistics. This
281 is called with the kernel lock held
282
283 remount_fs: called when the filesystem is remounted. This is called
284 with the kernel lock held
285
286 clear_inode: called then the VFS clears the inode. Optional
287
5ea626aa
PE
288 umount_begin: called when the VFS is unmounting a filesystem.
289
f84e3f52
MS
290 show_options: called by the VFS to show mount options for
291 /proc/<pid>/mounts. (see "Mount Options" section)
5ea626aa
PE
292
293 quota_read: called by the VFS to read from filesystem quota file.
294
295 quota_write: called by the VFS to write to filesystem quota file.
296
12debc42
DH
297Whoever sets up the inode is responsible for filling in the "i_op" field. This
298is a pointer to a "struct inode_operations" which describes the methods that
299can be performed on individual inodes.
1da177e4
LT
300
301
cc7d1f8f
PE
302The Inode Object
303================
304
305An inode object represents an object within the filesystem.
306
307
5ea626aa 308struct inode_operations
cc7d1f8f 309-----------------------
1da177e4
LT
310
311This describes how the VFS can manipulate an inode in your
422b14c2 312filesystem. As of kernel 2.6.22, the following members are defined:
1da177e4
LT
313
314struct inode_operations {
5ea626aa
PE
315 int (*create) (struct inode *,struct dentry *,int, struct nameidata *);
316 struct dentry * (*lookup) (struct inode *,struct dentry *, struct nameidata *);
1da177e4
LT
317 int (*link) (struct dentry *,struct inode *,struct dentry *);
318 int (*unlink) (struct inode *,struct dentry *);
319 int (*symlink) (struct inode *,struct dentry *,const char *);
320 int (*mkdir) (struct inode *,struct dentry *,int);
321 int (*rmdir) (struct inode *,struct dentry *);
322 int (*mknod) (struct inode *,struct dentry *,int,dev_t);
323 int (*rename) (struct inode *, struct dentry *,
324 struct inode *, struct dentry *);
5ea626aa
PE
325 int (*readlink) (struct dentry *, char __user *,int);
326 void * (*follow_link) (struct dentry *, struct nameidata *);
327 void (*put_link) (struct dentry *, struct nameidata *, void *);
1da177e4 328 void (*truncate) (struct inode *);
5ea626aa
PE
329 int (*permission) (struct inode *, int, struct nameidata *);
330 int (*setattr) (struct dentry *, struct iattr *);
331 int (*getattr) (struct vfsmount *mnt, struct dentry *, struct kstat *);
332 int (*setxattr) (struct dentry *, const char *,const void *,size_t,int);
333 ssize_t (*getxattr) (struct dentry *, const char *, void *, size_t);
334 ssize_t (*listxattr) (struct dentry *, char *, size_t);
335 int (*removexattr) (struct dentry *, const char *);
422b14c2 336 void (*truncate_range)(struct inode *, loff_t, loff_t);
1da177e4
LT
337};
338
339Again, all methods are called without any locks being held, unless
340otherwise noted.
341
1da177e4
LT
342 create: called by the open(2) and creat(2) system calls. Only
343 required if you want to support regular files. The dentry you
344 get should not have an inode (i.e. it should be a negative
345 dentry). Here you will probably call d_instantiate() with the
346 dentry and the newly created inode
347
348 lookup: called when the VFS needs to look up an inode in a parent
349 directory. The name to look for is found in the dentry. This
350 method must call d_add() to insert the found inode into the
351 dentry. The "i_count" field in the inode structure should be
352 incremented. If the named inode does not exist a NULL inode
353 should be inserted into the dentry (this is called a negative
354 dentry). Returning an error code from this routine must only
355 be done on a real error, otherwise creating inodes with system
356 calls like create(2), mknod(2), mkdir(2) and so on will fail.
357 If you wish to overload the dentry methods then you should
358 initialise the "d_dop" field in the dentry; this is a pointer
359 to a struct "dentry_operations".
360 This method is called with the directory inode semaphore held
361
362 link: called by the link(2) system call. Only required if you want
363 to support hard links. You will probably need to call
364 d_instantiate() just as you would in the create() method
365
366 unlink: called by the unlink(2) system call. Only required if you
367 want to support deleting inodes
368
369 symlink: called by the symlink(2) system call. Only required if you
370 want to support symlinks. You will probably need to call
371 d_instantiate() just as you would in the create() method
372
373 mkdir: called by the mkdir(2) system call. Only required if you want
374 to support creating subdirectories. You will probably need to
375 call d_instantiate() just as you would in the create() method
376
377 rmdir: called by the rmdir(2) system call. Only required if you want
378 to support deleting subdirectories
379
380 mknod: called by the mknod(2) system call to create a device (char,
381 block) inode or a named pipe (FIFO) or socket. Only required
382 if you want to support creating these types of inodes. You
383 will probably need to call d_instantiate() just as you would
384 in the create() method
385
cc7d1f8f
PE
386 rename: called by the rename(2) system call to rename the object to
387 have the parent and name given by the second inode and dentry.
388
1da177e4
LT
389 readlink: called by the readlink(2) system call. Only required if
390 you want to support reading symbolic links
391
392 follow_link: called by the VFS to follow a symbolic link to the
5ea626aa 393 inode it points to. Only required if you want to support
cc7d1f8f 394 symbolic links. This method returns a void pointer cookie
5ea626aa
PE
395 that is passed to put_link().
396
397 put_link: called by the VFS to release resources allocated by
cc7d1f8f 398 follow_link(). The cookie returned by follow_link() is passed
670e9f34 399 to this method as the last parameter. It is used by
cc7d1f8f
PE
400 filesystems such as NFS where page cache is not stable
401 (i.e. page that was installed when the symbolic link walk
402 started might not be in the page cache at the end of the
403 walk).
404
405 truncate: called by the VFS to change the size of a file. The
406 i_size field of the inode is set to the desired size by the
407 VFS before this method is called. This method is called by
408 the truncate(2) system call and related functionality.
5ea626aa
PE
409
410 permission: called by the VFS to check for access rights on a POSIX-like
411 filesystem.
412
cc7d1f8f
PE
413 setattr: called by the VFS to set attributes for a file. This method
414 is called by chmod(2) and related system calls.
5ea626aa 415
cc7d1f8f
PE
416 getattr: called by the VFS to get attributes of a file. This method
417 is called by stat(2) and related system calls.
5ea626aa
PE
418
419 setxattr: called by the VFS to set an extended attribute for a file.
cc7d1f8f
PE
420 Extended attribute is a name:value pair associated with an
421 inode. This method is called by setxattr(2) system call.
422
423 getxattr: called by the VFS to retrieve the value of an extended
424 attribute name. This method is called by getxattr(2) function
425 call.
426
427 listxattr: called by the VFS to list all extended attributes for a
428 given file. This method is called by listxattr(2) system call.
5ea626aa 429
cc7d1f8f
PE
430 removexattr: called by the VFS to remove an extended attribute from
431 a file. This method is called by removexattr(2) system call.
5ea626aa 432
422b14c2
BP
433 truncate_range: a method provided by the underlying filesystem to truncate a
434 range of blocks , i.e. punch a hole somewhere in a file.
435
5ea626aa 436
cc7d1f8f
PE
437The Address Space Object
438========================
439
341546f5
N
440The address space object is used to group and manage pages in the page
441cache. It can be used to keep track of the pages in a file (or
442anything else) and also track the mapping of sections of the file into
443process address spaces.
444
445There are a number of distinct yet related services that an
446address-space can provide. These include communicating memory
447pressure, page lookup by address, and keeping track of pages tagged as
448Dirty or Writeback.
449
a9e102b6 450The first can be used independently to the others. The VM can try to
341546f5
N
451either write dirty pages in order to clean them, or release clean
452pages in order to reuse them. To do this it can call the ->writepage
453method on dirty pages, and ->releasepage on clean pages with
454PagePrivate set. Clean pages without PagePrivate and with no external
455references will be released without notice being given to the
456address_space.
457
a9e102b6 458To achieve this functionality, pages need to be placed on an LRU with
341546f5
N
459lru_cache_add and mark_page_active needs to be called whenever the
460page is used.
461
462Pages are normally kept in a radix tree index by ->index. This tree
463maintains information about the PG_Dirty and PG_Writeback status of
464each page, so that pages with either of these flags can be found
465quickly.
466
467The Dirty tag is primarily used by mpage_writepages - the default
468->writepages method. It uses the tag to find dirty pages to call
469->writepage on. If mpage_writepages is not used (i.e. the address
a9e102b6 470provides its own ->writepages) , the PAGECACHE_TAG_DIRTY tag is
341546f5
N
471almost unused. write_inode_now and sync_inode do use it (through
472__sync_single_inode) to check if ->writepages has been successful in
473writing out the whole address_space.
474
475The Writeback tag is used by filemap*wait* and sync_page* functions,
a9e102b6 476via wait_on_page_writeback_range, to wait for all writeback to
341546f5 477complete. While waiting ->sync_page (if defined) will be called on
a9e102b6 478each page that is found to require writeback.
341546f5
N
479
480An address_space handler may attach extra information to a page,
481typically using the 'private' field in the 'struct page'. If such
482information is attached, the PG_Private flag should be set. This will
a9e102b6 483cause various VM routines to make extra calls into the address_space
341546f5
N
484handler to deal with that data.
485
486An address space acts as an intermediate between storage and
487application. Data is read into the address space a whole page at a
488time, and provided to the application either by copying of the page,
489or by memory-mapping the page.
490Data is written into the address space by the application, and then
491written-back to storage typically in whole pages, however the
a9e102b6 492address_space has finer control of write sizes.
341546f5
N
493
494The read process essentially only requires 'readpage'. The write
495process is more complicated and uses prepare_write/commit_write or
496set_page_dirty to write data into the address_space, and writepage,
497sync_page, and writepages to writeback data to storage.
498
499Adding and removing pages to/from an address_space is protected by the
500inode's i_mutex.
501
502When data is written to a page, the PG_Dirty flag should be set. It
503typically remains set until writepage asks for it to be written. This
504should clear PG_Dirty and set PG_Writeback. It can be actually
505written at any point after PG_Dirty is clear. Once it is known to be
506safe, PG_Writeback is cleared.
507
508Writeback makes use of a writeback_control structure...
5ea626aa
PE
509
510struct address_space_operations
cc7d1f8f 511-------------------------------
5ea626aa
PE
512
513This describes how the VFS can manipulate mapping of a file to page cache in
422b14c2 514your filesystem. As of kernel 2.6.22, the following members are defined:
5ea626aa
PE
515
516struct address_space_operations {
517 int (*writepage)(struct page *page, struct writeback_control *wbc);
518 int (*readpage)(struct file *, struct page *);
519 int (*sync_page)(struct page *);
520 int (*writepages)(struct address_space *, struct writeback_control *);
521 int (*set_page_dirty)(struct page *page);
522 int (*readpages)(struct file *filp, struct address_space *mapping,
523 struct list_head *pages, unsigned nr_pages);
524 int (*prepare_write)(struct file *, struct page *, unsigned, unsigned);
525 int (*commit_write)(struct file *, struct page *, unsigned, unsigned);
afddba49
NP
526 int (*write_begin)(struct file *, struct address_space *mapping,
527 loff_t pos, unsigned len, unsigned flags,
528 struct page **pagep, void **fsdata);
529 int (*write_end)(struct file *, struct address_space *mapping,
530 loff_t pos, unsigned len, unsigned copied,
531 struct page *page, void *fsdata);
5ea626aa
PE
532 sector_t (*bmap)(struct address_space *, sector_t);
533 int (*invalidatepage) (struct page *, unsigned long);
534 int (*releasepage) (struct page *, int);
535 ssize_t (*direct_IO)(int, struct kiocb *, const struct iovec *iov,
536 loff_t offset, unsigned long nr_segs);
537 struct page* (*get_xip_page)(struct address_space *, sector_t,
538 int);
341546f5
N
539 /* migrate the contents of a page to the specified target */
540 int (*migratepage) (struct page *, struct page *);
422b14c2 541 int (*launder_page) (struct page *);
5ea626aa
PE
542};
543
341546f5 544 writepage: called by the VM to write a dirty page to backing store.
a9e102b6 545 This may happen for data integrity reasons (i.e. 'sync'), or
341546f5
N
546 to free up memory (flush). The difference can be seen in
547 wbc->sync_mode.
548 The PG_Dirty flag has been cleared and PageLocked is true.
549 writepage should start writeout, should set PG_Writeback,
550 and should make sure the page is unlocked, either synchronously
551 or asynchronously when the write operation completes.
552
553 If wbc->sync_mode is WB_SYNC_NONE, ->writepage doesn't have to
a9e102b6
N
554 try too hard if there are problems, and may choose to write out
555 other pages from the mapping if that is easier (e.g. due to
556 internal dependencies). If it chooses not to start writeout, it
557 should return AOP_WRITEPAGE_ACTIVATE so that the VM will not keep
341546f5
N
558 calling ->writepage on that page.
559
560 See the file "Locking" for more details.
5ea626aa
PE
561
562 readpage: called by the VM to read a page from backing store.
341546f5
N
563 The page will be Locked when readpage is called, and should be
564 unlocked and marked uptodate once the read completes.
565 If ->readpage discovers that it needs to unlock the page for
566 some reason, it can do so, and then return AOP_TRUNCATED_PAGE.
a9e102b6 567 In this case, the page will be relocated, relocked and if
341546f5 568 that all succeeds, ->readpage will be called again.
5ea626aa
PE
569
570 sync_page: called by the VM to notify the backing store to perform all
571 queued I/O operations for a page. I/O operations for other pages
572 associated with this address_space object may also be performed.
573
341546f5
N
574 This function is optional and is called only for pages with
575 PG_Writeback set while waiting for the writeback to complete.
576
5ea626aa 577 writepages: called by the VM to write out pages associated with the
a9e102b6
N
578 address_space object. If wbc->sync_mode is WBC_SYNC_ALL, then
579 the writeback_control will specify a range of pages that must be
580 written out. If it is WBC_SYNC_NONE, then a nr_to_write is given
341546f5
N
581 and that many pages should be written if possible.
582 If no ->writepages is given, then mpage_writepages is used
a9e102b6 583 instead. This will choose pages from the address space that are
341546f5 584 tagged as DIRTY and will pass them to ->writepage.
5ea626aa
PE
585
586 set_page_dirty: called by the VM to set a page dirty.
341546f5
N
587 This is particularly needed if an address space attaches
588 private data to a page, and that data needs to be updated when
589 a page is dirtied. This is called, for example, when a memory
590 mapped page gets modified.
591 If defined, it should set the PageDirty flag, and the
592 PAGECACHE_TAG_DIRTY tag in the radix tree.
5ea626aa
PE
593
594 readpages: called by the VM to read pages associated with the address_space
341546f5
N
595 object. This is essentially just a vector version of
596 readpage. Instead of just one page, several pages are
597 requested.
a9e102b6 598 readpages is only used for read-ahead, so read errors are
341546f5 599 ignored. If anything goes wrong, feel free to give up.
1da177e4 600
5ea626aa 601 prepare_write: called by the generic write path in VM to set up a write
341546f5 602 request for a page. This indicates to the address space that
a9e102b6 603 the given range of bytes is about to be written. The
341546f5
N
604 address_space should check that the write will be able to
605 complete, by allocating space if necessary and doing any other
a9e102b6 606 internal housekeeping. If the write will update parts of
341546f5
N
607 any basic-blocks on storage, then those blocks should be
608 pre-read (if they haven't been read already) so that the
609 updated blocks can be written out properly.
55144768 610 The page will be locked.
341546f5 611
955eff5a
NP
612 Note: the page _must not_ be marked uptodate in this function
613 (or anywhere else) unless it actually is uptodate right now. As
614 soon as a page is marked uptodate, it is possible for a concurrent
615 read(2) to copy it to userspace.
616
341546f5
N
617 commit_write: If prepare_write succeeds, new data will be copied
618 into the page and then commit_write will be called. It will
619 typically update the size of the file (if appropriate) and
620 mark the inode as dirty, and do any other related housekeeping
621 operations. It should avoid returning an error if possible -
622 errors should have been handled by prepare_write.
5ea626aa 623
afddba49
NP
624 write_begin: This is intended as a replacement for prepare_write. The
625 key differences being that:
626 - it returns a locked page (in *pagep) rather than being
627 given a pre locked page;
628 - it must be able to cope with short writes (where the
629 length passed to write_begin is greater than the number
630 of bytes copied into the page).
631
632 Called by the generic buffered write code to ask the filesystem to
633 prepare to write len bytes at the given offset in the file. The
634 address_space should check that the write will be able to complete,
635 by allocating space if necessary and doing any other internal
636 housekeeping. If the write will update parts of any basic-blocks on
637 storage, then those blocks should be pre-read (if they haven't been
638 read already) so that the updated blocks can be written out properly.
639
640 The filesystem must return the locked pagecache page for the specified
641 offset, in *pagep, for the caller to write into.
642
643 flags is a field for AOP_FLAG_xxx flags, described in
644 include/linux/fs.h.
645
646 A void * may be returned in fsdata, which then gets passed into
647 write_end.
648
649 Returns 0 on success; < 0 on failure (which is the error code), in
650 which case write_end is not called.
651
652 write_end: After a successful write_begin, and data copy, write_end must
653 be called. len is the original len passed to write_begin, and copied
654 is the amount that was able to be copied (copied == len is always true
655 if write_begin was called with the AOP_FLAG_UNINTERRUPTIBLE flag).
656
657 The filesystem must take care of unlocking the page and releasing it
658 refcount, and updating i_size.
659
660 Returns < 0 on failure, otherwise the number of bytes (<= 'copied')
661 that were able to be copied into pagecache.
662
5ea626aa 663 bmap: called by the VFS to map a logical block offset within object to
a9e102b6 664 physical block number. This method is used by the FIBMAP
341546f5 665 ioctl and for working with swap-files. To be able to swap to
a9e102b6 666 a file, the file must have a stable mapping to a block
341546f5
N
667 device. The swap system does not go through the filesystem
668 but instead uses bmap to find out where the blocks in the file
669 are and uses those addresses directly.
670
671
672 invalidatepage: If a page has PagePrivate set, then invalidatepage
673 will be called when part or all of the page is to be removed
a9e102b6 674 from the address space. This generally corresponds to either a
341546f5
N
675 truncation or a complete invalidation of the address space
676 (in the latter case 'offset' will always be 0).
677 Any private data associated with the page should be updated
678 to reflect this truncation. If offset is 0, then
679 the private data should be released, because the page
680 must be able to be completely discarded. This may be done by
681 calling the ->releasepage function, but in this case the
682 release MUST succeed.
683
684 releasepage: releasepage is called on PagePrivate pages to indicate
685 that the page should be freed if possible. ->releasepage
686 should remove any private data from the page and clear the
687 PagePrivate flag. It may also remove the page from the
688 address_space. If this fails for some reason, it may indicate
689 failure with a 0 return value.
690 This is used in two distinct though related cases. The first
691 is when the VM finds a clean page with no active users and
692 wants to make it a free page. If ->releasepage succeeds, the
693 page will be removed from the address_space and become free.
694
bc5b1d55 695 The second case is when a request has been made to invalidate
341546f5
N
696 some or all pages in an address_space. This can happen
697 through the fadvice(POSIX_FADV_DONTNEED) system call or by the
698 filesystem explicitly requesting it as nfs and 9fs do (when
699 they believe the cache may be out of date with storage) by
700 calling invalidate_inode_pages2().
701 If the filesystem makes such a call, and needs to be certain
a9e102b6 702 that all pages are invalidated, then its releasepage will
341546f5
N
703 need to ensure this. Possibly it can clear the PageUptodate
704 bit if it cannot free private data yet.
705
706 direct_IO: called by the generic read/write routines to perform
707 direct_IO - that is IO requests which bypass the page cache
a9e102b6 708 and transfer data directly between the storage and the
341546f5 709 application's address space.
5ea626aa
PE
710
711 get_xip_page: called by the VM to translate a block number to a page.
712 The page is valid until the corresponding filesystem is unmounted.
713 Filesystems that want to use execute-in-place (XIP) need to implement
714 it. An example implementation can be found in fs/ext2/xip.c.
715
341546f5
N
716 migrate_page: This is used to compact the physical memory usage.
717 If the VM wants to relocate a page (maybe off a memory card
718 that is signalling imminent failure) it will pass a new page
719 and an old page to this function. migrate_page should
720 transfer any private data across and update any references
721 that it has to the page.
5ea626aa 722
422b14c2
BP
723 launder_page: Called before freeing a page - it writes back the dirty page. To
724 prevent redirtying the page, it is kept locked during the whole
725 operation.
726
cc7d1f8f
PE
727The File Object
728===============
729
730A file object represents a file opened by a process.
731
732
5ea626aa 733struct file_operations
cc7d1f8f 734----------------------
1da177e4
LT
735
736This describes how the VFS can manipulate an open file. As of kernel
422b14c2 7372.6.22, the following members are defined:
1da177e4
LT
738
739struct file_operations {
422b14c2 740 struct module *owner;
1da177e4 741 loff_t (*llseek) (struct file *, loff_t, int);
5ea626aa 742 ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
5ea626aa 743 ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
027445c3
BP
744 ssize_t (*aio_read) (struct kiocb *, const struct iovec *, unsigned long, loff_t);
745 ssize_t (*aio_write) (struct kiocb *, const struct iovec *, unsigned long, loff_t);
1da177e4
LT
746 int (*readdir) (struct file *, void *, filldir_t);
747 unsigned int (*poll) (struct file *, struct poll_table_struct *);
748 int (*ioctl) (struct inode *, struct file *, unsigned int, unsigned long);
5ea626aa
PE
749 long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
750 long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
1da177e4
LT
751 int (*mmap) (struct file *, struct vm_area_struct *);
752 int (*open) (struct inode *, struct file *);
5ea626aa 753 int (*flush) (struct file *);
1da177e4 754 int (*release) (struct inode *, struct file *);
5ea626aa
PE
755 int (*fsync) (struct file *, struct dentry *, int datasync);
756 int (*aio_fsync) (struct kiocb *, int datasync);
757 int (*fasync) (int, struct file *, int);
1da177e4 758 int (*lock) (struct file *, int, struct file_lock *);
5ea626aa
PE
759 ssize_t (*readv) (struct file *, const struct iovec *, unsigned long, loff_t *);
760 ssize_t (*writev) (struct file *, const struct iovec *, unsigned long, loff_t *);
761 ssize_t (*sendfile) (struct file *, loff_t *, size_t, read_actor_t, void *);
762 ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int);
763 unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long);
764 int (*check_flags)(int);
765 int (*dir_notify)(struct file *filp, unsigned long arg);
766 int (*flock) (struct file *, int, struct file_lock *);
422b14c2
BP
767 ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, size_t, unsigned int);
768 ssize_t (*splice_read)(struct file *, struct pipe_inode_info *, size_t, unsigned int);
1da177e4
LT
769};
770
771Again, all methods are called without any locks being held, unless
772otherwise noted.
773
774 llseek: called when the VFS needs to move the file position index
775
776 read: called by read(2) and related system calls
777
5ea626aa
PE
778 aio_read: called by io_submit(2) and other asynchronous I/O operations
779
1da177e4
LT
780 write: called by write(2) and related system calls
781
5ea626aa
PE
782 aio_write: called by io_submit(2) and other asynchronous I/O operations
783
1da177e4
LT
784 readdir: called when the VFS needs to read the directory contents
785
786 poll: called by the VFS when a process wants to check if there is
787 activity on this file and (optionally) go to sleep until there
788 is activity. Called by the select(2) and poll(2) system calls
789
790 ioctl: called by the ioctl(2) system call
791
5ea626aa
PE
792 unlocked_ioctl: called by the ioctl(2) system call. Filesystems that do not
793 require the BKL should use this method instead of the ioctl() above.
794
795 compat_ioctl: called by the ioctl(2) system call when 32 bit system calls
796 are used on 64 bit kernels.
797
1da177e4
LT
798 mmap: called by the mmap(2) system call
799
800 open: called by the VFS when an inode should be opened. When the VFS
5ea626aa
PE
801 opens a file, it creates a new "struct file". It then calls the
802 open method for the newly allocated file structure. You might
803 think that the open method really belongs in
804 "struct inode_operations", and you may be right. I think it's
805 done the way it is because it makes filesystems simpler to
806 implement. The open() method is a good place to initialize the
807 "private_data" member in the file structure if you want to point
808 to a device structure
809
810 flush: called by the close(2) system call to flush a file
1da177e4
LT
811
812 release: called when the last reference to an open file is closed
813
814 fsync: called by the fsync(2) system call
815
816 fasync: called by the fcntl(2) system call when asynchronous
817 (non-blocking) mode is enabled for a file
818
5ea626aa
PE
819 lock: called by the fcntl(2) system call for F_GETLK, F_SETLK, and F_SETLKW
820 commands
821
822 readv: called by the readv(2) system call
823
824 writev: called by the writev(2) system call
825
826 sendfile: called by the sendfile(2) system call
827
828 get_unmapped_area: called by the mmap(2) system call
829
830 check_flags: called by the fcntl(2) system call for F_SETFL command
831
832 dir_notify: called by the fcntl(2) system call for F_NOTIFY command
833
834 flock: called by the flock(2) system call
835
d1195c51
PE
836 splice_write: called by the VFS to splice data from a pipe to a file. This
837 method is used by the splice(2) system call
838
839 splice_read: called by the VFS to splice data from file to a pipe. This
840 method is used by the splice(2) system call
841
1da177e4
LT
842Note that the file operations are implemented by the specific
843filesystem in which the inode resides. When opening a device node
844(character or block special) most filesystems will call special
845support routines in the VFS which will locate the required device
846driver information. These support routines replace the filesystem file
847operations with those for the device driver, and then proceed to call
848the new open() method for the file. This is how opening a device file
849in the filesystem eventually ends up calling the device driver open()
5ea626aa 850method.
1da177e4
LT
851
852
5ea626aa
PE
853Directory Entry Cache (dcache)
854==============================
855
1da177e4
LT
856
857struct dentry_operations
5ea626aa 858------------------------
1da177e4
LT
859
860This describes how a filesystem can overload the standard dentry
861operations. Dentries and the dcache are the domain of the VFS and the
862individual filesystem implementations. Device drivers have no business
863here. These methods may be set to NULL, as they are either optional or
c23fbb6b 864the VFS uses a default. As of kernel 2.6.22, the following members are
1da177e4
LT
865defined:
866
867struct dentry_operations {
5ea626aa 868 int (*d_revalidate)(struct dentry *, struct nameidata *);
1da177e4
LT
869 int (*d_hash) (struct dentry *, struct qstr *);
870 int (*d_compare) (struct dentry *, struct qstr *, struct qstr *);
5ea626aa 871 int (*d_delete)(struct dentry *);
1da177e4
LT
872 void (*d_release)(struct dentry *);
873 void (*d_iput)(struct dentry *, struct inode *);
c23fbb6b 874 char *(*d_dname)(struct dentry *, char *, int);
1da177e4
LT
875};
876
877 d_revalidate: called when the VFS needs to revalidate a dentry. This
878 is called whenever a name look-up finds a dentry in the
879 dcache. Most filesystems leave this as NULL, because all their
880 dentries in the dcache are valid
881
882 d_hash: called when the VFS adds a dentry to the hash table
883
884 d_compare: called when a dentry should be compared with another
885
886 d_delete: called when the last reference to a dentry is
887 deleted. This means no-one is using the dentry, however it is
888 still valid and in the dcache
889
890 d_release: called when a dentry is really deallocated
891
892 d_iput: called when a dentry loses its inode (just prior to its
893 being deallocated). The default when this is NULL is that the
894 VFS calls iput(). If you define this method, you must call
895 iput() yourself
896
c23fbb6b
ED
897 d_dname: called when the pathname of a dentry should be generated.
898 Usefull for some pseudo filesystems (sockfs, pipefs, ...) to delay
899 pathname generation. (Instead of doing it when dentry is created,
900 its done only when the path is needed.). Real filesystems probably
901 dont want to use it, because their dentries are present in global
902 dcache hash, so their hash should be an invariant. As no lock is
903 held, d_dname() should not try to modify the dentry itself, unless
904 appropriate SMP safety is used. CAUTION : d_path() logic is quite
905 tricky. The correct way to return for example "Hello" is to put it
906 at the end of the buffer, and returns a pointer to the first char.
907 dynamic_dname() helper function is provided to take care of this.
908
909Example :
910
911static char *pipefs_dname(struct dentry *dent, char *buffer, int buflen)
912{
913 return dynamic_dname(dentry, buffer, buflen, "pipe:[%lu]",
914 dentry->d_inode->i_ino);
915}
916
1da177e4
LT
917Each dentry has a pointer to its parent dentry, as well as a hash list
918of child dentries. Child dentries are basically like files in a
919directory.
920
5ea626aa 921
cc7d1f8f 922Directory Entry Cache API
1da177e4
LT
923--------------------------
924
925There are a number of functions defined which permit a filesystem to
926manipulate dentries:
927
928 dget: open a new handle for an existing dentry (this just increments
929 the usage count)
930
931 dput: close a handle for a dentry (decrements the usage count). If
932 the usage count drops to 0, the "d_delete" method is called
933 and the dentry is placed on the unused list if the dentry is
934 still in its parents hash list. Putting the dentry on the
935 unused list just means that if the system needs some RAM, it
936 goes through the unused list of dentries and deallocates them.
937 If the dentry has already been unhashed and the usage count
938 drops to 0, in this case the dentry is deallocated after the
939 "d_delete" method is called
940
941 d_drop: this unhashes a dentry from its parents hash list. A
5ea626aa 942 subsequent call to dput() will deallocate the dentry if its
1da177e4
LT
943 usage count drops to 0
944
945 d_delete: delete a dentry. If there are no other open references to
946 the dentry then the dentry is turned into a negative dentry
947 (the d_iput() method is called). If there are other
948 references, then d_drop() is called instead
949
950 d_add: add a dentry to its parents hash list and then calls
951 d_instantiate()
952
953 d_instantiate: add a dentry to the alias hash list for the inode and
954 updates the "d_inode" member. The "i_count" member in the
955 inode structure should be set/incremented. If the inode
956 pointer is NULL, the dentry is called a "negative
957 dentry". This function is commonly called when an inode is
958 created for an existing negative dentry
959
960 d_lookup: look up a dentry given its parent and path name component
961 It looks up the child of that given name from the dcache
962 hash table. If it is found, the reference count is incremented
963 and the dentry is returned. The caller must use d_put()
964 to free the dentry when it finishes using it.
965
cbf8f0f3
PE
966For further information on dentry locking, please refer to the document
967Documentation/filesystems/dentry-locking.txt.
cc7d1f8f 968
f84e3f52
MS
969Mount Options
970=============
971
972Parsing options
973---------------
974
975On mount and remount the filesystem is passed a string containing a
976comma separated list of mount options. The options can have either of
977these forms:
978
979 option
980 option=value
981
982The <linux/parser.h> header defines an API that helps parse these
983options. There are plenty of examples on how to use it in existing
984filesystems.
985
986Showing options
987---------------
988
989If a filesystem accepts mount options, it must define show_options()
990to show all the currently active options. The rules are:
991
992 - options MUST be shown which are not default or their values differ
993 from the default
994
995 - options MAY be shown which are enabled by default or have their
996 default value
997
998Options used only internally between a mount helper and the kernel
999(such as file descriptors), or which only have an effect during the
1000mounting (such as ones controlling the creation of a journal) are exempt
1001from the above rules.
1002
1003The underlying reason for the above rules is to make sure, that a
1004mount can be accurately replicated (e.g. umounting and mounting again)
1005based on the information found in /proc/mounts.
1006
1007A simple method of saving options at mount/remount time and showing
1008them is provided with the save_mount_options() and
1009generic_show_options() helper functions. Please note, that using
1010these may have drawbacks. For more info see header comments for these
1011functions in fs/namespace.c.
cc7d1f8f
PE
1012
1013Resources
1014=========
1015
1016(Note some of these resources are not up-to-date with the latest kernel
1017 version.)
1018
1019Creating Linux virtual filesystems. 2002
1020 <http://lwn.net/Articles/13325/>
1021
1022The Linux Virtual File-system Layer by Neil Brown. 1999
1023 <http://www.cse.unsw.edu.au/~neilb/oss/linux-commentary/vfs.html>
1024
1025A tour of the Linux VFS by Michael K. Johnson. 1996
1026 <http://www.tldp.org/LDP/khg/HyperNews/get/fs/vfstour.html>
1027
1028A small trail through the Linux kernel by Andries Brouwer. 2001
1029 <http://www.win.tue.nl/~aeb/linux/vfs/trail.html>