fs/notify/dnotify/dnotify.c

   1 /*
   2  * Directory notifications for Linux.
   3  *
   4  * Copyright (C) 2000,2001,2002 Stephen Rothwell
   5  *
   6  * Copyright (C) 2009 Eric Paris <Red Hat Inc>
   7  * dnotify was largly rewritten to use the new fsnotify infrastructure
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License as published by the
  11  * Free Software Foundation; either version 2, or (at your option) any
  12  * later version.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  */
  19 #include <linux/fs.h>
  20 #include <linux/module.h>
  21 #include <linux/sched.h>
  22 #include <linux/dnotify.h>
  23 #include <linux/init.h>
  24 #include <linux/spinlock.h>
  25 #include <linux/slab.h>
  26 #include <linux/fdtable.h>
  27 #include <linux/fsnotify_backend.h>
  28
  29 int dir_notify_enable __read_mostly = 1;
  30
  31 static struct kmem_cache *dnotify_struct_cache __read_mostly;
  32 static struct kmem_cache *dnotify_mark_cache __read_mostly;
  33 static struct fsnotify_group *dnotify_group __read_mostly;
  34 static DEFINE_MUTEX(dnotify_mark_mutex);
  35
  36 /*
  37  * dnotify will attach one of these to each inode (i_fsnotify_marks) which
  38  * is being watched by dnotify.  If multiple userspace applications are watching
  39  * the same directory with dnotify their information is chained in dn
  40  */
  41 struct dnotify_mark {
  42         struct fsnotify_mark fsn_mark;
  43         struct dnotify_struct *dn;
  44 };
  45
  46 /*
  47  * When a process starts or stops watching an inode the set of events which
  48  * dnotify cares about for that inode may change.  This function runs the
  49  * list of everything receiving dnotify events about this directory and calculates
  50  * the set of all those events.  After it updates what dnotify is interested in
  51  * it calls the fsnotify function so it can update the set of all events relevant
  52  * to this inode.
  53  */
  54 static void dnotify_recalc_inode_mask(struct fsnotify_mark *fsn_mark)
  55 {
  56         __u32 new_mask, old_mask;
  57         struct dnotify_struct *dn;
  58         struct dnotify_mark *dn_mark  = container_of(fsn_mark,
  59                                                      struct dnotify_mark,
  60                                                      fsn_mark);
  61
  62         assert_spin_locked(&fsn_mark->lock);
  63
  64         old_mask = fsn_mark->mask;
  65         new_mask = 0;
  66         for (dn = dn_mark->dn; dn != NULL; dn = dn->dn_next)
  67                 new_mask |= (dn->dn_mask & ~FS_DN_MULTISHOT);
  68         fsnotify_set_mark_mask_locked(fsn_mark, new_mask);
  69
  70         if (old_mask == new_mask)
  71                 return;
  72
  73         if (fsn_mark->i.inode)
  74                 fsnotify_recalc_inode_mask(fsn_mark->i.inode);
  75 }
  76
  77 /*
  78  * Mains fsnotify call where events are delivered to dnotify.
  79  * Find the dnotify mark on the relevant inode, run the list of dnotify structs
  80  * on that mark and determine which of them has expressed interest in receiving
  81  * events of this type.  When found send the correct process and signal and
  82  * destroy the dnotify struct if it was not registered to receive multiple
  83  * events.
  84  */
  85 static int dnotify_handle_event(struct fsnotify_group *group,
  86                                 struct fsnotify_mark *mark,
  87                                 struct fsnotify_event *event)
  88 {
  89         struct dnotify_mark *dn_mark;
  90         struct inode *to_tell;
  91         struct dnotify_struct *dn;
  92         struct dnotify_struct **prev;
  93         struct fown_struct *fown;
  94         __u32 test_mask = event->mask & ~FS_EVENT_ON_CHILD;
  95
  96         to_tell = event->to_tell;
  97
  98         dn_mark = container_of(mark, struct dnotify_mark, fsn_mark);
  99
 100         spin_lock(&mark->lock);
 101         prev = &dn_mark->dn;
 102         while ((dn = *prev) != NULL) {
 103                 if ((dn->dn_mask & test_mask) == 0) {
 104                         prev = &dn->dn_next;
 105                         continue;
 106                 }
 107                 fown = &dn->dn_filp->f_owner;
 108                 send_sigio(fown, dn->dn_fd, POLL_MSG);
 109                 if (dn->dn_mask & FS_DN_MULTISHOT)
 110                         prev = &dn->dn_next;
 111                 else {
 112                         *prev = dn->dn_next;
 113                         kmem_cache_free(dnotify_struct_cache, dn);
 114                         dnotify_recalc_inode_mask(mark);
 115                 }
 116         }
 117
 118         spin_unlock(&mark->lock);
 119
 120         return 0;
 121 }
 122
 123 /*
 124  * Given an inode and mask determine if dnotify would be interested in sending
 125  * userspace notification for that pair.
 126  */
 127 static bool dnotify_should_send_event(struct fsnotify_group *group,
 128                                       struct inode *inode, struct vfsmount *mnt,
 129                                       struct fsnotify_mark *mark, __u32 mask,
 130                                       void *data, int data_type)
 131 {
 132         /* not a dir, dnotify doesn't care */
 133         if (!S_ISDIR(inode->i_mode))
 134                 return false;
 135
 136         return true;
 137 }
 138
 139 static void dnotify_free_mark(struct fsnotify_mark *fsn_mark)
 140 {
 141         struct dnotify_mark *dn_mark = container_of(fsn_mark,
 142                                                     struct dnotify_mark,
 143                                                     fsn_mark);
 144
 145         BUG_ON(dn_mark->dn);
 146
 147         kmem_cache_free(dnotify_mark_cache, dn_mark);
 148 }
 149
 150 static struct fsnotify_ops dnotify_fsnotify_ops = {
 151         .handle_event = dnotify_handle_event,
 152         .should_send_event = dnotify_should_send_event,
 153         .free_group_priv = NULL,
 154         .freeing_mark = NULL,
 155         .free_event_priv = NULL,
 156 };
 157
 158 /*
 159  * Called every time a file is closed.  Looks first for a dnotify mark on the
 160  * inode.  If one is found run all of the ->dn structures attached to that
 161  * mark for one relevant to this process closing the file and remove that
 162  * dnotify_struct.  If that was the last dnotify_struct also remove the
 163  * fsnotify_mark.
 164  */
 165 void dnotify_flush(struct file *filp, fl_owner_t id)
 166 {
 167         struct fsnotify_mark *fsn_mark;
 168         struct dnotify_mark *dn_mark;
 169         struct dnotify_struct *dn;
 170         struct dnotify_struct **prev;
 171         struct inode *inode;
 172
 173         inode = filp->f_path.dentry->d_inode;
 174         if (!S_ISDIR(inode->i_mode))
 175                 return;
 176
 177         fsn_mark = fsnotify_find_inode_mark(dnotify_group, inode);
 178         if (!fsn_mark)
 179                 return;
 180         dn_mark = container_of(fsn_mark, struct dnotify_mark, fsn_mark);
 181
 182         mutex_lock(&dnotify_mark_mutex);
 183
 184         spin_lock(&fsn_mark->lock);
 185         prev = &dn_mark->dn;
 186         while ((dn = *prev) != NULL) {
 187                 if ((dn->dn_owner == id) && (dn->dn_filp == filp)) {
 188                         *prev = dn->dn_next;
 189                         kmem_cache_free(dnotify_struct_cache, dn);
 190                         dnotify_recalc_inode_mask(fsn_mark);
 191                         break;
 192                 }
 193                 prev = &dn->dn_next;
 194         }
 195
 196         spin_unlock(&fsn_mark->lock);
 197
 198         /* nothing else could have found us thanks to the dnotify_mark_mutex */
 199         if (dn_mark->dn == NULL)
 200                 fsnotify_destroy_mark(fsn_mark);
 201
 202         mutex_unlock(&dnotify_mark_mutex);
 203
 204         fsnotify_put_mark(fsn_mark);
 205 }
 206
 207 /* this conversion is done only at watch creation */
 208 static __u32 convert_arg(unsigned long arg)
 209 {
 210         __u32 new_mask = FS_EVENT_ON_CHILD;
 211
 212         if (arg & DN_MULTISHOT)
 213                 new_mask |= FS_DN_MULTISHOT;
 214         if (arg & DN_DELETE)
 215                 new_mask |= (FS_DELETE | FS_MOVED_FROM);
 216         if (arg & DN_MODIFY)
 217                 new_mask |= FS_MODIFY;
 218         if (arg & DN_ACCESS)
 219                 new_mask |= FS_ACCESS;
 220         if (arg & DN_ATTRIB)
 221                 new_mask |= FS_ATTRIB;
 222         if (arg & DN_RENAME)
 223                 new_mask |= FS_DN_RENAME;
 224         if (arg & DN_CREATE)
 225                 new_mask |= (FS_CREATE | FS_MOVED_TO);
 226
 227         return new_mask;
 228 }
 229
 230 /*
 231  * If multiple processes watch the same inode with dnotify there is only one
 232  * dnotify mark in inode->i_fsnotify_marks but we chain a dnotify_struct
 233  * onto that mark.  This function either attaches the new dnotify_struct onto
 234  * that list, or it |= the mask onto an existing dnofiy_struct.
 235  */
 236 static int attach_dn(struct dnotify_struct *dn, struct dnotify_mark *dn_mark,
 237                      fl_owner_t id, int fd, struct file *filp, __u32 mask)
 238 {
 239         struct dnotify_struct *odn;
 240
 241         odn = dn_mark->dn;
 242         while (odn != NULL) {
 243                 /* adding more events to existing dnofiy_struct? */
 244                 if ((odn->dn_owner == id) && (odn->dn_filp == filp)) {
 245                         odn->dn_fd = fd;
 246                         odn->dn_mask |= mask;
 247                         return -EEXIST;
 248                 }
 249                 odn = odn->dn_next;
 250         }
 251
 252         dn->dn_mask = mask;
 253         dn->dn_fd = fd;
 254         dn->dn_filp = filp;
 255         dn->dn_owner = id;
 256         dn->dn_next = dn_mark->dn;
 257         dn_mark->dn = dn;
 258
 259         return 0;
 260 }
 261
 262 /*
 263  * When a process calls fcntl to attach a dnotify watch to a directory it ends
 264  * up here.  Allocate both a mark for fsnotify to add and a dnotify_struct to be
 265  * attached to the fsnotify_mark.
 266  */
 267 int fcntl_dirnotify(int fd, struct file *filp, unsigned long arg)
 268 {
 269         struct dnotify_mark *new_dn_mark, *dn_mark;
 270         struct fsnotify_mark *new_fsn_mark, *fsn_mark;
 271         struct dnotify_struct *dn;
 272         struct inode *inode;
 273         fl_owner_t id = current->files;
 274         struct file *f;
 275         int destroy = 0, error = 0;
 276         __u32 mask;
 277
 278         /* we use these to tell if we need to kfree */
 279         new_fsn_mark = NULL;
 280         dn = NULL;
 281
 282         if (!dir_notify_enable) {
 283                 error = -EINVAL;
 284                 goto out_err;
 285         }
 286
 287         /* a 0 mask means we are explicitly removing the watch */
 288         if ((arg & ~DN_MULTISHOT) == 0) {
 289                 dnotify_flush(filp, id);
 290                 error = 0;
 291                 goto out_err;
 292         }
 293
 294         /* dnotify only works on directories */
 295         inode = filp->f_path.dentry->d_inode;
 296         if (!S_ISDIR(inode->i_mode)) {
 297                 error = -ENOTDIR;
 298                 goto out_err;
 299         }
 300
 301         /* expect most fcntl to add new rather than augment old */
 302         dn = kmem_cache_alloc(dnotify_struct_cache, GFP_KERNEL);
 303         if (!dn) {
 304                 error = -ENOMEM;
 305                 goto out_err;
 306         }
 307
 308         /* new fsnotify mark, we expect most fcntl calls to add a new mark */
 309         new_dn_mark = kmem_cache_alloc(dnotify_mark_cache, GFP_KERNEL);
 310         if (!new_dn_mark) {
 311                 error = -ENOMEM;
 312                 goto out_err;
 313         }
 314
 315         /* convert the userspace DN_* "arg" to the internal FS_* defines in fsnotify */
 316         mask = convert_arg(arg);
 317
 318         /* set up the new_fsn_mark and new_dn_mark */
 319         new_fsn_mark = &new_dn_mark->fsn_mark;
 320         fsnotify_init_mark(new_fsn_mark, dnotify_free_mark);
 321         new_fsn_mark->mask = mask;
 322         new_dn_mark->dn = NULL;
 323
 324         /* this is needed to prevent the fcntl/close race described below */
 325         mutex_lock(&dnotify_mark_mutex);
 326
 327         /* add the new_fsn_mark or find an old one. */
 328         fsn_mark = fsnotify_find_inode_mark(dnotify_group, inode);
 329         if (fsn_mark) {
 330                 dn_mark = container_of(fsn_mark, struct dnotify_mark, fsn_mark);
 331                 spin_lock(&fsn_mark->lock);
 332         } else {
 333                 fsnotify_add_mark(new_fsn_mark, dnotify_group, inode, NULL, 0);
 334                 spin_lock(&new_fsn_mark->lock);
 335                 fsn_mark = new_fsn_mark;
 336                 dn_mark = new_dn_mark;
 337                 /* we used new_fsn_mark, so don't free it */
 338                 new_fsn_mark = NULL;
 339         }
 340
 341         rcu_read_lock();
 342         f = fcheck(fd);
 343         rcu_read_unlock();
 344
 345         /* if (f != filp) means that we lost a race and another task/thread
 346          * actually closed the fd we are still playing with before we grabbed
 347          * the dnotify_mark_mutex and fsn_mark->lock.  Since closing the fd is the
 348          * only time we clean up the marks we need to get our mark off
 349          * the list. */
 350         if (f != filp) {
 351                 /* if we added ourselves, shoot ourselves, it's possible that
 352                  * the flush actually did shoot this fsn_mark.  That's fine too
 353                  * since multiple calls to destroy_mark is perfectly safe, if
 354                  * we found a dn_mark already attached to the inode, just sod
 355                  * off silently as the flush at close time dealt with it.
 356                  */
 357                 if (dn_mark == new_dn_mark)
 358                         destroy = 1;
 359                 goto out;
 360         }
 361
 362         error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
 363         if (error) {
 364                 /* if we added, we must shoot */
 365                 if (dn_mark == new_dn_mark)
 366                         destroy = 1;
 367                 goto out;
 368         }
 369
 370         error = attach_dn(dn, dn_mark, id, fd, filp, mask);
 371         /* !error means that we attached the dn to the dn_mark, so don't free it */
 372         if (!error)
 373                 dn = NULL;
 374         /* -EEXIST means that we didn't add this new dn and used an old one.
 375          * that isn't an error (and the unused dn should be freed) */
 376         else if (error == -EEXIST)
 377                 error = 0;
 378
 379         dnotify_recalc_inode_mask(fsn_mark);
 380 out:
 381         spin_unlock(&fsn_mark->lock);
 382
 383         if (destroy)
 384                 fsnotify_destroy_mark(fsn_mark);
 385
 386         mutex_unlock(&dnotify_mark_mutex);
 387         fsnotify_put_mark(fsn_mark);
 388 out_err:
 389         if (new_fsn_mark)
 390                 fsnotify_put_mark(new_fsn_mark);
 391         if (dn)
 392                 kmem_cache_free(dnotify_struct_cache, dn);
 393         return error;
 394 }
 395
 396 static int __init dnotify_init(void)
 397 {
 398         dnotify_struct_cache = KMEM_CACHE(dnotify_struct, SLAB_PANIC);
 399         dnotify_mark_cache = KMEM_CACHE(dnotify_mark, SLAB_PANIC);
 400
 401         dnotify_group = fsnotify_alloc_group(&dnotify_fsnotify_ops);
 402         if (IS_ERR(dnotify_group))
 403                 panic("unable to allocate fsnotify group for dnotify\n");
 404         return 0;
 405 }
 406
 407 module_init(dnotify_init)