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 file *file, 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 = file->f_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 (file)
 128                         fsnotify(p_inode, mask, file, FSNOTIFY_EVENT_FILE,
 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 void __fsnotify_flush_ignored_mask(struct inode *inode, void *data, int data_is)
 144 {
 145         struct fsnotify_mark *mark;
 146         struct hlist_node *node;
 147         int idx;
 148
 149         idx = srcu_read_lock(&fsnotify_mark_srcu);
 150
 151         if (!hlist_empty(&inode->i_fsnotify_marks)) {
 152                 hlist_for_each_entry_rcu(mark, node, &inode->i_fsnotify_marks, i.i_list) {
 153                         if (!(mark->flags & FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY))
 154                                 mark->ignored_mask = 0;
 155                 }
 156         }
 157
 158         if (data_is == FSNOTIFY_EVENT_FILE) {
 159                 struct vfsmount *mnt;
 160
 161                 mnt = ((struct file *)data)->f_path.mnt;
 162                 if (mnt && !hlist_empty(&mnt->mnt_fsnotify_marks)) {
 163                         hlist_for_each_entry_rcu(mark, node, &mnt->mnt_fsnotify_marks, m.m_list) {
 164                                 if (!(mark->flags & FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY))
 165                                         mark->ignored_mask = 0;
 166                         }
 167                 }
 168         }
 169
 170         srcu_read_unlock(&fsnotify_mark_srcu, idx);
 171 }
 172
 173 static int send_to_group(struct fsnotify_group *group, struct inode *to_tell,
 174                          struct vfsmount *mnt, struct fsnotify_mark *mark,
 175                          __u32 mask, void *data, int data_is, u32 cookie,
 176                          const unsigned char *file_name,
 177                          struct fsnotify_event **event)
 178 {
 179         pr_debug("%s: group=%p to_tell=%p mnt=%p mark=%p mask=%x data=%p"
 180                  " data_is=%d cookie=%d event=%p\n", __func__, group, to_tell,
 181                  mnt, mark, mask, data, data_is, cookie, *event);
 182
 183         if (!group->ops->should_send_event(group, to_tell, mnt, mark, mask,
 184                                            data, data_is))
 185                 return 0;
 186         if (!*event) {
 187                 *event = fsnotify_create_event(to_tell, mask, data,
 188                                                 data_is, file_name,
 189                                                 cookie, GFP_KERNEL);
 190                 if (!*event)
 191                         return -ENOMEM;
 192         }
 193         return group->ops->handle_event(group, mark, *event);
 194 }
 195
 196 static bool needed_by_vfsmount(__u32 test_mask, struct vfsmount *mnt)
 197 {
 198         if (!mnt)
 199                 return false;
 200
 201         return (test_mask & mnt->mnt_fsnotify_mask);
 202 }
 203
 204 /*
 205  * This is the main call to fsnotify.  The VFS calls into hook specific functions
 206  * in linux/fsnotify.h.  Those functions then in turn call here.  Here will call
 207  * out to all of the registered fsnotify_group.  Those groups can then use the
 208  * notification event in whatever means they feel necessary.
 209  */
 210 int fsnotify(struct inode *to_tell, __u32 mask, void *data, int data_is,
 211              const unsigned char *file_name, u32 cookie)
 212 {
 213         struct fsnotify_mark *mark;
 214         struct fsnotify_group *group;
 215         struct fsnotify_event *event = NULL;
 216         struct hlist_node *node;
 217         struct vfsmount *mnt = NULL;
 218         int idx, ret = 0;
 219         /* global tests shouldn't care about events on child only the specific event */
 220         __u32 test_mask = (mask & ~FS_EVENT_ON_CHILD);
 221
 222         /* if no fsnotify listeners, nothing to do */
 223         if (list_empty(&fsnotify_inode_groups) &&
 224             list_empty(&fsnotify_vfsmount_groups))
 225                 return 0;
 226
 227         if (mask & FS_MODIFY)
 228                 __fsnotify_flush_ignored_mask(to_tell, data, data_is);
 229
 230         /* if none of the directed listeners or vfsmount listeners care */
 231         if (!(test_mask & fsnotify_inode_mask) &&
 232             !(test_mask & fsnotify_vfsmount_mask))
 233                 return 0;
 234
 235         if (data_is == FSNOTIFY_EVENT_FILE)
 236                 mnt = ((struct file *)data)->f_path.mnt;
 237
 238         /* if this inode's directed listeners don't care and nothing on the vfsmount
 239          * listeners list cares, nothing to do */
 240         if (!(test_mask & to_tell->i_fsnotify_mask) &&
 241             !needed_by_vfsmount(test_mask, mnt))
 242                 return 0;
 243
 244         idx = srcu_read_lock(&fsnotify_mark_srcu);
 245
 246         if (test_mask & to_tell->i_fsnotify_mask) {
 247                 hlist_for_each_entry_rcu(mark, node, &to_tell->i_fsnotify_marks, i.i_list) {
 248
 249                         pr_debug("%s: inode_loop: mark=%p mark->mask=%x mark->ignored_mask=%x\n",
 250                                  __func__, mark, mark->mask, mark->ignored_mask);
 251
 252                         if (test_mask & mark->mask & ~mark->ignored_mask) {
 253                                 group = mark->group;
 254                                 if (!group)
 255                                         continue;
 256                                 ret = send_to_group(group, to_tell, NULL, mark, mask,
 257                                                     data, data_is, cookie, file_name,
 258                                                     &event);
 259                                 if (ret)
 260                                         goto out;
 261                         }
 262                 }
 263         }
 264
 265         if (mnt && (test_mask & mnt->mnt_fsnotify_mask)) {
 266                 hlist_for_each_entry_rcu(mark, node, &mnt->mnt_fsnotify_marks, m.m_list) {
 267
 268                         pr_debug("%s: mnt_loop: mark=%p mark->mask=%x mark->ignored_mask=%x\n",
 269                                  __func__, mark, mark->mask, mark->ignored_mask);
 270
 271                         if (test_mask & mark->mask & ~mark->ignored_mask)  {
 272                                 group = mark->group;
 273                                 if (!group)
 274                                         continue;
 275                                 ret = send_to_group(group, to_tell, mnt, mark, mask,
 276                                                     data, data_is, cookie, file_name,
 277                                                     &event);
 278                                 if (ret)
 279                                         goto out;
 280                         }
 281                 }
 282         }
 283 out:
 284         srcu_read_unlock(&fsnotify_mark_srcu, idx);
 285         /*
 286          * fsnotify_create_event() took a reference so the event can't be cleaned
 287          * up while we are still trying to add it to lists, drop that one.
 288          */
 289         if (event)
 290                 fsnotify_put_event(event);
 291
 292         return ret;
 293 }
 294 EXPORT_SYMBOL_GPL(fsnotify);
 295
 296 static __init int fsnotify_init(void)
 297 {
 298         int ret;
 299
 300         BUG_ON(hweight32(ALL_FSNOTIFY_EVENTS) != 23);
 301
 302         ret = init_srcu_struct(&fsnotify_mark_srcu);
 303         if (ret)
 304                 panic("initializing fsnotify_mark_srcu");
 305
 306         return 0;
 307 }
 308 core_initcall(fsnotify_init);