iokit/Kernel/IOHibernateInternal.h

   1 /*
   2  * Copyright (c) 2004 Apple Computer, 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 #include <stdint.h>
  30 #include <IOKit/IOHibernatePrivate.h>
  31
  32 #ifdef __cplusplus
  33
  34 #if HIBERNATE_HMAC_IMAGE
  35 #include <libkern/crypto/sha2.h>
  36 #endif /* HIBERNATE_HMAC_IMAGE */
  37
  38 enum { kIOHibernateAESKeySize = 16 };  /* bytes */
  39
  40 #if HIBERNATE_HMAC_IMAGE
  41 // when we call out to PPL to compute IOHibernateHibSegInfo, we use
  42 // srcBuffer as a temporary buffer, to copy out all of the required
  43 // HIB segments, so it should be big enough to contain those segments
  44 #define HIBERNATION_SRC_BUFFER_SIZE (16 * 1024 * 1024)
  45 #else
  46 // srcBuffer has to be big enough for a source page, the WKDM
  47 // compressed output, and a scratch page needed by WKDM
  48 #define HIBERNATION_SRC_BUFFER_SIZE (2 * page_size + WKdm_SCRATCH_BUF_SIZE_INTERNAL)
  49 #endif
  50
  51 struct IOHibernateVars {
  52         hibernate_page_list_t *             page_list;
  53         hibernate_page_list_t *             page_list_wired;
  54         hibernate_page_list_t *             page_list_pal;
  55         class IOBufferMemoryDescriptor *    ioBuffer;
  56         class IOBufferMemoryDescriptor *    srcBuffer;
  57         class IOBufferMemoryDescriptor *    handoffBuffer;
  58         class IOMemoryDescriptor *          previewBuffer;
  59         OSData *                            previewData;
  60         OSObject *                          saveBootDevice;
  61
  62         struct IOPolledFileIOVars *         fileVars;
  63         uint64_t                            fileMinSize;
  64         uint64_t                            fileMaxSize;
  65         vm_offset_t                         videoMapping;
  66         vm_size_t                           videoAllocSize;
  67         vm_size_t                           videoMapSize;
  68         uint8_t *                           consoleMapping;
  69         uint8_t                             haveFastBoot;
  70         uint8_t                             saveBootAudioVolume;
  71         uint8_t                             hwEncrypt;
  72         uint8_t                             wiredCryptKey[kIOHibernateAESKeySize];
  73         uint8_t                             cryptKey[kIOHibernateAESKeySize];
  74         size_t                              volumeCryptKeySize;
  75         uint8_t                             volumeCryptKey[64];
  76 #if HIBERNATE_HMAC_IMAGE
  77         SHA256_CTX *                        imageShaCtx;
  78 #endif /* HIBERNATE_HMAC_IMAGE */
  79 };
  80 typedef struct IOHibernateVars IOHibernateVars;
  81
  82 #endif          /* __cplusplus */
  83
  84 enum{
  85         kIOHibernateTagSignature = 0x53000000,
  86         kIOHibernateTagLength    = 0x00007fff,
  87 };
  88
  89 #ifdef __cplusplus
  90 extern "C"
  91 #endif          /* __cplusplus */
  92 uint32_t
  93 hibernate_sum_page(uint8_t *buf, uint32_t ppnum);
  94
  95 #if defined(__i386__) || defined(__x86_64__)
  96 extern vm_offset_t segHIBB;
  97 extern unsigned long segSizeHIB;
  98 #elif defined(__arm64__)
  99 extern vm_offset_t sectHIBTEXTB;
 100 extern unsigned long sectSizeHIBTEXT;
 101 #endif
 102
 103 extern ppnum_t gIOHibernateHandoffPages[];
 104 extern const uint32_t gIOHibernateHandoffPageCount;
 105
 106 // max address that can fit in a ppnum_t
 107 #define IO_MAX_PAGE_ADDR        (((uint64_t) UINT_MAX) << PAGE_SHIFT)
 108 // atop() returning ppnum_t
 109 #define atop_64_ppnum(x) ((ppnum_t)((uint64_t)(x) >> PAGE_SHIFT))