1af96c1e3STobin C. Harding.. SPDX-License-Identifier: GPL-2.0 2af96c1e3STobin C. Harding 3af96c1e3STobin C. Harding========================================= 4af96c1e3STobin C. HardingOverview of the Linux Virtual File System 5af96c1e3STobin C. Harding========================================= 6af96c1e3STobin C. Harding 7af96c1e3STobin C. HardingOriginal author: Richard Gooch <rgooch@atnf.csiro.au> 8af96c1e3STobin C. Harding 9af96c1e3STobin C. Harding- Copyright (C) 1999 Richard Gooch 10af96c1e3STobin C. Harding- Copyright (C) 2005 Pekka Enberg 11af96c1e3STobin C. Harding 12af96c1e3STobin C. Harding 13af96c1e3STobin C. HardingIntroduction 14af96c1e3STobin C. Harding============ 15af96c1e3STobin C. Harding 16af96c1e3STobin C. HardingThe Virtual File System (also known as the Virtual Filesystem Switch) is 17af96c1e3STobin C. Hardingthe software layer in the kernel that provides the filesystem interface 18af96c1e3STobin C. Hardingto userspace programs. It also provides an abstraction within the 19af96c1e3STobin C. Hardingkernel which allows different filesystem implementations to coexist. 20af96c1e3STobin C. Harding 21af96c1e3STobin C. HardingVFS system calls open(2), stat(2), read(2), write(2), chmod(2) and so on 22af96c1e3STobin C. Hardingare called from a process context. Filesystem locking is described in 23ec23eb54SMauro Carvalho Chehabthe document Documentation/filesystems/locking.rst. 24af96c1e3STobin C. Harding 25af96c1e3STobin C. Harding 26af96c1e3STobin C. HardingDirectory Entry Cache (dcache) 27af96c1e3STobin C. Harding------------------------------ 28af96c1e3STobin C. Harding 29af96c1e3STobin C. HardingThe VFS implements the open(2), stat(2), chmod(2), and similar system 30af96c1e3STobin C. Hardingcalls. The pathname argument that is passed to them is used by the VFS 31af96c1e3STobin C. Hardingto search through the directory entry cache (also known as the dentry 32af96c1e3STobin C. Hardingcache or dcache). This provides a very fast look-up mechanism to 33af96c1e3STobin C. Hardingtranslate a pathname (filename) into a specific dentry. Dentries live 34af96c1e3STobin C. Hardingin RAM and are never saved to disc: they exist only for performance. 35af96c1e3STobin C. Harding 36af96c1e3STobin C. HardingThe dentry cache is meant to be a view into your entire filespace. As 37af96c1e3STobin C. Hardingmost computers cannot fit all dentries in the RAM at the same time, some 38af96c1e3STobin C. Hardingbits of the cache are missing. In order to resolve your pathname into a 39af96c1e3STobin C. Hardingdentry, the VFS may have to resort to creating dentries along the way, 40af96c1e3STobin C. Hardingand then loading the inode. This is done by looking up the inode. 41af96c1e3STobin C. Harding 42af96c1e3STobin C. Harding 43af96c1e3STobin C. HardingThe Inode Object 44af96c1e3STobin C. Harding---------------- 45af96c1e3STobin C. Harding 46af96c1e3STobin C. HardingAn individual dentry usually has a pointer to an inode. Inodes are 47af96c1e3STobin C. Hardingfilesystem objects such as regular files, directories, FIFOs and other 48af96c1e3STobin C. Hardingbeasts. They live either on the disc (for block device filesystems) or 49af96c1e3STobin C. Hardingin the memory (for pseudo filesystems). Inodes that live on the disc 50af96c1e3STobin C. Hardingare copied into the memory when required and changes to the inode are 51af96c1e3STobin C. Hardingwritten back to disc. A single inode can be pointed to by multiple 52af96c1e3STobin C. Hardingdentries (hard links, for example, do this). 53af96c1e3STobin C. Harding 54af96c1e3STobin C. HardingTo look up an inode requires that the VFS calls the lookup() method of 55af96c1e3STobin C. Hardingthe parent directory inode. This method is installed by the specific 56af96c1e3STobin C. Hardingfilesystem implementation that the inode lives in. Once the VFS has the 57af96c1e3STobin C. Hardingrequired dentry (and hence the inode), we can do all those boring things 58af96c1e3STobin C. Hardinglike open(2) the file, or stat(2) it to peek at the inode data. The 59af96c1e3STobin C. Hardingstat(2) operation is fairly simple: once the VFS has the dentry, it 60af96c1e3STobin C. Hardingpeeks at the inode data and passes some of it back to userspace. 61af96c1e3STobin C. Harding 62af96c1e3STobin C. Harding 63af96c1e3STobin C. HardingThe File Object 64af96c1e3STobin C. Harding--------------- 65af96c1e3STobin C. Harding 66af96c1e3STobin C. HardingOpening a file requires another operation: allocation of a file 67af96c1e3STobin C. Hardingstructure (this is the kernel-side implementation of file descriptors). 68af96c1e3STobin C. HardingThe freshly allocated file structure is initialized with a pointer to 69af96c1e3STobin C. Hardingthe dentry and a set of file operation member functions. These are 70af96c1e3STobin C. Hardingtaken from the inode data. The open() file method is then called so the 71af96c1e3STobin C. Hardingspecific filesystem implementation can do its work. You can see that 72af96c1e3STobin C. Hardingthis is another switch performed by the VFS. The file structure is 73af96c1e3STobin C. Hardingplaced into the file descriptor table for the process. 74af96c1e3STobin C. Harding 75af96c1e3STobin C. HardingReading, writing and closing files (and other assorted VFS operations) 76af96c1e3STobin C. Hardingis done by using the userspace file descriptor to grab the appropriate 77af96c1e3STobin C. Hardingfile structure, and then calling the required file structure method to 78af96c1e3STobin C. Hardingdo whatever is required. For as long as the file is open, it keeps the 79af96c1e3STobin C. Hardingdentry in use, which in turn means that the VFS inode is still in use. 80af96c1e3STobin C. Harding 81af96c1e3STobin C. Harding 82af96c1e3STobin C. HardingRegistering and Mounting a Filesystem 83af96c1e3STobin C. Harding===================================== 84af96c1e3STobin C. Harding 85af96c1e3STobin C. HardingTo register and unregister a filesystem, use the following API 86af96c1e3STobin C. Hardingfunctions: 87af96c1e3STobin C. Harding 88af96c1e3STobin C. Harding.. code-block:: c 89af96c1e3STobin C. Harding 90af96c1e3STobin C. Harding #include <linux/fs.h> 91af96c1e3STobin C. Harding 92af96c1e3STobin C. Harding extern int register_filesystem(struct file_system_type *); 93af96c1e3STobin C. Harding extern int unregister_filesystem(struct file_system_type *); 94af96c1e3STobin C. Harding 95af96c1e3STobin C. HardingThe passed struct file_system_type describes your filesystem. When a 96af96c1e3STobin C. Hardingrequest is made to mount a filesystem onto a directory in your 97af96c1e3STobin C. Hardingnamespace, the VFS will call the appropriate mount() method for the 98af96c1e3STobin C. Hardingspecific filesystem. New vfsmount referring to the tree returned by 99af96c1e3STobin C. Harding->mount() will be attached to the mountpoint, so that when pathname 100af96c1e3STobin C. Hardingresolution reaches the mountpoint it will jump into the root of that 101af96c1e3STobin C. Hardingvfsmount. 102af96c1e3STobin C. Harding 103af96c1e3STobin C. HardingYou can see all filesystems that are registered to the kernel in the 104af96c1e3STobin C. Hardingfile /proc/filesystems. 105af96c1e3STobin C. Harding 106af96c1e3STobin C. Harding 107af96c1e3STobin C. Hardingstruct file_system_type 108af96c1e3STobin C. Harding----------------------- 109af96c1e3STobin C. Harding 110*85bf9a0eSAlexander MikhalitsynThis describes the filesystem. The following 111af96c1e3STobin C. Hardingmembers are defined: 112af96c1e3STobin C. Harding 113af96c1e3STobin C. Harding.. code-block:: c 114af96c1e3STobin C. Harding 1156a2195a1SLiao Pingfang struct file_system_type { 116af96c1e3STobin C. Harding const char *name; 117af96c1e3STobin C. Harding int fs_flags; 118*85bf9a0eSAlexander Mikhalitsyn int (*init_fs_context)(struct fs_context *); 119*85bf9a0eSAlexander Mikhalitsyn const struct fs_parameter_spec *parameters; 120af96c1e3STobin C. Harding struct dentry *(*mount) (struct file_system_type *, int, 121af96c1e3STobin C. Harding const char *, void *); 122af96c1e3STobin C. Harding void (*kill_sb) (struct super_block *); 123af96c1e3STobin C. Harding struct module *owner; 124af96c1e3STobin C. Harding struct file_system_type * next; 125*85bf9a0eSAlexander Mikhalitsyn struct hlist_head fs_supers; 126*85bf9a0eSAlexander Mikhalitsyn 127af96c1e3STobin C. Harding struct lock_class_key s_lock_key; 128af96c1e3STobin C. Harding struct lock_class_key s_umount_key; 129*85bf9a0eSAlexander Mikhalitsyn struct lock_class_key s_vfs_rename_key; 130*85bf9a0eSAlexander Mikhalitsyn struct lock_class_key s_writers_key[SB_FREEZE_LEVELS]; 131*85bf9a0eSAlexander Mikhalitsyn 132*85bf9a0eSAlexander Mikhalitsyn struct lock_class_key i_lock_key; 133*85bf9a0eSAlexander Mikhalitsyn struct lock_class_key i_mutex_key; 134*85bf9a0eSAlexander Mikhalitsyn struct lock_class_key invalidate_lock_key; 135*85bf9a0eSAlexander Mikhalitsyn struct lock_class_key i_mutex_dir_key; 136af96c1e3STobin C. Harding }; 137af96c1e3STobin C. Harding 138ee5dc049STobin C. Harding``name`` 139ee5dc049STobin C. Harding the name of the filesystem type, such as "ext2", "iso9660", 140af96c1e3STobin C. Harding "msdos" and so on 141af96c1e3STobin C. Harding 142ee5dc049STobin C. Harding``fs_flags`` 143ee5dc049STobin C. Harding various flags (i.e. FS_REQUIRES_DEV, FS_NO_DCACHE, etc.) 144af96c1e3STobin C. Harding 145*85bf9a0eSAlexander Mikhalitsyn``init_fs_context`` 146*85bf9a0eSAlexander Mikhalitsyn Initializes 'struct fs_context' ->ops and ->fs_private fields with 147*85bf9a0eSAlexander Mikhalitsyn filesystem-specific data. 148*85bf9a0eSAlexander Mikhalitsyn 149*85bf9a0eSAlexander Mikhalitsyn``parameters`` 150*85bf9a0eSAlexander Mikhalitsyn Pointer to the array of filesystem parameters descriptors 151*85bf9a0eSAlexander Mikhalitsyn 'struct fs_parameter_spec'. 152*85bf9a0eSAlexander Mikhalitsyn More info in Documentation/filesystems/mount_api.rst. 153*85bf9a0eSAlexander Mikhalitsyn 154ee5dc049STobin C. Harding``mount`` 155ee5dc049STobin C. Harding the method to call when a new instance of this filesystem should 156af96c1e3STobin C. Harding be mounted 157af96c1e3STobin C. Harding 158ee5dc049STobin C. Harding``kill_sb`` 159ee5dc049STobin C. Harding the method to call when an instance of this filesystem should be 160ee5dc049STobin C. Harding shut down 161af96c1e3STobin C. Harding 162af96c1e3STobin C. Harding 163ee5dc049STobin C. Harding``owner`` 164ee5dc049STobin C. Harding for internal VFS use: you should initialize this to THIS_MODULE 165ee5dc049STobin C. Harding in most cases. 166ee5dc049STobin C. Harding 167ee5dc049STobin C. Harding``next`` 168ee5dc049STobin C. Harding for internal VFS use: you should initialize this to NULL 169af96c1e3STobin C. Harding 170*85bf9a0eSAlexander Mikhalitsyn``fs_supers`` 171*85bf9a0eSAlexander Mikhalitsyn for internal VFS use: hlist of filesystem instances (superblocks) 172*85bf9a0eSAlexander Mikhalitsyn 173*85bf9a0eSAlexander Mikhalitsyn s_lock_key, s_umount_key, s_vfs_rename_key, s_writers_key, 174*85bf9a0eSAlexander Mikhalitsyn i_lock_key, i_mutex_key, invalidate_lock_key, i_mutex_dir_key: lockdep-specific 175af96c1e3STobin C. Harding 176af96c1e3STobin C. HardingThe mount() method has the following arguments: 177af96c1e3STobin C. Harding 178ee5dc049STobin C. Harding``struct file_system_type *fs_type`` 179ee5dc049STobin C. Harding describes the filesystem, partly initialized by the specific 180ee5dc049STobin C. Harding filesystem code 181af96c1e3STobin C. Harding 182ee5dc049STobin C. Harding``int flags`` 183ee5dc049STobin C. Harding mount flags 184af96c1e3STobin C. Harding 185ee5dc049STobin C. Harding``const char *dev_name`` 186ee5dc049STobin C. Harding the device name we are mounting. 187af96c1e3STobin C. Harding 188ee5dc049STobin C. Harding``void *data`` 189ee5dc049STobin C. Harding arbitrary mount options, usually comes as an ASCII string (see 190ee5dc049STobin C. Harding "Mount Options" section) 191af96c1e3STobin C. Harding 192af96c1e3STobin C. HardingThe mount() method must return the root dentry of the tree requested by 193af96c1e3STobin C. Hardingcaller. An active reference to its superblock must be grabbed and the 194af96c1e3STobin C. Hardingsuperblock must be locked. On failure it should return ERR_PTR(error). 195af96c1e3STobin C. Harding 196af96c1e3STobin C. HardingThe arguments match those of mount(2) and their interpretation depends 197af96c1e3STobin C. Hardingon filesystem type. E.g. for block filesystems, dev_name is interpreted 198af96c1e3STobin C. Hardingas block device name, that device is opened and if it contains a 199af96c1e3STobin C. Hardingsuitable filesystem image the method creates and initializes struct 200af96c1e3STobin C. Hardingsuper_block accordingly, returning its root dentry to caller. 201af96c1e3STobin C. Harding 202af96c1e3STobin C. Harding->mount() may choose to return a subtree of existing filesystem - it 203af96c1e3STobin C. Hardingdoesn't have to create a new one. The main result from the caller's 204af96c1e3STobin C. Hardingpoint of view is a reference to dentry at the root of (sub)tree to be 205af96c1e3STobin C. Hardingattached; creation of new superblock is a common side effect. 206af96c1e3STobin C. Harding 207af96c1e3STobin C. HardingThe most interesting member of the superblock structure that the mount() 208af96c1e3STobin C. Hardingmethod fills in is the "s_op" field. This is a pointer to a "struct 209af96c1e3STobin C. Hardingsuper_operations" which describes the next level of the filesystem 210af96c1e3STobin C. Hardingimplementation. 211af96c1e3STobin C. Harding 212af96c1e3STobin C. HardingUsually, a filesystem uses one of the generic mount() implementations 213af96c1e3STobin C. Hardingand provides a fill_super() callback instead. The generic variants are: 214af96c1e3STobin C. Harding 215ee5dc049STobin C. Harding``mount_bdev`` 216ee5dc049STobin C. Harding mount a filesystem residing on a block device 217af96c1e3STobin C. Harding 218ee5dc049STobin C. Harding``mount_nodev`` 219ee5dc049STobin C. Harding mount a filesystem that is not backed by a device 220af96c1e3STobin C. Harding 221ee5dc049STobin C. Harding``mount_single`` 222ee5dc049STobin C. Harding mount a filesystem which shares the instance between all mounts 223af96c1e3STobin C. Harding 224af96c1e3STobin C. HardingA fill_super() callback implementation has the following arguments: 225af96c1e3STobin C. Harding 226ee5dc049STobin C. Harding``struct super_block *sb`` 227ee5dc049STobin C. Harding the superblock structure. The callback must initialize this 228ee5dc049STobin C. Harding properly. 229af96c1e3STobin C. Harding 230ee5dc049STobin C. Harding``void *data`` 231ee5dc049STobin C. Harding arbitrary mount options, usually comes as an ASCII string (see 232ee5dc049STobin C. Harding "Mount Options" section) 233af96c1e3STobin C. Harding 234ee5dc049STobin C. Harding``int silent`` 235ee5dc049STobin C. Harding whether or not to be silent on error 236af96c1e3STobin C. Harding 237af96c1e3STobin C. Harding 238af96c1e3STobin C. HardingThe Superblock Object 239af96c1e3STobin C. Harding===================== 240af96c1e3STobin C. Harding 241af96c1e3STobin C. HardingA superblock object represents a mounted filesystem. 242af96c1e3STobin C. Harding 243af96c1e3STobin C. Harding 244af96c1e3STobin C. Hardingstruct super_operations 245af96c1e3STobin C. Harding----------------------- 246af96c1e3STobin C. Harding 247af96c1e3STobin C. HardingThis describes how the VFS can manipulate the superblock of your 248af96c1e3STobin C. Hardingfilesystem. As of kernel 2.6.22, the following members are defined: 249af96c1e3STobin C. Harding 250af96c1e3STobin C. Harding.. code-block:: c 251af96c1e3STobin C. Harding 252af96c1e3STobin C. Harding struct super_operations { 253af96c1e3STobin C. Harding struct inode *(*alloc_inode)(struct super_block *sb); 254af96c1e3STobin C. Harding void (*destroy_inode)(struct inode *); 255af96c1e3STobin C. Harding 256af96c1e3STobin C. Harding void (*dirty_inode) (struct inode *, int flags); 257af96c1e3STobin C. Harding int (*write_inode) (struct inode *, int); 258af96c1e3STobin C. Harding void (*drop_inode) (struct inode *); 259af96c1e3STobin C. Harding void (*delete_inode) (struct inode *); 260af96c1e3STobin C. Harding void (*put_super) (struct super_block *); 261af96c1e3STobin C. Harding int (*sync_fs)(struct super_block *sb, int wait); 262af96c1e3STobin C. Harding int (*freeze_fs) (struct super_block *); 263af96c1e3STobin C. Harding int (*unfreeze_fs) (struct super_block *); 264af96c1e3STobin C. Harding int (*statfs) (struct dentry *, struct kstatfs *); 265af96c1e3STobin C. Harding int (*remount_fs) (struct super_block *, int *, char *); 266af96c1e3STobin C. Harding void (*clear_inode) (struct inode *); 267af96c1e3STobin C. Harding void (*umount_begin) (struct super_block *); 268af96c1e3STobin C. Harding 269af96c1e3STobin C. Harding int (*show_options)(struct seq_file *, struct dentry *); 270af96c1e3STobin C. Harding 271af96c1e3STobin C. Harding ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t); 272af96c1e3STobin C. Harding ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t); 273af96c1e3STobin C. Harding int (*nr_cached_objects)(struct super_block *); 274af96c1e3STobin C. Harding void (*free_cached_objects)(struct super_block *, int); 275af96c1e3STobin C. Harding }; 276af96c1e3STobin C. Harding 277af96c1e3STobin C. HardingAll methods are called without any locks being held, unless otherwise 278af96c1e3STobin C. Hardingnoted. This means that most methods can block safely. All methods are 279af96c1e3STobin C. Hardingonly called from a process context (i.e. not from an interrupt handler 280af96c1e3STobin C. Hardingor bottom half). 281af96c1e3STobin C. Harding 282ee5dc049STobin C. Harding``alloc_inode`` 283ee5dc049STobin C. Harding this method is called by alloc_inode() to allocate memory for 284ee5dc049STobin C. Harding struct inode and initialize it. If this function is not 285af96c1e3STobin C. Harding defined, a simple 'struct inode' is allocated. Normally 286af96c1e3STobin C. Harding alloc_inode will be used to allocate a larger structure which 287af96c1e3STobin C. Harding contains a 'struct inode' embedded within it. 288af96c1e3STobin C. Harding 289ee5dc049STobin C. Harding``destroy_inode`` 290ee5dc049STobin C. Harding this method is called by destroy_inode() to release resources 291ee5dc049STobin C. Harding allocated for struct inode. It is only required if 292af96c1e3STobin C. Harding ->alloc_inode was defined and simply undoes anything done by 293af96c1e3STobin C. Harding ->alloc_inode. 294af96c1e3STobin C. Harding 295ee5dc049STobin C. Harding``dirty_inode`` 296a38ed483SEric Biggers this method is called by the VFS when an inode is marked dirty. 297a38ed483SEric Biggers This is specifically for the inode itself being marked dirty, 298a38ed483SEric Biggers not its data. If the update needs to be persisted by fdatasync(), 299a38ed483SEric Biggers then I_DIRTY_DATASYNC will be set in the flags argument. 300cbfecb92SLukas Czerner I_DIRTY_TIME will be set in the flags in case lazytime is enabled 301cbfecb92SLukas Czerner and struct inode has times updated since the last ->dirty_inode 302cbfecb92SLukas Czerner call. 303af96c1e3STobin C. Harding 304ee5dc049STobin C. Harding``write_inode`` 305ee5dc049STobin C. Harding this method is called when the VFS needs to write an inode to 306ee5dc049STobin C. Harding disc. The second parameter indicates whether the write should 307ee5dc049STobin C. Harding be synchronous or not, not all filesystems check this flag. 308af96c1e3STobin C. Harding 309ee5dc049STobin C. Harding``drop_inode`` 310ee5dc049STobin C. Harding called when the last access to the inode is dropped, with the 311ee5dc049STobin C. Harding inode->i_lock spinlock held. 312af96c1e3STobin C. Harding 313af96c1e3STobin C. Harding This method should be either NULL (normal UNIX filesystem 314ee5dc049STobin C. Harding semantics) or "generic_delete_inode" (for filesystems that do 315ee5dc049STobin C. Harding not want to cache inodes - causing "delete_inode" to always be 316af96c1e3STobin C. Harding called regardless of the value of i_nlink) 317af96c1e3STobin C. Harding 318ee5dc049STobin C. Harding The "generic_delete_inode()" behavior is equivalent to the old 319ee5dc049STobin C. Harding practice of using "force_delete" in the put_inode() case, but 320ee5dc049STobin C. Harding does not have the races that the "force_delete()" approach had. 321af96c1e3STobin C. Harding 322ee5dc049STobin C. Harding``delete_inode`` 323ee5dc049STobin C. Harding called when the VFS wants to delete an inode 324af96c1e3STobin C. Harding 325ee5dc049STobin C. Harding``put_super`` 326ee5dc049STobin C. Harding called when the VFS wishes to free the superblock 327af96c1e3STobin C. Harding (i.e. unmount). This is called with the superblock lock held 328af96c1e3STobin C. Harding 329ee5dc049STobin C. Harding``sync_fs`` 330ee5dc049STobin C. Harding called when VFS is writing out all dirty data associated with a 331ee5dc049STobin C. Harding superblock. The second parameter indicates whether the method 332af96c1e3STobin C. Harding should wait until the write out has been completed. Optional. 333af96c1e3STobin C. Harding 334ee5dc049STobin C. Harding``freeze_fs`` 335ee5dc049STobin C. Harding called when VFS is locking a filesystem and forcing it into a 336ee5dc049STobin C. Harding consistent state. This method is currently used by the Logical 337ee5dc049STobin C. Harding Volume Manager (LVM). 338af96c1e3STobin C. Harding 339ee5dc049STobin C. Harding``unfreeze_fs`` 340ee5dc049STobin C. Harding called when VFS is unlocking a filesystem and making it writable 341af96c1e3STobin C. Harding again. 342af96c1e3STobin C. Harding 343ee5dc049STobin C. Harding``statfs`` 344ee5dc049STobin C. Harding called when the VFS needs to get filesystem statistics. 345af96c1e3STobin C. Harding 346ee5dc049STobin C. Harding``remount_fs`` 347ee5dc049STobin C. Harding called when the filesystem is remounted. This is called with 348ee5dc049STobin C. Harding the kernel lock held 349af96c1e3STobin C. Harding 350ee5dc049STobin C. Harding``clear_inode`` 351ee5dc049STobin C. Harding called then the VFS clears the inode. Optional 352af96c1e3STobin C. Harding 353ee5dc049STobin C. Harding``umount_begin`` 354ee5dc049STobin C. Harding called when the VFS is unmounting a filesystem. 355af96c1e3STobin C. Harding 356ee5dc049STobin C. Harding``show_options`` 357ee5dc049STobin C. Harding called by the VFS to show mount options for /proc/<pid>/mounts. 358ee5dc049STobin C. Harding (see "Mount Options" section) 359af96c1e3STobin C. Harding 360ee5dc049STobin C. Harding``quota_read`` 361ee5dc049STobin C. Harding called by the VFS to read from filesystem quota file. 362af96c1e3STobin C. Harding 363ee5dc049STobin C. Harding``quota_write`` 364ee5dc049STobin C. Harding called by the VFS to write to filesystem quota file. 365af96c1e3STobin C. Harding 366ee5dc049STobin C. Harding``nr_cached_objects`` 367ee5dc049STobin C. Harding called by the sb cache shrinking function for the filesystem to 368ee5dc049STobin C. Harding return the number of freeable cached objects it contains. 369af96c1e3STobin C. Harding Optional. 370af96c1e3STobin C. Harding 371ee5dc049STobin C. Harding``free_cache_objects`` 372ee5dc049STobin C. Harding called by the sb cache shrinking function for the filesystem to 373ee5dc049STobin C. Harding scan the number of objects indicated to try to free them. 374ee5dc049STobin C. Harding Optional, but any filesystem implementing this method needs to 375ee5dc049STobin C. Harding also implement ->nr_cached_objects for it to be called 376ee5dc049STobin C. Harding correctly. 377af96c1e3STobin C. Harding 378af96c1e3STobin C. Harding We can't do anything with any errors that the filesystem might 379ee5dc049STobin C. Harding encountered, hence the void return type. This will never be 380ee5dc049STobin C. Harding called if the VM is trying to reclaim under GFP_NOFS conditions, 381ee5dc049STobin C. Harding hence this method does not need to handle that situation itself. 382af96c1e3STobin C. Harding 383ee5dc049STobin C. Harding Implementations must include conditional reschedule calls inside 384ee5dc049STobin C. Harding any scanning loop that is done. This allows the VFS to 385ee5dc049STobin C. Harding determine appropriate scan batch sizes without having to worry 386ee5dc049STobin C. Harding about whether implementations will cause holdoff problems due to 387ee5dc049STobin C. Harding large scan batch sizes. 388af96c1e3STobin C. Harding 389af96c1e3STobin C. HardingWhoever sets up the inode is responsible for filling in the "i_op" 390af96c1e3STobin C. Hardingfield. This is a pointer to a "struct inode_operations" which describes 391af96c1e3STobin C. Hardingthe methods that can be performed on individual inodes. 392af96c1e3STobin C. Harding 393af96c1e3STobin C. Harding 394af96c1e3STobin C. Hardingstruct xattr_handlers 395af96c1e3STobin C. Harding--------------------- 396af96c1e3STobin C. Harding 397af96c1e3STobin C. HardingOn filesystems that support extended attributes (xattrs), the s_xattr 398af96c1e3STobin C. Hardingsuperblock field points to a NULL-terminated array of xattr handlers. 399af96c1e3STobin C. HardingExtended attributes are name:value pairs. 400af96c1e3STobin C. Harding 401ee5dc049STobin C. Harding``name`` 402ee5dc049STobin C. Harding Indicates that the handler matches attributes with the specified 403ee5dc049STobin C. Harding name (such as "system.posix_acl_access"); the prefix field must 404ee5dc049STobin C. Harding be NULL. 405af96c1e3STobin C. Harding 406ee5dc049STobin C. Harding``prefix`` 407ee5dc049STobin C. Harding Indicates that the handler matches all attributes with the 408ee5dc049STobin C. Harding specified name prefix (such as "user."); the name field must be 409ee5dc049STobin C. Harding NULL. 410af96c1e3STobin C. Harding 411ee5dc049STobin C. Harding``list`` 412ee5dc049STobin C. Harding Determine if attributes matching this xattr handler should be 413ee5dc049STobin C. Harding listed for a particular dentry. Used by some listxattr 414ee5dc049STobin C. Harding implementations like generic_listxattr. 415af96c1e3STobin C. Harding 416ee5dc049STobin C. Harding``get`` 417ee5dc049STobin C. Harding Called by the VFS to get the value of a particular extended 418ee5dc049STobin C. Harding attribute. This method is called by the getxattr(2) system 419ee5dc049STobin C. Harding call. 420af96c1e3STobin C. Harding 421ee5dc049STobin C. Harding``set`` 422ee5dc049STobin C. Harding Called by the VFS to set the value of a particular extended 423ee5dc049STobin C. Harding attribute. When the new value is NULL, called to remove a 4248286de7cSRandy Dunlap particular extended attribute. This method is called by the 425ee5dc049STobin C. Harding setxattr(2) and removexattr(2) system calls. 426af96c1e3STobin C. Harding 427af96c1e3STobin C. HardingWhen none of the xattr handlers of a filesystem match the specified 428af96c1e3STobin C. Hardingattribute name or when a filesystem doesn't support extended attributes, 429af96c1e3STobin C. Hardingthe various ``*xattr(2)`` system calls return -EOPNOTSUPP. 430af96c1e3STobin C. Harding 431af96c1e3STobin C. Harding 432af96c1e3STobin C. HardingThe Inode Object 433af96c1e3STobin C. Harding================ 434af96c1e3STobin C. Harding 435af96c1e3STobin C. HardingAn inode object represents an object within the filesystem. 436af96c1e3STobin C. Harding 437af96c1e3STobin C. Harding 438af96c1e3STobin C. Hardingstruct inode_operations 439af96c1e3STobin C. Harding----------------------- 440af96c1e3STobin C. Harding 441af96c1e3STobin C. HardingThis describes how the VFS can manipulate an inode in your filesystem. 442af96c1e3STobin C. HardingAs of kernel 2.6.22, the following members are defined: 443af96c1e3STobin C. Harding 444af96c1e3STobin C. Harding.. code-block:: c 445af96c1e3STobin C. Harding 446af96c1e3STobin C. Harding struct inode_operations { 4476c960e68SChristian Brauner int (*create) (struct mnt_idmap *, struct inode *,struct dentry *, umode_t, bool); 448af96c1e3STobin C. Harding struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int); 449af96c1e3STobin C. Harding int (*link) (struct dentry *,struct inode *,struct dentry *); 450af96c1e3STobin C. Harding int (*unlink) (struct inode *,struct dentry *); 4517a77db95SChristian Brauner int (*symlink) (struct mnt_idmap *, struct inode *,struct dentry *,const char *); 452c54bd91eSChristian Brauner int (*mkdir) (struct mnt_idmap *, struct inode *,struct dentry *,umode_t); 453af96c1e3STobin C. Harding int (*rmdir) (struct inode *,struct dentry *); 4545ebb29beSChristian Brauner int (*mknod) (struct mnt_idmap *, struct inode *,struct dentry *,umode_t,dev_t); 455e18275aeSChristian Brauner int (*rename) (struct mnt_idmap *, struct inode *, struct dentry *, 456af96c1e3STobin C. Harding struct inode *, struct dentry *, unsigned int); 457af96c1e3STobin C. Harding int (*readlink) (struct dentry *, char __user *,int); 458af96c1e3STobin C. Harding const char *(*get_link) (struct dentry *, struct inode *, 459af96c1e3STobin C. Harding struct delayed_call *); 4604609e1f1SChristian Brauner int (*permission) (struct mnt_idmap *, struct inode *, int); 461cac2f8b8SChristian Brauner struct posix_acl * (*get_inode_acl)(struct inode *, int, bool); 462c1632a0fSChristian Brauner int (*setattr) (struct mnt_idmap *, struct dentry *, struct iattr *); 463b74d24f7SChristian Brauner int (*getattr) (struct mnt_idmap *, const struct path *, struct kstat *, u32, unsigned int); 464af96c1e3STobin C. Harding ssize_t (*listxattr) (struct dentry *, char *, size_t); 465af96c1e3STobin C. Harding void (*update_time)(struct inode *, struct timespec *, int); 466af96c1e3STobin C. Harding int (*atomic_open)(struct inode *, struct dentry *, struct file *, 467af96c1e3STobin C. Harding unsigned open_flag, umode_t create_mode); 468011e2b71SChristian Brauner int (*tmpfile) (struct mnt_idmap *, struct inode *, struct file *, umode_t); 46977435322SChristian Brauner struct posix_acl * (*get_acl)(struct mnt_idmap *, struct dentry *, int); 47013e83a49SChristian Brauner int (*set_acl)(struct mnt_idmap *, struct dentry *, struct posix_acl *, int); 4718782a9aeSChristian Brauner int (*fileattr_set)(struct mnt_idmap *idmap, 4724c5b4799SMiklos Szeredi struct dentry *dentry, struct fileattr *fa); 4734c5b4799SMiklos Szeredi int (*fileattr_get)(struct dentry *dentry, struct fileattr *fa); 474af96c1e3STobin C. Harding }; 475af96c1e3STobin C. Harding 476af96c1e3STobin C. HardingAgain, all methods are called without any locks being held, unless 477af96c1e3STobin C. Hardingotherwise noted. 478af96c1e3STobin C. Harding 479ee5dc049STobin C. Harding``create`` 480ee5dc049STobin C. Harding called by the open(2) and creat(2) system calls. Only required 481ee5dc049STobin C. Harding if you want to support regular files. The dentry you get should 482ee5dc049STobin C. Harding not have an inode (i.e. it should be a negative dentry). Here 483ee5dc049STobin C. Harding you will probably call d_instantiate() with the dentry and the 484ee5dc049STobin C. Harding newly created inode 485af96c1e3STobin C. Harding 486ee5dc049STobin C. Harding``lookup`` 487ee5dc049STobin C. Harding called when the VFS needs to look up an inode in a parent 488af96c1e3STobin C. Harding directory. The name to look for is found in the dentry. This 489af96c1e3STobin C. Harding method must call d_add() to insert the found inode into the 490af96c1e3STobin C. Harding dentry. The "i_count" field in the inode structure should be 491af96c1e3STobin C. Harding incremented. If the named inode does not exist a NULL inode 492af96c1e3STobin C. Harding should be inserted into the dentry (this is called a negative 493ee5dc049STobin C. Harding dentry). Returning an error code from this routine must only be 494ee5dc049STobin C. Harding done on a real error, otherwise creating inodes with system 495af96c1e3STobin C. Harding calls like create(2), mknod(2), mkdir(2) and so on will fail. 496af96c1e3STobin C. Harding If you wish to overload the dentry methods then you should 497ee5dc049STobin C. Harding initialise the "d_dop" field in the dentry; this is a pointer to 498ee5dc049STobin C. Harding a struct "dentry_operations". This method is called with the 499ee5dc049STobin C. Harding directory inode semaphore held 500af96c1e3STobin C. Harding 501ee5dc049STobin C. Harding``link`` 502ee5dc049STobin C. Harding called by the link(2) system call. Only required if you want to 503ee5dc049STobin C. Harding support hard links. You will probably need to call 504af96c1e3STobin C. Harding d_instantiate() just as you would in the create() method 505af96c1e3STobin C. Harding 506ee5dc049STobin C. Harding``unlink`` 507ee5dc049STobin C. Harding called by the unlink(2) system call. Only required if you want 508ee5dc049STobin C. Harding to support deleting inodes 509af96c1e3STobin C. Harding 510ee5dc049STobin C. Harding``symlink`` 511ee5dc049STobin C. Harding called by the symlink(2) system call. Only required if you want 512ee5dc049STobin C. Harding to support symlinks. You will probably need to call 513af96c1e3STobin C. Harding d_instantiate() just as you would in the create() method 514af96c1e3STobin C. Harding 515ee5dc049STobin C. Harding``mkdir`` 516ee5dc049STobin C. Harding called by the mkdir(2) system call. Only required if you want 517af96c1e3STobin C. Harding to support creating subdirectories. You will probably need to 518af96c1e3STobin C. Harding call d_instantiate() just as you would in the create() method 519af96c1e3STobin C. Harding 520ee5dc049STobin C. Harding``rmdir`` 521ee5dc049STobin C. Harding called by the rmdir(2) system call. Only required if you want 522af96c1e3STobin C. Harding to support deleting subdirectories 523af96c1e3STobin C. Harding 524ee5dc049STobin C. Harding``mknod`` 525ee5dc049STobin C. Harding called by the mknod(2) system call to create a device (char, 526ee5dc049STobin C. Harding block) inode or a named pipe (FIFO) or socket. Only required if 527ee5dc049STobin C. Harding you want to support creating these types of inodes. You will 528ee5dc049STobin C. Harding probably need to call d_instantiate() just as you would in the 529ee5dc049STobin C. Harding create() method 530af96c1e3STobin C. Harding 531ee5dc049STobin C. Harding``rename`` 532ee5dc049STobin C. Harding called by the rename(2) system call to rename the object to have 533ee5dc049STobin C. Harding the parent and name given by the second inode and dentry. 534af96c1e3STobin C. Harding 535af96c1e3STobin C. Harding The filesystem must return -EINVAL for any unsupported or 536af96c1e3STobin C. Harding unknown flags. Currently the following flags are implemented: 537ee5dc049STobin C. Harding (1) RENAME_NOREPLACE: this flag indicates that if the target of 538ee5dc049STobin C. Harding the rename exists the rename should fail with -EEXIST instead of 539ee5dc049STobin C. Harding replacing the target. The VFS already checks for existence, so 540ee5dc049STobin C. Harding for local filesystems the RENAME_NOREPLACE implementation is 541ee5dc049STobin C. Harding equivalent to plain rename. 542af96c1e3STobin C. Harding (2) RENAME_EXCHANGE: exchange source and target. Both must 543ee5dc049STobin C. Harding exist; this is checked by the VFS. Unlike plain rename, source 544ee5dc049STobin C. Harding and target may be of different type. 545af96c1e3STobin C. Harding 546ee5dc049STobin C. Harding``get_link`` 547ee5dc049STobin C. Harding called by the VFS to follow a symbolic link to the inode it 548ee5dc049STobin C. Harding points to. Only required if you want to support symbolic links. 549ee5dc049STobin C. Harding This method returns the symlink body to traverse (and possibly 550ee5dc049STobin C. Harding resets the current position with nd_jump_link()). If the body 551ee5dc049STobin C. Harding won't go away until the inode is gone, nothing else is needed; 552ee5dc049STobin C. Harding if it needs to be otherwise pinned, arrange for its release by 553ee5dc049STobin C. Harding having get_link(..., ..., done) do set_delayed_call(done, 554ee5dc049STobin C. Harding destructor, argument). In that case destructor(argument) will 555ee5dc049STobin C. Harding be called once VFS is done with the body you've returned. May 556ee5dc049STobin C. Harding be called in RCU mode; that is indicated by NULL dentry 557af96c1e3STobin C. Harding argument. If request can't be handled without leaving RCU mode, 558af96c1e3STobin C. Harding have it return ERR_PTR(-ECHILD). 559af96c1e3STobin C. Harding 560af96c1e3STobin C. Harding If the filesystem stores the symlink target in ->i_link, the 561af96c1e3STobin C. Harding VFS may use it directly without calling ->get_link(); however, 562af96c1e3STobin C. Harding ->get_link() must still be provided. ->i_link must not be 563af96c1e3STobin C. Harding freed until after an RCU grace period. Writing to ->i_link 564af96c1e3STobin C. Harding post-iget() time requires a 'release' memory barrier. 565af96c1e3STobin C. Harding 566ee5dc049STobin C. Harding``readlink`` 567ee5dc049STobin C. Harding this is now just an override for use by readlink(2) for the 568af96c1e3STobin C. Harding cases when ->get_link uses nd_jump_link() or object is not in 569af96c1e3STobin C. Harding fact a symlink. Normally filesystems should only implement 570af96c1e3STobin C. Harding ->get_link for symlinks and readlink(2) will automatically use 571af96c1e3STobin C. Harding that. 572af96c1e3STobin C. Harding 573ee5dc049STobin C. Harding``permission`` 574ee5dc049STobin C. Harding called by the VFS to check for access rights on a POSIX-like 575af96c1e3STobin C. Harding filesystem. 576af96c1e3STobin C. Harding 577ee5dc049STobin C. Harding May be called in rcu-walk mode (mask & MAY_NOT_BLOCK). If in 578ee5dc049STobin C. Harding rcu-walk mode, the filesystem must check the permission without 579ee5dc049STobin C. Harding blocking or storing to the inode. 580af96c1e3STobin C. Harding 581ee5dc049STobin C. Harding If a situation is encountered that rcu-walk cannot handle, 582ee5dc049STobin C. Harding return 583af96c1e3STobin C. Harding -ECHILD and it will be called again in ref-walk mode. 584af96c1e3STobin C. Harding 585ee5dc049STobin C. Harding``setattr`` 586ee5dc049STobin C. Harding called by the VFS to set attributes for a file. This method is 587ee5dc049STobin C. Harding called by chmod(2) and related system calls. 588af96c1e3STobin C. Harding 589ee5dc049STobin C. Harding``getattr`` 590ee5dc049STobin C. Harding called by the VFS to get attributes of a file. This method is 591ee5dc049STobin C. Harding called by stat(2) and related system calls. 592af96c1e3STobin C. Harding 593ee5dc049STobin C. Harding``listxattr`` 594ee5dc049STobin C. Harding called by the VFS to list all extended attributes for a given 595ee5dc049STobin C. Harding file. This method is called by the listxattr(2) system call. 596af96c1e3STobin C. Harding 597ee5dc049STobin C. Harding``update_time`` 598ee5dc049STobin C. Harding called by the VFS to update a specific time or the i_version of 599ee5dc049STobin C. Harding an inode. If this is not defined the VFS will update the inode 600ee5dc049STobin C. Harding itself and call mark_inode_dirty_sync. 601af96c1e3STobin C. Harding 602ee5dc049STobin C. Harding``atomic_open`` 603ee5dc049STobin C. Harding called on the last component of an open. Using this optional 604ee5dc049STobin C. Harding method the filesystem can look up, possibly create and open the 605ee5dc049STobin C. Harding file in one atomic operation. If it wants to leave actual 606ee5dc049STobin C. Harding opening to the caller (e.g. if the file turned out to be a 607ee5dc049STobin C. Harding symlink, device, or just something filesystem won't do atomic 608ee5dc049STobin C. Harding open for), it may signal this by returning finish_no_open(file, 609ee5dc049STobin C. Harding dentry). This method is only called if the last component is 610ee5dc049STobin C. Harding negative or needs lookup. Cached positive dentries are still 611ee5dc049STobin C. Harding handled by f_op->open(). If the file was created, FMODE_CREATED 612ee5dc049STobin C. Harding flag should be set in file->f_mode. In case of O_EXCL the 613ee5dc049STobin C. Harding method must only succeed if the file didn't exist and hence 614ee5dc049STobin C. Harding FMODE_CREATED shall always be set on success. 615af96c1e3STobin C. Harding 616ee5dc049STobin C. Harding``tmpfile`` 617ee5dc049STobin C. Harding called in the end of O_TMPFILE open(). Optional, equivalent to 618ee5dc049STobin C. Harding atomically creating, opening and unlinking a file in given 619863f144fSMiklos Szeredi directory. On success needs to return with the file already 620863f144fSMiklos Szeredi open; this can be done by calling finish_open_simple() right at 621863f144fSMiklos Szeredi the end. 622af96c1e3STobin C. Harding 6234c5b4799SMiklos Szeredi``fileattr_get`` 6244c5b4799SMiklos Szeredi called on ioctl(FS_IOC_GETFLAGS) and ioctl(FS_IOC_FSGETXATTR) to 6254c5b4799SMiklos Szeredi retrieve miscellaneous file flags and attributes. Also called 6264c5b4799SMiklos Szeredi before the relevant SET operation to check what is being changed 6274c5b4799SMiklos Szeredi (in this case with i_rwsem locked exclusive). If unset, then 6284c5b4799SMiklos Szeredi fall back to f_op->ioctl(). 6294c5b4799SMiklos Szeredi 6304c5b4799SMiklos Szeredi``fileattr_set`` 6314c5b4799SMiklos Szeredi called on ioctl(FS_IOC_SETFLAGS) and ioctl(FS_IOC_FSSETXATTR) to 6324c5b4799SMiklos Szeredi change miscellaneous file flags and attributes. Callers hold 6334c5b4799SMiklos Szeredi i_rwsem exclusive. If unset, then fall back to f_op->ioctl(). 6344c5b4799SMiklos Szeredi 635af96c1e3STobin C. Harding 636af96c1e3STobin C. HardingThe Address Space Object 637af96c1e3STobin C. Harding======================== 638af96c1e3STobin C. Harding 639af96c1e3STobin C. HardingThe address space object is used to group and manage pages in the page 640af96c1e3STobin C. Hardingcache. It can be used to keep track of the pages in a file (or anything 641af96c1e3STobin C. Hardingelse) and also track the mapping of sections of the file into process 642af96c1e3STobin C. Hardingaddress spaces. 643af96c1e3STobin C. Harding 644af96c1e3STobin C. HardingThere are a number of distinct yet related services that an 645af96c1e3STobin C. Hardingaddress-space can provide. These include communicating memory pressure, 646af96c1e3STobin C. Hardingpage lookup by address, and keeping track of pages tagged as Dirty or 647af96c1e3STobin C. HardingWriteback. 648af96c1e3STobin C. Harding 649af96c1e3STobin C. HardingThe first can be used independently to the others. The VM can try to 650af96c1e3STobin C. Hardingeither write dirty pages in order to clean them, or release clean pages 651af96c1e3STobin C. Hardingin order to reuse them. To do this it can call the ->writepage method 652fa29000bSMatthew Wilcox (Oracle)on dirty pages, and ->release_folio on clean folios with the private 653fa29000bSMatthew Wilcox (Oracle)flag set. Clean pages without PagePrivate and with no external references 654fa29000bSMatthew Wilcox (Oracle)will be released without notice being given to the address_space. 655af96c1e3STobin C. Harding 656af96c1e3STobin C. HardingTo achieve this functionality, pages need to be placed on an LRU with 657af96c1e3STobin C. Hardinglru_cache_add and mark_page_active needs to be called whenever the page 658af96c1e3STobin C. Hardingis used. 659af96c1e3STobin C. Harding 660af96c1e3STobin C. HardingPages are normally kept in a radix tree index by ->index. This tree 661af96c1e3STobin C. Hardingmaintains information about the PG_Dirty and PG_Writeback status of each 662af96c1e3STobin C. Hardingpage, so that pages with either of these flags can be found quickly. 663af96c1e3STobin C. Harding 664af96c1e3STobin C. HardingThe Dirty tag is primarily used by mpage_writepages - the default 665af96c1e3STobin C. Harding->writepages method. It uses the tag to find dirty pages to call 666af96c1e3STobin C. Harding->writepage on. If mpage_writepages is not used (i.e. the address 667af96c1e3STobin C. Hardingprovides its own ->writepages) , the PAGECACHE_TAG_DIRTY tag is almost 668af96c1e3STobin C. Hardingunused. write_inode_now and sync_inode do use it (through 669af96c1e3STobin C. Harding__sync_single_inode) to check if ->writepages has been successful in 670af96c1e3STobin C. Hardingwriting out the whole address_space. 671af96c1e3STobin C. Harding 672af96c1e3STobin C. HardingThe Writeback tag is used by filemap*wait* and sync_page* functions, via 673af96c1e3STobin C. Hardingfilemap_fdatawait_range, to wait for all writeback to complete. 674af96c1e3STobin C. Harding 675af96c1e3STobin C. HardingAn address_space handler may attach extra information to a page, 676af96c1e3STobin C. Hardingtypically using the 'private' field in the 'struct page'. If such 677af96c1e3STobin C. Hardinginformation is attached, the PG_Private flag should be set. This will 678af96c1e3STobin C. Hardingcause various VM routines to make extra calls into the address_space 679af96c1e3STobin C. Hardinghandler to deal with that data. 680af96c1e3STobin C. Harding 681af96c1e3STobin C. HardingAn address space acts as an intermediate between storage and 682af96c1e3STobin C. Hardingapplication. Data is read into the address space a whole page at a 683af96c1e3STobin C. Hardingtime, and provided to the application either by copying of the page, or 684af96c1e3STobin C. Hardingby memory-mapping the page. Data is written into the address space by 685af96c1e3STobin C. Hardingthe application, and then written-back to storage typically in whole 686af96c1e3STobin C. Hardingpages, however the address_space has finer control of write sizes. 687af96c1e3STobin C. Harding 68808830c8bSMatthew Wilcox (Oracle)The read process essentially only requires 'read_folio'. The write 689af96c1e3STobin C. Hardingprocess is more complicated and uses write_begin/write_end or 6906f31a5a2SMatthew Wilcox (Oracle)dirty_folio to write data into the address_space, and writepage and 691af96c1e3STobin C. Hardingwritepages to writeback data to storage. 692af96c1e3STobin C. Harding 693af96c1e3STobin C. HardingAdding and removing pages to/from an address_space is protected by the 694af96c1e3STobin C. Hardinginode's i_mutex. 695af96c1e3STobin C. Harding 696af96c1e3STobin C. HardingWhen data is written to a page, the PG_Dirty flag should be set. It 697af96c1e3STobin C. Hardingtypically remains set until writepage asks for it to be written. This 698af96c1e3STobin C. Hardingshould clear PG_Dirty and set PG_Writeback. It can be actually written 699af96c1e3STobin C. Hardingat any point after PG_Dirty is clear. Once it is known to be safe, 700af96c1e3STobin C. HardingPG_Writeback is cleared. 701af96c1e3STobin C. Harding 702af96c1e3STobin C. HardingWriteback makes use of a writeback_control structure to direct the 7038286de7cSRandy Dunlapoperations. This gives the writepage and writepages operations some 704af96c1e3STobin C. Hardinginformation about the nature of and reason for the writeback request, 705af96c1e3STobin C. Hardingand the constraints under which it is being done. It is also used to 706af96c1e3STobin C. Hardingreturn information back to the caller about the result of a writepage or 707af96c1e3STobin C. Hardingwritepages request. 708af96c1e3STobin C. Harding 709af96c1e3STobin C. Harding 710af96c1e3STobin C. HardingHandling errors during writeback 711af96c1e3STobin C. Harding-------------------------------- 712af96c1e3STobin C. Harding 713af96c1e3STobin C. HardingMost applications that do buffered I/O will periodically call a file 714af96c1e3STobin C. Hardingsynchronization call (fsync, fdatasync, msync or sync_file_range) to 715af96c1e3STobin C. Hardingensure that data written has made it to the backing store. When there 716af96c1e3STobin C. Hardingis an error during writeback, they expect that error to be reported when 717af96c1e3STobin C. Hardinga file sync request is made. After an error has been reported on one 718af96c1e3STobin C. Hardingrequest, subsequent requests on the same file descriptor should return 719af96c1e3STobin C. Harding0, unless further writeback errors have occurred since the previous file 720af96c1e3STobin C. Hardingsyncronization. 721af96c1e3STobin C. Harding 722af96c1e3STobin C. HardingIdeally, the kernel would report errors only on file descriptions on 723af96c1e3STobin C. Hardingwhich writes were done that subsequently failed to be written back. The 724af96c1e3STobin C. Hardinggeneric pagecache infrastructure does not track the file descriptions 725af96c1e3STobin C. Hardingthat have dirtied each individual page however, so determining which 726af96c1e3STobin C. Hardingfile descriptors should get back an error is not possible. 727af96c1e3STobin C. Harding 728af96c1e3STobin C. HardingInstead, the generic writeback error tracking infrastructure in the 729af96c1e3STobin C. Hardingkernel settles for reporting errors to fsync on all file descriptions 730af96c1e3STobin C. Hardingthat were open at the time that the error occurred. In a situation with 731af96c1e3STobin C. Hardingmultiple writers, all of them will get back an error on a subsequent 732af96c1e3STobin C. Hardingfsync, even if all of the writes done through that particular file 733af96c1e3STobin C. Hardingdescriptor succeeded (or even if there were no writes on that file 734af96c1e3STobin C. Hardingdescriptor at all). 735af96c1e3STobin C. Harding 736af96c1e3STobin C. HardingFilesystems that wish to use this infrastructure should call 737af96c1e3STobin C. Hardingmapping_set_error to record the error in the address_space when it 738af96c1e3STobin C. Hardingoccurs. Then, after writing back data from the pagecache in their 739af96c1e3STobin C. Hardingfile->fsync operation, they should call file_check_and_advance_wb_err to 740af96c1e3STobin C. Hardingensure that the struct file's error cursor has advanced to the correct 741af96c1e3STobin C. Hardingpoint in the stream of errors emitted by the backing device(s). 742af96c1e3STobin C. Harding 743af96c1e3STobin C. Harding 744af96c1e3STobin C. Hardingstruct address_space_operations 745af96c1e3STobin C. Harding------------------------------- 746af96c1e3STobin C. Harding 747af96c1e3STobin C. HardingThis describes how the VFS can manipulate mapping of a file to page 748af96c1e3STobin C. Hardingcache in your filesystem. The following members are defined: 749af96c1e3STobin C. Harding 750af96c1e3STobin C. Harding.. code-block:: c 751af96c1e3STobin C. Harding 752af96c1e3STobin C. Harding struct address_space_operations { 753af96c1e3STobin C. Harding int (*writepage)(struct page *page, struct writeback_control *wbc); 75408830c8bSMatthew Wilcox (Oracle) int (*read_folio)(struct file *, struct folio *); 755af96c1e3STobin C. Harding int (*writepages)(struct address_space *, struct writeback_control *); 7566f31a5a2SMatthew Wilcox (Oracle) bool (*dirty_folio)(struct address_space *, struct folio *); 7578151b4c8SMatthew Wilcox (Oracle) void (*readahead)(struct readahead_control *); 758af96c1e3STobin C. Harding int (*write_begin)(struct file *, struct address_space *mapping, 7599d6b0cd7SMatthew Wilcox (Oracle) loff_t pos, unsigned len, 760af96c1e3STobin C. Harding struct page **pagep, void **fsdata); 761af96c1e3STobin C. Harding int (*write_end)(struct file *, struct address_space *mapping, 762af96c1e3STobin C. Harding loff_t pos, unsigned len, unsigned copied, 763af96c1e3STobin C. Harding struct page *page, void *fsdata); 764af96c1e3STobin C. Harding sector_t (*bmap)(struct address_space *, sector_t); 765128d1f82SMatthew Wilcox (Oracle) void (*invalidate_folio) (struct folio *, size_t start, size_t len); 766fa29000bSMatthew Wilcox (Oracle) bool (*release_folio)(struct folio *, gfp_t); 767d2329aa0SMatthew Wilcox (Oracle) void (*free_folio)(struct folio *); 768af96c1e3STobin C. Harding ssize_t (*direct_IO)(struct kiocb *, struct iov_iter *iter); 7695490da4fSMatthew Wilcox (Oracle) int (*migrate_folio)(struct mapping *, struct folio *dst, 7705490da4fSMatthew Wilcox (Oracle) struct folio *src, enum migrate_mode); 771affa80e8SMatthew Wilcox (Oracle) int (*launder_folio) (struct folio *); 772af96c1e3STobin C. Harding 7732e7e80f7SMatthew Wilcox (Oracle) bool (*is_partially_uptodate) (struct folio *, size_t from, 7742e7e80f7SMatthew Wilcox (Oracle) size_t count); 775520f301cSMatthew Wilcox (Oracle) void (*is_dirty_writeback)(struct folio *, bool *, bool *); 776af96c1e3STobin C. Harding int (*error_remove_page) (struct mapping *mapping, struct page *page); 777cba738f6SNeilBrown int (*swap_activate)(struct swap_info_struct *sis, struct file *f, sector_t *span) 778af96c1e3STobin C. Harding int (*swap_deactivate)(struct file *); 779cba738f6SNeilBrown int (*swap_rw)(struct kiocb *iocb, struct iov_iter *iter); 780af96c1e3STobin C. Harding }; 781af96c1e3STobin C. Harding 782ee5dc049STobin C. Harding``writepage`` 783ee5dc049STobin C. Harding called by the VM to write a dirty page to backing store. This 784ee5dc049STobin C. Harding may happen for data integrity reasons (i.e. 'sync'), or to free 785ee5dc049STobin C. Harding up memory (flush). The difference can be seen in 786ee5dc049STobin C. Harding wbc->sync_mode. The PG_Dirty flag has been cleared and 787ee5dc049STobin C. Harding PageLocked is true. writepage should start writeout, should set 788ee5dc049STobin C. Harding PG_Writeback, and should make sure the page is unlocked, either 789ee5dc049STobin C. Harding synchronously or asynchronously when the write operation 790ee5dc049STobin C. Harding completes. 791af96c1e3STobin C. Harding 792af96c1e3STobin C. Harding If wbc->sync_mode is WB_SYNC_NONE, ->writepage doesn't have to 793af96c1e3STobin C. Harding try too hard if there are problems, and may choose to write out 794af96c1e3STobin C. Harding other pages from the mapping if that is easier (e.g. due to 795af96c1e3STobin C. Harding internal dependencies). If it chooses not to start writeout, it 796ee5dc049STobin C. Harding should return AOP_WRITEPAGE_ACTIVATE so that the VM will not 797ee5dc049STobin C. Harding keep calling ->writepage on that page. 798af96c1e3STobin C. Harding 799af96c1e3STobin C. Harding See the file "Locking" for more details. 800af96c1e3STobin C. Harding 80108830c8bSMatthew Wilcox (Oracle)``read_folio`` 80290c02eb9SMatthew Wilcox (Oracle) Called by the page cache to read a folio from the backing store. 80390c02eb9SMatthew Wilcox (Oracle) The 'file' argument supplies authentication information to network 80490c02eb9SMatthew Wilcox (Oracle) filesystems, and is generally not used by block based filesystems. 80590c02eb9SMatthew Wilcox (Oracle) It may be NULL if the caller does not have an open file (eg if 80690c02eb9SMatthew Wilcox (Oracle) the kernel is performing a read for itself rather than on behalf 80790c02eb9SMatthew Wilcox (Oracle) of a userspace process with an open file). 80890c02eb9SMatthew Wilcox (Oracle) 80990c02eb9SMatthew Wilcox (Oracle) If the mapping does not support large folios, the folio will 81090c02eb9SMatthew Wilcox (Oracle) contain a single page. The folio will be locked when read_folio 81190c02eb9SMatthew Wilcox (Oracle) is called. If the read completes successfully, the folio should 81290c02eb9SMatthew Wilcox (Oracle) be marked uptodate. The filesystem should unlock the folio 81390c02eb9SMatthew Wilcox (Oracle) once the read has completed, whether it was successful or not. 81490c02eb9SMatthew Wilcox (Oracle) The filesystem does not need to modify the refcount on the folio; 81590c02eb9SMatthew Wilcox (Oracle) the page cache holds a reference count and that will not be 81690c02eb9SMatthew Wilcox (Oracle) released until the folio is unlocked. 81790c02eb9SMatthew Wilcox (Oracle) 81890c02eb9SMatthew Wilcox (Oracle) Filesystems may implement ->read_folio() synchronously. 81990c02eb9SMatthew Wilcox (Oracle) In normal operation, folios are read through the ->readahead() 82090c02eb9SMatthew Wilcox (Oracle) method. Only if this fails, or if the caller needs to wait for 82190c02eb9SMatthew Wilcox (Oracle) the read to complete will the page cache call ->read_folio(). 82290c02eb9SMatthew Wilcox (Oracle) Filesystems should not attempt to perform their own readahead 82390c02eb9SMatthew Wilcox (Oracle) in the ->read_folio() operation. 82490c02eb9SMatthew Wilcox (Oracle) 82590c02eb9SMatthew Wilcox (Oracle) If the filesystem cannot perform the read at this time, it can 82690c02eb9SMatthew Wilcox (Oracle) unlock the folio, do whatever action it needs to ensure that the 82790c02eb9SMatthew Wilcox (Oracle) read will succeed in the future and return AOP_TRUNCATED_PAGE. 82890c02eb9SMatthew Wilcox (Oracle) In this case, the caller should look up the folio, lock it, 82990c02eb9SMatthew Wilcox (Oracle) and call ->read_folio again. 83090c02eb9SMatthew Wilcox (Oracle) 83190c02eb9SMatthew Wilcox (Oracle) Callers may invoke the ->read_folio() method directly, but using 83290c02eb9SMatthew Wilcox (Oracle) read_mapping_folio() will take care of locking, waiting for the 83390c02eb9SMatthew Wilcox (Oracle) read to complete and handle cases such as AOP_TRUNCATED_PAGE. 834af96c1e3STobin C. Harding 835ee5dc049STobin C. Harding``writepages`` 836ee5dc049STobin C. Harding called by the VM to write out pages associated with the 837e9b2f15bSJulia Lawall address_space object. If wbc->sync_mode is WB_SYNC_ALL, then 838af96c1e3STobin C. Harding the writeback_control will specify a range of pages that must be 839e9b2f15bSJulia Lawall written out. If it is WB_SYNC_NONE, then a nr_to_write is 840ee5dc049STobin C. Harding given and that many pages should be written if possible. If no 841ee5dc049STobin C. Harding ->writepages is given, then mpage_writepages is used instead. 842ee5dc049STobin C. Harding This will choose pages from the address space that are tagged as 843ee5dc049STobin C. Harding DIRTY and will pass them to ->writepage. 844af96c1e3STobin C. Harding 8456f31a5a2SMatthew Wilcox (Oracle)``dirty_folio`` 8466f31a5a2SMatthew Wilcox (Oracle) called by the VM to mark a folio as dirty. This is particularly 8476f31a5a2SMatthew Wilcox (Oracle) needed if an address space attaches private data to a folio, and 8486f31a5a2SMatthew Wilcox (Oracle) that data needs to be updated when a folio is dirtied. This is 849ee5dc049STobin C. Harding called, for example, when a memory mapped page gets modified. 8506f31a5a2SMatthew Wilcox (Oracle) If defined, it should set the folio dirty flag, and the 8516f31a5a2SMatthew Wilcox (Oracle) PAGECACHE_TAG_DIRTY search mark in i_pages. 852af96c1e3STobin C. Harding 8538151b4c8SMatthew Wilcox (Oracle)``readahead`` 8548151b4c8SMatthew Wilcox (Oracle) Called by the VM to read pages associated with the address_space 8558151b4c8SMatthew Wilcox (Oracle) object. The pages are consecutive in the page cache and are 8568151b4c8SMatthew Wilcox (Oracle) locked. The implementation should decrement the page refcount 8578151b4c8SMatthew Wilcox (Oracle) after starting I/O on each page. Usually the page will be 85884dacdbdSNeilBrown unlocked by the I/O completion handler. The set of pages are 85984dacdbdSNeilBrown divided into some sync pages followed by some async pages, 86084dacdbdSNeilBrown rac->ra->async_size gives the number of async pages. The 86184dacdbdSNeilBrown filesystem should attempt to read all sync pages but may decide 86284dacdbdSNeilBrown to stop once it reaches the async pages. If it does decide to 86384dacdbdSNeilBrown stop attempting I/O, it can simply return. The caller will 86484dacdbdSNeilBrown remove the remaining pages from the address space, unlock them 86584dacdbdSNeilBrown and decrement the page refcount. Set PageUptodate if the I/O 86684dacdbdSNeilBrown completes successfully. Setting PageError on any page will be 86784dacdbdSNeilBrown ignored; simply unlock the page if an I/O error occurs. 8688151b4c8SMatthew Wilcox (Oracle) 869ee5dc049STobin C. Harding``write_begin`` 870ee5dc049STobin C. Harding Called by the generic buffered write code to ask the filesystem 871ee5dc049STobin C. Harding to prepare to write len bytes at the given offset in the file. 872ee5dc049STobin C. Harding The address_space should check that the write will be able to 873ee5dc049STobin C. Harding complete, by allocating space if necessary and doing any other 874ee5dc049STobin C. Harding internal housekeeping. If the write will update parts of any 875ee5dc049STobin C. Harding basic-blocks on storage, then those blocks should be pre-read 876ee5dc049STobin C. Harding (if they haven't been read already) so that the updated blocks 877ee5dc049STobin C. Harding can be written out properly. 878af96c1e3STobin C. Harding 879ee5dc049STobin C. Harding The filesystem must return the locked pagecache page for the 880ee5dc049STobin C. Harding specified offset, in ``*pagep``, for the caller to write into. 881af96c1e3STobin C. Harding 882ee5dc049STobin C. Harding It must be able to cope with short writes (where the length 883ee5dc049STobin C. Harding passed to write_begin is greater than the number of bytes copied 884ee5dc049STobin C. Harding into the page). 885af96c1e3STobin C. Harding 886af96c1e3STobin C. Harding A void * may be returned in fsdata, which then gets passed into 887af96c1e3STobin C. Harding write_end. 888af96c1e3STobin C. Harding 889ee5dc049STobin C. Harding Returns 0 on success; < 0 on failure (which is the error code), 890ee5dc049STobin C. Harding in which case write_end is not called. 891af96c1e3STobin C. Harding 892ee5dc049STobin C. Harding``write_end`` 893ee5dc049STobin C. Harding After a successful write_begin, and data copy, write_end must be 894ee5dc049STobin C. Harding called. len is the original len passed to write_begin, and 895ee5dc049STobin C. Harding copied is the amount that was able to be copied. 896af96c1e3STobin C. Harding 897ee5dc049STobin C. Harding The filesystem must take care of unlocking the page and 898ee5dc049STobin C. Harding releasing it refcount, and updating i_size. 899af96c1e3STobin C. Harding 900ee5dc049STobin C. Harding Returns < 0 on failure, otherwise the number of bytes (<= 901ee5dc049STobin C. Harding 'copied') that were able to be copied into pagecache. 902af96c1e3STobin C. Harding 903ee5dc049STobin C. Harding``bmap`` 904ee5dc049STobin C. Harding called by the VFS to map a logical block offset within object to 905ee5dc049STobin C. Harding physical block number. This method is used by the FIBMAP ioctl 906ee5dc049STobin C. Harding and for working with swap-files. To be able to swap to a file, 907ee5dc049STobin C. Harding the file must have a stable mapping to a block device. The swap 908ee5dc049STobin C. Harding system does not go through the filesystem but instead uses bmap 909ee5dc049STobin C. Harding to find out where the blocks in the file are and uses those 910ee5dc049STobin C. Harding addresses directly. 911af96c1e3STobin C. Harding 912128d1f82SMatthew Wilcox (Oracle)``invalidate_folio`` 913128d1f82SMatthew Wilcox (Oracle) If a folio has private data, then invalidate_folio will be 914128d1f82SMatthew Wilcox (Oracle) called when part or all of the folio is to be removed from the 915ee5dc049STobin C. Harding address space. This generally corresponds to either a 916af96c1e3STobin C. Harding truncation, punch hole or a complete invalidation of the address 917af96c1e3STobin C. Harding space (in the latter case 'offset' will always be 0 and 'length' 918fa29000bSMatthew Wilcox (Oracle) will be folio_size()). Any private data associated with the folio 919ee5dc049STobin C. Harding should be updated to reflect this truncation. If offset is 0 920128d1f82SMatthew Wilcox (Oracle) and length is folio_size(), then the private data should be 921fa29000bSMatthew Wilcox (Oracle) released, because the folio must be able to be completely 922fa29000bSMatthew Wilcox (Oracle) discarded. This may be done by calling the ->release_folio 923ee5dc049STobin C. Harding function, but in this case the release MUST succeed. 924af96c1e3STobin C. Harding 925fa29000bSMatthew Wilcox (Oracle)``release_folio`` 926fa29000bSMatthew Wilcox (Oracle) release_folio is called on folios with private data to tell the 927fa29000bSMatthew Wilcox (Oracle) filesystem that the folio is about to be freed. ->release_folio 928fa29000bSMatthew Wilcox (Oracle) should remove any private data from the folio and clear the 929fa29000bSMatthew Wilcox (Oracle) private flag. If release_folio() fails, it should return false. 930fa29000bSMatthew Wilcox (Oracle) release_folio() is used in two distinct though related cases. 931fa29000bSMatthew Wilcox (Oracle) The first is when the VM wants to free a clean folio with no 932fa29000bSMatthew Wilcox (Oracle) active users. If ->release_folio succeeds, the folio will be 933fa29000bSMatthew Wilcox (Oracle) removed from the address_space and be freed. 934af96c1e3STobin C. Harding 935af96c1e3STobin C. Harding The second case is when a request has been made to invalidate 936fa29000bSMatthew Wilcox (Oracle) some or all folios in an address_space. This can happen 937fa29000bSMatthew Wilcox (Oracle) through the fadvise(POSIX_FADV_DONTNEED) system call or by the 938fa29000bSMatthew Wilcox (Oracle) filesystem explicitly requesting it as nfs and 9p do (when they 939ee5dc049STobin C. Harding believe the cache may be out of date with storage) by calling 940ee5dc049STobin C. Harding invalidate_inode_pages2(). If the filesystem makes such a call, 941fa29000bSMatthew Wilcox (Oracle) and needs to be certain that all folios are invalidated, then 942fa29000bSMatthew Wilcox (Oracle) its release_folio will need to ensure this. Possibly it can 943fa29000bSMatthew Wilcox (Oracle) clear the uptodate flag if it cannot free private data yet. 944af96c1e3STobin C. Harding 945d2329aa0SMatthew Wilcox (Oracle)``free_folio`` 946d2329aa0SMatthew Wilcox (Oracle) free_folio is called once the folio is no longer visible in the 947ee5dc049STobin C. Harding page cache in order to allow the cleanup of any private data. 948ee5dc049STobin C. Harding Since it may be called by the memory reclaimer, it should not 949ee5dc049STobin C. Harding assume that the original address_space mapping still exists, and 950ee5dc049STobin C. Harding it should not block. 951af96c1e3STobin C. Harding 952ee5dc049STobin C. Harding``direct_IO`` 953ee5dc049STobin C. Harding called by the generic read/write routines to perform direct_IO - 954ee5dc049STobin C. Harding that is IO requests which bypass the page cache and transfer 955ee5dc049STobin C. Harding data directly between the storage and the application's address 956ee5dc049STobin C. Harding space. 957af96c1e3STobin C. Harding 9585490da4fSMatthew Wilcox (Oracle)``migrate_folio`` 959ee5dc049STobin C. Harding This is used to compact the physical memory usage. If the VM 9605490da4fSMatthew Wilcox (Oracle) wants to relocate a folio (maybe from a memory device that is 9615490da4fSMatthew Wilcox (Oracle) signalling imminent failure) it will pass a new folio and an old 9625490da4fSMatthew Wilcox (Oracle) folio to this function. migrate_folio should transfer any private 9635490da4fSMatthew Wilcox (Oracle) data across and update any references that it has to the folio. 964af96c1e3STobin C. Harding 965affa80e8SMatthew Wilcox (Oracle)``launder_folio`` 966affa80e8SMatthew Wilcox (Oracle) Called before freeing a folio - it writes back the dirty folio. 967affa80e8SMatthew Wilcox (Oracle) To prevent redirtying the folio, it is kept locked during the 968ee5dc049STobin C. Harding whole operation. 969af96c1e3STobin C. Harding 970ee5dc049STobin C. Harding``is_partially_uptodate`` 971ee5dc049STobin C. Harding Called by the VM when reading a file through the pagecache when 9722e7e80f7SMatthew Wilcox (Oracle) the underlying blocksize is smaller than the size of the folio. 9732e7e80f7SMatthew Wilcox (Oracle) If the required block is up to date then the read can complete 9742e7e80f7SMatthew Wilcox (Oracle) without needing I/O to bring the whole page up to date. 975af96c1e3STobin C. Harding 976ee5dc049STobin C. Harding``is_dirty_writeback`` 977520f301cSMatthew Wilcox (Oracle) Called by the VM when attempting to reclaim a folio. The VM uses 978ee5dc049STobin C. Harding dirty and writeback information to determine if it needs to 979ee5dc049STobin C. Harding stall to allow flushers a chance to complete some IO. 980520f301cSMatthew Wilcox (Oracle) Ordinarily it can use folio_test_dirty and folio_test_writeback but 981520f301cSMatthew Wilcox (Oracle) some filesystems have more complex state (unstable folios in NFS 982ee5dc049STobin C. Harding prevent reclaim) or do not set those flags due to locking 983ee5dc049STobin C. Harding problems. This callback allows a filesystem to indicate to the 984520f301cSMatthew Wilcox (Oracle) VM if a folio should be treated as dirty or writeback for the 985ee5dc049STobin C. Harding purposes of stalling. 986af96c1e3STobin C. Harding 987ee5dc049STobin C. Harding``error_remove_page`` 988ee5dc049STobin C. Harding normally set to generic_error_remove_page if truncation is ok 989ee5dc049STobin C. Harding for this address space. Used for memory failure handling. 990af96c1e3STobin C. Harding Setting this implies you deal with pages going away under you, 991af96c1e3STobin C. Harding unless you have them locked or reference counts increased. 992af96c1e3STobin C. Harding 993ee5dc049STobin C. Harding``swap_activate`` 994cba738f6SNeilBrown 995cba738f6SNeilBrown Called to prepare the given file for swap. It should perform 996cba738f6SNeilBrown any validation and preparation necessary to ensure that writes 997cba738f6SNeilBrown can be performed with minimal memory allocation. It should call 998cba738f6SNeilBrown add_swap_extent(), or the helper iomap_swapfile_activate(), and 999cba738f6SNeilBrown return the number of extents added. If IO should be submitted 1000cba738f6SNeilBrown through ->swap_rw(), it should set SWP_FS_OPS, otherwise IO will 1001cba738f6SNeilBrown be submitted directly to the block device ``sis->bdev``. 1002af96c1e3STobin C. Harding 1003ee5dc049STobin C. Harding``swap_deactivate`` 1004ee5dc049STobin C. Harding Called during swapoff on files where swap_activate was 1005ee5dc049STobin C. Harding successful. 1006af96c1e3STobin C. Harding 1007cba738f6SNeilBrown``swap_rw`` 1008cba738f6SNeilBrown Called to read or write swap pages when SWP_FS_OPS is set. 1009af96c1e3STobin C. Harding 1010af96c1e3STobin C. HardingThe File Object 1011af96c1e3STobin C. Harding=============== 1012af96c1e3STobin C. Harding 1013af96c1e3STobin C. HardingA file object represents a file opened by a process. This is also known 1014af96c1e3STobin C. Hardingas an "open file description" in POSIX parlance. 1015af96c1e3STobin C. Harding 1016af96c1e3STobin C. Harding 1017af96c1e3STobin C. Hardingstruct file_operations 1018af96c1e3STobin C. Harding---------------------- 1019af96c1e3STobin C. Harding 1020af96c1e3STobin C. HardingThis describes how the VFS can manipulate an open file. As of kernel 1021af96c1e3STobin C. Harding4.18, the following members are defined: 1022af96c1e3STobin C. Harding 1023af96c1e3STobin C. Harding.. code-block:: c 1024af96c1e3STobin C. Harding 1025af96c1e3STobin C. Harding struct file_operations { 1026af96c1e3STobin C. Harding struct module *owner; 1027af96c1e3STobin C. Harding loff_t (*llseek) (struct file *, loff_t, int); 1028af96c1e3STobin C. Harding ssize_t (*read) (struct file *, char __user *, size_t, loff_t *); 1029af96c1e3STobin C. Harding ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *); 1030af96c1e3STobin C. Harding ssize_t (*read_iter) (struct kiocb *, struct iov_iter *); 1031af96c1e3STobin C. Harding ssize_t (*write_iter) (struct kiocb *, struct iov_iter *); 1032af96c1e3STobin C. Harding int (*iopoll)(struct kiocb *kiocb, bool spin); 1033af96c1e3STobin C. Harding int (*iterate) (struct file *, struct dir_context *); 1034af96c1e3STobin C. Harding int (*iterate_shared) (struct file *, struct dir_context *); 1035af96c1e3STobin C. Harding __poll_t (*poll) (struct file *, struct poll_table_struct *); 1036af96c1e3STobin C. Harding long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long); 1037af96c1e3STobin C. Harding long (*compat_ioctl) (struct file *, unsigned int, unsigned long); 1038af96c1e3STobin C. Harding int (*mmap) (struct file *, struct vm_area_struct *); 1039af96c1e3STobin C. Harding int (*open) (struct inode *, struct file *); 1040af96c1e3STobin C. Harding int (*flush) (struct file *, fl_owner_t id); 1041af96c1e3STobin C. Harding int (*release) (struct inode *, struct file *); 1042af96c1e3STobin C. Harding int (*fsync) (struct file *, loff_t, loff_t, int datasync); 1043af96c1e3STobin C. Harding int (*fasync) (int, struct file *, int); 1044af96c1e3STobin C. Harding int (*lock) (struct file *, int, struct file_lock *); 1045af96c1e3STobin C. Harding ssize_t (*sendpage) (struct file *, struct page *, int, size_t, loff_t *, int); 1046af96c1e3STobin C. Harding unsigned long (*get_unmapped_area)(struct file *, unsigned long, unsigned long, unsigned long, unsigned long); 1047af96c1e3STobin C. Harding int (*check_flags)(int); 1048af96c1e3STobin C. Harding int (*flock) (struct file *, int, struct file_lock *); 1049af96c1e3STobin C. Harding ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *, size_t, unsigned int); 1050af96c1e3STobin C. Harding ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *, size_t, unsigned int); 1051af96c1e3STobin C. Harding int (*setlease)(struct file *, long, struct file_lock **, void **); 1052af96c1e3STobin C. Harding long (*fallocate)(struct file *file, int mode, loff_t offset, 1053af96c1e3STobin C. Harding loff_t len); 1054af96c1e3STobin C. Harding void (*show_fdinfo)(struct seq_file *m, struct file *f); 1055af96c1e3STobin C. Harding #ifndef CONFIG_MMU 1056af96c1e3STobin C. Harding unsigned (*mmap_capabilities)(struct file *); 1057af96c1e3STobin C. Harding #endif 1058af96c1e3STobin C. Harding ssize_t (*copy_file_range)(struct file *, loff_t, struct file *, loff_t, size_t, unsigned int); 1059af96c1e3STobin C. Harding loff_t (*remap_file_range)(struct file *file_in, loff_t pos_in, 1060af96c1e3STobin C. Harding struct file *file_out, loff_t pos_out, 1061af96c1e3STobin C. Harding loff_t len, unsigned int remap_flags); 1062af96c1e3STobin C. Harding int (*fadvise)(struct file *, loff_t, loff_t, int); 1063af96c1e3STobin C. Harding }; 1064af96c1e3STobin C. Harding 1065af96c1e3STobin C. HardingAgain, all methods are called without any locks being held, unless 1066af96c1e3STobin C. Hardingotherwise noted. 1067af96c1e3STobin C. Harding 1068ee5dc049STobin C. Harding``llseek`` 1069ee5dc049STobin C. Harding called when the VFS needs to move the file position index 1070af96c1e3STobin C. Harding 1071ee5dc049STobin C. Harding``read`` 1072ee5dc049STobin C. Harding called by read(2) and related system calls 1073af96c1e3STobin C. Harding 1074ee5dc049STobin C. Harding``read_iter`` 1075ee5dc049STobin C. Harding possibly asynchronous read with iov_iter as destination 1076af96c1e3STobin C. Harding 1077ee5dc049STobin C. Harding``write`` 1078ee5dc049STobin C. Harding called by write(2) and related system calls 1079af96c1e3STobin C. Harding 1080ee5dc049STobin C. Harding``write_iter`` 1081ee5dc049STobin C. Harding possibly asynchronous write with iov_iter as source 1082af96c1e3STobin C. Harding 1083ee5dc049STobin C. Harding``iopoll`` 1084ee5dc049STobin C. Harding called when aio wants to poll for completions on HIPRI iocbs 1085af96c1e3STobin C. Harding 1086ee5dc049STobin C. Harding``iterate`` 1087ee5dc049STobin C. Harding called when the VFS needs to read the directory contents 1088af96c1e3STobin C. Harding 1089ee5dc049STobin C. Harding``iterate_shared`` 1090ee5dc049STobin C. Harding called when the VFS needs to read the directory contents when 1091ee5dc049STobin C. Harding filesystem supports concurrent dir iterators 1092af96c1e3STobin C. Harding 1093ee5dc049STobin C. Harding``poll`` 1094ee5dc049STobin C. Harding called by the VFS when a process wants to check if there is 1095af96c1e3STobin C. Harding activity on this file and (optionally) go to sleep until there 1096af96c1e3STobin C. Harding is activity. Called by the select(2) and poll(2) system calls 1097af96c1e3STobin C. Harding 1098ee5dc049STobin C. Harding``unlocked_ioctl`` 1099ee5dc049STobin C. Harding called by the ioctl(2) system call. 1100af96c1e3STobin C. Harding 1101ee5dc049STobin C. Harding``compat_ioctl`` 1102ee5dc049STobin C. Harding called by the ioctl(2) system call when 32 bit system calls are 1103ee5dc049STobin C. Harding used on 64 bit kernels. 1104af96c1e3STobin C. Harding 1105ee5dc049STobin C. Harding``mmap`` 1106ee5dc049STobin C. Harding called by the mmap(2) system call 1107af96c1e3STobin C. Harding 1108ee5dc049STobin C. Harding``open`` 1109ee5dc049STobin C. Harding called by the VFS when an inode should be opened. When the VFS 1110af96c1e3STobin C. Harding opens a file, it creates a new "struct file". It then calls the 1111af96c1e3STobin C. Harding open method for the newly allocated file structure. You might 1112ee5dc049STobin C. Harding think that the open method really belongs in "struct 1113ee5dc049STobin C. Harding inode_operations", and you may be right. I think it's done the 1114ee5dc049STobin C. Harding way it is because it makes filesystems simpler to implement. 1115ee5dc049STobin C. Harding The open() method is a good place to initialize the 1116af96c1e3STobin C. Harding "private_data" member in the file structure if you want to point 1117af96c1e3STobin C. Harding to a device structure 1118af96c1e3STobin C. Harding 1119ee5dc049STobin C. Harding``flush`` 1120ee5dc049STobin C. Harding called by the close(2) system call to flush a file 1121af96c1e3STobin C. Harding 1122ee5dc049STobin C. Harding``release`` 1123ee5dc049STobin C. Harding called when the last reference to an open file is closed 1124af96c1e3STobin C. Harding 1125ee5dc049STobin C. Harding``fsync`` 1126ee5dc049STobin C. Harding called by the fsync(2) system call. Also see the section above 1127af96c1e3STobin C. Harding entitled "Handling errors during writeback". 1128af96c1e3STobin C. Harding 1129ee5dc049STobin C. Harding``fasync`` 1130ee5dc049STobin C. Harding called by the fcntl(2) system call when asynchronous 1131af96c1e3STobin C. Harding (non-blocking) mode is enabled for a file 1132af96c1e3STobin C. Harding 1133ee5dc049STobin C. Harding``lock`` 1134ee5dc049STobin C. Harding called by the fcntl(2) system call for F_GETLK, F_SETLK, and 1135ee5dc049STobin C. Harding F_SETLKW commands 1136af96c1e3STobin C. Harding 1137ee5dc049STobin C. Harding``get_unmapped_area`` 1138ee5dc049STobin C. Harding called by the mmap(2) system call 1139af96c1e3STobin C. Harding 1140ee5dc049STobin C. Harding``check_flags`` 1141ee5dc049STobin C. Harding called by the fcntl(2) system call for F_SETFL command 1142af96c1e3STobin C. Harding 1143ee5dc049STobin C. Harding``flock`` 1144ee5dc049STobin C. Harding called by the flock(2) system call 1145af96c1e3STobin C. Harding 1146ee5dc049STobin C. Harding``splice_write`` 1147ee5dc049STobin C. Harding called by the VFS to splice data from a pipe to a file. This 1148af96c1e3STobin C. Harding method is used by the splice(2) system call 1149af96c1e3STobin C. Harding 1150ee5dc049STobin C. Harding``splice_read`` 1151ee5dc049STobin C. Harding called by the VFS to splice data from file to a pipe. This 1152af96c1e3STobin C. Harding method is used by the splice(2) system call 1153af96c1e3STobin C. Harding 1154ee5dc049STobin C. Harding``setlease`` 1155ee5dc049STobin C. Harding called by the VFS to set or release a file lock lease. setlease 1156af96c1e3STobin C. Harding implementations should call generic_setlease to record or remove 1157af96c1e3STobin C. Harding the lease in the inode after setting it. 1158af96c1e3STobin C. Harding 1159ee5dc049STobin C. Harding``fallocate`` 1160ee5dc049STobin C. Harding called by the VFS to preallocate blocks or punch a hole. 1161af96c1e3STobin C. Harding 1162ee5dc049STobin C. Harding``copy_file_range`` 1163ee5dc049STobin C. Harding called by the copy_file_range(2) system call. 1164af96c1e3STobin C. Harding 1165ee5dc049STobin C. Harding``remap_file_range`` 1166ee5dc049STobin C. Harding called by the ioctl(2) system call for FICLONERANGE and FICLONE 1167ee5dc049STobin C. Harding and FIDEDUPERANGE commands to remap file ranges. An 1168ee5dc049STobin C. Harding implementation should remap len bytes at pos_in of the source 1169ee5dc049STobin C. Harding file into the dest file at pos_out. Implementations must handle 1170ee5dc049STobin C. Harding callers passing in len == 0; this means "remap to the end of the 1171ee5dc049STobin C. Harding source file". The return value should the number of bytes 1172ee5dc049STobin C. Harding remapped, or the usual negative error code if errors occurred 1173ee5dc049STobin C. Harding before any bytes were remapped. The remap_flags parameter 1174ee5dc049STobin C. Harding accepts REMAP_FILE_* flags. If REMAP_FILE_DEDUP is set then the 1175ee5dc049STobin C. Harding implementation must only remap if the requested file ranges have 1176cb56ecaeSJulia Lawall identical contents. If REMAP_FILE_CAN_SHORTEN is set, the caller is 1177ee5dc049STobin C. Harding ok with the implementation shortening the request length to 1178ee5dc049STobin C. Harding satisfy alignment or EOF requirements (or any other reason). 1179af96c1e3STobin C. Harding 1180ee5dc049STobin C. Harding``fadvise`` 1181ee5dc049STobin C. Harding possibly called by the fadvise64() system call. 1182af96c1e3STobin C. Harding 1183af96c1e3STobin C. HardingNote that the file operations are implemented by the specific 1184af96c1e3STobin C. Hardingfilesystem in which the inode resides. When opening a device node 1185af96c1e3STobin C. Harding(character or block special) most filesystems will call special 1186af96c1e3STobin C. Hardingsupport routines in the VFS which will locate the required device 1187af96c1e3STobin C. Hardingdriver information. These support routines replace the filesystem file 1188af96c1e3STobin C. Hardingoperations with those for the device driver, and then proceed to call 1189af96c1e3STobin C. Hardingthe new open() method for the file. This is how opening a device file 1190af96c1e3STobin C. Hardingin the filesystem eventually ends up calling the device driver open() 1191af96c1e3STobin C. Hardingmethod. 1192af96c1e3STobin C. Harding 1193af96c1e3STobin C. Harding 1194af96c1e3STobin C. HardingDirectory Entry Cache (dcache) 1195af96c1e3STobin C. Harding============================== 1196af96c1e3STobin C. Harding 1197af96c1e3STobin C. Harding 1198af96c1e3STobin C. Hardingstruct dentry_operations 1199af96c1e3STobin C. Harding------------------------ 1200af96c1e3STobin C. Harding 1201af96c1e3STobin C. HardingThis describes how a filesystem can overload the standard dentry 1202af96c1e3STobin C. Hardingoperations. Dentries and the dcache are the domain of the VFS and the 1203af96c1e3STobin C. Hardingindividual filesystem implementations. Device drivers have no business 1204af96c1e3STobin C. Hardinghere. These methods may be set to NULL, as they are either optional or 1205af96c1e3STobin C. Hardingthe VFS uses a default. As of kernel 2.6.22, the following members are 1206af96c1e3STobin C. Hardingdefined: 1207af96c1e3STobin C. Harding 1208af96c1e3STobin C. Harding.. code-block:: c 1209af96c1e3STobin C. Harding 1210af96c1e3STobin C. Harding struct dentry_operations { 1211af96c1e3STobin C. Harding int (*d_revalidate)(struct dentry *, unsigned int); 1212af96c1e3STobin C. Harding int (*d_weak_revalidate)(struct dentry *, unsigned int); 1213af96c1e3STobin C. Harding int (*d_hash)(const struct dentry *, struct qstr *); 1214af96c1e3STobin C. Harding int (*d_compare)(const struct dentry *, 1215af96c1e3STobin C. Harding unsigned int, const char *, const struct qstr *); 1216af96c1e3STobin C. Harding int (*d_delete)(const struct dentry *); 1217af96c1e3STobin C. Harding int (*d_init)(struct dentry *); 1218af96c1e3STobin C. Harding void (*d_release)(struct dentry *); 1219af96c1e3STobin C. Harding void (*d_iput)(struct dentry *, struct inode *); 1220af96c1e3STobin C. Harding char *(*d_dname)(struct dentry *, char *, int); 1221af96c1e3STobin C. Harding struct vfsmount *(*d_automount)(struct path *); 1222af96c1e3STobin C. Harding int (*d_manage)(const struct path *, bool); 1223af96c1e3STobin C. Harding struct dentry *(*d_real)(struct dentry *, const struct inode *); 1224af96c1e3STobin C. Harding }; 1225af96c1e3STobin C. Harding 1226ee5dc049STobin C. Harding``d_revalidate`` 1227ee5dc049STobin C. Harding called when the VFS needs to revalidate a dentry. This is 1228ee5dc049STobin C. Harding called whenever a name look-up finds a dentry in the dcache. 1229ee5dc049STobin C. Harding Most local filesystems leave this as NULL, because all their 1230ee5dc049STobin C. Harding dentries in the dcache are valid. Network filesystems are 1231ee5dc049STobin C. Harding different since things can change on the server without the 1232ee5dc049STobin C. Harding client necessarily being aware of it. 1233af96c1e3STobin C. Harding 1234ee5dc049STobin C. Harding This function should return a positive value if the dentry is 1235ee5dc049STobin C. Harding still valid, and zero or a negative error code if it isn't. 1236af96c1e3STobin C. Harding 1237ee5dc049STobin C. Harding d_revalidate may be called in rcu-walk mode (flags & 1238ee5dc049STobin C. Harding LOOKUP_RCU). If in rcu-walk mode, the filesystem must 1239ee5dc049STobin C. Harding revalidate the dentry without blocking or storing to the dentry, 1240ee5dc049STobin C. Harding d_parent and d_inode should not be used without care (because 1241ee5dc049STobin C. Harding they can change and, in d_inode case, even become NULL under 1242ee5dc049STobin C. Harding us). 1243af96c1e3STobin C. Harding 1244ee5dc049STobin C. Harding If a situation is encountered that rcu-walk cannot handle, 1245ee5dc049STobin C. Harding return 1246af96c1e3STobin C. Harding -ECHILD and it will be called again in ref-walk mode. 1247af96c1e3STobin C. Harding 124874596085SGlenn Washburn``d_weak_revalidate`` 1249ee5dc049STobin C. Harding called when the VFS needs to revalidate a "jumped" dentry. This 1250ee5dc049STobin C. Harding is called when a path-walk ends at dentry that was not acquired 1251ee5dc049STobin C. Harding by doing a lookup in the parent directory. This includes "/", 1252ee5dc049STobin C. Harding "." and "..", as well as procfs-style symlinks and mountpoint 1253ee5dc049STobin C. Harding traversal. 1254af96c1e3STobin C. Harding 1255ee5dc049STobin C. Harding In this case, we are less concerned with whether the dentry is 1256ee5dc049STobin C. Harding still fully correct, but rather that the inode is still valid. 1257ee5dc049STobin C. Harding As with d_revalidate, most local filesystems will set this to 1258ee5dc049STobin C. Harding NULL since their dcache entries are always valid. 1259af96c1e3STobin C. Harding 1260ee5dc049STobin C. Harding This function has the same return code semantics as 1261ee5dc049STobin C. Harding d_revalidate. 1262af96c1e3STobin C. Harding 1263af96c1e3STobin C. Harding d_weak_revalidate is only called after leaving rcu-walk mode. 1264af96c1e3STobin C. Harding 1265ee5dc049STobin C. Harding``d_hash`` 1266ee5dc049STobin C. Harding called when the VFS adds a dentry to the hash table. The first 1267af96c1e3STobin C. Harding dentry passed to d_hash is the parent directory that the name is 1268af96c1e3STobin C. Harding to be hashed into. 1269af96c1e3STobin C. Harding 1270af96c1e3STobin C. Harding Same locking and synchronisation rules as d_compare regarding 1271af96c1e3STobin C. Harding what is safe to dereference etc. 1272af96c1e3STobin C. Harding 1273ee5dc049STobin C. Harding``d_compare`` 1274ee5dc049STobin C. Harding called to compare a dentry name with a given name. The first 1275af96c1e3STobin C. Harding dentry is the parent of the dentry to be compared, the second is 1276ee5dc049STobin C. Harding the child dentry. len and name string are properties of the 1277ee5dc049STobin C. Harding dentry to be compared. qstr is the name to compare it with. 1278af96c1e3STobin C. Harding 1279af96c1e3STobin C. Harding Must be constant and idempotent, and should not take locks if 1280ee5dc049STobin C. Harding possible, and should not or store into the dentry. Should not 1281ee5dc049STobin C. Harding dereference pointers outside the dentry without lots of care 1282ee5dc049STobin C. Harding (eg. d_parent, d_inode, d_name should not be used). 1283af96c1e3STobin C. Harding 1284ee5dc049STobin C. Harding However, our vfsmount is pinned, and RCU held, so the dentries 1285ee5dc049STobin C. Harding and inodes won't disappear, neither will our sb or filesystem 1286ee5dc049STobin C. Harding module. ->d_sb may be used. 1287af96c1e3STobin C. Harding 1288ee5dc049STobin C. Harding It is a tricky calling convention because it needs to be called 1289ee5dc049STobin C. Harding under "rcu-walk", ie. without any locks or references on things. 1290af96c1e3STobin C. Harding 1291ee5dc049STobin C. Harding``d_delete`` 1292ee5dc049STobin C. Harding called when the last reference to a dentry is dropped and the 1293ee5dc049STobin C. Harding dcache is deciding whether or not to cache it. Return 1 to 1294ee5dc049STobin C. Harding delete immediately, or 0 to cache the dentry. Default is NULL 1295ee5dc049STobin C. Harding which means to always cache a reachable dentry. d_delete must 1296ee5dc049STobin C. Harding be constant and idempotent. 1297af96c1e3STobin C. Harding 1298ee5dc049STobin C. Harding``d_init`` 1299ee5dc049STobin C. Harding called when a dentry is allocated 1300af96c1e3STobin C. Harding 1301ee5dc049STobin C. Harding``d_release`` 1302ee5dc049STobin C. Harding called when a dentry is really deallocated 1303af96c1e3STobin C. Harding 1304ee5dc049STobin C. Harding``d_iput`` 1305ee5dc049STobin C. Harding called when a dentry loses its inode (just prior to its being 1306ee5dc049STobin C. Harding deallocated). The default when this is NULL is that the VFS 1307ee5dc049STobin C. Harding calls iput(). If you define this method, you must call iput() 1308ee5dc049STobin C. Harding yourself 1309af96c1e3STobin C. Harding 1310ee5dc049STobin C. Harding``d_dname`` 1311ee5dc049STobin C. Harding called when the pathname of a dentry should be generated. 1312ee5dc049STobin C. Harding Useful for some pseudo filesystems (sockfs, pipefs, ...) to 1313ee5dc049STobin C. Harding delay pathname generation. (Instead of doing it when dentry is 1314ee5dc049STobin C. Harding created, it's done only when the path is needed.). Real 1315ee5dc049STobin C. Harding filesystems probably dont want to use it, because their dentries 1316ee5dc049STobin C. Harding are present in global dcache hash, so their hash should be an 1317ee5dc049STobin C. Harding invariant. As no lock is held, d_dname() should not try to 1318ee5dc049STobin C. Harding modify the dentry itself, unless appropriate SMP safety is used. 1319ee5dc049STobin C. Harding CAUTION : d_path() logic is quite tricky. The correct way to 1320ee5dc049STobin C. Harding return for example "Hello" is to put it at the end of the 1321ee5dc049STobin C. Harding buffer, and returns a pointer to the first char. 1322ee5dc049STobin C. Harding dynamic_dname() helper function is provided to take care of 1323ee5dc049STobin C. Harding this. 1324af96c1e3STobin C. Harding 1325af96c1e3STobin C. Harding Example : 1326af96c1e3STobin C. Harding 1327af96c1e3STobin C. Harding.. code-block:: c 1328af96c1e3STobin C. Harding 1329af96c1e3STobin C. Harding static char *pipefs_dname(struct dentry *dent, char *buffer, int buflen) 1330af96c1e3STobin C. Harding { 1331af96c1e3STobin C. Harding return dynamic_dname(dentry, buffer, buflen, "pipe:[%lu]", 1332af96c1e3STobin C. Harding dentry->d_inode->i_ino); 1333af96c1e3STobin C. Harding } 1334af96c1e3STobin C. Harding 1335ee5dc049STobin C. Harding``d_automount`` 1336ee5dc049STobin C. Harding called when an automount dentry is to be traversed (optional). 1337ee5dc049STobin C. Harding This should create a new VFS mount record and return the record 1338ee5dc049STobin C. Harding to the caller. The caller is supplied with a path parameter 1339ee5dc049STobin C. Harding giving the automount directory to describe the automount target 1340ee5dc049STobin C. Harding and the parent VFS mount record to provide inheritable mount 1341ee5dc049STobin C. Harding parameters. NULL should be returned if someone else managed to 1342ee5dc049STobin C. Harding make the automount first. If the vfsmount creation failed, then 1343ee5dc049STobin C. Harding an error code should be returned. If -EISDIR is returned, then 1344ee5dc049STobin C. Harding the directory will be treated as an ordinary directory and 1345ee5dc049STobin C. Harding returned to pathwalk to continue walking. 1346af96c1e3STobin C. Harding 1347ee5dc049STobin C. Harding If a vfsmount is returned, the caller will attempt to mount it 1348ee5dc049STobin C. Harding on the mountpoint and will remove the vfsmount from its 1349ee5dc049STobin C. Harding expiration list in the case of failure. The vfsmount should be 1350ee5dc049STobin C. Harding returned with 2 refs on it to prevent automatic expiration - the 1351ee5dc049STobin C. Harding caller will clean up the additional ref. 1352af96c1e3STobin C. Harding 1353ee5dc049STobin C. Harding This function is only used if DCACHE_NEED_AUTOMOUNT is set on 1354ee5dc049STobin C. Harding the dentry. This is set by __d_instantiate() if S_AUTOMOUNT is 1355ee5dc049STobin C. Harding set on the inode being added. 1356af96c1e3STobin C. Harding 1357ee5dc049STobin C. Harding``d_manage`` 1358ee5dc049STobin C. Harding called to allow the filesystem to manage the transition from a 1359ee5dc049STobin C. Harding dentry (optional). This allows autofs, for example, to hold up 1360ee5dc049STobin C. Harding clients waiting to explore behind a 'mountpoint' while letting 1361ee5dc049STobin C. Harding the daemon go past and construct the subtree there. 0 should be 1362ee5dc049STobin C. Harding returned to let the calling process continue. -EISDIR can be 1363ee5dc049STobin C. Harding returned to tell pathwalk to use this directory as an ordinary 1364ee5dc049STobin C. Harding directory and to ignore anything mounted on it and not to check 1365ee5dc049STobin C. Harding the automount flag. Any other error code will abort pathwalk 1366ee5dc049STobin C. Harding completely. 1367af96c1e3STobin C. Harding 1368af96c1e3STobin C. Harding If the 'rcu_walk' parameter is true, then the caller is doing a 1369ee5dc049STobin C. Harding pathwalk in RCU-walk mode. Sleeping is not permitted in this 1370ee5dc049STobin C. Harding mode, and the caller can be asked to leave it and call again by 1371ee5dc049STobin C. Harding returning -ECHILD. -EISDIR may also be returned to tell 1372ee5dc049STobin C. Harding pathwalk to ignore d_automount or any mounts. 1373af96c1e3STobin C. Harding 1374ee5dc049STobin C. Harding This function is only used if DCACHE_MANAGE_TRANSIT is set on 1375ee5dc049STobin C. Harding the dentry being transited from. 1376af96c1e3STobin C. Harding 1377ee5dc049STobin C. Harding``d_real`` 1378ee5dc049STobin C. Harding overlay/union type filesystems implement this method to return 1379ee5dc049STobin C. Harding one of the underlying dentries hidden by the overlay. It is 1380ee5dc049STobin C. Harding used in two different modes: 1381af96c1e3STobin C. Harding 1382ee5dc049STobin C. Harding Called from file_dentry() it returns the real dentry matching 1383ee5dc049STobin C. Harding the inode argument. The real dentry may be from a lower layer 1384ee5dc049STobin C. Harding already copied up, but still referenced from the file. This 1385ee5dc049STobin C. Harding mode is selected with a non-NULL inode argument. 1386af96c1e3STobin C. Harding 1387af96c1e3STobin C. Harding With NULL inode the topmost real underlying dentry is returned. 1388af96c1e3STobin C. Harding 1389af96c1e3STobin C. HardingEach dentry has a pointer to its parent dentry, as well as a hash list 1390af96c1e3STobin C. Hardingof child dentries. Child dentries are basically like files in a 1391af96c1e3STobin C. Hardingdirectory. 1392af96c1e3STobin C. Harding 1393af96c1e3STobin C. Harding 1394af96c1e3STobin C. HardingDirectory Entry Cache API 1395af96c1e3STobin C. Harding-------------------------- 1396af96c1e3STobin C. Harding 1397af96c1e3STobin C. HardingThere are a number of functions defined which permit a filesystem to 1398af96c1e3STobin C. Hardingmanipulate dentries: 1399af96c1e3STobin C. Harding 1400ee5dc049STobin C. Harding``dget`` 1401ee5dc049STobin C. Harding open a new handle for an existing dentry (this just increments 1402af96c1e3STobin C. Harding the usage count) 1403af96c1e3STobin C. Harding 1404ee5dc049STobin C. Harding``dput`` 1405ee5dc049STobin C. Harding close a handle for a dentry (decrements the usage count). If 1406af96c1e3STobin C. Harding the usage count drops to 0, and the dentry is still in its 1407af96c1e3STobin C. Harding parent's hash, the "d_delete" method is called to check whether 1408ee5dc049STobin C. Harding it should be cached. If it should not be cached, or if the 1409ee5dc049STobin C. Harding dentry is not hashed, it is deleted. Otherwise cached dentries 1410ee5dc049STobin C. Harding are put into an LRU list to be reclaimed on memory shortage. 1411af96c1e3STobin C. Harding 1412ee5dc049STobin C. Harding``d_drop`` 1413ee5dc049STobin C. Harding this unhashes a dentry from its parents hash list. A subsequent 1414ee5dc049STobin C. Harding call to dput() will deallocate the dentry if its usage count 1415ee5dc049STobin C. Harding drops to 0 1416af96c1e3STobin C. Harding 1417ee5dc049STobin C. Harding``d_delete`` 1418ee5dc049STobin C. Harding delete a dentry. If there are no other open references to the 1419ee5dc049STobin C. Harding dentry then the dentry is turned into a negative dentry (the 1420ee5dc049STobin C. Harding d_iput() method is called). If there are other references, then 1421ee5dc049STobin C. Harding d_drop() is called instead 1422af96c1e3STobin C. Harding 1423ee5dc049STobin C. Harding``d_add`` 1424ee5dc049STobin C. Harding add a dentry to its parents hash list and then calls 1425af96c1e3STobin C. Harding d_instantiate() 1426af96c1e3STobin C. Harding 1427ee5dc049STobin C. Harding``d_instantiate`` 1428ee5dc049STobin C. Harding add a dentry to the alias hash list for the inode and updates 1429ee5dc049STobin C. Harding the "d_inode" member. The "i_count" member in the inode 1430ee5dc049STobin C. Harding structure should be set/incremented. If the inode pointer is 1431ee5dc049STobin C. Harding NULL, the dentry is called a "negative dentry". This function 1432ee5dc049STobin C. Harding is commonly called when an inode is created for an existing 1433ee5dc049STobin C. Harding negative dentry 1434af96c1e3STobin C. Harding 1435ee5dc049STobin C. Harding``d_lookup`` 1436ee5dc049STobin C. Harding look up a dentry given its parent and path name component It 1437ee5dc049STobin C. Harding looks up the child of that given name from the dcache hash 1438ee5dc049STobin C. Harding table. If it is found, the reference count is incremented and 1439ee5dc049STobin C. Harding the dentry is returned. The caller must use dput() to free the 1440ee5dc049STobin C. Harding dentry when it finishes using it. 1441af96c1e3STobin C. Harding 1442af96c1e3STobin C. Harding 1443af96c1e3STobin C. HardingMount Options 1444af96c1e3STobin C. Harding============= 1445af96c1e3STobin C. Harding 1446af96c1e3STobin C. Harding 1447af96c1e3STobin C. HardingParsing options 1448af96c1e3STobin C. Harding--------------- 1449af96c1e3STobin C. Harding 1450af96c1e3STobin C. HardingOn mount and remount the filesystem is passed a string containing a 1451af96c1e3STobin C. Hardingcomma separated list of mount options. The options can have either of 1452af96c1e3STobin C. Hardingthese forms: 1453af96c1e3STobin C. Harding 1454af96c1e3STobin C. Harding option 1455af96c1e3STobin C. Harding option=value 1456af96c1e3STobin C. Harding 1457af96c1e3STobin C. HardingThe <linux/parser.h> header defines an API that helps parse these 1458af96c1e3STobin C. Hardingoptions. There are plenty of examples on how to use it in existing 1459af96c1e3STobin C. Hardingfilesystems. 1460af96c1e3STobin C. Harding 1461af96c1e3STobin C. Harding 1462af96c1e3STobin C. HardingShowing options 1463af96c1e3STobin C. Harding--------------- 1464af96c1e3STobin C. Harding 1465af96c1e3STobin C. HardingIf a filesystem accepts mount options, it must define show_options() to 1466af96c1e3STobin C. Hardingshow all the currently active options. The rules are: 1467af96c1e3STobin C. Harding 1468af96c1e3STobin C. Harding - options MUST be shown which are not default or their values differ 1469af96c1e3STobin C. Harding from the default 1470af96c1e3STobin C. Harding 1471af96c1e3STobin C. Harding - options MAY be shown which are enabled by default or have their 1472af96c1e3STobin C. Harding default value 1473af96c1e3STobin C. Harding 1474af96c1e3STobin C. HardingOptions used only internally between a mount helper and the kernel (such 1475af96c1e3STobin C. Hardingas file descriptors), or which only have an effect during the mounting 1476af96c1e3STobin C. Harding(such as ones controlling the creation of a journal) are exempt from the 1477af96c1e3STobin C. Hardingabove rules. 1478af96c1e3STobin C. Harding 1479af96c1e3STobin C. HardingThe underlying reason for the above rules is to make sure, that a mount 1480af96c1e3STobin C. Hardingcan be accurately replicated (e.g. umounting and mounting again) based 1481af96c1e3STobin C. Hardingon the information found in /proc/mounts. 1482af96c1e3STobin C. Harding 1483af96c1e3STobin C. Harding 1484af96c1e3STobin C. HardingResources 1485af96c1e3STobin C. Harding========= 1486af96c1e3STobin C. Harding 1487af96c1e3STobin C. Harding(Note some of these resources are not up-to-date with the latest kernel 1488af96c1e3STobin C. Harding version.) 1489af96c1e3STobin C. Harding 1490af96c1e3STobin C. HardingCreating Linux virtual filesystems. 2002 1491c69f22f2SAlexander A. Klimov <https://lwn.net/Articles/13325/> 1492af96c1e3STobin C. Harding 1493af96c1e3STobin C. HardingThe Linux Virtual File-system Layer by Neil Brown. 1999 1494af96c1e3STobin C. Harding <http://www.cse.unsw.edu.au/~neilb/oss/linux-commentary/vfs.html> 1495af96c1e3STobin C. Harding 1496af96c1e3STobin C. HardingA tour of the Linux VFS by Michael K. Johnson. 1996 1497c69f22f2SAlexander A. Klimov <https://www.tldp.org/LDP/khg/HyperNews/get/fs/vfstour.html> 1498af96c1e3STobin C. Harding 1499af96c1e3STobin C. HardingA small trail through the Linux kernel by Andries Brouwer. 2001 1500c69f22f2SAlexander A. Klimov <https://www.win.tue.nl/~aeb/linux/vfs/trail.html> 1501