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