x86.h@ 31627

Last change on this file since 31627 was 31490, checked in by vboxsync, 14 years ago
VBox/x86.h: X86TSS16.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 100.5 KB

Line
1	/** @file
2	* X86 (and AMD64) Structures and Definitions (VMM,++).
3	*
4	* x86.mac is generated from this file by running 'kmk incs' in the root.
5	*/
6
7	/*
8	* Copyright (C) 2006-2009 Oracle Corporation
9	*
10	* This file is part of VirtualBox Open Source Edition (OSE), as
11	* available from http://www.virtualbox.org. This file is free software;
12	* you can redistribute it and/or modify it under the terms of the GNU
13	* General Public License (GPL) as published by the Free Software
14	* Foundation, in version 2 as it comes in the "COPYING" file of the
15	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17	*
18	* The contents of this file may alternatively be used under the terms
19	* of the Common Development and Distribution License Version 1.0
20	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
21	* VirtualBox OSE distribution, in which case the provisions of the
22	* CDDL are applicable instead of those of the GPL.
23	*
24	* You may elect to license modified versions of this file under the
25	* terms and conditions of either the GPL or the CDDL or both.
26	*/
27
28	#ifndef ___VBox_x86_h
29	#define ___VBox_x86_h
30
31	#include <VBox/types.h>
32	#include <iprt/assert.h>
33
34	/* Workaround for Solaris sys/regset.h defining CS, DS */
35	#ifdef RT_OS_SOLARIS
36	# undef CS
37	# undef DS
38	#endif
39
40	/** @defgroup grp_x86 x86 Types and Definitions
41	* @{
42	*/
43
44	/**
45	* EFLAGS Bits.
46	*/
47	typedef struct X86EFLAGSBITS
48	{
49	/** Bit 0 - CF - Carry flag - Status flag. */
50	unsigned u1CF : 1;
51	/** Bit 1 - 1 - Reserved flag. */
52	unsigned u1Reserved0 : 1;
53	/** Bit 2 - PF - Parity flag - Status flag. */
54	unsigned u1PF : 1;
55	/** Bit 3 - 0 - Reserved flag. */
56	unsigned u1Reserved1 : 1;
57	/** Bit 4 - AF - Auxiliary carry flag - Status flag. */
58	unsigned u1AF : 1;
59	/** Bit 5 - 0 - Reserved flag. */
60	unsigned u1Reserved2 : 1;
61	/** Bit 6 - ZF - Zero flag - Status flag. */
62	unsigned u1ZF : 1;
63	/** Bit 7 - SF - Signed flag - Status flag. */
64	unsigned u1SF : 1;
65	/** Bit 8 - TF - Trap flag - System flag. */
66	unsigned u1TF : 1;
67	/** Bit 9 - IF - Interrupt flag - System flag. */
68	unsigned u1IF : 1;
69	/** Bit 10 - DF - Direction flag - Control flag. */
70	unsigned u1DF : 1;
71	/** Bit 11 - OF - Overflow flag - Status flag. */
72	unsigned u1OF : 1;
73	/** Bit 12-13 - IOPL - I/O prvilege level flag - System flag. */
74	unsigned u2IOPL : 2;
75	/** Bit 14 - NT - Nested task flag - System flag. */
76	unsigned u1NT : 1;
77	/** Bit 15 - 0 - Reserved flag. */
78	unsigned u1Reserved3 : 1;
79	/** Bit 16 - RF - Resume flag - System flag. */
80	unsigned u1RF : 1;
81	/** Bit 17 - VM - Virtual 8086 mode - System flag. */
82	unsigned u1VM : 1;
83	/** Bit 18 - AC - Alignment check flag - System flag. Works with CR0.AM. */
84	unsigned u1AC : 1;
85	/** Bit 19 - VIF - Virtual interupt flag - System flag. */
86	unsigned u1VIF : 1;
87	/** Bit 20 - VIP - Virtual interupt pending flag - System flag. */
88	unsigned u1VIP : 1;
89	/** Bit 21 - ID - CPUID flag - System flag. If this responds to flipping CPUID is supported. */
90	unsigned u1ID : 1;
91	/** Bit 22-31 - 0 - Reserved flag. */
92	unsigned u10Reserved4 : 10;
93	} X86EFLAGSBITS;
94	/** Pointer to EFLAGS bits. */
95	typedef X86EFLAGSBITS *PX86EFLAGSBITS;
96	/** Pointer to const EFLAGS bits. */
97	typedef const X86EFLAGSBITS *PCX86EFLAGSBITS;
98
99	/**
100	* EFLAGS.
101	*/
102	typedef union X86EFLAGS
103	{
104	/** The plain unsigned view. */
105	uint32_t u;
106	/** The bitfield view. */
107	X86EFLAGSBITS Bits;
108	/** The 8-bit view. */
109	uint8_t au8[4];
110	/** The 16-bit view. */
111	uint16_t au16[2];
112	/** The 32-bit view. */
113	uint32_t au32[1];
114	/** The 32-bit view. */
115	uint32_t u32;
116	} X86EFLAGS;
117	/** Pointer to EFLAGS. */
118	typedef X86EFLAGS *PX86EFLAGS;
119	/** Pointer to const EFLAGS. */
120	typedef const X86EFLAGS *PCX86EFLAGS;
121
122	/**
123	* RFLAGS (32 upper bits are reserved).
124	*/
125	typedef union X86RFLAGS
126	{
127	/** The plain unsigned view. */
128	uint64_t u;
129	/** The bitfield view. */
130	X86EFLAGSBITS Bits;
131	/** The 8-bit view. */
132	uint8_t au8[8];
133	/** The 16-bit view. */
134	uint16_t au16[4];
135	/** The 32-bit view. */
136	uint32_t au32[2];
137	/** The 64-bit view. */
138	uint64_t au64[1];
139	/** The 64-bit view. */
140	uint64_t u64;
141	} X86RFLAGS;
142	/** Pointer to RFLAGS. */
143	typedef X86RFLAGS *PX86RFLAGS;
144	/** Pointer to const RFLAGS. */
145	typedef const X86RFLAGS *PCX86RFLAGS;
146
147
148	/** @name EFLAGS
149	* @{
150	*/
151	/** Bit 0 - CF - Carry flag - Status flag. */
152	#define X86_EFL_CF RT_BIT(0)
153	/** Bit 2 - PF - Parity flag - Status flag. */
154	#define X86_EFL_PF RT_BIT(2)
155	/** Bit 4 - AF - Auxiliary carry flag - Status flag. */
156	#define X86_EFL_AF RT_BIT(4)
157	/** Bit 6 - ZF - Zero flag - Status flag. */
158	#define X86_EFL_ZF RT_BIT(6)
159	/** Bit 7 - SF - Signed flag - Status flag. */
160	#define X86_EFL_SF RT_BIT(7)
161	/** Bit 8 - TF - Trap flag - System flag. */
162	#define X86_EFL_TF RT_BIT(8)
163	/** Bit 9 - IF - Interrupt flag - System flag. */
164	#define X86_EFL_IF RT_BIT(9)
165	/** Bit 10 - DF - Direction flag - Control flag. */
166	#define X86_EFL_DF RT_BIT(10)
167	/** Bit 11 - OF - Overflow flag - Status flag. */
168	#define X86_EFL_OF RT_BIT(11)
169	/** Bit 12-13 - IOPL - I/O prvilege level flag - System flag. */
170	#define X86_EFL_IOPL (RT_BIT(12) \| RT_BIT(13))
171	/** Bit 14 - NT - Nested task flag - System flag. */
172	#define X86_EFL_NT RT_BIT(14)
173	/** Bit 16 - RF - Resume flag - System flag. */
174	#define X86_EFL_RF RT_BIT(16)
175	/** Bit 17 - VM - Virtual 8086 mode - System flag. */
176	#define X86_EFL_VM RT_BIT(17)
177	/** Bit 18 - AC - Alignment check flag - System flag. Works with CR0.AM. */
178	#define X86_EFL_AC RT_BIT(18)
179	/** Bit 19 - VIF - Virtual interupt flag - System flag. */
180	#define X86_EFL_VIF RT_BIT(19)
181	/** Bit 20 - VIP - Virtual interupt pending flag - System flag. */
182	#define X86_EFL_VIP RT_BIT(20)
183	/** Bit 21 - ID - CPUID flag - System flag. If this responds to flipping CPUID is supported. */
184	#define X86_EFL_ID RT_BIT(21)
185	/** IOPL shift. */
186	#define X86_EFL_IOPL_SHIFT 12
187	/** The the IOPL level from the flags. */
188	#define X86_EFL_GET_IOPL(efl) (((efl) >> X86_EFL_IOPL_SHIFT) & 3)
189	/** Bits restored by popf */
190	#define X86_EFL_POPF_BITS (X86_EFL_CF \| X86_EFL_PF \| X86_EFL_AF \| X86_EFL_ZF \| X86_EFL_SF \| X86_EFL_TF \| X86_EFL_IF \| X86_EFL_DF \| X86_EFL_OF \| X86_EFL_IOPL \| X86_EFL_NT \| X86_EFL_AC \| X86_EFL_ID)
191	/** @} */
192
193
194	/** CPUID Feature information - ECX.
195	* CPUID query with EAX=1.
196	*/
197	typedef struct X86CPUIDFEATECX
198	{
199	/** Bit 0 - SSE3 - Supports SSE3 or not. */
200	unsigned u1SSE3 : 1;
201	/** Reserved. */
202	unsigned u1Reserved1 : 1;
203	/** Bit 2 - DS Area 64-bit layout. */
204	unsigned u1DTE64 : 1;
205	/** Bit 3 - MONITOR - Supports MONITOR/MWAIT. */
206	unsigned u1Monitor : 1;
207	/** Bit 4 - CPL-DS - CPL Qualified Debug Store. */
208	unsigned u1CPLDS : 1;
209	/** Bit 5 - VMX - Virtual Machine Technology. */
210	unsigned u1VMX : 1;
211	/** Bit 6 - SMX: Safer Mode Extensions. */
212	unsigned u1SMX : 1;
213	/** Bit 7 - EST - Enh. SpeedStep Tech. */
214	unsigned u1EST : 1;
215	/** Bit 8 - TM2 - Terminal Monitor 2. */
216	unsigned u1TM2 : 1;
217	/** Bit 9 - SSSE3 - Supplemental Streaming SIMD Extensions 3. */
218	unsigned u1SSSE3 : 1;
219	/** Bit 10 - CNTX-ID - L1 Context ID. */
220	unsigned u1CNTXID : 1;
221	/** Bit 11 - FMA. */
222	unsigned u1FMA : 1;
223	/** Bit 12 - Reserved. */
224	unsigned u1Reserved2 : 1;
225	/** Bit 13 - CX16 - CMPXCHG16B. */
226	unsigned u1CX16 : 1;
227	/** Bit 14 - xTPR Update Control. Processor supports changing IA32_MISC_ENABLES[bit 23]. */
228	unsigned u1TPRUpdate : 1;
229	/** Bit 15 - PDCM - Perf/Debug Capability MSR. */
230	unsigned u1PDCM : 1;
231	/** Reserved. */
232	unsigned u2Reserved3 : 2;
233	/** Bit 18 - Direct Cache Access. */
234	unsigned u1DCA : 1;
235	/** Bit 19 - SSE4_1 - Supports SSE4_1 or not. */
236	unsigned u1SSE4_1 : 1;
237	/** Bit 20 - SSE4_2 - Supports SSE4_2 or not. */
238	unsigned u1SSE4_2 : 1;
239	/** Bit 21 - x2APIC. */
240	unsigned u1x2APIC : 1;
241	/** Bit 22 - MOVBE - Supports MOVBE. */
242	unsigned u1MOVBE : 1;
243	/** Bit 23 - POPCNT - Supports POPCNT. */
244	unsigned u1POPCNT : 1;
245	/** Bit 24 - Reserved. */
246	unsigned u1Reserved4 : 1;
247	/** Bit 25 - AES. */
248	unsigned u1AES : 1;
249	/** Bit 26 - XSAVE - Supports XSAVE. */
250	unsigned u1XSAVE : 1;
251	/** Bit 27 - OSXSAVE - Supports OSXSAVE. */
252	unsigned u1OSXSAVE : 1;
253	/** Reserved. */
254	unsigned u4Reserved5 : 4;
255	} X86CPUIDFEATECX;
256	/** Pointer to CPUID Feature Information - ECX. */
257	typedef X86CPUIDFEATECX *PX86CPUIDFEATECX;
258	/** Pointer to const CPUID Feature Information - ECX. */
259	typedef const X86CPUIDFEATECX *PCX86CPUIDFEATECX;
260
261
262	/** CPUID Feature Information - EDX.
263	* CPUID query with EAX=1.
264	*/
265	typedef struct X86CPUIDFEATEDX
266	{
267	/** Bit 0 - FPU - x87 FPU on Chip. */
268	unsigned u1FPU : 1;
269	/** Bit 1 - VME - Virtual 8086 Mode Enhancements. */
270	unsigned u1VME : 1;
271	/** Bit 2 - DE - Debugging extensions. */
272	unsigned u1DE : 1;
273	/** Bit 3 - PSE - Page Size Extension. */
274	unsigned u1PSE : 1;
275	/** Bit 4 - TSC - Time Stamp Counter. */
276	unsigned u1TSC : 1;
277	/** Bit 5 - MSR - Model Specific Registers RDMSR and WRMSR Instructions. */
278	unsigned u1MSR : 1;
279	/** Bit 6 - PAE - Physical Address Extension. */
280	unsigned u1PAE : 1;
281	/** Bit 7 - MCE - Machine Check Exception. */
282	unsigned u1MCE : 1;
283	/** Bit 8 - CX8 - CMPXCHG8B instruction. */
284	unsigned u1CX8 : 1;
285	/** Bit 9 - APIC - APIC On-Chip. */
286	unsigned u1APIC : 1;
287	/** Bit 10 - Reserved. */
288	unsigned u1Reserved1 : 1;
289	/** Bit 11 - SEP - SYSENTER and SYSEXIT. */
290	unsigned u1SEP : 1;
291	/** Bit 12 - MTRR - Memory Type Range Registers. */
292	unsigned u1MTRR : 1;
293	/** Bit 13 - PGE - PTE Global Bit. */
294	unsigned u1PGE : 1;
295	/** Bit 14 - MCA - Machine Check Architecture. */
296	unsigned u1MCA : 1;
297	/** Bit 15 - CMOV - Conditional Move Instructions. */
298	unsigned u1CMOV : 1;
299	/** Bit 16 - PAT - Page Attribute Table. */
300	unsigned u1PAT : 1;
301	/** Bit 17 - PSE-36 - 36-bit Page Size Extention. */
302	unsigned u1PSE36 : 1;
303	/** Bit 18 - PSN - Processor Serial Number. */
304	unsigned u1PSN : 1;
305	/** Bit 19 - CLFSH - CLFLUSH Instruction. */
306	unsigned u1CLFSH : 1;
307	/** Bit 20 - Reserved. */
308	unsigned u1Reserved2 : 1;
309	/** Bit 21 - DS - Debug Store. */
310	unsigned u1DS : 1;
311	/** Bit 22 - ACPI - Thermal Monitor and Software Controlled Clock Facilities. */
312	unsigned u1ACPI : 1;
313	/** Bit 23 - MMX - Intel MMX 'Technology'. */
314	unsigned u1MMX : 1;
315	/** Bit 24 - FXSR - FXSAVE and FXRSTOR Instructions. */
316	unsigned u1FXSR : 1;
317	/** Bit 25 - SSE - SSE Support. */
318	unsigned u1SSE : 1;
319	/** Bit 26 - SSE2 - SSE2 Support. */
320	unsigned u1SSE2 : 1;
321	/** Bit 27 - SS - Self Snoop. */
322	unsigned u1SS : 1;
323	/** Bit 28 - HTT - Hyper-Threading Technology. */
324	unsigned u1HTT : 1;
325	/** Bit 29 - TM - Thermal Monitor. */
326	unsigned u1TM : 1;
327	/** Bit 30 - Reserved - . */
328	unsigned u1Reserved3 : 1;
329	/** Bit 31 - PBE - Pending Break Enabled. */
330	unsigned u1PBE : 1;
331	} X86CPUIDFEATEDX;
332	/** Pointer to CPUID Feature Information - EDX. */
333	typedef X86CPUIDFEATEDX *PX86CPUIDFEATEDX;
334	/** Pointer to const CPUID Feature Information - EDX. */
335	typedef const X86CPUIDFEATEDX *PCX86CPUIDFEATEDX;
336
337	/** @name CPUID Vendor information.
338	* CPUID query with EAX=0.
339	* @{
340	*/
341	#define X86_CPUID_VENDOR_INTEL_EBX 0x756e6547 /* Genu */
342	#define X86_CPUID_VENDOR_INTEL_ECX 0x6c65746e /* ntel */
343	#define X86_CPUID_VENDOR_INTEL_EDX 0x49656e69 /* ineI */
344
345	#define X86_CPUID_VENDOR_AMD_EBX 0x68747541 /* Auth */
346	#define X86_CPUID_VENDOR_AMD_ECX 0x444d4163 /* cAMD */
347	#define X86_CPUID_VENDOR_AMD_EDX 0x69746e65 /* enti */
348	/** @} */
349
350
351	/** @name CPUID Feature information.
352	* CPUID query with EAX=1.
353	* @{
354	*/
355	/** ECX Bit 0 - SSE3 - Supports SSE3 or not. */
356	#define X86_CPUID_FEATURE_ECX_SSE3 RT_BIT(0)
357	/** ECX Bit 1 - PCLMUL - PCLMULQDQ support (for AES-GCM). */
358	#define X86_CPUID_FEATURE_ECX_PCLMUL RT_BIT(1)
359	/** ECX Bit 2 - DTES64 - DS Area 64-bit Layout. */
360	#define X86_CPUID_FEATURE_ECX_DTES64 RT_BIT(2)
361	/** ECX Bit 3 - MONITOR - Supports MONITOR/MWAIT. */
362	#define X86_CPUID_FEATURE_ECX_MONITOR RT_BIT(3)
363	/** ECX Bit 4 - CPL-DS - CPL Qualified Debug Store. */
364	#define X86_CPUID_FEATURE_ECX_CPLDS RT_BIT(4)
365	/** ECX Bit 5 - VMX - Virtual Machine Technology. */
366	#define X86_CPUID_FEATURE_ECX_VMX RT_BIT(5)
367	/** ECX Bit 6 - SMX - Safer Mode Extensions. */
368	#define X86_CPUID_FEATURE_ECX_SMX RT_BIT(6)
369	/** ECX Bit 7 - EST - Enh. SpeedStep Tech. */
370	#define X86_CPUID_FEATURE_ECX_EST RT_BIT(7)
371	/** ECX Bit 8 - TM2 - Terminal Monitor 2. */
372	#define X86_CPUID_FEATURE_ECX_TM2 RT_BIT(8)
373	/** ECX Bit 9 - SSSE3 - Supplemental Streaming SIMD Extensions 3. */
374	#define X86_CPUID_FEATURE_ECX_SSSE3 RT_BIT(9)
375	/** ECX Bit 10 - CNTX-ID - L1 Context ID. */
376	#define X86_CPUID_FEATURE_ECX_CNTXID RT_BIT(10)
377	/** ECX Bit 12 - FMA. */
378	#define X86_CPUID_FEATURE_ECX_FMA RT_BIT(12)
379	/** ECX Bit 13 - CX16 - CMPXCHG16B. */
380	#define X86_CPUID_FEATURE_ECX_CX16 RT_BIT(13)
381	/** ECX Bit 14 - xTPR Update Control. Processor supports changing IA32_MISC_ENABLES[bit 23]. */
382	#define X86_CPUID_FEATURE_ECX_TPRUPDATE RT_BIT(14)
383	/** ECX Bit 15 - PDCM - Perf/Debug Capability MSR. */
384	#define X86_CPUID_FEATURE_ECX_PDCM RT_BIT(15)
385	/** ECX Bit 18 - DCA - Direct Cache Access. */
386	#define X86_CPUID_FEATURE_ECX_DCA RT_BIT(18)
387	/** ECX Bit 19 - SSE4_1 - Supports SSE4_1 or not. */
388	#define X86_CPUID_FEATURE_ECX_SSE4_1 RT_BIT(19)
389	/** ECX Bit 20 - SSE4_2 - Supports SSE4_2 or not. */
390	#define X86_CPUID_FEATURE_ECX_SSE4_2 RT_BIT(20)
391	/** ECX Bit 21 - x2APIC support. */
392	#define X86_CPUID_FEATURE_ECX_X2APIC RT_BIT(21)
393	/** ECX Bit 22 - MOVBE instruction. */
394	#define X86_CPUID_FEATURE_ECX_MOVBE RT_BIT(22)
395	/** ECX Bit 23 - POPCNT instruction. */
396	#define X86_CPUID_FEATURE_ECX_POPCNT RT_BIT(23)
397	/** ECX Bit 25 - AES instructions. */
398	#define X86_CPUID_FEATURE_ECX_AES RT_BIT(25)
399	/** ECX Bit 26 - XSAVE instruction. */
400	#define X86_CPUID_FEATURE_ECX_XSAVE RT_BIT(26)
401	/** ECX Bit 27 - OSXSAVE instruction. */
402	#define X86_CPUID_FEATURE_ECX_OSXSAVE RT_BIT(27)
403	/** ECX Bit 28 - AVX. */
404	#define X86_CPUID_FEATURE_ECX_AVX RT_BIT(28)
405
406
407	/** Bit 0 - FPU - x87 FPU on Chip. */
408	#define X86_CPUID_FEATURE_EDX_FPU RT_BIT(0)
409	/** Bit 1 - VME - Virtual 8086 Mode Enhancements. */
410	#define X86_CPUID_FEATURE_EDX_VME RT_BIT(1)
411	/** Bit 2 - DE - Debugging extensions. */
412	#define X86_CPUID_FEATURE_EDX_DE RT_BIT(2)
413	/** Bit 3 - PSE - Page Size Extension. */
414	#define X86_CPUID_FEATURE_EDX_PSE RT_BIT(3)
415	/** Bit 4 - TSC - Time Stamp Counter. */
416	#define X86_CPUID_FEATURE_EDX_TSC RT_BIT(4)
417	/** Bit 5 - MSR - Model Specific Registers RDMSR and WRMSR Instructions. */
418	#define X86_CPUID_FEATURE_EDX_MSR RT_BIT(5)
419	/** Bit 6 - PAE - Physical Address Extension. */
420	#define X86_CPUID_FEATURE_EDX_PAE RT_BIT(6)
421	/** Bit 7 - MCE - Machine Check Exception. */
422	#define X86_CPUID_FEATURE_EDX_MCE RT_BIT(7)
423	/** Bit 8 - CX8 - CMPXCHG8B instruction. */
424	#define X86_CPUID_FEATURE_EDX_CX8 RT_BIT(8)
425	/** Bit 9 - APIC - APIC On-Chip. */
426	#define X86_CPUID_FEATURE_EDX_APIC RT_BIT(9)
427	/** Bit 11 - SEP - SYSENTER and SYSEXIT. */
428	#define X86_CPUID_FEATURE_EDX_SEP RT_BIT(11)
429	/** Bit 12 - MTRR - Memory Type Range Registers. */
430	#define X86_CPUID_FEATURE_EDX_MTRR RT_BIT(12)
431	/** Bit 13 - PGE - PTE Global Bit. */
432	#define X86_CPUID_FEATURE_EDX_PGE RT_BIT(13)
433	/** Bit 14 - MCA - Machine Check Architecture. */
434	#define X86_CPUID_FEATURE_EDX_MCA RT_BIT(14)
435	/** Bit 15 - CMOV - Conditional Move Instructions. */
436	#define X86_CPUID_FEATURE_EDX_CMOV RT_BIT(15)
437	/** Bit 16 - PAT - Page Attribute Table. */
438	#define X86_CPUID_FEATURE_EDX_PAT RT_BIT(16)
439	/** Bit 17 - PSE-36 - 36-bit Page Size Extention. */
440	#define X86_CPUID_FEATURE_EDX_PSE36 RT_BIT(17)
441	/** Bit 18 - PSN - Processor Serial Number. */
442	#define X86_CPUID_FEATURE_EDX_PSN RT_BIT(18)
443	/** Bit 19 - CLFSH - CLFLUSH Instruction. */
444	#define X86_CPUID_FEATURE_EDX_CLFSH RT_BIT(19)
445	/** Bit 21 - DS - Debug Store. */
446	#define X86_CPUID_FEATURE_EDX_DS RT_BIT(21)
447	/** Bit 22 - ACPI - Termal Monitor and Software Controlled Clock Facilities. */
448	#define X86_CPUID_FEATURE_EDX_ACPI RT_BIT(22)
449	/** Bit 23 - MMX - Intel MMX Technology. */
450	#define X86_CPUID_FEATURE_EDX_MMX RT_BIT(23)
451	/** Bit 24 - FXSR - FXSAVE and FXRSTOR Instructions. */
452	#define X86_CPUID_FEATURE_EDX_FXSR RT_BIT(24)
453	/** Bit 25 - SSE - SSE Support. */
454	#define X86_CPUID_FEATURE_EDX_SSE RT_BIT(25)
455	/** Bit 26 - SSE2 - SSE2 Support. */
456	#define X86_CPUID_FEATURE_EDX_SSE2 RT_BIT(26)
457	/** Bit 27 - SS - Self Snoop. */
458	#define X86_CPUID_FEATURE_EDX_SS RT_BIT(27)
459	/** Bit 28 - HTT - Hyper-Threading Technology. */
460	#define X86_CPUID_FEATURE_EDX_HTT RT_BIT(28)
461	/** Bit 29 - TM - Therm. Monitor. */
462	#define X86_CPUID_FEATURE_EDX_TM RT_BIT(29)
463	/** Bit 31 - PBE - Pending Break Enabled. */
464	#define X86_CPUID_FEATURE_EDX_PBE RT_BIT(31)
465	/** @} */
466
467	/** @name CPUID mwait/monitor information.
468	* CPUID query with EAX=5.
469	* @{
470	*/
471	/** ECX Bit 0 - MWAITEXT - Supports mwait/monitor extensions or not. */
472	#define X86_CPUID_MWAIT_ECX_EXT RT_BIT(0)
473	/** ECX Bit 1 - MWAITBREAK - Break mwait for external interrupt even if EFLAGS.IF=0. */
474	#define X86_CPUID_MWAIT_ECX_BREAKIRQIF0 RT_BIT(1)
475	/** @} */
476
477
478	/** @name CPUID AMD Feature information.
479	* CPUID query with EAX=0x80000001.
480	* @{
481	*/
482	/** Bit 0 - FPU - x87 FPU on Chip. */
483	#define X86_CPUID_AMD_FEATURE_EDX_FPU RT_BIT(0)
484	/** Bit 1 - VME - Virtual 8086 Mode Enhancements. */
485	#define X86_CPUID_AMD_FEATURE_EDX_VME RT_BIT(1)
486	/** Bit 2 - DE - Debugging extensions. */
487	#define X86_CPUID_AMD_FEATURE_EDX_DE RT_BIT(2)
488	/** Bit 3 - PSE - Page Size Extension. */
489	#define X86_CPUID_AMD_FEATURE_EDX_PSE RT_BIT(3)
490	/** Bit 4 - TSC - Time Stamp Counter. */
491	#define X86_CPUID_AMD_FEATURE_EDX_TSC RT_BIT(4)
492	/** Bit 5 - MSR - K86 Model Specific Registers RDMSR and WRMSR Instructions. */
493	#define X86_CPUID_AMD_FEATURE_EDX_MSR RT_BIT(5)
494	/** Bit 6 - PAE - Physical Address Extension. */
495	#define X86_CPUID_AMD_FEATURE_EDX_PAE RT_BIT(6)
496	/** Bit 7 - MCE - Machine Check Exception. */
497	#define X86_CPUID_AMD_FEATURE_EDX_MCE RT_BIT(7)
498	/** Bit 8 - CX8 - CMPXCHG8B instruction. */
499	#define X86_CPUID_AMD_FEATURE_EDX_CX8 RT_BIT(8)
500	/** Bit 9 - APIC - APIC On-Chip. */
501	#define X86_CPUID_AMD_FEATURE_EDX_APIC RT_BIT(9)
502	/** Bit 11 - SEP - AMD SYSCALL and SYSRET. */
503	#define X86_CPUID_AMD_FEATURE_EDX_SEP RT_BIT(11)
504	/** Bit 12 - MTRR - Memory Type Range Registers. */
505	#define X86_CPUID_AMD_FEATURE_EDX_MTRR RT_BIT(12)
506	/** Bit 13 - PGE - PTE Global Bit. */
507	#define X86_CPUID_AMD_FEATURE_EDX_PGE RT_BIT(13)
508	/** Bit 14 - MCA - Machine Check Architecture. */
509	#define X86_CPUID_AMD_FEATURE_EDX_MCA RT_BIT(14)
510	/** Bit 15 - CMOV - Conditional Move Instructions. */
511	#define X86_CPUID_AMD_FEATURE_EDX_CMOV RT_BIT(15)
512	/** Bit 16 - PAT - Page Attribute Table. */
513	#define X86_CPUID_AMD_FEATURE_EDX_PAT RT_BIT(16)
514	/** Bit 17 - PSE-36 - 36-bit Page Size Extention. */
515	#define X86_CPUID_AMD_FEATURE_EDX_PSE36 RT_BIT(17)
516	/** Bit 20 - NX - AMD No-Execute Page Protection. */
517	#define X86_CPUID_AMD_FEATURE_EDX_NX RT_BIT(20)
518	/** Bit 22 - AXMMX - AMD Extensions to MMX Instructions. */
519	#define X86_CPUID_AMD_FEATURE_EDX_AXMMX RT_BIT(22)
520	/** Bit 23 - MMX - Intel MMX Technology. */
521	#define X86_CPUID_AMD_FEATURE_EDX_MMX RT_BIT(23)
522	/** Bit 24 - FXSR - FXSAVE and FXRSTOR Instructions. */
523	#define X86_CPUID_AMD_FEATURE_EDX_FXSR RT_BIT(24)
524	/** Bit 25 - FFXSR - AMD fast FXSAVE and FXRSTOR Instructions. */
525	#define X86_CPUID_AMD_FEATURE_EDX_FFXSR RT_BIT(25)
526	/** Bit 26 - PAGE1GB - AMD 1GB large page support. */
527	#define X86_CPUID_AMD_FEATURE_EDX_PAGE1GB RT_BIT(26)
528	/** Bit 27 - RDTSCP - AMD RDTSCP instruction. */
529	#define X86_CPUID_AMD_FEATURE_EDX_RDTSCP RT_BIT(27)
530	/** Bit 29 - LM - AMD Long Mode. */
531	#define X86_CPUID_AMD_FEATURE_EDX_LONG_MODE RT_BIT(29)
532	/** Bit 30 - 3DNOWEXT - AMD Extensions to 3DNow. */
533	#define X86_CPUID_AMD_FEATURE_EDX_3DNOW_EX RT_BIT(30)
534	/** Bit 31 - 3DNOW - AMD 3DNow. */
535	#define X86_CPUID_AMD_FEATURE_EDX_3DNOW RT_BIT(31)
536
537	/** Bit 0 - LAHF/SAHF - AMD LAHF and SAHF in 64-bit mode. */
538	#define X86_CPUID_AMD_FEATURE_ECX_LAHF_SAHF RT_BIT(0)
539	/** Bit 1 - CMPL - Core multi-processing legacy mode. */
540	#define X86_CPUID_AMD_FEATURE_ECX_CMPL RT_BIT(1)
541	/** Bit 2 - SVM - AMD VM extensions. */
542	#define X86_CPUID_AMD_FEATURE_ECX_SVM RT_BIT(2)
543	/** Bit 3 - EXTAPIC - AMD extended APIC registers starting at 0x400. */
544	#define X86_CPUID_AMD_FEATURE_ECX_EXT_APIC RT_BIT(3)
545	/** Bit 4 - CR8L - AMD LOCK MOV CR0 means MOV CR8. */
546	#define X86_CPUID_AMD_FEATURE_ECX_CR8L RT_BIT(4)
547	/** Bit 5 - ABM - AMD Advanced bit manipulation. LZCNT instruction support. */
548	#define X86_CPUID_AMD_FEATURE_ECX_ABM RT_BIT(5)
549	/** Bit 6 - SSE4A - AMD EXTRQ, INSERTQ, MOVNTSS, and MOVNTSD instruction support. */
550	#define X86_CPUID_AMD_FEATURE_ECX_SSE4A RT_BIT(6)
551	/** Bit 7 - MISALIGNSSE - AMD Misaligned SSE mode. */
552	#define X86_CPUID_AMD_FEATURE_ECX_MISALNSSE RT_BIT(7)
553	/** Bit 8 - 3DNOWPRF - AMD PREFETCH and PREFETCHW instruction support. */
554	#define X86_CPUID_AMD_FEATURE_ECX_3DNOWPRF RT_BIT(8)
555	/** Bit 9 - OSVW - AMD OS visible workaround. */
556	#define X86_CPUID_AMD_FEATURE_ECX_OSVW RT_BIT(9)
557	/** Bit 10 - IBS - Instruct based sampling. */
558	#define X86_CPUID_AMD_FEATURE_ECX_IBS RT_BIT(10)
559	/** Bit 11 - SSE5 - SSE5 instruction support. */
560	#define X86_CPUID_AMD_FEATURE_ECX_SSE5 RT_BIT(11)
561	/** Bit 12 - SKINIT - AMD SKINIT: SKINIT, STGI, and DEV support. */
562	#define X86_CPUID_AMD_FEATURE_ECX_SKINIT RT_BIT(12)
563	/** Bit 13 - WDT - AMD Watchdog timer support. */
564	#define X86_CPUID_AMD_FEATURE_ECX_WDT RT_BIT(13)
565
566	/** @} */
567
568
569	/** @name CPUID AMD Feature information.
570	* CPUID query with EAX=0x80000007.
571	* @{
572	*/
573	/** Bit 0 - TS - Temperature Sensor. */
574	#define X86_CPUID_AMD_ADVPOWER_EDX_TS RT_BIT(0)
575	/** Bit 1 - FID - Frequency ID Control. */
576	#define X86_CPUID_AMD_ADVPOWER_EDX_FID RT_BIT(1)
577	/** Bit 2 - VID - Voltage ID Control. */
578	#define X86_CPUID_AMD_ADVPOWER_EDX_VID RT_BIT(2)
579	/** Bit 3 - TTP - THERMTRIP. */
580	#define X86_CPUID_AMD_ADVPOWER_EDX_TTP RT_BIT(3)
581	/** Bit 4 - TM - Hardware Thermal Control. */
582	#define X86_CPUID_AMD_ADVPOWER_EDX_TM RT_BIT(4)
583	/** Bit 5 - STC - Software Thermal Control. */
584	#define X86_CPUID_AMD_ADVPOWER_EDX_STC RT_BIT(5)
585	/** Bit 6 - MC - 100 Mhz Multiplier Control. */
586	#define X86_CPUID_AMD_ADVPOWER_EDX_MC RT_BIT(6)
587	/** Bit 7 - HWPSTATE - Hardware P-State Control. */
588	#define X86_CPUID_AMD_ADVPOWER_EDX_HWPSTATE RT_BIT(7)
589	/** Bit 8 - TSCINVAR - TSC Invariant. */
590	#define X86_CPUID_AMD_ADVPOWER_EDX_TSCINVAR RT_BIT(8)
591	/** @} */
592
593
594	/** @name CR0
595	* @{ */
596	/** Bit 0 - PE - Protection Enabled */
597	#define X86_CR0_PE RT_BIT(0)
598	#define X86_CR0_PROTECTION_ENABLE RT_BIT(0)
599	/** Bit 1 - MP - Monitor Coprocessor */
600	#define X86_CR0_MP RT_BIT(1)
601	#define X86_CR0_MONITOR_COPROCESSOR RT_BIT(1)
602	/** Bit 2 - EM - Emulation. */
603	#define X86_CR0_EM RT_BIT(2)
604	#define X86_CR0_EMULATE_FPU RT_BIT(2)
605	/** Bit 3 - TS - Task Switch. */
606	#define X86_CR0_TS RT_BIT(3)
607	#define X86_CR0_TASK_SWITCH RT_BIT(3)
608	/** Bit 4 - ET - Extension flag. ('hardcoded' to 1) */
609	#define X86_CR0_ET RT_BIT(4)
610	#define X86_CR0_EXTENSION_TYPE RT_BIT(4)
611	/** Bit 5 - NE - Numeric error. */
612	#define X86_CR0_NE RT_BIT(5)
613	#define X86_CR0_NUMERIC_ERROR RT_BIT(5)
614	/** Bit 16 - WP - Write Protect. */
615	#define X86_CR0_WP RT_BIT(16)
616	#define X86_CR0_WRITE_PROTECT RT_BIT(16)
617	/** Bit 18 - AM - Alignment Mask. */
618	#define X86_CR0_AM RT_BIT(18)
619	#define X86_CR0_ALIGMENT_MASK RT_BIT(18)
620	/** Bit 29 - NW - Not Write-though. */
621	#define X86_CR0_NW RT_BIT(29)
622	#define X86_CR0_NOT_WRITE_THROUGH RT_BIT(29)
623	/** Bit 30 - WP - Cache Disable. */
624	#define X86_CR0_CD RT_BIT(30)
625	#define X86_CR0_CACHE_DISABLE RT_BIT(30)
626	/** Bit 31 - PG - Paging. */
627	#define X86_CR0_PG RT_BIT(31)
628	#define X86_CR0_PAGING RT_BIT(31)
629	/** @} */
630
631
632	/** @name CR3
633	* @{ */
634	/** Bit 3 - PWT - Page-level Writes Transparent. */
635	#define X86_CR3_PWT RT_BIT(3)
636	/** Bit 4 - PCD - Page-level Cache Disable. */
637	#define X86_CR3_PCD RT_BIT(4)
638	/** Bits 12-31 - - Page directory page number. */
639	#define X86_CR3_PAGE_MASK (0xfffff000)
640	/** Bits 5-31 - - PAE Page directory page number. */
641	#define X86_CR3_PAE_PAGE_MASK (0xffffffe0)
642	/** Bits 12-51 - - AMD64 Page directory page number. */
643	#define X86_CR3_AMD64_PAGE_MASK UINT64_C(0x000ffffffffff000)
644	/** @} */
645
646
647	/** @name CR4
648	* @{ */
649	/** Bit 0 - VME - Virtual-8086 Mode Extensions. */
650	#define X86_CR4_VME RT_BIT(0)
651	/** Bit 1 - PVI - Protected-Mode Virtual Interrupts. */
652	#define X86_CR4_PVI RT_BIT(1)
653	/** Bit 2 - TSD - Time Stamp Disable. */
654	#define X86_CR4_TSD RT_BIT(2)
655	/** Bit 3 - DE - Debugging Extensions. */
656	#define X86_CR4_DE RT_BIT(3)
657	/** Bit 4 - PSE - Page Size Extension. */
658	#define X86_CR4_PSE RT_BIT(4)
659	/** Bit 5 - PAE - Physical Address Extension. */
660	#define X86_CR4_PAE RT_BIT(5)
661	/** Bit 6 - MCE - Machine-Check Enable. */
662	#define X86_CR4_MCE RT_BIT(6)
663	/** Bit 7 - PGE - Page Global Enable. */
664	#define X86_CR4_PGE RT_BIT(7)
665	/** Bit 8 - PCE - Performance-Monitoring Counter Enable. */
666	#define X86_CR4_PCE RT_BIT(8)
667	/** Bit 9 - OSFSXR - Operating System Support for FXSAVE and FXRSTORE instruction. */
668	#define X86_CR4_OSFSXR RT_BIT(9)
669	/** Bit 10 - OSXMMEEXCPT - Operating System Support for Unmasked SIMD Floating-Point Exceptions. */
670	#define X86_CR4_OSXMMEEXCPT RT_BIT(10)
671	/** Bit 13 - VMXE - VMX mode is enabled. */
672	#define X86_CR4_VMXE RT_BIT(13)
673	/** @} */
674
675
676	/** @name DR6
677	* @{ */
678	/** Bit 0 - B0 - Breakpoint 0 condition detected. */
679	#define X86_DR6_B0 RT_BIT(0)
680	/** Bit 1 - B1 - Breakpoint 1 condition detected. */
681	#define X86_DR6_B1 RT_BIT(1)
682	/** Bit 2 - B2 - Breakpoint 2 condition detected. */
683	#define X86_DR6_B2 RT_BIT(2)
684	/** Bit 3 - B3 - Breakpoint 3 condition detected. */
685	#define X86_DR6_B3 RT_BIT(3)
686	/** Bit 13 - BD - Debug register access detected. Corresponds to the X86_DR7_GD bit. */
687	#define X86_DR6_BD RT_BIT(13)
688	/** Bit 14 - BS - Single step */
689	#define X86_DR6_BS RT_BIT(14)
690	/** Bit 15 - BT - Task switch. (TSS T bit.) */
691	#define X86_DR6_BT RT_BIT(15)
692	/** Value of DR6 after powerup/reset. */
693	#define X86_DR6_INIT_VAL UINT64_C(0xFFFF0FF0)
694	/** @} */
695
696
697	/** @name DR7
698	* @{ */
699	/** Bit 0 - L0 - Local breakpoint enable. Cleared on task switch. */
700	#define X86_DR7_L0 RT_BIT(0)
701	/** Bit 1 - G0 - Global breakpoint enable. Not cleared on task switch. */
702	#define X86_DR7_G0 RT_BIT(1)
703	/** Bit 2 - L1 - Local breakpoint enable. Cleared on task switch. */
704	#define X86_DR7_L1 RT_BIT(2)
705	/** Bit 3 - G1 - Global breakpoint enable. Not cleared on task switch. */
706	#define X86_DR7_G1 RT_BIT(3)
707	/** Bit 4 - L2 - Local breakpoint enable. Cleared on task switch. */
708	#define X86_DR7_L2 RT_BIT(4)
709	/** Bit 5 - G2 - Global breakpoint enable. Not cleared on task switch. */
710	#define X86_DR7_G2 RT_BIT(5)
711	/** Bit 6 - L3 - Local breakpoint enable. Cleared on task switch. */
712	#define X86_DR7_L3 RT_BIT(6)
713	/** Bit 7 - G3 - Global breakpoint enable. Not cleared on task switch. */
714	#define X86_DR7_G3 RT_BIT(7)
715	/** Bit 8 - LE - Local breakpoint exact. (Not supported (read ignored) by P6 and later.) */
716	#define X86_DR7_LE RT_BIT(8)
717	/** Bit 9 - GE - Local breakpoint exact. (Not supported (read ignored) by P6 and later.) */
718	#define X86_DR7_GE RT_BIT(9)
719
720	/** Bit 13 - GD - General detect enable. Enables emulators to get exceptions when
721	* any DR register is accessed. */
722	#define X86_DR7_GD RT_BIT(13)
723	/** Bit 16 & 17 - R/W0 - Read write field 0. Values X86_DR7_RW_. /
724	#define X86_DR7_RW0_MASK (3 << 16)
725	/** Bit 18 & 19 - LEN0 - Length field 0. Values X86_DR7_LEN_. /
726	#define X86_DR7_LEN0_MASK (3 << 18)
727	/** Bit 20 & 21 - R/W1 - Read write field 0. Values X86_DR7_RW_. /
728	#define X86_DR7_RW1_MASK (3 << 20)
729	/** Bit 22 & 23 - LEN1 - Length field 0. Values X86_DR7_LEN_. /
730	#define X86_DR7_LEN1_MASK (3 << 22)
731	/** Bit 24 & 25 - R/W2 - Read write field 0. Values X86_DR7_RW_. /
732	#define X86_DR7_RW2_MASK (3 << 24)
733	/** Bit 26 & 27 - LEN2 - Length field 0. Values X86_DR7_LEN_. /
734	#define X86_DR7_LEN2_MASK (3 << 26)
735	/** Bit 28 & 29 - R/W3 - Read write field 0. Values X86_DR7_RW_. /
736	#define X86_DR7_RW3_MASK (3 << 28)
737	/** Bit 30 & 31 - LEN3 - Length field 0. Values X86_DR7_LEN_. /
738	#define X86_DR7_LEN3_MASK (3 << 30)
739
740	/** Bits which must be 1s. */
741	#define X86_DR7_MB1_MASK (RT_BIT(10))
742
743	/** Calcs the L bit of Nth breakpoint.
744	* @param iBp The breakpoint number [0..3].
745	*/
746	#define X86_DR7_L(iBp) ( UINT32_C(1) << (iBp * 2) )
747
748	/** Calcs the G bit of Nth breakpoint.
749	* @param iBp The breakpoint number [0..3].
750	*/
751	#define X86_DR7_G(iBp) ( UINT32_C(1) << (iBp * 2 + 1) )
752
753	/** @name Read/Write values.
754	* @{ */
755	/** Break on instruction fetch only. */
756	#define X86_DR7_RW_EO 0U
757	/** Break on write only. */
758	#define X86_DR7_RW_WO 1U
759	/** Break on I/O read/write. This is only defined if CR4.DE is set. */
760	#define X86_DR7_RW_IO 2U
761	/** Break on read or write (but not instruction fetches). */
762	#define X86_DR7_RW_RW 3U
763	/** @} */
764
765	/** Shifts a X86_DR7_RW_* value to its right place.
766	* @param iBp The breakpoint number [0..3].
767	* @param fRw One of the X86_DR7_RW_* value.
768	*/
769	#define X86_DR7_RW(iBp, fRw) ( (fRw) << ((iBp) * 4 + 16) )
770
771	/** @name Length values.
772	* @{ */
773	#define X86_DR7_LEN_BYTE 0U
774	#define X86_DR7_LEN_WORD 1U
775	#define X86_DR7_LEN_QWORD 2U /*< AMD64 long mode only. /
776	#define X86_DR7_LEN_DWORD 3U
777	/** @} */
778
779	/** Shifts a X86_DR7_LEN_* value to its right place.
780	* @param iBp The breakpoint number [0..3].
781	* @param cb One of the X86_DR7_LEN_* values.
782	*/
783	#define X86_DR7_LEN(iBp, cb) ( (cb) << ((iBp) * 4 + 18) )
784
785	/** Fetch the breakpoint length bits from the DR7 value.
786	* @param uDR7 DR7 value
787	* @param iBp The breakpoint number [0..3].
788	*/
789	#define X86_DR7_GET_LEN(uDR7, iBp) ( ( (uDR7) >> ((iBp) * 4 + 18) ) & 0x3U)
790
791	/** Mask used to check if any breakpoints are enabled. */
792	#define X86_DR7_ENABLED_MASK (RT_BIT(0) \| RT_BIT(1) \| RT_BIT(2) \| RT_BIT(3) \| RT_BIT(4) \| RT_BIT(5) \| RT_BIT(6) \| RT_BIT(7))
793
794	/** Mask used to check if any io breakpoints are set. */
795	#define X86_DR7_IO_ENABLED_MASK (X86_DR7_RW(0, X86_DR7_RW_IO) \| X86_DR7_RW(1, X86_DR7_RW_IO) \| X86_DR7_RW(2, X86_DR7_RW_IO) \| X86_DR7_RW(3, X86_DR7_RW_IO))
796
797	/** Value of DR7 after powerup/reset. */
798	#define X86_DR7_INIT_VAL 0x400
799	/** @} */
800
801
802	/** @name Machine Specific Registers
803	* @{
804	*/
805
806	/** Time Stamp Counter. */
807	#define MSR_IA32_TSC 0x10
808
809	#define MSR_IA32_PLATFORM_ID 0x17
810
811	#ifndef MSR_IA32_APICBASE /* qemu cpu.h klugde */
812	#define MSR_IA32_APICBASE 0x1b
813	#endif
814
815	/** CPU Feature control. */
816	#define MSR_IA32_FEATURE_CONTROL 0x3A
817	#define MSR_IA32_FEATURE_CONTROL_LOCK RT_BIT(0)
818	#define MSR_IA32_FEATURE_CONTROL_VMXON RT_BIT(2)
819
820	/** BIOS update trigger (microcode update). */
821	#define MSR_IA32_BIOS_UPDT_TRIG 0x79
822
823	/** BIOS update signature (microcode). */
824	#define MSR_IA32_BIOS_SIGN_ID 0x8B
825
826	/** General performance counter no. 0. */
827	#define MSR_IA32_PMC0 0xC1
828	/** General performance counter no. 1. */
829	#define MSR_IA32_PMC1 0xC2
830	/** General performance counter no. 2. */
831	#define MSR_IA32_PMC2 0xC3
832	/** General performance counter no. 3. */
833	#define MSR_IA32_PMC3 0xC4
834
835	/** Nehalem power control. */
836	#define MSR_IA32_PLATFORM_INFO 0xCE
837
838	/** Get FSB clock status (Intel-specific). */
839	#define MSR_IA32_FSB_CLOCK_STS 0xCD
840
841	/** MTRR Capabilities. */
842	#define MSR_IA32_MTRR_CAP 0xFE
843
844
845	#ifndef MSR_IA32_SYSENTER_CS /* qemu cpu.h klugde */
846	/** SYSENTER_CS - the R0 CS, indirectly giving R0 SS, R3 CS and R3 DS.
847	* R0 SS == CS + 8
848	* R3 CS == CS + 16
849	* R3 SS == CS + 24
850	*/
851	#define MSR_IA32_SYSENTER_CS 0x174
852	/** SYSENTER_ESP - the R0 ESP. */
853	#define MSR_IA32_SYSENTER_ESP 0x175
854	/** SYSENTER_EIP - the R0 EIP. */
855	#define MSR_IA32_SYSENTER_EIP 0x176
856	#endif
857
858	/** Machine Check Global Capabilities Register. */
859	#define MSR_IA32_MCP_CAP 0x179
860	/** Machine Check Global Status Register. */
861	#define MSR_IA32_MCP_STATUS 0x17A
862	/** Machine Check Global Control Register. */
863	#define MSR_IA32_MCP_CTRL 0x17B
864
865	/** Trace/Profile Resource Control (R/W) */
866	#define MSR_IA32_DEBUGCTL 0x1D9
867
868	/* Page Attribute Table. */
869	#define MSR_IA32_CR_PAT 0x277
870
871	/** Performance counter MSRs. (Intel only) */
872	#define MSR_IA32_PERFEVTSEL0 0x186
873	#define MSR_IA32_PERFEVTSEL1 0x187
874	#define MSR_IA32_FLEX_RATIO 0x194
875	#define MSR_IA32_PERF_STATUS 0x198
876	#define MSR_IA32_PERF_CTL 0x199
877	#define MSR_IA32_THERM_STATUS 0x19c
878
879	/** Enable misc. processor features (R/W). */
880	#define MSR_IA32_MISC_ENABLE 0x1A0
881
882	/** MTRR Default Range. */
883	#define MSR_IA32_MTRR_DEF_TYPE 0x2FF
884
885	#define MSR_IA32_MC0_CTL 0x400
886	#define MSR_IA32_MC0_STATUS 0x401
887
888	/** Basic VMX information. */
889	#define MSR_IA32_VMX_BASIC_INFO 0x480
890	/** Allowed settings for pin-based VM execution controls */
891	#define MSR_IA32_VMX_PINBASED_CTLS 0x481
892	/** Allowed settings for proc-based VM execution controls */
893	#define MSR_IA32_VMX_PROCBASED_CTLS 0x482
894	/** Allowed settings for the VMX exit controls. */
895	#define MSR_IA32_VMX_EXIT_CTLS 0x483
896	/** Allowed settings for the VMX entry controls. */
897	#define MSR_IA32_VMX_ENTRY_CTLS 0x484
898	/** Misc VMX info. */
899	#define MSR_IA32_VMX_MISC 0x485
900	/** Fixed cleared bits in CR0. */
901	#define MSR_IA32_VMX_CR0_FIXED0 0x486
902	/** Fixed set bits in CR0. */
903	#define MSR_IA32_VMX_CR0_FIXED1 0x487
904	/** Fixed cleared bits in CR4. */
905	#define MSR_IA32_VMX_CR4_FIXED0 0x488
906	/** Fixed set bits in CR4. */
907	#define MSR_IA32_VMX_CR4_FIXED1 0x489
908	/** Information for enumerating fields in the VMCS. */
909	#define MSR_IA32_VMX_VMCS_ENUM 0x48A
910	/** Allowed settings for secondary proc-based VM execution controls */
911	#define MSR_IA32_VMX_PROCBASED_CTLS2 0x48B
912	/** EPT capabilities. */
913	#define MSR_IA32_VMX_EPT_CAPS 0x48C
914	/** DS Save Area (R/W). */
915	#define MSR_IA32_DS_AREA 0x600
916	/** X2APIC MSR ranges. */
917	#define MSR_IA32_APIC_START 0x800
918	#define MSR_IA32_APIC_END 0x900
919
920	/** K6 EFER - Extended Feature Enable Register. */
921	#define MSR_K6_EFER 0xc0000080
922	/** @todo document EFER */
923	/** Bit 0 - SCE - System call extensions (SYSCALL / SYSRET). (R/W) */
924	#define MSR_K6_EFER_SCE RT_BIT(0)
925	/** Bit 8 - LME - Long mode enabled. (R/W) */
926	#define MSR_K6_EFER_LME RT_BIT(8)
927	/** Bit 10 - LMA - Long mode active. (R) */
928	#define MSR_K6_EFER_LMA RT_BIT(10)
929	/** Bit 11 - NXE - No-Execute Page Protection Enabled. (R/W) */
930	#define MSR_K6_EFER_NXE RT_BIT(11)
931	/** Bit 12 - SVME - Secure VM Extension Enabled. (R/W) */
932	#define MSR_K6_EFER_SVME RT_BIT(12)
933	/** Bit 13 - LMSLE - Long Mode Segment Limit Enable. (R/W?) */
934	#define MSR_K6_EFER_LMSLE RT_BIT(13)
935	/** Bit 14 - FFXSR - Fast FXSAVE / FXRSTOR (skip XMM). (R/W) /
936	#define MSR_K6_EFER_FFXSR RT_BIT(14)
937	/** K6 STAR - SYSCALL/RET targets. */
938	#define MSR_K6_STAR 0xc0000081
939	/** Shift value for getting the SYSRET CS and SS value. */
940	#define MSR_K6_STAR_SYSRET_CS_SS_SHIFT 48
941	/** Shift value for getting the SYSCALL CS and SS value. */
942	#define MSR_K6_STAR_SYSCALL_CS_SS_SHIFT 32
943	/** Selector mask for use after shifting. */
944	#define MSR_K6_STAR_SEL_MASK 0xffff
945	/** The mask which give the SYSCALL EIP. */
946	#define MSR_K6_STAR_SYSCALL_EIP_MASK 0xffffffff
947	/** K6 WHCR - Write Handling Control Register. */
948	#define MSR_K6_WHCR 0xc0000082
949	/** K6 UWCCR - UC/WC Cacheability Control Register. */
950	#define MSR_K6_UWCCR 0xc0000085
951	/** K6 PSOR - Processor State Observability Register. */
952	#define MSR_K6_PSOR 0xc0000087
953	/** K6 PFIR - Page Flush/Invalidate Register. */
954	#define MSR_K6_PFIR 0xc0000088
955
956	/** Performance counter MSRs. (AMD only) */
957	#define MSR_K7_EVNTSEL0 0xc0010000
958	#define MSR_K7_EVNTSEL1 0xc0010001
959	#define MSR_K7_EVNTSEL2 0xc0010002
960	#define MSR_K7_EVNTSEL3 0xc0010003
961	#define MSR_K7_PERFCTR0 0xc0010004
962	#define MSR_K7_PERFCTR1 0xc0010005
963	#define MSR_K7_PERFCTR2 0xc0010006
964	#define MSR_K7_PERFCTR3 0xc0010007
965
966	#define MSR_K8_HWCR 0xc0010015
967
968	/** K8 LSTAR - Long mode SYSCALL target (RIP). */
969	#define MSR_K8_LSTAR 0xc0000082
970	/** K8 CSTAR - Compatibility mode SYSCALL target (RIP). */
971	#define MSR_K8_CSTAR 0xc0000083
972	/** K8 SF_MASK - SYSCALL flag mask. (aka SFMASK) */
973	#define MSR_K8_SF_MASK 0xc0000084
974	/** K8 FS.base - The 64-bit base FS register. */
975	#define MSR_K8_FS_BASE 0xc0000100
976	/** K8 GS.base - The 64-bit base GS register. */
977	#define MSR_K8_GS_BASE 0xc0000101
978	/** K8 KernelGSbase - Used with SWAPGS. */
979	#define MSR_K8_KERNEL_GS_BASE 0xc0000102
980	#define MSR_K8_TSC_AUX 0xc0000103
981	#define MSR_K8_SYSCFG 0xc0010010
982	#define MSR_K8_HWCR 0xc0010015
983	#define MSR_K8_IORRBASE0 0xc0010016
984	#define MSR_K8_IORRMASK0 0xc0010017
985	#define MSR_K8_IORRBASE1 0xc0010018
986	#define MSR_K8_IORRMASK1 0xc0010019
987	#define MSR_K8_TOP_MEM1 0xc001001a
988	#define MSR_K8_TOP_MEM2 0xc001001d
989	#define MSR_K8_VM_CR 0xc0010114
990	#define MSR_K8_VM_CR_SVM_DISABLE RT_BIT(4)
991
992	#define MSR_K8_IGNNE 0xc0010115
993	#define MSR_K8_SMM_CTL 0xc0010116
994	/** SVM - VM_HSAVE_PA - Physical address for saving and restoring
995	* host state during world switch.
996	*/
997	#define MSR_K8_VM_HSAVE_PA 0xc0010117
998
999	/** @} */
1000
1001
1002	/** @name Page Table / Directory / Directory Pointers / L4.
1003	* @{
1004	*/
1005
1006	/** Page table/directory entry as an unsigned integer. */
1007	typedef uint32_t X86PGUINT;
1008	/** Pointer to a page table/directory table entry as an unsigned integer. */
1009	typedef X86PGUINT *PX86PGUINT;
1010	/** Pointer to an const page table/directory table entry as an unsigned integer. */
1011	typedef X86PGUINT const *PCX86PGUINT;
1012
1013	/** Number of entries in a 32-bit PT/PD. */
1014	#define X86_PG_ENTRIES 1024
1015
1016
1017	/** PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1018	typedef uint64_t X86PGPAEUINT;
1019	/** Pointer to a PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1020	typedef X86PGPAEUINT *PX86PGPAEUINT;
1021	/** Pointer to an const PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1022	typedef X86PGPAEUINT const *PCX86PGPAEUINT;
1023
1024	/** Number of entries in a PAE PT/PD. */
1025	#define X86_PG_PAE_ENTRIES 512
1026	/** Number of entries in a PAE PDPT. */
1027	#define X86_PG_PAE_PDPE_ENTRIES 4
1028
1029	/** Number of entries in an AMD64 PT/PD/PDPT/L4/L5. */
1030	#define X86_PG_AMD64_ENTRIES X86_PG_PAE_ENTRIES
1031	/** Number of entries in an AMD64 PDPT.
1032	* Just for complementing X86_PG_PAE_PDPE_ENTRIES, using X86_PG_AMD64_ENTRIES for this is fine too. */
1033	#define X86_PG_AMD64_PDPE_ENTRIES X86_PG_AMD64_ENTRIES
1034
1035	/** The size of a 4KB page. */
1036	#define X86_PAGE_4K_SIZE _4K
1037	/** The page shift of a 4KB page. */
1038	#define X86_PAGE_4K_SHIFT 12
1039	/** The 4KB page offset mask. */
1040	#define X86_PAGE_4K_OFFSET_MASK 0xfff
1041	/** The 4KB page base mask for virtual addresses. */
1042	#define X86_PAGE_4K_BASE_MASK 0xfffffffffffff000ULL
1043	/** The 4KB page base mask for virtual addresses - 32bit version. */
1044	#define X86_PAGE_4K_BASE_MASK_32 0xfffff000U
1045
1046	/** The size of a 2MB page. */
1047	#define X86_PAGE_2M_SIZE _2M
1048	/** The page shift of a 2MB page. */
1049	#define X86_PAGE_2M_SHIFT 21
1050	/** The 2MB page offset mask. */
1051	#define X86_PAGE_2M_OFFSET_MASK 0x001fffff
1052	/** The 2MB page base mask for virtual addresses. */
1053	#define X86_PAGE_2M_BASE_MASK 0xffffffffffe00000ULL
1054	/** The 2MB page base mask for virtual addresses - 32bit version. */
1055	#define X86_PAGE_2M_BASE_MASK_32 0xffe00000U
1056
1057	/** The size of a 4MB page. */
1058	#define X86_PAGE_4M_SIZE _4M
1059	/** The page shift of a 4MB page. */
1060	#define X86_PAGE_4M_SHIFT 22
1061	/** The 4MB page offset mask. */
1062	#define X86_PAGE_4M_OFFSET_MASK 0x003fffff
1063	/** The 4MB page base mask for virtual addresses. */
1064	#define X86_PAGE_4M_BASE_MASK 0xffffffffffc00000ULL
1065	/** The 4MB page base mask for virtual addresses - 32bit version. */
1066	#define X86_PAGE_4M_BASE_MASK_32 0xffc00000U
1067
1068
1069
1070	/** @name Page Table Entry
1071	* @{
1072	*/
1073	/** Bit 0 - P - Present bit. */
1074	#define X86_PTE_BIT_P 0
1075	/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1076	#define X86_PTE_BIT_RW 1
1077	/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1078	#define X86_PTE_BIT_US 2
1079	/** Bit 3 - PWT - Page level write thru bit. */
1080	#define X86_PTE_BIT_PWT 3
1081	/** Bit 4 - PCD - Page level cache disable bit. */
1082	#define X86_PTE_BIT_PCD 4
1083	/** Bit 5 - A - Access bit. */
1084	#define X86_PTE_BIT_A 5
1085	/** Bit 6 - D - Dirty bit. */
1086	#define X86_PTE_BIT_D 6
1087	/** Bit 7 - PAT - Page Attribute Table index bit. Reserved and 0 if not supported. */
1088	#define X86_PTE_BIT_PAT 7
1089	/** Bit 8 - G - Global flag. */
1090	#define X86_PTE_BIT_G 8
1091
1092	/** Bit 0 - P - Present bit mask. */
1093	#define X86_PTE_P RT_BIT(0)
1094	/** Bit 1 - R/W - Read (clear) / Write (set) bit mask. */
1095	#define X86_PTE_RW RT_BIT(1)
1096	/** Bit 2 - U/S - User (set) / Supervisor (clear) bit mask. */
1097	#define X86_PTE_US RT_BIT(2)
1098	/** Bit 3 - PWT - Page level write thru bit mask. */
1099	#define X86_PTE_PWT RT_BIT(3)
1100	/** Bit 4 - PCD - Page level cache disable bit mask. */
1101	#define X86_PTE_PCD RT_BIT(4)
1102	/** Bit 5 - A - Access bit mask. */
1103	#define X86_PTE_A RT_BIT(5)
1104	/** Bit 6 - D - Dirty bit mask. */
1105	#define X86_PTE_D RT_BIT(6)
1106	/** Bit 7 - PAT - Page Attribute Table index bit mask. Reserved and 0 if not supported. */
1107	#define X86_PTE_PAT RT_BIT(7)
1108	/** Bit 8 - G - Global bit mask. */
1109	#define X86_PTE_G RT_BIT(8)
1110
1111	/** Bits 9-11 - - Available for use to system software. */
1112	#define X86_PTE_AVL_MASK (RT_BIT(9) \| RT_BIT(10) \| RT_BIT(11))
1113	/** Bits 12-31 - - Physical Page number of the next level. */
1114	#define X86_PTE_PG_MASK ( 0xfffff000 )
1115
1116	/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1117	#if 1 /* we're using this internally and have to mask of the top 16-bit. / /* @todo this should be safe to ditch now */
1118	#define X86_PTE_PAE_PG_MASK ( 0x0000fffffffff000ULL )
1119	/** @todo Get rid of the above hack; makes code unreadable. */
1120	#define X86_PTE_PAE_PG_MASK_FULL ( 0x000ffffffffff000ULL )
1121	#else
1122	#define X86_PTE_PAE_PG_MASK ( 0x000ffffffffff000ULL )
1123	#endif
1124	/** Bits 63 - NX - PAE/LM - No execution flag. */
1125	#define X86_PTE_PAE_NX RT_BIT_64(63)
1126	/** Bits 62-52 - - PAE - MBZ bits when NX is active. */
1127	#define X86_PTE_PAE_MBZ_MASK_NX UINT64_C(0x7ff0000000000000)
1128	/** Bits 63-52 - - PAE - MBZ bits when no NX. */
1129	#define X86_PTE_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff0000000000000)
1130	/** No bits - - LM - MBZ bits when NX is active. */
1131	#define X86_PTE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000000)
1132	/** Bits 63 - - LM - MBZ bits when no NX. */
1133	#define X86_PTE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000000)
1134
1135	/**
1136	* Page table entry.
1137	*/
1138	typedef struct X86PTEBITS
1139	{
1140	/** Flags whether(=1) or not the page is present. */
1141	unsigned u1Present : 1;
1142	/** Read(=0) / Write(=1) flag. */
1143	unsigned u1Write : 1;
1144	/** User(=1) / Supervisor (=0) flag. */
1145	unsigned u1User : 1;
1146	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
1147	unsigned u1WriteThru : 1;
1148	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1149	unsigned u1CacheDisable : 1;
1150	/** Accessed flag.
1151	* Indicates that the page have been read or written to. */
1152	unsigned u1Accessed : 1;
1153	/** Dirty flag.
1154	* Indicates that the page has been written to. */
1155	unsigned u1Dirty : 1;
1156	/** Reserved / If PAT enabled, bit 2 of the index. */
1157	unsigned u1PAT : 1;
1158	/** Global flag. (Ignored in all but final level.) */
1159	unsigned u1Global : 1;
1160	/** Available for use to system software. */
1161	unsigned u3Available : 3;
1162	/** Physical Page number of the next level. */
1163	unsigned u20PageNo : 20;
1164	} X86PTEBITS;
1165	/** Pointer to a page table entry. */
1166	typedef X86PTEBITS *PX86PTEBITS;
1167	/** Pointer to a const page table entry. */
1168	typedef const X86PTEBITS *PCX86PTEBITS;
1169
1170	/**
1171	* Page table entry.
1172	*/
1173	typedef union X86PTE
1174	{
1175	/** Unsigned integer view */
1176	X86PGUINT u;
1177	/** Bit field view. */
1178	X86PTEBITS n;
1179	/** 32-bit view. */
1180	uint32_t au32[1];
1181	/** 16-bit view. */
1182	uint16_t au16[2];
1183	/** 8-bit view. */
1184	uint8_t au8[4];
1185	} X86PTE;
1186	/** Pointer to a page table entry. */
1187	typedef X86PTE *PX86PTE;
1188	/** Pointer to a const page table entry. */
1189	typedef const X86PTE *PCX86PTE;
1190
1191
1192	/**
1193	* PAE page table entry.
1194	*/
1195	typedef struct X86PTEPAEBITS
1196	{
1197	/** Flags whether(=1) or not the page is present. */
1198	uint32_t u1Present : 1;
1199	/** Read(=0) / Write(=1) flag. */
1200	uint32_t u1Write : 1;
1201	/** User(=1) / Supervisor(=0) flag. */
1202	uint32_t u1User : 1;
1203	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
1204	uint32_t u1WriteThru : 1;
1205	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1206	uint32_t u1CacheDisable : 1;
1207	/** Accessed flag.
1208	* Indicates that the page have been read or written to. */
1209	uint32_t u1Accessed : 1;
1210	/** Dirty flag.
1211	* Indicates that the page has been written to. */
1212	uint32_t u1Dirty : 1;
1213	/** Reserved / If PAT enabled, bit 2 of the index. */
1214	uint32_t u1PAT : 1;
1215	/** Global flag. (Ignored in all but final level.) */
1216	uint32_t u1Global : 1;
1217	/** Available for use to system software. */
1218	uint32_t u3Available : 3;
1219	/** Physical Page number of the next level - Low Part. Don't use this. */
1220	uint32_t u20PageNoLow : 20;
1221	/** Physical Page number of the next level - High Part. Don't use this. */
1222	uint32_t u20PageNoHigh : 20;
1223	/** MBZ bits */
1224	uint32_t u11Reserved : 11;
1225	/** No Execute flag. */
1226	uint32_t u1NoExecute : 1;
1227	} X86PTEPAEBITS;
1228	/** Pointer to a page table entry. */
1229	typedef X86PTEPAEBITS *PX86PTEPAEBITS;
1230	/** Pointer to a page table entry. */
1231	typedef const X86PTEPAEBITS *PCX86PTEPAEBITS;
1232
1233	/**
1234	* PAE Page table entry.
1235	*/
1236	typedef union X86PTEPAE
1237	{
1238	/** Unsigned integer view */
1239	X86PGPAEUINT u;
1240	/** Bit field view. */
1241	X86PTEPAEBITS n;
1242	/** 32-bit view. */
1243	uint32_t au32[2];
1244	/** 16-bit view. */
1245	uint16_t au16[4];
1246	/** 8-bit view. */
1247	uint8_t au8[8];
1248	} X86PTEPAE;
1249	/** Pointer to a PAE page table entry. */
1250	typedef X86PTEPAE *PX86PTEPAE;
1251	/** Pointer to a const PAE page table entry. */
1252	typedef const X86PTEPAE *PCX86PTEPAE;
1253	/** @} */
1254
1255	/**
1256	* Page table.
1257	*/
1258	typedef struct X86PT
1259	{
1260	/** PTE Array. */
1261	X86PTE a[X86_PG_ENTRIES];
1262	} X86PT;
1263	/** Pointer to a page table. */
1264	typedef X86PT *PX86PT;
1265	/** Pointer to a const page table. */
1266	typedef const X86PT *PCX86PT;
1267
1268	/** The page shift to get the PT index. */
1269	#define X86_PT_SHIFT 12
1270	/** The PT index mask (apply to a shifted page address). */
1271	#define X86_PT_MASK 0x3ff
1272
1273
1274	/**
1275	* Page directory.
1276	*/
1277	typedef struct X86PTPAE
1278	{
1279	/** PTE Array. */
1280	X86PTEPAE a[X86_PG_PAE_ENTRIES];
1281	} X86PTPAE;
1282	/** Pointer to a page table. */
1283	typedef X86PTPAE *PX86PTPAE;
1284	/** Pointer to a const page table. */
1285	typedef const X86PTPAE *PCX86PTPAE;
1286
1287	/** The page shift to get the PA PTE index. */
1288	#define X86_PT_PAE_SHIFT 12
1289	/** The PAE PT index mask (apply to a shifted page address). */
1290	#define X86_PT_PAE_MASK 0x1ff
1291
1292
1293	/** @name 4KB Page Directory Entry
1294	* @{
1295	*/
1296	/** Bit 0 - P - Present bit. */
1297	#define X86_PDE_P RT_BIT(0)
1298	/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1299	#define X86_PDE_RW RT_BIT(1)
1300	/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1301	#define X86_PDE_US RT_BIT(2)
1302	/** Bit 3 - PWT - Page level write thru bit. */
1303	#define X86_PDE_PWT RT_BIT(3)
1304	/** Bit 4 - PCD - Page level cache disable bit. */
1305	#define X86_PDE_PCD RT_BIT(4)
1306	/** Bit 5 - A - Access bit. */
1307	#define X86_PDE_A RT_BIT(5)
1308	/** Bit 7 - PS - Page size attribute.
1309	* Clear mean 4KB pages, set means large pages (2/4MB). */
1310	#define X86_PDE_PS RT_BIT(7)
1311	/** Bits 9-11 - - Available for use to system software. */
1312	#define X86_PDE_AVL_MASK (RT_BIT(9) \| RT_BIT(10) \| RT_BIT(11))
1313	/** Bits 12-31 - - Physical Page number of the next level. */
1314	#define X86_PDE_PG_MASK ( 0xfffff000 )
1315
1316	/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1317	#if 1 /* we're using this internally and have to mask of the top 16-bit. */
1318	/* Note: This is kind of dangerous if the guest uses these bits (legally or illegally);
1319	* we partly or that part into shadow page table entries. Will be corrected
1320	* soon.
1321	*/
1322	#define X86_PDE_PAE_PG_MASK ( 0x0000fffffffff000ULL )
1323	#define X86_PDE_PAE_PG_MASK_FULL ( 0x000ffffffffff000ULL )
1324	#else
1325	#define X86_PDE_PAE_PG_MASK ( 0x000ffffffffff000ULL )
1326	#endif
1327	/** Bits 63 - NX - PAE/LM - No execution flag. */
1328	#define X86_PDE_PAE_NX RT_BIT_64(63)
1329	/** Bits 62-52, 7 - - PAE - MBZ bits when NX is active. */
1330	#define X86_PDE_PAE_MBZ_MASK_NX UINT64_C(0x7ff0000000000080)
1331	/** Bits 63-52, 7 - - PAE - MBZ bits when no NX. */
1332	#define X86_PDE_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff0000000000080)
1333	/** Bit 7 - - LM - MBZ bits when NX is active. */
1334	#define X86_PDE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000080)
1335	/** Bits 63, 7 - - LM - MBZ bits when no NX. */
1336	#define X86_PDE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000080)
1337
1338	/**
1339	* Page directory entry.
1340	*/
1341	typedef struct X86PDEBITS
1342	{
1343	/** Flags whether(=1) or not the page is present. */
1344	unsigned u1Present : 1;
1345	/** Read(=0) / Write(=1) flag. */
1346	unsigned u1Write : 1;
1347	/** User(=1) / Supervisor (=0) flag. */
1348	unsigned u1User : 1;
1349	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
1350	unsigned u1WriteThru : 1;
1351	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1352	unsigned u1CacheDisable : 1;
1353	/** Accessed flag.
1354	* Indicates that the page has been read or written to. */
1355	unsigned u1Accessed : 1;
1356	/** Reserved / Ignored (dirty bit). */
1357	unsigned u1Reserved0 : 1;
1358	/** Size bit if PSE is enabled - in any event it's 0. */
1359	unsigned u1Size : 1;
1360	/** Reserved / Ignored (global bit). */
1361	unsigned u1Reserved1 : 1;
1362	/** Available for use to system software. */
1363	unsigned u3Available : 3;
1364	/** Physical Page number of the next level. */
1365	unsigned u20PageNo : 20;
1366	} X86PDEBITS;
1367	/** Pointer to a page directory entry. */
1368	typedef X86PDEBITS *PX86PDEBITS;
1369	/** Pointer to a const page directory entry. */
1370	typedef const X86PDEBITS *PCX86PDEBITS;
1371
1372
1373	/**
1374	* PAE page directory entry.
1375	*/
1376	typedef struct X86PDEPAEBITS
1377	{
1378	/** Flags whether(=1) or not the page is present. */
1379	uint32_t u1Present : 1;
1380	/** Read(=0) / Write(=1) flag. */
1381	uint32_t u1Write : 1;
1382	/** User(=1) / Supervisor (=0) flag. */
1383	uint32_t u1User : 1;
1384	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
1385	uint32_t u1WriteThru : 1;
1386	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1387	uint32_t u1CacheDisable : 1;
1388	/** Accessed flag.
1389	* Indicates that the page has been read or written to. */
1390	uint32_t u1Accessed : 1;
1391	/** Reserved / Ignored (dirty bit). */
1392	uint32_t u1Reserved0 : 1;
1393	/** Size bit if PSE is enabled - in any event it's 0. */
1394	uint32_t u1Size : 1;
1395	/** Reserved / Ignored (global bit). / */
1396	uint32_t u1Reserved1 : 1;
1397	/** Available for use to system software. */
1398	uint32_t u3Available : 3;
1399	/** Physical Page number of the next level - Low Part. Don't use! */
1400	uint32_t u20PageNoLow : 20;
1401	/** Physical Page number of the next level - High Part. Don't use! */
1402	uint32_t u20PageNoHigh : 20;
1403	/** MBZ bits */
1404	uint32_t u11Reserved : 11;
1405	/** No Execute flag. */
1406	uint32_t u1NoExecute : 1;
1407	} X86PDEPAEBITS;
1408	/** Pointer to a page directory entry. */
1409	typedef X86PDEPAEBITS *PX86PDEPAEBITS;
1410	/** Pointer to a const page directory entry. */
1411	typedef const X86PDEPAEBITS *PCX86PDEPAEBITS;
1412
1413	/** @} */
1414
1415
1416	/** @name 2/4MB Page Directory Entry
1417	* @{
1418	*/
1419	/** Bit 0 - P - Present bit. */
1420	#define X86_PDE4M_P RT_BIT(0)
1421	/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1422	#define X86_PDE4M_RW RT_BIT(1)
1423	/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1424	#define X86_PDE4M_US RT_BIT(2)
1425	/** Bit 3 - PWT - Page level write thru bit. */
1426	#define X86_PDE4M_PWT RT_BIT(3)
1427	/** Bit 4 - PCD - Page level cache disable bit. */
1428	#define X86_PDE4M_PCD RT_BIT(4)
1429	/** Bit 5 - A - Access bit. */
1430	#define X86_PDE4M_A RT_BIT(5)
1431	/** Bit 6 - D - Dirty bit. */
1432	#define X86_PDE4M_D RT_BIT(6)
1433	/** Bit 7 - PS - Page size attribute. Clear mean 4KB pages, set means large pages (2/4MB). */
1434	#define X86_PDE4M_PS RT_BIT(7)
1435	/** Bit 8 - G - Global flag. */
1436	#define X86_PDE4M_G RT_BIT(8)
1437	/** Bits 9-11 - AVL - Available for use to system software. */
1438	#define X86_PDE4M_AVL (RT_BIT(9) \| RT_BIT(10) \| RT_BIT(11))
1439	/** Bit 12 - PAT - Page Attribute Table index bit. Reserved and 0 if not supported. */
1440	#define X86_PDE4M_PAT RT_BIT(12)
1441	/** Shift to get from X86_PTE_PAT to X86_PDE4M_PAT. */
1442	#define X86_PDE4M_PAT_SHIFT (12 - 7)
1443	/** Bits 22-31 - - Physical Page number. */
1444	#define X86_PDE4M_PG_MASK ( 0xffc00000 )
1445	/** Bits 20-13 - - Physical Page number high part (32-39 bits). AMD64 hack. */
1446	#define X86_PDE4M_PG_HIGH_MASK ( 0x001fe000 )
1447	/** The number of bits to the high part of the page number. */
1448	#define X86_PDE4M_PG_HIGH_SHIFT 19
1449	/** Bit 21 - - MBZ bits for AMD CPUs, no PSE36. */
1450	#define X86_PDE4M_MBZ_MASK RT_BIT_32(21)
1451
1452	/** Bits 21-51 - - PAE/LM - Physical Page number.
1453	* (Bits 40-51 (long mode) & bits 36-51 (pae legacy) are reserved according to the Intel docs; AMD allows for more.) */
1454	#define X86_PDE2M_PAE_PG_MASK UINT64_C(0x000fffffffe00000)
1455	/** Bits 63 - NX - PAE/LM - No execution flag. */
1456	#define X86_PDE2M_PAE_NX RT_BIT_64(63)
1457	/** Bits 62-52, 20-13 - - PAE - MBZ bits when NX is active. */
1458	#define X86_PDE2M_PAE_MBZ_MASK_NX UINT64_C(0x7ff00000001fe000)
1459	/** Bits 63-52, 20-13 - - PAE - MBZ bits when no NX. */
1460	#define X86_PDE2M_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff00000001fe000)
1461	/** Bits 20-13 - - LM - MBZ bits when NX is active. */
1462	#define X86_PDE2M_LM_MBZ_MASK_NX UINT64_C(0x00000000001fe000)
1463	/** Bits 63, 20-13 - - LM - MBZ bits when no NX. */
1464	#define X86_PDE2M_LM_MBZ_MASK_NO_NX UINT64_C(0x80000000001fe000)
1465
1466	/**
1467	* 4MB page directory entry.
1468	*/
1469	typedef struct X86PDE4MBITS
1470	{
1471	/** Flags whether(=1) or not the page is present. */
1472	unsigned u1Present : 1;
1473	/** Read(=0) / Write(=1) flag. */
1474	unsigned u1Write : 1;
1475	/** User(=1) / Supervisor (=0) flag. */
1476	unsigned u1User : 1;
1477	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
1478	unsigned u1WriteThru : 1;
1479	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1480	unsigned u1CacheDisable : 1;
1481	/** Accessed flag.
1482	* Indicates that the page have been read or written to. */
1483	unsigned u1Accessed : 1;
1484	/** Dirty flag.
1485	* Indicates that the page has been written to. */
1486	unsigned u1Dirty : 1;
1487	/** Page size flag - always 1 for 4MB entries. */
1488	unsigned u1Size : 1;
1489	/** Global flag. */
1490	unsigned u1Global : 1;
1491	/** Available for use to system software. */
1492	unsigned u3Available : 3;
1493	/** Reserved / If PAT enabled, bit 2 of the index. */
1494	unsigned u1PAT : 1;
1495	/** Bits 32-39 of the page number on AMD64.
1496	* This AMD64 hack allows accessing 40bits of physical memory without PAE. */
1497	unsigned u8PageNoHigh : 8;
1498	/** Reserved. */
1499	unsigned u1Reserved : 1;
1500	/** Physical Page number of the page. */
1501	unsigned u10PageNo : 10;
1502	} X86PDE4MBITS;
1503	/** Pointer to a page table entry. */
1504	typedef X86PDE4MBITS *PX86PDE4MBITS;
1505	/** Pointer to a const page table entry. */
1506	typedef const X86PDE4MBITS *PCX86PDE4MBITS;
1507
1508
1509	/**
1510	* 2MB PAE page directory entry.
1511	*/
1512	typedef struct X86PDE2MPAEBITS
1513	{
1514	/** Flags whether(=1) or not the page is present. */
1515	uint32_t u1Present : 1;
1516	/** Read(=0) / Write(=1) flag. */
1517	uint32_t u1Write : 1;
1518	/** User(=1) / Supervisor(=0) flag. */
1519	uint32_t u1User : 1;
1520	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
1521	uint32_t u1WriteThru : 1;
1522	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1523	uint32_t u1CacheDisable : 1;
1524	/** Accessed flag.
1525	* Indicates that the page have been read or written to. */
1526	uint32_t u1Accessed : 1;
1527	/** Dirty flag.
1528	* Indicates that the page has been written to. */
1529	uint32_t u1Dirty : 1;
1530	/** Page size flag - always 1 for 2MB entries. */
1531	uint32_t u1Size : 1;
1532	/** Global flag. */
1533	uint32_t u1Global : 1;
1534	/** Available for use to system software. */
1535	uint32_t u3Available : 3;
1536	/** Reserved / If PAT enabled, bit 2 of the index. */
1537	uint32_t u1PAT : 1;
1538	/** Reserved. */
1539	uint32_t u9Reserved : 9;
1540	/** Physical Page number of the next level - Low part. Don't use! */
1541	uint32_t u10PageNoLow : 10;
1542	/** Physical Page number of the next level - High part. Don't use! */
1543	uint32_t u20PageNoHigh : 20;
1544	/** MBZ bits */
1545	uint32_t u11Reserved : 11;
1546	/** No Execute flag. */
1547	uint32_t u1NoExecute : 1;
1548	} X86PDE2MPAEBITS;
1549	/** Pointer to a 2MB PAE page table entry. */
1550	typedef X86PDE2MPAEBITS *PX86PDE2MPAEBITS;
1551	/** Pointer to a 2MB PAE page table entry. */
1552	typedef const X86PDE2MPAEBITS *PCX86PDE2MPAEBITS;
1553
1554	/** @} */
1555
1556	/**
1557	* Page directory entry.
1558	*/
1559	typedef union X86PDE
1560	{
1561	/** Unsigned integer view. */
1562	X86PGUINT u;
1563	/** Normal view. */
1564	X86PDEBITS n;
1565	/** 4MB view (big). */
1566	X86PDE4MBITS b;
1567	/** 8 bit unsigned integer view. */
1568	uint8_t au8[4];
1569	/** 16 bit unsigned integer view. */
1570	uint16_t au16[2];
1571	/** 32 bit unsigned integer view. */
1572	uint32_t au32[1];
1573	} X86PDE;
1574	/** Pointer to a page directory entry. */
1575	typedef X86PDE *PX86PDE;
1576	/** Pointer to a const page directory entry. */
1577	typedef const X86PDE *PCX86PDE;
1578
1579	/**
1580	* PAE page directory entry.
1581	*/
1582	typedef union X86PDEPAE
1583	{
1584	/** Unsigned integer view. */
1585	X86PGPAEUINT u;
1586	/** Normal view. */
1587	X86PDEPAEBITS n;
1588	/** 2MB page view (big). */
1589	X86PDE2MPAEBITS b;
1590	/** 8 bit unsigned integer view. */
1591	uint8_t au8[8];
1592	/** 16 bit unsigned integer view. */
1593	uint16_t au16[4];
1594	/** 32 bit unsigned integer view. */
1595	uint32_t au32[2];
1596	} X86PDEPAE;
1597	/** Pointer to a page directory entry. */
1598	typedef X86PDEPAE *PX86PDEPAE;
1599	/** Pointer to a const page directory entry. */
1600	typedef const X86PDEPAE *PCX86PDEPAE;
1601
1602	/**
1603	* Page directory.
1604	*/
1605	typedef struct X86PD
1606	{
1607	/** PDE Array. */
1608	X86PDE a[X86_PG_ENTRIES];
1609	} X86PD;
1610	/** Pointer to a page directory. */
1611	typedef X86PD *PX86PD;
1612	/** Pointer to a const page directory. */
1613	typedef const X86PD *PCX86PD;
1614
1615	/** The page shift to get the PD index. */
1616	#define X86_PD_SHIFT 22
1617	/** The PD index mask (apply to a shifted page address). */
1618	#define X86_PD_MASK 0x3ff
1619
1620
1621	/**
1622	* PAE page directory.
1623	*/
1624	typedef struct X86PDPAE
1625	{
1626	/** PDE Array. */
1627	X86PDEPAE a[X86_PG_PAE_ENTRIES];
1628	} X86PDPAE;
1629	/** Pointer to a PAE page directory. */
1630	typedef X86PDPAE *PX86PDPAE;
1631	/** Pointer to a const PAE page directory. */
1632	typedef const X86PDPAE *PCX86PDPAE;
1633
1634	/** The page shift to get the PAE PD index. */
1635	#define X86_PD_PAE_SHIFT 21
1636	/** The PAE PD index mask (apply to a shifted page address). */
1637	#define X86_PD_PAE_MASK 0x1ff
1638
1639
1640	/** @name Page Directory Pointer Table Entry (PAE)
1641	* @{
1642	*/
1643	/** Bit 0 - P - Present bit. */
1644	#define X86_PDPE_P RT_BIT(0)
1645	/** Bit 1 - R/W - Read (clear) / Write (set) bit. Long Mode only. */
1646	#define X86_PDPE_RW RT_BIT(1)
1647	/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. Long Mode only. */
1648	#define X86_PDPE_US RT_BIT(2)
1649	/** Bit 3 - PWT - Page level write thru bit. */
1650	#define X86_PDPE_PWT RT_BIT(3)
1651	/** Bit 4 - PCD - Page level cache disable bit. */
1652	#define X86_PDPE_PCD RT_BIT(4)
1653	/** Bit 5 - A - Access bit. Long Mode only. */
1654	#define X86_PDPE_A RT_BIT(5)
1655	/** Bit 7 - PS - Page size (1GB). Long Mode only. */
1656	#define X86_PDPE_LM_PS RT_BIT(7)
1657	/** Bits 9-11 - - Available for use to system software. */
1658	#define X86_PDPE_AVL_MASK (RT_BIT(9) \| RT_BIT(10) \| RT_BIT(11))
1659	/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1660	#if 1 /* we're using this internally and have to mask of the top 16-bit. */
1661	#define X86_PDPE_PG_MASK UINT64_C(0x0000fffffffff000)
1662	/** @todo Get rid of the above hack; makes code unreadable. */
1663	#define X86_PDPE_PG_MASK_FULL UINT64_C(0x000ffffffffff000)
1664	#else
1665	#define X86_PDPE_PG_MASK UINT64_C(0x000ffffffffff000)
1666	#endif
1667	/** Bits 63-52, 8-5, 2-1 - - PAE - MBZ bits (NX is long mode only). */
1668	#define X86_PDPE_PAE_MBZ_MASK UINT64_C(0xfff00000000001e6)
1669	/** Bits 63 - NX - LM - No execution flag. Long Mode only. */
1670	#define X86_PDPE_LM_NX RT_BIT_64(63)
1671	/** Bits 8, 7 - - LM - MBZ bits when NX is active. */
1672	#define X86_PDPE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000180)
1673	/** Bits 63, 8, 7 - - LM - MBZ bits when no NX. */
1674	#define X86_PDPE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000180)
1675	/** Bits 29-13 - - LM - MBZ bits for 1GB page entry when NX is active. */
1676	#define X86_PDPE1G_LM_MBZ_MASK_NX UINT64_C(0x000000003fffe000)
1677	/** Bits 63, 29-13 - - LM - MBZ bits for 1GB page entry when no NX. */
1678	#define X86_PDPE1G_LM_MBZ_MASK_NO_NX UINT64_C(0x800000003fffe000)
1679
1680
1681	/**
1682	* Page directory pointer table entry.
1683	*/
1684	typedef struct X86PDPEBITS
1685	{
1686	/** Flags whether(=1) or not the page is present. */
1687	uint32_t u1Present : 1;
1688	/** Chunk of reserved bits. */
1689	uint32_t u2Reserved : 2;
1690	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
1691	uint32_t u1WriteThru : 1;
1692	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1693	uint32_t u1CacheDisable : 1;
1694	/** Chunk of reserved bits. */
1695	uint32_t u4Reserved : 4;
1696	/** Available for use to system software. */
1697	uint32_t u3Available : 3;
1698	/** Physical Page number of the next level - Low Part. Don't use! */
1699	uint32_t u20PageNoLow : 20;
1700	/** Physical Page number of the next level - High Part. Don't use! */
1701	uint32_t u20PageNoHigh : 20;
1702	/** MBZ bits */
1703	uint32_t u12Reserved : 12;
1704	} X86PDPEBITS;
1705	/** Pointer to a page directory pointer table entry. */
1706	typedef X86PDPEBITS *PX86PTPEBITS;
1707	/** Pointer to a const page directory pointer table entry. */
1708	typedef const X86PDPEBITS *PCX86PTPEBITS;
1709
1710	/**
1711	* Page directory pointer table entry. AMD64 version
1712	*/
1713	typedef struct X86PDPEAMD64BITS
1714	{
1715	/** Flags whether(=1) or not the page is present. */
1716	uint32_t u1Present : 1;
1717	/** Read(=0) / Write(=1) flag. */
1718	uint32_t u1Write : 1;
1719	/** User(=1) / Supervisor (=0) flag. */
1720	uint32_t u1User : 1;
1721	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
1722	uint32_t u1WriteThru : 1;
1723	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1724	uint32_t u1CacheDisable : 1;
1725	/** Accessed flag.
1726	* Indicates that the page have been read or written to. */
1727	uint32_t u1Accessed : 1;
1728	/** Chunk of reserved bits. */
1729	uint32_t u3Reserved : 3;
1730	/** Available for use to system software. */
1731	uint32_t u3Available : 3;
1732	/** Physical Page number of the next level - Low Part. Don't use! */
1733	uint32_t u20PageNoLow : 20;
1734	/** Physical Page number of the next level - High Part. Don't use! */
1735	uint32_t u20PageNoHigh : 20;
1736	/** MBZ bits */
1737	uint32_t u11Reserved : 11;
1738	/** No Execute flag. */
1739	uint32_t u1NoExecute : 1;
1740	} X86PDPEAMD64BITS;
1741	/** Pointer to a page directory pointer table entry. */
1742	typedef X86PDPEAMD64BITS *PX86PDPEAMD64BITS;
1743	/** Pointer to a const page directory pointer table entry. */
1744	typedef const X86PDPEBITS *PCX86PDPEAMD64BITS;
1745
1746	/**
1747	* Page directory pointer table entry.
1748	*/
1749	typedef union X86PDPE
1750	{
1751	/** Unsigned integer view. */
1752	X86PGPAEUINT u;
1753	/** Normal view. */
1754	X86PDPEBITS n;
1755	/** AMD64 view. */
1756	X86PDPEAMD64BITS lm;
1757	/** 8 bit unsigned integer view. */
1758	uint8_t au8[8];
1759	/** 16 bit unsigned integer view. */
1760	uint16_t au16[4];
1761	/** 32 bit unsigned integer view. */
1762	uint32_t au32[2];
1763	} X86PDPE;
1764	/** Pointer to a page directory pointer table entry. */
1765	typedef X86PDPE *PX86PDPE;
1766	/** Pointer to a const page directory pointer table entry. */
1767	typedef const X86PDPE *PCX86PDPE;
1768
1769
1770	/**
1771	* Page directory pointer table.
1772	*/
1773	typedef struct X86PDPT
1774	{
1775	/** PDE Array. */
1776	X86PDPE a[X86_PG_AMD64_PDPE_ENTRIES];
1777	} X86PDPT;
1778	/** Pointer to a page directory pointer table. */
1779	typedef X86PDPT *PX86PDPT;
1780	/** Pointer to a const page directory pointer table. */
1781	typedef const X86PDPT *PCX86PDPT;
1782
1783	/** The page shift to get the PDPT index. */
1784	#define X86_PDPT_SHIFT 30
1785	/** The PDPT index mask (apply to a shifted page address). (32 bits PAE) */
1786	#define X86_PDPT_MASK_PAE 0x3
1787	/** The PDPT index mask (apply to a shifted page address). (64 bits PAE)*/
1788	#define X86_PDPT_MASK_AMD64 0x1ff
1789
1790	/** @} */
1791
1792
1793	/** @name Page Map Level-4 Entry (Long Mode PAE)
1794	* @{
1795	*/
1796	/** Bit 0 - P - Present bit. */
1797	#define X86_PML4E_P RT_BIT(0)
1798	/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1799	#define X86_PML4E_RW RT_BIT(1)
1800	/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1801	#define X86_PML4E_US RT_BIT(2)
1802	/** Bit 3 - PWT - Page level write thru bit. */
1803	#define X86_PML4E_PWT RT_BIT(3)
1804	/** Bit 4 - PCD - Page level cache disable bit. */
1805	#define X86_PML4E_PCD RT_BIT(4)
1806	/** Bit 5 - A - Access bit. */
1807	#define X86_PML4E_A RT_BIT(5)
1808	/** Bits 9-11 - - Available for use to system software. */
1809	#define X86_PML4E_AVL_MASK (RT_BIT(9) \| RT_BIT(10) \| RT_BIT(11))
1810	/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1811	#if 1 /* we're using this internally and have to mask of the top 16-bit. */
1812	#define X86_PML4E_PG_MASK ( 0x0000fffffffff000ULL )
1813	#define X86_PML4E_PG_MASK_FULL ( 0x000ffffffffff000ULL )
1814	#else
1815	#define X86_PML4E_PG_MASK ( 0x000ffffffffff000ULL )
1816	#endif
1817	/** Bits 8, 7 - - MBZ bits when NX is active. */
1818	#define X86_PML4E_MBZ_MASK_NX UINT64_C(0x0000000000000080)
1819	/** Bits 63, 7 - - MBZ bits when no NX. */
1820	#define X86_PML4E_MBZ_MASK_NO_NX UINT64_C(0x8000000000000080)
1821	/** Bits 63 - NX - PAE - No execution flag. */
1822	#define X86_PML4E_NX RT_BIT_64(63)
1823
1824	/**
1825	* Page Map Level-4 Entry
1826	*/
1827	typedef struct X86PML4EBITS
1828	{
1829	/** Flags whether(=1) or not the page is present. */
1830	uint32_t u1Present : 1;
1831	/** Read(=0) / Write(=1) flag. */
1832	uint32_t u1Write : 1;
1833	/** User(=1) / Supervisor (=0) flag. */
1834	uint32_t u1User : 1;
1835	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
1836	uint32_t u1WriteThru : 1;
1837	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1838	uint32_t u1CacheDisable : 1;
1839	/** Accessed flag.
1840	* Indicates that the page have been read or written to. */
1841	uint32_t u1Accessed : 1;
1842	/** Chunk of reserved bits. */
1843	uint32_t u3Reserved : 3;
1844	/** Available for use to system software. */
1845	uint32_t u3Available : 3;
1846	/** Physical Page number of the next level - Low Part. Don't use! */
1847	uint32_t u20PageNoLow : 20;
1848	/** Physical Page number of the next level - High Part. Don't use! */
1849	uint32_t u20PageNoHigh : 20;
1850	/** MBZ bits */
1851	uint32_t u11Reserved : 11;
1852	/** No Execute flag. */
1853	uint32_t u1NoExecute : 1;
1854	} X86PML4EBITS;
1855	/** Pointer to a page map level-4 entry. */
1856	typedef X86PML4EBITS *PX86PML4EBITS;
1857	/** Pointer to a const page map level-4 entry. */
1858	typedef const X86PML4EBITS *PCX86PML4EBITS;
1859
1860	/**
1861	* Page Map Level-4 Entry.
1862	*/
1863	typedef union X86PML4E
1864	{
1865	/** Unsigned integer view. */
1866	X86PGPAEUINT u;
1867	/** Normal view. */
1868	X86PML4EBITS n;
1869	/** 8 bit unsigned integer view. */
1870	uint8_t au8[8];
1871	/** 16 bit unsigned integer view. */
1872	uint16_t au16[4];
1873	/** 32 bit unsigned integer view. */
1874	uint32_t au32[2];
1875	} X86PML4E;
1876	/** Pointer to a page map level-4 entry. */
1877	typedef X86PML4E *PX86PML4E;
1878	/** Pointer to a const page map level-4 entry. */
1879	typedef const X86PML4E *PCX86PML4E;
1880
1881
1882	/**
1883	* Page Map Level-4.
1884	*/
1885	typedef struct X86PML4
1886	{
1887	/** PDE Array. */
1888	X86PML4E a[X86_PG_PAE_ENTRIES];
1889	} X86PML4;
1890	/** Pointer to a page map level-4. */
1891	typedef X86PML4 *PX86PML4;
1892	/** Pointer to a const page map level-4. */
1893	typedef const X86PML4 *PCX86PML4;
1894
1895	/** The page shift to get the PML4 index. */
1896	#define X86_PML4_SHIFT 39
1897	/** The PML4 index mask (apply to a shifted page address). */
1898	#define X86_PML4_MASK 0x1ff
1899
1900	/** @} */
1901
1902	/** @} */
1903
1904
1905	/**
1906	* 80-bit MMX/FPU register type.
1907	*/
1908	typedef struct X86FPUMMX
1909	{
1910	uint8_t reg[10];
1911	} X86FPUMMX;
1912	/** Pointer to a 80-bit MMX/FPU register type. */
1913	typedef X86FPUMMX *PX86FPUMMX;
1914	/** Pointer to a const 80-bit MMX/FPU register type. */
1915	typedef const X86FPUMMX *PCX86FPUMMX;
1916
1917	/**
1918	* FPU state (aka FSAVE/FRSTOR Memory Region).
1919	*/
1920	#pragma pack(1)
1921	typedef struct X86FPUSTATE
1922	{
1923	/** Control word. */
1924	uint16_t FCW;
1925	/** Alignment word */
1926	uint16_t Dummy1;
1927	/** Status word. */
1928	uint16_t FSW;
1929	/** Alignment word */
1930	uint16_t Dummy2;
1931	/** Tag word */
1932	uint16_t FTW;
1933	/** Alignment word */
1934	uint16_t Dummy3;
1935
1936	/** Instruction pointer. */
1937	uint32_t FPUIP;
1938	/** Code selector. */
1939	uint16_t CS;
1940	/** Opcode. */
1941	uint16_t FOP;
1942	/** FOO. */
1943	uint32_t FPUOO;
1944	/** FOS. */
1945	uint32_t FPUOS;
1946	/** FPU view - todo. */
1947	X86FPUMMX regs[8];
1948	} X86FPUSTATE;
1949	#pragma pack()
1950	/** Pointer to a FPU state. */
1951	typedef X86FPUSTATE *PX86FPUSTATE;
1952	/** Pointer to a const FPU state. */
1953	typedef const X86FPUSTATE *PCX86FPUSTATE;
1954
1955	/**
1956	* FPU Extended state (aka FXSAVE/FXRSTORE Memory Region).
1957	*/
1958	#pragma pack(1)
1959	typedef struct X86FXSTATE
1960	{
1961	/** Control word. */
1962	uint16_t FCW;
1963	/** Status word. */
1964	uint16_t FSW;
1965	/** Tag word. (The upper byte is always zero.) */
1966	uint16_t FTW;
1967	/** Opcode. */
1968	uint16_t FOP;
1969	/** Instruction pointer. */
1970	uint32_t FPUIP;
1971	/** Code selector. */
1972	uint16_t CS;
1973	uint16_t Rsvrd1;
1974	/* - offset 16 - */
1975	/** Data pointer. */
1976	uint32_t FPUDP;
1977	/** Data segment */
1978	uint16_t DS;
1979	uint16_t Rsrvd2;
1980	uint32_t MXCSR;
1981	uint32_t MXCSR_MASK;
1982	/* - offset 32 - */
1983	union
1984	{
1985	/** MMX view. */
1986	uint64_t mmx;
1987	/** FPU view - todo. */
1988	X86FPUMMX fpu;
1989	/** 8-bit view. */
1990	uint8_t au8[16];
1991	/** 16-bit view. */
1992	uint16_t au16[8];
1993	/** 32-bit view. */
1994	uint32_t au32[4];
1995	/** 64-bit view. */
1996	uint64_t au64[2];
1997	/** 128-bit view. (yeah, very helpful) */
1998	uint128_t au128[1];
1999	} aRegs[8];
2000	/* - offset 160 - */
2001	union
2002	{
2003	/** XMM Register view . /
2004	uint128_t xmm;
2005	/** 8-bit view. */
2006	uint8_t au8[16];
2007	/** 16-bit view. */
2008	uint16_t au16[8];
2009	/** 32-bit view. */
2010	uint32_t au32[4];
2011	/** 64-bit view. */
2012	uint64_t au64[2];
2013	/** 128-bit view. (yeah, very helpful) */
2014	uint128_t au128[1];
2015	} aXMM[16]; /* 8 registers in 32 bits mode; 16 in long mode */
2016	/* - offset 416 - */
2017	uint32_t au32RsrvdRest[(512 - 416) / sizeof(uint32_t)];
2018	} X86FXSTATE;
2019	#pragma pack()
2020	/** Pointer to a FPU Extended state. */
2021	typedef X86FXSTATE *PX86FXSTATE;
2022	/** Pointer to a const FPU Extended state. */
2023	typedef const X86FXSTATE *PCX86FXSTATE;
2024
2025
2026	/** @name Selector Descriptor
2027	* @{
2028	*/
2029
2030	/**
2031	* Descriptor attributes.
2032	*/
2033	typedef struct X86DESCATTRBITS
2034	{
2035	/** 00 - Segment Type. */
2036	unsigned u4Type : 4;
2037	/** 04 - Descriptor Type. System(=0) or code/data selector */
2038	unsigned u1DescType : 1;
2039	/** 05 - Descriptor Privelege level. */
2040	unsigned u2Dpl : 2;
2041	/** 07 - Flags selector present(=1) or not. */
2042	unsigned u1Present : 1;
2043	/** 08 - Segment limit 16-19. */
2044	unsigned u4LimitHigh : 4;
2045	/** 0c - Available for system software. */
2046	unsigned u1Available : 1;
2047	/** 0d - 32 bits mode: Reserved - 0, long mode: Long Attribute Bit. */
2048	unsigned u1Long : 1;
2049	/** 0e - This flags meaning depends on the segment type. Try make sense out
2050	* of the intel manual yourself. */
2051	unsigned u1DefBig : 1;
2052	/** 0f - Granularity of the limit. If set 4KB granularity is used, if
2053	* clear byte. */
2054	unsigned u1Granularity : 1;
2055	} X86DESCATTRBITS;
2056
2057
2058	#pragma pack(1)
2059	typedef union X86DESCATTR
2060	{
2061	/** Unsigned integer view. */
2062	uint32_t u;
2063	/** Normal view. */
2064	X86DESCATTRBITS n;
2065	} X86DESCATTR;
2066	#pragma pack()
2067	/** Pointer to descriptor attributes. */
2068	typedef X86DESCATTR *PX86DESCATTR;
2069	/** Pointer to const descriptor attributes. */
2070	typedef const X86DESCATTR *PCX86DESCATTR;
2071
2072
2073	/**
2074	* Generic descriptor table entry
2075	*/
2076	#pragma pack(1)
2077	typedef struct X86DESCGENERIC
2078	{
2079	/** Limit - Low word. */
2080	unsigned u16LimitLow : 16;
2081	/** Base address - lowe word.
2082	* Don't try set this to 24 because MSC is doing stupid things then. */
2083	unsigned u16BaseLow : 16;
2084	/** Base address - first 8 bits of high word. */
2085	unsigned u8BaseHigh1 : 8;
2086	/** Segment Type. */
2087	unsigned u4Type : 4;
2088	/** Descriptor Type. System(=0) or code/data selector */
2089	unsigned u1DescType : 1;
2090	/** Descriptor Privelege level. */
2091	unsigned u2Dpl : 2;
2092	/** Flags selector present(=1) or not. */
2093	unsigned u1Present : 1;
2094	/** Segment limit 16-19. */
2095	unsigned u4LimitHigh : 4;
2096	/** Available for system software. */
2097	unsigned u1Available : 1;
2098	/** 32 bits mode: Reserved - 0, long mode: Long Attribute Bit. */
2099	unsigned u1Long : 1;
2100	/** This flags meaning depends on the segment type. Try make sense out
2101	* of the intel manual yourself. */
2102	unsigned u1DefBig : 1;
2103	/** Granularity of the limit. If set 4KB granularity is used, if
2104	* clear byte. */
2105	unsigned u1Granularity : 1;
2106	/** Base address - highest 8 bits. */
2107	unsigned u8BaseHigh2 : 8;
2108	} X86DESCGENERIC;
2109	#pragma pack()
2110	/** Pointer to a generic descriptor entry. */
2111	typedef X86DESCGENERIC *PX86DESCGENERIC;
2112	/** Pointer to a const generic descriptor entry. */
2113	typedef const X86DESCGENERIC *PCX86DESCGENERIC;
2114
2115	/**
2116	* Call-, Interrupt-, Trap- or Task-gate descriptor (legacy).
2117	*/
2118	typedef struct X86DESCGATE
2119	{
2120	/** 00 - Target code segment offset - Low word.
2121	* Ignored if task-gate. */
2122	unsigned u16OffsetLow : 16;
2123	/** 10 - Target code segment selector for call-, interrupt- and trap-gates,
2124	* TSS selector if task-gate. */
2125	unsigned u16Sel : 16;
2126	/** 20 - Number of parameters for a call-gate.
2127	* Ignored if interrupt-, trap- or task-gate. */
2128	unsigned u4ParmCount : 4;
2129	/** 24 - Reserved / ignored. */
2130	unsigned u4Reserved : 4;
2131	/** 28 - Segment Type. */
2132	unsigned u4Type : 4;
2133	/** 2c - Descriptor Type (0 = system). */
2134	unsigned u1DescType : 1;
2135	/** 2d - Descriptor Privelege level. */
2136	unsigned u2Dpl : 2;
2137	/** 2f - Flags selector present(=1) or not. */
2138	unsigned u1Present : 1;
2139	/** 30 - Target code segment offset - High word.
2140	* Ignored if task-gate. */
2141	unsigned u16OffsetHigh : 16;
2142	} X86DESCGATE;
2143	AssertCompileSize(X86DESCGATE, 8);
2144	/** Pointer to a Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
2145	typedef X86DESCGATE *PX86DESCGATE;
2146	/** Pointer to a const Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
2147	typedef const X86DESCGATE *PCX86DESCGATE;
2148
2149	/**
2150	* Descriptor table entry.
2151	*/
2152	#pragma pack(1)
2153	typedef union X86DESC
2154	{
2155	/** Generic descriptor view. */
2156	X86DESCGENERIC Gen;
2157	/** Gate descriptor view. */
2158	X86DESCGATE Gate;
2159
2160	/** 8 bit unsigned interger view. */
2161	uint8_t au8[8];
2162	/** 16 bit unsigned interger view. */
2163	uint16_t au16[4];
2164	/** 32 bit unsigned interger view. */
2165	uint32_t au32[2];
2166	} X86DESC;
2167	AssertCompileSize(X86DESC, 8);
2168	#pragma pack()
2169	/** Pointer to descriptor table entry. */
2170	typedef X86DESC *PX86DESC;
2171	/** Pointer to const descriptor table entry. */
2172	typedef const X86DESC *PCX86DESC;
2173
2174	/** @def X86DESC_BASE
2175	* Return the base address of a descriptor.
2176	*/
2177	#define X86DESC_BASE(desc) /ASM-NOINC/ \
2178	( ((uint32_t)((desc).Gen.u8BaseHigh2) << 24) \
2179	\| ( (desc).Gen.u8BaseHigh1 << 16) \
2180	\| ( (desc).Gen.u16BaseLow ) )
2181
2182	/** @def X86DESC_LIMIT
2183	* Return the limit of a descriptor.
2184	*/
2185	#define X86DESC_LIMIT(desc) /ASM-NOINC/ \
2186	( ((uint32_t)((desc).Gen.u4LimitHigh) << 16) \
2187	\| ( (desc).Gen.u16LimitLow ) )
2188
2189	/**
2190	* 64 bits generic descriptor table entry
2191	* Note: most of these bits have no meaning in long mode.
2192	*/
2193	#pragma pack(1)
2194	typedef struct X86DESC64GENERIC
2195	{
2196	/** Limit - Low word - IGNORED. */
2197	unsigned u16LimitLow : 16;
2198	/** Base address - lowe word. - IGNORED
2199	* Don't try set this to 24 because MSC is doing stupid things then. */
2200	unsigned u16BaseLow : 16;
2201	/** Base address - first 8 bits of high word. - IGNORED */
2202	unsigned u8BaseHigh1 : 8;
2203	/** Segment Type. */
2204	unsigned u4Type : 4;
2205	/** Descriptor Type. System(=0) or code/data selector */
2206	unsigned u1DescType : 1;
2207	/** Descriptor Privelege level. */
2208	unsigned u2Dpl : 2;
2209	/** Flags selector present(=1) or not. */
2210	unsigned u1Present : 1;
2211	/** Segment limit 16-19. - IGNORED */
2212	unsigned u4LimitHigh : 4;
2213	/** Available for system software. - IGNORED */
2214	unsigned u1Available : 1;
2215	/** Long mode flag. */
2216	unsigned u1Long : 1;
2217	/** This flags meaning depends on the segment type. Try make sense out
2218	* of the intel manual yourself. */
2219	unsigned u1DefBig : 1;
2220	/** Granularity of the limit. If set 4KB granularity is used, if
2221	* clear byte. - IGNORED */
2222	unsigned u1Granularity : 1;
2223	/** Base address - highest 8 bits. - IGNORED */
2224	unsigned u8BaseHigh2 : 8;
2225	/** Base address - bits 63-32. */
2226	unsigned u32BaseHigh3 : 32;
2227	unsigned u8Reserved : 8;
2228	unsigned u5Zeros : 5;
2229	unsigned u19Reserved : 19;
2230	} X86DESC64GENERIC;
2231	#pragma pack()
2232	/** Pointer to a generic descriptor entry. */
2233	typedef X86DESC64GENERIC *PX86DESC64GENERIC;
2234	/** Pointer to a const generic descriptor entry. */
2235	typedef const X86DESC64GENERIC *PCX86DESC64GENERIC;
2236
2237	/**
2238	* System descriptor table entry (64 bits)
2239	*
2240	* @remarks This is, save a couple of comments, identical to X86DESC64GENERIC...
2241	*/
2242	#pragma pack(1)
2243	typedef struct X86DESC64SYSTEM
2244	{
2245	/** Limit - Low word. */
2246	unsigned u16LimitLow : 16;
2247	/** Base address - lowe word.
2248	* Don't try set this to 24 because MSC is doing stupid things then. */
2249	unsigned u16BaseLow : 16;
2250	/** Base address - first 8 bits of high word. */
2251	unsigned u8BaseHigh1 : 8;
2252	/** Segment Type. */
2253	unsigned u4Type : 4;
2254	/** Descriptor Type. System(=0) or code/data selector */
2255	unsigned u1DescType : 1;
2256	/** Descriptor Privelege level. */
2257	unsigned u2Dpl : 2;
2258	/** Flags selector present(=1) or not. */
2259	unsigned u1Present : 1;
2260	/** Segment limit 16-19. */
2261	unsigned u4LimitHigh : 4;
2262	/** Available for system software. */
2263	unsigned u1Available : 1;
2264	/** Reserved - 0. */
2265	unsigned u1Reserved : 1;
2266	/** This flags meaning depends on the segment type. Try make sense out
2267	* of the intel manual yourself. */
2268	unsigned u1DefBig : 1;
2269	/** Granularity of the limit. If set 4KB granularity is used, if
2270	* clear byte. */
2271	unsigned u1Granularity : 1;
2272	/** Base address - bits 31-24. */
2273	unsigned u8BaseHigh2 : 8;
2274	/** Base address - bits 63-32. */
2275	unsigned u32BaseHigh3 : 32;
2276	unsigned u8Reserved : 8;
2277	unsigned u5Zeros : 5;
2278	unsigned u19Reserved : 19;
2279	} X86DESC64SYSTEM;
2280	#pragma pack()
2281	/** Pointer to a system descriptor entry. */
2282	typedef X86DESC64SYSTEM *PX86DESC64SYSTEM;
2283	/** Pointer to a const system descriptor entry. */
2284	typedef const X86DESC64SYSTEM *PCX86DESC64SYSTEM;
2285
2286	/**
2287	* Call-, Interrupt-, Trap- or Task-gate descriptor (64-bit).
2288	*/
2289	typedef struct X86DESC64GATE
2290	{
2291	/** Target code segment offset - Low word. */
2292	unsigned u16OffsetLow : 16;
2293	/** Target code segment selector. */
2294	unsigned u16Sel : 16;
2295	/** Interrupt stack table for interrupt- and trap-gates.
2296	* Ignored by call-gates. */
2297	unsigned u3IST : 3;
2298	/** Reserved / ignored. */
2299	unsigned u5Reserved : 5;
2300	/** Segment Type. */
2301	unsigned u4Type : 4;
2302	/** Descriptor Type (0 = system). */
2303	unsigned u1DescType : 1;
2304	/** Descriptor Privelege level. */
2305	unsigned u2Dpl : 2;
2306	/** Flags selector present(=1) or not. */
2307	unsigned u1Present : 1;
2308	/** Target code segment offset - High word.
2309	* Ignored if task-gate. */
2310	unsigned u16OffsetHigh : 16;
2311	/** Target code segment offset - Top dword.
2312	* Ignored if task-gate. */
2313	unsigned u32OffsetTop : 32;
2314	/** Reserved / ignored / must be zero.
2315	* For call-gates bits 8 thru 12 must be zero, the other gates ignores this. */
2316	unsigned u32Reserved : 32;
2317	} X86DESC64GATE;
2318	AssertCompileSize(X86DESC64GATE, 16);
2319	/** Pointer to a Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
2320	typedef X86DESC64GATE *PX86DESC64GATE;
2321	/** Pointer to a const Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
2322	typedef const X86DESC64GATE *PCX86DESC64GATE;
2323
2324
2325	/**
2326	* Descriptor table entry.
2327	*/
2328	#pragma pack(1)
2329	typedef union X86DESC64
2330	{
2331	/** Generic descriptor view. */
2332	X86DESC64GENERIC Gen;
2333	/** System descriptor view. */
2334	X86DESC64SYSTEM System;
2335	/** Gate descriptor view. */
2336	X86DESC64GATE Gate;
2337
2338	/** 8 bit unsigned interger view. */
2339	uint8_t au8[16];
2340	/** 16 bit unsigned interger view. */
2341	uint16_t au16[8];
2342	/** 32 bit unsigned interger view. */
2343	uint32_t au32[4];
2344	/** 64 bit unsigned interger view. */
2345	uint64_t au64[2];
2346	} X86DESC64;
2347	AssertCompileSize(X86DESC64, 16);
2348	#pragma pack()
2349	/** Pointer to descriptor table entry. */
2350	typedef X86DESC64 *PX86DESC64;
2351	/** Pointer to const descriptor table entry. */
2352	typedef const X86DESC64 *PCX86DESC64;
2353
2354	/** @def X86DESC64_BASE
2355	* Return the base of a 64-bit descriptor.
2356	*/
2357	#define X86DESC64_BASE(desc) /ASM-NOINC/ \
2358	( ((uint64_t)((desc).Gen.u32BaseHigh3) << 32) \
2359	\| ((uint32_t)((desc).Gen.u8BaseHigh2) << 24) \
2360	\| ( (desc).Gen.u8BaseHigh1 << 16) \
2361	\| ( (desc).Gen.u16BaseLow ) )
2362
2363
2364
2365	/** @name Host system descriptor table entry - Use with care!
2366	* @{ */
2367	/** Host system descriptor table entry. */
2368	#if HC_ARCH_BITS == 64
2369	typedef X86DESC64 X86DESCHC;
2370	#else
2371	typedef X86DESC X86DESCHC;
2372	#endif
2373	/** Pointer to a host system descriptor table entry. */
2374	#if HC_ARCH_BITS == 64
2375	typedef PX86DESC64 PX86DESCHC;
2376	#else
2377	typedef PX86DESC PX86DESCHC;
2378	#endif
2379	/** Pointer to a const host system descriptor table entry. */
2380	#if HC_ARCH_BITS == 64
2381	typedef PCX86DESC64 PCX86DESCHC;
2382	#else
2383	typedef PCX86DESC PCX86DESCHC;
2384	#endif
2385	/** @} */
2386
2387
2388	/** @name Selector Descriptor Types.
2389	* @{
2390	*/
2391
2392	/** @name Non-System Selector Types.
2393	* @{ */
2394	/** Code(=set)/Data(=clear) bit. */
2395	#define X86_SEL_TYPE_CODE 8
2396	/** Memory(=set)/System(=clear) bit. */
2397	#define X86_SEL_TYPE_MEMORY RT_BIT(4)
2398	/** Accessed bit. */
2399	#define X86_SEL_TYPE_ACCESSED 1
2400	/** Expand down bit (for data selectors only). */
2401	#define X86_SEL_TYPE_DOWN 4
2402	/** Conforming bit (for code selectors only). */
2403	#define X86_SEL_TYPE_CONF 4
2404	/** Write bit (for data selectors only). */
2405	#define X86_SEL_TYPE_WRITE 2
2406	/** Read bit (for code selectors only). */
2407	#define X86_SEL_TYPE_READ 2
2408
2409	/** Read only selector type. */
2410	#define X86_SEL_TYPE_RO 0
2411	/** Accessed read only selector type. */
2412	#define X86_SEL_TYPE_RO_ACC (0 \| X86_SEL_TYPE_ACCESSED)
2413	/** Read write selector type. */
2414	#define X86_SEL_TYPE_RW 2
2415	/** Accessed read write selector type. */
2416	#define X86_SEL_TYPE_RW_ACC (2 \| X86_SEL_TYPE_ACCESSED)
2417	/** Expand down read only selector type. */
2418	#define X86_SEL_TYPE_RO_DOWN 4
2419	/** Accessed expand down read only selector type. */
2420	#define X86_SEL_TYPE_RO_DOWN_ACC (4 \| X86_SEL_TYPE_ACCESSED)
2421	/** Expand down read write selector type. */
2422	#define X86_SEL_TYPE_RW_DOWN 6
2423	/** Accessed expand down read write selector type. */
2424	#define X86_SEL_TYPE_RW_DOWN_ACC (6 \| X86_SEL_TYPE_ACCESSED)
2425	/** Execute only selector type. */
2426	#define X86_SEL_TYPE_EO (0 \| X86_SEL_TYPE_CODE)
2427	/** Accessed execute only selector type. */
2428	#define X86_SEL_TYPE_EO_ACC (0 \| X86_SEL_TYPE_CODE \| X86_SEL_TYPE_ACCESSED)
2429	/** Execute and read selector type. */
2430	#define X86_SEL_TYPE_ER (2 \| X86_SEL_TYPE_CODE)
2431	/** Accessed execute and read selector type. */
2432	#define X86_SEL_TYPE_ER_ACC (2 \| X86_SEL_TYPE_CODE \| X86_SEL_TYPE_ACCESSED)
2433	/** Conforming execute only selector type. */
2434	#define X86_SEL_TYPE_EO_CONF (4 \| X86_SEL_TYPE_CODE)
2435	/** Accessed Conforming execute only selector type. */
2436	#define X86_SEL_TYPE_EO_CONF_ACC (4 \| X86_SEL_TYPE_CODE \| X86_SEL_TYPE_ACCESSED)
2437	/** Conforming execute and write selector type. */
2438	#define X86_SEL_TYPE_ER_CONF (6 \| X86_SEL_TYPE_CODE)
2439	/** Accessed Conforming execute and write selector type. */
2440	#define X86_SEL_TYPE_ER_CONF_ACC (6 \| X86_SEL_TYPE_CODE \| X86_SEL_TYPE_ACCESSED)
2441	/** @} */
2442
2443
2444	/** @name System Selector Types.
2445	* @{ */
2446	/** Undefined system selector type. */
2447	#define X86_SEL_TYPE_SYS_UNDEFINED 0
2448	/** 286 TSS selector. */
2449	#define X86_SEL_TYPE_SYS_286_TSS_AVAIL 1
2450	/** LDT selector. */
2451	#define X86_SEL_TYPE_SYS_LDT 2
2452	/** 286 TSS selector - Busy. */
2453	#define X86_SEL_TYPE_SYS_286_TSS_BUSY 3
2454	/** 286 Callgate selector. */
2455	#define X86_SEL_TYPE_SYS_286_CALL_GATE 4
2456	/** Taskgate selector. */
2457	#define X86_SEL_TYPE_SYS_TASK_GATE 5
2458	/** 286 Interrupt gate selector. */
2459	#define X86_SEL_TYPE_SYS_286_INT_GATE 6
2460	/** 286 Trapgate selector. */
2461	#define X86_SEL_TYPE_SYS_286_TRAP_GATE 7
2462	/** Undefined system selector. */
2463	#define X86_SEL_TYPE_SYS_UNDEFINED2 8
2464	/** 386 TSS selector. */
2465	#define X86_SEL_TYPE_SYS_386_TSS_AVAIL 9
2466	/** Undefined system selector. */
2467	#define X86_SEL_TYPE_SYS_UNDEFINED3 0xA
2468	/** 386 TSS selector - Busy. */
2469	#define X86_SEL_TYPE_SYS_386_TSS_BUSY 0xB
2470	/** 386 Callgate selector. */
2471	#define X86_SEL_TYPE_SYS_386_CALL_GATE 0xC
2472	/** Undefined system selector. */
2473	#define X86_SEL_TYPE_SYS_UNDEFINED4 0xD
2474	/** 386 Interruptgate selector. */
2475	#define X86_SEL_TYPE_SYS_386_INT_GATE 0xE
2476	/** 386 Trapgate selector. */
2477	#define X86_SEL_TYPE_SYS_386_TRAP_GATE 0xF
2478	/** @} */
2479
2480	/** @name AMD64 System Selector Types.
2481	* @{ */
2482	/** LDT selector. */
2483	#define AMD64_SEL_TYPE_SYS_LDT 2
2484	/** TSS selector - Busy. */
2485	#define AMD64_SEL_TYPE_SYS_TSS_AVAIL 9
2486	/** TSS selector - Busy. */
2487	#define AMD64_SEL_TYPE_SYS_TSS_BUSY 0xB
2488	/** Callgate selector. */
2489	#define AMD64_SEL_TYPE_SYS_CALL_GATE 0xC
2490	/** Interruptgate selector. */
2491	#define AMD64_SEL_TYPE_SYS_INT_GATE 0xE
2492	/** Trapgate selector. */
2493	#define AMD64_SEL_TYPE_SYS_TRAP_GATE 0xF
2494	/** @} */
2495
2496	/** @} */
2497
2498
2499	/** @name Descriptor Table Entry Flag Masks.
2500	* These are for the 2nd 32-bit word of a descriptor.
2501	* @{ */
2502	/** Bits 8-11 - TYPE - Descriptor type mask. */
2503	#define X86_DESC_TYPE_MASK (RT_BIT(8) \| RT_BIT(9) \| RT_BIT(10) \| RT_BIT(11))
2504	/** Bit 12 - S - System (=0) or Code/Data (=1). */
2505	#define X86_DESC_S RT_BIT(12)
2506	/** Bits 13-14 - DPL - Descriptor Privilege Level. */
2507	#define X86_DESC_DPL (RT_BIT(13) \| RT_BIT(14))
2508	/** Bit 15 - P - Present. */
2509	#define X86_DESC_P RT_BIT(15)
2510	/** Bit 20 - AVL - Available for system software. */
2511	#define X86_DESC_AVL RT_BIT(20)
2512	/** Bit 22 - DB - Default operation size. 0 = 16 bit, 1 = 32 bit. */
2513	#define X86_DESC_DB RT_BIT(22)
2514	/** Bit 23 - G - Granularity of the limit. If set 4KB granularity is
2515	* used, if clear byte. */
2516	#define X86_DESC_G RT_BIT(23)
2517	/** @} */
2518
2519	/** @} */
2520
2521
2522	/** @name Task Segments.
2523	* @{
2524	*/
2525
2526	/**
2527	* 16-bit Task Segment (TSS).
2528	*/
2529	#pragma pack(1)
2530	typedef struct X86TSS16
2531	{
2532	/** Back link to previous task. (static) */
2533	RTSEL selPrev;
2534	/** Ring-0 stack pointer. (static) */
2535	uint16_t sp0;
2536	/** Ring-0 stack segment. (static) */
2537	RTSEL ss0;
2538	/** Ring-1 stack pointer. (static) */
2539	uint16_t sp1;
2540	/** Ring-1 stack segment. (static) */
2541	RTSEL ss1;
2542	/** Ring-2 stack pointer. (static) */
2543	uint16_t sp2;
2544	/** Ring-2 stack segment. (static) */
2545	RTSEL ss2;
2546	/** IP before task switch. */
2547	uint16_t ip;
2548	/** FLAGS before task switch. */
2549	uint16_t flags;
2550	/** AX before task switch. */
2551	uint16_t ax;
2552	/** CX before task switch. */
2553	uint16_t cx;
2554	/** DX before task switch. */
2555	uint16_t dx;
2556	/** BX before task switch. */
2557	uint16_t bx;
2558	/** SP before task switch. */
2559	uint16_t sp;
2560	/** BP before task switch. */
2561	uint16_t bp;
2562	/** SI before task switch. */
2563	uint16_t si;
2564	/** DI before task switch. */
2565	uint16_t di;
2566	/** ES before task switch. */
2567	RTSEL es;
2568	/** CS before task switch. */
2569	RTSEL cs;
2570	/** SS before task switch. */
2571	RTSEL ss;
2572	/** DS before task switch. */
2573	RTSEL ds;
2574	/** LDTR before task switch. */
2575	RTSEL selLdt;
2576	} X86TSS16;
2577	AssertCompileSize(X86TSS16, 44);
2578	#pragma pack()
2579	/** Pointer to a 16-bit task segment. */
2580	typedef X86TSS16 *PX86TSS16;
2581	/** Pointer to a const 16-bit task segment. */
2582	typedef const X86TSS16 *PCX86TSS16;
2583
2584
2585	/**
2586	* 32-bit Task Segment (TSS).
2587	*/
2588	#pragma pack(1)
2589	typedef struct X86TSS32
2590	{
2591	/** Back link to previous task. (static) */
2592	RTSEL selPrev;
2593	uint16_t padding1;
2594	/** Ring-0 stack pointer. (static) */
2595	uint32_t esp0;
2596	/** Ring-0 stack segment. (static) */
2597	RTSEL ss0;
2598	uint16_t padding_ss0;
2599	/** Ring-1 stack pointer. (static) */
2600	uint32_t esp1;
2601	/** Ring-1 stack segment. (static) */
2602	RTSEL ss1;
2603	uint16_t padding_ss1;
2604	/** Ring-2 stack pointer. (static) */
2605	uint32_t esp2;
2606	/** Ring-2 stack segment. (static) */
2607	RTSEL ss2;
2608	uint16_t padding_ss2;
2609	/** Page directory for the task. (static) */
2610	uint32_t cr3;
2611	/** EIP before task switch. */
2612	uint32_t eip;
2613	/** EFLAGS before task switch. */
2614	uint32_t eflags;
2615	/** EAX before task switch. */
2616	uint32_t eax;
2617	/** ECX before task switch. */
2618	uint32_t ecx;
2619	/** EDX before task switch. */
2620	uint32_t edx;
2621	/** EBX before task switch. */
2622	uint32_t ebx;
2623	/** ESP before task switch. */
2624	uint32_t esp;
2625	/** EBP before task switch. */
2626	uint32_t ebp;
2627	/** ESI before task switch. */
2628	uint32_t esi;
2629	/** EDI before task switch. */
2630	uint32_t edi;
2631	/** ES before task switch. */
2632	RTSEL es;
2633	uint16_t padding_es;
2634	/** CS before task switch. */
2635	RTSEL cs;
2636	uint16_t padding_cs;
2637	/** SS before task switch. */
2638	RTSEL ss;
2639	uint16_t padding_ss;
2640	/** DS before task switch. */
2641	RTSEL ds;
2642	uint16_t padding_ds;
2643	/** FS before task switch. */
2644	RTSEL fs;
2645	uint16_t padding_fs;
2646	/** GS before task switch. */
2647	RTSEL gs;
2648	uint16_t padding_gs;
2649	/** LDTR before task switch. */
2650	RTSEL selLdt;
2651	uint16_t padding_ldt;
2652	/** Debug trap flag */
2653	uint16_t fDebugTrap;
2654	/** Offset relative to the TSS of the start of the I/O Bitmap
2655	* and the end of the interrupt redirection bitmap. */
2656	uint16_t offIoBitmap;
2657	/** 32 bytes for the virtual interrupt redirection bitmap. (VME) */
2658	uint8_t IntRedirBitmap[32];
2659	} X86TSS32;
2660	#pragma pack()
2661	/** Pointer to task segment. */
2662	typedef X86TSS32 *PX86TSS32;
2663	/** Pointer to const task segment. */
2664	typedef const X86TSS32 *PCX86TSS32;
2665
2666
2667	/**
2668	* 64-bit Task segment.
2669	*/
2670	#pragma pack(1)
2671	typedef struct X86TSS64
2672	{
2673	/** Reserved. */
2674	uint32_t u32Reserved;
2675	/** Ring-0 stack pointer. (static) */
2676	uint64_t rsp0;
2677	/** Ring-1 stack pointer. (static) */
2678	uint64_t rsp1;
2679	/** Ring-2 stack pointer. (static) */
2680	uint64_t rsp2;
2681	/** Reserved. */
2682	uint32_t u32Reserved2[2];
2683	/* IST */
2684	uint64_t ist1;
2685	uint64_t ist2;
2686	uint64_t ist3;
2687	uint64_t ist4;
2688	uint64_t ist5;
2689	uint64_t ist6;
2690	uint64_t ist7;
2691	/* Reserved. */
2692	uint16_t u16Reserved[5];
2693	/** Offset relative to the TSS of the start of the I/O Bitmap
2694	* and the end of the interrupt redirection bitmap. */
2695	uint16_t offIoBitmap;
2696	/** 32 bytes for the virtual interrupt redirection bitmap. (VME) */
2697	uint8_t IntRedirBitmap[32];
2698	} X86TSS64;
2699	#pragma pack()
2700	/** Pointer to a 64-bit task segment. */
2701	typedef X86TSS64 *PX86TSS64;
2702	/** Pointer to a const 64-bit task segment. */
2703	typedef const X86TSS64 *PCX86TSS64;
2704	AssertCompileSize(X86TSS64, 136);
2705
2706	/** @} */
2707
2708
2709	/** @name Selectors.
2710	* @{
2711	*/
2712
2713	/**
2714	* The shift used to convert a selector from and to index an index (C).
2715	*/
2716	#define X86_SEL_SHIFT 3
2717
2718	/**
2719	* The mask used to mask off the table indicator and CPL of an selector.
2720	*/
2721	#define X86_SEL_MASK 0xfff8
2722
2723	/**
2724	* The bit indicating that a selector is in the LDT and not in the GDT.
2725	*/
2726	#define X86_SEL_LDT 0x0004
2727	/**
2728	* The bit mask for getting the RPL of a selector.
2729	*/
2730	#define X86_SEL_RPL 0x0003
2731
2732	/** @} */
2733
2734
2735	/**
2736	* x86 Exceptions/Faults/Traps.
2737	*/
2738	typedef enum X86XCPT
2739	{
2740	/** \#DE - Divide error. */
2741	X86_XCPT_DE = 0x00,
2742	/** \#DB - Debug event (single step, DRx, ..) */
2743	X86_XCPT_DB = 0x01,
2744	/** NMI - Non-Maskable Interrupt */
2745	X86_XCPT_NMI = 0x02,
2746	/** \#BP - Breakpoint (INT3). */
2747	X86_XCPT_BP = 0x03,
2748	/** \#OF - Overflow (INTO). */
2749	X86_XCPT_OF = 0x04,
2750	/** \#BR - Bound range exceeded (BOUND). */
2751	X86_XCPT_BR = 0x05,
2752	/** \#UD - Undefined opcode. */
2753	X86_XCPT_UD = 0x06,
2754	/** \#NM - Device not available (math coprocessor device). */
2755	X86_XCPT_NM = 0x07,
2756	/** \#DF - Double fault. */
2757	X86_XCPT_DF = 0x08,
2758	/** ??? - Coprocessor segment overrun (obsolete). */
2759	X86_XCPT_CO_SEG_OVERRUN = 0x09,
2760	/** \#TS - Taskswitch (TSS). */
2761	X86_XCPT_TS = 0x0a,
2762	/** \#NP - Segment no present. */
2763	X86_XCPT_NP = 0x0b,
2764	/** \#SS - Stack segment fault. */
2765	X86_XCPT_SS = 0x0c,
2766	/** \#GP - General protection fault. */
2767	X86_XCPT_GP = 0x0d,
2768	/** \#PF - Page fault. */
2769	X86_XCPT_PF = 0x0e,
2770	/* 0x0f is reserved. */
2771	/** \#MF - Math fault (FPU). */
2772	X86_XCPT_MF = 0x10,
2773	/** \#AC - Alignment check. */
2774	X86_XCPT_AC = 0x11,
2775	/** \#MC - Machine check. */
2776	X86_XCPT_MC = 0x12,
2777	/** \#XF - SIMD Floating-Pointer Exception. */
2778	X86_XCPT_XF = 0x13
2779	} X86XCPT;
2780	/** Pointer to a x86 exception code. */
2781	typedef X86XCPT *PX86XCPT;
2782	/** Pointer to a const x86 exception code. */
2783	typedef const X86XCPT *PCX86XCPT;
2784
2785
2786	/** @name Trap Error Codes
2787	* @{
2788	*/
2789	/** External indicator. */
2790	#define X86_TRAP_ERR_EXTERNAL 1
2791	/** IDT indicator. */
2792	#define X86_TRAP_ERR_IDT 2
2793	/** Descriptor table indicator - If set LDT, if clear GDT. */
2794	#define X86_TRAP_ERR_TI 4
2795	/** Mask for getting the selector. */
2796	#define X86_TRAP_ERR_SEL_MASK 0xfff8
2797	/** Shift for getting the selector table index (C type index). */
2798	#define X86_TRAP_ERR_SEL_SHIFT 3
2799	/** @} */
2800
2801
2802	/** @name \#PF Trap Error Codes
2803	* @{
2804	*/
2805	/** Bit 0 - P - Not present (clear) or page level protection (set) fault. */
2806	#define X86_TRAP_PF_P RT_BIT(0)
2807	/** Bit 1 - R/W - Read (clear) or write (set) access. */
2808	#define X86_TRAP_PF_RW RT_BIT(1)
2809	/** Bit 2 - U/S - CPU executing in user mode (set) or supervisor mode (clear). */
2810	#define X86_TRAP_PF_US RT_BIT(2)
2811	/** Bit 3 - RSVD- Reserved bit violation (set), i.e. reserved bit was set to 1. */
2812	#define X86_TRAP_PF_RSVD RT_BIT(3)
2813	/** Bit 4 - I/D - Instruction fetch (set) / Data access (clear) - PAE + NXE. */
2814	#define X86_TRAP_PF_ID RT_BIT(4)
2815	/** @} */
2816
2817	#pragma pack(1)
2818	/**
2819	* 32-bit IDTR/GDTR.
2820	*/
2821	typedef struct X86XDTR32
2822	{
2823	/** Size of the descriptor table. */
2824	uint16_t cb;
2825	/** Address of the descriptor table. */
2826	uint32_t uAddr;
2827	} X86XDTR32, *PX86XDTR32;
2828	#pragma pack()
2829
2830	#pragma pack(1)
2831	/**
2832	* 64-bit IDTR/GDTR.
2833	*/
2834	typedef struct X86XDTR64
2835	{
2836	/** Size of the descriptor table. */
2837	uint16_t cb;
2838	/** Address of the descriptor table. */
2839	uint64_t uAddr;
2840	} X86XDTR64, *PX86XDTR64;
2841	#pragma pack()
2842
2843	/** @} */
2844
2845	#endif
2846

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/VBox/x86.h@ 31627

Download in other formats: