VirtualBox

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

Last change on this file since 61693 was 61249, checked in by vboxsync, 9 years ago

iprt/x86.h: Rename MSR to be more inline with inconsistent Intel docs.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 152.0 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-2015 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 */
53typedef 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. */
101typedef X86EFLAGSBITS *PX86EFLAGSBITS;
102/** Pointer to const EFLAGS bits. */
103typedef const X86EFLAGSBITS *PCX86EFLAGSBITS;
104#endif /* !VBOX_FOR_DTRACE_LIB */
105
106/**
107 * EFLAGS.
108 */
109typedef 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. */
127typedef X86EFLAGS *PX86EFLAGS;
128/** Pointer to const EFLAGS. */
129typedef const X86EFLAGS *PCX86EFLAGS;
130
131/**
132 * RFLAGS (32 upper bits are reserved).
133 */
134typedef 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. */
154typedef X86RFLAGS *PX86RFLAGS;
155/** Pointer to const RFLAGS. */
156typedef 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
226typedef 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 */
294typedef uint32_t X86CPUIDFEATECX;
295#endif /* VBOX_FOR_DTRACE_LIB */
296/** Pointer to CPUID Feature Information - ECX. */
297typedef X86CPUIDFEATECX *PX86CPUIDFEATECX;
298/** Pointer to const CPUID Feature Information - ECX. */
299typedef 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 */
306typedef 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 */
374typedef uint32_t X86CPUIDFEATEDX;
375#endif /* VBOX_FOR_DTRACE_LIB */
376/** Pointer to CPUID Feature Information - EDX. */
377typedef X86CPUIDFEATEDX *PX86CPUIDFEATEDX;
378/** Pointer to const CPUID Feature Information - EDX. */
379typedef 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 - OSXSAVE instruction. */
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) ) )
990AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x33330000)) == 0);
991AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x22220000)) == 1);
992AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x32320000)) == 1);
993AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x23230000)) == 1);
994AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x00000000)) == 0);
995AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x00010000)) == 0);
996AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x00020000)) == 1);
997AssertCompile(X86_DR7_ANY_RW_IO(UINT32_C(0x00030000)) == 0);
998AssertCompile(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/** DS Save Area (R/W). */
1273#define MSR_IA32_DS_AREA 0x600
1274/** Running Average Power Limit (RAPL) power units. */
1275#define MSR_RAPL_POWER_UNIT 0x606
1276
1277/** X2APIC MSR range start. */
1278#define MSR_IA32_X2APIC_START 0x800
1279/** X2APIC MSR - APIC ID Register. */
1280#define MSR_IA32_X2APIC_ID 0x802
1281/** X2APIC MSR - APIC Version Register. */
1282#define MSR_IA32_X2APIC_VERSION 0x803
1283/** X2APIC MSR - Task Priority Register. */
1284#define MSR_IA32_X2APIC_TPR 0x808
1285/** X2APIC MSR - Processor Priority register. */
1286#define MSR_IA32_X2APIC_PPR 0x80A
1287/** X2APIC MSR - End Of Interrupt register. */
1288#define MSR_IA32_X2APIC_EOI 0x80B
1289/** X2APIC MSR - Logical Destination Register. */
1290#define MSR_IA32_X2APIC_LDR 0x80D
1291/** X2APIC MSR - Spurious Interrupt Vector Register. */
1292#define MSR_IA32_X2APIC_SVR 0x80F
1293/** X2APIC MSR - In-service Register (bits 31:0). */
1294#define MSR_IA32_X2APIC_ISR0 0x810
1295/** X2APIC MSR - In-service Register (bits 63:32). */
1296#define MSR_IA32_X2APIC_ISR1 0x811
1297/** X2APIC MSR - In-service Register (bits 95:64). */
1298#define MSR_IA32_X2APIC_ISR2 0x812
1299/** X2APIC MSR - In-service Register (bits 127:96). */
1300#define MSR_IA32_X2APIC_ISR3 0x813
1301/** X2APIC MSR - In-service Register (bits 159:128). */
1302#define MSR_IA32_X2APIC_ISR4 0x814
1303/** X2APIC MSR - In-service Register (bits 191:160). */
1304#define MSR_IA32_X2APIC_ISR5 0x815
1305/** X2APIC MSR - In-service Register (bits 223:192). */
1306#define MSR_IA32_X2APIC_ISR6 0x816
1307/** X2APIC MSR - In-service Register (bits 255:224). */
1308#define MSR_IA32_X2APIC_ISR7 0x817
1309/** X2APIC MSR - Trigger Mode Register (bits 31:0). */
1310#define MSR_IA32_X2APIC_TMR0 0x818
1311/** X2APIC MSR - Trigger Mode Register (bits 63:32). */
1312#define MSR_IA32_X2APIC_TMR1 0x819
1313/** X2APIC MSR - Trigger Mode Register (bits 95:64). */
1314#define MSR_IA32_X2APIC_TMR2 0x81A
1315/** X2APIC MSR - Trigger Mode Register (bits 127:96). */
1316#define MSR_IA32_X2APIC_TMR3 0x81B
1317/** X2APIC MSR - Trigger Mode Register (bits 159:128). */
1318#define MSR_IA32_X2APIC_TMR4 0x81C
1319/** X2APIC MSR - Trigger Mode Register (bits 191:160). */
1320#define MSR_IA32_X2APIC_TMR5 0x81D
1321/** X2APIC MSR - Trigger Mode Register (bits 223:192). */
1322#define MSR_IA32_X2APIC_TMR6 0x81E
1323/** X2APIC MSR - Trigger Mode Register (bits 255:224). */
1324#define MSR_IA32_X2APIC_TMR7 0x81F
1325/** X2APIC MSR - Interrupt Request Register (bits 31:0). */
1326#define MSR_IA32_X2APIC_IRR0 0x820
1327/** X2APIC MSR - Interrupt Request Register (bits 63:32). */
1328#define MSR_IA32_X2APIC_IRR1 0x821
1329/** X2APIC MSR - Interrupt Request Register (bits 95:64). */
1330#define MSR_IA32_X2APIC_IRR2 0x822
1331/** X2APIC MSR - Interrupt Request Register (bits 127:96). */
1332#define MSR_IA32_X2APIC_IRR3 0x823
1333/** X2APIC MSR - Interrupt Request Register (bits 159:128). */
1334#define MSR_IA32_X2APIC_IRR4 0x824
1335/** X2APIC MSR - Interrupt Request Register (bits 191:160). */
1336#define MSR_IA32_X2APIC_IRR5 0x825
1337/** X2APIC MSR - Interrupt Request Register (bits 223:192). */
1338#define MSR_IA32_X2APIC_IRR6 0x826
1339/** X2APIC MSR - Interrupt Request Register (bits 255:224). */
1340#define MSR_IA32_X2APIC_IRR7 0x827
1341/** X2APIC MSR - Error Status Register. */
1342#define MSR_IA32_X2APIC_ESR 0x828
1343/** X2APIC MSR - LVT CMCI Register. */
1344#define MSR_IA32_X2APIC_LVT_CMCI 0x82F
1345/** X2APIC MSR - Interrupt Command Register. */
1346#define MSR_IA32_X2APIC_ICR 0x830
1347/** X2APIC MSR - LVT Timer Register. */
1348#define MSR_IA32_X2APIC_LVT_TIMER 0x832
1349/** X2APIC MSR - LVT Thermal Sensor Register. */
1350#define MSR_IA32_X2APIC_LVT_THERMAL 0x833
1351/** X2APIC MSR - LVT Performance Counter Register. */
1352#define MSR_IA32_X2APIC_LVT_PERF 0x834
1353/** X2APIC MSR - LVT LINT0 Register. */
1354#define MSR_IA32_X2APIC_LVT_LINT0 0x835
1355/** X2APIC MSR - LVT LINT1 Register. */
1356#define MSR_IA32_X2APIC_LVT_LINT1 0x836
1357/** X2APIC MSR - LVT Error Register . */
1358#define MSR_IA32_X2APIC_LVT_ERROR 0x837
1359/** X2APIC MSR - Timer Initial Count Register. */
1360#define MSR_IA32_X2APIC_TIMER_ICR 0x838
1361/** X2APIC MSR - Timer Current Count Register. */
1362#define MSR_IA32_X2APIC_TIMER_CCR 0x839
1363/** X2APIC MSR - Timer Divide Configuration Register. */
1364#define MSR_IA32_X2APIC_TIMER_DCR 0x83E
1365/** X2APIC MSR - Self IPI. */
1366#define MSR_IA32_X2APIC_SELF_IPI 0x83F
1367/** X2APIC MSR range end. */
1368#define MSR_IA32_X2APIC_END 0xBFF
1369/** X2APIC MSR - LVT start range. */
1370#define MSR_IA32_X2APIC_LVT_START MSR_IA32_X2APIC_LVT_TIMER
1371/** X2APIC MSR - LVT end range (inclusive). */
1372#define MSR_IA32_X2APIC_LVT_END MSR_IA32_X2APIC_LVT_ERROR
1373
1374/** K6 EFER - Extended Feature Enable Register. */
1375#define MSR_K6_EFER UINT32_C(0xc0000080)
1376/** @todo document EFER */
1377/** Bit 0 - SCE - System call extensions (SYSCALL / SYSRET). (R/W) */
1378#define MSR_K6_EFER_SCE RT_BIT_32(0)
1379/** Bit 8 - LME - Long mode enabled. (R/W) */
1380#define MSR_K6_EFER_LME RT_BIT_32(8)
1381/** Bit 10 - LMA - Long mode active. (R) */
1382#define MSR_K6_EFER_LMA RT_BIT_32(10)
1383/** Bit 11 - NXE - No-Execute Page Protection Enabled. (R/W) */
1384#define MSR_K6_EFER_NXE RT_BIT_32(11)
1385/** Bit 12 - SVME - Secure VM Extension Enabled. (R/W) */
1386#define MSR_K6_EFER_SVME RT_BIT_32(12)
1387/** Bit 13 - LMSLE - Long Mode Segment Limit Enable. (R/W?) */
1388#define MSR_K6_EFER_LMSLE RT_BIT_32(13)
1389/** Bit 14 - FFXSR - Fast FXSAVE / FXRSTOR (skip XMM*). (R/W) */
1390#define MSR_K6_EFER_FFXSR RT_BIT_32(14)
1391/** Bit 15 - TCE - Translation Cache Extension. (R/W) */
1392#define MSR_K6_EFER_TCE RT_BIT_32(15)
1393/** K6 STAR - SYSCALL/RET targets. */
1394#define MSR_K6_STAR UINT32_C(0xc0000081)
1395/** Shift value for getting the SYSRET CS and SS value. */
1396#define MSR_K6_STAR_SYSRET_CS_SS_SHIFT 48
1397/** Shift value for getting the SYSCALL CS and SS value. */
1398#define MSR_K6_STAR_SYSCALL_CS_SS_SHIFT 32
1399/** Selector mask for use after shifting. */
1400#define MSR_K6_STAR_SEL_MASK UINT32_C(0xffff)
1401/** The mask which give the SYSCALL EIP. */
1402#define MSR_K6_STAR_SYSCALL_EIP_MASK UINT32_C(0xffffffff)
1403/** K6 WHCR - Write Handling Control Register. */
1404#define MSR_K6_WHCR UINT32_C(0xc0000082)
1405/** K6 UWCCR - UC/WC Cacheability Control Register. */
1406#define MSR_K6_UWCCR UINT32_C(0xc0000085)
1407/** K6 PSOR - Processor State Observability Register. */
1408#define MSR_K6_PSOR UINT32_C(0xc0000087)
1409/** K6 PFIR - Page Flush/Invalidate Register. */
1410#define MSR_K6_PFIR UINT32_C(0xc0000088)
1411
1412/** Performance counter MSRs. (AMD only) */
1413#define MSR_K7_EVNTSEL0 UINT32_C(0xc0010000)
1414#define MSR_K7_EVNTSEL1 UINT32_C(0xc0010001)
1415#define MSR_K7_EVNTSEL2 UINT32_C(0xc0010002)
1416#define MSR_K7_EVNTSEL3 UINT32_C(0xc0010003)
1417#define MSR_K7_PERFCTR0 UINT32_C(0xc0010004)
1418#define MSR_K7_PERFCTR1 UINT32_C(0xc0010005)
1419#define MSR_K7_PERFCTR2 UINT32_C(0xc0010006)
1420#define MSR_K7_PERFCTR3 UINT32_C(0xc0010007)
1421
1422/** K8 LSTAR - Long mode SYSCALL target (RIP). */
1423#define MSR_K8_LSTAR UINT32_C(0xc0000082)
1424/** K8 CSTAR - Compatibility mode SYSCALL target (RIP). */
1425#define MSR_K8_CSTAR UINT32_C(0xc0000083)
1426/** K8 SF_MASK - SYSCALL flag mask. (aka SFMASK) */
1427#define MSR_K8_SF_MASK UINT32_C(0xc0000084)
1428/** K8 FS.base - The 64-bit base FS register. */
1429#define MSR_K8_FS_BASE UINT32_C(0xc0000100)
1430/** K8 GS.base - The 64-bit base GS register. */
1431#define MSR_K8_GS_BASE UINT32_C(0xc0000101)
1432/** K8 KernelGSbase - Used with SWAPGS. */
1433#define MSR_K8_KERNEL_GS_BASE UINT32_C(0xc0000102)
1434/** K8 TSC_AUX - Used with RDTSCP. */
1435#define MSR_K8_TSC_AUX UINT32_C(0xc0000103)
1436#define MSR_K8_SYSCFG UINT32_C(0xc0010010)
1437#define MSR_K8_HWCR UINT32_C(0xc0010015)
1438#define MSR_K8_IORRBASE0 UINT32_C(0xc0010016)
1439#define MSR_K8_IORRMASK0 UINT32_C(0xc0010017)
1440#define MSR_K8_IORRBASE1 UINT32_C(0xc0010018)
1441#define MSR_K8_IORRMASK1 UINT32_C(0xc0010019)
1442#define MSR_K8_TOP_MEM1 UINT32_C(0xc001001a)
1443#define MSR_K8_TOP_MEM2 UINT32_C(0xc001001d)
1444/** North bridge config? See BIOS & Kernel dev guides for
1445 * details. */
1446#define MSR_K8_NB_CFG UINT32_C(0xc001001f)
1447
1448/** Hypertransport interrupt pending register.
1449 * "BIOS and Kernel Developer's Guide for AMD NPT Family 0Fh Processors" */
1450#define MSR_K8_INT_PENDING UINT32_C(0xc0010055)
1451#define MSR_K8_VM_CR UINT32_C(0xc0010114)
1452#define MSR_K8_VM_CR_SVM_DISABLE RT_BIT_32(4)
1453
1454#define MSR_K8_IGNNE UINT32_C(0xc0010115)
1455#define MSR_K8_SMM_CTL UINT32_C(0xc0010116)
1456/** SVM - VM_HSAVE_PA - Physical address for saving and restoring
1457 * host state during world switch. */
1458#define MSR_K8_VM_HSAVE_PA UINT32_C(0xc0010117)
1459
1460/** @} */
1461
1462
1463/** @name Page Table / Directory / Directory Pointers / L4.
1464 * @{
1465 */
1466
1467/** Page table/directory entry as an unsigned integer. */
1468typedef uint32_t X86PGUINT;
1469/** Pointer to a page table/directory table entry as an unsigned integer. */
1470typedef X86PGUINT *PX86PGUINT;
1471/** Pointer to an const page table/directory table entry as an unsigned integer. */
1472typedef X86PGUINT const *PCX86PGUINT;
1473
1474/** Number of entries in a 32-bit PT/PD. */
1475#define X86_PG_ENTRIES 1024
1476
1477
1478/** PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1479typedef uint64_t X86PGPAEUINT;
1480/** Pointer to a PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1481typedef X86PGPAEUINT *PX86PGPAEUINT;
1482/** Pointer to an const PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1483typedef X86PGPAEUINT const *PCX86PGPAEUINT;
1484
1485/** Number of entries in a PAE PT/PD. */
1486#define X86_PG_PAE_ENTRIES 512
1487/** Number of entries in a PAE PDPT. */
1488#define X86_PG_PAE_PDPE_ENTRIES 4
1489
1490/** Number of entries in an AMD64 PT/PD/PDPT/L4/L5. */
1491#define X86_PG_AMD64_ENTRIES X86_PG_PAE_ENTRIES
1492/** Number of entries in an AMD64 PDPT.
1493 * Just for complementing X86_PG_PAE_PDPE_ENTRIES, using X86_PG_AMD64_ENTRIES for this is fine too. */
1494#define X86_PG_AMD64_PDPE_ENTRIES X86_PG_AMD64_ENTRIES
1495
1496/** The size of a default page. */
1497#define X86_PAGE_SIZE X86_PAGE_4K_SIZE
1498/** The page shift of a default page. */
1499#define X86_PAGE_SHIFT X86_PAGE_4K_SHIFT
1500/** The default page offset mask. */
1501#define X86_PAGE_OFFSET_MASK X86_PAGE_4K_OFFSET_MASK
1502/** The default page base mask for virtual addresses. */
1503#define X86_PAGE_BASE_MASK X86_PAGE_4K_BASE_MASK
1504/** The default page base mask for virtual addresses - 32bit version. */
1505#define X86_PAGE_BASE_MASK_32 X86_PAGE_4K_BASE_MASK_32
1506
1507/** The size of a 4KB page. */
1508#define X86_PAGE_4K_SIZE _4K
1509/** The page shift of a 4KB page. */
1510#define X86_PAGE_4K_SHIFT 12
1511/** The 4KB page offset mask. */
1512#define X86_PAGE_4K_OFFSET_MASK 0xfff
1513/** The 4KB page base mask for virtual addresses. */
1514#define X86_PAGE_4K_BASE_MASK 0xfffffffffffff000ULL
1515/** The 4KB page base mask for virtual addresses - 32bit version. */
1516#define X86_PAGE_4K_BASE_MASK_32 0xfffff000U
1517
1518/** The size of a 2MB page. */
1519#define X86_PAGE_2M_SIZE _2M
1520/** The page shift of a 2MB page. */
1521#define X86_PAGE_2M_SHIFT 21
1522/** The 2MB page offset mask. */
1523#define X86_PAGE_2M_OFFSET_MASK 0x001fffff
1524/** The 2MB page base mask for virtual addresses. */
1525#define X86_PAGE_2M_BASE_MASK 0xffffffffffe00000ULL
1526/** The 2MB page base mask for virtual addresses - 32bit version. */
1527#define X86_PAGE_2M_BASE_MASK_32 0xffe00000U
1528
1529/** The size of a 4MB page. */
1530#define X86_PAGE_4M_SIZE _4M
1531/** The page shift of a 4MB page. */
1532#define X86_PAGE_4M_SHIFT 22
1533/** The 4MB page offset mask. */
1534#define X86_PAGE_4M_OFFSET_MASK 0x003fffff
1535/** The 4MB page base mask for virtual addresses. */
1536#define X86_PAGE_4M_BASE_MASK 0xffffffffffc00000ULL
1537/** The 4MB page base mask for virtual addresses - 32bit version. */
1538#define X86_PAGE_4M_BASE_MASK_32 0xffc00000U
1539
1540/**
1541 * Check if the given address is canonical.
1542 */
1543#define X86_IS_CANONICAL(a_u64Addr) ((uint64_t)(a_u64Addr) + UINT64_C(0x800000000000) < UINT64_C(0x1000000000000))
1544
1545
1546/** @name Page Table Entry
1547 * @{
1548 */
1549/** Bit 0 - P - Present bit. */
1550#define X86_PTE_BIT_P 0
1551/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1552#define X86_PTE_BIT_RW 1
1553/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1554#define X86_PTE_BIT_US 2
1555/** Bit 3 - PWT - Page level write thru bit. */
1556#define X86_PTE_BIT_PWT 3
1557/** Bit 4 - PCD - Page level cache disable bit. */
1558#define X86_PTE_BIT_PCD 4
1559/** Bit 5 - A - Access bit. */
1560#define X86_PTE_BIT_A 5
1561/** Bit 6 - D - Dirty bit. */
1562#define X86_PTE_BIT_D 6
1563/** Bit 7 - PAT - Page Attribute Table index bit. Reserved and 0 if not supported. */
1564#define X86_PTE_BIT_PAT 7
1565/** Bit 8 - G - Global flag. */
1566#define X86_PTE_BIT_G 8
1567
1568/** Bit 0 - P - Present bit mask. */
1569#define X86_PTE_P RT_BIT_32(0)
1570/** Bit 1 - R/W - Read (clear) / Write (set) bit mask. */
1571#define X86_PTE_RW RT_BIT_32(1)
1572/** Bit 2 - U/S - User (set) / Supervisor (clear) bit mask. */
1573#define X86_PTE_US RT_BIT_32(2)
1574/** Bit 3 - PWT - Page level write thru bit mask. */
1575#define X86_PTE_PWT RT_BIT_32(3)
1576/** Bit 4 - PCD - Page level cache disable bit mask. */
1577#define X86_PTE_PCD RT_BIT_32(4)
1578/** Bit 5 - A - Access bit mask. */
1579#define X86_PTE_A RT_BIT_32(5)
1580/** Bit 6 - D - Dirty bit mask. */
1581#define X86_PTE_D RT_BIT_32(6)
1582/** Bit 7 - PAT - Page Attribute Table index bit mask. Reserved and 0 if not supported. */
1583#define X86_PTE_PAT RT_BIT_32(7)
1584/** Bit 8 - G - Global bit mask. */
1585#define X86_PTE_G RT_BIT_32(8)
1586
1587/** Bits 9-11 - - Available for use to system software. */
1588#define X86_PTE_AVL_MASK (RT_BIT_32(9) | RT_BIT_32(10) | RT_BIT_32(11))
1589/** Bits 12-31 - - Physical Page number of the next level. */
1590#define X86_PTE_PG_MASK ( 0xfffff000 )
1591
1592/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1593#define X86_PTE_PAE_PG_MASK UINT64_C(0x000ffffffffff000)
1594/** Bits 63 - NX - PAE/LM - No execution flag. */
1595#define X86_PTE_PAE_NX RT_BIT_64(63)
1596/** Bits 62-52 - - PAE - MBZ bits when NX is active. */
1597#define X86_PTE_PAE_MBZ_MASK_NX UINT64_C(0x7ff0000000000000)
1598/** Bits 63-52 - - PAE - MBZ bits when no NX. */
1599#define X86_PTE_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff0000000000000)
1600/** No bits - - LM - MBZ bits when NX is active. */
1601#define X86_PTE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000000)
1602/** Bits 63 - - LM - MBZ bits when no NX. */
1603#define X86_PTE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000000)
1604
1605/**
1606 * Page table entry.
1607 */
1608typedef struct X86PTEBITS
1609{
1610 /** Flags whether(=1) or not the page is present. */
1611 uint32_t u1Present : 1;
1612 /** Read(=0) / Write(=1) flag. */
1613 uint32_t u1Write : 1;
1614 /** User(=1) / Supervisor (=0) flag. */
1615 uint32_t u1User : 1;
1616 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1617 uint32_t u1WriteThru : 1;
1618 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1619 uint32_t u1CacheDisable : 1;
1620 /** Accessed flag.
1621 * Indicates that the page have been read or written to. */
1622 uint32_t u1Accessed : 1;
1623 /** Dirty flag.
1624 * Indicates that the page has been written to. */
1625 uint32_t u1Dirty : 1;
1626 /** Reserved / If PAT enabled, bit 2 of the index. */
1627 uint32_t u1PAT : 1;
1628 /** Global flag. (Ignored in all but final level.) */
1629 uint32_t u1Global : 1;
1630 /** Available for use to system software. */
1631 uint32_t u3Available : 3;
1632 /** Physical Page number of the next level. */
1633 uint32_t u20PageNo : 20;
1634} X86PTEBITS;
1635#ifndef VBOX_FOR_DTRACE_LIB
1636AssertCompileSize(X86PTEBITS, 4);
1637#endif
1638/** Pointer to a page table entry. */
1639typedef X86PTEBITS *PX86PTEBITS;
1640/** Pointer to a const page table entry. */
1641typedef const X86PTEBITS *PCX86PTEBITS;
1642
1643/**
1644 * Page table entry.
1645 */
1646typedef union X86PTE
1647{
1648 /** Unsigned integer view */
1649 X86PGUINT u;
1650 /** Bit field view. */
1651 X86PTEBITS n;
1652 /** 32-bit view. */
1653 uint32_t au32[1];
1654 /** 16-bit view. */
1655 uint16_t au16[2];
1656 /** 8-bit view. */
1657 uint8_t au8[4];
1658} X86PTE;
1659#ifndef VBOX_FOR_DTRACE_LIB
1660AssertCompileSize(X86PTE, 4);
1661#endif
1662/** Pointer to a page table entry. */
1663typedef X86PTE *PX86PTE;
1664/** Pointer to a const page table entry. */
1665typedef const X86PTE *PCX86PTE;
1666
1667
1668/**
1669 * PAE page table entry.
1670 */
1671typedef struct X86PTEPAEBITS
1672{
1673 /** Flags whether(=1) or not the page is present. */
1674 uint32_t u1Present : 1;
1675 /** Read(=0) / Write(=1) flag. */
1676 uint32_t u1Write : 1;
1677 /** User(=1) / Supervisor(=0) flag. */
1678 uint32_t u1User : 1;
1679 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1680 uint32_t u1WriteThru : 1;
1681 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1682 uint32_t u1CacheDisable : 1;
1683 /** Accessed flag.
1684 * Indicates that the page have been read or written to. */
1685 uint32_t u1Accessed : 1;
1686 /** Dirty flag.
1687 * Indicates that the page has been written to. */
1688 uint32_t u1Dirty : 1;
1689 /** Reserved / If PAT enabled, bit 2 of the index. */
1690 uint32_t u1PAT : 1;
1691 /** Global flag. (Ignored in all but final level.) */
1692 uint32_t u1Global : 1;
1693 /** Available for use to system software. */
1694 uint32_t u3Available : 3;
1695 /** Physical Page number of the next level - Low Part. Don't use this. */
1696 uint32_t u20PageNoLow : 20;
1697 /** Physical Page number of the next level - High Part. Don't use this. */
1698 uint32_t u20PageNoHigh : 20;
1699 /** MBZ bits */
1700 uint32_t u11Reserved : 11;
1701 /** No Execute flag. */
1702 uint32_t u1NoExecute : 1;
1703} X86PTEPAEBITS;
1704#ifndef VBOX_FOR_DTRACE_LIB
1705AssertCompileSize(X86PTEPAEBITS, 8);
1706#endif
1707/** Pointer to a page table entry. */
1708typedef X86PTEPAEBITS *PX86PTEPAEBITS;
1709/** Pointer to a page table entry. */
1710typedef const X86PTEPAEBITS *PCX86PTEPAEBITS;
1711
1712/**
1713 * PAE Page table entry.
1714 */
1715typedef union X86PTEPAE
1716{
1717 /** Unsigned integer view */
1718 X86PGPAEUINT u;
1719 /** Bit field view. */
1720 X86PTEPAEBITS n;
1721 /** 32-bit view. */
1722 uint32_t au32[2];
1723 /** 16-bit view. */
1724 uint16_t au16[4];
1725 /** 8-bit view. */
1726 uint8_t au8[8];
1727} X86PTEPAE;
1728#ifndef VBOX_FOR_DTRACE_LIB
1729AssertCompileSize(X86PTEPAE, 8);
1730#endif
1731/** Pointer to a PAE page table entry. */
1732typedef X86PTEPAE *PX86PTEPAE;
1733/** Pointer to a const PAE page table entry. */
1734typedef const X86PTEPAE *PCX86PTEPAE;
1735/** @} */
1736
1737/**
1738 * Page table.
1739 */
1740typedef struct X86PT
1741{
1742 /** PTE Array. */
1743 X86PTE a[X86_PG_ENTRIES];
1744} X86PT;
1745#ifndef VBOX_FOR_DTRACE_LIB
1746AssertCompileSize(X86PT, 4096);
1747#endif
1748/** Pointer to a page table. */
1749typedef X86PT *PX86PT;
1750/** Pointer to a const page table. */
1751typedef const X86PT *PCX86PT;
1752
1753/** The page shift to get the PT index. */
1754#define X86_PT_SHIFT 12
1755/** The PT index mask (apply to a shifted page address). */
1756#define X86_PT_MASK 0x3ff
1757
1758
1759/**
1760 * Page directory.
1761 */
1762typedef struct X86PTPAE
1763{
1764 /** PTE Array. */
1765 X86PTEPAE a[X86_PG_PAE_ENTRIES];
1766} X86PTPAE;
1767#ifndef VBOX_FOR_DTRACE_LIB
1768AssertCompileSize(X86PTPAE, 4096);
1769#endif
1770/** Pointer to a page table. */
1771typedef X86PTPAE *PX86PTPAE;
1772/** Pointer to a const page table. */
1773typedef const X86PTPAE *PCX86PTPAE;
1774
1775/** The page shift to get the PA PTE index. */
1776#define X86_PT_PAE_SHIFT 12
1777/** The PAE PT index mask (apply to a shifted page address). */
1778#define X86_PT_PAE_MASK 0x1ff
1779
1780
1781/** @name 4KB Page Directory Entry
1782 * @{
1783 */
1784/** Bit 0 - P - Present bit. */
1785#define X86_PDE_P RT_BIT_32(0)
1786/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1787#define X86_PDE_RW RT_BIT_32(1)
1788/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1789#define X86_PDE_US RT_BIT_32(2)
1790/** Bit 3 - PWT - Page level write thru bit. */
1791#define X86_PDE_PWT RT_BIT_32(3)
1792/** Bit 4 - PCD - Page level cache disable bit. */
1793#define X86_PDE_PCD RT_BIT_32(4)
1794/** Bit 5 - A - Access bit. */
1795#define X86_PDE_A RT_BIT_32(5)
1796/** Bit 7 - PS - Page size attribute.
1797 * Clear mean 4KB pages, set means large pages (2/4MB). */
1798#define X86_PDE_PS RT_BIT_32(7)
1799/** Bits 9-11 - - Available for use to system software. */
1800#define X86_PDE_AVL_MASK (RT_BIT_32(9) | RT_BIT_32(10) | RT_BIT_32(11))
1801/** Bits 12-31 - - Physical Page number of the next level. */
1802#define X86_PDE_PG_MASK ( 0xfffff000 )
1803
1804/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1805#define X86_PDE_PAE_PG_MASK UINT64_C(0x000ffffffffff000)
1806/** Bits 63 - NX - PAE/LM - No execution flag. */
1807#define X86_PDE_PAE_NX RT_BIT_64(63)
1808/** Bits 62-52, 7 - - PAE - MBZ bits when NX is active. */
1809#define X86_PDE_PAE_MBZ_MASK_NX UINT64_C(0x7ff0000000000080)
1810/** Bits 63-52, 7 - - PAE - MBZ bits when no NX. */
1811#define X86_PDE_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff0000000000080)
1812/** Bit 7 - - LM - MBZ bits when NX is active. */
1813#define X86_PDE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000080)
1814/** Bits 63, 7 - - LM - MBZ bits when no NX. */
1815#define X86_PDE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000080)
1816
1817/**
1818 * Page directory entry.
1819 */
1820typedef struct X86PDEBITS
1821{
1822 /** Flags whether(=1) or not the page is present. */
1823 uint32_t u1Present : 1;
1824 /** Read(=0) / Write(=1) flag. */
1825 uint32_t u1Write : 1;
1826 /** User(=1) / Supervisor (=0) flag. */
1827 uint32_t u1User : 1;
1828 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1829 uint32_t u1WriteThru : 1;
1830 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1831 uint32_t u1CacheDisable : 1;
1832 /** Accessed flag.
1833 * Indicates that the page has been read or written to. */
1834 uint32_t u1Accessed : 1;
1835 /** Reserved / Ignored (dirty bit). */
1836 uint32_t u1Reserved0 : 1;
1837 /** Size bit if PSE is enabled - in any event it's 0. */
1838 uint32_t u1Size : 1;
1839 /** Reserved / Ignored (global bit). */
1840 uint32_t u1Reserved1 : 1;
1841 /** Available for use to system software. */
1842 uint32_t u3Available : 3;
1843 /** Physical Page number of the next level. */
1844 uint32_t u20PageNo : 20;
1845} X86PDEBITS;
1846#ifndef VBOX_FOR_DTRACE_LIB
1847AssertCompileSize(X86PDEBITS, 4);
1848#endif
1849/** Pointer to a page directory entry. */
1850typedef X86PDEBITS *PX86PDEBITS;
1851/** Pointer to a const page directory entry. */
1852typedef const X86PDEBITS *PCX86PDEBITS;
1853
1854
1855/**
1856 * PAE page directory entry.
1857 */
1858typedef struct X86PDEPAEBITS
1859{
1860 /** Flags whether(=1) or not the page is present. */
1861 uint32_t u1Present : 1;
1862 /** Read(=0) / Write(=1) flag. */
1863 uint32_t u1Write : 1;
1864 /** User(=1) / Supervisor (=0) flag. */
1865 uint32_t u1User : 1;
1866 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1867 uint32_t u1WriteThru : 1;
1868 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1869 uint32_t u1CacheDisable : 1;
1870 /** Accessed flag.
1871 * Indicates that the page has been read or written to. */
1872 uint32_t u1Accessed : 1;
1873 /** Reserved / Ignored (dirty bit). */
1874 uint32_t u1Reserved0 : 1;
1875 /** Size bit if PSE is enabled - in any event it's 0. */
1876 uint32_t u1Size : 1;
1877 /** Reserved / Ignored (global bit). / */
1878 uint32_t u1Reserved1 : 1;
1879 /** Available for use to system software. */
1880 uint32_t u3Available : 3;
1881 /** Physical Page number of the next level - Low Part. Don't use! */
1882 uint32_t u20PageNoLow : 20;
1883 /** Physical Page number of the next level - High Part. Don't use! */
1884 uint32_t u20PageNoHigh : 20;
1885 /** MBZ bits */
1886 uint32_t u11Reserved : 11;
1887 /** No Execute flag. */
1888 uint32_t u1NoExecute : 1;
1889} X86PDEPAEBITS;
1890#ifndef VBOX_FOR_DTRACE_LIB
1891AssertCompileSize(X86PDEPAEBITS, 8);
1892#endif
1893/** Pointer to a page directory entry. */
1894typedef X86PDEPAEBITS *PX86PDEPAEBITS;
1895/** Pointer to a const page directory entry. */
1896typedef const X86PDEPAEBITS *PCX86PDEPAEBITS;
1897
1898/** @} */
1899
1900
1901/** @name 2/4MB Page Directory Entry
1902 * @{
1903 */
1904/** Bit 0 - P - Present bit. */
1905#define X86_PDE4M_P RT_BIT_32(0)
1906/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1907#define X86_PDE4M_RW RT_BIT_32(1)
1908/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1909#define X86_PDE4M_US RT_BIT_32(2)
1910/** Bit 3 - PWT - Page level write thru bit. */
1911#define X86_PDE4M_PWT RT_BIT_32(3)
1912/** Bit 4 - PCD - Page level cache disable bit. */
1913#define X86_PDE4M_PCD RT_BIT_32(4)
1914/** Bit 5 - A - Access bit. */
1915#define X86_PDE4M_A RT_BIT_32(5)
1916/** Bit 6 - D - Dirty bit. */
1917#define X86_PDE4M_D RT_BIT_32(6)
1918/** Bit 7 - PS - Page size attribute. Clear mean 4KB pages, set means large pages (2/4MB). */
1919#define X86_PDE4M_PS RT_BIT_32(7)
1920/** Bit 8 - G - Global flag. */
1921#define X86_PDE4M_G RT_BIT_32(8)
1922/** Bits 9-11 - AVL - Available for use to system software. */
1923#define X86_PDE4M_AVL (RT_BIT_32(9) | RT_BIT_32(10) | RT_BIT_32(11))
1924/** Bit 12 - PAT - Page Attribute Table index bit. Reserved and 0 if not supported. */
1925#define X86_PDE4M_PAT RT_BIT_32(12)
1926/** Shift to get from X86_PTE_PAT to X86_PDE4M_PAT. */
1927#define X86_PDE4M_PAT_SHIFT (12 - 7)
1928/** Bits 22-31 - - Physical Page number. */
1929#define X86_PDE4M_PG_MASK ( 0xffc00000 )
1930/** Bits 20-13 - - Physical Page number high part (32-39 bits). AMD64 hack. */
1931#define X86_PDE4M_PG_HIGH_MASK ( 0x001fe000 )
1932/** The number of bits to the high part of the page number. */
1933#define X86_PDE4M_PG_HIGH_SHIFT 19
1934/** Bit 21 - - MBZ bits for AMD CPUs, no PSE36. */
1935#define X86_PDE4M_MBZ_MASK RT_BIT_32(21)
1936
1937/** Bits 21-51 - - PAE/LM - Physical Page number.
1938 * (Bits 40-51 (long mode) & bits 36-51 (pae legacy) are reserved according to the Intel docs; AMD allows for more.) */
1939#define X86_PDE2M_PAE_PG_MASK UINT64_C(0x000fffffffe00000)
1940/** Bits 63 - NX - PAE/LM - No execution flag. */
1941#define X86_PDE2M_PAE_NX RT_BIT_64(63)
1942/** Bits 62-52, 20-13 - - PAE - MBZ bits when NX is active. */
1943#define X86_PDE2M_PAE_MBZ_MASK_NX UINT64_C(0x7ff00000001fe000)
1944/** Bits 63-52, 20-13 - - PAE - MBZ bits when no NX. */
1945#define X86_PDE2M_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff00000001fe000)
1946/** Bits 20-13 - - LM - MBZ bits when NX is active. */
1947#define X86_PDE2M_LM_MBZ_MASK_NX UINT64_C(0x00000000001fe000)
1948/** Bits 63, 20-13 - - LM - MBZ bits when no NX. */
1949#define X86_PDE2M_LM_MBZ_MASK_NO_NX UINT64_C(0x80000000001fe000)
1950
1951/**
1952 * 4MB page directory entry.
1953 */
1954typedef struct X86PDE4MBITS
1955{
1956 /** Flags whether(=1) or not the page is present. */
1957 uint32_t u1Present : 1;
1958 /** Read(=0) / Write(=1) flag. */
1959 uint32_t u1Write : 1;
1960 /** User(=1) / Supervisor (=0) flag. */
1961 uint32_t u1User : 1;
1962 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1963 uint32_t u1WriteThru : 1;
1964 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1965 uint32_t u1CacheDisable : 1;
1966 /** Accessed flag.
1967 * Indicates that the page have been read or written to. */
1968 uint32_t u1Accessed : 1;
1969 /** Dirty flag.
1970 * Indicates that the page has been written to. */
1971 uint32_t u1Dirty : 1;
1972 /** Page size flag - always 1 for 4MB entries. */
1973 uint32_t u1Size : 1;
1974 /** Global flag. */
1975 uint32_t u1Global : 1;
1976 /** Available for use to system software. */
1977 uint32_t u3Available : 3;
1978 /** Reserved / If PAT enabled, bit 2 of the index. */
1979 uint32_t u1PAT : 1;
1980 /** Bits 32-39 of the page number on AMD64.
1981 * This AMD64 hack allows accessing 40bits of physical memory without PAE. */
1982 uint32_t u8PageNoHigh : 8;
1983 /** Reserved. */
1984 uint32_t u1Reserved : 1;
1985 /** Physical Page number of the page. */
1986 uint32_t u10PageNo : 10;
1987} X86PDE4MBITS;
1988#ifndef VBOX_FOR_DTRACE_LIB
1989AssertCompileSize(X86PDE4MBITS, 4);
1990#endif
1991/** Pointer to a page table entry. */
1992typedef X86PDE4MBITS *PX86PDE4MBITS;
1993/** Pointer to a const page table entry. */
1994typedef const X86PDE4MBITS *PCX86PDE4MBITS;
1995
1996
1997/**
1998 * 2MB PAE page directory entry.
1999 */
2000typedef struct X86PDE2MPAEBITS
2001{
2002 /** Flags whether(=1) or not the page is present. */
2003 uint32_t u1Present : 1;
2004 /** Read(=0) / Write(=1) flag. */
2005 uint32_t u1Write : 1;
2006 /** User(=1) / Supervisor(=0) flag. */
2007 uint32_t u1User : 1;
2008 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
2009 uint32_t u1WriteThru : 1;
2010 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
2011 uint32_t u1CacheDisable : 1;
2012 /** Accessed flag.
2013 * Indicates that the page have been read or written to. */
2014 uint32_t u1Accessed : 1;
2015 /** Dirty flag.
2016 * Indicates that the page has been written to. */
2017 uint32_t u1Dirty : 1;
2018 /** Page size flag - always 1 for 2MB entries. */
2019 uint32_t u1Size : 1;
2020 /** Global flag. */
2021 uint32_t u1Global : 1;
2022 /** Available for use to system software. */
2023 uint32_t u3Available : 3;
2024 /** Reserved / If PAT enabled, bit 2 of the index. */
2025 uint32_t u1PAT : 1;
2026 /** Reserved. */
2027 uint32_t u9Reserved : 9;
2028 /** Physical Page number of the next level - Low part. Don't use! */
2029 uint32_t u10PageNoLow : 10;
2030 /** Physical Page number of the next level - High part. Don't use! */
2031 uint32_t u20PageNoHigh : 20;
2032 /** MBZ bits */
2033 uint32_t u11Reserved : 11;
2034 /** No Execute flag. */
2035 uint32_t u1NoExecute : 1;
2036} X86PDE2MPAEBITS;
2037#ifndef VBOX_FOR_DTRACE_LIB
2038AssertCompileSize(X86PDE2MPAEBITS, 8);
2039#endif
2040/** Pointer to a 2MB PAE page table entry. */
2041typedef X86PDE2MPAEBITS *PX86PDE2MPAEBITS;
2042/** Pointer to a 2MB PAE page table entry. */
2043typedef const X86PDE2MPAEBITS *PCX86PDE2MPAEBITS;
2044
2045/** @} */
2046
2047/**
2048 * Page directory entry.
2049 */
2050typedef union X86PDE
2051{
2052 /** Unsigned integer view. */
2053 X86PGUINT u;
2054 /** Normal view. */
2055 X86PDEBITS n;
2056 /** 4MB view (big). */
2057 X86PDE4MBITS b;
2058 /** 8 bit unsigned integer view. */
2059 uint8_t au8[4];
2060 /** 16 bit unsigned integer view. */
2061 uint16_t au16[2];
2062 /** 32 bit unsigned integer view. */
2063 uint32_t au32[1];
2064} X86PDE;
2065#ifndef VBOX_FOR_DTRACE_LIB
2066AssertCompileSize(X86PDE, 4);
2067#endif
2068/** Pointer to a page directory entry. */
2069typedef X86PDE *PX86PDE;
2070/** Pointer to a const page directory entry. */
2071typedef const X86PDE *PCX86PDE;
2072
2073/**
2074 * PAE page directory entry.
2075 */
2076typedef union X86PDEPAE
2077{
2078 /** Unsigned integer view. */
2079 X86PGPAEUINT u;
2080 /** Normal view. */
2081 X86PDEPAEBITS n;
2082 /** 2MB page view (big). */
2083 X86PDE2MPAEBITS b;
2084 /** 8 bit unsigned integer view. */
2085 uint8_t au8[8];
2086 /** 16 bit unsigned integer view. */
2087 uint16_t au16[4];
2088 /** 32 bit unsigned integer view. */
2089 uint32_t au32[2];
2090} X86PDEPAE;
2091#ifndef VBOX_FOR_DTRACE_LIB
2092AssertCompileSize(X86PDEPAE, 8);
2093#endif
2094/** Pointer to a page directory entry. */
2095typedef X86PDEPAE *PX86PDEPAE;
2096/** Pointer to a const page directory entry. */
2097typedef const X86PDEPAE *PCX86PDEPAE;
2098
2099/**
2100 * Page directory.
2101 */
2102typedef struct X86PD
2103{
2104 /** PDE Array. */
2105 X86PDE a[X86_PG_ENTRIES];
2106} X86PD;
2107#ifndef VBOX_FOR_DTRACE_LIB
2108AssertCompileSize(X86PD, 4096);
2109#endif
2110/** Pointer to a page directory. */
2111typedef X86PD *PX86PD;
2112/** Pointer to a const page directory. */
2113typedef const X86PD *PCX86PD;
2114
2115/** The page shift to get the PD index. */
2116#define X86_PD_SHIFT 22
2117/** The PD index mask (apply to a shifted page address). */
2118#define X86_PD_MASK 0x3ff
2119
2120
2121/**
2122 * PAE page directory.
2123 */
2124typedef struct X86PDPAE
2125{
2126 /** PDE Array. */
2127 X86PDEPAE a[X86_PG_PAE_ENTRIES];
2128} X86PDPAE;
2129#ifndef VBOX_FOR_DTRACE_LIB
2130AssertCompileSize(X86PDPAE, 4096);
2131#endif
2132/** Pointer to a PAE page directory. */
2133typedef X86PDPAE *PX86PDPAE;
2134/** Pointer to a const PAE page directory. */
2135typedef const X86PDPAE *PCX86PDPAE;
2136
2137/** The page shift to get the PAE PD index. */
2138#define X86_PD_PAE_SHIFT 21
2139/** The PAE PD index mask (apply to a shifted page address). */
2140#define X86_PD_PAE_MASK 0x1ff
2141
2142
2143/** @name Page Directory Pointer Table Entry (PAE)
2144 * @{
2145 */
2146/** Bit 0 - P - Present bit. */
2147#define X86_PDPE_P RT_BIT_32(0)
2148/** Bit 1 - R/W - Read (clear) / Write (set) bit. Long Mode only. */
2149#define X86_PDPE_RW RT_BIT_32(1)
2150/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. Long Mode only. */
2151#define X86_PDPE_US RT_BIT_32(2)
2152/** Bit 3 - PWT - Page level write thru bit. */
2153#define X86_PDPE_PWT RT_BIT_32(3)
2154/** Bit 4 - PCD - Page level cache disable bit. */
2155#define X86_PDPE_PCD RT_BIT_32(4)
2156/** Bit 5 - A - Access bit. Long Mode only. */
2157#define X86_PDPE_A RT_BIT_32(5)
2158/** Bit 7 - PS - Page size (1GB). Long Mode only. */
2159#define X86_PDPE_LM_PS RT_BIT_32(7)
2160/** Bits 9-11 - - Available for use to system software. */
2161#define X86_PDPE_AVL_MASK (RT_BIT_32(9) | RT_BIT_32(10) | RT_BIT_32(11))
2162/** Bits 12-51 - - PAE - Physical Page number of the next level. */
2163#define X86_PDPE_PG_MASK UINT64_C(0x000ffffffffff000)
2164/** Bits 63-52, 8-5, 2-1 - - PAE - MBZ bits (NX is long mode only). */
2165#define X86_PDPE_PAE_MBZ_MASK UINT64_C(0xfff00000000001e6)
2166/** Bits 63 - NX - LM - No execution flag. Long Mode only. */
2167#define X86_PDPE_LM_NX RT_BIT_64(63)
2168/** Bits 8, 7 - - LM - MBZ bits when NX is active. */
2169#define X86_PDPE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000180)
2170/** Bits 63, 8, 7 - - LM - MBZ bits when no NX. */
2171#define X86_PDPE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000180)
2172/** Bits 29-13 - - LM - MBZ bits for 1GB page entry when NX is active. */
2173#define X86_PDPE1G_LM_MBZ_MASK_NX UINT64_C(0x000000003fffe000)
2174/** Bits 63, 29-13 - - LM - MBZ bits for 1GB page entry when no NX. */
2175#define X86_PDPE1G_LM_MBZ_MASK_NO_NX UINT64_C(0x800000003fffe000)
2176
2177
2178/**
2179 * Page directory pointer table entry.
2180 */
2181typedef struct X86PDPEBITS
2182{
2183 /** Flags whether(=1) or not the page is present. */
2184 uint32_t u1Present : 1;
2185 /** Chunk of reserved bits. */
2186 uint32_t u2Reserved : 2;
2187 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
2188 uint32_t u1WriteThru : 1;
2189 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
2190 uint32_t u1CacheDisable : 1;
2191 /** Chunk of reserved bits. */
2192 uint32_t u4Reserved : 4;
2193 /** Available for use to system software. */
2194 uint32_t u3Available : 3;
2195 /** Physical Page number of the next level - Low Part. Don't use! */
2196 uint32_t u20PageNoLow : 20;
2197 /** Physical Page number of the next level - High Part. Don't use! */
2198 uint32_t u20PageNoHigh : 20;
2199 /** MBZ bits */
2200 uint32_t u12Reserved : 12;
2201} X86PDPEBITS;
2202#ifndef VBOX_FOR_DTRACE_LIB
2203AssertCompileSize(X86PDPEBITS, 8);
2204#endif
2205/** Pointer to a page directory pointer table entry. */
2206typedef X86PDPEBITS *PX86PTPEBITS;
2207/** Pointer to a const page directory pointer table entry. */
2208typedef const X86PDPEBITS *PCX86PTPEBITS;
2209
2210/**
2211 * Page directory pointer table entry. AMD64 version
2212 */
2213typedef struct X86PDPEAMD64BITS
2214{
2215 /** Flags whether(=1) or not the page is present. */
2216 uint32_t u1Present : 1;
2217 /** Read(=0) / Write(=1) flag. */
2218 uint32_t u1Write : 1;
2219 /** User(=1) / Supervisor (=0) flag. */
2220 uint32_t u1User : 1;
2221 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
2222 uint32_t u1WriteThru : 1;
2223 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
2224 uint32_t u1CacheDisable : 1;
2225 /** Accessed flag.
2226 * Indicates that the page have been read or written to. */
2227 uint32_t u1Accessed : 1;
2228 /** Chunk of reserved bits. */
2229 uint32_t u3Reserved : 3;
2230 /** Available for use to system software. */
2231 uint32_t u3Available : 3;
2232 /** Physical Page number of the next level - Low Part. Don't use! */
2233 uint32_t u20PageNoLow : 20;
2234 /** Physical Page number of the next level - High Part. Don't use! */
2235 uint32_t u20PageNoHigh : 20;
2236 /** MBZ bits */
2237 uint32_t u11Reserved : 11;
2238 /** No Execute flag. */
2239 uint32_t u1NoExecute : 1;
2240} X86PDPEAMD64BITS;
2241#ifndef VBOX_FOR_DTRACE_LIB
2242AssertCompileSize(X86PDPEAMD64BITS, 8);
2243#endif
2244/** Pointer to a page directory pointer table entry. */
2245typedef X86PDPEAMD64BITS *PX86PDPEAMD64BITS;
2246/** Pointer to a const page directory pointer table entry. */
2247typedef const X86PDPEAMD64BITS *PCX86PDPEAMD64BITS;
2248
2249/**
2250 * Page directory pointer table entry for 1GB page. (AMD64 only)
2251 */
2252typedef struct X86PDPE1GB
2253{
2254 /** 0: Flags whether(=1) or not the page is present. */
2255 uint32_t u1Present : 1;
2256 /** 1: Read(=0) / Write(=1) flag. */
2257 uint32_t u1Write : 1;
2258 /** 2: User(=1) / Supervisor (=0) flag. */
2259 uint32_t u1User : 1;
2260 /** 3: Write Thru flag. If PAT enabled, bit 0 of the index. */
2261 uint32_t u1WriteThru : 1;
2262 /** 4: Cache disabled flag. If PAT enabled, bit 1 of the index. */
2263 uint32_t u1CacheDisable : 1;
2264 /** 5: Accessed flag.
2265 * Indicates that the page have been read or written to. */
2266 uint32_t u1Accessed : 1;
2267 /** 6: Dirty flag for 1GB pages. */
2268 uint32_t u1Dirty : 1;
2269 /** 7: Indicates 1GB page if set. */
2270 uint32_t u1Size : 1;
2271 /** 8: Global 1GB page. */
2272 uint32_t u1Global: 1;
2273 /** 9-11: Available for use to system software. */
2274 uint32_t u3Available : 3;
2275 /** 12: PAT bit for 1GB page. */
2276 uint32_t u1PAT : 1;
2277 /** 13-29: MBZ bits. */
2278 uint32_t u17Reserved : 17;
2279 /** 30-31: Physical page number - Low Part. Don't use! */
2280 uint32_t u2PageNoLow : 2;
2281 /** 32-51: Physical Page number of the next level - High Part. Don't use! */
2282 uint32_t u20PageNoHigh : 20;
2283 /** 52-62: MBZ bits */
2284 uint32_t u11Reserved : 11;
2285 /** 63: No Execute flag. */
2286 uint32_t u1NoExecute : 1;
2287} X86PDPE1GB;
2288#ifndef VBOX_FOR_DTRACE_LIB
2289AssertCompileSize(X86PDPE1GB, 8);
2290#endif
2291/** Pointer to a page directory pointer table entry for a 1GB page. */
2292typedef X86PDPE1GB *PX86PDPE1GB;
2293/** Pointer to a const page directory pointer table entry for a 1GB page. */
2294typedef const X86PDPE1GB *PCX86PDPE1GB;
2295
2296/**
2297 * Page directory pointer table entry.
2298 */
2299typedef union X86PDPE
2300{
2301 /** Unsigned integer view. */
2302 X86PGPAEUINT u;
2303 /** Normal view. */
2304 X86PDPEBITS n;
2305 /** AMD64 view. */
2306 X86PDPEAMD64BITS lm;
2307 /** AMD64 big view. */
2308 X86PDPE1GB b;
2309 /** 8 bit unsigned integer view. */
2310 uint8_t au8[8];
2311 /** 16 bit unsigned integer view. */
2312 uint16_t au16[4];
2313 /** 32 bit unsigned integer view. */
2314 uint32_t au32[2];
2315} X86PDPE;
2316#ifndef VBOX_FOR_DTRACE_LIB
2317AssertCompileSize(X86PDPE, 8);
2318#endif
2319/** Pointer to a page directory pointer table entry. */
2320typedef X86PDPE *PX86PDPE;
2321/** Pointer to a const page directory pointer table entry. */
2322typedef const X86PDPE *PCX86PDPE;
2323
2324
2325/**
2326 * Page directory pointer table.
2327 */
2328typedef struct X86PDPT
2329{
2330 /** PDE Array. */
2331 X86PDPE a[X86_PG_AMD64_PDPE_ENTRIES];
2332} X86PDPT;
2333#ifndef VBOX_FOR_DTRACE_LIB
2334AssertCompileSize(X86PDPT, 4096);
2335#endif
2336/** Pointer to a page directory pointer table. */
2337typedef X86PDPT *PX86PDPT;
2338/** Pointer to a const page directory pointer table. */
2339typedef const X86PDPT *PCX86PDPT;
2340
2341/** The page shift to get the PDPT index. */
2342#define X86_PDPT_SHIFT 30
2343/** The PDPT index mask (apply to a shifted page address). (32 bits PAE) */
2344#define X86_PDPT_MASK_PAE 0x3
2345/** The PDPT index mask (apply to a shifted page address). (64 bits PAE)*/
2346#define X86_PDPT_MASK_AMD64 0x1ff
2347
2348/** @} */
2349
2350
2351/** @name Page Map Level-4 Entry (Long Mode PAE)
2352 * @{
2353 */
2354/** Bit 0 - P - Present bit. */
2355#define X86_PML4E_P RT_BIT_32(0)
2356/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
2357#define X86_PML4E_RW RT_BIT_32(1)
2358/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
2359#define X86_PML4E_US RT_BIT_32(2)
2360/** Bit 3 - PWT - Page level write thru bit. */
2361#define X86_PML4E_PWT RT_BIT_32(3)
2362/** Bit 4 - PCD - Page level cache disable bit. */
2363#define X86_PML4E_PCD RT_BIT_32(4)
2364/** Bit 5 - A - Access bit. */
2365#define X86_PML4E_A RT_BIT_32(5)
2366/** Bits 9-11 - - Available for use to system software. */
2367#define X86_PML4E_AVL_MASK (RT_BIT_32(9) | RT_BIT_32(10) | RT_BIT_32(11))
2368/** Bits 12-51 - - PAE - Physical Page number of the next level. */
2369#define X86_PML4E_PG_MASK UINT64_C(0x000ffffffffff000)
2370/** Bits 8, 7 - - MBZ bits when NX is active. */
2371#define X86_PML4E_MBZ_MASK_NX UINT64_C(0x0000000000000080)
2372/** Bits 63, 7 - - MBZ bits when no NX. */
2373#define X86_PML4E_MBZ_MASK_NO_NX UINT64_C(0x8000000000000080)
2374/** Bits 63 - NX - PAE - No execution flag. */
2375#define X86_PML4E_NX RT_BIT_64(63)
2376
2377/**
2378 * Page Map Level-4 Entry
2379 */
2380typedef struct X86PML4EBITS
2381{
2382 /** Flags whether(=1) or not the page is present. */
2383 uint32_t u1Present : 1;
2384 /** Read(=0) / Write(=1) flag. */
2385 uint32_t u1Write : 1;
2386 /** User(=1) / Supervisor (=0) flag. */
2387 uint32_t u1User : 1;
2388 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
2389 uint32_t u1WriteThru : 1;
2390 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
2391 uint32_t u1CacheDisable : 1;
2392 /** Accessed flag.
2393 * Indicates that the page have been read or written to. */
2394 uint32_t u1Accessed : 1;
2395 /** Chunk of reserved bits. */
2396 uint32_t u3Reserved : 3;
2397 /** Available for use to system software. */
2398 uint32_t u3Available : 3;
2399 /** Physical Page number of the next level - Low Part. Don't use! */
2400 uint32_t u20PageNoLow : 20;
2401 /** Physical Page number of the next level - High Part. Don't use! */
2402 uint32_t u20PageNoHigh : 20;
2403 /** MBZ bits */
2404 uint32_t u11Reserved : 11;
2405 /** No Execute flag. */
2406 uint32_t u1NoExecute : 1;
2407} X86PML4EBITS;
2408#ifndef VBOX_FOR_DTRACE_LIB
2409AssertCompileSize(X86PML4EBITS, 8);
2410#endif
2411/** Pointer to a page map level-4 entry. */
2412typedef X86PML4EBITS *PX86PML4EBITS;
2413/** Pointer to a const page map level-4 entry. */
2414typedef const X86PML4EBITS *PCX86PML4EBITS;
2415
2416/**
2417 * Page Map Level-4 Entry.
2418 */
2419typedef union X86PML4E
2420{
2421 /** Unsigned integer view. */
2422 X86PGPAEUINT u;
2423 /** Normal view. */
2424 X86PML4EBITS n;
2425 /** 8 bit unsigned integer view. */
2426 uint8_t au8[8];
2427 /** 16 bit unsigned integer view. */
2428 uint16_t au16[4];
2429 /** 32 bit unsigned integer view. */
2430 uint32_t au32[2];
2431} X86PML4E;
2432#ifndef VBOX_FOR_DTRACE_LIB
2433AssertCompileSize(X86PML4E, 8);
2434#endif
2435/** Pointer to a page map level-4 entry. */
2436typedef X86PML4E *PX86PML4E;
2437/** Pointer to a const page map level-4 entry. */
2438typedef const X86PML4E *PCX86PML4E;
2439
2440
2441/**
2442 * Page Map Level-4.
2443 */
2444typedef struct X86PML4
2445{
2446 /** PDE Array. */
2447 X86PML4E a[X86_PG_PAE_ENTRIES];
2448} X86PML4;
2449#ifndef VBOX_FOR_DTRACE_LIB
2450AssertCompileSize(X86PML4, 4096);
2451#endif
2452/** Pointer to a page map level-4. */
2453typedef X86PML4 *PX86PML4;
2454/** Pointer to a const page map level-4. */
2455typedef const X86PML4 *PCX86PML4;
2456
2457/** The page shift to get the PML4 index. */
2458#define X86_PML4_SHIFT 39
2459/** The PML4 index mask (apply to a shifted page address). */
2460#define X86_PML4_MASK 0x1ff
2461
2462/** @} */
2463
2464/** @} */
2465
2466/**
2467 * 32-bit protected mode FSTENV image.
2468 */
2469typedef struct X86FSTENV32P
2470{
2471 uint16_t FCW;
2472 uint16_t padding1;
2473 uint16_t FSW;
2474 uint16_t padding2;
2475 uint16_t FTW;
2476 uint16_t padding3;
2477 uint32_t FPUIP;
2478 uint16_t FPUCS;
2479 uint16_t FOP;
2480 uint32_t FPUDP;
2481 uint16_t FPUDS;
2482 uint16_t padding4;
2483} X86FSTENV32P;
2484/** Pointer to a 32-bit protected mode FSTENV image. */
2485typedef X86FSTENV32P *PX86FSTENV32P;
2486/** Pointer to a const 32-bit protected mode FSTENV image. */
2487typedef X86FSTENV32P const *PCX86FSTENV32P;
2488
2489
2490/**
2491 * 80-bit MMX/FPU register type.
2492 */
2493typedef struct X86FPUMMX
2494{
2495 uint8_t reg[10];
2496} X86FPUMMX;
2497#ifndef VBOX_FOR_DTRACE_LIB
2498AssertCompileSize(X86FPUMMX, 10);
2499#endif
2500/** Pointer to a 80-bit MMX/FPU register type. */
2501typedef X86FPUMMX *PX86FPUMMX;
2502/** Pointer to a const 80-bit MMX/FPU register type. */
2503typedef const X86FPUMMX *PCX86FPUMMX;
2504
2505/** FPU (x87) register. */
2506typedef union X86FPUREG
2507{
2508 /** MMX view. */
2509 uint64_t mmx;
2510 /** FPU view - todo. */
2511 X86FPUMMX fpu;
2512 /** Extended precision floating point view. */
2513 RTFLOAT80U r80;
2514 /** Extended precision floating point view v2 */
2515 RTFLOAT80U2 r80Ex;
2516 /** 8-bit view. */
2517 uint8_t au8[16];
2518 /** 16-bit view. */
2519 uint16_t au16[8];
2520 /** 32-bit view. */
2521 uint32_t au32[4];
2522 /** 64-bit view. */
2523 uint64_t au64[2];
2524 /** 128-bit view. (yeah, very helpful) */
2525 uint128_t au128[1];
2526} X86FPUREG;
2527#ifndef VBOX_FOR_DTRACE_LIB
2528AssertCompileSize(X86FPUREG, 16);
2529#endif
2530/** Pointer to a FPU register. */
2531typedef X86FPUREG *PX86FPUREG;
2532/** Pointer to a const FPU register. */
2533typedef X86FPUREG const *PCX86FPUREG;
2534
2535/**
2536 * XMM register union.
2537 */
2538typedef union X86XMMREG
2539{
2540 /** XMM Register view *. */
2541 uint128_t xmm;
2542 /** 8-bit view. */
2543 uint8_t au8[16];
2544 /** 16-bit view. */
2545 uint16_t au16[8];
2546 /** 32-bit view. */
2547 uint32_t au32[4];
2548 /** 64-bit view. */
2549 uint64_t au64[2];
2550 /** 128-bit view. (yeah, very helpful) */
2551 uint128_t au128[1];
2552} X86XMMREG;
2553#ifndef VBOX_FOR_DTRACE_LIB
2554AssertCompileSize(X86XMMREG, 16);
2555#endif
2556/** Pointer to an XMM register state. */
2557typedef X86XMMREG *PX86XMMREG;
2558/** Pointer to a const XMM register state. */
2559typedef X86XMMREG const *PCX86XMMREG;
2560
2561/**
2562 * YMM register union.
2563 */
2564typedef union X86YMMREG
2565{
2566 /** 8-bit view. */
2567 uint8_t au8[32];
2568 /** 16-bit view. */
2569 uint16_t au16[16];
2570 /** 32-bit view. */
2571 uint32_t au32[8];
2572 /** 64-bit view. */
2573 uint64_t au64[4];
2574 /** 128-bit view. (yeah, very helpful) */
2575 uint128_t au128[2];
2576 /** XMM sub register view. */
2577 X86XMMREG aXmm[2];
2578} X86YMMREG;
2579#ifndef VBOX_FOR_DTRACE_LIB
2580AssertCompileSize(X86YMMREG, 32);
2581#endif
2582/** Pointer to an YMM register state. */
2583typedef X86YMMREG *PX86YMMREG;
2584/** Pointer to a const YMM register state. */
2585typedef X86YMMREG const *PCX86YMMREG;
2586
2587/**
2588 * ZMM register union.
2589 */
2590typedef union X86ZMMREG
2591{
2592 /** 8-bit view. */
2593 uint8_t au8[64];
2594 /** 16-bit view. */
2595 uint16_t au16[32];
2596 /** 32-bit view. */
2597 uint32_t au32[16];
2598 /** 64-bit view. */
2599 uint64_t au64[8];
2600 /** 128-bit view. (yeah, very helpful) */
2601 uint128_t au128[4];
2602 /** XMM sub register view. */
2603 X86XMMREG aXmm[4];
2604 /** YMM sub register view. */
2605 X86YMMREG aYmm[2];
2606} X86ZMMREG;
2607#ifndef VBOX_FOR_DTRACE_LIB
2608AssertCompileSize(X86ZMMREG, 64);
2609#endif
2610/** Pointer to an ZMM register state. */
2611typedef X86ZMMREG *PX86ZMMREG;
2612/** Pointer to a const ZMM register state. */
2613typedef X86ZMMREG const *PCX86ZMMREG;
2614
2615
2616/**
2617 * 32-bit FPU state (aka FSAVE/FRSTOR Memory Region).
2618 * @todo verify this...
2619 */
2620#pragma pack(1)
2621typedef struct X86FPUSTATE
2622{
2623 /** 0x00 - Control word. */
2624 uint16_t FCW;
2625 /** 0x02 - Alignment word */
2626 uint16_t Dummy1;
2627 /** 0x04 - Status word. */
2628 uint16_t FSW;
2629 /** 0x06 - Alignment word */
2630 uint16_t Dummy2;
2631 /** 0x08 - Tag word */
2632 uint16_t FTW;
2633 /** 0x0a - Alignment word */
2634 uint16_t Dummy3;
2635
2636 /** 0x0c - Instruction pointer. */
2637 uint32_t FPUIP;
2638 /** 0x10 - Code selector. */
2639 uint16_t CS;
2640 /** 0x12 - Opcode. */
2641 uint16_t FOP;
2642 /** 0x14 - FOO. */
2643 uint32_t FPUOO;
2644 /** 0x18 - FOS. */
2645 uint32_t FPUOS;
2646 /** 0x1c - FPU register. */
2647 X86FPUREG regs[8];
2648} X86FPUSTATE;
2649#pragma pack()
2650/** Pointer to a FPU state. */
2651typedef X86FPUSTATE *PX86FPUSTATE;
2652/** Pointer to a const FPU state. */
2653typedef const X86FPUSTATE *PCX86FPUSTATE;
2654
2655/**
2656 * FPU Extended state (aka FXSAVE/FXRSTORE Memory Region).
2657 */
2658#pragma pack(1)
2659typedef struct X86FXSTATE
2660{
2661 /** 0x00 - Control word. */
2662 uint16_t FCW;
2663 /** 0x02 - Status word. */
2664 uint16_t FSW;
2665 /** 0x04 - Tag word. (The upper byte is always zero.) */
2666 uint16_t FTW;
2667 /** 0x06 - Opcode. */
2668 uint16_t FOP;
2669 /** 0x08 - Instruction pointer. */
2670 uint32_t FPUIP;
2671 /** 0x0c - Code selector. */
2672 uint16_t CS;
2673 uint16_t Rsrvd1;
2674 /** 0x10 - Data pointer. */
2675 uint32_t FPUDP;
2676 /** 0x14 - Data segment */
2677 uint16_t DS;
2678 /** 0x16 */
2679 uint16_t Rsrvd2;
2680 /** 0x18 */
2681 uint32_t MXCSR;
2682 /** 0x1c */
2683 uint32_t MXCSR_MASK;
2684 /** 0x20 - FPU registers. */
2685 X86FPUREG aRegs[8];
2686 /** 0xA0 - XMM registers - 8 registers in 32 bits mode, 16 in long mode. */
2687 X86XMMREG aXMM[16];
2688 /* - offset 416 - */
2689 uint32_t au32RsrvdRest[(464 - 416) / sizeof(uint32_t)];
2690 /* - offset 464 - Software usable reserved bits. */
2691 uint32_t au32RsrvdForSoftware[(512 - 464) / sizeof(uint32_t)];
2692} X86FXSTATE;
2693#pragma pack()
2694/** Pointer to a FPU Extended state. */
2695typedef X86FXSTATE *PX86FXSTATE;
2696/** Pointer to a const FPU Extended state. */
2697typedef const X86FXSTATE *PCX86FXSTATE;
2698
2699/** Offset for software usable reserved bits (464:511) where we store a 32-bit
2700 * magic. Don't forget to update x86.mac if you change this! */
2701#define X86_OFF_FXSTATE_RSVD 0x1d0
2702/** The 32-bit magic used to recognize if this a 32-bit FPU state. Don't
2703 * forget to update x86.mac if you change this!
2704 * @todo r=bird: This has nothing what-so-ever to do here.... */
2705#define X86_FXSTATE_RSVD_32BIT_MAGIC 0x32b3232b
2706#ifndef VBOX_FOR_DTRACE_LIB
2707AssertCompileSize(X86FXSTATE, 512);
2708AssertCompileMemberOffset(X86FXSTATE, au32RsrvdForSoftware, X86_OFF_FXSTATE_RSVD);
2709#endif
2710
2711/** @name FPU status word flags.
2712 * @{ */
2713/** Exception Flag: Invalid operation. */
2714#define X86_FSW_IE RT_BIT_32(0)
2715/** Exception Flag: Denormalized operand. */
2716#define X86_FSW_DE RT_BIT_32(1)
2717/** Exception Flag: Zero divide. */
2718#define X86_FSW_ZE RT_BIT_32(2)
2719/** Exception Flag: Overflow. */
2720#define X86_FSW_OE RT_BIT_32(3)
2721/** Exception Flag: Underflow. */
2722#define X86_FSW_UE RT_BIT_32(4)
2723/** Exception Flag: Precision. */
2724#define X86_FSW_PE RT_BIT_32(5)
2725/** Stack fault. */
2726#define X86_FSW_SF RT_BIT_32(6)
2727/** Error summary status. */
2728#define X86_FSW_ES RT_BIT_32(7)
2729/** Mask of exceptions flags, excluding the summary bit. */
2730#define X86_FSW_XCPT_MASK UINT16_C(0x007f)
2731/** Mask of exceptions flags, including the summary bit. */
2732#define X86_FSW_XCPT_ES_MASK UINT16_C(0x00ff)
2733/** Condition code 0. */
2734#define X86_FSW_C0 RT_BIT_32(8)
2735/** Condition code 1. */
2736#define X86_FSW_C1 RT_BIT_32(9)
2737/** Condition code 2. */
2738#define X86_FSW_C2 RT_BIT_32(10)
2739/** Top of the stack mask. */
2740#define X86_FSW_TOP_MASK UINT16_C(0x3800)
2741/** TOP shift value. */
2742#define X86_FSW_TOP_SHIFT 11
2743/** Mask for getting TOP value after shifting it right. */
2744#define X86_FSW_TOP_SMASK UINT16_C(0x0007)
2745/** Get the TOP value. */
2746#define X86_FSW_TOP_GET(a_uFsw) (((a_uFsw) >> X86_FSW_TOP_SHIFT) & X86_FSW_TOP_SMASK)
2747/** Condition code 3. */
2748#define X86_FSW_C3 RT_BIT_32(14)
2749/** Mask of exceptions flags, including the summary bit. */
2750#define X86_FSW_C_MASK UINT16_C(0x4700)
2751/** FPU busy. */
2752#define X86_FSW_B RT_BIT_32(15)
2753/** @} */
2754
2755
2756/** @name FPU control word flags.
2757 * @{ */
2758/** Exception Mask: Invalid operation. */
2759#define X86_FCW_IM RT_BIT_32(0)
2760/** Exception Mask: Denormalized operand. */
2761#define X86_FCW_DM RT_BIT_32(1)
2762/** Exception Mask: Zero divide. */
2763#define X86_FCW_ZM RT_BIT_32(2)
2764/** Exception Mask: Overflow. */
2765#define X86_FCW_OM RT_BIT_32(3)
2766/** Exception Mask: Underflow. */
2767#define X86_FCW_UM RT_BIT_32(4)
2768/** Exception Mask: Precision. */
2769#define X86_FCW_PM RT_BIT_32(5)
2770/** Mask all exceptions, the value typically loaded (by for instance fninit).
2771 * @remarks This includes reserved bit 6. */
2772#define X86_FCW_MASK_ALL UINT16_C(0x007f)
2773/** Mask all exceptions. Same as X86_FSW_XCPT_MASK. */
2774#define X86_FCW_XCPT_MASK UINT16_C(0x003f)
2775/** Precision control mask. */
2776#define X86_FCW_PC_MASK UINT16_C(0x0300)
2777/** Precision control: 24-bit. */
2778#define X86_FCW_PC_24 UINT16_C(0x0000)
2779/** Precision control: Reserved. */
2780#define X86_FCW_PC_RSVD UINT16_C(0x0100)
2781/** Precision control: 53-bit. */
2782#define X86_FCW_PC_53 UINT16_C(0x0200)
2783/** Precision control: 64-bit. */
2784#define X86_FCW_PC_64 UINT16_C(0x0300)
2785/** Rounding control mask. */
2786#define X86_FCW_RC_MASK UINT16_C(0x0c00)
2787/** Rounding control: To nearest. */
2788#define X86_FCW_RC_NEAREST UINT16_C(0x0000)
2789/** Rounding control: Down. */
2790#define X86_FCW_RC_DOWN UINT16_C(0x0400)
2791/** Rounding control: Up. */
2792#define X86_FCW_RC_UP UINT16_C(0x0800)
2793/** Rounding control: Towards zero. */
2794#define X86_FCW_RC_ZERO UINT16_C(0x0c00)
2795/** Bits which should be zero, apparently. */
2796#define X86_FCW_ZERO_MASK UINT16_C(0xf080)
2797/** @} */
2798
2799/** @name SSE MXCSR
2800 * @{ */
2801/** Exception Flag: Invalid operation. */
2802#define X86_MXSCR_IE RT_BIT_32(0)
2803/** Exception Flag: Denormalized operand. */
2804#define X86_MXSCR_DE RT_BIT_32(1)
2805/** Exception Flag: Zero divide. */
2806#define X86_MXSCR_ZE RT_BIT_32(2)
2807/** Exception Flag: Overflow. */
2808#define X86_MXSCR_OE RT_BIT_32(3)
2809/** Exception Flag: Underflow. */
2810#define X86_MXSCR_UE RT_BIT_32(4)
2811/** Exception Flag: Precision. */
2812#define X86_MXSCR_PE RT_BIT_32(5)
2813
2814/** Denormals are zero. */
2815#define X86_MXSCR_DAZ RT_BIT_32(6)
2816
2817/** Exception Mask: Invalid operation. */
2818#define X86_MXSCR_IM RT_BIT_32(7)
2819/** Exception Mask: Denormalized operand. */
2820#define X86_MXSCR_DM RT_BIT_32(8)
2821/** Exception Mask: Zero divide. */
2822#define X86_MXSCR_ZM RT_BIT_32(9)
2823/** Exception Mask: Overflow. */
2824#define X86_MXSCR_OM RT_BIT_32(10)
2825/** Exception Mask: Underflow. */
2826#define X86_MXSCR_UM RT_BIT_32(11)
2827/** Exception Mask: Precision. */
2828#define X86_MXSCR_PM RT_BIT_32(12)
2829
2830/** Rounding control mask. */
2831#define X86_MXSCR_RC_MASK UINT16_C(0x6000)
2832/** Rounding control: To nearest. */
2833#define X86_MXSCR_RC_NEAREST UINT16_C(0x0000)
2834/** Rounding control: Down. */
2835#define X86_MXSCR_RC_DOWN UINT16_C(0x2000)
2836/** Rounding control: Up. */
2837#define X86_MXSCR_RC_UP UINT16_C(0x4000)
2838/** Rounding control: Towards zero. */
2839#define X86_MXSCR_RC_ZERO UINT16_C(0x6000)
2840
2841/** Flush-to-zero for masked underflow. */
2842#define X86_MXSCR_FZ RT_BIT_32(15)
2843
2844/** Misaligned Exception Mask (AMD MISALIGNSSE). */
2845#define X86_MXSCR_MM RT_BIT_32(17)
2846/** @} */
2847
2848/**
2849 * XSAVE header.
2850 */
2851typedef struct X86XSAVEHDR
2852{
2853 /** XTATE_BV - Bitmap indicating whether a component is in the state. */
2854 uint64_t bmXState;
2855 /** XCOMP_BC - Bitmap used by instructions applying structure compaction. */
2856 uint64_t bmXComp;
2857 /** Reserved for furture extensions, probably MBZ. */
2858 uint64_t au64Reserved[6];
2859} X86XSAVEHDR;
2860#ifndef VBOX_FOR_DTRACE_LIB
2861AssertCompileSize(X86XSAVEHDR, 64);
2862#endif
2863/** Pointer to an XSAVE header. */
2864typedef X86XSAVEHDR *PX86XSAVEHDR;
2865/** Pointer to a const XSAVE header. */
2866typedef X86XSAVEHDR const *PCX86XSAVEHDR;
2867
2868
2869/**
2870 * The high 128-bit YMM register state (XSAVE_C_YMM).
2871 * (The lower 128-bits being in X86FXSTATE.)
2872 */
2873typedef struct X86XSAVEYMMHI
2874{
2875 /** 16 registers in 64-bit mode, 8 in 32-bit mode. */
2876 X86XMMREG aYmmHi[16];
2877} X86XSAVEYMMHI;
2878#ifndef VBOX_FOR_DTRACE_LIB
2879AssertCompileSize(X86XSAVEYMMHI, 256);
2880#endif
2881/** Pointer to a high 128-bit YMM register state. */
2882typedef X86XSAVEYMMHI *PX86XSAVEYMMHI;
2883/** Pointer to a const high 128-bit YMM register state. */
2884typedef X86XSAVEYMMHI const *PCX86XSAVEYMMHI;
2885
2886/**
2887 * Intel MPX bound registers state (XSAVE_C_BNDREGS).
2888 */
2889typedef struct X86XSAVEBNDREGS
2890{
2891 /** Array of registers (BND0...BND3). */
2892 struct
2893 {
2894 /** Lower bound. */
2895 uint64_t uLowerBound;
2896 /** Upper bound. */
2897 uint64_t uUpperBound;
2898 } aRegs[4];
2899} X86XSAVEBNDREGS;
2900#ifndef VBOX_FOR_DTRACE_LIB
2901AssertCompileSize(X86XSAVEBNDREGS, 64);
2902#endif
2903/** Pointer to a MPX bound register state. */
2904typedef X86XSAVEBNDREGS *PX86XSAVEBNDREGS;
2905/** Pointer to a const MPX bound register state. */
2906typedef X86XSAVEBNDREGS const *PCX86XSAVEBNDREGS;
2907
2908/**
2909 * Intel MPX bound config and status register state (XSAVE_C_BNDCSR).
2910 */
2911typedef struct X86XSAVEBNDCFG
2912{
2913 uint64_t fConfig;
2914 uint64_t fStatus;
2915} X86XSAVEBNDCFG;
2916#ifndef VBOX_FOR_DTRACE_LIB
2917AssertCompileSize(X86XSAVEBNDCFG, 16);
2918#endif
2919/** Pointer to a MPX bound config and status register state. */
2920typedef X86XSAVEBNDCFG *PX86XSAVEBNDCFG;
2921/** Pointer to a const MPX bound config and status register state. */
2922typedef X86XSAVEBNDCFG *PCX86XSAVEBNDCFG;
2923
2924/**
2925 * AVX-512 opmask state (XSAVE_C_OPMASK).
2926 */
2927typedef struct X86XSAVEOPMASK
2928{
2929 /** The K0..K7 values. */
2930 uint64_t aKRegs[8];
2931} X86XSAVEOPMASK;
2932#ifndef VBOX_FOR_DTRACE_LIB
2933AssertCompileSize(X86XSAVEOPMASK, 64);
2934#endif
2935/** Pointer to a AVX-512 opmask state. */
2936typedef X86XSAVEOPMASK *PX86XSAVEOPMASK;
2937/** Pointer to a const AVX-512 opmask state. */
2938typedef X86XSAVEOPMASK const *PCX86XSAVEOPMASK;
2939
2940/**
2941 * ZMM0-15 upper 256 bits introduced in AVX-512 (XSAVE_C_ZMM_HI256).
2942 */
2943typedef struct X86XSAVEZMMHI256
2944{
2945 /** Upper 256-bits of ZMM0-15. */
2946 X86YMMREG aHi256Regs[16];
2947} X86XSAVEZMMHI256;
2948#ifndef VBOX_FOR_DTRACE_LIB
2949AssertCompileSize(X86XSAVEZMMHI256, 512);
2950#endif
2951/** Pointer to a state comprising the upper 256-bits of ZMM0-15. */
2952typedef X86XSAVEZMMHI256 *PX86XSAVEZMMHI256;
2953/** Pointer to a const state comprising the upper 256-bits of ZMM0-15. */
2954typedef X86XSAVEZMMHI256 const *PCX86XSAVEZMMHI256;
2955
2956/**
2957 * ZMM16-31 register state introduced in AVX-512 (XSAVE_C_ZMM_16HI).
2958 */
2959typedef struct X86XSAVEZMM16HI
2960{
2961 /** ZMM16 thru ZMM31. */
2962 X86ZMMREG aRegs[16];
2963} X86XSAVEZMM16HI;
2964#ifndef VBOX_FOR_DTRACE_LIB
2965AssertCompileSize(X86XSAVEZMM16HI, 1024);
2966#endif
2967/** Pointer to a state comprising ZMM16-32. */
2968typedef X86XSAVEZMM16HI *PX86XSAVEZMM16HI;
2969/** Pointer to a const state comprising ZMM16-32. */
2970typedef X86XSAVEZMM16HI const *PCX86XSAVEZMM16HI;
2971
2972/**
2973 * AMD Light weight profiling state (XSAVE_C_LWP).
2974 *
2975 * We probably won't play with this as AMD seems to be dropping from their "zen"
2976 * processor micro architecture.
2977 */
2978typedef struct X86XSAVELWP
2979{
2980 /** Details when needed. */
2981 uint64_t auLater[128/8];
2982} X86XSAVELWP;
2983#ifndef VBOX_FOR_DTRACE_LIB
2984AssertCompileSize(X86XSAVELWP, 128);
2985#endif
2986
2987
2988/**
2989 * x86 FPU/SSE/AVX/XXXX state.
2990 *
2991 * Please bump DBGFCORE_FMT_VERSION by 1 in dbgfcorefmt.h if you make any
2992 * changes to this structure.
2993 */
2994typedef struct X86XSAVEAREA
2995{
2996 /** The x87 and SSE region (or legacy region if you like). */
2997 X86FXSTATE x87;
2998 /** The XSAVE header. */
2999 X86XSAVEHDR Hdr;
3000 /** Beyond the header, there isn't really a fixed layout, but we can
3001 generally assume the YMM (AVX) register extensions are present and
3002 follows immediately. */
3003 union
3004 {
3005 /** This is a typical layout on intel CPUs (good for debuggers). */
3006 struct
3007 {
3008 X86XSAVEYMMHI YmmHi;
3009 X86XSAVEBNDREGS BndRegs;
3010 X86XSAVEBNDCFG BndCfg;
3011 uint8_t abFudgeToMatchDocs[0xB0];
3012 X86XSAVEOPMASK Opmask;
3013 X86XSAVEZMMHI256 ZmmHi256;
3014 X86XSAVEZMM16HI Zmm16Hi;
3015 } Intel;
3016
3017 /** This is a typical layout on AMD Bulldozer type CPUs (good for debuggers). */
3018 struct
3019 {
3020 X86XSAVEYMMHI YmmHi;
3021 X86XSAVELWP Lwp;
3022 } AmdBd;
3023
3024 /** To enbling static deployments that have a reasonable chance of working for
3025 * the next 3-6 CPU generations without running short on space, we allocate a
3026 * lot of extra space here, making the structure a round 8KB in size. This
3027 * leaves us 7616 bytes for extended state. The skylake xeons are likely to use
3028 * 2112 of these, leaving us with 5504 bytes for future Intel generations. */
3029 uint8_t ab[8192 - 512 - 64];
3030 } u;
3031} X86XSAVEAREA;
3032#ifndef VBOX_FOR_DTRACE_LIB
3033AssertCompileSize(X86XSAVEAREA, 8192);
3034AssertCompileMemberSize(X86XSAVEAREA, u.Intel, 0x840 /*2112 => total 0xa80 (2688) */);
3035AssertCompileMemberOffset(X86XSAVEAREA, Hdr, 0x200);
3036AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.YmmHi, 0x240);
3037AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.BndRegs, 0x340);
3038AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.BndCfg, 0x380);
3039AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.Opmask, 0x440 /* 1088 */);
3040AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.ZmmHi256, 0x480 /* 1152 */);
3041AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.Zmm16Hi, 0x680 /* 1664 */);
3042#endif
3043/** Pointer to a XSAVE area. */
3044typedef X86XSAVEAREA *PX86XSAVEAREA;
3045/** Pointer to a const XSAVE area. */
3046typedef X86XSAVEAREA const *PCX86XSAVEAREA;
3047
3048
3049/** @name XSAVE_C_XXX - XSAVE State Components Bits.
3050 * @{ */
3051/** Bit 0 - x87 - Legacy FPU state (bit number) */
3052#define XSAVE_C_X87_BIT 0
3053/** Bit 0 - x87 - Legacy FPU state. */
3054#define XSAVE_C_X87 RT_BIT_64(XSAVE_C_X87_BIT)
3055/** Bit 1 - SSE - 128-bit SSE state (bit number). */
3056#define XSAVE_C_SSE_BIT 1
3057/** Bit 1 - SSE - 128-bit SSE state. */
3058#define XSAVE_C_SSE RT_BIT_64(XSAVE_C_SSE_BIT)
3059/** Bit 2 - YMM_Hi128 - Upper 128 bits of YMM0-15 (AVX) (bit number). */
3060#define XSAVE_C_YMM_BIT 2
3061/** Bit 2 - YMM_Hi128 - Upper 128 bits of YMM0-15 (AVX). */
3062#define XSAVE_C_YMM RT_BIT_64(XSAVE_C_YMM_BIT)
3063/** Bit 3 - BNDREGS - MPX bound register state (bit number). */
3064#define XSAVE_C_BNDREGS_BIT 3
3065/** Bit 3 - BNDREGS - MPX bound register state. */
3066#define XSAVE_C_BNDREGS RT_BIT_64(XSAVE_C_BNDREGS_BIT)
3067/** Bit 4 - BNDCSR - MPX bound config and status state (bit number). */
3068#define XSAVE_C_BNDCSR_BIT 4
3069/** Bit 4 - BNDCSR - MPX bound config and status state. */
3070#define XSAVE_C_BNDCSR RT_BIT_64(XSAVE_C_BNDCSR_BIT)
3071/** Bit 5 - Opmask - opmask state (bit number). */
3072#define XSAVE_C_OPMASK_BIT 5
3073/** Bit 5 - Opmask - opmask state. */
3074#define XSAVE_C_OPMASK RT_BIT_64(XSAVE_C_OPMASK_BIT)
3075/** Bit 6 - ZMM_Hi256 - Upper 256 bits of ZMM0-15 (AVX-512) (bit number). */
3076#define XSAVE_C_ZMM_HI256_BIT 6
3077/** Bit 6 - ZMM_Hi256 - Upper 256 bits of ZMM0-15 (AVX-512). */
3078#define XSAVE_C_ZMM_HI256 RT_BIT_64(XSAVE_C_ZMM_HI256_BIT)
3079/** Bit 7 - Hi16_ZMM - 512-bits ZMM16-31 state (AVX-512) (bit number). */
3080#define XSAVE_C_ZMM_16HI_BIT 7
3081/** Bit 7 - Hi16_ZMM - 512-bits ZMM16-31 state (AVX-512). */
3082#define XSAVE_C_ZMM_16HI RT_BIT_64(XSAVE_C_ZMM_16HI_BIT)
3083/** Bit 9 - PKRU - Protection-key state (bit number). */
3084#define XSAVE_C_PKRU_BIT 9
3085/** Bit 9 - PKRU - Protection-key state. */
3086#define XSAVE_C_PKRU RT_BIT_64(XSAVE_C_PKRU_BIT)
3087/** Bit 62 - LWP - Lightweight Profiling (AMD) (bit number). */
3088#define XSAVE_C_LWP_BIT 62
3089/** Bit 62 - LWP - Lightweight Profiling (AMD). */
3090#define XSAVE_C_LWP RT_BIT_64(XSAVE_C_LWP_BIT)
3091/** @} */
3092
3093
3094
3095/** @name Selector Descriptor
3096 * @{
3097 */
3098
3099#ifndef VBOX_FOR_DTRACE_LIB
3100/**
3101 * Descriptor attributes (as seen by VT-x).
3102 */
3103typedef struct X86DESCATTRBITS
3104{
3105 /** 00 - Segment Type. */
3106 unsigned u4Type : 4;
3107 /** 04 - Descriptor Type. System(=0) or code/data selector */
3108 unsigned u1DescType : 1;
3109 /** 05 - Descriptor Privilege level. */
3110 unsigned u2Dpl : 2;
3111 /** 07 - Flags selector present(=1) or not. */
3112 unsigned u1Present : 1;
3113 /** 08 - Segment limit 16-19. */
3114 unsigned u4LimitHigh : 4;
3115 /** 0c - Available for system software. */
3116 unsigned u1Available : 1;
3117 /** 0d - 32 bits mode: Reserved - 0, long mode: Long Attribute Bit. */
3118 unsigned u1Long : 1;
3119 /** 0e - This flags meaning depends on the segment type. Try make sense out
3120 * of the intel manual yourself. */
3121 unsigned u1DefBig : 1;
3122 /** 0f - Granularity of the limit. If set 4KB granularity is used, if
3123 * clear byte. */
3124 unsigned u1Granularity : 1;
3125 /** 10 - "Unusable" selector, special Intel (VT-x only?) bit. */
3126 unsigned u1Unusable : 1;
3127} X86DESCATTRBITS;
3128#endif /* !VBOX_FOR_DTRACE_LIB */
3129
3130/** @name X86DESCATTR masks
3131 * @{ */
3132#define X86DESCATTR_TYPE UINT32_C(0x0000000f)
3133#define X86DESCATTR_DT UINT32_C(0x00000010)
3134#define X86DESCATTR_DPL UINT32_C(0x00000060)
3135#define X86DESCATTR_DPL_SHIFT 5 /**< Shift count for the DPL value. */
3136#define X86DESCATTR_P UINT32_C(0x00000080)
3137#define X86DESCATTR_LIMIT_HIGH UINT32_C(0x00000f00)
3138#define X86DESCATTR_AVL UINT32_C(0x00001000)
3139#define X86DESCATTR_L UINT32_C(0x00002000)
3140#define X86DESCATTR_D UINT32_C(0x00004000)
3141#define X86DESCATTR_G UINT32_C(0x00008000)
3142#define X86DESCATTR_UNUSABLE UINT32_C(0x00010000)
3143/** @} */
3144
3145#pragma pack(1)
3146typedef union X86DESCATTR
3147{
3148 /** Unsigned integer view. */
3149 uint32_t u;
3150#ifndef VBOX_FOR_DTRACE_LIB
3151 /** Normal view. */
3152 X86DESCATTRBITS n;
3153#endif
3154} X86DESCATTR;
3155#pragma pack()
3156/** Pointer to descriptor attributes. */
3157typedef X86DESCATTR *PX86DESCATTR;
3158/** Pointer to const descriptor attributes. */
3159typedef const X86DESCATTR *PCX86DESCATTR;
3160
3161#ifndef VBOX_FOR_DTRACE_LIB
3162
3163/**
3164 * Generic descriptor table entry
3165 */
3166#pragma pack(1)
3167typedef struct X86DESCGENERIC
3168{
3169 /** 00 - Limit - Low word. */
3170 unsigned u16LimitLow : 16;
3171 /** 10 - Base address - low word.
3172 * Don't try set this to 24 because MSC is doing stupid things then. */
3173 unsigned u16BaseLow : 16;
3174 /** 20 - Base address - first 8 bits of high word. */
3175 unsigned u8BaseHigh1 : 8;
3176 /** 28 - Segment Type. */
3177 unsigned u4Type : 4;
3178 /** 2c - Descriptor Type. System(=0) or code/data selector */
3179 unsigned u1DescType : 1;
3180 /** 2d - Descriptor Privilege level. */
3181 unsigned u2Dpl : 2;
3182 /** 2f - Flags selector present(=1) or not. */
3183 unsigned u1Present : 1;
3184 /** 30 - Segment limit 16-19. */
3185 unsigned u4LimitHigh : 4;
3186 /** 34 - Available for system software. */
3187 unsigned u1Available : 1;
3188 /** 35 - 32 bits mode: Reserved - 0, long mode: Long Attribute Bit. */
3189 unsigned u1Long : 1;
3190 /** 36 - This flags meaning depends on the segment type. Try make sense out
3191 * of the intel manual yourself. */
3192 unsigned u1DefBig : 1;
3193 /** 37 - Granularity of the limit. If set 4KB granularity is used, if
3194 * clear byte. */
3195 unsigned u1Granularity : 1;
3196 /** 38 - Base address - highest 8 bits. */
3197 unsigned u8BaseHigh2 : 8;
3198} X86DESCGENERIC;
3199#pragma pack()
3200/** Pointer to a generic descriptor entry. */
3201typedef X86DESCGENERIC *PX86DESCGENERIC;
3202/** Pointer to a const generic descriptor entry. */
3203typedef const X86DESCGENERIC *PCX86DESCGENERIC;
3204
3205/** @name Bit offsets of X86DESCGENERIC members.
3206 * @{*/
3207#define X86DESCGENERIC_BIT_OFF_LIMIT_LOW (0) /**< Bit offset of X86DESCGENERIC::u16LimitLow. */
3208#define X86DESCGENERIC_BIT_OFF_BASE_LOW (16) /**< Bit offset of X86DESCGENERIC::u16BaseLow. */
3209#define X86DESCGENERIC_BIT_OFF_BASE_HIGH1 (32) /**< Bit offset of X86DESCGENERIC::u8BaseHigh1. */
3210#define X86DESCGENERIC_BIT_OFF_TYPE (40) /**< Bit offset of X86DESCGENERIC::u4Type. */
3211#define X86DESCGENERIC_BIT_OFF_DESC_TYPE (44) /**< Bit offset of X86DESCGENERIC::u1DescType. */
3212#define X86DESCGENERIC_BIT_OFF_DPL (45) /**< Bit offset of X86DESCGENERIC::u2Dpl. */
3213#define X86DESCGENERIC_BIT_OFF_PRESENT (47) /**< Bit offset of X86DESCGENERIC::uu1Present. */
3214#define X86DESCGENERIC_BIT_OFF_LIMIT_HIGH (48) /**< Bit offset of X86DESCGENERIC::u4LimitHigh. */
3215#define X86DESCGENERIC_BIT_OFF_AVAILABLE (52) /**< Bit offset of X86DESCGENERIC::u1Available. */
3216#define X86DESCGENERIC_BIT_OFF_LONG (53) /**< Bit offset of X86DESCGENERIC::u1Long. */
3217#define X86DESCGENERIC_BIT_OFF_DEF_BIG (54) /**< Bit offset of X86DESCGENERIC::u1DefBig. */
3218#define X86DESCGENERIC_BIT_OFF_GRANULARITY (55) /**< Bit offset of X86DESCGENERIC::u1Granularity. */
3219#define X86DESCGENERIC_BIT_OFF_BASE_HIGH2 (56) /**< Bit offset of X86DESCGENERIC::u8BaseHigh2. */
3220/** @} */
3221
3222
3223/** @name LAR mask
3224 * @{ */
3225#define X86LAR_F_TYPE UINT16_C( 0x0f00)
3226#define X86LAR_F_DT UINT16_C( 0x1000)
3227#define X86LAR_F_DPL UINT16_C( 0x6000)
3228#define X86LAR_F_DPL_SHIFT 13 /**< Shift count for the DPL value. */
3229#define X86LAR_F_P UINT16_C( 0x8000)
3230#define X86LAR_F_AVL UINT32_C(0x00100000)
3231#define X86LAR_F_L UINT32_C(0x00200000)
3232#define X86LAR_F_D UINT32_C(0x00400000)
3233#define X86LAR_F_G UINT32_C(0x00800000)
3234/** @} */
3235
3236
3237/**
3238 * Call-, Interrupt-, Trap- or Task-gate descriptor (legacy).
3239 */
3240typedef struct X86DESCGATE
3241{
3242 /** 00 - Target code segment offset - Low word.
3243 * Ignored if task-gate. */
3244 unsigned u16OffsetLow : 16;
3245 /** 10 - Target code segment selector for call-, interrupt- and trap-gates,
3246 * TSS selector if task-gate. */
3247 unsigned u16Sel : 16;
3248 /** 20 - Number of parameters for a call-gate.
3249 * Ignored if interrupt-, trap- or task-gate. */
3250 unsigned u4ParmCount : 4;
3251 /** 24 - Reserved / ignored. */
3252 unsigned u4Reserved : 4;
3253 /** 28 - Segment Type. */
3254 unsigned u4Type : 4;
3255 /** 2c - Descriptor Type (0 = system). */
3256 unsigned u1DescType : 1;
3257 /** 2d - Descriptor Privilege level. */
3258 unsigned u2Dpl : 2;
3259 /** 2f - Flags selector present(=1) or not. */
3260 unsigned u1Present : 1;
3261 /** 30 - Target code segment offset - High word.
3262 * Ignored if task-gate. */
3263 unsigned u16OffsetHigh : 16;
3264} X86DESCGATE;
3265/** Pointer to a Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
3266typedef X86DESCGATE *PX86DESCGATE;
3267/** Pointer to a const Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
3268typedef const X86DESCGATE *PCX86DESCGATE;
3269
3270#endif /* VBOX_FOR_DTRACE_LIB */
3271
3272/**
3273 * Descriptor table entry.
3274 */
3275#pragma pack(1)
3276typedef union X86DESC
3277{
3278#ifndef VBOX_FOR_DTRACE_LIB
3279 /** Generic descriptor view. */
3280 X86DESCGENERIC Gen;
3281 /** Gate descriptor view. */
3282 X86DESCGATE Gate;
3283#endif
3284
3285 /** 8 bit unsigned integer view. */
3286 uint8_t au8[8];
3287 /** 16 bit unsigned integer view. */
3288 uint16_t au16[4];
3289 /** 32 bit unsigned integer view. */
3290 uint32_t au32[2];
3291 /** 64 bit unsigned integer view. */
3292 uint64_t au64[1];
3293 /** Unsigned integer view. */
3294 uint64_t u;
3295} X86DESC;
3296#ifndef VBOX_FOR_DTRACE_LIB
3297AssertCompileSize(X86DESC, 8);
3298#endif
3299#pragma pack()
3300/** Pointer to descriptor table entry. */
3301typedef X86DESC *PX86DESC;
3302/** Pointer to const descriptor table entry. */
3303typedef const X86DESC *PCX86DESC;
3304
3305/** @def X86DESC_BASE
3306 * Return the base address of a descriptor.
3307 */
3308#define X86DESC_BASE(a_pDesc) /*ASM-NOINC*/ \
3309 ( ((uint32_t)((a_pDesc)->Gen.u8BaseHigh2) << 24) \
3310 | ( (a_pDesc)->Gen.u8BaseHigh1 << 16) \
3311 | ( (a_pDesc)->Gen.u16BaseLow ) )
3312
3313/** @def X86DESC_LIMIT
3314 * Return the limit of a descriptor.
3315 */
3316#define X86DESC_LIMIT(a_pDesc) /*ASM-NOINC*/ \
3317 ( ((uint32_t)((a_pDesc)->Gen.u4LimitHigh) << 16) \
3318 | ( (a_pDesc)->Gen.u16LimitLow ) )
3319
3320/** @def X86DESC_LIMIT_G
3321 * Return the limit of a descriptor with the granularity bit taken into account.
3322 * @returns Selector limit (uint32_t).
3323 * @param a_pDesc Pointer to the descriptor.
3324 */
3325#define X86DESC_LIMIT_G(a_pDesc) /*ASM-NOINC*/ \
3326 ( (a_pDesc)->Gen.u1Granularity \
3327 ? ( ( ((uint32_t)(a_pDesc)->Gen.u4LimitHigh << 16) | (a_pDesc)->Gen.u16LimitLow ) << 12 ) | UINT32_C(0xfff) \
3328 : ((uint32_t)(a_pDesc)->Gen.u4LimitHigh << 16) | (a_pDesc)->Gen.u16LimitLow \
3329 )
3330
3331/** @def X86DESC_GET_HID_ATTR
3332 * Get the descriptor attributes for the hidden register.
3333 */
3334#define X86DESC_GET_HID_ATTR(a_pDesc) /*ASM-NOINC*/ \
3335 ( ((a_pDesc)->u >> (16+16+8)) & UINT32_C(0xf0ff) ) /** @todo do we have a define for 0xf0ff? */
3336
3337#ifndef VBOX_FOR_DTRACE_LIB
3338
3339/**
3340 * 64 bits generic descriptor table entry
3341 * Note: most of these bits have no meaning in long mode.
3342 */
3343#pragma pack(1)
3344typedef struct X86DESC64GENERIC
3345{
3346 /** Limit - Low word - *IGNORED*. */
3347 uint32_t u16LimitLow : 16;
3348 /** Base address - low word. - *IGNORED*
3349 * Don't try set this to 24 because MSC is doing stupid things then. */
3350 uint32_t u16BaseLow : 16;
3351 /** Base address - first 8 bits of high word. - *IGNORED* */
3352 uint32_t u8BaseHigh1 : 8;
3353 /** Segment Type. */
3354 uint32_t u4Type : 4;
3355 /** Descriptor Type. System(=0) or code/data selector */
3356 uint32_t u1DescType : 1;
3357 /** Descriptor Privilege level. */
3358 uint32_t u2Dpl : 2;
3359 /** Flags selector present(=1) or not. */
3360 uint32_t u1Present : 1;
3361 /** Segment limit 16-19. - *IGNORED* */
3362 uint32_t u4LimitHigh : 4;
3363 /** Available for system software. - *IGNORED* */
3364 uint32_t u1Available : 1;
3365 /** Long mode flag. */
3366 uint32_t u1Long : 1;
3367 /** This flags meaning depends on the segment type. Try make sense out
3368 * of the intel manual yourself. */
3369 uint32_t u1DefBig : 1;
3370 /** Granularity of the limit. If set 4KB granularity is used, if
3371 * clear byte. - *IGNORED* */
3372 uint32_t u1Granularity : 1;
3373 /** Base address - highest 8 bits. - *IGNORED* */
3374 uint32_t u8BaseHigh2 : 8;
3375 /** Base address - bits 63-32. */
3376 uint32_t u32BaseHigh3 : 32;
3377 uint32_t u8Reserved : 8;
3378 uint32_t u5Zeros : 5;
3379 uint32_t u19Reserved : 19;
3380} X86DESC64GENERIC;
3381#pragma pack()
3382/** Pointer to a generic descriptor entry. */
3383typedef X86DESC64GENERIC *PX86DESC64GENERIC;
3384/** Pointer to a const generic descriptor entry. */
3385typedef const X86DESC64GENERIC *PCX86DESC64GENERIC;
3386
3387/**
3388 * System descriptor table entry (64 bits)
3389 *
3390 * @remarks This is, save a couple of comments, identical to X86DESC64GENERIC...
3391 */
3392#pragma pack(1)
3393typedef struct X86DESC64SYSTEM
3394{
3395 /** Limit - Low word. */
3396 uint32_t u16LimitLow : 16;
3397 /** Base address - low word.
3398 * Don't try set this to 24 because MSC is doing stupid things then. */
3399 uint32_t u16BaseLow : 16;
3400 /** Base address - first 8 bits of high word. */
3401 uint32_t u8BaseHigh1 : 8;
3402 /** Segment Type. */
3403 uint32_t u4Type : 4;
3404 /** Descriptor Type. System(=0) or code/data selector */
3405 uint32_t u1DescType : 1;
3406 /** Descriptor Privilege level. */
3407 uint32_t u2Dpl : 2;
3408 /** Flags selector present(=1) or not. */
3409 uint32_t u1Present : 1;
3410 /** Segment limit 16-19. */
3411 uint32_t u4LimitHigh : 4;
3412 /** Available for system software. */
3413 uint32_t u1Available : 1;
3414 /** Reserved - 0. */
3415 uint32_t u1Reserved : 1;
3416 /** This flags meaning depends on the segment type. Try make sense out
3417 * of the intel manual yourself. */
3418 uint32_t u1DefBig : 1;
3419 /** Granularity of the limit. If set 4KB granularity is used, if
3420 * clear byte. */
3421 uint32_t u1Granularity : 1;
3422 /** Base address - bits 31-24. */
3423 uint32_t u8BaseHigh2 : 8;
3424 /** Base address - bits 63-32. */
3425 uint32_t u32BaseHigh3 : 32;
3426 uint32_t u8Reserved : 8;
3427 uint32_t u5Zeros : 5;
3428 uint32_t u19Reserved : 19;
3429} X86DESC64SYSTEM;
3430#pragma pack()
3431/** Pointer to a system descriptor entry. */
3432typedef X86DESC64SYSTEM *PX86DESC64SYSTEM;
3433/** Pointer to a const system descriptor entry. */
3434typedef const X86DESC64SYSTEM *PCX86DESC64SYSTEM;
3435
3436/**
3437 * Call-, Interrupt-, Trap- or Task-gate descriptor (64-bit).
3438 */
3439typedef struct X86DESC64GATE
3440{
3441 /** Target code segment offset - Low word. */
3442 uint32_t u16OffsetLow : 16;
3443 /** Target code segment selector. */
3444 uint32_t u16Sel : 16;
3445 /** Interrupt stack table for interrupt- and trap-gates.
3446 * Ignored by call-gates. */
3447 uint32_t u3IST : 3;
3448 /** Reserved / ignored. */
3449 uint32_t u5Reserved : 5;
3450 /** Segment Type. */
3451 uint32_t u4Type : 4;
3452 /** Descriptor Type (0 = system). */
3453 uint32_t u1DescType : 1;
3454 /** Descriptor Privilege level. */
3455 uint32_t u2Dpl : 2;
3456 /** Flags selector present(=1) or not. */
3457 uint32_t u1Present : 1;
3458 /** Target code segment offset - High word.
3459 * Ignored if task-gate. */
3460 uint32_t u16OffsetHigh : 16;
3461 /** Target code segment offset - Top dword.
3462 * Ignored if task-gate. */
3463 uint32_t u32OffsetTop : 32;
3464 /** Reserved / ignored / must be zero.
3465 * For call-gates bits 8 thru 12 must be zero, the other gates ignores this. */
3466 uint32_t u32Reserved : 32;
3467} X86DESC64GATE;
3468AssertCompileSize(X86DESC64GATE, 16);
3469/** Pointer to a Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
3470typedef X86DESC64GATE *PX86DESC64GATE;
3471/** Pointer to a const Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
3472typedef const X86DESC64GATE *PCX86DESC64GATE;
3473
3474#endif /* VBOX_FOR_DTRACE_LIB */
3475
3476/**
3477 * Descriptor table entry.
3478 */
3479#pragma pack(1)
3480typedef union X86DESC64
3481{
3482#ifndef VBOX_FOR_DTRACE_LIB
3483 /** Generic descriptor view. */
3484 X86DESC64GENERIC Gen;
3485 /** System descriptor view. */
3486 X86DESC64SYSTEM System;
3487 /** Gate descriptor view. */
3488 X86DESC64GATE Gate;
3489#endif
3490
3491 /** 8 bit unsigned integer view. */
3492 uint8_t au8[16];
3493 /** 16 bit unsigned integer view. */
3494 uint16_t au16[8];
3495 /** 32 bit unsigned integer view. */
3496 uint32_t au32[4];
3497 /** 64 bit unsigned integer view. */
3498 uint64_t au64[2];
3499} X86DESC64;
3500#ifndef VBOX_FOR_DTRACE_LIB
3501AssertCompileSize(X86DESC64, 16);
3502#endif
3503#pragma pack()
3504/** Pointer to descriptor table entry. */
3505typedef X86DESC64 *PX86DESC64;
3506/** Pointer to const descriptor table entry. */
3507typedef const X86DESC64 *PCX86DESC64;
3508
3509/** @def X86DESC64_BASE
3510 * Return the base of a 64-bit descriptor.
3511 */
3512#define X86DESC64_BASE(a_pDesc) /*ASM-NOINC*/ \
3513 ( ((uint64_t)((a_pDesc)->Gen.u32BaseHigh3) << 32) \
3514 | ((uint32_t)((a_pDesc)->Gen.u8BaseHigh2) << 24) \
3515 | ( (a_pDesc)->Gen.u8BaseHigh1 << 16) \
3516 | ( (a_pDesc)->Gen.u16BaseLow ) )
3517
3518
3519
3520/** @name Host system descriptor table entry - Use with care!
3521 * @{ */
3522/** Host system descriptor table entry. */
3523#if HC_ARCH_BITS == 64
3524typedef X86DESC64 X86DESCHC;
3525#else
3526typedef X86DESC X86DESCHC;
3527#endif
3528/** Pointer to a host system descriptor table entry. */
3529#if HC_ARCH_BITS == 64
3530typedef PX86DESC64 PX86DESCHC;
3531#else
3532typedef PX86DESC PX86DESCHC;
3533#endif
3534/** Pointer to a const host system descriptor table entry. */
3535#if HC_ARCH_BITS == 64
3536typedef PCX86DESC64 PCX86DESCHC;
3537#else
3538typedef PCX86DESC PCX86DESCHC;
3539#endif
3540/** @} */
3541
3542
3543/** @name Selector Descriptor Types.
3544 * @{
3545 */
3546
3547/** @name Non-System Selector Types.
3548 * @{ */
3549/** Code(=set)/Data(=clear) bit. */
3550#define X86_SEL_TYPE_CODE 8
3551/** Memory(=set)/System(=clear) bit. */
3552#define X86_SEL_TYPE_MEMORY RT_BIT_32(4)
3553/** Accessed bit. */
3554#define X86_SEL_TYPE_ACCESSED 1
3555/** Expand down bit (for data selectors only). */
3556#define X86_SEL_TYPE_DOWN 4
3557/** Conforming bit (for code selectors only). */
3558#define X86_SEL_TYPE_CONF 4
3559/** Write bit (for data selectors only). */
3560#define X86_SEL_TYPE_WRITE 2
3561/** Read bit (for code selectors only). */
3562#define X86_SEL_TYPE_READ 2
3563/** The bit number of the code segment read bit (relative to u4Type). */
3564#define X86_SEL_TYPE_READ_BIT 1
3565
3566/** Read only selector type. */
3567#define X86_SEL_TYPE_RO 0
3568/** Accessed read only selector type. */
3569#define X86_SEL_TYPE_RO_ACC (0 | X86_SEL_TYPE_ACCESSED)
3570/** Read write selector type. */
3571#define X86_SEL_TYPE_RW 2
3572/** Accessed read write selector type. */
3573#define X86_SEL_TYPE_RW_ACC (2 | X86_SEL_TYPE_ACCESSED)
3574/** Expand down read only selector type. */
3575#define X86_SEL_TYPE_RO_DOWN 4
3576/** Accessed expand down read only selector type. */
3577#define X86_SEL_TYPE_RO_DOWN_ACC (4 | X86_SEL_TYPE_ACCESSED)
3578/** Expand down read write selector type. */
3579#define X86_SEL_TYPE_RW_DOWN 6
3580/** Accessed expand down read write selector type. */
3581#define X86_SEL_TYPE_RW_DOWN_ACC (6 | X86_SEL_TYPE_ACCESSED)
3582/** Execute only selector type. */
3583#define X86_SEL_TYPE_EO (0 | X86_SEL_TYPE_CODE)
3584/** Accessed execute only selector type. */
3585#define X86_SEL_TYPE_EO_ACC (0 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
3586/** Execute and read selector type. */
3587#define X86_SEL_TYPE_ER (2 | X86_SEL_TYPE_CODE)
3588/** Accessed execute and read selector type. */
3589#define X86_SEL_TYPE_ER_ACC (2 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
3590/** Conforming execute only selector type. */
3591#define X86_SEL_TYPE_EO_CONF (4 | X86_SEL_TYPE_CODE)
3592/** Accessed Conforming execute only selector type. */
3593#define X86_SEL_TYPE_EO_CONF_ACC (4 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
3594/** Conforming execute and write selector type. */
3595#define X86_SEL_TYPE_ER_CONF (6 | X86_SEL_TYPE_CODE)
3596/** Accessed Conforming execute and write selector type. */
3597#define X86_SEL_TYPE_ER_CONF_ACC (6 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
3598/** @} */
3599
3600
3601/** @name System Selector Types.
3602 * @{ */
3603/** The TSS busy bit mask. */
3604#define X86_SEL_TYPE_SYS_TSS_BUSY_MASK 2
3605
3606/** Undefined system selector type. */
3607#define X86_SEL_TYPE_SYS_UNDEFINED 0
3608/** 286 TSS selector. */
3609#define X86_SEL_TYPE_SYS_286_TSS_AVAIL 1
3610/** LDT selector. */
3611#define X86_SEL_TYPE_SYS_LDT 2
3612/** 286 TSS selector - Busy. */
3613#define X86_SEL_TYPE_SYS_286_TSS_BUSY 3
3614/** 286 Callgate selector. */
3615#define X86_SEL_TYPE_SYS_286_CALL_GATE 4
3616/** Taskgate selector. */
3617#define X86_SEL_TYPE_SYS_TASK_GATE 5
3618/** 286 Interrupt gate selector. */
3619#define X86_SEL_TYPE_SYS_286_INT_GATE 6
3620/** 286 Trapgate selector. */
3621#define X86_SEL_TYPE_SYS_286_TRAP_GATE 7
3622/** Undefined system selector. */
3623#define X86_SEL_TYPE_SYS_UNDEFINED2 8
3624/** 386 TSS selector. */
3625#define X86_SEL_TYPE_SYS_386_TSS_AVAIL 9
3626/** Undefined system selector. */
3627#define X86_SEL_TYPE_SYS_UNDEFINED3 0xA
3628/** 386 TSS selector - Busy. */
3629#define X86_SEL_TYPE_SYS_386_TSS_BUSY 0xB
3630/** 386 Callgate selector. */
3631#define X86_SEL_TYPE_SYS_386_CALL_GATE 0xC
3632/** Undefined system selector. */
3633#define X86_SEL_TYPE_SYS_UNDEFINED4 0xD
3634/** 386 Interruptgate selector. */
3635#define X86_SEL_TYPE_SYS_386_INT_GATE 0xE
3636/** 386 Trapgate selector. */
3637#define X86_SEL_TYPE_SYS_386_TRAP_GATE 0xF
3638/** @} */
3639
3640/** @name AMD64 System Selector Types.
3641 * @{ */
3642/** LDT selector. */
3643#define AMD64_SEL_TYPE_SYS_LDT 2
3644/** TSS selector - Busy. */
3645#define AMD64_SEL_TYPE_SYS_TSS_AVAIL 9
3646/** TSS selector - Busy. */
3647#define AMD64_SEL_TYPE_SYS_TSS_BUSY 0xB
3648/** Callgate selector. */
3649#define AMD64_SEL_TYPE_SYS_CALL_GATE 0xC
3650/** Interruptgate selector. */
3651#define AMD64_SEL_TYPE_SYS_INT_GATE 0xE
3652/** Trapgate selector. */
3653#define AMD64_SEL_TYPE_SYS_TRAP_GATE 0xF
3654/** @} */
3655
3656/** @} */
3657
3658
3659/** @name Descriptor Table Entry Flag Masks.
3660 * These are for the 2nd 32-bit word of a descriptor.
3661 * @{ */
3662/** Bits 8-11 - TYPE - Descriptor type mask. */
3663#define X86_DESC_TYPE_MASK (RT_BIT_32(8) | RT_BIT_32(9) | RT_BIT_32(10) | RT_BIT_32(11))
3664/** Bit 12 - S - System (=0) or Code/Data (=1). */
3665#define X86_DESC_S RT_BIT_32(12)
3666/** Bits 13-14 - DPL - Descriptor Privilege Level. */
3667#define X86_DESC_DPL (RT_BIT_32(13) | RT_BIT_32(14))
3668/** Bit 15 - P - Present. */
3669#define X86_DESC_P RT_BIT_32(15)
3670/** Bit 20 - AVL - Available for system software. */
3671#define X86_DESC_AVL RT_BIT_32(20)
3672/** Bit 22 - DB - Default operation size. 0 = 16 bit, 1 = 32 bit. */
3673#define X86_DESC_DB RT_BIT_32(22)
3674/** Bit 23 - G - Granularity of the limit. If set 4KB granularity is
3675 * used, if clear byte. */
3676#define X86_DESC_G RT_BIT_32(23)
3677/** @} */
3678
3679/** @} */
3680
3681
3682/** @name Task Segments.
3683 * @{
3684 */
3685
3686/**
3687 * The minimum TSS descriptor limit for 286 tasks.
3688 */
3689#define X86_SEL_TYPE_SYS_286_TSS_LIMIT_MIN 0x2b
3690
3691/**
3692 * The minimum TSS descriptor segment limit for 386 tasks.
3693 */
3694#define X86_SEL_TYPE_SYS_386_TSS_LIMIT_MIN 0x67
3695
3696/**
3697 * 16-bit Task Segment (TSS).
3698 */
3699#pragma pack(1)
3700typedef struct X86TSS16
3701{
3702 /** Back link to previous task. (static) */
3703 RTSEL selPrev;
3704 /** Ring-0 stack pointer. (static) */
3705 uint16_t sp0;
3706 /** Ring-0 stack segment. (static) */
3707 RTSEL ss0;
3708 /** Ring-1 stack pointer. (static) */
3709 uint16_t sp1;
3710 /** Ring-1 stack segment. (static) */
3711 RTSEL ss1;
3712 /** Ring-2 stack pointer. (static) */
3713 uint16_t sp2;
3714 /** Ring-2 stack segment. (static) */
3715 RTSEL ss2;
3716 /** IP before task switch. */
3717 uint16_t ip;
3718 /** FLAGS before task switch. */
3719 uint16_t flags;
3720 /** AX before task switch. */
3721 uint16_t ax;
3722 /** CX before task switch. */
3723 uint16_t cx;
3724 /** DX before task switch. */
3725 uint16_t dx;
3726 /** BX before task switch. */
3727 uint16_t bx;
3728 /** SP before task switch. */
3729 uint16_t sp;
3730 /** BP before task switch. */
3731 uint16_t bp;
3732 /** SI before task switch. */
3733 uint16_t si;
3734 /** DI before task switch. */
3735 uint16_t di;
3736 /** ES before task switch. */
3737 RTSEL es;
3738 /** CS before task switch. */
3739 RTSEL cs;
3740 /** SS before task switch. */
3741 RTSEL ss;
3742 /** DS before task switch. */
3743 RTSEL ds;
3744 /** LDTR before task switch. */
3745 RTSEL selLdt;
3746} X86TSS16;
3747#ifndef VBOX_FOR_DTRACE_LIB
3748AssertCompileSize(X86TSS16, X86_SEL_TYPE_SYS_286_TSS_LIMIT_MIN + 1);
3749#endif
3750#pragma pack()
3751/** Pointer to a 16-bit task segment. */
3752typedef X86TSS16 *PX86TSS16;
3753/** Pointer to a const 16-bit task segment. */
3754typedef const X86TSS16 *PCX86TSS16;
3755
3756
3757/**
3758 * 32-bit Task Segment (TSS).
3759 */
3760#pragma pack(1)
3761typedef struct X86TSS32
3762{
3763 /** Back link to previous task. (static) */
3764 RTSEL selPrev;
3765 uint16_t padding1;
3766 /** Ring-0 stack pointer. (static) */
3767 uint32_t esp0;
3768 /** Ring-0 stack segment. (static) */
3769 RTSEL ss0;
3770 uint16_t padding_ss0;
3771 /** Ring-1 stack pointer. (static) */
3772 uint32_t esp1;
3773 /** Ring-1 stack segment. (static) */
3774 RTSEL ss1;
3775 uint16_t padding_ss1;
3776 /** Ring-2 stack pointer. (static) */
3777 uint32_t esp2;
3778 /** Ring-2 stack segment. (static) */
3779 RTSEL ss2;
3780 uint16_t padding_ss2;
3781 /** Page directory for the task. (static) */
3782 uint32_t cr3;
3783 /** EIP before task switch. */
3784 uint32_t eip;
3785 /** EFLAGS before task switch. */
3786 uint32_t eflags;
3787 /** EAX before task switch. */
3788 uint32_t eax;
3789 /** ECX before task switch. */
3790 uint32_t ecx;
3791 /** EDX before task switch. */
3792 uint32_t edx;
3793 /** EBX before task switch. */
3794 uint32_t ebx;
3795 /** ESP before task switch. */
3796 uint32_t esp;
3797 /** EBP before task switch. */
3798 uint32_t ebp;
3799 /** ESI before task switch. */
3800 uint32_t esi;
3801 /** EDI before task switch. */
3802 uint32_t edi;
3803 /** ES before task switch. */
3804 RTSEL es;
3805 uint16_t padding_es;
3806 /** CS before task switch. */
3807 RTSEL cs;
3808 uint16_t padding_cs;
3809 /** SS before task switch. */
3810 RTSEL ss;
3811 uint16_t padding_ss;
3812 /** DS before task switch. */
3813 RTSEL ds;
3814 uint16_t padding_ds;
3815 /** FS before task switch. */
3816 RTSEL fs;
3817 uint16_t padding_fs;
3818 /** GS before task switch. */
3819 RTSEL gs;
3820 uint16_t padding_gs;
3821 /** LDTR before task switch. */
3822 RTSEL selLdt;
3823 uint16_t padding_ldt;
3824 /** Debug trap flag */
3825 uint16_t fDebugTrap;
3826 /** Offset relative to the TSS of the start of the I/O Bitmap
3827 * and the end of the interrupt redirection bitmap. */
3828 uint16_t offIoBitmap;
3829} X86TSS32;
3830#pragma pack()
3831/** Pointer to task segment. */
3832typedef X86TSS32 *PX86TSS32;
3833/** Pointer to const task segment. */
3834typedef const X86TSS32 *PCX86TSS32;
3835#ifndef VBOX_FOR_DTRACE_LIB
3836AssertCompileSize(X86TSS32, X86_SEL_TYPE_SYS_386_TSS_LIMIT_MIN + 1);
3837AssertCompileMemberOffset(X86TSS32, cr3, 28);
3838AssertCompileMemberOffset(X86TSS32, offIoBitmap, 102);
3839#endif
3840
3841/**
3842 * 64-bit Task segment.
3843 */
3844#pragma pack(1)
3845typedef struct X86TSS64
3846{
3847 /** Reserved. */
3848 uint32_t u32Reserved;
3849 /** Ring-0 stack pointer. (static) */
3850 uint64_t rsp0;
3851 /** Ring-1 stack pointer. (static) */
3852 uint64_t rsp1;
3853 /** Ring-2 stack pointer. (static) */
3854 uint64_t rsp2;
3855 /** Reserved. */
3856 uint32_t u32Reserved2[2];
3857 /* IST */
3858 uint64_t ist1;
3859 uint64_t ist2;
3860 uint64_t ist3;
3861 uint64_t ist4;
3862 uint64_t ist5;
3863 uint64_t ist6;
3864 uint64_t ist7;
3865 /* Reserved. */
3866 uint16_t u16Reserved[5];
3867 /** Offset relative to the TSS of the start of the I/O Bitmap
3868 * and the end of the interrupt redirection bitmap. */
3869 uint16_t offIoBitmap;
3870} X86TSS64;
3871#pragma pack()
3872/** Pointer to a 64-bit task segment. */
3873typedef X86TSS64 *PX86TSS64;
3874/** Pointer to a const 64-bit task segment. */
3875typedef const X86TSS64 *PCX86TSS64;
3876#ifndef VBOX_FOR_DTRACE_LIB
3877AssertCompileSize(X86TSS64, X86_SEL_TYPE_SYS_386_TSS_LIMIT_MIN + 1);
3878#endif
3879
3880/** @} */
3881
3882
3883/** @name Selectors.
3884 * @{
3885 */
3886
3887/**
3888 * The shift used to convert a selector from and to index an index (C).
3889 */
3890#define X86_SEL_SHIFT 3
3891
3892/**
3893 * The mask used to mask off the table indicator and RPL of an selector.
3894 */
3895#define X86_SEL_MASK 0xfff8U
3896
3897/**
3898 * The mask used to mask off the RPL of an selector.
3899 * This is suitable for checking for NULL selectors.
3900 */
3901#define X86_SEL_MASK_OFF_RPL 0xfffcU
3902
3903/**
3904 * The bit indicating that a selector is in the LDT and not in the GDT.
3905 */
3906#define X86_SEL_LDT 0x0004U
3907
3908/**
3909 * The bit mask for getting the RPL of a selector.
3910 */
3911#define X86_SEL_RPL 0x0003U
3912
3913/**
3914 * The mask covering both RPL and LDT.
3915 * This is incidentally the same as sizeof(X86DESC) - 1, so good for limit
3916 * checks.
3917 */
3918#define X86_SEL_RPL_LDT 0x0007U
3919
3920/** @} */
3921
3922
3923/**
3924 * x86 Exceptions/Faults/Traps.
3925 */
3926typedef enum X86XCPT
3927{
3928 /** \#DE - Divide error. */
3929 X86_XCPT_DE = 0x00,
3930 /** \#DB - Debug event (single step, DRx, ..) */
3931 X86_XCPT_DB = 0x01,
3932 /** NMI - Non-Maskable Interrupt */
3933 X86_XCPT_NMI = 0x02,
3934 /** \#BP - Breakpoint (INT3). */
3935 X86_XCPT_BP = 0x03,
3936 /** \#OF - Overflow (INTO). */
3937 X86_XCPT_OF = 0x04,
3938 /** \#BR - Bound range exceeded (BOUND). */
3939 X86_XCPT_BR = 0x05,
3940 /** \#UD - Undefined opcode. */
3941 X86_XCPT_UD = 0x06,
3942 /** \#NM - Device not available (math coprocessor device). */
3943 X86_XCPT_NM = 0x07,
3944 /** \#DF - Double fault. */
3945 X86_XCPT_DF = 0x08,
3946 /** ??? - Coprocessor segment overrun (obsolete). */
3947 X86_XCPT_CO_SEG_OVERRUN = 0x09,
3948 /** \#TS - Taskswitch (TSS). */
3949 X86_XCPT_TS = 0x0a,
3950 /** \#NP - Segment no present. */
3951 X86_XCPT_NP = 0x0b,
3952 /** \#SS - Stack segment fault. */
3953 X86_XCPT_SS = 0x0c,
3954 /** \#GP - General protection fault. */
3955 X86_XCPT_GP = 0x0d,
3956 /** \#PF - Page fault. */
3957 X86_XCPT_PF = 0x0e,
3958 /* 0x0f is reserved (to avoid conflict with spurious interrupts in BIOS setup). */
3959 /** \#MF - Math fault (FPU). */
3960 X86_XCPT_MF = 0x10,
3961 /** \#AC - Alignment check. */
3962 X86_XCPT_AC = 0x11,
3963 /** \#MC - Machine check. */
3964 X86_XCPT_MC = 0x12,
3965 /** \#XF - SIMD Floating-Pointer Exception. */
3966 X86_XCPT_XF = 0x13,
3967 /** \#VE - Virtualization Exception. */
3968 X86_XCPT_VE = 0x14,
3969 /** \#SX - Security Exception. */
3970 X86_XCPT_SX = 0x1f
3971} X86XCPT;
3972/** Pointer to a x86 exception code. */
3973typedef X86XCPT *PX86XCPT;
3974/** Pointer to a const x86 exception code. */
3975typedef const X86XCPT *PCX86XCPT;
3976/** The maximum exception value. */
3977#define X86_XCPT_MAX (X86_XCPT_SX)
3978
3979
3980/** @name Trap Error Codes
3981 * @{
3982 */
3983/** External indicator. */
3984#define X86_TRAP_ERR_EXTERNAL 1
3985/** IDT indicator. */
3986#define X86_TRAP_ERR_IDT 2
3987/** Descriptor table indicator - If set LDT, if clear GDT. */
3988#define X86_TRAP_ERR_TI 4
3989/** Mask for getting the selector. */
3990#define X86_TRAP_ERR_SEL_MASK 0xfff8
3991/** Shift for getting the selector table index (C type index). */
3992#define X86_TRAP_ERR_SEL_SHIFT 3
3993/** @} */
3994
3995
3996/** @name \#PF Trap Error Codes
3997 * @{
3998 */
3999/** Bit 0 - P - Not present (clear) or page level protection (set) fault. */
4000#define X86_TRAP_PF_P RT_BIT_32(0)
4001/** Bit 1 - R/W - Read (clear) or write (set) access. */
4002#define X86_TRAP_PF_RW RT_BIT_32(1)
4003/** Bit 2 - U/S - CPU executing in user mode (set) or supervisor mode (clear). */
4004#define X86_TRAP_PF_US RT_BIT_32(2)
4005/** Bit 3 - RSVD- Reserved bit violation (set), i.e. reserved bit was set to 1. */
4006#define X86_TRAP_PF_RSVD RT_BIT_32(3)
4007/** Bit 4 - I/D - Instruction fetch (set) / Data access (clear) - PAE + NXE. */
4008#define X86_TRAP_PF_ID RT_BIT_32(4)
4009/** Bit 5 - PK - Protection-key violation (AMD64 mode only). */
4010#define X86_TRAP_PF_PK RT_BIT_32(5)
4011/** @} */
4012
4013#pragma pack(1)
4014/**
4015 * 16-bit IDTR.
4016 */
4017typedef struct X86IDTR16
4018{
4019 /** Offset. */
4020 uint16_t offSel;
4021 /** Selector. */
4022 uint16_t uSel;
4023} X86IDTR16, *PX86IDTR16;
4024#pragma pack()
4025
4026#pragma pack(1)
4027/**
4028 * 32-bit IDTR/GDTR.
4029 */
4030typedef struct X86XDTR32
4031{
4032 /** Size of the descriptor table. */
4033 uint16_t cb;
4034 /** Address of the descriptor table. */
4035#ifndef VBOX_FOR_DTRACE_LIB
4036 uint32_t uAddr;
4037#else
4038 uint16_t au16Addr[2];
4039#endif
4040} X86XDTR32, *PX86XDTR32;
4041#pragma pack()
4042
4043#pragma pack(1)
4044/**
4045 * 64-bit IDTR/GDTR.
4046 */
4047typedef struct X86XDTR64
4048{
4049 /** Size of the descriptor table. */
4050 uint16_t cb;
4051 /** Address of the descriptor table. */
4052#ifndef VBOX_FOR_DTRACE_LIB
4053 uint64_t uAddr;
4054#else
4055 uint16_t au16Addr[4];
4056#endif
4057} X86XDTR64, *PX86XDTR64;
4058#pragma pack()
4059
4060
4061/** @name ModR/M
4062 * @{ */
4063#define X86_MODRM_RM_MASK UINT8_C(0x07)
4064#define X86_MODRM_REG_MASK UINT8_C(0x38)
4065#define X86_MODRM_REG_SMASK UINT8_C(0x07)
4066#define X86_MODRM_REG_SHIFT 3
4067#define X86_MODRM_MOD_MASK UINT8_C(0xc0)
4068#define X86_MODRM_MOD_SMASK UINT8_C(0x03)
4069#define X86_MODRM_MOD_SHIFT 6
4070#ifndef VBOX_FOR_DTRACE_LIB
4071AssertCompile((X86_MODRM_RM_MASK | X86_MODRM_REG_MASK | X86_MODRM_MOD_MASK) == 0xff);
4072AssertCompile((X86_MODRM_REG_MASK >> X86_MODRM_REG_SHIFT) == X86_MODRM_REG_SMASK);
4073AssertCompile((X86_MODRM_MOD_MASK >> X86_MODRM_MOD_SHIFT) == X86_MODRM_MOD_SMASK);
4074#endif
4075/** @} */
4076
4077/** @name SIB
4078 * @{ */
4079#define X86_SIB_BASE_MASK UINT8_C(0x07)
4080#define X86_SIB_INDEX_MASK UINT8_C(0x38)
4081#define X86_SIB_INDEX_SMASK UINT8_C(0x07)
4082#define X86_SIB_INDEX_SHIFT 3
4083#define X86_SIB_SCALE_MASK UINT8_C(0xc0)
4084#define X86_SIB_SCALE_SMASK UINT8_C(0x03)
4085#define X86_SIB_SCALE_SHIFT 6
4086#ifndef VBOX_FOR_DTRACE_LIB
4087AssertCompile((X86_SIB_BASE_MASK | X86_SIB_INDEX_MASK | X86_SIB_SCALE_MASK) == 0xff);
4088AssertCompile((X86_SIB_INDEX_MASK >> X86_SIB_INDEX_SHIFT) == X86_SIB_INDEX_SMASK);
4089AssertCompile((X86_SIB_SCALE_MASK >> X86_SIB_SCALE_SHIFT) == X86_SIB_SCALE_SMASK);
4090#endif
4091/** @} */
4092
4093/** @name General register indexes
4094 * @{ */
4095#define X86_GREG_xAX 0
4096#define X86_GREG_xCX 1
4097#define X86_GREG_xDX 2
4098#define X86_GREG_xBX 3
4099#define X86_GREG_xSP 4
4100#define X86_GREG_xBP 5
4101#define X86_GREG_xSI 6
4102#define X86_GREG_xDI 7
4103#define X86_GREG_x8 8
4104#define X86_GREG_x9 9
4105#define X86_GREG_x10 10
4106#define X86_GREG_x11 11
4107#define X86_GREG_x12 12
4108#define X86_GREG_x13 13
4109#define X86_GREG_x14 14
4110#define X86_GREG_x15 15
4111/** @} */
4112
4113/** @name X86_SREG_XXX - Segment register indexes.
4114 * @{ */
4115#define X86_SREG_ES 0
4116#define X86_SREG_CS 1
4117#define X86_SREG_SS 2
4118#define X86_SREG_DS 3
4119#define X86_SREG_FS 4
4120#define X86_SREG_GS 5
4121/** @} */
4122/** Segment register count. */
4123#define X86_SREG_COUNT 6
4124
4125
4126/** @name X86_OP_XXX - Prefixes
4127 * @{ */
4128#define X86_OP_PRF_CS UINT8_C(0x2e)
4129#define X86_OP_PRF_SS UINT8_C(0x36)
4130#define X86_OP_PRF_DS UINT8_C(0x3e)
4131#define X86_OP_PRF_ES UINT8_C(0x26)
4132#define X86_OP_PRF_FS UINT8_C(0x64)
4133#define X86_OP_PRF_GS UINT8_C(0x65)
4134#define X86_OP_PRF_SIZE_OP UINT8_C(0x66)
4135#define X86_OP_PRF_SIZE_ADDR UINT8_C(0x67)
4136#define X86_OP_PRF_LOCK UINT8_C(0xf0)
4137#define X86_OP_PRF_REPZ UINT8_C(0xf2)
4138#define X86_OP_PRF_REPNZ UINT8_C(0xf3)
4139#define X86_OP_REX_B UINT8_C(0x41)
4140#define X86_OP_REX_X UINT8_C(0x42)
4141#define X86_OP_REX_R UINT8_C(0x44)
4142#define X86_OP_REX_W UINT8_C(0x48)
4143/** @} */
4144
4145
4146/** @} */
4147
4148#endif
4149
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette