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