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