1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/fanotify.h>
3 #include <linux/fdtable.h>
4 #include <linux/fsnotify_backend.h>
5 #include <linux/init.h>
6 #include <linux/jiffies.h>
7 #include <linux/kernel.h> /* UINT_MAX */
8 #include <linux/mount.h>
9 #include <linux/sched.h>
10 #include <linux/sched/user.h>
11 #include <linux/types.h>
12 #include <linux/wait.h>
16 static bool should_merge(struct fsnotify_event *old_fsn,
17 struct fsnotify_event *new_fsn)
19 struct fanotify_event_info *old, *new;
21 pr_debug("%s: old=%p new=%p\n", __func__, old_fsn, new_fsn);
22 old = FANOTIFY_E(old_fsn);
23 new = FANOTIFY_E(new_fsn);
25 if (old_fsn->inode == new_fsn->inode && old->tgid == new->tgid &&
26 old->path.mnt == new->path.mnt &&
27 old->path.dentry == new->path.dentry)
32 /* and the list better be locked by something too! */
33 static int fanotify_merge(struct list_head *list, struct fsnotify_event *event)
35 struct fsnotify_event *test_event;
37 pr_debug("%s: list=%p event=%p\n", __func__, list, event);
39 #ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
41 * Don't merge a permission event with any other event so that we know
42 * the event structure we have created in fanotify_handle_event() is the
43 * one we should check for permission response.
45 if (event->mask & FAN_ALL_PERM_EVENTS)
49 list_for_each_entry_reverse(test_event, list, list) {
50 if (should_merge(test_event, event)) {
51 test_event->mask |= event->mask;
59 #ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
60 static int fanotify_get_response(struct fsnotify_group *group,
61 struct fanotify_perm_event_info *event,
62 struct fsnotify_iter_info *iter_info)
66 pr_debug("%s: group=%p event=%p\n", __func__, group, event);
68 wait_event(group->fanotify_data.access_waitq, event->response);
70 /* userspace responded, convert to something usable */
71 switch (event->response) {
81 pr_debug("%s: group=%p event=%p about to return ret=%d\n", __func__,
88 static bool fanotify_should_send_event(struct fsnotify_mark *inode_mark,
89 struct fsnotify_mark *vfsmnt_mark,
91 const void *data, int data_type)
93 __u32 marks_mask = 0, marks_ignored_mask = 0;
94 const struct path *path = data;
96 pr_debug("%s: inode_mark=%p vfsmnt_mark=%p mask=%x data=%p"
97 " data_type=%d\n", __func__, inode_mark, vfsmnt_mark,
98 event_mask, data, data_type);
100 /* if we don't have enough info to send an event to userspace say no */
101 if (data_type != FSNOTIFY_EVENT_PATH)
104 /* sorry, fanotify only gives a damn about files and dirs */
105 if (!d_is_reg(path->dentry) &&
106 !d_can_lookup(path->dentry))
110 * if the event is for a child and this inode doesn't care about
111 * events on the child, don't send it!
114 (!(event_mask & FS_EVENT_ON_CHILD) ||
115 (inode_mark->mask & FS_EVENT_ON_CHILD))) {
116 marks_mask |= inode_mark->mask;
117 marks_ignored_mask |= inode_mark->ignored_mask;
121 marks_mask |= vfsmnt_mark->mask;
122 marks_ignored_mask |= vfsmnt_mark->ignored_mask;
125 if (d_is_dir(path->dentry) &&
126 !(marks_mask & FS_ISDIR & ~marks_ignored_mask))
129 if (event_mask & FAN_ALL_OUTGOING_EVENTS & marks_mask &
136 struct fanotify_event_info *fanotify_alloc_event(struct inode *inode, u32 mask,
137 const struct path *path)
139 struct fanotify_event_info *event;
141 #ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
142 if (mask & FAN_ALL_PERM_EVENTS) {
143 struct fanotify_perm_event_info *pevent;
145 pevent = kmem_cache_alloc(fanotify_perm_event_cachep,
149 event = &pevent->fae;
150 pevent->response = 0;
154 event = kmem_cache_alloc(fanotify_event_cachep, GFP_KERNEL);
158 fsnotify_init_event(&event->fse, inode, mask);
159 event->tgid = get_pid(task_tgid(current));
162 path_get(&event->path);
164 event->path.mnt = NULL;
165 event->path.dentry = NULL;
170 static int fanotify_handle_event(struct fsnotify_group *group,
172 struct fsnotify_mark *inode_mark,
173 struct fsnotify_mark *fanotify_mark,
174 u32 mask, const void *data, int data_type,
175 const unsigned char *file_name, u32 cookie,
176 struct fsnotify_iter_info *iter_info)
179 struct fanotify_event_info *event;
180 struct fsnotify_event *fsn_event;
182 BUILD_BUG_ON(FAN_ACCESS != FS_ACCESS);
183 BUILD_BUG_ON(FAN_MODIFY != FS_MODIFY);
184 BUILD_BUG_ON(FAN_CLOSE_NOWRITE != FS_CLOSE_NOWRITE);
185 BUILD_BUG_ON(FAN_CLOSE_WRITE != FS_CLOSE_WRITE);
186 BUILD_BUG_ON(FAN_OPEN != FS_OPEN);
187 BUILD_BUG_ON(FAN_EVENT_ON_CHILD != FS_EVENT_ON_CHILD);
188 BUILD_BUG_ON(FAN_Q_OVERFLOW != FS_Q_OVERFLOW);
189 BUILD_BUG_ON(FAN_OPEN_PERM != FS_OPEN_PERM);
190 BUILD_BUG_ON(FAN_ACCESS_PERM != FS_ACCESS_PERM);
191 BUILD_BUG_ON(FAN_ONDIR != FS_ISDIR);
193 if (!fanotify_should_send_event(inode_mark, fanotify_mark, mask, data,
197 pr_debug("%s: group=%p inode=%p mask=%x\n", __func__, group, inode,
200 #ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
201 if (mask & FAN_ALL_PERM_EVENTS) {
203 * fsnotify_prepare_user_wait() fails if we race with mark
204 * deletion. Just let the operation pass in that case.
206 if (!fsnotify_prepare_user_wait(iter_info))
211 event = fanotify_alloc_event(inode, mask, data);
213 if (unlikely(!event))
216 fsn_event = &event->fse;
217 ret = fsnotify_add_event(group, fsn_event, fanotify_merge);
219 /* Permission events shouldn't be merged */
220 BUG_ON(ret == 1 && mask & FAN_ALL_PERM_EVENTS);
221 /* Our event wasn't used in the end. Free it. */
222 fsnotify_destroy_event(group, fsn_event);
228 #ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
229 if (mask & FAN_ALL_PERM_EVENTS) {
230 ret = fanotify_get_response(group, FANOTIFY_PE(fsn_event),
232 fsnotify_destroy_event(group, fsn_event);
235 if (mask & FAN_ALL_PERM_EVENTS)
236 fsnotify_finish_user_wait(iter_info);
243 static void fanotify_free_group_priv(struct fsnotify_group *group)
245 struct user_struct *user;
247 user = group->fanotify_data.user;
248 atomic_dec(&user->fanotify_listeners);
252 static void fanotify_free_event(struct fsnotify_event *fsn_event)
254 struct fanotify_event_info *event;
256 event = FANOTIFY_E(fsn_event);
257 path_put(&event->path);
258 put_pid(event->tgid);
259 #ifdef CONFIG_FANOTIFY_ACCESS_PERMISSIONS
260 if (fsn_event->mask & FAN_ALL_PERM_EVENTS) {
261 kmem_cache_free(fanotify_perm_event_cachep,
262 FANOTIFY_PE(fsn_event));
266 kmem_cache_free(fanotify_event_cachep, event);
269 static void fanotify_free_mark(struct fsnotify_mark *fsn_mark)
271 kmem_cache_free(fanotify_mark_cache, fsn_mark);
274 const struct fsnotify_ops fanotify_fsnotify_ops = {
275 .handle_event = fanotify_handle_event,
276 .free_group_priv = fanotify_free_group_priv,
277 .free_event = fanotify_free_event,
278 .free_mark = fanotify_free_mark,