]> git.saurik.com Git - apple/xnu.git/blame_incremental - osfmk/ppc/vmachmon.h
projects / apple / xnu.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
xnu-1228.tar.gz
[apple/xnu.git] / osfmk / ppc / vmachmon.h
... / ...
CommitLineData
1/*
2 * Copyright (c) 2000-2005 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** vmachmon.h
30**
31** C routines that we are adding to the MacOS X kernel.
32**
33-----------------------------------------------------------------------*/
34
35#include <ppc/exception.h>
36
37#ifndef _VEMULATION_H_
38#define _VEMULATION_H_
39
40/*************************************************************************************
41 External Emulation Types
42**************************************************************************************/
43
44typedef union vmm_vector_register_t {
45 unsigned long i[4];
46 unsigned short s[8];
47 unsigned char b[16];
48} vmm_vector_register_t;
49
50typedef union vmm_fp_register_t {
51 double d;
52 unsigned long i[2];
53 unsigned short s[4];
54 unsigned char b[8];
55} vmm_fp_register_t;
56
57
58typedef struct vmm_regs32_t {
59
60 unsigned long ppcPC; /* 000 */
61 unsigned long ppcMSR; /* 004 */
62
63 unsigned long ppcGPRs[32]; /* 008 */
64
65 unsigned long ppcCR; /* 088 */
66 unsigned long ppcXER; /* 08C */
67 unsigned long ppcLR; /* 090 */
68 unsigned long ppcCTR; /* 094 */
69 unsigned long ppcMQ; /* 098 - Obsolete */
70 unsigned long ppcVRSave; /* 09C */
71 unsigned long ppcRsrvd0A0[40]; /* 0A0 */
72 /* 140 */
73} vmm_regs32_t;
74
75#pragma pack(4) /* Make sure the structure stays as we defined it */
76typedef struct vmm_regs64_t {
77
78 unsigned long long ppcPC; /* 000 */
79 unsigned long long ppcMSR; /* 008 */
80
81 unsigned long long ppcGPRs[32]; /* 010 */
82
83 unsigned long long ppcXER; /* 110 */
84 unsigned long long ppcLR; /* 118 */
85 unsigned long long ppcCTR; /* 120 */
86 unsigned long ppcCR; /* 128 */
87 unsigned long ppcVRSave; /* 12C */
88 unsigned long ppcRsvd130[4]; /* 130 */
89 /* 140 */
90} vmm_regs64_t;
91#pragma pack()
92
93
94#pragma pack(4) /* Make sure the structure stays as we defined it */
95typedef union vmm_regs_t {
96 vmm_regs32_t ppcRegs32;
97 vmm_regs64_t ppcRegs64;
98} vmm_regs_t;
99#pragma pack()
100
101#pragma pack(4) /* Make sure the structure stays as we defined it */
102typedef struct vmm_processor_state_t {
103 /* 32-byte bndry */
104 vmm_regs_t ppcRegs; /* Define registers areas */
105
106/* We must be 16-byte aligned here */
107
108 vmm_vector_register_t ppcVRs[32]; /* These are only valid after a kVmmGetVectorState */
109 vmm_vector_register_t ppcVSCR; /* This is always loaded/saved at host/guest transition */
110
111/* We must be 8-byte aligned here */
112
113 vmm_fp_register_t ppcFPRs[32]; /* These are only valid after a kVmmGetFloatState */
114 vmm_fp_register_t ppcFPSCR; /* This is always loaded/saved at host/guest transition */
115 unsigned long ppcReserved2[2]; /* Pad out to multiple of 16 bytes */
116} vmm_processor_state_t;
117#pragma pack()
118
119typedef unsigned long vmm_return_code_t;
120
121typedef unsigned long vmm_thread_index_t;
122#define vmmTInum 0x000000FF
123#define vmmTIadsp 0x0000FF00
124typedef unsigned long vmm_adsp_id_t;
125
126enum {
127 kVmmCurMajorVersion = 0x0001,
128 kVmmCurMinorVersion = 0x0007,
129 kVmmMinMajorVersion = 0x0001,
130};
131#define kVmmCurrentVersion ((kVmmCurMajorVersion << 16) | kVmmCurMinorVersion)
132
133typedef unsigned long vmm_features_t;
134enum {
135 kVmmFeature_LittleEndian = 0x00000001,
136 kVmmFeature_Stop = 0x00000002,
137 kVmmFeature_ExtendedMapping = 0x00000004,
138 kVmmFeature_ListMapping = 0x00000008,
139 kVmmFeature_FastAssist = 0x00000010,
140 kVmmFeature_XA = 0x00000020,
141 kVmmFeature_SixtyFourBit = 0x00000040,
142 kVmmFeature_MultAddrSpace = 0x00000080,
143 kVmmFeature_GuestShadowAssist = 0x00000100, /* Guest->physical shadow hash table */
144 kVmmFeature_GlobalMappingAssist = 0x00000200, /* Global shadow mapping support */
145 kVmmFeature_HostShadowAssist = 0x00000400, /* Linear shadow mapping of an area of
146 host virtual as guest physical */
147 kVmmFeature_MultAddrSpaceAssist = 0x00000800, /* Expanded pool of guest virtual
148 address spaces */
149};
150#define kVmmCurrentFeatures (kVmmFeature_LittleEndian | kVmmFeature_Stop | kVmmFeature_ExtendedMapping \
151 | kVmmFeature_ListMapping | kVmmFeature_FastAssist | kVmmFeature_XA \
152 | kVmmFeature_GuestShadowAssist)
153
154enum {
155 vmm64Bit = 0x80000000, /* Make guest 64-bit */
156 vmmGSA = 0x40000000, /* Enable guest shadow assist (GSA) */
157 vmmGMA = 0x20000000, /* Enable global shadow mapping assist (GMA) */
158};
159
160#define kVmmSupportedSetXA (vmm64Bit | vmmGSA | vmmGMA)
161
162typedef unsigned long vmm_version_t;
163
164typedef struct vmm_ret_parms32_t {
165 unsigned long return_params[4];
166} vmm_ret_parms32_t;
167
168typedef struct vmm_ret_parms64_t {
169 unsigned long long return_params[4];
170} vmm_ret_parms64_t;
171
172#pragma pack(4) /* Make sure the structure stays as we defined it */
173typedef union vmm_ret_parms_t {
174 vmm_ret_parms64_t vmmrp64; /* 64-bit flavor */
175 vmm_ret_parms32_t vmmrp32; /* 32-bit flavor */
176 unsigned int retgas[11]; /* Force this to be 11 words long */
177} vmm_ret_parms_t;
178#pragma pack()
179
180#pragma pack(4) /* Make sure the structure stays as we defined it */
181typedef struct vmm_fastassist_state32_t {
182 unsigned long fastassist_dispatch;
183 unsigned long fastassist_refcon;
184
185 unsigned long fastassist_dispatch_code;
186 unsigned long fastassist_parameter[5];
187
188 unsigned long guest_register[8];
189
190 unsigned long guest_pc;
191 unsigned long guest_msr;
192
193 unsigned long fastassist_intercepts;
194 unsigned long fastassist_reserved1;
195} vmm_fastassist_state32_t;
196
197typedef struct vmm_fastassist_state64_t {
198 unsigned long long fastassist_dispatch;
199 unsigned long long fastassist_refcon;
200
201 unsigned long long fastassist_dispatch_code;
202 unsigned long long fastassist_parameter[5];
203
204 unsigned long long guest_register[8];
205
206 unsigned long long guest_pc;
207 unsigned long long guest_msr;
208
209 unsigned long fastassist_intercepts;
210 unsigned long fastassist_reserved1;
211} vmm_fastassist_state64_t;
212
213typedef union vmm_fastassist_state_t {
214 vmm_fastassist_state64_t vmmfs64; /* 64-bit flavor */
215 vmm_fastassist_state32_t vmmfs32; /* 32-bit flavor */
216} vmm_fastassist_state_t;
217#pragma pack()
218
219#pragma pack(4) /* Make sure the structure stays as we defined it */
220typedef struct vmm_state_page_t {
221 /* This structure must remain below 4Kb (one page) in size */
222 vmm_version_t interface_version;
223 vmm_thread_index_t thread_index;
224 unsigned int vmmStat; /* Note: this field is identical to vmmFlags in vmmCntrlEntry */
225 unsigned int vmmCntrl;
226#define vmmFloatLoad 0x80000000
227#define vmmFloatLoadb 0
228#define vmmVectLoad 0x40000000
229#define vmmVectLoadb 1
230#define vmmVectVRall 0x20000000
231#define vmmVectVRallb 2
232#define vmmVectVAss 0x10000000
233#define vmmVectVAssb 3
234#define vmmXStart 0x08000000
235#define vmmXStartb 4
236#define vmmKey 0x04000000
237#define vmmKeyb 5
238#define vmmFamEna 0x02000000
239#define vmmFamEnab 6
240#define vmmFamSet 0x01000000
241#define vmmFamSetb 7
242
243 vmm_return_code_t return_code;
244 vmm_ret_parms_t vmmRet;
245
246 /* The next portion of the structure must remain 32-byte aligned */
247 vmm_processor_state_t vmm_proc_state;
248
249 /* The next portion of the structure must remain 16-byte aligned */
250 vmm_fastassist_state_t vmm_fastassist_state;
251
252} vmm_state_page_t;
253#pragma pack()
254
255#pragma pack(4) /* Make sure the structure stays as we defined it */
256typedef struct vmm_comm_page_t {
257 union {
258 vmm_state_page_t vmcpState; /* Reserve area for state */
259 unsigned int vmcpPad[768]; /* Reserve space for 3/4 page state area */
260 } vmcpfirst;
261 unsigned int vmcpComm[256]; /* Define last 1024 bytes as a communications area - function specific */
262} vmm_comm_page_t;
263#pragma pack()
264
265enum {
266 /* Function Indices (passed in r3) */
267 kVmmGetVersion = 0, /* Get VMM system version */
268 kVmmvGetFeatures, /* Get VMM supported features */
269 kVmmInitContext, /* Initialize a context */
270 kVmmTearDownContext, /* Destroy a context */
271 kVmmTearDownAll, /* Destory all contexts */
272 kVmmMapPage, /* Map a host to guest address space */
273 kVmmGetPageMapping, /* Get host address of a guest page */
274 kVmmUnmapPage, /* Unmap a guest page */
275 kVmmUnmapAllPages, /* Unmap all pages in a guest address space */
276 kVmmGetPageDirtyFlag, /* Check if guest page modified */
277 kVmmGetFloatState, /* Retrieve guest floating point context */
278 kVmmGetVectorState, /* Retrieve guest vector context */
279 kVmmSetTimer, /* Set a guest timer */
280 kVmmGetTimer, /* Get a guest timer */
281 kVmmExecuteVM, /* Launch a guest */
282 kVmmProtectPage, /* Set protection attributes for a guest page */
283 kVmmMapExecute, /* Map guest page and launch */
284 kVmmProtectExecute, /* Set prot attributes and launch */
285 kVmmMapList, /* Map a list of pages into guest address spaces */
286 kVmmUnmapList, /* Unmap a list of pages from guest address spaces */
287 kvmmExitToHost, /* Exit from FAM to host -- fast-path syscall */
288 kvmmResumeGuest, /* Resume guest from FAM -- fast-path syscall */
289 kvmmGetGuestRegister, /* Get guest register from FAM -- fast-path syscall */
290 kvmmSetGuestRegister, /* Set guest register from FAM -- fast-path syscall */
291
292 kVmmActivateXA, /* Activate extended architecture features for a VM */
293 kVmmDeactivateXA, /* Deactivate extended architecture features for a VM */
294 kVmmGetXA, /* Get extended architecture features from a VM */
295
296 kVmmMapPage64, /* Map a host to guest address space - supports 64-bit */
297 kVmmGetPageMapping64, /* Get host address of a guest page - supports 64-bit */
298 kVmmUnmapPage64, /* Unmap a guest page - supports 64-bit */
299 kVmmGetPageDirtyFlag64, /* Check if guest page modified - supports 64-bit */
300 kVmmProtectPage64, /* Set protection attributes for a guest page - supports 64-bit */
301 kVmmMapExecute64, /* Map guest page and launch - supports 64-bit */
302 kVmmProtectExecute64, /* Set prot attributes and launch - supports 64-bit */
303 kVmmMapList64, /* Map a list of pages into guest address spaces - supports 64-bit */
304 kVmmUnmapList64, /* Unmap a list of pages from guest address spaces - supports 64-bit */
305 kVmmMaxAddr, /* Returns the maximum virtual address that is mappable */
306
307 kVmmSetGuestMemory, /* Sets base and extent of guest physical memory in host address space */
308 kVmmPurgeLocal, /* Purges all non-global mappings for a given guest address space */
309};
310
311#define kVmmReturnNull 0
312#define kVmmBogusContext 1
313#define kVmmStopped 2
314#define kVmmReturnDataPageFault 3
315#define kVmmReturnInstrPageFault 4
316#define kVmmReturnAlignmentFault 6
317#define kVmmReturnProgramException 7
318#define kVmmReturnSystemCall 12
319#define kVmmReturnTraceException 13
320#define kVmmAltivecAssist 22
321#define kVmmInvalidAddress 0x1000
322#define kVmmInvalidAdSpace 0x1001
323
324/*
325 * Notes on guest address spaces.
326 *
327 * Address spaces are loosely coupled to virtual machines. The default is for
328 * a guest with an index of 1 to use address space 1, 2 to use 2, etc. However,
329 * any guest may be launched using any address space and any address space may be the
330 * target for a map or unmap function. Note that the (un)map list functions may pass in
331 * an address space ID on a page-by-page basis.
332 *
333 * An address space is instantiated either explicitly by mapping something into it, or
334 * implicitly by launching a guest with it.
335 *
336 * An address space is destroyed explicitly by kVmmTearDownAll or kVmmUnmapAllPages. It is
337 * destroyed implicitly by kVmmTearDownContext. The latter is done in order to remain
338 * backwards compatible with the previous implementation, which does not have decoupled
339 * guests and address spaces.
340 *
341 * An address space supports the maximum virtual address supported by the processor.
342 * The 64-bit variant of the mapping functions can be used on non-64-bit machines. If an
343 * unmappable address (e.g., an address larger than 4GB-1 on a 32-bit machine) is requested,
344 * the operation fails with a kVmmInvalidAddress return code.
345 *
346 * Note that for 64-bit calls, both host and guest are specified at 64-bit values.
347 *
348 */
349
350
351
352
353/*
354 * Storage Extended Protection modes
355 * Notes:
356 * To keep compatibility, vmmKey and the PPC key have reversed meanings,
357 * i.e., vmmKey 0 is PPC key 1 and vice versa.
358 *
359 * vmmKey Notes
360 * Mode 0 1
361 *
362 * kVmmProtNARW not accessible read/write VM_PROT_NONE (not settable via VM calls)
363 * kVmmProtRORW read only read/write
364 * kVmmProtRWRW read/write read/write VM_PROT_WRITE or (VM_PROT_WRITE | VM_PROT_READ)
365 * kVmmProtRORO read only read only VM_PROT_READ
366
367 */
368
369#define kVmmProtXtnd 0x00000008
370#define kVmmProtNARW (kVmmProtXtnd | 0x00000000)
371#define kVmmProtRORW (kVmmProtXtnd | 0x00000001)
372#define kVmmProtRWRW (kVmmProtXtnd | 0x00000002)
373#define kVmmProtRORO (kVmmProtXtnd | 0x00000003)
374
375/*
376 * Map list formats
377 * The last 12 bits in the guest virtual address is used as flags as follows:
378 * 0x007 - for the map calls, this is the key to set
379 * 0x3F0 - for both map and unmap, this is the address space ID upon which to operate.
380 * Note that if 0, the address space ID from the function call is used instead.
381 */
382
383typedef struct vmmMList {
384 unsigned int vmlva; /* Virtual address in host address space */
385 unsigned int vmlava; /* Virtual address in guest address space */
386} vmmMList;
387
388typedef struct vmmMList64 {
389 unsigned long long vmlva; /* Virtual address in host address space */
390 unsigned long long vmlava; /* Virtual address in guest address space */
391} vmmMList64;
392
393typedef struct vmmUMList {
394 unsigned int vmlava; /* Virtual address in guest address space */
395} vmmUMList;
396
397typedef struct vmmUMList64 {
398 unsigned long long vmlava; /* Virtual address in guest address space */
399} vmmUMList64;
400
401#define vmmlFlgs 0x00000FFF /* Flags passed in in vmlava low order 12 bits */
402#define vmmlProt 0x00000007 /* Protection flags for the page */
403#define vmmlAdID 0x000003F0 /* Guest address space ID - used only if non-zero */
404#define vmmlGlob 0x00000400 /* Mapping is global */
405#define vmmlRsvd 0x00000800 /* Reserved for future */
406
407/*************************************************************************************
408 Internal Emulation Types
409**************************************************************************************/
410
411#define kVmmMaxContexts 32
412#define kVmmMaxUnmapPages 64
413#define kVmmMaxMapPages 64
414
415#pragma pack(4) /* Make sure the structure stays as we defined it */
416typedef struct vmmCntrlEntry { /* Virtual Machine Monitor control table entry */
417 unsigned int vmmFlags; /* Assorted control flags */
418#define vmmInUse 0x80000000
419#define vmmInUseb 0
420#define vmmFloatCngd 0x40000000
421#define vmmFloatCngdb 1
422#define vmmVectCngd 0x20000000
423#define vmmVectCngdb 2
424#define vmmTimerPop 0x10000000
425#define vmmTimerPopb 3
426#define vmmFAMmode 0x04000000
427#define vmmFAMmodeb 5
428#define vmmXStop 0x00800000
429#define vmmXStopb 8
430#define vmmSpfSave 0x000000FF
431#define vmmSpfSaveb 24
432 unsigned int vmmXAFlgs; /* Extended Architecture flags */
433 vmm_state_page_t *vmmContextKern; /* Kernel address of context communications area */
434 ppnum_t vmmContextPhys; /* Physical address of context communications area */
435 vmm_state_page_t *vmmContextUser; /* User address of context communications area */
436 facility_context vmmFacCtx; /* Header for vector and floating point contexts */
437 pmap_t vmmPmap; /* Last dispatched pmap */
438 uint64_t vmmTimer; /* Last set timer value. Zero means unset */
439 unsigned int vmmFAMintercept; /* FAM intercepted exceptions */
440} vmmCntrlEntry;
441#pragma pack()
442
443#pragma pack(4) /* Make sure the structure stays as we defined it */
444typedef struct vmmCntrlTable { /* Virtual Machine Monitor Control table */
445 unsigned int vmmGFlags; /* Global flags */
446#define vmmLastAdSp 0xFF /* Remember the address space that was mapped last */
447 addr64_t vmmLastMap; /* Last vaddr mapping made */
448 vmmCntrlEntry vmmc[kVmmMaxContexts]; /* One entry for each possible Virtual Machine Monitor context */
449 pmap_t vmmAdsp[kVmmMaxContexts]; /* Guest address space pmaps */
450} vmmCntrlTable;
451#pragma pack()
452
453/* function decls for kernel level routines... */
454extern void vmm_execute_vm(thread_t act, vmm_thread_index_t index);
455extern kern_return_t vmm_tear_down_context(thread_t act, vmm_thread_index_t index);
456extern kern_return_t vmm_get_float_state(thread_t act, vmm_thread_index_t index);
457extern kern_return_t vmm_get_vector_state(thread_t act, vmm_thread_index_t index);
458extern kern_return_t vmm_set_timer(thread_t act, vmm_thread_index_t index, unsigned int timerhi, unsigned int timerlo);
459extern kern_return_t vmm_get_timer(thread_t act, vmm_thread_index_t index);
460extern void vmm_tear_down_all(thread_t act);
461extern kern_return_t vmm_map_page(thread_t act, vmm_thread_index_t hindex, addr64_t cva,
462 addr64_t ava, vm_prot_t prot);
463extern vmm_return_code_t vmm_map_execute(thread_t act, vmm_thread_index_t hindex, addr64_t cva,
464 addr64_t ava, vm_prot_t prot);
465extern kern_return_t vmm_protect_page(thread_t act, vmm_thread_index_t hindex, addr64_t va,
466 vm_prot_t prot);
467extern vmm_return_code_t vmm_protect_execute(thread_t act, vmm_thread_index_t hindex, addr64_t va,
468 vm_prot_t prot);
469extern addr64_t vmm_get_page_mapping(thread_t act, vmm_thread_index_t index,
470 addr64_t va);
471extern kern_return_t vmm_unmap_page(thread_t act, vmm_thread_index_t index, addr64_t va);
472extern void vmm_unmap_all_pages(thread_t act, vmm_thread_index_t index);
473extern boolean_t vmm_get_page_dirty_flag(thread_t act, vmm_thread_index_t index,
474 addr64_t va, unsigned int reset);
475extern kern_return_t vmm_activate_XA(thread_t act, vmm_thread_index_t index, unsigned int xaflags);
476extern kern_return_t vmm_deactivate_XA(thread_t act, vmm_thread_index_t index, unsigned int xaflags);
477extern unsigned int vmm_get_XA(thread_t act, vmm_thread_index_t index);
478extern int vmm_get_features(struct savearea *);
479extern int vmm_get_version(struct savearea *);
480extern int vmm_init_context(struct savearea *);
481extern int vmm_dispatch(struct savearea *);
482extern int vmm_exit(thread_t act, struct savearea *);
483extern void vmm_force_exit(thread_t act, struct savearea *);
484extern int vmm_stop_vm(struct savearea *save);
485extern void vmm_timer_pop(thread_t act);
486extern void vmm_interrupt(ReturnHandler *rh, thread_t act);
487extern kern_return_t vmm_map_list(thread_t act, vmm_thread_index_t index, unsigned int cnt, unsigned int flavor);
488extern kern_return_t vmm_unmap_list(thread_t act, vmm_thread_index_t index, unsigned int cnt, unsigned int flavor);
489extern vmm_return_code_t vmm_resume_guest(vmm_thread_index_t index, unsigned long pc,
490 unsigned long vmmCntrl, unsigned long vmmCntrMaskl);
491extern vmm_return_code_t vmm_exit_to_host(vmm_thread_index_t index);
492extern unsigned long vmm_get_guest_register(vmm_thread_index_t index, unsigned long reg_index);
493extern vmm_return_code_t vmm_set_guest_register(vmm_thread_index_t index, unsigned long reg_index, unsigned long reg_value);
494extern addr64_t vmm_max_addr(thread_t act);
495extern kern_return_t vmm_set_guest_memory(thread_t act, vmm_thread_index_t index, addr64_t base, addr64_t extent);
496extern kern_return_t vmm_purge_local(thread_t act, vmm_thread_index_t index);
497
498#endif
mirror of XNU