include/linux/fanotify.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_FANOTIFY_H
   3 #define _LINUX_FANOTIFY_H
   4
   5 #include <uapi/linux/fanotify.h>
   6
   7 #define FAN_GROUP_FLAG(group, flag) \
   8         ((group)->fanotify_data.flags & (flag))
   9
  10 /*
  11  * Flags allowed to be passed from/to userspace.
  12  *
  13  * We intentionally do not add new bits to the old FAN_ALL_* constants, because
  14  * they are uapi exposed constants. If there are programs out there using
  15  * these constant, the programs may break if re-compiled with new uapi headers
  16  * and then run on an old kernel.
  17  */
  18 #define FANOTIFY_CLASS_BITS     (FAN_CLASS_NOTIF | FAN_CLASS_CONTENT | \
  19                                  FAN_CLASS_PRE_CONTENT)
  20
  21 #define FANOTIFY_INIT_FLAGS     (FANOTIFY_CLASS_BITS | \
  22                                  FAN_REPORT_TID | FAN_REPORT_FID | \
  23                                  FAN_CLOEXEC | FAN_NONBLOCK | \
  24                                  FAN_UNLIMITED_QUEUE | FAN_UNLIMITED_MARKS)
  25
  26 #define FANOTIFY_MARK_TYPE_BITS (FAN_MARK_INODE | FAN_MARK_MOUNT | \
  27                                  FAN_MARK_FILESYSTEM)
  28
  29 #define FANOTIFY_MARK_FLAGS     (FANOTIFY_MARK_TYPE_BITS | \
  30                                  FAN_MARK_ADD | \
  31                                  FAN_MARK_REMOVE | \
  32                                  FAN_MARK_DONT_FOLLOW | \
  33                                  FAN_MARK_ONLYDIR | \
  34                                  FAN_MARK_IGNORED_MASK | \
  35                                  FAN_MARK_IGNORED_SURV_MODIFY | \
  36                                  FAN_MARK_FLUSH)
  37
  38 /*
  39  * Events that can be reported with data type FSNOTIFY_EVENT_PATH.
  40  * Note that FAN_MODIFY can also be reported with data type
  41  * FSNOTIFY_EVENT_INODE.
  42  */
  43 #define FANOTIFY_PATH_EVENTS    (FAN_ACCESS | FAN_MODIFY | \
  44                                  FAN_CLOSE | FAN_OPEN | FAN_OPEN_EXEC)
  45
  46 /*
  47  * Directory entry modification events - reported only to directory
  48  * where entry is modified and not to a watching parent.
  49  */
  50 #define FANOTIFY_DIRENT_EVENTS  (FAN_MOVE | FAN_CREATE | FAN_DELETE)
  51
  52 /* Events that can only be reported with data type FSNOTIFY_EVENT_INODE */
  53 #define FANOTIFY_INODE_EVENTS   (FANOTIFY_DIRENT_EVENTS | \
  54                                  FAN_ATTRIB | FAN_MOVE_SELF | FAN_DELETE_SELF)
  55
  56 /* Events that user can request to be notified on */
  57 #define FANOTIFY_EVENTS         (FANOTIFY_PATH_EVENTS | \
  58                                  FANOTIFY_INODE_EVENTS)
  59
  60 /* Events that require a permission response from user */
  61 #define FANOTIFY_PERM_EVENTS    (FAN_OPEN_PERM | FAN_ACCESS_PERM | \
  62                                  FAN_OPEN_EXEC_PERM)
  63
  64 /* Extra flags that may be reported with event or control handling of events */
  65 #define FANOTIFY_EVENT_FLAGS    (FAN_EVENT_ON_CHILD | FAN_ONDIR)
  66
  67 /* Events that may be reported to user */
  68 #define FANOTIFY_OUTGOING_EVENTS        (FANOTIFY_EVENTS | \
  69                                          FANOTIFY_PERM_EVENTS | \
  70                                          FAN_Q_OVERFLOW | FAN_ONDIR)
  71
  72 #define ALL_FANOTIFY_EVENT_BITS         (FANOTIFY_OUTGOING_EVENTS | \
  73                                          FANOTIFY_EVENT_FLAGS)
  74
  75 /* Do not use these old uapi constants internally */
  76 #undef FAN_ALL_CLASS_BITS
  77 #undef FAN_ALL_INIT_FLAGS
  78 #undef FAN_ALL_MARK_FLAGS
  79 #undef FAN_ALL_EVENTS
  80 #undef FAN_ALL_PERM_EVENTS
  81 #undef FAN_ALL_OUTGOING_EVENTS
  82
  83 #endif /* _LINUX_FANOTIFY_H */