fs/notify/mark.c

   1 /*
   2  *  Copyright (C) 2008 Red Hat, Inc., Eric Paris <eparis@redhat.com>
   3  *
   4  *  This program is free software; you can redistribute it and/or modify
   5  *  it under the terms of the GNU General Public License as published by
   6  *  the Free Software Foundation; either version 2, or (at your option)
   7  *  any later version.
   8  *
   9  *  This program is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *  GNU General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU General Public License
  15  *  along with this program; see the file COPYING.  If not, write to
  16  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18
  19 /*
  20  * fsnotify inode mark locking/lifetime/and refcnting
  21  *
  22  * REFCNT:
  23  * The mark->refcnt tells how many "things" in the kernel currently are
  24  * referencing this object.  The object typically will live inside the kernel
  25  * with a refcnt of 2, one for each list it is on (i_list, g_list).  Any task
  26  * which can find this object holding the appropriete locks, can take a reference
  27  * and the object itself is guarenteed to survive until the reference is dropped.
  28  *
  29  * LOCKING:
  30  * There are 3 spinlocks involved with fsnotify inode marks and they MUST
  31  * be taken in order as follows:
  32  *
  33  * mark->lock
  34  * group->mark_lock
  35  * inode->i_lock
  36  *
  37  * mark->lock protects 2 things, mark->group and mark->inode.  You must hold
  38  * that lock to dereference either of these things (they could be NULL even with
  39  * the lock)
  40  *
  41  * group->mark_lock protects the marks_list anchored inside a given group
  42  * and each mark is hooked via the g_list.  It also sorta protects the
  43  * free_g_list, which when used is anchored by a private list on the stack of the
  44  * task which held the group->mark_lock.
  45  *
  46  * inode->i_lock protects the i_fsnotify_marks list anchored inside a
  47  * given inode and each mark is hooked via the i_list. (and sorta the
  48  * free_i_list)
  49  *
  50  *
  51  * LIFETIME:
  52  * Inode marks survive between when they are added to an inode and when their
  53  * refcnt==0.
  54  *
  55  * The inode mark can be cleared for a number of different reasons including:
  56  * - The inode is unlinked for the last time.  (fsnotify_inode_remove)
  57  * - The inode is being evicted from cache. (fsnotify_inode_delete)
  58  * - The fs the inode is on is unmounted.  (fsnotify_inode_delete/fsnotify_unmount_inodes)
  59  * - Something explicitly requests that it be removed.  (fsnotify_destroy_mark)
  60  * - The fsnotify_group associated with the mark is going away and all such marks
  61  *   need to be cleaned up. (fsnotify_clear_marks_by_group)
  62  *
  63  * Worst case we are given an inode and need to clean up all the marks on that
  64  * inode.  We take i_lock and walk the i_fsnotify_marks safely.  For each
  65  * mark on the list we take a reference (so the mark can't disappear under us).
  66  * We remove that mark form the inode's list of marks and we add this mark to a
  67  * private list anchored on the stack using i_free_list;  At this point we no
  68  * longer fear anything finding the mark using the inode's list of marks.
  69  *
  70  * We can safely and locklessly run the private list on the stack of everything
  71  * we just unattached from the original inode.  For each mark on the private list
  72  * we grab the mark-> and can thus dereference mark->group and mark->inode.  If
  73  * we see the group and inode are not NULL we take those locks.  Now holding all
  74  * 3 locks we can completely remove the mark from other tasks finding it in the
  75  * future.  Remember, 10 things might already be referencing this mark, but they
  76  * better be holding a ref.  We drop our reference we took before we unhooked it
  77  * from the inode.  When the ref hits 0 we can free the mark.
  78  *
  79  * Very similarly for freeing by group, except we use free_g_list.
  80  *
  81  * This has the very interesting property of being able to run concurrently with
  82  * any (or all) other directions.
  83  */
  84
  85 #include <linux/fs.h>
  86 #include <linux/init.h>
  87 #include <linux/kernel.h>
  88 #include <linux/module.h>
  89 #include <linux/mutex.h>
  90 #include <linux/slab.h>
  91 #include <linux/spinlock.h>
  92 #include <linux/writeback.h> /* for inode_lock */
  93
  94 #include <asm/atomic.h>
  95
  96 #include <linux/fsnotify_backend.h>
  97 #include "fsnotify.h"
  98
  99 void fsnotify_get_mark(struct fsnotify_mark *mark)
 100 {
 101         atomic_inc(&mark->refcnt);
 102 }
 103
 104 void fsnotify_put_mark(struct fsnotify_mark *mark)
 105 {
 106         if (atomic_dec_and_test(&mark->refcnt))
 107                 mark->free_mark(mark);
 108 }
 109
 110 /*
 111  * Any time a mark is getting freed we end up here.
 112  * The caller had better be holding a reference to this mark so we don't actually
 113  * do the final put under the mark->lock
 114  */
 115 void fsnotify_destroy_mark(struct fsnotify_mark *mark)
 116 {
 117         struct fsnotify_group *group;
 118         struct inode *inode = NULL;
 119
 120         spin_lock(&mark->lock);
 121
 122         group = mark->group;
 123
 124         /* if !group something else already marked this to die */
 125         if (!group) {
 126                 spin_unlock(&mark->lock);
 127                 return;
 128         }
 129
 130         /* 1 from caller and 1 for being on i_list/g_list */
 131         BUG_ON(atomic_read(&mark->refcnt) < 2);
 132
 133         spin_lock(&group->mark_lock);
 134
 135         if (mark->flags & FSNOTIFY_MARK_FLAG_INODE) {
 136                 fsnotify_destroy_inode_mark(mark);
 137                 inode = mark->i.inode;
 138         } else if (mark->flags & FSNOTIFY_MARK_FLAG_VFSMOUNT)
 139                 fsnotify_destroy_vfsmount_mark(mark);
 140         else
 141                 BUG();
 142
 143         list_del_init(&mark->g_list);
 144         mark->group = NULL;
 145
 146         fsnotify_put_mark(mark); /* for i_list and g_list */
 147
 148         spin_unlock(&group->mark_lock);
 149         spin_unlock(&mark->lock);
 150
 151         /*
 152          * Some groups like to know that marks are being freed.  This is a
 153          * callback to the group function to let it know that this mark
 154          * is being freed.
 155          */
 156         if (group->ops->freeing_mark)
 157                 group->ops->freeing_mark(mark, group);
 158
 159         /*
 160          * __fsnotify_update_child_dentry_flags(inode);
 161          *
 162          * I really want to call that, but we can't, we have no idea if the inode
 163          * still exists the second we drop the mark->lock.
 164          *
 165          * The next time an event arrive to this inode from one of it's children
 166          * __fsnotify_parent will see that the inode doesn't care about it's
 167          * children and will update all of these flags then.  So really this
 168          * is just a lazy update (and could be a perf win...)
 169          */
 170
 171         if (inode)
 172                 iput(inode);
 173
 174         /*
 175          * it's possible that this group tried to destroy itself, but this
 176          * this mark was simultaneously being freed by inode.  If that's the
 177          * case, we finish freeing the group here.
 178          */
 179         if (unlikely(atomic_dec_and_test(&group->num_marks)))
 180                 fsnotify_final_destroy_group(group);
 181 }
 182
 183 /*
 184  * Attach an initialized mark to a given group and fs object.
 185  * These marks may be used for the fsnotify backend to determine which
 186  * event types should be delivered to which group.
 187  */
 188 int fsnotify_add_mark(struct fsnotify_mark *mark,
 189                       struct fsnotify_group *group, struct inode *inode,
 190                       struct vfsmount *mnt, int allow_dups)
 191 {
 192         int ret = 0;
 193
 194         BUG_ON(inode && mnt);
 195         BUG_ON(!inode && !mnt);
 196
 197         /*
 198          * if this group isn't being testing for inode type events we need
 199          * to start testing
 200          */
 201         if (inode && unlikely(list_empty(&group->inode_group_list)))
 202                 fsnotify_add_inode_group(group);
 203         else if (mnt && unlikely(list_empty(&group->vfsmount_group_list)))
 204                 fsnotify_add_vfsmount_group(group);
 205
 206         /*
 207          * LOCKING ORDER!!!!
 208          * mark->lock
 209          * group->mark_lock
 210          * inode->i_lock
 211          */
 212         spin_lock(&mark->lock);
 213         spin_lock(&group->mark_lock);
 214
 215         mark->group = group;
 216         list_add(&mark->g_list, &group->marks_list);
 217         atomic_inc(&group->num_marks);
 218         fsnotify_get_mark(mark); /* for i_list and g_list */
 219
 220         if (inode) {
 221                 ret = fsnotify_add_inode_mark(mark, group, inode, allow_dups);
 222                 if (ret)
 223                         goto err;
 224         } else if (mnt) {
 225                 ret = fsnotify_add_vfsmount_mark(mark, group, mnt, allow_dups);
 226                 if (ret)
 227                         goto err;
 228         } else {
 229                 BUG();
 230         }
 231
 232         spin_unlock(&group->mark_lock);
 233         spin_unlock(&mark->lock);
 234
 235         if (inode)
 236                 __fsnotify_update_child_dentry_flags(inode);
 237
 238         return ret;
 239 err:
 240         mark->group = NULL;
 241         list_del_init(&mark->g_list);
 242         atomic_dec(&group->num_marks);
 243         fsnotify_put_mark(mark);
 244
 245         spin_unlock(&group->mark_lock);
 246         spin_unlock(&mark->lock);
 247
 248         return ret;
 249 }
 250
 251 /*
 252  * Given a group, destroy all of the marks associated with that group.
 253  */
 254 void fsnotify_clear_marks_by_group(struct fsnotify_group *group)
 255 {
 256         struct fsnotify_mark *lmark, *mark;
 257         LIST_HEAD(free_list);
 258
 259         spin_lock(&group->mark_lock);
 260         list_for_each_entry_safe(mark, lmark, &group->marks_list, g_list) {
 261                 list_add(&mark->free_g_list, &free_list);
 262                 list_del_init(&mark->g_list);
 263                 fsnotify_get_mark(mark);
 264         }
 265         spin_unlock(&group->mark_lock);
 266
 267         list_for_each_entry_safe(mark, lmark, &free_list, free_g_list) {
 268                 fsnotify_destroy_mark(mark);
 269                 fsnotify_put_mark(mark);
 270         }
 271 }
 272
 273 void fsnotify_duplicate_mark(struct fsnotify_mark *new, struct fsnotify_mark *old)
 274 {
 275         assert_spin_locked(&old->lock);
 276         new->i.inode = old->i.inode;
 277         new->m.mnt = old->m.mnt;
 278         new->group = old->group;
 279         new->mask = old->mask;
 280         new->free_mark = old->free_mark;
 281 }
 282
 283 /*
 284  * Nothing fancy, just initialize lists and locks and counters.
 285  */
 286 void fsnotify_init_mark(struct fsnotify_mark *mark,
 287                         void (*free_mark)(struct fsnotify_mark *mark))
 288 {
 289         memset(mark, 0, sizeof(*mark));
 290         spin_lock_init(&mark->lock);
 291         atomic_set(&mark->refcnt, 1);
 292         mark->free_mark = free_mark;
 293 }