blob: 118085c9d2d9e4999ca21bc78c1c9b2ba998ae45 [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
Amy Griffis2d9048e2006-06-01 13:10:59 -070054#ifdef CONFIG_SYSCTL
55
56#include <linux/sysctl.h>
57
58static int zero;
59
60ctl_table inotify_table[] = {
61 {
Amy Griffis2d9048e2006-06-01 13:10:59 -070062 .procname = "max_user_instances",
63 .data = &inotify_max_user_instances,
64 .maxlen = sizeof(int),
65 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -080066 .proc_handler = proc_dointvec_minmax,
Amy Griffis2d9048e2006-06-01 13:10:59 -070067 .extra1 = &zero,
68 },
69 {
Amy Griffis2d9048e2006-06-01 13:10:59 -070070 .procname = "max_user_watches",
71 .data = &inotify_max_user_watches,
72 .maxlen = sizeof(int),
73 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -080074 .proc_handler = proc_dointvec_minmax,
Amy Griffis2d9048e2006-06-01 13:10:59 -070075 .extra1 = &zero,
76 },
77 {
Amy Griffis2d9048e2006-06-01 13:10:59 -070078 .procname = "max_queued_events",
79 .data = &inotify_max_queued_events,
80 .maxlen = sizeof(int),
81 .mode = 0644,
Eric W. Biederman6d456112009-11-16 03:11:48 -080082 .proc_handler = proc_dointvec_minmax,
Amy Griffis2d9048e2006-06-01 13:10:59 -070083 .extra1 = &zero
84 },
Eric W. Biedermanab092032009-11-05 14:25:10 -080085 { }
Amy Griffis2d9048e2006-06-01 13:10:59 -070086};
87#endif /* CONFIG_SYSCTL */
88
Eric Paris63c882a2009-05-21 17:02:01 -040089static inline __u32 inotify_arg_to_mask(u32 arg)
Amy Griffis2d9048e2006-06-01 13:10:59 -070090{
Eric Paris63c882a2009-05-21 17:02:01 -040091 __u32 mask;
92
93 /* everything should accept their own ignored and cares about children */
94 mask = (FS_IN_IGNORED | FS_EVENT_ON_CHILD);
95
96 /* mask off the flags used to open the fd */
97 mask |= (arg & (IN_ALL_EVENTS | IN_ONESHOT));
98
99 return mask;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700100}
101
Eric Paris63c882a2009-05-21 17:02:01 -0400102static inline u32 inotify_mask_to_arg(__u32 mask)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700103{
Eric Paris63c882a2009-05-21 17:02:01 -0400104 return mask & (IN_ALL_EVENTS | IN_ISDIR | IN_UNMOUNT | IN_IGNORED |
105 IN_Q_OVERFLOW);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700106}
107
Eric Paris63c882a2009-05-21 17:02:01 -0400108/* intofiy userspace file descriptor functions */
Amy Griffis2d9048e2006-06-01 13:10:59 -0700109static unsigned int inotify_poll(struct file *file, poll_table *wait)
110{
Eric Paris63c882a2009-05-21 17:02:01 -0400111 struct fsnotify_group *group = file->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700112 int ret = 0;
113
Eric Paris63c882a2009-05-21 17:02:01 -0400114 poll_wait(file, &group->notification_waitq, wait);
115 mutex_lock(&group->notification_mutex);
116 if (!fsnotify_notify_queue_is_empty(group))
Amy Griffis2d9048e2006-06-01 13:10:59 -0700117 ret = POLLIN | POLLRDNORM;
Eric Paris63c882a2009-05-21 17:02:01 -0400118 mutex_unlock(&group->notification_mutex);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700119
120 return ret;
121}
122
Vegard Nossum3632dee2009-01-22 15:29:45 +0100123/*
124 * Get an inotify_kernel_event if one exists and is small
125 * enough to fit in "count". Return an error pointer if
126 * not large enough.
127 *
Eric Paris63c882a2009-05-21 17:02:01 -0400128 * Called with the group->notification_mutex held.
Vegard Nossum3632dee2009-01-22 15:29:45 +0100129 */
Eric Paris63c882a2009-05-21 17:02:01 -0400130static struct fsnotify_event *get_one_event(struct fsnotify_group *group,
131 size_t count)
Vegard Nossum3632dee2009-01-22 15:29:45 +0100132{
133 size_t event_size = sizeof(struct inotify_event);
Eric Paris63c882a2009-05-21 17:02:01 -0400134 struct fsnotify_event *event;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100135
Eric Paris63c882a2009-05-21 17:02:01 -0400136 if (fsnotify_notify_queue_is_empty(group))
Vegard Nossum3632dee2009-01-22 15:29:45 +0100137 return NULL;
138
Eric Paris63c882a2009-05-21 17:02:01 -0400139 event = fsnotify_peek_notify_event(group);
140
Eric Paris83cb10f2009-08-28 11:57:55 -0400141 if (event->name_len)
142 event_size += roundup(event->name_len + 1, event_size);
Vegard Nossum3632dee2009-01-22 15:29:45 +0100143
144 if (event_size > count)
145 return ERR_PTR(-EINVAL);
146
Eric Paris63c882a2009-05-21 17:02:01 -0400147 /* held the notification_mutex the whole time, so this is the
148 * same event we peeked above */
149 fsnotify_remove_notify_event(group);
150
151 return event;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100152}
153
154/*
155 * Copy an event to user space, returning how much we copied.
156 *
157 * We already checked that the event size is smaller than the
158 * buffer we had in "get_one_event()" above.
159 */
Eric Paris63c882a2009-05-21 17:02:01 -0400160static ssize_t copy_event_to_user(struct fsnotify_group *group,
161 struct fsnotify_event *event,
Vegard Nossum3632dee2009-01-22 15:29:45 +0100162 char __user *buf)
163{
Eric Paris63c882a2009-05-21 17:02:01 -0400164 struct inotify_event inotify_event;
165 struct fsnotify_event_private_data *fsn_priv;
166 struct inotify_event_private_data *priv;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100167 size_t event_size = sizeof(struct inotify_event);
Brian Rogersb962e732009-08-28 10:00:05 -0400168 size_t name_len = 0;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100169
Eric Paris63c882a2009-05-21 17:02:01 -0400170 /* we get the inotify watch descriptor from the event private data */
171 spin_lock(&event->lock);
172 fsn_priv = fsnotify_remove_priv_from_event(group, event);
173 spin_unlock(&event->lock);
174
175 if (!fsn_priv)
176 inotify_event.wd = -1;
177 else {
178 priv = container_of(fsn_priv, struct inotify_event_private_data,
179 fsnotify_event_priv_data);
180 inotify_event.wd = priv->wd;
181 inotify_free_event_priv(fsn_priv);
182 }
183
Brian Rogersb962e732009-08-28 10:00:05 -0400184 /*
185 * round up event->name_len so it is a multiple of event_size
Eric W. Biederman0db501b2009-08-27 03:20:04 -0700186 * plus an extra byte for the terminating '\0'.
187 */
Brian Rogersb962e732009-08-28 10:00:05 -0400188 if (event->name_len)
189 name_len = roundup(event->name_len + 1, event_size);
Eric Paris63c882a2009-05-21 17:02:01 -0400190 inotify_event.len = name_len;
191
192 inotify_event.mask = inotify_mask_to_arg(event->mask);
193 inotify_event.cookie = event->sync_cookie;
194
195 /* send the main event */
196 if (copy_to_user(buf, &inotify_event, event_size))
Vegard Nossum3632dee2009-01-22 15:29:45 +0100197 return -EFAULT;
198
Eric Paris63c882a2009-05-21 17:02:01 -0400199 buf += event_size;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100200
Eric Paris63c882a2009-05-21 17:02:01 -0400201 /*
202 * fsnotify only stores the pathname, so here we have to send the pathname
203 * and then pad that pathname out to a multiple of sizeof(inotify_event)
204 * with zeros. I get my zeros from the nul_inotify_event.
205 */
206 if (name_len) {
207 unsigned int len_to_zero = name_len - event->name_len;
208 /* copy the path name */
209 if (copy_to_user(buf, event->file_name, event->name_len))
Vegard Nossum3632dee2009-01-22 15:29:45 +0100210 return -EFAULT;
Eric Paris63c882a2009-05-21 17:02:01 -0400211 buf += event->name_len;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100212
Eric W. Biederman0db501b2009-08-27 03:20:04 -0700213 /* fill userspace with 0's */
214 if (clear_user(buf, len_to_zero))
Eric Paris63c882a2009-05-21 17:02:01 -0400215 return -EFAULT;
216 buf += len_to_zero;
217 event_size += name_len;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100218 }
Eric Paris63c882a2009-05-21 17:02:01 -0400219
Vegard Nossum3632dee2009-01-22 15:29:45 +0100220 return event_size;
221}
222
Amy Griffis2d9048e2006-06-01 13:10:59 -0700223static ssize_t inotify_read(struct file *file, char __user *buf,
224 size_t count, loff_t *pos)
225{
Eric Paris63c882a2009-05-21 17:02:01 -0400226 struct fsnotify_group *group;
227 struct fsnotify_event *kevent;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700228 char __user *start;
229 int ret;
230 DEFINE_WAIT(wait);
231
232 start = buf;
Eric Paris63c882a2009-05-21 17:02:01 -0400233 group = file->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700234
235 while (1) {
Eric Paris63c882a2009-05-21 17:02:01 -0400236 prepare_to_wait(&group->notification_waitq, &wait, TASK_INTERRUPTIBLE);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700237
Eric Paris63c882a2009-05-21 17:02:01 -0400238 mutex_lock(&group->notification_mutex);
239 kevent = get_one_event(group, count);
240 mutex_unlock(&group->notification_mutex);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700241
Vegard Nossum3632dee2009-01-22 15:29:45 +0100242 if (kevent) {
243 ret = PTR_ERR(kevent);
244 if (IS_ERR(kevent))
245 break;
Eric Paris63c882a2009-05-21 17:02:01 -0400246 ret = copy_event_to_user(group, kevent, buf);
247 fsnotify_put_event(kevent);
Vegard Nossum3632dee2009-01-22 15:29:45 +0100248 if (ret < 0)
249 break;
250 buf += ret;
251 count -= ret;
252 continue;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700253 }
254
Vegard Nossum3632dee2009-01-22 15:29:45 +0100255 ret = -EAGAIN;
256 if (file->f_flags & O_NONBLOCK)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700257 break;
Vegard Nossum3632dee2009-01-22 15:29:45 +0100258 ret = -EINTR;
259 if (signal_pending(current))
260 break;
261
262 if (start != buf)
263 break;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700264
265 schedule();
266 }
267
Eric Paris63c882a2009-05-21 17:02:01 -0400268 finish_wait(&group->notification_waitq, &wait);
Vegard Nossum3632dee2009-01-22 15:29:45 +0100269 if (start != buf && ret != -EFAULT)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700270 ret = buf - start;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700271 return ret;
272}
273
Dmitry Antipovbcfbf842008-02-06 01:36:19 -0800274static int inotify_fasync(int fd, struct file *file, int on)
275{
Eric Paris63c882a2009-05-21 17:02:01 -0400276 struct fsnotify_group *group = file->private_data;
Dmitry Antipovbcfbf842008-02-06 01:36:19 -0800277
Eric Paris63c882a2009-05-21 17:02:01 -0400278 return fasync_helper(fd, file, on, &group->inotify_data.fa) >= 0 ? 0 : -EIO;
Dmitry Antipovbcfbf842008-02-06 01:36:19 -0800279}
280
Amy Griffis2d9048e2006-06-01 13:10:59 -0700281static int inotify_release(struct inode *ignored, struct file *file)
282{
Eric Paris63c882a2009-05-21 17:02:01 -0400283 struct fsnotify_group *group = file->private_data;
Keith Packardbdae9972009-07-01 21:56:38 -0700284 struct user_struct *user = group->inotify_data.user;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700285
Eric Paris63c882a2009-05-21 17:02:01 -0400286 fsnotify_clear_marks_by_group(group);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700287
Eric Paris63c882a2009-05-21 17:02:01 -0400288 /* free this group, matching get was inotify_init->fsnotify_obtain_group */
289 fsnotify_put_group(group);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700290
Keith Packardbdae9972009-07-01 21:56:38 -0700291 atomic_dec(&user->inotify_devs);
292
Amy Griffis2d9048e2006-06-01 13:10:59 -0700293 return 0;
294}
295
296static long inotify_ioctl(struct file *file, unsigned int cmd,
297 unsigned long arg)
298{
Eric Paris63c882a2009-05-21 17:02:01 -0400299 struct fsnotify_group *group;
300 struct fsnotify_event_holder *holder;
301 struct fsnotify_event *event;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700302 void __user *p;
303 int ret = -ENOTTY;
Eric Paris63c882a2009-05-21 17:02:01 -0400304 size_t send_len = 0;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700305
Eric Paris63c882a2009-05-21 17:02:01 -0400306 group = file->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700307 p = (void __user *) arg;
308
309 switch (cmd) {
310 case FIONREAD:
Eric Paris63c882a2009-05-21 17:02:01 -0400311 mutex_lock(&group->notification_mutex);
312 list_for_each_entry(holder, &group->notification_list, event_list) {
313 event = holder->event;
314 send_len += sizeof(struct inotify_event);
Eric Paris83cb10f2009-08-28 11:57:55 -0400315 if (event->name_len)
316 send_len += roundup(event->name_len + 1,
317 sizeof(struct inotify_event));
Eric Paris63c882a2009-05-21 17:02:01 -0400318 }
319 mutex_unlock(&group->notification_mutex);
320 ret = put_user(send_len, (int __user *) p);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700321 break;
322 }
323
324 return ret;
325}
326
327static const struct file_operations inotify_fops = {
Eric Paris63c882a2009-05-21 17:02:01 -0400328 .poll = inotify_poll,
329 .read = inotify_read,
330 .fasync = inotify_fasync,
331 .release = inotify_release,
332 .unlocked_ioctl = inotify_ioctl,
Amy Griffis2d9048e2006-06-01 13:10:59 -0700333 .compat_ioctl = inotify_ioctl,
334};
335
Amy Griffis2d9048e2006-06-01 13:10:59 -0700336
Eric Paris63c882a2009-05-21 17:02:01 -0400337/*
338 * find_inode - resolve a user-given path to a specific inode
339 */
340static int inotify_find_inode(const char __user *dirname, struct path *path, unsigned flags)
341{
342 int error;
343
344 error = user_path_at(AT_FDCWD, dirname, flags, path);
345 if (error)
346 return error;
347 /* you can only watch an inode if you have read permissions on it */
348 error = inode_permission(path->dentry->d_inode, MAY_READ);
349 if (error)
350 path_put(path);
351 return error;
352}
353
Eric Parisb7ba8372009-12-17 20:12:04 -0500354static int inotify_add_to_idr(struct idr *idr, spinlock_t *idr_lock,
Eric Paris7050c482009-12-17 20:27:10 -0500355 int *last_wd,
Eric Parisb7ba8372009-12-17 20:12:04 -0500356 struct inotify_inode_mark_entry *ientry)
357{
358 int ret;
359
360 do {
361 if (unlikely(!idr_pre_get(idr, GFP_KERNEL)))
362 return -ENOMEM;
363
364 spin_lock(idr_lock);
Eric Paris7050c482009-12-17 20:27:10 -0500365 ret = idr_get_new_above(idr, ientry, *last_wd + 1,
Eric Parisb7ba8372009-12-17 20:12:04 -0500366 &ientry->wd);
367 /* we added the mark to the idr, take a reference */
Eric Paris7050c482009-12-17 20:27:10 -0500368 if (!ret) {
Eric Parisb7ba8372009-12-17 20:12:04 -0500369 fsnotify_get_mark(&ientry->fsn_entry);
Eric Paris7050c482009-12-17 20:27:10 -0500370 *last_wd = ientry->wd;
371 }
Eric Parisb7ba8372009-12-17 20:12:04 -0500372 spin_unlock(idr_lock);
373 } while (ret == -EAGAIN);
374
375 return ret;
376}
377
378static struct inotify_inode_mark_entry *inotify_idr_find_locked(struct fsnotify_group *group,
379 int wd)
380{
381 struct idr *idr = &group->inotify_data.idr;
382 spinlock_t *idr_lock = &group->inotify_data.idr_lock;
383 struct inotify_inode_mark_entry *ientry;
384
385 assert_spin_locked(idr_lock);
386
387 ientry = idr_find(idr, wd);
388 if (ientry) {
Eric Parise61ce862009-12-17 21:24:24 -0500389 struct fsnotify_mark *fsn_entry = &ientry->fsn_entry;
Eric Parisb7ba8372009-12-17 20:12:04 -0500390
391 fsnotify_get_mark(fsn_entry);
392 /* One ref for being in the idr, one ref we just took */
393 BUG_ON(atomic_read(&fsn_entry->refcnt) < 2);
394 }
395
396 return ientry;
397}
398
399static struct inotify_inode_mark_entry *inotify_idr_find(struct fsnotify_group *group,
400 int wd)
401{
402 struct inotify_inode_mark_entry *ientry;
403 spinlock_t *idr_lock = &group->inotify_data.idr_lock;
404
405 spin_lock(idr_lock);
406 ientry = inotify_idr_find_locked(group, wd);
407 spin_unlock(idr_lock);
408
409 return ientry;
410}
411
412static void do_inotify_remove_from_idr(struct fsnotify_group *group,
413 struct inotify_inode_mark_entry *ientry)
414{
415 struct idr *idr = &group->inotify_data.idr;
416 spinlock_t *idr_lock = &group->inotify_data.idr_lock;
417 int wd = ientry->wd;
418
419 assert_spin_locked(idr_lock);
420
421 idr_remove(idr, wd);
422
423 /* removed from the idr, drop that ref */
424 fsnotify_put_mark(&ientry->fsn_entry);
425}
426
Eric Parisdead5372009-08-24 16:03:35 -0400427/*
428 * Remove the mark from the idr (if present) and drop the reference
429 * on the mark because it was in the idr.
430 */
Eric Paris7e790dd2009-07-07 10:28:24 -0400431static void inotify_remove_from_idr(struct fsnotify_group *group,
432 struct inotify_inode_mark_entry *ientry)
433{
Eric Parisb7ba8372009-12-17 20:12:04 -0500434 spinlock_t *idr_lock = &group->inotify_data.idr_lock;
435 struct inotify_inode_mark_entry *found_ientry = NULL;
Eric Parisdead5372009-08-24 16:03:35 -0400436 int wd;
Eric Paris7e790dd2009-07-07 10:28:24 -0400437
Eric Parisb7ba8372009-12-17 20:12:04 -0500438 spin_lock(idr_lock);
Eric Parisdead5372009-08-24 16:03:35 -0400439 wd = ientry->wd;
440
Eric Parisb7ba8372009-12-17 20:12:04 -0500441 /*
442 * does this ientry think it is in the idr? we shouldn't get called
443 * if it wasn't....
444 */
445 if (wd == -1) {
Eric Parisd7f0ce42009-12-22 23:16:33 -0500446 WARN_ONCE(1, "%s: ientry=%p ientry->wd=%d ientry->group=%p"
Eric Parisb7ba8372009-12-17 20:12:04 -0500447 " ientry->inode=%p\n", __func__, ientry, ientry->wd,
Eric Paris2823e042009-12-17 21:24:23 -0500448 ientry->fsn_entry.group, ientry->fsn_entry.i.inode);
Eric Parisdead5372009-08-24 16:03:35 -0400449 goto out;
450 }
451
Eric Parisb7ba8372009-12-17 20:12:04 -0500452 /* Lets look in the idr to see if we find it */
453 found_ientry = inotify_idr_find_locked(group, wd);
454 if (unlikely(!found_ientry)) {
Eric Parisd7f0ce42009-12-22 23:16:33 -0500455 WARN_ONCE(1, "%s: ientry=%p ientry->wd=%d ientry->group=%p"
Eric Parisb7ba8372009-12-17 20:12:04 -0500456 " ientry->inode=%p\n", __func__, ientry, ientry->wd,
Eric Paris2823e042009-12-17 21:24:23 -0500457 ientry->fsn_entry.group, ientry->fsn_entry.i.inode);
Eric Parisb7ba8372009-12-17 20:12:04 -0500458 goto out;
459 }
Eric Parisdead5372009-08-24 16:03:35 -0400460
Eric Parisb7ba8372009-12-17 20:12:04 -0500461 /*
462 * We found an entry in the idr at the right wd, but it's
463 * not the entry we were told to remove. eparis seriously
464 * fucked up somewhere.
465 */
466 if (unlikely(found_ientry != ientry)) {
Eric Parisd7f0ce42009-12-22 23:16:33 -0500467 WARN_ONCE(1, "%s: ientry=%p ientry->wd=%d ientry->group=%p "
Eric Parisb7ba8372009-12-17 20:12:04 -0500468 "entry->inode=%p found_ientry=%p found_ientry->wd=%d "
469 "found_ientry->group=%p found_ientry->inode=%p\n",
470 __func__, ientry, ientry->wd, ientry->fsn_entry.group,
Eric Paris2823e042009-12-17 21:24:23 -0500471 ientry->fsn_entry.i.inode, found_ientry, found_ientry->wd,
Eric Parisb7ba8372009-12-17 20:12:04 -0500472 found_ientry->fsn_entry.group,
Eric Paris2823e042009-12-17 21:24:23 -0500473 found_ientry->fsn_entry.i.inode);
Eric Parisb7ba8372009-12-17 20:12:04 -0500474 goto out;
475 }
Eric Parisdead5372009-08-24 16:03:35 -0400476
Eric Parisb7ba8372009-12-17 20:12:04 -0500477 /*
478 * One ref for being in the idr
479 * one ref held by the caller trying to kill us
480 * one ref grabbed by inotify_idr_find
481 */
482 if (unlikely(atomic_read(&ientry->fsn_entry.refcnt) < 3)) {
Eric Parisd7f0ce42009-12-22 23:16:33 -0500483 printk(KERN_ERR "%s: ientry=%p ientry->wd=%d ientry->group=%p"
Eric Parisb7ba8372009-12-17 20:12:04 -0500484 " ientry->inode=%p\n", __func__, ientry, ientry->wd,
Eric Paris2823e042009-12-17 21:24:23 -0500485 ientry->fsn_entry.group, ientry->fsn_entry.i.inode);
Eric Parisb7ba8372009-12-17 20:12:04 -0500486 /* we can't really recover with bad ref cnting.. */
487 BUG();
488 }
489
490 do_inotify_remove_from_idr(group, ientry);
Eric Parisdead5372009-08-24 16:03:35 -0400491out:
Eric Parisb7ba8372009-12-17 20:12:04 -0500492 /* match the ref taken by inotify_idr_find_locked() */
493 if (found_ientry)
494 fsnotify_put_mark(&found_ientry->fsn_entry);
495 ientry->wd = -1;
496 spin_unlock(idr_lock);
Eric Paris7e790dd2009-07-07 10:28:24 -0400497}
Eric Parisdead5372009-08-24 16:03:35 -0400498
Eric Paris63c882a2009-05-21 17:02:01 -0400499/*
Eric Parisdead5372009-08-24 16:03:35 -0400500 * Send IN_IGNORED for this wd, remove this wd from the idr.
Eric Paris63c882a2009-05-21 17:02:01 -0400501 */
Eric Parise61ce862009-12-17 21:24:24 -0500502void inotify_ignored_and_remove_idr(struct fsnotify_mark *entry,
Eric Paris528da3e2009-06-12 16:04:26 -0400503 struct fsnotify_group *group)
Eric Paris63c882a2009-05-21 17:02:01 -0400504{
505 struct inotify_inode_mark_entry *ientry;
Eric Parisf44aebc2009-07-15 15:49:52 -0400506 struct fsnotify_event *ignored_event;
Eric Paris63c882a2009-05-21 17:02:01 -0400507 struct inotify_event_private_data *event_priv;
508 struct fsnotify_event_private_data *fsn_event_priv;
Eric Pariseef3a112009-08-16 21:51:44 -0400509 int ret;
Eric Paris63c882a2009-05-21 17:02:01 -0400510
Eric Parisf44aebc2009-07-15 15:49:52 -0400511 ignored_event = fsnotify_create_event(NULL, FS_IN_IGNORED, NULL,
512 FSNOTIFY_EVENT_NONE, NULL, 0,
513 GFP_NOFS);
514 if (!ignored_event)
515 return;
516
Eric Paris63c882a2009-05-21 17:02:01 -0400517 ientry = container_of(entry, struct inotify_inode_mark_entry, fsn_entry);
518
Eric Parisf44aebc2009-07-15 15:49:52 -0400519 event_priv = kmem_cache_alloc(event_priv_cachep, GFP_NOFS);
Eric Paris63c882a2009-05-21 17:02:01 -0400520 if (unlikely(!event_priv))
521 goto skip_send_ignore;
522
523 fsn_event_priv = &event_priv->fsnotify_event_priv_data;
524
525 fsn_event_priv->group = group;
526 event_priv->wd = ientry->wd;
527
Eric Paris74766bb2009-12-17 21:24:21 -0500528 ret = fsnotify_add_notify_event(group, ignored_event, fsn_event_priv, NULL);
Eric Pariseef3a112009-08-16 21:51:44 -0400529 if (ret)
Eric Paris63c882a2009-05-21 17:02:01 -0400530 inotify_free_event_priv(fsn_event_priv);
531
532skip_send_ignore:
533
Eric Parisf44aebc2009-07-15 15:49:52 -0400534 /* matches the reference taken when the event was created */
535 fsnotify_put_event(ignored_event);
536
Eric Paris63c882a2009-05-21 17:02:01 -0400537 /* remove this entry from the idr */
Eric Paris7e790dd2009-07-07 10:28:24 -0400538 inotify_remove_from_idr(group, ientry);
Eric Paris63c882a2009-05-21 17:02:01 -0400539
Eric Paris5549f7c2009-07-07 10:28:23 -0400540 atomic_dec(&group->inotify_data.user->inotify_watches);
Eric Paris63c882a2009-05-21 17:02:01 -0400541}
542
543/* ding dong the mark is dead */
Eric Parise61ce862009-12-17 21:24:24 -0500544static void inotify_free_mark(struct fsnotify_mark *entry)
Eric Paris63c882a2009-05-21 17:02:01 -0400545{
Eric Paris31ddd322009-12-17 20:12:06 -0500546 struct inotify_inode_mark_entry *ientry;
547
548 ientry = container_of(entry, struct inotify_inode_mark_entry, fsn_entry);
Eric Paris63c882a2009-05-21 17:02:01 -0400549
550 kmem_cache_free(inotify_inode_mark_cachep, ientry);
551}
552
Eric Paris52cef752009-08-24 16:03:35 -0400553static int inotify_update_existing_watch(struct fsnotify_group *group,
554 struct inode *inode,
555 u32 arg)
Eric Paris63c882a2009-05-21 17:02:01 -0400556{
Eric Parise61ce862009-12-17 21:24:24 -0500557 struct fsnotify_mark *entry;
Eric Paris63c882a2009-05-21 17:02:01 -0400558 struct inotify_inode_mark_entry *ientry;
Eric Paris63c882a2009-05-21 17:02:01 -0400559 __u32 old_mask, new_mask;
Eric Paris52cef752009-08-24 16:03:35 -0400560 __u32 mask;
561 int add = (arg & IN_MASK_ADD);
562 int ret;
Eric Paris63c882a2009-05-21 17:02:01 -0400563
564 /* don't allow invalid bits: we don't want flags set */
565 mask = inotify_arg_to_mask(arg);
566 if (unlikely(!mask))
567 return -EINVAL;
568
Eric Paris63c882a2009-05-21 17:02:01 -0400569 spin_lock(&inode->i_lock);
Eric Parisd0775442009-12-17 21:24:24 -0500570 entry = fsnotify_find_mark(group, inode);
Eric Paris63c882a2009-05-21 17:02:01 -0400571 spin_unlock(&inode->i_lock);
Eric Paris52cef752009-08-24 16:03:35 -0400572 if (!entry)
573 return -ENOENT;
Eric Paris63c882a2009-05-21 17:02:01 -0400574
Eric Paris52cef752009-08-24 16:03:35 -0400575 ientry = container_of(entry, struct inotify_inode_mark_entry, fsn_entry);
Eric Paris75fe2b22009-07-07 10:28:23 -0400576
Eric Paris63c882a2009-05-21 17:02:01 -0400577 spin_lock(&entry->lock);
578
579 old_mask = entry->mask;
580 if (add) {
581 entry->mask |= mask;
582 new_mask = entry->mask;
583 } else {
584 entry->mask = mask;
585 new_mask = entry->mask;
586 }
587
588 spin_unlock(&entry->lock);
589
590 if (old_mask != new_mask) {
591 /* more bits in old than in new? */
592 int dropped = (old_mask & ~new_mask);
593 /* more bits in this entry than the inode's mask? */
594 int do_inode = (new_mask & ~inode->i_fsnotify_mask);
595 /* more bits in this entry than the group? */
596 int do_group = (new_mask & ~group->mask);
597
598 /* update the inode with this new entry */
599 if (dropped || do_inode)
600 fsnotify_recalc_inode_mask(inode);
601
602 /* update the group mask with the new mask */
603 if (dropped || do_group)
604 fsnotify_recalc_group_mask(group);
605 }
606
Eric Paris52cef752009-08-24 16:03:35 -0400607 /* return the wd */
608 ret = ientry->wd;
609
Eric Parisd0775442009-12-17 21:24:24 -0500610 /* match the get from fsnotify_find_mark() */
Eric Paris75fe2b22009-07-07 10:28:23 -0400611 fsnotify_put_mark(entry);
612
Eric Paris52cef752009-08-24 16:03:35 -0400613 return ret;
614}
615
616static int inotify_new_watch(struct fsnotify_group *group,
617 struct inode *inode,
618 u32 arg)
619{
620 struct inotify_inode_mark_entry *tmp_ientry;
621 __u32 mask;
622 int ret;
Eric Parisb7ba8372009-12-17 20:12:04 -0500623 struct idr *idr = &group->inotify_data.idr;
624 spinlock_t *idr_lock = &group->inotify_data.idr_lock;
Eric Paris52cef752009-08-24 16:03:35 -0400625
626 /* don't allow invalid bits: we don't want flags set */
627 mask = inotify_arg_to_mask(arg);
628 if (unlikely(!mask))
629 return -EINVAL;
630
631 tmp_ientry = kmem_cache_alloc(inotify_inode_mark_cachep, GFP_KERNEL);
632 if (unlikely(!tmp_ientry))
633 return -ENOMEM;
634
635 fsnotify_init_mark(&tmp_ientry->fsn_entry, inotify_free_mark);
636 tmp_ientry->fsn_entry.mask = mask;
637 tmp_ientry->wd = -1;
638
639 ret = -ENOSPC;
640 if (atomic_read(&group->inotify_data.user->inotify_watches) >= inotify_max_user_watches)
641 goto out_err;
Eric Parisb7ba8372009-12-17 20:12:04 -0500642
Eric Paris7050c482009-12-17 20:27:10 -0500643 ret = inotify_add_to_idr(idr, idr_lock, &group->inotify_data.last_wd,
Eric Parisb7ba8372009-12-17 20:12:04 -0500644 tmp_ientry);
645 if (ret)
Eric Paris52cef752009-08-24 16:03:35 -0400646 goto out_err;
647
Eric Paris52cef752009-08-24 16:03:35 -0400648 /* we are on the idr, now get on the inode */
Eric Paris40554c32009-12-17 20:12:05 -0500649 ret = fsnotify_add_mark(&tmp_ientry->fsn_entry, group, inode, 0);
Eric Paris52cef752009-08-24 16:03:35 -0400650 if (ret) {
651 /* we failed to get on the inode, get off the idr */
652 inotify_remove_from_idr(group, tmp_ientry);
653 goto out_err;
654 }
655
Eric Paris52cef752009-08-24 16:03:35 -0400656 /* increment the number of watches the user has */
657 atomic_inc(&group->inotify_data.user->inotify_watches);
658
659 /* return the watch descriptor for this new entry */
660 ret = tmp_ientry->wd;
661
Eric Paris750a8872009-08-28 12:50:47 -0400662 /* if this mark added a new event update the group mask */
663 if (mask & ~group->mask)
664 fsnotify_recalc_group_mask(group);
665
Eric Paris52cef752009-08-24 16:03:35 -0400666out_err:
Eric Paris3dbc6fb2010-05-11 17:16:23 -0400667 /* match the ref from fsnotify_init_markentry() */
668 fsnotify_put_mark(&tmp_ientry->fsn_entry);
Eric Paris52cef752009-08-24 16:03:35 -0400669
670 return ret;
671}
672
673static int inotify_update_watch(struct fsnotify_group *group, struct inode *inode, u32 arg)
674{
675 int ret = 0;
676
677retry:
678 /* try to update and existing watch with the new arg */
679 ret = inotify_update_existing_watch(group, inode, arg);
680 /* no mark present, try to add a new one */
681 if (ret == -ENOENT)
682 ret = inotify_new_watch(group, inode, arg);
683 /*
684 * inotify_new_watch could race with another thread which did an
685 * inotify_new_watch between the update_existing and the add watch
686 * here, go back and try to update an existing mark again.
687 */
688 if (ret == -EEXIST)
689 goto retry;
690
Eric Paris63c882a2009-05-21 17:02:01 -0400691 return ret;
692}
693
694static struct fsnotify_group *inotify_new_group(struct user_struct *user, unsigned int max_events)
695{
696 struct fsnotify_group *group;
Eric Paris63c882a2009-05-21 17:02:01 -0400697
Eric Paris0d2e2a12009-12-17 21:24:22 -0500698 group = fsnotify_alloc_group(&inotify_fsnotify_ops);
Eric Paris63c882a2009-05-21 17:02:01 -0400699 if (IS_ERR(group))
700 return group;
701
702 group->max_events = max_events;
703
704 spin_lock_init(&group->inotify_data.idr_lock);
705 idr_init(&group->inotify_data.idr);
Eric Paris9e572cc2010-01-15 12:12:24 -0500706 group->inotify_data.last_wd = 0;
Eric Paris63c882a2009-05-21 17:02:01 -0400707 group->inotify_data.user = user;
708 group->inotify_data.fa = NULL;
709
710 return group;
711}
712
713
714/* inotify syscalls */
Heiko Carstens938bb9f2009-01-14 14:14:30 +0100715SYSCALL_DEFINE1(inotify_init1, int, flags)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700716{
Eric Paris63c882a2009-05-21 17:02:01 -0400717 struct fsnotify_group *group;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700718 struct user_struct *user;
Al Viroc44dcc52010-02-11 02:24:46 -0500719 int ret;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700720
Ulrich Dreppere38b36f2008-07-23 21:29:42 -0700721 /* Check the IN_* constants for consistency. */
722 BUILD_BUG_ON(IN_CLOEXEC != O_CLOEXEC);
723 BUILD_BUG_ON(IN_NONBLOCK != O_NONBLOCK);
724
Ulrich Drepper510df2d2008-07-23 21:29:41 -0700725 if (flags & ~(IN_CLOEXEC | IN_NONBLOCK))
Ulrich Drepper40065532008-07-23 21:29:32 -0700726 return -EINVAL;
727
David Howellsda9592e2008-11-14 10:39:05 +1100728 user = get_current_user();
Amy Griffis2d9048e2006-06-01 13:10:59 -0700729 if (unlikely(atomic_read(&user->inotify_devs) >=
730 inotify_max_user_instances)) {
731 ret = -EMFILE;
732 goto out_free_uid;
733 }
734
Eric Paris63c882a2009-05-21 17:02:01 -0400735 /* fsnotify_obtain_group took a reference to group, we put this when we kill the file in the end */
736 group = inotify_new_group(user, inotify_max_queued_events);
737 if (IS_ERR(group)) {
738 ret = PTR_ERR(group);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700739 goto out_free_uid;
740 }
741
Al Viro825f9692009-08-05 18:35:21 +0400742 atomic_inc(&user->inotify_devs);
743
Al Viroc44dcc52010-02-11 02:24:46 -0500744 ret = anon_inode_getfd("inotify", &inotify_fops, group,
745 O_RDONLY | flags);
746 if (ret >= 0)
747 return ret;
Al Viro825f9692009-08-05 18:35:21 +0400748
Al Viro825f9692009-08-05 18:35:21 +0400749 atomic_dec(&user->inotify_devs);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700750out_free_uid:
751 free_uid(user);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700752 return ret;
753}
754
Heiko Carstens938bb9f2009-01-14 14:14:30 +0100755SYSCALL_DEFINE0(inotify_init)
Ulrich Drepper40065532008-07-23 21:29:32 -0700756{
757 return sys_inotify_init1(0);
758}
759
Heiko Carstens2e4d0922009-01-14 14:14:31 +0100760SYSCALL_DEFINE3(inotify_add_watch, int, fd, const char __user *, pathname,
761 u32, mask)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700762{
Eric Paris63c882a2009-05-21 17:02:01 -0400763 struct fsnotify_group *group;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700764 struct inode *inode;
Al Viro2d8f3032008-07-22 09:59:21 -0400765 struct path path;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700766 struct file *filp;
767 int ret, fput_needed;
768 unsigned flags = 0;
769
770 filp = fget_light(fd, &fput_needed);
771 if (unlikely(!filp))
772 return -EBADF;
773
774 /* verify that this is indeed an inotify instance */
775 if (unlikely(filp->f_op != &inotify_fops)) {
776 ret = -EINVAL;
777 goto fput_and_out;
778 }
779
780 if (!(mask & IN_DONT_FOLLOW))
781 flags |= LOOKUP_FOLLOW;
782 if (mask & IN_ONLYDIR)
783 flags |= LOOKUP_DIRECTORY;
784
Eric Paris63c882a2009-05-21 17:02:01 -0400785 ret = inotify_find_inode(pathname, &path, flags);
786 if (ret)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700787 goto fput_and_out;
788
Eric Paris63c882a2009-05-21 17:02:01 -0400789 /* inode held in place by reference to path; group by fget on fd */
Al Viro2d8f3032008-07-22 09:59:21 -0400790 inode = path.dentry->d_inode;
Eric Paris63c882a2009-05-21 17:02:01 -0400791 group = filp->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700792
Eric Paris63c882a2009-05-21 17:02:01 -0400793 /* create/update an inode mark */
794 ret = inotify_update_watch(group, inode, mask);
Al Viro2d8f3032008-07-22 09:59:21 -0400795 path_put(&path);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700796fput_and_out:
797 fput_light(filp, fput_needed);
798 return ret;
799}
800
Heiko Carstens2e4d0922009-01-14 14:14:31 +0100801SYSCALL_DEFINE2(inotify_rm_watch, int, fd, __s32, wd)
Amy Griffis2d9048e2006-06-01 13:10:59 -0700802{
Eric Paris63c882a2009-05-21 17:02:01 -0400803 struct fsnotify_group *group;
Eric Parisb7ba8372009-12-17 20:12:04 -0500804 struct inotify_inode_mark_entry *ientry;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700805 struct file *filp;
Eric Paris63c882a2009-05-21 17:02:01 -0400806 int ret = 0, fput_needed;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700807
808 filp = fget_light(fd, &fput_needed);
809 if (unlikely(!filp))
810 return -EBADF;
811
812 /* verify that this is indeed an inotify instance */
Eric Parisb7ba8372009-12-17 20:12:04 -0500813 ret = -EINVAL;
814 if (unlikely(filp->f_op != &inotify_fops))
Amy Griffis2d9048e2006-06-01 13:10:59 -0700815 goto out;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700816
Eric Paris63c882a2009-05-21 17:02:01 -0400817 group = filp->private_data;
Amy Griffis2d9048e2006-06-01 13:10:59 -0700818
Eric Parisb7ba8372009-12-17 20:12:04 -0500819 ret = -EINVAL;
820 ientry = inotify_idr_find(group, wd);
821 if (unlikely(!ientry))
Eric Paris63c882a2009-05-21 17:02:01 -0400822 goto out;
Eric Paris63c882a2009-05-21 17:02:01 -0400823
Eric Parisb7ba8372009-12-17 20:12:04 -0500824 ret = 0;
825
Eric Parisd0775442009-12-17 21:24:24 -0500826 fsnotify_destroy_mark(&ientry->fsn_entry);
Eric Parisb7ba8372009-12-17 20:12:04 -0500827
828 /* match ref taken by inotify_idr_find */
829 fsnotify_put_mark(&ientry->fsn_entry);
Amy Griffis2d9048e2006-06-01 13:10:59 -0700830
831out:
832 fput_light(filp, fput_needed);
833 return ret;
834}
835
Amy Griffis2d9048e2006-06-01 13:10:59 -0700836/*
837 * inotify_user_setup - Our initialization function. Note that we cannnot return
838 * error because we have compiled-in VFS hooks. So an (unlikely) failure here
839 * must result in panic().
840 */
841static int __init inotify_user_setup(void)
842{
Eric Paris63c882a2009-05-21 17:02:01 -0400843 inotify_inode_mark_cachep = KMEM_CACHE(inotify_inode_mark_entry, SLAB_PANIC);
844 event_priv_cachep = KMEM_CACHE(inotify_event_private_data, SLAB_PANIC);
Eric Paris63c882a2009-05-21 17:02:01 -0400845
Amy Griffis2d9048e2006-06-01 13:10:59 -0700846 inotify_max_queued_events = 16384;
847 inotify_max_user_instances = 128;
848 inotify_max_user_watches = 8192;
849
Amy Griffis2d9048e2006-06-01 13:10:59 -0700850 return 0;
851}
Amy Griffis2d9048e2006-06-01 13:10:59 -0700852module_init(inotify_user_setup);