fs/notify/fsnotify.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 #include <linux/dcache.h>
  20 #include <linux/fs.h>
  21 #include <linux/gfp.h>
  22 #include <linux/init.h>
  23 #include <linux/module.h>
  24 #include <linux/mount.h>
  25 #include <linux/srcu.h>
  26
  27 #include <linux/fsnotify_backend.h>
  28 #include "fsnotify.h"
  29
  30 /*
  31  * Clear all of the marks on an inode when it is being evicted from core
  32  */
  33 void __fsnotify_inode_delete(struct inode *inode)
  34 {
  35         fsnotify_clear_marks_by_inode(inode);
  36 }
  37 EXPORT_SYMBOL_GPL(__fsnotify_inode_delete);
  38
  39 void __fsnotify_vfsmount_delete(struct vfsmount *mnt)
  40 {
  41         fsnotify_clear_marks_by_mount(mnt);
  42 }
  43
  44 /**
  45  * fsnotify_unmount_inodes - an sb is unmounting.  handle any watched inodes.
  46  * @sb: superblock being unmounted.
  47  *
  48  * Called during unmount with no locks held, so needs to be safe against
  49  * concurrent modifiers. We temporarily drop sb->s_inode_list_lock and CAN block.
  50  */
  51 void fsnotify_unmount_inodes(struct super_block *sb)
  52 {
  53         struct inode *inode, *iput_inode = NULL;
  54
  55         spin_lock(&sb->s_inode_list_lock);
  56         list_for_each_entry(inode, &sb->s_inodes, i_sb_list) {
  57                 /*
  58                  * We cannot __iget() an inode in state I_FREEING,
  59                  * I_WILL_FREE, or I_NEW which is fine because by that point
  60                  * the inode cannot have any associated watches.
  61                  */
  62                 spin_lock(&inode->i_lock);
  63                 if (inode->i_state & (I_FREEING|I_WILL_FREE|I_NEW)) {
  64                         spin_unlock(&inode->i_lock);
  65                         continue;
  66                 }
  67
  68                 /*
  69                  * If i_count is zero, the inode cannot have any watches and
  70                  * doing an __iget/iput with SB_ACTIVE clear would actually
  71                  * evict all inodes with zero i_count from icache which is
  72                  * unnecessarily violent and may in fact be illegal to do.
  73                  */
  74                 if (!atomic_read(&inode->i_count)) {
  75                         spin_unlock(&inode->i_lock);
  76                         continue;
  77                 }
  78
  79                 __iget(inode);
  80                 spin_unlock(&inode->i_lock);
  81                 spin_unlock(&sb->s_inode_list_lock);
  82
  83                 if (iput_inode)
  84                         iput(iput_inode);
  85
  86                 /* for each watch, send FS_UNMOUNT and then remove it */
  87                 fsnotify(inode, FS_UNMOUNT, inode, FSNOTIFY_EVENT_INODE, NULL, 0);
  88
  89                 fsnotify_inode_delete(inode);
  90
  91                 iput_inode = inode;
  92
  93                 cond_resched();
  94                 spin_lock(&sb->s_inode_list_lock);
  95         }
  96         spin_unlock(&sb->s_inode_list_lock);
  97
  98         if (iput_inode)
  99                 iput(iput_inode);
 100         /* Wait for outstanding inode references from connectors */
 101         wait_var_event(&sb->s_fsnotify_inode_refs,
 102                        !atomic_long_read(&sb->s_fsnotify_inode_refs));
 103 }
 104
 105 /*
 106  * Given an inode, first check if we care what happens to our children.  Inotify
 107  * and dnotify both tell their parents about events.  If we care about any event
 108  * on a child we run all of our children and set a dentry flag saying that the
 109  * parent cares.  Thus when an event happens on a child it can quickly tell if
 110  * if there is a need to find a parent and send the event to the parent.
 111  */
 112 void __fsnotify_update_child_dentry_flags(struct inode *inode)
 113 {
 114         struct dentry *alias;
 115         int watched;
 116
 117         if (!S_ISDIR(inode->i_mode))
 118                 return;
 119
 120         /* determine if the children should tell inode about their events */
 121         watched = fsnotify_inode_watches_children(inode);
 122
 123         spin_lock(&inode->i_lock);
 124         /* run all of the dentries associated with this inode.  Since this is a
 125          * directory, there damn well better only be one item on this list */
 126         hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
 127                 struct dentry *child;
 128
 129                 /* run all of the children of the original inode and fix their
 130                  * d_flags to indicate parental interest (their parent is the
 131                  * original inode) */
 132                 spin_lock(&alias->d_lock);
 133                 list_for_each_entry(child, &alias->d_subdirs, d_child) {
 134                         if (!child->d_inode)
 135                                 continue;
 136
 137                         spin_lock_nested(&child->d_lock, DENTRY_D_LOCK_NESTED);
 138                         if (watched)
 139                                 child->d_flags |= DCACHE_FSNOTIFY_PARENT_WATCHED;
 140                         else
 141                                 child->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
 142                         spin_unlock(&child->d_lock);
 143                 }
 144                 spin_unlock(&alias->d_lock);
 145         }
 146         spin_unlock(&inode->i_lock);
 147 }
 148
 149 /* Notify this dentry's parent about a child's events. */
 150 int __fsnotify_parent(const struct path *path, struct dentry *dentry, __u32 mask)
 151 {
 152         struct dentry *parent;
 153         struct inode *p_inode;
 154         int ret = 0;
 155
 156         if (!dentry)
 157                 dentry = path->dentry;
 158
 159         if (!(dentry->d_flags & DCACHE_FSNOTIFY_PARENT_WATCHED))
 160                 return 0;
 161
 162         parent = dget_parent(dentry);
 163         p_inode = parent->d_inode;
 164
 165         if (unlikely(!fsnotify_inode_watches_children(p_inode))) {
 166                 __fsnotify_update_child_dentry_flags(p_inode);
 167         } else if (p_inode->i_fsnotify_mask & mask & ALL_FSNOTIFY_EVENTS) {
 168                 struct name_snapshot name;
 169
 170                 /* we are notifying a parent so come up with the new mask which
 171                  * specifies these are events which came from a child. */
 172                 mask |= FS_EVENT_ON_CHILD;
 173
 174                 take_dentry_name_snapshot(&name, dentry);
 175                 if (path)
 176                         ret = fsnotify(p_inode, mask, path, FSNOTIFY_EVENT_PATH,
 177                                        name.name, 0);
 178                 else
 179                         ret = fsnotify(p_inode, mask, dentry->d_inode, FSNOTIFY_EVENT_INODE,
 180                                        name.name, 0);
 181                 release_dentry_name_snapshot(&name);
 182         }
 183
 184         dput(parent);
 185
 186         return ret;
 187 }
 188 EXPORT_SYMBOL_GPL(__fsnotify_parent);
 189
 190 static int send_to_group(struct inode *to_tell,
 191                          __u32 mask, const void *data,
 192                          int data_is, u32 cookie,
 193                          const unsigned char *file_name,
 194                          struct fsnotify_iter_info *iter_info)
 195 {
 196         struct fsnotify_group *group = NULL;
 197         __u32 test_mask = (mask & ALL_FSNOTIFY_EVENTS);
 198         __u32 marks_mask = 0;
 199         __u32 marks_ignored_mask = 0;
 200         struct fsnotify_mark *mark;
 201         int type;
 202
 203         if (WARN_ON(!iter_info->report_mask))
 204                 return 0;
 205
 206         /* clear ignored on inode modification */
 207         if (mask & FS_MODIFY) {
 208                 fsnotify_foreach_obj_type(type) {
 209                         if (!fsnotify_iter_should_report_type(iter_info, type))
 210                                 continue;
 211                         mark = iter_info->marks[type];
 212                         if (mark &&
 213                             !(mark->flags & FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY))
 214                                 mark->ignored_mask = 0;
 215                 }
 216         }
 217
 218         fsnotify_foreach_obj_type(type) {
 219                 if (!fsnotify_iter_should_report_type(iter_info, type))
 220                         continue;
 221                 mark = iter_info->marks[type];
 222                 /* does the object mark tell us to do something? */
 223                 if (mark) {
 224                         group = mark->group;
 225                         marks_mask |= mark->mask;
 226                         marks_ignored_mask |= mark->ignored_mask;
 227                 }
 228         }
 229
 230         pr_debug("%s: group=%p to_tell=%p mask=%x marks_mask=%x marks_ignored_mask=%x"
 231                  " data=%p data_is=%d cookie=%d\n",
 232                  __func__, group, to_tell, mask, marks_mask, marks_ignored_mask,
 233                  data, data_is, cookie);
 234
 235         if (!(test_mask & marks_mask & ~marks_ignored_mask))
 236                 return 0;
 237
 238         return group->ops->handle_event(group, to_tell, mask, data, data_is,
 239                                         file_name, cookie, iter_info);
 240 }
 241
 242 static struct fsnotify_mark *fsnotify_first_mark(struct fsnotify_mark_connector **connp)
 243 {
 244         struct fsnotify_mark_connector *conn;
 245         struct hlist_node *node = NULL;
 246
 247         conn = srcu_dereference(*connp, &fsnotify_mark_srcu);
 248         if (conn)
 249                 node = srcu_dereference(conn->list.first, &fsnotify_mark_srcu);
 250
 251         return hlist_entry_safe(node, struct fsnotify_mark, obj_list);
 252 }
 253
 254 static struct fsnotify_mark *fsnotify_next_mark(struct fsnotify_mark *mark)
 255 {
 256         struct hlist_node *node = NULL;
 257
 258         if (mark)
 259                 node = srcu_dereference(mark->obj_list.next,
 260                                         &fsnotify_mark_srcu);
 261
 262         return hlist_entry_safe(node, struct fsnotify_mark, obj_list);
 263 }
 264
 265 /*
 266  * iter_info is a multi head priority queue of marks.
 267  * Pick a subset of marks from queue heads, all with the
 268  * same group and set the report_mask for selected subset.
 269  * Returns the report_mask of the selected subset.
 270  */
 271 static unsigned int fsnotify_iter_select_report_types(
 272                 struct fsnotify_iter_info *iter_info)
 273 {
 274         struct fsnotify_group *max_prio_group = NULL;
 275         struct fsnotify_mark *mark;
 276         int type;
 277
 278         /* Choose max prio group among groups of all queue heads */
 279         fsnotify_foreach_obj_type(type) {
 280                 mark = iter_info->marks[type];
 281                 if (mark &&
 282                     fsnotify_compare_groups(max_prio_group, mark->group) > 0)
 283                         max_prio_group = mark->group;
 284         }
 285
 286         if (!max_prio_group)
 287                 return 0;
 288
 289         /* Set the report mask for marks from same group as max prio group */
 290         iter_info->report_mask = 0;
 291         fsnotify_foreach_obj_type(type) {
 292                 mark = iter_info->marks[type];
 293                 if (mark &&
 294                     fsnotify_compare_groups(max_prio_group, mark->group) == 0)
 295                         fsnotify_iter_set_report_type(iter_info, type);
 296         }
 297
 298         return iter_info->report_mask;
 299 }
 300
 301 /*
 302  * Pop from iter_info multi head queue, the marks that were iterated in the
 303  * current iteration step.
 304  */
 305 static void fsnotify_iter_next(struct fsnotify_iter_info *iter_info)
 306 {
 307         int type;
 308
 309         fsnotify_foreach_obj_type(type) {
 310                 if (fsnotify_iter_should_report_type(iter_info, type))
 311                         iter_info->marks[type] =
 312                                 fsnotify_next_mark(iter_info->marks[type]);
 313         }
 314 }
 315
 316 /*
 317  * This is the main call to fsnotify.  The VFS calls into hook specific functions
 318  * in linux/fsnotify.h.  Those functions then in turn call here.  Here will call
 319  * out to all of the registered fsnotify_group.  Those groups can then use the
 320  * notification event in whatever means they feel necessary.
 321  */
 322 int fsnotify(struct inode *to_tell, __u32 mask, const void *data, int data_is,
 323              const unsigned char *file_name, u32 cookie)
 324 {
 325         struct fsnotify_iter_info iter_info = {};
 326         struct mount *mnt;
 327         int ret = 0;
 328         __u32 test_mask = (mask & ALL_FSNOTIFY_EVENTS);
 329
 330         if (data_is == FSNOTIFY_EVENT_PATH)
 331                 mnt = real_mount(((const struct path *)data)->mnt);
 332         else
 333                 mnt = NULL;
 334
 335         /* An event "on child" is not intended for a mount mark */
 336         if (mask & FS_EVENT_ON_CHILD)
 337                 mnt = NULL;
 338
 339         /*
 340          * Optimization: srcu_read_lock() has a memory barrier which can
 341          * be expensive.  It protects walking the *_fsnotify_marks lists.
 342          * However, if we do not walk the lists, we do not have to do
 343          * SRCU because we have no references to any objects and do not
 344          * need SRCU to keep them "alive".
 345          */
 346         if (!to_tell->i_fsnotify_marks &&
 347             (!mnt || !mnt->mnt_fsnotify_marks))
 348                 return 0;
 349         /*
 350          * if this is a modify event we may need to clear the ignored masks
 351          * otherwise return if neither the inode nor the vfsmount care about
 352          * this type of event.
 353          */
 354         if (!(mask & FS_MODIFY) &&
 355             !(test_mask & to_tell->i_fsnotify_mask) &&
 356             !(mnt && test_mask & mnt->mnt_fsnotify_mask))
 357                 return 0;
 358
 359         iter_info.srcu_idx = srcu_read_lock(&fsnotify_mark_srcu);
 360
 361         iter_info.marks[FSNOTIFY_OBJ_TYPE_INODE] =
 362                 fsnotify_first_mark(&to_tell->i_fsnotify_marks);
 363         if (mnt) {
 364                 iter_info.marks[FSNOTIFY_OBJ_TYPE_VFSMOUNT] =
 365                         fsnotify_first_mark(&mnt->mnt_fsnotify_marks);
 366         }
 367
 368         /*
 369          * We need to merge inode & vfsmount mark lists so that inode mark
 370          * ignore masks are properly reflected for mount mark notifications.
 371          * That's why this traversal is so complicated...
 372          */
 373         while (fsnotify_iter_select_report_types(&iter_info)) {
 374                 ret = send_to_group(to_tell, mask, data, data_is, cookie,
 375                                     file_name, &iter_info);
 376
 377                 if (ret && (mask & ALL_FSNOTIFY_PERM_EVENTS))
 378                         goto out;
 379
 380                 fsnotify_iter_next(&iter_info);
 381         }
 382         ret = 0;
 383 out:
 384         srcu_read_unlock(&fsnotify_mark_srcu, iter_info.srcu_idx);
 385
 386         return ret;
 387 }
 388 EXPORT_SYMBOL_GPL(fsnotify);
 389
 390 extern struct kmem_cache *fsnotify_mark_connector_cachep;
 391
 392 static __init int fsnotify_init(void)
 393 {
 394         int ret;
 395
 396         BUG_ON(hweight32(ALL_FSNOTIFY_BITS) != 23);
 397
 398         ret = init_srcu_struct(&fsnotify_mark_srcu);
 399         if (ret)
 400                 panic("initializing fsnotify_mark_srcu");
 401
 402         fsnotify_mark_connector_cachep = KMEM_CACHE(fsnotify_mark_connector,
 403                                                     SLAB_PANIC);
 404
 405         return 0;
 406 }
 407 core_initcall(fsnotify_init);