original/man7/inotify.7

   1 '\" t
   2 .\" Hey Emacs! This file is -*- nroff -*- source.
   3 .\"
   4 .\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
   5 .\"
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\"
  26 .TH INOTIFY 7 2010-11-12 "Linux" "Linux Programmer's Manual"
  27 .SH NAME
  28 inotify \- monitoring file system events
  29 .SH DESCRIPTION
  30 The
  31 .I inotify
  32 API provides a mechanism for monitoring file system events.
  33 Inotify can be used to monitor individual files,
  34 or to monitor directories.
  35 When a directory is monitored, inotify will return events
  36 for the directory itself, and for files inside the directory.
  37
  38 The following system calls are used with this API:
  39 .BR inotify_init (2)
  40 (or
  41 .BR inotify_init1 (2)),
  42 .BR inotify_add_watch (2),
  43 .BR inotify_rm_watch (2),
  44 .BR read (2),
  45 and
  46 .BR close (2).
  47
  48 .BR inotify_init (2)
  49 creates an inotify instance and returns a file descriptor
  50 referring to the inotify instance.
  51 The more recent
  52 .BR inotify_init1 (2)
  53 is like
  54 .BR inotify_init (2),
  55 but provides some extra functionality.
  56
  57 .BR inotify_add_watch (2)
  58 manipulates the "watch list" associated with an inotify instance.
  59 Each item ("watch") in the watch list specifies the pathname of
  60 a file or directory,
  61 along with some set of events that the kernel should monitor for the
  62 file referred to by that pathname.
  63 .BR inotify_add_watch (2)
  64 either creates a new watch item, or modifies an existing watch.
  65 Each watch has a unique "watch descriptor", an integer
  66 returned by
  67 .BR inotify_add_watch (2)
  68 when the watch is created.
  69
  70 .BR inotify_rm_watch (2)
  71 removes an item from an inotify watch list.
  72
  73 When all file descriptors referring to an inotify
  74 instance have been closed,
  75 the underlying object and its resources are
  76 freed for reuse by the kernel;
  77 all associated watches are automatically freed.
  78
  79 To determine what events have occurred, an application
  80 .BR read (2)s
  81 from the inotify file descriptor.
  82 If no events have so far occurred, then,
  83 assuming a blocking file descriptor,
  84 .BR read (2)
  85 will block until at least one event occurs
  86 (unless interrupted by a signal,
  87 in which case the call fails with the error
  88 .BR EINTR ;
  89 see
  90 .BR signal (7)).
  91
  92 Each successful
  93 .BR read (2)
  94 returns a buffer containing one or more of the following structures:
  95 .in +4n
  96 .nf
  97
  98 struct inotify_event {
  99     int      wd;       /* Watch descriptor */
 100 .\" FIXME . The type of the 'wd' field should probably be "int32_t".
 101 .\" I submitted a patch to fix this.  See the LKML thread
 102 .\" "[patch] Fix type errors in inotify interfaces", 18 Nov 2008
 103 .\" Glibc bug filed: http://sources.redhat.com/bugzilla/show_bug.cgi?id=7040
 104     uint32_t mask;     /* Mask of events */
 105     uint32_t cookie;   /* Unique cookie associating related
 106                           events (for rename(2)) */
 107     uint32_t len;      /* Size of \fIname\fP field */
 108     char     name[];   /* Optional null-terminated name */
 109 };
 110 .fi
 111 .in
 112
 113 .I wd
 114 identifies the watch for which this event occurs.
 115 It is one of the watch descriptors returned by a previous call to
 116 .BR inotify_add_watch (2).
 117
 118 .I mask
 119 contains bits that describe the event that occurred (see below).
 120
 121 .I cookie
 122 is a unique integer that connects related events.
 123 Currently this is only used for rename events, and
 124 allows the resulting pair of
 125 .B IN_MOVE_FROM
 126 and
 127 .B IN_MOVE_TO
 128 events to be connected by the application.
 129
 130 The
 131 .I name
 132 field is only present when an event is returned
 133 for a file inside a watched directory;
 134 it identifies the file pathname relative to the watched directory.
 135 This pathname is null-terminated,
 136 and may include further null bytes to align subsequent reads to a
 137 suitable address boundary.
 138
 139 The
 140 .I len
 141 field counts all of the bytes in
 142 .IR name ,
 143 including the null bytes;
 144 the length of each
 145 .I inotify_event
 146 structure is thus
 147 .IR "sizeof(inotify_event)+len" .
 148
 149 The behavior when the buffer given to
 150 .BR read (2)
 151 is too small to return information about the next event depends
 152 on the kernel version: in kernels before 2.6.21,
 153 .BR read (2)
 154 returns 0; since kernel 2.6.21,
 155 .BR read (2)
 156 fails with the error
 157 .BR EINVAL .
 158 .SS inotify events
 159 The
 160 .BR inotify_add_watch (2)
 161 .I mask
 162 argument and the
 163 .I mask
 164 field of the
 165 .I inotify_event
 166 structure returned when
 167 .BR read (2)ing
 168 an inotify file descriptor are both bit masks identifying
 169 inotify events.
 170 The following bits can be specified in
 171 .I mask
 172 when calling
 173 .BR inotify_add_watch (2)
 174 and may be returned in the
 175 .I mask
 176 field returned by
 177 .BR read (2):
 178 .RS 4
 179 .sp
 180 .PD 0
 181 .TP 18
 182 .B IN_ACCESS
 183 File was accessed (read) (*).
 184 .TP
 185 .B IN_ATTRIB
 186 Metadata changed, e.g., permissions, timestamps, extended attributes,
 187 link count (since Linux 2.6.25), UID, GID, etc. (*).
 188 .TP
 189 .B IN_CLOSE_WRITE
 190 File opened for writing was closed (*).
 191 .TP
 192 .B IN_CLOSE_NOWRITE
 193 File not opened for writing was closed (*).
 194 .TP
 195 .B IN_CREATE
 196 File/directory created in watched directory (*).
 197 .TP
 198 .B IN_DELETE
 199 File/directory deleted from watched directory (*).
 200 .TP
 201 .B IN_DELETE_SELF
 202 Watched file/directory was itself deleted.
 203 .TP
 204 .B IN_MODIFY
 205 File was modified (*).
 206 .TP
 207 .B IN_MOVE_SELF
 208 Watched file/directory was itself moved.
 209 .TP
 210 .B IN_MOVED_FROM
 211 File moved out of watched directory (*).
 212 .TP
 213 .B IN_MOVED_TO
 214 File moved into watched directory (*).
 215 .TP
 216 .B IN_OPEN
 217 File was opened (*).
 218 .PD
 219 .RE
 220 .PP
 221 When monitoring a directory,
 222 the events marked with an asterisk (*) above can occur for
 223 files in the directory, in which case the
 224 .I name
 225 field in the returned
 226 .I inotify_event
 227 structure identifies the name of the file within the directory.
 228 .PP
 229 The
 230 .B IN_ALL_EVENTS
 231 macro is defined as a bit mask of all of the above events.
 232 This macro can be used as the
 233 .I mask
 234 argument when calling
 235 .BR inotify_add_watch (2).
 236
 237 Two additional convenience macros are
 238 .BR IN_MOVE ,
 239 which equates to
 240 IN_MOVED_FROM|IN_MOVED_TO,
 241 and
 242 .BR IN_CLOSE ,
 243 which equates to
 244 IN_CLOSE_WRITE|IN_CLOSE_NOWRITE.
 245 .PP
 246 The following further bits can be specified in
 247 .I mask
 248 when calling
 249 .BR inotify_add_watch (2):
 250 .RS 4
 251 .sp
 252 .PD 0
 253 .TP 18
 254 .BR IN_DONT_FOLLOW " (since Linux 2.6.15)"
 255 Don't dereference \fIpathname\fP if it is a symbolic link.
 256 .TP
 257 .B IN_EXCL_UNLINK " (since Linux 2.6.36)"
 258 .\" commit 8c1934c8d70b22ca8333b216aec6c7d09fdbd6a6
 259 By default, when watching events on the children of a directory,
 260 events are generated for children even after they have been unlinked
 261 from the directory.
 262 This can result in large numbers of uninteresting events for
 263 some applications (e.g., if watching
 264 .IR /tmp ,
 265 in which many applications create temporary files whose
 266 names are immediately unlinked).
 267 Specifying
 268 .B IN_EXCL_UNLINK
 269 changes the default behavior,
 270 so that events are not generated for children after
 271 they have been unlinked from the watched directory.
 272 .TP
 273 .B IN_MASK_ADD
 274 Add (OR) events to watch mask for this pathname if
 275 it already exists (instead of replacing mask).
 276 .TP
 277 .B IN_ONESHOT
 278 Monitor \fIpathname\fP for one event, then remove from
 279 watch list.
 280 .TP
 281 .BR IN_ONLYDIR " (since Linux 2.6.15)"
 282 Only watch \fIpathname\fP if it is a directory.
 283 .PD
 284 .RE
 285 .PP
 286 The following bits may be set in the
 287 .I mask
 288 field returned by
 289 .BR read (2):
 290 .RS 4
 291 .sp
 292 .PD 0
 293 .TP 18
 294 .B IN_IGNORED
 295 Watch was removed explicitly (\fBinotify_rm_watch\fP(2))
 296 or automatically (file was deleted, or file system was unmounted).
 297 .TP
 298 .B IN_ISDIR
 299 Subject of this event is a directory.
 300 .TP
 301 .B IN_Q_OVERFLOW
 302 Event queue overflowed (\fIwd\fP is \-1 for this event).
 303 .TP
 304 .B IN_UNMOUNT
 305 File system containing watched object was unmounted.
 306 .PD
 307 .RE
 308 .SS /proc interfaces
 309 The following interfaces can be used to limit the amount of
 310 kernel memory consumed by inotify:
 311 .TP
 312 .I /proc/sys/fs/inotify/max_queued_events
 313 The value in this file is used when an application calls
 314 .BR inotify_init (2)
 315 to set an upper limit on the number of events that can be
 316 queued to the corresponding inotify instance.
 317 Events in excess of this limit are dropped, but an
 318 .B IN_Q_OVERFLOW
 319 event is always generated.
 320 .TP
 321 .I /proc/sys/fs/inotify/max_user_instances
 322 This specifies an upper limit on the number of inotify instances
 323 that can be created per real user ID.
 324 .TP
 325 .I /proc/sys/fs/inotify/max_user_watches
 326 This specifies an upper limit on the number of watches
 327 that can be created per real user ID.
 328 .SH "VERSIONS"
 329 Inotify was merged into the 2.6.13 Linux kernel.
 330 The required library interfaces were added to glibc in version 2.4.
 331 .RB ( IN_DONT_FOLLOW ,
 332 .BR IN_MASK_ADD ,
 333 and
 334 .B IN_ONLYDIR
 335 were only added in version 2.5.)
 336 .SH "CONFORMING TO"
 337 The inotify API is Linux-specific.
 338 .SH "NOTES"
 339 Inotify file descriptors can be monitored using
 340 .BR select (2),
 341 .BR poll (2),
 342 and
 343 .BR epoll (7).
 344 When an event is available, the file descriptor indicates as readable.
 345
 346 Since Linux 2.6.25,
 347 signal-driven I/O notification is available for inotify file descriptors;
 348 see the discussion of
 349 .B F_SETFL
 350 (for setting the
 351 .B O_ASYNC
 352 flag),
 353 .BR F_SETOWN ,
 354 and
 355 .B F_SETSIG
 356 in
 357 .BR fcntl (2).
 358 The
 359 .I siginfo_t
 360 structure (described in
 361 .BR sigaction (2))
 362 that is passed to the signal handler has the following fields set:
 363 .IR si_fd
 364 is set to the inotify file descriptor number;
 365 .IR si_signo
 366 is set to the signal number;
 367 .IR si_code
 368 is set to
 369 .BR POLL_IN ;
 370 and
 371 .B POLLIN
 372 is set in
 373 .IR si_band .
 374
 375 If successive output inotify events produced on the
 376 inotify file descriptor are identical (same
 377 .IR wd ,
 378 .IR mask ,
 379 .IR cookie ,
 380 and
 381 .IR name )
 382 then they are coalesced into a single event if the
 383 older event has not yet been read (but see BUGS).
 384
 385 The events returned by reading from an inotify file descriptor
 386 form an ordered queue.
 387 Thus, for example, it is guaranteed that when renaming from
 388 one directory to another, events will be produced in the
 389 correct order on the inotify file descriptor.
 390
 391 The
 392 .B FIONREAD
 393 .BR ioctl (2)
 394 returns the number of bytes available to read from an
 395 inotify file descriptor.
 396 .SS Limitations and caveats
 397 Inotify monitoring of directories is not recursive:
 398 to monitor subdirectories under a directory,
 399 additional watches must be created.
 400 This can take a significant amount time for large directory trees.
 401
 402 The inotify API provides no information about the user or process that
 403 triggered the inotify event.
 404
 405 Note that the event queue can overflow.
 406 In this case, events are lost.
 407 Robust applications should handle the possibility of
 408 lost events gracefully.
 409
 410 The inotify API identifies affected files by filename.
 411 However, by the time an application processes an inotify event,
 412 the filename may already have been deleted or renamed.
 413
 414 If monitoring an entire directory subtree,
 415 and a new subdirectory is created in that tree,
 416 be aware that by the time you create a watch for the new subdirectory,
 417 new files may already have been created in the subdirectory.
 418 Therefore, you may want to scan the contents of the subdirectory
 419 immediately after adding the watch.
 420 .SH "BUGS"
 421 In kernels before 2.6.16, the
 422 .B IN_ONESHOT
 423 .I mask
 424 flag does not work.
 425
 426 Before kernel 2.6.25,
 427 the kernel code that was intended to coalesce successive identical events
 428 (i.e., the two most recent events could potentially be coalesced
 429 if the older had not yet been read)
 430 instead checked if the most recent event could be coalesced with the
 431 .I oldest
 432 unread event.
 433 .SH "SEE ALSO"
 434 .BR inotify_add_watch (2),
 435 .BR inotify_init (2),
 436 .BR inotify_init1 (2),
 437 .BR inotify_rm_watch (2),
 438 .BR read (2),
 439 .BR stat (2),
 440 .IR Documentation/filesystems/inotify.txt .