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