inotify.txt 3.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. inotify
  2. a powerful yet simple file change notification system
  3. Document started 15 Mar 2005 by Robert Love <rml@novell.com>
  4. Document updated 4 Jan 2015 by Zhang Zhen <zhenzhang.zhang@huawei.com>
  5. --Deleted obsoleted interface, just refer to manpages for user interface.
  6. (i) Rationale
  7. Q: What is the design decision behind not tying the watch to the open fd of
  8. the watched object?
  9. A: Watches are associated with an open inotify device, not an open file.
  10. This solves the primary problem with dnotify: keeping the file open pins
  11. the file and thus, worse, pins the mount. Dnotify is therefore infeasible
  12. for use on a desktop system with removable media as the media cannot be
  13. unmounted. Watching a file should not require that it be open.
  14. Q: What is the design decision behind using an-fd-per-instance as opposed to
  15. an fd-per-watch?
  16. A: An fd-per-watch quickly consumes more file descriptors than are allowed,
  17. more fd's than are feasible to manage, and more fd's than are optimally
  18. select()-able. Yes, root can bump the per-process fd limit and yes, users
  19. can use epoll, but requiring both is a silly and extraneous requirement.
  20. A watch consumes less memory than an open file, separating the number
  21. spaces is thus sensible. The current design is what user-space developers
  22. want: Users initialize inotify, once, and add n watches, requiring but one
  23. fd and no twiddling with fd limits. Initializing an inotify instance two
  24. thousand times is silly. If we can implement user-space's preferences
  25. cleanly--and we can, the idr layer makes stuff like this trivial--then we
  26. should.
  27. There are other good arguments. With a single fd, there is a single
  28. item to block on, which is mapped to a single queue of events. The single
  29. fd returns all watch events and also any potential out-of-band data. If
  30. every fd was a separate watch,
  31. - There would be no way to get event ordering. Events on file foo and
  32. file bar would pop poll() on both fd's, but there would be no way to tell
  33. which happened first. A single queue trivially gives you ordering. Such
  34. ordering is crucial to existing applications such as Beagle. Imagine
  35. "mv a b ; mv b a" events without ordering.
  36. - We'd have to maintain n fd's and n internal queues with state,
  37. versus just one. It is a lot messier in the kernel. A single, linear
  38. queue is the data structure that makes sense.
  39. - User-space developers prefer the current API. The Beagle guys, for
  40. example, love it. Trust me, I asked. It is not a surprise: Who'd want
  41. to manage and block on 1000 fd's via select?
  42. - No way to get out of band data.
  43. - 1024 is still too low. ;-)
  44. When you talk about designing a file change notification system that
  45. scales to 1000s of directories, juggling 1000s of fd's just does not seem
  46. the right interface. It is too heavy.
  47. Additionally, it _is_ possible to more than one instance and
  48. juggle more than one queue and thus more than one associated fd. There
  49. need not be a one-fd-per-process mapping; it is one-fd-per-queue and a
  50. process can easily want more than one queue.
  51. Q: Why the system call approach?
  52. A: The poor user-space interface is the second biggest problem with dnotify.
  53. Signals are a terrible, terrible interface for file notification. Or for
  54. anything, for that matter. The ideal solution, from all perspectives, is a
  55. file descriptor-based one that allows basic file I/O and poll/select.
  56. Obtaining the fd and managing the watches could have been done either via a
  57. device file or a family of new system calls. We decided to implement a
  58. family of system calls because that is the preferred approach for new kernel
  59. interfaces. The only real difference was whether we wanted to use open(2)
  60. and ioctl(2) or a couple of new system calls. System calls beat ioctls.