include/uapi/linux/fanotify.h

   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_CLOSE_WRITE         0x00000008      /* Writtable file closed */
  11 #define FAN_CLOSE_NOWRITE       0x00000010      /* Unwrittable file closed */
  12 #define FAN_OPEN                0x00000020      /* File was opened */
  13 #define FAN_OPEN_EXEC           0x00001000      /* File was opened for exec */
  14
  15 #define FAN_Q_OVERFLOW          0x00004000      /* Event queued overflowed */
  16
  17 #define FAN_OPEN_PERM           0x00010000      /* File open in perm check */
  18 #define FAN_ACCESS_PERM         0x00020000      /* File accessed in perm check */
  19 #define FAN_OPEN_EXEC_PERM      0x00040000      /* File open/exec in perm check */
  20
  21 #define FAN_ONDIR               0x40000000      /* event occurred against dir */
  22
  23 #define FAN_EVENT_ON_CHILD      0x08000000      /* interested in child events */
  24
  25 /* helper events */
  26 #define FAN_CLOSE               (FAN_CLOSE_WRITE | FAN_CLOSE_NOWRITE) /* close */
  27
  28 /* flags used for fanotify_init() */
  29 #define FAN_CLOEXEC             0x00000001
  30 #define FAN_NONBLOCK            0x00000002
  31
  32 /* These are NOT bitwise flags.  Both bits are used together.  */
  33 #define FAN_CLASS_NOTIF         0x00000000
  34 #define FAN_CLASS_CONTENT       0x00000004
  35 #define FAN_CLASS_PRE_CONTENT   0x00000008
  36
  37 /* Deprecated - do not use this in programs and do not add new flags here! */
  38 #define FAN_ALL_CLASS_BITS      (FAN_CLASS_NOTIF | FAN_CLASS_CONTENT | \
  39                                  FAN_CLASS_PRE_CONTENT)
  40
  41 #define FAN_UNLIMITED_QUEUE     0x00000010
  42 #define FAN_UNLIMITED_MARKS     0x00000020
  43 #define FAN_ENABLE_AUDIT        0x00000040
  44
  45 /* Flags to determine fanotify event format */
  46 #define FAN_REPORT_TID          0x00000100      /* event->pid is thread id */
  47 #define FAN_REPORT_FID          0x00000200      /* Report unique file id */
  48
  49 /* Deprecated - do not use this in programs and do not add new flags here! */
  50 #define FAN_ALL_INIT_FLAGS      (FAN_CLOEXEC | FAN_NONBLOCK | \
  51                                  FAN_ALL_CLASS_BITS | FAN_UNLIMITED_QUEUE |\
  52                                  FAN_UNLIMITED_MARKS)
  53
  54 /* flags used for fanotify_modify_mark() */
  55 #define FAN_MARK_ADD            0x00000001
  56 #define FAN_MARK_REMOVE         0x00000002
  57 #define FAN_MARK_DONT_FOLLOW    0x00000004
  58 #define FAN_MARK_ONLYDIR        0x00000008
  59 /* FAN_MARK_MOUNT is            0x00000010 */
  60 #define FAN_MARK_IGNORED_MASK   0x00000020
  61 #define FAN_MARK_IGNORED_SURV_MODIFY    0x00000040
  62 #define FAN_MARK_FLUSH          0x00000080
  63 /* FAN_MARK_FILESYSTEM is       0x00000100 */
  64
  65 /* These are NOT bitwise flags.  Both bits can be used togther.  */
  66 #define FAN_MARK_INODE          0x00000000
  67 #define FAN_MARK_MOUNT          0x00000010
  68 #define FAN_MARK_FILESYSTEM     0x00000100
  69
  70 /* Deprecated - do not use this in programs and do not add new flags here! */
  71 #define FAN_ALL_MARK_FLAGS      (FAN_MARK_ADD |\
  72                                  FAN_MARK_REMOVE |\
  73                                  FAN_MARK_DONT_FOLLOW |\
  74                                  FAN_MARK_ONLYDIR |\
  75                                  FAN_MARK_MOUNT |\
  76                                  FAN_MARK_IGNORED_MASK |\
  77                                  FAN_MARK_IGNORED_SURV_MODIFY |\
  78                                  FAN_MARK_FLUSH)
  79
  80 /* Deprecated - do not use this in programs and do not add new flags here! */
  81 #define FAN_ALL_EVENTS (FAN_ACCESS |\
  82                         FAN_MODIFY |\
  83                         FAN_CLOSE |\
  84                         FAN_OPEN)
  85
  86 /*
  87  * All events which require a permission response from userspace
  88  */
  89 /* Deprecated - do not use this in programs and do not add new flags here! */
  90 #define FAN_ALL_PERM_EVENTS (FAN_OPEN_PERM |\
  91                              FAN_ACCESS_PERM)
  92
  93 /* Deprecated - do not use this in programs and do not add new flags here! */
  94 #define FAN_ALL_OUTGOING_EVENTS (FAN_ALL_EVENTS |\
  95                                  FAN_ALL_PERM_EVENTS |\
  96                                  FAN_Q_OVERFLOW)
  97
  98 #define FANOTIFY_METADATA_VERSION       3
  99
 100 struct fanotify_event_metadata {
 101         __u32 event_len;
 102         __u8 vers;
 103         __u8 reserved;
 104         __u16 metadata_len;
 105         __aligned_u64 mask;
 106         __s32 fd;
 107         __s32 pid;
 108 };
 109
 110 #define FAN_EVENT_INFO_TYPE_FID         1
 111
 112 /* Variable length info record following event metadata */
 113 struct fanotify_event_info_header {
 114         __u8 info_type;
 115         __u8 pad;
 116         __u16 len;
 117 };
 118
 119 /* Unique file identifier info record */
 120 struct fanotify_event_info_fid {
 121         struct fanotify_event_info_header hdr;
 122         __kernel_fsid_t fsid;
 123         /*
 124          * Following is an opaque struct file_handle that can be passed as
 125          * an argument to open_by_handle_at(2).
 126          */
 127         unsigned char handle[0];
 128 };
 129
 130 struct fanotify_response {
 131         __s32 fd;
 132         __u32 response;
 133 };
 134
 135 /* Legit userspace responses to a _PERM event */
 136 #define FAN_ALLOW       0x01
 137 #define FAN_DENY        0x02
 138 #define FAN_AUDIT       0x10    /* Bit mask to create audit record for result */
 139
 140 /* No fd set in event */
 141 #define FAN_NOFD        -1
 142
 143 /* Helper functions to deal with fanotify_event_metadata buffers */
 144 #define FAN_EVENT_METADATA_LEN (sizeof(struct fanotify_event_metadata))
 145
 146 #define FAN_EVENT_NEXT(meta, len) ((len) -= (meta)->event_len, \
 147                                    (struct fanotify_event_metadata*)(((char *)(meta)) + \
 148                                    (meta)->event_len))
 149
 150 #define FAN_EVENT_OK(meta, len) ((long)(len) >= (long)FAN_EVENT_METADATA_LEN && \
 151                                 (long)(meta)->event_len >= (long)FAN_EVENT_METADATA_LEN && \
 152                                 (long)(meta)->event_len <= (long)(len))
 153
 154 #endif /* _UAPI_LINUX_FANOTIFY_H */