Minor wording chnages.

[thirdparty/man-pages.git] / man7 / inotify.7

'\" t
.\" Hey Emacs! This file is -*- nroff -*- source.
.\"
.\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.TH INOTIFY 7 2007-06-03 "Linux" "Linux Programmer's Manual"
.SH NAME
inotify \- monitoring file system events
.SH DESCRIPTION
The
.I inotify
API provides a mechanism for monitoring file system events.
Inotify can be used to monitor individual files,
or to monitor directories.
When a directory is monitored, inotify will return events
for the directory itself, and for files inside the directory.

The following system calls are used with this API:
.BR inotify_init (2),
.BR inotify_add_watch (2),
.BR inotify_rm_watch (2),
.BR read (2),
and
.BR close (2).

.BR inotify_init (2)
creates an inotify instance and returns a file descriptor
referring to the inotify instance.

.BR inotify_add_watch (2)
manipulates the "watch list" associated with an inotify instance.
Each item ("watch") in the watch list specifies the pathname of
a file or directory,
along with some set of events that the kernel should monitor for the
file referred to by that pathname.
.BR inotify_add_watch (2)
either creates a new watch item, or modifies an existing watch.
Each watch has a unique "watch descriptor", an integer
returned by
.BR inotify_add_watch (2)
when the watch is created.

.BR inotify_rm_watch (2)
removes an item from an inotify watch list.

When all file descriptors referring to an inotify
instance have been closed,
the underlying object and its resources are
freed for re-use by the kernel;
all associated watches are automatically freed.

To determine what events have occurred, an application
.BR read (2)s
from the inotify file descriptor.
If no events have so far occurred, then,
assuming a blocking file descriptor,
.BR read (2)
will block until at least one event occurs.

Each successful
.BR read (2)
returns a buffer containing one or more of the following structures:
.in +4n
.nf

struct inotify_event {
    int      wd;       /* Watch descriptor */
    uint32_t mask;     /* Mask of events */
    uint32_t cookie;   /* Unique cookie associating related
                          events (for rename(2)) */
    uint32_t len;      /* Size of 'name' field */
    char     name[];   /* Optional null-terminated name */
};
.fi
.in

.I wd
identifies the watch for which this event occurs.
It is one of the watch descriptors returned by a previous call to
.BR inotify_add_watch (2).

.I mask
contains bits that describe the event that occurred (see below).

.I cookie
is a unique integer that connects related events.
Currently this is only used for rename events, and
allows the resulting pair of
.B IN_MOVE_FROM
and
.B IN_MOVE_TO
events to be connected by the application.

The
.I name
field is only present when an event is returned
for a file inside a watched directory;
it identifies the file pathname relative to the watched directory.
This pathname is null-terminated,
and may include further null bytes to align subsequent reads to a
suitable address boundary.

The
.I len
field counts all of the bytes in
.IR name ,
including the null bytes;
the length of each
.I inotify_event
structure is thus
.IR "sizeof(inotify_event)+len" .

The behavior when the buffer given to
.BR read (2)
is too small to return information about the next event depends
on the kernel version: in kernels before 2.6.21,
.BR read (2)
returns 0; since kernel 2.6.21,
.BR read (2)
fails with the error
.BR EINVAL .
.SS inotify events
The
.BR inotify_add_watch (2)
.I mask
argument and the
.I mask
field of the
.I inotify_event
structure returned when
.BR read (2)ing
an inotify file descriptor are both bit masks identifying
inotify events.
The following bits can be specified in
.I mask
when calling
.BR inotify_add_watch (2)
and may be returned in the
.I mask
field returned by
.BR read (2):
.TS
lB l.
IN_ACCESS	File was accessed (read) (*)
IN_ATTRIB	Metadata changed (permissions, timestamps,
	extended attributes, etc.) (*)
