blob: f22a04005db21145add6647352ff6b3e3848078b [file] [log] [blame]
Amy Griffis2d9048e2006-06-01 13:10:59 -07001/*
2 * fs/inotify_user.c - inotify support for userspace
3 *
4 * Authors:
5 * John McCutchan <ttb@tentacle.dhs.org>
6 * Robert Love <rml@novell.com>
7 *
8 * Copyright (C) 2005 John McCutchan
9 * Copyright 2006 Hewlett-Packard Development Company, L.P.
10 *
Eric Paris63c882a2009-05-21 17:02:01 -040011 * Copyright (C) 2009 Eric Paris <Red Hat Inc>
12 * inotify was largely rewriten to make use of the fsnotify infrastructure
13 *
Amy Griffis2d9048e2006-06-01 13:10:59 -070014 * This program is free software; you can redistribute it and/or modify it
15 * under the terms of the GNU General Public License as published by the
16 * Free Software Foundation; either version 2, or (at your option) any
17 * later version.
18 *
19 * This program is distributed in the hope that it will be useful, but
20 * WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 * General Public License for more details.
23 */
24
Amy Griffis2d9048e2006-06-01 13:10:59 -070025#include <linux/file.h>
Eric Paris63c882a2009-05-21 17:02:01 -040026#include <linux/fs.h> /* struct inode */
27#include <linux/fsnotify_backend.h>
28#include <linux/idr.h>
29#include <linux/init.h> /* module_init */
Amy Griffis2d9048e2006-06-01 13:10:59 -070030#include <linux/inotify.h>
Eric Paris63c882a2009-05-21 17:02:01 -040031#include <linux/kernel.h> /* roundup() */
Eric Paris63c882a2009-05-21 17:02:01 -040032#include <linux/namei.h> /* LOOKUP_FOLLOW */
Eric Paris63c882a2009-05-21 17:02:01 -040033#include <linux/sched.h> /* struct user */
34#include <linux/slab.h> /* struct kmem_cache */
Amy Griffis2d9048e2006-06-01 13:10:59 -070035#include <linux/syscalls.h>
Eric Paris63c882a2009-05-21 17:02:01 -040036#include <linux/types.h>
Al Viroc44dcc52010-02-11 02:24:46 -050037#include <linux/anon_inodes.h>
Eric Paris63c882a2009-05-21 17:02:01 -040038#include <linux/uaccess.h>
39#include <linux/poll.h>
40#include <linux/wait.h>
41
42#include "inotify.h"
Amy Griffis2d9048e2006-06-01 13:10:59 -070043
44#include <asm/ioctls.h>
45
Amy Griffis2d9048e2006-06-01 13:10:59 -070046/* these are configurable via /proc/sys/fs/inotify/ */
Harvey Harrison3c828e42008-02-14 19:31:21 -080047static int inotify_max_user_instances __read_mostly;
Harvey Harrison3c828e42008-02-14 19:31:21 -080048static int inotify_max_queued_events __read_mostly;
Eric Paris63c882a2009-05-21 17:02:01 -040049int inotify_max_user_watches __read_mostly;
50
51static struct kmem_cache *inotify_inode_mark_cachep __read_mostly;
52struct kmem_cache *event_priv_cachep __read_mostly;
Amy Griffis2d9048e2006-06-01 13:10:59 -070053
54/*
Eric Paris63c882a2009-05-21 17:02:01 -040055 * When inotify registers a new group it increments this and uses that
56 * value as an offset to set the fsnotify group "name" and priority.
Amy Griffis2d9048e2006-06-01 13:10:59 -070057 */
Eric Paris63c882a2009-05-21 17:02:01 -040058static atomic_t inotify_grp_num;
Amy Griffis2d9048e2006-06-01 13:10:59 -070059
60#ifdef CONFIG_SYSCTL
61
62#include <linux/sysctl.h>
63
64static int zero;
65
66ctl_table inotify_table[] = {
67 {
Amy Griffis2d9048e2006-06-01 13:10:59 -070068 .procname = "max_user_instances",
69 .data = &inotify_max_user_instances,
70 .maxlen = sizeof(int),
71 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -080072 .proc_handler = proc_dointvec_minmax,
Amy Griffis2d9048e2006-06-01 13:10:59 -070073 .extra1 = &zero,
74 },
75 {
Amy Griffis2d9048e2006-06-01 13:10:59 -070076 .procname = "max_user_watches",
77 .data = &inotify_max_user_watches,
78 .maxlen = sizeof(int),
79 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -080080 .proc_handler = proc_dointvec_minmax,
Amy Griffis2d9048e2006-06-01 13:10:59 -070081 .extra1 = &zero,
82 },
83 {
Amy Griffis2d9048e2006-06-01 13:10:59 -070084 .procname = "max_queued_events",
85 .data = &inotify_max_queued_events,
86 .maxlen = sizeof(int),
87 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -080088 .proc_handler = proc_dointvec_minmax,
Amy Griffis2d9048e2006-06-01 13:10:59 -070089 .extra1 = &zero
90 },
Eric W. Biedermanab092032009-11-05 14:25:10 -080091 { }
Amy Griffis2d9048e2006-06-01 13:10:59 -070092};
93#endif /* CONFIG_SYSCTL */
94
Eric Paris63c882a2009-05-21 17:02:01 -040095static inline __u32 inotify_arg_to_mask(u32 arg)
Amy Griffis2d9048e2006-06-01 13:10:59 -070096{
Eric Paris63c882a2009-05-21 17:02:01 -040097 __u32 mask;
98
99 /* everything should accept their own ignored and cares about children */
100 mask = (FS_IN_IGNORED | FS_EVENT_ON_CHILD);
101
102 /* mask off the flags used to open the fd */
103 mask |= (arg & (IN_ALL_EVENTS | IN_ONESHOT));
104
105 return mask;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700106}
107
Eric Paris63c882a2009-05-21 17:02:01 -0400108static inline u32 inotify_mask_to_arg(__u32 mask)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700109{
Eric Paris63c882a2009-05-21 17:02:01 -0400110 return mask & (IN_ALL_EVENTS | IN_ISDIR | IN_UNMOUNT | IN_IGNORED |
111 IN_Q_OVERFLOW);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700112}
113
Eric Paris63c882a2009-05-21 17:02:01 -0400114/* intofiy userspace file descriptor functions */
Amy Griffis2d9048e2006-06-01 13:10:59 -0700115static unsigned int inotify_poll(struct file *file, poll_table *wait)
116{
Eric Paris63c882a2009-05-21 17:02:01 -0400117 struct fsnotify_group *group = file->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700118 int ret = 0;
119
Eric Paris63c882a2009-05-21 17:02:01 -0400120 poll_wait(file, &group->notification_waitq, wait);
121 mutex_lock(&group->notification_mutex);
122 if (!fsnotify_notify_queue_is_empty(group))
Amy Griffis2d9048e2006-06-01 13:10:59 -0700123 ret = POLLIN | POLLRDNORM;
Eric Paris63c882a2009-05-21 17:02:01 -0400124 mutex_unlock(&group->notification_mutex);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700125
126 return ret;
127}
128
Vegard Nossum3632dee2009-01-22 15:29:45 +0100129/*
130 * Get an inotify_kernel_event if one exists and is small
131 * enough to fit in "count". Return an error pointer if
132 * not large enough.
133 *
Eric Paris63c882a2009-05-21 17:02:01 -0400134 * Called with the group->notification_mutex held.
Vegard Nossum3632dee2009-01-22 15:29:45 +0100135 */
Eric Paris63c882a2009-05-21 17:02:01 -0400136static struct fsnotify_event *get_one_event(struct fsnotify_group *group,
137 size_t count)
Vegard Nossum3632dee2009-01-22 15:29:45 +0100138{
139 size_t event_size = sizeof(struct inotify_event);
Eric Paris63c882a2009-05-21 17:02:01 -0400140 struct fsnotify_event *event;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100141
Eric Paris63c882a2009-05-21 17:02:01 -0400142 if (fsnotify_notify_queue_is_empty(group))
Vegard Nossum3632dee2009-01-22 15:29:45 +0100143 return NULL;
144
Eric Paris63c882a2009-05-21 17:02:01 -0400145 event = fsnotify_peek_notify_event(group);
146
Eric Paris83cb10f2009-08-28 11:57:55 -0400147 if (event->name_len)
148 event_size += roundup(event->name_len + 1, event_size);
Vegard Nossum3632dee2009-01-22 15:29:45 +0100149
150 if (event_size > count)
151 return ERR_PTR(-EINVAL);
152
Eric Paris63c882a2009-05-21 17:02:01 -0400153 /* held the notification_mutex the whole time, so this is the
154 * same event we peeked above */
155 fsnotify_remove_notify_event(group);
156
157 return event;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100158}
159
160/*
161 * Copy an event to user space, returning how much we copied.
162 *
163 * We already checked that the event size is smaller than the
164 * buffer we had in "get_one_event()" above.
165 */
Eric Paris63c882a2009-05-21 17:02:01 -0400166static ssize_t copy_event_to_user(struct fsnotify_group *group,
167 struct fsnotify_event *event,
Vegard Nossum3632dee2009-01-22 15:29:45 +0100168 char __user *buf)
169{
Eric Paris63c882a2009-05-21 17:02:01 -0400170 struct inotify_event inotify_event;
171 struct fsnotify_event_private_data *fsn_priv;
172 struct inotify_event_private_data *priv;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100173 size_t event_size = sizeof(struct inotify_event);
Brian Rogersb962e732009-08-28 10:00:05 -0400174 size_t name_len = 0;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100175
Eric Paris63c882a2009-05-21 17:02:01 -0400176 /* we get the inotify watch descriptor from the event private data */
177 spin_lock(&event->lock);
178 fsn_priv = fsnotify_remove_priv_from_event(group, event);
179 spin_unlock(&event->lock);
180
181 if (!fsn_priv)
182 inotify_event.wd = -1;
183 else {
184 priv = container_of(fsn_priv, struct inotify_event_private_data,
185 fsnotify_event_priv_data);
186 inotify_event.wd = priv->wd;
187 inotify_free_event_priv(fsn_priv);
188 }
189
Brian Rogersb962e732009-08-28 10:00:05 -0400190 /*
191 * round up event->name_len so it is a multiple of event_size
Eric W. Biederman0db501b2009-08-27 03:20:04 -0700192 * plus an extra byte for the terminating '\0'.
193 */
Brian Rogersb962e732009-08-28 10:00:05 -0400194 if (event->name_len)
195 name_len = roundup(event->name_len + 1, event_size);
Eric Paris63c882a2009-05-21 17:02:01 -0400196 inotify_event.len = name_len;
197
198 inotify_event.mask = inotify_mask_to_arg(event->mask);
199 inotify_event.cookie = event->sync_cookie;
200
201 /* send the main event */
202 if (copy_to_user(buf, &inotify_event, event_size))
Vegard Nossum3632dee2009-01-22 15:29:45 +0100203 return -EFAULT;
204
Eric Paris63c882a2009-05-21 17:02:01 -0400205 buf += event_size;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100206
Eric Paris63c882a2009-05-21 17:02:01 -0400207 /*
208 * fsnotify only stores the pathname, so here we have to send the pathname
209 * and then pad that pathname out to a multiple of sizeof(inotify_event)
210 * with zeros. I get my zeros from the nul_inotify_event.
211 */
212 if (name_len) {
213 unsigned int len_to_zero = name_len - event->name_len;
214 /* copy the path name */
215 if (copy_to_user(buf, event->file_name, event->name_len))
Vegard Nossum3632dee2009-01-22 15:29:45 +0100216 return -EFAULT;
Eric Paris63c882a2009-05-21 17:02:01 -0400217 buf += event->name_len;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100218
Eric W. Biederman0db501b2009-08-27 03:20:04 -0700219 /* fill userspace with 0's */
220 if (clear_user(buf, len_to_zero))
Eric Paris63c882a2009-05-21 17:02:01 -0400221 return -EFAULT;
222 buf += len_to_zero;
223 event_size += name_len;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100224 }
Eric Paris63c882a2009-05-21 17:02:01 -0400225
Vegard Nossum3632dee2009-01-22 15:29:45 +0100226 return event_size;
227}
228
Amy Griffis2d9048e2006-06-01 13:10:59 -0700229static ssize_t inotify_read(struct file *file, char __user *buf,
230 size_t count, loff_t *pos)
231{
Eric Paris63c882a2009-05-21 17:02:01 -0400232 struct fsnotify_group *group;
233 struct fsnotify_event *kevent;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700234 char __user *start;
235 int ret;
236 DEFINE_WAIT(wait);
237
238 start = buf;
Eric Paris63c882a2009-05-21 17:02:01 -0400239 group = file->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700240
241 while (1) {
Eric Paris63c882a2009-05-21 17:02:01 -0400242 prepare_to_wait(&group->notification_waitq, &wait, TASK_INTERRUPTIBLE);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700243
Eric Paris63c882a2009-05-21 17:02:01 -0400244 mutex_lock(&group->notification_mutex);
245 kevent = get_one_event(group, count);
246 mutex_unlock(&group->notification_mutex);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700247
Vegard Nossum3632dee2009-01-22 15:29:45 +0100248 if (kevent) {
249 ret = PTR_ERR(kevent);
250 if (IS_ERR(kevent))
251 break;
Eric Paris63c882a2009-05-21 17:02:01 -0400252 ret = copy_event_to_user(group, kevent, buf);
253 fsnotify_put_event(kevent);
Vegard Nossum3632dee2009-01-22 15:29:45 +0100254 if (ret < 0)
255 break;
256 buf += ret;
257 count -= ret;
258 continue;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700259 }
260
Vegard Nossum3632dee2009-01-22 15:29:45 +0100261 ret = -EAGAIN;
262 if (file->f_flags & O_NONBLOCK)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700263 break;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100264 ret = -EINTR;
265 if (signal_pending(current))
266 break;
267
268 if (start != buf)
269 break;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700270
271 schedule();
272 }
273
Eric Paris63c882a2009-05-21 17:02:01 -0400274 finish_wait(&group->notification_waitq, &wait);
Vegard Nossum3632dee2009-01-22 15:29:45 +0100275 if (start != buf && ret != -EFAULT)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700276 ret = buf - start;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700277 return ret;
278}
279
Dmitry Antipovbcfbf842008-02-06 01:36:19 -0800280static int inotify_fasync(int fd, struct file *file, int on)
281{
Eric Paris63c882a2009-05-21 17:02:01 -0400282 struct fsnotify_group *group = file->private_data;
Dmitry Antipovbcfbf842008-02-06 01:36:19 -0800283
Eric Paris63c882a2009-05-21 17:02:01 -0400284 return fasync_helper(fd, file, on, &group->inotify_data.fa) >= 0 ? 0 : -EIO;
Dmitry Antipovbcfbf842008-02-06 01:36:19 -0800285}
286
Amy Griffis2d9048e2006-06-01 13:10:59 -0700287static int inotify_release(struct inode *ignored, struct file *file)
288{
Eric Paris63c882a2009-05-21 17:02:01 -0400289 struct fsnotify_group *group = file->private_data;
Keith Packardbdae9972009-07-01 21:56:38 -0700290 struct user_struct *user = group->inotify_data.user;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700291
Eric Paris63c882a2009-05-21 17:02:01 -0400292 fsnotify_clear_marks_by_group(group);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700293
Eric Paris63c882a2009-05-21 17:02:01 -0400294 /* free this group, matching get was inotify_init->fsnotify_obtain_group */
295 fsnotify_put_group(group);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700296
Keith Packardbdae9972009-07-01 21:56:38 -0700297 atomic_dec(&user->inotify_devs);
298
Amy Griffis2d9048e2006-06-01 13:10:59 -0700299 return 0;
300}
301
302static long inotify_ioctl(struct file *file, unsigned int cmd,
303 unsigned long arg)
304{
Eric Paris63c882a2009-05-21 17:02:01 -0400305 struct fsnotify_group *group;
306 struct fsnotify_event_holder *holder;
307 struct fsnotify_event *event;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700308 void __user *p;
309 int ret = -ENOTTY;
Eric Paris63c882a2009-05-21 17:02:01 -0400310 size_t send_len = 0;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700311
Eric Paris63c882a2009-05-21 17:02:01 -0400312 group = file->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700313 p = (void __user *) arg;
314
315 switch (cmd) {
316 case FIONREAD:
Eric Paris63c882a2009-05-21 17:02:01 -0400317 mutex_lock(&group->notification_mutex);
318 list_for_each_entry(holder, &group->notification_list, event_list) {
319 event = holder->event;
320 send_len += sizeof(struct inotify_event);
Eric Paris83cb10f2009-08-28 11:57:55 -0400321 if (event->name_len)
322 send_len += roundup(event->name_len + 1,
323 sizeof(struct inotify_event));
Eric Paris63c882a2009-05-21 17:02:01 -0400324 }
325 mutex_unlock(&group->notification_mutex);
326 ret = put_user(send_len, (int __user *) p);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700327 break;
328 }
329
330 return ret;
331}
332
333static const struct file_operations inotify_fops = {
Eric Paris63c882a2009-05-21 17:02:01 -0400334 .poll = inotify_poll,
335 .read = inotify_read,
336 .fasync = inotify_fasync,
337 .release = inotify_release,
338 .unlocked_ioctl = inotify_ioctl,
Amy Griffis2d9048e2006-06-01 13:10:59 -0700339 .compat_ioctl = inotify_ioctl,
340};
341
Amy Griffis2d9048e2006-06-01 13:10:59 -0700342
Eric Paris63c882a2009-05-21 17:02:01 -0400343/*
344 * find_inode - resolve a user-given path to a specific inode
345 */
346static int inotify_find_inode(const char __user *dirname, struct path *path, unsigned flags)
347{
348 int error;
349
350 error = user_path_at(AT_FDCWD, dirname, flags, path);
351 if (error)
352 return error;
353 /* you can only watch an inode if you have read permissions on it */
354 error = inode_permission(path->dentry->d_inode, MAY_READ);
355 if (error)
356 path_put(path);
357 return error;
358}
359
Eric Parisb7ba8372009-12-17 20:12:04 -0500360static int inotify_add_to_idr(struct idr *idr, spinlock_t *idr_lock,
361 int last_wd,
362 struct inotify_inode_mark_entry *ientry)
363{
364 int ret;
365
366 do {
367 if (unlikely(!idr_pre_get(idr, GFP_KERNEL)))
368 return -ENOMEM;
369
370 spin_lock(idr_lock);
371 ret = idr_get_new_above(idr, ientry, last_wd + 1,
372 &ientry->wd);
373 /* we added the mark to the idr, take a reference */
374 if (!ret)
375 fsnotify_get_mark(&ientry->fsn_entry);
376 spin_unlock(idr_lock);
377 } while (ret == -EAGAIN);
378
379 return ret;
380}
381
382static struct inotify_inode_mark_entry *inotify_idr_find_locked(struct fsnotify_group *group,
383 int wd)
384{
385 struct idr *idr = &group->inotify_data.idr;
386 spinlock_t *idr_lock = &group->inotify_data.idr_lock;
387 struct inotify_inode_mark_entry *ientry;
388
389 assert_spin_locked(idr_lock);
390
391 ientry = idr_find(idr, wd);
392 if (ientry) {
393 struct fsnotify_mark_entry *fsn_entry = &ientry->fsn_entry;
394
395 fsnotify_get_mark(fsn_entry);
396 /* One ref for being in the idr, one ref we just took */
397 BUG_ON(atomic_read(&fsn_entry->refcnt) < 2);
398 }
399
400 return ientry;
401}
402
403static struct inotify_inode_mark_entry *inotify_idr_find(struct fsnotify_group *group,
404 int wd)
405{
406 struct inotify_inode_mark_entry *ientry;
407 spinlock_t *idr_lock = &group->inotify_data.idr_lock;
408
409 spin_lock(idr_lock);
410 ientry = inotify_idr_find_locked(group, wd);
411 spin_unlock(idr_lock);
412
413 return ientry;
414}
415
416static void do_inotify_remove_from_idr(struct fsnotify_group *group,
417 struct inotify_inode_mark_entry *ientry)
418{
419 struct idr *idr = &group->inotify_data.idr;
420 spinlock_t *idr_lock = &group->inotify_data.idr_lock;
421 int wd = ientry->wd;
422
423 assert_spin_locked(idr_lock);
424
425 idr_remove(idr, wd);
426
427 /* removed from the idr, drop that ref */
428 fsnotify_put_mark(&ientry->fsn_entry);
429}
430
Eric Parisdead5372009-08-24 16:03:35 -0400431/*
432 * Remove the mark from the idr (if present) and drop the reference
433 * on the mark because it was in the idr.
434 */
Eric Paris7e790dd2009-07-07 10:28:24 -0400435static void inotify_remove_from_idr(struct fsnotify_group *group,
436 struct inotify_inode_mark_entry *ientry)
437{
Eric Parisb7ba8372009-12-17 20:12:04 -0500438 spinlock_t *idr_lock = &group->inotify_data.idr_lock;
439 struct inotify_inode_mark_entry *found_ientry = NULL;
Eric Parisdead5372009-08-24 16:03:35 -0400440 int wd;
Eric Paris7e790dd2009-07-07 10:28:24 -0400441
Eric Parisb7ba8372009-12-17 20:12:04 -0500442 spin_lock(idr_lock);
Eric Parisdead5372009-08-24 16:03:35 -0400443 wd = ientry->wd;
444
Eric Parisb7ba8372009-12-17 20:12:04 -0500445 /*
446 * does this ientry think it is in the idr? we shouldn't get called
447 * if it wasn't....
448 */
449 if (wd == -1) {
450 printk(KERN_WARNING "%s: ientry=%p ientry->wd=%d ientry->group=%p"
451 " ientry->inode=%p\n", __func__, ientry, ientry->wd,
452 ientry->fsn_entry.group, ientry->fsn_entry.inode);
Eric Parisdead5372009-08-24 16:03:35 -0400453 WARN_ON(1);
Eric Parisdead5372009-08-24 16:03:35 -0400454 goto out;
455 }
456
Eric Parisb7ba8372009-12-17 20:12:04 -0500457 /* Lets look in the idr to see if we find it */
458 found_ientry = inotify_idr_find_locked(group, wd);
459 if (unlikely(!found_ientry)) {
460 printk(KERN_WARNING "%s: ientry=%p ientry->wd=%d ientry->group=%p"
461 " ientry->inode=%p\n", __func__, ientry, ientry->wd,
462 ientry->fsn_entry.group, ientry->fsn_entry.inode);
463 WARN_ON(1);
464 goto out;
465 }
Eric Parisdead5372009-08-24 16:03:35 -0400466
Eric Parisb7ba8372009-12-17 20:12:04 -0500467 /*
468 * We found an entry in the idr at the right wd, but it's
469 * not the entry we were told to remove. eparis seriously
470 * fucked up somewhere.
471 */
472 if (unlikely(found_ientry != ientry)) {
473 WARN_ON(1);
474 printk(KERN_WARNING "%s: ientry=%p ientry->wd=%d ientry->group=%p "
475 "entry->inode=%p found_ientry=%p found_ientry->wd=%d "
476 "found_ientry->group=%p found_ientry->inode=%p\n",
477 __func__, ientry, ientry->wd, ientry->fsn_entry.group,
478 ientry->fsn_entry.inode, found_ientry, found_ientry->wd,
479 found_ientry->fsn_entry.group,
480 found_ientry->fsn_entry.inode);
481 goto out;
482 }
Eric Parisdead5372009-08-24 16:03:35 -0400483
Eric Parisb7ba8372009-12-17 20:12:04 -0500484 /*
485 * One ref for being in the idr
486 * one ref held by the caller trying to kill us
487 * one ref grabbed by inotify_idr_find
488 */
489 if (unlikely(atomic_read(&ientry->fsn_entry.refcnt) < 3)) {
490 printk(KERN_WARNING "%s: ientry=%p ientry->wd=%d ientry->group=%p"
491 " ientry->inode=%p\n", __func__, ientry, ientry->wd,
492 ientry->fsn_entry.group, ientry->fsn_entry.inode);
493 /* we can't really recover with bad ref cnting.. */
494 BUG();
495 }
496
497 do_inotify_remove_from_idr(group, ientry);
Eric Parisdead5372009-08-24 16:03:35 -0400498out:
Eric Parisb7ba8372009-12-17 20:12:04 -0500499 /* match the ref taken by inotify_idr_find_locked() */
500 if (found_ientry)
501 fsnotify_put_mark(&found_ientry->fsn_entry);
502 ientry->wd = -1;
503 spin_unlock(idr_lock);
Eric Paris7e790dd2009-07-07 10:28:24 -0400504}
Eric Parisdead5372009-08-24 16:03:35 -0400505
Eric Paris63c882a2009-05-21 17:02:01 -0400506/*
Eric Parisdead5372009-08-24 16:03:35 -0400507 * Send IN_IGNORED for this wd, remove this wd from the idr.
Eric Paris63c882a2009-05-21 17:02:01 -0400508 */
Eric Paris528da3e2009-06-12 16:04:26 -0400509void inotify_ignored_and_remove_idr(struct fsnotify_mark_entry *entry,
510 struct fsnotify_group *group)
Eric Paris63c882a2009-05-21 17:02:01 -0400511{
512 struct inotify_inode_mark_entry *ientry;
Eric Parisf44aebc2009-07-15 15:49:52 -0400513 struct fsnotify_event *ignored_event;
Eric Paris63c882a2009-05-21 17:02:01 -0400514 struct inotify_event_private_data *event_priv;
515 struct fsnotify_event_private_data *fsn_event_priv;
Eric Pariseef3a112009-08-16 21:51:44 -0400516 int ret;
Eric Paris63c882a2009-05-21 17:02:01 -0400517
Eric Parisf44aebc2009-07-15 15:49:52 -0400518 ignored_event = fsnotify_create_event(NULL, FS_IN_IGNORED, NULL,
519 FSNOTIFY_EVENT_NONE, NULL, 0,
520 GFP_NOFS);
521 if (!ignored_event)
522 return;
523
Eric Paris63c882a2009-05-21 17:02:01 -0400524 ientry = container_of(entry, struct inotify_inode_mark_entry, fsn_entry);
525
Eric Parisf44aebc2009-07-15 15:49:52 -0400526 event_priv = kmem_cache_alloc(event_priv_cachep, GFP_NOFS);
Eric Paris63c882a2009-05-21 17:02:01 -0400527 if (unlikely(!event_priv))
528 goto skip_send_ignore;
529
530 fsn_event_priv = &event_priv->fsnotify_event_priv_data;
531
532 fsn_event_priv->group = group;
533 event_priv->wd = ientry->wd;
534
Eric Pariseef3a112009-08-16 21:51:44 -0400535 ret = fsnotify_add_notify_event(group, ignored_event, fsn_event_priv);
536 if (ret)
Eric Paris63c882a2009-05-21 17:02:01 -0400537 inotify_free_event_priv(fsn_event_priv);
538
539skip_send_ignore:
540
Eric Parisf44aebc2009-07-15 15:49:52 -0400541 /* matches the reference taken when the event was created */
542 fsnotify_put_event(ignored_event);
543
Eric Paris63c882a2009-05-21 17:02:01 -0400544 /* remove this entry from the idr */
Eric Paris7e790dd2009-07-07 10:28:24 -0400545 inotify_remove_from_idr(group, ientry);
Eric Paris63c882a2009-05-21 17:02:01 -0400546
Eric Paris5549f7c2009-07-07 10:28:23 -0400547 atomic_dec(&group->inotify_data.user->inotify_watches);
Eric Paris63c882a2009-05-21 17:02:01 -0400548}
549
550/* ding dong the mark is dead */
551static void inotify_free_mark(struct fsnotify_mark_entry *entry)
552{
553 struct inotify_inode_mark_entry *ientry = (struct inotify_inode_mark_entry *)entry;
554
555 kmem_cache_free(inotify_inode_mark_cachep, ientry);
556}
557
Eric Paris52cef752009-08-24 16:03:35 -0400558static int inotify_update_existing_watch(struct fsnotify_group *group,
559 struct inode *inode,
560 u32 arg)
Eric Paris63c882a2009-05-21 17:02:01 -0400561{
Eric Paris52cef752009-08-24 16:03:35 -0400562 struct fsnotify_mark_entry *entry;
Eric Paris63c882a2009-05-21 17:02:01 -0400563 struct inotify_inode_mark_entry *ientry;
Eric Paris63c882a2009-05-21 17:02:01 -0400564 __u32 old_mask, new_mask;
Eric Paris52cef752009-08-24 16:03:35 -0400565 __u32 mask;
566 int add = (arg & IN_MASK_ADD);
567 int ret;
Eric Paris63c882a2009-05-21 17:02:01 -0400568
569 /* don't allow invalid bits: we don't want flags set */
570 mask = inotify_arg_to_mask(arg);
571 if (unlikely(!mask))
572 return -EINVAL;
573
Eric Paris63c882a2009-05-21 17:02:01 -0400574 spin_lock(&inode->i_lock);
575 entry = fsnotify_find_mark_entry(group, inode);
576 spin_unlock(&inode->i_lock);
Eric Paris52cef752009-08-24 16:03:35 -0400577 if (!entry)
578 return -ENOENT;
Eric Paris63c882a2009-05-21 17:02:01 -0400579
Eric Paris52cef752009-08-24 16:03:35 -0400580 ientry = container_of(entry, struct inotify_inode_mark_entry, fsn_entry);
Eric Paris75fe2b22009-07-07 10:28:23 -0400581
Eric Paris63c882a2009-05-21 17:02:01 -0400582 spin_lock(&entry->lock);
583
584 old_mask = entry->mask;
585 if (add) {
586 entry->mask |= mask;
587 new_mask = entry->mask;
588 } else {
589 entry->mask = mask;
590 new_mask = entry->mask;
591 }
592
593 spin_unlock(&entry->lock);
594
595 if (old_mask != new_mask) {
596 /* more bits in old than in new? */
597 int dropped = (old_mask & ~new_mask);
598 /* more bits in this entry than the inode's mask? */
599 int do_inode = (new_mask & ~inode->i_fsnotify_mask);
600 /* more bits in this entry than the group? */
601 int do_group = (new_mask & ~group->mask);
602
603 /* update the inode with this new entry */
604 if (dropped || do_inode)
605 fsnotify_recalc_inode_mask(inode);
606
607 /* update the group mask with the new mask */
608 if (dropped || do_group)
609 fsnotify_recalc_group_mask(group);
610 }
611
Eric Paris52cef752009-08-24 16:03:35 -0400612 /* return the wd */
613 ret = ientry->wd;
614
615 /* match the get from fsnotify_find_mark_entry() */
Eric Paris75fe2b22009-07-07 10:28:23 -0400616 fsnotify_put_mark(entry);
617
Eric Paris52cef752009-08-24 16:03:35 -0400618 return ret;
619}
620
621static int inotify_new_watch(struct fsnotify_group *group,
622 struct inode *inode,
623 u32 arg)
624{
625 struct inotify_inode_mark_entry *tmp_ientry;
626 __u32 mask;
627 int ret;
Eric Parisb7ba8372009-12-17 20:12:04 -0500628 struct idr *idr = &group->inotify_data.idr;
629 spinlock_t *idr_lock = &group->inotify_data.idr_lock;
Eric Paris52cef752009-08-24 16:03:35 -0400630
631 /* don't allow invalid bits: we don't want flags set */
632 mask = inotify_arg_to_mask(arg);
633 if (unlikely(!mask))
634 return -EINVAL;
635
636 tmp_ientry = kmem_cache_alloc(inotify_inode_mark_cachep, GFP_KERNEL);
637 if (unlikely(!tmp_ientry))
638 return -ENOMEM;
639
640 fsnotify_init_mark(&tmp_ientry->fsn_entry, inotify_free_mark);
641 tmp_ientry->fsn_entry.mask = mask;
642 tmp_ientry->wd = -1;
643
644 ret = -ENOSPC;
645 if (atomic_read(&group->inotify_data.user->inotify_watches) >= inotify_max_user_watches)
646 goto out_err;
Eric Parisb7ba8372009-12-17 20:12:04 -0500647
648 ret = inotify_add_to_idr(idr, idr_lock, group->inotify_data.last_wd,
649 tmp_ientry);
650 if (ret)
Eric Paris52cef752009-08-24 16:03:35 -0400651 goto out_err;
652
Eric Paris52cef752009-08-24 16:03:35 -0400653 /* we are on the idr, now get on the inode */
Eric Paris40554c32009-12-17 20:12:05 -0500654 ret = fsnotify_add_mark(&tmp_ientry->fsn_entry, group, inode, 0);
Eric Paris52cef752009-08-24 16:03:35 -0400655 if (ret) {
656 /* we failed to get on the inode, get off the idr */
657 inotify_remove_from_idr(group, tmp_ientry);
658 goto out_err;
659 }
660
Eric Paris52cef752009-08-24 16:03:35 -0400661 /* update the idr hint, who cares about races, it's just a hint */
662 group->inotify_data.last_wd = tmp_ientry->wd;
663
664 /* increment the number of watches the user has */
665 atomic_inc(&group->inotify_data.user->inotify_watches);
666
667 /* return the watch descriptor for this new entry */
668 ret = tmp_ientry->wd;
669
Eric Paris750a8872009-08-28 12:50:47 -0400670 /* if this mark added a new event update the group mask */
671 if (mask & ~group->mask)
672 fsnotify_recalc_group_mask(group);
673
Eric Paris52cef752009-08-24 16:03:35 -0400674out_err:
Eric Paris3dbc6fb2010-05-11 17:16:23 -0400675 /* match the ref from fsnotify_init_markentry() */
676 fsnotify_put_mark(&tmp_ientry->fsn_entry);
Eric Paris52cef752009-08-24 16:03:35 -0400677
678 return ret;
679}
680
681static int inotify_update_watch(struct fsnotify_group *group, struct inode *inode, u32 arg)
682{
683 int ret = 0;
684
685retry:
686 /* try to update and existing watch with the new arg */
687 ret = inotify_update_existing_watch(group, inode, arg);
688 /* no mark present, try to add a new one */
689 if (ret == -ENOENT)
690 ret = inotify_new_watch(group, inode, arg);
691 /*
692 * inotify_new_watch could race with another thread which did an
693 * inotify_new_watch between the update_existing and the add watch
694 * here, go back and try to update an existing mark again.
695 */
696 if (ret == -EEXIST)
697 goto retry;
698
Eric Paris63c882a2009-05-21 17:02:01 -0400699 return ret;
700}
701
702static struct fsnotify_group *inotify_new_group(struct user_struct *user, unsigned int max_events)
703{
704 struct fsnotify_group *group;
705 unsigned int grp_num;
706
707 /* fsnotify_obtain_group took a reference to group, we put this when we kill the file in the end */
708 grp_num = (INOTIFY_GROUP_NUM - atomic_inc_return(&inotify_grp_num));
709 group = fsnotify_obtain_group(grp_num, 0, &inotify_fsnotify_ops);
710 if (IS_ERR(group))
711 return group;
712
713 group->max_events = max_events;
714
715 spin_lock_init(&group->inotify_data.idr_lock);
716 idr_init(&group->inotify_data.idr);
Eric Paris9e572cc2010-01-15 12:12:24 -0500717 group->inotify_data.last_wd = 0;
Eric Paris63c882a2009-05-21 17:02:01 -0400718 group->inotify_data.user = user;
719 group->inotify_data.fa = NULL;
720
721 return group;
722}
723
724
725/* inotify syscalls */
Heiko Carstens938bb9f2009-01-14 14:14:30 +0100726SYSCALL_DEFINE1(inotify_init1, int, flags)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700727{
Eric Paris63c882a2009-05-21 17:02:01 -0400728 struct fsnotify_group *group;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700729 struct user_struct *user;
Al Viroc44dcc52010-02-11 02:24:46 -0500730 int ret;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700731
Ulrich Dreppere38b36f2008-07-23 21:29:42 -0700732 /* Check the IN_* constants for consistency. */
733 BUILD_BUG_ON(IN_CLOEXEC != O_CLOEXEC);
734 BUILD_BUG_ON(IN_NONBLOCK != O_NONBLOCK);
735
Ulrich Drepper510df2d2008-07-23 21:29:41 -0700736 if (flags & ~(IN_CLOEXEC | IN_NONBLOCK))
Ulrich Drepper40065532008-07-23 21:29:32 -0700737 return -EINVAL;
738
David Howellsda9592e2008-11-14 10:39:05 +1100739 user = get_current_user();
Amy Griffis2d9048e2006-06-01 13:10:59 -0700740 if (unlikely(atomic_read(&user->inotify_devs) >=
741 inotify_max_user_instances)) {
742 ret = -EMFILE;
743 goto out_free_uid;
744 }
745
Eric Paris63c882a2009-05-21 17:02:01 -0400746 /* fsnotify_obtain_group took a reference to group, we put this when we kill the file in the end */
747 group = inotify_new_group(user, inotify_max_queued_events);
748 if (IS_ERR(group)) {
749 ret = PTR_ERR(group);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700750 goto out_free_uid;
751 }
752
Al Viro825f9692009-08-05 18:35:21 +0400753 atomic_inc(&user->inotify_devs);
754
Al Viroc44dcc52010-02-11 02:24:46 -0500755 ret = anon_inode_getfd("inotify", &inotify_fops, group,
756 O_RDONLY | flags);
757 if (ret >= 0)
758 return ret;
Al Viro825f9692009-08-05 18:35:21 +0400759
Al Viro825f9692009-08-05 18:35:21 +0400760 atomic_dec(&user->inotify_devs);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700761out_free_uid:
762 free_uid(user);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700763 return ret;
764}
765
Heiko Carstens938bb9f2009-01-14 14:14:30 +0100766SYSCALL_DEFINE0(inotify_init)
Ulrich Drepper40065532008-07-23 21:29:32 -0700767{
768 return sys_inotify_init1(0);
769}
770
Heiko Carstens2e4d0922009-01-14 14:14:31 +0100771SYSCALL_DEFINE3(inotify_add_watch, int, fd, const char __user *, pathname,
772 u32, mask)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700773{
Eric Paris63c882a2009-05-21 17:02:01 -0400774 struct fsnotify_group *group;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700775 struct inode *inode;
Al Viro2d8f3032008-07-22 09:59:21 -0400776 struct path path;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700777 struct file *filp;
778 int ret, fput_needed;
779 unsigned flags = 0;
780
781 filp = fget_light(fd, &fput_needed);
782 if (unlikely(!filp))
783 return -EBADF;
784
785 /* verify that this is indeed an inotify instance */
786 if (unlikely(filp->f_op != &inotify_fops)) {
787 ret = -EINVAL;
788 goto fput_and_out;
789 }
790
791 if (!(mask & IN_DONT_FOLLOW))
792 flags |= LOOKUP_FOLLOW;
793 if (mask & IN_ONLYDIR)
794 flags |= LOOKUP_DIRECTORY;
795
Eric Paris63c882a2009-05-21 17:02:01 -0400796 ret = inotify_find_inode(pathname, &path, flags);
797 if (ret)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700798 goto fput_and_out;
799
Eric Paris63c882a2009-05-21 17:02:01 -0400800 /* inode held in place by reference to path; group by fget on fd */
Al Viro2d8f3032008-07-22 09:59:21 -0400801 inode = path.dentry->d_inode;
Eric Paris63c882a2009-05-21 17:02:01 -0400802 group = filp->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700803
Eric Paris63c882a2009-05-21 17:02:01 -0400804 /* create/update an inode mark */
805 ret = inotify_update_watch(group, inode, mask);
Al Viro2d8f3032008-07-22 09:59:21 -0400806 path_put(&path);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700807fput_and_out:
808 fput_light(filp, fput_needed);
809 return ret;
810}
811
Heiko Carstens2e4d0922009-01-14 14:14:31 +0100812SYSCALL_DEFINE2(inotify_rm_watch, int, fd, __s32, wd)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700813{
Eric Paris63c882a2009-05-21 17:02:01 -0400814 struct fsnotify_group *group;
Eric Parisb7ba8372009-12-17 20:12:04 -0500815 struct inotify_inode_mark_entry *ientry;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700816 struct file *filp;
Eric Paris63c882a2009-05-21 17:02:01 -0400817 int ret = 0, fput_needed;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700818
819 filp = fget_light(fd, &fput_needed);
820 if (unlikely(!filp))
821 return -EBADF;
822
823 /* verify that this is indeed an inotify instance */
Eric Parisb7ba8372009-12-17 20:12:04 -0500824 ret = -EINVAL;
825 if (unlikely(filp->f_op != &inotify_fops))
Amy Griffis2d9048e2006-06-01 13:10:59 -0700826 goto out;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700827
Eric Paris63c882a2009-05-21 17:02:01 -0400828 group = filp->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700829
Eric Parisb7ba8372009-12-17 20:12:04 -0500830 ret = -EINVAL;
831 ientry = inotify_idr_find(group, wd);
832 if (unlikely(!ientry))
Eric Paris63c882a2009-05-21 17:02:01 -0400833 goto out;
Eric Paris63c882a2009-05-21 17:02:01 -0400834
Eric Parisb7ba8372009-12-17 20:12:04 -0500835 ret = 0;
836
837 fsnotify_destroy_mark_by_entry(&ientry->fsn_entry);
838
839 /* match ref taken by inotify_idr_find */
840 fsnotify_put_mark(&ientry->fsn_entry);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700841
842out:
843 fput_light(filp, fput_needed);
844 return ret;
845}
846
Amy Griffis2d9048e2006-06-01 13:10:59 -0700847/*
848 * inotify_user_setup - Our initialization function. Note that we cannnot return
849 * error because we have compiled-in VFS hooks. So an (unlikely) failure here
850 * must result in panic().
851 */
852static int __init inotify_user_setup(void)
853{
Eric Paris63c882a2009-05-21 17:02:01 -0400854 inotify_inode_mark_cachep = KMEM_CACHE(inotify_inode_mark_entry, SLAB_PANIC);
855 event_priv_cachep = KMEM_CACHE(inotify_event_private_data, SLAB_PANIC);
Eric Paris63c882a2009-05-21 17:02:01 -0400856
Amy Griffis2d9048e2006-06-01 13:10:59 -0700857 inotify_max_queued_events = 16384;
858 inotify_max_user_instances = 128;
859 inotify_max_user_watches = 8192;
860
Amy Griffis2d9048e2006-06-01 13:10:59 -0700861 return 0;
862}
Amy Griffis2d9048e2006-06-01 13:10:59 -0700863module_init(inotify_user_setup);