xnu-7195.81.3.tar.gz

[apple/xnu.git] / iokit / Kernel / IOHibernateInternal.h

diff --git a/iokit/Kernel/IOHibernateInternal.h b/iokit/Kernel/IOHibernateInternal.h
index fdaf45d062cbb636b80990b98d8258d5b2afe4c9..cbb8cc2eb8b6906fca8b9f3aeca86c571290e63e 100644 (file)
--- a/iokit/Kernel/IOHibernateInternal.h
+++ b/iokit/Kernel/IOHibernateInternal.h
@@ -2,7 +2,7 @@
  * Copyright (c) 2004 Apple Computer, Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * Copyright (c) 2004 Apple Computer, Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

- * 
+ *

  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in


@@ -11,10 +11,10 @@
  * unlawful or unlicensed copies of an Apple operating system, or to
  * circumvent, violate, or enable the circumvention or violation of, any
  * terms of an Apple operating system software license agreement.
  * unlawful or unlicensed copies of an Apple operating system, or to
  * circumvent, violate, or enable the circumvention or violation of, any
  * terms of an Apple operating system software license agreement.

- * 
+ *

  * Please obtain a copy of the License at
  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  * Please obtain a copy of the License at
  * http://www.opensource.apple.com/apsl/ and read it before using this file.

- * 
+ *

  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,


@@ -22,81 +22,75 @@
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.

- * 
+ *

  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 
 #include <stdint.h>
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 
 #include <stdint.h>

+#include <IOKit/IOHibernatePrivate.h>

 
 #ifdef __cplusplus
 
 
 #ifdef __cplusplus
 

-enum { kIOHibernateAESKeySize = 128 }; /* bits */

 
 

-struct IOHibernateVars
-{
-    hibernate_page_list_t *            page_list;
-    hibernate_page_list_t *            page_list_wired;
-    class IOBufferMemoryDescriptor *    ioBuffer;
-    class IOBufferMemoryDescriptor *    srcBuffer;
-    class IOMemoryDescriptor *          previewBuffer;
-    OSData *                           previewData;
-    OSData *                           fileExtents;
-    OSObject *                         saveBootDevice;
+enum { kIOHibernateAESKeySize = 16 };  /* bytes */

 
 

-    struct IOPolledFileIOVars *                fileVars;
-    vm_offset_t                                videoMapping;
-    vm_size_t                          videoAllocSize;
-    vm_size_t                          videoMapSize;
-    uint8_t                            haveFastBoot;
-    uint8_t                            saveBootAudioVolume;
-    uint8_t                            wiredCryptKey[kIOHibernateAESKeySize / 8];
-    uint8_t                            cryptKey[kIOHibernateAESKeySize / 8];
-};
-typedef struct IOHibernateVars IOHibernateVars;
+// srcBuffer has to be big enough for a source page, the WKDM
+// compressed output, and a scratch page needed by WKDM
+#define HIBERNATION_SRC_BUFFER_SIZE (2 * page_size + WKdm_SCRATCH_BUF_SIZE_INTERNAL)

 
 

+struct IOHibernateVars {
+       hibernate_page_list_t *             page_list;
+       hibernate_page_list_t *             page_list_wired;
+       hibernate_page_list_t *             page_list_pal;
+       class IOBufferMemoryDescriptor *    ioBuffer;
+       class IOBufferMemoryDescriptor *    srcBuffer;
+       class IOBufferMemoryDescriptor *    handoffBuffer;
+       class IOMemoryDescriptor *          previewBuffer;
+       OSData *                            previewData;
+       OSObject *                          saveBootDevice;

 
 

-struct IOPolledFileIOVars
-{
-    struct kern_direct_file_io_ref_t * fileRef;
-    class OSArray *                    pollers;
-    IOByteCount                                blockSize;
-    uint8_t *                                  buffer;
-    IOByteCount                        bufferSize;
-    IOByteCount                        bufferLimit;
-    IOByteCount                        bufferOffset;
-    IOByteCount                        bufferHalf;
-    IOByteCount                                extentRemaining;
-    IOByteCount                                lastRead;
-    uint64_t                           block0;
-    uint64_t                           position;
-    uint64_t                           extentPosition;
-    uint64_t                           encryptStart;
-    IOPolledFileExtent *               extentMap;
-    IOPolledFileExtent *               currentExtent;
-    bool                               io;
-    IOReturn                           ioStatus;
+       struct IOPolledFileIOVars *         fileVars;
+       uint64_t                            fileMinSize;
+       uint64_t                            fileMaxSize;
+       vm_offset_t                         videoMapping;
+       vm_size_t                           videoAllocSize;
+       vm_size_t                           videoMapSize;
+       uint8_t *                           consoleMapping;
+       uint8_t                             haveFastBoot;
+       uint8_t                             saveBootAudioVolume;
+       uint8_t                             hwEncrypt;
+       uint8_t                             wiredCryptKey[kIOHibernateAESKeySize];
+       uint8_t                             cryptKey[kIOHibernateAESKeySize];
+       size_t                              volumeCryptKeySize;
+       uint8_t                             volumeCryptKey[64];

 };
 };

-typedef struct IOPolledFileIOVars IOPolledFileIOVars;
+typedef struct IOHibernateVars IOHibernateVars;

 
 

-#endif         /* __cplusplus */
+#endif          /* __cplusplus */

 
 

-enum
-{
-    kIOHibernateTagSignature = 0x53000000,
-    kIOHibernateTagLength    = 0x00001fff,
+enum{
+       kIOHibernateTagSignature = 0x53000000,
+       kIOHibernateTagLength    = 0x00007fff,

 };
 
 #ifdef __cplusplus
 extern "C"
 };
 
 #ifdef __cplusplus
 extern "C"

-#endif         /* __cplusplus */
+#endif          /* __cplusplus */

 uint32_t
 uint32_t

-hibernate_sum(uint8_t *buf, int32_t len);
+hibernate_sum_page(uint8_t *buf, uint32_t ppnum);

 
 

-extern vm_offset_t sectHIBB;
-extern int         sectSizeHIB;
-extern vm_offset_t sectDATAB;
-extern int         sectSizeDATA;
+#if defined(__i386__) || defined(__x86_64__)
+extern vm_offset_t segHIBB;
+extern unsigned long segSizeHIB;
+#elif defined(__arm64__)
+extern vm_offset_t sectHIBTEXTB;
+extern unsigned long sectSizeHIBTEXT;
+#endif

 
 

-extern vm_offset_t gIOHibernateWakeMap;            // ppnum
-extern vm_size_t   gIOHibernateWakeMapSize;
+extern ppnum_t gIOHibernateHandoffPages[];
+extern const uint32_t gIOHibernateHandoffPageCount;

 
 

+// max address that can fit in a ppnum_t
+#define IO_MAX_PAGE_ADDR        (((uint64_t) UINT_MAX) << PAGE_SHIFT)
+// atop() returning ppnum_t
+#define atop_64_ppnum(x) ((ppnum_t)((uint64_t)(x) >> PAGE_SHIFT))