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  * Given an inode, first check if we care what happens to our children.  Inotify
  46  * and dnotify both tell their parents about events.  If we care about any event
  47  * on a child we run all of our children and set a dentry flag saying that the
  48  * parent cares.  Thus when an event happens on a child it can quickly tell if
  49  * if there is a need to find a parent and send the event to the parent.
  50  */
  51 void __fsnotify_update_child_dentry_flags(struct inode *inode)
  52 {
  53         struct dentry *alias;
  54         int watched;
  55
  56         if (!S_ISDIR(inode->i_mode))
  57                 return;
  58
  59         /* determine if the children should tell inode about their events */
  60         watched = fsnotify_inode_watches_children(inode);
  61
  62         spin_lock(&dcache_lock);
  63         /* run all of the dentries associated with this inode.  Since this is a
  64          * directory, there damn well better only be one item on this list */
  65         list_for_each_entry(alias, &inode->i_dentry, d_alias) {
  66                 struct dentry *child;
  67
  68                 /* run all of the children of the original inode and fix their
  69                  * d_flags to indicate parental interest (their parent is the
  70                  * original inode) */
  71                 list_for_each_entry(child, &alias->d_subdirs, d_u.d_child) {
  72                         if (!child->d_inode)
  73                                 continue;
  74
  75                         spin_lock(&child->d_lock);
  76                         if (watched)
  77                                 child->d_flags |= DCACHE_FSNOTIFY_PARENT_WATCHED;
  78                         else
  79                                 child->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
  80                         spin_unlock(&child->d_lock);
  81                 }
  82         }
  83         spin_unlock(&dcache_lock);
  84 }
  85
  86 /* Notify this dentry's parent about a child's events. */
  87 void __fsnotify_parent(struct path *path, struct dentry *dentry, __u32 mask)
  88 {
  89         struct dentry *parent;
  90         struct inode *p_inode;
  91         bool send = false;
  92         bool should_update_children = false;
  93
  94         if (!dentry)
  95                 dentry = path->dentry;
  96
  97         if (!(dentry->d_flags & DCACHE_FSNOTIFY_PARENT_WATCHED))
  98                 return;
  99
 100         spin_lock(&dentry->d_lock);
 101         parent = dentry->d_parent;
 102         p_inode = parent->d_inode;
 103
 104         if (fsnotify_inode_watches_children(p_inode)) {
 105                 if (p_inode->i_fsnotify_mask & mask) {
 106                         dget(parent);
 107                         send = true;
 108                 }
 109         } else {
 110                 /*
 111                  * The parent doesn't care about events on it's children but
 112                  * at least one child thought it did.  We need to run all the
 113                  * children and update their d_flags to let them know p_inode
 114                  * doesn't care about them any more.
 115                  */
 116                 dget(parent);
 117                 should_update_children = true;
 118         }
 119
 120         spin_unlock(&dentry->d_lock);
 121
 122         if (send) {
 123                 /* we are notifying a parent so come up with the new mask which
 124                  * specifies these are events which came from a child. */
 125                 mask |= FS_EVENT_ON_CHILD;
 126
 127                 if (path)
 128                         fsnotify(p_inode, mask, path, FSNOTIFY_EVENT_PATH,
 129                                  dentry->d_name.name, 0);
 130                 else
 131                         fsnotify(p_inode, mask, dentry->d_inode, FSNOTIFY_EVENT_INODE,
 132                                  dentry->d_name.name, 0);
 133                 dput(parent);
 134         }
 135
 136         if (unlikely(should_update_children)) {
 137                 __fsnotify_update_child_dentry_flags(p_inode);
 138                 dput(parent);
 139         }
 140 }
 141 EXPORT_SYMBOL_GPL(__fsnotify_parent);
 142
 143 static int send_to_group(struct inode *to_tell, struct vfsmount *mnt,
 144                          struct fsnotify_mark *inode_mark,
 145                          struct fsnotify_mark *vfsmount_mark,
 146                          __u32 mask, void *data,
 147                          int data_is, u32 cookie,
 148                          const unsigned char *file_name,
 149                          struct fsnotify_event **event)
 150 {
 151         struct fsnotify_group *group = NULL;
 152         __u32 inode_test_mask = (mask & ~FS_EVENT_ON_CHILD);
 153         __u32 vfsmount_test_mask = (mask & ~FS_EVENT_ON_CHILD);
 154
 155         if (unlikely(!inode_mark && !vfsmount_mark)) {
 156                 BUG();
 157                 return 0;
 158         }
 159
 160         /* clear ignored on inode modification */
 161         if (mask & FS_MODIFY) {
 162                 if (inode_mark &&
 163                     !(inode_mark->flags & FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY))
 164                         inode_mark->ignored_mask = 0;
 165                 if (vfsmount_mark &&
 166                     !(vfsmount_mark->flags & FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY))
 167                         vfsmount_mark->ignored_mask = 0;
 168         }
 169
 170         /* does the inode mark tell us to do something? */
 171         if (inode_mark) {
 172                 group = inode_mark->group;
 173                 inode_test_mask &= inode_mark->mask;
 174                 inode_test_mask &= ~inode_mark->ignored_mask;
 175         }
 176
 177         /* does the vfsmount_mark tell us to do something? */
 178         if (vfsmount_mark) {
 179                 group = vfsmount_mark->group;
 180                 vfsmount_test_mask &= vfsmount_mark->mask;
 181                 vfsmount_test_mask &= ~vfsmount_mark->ignored_mask;
 182                 if (inode_mark)
 183                         vfsmount_test_mask &= ~inode_mark->ignored_mask;
 184         }
 185
 186         pr_debug("%s: group=%p to_tell=%p mnt=%p mark=%p mask=%x data=%p"
 187                  " data_is=%d cookie=%d event=%p\n", __func__, group, to_tell,
 188                  mnt, inode_mark, mask, data, data_is, cookie, *event);
 189
 190         if (!inode_test_mask && !vfsmount_test_mask)
 191                 return 0;
 192
 193         if (group->ops->should_send_event(group, to_tell, inode_mark,
 194                                           vfsmount_mark, mask, data,
 195                                           data_is) == false)
 196                 return 0;
 197
 198         if (!*event) {
 199                 *event = fsnotify_create_event(to_tell, mask, data,
 200                                                 data_is, file_name,
 201                                                 cookie, GFP_KERNEL);
 202                 if (!*event)
 203                         return -ENOMEM;
 204         }
 205         return group->ops->handle_event(group, inode_mark, vfsmount_mark, *event);
 206 }
 207
 208 /*
 209  * This is the main call to fsnotify.  The VFS calls into hook specific functions
 210  * in linux/fsnotify.h.  Those functions then in turn call here.  Here will call
 211  * out to all of the registered fsnotify_group.  Those groups can then use the
 212  * notification event in whatever means they feel necessary.
 213  */
 214 int fsnotify(struct inode *to_tell, __u32 mask, void *data, int data_is,
 215              const unsigned char *file_name, u32 cookie)
 216 {
 217         struct hlist_node *inode_node, *vfsmount_node;
 218         struct fsnotify_mark *inode_mark = NULL, *vfsmount_mark = NULL;
 219         struct fsnotify_group *inode_group, *vfsmount_group;
 220         struct fsnotify_event *event = NULL;
 221         struct vfsmount *mnt;
 222         int idx, ret = 0;
 223         bool used_inode = false, used_vfsmount = false;
 224         /* global tests shouldn't care about events on child only the specific event */
 225         __u32 test_mask = (mask & ~FS_EVENT_ON_CHILD);
 226
 227         if (data_is == FSNOTIFY_EVENT_PATH)
 228                 mnt = ((struct path *)data)->mnt;
 229         else
 230                 mnt = NULL;
 231
 232         /*
 233          * if this is a modify event we may need to clear the ignored masks
 234          * otherwise return if neither the inode nor the vfsmount care about
 235          * this type of event.
 236          */
 237         if (!(mask & FS_MODIFY) &&
 238             !(test_mask & to_tell->i_fsnotify_mask) &&
 239             !(mnt && test_mask & mnt->mnt_fsnotify_mask))
 240                 return 0;
 241
 242         idx = srcu_read_lock(&fsnotify_mark_srcu);
 243
 244         if ((mask & FS_MODIFY) ||
 245             (test_mask & to_tell->i_fsnotify_mask))
 246                 inode_node = srcu_dereference(to_tell->i_fsnotify_marks.first,
 247                                               &fsnotify_mark_srcu);
 248         else
 249                 inode_node = NULL;
 250
 251         if (mnt) {
 252                 if ((mask & FS_MODIFY) ||
 253                     (test_mask & mnt->mnt_fsnotify_mask))
 254                         vfsmount_node = srcu_dereference(mnt->mnt_fsnotify_marks.first,
 255                                                          &fsnotify_mark_srcu);
 256                 else
 257                         vfsmount_node = NULL;
 258         } else {
 259                 mnt = NULL;
 260                 vfsmount_node = NULL;
 261         }
 262
 263         while (inode_node || vfsmount_node) {
 264                 if (inode_node) {
 265                         inode_mark = hlist_entry(srcu_dereference(inode_node, &fsnotify_mark_srcu),
 266                                                  struct fsnotify_mark, i.i_list);
 267                         inode_group = inode_mark->group;
 268                 } else
 269                         inode_group = (void *)-1;
 270
 271                 if (vfsmount_node) {
 272                         vfsmount_mark = hlist_entry(srcu_dereference(vfsmount_node, &fsnotify_mark_srcu),
 273                                                         struct fsnotify_mark, m.m_list);
 274                         vfsmount_group = vfsmount_mark->group;
 275                 } else
 276                         vfsmount_group = (void *)-1;
 277
 278                 if (inode_group < vfsmount_group) {
 279                         /* handle inode */
 280                         send_to_group(to_tell, NULL, inode_mark, NULL, mask, data,
 281                                       data_is, cookie, file_name, &event);
 282                         used_inode = true;
 283                 } else if (vfsmount_group < inode_group) {
 284                         send_to_group(to_tell, mnt, NULL, vfsmount_mark, mask, data,
 285                                       data_is, cookie, file_name, &event);
 286                         used_vfsmount = true;
 287                 } else {
 288                         send_to_group(to_tell, mnt, inode_mark, vfsmount_mark,
 289                                       mask, data, data_is, cookie, file_name,
 290                                       &event);
 291                         used_vfsmount = true;
 292                         used_inode = true;
 293                 }
 294
 295                 if (used_inode)
 296                         inode_node = srcu_dereference(inode_node->next,
 297                                                       &fsnotify_mark_srcu);
 298                 if (used_vfsmount)
 299                         vfsmount_node = srcu_dereference(vfsmount_node->next,
 300                                                          &fsnotify_mark_srcu);
 301         }
 302
 303         srcu_read_unlock(&fsnotify_mark_srcu, idx);
 304         /*
 305          * fsnotify_create_event() took a reference so the event can't be cleaned
 306          * up while we are still trying to add it to lists, drop that one.
 307          */
 308         if (event)
 309                 fsnotify_put_event(event);
 310
 311         return ret;
 312 }
 313 EXPORT_SYMBOL_GPL(fsnotify);
 314
 315 static __init int fsnotify_init(void)
 316 {
 317         int ret;
 318
 319         BUG_ON(hweight32(ALL_FSNOTIFY_EVENTS) != 23);
 320
 321         ret = init_srcu_struct(&fsnotify_mark_srcu);
 322         if (ret)
 323                 panic("initializing fsnotify_mark_srcu");
 324
 325         return 0;
 326 }
 327 core_initcall(fsnotify_init);