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