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/idr.h> /* inotify uses this */
  13 #include <linux/fs.h> /* struct inode */
  14 #include <linux/list.h>
  15 #include <linux/path.h> /* struct path */
  16 #include <linux/spinlock.h>
  17 #include <linux/types.h>
  18
  19 #include <asm/atomic.h>
  20
  21 /*
  22  * IN_* from inotfy.h lines up EXACTLY with FS_*, this is so we can easily
  23  * convert between them.  dnotify only needs conversion at watch creation
  24  * so no perf loss there.  fanotify isn't defined yet, so it can use the
  25  * wholes if it needs more events.
  26  */
  27 #define FS_ACCESS               0x00000001      /* File was accessed */
  28 #define FS_MODIFY               0x00000002      /* File was modified */
  29 #define FS_ATTRIB               0x00000004      /* Metadata changed */
  30 #define FS_CLOSE_WRITE          0x00000008      /* Writtable file was closed */
  31 #define FS_CLOSE_NOWRITE        0x00000010      /* Unwrittable file closed */
  32 #define FS_OPEN                 0x00000020      /* File was opened */
  33 #define FS_MOVED_FROM           0x00000040      /* File was moved from X */
  34 #define FS_MOVED_TO             0x00000080      /* File was moved to Y */
  35 #define FS_CREATE               0x00000100      /* Subfile was created */
  36 #define FS_DELETE               0x00000200      /* Subfile was deleted */
  37 #define FS_DELETE_SELF          0x00000400      /* Self was deleted */
  38 #define FS_MOVE_SELF            0x00000800      /* Self was moved */
  39
  40 #define FS_UNMOUNT              0x00002000      /* inode on umount fs */
  41 #define FS_Q_OVERFLOW           0x00004000      /* Event queued overflowed */
  42 #define FS_IN_IGNORED           0x00008000      /* last inotify event here */
  43
  44 #define FS_IN_ISDIR             0x40000000      /* event occurred against dir */
  45 #define FS_IN_ONESHOT           0x80000000      /* only send event once */
  46
  47 #define FS_DN_RENAME            0x10000000      /* file renamed */
  48 #define FS_DN_MULTISHOT         0x20000000      /* dnotify multishot */
  49
  50 /* This inode cares about things that happen to its children.  Always set for
  51  * dnotify and inotify. */
  52 #define FS_EVENT_ON_CHILD       0x08000000
  53
  54 /* This is a list of all events that may get sent to a parernt based on fs event
  55  * happening to inodes inside that directory */
  56 #define FS_EVENTS_POSS_ON_CHILD   (FS_ACCESS | FS_MODIFY | FS_ATTRIB |\
  57                                    FS_CLOSE_WRITE | FS_CLOSE_NOWRITE | FS_OPEN |\
  58                                    FS_MOVED_FROM | FS_MOVED_TO | FS_CREATE |\
  59                                    FS_DELETE)
  60
  61 #define FS_MOVE                 (FS_MOVED_FROM | FS_MOVED_TO)
  62
  63 struct fsnotify_group;
  64 struct fsnotify_event;
  65 struct fsnotify_mark_entry;
  66 struct fsnotify_event_private_data;
  67
  68 /*
  69  * Each group much define these ops.  The fsnotify infrastructure will call
  70  * these operations for each relevant group.
  71  *
  72  * should_send_event - given a group, inode, and mask this function determines
  73  *              if the group is interested in this event.
  74  * handle_event - main call for a group to handle an fs event
  75  * free_group_priv - called when a group refcnt hits 0 to clean up the private union
  76  * freeing-mark - this means that a mark has been flagged to die when everything
  77  *              finishes using it.  The function is supplied with what must be a
  78  *              valid group and inode to use to clean up.
  79  */
  80 struct fsnotify_ops {
  81         bool (*should_send_event)(struct fsnotify_group *group, struct inode *inode,
  82                                   __u32 mask, void *data, int data_type);
  83         int (*handle_event)(struct fsnotify_group *group, struct fsnotify_event *event);
  84         void (*free_group_priv)(struct fsnotify_group *group);
  85         void (*freeing_mark)(struct fsnotify_mark_entry *entry, struct fsnotify_group *group);
  86         void (*free_event_priv)(struct fsnotify_event_private_data *priv);
  87 };
  88
  89 /*
  90  * A group is a "thing" that wants to receive notification about filesystem
  91  * events.  The mask holds the subset of event types this group cares about.
  92  * refcnt on a group is up to the implementor and at any moment if it goes 0
  93  * everything will be cleaned up.
  94  */
  95 struct fsnotify_group {
  96         /*
  97          * global list of all groups receiving events from fsnotify.
  98          * anchored by fsnotify_groups and protected by either fsnotify_grp_mutex
  99          * or fsnotify_grp_srcu depending on write vs read.
 100          */
 101         struct list_head group_list;
 102
 103         /*
 104          * Defines all of the event types in which this group is interested.
 105          * This mask is a bitwise OR of the FS_* events from above.  Each time
 106          * this mask changes for a group (if it changes) the correct functions
 107          * must be called to update the global structures which indicate global
 108          * interest in event types.
 109          */
 110         __u32 mask;
 111
 112         /*
 113          * How the refcnt is used is up to each group.  When the refcnt hits 0
 114          * fsnotify will clean up all of the resources associated with this group.
 115          * As an example, the dnotify group will always have a refcnt=1 and that
 116          * will never change.  Inotify, on the other hand, has a group per
 117          * inotify_init() and the refcnt will hit 0 only when that fd has been
 118          * closed.
 119          */
 120         atomic_t refcnt;                /* things with interest in this group */
 121
 122         const struct fsnotify_ops *ops; /* how this group handles things */
 123
 124         /* needed to send notification to userspace */
 125         struct mutex notification_mutex;        /* protect the notification_list */
 126         struct list_head notification_list;     /* list of event_holder this group needs to send to userspace */
 127         wait_queue_head_t notification_waitq;   /* read() on the notification file blocks on this waitq */
 128         unsigned int q_len;                     /* events on the queue */
 129         unsigned int max_events;                /* maximum events allowed on the list */
 130
 131         /* stores all fastapth entries assoc with this group so they can be cleaned on unregister */
 132         spinlock_t mark_lock;           /* protect mark_entries list */
 133         atomic_t num_marks;             /* 1 for each mark entry and 1 for not being
 134                                          * past the point of no return when freeing
 135                                          * a group */
 136         struct list_head mark_entries;  /* all inode mark entries for this group */
 137
 138         /* prevents double list_del of group_list.  protected by global fsnotify_grp_mutex */
 139         bool on_group_list;
 140
 141         /* groups can define private fields here or use the void *private */
 142         union {
 143                 void *private;
 144 #ifdef CONFIG_INOTIFY_USER
 145                 struct inotify_group_private_data {
 146                         spinlock_t      idr_lock;
 147                         struct idr      idr;
 148                         u32             last_wd;
 149                         struct fasync_struct    *fa;    /* async notification */
 150                         struct user_struct      *user;
 151                 } inotify_data;
 152 #endif
 153         };
 154 };
 155
 156 /*
 157  * A single event can be queued in multiple group->notification_lists.
 158  *
 159  * each group->notification_list will point to an event_holder which in turns points
 160  * to the actual event that needs to be sent to userspace.
 161  *
 162  * Seemed cheaper to create a refcnt'd event and a small holder for every group
 163  * than create a different event for every group
 164  *
 165  */
 166 struct fsnotify_event_holder {
 167         struct fsnotify_event *event;
 168         struct list_head event_list;
 169 };
 170
 171 /*
 172  * Inotify needs to tack data onto an event.  This struct lets us later find the
 173  * correct private data of the correct group.
 174  */
 175 struct fsnotify_event_private_data {
 176         struct fsnotify_group *group;
 177         struct list_head event_list;
 178 };
 179
 180 /*
 181  * all of the information about the original object we want to now send to
 182  * a group.  If you want to carry more info from the accessing task to the
 183  * listener this structure is where you need to be adding fields.
 184  */
 185 struct fsnotify_event {
 186         /*
 187          * If we create an event we are also likely going to need a holder
 188          * to link to a group.  So embed one holder in the event.  Means only
 189          * one allocation for the common case where we only have one group
 190          */
 191         struct fsnotify_event_holder holder;
 192         spinlock_t lock;        /* protection for the associated event_holder and private_list */
 193         /* to_tell may ONLY be dereferenced during handle_event(). */
 194         struct inode *to_tell;  /* either the inode the event happened to or its parent */
 195         /*
 196          * depending on the event type we should have either a path or inode
 197          * We hold a reference on path, but NOT on inode.  Since we have the ref on
 198          * the path, it may be dereferenced at any point during this object's
 199          * lifetime.  That reference is dropped when this object's refcnt hits
 200          * 0.  If this event contains an inode instead of a path, the inode may
 201          * ONLY be used during handle_event().
 202          */
 203         union {
 204                 struct path path;
 205                 struct inode *inode;
 206         };
 207 /* when calling fsnotify tell it if the data is a path or inode */
 208 #define FSNOTIFY_EVENT_NONE     0
 209 #define FSNOTIFY_EVENT_PATH     1
 210 #define FSNOTIFY_EVENT_INODE    2
 211 #define FSNOTIFY_EVENT_FILE     3
 212         int data_type;          /* which of the above union we have */
 213         atomic_t refcnt;        /* how many groups still are using/need to send this event */
 214         __u32 mask;             /* the type of access, bitwise OR for FS_* event types */
 215
 216         u32 sync_cookie;        /* used to corrolate events, namely inotify mv events */
 217         char *file_name;
 218         size_t name_len;
 219
 220         struct list_head private_data_list;     /* groups can store private data here */
 221 };
 222
 223 /*
 224  * a mark is simply an entry attached to an in core inode which allows an
 225  * fsnotify listener to indicate they are either no longer interested in events
 226  * of a type matching mask or only interested in those events.
 227  *
 228  * these are flushed when an inode is evicted from core and may be flushed
 229  * when the inode is modified (as seen by fsnotify_access).  Some fsnotify users
 230  * (such as dnotify) will flush these when the open fd is closed and not at
 231  * inode eviction or modification.
 232  */
 233 struct fsnotify_mark_entry {
 234         __u32 mask;                     /* mask this mark entry is for */
 235         /* we hold ref for each i_list and g_list.  also one ref for each 'thing'
 236          * in kernel that found and may be using this mark. */
 237         atomic_t refcnt;                /* active things looking at this mark */
 238         struct inode *inode;            /* inode this entry is associated with */
 239         struct fsnotify_group *group;   /* group this mark entry is for */
 240         struct hlist_node i_list;       /* list of mark_entries by inode->i_fsnotify_mark_entries */
 241         struct list_head g_list;        /* list of mark_entries by group->i_fsnotify_mark_entries */
 242         spinlock_t lock;                /* protect group, inode, and killme */
 243         struct list_head free_i_list;   /* tmp list used when freeing this mark */
 244         struct list_head free_g_list;   /* tmp list used when freeing this mark */
 245         void (*free_mark)(struct fsnotify_mark_entry *entry); /* called on final put+free */
 246 };
 247
 248 #ifdef CONFIG_FSNOTIFY
 249
 250 /* called from the vfs helpers */
 251
 252 /* main fsnotify call to send events */
 253 extern void fsnotify(struct inode *to_tell, __u32 mask, void *data, int data_is,
 254                      const char *name, u32 cookie);
 255 extern void __fsnotify_parent(struct file *file, struct dentry *dentry, __u32 mask);
 256 extern void __fsnotify_inode_delete(struct inode *inode);
 257 extern u32 fsnotify_get_cookie(void);
 258
 259 static inline int fsnotify_inode_watches_children(struct inode *inode)
 260 {
 261         /* FS_EVENT_ON_CHILD is set if the inode may care */
 262         if (!(inode->i_fsnotify_mask & FS_EVENT_ON_CHILD))
 263                 return 0;
 264         /* this inode might care about child events, does it care about the
 265          * specific set of events that can happen on a child? */
 266         return inode->i_fsnotify_mask & FS_EVENTS_POSS_ON_CHILD;
 267 }
 268
 269 /*
 270  * Update the dentry with a flag indicating the interest of its parent to receive
 271  * filesystem events when those events happens to this dentry->d_inode.
 272  */
 273 static inline void __fsnotify_update_dcache_flags(struct dentry *dentry)
 274 {
 275         struct dentry *parent;
 276
 277         assert_spin_locked(&dcache_lock);
 278         assert_spin_locked(&dentry->d_lock);
 279
 280         parent = dentry->d_parent;
 281         if (parent->d_inode && fsnotify_inode_watches_children(parent->d_inode))
 282                 dentry->d_flags |= DCACHE_FSNOTIFY_PARENT_WATCHED;
 283         else
 284                 dentry->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
 285 }
 286
 287 /*
 288  * fsnotify_d_instantiate - instantiate a dentry for inode
 289  * Called with dcache_lock held.
 290  */
 291 static inline void __fsnotify_d_instantiate(struct dentry *dentry, struct inode *inode)
 292 {
 293         if (!inode)
 294                 return;
 295
 296         assert_spin_locked(&dcache_lock);
 297
 298         spin_lock(&dentry->d_lock);
 299         __fsnotify_update_dcache_flags(dentry);
 300         spin_unlock(&dentry->d_lock);
 301 }
 302
 303 /* called from fsnotify listeners, such as fanotify or dnotify */
 304
 305 /* must call when a group changes its ->mask */
 306 extern void fsnotify_recalc_global_mask(void);
 307 /* get a reference to an existing or create a new group */
 308 extern struct fsnotify_group *fsnotify_alloc_group(__u32 mask,
 309                                                     const struct fsnotify_ops *ops);
 310 /* run all marks associated with this group and update group->mask */
 311 extern void fsnotify_recalc_group_mask(struct fsnotify_group *group);
 312 /* drop reference on a group from fsnotify_alloc_group */
 313 extern void fsnotify_put_group(struct fsnotify_group *group);
 314
 315 /* take a reference to an event */
 316 extern void fsnotify_get_event(struct fsnotify_event *event);
 317 extern void fsnotify_put_event(struct fsnotify_event *event);
 318 /* find private data previously attached to an event and unlink it */
 319 extern struct fsnotify_event_private_data *fsnotify_remove_priv_from_event(struct fsnotify_group *group,
 320                                                                            struct fsnotify_event *event);
 321
 322 /* attach the event to the group notification queue */
 323 extern int fsnotify_add_notify_event(struct fsnotify_group *group,
 324                                      struct fsnotify_event *event,
 325                                      struct fsnotify_event_private_data *priv,
 326                                      int (*merge)(struct list_head *, struct fsnotify_event *));
 327 /* true if the group notification queue is empty */
 328 extern bool fsnotify_notify_queue_is_empty(struct fsnotify_group *group);
 329 /* return, but do not dequeue the first event on the notification queue */
 330 extern struct fsnotify_event *fsnotify_peek_notify_event(struct fsnotify_group *group);
 331 /* return AND dequeue the first event on the notification queue */
 332 extern struct fsnotify_event *fsnotify_remove_notify_event(struct fsnotify_group *group);
 333
 334 /* functions used to manipulate the marks attached to inodes */
 335
 336 /* run all marks associated with an inode and update inode->i_fsnotify_mask */
 337 extern void fsnotify_recalc_inode_mask(struct inode *inode);
 338 extern void fsnotify_init_mark(struct fsnotify_mark_entry *entry, void (*free_mark)(struct fsnotify_mark_entry *entry));
 339 /* find (and take a reference) to a mark associated with group and inode */
 340 extern struct fsnotify_mark_entry *fsnotify_find_mark_entry(struct fsnotify_group *group, struct inode *inode);
 341 /* copy the values from old into new */
 342 extern void fsnotify_duplicate_mark(struct fsnotify_mark_entry *new, struct fsnotify_mark_entry *old);
 343 /* attach the mark to both the group and the inode */
 344 extern int fsnotify_add_mark(struct fsnotify_mark_entry *entry, struct fsnotify_group *group, struct inode *inode, int allow_dups);
 345 /* given a mark, flag it to be freed when all references are dropped */
 346 extern void fsnotify_destroy_mark_by_entry(struct fsnotify_mark_entry *entry);
 347 /* run all the marks in a group, and flag them to be freed */
 348 extern void fsnotify_clear_marks_by_group(struct fsnotify_group *group);
 349 extern void fsnotify_get_mark(struct fsnotify_mark_entry *entry);
 350 extern void fsnotify_put_mark(struct fsnotify_mark_entry *entry);
 351 extern void fsnotify_unmount_inodes(struct list_head *list);
 352
 353 /* put here because inotify does some weird stuff when destroying watches */
 354 extern struct fsnotify_event *fsnotify_create_event(struct inode *to_tell, __u32 mask,
 355                                                     void *data, int data_is, const char *name,
 356                                                     u32 cookie, gfp_t gfp);
 357
 358 /* fanotify likes to change events after they are on lists... */
 359 extern struct fsnotify_event *fsnotify_clone_event(struct fsnotify_event *old_event);
 360 extern int fsnotify_replace_event(struct fsnotify_event_holder *old_holder,
 361                                   struct fsnotify_event *new_event);
 362
 363 #else
 364
 365 static inline void fsnotify(struct inode *to_tell, __u32 mask, void *data, int data_is,
 366                             const char *name, u32 cookie)
 367 {}
 368
 369 static inline void __fsnotify_parent(struct file *file, struct dentry *dentry, __u32 mask)
 370 {}
 371
 372 static inline void __fsnotify_inode_delete(struct inode *inode)
 373 {}
 374
 375 static inline void __fsnotify_update_dcache_flags(struct dentry *dentry)
 376 {}
 377
 378 static inline void __fsnotify_d_instantiate(struct dentry *dentry, struct inode *inode)
 379 {}
 380
 381 static inline u32 fsnotify_get_cookie(void)
 382 {
 383         return 0;
 384 }
 385
 386 static inline void fsnotify_unmount_inodes(struct list_head *list)
 387 {}
 388
 389 #endif  /* CONFIG_FSNOTIFY */
 390
 391 #endif  /* __KERNEL __ */
 392
 393 #endif  /* __LINUX_FSNOTIFY_BACKEND_H */