arch/arm64/kernel/hibernate.c

   1 /*:
   2  * Hibernate support specific for ARM64
   3  *
   4  * Derived from work on ARM hibernation support by:
   5  *
   6  * Ubuntu project, hibernation support for mach-dove
   7  * Copyright (C) 2010 Nokia Corporation (Hiroshi Doyu)
   8  * Copyright (C) 2010 Texas Instruments, Inc. (Teerth Reddy et al.)
   9  *  https://lkml.org/lkml/2010/6/18/4
  10  *  https://lists.linux-foundation.org/pipermail/linux-pm/2010-June/027422.html
  11  *  https://patchwork.kernel.org/patch/96442/
  12  *
  13  * Copyright (C) 2006 Rafael J. Wysocki <rjw@sisk.pl>
  14  *
  15  * License terms: GNU General Public License (GPL) version 2
  16  */
  17 #define pr_fmt(x) "hibernate: " x
  18 #include <linux/cpu.h>
  19 #include <linux/kvm_host.h>
  20 #include <linux/mm.h>
  21 #include <linux/pm.h>
  22 #include <linux/sched.h>
  23 #include <linux/suspend.h>
  24 #include <linux/utsname.h>
  25 #include <linux/version.h>
  26
  27 #include <asm/barrier.h>
  28 #include <asm/cacheflush.h>
  29 #include <asm/cputype.h>
  30 #include <asm/daifflags.h>
  31 #include <asm/irqflags.h>
  32 #include <asm/kexec.h>
  33 #include <asm/memory.h>
  34 #include <asm/mmu_context.h>
  35 #include <asm/pgalloc.h>
  36 #include <asm/pgtable.h>
  37 #include <asm/pgtable-hwdef.h>
  38 #include <asm/sections.h>
  39 #include <asm/smp.h>
  40 #include <asm/smp_plat.h>
  41 #include <asm/suspend.h>
  42 #include <asm/sysreg.h>
  43 #include <asm/virt.h>
  44
  45 /*
  46  * Hibernate core relies on this value being 0 on resume, and marks it
  47  * __nosavedata assuming it will keep the resume kernel's '0' value. This
  48  * doesn't happen with either KASLR.
  49  *
  50  * defined as "__visible int in_suspend __nosavedata" in
  51  * kernel/power/hibernate.c
  52  */
  53 extern int in_suspend;
  54
  55 /* Do we need to reset el2? */
  56 #define el2_reset_needed() (is_hyp_mode_available() && !is_kernel_in_hyp_mode())
  57
  58 /* temporary el2 vectors in the __hibernate_exit_text section. */
  59 extern char hibernate_el2_vectors[];
  60
  61 /* hyp-stub vectors, used to restore el2 during resume from hibernate. */
  62 extern char __hyp_stub_vectors[];
  63
  64 /*
  65  * The logical cpu number we should resume on, initialised to a non-cpu
  66  * number.
  67  */
  68 static int sleep_cpu = -EINVAL;
  69
  70 /*
  71  * Values that may not change over hibernate/resume. We put the build number
  72  * and date in here so that we guarantee not to resume with a different
  73  * kernel.
  74  */
  75 struct arch_hibernate_hdr_invariants {
  76         char            uts_version[__NEW_UTS_LEN + 1];
  77 };
  78
  79 /* These values need to be know across a hibernate/restore. */
  80 static struct arch_hibernate_hdr {
  81         struct arch_hibernate_hdr_invariants invariants;
  82
  83         /* These are needed to find the relocated kernel if built with kaslr */
  84         phys_addr_t     ttbr1_el1;
  85         void            (*reenter_kernel)(void);
  86
  87         /*
  88          * We need to know where the __hyp_stub_vectors are after restore to
  89          * re-configure el2.
  90          */
  91         phys_addr_t     __hyp_stub_vectors;
  92
  93         u64             sleep_cpu_mpidr;
  94 } resume_hdr;
  95
  96 static inline void arch_hdr_invariants(struct arch_hibernate_hdr_invariants *i)
  97 {
  98         memset(i, 0, sizeof(*i));
  99         memcpy(i->uts_version, init_utsname()->version, sizeof(i->uts_version));
 100 }
 101
 102 int pfn_is_nosave(unsigned long pfn)
 103 {
 104         unsigned long nosave_begin_pfn = sym_to_pfn(&__nosave_begin);
 105         unsigned long nosave_end_pfn = sym_to_pfn(&__nosave_end - 1);
 106
 107         return ((pfn >= nosave_begin_pfn) && (pfn <= nosave_end_pfn)) ||
 108                 crash_is_nosave(pfn);
 109 }
 110
 111 void notrace save_processor_state(void)
 112 {
 113         WARN_ON(num_online_cpus() != 1);
 114 }
 115
 116 void notrace restore_processor_state(void)
 117 {
 118 }
 119
 120 int arch_hibernation_header_save(void *addr, unsigned int max_size)
 121 {
 122         struct arch_hibernate_hdr *hdr = addr;
 123
 124         if (max_size < sizeof(*hdr))
 125                 return -EOVERFLOW;
 126
 127         arch_hdr_invariants(&hdr->invariants);
 128         hdr->ttbr1_el1          = __pa_symbol(swapper_pg_dir);
 129         hdr->reenter_kernel     = _cpu_resume;
 130
 131         /* We can't use __hyp_get_vectors() because kvm may still be loaded */
 132         if (el2_reset_needed())
 133                 hdr->__hyp_stub_vectors = __pa_symbol(__hyp_stub_vectors);
 134         else
 135                 hdr->__hyp_stub_vectors = 0;
 136
 137         /* Save the mpidr of the cpu we called cpu_suspend() on... */
 138         if (sleep_cpu < 0) {
 139                 pr_err("Failing to hibernate on an unknown CPU.\n");
 140                 return -ENODEV;
 141         }
 142         hdr->sleep_cpu_mpidr = cpu_logical_map(sleep_cpu);
 143         pr_info("Hibernating on CPU %d [mpidr:0x%llx]\n", sleep_cpu,
 144                 hdr->sleep_cpu_mpidr);
 145
 146         return 0;
 147 }
 148 EXPORT_SYMBOL(arch_hibernation_header_save);
 149
 150 int arch_hibernation_header_restore(void *addr)
 151 {
 152         int ret;
 153         struct arch_hibernate_hdr_invariants invariants;
 154         struct arch_hibernate_hdr *hdr = addr;
 155
 156         arch_hdr_invariants(&invariants);
 157         if (memcmp(&hdr->invariants, &invariants, sizeof(invariants))) {
 158                 pr_crit("Hibernate image not generated by this kernel!\n");
 159                 return -EINVAL;
 160         }
 161
 162         sleep_cpu = get_logical_index(hdr->sleep_cpu_mpidr);
 163         pr_info("Hibernated on CPU %d [mpidr:0x%llx]\n", sleep_cpu,
 164                 hdr->sleep_cpu_mpidr);
 165         if (sleep_cpu < 0) {
 166                 pr_crit("Hibernated on a CPU not known to this kernel!\n");
 167                 sleep_cpu = -EINVAL;
 168                 return -EINVAL;
 169         }
 170         if (!cpu_online(sleep_cpu)) {
 171                 pr_info("Hibernated on a CPU that is offline! Bringing CPU up.\n");
 172                 ret = cpu_up(sleep_cpu);
 173                 if (ret) {
 174                         pr_err("Failed to bring hibernate-CPU up!\n");
 175                         sleep_cpu = -EINVAL;
 176                         return ret;
 177                 }
 178         }
 179
 180         resume_hdr = *hdr;
 181
 182         return 0;
 183 }
 184 EXPORT_SYMBOL(arch_hibernation_header_restore);
 185
 186 /*
 187  * Copies length bytes, starting at src_start into an new page,
 188  * perform cache maintentance, then maps it at the specified address low
 189  * address as executable.
 190  *
 191  * This is used by hibernate to copy the code it needs to execute when
 192  * overwriting the kernel text. This function generates a new set of page
 193  * tables, which it loads into ttbr0.
 194  *
 195  * Length is provided as we probably only want 4K of data, even on a 64K
 196  * page system.
 197  */
 198 static int create_safe_exec_page(void *src_start, size_t length,
 199                                  unsigned long dst_addr,
 200                                  phys_addr_t *phys_dst_addr,
 201                                  void *(*allocator)(gfp_t mask),
 202                                  gfp_t mask)
 203 {
 204         int rc = 0;
 205         pgd_t *trans_pgd;
 206         pgd_t *pgdp;
 207         pud_t *pudp;
 208         pmd_t *pmdp;
 209         pte_t *ptep;
 210         unsigned long dst = (unsigned long)allocator(mask);
 211
 212         if (!dst) {
 213                 rc = -ENOMEM;
 214                 goto out;
 215         }
 216
 217         memcpy((void *)dst, src_start, length);
 218         __flush_icache_range(dst, dst + length);
 219
 220         trans_pgd = allocator(mask);
 221         if (!trans_pgd) {
 222                 rc = -ENOMEM;
 223                 goto out;
 224         }
 225
 226         pgdp = pgd_offset_raw(trans_pgd, dst_addr);
 227         if (pgd_none(READ_ONCE(*pgdp))) {
 228                 pudp = allocator(mask);
 229                 if (!pudp) {
 230                         rc = -ENOMEM;
 231                         goto out;
 232                 }
 233                 pgd_populate(&init_mm, pgdp, pudp);
 234         }
 235
 236         pudp = pud_offset(pgdp, dst_addr);
 237         if (pud_none(READ_ONCE(*pudp))) {
 238                 pmdp = allocator(mask);
 239                 if (!pmdp) {
 240                         rc = -ENOMEM;
 241                         goto out;
 242                 }
 243                 pud_populate(&init_mm, pudp, pmdp);
 244         }
 245
 246         pmdp = pmd_offset(pudp, dst_addr);
 247         if (pmd_none(READ_ONCE(*pmdp))) {
 248                 ptep = allocator(mask);
 249                 if (!ptep) {
 250                         rc = -ENOMEM;
 251                         goto out;
 252                 }
 253                 pmd_populate_kernel(&init_mm, pmdp, ptep);
 254         }
 255
 256         ptep = pte_offset_kernel(pmdp, dst_addr);
 257         set_pte(ptep, pfn_pte(virt_to_pfn(dst), PAGE_KERNEL_EXEC));
 258
 259         /*
 260          * Load our new page tables. A strict BBM approach requires that we
 261          * ensure that TLBs are free of any entries that may overlap with the
 262          * global mappings we are about to install.
 263          *
 264          * For a real hibernate/resume cycle TTBR0 currently points to a zero
 265          * page, but TLBs may contain stale ASID-tagged entries (e.g. for EFI
 266          * runtime services), while for a userspace-driven test_resume cycle it
 267          * points to userspace page tables (and we must point it at a zero page
 268          * ourselves). Elsewhere we only (un)install the idmap with preemption
 269          * disabled, so T0SZ should be as required regardless.
 270          */
 271         cpu_set_reserved_ttbr0();
 272         local_flush_tlb_all();
 273         write_sysreg(phys_to_ttbr(virt_to_phys(pgdp)), ttbr0_el1);
 274         isb();
 275
 276         *phys_dst_addr = virt_to_phys((void *)dst);
 277
 278 out:
 279         return rc;
 280 }
 281
 282 #define dcache_clean_range(start, end)  __flush_dcache_area(start, (end - start))
 283
 284 int swsusp_arch_suspend(void)
 285 {
 286         int ret = 0;
 287         unsigned long flags;
 288         struct sleep_stack_data state;
 289
 290         if (cpus_are_stuck_in_kernel()) {
 291                 pr_err("Can't hibernate: no mechanism to offline secondary CPUs.\n");
 292                 return -EBUSY;
 293         }
 294
 295         flags = local_daif_save();
 296
 297         if (__cpu_suspend_enter(&state)) {
 298                 /* make the crash dump kernel image visible/saveable */
 299                 crash_prepare_suspend();
 300
 301                 sleep_cpu = smp_processor_id();
 302                 ret = swsusp_save();
 303         } else {
 304                 /* Clean kernel core startup/idle code to PoC*/
 305                 dcache_clean_range(__mmuoff_data_start, __mmuoff_data_end);
 306                 dcache_clean_range(__idmap_text_start, __idmap_text_end);
 307
 308                 /* Clean kvm setup code to PoC? */
 309                 if (el2_reset_needed()) {
 310                         dcache_clean_range(__hyp_idmap_text_start, __hyp_idmap_text_end);
 311                         dcache_clean_range(__hyp_text_start, __hyp_text_end);
 312                 }
 313
 314                 /* make the crash dump kernel image protected again */
 315                 crash_post_resume();
 316
 317                 /*
 318                  * Tell the hibernation core that we've just restored
 319                  * the memory
 320                  */
 321                 in_suspend = 0;
 322
 323                 sleep_cpu = -EINVAL;
 324                 __cpu_suspend_exit();
 325
 326                 /*
 327                  * Just in case the boot kernel did turn the SSBD
 328                  * mitigation off behind our back, let's set the state
 329                  * to what we expect it to be.
 330                  */
 331                 switch (arm64_get_ssbd_state()) {
 332                 case ARM64_SSBD_FORCE_ENABLE:
 333                 case ARM64_SSBD_KERNEL:
 334                         arm64_set_ssbd_mitigation(true);
 335                 }
 336         }
 337
 338         local_daif_restore(flags);
 339
 340         return ret;
 341 }
 342
 343 static void _copy_pte(pte_t *dst_ptep, pte_t *src_ptep, unsigned long addr)
 344 {
 345         pte_t pte = READ_ONCE(*src_ptep);
 346
 347         if (pte_valid(pte)) {
 348                 /*
 349                  * Resume will overwrite areas that may be marked
 350                  * read only (code, rodata). Clear the RDONLY bit from
 351                  * the temporary mappings we use during restore.
 352                  */
 353                 set_pte(dst_ptep, pte_mkwrite(pte));
 354         } else if (debug_pagealloc_enabled() && !pte_none(pte)) {
 355                 /*
 356                  * debug_pagealloc will removed the PTE_VALID bit if
 357                  * the page isn't in use by the resume kernel. It may have
 358                  * been in use by the original kernel, in which case we need
 359                  * to put it back in our copy to do the restore.
 360                  *
 361                  * Before marking this entry valid, check the pfn should
 362                  * be mapped.
 363                  */
 364                 BUG_ON(!pfn_valid(pte_pfn(pte)));
 365
 366                 set_pte(dst_ptep, pte_mkpresent(pte_mkwrite(pte)));
 367         }
 368 }
 369
 370 static int copy_pte(pmd_t *dst_pmdp, pmd_t *src_pmdp, unsigned long start,
 371                     unsigned long end)
 372 {
 373         pte_t *src_ptep;
 374         pte_t *dst_ptep;
 375         unsigned long addr = start;
 376
 377         dst_ptep = (pte_t *)get_safe_page(GFP_ATOMIC);
 378         if (!dst_ptep)
 379                 return -ENOMEM;
 380         pmd_populate_kernel(&init_mm, dst_pmdp, dst_ptep);
 381         dst_ptep = pte_offset_kernel(dst_pmdp, start);
 382
 383         src_ptep = pte_offset_kernel(src_pmdp, start);
 384         do {
 385                 _copy_pte(dst_ptep, src_ptep, addr);
 386         } while (dst_ptep++, src_ptep++, addr += PAGE_SIZE, addr != end);
 387
 388         return 0;
 389 }
 390
 391 static int copy_pmd(pud_t *dst_pudp, pud_t *src_pudp, unsigned long start,
 392                     unsigned long end)
 393 {
 394         pmd_t *src_pmdp;
 395         pmd_t *dst_pmdp;
 396         unsigned long next;
 397         unsigned long addr = start;
 398
 399         if (pud_none(READ_ONCE(*dst_pudp))) {
 400                 dst_pmdp = (pmd_t *)get_safe_page(GFP_ATOMIC);
 401                 if (!dst_pmdp)
 402                         return -ENOMEM;
 403                 pud_populate(&init_mm, dst_pudp, dst_pmdp);
 404         }
 405         dst_pmdp = pmd_offset(dst_pudp, start);
 406
 407         src_pmdp = pmd_offset(src_pudp, start);
 408         do {
 409                 pmd_t pmd = READ_ONCE(*src_pmdp);
 410
 411                 next = pmd_addr_end(addr, end);
 412                 if (pmd_none(pmd))
 413                         continue;
 414                 if (pmd_table(pmd)) {
 415                         if (copy_pte(dst_pmdp, src_pmdp, addr, next))
 416                                 return -ENOMEM;
 417                 } else {
 418                         set_pmd(dst_pmdp,
 419                                 __pmd(pmd_val(pmd) & ~PMD_SECT_RDONLY));
 420                 }
 421         } while (dst_pmdp++, src_pmdp++, addr = next, addr != end);
 422
 423         return 0;
 424 }
 425
 426 static int copy_pud(pgd_t *dst_pgdp, pgd_t *src_pgdp, unsigned long start,
 427                     unsigned long end)
 428 {
 429         pud_t *dst_pudp;
 430         pud_t *src_pudp;
 431         unsigned long next;
 432         unsigned long addr = start;
 433
 434         if (pgd_none(READ_ONCE(*dst_pgdp))) {
 435                 dst_pudp = (pud_t *)get_safe_page(GFP_ATOMIC);
 436                 if (!dst_pudp)
 437                         return -ENOMEM;
 438                 pgd_populate(&init_mm, dst_pgdp, dst_pudp);
 439         }
 440         dst_pudp = pud_offset(dst_pgdp, start);
 441
 442         src_pudp = pud_offset(src_pgdp, start);
 443         do {
 444                 pud_t pud = READ_ONCE(*src_pudp);
 445
 446                 next = pud_addr_end(addr, end);
 447                 if (pud_none(pud))
 448                         continue;
 449                 if (pud_table(pud)) {
 450                         if (copy_pmd(dst_pudp, src_pudp, addr, next))
 451                                 return -ENOMEM;
 452                 } else {
 453                         set_pud(dst_pudp,
 454                                 __pud(pud_val(pud) & ~PMD_SECT_RDONLY));
 455                 }
 456         } while (dst_pudp++, src_pudp++, addr = next, addr != end);
 457
 458         return 0;
 459 }
 460
 461 static int copy_page_tables(pgd_t *dst_pgdp, unsigned long start,
 462                             unsigned long end)
 463 {
 464         unsigned long next;
 465         unsigned long addr = start;
 466         pgd_t *src_pgdp = pgd_offset_k(start);
 467
 468         dst_pgdp = pgd_offset_raw(dst_pgdp, start);
 469         do {
 470                 next = pgd_addr_end(addr, end);
 471                 if (pgd_none(READ_ONCE(*src_pgdp)))
 472                         continue;
 473                 if (copy_pud(dst_pgdp, src_pgdp, addr, next))
 474                         return -ENOMEM;
 475         } while (dst_pgdp++, src_pgdp++, addr = next, addr != end);
 476
 477         return 0;
 478 }
 479
 480 /*
 481  * Setup then Resume from the hibernate image using swsusp_arch_suspend_exit().
 482  *
 483  * Memory allocated by get_safe_page() will be dealt with by the hibernate code,
 484  * we don't need to free it here.
 485  */
 486 int swsusp_arch_resume(void)
 487 {
 488         int rc = 0;
 489         void *zero_page;
 490         size_t exit_size;
 491         pgd_t *tmp_pg_dir;
 492         phys_addr_t phys_hibernate_exit;
 493         void __noreturn (*hibernate_exit)(phys_addr_t, phys_addr_t, void *,
 494                                           void *, phys_addr_t, phys_addr_t);
 495
 496         /*
 497          * Restoring the memory image will overwrite the ttbr1 page tables.
 498          * Create a second copy of just the linear map, and use this when
 499          * restoring.
 500          */
 501         tmp_pg_dir = (pgd_t *)get_safe_page(GFP_ATOMIC);
 502         if (!tmp_pg_dir) {
 503                 pr_err("Failed to allocate memory for temporary page tables.\n");
 504                 rc = -ENOMEM;
 505                 goto out;
 506         }
 507         rc = copy_page_tables(tmp_pg_dir, PAGE_OFFSET, 0);
 508         if (rc)
 509                 goto out;
 510
 511         /*
 512          * We need a zero page that is zero before & after resume in order to
 513          * to break before make on the ttbr1 page tables.
 514          */
 515         zero_page = (void *)get_safe_page(GFP_ATOMIC);
 516         if (!zero_page) {
 517                 pr_err("Failed to allocate zero page.\n");
 518                 rc = -ENOMEM;
 519                 goto out;
 520         }
 521
 522         /*
 523          * Locate the exit code in the bottom-but-one page, so that *NULL
 524          * still has disastrous affects.
 525          */
 526         hibernate_exit = (void *)PAGE_SIZE;
 527         exit_size = __hibernate_exit_text_end - __hibernate_exit_text_start;
 528         /*
 529          * Copy swsusp_arch_suspend_exit() to a safe page. This will generate
 530          * a new set of ttbr0 page tables and load them.
 531          */
 532         rc = create_safe_exec_page(__hibernate_exit_text_start, exit_size,
 533                                    (unsigned long)hibernate_exit,
 534                                    &phys_hibernate_exit,
 535                                    (void *)get_safe_page, GFP_ATOMIC);
 536         if (rc) {
 537                 pr_err("Failed to create safe executable page for hibernate_exit code.\n");
 538                 goto out;
 539         }
 540
 541         /*
 542          * The hibernate exit text contains a set of el2 vectors, that will
 543          * be executed at el2 with the mmu off in order to reload hyp-stub.
 544          */
 545         __flush_dcache_area(hibernate_exit, exit_size);
 546
 547         /*
 548          * KASLR will cause the el2 vectors to be in a different location in
 549          * the resumed kernel. Load hibernate's temporary copy into el2.
 550          *
 551          * We can skip this step if we booted at EL1, or are running with VHE.
 552          */
 553         if (el2_reset_needed()) {
 554                 phys_addr_t el2_vectors = phys_hibernate_exit;  /* base */
 555                 el2_vectors += hibernate_el2_vectors -
 556                                __hibernate_exit_text_start;     /* offset */
 557
 558                 __hyp_set_vectors(el2_vectors);
 559         }
 560
 561         hibernate_exit(virt_to_phys(tmp_pg_dir), resume_hdr.ttbr1_el1,
 562                        resume_hdr.reenter_kernel, restore_pblist,
 563                        resume_hdr.__hyp_stub_vectors, virt_to_phys(zero_page));
 564
 565 out:
 566         return rc;
 567 }
 568
 569 int hibernate_resume_nonboot_cpu_disable(void)
 570 {
 571         if (sleep_cpu < 0) {
 572                 pr_err("Failing to resume from hibernate on an unknown CPU.\n");
 573                 return -ENODEV;
 574         }
 575
 576         return freeze_secondary_cpus(sleep_cpu);
 577 }