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
  31 #ifdef __cplusplus
  32
  33 enum { kIOHibernateAESKeySize = 128 };  /* bits */
  34
  35 struct IOHibernateVars
  36 {
  37     hibernate_page_list_t *             page_list;
  38     hibernate_page_list_t *             page_list_wired;
  39     hibernate_page_list_t *             page_list_pal;
  40     class IOBufferMemoryDescriptor *    ioBuffer;
  41     class IOBufferMemoryDescriptor *    srcBuffer;
  42     class IOBufferMemoryDescriptor *    handoffBuffer;
  43     class IOMemoryDescriptor *          previewBuffer;
  44     OSData *                            previewData;
  45     OSData *                            fileExtents;
  46     OSObject *                          saveBootDevice;
  47
  48     struct IOPolledFileIOVars *         fileVars;
  49     uint64_t                            fileMinSize;
  50     uint64_t                            fileMaxSize;
  51     vm_offset_t                         videoMapping;
  52     vm_size_t                           videoAllocSize;
  53     vm_size_t                           videoMapSize;
  54     uint8_t *                           consoleMapping;
  55     uint8_t                             haveFastBoot;
  56     uint8_t                             saveBootAudioVolume;
  57     uint8_t                             wiredCryptKey[kIOHibernateAESKeySize / 8];
  58     uint8_t                             cryptKey[kIOHibernateAESKeySize / 8];
  59     uint8_t                             volumeCryptKey[kIOHibernateAESKeySize / 8];
  60 };
  61 typedef struct IOHibernateVars IOHibernateVars;
  62
  63
  64 struct IOPolledFileIOVars
  65 {
  66     struct kern_direct_file_io_ref_t *  fileRef;
  67     IORegistryEntry *                   media;
  68     class OSArray *                     pollers;
  69     IOByteCount                         blockSize;
  70     uint8_t *                           buffer;
  71     IOByteCount                         bufferSize;
  72     IOByteCount                         bufferLimit;
  73     IOByteCount                         bufferOffset;
  74     IOByteCount                         bufferHalf;
  75     IOByteCount                         extentRemaining;
  76     IOByteCount                         lastRead;
  77     IOByteCount                         readEnd;
  78     uint32_t                            flags;
  79     uint64_t                            fileSize;
  80     uint64_t                            block0;
  81     uint64_t                            position;
  82     uint64_t                            extentPosition;
  83     uint64_t                            encryptStart;
  84     uint64_t                            encryptEnd;
  85     uint64_t                            cryptBytes;
  86     AbsoluteTime                        cryptTime;
  87     IOPolledFileExtent *                extentMap;
  88     IOPolledFileExtent *                currentExtent;
  89     bool                                io;
  90     IOReturn                            ioStatus;
  91 };
  92 typedef struct IOPolledFileIOVars IOPolledFileIOVars;
  93
  94 #endif          /* __cplusplus */
  95
  96 enum
  97 {
  98     kIOHibernateTagSignature = 0x53000000,
  99     kIOHibernateTagLength    = 0x00001fff,
 100 };
 101
 102 #ifdef __cplusplus
 103 extern "C"
 104 #endif          /* __cplusplus */
 105 uint32_t
 106 hibernate_sum_page(uint8_t *buf, uint32_t ppnum);
 107
 108 extern vm_offset_t segHIBB;
 109 extern unsigned long segSizeHIB;
 110 extern vm_offset_t segDATAB;
 111 extern unsigned long segSizeDATA;
 112
 113 extern ppnum_t gIOHibernateHandoffPages[];
 114 extern uint32_t gIOHibernateHandoffPageCount;