Chameleon

Chameleon Svn Source Tree

Root/branches/ErmaC/Enoch/i386/boot2/IOHibernatePrivate.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#ifdef __cplusplus␊
30extern "C" {␊
31#endif␊
32␊
33#ifdef KERNEL␊
34#include <crypto/aes.h>␊
35#endif␊
36␊
37struct IOPolledFileExtent␊
38{␊
39␉uint64_t␉start;␊
40␉uint64_t␉length;␊
41};␊
42typedef struct IOPolledFileExtent IOPolledFileExtent;␊
43␊
44struct IOHibernateImageHeader␊
45{␊
46␉uint64_t␉imageSize;␊
47␉uint64_t␉image1Size;␊
48␊
49␉uint32_t␉restore1CodePage;␊
50␊
51␉uint32_t␉restore1PageCount;␊
52␉uint32_t␉restore1CodeOffset;␊
53␉uint32_t␉restore1StackOffset;␊
54␊
55␉uint32_t␉pageCount;␊
56␉uint32_t␉bitmapSize;␊
57␊
58␉uint32_t␉restore1Sum;␊
59␉uint32_t␉image1Sum;␊
60␉uint32_t␉image2Sum;␊
61␊
62␉uint32_t␉actualRestore1Sum;␊
63␉uint32_t␉actualImage1Sum;␊
64␉uint32_t␉actualImage2Sum;␊
65␊
66␉uint32_t␉actualUncompressedPages;␊
67␉uint32_t␉conflictCount;␊
68␉uint32_t␉nextFree;␊
69␊
70␉uint32_t␉signature;␊
71␉uint32_t␉processorFlags;␊
72␊
73␉uint32_t␉runtimePages;␊
74␉uint32_t␉runtimePageCount;␊
75␊
76␉uint8_t␉␉reserved2[16];␊
77␊
78␉uint64_t␉encryptStart;␊
79␉uint64_t␉machineSignature;␊
80␊
81␉uint32_t␉previewSize;␊
82␉uint32_t␉previewPageListSize;␊
83␊
84␉uint32_t␉diag[4];␊
85␊
86␉int32_t␉␉graphicsInfoOffset;␊
87␉int32_t␉␉cryptVarsOffset;␊
88␉int32_t␉␉memoryMapOffset;␊
89␉uint32_t␉memoryMapSize;␊
90␉uint32_t␉systemTableOffset;␊
91␊
92␉uint32_t␉reserved[77];␉␉// make sizeof == 512␊
93␊
94␉uint32_t␉␉fileExtentMapSize;␊
95␉IOPolledFileExtent␉fileExtentMap[2];␊
96};␊
97typedef struct IOHibernateImageHeader IOHibernateImageHeader;␊
98␊
99␊
100struct hibernate_bitmap_t␊
101{␊
102␉uint32_t␉first_page;␊
103␉uint32_t␉last_page;␊
104␉uint32_t␉bitmapwords;␊
105␉uint32_t␉bitmap[0];␊
106};␊
107typedef struct hibernate_bitmap_t hibernate_bitmap_t;␊
108␊
109struct hibernate_page_list_t␊
110{␊
111␉uint32_t␉␉ list_size;␊
112␉uint32_t␉␉ page_count;␊
113␉uint32_t␉␉ bank_count;␊
114␉hibernate_bitmap_t bank_bitmap[0];␊
115};␊
116typedef struct hibernate_page_list_t hibernate_page_list_t;␊
117␊
118#if defined(_AES_H)␊
119␊
120struct hibernate_cryptwakevars_t␊
121{␊
122␉uint8_t aes_iv[AES_BLOCK_SIZE];␊
123};␊
124typedef struct hibernate_cryptwakevars_t hibernate_cryptwakevars_t;␊
125␊
126struct hibernate_cryptvars_t␊
127{␊
128␉uint8_t aes_iv[AES_BLOCK_SIZE];␊
129␉aes_ctx ctx;␊
130};␊
131typedef struct hibernate_cryptvars_t hibernate_cryptvars_t;␊
132␊
133#endif /* defined(_AES_H) */␊
134␊
135␊
136enum ␊
137{␊
138␉kIOHibernateProgressCount = 19,␊
139␉kIOHibernateProgressWidth = 7,␊
140␉kIOHibernateProgressHeight = 16,␊
141␉kIOHibernateProgressSpacing = 3,␊
142␉kIOHibernateProgressOriginY = 81,␊
143␊
144␉kIOHibernateProgressSaveUnderSize = 2*5+14*2,␊
145␊
146␉kIOHibernateProgressLightGray = 230,␊
147␉kIOHibernateProgressMidGray = 174,␊
148␉kIOHibernateProgressDarkGray = 92␊
149};␊
150␊
151enum␊
152{␊
153␉kIOHibernatePostWriteSleep = 0,␊
154␉kIOHibernatePostWriteWake = 1,␊
155␉kIOHibernatePostWriteHalt = 2,␊
156␉kIOHibernatePostWriteRestart = 3␊
157};␊
158␊
159␊
160struct hibernate_graphics_t␊
161{␊
162␉uint32_t physicalAddress;␉␉// Base address of video memory␊
163␉uint32_t mode;␉␉␉// ␊
164␉uint32_t rowBytes; ␉␉// Number of bytes per pixel row␊
165␉uint32_t width; ␉␉// Width␊
166␉uint32_t height; ␉␉// Height␊
167␉uint32_t depth; ␉␉// Pixel Depth␊
168␊
169␉uint8_t progressSaveUnder[kIOHibernateProgressCount][kIOHibernateProgressSaveUnderSize];␊
170};␊
171typedef struct hibernate_graphics_t hibernate_graphics_t;␊
172␊
173#define DECLARE_IOHIBERNATEPROGRESSALPHA␉␉␉␉\␊
174static const uint8_t gIOHibernateProgressAlpha␉␉␉\␊
175[kIOHibernateProgressHeight][kIOHibernateProgressWidth] = ␉\␊
176{␉␉␉␉␉␉␉␉\␊
177␉{ 0x00,0x63,0xd8,0xf0,0xd8,0x63,0x00 },␉␉␉\␊
178␉{ 0x51,0xff,0xff,0xff,0xff,0xff,0x51 },␉␉␉\␊
179␉{ 0xae,0xff,0xff,0xff,0xff,0xff,0xae },␉␉␉\␊
180␉{ 0xc3,0xff,0xff,0xff,0xff,0xff,0xc3 },␉␉␉\␊
181␉{ 0xc3,0xff,0xff,0xff,0xff,0xff,0xc3 },␉␉␉\␊
182␉{ 0xc3,0xff,0xff,0xff,0xff,0xff,0xc3 },␉␉␉\␊
183␉{ 0xc3,0xff,0xff,0xff,0xff,0xff,0xc3 },␉␉␉\␊
184␉{ 0xc3,0xff,0xff,0xff,0xff,0xff,0xc3 },␉␉␉\␊
185␉{ 0xc3,0xff,0xff,0xff,0xff,0xff,0xc3 },␉␉␉\␊
186␉{ 0xc3,0xff,0xff,0xff,0xff,0xff,0xc3 },␉␉␉\␊
187␉{ 0xc3,0xff,0xff,0xff,0xff,0xff,0xc3 },␉␉␉\␊
188␉{ 0xc3,0xff,0xff,0xff,0xff,0xff,0xc3 },␉␉␉\␊
189␉{ 0xc3,0xff,0xff,0xff,0xff,0xff,0xc3 },␉␉␉\␊
190␉{ 0xae,0xff,0xff,0xff,0xff,0xff,0xae },␉␉␉\␊
191␉{ 0x54,0xff,0xff,0xff,0xff,0xff,0x54 },␉␉␉\␊
192␉{ 0x00,0x66,0xdb,0xf3,0xdb,0x66,0x00 }␉␉␉\␊
193};␊
194␊
195#ifdef KERNEL␊
196␊
197#ifdef __cplusplus␊
198␊
199void IOHibernateSystemInit(IOPMrootDomain * rootDomain);␊
200␊
201IOReturn IOHibernateSystemSleep(void);␊
202IOReturn IOHibernateSystemHasSlept(void);␊
203IOReturn IOHibernateSystemWake(void);␊
204IOReturn IOHibernateSystemPostWake(void);␊
205␊
206#endif /* __cplusplus */␊
207␊
208#ifdef _SYS_CONF_H_␊
209typedef void (*kern_get_file_extents_callback_t)(void * ref, uint64_t start, uint64_t size);␊
210␊
211struct kern_direct_file_io_ref_t *␊
212kern_open_file_for_direct_io(const char * name, ␊
213␉␉␉ kern_get_file_extents_callback_t callback, ␊
214␉␉␉ void * callback_ref,␊
215␉␉␉ dev_t * device,␊
216 uint64_t * partitionbase_result,␊
217 uint64_t * maxiocount_result);␊
218void␊
219kern_close_file_for_direct_io(struct kern_direct_file_io_ref_t * ref);␊
220int␊
221kern_write_file(struct kern_direct_file_io_ref_t * ref, off_t offset, caddr_t addr, vm_size_t len);␊
222int get_kernel_symfile(struct proc *p, char const **symfile);␊
223#endif /* _SYS_CONF_H_ */␊
224␊
225hibernate_page_list_t *␊
226hibernate_page_list_allocate(void);␊
227␊
228kern_return_t ␊
229hibernate_setup(IOHibernateImageHeader * header,␊
230 uint32_t free_page_ratio,␊
231 uint32_t free_page_time,␊
232␉␉␉hibernate_page_list_t ** page_list_ret,␊
233␉␉␉hibernate_page_list_t ** page_list_wired_ret,␊
234 boolean_t * encryptedswap);␊
235kern_return_t ␊
236hibernate_teardown(hibernate_page_list_t * page_list,␊
237 hibernate_page_list_t * page_list_wired);␊
238␊
239kern_return_t ␊
240hibernate_processor_setup(IOHibernateImageHeader * header);␊
241␊
242void␊
243hibernate_vm_lock(void);␊
244void␊
245hibernate_vm_unlock(void);␊
246␊
247// mark pages not to be saved, based on VM system accounting␊
248void␊
249hibernate_page_list_setall(hibernate_page_list_t * page_list,␊
250␉␉␉ hibernate_page_list_t * page_list_wired,␊
251␉␉␉ uint32_t * pagesOut);␊
252␊
253// mark pages to be saved, or pages not to be saved but available ␊
254// for scratch usage during restore␊
255void␊
256hibernate_page_list_setall_machine(hibernate_page_list_t * page_list,␊
257 hibernate_page_list_t * page_list_wired,␊
258 uint32_t * pagesOut);␊
259␊
260// mark pages not to be saved and not for scratch usage during restore␊
261void␊
262hibernate_page_list_set_volatile( hibernate_page_list_t * page_list,␊
263␉␉␉␉ hibernate_page_list_t * page_list_wired,␊
264␉␉␉␉ uint32_t * pagesOut);␊
265␊
266void␊
267hibernate_page_list_discard(hibernate_page_list_t * page_list);␊
268␊
269void␊
270hibernate_set_page_state(hibernate_page_list_t * page_list, hibernate_page_list_t * page_list_wired,␊
271␉␉␉␉vm_offset_t ppnum, vm_offset_t count, uint32_t kind);␊
272␊
273void␊
274hibernate_page_bitset(hibernate_page_list_t * list, boolean_t set, uint32_t page);␊
275␊
276boolean_t␊
277hibernate_page_bittst(hibernate_page_list_t * list, uint32_t page);␊
278␊
279hibernate_bitmap_t *␊
280hibernate_page_bitmap_pin(hibernate_page_list_t * list, uint32_t * page);␊
281␊
282uint32_t␊
283hibernate_page_bitmap_count(hibernate_bitmap_t * bitmap, uint32_t set, uint32_t page);␊
284␊
285void ␊
286hibernate_restore_phys_page(uint64_t src, uint64_t dst, uint32_t len, uint32_t procFlags);␊
287␊
288void␊
289hibernate_machine_init(void);␊
290␊
291uint32_t␊
292hibernate_write_image(void);␊
293␊
294long␊
295hibernate_machine_entrypoint(IOHibernateImageHeader * header, void * p2, void * p3, void * p4);␊
296long␊
297hibernate_kernel_entrypoint(IOHibernateImageHeader * header, void * p2, void * p3, void * p4);␊
298void␊
299hibernate_newruntime_map(void * map, vm_size_t map_size, ␊
300␉␉␉ uint32_t system_table_offset);␊
301␊
302␊
303extern uint32_t gIOHibernateState;␊
304extern uint32_t gIOHibernateMode;␊
305extern uint32_t gIOHibernateFreeTime;␉// max time to spend freeing pages (ms)␊
306extern uint8_t gIOHibernateRestoreStack[];␊
307extern uint8_t gIOHibernateRestoreStackEnd[];␊
308extern IOHibernateImageHeader * gIOHibernateCurrentHeader;␊
309extern hibernate_graphics_t * gIOHibernateGraphicsInfo;␊
310extern hibernate_cryptwakevars_t * gIOHibernateCryptWakeVars;␊
311␊
312#define HIBLOG(fmt, args...)␉\␊
313 { kprintf(fmt, ## args); printf(fmt, ## args); }␊
314␊
315#define HIBPRINT(fmt, args...)␉\␊
316 { kprintf(fmt, ## args); }␊
317␊
318#endif /* KERNEL */␊
319␊
320// gIOHibernateState, kIOHibernateStateKey␊
321enum␊
322{␊
323 kIOHibernateStateInactive = 0,␊
324 kIOHibernateStateHibernating ␉ = 1,␉/* writing image */␊
325 kIOHibernateStateWakingFromHibernate = 2␉/* booted and restored image */␊
326};␊
327␊
328// gIOHibernateMode, kIOHibernateModeKey␊
329enum␊
330{␊
331 kIOHibernateModeOn = 0x00000001,␊
332 kIOHibernateModeSleep = 0x00000002,␊
333 kIOHibernateModeEncrypt = 0x00000004,␊
334 kIOHibernateModeDiscardCleanInactive = 0x00000008,␊
335 kIOHibernateModeDiscardCleanActive = 0x00000010,␊
336 kIOHibernateModeSwitch␉= 0x00000020,␊
337 kIOHibernateModeRestart␉= 0x00000040␊
338};␊
339␊
340// IOHibernateImageHeader.signature␊
341enum␊
342{␊
343 kIOHibernateHeaderSignature = 0x73696d65,␊
344 kIOHibernateHeaderInvalidSignature = 0x7a7a7a7a␊
345};␊
346␊
347// kind for hibernate_set_page_state()␊
348enum␊
349{␊
350 kIOHibernatePageStateFree = 0,␊
351 kIOHibernatePageStateWiredSave = 1,␊
352 kIOHibernatePageStateUnwiredSave = 2␊
353};␊
354␊
355#define kIOHibernateModeKey␉␉"Hibernate Mode"␊
356#define kIOHibernateFileKey␉␉"Hibernate File"␊
357#define kIOHibernateFreeRatioKey␉"Hibernate Free Ratio"␊
358#define kIOHibernateFreeTimeKey␉␉"Hibernate Free Time"␊
359␊
360#define kIOHibernateStateKey␉␉"IOHibernateState"␊
361#define kIOHibernateFeatureKey␉␉"Hibernation"␊
362#define kIOHibernatePreviewBufferKey␉"IOPreviewBuffer"␊
363␊
364#define kIOHibernatePreviewActiveKey␉"IOHibernatePreviewActive"␊
365// values for kIOHibernatePreviewActiveKey␊
366enum {␊
367 kIOHibernatePreviewActive = 0x00000001,␊
368 kIOHibernatePreviewUpdates = 0x00000002␊
369};␊
370␊
371#define kIOHibernateBootImageKey␉"boot-image"␊
372#define kIOHibernateBootImageKeyKey␉"boot-image-key"␊
373#define kIOHibernateBootSignatureKey␉"boot-signature"␊
374␊
375#define kIOHibernateMemorySignatureKey␉ "memory-signature"␊
376#define kIOHibernateMemorySignatureEnvKey "mem-sig"␊
377#define kIOHibernateMachineSignatureKey␉ "machine-signature"␊
378␊
379#define kIOHibernateRTCVariablesKey␉"IOHibernateRTCVariables"␊
380␊
381#define kIOHibernateBootSwitchVarsKey␉␉␉"boot-switch-vars"␊
382␊
383␊
384#ifdef __cplusplus␊
385}␊
386#endif␊
387

Archive Download this file

Revision: 2347