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/kvm_host.h>
  19 #include <linux/mm.h>
  20 #include <linux/notifier.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/irqflags.h>
  30 #include <asm/memory.h>
  31 #include <asm/mmu_context.h>
  32 #include <asm/pgalloc.h>
  33 #include <asm/pgtable.h>
  34 #include <asm/pgtable-hwdef.h>
  35 #include <asm/sections.h>
  36 #include <asm/smp.h>
  37 #include <asm/suspend.h>
  38 #include <asm/sysreg.h>
  39 #include <asm/virt.h>
  40
  41 /*
  42  * Hibernate core relies on this value being 0 on resume, and marks it
  43  * __nosavedata assuming it will keep the resume kernel's '0' value. This
  44  * doesn't happen with either KASLR.
  45  *
  46  * defined as "__visible int in_suspend __nosavedata" in
  47  * kernel/power/hibernate.c
  48  */
  49 extern int in_suspend;
  50
  51 /* Find a symbols alias in the linear map */
  52 #define LMADDR(x)       phys_to_virt(virt_to_phys(x))
  53
  54 /* Do we need to reset el2? */
  55 #define el2_reset_needed() (is_hyp_mode_available() && !is_kernel_in_hyp_mode())
  56
  57 /* temporary el2 vectors in the __hibernate_exit_text section. */
  58 extern char hibernate_el2_vectors[];
  59
  60 /* hyp-stub vectors, used to restore el2 during resume from hibernate. */
  61 extern char __hyp_stub_vectors[];
  62
  63 /*
  64  * Values that may not change over hibernate/resume. We put the build number
  65  * and date in here so that we guarantee not to resume with a different
  66  * kernel.
  67  */
  68 struct arch_hibernate_hdr_invariants {
  69         char            uts_version[__NEW_UTS_LEN + 1];
  70 };
  71
  72 /* These values need to be know across a hibernate/restore. */
  73 static struct arch_hibernate_hdr {
  74         struct arch_hibernate_hdr_invariants invariants;
  75
  76         /* These are needed to find the relocated kernel if built with kaslr */
  77         phys_addr_t     ttbr1_el1;
  78         void            (*reenter_kernel)(void);
  79
  80         /*
  81          * We need to know where the __hyp_stub_vectors are after restore to
  82          * re-configure el2.
  83          */
  84         phys_addr_t     __hyp_stub_vectors;
  85 } resume_hdr;
  86
  87 static inline void arch_hdr_invariants(struct arch_hibernate_hdr_invariants *i)
  88 {
  89         memset(i, 0, sizeof(*i));
  90         memcpy(i->uts_version, init_utsname()->version, sizeof(i->uts_version));
  91 }
  92
  93 int pfn_is_nosave(unsigned long pfn)
  94 {
  95         unsigned long nosave_begin_pfn = virt_to_pfn(&__nosave_begin);
  96         unsigned long nosave_end_pfn = virt_to_pfn(&__nosave_end - 1);
  97
  98         return (pfn >= nosave_begin_pfn) && (pfn <= nosave_end_pfn);
  99 }
 100
 101 void notrace save_processor_state(void)
 102 {
 103         WARN_ON(num_online_cpus() != 1);
 104 }
 105
 106 void notrace restore_processor_state(void)
 107 {
 108 }
 109
 110 int arch_hibernation_header_save(void *addr, unsigned int max_size)
 111 {
 112         struct arch_hibernate_hdr *hdr = addr;
 113
 114         if (max_size < sizeof(*hdr))
 115                 return -EOVERFLOW;
 116
 117         arch_hdr_invariants(&hdr->invariants);
 118         hdr->ttbr1_el1          = virt_to_phys(swapper_pg_dir);
 119         hdr->reenter_kernel     = _cpu_resume;
 120
 121         /* We can't use __hyp_get_vectors() because kvm may still be loaded */
 122         if (el2_reset_needed())
 123                 hdr->__hyp_stub_vectors = virt_to_phys(__hyp_stub_vectors);
 124         else
 125                 hdr->__hyp_stub_vectors = 0;
 126
 127         return 0;
 128 }
 129 EXPORT_SYMBOL(arch_hibernation_header_save);
 130
 131 int arch_hibernation_header_restore(void *addr)
 132 {
 133         struct arch_hibernate_hdr_invariants invariants;
 134         struct arch_hibernate_hdr *hdr = addr;
 135
 136         arch_hdr_invariants(&invariants);
 137         if (memcmp(&hdr->invariants, &invariants, sizeof(invariants))) {
 138                 pr_crit("Hibernate image not generated by this kernel!\n");
 139                 return -EINVAL;
 140         }
 141
 142         resume_hdr = *hdr;
 143
 144         return 0;
 145 }
 146 EXPORT_SYMBOL(arch_hibernation_header_restore);
 147
 148 /*
 149  * Copies length bytes, starting at src_start into an new page,
 150  * perform cache maintentance, then maps it at the specified address low
 151  * address as executable.
 152  *
 153  * This is used by hibernate to copy the code it needs to execute when
 154  * overwriting the kernel text. This function generates a new set of page
 155  * tables, which it loads into ttbr0.
 156  *
 157  * Length is provided as we probably only want 4K of data, even on a 64K
 158  * page system.
 159  */
 160 static int create_safe_exec_page(void *src_start, size_t length,
 161                                  unsigned long dst_addr,
 162                                  phys_addr_t *phys_dst_addr,
 163                                  void *(*allocator)(gfp_t mask),
 164                                  gfp_t mask)
 165 {
 166         int rc = 0;
 167         pgd_t *pgd;
 168         pud_t *pud;
 169         pmd_t *pmd;
 170         pte_t *pte;
 171         unsigned long dst = (unsigned long)allocator(mask);
 172
 173         if (!dst) {
 174                 rc = -ENOMEM;
 175                 goto out;
 176         }
 177
 178         memcpy((void *)dst, src_start, length);
 179         flush_icache_range(dst, dst + length);
 180
 181         pgd = pgd_offset_raw(allocator(mask), dst_addr);
 182         if (pgd_none(*pgd)) {
 183                 pud = allocator(mask);
 184                 if (!pud) {
 185                         rc = -ENOMEM;
 186                         goto out;
 187                 }
 188                 pgd_populate(&init_mm, pgd, pud);
 189         }
 190
 191         pud = pud_offset(pgd, dst_addr);
 192         if (pud_none(*pud)) {
 193                 pmd = allocator(mask);
 194                 if (!pmd) {
 195                         rc = -ENOMEM;
 196                         goto out;
 197                 }
 198                 pud_populate(&init_mm, pud, pmd);
 199         }
 200
 201         pmd = pmd_offset(pud, dst_addr);
 202         if (pmd_none(*pmd)) {
 203                 pte = allocator(mask);
 204                 if (!pte) {
 205                         rc = -ENOMEM;
 206                         goto out;
 207                 }
 208                 pmd_populate_kernel(&init_mm, pmd, pte);
 209         }
 210
 211         pte = pte_offset_kernel(pmd, dst_addr);
 212         set_pte(pte, __pte(virt_to_phys((void *)dst) |
 213                          pgprot_val(PAGE_KERNEL_EXEC)));
 214
 215         /*
 216          * Load our new page tables. A strict BBM approach requires that we
 217          * ensure that TLBs are free of any entries that may overlap with the
 218          * global mappings we are about to install.
 219          *
 220          * For a real hibernate/resume cycle TTBR0 currently points to a zero
 221          * page, but TLBs may contain stale ASID-tagged entries (e.g. for EFI
 222          * runtime services), while for a userspace-driven test_resume cycle it
 223          * points to userspace page tables (and we must point it at a zero page
 224          * ourselves). Elsewhere we only (un)install the idmap with preemption
 225          * disabled, so T0SZ should be as required regardless.
 226          */
 227         cpu_set_reserved_ttbr0();
 228         local_flush_tlb_all();
 229         write_sysreg(virt_to_phys(pgd), ttbr0_el1);
 230         isb();
 231
 232         *phys_dst_addr = virt_to_phys((void *)dst);
 233
 234 out:
 235         return rc;
 236 }
 237
 238
 239 int swsusp_arch_suspend(void)
 240 {
 241         int ret = 0;
 242         unsigned long flags;
 243         struct sleep_stack_data state;
 244
 245         if (cpus_are_stuck_in_kernel()) {
 246                 pr_err("Can't hibernate: no mechanism to offline secondary CPUs.\n");
 247                 return -EBUSY;
 248         }
 249
 250         local_dbg_save(flags);
 251
 252         if (__cpu_suspend_enter(&state)) {
 253                 ret = swsusp_save();
 254         } else {
 255                 /* Clean kernel to PoC for secondary core startup */
 256                 __flush_dcache_area(LMADDR(KERNEL_START), KERNEL_END - KERNEL_START);
 257
 258                 /*
 259                  * Tell the hibernation core that we've just restored
 260                  * the memory
 261                  */
 262                 in_suspend = 0;
 263
 264                 __cpu_suspend_exit();
 265         }
 266
 267         local_dbg_restore(flags);
 268
 269         return ret;
 270 }
 271
 272 static int copy_pte(pmd_t *dst_pmd, pmd_t *src_pmd, unsigned long start,
 273                     unsigned long end)
 274 {
 275         pte_t *src_pte;
 276         pte_t *dst_pte;
 277         unsigned long addr = start;
 278
 279         dst_pte = (pte_t *)get_safe_page(GFP_ATOMIC);
 280         if (!dst_pte)
 281                 return -ENOMEM;
 282         pmd_populate_kernel(&init_mm, dst_pmd, dst_pte);
 283         dst_pte = pte_offset_kernel(dst_pmd, start);
 284
 285         src_pte = pte_offset_kernel(src_pmd, start);
 286         do {
 287                 if (!pte_none(*src_pte))
 288                         /*
 289                          * Resume will overwrite areas that may be marked
 290                          * read only (code, rodata). Clear the RDONLY bit from
 291                          * the temporary mappings we use during restore.
 292                          */
 293                         set_pte(dst_pte, __pte(pte_val(*src_pte) & ~PTE_RDONLY));
 294         } while (dst_pte++, src_pte++, addr += PAGE_SIZE, addr != end);
 295
 296         return 0;
 297 }
 298
 299 static int copy_pmd(pud_t *dst_pud, pud_t *src_pud, unsigned long start,
 300                     unsigned long end)
 301 {
 302         pmd_t *src_pmd;
 303         pmd_t *dst_pmd;
 304         unsigned long next;
 305         unsigned long addr = start;
 306
 307         if (pud_none(*dst_pud)) {
 308                 dst_pmd = (pmd_t *)get_safe_page(GFP_ATOMIC);
 309                 if (!dst_pmd)
 310                         return -ENOMEM;
 311                 pud_populate(&init_mm, dst_pud, dst_pmd);
 312         }
 313         dst_pmd = pmd_offset(dst_pud, start);
 314
 315         src_pmd = pmd_offset(src_pud, start);
 316         do {
 317                 next = pmd_addr_end(addr, end);
 318                 if (pmd_none(*src_pmd))
 319                         continue;
 320                 if (pmd_table(*src_pmd)) {
 321                         if (copy_pte(dst_pmd, src_pmd, addr, next))
 322                                 return -ENOMEM;
 323                 } else {
 324                         set_pmd(dst_pmd,
 325                                 __pmd(pmd_val(*src_pmd) & ~PMD_SECT_RDONLY));
 326                 }
 327         } while (dst_pmd++, src_pmd++, addr = next, addr != end);
 328
 329         return 0;
 330 }
 331
 332 static int copy_pud(pgd_t *dst_pgd, pgd_t *src_pgd, unsigned long start,
 333                     unsigned long end)
 334 {
 335         pud_t *dst_pud;
 336         pud_t *src_pud;
 337         unsigned long next;
 338         unsigned long addr = start;
 339
 340         if (pgd_none(*dst_pgd)) {
 341                 dst_pud = (pud_t *)get_safe_page(GFP_ATOMIC);
 342                 if (!dst_pud)
 343                         return -ENOMEM;
 344                 pgd_populate(&init_mm, dst_pgd, dst_pud);
 345         }
 346         dst_pud = pud_offset(dst_pgd, start);
 347
 348         src_pud = pud_offset(src_pgd, start);
 349         do {
 350                 next = pud_addr_end(addr, end);
 351                 if (pud_none(*src_pud))
 352                         continue;
 353                 if (pud_table(*(src_pud))) {
 354                         if (copy_pmd(dst_pud, src_pud, addr, next))
 355                                 return -ENOMEM;
 356                 } else {
 357                         set_pud(dst_pud,
 358                                 __pud(pud_val(*src_pud) & ~PMD_SECT_RDONLY));
 359                 }
 360         } while (dst_pud++, src_pud++, addr = next, addr != end);
 361
 362         return 0;
 363 }
 364
 365 static int copy_page_tables(pgd_t *dst_pgd, unsigned long start,
 366                             unsigned long end)
 367 {
 368         unsigned long next;
 369         unsigned long addr = start;
 370         pgd_t *src_pgd = pgd_offset_k(start);
 371
 372         dst_pgd = pgd_offset_raw(dst_pgd, start);
 373         do {
 374                 next = pgd_addr_end(addr, end);
 375                 if (pgd_none(*src_pgd))
 376                         continue;
 377                 if (copy_pud(dst_pgd, src_pgd, addr, next))
 378                         return -ENOMEM;
 379         } while (dst_pgd++, src_pgd++, addr = next, addr != end);
 380
 381         return 0;
 382 }
 383
 384 /*
 385  * Setup then Resume from the hibernate image using swsusp_arch_suspend_exit().
 386  *
 387  * Memory allocated by get_safe_page() will be dealt with by the hibernate code,
 388  * we don't need to free it here.
 389  */
 390 int swsusp_arch_resume(void)
 391 {
 392         int rc = 0;
 393         void *zero_page;
 394         size_t exit_size;
 395         pgd_t *tmp_pg_dir;
 396         void *lm_restore_pblist;
 397         phys_addr_t phys_hibernate_exit;
 398         void __noreturn (*hibernate_exit)(phys_addr_t, phys_addr_t, void *,
 399                                           void *, phys_addr_t, phys_addr_t);
 400
 401         /*
 402          * Restoring the memory image will overwrite the ttbr1 page tables.
 403          * Create a second copy of just the linear map, and use this when
 404          * restoring.
 405          */
 406         tmp_pg_dir = (pgd_t *)get_safe_page(GFP_ATOMIC);
 407         if (!tmp_pg_dir) {
 408                 pr_err("Failed to allocate memory for temporary page tables.");
 409                 rc = -ENOMEM;
 410                 goto out;
 411         }
 412         rc = copy_page_tables(tmp_pg_dir, PAGE_OFFSET, 0);
 413         if (rc)
 414                 goto out;
 415
 416         /*
 417          * Since we only copied the linear map, we need to find restore_pblist's
 418          * linear map address.
 419          */
 420         lm_restore_pblist = LMADDR(restore_pblist);
 421
 422         /*
 423          * We need a zero page that is zero before & after resume in order to
 424          * to break before make on the ttbr1 page tables.
 425          */
 426         zero_page = (void *)get_safe_page(GFP_ATOMIC);
 427         if (!zero_page) {
 428                 pr_err("Failed to allocate zero page.");
 429                 rc = -ENOMEM;
 430                 goto out;
 431         }
 432
 433         /*
 434          * Locate the exit code in the bottom-but-one page, so that *NULL
 435          * still has disastrous affects.
 436          */
 437         hibernate_exit = (void *)PAGE_SIZE;
 438         exit_size = __hibernate_exit_text_end - __hibernate_exit_text_start;
 439         /*
 440          * Copy swsusp_arch_suspend_exit() to a safe page. This will generate
 441          * a new set of ttbr0 page tables and load them.
 442          */
 443         rc = create_safe_exec_page(__hibernate_exit_text_start, exit_size,
 444                                    (unsigned long)hibernate_exit,
 445                                    &phys_hibernate_exit,
 446                                    (void *)get_safe_page, GFP_ATOMIC);
 447         if (rc) {
 448                 pr_err("Failed to create safe executable page for hibernate_exit code.");
 449                 goto out;
 450         }
 451
 452         /*
 453          * The hibernate exit text contains a set of el2 vectors, that will
 454          * be executed at el2 with the mmu off in order to reload hyp-stub.
 455          */
 456         __flush_dcache_area(hibernate_exit, exit_size);
 457
 458         /*
 459          * KASLR will cause the el2 vectors to be in a different location in
 460          * the resumed kernel. Load hibernate's temporary copy into el2.
 461          *
 462          * We can skip this step if we booted at EL1, or are running with VHE.
 463          */
 464         if (el2_reset_needed()) {
 465                 phys_addr_t el2_vectors = phys_hibernate_exit;  /* base */
 466                 el2_vectors += hibernate_el2_vectors -
 467                                __hibernate_exit_text_start;     /* offset */
 468
 469                 __hyp_set_vectors(el2_vectors);
 470         }
 471
 472         hibernate_exit(virt_to_phys(tmp_pg_dir), resume_hdr.ttbr1_el1,
 473                        resume_hdr.reenter_kernel, lm_restore_pblist,
 474                        resume_hdr.__hyp_stub_vectors, virt_to_phys(zero_page));
 475
 476 out:
 477         return rc;
 478 }
 479
 480 static int check_boot_cpu_online_pm_callback(struct notifier_block *nb,
 481                                              unsigned long action, void *ptr)
 482 {
 483         if (action == PM_HIBERNATION_PREPARE &&
 484              cpumask_first(cpu_online_mask) != 0) {
 485                 pr_warn("CPU0 is offline.\n");
 486                 return notifier_from_errno(-ENODEV);
 487         }
 488
 489         return NOTIFY_OK;
 490 }
 491
 492 static int __init check_boot_cpu_online_init(void)
 493 {
 494         /*
 495          * Set this pm_notifier callback with a lower priority than
 496          * cpu_hotplug_pm_callback, so that cpu_hotplug_pm_callback will be
 497          * called earlier to disable cpu hotplug before the cpu online check.
 498          */
 499         pm_notifier(check_boot_cpu_online_pm_callback, -INT_MAX);
 500
 501         return 0;
 502 }
 503 core_initcall(check_boot_cpu_online_init);