xref: /OK3568_Linux_fs/kernel/include/linux/fanotify.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun #ifndef _LINUX_FANOTIFY_H
3*4882a593Smuzhiyun #define _LINUX_FANOTIFY_H
4*4882a593Smuzhiyun 
5*4882a593Smuzhiyun #include <uapi/linux/fanotify.h>
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #define FAN_GROUP_FLAG(group, flag) \
8*4882a593Smuzhiyun 	((group)->fanotify_data.flags & (flag))
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun /*
11*4882a593Smuzhiyun  * Flags allowed to be passed from/to userspace.
12*4882a593Smuzhiyun  *
13*4882a593Smuzhiyun  * We intentionally do not add new bits to the old FAN_ALL_* constants, because
14*4882a593Smuzhiyun  * they are uapi exposed constants. If there are programs out there using
15*4882a593Smuzhiyun  * these constant, the programs may break if re-compiled with new uapi headers
16*4882a593Smuzhiyun  * and then run on an old kernel.
17*4882a593Smuzhiyun  */
18*4882a593Smuzhiyun #define FANOTIFY_CLASS_BITS	(FAN_CLASS_NOTIF | FAN_CLASS_CONTENT | \
19*4882a593Smuzhiyun 				 FAN_CLASS_PRE_CONTENT)
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun #define FANOTIFY_FID_BITS	(FAN_REPORT_FID | FAN_REPORT_DFID_NAME)
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun #define FANOTIFY_INIT_FLAGS	(FANOTIFY_CLASS_BITS | FANOTIFY_FID_BITS | \
24*4882a593Smuzhiyun 				 FAN_REPORT_TID | \
25*4882a593Smuzhiyun 				 FAN_CLOEXEC | FAN_NONBLOCK | \
26*4882a593Smuzhiyun 				 FAN_UNLIMITED_QUEUE | FAN_UNLIMITED_MARKS)
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun #define FANOTIFY_MARK_TYPE_BITS	(FAN_MARK_INODE | FAN_MARK_MOUNT | \
29*4882a593Smuzhiyun 				 FAN_MARK_FILESYSTEM)
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun #define FANOTIFY_MARK_FLAGS	(FANOTIFY_MARK_TYPE_BITS | \
32*4882a593Smuzhiyun 				 FAN_MARK_ADD | \
33*4882a593Smuzhiyun 				 FAN_MARK_REMOVE | \
34*4882a593Smuzhiyun 				 FAN_MARK_DONT_FOLLOW | \
35*4882a593Smuzhiyun 				 FAN_MARK_ONLYDIR | \
36*4882a593Smuzhiyun 				 FAN_MARK_IGNORED_MASK | \
37*4882a593Smuzhiyun 				 FAN_MARK_IGNORED_SURV_MODIFY | \
38*4882a593Smuzhiyun 				 FAN_MARK_FLUSH)
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun /*
41*4882a593Smuzhiyun  * Events that can be reported with data type FSNOTIFY_EVENT_PATH.
42*4882a593Smuzhiyun  * Note that FAN_MODIFY can also be reported with data type
43*4882a593Smuzhiyun  * FSNOTIFY_EVENT_INODE.
44*4882a593Smuzhiyun  */
45*4882a593Smuzhiyun #define FANOTIFY_PATH_EVENTS	(FAN_ACCESS | FAN_MODIFY | \
46*4882a593Smuzhiyun 				 FAN_CLOSE | FAN_OPEN | FAN_OPEN_EXEC)
47*4882a593Smuzhiyun 
48*4882a593Smuzhiyun /*
49*4882a593Smuzhiyun  * Directory entry modification events - reported only to directory
50*4882a593Smuzhiyun  * where entry is modified and not to a watching parent.
51*4882a593Smuzhiyun  */
52*4882a593Smuzhiyun #define FANOTIFY_DIRENT_EVENTS	(FAN_MOVE | FAN_CREATE | FAN_DELETE)
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun /* Events that can only be reported with data type FSNOTIFY_EVENT_INODE */
55*4882a593Smuzhiyun #define FANOTIFY_INODE_EVENTS	(FANOTIFY_DIRENT_EVENTS | \
56*4882a593Smuzhiyun 				 FAN_ATTRIB | FAN_MOVE_SELF | FAN_DELETE_SELF)
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun /* Events that user can request to be notified on */
59*4882a593Smuzhiyun #define FANOTIFY_EVENTS		(FANOTIFY_PATH_EVENTS | \
60*4882a593Smuzhiyun 				 FANOTIFY_INODE_EVENTS)
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun /* Events that require a permission response from user */
63*4882a593Smuzhiyun #define FANOTIFY_PERM_EVENTS	(FAN_OPEN_PERM | FAN_ACCESS_PERM | \
64*4882a593Smuzhiyun 				 FAN_OPEN_EXEC_PERM)
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun /* Extra flags that may be reported with event or control handling of events */
67*4882a593Smuzhiyun #define FANOTIFY_EVENT_FLAGS	(FAN_EVENT_ON_CHILD | FAN_ONDIR)
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun /* Events that may be reported to user */
70*4882a593Smuzhiyun #define FANOTIFY_OUTGOING_EVENTS	(FANOTIFY_EVENTS | \
71*4882a593Smuzhiyun 					 FANOTIFY_PERM_EVENTS | \
72*4882a593Smuzhiyun 					 FAN_Q_OVERFLOW | FAN_ONDIR)
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun #define ALL_FANOTIFY_EVENT_BITS		(FANOTIFY_OUTGOING_EVENTS | \
75*4882a593Smuzhiyun 					 FANOTIFY_EVENT_FLAGS)
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun /* Do not use these old uapi constants internally */
78*4882a593Smuzhiyun #undef FAN_ALL_CLASS_BITS
79*4882a593Smuzhiyun #undef FAN_ALL_INIT_FLAGS
80*4882a593Smuzhiyun #undef FAN_ALL_MARK_FLAGS
81*4882a593Smuzhiyun #undef FAN_ALL_EVENTS
82*4882a593Smuzhiyun #undef FAN_ALL_PERM_EVENTS
83*4882a593Smuzhiyun #undef FAN_ALL_OUTGOING_EVENTS
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun #endif /* _LINUX_FANOTIFY_H */
86