fs/notify/fsnotify.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *  Copyright (C) 2008 Red Hat, Inc., Eric Paris <[email protected]>
   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 }
  91
  92 void fsnotify_sb_delete(struct super_block *sb)
  93 {
  94         fsnotify_unmount_inodes(sb);
  95         fsnotify_clear_marks_by_sb(sb);
  96         /* Wait for outstanding object references from connectors */
  97         wait_var_event(&sb->s_fsnotify_connectors,
  98                        !atomic_long_read(&sb->s_fsnotify_connectors));
  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         /*
 156          * All events that are possible on child can also may be reported with
 157          * parent/name info to inode/sb/mount.  Otherwise, a watching parent
 158          * could result in events reported with unexpected name info to sb/mount.
 159          */
 160         BUILD_BUG_ON(FS_EVENTS_POSS_ON_CHILD & ~FS_EVENTS_POSS_TO_PARENT);
 161
 162         /* Did either inode/sb/mount subscribe for events with parent/name? */
 163         marks_mask |= fsnotify_parent_needed_mask(inode->i_fsnotify_mask);
 164         marks_mask |= fsnotify_parent_needed_mask(inode->i_sb->s_fsnotify_mask);
 165         if (mnt)
 166                 marks_mask |= fsnotify_parent_needed_mask(mnt->mnt_fsnotify_mask);
 167
 168         /* Did they subscribe for this event with parent/name info? */
 169         return mask & marks_mask;
 170 }
 171
 172 /*
 173  * Notify this dentry's parent about a child's events with child name info
 174  * if parent is watching or if inode/sb/mount are interested in events with
 175  * parent and name info.
 176  *
 177  * Notify only the child without name info if parent is not watching and
 178  * inode/sb/mount are not interested in events with parent and name info.
 179  */
 180 int __fsnotify_parent(struct dentry *dentry, __u32 mask, const void *data,
 181                       int data_type)
 182 {
 183         const struct path *path = fsnotify_data_path(data, data_type);
 184         struct mount *mnt = path ? real_mount(path->mnt) : NULL;
 185         struct inode *inode = d_inode(dentry);
 186         struct dentry *parent;
 187         bool parent_watched = dentry->d_flags & DCACHE_FSNOTIFY_PARENT_WATCHED;
 188         bool parent_needed, parent_interested;
 189         __u32 p_mask;
 190         struct inode *p_inode = NULL;
 191         struct name_snapshot name;
 192         struct qstr *file_name = NULL;
 193         int ret = 0;
 194
 195         /*
 196          * Do inode/sb/mount care about parent and name info on non-dir?
 197          * Do they care about any event at all?
 198          */
 199         if (!inode->i_fsnotify_marks && !inode->i_sb->s_fsnotify_marks &&
 200             (!mnt || !mnt->mnt_fsnotify_marks) && !parent_watched)
 201                 return 0;
 202
 203         parent = NULL;
 204         parent_needed = fsnotify_event_needs_parent(inode, mnt, mask);
 205         if (!parent_watched && !parent_needed)
 206                 goto notify;
 207
 208         /* Does parent inode care about events on children? */
 209         parent = dget_parent(dentry);
 210         p_inode = parent->d_inode;
 211         p_mask = fsnotify_inode_watches_children(p_inode);
 212         if (unlikely(parent_watched && !p_mask))
 213                 __fsnotify_update_child_dentry_flags(p_inode);
 214
 215         /*
 216          * Include parent/name in notification either if some notification
 217          * groups require parent info or the parent is interested in this event.
 218          */
 219         parent_interested = mask & p_mask & ALL_FSNOTIFY_EVENTS;
 220         if (parent_needed || parent_interested) {
 221                 /* When notifying parent, child should be passed as data */
 222                 WARN_ON_ONCE(inode != fsnotify_data_inode(data, data_type));
 223
 224                 /* Notify both parent and child with child name info */
 225                 take_dentry_name_snapshot(&name, dentry);
 226                 file_name = &name.name;
 227                 if (parent_interested)
 228                         mask |= FS_EVENT_ON_CHILD;
 229         }
 230
 231 notify:
 232         ret = fsnotify(mask, data, data_type, p_inode, file_name, inode, 0);
 233
 234         if (file_name)
 235                 release_dentry_name_snapshot(&name);
 236         dput(parent);
 237
 238         return ret;
 239 }
 240 EXPORT_SYMBOL_GPL(__fsnotify_parent);
 241
 242 static int fsnotify_handle_inode_event(struct fsnotify_group *group,
 243                                        struct fsnotify_mark *inode_mark,
 244                                        u32 mask, const void *data, int data_type,
 245                                        struct inode *dir, const struct qstr *name,
 246                                        u32 cookie)
 247 {
 248         const struct path *path = fsnotify_data_path(data, data_type);
 249         struct inode *inode = fsnotify_data_inode(data, data_type);
 250         const struct fsnotify_ops *ops = group->ops;
 251
 252         if (WARN_ON_ONCE(!ops->handle_inode_event))
 253                 return 0;
 254
 255         if (WARN_ON_ONCE(!inode && !dir))
 256                 return 0;
 257
 258         if ((inode_mark->mask & FS_EXCL_UNLINK) &&
 259             path && d_unlinked(path->dentry))
 260                 return 0;
 261
 262         /* Check interest of this mark in case event was sent with two marks */
 263         if (!(mask & inode_mark->mask & ALL_FSNOTIFY_EVENTS))
 264                 return 0;
 265
 266         return ops->handle_inode_event(inode_mark, mask, inode, dir, name, cookie);
 267 }
 268
 269 static int fsnotify_handle_event(struct fsnotify_group *group, __u32 mask,
 270                                  const void *data, int data_type,
 271                                  struct inode *dir, const struct qstr *name,
 272                                  u32 cookie, struct fsnotify_iter_info *iter_info)
 273 {
 274         struct fsnotify_mark *inode_mark = fsnotify_iter_inode_mark(iter_info);
 275         struct fsnotify_mark *parent_mark = fsnotify_iter_parent_mark(iter_info);
 276         int ret;
 277
 278         if (WARN_ON_ONCE(fsnotify_iter_sb_mark(iter_info)) ||
 279             WARN_ON_ONCE(fsnotify_iter_vfsmount_mark(iter_info)))
 280                 return 0;
 281
 282         /*
 283          * For FS_RENAME, 'dir' is old dir and 'data' is new dentry.
 284          * The only ->handle_inode_event() backend that supports FS_RENAME is
 285          * dnotify, where it means file was renamed within same parent.
 286          */
 287         if (mask & FS_RENAME) {
 288                 struct dentry *moved = fsnotify_data_dentry(data, data_type);
 289
 290                 if (dir != moved->d_parent->d_inode)
 291                         return 0;
 292         }
 293
 294         if (parent_mark) {
 295                 /*
 296                  * parent_mark indicates that the parent inode is watching
 297                  * children and interested in this event, which is an event
 298                  * possible on child. But is *this mark* watching children and
 299                  * interested in this event?
 300                  */
 301                 if (parent_mark->mask & FS_EVENT_ON_CHILD) {
 302                         ret = fsnotify_handle_inode_event(group, parent_mark, mask,
 303                                                           data, data_type, dir, name, 0);
 304                         if (ret)
 305                                 return ret;
 306                 }
 307                 if (!inode_mark)
 308                         return 0;
 309         }
 310
 311         if (mask & FS_EVENT_ON_CHILD) {
 312                 /*
 313                  * Some events can be sent on both parent dir and child marks
 314                  * (e.g. FS_ATTRIB).  If both parent dir and child are
 315                  * watching, report the event once to parent dir with name (if
 316                  * interested) and once to child without name (if interested).
 317                  * The child watcher is expecting an event without a file name
 318                  * and without the FS_EVENT_ON_CHILD flag.
 319                  */
 320                 mask &= ~FS_EVENT_ON_CHILD;
 321                 dir = NULL;
 322                 name = NULL;
 323         }
 324
 325         return fsnotify_handle_inode_event(group, inode_mark, mask, data, data_type,
 326                                            dir, name, cookie);
 327 }
 328
 329 static int send_to_group(__u32 mask, const void *data, int data_type,
 330                          struct inode *dir, const struct qstr *file_name,
 331                          u32 cookie, struct fsnotify_iter_info *iter_info)
 332 {
 333         struct fsnotify_group *group = NULL;
 334         __u32 test_mask = (mask & ALL_FSNOTIFY_EVENTS);
 335         __u32 marks_mask = 0;
 336         __u32 marks_ignored_mask = 0;
 337         struct fsnotify_mark *mark;
 338         int type;
 339
 340         if (WARN_ON(!iter_info->report_mask))
 341                 return 0;
 342
 343         /* clear ignored on inode modification */
 344         if (mask & FS_MODIFY) {
 345                 fsnotify_foreach_iter_type(type) {
 346                         if (!fsnotify_iter_should_report_type(iter_info, type))
 347                                 continue;
 348                         mark = iter_info->marks[type];
 349                         if (mark &&
 350                             !(mark->flags & FSNOTIFY_MARK_FLAG_IGNORED_SURV_MODIFY))
 351                                 mark->ignored_mask = 0;
 352                 }
 353         }
 354
 355         fsnotify_foreach_iter_type(type) {
 356                 if (!fsnotify_iter_should_report_type(iter_info, type))
 357                         continue;
 358                 mark = iter_info->marks[type];
 359                 /* does the object mark tell us to do something? */
 360                 if (mark) {
 361                         group = mark->group;
 362                         marks_mask |= mark->mask;
 363                         marks_ignored_mask |= mark->ignored_mask;
 364                 }
 365         }
 366
 367         pr_debug("%s: group=%p mask=%x marks_mask=%x marks_ignored_mask=%x data=%p data_type=%d dir=%p cookie=%d\n",
 368                  __func__, group, mask, marks_mask, marks_ignored_mask,
 369                  data, data_type, dir, cookie);
 370
 371         if (!(test_mask & marks_mask & ~marks_ignored_mask))
 372                 return 0;
 373
 374         if (group->ops->handle_event) {
 375                 return group->ops->handle_event(group, mask, data, data_type, dir,
 376                                                 file_name, cookie, iter_info);
 377         }
 378
 379         return fsnotify_handle_event(group, mask, data, data_type, dir,
 380                                      file_name, cookie, iter_info);
 381 }
 382
 383 static struct fsnotify_mark *fsnotify_first_mark(struct fsnotify_mark_connector **connp)
 384 {
 385         struct fsnotify_mark_connector *conn;
 386         struct hlist_node *node = NULL;
 387
 388         conn = srcu_dereference(*connp, &fsnotify_mark_srcu);
 389         if (conn)
 390                 node = srcu_dereference(conn->list.first, &fsnotify_mark_srcu);
 391
 392         return hlist_entry_safe(node, struct fsnotify_mark, obj_list);
 393 }
 394
 395 static struct fsnotify_mark *fsnotify_next_mark(struct fsnotify_mark *mark)
 396 {
 397         struct hlist_node *node = NULL;
 398
 399         if (mark)
 400                 node = srcu_dereference(mark->obj_list.next,
 401                                         &fsnotify_mark_srcu);
 402
 403         return hlist_entry_safe(node, struct fsnotify_mark, obj_list);
 404 }
 405
 406 /*
 407  * iter_info is a multi head priority queue of marks.
 408  * Pick a subset of marks from queue heads, all with the
 409  * same group and set the report_mask for selected subset.
 410  * Returns the report_mask of the selected subset.
 411  */
 412 static unsigned int fsnotify_iter_select_report_types(
 413                 struct fsnotify_iter_info *iter_info)
 414 {
 415         struct fsnotify_group *max_prio_group = NULL;
 416         struct fsnotify_mark *mark;
 417         int type;
 418
 419         /* Choose max prio group among groups of all queue heads */
 420         fsnotify_foreach_iter_type(type) {
 421                 mark = iter_info->marks[type];
 422                 if (mark &&
 423                     fsnotify_compare_groups(max_prio_group, mark->group) > 0)
 424                         max_prio_group = mark->group;
 425         }
 426
 427         if (!max_prio_group)
 428                 return 0;
 429
 430         /* Set the report mask for marks from same group as max prio group */
 431         iter_info->report_mask = 0;
 432         fsnotify_foreach_iter_type(type) {
 433                 mark = iter_info->marks[type];
 434                 if (mark &&
 435                     fsnotify_compare_groups(max_prio_group, mark->group) == 0)
 436                         fsnotify_iter_set_report_type(iter_info, type);
 437         }
 438
 439         return iter_info->report_mask;
 440 }
 441
 442 /*
 443  * Pop from iter_info multi head queue, the marks that were iterated in the
 444  * current iteration step.
 445  */
 446 static void fsnotify_iter_next(struct fsnotify_iter_info *iter_info)
 447 {
 448         int type;
 449
 450         fsnotify_foreach_iter_type(type) {
 451                 if (fsnotify_iter_should_report_type(iter_info, type))
 452                         iter_info->marks[type] =
 453                                 fsnotify_next_mark(iter_info->marks[type]);
 454         }
 455 }
 456
 457 /*
 458  * fsnotify - This is the main call to fsnotify.
 459  *
 460  * The VFS calls into hook specific functions in linux/fsnotify.h.
 461  * Those functions then in turn call here.  Here will call out to all of the
 462  * registered fsnotify_group.  Those groups can then use the notification event
 463  * in whatever means they feel necessary.
 464  *
 465  * @mask:       event type and flags
 466  * @data:       object that event happened on
 467  * @data_type:  type of object for fanotify_data_XXX() accessors
 468  * @dir:        optional directory associated with event -
 469  *              if @file_name is not NULL, this is the directory that
 470  *              @file_name is relative to
 471  * @file_name:  optional file name associated with event
 472  * @inode:      optional inode associated with event -
 473  *              If @dir and @inode are both non-NULL, event may be
 474  *              reported to both.
 475  * @cookie:     inotify rename cookie
 476  */
 477 int fsnotify(__u32 mask, const void *data, int data_type, struct inode *dir,
 478              const struct qstr *file_name, struct inode *inode, u32 cookie)
 479 {
 480         const struct path *path = fsnotify_data_path(data, data_type);
 481         struct super_block *sb = fsnotify_data_sb(data, data_type);
 482         struct fsnotify_iter_info iter_info = {};
 483         struct mount *mnt = NULL;
 484         struct inode *inode2 = NULL;
 485         struct dentry *moved;
 486         int inode2_type;
 487         int ret = 0;
 488         __u32 test_mask, marks_mask;
 489
 490         if (path)
 491                 mnt = real_mount(path->mnt);
 492
 493         if (!inode) {
 494                 /* Dirent event - report on TYPE_INODE to dir */
 495                 inode = dir;
 496                 /* For FS_RENAME, inode is old_dir and inode2 is new_dir */
 497                 if (mask & FS_RENAME) {
 498                         moved = fsnotify_data_dentry(data, data_type);
 499                         inode2 = moved->d_parent->d_inode;
 500                         inode2_type = FSNOTIFY_ITER_TYPE_INODE2;
 501                 }
 502         } else if (mask & FS_EVENT_ON_CHILD) {
 503                 /*
 504                  * Event on child - report on TYPE_PARENT to dir if it is
 505                  * watching children and on TYPE_INODE to child.
 506                  */
 507                 inode2 = dir;
 508                 inode2_type = FSNOTIFY_ITER_TYPE_PARENT;
 509         }
 510
 511         /*
 512          * Optimization: srcu_read_lock() has a memory barrier which can
 513          * be expensive.  It protects walking the *_fsnotify_marks lists.
 514          * However, if we do not walk the lists, we do not have to do
 515          * SRCU because we have no references to any objects and do not
 516          * need SRCU to keep them "alive".
 517          */
 518         if (!sb->s_fsnotify_marks &&
 519             (!mnt || !mnt->mnt_fsnotify_marks) &&
 520             (!inode || !inode->i_fsnotify_marks) &&
 521             (!inode2 || !inode2->i_fsnotify_marks))
 522                 return 0;
 523
 524         marks_mask = sb->s_fsnotify_mask;
 525         if (mnt)
 526                 marks_mask |= mnt->mnt_fsnotify_mask;
 527         if (inode)
 528                 marks_mask |= inode->i_fsnotify_mask;
 529         if (inode2)
 530                 marks_mask |= inode2->i_fsnotify_mask;
 531
 532
 533         /*
 534          * if this is a modify event we may need to clear the ignored masks
 535          * otherwise return if none of the marks care about this type of event.
 536          */
 537         test_mask = (mask & ALL_FSNOTIFY_EVENTS);
 538         if (!(mask & FS_MODIFY) && !(test_mask & marks_mask))
 539                 return 0;
 540
 541         iter_info.srcu_idx = srcu_read_lock(&fsnotify_mark_srcu);
 542
 543         iter_info.marks[FSNOTIFY_ITER_TYPE_SB] =
 544                 fsnotify_first_mark(&sb->s_fsnotify_marks);
 545         if (mnt) {
 546                 iter_info.marks[FSNOTIFY_ITER_TYPE_VFSMOUNT] =
 547                         fsnotify_first_mark(&mnt->mnt_fsnotify_marks);
 548         }
 549         if (inode) {
 550                 iter_info.marks[FSNOTIFY_ITER_TYPE_INODE] =
 551                         fsnotify_first_mark(&inode->i_fsnotify_marks);
 552         }
 553         if (inode2) {
 554                 iter_info.marks[inode2_type] =
 555                         fsnotify_first_mark(&inode2->i_fsnotify_marks);
 556         }
 557
 558         /*
 559          * We need to merge inode/vfsmount/sb mark lists so that e.g. inode mark
 560          * ignore masks are properly reflected for mount/sb mark notifications.
 561          * That's why this traversal is so complicated...
 562          */
 563         while (fsnotify_iter_select_report_types(&iter_info)) {
 564                 ret = send_to_group(mask, data, data_type, dir, file_name,
 565                                     cookie, &iter_info);
 566
 567                 if (ret && (mask & ALL_FSNOTIFY_PERM_EVENTS))
 568                         goto out;
 569
 570                 fsnotify_iter_next(&iter_info);
 571         }
 572         ret = 0;
 573 out:
 574         srcu_read_unlock(&fsnotify_mark_srcu, iter_info.srcu_idx);
 575
 576         return ret;
 577 }
 578 EXPORT_SYMBOL_GPL(fsnotify);
 579
 580 static __init int fsnotify_init(void)
 581 {
 582         int ret;
 583
 584         BUILD_BUG_ON(HWEIGHT32(ALL_FSNOTIFY_BITS) != 25);
 585
 586         ret = init_srcu_struct(&fsnotify_mark_srcu);
 587         if (ret)
 588                 panic("initializing fsnotify_mark_srcu");
 589
 590         fsnotify_mark_connector_cachep = KMEM_CACHE(fsnotify_mark_connector,
 591                                                     SLAB_PANIC);
 592
 593         return 0;
 594 }
 595 core_initcall(fsnotify_init);