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