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 2012-04-26 "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 For all other event types,
 130 .I cookie
 131 is set to 0.
 132
 133 The
 134 .I name
 135 field is only present when an event is returned
 136 for a file inside a watched directory;
 137 it identifies the file pathname relative to the watched directory.
 138 This pathname is null-terminated,
 139 and may include further null bytes to align subsequent reads to a
 140 suitable address boundary.
 141
 142 The
 143 .I len
 144 field counts all of the bytes in
 145 .IR name ,
 146 including the null bytes;
 147 the length of each
 148 .I inotify_event
 149 structure is thus
 150 .IR "sizeof(struct inotify_event)+len" .
 151
 152 The behavior when the buffer given to
 153 .BR read (2)
 154 is too small to return information about the next event depends
 155 on the kernel version: in kernels before 2.6.21,
 156 .BR read (2)
 157 returns 0; since kernel 2.6.21,
 158 .BR read (2)
 159 fails with the error
 160 .BR EINVAL .
 161 Specifying a buffer of size
 162
 163     sizeof(struct inotify_event) + NAME_MAX + 1
 164
 165 will be sufficient to read at least one event.
 166
 167 .SS inotify events
 168 The
 169 .BR inotify_add_watch (2)
 170 .I mask
 171 argument and the
 172 .I mask
 173 field of the
 174 .I inotify_event
 175 structure returned when
 176 .BR read (2)ing
 177 an inotify file descriptor are both bit masks identifying
 178 inotify events.
 179 The following bits can be specified in
 180 .I mask
 181 when calling
 182 .BR inotify_add_watch (2)
 183 and may be returned in the
 184 .I mask
 185 field returned by
 186 .BR read (2):
 187 .RS 4
 188 .sp
 189 .PD 0
 190 .TP 18
 191 .B IN_ACCESS
 192 File was accessed (read) (*).
 193 .TP
 194 .B IN_ATTRIB
 195 Metadata changed, e.g., permissions, timestamps, extended attributes,
 196 link count (since Linux 2.6.25), UID, GID, etc. (*).
 197 .TP
 198 .B IN_CLOSE_WRITE
 199 File opened for writing was closed (*).
 200 .TP
 201 .B IN_CLOSE_NOWRITE
 202 File not opened for writing was closed (*).
 203 .TP
 204 .B IN_CREATE
 205 File/directory created in watched directory (*).
 206 .TP
 207 .B IN_DELETE
 208 File/directory deleted from watched directory (*).
 209 .TP
 210 .B IN_DELETE_SELF
 211 Watched file/directory was itself deleted.
 212 .TP
 213 .B IN_MODIFY
 214 File was modified (*).
 215 .TP
 216 .B IN_MOVE_SELF
 217 Watched file/directory was itself moved.
 218 .TP
 219 .B IN_MOVED_FROM
 220 File moved out of watched directory (*).
 221 .TP
 222 .B IN_MOVED_TO
 223 File moved into watched directory (*).
 224 .TP
 225 .B IN_OPEN
 226 File was opened (*).
 227 .PD
 228 .RE
 229 .PP
 230 When monitoring a directory,
 231 the events marked with an asterisk (*) above can occur for
 232 files in the directory, in which case the
 233 .I name
 234 field in the returned
 235 .I inotify_event
 236 structure identifies the name of the file within the directory.
 237 .PP
 238 The
 239 .B IN_ALL_EVENTS
 240 macro is defined as a bit mask of all of the above events.
 241 This macro can be used as the
 242 .I mask
 243 argument when calling
 244 .BR inotify_add_watch (2).
 245
 246 Two additional convenience macros are
 247 .BR IN_MOVE ,
 248 which equates to
 249 IN_MOVED_FROM|IN_MOVED_TO,
 250 and
 251 .BR IN_CLOSE ,
 252 which equates to
 253 IN_CLOSE_WRITE|IN_CLOSE_NOWRITE.
 254 .PP
 255 The following further bits can be specified in
 256 .I mask
 257 when calling
 258 .BR inotify_add_watch (2):
 259 .RS 4
 260 .sp
 261 .PD 0
 262 .TP 18
 263 .BR IN_DONT_FOLLOW " (since Linux 2.6.15)"
 264 Don't dereference \fIpathname\fP if it is a symbolic link.
 265 .TP
 266 .BR IN_EXCL_UNLINK " (since Linux 2.6.36)"
 267 .\" commit 8c1934c8d70b22ca8333b216aec6c7d09fdbd6a6
 268 By default, when watching events on the children of a directory,
 269 events are generated for children even after they have been unlinked
 270 from the directory.
 271 This can result in large numbers of uninteresting events for
 272 some applications (e.g., if watching
 273 .IR /tmp ,
 274 in which many applications create temporary files whose
 275 names are immediately unlinked).
 276 Specifying
 277 .B IN_EXCL_UNLINK
 278 changes the default behavior,
 279 so that events are not generated for children after
 280 they have been unlinked from the watched directory.
 281 .TP
 282 .B IN_MASK_ADD
 283 Add (OR) events to watch mask for this pathname if
 284 it already exists (instead of replacing mask).
 285 .TP
 286 .B IN_ONESHOT
 287 Monitor \fIpathname\fP for one event, then remove from
 288 watch list.
 289 .TP
 290 .BR IN_ONLYDIR " (since Linux 2.6.15)"
 291 Only watch \fIpathname\fP if it is a directory.
 292 .PD
 293 .RE
 294 .PP
 295 The following bits may be set in the
 296 .I mask
 297 field returned by
 298 .BR read (2):
 299 .RS 4
 300 .sp
 301 .PD 0
 302 .TP 18
 303 .B IN_IGNORED
 304 Watch was removed explicitly (\fBinotify_rm_watch\fP(2))
 305 or automatically (file was deleted, or file system was unmounted).
 306 .TP
 307 .B IN_ISDIR
 308 Subject of this event is a directory.
 309 .TP
 310 .B IN_Q_OVERFLOW
 311 Event queue overflowed (\fIwd\fP is \-1 for this event).
 312 .TP
 313 .B IN_UNMOUNT
 314 File system containing watched object was unmounted.
 315 .PD
 316 .RE
 317 .SS /proc interfaces
 318 The following interfaces can be used to limit the amount of
 319 kernel memory consumed by inotify:
 320 .TP
 321 .I /proc/sys/fs/inotify/max_queued_events
 322 The value in this file is used when an application calls
 323 .BR inotify_init (2)
 324 to set an upper limit on the number of events that can be
 325 queued to the corresponding inotify instance.
 326 Events in excess of this limit are dropped, but an
 327 .B IN_Q_OVERFLOW
 328 event is always generated.
 329 .TP
 330 .I /proc/sys/fs/inotify/max_user_instances
 331 This specifies an upper limit on the number of inotify instances
 332 that can be created per real user ID.
 333 .TP
 334 .I /proc/sys/fs/inotify/max_user_watches
 335 This specifies an upper limit on the number of watches
 336 that can be created per real user ID.
 337 .SH "VERSIONS"
 338 Inotify was merged into the 2.6.13 Linux kernel.
 339 The required library interfaces were added to glibc in version 2.4.
 340 .RB ( IN_DONT_FOLLOW ,
 341 .BR IN_MASK_ADD ,
 342 and
 343 .B IN_ONLYDIR
 344 were only added in version 2.5.)
 345 .SH "CONFORMING TO"
 346 The inotify API is Linux-specific.
 347 .SH "NOTES"
 348 Inotify file descriptors can be monitored using
 349 .BR select (2),
 350 .BR poll (2),
 351 and
 352 .BR epoll (7).
 353 When an event is available, the file descriptor indicates as readable.
 354
 355 Since Linux 2.6.25,
 356 signal-driven I/O notification is available for inotify file descriptors;
 357 see the discussion of
 358 .B F_SETFL
 359 (for setting the
 360 .B O_ASYNC
 361 flag),
 362 .BR F_SETOWN ,
 363 and
 364 .B F_SETSIG
 365 in
 366 .BR fcntl (2).
 367 The
 368 .I siginfo_t
 369 structure (described in
 370 .BR sigaction (2))
 371 that is passed to the signal handler has the following fields set:
 372 .IR si_fd
 373 is set to the inotify file descriptor number;
 374 .IR si_signo
 375 is set to the signal number;
 376 .IR si_code
 377 is set to
 378 .BR POLL_IN ;
 379 and
 380 .B POLLIN
 381 is set in
 382 .IR si_band .
 383
 384 If successive output inotify events produced on the
 385 inotify file descriptor are identical (same
 386 .IR wd ,
 387 .IR mask ,
 388 .IR cookie ,
 389 and
 390 .IR name )
 391 then they are coalesced into a single event if the
 392 older event has not yet been read (but see BUGS).
 393
 394 The events returned by reading from an inotify file descriptor
 395 form an ordered queue.
 396 Thus, for example, it is guaranteed that when renaming from
 397 one directory to another, events will be produced in the
 398 correct order on the inotify file descriptor.
 399
 400 The
 401 .B FIONREAD
 402 .BR ioctl (2)
 403 returns the number of bytes available to read from an
 404 inotify file descriptor.
 405 .SS Limitations and caveats
 406 Inotify monitoring of directories is not recursive:
 407 to monitor subdirectories under a directory,
 408 additional watches must be created.
 409 This can take a significant amount time for large directory trees.
 410
 411 The inotify API provides no information about the user or process that
 412 triggered the inotify event.
 413
 414 Note that the event queue can overflow.
 415 In this case, events are lost.
 416 Robust applications should handle the possibility of
 417 lost events gracefully.
 418
 419 The inotify API identifies affected files by filename.
 420 However, by the time an application processes an inotify event,
 421 the filename may already have been deleted or renamed.
 422
 423 If monitoring an entire directory subtree,
 424 and a new subdirectory is created in that tree,
 425 be aware that by the time you create a watch for the new subdirectory,
 426 new files may already have been created in the subdirectory.
 427 Therefore, you may want to scan the contents of the subdirectory
 428 immediately after adding the watch.
 429 .SH "BUGS"
 430 In kernels before 2.6.16, the
 431 .B IN_ONESHOT
 432 .I mask
 433 flag does not work.
 434
 435 Before kernel 2.6.25,
 436 the kernel code that was intended to coalesce successive identical events
 437 (i.e., the two most recent events could potentially be coalesced
 438 if the older had not yet been read)
 439 instead checked if the most recent event could be coalesced with the
 440 .I oldest
 441 unread event.
 442 .SH "SEE ALSO"
 443 .BR inotify_add_watch (2),
 444 .BR inotify_init (2),
 445 .BR inotify_init1 (2),
 446 .BR inotify_rm_watch (2),
 447 .BR read (2),
 448 .BR stat (2),
 449 .IR Documentation/filesystems/inotify.txt .