blob: 5275921ed1ce560b1976ca019be9be0de50f071e [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() */
32#include <linux/magic.h> /* superblock magic number */
33#include <linux/mount.h> /* mntget */
34#include <linux/namei.h> /* LOOKUP_FOLLOW */
35#include <linux/path.h> /* struct path */
36#include <linux/sched.h> /* struct user */
37#include <linux/slab.h> /* struct kmem_cache */
Amy Griffis2d9048e2006-06-01 13:10:59 -070038#include <linux/syscalls.h>
Eric Paris63c882a2009-05-21 17:02:01 -040039#include <linux/types.h>
40#include <linux/uaccess.h>
41#include <linux/poll.h>
42#include <linux/wait.h>
43
44#include "inotify.h"
Amy Griffis2d9048e2006-06-01 13:10:59 -070045
46#include <asm/ioctls.h>
47
Amy Griffis2d9048e2006-06-01 13:10:59 -070048static struct vfsmount *inotify_mnt __read_mostly;
49
50/* these are configurable via /proc/sys/fs/inotify/ */
Harvey Harrison3c828e42008-02-14 19:31:21 -080051static int inotify_max_user_instances __read_mostly;
Harvey Harrison3c828e42008-02-14 19:31:21 -080052static int inotify_max_queued_events __read_mostly;
Eric Paris63c882a2009-05-21 17:02:01 -040053int inotify_max_user_watches __read_mostly;
54
55static struct kmem_cache *inotify_inode_mark_cachep __read_mostly;
56struct kmem_cache *event_priv_cachep __read_mostly;
Amy Griffis2d9048e2006-06-01 13:10:59 -070057
58/*
Eric Paris63c882a2009-05-21 17:02:01 -040059 * When inotify registers a new group it increments this and uses that
60 * value as an offset to set the fsnotify group "name" and priority.
Amy Griffis2d9048e2006-06-01 13:10:59 -070061 */
Eric Paris63c882a2009-05-21 17:02:01 -040062static atomic_t inotify_grp_num;
Amy Griffis2d9048e2006-06-01 13:10:59 -070063
64#ifdef CONFIG_SYSCTL
65
66#include <linux/sysctl.h>
67
68static int zero;
69
70ctl_table inotify_table[] = {
71 {
Amy Griffis2d9048e2006-06-01 13:10:59 -070072 .procname = "max_user_instances",
73 .data = &inotify_max_user_instances,
74 .maxlen = sizeof(int),
75 .mode = 0644,
76 .proc_handler = &proc_dointvec_minmax,
Amy Griffis2d9048e2006-06-01 13:10:59 -070077 .extra1 = &zero,
78 },
79 {
Amy Griffis2d9048e2006-06-01 13:10:59 -070080 .procname = "max_user_watches",
81 .data = &inotify_max_user_watches,
82 .maxlen = sizeof(int),
83 .mode = 0644,
84 .proc_handler = &proc_dointvec_minmax,
Amy Griffis2d9048e2006-06-01 13:10:59 -070085 .extra1 = &zero,
86 },
87 {
Amy Griffis2d9048e2006-06-01 13:10:59 -070088 .procname = "max_queued_events",
89 .data = &inotify_max_queued_events,
90 .maxlen = sizeof(int),
91 .mode = 0644,
92 .proc_handler = &proc_dointvec_minmax,
Amy Griffis2d9048e2006-06-01 13:10:59 -070093 .extra1 = &zero
94 },
Eric W. Biedermanab092032009-11-05 14:25:10 -080095 { }
Amy Griffis2d9048e2006-06-01 13:10:59 -070096};
97#endif /* CONFIG_SYSCTL */
98
Eric Paris63c882a2009-05-21 17:02:01 -040099static inline __u32 inotify_arg_to_mask(u32 arg)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700100{
Eric Paris63c882a2009-05-21 17:02:01 -0400101 __u32 mask;
102
103 /* everything should accept their own ignored and cares about children */
104 mask = (FS_IN_IGNORED | FS_EVENT_ON_CHILD);
105
106 /* mask off the flags used to open the fd */
107 mask |= (arg & (IN_ALL_EVENTS | IN_ONESHOT));
108
109 return mask;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700110}
111
Eric Paris63c882a2009-05-21 17:02:01 -0400112static inline u32 inotify_mask_to_arg(__u32 mask)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700113{
Eric Paris63c882a2009-05-21 17:02:01 -0400114 return mask & (IN_ALL_EVENTS | IN_ISDIR | IN_UNMOUNT | IN_IGNORED |
115 IN_Q_OVERFLOW);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700116}
117
Eric Paris63c882a2009-05-21 17:02:01 -0400118/* intofiy userspace file descriptor functions */
Amy Griffis2d9048e2006-06-01 13:10:59 -0700119static unsigned int inotify_poll(struct file *file, poll_table *wait)
120{
Eric Paris63c882a2009-05-21 17:02:01 -0400121 struct fsnotify_group *group = file->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700122 int ret = 0;
123
Eric Paris63c882a2009-05-21 17:02:01 -0400124 poll_wait(file, &group->notification_waitq, wait);
125 mutex_lock(&group->notification_mutex);
126 if (!fsnotify_notify_queue_is_empty(group))
Amy Griffis2d9048e2006-06-01 13:10:59 -0700127 ret = POLLIN | POLLRDNORM;
Eric Paris63c882a2009-05-21 17:02:01 -0400128 mutex_unlock(&group->notification_mutex);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700129
130 return ret;
131}
132
Vegard Nossum3632dee2009-01-22 15:29:45 +0100133/*
134 * Get an inotify_kernel_event if one exists and is small
135 * enough to fit in "count". Return an error pointer if
136 * not large enough.
137 *
Eric Paris63c882a2009-05-21 17:02:01 -0400138 * Called with the group->notification_mutex held.
Vegard Nossum3632dee2009-01-22 15:29:45 +0100139 */
Eric Paris63c882a2009-05-21 17:02:01 -0400140static struct fsnotify_event *get_one_event(struct fsnotify_group *group,
141 size_t count)
Vegard Nossum3632dee2009-01-22 15:29:45 +0100142{
143 size_t event_size = sizeof(struct inotify_event);
Eric Paris63c882a2009-05-21 17:02:01 -0400144 struct fsnotify_event *event;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100145
Eric Paris63c882a2009-05-21 17:02:01 -0400146 if (fsnotify_notify_queue_is_empty(group))
Vegard Nossum3632dee2009-01-22 15:29:45 +0100147 return NULL;
148
Eric Paris63c882a2009-05-21 17:02:01 -0400149 event = fsnotify_peek_notify_event(group);
150
Eric Paris83cb10f2009-08-28 11:57:55 -0400151 if (event->name_len)
152 event_size += roundup(event->name_len + 1, event_size);
Vegard Nossum3632dee2009-01-22 15:29:45 +0100153
154 if (event_size > count)
155 return ERR_PTR(-EINVAL);
156
Eric Paris63c882a2009-05-21 17:02:01 -0400157 /* held the notification_mutex the whole time, so this is the
158 * same event we peeked above */
159 fsnotify_remove_notify_event(group);
160
161 return event;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100162}
163
164/*
165 * Copy an event to user space, returning how much we copied.
166 *
167 * We already checked that the event size is smaller than the
168 * buffer we had in "get_one_event()" above.
169 */
Eric Paris63c882a2009-05-21 17:02:01 -0400170static ssize_t copy_event_to_user(struct fsnotify_group *group,
171 struct fsnotify_event *event,
Vegard Nossum3632dee2009-01-22 15:29:45 +0100172 char __user *buf)
173{
Eric Paris63c882a2009-05-21 17:02:01 -0400174 struct inotify_event inotify_event;
175 struct fsnotify_event_private_data *fsn_priv;
176 struct inotify_event_private_data *priv;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100177 size_t event_size = sizeof(struct inotify_event);
Brian Rogersb962e732009-08-28 10:00:05 -0400178 size_t name_len = 0;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100179
Eric Paris63c882a2009-05-21 17:02:01 -0400180 /* we get the inotify watch descriptor from the event private data */
181 spin_lock(&event->lock);
182 fsn_priv = fsnotify_remove_priv_from_event(group, event);
183 spin_unlock(&event->lock);
184
185 if (!fsn_priv)
186 inotify_event.wd = -1;
187 else {
188 priv = container_of(fsn_priv, struct inotify_event_private_data,
189 fsnotify_event_priv_data);
190 inotify_event.wd = priv->wd;
191 inotify_free_event_priv(fsn_priv);
192 }
193
Brian Rogersb962e732009-08-28 10:00:05 -0400194 /*
195 * round up event->name_len so it is a multiple of event_size
Eric W. Biederman0db501b2009-08-27 03:20:04 -0700196 * plus an extra byte for the terminating '\0'.
197 */
Brian Rogersb962e732009-08-28 10:00:05 -0400198 if (event->name_len)
199 name_len = roundup(event->name_len + 1, event_size);
Eric Paris63c882a2009-05-21 17:02:01 -0400200 inotify_event.len = name_len;
201
202 inotify_event.mask = inotify_mask_to_arg(event->mask);
203 inotify_event.cookie = event->sync_cookie;
204
205 /* send the main event */
206 if (copy_to_user(buf, &inotify_event, event_size))
Vegard Nossum3632dee2009-01-22 15:29:45 +0100207 return -EFAULT;
208
Eric Paris63c882a2009-05-21 17:02:01 -0400209 buf += event_size;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100210
Eric Paris63c882a2009-05-21 17:02:01 -0400211 /*
212 * fsnotify only stores the pathname, so here we have to send the pathname
213 * and then pad that pathname out to a multiple of sizeof(inotify_event)
214 * with zeros. I get my zeros from the nul_inotify_event.
215 */
216 if (name_len) {
217 unsigned int len_to_zero = name_len - event->name_len;
218 /* copy the path name */
219 if (copy_to_user(buf, event->file_name, event->name_len))
Vegard Nossum3632dee2009-01-22 15:29:45 +0100220 return -EFAULT;
Eric Paris63c882a2009-05-21 17:02:01 -0400221 buf += event->name_len;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100222
Eric W. Biederman0db501b2009-08-27 03:20:04 -0700223 /* fill userspace with 0's */
224 if (clear_user(buf, len_to_zero))
Eric Paris63c882a2009-05-21 17:02:01 -0400225 return -EFAULT;
226 buf += len_to_zero;
227 event_size += name_len;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100228 }
Eric Paris63c882a2009-05-21 17:02:01 -0400229
Vegard Nossum3632dee2009-01-22 15:29:45 +0100230 return event_size;
231}
232
Amy Griffis2d9048e2006-06-01 13:10:59 -0700233static ssize_t inotify_read(struct file *file, char __user *buf,
234 size_t count, loff_t *pos)
235{
Eric Paris63c882a2009-05-21 17:02:01 -0400236 struct fsnotify_group *group;
237 struct fsnotify_event *kevent;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700238 char __user *start;
239 int ret;
240 DEFINE_WAIT(wait);
241
242 start = buf;
Eric Paris63c882a2009-05-21 17:02:01 -0400243 group = file->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700244
245 while (1) {
Eric Paris63c882a2009-05-21 17:02:01 -0400246 prepare_to_wait(&group->notification_waitq, &wait, TASK_INTERRUPTIBLE);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700247
Eric Paris63c882a2009-05-21 17:02:01 -0400248 mutex_lock(&group->notification_mutex);
249 kevent = get_one_event(group, count);
250 mutex_unlock(&group->notification_mutex);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700251
Vegard Nossum3632dee2009-01-22 15:29:45 +0100252 if (kevent) {
253 ret = PTR_ERR(kevent);
254 if (IS_ERR(kevent))
255 break;
Eric Paris63c882a2009-05-21 17:02:01 -0400256 ret = copy_event_to_user(group, kevent, buf);
257 fsnotify_put_event(kevent);
Vegard Nossum3632dee2009-01-22 15:29:45 +0100258 if (ret < 0)
259 break;
260 buf += ret;
261 count -= ret;
262 continue;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700263 }
264
Vegard Nossum3632dee2009-01-22 15:29:45 +0100265 ret = -EAGAIN;
266 if (file->f_flags & O_NONBLOCK)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700267 break;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100268 ret = -EINTR;
269 if (signal_pending(current))
270 break;
271
272 if (start != buf)
273 break;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700274
275 schedule();
276 }
277
Eric Paris63c882a2009-05-21 17:02:01 -0400278 finish_wait(&group->notification_waitq, &wait);
Vegard Nossum3632dee2009-01-22 15:29:45 +0100279 if (start != buf && ret != -EFAULT)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700280 ret = buf - start;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700281 return ret;
282}
283
Dmitry Antipovbcfbf842008-02-06 01:36:19 -0800284static int inotify_fasync(int fd, struct file *file, int on)
285{
Eric Paris63c882a2009-05-21 17:02:01 -0400286 struct fsnotify_group *group = file->private_data;
Dmitry Antipovbcfbf842008-02-06 01:36:19 -0800287
Eric Paris63c882a2009-05-21 17:02:01 -0400288 return fasync_helper(fd, file, on, &group->inotify_data.fa) >= 0 ? 0 : -EIO;
Dmitry Antipovbcfbf842008-02-06 01:36:19 -0800289}
290
Amy Griffis2d9048e2006-06-01 13:10:59 -0700291static int inotify_release(struct inode *ignored, struct file *file)
292{
Eric Paris63c882a2009-05-21 17:02:01 -0400293 struct fsnotify_group *group = file->private_data;
Keith Packardbdae9972009-07-01 21:56:38 -0700294 struct user_struct *user = group->inotify_data.user;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700295
Eric Paris63c882a2009-05-21 17:02:01 -0400296 fsnotify_clear_marks_by_group(group);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700297
Eric Paris63c882a2009-05-21 17:02:01 -0400298 /* free this group, matching get was inotify_init->fsnotify_obtain_group */
299 fsnotify_put_group(group);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700300
Keith Packardbdae9972009-07-01 21:56:38 -0700301 atomic_dec(&user->inotify_devs);
302
Amy Griffis2d9048e2006-06-01 13:10:59 -0700303 return 0;
304}
305
306static long inotify_ioctl(struct file *file, unsigned int cmd,
307 unsigned long arg)
308{
Eric Paris63c882a2009-05-21 17:02:01 -0400309 struct fsnotify_group *group;
310 struct fsnotify_event_holder *holder;
311 struct fsnotify_event *event;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700312 void __user *p;
313 int ret = -ENOTTY;
Eric Paris63c882a2009-05-21 17:02:01 -0400314 size_t send_len = 0;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700315
Eric Paris63c882a2009-05-21 17:02:01 -0400316 group = file->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700317 p = (void __user *) arg;
318
319 switch (cmd) {
320 case FIONREAD:
Eric Paris63c882a2009-05-21 17:02:01 -0400321 mutex_lock(&group->notification_mutex);
322 list_for_each_entry(holder, &group->notification_list, event_list) {
323 event = holder->event;
324 send_len += sizeof(struct inotify_event);
Eric Paris83cb10f2009-08-28 11:57:55 -0400325 if (event->name_len)
326 send_len += roundup(event->name_len + 1,
327 sizeof(struct inotify_event));
Eric Paris63c882a2009-05-21 17:02:01 -0400328 }
329 mutex_unlock(&group->notification_mutex);
330 ret = put_user(send_len, (int __user *) p);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700331 break;
332 }
333
334 return ret;
335}
336
337static const struct file_operations inotify_fops = {
Eric Paris63c882a2009-05-21 17:02:01 -0400338 .poll = inotify_poll,
339 .read = inotify_read,
340 .fasync = inotify_fasync,
341 .release = inotify_release,
342 .unlocked_ioctl = inotify_ioctl,
Amy Griffis2d9048e2006-06-01 13:10:59 -0700343 .compat_ioctl = inotify_ioctl,
344};
345
Amy Griffis2d9048e2006-06-01 13:10:59 -0700346
Eric Paris63c882a2009-05-21 17:02:01 -0400347/*
348 * find_inode - resolve a user-given path to a specific inode
349 */
350static int inotify_find_inode(const char __user *dirname, struct path *path, unsigned flags)
351{
352 int error;
353
354 error = user_path_at(AT_FDCWD, dirname, flags, path);
355 if (error)
356 return error;
357 /* you can only watch an inode if you have read permissions on it */
358 error = inode_permission(path->dentry->d_inode, MAY_READ);
359 if (error)
360 path_put(path);
361 return error;
362}
363
Eric Parisdead5372009-08-24 16:03:35 -0400364/*
365 * Remove the mark from the idr (if present) and drop the reference
366 * on the mark because it was in the idr.
367 */
Eric Paris7e790dd2009-07-07 10:28:24 -0400368static void inotify_remove_from_idr(struct fsnotify_group *group,
369 struct inotify_inode_mark_entry *ientry)
370{
371 struct idr *idr;
Eric Parisdead5372009-08-24 16:03:35 -0400372 struct fsnotify_mark_entry *entry;
373 struct inotify_inode_mark_entry *found_ientry;
374 int wd;
Eric Paris7e790dd2009-07-07 10:28:24 -0400375
376 spin_lock(&group->inotify_data.idr_lock);
377 idr = &group->inotify_data.idr;
Eric Parisdead5372009-08-24 16:03:35 -0400378 wd = ientry->wd;
379
380 if (wd == -1)
381 goto out;
382
383 entry = idr_find(&group->inotify_data.idr, wd);
384 if (unlikely(!entry))
385 goto out;
386
387 found_ientry = container_of(entry, struct inotify_inode_mark_entry, fsn_entry);
388 if (unlikely(found_ientry != ientry)) {
389 /* We found an entry in the idr with the right wd, but it's
390 * not the entry we were told to remove. eparis seriously
391 * fucked up somewhere. */
392 WARN_ON(1);
393 ientry->wd = -1;
394 goto out;
395 }
396
397 /* One ref for being in the idr, one ref held by the caller */
398 BUG_ON(atomic_read(&entry->refcnt) < 2);
399
400 idr_remove(idr, wd);
Eric Paris7e790dd2009-07-07 10:28:24 -0400401 ientry->wd = -1;
Eric Parisdead5372009-08-24 16:03:35 -0400402
403 /* removed from the idr, drop that ref */
404 fsnotify_put_mark(entry);
405out:
406 spin_unlock(&group->inotify_data.idr_lock);
Eric Paris7e790dd2009-07-07 10:28:24 -0400407}
Eric Parisdead5372009-08-24 16:03:35 -0400408
Eric Paris63c882a2009-05-21 17:02:01 -0400409/*
Eric Parisdead5372009-08-24 16:03:35 -0400410 * Send IN_IGNORED for this wd, remove this wd from the idr.
Eric Paris63c882a2009-05-21 17:02:01 -0400411 */
Eric Paris528da3e2009-06-12 16:04:26 -0400412void inotify_ignored_and_remove_idr(struct fsnotify_mark_entry *entry,
413 struct fsnotify_group *group)
Eric Paris63c882a2009-05-21 17:02:01 -0400414{
415 struct inotify_inode_mark_entry *ientry;
Eric Parisf44aebc2009-07-15 15:49:52 -0400416 struct fsnotify_event *ignored_event;
Eric Paris63c882a2009-05-21 17:02:01 -0400417 struct inotify_event_private_data *event_priv;
418 struct fsnotify_event_private_data *fsn_event_priv;
Eric Pariseef3a112009-08-16 21:51:44 -0400419 int ret;
Eric Paris63c882a2009-05-21 17:02:01 -0400420
Eric Parisf44aebc2009-07-15 15:49:52 -0400421 ignored_event = fsnotify_create_event(NULL, FS_IN_IGNORED, NULL,
422 FSNOTIFY_EVENT_NONE, NULL, 0,
423 GFP_NOFS);
424 if (!ignored_event)
425 return;
426
Eric Paris63c882a2009-05-21 17:02:01 -0400427 ientry = container_of(entry, struct inotify_inode_mark_entry, fsn_entry);
428
Eric Parisf44aebc2009-07-15 15:49:52 -0400429 event_priv = kmem_cache_alloc(event_priv_cachep, GFP_NOFS);
Eric Paris63c882a2009-05-21 17:02:01 -0400430 if (unlikely(!event_priv))
431 goto skip_send_ignore;
432
433 fsn_event_priv = &event_priv->fsnotify_event_priv_data;
434
435 fsn_event_priv->group = group;
436 event_priv->wd = ientry->wd;
437
Eric Pariseef3a112009-08-16 21:51:44 -0400438 ret = fsnotify_add_notify_event(group, ignored_event, fsn_event_priv);
439 if (ret)
Eric Paris63c882a2009-05-21 17:02:01 -0400440 inotify_free_event_priv(fsn_event_priv);
441
442skip_send_ignore:
443
Eric Parisf44aebc2009-07-15 15:49:52 -0400444 /* matches the reference taken when the event was created */
445 fsnotify_put_event(ignored_event);
446
Eric Paris63c882a2009-05-21 17:02:01 -0400447 /* remove this entry from the idr */
Eric Paris7e790dd2009-07-07 10:28:24 -0400448 inotify_remove_from_idr(group, ientry);
Eric Paris63c882a2009-05-21 17:02:01 -0400449
Eric Paris5549f7c2009-07-07 10:28:23 -0400450 atomic_dec(&group->inotify_data.user->inotify_watches);
Eric Paris63c882a2009-05-21 17:02:01 -0400451}
452
453/* ding dong the mark is dead */
454static void inotify_free_mark(struct fsnotify_mark_entry *entry)
455{
456 struct inotify_inode_mark_entry *ientry = (struct inotify_inode_mark_entry *)entry;
457
458 kmem_cache_free(inotify_inode_mark_cachep, ientry);
459}
460
Eric Paris52cef752009-08-24 16:03:35 -0400461static int inotify_update_existing_watch(struct fsnotify_group *group,
462 struct inode *inode,
463 u32 arg)
Eric Paris63c882a2009-05-21 17:02:01 -0400464{
Eric Paris52cef752009-08-24 16:03:35 -0400465 struct fsnotify_mark_entry *entry;
Eric Paris63c882a2009-05-21 17:02:01 -0400466 struct inotify_inode_mark_entry *ientry;
Eric Paris63c882a2009-05-21 17:02:01 -0400467 __u32 old_mask, new_mask;
Eric Paris52cef752009-08-24 16:03:35 -0400468 __u32 mask;
469 int add = (arg & IN_MASK_ADD);
470 int ret;
Eric Paris63c882a2009-05-21 17:02:01 -0400471
472 /* don't allow invalid bits: we don't want flags set */
473 mask = inotify_arg_to_mask(arg);
474 if (unlikely(!mask))
475 return -EINVAL;
476
Eric Paris63c882a2009-05-21 17:02:01 -0400477 spin_lock(&inode->i_lock);
478 entry = fsnotify_find_mark_entry(group, inode);
479 spin_unlock(&inode->i_lock);
Eric Paris52cef752009-08-24 16:03:35 -0400480 if (!entry)
481 return -ENOENT;
Eric Paris63c882a2009-05-21 17:02:01 -0400482
Eric Paris52cef752009-08-24 16:03:35 -0400483 ientry = container_of(entry, struct inotify_inode_mark_entry, fsn_entry);
Eric Paris75fe2b22009-07-07 10:28:23 -0400484
Eric Paris63c882a2009-05-21 17:02:01 -0400485 spin_lock(&entry->lock);
486
487 old_mask = entry->mask;
488 if (add) {
489 entry->mask |= mask;
490 new_mask = entry->mask;
491 } else {
492 entry->mask = mask;
493 new_mask = entry->mask;
494 }
495
496 spin_unlock(&entry->lock);
497
498 if (old_mask != new_mask) {
499 /* more bits in old than in new? */
500 int dropped = (old_mask & ~new_mask);
501 /* more bits in this entry than the inode's mask? */
502 int do_inode = (new_mask & ~inode->i_fsnotify_mask);
503 /* more bits in this entry than the group? */
504 int do_group = (new_mask & ~group->mask);
505
506 /* update the inode with this new entry */
507 if (dropped || do_inode)
508 fsnotify_recalc_inode_mask(inode);
509
510 /* update the group mask with the new mask */
511 if (dropped || do_group)
512 fsnotify_recalc_group_mask(group);
513 }
514
Eric Paris52cef752009-08-24 16:03:35 -0400515 /* return the wd */
516 ret = ientry->wd;
517
518 /* match the get from fsnotify_find_mark_entry() */
Eric Paris75fe2b22009-07-07 10:28:23 -0400519 fsnotify_put_mark(entry);
520
Eric Paris52cef752009-08-24 16:03:35 -0400521 return ret;
522}
523
524static int inotify_new_watch(struct fsnotify_group *group,
525 struct inode *inode,
526 u32 arg)
527{
528 struct inotify_inode_mark_entry *tmp_ientry;
529 __u32 mask;
530 int ret;
531
532 /* don't allow invalid bits: we don't want flags set */
533 mask = inotify_arg_to_mask(arg);
534 if (unlikely(!mask))
535 return -EINVAL;
536
537 tmp_ientry = kmem_cache_alloc(inotify_inode_mark_cachep, GFP_KERNEL);
538 if (unlikely(!tmp_ientry))
539 return -ENOMEM;
540
541 fsnotify_init_mark(&tmp_ientry->fsn_entry, inotify_free_mark);
542 tmp_ientry->fsn_entry.mask = mask;
543 tmp_ientry->wd = -1;
544
545 ret = -ENOSPC;
546 if (atomic_read(&group->inotify_data.user->inotify_watches) >= inotify_max_user_watches)
547 goto out_err;
548retry:
549 ret = -ENOMEM;
550 if (unlikely(!idr_pre_get(&group->inotify_data.idr, GFP_KERNEL)))
551 goto out_err;
552
553 spin_lock(&group->inotify_data.idr_lock);
554 ret = idr_get_new_above(&group->inotify_data.idr, &tmp_ientry->fsn_entry,
555 group->inotify_data.last_wd,
556 &tmp_ientry->wd);
557 spin_unlock(&group->inotify_data.idr_lock);
558 if (ret) {
559 /* idr was out of memory allocate and try again */
560 if (ret == -EAGAIN)
561 goto retry;
562 goto out_err;
Eric Paris63c882a2009-05-21 17:02:01 -0400563 }
Eric Paris7e790dd2009-07-07 10:28:24 -0400564
Eric Parisdead5372009-08-24 16:03:35 -0400565 /* we put the mark on the idr, take a reference */
566 fsnotify_get_mark(&tmp_ientry->fsn_entry);
567
Eric Paris52cef752009-08-24 16:03:35 -0400568 /* we are on the idr, now get on the inode */
569 ret = fsnotify_add_mark(&tmp_ientry->fsn_entry, group, inode);
570 if (ret) {
571 /* we failed to get on the inode, get off the idr */
572 inotify_remove_from_idr(group, tmp_ientry);
573 goto out_err;
574 }
575
Eric Paris52cef752009-08-24 16:03:35 -0400576 /* update the idr hint, who cares about races, it's just a hint */
577 group->inotify_data.last_wd = tmp_ientry->wd;
578
579 /* increment the number of watches the user has */
580 atomic_inc(&group->inotify_data.user->inotify_watches);
581
582 /* return the watch descriptor for this new entry */
583 ret = tmp_ientry->wd;
584
585 /* match the ref from fsnotify_init_markentry() */
586 fsnotify_put_mark(&tmp_ientry->fsn_entry);
587
Eric Paris750a8872009-08-28 12:50:47 -0400588 /* if this mark added a new event update the group mask */
589 if (mask & ~group->mask)
590 fsnotify_recalc_group_mask(group);
591
Eric Paris52cef752009-08-24 16:03:35 -0400592out_err:
593 if (ret < 0)
594 kmem_cache_free(inotify_inode_mark_cachep, tmp_ientry);
595
596 return ret;
597}
598
599static int inotify_update_watch(struct fsnotify_group *group, struct inode *inode, u32 arg)
600{
601 int ret = 0;
602
603retry:
604 /* try to update and existing watch with the new arg */
605 ret = inotify_update_existing_watch(group, inode, arg);
606 /* no mark present, try to add a new one */
607 if (ret == -ENOENT)
608 ret = inotify_new_watch(group, inode, arg);
609 /*
610 * inotify_new_watch could race with another thread which did an
611 * inotify_new_watch between the update_existing and the add watch
612 * here, go back and try to update an existing mark again.
613 */
614 if (ret == -EEXIST)
615 goto retry;
616
Eric Paris63c882a2009-05-21 17:02:01 -0400617 return ret;
618}
619
620static struct fsnotify_group *inotify_new_group(struct user_struct *user, unsigned int max_events)
621{
622 struct fsnotify_group *group;
623 unsigned int grp_num;
624
625 /* fsnotify_obtain_group took a reference to group, we put this when we kill the file in the end */
626 grp_num = (INOTIFY_GROUP_NUM - atomic_inc_return(&inotify_grp_num));
627 group = fsnotify_obtain_group(grp_num, 0, &inotify_fsnotify_ops);
628 if (IS_ERR(group))
629 return group;
630
631 group->max_events = max_events;
632
633 spin_lock_init(&group->inotify_data.idr_lock);
634 idr_init(&group->inotify_data.idr);
Eric Paris08e53fc2009-08-16 21:51:55 -0400635 group->inotify_data.last_wd = 1;
Eric Paris63c882a2009-05-21 17:02:01 -0400636 group->inotify_data.user = user;
637 group->inotify_data.fa = NULL;
638
639 return group;
640}
641
642
643/* inotify syscalls */
Heiko Carstens938bb9f2009-01-14 14:14:30 +0100644SYSCALL_DEFINE1(inotify_init1, int, flags)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700645{
Eric Paris63c882a2009-05-21 17:02:01 -0400646 struct fsnotify_group *group;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700647 struct user_struct *user;
648 struct file *filp;
649 int fd, ret;
650
Ulrich Dreppere38b36f2008-07-23 21:29:42 -0700651 /* Check the IN_* constants for consistency. */
652 BUILD_BUG_ON(IN_CLOEXEC != O_CLOEXEC);
653 BUILD_BUG_ON(IN_NONBLOCK != O_NONBLOCK);
654
Ulrich Drepper510df2d2008-07-23 21:29:41 -0700655 if (flags & ~(IN_CLOEXEC | IN_NONBLOCK))
Ulrich Drepper40065532008-07-23 21:29:32 -0700656 return -EINVAL;
657
658 fd = get_unused_fd_flags(flags & O_CLOEXEC);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700659 if (fd < 0)
660 return fd;
661
662 filp = get_empty_filp();
663 if (!filp) {
664 ret = -ENFILE;
665 goto out_put_fd;
666 }
667
David Howellsda9592e2008-11-14 10:39:05 +1100668 user = get_current_user();
Amy Griffis2d9048e2006-06-01 13:10:59 -0700669 if (unlikely(atomic_read(&user->inotify_devs) >=
670 inotify_max_user_instances)) {
671 ret = -EMFILE;
672 goto out_free_uid;
673 }
674
Eric Paris63c882a2009-05-21 17:02:01 -0400675 /* fsnotify_obtain_group took a reference to group, we put this when we kill the file in the end */
676 group = inotify_new_group(user, inotify_max_queued_events);
677 if (IS_ERR(group)) {
678 ret = PTR_ERR(group);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700679 goto out_free_uid;
680 }
681
Amy Griffis2d9048e2006-06-01 13:10:59 -0700682 filp->f_op = &inotify_fops;
Josef "Jeff" Sipek0f7fc9e2006-12-08 02:36:35 -0800683 filp->f_path.mnt = mntget(inotify_mnt);
684 filp->f_path.dentry = dget(inotify_mnt->mnt_root);
685 filp->f_mapping = filp->f_path.dentry->d_inode->i_mapping;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700686 filp->f_mode = FMODE_READ;
Ulrich Drepper510df2d2008-07-23 21:29:41 -0700687 filp->f_flags = O_RDONLY | (flags & O_NONBLOCK);
Eric Paris63c882a2009-05-21 17:02:01 -0400688 filp->private_data = group;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700689
Amy Griffis2d9048e2006-06-01 13:10:59 -0700690 atomic_inc(&user->inotify_devs);
Eric Paris63c882a2009-05-21 17:02:01 -0400691
Amy Griffis2d9048e2006-06-01 13:10:59 -0700692 fd_install(fd, filp);
693
694 return fd;
Eric Paris63c882a2009-05-21 17:02:01 -0400695
Amy Griffis2d9048e2006-06-01 13:10:59 -0700696out_free_uid:
697 free_uid(user);
698 put_filp(filp);
699out_put_fd:
700 put_unused_fd(fd);
701 return ret;
702}
703
Heiko Carstens938bb9f2009-01-14 14:14:30 +0100704SYSCALL_DEFINE0(inotify_init)
Ulrich Drepper40065532008-07-23 21:29:32 -0700705{
706 return sys_inotify_init1(0);
707}
708
Heiko Carstens2e4d0922009-01-14 14:14:31 +0100709SYSCALL_DEFINE3(inotify_add_watch, int, fd, const char __user *, pathname,
710 u32, mask)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700711{
Eric Paris63c882a2009-05-21 17:02:01 -0400712 struct fsnotify_group *group;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700713 struct inode *inode;
Al Viro2d8f3032008-07-22 09:59:21 -0400714 struct path path;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700715 struct file *filp;
716 int ret, fput_needed;
717 unsigned flags = 0;
718
719 filp = fget_light(fd, &fput_needed);
720 if (unlikely(!filp))
721 return -EBADF;
722
723 /* verify that this is indeed an inotify instance */
724 if (unlikely(filp->f_op != &inotify_fops)) {
725 ret = -EINVAL;
726 goto fput_and_out;
727 }
728
729 if (!(mask & IN_DONT_FOLLOW))
730 flags |= LOOKUP_FOLLOW;
731 if (mask & IN_ONLYDIR)
732 flags |= LOOKUP_DIRECTORY;
733
Eric Paris63c882a2009-05-21 17:02:01 -0400734 ret = inotify_find_inode(pathname, &path, flags);
735 if (ret)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700736 goto fput_and_out;
737
Eric Paris63c882a2009-05-21 17:02:01 -0400738 /* inode held in place by reference to path; group by fget on fd */
Al Viro2d8f3032008-07-22 09:59:21 -0400739 inode = path.dentry->d_inode;
Eric Paris63c882a2009-05-21 17:02:01 -0400740 group = filp->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700741
Eric Paris63c882a2009-05-21 17:02:01 -0400742 /* create/update an inode mark */
743 ret = inotify_update_watch(group, inode, mask);
744 if (unlikely(ret))
745 goto path_put_and_out;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700746
Eric Paris63c882a2009-05-21 17:02:01 -0400747path_put_and_out:
Al Viro2d8f3032008-07-22 09:59:21 -0400748 path_put(&path);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700749fput_and_out:
750 fput_light(filp, fput_needed);
751 return ret;
752}
753
Heiko Carstens2e4d0922009-01-14 14:14:31 +0100754SYSCALL_DEFINE2(inotify_rm_watch, int, fd, __s32, wd)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700755{
Eric Paris63c882a2009-05-21 17:02:01 -0400756 struct fsnotify_group *group;
757 struct fsnotify_mark_entry *entry;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700758 struct file *filp;
Eric Paris63c882a2009-05-21 17:02:01 -0400759 int ret = 0, fput_needed;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700760
761 filp = fget_light(fd, &fput_needed);
762 if (unlikely(!filp))
763 return -EBADF;
764
765 /* verify that this is indeed an inotify instance */
766 if (unlikely(filp->f_op != &inotify_fops)) {
767 ret = -EINVAL;
768 goto out;
769 }
770
Eric Paris63c882a2009-05-21 17:02:01 -0400771 group = filp->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700772
Eric Paris63c882a2009-05-21 17:02:01 -0400773 spin_lock(&group->inotify_data.idr_lock);
774 entry = idr_find(&group->inotify_data.idr, wd);
775 if (unlikely(!entry)) {
776 spin_unlock(&group->inotify_data.idr_lock);
777 ret = -EINVAL;
778 goto out;
779 }
780 fsnotify_get_mark(entry);
781 spin_unlock(&group->inotify_data.idr_lock);
782
Eric Paris528da3e2009-06-12 16:04:26 -0400783 fsnotify_destroy_mark_by_entry(entry);
Eric Paris63c882a2009-05-21 17:02:01 -0400784 fsnotify_put_mark(entry);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700785
786out:
787 fput_light(filp, fput_needed);
788 return ret;
789}
790
David Howells454e2392006-06-23 02:02:57 -0700791static int
Amy Griffis2d9048e2006-06-01 13:10:59 -0700792inotify_get_sb(struct file_system_type *fs_type, int flags,
David Howells454e2392006-06-23 02:02:57 -0700793 const char *dev_name, void *data, struct vfsmount *mnt)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700794{
Andrey Mirkinfd5eea42007-10-16 23:30:13 -0700795 return get_sb_pseudo(fs_type, "inotify", NULL,
796 INOTIFYFS_SUPER_MAGIC, mnt);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700797}
798
799static struct file_system_type inotify_fs_type = {
Eric Paris63c882a2009-05-21 17:02:01 -0400800 .name = "inotifyfs",
801 .get_sb = inotify_get_sb,
802 .kill_sb = kill_anon_super,
Amy Griffis2d9048e2006-06-01 13:10:59 -0700803};
804
805/*
806 * inotify_user_setup - Our initialization function. Note that we cannnot return
807 * error because we have compiled-in VFS hooks. So an (unlikely) failure here
808 * must result in panic().
809 */
810static int __init inotify_user_setup(void)
811{
812 int ret;
813
814 ret = register_filesystem(&inotify_fs_type);
815 if (unlikely(ret))
816 panic("inotify: register_filesystem returned %d!\n", ret);
817
818 inotify_mnt = kern_mount(&inotify_fs_type);
819 if (IS_ERR(inotify_mnt))
820 panic("inotify: kern_mount ret %ld!\n", PTR_ERR(inotify_mnt));
821
Eric Paris63c882a2009-05-21 17:02:01 -0400822 inotify_inode_mark_cachep = KMEM_CACHE(inotify_inode_mark_entry, SLAB_PANIC);
823 event_priv_cachep = KMEM_CACHE(inotify_event_private_data, SLAB_PANIC);
Eric Paris63c882a2009-05-21 17:02:01 -0400824
Amy Griffis2d9048e2006-06-01 13:10:59 -0700825 inotify_max_queued_events = 16384;
826 inotify_max_user_instances = 128;
827 inotify_max_user_watches = 8192;
828
Amy Griffis2d9048e2006-06-01 13:10:59 -0700829 return 0;
830}
Amy Griffis2d9048e2006-06-01 13:10:59 -0700831module_init(inotify_user_setup);