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/irqflags.h>
  31 #include <asm/memory.h>
  32 #include <asm/mmu_context.h>
  33 #include <asm/pgalloc.h>
  34 #include <asm/pgtable.h>
  35 #include <asm/pgtable-hwdef.h>
  36 #include <asm/sections.h>
  37 #include <asm/smp.h>
  38 #include <asm/smp_plat.h>
  39 #include <asm/suspend.h>
  40 #include <asm/sysreg.h>
  41 #include <asm/virt.h>
  42
  43 /*
  44  * Hibernate core relies on this value being 0 on resume, and marks it
  45  * __nosavedata assuming it will keep the resume kernel's '0' value. This
  46  * doesn't happen with either KASLR.
  47  *
  48  * defined as "__visible int in_suspend __nosavedata" in
  49  * kernel/power/hibernate.c
  50  */
  51 extern int in_suspend;
  52
  53 /* Find a symbols alias in the linear map */
  54 #define LMADDR(x)       phys_to_virt(virt_to_phys(x))
  55
  56 /* Do we need to reset el2? */
  57 #define el2_reset_needed() (is_hyp_mode_available() && !is_kernel_in_hyp_mode())
  58
  59 /* temporary el2 vectors in the __hibernate_exit_text section. */
  60 extern char hibernate_el2_vectors[];
  61
  62 /* hyp-stub vectors, used to restore el2 during resume from hibernate. */
  63 extern char __hyp_stub_vectors[];
  64
  65 /*
  66  * The logical cpu number we should resume on, initialised to a non-cpu
  67  * number.
  68  */
  69 static int sleep_cpu = -EINVAL;
  70
  71 /*
  72  * Values that may not change over hibernate/resume. We put the build number
  73  * and date in here so that we guarantee not to resume with a different
  74  * kernel.
  75  */
  76 struct arch_hibernate_hdr_invariants {
  77         char            uts_version[__NEW_UTS_LEN + 1];
  78 };
  79
  80 /* These values need to be know across a hibernate/restore. */
  81 static struct arch_hibernate_hdr {
  82         struct arch_hibernate_hdr_invariants invariants;
  83
  84         /* These are needed to find the relocated kernel if built with kaslr */
  85         phys_addr_t     ttbr1_el1;
  86         void            (*reenter_kernel)(void);
  87
  88         /*
  89          * We need to know where the __hyp_stub_vectors are after restore to
  90          * re-configure el2.
  91          */
  92         phys_addr_t     __hyp_stub_vectors;
  93
  94         u64             sleep_cpu_mpidr;
  95 } resume_hdr;
  96
  97 static inline void arch_hdr_invariants(struct arch_hibernate_hdr_invariants *i)
  98 {
  99         memset(i, 0, sizeof(*i));
 100         memcpy(i->uts_version, init_utsname()->version, sizeof(i->uts_version));
 101 }
 102
 103 int pfn_is_nosave(unsigned long pfn)
 104 {
 105         unsigned long nosave_begin_pfn = virt_to_pfn(&__nosave_begin);
 106         unsigned long nosave_end_pfn = virt_to_pfn(&__nosave_end - 1);
 107
 108         return (pfn >= nosave_begin_pfn) && (pfn <= nosave_end_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          = virt_to_phys(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 = virt_to_phys(__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 unkown 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 *pgd;
 206         pud_t *pud;
 207         pmd_t *pmd;
 208         pte_t *pte;
 209         unsigned long dst = (unsigned long)allocator(mask);
 210
 211         if (!dst) {
 212                 rc = -ENOMEM;
 213                 goto out;
 214         }
 215
 216         memcpy((void *)dst, src_start, length);
 217         flush_icache_range(dst, dst + length);
 218
 219         pgd = pgd_offset_raw(allocator(mask), dst_addr);
 220         if (pgd_none(*pgd)) {
 221                 pud = allocator(mask);
 222                 if (!pud) {
 223                         rc = -ENOMEM;
 224                         goto out;
 225                 }
 226                 pgd_populate(&init_mm, pgd, pud);
 227         }
 228
 229         pud = pud_offset(pgd, dst_addr);
 230         if (pud_none(*pud)) {
 231                 pmd = allocator(mask);
 232                 if (!pmd) {
 233                         rc = -ENOMEM;
 234                         goto out;
 235                 }
 236                 pud_populate(&init_mm, pud, pmd);
 237         }
 238
 239         pmd = pmd_offset(pud, dst_addr);
 240         if (pmd_none(*pmd)) {
 241                 pte = allocator(mask);
 242                 if (!pte) {
 243                         rc = -ENOMEM;
 244                         goto out;
 245                 }
 246                 pmd_populate_kernel(&init_mm, pmd, pte);
 247         }
 248
 249         pte = pte_offset_kernel(pmd, dst_addr);
 250         set_pte(pte, __pte(virt_to_phys((void *)dst) |
 251                          pgprot_val(PAGE_KERNEL_EXEC)));
 252
 253         /*
 254          * Load our new page tables. A strict BBM approach requires that we
 255          * ensure that TLBs are free of any entries that may overlap with the
 256          * global mappings we are about to install.
 257          *
 258          * For a real hibernate/resume cycle TTBR0 currently points to a zero
 259          * page, but TLBs may contain stale ASID-tagged entries (e.g. for EFI
 260          * runtime services), while for a userspace-driven test_resume cycle it
 261          * points to userspace page tables (and we must point it at a zero page
 262          * ourselves). Elsewhere we only (un)install the idmap with preemption
 263          * disabled, so T0SZ should be as required regardless.
 264          */
 265         cpu_set_reserved_ttbr0();
 266         local_flush_tlb_all();
 267         write_sysreg(virt_to_phys(pgd), ttbr0_el1);
 268         isb();
 269
 270         *phys_dst_addr = virt_to_phys((void *)dst);
 271
 272 out:
 273         return rc;
 274 }
 275
 276 #define dcache_clean_range(start, end)  __flush_dcache_area(start, (end - start))
 277
 278 int swsusp_arch_suspend(void)
 279 {
 280         int ret = 0;
 281         unsigned long flags;
 282         struct sleep_stack_data state;
 283
 284         if (cpus_are_stuck_in_kernel()) {
 285                 pr_err("Can't hibernate: no mechanism to offline secondary CPUs.\n");
 286                 return -EBUSY;
 287         }
 288
 289         local_dbg_save(flags);
 290
 291         if (__cpu_suspend_enter(&state)) {
 292                 sleep_cpu = smp_processor_id();
 293                 ret = swsusp_save();
 294         } else {
 295                 /* Clean kernel core startup/idle code to PoC*/
 296                 dcache_clean_range(__mmuoff_data_start, __mmuoff_data_end);
 297                 dcache_clean_range(__idmap_text_start, __idmap_text_end);
 298
 299                 /* Clean kvm setup code to PoC? */
 300                 if (el2_reset_needed()) {
 301                         dcache_clean_range(__hyp_idmap_text_start, __hyp_idmap_text_end);
 302                         dcache_clean_range(__hyp_text_start, __hyp_text_end);
 303                 }
 304
 305                 /*
 306                  * Tell the hibernation core that we've just restored
 307                  * the memory
 308                  */
 309                 in_suspend = 0;
 310
 311                 sleep_cpu = -EINVAL;
 312                 __cpu_suspend_exit();
 313
 314                 /*
 315                  * Just in case the boot kernel did turn the SSBD
 316                  * mitigation off behind our back, let's set the state
 317                  * to what we expect it to be.
 318                  */
 319                 switch (arm64_get_ssbd_state()) {
 320                 case ARM64_SSBD_FORCE_ENABLE:
 321                 case ARM64_SSBD_KERNEL:
 322                         arm64_set_ssbd_mitigation(true);
 323                 }
 324         }
 325
 326         local_dbg_restore(flags);
 327
 328         return ret;
 329 }
 330
 331 static void _copy_pte(pte_t *dst_pte, pte_t *src_pte, unsigned long addr)
 332 {
 333         pte_t pte = *src_pte;
 334
 335         if (pte_valid(pte)) {
 336                 /*
 337                  * Resume will overwrite areas that may be marked
 338                  * read only (code, rodata). Clear the RDONLY bit from
 339                  * the temporary mappings we use during restore.
 340                  */
 341                 set_pte(dst_pte, pte_clear_rdonly(pte));
 342         } else if (debug_pagealloc_enabled() && !pte_none(pte)) {
 343                 /*
 344                  * debug_pagealloc will removed the PTE_VALID bit if
 345                  * the page isn't in use by the resume kernel. It may have
 346                  * been in use by the original kernel, in which case we need
 347                  * to put it back in our copy to do the restore.
 348                  *
 349                  * Before marking this entry valid, check the pfn should
 350                  * be mapped.
 351                  */
 352                 BUG_ON(!pfn_valid(pte_pfn(pte)));
 353
 354                 set_pte(dst_pte, pte_mkpresent(pte_clear_rdonly(pte)));
 355         }
 356 }
 357
 358 static int copy_pte(pmd_t *dst_pmd, pmd_t *src_pmd, unsigned long start,
 359                     unsigned long end)
 360 {
 361         pte_t *src_pte;
 362         pte_t *dst_pte;
 363         unsigned long addr = start;
 364
 365         dst_pte = (pte_t *)get_safe_page(GFP_ATOMIC);
 366         if (!dst_pte)
 367                 return -ENOMEM;
 368         pmd_populate_kernel(&init_mm, dst_pmd, dst_pte);
 369         dst_pte = pte_offset_kernel(dst_pmd, start);
 370
 371         src_pte = pte_offset_kernel(src_pmd, start);
 372         do {
 373                 _copy_pte(dst_pte, src_pte, addr);
 374         } while (dst_pte++, src_pte++, addr += PAGE_SIZE, addr != end);
 375
 376         return 0;
 377 }
 378
 379 static int copy_pmd(pud_t *dst_pud, pud_t *src_pud, unsigned long start,
 380                     unsigned long end)
 381 {
 382         pmd_t *src_pmd;
 383         pmd_t *dst_pmd;
 384         unsigned long next;
 385         unsigned long addr = start;
 386
 387         if (pud_none(*dst_pud)) {
 388                 dst_pmd = (pmd_t *)get_safe_page(GFP_ATOMIC);
 389                 if (!dst_pmd)
 390                         return -ENOMEM;
 391                 pud_populate(&init_mm, dst_pud, dst_pmd);
 392         }
 393         dst_pmd = pmd_offset(dst_pud, start);
 394
 395         src_pmd = pmd_offset(src_pud, start);
 396         do {
 397                 next = pmd_addr_end(addr, end);
 398                 if (pmd_none(*src_pmd))
 399                         continue;
 400                 if (pmd_table(*src_pmd)) {
 401                         if (copy_pte(dst_pmd, src_pmd, addr, next))
 402                                 return -ENOMEM;
 403                 } else {
 404                         set_pmd(dst_pmd,
 405                                 __pmd(pmd_val(*src_pmd) & ~PMD_SECT_RDONLY));
 406                 }
 407         } while (dst_pmd++, src_pmd++, addr = next, addr != end);
 408
 409         return 0;
 410 }
 411
 412 static int copy_pud(pgd_t *dst_pgd, pgd_t *src_pgd, unsigned long start,
 413                     unsigned long end)
 414 {
 415         pud_t *dst_pud;
 416         pud_t *src_pud;
 417         unsigned long next;
 418         unsigned long addr = start;
 419
 420         if (pgd_none(*dst_pgd)) {
 421                 dst_pud = (pud_t *)get_safe_page(GFP_ATOMIC);
 422                 if (!dst_pud)
 423                         return -ENOMEM;
 424                 pgd_populate(&init_mm, dst_pgd, dst_pud);
 425         }
 426         dst_pud = pud_offset(dst_pgd, start);
 427
 428         src_pud = pud_offset(src_pgd, start);
 429         do {
 430                 next = pud_addr_end(addr, end);
 431                 if (pud_none(*src_pud))
 432                         continue;
 433                 if (pud_table(*(src_pud))) {
 434                         if (copy_pmd(dst_pud, src_pud, addr, next))
 435                                 return -ENOMEM;
 436                 } else {
 437                         set_pud(dst_pud,
 438                                 __pud(pud_val(*src_pud) & ~PMD_SECT_RDONLY));
 439                 }
 440         } while (dst_pud++, src_pud++, addr = next, addr != end);
 441
 442         return 0;
 443 }
 444
 445 static int copy_page_tables(pgd_t *dst_pgd, unsigned long start,
 446                             unsigned long end)
 447 {
 448         unsigned long next;
 449         unsigned long addr = start;
 450         pgd_t *src_pgd = pgd_offset_k(start);
 451
 452         dst_pgd = pgd_offset_raw(dst_pgd, start);
 453         do {
 454                 next = pgd_addr_end(addr, end);
 455                 if (pgd_none(*src_pgd))
 456                         continue;
 457                 if (copy_pud(dst_pgd, src_pgd, addr, next))
 458                         return -ENOMEM;
 459         } while (dst_pgd++, src_pgd++, addr = next, addr != end);
 460
 461         return 0;
 462 }
 463
 464 /*
 465  * Setup then Resume from the hibernate image using swsusp_arch_suspend_exit().
 466  *
 467  * Memory allocated by get_safe_page() will be dealt with by the hibernate code,
 468  * we don't need to free it here.
 469  */
 470 int swsusp_arch_resume(void)
 471 {
 472         int rc = 0;
 473         void *zero_page;
 474         size_t exit_size;
 475         pgd_t *tmp_pg_dir;
 476         void *lm_restore_pblist;
 477         phys_addr_t phys_hibernate_exit;
 478         void __noreturn (*hibernate_exit)(phys_addr_t, phys_addr_t, void *,
 479                                           void *, phys_addr_t, phys_addr_t);
 480
 481         /*
 482          * Restoring the memory image will overwrite the ttbr1 page tables.
 483          * Create a second copy of just the linear map, and use this when
 484          * restoring.
 485          */
 486         tmp_pg_dir = (pgd_t *)get_safe_page(GFP_ATOMIC);
 487         if (!tmp_pg_dir) {
 488                 pr_err("Failed to allocate memory for temporary page tables.");
 489                 rc = -ENOMEM;
 490                 goto out;
 491         }
 492         rc = copy_page_tables(tmp_pg_dir, PAGE_OFFSET, 0);
 493         if (rc)
 494                 goto out;
 495
 496         /*
 497          * Since we only copied the linear map, we need to find restore_pblist's
 498          * linear map address.
 499          */
 500         lm_restore_pblist = LMADDR(restore_pblist);
 501
 502         /*
 503          * We need a zero page that is zero before & after resume in order to
 504          * to break before make on the ttbr1 page tables.
 505          */
 506         zero_page = (void *)get_safe_page(GFP_ATOMIC);
 507         if (!zero_page) {
 508                 pr_err("Failed to allocate zero page.");
 509                 rc = -ENOMEM;
 510                 goto out;
 511         }
 512
 513         /*
 514          * Locate the exit code in the bottom-but-one page, so that *NULL
 515          * still has disastrous affects.
 516          */
 517         hibernate_exit = (void *)PAGE_SIZE;
 518         exit_size = __hibernate_exit_text_end - __hibernate_exit_text_start;
 519         /*
 520          * Copy swsusp_arch_suspend_exit() to a safe page. This will generate
 521          * a new set of ttbr0 page tables and load them.
 522          */
 523         rc = create_safe_exec_page(__hibernate_exit_text_start, exit_size,
 524                                    (unsigned long)hibernate_exit,
 525                                    &phys_hibernate_exit,
 526                                    (void *)get_safe_page, GFP_ATOMIC);
 527         if (rc) {
 528                 pr_err("Failed to create safe executable page for hibernate_exit code.");
 529                 goto out;
 530         }
 531
 532         /*
 533          * The hibernate exit text contains a set of el2 vectors, that will
 534          * be executed at el2 with the mmu off in order to reload hyp-stub.
 535          */
 536         __flush_dcache_area(hibernate_exit, exit_size);
 537
 538         /*
 539          * KASLR will cause the el2 vectors to be in a different location in
 540          * the resumed kernel. Load hibernate's temporary copy into el2.
 541          *
 542          * We can skip this step if we booted at EL1, or are running with VHE.
 543          */
 544         if (el2_reset_needed()) {
 545                 phys_addr_t el2_vectors = phys_hibernate_exit;  /* base */
 546                 el2_vectors += hibernate_el2_vectors -
 547                                __hibernate_exit_text_start;     /* offset */
 548
 549                 __hyp_set_vectors(el2_vectors);
 550         }
 551
 552         hibernate_exit(virt_to_phys(tmp_pg_dir), resume_hdr.ttbr1_el1,
 553                        resume_hdr.reenter_kernel, lm_restore_pblist,
 554                        resume_hdr.__hyp_stub_vectors, virt_to_phys(zero_page));
 555
 556 out:
 557         return rc;
 558 }
 559
 560 int hibernate_resume_nonboot_cpu_disable(void)
 561 {
 562         if (sleep_cpu < 0) {
 563                 pr_err("Failing to resume from hibernate on an unkown CPU.\n");
 564                 return -ENODEV;
 565         }
 566
 567         return freeze_secondary_cpus(sleep_cpu);
 568 }