fs/notify/mark.c

   1 /*
   2  *  Copyright (C) 2008 Red Hat, Inc., Eric Paris <[email protected]>
   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;
 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 (!mark->connector) {
 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, &mark->connector->lock))
 259                 return;
 260
 261         conn = mark->connector;
 262         hlist_del_init_rcu(&mark->obj_list);
 263         if (hlist_empty(&conn->list)) {
 264                 objp = fsnotify_detach_connector_from_object(conn, &type);
 265                 free_conn = true;
 266         } else {
 267                 __fsnotify_recalc_mask(conn);
 268         }
 269         mark->connector = NULL;
 270         spin_unlock(&conn->lock);
 271
 272         fsnotify_drop_object(type, objp);
 273
 274         if (free_conn) {
 275                 spin_lock(&destroy_lock);
 276                 conn->destroy_next = connector_destroy_list;
 277                 connector_destroy_list = conn;
 278                 spin_unlock(&destroy_lock);
 279                 queue_work(system_unbound_wq, &connector_reaper_work);
 280         }
 281         /*
 282          * Note that we didn't update flags telling whether inode cares about
 283          * what's happening with children. We update these flags from
 284          * __fsnotify_parent() lazily when next event happens on one of our
 285          * children.
 286          */
 287         spin_lock(&destroy_lock);
 288         list_add(&mark->g_list, &destroy_list);
 289         spin_unlock(&destroy_lock);
 290         queue_delayed_work(system_unbound_wq, &reaper_work,
 291                            FSNOTIFY_REAPER_DELAY);
 292 }
 293
 294 /*
 295  * Get mark reference when we found the mark via lockless traversal of object
 296  * list. Mark can be already removed from the list by now and on its way to be
 297  * destroyed once SRCU period ends.
 298  *
 299  * Also pin the group so it doesn't disappear under us.
 300  */
 301 static bool fsnotify_get_mark_safe(struct fsnotify_mark *mark)
 302 {
 303         if (!mark)
 304                 return true;
 305
 306         if (refcount_inc_not_zero(&mark->refcnt)) {
 307                 spin_lock(&mark->lock);
 308                 if (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED) {
 309                         /* mark is attached, group is still alive then */
 310                         atomic_inc(&mark->group->user_waits);
 311                         spin_unlock(&mark->lock);
 312                         return true;
 313                 }
 314                 spin_unlock(&mark->lock);
 315                 fsnotify_put_mark(mark);
 316         }
 317         return false;
 318 }
 319
 320 /*
 321  * Puts marks and wakes up group destruction if necessary.
 322  *
 323  * Pairs with fsnotify_get_mark_safe()
 324  */
 325 static void fsnotify_put_mark_wake(struct fsnotify_mark *mark)
 326 {
 327         if (mark) {
 328                 struct fsnotify_group *group = mark->group;
 329
 330                 fsnotify_put_mark(mark);
 331                 /*
 332                  * We abuse notification_waitq on group shutdown for waiting for
 333                  * all marks pinned when waiting for userspace.
 334                  */
 335                 if (atomic_dec_and_test(&group->user_waits) && group->shutdown)
 336                         wake_up(&group->notification_waitq);
 337         }
 338 }
 339
 340 bool fsnotify_prepare_user_wait(struct fsnotify_iter_info *iter_info)
 341 {
 342         int type;
 343
 344         fsnotify_foreach_obj_type(type) {
 345                 /* This can fail if mark is being removed */
 346                 if (!fsnotify_get_mark_safe(iter_info->marks[type]))
 347                         goto fail;
 348         }
 349
 350         /*
 351          * Now that both marks are pinned by refcount in the inode / vfsmount
 352          * lists, we can drop SRCU lock, and safely resume the list iteration
 353          * once userspace returns.
 354          */
 355         srcu_read_unlock(&fsnotify_mark_srcu, iter_info->srcu_idx);
 356
 357         return true;
 358
 359 fail:
 360         for (type--; type >= 0; type--)
 361                 fsnotify_put_mark_wake(iter_info->marks[type]);
 362         return false;
 363 }
 364
 365 void fsnotify_finish_user_wait(struct fsnotify_iter_info *iter_info)
 366 {
 367         int type;
 368
 369         iter_info->srcu_idx = srcu_read_lock(&fsnotify_mark_srcu);
 370         fsnotify_foreach_obj_type(type)
 371                 fsnotify_put_mark_wake(iter_info->marks[type]);
 372 }
 373
 374 /*
 375  * Mark mark as detached, remove it from group list. Mark still stays in object
 376  * list until its last reference is dropped. Note that we rely on mark being
 377  * removed from group list before corresponding reference to it is dropped. In
 378  * particular we rely on mark->connector being valid while we hold
 379  * group->mark_mutex if we found the mark through g_list.
 380  *
 381  * Must be called with group->mark_mutex held. The caller must either hold
 382  * reference to the mark or be protected by fsnotify_mark_srcu.
 383  */
 384 void fsnotify_detach_mark(struct fsnotify_mark *mark)
 385 {
 386         struct fsnotify_group *group = mark->group;
 387
 388         WARN_ON_ONCE(!mutex_is_locked(&group->mark_mutex));
 389         WARN_ON_ONCE(!srcu_read_lock_held(&fsnotify_mark_srcu) &&
 390                      refcount_read(&mark->refcnt) < 1 +
 391                         !!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED));
 392
 393         spin_lock(&mark->lock);
 394         /* something else already called this function on this mark */
 395         if (!(mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
 396                 spin_unlock(&mark->lock);
 397                 return;
 398         }
 399         mark->flags &= ~FSNOTIFY_MARK_FLAG_ATTACHED;
 400         list_del_init(&mark->g_list);
 401         spin_unlock(&mark->lock);
 402
 403         atomic_dec(&group->num_marks);
 404
 405         /* Drop mark reference acquired in fsnotify_add_mark_locked() */
 406         fsnotify_put_mark(mark);
 407 }
 408
 409 /*
 410  * Free fsnotify mark. The mark is actually only marked as being freed.  The
 411  * freeing is actually happening only once last reference to the mark is
 412  * dropped from a workqueue which first waits for srcu period end.
 413  *
 414  * Caller must have a reference to the mark or be protected by
 415  * fsnotify_mark_srcu.
 416  */
 417 void fsnotify_free_mark(struct fsnotify_mark *mark)
 418 {
 419         struct fsnotify_group *group = mark->group;
 420
 421         spin_lock(&mark->lock);
 422         /* something else already called this function on this mark */
 423         if (!(mark->flags & FSNOTIFY_MARK_FLAG_ALIVE)) {
 424                 spin_unlock(&mark->lock);
 425                 return;
 426         }
 427         mark->flags &= ~FSNOTIFY_MARK_FLAG_ALIVE;
 428         spin_unlock(&mark->lock);
 429
 430         /*
 431          * Some groups like to know that marks are being freed.  This is a
 432          * callback to the group function to let it know that this mark
 433          * is being freed.
 434          */
 435         if (group->ops->freeing_mark)
 436                 group->ops->freeing_mark(mark, group);
 437 }
 438
 439 void fsnotify_destroy_mark(struct fsnotify_mark *mark,
 440                            struct fsnotify_group *group)
 441 {
 442         mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
 443         fsnotify_detach_mark(mark);
 444         mutex_unlock(&group->mark_mutex);
 445         fsnotify_free_mark(mark);
 446 }
 447
 448 /*
 449  * Sorting function for lists of fsnotify marks.
 450  *
 451  * Fanotify supports different notification classes (reflected as priority of
 452  * notification group). Events shall be passed to notification groups in
 453  * decreasing priority order. To achieve this marks in notification lists for
 454  * inodes and vfsmounts are sorted so that priorities of corresponding groups
 455  * are descending.
 456  *
 457  * Furthermore correct handling of the ignore mask requires processing inode
 458  * and vfsmount marks of each group together. Using the group address as
 459  * further sort criterion provides a unique sorting order and thus we can
 460  * merge inode and vfsmount lists of marks in linear time and find groups
 461  * present in both lists.
 462  *
 463  * A return value of 1 signifies that b has priority over a.
 464  * A return value of 0 signifies that the two marks have to be handled together.
 465  * A return value of -1 signifies that a has priority over b.
 466  */
 467 int fsnotify_compare_groups(struct fsnotify_group *a, struct fsnotify_group *b)
 468 {
 469         if (a == b)
 470                 return 0;
 471         if (!a)
 472                 return 1;
 473         if (!b)
 474                 return -1;
 475         if (a->priority < b->priority)
 476                 return 1;
 477         if (a->priority > b->priority)
 478                 return -1;
 479         if (a < b)
 480                 return 1;
 481         return -1;
 482 }
 483
 484 static int fsnotify_attach_connector_to_object(fsnotify_connp_t *connp,
 485                                                unsigned int type,
 486                                                __kernel_fsid_t *fsid)
 487 {
 488         struct inode *inode = NULL;
 489         struct fsnotify_mark_connector *conn;
 490
 491         conn = kmem_cache_alloc(fsnotify_mark_connector_cachep, GFP_KERNEL);
 492         if (!conn)
 493                 return -ENOMEM;
 494         spin_lock_init(&conn->lock);
 495         INIT_HLIST_HEAD(&conn->list);
 496         conn->type = type;
 497         conn->obj = connp;
 498         /* Cache fsid of filesystem containing the object */
 499         if (fsid)
 500                 conn->fsid = *fsid;
 501         else
 502                 conn->fsid.val[0] = conn->fsid.val[1] = 0;
 503         if (conn->type == FSNOTIFY_OBJ_TYPE_INODE)
 504                 inode = igrab(fsnotify_conn_inode(conn));
 505         /*
 506          * cmpxchg() provides the barrier so that readers of *connp can see
 507          * only initialized structure
 508          */
 509         if (cmpxchg(connp, NULL, conn)) {
 510                 /* Someone else created list structure for us */
 511                 if (inode)
 512                         iput(inode);
 513                 kmem_cache_free(fsnotify_mark_connector_cachep, conn);
 514         }
 515
 516         return 0;
 517 }
 518
 519 /*
 520  * Get mark connector, make sure it is alive and return with its lock held.
 521  * This is for users that get connector pointer from inode or mount. Users that
 522  * hold reference to a mark on the list may directly lock connector->lock as
 523  * they are sure list cannot go away under them.
 524  */
 525 static struct fsnotify_mark_connector *fsnotify_grab_connector(
 526                                                 fsnotify_connp_t *connp)
 527 {
 528         struct fsnotify_mark_connector *conn;
 529         int idx;
 530
 531         idx = srcu_read_lock(&fsnotify_mark_srcu);
 532         conn = srcu_dereference(*connp, &fsnotify_mark_srcu);
 533         if (!conn)
 534                 goto out;
 535         spin_lock(&conn->lock);
 536         if (conn->type == FSNOTIFY_OBJ_TYPE_DETACHED) {
 537                 spin_unlock(&conn->lock);
 538                 srcu_read_unlock(&fsnotify_mark_srcu, idx);
 539                 return NULL;
 540         }
 541 out:
 542         srcu_read_unlock(&fsnotify_mark_srcu, idx);
 543         return conn;
 544 }
 545
 546 /*
 547  * Add mark into proper place in given list of marks. These marks may be used
 548  * for the fsnotify backend to determine which event types should be delivered
 549  * to which group and for which inodes. These marks are ordered according to
 550  * priority, highest number first, and then by the group's location in memory.
 551  */
 552 static int fsnotify_add_mark_list(struct fsnotify_mark *mark,
 553                                   fsnotify_connp_t *connp, unsigned int type,
 554                                   int allow_dups, __kernel_fsid_t *fsid)
 555 {
 556         struct fsnotify_mark *lmark, *last = NULL;
 557         struct fsnotify_mark_connector *conn;
 558         int cmp;
 559         int err = 0;
 560
 561         if (WARN_ON(!fsnotify_valid_obj_type(type)))
 562                 return -EINVAL;
 563
 564         /* Backend is expected to check for zero fsid (e.g. tmpfs) */
 565         if (fsid && WARN_ON_ONCE(!fsid->val[0] && !fsid->val[1]))
 566                 return -ENODEV;
 567
 568 restart:
 569         spin_lock(&mark->lock);
 570         conn = fsnotify_grab_connector(connp);
 571         if (!conn) {
 572                 spin_unlock(&mark->lock);
 573                 err = fsnotify_attach_connector_to_object(connp, type, fsid);
 574                 if (err)
 575                         return err;
 576                 goto restart;
 577         } else if (fsid && (conn->fsid.val[0] || conn->fsid.val[1]) &&
 578                    (fsid->val[0] != conn->fsid.val[0] ||
 579                     fsid->val[1] != conn->fsid.val[1])) {
 580                 /*
 581                  * Backend is expected to check for non uniform fsid
 582                  * (e.g. btrfs), but maybe we missed something?
 583                  * Only allow setting conn->fsid once to non zero fsid.
 584                  * inotify and non-fid fanotify groups do not set nor test
 585                  * conn->fsid.
 586                  */
 587                 pr_warn_ratelimited("%s: fsid mismatch on object of type %u: "
 588                                     "%x.%x != %x.%x\n", __func__, conn->type,
 589                                     fsid->val[0], fsid->val[1],
 590                                     conn->fsid.val[0], conn->fsid.val[1]);
 591                 err = -EXDEV;
 592                 goto out_err;
 593         }
 594
 595         /* is mark the first mark? */
 596         if (hlist_empty(&conn->list)) {
 597                 hlist_add_head_rcu(&mark->obj_list, &conn->list);
 598                 goto added;
 599         }
 600
 601         /* should mark be in the middle of the current list? */
 602         hlist_for_each_entry(lmark, &conn->list, obj_list) {
 603                 last = lmark;
 604
 605                 if ((lmark->group == mark->group) &&
 606                     (lmark->flags & FSNOTIFY_MARK_FLAG_ATTACHED) &&
 607                     !allow_dups) {
 608                         err = -EEXIST;
 609                         goto out_err;
 610                 }
 611
 612                 cmp = fsnotify_compare_groups(lmark->group, mark->group);
 613                 if (cmp >= 0) {
 614                         hlist_add_before_rcu(&mark->obj_list, &lmark->obj_list);
 615                         goto added;
 616                 }
 617         }
 618
 619         BUG_ON(last == NULL);
 620         /* mark should be the last entry.  last is the current last entry */
 621         hlist_add_behind_rcu(&mark->obj_list, &last->obj_list);
 622 added:
 623         mark->connector = conn;
 624 out_err:
 625         spin_unlock(&conn->lock);
 626         spin_unlock(&mark->lock);
 627         return err;
 628 }
 629
 630 /*
 631  * Attach an initialized mark to a given group and fs object.
 632  * These marks may be used for the fsnotify backend to determine which
 633  * event types should be delivered to which group.
 634  */
 635 int fsnotify_add_mark_locked(struct fsnotify_mark *mark,
 636                              fsnotify_connp_t *connp, unsigned int type,
 637                              int allow_dups, __kernel_fsid_t *fsid)
 638 {
 639         struct fsnotify_group *group = mark->group;
 640         int ret = 0;
 641
 642         BUG_ON(!mutex_is_locked(&group->mark_mutex));
 643
 644         /*
 645          * LOCKING ORDER!!!!
 646          * group->mark_mutex
 647          * mark->lock
 648          * mark->connector->lock
 649          */
 650         spin_lock(&mark->lock);
 651         mark->flags |= FSNOTIFY_MARK_FLAG_ALIVE | FSNOTIFY_MARK_FLAG_ATTACHED;
 652
 653         list_add(&mark->g_list, &group->marks_list);
 654         atomic_inc(&group->num_marks);
 655         fsnotify_get_mark(mark); /* for g_list */
 656         spin_unlock(&mark->lock);
 657
 658         ret = fsnotify_add_mark_list(mark, connp, type, allow_dups, fsid);
 659         if (ret)
 660                 goto err;
 661
 662         if (mark->mask)
 663                 fsnotify_recalc_mask(mark->connector);
 664
 665         return ret;
 666 err:
 667         spin_lock(&mark->lock);
 668         mark->flags &= ~(FSNOTIFY_MARK_FLAG_ALIVE |
 669                          FSNOTIFY_MARK_FLAG_ATTACHED);
 670         list_del_init(&mark->g_list);
 671         spin_unlock(&mark->lock);
 672         atomic_dec(&group->num_marks);
 673
 674         fsnotify_put_mark(mark);
 675         return ret;
 676 }
 677
 678 int fsnotify_add_mark(struct fsnotify_mark *mark, fsnotify_connp_t *connp,
 679                       unsigned int type, int allow_dups, __kernel_fsid_t *fsid)
 680 {
 681         int ret;
 682         struct fsnotify_group *group = mark->group;
 683
 684         mutex_lock(&group->mark_mutex);
 685         ret = fsnotify_add_mark_locked(mark, connp, type, allow_dups, fsid);
 686         mutex_unlock(&group->mark_mutex);
 687         return ret;
 688 }
 689
 690 /*
 691  * Given a list of marks, find the mark associated with given group. If found
 692  * take a reference to that mark and return it, else return NULL.
 693  */
 694 struct fsnotify_mark *fsnotify_find_mark(fsnotify_connp_t *connp,
 695                                          struct fsnotify_group *group)
 696 {
 697         struct fsnotify_mark_connector *conn;
 698         struct fsnotify_mark *mark;
 699
 700         conn = fsnotify_grab_connector(connp);
 701         if (!conn)
 702                 return NULL;
 703
 704         hlist_for_each_entry(mark, &conn->list, obj_list) {
 705                 if (mark->group == group &&
 706                     (mark->flags & FSNOTIFY_MARK_FLAG_ATTACHED)) {
 707                         fsnotify_get_mark(mark);
 708                         spin_unlock(&conn->lock);
 709                         return mark;
 710                 }
 711         }
 712         spin_unlock(&conn->lock);
 713         return NULL;
 714 }
 715
 716 /* Clear any marks in a group with given type mask */
 717 void fsnotify_clear_marks_by_group(struct fsnotify_group *group,
 718                                    unsigned int type_mask)
 719 {
 720         struct fsnotify_mark *lmark, *mark;
 721         LIST_HEAD(to_free);
 722         struct list_head *head = &to_free;
 723
 724         /* Skip selection step if we want to clear all marks. */
 725         if (type_mask == FSNOTIFY_OBJ_ALL_TYPES_MASK) {
 726                 head = &group->marks_list;
 727                 goto clear;
 728         }
 729         /*
 730          * We have to be really careful here. Anytime we drop mark_mutex, e.g.
 731          * fsnotify_clear_marks_by_inode() can come and free marks. Even in our
 732          * to_free list so we have to use mark_mutex even when accessing that
 733          * list. And freeing mark requires us to drop mark_mutex. So we can
 734          * reliably free only the first mark in the list. That's why we first
 735          * move marks to free to to_free list in one go and then free marks in
 736          * to_free list one by one.
 737          */
 738         mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
 739         list_for_each_entry_safe(mark, lmark, &group->marks_list, g_list) {
 740                 if ((1U << mark->connector->type) & type_mask)
 741                         list_move(&mark->g_list, &to_free);
 742         }
 743         mutex_unlock(&group->mark_mutex);
 744
 745 clear:
 746         while (1) {
 747                 mutex_lock_nested(&group->mark_mutex, SINGLE_DEPTH_NESTING);
 748                 if (list_empty(head)) {
 749                         mutex_unlock(&group->mark_mutex);
 750                         break;
 751                 }
 752                 mark = list_first_entry(head, struct fsnotify_mark, g_list);
 753                 fsnotify_get_mark(mark);
 754                 fsnotify_detach_mark(mark);
 755                 mutex_unlock(&group->mark_mutex);
 756                 fsnotify_free_mark(mark);
 757                 fsnotify_put_mark(mark);
 758         }
 759 }
 760
 761 /* Destroy all marks attached to an object via connector */
 762 void fsnotify_destroy_marks(fsnotify_connp_t *connp)
 763 {
 764         struct fsnotify_mark_connector *conn;
 765         struct fsnotify_mark *mark, *old_mark = NULL;
 766         void *objp;
 767         unsigned int type;
 768
 769         conn = fsnotify_grab_connector(connp);
 770         if (!conn)
 771                 return;
 772         /*
 773          * We have to be careful since we can race with e.g.
 774          * fsnotify_clear_marks_by_group() and once we drop the conn->lock, the
 775          * list can get modified. However we are holding mark reference and
 776          * thus our mark cannot be removed from obj_list so we can continue
 777          * iteration after regaining conn->lock.
 778          */
 779         hlist_for_each_entry(mark, &conn->list, obj_list) {
 780                 fsnotify_get_mark(mark);
 781                 spin_unlock(&conn->lock);
 782                 if (old_mark)
 783                         fsnotify_put_mark(old_mark);
 784                 old_mark = mark;
 785                 fsnotify_destroy_mark(mark, mark->group);
 786                 spin_lock(&conn->lock);
 787         }
 788         /*
 789          * Detach list from object now so that we don't pin inode until all
 790          * mark references get dropped. It would lead to strange results such
 791          * as delaying inode deletion or blocking unmount.
 792          */
 793         objp = fsnotify_detach_connector_from_object(conn, &type);
 794         spin_unlock(&conn->lock);
 795         if (old_mark)
 796                 fsnotify_put_mark(old_mark);
 797         fsnotify_drop_object(type, objp);
 798 }
 799
 800 /*
 801  * Nothing fancy, just initialize lists and locks and counters.
 802  */
 803 void fsnotify_init_mark(struct fsnotify_mark *mark,
 804                         struct fsnotify_group *group)
 805 {
 806         memset(mark, 0, sizeof(*mark));
 807         spin_lock_init(&mark->lock);
 808         refcount_set(&mark->refcnt, 1);
 809         fsnotify_get_group(group);
 810         mark->group = group;
 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 }