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