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 /* Writtable file closed */ 12 #define FAN_CLOSE_NOWRITE 0x00000010 /* Unwrittable 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 29 #define FAN_EVENT_ON_CHILD 0x08000000 /* Interested in child events */ 30 31 #define FAN_RENAME 0x10000000 /* File was renamed */ 32 33 #define FAN_ONDIR 0x40000000 /* Event occurred against dir */ 34 35 /* helper events */ 36 #define FAN_CLOSE (FAN_CLOSE_WRITE | FAN_CLOSE_NOWRITE) /* close */ 37 #define FAN_MOVE (FAN_MOVED_FROM | FAN_MOVED_TO) /* moves */ 38 39 /* flags used for fanotify_init() */ 40 #define FAN_CLOEXEC 0x00000001 41 #define FAN_NONBLOCK 0x00000002 42 43 /* These are NOT bitwise flags. Both bits are used together. */ 44 #define FAN_CLASS_NOTIF 0x00000000 45 #define FAN_CLASS_CONTENT 0x00000004 46 #define FAN_CLASS_PRE_CONTENT 0x00000008 47 48 /* Deprecated - do not use this in programs and do not add new flags here! */ 49 #define FAN_ALL_CLASS_BITS (FAN_CLASS_NOTIF | FAN_CLASS_CONTENT | \ 50 FAN_CLASS_PRE_CONTENT) 51 52 #define FAN_UNLIMITED_QUEUE 0x00000010 53 #define FAN_UNLIMITED_MARKS 0x00000020 54 #define FAN_ENABLE_AUDIT 0x00000040 55 56 /* Flags to determine fanotify event format */ 57 #define FAN_REPORT_PIDFD 0x00000080 /* Report pidfd for event->pid */ 58 #define FAN_REPORT_TID 0x00000100 /* event->pid is thread id */ 59 #define FAN_REPORT_FID 0x00000200 /* Report unique file id */ 60 #define FAN_REPORT_DIR_FID 0x00000400 /* Report unique directory id */ 61 #define FAN_REPORT_NAME 0x00000800 /* Report events with name */ 62 #define FAN_REPORT_TARGET_FID 0x00001000 /* Report dirent target id */ 63 64 /* Convenience macro - FAN_REPORT_NAME requires FAN_REPORT_DIR_FID */ 65 #define FAN_REPORT_DFID_NAME (FAN_REPORT_DIR_FID | FAN_REPORT_NAME) 66 /* Convenience macro - FAN_REPORT_TARGET_FID requires all other FID flags */ 67 #define FAN_REPORT_DFID_NAME_TARGET (FAN_REPORT_DFID_NAME | \ 68 FAN_REPORT_FID | FAN_REPORT_TARGET_FID) 69 70 /* Deprecated - do not use this in programs and do not add new flags here! */ 71 #define FAN_ALL_INIT_FLAGS (FAN_CLOEXEC | FAN_NONBLOCK | \ 72 FAN_ALL_CLASS_BITS | FAN_UNLIMITED_QUEUE |\ 73 FAN_UNLIMITED_MARKS) 74 75 /* flags used for fanotify_modify_mark() */ 76 #define FAN_MARK_ADD 0x00000001 77 #define FAN_MARK_REMOVE 0x00000002 78 #define FAN_MARK_DONT_FOLLOW 0x00000004 79 #define FAN_MARK_ONLYDIR 0x00000008 80 /* FAN_MARK_MOUNT is 0x00000010 */ 81 #define FAN_MARK_IGNORED_MASK 0x00000020 82 #define FAN_MARK_IGNORED_SURV_MODIFY 0x00000040 83 #define FAN_MARK_FLUSH 0x00000080 84 /* FAN_MARK_FILESYSTEM is 0x00000100 */ 85 #define FAN_MARK_EVICTABLE 0x00000200 86 87 /* These are NOT bitwise flags. Both bits can be used togther. */ 88 #define FAN_MARK_INODE 0x00000000 89 #define FAN_MARK_MOUNT 0x00000010 90 #define FAN_MARK_FILESYSTEM 0x00000100 91 92 /* Deprecated - do not use this in programs and do not add new flags here! */ 93 #define FAN_ALL_MARK_FLAGS (FAN_MARK_ADD |\ 94 FAN_MARK_REMOVE |\ 95 FAN_MARK_DONT_FOLLOW |\ 96 FAN_MARK_ONLYDIR |\ 97 FAN_MARK_MOUNT |\ 98 FAN_MARK_IGNORED_MASK |\ 99 FAN_MARK_IGNORED_SURV_MODIFY |\ 100 FAN_MARK_FLUSH) 101 102 /* Deprecated - do not use this in programs and do not add new flags here! */ 103 #define FAN_ALL_EVENTS (FAN_ACCESS |\ 104 FAN_MODIFY |\ 105 FAN_CLOSE |\ 106 FAN_OPEN) 107 108 /* 109 * All events which require a permission response from userspace 110 */ 111 /* Deprecated - do not use this in programs and do not add new flags here! */ 112 #define FAN_ALL_PERM_EVENTS (FAN_OPEN_PERM |\ 113 FAN_ACCESS_PERM) 114 115 /* Deprecated - do not use this in programs and do not add new flags here! */ 116 #define FAN_ALL_OUTGOING_EVENTS (FAN_ALL_EVENTS |\ 117 FAN_ALL_PERM_EVENTS |\ 118 FAN_Q_OVERFLOW) 119 120 #define FANOTIFY_METADATA_VERSION 3 121 122 struct fanotify_event_metadata { 123 __u32 event_len; 124 __u8 vers; 125 __u8 reserved; 126 __u16 metadata_len; 127 __aligned_u64 mask; 128 __s32 fd; 129 __s32 pid; 130 }; 131 132 #define FAN_EVENT_INFO_TYPE_FID 1 133 #define FAN_EVENT_INFO_TYPE_DFID_NAME 2 134 #define FAN_EVENT_INFO_TYPE_DFID 3 135 #define FAN_EVENT_INFO_TYPE_PIDFD 4 136 #define FAN_EVENT_INFO_TYPE_ERROR 5 137 138 /* Special info types for FAN_RENAME */ 139 #define FAN_EVENT_INFO_TYPE_OLD_DFID_NAME 10 140 /* Reserved for FAN_EVENT_INFO_TYPE_OLD_DFID 11 */ 141 #define FAN_EVENT_INFO_TYPE_NEW_DFID_NAME 12 142 /* Reserved for FAN_EVENT_INFO_TYPE_NEW_DFID 13 */ 143 144 /* Variable length info record following event metadata */ 145 struct fanotify_event_info_header { 146 __u8 info_type; 147 __u8 pad; 148 __u16 len; 149 }; 150 151 /* 152 * Unique file identifier info record. 153 * This structure is used for records of types FAN_EVENT_INFO_TYPE_FID, 154 * FAN_EVENT_INFO_TYPE_DFID and FAN_EVENT_INFO_TYPE_DFID_NAME. 155 * For FAN_EVENT_INFO_TYPE_DFID_NAME there is additionally a null terminated 156 * name immediately after the file handle. 157 */ 158 struct fanotify_event_info_fid { 159 struct fanotify_event_info_header hdr; 160 __kernel_fsid_t fsid; 161 /* 162 * Following is an opaque struct file_handle that can be passed as 163 * an argument to open_by_handle_at(2). 164 */ 165 unsigned char handle[0]; 166 }; 167 168 /* 169 * This structure is used for info records of type FAN_EVENT_INFO_TYPE_PIDFD. 170 * It holds a pidfd for the pid that was responsible for generating an event. 171 */ 172 struct fanotify_event_info_pidfd { 173 struct fanotify_event_info_header hdr; 174 __s32 pidfd; 175 }; 176 177 struct fanotify_event_info_error { 178 struct fanotify_event_info_header hdr; 179 __s32 error; 180 __u32 error_count; 181 }; 182 183 struct fanotify_response { 184 __s32 fd; 185 __u32 response; 186 }; 187 188 /* Legit userspace responses to a _PERM event */ 189 #define FAN_ALLOW 0x01 190 #define FAN_DENY 0x02 191 #define FAN_AUDIT 0x10 /* Bit mask to create audit record for result */ 192 193 /* No fd set in event */ 194 #define FAN_NOFD -1 195 #define FAN_NOPIDFD FAN_NOFD 196 #define FAN_EPIDFD -2 197 198 /* Helper functions to deal with fanotify_event_metadata buffers */ 199 #define FAN_EVENT_METADATA_LEN (sizeof(struct fanotify_event_metadata)) 200 201 #define FAN_EVENT_NEXT(meta, len) ((len) -= (meta)->event_len, \ 202 (struct fanotify_event_metadata*)(((char *)(meta)) + \ 203 (meta)->event_len)) 204 205 #define FAN_EVENT_OK(meta, len) ((long)(len) >= (long)FAN_EVENT_METADATA_LEN && \ 206 (long)(meta)->event_len >= (long)FAN_EVENT_METADATA_LEN && \ 207 (long)(meta)->event_len <= (long)(len)) 208 209 #endif /* _UAPI_LINUX_FANOTIFY_H */ 210