Merge branch 'kvm-updates/2.6.37' of git://git.kernel.org/pub/scm/virt/kvm/kvm
[~shefty/rdma-dev.git] / Documentation / filesystems / Locking
1         The text below describes the locking rules for VFS-related methods.
2 It is (believed to be) up-to-date. *Please*, if you change anything in
3 prototypes or locking protocols - update this file. And update the relevant
4 instances in the tree, don't leave that to maintainers of filesystems/devices/
5 etc. At the very least, put the list of dubious cases in the end of this file.
6 Don't turn it into log - maintainers of out-of-the-tree code are supposed to
7 be able to use diff(1).
8         Thing currently missing here: socket operations. Alexey?
9
10 --------------------------- dentry_operations --------------------------
11 prototypes:
12         int (*d_revalidate)(struct dentry *, int);
13         int (*d_hash) (struct dentry *, struct qstr *);
14         int (*d_compare) (struct dentry *, struct qstr *, struct qstr *);
15         int (*d_delete)(struct dentry *);
16         void (*d_release)(struct dentry *);
17         void (*d_iput)(struct dentry *, struct inode *);
18         char *(*d_dname)((struct dentry *dentry, char *buffer, int buflen);
19
20 locking rules:
21                 dcache_lock     rename_lock     ->d_lock        may block
22 d_revalidate:   no              no              no              yes
23 d_hash          no              no              no              yes
24 d_compare:      no              yes             no              no 
25 d_delete:       yes             no              yes             no
26 d_release:      no              no              no              yes
27 d_iput:         no              no              no              yes
28 d_dname:        no              no              no              no
29
30 --------------------------- inode_operations --------------------------- 
31 prototypes:
32         int (*create) (struct inode *,struct dentry *,int, struct nameidata *);
33         struct dentry * (*lookup) (struct inode *,struct dentry *, struct nameid
34 ata *);
35         int (*link) (struct dentry *,struct inode *,struct dentry *);
36         int (*unlink) (struct inode *,struct dentry *);
37         int (*symlink) (struct inode *,struct dentry *,const char *);
38         int (*mkdir) (struct inode *,struct dentry *,int);
39         int (*rmdir) (struct inode *,struct dentry *);
40         int (*mknod) (struct inode *,struct dentry *,int,dev_t);
41         int (*rename) (struct inode *, struct dentry *,
42                         struct inode *, struct dentry *);
43         int (*readlink) (struct dentry *, char __user *,int);
44         void * (*follow_link) (struct dentry *, struct nameidata *);
45         void (*put_link) (struct dentry *, struct nameidata *, void *);
46         void (*truncate) (struct inode *);
47         int (*permission) (struct inode *, int, struct nameidata *);
48         int (*check_acl)(struct inode *, int);
49         int (*setattr) (struct dentry *, struct iattr *);
50         int (*getattr) (struct vfsmount *, struct dentry *, struct kstat *);
51         int (*setxattr) (struct dentry *, const char *,const void *,size_t,int);
52         ssize_t (*getxattr) (struct dentry *, const char *, void *, size_t);
53         ssize_t (*listxattr) (struct dentry *, char *, size_t);
54         int (*removexattr) (struct dentry *, const char *);
55         void (*truncate_range)(struct inode *, loff_t, loff_t);
56         long (*fallocate)(struct inode *inode, int mode, loff_t offset, loff_t len);
57         int (*fiemap)(struct inode *, struct fiemap_extent_info *, u64 start, u64 len);
58
59 locking rules:
60         all may block
61                 i_mutex(inode)
62 lookup:         yes
63 create:         yes
64 link:           yes (both)
65 mknod:          yes
66 symlink:        yes
67 mkdir:          yes
68 unlink:         yes (both)
69 rmdir:          yes (both)      (see below)
70 rename:         yes (all)       (see below)
71 readlink:       no
72 follow_link:    no
73 put_link:       no
74 truncate:       yes             (see below)
75 setattr:        yes
76 permission:     no
77 check_acl:      no
78 getattr:        no
79 setxattr:       yes
80 getxattr:       no
81 listxattr:      no
82 removexattr:    yes
83 truncate_range: yes
84 fallocate:      no
85 fiemap:         no
86         Additionally, ->rmdir(), ->unlink() and ->rename() have ->i_mutex on
87 victim.
88         cross-directory ->rename() has (per-superblock) ->s_vfs_rename_sem.
89         ->truncate() is never called directly - it's a callback, not a
90 method. It's called by vmtruncate() - deprecated library function used by
91 ->setattr(). Locking information above applies to that call (i.e. is
92 inherited from ->setattr() - vmtruncate() is used when ATTR_SIZE had been
93 passed).
94
95 See Documentation/filesystems/directory-locking for more detailed discussion
96 of the locking scheme for directory operations.
97
98 --------------------------- super_operations ---------------------------
99 prototypes:
100         struct inode *(*alloc_inode)(struct super_block *sb);
101         void (*destroy_inode)(struct inode *);
102         void (*dirty_inode) (struct inode *);
103         int (*write_inode) (struct inode *, struct writeback_control *wbc);
104         int (*drop_inode) (struct inode *);
105         void (*evict_inode) (struct inode *);
106         void (*put_super) (struct super_block *);
107         void (*write_super) (struct super_block *);
108         int (*sync_fs)(struct super_block *sb, int wait);
109         int (*freeze_fs) (struct super_block *);
110         int (*unfreeze_fs) (struct super_block *);
111         int (*statfs) (struct dentry *, struct kstatfs *);
112         int (*remount_fs) (struct super_block *, int *, char *);
113         void (*umount_begin) (struct super_block *);
114         int (*show_options)(struct seq_file *, struct vfsmount *);
115         ssize_t (*quota_read)(struct super_block *, int, char *, size_t, loff_t);
116         ssize_t (*quota_write)(struct super_block *, int, const char *, size_t, loff_t);
117         int (*bdev_try_to_free_page)(struct super_block*, struct page*, gfp_t);
118         int (*trim_fs) (struct super_block *, struct fstrim_range *);
119
120 locking rules:
121         All may block [not true, see below]
122                         s_umount
123 alloc_inode:
124 destroy_inode:
125 dirty_inode:                            (must not sleep)
126 write_inode:
127 drop_inode:                             !!!inode_lock!!!
128 evict_inode:
129 put_super:              write
130 write_super:            read
131 sync_fs:                read
132 freeze_fs:              read
133 unfreeze_fs:            read
134 statfs:                 maybe(read)     (see below)
135 remount_fs:             write
136 umount_begin:           no
137 show_options:           no              (namespace_sem)
138 quota_read:             no              (see below)
139 quota_write:            no              (see below)
140 bdev_try_to_free_page:  no              (see below)
141 trim_fs:                no
142
143 ->statfs() has s_umount (shared) when called by ustat(2) (native or
144 compat), but that's an accident of bad API; s_umount is used to pin
145 the superblock down when we only have dev_t given us by userland to
146 identify the superblock.  Everything else (statfs(), fstatfs(), etc.)
147 doesn't hold it when calling ->statfs() - superblock is pinned down
148 by resolving the pathname passed to syscall.
149 ->quota_read() and ->quota_write() functions are both guaranteed to
150 be the only ones operating on the quota file by the quota code (via
151 dqio_sem) (unless an admin really wants to screw up something and
152 writes to quota files with quotas on). For other details about locking
153 see also dquot_operations section.
154 ->bdev_try_to_free_page is called from the ->releasepage handler of
155 the block device inode.  See there for more details.
156
157 --------------------------- file_system_type ---------------------------
158 prototypes:
159         int (*get_sb) (struct file_system_type *, int,
160                        const char *, void *, struct vfsmount *);
161         struct dentry *(*mount) (struct file_system_type *, int,
162                        const char *, void *);
163         void (*kill_sb) (struct super_block *);
164 locking rules:
165                 may block
166 get_sb          yes
167 mount           yes
168 kill_sb         yes
169
170 ->get_sb() returns error or 0 with locked superblock attached to the vfsmount
171 (exclusive on ->s_umount).
172 ->mount() returns ERR_PTR or the root dentry.
173 ->kill_sb() takes a write-locked superblock, does all shutdown work on it,
174 unlocks and drops the reference.
175
176 --------------------------- address_space_operations --------------------------
177 prototypes:
178         int (*writepage)(struct page *page, struct writeback_control *wbc);
179         int (*readpage)(struct file *, struct page *);
180         int (*sync_page)(struct page *);
181         int (*writepages)(struct address_space *, struct writeback_control *);
182         int (*set_page_dirty)(struct page *page);
183         int (*readpages)(struct file *filp, struct address_space *mapping,
184                         struct list_head *pages, unsigned nr_pages);
185         int (*write_begin)(struct file *, struct address_space *mapping,
186                                 loff_t pos, unsigned len, unsigned flags,
187                                 struct page **pagep, void **fsdata);
188         int (*write_end)(struct file *, struct address_space *mapping,
189                                 loff_t pos, unsigned len, unsigned copied,
190                                 struct page *page, void *fsdata);
191         sector_t (*bmap)(struct address_space *, sector_t);
192         int (*invalidatepage) (struct page *, unsigned long);
193         int (*releasepage) (struct page *, int);
194         void (*freepage)(struct page *);
195         int (*direct_IO)(int, struct kiocb *, const struct iovec *iov,
196                         loff_t offset, unsigned long nr_segs);
197         int (*get_xip_mem)(struct address_space *, pgoff_t, int, void **,
198                                 unsigned long *);
199         int (*migratepage)(struct address_space *, struct page *, struct page *);
200         int (*launder_page)(struct page *);
201         int (*is_partially_uptodate)(struct page *, read_descriptor_t *, unsigned long);
202         int (*error_remove_page)(struct address_space *, struct page *);
203
204 locking rules:
205         All except set_page_dirty and freepage may block
206
207                         PageLocked(page)        i_mutex
208 writepage:              yes, unlocks (see below)
209 readpage:               yes, unlocks
210 sync_page:              maybe
211 writepages:
212 set_page_dirty          no
213 readpages:
214 write_begin:            locks the page          yes
215 write_end:              yes, unlocks            yes
216 bmap:
217 invalidatepage:         yes
218 releasepage:            yes
219 freepage:               yes
220 direct_IO:
221 get_xip_mem:                                    maybe
222 migratepage:            yes (both)
223 launder_page:           yes
224 is_partially_uptodate:  yes
225 error_remove_page:      yes
226
227         ->write_begin(), ->write_end(), ->sync_page() and ->readpage()
228 may be called from the request handler (/dev/loop).
229
230         ->readpage() unlocks the page, either synchronously or via I/O
231 completion.
232
233         ->readpages() populates the pagecache with the passed pages and starts
234 I/O against them.  They come unlocked upon I/O completion.
235
236         ->writepage() is used for two purposes: for "memory cleansing" and for
237 "sync".  These are quite different operations and the behaviour may differ
238 depending upon the mode.
239
240 If writepage is called for sync (wbc->sync_mode != WBC_SYNC_NONE) then
241 it *must* start I/O against the page, even if that would involve
242 blocking on in-progress I/O.
243
244 If writepage is called for memory cleansing (sync_mode ==
245 WBC_SYNC_NONE) then its role is to get as much writeout underway as
246 possible.  So writepage should try to avoid blocking against
247 currently-in-progress I/O.
248
249 If the filesystem is not called for "sync" and it determines that it
250 would need to block against in-progress I/O to be able to start new I/O
251 against the page the filesystem should redirty the page with
252 redirty_page_for_writepage(), then unlock the page and return zero.
253 This may also be done to avoid internal deadlocks, but rarely.
254
255 If the filesystem is called for sync then it must wait on any
256 in-progress I/O and then start new I/O.
257
258 The filesystem should unlock the page synchronously, before returning to the
259 caller, unless ->writepage() returns special WRITEPAGE_ACTIVATE
260 value. WRITEPAGE_ACTIVATE means that page cannot really be written out
261 currently, and VM should stop calling ->writepage() on this page for some
262 time. VM does this by moving page to the head of the active list, hence the
263 name.
264
265 Unless the filesystem is going to redirty_page_for_writepage(), unlock the page
266 and return zero, writepage *must* run set_page_writeback() against the page,
267 followed by unlocking it.  Once set_page_writeback() has been run against the
268 page, write I/O can be submitted and the write I/O completion handler must run
269 end_page_writeback() once the I/O is complete.  If no I/O is submitted, the
270 filesystem must run end_page_writeback() against the page before returning from
271 writepage.
272
273 That is: after 2.5.12, pages which are under writeout are *not* locked.  Note,
274 if the filesystem needs the page to be locked during writeout, that is ok, too,
275 the page is allowed to be unlocked at any point in time between the calls to
276 set_page_writeback() and end_page_writeback().
277
278 Note, failure to run either redirty_page_for_writepage() or the combination of
279 set_page_writeback()/end_page_writeback() on a page submitted to writepage
280 will leave the page itself marked clean but it will be tagged as dirty in the
281 radix tree.  This incoherency can lead to all sorts of hard-to-debug problems
282 in the filesystem like having dirty inodes at umount and losing written data.
283
284         ->sync_page() locking rules are not well-defined - usually it is called
285 with lock on page, but that is not guaranteed. Considering the currently
286 existing instances of this method ->sync_page() itself doesn't look
287 well-defined...
288
289         ->writepages() is used for periodic writeback and for syscall-initiated
290 sync operations.  The address_space should start I/O against at least
291 *nr_to_write pages.  *nr_to_write must be decremented for each page which is
292 written.  The address_space implementation may write more (or less) pages
293 than *nr_to_write asks for, but it should try to be reasonably close.  If
294 nr_to_write is NULL, all dirty pages must be written.
295
296 writepages should _only_ write pages which are present on
297 mapping->io_pages.
298
299         ->set_page_dirty() is called from various places in the kernel
300 when the target page is marked as needing writeback.  It may be called
301 under spinlock (it cannot block) and is sometimes called with the page
302 not locked.
303
304         ->bmap() is currently used by legacy ioctl() (FIBMAP) provided by some
305 filesystems and by the swapper. The latter will eventually go away.  Please,
306 keep it that way and don't breed new callers.
307
308         ->invalidatepage() is called when the filesystem must attempt to drop
309 some or all of the buffers from the page when it is being truncated.  It
310 returns zero on success.  If ->invalidatepage is zero, the kernel uses
311 block_invalidatepage() instead.
312
313         ->releasepage() is called when the kernel is about to try to drop the
314 buffers from the page in preparation for freeing it.  It returns zero to
315 indicate that the buffers are (or may be) freeable.  If ->releasepage is zero,
316 the kernel assumes that the fs has no private interest in the buffers.
317
318         ->freepage() is called when the kernel is done dropping the page
319 from the page cache.
320
321         ->launder_page() may be called prior to releasing a page if
322 it is still found to be dirty. It returns zero if the page was successfully
323 cleaned, or an error value if not. Note that in order to prevent the page
324 getting mapped back in and redirtied, it needs to be kept locked
325 across the entire operation.
326
327 ----------------------- file_lock_operations ------------------------------
328 prototypes:
329         void (*fl_copy_lock)(struct file_lock *, struct file_lock *);
330         void (*fl_release_private)(struct file_lock *);
331
332
333 locking rules:
334                         file_lock_lock  may block
335 fl_copy_lock:           yes             no
336 fl_release_private:     maybe           no
337
338 ----------------------- lock_manager_operations ---------------------------
339 prototypes:
340         int (*fl_compare_owner)(struct file_lock *, struct file_lock *);
341         void (*fl_notify)(struct file_lock *);  /* unblock callback */
342         int (*fl_grant)(struct file_lock *, struct file_lock *, int);
343         void (*fl_release_private)(struct file_lock *);
344         void (*fl_break)(struct file_lock *); /* break_lease callback */
345         int (*fl_mylease)(struct file_lock *, struct file_lock *);
346         int (*fl_change)(struct file_lock **, int);
347
348 locking rules:
349                         file_lock_lock  may block
350 fl_compare_owner:       yes             no
351 fl_notify:              yes             no
352 fl_grant:               no              no
353 fl_release_private:     maybe           no
354 fl_break:               yes             no
355 fl_mylease:             yes             no
356 fl_change               yes             no
357
358 --------------------------- buffer_head -----------------------------------
359 prototypes:
360         void (*b_end_io)(struct buffer_head *bh, int uptodate);
361
362 locking rules:
363         called from interrupts. In other words, extreme care is needed here.
364 bh is locked, but that's all warranties we have here. Currently only RAID1,
365 highmem, fs/buffer.c, and fs/ntfs/aops.c are providing these. Block devices
366 call this method upon the IO completion.
367
368 --------------------------- block_device_operations -----------------------
369 prototypes:
370         int (*open) (struct block_device *, fmode_t);
371         int (*release) (struct gendisk *, fmode_t);
372         int (*ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
373         int (*compat_ioctl) (struct block_device *, fmode_t, unsigned, unsigned long);
374         int (*direct_access) (struct block_device *, sector_t, void **, unsigned long *);
375         int (*media_changed) (struct gendisk *);
376         void (*unlock_native_capacity) (struct gendisk *);
377         int (*revalidate_disk) (struct gendisk *);
378         int (*getgeo)(struct block_device *, struct hd_geometry *);
379         void (*swap_slot_free_notify) (struct block_device *, unsigned long);
380
381 locking rules:
382                         bd_mutex
383 open:                   yes
384 release:                yes
385 ioctl:                  no
386 compat_ioctl:           no
387 direct_access:          no
388 media_changed:          no
389 unlock_native_capacity: no
390 revalidate_disk:        no
391 getgeo:                 no
392 swap_slot_free_notify:  no      (see below)
393
394 media_changed, unlock_native_capacity and revalidate_disk are called only from
395 check_disk_change().
396
397 swap_slot_free_notify is called with swap_lock and sometimes the page lock
398 held.
399
400
401 --------------------------- file_operations -------------------------------
402 prototypes:
403         loff_t (*llseek) (struct file *, loff_t, int);
404         ssize_t (*read) (struct file *, char __user *, size_t, loff_t *);
405         ssize_t (*write) (struct file *, const char __user *, size_t, loff_t *);
406         ssize_t (*aio_read) (struct kiocb *, const struct iovec *, unsigned long, loff_t);
407         ssize_t (*aio_write) (struct kiocb *, const struct iovec *, unsigned long, loff_t);
408         int (*readdir) (struct file *, void *, filldir_t);
409         unsigned int (*poll) (struct file *, struct poll_table_struct *);
410         long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
411         long (*compat_ioctl) (struct file *, unsigned int, unsigned long);
412         int (*mmap) (struct file *, struct vm_area_struct *);
413         int (*open) (struct inode *, struct file *);
414         int (*flush) (struct file *);
415         int (*release) (struct inode *, struct file *);
416         int (*fsync) (struct file *, int datasync);
417         int (*aio_fsync) (struct kiocb *, int datasync);
418         int (*fasync) (int, struct file *, int);
419         int (*lock) (struct file *, int, struct file_lock *);
420         ssize_t (*readv) (struct file *, const struct iovec *, unsigned long,
421                         loff_t *);
422         ssize_t (*writev) (struct file *, const struct iovec *, unsigned long,
423                         loff_t *);
424         ssize_t (*sendfile) (struct file *, loff_t *, size_t, read_actor_t,
425                         void __user *);
426         ssize_t (*sendpage) (struct file *, struct page *, int, size_t,
427                         loff_t *, int);
428         unsigned long (*get_unmapped_area)(struct file *, unsigned long,
429                         unsigned long, unsigned long, unsigned long);
430         int (*check_flags)(int);
431         int (*flock) (struct file *, int, struct file_lock *);
432         ssize_t (*splice_write)(struct pipe_inode_info *, struct file *, loff_t *,
433                         size_t, unsigned int);
434         ssize_t (*splice_read)(struct file *, loff_t *, struct pipe_inode_info *,
435                         size_t, unsigned int);
436         int (*setlease)(struct file *, long, struct file_lock **);
437 };
438
439 locking rules:
440         All may block except for ->setlease.
441         No VFS locks held on entry except for ->fsync and ->setlease.
442
443 ->fsync() has i_mutex on inode.
444
445 ->setlease has the file_list_lock held and must not sleep.
446
447 ->llseek() locking has moved from llseek to the individual llseek
448 implementations.  If your fs is not using generic_file_llseek, you
449 need to acquire and release the appropriate locks in your ->llseek().
450 For many filesystems, it is probably safe to acquire the inode
451 mutex or just to use i_size_read() instead.
452 Note: this does not protect the file->f_pos against concurrent modifications
453 since this is something the userspace has to take care about.
454
455 ->fasync() is responsible for maintaining the FASYNC bit in filp->f_flags.
456 Most instances call fasync_helper(), which does that maintenance, so it's
457 not normally something one needs to worry about.  Return values > 0 will be
458 mapped to zero in the VFS layer.
459
460 ->readdir() and ->ioctl() on directories must be changed. Ideally we would
461 move ->readdir() to inode_operations and use a separate method for directory
462 ->ioctl() or kill the latter completely. One of the problems is that for
463 anything that resembles union-mount we won't have a struct file for all
464 components. And there are other reasons why the current interface is a mess...
465
466 ->read on directories probably must go away - we should just enforce -EISDIR
467 in sys_read() and friends.
468
469 --------------------------- dquot_operations -------------------------------
470 prototypes:
471         int (*write_dquot) (struct dquot *);
472         int (*acquire_dquot) (struct dquot *);
473         int (*release_dquot) (struct dquot *);
474         int (*mark_dirty) (struct dquot *);
475         int (*write_info) (struct super_block *, int);
476
477 These operations are intended to be more or less wrapping functions that ensure
478 a proper locking wrt the filesystem and call the generic quota operations.
479
480 What filesystem should expect from the generic quota functions:
481
482                 FS recursion    Held locks when called
483 write_dquot:    yes             dqonoff_sem or dqptr_sem
484 acquire_dquot:  yes             dqonoff_sem or dqptr_sem
485 release_dquot:  yes             dqonoff_sem or dqptr_sem
486 mark_dirty:     no              -
487 write_info:     yes             dqonoff_sem
488
489 FS recursion means calling ->quota_read() and ->quota_write() from superblock
490 operations.
491
492 More details about quota locking can be found in fs/dquot.c.
493
494 --------------------------- vm_operations_struct -----------------------------
495 prototypes:
496         void (*open)(struct vm_area_struct*);
497         void (*close)(struct vm_area_struct*);
498         int (*fault)(struct vm_area_struct*, struct vm_fault *);
499         int (*page_mkwrite)(struct vm_area_struct *, struct vm_fault *);
500         int (*access)(struct vm_area_struct *, unsigned long, void*, int, int);
501
502 locking rules:
503                 mmap_sem        PageLocked(page)
504 open:           yes
505 close:          yes
506 fault:          yes             can return with page locked
507 page_mkwrite:   yes             can return with page locked
508 access:         yes
509
510         ->fault() is called when a previously not present pte is about
511 to be faulted in. The filesystem must find and return the page associated
512 with the passed in "pgoff" in the vm_fault structure. If it is possible that
513 the page may be truncated and/or invalidated, then the filesystem must lock
514 the page, then ensure it is not already truncated (the page lock will block
515 subsequent truncate), and then return with VM_FAULT_LOCKED, and the page
516 locked. The VM will unlock the page.
517
518         ->page_mkwrite() is called when a previously read-only pte is
519 about to become writeable. The filesystem again must ensure that there are
520 no truncate/invalidate races, and then return with the page locked. If
521 the page has been truncated, the filesystem should not look up a new page
522 like the ->fault() handler, but simply return with VM_FAULT_NOPAGE, which
523 will cause the VM to retry the fault.
524
525         ->access() is called when get_user_pages() fails in
526 acces_process_vm(), typically used to debug a process through
527 /proc/pid/mem or ptrace.  This function is needed only for
528 VM_IO | VM_PFNMAP VMAs.
529
530 ================================================================================
531                         Dubious stuff
532
533 (if you break something or notice that it is broken and do not fix it yourself
534 - at least put it here)