include/linux/fanotify.h

   1 #ifndef _LINUX_FANOTIFY_H
   2 #define _LINUX_FANOTIFY_H
   3
   4 #include <linux/types.h>
   5
   6 /* the following events that user-space can register for */
   7 #define FAN_ACCESS              0x00000001      /* File was accessed */
   8 #define FAN_MODIFY              0x00000002      /* File was modified */
   9 #define FAN_CLOSE_WRITE         0x00000008      /* Writtable file closed */
  10 #define FAN_CLOSE_NOWRITE       0x00000010      /* Unwrittable file closed */
  11 #define FAN_OPEN                0x00000020      /* File was opened */
  12
  13 #define FAN_Q_OVERFLOW          0x00004000      /* Event queued overflowed */
  14
  15 #define FAN_OPEN_PERM           0x00010000      /* File open in perm check */
  16 #define FAN_ACCESS_PERM         0x00020000      /* File accessed in perm check */
  17
  18 #define FAN_ONDIR               0x40000000      /* event occurred against dir */
  19
  20 #define FAN_EVENT_ON_CHILD      0x08000000      /* interested in child events */
  21
  22 /* helper events */
  23 #define FAN_CLOSE               (FAN_CLOSE_WRITE | FAN_CLOSE_NOWRITE) /* close */
  24
  25 /* flags used for fanotify_init() */
  26 #define FAN_CLOEXEC             0x00000001
  27 #define FAN_NONBLOCK            0x00000002
  28
  29 /* These are NOT bitwise flags.  Both bits are used togther.  */
  30 #define FAN_CLASS_NOTIF         0x00000000
  31 #define FAN_CLASS_CONTENT       0x00000004
  32 #define FAN_CLASS_PRE_CONTENT   0x00000008
  33 #define FAN_ALL_CLASS_BITS      (FAN_CLASS_NOTIF | FAN_CLASS_CONTENT | \
  34                                  FAN_CLASS_PRE_CONTENT)
  35
  36 #define FAN_UNLIMITED_QUEUE     0x00000010
  37 #define FAN_UNLIMITED_MARKS     0x00000020
  38
  39 /* Attempt read-only open if read-write failed. */
  40 #define FAN_READONLY_FALLBACK  0x00000040
  41
  42 #define FAN_ALL_INIT_FLAGS      (FAN_CLOEXEC | FAN_NONBLOCK | \
  43                                  FAN_ALL_CLASS_BITS | FAN_UNLIMITED_QUEUE |\
  44                                  FAN_UNLIMITED_MARKS | FAN_READONLY_FALLBACK)
  45
  46 /* flags used for fanotify_modify_mark() */
  47 #define FAN_MARK_ADD            0x00000001
  48 #define FAN_MARK_REMOVE         0x00000002
  49 #define FAN_MARK_DONT_FOLLOW    0x00000004
  50 #define FAN_MARK_ONLYDIR        0x00000008
  51 #define FAN_MARK_MOUNT          0x00000010
  52 #define FAN_MARK_IGNORED_MASK   0x00000020
  53 #define FAN_MARK_IGNORED_SURV_MODIFY    0x00000040
  54 #define FAN_MARK_FLUSH          0x00000080
  55 #ifdef __KERNEL__
  56 /* not valid from userspace, only kernel internal */
  57 #define FAN_MARK_ONDIR          0x00000100
  58 #endif
  59
  60 #define FAN_ALL_MARK_FLAGS      (FAN_MARK_ADD |\
  61                                  FAN_MARK_REMOVE |\
  62                                  FAN_MARK_DONT_FOLLOW |\
  63                                  FAN_MARK_ONLYDIR |\
  64                                  FAN_MARK_MOUNT |\
  65                                  FAN_MARK_IGNORED_MASK |\
  66                                  FAN_MARK_IGNORED_SURV_MODIFY |\
  67                                  FAN_MARK_FLUSH)
  68
  69 /*
  70  * All of the events - we build the list by hand so that we can add flags in
  71  * the future and not break backward compatibility.  Apps will get only the
  72  * events that they originally wanted.  Be sure to add new events here!
  73  */
  74 #define FAN_ALL_EVENTS (FAN_ACCESS |\
  75                         FAN_MODIFY |\
  76                         FAN_CLOSE |\
  77                         FAN_OPEN)
  78
  79 /*
  80  * All events which require a permission response from userspace
  81  */
  82 #define FAN_ALL_PERM_EVENTS (FAN_OPEN_PERM |\
  83                              FAN_ACCESS_PERM)
  84
  85 #define FAN_ALL_OUTGOING_EVENTS (FAN_ALL_EVENTS |\
  86                                  FAN_ALL_PERM_EVENTS |\
  87                                  FAN_Q_OVERFLOW)
  88
  89 #define FANOTIFY_METADATA_VERSION       3
  90
  91 struct fanotify_event_metadata {
  92         __u32 event_len;
  93         __u8 vers;
  94         __u8 reserved;
  95         __u16 metadata_len;
  96         __aligned_u64 mask;
  97         __s32 fd;
  98         __s32 pid;
  99 };
 100
 101 struct fanotify_response {
 102         __s32 fd;
 103         __u32 response;
 104 };
 105
 106 /* Legit userspace responses to a _PERM event */
 107 #define FAN_ALLOW       0x01
 108 #define FAN_DENY        0x02
 109 /* No fd set in event */
 110 #define FAN_NOFD        -1
 111
 112 /* Helper functions to deal with fanotify_event_metadata buffers */
 113 #define FAN_EVENT_METADATA_LEN (sizeof(struct fanotify_event_metadata))
 114
 115 #define FAN_EVENT_NEXT(meta, len) ((len) -= (meta)->event_len, \
 116                                    (struct fanotify_event_metadata*)(((char *)(meta)) + \
 117                                    (meta)->event_len))
 118
 119 #define FAN_EVENT_OK(meta, len) ((long)(len) >= (long)FAN_EVENT_METADATA_LEN && \
 120                                 (long)(meta)->event_len >= (long)FAN_EVENT_METADATA_LEN && \
 121                                 (long)(meta)->event_len <= (long)(len))
 122
 123 #endif /* _LINUX_FANOTIFY_H */