Blame view

Documentation/filesystems/locking.rst 24.7 KB
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
1
2
3
4
5
  =======
  Locking
  =======
  
  The text below describes the locking rules for VFS-related methods.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
6
7
8
9
10
11
  It is (believed to be) up-to-date. *Please*, if you change anything in
  prototypes or locking protocols - update this file. And update the relevant
  instances in the tree, don't leave that to maintainers of filesystems/devices/
  etc. At the very least, put the list of dubious cases in the end of this file.
  Don't turn it into log - maintainers of out-of-the-tree code are supposed to
  be able to use diff(1).
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
12

ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
13
14
15
16
17
18
  Thing currently missing here: socket operations. Alexey?
  
  dentry_operations
  =================
  
  prototypes::
0b728e191   Al Viro   stop passing name...
19
  	int (*d_revalidate)(struct dentry *, unsigned int);
ecf3d1f1a   Jeff Layton   vfs: kill FS_REVA...
20
  	int (*d_weak_revalidate)(struct dentry *, unsigned int);
da53be12b   Linus Torvalds   Don't pass inode ...
21
  	int (*d_hash)(const struct dentry *, struct qstr *);
6fa67e707   Al Viro   get rid of 'paren...
22
  	int (*d_compare)(const struct dentry *,
621e155a3   Nick Piggin   fs: change d_comp...
23
  			unsigned int, const char *, const struct qstr *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
24
  	int (*d_delete)(struct dentry *);
285b102d3   Miklos Szeredi   vfs: new d_init m...
25
  	int (*d_init)(struct dentry *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
26
27
  	void (*d_release)(struct dentry *);
  	void (*d_iput)(struct dentry *, struct inode *);
c23fbb6bc   Eric Dumazet   VFS: delay the de...
28
  	char *(*d_dname)((struct dentry *dentry, char *buffer, int buflen);
9875cf806   David Howells   Add a dentry op t...
29
  	struct vfsmount *(*d_automount)(struct path *path);
fb5f51c74   Ian Kent   vfs: change d_man...
30
  	int (*d_manage)(const struct path *, bool);
fb16043b4   Miklos Szeredi   vfs: remove open_...
31
  	struct dentry *(*d_real)(struct dentry *, const struct inode *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
32
33
  
  locking rules:
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
  
  ================== ===========	========	==============	========
  ops		   rename_lock	->d_lock	may block	rcu-walk
  ================== ===========	========	==============	========
  d_revalidate:	   no		no		yes (ref-walk)	maybe
  d_weak_revalidate: no		no		yes	 	no
  d_hash		   no		no		no		maybe
  d_compare:	   yes		no		no		maybe
  d_delete:	   no		yes		no		no
  d_init:		   no		no		yes		no
  d_release:	   no		no		yes		no
  d_prune:           no		yes		no		no
  d_iput:		   no		no		yes		no
  d_dname:	   no		no		no		no
  d_automount:	   no		no		yes		no
  d_manage:	   no		no		yes (ref-walk)	maybe
  d_real		   no		no		yes 		no
  ================== ===========	========	==============	========
  
  inode_operations
  ================
  
  prototypes::
ebfc3b49a   Al Viro   don't pass nameid...
57
  	int (*create) (struct inode *,struct dentry *,umode_t, bool);
00cd8dd3b   Al Viro   stop passing name...
58
  	struct dentry * (*lookup) (struct inode *,struct dentry *, unsigned int);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
59
60
61
  	int (*link) (struct dentry *,struct inode *,struct dentry *);
  	int (*unlink) (struct inode *,struct dentry *);
  	int (*symlink) (struct inode *,struct dentry *,const char *);
18bb1db3e   Al Viro   switch vfs_mkdir(...
62
  	int (*mkdir) (struct inode *,struct dentry *,umode_t);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
63
  	int (*rmdir) (struct inode *,struct dentry *);
1a67aafb5   Al Viro   switch ->mknod() ...
64
  	int (*mknod) (struct inode *,struct dentry *,umode_t,dev_t);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
65
  	int (*rename) (struct inode *, struct dentry *,
520c8b165   Miklos Szeredi   vfs: add renameat...
66
  			struct inode *, struct dentry *, unsigned int);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
67
  	int (*readlink) (struct dentry *, char __user *,int);
1a6a31655   Eric Biggers   Documentation/fil...
68
  	const char *(*get_link) (struct dentry *, struct inode *, struct delayed_call *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
69
  	void (*truncate) (struct inode *);
b74c79e99   Nick Piggin   fs: provide rcu-w...
70
  	int (*permission) (struct inode *, int, unsigned int);
4e34e719e   Christoph Hellwig   fs: take the ACL ...
71
  	int (*get_acl)(struct inode *, int);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
72
  	int (*setattr) (struct dentry *, struct iattr *);
75dd7e4bb   Eric Biggers   Documentation/fil...
73
  	int (*getattr) (const struct path *, struct kstat *, u32, unsigned int);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
74
  	ssize_t (*listxattr) (struct dentry *, char *, size_t);
b83be6f20   Christoph Hellwig   update Documentat...
75
  	int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start, u64 len);
c3b2da314   Josef Bacik   fs: introduce ino...
76
  	void (*update_time)(struct inode *, struct timespec *, int);
d95852777   Al Viro   make ->atomic_ope...
77
  	int (*atomic_open)(struct inode *, struct dentry *,
30d904947   Al Viro   kill struct opendata
78
  				struct file *, unsigned open_flag,
6c9b1de17   Al Viro   document ->atomic...
79
  				umode_t create_mode);
48bde8d36   Al Viro   Document ->tmpfile()
80
  	int (*tmpfile) (struct inode *, struct dentry *, umode_t);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
81
82
  
  locking rules:
b83be6f20   Christoph Hellwig   update Documentat...
83
  	all may block
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
84
85
86
87
  
  ============	=============================================
  ops		i_rwsem(inode)
  ============	=============================================
965de0ec3   Sean Anderson   Documentation: fi...
88
89
90
91
92
93
94
95
96
  lookup:		shared
  create:		exclusive
  link:		exclusive (both)
  mknod:		exclusive
  symlink:	exclusive
  mkdir:		exclusive
  unlink:		exclusive (both)
  rmdir:		exclusive (both)(see below)
  rename:		exclusive (all)	(see below)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
97
  readlink:	no
6b2553918   Al Viro   replace ->follow_...
98
  get_link:	no
965de0ec3   Sean Anderson   Documentation: fi...
99
  setattr:	exclusive
b74c79e99   Nick Piggin   fs: provide rcu-w...
100
  permission:	no (may not block if called in rcu-walk mode)
4e34e719e   Christoph Hellwig   fs: take the ACL ...
101
  get_acl:	no
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
102
  getattr:	no
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
103
  listxattr:	no
b83be6f20   Christoph Hellwig   update Documentat...
104
  fiemap:		no
c3b2da314   Josef Bacik   fs: introduce ino...
105
  update_time:	no
ff467342d   Jeff Layton   Documentation: at...
106
  atomic_open:	shared (exclusive if O_CREAT is set in open flags)
48bde8d36   Al Viro   Document ->tmpfile()
107
  tmpfile:	no
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
108
  ============	=============================================
c3b2da314   Josef Bacik   fs: introduce ino...
109

6c6ef9f26   Andreas Gruenbacher   xattr: Stop calli...
110

965de0ec3   Sean Anderson   Documentation: fi...
111
112
  	Additionally, ->rmdir(), ->unlink() and ->rename() have ->i_rwsem
  	exclusive on victim.
2773bf00a   Miklos Szeredi   fs: rename "renam...
113
  	cross-directory ->rename() has (per-superblock) ->s_vfs_rename_sem.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
114

ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
115
  See Documentation/filesystems/directory-locking.rst for more detailed discussion
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
116
  of the locking scheme for directory operations.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
117
118
119
120
  xattr_handler operations
  ========================
  
  prototypes::
6c6ef9f26   Andreas Gruenbacher   xattr: Stop calli...
121
122
123
  	bool (*list)(struct dentry *dentry);
  	int (*get)(const struct xattr_handler *handler, struct dentry *dentry,
  		   struct inode *inode, const char *name, void *buffer,
3484eba91   Mark Salyzyn   FROMLIST: Add fla...
124
  		   size_t size, int flags);
6c6ef9f26   Andreas Gruenbacher   xattr: Stop calli...
125
126
127
128
129
130
  	int (*set)(const struct xattr_handler *handler, struct dentry *dentry,
  		   struct inode *inode, const char *name, const void *buffer,
  		   size_t size, int flags);
  
  locking rules:
  	all may block
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
131
132
133
134
  
  =====		==============
  ops		i_rwsem(inode)
  =====		==============
6c6ef9f26   Andreas Gruenbacher   xattr: Stop calli...
135
136
  list:		no
  get:		no
965de0ec3   Sean Anderson   Documentation: fi...
137
  set:		exclusive
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
138
139
140
141
142
143
  =====		==============
  
  super_operations
  ================
  
  prototypes::
6c6ef9f26   Andreas Gruenbacher   xattr: Stop calli...
144

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
145
  	struct inode *(*alloc_inode)(struct super_block *sb);
fdb0da89f   Al Viro   new inode method:...
146
  	void (*free_inode)(struct inode *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
147
  	void (*destroy_inode)(struct inode *);
aa3857295   Christoph Hellwig   fs: pass exact ty...
148
  	void (*dirty_inode) (struct inode *, int flags);
b83be6f20   Christoph Hellwig   update Documentat...
149
  	int (*write_inode) (struct inode *, struct writeback_control *wbc);
336fb3b97   Al Viro   update VFS docume...
150
151
  	int (*drop_inode) (struct inode *);
  	void (*evict_inode) (struct inode *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
152
  	void (*put_super) (struct super_block *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
153
  	int (*sync_fs)(struct super_block *sb, int wait);
c4be0c1dc   Takashi Sato   filesystem freeze...
154
155
  	int (*freeze_fs) (struct super_block *);
  	int (*unfreeze_fs) (struct super_block *);
726c33422   David Howells   [PATCH] VFS: Perm...
156
  	int (*statfs) (struct dentry *, struct kstatfs *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
157
  	int (*remount_fs) (struct super_block *, int *, char *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
158
  	void (*umount_begin) (struct super_block *);
34c80b1d9   Al Viro   vfs: switch ->sho...
159
  	int (*show_options)(struct seq_file *, struct dentry *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
160
161
  	ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
  	ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
b83be6f20   Christoph Hellwig   update Documentat...
162
  	int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
163
164
  
  locking rules:
336fb3b97   Al Viro   update VFS docume...
165
  	All may block [not true, see below]
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
166
167
168
169
  
  ======================	============	========================
  ops			s_umount	note
  ======================	============	========================
7e325d3a6   Christoph Hellwig   update Documentat...
170
  alloc_inode:
fdb0da89f   Al Viro   new inode method:...
171
  free_inode:				called from RCU callback
7e325d3a6   Christoph Hellwig   update Documentat...
172
  destroy_inode:
aa3857295   Christoph Hellwig   fs: pass exact ty...
173
  dirty_inode:
7e325d3a6   Christoph Hellwig   update Documentat...
174
  write_inode:
f283c86af   Dave Chinner   fs: remove inode_...
175
  drop_inode:				!!!inode->i_lock!!!
336fb3b97   Al Viro   update VFS docume...
176
  evict_inode:
7e325d3a6   Christoph Hellwig   update Documentat...
177
  put_super:		write
7e325d3a6   Christoph Hellwig   update Documentat...
178
  sync_fs:		read
06fd516c1   Valerie Aurora   Documentation: Co...
179
180
  freeze_fs:		write
  unfreeze_fs:		write
336fb3b97   Al Viro   update VFS docume...
181
182
  statfs:			maybe(read)	(see below)
  remount_fs:		write
7e325d3a6   Christoph Hellwig   update Documentat...
183
184
185
186
  umount_begin:		no
  show_options:		no		(namespace_sem)
  quota_read:		no		(see below)
  quota_write:		no		(see below)
b83be6f20   Christoph Hellwig   update Documentat...
187
  bdev_try_to_free_page:	no		(see below)
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
188
  ======================	============	========================
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
189

336fb3b97   Al Viro   update VFS docume...
190
191
192
193
194
195
  ->statfs() has s_umount (shared) when called by ustat(2) (native or
  compat), but that's an accident of bad API; s_umount is used to pin
  the superblock down when we only have dev_t given us by userland to
  identify the superblock.  Everything else (statfs(), fstatfs(), etc.)
  doesn't hold it when calling ->statfs() - superblock is pinned down
  by resolving the pathname passed to syscall.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
196

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
197
198
199
200
201
  ->quota_read() and ->quota_write() functions are both guaranteed to
  be the only ones operating on the quota file by the quota code (via
  dqio_sem) (unless an admin really wants to screw up something and
  writes to quota files with quotas on). For other details about locking
  see also dquot_operations section.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
202

b83be6f20   Christoph Hellwig   update Documentat...
203
204
  ->bdev_try_to_free_page is called from the ->releasepage handler of
  the block device inode.  See there for more details.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
205

ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
206
207
208
209
  file_system_type
  ================
  
  prototypes::
b83be6f20   Christoph Hellwig   update Documentat...
210
211
  	struct dentry *(*mount) (struct file_system_type *, int,
  		       const char *, void *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
212
  	void (*kill_sb) (struct super_block *);
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
213

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
214
  locking rules:
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
215
216
217
218
  
  =======		=========
  ops		may block
  =======		=========
b83be6f20   Christoph Hellwig   update Documentat...
219
220
  mount		yes
  kill_sb		yes
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
221
  =======		=========
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
222

1a102ff92   Al Viro   vfs: bury ->get_sb()
223
224
  ->mount() returns ERR_PTR or the root dentry; its superblock should be locked
  on return.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
225

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
226
227
  ->kill_sb() takes a write-locked superblock, does all shutdown work on it,
  unlocks and drops the reference.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
228
229
230
  address_space_operations
  ========================
  prototypes::
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
231
232
  	int (*writepage)(struct page *page, struct writeback_control *wbc);
  	int (*readpage)(struct file *, struct page *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
233
234
  	int (*writepages)(struct address_space *, struct writeback_control *);
  	int (*set_page_dirty)(struct page *page);
8151b4c8b   Matthew Wilcox (Oracle)   mm: add readahead...
235
  	void (*readahead)(struct readahead_control *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
236
237
  	int (*readpages)(struct file *filp, struct address_space *mapping,
  			struct list_head *pages, unsigned nr_pages);
4e02ed4b4   Nick Piggin   fs: remove prepar...
238
239
240
241
242
243
  	int (*write_begin)(struct file *, struct address_space *mapping,
  				loff_t pos, unsigned len, unsigned flags,
  				struct page **pagep, void **fsdata);
  	int (*write_end)(struct file *, struct address_space *mapping,
  				loff_t pos, unsigned len, unsigned copied,
  				struct page *page, void *fsdata);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
244
  	sector_t (*bmap)(struct address_space *, sector_t);
d47992f86   Lukas Czerner   mm: change invali...
245
  	void (*invalidatepage) (struct page *, unsigned int, unsigned int);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
246
  	int (*releasepage) (struct page *, int);
6072d13c4   Linus Torvalds   Call the filesyst...
247
  	void (*freepage)(struct page *);
c8b8e32d7   Christoph Hellwig   direct-io: elimin...
248
  	int (*direct_IO)(struct kiocb *, struct iov_iter *iter);
bda807d44   Minchan Kim   mm: migrate: supp...
249
  	bool (*isolate_page) (struct page *, isolate_mode_t);
b83be6f20   Christoph Hellwig   update Documentat...
250
  	int (*migratepage)(struct address_space *, struct page *, struct page *);
bda807d44   Minchan Kim   mm: migrate: supp...
251
  	void (*putback_page) (struct page *);
b83be6f20   Christoph Hellwig   update Documentat...
252
  	int (*launder_page)(struct page *);
c186afb4d   Al Viro   switch ->is_parti...
253
  	int (*is_partially_uptodate)(struct page *, unsigned long, unsigned long);
b83be6f20   Christoph Hellwig   update Documentat...
254
  	int (*error_remove_page)(struct address_space *, struct page *);
62c230bc1   Mel Gorman   mm: add support f...
255
256
  	int (*swap_activate)(struct file *);
  	int (*swap_deactivate)(struct file *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
257
258
  
  locking rules:
6072d13c4   Linus Torvalds   Call the filesyst...
259
  	All except set_page_dirty and freepage may block
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
260

ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
261
262
263
  ======================	======================== =========
  ops			PageLocked(page)	 i_rwsem
  ======================	======================== =========
b83be6f20   Christoph Hellwig   update Documentat...
264
265
  writepage:		yes, unlocks (see below)
  readpage:		yes, unlocks
b83be6f20   Christoph Hellwig   update Documentat...
266
267
  writepages:
  set_page_dirty		no
8151b4c8b   Matthew Wilcox (Oracle)   mm: add readahead...
268
269
  readahead:		yes, unlocks
  readpages:		no
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
270
271
  write_begin:		locks the page		 exclusive
  write_end:		yes, unlocks		 exclusive
b83be6f20   Christoph Hellwig   update Documentat...
272
273
274
275
276
  bmap:
  invalidatepage:		yes
  releasepage:		yes
  freepage:		yes
  direct_IO:
bda807d44   Minchan Kim   mm: migrate: supp...
277
  isolate_page:		yes
b83be6f20   Christoph Hellwig   update Documentat...
278
  migratepage:		yes (both)
bda807d44   Minchan Kim   mm: migrate: supp...
279
  putback_page:		yes
b83be6f20   Christoph Hellwig   update Documentat...
280
281
282
  launder_page:		yes
  is_partially_uptodate:	yes
  error_remove_page:	yes
62c230bc1   Mel Gorman   mm: add support f...
283
284
  swap_activate:		no
  swap_deactivate:	no
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
285
  ======================	======================== =========
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
286

ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
287
  ->write_begin(), ->write_end() and ->readpage() may be called from
f4e6d844b   Matthew Wilcox   Remove last trace...
288
  the request handler (/dev/loop).
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
289

ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
290
  ->readpage() unlocks the page, either synchronously or via I/O
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
291
  completion.
8151b4c8b   Matthew Wilcox (Oracle)   mm: add readahead...
292
  ->readahead() unlocks the pages that I/O is attempted on like ->readpage().
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
293
  ->readpages() populates the pagecache with the passed pages and starts
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
294
  I/O against them.  They come unlocked upon I/O completion.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
295
  ->writepage() is used for two purposes: for "memory cleansing" and for
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
  "sync".  These are quite different operations and the behaviour may differ
  depending upon the mode.
  
  If writepage is called for sync (wbc->sync_mode != WBC_SYNC_NONE) then
  it *must* start I/O against the page, even if that would involve
  blocking on in-progress I/O.
  
  If writepage is called for memory cleansing (sync_mode ==
  WBC_SYNC_NONE) then its role is to get as much writeout underway as
  possible.  So writepage should try to avoid blocking against
  currently-in-progress I/O.
  
  If the filesystem is not called for "sync" and it determines that it
  would need to block against in-progress I/O to be able to start new I/O
  against the page the filesystem should redirty the page with
  redirty_page_for_writepage(), then unlock the page and return zero.
  This may also be done to avoid internal deadlocks, but rarely.
3a4fa0a25   Robert P. J. Day   Fix misspellings ...
313
  If the filesystem is called for sync then it must wait on any
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
314
  in-progress I/O and then start new I/O.
2054606ad   Nikita Danilov   [PATCH] doc: Lock...
315
316
317
318
319
320
  The filesystem should unlock the page synchronously, before returning to the
  caller, unless ->writepage() returns special WRITEPAGE_ACTIVATE
  value. WRITEPAGE_ACTIVATE means that page cannot really be written out
  currently, and VM should stop calling ->writepage() on this page for some
  time. VM does this by moving page to the head of the active list, hence the
  name.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
  
  Unless the filesystem is going to redirty_page_for_writepage(), unlock the page
  and return zero, writepage *must* run set_page_writeback() against the page,
  followed by unlocking it.  Once set_page_writeback() has been run against the
  page, write I/O can be submitted and the write I/O completion handler must run
  end_page_writeback() once the I/O is complete.  If no I/O is submitted, the
  filesystem must run end_page_writeback() against the page before returning from
  writepage.
  
  That is: after 2.5.12, pages which are under writeout are *not* locked.  Note,
  if the filesystem needs the page to be locked during writeout, that is ok, too,
  the page is allowed to be unlocked at any point in time between the calls to
  set_page_writeback() and end_page_writeback().
  
  Note, failure to run either redirty_page_for_writepage() or the combination of
  set_page_writeback()/end_page_writeback() on a page submitted to writepage
  will leave the page itself marked clean but it will be tagged as dirty in the
  radix tree.  This incoherency can lead to all sorts of hard-to-debug problems
  in the filesystem like having dirty inodes at umount and losing written data.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
340
  ->writepages() is used for periodic writeback and for syscall-initiated
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
341
  sync operations.  The address_space should start I/O against at least
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
342
343
344
345
  ``*nr_to_write`` pages.  ``*nr_to_write`` must be decremented for each page
  which is written.  The address_space implementation may write more (or less)
  pages than ``*nr_to_write`` asks for, but it should try to be reasonably close.
  If nr_to_write is NULL, all dirty pages must be written.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
346
347
348
  
  writepages should _only_ write pages which are present on
  mapping->io_pages.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
349
  ->set_page_dirty() is called from various places in the kernel
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
350
351
352
  when the target page is marked as needing writeback.  It may be called
  under spinlock (it cannot block) and is sometimes called with the page
  not locked.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
353
  ->bmap() is currently used by legacy ioctl() (FIBMAP) provided by some
b83be6f20   Christoph Hellwig   update Documentat...
354
355
  filesystems and by the swapper. The latter will eventually go away.  Please,
  keep it that way and don't breed new callers.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
356

ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
357
  ->invalidatepage() is called when the filesystem must attempt to drop
d47992f86   Lukas Czerner   mm: change invali...
358
359
  some or all of the buffers from the page when it is being truncated. It
  returns zero on success. If ->invalidatepage is zero, the kernel uses
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
360
  block_invalidatepage() instead.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
361
  ->releasepage() is called when the kernel is about to try to drop the
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
362
363
364
  buffers from the page in preparation for freeing it.  It returns zero to
  indicate that the buffers are (or may be) freeable.  If ->releasepage is zero,
  the kernel assumes that the fs has no private interest in the buffers.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
365
  ->freepage() is called when the kernel is done dropping the page
6072d13c4   Linus Torvalds   Call the filesyst...
366
  from the page cache.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
367
  ->launder_page() may be called prior to releasing a page if
e3db7691e   Trond Myklebust   [PATCH] NFS: Fix ...
368
369
370
371
  it is still found to be dirty. It returns zero if the page was successfully
  cleaned, or an error value if not. Note that in order to prevent the page
  getting mapped back in and redirtied, it needs to be kept locked
  across the entire operation.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
372
  ->swap_activate will be called with a non-zero argument on
62c230bc1   Mel Gorman   mm: add support f...
373
374
375
376
  files backing (non block device backed) swapfiles. A return value
  of zero indicates success, in which case this file can be used for
  backing swapspace. The swapspace operations will be proxied to the
  address space operations.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
377
  ->swap_deactivate() will be called in the sys_swapoff()
62c230bc1   Mel Gorman   mm: add support f...
378
  path after ->swap_activate() returned success.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
379
380
381
382
  file_lock_operations
  ====================
  
  prototypes::
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
383
384
385
386
387
  	void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
  	void (*fl_release_private)(struct file_lock *);
  
  
  locking rules:
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
388
389
390
391
  
  ===================	=============	=========
  ops			inode->i_lock	may block
  ===================	=============	=========
b83be6f20   Christoph Hellwig   update Documentat...
392
  fl_copy_lock:		yes		no
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
393
394
395
396
397
398
399
  fl_release_private:	maybe		maybe[1]_
  ===================	=============	=========
  
  .. [1]:
     ->fl_release_private for flock or POSIX locks is currently allowed
     to block. Leases however can still be freed while the i_lock is held and
     so fl_release_private called on a lease should not block.
2ece173e4   Jeff Layton   locks: update Loc...
400

ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
401
402
403
404
  lock_manager_operations
  =======================
  
  prototypes::
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
405

8fb47a4fb   J. Bruce Fields   locks: rename loc...
406
407
  	void (*lm_notify)(struct file_lock *);  /* unblock callback */
  	int (*lm_grant)(struct file_lock *, struct file_lock *, int);
8fb47a4fb   J. Bruce Fields   locks: rename loc...
408
409
  	void (*lm_break)(struct file_lock *); /* break_lease callback */
  	int (*lm_change)(struct file_lock **, int);
28df3d153   J. Bruce Fields   nfsd: clients don...
410
  	bool (*lm_breaker_owns_lease)(struct file_lock *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
411
412
  
  locking rules:
1c8c601a8   Jeff Layton   locks: protect mo...
413

6cbef2adb   Randy Dunlap   Documentation: fi...
414
  ======================	=============	=================	=========
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
415
  ops			inode->i_lock	blocked_lock_lock	may block
6cbef2adb   Randy Dunlap   Documentation: fi...
416
  ======================	=============	=================	=========
7b2296afb   Jeff Layton   locks: give the b...
417
418
419
420
  lm_notify:		yes		yes			no
  lm_grant:		no		no			no
  lm_break:		yes		no			no
  lm_change		yes		no			no
28df3d153   J. Bruce Fields   nfsd: clients don...
421
  lm_breaker_owns_lease:	no		no			no
6cbef2adb   Randy Dunlap   Documentation: fi...
422
  ======================	=============	=================	=========
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
423
424
425
426
427
  
  buffer_head
  ===========
  
  prototypes::
1c8c601a8   Jeff Layton   locks: protect mo...
428

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
429
430
431
  	void (*b_end_io)(struct buffer_head *bh, int uptodate);
  
  locking rules:
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
432
433
  
  called from interrupts. In other words, extreme care is needed here.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
434
435
436
  bh is locked, but that's all warranties we have here. Currently only RAID1,
  highmem, fs/buffer.c, and fs/ntfs/aops.c are providing these. Block devices
  call this method upon the IO completion.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
437
438
439
  block_device_operations
  =======================
  prototypes::
e1455d1bd   Christoph Hellwig   update block_devi...
440
441
442
443
  	int (*open) (struct block_device *, fmode_t);
  	int (*release) (struct gendisk *, fmode_t);
  	int (*ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
  	int (*compat_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
7a9eb2066   Dan Williams   pmem: kill __pmem...
444
  	int (*direct_access) (struct block_device *, sector_t, void **,
e2e05394e   Ross Zwisler   pmem, dax: have d...
445
  				unsigned long *);
e1455d1bd   Christoph Hellwig   update block_devi...
446
  	void (*unlock_native_capacity) (struct gendisk *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
447
  	int (*revalidate_disk) (struct gendisk *);
e1455d1bd   Christoph Hellwig   update block_devi...
448
449
  	int (*getgeo)(struct block_device *, struct hd_geometry *);
  	void (*swap_slot_free_notify) (struct block_device *, unsigned long);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
450
451
  
  locking rules:
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
452
453
454
455
  
  ======================= ===================
  ops			bd_mutex
  ======================= ===================
b83be6f20   Christoph Hellwig   update Documentat...
456
457
458
459
460
  open:			yes
  release:		yes
  ioctl:			no
  compat_ioctl:		no
  direct_access:		no
b83be6f20   Christoph Hellwig   update Documentat...
461
462
463
464
  unlock_native_capacity:	no
  revalidate_disk:	no
  getgeo:			no
  swap_slot_free_notify:	no	(see below)
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
465
  ======================= ===================
e1455d1bd   Christoph Hellwig   update block_devi...
466

e1455d1bd   Christoph Hellwig   update block_devi...
467
468
  swap_slot_free_notify is called with swap_lock and sometimes the page lock
  held.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
469

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
470

ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
471
472
473
474
  file_operations
  ===============
  
  prototypes::
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
475
476
  	loff_t (*llseek) (struct file *, loff_t, int);
  	ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
477
  	ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
293bc9822   Al Viro   new methods: ->re...
478
479
  	ssize_t (*read_iter) (struct kiocb *, struct iov_iter *);
  	ssize_t (*write_iter) (struct kiocb *, struct iov_iter *);
2233f31aa   Al Viro   [readdir] ->readd...
480
  	int (*iterate) (struct file *, struct dir_context *);
965de0ec3   Sean Anderson   Documentation: fi...
481
  	int (*iterate_shared) (struct file *, struct dir_context *);
6e8b704df   Christoph Hellwig   fs: update docume...
482
  	__poll_t (*poll) (struct file *, struct poll_table_struct *);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
483
484
485
486
487
488
  	long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
  	long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
  	int (*mmap) (struct file *, struct vm_area_struct *);
  	int (*open) (struct inode *, struct file *);
  	int (*flush) (struct file *);
  	int (*release) (struct inode *, struct file *);
02c24a821   Josef Bacik   fs: push i_mutex ...
489
  	int (*fsync) (struct file *, loff_t start, loff_t end, int datasync);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
490
491
492
493
494
495
496
497
498
499
500
501
502
  	int (*fasync) (int, struct file *, int);
  	int (*lock) (struct file *, int, struct file_lock *);
  	ssize_t (*readv) (struct file *, const struct iovec *, unsigned long,
  			loff_t *);
  	ssize_t (*writev) (struct file *, const struct iovec *, unsigned long,
  			loff_t *);
  	ssize_t (*sendfile) (struct file *, loff_t *, size_t, read_actor_t,
  			void __user *);
  	ssize_t (*sendpage) (struct file *, struct page *, int, size_t,
  			loff_t *, int);
  	unsigned long (*get_unmapped_area)(struct file *, unsigned long,
  			unsigned long, unsigned long, unsigned long);
  	int (*check_flags)(int);
b83be6f20   Christoph Hellwig   update Documentat...
503
504
505
506
507
  	int (*flock) (struct file *, int, struct file_lock *);
  	ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *,
  			size_t, unsigned int);
  	ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *,
  			size_t, unsigned int);
e6f5c7893   Jeff Layton   locks: plumb a "p...
508
  	int (*setlease)(struct file *, long, struct file_lock **, void **);
2fe17c107   Christoph Hellwig   fallocate should ...
509
  	long (*fallocate)(struct file *, int, loff_t, loff_t);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
510
511
  
  locking rules:
a11e1d432   Linus Torvalds   Revert changes to...
512
  	All may block.
b83be6f20   Christoph Hellwig   update Documentat...
513

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
514
515
516
517
  ->llseek() locking has moved from llseek to the individual llseek
  implementations.  If your fs is not using generic_file_llseek, you
  need to acquire and release the appropriate locks in your ->llseek().
  For many filesystems, it is probably safe to acquire the inode
866707fc2   Jan Blunck   Documentation/fil...
518
519
520
  mutex or just to use i_size_read() instead.
  Note: this does not protect the file->f_pos against concurrent modifications
  since this is something the userspace has to take care about.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
521

965de0ec3   Sean Anderson   Documentation: fi...
522
523
524
  ->iterate() is called with i_rwsem exclusive.
  
  ->iterate_shared() is called with i_rwsem at least shared.
b83be6f20   Christoph Hellwig   update Documentat...
525
526
527
528
  ->fasync() is responsible for maintaining the FASYNC bit in filp->f_flags.
  Most instances call fasync_helper(), which does that maintenance, so it's
  not normally something one needs to worry about.  Return values > 0 will be
  mapped to zero in the VFS layer.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
529
530
531
532
533
534
  
  ->readdir() and ->ioctl() on directories must be changed. Ideally we would
  move ->readdir() to inode_operations and use a separate method for directory
  ->ioctl() or kill the latter completely. One of the problems is that for
  anything that resembles union-mount we won't have a struct file for all
  components. And there are other reasons why the current interface is a mess...
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
535
536
  ->read on directories probably must go away - we should just enforce -EISDIR
  in sys_read() and friends.
f82b4b678   Jeff Layton   locks: move i_loc...
537
538
539
  ->setlease operations should call generic_setlease() before or after setting
  the lease within the individual filesystem to record the result of the
  operation
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
540
541
542
543
  dquot_operations
  ================
  
  prototypes::
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
544
545
546
547
548
549
550
551
552
553
  	int (*write_dquot) (struct dquot *);
  	int (*acquire_dquot) (struct dquot *);
  	int (*release_dquot) (struct dquot *);
  	int (*mark_dirty) (struct dquot *);
  	int (*write_info) (struct super_block *, int);
  
  These operations are intended to be more or less wrapping functions that ensure
  a proper locking wrt the filesystem and call the generic quota operations.
  
  What filesystem should expect from the generic quota functions:
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
554
555
556
  ==============	============	=========================
  ops		FS recursion	Held locks when called
  ==============	============	=========================
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
557
558
559
560
561
  write_dquot:	yes		dqonoff_sem or dqptr_sem
  acquire_dquot:	yes		dqonoff_sem or dqptr_sem
  release_dquot:	yes		dqonoff_sem or dqptr_sem
  mark_dirty:	no		-
  write_info:	yes		dqonoff_sem
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
562
  ==============	============	=========================
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
563
564
565
  
  FS recursion means calling ->quota_read() and ->quota_write() from superblock
  operations.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
566
  More details about quota locking can be found in fs/dquot.c.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
567
568
569
570
  vm_operations_struct
  ====================
  
  prototypes::
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
571
572
  	void (*open)(struct vm_area_struct*);
  	void (*close)(struct vm_area_struct*);
fe3136f44   Souptick Joarder   mm: Introduce new...
573
574
575
  	vm_fault_t (*fault)(struct vm_area_struct*, struct vm_fault *);
  	vm_fault_t (*page_mkwrite)(struct vm_area_struct *, struct vm_fault *);
  	vm_fault_t (*pfn_mkwrite)(struct vm_area_struct *, struct vm_fault *);
28b2ee20c   Rik van Riel   access_process_vm...
576
  	int (*access)(struct vm_area_struct *, unsigned long, void*, int, int);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
577
578
  
  locking rules:
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
579

6cbef2adb   Randy Dunlap   Documentation: fi...
580
  =============	=========	===========================
c1e8d7c6a   Michel Lespinasse   mmap locking API:...
581
  ops		mmap_lock	PageLocked(page)
6cbef2adb   Randy Dunlap   Documentation: fi...
582
  =============	=========	===========================
b83be6f20   Christoph Hellwig   update Documentat...
583
584
585
  open:		yes
  close:		yes
  fault:		yes		can return with page locked
8c6e50b02   Kirill A. Shutemov   mm: introduce vm_...
586
  map_pages:	yes
b83be6f20   Christoph Hellwig   update Documentat...
587
  page_mkwrite:	yes		can return with page locked
dd9061846   Boaz Harrosh   mm: new pfn_mkwri...
588
  pfn_mkwrite:	yes
b83be6f20   Christoph Hellwig   update Documentat...
589
  access:		yes
6cbef2adb   Randy Dunlap   Documentation: fi...
590
  =============	=========	===========================
ed2f2f9b3   Mark Fasheh   Document ->page_m...
591

ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
592
  ->fault() is called when a previously not present pte is about
b827e496c   Nick Piggin   mm: close page_mk...
593
594
595
596
597
598
  to be faulted in. The filesystem must find and return the page associated
  with the passed in "pgoff" in the vm_fault structure. If it is possible that
  the page may be truncated and/or invalidated, then the filesystem must lock
  the page, then ensure it is not already truncated (the page lock will block
  subsequent truncate), and then return with VM_FAULT_LOCKED, and the page
  locked. The VM will unlock the page.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
599
  ->map_pages() is called when VM asks to map easy accessible pages.
bae473a42   Kirill A. Shutemov   mm: introduce fau...
600
601
  Filesystem should find and map pages associated with offsets from "start_pgoff"
  till "end_pgoff". ->map_pages() is called with page table locked and must
8c6e50b02   Kirill A. Shutemov   mm: introduce vm_...
602
603
  not block.  If it's not possible to reach a page without blocking,
  filesystem should skip it. Filesystem should use do_set_pte() to setup
bae473a42   Kirill A. Shutemov   mm: introduce fau...
604
  page table entry. Pointer to entry associated with the page is passed in
82b0f8c39   Jan Kara   mm: join struct f...
605
  "pte" field in vm_fault structure. Pointers to entries for other offsets
bae473a42   Kirill A. Shutemov   mm: introduce fau...
606
  should be calculated relative to "pte".
8c6e50b02   Kirill A. Shutemov   mm: introduce vm_...
607

ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
608
  ->page_mkwrite() is called when a previously read-only pte is
b827e496c   Nick Piggin   mm: close page_mk...
609
610
611
612
613
  about to become writeable. The filesystem again must ensure that there are
  no truncate/invalidate races, and then return with the page locked. If
  the page has been truncated, the filesystem should not look up a new page
  like the ->fault() handler, but simply return with VM_FAULT_NOPAGE, which
  will cause the VM to retry the fault.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
614

ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
615
  ->pfn_mkwrite() is the same as page_mkwrite but when the pte is
dd9061846   Boaz Harrosh   mm: new pfn_mkwri...
616
617
618
619
  VM_PFNMAP or VM_MIXEDMAP with a page-less entry. Expected return is
  VM_FAULT_NOPAGE. Or one of the VM_FAULT_ERROR types. The default behavior
  after this call is to make the pte read-write, unless pfn_mkwrite returns
  an error.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
620
  ->access() is called when get_user_pages() fails in
507da6a1f   Stefan Weil   doc: Fix typo (ac...
621
  access_process_vm(), typically used to debug a process through
28b2ee20c   Rik van Riel   access_process_vm...
622
623
  /proc/pid/mem or ptrace.  This function is needed only for
  VM_IO | VM_PFNMAP VMAs.
ec23eb54f   Mauro Carvalho Chehab   docs: fs: convert...
624
  --------------------------------------------------------------------------------
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
625
626
627
628
  			Dubious stuff
  
  (if you break something or notice that it is broken and do not fix it yourself
  - at least put it here)