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_event *event)
  87 {
  88         struct fsnotify_mark *fsn_mark = NULL;
  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         fsn_mark = fsnotify_find_inode_mark(group, to_tell);
  99         if (unlikely(!fsn_mark))
 100                 return 0;
 101         dn_mark = container_of(fsn_mark, struct dnotify_mark, fsn_mark);
 102
 103         spin_lock(&fsn_mark->lock);
 104         prev = &dn_mark->dn;
 105         while ((dn = *prev) != NULL) {
 106                 if ((dn->dn_mask & test_mask) == 0) {
 107                         prev = &dn->dn_next;
 108                         continue;
 109                 }
 110                 fown = &dn->dn_filp->f_owner;
 111                 send_sigio(fown, dn->dn_fd, POLL_MSG);
 112                 if (dn->dn_mask & FS_DN_MULTISHOT)
 113                         prev = &dn->dn_next;
 114                 else {
 115                         *prev = dn->dn_next;
 116                         kmem_cache_free(dnotify_struct_cache, dn);
 117                         dnotify_recalc_inode_mask(fsn_mark);
 118                 }
 119         }
 120
 121         spin_unlock(&fsn_mark->lock);
 122         fsnotify_put_mark(fsn_mark);
 123
 124         return 0;
 125 }
 126
 127 /*
 128  * Given an inode and mask determine if dnotify would be interested in sending
 129  * userspace notification for that pair.
 130  */
 131 static bool dnotify_should_send_event(struct fsnotify_group *group,
 132                                       struct inode *inode, struct vfsmount *mnt,
 133                                       __u32 mask, void *data, int data_type)
 134 {
 135         struct fsnotify_mark *fsn_mark;
 136         bool send;
 137
 138         /* !dir_notify_enable should never get here, don't waste time checking
 139         if (!dir_notify_enable)
 140                 return 0; */
 141
 142         /* not a dir, dnotify doesn't care */
 143         if (!S_ISDIR(inode->i_mode))
 144                 return false;
 145
 146         fsn_mark = fsnotify_find_inode_mark(group, inode);
 147         if (!fsn_mark)
 148                 return false;
 149
 150         mask = (mask & ~FS_EVENT_ON_CHILD);
 151         send = (mask & fsn_mark->mask);
 152
 153         fsnotify_put_mark(fsn_mark); /* matches fsnotify_find_inode_mark */
 154
 155         return send;
 156 }
 157
 158 static void dnotify_free_mark(struct fsnotify_mark *fsn_mark)
 159 {
 160         struct dnotify_mark *dn_mark = container_of(fsn_mark,
 161                                                     struct dnotify_mark,
 162                                                     fsn_mark);
 163
 164         BUG_ON(dn_mark->dn);
 165
 166         kmem_cache_free(dnotify_mark_cache, dn_mark);
 167 }
 168
 169 static struct fsnotify_ops dnotify_fsnotify_ops = {
 170         .handle_event = dnotify_handle_event,
 171         .should_send_event = dnotify_should_send_event,
 172         .free_group_priv = NULL,
 173         .freeing_mark = NULL,
 174         .free_event_priv = NULL,
 175 };
 176
 177 /*
 178  * Called every time a file is closed.  Looks first for a dnotify mark on the
 179  * inode.  If one is found run all of the ->dn structures attached to that
 180  * mark for one relevant to this process closing the file and remove that
 181  * dnotify_struct.  If that was the last dnotify_struct also remove the
 182  * fsnotify_mark.
 183  */
 184 void dnotify_flush(struct file *filp, fl_owner_t id)
 185 {
 186         struct fsnotify_mark *fsn_mark;
 187         struct dnotify_mark *dn_mark;
 188         struct dnotify_struct *dn;
 189         struct dnotify_struct **prev;
 190         struct inode *inode;
 191
 192         inode = filp->f_path.dentry->d_inode;
 193         if (!S_ISDIR(inode->i_mode))
 194                 return;
 195
 196         fsn_mark = fsnotify_find_inode_mark(dnotify_group, inode);
 197         if (!fsn_mark)
 198                 return;
 199         dn_mark = container_of(fsn_mark, struct dnotify_mark, fsn_mark);
 200
 201         mutex_lock(&dnotify_mark_mutex);
 202
 203         spin_lock(&fsn_mark->lock);
 204         prev = &dn_mark->dn;
 205         while ((dn = *prev) != NULL) {
 206                 if ((dn->dn_owner == id) && (dn->dn_filp == filp)) {
 207                         *prev = dn->dn_next;
 208                         kmem_cache_free(dnotify_struct_cache, dn);
 209                         dnotify_recalc_inode_mask(fsn_mark);
 210                         break;
 211                 }
 212                 prev = &dn->dn_next;
 213         }
 214
 215         spin_unlock(&fsn_mark->lock);
 216
 217         /* nothing else could have found us thanks to the dnotify_mark_mutex */
 218         if (dn_mark->dn == NULL)
 219                 fsnotify_destroy_mark(fsn_mark);
 220
 221         fsnotify_recalc_group_mask(dnotify_group);
 222
 223         mutex_unlock(&dnotify_mark_mutex);
 224
 225         fsnotify_put_mark(fsn_mark);
 226 }
 227
 228 /* this conversion is done only at watch creation */
 229 static __u32 convert_arg(unsigned long arg)
 230 {
 231         __u32 new_mask = FS_EVENT_ON_CHILD;
 232
 233         if (arg & DN_MULTISHOT)
 234                 new_mask |= FS_DN_MULTISHOT;
 235         if (arg & DN_DELETE)
 236                 new_mask |= (FS_DELETE | FS_MOVED_FROM);
 237         if (arg & DN_MODIFY)
 238                 new_mask |= FS_MODIFY;
 239         if (arg & DN_ACCESS)
 240                 new_mask |= FS_ACCESS;
 241         if (arg & DN_ATTRIB)
 242                 new_mask |= FS_ATTRIB;
 243         if (arg & DN_RENAME)
 244                 new_mask |= FS_DN_RENAME;
 245         if (arg & DN_CREATE)
 246                 new_mask |= (FS_CREATE | FS_MOVED_TO);
 247
 248         return new_mask;
 249 }
 250
 251 /*
 252  * If multiple processes watch the same inode with dnotify there is only one
 253  * dnotify mark in inode->i_fsnotify_marks but we chain a dnotify_struct
 254  * onto that mark.  This function either attaches the new dnotify_struct onto
 255  * that list, or it |= the mask onto an existing dnofiy_struct.
 256  */
 257 static int attach_dn(struct dnotify_struct *dn, struct dnotify_mark *dn_mark,
 258                      fl_owner_t id, int fd, struct file *filp, __u32 mask)
 259 {
 260         struct dnotify_struct *odn;
 261
 262         odn = dn_mark->dn;
 263         while (odn != NULL) {
 264                 /* adding more events to existing dnofiy_struct? */
 265                 if ((odn->dn_owner == id) && (odn->dn_filp == filp)) {
 266                         odn->dn_fd = fd;
 267                         odn->dn_mask |= mask;
 268                         return -EEXIST;
 269                 }
 270                 odn = odn->dn_next;
 271         }
 272
 273         dn->dn_mask = mask;
 274         dn->dn_fd = fd;
 275         dn->dn_filp = filp;
 276         dn->dn_owner = id;
 277         dn->dn_next = dn_mark->dn;
 278         dn_mark->dn = dn;
 279
 280         return 0;
 281 }
 282
 283 /*
 284  * When a process calls fcntl to attach a dnotify watch to a directory it ends
 285  * up here.  Allocate both a mark for fsnotify to add and a dnotify_struct to be
 286  * attached to the fsnotify_mark.
 287  */
 288 int fcntl_dirnotify(int fd, struct file *filp, unsigned long arg)
 289 {
 290         struct dnotify_mark *new_dn_mark, *dn_mark;
 291         struct fsnotify_mark *new_fsn_mark, *fsn_mark;
 292         struct dnotify_struct *dn;
 293         struct inode *inode;
 294         fl_owner_t id = current->files;
 295         struct file *f;
 296         int destroy = 0, error = 0;
 297         __u32 mask;
 298
 299         /* we use these to tell if we need to kfree */
 300         new_fsn_mark = NULL;
 301         dn = NULL;
 302
 303         if (!dir_notify_enable) {
 304                 error = -EINVAL;
 305                 goto out_err;
 306         }
 307
 308         /* a 0 mask means we are explicitly removing the watch */
 309         if ((arg & ~DN_MULTISHOT) == 0) {
 310                 dnotify_flush(filp, id);
 311                 error = 0;
 312                 goto out_err;
 313         }
 314
 315         /* dnotify only works on directories */
 316         inode = filp->f_path.dentry->d_inode;
 317         if (!S_ISDIR(inode->i_mode)) {
 318                 error = -ENOTDIR;
 319                 goto out_err;
 320         }
 321
 322         /* expect most fcntl to add new rather than augment old */
 323         dn = kmem_cache_alloc(dnotify_struct_cache, GFP_KERNEL);
 324         if (!dn) {
 325                 error = -ENOMEM;
 326                 goto out_err;
 327         }
 328
 329         /* new fsnotify mark, we expect most fcntl calls to add a new mark */
 330         new_dn_mark = kmem_cache_alloc(dnotify_mark_cache, GFP_KERNEL);
 331         if (!new_dn_mark) {
 332                 error = -ENOMEM;
 333                 goto out_err;
 334         }
 335
 336         /* convert the userspace DN_* "arg" to the internal FS_* defines in fsnotify */
 337         mask = convert_arg(arg);
 338
 339         /* set up the new_fsn_mark and new_dn_mark */
 340         new_fsn_mark = &new_dn_mark->fsn_mark;
 341         fsnotify_init_mark(new_fsn_mark, dnotify_free_mark);
 342         new_fsn_mark->mask = mask;
 343         new_dn_mark->dn = NULL;
 344
 345         /* this is needed to prevent the fcntl/close race described below */
 346         mutex_lock(&dnotify_mark_mutex);
 347
 348         /* add the new_fsn_mark or find an old one. */
 349         fsn_mark = fsnotify_find_inode_mark(dnotify_group, inode);
 350         if (fsn_mark) {
 351                 dn_mark = container_of(fsn_mark, struct dnotify_mark, fsn_mark);
 352                 spin_lock(&fsn_mark->lock);
 353         } else {
 354                 fsnotify_add_mark(new_fsn_mark, dnotify_group, inode, NULL, 0);
 355                 spin_lock(&new_fsn_mark->lock);
 356                 fsn_mark = new_fsn_mark;
 357                 dn_mark = new_dn_mark;
 358                 /* we used new_fsn_mark, so don't free it */
 359                 new_fsn_mark = NULL;
 360         }
 361
 362         rcu_read_lock();
 363         f = fcheck(fd);
 364         rcu_read_unlock();
 365
 366         /* if (f != filp) means that we lost a race and another task/thread
 367          * actually closed the fd we are still playing with before we grabbed
 368          * the dnotify_mark_mutex and fsn_mark->lock.  Since closing the fd is the
 369          * only time we clean up the marks we need to get our mark off
 370          * the list. */
 371         if (f != filp) {
 372                 /* if we added ourselves, shoot ourselves, it's possible that
 373                  * the flush actually did shoot this fsn_mark.  That's fine too
 374                  * since multiple calls to destroy_mark is perfectly safe, if
 375                  * we found a dn_mark already attached to the inode, just sod
 376                  * off silently as the flush at close time dealt with it.
 377                  */
 378                 if (dn_mark == new_dn_mark)
 379                         destroy = 1;
 380                 goto out;
 381         }
 382
 383         error = __f_setown(filp, task_pid(current), PIDTYPE_PID, 0);
 384         if (error) {
 385                 /* if we added, we must shoot */
 386                 if (dn_mark == new_dn_mark)
 387                         destroy = 1;
 388                 goto out;
 389         }
 390
 391         error = attach_dn(dn, dn_mark, id, fd, filp, mask);
 392         /* !error means that we attached the dn to the dn_mark, so don't free it */
 393         if (!error)
 394                 dn = NULL;
 395         /* -EEXIST means that we didn't add this new dn and used an old one.
 396          * that isn't an error (and the unused dn should be freed) */
 397         else if (error == -EEXIST)
 398                 error = 0;
 399
 400         dnotify_recalc_inode_mask(fsn_mark);
 401 out:
 402         spin_unlock(&fsn_mark->lock);
 403
 404         if (destroy)
 405                 fsnotify_destroy_mark(fsn_mark);
 406
 407         fsnotify_recalc_group_mask(dnotify_group);
 408
 409         mutex_unlock(&dnotify_mark_mutex);
 410         fsnotify_put_mark(fsn_mark);
 411 out_err:
 412         if (new_fsn_mark)
 413                 fsnotify_put_mark(new_fsn_mark);
 414         if (dn)
 415                 kmem_cache_free(dnotify_struct_cache, dn);
 416         return error;
 417 }
 418
 419 static int __init dnotify_init(void)
 420 {
 421         dnotify_struct_cache = KMEM_CACHE(dnotify_struct, SLAB_PANIC);
 422         dnotify_mark_cache = KMEM_CACHE(dnotify_mark, SLAB_PANIC);
 423
 424         dnotify_group = fsnotify_alloc_group(&dnotify_fsnotify_ops);
 425         if (IS_ERR(dnotify_group))
 426                 panic("unable to allocate fsnotify group for dnotify\n");
 427         return 0;
 428 }
 429
 430 module_init(dnotify_init)