mm/mmu_notifier.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  linux/mm/mmu_notifier.c
   4  *
   5  *  Copyright (C) 2008  Qumranet, Inc.
   6  *  Copyright (C) 2008  SGI
   7  *             Christoph Lameter <cl@linux.com>
   8  */
   9
  10 #include <linux/rculist.h>
  11 #include <linux/mmu_notifier.h>
  12 #include <linux/export.h>
  13 #include <linux/mm.h>
  14 #include <linux/err.h>
  15 #include <linux/srcu.h>
  16 #include <linux/rcupdate.h>
  17 #include <linux/sched.h>
  18 #include <linux/sched/mm.h>
  19 #include <linux/slab.h>
  20
  21 /* global SRCU for all MMs */
  22 DEFINE_STATIC_SRCU(srcu);
  23
  24 /*
  25  * This function allows mmu_notifier::release callback to delay a call to
  26  * a function that will free appropriate resources. The function must be
  27  * quick and must not block.
  28  */
  29 void mmu_notifier_call_srcu(struct rcu_head *rcu,
  30                             void (*func)(struct rcu_head *rcu))
  31 {
  32         call_srcu(&srcu, rcu, func);
  33 }
  34 EXPORT_SYMBOL_GPL(mmu_notifier_call_srcu);
  35
  36 /*
  37  * This function can't run concurrently against mmu_notifier_register
  38  * because mm->mm_users > 0 during mmu_notifier_register and exit_mmap
  39  * runs with mm_users == 0. Other tasks may still invoke mmu notifiers
  40  * in parallel despite there being no task using this mm any more,
  41  * through the vmas outside of the exit_mmap context, such as with
  42  * vmtruncate. This serializes against mmu_notifier_unregister with
  43  * the mmu_notifier_mm->lock in addition to SRCU and it serializes
  44  * against the other mmu notifiers with SRCU. struct mmu_notifier_mm
  45  * can't go away from under us as exit_mmap holds an mm_count pin
  46  * itself.
  47  */
  48 void __mmu_notifier_release(struct mm_struct *mm)
  49 {
  50         struct mmu_notifier *mn;
  51         int id;
  52
  53         /*
  54          * SRCU here will block mmu_notifier_unregister until
  55          * ->release returns.
  56          */
  57         id = srcu_read_lock(&srcu);
  58         hlist_for_each_entry_rcu(mn, &mm->mmu_notifier_mm->list, hlist)
  59                 /*
  60                  * If ->release runs before mmu_notifier_unregister it must be
  61                  * handled, as it's the only way for the driver to flush all
  62                  * existing sptes and stop the driver from establishing any more
  63                  * sptes before all the pages in the mm are freed.
  64                  */
  65                 if (mn->ops->release)
  66                         mn->ops->release(mn, mm);
  67
  68         spin_lock(&mm->mmu_notifier_mm->lock);
  69         while (unlikely(!hlist_empty(&mm->mmu_notifier_mm->list))) {
  70                 mn = hlist_entry(mm->mmu_notifier_mm->list.first,
  71                                  struct mmu_notifier,
  72                                  hlist);
  73                 /*
  74                  * We arrived before mmu_notifier_unregister so
  75                  * mmu_notifier_unregister will do nothing other than to wait
  76                  * for ->release to finish and for mmu_notifier_unregister to
  77                  * return.
  78                  */
  79                 hlist_del_init_rcu(&mn->hlist);
  80         }
  81         spin_unlock(&mm->mmu_notifier_mm->lock);
  82         srcu_read_unlock(&srcu, id);
  83
  84         /*
  85          * synchronize_srcu here prevents mmu_notifier_release from returning to
  86          * exit_mmap (which would proceed with freeing all pages in the mm)
  87          * until the ->release method returns, if it was invoked by
  88          * mmu_notifier_unregister.
  89          *
  90          * The mmu_notifier_mm can't go away from under us because one mm_count
  91          * is held by exit_mmap.
  92          */
  93         synchronize_srcu(&srcu);
  94 }
  95
  96 /*
  97  * If no young bitflag is supported by the hardware, ->clear_flush_young can
  98  * unmap the address and return 1 or 0 depending if the mapping previously
  99  * existed or not.
 100  */
 101 int __mmu_notifier_clear_flush_young(struct mm_struct *mm,
 102                                         unsigned long start,
 103                                         unsigned long end)
 104 {
 105         struct mmu_notifier *mn;
 106         int young = 0, id;
 107
 108         id = srcu_read_lock(&srcu);
 109         hlist_for_each_entry_rcu(mn, &mm->mmu_notifier_mm->list, hlist) {
 110                 if (mn->ops->clear_flush_young)
 111                         young |= mn->ops->clear_flush_young(mn, mm, start, end);
 112         }
 113         srcu_read_unlock(&srcu, id);
 114
 115         return young;
 116 }
 117
 118 int __mmu_notifier_clear_young(struct mm_struct *mm,
 119                                unsigned long start,
 120                                unsigned long end)
 121 {
 122         struct mmu_notifier *mn;
 123         int young = 0, id;
 124
 125         id = srcu_read_lock(&srcu);
 126         hlist_for_each_entry_rcu(mn, &mm->mmu_notifier_mm->list, hlist) {
 127                 if (mn->ops->clear_young)
 128                         young |= mn->ops->clear_young(mn, mm, start, end);
 129         }
 130         srcu_read_unlock(&srcu, id);
 131
 132         return young;
 133 }
 134
 135 int __mmu_notifier_test_young(struct mm_struct *mm,
 136                               unsigned long address)
 137 {
 138         struct mmu_notifier *mn;
 139         int young = 0, id;
 140
 141         id = srcu_read_lock(&srcu);
 142         hlist_for_each_entry_rcu(mn, &mm->mmu_notifier_mm->list, hlist) {
 143                 if (mn->ops->test_young) {
 144                         young = mn->ops->test_young(mn, mm, address);
 145                         if (young)
 146                                 break;
 147                 }
 148         }
 149         srcu_read_unlock(&srcu, id);
 150
 151         return young;
 152 }
 153
 154 void __mmu_notifier_change_pte(struct mm_struct *mm, unsigned long address,
 155                                pte_t pte)
 156 {
 157         struct mmu_notifier *mn;
 158         int id;
 159
 160         id = srcu_read_lock(&srcu);
 161         hlist_for_each_entry_rcu(mn, &mm->mmu_notifier_mm->list, hlist) {
 162                 if (mn->ops->change_pte)
 163                         mn->ops->change_pte(mn, mm, address, pte);
 164         }
 165         srcu_read_unlock(&srcu, id);
 166 }
 167
 168 int __mmu_notifier_invalidate_range_start(struct mmu_notifier_range *range)
 169 {
 170         struct mmu_notifier *mn;
 171         int ret = 0;
 172         int id;
 173
 174         id = srcu_read_lock(&srcu);
 175         hlist_for_each_entry_rcu(mn, &range->mm->mmu_notifier_mm->list, hlist) {
 176                 if (mn->ops->invalidate_range_start) {
 177                         int _ret = mn->ops->invalidate_range_start(mn, range);
 178                         if (_ret) {
 179                                 pr_info("%pS callback failed with %d in %sblockable context.\n",
 180                                         mn->ops->invalidate_range_start, _ret,
 181                                         !mmu_notifier_range_blockable(range) ? "non-" : "");
 182                                 WARN_ON(mmu_notifier_range_blockable(range) ||
 183                                         ret != -EAGAIN);
 184                                 ret = _ret;
 185                         }
 186                 }
 187         }
 188         srcu_read_unlock(&srcu, id);
 189
 190         return ret;
 191 }
 192 EXPORT_SYMBOL_GPL(__mmu_notifier_invalidate_range_start);
 193
 194 void __mmu_notifier_invalidate_range_end(struct mmu_notifier_range *range,
 195                                          bool only_end)
 196 {
 197         struct mmu_notifier *mn;
 198         int id;
 199
 200         id = srcu_read_lock(&srcu);
 201         hlist_for_each_entry_rcu(mn, &range->mm->mmu_notifier_mm->list, hlist) {
 202                 /*
 203                  * Call invalidate_range here too to avoid the need for the
 204                  * subsystem of having to register an invalidate_range_end
 205                  * call-back when there is invalidate_range already. Usually a
 206                  * subsystem registers either invalidate_range_start()/end() or
 207                  * invalidate_range(), so this will be no additional overhead
 208                  * (besides the pointer check).
 209                  *
 210                  * We skip call to invalidate_range() if we know it is safe ie
 211                  * call site use mmu_notifier_invalidate_range_only_end() which
 212                  * is safe to do when we know that a call to invalidate_range()
 213                  * already happen under page table lock.
 214                  */
 215                 if (!only_end && mn->ops->invalidate_range)
 216                         mn->ops->invalidate_range(mn, range->mm,
 217                                                   range->start,
 218                                                   range->end);
 219                 if (mn->ops->invalidate_range_end)
 220                         mn->ops->invalidate_range_end(mn, range);
 221         }
 222         srcu_read_unlock(&srcu, id);
 223 }
 224 EXPORT_SYMBOL_GPL(__mmu_notifier_invalidate_range_end);
 225
 226 void __mmu_notifier_invalidate_range(struct mm_struct *mm,
 227                                   unsigned long start, unsigned long end)
 228 {
 229         struct mmu_notifier *mn;
 230         int id;
 231
 232         id = srcu_read_lock(&srcu);
 233         hlist_for_each_entry_rcu(mn, &mm->mmu_notifier_mm->list, hlist) {
 234                 if (mn->ops->invalidate_range)
 235                         mn->ops->invalidate_range(mn, mm, start, end);
 236         }
 237         srcu_read_unlock(&srcu, id);
 238 }
 239 EXPORT_SYMBOL_GPL(__mmu_notifier_invalidate_range);
 240
 241 /*
 242  * Same as mmu_notifier_register but here the caller must hold the
 243  * mmap_sem in write mode.
 244  */
 245 int __mmu_notifier_register(struct mmu_notifier *mn, struct mm_struct *mm)
 246 {
 247         struct mmu_notifier_mm *mmu_notifier_mm = NULL;
 248         int ret;
 249
 250         lockdep_assert_held_write(&mm->mmap_sem);
 251         BUG_ON(atomic_read(&mm->mm_users) <= 0);
 252
 253         mn->mm = mm;
 254         mn->users = 1;
 255
 256         if (!mm->mmu_notifier_mm) {
 257                 /*
 258                  * kmalloc cannot be called under mm_take_all_locks(), but we
 259                  * know that mm->mmu_notifier_mm can't change while we hold
 260                  * the write side of the mmap_sem.
 261                  */
 262                 mmu_notifier_mm =
 263                         kmalloc(sizeof(struct mmu_notifier_mm), GFP_KERNEL);
 264                 if (!mmu_notifier_mm)
 265                         return -ENOMEM;
 266
 267                 INIT_HLIST_HEAD(&mmu_notifier_mm->list);
 268                 spin_lock_init(&mmu_notifier_mm->lock);
 269         }
 270
 271         ret = mm_take_all_locks(mm);
 272         if (unlikely(ret))
 273                 goto out_clean;
 274
 275         /* Pairs with the mmdrop in mmu_notifier_unregister_* */
 276         mmgrab(mm);
 277
 278         /*
 279          * Serialize the update against mmu_notifier_unregister. A
 280          * side note: mmu_notifier_release can't run concurrently with
 281          * us because we hold the mm_users pin (either implicitly as
 282          * current->mm or explicitly with get_task_mm() or similar).
 283          * We can't race against any other mmu notifier method either
 284          * thanks to mm_take_all_locks().
 285          */
 286         if (mmu_notifier_mm)
 287                 mm->mmu_notifier_mm = mmu_notifier_mm;
 288
 289         spin_lock(&mm->mmu_notifier_mm->lock);
 290         hlist_add_head_rcu(&mn->hlist, &mm->mmu_notifier_mm->list);
 291         spin_unlock(&mm->mmu_notifier_mm->lock);
 292
 293         mm_drop_all_locks(mm);
 294         BUG_ON(atomic_read(&mm->mm_users) <= 0);
 295         return 0;
 296
 297 out_clean:
 298         kfree(mmu_notifier_mm);
 299         return ret;
 300 }
 301 EXPORT_SYMBOL_GPL(__mmu_notifier_register);
 302
 303 /**
 304  * mmu_notifier_register - Register a notifier on a mm
 305  * @mn: The notifier to attach
 306  * @mm: The mm to attach the notifier to
 307  *
 308  * Must not hold mmap_sem nor any other VM related lock when calling
 309  * this registration function. Must also ensure mm_users can't go down
 310  * to zero while this runs to avoid races with mmu_notifier_release,
 311  * so mm has to be current->mm or the mm should be pinned safely such
 312  * as with get_task_mm(). If the mm is not current->mm, the mm_users
 313  * pin should be released by calling mmput after mmu_notifier_register
 314  * returns.
 315  *
 316  * mmu_notifier_unregister() or mmu_notifier_put() must be always called to
 317  * unregister the notifier.
 318  *
 319  * While the caller has a mmu_notifier get the mn->mm pointer will remain
 320  * valid, and can be converted to an active mm pointer via mmget_not_zero().
 321  */
 322 int mmu_notifier_register(struct mmu_notifier *mn, struct mm_struct *mm)
 323 {
 324         int ret;
 325
 326         down_write(&mm->mmap_sem);
 327         ret = __mmu_notifier_register(mn, mm);
 328         up_write(&mm->mmap_sem);
 329         return ret;
 330 }
 331 EXPORT_SYMBOL_GPL(mmu_notifier_register);
 332
 333 static struct mmu_notifier *
 334 find_get_mmu_notifier(struct mm_struct *mm, const struct mmu_notifier_ops *ops)
 335 {
 336         struct mmu_notifier *mn;
 337
 338         spin_lock(&mm->mmu_notifier_mm->lock);
 339         hlist_for_each_entry_rcu (mn, &mm->mmu_notifier_mm->list, hlist) {
 340                 if (mn->ops != ops)
 341                         continue;
 342
 343                 if (likely(mn->users != UINT_MAX))
 344                         mn->users++;
 345                 else
 346                         mn = ERR_PTR(-EOVERFLOW);
 347                 spin_unlock(&mm->mmu_notifier_mm->lock);
 348                 return mn;
 349         }
 350         spin_unlock(&mm->mmu_notifier_mm->lock);
 351         return NULL;
 352 }
 353
 354 /**
 355  * mmu_notifier_get_locked - Return the single struct mmu_notifier for
 356  *                           the mm & ops
 357  * @ops: The operations struct being subscribe with
 358  * @mm : The mm to attach notifiers too
 359  *
 360  * This function either allocates a new mmu_notifier via
 361  * ops->alloc_notifier(), or returns an already existing notifier on the
 362  * list. The value of the ops pointer is used to determine when two notifiers
 363  * are the same.
 364  *
 365  * Each call to mmu_notifier_get() must be paired with a call to
 366  * mmu_notifier_put(). The caller must hold the write side of mm->mmap_sem.
 367  *
 368  * While the caller has a mmu_notifier get the mm pointer will remain valid,
 369  * and can be converted to an active mm pointer via mmget_not_zero().
 370  */
 371 struct mmu_notifier *mmu_notifier_get_locked(const struct mmu_notifier_ops *ops,
 372                                              struct mm_struct *mm)
 373 {
 374         struct mmu_notifier *mn;
 375         int ret;
 376
 377         lockdep_assert_held_write(&mm->mmap_sem);
 378
 379         if (mm->mmu_notifier_mm) {
 380                 mn = find_get_mmu_notifier(mm, ops);
 381                 if (mn)
 382                         return mn;
 383         }
 384
 385         mn = ops->alloc_notifier(mm);
 386         if (IS_ERR(mn))
 387                 return mn;
 388         mn->ops = ops;
 389         ret = __mmu_notifier_register(mn, mm);
 390         if (ret)
 391                 goto out_free;
 392         return mn;
 393 out_free:
 394         mn->ops->free_notifier(mn);
 395         return ERR_PTR(ret);
 396 }
 397 EXPORT_SYMBOL_GPL(mmu_notifier_get_locked);
 398
 399 /* this is called after the last mmu_notifier_unregister() returned */
 400 void __mmu_notifier_mm_destroy(struct mm_struct *mm)
 401 {
 402         BUG_ON(!hlist_empty(&mm->mmu_notifier_mm->list));
 403         kfree(mm->mmu_notifier_mm);
 404         mm->mmu_notifier_mm = LIST_POISON1; /* debug */
 405 }
 406
 407 /*
 408  * This releases the mm_count pin automatically and frees the mm
 409  * structure if it was the last user of it. It serializes against
 410  * running mmu notifiers with SRCU and against mmu_notifier_unregister
 411  * with the unregister lock + SRCU. All sptes must be dropped before
 412  * calling mmu_notifier_unregister. ->release or any other notifier
 413  * method may be invoked concurrently with mmu_notifier_unregister,
 414  * and only after mmu_notifier_unregister returned we're guaranteed
 415  * that ->release or any other method can't run anymore.
 416  */
 417 void mmu_notifier_unregister(struct mmu_notifier *mn, struct mm_struct *mm)
 418 {
 419         BUG_ON(atomic_read(&mm->mm_count) <= 0);
 420
 421         if (!hlist_unhashed(&mn->hlist)) {
 422                 /*
 423                  * SRCU here will force exit_mmap to wait for ->release to
 424                  * finish before freeing the pages.
 425                  */
 426                 int id;
 427
 428                 id = srcu_read_lock(&srcu);
 429                 /*
 430                  * exit_mmap will block in mmu_notifier_release to guarantee
 431                  * that ->release is called before freeing the pages.
 432                  */
 433                 if (mn->ops->release)
 434                         mn->ops->release(mn, mm);
 435                 srcu_read_unlock(&srcu, id);
 436
 437                 spin_lock(&mm->mmu_notifier_mm->lock);
 438                 /*
 439                  * Can not use list_del_rcu() since __mmu_notifier_release
 440                  * can delete it before we hold the lock.
 441                  */
 442                 hlist_del_init_rcu(&mn->hlist);
 443                 spin_unlock(&mm->mmu_notifier_mm->lock);
 444         }
 445
 446         /*
 447          * Wait for any running method to finish, of course including
 448          * ->release if it was run by mmu_notifier_release instead of us.
 449          */
 450         synchronize_srcu(&srcu);
 451
 452         BUG_ON(atomic_read(&mm->mm_count) <= 0);
 453
 454         mmdrop(mm);
 455 }
 456 EXPORT_SYMBOL_GPL(mmu_notifier_unregister);
 457
 458 /*
 459  * Same as mmu_notifier_unregister but no callback and no srcu synchronization.
 460  */
 461 void mmu_notifier_unregister_no_release(struct mmu_notifier *mn,
 462                                         struct mm_struct *mm)
 463 {
 464         spin_lock(&mm->mmu_notifier_mm->lock);
 465         /*
 466          * Can not use list_del_rcu() since __mmu_notifier_release
 467          * can delete it before we hold the lock.
 468          */
 469         hlist_del_init_rcu(&mn->hlist);
 470         spin_unlock(&mm->mmu_notifier_mm->lock);
 471
 472         BUG_ON(atomic_read(&mm->mm_count) <= 0);
 473         mmdrop(mm);
 474 }
 475 EXPORT_SYMBOL_GPL(mmu_notifier_unregister_no_release);
 476
 477 static void mmu_notifier_free_rcu(struct rcu_head *rcu)
 478 {
 479         struct mmu_notifier *mn = container_of(rcu, struct mmu_notifier, rcu);
 480         struct mm_struct *mm = mn->mm;
 481
 482         mn->ops->free_notifier(mn);
 483         /* Pairs with the get in __mmu_notifier_register() */
 484         mmdrop(mm);
 485 }
 486
 487 /**
 488  * mmu_notifier_put - Release the reference on the notifier
 489  * @mn: The notifier to act on
 490  *
 491  * This function must be paired with each mmu_notifier_get(), it releases the
 492  * reference obtained by the get. If this is the last reference then process
 493  * to free the notifier will be run asynchronously.
 494  *
 495  * Unlike mmu_notifier_unregister() the get/put flow only calls ops->release
 496  * when the mm_struct is destroyed. Instead free_notifier is always called to
 497  * release any resources held by the user.
 498  *
 499  * As ops->release is not guaranteed to be called, the user must ensure that
 500  * all sptes are dropped, and no new sptes can be established before
 501  * mmu_notifier_put() is called.
 502  *
 503  * This function can be called from the ops->release callback, however the
 504  * caller must still ensure it is called pairwise with mmu_notifier_get().
 505  *
 506  * Modules calling this function must call mmu_notifier_synchronize() in
 507  * their __exit functions to ensure the async work is completed.
 508  */
 509 void mmu_notifier_put(struct mmu_notifier *mn)
 510 {
 511         struct mm_struct *mm = mn->mm;
 512
 513         spin_lock(&mm->mmu_notifier_mm->lock);
 514         if (WARN_ON(!mn->users) || --mn->users)
 515                 goto out_unlock;
 516         hlist_del_init_rcu(&mn->hlist);
 517         spin_unlock(&mm->mmu_notifier_mm->lock);
 518
 519         call_srcu(&srcu, &mn->rcu, mmu_notifier_free_rcu);
 520         return;
 521
 522 out_unlock:
 523         spin_unlock(&mm->mmu_notifier_mm->lock);
 524 }
 525 EXPORT_SYMBOL_GPL(mmu_notifier_put);
 526
 527 /**
 528  * mmu_notifier_synchronize - Ensure all mmu_notifiers are freed
 529  *
 530  * This function ensures that all outstanding async SRU work from
 531  * mmu_notifier_put() is completed. After it returns any mmu_notifier_ops
 532  * associated with an unused mmu_notifier will no longer be called.
 533  *
 534  * Before using the caller must ensure that all of its mmu_notifiers have been
 535  * fully released via mmu_notifier_put().
 536  *
 537  * Modules using the mmu_notifier_put() API should call this in their __exit
 538  * function to avoid module unloading races.
 539  */
 540 void mmu_notifier_synchronize(void)
 541 {
 542         synchronize_srcu(&srcu);
 543 }
 544 EXPORT_SYMBOL_GPL(mmu_notifier_synchronize);
 545
 546 bool
 547 mmu_notifier_range_update_to_read_only(const struct mmu_notifier_range *range)
 548 {
 549         if (!range->vma || range->event != MMU_NOTIFY_PROTECTION_VMA)
 550                 return false;
 551         /* Return true if the vma still have the read flag set. */
 552         return range->vma->vm_flags & VM_READ;
 553 }
 554 EXPORT_SYMBOL_GPL(mmu_notifier_range_update_to_read_only);