arch/arm64/kernel/mte.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Copyright (C) 2020 ARM Ltd.
   4  */
   5
   6 #include <linux/bitops.h>
   7 #include <linux/cpu.h>
   8 #include <linux/kernel.h>
   9 #include <linux/mm.h>
  10 #include <linux/prctl.h>
  11 #include <linux/sched.h>
  12 #include <linux/sched/mm.h>
  13 #include <linux/string.h>
  14 #include <linux/swap.h>
  15 #include <linux/swapops.h>
  16 #include <linux/thread_info.h>
  17 #include <linux/types.h>
  18 #include <linux/uaccess.h>
  19 #include <linux/uio.h>
  20
  21 #include <asm/barrier.h>
  22 #include <asm/cpufeature.h>
  23 #include <asm/mte.h>
  24 #include <asm/ptrace.h>
  25 #include <asm/sysreg.h>
  26
  27 static DEFINE_PER_CPU_READ_MOSTLY(u64, mte_tcf_preferred);
  28
  29 #ifdef CONFIG_KASAN_HW_TAGS
  30 /*
  31  * The asynchronous and asymmetric MTE modes have the same behavior for
  32  * store operations. This flag is set when either of these modes is enabled.
  33  */
  34 DEFINE_STATIC_KEY_FALSE(mte_async_or_asymm_mode);
  35 EXPORT_SYMBOL_GPL(mte_async_or_asymm_mode);
  36 #endif
  37
  38 static void mte_sync_page_tags(struct page *page, pte_t old_pte,
  39                                bool check_swap, bool pte_is_tagged)
  40 {
  41         if (check_swap && is_swap_pte(old_pte)) {
  42                 swp_entry_t entry = pte_to_swp_entry(old_pte);
  43
  44                 if (!non_swap_entry(entry) && mte_restore_tags(entry, page)) {
  45                         set_page_mte_tagged(page);
  46                         return;
  47                 }
  48         }
  49
  50         if (!pte_is_tagged)
  51                 return;
  52
  53         /*
  54          * Test PG_mte_tagged again in case it was racing with another
  55          * set_pte_at().
  56          */
  57         if (!page_mte_tagged(page)) {
  58                 mte_clear_page_tags(page_address(page));
  59                 set_page_mte_tagged(page);
  60         }
  61 }
  62
  63 void mte_sync_tags(pte_t old_pte, pte_t pte)
  64 {
  65         struct page *page = pte_page(pte);
  66         long i, nr_pages = compound_nr(page);
  67         bool check_swap = nr_pages == 1;
  68         bool pte_is_tagged = pte_tagged(pte);
  69
  70         /* Early out if there's nothing to do */
  71         if (!check_swap && !pte_is_tagged)
  72                 return;
  73
  74         /* if PG_mte_tagged is set, tags have already been initialised */
  75         for (i = 0; i < nr_pages; i++, page++)
  76                 if (!page_mte_tagged(page))
  77                         mte_sync_page_tags(page, old_pte, check_swap,
  78                                            pte_is_tagged);
  79
  80         /* ensure the tags are visible before the PTE is set */
  81         smp_wmb();
  82 }
  83
  84 int memcmp_pages(struct page *page1, struct page *page2)
  85 {
  86         char *addr1, *addr2;
  87         int ret;
  88
  89         addr1 = page_address(page1);
  90         addr2 = page_address(page2);
  91         ret = memcmp(addr1, addr2, PAGE_SIZE);
  92
  93         if (!system_supports_mte() || ret)
  94                 return ret;
  95
  96         /*
  97          * If the page content is identical but at least one of the pages is
  98          * tagged, return non-zero to avoid KSM merging. If only one of the
  99          * pages is tagged, set_pte_at() may zero or change the tags of the
 100          * other page via mte_sync_tags().
 101          */
 102         if (page_mte_tagged(page1) || page_mte_tagged(page2))
 103                 return addr1 != addr2;
 104
 105         return ret;
 106 }
 107
 108 static inline void __mte_enable_kernel(const char *mode, unsigned long tcf)
 109 {
 110         /* Enable MTE Sync Mode for EL1. */
 111         sysreg_clear_set(sctlr_el1, SCTLR_EL1_TCF_MASK,
 112                          SYS_FIELD_PREP(SCTLR_EL1, TCF, tcf));
 113         isb();
 114
 115         pr_info_once("MTE: enabled in %s mode at EL1\n", mode);
 116 }
 117
 118 #ifdef CONFIG_KASAN_HW_TAGS
 119 void mte_enable_kernel_sync(void)
 120 {
 121         /*
 122          * Make sure we enter this function when no PE has set
 123          * async mode previously.
 124          */
 125         WARN_ONCE(system_uses_mte_async_or_asymm_mode(),
 126                         "MTE async mode enabled system wide!");
 127
 128         __mte_enable_kernel("synchronous", SCTLR_EL1_TCF_SYNC);
 129 }
 130
 131 void mte_enable_kernel_async(void)
 132 {
 133         __mte_enable_kernel("asynchronous", SCTLR_EL1_TCF_ASYNC);
 134
 135         /*
 136          * MTE async mode is set system wide by the first PE that
 137          * executes this function.
 138          *
 139          * Note: If in future KASAN acquires a runtime switching
 140          * mode in between sync and async, this strategy needs
 141          * to be reviewed.
 142          */
 143         if (!system_uses_mte_async_or_asymm_mode())
 144                 static_branch_enable(&mte_async_or_asymm_mode);
 145 }
 146
 147 void mte_enable_kernel_asymm(void)
 148 {
 149         if (cpus_have_cap(ARM64_MTE_ASYMM)) {
 150                 __mte_enable_kernel("asymmetric", SCTLR_EL1_TCF_ASYMM);
 151
 152                 /*
 153                  * MTE asymm mode behaves as async mode for store
 154                  * operations. The mode is set system wide by the
 155                  * first PE that executes this function.
 156                  *
 157                  * Note: If in future KASAN acquires a runtime switching
 158                  * mode in between sync and async, this strategy needs
 159                  * to be reviewed.
 160                  */
 161                 if (!system_uses_mte_async_or_asymm_mode())
 162                         static_branch_enable(&mte_async_or_asymm_mode);
 163         } else {
 164                 /*
 165                  * If the CPU does not support MTE asymmetric mode the
 166                  * kernel falls back on synchronous mode which is the
 167                  * default for kasan=on.
 168                  */
 169                 mte_enable_kernel_sync();
 170         }
 171 }
 172 #endif
 173
 174 #ifdef CONFIG_KASAN_HW_TAGS
 175 void mte_check_tfsr_el1(void)
 176 {
 177         u64 tfsr_el1 = read_sysreg_s(SYS_TFSR_EL1);
 178
 179         if (unlikely(tfsr_el1 & SYS_TFSR_EL1_TF1)) {
 180                 /*
 181                  * Note: isb() is not required after this direct write
 182                  * because there is no indirect read subsequent to it
 183                  * (per ARM DDI 0487F.c table D13-1).
 184                  */
 185                 write_sysreg_s(0, SYS_TFSR_EL1);
 186
 187                 kasan_report_async();
 188         }
 189 }
 190 #endif
 191
 192 /*
 193  * This is where we actually resolve the system and process MTE mode
 194  * configuration into an actual value in SCTLR_EL1 that affects
 195  * userspace.
 196  */
 197 static void mte_update_sctlr_user(struct task_struct *task)
 198 {
 199         /*
 200          * This must be called with preemption disabled and can only be called
 201          * on the current or next task since the CPU must match where the thread
 202          * is going to run. The caller is responsible for calling
 203          * update_sctlr_el1() later in the same preemption disabled block.
 204          */
 205         unsigned long sctlr = task->thread.sctlr_user;
 206         unsigned long mte_ctrl = task->thread.mte_ctrl;
 207         unsigned long pref, resolved_mte_tcf;
 208
 209         pref = __this_cpu_read(mte_tcf_preferred);
 210         /*
 211          * If there is no overlap between the system preferred and
 212          * program requested values go with what was requested.
 213          */
 214         resolved_mte_tcf = (mte_ctrl & pref) ? pref : mte_ctrl;
 215         sctlr &= ~SCTLR_EL1_TCF0_MASK;
 216         /*
 217          * Pick an actual setting. The order in which we check for
 218          * set bits and map into register values determines our
 219          * default order.
 220          */
 221         if (resolved_mte_tcf & MTE_CTRL_TCF_ASYMM)
 222                 sctlr |= SYS_FIELD_PREP_ENUM(SCTLR_EL1, TCF0, ASYMM);
 223         else if (resolved_mte_tcf & MTE_CTRL_TCF_ASYNC)
 224                 sctlr |= SYS_FIELD_PREP_ENUM(SCTLR_EL1, TCF0, ASYNC);
 225         else if (resolved_mte_tcf & MTE_CTRL_TCF_SYNC)
 226                 sctlr |= SYS_FIELD_PREP_ENUM(SCTLR_EL1, TCF0, SYNC);
 227         task->thread.sctlr_user = sctlr;
 228 }
 229
 230 static void mte_update_gcr_excl(struct task_struct *task)
 231 {
 232         /*
 233          * SYS_GCR_EL1 will be set to current->thread.mte_ctrl value by
 234          * mte_set_user_gcr() in kernel_exit, but only if KASAN is enabled.
 235          */
 236         if (kasan_hw_tags_enabled())
 237                 return;
 238
 239         write_sysreg_s(
 240                 ((task->thread.mte_ctrl >> MTE_CTRL_GCR_USER_EXCL_SHIFT) &
 241                  SYS_GCR_EL1_EXCL_MASK) | SYS_GCR_EL1_RRND,
 242                 SYS_GCR_EL1);
 243 }
 244
 245 #ifdef CONFIG_KASAN_HW_TAGS
 246 /* Only called from assembly, silence sparse */
 247 void __init kasan_hw_tags_enable(struct alt_instr *alt, __le32 *origptr,
 248                                  __le32 *updptr, int nr_inst);
 249
 250 void __init kasan_hw_tags_enable(struct alt_instr *alt, __le32 *origptr,
 251                                  __le32 *updptr, int nr_inst)
 252 {
 253         BUG_ON(nr_inst != 1); /* Branch -> NOP */
 254
 255         if (kasan_hw_tags_enabled())
 256                 *updptr = cpu_to_le32(aarch64_insn_gen_nop());
 257 }
 258 #endif
 259
 260 void mte_thread_init_user(void)
 261 {
 262         if (!system_supports_mte())
 263                 return;
 264
 265         /* clear any pending asynchronous tag fault */
 266         dsb(ish);
 267         write_sysreg_s(0, SYS_TFSRE0_EL1);
 268         clear_thread_flag(TIF_MTE_ASYNC_FAULT);
 269         /* disable tag checking and reset tag generation mask */
 270         set_mte_ctrl(current, 0);
 271 }
 272
 273 void mte_thread_switch(struct task_struct *next)
 274 {
 275         if (!system_supports_mte())
 276                 return;
 277
 278         mte_update_sctlr_user(next);
 279         mte_update_gcr_excl(next);
 280
 281         /* TCO may not have been disabled on exception entry for the current task. */
 282         mte_disable_tco_entry(next);
 283
 284         /*
 285          * Check if an async tag exception occurred at EL1.
 286          *
 287          * Note: On the context switch path we rely on the dsb() present
 288          * in __switch_to() to guarantee that the indirect writes to TFSR_EL1
 289          * are synchronized before this point.
 290          */
 291         isb();
 292         mte_check_tfsr_el1();
 293 }
 294
 295 void mte_cpu_setup(void)
 296 {
 297         u64 rgsr;
 298
 299         /*
 300          * CnP must be enabled only after the MAIR_EL1 register has been set
 301          * up. Inconsistent MAIR_EL1 between CPUs sharing the same TLB may
 302          * lead to the wrong memory type being used for a brief window during
 303          * CPU power-up.
 304          *
 305          * CnP is not a boot feature so MTE gets enabled before CnP, but let's
 306          * make sure that is the case.
 307          */
 308         BUG_ON(read_sysreg(ttbr0_el1) & TTBR_CNP_BIT);
 309         BUG_ON(read_sysreg(ttbr1_el1) & TTBR_CNP_BIT);
 310
 311         /* Normal Tagged memory type at the corresponding MAIR index */
 312         sysreg_clear_set(mair_el1,
 313                          MAIR_ATTRIDX(MAIR_ATTR_MASK, MT_NORMAL_TAGGED),
 314                          MAIR_ATTRIDX(MAIR_ATTR_NORMAL_TAGGED,
 315                                       MT_NORMAL_TAGGED));
 316
 317         write_sysreg_s(KERNEL_GCR_EL1, SYS_GCR_EL1);
 318
 319         /*
 320          * If GCR_EL1.RRND=1 is implemented the same way as RRND=0, then
 321          * RGSR_EL1.SEED must be non-zero for IRG to produce
 322          * pseudorandom numbers. As RGSR_EL1 is UNKNOWN out of reset, we
 323          * must initialize it.
 324          */
 325         rgsr = (read_sysreg(CNTVCT_EL0) & SYS_RGSR_EL1_SEED_MASK) <<
 326                SYS_RGSR_EL1_SEED_SHIFT;
 327         if (rgsr == 0)
 328                 rgsr = 1 << SYS_RGSR_EL1_SEED_SHIFT;
 329         write_sysreg_s(rgsr, SYS_RGSR_EL1);
 330
 331         /* clear any pending tag check faults in TFSR*_EL1 */
 332         write_sysreg_s(0, SYS_TFSR_EL1);
 333         write_sysreg_s(0, SYS_TFSRE0_EL1);
 334
 335         local_flush_tlb_all();
 336 }
 337
 338 void mte_suspend_enter(void)
 339 {
 340         if (!system_supports_mte())
 341                 return;
 342
 343         /*
 344          * The barriers are required to guarantee that the indirect writes
 345          * to TFSR_EL1 are synchronized before we report the state.
 346          */
 347         dsb(nsh);
 348         isb();
 349
 350         /* Report SYS_TFSR_EL1 before suspend entry */
 351         mte_check_tfsr_el1();
 352 }
 353
 354 void mte_suspend_exit(void)
 355 {
 356         if (!system_supports_mte())
 357                 return;
 358
 359         mte_cpu_setup();
 360 }
 361
 362 long set_mte_ctrl(struct task_struct *task, unsigned long arg)
 363 {
 364         u64 mte_ctrl = (~((arg & PR_MTE_TAG_MASK) >> PR_MTE_TAG_SHIFT) &
 365                         SYS_GCR_EL1_EXCL_MASK) << MTE_CTRL_GCR_USER_EXCL_SHIFT;
 366
 367         if (!system_supports_mte())
 368                 return 0;
 369
 370         if (arg & PR_MTE_TCF_ASYNC)
 371                 mte_ctrl |= MTE_CTRL_TCF_ASYNC;
 372         if (arg & PR_MTE_TCF_SYNC)
 373                 mte_ctrl |= MTE_CTRL_TCF_SYNC;
 374
 375         /*
 376          * If the system supports it and both sync and async modes are
 377          * specified then implicitly enable asymmetric mode.
 378          * Userspace could see a mix of both sync and async anyway due
 379          * to differing or changing defaults on CPUs.
 380          */
 381         if (cpus_have_cap(ARM64_MTE_ASYMM) &&
 382             (arg & PR_MTE_TCF_ASYNC) &&
 383             (arg & PR_MTE_TCF_SYNC))
 384                 mte_ctrl |= MTE_CTRL_TCF_ASYMM;
 385
 386         task->thread.mte_ctrl = mte_ctrl;
 387         if (task == current) {
 388                 preempt_disable();
 389                 mte_update_sctlr_user(task);
 390                 mte_update_gcr_excl(task);
 391                 update_sctlr_el1(task->thread.sctlr_user);
 392                 preempt_enable();
 393         }
 394
 395         return 0;
 396 }
 397
 398 long get_mte_ctrl(struct task_struct *task)
 399 {
 400         unsigned long ret;
 401         u64 mte_ctrl = task->thread.mte_ctrl;
 402         u64 incl = (~mte_ctrl >> MTE_CTRL_GCR_USER_EXCL_SHIFT) &
 403                    SYS_GCR_EL1_EXCL_MASK;
 404
 405         if (!system_supports_mte())
 406                 return 0;
 407
 408         ret = incl << PR_MTE_TAG_SHIFT;
 409         if (mte_ctrl & MTE_CTRL_TCF_ASYNC)
 410                 ret |= PR_MTE_TCF_ASYNC;
 411         if (mte_ctrl & MTE_CTRL_TCF_SYNC)
 412                 ret |= PR_MTE_TCF_SYNC;
 413
 414         return ret;
 415 }
 416
 417 /*
 418  * Access MTE tags in another process' address space as given in mm. Update
 419  * the number of tags copied. Return 0 if any tags copied, error otherwise.
 420  * Inspired by __access_remote_vm().
 421  */
 422 static int __access_remote_tags(struct mm_struct *mm, unsigned long addr,
 423                                 struct iovec *kiov, unsigned int gup_flags)
 424 {
 425         struct vm_area_struct *vma;
 426         void __user *buf = kiov->iov_base;
 427         size_t len = kiov->iov_len;
 428         int ret;
 429         int write = gup_flags & FOLL_WRITE;
 430
 431         if (!access_ok(buf, len))
 432                 return -EFAULT;
 433
 434         if (mmap_read_lock_killable(mm))
 435                 return -EIO;
 436
 437         while (len) {
 438                 unsigned long tags, offset;
 439                 void *maddr;
 440                 struct page *page = NULL;
 441
 442                 ret = get_user_pages_remote(mm, addr, 1, gup_flags, &page,
 443                                             &vma, NULL);
 444                 if (ret <= 0)
 445                         break;
 446
 447                 /*
 448                  * Only copy tags if the page has been mapped as PROT_MTE
 449                  * (PG_mte_tagged set). Otherwise the tags are not valid and
 450                  * not accessible to user. Moreover, an mprotect(PROT_MTE)
 451                  * would cause the existing tags to be cleared if the page
 452                  * was never mapped with PROT_MTE.
 453                  */
 454                 if (!(vma->vm_flags & VM_MTE)) {
 455                         ret = -EOPNOTSUPP;
 456                         put_page(page);
 457                         break;
 458                 }
 459                 WARN_ON_ONCE(!page_mte_tagged(page));
 460
 461                 /* limit access to the end of the page */
 462                 offset = offset_in_page(addr);
 463                 tags = min(len, (PAGE_SIZE - offset) / MTE_GRANULE_SIZE);
 464
 465                 maddr = page_address(page);
 466                 if (write) {
 467                         tags = mte_copy_tags_from_user(maddr + offset, buf, tags);
 468                         set_page_dirty_lock(page);
 469                 } else {
 470                         tags = mte_copy_tags_to_user(buf, maddr + offset, tags);
 471                 }
 472                 put_page(page);
 473
 474                 /* error accessing the tracer's buffer */
 475                 if (!tags)
 476                         break;
 477
 478                 len -= tags;
 479                 buf += tags;
 480                 addr += tags * MTE_GRANULE_SIZE;
 481         }
 482         mmap_read_unlock(mm);
 483
 484         /* return an error if no tags copied */
 485         kiov->iov_len = buf - kiov->iov_base;
 486         if (!kiov->iov_len) {
 487                 /* check for error accessing the tracee's address space */
 488                 if (ret <= 0)
 489                         return -EIO;
 490                 else
 491                         return -EFAULT;
 492         }
 493
 494         return 0;
 495 }
 496
 497 /*
 498  * Copy MTE tags in another process' address space at 'addr' to/from tracer's
 499  * iovec buffer. Return 0 on success. Inspired by ptrace_access_vm().
 500  */
 501 static int access_remote_tags(struct task_struct *tsk, unsigned long addr,
 502                               struct iovec *kiov, unsigned int gup_flags)
 503 {
 504         struct mm_struct *mm;
 505         int ret;
 506
 507         mm = get_task_mm(tsk);
 508         if (!mm)
 509                 return -EPERM;
 510
 511         if (!tsk->ptrace || (current != tsk->parent) ||
 512             ((get_dumpable(mm) != SUID_DUMP_USER) &&
 513              !ptracer_capable(tsk, mm->user_ns))) {
 514                 mmput(mm);
 515                 return -EPERM;
 516         }
 517
 518         ret = __access_remote_tags(mm, addr, kiov, gup_flags);
 519         mmput(mm);
 520
 521         return ret;
 522 }
 523
 524 int mte_ptrace_copy_tags(struct task_struct *child, long request,
 525                          unsigned long addr, unsigned long data)
 526 {
 527         int ret;
 528         struct iovec kiov;
 529         struct iovec __user *uiov = (void __user *)data;
 530         unsigned int gup_flags = FOLL_FORCE;
 531
 532         if (!system_supports_mte())
 533                 return -EIO;
 534
 535         if (get_user(kiov.iov_base, &uiov->iov_base) ||
 536             get_user(kiov.iov_len, &uiov->iov_len))
 537                 return -EFAULT;
 538
 539         if (request == PTRACE_POKEMTETAGS)
 540                 gup_flags |= FOLL_WRITE;
 541
 542         /* align addr to the MTE tag granule */
 543         addr &= MTE_GRANULE_MASK;
 544
 545         ret = access_remote_tags(child, addr, &kiov, gup_flags);
 546         if (!ret)
 547                 ret = put_user(kiov.iov_len, &uiov->iov_len);
 548
 549         return ret;
 550 }
 551
 552 static ssize_t mte_tcf_preferred_show(struct device *dev,
 553                                       struct device_attribute *attr, char *buf)
 554 {
 555         switch (per_cpu(mte_tcf_preferred, dev->id)) {
 556         case MTE_CTRL_TCF_ASYNC:
 557                 return sysfs_emit(buf, "async\n");
 558         case MTE_CTRL_TCF_SYNC:
 559                 return sysfs_emit(buf, "sync\n");
 560         case MTE_CTRL_TCF_ASYMM:
 561                 return sysfs_emit(buf, "asymm\n");
 562         default:
 563                 return sysfs_emit(buf, "???\n");
 564         }
 565 }
 566
 567 static ssize_t mte_tcf_preferred_store(struct device *dev,
 568                                        struct device_attribute *attr,
 569                                        const char *buf, size_t count)
 570 {
 571         u64 tcf;
 572
 573         if (sysfs_streq(buf, "async"))
 574                 tcf = MTE_CTRL_TCF_ASYNC;
 575         else if (sysfs_streq(buf, "sync"))
 576                 tcf = MTE_CTRL_TCF_SYNC;
 577         else if (cpus_have_cap(ARM64_MTE_ASYMM) && sysfs_streq(buf, "asymm"))
 578                 tcf = MTE_CTRL_TCF_ASYMM;
 579         else
 580                 return -EINVAL;
 581
 582         device_lock(dev);
 583         per_cpu(mte_tcf_preferred, dev->id) = tcf;
 584         device_unlock(dev);
 585
 586         return count;
 587 }
 588 static DEVICE_ATTR_RW(mte_tcf_preferred);
 589
 590 static int register_mte_tcf_preferred_sysctl(void)
 591 {
 592         unsigned int cpu;
 593
 594         if (!system_supports_mte())
 595                 return 0;
 596
 597         for_each_possible_cpu(cpu) {
 598                 per_cpu(mte_tcf_preferred, cpu) = MTE_CTRL_TCF_ASYNC;
 599                 device_create_file(get_cpu_device(cpu),
 600                                    &dev_attr_mte_tcf_preferred);
 601         }
 602
 603         return 0;
 604 }
 605 subsys_initcall(register_mte_tcf_preferred_sysctl);
 606
 607 /*
 608  * Return 0 on success, the number of bytes not probed otherwise.
 609  */
 610 size_t mte_probe_user_range(const char __user *uaddr, size_t size)
 611 {
 612         const char __user *end = uaddr + size;
 613         int err = 0;
 614         char val;
 615
 616         __raw_get_user(val, uaddr, err);
 617         if (err)
 618                 return size;
 619
 620         uaddr = PTR_ALIGN(uaddr, MTE_GRANULE_SIZE);
 621         while (uaddr < end) {
 622                 /*
 623                  * A read is sufficient for mte, the caller should have probed
 624                  * for the pte write permission if required.
 625                  */
 626                 __raw_get_user(val, uaddr, err);
 627                 if (err)
 628                         return end - uaddr;
 629                 uaddr += MTE_GRANULE_SIZE;
 630         }
 631         (void)val;
 632
 633         return 0;
 634 }