Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2#ifndef _UAPI_LINUX_FANOTIFY_H
3#define _UAPI_LINUX_FANOTIFY_H
4
5#include <linux/types.h>
6
7/* the following events that user-space can register for */
8#define FAN_ACCESS 0x00000001 /* File was accessed */
9#define FAN_MODIFY 0x00000002 /* File was modified */
10#define FAN_ATTRIB 0x00000004 /* Metadata changed */
11#define FAN_CLOSE_WRITE 0x00000008 /* Writable file closed */
12#define FAN_CLOSE_NOWRITE 0x00000010 /* Unwritable file closed */
13#define FAN_OPEN 0x00000020 /* File was opened */
14#define FAN_MOVED_FROM 0x00000040 /* File was moved from X */
15#define FAN_MOVED_TO 0x00000080 /* File was moved to Y */
16#define FAN_CREATE 0x00000100 /* Subfile was created */
17#define FAN_DELETE 0x00000200 /* Subfile was deleted */
18#define FAN_DELETE_SELF 0x00000400 /* Self was deleted */
19#define FAN_MOVE_SELF 0x00000800 /* Self was moved */
20#define FAN_OPEN_EXEC 0x00001000 /* File was opened for exec */
21
22#define FAN_Q_OVERFLOW 0x00004000 /* Event queued overflowed */
23#define FAN_FS_ERROR 0x00008000 /* Filesystem error */
24
25#define FAN_OPEN_PERM 0x00010000 /* File open in perm check */
26#define FAN_ACCESS_PERM 0x00020000 /* File accessed in perm check */
27#define FAN_OPEN_EXEC_PERM 0x00040000 /* File open/exec in perm check */
28/* #define FAN_DIR_MODIFY 0x00080000 */ /* Deprecated (reserved) */
29
30#define FAN_PRE_ACCESS 0x00100000 /* Pre-content access hook */
31
32#define FAN_EVENT_ON_CHILD 0x08000000 /* Interested in child events */
33
34#define FAN_RENAME 0x10000000 /* File was renamed */
35
36#define FAN_ONDIR 0x40000000 /* Event occurred against dir */
37
38/* helper events */
39#define FAN_CLOSE (FAN_CLOSE_WRITE | FAN_CLOSE_NOWRITE) /* close */
40#define FAN_MOVE (FAN_MOVED_FROM | FAN_MOVED_TO) /* moves */
41
42/* flags used for fanotify_init() */
43#define FAN_CLOEXEC 0x00000001
44#define FAN_NONBLOCK 0x00000002
45
46/* These are NOT bitwise flags. Both bits are used together. */
47#define FAN_CLASS_NOTIF 0x00000000
48#define FAN_CLASS_CONTENT 0x00000004
49#define FAN_CLASS_PRE_CONTENT 0x00000008
50
51/* Deprecated - do not use this in programs and do not add new flags here! */
52#define FAN_ALL_CLASS_BITS (FAN_CLASS_NOTIF | FAN_CLASS_CONTENT | \
53 FAN_CLASS_PRE_CONTENT)
54
55#define FAN_UNLIMITED_QUEUE 0x00000010
56#define FAN_UNLIMITED_MARKS 0x00000020
57#define FAN_ENABLE_AUDIT 0x00000040
58
59/* Flags to determine fanotify event format */
60#define FAN_REPORT_PIDFD 0x00000080 /* Report pidfd for event->pid */
61#define FAN_REPORT_TID 0x00000100 /* event->pid is thread id */
62#define FAN_REPORT_FID 0x00000200 /* Report unique file id */
63#define FAN_REPORT_DIR_FID 0x00000400 /* Report unique directory id */
64#define FAN_REPORT_NAME 0x00000800 /* Report events with name */
65#define FAN_REPORT_TARGET_FID 0x00001000 /* Report dirent target id */
66#define FAN_REPORT_FD_ERROR 0x00002000 /* event->fd can report error */
67
68/* Convenience macro - FAN_REPORT_NAME requires FAN_REPORT_DIR_FID */
69#define FAN_REPORT_DFID_NAME (FAN_REPORT_DIR_FID | FAN_REPORT_NAME)
70/* Convenience macro - FAN_REPORT_TARGET_FID requires all other FID flags */
71#define FAN_REPORT_DFID_NAME_TARGET (FAN_REPORT_DFID_NAME | \
72 FAN_REPORT_FID | FAN_REPORT_TARGET_FID)
73
74/* Deprecated - do not use this in programs and do not add new flags here! */
75#define FAN_ALL_INIT_FLAGS (FAN_CLOEXEC | FAN_NONBLOCK | \
76 FAN_ALL_CLASS_BITS | FAN_UNLIMITED_QUEUE |\
77 FAN_UNLIMITED_MARKS)
78
79/* flags used for fanotify_modify_mark() */
80#define FAN_MARK_ADD 0x00000001
81#define FAN_MARK_REMOVE 0x00000002
82#define FAN_MARK_DONT_FOLLOW 0x00000004
83#define FAN_MARK_ONLYDIR 0x00000008
84/* FAN_MARK_MOUNT is 0x00000010 */
85#define FAN_MARK_IGNORED_MASK 0x00000020
86#define FAN_MARK_IGNORED_SURV_MODIFY 0x00000040
87#define FAN_MARK_FLUSH 0x00000080
88/* FAN_MARK_FILESYSTEM is 0x00000100 */
89#define FAN_MARK_EVICTABLE 0x00000200
90/* This bit is mutually exclusive with FAN_MARK_IGNORED_MASK bit */
91#define FAN_MARK_IGNORE 0x00000400
92
93/* These are NOT bitwise flags. Both bits can be used togther. */
94#define FAN_MARK_INODE 0x00000000
95#define FAN_MARK_MOUNT 0x00000010
96#define FAN_MARK_FILESYSTEM 0x00000100
97
98/*
99 * Convenience macro - FAN_MARK_IGNORE requires FAN_MARK_IGNORED_SURV_MODIFY
100 * for non-inode mark types.
101 */
102#define FAN_MARK_IGNORE_SURV (FAN_MARK_IGNORE | FAN_MARK_IGNORED_SURV_MODIFY)
103
104/* Deprecated - do not use this in programs and do not add new flags here! */
105#define FAN_ALL_MARK_FLAGS (FAN_MARK_ADD |\
106 FAN_MARK_REMOVE |\
107 FAN_MARK_DONT_FOLLOW |\
108 FAN_MARK_ONLYDIR |\
109 FAN_MARK_MOUNT |\
110 FAN_MARK_IGNORED_MASK |\
111 FAN_MARK_IGNORED_SURV_MODIFY |\
112 FAN_MARK_FLUSH)
113
114/* Deprecated - do not use this in programs and do not add new flags here! */
115#define FAN_ALL_EVENTS (FAN_ACCESS |\
116 FAN_MODIFY |\
117 FAN_CLOSE |\
118 FAN_OPEN)
119
120/*
121 * All events which require a permission response from userspace
122 */
123/* Deprecated - do not use this in programs and do not add new flags here! */
124#define FAN_ALL_PERM_EVENTS (FAN_OPEN_PERM |\
125 FAN_ACCESS_PERM)
126
127/* Deprecated - do not use this in programs and do not add new flags here! */
128#define FAN_ALL_OUTGOING_EVENTS (FAN_ALL_EVENTS |\
129 FAN_ALL_PERM_EVENTS |\
130 FAN_Q_OVERFLOW)
131
132#define FANOTIFY_METADATA_VERSION 3
133
134struct fanotify_event_metadata {
135 __u32 event_len;
136 __u8 vers;
137 __u8 reserved;
138 __u16 metadata_len;
139 __aligned_u64 mask;
140 __s32 fd;
141 __s32 pid;
142};
143
144#define FAN_EVENT_INFO_TYPE_FID 1
145#define FAN_EVENT_INFO_TYPE_DFID_NAME 2
146#define FAN_EVENT_INFO_TYPE_DFID 3
147#define FAN_EVENT_INFO_TYPE_PIDFD 4
148#define FAN_EVENT_INFO_TYPE_ERROR 5
149#define FAN_EVENT_INFO_TYPE_RANGE 6
150
151/* Special info types for FAN_RENAME */
152#define FAN_EVENT_INFO_TYPE_OLD_DFID_NAME 10
153/* Reserved for FAN_EVENT_INFO_TYPE_OLD_DFID 11 */
154#define FAN_EVENT_INFO_TYPE_NEW_DFID_NAME 12
155/* Reserved for FAN_EVENT_INFO_TYPE_NEW_DFID 13 */
156
157/* Variable length info record following event metadata */
158struct fanotify_event_info_header {
159 __u8 info_type;
160 __u8 pad;
161 __u16 len;
162};
163
164/*
165 * Unique file identifier info record.
166 * This structure is used for records of types FAN_EVENT_INFO_TYPE_FID,
167 * FAN_EVENT_INFO_TYPE_DFID and FAN_EVENT_INFO_TYPE_DFID_NAME.
168 * For FAN_EVENT_INFO_TYPE_DFID_NAME there is additionally a null terminated
169 * name immediately after the file handle.
170 */
171struct fanotify_event_info_fid {
172 struct fanotify_event_info_header hdr;
173 __kernel_fsid_t fsid;
174 /*
175 * Following is an opaque struct file_handle that can be passed as
176 * an argument to open_by_handle_at(2).
177 */
178 unsigned char handle[];
179};
180
181/*
182 * This structure is used for info records of type FAN_EVENT_INFO_TYPE_PIDFD.
183 * It holds a pidfd for the pid that was responsible for generating an event.
184 */
185struct fanotify_event_info_pidfd {
186 struct fanotify_event_info_header hdr;
187 __s32 pidfd;
188};
189
190struct fanotify_event_info_error {
191 struct fanotify_event_info_header hdr;
192 __s32 error;
193 __u32 error_count;
194};
195
196struct fanotify_event_info_range {
197 struct fanotify_event_info_header hdr;
198 __u32 pad;
199 __u64 offset;
200 __u64 count;
201};
202
203/*
204 * User space may need to record additional information about its decision.
205 * The extra information type records what kind of information is included.
206 * The default is none. We also define an extra information buffer whose
207 * size is determined by the extra information type.
208 *
209 * If the information type is Audit Rule, then the information following
210 * is the rule number that triggered the user space decision that
211 * requires auditing.
212 */
213
214#define FAN_RESPONSE_INFO_NONE 0
215#define FAN_RESPONSE_INFO_AUDIT_RULE 1
216
217struct fanotify_response {
218 __s32 fd;
219 __u32 response;
220};
221
222struct fanotify_response_info_header {
223 __u8 type;
224 __u8 pad;
225 __u16 len;
226};
227
228struct fanotify_response_info_audit_rule {
229 struct fanotify_response_info_header hdr;
230 __u32 rule_number;
231 __u32 subj_trust;
232 __u32 obj_trust;
233};
234
235/* Legit userspace responses to a _PERM event */
236#define FAN_ALLOW 0x01
237#define FAN_DENY 0x02
238/* errno other than EPERM can specified in upper byte of deny response */
239#define FAN_ERRNO_BITS 8
240#define FAN_ERRNO_SHIFT (32 - FAN_ERRNO_BITS)
241#define FAN_ERRNO_MASK ((1 << FAN_ERRNO_BITS) - 1)
242#define FAN_DENY_ERRNO(err) \
243 (FAN_DENY | ((((__u32)(err)) & FAN_ERRNO_MASK) << FAN_ERRNO_SHIFT))
244
245#define FAN_AUDIT 0x10 /* Bitmask to create audit record for result */
246#define FAN_INFO 0x20 /* Bitmask to indicate additional information */
247
248/* No fd set in event */
249#define FAN_NOFD -1
250#define FAN_NOPIDFD FAN_NOFD
251#define FAN_EPIDFD -2
252
253/* Helper functions to deal with fanotify_event_metadata buffers */
254#define FAN_EVENT_METADATA_LEN (sizeof(struct fanotify_event_metadata))
255
256#define FAN_EVENT_NEXT(meta, len) ((len) -= (meta)->event_len, \
257 (struct fanotify_event_metadata*)(((char *)(meta)) + \
258 (meta)->event_len))
259
260#define FAN_EVENT_OK(meta, len) ((long)(len) >= (long)FAN_EVENT_METADATA_LEN && \
261 (long)(meta)->event_len >= (long)FAN_EVENT_METADATA_LEN && \
262 (long)(meta)->event_len <= (long)(len))
263
264#endif /* _UAPI_LINUX_FANOTIFY_H */