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 /* FIXME currently Q's have no limit.... */
  16 #define FAN_Q_OVERFLOW          0x00004000      /* Event queued overflowed */
  17
  18 /* helper events */
  19 #define FAN_CLOSE               (FAN_CLOSE_WRITE | FAN_CLOSE_NOWRITE) /* close */
  20
  21 /* flags used for fanotify_init() */
  22 #define FAN_CLOEXEC             0x00000001
  23 #define FAN_NONBLOCK            0x00000002
  24
  25 #define FAN_ALL_INIT_FLAGS      (FAN_CLOEXEC | FAN_NONBLOCK)
  26
  27 /* flags used for fanotify_modify_mark() */
  28 #define FAN_MARK_ADD            0x00000001
  29 #define FAN_MARK_REMOVE         0x00000002
  30 #define FAN_MARK_DONT_FOLLOW    0x00000004
  31 #define FAN_MARK_ONLYDIR        0x00000008
  32
  33 #define FAN_ALL_MARK_FLAGS      (FAN_MARK_ADD |\
  34                                  FAN_MARK_REMOVE |\
  35                                  FAN_MARK_DONT_FOLLOW |\
  36                                  FAN_MARK_ONLYDIR)
  37
  38 /*
  39  * All of the events - we build the list by hand so that we can add flags in
  40  * the future and not break backward compatibility.  Apps will get only the
  41  * events that they originally wanted.  Be sure to add new events here!
  42  */
  43 #define FAN_ALL_EVENTS (FAN_ACCESS |\
  44                         FAN_MODIFY |\
  45                         FAN_CLOSE |\
  46                         FAN_OPEN)
  47
  48 /*
  49  * All legal FAN bits userspace can request (although possibly not all
  50  * at the same time.
  51  */
  52 #define FAN_ALL_INCOMING_EVENTS (FAN_ALL_EVENTS |\
  53                                  FAN_EVENT_ON_CHILD)
  54
  55 #define FAN_ALL_OUTGOING_EVENTS (FAN_ALL_EVENTS |\
  56                                  FAN_Q_OVERFLOW)
  57
  58 #define FANOTIFY_METADATA_VERSION       1
  59
  60 struct fanotify_event_metadata {
  61         __u32 event_len;
  62         __u32 vers;
  63         __s32 fd;
  64         __u64 mask;
  65 } __attribute__ ((packed));
  66
  67 /* Helper functions to deal with fanotify_event_metadata buffers */
  68 #define FAN_EVENT_METADATA_LEN (sizeof(struct fanotify_event_metadata))
  69
  70 #define FAN_EVENT_NEXT(meta, len) ((len) -= (meta)->event_len, \
  71                                    (struct fanotify_event_metadata*)(((char *)(meta)) + \
  72                                    (meta)->event_len))
  73
  74 #define FAN_EVENT_OK(meta, len) ((long)(len) >= (long)FAN_EVENT_METADATA_LEN && \
  75                                 (long)(meta)->event_len >= (long)FAN_EVENT_METADATA_LEN && \
  76                                 (long)(meta)->event_len <= (long)(len))
  77
  78 #ifdef __KERNEL__
  79
  80 #endif /* __KERNEL__ */
  81 #endif /* _LINUX_FANOTIFY_H */