Merge tag 'for_v4.20-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/jack/linux-fs
[sfrench/cifs-2.6.git] / fs / notify / fsnotify.c
1 /*
2  *  Copyright (C) 2008 Red Hat, Inc., Eric Paris <eparis@redhat.com>
3  *
4  *  This program is free software; you can redistribute it and/or modify
5  *  it under the terms of the GNU General Public License as published by
6  *  the Free Software Foundation; either version 2, or (at your option)
7  *  any later version.
8  *
9  *  This program is distributed in the hope that it will be useful,
10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  *  GNU General Public License for more details.
13  *
14  *  You should have received a copy of the GNU General Public License
15  *  along with this program; see the file COPYING.  If not, write to
16  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <linux/dcache.h>
20 #include <linux/fs.h>
21 #include <linux/gfp.h>
22 #include <linux/init.h>
23 #include <linux/module.h>
24 #include <linux/mount.h>
25 #include <linux/srcu.h>
26
27 #include <linux/fsnotify_backend.h>
28 #include "fsnotify.h"
29
30 /*
31  * Clear all of the marks on an inode when it is being evicted from core
32  */
33 void __fsnotify_inode_delete(struct inode *inode)
34 {
35         fsnotify_clear_marks_by_inode(inode);
36 }
37 EXPORT_SYMBOL_GPL(__fsnotify_inode_delete);
38
39 void __fsnotify_vfsmount_delete(struct vfsmount *mnt)
40 {
41         fsnotify_clear_marks_by_mount(mnt);
42 }
43
44 /**
45  * fsnotify_unmount_inodes - an sb is unmounting.  handle any watched inodes.
46  * @sb: superblock being unmounted.
47  *
48  * Called during unmount with no locks held, so needs to be safe against
49  * concurrent modifiers. We temporarily drop sb->s_inode_list_lock and CAN block.
50  */
51 static void fsnotify_unmount_inodes(struct super_block *sb)
52 {
53         struct inode *inode, *iput_inode = NULL;
54
55         spin_lock(&sb->s_inode_list_lock);
56         list_for_each_entry(inode, &sb->s_inodes, i_sb_list) {
57                 /*
58                  * We cannot __iget() an inode in state I_FREEING,
59                  * I_WILL_FREE, or I_NEW which is fine because by that point
60                  * the inode cannot have any associated watches.
61                  */
62                 spin_lock(&inode->i_lock);
63                 if (inode->i_state & (I_FREEING|I_WILL_FREE|I_NEW)) {
64                         spin_unlock(&inode->i_lock);
65                         continue;
66                 }
67
68                 /*
69                  * If i_count is zero, the inode cannot have any watches and
70                  * doing an __iget/iput with SB_ACTIVE clear would actually
71                  * evict all inodes with zero i_count from icache which is
72                  * unnecessarily violent and may in fact be illegal to do.
73                  */
74                 if (!atomic_read(&inode->i_count)) {
75                         spin_unlock(&inode->i_lock);
76                         continue;
77                 }
78
79                 __iget(inode);
80                 spin_unlock(&inode->i_lock);
81                 spin_unlock(&sb->s_inode_list_lock);
82
83                 if (iput_inode)
84                         iput(iput_inode);
85
86                 /* for each watch, send FS_UNMOUNT and then remove it */
87                 fsnotify(inode, FS_UNMOUNT, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
88
89                 fsnotify_inode_delete(inode);
90
91                 iput_inode = inode;
92
93                 spin_lock(&sb->s_inode_list_lock);
94         }
95         spin_unlock(&sb->s_inode_list_lock);
96
97         if (iput_inode)
98                 iput(iput_inode);
99         /* Wait for outstanding inode references from connectors */
100         wait_var_event(&sb->s_fsnotify_inode_refs,
101                        !atomic_long_read(&sb->s_fsnotify_inode_refs));
102 }
103
104 void fsnotify_sb_delete(struct super_block *sb)
105 {
106         fsnotify_unmount_inodes(sb);
107         fsnotify_clear_marks_by_sb(sb);
108 }
109
110 /*
111  * Given an inode, first check if we care what happens to our children.  Inotify
112  * and dnotify both tell their parents about events.  If we care about any event
113  * on a child we run all of our children and set a dentry flag saying that the
114  * parent cares.  Thus when an event happens on a child it can quickly tell if
115  * if there is a need to find a parent and send the event to the parent.
116  */
117 void __fsnotify_update_child_dentry_flags(struct inode *inode)
118 {
119         struct dentry *alias;
120         int watched;
121
122         if (!S_ISDIR(inode->i_mode))
123                 return;
124
125         /* determine if the children should tell inode about their events */
126         watched = fsnotify_inode_watches_children(inode);
127
128         spin_lock(&inode->i_lock);
129         /* run all of the dentries associated with this inode.  Since this is a
130          * directory, there damn well better only be one item on this list */
131         hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
132                 struct dentry *child;
133
134                 /* run all of the children of the original inode and fix their
135                  * d_flags to indicate parental interest (their parent is the
136                  * original inode) */
137                 spin_lock(&alias->d_lock);
138                 list_for_each_entry(child, &alias->d_subdirs, d_child) {
139                         if (!child->d_inode)
140                                 continue;
141
142                         spin_lock_nested(&child->d_lock, DENTRY_D_LOCK_NESTED);
143                         if (watched)
144                                 child->d_flags |= DCACHE_FSNOTIFY_PARENT_WATCHED;
145                         else
146                                 child->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
147                         spin_unlock(&child->d_lock);
148                 }
149                 spin_unlock(&alias->d_lock);
150         }
151         spin_unlock(&inode->i_lock);
152 }
153
154 /* Notify this dentry's parent about a child's events. */
155 int __fsnotify_parent(const struct path *path, struct dentry *dentry, __u32 mask)
156 {
157         struct dentry *parent;
158         struct inode *p_inode;
159         int ret = 0;
160
161         if (!dentry)
162                 dentry = path->dentry;
163
164         if (!(dentry->d_flags & DCACHE_FSNOTIFY_PARENT_WATCHED))
165                 return 0;
166
167         parent = dget_parent(dentry);
168         p_inode = parent->d_inode;
169
170         if (unlikely(!fsnotify_inode_watches_children(p_inode)))
171                 __fsnotify_update_child_dentry_flags(p_inode);
172         else if (p_inode->i_fsnotify_mask & mask) {
173                 struct name_snapshot name;
174
175                 /* we are notifying a parent so come up with the new mask which
176                  * specifies these are events which came from a child. */
177                 mask |= FS_EVENT_ON_CHILD;
178
179                 take_dentry_name_snapshot(&name, dentry);
180                 if (path)
181                         ret = fsnotify(p_inode, mask, path, FSNOTIFY_EVENT_PATH,
182                                        name.name, 0);
183                 else
184                         ret = fsnotify(p_inode, mask, dentry->d_inode, FSNOTIFY_EVENT_INODE,
185                                        name.name, 0);
186                 release_dentry_name_snapshot(&name);
187         }
188
189         dput(parent);
190
191         return ret;
192 }
193 EXPORT_SYMBOL_GPL(__fsnotify_parent);
194
195 static int send_to_group(struct inode *to_tell,
196                          __u32 mask, const void *data,
197                          int data_is, u32 cookie,
198                          const unsigned char *file_name,
199                          struct fsnotify_iter_info *iter_info)
200 {
201         struct fsnotify_group *group = NULL;
202         __u32 test_mask = (mask & ALL_FSNOTIFY_EVENTS);
203         __u32 marks_mask = 0;
204         __u32 marks_ignored_mask = 0;
205         struct fsnotify_mark *mark;
206         int type;
207
208         if (WARN_ON(!iter_info->report_mask))
209                 return 0;
210
211         /* clear ignored on inode modification */
212         if (mask & FS_MODIFY) {
213                 fsnotify_foreach_obj_type(type) {
214                         if (!fsnotify_iter_should_report_type(iter_info, type))
215                                 continue;
216                         mark = iter_info->marks[type];
217                         if (mark &&
218                             !(mark->flags & FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY))
219                                 mark->ignored_mask = 0;
220                 }
221         }
222
223         fsnotify_foreach_obj_type(type) {
224                 if (!fsnotify_iter_should_report_type(iter_info, type))
225                         continue;
226                 mark = iter_info->marks[type];
227                 /* does the object mark tell us to do something? */
228                 if (mark) {
229                         group = mark->group;
230                         marks_mask |= mark->mask;
231                         marks_ignored_mask |= mark->ignored_mask;
232                 }
233         }
234
235         pr_debug("%s: group=%p to_tell=%p mask=%x marks_mask=%x marks_ignored_mask=%x"
236                  " data=%p data_is=%d cookie=%d\n",
237                  __func__, group, to_tell, mask, marks_mask, marks_ignored_mask,
238                  data, data_is, cookie);
239
240         if (!(test_mask & marks_mask & ~marks_ignored_mask))
241                 return 0;
242
243         return group->ops->handle_event(group, to_tell, mask, data, data_is,
244                                         file_name, cookie, iter_info);
245 }
246
247 static struct fsnotify_mark *fsnotify_first_mark(struct fsnotify_mark_connector **connp)
248 {
249         struct fsnotify_mark_connector *conn;
250         struct hlist_node *node = NULL;
251
252         conn = srcu_dereference(*connp, &fsnotify_mark_srcu);
253         if (conn)
254                 node = srcu_dereference(conn->list.first, &fsnotify_mark_srcu);
255
256         return hlist_entry_safe(node, struct fsnotify_mark, obj_list);
257 }
258
259 static struct fsnotify_mark *fsnotify_next_mark(struct fsnotify_mark *mark)
260 {
261         struct hlist_node *node = NULL;
262
263         if (mark)
264                 node = srcu_dereference(mark->obj_list.next,
265                                         &fsnotify_mark_srcu);
266
267         return hlist_entry_safe(node, struct fsnotify_mark, obj_list);
268 }
269
270 /*
271  * iter_info is a multi head priority queue of marks.
272  * Pick a subset of marks from queue heads, all with the
273  * same group and set the report_mask for selected subset.
274  * Returns the report_mask of the selected subset.
275  */
276 static unsigned int fsnotify_iter_select_report_types(
277                 struct fsnotify_iter_info *iter_info)
278 {
279         struct fsnotify_group *max_prio_group = NULL;
280         struct fsnotify_mark *mark;
281         int type;
282
283         /* Choose max prio group among groups of all queue heads */
284         fsnotify_foreach_obj_type(type) {
285                 mark = iter_info->marks[type];
286                 if (mark &&
287                     fsnotify_compare_groups(max_prio_group, mark->group) > 0)
288                         max_prio_group = mark->group;
289         }
290
291         if (!max_prio_group)
292                 return 0;
293
294         /* Set the report mask for marks from same group as max prio group */
295         iter_info->report_mask = 0;
296         fsnotify_foreach_obj_type(type) {
297                 mark = iter_info->marks[type];
298                 if (mark &&
299                     fsnotify_compare_groups(max_prio_group, mark->group) == 0)
300                         fsnotify_iter_set_report_type(iter_info, type);
301         }
302
303         return iter_info->report_mask;
304 }
305
306 /*
307  * Pop from iter_info multi head queue, the marks that were iterated in the
308  * current iteration step.
309  */
310 static void fsnotify_iter_next(struct fsnotify_iter_info *iter_info)
311 {
312         int type;
313
314         fsnotify_foreach_obj_type(type) {
315                 if (fsnotify_iter_should_report_type(iter_info, type))
316                         iter_info->marks[type] =
317                                 fsnotify_next_mark(iter_info->marks[type]);
318         }
319 }
320
321 /*
322  * This is the main call to fsnotify.  The VFS calls into hook specific functions
323  * in linux/fsnotify.h.  Those functions then in turn call here.  Here will call
324  * out to all of the registered fsnotify_group.  Those groups can then use the
325  * notification event in whatever means they feel necessary.
326  */
327 int fsnotify(struct inode *to_tell, __u32 mask, const void *data, int data_is,
328              const unsigned char *file_name, u32 cookie)
329 {
330         struct fsnotify_iter_info iter_info = {};
331         struct super_block *sb = NULL;
332         struct mount *mnt = NULL;
333         __u32 mnt_or_sb_mask = 0;
334         int ret = 0;
335         __u32 test_mask = (mask & ALL_FSNOTIFY_EVENTS);
336
337         if (data_is == FSNOTIFY_EVENT_PATH) {
338                 mnt = real_mount(((const struct path *)data)->mnt);
339                 sb = mnt->mnt.mnt_sb;
340                 mnt_or_sb_mask = mnt->mnt_fsnotify_mask | sb->s_fsnotify_mask;
341         }
342
343         /*
344          * Optimization: srcu_read_lock() has a memory barrier which can
345          * be expensive.  It protects walking the *_fsnotify_marks lists.
346          * However, if we do not walk the lists, we do not have to do
347          * SRCU because we have no references to any objects and do not
348          * need SRCU to keep them "alive".
349          */
350         if (!to_tell->i_fsnotify_marks &&
351             (!mnt || (!mnt->mnt_fsnotify_marks && !sb->s_fsnotify_marks)))
352                 return 0;
353         /*
354          * if this is a modify event we may need to clear the ignored masks
355          * otherwise return if neither the inode nor the vfsmount/sb care about
356          * this type of event.
357          */
358         if (!(mask & FS_MODIFY) &&
359             !(test_mask & (to_tell->i_fsnotify_mask | mnt_or_sb_mask)))
360                 return 0;
361
362         iter_info.srcu_idx = srcu_read_lock(&fsnotify_mark_srcu);
363
364         iter_info.marks[FSNOTIFY_OBJ_TYPE_INODE] =
365                 fsnotify_first_mark(&to_tell->i_fsnotify_marks);
366         if (mnt) {
367                 iter_info.marks[FSNOTIFY_OBJ_TYPE_VFSMOUNT] =
368                         fsnotify_first_mark(&mnt->mnt_fsnotify_marks);
369                 iter_info.marks[FSNOTIFY_OBJ_TYPE_SB] =
370                         fsnotify_first_mark(&sb->s_fsnotify_marks);
371         }
372
373         /*
374          * We need to merge inode/vfsmount/sb mark lists so that e.g. inode mark
375          * ignore masks are properly reflected for mount/sb mark notifications.
376          * That's why this traversal is so complicated...
377          */
378         while (fsnotify_iter_select_report_types(&iter_info)) {
379                 ret = send_to_group(to_tell, mask, data, data_is, cookie,
380                                     file_name, &iter_info);
381
382                 if (ret && (mask & ALL_FSNOTIFY_PERM_EVENTS))
383                         goto out;
384
385                 fsnotify_iter_next(&iter_info);
386         }
387         ret = 0;
388 out:
389         srcu_read_unlock(&fsnotify_mark_srcu, iter_info.srcu_idx);
390
391         return ret;
392 }
393 EXPORT_SYMBOL_GPL(fsnotify);
394
395 extern struct kmem_cache *fsnotify_mark_connector_cachep;
396
397 static __init int fsnotify_init(void)
398 {
399         int ret;
400
401         BUILD_BUG_ON(HWEIGHT32(ALL_FSNOTIFY_BITS) != 23);
402
403         ret = init_srcu_struct(&fsnotify_mark_srcu);
404         if (ret)
405                 panic("initializing fsnotify_mark_srcu");
406
407         fsnotify_mark_connector_cachep = KMEM_CACHE(fsnotify_mark_connector,
408                                                     SLAB_PANIC);
409
410         return 0;
411 }
412 core_initcall(fsnotify_init);