x86.h@ 64770

Last change on this file since 64770 was 64113, checked in by vboxsync, 8 years ago
Added some missing MSRs.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 152.6 KB

Line
1	/** @file
2	* IPRT - X86 and AMD64 Structures and Definitions.
3	*
4	* @note x86.mac is generated from this file by running 'kmk incs' in the root.
5	*/
6
7	/*
8	* Copyright (C) 2006-2016 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 ___iprt_x86_h
29	#define ___iprt_x86_h
30
31	#ifndef VBOX_FOR_DTRACE_LIB
32	# include <iprt/types.h>
33	# include <iprt/assert.h>
34	#else
35	# pragma D depends_on library vbox-types.d
36	#endif
37
38	/* Workaround for Solaris sys/regset.h defining CS, DS */
39	#ifdef RT_OS_SOLARIS
40	# undef CS
41	# undef DS
42	#endif
43
44	/** @defgroup grp_rt_x86 x86 Types and Definitions
45	* @ingroup grp_rt
46	* @{
47	*/
48
49	#ifndef VBOX_FOR_DTRACE_LIB
50	/**
51	* EFLAGS Bits.
52	*/
53	typedef struct X86EFLAGSBITS
54	{
55	/** Bit 0 - CF - Carry flag - Status flag. */
56	unsigned u1CF : 1;
57	/** Bit 1 - 1 - Reserved flag. */
58	unsigned u1Reserved0 : 1;
59	/** Bit 2 - PF - Parity flag - Status flag. */
60	unsigned u1PF : 1;
61	/** Bit 3 - 0 - Reserved flag. */
62	unsigned u1Reserved1 : 1;
63	/** Bit 4 - AF - Auxiliary carry flag - Status flag. */
64	unsigned u1AF : 1;
65	/** Bit 5 - 0 - Reserved flag. */
66	unsigned u1Reserved2 : 1;
67	/** Bit 6 - ZF - Zero flag - Status flag. */
68	unsigned u1ZF : 1;
69	/** Bit 7 - SF - Signed flag - Status flag. */
70	unsigned u1SF : 1;
71	/** Bit 8 - TF - Trap flag - System flag. */
72	unsigned u1TF : 1;
73	/** Bit 9 - IF - Interrupt flag - System flag. */
74	unsigned u1IF : 1;
75	/** Bit 10 - DF - Direction flag - Control flag. */
76	unsigned u1DF : 1;
77	/** Bit 11 - OF - Overflow flag - Status flag. */
78	unsigned u1OF : 1;
79	/** Bit 12-13 - IOPL - I/O privilege level flag - System flag. */
80	unsigned u2IOPL : 2;
81	/** Bit 14 - NT - Nested task flag - System flag. */
82	unsigned u1NT : 1;
83	/** Bit 15 - 0 - Reserved flag. */
84	unsigned u1Reserved3 : 1;
85	/** Bit 16 - RF - Resume flag - System flag. */
86	unsigned u1RF : 1;
87	/** Bit 17 - VM - Virtual 8086 mode - System flag. */
88	unsigned u1VM : 1;
89	/** Bit 18 - AC - Alignment check flag - System flag. Works with CR0.AM. */
90	unsigned u1AC : 1;
91	/** Bit 19 - VIF - Virtual interrupt flag - System flag. */
92	unsigned u1VIF : 1;
93	/** Bit 20 - VIP - Virtual interrupt pending flag - System flag. */
94	unsigned u1VIP : 1;
95	/** Bit 21 - ID - CPUID flag - System flag. If this responds to flipping CPUID is supported. */
96	unsigned u1ID : 1;
97	/** Bit 22-31 - 0 - Reserved flag. */
98	unsigned u10Reserved4 : 10;
99	} X86EFLAGSBITS;
100	/** Pointer to EFLAGS bits. */
101	typedef X86EFLAGSBITS *PX86EFLAGSBITS;
102	/** Pointer to const EFLAGS bits. */
103	typedef const X86EFLAGSBITS *PCX86EFLAGSBITS;
104	#endif /* !VBOX_FOR_DTRACE_LIB */
105
106	/**
107	* EFLAGS.
108	*/
109	typedef union X86EFLAGS
110	{
111	/** The plain unsigned view. */
112	uint32_t u;
113	#ifndef VBOX_FOR_DTRACE_LIB
114	/** The bitfield view. */
115	X86EFLAGSBITS Bits;
116	#endif
117	/** The 8-bit view. */
118	uint8_t au8[4];
119	/** The 16-bit view. */
120	uint16_t au16[2];
121	/** The 32-bit view. */
122	uint32_t au32[1];
123	/** The 32-bit view. */
124	uint32_t u32;
125	} X86EFLAGS;
126	/** Pointer to EFLAGS. */
127	typedef X86EFLAGS *PX86EFLAGS;
128	/** Pointer to const EFLAGS. */
129	typedef const X86EFLAGS *PCX86EFLAGS;
130
131	/**
132	* RFLAGS (32 upper bits are reserved).
133	*/
134	typedef union X86RFLAGS
135	{
136	/** The plain unsigned view. */
137	uint64_t u;
138	#ifndef VBOX_FOR_DTRACE_LIB
139	/** The bitfield view. */
140	X86EFLAGSBITS Bits;
141	#endif
142	/** The 8-bit view. */
143	uint8_t au8[8];
144	/** The 16-bit view. */
145	uint16_t au16[4];
146	/** The 32-bit view. */
147	uint32_t au32[2];
148	/** The 64-bit view. */
149	uint64_t au64[1];
150	/** The 64-bit view. */
151	uint64_t u64;
152	} X86RFLAGS;
153	/** Pointer to RFLAGS. */
154	typedef X86RFLAGS *PX86RFLAGS;
155	/** Pointer to const RFLAGS. */
156	typedef const X86RFLAGS *PCX86RFLAGS;
157
158
159	/** @name EFLAGS
160	* @{
161	*/
162	/** Bit 0 - CF - Carry flag - Status flag. */
163	#define X86_EFL_CF RT_BIT_32(0)
164	#define X86_EFL_CF_BIT 0
165	/** Bit 1 - Reserved, reads as 1. */
166	#define X86_EFL_1 RT_BIT_32(1)
167	/** Bit 2 - PF - Parity flag - Status flag. */
168	#define X86_EFL_PF RT_BIT_32(2)
169	/** Bit 4 - AF - Auxiliary carry flag - Status flag. */
170	#define X86_EFL_AF RT_BIT_32(4)
171	#define X86_EFL_AF_BIT 4
172	/** Bit 6 - ZF - Zero flag - Status flag. */
173	#define X86_EFL_ZF RT_BIT_32(6)
174	#define X86_EFL_ZF_BIT 6
175	/** Bit 7 - SF - Signed flag - Status flag. */
176	#define X86_EFL_SF RT_BIT_32(7)
177	#define X86_EFL_SF_BIT 7
178	/** Bit 8 - TF - Trap flag - System flag. */
179	#define X86_EFL_TF RT_BIT_32(8)
180	/** Bit 9 - IF - Interrupt flag - System flag. */
181	#define X86_EFL_IF RT_BIT_32(9)
182	/** Bit 10 - DF - Direction flag - Control flag. */
183	#define X86_EFL_DF RT_BIT_32(10)
184	/** Bit 11 - OF - Overflow flag - Status flag. */
185	#define X86_EFL_OF RT_BIT_32(11)
186	#define X86_EFL_OF_BIT 11
187	/** Bit 12-13 - IOPL - I/O privilege level flag - System flag. */
188	#define X86_EFL_IOPL (RT_BIT_32(12) \| RT_BIT_32(13))
189	/** Bit 14 - NT - Nested task flag - System flag. */
190	#define X86_EFL_NT RT_BIT_32(14)
191	/** Bit 16 - RF - Resume flag - System flag. */
192	#define X86_EFL_RF RT_BIT_32(16)
193	/** Bit 17 - VM - Virtual 8086 mode - System flag. */
194	#define X86_EFL_VM RT_BIT_32(17)
195	/** Bit 18 - AC - Alignment check flag - System flag. Works with CR0.AM. */
196	#define X86_EFL_AC RT_BIT_32(18)
197	/** Bit 19 - VIF - Virtual interrupt flag - System flag. */
198	#define X86_EFL_VIF RT_BIT_32(19)
199	/** Bit 20 - VIP - Virtual interrupt pending flag - System flag. */
200	#define X86_EFL_VIP RT_BIT_32(20)
201	/** Bit 21 - ID - CPUID flag - System flag. If this responds to flipping CPUID is supported. */
202	#define X86_EFL_ID RT_BIT_32(21)
203	/** All live bits. */
204	#define X86_EFL_LIVE_MASK UINT32_C(0x003f7fd5)
205	/** Read as 1 bits. */
206	#define X86_EFL_RA1_MASK RT_BIT_32(1)
207	/** IOPL shift. */
208	#define X86_EFL_IOPL_SHIFT 12
209	/** The IOPL level from the flags. */
210	#define X86_EFL_GET_IOPL(efl) (((efl) >> X86_EFL_IOPL_SHIFT) & 3)
211	/** Bits restored by popf */
212	#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 \
213	\| X86_EFL_DF \| X86_EFL_OF \| X86_EFL_IOPL \| X86_EFL_NT \| X86_EFL_AC \| X86_EFL_ID )
214	/** Bits restored by popf */
215	#define X86_EFL_POPF_BITS_386 ( X86_EFL_CF \| X86_EFL_PF \| X86_EFL_AF \| X86_EFL_ZF \| X86_EFL_SF \| X86_EFL_TF \| X86_EFL_IF \
216	\| X86_EFL_DF \| X86_EFL_OF \| X86_EFL_IOPL \| X86_EFL_NT )
217	/** The status bits commonly updated by arithmetic instructions. */
218	#define X86_EFL_STATUS_BITS ( X86_EFL_CF \| X86_EFL_PF \| X86_EFL_AF \| X86_EFL_ZF \| X86_EFL_SF \| X86_EFL_OF )
219	/** @} */
220
221
222	/** CPUID Feature information - ECX.
223	* CPUID query with EAX=1.
224	*/
225	#ifndef VBOX_FOR_DTRACE_LIB
226	typedef struct X86CPUIDFEATECX
227	{
228	/** Bit 0 - SSE3 - Supports SSE3 or not. */
229	unsigned u1SSE3 : 1;
230	/** Bit 1 - PCLMULQDQ. */
231	unsigned u1PCLMULQDQ : 1;
232	/** Bit 2 - DS Area 64-bit layout. */
233	unsigned u1DTE64 : 1;
234	/** Bit 3 - MONITOR - Supports MONITOR/MWAIT. */
235	unsigned u1Monitor : 1;
236	/** Bit 4 - CPL-DS - CPL Qualified Debug Store. */
237	unsigned u1CPLDS : 1;
238	/** Bit 5 - VMX - Virtual Machine Technology. */
239	unsigned u1VMX : 1;
240	/** Bit 6 - SMX: Safer Mode Extensions. */
241	unsigned u1SMX : 1;
242	/** Bit 7 - EST - Enh. SpeedStep Tech. */
243	unsigned u1EST : 1;
244	/** Bit 8 - TM2 - Terminal Monitor 2. */
245	unsigned u1TM2 : 1;
246	/** Bit 9 - SSSE3 - Supplemental Streaming SIMD Extensions 3. */
247	unsigned u1SSSE3 : 1;
248	/** Bit 10 - CNTX-ID - L1 Context ID. */
249	unsigned u1CNTXID : 1;
250	/** Bit 11 - Reserved. */
251	unsigned u1Reserved1 : 1;
252	/** Bit 12 - FMA. */
253	unsigned u1FMA : 1;
254	/** Bit 13 - CX16 - CMPXCHG16B. */
255	unsigned u1CX16 : 1;
256	/** Bit 14 - xTPR Update Control. Processor supports changing IA32_MISC_ENABLES[bit 23]. */
257	unsigned u1TPRUpdate : 1;
258	/** Bit 15 - PDCM - Perf/Debug Capability MSR. */
259	unsigned u1PDCM : 1;
260	/** Bit 16 - Reserved. */
261	unsigned u1Reserved2 : 1;
262	/** Bit 17 - PCID - Process-context identifiers. */
263	unsigned u1PCID : 1;
264	/** Bit 18 - Direct Cache Access. */
265	unsigned u1DCA : 1;
266	/** Bit 19 - SSE4_1 - Supports SSE4_1 or not. */
267	unsigned u1SSE4_1 : 1;
268	/** Bit 20 - SSE4_2 - Supports SSE4_2 or not. */
269	unsigned u1SSE4_2 : 1;
270	/** Bit 21 - x2APIC. */
271	unsigned u1x2APIC : 1;
272	/** Bit 22 - MOVBE - Supports MOVBE. */
273	unsigned u1MOVBE : 1;
274	/** Bit 23 - POPCNT - Supports POPCNT. */
275	unsigned u1POPCNT : 1;
276	/** Bit 24 - TSC-Deadline. */
277	unsigned u1TSCDEADLINE : 1;
278	/** Bit 25 - AES. */
279	unsigned u1AES : 1;
280	/** Bit 26 - XSAVE - Supports XSAVE. */
281	unsigned u1XSAVE : 1;
282	/** Bit 27 - OSXSAVE - Supports OSXSAVE. */
283	unsigned u1OSXSAVE : 1;
284	/** Bit 28 - AVX - Supports AVX instruction extensions. */
285	unsigned u1AVX : 1;
286	/** Bit 29 - F16C - Supports 16-bit floating point conversion instructions. */
287	unsigned u1F16C : 1;
288	/** Bit 30 - RDRAND - Supports RDRAND. */
289	unsigned u1RDRAND : 1;
290	/** Bit 31 - Hypervisor present (we're a guest). */
291	unsigned u1HVP : 1;
292	} X86CPUIDFEATECX;
293	#else /* VBOX_FOR_DTRACE_LIB */
294	typedef uint32_t X86CPUIDFEATECX;
295	#endif /* VBOX_FOR_DTRACE_LIB */
296	/** Pointer to CPUID Feature Information - ECX. */
297	typedef X86CPUIDFEATECX *PX86CPUIDFEATECX;
298	/** Pointer to const CPUID Feature Information - ECX. */
299	typedef const X86CPUIDFEATECX *PCX86CPUIDFEATECX;
300
301
302	/** CPUID Feature Information - EDX.
303	* CPUID query with EAX=1.
304	*/
305	#ifndef VBOX_FOR_DTRACE_LIB /* DTrace different (brain-dead from a C pov) bitfield implementation */
306	typedef struct X86CPUIDFEATEDX
307	{
308	/** Bit 0 - FPU - x87 FPU on Chip. */
309	unsigned u1FPU : 1;
310	/** Bit 1 - VME - Virtual 8086 Mode Enhancements. */
311	unsigned u1VME : 1;
312	/** Bit 2 - DE - Debugging extensions. */
313	unsigned u1DE : 1;
314	/** Bit 3 - PSE - Page Size Extension. */
315	unsigned u1PSE : 1;
316	/** Bit 4 - TSC - Time Stamp Counter. */
317	unsigned u1TSC : 1;
318	/** Bit 5 - MSR - Model Specific Registers RDMSR and WRMSR Instructions. */
319	unsigned u1MSR : 1;
320	/** Bit 6 - PAE - Physical Address Extension. */
321	unsigned u1PAE : 1;
322	/** Bit 7 - MCE - Machine Check Exception. */
323	unsigned u1MCE : 1;
324	/** Bit 8 - CX8 - CMPXCHG8B instruction. */
325	unsigned u1CX8 : 1;
326	/** Bit 9 - APIC - APIC On-Chip. */
327	unsigned u1APIC : 1;
328	/** Bit 10 - Reserved. */
329	unsigned u1Reserved1 : 1;
330	/** Bit 11 - SEP - SYSENTER and SYSEXIT. */
331	unsigned u1SEP : 1;
332	/** Bit 12 - MTRR - Memory Type Range Registers. */
333	unsigned u1MTRR : 1;
334	/** Bit 13 - PGE - PTE Global Bit. */
335	unsigned u1PGE : 1;
336	/** Bit 14 - MCA - Machine Check Architecture. */
337	unsigned u1MCA : 1;
338	/** Bit 15 - CMOV - Conditional Move Instructions. */
339	unsigned u1CMOV : 1;
340	/** Bit 16 - PAT - Page Attribute Table. */
341	unsigned u1PAT : 1;
342	/** Bit 17 - PSE-36 - 36-bit Page Size Extension. */
343	unsigned u1PSE36 : 1;
344	/** Bit 18 - PSN - Processor Serial Number. */
345	unsigned u1PSN : 1;
346	/** Bit 19 - CLFSH - CLFLUSH Instruction. */
347	unsigned u1CLFSH : 1;
348	/** Bit 20 - Reserved. */
349	unsigned u1Reserved2 : 1;
350	/** Bit 21 - DS - Debug Store. */
351	unsigned u1DS : 1;
352	/** Bit 22 - ACPI - Thermal Monitor and Software Controlled Clock Facilities. */
353	unsigned u1ACPI : 1;
354	/** Bit 23 - MMX - Intel MMX 'Technology'. */
355	unsigned u1MMX : 1;
356	/** Bit 24 - FXSR - FXSAVE and FXRSTOR Instructions. */
357	unsigned u1FXSR : 1;
358	/** Bit 25 - SSE - SSE Support. */
359	unsigned u1SSE : 1;
360	/** Bit 26 - SSE2 - SSE2 Support. */
361	unsigned u1SSE2 : 1;
362	/** Bit 27 - SS - Self Snoop. */
363	unsigned u1SS : 1;
364	/** Bit 28 - HTT - Hyper-Threading Technology. */
365	unsigned u1HTT : 1;
366	/** Bit 29 - TM - Thermal Monitor. */
367	unsigned u1TM : 1;
368	/** Bit 30 - Reserved - . */
369	unsigned u1Reserved3 : 1;
370	/** Bit 31 - PBE - Pending Break Enabled. */
371	unsigned u1PBE : 1;
372	} X86CPUIDFEATEDX;
373	#else /* VBOX_FOR_DTRACE_LIB */
374	typedef uint32_t X86CPUIDFEATEDX;
375	#endif /* VBOX_FOR_DTRACE_LIB */
376	/** Pointer to CPUID Feature Information - EDX. */
377	typedef X86CPUIDFEATEDX *PX86CPUIDFEATEDX;
378	/** Pointer to const CPUID Feature Information - EDX. */
379	typedef const X86CPUIDFEATEDX *PCX86CPUIDFEATEDX;
380
381	/** @name CPUID Vendor information.
382	* CPUID query with EAX=0.
383	* @{
384	*/
385	#define X86_CPUID_VENDOR_INTEL_EBX 0x756e6547 /* Genu */
386	#define X86_CPUID_VENDOR_INTEL_ECX 0x6c65746e /* ntel */
387	#define X86_CPUID_VENDOR_INTEL_EDX 0x49656e69 /* ineI */
388
389	#define X86_CPUID_VENDOR_AMD_EBX 0x68747541 /* Auth */
390	#define X86_CPUID_VENDOR_AMD_ECX 0x444d4163 /* cAMD */
391	#define X86_CPUID_VENDOR_AMD_EDX 0x69746e65 /* enti */
392
393	#define X86_CPUID_VENDOR_VIA_EBX 0x746e6543 /* Cent */
394	#define X86_CPUID_VENDOR_VIA_ECX 0x736c7561 /* auls */
395	#define X86_CPUID_VENDOR_VIA_EDX 0x48727561 /* aurH */
396	/** @} */
397
398
399	/** @name CPUID Feature information.
400	* CPUID query with EAX=1.
401	* @{
402	*/
403	/** ECX Bit 0 - SSE3 - Supports SSE3 or not. */
404	#define X86_CPUID_FEATURE_ECX_SSE3 RT_BIT_32(0)
405	/** ECX Bit 1 - PCLMUL - PCLMULQDQ support (for AES-GCM). */
406	#define X86_CPUID_FEATURE_ECX_PCLMUL RT_BIT_32(1)
407	/** ECX Bit 2 - DTES64 - DS Area 64-bit Layout. */
408	#define X86_CPUID_FEATURE_ECX_DTES64 RT_BIT_32(2)
409	/** ECX Bit 3 - MONITOR - Supports MONITOR/MWAIT. */
410	#define X86_CPUID_FEATURE_ECX_MONITOR RT_BIT_32(3)
411	/** ECX Bit 4 - CPL-DS - CPL Qualified Debug Store. */
412	#define X86_CPUID_FEATURE_ECX_CPLDS RT_BIT_32(4)
413	/** ECX Bit 5 - VMX - Virtual Machine Technology. */
414	#define X86_CPUID_FEATURE_ECX_VMX RT_BIT_32(5)
415	/** ECX Bit 6 - SMX - Safer Mode Extensions. */
416	#define X86_CPUID_FEATURE_ECX_SMX RT_BIT_32(6)
417	/** ECX Bit 7 - EST - Enh. SpeedStep Tech. */
418	#define X86_CPUID_FEATURE_ECX_EST RT_BIT_32(7)
419	/** ECX Bit 8 - TM2 - Terminal Monitor 2. */
420	#define X86_CPUID_FEATURE_ECX_TM2 RT_BIT_32(8)
421	/** ECX Bit 9 - SSSE3 - Supplemental Streaming SIMD Extensions 3. */
422	#define X86_CPUID_FEATURE_ECX_SSSE3 RT_BIT_32(9)
423	/** ECX Bit 10 - CNTX-ID - L1 Context ID. */
424	#define X86_CPUID_FEATURE_ECX_CNTXID RT_BIT_32(10)
425	/** ECX Bit 11 - SDBG - Sillicon debug interface (IA32_DEBUG_INTERFACE MSR).
426	* See figure 3-6 and table 3-10, in intel Vol. 2A. from 2015-01-01. */
427	#define X86_CPUID_FEATURE_ECX_SDBG RT_BIT_32(11)
428	/** ECX Bit 12 - FMA. */
429	#define X86_CPUID_FEATURE_ECX_FMA RT_BIT_32(12)
430	/** ECX Bit 13 - CX16 - CMPXCHG16B. */
431	#define X86_CPUID_FEATURE_ECX_CX16 RT_BIT_32(13)
432	/** ECX Bit 14 - xTPR Update Control. Processor supports changing IA32_MISC_ENABLES[bit 23]. */
433	#define X86_CPUID_FEATURE_ECX_TPRUPDATE RT_BIT_32(14)
434	/** ECX Bit 15 - PDCM - Perf/Debug Capability MSR. */
435	#define X86_CPUID_FEATURE_ECX_PDCM RT_BIT_32(15)
436	/** ECX Bit 17 - PCID - Process-context identifiers. */
437	#define X86_CPUID_FEATURE_ECX_PCID RT_BIT_32(17)
438	/** ECX Bit 18 - DCA - Direct Cache Access. */
439	#define X86_CPUID_FEATURE_ECX_DCA RT_BIT_32(18)
440	/** ECX Bit 19 - SSE4_1 - Supports SSE4_1 or not. */
441	#define X86_CPUID_FEATURE_ECX_SSE4_1 RT_BIT_32(19)
442	/** ECX Bit 20 - SSE4_2 - Supports SSE4_2 or not. */
443	#define X86_CPUID_FEATURE_ECX_SSE4_2 RT_BIT_32(20)
444	/** ECX Bit 21 - x2APIC support. */
445	#define X86_CPUID_FEATURE_ECX_X2APIC RT_BIT_32(21)
446	/** ECX Bit 22 - MOVBE instruction. */
447	#define X86_CPUID_FEATURE_ECX_MOVBE RT_BIT_32(22)
448	/** ECX Bit 23 - POPCNT instruction. */
449	#define X86_CPUID_FEATURE_ECX_POPCNT RT_BIT_32(23)
450	/** ECX Bir 24 - TSC-Deadline. */
451	#define X86_CPUID_FEATURE_ECX_TSCDEADL RT_BIT_32(24)
452	/** ECX Bit 25 - AES instructions. */
453	#define X86_CPUID_FEATURE_ECX_AES RT_BIT_32(25)
454	/** ECX Bit 26 - XSAVE instruction. */
455	#define X86_CPUID_FEATURE_ECX_XSAVE RT_BIT_32(26)
456	/** ECX Bit 27 - Copy of CR4.OSXSAVE. */
457	#define X86_CPUID_FEATURE_ECX_OSXSAVE RT_BIT_32(27)
458	/** ECX Bit 28 - AVX. */
459	#define X86_CPUID_FEATURE_ECX_AVX RT_BIT_32(28)
460	/** ECX Bit 29 - F16C - Half-precision convert instruction support. */
461	#define X86_CPUID_FEATURE_ECX_F16C RT_BIT_32(29)
462	/** ECX Bit 30 - RDRAND instruction. */
463	#define X86_CPUID_FEATURE_ECX_RDRAND RT_BIT_32(30)
464	/** ECX Bit 31 - Hypervisor Present (software only). */
465	#define X86_CPUID_FEATURE_ECX_HVP RT_BIT_32(31)
466
467
468	/** Bit 0 - FPU - x87 FPU on Chip. */
469	#define X86_CPUID_FEATURE_EDX_FPU RT_BIT_32(0)
470	/** Bit 1 - VME - Virtual 8086 Mode Enhancements. */
471	#define X86_CPUID_FEATURE_EDX_VME RT_BIT_32(1)
472	/** Bit 2 - DE - Debugging extensions. */
473	#define X86_CPUID_FEATURE_EDX_DE RT_BIT_32(2)
474	/** Bit 3 - PSE - Page Size Extension. */
475	#define X86_CPUID_FEATURE_EDX_PSE RT_BIT_32(3)
476	#define X86_CPUID_FEATURE_EDX_PSE_BIT 3 /*< Bit number for X86_CPUID_FEATURE_EDX_PSE. /
477	/** Bit 4 - TSC - Time Stamp Counter. */
478	#define X86_CPUID_FEATURE_EDX_TSC RT_BIT_32(4)
479	/** Bit 5 - MSR - Model Specific Registers RDMSR and WRMSR Instructions. */
480	#define X86_CPUID_FEATURE_EDX_MSR RT_BIT_32(5)
481	/** Bit 6 - PAE - Physical Address Extension. */
482	#define X86_CPUID_FEATURE_EDX_PAE RT_BIT_32(6)
483	#define X86_CPUID_FEATURE_EDX_PAE_BIT 6 /*< Bit number for X86_CPUID_FEATURE_EDX_PAE. /
484	/** Bit 7 - MCE - Machine Check Exception. */
485	#define X86_CPUID_FEATURE_EDX_MCE RT_BIT_32(7)
486	/** Bit 8 - CX8 - CMPXCHG8B instruction. */
487	#define X86_CPUID_FEATURE_EDX_CX8 RT_BIT_32(8)
488	/** Bit 9 - APIC - APIC On-Chip. */
489	#define X86_CPUID_FEATURE_EDX_APIC RT_BIT_32(9)
490	/** Bit 11 - SEP - SYSENTER and SYSEXIT Present. */
491	#define X86_CPUID_FEATURE_EDX_SEP RT_BIT_32(11)
492	/** Bit 12 - MTRR - Memory Type Range Registers. */
493	#define X86_CPUID_FEATURE_EDX_MTRR RT_BIT_32(12)
494	/** Bit 13 - PGE - PTE Global Bit. */
495	#define X86_CPUID_FEATURE_EDX_PGE RT_BIT_32(13)
496	/** Bit 14 - MCA - Machine Check Architecture. */
497	#define X86_CPUID_FEATURE_EDX_MCA RT_BIT_32(14)
498	/** Bit 15 - CMOV - Conditional Move Instructions. */
499	#define X86_CPUID_FEATURE_EDX_CMOV RT_BIT_32(15)
500	/** Bit 16 - PAT - Page Attribute Table. */
501	#define X86_CPUID_FEATURE_EDX_PAT RT_BIT_32(16)
502	/** Bit 17 - PSE-36 - 36-bit Page Size Extension. */
503	#define X86_CPUID_FEATURE_EDX_PSE36 RT_BIT_32(17)
504	/** Bit 18 - PSN - Processor Serial Number. */
505	#define X86_CPUID_FEATURE_EDX_PSN RT_BIT_32(18)
506	/** Bit 19 - CLFSH - CLFLUSH Instruction. */
507	#define X86_CPUID_FEATURE_EDX_CLFSH RT_BIT_32(19)
508	/** Bit 21 - DS - Debug Store. */
509	#define X86_CPUID_FEATURE_EDX_DS RT_BIT_32(21)
510	/** Bit 22 - ACPI - Thermal Monitor and Software Controlled Clock Facilities. */
511	#define X86_CPUID_FEATURE_EDX_ACPI RT_BIT_32(22)
512	/** Bit 23 - MMX - Intel MMX Technology. */
513	#define X86_CPUID_FEATURE_EDX_MMX RT_BIT_32(23)
514	/** Bit 24 - FXSR - FXSAVE and FXRSTOR Instructions. */
515	#define X86_CPUID_FEATURE_EDX_FXSR RT_BIT_32(24)
516	/** Bit 25 - SSE - SSE Support. */
517	#define X86_CPUID_FEATURE_EDX_SSE RT_BIT_32(25)
518	/** Bit 26 - SSE2 - SSE2 Support. */
519	#define X86_CPUID_FEATURE_EDX_SSE2 RT_BIT_32(26)
520	/** Bit 27 - SS - Self Snoop. */
521	#define X86_CPUID_FEATURE_EDX_SS RT_BIT_32(27)
522	/** Bit 28 - HTT - Hyper-Threading Technology. */
523	#define X86_CPUID_FEATURE_EDX_HTT RT_BIT_32(28)
524	/** Bit 29 - TM - Therm. Monitor. */
525	#define X86_CPUID_FEATURE_EDX_TM RT_BIT_32(29)
526	/** Bit 31 - PBE - Pending Break Enabled. */
527	#define X86_CPUID_FEATURE_EDX_PBE RT_BIT_32(31)
528	/** @} */
529
530	/** @name CPUID mwait/monitor information.
531	* CPUID query with EAX=5.
532	* @{
533	*/
534	/** ECX Bit 0 - MWAITEXT - Supports mwait/monitor extensions or not. */
535	#define X86_CPUID_MWAIT_ECX_EXT RT_BIT_32(0)
536	/** ECX Bit 1 - MWAITBREAK - Break mwait for external interrupt even if EFLAGS.IF=0. */
537	#define X86_CPUID_MWAIT_ECX_BREAKIRQIF0 RT_BIT_32(1)
538	/** @} */
539
540
541	/** @name CPUID Structured Extended Feature information.
542	* CPUID query with EAX=7.
543	* @{
544	*/
545	/** EBX Bit 0 - FSGSBASE - Supports RDFSBASE/RDGSBASE/WRFSBASE/WRGSBASE. */
546	#define X86_CPUID_STEXT_FEATURE_EBX_FSGSBASE RT_BIT_32(0)
547	/** EBX Bit 1 - TSCADJUST - Supports MSR_IA32_TSC_ADJUST. */
548	#define X86_CPUID_STEXT_FEATURE_EBX_TSC_ADJUST RT_BIT_32(1)
549	/** EBX Bit 2 - SGX - Supports Software Guard Extensions . */
550	#define X86_CPUID_STEXT_FEATURE_EBX_SGX RT_BIT_32(2)
551	/** EBX Bit 3 - BMI1 - Advanced Bit Manipulation extension 1. */
552	#define X86_CPUID_STEXT_FEATURE_EBX_BMI1 RT_BIT_32(3)
553	/** EBX Bit 4 - HLE - Hardware Lock Elision. */
554	#define X86_CPUID_STEXT_FEATURE_EBX_HLE RT_BIT_32(4)
555	/** EBX Bit 5 - AVX2 - Advanced Vector Extensions 2. */
556	#define X86_CPUID_STEXT_FEATURE_EBX_AVX2 RT_BIT_32(5)
557	/** EBX Bit 6 - FDP_EXCPTN_ONLY - FPU data pointer only updated on exceptions if set. */
558	#define X86_CPUID_STEXT_FEATURE_EBX_FDP_EXCPTN_ONLY RT_BIT_32(6)
559	/** EBX Bit 7 - SMEP - Supervisor Mode Execution Prevention. */
560	#define X86_CPUID_STEXT_FEATURE_EBX_SMEP RT_BIT_32(7)
561	/** EBX Bit 8 - BMI2 - Advanced Bit Manipulation extension 2. */
562	#define X86_CPUID_STEXT_FEATURE_EBX_BMI2 RT_BIT_32(8)
563	/** EBX Bit 9 - ERMS - Supports Enhanced REP MOVSB/STOSB. */
564	#define X86_CPUID_STEXT_FEATURE_EBX_ERMS RT_BIT_32(9)
565	/** EBX Bit 10 - INVPCID - Supports INVPCID. */
566	#define X86_CPUID_STEXT_FEATURE_EBX_INVPCID RT_BIT_32(10)
567	/** EBX Bit 11 - RTM - Supports Restricted Transactional Memory. */
568	#define X86_CPUID_STEXT_FEATURE_EBX_RTM RT_BIT_32(11)
569	/** EBX Bit 12 - PQM - Supports Platform Quality of Service Monitoring. */
570	#define X86_CPUID_STEXT_FEATURE_EBX_PQM RT_BIT_32(12)
571	/** EBX Bit 13 - DEPFPU_CS_DS - Deprecates FPU CS, FPU DS values if set. */
572	#define X86_CPUID_STEXT_FEATURE_EBX_DEPR_FPU_CS_DS RT_BIT_32(13)
573	/** EBX Bit 14 - MPE - Supports Intel Memory Protection Extensions. */
574	#define X86_CPUID_STEXT_FEATURE_EBX_MPE RT_BIT_32(14)
575	/** EBX Bit 15 - PQE - Supports Platform Quality of Service Enforcement. */
576	#define X86_CPUID_STEXT_FEATURE_EBX_PQE RT_BIT_32(15)
577	/** EBX Bit 16 - AVX512F - Supports AVX512F. */
578	#define X86_CPUID_STEXT_FEATURE_EBX_AVX512F RT_BIT_32(16)
579	/** EBX Bit 18 - RDSEED - Supports RDSEED. */
580	#define X86_CPUID_STEXT_FEATURE_EBX_RDSEED RT_BIT_32(18)
581	/** EBX Bit 19 - ADX - Supports ADCX/ADOX. */
582	#define X86_CPUID_STEXT_FEATURE_EBX_ADX RT_BIT_32(19)
583	/** EBX Bit 20 - SMAP - Supports Supervisor Mode Access Prevention. */
584	#define X86_CPUID_STEXT_FEATURE_EBX_SMAP RT_BIT_32(20)
585	/** EBX Bit 23 - CLFLUSHOPT - Supports CLFLUSHOPT (Cache Line Flush). */
586	#define X86_CPUID_STEXT_FEATURE_EBX_CLFLUSHOPT RT_BIT_32(23)
587	/** EBX Bit 25 - INTEL_PT - Supports Intel Processor Trace. */
588	#define X86_CPUID_STEXT_FEATURE_EBX_INTEL_PT RT_BIT_32(25)
589	/** EBX Bit 26 - AVX512PF - Supports AVX512PF. */
590	#define X86_CPUID_STEXT_FEATURE_EBX_AVX512PF RT_BIT_32(26)
591	/** EBX Bit 27 - AVX512ER - Supports AVX512ER. */
592	#define X86_CPUID_STEXT_FEATURE_EBX_AVX512ER RT_BIT_32(27)
593	/** EBX Bit 28 - AVX512CD - Supports AVX512CD. */
594	#define X86_CPUID_STEXT_FEATURE_EBX_AVX512CD RT_BIT_32(28)
595	/** EBX Bit 29 - SHA - Supports Secure Hash Algorithm extensions. */
596	#define X86_CPUID_STEXT_FEATURE_EBX_SHA RT_BIT_32(29)
597
598	/** ECX Bit 0 - PREFETCHWT1 - Supports the PREFETCHWT1 instruction. */
599	#define X86_CPUID_STEXT_FEATURE_ECX_PREFETCHWT1 RT_BIT_32(0)
600	/** @} */
601
602
603	/** @name CPUID Extended Feature information.
604	* CPUID query with EAX=0x80000001.
605	* @{
606	*/
607	/** ECX Bit 0 - LAHF/SAHF support in 64-bit mode. */
608	#define X86_CPUID_EXT_FEATURE_ECX_LAHF_SAHF RT_BIT_32(0)
609
610	/** EDX Bit 11 - SYSCALL/SYSRET. */
611	#define X86_CPUID_EXT_FEATURE_EDX_SYSCALL RT_BIT_32(11)
612	/** EDX Bit 20 - No-Execute/Execute-Disable. */
613	#define X86_CPUID_EXT_FEATURE_EDX_NX RT_BIT_32(20)
614	/** EDX Bit 26 - 1 GB large page. */
615	#define X86_CPUID_EXT_FEATURE_EDX_PAGE1GB RT_BIT_32(26)
616	/** EDX Bit 27 - RDTSCP. */
617	#define X86_CPUID_EXT_FEATURE_EDX_RDTSCP RT_BIT_32(27)
618	/** EDX Bit 29 - AMD Long Mode/Intel-64 Instructions. */
619	#define X86_CPUID_EXT_FEATURE_EDX_LONG_MODE RT_BIT_32(29)
620	/** @}*/
621
622	/** @name CPUID AMD Feature information.
623	* CPUID query with EAX=0x80000001.
624	* @{
625	*/
626	/** Bit 0 - FPU - x87 FPU on Chip. */
627	#define X86_CPUID_AMD_FEATURE_EDX_FPU RT_BIT_32(0)
628	/** Bit 1 - VME - Virtual 8086 Mode Enhancements. */
629	#define X86_CPUID_AMD_FEATURE_EDX_VME RT_BIT_32(1)
630	/** Bit 2 - DE - Debugging extensions. */
631	#define X86_CPUID_AMD_FEATURE_EDX_DE RT_BIT_32(2)
632	/** Bit 3 - PSE - Page Size Extension. */
633	#define X86_CPUID_AMD_FEATURE_EDX_PSE RT_BIT_32(3)
634	/** Bit 4 - TSC - Time Stamp Counter. */
635	#define X86_CPUID_AMD_FEATURE_EDX_TSC RT_BIT_32(4)
636	/** Bit 5 - MSR - K86 Model Specific Registers RDMSR and WRMSR Instructions. */
637	#define X86_CPUID_AMD_FEATURE_EDX_MSR RT_BIT_32(5)
638	/** Bit 6 - PAE - Physical Address Extension. */
639	#define X86_CPUID_AMD_FEATURE_EDX_PAE RT_BIT_32(6)
640	/** Bit 7 - MCE - Machine Check Exception. */
641	#define X86_CPUID_AMD_FEATURE_EDX_MCE RT_BIT_32(7)
642	/** Bit 8 - CX8 - CMPXCHG8B instruction. */
643	#define X86_CPUID_AMD_FEATURE_EDX_CX8 RT_BIT_32(8)
644	/** Bit 9 - APIC - APIC On-Chip. */
645	#define X86_CPUID_AMD_FEATURE_EDX_APIC RT_BIT_32(9)
646	/** Bit 12 - MTRR - Memory Type Range Registers. */
647	#define X86_CPUID_AMD_FEATURE_EDX_MTRR RT_BIT_32(12)
648	/** Bit 13 - PGE - PTE Global Bit. */
649	#define X86_CPUID_AMD_FEATURE_EDX_PGE RT_BIT_32(13)
650	/** Bit 14 - MCA - Machine Check Architecture. */
651	#define X86_CPUID_AMD_FEATURE_EDX_MCA RT_BIT_32(14)
652	/** Bit 15 - CMOV - Conditional Move Instructions. */
653	#define X86_CPUID_AMD_FEATURE_EDX_CMOV RT_BIT_32(15)
654	/** Bit 16 - PAT - Page Attribute Table. */
655	#define X86_CPUID_AMD_FEATURE_EDX_PAT RT_BIT_32(16)
656	/** Bit 17 - PSE-36 - 36-bit Page Size Extension. */
657	#define X86_CPUID_AMD_FEATURE_EDX_PSE36 RT_BIT_32(17)
658	/** Bit 22 - AXMMX - AMD Extensions to MMX Instructions. */
659	#define X86_CPUID_AMD_FEATURE_EDX_AXMMX RT_BIT_32(22)
660	/** Bit 23 - MMX - Intel MMX Technology. */
661	#define X86_CPUID_AMD_FEATURE_EDX_MMX RT_BIT_32(23)
662	/** Bit 24 - FXSR - FXSAVE and FXRSTOR Instructions. */
663	#define X86_CPUID_AMD_FEATURE_EDX_FXSR RT_BIT_32(24)
664	/** Bit 25 - FFXSR - AMD fast FXSAVE and FXRSTOR Instructions. */
665	#define X86_CPUID_AMD_FEATURE_EDX_FFXSR RT_BIT_32(25)
666	/** Bit 30 - 3DNOWEXT - AMD Extensions to 3DNow. */
667	#define X86_CPUID_AMD_FEATURE_EDX_3DNOW_EX RT_BIT_32(30)
668	/** Bit 31 - 3DNOW - AMD 3DNow. */
669	#define X86_CPUID_AMD_FEATURE_EDX_3DNOW RT_BIT_32(31)
670
671	/** Bit 1 - CmpLegacy - Core multi-processing legacy mode. */
672	#define X86_CPUID_AMD_FEATURE_ECX_CMPL RT_BIT_32(1)
673	/** Bit 2 - SVM - AMD VM extensions. */
674	#define X86_CPUID_AMD_FEATURE_ECX_SVM RT_BIT_32(2)
675	/** Bit 3 - EXTAPIC - AMD extended APIC registers starting at 0x400. */
676	#define X86_CPUID_AMD_FEATURE_ECX_EXT_APIC RT_BIT_32(3)
677	/** Bit 4 - CR8L - AMD LOCK MOV CR0 means MOV CR8. */
678	#define X86_CPUID_AMD_FEATURE_ECX_CR8L RT_BIT_32(4)
679	/** Bit 5 - ABM - AMD Advanced bit manipulation. LZCNT instruction support. */
680	#define X86_CPUID_AMD_FEATURE_ECX_ABM RT_BIT_32(5)
681	/** Bit 6 - SSE4A - AMD EXTRQ, INSERTQ, MOVNTSS, and MOVNTSD instruction support. */
682	#define X86_CPUID_AMD_FEATURE_ECX_SSE4A RT_BIT_32(6)
683	/** Bit 7 - MISALIGNSSE - AMD Misaligned SSE mode. */
684	#define X86_CPUID_AMD_FEATURE_ECX_MISALNSSE RT_BIT_32(7)
685	/** Bit 8 - 3DNOWPRF - AMD PREFETCH and PREFETCHW instruction support. */
686	#define X86_CPUID_AMD_FEATURE_ECX_3DNOWPRF RT_BIT_32(8)
687	/** Bit 9 - OSVW - AMD OS visible workaround. */
688	#define X86_CPUID_AMD_FEATURE_ECX_OSVW RT_BIT_32(9)
689	/** Bit 10 - IBS - Instruct based sampling. */
690	#define X86_CPUID_AMD_FEATURE_ECX_IBS RT_BIT_32(10)
691	/** Bit 11 - XOP - Extended operation support (see APM6). */
692	#define X86_CPUID_AMD_FEATURE_ECX_XOP RT_BIT_32(11)
693	/** Bit 12 - SKINIT - AMD SKINIT: SKINIT, STGI, and DEV support. */
694	#define X86_CPUID_AMD_FEATURE_ECX_SKINIT RT_BIT_32(12)
695	/** Bit 13 - WDT - AMD Watchdog timer support. */
696	#define X86_CPUID_AMD_FEATURE_ECX_WDT RT_BIT_32(13)
697	/** Bit 15 - LWP - Lightweight profiling support. */
698	#define X86_CPUID_AMD_FEATURE_ECX_LWP RT_BIT_32(15)
699	/** Bit 16 - FMA4 - Four operand FMA instruction support. */
700	#define X86_CPUID_AMD_FEATURE_ECX_FMA4 RT_BIT_32(16)
701	/** Bit 19 - NodeId - Indicates support for
702	* MSR_C001_100C[NodeId,NodesPerProcessr]. */
703	#define X86_CPUID_AMD_FEATURE_ECX_NODEID RT_BIT_32(19)
704	/** Bit 21 - TBM - Trailing bit manipulation instruction support. */
705	#define X86_CPUID_AMD_FEATURE_ECX_TBM RT_BIT_32(21)
706	/** Bit 22 - TopologyExtensions - . */
707	#define X86_CPUID_AMD_FEATURE_ECX_TOPOEXT RT_BIT_32(22)
708	/** @} */
709
710
711	/** @name CPUID AMD Feature information.
712	* CPUID query with EAX=0x80000007.
713	* @{
714	*/
715	/** Bit 0 - TS - Temperature Sensor. */
716	#define X86_CPUID_AMD_ADVPOWER_EDX_TS RT_BIT_32(0)
717	/** Bit 1 - FID - Frequency ID Control. */
718	#define X86_CPUID_AMD_ADVPOWER_EDX_FID RT_BIT_32(1)
719	/** Bit 2 - VID - Voltage ID Control. */
720	#define X86_CPUID_AMD_ADVPOWER_EDX_VID RT_BIT_32(2)
721	/** Bit 3 - TTP - THERMTRIP. */
722	#define X86_CPUID_AMD_ADVPOWER_EDX_TTP RT_BIT_32(3)
723	/** Bit 4 - TM - Hardware Thermal Control. */
724	#define X86_CPUID_AMD_ADVPOWER_EDX_TM RT_BIT_32(4)
725	/** Bit 5 - STC - Software Thermal Control. */
726	#define X86_CPUID_AMD_ADVPOWER_EDX_STC RT_BIT_32(5)
727	/** Bit 6 - MC - 100 Mhz Multiplier Control. */
728	#define X86_CPUID_AMD_ADVPOWER_EDX_MC RT_BIT_32(6)
729	/** Bit 7 - HWPSTATE - Hardware P-State Control. */
730	#define X86_CPUID_AMD_ADVPOWER_EDX_HWPSTATE RT_BIT_32(7)
731	/** Bit 8 - TSCINVAR - TSC Invariant. */
732	#define X86_CPUID_AMD_ADVPOWER_EDX_TSCINVAR RT_BIT_32(8)
733	/** Bit 9 - CPB - TSC Invariant. */
734	#define X86_CPUID_AMD_ADVPOWER_EDX_CPB RT_BIT_32(9)
735	/** Bit 10 - EffFreqRO - MPERF/APERF. */
736	#define X86_CPUID_AMD_ADVPOWER_EDX_EFRO RT_BIT_32(10)
737	/** Bit 11 - PFI - Processor feedback interface (see EAX). */
738	#define X86_CPUID_AMD_ADVPOWER_EDX_PFI RT_BIT_32(11)
739	/** Bit 12 - PA - Processor accumulator (MSR c001_007a). */
740	#define X86_CPUID_AMD_ADVPOWER_EDX_PA RT_BIT_32(12)
741	/** @} */
742
743
744	/** @name CR0
745	* @remarks The 286 (MSW), 386 and 486 ignores attempts at setting
746	* reserved flags.
747	* @{ */
748	/** Bit 0 - PE - Protection Enabled */
749	#define X86_CR0_PE RT_BIT_32(0)
750	#define X86_CR0_PROTECTION_ENABLE RT_BIT_32(0)
751	/** Bit 1 - MP - Monitor Coprocessor */
752	#define X86_CR0_MP RT_BIT_32(1)
753	#define X86_CR0_MONITOR_COPROCESSOR RT_BIT_32(1)
754	/** Bit 2 - EM - Emulation. */
755	#define X86_CR0_EM RT_BIT_32(2)
756	#define X86_CR0_EMULATE_FPU RT_BIT_32(2)
757	/** Bit 3 - TS - Task Switch. */
758	#define X86_CR0_TS RT_BIT_32(3)
759	#define X86_CR0_TASK_SWITCH RT_BIT_32(3)
760	/** Bit 4 - ET - Extension flag. (386, 'hardcoded' to 1 on 486+) */
761	#define X86_CR0_ET RT_BIT_32(4)
762	#define X86_CR0_EXTENSION_TYPE RT_BIT_32(4)
763	/** Bit 5 - NE - Numeric error (486+). */
764	#define X86_CR0_NE RT_BIT_32(5)
765	#define X86_CR0_NUMERIC_ERROR RT_BIT_32(5)
766	/** Bit 16 - WP - Write Protect (486+). */
767	#define X86_CR0_WP RT_BIT_32(16)
768	#define X86_CR0_WRITE_PROTECT RT_BIT_32(16)
769	/** Bit 18 - AM - Alignment Mask (486+). */
770	#define X86_CR0_AM RT_BIT_32(18)
771	#define X86_CR0_ALIGMENT_MASK RT_BIT_32(18)
772	/** Bit 29 - NW - Not Write-though (486+). */
773	#define X86_CR0_NW RT_BIT_32(29)
774	#define X86_CR0_NOT_WRITE_THROUGH RT_BIT_32(29)
775	/** Bit 30 - WP - Cache Disable (486+). */
776	#define X86_CR0_CD RT_BIT_32(30)
777	#define X86_CR0_CACHE_DISABLE RT_BIT_32(30)
778	/** Bit 31 - PG - Paging. */
779	#define X86_CR0_PG RT_BIT_32(31)
780	#define X86_CR0_PAGING RT_BIT_32(31)
781	/** @} */
782
783
784	/** @name CR3
785	* @{ */
786	/** Bit 3 - PWT - Page-level Writes Transparent. */
787	#define X86_CR3_PWT RT_BIT_32(3)
788	/** Bit 4 - PCD - Page-level Cache Disable. */
789	#define X86_CR3_PCD RT_BIT_32(4)
790	/** Bits 12-31 - - Page directory page number. */
791	#define X86_CR3_PAGE_MASK (0xfffff000)
792	/** Bits 5-31 - - PAE Page directory page number. */
793	#define X86_CR3_PAE_PAGE_MASK (0xffffffe0)
794	/** Bits 12-51 - - AMD64 Page directory page number. */
795	#define X86_CR3_AMD64_PAGE_MASK UINT64_C(0x000ffffffffff000)
796	/** @} */
797
798
799	/** @name CR4
800	* @{ */
801	/** Bit 0 - VME - Virtual-8086 Mode Extensions. */
802	#define X86_CR4_VME RT_BIT_32(0)
803	/** Bit 1 - PVI - Protected-Mode Virtual Interrupts. */
804	#define X86_CR4_PVI RT_BIT_32(1)
805	/** Bit 2 - TSD - Time Stamp Disable. */
806	#define X86_CR4_TSD RT_BIT_32(2)
807	/** Bit 3 - DE - Debugging Extensions. */
808	#define X86_CR4_DE RT_BIT_32(3)
809	/** Bit 4 - PSE - Page Size Extension. */
810	#define X86_CR4_PSE RT_BIT_32(4)
811	/** Bit 5 - PAE - Physical Address Extension. */
812	#define X86_CR4_PAE RT_BIT_32(5)
813	/** Bit 6 - MCE - Machine-Check Enable. */
814	#define X86_CR4_MCE RT_BIT_32(6)
815	/** Bit 7 - PGE - Page Global Enable. */
816	#define X86_CR4_PGE RT_BIT_32(7)
817	/** Bit 8 - PCE - Performance-Monitoring Counter Enable. */
818	#define X86_CR4_PCE RT_BIT_32(8)
819	/** Bit 9 - OSFXSR - Operating System Support for FXSAVE and FXRSTORE instructions. */
820	#define X86_CR4_OSFXSR RT_BIT_32(9)
821	/** Bit 10 - OSXMMEEXCPT - Operating System Support for Unmasked SIMD Floating-Point Exceptions. */
822	#define X86_CR4_OSXMMEEXCPT RT_BIT_32(10)
823	/** Bit 13 - VMXE - VMX mode is enabled. */
824	#define X86_CR4_VMXE RT_BIT_32(13)
825	/** Bit 14 - SMXE - Safer Mode Extensions Enabled. */
826	#define X86_CR4_SMXE RT_BIT_32(14)
827	/** Bit 17 - PCIDE - Process-Context Identifiers Enabled. */
828	#define X86_CR4_PCIDE RT_BIT_32(17)
829	/** Bit 18 - OSXSAVE - Operating System Support for XSAVE and processor
830	* extended states. */
831	#define X86_CR4_OSXSAVE RT_BIT_32(18)
832	/** Bit 20 - SMEP - Supervisor-mode Execution Prevention enabled. */
833	#define X86_CR4_SMEP RT_BIT_32(20)
834	/** Bit 21 - SMAP - Supervisor-mode Access Prevention enabled. */
835	#define X86_CR4_SMAP RT_BIT_32(21)
836	/** Bit 22 - PKE - Protection Key Enable. */
837	#define X86_CR4_PKE RT_BIT_32(22)
838	/** @} */
839
840
841	/** @name DR6
842	* @{ */
843	/** Bit 0 - B0 - Breakpoint 0 condition detected. */
844	#define X86_DR6_B0 RT_BIT_32(0)
845	/** Bit 1 - B1 - Breakpoint 1 condition detected. */
846	#define X86_DR6_B1 RT_BIT_32(1)
847	/** Bit 2 - B2 - Breakpoint 2 condition detected. */
848	#define X86_DR6_B2 RT_BIT_32(2)
849	/** Bit 3 - B3 - Breakpoint 3 condition detected. */
850	#define X86_DR6_B3 RT_BIT_32(3)
851	/** Mask of all the Bx bits. */
852	#define X86_DR6_B_MASK UINT64_C(0x0000000f)
853	/** Bit 13 - BD - Debug register access detected. Corresponds to the X86_DR7_GD bit. */
854	#define X86_DR6_BD RT_BIT_32(13)
855	/** Bit 14 - BS - Single step */
856	#define X86_DR6_BS RT_BIT_32(14)
857	/** Bit 15 - BT - Task switch. (TSS T bit.) */
858	#define X86_DR6_BT RT_BIT_32(15)
859	/** Value of DR6 after powerup/reset. */
860	#define X86_DR6_INIT_VAL UINT64_C(0xFFFF0FF0)
861	/** Bits which must be 1s in DR6. */
862	#define X86_DR6_RA1_MASK UINT64_C(0xffff0ff0)
863	/** Bits which must be 0s in DR6. */
864	#define X86_DR6_RAZ_MASK RT_BIT_64(12)
865	/** Bits which must be 0s on writes to DR6. */
866	#define X86_DR6_MBZ_MASK UINT64_C(0xffffffff00000000)
867	/** @} */
868
869	/** Get the DR6.Bx bit for a the given breakpoint. */
870	#define X86_DR6_B(iBp) RT_BIT_64(iBp)
871
872
873	/** @name DR7
874	* @{ */
875	/** Bit 0 - L0 - Local breakpoint enable. Cleared on task switch. */
876	#define X86_DR7_L0 RT_BIT_32(0)
877	/** Bit 1 - G0 - Global breakpoint enable. Not cleared on task switch. */
878	#define X86_DR7_G0 RT_BIT_32(1)
879	/** Bit 2 - L1 - Local breakpoint enable. Cleared on task switch. */
880	#define X86_DR7_L1 RT_BIT_32(2)
881	/** Bit 3 - G1 - Global breakpoint enable. Not cleared on task switch. */
882	#define X86_DR7_G1 RT_BIT_32(3)
883	/** Bit 4 - L2 - Local breakpoint enable. Cleared on task switch. */
884	#define X86_DR7_L2 RT_BIT_32(4)
885	/** Bit 5 - G2 - Global breakpoint enable. Not cleared on task switch. */
886	#define X86_DR7_G2 RT_BIT_32(5)
887	/** Bit 6 - L3 - Local breakpoint enable. Cleared on task switch. */
888	#define X86_DR7_L3 RT_BIT_32(6)
889	/** Bit 7 - G3 - Global breakpoint enable. Not cleared on task switch. */
890	#define X86_DR7_G3 RT_BIT_32(7)
891	/** Bit 8 - LE - Local breakpoint exact. (Not supported (read ignored) by P6 and later.) */
892	#define X86_DR7_LE RT_BIT_32(8)
893	/** Bit 9 - GE - Local breakpoint exact. (Not supported (read ignored) by P6 and later.) */
894	#define X86_DR7_GE RT_BIT_32(9)
895
896	/** L0, L1, L2, and L3. */
897	#define X86_DR7_LE_ALL UINT64_C(0x0000000000000055)
898	/** L0, L1, L2, and L3. */
899	#define X86_DR7_GE_ALL UINT64_C(0x00000000000000aa)
900
901	/** Bit 12 - IR (ICE) - Interrupt redirection on Pentium. When set, the in
902	* Circuit Emulator (ICE) will break emulation on breakpoints and stuff.
903	* May cause CPU hang if enabled without ICE attached when the ICEBP/INT1
904	* instruction is executed.
905	* @see http://www.rcollins.org/secrets/DR7.html */
906	#define X86_DR7_ICE_IR RT_BIT_32(12)
907	/** Bit 13 - GD - General detect enable. Enables emulators to get exceptions when
908	* any DR register is accessed. */
909	#define X86_DR7_GD RT_BIT_32(13)
910	/** Bit 14 - TR1 (ICE) - Code discontinuity trace for use with ICE on
911	* Pentium. */
912	#define X86_DR7_ICE_TR1 RT_BIT_32(14)
913	/** Bit 15 - TR2 (ICE) - Controls unknown ICE trace feature of the pentium. */
914	#define X86_DR7_ICE_TR2 RT_BIT_32(15)
915	/** Bit 16 & 17 - R/W0 - Read write field 0. Values X86_DR7_RW_. /
916	#define X86_DR7_RW0_MASK (3 << 16)
917	/** Bit 18 & 19 - LEN0 - Length field 0. Values X86_DR7_LEN_. /
918	#define X86_DR7_LEN0_MASK (3 << 18)
919	/** Bit 20 & 21 - R/W1 - Read write field 0. Values X86_DR7_RW_. /
920	#define X86_DR7_RW1_MASK (3 << 20)
921	/** Bit 22 & 23 - LEN1 - Length field 0. Values X86_DR7_LEN_. /
922	#define X86_DR7_LEN1_MASK (3 << 22)
923	/** Bit 24 & 25 - R/W2 - Read write field 0. Values X86_DR7_RW_. /
924	#define X86_DR7_RW2_MASK (3 << 24)
925	/** Bit 26 & 27 - LEN2 - Length field 0. Values X86_DR7_LEN_. /
926	#define X86_DR7_LEN2_MASK (3 << 26)
927	/** Bit 28 & 29 - R/W3 - Read write field 0. Values X86_DR7_RW_. /
928	#define X86_DR7_RW3_MASK (3 << 28)
929	/** Bit 30 & 31 - LEN3 - Length field 0. Values X86_DR7_LEN_. /
930	#define X86_DR7_LEN3_MASK (3 << 30)
931
932	/** Bits which reads as 1s. */
933	#define X86_DR7_RA1_MASK RT_BIT_32(10)
934	/** Bits which reads as zeros. These are related to ICE (bits 12, 14, 15). */
935	#define X86_DR7_RAZ_MASK UINT64_C(0x0000d800)
936	/** Bits which must be 0s when writing to DR7. */
937	#define X86_DR7_MBZ_MASK UINT64_C(0xffffffff00000000)
938
939	/** Calcs the L bit of Nth breakpoint.
940	* @param iBp The breakpoint number [0..3].
941	*/
942	#define X86_DR7_L(iBp) ( UINT32_C(1) << (iBp * 2) )
943
944	/** Calcs the G bit of Nth breakpoint.
945	* @param iBp The breakpoint number [0..3].
946	*/
947	#define X86_DR7_G(iBp) ( UINT32_C(1) << (iBp * 2 + 1) )
948
949	/** Calcs the L and G bits of Nth breakpoint.
950	* @param iBp The breakpoint number [0..3].
951	*/
952	#define X86_DR7_L_G(iBp) ( UINT32_C(3) << (iBp * 2) )
953
954	/** @name Read/Write values.
955	* @{ */
956	/** Break on instruction fetch only. */
957	#define X86_DR7_RW_EO 0U
958	/** Break on write only. */
959	#define X86_DR7_RW_WO 1U
960	/** Break on I/O read/write. This is only defined if CR4.DE is set. */
961	#define X86_DR7_RW_IO 2U
962	/** Break on read or write (but not instruction fetches). */
963	#define X86_DR7_RW_RW 3U
964	/** @} */
965
966	/** Shifts a X86_DR7_RW_* value to its right place.
967	* @param iBp The breakpoint number [0..3].
968	* @param fRw One of the X86_DR7_RW_* value.
969	*/
970	#define X86_DR7_RW(iBp, fRw) ( (fRw) << ((iBp) * 4 + 16) )
971
972	/** Fetch the R/Wx bits for a given breakpoint (so it can be compared with
973	* one of the X86_DR7_RW_XXX constants).
974	*
975	* @returns X86_DR7_RW_XXX
976	* @param uDR7 DR7 value
977	* @param iBp The breakpoint number [0..3].
978	*/
979	#define X86_DR7_GET_RW(uDR7, iBp) ( ( (uDR7) >> ((iBp) * 4 + 16) ) & UINT32_C(3) )
980
981	/** R/W0, R/W1, R/W2, and R/W3. */
982	#define X86_DR7_RW_ALL_MASKS UINT32_C(0x33330000)
983
984	#ifndef VBOX_FOR_DTRACE_LIB
985	/** Checks if there are any I/O breakpoint types configured in the RW
986	* registers. Does NOT check if these are enabled, sorry. */
987	# define X86_DR7_ANY_RW_IO(uDR7) \
988	( ( UINT32_C(0x22220000) & (uDR7) ) /* any candidates? */ \
989	&& ( ( (UINT32_C(0x22220000) & (uDR7) ) >> 1 ) & ~(uDR7) ) )
990	AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x33330000)) == 0);
991	AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x22220000)) == 1);
992	AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x32320000)) == 1);
993	AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x23230000)) == 1);
994	AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x00000000)) == 0);
995	AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x00010000)) == 0);
996	AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x00020000)) == 1);
997	AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x00030000)) == 0);
998	AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x00040000)) == 0);
999	#endif /* !VBOX_FOR_DTRACE_LIB */
1000
1001	/** @name Length values.
1002	* @{ */
1003	#define X86_DR7_LEN_BYTE 0U
1004	#define X86_DR7_LEN_WORD 1U
1005	#define X86_DR7_LEN_QWORD 2U /*< AMD64 long mode only. /
1006	#define X86_DR7_LEN_DWORD 3U
1007	/** @} */
1008
1009	/** Shifts a X86_DR7_LEN_* value to its right place.
1010	* @param iBp The breakpoint number [0..3].
1011	* @param cb One of the X86_DR7_LEN_* values.
1012	*/
1013	#define X86_DR7_LEN(iBp, cb) ( (cb) << ((iBp) * 4 + 18) )
1014
1015	/** Fetch the breakpoint length bits from the DR7 value.
1016	* @param uDR7 DR7 value
1017	* @param iBp The breakpoint number [0..3].
1018	*/
1019	#define X86_DR7_GET_LEN(uDR7, iBp) ( ( (uDR7) >> ((iBp) * 4 + 18) ) & UINT32_C(0x3) )
1020
1021	/** Mask used to check if any breakpoints are enabled. */
1022	#define X86_DR7_ENABLED_MASK UINT32_C(0x000000ff)
1023
1024	/** LEN0, LEN1, LEN2, and LEN3. */
1025	#define X86_DR7_LEN_ALL_MASKS UINT32_C(0xcccc0000)
1026	/** R/W0, R/W1, R/W2, R/W3,LEN0, LEN1, LEN2, and LEN3. */
1027	#define X86_DR7_RW_LEN_ALL_MASKS UINT32_C(0xffff0000)
1028
1029	/** Value of DR7 after powerup/reset. */
1030	#define X86_DR7_INIT_VAL 0x400
1031	/** @} */
1032
1033
1034	/** @name Machine Specific Registers
1035	* @{
1036	*/
1037	/** Machine check address register (P5). */
1038	#define MSR_P5_MC_ADDR UINT32_C(0x00000000)
1039	/** Machine check type register (P5). */
1040	#define MSR_P5_MC_TYPE UINT32_C(0x00000001)
1041	/** Time Stamp Counter. */
1042	#define MSR_IA32_TSC 0x10
1043	#define MSR_IA32_CESR UINT32_C(0x00000011)
1044	#define MSR_IA32_CTR0 UINT32_C(0x00000012)
1045	#define MSR_IA32_CTR1 UINT32_C(0x00000013)
1046
1047	#define MSR_IA32_PLATFORM_ID 0x17
1048
1049	#ifndef MSR_IA32_APICBASE /* qemu cpu.h kludge */
1050	# define MSR_IA32_APICBASE 0x1b
1051	/** Local APIC enabled. */
1052	# define MSR_IA32_APICBASE_EN RT_BIT_64(11)
1053	/** X2APIC enabled (requires the EN bit to be set). */
1054	# define MSR_IA32_APICBASE_EXTD RT_BIT_64(10)
1055	/** The processor is the boot strap processor (BSP). */
1056	# define MSR_IA32_APICBASE_BSP RT_BIT_64(8)
1057	/** Minimum base address mask, consult CPUID leaf 0x80000008 for the actual
1058	* width. */
1059	# define MSR_IA32_APICBASE_BASE_MIN UINT64_C(0x0000000ffffff000)
1060	/** The default physical base address of the APIC. */
1061	# define MSR_IA32_APICBASE_ADDR UINT64_C(0x00000000fee00000)
1062	/** Gets the physical base address from the MSR. */
1063	# define MSR_IA32_APICBASE_GET_ADDR(a_Msr) ((a_Msr) & X86_PAGE_4K_BASE_MASK)
1064	#endif
1065
1066	/** Undocumented intel MSR for reporting thread and core counts.
1067	* Judging from the XNU sources, it seems to be introduced in Nehalem. The
1068	* first 16 bits is the thread count. The next 16 bits the core count, except
1069	* on Westmere where it seems it's only the next 4 bits for some reason. */
1070	#define MSR_CORE_THREAD_COUNT 0x35
1071
1072	/** CPU Feature control. */
1073	#define MSR_IA32_FEATURE_CONTROL 0x3A
1074	#define MSR_IA32_FEATURE_CONTROL_LOCK RT_BIT_32(0)
1075	#define MSR_IA32_FEATURE_CONTROL_SMX_VMXON RT_BIT_32(1)
1076	#define MSR_IA32_FEATURE_CONTROL_VMXON RT_BIT_32(2)
1077
1078	/** Per-processor TSC adjust MSR. */
1079	#define MSR_IA32_TSC_ADJUST 0x3B
1080
1081	/** BIOS update trigger (microcode update). */
1082	#define MSR_IA32_BIOS_UPDT_TRIG 0x79
1083
1084	/** BIOS update signature (microcode). */
1085	#define MSR_IA32_BIOS_SIGN_ID 0x8B
1086
1087	/** SMM monitor control. */
1088	#define MSR_IA32_SMM_MONITOR_CTL 0x9B
1089
1090	/** General performance counter no. 0. */
1091	#define MSR_IA32_PMC0 0xC1
1092	/** General performance counter no. 1. */
1093	#define MSR_IA32_PMC1 0xC2
1094	/** General performance counter no. 2. */
1095	#define MSR_IA32_PMC2 0xC3
1096	/** General performance counter no. 3. */
1097	#define MSR_IA32_PMC3 0xC4
1098
1099	/** Nehalem power control. */
1100	#define MSR_IA32_PLATFORM_INFO 0xCE
1101
1102	/** Get FSB clock status (Intel-specific). */
1103	#define MSR_IA32_FSB_CLOCK_STS 0xCD
1104
1105	/** C-State configuration control. Intel specific: Nehalem, Sandy Bridge. */
1106	#define MSR_PKG_CST_CONFIG_CONTROL UINT32_C(0x000000e2)
1107
1108	/** C0 Maximum Frequency Clock Count */
1109	#define MSR_IA32_MPERF 0xE7
1110	/** C0 Actual Frequency Clock Count */
1111	#define MSR_IA32_APERF 0xE8
1112
1113	/** MTRR Capabilities. */
1114	#define MSR_IA32_MTRR_CAP 0xFE
1115
1116	/** Cache control/info. */
1117	#define MSR_BBL_CR_CTL3 UINT32_C(0x11e)
1118
1119	#ifndef MSR_IA32_SYSENTER_CS /* qemu cpu.h kludge */
1120	/** SYSENTER_CS - the R0 CS, indirectly giving R0 SS, R3 CS and R3 DS.
1121	* R0 SS == CS + 8
1122	* R3 CS == CS + 16
1123	* R3 SS == CS + 24
1124	*/
1125	#define MSR_IA32_SYSENTER_CS 0x174
1126	/** SYSENTER_ESP - the R0 ESP. */
1127	#define MSR_IA32_SYSENTER_ESP 0x175
1128	/** SYSENTER_EIP - the R0 EIP. */
1129	#define MSR_IA32_SYSENTER_EIP 0x176
1130	#endif
1131
1132	/** Machine Check Global Capabilities Register. */
1133	#define MSR_IA32_MCG_CAP 0x179
1134	/** Machine Check Global Status Register. */
1135	#define MSR_IA32_MCG_STATUS 0x17A
1136	/** Machine Check Global Control Register. */
1137	#define MSR_IA32_MCG_CTRL 0x17B
1138
1139	/** Page Attribute Table. */
1140	#define MSR_IA32_CR_PAT 0x277
1141
1142	/** Performance counter MSRs. (Intel only) */
1143	#define MSR_IA32_PERFEVTSEL0 0x186
1144	#define MSR_IA32_PERFEVTSEL1 0x187
1145	/** Flexible ratio, seems to be undocumented, used by XNU (tsc.c).
1146	* The 16th bit whether flex ratio is being used, in which case bits 15:8
1147	* holds a ratio that Apple takes for TSC granularity.
1148	*
1149	* @note This MSR conflicts the P4 MSR_MCG_R12 register. */
1150	#define MSR_FLEX_RATIO 0x194
1151	/** Performance state value and starting with Intel core more.
1152	* Apple uses the >=core features to determine TSC granularity on older CPUs. */
1153	#define MSR_IA32_PERF_STATUS 0x198
1154	#define MSR_IA32_PERF_CTL 0x199
1155	#define MSR_IA32_THERM_STATUS 0x19c
1156
1157	/** Enable misc. processor features (R/W). */
1158	#define MSR_IA32_MISC_ENABLE 0x1A0
1159	/** Enable fast-strings feature (for REP MOVS and REP STORS). */
1160	#define MSR_IA32_MISC_ENABLE_FAST_STRINGS RT_BIT_64(0)
1161	/** Automatic Thermal Control Circuit Enable (R/W). */
1162	#define MSR_IA32_MISC_ENABLE_TCC RT_BIT_64(3)
1163	/** Performance Monitoring Available (R). */
1164	#define MSR_IA32_MISC_ENABLE_PERF_MON RT_BIT_64(7)
1165	/** Branch Trace Storage Unavailable (R/O). */
1166	#define MSR_IA32_MISC_ENABLE_BTS_UNAVAIL RT_BIT_64(11)
1167	/** Precise Event Based Sampling (PEBS) Unavailable (R/O). */
1168	#define MSR_IA32_MISC_ENABLE_PEBS_UNAVAIL RT_BIT_64(12)
1169	/** Enhanced Intel SpeedStep Technology Enable (R/W). */
1170	#define MSR_IA32_MISC_ENABLE_SST_ENABLE RT_BIT_64(16)
1171	/** If MONITOR/MWAIT is supported (R/W). */
1172	#define MSR_IA32_MISC_ENABLE_MONITOR RT_BIT_64(18)
1173	/** Limit CPUID Maxval to 3 leafs (R/W). */
1174	#define MSR_IA32_MISC_ENABLE_LIMIT_CPUID RT_BIT_64(22)
1175	/** When set to 1, xTPR messages are disabled (R/W). */
1176	#define MSR_IA32_MISC_ENABLE_XTPR_MSG_DISABLE RT_BIT_64(23)
1177	/** When set to 1, the Execute Disable Bit feature (XD Bit) is disabled (R/W). */
1178	#define MSR_IA32_MISC_ENABLE_XD_DISABLE RT_BIT_64(34)
1179
1180	/** Trace/Profile Resource Control (R/W) */
1181	#define MSR_IA32_DEBUGCTL UINT32_C(0x000001d9)
1182	/** The number (0..3 or 0..15) of the last branch record register on P4 and
1183	* related Xeons. */
1184	#define MSR_P4_LASTBRANCH_TOS UINT32_C(0x000001da)
1185	/** @name Last branch registers for P4 and Xeon, models 0 thru 2.
1186	* @{ */
1187	#define MSR_P4_LASTBRANCH_0 UINT32_C(0x000001db)
1188	#define MSR_P4_LASTBRANCH_1 UINT32_C(0x000001dc)
1189	#define MSR_P4_LASTBRANCH_2 UINT32_C(0x000001dd)
1190	#define MSR_P4_LASTBRANCH_3 UINT32_C(0x000001de)
1191	/** @} */
1192
1193
1194	#define IA32_MTRR_PHYSBASE0 0x200
1195	#define IA32_MTRR_PHYSMASK0 0x201
1196	#define IA32_MTRR_PHYSBASE1 0x202
1197	#define IA32_MTRR_PHYSMASK1 0x203
1198	#define IA32_MTRR_PHYSBASE2 0x204
1199	#define IA32_MTRR_PHYSMASK2 0x205
1200	#define IA32_MTRR_PHYSBASE3 0x206
1201	#define IA32_MTRR_PHYSMASK3 0x207
1202	#define IA32_MTRR_PHYSBASE4 0x208
1203	#define IA32_MTRR_PHYSMASK4 0x209
1204	#define IA32_MTRR_PHYSBASE5 0x20a
1205	#define IA32_MTRR_PHYSMASK5 0x20b
1206	#define IA32_MTRR_PHYSBASE6 0x20c
1207	#define IA32_MTRR_PHYSMASK6 0x20d
1208	#define IA32_MTRR_PHYSBASE7 0x20e
1209	#define IA32_MTRR_PHYSMASK7 0x20f
1210	#define IA32_MTRR_PHYSBASE8 0x210
1211	#define IA32_MTRR_PHYSMASK8 0x211
1212	#define IA32_MTRR_PHYSBASE9 0x212
1213	#define IA32_MTRR_PHYSMASK9 0x213
1214
1215	/** Fixed range MTRRs.
1216	* @{ */
1217	#define IA32_MTRR_FIX64K_00000 0x250
1218	#define IA32_MTRR_FIX16K_80000 0x258
1219	#define IA32_MTRR_FIX16K_A0000 0x259
1220	#define IA32_MTRR_FIX4K_C0000 0x268
1221	#define IA32_MTRR_FIX4K_C8000 0x269
1222	#define IA32_MTRR_FIX4K_D0000 0x26a
1223	#define IA32_MTRR_FIX4K_D8000 0x26b
1224	#define IA32_MTRR_FIX4K_E0000 0x26c
1225	#define IA32_MTRR_FIX4K_E8000 0x26d
1226	#define IA32_MTRR_FIX4K_F0000 0x26e
1227	#define IA32_MTRR_FIX4K_F8000 0x26f
1228	/** @} */
1229
1230	/** MTRR Default Range. */
1231	#define MSR_IA32_MTRR_DEF_TYPE 0x2FF
1232
1233	/** Global performance counter control facilities (Intel only). */
1234	#define MSR_IA32_PERF_GLOBAL_STATUS 0x38E
1235	#define MSR_IA32_PERF_GLOBAL_CTRL 0x38F
1236	#define MSR_IA32_PERF_GLOBAL_OVF_CTRL 0x390
1237
1238	/** Precise Event Based sampling (Intel only). */
1239	#define MSR_IA32_PEBS_ENABLE 0x3F1
1240
1241	#define MSR_IA32_MC0_CTL 0x400
1242	#define MSR_IA32_MC0_STATUS 0x401
1243
1244	/** Basic VMX information. */
1245	#define MSR_IA32_VMX_BASIC_INFO 0x480
1246	/** Allowed settings for pin-based VM execution controls */
1247	#define MSR_IA32_VMX_PINBASED_CTLS 0x481
1248	/** Allowed settings for proc-based VM execution controls */
1249	#define MSR_IA32_VMX_PROCBASED_CTLS 0x482
1250	/** Allowed settings for the VMX exit controls. */
1251	#define MSR_IA32_VMX_EXIT_CTLS 0x483
1252	/** Allowed settings for the VMX entry controls. */
1253	#define MSR_IA32_VMX_ENTRY_CTLS 0x484
1254	/** Misc VMX info. */
1255	#define MSR_IA32_VMX_MISC 0x485
1256	/** Fixed cleared bits in CR0. */
1257	#define MSR_IA32_VMX_CR0_FIXED0 0x486
1258	/** Fixed set bits in CR0. */
1259	#define MSR_IA32_VMX_CR0_FIXED1 0x487
1260	/** Fixed cleared bits in CR4. */
1261	#define MSR_IA32_VMX_CR4_FIXED0 0x488
1262	/** Fixed set bits in CR4. */
1263	#define MSR_IA32_VMX_CR4_FIXED1 0x489
1264	/** Information for enumerating fields in the VMCS. */
1265	#define MSR_IA32_VMX_VMCS_ENUM 0x48A
1266	/** Allowed settings for the VM-functions controls. */
1267	#define MSR_IA32_VMX_VMFUNC 0x491
1268	/** Allowed settings for secondary proc-based VM execution controls */
1269	#define MSR_IA32_VMX_PROCBASED_CTLS2 0x48B
1270	/** EPT capabilities. */
1271	#define MSR_IA32_VMX_EPT_VPID_CAP 0x48C
1272	/** Allowed settings of all pin-based VM execution controls. */
1273	#define MSR_IA32_VMX_TRUE_PINBASED_CTLS 0x48D
1274	/** Allowed settings of all proc-based VM execution controls. */
1275	#define MSR_IA32_VMX_TRUE_PROCBASED_CTLS 0x48E
1276	/** Allowed settings of all VMX exit controls. */
1277	#define MSR_IA32_VMX_TRUE_EXIT_CTLS 0x48F
1278	/** Allowed settings of all VMX entry controls. */
1279	#define MSR_IA32_VMX_TRUE_ENTRY_CTLS 0x490
1280
1281	/** DS Save Area (R/W). */
1282	#define MSR_IA32_DS_AREA 0x600
1283	/** Running Average Power Limit (RAPL) power units. */
1284	#define MSR_RAPL_POWER_UNIT 0x606
1285
1286	/** X2APIC MSR range start. */
1287	#define MSR_IA32_X2APIC_START 0x800
1288	/** X2APIC MSR - APIC ID Register. */
1289	#define MSR_IA32_X2APIC_ID 0x802
1290	/** X2APIC MSR - APIC Version Register. */
1291	#define MSR_IA32_X2APIC_VERSION 0x803
1292	/** X2APIC MSR - Task Priority Register. */
1293	#define MSR_IA32_X2APIC_TPR 0x808
1294	/** X2APIC MSR - Processor Priority register. */
1295	#define MSR_IA32_X2APIC_PPR 0x80A
1296	/** X2APIC MSR - End Of Interrupt register. */
1297	#define MSR_IA32_X2APIC_EOI 0x80B
1298	/** X2APIC MSR - Logical Destination Register. */
1299	#define MSR_IA32_X2APIC_LDR 0x80D
1300	/** X2APIC MSR - Spurious Interrupt Vector Register. */
1301	#define MSR_IA32_X2APIC_SVR 0x80F
1302	/** X2APIC MSR - In-service Register (bits 31:0). */
1303	#define MSR_IA32_X2APIC_ISR0 0x810
1304	/** X2APIC MSR - In-service Register (bits 63:32). */
1305	#define MSR_IA32_X2APIC_ISR1 0x811
1306	/** X2APIC MSR - In-service Register (bits 95:64). */
1307	#define MSR_IA32_X2APIC_ISR2 0x812
1308	/** X2APIC MSR - In-service Register (bits 127:96). */
1309	#define MSR_IA32_X2APIC_ISR3 0x813
1310	/** X2APIC MSR - In-service Register (bits 159:128). */
1311	#define MSR_IA32_X2APIC_ISR4 0x814
1312	/** X2APIC MSR - In-service Register (bits 191:160). */
1313	#define MSR_IA32_X2APIC_ISR5 0x815
1314	/** X2APIC MSR - In-service Register (bits 223:192). */
1315	#define MSR_IA32_X2APIC_ISR6 0x816
1316	/** X2APIC MSR - In-service Register (bits 255:224). */
1317	#define MSR_IA32_X2APIC_ISR7 0x817
1318	/** X2APIC MSR - Trigger Mode Register (bits 31:0). */
1319	#define MSR_IA32_X2APIC_TMR0 0x818
1320	/** X2APIC MSR - Trigger Mode Register (bits 63:32). */
1321	#define MSR_IA32_X2APIC_TMR1 0x819
1322	/** X2APIC MSR - Trigger Mode Register (bits 95:64). */
1323	#define MSR_IA32_X2APIC_TMR2 0x81A
1324	/** X2APIC MSR - Trigger Mode Register (bits 127:96). */
1325	#define MSR_IA32_X2APIC_TMR3 0x81B
1326	/** X2APIC MSR - Trigger Mode Register (bits 159:128). */
1327	#define MSR_IA32_X2APIC_TMR4 0x81C
1328	/** X2APIC MSR - Trigger Mode Register (bits 191:160). */
1329	#define MSR_IA32_X2APIC_TMR5 0x81D
1330	/** X2APIC MSR - Trigger Mode Register (bits 223:192). */
1331	#define MSR_IA32_X2APIC_TMR6 0x81E
1332	/** X2APIC MSR - Trigger Mode Register (bits 255:224). */
1333	#define MSR_IA32_X2APIC_TMR7 0x81F
1334	/** X2APIC MSR - Interrupt Request Register (bits 31:0). */
1335	#define MSR_IA32_X2APIC_IRR0 0x820
1336	/** X2APIC MSR - Interrupt Request Register (bits 63:32). */
1337	#define MSR_IA32_X2APIC_IRR1 0x821
1338	/** X2APIC MSR - Interrupt Request Register (bits 95:64). */
1339	#define MSR_IA32_X2APIC_IRR2 0x822
1340	/** X2APIC MSR - Interrupt Request Register (bits 127:96). */
1341	#define MSR_IA32_X2APIC_IRR3 0x823
1342	/** X2APIC MSR - Interrupt Request Register (bits 159:128). */
1343	#define MSR_IA32_X2APIC_IRR4 0x824
1344	/** X2APIC MSR - Interrupt Request Register (bits 191:160). */
1345	#define MSR_IA32_X2APIC_IRR5 0x825
1346	/** X2APIC MSR - Interrupt Request Register (bits 223:192). */
1347	#define MSR_IA32_X2APIC_IRR6 0x826
1348	/** X2APIC MSR - Interrupt Request Register (bits 255:224). */
1349	#define MSR_IA32_X2APIC_IRR7 0x827
1350	/** X2APIC MSR - Error Status Register. */
1351	#define MSR_IA32_X2APIC_ESR 0x828
1352	/** X2APIC MSR - LVT CMCI Register. */
1353	#define MSR_IA32_X2APIC_LVT_CMCI 0x82F
1354	/** X2APIC MSR - Interrupt Command Register. */
1355	#define MSR_IA32_X2APIC_ICR 0x830
1356	/** X2APIC MSR - LVT Timer Register. */
1357	#define MSR_IA32_X2APIC_LVT_TIMER 0x832
1358	/** X2APIC MSR - LVT Thermal Sensor Register. */
1359	#define MSR_IA32_X2APIC_LVT_THERMAL 0x833
1360	/** X2APIC MSR - LVT Performance Counter Register. */
1361	#define MSR_IA32_X2APIC_LVT_PERF 0x834
1362	/** X2APIC MSR - LVT LINT0 Register. */
1363	#define MSR_IA32_X2APIC_LVT_LINT0 0x835
1364	/** X2APIC MSR - LVT LINT1 Register. */
1365	#define MSR_IA32_X2APIC_LVT_LINT1 0x836
1366	/** X2APIC MSR - LVT Error Register . */
1367	#define MSR_IA32_X2APIC_LVT_ERROR 0x837
1368	/** X2APIC MSR - Timer Initial Count Register. */
1369	#define MSR_IA32_X2APIC_TIMER_ICR 0x838
1370	/** X2APIC MSR - Timer Current Count Register. */
1371	#define MSR_IA32_X2APIC_TIMER_CCR 0x839
1372	/** X2APIC MSR - Timer Divide Configuration Register. */
1373	#define MSR_IA32_X2APIC_TIMER_DCR 0x83E
1374	/** X2APIC MSR - Self IPI. */
1375	#define MSR_IA32_X2APIC_SELF_IPI 0x83F
1376	/** X2APIC MSR range end. */
1377	#define MSR_IA32_X2APIC_END 0xBFF
1378	/** X2APIC MSR - LVT start range. */
1379	#define MSR_IA32_X2APIC_LVT_START MSR_IA32_X2APIC_LVT_TIMER
1380	/** X2APIC MSR - LVT end range (inclusive). */
1381	#define MSR_IA32_X2APIC_LVT_END MSR_IA32_X2APIC_LVT_ERROR
1382
1383	/** K6 EFER - Extended Feature Enable Register. */
1384	#define MSR_K6_EFER UINT32_C(0xc0000080)
1385	/** @todo document EFER */
1386	/** Bit 0 - SCE - System call extensions (SYSCALL / SYSRET). (R/W) */
1387	#define MSR_K6_EFER_SCE RT_BIT_32(0)
1388	/** Bit 8 - LME - Long mode enabled. (R/W) */
1389	#define MSR_K6_EFER_LME RT_BIT_32(8)
1390	/** Bit 10 - LMA - Long mode active. (R) */
1391	#define MSR_K6_EFER_LMA RT_BIT_32(10)
1392	/** Bit 11 - NXE - No-Execute Page Protection Enabled. (R/W) */
1393	#define MSR_K6_EFER_NXE RT_BIT_32(11)
1394	#define MSR_K6_EFER_BIT_NXE 11 /*< Bit number of MSR_K6_EFER_NXE /
1395	/** Bit 12 - SVME - Secure VM Extension Enabled. (R/W) */
1396	#define MSR_K6_EFER_SVME RT_BIT_32(12)
1397	/** Bit 13 - LMSLE - Long Mode Segment Limit Enable. (R/W?) */
1398	#define MSR_K6_EFER_LMSLE RT_BIT_32(13)
1399	/** Bit 14 - FFXSR - Fast FXSAVE / FXRSTOR (skip XMM). (R/W) /
1400	#define MSR_K6_EFER_FFXSR RT_BIT_32(14)
1401	/** Bit 15 - TCE - Translation Cache Extension. (R/W) */
1402	#define MSR_K6_EFER_TCE RT_BIT_32(15)
1403	/** K6 STAR - SYSCALL/RET targets. */
1404	#define MSR_K6_STAR UINT32_C(0xc0000081)
1405	/** Shift value for getting the SYSRET CS and SS value. */
1406	#define MSR_K6_STAR_SYSRET_CS_SS_SHIFT 48
1407	/** Shift value for getting the SYSCALL CS and SS value. */
1408	#define MSR_K6_STAR_SYSCALL_CS_SS_SHIFT 32
1409	/** Selector mask for use after shifting. */
1410	#define MSR_K6_STAR_SEL_MASK UINT32_C(0xffff)
1411	/** The mask which give the SYSCALL EIP. */
1412	#define MSR_K6_STAR_SYSCALL_EIP_MASK UINT32_C(0xffffffff)
1413	/** K6 WHCR - Write Handling Control Register. */
1414	#define MSR_K6_WHCR UINT32_C(0xc0000082)
1415	/** K6 UWCCR - UC/WC Cacheability Control Register. */
1416	#define MSR_K6_UWCCR UINT32_C(0xc0000085)
1417	/** K6 PSOR - Processor State Observability Register. */
1418	#define MSR_K6_PSOR UINT32_C(0xc0000087)
1419	/** K6 PFIR - Page Flush/Invalidate Register. */
1420	#define MSR_K6_PFIR UINT32_C(0xc0000088)
1421
1422	/** Performance counter MSRs. (AMD only) */
1423	#define MSR_K7_EVNTSEL0 UINT32_C(0xc0010000)
1424	#define MSR_K7_EVNTSEL1 UINT32_C(0xc0010001)
1425	#define MSR_K7_EVNTSEL2 UINT32_C(0xc0010002)
1426	#define MSR_K7_EVNTSEL3 UINT32_C(0xc0010003)
1427	#define MSR_K7_PERFCTR0 UINT32_C(0xc0010004)
1428	#define MSR_K7_PERFCTR1 UINT32_C(0xc0010005)
1429	#define MSR_K7_PERFCTR2 UINT32_C(0xc0010006)
1430	#define MSR_K7_PERFCTR3 UINT32_C(0xc0010007)
1431
1432	/** K8 LSTAR - Long mode SYSCALL target (RIP). */
1433	#define MSR_K8_LSTAR UINT32_C(0xc0000082)
1434	/** K8 CSTAR - Compatibility mode SYSCALL target (RIP). */
1435	#define MSR_K8_CSTAR UINT32_C(0xc0000083)
1436	/** K8 SF_MASK - SYSCALL flag mask. (aka SFMASK) */
1437	#define MSR_K8_SF_MASK UINT32_C(0xc0000084)
1438	/** K8 FS.base - The 64-bit base FS register. */
1439	#define MSR_K8_FS_BASE UINT32_C(0xc0000100)
1440	/** K8 GS.base - The 64-bit base GS register. */
1441	#define MSR_K8_GS_BASE UINT32_C(0xc0000101)
1442	/** K8 KernelGSbase - Used with SWAPGS. */
1443	#define MSR_K8_KERNEL_GS_BASE UINT32_C(0xc0000102)
1444	/** K8 TSC_AUX - Used with RDTSCP. */
1445	#define MSR_K8_TSC_AUX UINT32_C(0xc0000103)
1446	#define MSR_K8_SYSCFG UINT32_C(0xc0010010)
1447	#define MSR_K8_HWCR UINT32_C(0xc0010015)
1448	#define MSR_K8_IORRBASE0 UINT32_C(0xc0010016)
1449	#define MSR_K8_IORRMASK0 UINT32_C(0xc0010017)
1450	#define MSR_K8_IORRBASE1 UINT32_C(0xc0010018)
1451	#define MSR_K8_IORRMASK1 UINT32_C(0xc0010019)
1452	#define MSR_K8_TOP_MEM1 UINT32_C(0xc001001a)
1453	#define MSR_K8_TOP_MEM2 UINT32_C(0xc001001d)
1454	/** North bridge config? See BIOS & Kernel dev guides for
1455	* details. */
1456	#define MSR_K8_NB_CFG UINT32_C(0xc001001f)
1457
1458	/** Hypertransport interrupt pending register.
1459	* "BIOS and Kernel Developer's Guide for AMD NPT Family 0Fh Processors" */
1460	#define MSR_K8_INT_PENDING UINT32_C(0xc0010055)
1461	#define MSR_K8_VM_CR UINT32_C(0xc0010114)
1462	#define MSR_K8_VM_CR_SVM_DISABLE RT_BIT_32(4)
1463
1464	#define MSR_K8_IGNNE UINT32_C(0xc0010115)
1465	#define MSR_K8_SMM_CTL UINT32_C(0xc0010116)
1466	/** SVM - VM_HSAVE_PA - Physical address for saving and restoring
1467	* host state during world switch. */
1468	#define MSR_K8_VM_HSAVE_PA UINT32_C(0xc0010117)
1469
1470	/** @} */
1471
1472
1473	/** @name Page Table / Directory / Directory Pointers / L4.
1474	* @{
1475	*/
1476
1477	/** Page table/directory entry as an unsigned integer. */
1478	typedef uint32_t X86PGUINT;
1479	/** Pointer to a page table/directory table entry as an unsigned integer. */
1480	typedef X86PGUINT *PX86PGUINT;
1481	/** Pointer to an const page table/directory table entry as an unsigned integer. */
1482	typedef X86PGUINT const *PCX86PGUINT;
1483
1484	/** Number of entries in a 32-bit PT/PD. */
1485	#define X86_PG_ENTRIES 1024
1486
1487
1488	/** PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1489	typedef uint64_t X86PGPAEUINT;
1490	/** Pointer to a PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1491	typedef X86PGPAEUINT *PX86PGPAEUINT;
1492	/** Pointer to an const PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1493	typedef X86PGPAEUINT const *PCX86PGPAEUINT;
1494
1495	/** Number of entries in a PAE PT/PD. */
1496	#define X86_PG_PAE_ENTRIES 512
1497	/** Number of entries in a PAE PDPT. */
1498	#define X86_PG_PAE_PDPE_ENTRIES 4
1499
1500	/** Number of entries in an AMD64 PT/PD/PDPT/L4/L5. */
1501	#define X86_PG_AMD64_ENTRIES X86_PG_PAE_ENTRIES
1502	/** Number of entries in an AMD64 PDPT.
1503	* Just for complementing X86_PG_PAE_PDPE_ENTRIES, using X86_PG_AMD64_ENTRIES for this is fine too. */
1504	#define X86_PG_AMD64_PDPE_ENTRIES X86_PG_AMD64_ENTRIES
1505
1506	/** The size of a default page. */
1507	#define X86_PAGE_SIZE X86_PAGE_4K_SIZE
1508	/** The page shift of a default page. */
1509	#define X86_PAGE_SHIFT X86_PAGE_4K_SHIFT
1510	/** The default page offset mask. */
1511	#define X86_PAGE_OFFSET_MASK X86_PAGE_4K_OFFSET_MASK
1512	/** The default page base mask for virtual addresses. */
1513	#define X86_PAGE_BASE_MASK X86_PAGE_4K_BASE_MASK
1514	/** The default page base mask for virtual addresses - 32bit version. */
1515	#define X86_PAGE_BASE_MASK_32 X86_PAGE_4K_BASE_MASK_32
1516
1517	/** The size of a 4KB page. */
1518	#define X86_PAGE_4K_SIZE _4K
1519	/** The page shift of a 4KB page. */
1520	#define X86_PAGE_4K_SHIFT 12
1521	/** The 4KB page offset mask. */
1522	#define X86_PAGE_4K_OFFSET_MASK 0xfff
1523	/** The 4KB page base mask for virtual addresses. */
1524	#define X86_PAGE_4K_BASE_MASK 0xfffffffffffff000ULL
1525	/** The 4KB page base mask for virtual addresses - 32bit version. */
1526	#define X86_PAGE_4K_BASE_MASK_32 0xfffff000U
1527
1528	/** The size of a 2MB page. */
1529	#define X86_PAGE_2M_SIZE _2M
1530	/** The page shift of a 2MB page. */
1531	#define X86_PAGE_2M_SHIFT 21
1532	/** The 2MB page offset mask. */
1533	#define X86_PAGE_2M_OFFSET_MASK 0x001fffff
1534	/** The 2MB page base mask for virtual addresses. */
1535	#define X86_PAGE_2M_BASE_MASK 0xffffffffffe00000ULL
1536	/** The 2MB page base mask for virtual addresses - 32bit version. */
1537	#define X86_PAGE_2M_BASE_MASK_32 0xffe00000U
1538
1539	/** The size of a 4MB page. */
1540	#define X86_PAGE_4M_SIZE _4M
1541	/** The page shift of a 4MB page. */
1542	#define X86_PAGE_4M_SHIFT 22
1543	/** The 4MB page offset mask. */
1544	#define X86_PAGE_4M_OFFSET_MASK 0x003fffff
1545	/** The 4MB page base mask for virtual addresses. */
1546	#define X86_PAGE_4M_BASE_MASK 0xffffffffffc00000ULL
1547	/** The 4MB page base mask for virtual addresses - 32bit version. */
1548	#define X86_PAGE_4M_BASE_MASK_32 0xffc00000U
1549
1550	/**
1551	* Check if the given address is canonical.
1552	*/
1553	#define X86_IS_CANONICAL(a_u64Addr) ((uint64_t)(a_u64Addr) + UINT64_C(0x800000000000) < UINT64_C(0x1000000000000))
1554
1555
1556	/** @name Page Table Entry
1557	* @{
1558	*/
1559	/** Bit 0 - P - Present bit. */
1560	#define X86_PTE_BIT_P 0
1561	/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1562	#define X86_PTE_BIT_RW 1
1563	/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1564	#define X86_PTE_BIT_US 2
1565	/** Bit 3 - PWT - Page level write thru bit. */
1566	#define X86_PTE_BIT_PWT 3
1567	/** Bit 4 - PCD - Page level cache disable bit. */
1568	#define X86_PTE_BIT_PCD 4
1569	/** Bit 5 - A - Access bit. */
1570	#define X86_PTE_BIT_A 5
1571	/** Bit 6 - D - Dirty bit. */
1572	#define X86_PTE_BIT_D 6
1573	/** Bit 7 - PAT - Page Attribute Table index bit. Reserved and 0 if not supported. */
1574	#define X86_PTE_BIT_PAT 7
1575	/** Bit 8 - G - Global flag. */
1576	#define X86_PTE_BIT_G 8
1577	/** Bits 63 - NX - PAE/LM - No execution flag. */
1578	#define X86_PTE_PAE_BIT_NX 63
1579
1580	/** Bit 0 - P - Present bit mask. */
1581	#define X86_PTE_P RT_BIT_32(0)
1582	/** Bit 1 - R/W - Read (clear) / Write (set) bit mask. */
1583	#define X86_PTE_RW RT_BIT_32(1)
1584	/** Bit 2 - U/S - User (set) / Supervisor (clear) bit mask. */
1585	#define X86_PTE_US RT_BIT_32(2)
1586	/** Bit 3 - PWT - Page level write thru bit mask. */
1587	#define X86_PTE_PWT RT_BIT_32(3)
1588	/** Bit 4 - PCD - Page level cache disable bit mask. */
1589	#define X86_PTE_PCD RT_BIT_32(4)
1590	/** Bit 5 - A - Access bit mask. */
1591	#define X86_PTE_A RT_BIT_32(5)
1592	/** Bit 6 - D - Dirty bit mask. */
1593	#define X86_PTE_D RT_BIT_32(6)
1594	/** Bit 7 - PAT - Page Attribute Table index bit mask. Reserved and 0 if not supported. */
1595	#define X86_PTE_PAT RT_BIT_32(7)
1596	/** Bit 8 - G - Global bit mask. */
1597	#define X86_PTE_G RT_BIT_32(8)
1598
1599	/** Bits 9-11 - - Available for use to system software. */
1600	#define X86_PTE_AVL_MASK (RT_BIT_32(9) \| RT_BIT_32(10) \| RT_BIT_32(11))
1601	/** Bits 12-31 - - Physical Page number of the next level. */
1602	#define X86_PTE_PG_MASK ( 0xfffff000 )
1603
1604	/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1605	#define X86_PTE_PAE_PG_MASK UINT64_C(0x000ffffffffff000)
1606	/** Bits 63 - NX - PAE/LM - No execution flag. */
1607	#define X86_PTE_PAE_NX RT_BIT_64(63)
1608	/** Bits 62-52 - - PAE - MBZ bits when NX is active. */
1609	#define X86_PTE_PAE_MBZ_MASK_NX UINT64_C(0x7ff0000000000000)
1610	/** Bits 63-52 - - PAE - MBZ bits when no NX. */
1611	#define X86_PTE_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff0000000000000)
1612	/** No bits - - LM - MBZ bits when NX is active. */
1613	#define X86_PTE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000000)
1614	/** Bits 63 - - LM - MBZ bits when no NX. */
1615	#define X86_PTE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000000)
1616
1617	/**
1618	* Page table entry.
1619	*/
1620	typedef struct X86PTEBITS
1621	{
1622	/** Flags whether(=1) or not the page is present. */
1623	uint32_t u1Present : 1;
1624	/** Read(=0) / Write(=1) flag. */
1625	uint32_t u1Write : 1;
1626	/** User(=1) / Supervisor (=0) flag. */
1627	uint32_t u1User : 1;
1628	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
1629	uint32_t u1WriteThru : 1;
1630	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1631	uint32_t u1CacheDisable : 1;
1632	/** Accessed flag.
1633	* Indicates that the page have been read or written to. */
1634	uint32_t u1Accessed : 1;
1635	/** Dirty flag.
1636	* Indicates that the page has been written to. */
1637	uint32_t u1Dirty : 1;
1638	/** Reserved / If PAT enabled, bit 2 of the index. */
1639	uint32_t u1PAT : 1;
1640	/** Global flag. (Ignored in all but final level.) */
1641	uint32_t u1Global : 1;
1642	/** Available for use to system software. */
1643	uint32_t u3Available : 3;
1644	/** Physical Page number of the next level. */
1645	uint32_t u20PageNo : 20;
1646	} X86PTEBITS;
1647	#ifndef VBOX_FOR_DTRACE_LIB
1648	AssertCompileSize(X86PTEBITS, 4);
1649	#endif
1650	/** Pointer to a page table entry. */
1651	typedef X86PTEBITS *PX86PTEBITS;
1652	/** Pointer to a const page table entry. */
1653	typedef const X86PTEBITS *PCX86PTEBITS;
1654
1655	/**
1656	* Page table entry.
1657	*/
1658	typedef union X86PTE
1659	{
1660	/** Unsigned integer view */
1661	X86PGUINT u;
1662	/** Bit field view. */
1663	X86PTEBITS n;
1664	/** 32-bit view. */
1665	uint32_t au32[1];
1666	/** 16-bit view. */
1667	uint16_t au16[2];
1668	/** 8-bit view. */
1669	uint8_t au8[4];
1670	} X86PTE;
1671	#ifndef VBOX_FOR_DTRACE_LIB
1672	AssertCompileSize(X86PTE, 4);
1673	#endif
1674	/** Pointer to a page table entry. */
1675	typedef X86PTE *PX86PTE;
1676	/** Pointer to a const page table entry. */
1677	typedef const X86PTE *PCX86PTE;
1678
1679
1680	/**
1681	* PAE page table entry.
1682	*/
1683	typedef struct X86PTEPAEBITS
1684	{
1685	/** Flags whether(=1) or not the page is present. */
1686	uint32_t u1Present : 1;
1687	/** Read(=0) / Write(=1) flag. */
1688	uint32_t u1Write : 1;
1689	/** User(=1) / Supervisor(=0) flag. */
1690	uint32_t u1User : 1;
1691	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
1692	uint32_t u1WriteThru : 1;
1693	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1694	uint32_t u1CacheDisable : 1;
1695	/** Accessed flag.
1696	* Indicates that the page have been read or written to. */
1697	uint32_t u1Accessed : 1;
1698	/** Dirty flag.
1699	* Indicates that the page has been written to. */
1700	uint32_t u1Dirty : 1;
1701	/** Reserved / If PAT enabled, bit 2 of the index. */
1702	uint32_t u1PAT : 1;
1703	/** Global flag. (Ignored in all but final level.) */
1704	uint32_t u1Global : 1;
1705	/** Available for use to system software. */
1706	uint32_t u3Available : 3;
1707	/** Physical Page number of the next level - Low Part. Don't use this. */
1708	uint32_t u20PageNoLow : 20;
1709	/** Physical Page number of the next level - High Part. Don't use this. */
1710	uint32_t u20PageNoHigh : 20;
1711	/** MBZ bits */
1712	uint32_t u11Reserved : 11;
1713	/** No Execute flag. */
1714	uint32_t u1NoExecute : 1;
1715	} X86PTEPAEBITS;
1716	#ifndef VBOX_FOR_DTRACE_LIB
1717	AssertCompileSize(X86PTEPAEBITS, 8);
1718	#endif
1719	/** Pointer to a page table entry. */
1720	typedef X86PTEPAEBITS *PX86PTEPAEBITS;
1721	/** Pointer to a page table entry. */
1722	typedef const X86PTEPAEBITS *PCX86PTEPAEBITS;
1723
1724	/**
1725	* PAE Page table entry.
1726	*/
1727	typedef union X86PTEPAE
1728	{
1729	/** Unsigned integer view */
1730	X86PGPAEUINT u;
1731	/** Bit field view. */
1732	X86PTEPAEBITS n;
1733	/** 32-bit view. */
1734	uint32_t au32[2];
1735	/** 16-bit view. */
1736	uint16_t au16[4];
1737	/** 8-bit view. */
1738	uint8_t au8[8];
1739	} X86PTEPAE;
1740	#ifndef VBOX_FOR_DTRACE_LIB
1741	AssertCompileSize(X86PTEPAE, 8);
1742	#endif
1743	/** Pointer to a PAE page table entry. */
1744	typedef X86PTEPAE *PX86PTEPAE;
1745	/** Pointer to a const PAE page table entry. */
1746	typedef const X86PTEPAE *PCX86PTEPAE;
1747	/** @} */
1748
1749	/**
1750	* Page table.
1751	*/
1752	typedef struct X86PT
1753	{
1754	/** PTE Array. */
1755	X86PTE a[X86_PG_ENTRIES];
1756	} X86PT;
1757	#ifndef VBOX_FOR_DTRACE_LIB
1758	AssertCompileSize(X86PT, 4096);
1759	#endif
1760	/** Pointer to a page table. */
1761	typedef X86PT *PX86PT;
1762	/** Pointer to a const page table. */
1763	typedef const X86PT *PCX86PT;
1764
1765	/** The page shift to get the PT index. */
1766	#define X86_PT_SHIFT 12
1767	/** The PT index mask (apply to a shifted page address). */
1768	#define X86_PT_MASK 0x3ff
1769
1770
1771	/**
1772	* Page directory.
1773	*/
1774	typedef struct X86PTPAE
1775	{
1776	/** PTE Array. */
1777	X86PTEPAE a[X86_PG_PAE_ENTRIES];
1778	} X86PTPAE;
1779	#ifndef VBOX_FOR_DTRACE_LIB
1780	AssertCompileSize(X86PTPAE, 4096);
1781	#endif
1782	/** Pointer to a page table. */
1783	typedef X86PTPAE *PX86PTPAE;
1784	/** Pointer to a const page table. */
1785	typedef const X86PTPAE *PCX86PTPAE;
1786
1787	/** The page shift to get the PA PTE index. */
1788	#define X86_PT_PAE_SHIFT 12
1789	/** The PAE PT index mask (apply to a shifted page address). */
1790	#define X86_PT_PAE_MASK 0x1ff
1791
1792
1793	/** @name 4KB Page Directory Entry
1794	* @{
1795	*/
1796	/** Bit 0 - P - Present bit. */
1797	#define X86_PDE_P RT_BIT_32(0)
1798	/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1799	#define X86_PDE_RW RT_BIT_32(1)
1800	/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1801	#define X86_PDE_US RT_BIT_32(2)
1802	/** Bit 3 - PWT - Page level write thru bit. */
1803	#define X86_PDE_PWT RT_BIT_32(3)
1804	/** Bit 4 - PCD - Page level cache disable bit. */
1805	#define X86_PDE_PCD RT_BIT_32(4)
1806	/** Bit 5 - A - Access bit. */
1807	#define X86_PDE_A RT_BIT_32(5)
1808	/** Bit 7 - PS - Page size attribute.
1809	* Clear mean 4KB pages, set means large pages (2/4MB). */
1810	#define X86_PDE_PS RT_BIT_32(7)
1811	/** Bits 9-11 - - Available for use to system software. */
1812	#define X86_PDE_AVL_MASK (RT_BIT_32(9) \| RT_BIT_32(10) \| RT_BIT_32(11))
1813	/** Bits 12-31 - - Physical Page number of the next level. */
1814	#define X86_PDE_PG_MASK ( 0xfffff000 )
1815
1816	/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1817	#define X86_PDE_PAE_PG_MASK UINT64_C(0x000ffffffffff000)
1818	/** Bits 63 - NX - PAE/LM - No execution flag. */
1819	#define X86_PDE_PAE_NX RT_BIT_64(63)
1820	/** Bits 62-52, 7 - - PAE - MBZ bits when NX is active. */
1821	#define X86_PDE_PAE_MBZ_MASK_NX UINT64_C(0x7ff0000000000080)
1822	/** Bits 63-52, 7 - - PAE - MBZ bits when no NX. */
1823	#define X86_PDE_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff0000000000080)
1824	/** Bit 7 - - LM - MBZ bits when NX is active. */
1825	#define X86_PDE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000080)
1826	/** Bits 63, 7 - - LM - MBZ bits when no NX. */
1827	#define X86_PDE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000080)
1828
1829	/**
1830	* Page directory entry.
1831	*/
1832	typedef struct X86PDEBITS
1833	{
1834	/** Flags whether(=1) or not the page is present. */
1835	uint32_t u1Present : 1;
1836	/** Read(=0) / Write(=1) flag. */
1837	uint32_t u1Write : 1;
1838	/** User(=1) / Supervisor (=0) flag. */
1839	uint32_t u1User : 1;
1840	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
1841	uint32_t u1WriteThru : 1;
1842	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1843	uint32_t u1CacheDisable : 1;
1844	/** Accessed flag.
1845	* Indicates that the page has been read or written to. */
1846	uint32_t u1Accessed : 1;
1847	/** Reserved / Ignored (dirty bit). */
1848	uint32_t u1Reserved0 : 1;
1849	/** Size bit if PSE is enabled - in any event it's 0. */
1850	uint32_t u1Size : 1;
1851	/** Reserved / Ignored (global bit). */
1852	uint32_t u1Reserved1 : 1;
1853	/** Available for use to system software. */
1854	uint32_t u3Available : 3;
1855	/** Physical Page number of the next level. */
1856	uint32_t u20PageNo : 20;
1857	} X86PDEBITS;
1858	#ifndef VBOX_FOR_DTRACE_LIB
1859	AssertCompileSize(X86PDEBITS, 4);
1860	#endif
1861	/** Pointer to a page directory entry. */
1862	typedef X86PDEBITS *PX86PDEBITS;
1863	/** Pointer to a const page directory entry. */
1864	typedef const X86PDEBITS *PCX86PDEBITS;
1865
1866
1867	/**
1868	* PAE page directory entry.
1869	*/
1870	typedef struct X86PDEPAEBITS
1871	{
1872	/** Flags whether(=1) or not the page is present. */
1873	uint32_t u1Present : 1;
1874	/** Read(=0) / Write(=1) flag. */
1875	uint32_t u1Write : 1;
1876	/** User(=1) / Supervisor (=0) flag. */
1877	uint32_t u1User : 1;
1878	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
1879	uint32_t u1WriteThru : 1;
1880	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1881	uint32_t u1CacheDisable : 1;
1882	/** Accessed flag.
1883	* Indicates that the page has been read or written to. */
1884	uint32_t u1Accessed : 1;
1885	/** Reserved / Ignored (dirty bit). */
1886	uint32_t u1Reserved0 : 1;
1887	/** Size bit if PSE is enabled - in any event it's 0. */
1888	uint32_t u1Size : 1;
1889	/** Reserved / Ignored (global bit). / */
1890	uint32_t u1Reserved1 : 1;
1891	/** Available for use to system software. */
1892	uint32_t u3Available : 3;
1893	/** Physical Page number of the next level - Low Part. Don't use! */
1894	uint32_t u20PageNoLow : 20;
1895	/** Physical Page number of the next level - High Part. Don't use! */
1896	uint32_t u20PageNoHigh : 20;
1897	/** MBZ bits */
1898	uint32_t u11Reserved : 11;
1899	/** No Execute flag. */
1900	uint32_t u1NoExecute : 1;
1901	} X86PDEPAEBITS;
1902	#ifndef VBOX_FOR_DTRACE_LIB
1903	AssertCompileSize(X86PDEPAEBITS, 8);
1904	#endif
1905	/** Pointer to a page directory entry. */
1906	typedef X86PDEPAEBITS *PX86PDEPAEBITS;
1907	/** Pointer to a const page directory entry. */
1908	typedef const X86PDEPAEBITS *PCX86PDEPAEBITS;
1909
1910	/** @} */
1911
1912
1913	/** @name 2/4MB Page Directory Entry
1914	* @{
1915	*/
1916	/** Bit 0 - P - Present bit. */
1917	#define X86_PDE4M_P RT_BIT_32(0)
1918	/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1919	#define X86_PDE4M_RW RT_BIT_32(1)
1920	/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1921	#define X86_PDE4M_US RT_BIT_32(2)
1922	/** Bit 3 - PWT - Page level write thru bit. */
1923	#define X86_PDE4M_PWT RT_BIT_32(3)
1924	/** Bit 4 - PCD - Page level cache disable bit. */
1925	#define X86_PDE4M_PCD RT_BIT_32(4)
1926	/** Bit 5 - A - Access bit. */
1927	#define X86_PDE4M_A RT_BIT_32(5)
1928	/** Bit 6 - D - Dirty bit. */
1929	#define X86_PDE4M_D RT_BIT_32(6)
1930	/** Bit 7 - PS - Page size attribute. Clear mean 4KB pages, set means large pages (2/4MB). */
1931	#define X86_PDE4M_PS RT_BIT_32(7)
1932	/** Bit 8 - G - Global flag. */
1933	#define X86_PDE4M_G RT_BIT_32(8)
1934	/** Bits 9-11 - AVL - Available for use to system software. */
1935	#define X86_PDE4M_AVL (RT_BIT_32(9) \| RT_BIT_32(10) \| RT_BIT_32(11))
1936	/** Bit 12 - PAT - Page Attribute Table index bit. Reserved and 0 if not supported. */
1937	#define X86_PDE4M_PAT RT_BIT_32(12)
1938	/** Shift to get from X86_PTE_PAT to X86_PDE4M_PAT. */
1939	#define X86_PDE4M_PAT_SHIFT (12 - 7)
1940	/** Bits 22-31 - - Physical Page number. */
1941	#define X86_PDE4M_PG_MASK ( 0xffc00000 )
1942	/** Bits 20-13 - - Physical Page number high part (32-39 bits). AMD64 hack. */
1943	#define X86_PDE4M_PG_HIGH_MASK ( 0x001fe000 )
1944	/** The number of bits to the high part of the page number. */
1945	#define X86_PDE4M_PG_HIGH_SHIFT 19
1946	/** Bit 21 - - MBZ bits for AMD CPUs, no PSE36. */
1947	#define X86_PDE4M_MBZ_MASK RT_BIT_32(21)
1948
1949	/** Bits 21-51 - - PAE/LM - Physical Page number.
1950	* (Bits 40-51 (long mode) & bits 36-51 (pae legacy) are reserved according to the Intel docs; AMD allows for more.) */
1951	#define X86_PDE2M_PAE_PG_MASK UINT64_C(0x000fffffffe00000)
1952	/** Bits 63 - NX - PAE/LM - No execution flag. */
1953	#define X86_PDE2M_PAE_NX RT_BIT_64(63)
1954	/** Bits 62-52, 20-13 - - PAE - MBZ bits when NX is active. */
1955	#define X86_PDE2M_PAE_MBZ_MASK_NX UINT64_C(0x7ff00000001fe000)
1956	/** Bits 63-52, 20-13 - - PAE - MBZ bits when no NX. */
1957	#define X86_PDE2M_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff00000001fe000)
1958	/** Bits 20-13 - - LM - MBZ bits when NX is active. */
1959	#define X86_PDE2M_LM_MBZ_MASK_NX UINT64_C(0x00000000001fe000)
1960	/** Bits 63, 20-13 - - LM - MBZ bits when no NX. */
1961	#define X86_PDE2M_LM_MBZ_MASK_NO_NX UINT64_C(0x80000000001fe000)
1962
1963	/**
1964	* 4MB page directory entry.
1965	*/
1966	typedef struct X86PDE4MBITS
1967	{
1968	/** Flags whether(=1) or not the page is present. */
1969	uint32_t u1Present : 1;
1970	/** Read(=0) / Write(=1) flag. */
1971	uint32_t u1Write : 1;
1972	/** User(=1) / Supervisor (=0) flag. */
1973	uint32_t u1User : 1;
1974	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
1975	uint32_t u1WriteThru : 1;
1976	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1977	uint32_t u1CacheDisable : 1;
1978	/** Accessed flag.
1979	* Indicates that the page have been read or written to. */
1980	uint32_t u1Accessed : 1;
1981	/** Dirty flag.
1982	* Indicates that the page has been written to. */
1983	uint32_t u1Dirty : 1;
1984	/** Page size flag - always 1 for 4MB entries. */
1985	uint32_t u1Size : 1;
1986	/** Global flag. */
1987	uint32_t u1Global : 1;
1988	/** Available for use to system software. */
1989	uint32_t u3Available : 3;
1990	/** Reserved / If PAT enabled, bit 2 of the index. */
1991	uint32_t u1PAT : 1;
1992	/** Bits 32-39 of the page number on AMD64.
1993	* This AMD64 hack allows accessing 40bits of physical memory without PAE. */
1994	uint32_t u8PageNoHigh : 8;
1995	/** Reserved. */
1996	uint32_t u1Reserved : 1;
1997	/** Physical Page number of the page. */
1998	uint32_t u10PageNo : 10;
1999	} X86PDE4MBITS;
2000	#ifndef VBOX_FOR_DTRACE_LIB
2001	AssertCompileSize(X86PDE4MBITS, 4);
2002	#endif
2003	/** Pointer to a page table entry. */
2004	typedef X86PDE4MBITS *PX86PDE4MBITS;
2005	/** Pointer to a const page table entry. */
2006	typedef const X86PDE4MBITS *PCX86PDE4MBITS;
2007
2008
2009	/**
2010	* 2MB PAE page directory entry.
2011	*/
2012	typedef struct X86PDE2MPAEBITS
2013	{
2014	/** Flags whether(=1) or not the page is present. */
2015	uint32_t u1Present : 1;
2016	/** Read(=0) / Write(=1) flag. */
2017	uint32_t u1Write : 1;
2018	/** User(=1) / Supervisor(=0) flag. */
2019	uint32_t u1User : 1;
2020	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
2021	uint32_t u1WriteThru : 1;
2022	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
2023	uint32_t u1CacheDisable : 1;
2024	/** Accessed flag.
2025	* Indicates that the page have been read or written to. */
2026	uint32_t u1Accessed : 1;
2027	/** Dirty flag.
2028	* Indicates that the page has been written to. */
2029	uint32_t u1Dirty : 1;
2030	/** Page size flag - always 1 for 2MB entries. */
2031	uint32_t u1Size : 1;
2032	/** Global flag. */
2033	uint32_t u1Global : 1;
2034	/** Available for use to system software. */
2035	uint32_t u3Available : 3;
2036	/** Reserved / If PAT enabled, bit 2 of the index. */
2037	uint32_t u1PAT : 1;
2038	/** Reserved. */
2039	uint32_t u9Reserved : 9;
2040	/** Physical Page number of the next level - Low part. Don't use! */
2041	uint32_t u10PageNoLow : 10;
2042	/** Physical Page number of the next level - High part. Don't use! */
2043	uint32_t u20PageNoHigh : 20;
2044	/** MBZ bits */
2045	uint32_t u11Reserved : 11;
2046	/** No Execute flag. */
2047	uint32_t u1NoExecute : 1;
2048	} X86PDE2MPAEBITS;
2049	#ifndef VBOX_FOR_DTRACE_LIB
2050	AssertCompileSize(X86PDE2MPAEBITS, 8);
2051	#endif
2052	/** Pointer to a 2MB PAE page table entry. */
2053	typedef X86PDE2MPAEBITS *PX86PDE2MPAEBITS;
2054	/** Pointer to a 2MB PAE page table entry. */
2055	typedef const X86PDE2MPAEBITS *PCX86PDE2MPAEBITS;
2056
2057	/** @} */
2058
2059	/**
2060	* Page directory entry.
2061	*/
2062	typedef union X86PDE
2063	{
2064	/** Unsigned integer view. */
2065	X86PGUINT u;
2066	/** Normal view. */
2067	X86PDEBITS n;
2068	/** 4MB view (big). */
2069	X86PDE4MBITS b;
2070	/** 8 bit unsigned integer view. */
2071	uint8_t au8[4];
2072	/** 16 bit unsigned integer view. */
2073	uint16_t au16[2];
2074	/** 32 bit unsigned integer view. */
2075	uint32_t au32[1];
2076	} X86PDE;
2077	#ifndef VBOX_FOR_DTRACE_LIB
2078	AssertCompileSize(X86PDE, 4);
2079	#endif
2080	/** Pointer to a page directory entry. */
2081	typedef X86PDE *PX86PDE;
2082	/** Pointer to a const page directory entry. */
2083	typedef const X86PDE *PCX86PDE;
2084
2085	/**
2086	* PAE page directory entry.
2087	*/
2088	typedef union X86PDEPAE
2089	{
2090	/** Unsigned integer view. */
2091	X86PGPAEUINT u;
2092	/** Normal view. */
2093	X86PDEPAEBITS n;
2094	/** 2MB page view (big). */
2095	X86PDE2MPAEBITS b;
2096	/** 8 bit unsigned integer view. */
2097	uint8_t au8[8];
2098	/** 16 bit unsigned integer view. */
2099	uint16_t au16[4];
2100	/** 32 bit unsigned integer view. */
2101	uint32_t au32[2];
2102	} X86PDEPAE;
2103	#ifndef VBOX_FOR_DTRACE_LIB
2104	AssertCompileSize(X86PDEPAE, 8);
2105	#endif
2106	/** Pointer to a page directory entry. */
2107	typedef X86PDEPAE *PX86PDEPAE;
2108	/** Pointer to a const page directory entry. */
2109	typedef const X86PDEPAE *PCX86PDEPAE;
2110
2111	/**
2112	* Page directory.
2113	*/
2114	typedef struct X86PD
2115	{
2116	/** PDE Array. */
2117	X86PDE a[X86_PG_ENTRIES];
2118	} X86PD;
2119	#ifndef VBOX_FOR_DTRACE_LIB
2120	AssertCompileSize(X86PD, 4096);
2121	#endif
2122	/** Pointer to a page directory. */
2123	typedef X86PD *PX86PD;
2124	/** Pointer to a const page directory. */
2125	typedef const X86PD *PCX86PD;
2126
2127	/** The page shift to get the PD index. */
2128	#define X86_PD_SHIFT 22
2129	/** The PD index mask (apply to a shifted page address). */
2130	#define X86_PD_MASK 0x3ff
2131
2132
2133	/**
2134	* PAE page directory.
2135	*/
2136	typedef struct X86PDPAE
2137	{
2138	/** PDE Array. */
2139	X86PDEPAE a[X86_PG_PAE_ENTRIES];
2140	} X86PDPAE;
2141	#ifndef VBOX_FOR_DTRACE_LIB
2142	AssertCompileSize(X86PDPAE, 4096);
2143	#endif
2144	/** Pointer to a PAE page directory. */
2145	typedef X86PDPAE *PX86PDPAE;
2146	/** Pointer to a const PAE page directory. */
2147	typedef const X86PDPAE *PCX86PDPAE;
2148
2149	/** The page shift to get the PAE PD index. */
2150	#define X86_PD_PAE_SHIFT 21
2151	/** The PAE PD index mask (apply to a shifted page address). */
2152	#define X86_PD_PAE_MASK 0x1ff
2153
2154
2155	/** @name Page Directory Pointer Table Entry (PAE)
2156	* @{
2157	*/
2158	/** Bit 0 - P - Present bit. */
2159	#define X86_PDPE_P RT_BIT_32(0)
2160	/** Bit 1 - R/W - Read (clear) / Write (set) bit. Long Mode only. */
2161	#define X86_PDPE_RW RT_BIT_32(1)
2162	/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. Long Mode only. */
2163	#define X86_PDPE_US RT_BIT_32(2)
2164	/** Bit 3 - PWT - Page level write thru bit. */
2165	#define X86_PDPE_PWT RT_BIT_32(3)
2166	/** Bit 4 - PCD - Page level cache disable bit. */
2167	#define X86_PDPE_PCD RT_BIT_32(4)
2168	/** Bit 5 - A - Access bit. Long Mode only. */
2169	#define X86_PDPE_A RT_BIT_32(5)
2170	/** Bit 7 - PS - Page size (1GB). Long Mode only. */
2171	#define X86_PDPE_LM_PS RT_BIT_32(7)
2172	/** Bits 9-11 - - Available for use to system software. */
2173	#define X86_PDPE_AVL_MASK (RT_BIT_32(9) \| RT_BIT_32(10) \| RT_BIT_32(11))
2174	/** Bits 12-51 - - PAE - Physical Page number of the next level. */
2175	#define X86_PDPE_PG_MASK UINT64_C(0x000ffffffffff000)
2176	/** Bits 63-52, 8-5, 2-1 - - PAE - MBZ bits (NX is long mode only). */
2177	#define X86_PDPE_PAE_MBZ_MASK UINT64_C(0xfff00000000001e6)
2178	/** Bits 63 - NX - LM - No execution flag. Long Mode only. */
2179	#define X86_PDPE_LM_NX RT_BIT_64(63)
2180	/** Bits 8, 7 - - LM - MBZ bits when NX is active. */
2181	#define X86_PDPE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000180)
2182	/** Bits 63, 8, 7 - - LM - MBZ bits when no NX. */
2183	#define X86_PDPE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000180)
2184	/** Bits 29-13 - - LM - MBZ bits for 1GB page entry when NX is active. */
2185	#define X86_PDPE1G_LM_MBZ_MASK_NX UINT64_C(0x000000003fffe000)
2186	/** Bits 63, 29-13 - - LM - MBZ bits for 1GB page entry when no NX. */
2187	#define X86_PDPE1G_LM_MBZ_MASK_NO_NX UINT64_C(0x800000003fffe000)
2188
2189
2190	/**
2191	* Page directory pointer table entry.
2192	*/
2193	typedef struct X86PDPEBITS
2194	{
2195	/** Flags whether(=1) or not the page is present. */
2196	uint32_t u1Present : 1;
2197	/** Chunk of reserved bits. */
2198	uint32_t u2Reserved : 2;
2199	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
2200	uint32_t u1WriteThru : 1;
2201	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
2202	uint32_t u1CacheDisable : 1;
2203	/** Chunk of reserved bits. */
2204	uint32_t u4Reserved : 4;
2205	/** Available for use to system software. */
2206	uint32_t u3Available : 3;
2207	/** Physical Page number of the next level - Low Part. Don't use! */
2208	uint32_t u20PageNoLow : 20;
2209	/** Physical Page number of the next level - High Part. Don't use! */
2210	uint32_t u20PageNoHigh : 20;
2211	/** MBZ bits */
2212	uint32_t u12Reserved : 12;
2213	} X86PDPEBITS;
2214	#ifndef VBOX_FOR_DTRACE_LIB
2215	AssertCompileSize(X86PDPEBITS, 8);
2216	#endif
2217	/** Pointer to a page directory pointer table entry. */
2218	typedef X86PDPEBITS *PX86PTPEBITS;
2219	/** Pointer to a const page directory pointer table entry. */
2220	typedef const X86PDPEBITS *PCX86PTPEBITS;
2221
2222	/**
2223	* Page directory pointer table entry. AMD64 version
2224	*/
2225	typedef struct X86PDPEAMD64BITS
2226	{
2227	/** Flags whether(=1) or not the page is present. */
2228	uint32_t u1Present : 1;
2229	/** Read(=0) / Write(=1) flag. */
2230	uint32_t u1Write : 1;
2231	/** User(=1) / Supervisor (=0) flag. */
2232	uint32_t u1User : 1;
2233	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
2234	uint32_t u1WriteThru : 1;
2235	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
2236	uint32_t u1CacheDisable : 1;
2237	/** Accessed flag.
2238	* Indicates that the page have been read or written to. */
2239	uint32_t u1Accessed : 1;
2240	/** Chunk of reserved bits. */
2241	uint32_t u3Reserved : 3;
2242	/** Available for use to system software. */
2243	uint32_t u3Available : 3;
2244	/** Physical Page number of the next level - Low Part. Don't use! */
2245	uint32_t u20PageNoLow : 20;
2246	/** Physical Page number of the next level - High Part. Don't use! */
2247	uint32_t u20PageNoHigh : 20;
2248	/** MBZ bits */
2249	uint32_t u11Reserved : 11;
2250	/** No Execute flag. */
2251	uint32_t u1NoExecute : 1;
2252	} X86PDPEAMD64BITS;
2253	#ifndef VBOX_FOR_DTRACE_LIB
2254	AssertCompileSize(X86PDPEAMD64BITS, 8);
2255	#endif
2256	/** Pointer to a page directory pointer table entry. */
2257	typedef X86PDPEAMD64BITS *PX86PDPEAMD64BITS;
2258	/** Pointer to a const page directory pointer table entry. */
2259	typedef const X86PDPEAMD64BITS *PCX86PDPEAMD64BITS;
2260
2261	/**
2262	* Page directory pointer table entry for 1GB page. (AMD64 only)
2263	*/
2264	typedef struct X86PDPE1GB
2265	{
2266	/** 0: Flags whether(=1) or not the page is present. */
2267	uint32_t u1Present : 1;
2268	/** 1: Read(=0) / Write(=1) flag. */
2269	uint32_t u1Write : 1;
2270	/** 2: User(=1) / Supervisor (=0) flag. */
2271	uint32_t u1User : 1;
2272	/** 3: Write Thru flag. If PAT enabled, bit 0 of the index. */
2273	uint32_t u1WriteThru : 1;
2274	/** 4: Cache disabled flag. If PAT enabled, bit 1 of the index. */
2275	uint32_t u1CacheDisable : 1;
2276	/** 5: Accessed flag.
2277	* Indicates that the page have been read or written to. */
2278	uint32_t u1Accessed : 1;
2279	/** 6: Dirty flag for 1GB pages. */
2280	uint32_t u1Dirty : 1;
2281	/** 7: Indicates 1GB page if set. */
2282	uint32_t u1Size : 1;
2283	/** 8: Global 1GB page. */
2284	uint32_t u1Global: 1;
2285	/** 9-11: Available for use to system software. */
2286	uint32_t u3Available : 3;
2287	/** 12: PAT bit for 1GB page. */
2288	uint32_t u1PAT : 1;
2289	/** 13-29: MBZ bits. */
2290	uint32_t u17Reserved : 17;
2291	/** 30-31: Physical page number - Low Part. Don't use! */
2292	uint32_t u2PageNoLow : 2;
2293	/** 32-51: Physical Page number of the next level - High Part. Don't use! */
2294	uint32_t u20PageNoHigh : 20;
2295	/** 52-62: MBZ bits */
2296	uint32_t u11Reserved : 11;
2297	/** 63: No Execute flag. */
2298	uint32_t u1NoExecute : 1;
2299	} X86PDPE1GB;
2300	#ifndef VBOX_FOR_DTRACE_LIB
2301	AssertCompileSize(X86PDPE1GB, 8);
2302	#endif
2303	/** Pointer to a page directory pointer table entry for a 1GB page. */
2304	typedef X86PDPE1GB *PX86PDPE1GB;
2305	/** Pointer to a const page directory pointer table entry for a 1GB page. */
2306	typedef const X86PDPE1GB *PCX86PDPE1GB;
2307
2308	/**
2309	* Page directory pointer table entry.
2310	*/
2311	typedef union X86PDPE
2312	{
2313	/** Unsigned integer view. */
2314	X86PGPAEUINT u;
2315	/** Normal view. */
2316	X86PDPEBITS n;
2317	/** AMD64 view. */
2318	X86PDPEAMD64BITS lm;
2319	/** AMD64 big view. */
2320	X86PDPE1GB b;
2321	/** 8 bit unsigned integer view. */
2322	uint8_t au8[8];
2323	/** 16 bit unsigned integer view. */
2324	uint16_t au16[4];
2325	/** 32 bit unsigned integer view. */
2326	uint32_t au32[2];
2327	} X86PDPE;
2328	#ifndef VBOX_FOR_DTRACE_LIB
2329	AssertCompileSize(X86PDPE, 8);
2330	#endif
2331	/** Pointer to a page directory pointer table entry. */
2332	typedef X86PDPE *PX86PDPE;
2333	/** Pointer to a const page directory pointer table entry. */
2334	typedef const X86PDPE *PCX86PDPE;
2335
2336
2337	/**
2338	* Page directory pointer table.
2339	*/
2340	typedef struct X86PDPT
2341	{
2342	/** PDE Array. */
2343	X86PDPE a[X86_PG_AMD64_PDPE_ENTRIES];
2344	} X86PDPT;
2345	#ifndef VBOX_FOR_DTRACE_LIB
2346	AssertCompileSize(X86PDPT, 4096);
2347	#endif
2348	/** Pointer to a page directory pointer table. */
2349	typedef X86PDPT *PX86PDPT;
2350	/** Pointer to a const page directory pointer table. */
2351	typedef const X86PDPT *PCX86PDPT;
2352
2353	/** The page shift to get the PDPT index. */
2354	#define X86_PDPT_SHIFT 30
2355	/** The PDPT index mask (apply to a shifted page address). (32 bits PAE) */
2356	#define X86_PDPT_MASK_PAE 0x3
2357	/** The PDPT index mask (apply to a shifted page address). (64 bits PAE)*/
2358	#define X86_PDPT_MASK_AMD64 0x1ff
2359
2360	/** @} */
2361
2362
2363	/** @name Page Map Level-4 Entry (Long Mode PAE)
2364	* @{
2365	*/
2366	/** Bit 0 - P - Present bit. */
2367	#define X86_PML4E_P RT_BIT_32(0)
2368	/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
2369	#define X86_PML4E_RW RT_BIT_32(1)
2370	/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
2371	#define X86_PML4E_US RT_BIT_32(2)
2372	/** Bit 3 - PWT - Page level write thru bit. */
2373	#define X86_PML4E_PWT RT_BIT_32(3)
2374	/** Bit 4 - PCD - Page level cache disable bit. */
2375	#define X86_PML4E_PCD RT_BIT_32(4)
2376	/** Bit 5 - A - Access bit. */
2377	#define X86_PML4E_A RT_BIT_32(5)
2378	/** Bits 9-11 - - Available for use to system software. */
2379	#define X86_PML4E_AVL_MASK (RT_BIT_32(9) \| RT_BIT_32(10) \| RT_BIT_32(11))
2380	/** Bits 12-51 - - PAE - Physical Page number of the next level. */
2381	#define X86_PML4E_PG_MASK UINT64_C(0x000ffffffffff000)
2382	/** Bits 8, 7 - - MBZ bits when NX is active. */
2383	#define X86_PML4E_MBZ_MASK_NX UINT64_C(0x0000000000000080)
2384	/** Bits 63, 7 - - MBZ bits when no NX. */
2385	#define X86_PML4E_MBZ_MASK_NO_NX UINT64_C(0x8000000000000080)
2386	/** Bits 63 - NX - PAE - No execution flag. */
2387	#define X86_PML4E_NX RT_BIT_64(63)
2388
2389	/**
2390	* Page Map Level-4 Entry
2391	*/
2392	typedef struct X86PML4EBITS
2393	{
2394	/** Flags whether(=1) or not the page is present. */
2395	uint32_t u1Present : 1;
2396	/** Read(=0) / Write(=1) flag. */
2397	uint32_t u1Write : 1;
2398	/** User(=1) / Supervisor (=0) flag. */
2399	uint32_t u1User : 1;
2400	/** Write Thru flag. If PAT enabled, bit 0 of the index. */
2401	uint32_t u1WriteThru : 1;
2402	/** Cache disabled flag. If PAT enabled, bit 1 of the index. */
2403	uint32_t u1CacheDisable : 1;
2404	/** Accessed flag.
2405	* Indicates that the page have been read or written to. */
2406	uint32_t u1Accessed : 1;
2407	/** Chunk of reserved bits. */
2408	uint32_t u3Reserved : 3;
2409	/** Available for use to system software. */
2410	uint32_t u3Available : 3;
2411	/** Physical Page number of the next level - Low Part. Don't use! */
2412	uint32_t u20PageNoLow : 20;
2413	/** Physical Page number of the next level - High Part. Don't use! */
2414	uint32_t u20PageNoHigh : 20;
2415	/** MBZ bits */
2416	uint32_t u11Reserved : 11;
2417	/** No Execute flag. */
2418	uint32_t u1NoExecute : 1;
2419	} X86PML4EBITS;
2420	#ifndef VBOX_FOR_DTRACE_LIB
2421	AssertCompileSize(X86PML4EBITS, 8);
2422	#endif
2423	/** Pointer to a page map level-4 entry. */
2424	typedef X86PML4EBITS *PX86PML4EBITS;
2425	/** Pointer to a const page map level-4 entry. */
2426	typedef const X86PML4EBITS *PCX86PML4EBITS;
2427
2428	/**
2429	* Page Map Level-4 Entry.
2430	*/
2431	typedef union X86PML4E
2432	{
2433	/** Unsigned integer view. */
2434	X86PGPAEUINT u;
2435	/** Normal view. */
2436	X86PML4EBITS n;
2437	/** 8 bit unsigned integer view. */
2438	uint8_t au8[8];
2439	/** 16 bit unsigned integer view. */
2440	uint16_t au16[4];
2441	/** 32 bit unsigned integer view. */
2442	uint32_t au32[2];
2443	} X86PML4E;
2444	#ifndef VBOX_FOR_DTRACE_LIB
2445	AssertCompileSize(X86PML4E, 8);
2446	#endif
2447	/** Pointer to a page map level-4 entry. */
2448	typedef X86PML4E *PX86PML4E;
2449	/** Pointer to a const page map level-4 entry. */
2450	typedef const X86PML4E *PCX86PML4E;
2451
2452
2453	/**
2454	* Page Map Level-4.
2455	*/
2456	typedef struct X86PML4
2457	{
2458	/** PDE Array. */
2459	X86PML4E a[X86_PG_PAE_ENTRIES];
2460	} X86PML4;
2461	#ifndef VBOX_FOR_DTRACE_LIB
2462	AssertCompileSize(X86PML4, 4096);
2463	#endif
2464	/** Pointer to a page map level-4. */
2465	typedef X86PML4 *PX86PML4;
2466	/** Pointer to a const page map level-4. */
2467	typedef const X86PML4 *PCX86PML4;
2468
2469	/** The page shift to get the PML4 index. */
2470	#define X86_PML4_SHIFT 39
2471	/** The PML4 index mask (apply to a shifted page address). */
2472	#define X86_PML4_MASK 0x1ff
2473
2474	/** @} */
2475
2476	/** @} */
2477
2478	/**
2479	* 32-bit protected mode FSTENV image.
2480	*/
2481	typedef struct X86FSTENV32P
2482	{
2483	uint16_t FCW;
2484	uint16_t padding1;
2485	uint16_t FSW;
2486	uint16_t padding2;
2487	uint16_t FTW;
2488	uint16_t padding3;
2489	uint32_t FPUIP;
2490	uint16_t FPUCS;
2491	uint16_t FOP;
2492	uint32_t FPUDP;
2493	uint16_t FPUDS;
2494	uint16_t padding4;
2495	} X86FSTENV32P;
2496	/** Pointer to a 32-bit protected mode FSTENV image. */
2497	typedef X86FSTENV32P *PX86FSTENV32P;
2498	/** Pointer to a const 32-bit protected mode FSTENV image. */
2499	typedef X86FSTENV32P const *PCX86FSTENV32P;
2500
2501
2502	/**
2503	* 80-bit MMX/FPU register type.
2504	*/
2505	typedef struct X86FPUMMX
2506	{
2507	uint8_t reg[10];
2508	} X86FPUMMX;
2509	#ifndef VBOX_FOR_DTRACE_LIB
2510	AssertCompileSize(X86FPUMMX, 10);
2511	#endif
2512	/** Pointer to a 80-bit MMX/FPU register type. */
2513	typedef X86FPUMMX *PX86FPUMMX;
2514	/** Pointer to a const 80-bit MMX/FPU register type. */
2515	typedef const X86FPUMMX *PCX86FPUMMX;
2516
2517	/** FPU (x87) register. */
2518	typedef union X86FPUREG
2519	{
2520	/** MMX view. */
2521	uint64_t mmx;
2522	/** FPU view - todo. */
2523	X86FPUMMX fpu;
2524	/** Extended precision floating point view. */
2525	RTFLOAT80U r80;
2526	/** Extended precision floating point view v2 */
2527	RTFLOAT80U2 r80Ex;
2528	/** 8-bit view. */
2529	uint8_t au8[16];
2530	/** 16-bit view. */
2531	uint16_t au16[8];
2532	/** 32-bit view. */
2533	uint32_t au32[4];
2534	/** 64-bit view. */
2535	uint64_t au64[2];
2536	/** 128-bit view. (yeah, very helpful) */
2537	uint128_t au128[1];
2538	} X86FPUREG;
2539	#ifndef VBOX_FOR_DTRACE_LIB
2540	AssertCompileSize(X86FPUREG, 16);
2541	#endif
2542	/** Pointer to a FPU register. */
2543	typedef X86FPUREG *PX86FPUREG;
2544	/** Pointer to a const FPU register. */
2545	typedef X86FPUREG const *PCX86FPUREG;
2546
2547	/**
2548	* XMM register union.
2549	*/
2550	typedef union X86XMMREG
2551	{
2552	/** XMM Register view . /
2553	uint128_t xmm;
2554	/** 8-bit view. */
2555	uint8_t au8[16];
2556	/** 16-bit view. */
2557	uint16_t au16[8];
2558	/** 32-bit view. */
2559	uint32_t au32[4];
2560	/** 64-bit view. */
2561	uint64_t au64[2];
2562	/** 128-bit view. (yeah, very helpful) */
2563	uint128_t au128[1];
2564	} X86XMMREG;
2565	#ifndef VBOX_FOR_DTRACE_LIB
2566	AssertCompileSize(X86XMMREG, 16);
2567	#endif
2568	/** Pointer to an XMM register state. */
2569	typedef X86XMMREG *PX86XMMREG;
2570	/** Pointer to a const XMM register state. */
2571	typedef X86XMMREG const *PCX86XMMREG;
2572
2573	/**
2574	* YMM register union.
2575	*/
2576	typedef union X86YMMREG
2577	{
2578	/** 8-bit view. */
2579	uint8_t au8[32];
2580	/** 16-bit view. */
2581	uint16_t au16[16];
2582	/** 32-bit view. */
2583	uint32_t au32[8];
2584	/** 64-bit view. */
2585	uint64_t au64[4];
2586	/** 128-bit view. (yeah, very helpful) */
2587	uint128_t au128[2];
2588	/** XMM sub register view. */
2589	X86XMMREG aXmm[2];
2590	} X86YMMREG;
2591	#ifndef VBOX_FOR_DTRACE_LIB
2592	AssertCompileSize(X86YMMREG, 32);
2593	#endif
2594	/** Pointer to an YMM register state. */
2595	typedef X86YMMREG *PX86YMMREG;
2596	/** Pointer to a const YMM register state. */
2597	typedef X86YMMREG const *PCX86YMMREG;
2598
2599	/**
2600	* ZMM register union.
2601	*/
2602	typedef union X86ZMMREG
2603	{
2604	/** 8-bit view. */
2605	uint8_t au8[64];
2606	/** 16-bit view. */
2607	uint16_t au16[32];
2608	/** 32-bit view. */
2609	uint32_t au32[16];
2610	/** 64-bit view. */
2611	uint64_t au64[8];
2612	/** 128-bit view. (yeah, very helpful) */
2613	uint128_t au128[4];
2614	/** XMM sub register view. */
2615	X86XMMREG aXmm[4];
2616	/** YMM sub register view. */
2617	X86YMMREG aYmm[2];
2618	} X86ZMMREG;
2619	#ifndef VBOX_FOR_DTRACE_LIB
2620	AssertCompileSize(X86ZMMREG, 64);
2621	#endif
2622	/** Pointer to an ZMM register state. */
2623	typedef X86ZMMREG *PX86ZMMREG;
2624	/** Pointer to a const ZMM register state. */
2625	typedef X86ZMMREG const *PCX86ZMMREG;
2626
2627
2628	/**
2629	* 32-bit FPU state (aka FSAVE/FRSTOR Memory Region).
2630	* @todo verify this...
2631	*/
2632	#pragma pack(1)
2633	typedef struct X86FPUSTATE
2634	{
2635	/** 0x00 - Control word. */
2636	uint16_t FCW;
2637	/** 0x02 - Alignment word */
2638	uint16_t Dummy1;
2639	/** 0x04 - Status word. */
2640	uint16_t FSW;
2641	/** 0x06 - Alignment word */
2642	uint16_t Dummy2;
2643	/** 0x08 - Tag word */
2644	uint16_t FTW;
2645	/** 0x0a - Alignment word */
2646	uint16_t Dummy3;
2647
2648	/** 0x0c - Instruction pointer. */
2649	uint32_t FPUIP;
2650	/** 0x10 - Code selector. */
2651	uint16_t CS;
2652	/** 0x12 - Opcode. */
2653	uint16_t FOP;
2654	/** 0x14 - FOO. */
2655	uint32_t FPUOO;
2656	/** 0x18 - FOS. */
2657	uint32_t FPUOS;
2658	/** 0x1c - FPU register. */
2659	X86FPUREG regs[8];
2660	} X86FPUSTATE;
2661	#pragma pack()
2662	/** Pointer to a FPU state. */
2663	typedef X86FPUSTATE *PX86FPUSTATE;
2664	/** Pointer to a const FPU state. */
2665	typedef const X86FPUSTATE *PCX86FPUSTATE;
2666
2667	/**
2668	* FPU Extended state (aka FXSAVE/FXRSTORE Memory Region).
2669	*/
2670	#pragma pack(1)
2671	typedef struct X86FXSTATE
2672	{
2673	/** 0x00 - Control word. */
2674	uint16_t FCW;
2675	/** 0x02 - Status word. */
2676	uint16_t FSW;
2677	/** 0x04 - Tag word. (The upper byte is always zero.) */
2678	uint16_t FTW;
2679	/** 0x06 - Opcode. */
2680	uint16_t FOP;
2681	/** 0x08 - Instruction pointer. */
2682	uint32_t FPUIP;
2683	/** 0x0c - Code selector. */
2684	uint16_t CS;
2685	uint16_t Rsrvd1;
2686	/** 0x10 - Data pointer. */
2687	uint32_t FPUDP;
2688	/** 0x14 - Data segment */
2689	uint16_t DS;
2690	/** 0x16 */
2691	uint16_t Rsrvd2;
2692	/** 0x18 */
2693	uint32_t MXCSR;
2694	/** 0x1c */
2695	uint32_t MXCSR_MASK;
2696	/** 0x20 - FPU registers. */
2697	X86FPUREG aRegs[8];
2698	/** 0xA0 - XMM registers - 8 registers in 32 bits mode, 16 in long mode. */
2699	X86XMMREG aXMM[16];
2700	/* - offset 416 - */
2701	uint32_t au32RsrvdRest[(464 - 416) / sizeof(uint32_t)];
2702	/* - offset 464 - Software usable reserved bits. */
2703	uint32_t au32RsrvdForSoftware[(512 - 464) / sizeof(uint32_t)];
2704	} X86FXSTATE;
2705	#pragma pack()
2706	/** Pointer to a FPU Extended state. */
2707	typedef X86FXSTATE *PX86FXSTATE;
2708	/** Pointer to a const FPU Extended state. */
2709	typedef const X86FXSTATE *PCX86FXSTATE;
2710
2711	/** Offset for software usable reserved bits (464:511) where we store a 32-bit
2712	* magic. Don't forget to update x86.mac if you change this! */
2713	#define X86_OFF_FXSTATE_RSVD 0x1d0
2714	/** The 32-bit magic used to recognize if this a 32-bit FPU state. Don't
2715	* forget to update x86.mac if you change this!
2716	* @todo r=bird: This has nothing what-so-ever to do here.... */
2717	#define X86_FXSTATE_RSVD_32BIT_MAGIC 0x32b3232b
2718	#ifndef VBOX_FOR_DTRACE_LIB
2719	AssertCompileSize(X86FXSTATE, 512);
2720	AssertCompileMemberOffset(X86FXSTATE, au32RsrvdForSoftware, X86_OFF_FXSTATE_RSVD);
2721	#endif
2722
2723	/** @name FPU status word flags.
2724	* @{ */
2725	/** Exception Flag: Invalid operation. */
2726	#define X86_FSW_IE RT_BIT_32(0)
2727	/** Exception Flag: Denormalized operand. */
2728	#define X86_FSW_DE RT_BIT_32(1)
2729	/** Exception Flag: Zero divide. */
2730	#define X86_FSW_ZE RT_BIT_32(2)
2731	/** Exception Flag: Overflow. */
2732	#define X86_FSW_OE RT_BIT_32(3)
2733	/** Exception Flag: Underflow. */
2734	#define X86_FSW_UE RT_BIT_32(4)
2735	/** Exception Flag: Precision. */
2736	#define X86_FSW_PE RT_BIT_32(5)
2737	/** Stack fault. */
2738	#define X86_FSW_SF RT_BIT_32(6)
2739	/** Error summary status. */
2740	#define X86_FSW_ES RT_BIT_32(7)
2741	/** Mask of exceptions flags, excluding the summary bit. */
2742	#define X86_FSW_XCPT_MASK UINT16_C(0x007f)
2743	/** Mask of exceptions flags, including the summary bit. */
2744	#define X86_FSW_XCPT_ES_MASK UINT16_C(0x00ff)
2745	/** Condition code 0. */
2746	#define X86_FSW_C0 RT_BIT_32(8)
2747	/** Condition code 1. */
2748	#define X86_FSW_C1 RT_BIT_32(9)
2749	/** Condition code 2. */
2750	#define X86_FSW_C2 RT_BIT_32(10)
2751	/** Top of the stack mask. */
2752	#define X86_FSW_TOP_MASK UINT16_C(0x3800)
2753	/** TOP shift value. */
2754	#define X86_FSW_TOP_SHIFT 11
2755	/** Mask for getting TOP value after shifting it right. */
2756	#define X86_FSW_TOP_SMASK UINT16_C(0x0007)
2757	/** Get the TOP value. */
2758	#define X86_FSW_TOP_GET(a_uFsw) (((a_uFsw) >> X86_FSW_TOP_SHIFT) & X86_FSW_TOP_SMASK)
2759	/** Condition code 3. */
2760	#define X86_FSW_C3 RT_BIT_32(14)
2761	/** Mask of exceptions flags, including the summary bit. */
2762	#define X86_FSW_C_MASK UINT16_C(0x4700)
2763	/** FPU busy. */
2764	#define X86_FSW_B RT_BIT_32(15)
2765	/** @} */
2766
2767
2768	/** @name FPU control word flags.
2769	* @{ */
2770	/** Exception Mask: Invalid operation. */
2771	#define X86_FCW_IM RT_BIT_32(0)
2772	/** Exception Mask: Denormalized operand. */
2773	#define X86_FCW_DM RT_BIT_32(1)
2774	/** Exception Mask: Zero divide. */
2775	#define X86_FCW_ZM RT_BIT_32(2)
2776	/** Exception Mask: Overflow. */
2777	#define X86_FCW_OM RT_BIT_32(3)
2778	/** Exception Mask: Underflow. */
2779	#define X86_FCW_UM RT_BIT_32(4)
2780	/** Exception Mask: Precision. */
2781	#define X86_FCW_PM RT_BIT_32(5)
2782	/** Mask all exceptions, the value typically loaded (by for instance fninit).
2783	* @remarks This includes reserved bit 6. */
2784	#define X86_FCW_MASK_ALL UINT16_C(0x007f)
2785	/** Mask all exceptions. Same as X86_FSW_XCPT_MASK. */
2786	#define X86_FCW_XCPT_MASK UINT16_C(0x003f)
2787	/** Precision control mask. */
2788	#define X86_FCW_PC_MASK UINT16_C(0x0300)
2789	/** Precision control: 24-bit. */
2790	#define X86_FCW_PC_24 UINT16_C(0x0000)
2791	/** Precision control: Reserved. */
2792	#define X86_FCW_PC_RSVD UINT16_C(0x0100)
2793	/** Precision control: 53-bit. */
2794	#define X86_FCW_PC_53 UINT16_C(0x0200)
2795	/** Precision control: 64-bit. */
2796	#define X86_FCW_PC_64 UINT16_C(0x0300)
2797	/** Rounding control mask. */
2798	#define X86_FCW_RC_MASK UINT16_C(0x0c00)
2799	/** Rounding control: To nearest. */
2800	#define X86_FCW_RC_NEAREST UINT16_C(0x0000)
2801	/** Rounding control: Down. */
2802	#define X86_FCW_RC_DOWN UINT16_C(0x0400)
2803	/** Rounding control: Up. */
2804	#define X86_FCW_RC_UP UINT16_C(0x0800)
2805	/** Rounding control: Towards zero. */
2806	#define X86_FCW_RC_ZERO UINT16_C(0x0c00)
2807	/** Bits which should be zero, apparently. */
2808	#define X86_FCW_ZERO_MASK UINT16_C(0xf080)
2809	/** @} */
2810
2811	/** @name SSE MXCSR
2812	* @{ */
2813	/** Exception Flag: Invalid operation. */
2814	#define X86_MXSCR_IE RT_BIT_32(0)
2815	/** Exception Flag: Denormalized operand. */
2816	#define X86_MXSCR_DE RT_BIT_32(1)
2817	/** Exception Flag: Zero divide. */
2818	#define X86_MXSCR_ZE RT_BIT_32(2)
2819	/** Exception Flag: Overflow. */
2820	#define X86_MXSCR_OE RT_BIT_32(3)
2821	/** Exception Flag: Underflow. */
2822	#define X86_MXSCR_UE RT_BIT_32(4)
2823	/** Exception Flag: Precision. */
2824	#define X86_MXSCR_PE RT_BIT_32(5)
2825
2826	/** Denormals are zero. */
2827	#define X86_MXSCR_DAZ RT_BIT_32(6)
2828
2829	/** Exception Mask: Invalid operation. */
2830	#define X86_MXSCR_IM RT_BIT_32(7)
2831	/** Exception Mask: Denormalized operand. */
2832	#define X86_MXSCR_DM RT_BIT_32(8)
2833	/** Exception Mask: Zero divide. */
2834	#define X86_MXSCR_ZM RT_BIT_32(9)
2835	/** Exception Mask: Overflow. */
2836	#define X86_MXSCR_OM RT_BIT_32(10)
2837	/** Exception Mask: Underflow. */
2838	#define X86_MXSCR_UM RT_BIT_32(11)
2839	/** Exception Mask: Precision. */
2840	#define X86_MXSCR_PM RT_BIT_32(12)
2841
2842	/** Rounding control mask. */
2843	#define X86_MXSCR_RC_MASK UINT16_C(0x6000)
2844	/** Rounding control: To nearest. */
2845	#define X86_MXSCR_RC_NEAREST UINT16_C(0x0000)
2846	/** Rounding control: Down. */
2847	#define X86_MXSCR_RC_DOWN UINT16_C(0x2000)
2848	/** Rounding control: Up. */
2849	#define X86_MXSCR_RC_UP UINT16_C(0x4000)
2850	/** Rounding control: Towards zero. */
2851	#define X86_MXSCR_RC_ZERO UINT16_C(0x6000)
2852
2853	/** Flush-to-zero for masked underflow. */
2854	#define X86_MXSCR_FZ RT_BIT_32(15)
2855
2856	/** Misaligned Exception Mask (AMD MISALIGNSSE). */
2857	#define X86_MXSCR_MM RT_BIT_32(17)
2858	/** @} */
2859
2860	/**
2861	* XSAVE header.
2862	*/
2863	typedef struct X86XSAVEHDR
2864	{
2865	/** XTATE_BV - Bitmap indicating whether a component is in the state. */
2866	uint64_t bmXState;
2867	/** XCOMP_BC - Bitmap used by instructions applying structure compaction. */
2868	uint64_t bmXComp;
2869	/** Reserved for furture extensions, probably MBZ. */
2870	uint64_t au64Reserved[6];
2871	} X86XSAVEHDR;
2872	#ifndef VBOX_FOR_DTRACE_LIB
2873	AssertCompileSize(X86XSAVEHDR, 64);
2874	#endif
2875	/** Pointer to an XSAVE header. */
2876	typedef X86XSAVEHDR *PX86XSAVEHDR;
2877	/** Pointer to a const XSAVE header. */
2878	typedef X86XSAVEHDR const *PCX86XSAVEHDR;
2879
2880
2881	/**
2882	* The high 128-bit YMM register state (XSAVE_C_YMM).
2883	* (The lower 128-bits being in X86FXSTATE.)
2884	*/
2885	typedef struct X86XSAVEYMMHI
2886	{
2887	/** 16 registers in 64-bit mode, 8 in 32-bit mode. */
2888	X86XMMREG aYmmHi[16];
2889	} X86XSAVEYMMHI;
2890	#ifndef VBOX_FOR_DTRACE_LIB
2891	AssertCompileSize(X86XSAVEYMMHI, 256);
2892	#endif
2893	/** Pointer to a high 128-bit YMM register state. */
2894	typedef X86XSAVEYMMHI *PX86XSAVEYMMHI;
2895	/** Pointer to a const high 128-bit YMM register state. */
2896	typedef X86XSAVEYMMHI const *PCX86XSAVEYMMHI;
2897
2898	/**
2899	* Intel MPX bound registers state (XSAVE_C_BNDREGS).
2900	*/
2901	typedef struct X86XSAVEBNDREGS
2902	{
2903	/** Array of registers (BND0...BND3). */
2904	struct
2905	{
2906	/** Lower bound. */
2907	uint64_t uLowerBound;
2908	/** Upper bound. */
2909	uint64_t uUpperBound;
2910	} aRegs[4];
2911	} X86XSAVEBNDREGS;
2912	#ifndef VBOX_FOR_DTRACE_LIB
2913	AssertCompileSize(X86XSAVEBNDREGS, 64);
2914	#endif
2915	/** Pointer to a MPX bound register state. */
2916	typedef X86XSAVEBNDREGS *PX86XSAVEBNDREGS;
2917	/** Pointer to a const MPX bound register state. */
2918	typedef X86XSAVEBNDREGS const *PCX86XSAVEBNDREGS;
2919
2920	/**
2921	* Intel MPX bound config and status register state (XSAVE_C_BNDCSR).
2922	*/
2923	typedef struct X86XSAVEBNDCFG
2924	{
2925	uint64_t fConfig;
2926	uint64_t fStatus;
2927	} X86XSAVEBNDCFG;
2928	#ifndef VBOX_FOR_DTRACE_LIB
2929	AssertCompileSize(X86XSAVEBNDCFG, 16);
2930	#endif
2931	/** Pointer to a MPX bound config and status register state. */
2932	typedef X86XSAVEBNDCFG *PX86XSAVEBNDCFG;
2933	/** Pointer to a const MPX bound config and status register state. */
2934	typedef X86XSAVEBNDCFG *PCX86XSAVEBNDCFG;
2935
2936	/**
2937	* AVX-512 opmask state (XSAVE_C_OPMASK).
2938	*/
2939	typedef struct X86XSAVEOPMASK
2940	{
2941	/** The K0..K7 values. */
2942	uint64_t aKRegs[8];
2943	} X86XSAVEOPMASK;
2944	#ifndef VBOX_FOR_DTRACE_LIB
2945	AssertCompileSize(X86XSAVEOPMASK, 64);
2946	#endif
2947	/** Pointer to a AVX-512 opmask state. */
2948	typedef X86XSAVEOPMASK *PX86XSAVEOPMASK;
2949	/** Pointer to a const AVX-512 opmask state. */
2950	typedef X86XSAVEOPMASK const *PCX86XSAVEOPMASK;
2951
2952	/**
2953	* ZMM0-15 upper 256 bits introduced in AVX-512 (XSAVE_C_ZMM_HI256).
2954	*/
2955	typedef struct X86XSAVEZMMHI256
2956	{
2957	/** Upper 256-bits of ZMM0-15. */
2958	X86YMMREG aHi256Regs[16];
2959	} X86XSAVEZMMHI256;
2960	#ifndef VBOX_FOR_DTRACE_LIB
2961	AssertCompileSize(X86XSAVEZMMHI256, 512);
2962	#endif
2963	/** Pointer to a state comprising the upper 256-bits of ZMM0-15. */
2964	typedef X86XSAVEZMMHI256 *PX86XSAVEZMMHI256;
2965	/** Pointer to a const state comprising the upper 256-bits of ZMM0-15. */
2966	typedef X86XSAVEZMMHI256 const *PCX86XSAVEZMMHI256;
2967
2968	/**
2969	* ZMM16-31 register state introduced in AVX-512 (XSAVE_C_ZMM_16HI).
2970	*/
2971	typedef struct X86XSAVEZMM16HI
2972	{
2973	/** ZMM16 thru ZMM31. */
2974	X86ZMMREG aRegs[16];
2975	} X86XSAVEZMM16HI;
2976	#ifndef VBOX_FOR_DTRACE_LIB
2977	AssertCompileSize(X86XSAVEZMM16HI, 1024);
2978	#endif
2979	/** Pointer to a state comprising ZMM16-32. */
2980	typedef X86XSAVEZMM16HI *PX86XSAVEZMM16HI;
2981	/** Pointer to a const state comprising ZMM16-32. */
2982	typedef X86XSAVEZMM16HI const *PCX86XSAVEZMM16HI;
2983
2984	/**
2985	* AMD Light weight profiling state (XSAVE_C_LWP).
2986	*
2987	* We probably won't play with this as AMD seems to be dropping from their "zen"
2988	* processor micro architecture.
2989	*/
2990	typedef struct X86XSAVELWP
2991	{
2992	/** Details when needed. */
2993	uint64_t auLater[128/8];
2994	} X86XSAVELWP;
2995	#ifndef VBOX_FOR_DTRACE_LIB
2996	AssertCompileSize(X86XSAVELWP, 128);
2997	#endif
2998
2999
3000	/**
3001	* x86 FPU/SSE/AVX/XXXX state.
3002	*
3003	* Please bump DBGFCORE_FMT_VERSION by 1 in dbgfcorefmt.h if you make any
3004	* changes to this structure.
3005	*/
3006	typedef struct X86XSAVEAREA
3007	{
3008	/** The x87 and SSE region (or legacy region if you like). */
3009	X86FXSTATE x87;
3010	/** The XSAVE header. */
3011	X86XSAVEHDR Hdr;
3012	/** Beyond the header, there isn't really a fixed layout, but we can
3013	generally assume the YMM (AVX) register extensions are present and
3014	follows immediately. */
3015	union
3016	{
3017	/** This is a typical layout on intel CPUs (good for debuggers). */
3018	struct
3019	{
3020	X86XSAVEYMMHI YmmHi;
3021	X86XSAVEBNDREGS BndRegs;
3022	X86XSAVEBNDCFG BndCfg;
3023	uint8_t abFudgeToMatchDocs[0xB0];
3024	X86XSAVEOPMASK Opmask;
3025	X86XSAVEZMMHI256 ZmmHi256;
3026	X86XSAVEZMM16HI Zmm16Hi;
3027	} Intel;
3028
3029	/** This is a typical layout on AMD Bulldozer type CPUs (good for debuggers). */
3030	struct
3031	{
3032	X86XSAVEYMMHI YmmHi;
3033	X86XSAVELWP Lwp;
3034	} AmdBd;
3035
3036	/** To enbling static deployments that have a reasonable chance of working for
3037	* the next 3-6 CPU generations without running short on space, we allocate a
3038	* lot of extra space here, making the structure a round 8KB in size. This
3039	* leaves us 7616 bytes for extended state. The skylake xeons are likely to use
3040	* 2112 of these, leaving us with 5504 bytes for future Intel generations. */
3041	uint8_t ab[8192 - 512 - 64];
3042	} u;
3043	} X86XSAVEAREA;
3044	#ifndef VBOX_FOR_DTRACE_LIB
3045	AssertCompileSize(X86XSAVEAREA, 8192);
3046	AssertCompileMemberSize(X86XSAVEAREA, u.Intel, 0x840 /2112 => total 0xa80 (2688) /);
3047	AssertCompileMemberOffset(X86XSAVEAREA, Hdr, 0x200);
3048	AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.YmmHi, 0x240);
3049	AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.BndRegs, 0x340);
3050	AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.BndCfg, 0x380);
3051	AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.Opmask, 0x440 /* 1088 */);
3052	AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.ZmmHi256, 0x480 /* 1152 */);
3053	AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.Zmm16Hi, 0x680 /* 1664 */);
3054	#endif
3055	/** Pointer to a XSAVE area. */
3056	typedef X86XSAVEAREA *PX86XSAVEAREA;
3057	/** Pointer to a const XSAVE area. */
3058	typedef X86XSAVEAREA const *PCX86XSAVEAREA;
3059
3060
3061	/** @name XSAVE_C_XXX - XSAVE State Components Bits.
3062	* @{ */
3063	/** Bit 0 - x87 - Legacy FPU state (bit number) */
3064	#define XSAVE_C_X87_BIT 0
3065	/** Bit 0 - x87 - Legacy FPU state. */
3066	#define XSAVE_C_X87 RT_BIT_64(XSAVE_C_X87_BIT)
3067	/** Bit 1 - SSE - 128-bit SSE state (bit number). */
3068	#define XSAVE_C_SSE_BIT 1
3069	/** Bit 1 - SSE - 128-bit SSE state. */
3070	#define XSAVE_C_SSE RT_BIT_64(XSAVE_C_SSE_BIT)
3071	/** Bit 2 - YMM_Hi128 - Upper 128 bits of YMM0-15 (AVX) (bit number). */
3072	#define XSAVE_C_YMM_BIT 2
3073	/** Bit 2 - YMM_Hi128 - Upper 128 bits of YMM0-15 (AVX). */
3074	#define XSAVE_C_YMM RT_BIT_64(XSAVE_C_YMM_BIT)
3075	/** Bit 3 - BNDREGS - MPX bound register state (bit number). */
3076	#define XSAVE_C_BNDREGS_BIT 3
3077	/** Bit 3 - BNDREGS - MPX bound register state. */
3078	#define XSAVE_C_BNDREGS RT_BIT_64(XSAVE_C_BNDREGS_BIT)
3079	/** Bit 4 - BNDCSR - MPX bound config and status state (bit number). */
3080	#define XSAVE_C_BNDCSR_BIT 4
3081	/** Bit 4 - BNDCSR - MPX bound config and status state. */
3082	#define XSAVE_C_BNDCSR RT_BIT_64(XSAVE_C_BNDCSR_BIT)
3083	/** Bit 5 - Opmask - opmask state (bit number). */
3084	#define XSAVE_C_OPMASK_BIT 5
3085	/** Bit 5 - Opmask - opmask state. */
3086	#define XSAVE_C_OPMASK RT_BIT_64(XSAVE_C_OPMASK_BIT)
3087	/** Bit 6 - ZMM_Hi256 - Upper 256 bits of ZMM0-15 (AVX-512) (bit number). */
3088	#define XSAVE_C_ZMM_HI256_BIT 6
3089	/** Bit 6 - ZMM_Hi256 - Upper 256 bits of ZMM0-15 (AVX-512). */
3090	#define XSAVE_C_ZMM_HI256 RT_BIT_64(XSAVE_C_ZMM_HI256_BIT)
3091	/** Bit 7 - Hi16_ZMM - 512-bits ZMM16-31 state (AVX-512) (bit number). */
3092	#define XSAVE_C_ZMM_16HI_BIT 7
3093	/** Bit 7 - Hi16_ZMM - 512-bits ZMM16-31 state (AVX-512). */
3094	#define XSAVE_C_ZMM_16HI RT_BIT_64(XSAVE_C_ZMM_16HI_BIT)
3095	/** Bit 9 - PKRU - Protection-key state (bit number). */
3096	#define XSAVE_C_PKRU_BIT 9
3097	/** Bit 9 - PKRU - Protection-key state. */
3098	#define XSAVE_C_PKRU RT_BIT_64(XSAVE_C_PKRU_BIT)
3099	/** Bit 62 - LWP - Lightweight Profiling (AMD) (bit number). */
3100	#define XSAVE_C_LWP_BIT 62
3101	/** Bit 62 - LWP - Lightweight Profiling (AMD). */
3102	#define XSAVE_C_LWP RT_BIT_64(XSAVE_C_LWP_BIT)
3103	/** @} */
3104
3105
3106
3107	/** @name Selector Descriptor
3108	* @{
3109	*/
3110
3111	#ifndef VBOX_FOR_DTRACE_LIB
3112	/**
3113	* Descriptor attributes (as seen by VT-x).
3114	*/
3115	typedef struct X86DESCATTRBITS
3116	{
3117	/** 00 - Segment Type. */
3118	unsigned u4Type : 4;
3119	/** 04 - Descriptor Type. System(=0) or code/data selector */
3120	unsigned u1DescType : 1;
3121	/** 05 - Descriptor Privilege level. */
3122	unsigned u2Dpl : 2;
3123	/** 07 - Flags selector present(=1) or not. */
3124	unsigned u1Present : 1;
3125	/** 08 - Segment limit 16-19. */
3126	unsigned u4LimitHigh : 4;
3127	/** 0c - Available for system software. */
3128	unsigned u1Available : 1;
3129	/** 0d - 32 bits mode: Reserved - 0, long mode: Long Attribute Bit. */
3130	unsigned u1Long : 1;
3131	/** 0e - This flags meaning depends on the segment type. Try make sense out
3132	* of the intel manual yourself. */
3133	unsigned u1DefBig : 1;
3134	/** 0f - Granularity of the limit. If set 4KB granularity is used, if
3135	* clear byte. */
3136	unsigned u1Granularity : 1;
3137	/** 10 - "Unusable" selector, special Intel (VT-x only?) bit. */
3138	unsigned u1Unusable : 1;
3139	} X86DESCATTRBITS;
3140	#endif /* !VBOX_FOR_DTRACE_LIB */
3141
3142	/** @name X86DESCATTR masks
3143	* @{ */
3144	#define X86DESCATTR_TYPE UINT32_C(0x0000000f)
3145	#define X86DESCATTR_DT UINT32_C(0x00000010)
3146	#define X86DESCATTR_DPL UINT32_C(0x00000060)
3147	#define X86DESCATTR_DPL_SHIFT 5 /*< Shift count for the DPL value. /
3148	#define X86DESCATTR_P UINT32_C(0x00000080)
3149	#define X86DESCATTR_LIMIT_HIGH UINT32_C(0x00000f00)
3150	#define X86DESCATTR_AVL UINT32_C(0x00001000)
3151	#define X86DESCATTR_L UINT32_C(0x00002000)
3152	#define X86DESCATTR_D UINT32_C(0x00004000)
3153	#define X86DESCATTR_G UINT32_C(0x00008000)
3154	#define X86DESCATTR_UNUSABLE UINT32_C(0x00010000)
3155	/** @} */
3156
3157	#pragma pack(1)
3158	typedef union X86DESCATTR
3159	{
3160	/** Unsigned integer view. */
3161	uint32_t u;
3162	#ifndef VBOX_FOR_DTRACE_LIB
3163	/** Normal view. */
3164	X86DESCATTRBITS n;
3165	#endif
3166	} X86DESCATTR;
3167	#pragma pack()
3168	/** Pointer to descriptor attributes. */
3169	typedef X86DESCATTR *PX86DESCATTR;
3170	/** Pointer to const descriptor attributes. */
3171	typedef const X86DESCATTR *PCX86DESCATTR;
3172
3173	#ifndef VBOX_FOR_DTRACE_LIB
3174
3175	/**
3176	* Generic descriptor table entry
3177	*/
3178	#pragma pack(1)
3179	typedef struct X86DESCGENERIC
3180	{
3181	/** 00 - Limit - Low word. */
3182	unsigned u16LimitLow : 16;
3183	/** 10 - Base address - low word.
3184	* Don't try set this to 24 because MSC is doing stupid things then. */
3185	unsigned u16BaseLow : 16;
3186	/** 20 - Base address - first 8 bits of high word. */
3187	unsigned u8BaseHigh1 : 8;
3188	/** 28 - Segment Type. */
3189	unsigned u4Type : 4;
3190	/** 2c - Descriptor Type. System(=0) or code/data selector */
3191	unsigned u1DescType : 1;
3192	/** 2d - Descriptor Privilege level. */
3193	unsigned u2Dpl : 2;
3194	/** 2f - Flags selector present(=1) or not. */
3195	unsigned u1Present : 1;
3196	/** 30 - Segment limit 16-19. */
3197	unsigned u4LimitHigh : 4;
3198	/** 34 - Available for system software. */
3199	unsigned u1Available : 1;
3200	/** 35 - 32 bits mode: Reserved - 0, long mode: Long Attribute Bit. */
3201	unsigned u1Long : 1;
3202	/** 36 - This flags meaning depends on the segment type. Try make sense out
3203	* of the intel manual yourself. */
3204	unsigned u1DefBig : 1;
3205	/** 37 - Granularity of the limit. If set 4KB granularity is used, if
3206	* clear byte. */
3207	unsigned u1Granularity : 1;
3208	/** 38 - Base address - highest 8 bits. */
3209	unsigned u8BaseHigh2 : 8;
3210	} X86DESCGENERIC;
3211	#pragma pack()
3212	/** Pointer to a generic descriptor entry. */
3213	typedef X86DESCGENERIC *PX86DESCGENERIC;
3214	/** Pointer to a const generic descriptor entry. */
3215	typedef const X86DESCGENERIC *PCX86DESCGENERIC;
3216
3217	/** @name Bit offsets of X86DESCGENERIC members.
3218	* @{*/
3219	#define X86DESCGENERIC_BIT_OFF_LIMIT_LOW (0) /*< Bit offset of X86DESCGENERIC::u16LimitLow. /
3220	#define X86DESCGENERIC_BIT_OFF_BASE_LOW (16) /*< Bit offset of X86DESCGENERIC::u16BaseLow. /
3221	#define X86DESCGENERIC_BIT_OFF_BASE_HIGH1 (32) /*< Bit offset of X86DESCGENERIC::u8BaseHigh1. /
3222	#define X86DESCGENERIC_BIT_OFF_TYPE (40) /*< Bit offset of X86DESCGENERIC::u4Type. /
3223	#define X86DESCGENERIC_BIT_OFF_DESC_TYPE (44) /*< Bit offset of X86DESCGENERIC::u1DescType. /
3224	#define X86DESCGENERIC_BIT_OFF_DPL (45) /*< Bit offset of X86DESCGENERIC::u2Dpl. /
3225	#define X86DESCGENERIC_BIT_OFF_PRESENT (47) /*< Bit offset of X86DESCGENERIC::uu1Present. /
3226	#define X86DESCGENERIC_BIT_OFF_LIMIT_HIGH (48) /*< Bit offset of X86DESCGENERIC::u4LimitHigh. /
3227	#define X86DESCGENERIC_BIT_OFF_AVAILABLE (52) /*< Bit offset of X86DESCGENERIC::u1Available. /
3228	#define X86DESCGENERIC_BIT_OFF_LONG (53) /*< Bit offset of X86DESCGENERIC::u1Long. /
3229	#define X86DESCGENERIC_BIT_OFF_DEF_BIG (54) /*< Bit offset of X86DESCGENERIC::u1DefBig. /
3230	#define X86DESCGENERIC_BIT_OFF_GRANULARITY (55) /*< Bit offset of X86DESCGENERIC::u1Granularity. /
3231	#define X86DESCGENERIC_BIT_OFF_BASE_HIGH2 (56) /*< Bit offset of X86DESCGENERIC::u8BaseHigh2. /
3232	/** @} */
3233
3234
3235	/** @name LAR mask
3236	* @{ */
3237	#define X86LAR_F_TYPE UINT16_C( 0x0f00)
3238	#define X86LAR_F_DT UINT16_C( 0x1000)
3239	#define X86LAR_F_DPL UINT16_C( 0x6000)
3240	#define X86LAR_F_DPL_SHIFT 13 /*< Shift count for the DPL value. /
3241	#define X86LAR_F_P UINT16_C( 0x8000)
3242	#define X86LAR_F_AVL UINT32_C(0x00100000)
3243	#define X86LAR_F_L UINT32_C(0x00200000)
3244	#define X86LAR_F_D UINT32_C(0x00400000)
3245	#define X86LAR_F_G UINT32_C(0x00800000)
3246	/** @} */
3247
3248
3249	/**
3250	* Call-, Interrupt-, Trap- or Task-gate descriptor (legacy).
3251	*/
3252	typedef struct X86DESCGATE
3253	{
3254	/** 00 - Target code segment offset - Low word.
3255	* Ignored if task-gate. */
3256	unsigned u16OffsetLow : 16;
3257	/** 10 - Target code segment selector for call-, interrupt- and trap-gates,
3258	* TSS selector if task-gate. */
3259	unsigned u16Sel : 16;
3260	/** 20 - Number of parameters for a call-gate.
3261	* Ignored if interrupt-, trap- or task-gate. */
3262	unsigned u4ParmCount : 4;
3263	/** 24 - Reserved / ignored. */
3264	unsigned u4Reserved : 4;
3265	/** 28 - Segment Type. */
3266	unsigned u4Type : 4;
3267	/** 2c - Descriptor Type (0 = system). */
3268	unsigned u1DescType : 1;
3269	/** 2d - Descriptor Privilege level. */
3270	unsigned u2Dpl : 2;
3271	/** 2f - Flags selector present(=1) or not. */
3272	unsigned u1Present : 1;
3273	/** 30 - Target code segment offset - High word.
3274	* Ignored if task-gate. */
3275	unsigned u16OffsetHigh : 16;
3276	} X86DESCGATE;
3277	/** Pointer to a Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
3278	typedef X86DESCGATE *PX86DESCGATE;
3279	/** Pointer to a const Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
3280	typedef const X86DESCGATE *PCX86DESCGATE;
3281
3282	#endif /* VBOX_FOR_DTRACE_LIB */
3283
3284	/**
3285	* Descriptor table entry.
3286	*/
3287	#pragma pack(1)
3288	typedef union X86DESC
3289	{
3290	#ifndef VBOX_FOR_DTRACE_LIB
3291	/** Generic descriptor view. */
3292	X86DESCGENERIC Gen;
3293	/** Gate descriptor view. */
3294	X86DESCGATE Gate;
3295	#endif
3296
3297	/** 8 bit unsigned integer view. */
3298	uint8_t au8[8];
3299	/** 16 bit unsigned integer view. */
3300	uint16_t au16[4];
3301	/** 32 bit unsigned integer view. */
3302	uint32_t au32[2];
3303	/** 64 bit unsigned integer view. */
3304	uint64_t au64[1];
3305	/** Unsigned integer view. */
3306	uint64_t u;
3307	} X86DESC;
3308	#ifndef VBOX_FOR_DTRACE_LIB
3309	AssertCompileSize(X86DESC, 8);
3310	#endif
3311	#pragma pack()
3312	/** Pointer to descriptor table entry. */
3313	typedef X86DESC *PX86DESC;
3314	/** Pointer to const descriptor table entry. */
3315	typedef const X86DESC *PCX86DESC;
3316
3317	/** @def X86DESC_BASE
3318	* Return the base address of a descriptor.
3319	*/
3320	#define X86DESC_BASE(a_pDesc) /ASM-NOINC/ \
3321	( ((uint32_t)((a_pDesc)->Gen.u8BaseHigh2) << 24) \
3322	\| ( (a_pDesc)->Gen.u8BaseHigh1 << 16) \
3323	\| ( (a_pDesc)->Gen.u16BaseLow ) )
3324
3325	/** @def X86DESC_LIMIT
3326	* Return the limit of a descriptor.
3327	*/
3328	#define X86DESC_LIMIT(a_pDesc) /ASM-NOINC/ \
3329	( ((uint32_t)((a_pDesc)->Gen.u4LimitHigh) << 16) \
3330	\| ( (a_pDesc)->Gen.u16LimitLow ) )
3331
3332	/** @def X86DESC_LIMIT_G
3333	* Return the limit of a descriptor with the granularity bit taken into account.
3334	* @returns Selector limit (uint32_t).
3335	* @param a_pDesc Pointer to the descriptor.
3336	*/
3337	#define X86DESC_LIMIT_G(a_pDesc) /ASM-NOINC/ \
3338	( (a_pDesc)->Gen.u1Granularity \
3339	? ( ( ((uint32_t)(a_pDesc)->Gen.u4LimitHigh << 16) \| (a_pDesc)->Gen.u16LimitLow ) << 12 ) \| UINT32_C(0xfff) \
3340	: ((uint32_t)(a_pDesc)->Gen.u4LimitHigh << 16) \| (a_pDesc)->Gen.u16LimitLow \
3341	)
3342
3343	/** @def X86DESC_GET_HID_ATTR
3344	* Get the descriptor attributes for the hidden register.
3345	*/
3346	#define X86DESC_GET_HID_ATTR(a_pDesc) /ASM-NOINC/ \
3347	( ((a_pDesc)->u >> (16+16+8)) & UINT32_C(0xf0ff) ) /** @todo do we have a define for 0xf0ff? */
3348
3349	#ifndef VBOX_FOR_DTRACE_LIB
3350
3351	/**
3352	* 64 bits generic descriptor table entry
3353	* Note: most of these bits have no meaning in long mode.
3354	*/
3355	#pragma pack(1)
3356	typedef struct X86DESC64GENERIC
3357	{
3358	/** Limit - Low word - IGNORED. */
3359	uint32_t u16LimitLow : 16;
3360	/** Base address - low word. - IGNORED
3361	* Don't try set this to 24 because MSC is doing stupid things then. */
3362	uint32_t u16BaseLow : 16;
3363	/** Base address - first 8 bits of high word. - IGNORED */
3364	uint32_t u8BaseHigh1 : 8;
3365	/** Segment Type. */
3366	uint32_t u4Type : 4;
3367	/** Descriptor Type. System(=0) or code/data selector */
3368	uint32_t u1DescType : 1;
3369	/** Descriptor Privilege level. */
3370	uint32_t u2Dpl : 2;
3371	/** Flags selector present(=1) or not. */
3372	uint32_t u1Present : 1;
3373	/** Segment limit 16-19. - IGNORED */
3374	uint32_t u4LimitHigh : 4;
3375	/** Available for system software. - IGNORED */
3376	uint32_t u1Available : 1;
3377	/** Long mode flag. */
3378	uint32_t u1Long : 1;
3379	/** This flags meaning depends on the segment type. Try make sense out
3380	* of the intel manual yourself. */
3381	uint32_t u1DefBig : 1;
3382	/** Granularity of the limit. If set 4KB granularity is used, if
3383	* clear byte. - IGNORED */
3384	uint32_t u1Granularity : 1;
3385	/** Base address - highest 8 bits. - IGNORED */
3386	uint32_t u8BaseHigh2 : 8;
3387	/** Base address - bits 63-32. */
3388	uint32_t u32BaseHigh3 : 32;
3389	uint32_t u8Reserved : 8;
3390	uint32_t u5Zeros : 5;
3391	uint32_t u19Reserved : 19;
3392	} X86DESC64GENERIC;
3393	#pragma pack()
3394	/** Pointer to a generic descriptor entry. */
3395	typedef X86DESC64GENERIC *PX86DESC64GENERIC;
3396	/** Pointer to a const generic descriptor entry. */
3397	typedef const X86DESC64GENERIC *PCX86DESC64GENERIC;
3398
3399	/**
3400	* System descriptor table entry (64 bits)
3401	*
3402	* @remarks This is, save a couple of comments, identical to X86DESC64GENERIC...
3403	*/
3404	#pragma pack(1)
3405	typedef struct X86DESC64SYSTEM
3406	{
3407	/** Limit - Low word. */
3408	uint32_t u16LimitLow : 16;
3409	/** Base address - low word.
3410	* Don't try set this to 24 because MSC is doing stupid things then. */
3411	uint32_t u16BaseLow : 16;
3412	/** Base address - first 8 bits of high word. */
3413	uint32_t u8BaseHigh1 : 8;
3414	/** Segment Type. */
3415	uint32_t u4Type : 4;
3416	/** Descriptor Type. System(=0) or code/data selector */
3417	uint32_t u1DescType : 1;
3418	/** Descriptor Privilege level. */
3419	uint32_t u2Dpl : 2;
3420	/** Flags selector present(=1) or not. */
3421	uint32_t u1Present : 1;
3422	/** Segment limit 16-19. */
3423	uint32_t u4LimitHigh : 4;
3424	/** Available for system software. */
3425	uint32_t u1Available : 1;
3426	/** Reserved - 0. */
3427	uint32_t u1Reserved : 1;
3428	/** This flags meaning depends on the segment type. Try make sense out
3429	* of the intel manual yourself. */
3430	uint32_t u1DefBig : 1;
3431	/** Granularity of the limit. If set 4KB granularity is used, if
3432	* clear byte. */
3433	uint32_t u1Granularity : 1;
3434	/** Base address - bits 31-24. */
3435	uint32_t u8BaseHigh2 : 8;
3436	/** Base address - bits 63-32. */
3437	uint32_t u32BaseHigh3 : 32;
3438	uint32_t u8Reserved : 8;
3439	uint32_t u5Zeros : 5;
3440	uint32_t u19Reserved : 19;
3441	} X86DESC64SYSTEM;
3442	#pragma pack()
3443	/** Pointer to a system descriptor entry. */
3444	typedef X86DESC64SYSTEM *PX86DESC64SYSTEM;
3445	/** Pointer to a const system descriptor entry. */
3446	typedef const X86DESC64SYSTEM *PCX86DESC64SYSTEM;
3447
3448	/**
3449	* Call-, Interrupt-, Trap- or Task-gate descriptor (64-bit).
3450	*/
3451	typedef struct X86DESC64GATE
3452	{
3453	/** Target code segment offset - Low word. */
3454	uint32_t u16OffsetLow : 16;
3455	/** Target code segment selector. */
3456	uint32_t u16Sel : 16;
3457	/** Interrupt stack table for interrupt- and trap-gates.
3458	* Ignored by call-gates. */
3459	uint32_t u3IST : 3;
3460	/** Reserved / ignored. */
3461	uint32_t u5Reserved : 5;
3462	/** Segment Type. */
3463	uint32_t u4Type : 4;
3464	/** Descriptor Type (0 = system). */
3465	uint32_t u1DescType : 1;
3466	/** Descriptor Privilege level. */
3467	uint32_t u2Dpl : 2;
3468	/** Flags selector present(=1) or not. */
3469	uint32_t u1Present : 1;
3470	/** Target code segment offset - High word.
3471	* Ignored if task-gate. */
3472	uint32_t u16OffsetHigh : 16;
3473	/** Target code segment offset - Top dword.
3474	* Ignored if task-gate. */
3475	uint32_t u32OffsetTop : 32;
3476	/** Reserved / ignored / must be zero.
3477	* For call-gates bits 8 thru 12 must be zero, the other gates ignores this. */
3478	uint32_t u32Reserved : 32;
3479	} X86DESC64GATE;
3480	AssertCompileSize(X86DESC64GATE, 16);
3481	/** Pointer to a Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
3482	typedef X86DESC64GATE *PX86DESC64GATE;
3483	/** Pointer to a const Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
3484	typedef const X86DESC64GATE *PCX86DESC64GATE;
3485
3486	#endif /* VBOX_FOR_DTRACE_LIB */
3487
3488	/**
3489	* Descriptor table entry.
3490	*/
3491	#pragma pack(1)
3492	typedef union X86DESC64
3493	{
3494	#ifndef VBOX_FOR_DTRACE_LIB
3495	/** Generic descriptor view. */
3496	X86DESC64GENERIC Gen;
3497	/** System descriptor view. */
3498	X86DESC64SYSTEM System;
3499	/** Gate descriptor view. */
3500	X86DESC64GATE Gate;
3501	#endif
3502
3503	/** 8 bit unsigned integer view. */
3504	uint8_t au8[16];
3505	/** 16 bit unsigned integer view. */
3506	uint16_t au16[8];
3507	/** 32 bit unsigned integer view. */
3508	uint32_t au32[4];
3509	/** 64 bit unsigned integer view. */
3510	uint64_t au64[2];
3511	} X86DESC64;
3512	#ifndef VBOX_FOR_DTRACE_LIB
3513	AssertCompileSize(X86DESC64, 16);
3514	#endif
3515	#pragma pack()
3516	/** Pointer to descriptor table entry. */
3517	typedef X86DESC64 *PX86DESC64;
3518	/** Pointer to const descriptor table entry. */
3519	typedef const X86DESC64 *PCX86DESC64;
3520
3521	/** @def X86DESC64_BASE
3522	* Return the base of a 64-bit descriptor.
3523	*/
3524	#define X86DESC64_BASE(a_pDesc) /ASM-NOINC/ \
3525	( ((uint64_t)((a_pDesc)->Gen.u32BaseHigh3) << 32) \
3526	\| ((uint32_t)((a_pDesc)->Gen.u8BaseHigh2) << 24) \
3527	\| ( (a_pDesc)->Gen.u8BaseHigh1 << 16) \
3528	\| ( (a_pDesc)->Gen.u16BaseLow ) )
3529
3530
3531
3532	/** @name Host system descriptor table entry - Use with care!
3533	* @{ */
3534	/** Host system descriptor table entry. */
3535	#if HC_ARCH_BITS == 64
3536	typedef X86DESC64 X86DESCHC;
3537	#else
3538	typedef X86DESC X86DESCHC;
3539	#endif
3540	/** Pointer to a host system descriptor table entry. */
3541	#if HC_ARCH_BITS == 64
3542	typedef PX86DESC64 PX86DESCHC;
3543	#else
3544	typedef PX86DESC PX86DESCHC;
3545	#endif
3546	/** Pointer to a const host system descriptor table entry. */
3547	#if HC_ARCH_BITS == 64
3548	typedef PCX86DESC64 PCX86DESCHC;
3549	#else
3550	typedef PCX86DESC PCX86DESCHC;
3551	#endif
3552	/** @} */
3553
3554
3555	/** @name Selector Descriptor Types.
3556	* @{
3557	*/
3558
3559	/** @name Non-System Selector Types.
3560	* @{ */
3561	/** Code(=set)/Data(=clear) bit. */
3562	#define X86_SEL_TYPE_CODE 8
3563	/** Memory(=set)/System(=clear) bit. */
3564	#define X86_SEL_TYPE_MEMORY RT_BIT_32(4)
3565	/** Accessed bit. */
3566	#define X86_SEL_TYPE_ACCESSED 1
3567	/** Expand down bit (for data selectors only). */
3568	#define X86_SEL_TYPE_DOWN 4
3569	/** Conforming bit (for code selectors only). */
3570	#define X86_SEL_TYPE_CONF 4
3571	/** Write bit (for data selectors only). */
3572	#define X86_SEL_TYPE_WRITE 2
3573	/** Read bit (for code selectors only). */
3574	#define X86_SEL_TYPE_READ 2
3575	/** The bit number of the code segment read bit (relative to u4Type). */
3576	#define X86_SEL_TYPE_READ_BIT 1
3577
3578	/** Read only selector type. */
3579	#define X86_SEL_TYPE_RO 0
3580	/** Accessed read only selector type. */
3581	#define X86_SEL_TYPE_RO_ACC (0 \| X86_SEL_TYPE_ACCESSED)
3582	/** Read write selector type. */
3583	#define X86_SEL_TYPE_RW 2
3584	/** Accessed read write selector type. */
3585	#define X86_SEL_TYPE_RW_ACC (2 \| X86_SEL_TYPE_ACCESSED)
3586	/** Expand down read only selector type. */
3587	#define X86_SEL_TYPE_RO_DOWN 4
3588	/** Accessed expand down read only selector type. */
3589	#define X86_SEL_TYPE_RO_DOWN_ACC (4 \| X86_SEL_TYPE_ACCESSED)
3590	/** Expand down read write selector type. */
3591	#define X86_SEL_TYPE_RW_DOWN 6
3592	/** Accessed expand down read write selector type. */
3593	#define X86_SEL_TYPE_RW_DOWN_ACC (6 \| X86_SEL_TYPE_ACCESSED)
3594	/** Execute only selector type. */
3595	#define X86_SEL_TYPE_EO (0 \| X86_SEL_TYPE_CODE)
3596	/** Accessed execute only selector type. */
3597	#define X86_SEL_TYPE_EO_ACC (0 \| X86_SEL_TYPE_CODE \| X86_SEL_TYPE_ACCESSED)
3598	/** Execute and read selector type. */
3599	#define X86_SEL_TYPE_ER (2 \| X86_SEL_TYPE_CODE)
3600	/** Accessed execute and read selector type. */
3601	#define X86_SEL_TYPE_ER_ACC (2 \| X86_SEL_TYPE_CODE \| X86_SEL_TYPE_ACCESSED)
3602	/** Conforming execute only selector type. */
3603	#define X86_SEL_TYPE_EO_CONF (4 \| X86_SEL_TYPE_CODE)
3604	/** Accessed Conforming execute only selector type. */
3605	#define X86_SEL_TYPE_EO_CONF_ACC (4 \| X86_SEL_TYPE_CODE \| X86_SEL_TYPE_ACCESSED)
3606	/** Conforming execute and write selector type. */
3607	#define X86_SEL_TYPE_ER_CONF (6 \| X86_SEL_TYPE_CODE)
3608	/** Accessed Conforming execute and write selector type. */
3609	#define X86_SEL_TYPE_ER_CONF_ACC (6 \| X86_SEL_TYPE_CODE \| X86_SEL_TYPE_ACCESSED)
3610	/** @} */
3611
3612
3613	/** @name System Selector Types.
3614	* @{ */
3615	/** The TSS busy bit mask. */
3616	#define X86_SEL_TYPE_SYS_TSS_BUSY_MASK 2
3617
3618	/** Undefined system selector type. */
3619	#define X86_SEL_TYPE_SYS_UNDEFINED 0
3620	/** 286 TSS selector. */
3621	#define X86_SEL_TYPE_SYS_286_TSS_AVAIL 1
3622	/** LDT selector. */
3623	#define X86_SEL_TYPE_SYS_LDT 2
3624	/** 286 TSS selector - Busy. */
3625	#define X86_SEL_TYPE_SYS_286_TSS_BUSY 3
3626	/** 286 Callgate selector. */
3627	#define X86_SEL_TYPE_SYS_286_CALL_GATE 4
3628	/** Taskgate selector. */
3629	#define X86_SEL_TYPE_SYS_TASK_GATE 5
3630	/** 286 Interrupt gate selector. */
3631	#define X86_SEL_TYPE_SYS_286_INT_GATE 6
3632	/** 286 Trapgate selector. */
3633	#define X86_SEL_TYPE_SYS_286_TRAP_GATE 7
3634	/** Undefined system selector. */
3635	#define X86_SEL_TYPE_SYS_UNDEFINED2 8
3636	/** 386 TSS selector. */
3637	#define X86_SEL_TYPE_SYS_386_TSS_AVAIL 9
3638	/** Undefined system selector. */
3639	#define X86_SEL_TYPE_SYS_UNDEFINED3 0xA
3640	/** 386 TSS selector - Busy. */
3641	#define X86_SEL_TYPE_SYS_386_TSS_BUSY 0xB
3642	/** 386 Callgate selector. */
3643	#define X86_SEL_TYPE_SYS_386_CALL_GATE 0xC
3644	/** Undefined system selector. */
3645	#define X86_SEL_TYPE_SYS_UNDEFINED4 0xD
3646	/** 386 Interruptgate selector. */
3647	#define X86_SEL_TYPE_SYS_386_INT_GATE 0xE
3648	/** 386 Trapgate selector. */
3649	#define X86_SEL_TYPE_SYS_386_TRAP_GATE 0xF
3650	/** @} */
3651
3652	/** @name AMD64 System Selector Types.
3653	* @{ */
3654	/** LDT selector. */
3655	#define AMD64_SEL_TYPE_SYS_LDT 2
3656	/** TSS selector - Busy. */
3657	#define AMD64_SEL_TYPE_SYS_TSS_AVAIL 9
3658	/** TSS selector - Busy. */
3659	#define AMD64_SEL_TYPE_SYS_TSS_BUSY 0xB
3660	/** Callgate selector. */
3661	#define AMD64_SEL_TYPE_SYS_CALL_GATE 0xC
3662	/** Interruptgate selector. */
3663	#define AMD64_SEL_TYPE_SYS_INT_GATE 0xE
3664	/** Trapgate selector. */
3665	#define AMD64_SEL_TYPE_SYS_TRAP_GATE 0xF
3666	/** @} */
3667
3668	/** @} */
3669
3670
3671	/** @name Descriptor Table Entry Flag Masks.
3672	* These are for the 2nd 32-bit word of a descriptor.
3673	* @{ */
3674	/** Bits 8-11 - TYPE - Descriptor type mask. */
3675	#define X86_DESC_TYPE_MASK (RT_BIT_32(8) \| RT_BIT_32(9) \| RT_BIT_32(10) \| RT_BIT_32(11))
3676	/** Bit 12 - S - System (=0) or Code/Data (=1). */
3677	#define X86_DESC_S RT_BIT_32(12)
3678	/** Bits 13-14 - DPL - Descriptor Privilege Level. */
3679	#define X86_DESC_DPL (RT_BIT_32(13) \| RT_BIT_32(14))
3680	/** Bit 15 - P - Present. */
3681	#define X86_DESC_P RT_BIT_32(15)
3682	/** Bit 20 - AVL - Available for system software. */
3683	#define X86_DESC_AVL RT_BIT_32(20)
3684	/** Bit 22 - DB - Default operation size. 0 = 16 bit, 1 = 32 bit. */
3685	#define X86_DESC_DB RT_BIT_32(22)
3686	/** Bit 23 - G - Granularity of the limit. If set 4KB granularity is
3687	* used, if clear byte. */
3688	#define X86_DESC_G RT_BIT_32(23)
3689	/** @} */
3690
3691	/** @} */
3692
3693
3694	/** @name Task Segments.
3695	* @{
3696	*/
3697
3698	/**
3699	* The minimum TSS descriptor limit for 286 tasks.
3700	*/
3701	#define X86_SEL_TYPE_SYS_286_TSS_LIMIT_MIN 0x2b
3702
3703	/**
3704	* The minimum TSS descriptor segment limit for 386 tasks.
3705	*/
3706	#define X86_SEL_TYPE_SYS_386_TSS_LIMIT_MIN 0x67
3707
3708	/**
3709	* 16-bit Task Segment (TSS).
3710	*/
3711	#pragma pack(1)
3712	typedef struct X86TSS16
3713	{
3714	/** Back link to previous task. (static) */
3715	RTSEL selPrev;
3716	/** Ring-0 stack pointer. (static) */
3717	uint16_t sp0;
3718	/** Ring-0 stack segment. (static) */
3719	RTSEL ss0;
3720	/** Ring-1 stack pointer. (static) */
3721	uint16_t sp1;
3722	/** Ring-1 stack segment. (static) */
3723	RTSEL ss1;
3724	/** Ring-2 stack pointer. (static) */
3725	uint16_t sp2;
3726	/** Ring-2 stack segment. (static) */
3727	RTSEL ss2;
3728	/** IP before task switch. */
3729	uint16_t ip;
3730	/** FLAGS before task switch. */
3731	uint16_t flags;
3732	/** AX before task switch. */
3733	uint16_t ax;
3734	/** CX before task switch. */
3735	uint16_t cx;
3736	/** DX before task switch. */
3737	uint16_t dx;
3738	/** BX before task switch. */
3739	uint16_t bx;
3740	/** SP before task switch. */
3741	uint16_t sp;
3742	/** BP before task switch. */
3743	uint16_t bp;
3744	/** SI before task switch. */
3745	uint16_t si;
3746	/** DI before task switch. */
3747	uint16_t di;
3748	/** ES before task switch. */
3749	RTSEL es;
3750	/** CS before task switch. */
3751	RTSEL cs;
3752	/** SS before task switch. */
3753	RTSEL ss;
3754	/** DS before task switch. */
3755	RTSEL ds;
3756	/** LDTR before task switch. */
3757	RTSEL selLdt;
3758	} X86TSS16;
3759	#ifndef VBOX_FOR_DTRACE_LIB
3760	AssertCompileSize(X86TSS16, X86_SEL_TYPE_SYS_286_TSS_LIMIT_MIN + 1);
3761	#endif
3762	#pragma pack()
3763	/** Pointer to a 16-bit task segment. */
3764	typedef X86TSS16 *PX86TSS16;
3765	/** Pointer to a const 16-bit task segment. */
3766	typedef const X86TSS16 *PCX86TSS16;
3767
3768
3769	/**
3770	* 32-bit Task Segment (TSS).
3771	*/
3772	#pragma pack(1)
3773	typedef struct X86TSS32
3774	{
3775	/** Back link to previous task. (static) */
3776	RTSEL selPrev;
3777	uint16_t padding1;
3778	/** Ring-0 stack pointer. (static) */
3779	uint32_t esp0;
3780	/** Ring-0 stack segment. (static) */
3781	RTSEL ss0;
3782	uint16_t padding_ss0;
3783	/** Ring-1 stack pointer. (static) */
3784	uint32_t esp1;
3785	/** Ring-1 stack segment. (static) */
3786	RTSEL ss1;
3787	uint16_t padding_ss1;
3788	/** Ring-2 stack pointer. (static) */
3789	uint32_t esp2;
3790	/** Ring-2 stack segment. (static) */
3791	RTSEL ss2;
3792	uint16_t padding_ss2;
3793	/** Page directory for the task. (static) */
3794	uint32_t cr3;
3795	/** EIP before task switch. */
3796	uint32_t eip;
3797	/** EFLAGS before task switch. */
3798	uint32_t eflags;
3799	/** EAX before task switch. */
3800	uint32_t eax;
3801	/** ECX before task switch. */
3802	uint32_t ecx;
3803	/** EDX before task switch. */
3804	uint32_t edx;
3805	/** EBX before task switch. */
3806	uint32_t ebx;
3807	/** ESP before task switch. */
3808	uint32_t esp;
3809	/** EBP before task switch. */
3810	uint32_t ebp;
3811	/** ESI before task switch. */
3812	uint32_t esi;
3813	/** EDI before task switch. */
3814	uint32_t edi;
3815	/** ES before task switch. */
3816	RTSEL es;
3817	uint16_t padding_es;
3818	/** CS before task switch. */
3819	RTSEL cs;
3820	uint16_t padding_cs;
3821	/** SS before task switch. */
3822	RTSEL ss;
3823	uint16_t padding_ss;
3824	/** DS before task switch. */
3825	RTSEL ds;
3826	uint16_t padding_ds;
3827	/** FS before task switch. */
3828	RTSEL fs;
3829	uint16_t padding_fs;
3830	/** GS before task switch. */
3831	RTSEL gs;
3832	uint16_t padding_gs;
3833	/** LDTR before task switch. */
3834	RTSEL selLdt;
3835	uint16_t padding_ldt;
3836	/** Debug trap flag */
3837	uint16_t fDebugTrap;
3838	/** Offset relative to the TSS of the start of the I/O Bitmap
3839	* and the end of the interrupt redirection bitmap. */
3840	uint16_t offIoBitmap;
3841	} X86TSS32;
3842	#pragma pack()
3843	/** Pointer to task segment. */
3844	typedef X86TSS32 *PX86TSS32;
3845	/** Pointer to const task segment. */
3846	typedef const X86TSS32 *PCX86TSS32;
3847	#ifndef VBOX_FOR_DTRACE_LIB
3848	AssertCompileSize(X86TSS32, X86_SEL_TYPE_SYS_386_TSS_LIMIT_MIN + 1);
3849	AssertCompileMemberOffset(X86TSS32, cr3, 28);
3850	AssertCompileMemberOffset(X86TSS32, offIoBitmap, 102);
3851	#endif
3852
3853	/**
3854	* 64-bit Task segment.
3855	*/
3856	#pragma pack(1)
3857	typedef struct X86TSS64
3858	{
3859	/** Reserved. */
3860	uint32_t u32Reserved;
3861	/** Ring-0 stack pointer. (static) */
3862	uint64_t rsp0;
3863	/** Ring-1 stack pointer. (static) */
3864	uint64_t rsp1;
3865	/** Ring-2 stack pointer. (static) */
3866	uint64_t rsp2;
3867	/** Reserved. */
3868	uint32_t u32Reserved2[2];
3869	/* IST */
3870	uint64_t ist1;
3871	uint64_t ist2;
3872	uint64_t ist3;
3873	uint64_t ist4;
3874	uint64_t ist5;
3875	uint64_t ist6;
3876	uint64_t ist7;
3877	/* Reserved. */
3878	uint16_t u16Reserved[5];
3879	/** Offset relative to the TSS of the start of the I/O Bitmap
3880	* and the end of the interrupt redirection bitmap. */
3881	uint16_t offIoBitmap;
3882	} X86TSS64;
3883	#pragma pack()
3884	/** Pointer to a 64-bit task segment. */
3885	typedef X86TSS64 *PX86TSS64;
3886	/** Pointer to a const 64-bit task segment. */
3887	typedef const X86TSS64 *PCX86TSS64;
3888	#ifndef VBOX_FOR_DTRACE_LIB
3889	AssertCompileSize(X86TSS64, X86_SEL_TYPE_SYS_386_TSS_LIMIT_MIN + 1);
3890	#endif
3891
3892	/** @} */
3893
3894
3895	/** @name Selectors.
3896	* @{
3897	*/
3898
3899	/**
3900	* The shift used to convert a selector from and to index an index (C).
3901	*/
3902	#define X86_SEL_SHIFT 3
3903
3904	/**
3905	* The mask used to mask off the table indicator and RPL of an selector.
3906	*/
3907	#define X86_SEL_MASK 0xfff8U
3908
3909	/**
3910	* The mask used to mask off the RPL of an selector.
3911	* This is suitable for checking for NULL selectors.
3912	*/
3913	#define X86_SEL_MASK_OFF_RPL 0xfffcU
3914
3915	/**
3916	* The bit indicating that a selector is in the LDT and not in the GDT.
3917	*/
3918	#define X86_SEL_LDT 0x0004U
3919
3920	/**
3921	* The bit mask for getting the RPL of a selector.
3922	*/
3923	#define X86_SEL_RPL 0x0003U
3924
3925	/**
3926	* The mask covering both RPL and LDT.
3927	* This is incidentally the same as sizeof(X86DESC) - 1, so good for limit
3928	* checks.
3929	*/
3930	#define X86_SEL_RPL_LDT 0x0007U
3931
3932	/** @} */
3933
3934
3935	/**
3936	* x86 Exceptions/Faults/Traps.
3937	*/
3938	typedef enum X86XCPT
3939	{
3940	/** \#DE - Divide error. */
3941	X86_XCPT_DE = 0x00,
3942	/** \#DB - Debug event (single step, DRx, ..) */
3943	X86_XCPT_DB = 0x01,
3944	/** NMI - Non-Maskable Interrupt */
3945	X86_XCPT_NMI = 0x02,
3946	/** \#BP - Breakpoint (INT3). */
3947	X86_XCPT_BP = 0x03,
3948	/** \#OF - Overflow (INTO). */
3949	X86_XCPT_OF = 0x04,
3950	/** \#BR - Bound range exceeded (BOUND). */
3951	X86_XCPT_BR = 0x05,
3952	/** \#UD - Undefined opcode. */
3953	X86_XCPT_UD = 0x06,
3954	/** \#NM - Device not available (math coprocessor device). */
3955	X86_XCPT_NM = 0x07,
3956	/** \#DF - Double fault. */
3957	X86_XCPT_DF = 0x08,
3958	/** ??? - Coprocessor segment overrun (obsolete). */
3959	X86_XCPT_CO_SEG_OVERRUN = 0x09,
3960	/** \#TS - Taskswitch (TSS). */
3961	X86_XCPT_TS = 0x0a,
3962	/** \#NP - Segment no present. */
3963	X86_XCPT_NP = 0x0b,
3964	/** \#SS - Stack segment fault. */
3965	X86_XCPT_SS = 0x0c,
3966	/** \#GP - General protection fault. */
3967	X86_XCPT_GP = 0x0d,
3968	/** \#PF - Page fault. */
3969	X86_XCPT_PF = 0x0e,
3970	/* 0x0f is reserved (to avoid conflict with spurious interrupts in BIOS setup). */
3971	/** \#MF - Math fault (FPU). */
3972	X86_XCPT_MF = 0x10,
3973	/** \#AC - Alignment check. */
3974	X86_XCPT_AC = 0x11,
3975	/** \#MC - Machine check. */
3976	X86_XCPT_MC = 0x12,
3977	/** \#XF - SIMD Floating-Pointer Exception. */
3978	X86_XCPT_XF = 0x13,
3979	/** \#VE - Virtualization Exception. */
3980	X86_XCPT_VE = 0x14,
3981	/** \#SX - Security Exception. */
3982	X86_XCPT_SX = 0x1f
3983	} X86XCPT;
3984	/** Pointer to a x86 exception code. */
3985	typedef X86XCPT *PX86XCPT;
3986	/** Pointer to a const x86 exception code. */
3987	typedef const X86XCPT *PCX86XCPT;
3988	/** The maximum exception value. */
3989	#define X86_XCPT_MAX (X86_XCPT_SX)
3990
3991
3992	/** @name Trap Error Codes
3993	* @{
3994	*/
3995	/** External indicator. */
3996	#define X86_TRAP_ERR_EXTERNAL 1
3997	/** IDT indicator. */
3998	#define X86_TRAP_ERR_IDT 2
3999	/** Descriptor table indicator - If set LDT, if clear GDT. */
4000	#define X86_TRAP_ERR_TI 4
4001	/** Mask for getting the selector. */
4002	#define X86_TRAP_ERR_SEL_MASK 0xfff8
4003	/** Shift for getting the selector table index (C type index). */
4004	#define X86_TRAP_ERR_SEL_SHIFT 3
4005	/** @} */
4006
4007
4008	/** @name \#PF Trap Error Codes
4009	* @{
4010	*/
4011	/** Bit 0 - P - Not present (clear) or page level protection (set) fault. */
4012	#define X86_TRAP_PF_P RT_BIT_32(0)
4013	/** Bit 1 - R/W - Read (clear) or write (set) access. */
4014	#define X86_TRAP_PF_RW RT_BIT_32(1)
4015	/** Bit 2 - U/S - CPU executing in user mode (set) or supervisor mode (clear). */
4016	#define X86_TRAP_PF_US RT_BIT_32(2)
4017	/** Bit 3 - RSVD- Reserved bit violation (set), i.e. reserved bit was set to 1. */
4018	#define X86_TRAP_PF_RSVD RT_BIT_32(3)
4019	/** Bit 4 - I/D - Instruction fetch (set) / Data access (clear) - PAE + NXE. */
4020	#define X86_TRAP_PF_ID RT_BIT_32(4)
4021	/** Bit 5 - PK - Protection-key violation (AMD64 mode only). */
4022	#define X86_TRAP_PF_PK RT_BIT_32(5)
4023	/** @} */
4024
4025	#pragma pack(1)
4026	/**
4027	* 16-bit IDTR.
4028	*/
4029	typedef struct X86IDTR16
4030	{
4031	/** Offset. */
4032	uint16_t offSel;
4033	/** Selector. */
4034	uint16_t uSel;
4035	} X86IDTR16, *PX86IDTR16;
4036	#pragma pack()
4037
4038	#pragma pack(1)
4039	/**
4040	* 32-bit IDTR/GDTR.
4041	*/
4042	typedef struct X86XDTR32
4043	{
4044	/** Size of the descriptor table. */
4045	uint16_t cb;
4046	/** Address of the descriptor table. */
4047	#ifndef VBOX_FOR_DTRACE_LIB
4048	uint32_t uAddr;
4049	#else
4050	uint16_t au16Addr[2];
4051	#endif
4052	} X86XDTR32, *PX86XDTR32;
4053	#pragma pack()
4054
4055	#pragma pack(1)
4056	/**
4057	* 64-bit IDTR/GDTR.
4058	*/
4059	typedef struct X86XDTR64
4060	{
4061	/** Size of the descriptor table. */
4062	uint16_t cb;
4063	/** Address of the descriptor table. */
4064	#ifndef VBOX_FOR_DTRACE_LIB
4065	uint64_t uAddr;
4066	#else
4067	uint16_t au16Addr[4];
4068	#endif
4069	} X86XDTR64, *PX86XDTR64;
4070	#pragma pack()
4071
4072
4073	/** @name ModR/M
4074	* @{ */
4075	#define X86_MODRM_RM_MASK UINT8_C(0x07)
4076	#define X86_MODRM_REG_MASK UINT8_C(0x38)
4077	#define X86_MODRM_REG_SMASK UINT8_C(0x07)
4078	#define X86_MODRM_REG_SHIFT 3
4079	#define X86_MODRM_MOD_MASK UINT8_C(0xc0)
4080	#define X86_MODRM_MOD_SMASK UINT8_C(0x03)
4081	#define X86_MODRM_MOD_SHIFT 6
4082	#ifndef VBOX_FOR_DTRACE_LIB
4083	AssertCompile((X86_MODRM_RM_MASK \| X86_MODRM_REG_MASK \| X86_MODRM_MOD_MASK) == 0xff);
4084	AssertCompile((X86_MODRM_REG_MASK >> X86_MODRM_REG_SHIFT) == X86_MODRM_REG_SMASK);
4085	AssertCompile((X86_MODRM_MOD_MASK >> X86_MODRM_MOD_SHIFT) == X86_MODRM_MOD_SMASK);
4086	#endif
4087	/** @} */
4088
4089	/** @name SIB
4090	* @{ */
4091	#define X86_SIB_BASE_MASK UINT8_C(0x07)
4092	#define X86_SIB_INDEX_MASK UINT8_C(0x38)
4093	#define X86_SIB_INDEX_SMASK UINT8_C(0x07)
4094	#define X86_SIB_INDEX_SHIFT 3
4095	#define X86_SIB_SCALE_MASK UINT8_C(0xc0)
4096	#define X86_SIB_SCALE_SMASK UINT8_C(0x03)
4097	#define X86_SIB_SCALE_SHIFT 6
4098	#ifndef VBOX_FOR_DTRACE_LIB
4099	AssertCompile((X86_SIB_BASE_MASK \| X86_SIB_INDEX_MASK \| X86_SIB_SCALE_MASK) == 0xff);
4100	AssertCompile((X86_SIB_INDEX_MASK >> X86_SIB_INDEX_SHIFT) == X86_SIB_INDEX_SMASK);
4101	AssertCompile((X86_SIB_SCALE_MASK >> X86_SIB_SCALE_SHIFT) == X86_SIB_SCALE_SMASK);
4102	#endif
4103	/** @} */
4104
4105	/** @name General register indexes
4106	* @{ */
4107	#define X86_GREG_xAX 0
4108	#define X86_GREG_xCX 1
4109	#define X86_GREG_xDX 2
4110	#define X86_GREG_xBX 3
4111	#define X86_GREG_xSP 4
4112	#define X86_GREG_xBP 5
4113	#define X86_GREG_xSI 6
4114	#define X86_GREG_xDI 7
4115	#define X86_GREG_x8 8
4116	#define X86_GREG_x9 9
4117	#define X86_GREG_x10 10
4118	#define X86_GREG_x11 11
4119	#define X86_GREG_x12 12
4120	#define X86_GREG_x13 13
4121	#define X86_GREG_x14 14
4122	#define X86_GREG_x15 15
4123	/** @} */
4124
4125	/** @name X86_SREG_XXX - Segment register indexes.
4126	* @{ */
4127	#define X86_SREG_ES 0
4128	#define X86_SREG_CS 1
4129	#define X86_SREG_SS 2
4130	#define X86_SREG_DS 3
4131	#define X86_SREG_FS 4
4132	#define X86_SREG_GS 5
4133	/** @} */
4134	/** Segment register count. */
4135	#define X86_SREG_COUNT 6
4136
4137
4138	/** @name X86_OP_XXX - Prefixes
4139	* @{ */
4140	#define X86_OP_PRF_CS UINT8_C(0x2e)
4141	#define X86_OP_PRF_SS UINT8_C(0x36)
4142	#define X86_OP_PRF_DS UINT8_C(0x3e)
4143	#define X86_OP_PRF_ES UINT8_C(0x26)
4144	#define X86_OP_PRF_FS UINT8_C(0x64)
4145	#define X86_OP_PRF_GS UINT8_C(0x65)
4146	#define X86_OP_PRF_SIZE_OP UINT8_C(0x66)
4147	#define X86_OP_PRF_SIZE_ADDR UINT8_C(0x67)
4148	#define X86_OP_PRF_LOCK UINT8_C(0xf0)
4149	#define X86_OP_PRF_REPZ UINT8_C(0xf2)
4150	#define X86_OP_PRF_REPNZ UINT8_C(0xf3)
4151	#define X86_OP_REX_B UINT8_C(0x41)
4152	#define X86_OP_REX_X UINT8_C(0x42)
4153	#define X86_OP_REX_R UINT8_C(0x44)
4154	#define X86_OP_REX_W UINT8_C(0x48)
4155	/** @} */
4156
4157
4158	/** @} */
4159
4160	#endif
4161

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

source: vbox/trunk/include/iprt/x86.h@ 64770

Download in other formats: