include/linux/fsnotify_backend.h

   1 /*
   2  * Filesystem access notification for Linux
   3  *
   4  *  Copyright (C) 2008 Red Hat, Inc., Eric Paris <eparis@redhat.com>
   5  */
   6
   7 #ifndef __LINUX_FSNOTIFY_BACKEND_H
   8 #define __LINUX_FSNOTIFY_BACKEND_H
   9
  10 #ifdef __KERNEL__
  11
  12 #include <linux/fs.h> /* struct inode */
  13 #include <linux/list.h>
  14 #include <linux/path.h> /* struct path */
  15 #include <linux/spinlock.h>
  16 #include <linux/types.h>
  17
  18 #include <asm/atomic.h>
  19
  20 /*
  21  * IN_* from inotfy.h lines up EXACTLY with FS_*, this is so we can easily
  22  * convert between them.  dnotify only needs conversion at watch creation
  23  * so no perf loss there.  fanotify isn't defined yet, so it can use the
  24  * wholes if it needs more events.
  25  */
  26 #define FS_ACCESS               0x00000001      /* File was accessed */
  27 #define FS_MODIFY               0x00000002      /* File was modified */
  28 #define FS_ATTRIB               0x00000004      /* Metadata changed */
  29 #define FS_CLOSE_WRITE          0x00000008      /* Writtable file was closed */
  30 #define FS_CLOSE_NOWRITE        0x00000010      /* Unwrittable file closed */
  31 #define FS_OPEN                 0x00000020      /* File was opened */
  32 #define FS_MOVED_FROM           0x00000040      /* File was moved from X */
  33 #define FS_MOVED_TO             0x00000080      /* File was moved to Y */
  34 #define FS_CREATE               0x00000100      /* Subfile was created */
  35 #define FS_DELETE               0x00000200      /* Subfile was deleted */
  36 #define FS_DELETE_SELF          0x00000400      /* Self was deleted */
  37 #define FS_MOVE_SELF            0x00000800      /* Self was moved */
  38
  39 #define FS_UNMOUNT              0x00002000      /* inode on umount fs */
  40 #define FS_Q_OVERFLOW           0x00004000      /* Event queued overflowed */
  41 #define FS_IN_IGNORED           0x00008000      /* last inotify event here */
  42
  43 #define FS_IN_ISDIR             0x40000000      /* event occurred against dir */
  44 #define FS_IN_ONESHOT           0x80000000      /* only send event once */
  45
  46 #define FS_DN_RENAME            0x10000000      /* file renamed */
  47 #define FS_DN_MULTISHOT         0x20000000      /* dnotify multishot */
  48
  49 /* This inode cares about things that happen to its children.  Always set for
  50  * dnotify and inotify. */
  51 #define FS_EVENT_ON_CHILD       0x08000000
  52
  53 /* This is a list of all events that may get sent to a parernt based on fs event
  54  * happening to inodes inside that directory */
  55 #define FS_EVENTS_POSS_ON_CHILD   (FS_ACCESS | FS_MODIFY | FS_ATTRIB |\
  56                                    FS_CLOSE_WRITE | FS_CLOSE_NOWRITE | FS_OPEN |\
  57                                    FS_MOVED_FROM | FS_MOVED_TO | FS_CREATE |\
  58                                    FS_DELETE)
  59
  60 struct fsnotify_group;
  61 struct fsnotify_event;
  62 struct fsnotify_mark_entry;
  63
  64 /*
  65  * Each group much define these ops.  The fsnotify infrastructure will call
  66  * these operations for each relevant group.
  67  *
  68  * should_send_event - given a group, inode, and mask this function determines
  69  *              if the group is interested in this event.
  70  * handle_event - main call for a group to handle an fs event
  71  * free_group_priv - called when a group refcnt hits 0 to clean up the private union
  72  * freeing-mark - this means that a mark has been flagged to die when everything
  73  *              finishes using it.  The function is supplied with what must be a
  74  *              valid group and inode to use to clean up.
  75  */
  76 struct fsnotify_ops {
  77         bool (*should_send_event)(struct fsnotify_group *group, struct inode *inode, __u32 mask);
  78         int (*handle_event)(struct fsnotify_group *group, struct fsnotify_event *event);
  79         void (*free_group_priv)(struct fsnotify_group *group);
  80         void (*freeing_mark)(struct fsnotify_mark_entry *entry, struct fsnotify_group *group);
  81 };
  82
  83 /*
  84  * A group is a "thing" that wants to receive notification about filesystem
  85  * events.  The mask holds the subset of event types this group cares about.
  86  * refcnt on a group is up to the implementor and at any moment if it goes 0
  87  * everything will be cleaned up.
  88  */
  89 struct fsnotify_group {
  90         /*
  91          * global list of all groups receiving events from fsnotify.
  92          * anchored by fsnotify_groups and protected by either fsnotify_grp_mutex
  93          * or fsnotify_grp_srcu depending on write vs read.
  94          */
  95         struct list_head group_list;
  96
  97         /*
  98          * Defines all of the event types in which this group is interested.
  99          * This mask is a bitwise OR of the FS_* events from above.  Each time
 100          * this mask changes for a group (if it changes) the correct functions
 101          * must be called to update the global structures which indicate global
 102          * interest in event types.
 103          */
 104         __u32 mask;
 105
 106         /*
 107          * How the refcnt is used is up to each group.  When the refcnt hits 0
 108          * fsnotify will clean up all of the resources associated with this group.
 109          * As an example, the dnotify group will always have a refcnt=1 and that
 110          * will never change.  Inotify, on the other hand, has a group per
 111          * inotify_init() and the refcnt will hit 0 only when that fd has been
 112          * closed.
 113          */
 114         atomic_t refcnt;                /* things with interest in this group */
 115         unsigned int group_num;         /* simply prevents accidental group collision */
 116
 117         const struct fsnotify_ops *ops; /* how this group handles things */
 118
 119         /* stores all fastapth entries assoc with this group so they can be cleaned on unregister */
 120         spinlock_t mark_lock;           /* protect mark_entries list */
 121         atomic_t num_marks;             /* 1 for each mark entry and 1 for not being
 122                                          * past the point of no return when freeing
 123                                          * a group */
 124         struct list_head mark_entries;  /* all inode mark entries for this group */
 125
 126         /* prevents double list_del of group_list.  protected by global fsnotify_grp_mutex */
 127         bool on_group_list;
 128
 129         /* groups can define private fields here or use the void *private */
 130         union {
 131                 void *private;
 132         };
 133 };
 134
 135 /*
 136  * all of the information about the original object we want to now send to
 137  * a group.  If you want to carry more info from the accessing task to the
 138  * listener this structure is where you need to be adding fields.
 139  */
 140 struct fsnotify_event {
 141         spinlock_t lock;        /* protection for the associated event_holder and private_list */
 142         /* to_tell may ONLY be dereferenced during handle_event(). */
 143         struct inode *to_tell;  /* either the inode the event happened to or its parent */
 144         /*
 145          * depending on the event type we should have either a path or inode
 146          * We hold a reference on path, but NOT on inode.  Since we have the ref on
 147          * the path, it may be dereferenced at any point during this object's
 148          * lifetime.  That reference is dropped when this object's refcnt hits
 149          * 0.  If this event contains an inode instead of a path, the inode may
 150          * ONLY be used during handle_event().
 151          */
 152         union {
 153                 struct path path;
 154                 struct inode *inode;
 155         };
 156 /* when calling fsnotify tell it if the data is a path or inode */
 157 #define FSNOTIFY_EVENT_NONE     0
 158 #define FSNOTIFY_EVENT_PATH     1
 159 #define FSNOTIFY_EVENT_INODE    2
 160 #define FSNOTIFY_EVENT_FILE     3
 161         int data_type;          /* which of the above union we have */
 162         atomic_t refcnt;        /* how many groups still are using/need to send this event */
 163         __u32 mask;             /* the type of access, bitwise OR for FS_* event types */
 164 };
 165
 166 /*
 167  * a mark is simply an entry attached to an in core inode which allows an
 168  * fsnotify listener to indicate they are either no longer interested in events
 169  * of a type matching mask or only interested in those events.
 170  *
 171  * these are flushed when an inode is evicted from core and may be flushed
 172  * when the inode is modified (as seen by fsnotify_access).  Some fsnotify users
 173  * (such as dnotify) will flush these when the open fd is closed and not at
 174  * inode eviction or modification.
 175  */
 176 struct fsnotify_mark_entry {
 177         __u32 mask;                     /* mask this mark entry is for */
 178         /* we hold ref for each i_list and g_list.  also one ref for each 'thing'
 179          * in kernel that found and may be using this mark. */
 180         atomic_t refcnt;                /* active things looking at this mark */
 181         struct inode *inode;            /* inode this entry is associated with */
 182         struct fsnotify_group *group;   /* group this mark entry is for */
 183         struct hlist_node i_list;       /* list of mark_entries by inode->i_fsnotify_mark_entries */
 184         struct list_head g_list;        /* list of mark_entries by group->i_fsnotify_mark_entries */
 185         spinlock_t lock;                /* protect group, inode, and killme */
 186         struct list_head free_i_list;   /* tmp list used when freeing this mark */
 187         struct list_head free_g_list;   /* tmp list used when freeing this mark */
 188         void (*free_mark)(struct fsnotify_mark_entry *entry); /* called on final put+free */
 189 };
 190
 191 #ifdef CONFIG_FSNOTIFY
 192
 193 /* called from the vfs helpers */
 194
 195 /* main fsnotify call to send events */
 196 extern void fsnotify(struct inode *to_tell, __u32 mask, void *data, int data_is);
 197 extern void __fsnotify_parent(struct dentry *dentry, __u32 mask);
 198 extern void __fsnotify_inode_delete(struct inode *inode);
 199
 200 static inline int fsnotify_inode_watches_children(struct inode *inode)
 201 {
 202         /* FS_EVENT_ON_CHILD is set if the inode may care */
 203         if (!(inode->i_fsnotify_mask & FS_EVENT_ON_CHILD))
 204                 return 0;
 205         /* this inode might care about child events, does it care about the
 206          * specific set of events that can happen on a child? */
 207         return inode->i_fsnotify_mask & FS_EVENTS_POSS_ON_CHILD;
 208 }
 209
 210 /*
 211  * Update the dentry with a flag indicating the interest of its parent to receive
 212  * filesystem events when those events happens to this dentry->d_inode.
 213  */
 214 static inline void __fsnotify_update_dcache_flags(struct dentry *dentry)
 215 {
 216         struct dentry *parent;
 217
 218         assert_spin_locked(&dcache_lock);
 219         assert_spin_locked(&dentry->d_lock);
 220
 221         parent = dentry->d_parent;
 222         if (fsnotify_inode_watches_children(parent->d_inode))
 223                 dentry->d_flags |= DCACHE_FSNOTIFY_PARENT_WATCHED;
 224         else
 225                 dentry->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
 226 }
 227
 228 /*
 229  * fsnotify_d_instantiate - instantiate a dentry for inode
 230  * Called with dcache_lock held.
 231  */
 232 static inline void __fsnotify_d_instantiate(struct dentry *dentry, struct inode *inode)
 233 {
 234         if (!inode)
 235                 return;
 236
 237         assert_spin_locked(&dcache_lock);
 238
 239         spin_lock(&dentry->d_lock);
 240         __fsnotify_update_dcache_flags(dentry);
 241         spin_unlock(&dentry->d_lock);
 242 }
 243
 244 /* called from fsnotify listeners, such as fanotify or dnotify */
 245
 246 /* must call when a group changes its ->mask */
 247 extern void fsnotify_recalc_global_mask(void);
 248 /* get a reference to an existing or create a new group */
 249 extern struct fsnotify_group *fsnotify_obtain_group(unsigned int group_num,
 250                                                     __u32 mask,
 251                                                     const struct fsnotify_ops *ops);
 252 /* run all marks associated with this group and update group->mask */
 253 extern void fsnotify_recalc_group_mask(struct fsnotify_group *group);
 254 /* drop reference on a group from fsnotify_obtain_group */
 255 extern void fsnotify_put_group(struct fsnotify_group *group);
 256
 257 /* take a reference to an event */
 258 extern void fsnotify_get_event(struct fsnotify_event *event);
 259 extern void fsnotify_put_event(struct fsnotify_event *event);
 260 /* find private data previously attached to an event */
 261 extern struct fsnotify_event_private_data *fsnotify_get_priv_from_event(struct fsnotify_group *group,
 262                                                                         struct fsnotify_event *event);
 263
 264 /* functions used to manipulate the marks attached to inodes */
 265
 266 /* run all marks associated with an inode and update inode->i_fsnotify_mask */
 267 extern void fsnotify_recalc_inode_mask(struct inode *inode);
 268 extern void fsnotify_init_mark(struct fsnotify_mark_entry *entry, void (*free_mark)(struct fsnotify_mark_entry *entry));
 269 /* find (and take a reference) to a mark associated with group and inode */
 270 extern struct fsnotify_mark_entry *fsnotify_find_mark_entry(struct fsnotify_group *group, struct inode *inode);
 271 /* attach the mark to both the group and the inode */
 272 extern int fsnotify_add_mark(struct fsnotify_mark_entry *entry, struct fsnotify_group *group, struct inode *inode);
 273 /* given a mark, flag it to be freed when all references are dropped */
 274 extern void fsnotify_destroy_mark_by_entry(struct fsnotify_mark_entry *entry);
 275 /* run all the marks in a group, and flag them to be freed */
 276 extern void fsnotify_clear_marks_by_group(struct fsnotify_group *group);
 277 extern void fsnotify_get_mark(struct fsnotify_mark_entry *entry);
 278 extern void fsnotify_put_mark(struct fsnotify_mark_entry *entry);
 279
 280 /* put here because inotify does some weird stuff when destroying watches */
 281 extern struct fsnotify_event *fsnotify_create_event(struct inode *to_tell, __u32 mask,
 282                                                     void *data, int data_is);
 283 #else
 284
 285 static inline void fsnotify(struct inode *to_tell, __u32 mask, void *data, int data_is)
 286 {}
 287
 288 static inline void __fsnotify_parent(struct dentry *dentry, __u32 mask)
 289 {}
 290
 291 static inline void __fsnotify_inode_delete(struct inode *inode)
 292 {}
 293
 294 static inline void __fsnotify_update_dcache_flags(struct dentry *dentry)
 295 {}
 296
 297 static inline void __fsnotify_d_instantiate(struct dentry *dentry, struct inode *inode)
 298 {}
 299
 300 #endif  /* CONFIG_FSNOTIFY */
 301
 302 #endif  /* __KERNEL __ */
 303
 304 #endif  /* __LINUX_FSNOTIFY_BACKEND_H */