fs/notify/mark.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 /*
   7  * fsnotify inode mark locking/lifetime/and refcnting
   8  *
   9  * REFCNT:
  10  * The group->recnt and mark->refcnt tell how many "things" in the kernel
  11  * currently are referencing the objects. Both kind of objects typically will
  12  * live inside the kernel with a refcnt of 2, one for its creation and one for
  13  * the reference a group and a mark hold to each other.
  14  * If you are holding the appropriate locks, you can take a reference and the
  15  * object itself is guaranteed to survive until the reference is dropped.
  16  *
  17  * LOCKING:
  18  * There are 3 locks involved with fsnotify inode marks and they MUST be taken
  19  * in order as follows:
  20  *
  21  * group->mark_mutex
  22  * mark->lock
  23  * mark->connector->lock
  24  *
  25  * group->mark_mutex protects the marks_list anchored inside a given group and
  26  * each mark is hooked via the g_list.  It also protects the groups private
  27  * data (i.e group limits).
  28
  29  * mark->lock protects the marks attributes like its masks and flags.
  30  * Furthermore it protects the access to a reference of the group that the mark
  31  * is assigned to as well as the access to a reference of the inode/vfsmount
  32  * that is being watched by the mark.
  33  *
  34  * mark->connector->lock protects the list of marks anchored inside an
  35  * inode / vfsmount and each mark is hooked via the i_list.
  36  *
  37  * A list of notification marks relating to inode / mnt is contained in
  38  * fsnotify_mark_connector. That structure is alive as long as there are any
  39  * marks in the list and is also protected by fsnotify_mark_srcu. A mark gets
  40  * detached from fsnotify_mark_connector when last reference to the mark is
  41  * dropped.  Thus having mark reference is enough to protect mark->connector
  42  * pointer and to make sure fsnotify_mark_connector cannot disappear. Also
  43  * because we remove mark from g_list before dropping mark reference associated
  44  * with that, any mark found through g_list is guaranteed to have
  45  * mark->connector set until we drop group->mark_mutex.
  46  *
  47  * LIFETIME:
  48  * Inode marks survive between when they are added to an inode and when their
  49  * refcnt==0. Marks are also protected by fsnotify_mark_srcu.
  50  *
  51  * The inode mark can be cleared for a number of different reasons including:
  52  * - The inode is unlinked for the last time.  (fsnotify_inode_remove)
  53  * - The inode is being evicted from cache. (fsnotify_inode_delete)
  54  * - The fs the inode is on is unmounted.  (fsnotify_inode_delete/fsnotify_unmount_inodes)
  55  * - Something explicitly requests that it be removed.  (fsnotify_destroy_mark)
  56  * - The fsnotify_group associated with the mark is going away and all such marks
  57  *   need to be cleaned up. (fsnotify_clear_marks_by_group)
  58  *
  59  * This has the very interesting property of being able to run concurrently with
  60  * any (or all) other directions.
  61  */
  62
  63 #include <linux/fs.h>
  64 #include <linux/init.h>
  65 #include <linux/kernel.h>
  66 #include <linux/kthread.h>
  67 #include <linux/module.h>
  68 #include <linux/mutex.h>
  69 #include <linux/slab.h>
  70 #include <linux/spinlock.h>
  71 #include <linux/srcu.h>
  72 #include <linux/ratelimit.h>
  73
  74 #include <linux/atomic.h>
  75
  76 #include <linux/fsnotify_backend.h>
  77 #include "fsnotify.h"
  78
  79 #define FSNOTIFY_REAPER_DELAY   (1)     /* 1 jiffy */
  80
  81 struct srcu_struct fsnotify_mark_srcu;
  82 struct kmem_cache *fsnotify_mark_connector_cachep;
  83
  84 static DEFINE_SPINLOCK(destroy_lock);
  85 static LIST_HEAD(destroy_list);
  86 static struct fsnotify_mark_connector *connector_destroy_list;
  87
  88 static void fsnotify_mark_destroy_workfn(struct work_struct *work);
  89 static DECLARE_DELAYED_WORK(reaper_work, fsnotify_mark_destroy_workfn);
  90
  91 static void fsnotify_connector_destroy_workfn(struct work_struct *work);
  92 static DECLARE_WORK(connector_reaper_work, fsnotify_connector_destroy_workfn);
  93
  94 void fsnotify_get_mark(struct fsnotify_mark *mark)
  95 {
  96         WARN_ON_ONCE(!refcount_read(&mark->refcnt));
  97         refcount_inc(&mark->refcnt);
  98 }
  99
 100 static __u32 *fsnotify_conn_mask_p(struct fsnotify_mark_connector *conn)
 101 {
 102         if (conn->type == FSNOTIFY_OBJ_TYPE_INODE)
 103                 return &fsnotify_conn_inode(conn)->i_fsnotify_mask;
 104         else if (conn->type == FSNOTIFY_OBJ_TYPE_VFSMOUNT)
 105                 return &fsnotify_conn_mount(conn)->mnt_fsnotify_mask;
 106         else if (conn->type == FSNOTIFY_OBJ_TYPE_SB)
 107                 return &fsnotify_conn_sb(conn)->s_fsnotify_mask;
 108         return NULL;
 109 }
 110
 111 __u32 fsnotify_conn_mask(struct fsnotify_mark_connector *conn)
 112 {
 113         if (WARN_ON(!fsnotify_valid_obj_type(conn->type)))
 114                 return 0;
 115
 116         return *fsnotify_conn_mask_p(conn);
 117 }
 118
 119 static void __fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
 120 {
 121         u32 new_mask = 0;
 122         struct fsnotify_mark *mark;
 123
 124         assert_spin_locked(&conn->lock);
 125         /* We can get detached connector here when inode is getting unlinked. */
 126         if (!fsnotify_valid_obj_type(conn->type))
 127                 return;
 128         hlist_for_each_entry(mark, &conn->list, obj_list) {
 129                 if (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)
 130                         new_mask |= mark->mask;
 131         }
 132         *fsnotify_conn_mask_p(conn) = new_mask;
 133 }
 134
 135 /*
 136  * Calculate mask of events for a list of marks. The caller must make sure
 137  * connector and connector->obj cannot disappear under us.  Callers achieve
 138  * this by holding a mark->lock or mark->group->mark_mutex for a mark on this
 139  * list.
 140  */
 141 void fsnotify_recalc_mask(struct fsnotify_mark_connector *conn)
 142 {
 143         if (!conn)
 144                 return;
 145
 146         spin_lock(&conn->lock);
 147         __fsnotify_recalc_mask(conn);
 148         spin_unlock(&conn->lock);
 149         if (conn->type == FSNOTIFY_OBJ_TYPE_INODE)
 150                 __fsnotify_update_child_dentry_flags(
 151                                         fsnotify_conn_inode(conn));
 152 }
 153
 154 /* Free all connectors queued for freeing once SRCU period ends */
 155 static void fsnotify_connector_destroy_workfn(struct work_struct *work)
 156 {
 157         struct fsnotify_mark_connector *conn, *free;
 158
 159         spin_lock(&destroy_lock);
 160         conn = connector_destroy_list;
 161         connector_destroy_list = NULL;
 162         spin_unlock(&destroy_lock);
 163
 164         synchronize_srcu(&fsnotify_mark_srcu);
 165         while (conn) {
 166                 free = conn;
 167                 conn = conn->destroy_next;
 168                 kmem_cache_free(fsnotify_mark_connector_cachep, free);
 169         }
 170 }
 171
 172 static void fsnotify_get_inode_ref(struct inode *inode)
 173 {
 174         ihold(inode);
 175         atomic_long_inc(&inode->i_sb->s_fsnotify_inode_refs);
 176 }
 177
 178 static void fsnotify_put_inode_ref(struct inode *inode)
 179 {
 180         struct super_block *sb = inode->i_sb;
 181
 182         iput(inode);
 183         if (atomic_long_dec_and_test(&sb->s_fsnotify_inode_refs))
 184                 wake_up_var(&sb->s_fsnotify_inode_refs);
 185 }
 186
 187 static void *fsnotify_detach_connector_from_object(
 188                                         struct fsnotify_mark_connector *conn,
 189                                         unsigned int *type)
 190 {
 191         struct inode *inode = NULL;
 192
 193         *type = conn->type;
 194         if (conn->type == FSNOTIFY_OBJ_TYPE_DETACHED)
 195                 return NULL;
 196
 197         if (conn->type == FSNOTIFY_OBJ_TYPE_INODE) {
 198                 inode = fsnotify_conn_inode(conn);
 199                 inode->i_fsnotify_mask = 0;
 200         } else if (conn->type == FSNOTIFY_OBJ_TYPE_VFSMOUNT) {
 201                 fsnotify_conn_mount(conn)->mnt_fsnotify_mask = 0;
 202         } else if (conn->type == FSNOTIFY_OBJ_TYPE_SB) {
 203                 fsnotify_conn_sb(conn)->s_fsnotify_mask = 0;
 204         }
 205
 206         rcu_assign_pointer(*(conn->obj), NULL);
 207         conn->obj = NULL;
 208         conn->type = FSNOTIFY_OBJ_TYPE_DETACHED;
 209
 210         return inode;
 211 }
 212
 213 static void fsnotify_final_mark_destroy(struct fsnotify_mark *mark)
 214 {
 215         struct fsnotify_group *group = mark->group;
 216
 217         if (WARN_ON_ONCE(!group))
 218                 return;
 219         group->ops->free_mark(mark);
 220         fsnotify_put_group(group);
 221 }
 222
 223 /* Drop object reference originally held by a connector */
 224 static void fsnotify_drop_object(unsigned int type, void *objp)
 225 {
 226         if (!objp)
 227                 return;
 228         /* Currently only inode references are passed to be dropped */
 229         if (WARN_ON_ONCE(type != FSNOTIFY_OBJ_TYPE_INODE))
 230                 return;
 231         fsnotify_put_inode_ref(objp);
 232 }
 233
 234 void fsnotify_put_mark(struct fsnotify_mark *mark)
 235 {
 236         struct fsnotify_mark_connector *conn = READ_ONCE(mark->connector);
 237         void *objp = NULL;
 238         unsigned int type = FSNOTIFY_OBJ_TYPE_DETACHED;
 239         bool free_conn = false;
 240
 241         /* Catch marks that were actually never attached to object */
 242         if (!conn) {
 243                 if (refcount_dec_and_test(&mark->refcnt))
 244                         fsnotify_final_mark_destroy(mark);
 245                 return;
 246         }
 247
 248         /*
 249          * We have to be careful so that traversals of obj_list under lock can
 250          * safely grab mark reference.
 251          */
 252         if (!refcount_dec_and_lock(&mark->refcnt, &conn->lock))
 253                 return;
 254
 255         hlist_del_init_rcu(&mark->obj_list);
 256         if (hlist_empty(&conn->list)) {
 257                 objp = fsnotify_detach_connector_from_object(conn, &type);
 258                 free_conn = true;
 259         } else {
 260                 __fsnotify_recalc_mask(conn);
 261         }
 262         WRITE_ONCE(mark->connector, NULL);
 263         spin_unlock(&conn->lock);
 264
 265         fsnotify_drop_object(type, objp);
 266
 267         if (free_conn) {
 268                 spin_lock(&destroy_lock);
 269                 conn->destroy_next = connector_destroy_list;
 270                 connector_destroy_list = conn;
 271                 spin_unlock(&destroy_lock);
 272                 queue_work(system_unbound_wq, &connector_reaper_work);
 273         }
 274         /*
 275          * Note that we didn't update flags telling whether inode cares about
 276          * what's happening with children. We update these flags from
 277          * __fsnotify_parent() lazily when next event happens on one of our
 278          * children.
 279          */
 280         spin_lock(&destroy_lock);
 281         list_add(&mark->g_list, &destroy_list);
 282         spin_unlock(&destroy_lock);
 283         queue_delayed_work(system_unbound_wq, &reaper_work,
 284                            FSNOTIFY_REAPER_DELAY);
 285 }
 286 EXPORT_SYMBOL_GPL(fsnotify_put_mark);
 287
 288 /*
 289  * Get mark reference when we found the mark via lockless traversal of object
 290  * list. Mark can be already removed from the list by now and on its way to be
 291  * destroyed once SRCU period ends.
 292  *
 293  * Also pin the group so it doesn't disappear under us.
 294  */
 295 static bool fsnotify_get_mark_safe(struct fsnotify_mark *mark)
 296 {
 297         if (!mark)
 298                 return true;
 299
 300         if (refcount_inc_not_zero(&mark->refcnt)) {
 301                 spin_lock(&mark->lock);
 302                 if (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED) {
 303                         /* mark is attached, group is still alive then */
 304                         atomic_inc(&mark->group->user_waits);
 305                         spin_unlock(&mark->lock);
 306                         return true;
 307                 }
 308                 spin_unlock(&mark->lock);
 309                 fsnotify_put_mark(mark);
 310         }
 311         return false;
 312 }
 313
 314 /*
 315  * Puts marks and wakes up group destruction if necessary.
 316  *
 317  * Pairs with fsnotify_get_mark_safe()
 318  */
 319 static void fsnotify_put_mark_wake(struct fsnotify_mark *mark)
 320 {
 321         if (mark) {
 322                 struct fsnotify_group *group = mark->group;
 323
 324                 fsnotify_put_mark(mark);
 325                 /*
 326                  * We abuse notification_waitq on group shutdown for waiting for
 327                  * all marks pinned when waiting for userspace.
 328                  */
 329                 if (atomic_dec_and_test(&group->user_waits) && group->shutdown)
 330                         wake_up(&group->notification_waitq);
 331         }
 332 }
 333
 334 bool fsnotify_prepare_user_wait(struct fsnotify_iter_info *iter_info)
 335         __releases(&fsnotify_mark_srcu)
 336 {
 337         int type;
 338
 339         fsnotify_foreach_obj_type(type) {
 340                 /* This can fail if mark is being removed */
 341                 if (!fsnotify_get_mark_safe(iter_info->marks[type])) {
 342                         __release(&fsnotify_mark_srcu);
 343                         goto fail;
 344                 }
 345         }
 346
 347         /*
 348          * Now that both marks are pinned by refcount in the inode / vfsmount
 349          * lists, we can drop SRCU lock, and safely resume the list iteration
 350          * once userspace returns.
 351          */
 352         srcu_read_unlock(&fsnotify_mark_srcu, iter_info->srcu_idx);
 353
 354         return true;
 355
 356 fail:
 357         for (type--; type >= 0; type--)
 358                 fsnotify_put_mark_wake(iter_info->marks[type]);
 359         return false;
 360 }
 361
 362 void fsnotify_finish_user_wait(struct fsnotify_iter_info *iter_info)
 363         __acquires(&fsnotify_mark_srcu)
 364 {
 365         int type;
 366
 367         iter_info->srcu_idx = srcu_read_lock(&fsnotify_mark_srcu);
 368         fsnotify_foreach_obj_type(type)
 369                 fsnotify_put_mark_wake(iter_info->marks[type]);
 370 }
 371
 372 /*
 373  * Mark mark as detached, remove it from group list. Mark still stays in object
 374  * list until its last reference is dropped. Note that we rely on mark being
 375  * removed from group list before corresponding reference to it is dropped. In
 376  * particular we rely on mark->connector being valid while we hold
 377  * group->mark_mutex if we found the mark through g_list.
 378  *
 379  * Must be called with group->mark_mutex held. The caller must either hold
 380  * reference to the mark or be protected by fsnotify_mark_srcu.
 381  */
 382 void fsnotify_detach_mark(struct fsnotify_mark *mark)
 383 {
 384         struct fsnotify_group *group = mark->group;
 385
 386         WARN_ON_ONCE(!mutex_is_locked(&group->mark_mutex));
 387         WARN_ON_ONCE(!srcu_read_lock_held(&fsnotify_mark_srcu) &&
 388                      refcount_read(&mark->refcnt) < 1 +
 389                         !!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED));
 390
 391         spin_lock(&mark->lock);
 392         /* something else already called this function on this mark */
 393         if (!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
 394                 spin_unlock(&mark->lock);
 395                 return;
 396         }
 397         mark->flags &= ~FSNOTIFY_MARK_FLAG_ATTACHED;
 398         list_del_init(&mark->g_list);
 399         spin_unlock(&mark->lock);
 400
 401         /* Drop mark reference acquired in fsnotify_add_mark_locked() */
 402         fsnotify_put_mark(mark);
 403 }
 404
 405 /*
 406  * Free fsnotify mark. The mark is actually only marked as being freed.  The
 407  * freeing is actually happening only once last reference to the mark is
 408  * dropped from a workqueue which first waits for srcu period end.
 409  *
 410  * Caller must have a reference to the mark or be protected by
 411  * fsnotify_mark_srcu.
 412  */
 413 void fsnotify_free_mark(struct fsnotify_mark *mark)
 414 {
 415         struct fsnotify_group *group = mark->group;
 416
 417         spin_lock(&mark->lock);
 418         /* something else already called this function on this mark */
 419         if (!(mark->flags & FSNOTIFY_MARK_FLAG_ALIVE)) {
 420                 spin_unlock(&mark->lock);
 421                 return;
 422         }
 423         mark->flags &= ~FSNOTIFY_MARK_FLAG_ALIVE;
 424         spin_unlock(&mark->lock);
 425
 426         /*
 427          * Some groups like to know that marks are being freed.  This is a
 428          * callback to the group function to let it know that this mark
 429          * is being freed.
 430          */
 431         if (group->ops->freeing_mark)
 432                 group->ops->freeing_mark(mark, group);
 433 }
 434
 435 void fsnotify_destroy_mark(struct fsnotify_mark *mark,
 436                            struct fsnotify_group *group)
 437 {
 438         mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
 439         fsnotify_detach_mark(mark);
 440         mutex_unlock(&group->mark_mutex);
 441         fsnotify_free_mark(mark);
 442 }
 443 EXPORT_SYMBOL_GPL(fsnotify_destroy_mark);
 444
 445 /*
 446  * Sorting function for lists of fsnotify marks.
 447  *
 448  * Fanotify supports different notification classes (reflected as priority of
 449  * notification group). Events shall be passed to notification groups in
 450  * decreasing priority order. To achieve this marks in notification lists for
 451  * inodes and vfsmounts are sorted so that priorities of corresponding groups
 452  * are descending.
 453  *
 454  * Furthermore correct handling of the ignore mask requires processing inode
 455  * and vfsmount marks of each group together. Using the group address as
 456  * further sort criterion provides a unique sorting order and thus we can
 457  * merge inode and vfsmount lists of marks in linear time and find groups
 458  * present in both lists.
 459  *
 460  * A return value of 1 signifies that b has priority over a.
 461  * A return value of 0 signifies that the two marks have to be handled together.
 462  * A return value of -1 signifies that a has priority over b.
 463  */
 464 int fsnotify_compare_groups(struct fsnotify_group *a, struct fsnotify_group *b)
 465 {
 466         if (a == b)
 467                 return 0;
 468         if (!a)
 469                 return 1;
 470         if (!b)
 471                 return -1;
 472         if (a->priority < b->priority)
 473                 return 1;
 474         if (a->priority > b->priority)
 475                 return -1;
 476         if (a < b)
 477                 return 1;
 478         return -1;
 479 }
 480
 481 static int fsnotify_attach_connector_to_object(fsnotify_connp_t *connp,
 482                                                unsigned int type,
 483                                                __kernel_fsid_t *fsid)
 484 {
 485         struct inode *inode = NULL;
 486         struct fsnotify_mark_connector *conn;
 487
 488         conn = kmem_cache_alloc(fsnotify_mark_connector_cachep, GFP_KERNEL);
 489         if (!conn)
 490                 return -ENOMEM;
 491         spin_lock_init(&conn->lock);
 492         INIT_HLIST_HEAD(&conn->list);
 493         conn->type = type;
 494         conn->obj = connp;
 495         /* Cache fsid of filesystem containing the object */
 496         if (fsid) {
 497                 conn->fsid = *fsid;
 498                 conn->flags = FSNOTIFY_CONN_FLAG_HAS_FSID;
 499         } else {
 500                 conn->fsid.val[0] = conn->fsid.val[1] = 0;
 501                 conn->flags = 0;
 502         }
 503         if (conn->type == FSNOTIFY_OBJ_TYPE_INODE) {
 504                 inode = fsnotify_conn_inode(conn);
 505                 fsnotify_get_inode_ref(inode);
 506         }
 507
 508         /*
 509          * cmpxchg() provides the barrier so that readers of *connp can see
 510          * only initialized structure
 511          */
 512         if (cmpxchg(connp, NULL, conn)) {
 513                 /* Someone else created list structure for us */
 514                 if (inode)
 515                         fsnotify_put_inode_ref(inode);
 516                 kmem_cache_free(fsnotify_mark_connector_cachep, conn);
 517         }
 518
 519         return 0;
 520 }
 521
 522 /*
 523  * Get mark connector, make sure it is alive and return with its lock held.
 524  * This is for users that get connector pointer from inode or mount. Users that
 525  * hold reference to a mark on the list may directly lock connector->lock as
 526  * they are sure list cannot go away under them.
 527  */
 528 static struct fsnotify_mark_connector *fsnotify_grab_connector(
 529                                                 fsnotify_connp_t *connp)
 530 {
 531         struct fsnotify_mark_connector *conn;
 532         int idx;
 533
 534         idx = srcu_read_lock(&fsnotify_mark_srcu);
 535         conn = srcu_dereference(*connp, &fsnotify_mark_srcu);
 536         if (!conn)
 537                 goto out;
 538         spin_lock(&conn->lock);
 539         if (conn->type == FSNOTIFY_OBJ_TYPE_DETACHED) {
 540                 spin_unlock(&conn->lock);
 541                 srcu_read_unlock(&fsnotify_mark_srcu, idx);
 542                 return NULL;
 543         }
 544 out:
 545         srcu_read_unlock(&fsnotify_mark_srcu, idx);
 546         return conn;
 547 }
 548
 549 /*
 550  * Add mark into proper place in given list of marks. These marks may be used
 551  * for the fsnotify backend to determine which event types should be delivered
 552  * to which group and for which inodes. These marks are ordered according to
 553  * priority, highest number first, and then by the group's location in memory.
 554  */
 555 static int fsnotify_add_mark_list(struct fsnotify_mark *mark,
 556                                   fsnotify_connp_t *connp, unsigned int type,
 557                                   int allow_dups, __kernel_fsid_t *fsid)
 558 {
 559         struct fsnotify_mark *lmark, *last = NULL;
 560         struct fsnotify_mark_connector *conn;
 561         int cmp;
 562         int err = 0;
 563
 564         if (WARN_ON(!fsnotify_valid_obj_type(type)))
 565                 return -EINVAL;
 566
 567         /* Backend is expected to check for zero fsid (e.g. tmpfs) */
 568         if (fsid && WARN_ON_ONCE(!fsid->val[0] && !fsid->val[1]))
 569                 return -ENODEV;
 570
 571 restart:
 572         spin_lock(&mark->lock);
 573         conn = fsnotify_grab_connector(connp);
 574         if (!conn) {
 575                 spin_unlock(&mark->lock);
 576                 err = fsnotify_attach_connector_to_object(connp, type, fsid);
 577                 if (err)
 578                         return err;
 579                 goto restart;
 580         } else if (fsid && !(conn->flags & FSNOTIFY_CONN_FLAG_HAS_FSID)) {
 581                 conn->fsid = *fsid;
 582                 /* Pairs with smp_rmb() in fanotify_get_fsid() */
 583                 smp_wmb();
 584                 conn->flags |= FSNOTIFY_CONN_FLAG_HAS_FSID;
 585         } else if (fsid && (conn->flags & FSNOTIFY_CONN_FLAG_HAS_FSID) &&
 586                    (fsid->val[0] != conn->fsid.val[0] ||
 587                     fsid->val[1] != conn->fsid.val[1])) {
 588                 /*
 589                  * Backend is expected to check for non uniform fsid
 590                  * (e.g. btrfs), but maybe we missed something?
 591                  * Only allow setting conn->fsid once to non zero fsid.
 592                  * inotify and non-fid fanotify groups do not set nor test
 593                  * conn->fsid.
 594                  */
 595                 pr_warn_ratelimited("%s: fsid mismatch on object of type %u: "
 596                                     "%x.%x != %x.%x\n", __func__, conn->type,
 597                                     fsid->val[0], fsid->val[1],
 598                                     conn->fsid.val[0], conn->fsid.val[1]);
 599                 err = -EXDEV;
 600                 goto out_err;
 601         }
 602
 603         /* is mark the first mark? */
 604         if (hlist_empty(&conn->list)) {
 605                 hlist_add_head_rcu(&mark->obj_list, &conn->list);
 606                 goto added;
 607         }
 608
 609         /* should mark be in the middle of the current list? */
 610         hlist_for_each_entry(lmark, &conn->list, obj_list) {
 611                 last = lmark;
 612
 613                 if ((lmark->group == mark->group) &&
 614                     (lmark->flags & FSNOTIFY_MARK_FLAG_ATTACHED) &&
 615                     !allow_dups) {
 616                         err = -EEXIST;
 617                         goto out_err;
 618                 }
 619
 620                 cmp = fsnotify_compare_groups(lmark->group, mark->group);
 621                 if (cmp >= 0) {
 622                         hlist_add_before_rcu(&mark->obj_list, &lmark->obj_list);
 623                         goto added;
 624                 }
 625         }
 626
 627         BUG_ON(last == NULL);
 628         /* mark should be the last entry.  last is the current last entry */
 629         hlist_add_behind_rcu(&mark->obj_list, &last->obj_list);
 630 added:
 631         /*
 632          * Since connector is attached to object using cmpxchg() we are
 633          * guaranteed that connector initialization is fully visible by anyone
 634          * seeing mark->connector set.
 635          */
 636         WRITE_ONCE(mark->connector, conn);
 637 out_err:
 638         spin_unlock(&conn->lock);
 639         spin_unlock(&mark->lock);
 640         return err;
 641 }
 642
 643 /*
 644  * Attach an initialized mark to a given group and fs object.
 645  * These marks may be used for the fsnotify backend to determine which
 646  * event types should be delivered to which group.
 647  */
 648 int fsnotify_add_mark_locked(struct fsnotify_mark *mark,
 649                              fsnotify_connp_t *connp, unsigned int type,
 650                              int allow_dups, __kernel_fsid_t *fsid)
 651 {
 652         struct fsnotify_group *group = mark->group;
 653         int ret = 0;
 654
 655         BUG_ON(!mutex_is_locked(&group->mark_mutex));
 656
 657         /*
 658          * LOCKING ORDER!!!!
 659          * group->mark_mutex
 660          * mark->lock
 661          * mark->connector->lock
 662          */
 663         spin_lock(&mark->lock);
 664         mark->flags |= FSNOTIFY_MARK_FLAG_ALIVE | FSNOTIFY_MARK_FLAG_ATTACHED;
 665
 666         list_add(&mark->g_list, &group->marks_list);
 667         fsnotify_get_mark(mark); /* for g_list */
 668         spin_unlock(&mark->lock);
 669
 670         ret = fsnotify_add_mark_list(mark, connp, type, allow_dups, fsid);
 671         if (ret)
 672                 goto err;
 673
 674         if (mark->mask)
 675                 fsnotify_recalc_mask(mark->connector);
 676
 677         return ret;
 678 err:
 679         spin_lock(&mark->lock);
 680         mark->flags &= ~(FSNOTIFY_MARK_FLAG_ALIVE |
 681                          FSNOTIFY_MARK_FLAG_ATTACHED);
 682         list_del_init(&mark->g_list);
 683         spin_unlock(&mark->lock);
 684
 685         fsnotify_put_mark(mark);
 686         return ret;
 687 }
 688
 689 int fsnotify_add_mark(struct fsnotify_mark *mark, fsnotify_connp_t *connp,
 690                       unsigned int type, int allow_dups, __kernel_fsid_t *fsid)
 691 {
 692         int ret;
 693         struct fsnotify_group *group = mark->group;
 694
 695         mutex_lock(&group->mark_mutex);
 696         ret = fsnotify_add_mark_locked(mark, connp, type, allow_dups, fsid);
 697         mutex_unlock(&group->mark_mutex);
 698         return ret;
 699 }
 700 EXPORT_SYMBOL_GPL(fsnotify_add_mark);
 701
 702 /*
 703  * Given a list of marks, find the mark associated with given group. If found
 704  * take a reference to that mark and return it, else return NULL.
 705  */
 706 struct fsnotify_mark *fsnotify_find_mark(fsnotify_connp_t *connp,
 707                                          struct fsnotify_group *group)
 708 {
 709         struct fsnotify_mark_connector *conn;
 710         struct fsnotify_mark *mark;
 711
 712         conn = fsnotify_grab_connector(connp);
 713         if (!conn)
 714                 return NULL;
 715
 716         hlist_for_each_entry(mark, &conn->list, obj_list) {
 717                 if (mark->group == group &&
 718                     (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
 719                         fsnotify_get_mark(mark);
 720                         spin_unlock(&conn->lock);
 721                         return mark;
 722                 }
 723         }
 724         spin_unlock(&conn->lock);
 725         return NULL;
 726 }
 727 EXPORT_SYMBOL_GPL(fsnotify_find_mark);
 728
 729 /* Clear any marks in a group with given type mask */
 730 void fsnotify_clear_marks_by_group(struct fsnotify_group *group,
 731                                    unsigned int type_mask)
 732 {
 733         struct fsnotify_mark *lmark, *mark;
 734         LIST_HEAD(to_free);
 735         struct list_head *head = &to_free;
 736
 737         /* Skip selection step if we want to clear all marks. */
 738         if (type_mask == FSNOTIFY_OBJ_ALL_TYPES_MASK) {
 739                 head = &group->marks_list;
 740                 goto clear;
 741         }
 742         /*
 743          * We have to be really careful here. Anytime we drop mark_mutex, e.g.
 744          * fsnotify_clear_marks_by_inode() can come and free marks. Even in our
 745          * to_free list so we have to use mark_mutex even when accessing that
 746          * list. And freeing mark requires us to drop mark_mutex. So we can
 747          * reliably free only the first mark in the list. That's why we first
 748          * move marks to free to to_free list in one go and then free marks in
 749          * to_free list one by one.
 750          */
 751         mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
 752         list_for_each_entry_safe(mark, lmark, &group->marks_list, g_list) {
 753                 if ((1U << mark->connector->type) & type_mask)
 754                         list_move(&mark->g_list, &to_free);
 755         }
 756         mutex_unlock(&group->mark_mutex);
 757
 758 clear:
 759         while (1) {
 760                 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
 761                 if (list_empty(head)) {
 762                         mutex_unlock(&group->mark_mutex);
 763                         break;
 764                 }
 765                 mark = list_first_entry(head, struct fsnotify_mark, g_list);
 766                 fsnotify_get_mark(mark);
 767                 fsnotify_detach_mark(mark);
 768                 mutex_unlock(&group->mark_mutex);
 769                 fsnotify_free_mark(mark);
 770                 fsnotify_put_mark(mark);
 771         }
 772 }
 773
 774 /* Destroy all marks attached to an object via connector */
 775 void fsnotify_destroy_marks(fsnotify_connp_t *connp)
 776 {
 777         struct fsnotify_mark_connector *conn;
 778         struct fsnotify_mark *mark, *old_mark = NULL;
 779         void *objp;
 780         unsigned int type;
 781
 782         conn = fsnotify_grab_connector(connp);
 783         if (!conn)
 784                 return;
 785         /*
 786          * We have to be careful since we can race with e.g.
 787          * fsnotify_clear_marks_by_group() and once we drop the conn->lock, the
 788          * list can get modified. However we are holding mark reference and
 789          * thus our mark cannot be removed from obj_list so we can continue
 790          * iteration after regaining conn->lock.
 791          */
 792         hlist_for_each_entry(mark, &conn->list, obj_list) {
 793                 fsnotify_get_mark(mark);
 794                 spin_unlock(&conn->lock);
 795                 if (old_mark)
 796                         fsnotify_put_mark(old_mark);
 797                 old_mark = mark;
 798                 fsnotify_destroy_mark(mark, mark->group);
 799                 spin_lock(&conn->lock);
 800         }
 801         /*
 802          * Detach list from object now so that we don't pin inode until all
 803          * mark references get dropped. It would lead to strange results such
 804          * as delaying inode deletion or blocking unmount.
 805          */
 806         objp = fsnotify_detach_connector_from_object(conn, &type);
 807         spin_unlock(&conn->lock);
 808         if (old_mark)
 809                 fsnotify_put_mark(old_mark);
 810         fsnotify_drop_object(type, objp);
 811 }
 812
 813 /*
 814  * Nothing fancy, just initialize lists and locks and counters.
 815  */
 816 void fsnotify_init_mark(struct fsnotify_mark *mark,
 817                         struct fsnotify_group *group)
 818 {
 819         memset(mark, 0, sizeof(*mark));
 820         spin_lock_init(&mark->lock);
 821         refcount_set(&mark->refcnt, 1);
 822         fsnotify_get_group(group);
 823         mark->group = group;
 824         WRITE_ONCE(mark->connector, NULL);
 825 }
 826 EXPORT_SYMBOL_GPL(fsnotify_init_mark);
 827
 828 /*
 829  * Destroy all marks in destroy_list, waits for SRCU period to finish before
 830  * actually freeing marks.
 831  */
 832 static void fsnotify_mark_destroy_workfn(struct work_struct *work)
 833 {
 834         struct fsnotify_mark *mark, *next;
 835         struct list_head private_destroy_list;
 836
 837         spin_lock(&destroy_lock);
 838         /* exchange the list head */
 839         list_replace_init(&destroy_list, &private_destroy_list);
 840         spin_unlock(&destroy_lock);
 841
 842         synchronize_srcu(&fsnotify_mark_srcu);
 843
 844         list_for_each_entry_safe(mark, next, &private_destroy_list, g_list) {
 845                 list_del_init(&mark->g_list);
 846                 fsnotify_final_mark_destroy(mark);
 847         }
 848 }
 849
 850 /* Wait for all marks queued for destruction to be actually destroyed */
 851 void fsnotify_wait_marks_destroyed(void)
 852 {
 853         flush_delayed_work(&reaper_work);
 854 }
 855 EXPORT_SYMBOL_GPL(fsnotify_wait_marks_destroyed);