fsnotify: Provide framework for dropping SRCU lock in ->handle_event
[sfrench/cifs-2.6.git] / 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 #include <linux/atomic.h>
19 #include <linux/user_namespace.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_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 | FS_OPEN_PERM | FS_ACCESS_PERM)
64
65 #define FS_MOVE                 (FS_MOVED_FROM | FS_MOVED_TO)
66
67 #define ALL_FSNOTIFY_PERM_EVENTS (FS_OPEN_PERM | FS_ACCESS_PERM)
68
69 #define ALL_FSNOTIFY_EVENTS (FS_ACCESS | FS_MODIFY | FS_ATTRIB | \
70                              FS_CLOSE_WRITE | FS_CLOSE_NOWRITE | FS_OPEN | \
71                              FS_MOVED_FROM | FS_MOVED_TO | FS_CREATE | \
72                              FS_DELETE | FS_DELETE_SELF | FS_MOVE_SELF | \
73                              FS_UNMOUNT | FS_Q_OVERFLOW | FS_IN_IGNORED | \
74                              FS_OPEN_PERM | FS_ACCESS_PERM | FS_EXCL_UNLINK | \
75                              FS_ISDIR | FS_IN_ONESHOT | FS_DN_RENAME | \
76                              FS_DN_MULTISHOT | FS_EVENT_ON_CHILD)
77
78 struct fsnotify_group;
79 struct fsnotify_event;
80 struct fsnotify_mark;
81 struct fsnotify_event_private_data;
82 struct fsnotify_fname;
83 struct fsnotify_iter_info;
84
85 /*
86  * Each group much define these ops.  The fsnotify infrastructure will call
87  * these operations for each relevant group.
88  *
89  * handle_event - main call for a group to handle an fs event
90  * free_group_priv - called when a group refcnt hits 0 to clean up the private union
91  * freeing_mark - called when a mark is being destroyed for some reason.  The group
92  *              MUST be holding a reference on each mark and that reference must be
93  *              dropped in this function.  inotify uses this function to send
94  *              userspace messages that marks have been removed.
95  */
96 struct fsnotify_ops {
97         int (*handle_event)(struct fsnotify_group *group,
98                             struct inode *inode,
99                             struct fsnotify_mark *inode_mark,
100                             struct fsnotify_mark *vfsmount_mark,
101                             u32 mask, const void *data, int data_type,
102                             const unsigned char *file_name, u32 cookie);
103         void (*free_group_priv)(struct fsnotify_group *group);
104         void (*freeing_mark)(struct fsnotify_mark *mark, struct fsnotify_group *group);
105         void (*free_event)(struct fsnotify_event *event);
106 };
107
108 /*
109  * all of the information about the original object we want to now send to
110  * a group.  If you want to carry more info from the accessing task to the
111  * listener this structure is where you need to be adding fields.
112  */
113 struct fsnotify_event {
114         struct list_head list;
115         /* inode may ONLY be dereferenced during handle_event(). */
116         struct inode *inode;    /* either the inode the event happened to or its parent */
117         u32 mask;               /* the type of access, bitwise OR for FS_* event types */
118 };
119
120 /*
121  * A group is a "thing" that wants to receive notification about filesystem
122  * events.  The mask holds the subset of event types this group cares about.
123  * refcnt on a group is up to the implementor and at any moment if it goes 0
124  * everything will be cleaned up.
125  */
126 struct fsnotify_group {
127         /*
128          * How the refcnt is used is up to each group.  When the refcnt hits 0
129          * fsnotify will clean up all of the resources associated with this group.
130          * As an example, the dnotify group will always have a refcnt=1 and that
131          * will never change.  Inotify, on the other hand, has a group per
132          * inotify_init() and the refcnt will hit 0 only when that fd has been
133          * closed.
134          */
135         atomic_t refcnt;                /* things with interest in this group */
136
137         const struct fsnotify_ops *ops; /* how this group handles things */
138
139         /* needed to send notification to userspace */
140         spinlock_t notification_lock;           /* protect the notification_list */
141         struct list_head notification_list;     /* list of event_holder this group needs to send to userspace */
142         wait_queue_head_t notification_waitq;   /* read() on the notification file blocks on this waitq */
143         unsigned int q_len;                     /* events on the queue */
144         unsigned int max_events;                /* maximum events allowed on the list */
145         /*
146          * Valid fsnotify group priorities.  Events are send in order from highest
147          * priority to lowest priority.  We default to the lowest priority.
148          */
149         #define FS_PRIO_0       0 /* normal notifiers, no permissions */
150         #define FS_PRIO_1       1 /* fanotify content based access control */
151         #define FS_PRIO_2       2 /* fanotify pre-content access */
152         unsigned int priority;
153         bool shutdown;          /* group is being shut down, don't queue more events */
154
155         /* stores all fastpath marks assoc with this group so they can be cleaned on unregister */
156         struct mutex mark_mutex;        /* protect marks_list */
157         atomic_t num_marks;             /* 1 for each mark and 1 for not being
158                                          * past the point of no return when freeing
159                                          * a group */
160         struct list_head marks_list;    /* all inode marks for this group */
161
162         struct fasync_struct *fsn_fa;    /* async notification */
163
164         struct fsnotify_event *overflow_event;  /* Event we queue when the
165                                                  * notification list is too
166                                                  * full */
167         atomic_t user_waits;            /* Number of tasks waiting for user
168                                          * response */
169
170         /* groups can define private fields here or use the void *private */
171         union {
172                 void *private;
173 #ifdef CONFIG_INOTIFY_USER
174                 struct inotify_group_private_data {
175                         spinlock_t      idr_lock;
176                         struct idr      idr;
177                         struct ucounts *ucounts;
178                 } inotify_data;
179 #endif
180 #ifdef CONFIG_FANOTIFY
181                 struct fanotify_group_private_data {
182 #ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
183                         /* allows a group to block waiting for a userspace response */
184                         struct list_head access_list;
185                         wait_queue_head_t access_waitq;
186 #endif /* CONFIG_FANOTIFY_ACCESS_PERMISSIONS */
187                         int f_flags;
188                         unsigned int max_marks;
189                         struct user_struct *user;
190                 } fanotify_data;
191 #endif /* CONFIG_FANOTIFY */
192         };
193 };
194
195 /* when calling fsnotify tell it if the data is a path or inode */
196 #define FSNOTIFY_EVENT_NONE     0
197 #define FSNOTIFY_EVENT_PATH     1
198 #define FSNOTIFY_EVENT_INODE    2
199
200 /*
201  * Inode / vfsmount point to this structure which tracks all marks attached to
202  * the inode / vfsmount. The reference to inode / vfsmount is held by this
203  * structure. We destroy this structure when there are no more marks attached
204  * to it. The structure is protected by fsnotify_mark_srcu.
205  */
206 struct fsnotify_mark_connector {
207         spinlock_t lock;
208 #define FSNOTIFY_OBJ_TYPE_INODE         0x01
209 #define FSNOTIFY_OBJ_TYPE_VFSMOUNT      0x02
210         unsigned int flags;     /* Type of object [lock] */
211         union { /* Object pointer [lock] */
212                 struct inode *inode;
213                 struct vfsmount *mnt;
214         };
215         union {
216                 struct hlist_head list;
217                 /* Used listing heads to free after srcu period expires */
218                 struct fsnotify_mark_connector *destroy_next;
219         };
220 };
221
222 /*
223  * A mark is simply an object attached to an in core inode which allows an
224  * fsnotify listener to indicate they are either no longer interested in events
225  * of a type matching mask or only interested in those events.
226  *
227  * These are flushed when an inode is evicted from core and may be flushed
228  * when the inode is modified (as seen by fsnotify_access).  Some fsnotify
229  * users (such as dnotify) will flush these when the open fd is closed and not
230  * at inode eviction or modification.
231  *
232  * Text in brackets is showing the lock(s) protecting modifications of a
233  * particular entry. obj_lock means either inode->i_lock or
234  * mnt->mnt_root->d_lock depending on the mark type.
235  */
236 struct fsnotify_mark {
237         /* Mask this mark is for [mark->lock, group->mark_mutex] */
238         __u32 mask;
239         /* We hold one for presence in g_list. Also one ref for each 'thing'
240          * in kernel that found and may be using this mark. */
241         atomic_t refcnt;
242         /* Group this mark is for. Set on mark creation, stable until last ref
243          * is dropped */
244         struct fsnotify_group *group;
245         /* List of marks by group->i_fsnotify_marks. Also reused for queueing
246          * mark into destroy_list when it's waiting for the end of SRCU period
247          * before it can be freed. [group->mark_mutex] */
248         struct list_head g_list;
249         /* Protects inode / mnt pointers, flags, masks */
250         spinlock_t lock;
251         /* List of marks for inode / vfsmount [connector->lock, mark ref] */
252         struct hlist_node obj_list;
253         /* Head of list of marks for an object [mark ref] */
254         struct fsnotify_mark_connector *connector;
255         /* Events types to ignore [mark->lock, group->mark_mutex] */
256         __u32 ignored_mask;
257 #define FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY  0x01
258 #define FSNOTIFY_MARK_FLAG_ALIVE                0x02
259 #define FSNOTIFY_MARK_FLAG_ATTACHED             0x04
260         unsigned int flags;             /* flags [mark->lock] */
261         void (*free_mark)(struct fsnotify_mark *mark); /* called on final put+free */
262 };
263
264 #ifdef CONFIG_FSNOTIFY
265
266 /* called from the vfs helpers */
267
268 /* main fsnotify call to send events */
269 extern int fsnotify(struct inode *to_tell, __u32 mask, const void *data, int data_is,
270                     const unsigned char *name, u32 cookie);
271 extern int __fsnotify_parent(const struct path *path, struct dentry *dentry, __u32 mask);
272 extern void __fsnotify_inode_delete(struct inode *inode);
273 extern void __fsnotify_vfsmount_delete(struct vfsmount *mnt);
274 extern u32 fsnotify_get_cookie(void);
275
276 static inline int fsnotify_inode_watches_children(struct inode *inode)
277 {
278         /* FS_EVENT_ON_CHILD is set if the inode may care */
279         if (!(inode->i_fsnotify_mask & FS_EVENT_ON_CHILD))
280                 return 0;
281         /* this inode might care about child events, does it care about the
282          * specific set of events that can happen on a child? */
283         return inode->i_fsnotify_mask & FS_EVENTS_POSS_ON_CHILD;
284 }
285
286 /*
287  * Update the dentry with a flag indicating the interest of its parent to receive
288  * filesystem events when those events happens to this dentry->d_inode.
289  */
290 static inline void fsnotify_update_flags(struct dentry *dentry)
291 {
292         assert_spin_locked(&dentry->d_lock);
293
294         /*
295          * Serialisation of setting PARENT_WATCHED on the dentries is provided
296          * by d_lock. If inotify_inode_watched changes after we have taken
297          * d_lock, the following __fsnotify_update_child_dentry_flags call will
298          * find our entry, so it will spin until we complete here, and update
299          * us with the new state.
300          */
301         if (fsnotify_inode_watches_children(dentry->d_parent->d_inode))
302                 dentry->d_flags |= DCACHE_FSNOTIFY_PARENT_WATCHED;
303         else
304                 dentry->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
305 }
306
307 /* called from fsnotify listeners, such as fanotify or dnotify */
308
309 /* create a new group */
310 extern struct fsnotify_group *fsnotify_alloc_group(const struct fsnotify_ops *ops);
311 /* get reference to a group */
312 extern void fsnotify_get_group(struct fsnotify_group *group);
313 /* drop reference on a group from fsnotify_alloc_group */
314 extern void fsnotify_put_group(struct fsnotify_group *group);
315 /* group destruction begins, stop queuing new events */
316 extern void fsnotify_group_stop_queueing(struct fsnotify_group *group);
317 /* destroy group */
318 extern void fsnotify_destroy_group(struct fsnotify_group *group);
319 /* fasync handler function */
320 extern int fsnotify_fasync(int fd, struct file *file, int on);
321 /* Free event from memory */
322 extern void fsnotify_destroy_event(struct fsnotify_group *group,
323                                    struct fsnotify_event *event);
324 /* attach the event to the group notification queue */
325 extern int fsnotify_add_event(struct fsnotify_group *group,
326                               struct fsnotify_event *event,
327                               int (*merge)(struct list_head *,
328                                            struct fsnotify_event *));
329 /* true if the group notification queue is empty */
330 extern bool fsnotify_notify_queue_is_empty(struct fsnotify_group *group);
331 /* return, but do not dequeue the first event on the notification queue */
332 extern struct fsnotify_event *fsnotify_peek_first_event(struct fsnotify_group *group);
333 /* return AND dequeue the first event on the notification queue */
334 extern struct fsnotify_event *fsnotify_remove_first_event(struct fsnotify_group *group);
335
336 /* functions used to manipulate the marks attached to inodes */
337
338 /* Calculate mask of events for a list of marks */
339 extern void fsnotify_recalc_mask(struct fsnotify_mark_connector *conn);
340 /* run all marks associated with a vfsmount and update mnt->mnt_fsnotify_mask */
341 extern void fsnotify_recalc_vfsmount_mask(struct vfsmount *mnt);
342 /* run all marks associated with an inode and update inode->i_fsnotify_mask */
343 extern void fsnotify_recalc_inode_mask(struct inode *inode);
344 extern void fsnotify_init_mark(struct fsnotify_mark *mark, void (*free_mark)(struct fsnotify_mark *mark));
345 /* find (and take a reference) to a mark associated with group and inode */
346 extern struct fsnotify_mark *fsnotify_find_inode_mark(struct fsnotify_group *group, struct inode *inode);
347 /* find (and take a reference) to a mark associated with group and vfsmount */
348 extern struct fsnotify_mark *fsnotify_find_vfsmount_mark(struct fsnotify_group *group, struct vfsmount *mnt);
349 /* set the ignored_mask of a mark */
350 extern void fsnotify_set_mark_ignored_mask_locked(struct fsnotify_mark *mark, __u32 mask);
351 /* set the mask of a mark (might pin the object into memory */
352 extern void fsnotify_set_mark_mask_locked(struct fsnotify_mark *mark, __u32 mask);
353 /* attach the mark to both the group and the inode */
354 extern int fsnotify_add_mark(struct fsnotify_mark *mark, struct fsnotify_group *group,
355                              struct inode *inode, struct vfsmount *mnt, int allow_dups);
356 extern int fsnotify_add_mark_locked(struct fsnotify_mark *mark, struct fsnotify_group *group,
357                                     struct inode *inode, struct vfsmount *mnt, int allow_dups);
358 /* given a group and a mark, flag mark to be freed when all references are dropped */
359 extern void fsnotify_destroy_mark(struct fsnotify_mark *mark,
360                                   struct fsnotify_group *group);
361 /* detach mark from inode / mount list, group list, drop inode reference */
362 extern void fsnotify_detach_mark(struct fsnotify_mark *mark);
363 /* free mark */
364 extern void fsnotify_free_mark(struct fsnotify_mark *mark);
365 /* run all the marks in a group, and clear all of the vfsmount marks */
366 extern void fsnotify_clear_vfsmount_marks_by_group(struct fsnotify_group *group);
367 /* run all the marks in a group, and clear all of the inode marks */
368 extern void fsnotify_clear_inode_marks_by_group(struct fsnotify_group *group);
369 /* run all the marks in a group, and clear all of the marks attached to given object type */
370 extern void fsnotify_clear_marks_by_group_flags(struct fsnotify_group *group, unsigned int flags);
371 extern void fsnotify_get_mark(struct fsnotify_mark *mark);
372 extern void fsnotify_put_mark(struct fsnotify_mark *mark);
373 extern void fsnotify_unmount_inodes(struct super_block *sb);
374 extern void fsnotify_finish_user_wait(struct fsnotify_iter_info *iter_info);
375 extern bool fsnotify_prepare_user_wait(struct fsnotify_iter_info *iter_info);
376
377 /* put here because inotify does some weird stuff when destroying watches */
378 extern void fsnotify_init_event(struct fsnotify_event *event,
379                                 struct inode *to_tell, u32 mask);
380
381 #else
382
383 static inline int fsnotify(struct inode *to_tell, __u32 mask, const void *data, int data_is,
384                            const unsigned char *name, u32 cookie)
385 {
386         return 0;
387 }
388
389 static inline int __fsnotify_parent(const struct path *path, struct dentry *dentry, __u32 mask)
390 {
391         return 0;
392 }
393
394 static inline void __fsnotify_inode_delete(struct inode *inode)
395 {}
396
397 static inline void __fsnotify_vfsmount_delete(struct vfsmount *mnt)
398 {}
399
400 static inline void fsnotify_update_flags(struct dentry *dentry)
401 {}
402
403 static inline u32 fsnotify_get_cookie(void)
404 {
405         return 0;
406 }
407
408 static inline void fsnotify_unmount_inodes(struct super_block *sb)
409 {}
410
411 #endif  /* CONFIG_FSNOTIFY */
412
413 #endif  /* __KERNEL __ */
414
415 #endif  /* __LINUX_FSNOTIFY_BACKEND_H */