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_OPEN_PERM            0x00010000      /* open event in an permission hook */
  45 #define FS_ACCESS_PERM          0x00020000      /* access event in a permissions hook */
  46
  47 #define FS_EXCL_UNLINK          0x04000000      /* do not send events if object is unlinked */
  48 #define FS_IN_ISDIR             0x40000000      /* event occurred against dir */
  49 #define FS_IN_ONESHOT           0x80000000      /* only send event once */
  50
  51 #define FS_DN_RENAME            0x10000000      /* file renamed */
  52 #define FS_DN_MULTISHOT         0x20000000      /* dnotify multishot */
  53
  54 /* This inode cares about things that happen to its children.  Always set for
  55  * dnotify and inotify. */
  56 #define FS_EVENT_ON_CHILD       0x08000000
  57
  58 /* This is a list of all events that may get sent to a parernt based on fs event
  59  * happening to inodes inside that directory */
  60 #define FS_EVENTS_POSS_ON_CHILD   (FS_ACCESS | FS_MODIFY | FS_ATTRIB |\
  61                                    FS_CLOSE_WRITE | FS_CLOSE_NOWRITE | FS_OPEN |\
  62                                    FS_MOVED_FROM | FS_MOVED_TO | FS_CREATE |\
  63                                    FS_DELETE)
  64
  65 #define FS_MOVE                 (FS_MOVED_FROM | FS_MOVED_TO)
  66
  67 struct fsnotify_group;
  68 struct fsnotify_event;
  69 struct fsnotify_mark;
  70 struct fsnotify_event_private_data;
  71
  72 /*
  73  * Each group much define these ops.  The fsnotify infrastructure will call
  74  * these operations for each relevant group.
  75  *
  76  * should_send_event - given a group, inode, and mask this function determines
  77  *              if the group is interested in this event.
  78  * handle_event - main call for a group to handle an fs event
  79  * free_group_priv - called when a group refcnt hits 0 to clean up the private union
  80  * freeing-mark - this means that a mark has been flagged to die when everything
  81  *              finishes using it.  The function is supplied with what must be a
  82  *              valid group and inode to use to clean up.
  83  */
  84 struct fsnotify_ops {
  85         bool (*should_send_event)(struct fsnotify_group *group, struct inode *inode,
  86                                   struct vfsmount *mnt, __u32 mask, void *data,
  87                                   int data_type);
  88         int (*handle_event)(struct fsnotify_group *group, struct fsnotify_event *event);
  89         void (*free_group_priv)(struct fsnotify_group *group);
  90         void (*freeing_mark)(struct fsnotify_mark *mark, struct fsnotify_group *group);
  91         void (*free_event_priv)(struct fsnotify_event_private_data *priv);
  92 };
  93
  94 /*
  95  * A group is a "thing" that wants to receive notification about filesystem
  96  * events.  The mask holds the subset of event types this group cares about.
  97  * refcnt on a group is up to the implementor and at any moment if it goes 0
  98  * everything will be cleaned up.
  99  */
 100 struct fsnotify_group {
 101         /*
 102          * global list of all groups receiving events from fsnotify.
 103          * anchored by fsnotify_inode_groups and protected by either fsnotify_grp_mutex
 104          * or fsnotify_grp_srcu depending on write vs read.
 105          */
 106         struct list_head inode_group_list;
 107         /*
 108          * same as above except anchored by fsnotify_vfsmount_groups
 109          */
 110         struct list_head vfsmount_group_list;
 111
 112         /*
 113          * Defines all of the event types in which this group is interested.
 114          * This mask is a bitwise OR of the FS_* events from above.  Each time
 115          * this mask changes for a group (if it changes) the correct functions
 116          * must be called to update the global structures which indicate global
 117          * interest in event types.
 118          */
 119         __u32 mask;
 120
 121         /*
 122          * How the refcnt is used is up to each group.  When the refcnt hits 0
 123          * fsnotify will clean up all of the resources associated with this group.
 124          * As an example, the dnotify group will always have a refcnt=1 and that
 125          * will never change.  Inotify, on the other hand, has a group per
 126          * inotify_init() and the refcnt will hit 0 only when that fd has been
 127          * closed.
 128          */
 129         atomic_t refcnt;                /* things with interest in this group */
 130
 131         const struct fsnotify_ops *ops; /* how this group handles things */
 132
 133         /* needed to send notification to userspace */
 134         struct mutex notification_mutex;        /* protect the notification_list */
 135         struct list_head notification_list;     /* list of event_holder this group needs to send to userspace */
 136         wait_queue_head_t notification_waitq;   /* read() on the notification file blocks on this waitq */
 137         unsigned int q_len;                     /* events on the queue */
 138         unsigned int max_events;                /* maximum events allowed on the list */
 139
 140         /* stores all fastpath marks assoc with this group so they can be cleaned on unregister */
 141         spinlock_t mark_lock;           /* protect marks_list */
 142         atomic_t num_marks;             /* 1 for each mark and 1 for not being
 143                                          * past the point of no return when freeing
 144                                          * a group */
 145         struct list_head marks_list;    /* all inode marks for this group */
 146
 147         /* prevents double list_del of group_list.  protected by global fsnotify_grp_mutex */
 148         bool on_inode_group_list;
 149         bool on_vfsmount_group_list;
 150
 151         /* groups can define private fields here or use the void *private */
 152         union {
 153                 void *private;
 154 #ifdef CONFIG_INOTIFY_USER
 155                 struct inotify_group_private_data {
 156                         spinlock_t      idr_lock;
 157                         struct idr      idr;
 158                         u32             last_wd;
 159                         struct fasync_struct    *fa;    /* async notification */
 160                         struct user_struct      *user;
 161                 } inotify_data;
 162 #endif
 163 #ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
 164                 struct fanotify_group_private_data {
 165                         /* allows a group to block waiting for a userspace response */
 166                         struct mutex access_mutex;
 167                         struct list_head access_list;
 168                         wait_queue_head_t access_waitq;
 169                 } fanotify_data;
 170 #endif
 171         };
 172 };
 173
 174 /*
 175  * A single event can be queued in multiple group->notification_lists.
 176  *
 177  * each group->notification_list will point to an event_holder which in turns points
 178  * to the actual event that needs to be sent to userspace.
 179  *
 180  * Seemed cheaper to create a refcnt'd event and a small holder for every group
 181  * than create a different event for every group
 182  *
 183  */
 184 struct fsnotify_event_holder {
 185         struct fsnotify_event *event;
 186         struct list_head event_list;
 187 };
 188
 189 /*
 190  * Inotify needs to tack data onto an event.  This struct lets us later find the
 191  * correct private data of the correct group.
 192  */
 193 struct fsnotify_event_private_data {
 194         struct fsnotify_group *group;
 195         struct list_head event_list;
 196 };
 197
 198 /*
 199  * all of the information about the original object we want to now send to
 200  * a group.  If you want to carry more info from the accessing task to the
 201  * listener this structure is where you need to be adding fields.
 202  */
 203 struct fsnotify_event {
 204         /*
 205          * If we create an event we are also likely going to need a holder
 206          * to link to a group.  So embed one holder in the event.  Means only
 207          * one allocation for the common case where we only have one group
 208          */
 209         struct fsnotify_event_holder holder;
 210         spinlock_t lock;        /* protection for the associated event_holder and private_list */
 211         /* to_tell may ONLY be dereferenced during handle_event(). */
 212         struct inode *to_tell;  /* either the inode the event happened to or its parent */
 213         /*
 214          * depending on the event type we should have either a path or inode
 215          * We hold a reference on path, but NOT on inode.  Since we have the ref on
 216          * the path, it may be dereferenced at any point during this object's
 217          * lifetime.  That reference is dropped when this object's refcnt hits
 218          * 0.  If this event contains an inode instead of a path, the inode may
 219          * ONLY be used during handle_event().
 220          */
 221         union {
 222                 struct path path;
 223                 struct inode *inode;
 224         };
 225 /* when calling fsnotify tell it if the data is a path or inode */
 226 #define FSNOTIFY_EVENT_NONE     0
 227 #define FSNOTIFY_EVENT_PATH     1
 228 #define FSNOTIFY_EVENT_INODE    2
 229         int data_type;          /* which of the above union we have */
 230         atomic_t refcnt;        /* how many groups still are using/need to send this event */
 231         __u32 mask;             /* the type of access, bitwise OR for FS_* event types */
 232
 233         u32 sync_cookie;        /* used to corrolate events, namely inotify mv events */
 234         const unsigned char *file_name;
 235         size_t name_len;
 236         struct pid *tgid;
 237
 238 #ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
 239         __u32 response; /* userspace answer to question */
 240 #endif /* CONFIG_FANOTIFY_ACCESS_PERMISSIONS */
 241
 242         struct list_head private_data_list;     /* groups can store private data here */
 243 };
 244
 245 /*
 246  * Inode specific fields in an fsnotify_mark
 247  */
 248 struct fsnotify_inode_mark {
 249         struct inode *inode;            /* inode this mark is associated with */
 250         struct hlist_node i_list;       /* list of marks by inode->i_fsnotify_marks */
 251         struct list_head free_i_list;   /* tmp list used when freeing this mark */
 252 };
 253
 254 /*
 255  * Mount point specific fields in an fsnotify_mark
 256  */
 257 struct fsnotify_vfsmount_mark {
 258         struct vfsmount *mnt;           /* vfsmount this mark is associated with */
 259         struct hlist_node m_list;       /* list of marks by inode->i_fsnotify_marks */
 260         struct list_head free_m_list;   /* tmp list used when freeing this mark */
 261 };
 262
 263 /*
 264  * a mark is simply an object attached to an in core inode which allows an
 265  * fsnotify listener to indicate they are either no longer interested in events
 266  * of a type matching mask or only interested in those events.
 267  *
 268  * these are flushed when an inode is evicted from core and may be flushed
 269  * when the inode is modified (as seen by fsnotify_access).  Some fsnotify users
 270  * (such as dnotify) will flush these when the open fd is closed and not at
 271  * inode eviction or modification.
 272  */
 273 struct fsnotify_mark {
 274         __u32 mask;                     /* mask this mark is for */
 275         /* we hold ref for each i_list and g_list.  also one ref for each 'thing'
 276          * in kernel that found and may be using this mark. */
 277         atomic_t refcnt;                /* active things looking at this mark */
 278         struct fsnotify_group *group;   /* group this mark is for */
 279         struct list_head g_list;        /* list of marks by group->i_fsnotify_marks */
 280         spinlock_t lock;                /* protect group and inode */
 281         union {
 282                 struct fsnotify_inode_mark i;
 283                 struct fsnotify_vfsmount_mark m;
 284         };
 285         __u32 ignored_mask;             /* events types to ignore */
 286         struct list_head free_g_list;   /* tmp list used when freeing this mark */
 287 #define FSNOTIFY_MARK_FLAG_INODE                0x01
 288 #define FSNOTIFY_MARK_FLAG_VFSMOUNT             0x02
 289 #define FSNOTIFY_MARK_FLAG_OBJECT_PINNED        0x04
 290 #define FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY  0x08
 291         unsigned int flags;             /* vfsmount or inode mark? */
 292         void (*free_mark)(struct fsnotify_mark *mark); /* called on final put+free */
 293 };
 294
 295 #ifdef CONFIG_FSNOTIFY
 296
 297 /* called from the vfs helpers */
 298
 299 /* main fsnotify call to send events */
 300 extern int fsnotify(struct inode *to_tell, __u32 mask, void *data, int data_is,
 301                     const unsigned char *name, u32 cookie);
 302 extern void __fsnotify_parent(struct path *path, struct dentry *dentry, __u32 mask);
 303 extern void __fsnotify_inode_delete(struct inode *inode);
 304 extern void __fsnotify_vfsmount_delete(struct vfsmount *mnt);
 305 extern u32 fsnotify_get_cookie(void);
 306
 307 static inline int fsnotify_inode_watches_children(struct inode *inode)
 308 {
 309         /* FS_EVENT_ON_CHILD is set if the inode may care */
 310         if (!(inode->i_fsnotify_mask & FS_EVENT_ON_CHILD))
 311                 return 0;
 312         /* this inode might care about child events, does it care about the
 313          * specific set of events that can happen on a child? */
 314         return inode->i_fsnotify_mask & FS_EVENTS_POSS_ON_CHILD;
 315 }
 316
 317 /*
 318  * Update the dentry with a flag indicating the interest of its parent to receive
 319  * filesystem events when those events happens to this dentry->d_inode.
 320  */
 321 static inline void __fsnotify_update_dcache_flags(struct dentry *dentry)
 322 {
 323         struct dentry *parent;
 324
 325         assert_spin_locked(&dcache_lock);
 326         assert_spin_locked(&dentry->d_lock);
 327
 328         parent = dentry->d_parent;
 329         if (parent->d_inode && fsnotify_inode_watches_children(parent->d_inode))
 330                 dentry->d_flags |= DCACHE_FSNOTIFY_PARENT_WATCHED;
 331         else
 332                 dentry->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
 333 }
 334
 335 /*
 336  * fsnotify_d_instantiate - instantiate a dentry for inode
 337  * Called with dcache_lock held.
 338  */
 339 static inline void __fsnotify_d_instantiate(struct dentry *dentry, struct inode *inode)
 340 {
 341         if (!inode)
 342                 return;
 343
 344         assert_spin_locked(&dcache_lock);
 345
 346         spin_lock(&dentry->d_lock);
 347         __fsnotify_update_dcache_flags(dentry);
 348         spin_unlock(&dentry->d_lock);
 349 }
 350
 351 /* called from fsnotify listeners, such as fanotify or dnotify */
 352
 353 /* must call when a group changes its ->mask */
 354 extern void fsnotify_recalc_global_mask(void);
 355 /* get a reference to an existing or create a new group */
 356 extern struct fsnotify_group *fsnotify_alloc_group(const struct fsnotify_ops *ops);
 357 /* run all marks associated with this group and update group->mask */
 358 extern void fsnotify_recalc_group_mask(struct fsnotify_group *group);
 359 /* drop reference on a group from fsnotify_alloc_group */
 360 extern void fsnotify_put_group(struct fsnotify_group *group);
 361
 362 /* take a reference to an event */
 363 extern void fsnotify_get_event(struct fsnotify_event *event);
 364 extern void fsnotify_put_event(struct fsnotify_event *event);
 365 /* find private data previously attached to an event and unlink it */
 366 extern struct fsnotify_event_private_data *fsnotify_remove_priv_from_event(struct fsnotify_group *group,
 367                                                                            struct fsnotify_event *event);
 368
 369 /* attach the event to the group notification queue */
 370 extern int fsnotify_add_notify_event(struct fsnotify_group *group,
 371                                      struct fsnotify_event *event,
 372                                      struct fsnotify_event_private_data *priv,
 373                                      int (*merge)(struct list_head *,
 374                                                   struct fsnotify_event *,
 375                                                   void **),
 376                                      void **arg);
 377 /* true if the group notification queue is empty */
 378 extern bool fsnotify_notify_queue_is_empty(struct fsnotify_group *group);
 379 /* return, but do not dequeue the first event on the notification queue */
 380 extern struct fsnotify_event *fsnotify_peek_notify_event(struct fsnotify_group *group);
 381 /* return AND dequeue the first event on the notification queue */
 382 extern struct fsnotify_event *fsnotify_remove_notify_event(struct fsnotify_group *group);
 383
 384 /* functions used to manipulate the marks attached to inodes */
 385
 386 /* run all marks associated with a vfsmount and update mnt->mnt_fsnotify_mask */
 387 extern void fsnotify_recalc_vfsmount_mask(struct vfsmount *mnt);
 388 /* run all marks associated with an inode and update inode->i_fsnotify_mask */
 389 extern void fsnotify_recalc_inode_mask(struct inode *inode);
 390 extern void fsnotify_init_mark(struct fsnotify_mark *mark, void (*free_mark)(struct fsnotify_mark *mark));
 391 /* find (and take a reference) to a mark associated with group and inode */
 392 extern struct fsnotify_mark *fsnotify_find_inode_mark(struct fsnotify_group *group, struct inode *inode);
 393 /* find (and take a reference) to a mark associated with group and vfsmount */
 394 extern struct fsnotify_mark *fsnotify_find_vfsmount_mark(struct fsnotify_group *group, struct vfsmount *mnt);
 395 /* copy the values from old into new */
 396 extern void fsnotify_duplicate_mark(struct fsnotify_mark *new, struct fsnotify_mark *old);
 397 /* set the ignored_mask of a mark */
 398 extern void fsnotify_set_mark_ignored_mask_locked(struct fsnotify_mark *mark, __u32 mask);
 399 /* set the mask of a mark (might pin the object into memory */
 400 extern void fsnotify_set_mark_mask_locked(struct fsnotify_mark *mark, __u32 mask);
 401 /* attach the mark to both the group and the inode */
 402 extern int fsnotify_add_mark(struct fsnotify_mark *mark, struct fsnotify_group *group,
 403                              struct inode *inode, struct vfsmount *mnt, int allow_dups);
 404 /* given a mark, flag it to be freed when all references are dropped */
 405 extern void fsnotify_destroy_mark(struct fsnotify_mark *mark);
 406 /* run all the marks in a group, and clear all of the vfsmount marks */
 407 extern void fsnotify_clear_vfsmount_marks_by_group(struct fsnotify_group *group);
 408 /* run all the marks in a group, and clear all of the inode marks */
 409 extern void fsnotify_clear_inode_marks_by_group(struct fsnotify_group *group);
 410 /* run all the marks in a group, and clear all of the marks where mark->flags & flags is true*/
 411 extern void fsnotify_clear_marks_by_group_flags(struct fsnotify_group *group, unsigned int flags);
 412 /* run all the marks in a group, and flag them to be freed */
 413 extern void fsnotify_clear_marks_by_group(struct fsnotify_group *group);
 414 extern void fsnotify_get_mark(struct fsnotify_mark *mark);
 415 extern void fsnotify_put_mark(struct fsnotify_mark *mark);
 416 extern void fsnotify_unmount_inodes(struct list_head *list);
 417
 418 /* put here because inotify does some weird stuff when destroying watches */
 419 extern struct fsnotify_event *fsnotify_create_event(struct inode *to_tell, __u32 mask,
 420                                                     void *data, int data_is,
 421                                                     const unsigned char *name,
 422                                                     u32 cookie, gfp_t gfp);
 423
 424 /* fanotify likes to change events after they are on lists... */
 425 extern struct fsnotify_event *fsnotify_clone_event(struct fsnotify_event *old_event);
 426 extern int fsnotify_replace_event(struct fsnotify_event_holder *old_holder,
 427                                   struct fsnotify_event *new_event);
 428
 429 #else
 430
 431 static inline int fsnotify(struct inode *to_tell, __u32 mask, void *data, int data_is,
 432                            const unsigned char *name, u32 cookie)
 433 {
 434         return 0;
 435 }
 436
 437 static inline void __fsnotify_parent(struct path *path, struct dentry *dentry, __u32 mask)
 438 {}
 439
 440 static inline void __fsnotify_inode_delete(struct inode *inode)
 441 {}
 442
 443 static inline void __fsnotify_vfsmount_delete(struct vfsmount *mnt)
 444 {}
 445
 446 static inline void __fsnotify_update_dcache_flags(struct dentry *dentry)
 447 {}
 448
 449 static inline void __fsnotify_d_instantiate(struct dentry *dentry, struct inode *inode)
 450 {}
 451
 452 static inline u32 fsnotify_get_cookie(void)
 453 {
 454         return 0;
 455 }
 456
 457 static inline void fsnotify_unmount_inodes(struct list_head *list)
 458 {}
 459
 460 #endif  /* CONFIG_FSNOTIFY */
 461
 462 #endif  /* __KERNEL __ */
 463
 464 #endif  /* __LINUX_FSNOTIFY_BACKEND_H */