1/*
2 * Inode based directory notification for Linux
3 *
4 * Copyright (C) 2005 John McCutchan
5 */
6
7#ifndef _UAPI_LINUX_INOTIFY_H
8#define _UAPI_LINUX_INOTIFY_H
9
10/* For O_CLOEXEC and O_NONBLOCK */
11#include <linux/fcntl.h>
12#include <linux/types.h>
13
14/*
15 * struct inotify_event - structure read from the inotify device for each event
16 *
17 * When you are watching a directory, you will receive the filename for events
18 * such as IN_CREATE, IN_DELETE, IN_OPEN, IN_CLOSE, ..., relative to the wd.
19 */
20struct inotify_event {
21	__s32		wd;		/* watch descriptor */
22	__u32		mask;		/* watch mask */
23	__u32		cookie;		/* cookie to synchronize two events */
24	__u32		len;		/* length (including nulls) of name */
25	char		name[0];	/* stub for possible name */
26};
27
28/* the following are legal, implemented events that user-space can watch for */
29#define IN_ACCESS		0x00000001	/* File was accessed */
30#define IN_MODIFY		0x00000002	/* File was modified */
31#define IN_ATTRIB		0x00000004	/* Metadata changed */
32#define IN_CLOSE_WRITE		0x00000008	/* Writtable file was closed */
33#define IN_CLOSE_NOWRITE	0x00000010	/* Unwrittable file closed */
34#define IN_OPEN			0x00000020	/* File was opened */
35#define IN_MOVED_FROM		0x00000040	/* File was moved from X */
36#define IN_MOVED_TO		0x00000080	/* File was moved to Y */
37#define IN_CREATE		0x00000100	/* Subfile was created */
38#define IN_DELETE		0x00000200	/* Subfile was deleted */
39#define IN_DELETE_SELF		0x00000400	/* Self was deleted */
40#define IN_MOVE_SELF		0x00000800	/* Self was moved */
41
42/* the following are legal events.  they are sent as needed to any watch */
43#define IN_UNMOUNT		0x00002000	/* Backing fs was unmounted */
44#define IN_Q_OVERFLOW		0x00004000	/* Event queued overflowed */
45#define IN_IGNORED		0x00008000	/* File was ignored */
46
47/* helper events */
48#define IN_CLOSE		(IN_CLOSE_WRITE | IN_CLOSE_NOWRITE) /* close */
49#define IN_MOVE			(IN_MOVED_FROM | IN_MOVED_TO) /* moves */
50
51/* special flags */
52#define IN_ONLYDIR		0x01000000	/* only watch the path if it is a directory */
53#define IN_DONT_FOLLOW		0x02000000	/* don't follow a sym link */
54#define IN_EXCL_UNLINK		0x04000000	/* exclude events on unlinked objects */
55#define IN_MASK_ADD		0x20000000	/* add to the mask of an already existing watch */
56#define IN_ISDIR		0x40000000	/* event occurred against dir */
57#define IN_ONESHOT		0x80000000	/* only send event once */
58
59/*
60 * All of the events - we build the list by hand so that we can add flags in
61 * the future and not break backward compatibility.  Apps will get only the
62 * events that they originally wanted.  Be sure to add new events here!
63 */
64#define IN_ALL_EVENTS	(IN_ACCESS | IN_MODIFY | IN_ATTRIB | IN_CLOSE_WRITE | \
65			 IN_CLOSE_NOWRITE | IN_OPEN | IN_MOVED_FROM | \
66			 IN_MOVED_TO | IN_DELETE | IN_CREATE | IN_DELETE_SELF | \
67			 IN_MOVE_SELF)
68
69/* Flags for sys_inotify_init1.  */
70#define IN_CLOEXEC O_CLOEXEC
71#define IN_NONBLOCK O_NONBLOCK
72
73
74#endif /* _UAPI_LINUX_INOTIFY_H */
75