Locking
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:12k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  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. --------------------------- dentry_operations --------------------------
  10. prototypes:
  11. int (*d_revalidate)(struct dentry *, int);
  12. int (*d_hash) (struct dentry *, struct qstr *);
  13. int (*d_compare) (struct dentry *, struct qstr *, struct qstr *);
  14. int (*d_delete)(struct dentry *);
  15. void (*d_release)(struct dentry *);
  16. void (*d_iput)(struct dentry *, struct inode *);
  17. locking rules:
  18. none have BKL
  19. dcache_lock may block
  20. d_revalidate: no yes
  21. d_hash no yes
  22. d_compare: yes no
  23. d_delete: yes no
  24. d_release: no yes
  25. d_iput: no yes
  26. --------------------------- inode_operations --------------------------- 
  27. prototypes:
  28. int (*create) (struct inode *,struct dentry *,int);
  29. struct dentry * (*lookup) (struct inode *,struct dentry *);
  30. int (*link) (struct dentry *,struct inode *,struct dentry *);
  31. int (*unlink) (struct inode *,struct dentry *);
  32. int (*symlink) (struct inode *,struct dentry *,const char *);
  33. int (*mkdir) (struct inode *,struct dentry *,int);
  34. int (*rmdir) (struct inode *,struct dentry *);
  35. int (*mknod) (struct inode *,struct dentry *,int,int);
  36. int (*rename) (struct inode *, struct dentry *,
  37. struct inode *, struct dentry *);
  38. int (*readlink) (struct dentry *, char *,int);
  39. int (*follow_link) (struct dentry *, struct nameidata *);
  40. void (*truncate) (struct inode *);
  41. int (*permission) (struct inode *, int);
  42. int (*revalidate) (struct dentry *);
  43. int (*setattr) (struct dentry *, struct iattr *);
  44. int (*getattr) (struct dentry *, struct iattr *);
  45. locking rules:
  46. all may block
  47. BKL i_sem(inode) i_zombie(inode)
  48. lookup: yes yes no
  49. create: yes yes yes
  50. link: yes yes yes
  51. mknod: yes yes yes
  52. mkdir: yes yes yes
  53. unlink: yes yes yes
  54. rmdir: yes yes yes (see below)
  55. rename: yes yes (both) yes (both) (see below)
  56. readlink: no no no
  57. follow_link: no no no
  58. truncate: yes yes no (see below)
  59. setattr: yes if ATTR_SIZE no
  60. permssion: yes no no
  61. getattr: (see below)
  62. revalidate: no (see below)
  63. Additionally, ->rmdir() has i_zombie on victim and so does ->rename()
  64. in case when target exists and is a directory.
  65. ->rename() on directories has (per-superblock) ->s_vfs_rename_sem.
  66. ->revalidate(), it may be called both with and without the i_sem
  67. on dentry->d_inode. VFS never calls it with i_zombie on dentry->d_inode,
  68. but watch for other methods directly calling this one...
  69. ->truncate() is never called directly - it's a callback, not a
  70. method. It's called by vmtruncate() - library function normally used by
  71. ->setattr(). Locking information above applies to that call (i.e. is
  72. inherited from ->setattr() - vmtruncate() is used when ATTR_SIZE had been
  73. passed).
  74. ->getattr() is currently unused.
  75. --------------------------- super_operations ---------------------------
  76. prototypes:
  77. void (*read_inode) (struct inode *);
  78. void (*write_inode) (struct inode *, int);
  79. void (*put_inode) (struct inode *);
  80. void (*delete_inode) (struct inode *);
  81. void (*put_super) (struct super_block *);
  82. void (*write_super) (struct super_block *);
  83. int (*statfs) (struct super_block *, struct statfs *);
  84. int (*remount_fs) (struct super_block *, int *, char *);
  85. void (*clear_inode) (struct inode *);
  86. void (*umount_begin) (struct super_block *);
  87. locking rules:
  88. All may block.
  89. BKL s_lock mount_sem
  90. read_inode: yes (see below)
  91. write_inode: no
  92. put_inode: no
  93. delete_inode: no
  94. clear_inode: no
  95. put_super: yes yes maybe (see below)
  96. write_super: yes yes maybe (see below)
  97. statfs: yes no no
  98. remount_fs: yes yes maybe (see below)
  99. umount_begin: yes no maybe (see below)
  100. ->read_inode() is not a method - it's a callback used in iget()/iget4().
  101. rules for mount_sem are not too nice - it is going to die and be replaced
  102. by better scheme anyway.
  103. --------------------------- file_system_type ---------------------------
  104. prototypes:
  105. struct super_block *(*read_super) (struct super_block *, void *, int);
  106. locking rules:
  107. may block BKL ->s_lock mount_sem
  108. yes yes yes maybe
  109. --------------------------- address_space_operations --------------------------
  110. prototypes:
  111. int (*writepage)(struct page *);
  112. int (*readpage)(struct file *, struct page *);
  113. int (*sync_page)(struct page *);
  114. int (*prepare_write)(struct file *, struct page *, unsigned, unsigned);
  115. int (*commit_write)(struct file *, struct page *, unsigned, unsigned);
  116. int (*bmap)(struct address_space *, long);
  117. int (*flushpage) (struct page *, unsigned long);
  118. int (*releasepage) (struct page *, int);
  119. int (*direct_IO)(int, struct inode *, struct kiobuf *, unsigned long, int);
  120. locking rules:
  121. All may block
  122. BKL PageLocked(page)
  123. writepage: no yes, unlocks
  124. readpage: no yes, unlocks
  125. sync_page: no maybe
  126. prepare_write: no yes
  127. commit_write: no yes
  128. bmap: yes
  129. flushpage: no yes
  130. releasepage: no yes
  131. ->prepare_write(), ->commit_write(), ->sync_page() and ->readpage()
  132. may be called from the request handler (/dev/loop).
  133. ->readpage() and ->writepage() unlock the page.
  134. ->sync_page() locking rules are not well-defined - usually it is called
  135. with lock on page, but that is not guaranteed. Considering the currently
  136. existing instances of this method ->sync_page() itself doesn't look
  137. well-defined...
  138. ->bmap() is currently used by legacy ioctl() (FIBMAP) provided by some
  139. filesystems and by the swapper. The latter will eventually go away. All
  140. instances do not actually need the BKL. Please, keep it that way and don't
  141. breed new callers.
  142. ->flushpage() is called when the filesystem must attempt to drop
  143. some or all of the buffers from the page when it is being truncated.  It
  144. returns zero on success.  If ->flushpage is zero, the kernel uses
  145. block_flushpage() instead.
  146. ->releasepage() is called when the kernel is about to try to drop the
  147. buffers from the page in preparation for freeing it.  It returns zero to
  148. indicate that the buffers are (or may be) freeable.  If ->flushpage is zero,
  149. the kernel assumes that the fs has no private interest in the buffers.
  150. Note: currently almost all instances of address_space methods are
  151. using BKL for internal serialization and that's one of the worst sources
  152. of contention. Normally they are calling library functions (in fs/buffer.c)
  153. and pass foo_get_block() as a callback (on local block-based filesystems,
  154. indeed). BKL is not needed for library stuff and is usually taken by
  155. foo_get_block(). It's an overkill, since block bitmaps can be protected by
  156. internal fs locking and real critical areas are much smaller than the areas
  157. filesystems protect now.
  158. --------------------------- file_lock ------------------------------------
  159. prototypes:
  160. void (*fl_notify)(struct file_lock *); /* unblock callback */
  161. void (*fl_insert)(struct file_lock *); /* lock insertion callback */
  162. void (*fl_remove)(struct file_lock *); /* lock removal callback */
  163. locking rules:
  164. BKL may block
  165. fl_notify: yes no
  166. fl_insert: yes maybe
  167. fl_remove: yes maybe
  168. Currently only NLM provides instances of this class. None of the
  169. them block. If you have out-of-tree instances - please, show up. Locking
  170. in that area will change.
  171. --------------------------- buffer_head -----------------------------------
  172. prototypes:
  173. void (*b_end_io)(struct buffer_head *bh, int uptodate);
  174. locking rules:
  175. called from interrupts. In other words, extreme care is needed here.
  176. bh is locked, but that's all warranties we have here. Currently only RAID1,
  177. highmem and fs/buffer.c are providing these. Block devices call this method
  178. upon the IO completion.
  179. --------------------------- block_device_operations -----------------------
  180. prototypes:
  181. int (*open) (struct inode *, struct file *);
  182. int (*release) (struct inode *, struct file *);
  183. int (*ioctl) (struct inode *, struct file *, unsigned, unsigned long);
  184. int (*check_media_change) (kdev_t);
  185. int (*revalidate) (kdev_t);
  186. locking rules:
  187. BKL bd_sem
  188. open: yes yes
  189. release: yes yes
  190. ioctl: yes no
  191. check_media_change: yes no
  192. revalidate: yes no
  193. The last two are called only from check_disk_change(). Prototypes are very
  194. bad - as soon as we'll get disk_struct they will change (and methods will
  195. become per-disk instead of per-partition).
  196. --------------------------- file_operations -------------------------------
  197. prototypes:
  198. loff_t (*llseek) (struct file *, loff_t, int);
  199. ssize_t (*read) (struct file *, char *, size_t, loff_t *);
  200. ssize_t (*write) (struct file *, const char *, size_t, loff_t *);
  201. int (*readdir) (struct file *, void *, filldir_t);
  202. unsigned int (*poll) (struct file *, struct poll_table_struct *);
  203. int (*ioctl) (struct inode *, struct file *, unsigned int, unsigned long);
  204. int (*mmap) (struct file *, struct vm_area_struct *);
  205. int (*open) (struct inode *, struct file *);
  206. int (*flush) (struct file *);
  207. int (*release) (struct inode *, struct file *);
  208. int (*fsync) (struct file *, struct dentry *, int datasync);
  209. int (*fasync) (int, struct file *, int);
  210. int (*lock) (struct file *, int, struct file_lock *);
  211. ssize_t (*readv) (struct file *, const struct iovec *, unsigned long, loff_t *);
  212. ssize_t (*writev) (struct file *, const struct iovec *, unsigned long, loff_t *);
  213. };
  214. locking rules:
  215. All except ->poll() may block.
  216. BKL
  217. llseek: yes
  218. read: no
  219. write: no
  220. readdir: yes (see below)
  221. poll: no
  222. ioctl: yes (see below)
  223. mmap: no
  224. open: maybe (see below)
  225. flush: yes
  226. release: no
  227. fsync: yes (see below)
  228. fasync: yes (see below)
  229. lock: yes
  230. readv: no
  231. writev: no
  232. ->open() locking is in-transit: big lock partially moved into the methods.
  233. The only exception is ->open() in the instances of file_operations that never
  234. end up in ->i_fop/->proc_fops, i.e. ones that belong to character devices
  235. (chrdev_open() takes lock before replacing ->f_op and calling the secondary
  236. method. As soon as we fix the handling of module reference counters all
  237. instances of ->open() will be called without the BKL.
  238. Note: ext2_release() was *the* source of contention on fs-intensive
  239. loads and dropping BKL on ->release() helps to get rid of that (we still
  240. grab BKL for cases when we close a file that had been opened r/w, but that
  241. can and should be done using the internal locking with smaller critical areas).
  242. Current worst offender is ext2_get_block()...
  243. ->fasync() is a mess. This area needs a big cleanup and that will probably
  244. affect locking.
  245. ->readdir() and ->ioctl() on directories must be changed. Ideally we would
  246. move ->readdir() to inode_operations and use a separate method for directory
  247. ->ioctl() or kill the latter completely. One of the problems is that for
  248. anything that resembles union-mount we won't have a struct file for all
  249. components. And there are other reasons why the current interface is a mess...
  250. ->read on directories probably must go away - we should just enforce -EISDIR
  251. in sys_read() and friends.
  252. ->fsync() has i_sem on inode.
  253. --------------------------- dquot_operations -------------------------------
  254. prototypes:
  255. void (*initialize) (struct inode *, short);
  256. void (*drop) (struct inode *);
  257. int (*alloc_block) (const struct inode *, unsigned long, char);
  258. int (*alloc_inode) (const struct inode *, unsigned long);
  259. void (*free_block) (const struct inode *, unsigned long);
  260. void (*free_inode) (const struct inode *, unsigned long);
  261. int (*transfer) (struct dentry *, struct iattr *);
  262. locking rules:
  263. BKL
  264. initialize: no
  265. drop: no
  266. alloc_block: yes
  267. alloc_inode: yes
  268. free_block: yes
  269. free_inode: yes
  270. transfer: no
  271. --------------------------- vm_operations_struct -----------------------------
  272. prototypes:
  273. void (*open)(struct vm_area_struct*);
  274. void (*close)(struct vm_area_struct*);
  275. struct page *(*nopage)(struct vm_area_struct*, unsigned long, int);
  276. locking rules:
  277. BKL mmap_sem
  278. open: no yes
  279. close: no yes
  280. nopage: no yes
  281. ================================================================================
  282. Dubious stuff
  283. (if you break something or notice that it is broken and do not fix it yourself
  284. - at least put it here)
  285. ipc/shm.c::shm_delete() - may need BKL.
  286. ->read() and ->write() in many drivers are (probably) missing BKL.
  287. drivers/sgi/char/graphics.c::sgi_graphics_nopage() - may need BKL.