osfmk/i386/hibernate_restore.c

   1 /*
   2  * Copyright (c) 2008 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*!
  29  * i386/x86_64-specific functions required to support hibernation resume.
  30  */
  31
  32 #include <i386/pmap.h>
  33 #include <i386/proc_reg.h>
  34 #include <IOKit/IOHibernatePrivate.h>
  35 #include <vm/WKdm_new.h>
  36
  37 #include <machine/pal_hibernate.h>
  38
  39 extern pd_entry_t BootPTD[2048];
  40
  41 // src is virtually mapped, not page aligned,
  42 // dst is a physical 4k page aligned ptr, len is one 4K page
  43 // src & dst will not overlap
  44
  45 uintptr_t
  46 hibernate_restore_phys_page(uint64_t src, uint64_t dst, uint32_t len, uint32_t procFlags)
  47 {
  48         (void)procFlags;
  49         uint64_t * d;
  50         uint64_t * s;
  51
  52         if (src == 0) {
  53                 return (uintptr_t)dst;
  54         }
  55
  56         d = (uint64_t *)pal_hib_map(DEST_COPY_AREA, dst);
  57         s = (uint64_t *) (uintptr_t)src;
  58
  59         __nosan_memcpy(d, s, len);
  60
  61         return (uintptr_t)d;
  62 }
  63 #undef hibprintf
  64
  65 void hibprintf(const char *fmt, ...);
  66
  67 uintptr_t
  68 pal_hib_map(uintptr_t virt, uint64_t phys)
  69 {
  70         uintptr_t index;
  71
  72         switch (virt) {
  73         case DEST_COPY_AREA:
  74         case SRC_COPY_AREA:
  75         case COPY_PAGE_AREA:
  76         case BITMAP_AREA:
  77         case IMAGE_AREA:
  78         case IMAGE2_AREA:
  79         case SCRATCH_AREA:
  80         case WKDM_AREA:
  81                 break;
  82
  83         default:
  84                 asm("cli;hlt;");
  85                 break;
  86         }
  87         if (phys < WKDM_AREA) {
  88                 // first 4Gb is all mapped,
  89                 // and do not expect source areas to cross 4Gb
  90                 return phys;
  91         }
  92         index = (virt >> I386_LPGSHIFT);
  93         virt += (uintptr_t)(phys & I386_LPGMASK);
  94         phys  = ((phys & ~((uint64_t)I386_LPGMASK)) | INTEL_PTE_PS  | INTEL_PTE_VALID | INTEL_PTE_WRITE);
  95         if (phys == BootPTD[index]) {
  96                 return virt;
  97         }
  98         BootPTD[index] = phys;
  99         invlpg(virt);
 100         BootPTD[index + 1] = (phys + I386_LPGBYTES);
 101         invlpg(virt + I386_LPGBYTES);
 102
 103         return virt;
 104 }
 105
 106 void
 107 pal_hib_restore_pal_state(uint32_t *arg)
 108 {
 109         (void)arg;
 110 }
 111
 112 void
 113 pal_hib_resume_init(__unused pal_hib_ctx_t *ctx, __unused hibernate_page_list_t *map, __unused uint32_t *nextFree)
 114 {
 115 }
 116
 117 void
 118 pal_hib_restored_page(__unused pal_hib_ctx_t *ctx, __unused pal_hib_restore_stage_t stage, __unused ppnum_t ppnum)
 119 {
 120 }
 121
 122 void
 123 pal_hib_patchup(__unused pal_hib_ctx_t *ctx)
 124 {
 125 }
 126
 127 void
 128 pal_hib_decompress_page(void *src, void *dst, void *scratch, unsigned int compressedSize)
 129 {
 130         WKdm_decompress_new((WK_word*)src, (WK_word*)dst, (WK_word*)scratch, compressedSize);
 131 }