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