]> git.ipfire.org Git - people/ms/linux.git/blame - fs/notify/fanotify/fanotify_user.c
Linux 5.13-rc5
[people/ms/linux.git] / fs / notify / fanotify / fanotify_user.c
CommitLineData
b2441318 1// SPDX-License-Identifier: GPL-2.0
33d3dfff 2#include <linux/fanotify.h>
11637e4b 3#include <linux/fcntl.h>
2a3edf86 4#include <linux/file.h>
11637e4b 5#include <linux/fs.h>
52c923dd 6#include <linux/anon_inodes.h>
11637e4b 7#include <linux/fsnotify_backend.h>
2a3edf86 8#include <linux/init.h>
a1014f10 9#include <linux/mount.h>
2a3edf86 10#include <linux/namei.h>
a1014f10 11#include <linux/poll.h>
11637e4b
EP
12#include <linux/security.h>
13#include <linux/syscalls.h>
e4e047a2 14#include <linux/slab.h>
2a3edf86 15#include <linux/types.h>
a1014f10 16#include <linux/uaccess.h>
91c2e0bc 17#include <linux/compat.h>
174cd4b1 18#include <linux/sched/signal.h>
d46eb14b 19#include <linux/memcontrol.h>
a8b13aa2
AG
20#include <linux/statfs.h>
21#include <linux/exportfs.h>
a1014f10
EP
22
23#include <asm/ioctls.h>
11637e4b 24
c63181e6 25#include "../../mount.h"
be77196b 26#include "../fdinfo.h"
7053aee2 27#include "fanotify.h"
c63181e6 28
2529a0df 29#define FANOTIFY_DEFAULT_MAX_EVENTS 16384
5b8fea65
AG
30#define FANOTIFY_OLD_DEFAULT_MAX_MARKS 8192
31#define FANOTIFY_DEFAULT_MAX_GROUPS 128
32
33/*
34 * Legacy fanotify marks limits (8192) is per group and we introduced a tunable
35 * limit of marks per user, similar to inotify. Effectively, the legacy limit
36 * of fanotify marks per user is <max marks per group> * <max groups per user>.
37 * This default limit (1M) also happens to match the increased limit of inotify
38 * max_user_watches since v5.10.
39 */
40#define FANOTIFY_DEFAULT_MAX_USER_MARKS \
41 (FANOTIFY_OLD_DEFAULT_MAX_MARKS * FANOTIFY_DEFAULT_MAX_GROUPS)
42
43/*
44 * Most of the memory cost of adding an inode mark is pinning the marked inode.
45 * The size of the filesystem inode struct is not uniform across filesystems,
46 * so double the size of a VFS inode is used as a conservative approximation.
47 */
48#define INODE_MARK_COST (2 * sizeof(struct inode))
49
50/* configurable via /proc/sys/fs/fanotify/ */
51static int fanotify_max_queued_events __read_mostly;
52
53#ifdef CONFIG_SYSCTL
54
55#include <linux/sysctl.h>
56
57struct ctl_table fanotify_table[] = {
58 {
59 .procname = "max_user_groups",
60 .data = &init_user_ns.ucount_max[UCOUNT_FANOTIFY_GROUPS],
61 .maxlen = sizeof(int),
62 .mode = 0644,
63 .proc_handler = proc_dointvec_minmax,
64 .extra1 = SYSCTL_ZERO,
65 },
66 {
67 .procname = "max_user_marks",
68 .data = &init_user_ns.ucount_max[UCOUNT_FANOTIFY_MARKS],
69 .maxlen = sizeof(int),
70 .mode = 0644,
71 .proc_handler = proc_dointvec_minmax,
72 .extra1 = SYSCTL_ZERO,
73 },
74 {
75 .procname = "max_queued_events",
76 .data = &fanotify_max_queued_events,
77 .maxlen = sizeof(int),
78 .mode = 0644,
79 .proc_handler = proc_dointvec_minmax,
80 .extra1 = SYSCTL_ZERO
81 },
82 { }
83};
84#endif /* CONFIG_SYSCTL */
2529a0df 85
48149e9d
HS
86/*
87 * All flags that may be specified in parameter event_f_flags of fanotify_init.
88 *
89 * Internal and external open flags are stored together in field f_flags of
90 * struct file. Only external open flags shall be allowed in event_f_flags.
91 * Internal flags like FMODE_NONOTIFY, FMODE_EXEC, FMODE_NOCMTIME shall be
92 * excluded.
93 */
94#define FANOTIFY_INIT_ALL_EVENT_F_BITS ( \
95 O_ACCMODE | O_APPEND | O_NONBLOCK | \
96 __O_SYNC | O_DSYNC | O_CLOEXEC | \
97 O_LARGEFILE | O_NOATIME )
98
33d3dfff 99extern const struct fsnotify_ops fanotify_fsnotify_ops;
11637e4b 100
054c636e 101struct kmem_cache *fanotify_mark_cache __read_mostly;
7088f357
JK
102struct kmem_cache *fanotify_fid_event_cachep __read_mostly;
103struct kmem_cache *fanotify_path_event_cachep __read_mostly;
f083441b 104struct kmem_cache *fanotify_perm_event_cachep __read_mostly;
2a3edf86 105
5e469c83 106#define FANOTIFY_EVENT_ALIGN 4
44d705b0
AG
107#define FANOTIFY_INFO_HDR_LEN \
108 (sizeof(struct fanotify_event_info_fid) + sizeof(struct file_handle))
5e469c83 109
44d705b0 110static int fanotify_fid_info_len(int fh_len, int name_len)
d766b553 111{
44d705b0
AG
112 int info_len = fh_len;
113
114 if (name_len)
115 info_len += name_len + 1;
116
117 return roundup(FANOTIFY_INFO_HDR_LEN + info_len, FANOTIFY_EVENT_ALIGN);
d766b553
AG
118}
119
929943b3
AG
120static int fanotify_event_info_len(unsigned int fid_mode,
121 struct fanotify_event *event)
5e469c83 122{
f454fa61
AG
123 struct fanotify_info *info = fanotify_event_info(event);
124 int dir_fh_len = fanotify_event_dir_fh_len(event);
afc894c7 125 int fh_len = fanotify_event_object_fh_len(event);
f454fa61 126 int info_len = 0;
929943b3 127 int dot_len = 0;
f454fa61 128
929943b3 129 if (dir_fh_len) {
f454fa61 130 info_len += fanotify_fid_info_len(dir_fh_len, info->name_len);
929943b3
AG
131 } else if ((fid_mode & FAN_REPORT_NAME) && (event->mask & FAN_ONDIR)) {
132 /*
133 * With group flag FAN_REPORT_NAME, if name was not recorded in
134 * event on a directory, we will report the name ".".
135 */
136 dot_len = 1;
137 }
afc894c7 138
44d705b0 139 if (fh_len)
929943b3 140 info_len += fanotify_fid_info_len(fh_len, dot_len);
44d705b0 141
44d705b0 142 return info_len;
5e469c83
AG
143}
144
94e00d28
AG
145/*
146 * Remove an hashed event from merge hash table.
147 */
148static void fanotify_unhash_event(struct fsnotify_group *group,
149 struct fanotify_event *event)
150{
151 assert_spin_locked(&group->notification_lock);
152
153 pr_debug("%s: group=%p event=%p bucket=%u\n", __func__,
154 group, event, fanotify_event_hash_bucket(group, event));
155
156 if (WARN_ON_ONCE(hlist_unhashed(&event->merge_list)))
157 return;
158
159 hlist_del_init(&event->merge_list);
160}
161
a1014f10 162/*
7088f357 163 * Get an fanotify notification event if one exists and is small
a1014f10 164 * enough to fit in "count". Return an error pointer if the count
40873284
JK
165 * is not large enough. When permission event is dequeued, its state is
166 * updated accordingly.
a1014f10 167 */
7088f357 168static struct fanotify_event *get_one_event(struct fsnotify_group *group,
a1014f10
EP
169 size_t count)
170{
5e469c83 171 size_t event_size = FAN_EVENT_METADATA_LEN;
7088f357 172 struct fanotify_event *event = NULL;
6f73171e 173 struct fsnotify_event *fsn_event;
929943b3 174 unsigned int fid_mode = FAN_GROUP_FLAG(group, FANOTIFY_FID_BITS);
a1014f10
EP
175
176 pr_debug("%s: group=%p count=%zd\n", __func__, group, count);
177
8c554466 178 spin_lock(&group->notification_lock);
6f73171e
AG
179 fsn_event = fsnotify_peek_first_event(group);
180 if (!fsn_event)
8c554466 181 goto out;
a1014f10 182
6f73171e
AG
183 event = FANOTIFY_E(fsn_event);
184 if (fid_mode)
185 event_size += fanotify_event_info_len(fid_mode, event);
5e469c83 186
8c554466 187 if (event_size > count) {
7088f357 188 event = ERR_PTR(-EINVAL);
8c554466
JK
189 goto out;
190 }
6f73171e
AG
191
192 /*
193 * Held the notification_lock the whole time, so this is the
194 * same event we peeked above.
195 */
196 fsnotify_remove_first_event(group);
7088f357
JK
197 if (fanotify_is_perm_event(event->mask))
198 FANOTIFY_PERM(event)->state = FAN_EVENT_REPORTED;
94e00d28
AG
199 if (fanotify_is_hashed_event(event->mask))
200 fanotify_unhash_event(group, event);
8c554466
JK
201out:
202 spin_unlock(&group->notification_lock);
7088f357 203 return event;
a1014f10
EP
204}
205
a741c2fe 206static int create_fd(struct fsnotify_group *group, struct path *path,
7053aee2 207 struct file **file)
a1014f10
EP
208{
209 int client_fd;
a1014f10
EP
210 struct file *new_file;
211
0b37e097 212 client_fd = get_unused_fd_flags(group->fanotify_data.f_flags);
a1014f10
EP
213 if (client_fd < 0)
214 return client_fd;
215
a1014f10
EP
216 /*
217 * we need a new file handle for the userspace program so it can read even if it was
218 * originally opened O_WRONLY.
219 */
a741c2fe
JK
220 new_file = dentry_open(path,
221 group->fanotify_data.f_flags | FMODE_NONOTIFY,
222 current_cred());
a1014f10
EP
223 if (IS_ERR(new_file)) {
224 /*
225 * we still send an event even if we can't open the file. this
226 * can happen when say tasks are gone and we try to open their
227 * /proc files or we try to open a WRONLY file like in sysfs
228 * we just send the errno to userspace since there isn't much
229 * else we can do.
230 */
231 put_unused_fd(client_fd);
232 client_fd = PTR_ERR(new_file);
233 } else {
352e3b24 234 *file = new_file;
a1014f10
EP
235 }
236
22aa425d 237 return client_fd;
a1014f10
EP
238}
239
40873284
JK
240/*
241 * Finish processing of permission event by setting it to ANSWERED state and
242 * drop group->notification_lock.
243 */
244static void finish_permission_event(struct fsnotify_group *group,
245 struct fanotify_perm_event *event,
246 unsigned int response)
247 __releases(&group->notification_lock)
248{
fabf7f29
JK
249 bool destroy = false;
250
40873284
JK
251 assert_spin_locked(&group->notification_lock);
252 event->response = response;
fabf7f29
JK
253 if (event->state == FAN_EVENT_CANCELED)
254 destroy = true;
255 else
256 event->state = FAN_EVENT_ANSWERED;
40873284 257 spin_unlock(&group->notification_lock);
fabf7f29
JK
258 if (destroy)
259 fsnotify_destroy_event(group, &event->fae.fse);
40873284
JK
260}
261
b2d87909
EP
262static int process_access_response(struct fsnotify_group *group,
263 struct fanotify_response *response_struct)
264{
33913997 265 struct fanotify_perm_event *event;
f083441b
JK
266 int fd = response_struct->fd;
267 int response = response_struct->response;
b2d87909
EP
268
269 pr_debug("%s: group=%p fd=%d response=%d\n", __func__, group,
270 fd, response);
271 /*
272 * make sure the response is valid, if invalid we do nothing and either
25985edc 273 * userspace can send a valid response or we will clean it up after the
b2d87909
EP
274 * timeout
275 */
de8cd83e 276 switch (response & ~FAN_AUDIT) {
b2d87909
EP
277 case FAN_ALLOW:
278 case FAN_DENY:
279 break;
280 default:
281 return -EINVAL;
282 }
283
284 if (fd < 0)
285 return -EINVAL;
286
96a71f21 287 if ((response & FAN_AUDIT) && !FAN_GROUP_FLAG(group, FAN_ENABLE_AUDIT))
de8cd83e
SG
288 return -EINVAL;
289
af6a5113
JK
290 spin_lock(&group->notification_lock);
291 list_for_each_entry(event, &group->fanotify_data.access_list,
292 fae.fse.list) {
293 if (event->fd != fd)
294 continue;
b2d87909 295
af6a5113 296 list_del_init(&event->fae.fse.list);
40873284 297 finish_permission_event(group, event, response);
af6a5113
JK
298 wake_up(&group->fanotify_data.access_waitq);
299 return 0;
300 }
301 spin_unlock(&group->notification_lock);
b2d87909 302
af6a5113 303 return -ENOENT;
b2d87909 304}
b2d87909 305
44d705b0 306static int copy_info_to_user(__kernel_fsid_t *fsid, struct fanotify_fh *fh,
83b7a598 307 int info_type, const char *name, size_t name_len,
44d705b0 308 char __user *buf, size_t count)
5e469c83
AG
309{
310 struct fanotify_event_info_fid info = { };
311 struct file_handle handle = { };
afc894c7 312 unsigned char bounce[FANOTIFY_INLINE_FH_LEN], *fh_buf;
cacfb956 313 size_t fh_len = fh ? fh->len : 0;
44d705b0
AG
314 size_t info_len = fanotify_fid_info_len(fh_len, name_len);
315 size_t len = info_len;
5e469c83 316
44d705b0
AG
317 pr_debug("%s: fh_len=%zu name_len=%zu, info_len=%zu, count=%zu\n",
318 __func__, fh_len, name_len, info_len, count);
319
83b7a598 320 if (!fh_len)
5e469c83
AG
321 return 0;
322
44d705b0 323 if (WARN_ON_ONCE(len < sizeof(info) || len > count))
5e469c83
AG
324 return -EFAULT;
325
44d705b0
AG
326 /*
327 * Copy event info fid header followed by variable sized file handle
328 * and optionally followed by variable sized filename.
329 */
83b7a598
AG
330 switch (info_type) {
331 case FAN_EVENT_INFO_TYPE_FID:
332 case FAN_EVENT_INFO_TYPE_DFID:
333 if (WARN_ON_ONCE(name_len))
334 return -EFAULT;
335 break;
336 case FAN_EVENT_INFO_TYPE_DFID_NAME:
337 if (WARN_ON_ONCE(!name || !name_len))
338 return -EFAULT;
339 break;
340 default:
341 return -EFAULT;
342 }
343
344 info.hdr.info_type = info_type;
5e469c83 345 info.hdr.len = len;
d766b553 346 info.fsid = *fsid;
5e469c83
AG
347 if (copy_to_user(buf, &info, sizeof(info)))
348 return -EFAULT;
349
350 buf += sizeof(info);
351 len -= sizeof(info);
44d705b0
AG
352 if (WARN_ON_ONCE(len < sizeof(handle)))
353 return -EFAULT;
354
afc894c7 355 handle.handle_type = fh->type;
5e469c83
AG
356 handle.handle_bytes = fh_len;
357 if (copy_to_user(buf, &handle, sizeof(handle)))
358 return -EFAULT;
359
360 buf += sizeof(handle);
361 len -= sizeof(handle);
44d705b0
AG
362 if (WARN_ON_ONCE(len < fh_len))
363 return -EFAULT;
364
b2d22b6b 365 /*
44d705b0
AG
366 * For an inline fh and inline file name, copy through stack to exclude
367 * the copy from usercopy hardening protections.
b2d22b6b 368 */
afc894c7 369 fh_buf = fanotify_fh_buf(fh);
b2d22b6b 370 if (fh_len <= FANOTIFY_INLINE_FH_LEN) {
afc894c7
JK
371 memcpy(bounce, fh_buf, fh_len);
372 fh_buf = bounce;
b2d22b6b 373 }
afc894c7 374 if (copy_to_user(buf, fh_buf, fh_len))
5e469c83
AG
375 return -EFAULT;
376
5e469c83
AG
377 buf += fh_len;
378 len -= fh_len;
44d705b0
AG
379
380 if (name_len) {
381 /* Copy the filename with terminating null */
382 name_len++;
383 if (WARN_ON_ONCE(len < name_len))
384 return -EFAULT;
385
386 if (copy_to_user(buf, name, name_len))
387 return -EFAULT;
388
389 buf += name_len;
390 len -= name_len;
391 }
392
393 /* Pad with 0's */
5e469c83
AG
394 WARN_ON_ONCE(len < 0 || len >= FANOTIFY_EVENT_ALIGN);
395 if (len > 0 && clear_user(buf, len))
396 return -EFAULT;
397
44d705b0 398 return info_len;
5e469c83
AG
399}
400
a1014f10 401static ssize_t copy_event_to_user(struct fsnotify_group *group,
7088f357 402 struct fanotify_event *event,
5b03a472 403 char __user *buf, size_t count)
a1014f10 404{
bb2f7b45 405 struct fanotify_event_metadata metadata;
7088f357 406 struct path *path = fanotify_event_path(event);
f454fa61 407 struct fanotify_info *info = fanotify_event_info(event);
83b7a598 408 unsigned int fid_mode = FAN_GROUP_FLAG(group, FANOTIFY_FID_BITS);
bb2f7b45 409 struct file *f = NULL;
e9e0c890 410 int ret, fd = FAN_NOFD;
83b7a598 411 int info_type = 0;
a1014f10 412
7088f357 413 pr_debug("%s: group=%p event=%p\n", __func__, group, event);
a1014f10 414
44d705b0 415 metadata.event_len = FAN_EVENT_METADATA_LEN +
929943b3 416 fanotify_event_info_len(fid_mode, event);
bb2f7b45
AG
417 metadata.metadata_len = FAN_EVENT_METADATA_LEN;
418 metadata.vers = FANOTIFY_METADATA_VERSION;
419 metadata.reserved = 0;
420 metadata.mask = event->mask & FANOTIFY_OUTGOING_EVENTS;
421 metadata.pid = pid_vnr(event->pid);
7cea2a3c
AG
422 /*
423 * For an unprivileged listener, event->pid can be used to identify the
424 * events generated by the listener process itself, without disclosing
425 * the pids of other processes.
426 */
a8b98c80 427 if (FAN_GROUP_FLAG(group, FANOTIFY_UNPRIV) &&
7cea2a3c
AG
428 task_tgid(current) != event->pid)
429 metadata.pid = 0;
bb2f7b45 430
a8b98c80
AG
431 /*
432 * For now, fid mode is required for an unprivileged listener and
433 * fid mode does not report fd in events. Keep this check anyway
434 * for safety in case fid mode requirement is relaxed in the future
435 * to allow unprivileged listener to get events with no fd and no fid.
436 */
437 if (!FAN_GROUP_FLAG(group, FANOTIFY_UNPRIV) &&
438 path && path->mnt && path->dentry) {
afc894c7
JK
439 fd = create_fd(group, path, &f);
440 if (fd < 0)
441 return fd;
bb2f7b45
AG
442 }
443 metadata.fd = fd;
b2d87909 444
b2d87909 445 ret = -EFAULT;
5b03a472
KC
446 /*
447 * Sanity check copy size in case get_one_event() and
c5e443cb 448 * event_len sizes ever get out of sync.
5b03a472 449 */
bb2f7b45 450 if (WARN_ON_ONCE(metadata.event_len > count))
5b03a472 451 goto out_close_fd;
bb2f7b45 452
5e469c83 453 if (copy_to_user(buf, &metadata, FAN_EVENT_METADATA_LEN))
352e3b24
AV
454 goto out_close_fd;
455
44d705b0
AG
456 buf += FAN_EVENT_METADATA_LEN;
457 count -= FAN_EVENT_METADATA_LEN;
458
bb2f7b45 459 if (fanotify_is_perm_event(event->mask))
7088f357 460 FANOTIFY_PERM(event)->fd = fd;
a1014f10 461
44d705b0 462 if (f)
3587b1b0 463 fd_install(fd, f);
44d705b0
AG
464
465 /* Event info records order is: dir fid + name, child fid */
f454fa61 466 if (fanotify_event_dir_fh_len(event)) {
691d9763
AG
467 info_type = info->name_len ? FAN_EVENT_INFO_TYPE_DFID_NAME :
468 FAN_EVENT_INFO_TYPE_DFID;
44d705b0 469 ret = copy_info_to_user(fanotify_event_fsid(event),
f454fa61 470 fanotify_info_dir_fh(info),
83b7a598 471 info_type, fanotify_info_name(info),
f454fa61 472 info->name_len, buf, count);
5e469c83
AG
473 if (ret < 0)
474 return ret;
44d705b0
AG
475
476 buf += ret;
477 count -= ret;
478 }
479
480 if (fanotify_event_object_fh_len(event)) {
929943b3
AG
481 const char *dot = NULL;
482 int dot_len = 0;
483
83b7a598
AG
484 if (fid_mode == FAN_REPORT_FID || info_type) {
485 /*
486 * With only group flag FAN_REPORT_FID only type FID is
487 * reported. Second info record type is always FID.
488 */
489 info_type = FAN_EVENT_INFO_TYPE_FID;
929943b3
AG
490 } else if ((fid_mode & FAN_REPORT_NAME) &&
491 (event->mask & FAN_ONDIR)) {
492 /*
493 * With group flag FAN_REPORT_NAME, if name was not
494 * recorded in an event on a directory, report the
495 * name "." with info type DFID_NAME.
496 */
497 info_type = FAN_EVENT_INFO_TYPE_DFID_NAME;
498 dot = ".";
499 dot_len = 1;
83b7a598
AG
500 } else if ((event->mask & ALL_FSNOTIFY_DIRENT_EVENTS) ||
501 (event->mask & FAN_ONDIR)) {
502 /*
503 * With group flag FAN_REPORT_DIR_FID, a single info
504 * record has type DFID for directory entry modification
505 * event and for event on a directory.
506 */
507 info_type = FAN_EVENT_INFO_TYPE_DFID;
508 } else {
509 /*
510 * With group flags FAN_REPORT_DIR_FID|FAN_REPORT_FID,
511 * a single info record has type FID for event on a
512 * non-directory, when there is no directory to report.
513 * For example, on FAN_DELETE_SELF event.
514 */
515 info_type = FAN_EVENT_INFO_TYPE_FID;
516 }
517
44d705b0
AG
518 ret = copy_info_to_user(fanotify_event_fsid(event),
519 fanotify_event_object_fh(event),
929943b3 520 info_type, dot, dot_len, buf, count);
44d705b0
AG
521 if (ret < 0)
522 return ret;
523
524 buf += ret;
525 count -= ret;
5e469c83
AG
526 }
527
bb2f7b45 528 return metadata.event_len;
b2d87909 529
b2d87909 530out_close_fd:
352e3b24
AV
531 if (fd != FAN_NOFD) {
532 put_unused_fd(fd);
533 fput(f);
534 }
b2d87909 535 return ret;
a1014f10
EP
536}
537
538/* intofiy userspace file descriptor functions */
076ccb76 539static __poll_t fanotify_poll(struct file *file, poll_table *wait)
a1014f10
EP
540{
541 struct fsnotify_group *group = file->private_data;
076ccb76 542 __poll_t ret = 0;
a1014f10
EP
543
544 poll_wait(file, &group->notification_waitq, wait);
c21dbe20 545 spin_lock(&group->notification_lock);
a1014f10 546 if (!fsnotify_notify_queue_is_empty(group))
a9a08845 547 ret = EPOLLIN | EPOLLRDNORM;
c21dbe20 548 spin_unlock(&group->notification_lock);
a1014f10
EP
549
550 return ret;
551}
552
553static ssize_t fanotify_read(struct file *file, char __user *buf,
554 size_t count, loff_t *pos)
555{
556 struct fsnotify_group *group;
7088f357 557 struct fanotify_event *event;
a1014f10
EP
558 char __user *start;
559 int ret;
536ebe9c 560 DEFINE_WAIT_FUNC(wait, woken_wake_function);
a1014f10
EP
561
562 start = buf;
563 group = file->private_data;
564
565 pr_debug("%s: group=%p\n", __func__, group);
566
536ebe9c 567 add_wait_queue(&group->notification_waitq, &wait);
a1014f10 568 while (1) {
47aaabde
JK
569 /*
570 * User can supply arbitrarily large buffer. Avoid softlockups
571 * in case there are lots of available events.
572 */
573 cond_resched();
7088f357
JK
574 event = get_one_event(group, count);
575 if (IS_ERR(event)) {
576 ret = PTR_ERR(event);
d8aaab4f
JK
577 break;
578 }
579
7088f357 580 if (!event) {
d8aaab4f
JK
581 ret = -EAGAIN;
582 if (file->f_flags & O_NONBLOCK)
a1014f10 583 break;
d8aaab4f
JK
584
585 ret = -ERESTARTSYS;
586 if (signal_pending(current))
587 break;
588
589 if (start != buf)
a1014f10 590 break;
536ebe9c
PZ
591
592 wait_woken(&wait, TASK_INTERRUPTIBLE, MAX_SCHEDULE_TIMEOUT);
a1014f10
EP
593 continue;
594 }
595
7088f357 596 ret = copy_event_to_user(group, event, buf, count);
4ff33aaf
AG
597 if (unlikely(ret == -EOPENSTALE)) {
598 /*
599 * We cannot report events with stale fd so drop it.
600 * Setting ret to 0 will continue the event loop and
601 * do the right thing if there are no more events to
602 * read (i.e. return bytes read, -EAGAIN or wait).
603 */
604 ret = 0;
605 }
606
d8aaab4f
JK
607 /*
608 * Permission events get queued to wait for response. Other
609 * events can be destroyed now.
610 */
7088f357
JK
611 if (!fanotify_is_perm_event(event->mask)) {
612 fsnotify_destroy_event(group, &event->fse);
d507816b 613 } else {
4ff33aaf 614 if (ret <= 0) {
40873284
JK
615 spin_lock(&group->notification_lock);
616 finish_permission_event(group,
7088f357 617 FANOTIFY_PERM(event), FAN_DENY);
d507816b 618 wake_up(&group->fanotify_data.access_waitq);
4ff33aaf
AG
619 } else {
620 spin_lock(&group->notification_lock);
7088f357 621 list_add_tail(&event->fse.list,
4ff33aaf
AG
622 &group->fanotify_data.access_list);
623 spin_unlock(&group->notification_lock);
d507816b 624 }
d507816b 625 }
4ff33aaf
AG
626 if (ret < 0)
627 break;
d8aaab4f
JK
628 buf += ret;
629 count -= ret;
a1014f10 630 }
536ebe9c 631 remove_wait_queue(&group->notification_waitq, &wait);
a1014f10 632
a1014f10
EP
633 if (start != buf && ret != -EFAULT)
634 ret = buf - start;
635 return ret;
636}
637
b2d87909
EP
638static ssize_t fanotify_write(struct file *file, const char __user *buf, size_t count, loff_t *pos)
639{
b2d87909
EP
640 struct fanotify_response response = { .fd = -1, .response = -1 };
641 struct fsnotify_group *group;
642 int ret;
643
6685df31
MS
644 if (!IS_ENABLED(CONFIG_FANOTIFY_ACCESS_PERMISSIONS))
645 return -EINVAL;
646
b2d87909
EP
647 group = file->private_data;
648
5e23663b
FF
649 if (count < sizeof(response))
650 return -EINVAL;
651
652 count = sizeof(response);
b2d87909
EP
653
654 pr_debug("%s: group=%p count=%zu\n", __func__, group, count);
655
656 if (copy_from_user(&response, buf, count))
657 return -EFAULT;
658
659 ret = process_access_response(group, &response);
660 if (ret < 0)
661 count = ret;
662
663 return count;
b2d87909
EP
664}
665
52c923dd
EP
666static int fanotify_release(struct inode *ignored, struct file *file)
667{
668 struct fsnotify_group *group = file->private_data;
6f73171e 669 struct fsnotify_event *fsn_event;
19ba54f4 670
5838d444 671 /*
96d41019
JK
672 * Stop new events from arriving in the notification queue. since
673 * userspace cannot use fanotify fd anymore, no event can enter or
674 * leave access_list by now either.
5838d444 675 */
96d41019 676 fsnotify_group_stop_queueing(group);
2eebf582 677
96d41019
JK
678 /*
679 * Process all permission events on access_list and notification queue
680 * and simulate reply from userspace.
681 */
073f6552 682 spin_lock(&group->notification_lock);
ca6f8699 683 while (!list_empty(&group->fanotify_data.access_list)) {
7088f357
JK
684 struct fanotify_perm_event *event;
685
ca6f8699
JK
686 event = list_first_entry(&group->fanotify_data.access_list,
687 struct fanotify_perm_event, fae.fse.list);
f083441b 688 list_del_init(&event->fae.fse.list);
40873284
JK
689 finish_permission_event(group, event, FAN_ALLOW);
690 spin_lock(&group->notification_lock);
2eebf582 691 }
2eebf582 692
5838d444 693 /*
96d41019
JK
694 * Destroy all non-permission events. For permission events just
695 * dequeue them and set the response. They will be freed once the
696 * response is consumed and fanotify_get_response() returns.
5838d444 697 */
6f73171e
AG
698 while ((fsn_event = fsnotify_remove_first_event(group))) {
699 struct fanotify_event *event = FANOTIFY_E(fsn_event);
7088f357 700
7088f357 701 if (!(event->mask & FANOTIFY_PERM_EVENTS)) {
c21dbe20 702 spin_unlock(&group->notification_lock);
6f73171e 703 fsnotify_destroy_event(group, fsn_event);
6685df31 704 } else {
7088f357 705 finish_permission_event(group, FANOTIFY_PERM(event),
40873284 706 FAN_ALLOW);
6685df31 707 }
40873284 708 spin_lock(&group->notification_lock);
96d41019 709 }
c21dbe20 710 spin_unlock(&group->notification_lock);
96d41019
JK
711
712 /* Response for all permission events it set, wakeup waiters */
2eebf582 713 wake_up(&group->fanotify_data.access_waitq);
0a6b6bd5 714
52c923dd 715 /* matches the fanotify_init->fsnotify_alloc_group */
d8153d4d 716 fsnotify_destroy_group(group);
52c923dd
EP
717
718 return 0;
719}
720
a1014f10
EP
721static long fanotify_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
722{
723 struct fsnotify_group *group;
7053aee2 724 struct fsnotify_event *fsn_event;
a1014f10
EP
725 void __user *p;
726 int ret = -ENOTTY;
727 size_t send_len = 0;
728
729 group = file->private_data;
730
731 p = (void __user *) arg;
732
733 switch (cmd) {
734 case FIONREAD:
c21dbe20 735 spin_lock(&group->notification_lock);
7053aee2 736 list_for_each_entry(fsn_event, &group->notification_list, list)
a1014f10 737 send_len += FAN_EVENT_METADATA_LEN;
c21dbe20 738 spin_unlock(&group->notification_lock);
a1014f10
EP
739 ret = put_user(send_len, (int __user *) p);
740 break;
741 }
742
743 return ret;
744}
745
52c923dd 746static const struct file_operations fanotify_fops = {
be77196b 747 .show_fdinfo = fanotify_show_fdinfo,
a1014f10
EP
748 .poll = fanotify_poll,
749 .read = fanotify_read,
b2d87909 750 .write = fanotify_write,
52c923dd
EP
751 .fasync = NULL,
752 .release = fanotify_release,
a1014f10 753 .unlocked_ioctl = fanotify_ioctl,
1832f2d8 754 .compat_ioctl = compat_ptr_ioctl,
6038f373 755 .llseek = noop_llseek,
52c923dd
EP
756};
757
2a3edf86 758static int fanotify_find_path(int dfd, const char __user *filename,
ac5656d8
AG
759 struct path *path, unsigned int flags, __u64 mask,
760 unsigned int obj_type)
2a3edf86
EP
761{
762 int ret;
763
764 pr_debug("%s: dfd=%d filename=%p flags=%x\n", __func__,
765 dfd, filename, flags);
766
767 if (filename == NULL) {
2903ff01 768 struct fd f = fdget(dfd);
2a3edf86
EP
769
770 ret = -EBADF;
2903ff01 771 if (!f.file)
2a3edf86
EP
772 goto out;
773
774 ret = -ENOTDIR;
775 if ((flags & FAN_MARK_ONLYDIR) &&
496ad9aa 776 !(S_ISDIR(file_inode(f.file)->i_mode))) {
2903ff01 777 fdput(f);
2a3edf86
EP
778 goto out;
779 }
780
2903ff01 781 *path = f.file->f_path;
2a3edf86 782 path_get(path);
2903ff01 783 fdput(f);
2a3edf86
EP
784 } else {
785 unsigned int lookup_flags = 0;
786
787 if (!(flags & FAN_MARK_DONT_FOLLOW))
788 lookup_flags |= LOOKUP_FOLLOW;
789 if (flags & FAN_MARK_ONLYDIR)
790 lookup_flags |= LOOKUP_DIRECTORY;
791
792 ret = user_path_at(dfd, filename, lookup_flags, path);
793 if (ret)
794 goto out;
795 }
796
797 /* you can only watch an inode if you have read permissions on it */
02f92b38 798 ret = path_permission(path, MAY_READ);
ac5656d8
AG
799 if (ret) {
800 path_put(path);
801 goto out;
802 }
803
804 ret = security_path_notify(path, mask, obj_type);
2a3edf86
EP
805 if (ret)
806 path_put(path);
ac5656d8 807
2a3edf86
EP
808out:
809 return ret;
810}
811
b9e4e3bd 812static __u32 fanotify_mark_remove_from_mask(struct fsnotify_mark *fsn_mark,
4ed6814a
AG
813 __u32 mask, unsigned int flags,
814 __u32 umask, int *destroy)
088b09b0 815{
d2c1874c 816 __u32 oldmask = 0;
088b09b0 817
4ed6814a
AG
818 /* umask bits cannot be removed by user */
819 mask &= ~umask;
088b09b0 820 spin_lock(&fsn_mark->lock);
b9e4e3bd
EP
821 if (!(flags & FAN_MARK_IGNORED_MASK)) {
822 oldmask = fsn_mark->mask;
a72fd224 823 fsn_mark->mask &= ~mask;
b9e4e3bd 824 } else {
a72fd224 825 fsn_mark->ignored_mask &= ~mask;
b9e4e3bd 826 }
4ed6814a
AG
827 /*
828 * We need to keep the mark around even if remaining mask cannot
829 * result in any events (e.g. mask == FAN_ONDIR) to support incremenal
830 * changes to the mask.
831 * Destroy mark when only umask bits remain.
832 */
833 *destroy = !((fsn_mark->mask | fsn_mark->ignored_mask) & ~umask);
088b09b0
AG
834 spin_unlock(&fsn_mark->lock);
835
088b09b0
AG
836 return mask & oldmask;
837}
838
eaa2c6b0
AG
839static int fanotify_remove_mark(struct fsnotify_group *group,
840 fsnotify_connp_t *connp, __u32 mask,
4ed6814a 841 unsigned int flags, __u32 umask)
88826276
EP
842{
843 struct fsnotify_mark *fsn_mark = NULL;
088b09b0 844 __u32 removed;
6dfbd149 845 int destroy_mark;
88826276 846
7b18527c 847 mutex_lock(&group->mark_mutex);
eaa2c6b0 848 fsn_mark = fsnotify_find_mark(connp, group);
7b18527c
LS
849 if (!fsn_mark) {
850 mutex_unlock(&group->mark_mutex);
f3640192 851 return -ENOENT;
7b18527c 852 }
88826276 853
6dfbd149 854 removed = fanotify_mark_remove_from_mask(fsn_mark, mask, flags,
4ed6814a 855 umask, &destroy_mark);
3ac70bfc
AG
856 if (removed & fsnotify_conn_mask(fsn_mark->connector))
857 fsnotify_recalc_mask(fsn_mark->connector);
6dfbd149 858 if (destroy_mark)
4712e722 859 fsnotify_detach_mark(fsn_mark);
7b18527c 860 mutex_unlock(&group->mark_mutex);
4712e722
JK
861 if (destroy_mark)
862 fsnotify_free_mark(fsn_mark);
6dfbd149 863
eaa2c6b0 864 /* matches the fsnotify_find_mark() */
f3640192 865 fsnotify_put_mark(fsn_mark);
f3640192
AG
866 return 0;
867}
2a3edf86 868
eaa2c6b0
AG
869static int fanotify_remove_vfsmount_mark(struct fsnotify_group *group,
870 struct vfsmount *mnt, __u32 mask,
4ed6814a 871 unsigned int flags, __u32 umask)
eaa2c6b0
AG
872{
873 return fanotify_remove_mark(group, &real_mount(mnt)->mnt_fsnotify_marks,
4ed6814a 874 mask, flags, umask);
eaa2c6b0
AG
875}
876
d54f4fba 877static int fanotify_remove_sb_mark(struct fsnotify_group *group,
4ed6814a
AG
878 struct super_block *sb, __u32 mask,
879 unsigned int flags, __u32 umask)
d54f4fba 880{
4ed6814a
AG
881 return fanotify_remove_mark(group, &sb->s_fsnotify_marks, mask,
882 flags, umask);
d54f4fba
AG
883}
884
f3640192 885static int fanotify_remove_inode_mark(struct fsnotify_group *group,
b9e4e3bd 886 struct inode *inode, __u32 mask,
4ed6814a 887 unsigned int flags, __u32 umask)
f3640192 888{
eaa2c6b0 889 return fanotify_remove_mark(group, &inode->i_fsnotify_marks, mask,
4ed6814a 890 flags, umask);
2a3edf86
EP
891}
892
b9e4e3bd
EP
893static __u32 fanotify_mark_add_to_mask(struct fsnotify_mark *fsn_mark,
894 __u32 mask,
895 unsigned int flags)
912ee394 896{
192ca4d1 897 __u32 oldmask = -1;
912ee394
AG
898
899 spin_lock(&fsn_mark->lock);
b9e4e3bd
EP
900 if (!(flags & FAN_MARK_IGNORED_MASK)) {
901 oldmask = fsn_mark->mask;
a72fd224 902 fsn_mark->mask |= mask;
b9e4e3bd 903 } else {
a72fd224 904 fsn_mark->ignored_mask |= mask;
c9778a98
EP
905 if (flags & FAN_MARK_IGNORED_SURV_MODIFY)
906 fsn_mark->flags |= FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY;
b9e4e3bd 907 }
912ee394
AG
908 spin_unlock(&fsn_mark->lock);
909
910 return mask & ~oldmask;
911}
912
5e9c070c 913static struct fsnotify_mark *fanotify_add_new_mark(struct fsnotify_group *group,
b812a9f5 914 fsnotify_connp_t *connp,
77115225
AG
915 unsigned int type,
916 __kernel_fsid_t *fsid)
5e9c070c 917{
5b8fea65 918 struct ucounts *ucounts = group->fanotify_data.ucounts;
5e9c070c
LS
919 struct fsnotify_mark *mark;
920 int ret;
921
5b8fea65
AG
922 /*
923 * Enforce per user marks limits per user in all containing user ns.
924 * A group with FAN_UNLIMITED_MARKS does not contribute to mark count
925 * in the limited groups account.
926 */
927 if (!FAN_GROUP_FLAG(group, FAN_UNLIMITED_MARKS) &&
928 !inc_ucount(ucounts->ns, ucounts->uid, UCOUNT_FANOTIFY_MARKS))
5e9c070c
LS
929 return ERR_PTR(-ENOSPC);
930
931 mark = kmem_cache_alloc(fanotify_mark_cache, GFP_KERNEL);
5b8fea65
AG
932 if (!mark) {
933 ret = -ENOMEM;
934 goto out_dec_ucounts;
935 }
5e9c070c 936
054c636e 937 fsnotify_init_mark(mark, group);
77115225 938 ret = fsnotify_add_mark_locked(mark, connp, type, 0, fsid);
5e9c070c
LS
939 if (ret) {
940 fsnotify_put_mark(mark);
5b8fea65 941 goto out_dec_ucounts;
5e9c070c
LS
942 }
943
944 return mark;
5b8fea65
AG
945
946out_dec_ucounts:
947 if (!FAN_GROUP_FLAG(group, FAN_UNLIMITED_MARKS))
948 dec_ucount(ucounts, UCOUNT_FANOTIFY_MARKS);
949 return ERR_PTR(ret);
5e9c070c
LS
950}
951
952
eaa2c6b0
AG
953static int fanotify_add_mark(struct fsnotify_group *group,
954 fsnotify_connp_t *connp, unsigned int type,
77115225
AG
955 __u32 mask, unsigned int flags,
956 __kernel_fsid_t *fsid)
2a3edf86
EP
957{
958 struct fsnotify_mark *fsn_mark;
912ee394 959 __u32 added;
2a3edf86 960
7b18527c 961 mutex_lock(&group->mark_mutex);
b812a9f5 962 fsn_mark = fsnotify_find_mark(connp, group);
88826276 963 if (!fsn_mark) {
77115225 964 fsn_mark = fanotify_add_new_mark(group, connp, type, fsid);
5e9c070c 965 if (IS_ERR(fsn_mark)) {
7b18527c 966 mutex_unlock(&group->mark_mutex);
5e9c070c 967 return PTR_ERR(fsn_mark);
7b18527c 968 }
88826276 969 }
b9e4e3bd 970 added = fanotify_mark_add_to_mask(fsn_mark, mask, flags);
3ac70bfc
AG
971 if (added & ~fsnotify_conn_mask(fsn_mark->connector))
972 fsnotify_recalc_mask(fsn_mark->connector);
c9747640 973 mutex_unlock(&group->mark_mutex);
5e9c070c 974
fa218ab9 975 fsnotify_put_mark(fsn_mark);
5e9c070c 976 return 0;
88826276
EP
977}
978
eaa2c6b0
AG
979static int fanotify_add_vfsmount_mark(struct fsnotify_group *group,
980 struct vfsmount *mnt, __u32 mask,
77115225 981 unsigned int flags, __kernel_fsid_t *fsid)
eaa2c6b0
AG
982{
983 return fanotify_add_mark(group, &real_mount(mnt)->mnt_fsnotify_marks,
77115225 984 FSNOTIFY_OBJ_TYPE_VFSMOUNT, mask, flags, fsid);
eaa2c6b0
AG
985}
986
d54f4fba 987static int fanotify_add_sb_mark(struct fsnotify_group *group,
77115225
AG
988 struct super_block *sb, __u32 mask,
989 unsigned int flags, __kernel_fsid_t *fsid)
d54f4fba
AG
990{
991 return fanotify_add_mark(group, &sb->s_fsnotify_marks,
77115225 992 FSNOTIFY_OBJ_TYPE_SB, mask, flags, fsid);
d54f4fba
AG
993}
994
52202dfb 995static int fanotify_add_inode_mark(struct fsnotify_group *group,
b9e4e3bd 996 struct inode *inode, __u32 mask,
77115225 997 unsigned int flags, __kernel_fsid_t *fsid)
88826276 998{
88826276 999 pr_debug("%s: group=%p inode=%p\n", __func__, group, inode);
2a3edf86 1000
5322a59f
EP
1001 /*
1002 * If some other task has this inode open for write we should not add
1003 * an ignored mark, unless that ignored mark is supposed to survive
1004 * modification changes anyway.
1005 */
1006 if ((flags & FAN_MARK_IGNORED_MASK) &&
1007 !(flags & FAN_MARK_IGNORED_SURV_MODIFY) &&
ac9498d6 1008 inode_is_open_for_write(inode))
5322a59f
EP
1009 return 0;
1010
eaa2c6b0 1011 return fanotify_add_mark(group, &inode->i_fsnotify_marks,
77115225 1012 FSNOTIFY_OBJ_TYPE_INODE, mask, flags, fsid);
88826276 1013}
2a3edf86 1014
b8a6c3a2
AG
1015static struct fsnotify_event *fanotify_alloc_overflow_event(void)
1016{
1017 struct fanotify_event *oevent;
1018
1019 oevent = kmalloc(sizeof(*oevent), GFP_KERNEL_ACCOUNT);
1020 if (!oevent)
1021 return NULL;
1022
1023 fanotify_init_event(oevent, 0, FS_Q_OVERFLOW);
1024 oevent->type = FANOTIFY_EVENT_TYPE_OVERFLOW;
1025
1026 return &oevent->fse;
1027}
1028
94e00d28
AG
1029static struct hlist_head *fanotify_alloc_merge_hash(void)
1030{
1031 struct hlist_head *hash;
1032
1033 hash = kmalloc(sizeof(struct hlist_head) << FANOTIFY_HTABLE_BITS,
1034 GFP_KERNEL_ACCOUNT);
1035 if (!hash)
1036 return NULL;
1037
1038 __hash_init(hash, FANOTIFY_HTABLE_SIZE);
1039
1040 return hash;
1041}
1042
52c923dd 1043/* fanotify syscalls */
08ae8938 1044SYSCALL_DEFINE2(fanotify_init, unsigned int, flags, unsigned int, event_f_flags)
11637e4b 1045{
52c923dd
EP
1046 struct fsnotify_group *group;
1047 int f_flags, fd;
83b7a598
AG
1048 unsigned int fid_mode = flags & FANOTIFY_FID_BITS;
1049 unsigned int class = flags & FANOTIFY_CLASS_BITS;
a8b98c80 1050 unsigned int internal_flags = 0;
52c923dd 1051
96a71f21
AG
1052 pr_debug("%s: flags=%x event_f_flags=%x\n",
1053 __func__, flags, event_f_flags);
52c923dd 1054
7cea2a3c
AG
1055 if (!capable(CAP_SYS_ADMIN)) {
1056 /*
1057 * An unprivileged user can setup an fanotify group with
1058 * limited functionality - an unprivileged group is limited to
1059 * notification events with file handles and it cannot use
1060 * unlimited queue/marks.
1061 */
1062 if ((flags & FANOTIFY_ADMIN_INIT_FLAGS) || !fid_mode)
1063 return -EPERM;
a8b98c80
AG
1064
1065 /*
1066 * Setting the internal flag FANOTIFY_UNPRIV on the group
1067 * prevents setting mount/filesystem marks on this group and
1068 * prevents reporting pid and open fd in events.
1069 */
1070 internal_flags |= FANOTIFY_UNPRIV;
7cea2a3c 1071 }
52c923dd 1072
de8cd83e 1073#ifdef CONFIG_AUDITSYSCALL
23c9deeb 1074 if (flags & ~(FANOTIFY_INIT_FLAGS | FAN_ENABLE_AUDIT))
de8cd83e 1075#else
23c9deeb 1076 if (flags & ~FANOTIFY_INIT_FLAGS)
de8cd83e 1077#endif
52c923dd
EP
1078 return -EINVAL;
1079
48149e9d
HS
1080 if (event_f_flags & ~FANOTIFY_INIT_ALL_EVENT_F_BITS)
1081 return -EINVAL;
1082
1083 switch (event_f_flags & O_ACCMODE) {
1084 case O_RDONLY:
1085 case O_RDWR:
1086 case O_WRONLY:
1087 break;
1088 default:
1089 return -EINVAL;
1090 }
1091
83b7a598 1092 if (fid_mode && class != FAN_CLASS_NOTIF)
a8b13aa2
AG
1093 return -EINVAL;
1094
929943b3 1095 /*
929943b3 1096 * Child name is reported with parent fid so requires dir fid.
691d9763 1097 * We can report both child fid and dir fid with or without name.
929943b3 1098 */
691d9763 1099 if ((fid_mode & FAN_REPORT_NAME) && !(fid_mode & FAN_REPORT_DIR_FID))
83b7a598 1100 return -EINVAL;
83b7a598 1101
b2d87909 1102 f_flags = O_RDWR | FMODE_NONOTIFY;
52c923dd
EP
1103 if (flags & FAN_CLOEXEC)
1104 f_flags |= O_CLOEXEC;
1105 if (flags & FAN_NONBLOCK)
1106 f_flags |= O_NONBLOCK;
1107
1108 /* fsnotify_alloc_group takes a ref. Dropped in fanotify_release */
ac7b79fd 1109 group = fsnotify_alloc_user_group(&fanotify_fsnotify_ops);
26379198 1110 if (IS_ERR(group)) {
52c923dd 1111 return PTR_ERR(group);
26379198 1112 }
52c923dd 1113
5b8fea65
AG
1114 /* Enforce groups limits per user in all containing user ns */
1115 group->fanotify_data.ucounts = inc_ucount(current_user_ns(),
1116 current_euid(),
1117 UCOUNT_FANOTIFY_GROUPS);
1118 if (!group->fanotify_data.ucounts) {
1119 fd = -EMFILE;
1120 goto out_destroy_group;
1121 }
1122
a8b98c80 1123 group->fanotify_data.flags = flags | internal_flags;
d46eb14b 1124 group->memcg = get_mem_cgroup_from_mm(current->mm);
4afeff85 1125
94e00d28
AG
1126 group->fanotify_data.merge_hash = fanotify_alloc_merge_hash();
1127 if (!group->fanotify_data.merge_hash) {
1128 fd = -ENOMEM;
1129 goto out_destroy_group;
1130 }
1131
b8a6c3a2
AG
1132 group->overflow_event = fanotify_alloc_overflow_event();
1133 if (unlikely(!group->overflow_event)) {
ff57cd58
JK
1134 fd = -ENOMEM;
1135 goto out_destroy_group;
1136 }
ff57cd58 1137
1e2ee49f
WW
1138 if (force_o_largefile())
1139 event_f_flags |= O_LARGEFILE;
80af2588 1140 group->fanotify_data.f_flags = event_f_flags;
9e66e423
EP
1141 init_waitqueue_head(&group->fanotify_data.access_waitq);
1142 INIT_LIST_HEAD(&group->fanotify_data.access_list);
83b7a598 1143 switch (class) {
4231a235
EP
1144 case FAN_CLASS_NOTIF:
1145 group->priority = FS_PRIO_0;
1146 break;
1147 case FAN_CLASS_CONTENT:
1148 group->priority = FS_PRIO_1;
1149 break;
1150 case FAN_CLASS_PRE_CONTENT:
1151 group->priority = FS_PRIO_2;
1152 break;
1153 default:
1154 fd = -EINVAL;
d8153d4d 1155 goto out_destroy_group;
4231a235 1156 }
cb2d429f 1157
5dd03f55
EP
1158 if (flags & FAN_UNLIMITED_QUEUE) {
1159 fd = -EPERM;
1160 if (!capable(CAP_SYS_ADMIN))
d8153d4d 1161 goto out_destroy_group;
5dd03f55
EP
1162 group->max_events = UINT_MAX;
1163 } else {
5b8fea65 1164 group->max_events = fanotify_max_queued_events;
5dd03f55 1165 }
2529a0df 1166
ac7e22dc
EP
1167 if (flags & FAN_UNLIMITED_MARKS) {
1168 fd = -EPERM;
1169 if (!capable(CAP_SYS_ADMIN))
d8153d4d 1170 goto out_destroy_group;
ac7e22dc 1171 }
e7099d8a 1172
de8cd83e
SG
1173 if (flags & FAN_ENABLE_AUDIT) {
1174 fd = -EPERM;
1175 if (!capable(CAP_AUDIT_WRITE))
1176 goto out_destroy_group;
de8cd83e
SG
1177 }
1178
52c923dd
EP
1179 fd = anon_inode_getfd("[fanotify]", &fanotify_fops, group, f_flags);
1180 if (fd < 0)
d8153d4d 1181 goto out_destroy_group;
52c923dd
EP
1182
1183 return fd;
1184
d8153d4d
LS
1185out_destroy_group:
1186 fsnotify_destroy_group(group);
52c923dd 1187 return fd;
11637e4b 1188}
bbaa4168 1189
a8b13aa2 1190/* Check if filesystem can encode a unique fid */
73072283 1191static int fanotify_test_fid(struct path *path, __kernel_fsid_t *fsid)
a8b13aa2 1192{
73072283 1193 __kernel_fsid_t root_fsid;
a8b13aa2
AG
1194 int err;
1195
1196 /*
1197 * Make sure path is not in filesystem with zero fsid (e.g. tmpfs).
1198 */
73072283 1199 err = vfs_get_fsid(path->dentry, fsid);
a8b13aa2
AG
1200 if (err)
1201 return err;
1202
73072283 1203 if (!fsid->val[0] && !fsid->val[1])
a8b13aa2
AG
1204 return -ENODEV;
1205
1206 /*
1207 * Make sure path is not inside a filesystem subvolume (e.g. btrfs)
1208 * which uses a different fsid than sb root.
1209 */
73072283 1210 err = vfs_get_fsid(path->dentry->d_sb->s_root, &root_fsid);
a8b13aa2
AG
1211 if (err)
1212 return err;
1213
73072283
AG
1214 if (root_fsid.val[0] != fsid->val[0] ||
1215 root_fsid.val[1] != fsid->val[1])
a8b13aa2
AG
1216 return -EXDEV;
1217
1218 /*
1219 * We need to make sure that the file system supports at least
1220 * encoding a file handle so user can use name_to_handle_at() to
1221 * compare fid returned with event to the file handle of watched
1222 * objects. However, name_to_handle_at() requires that the
1223 * filesystem also supports decoding file handles.
1224 */
1225 if (!path->dentry->d_sb->s_export_op ||
1226 !path->dentry->d_sb->s_export_op->fh_to_dentry)
1227 return -EOPNOTSUPP;
1228
1229 return 0;
1230}
1231
0b3b094a
JK
1232static int fanotify_events_supported(struct path *path, __u64 mask)
1233{
1234 /*
1235 * Some filesystems such as 'proc' acquire unusual locks when opening
1236 * files. For them fanotify permission events have high chances of
1237 * deadlocking the system - open done when reporting fanotify event
1238 * blocks on this "unusual" lock while another process holding the lock
1239 * waits for fanotify permission event to be answered. Just disallow
1240 * permission events for such filesystems.
1241 */
1242 if (mask & FANOTIFY_PERM_EVENTS &&
1243 path->mnt->mnt_sb->s_type->fs_flags & FS_DISALLOW_NOTIFY_PERM)
1244 return -EINVAL;
1245 return 0;
1246}
1247
183caa3c
DB
1248static int do_fanotify_mark(int fanotify_fd, unsigned int flags, __u64 mask,
1249 int dfd, const char __user *pathname)
bbaa4168 1250{
0ff21db9
EP
1251 struct inode *inode = NULL;
1252 struct vfsmount *mnt = NULL;
2a3edf86 1253 struct fsnotify_group *group;
2903ff01 1254 struct fd f;
2a3edf86 1255 struct path path;
73072283 1256 __kernel_fsid_t __fsid, *fsid = NULL;
bdd5a46f 1257 u32 valid_mask = FANOTIFY_EVENTS | FANOTIFY_EVENT_FLAGS;
23c9deeb 1258 unsigned int mark_type = flags & FANOTIFY_MARK_TYPE_BITS;
3ef86653 1259 bool ignored = flags & FAN_MARK_IGNORED_MASK;
d809daf1 1260 unsigned int obj_type, fid_mode;
85af5d92 1261 u32 umask = 0;
2903ff01 1262 int ret;
2a3edf86
EP
1263
1264 pr_debug("%s: fanotify_fd=%d flags=%x dfd=%d pathname=%p mask=%llx\n",
1265 __func__, fanotify_fd, flags, dfd, pathname, mask);
1266
1267 /* we only use the lower 32 bits as of right now. */
22d483b9 1268 if (upper_32_bits(mask))
2a3edf86
EP
1269 return -EINVAL;
1270
23c9deeb 1271 if (flags & ~FANOTIFY_MARK_FLAGS)
88380fe6 1272 return -EINVAL;
d54f4fba
AG
1273
1274 switch (mark_type) {
1275 case FAN_MARK_INODE:
ac5656d8
AG
1276 obj_type = FSNOTIFY_OBJ_TYPE_INODE;
1277 break;
d54f4fba 1278 case FAN_MARK_MOUNT:
ac5656d8
AG
1279 obj_type = FSNOTIFY_OBJ_TYPE_VFSMOUNT;
1280 break;
d54f4fba 1281 case FAN_MARK_FILESYSTEM:
ac5656d8 1282 obj_type = FSNOTIFY_OBJ_TYPE_SB;
d54f4fba
AG
1283 break;
1284 default:
1285 return -EINVAL;
1286 }
1287
4d92604c 1288 switch (flags & (FAN_MARK_ADD | FAN_MARK_REMOVE | FAN_MARK_FLUSH)) {
df561f66 1289 case FAN_MARK_ADD:
88380fe6 1290 case FAN_MARK_REMOVE:
1734dee4
LS
1291 if (!mask)
1292 return -EINVAL;
cc299a98 1293 break;
4d92604c 1294 case FAN_MARK_FLUSH:
23c9deeb 1295 if (flags & ~(FANOTIFY_MARK_TYPE_BITS | FAN_MARK_FLUSH))
cc299a98 1296 return -EINVAL;
88380fe6
AG
1297 break;
1298 default:
1299 return -EINVAL;
1300 }
8fcd6528 1301
6685df31 1302 if (IS_ENABLED(CONFIG_FANOTIFY_ACCESS_PERMISSIONS))
23c9deeb 1303 valid_mask |= FANOTIFY_PERM_EVENTS;
6685df31
MS
1304
1305 if (mask & ~valid_mask)
2a3edf86
EP
1306 return -EINVAL;
1307
3ef86653
AG
1308 /* Event flags (ONDIR, ON_CHILD) are meaningless in ignored mask */
1309 if (ignored)
1310 mask &= ~FANOTIFY_EVENT_FLAGS;
1311
2903ff01
AV
1312 f = fdget(fanotify_fd);
1313 if (unlikely(!f.file))
2a3edf86
EP
1314 return -EBADF;
1315
1316 /* verify that this is indeed an fanotify instance */
1317 ret = -EINVAL;
2903ff01 1318 if (unlikely(f.file->f_op != &fanotify_fops))
2a3edf86 1319 goto fput_and_out;
2903ff01 1320 group = f.file->private_data;
4231a235 1321
7cea2a3c 1322 /*
a8b98c80
AG
1323 * An unprivileged user is not allowed to setup mount nor filesystem
1324 * marks. This also includes setting up such marks by a group that
1325 * was initialized by an unprivileged user.
7cea2a3c
AG
1326 */
1327 ret = -EPERM;
a8b98c80
AG
1328 if ((!capable(CAP_SYS_ADMIN) ||
1329 FAN_GROUP_FLAG(group, FANOTIFY_UNPRIV)) &&
7cea2a3c
AG
1330 mark_type != FAN_MARK_INODE)
1331 goto fput_and_out;
1332
4231a235
EP
1333 /*
1334 * group->priority == FS_PRIO_0 == FAN_CLASS_NOTIF. These are not
1335 * allowed to set permissions events.
1336 */
1337 ret = -EINVAL;
23c9deeb 1338 if (mask & FANOTIFY_PERM_EVENTS &&
4231a235
EP
1339 group->priority == FS_PRIO_0)
1340 goto fput_and_out;
2a3edf86 1341
235328d1
AG
1342 /*
1343 * Events with data type inode do not carry enough information to report
1344 * event->fd, so we do not allow setting a mask for inode events unless
1345 * group supports reporting fid.
1346 * inode events are not supported on a mount mark, because they do not
1347 * carry enough information (i.e. path) to be filtered by mount point.
1348 */
d809daf1 1349 fid_mode = FAN_GROUP_FLAG(group, FANOTIFY_FID_BITS);
235328d1 1350 if (mask & FANOTIFY_INODE_EVENTS &&
d809daf1 1351 (!fid_mode || mark_type == FAN_MARK_MOUNT))
235328d1
AG
1352 goto fput_and_out;
1353
0a8dd2db
HS
1354 if (flags & FAN_MARK_FLUSH) {
1355 ret = 0;
d54f4fba 1356 if (mark_type == FAN_MARK_MOUNT)
0a8dd2db 1357 fsnotify_clear_vfsmount_marks_by_group(group);
d54f4fba
AG
1358 else if (mark_type == FAN_MARK_FILESYSTEM)
1359 fsnotify_clear_sb_marks_by_group(group);
0a8dd2db
HS
1360 else
1361 fsnotify_clear_inode_marks_by_group(group);
1362 goto fput_and_out;
1363 }
1364
ac5656d8
AG
1365 ret = fanotify_find_path(dfd, pathname, &path, flags,
1366 (mask & ALL_FSNOTIFY_EVENTS), obj_type);
2a3edf86
EP
1367 if (ret)
1368 goto fput_and_out;
1369
0b3b094a
JK
1370 if (flags & FAN_MARK_ADD) {
1371 ret = fanotify_events_supported(&path, mask);
1372 if (ret)
1373 goto path_put_and_out;
1374 }
1375
d809daf1 1376 if (fid_mode) {
73072283 1377 ret = fanotify_test_fid(&path, &__fsid);
a8b13aa2
AG
1378 if (ret)
1379 goto path_put_and_out;
77115225 1380
73072283 1381 fsid = &__fsid;
a8b13aa2
AG
1382 }
1383
2a3edf86 1384 /* inode held in place by reference to path; group by fget on fd */
d54f4fba 1385 if (mark_type == FAN_MARK_INODE)
0ff21db9
EP
1386 inode = path.dentry->d_inode;
1387 else
1388 mnt = path.mnt;
2a3edf86 1389
85af5d92
AG
1390 /* Mask out FAN_EVENT_ON_CHILD flag for sb/mount/non-dir marks */
1391 if (mnt || !S_ISDIR(inode->i_mode)) {
1392 mask &= ~FAN_EVENT_ON_CHILD;
1393 umask = FAN_EVENT_ON_CHILD;
51280637
AG
1394 /*
1395 * If group needs to report parent fid, register for getting
1396 * events with parent/name info for non-directory.
1397 */
1398 if ((fid_mode & FAN_REPORT_DIR_FID) &&
1399 (flags & FAN_MARK_ADD) && !ignored)
1400 mask |= FAN_EVENT_ON_CHILD;
85af5d92
AG
1401 }
1402
2a3edf86 1403 /* create/update an inode mark */
0a8dd2db 1404 switch (flags & (FAN_MARK_ADD | FAN_MARK_REMOVE)) {
c6223f46 1405 case FAN_MARK_ADD:
d54f4fba 1406 if (mark_type == FAN_MARK_MOUNT)
77115225
AG
1407 ret = fanotify_add_vfsmount_mark(group, mnt, mask,
1408 flags, fsid);
d54f4fba 1409 else if (mark_type == FAN_MARK_FILESYSTEM)
77115225
AG
1410 ret = fanotify_add_sb_mark(group, mnt->mnt_sb, mask,
1411 flags, fsid);
0ff21db9 1412 else
77115225
AG
1413 ret = fanotify_add_inode_mark(group, inode, mask,
1414 flags, fsid);
c6223f46
AG
1415 break;
1416 case FAN_MARK_REMOVE:
d54f4fba 1417 if (mark_type == FAN_MARK_MOUNT)
77115225 1418 ret = fanotify_remove_vfsmount_mark(group, mnt, mask,
85af5d92 1419 flags, umask);
d54f4fba 1420 else if (mark_type == FAN_MARK_FILESYSTEM)
77115225 1421 ret = fanotify_remove_sb_mark(group, mnt->mnt_sb, mask,
85af5d92 1422 flags, umask);
f3640192 1423 else
77115225 1424 ret = fanotify_remove_inode_mark(group, inode, mask,
85af5d92 1425 flags, umask);
c6223f46
AG
1426 break;
1427 default:
1428 ret = -EINVAL;
1429 }
2a3edf86 1430
a8b13aa2 1431path_put_and_out:
2a3edf86
EP
1432 path_put(&path);
1433fput_and_out:
2903ff01 1434 fdput(f);
2a3edf86
EP
1435 return ret;
1436}
1437
2ca408d9 1438#ifndef CONFIG_ARCH_SPLIT_ARG64
183caa3c
DB
1439SYSCALL_DEFINE5(fanotify_mark, int, fanotify_fd, unsigned int, flags,
1440 __u64, mask, int, dfd,
1441 const char __user *, pathname)
1442{
1443 return do_fanotify_mark(fanotify_fd, flags, mask, dfd, pathname);
1444}
2ca408d9 1445#endif
183caa3c 1446
2ca408d9
BG
1447#if defined(CONFIG_ARCH_SPLIT_ARG64) || defined(CONFIG_COMPAT)
1448SYSCALL32_DEFINE6(fanotify_mark,
91c2e0bc 1449 int, fanotify_fd, unsigned int, flags,
2ca408d9 1450 SC_ARG64(mask), int, dfd,
91c2e0bc
AV
1451 const char __user *, pathname)
1452{
2ca408d9
BG
1453 return do_fanotify_mark(fanotify_fd, flags, SC_VAL64(__u64, mask),
1454 dfd, pathname);
91c2e0bc
AV
1455}
1456#endif
1457
2a3edf86 1458/*
ae0e47f0 1459 * fanotify_user_setup - Our initialization function. Note that we cannot return
2a3edf86
EP
1460 * error because we have compiled-in VFS hooks. So an (unlikely) failure here
1461 * must result in panic().
1462 */
1463static int __init fanotify_user_setup(void)
1464{
5b8fea65
AG
1465 struct sysinfo si;
1466 int max_marks;
1467
1468 si_meminfo(&si);
1469 /*
1470 * Allow up to 1% of addressable memory to be accounted for per user
1471 * marks limited to the range [8192, 1048576]. mount and sb marks are
1472 * a lot cheaper than inode marks, but there is no reason for a user
1473 * to have many of those, so calculate by the cost of inode marks.
1474 */
1475 max_marks = (((si.totalram - si.totalhigh) / 100) << PAGE_SHIFT) /
1476 INODE_MARK_COST;
1477 max_marks = clamp(max_marks, FANOTIFY_OLD_DEFAULT_MAX_MARKS,
1478 FANOTIFY_DEFAULT_MAX_USER_MARKS);
1479
a8b98c80 1480 BUILD_BUG_ON(FANOTIFY_INIT_FLAGS & FANOTIFY_INTERNAL_GROUP_FLAGS);
929943b3 1481 BUILD_BUG_ON(HWEIGHT32(FANOTIFY_INIT_FLAGS) != 10);
bdd5a46f
AG
1482 BUILD_BUG_ON(HWEIGHT32(FANOTIFY_MARK_FLAGS) != 9);
1483
d46eb14b
SB
1484 fanotify_mark_cache = KMEM_CACHE(fsnotify_mark,
1485 SLAB_PANIC|SLAB_ACCOUNT);
7088f357
JK
1486 fanotify_fid_event_cachep = KMEM_CACHE(fanotify_fid_event,
1487 SLAB_PANIC);
1488 fanotify_path_event_cachep = KMEM_CACHE(fanotify_path_event,
1489 SLAB_PANIC);
6685df31
MS
1490 if (IS_ENABLED(CONFIG_FANOTIFY_ACCESS_PERMISSIONS)) {
1491 fanotify_perm_event_cachep =
33913997 1492 KMEM_CACHE(fanotify_perm_event, SLAB_PANIC);
6685df31 1493 }
2a3edf86 1494
5b8fea65
AG
1495 fanotify_max_queued_events = FANOTIFY_DEFAULT_MAX_EVENTS;
1496 init_user_ns.ucount_max[UCOUNT_FANOTIFY_GROUPS] =
1497 FANOTIFY_DEFAULT_MAX_GROUPS;
1498 init_user_ns.ucount_max[UCOUNT_FANOTIFY_MARKS] = max_marks;
1499
2a3edf86 1500 return 0;
bbaa4168 1501}
2a3edf86 1502device_initcall(fanotify_user_setup);