IN_CLOSE_WRITE	File opened for writing was closed (*)
IN_CLOSE_NOWRITE	File not opened for writing was closed (*)
IN_CREATE	File/directory created in watched directory (*)
IN_DELETE	File/directory deleted from watched directory (*)
IN_DELETE_SELF	Watched file/directory was itself deleted
IN_MODIFY	File was modified (*)
IN_MOVE_SELF	Watched file/directory was itself moved
IN_MOVED_FROM	File moved out of watched directory (*)
IN_MOVED_TO	File moved into watched directory (*)
IN_OPEN	File was opened (*)
.TE
.PP
When monitoring a directory,
the events marked with an asterisk (*) above can occur for
files in the directory, in which case the
.I name
field in the returned
.I inotify_event
structure identifies the name of the file within the directory.
.PP
The
.B IN_ALL_EVENTS
macro is defined as a bit mask of all of the above events.
This macro can be used as the
.I mask
argument when calling
.BR inotify_add_watch (2).

Two additional convenience macros are
.BR IN_MOVE ,
which equates to
IN_MOVED_FROM|IN_MOVED_TO,
and
.B IN_CLOSE
which equates to
IN_CLOSE_WRITE|IN_CLOSE_NOWRITE.
.PP
The following further bits can be specified in
.I mask
when calling
.BR inotify_add_watch (2):
.TS
lB l.
IN_DONT_FOLLOW	Don't dereference \fIpathname\fP if it is a symbolic link
	(Since Linux 2.6.15)
IN_MASK_ADD	Add (OR) events to watch mask for this pathname if
	it already exists (instead of replacing mask)
IN_ONESHOT	Monitor \fIpathname\fP for one event, then remove from
	watch list
IN_ONLYDIR	Only watch \fIpathname\fP if it is a directory
	(Since Linux 2.6.15)
.TE
.PP
The following bits may be set in the
.I mask
field returned by
.BR read (2):
.TS
lB l.
IN_IGNORED	Watch was removed explicitly (\fBinotify_rm_watch\fP(2))
	or automatically (file was deleted, or
	file system was unmounted)
IN_ISDIR	Subject of this event is a directory
IN_Q_OVERFLOW	Event queue overflowed (\fIwd\fP is \-1 for this event)
IN_UNMOUNT	File system containing watched object was unmounted
.TE
.SS /proc interfaces
The following interfaces can be used to limit the amount of
kernel memory consumed by inotify:
.TP
.I /proc/sys/fs/inotify/max_queued_events
The value in this file is used when an application calls
.BR inotify_init (2)
to set an upper limit on the number of events that can be
queued to the corresponding inotify instance.
Events in excess of this limit are dropped, but an
.B IN_Q_OVERFLOW
event is always generated.
.TP
.I /proc/sys/fs/inotify/max_user_instances
This specifies an upper limit on the number of inotify instances
that can be created per real user ID.
.TP
.I /proc/sys/fs/inotify/max_user_watches
This specifies a limit on the number of watches that can be associated
with each inotify instance.
.SH "VERSIONS"
Inotify was merged into the 2.6.13 Linux kernel.
The required library interfaces were added to glibc in version 2.4.
.RB ( IN_DONT_FOLLOW ,
.BR IN_MASK_ADD ,
and
.B IN_ONLYDIR
were only added in version 2.5.)
.SH "CONFORMING TO"
The inotify API is Linux-specific.
.SH "NOTES"
Inotify file descriptors can be monitored using
.BR select (2),
.BR poll (2),
and
.BR epoll (7).

If successive output inotify events produced on the
inotify file descriptor are identical (same
.IR wd ,
.IR mask ,
.IR cookie ,
and
.IR name )
then they are coalesced into a single event.

The events returned by reading from an inotify file descriptor
form an ordered queue.
Thus, for example, it is guaranteed that when renaming from
one directory to another, events will be produced in the
correct order on the inotify file descriptor.

The
.B FIONREAD
.BR ioctl (2)
returns the number of bytes available to read from an
inotify file descriptor.

Inotify monitoring of directories is not recursive:
to monitor subdirectories under a directory,
additional watches must be created.
.SH "BUGS"
In kernels before 2.6.16, the
.B IN_ONESHOT
.I mask
flag does not work.
.SH "SEE ALSO"
.BR inotify_add_watch (2),
.BR inotify_init (2),
.BR inotify_rm_watch (2),
.BR read (2),
.BR stat (2),
.IR Documentation/filesystems/inotify.txt .