fs/notify/fsnotify.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *  Copyright (C) 2008 Red Hat, Inc., Eric Paris <eparis@redhat.com>
   4  */
   5
   6 #include <linux/dcache.h>
   7 #include <linux/fs.h>
   8 #include <linux/gfp.h>
   9 #include <linux/init.h>
  10 #include <linux/module.h>
  11 #include <linux/mount.h>
  12 #include <linux/srcu.h>
  13
  14 #include <linux/fsnotify_backend.h>
  15 #include "fsnotify.h"
  16
  17 /*
  18  * Clear all of the marks on an inode when it is being evicted from core
  19  */
  20 void __fsnotify_inode_delete(struct inode *inode)
  21 {
  22         fsnotify_clear_marks_by_inode(inode);
  23 }
  24 EXPORT_SYMBOL_GPL(__fsnotify_inode_delete);
  25
  26 void __fsnotify_vfsmount_delete(struct vfsmount *mnt)
  27 {
  28         fsnotify_clear_marks_by_mount(mnt);
  29 }
  30
  31 /**
  32  * fsnotify_unmount_inodes - an sb is unmounting.  handle any watched inodes.
  33  * @sb: superblock being unmounted.
  34  *
  35  * Called during unmount with no locks held, so needs to be safe against
  36  * concurrent modifiers. We temporarily drop sb->s_inode_list_lock and CAN block.
  37  */
  38 static void fsnotify_unmount_inodes(struct super_block *sb)
  39 {
  40         struct inode *inode, *iput_inode = NULL;
  41
  42         spin_lock(&sb->s_inode_list_lock);
  43         list_for_each_entry(inode, &sb->s_inodes, i_sb_list) {
  44                 /*
  45                  * We cannot __iget() an inode in state I_FREEING,
  46                  * I_WILL_FREE, or I_NEW which is fine because by that point
  47                  * the inode cannot have any associated watches.
  48                  */
  49                 spin_lock(&inode->i_lock);
  50                 if (inode->i_state & (I_FREEING|I_WILL_FREE|I_NEW)) {
  51                         spin_unlock(&inode->i_lock);
  52                         continue;
  53                 }
  54
  55                 /*
  56                  * If i_count is zero, the inode cannot have any watches and
  57                  * doing an __iget/iput with SB_ACTIVE clear would actually
  58                  * evict all inodes with zero i_count from icache which is
  59                  * unnecessarily violent and may in fact be illegal to do.
  60                  * However, we should have been called /after/ evict_inodes
  61                  * removed all zero refcount inodes, in any case.  Test to
  62                  * be sure.
  63                  */
  64                 if (!atomic_read(&inode->i_count)) {
  65                         spin_unlock(&inode->i_lock);
  66                         continue;
  67                 }
  68
  69                 __iget(inode);
  70                 spin_unlock(&inode->i_lock);
  71                 spin_unlock(&sb->s_inode_list_lock);
  72
  73                 if (iput_inode)
  74                         iput(iput_inode);
  75
  76                 /* for each watch, send FS_UNMOUNT and then remove it */
  77                 fsnotify_inode(inode, FS_UNMOUNT);
  78
  79                 fsnotify_inode_delete(inode);
  80
  81                 iput_inode = inode;
  82
  83                 cond_resched();
  84                 spin_lock(&sb->s_inode_list_lock);
  85         }
  86         spin_unlock(&sb->s_inode_list_lock);
  87
  88         if (iput_inode)
  89                 iput(iput_inode);
  90         /* Wait for outstanding inode references from connectors */
  91         wait_var_event(&sb->s_fsnotify_inode_refs,
  92                        !atomic_long_read(&sb->s_fsnotify_inode_refs));
  93 }
  94
  95 void fsnotify_sb_delete(struct super_block *sb)
  96 {
  97         fsnotify_unmount_inodes(sb);
  98         fsnotify_clear_marks_by_sb(sb);
  99 }
 100
 101 /*
 102  * Given an inode, first check if we care what happens to our children.  Inotify
 103  * and dnotify both tell their parents about events.  If we care about any event
 104  * on a child we run all of our children and set a dentry flag saying that the
 105  * parent cares.  Thus when an event happens on a child it can quickly tell if
 106  * if there is a need to find a parent and send the event to the parent.
 107  */
 108 void __fsnotify_update_child_dentry_flags(struct inode *inode)
 109 {
 110         struct dentry *alias;
 111         int watched;
 112
 113         if (!S_ISDIR(inode->i_mode))
 114                 return;
 115
 116         /* determine if the children should tell inode about their events */
 117         watched = fsnotify_inode_watches_children(inode);
 118
 119         spin_lock(&inode->i_lock);
 120         /* run all of the dentries associated with this inode.  Since this is a
 121          * directory, there damn well better only be one item on this list */
 122         hlist_for_each_entry(alias, &inode->i_dentry, d_u.d_alias) {
 123                 struct dentry *child;
 124
 125                 /* run all of the children of the original inode and fix their
 126                  * d_flags to indicate parental interest (their parent is the
 127                  * original inode) */
 128                 spin_lock(&alias->d_lock);
 129                 list_for_each_entry(child, &alias->d_subdirs, d_child) {
 130                         if (!child->d_inode)
 131                                 continue;
 132
 133                         spin_lock_nested(&child->d_lock, DENTRY_D_LOCK_NESTED);
 134                         if (watched)
 135                                 child->d_flags |= DCACHE_FSNOTIFY_PARENT_WATCHED;
 136                         else
 137                                 child->d_flags &= ~DCACHE_FSNOTIFY_PARENT_WATCHED;
 138                         spin_unlock(&child->d_lock);
 139                 }
 140                 spin_unlock(&alias->d_lock);
 141         }
 142         spin_unlock(&inode->i_lock);
 143 }
 144
 145 /* Are inode/sb/mount interested in parent and name info with this event? */
 146 static bool fsnotify_event_needs_parent(struct inode *inode, struct mount *mnt,
 147                                         __u32 mask)
 148 {
 149         __u32 marks_mask = 0;
 150
 151         /* We only send parent/name to inode/sb/mount for events on non-dir */
 152         if (mask & FS_ISDIR)
 153                 return false;
 154
 155         /* Did either inode/sb/mount subscribe for events with parent/name? */
 156         marks_mask |= fsnotify_parent_needed_mask(inode->i_fsnotify_mask);
 157         marks_mask |= fsnotify_parent_needed_mask(inode->i_sb->s_fsnotify_mask);
 158         if (mnt)
 159                 marks_mask |= fsnotify_parent_needed_mask(mnt->mnt_fsnotify_mask);
 160
 161         /* Did they subscribe for this event with parent/name info? */
 162         return mask & marks_mask;
 163 }
 164
 165 /*
 166  * Notify this dentry's parent about a child's events with child name info
 167  * if parent is watching or if inode/sb/mount are interested in events with
 168  * parent and name info.
 169  *
 170  * Notify only the child without name info if parent is not watching and
 171  * inode/sb/mount are not interested in events with parent and name info.
 172  */
 173 int __fsnotify_parent(struct dentry *dentry, __u32 mask, const void *data,
 174                       int data_type)
 175 {
 176         const struct path *path = fsnotify_data_path(data, data_type);
 177         struct mount *mnt = path ? real_mount(path->mnt) : NULL;
 178         struct inode *inode = d_inode(dentry);
 179         struct dentry *parent;
 180         bool parent_watched = dentry->d_flags & DCACHE_FSNOTIFY_PARENT_WATCHED;
 181         __u32 p_mask;
 182         struct inode *p_inode = NULL;
 183         struct name_snapshot name;
 184         struct qstr *file_name = NULL;
 185         int ret = 0;
 186
 187         /*
 188          * Do inode/sb/mount care about parent and name info on non-dir?
 189          * Do they care about any event at all?
 190          */
 191         if (!inode->i_fsnotify_marks && !inode->i_sb->s_fsnotify_marks &&
 192             (!mnt || !mnt->mnt_fsnotify_marks) && !parent_watched)
 193                 return 0;
 194
 195         parent = NULL;
 196         if (!parent_watched && !fsnotify_event_needs_parent(inode, mnt, mask))
 197                 goto notify;
 198
 199         /* Does parent inode care about events on children? */
 200         parent = dget_parent(dentry);
 201         p_inode = parent->d_inode;
 202         p_mask = fsnotify_inode_watches_children(p_inode);
 203         if (unlikely(parent_watched && !p_mask))
 204                 __fsnotify_update_child_dentry_flags(p_inode);
 205
 206         /*
 207          * Include parent/name in notification either if some notification
 208          * groups require parent info (!parent_watched case) or the parent is
 209          * interested in this event.
 210          */
 211         if (!parent_watched || (mask & p_mask & ALL_FSNOTIFY_EVENTS)) {
 212                 /* When notifying parent, child should be passed as data */
 213                 WARN_ON_ONCE(inode != fsnotify_data_inode(data, data_type));
 214
 215                 /* Notify both parent and child with child name info */
 216                 take_dentry_name_snapshot(&name, dentry);
 217                 file_name = &name.name;
 218                 if (parent_watched)
 219                         mask |= FS_EVENT_ON_CHILD;
 220         }
 221
 222 notify:
 223         ret = fsnotify(mask, data, data_type, p_inode, file_name, inode, 0);
 224
 225         if (file_name)
 226                 release_dentry_name_snapshot(&name);
 227         dput(parent);
 228
 229         return ret;
 230 }
 231 EXPORT_SYMBOL_GPL(__fsnotify_parent);
 232
 233 static int fsnotify_handle_event(struct fsnotify_group *group, __u32 mask,
 234                                  const void *data, int data_type,
 235                                  struct inode *dir, const struct qstr *name,
 236                                  u32 cookie, struct fsnotify_iter_info *iter_info)
 237 {
 238         struct fsnotify_mark *inode_mark = fsnotify_iter_inode_mark(iter_info);
 239         struct fsnotify_mark *child_mark = fsnotify_iter_child_mark(iter_info);
 240         struct inode *inode = fsnotify_data_inode(data, data_type);
 241         const struct fsnotify_ops *ops = group->ops;
 242         int ret;
 243
 244         if (WARN_ON_ONCE(!ops->handle_inode_event))
 245                 return 0;
 246
 247         if (WARN_ON_ONCE(fsnotify_iter_sb_mark(iter_info)) ||
 248             WARN_ON_ONCE(fsnotify_iter_vfsmount_mark(iter_info)))
 249                 return 0;
 250
 251         /*
 252          * An event can be sent on child mark iterator instead of inode mark
 253          * iterator because of other groups that have interest of this inode
 254          * and have marks on both parent and child.  We can simplify this case.
 255          */
 256         if (!inode_mark) {
 257                 inode_mark = child_mark;
 258                 child_mark = NULL;
 259                 dir = NULL;
 260                 name = NULL;
 261         }
 262
 263         ret = ops->handle_inode_event(inode_mark, mask, inode, dir, name);
 264         if (ret || !child_mark)
 265                 return ret;
 266
 267         /*
 268          * Some events can be sent on both parent dir and child marks
 269          * (e.g. FS_ATTRIB).  If both parent dir and child are watching,
 270          * report the event once to parent dir with name and once to child
 271          * without name.
 272          */
 273         return ops->handle_inode_event(child_mark, mask, inode, NULL, NULL);
 274 }
 275
 276 static int send_to_group(__u32 mask, const void *data, int data_type,
 277                          struct inode *dir, const struct qstr *file_name,
 278                          u32 cookie, struct fsnotify_iter_info *iter_info)
 279 {
 280         struct fsnotify_group *group = NULL;
 281         __u32 test_mask = (mask & ALL_FSNOTIFY_EVENTS);
 282         __u32 marks_mask = 0;
 283         __u32 marks_ignored_mask = 0;
 284         struct fsnotify_mark *mark;
 285         int type;
 286
 287         if (WARN_ON(!iter_info->report_mask))
 288                 return 0;
 289
 290         /* clear ignored on inode modification */
 291         if (mask & FS_MODIFY) {
 292                 fsnotify_foreach_obj_type(type) {
 293                         if (!fsnotify_iter_should_report_type(iter_info, type))
 294                                 continue;
 295                         mark = iter_info->marks[type];
 296                         if (mark &&
 297                             !(mark->flags & FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY))
 298                                 mark->ignored_mask = 0;
 299                 }
 300         }
 301
 302         fsnotify_foreach_obj_type(type) {
 303                 if (!fsnotify_iter_should_report_type(iter_info, type))
 304                         continue;
 305                 mark = iter_info->marks[type];
 306                 /* does the object mark tell us to do something? */
 307                 if (mark) {
 308                         group = mark->group;
 309                         marks_mask |= mark->mask;
 310                         marks_ignored_mask |= mark->ignored_mask;
 311                 }
 312         }
 313
 314         pr_debug("%s: group=%p mask=%x marks_mask=%x marks_ignored_mask=%x data=%p data_type=%d dir=%p cookie=%d\n",
 315                  __func__, group, mask, marks_mask, marks_ignored_mask,
 316                  data, data_type, dir, cookie);
 317
 318         if (!(test_mask & marks_mask & ~marks_ignored_mask))
 319                 return 0;
 320
 321         if (group->ops->handle_event) {
 322                 return group->ops->handle_event(group, mask, data, data_type, dir,
 323                                                 file_name, cookie, iter_info);
 324         }
 325
 326         return fsnotify_handle_event(group, mask, data, data_type, dir,
 327                                      file_name, cookie, iter_info);
 328 }
 329
 330 static struct fsnotify_mark *fsnotify_first_mark(struct fsnotify_mark_connector **connp)
 331 {
 332         struct fsnotify_mark_connector *conn;
 333         struct hlist_node *node = NULL;
 334
 335         conn = srcu_dereference(*connp, &fsnotify_mark_srcu);
 336         if (conn)
 337                 node = srcu_dereference(conn->list.first, &fsnotify_mark_srcu);
 338
 339         return hlist_entry_safe(node, struct fsnotify_mark, obj_list);
 340 }
 341
 342 static struct fsnotify_mark *fsnotify_next_mark(struct fsnotify_mark *mark)
 343 {
 344         struct hlist_node *node = NULL;
 345
 346         if (mark)
 347                 node = srcu_dereference(mark->obj_list.next,
 348                                         &fsnotify_mark_srcu);
 349
 350         return hlist_entry_safe(node, struct fsnotify_mark, obj_list);
 351 }
 352
 353 /*
 354  * iter_info is a multi head priority queue of marks.
 355  * Pick a subset of marks from queue heads, all with the
 356  * same group and set the report_mask for selected subset.
 357  * Returns the report_mask of the selected subset.
 358  */
 359 static unsigned int fsnotify_iter_select_report_types(
 360                 struct fsnotify_iter_info *iter_info)
 361 {
 362         struct fsnotify_group *max_prio_group = NULL;
 363         struct fsnotify_mark *mark;
 364         int type;
 365
 366         /* Choose max prio group among groups of all queue heads */
 367         fsnotify_foreach_obj_type(type) {
 368                 mark = iter_info->marks[type];
 369                 if (mark &&
 370                     fsnotify_compare_groups(max_prio_group, mark->group) > 0)
 371                         max_prio_group = mark->group;
 372         }
 373
 374         if (!max_prio_group)
 375                 return 0;
 376
 377         /* Set the report mask for marks from same group as max prio group */
 378         iter_info->report_mask = 0;
 379         fsnotify_foreach_obj_type(type) {
 380                 mark = iter_info->marks[type];
 381                 if (mark &&
 382                     fsnotify_compare_groups(max_prio_group, mark->group) == 0)
 383                         fsnotify_iter_set_report_type(iter_info, type);
 384         }
 385
 386         return iter_info->report_mask;
 387 }
 388
 389 /*
 390  * Pop from iter_info multi head queue, the marks that were iterated in the
 391  * current iteration step.
 392  */
 393 static void fsnotify_iter_next(struct fsnotify_iter_info *iter_info)
 394 {
 395         int type;
 396
 397         fsnotify_foreach_obj_type(type) {
 398                 if (fsnotify_iter_should_report_type(iter_info, type))
 399                         iter_info->marks[type] =
 400                                 fsnotify_next_mark(iter_info->marks[type]);
 401         }
 402 }
 403
 404 /*
 405  * fsnotify - This is the main call to fsnotify.
 406  *
 407  * The VFS calls into hook specific functions in linux/fsnotify.h.
 408  * Those functions then in turn call here.  Here will call out to all of the
 409  * registered fsnotify_group.  Those groups can then use the notification event
 410  * in whatever means they feel necessary.
 411  *
 412  * @mask:       event type and flags
 413  * @data:       object that event happened on
 414  * @data_type:  type of object for fanotify_data_XXX() accessors
 415  * @dir:        optional directory associated with event -
 416  *              if @file_name is not NULL, this is the directory that
 417  *              @file_name is relative to
 418  * @file_name:  optional file name associated with event
 419  * @inode:      optional inode associated with event -
 420  *              either @dir or @inode must be non-NULL.
 421  *              if both are non-NULL event may be reported to both.
 422  * @cookie:     inotify rename cookie
 423  */
 424 int fsnotify(__u32 mask, const void *data, int data_type, struct inode *dir,
 425              const struct qstr *file_name, struct inode *inode, u32 cookie)
 426 {
 427         const struct path *path = fsnotify_data_path(data, data_type);
 428         struct fsnotify_iter_info iter_info = {};
 429         struct super_block *sb;
 430         struct mount *mnt = NULL;
 431         struct inode *child = NULL;
 432         int ret = 0;
 433         __u32 test_mask, marks_mask;
 434
 435         if (path)
 436                 mnt = real_mount(path->mnt);
 437
 438         if (!inode) {
 439                 /* Dirent event - report on TYPE_INODE to dir */
 440                 inode = dir;
 441         } else if (mask & FS_EVENT_ON_CHILD) {
 442                 /*
 443                  * Event on child - report on TYPE_INODE to dir if it is
 444                  * watching children and on TYPE_CHILD to child.
 445                  */
 446                 child = inode;
 447                 inode = dir;
 448         }
 449         sb = inode->i_sb;
 450
 451         /*
 452          * Optimization: srcu_read_lock() has a memory barrier which can
 453          * be expensive.  It protects walking the *_fsnotify_marks lists.
 454          * However, if we do not walk the lists, we do not have to do
 455          * SRCU because we have no references to any objects and do not
 456          * need SRCU to keep them "alive".
 457          */
 458         if (!sb->s_fsnotify_marks &&
 459             (!mnt || !mnt->mnt_fsnotify_marks) &&
 460             (!inode || !inode->i_fsnotify_marks) &&
 461             (!child || !child->i_fsnotify_marks))
 462                 return 0;
 463
 464         marks_mask = sb->s_fsnotify_mask;
 465         if (mnt)
 466                 marks_mask |= mnt->mnt_fsnotify_mask;
 467         if (inode)
 468                 marks_mask |= inode->i_fsnotify_mask;
 469         if (child)
 470                 marks_mask |= child->i_fsnotify_mask;
 471
 472
 473         /*
 474          * if this is a modify event we may need to clear the ignored masks
 475          * otherwise return if none of the marks care about this type of event.
 476          */
 477         test_mask = (mask & ALL_FSNOTIFY_EVENTS);
 478         if (!(mask & FS_MODIFY) && !(test_mask & marks_mask))
 479                 return 0;
 480
 481         iter_info.srcu_idx = srcu_read_lock(&fsnotify_mark_srcu);
 482
 483         iter_info.marks[FSNOTIFY_OBJ_TYPE_SB] =
 484                 fsnotify_first_mark(&sb->s_fsnotify_marks);
 485         if (mnt) {
 486                 iter_info.marks[FSNOTIFY_OBJ_TYPE_VFSMOUNT] =
 487                         fsnotify_first_mark(&mnt->mnt_fsnotify_marks);
 488         }
 489         if (inode) {
 490                 iter_info.marks[FSNOTIFY_OBJ_TYPE_INODE] =
 491                         fsnotify_first_mark(&inode->i_fsnotify_marks);
 492         }
 493         if (child) {
 494                 iter_info.marks[FSNOTIFY_OBJ_TYPE_CHILD] =
 495                         fsnotify_first_mark(&child->i_fsnotify_marks);
 496         }
 497
 498         /*
 499          * We need to merge inode/vfsmount/sb mark lists so that e.g. inode mark
 500          * ignore masks are properly reflected for mount/sb mark notifications.
 501          * That's why this traversal is so complicated...
 502          */
 503         while (fsnotify_iter_select_report_types(&iter_info)) {
 504                 ret = send_to_group(mask, data, data_type, dir, file_name,
 505                                     cookie, &iter_info);
 506
 507                 if (ret && (mask & ALL_FSNOTIFY_PERM_EVENTS))
 508                         goto out;
 509
 510                 fsnotify_iter_next(&iter_info);
 511         }
 512         ret = 0;
 513 out:
 514         srcu_read_unlock(&fsnotify_mark_srcu, iter_info.srcu_idx);
 515
 516         return ret;
 517 }
 518 EXPORT_SYMBOL_GPL(fsnotify);
 519
 520 static __init int fsnotify_init(void)
 521 {
 522         int ret;
 523
 524         BUILD_BUG_ON(HWEIGHT32(ALL_FSNOTIFY_BITS) != 25);
 525
 526         ret = init_srcu_struct(&fsnotify_mark_srcu);
 527         if (ret)
 528                 panic("initializing fsnotify_mark_srcu");
 529
 530         fsnotify_mark_connector_cachep = KMEM_CACHE(fsnotify_mark_connector,
 531                                                     SLAB_PANIC);
 532
 533         return 0;
 534 }
 535 core_initcall(fsnotify_init);