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      /* Unwrittable file closed */
  10 #define FAN_CLOSE_NOWRITE       0x00000010      /* Writtable file closed */
  11 #define FAN_OPEN                0x00000020      /* File was opened */
  12
  13 #define FAN_EVENT_ON_CHILD      0x08000000      /* interested in child events */
  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
  20 /* helper events */
  21 #define FAN_CLOSE               (FAN_CLOSE_WRITE | FAN_CLOSE_NOWRITE) /* close */
  22
  23 /* flags used for fanotify_init() */
  24 #define FAN_CLOEXEC             0x00000001
  25 #define FAN_NONBLOCK            0x00000002
  26
  27 /* These are NOT bitwise flags.  Both bits are used togther.  */
  28 #define FAN_CLASS_NOTIF         0x00000000
  29 #define FAN_CLASS_CONTENT       0x00000004
  30 #define FAN_CLASS_PRE_CONTENT   0x00000008
  31 #define FAN_ALL_CLASS_BITS      (FAN_CLASS_NOTIF | FAN_CLASS_CONTENT | \
  32                                  FAN_CLASS_PRE_CONTENT)
  33
  34 #define FAN_UNLIMITED_QUEUE     0x00000010
  35
  36 #define FAN_ALL_INIT_FLAGS      (FAN_CLOEXEC | FAN_NONBLOCK | \
  37                                  FAN_ALL_CLASS_BITS | FAN_UNLIMITED_QUEUE)
  38
  39 /* flags used for fanotify_modify_mark() */
  40 #define FAN_MARK_ADD            0x00000001
  41 #define FAN_MARK_REMOVE         0x00000002
  42 #define FAN_MARK_DONT_FOLLOW    0x00000004
  43 #define FAN_MARK_ONLYDIR        0x00000008
  44 #define FAN_MARK_MOUNT          0x00000010
  45 #define FAN_MARK_IGNORED_MASK   0x00000020
  46 #define FAN_MARK_IGNORED_SURV_MODIFY    0x00000040
  47 #define FAN_MARK_FLUSH          0x00000080
  48
  49 #define FAN_ALL_MARK_FLAGS      (FAN_MARK_ADD |\
  50                                  FAN_MARK_REMOVE |\
  51                                  FAN_MARK_DONT_FOLLOW |\
  52                                  FAN_MARK_ONLYDIR |\
  53                                  FAN_MARK_MOUNT |\
  54                                  FAN_MARK_IGNORED_MASK |\
  55                                  FAN_MARK_IGNORED_SURV_MODIFY |\
  56                                  FAN_MARK_FLUSH)
  57
  58 /*
  59  * All of the events - we build the list by hand so that we can add flags in
  60  * the future and not break backward compatibility.  Apps will get only the
  61  * events that they originally wanted.  Be sure to add new events here!
  62  */
  63 #define FAN_ALL_EVENTS (FAN_ACCESS |\
  64                         FAN_MODIFY |\
  65                         FAN_CLOSE |\
  66                         FAN_OPEN)
  67
  68 /*
  69  * All events which require a permission response from userspace
  70  */
  71 #define FAN_ALL_PERM_EVENTS (FAN_OPEN_PERM |\
  72                              FAN_ACCESS_PERM)
  73
  74 #define FAN_ALL_OUTGOING_EVENTS (FAN_ALL_EVENTS |\
  75                                  FAN_ALL_PERM_EVENTS |\
  76                                  FAN_Q_OVERFLOW)
  77
  78 #define FANOTIFY_METADATA_VERSION       2
  79
  80 struct fanotify_event_metadata {
  81         __u32 event_len;
  82         __u32 vers;
  83         __aligned_u64 mask;
  84         __s32 fd;
  85         __s32 pid;
  86 };
  87
  88 struct fanotify_response {
  89         __s32 fd;
  90         __u32 response;
  91 } __attribute__ ((packed));
  92
  93 /* Legit userspace responses to a _PERM event */
  94 #define FAN_ALLOW       0x01
  95 #define FAN_DENY        0x02
  96
  97 /* Helper functions to deal with fanotify_event_metadata buffers */
  98 #define FAN_EVENT_METADATA_LEN (sizeof(struct fanotify_event_metadata))
  99
 100 #define FAN_EVENT_NEXT(meta, len) ((len) -= (meta)->event_len, \
 101                                    (struct fanotify_event_metadata*)(((char *)(meta)) + \
 102                                    (meta)->event_len))
 103
 104 #define FAN_EVENT_OK(meta, len) ((long)(len) >= (long)FAN_EVENT_METADATA_LEN && \
 105                                 (long)(meta)->event_len >= (long)FAN_EVENT_METADATA_LEN && \
 106                                 (long)(meta)->event_len <= (long)(len))
 107
 108 #endif /* _LINUX_FANOTIFY_H */