VirtualBox

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

Last change on this file since 63356 was 62473, checked in by vboxsync, 8 years ago

(C) 2016

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 152.2 KB
Line 
1/** @file
2 * IPRT - X86 and AMD64 Structures and Definitions.
3 *
4 * @note x86.mac is generated from this file by running 'kmk incs' in the root.
5 */
6
7/*
8 * Copyright (C) 2006-2016 Oracle Corporation
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License (GPL) as published by the Free Software
14 * Foundation, in version 2 as it comes in the "COPYING" file of the
15 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17 *
18 * The contents of this file may alternatively be used under the terms
19 * of the Common Development and Distribution License Version 1.0
20 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
21 * VirtualBox OSE distribution, in which case the provisions of the
22 * CDDL are applicable instead of those of the GPL.
23 *
24 * You may elect to license modified versions of this file under the
25 * terms and conditions of either the GPL or the CDDL or both.
26 */
27
28#ifndef ___iprt_x86_h
29#define ___iprt_x86_h
30
31#ifndef VBOX_FOR_DTRACE_LIB
32# include <iprt/types.h>
33# include <iprt/assert.h>
34#else
35# pragma D depends_on library vbox-types.d
36#endif
37
38/* Workaround for Solaris sys/regset.h defining CS, DS */
39#ifdef RT_OS_SOLARIS
40# undef CS
41# undef DS
42#endif
43
44/** @defgroup grp_rt_x86 x86 Types and Definitions
45 * @ingroup grp_rt
46 * @{
47 */
48
49#ifndef VBOX_FOR_DTRACE_LIB
50/**
51 * EFLAGS Bits.
52 */
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 - Copy of CR4.OSXSAVE. */
457#define X86_CPUID_FEATURE_ECX_OSXSAVE RT_BIT_32(27)
458/** ECX Bit 28 - AVX. */
459#define X86_CPUID_FEATURE_ECX_AVX RT_BIT_32(28)
460/** ECX Bit 29 - F16C - Half-precision convert instruction support. */
461#define X86_CPUID_FEATURE_ECX_F16C RT_BIT_32(29)
462/** ECX Bit 30 - RDRAND instruction. */
463#define X86_CPUID_FEATURE_ECX_RDRAND RT_BIT_32(30)
464/** ECX Bit 31 - Hypervisor Present (software only). */
465#define X86_CPUID_FEATURE_ECX_HVP RT_BIT_32(31)
466
467
468/** Bit 0 - FPU - x87 FPU on Chip. */
469#define X86_CPUID_FEATURE_EDX_FPU RT_BIT_32(0)
470/** Bit 1 - VME - Virtual 8086 Mode Enhancements. */
471#define X86_CPUID_FEATURE_EDX_VME RT_BIT_32(1)
472/** Bit 2 - DE - Debugging extensions. */
473#define X86_CPUID_FEATURE_EDX_DE RT_BIT_32(2)
474/** Bit 3 - PSE - Page Size Extension. */
475#define X86_CPUID_FEATURE_EDX_PSE RT_BIT_32(3)
476#define X86_CPUID_FEATURE_EDX_PSE_BIT 3 /**< Bit number for X86_CPUID_FEATURE_EDX_PSE. */
477/** Bit 4 - TSC - Time Stamp Counter. */
478#define X86_CPUID_FEATURE_EDX_TSC RT_BIT_32(4)
479/** Bit 5 - MSR - Model Specific Registers RDMSR and WRMSR Instructions. */
480#define X86_CPUID_FEATURE_EDX_MSR RT_BIT_32(5)
481/** Bit 6 - PAE - Physical Address Extension. */
482#define X86_CPUID_FEATURE_EDX_PAE RT_BIT_32(6)
483#define X86_CPUID_FEATURE_EDX_PAE_BIT 6 /**< Bit number for X86_CPUID_FEATURE_EDX_PAE. */
484/** Bit 7 - MCE - Machine Check Exception. */
485#define X86_CPUID_FEATURE_EDX_MCE RT_BIT_32(7)
486/** Bit 8 - CX8 - CMPXCHG8B instruction. */
487#define X86_CPUID_FEATURE_EDX_CX8 RT_BIT_32(8)
488/** Bit 9 - APIC - APIC On-Chip. */
489#define X86_CPUID_FEATURE_EDX_APIC RT_BIT_32(9)
490/** Bit 11 - SEP - SYSENTER and SYSEXIT Present. */
491#define X86_CPUID_FEATURE_EDX_SEP RT_BIT_32(11)
492/** Bit 12 - MTRR - Memory Type Range Registers. */
493#define X86_CPUID_FEATURE_EDX_MTRR RT_BIT_32(12)
494/** Bit 13 - PGE - PTE Global Bit. */
495#define X86_CPUID_FEATURE_EDX_PGE RT_BIT_32(13)
496/** Bit 14 - MCA - Machine Check Architecture. */
497#define X86_CPUID_FEATURE_EDX_MCA RT_BIT_32(14)
498/** Bit 15 - CMOV - Conditional Move Instructions. */
499#define X86_CPUID_FEATURE_EDX_CMOV RT_BIT_32(15)
500/** Bit 16 - PAT - Page Attribute Table. */
501#define X86_CPUID_FEATURE_EDX_PAT RT_BIT_32(16)
502/** Bit 17 - PSE-36 - 36-bit Page Size Extension. */
503#define X86_CPUID_FEATURE_EDX_PSE36 RT_BIT_32(17)
504/** Bit 18 - PSN - Processor Serial Number. */
505#define X86_CPUID_FEATURE_EDX_PSN RT_BIT_32(18)
506/** Bit 19 - CLFSH - CLFLUSH Instruction. */
507#define X86_CPUID_FEATURE_EDX_CLFSH RT_BIT_32(19)
508/** Bit 21 - DS - Debug Store. */
509#define X86_CPUID_FEATURE_EDX_DS RT_BIT_32(21)
510/** Bit 22 - ACPI - Thermal Monitor and Software Controlled Clock Facilities. */
511#define X86_CPUID_FEATURE_EDX_ACPI RT_BIT_32(22)
512/** Bit 23 - MMX - Intel MMX Technology. */
513#define X86_CPUID_FEATURE_EDX_MMX RT_BIT_32(23)
514/** Bit 24 - FXSR - FXSAVE and FXRSTOR Instructions. */
515#define X86_CPUID_FEATURE_EDX_FXSR RT_BIT_32(24)
516/** Bit 25 - SSE - SSE Support. */
517#define X86_CPUID_FEATURE_EDX_SSE RT_BIT_32(25)
518/** Bit 26 - SSE2 - SSE2 Support. */
519#define X86_CPUID_FEATURE_EDX_SSE2 RT_BIT_32(26)
520/** Bit 27 - SS - Self Snoop. */
521#define X86_CPUID_FEATURE_EDX_SS RT_BIT_32(27)
522/** Bit 28 - HTT - Hyper-Threading Technology. */
523#define X86_CPUID_FEATURE_EDX_HTT RT_BIT_32(28)
524/** Bit 29 - TM - Therm. Monitor. */
525#define X86_CPUID_FEATURE_EDX_TM RT_BIT_32(29)
526/** Bit 31 - PBE - Pending Break Enabled. */
527#define X86_CPUID_FEATURE_EDX_PBE RT_BIT_32(31)
528/** @} */
529
530/** @name CPUID mwait/monitor information.
531 * CPUID query with EAX=5.
532 * @{
533 */
534/** ECX Bit 0 - MWAITEXT - Supports mwait/monitor extensions or not. */
535#define X86_CPUID_MWAIT_ECX_EXT RT_BIT_32(0)
536/** ECX Bit 1 - MWAITBREAK - Break mwait for external interrupt even if EFLAGS.IF=0. */
537#define X86_CPUID_MWAIT_ECX_BREAKIRQIF0 RT_BIT_32(1)
538/** @} */
539
540
541/** @name CPUID Structured Extended Feature information.
542 * CPUID query with EAX=7.
543 * @{
544 */
545/** EBX Bit 0 - FSGSBASE - Supports RDFSBASE/RDGSBASE/WRFSBASE/WRGSBASE. */
546#define X86_CPUID_STEXT_FEATURE_EBX_FSGSBASE RT_BIT_32(0)
547/** EBX Bit 1 - TSCADJUST - Supports MSR_IA32_TSC_ADJUST. */
548#define X86_CPUID_STEXT_FEATURE_EBX_TSC_ADJUST RT_BIT_32(1)
549/** EBX Bit 2 - SGX - Supports Software Guard Extensions . */
550#define X86_CPUID_STEXT_FEATURE_EBX_SGX RT_BIT_32(2)
551/** EBX Bit 3 - BMI1 - Advanced Bit Manipulation extension 1. */
552#define X86_CPUID_STEXT_FEATURE_EBX_BMI1 RT_BIT_32(3)
553/** EBX Bit 4 - HLE - Hardware Lock Elision. */
554#define X86_CPUID_STEXT_FEATURE_EBX_HLE RT_BIT_32(4)
555/** EBX Bit 5 - AVX2 - Advanced Vector Extensions 2. */
556#define X86_CPUID_STEXT_FEATURE_EBX_AVX2 RT_BIT_32(5)
557/** EBX Bit 6 - FDP_EXCPTN_ONLY - FPU data pointer only updated on exceptions if set. */
558#define X86_CPUID_STEXT_FEATURE_EBX_FDP_EXCPTN_ONLY RT_BIT_32(6)
559/** EBX Bit 7 - SMEP - Supervisor Mode Execution Prevention. */
560#define X86_CPUID_STEXT_FEATURE_EBX_SMEP RT_BIT_32(7)
561/** EBX Bit 8 - BMI2 - Advanced Bit Manipulation extension 2. */
562#define X86_CPUID_STEXT_FEATURE_EBX_BMI2 RT_BIT_32(8)
563/** EBX Bit 9 - ERMS - Supports Enhanced REP MOVSB/STOSB. */
564#define X86_CPUID_STEXT_FEATURE_EBX_ERMS RT_BIT_32(9)
565/** EBX Bit 10 - INVPCID - Supports INVPCID. */
566#define X86_CPUID_STEXT_FEATURE_EBX_INVPCID RT_BIT_32(10)
567/** EBX Bit 11 - RTM - Supports Restricted Transactional Memory. */
568#define X86_CPUID_STEXT_FEATURE_EBX_RTM RT_BIT_32(11)
569/** EBX Bit 12 - PQM - Supports Platform Quality of Service Monitoring. */
570#define X86_CPUID_STEXT_FEATURE_EBX_PQM RT_BIT_32(12)
571/** EBX Bit 13 - DEPFPU_CS_DS - Deprecates FPU CS, FPU DS values if set. */
572#define X86_CPUID_STEXT_FEATURE_EBX_DEPR_FPU_CS_DS RT_BIT_32(13)
573/** EBX Bit 14 - MPE - Supports Intel Memory Protection Extensions. */
574#define X86_CPUID_STEXT_FEATURE_EBX_MPE RT_BIT_32(14)
575/** EBX Bit 15 - PQE - Supports Platform Quality of Service Enforcement. */
576#define X86_CPUID_STEXT_FEATURE_EBX_PQE RT_BIT_32(15)
577/** EBX Bit 16 - AVX512F - Supports AVX512F. */
578#define X86_CPUID_STEXT_FEATURE_EBX_AVX512F RT_BIT_32(16)
579/** EBX Bit 18 - RDSEED - Supports RDSEED. */
580#define X86_CPUID_STEXT_FEATURE_EBX_RDSEED RT_BIT_32(18)
581/** EBX Bit 19 - ADX - Supports ADCX/ADOX. */
582#define X86_CPUID_STEXT_FEATURE_EBX_ADX RT_BIT_32(19)
583/** EBX Bit 20 - SMAP - Supports Supervisor Mode Access Prevention. */
584#define X86_CPUID_STEXT_FEATURE_EBX_SMAP RT_BIT_32(20)
585/** EBX Bit 23 - CLFLUSHOPT - Supports CLFLUSHOPT (Cache Line Flush). */
586#define X86_CPUID_STEXT_FEATURE_EBX_CLFLUSHOPT RT_BIT_32(23)
587/** EBX Bit 25 - INTEL_PT - Supports Intel Processor Trace. */
588#define X86_CPUID_STEXT_FEATURE_EBX_INTEL_PT RT_BIT_32(25)
589/** EBX Bit 26 - AVX512PF - Supports AVX512PF. */
590#define X86_CPUID_STEXT_FEATURE_EBX_AVX512PF RT_BIT_32(26)
591/** EBX Bit 27 - AVX512ER - Supports AVX512ER. */
592#define X86_CPUID_STEXT_FEATURE_EBX_AVX512ER RT_BIT_32(27)
593/** EBX Bit 28 - AVX512CD - Supports AVX512CD. */
594#define X86_CPUID_STEXT_FEATURE_EBX_AVX512CD RT_BIT_32(28)
595/** EBX Bit 29 - SHA - Supports Secure Hash Algorithm extensions. */
596#define X86_CPUID_STEXT_FEATURE_EBX_SHA RT_BIT_32(29)
597
598/** ECX Bit 0 - PREFETCHWT1 - Supports the PREFETCHWT1 instruction. */
599#define X86_CPUID_STEXT_FEATURE_ECX_PREFETCHWT1 RT_BIT_32(0)
600/** @} */
601
602
603/** @name CPUID Extended Feature information.
604 * CPUID query with EAX=0x80000001.
605 * @{
606 */
607/** ECX Bit 0 - LAHF/SAHF support in 64-bit mode. */
608#define X86_CPUID_EXT_FEATURE_ECX_LAHF_SAHF RT_BIT_32(0)
609
610/** EDX Bit 11 - SYSCALL/SYSRET. */
611#define X86_CPUID_EXT_FEATURE_EDX_SYSCALL RT_BIT_32(11)
612/** EDX Bit 20 - No-Execute/Execute-Disable. */
613#define X86_CPUID_EXT_FEATURE_EDX_NX RT_BIT_32(20)
614/** EDX Bit 26 - 1 GB large page. */
615#define X86_CPUID_EXT_FEATURE_EDX_PAGE1GB RT_BIT_32(26)
616/** EDX Bit 27 - RDTSCP. */
617#define X86_CPUID_EXT_FEATURE_EDX_RDTSCP RT_BIT_32(27)
618/** EDX Bit 29 - AMD Long Mode/Intel-64 Instructions. */
619#define X86_CPUID_EXT_FEATURE_EDX_LONG_MODE RT_BIT_32(29)
620/** @}*/
621
622/** @name CPUID AMD Feature information.
623 * CPUID query with EAX=0x80000001.
624 * @{
625 */
626/** Bit 0 - FPU - x87 FPU on Chip. */
627#define X86_CPUID_AMD_FEATURE_EDX_FPU RT_BIT_32(0)
628/** Bit 1 - VME - Virtual 8086 Mode Enhancements. */
629#define X86_CPUID_AMD_FEATURE_EDX_VME RT_BIT_32(1)
630/** Bit 2 - DE - Debugging extensions. */
631#define X86_CPUID_AMD_FEATURE_EDX_DE RT_BIT_32(2)
632/** Bit 3 - PSE - Page Size Extension. */
633#define X86_CPUID_AMD_FEATURE_EDX_PSE RT_BIT_32(3)
634/** Bit 4 - TSC - Time Stamp Counter. */
635#define X86_CPUID_AMD_FEATURE_EDX_TSC RT_BIT_32(4)
636/** Bit 5 - MSR - K86 Model Specific Registers RDMSR and WRMSR Instructions. */
637#define X86_CPUID_AMD_FEATURE_EDX_MSR RT_BIT_32(5)
638/** Bit 6 - PAE - Physical Address Extension. */
639#define X86_CPUID_AMD_FEATURE_EDX_PAE RT_BIT_32(6)
640/** Bit 7 - MCE - Machine Check Exception. */
641#define X86_CPUID_AMD_FEATURE_EDX_MCE RT_BIT_32(7)
642/** Bit 8 - CX8 - CMPXCHG8B instruction. */
643#define X86_CPUID_AMD_FEATURE_EDX_CX8 RT_BIT_32(8)
644/** Bit 9 - APIC - APIC On-Chip. */
645#define X86_CPUID_AMD_FEATURE_EDX_APIC RT_BIT_32(9)
646/** Bit 12 - MTRR - Memory Type Range Registers. */
647#define X86_CPUID_AMD_FEATURE_EDX_MTRR RT_BIT_32(12)
648/** Bit 13 - PGE - PTE Global Bit. */
649#define X86_CPUID_AMD_FEATURE_EDX_PGE RT_BIT_32(13)
650/** Bit 14 - MCA - Machine Check Architecture. */
651#define X86_CPUID_AMD_FEATURE_EDX_MCA RT_BIT_32(14)
652/** Bit 15 - CMOV - Conditional Move Instructions. */
653#define X86_CPUID_AMD_FEATURE_EDX_CMOV RT_BIT_32(15)
654/** Bit 16 - PAT - Page Attribute Table. */
655#define X86_CPUID_AMD_FEATURE_EDX_PAT RT_BIT_32(16)
656/** Bit 17 - PSE-36 - 36-bit Page Size Extension. */
657#define X86_CPUID_AMD_FEATURE_EDX_PSE36 RT_BIT_32(17)
658/** Bit 22 - AXMMX - AMD Extensions to MMX Instructions. */
659#define X86_CPUID_AMD_FEATURE_EDX_AXMMX RT_BIT_32(22)
660/** Bit 23 - MMX - Intel MMX Technology. */
661#define X86_CPUID_AMD_FEATURE_EDX_MMX RT_BIT_32(23)
662/** Bit 24 - FXSR - FXSAVE and FXRSTOR Instructions. */
663#define X86_CPUID_AMD_FEATURE_EDX_FXSR RT_BIT_32(24)
664/** Bit 25 - FFXSR - AMD fast FXSAVE and FXRSTOR Instructions. */
665#define X86_CPUID_AMD_FEATURE_EDX_FFXSR RT_BIT_32(25)
666/** Bit 30 - 3DNOWEXT - AMD Extensions to 3DNow. */
667#define X86_CPUID_AMD_FEATURE_EDX_3DNOW_EX RT_BIT_32(30)
668/** Bit 31 - 3DNOW - AMD 3DNow. */
669#define X86_CPUID_AMD_FEATURE_EDX_3DNOW RT_BIT_32(31)
670
671/** Bit 1 - CmpLegacy - Core multi-processing legacy mode. */
672#define X86_CPUID_AMD_FEATURE_ECX_CMPL RT_BIT_32(1)
673/** Bit 2 - SVM - AMD VM extensions. */
674#define X86_CPUID_AMD_FEATURE_ECX_SVM RT_BIT_32(2)
675/** Bit 3 - EXTAPIC - AMD extended APIC registers starting at 0x400. */
676#define X86_CPUID_AMD_FEATURE_ECX_EXT_APIC RT_BIT_32(3)
677/** Bit 4 - CR8L - AMD LOCK MOV CR0 means MOV CR8. */
678#define X86_CPUID_AMD_FEATURE_ECX_CR8L RT_BIT_32(4)
679/** Bit 5 - ABM - AMD Advanced bit manipulation. LZCNT instruction support. */
680#define X86_CPUID_AMD_FEATURE_ECX_ABM RT_BIT_32(5)
681/** Bit 6 - SSE4A - AMD EXTRQ, INSERTQ, MOVNTSS, and MOVNTSD instruction support. */
682#define X86_CPUID_AMD_FEATURE_ECX_SSE4A RT_BIT_32(6)
683/** Bit 7 - MISALIGNSSE - AMD Misaligned SSE mode. */
684#define X86_CPUID_AMD_FEATURE_ECX_MISALNSSE RT_BIT_32(7)
685/** Bit 8 - 3DNOWPRF - AMD PREFETCH and PREFETCHW instruction support. */
686#define X86_CPUID_AMD_FEATURE_ECX_3DNOWPRF RT_BIT_32(8)
687/** Bit 9 - OSVW - AMD OS visible workaround. */
688#define X86_CPUID_AMD_FEATURE_ECX_OSVW RT_BIT_32(9)
689/** Bit 10 - IBS - Instruct based sampling. */
690#define X86_CPUID_AMD_FEATURE_ECX_IBS RT_BIT_32(10)
691/** Bit 11 - XOP - Extended operation support (see APM6). */
692#define X86_CPUID_AMD_FEATURE_ECX_XOP RT_BIT_32(11)
693/** Bit 12 - SKINIT - AMD SKINIT: SKINIT, STGI, and DEV support. */
694#define X86_CPUID_AMD_FEATURE_ECX_SKINIT RT_BIT_32(12)
695/** Bit 13 - WDT - AMD Watchdog timer support. */
696#define X86_CPUID_AMD_FEATURE_ECX_WDT RT_BIT_32(13)
697/** Bit 15 - LWP - Lightweight profiling support. */
698#define X86_CPUID_AMD_FEATURE_ECX_LWP RT_BIT_32(15)
699/** Bit 16 - FMA4 - Four operand FMA instruction support. */
700#define X86_CPUID_AMD_FEATURE_ECX_FMA4 RT_BIT_32(16)
701/** Bit 19 - NodeId - Indicates support for
702 * MSR_C001_100C[NodeId,NodesPerProcessr]. */
703#define X86_CPUID_AMD_FEATURE_ECX_NODEID RT_BIT_32(19)
704/** Bit 21 - TBM - Trailing bit manipulation instruction support. */
705#define X86_CPUID_AMD_FEATURE_ECX_TBM RT_BIT_32(21)
706/** Bit 22 - TopologyExtensions - . */
707#define X86_CPUID_AMD_FEATURE_ECX_TOPOEXT RT_BIT_32(22)
708/** @} */
709
710
711/** @name CPUID AMD Feature information.
712 * CPUID query with EAX=0x80000007.
713 * @{
714 */
715/** Bit 0 - TS - Temperature Sensor. */
716#define X86_CPUID_AMD_ADVPOWER_EDX_TS RT_BIT_32(0)
717/** Bit 1 - FID - Frequency ID Control. */
718#define X86_CPUID_AMD_ADVPOWER_EDX_FID RT_BIT_32(1)
719/** Bit 2 - VID - Voltage ID Control. */
720#define X86_CPUID_AMD_ADVPOWER_EDX_VID RT_BIT_32(2)
721/** Bit 3 - TTP - THERMTRIP. */
722#define X86_CPUID_AMD_ADVPOWER_EDX_TTP RT_BIT_32(3)
723/** Bit 4 - TM - Hardware Thermal Control. */
724#define X86_CPUID_AMD_ADVPOWER_EDX_TM RT_BIT_32(4)
725/** Bit 5 - STC - Software Thermal Control. */
726#define X86_CPUID_AMD_ADVPOWER_EDX_STC RT_BIT_32(5)
727/** Bit 6 - MC - 100 Mhz Multiplier Control. */
728#define X86_CPUID_AMD_ADVPOWER_EDX_MC RT_BIT_32(6)
729/** Bit 7 - HWPSTATE - Hardware P-State Control. */
730#define X86_CPUID_AMD_ADVPOWER_EDX_HWPSTATE RT_BIT_32(7)
731/** Bit 8 - TSCINVAR - TSC Invariant. */
732#define X86_CPUID_AMD_ADVPOWER_EDX_TSCINVAR RT_BIT_32(8)
733/** Bit 9 - CPB - TSC Invariant. */
734#define X86_CPUID_AMD_ADVPOWER_EDX_CPB RT_BIT_32(9)
735/** Bit 10 - EffFreqRO - MPERF/APERF. */
736#define X86_CPUID_AMD_ADVPOWER_EDX_EFRO RT_BIT_32(10)
737/** Bit 11 - PFI - Processor feedback interface (see EAX). */
738#define X86_CPUID_AMD_ADVPOWER_EDX_PFI RT_BIT_32(11)
739/** Bit 12 - PA - Processor accumulator (MSR c001_007a). */
740#define X86_CPUID_AMD_ADVPOWER_EDX_PA RT_BIT_32(12)
741/** @} */
742
743
744/** @name CR0
745 * @remarks The 286 (MSW), 386 and 486 ignores attempts at setting
746 * reserved flags.
747 * @{ */
748/** Bit 0 - PE - Protection Enabled */
749#define X86_CR0_PE RT_BIT_32(0)
750#define X86_CR0_PROTECTION_ENABLE RT_BIT_32(0)
751/** Bit 1 - MP - Monitor Coprocessor */
752#define X86_CR0_MP RT_BIT_32(1)
753#define X86_CR0_MONITOR_COPROCESSOR RT_BIT_32(1)
754/** Bit 2 - EM - Emulation. */
755#define X86_CR0_EM RT_BIT_32(2)
756#define X86_CR0_EMULATE_FPU RT_BIT_32(2)
757/** Bit 3 - TS - Task Switch. */
758#define X86_CR0_TS RT_BIT_32(3)
759#define X86_CR0_TASK_SWITCH RT_BIT_32(3)
760/** Bit 4 - ET - Extension flag. (386, 'hardcoded' to 1 on 486+) */
761#define X86_CR0_ET RT_BIT_32(4)
762#define X86_CR0_EXTENSION_TYPE RT_BIT_32(4)
763/** Bit 5 - NE - Numeric error (486+). */
764#define X86_CR0_NE RT_BIT_32(5)
765#define X86_CR0_NUMERIC_ERROR RT_BIT_32(5)
766/** Bit 16 - WP - Write Protect (486+). */
767#define X86_CR0_WP RT_BIT_32(16)
768#define X86_CR0_WRITE_PROTECT RT_BIT_32(16)
769/** Bit 18 - AM - Alignment Mask (486+). */
770#define X86_CR0_AM RT_BIT_32(18)
771#define X86_CR0_ALIGMENT_MASK RT_BIT_32(18)
772/** Bit 29 - NW - Not Write-though (486+). */
773#define X86_CR0_NW RT_BIT_32(29)
774#define X86_CR0_NOT_WRITE_THROUGH RT_BIT_32(29)
775/** Bit 30 - WP - Cache Disable (486+). */
776#define X86_CR0_CD RT_BIT_32(30)
777#define X86_CR0_CACHE_DISABLE RT_BIT_32(30)
778/** Bit 31 - PG - Paging. */
779#define X86_CR0_PG RT_BIT_32(31)
780#define X86_CR0_PAGING RT_BIT_32(31)
781/** @} */
782
783
784/** @name CR3
785 * @{ */
786/** Bit 3 - PWT - Page-level Writes Transparent. */
787#define X86_CR3_PWT RT_BIT_32(3)
788/** Bit 4 - PCD - Page-level Cache Disable. */
789#define X86_CR3_PCD RT_BIT_32(4)
790/** Bits 12-31 - - Page directory page number. */
791#define X86_CR3_PAGE_MASK (0xfffff000)
792/** Bits 5-31 - - PAE Page directory page number. */
793#define X86_CR3_PAE_PAGE_MASK (0xffffffe0)
794/** Bits 12-51 - - AMD64 Page directory page number. */
795#define X86_CR3_AMD64_PAGE_MASK UINT64_C(0x000ffffffffff000)
796/** @} */
797
798
799/** @name CR4
800 * @{ */
801/** Bit 0 - VME - Virtual-8086 Mode Extensions. */
802#define X86_CR4_VME RT_BIT_32(0)
803/** Bit 1 - PVI - Protected-Mode Virtual Interrupts. */
804#define X86_CR4_PVI RT_BIT_32(1)
805/** Bit 2 - TSD - Time Stamp Disable. */
806#define X86_CR4_TSD RT_BIT_32(2)
807/** Bit 3 - DE - Debugging Extensions. */
808#define X86_CR4_DE RT_BIT_32(3)
809/** Bit 4 - PSE - Page Size Extension. */
810#define X86_CR4_PSE RT_BIT_32(4)
811/** Bit 5 - PAE - Physical Address Extension. */
812#define X86_CR4_PAE RT_BIT_32(5)
813/** Bit 6 - MCE - Machine-Check Enable. */
814#define X86_CR4_MCE RT_BIT_32(6)
815/** Bit 7 - PGE - Page Global Enable. */
816#define X86_CR4_PGE RT_BIT_32(7)
817/** Bit 8 - PCE - Performance-Monitoring Counter Enable. */
818#define X86_CR4_PCE RT_BIT_32(8)
819/** Bit 9 - OSFXSR - Operating System Support for FXSAVE and FXRSTORE instructions. */
820#define X86_CR4_OSFXSR RT_BIT_32(9)
821/** Bit 10 - OSXMMEEXCPT - Operating System Support for Unmasked SIMD Floating-Point Exceptions. */
822#define X86_CR4_OSXMMEEXCPT RT_BIT_32(10)
823/** Bit 13 - VMXE - VMX mode is enabled. */
824#define X86_CR4_VMXE RT_BIT_32(13)
825/** Bit 14 - SMXE - Safer Mode Extensions Enabled. */
826#define X86_CR4_SMXE RT_BIT_32(14)
827/** Bit 17 - PCIDE - Process-Context Identifiers Enabled. */
828#define X86_CR4_PCIDE RT_BIT_32(17)
829/** Bit 18 - OSXSAVE - Operating System Support for XSAVE and processor
830 * extended states. */
831#define X86_CR4_OSXSAVE RT_BIT_32(18)
832/** Bit 20 - SMEP - Supervisor-mode Execution Prevention enabled. */
833#define X86_CR4_SMEP RT_BIT_32(20)
834/** Bit 21 - SMAP - Supervisor-mode Access Prevention enabled. */
835#define X86_CR4_SMAP RT_BIT_32(21)
836/** Bit 22 - PKE - Protection Key Enable. */
837#define X86_CR4_PKE RT_BIT_32(22)
838/** @} */
839
840
841/** @name DR6
842 * @{ */
843/** Bit 0 - B0 - Breakpoint 0 condition detected. */
844#define X86_DR6_B0 RT_BIT_32(0)
845/** Bit 1 - B1 - Breakpoint 1 condition detected. */
846#define X86_DR6_B1 RT_BIT_32(1)
847/** Bit 2 - B2 - Breakpoint 2 condition detected. */
848#define X86_DR6_B2 RT_BIT_32(2)
849/** Bit 3 - B3 - Breakpoint 3 condition detected. */
850#define X86_DR6_B3 RT_BIT_32(3)
851/** Mask of all the Bx bits. */
852#define X86_DR6_B_MASK UINT64_C(0x0000000f)
853/** Bit 13 - BD - Debug register access detected. Corresponds to the X86_DR7_GD bit. */
854#define X86_DR6_BD RT_BIT_32(13)
855/** Bit 14 - BS - Single step */
856#define X86_DR6_BS RT_BIT_32(14)
857/** Bit 15 - BT - Task switch. (TSS T bit.) */
858#define X86_DR6_BT RT_BIT_32(15)
859/** Value of DR6 after powerup/reset. */
860#define X86_DR6_INIT_VAL UINT64_C(0xFFFF0FF0)
861/** Bits which must be 1s in DR6. */
862#define X86_DR6_RA1_MASK UINT64_C(0xffff0ff0)
863/** Bits which must be 0s in DR6. */
864#define X86_DR6_RAZ_MASK RT_BIT_64(12)
865/** Bits which must be 0s on writes to DR6. */
866#define X86_DR6_MBZ_MASK UINT64_C(0xffffffff00000000)
867/** @} */
868
869/** Get the DR6.Bx bit for a the given breakpoint. */
870#define X86_DR6_B(iBp) RT_BIT_64(iBp)
871
872
873/** @name DR7
874 * @{ */
875/** Bit 0 - L0 - Local breakpoint enable. Cleared on task switch. */
876#define X86_DR7_L0 RT_BIT_32(0)
877/** Bit 1 - G0 - Global breakpoint enable. Not cleared on task switch. */
878#define X86_DR7_G0 RT_BIT_32(1)
879/** Bit 2 - L1 - Local breakpoint enable. Cleared on task switch. */
880#define X86_DR7_L1 RT_BIT_32(2)
881/** Bit 3 - G1 - Global breakpoint enable. Not cleared on task switch. */
882#define X86_DR7_G1 RT_BIT_32(3)
883/** Bit 4 - L2 - Local breakpoint enable. Cleared on task switch. */
884#define X86_DR7_L2 RT_BIT_32(4)
885/** Bit 5 - G2 - Global breakpoint enable. Not cleared on task switch. */
886#define X86_DR7_G2 RT_BIT_32(5)
887/** Bit 6 - L3 - Local breakpoint enable. Cleared on task switch. */
888#define X86_DR7_L3 RT_BIT_32(6)
889/** Bit 7 - G3 - Global breakpoint enable. Not cleared on task switch. */
890#define X86_DR7_G3 RT_BIT_32(7)
891/** Bit 8 - LE - Local breakpoint exact. (Not supported (read ignored) by P6 and later.) */
892#define X86_DR7_LE RT_BIT_32(8)
893/** Bit 9 - GE - Local breakpoint exact. (Not supported (read ignored) by P6 and later.) */
894#define X86_DR7_GE RT_BIT_32(9)
895
896/** L0, L1, L2, and L3. */
897#define X86_DR7_LE_ALL UINT64_C(0x0000000000000055)
898/** L0, L1, L2, and L3. */
899#define X86_DR7_GE_ALL UINT64_C(0x00000000000000aa)
900
901/** Bit 12 - IR (ICE) - Interrupt redirection on Pentium. When set, the in
902 * Circuit Emulator (ICE) will break emulation on breakpoints and stuff.
903 * May cause CPU hang if enabled without ICE attached when the ICEBP/INT1
904 * instruction is executed.
905 * @see http://www.rcollins.org/secrets/DR7.html */
906#define X86_DR7_ICE_IR RT_BIT_32(12)
907/** Bit 13 - GD - General detect enable. Enables emulators to get exceptions when
908 * any DR register is accessed. */
909#define X86_DR7_GD RT_BIT_32(13)
910/** Bit 14 - TR1 (ICE) - Code discontinuity trace for use with ICE on
911 * Pentium. */
912#define X86_DR7_ICE_TR1 RT_BIT_32(14)
913/** Bit 15 - TR2 (ICE) - Controls unknown ICE trace feature of the pentium. */
914#define X86_DR7_ICE_TR2 RT_BIT_32(15)
915/** Bit 16 & 17 - R/W0 - Read write field 0. Values X86_DR7_RW_*. */
916#define X86_DR7_RW0_MASK (3 << 16)
917/** Bit 18 & 19 - LEN0 - Length field 0. Values X86_DR7_LEN_*. */
918#define X86_DR7_LEN0_MASK (3 << 18)
919/** Bit 20 & 21 - R/W1 - Read write field 0. Values X86_DR7_RW_*. */
920#define X86_DR7_RW1_MASK (3 << 20)
921/** Bit 22 & 23 - LEN1 - Length field 0. Values X86_DR7_LEN_*. */
922#define X86_DR7_LEN1_MASK (3 << 22)
923/** Bit 24 & 25 - R/W2 - Read write field 0. Values X86_DR7_RW_*. */
924#define X86_DR7_RW2_MASK (3 << 24)
925/** Bit 26 & 27 - LEN2 - Length field 0. Values X86_DR7_LEN_*. */
926#define X86_DR7_LEN2_MASK (3 << 26)
927/** Bit 28 & 29 - R/W3 - Read write field 0. Values X86_DR7_RW_*. */
928#define X86_DR7_RW3_MASK (3 << 28)
929/** Bit 30 & 31 - LEN3 - Length field 0. Values X86_DR7_LEN_*. */
930#define X86_DR7_LEN3_MASK (3 << 30)
931
932/** Bits which reads as 1s. */
933#define X86_DR7_RA1_MASK RT_BIT_32(10)
934/** Bits which reads as zeros. These are related to ICE (bits 12, 14, 15). */
935#define X86_DR7_RAZ_MASK UINT64_C(0x0000d800)
936/** Bits which must be 0s when writing to DR7. */
937#define X86_DR7_MBZ_MASK UINT64_C(0xffffffff00000000)
938
939/** Calcs the L bit of Nth breakpoint.
940 * @param iBp The breakpoint number [0..3].
941 */
942#define X86_DR7_L(iBp) ( UINT32_C(1) << (iBp * 2) )
943
944/** Calcs the G bit of Nth breakpoint.
945 * @param iBp The breakpoint number [0..3].
946 */
947#define X86_DR7_G(iBp) ( UINT32_C(1) << (iBp * 2 + 1) )
948
949/** Calcs the L and G bits of Nth breakpoint.
950 * @param iBp The breakpoint number [0..3].
951 */
952#define X86_DR7_L_G(iBp) ( UINT32_C(3) << (iBp * 2) )
953
954/** @name Read/Write values.
955 * @{ */
956/** Break on instruction fetch only. */
957#define X86_DR7_RW_EO 0U
958/** Break on write only. */
959#define X86_DR7_RW_WO 1U
960/** Break on I/O read/write. This is only defined if CR4.DE is set. */
961#define X86_DR7_RW_IO 2U
962/** Break on read or write (but not instruction fetches). */
963#define X86_DR7_RW_RW 3U
964/** @} */
965
966/** Shifts a X86_DR7_RW_* value to its right place.
967 * @param iBp The breakpoint number [0..3].
968 * @param fRw One of the X86_DR7_RW_* value.
969 */
970#define X86_DR7_RW(iBp, fRw) ( (fRw) << ((iBp) * 4 + 16) )
971
972/** Fetch the R/Wx bits for a given breakpoint (so it can be compared with
973 * one of the X86_DR7_RW_XXX constants).
974 *
975 * @returns X86_DR7_RW_XXX
976 * @param uDR7 DR7 value
977 * @param iBp The breakpoint number [0..3].
978 */
979#define X86_DR7_GET_RW(uDR7, iBp) ( ( (uDR7) >> ((iBp) * 4 + 16) ) & UINT32_C(3) )
980
981/** R/W0, R/W1, R/W2, and R/W3. */
982#define X86_DR7_RW_ALL_MASKS UINT32_C(0x33330000)
983
984#ifndef VBOX_FOR_DTRACE_LIB
985/** Checks if there are any I/O breakpoint types configured in the RW
986 * registers. Does NOT check if these are enabled, sorry. */
987# define X86_DR7_ANY_RW_IO(uDR7) \
988 ( ( UINT32_C(0x22220000) & (uDR7) ) /* any candidates? */ \
989 && ( ( (UINT32_C(0x22220000) & (uDR7) ) >> 1 ) & ~(uDR7) ) )
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#define MSR_K6_EFER_BIT_NXE 11 /**< Bit number of MSR_K6_EFER_NXE */
1386/** Bit 12 - SVME - Secure VM Extension Enabled. (R/W) */
1387#define MSR_K6_EFER_SVME RT_BIT_32(12)
1388/** Bit 13 - LMSLE - Long Mode Segment Limit Enable. (R/W?) */
1389#define MSR_K6_EFER_LMSLE RT_BIT_32(13)
1390/** Bit 14 - FFXSR - Fast FXSAVE / FXRSTOR (skip XMM*). (R/W) */
1391#define MSR_K6_EFER_FFXSR RT_BIT_32(14)
1392/** Bit 15 - TCE - Translation Cache Extension. (R/W) */
1393#define MSR_K6_EFER_TCE RT_BIT_32(15)
1394/** K6 STAR - SYSCALL/RET targets. */
1395#define MSR_K6_STAR UINT32_C(0xc0000081)
1396/** Shift value for getting the SYSRET CS and SS value. */
1397#define MSR_K6_STAR_SYSRET_CS_SS_SHIFT 48
1398/** Shift value for getting the SYSCALL CS and SS value. */
1399#define MSR_K6_STAR_SYSCALL_CS_SS_SHIFT 32
1400/** Selector mask for use after shifting. */
1401#define MSR_K6_STAR_SEL_MASK UINT32_C(0xffff)
1402/** The mask which give the SYSCALL EIP. */
1403#define MSR_K6_STAR_SYSCALL_EIP_MASK UINT32_C(0xffffffff)
1404/** K6 WHCR - Write Handling Control Register. */
1405#define MSR_K6_WHCR UINT32_C(0xc0000082)
1406/** K6 UWCCR - UC/WC Cacheability Control Register. */
1407#define MSR_K6_UWCCR UINT32_C(0xc0000085)
1408/** K6 PSOR - Processor State Observability Register. */
1409#define MSR_K6_PSOR UINT32_C(0xc0000087)
1410/** K6 PFIR - Page Flush/Invalidate Register. */
1411#define MSR_K6_PFIR UINT32_C(0xc0000088)
1412
1413/** Performance counter MSRs. (AMD only) */
1414#define MSR_K7_EVNTSEL0 UINT32_C(0xc0010000)
1415#define MSR_K7_EVNTSEL1 UINT32_C(0xc0010001)
1416#define MSR_K7_EVNTSEL2 UINT32_C(0xc0010002)
1417#define MSR_K7_EVNTSEL3 UINT32_C(0xc0010003)
1418#define MSR_K7_PERFCTR0 UINT32_C(0xc0010004)
1419#define MSR_K7_PERFCTR1 UINT32_C(0xc0010005)
1420#define MSR_K7_PERFCTR2 UINT32_C(0xc0010006)
1421#define MSR_K7_PERFCTR3 UINT32_C(0xc0010007)
1422
1423/** K8 LSTAR - Long mode SYSCALL target (RIP). */
1424#define MSR_K8_LSTAR UINT32_C(0xc0000082)
1425/** K8 CSTAR - Compatibility mode SYSCALL target (RIP). */
1426#define MSR_K8_CSTAR UINT32_C(0xc0000083)
1427/** K8 SF_MASK - SYSCALL flag mask. (aka SFMASK) */
1428#define MSR_K8_SF_MASK UINT32_C(0xc0000084)
1429/** K8 FS.base - The 64-bit base FS register. */
1430#define MSR_K8_FS_BASE UINT32_C(0xc0000100)
1431/** K8 GS.base - The 64-bit base GS register. */
1432#define MSR_K8_GS_BASE UINT32_C(0xc0000101)
1433/** K8 KernelGSbase - Used with SWAPGS. */
1434#define MSR_K8_KERNEL_GS_BASE UINT32_C(0xc0000102)
1435/** K8 TSC_AUX - Used with RDTSCP. */
1436#define MSR_K8_TSC_AUX UINT32_C(0xc0000103)
1437#define MSR_K8_SYSCFG UINT32_C(0xc0010010)
1438#define MSR_K8_HWCR UINT32_C(0xc0010015)
1439#define MSR_K8_IORRBASE0 UINT32_C(0xc0010016)
1440#define MSR_K8_IORRMASK0 UINT32_C(0xc0010017)
1441#define MSR_K8_IORRBASE1 UINT32_C(0xc0010018)
1442#define MSR_K8_IORRMASK1 UINT32_C(0xc0010019)
1443#define MSR_K8_TOP_MEM1 UINT32_C(0xc001001a)
1444#define MSR_K8_TOP_MEM2 UINT32_C(0xc001001d)
1445/** North bridge config? See BIOS & Kernel dev guides for
1446 * details. */
1447#define MSR_K8_NB_CFG UINT32_C(0xc001001f)
1448
1449/** Hypertransport interrupt pending register.
1450 * "BIOS and Kernel Developer's Guide for AMD NPT Family 0Fh Processors" */
1451#define MSR_K8_INT_PENDING UINT32_C(0xc0010055)
1452#define MSR_K8_VM_CR UINT32_C(0xc0010114)
1453#define MSR_K8_VM_CR_SVM_DISABLE RT_BIT_32(4)
1454
1455#define MSR_K8_IGNNE UINT32_C(0xc0010115)
1456#define MSR_K8_SMM_CTL UINT32_C(0xc0010116)
1457/** SVM - VM_HSAVE_PA - Physical address for saving and restoring
1458 * host state during world switch. */
1459#define MSR_K8_VM_HSAVE_PA UINT32_C(0xc0010117)
1460
1461/** @} */
1462
1463
1464/** @name Page Table / Directory / Directory Pointers / L4.
1465 * @{
1466 */
1467
1468/** Page table/directory entry as an unsigned integer. */
1469typedef uint32_t X86PGUINT;
1470/** Pointer to a page table/directory table entry as an unsigned integer. */
1471typedef X86PGUINT *PX86PGUINT;
1472/** Pointer to an const page table/directory table entry as an unsigned integer. */
1473typedef X86PGUINT const *PCX86PGUINT;
1474
1475/** Number of entries in a 32-bit PT/PD. */
1476#define X86_PG_ENTRIES 1024
1477
1478
1479/** PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1480typedef uint64_t X86PGPAEUINT;
1481/** Pointer to a PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1482typedef X86PGPAEUINT *PX86PGPAEUINT;
1483/** Pointer to an const PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1484typedef X86PGPAEUINT const *PCX86PGPAEUINT;
1485
1486/** Number of entries in a PAE PT/PD. */
1487#define X86_PG_PAE_ENTRIES 512
1488/** Number of entries in a PAE PDPT. */
1489#define X86_PG_PAE_PDPE_ENTRIES 4
1490
1491/** Number of entries in an AMD64 PT/PD/PDPT/L4/L5. */
1492#define X86_PG_AMD64_ENTRIES X86_PG_PAE_ENTRIES
1493/** Number of entries in an AMD64 PDPT.
1494 * Just for complementing X86_PG_PAE_PDPE_ENTRIES, using X86_PG_AMD64_ENTRIES for this is fine too. */
1495#define X86_PG_AMD64_PDPE_ENTRIES X86_PG_AMD64_ENTRIES
1496
1497/** The size of a default page. */
1498#define X86_PAGE_SIZE X86_PAGE_4K_SIZE
1499/** The page shift of a default page. */
1500#define X86_PAGE_SHIFT X86_PAGE_4K_SHIFT
1501/** The default page offset mask. */
1502#define X86_PAGE_OFFSET_MASK X86_PAGE_4K_OFFSET_MASK
1503/** The default page base mask for virtual addresses. */
1504#define X86_PAGE_BASE_MASK X86_PAGE_4K_BASE_MASK
1505/** The default page base mask for virtual addresses - 32bit version. */
1506#define X86_PAGE_BASE_MASK_32 X86_PAGE_4K_BASE_MASK_32
1507
1508/** The size of a 4KB page. */
1509#define X86_PAGE_4K_SIZE _4K
1510/** The page shift of a 4KB page. */
1511#define X86_PAGE_4K_SHIFT 12
1512/** The 4KB page offset mask. */
1513#define X86_PAGE_4K_OFFSET_MASK 0xfff
1514/** The 4KB page base mask for virtual addresses. */
1515#define X86_PAGE_4K_BASE_MASK 0xfffffffffffff000ULL
1516/** The 4KB page base mask for virtual addresses - 32bit version. */
1517#define X86_PAGE_4K_BASE_MASK_32 0xfffff000U
1518
1519/** The size of a 2MB page. */
1520#define X86_PAGE_2M_SIZE _2M
1521/** The page shift of a 2MB page. */
1522#define X86_PAGE_2M_SHIFT 21
1523/** The 2MB page offset mask. */
1524#define X86_PAGE_2M_OFFSET_MASK 0x001fffff
1525/** The 2MB page base mask for virtual addresses. */
1526#define X86_PAGE_2M_BASE_MASK 0xffffffffffe00000ULL
1527/** The 2MB page base mask for virtual addresses - 32bit version. */
1528#define X86_PAGE_2M_BASE_MASK_32 0xffe00000U
1529
1530/** The size of a 4MB page. */
1531#define X86_PAGE_4M_SIZE _4M
1532/** The page shift of a 4MB page. */
1533#define X86_PAGE_4M_SHIFT 22
1534/** The 4MB page offset mask. */
1535#define X86_PAGE_4M_OFFSET_MASK 0x003fffff
1536/** The 4MB page base mask for virtual addresses. */
1537#define X86_PAGE_4M_BASE_MASK 0xffffffffffc00000ULL
1538/** The 4MB page base mask for virtual addresses - 32bit version. */
1539#define X86_PAGE_4M_BASE_MASK_32 0xffc00000U
1540
1541/**
1542 * Check if the given address is canonical.
1543 */
1544#define X86_IS_CANONICAL(a_u64Addr) ((uint64_t)(a_u64Addr) + UINT64_C(0x800000000000) < UINT64_C(0x1000000000000))
1545
1546
1547/** @name Page Table Entry
1548 * @{
1549 */
1550/** Bit 0 - P - Present bit. */
1551#define X86_PTE_BIT_P 0
1552/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1553#define X86_PTE_BIT_RW 1
1554/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1555#define X86_PTE_BIT_US 2
1556/** Bit 3 - PWT - Page level write thru bit. */
1557#define X86_PTE_BIT_PWT 3
1558/** Bit 4 - PCD - Page level cache disable bit. */
1559#define X86_PTE_BIT_PCD 4
1560/** Bit 5 - A - Access bit. */
1561#define X86_PTE_BIT_A 5
1562/** Bit 6 - D - Dirty bit. */
1563#define X86_PTE_BIT_D 6
1564/** Bit 7 - PAT - Page Attribute Table index bit. Reserved and 0 if not supported. */
1565#define X86_PTE_BIT_PAT 7
1566/** Bit 8 - G - Global flag. */
1567#define X86_PTE_BIT_G 8
1568/** Bits 63 - NX - PAE/LM - No execution flag. */
1569#define X86_PTE_PAE_BIT_NX 63
1570
1571/** Bit 0 - P - Present bit mask. */
1572#define X86_PTE_P RT_BIT_32(0)
1573/** Bit 1 - R/W - Read (clear) / Write (set) bit mask. */
1574#define X86_PTE_RW RT_BIT_32(1)
1575/** Bit 2 - U/S - User (set) / Supervisor (clear) bit mask. */
1576#define X86_PTE_US RT_BIT_32(2)
1577/** Bit 3 - PWT - Page level write thru bit mask. */
1578#define X86_PTE_PWT RT_BIT_32(3)
1579/** Bit 4 - PCD - Page level cache disable bit mask. */
1580#define X86_PTE_PCD RT_BIT_32(4)
1581/** Bit 5 - A - Access bit mask. */
1582#define X86_PTE_A RT_BIT_32(5)
1583/** Bit 6 - D - Dirty bit mask. */
1584#define X86_PTE_D RT_BIT_32(6)
1585/** Bit 7 - PAT - Page Attribute Table index bit mask. Reserved and 0 if not supported. */
1586#define X86_PTE_PAT RT_BIT_32(7)
1587/** Bit 8 - G - Global bit mask. */
1588#define X86_PTE_G RT_BIT_32(8)
1589
1590/** Bits 9-11 - - Available for use to system software. */
1591#define X86_PTE_AVL_MASK (RT_BIT_32(9) | RT_BIT_32(10) | RT_BIT_32(11))
1592/** Bits 12-31 - - Physical Page number of the next level. */
1593#define X86_PTE_PG_MASK ( 0xfffff000 )
1594
1595/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1596#define X86_PTE_PAE_PG_MASK UINT64_C(0x000ffffffffff000)
1597/** Bits 63 - NX - PAE/LM - No execution flag. */
1598#define X86_PTE_PAE_NX RT_BIT_64(63)
1599/** Bits 62-52 - - PAE - MBZ bits when NX is active. */
1600#define X86_PTE_PAE_MBZ_MASK_NX UINT64_C(0x7ff0000000000000)
1601/** Bits 63-52 - - PAE - MBZ bits when no NX. */
1602#define X86_PTE_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff0000000000000)
1603/** No bits - - LM - MBZ bits when NX is active. */
1604#define X86_PTE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000000)
1605/** Bits 63 - - LM - MBZ bits when no NX. */
1606#define X86_PTE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000000)
1607
1608/**
1609 * Page table entry.
1610 */
1611typedef struct X86PTEBITS
1612{
1613 /** Flags whether(=1) or not the page is present. */
1614 uint32_t u1Present : 1;
1615 /** Read(=0) / Write(=1) flag. */
1616 uint32_t u1Write : 1;
1617 /** User(=1) / Supervisor (=0) flag. */
1618 uint32_t u1User : 1;
1619 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1620 uint32_t u1WriteThru : 1;
1621 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1622 uint32_t u1CacheDisable : 1;
1623 /** Accessed flag.
1624 * Indicates that the page have been read or written to. */
1625 uint32_t u1Accessed : 1;
1626 /** Dirty flag.
1627 * Indicates that the page has been written to. */
1628 uint32_t u1Dirty : 1;
1629 /** Reserved / If PAT enabled, bit 2 of the index. */
1630 uint32_t u1PAT : 1;
1631 /** Global flag. (Ignored in all but final level.) */
1632 uint32_t u1Global : 1;
1633 /** Available for use to system software. */
1634 uint32_t u3Available : 3;
1635 /** Physical Page number of the next level. */
1636 uint32_t u20PageNo : 20;
1637} X86PTEBITS;
1638#ifndef VBOX_FOR_DTRACE_LIB
1639AssertCompileSize(X86PTEBITS, 4);
1640#endif
1641/** Pointer to a page table entry. */
1642typedef X86PTEBITS *PX86PTEBITS;
1643/** Pointer to a const page table entry. */
1644typedef const X86PTEBITS *PCX86PTEBITS;
1645
1646/**
1647 * Page table entry.
1648 */
1649typedef union X86PTE
1650{
1651 /** Unsigned integer view */
1652 X86PGUINT u;
1653 /** Bit field view. */
1654 X86PTEBITS n;
1655 /** 32-bit view. */
1656 uint32_t au32[1];
1657 /** 16-bit view. */
1658 uint16_t au16[2];
1659 /** 8-bit view. */
1660 uint8_t au8[4];
1661} X86PTE;
1662#ifndef VBOX_FOR_DTRACE_LIB
1663AssertCompileSize(X86PTE, 4);
1664#endif
1665/** Pointer to a page table entry. */
1666typedef X86PTE *PX86PTE;
1667/** Pointer to a const page table entry. */
1668typedef const X86PTE *PCX86PTE;
1669
1670
1671/**
1672 * PAE page table entry.
1673 */
1674typedef struct X86PTEPAEBITS
1675{
1676 /** Flags whether(=1) or not the page is present. */
1677 uint32_t u1Present : 1;
1678 /** Read(=0) / Write(=1) flag. */
1679 uint32_t u1Write : 1;
1680 /** User(=1) / Supervisor(=0) flag. */
1681 uint32_t u1User : 1;
1682 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1683 uint32_t u1WriteThru : 1;
1684 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1685 uint32_t u1CacheDisable : 1;
1686 /** Accessed flag.
1687 * Indicates that the page have been read or written to. */
1688 uint32_t u1Accessed : 1;
1689 /** Dirty flag.
1690 * Indicates that the page has been written to. */
1691 uint32_t u1Dirty : 1;
1692 /** Reserved / If PAT enabled, bit 2 of the index. */
1693 uint32_t u1PAT : 1;
1694 /** Global flag. (Ignored in all but final level.) */
1695 uint32_t u1Global : 1;
1696 /** Available for use to system software. */
1697 uint32_t u3Available : 3;
1698 /** Physical Page number of the next level - Low Part. Don't use this. */
1699 uint32_t u20PageNoLow : 20;
1700 /** Physical Page number of the next level - High Part. Don't use this. */
1701 uint32_t u20PageNoHigh : 20;
1702 /** MBZ bits */
1703 uint32_t u11Reserved : 11;
1704 /** No Execute flag. */
1705 uint32_t u1NoExecute : 1;
1706} X86PTEPAEBITS;
1707#ifndef VBOX_FOR_DTRACE_LIB
1708AssertCompileSize(X86PTEPAEBITS, 8);
1709#endif
1710/** Pointer to a page table entry. */
1711typedef X86PTEPAEBITS *PX86PTEPAEBITS;
1712/** Pointer to a page table entry. */
1713typedef const X86PTEPAEBITS *PCX86PTEPAEBITS;
1714
1715/**
1716 * PAE Page table entry.
1717 */
1718typedef union X86PTEPAE
1719{
1720 /** Unsigned integer view */
1721 X86PGPAEUINT u;
1722 /** Bit field view. */
1723 X86PTEPAEBITS n;
1724 /** 32-bit view. */
1725 uint32_t au32[2];
1726 /** 16-bit view. */
1727 uint16_t au16[4];
1728 /** 8-bit view. */
1729 uint8_t au8[8];
1730} X86PTEPAE;
1731#ifndef VBOX_FOR_DTRACE_LIB
1732AssertCompileSize(X86PTEPAE, 8);
1733#endif
1734/** Pointer to a PAE page table entry. */
1735typedef X86PTEPAE *PX86PTEPAE;
1736/** Pointer to a const PAE page table entry. */
1737typedef const X86PTEPAE *PCX86PTEPAE;
1738/** @} */
1739
1740/**
1741 * Page table.
1742 */
1743typedef struct X86PT
1744{
1745 /** PTE Array. */
1746 X86PTE a[X86_PG_ENTRIES];
1747} X86PT;
1748#ifndef VBOX_FOR_DTRACE_LIB
1749AssertCompileSize(X86PT, 4096);
1750#endif
1751/** Pointer to a page table. */
1752typedef X86PT *PX86PT;
1753/** Pointer to a const page table. */
1754typedef const X86PT *PCX86PT;
1755
1756/** The page shift to get the PT index. */
1757#define X86_PT_SHIFT 12
1758/** The PT index mask (apply to a shifted page address). */
1759#define X86_PT_MASK 0x3ff
1760
1761
1762/**
1763 * Page directory.
1764 */
1765typedef struct X86PTPAE
1766{
1767 /** PTE Array. */
1768 X86PTEPAE a[X86_PG_PAE_ENTRIES];
1769} X86PTPAE;
1770#ifndef VBOX_FOR_DTRACE_LIB
1771AssertCompileSize(X86PTPAE, 4096);
1772#endif
1773/** Pointer to a page table. */
1774typedef X86PTPAE *PX86PTPAE;
1775/** Pointer to a const page table. */
1776typedef const X86PTPAE *PCX86PTPAE;
1777
1778/** The page shift to get the PA PTE index. */
1779#define X86_PT_PAE_SHIFT 12
1780/** The PAE PT index mask (apply to a shifted page address). */
1781#define X86_PT_PAE_MASK 0x1ff
1782
1783
1784/** @name 4KB Page Directory Entry
1785 * @{
1786 */
1787/** Bit 0 - P - Present bit. */
1788#define X86_PDE_P RT_BIT_32(0)
1789/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1790#define X86_PDE_RW RT_BIT_32(1)
1791/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1792#define X86_PDE_US RT_BIT_32(2)
1793/** Bit 3 - PWT - Page level write thru bit. */
1794#define X86_PDE_PWT RT_BIT_32(3)
1795/** Bit 4 - PCD - Page level cache disable bit. */
1796#define X86_PDE_PCD RT_BIT_32(4)
1797/** Bit 5 - A - Access bit. */
1798#define X86_PDE_A RT_BIT_32(5)
1799/** Bit 7 - PS - Page size attribute.
1800 * Clear mean 4KB pages, set means large pages (2/4MB). */
1801#define X86_PDE_PS RT_BIT_32(7)
1802/** Bits 9-11 - - Available for use to system software. */
1803#define X86_PDE_AVL_MASK (RT_BIT_32(9) | RT_BIT_32(10) | RT_BIT_32(11))
1804/** Bits 12-31 - - Physical Page number of the next level. */
1805#define X86_PDE_PG_MASK ( 0xfffff000 )
1806
1807/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1808#define X86_PDE_PAE_PG_MASK UINT64_C(0x000ffffffffff000)
1809/** Bits 63 - NX - PAE/LM - No execution flag. */
1810#define X86_PDE_PAE_NX RT_BIT_64(63)
1811/** Bits 62-52, 7 - - PAE - MBZ bits when NX is active. */
1812#define X86_PDE_PAE_MBZ_MASK_NX UINT64_C(0x7ff0000000000080)
1813/** Bits 63-52, 7 - - PAE - MBZ bits when no NX. */
1814#define X86_PDE_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff0000000000080)
1815/** Bit 7 - - LM - MBZ bits when NX is active. */
1816#define X86_PDE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000080)
1817/** Bits 63, 7 - - LM - MBZ bits when no NX. */
1818#define X86_PDE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000080)
1819
1820/**
1821 * Page directory entry.
1822 */
1823typedef struct X86PDEBITS
1824{
1825 /** Flags whether(=1) or not the page is present. */
1826 uint32_t u1Present : 1;
1827 /** Read(=0) / Write(=1) flag. */
1828 uint32_t u1Write : 1;
1829 /** User(=1) / Supervisor (=0) flag. */
1830 uint32_t u1User : 1;
1831 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1832 uint32_t u1WriteThru : 1;
1833 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1834 uint32_t u1CacheDisable : 1;
1835 /** Accessed flag.
1836 * Indicates that the page has been read or written to. */
1837 uint32_t u1Accessed : 1;
1838 /** Reserved / Ignored (dirty bit). */
1839 uint32_t u1Reserved0 : 1;
1840 /** Size bit if PSE is enabled - in any event it's 0. */
1841 uint32_t u1Size : 1;
1842 /** Reserved / Ignored (global bit). */
1843 uint32_t u1Reserved1 : 1;
1844 /** Available for use to system software. */
1845 uint32_t u3Available : 3;
1846 /** Physical Page number of the next level. */
1847 uint32_t u20PageNo : 20;
1848} X86PDEBITS;
1849#ifndef VBOX_FOR_DTRACE_LIB
1850AssertCompileSize(X86PDEBITS, 4);
1851#endif
1852/** Pointer to a page directory entry. */
1853typedef X86PDEBITS *PX86PDEBITS;
1854/** Pointer to a const page directory entry. */
1855typedef const X86PDEBITS *PCX86PDEBITS;
1856
1857
1858/**
1859 * PAE page directory entry.
1860 */
1861typedef struct X86PDEPAEBITS
1862{
1863 /** Flags whether(=1) or not the page is present. */
1864 uint32_t u1Present : 1;
1865 /** Read(=0) / Write(=1) flag. */
1866 uint32_t u1Write : 1;
1867 /** User(=1) / Supervisor (=0) flag. */
1868 uint32_t u1User : 1;
1869 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1870 uint32_t u1WriteThru : 1;
1871 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1872 uint32_t u1CacheDisable : 1;
1873 /** Accessed flag.
1874 * Indicates that the page has been read or written to. */
1875 uint32_t u1Accessed : 1;
1876 /** Reserved / Ignored (dirty bit). */
1877 uint32_t u1Reserved0 : 1;
1878 /** Size bit if PSE is enabled - in any event it's 0. */
1879 uint32_t u1Size : 1;
1880 /** Reserved / Ignored (global bit). / */
1881 uint32_t u1Reserved1 : 1;
1882 /** Available for use to system software. */
1883 uint32_t u3Available : 3;
1884 /** Physical Page number of the next level - Low Part. Don't use! */
1885 uint32_t u20PageNoLow : 20;
1886 /** Physical Page number of the next level - High Part. Don't use! */
1887 uint32_t u20PageNoHigh : 20;
1888 /** MBZ bits */
1889 uint32_t u11Reserved : 11;
1890 /** No Execute flag. */
1891 uint32_t u1NoExecute : 1;
1892} X86PDEPAEBITS;
1893#ifndef VBOX_FOR_DTRACE_LIB
1894AssertCompileSize(X86PDEPAEBITS, 8);
1895#endif
1896/** Pointer to a page directory entry. */
1897typedef X86PDEPAEBITS *PX86PDEPAEBITS;
1898/** Pointer to a const page directory entry. */
1899typedef const X86PDEPAEBITS *PCX86PDEPAEBITS;
1900
1901/** @} */
1902
1903
1904/** @name 2/4MB Page Directory Entry
1905 * @{
1906 */
1907/** Bit 0 - P - Present bit. */
1908#define X86_PDE4M_P RT_BIT_32(0)
1909/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1910#define X86_PDE4M_RW RT_BIT_32(1)
1911/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1912#define X86_PDE4M_US RT_BIT_32(2)
1913/** Bit 3 - PWT - Page level write thru bit. */
1914#define X86_PDE4M_PWT RT_BIT_32(3)
1915/** Bit 4 - PCD - Page level cache disable bit. */
1916#define X86_PDE4M_PCD RT_BIT_32(4)
1917/** Bit 5 - A - Access bit. */
1918#define X86_PDE4M_A RT_BIT_32(5)
1919/** Bit 6 - D - Dirty bit. */
1920#define X86_PDE4M_D RT_BIT_32(6)
1921/** Bit 7 - PS - Page size attribute. Clear mean 4KB pages, set means large pages (2/4MB). */
1922#define X86_PDE4M_PS RT_BIT_32(7)
1923/** Bit 8 - G - Global flag. */
1924#define X86_PDE4M_G RT_BIT_32(8)
1925/** Bits 9-11 - AVL - Available for use to system software. */
1926#define X86_PDE4M_AVL (RT_BIT_32(9) | RT_BIT_32(10) | RT_BIT_32(11))
1927/** Bit 12 - PAT - Page Attribute Table index bit. Reserved and 0 if not supported. */
1928#define X86_PDE4M_PAT RT_BIT_32(12)
1929/** Shift to get from X86_PTE_PAT to X86_PDE4M_PAT. */
1930#define X86_PDE4M_PAT_SHIFT (12 - 7)
1931/** Bits 22-31 - - Physical Page number. */
1932#define X86_PDE4M_PG_MASK ( 0xffc00000 )
1933/** Bits 20-13 - - Physical Page number high part (32-39 bits). AMD64 hack. */
1934#define X86_PDE4M_PG_HIGH_MASK ( 0x001fe000 )
1935/** The number of bits to the high part of the page number. */
1936#define X86_PDE4M_PG_HIGH_SHIFT 19
1937/** Bit 21 - - MBZ bits for AMD CPUs, no PSE36. */
1938#define X86_PDE4M_MBZ_MASK RT_BIT_32(21)
1939
1940/** Bits 21-51 - - PAE/LM - Physical Page number.
1941 * (Bits 40-51 (long mode) & bits 36-51 (pae legacy) are reserved according to the Intel docs; AMD allows for more.) */
1942#define X86_PDE2M_PAE_PG_MASK UINT64_C(0x000fffffffe00000)
1943/** Bits 63 - NX - PAE/LM - No execution flag. */
1944#define X86_PDE2M_PAE_NX RT_BIT_64(63)
1945/** Bits 62-52, 20-13 - - PAE - MBZ bits when NX is active. */
1946#define X86_PDE2M_PAE_MBZ_MASK_NX UINT64_C(0x7ff00000001fe000)
1947/** Bits 63-52, 20-13 - - PAE - MBZ bits when no NX. */
1948#define X86_PDE2M_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff00000001fe000)
1949/** Bits 20-13 - - LM - MBZ bits when NX is active. */
1950#define X86_PDE2M_LM_MBZ_MASK_NX UINT64_C(0x00000000001fe000)
1951/** Bits 63, 20-13 - - LM - MBZ bits when no NX. */
1952#define X86_PDE2M_LM_MBZ_MASK_NO_NX UINT64_C(0x80000000001fe000)
1953
1954/**
1955 * 4MB page directory entry.
1956 */
1957typedef struct X86PDE4MBITS
1958{
1959 /** Flags whether(=1) or not the page is present. */
1960 uint32_t u1Present : 1;
1961 /** Read(=0) / Write(=1) flag. */
1962 uint32_t u1Write : 1;
1963 /** User(=1) / Supervisor (=0) flag. */
1964 uint32_t u1User : 1;
1965 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1966 uint32_t u1WriteThru : 1;
1967 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1968 uint32_t u1CacheDisable : 1;
1969 /** Accessed flag.
1970 * Indicates that the page have been read or written to. */
1971 uint32_t u1Accessed : 1;
1972 /** Dirty flag.
1973 * Indicates that the page has been written to. */
1974 uint32_t u1Dirty : 1;
1975 /** Page size flag - always 1 for 4MB entries. */
1976 uint32_t u1Size : 1;
1977 /** Global flag. */
1978 uint32_t u1Global : 1;
1979 /** Available for use to system software. */
1980 uint32_t u3Available : 3;
1981 /** Reserved / If PAT enabled, bit 2 of the index. */
1982 uint32_t u1PAT : 1;
1983 /** Bits 32-39 of the page number on AMD64.
1984 * This AMD64 hack allows accessing 40bits of physical memory without PAE. */
1985 uint32_t u8PageNoHigh : 8;
1986 /** Reserved. */
1987 uint32_t u1Reserved : 1;
1988 /** Physical Page number of the page. */
1989 uint32_t u10PageNo : 10;
1990} X86PDE4MBITS;
1991#ifndef VBOX_FOR_DTRACE_LIB
1992AssertCompileSize(X86PDE4MBITS, 4);
1993#endif
1994/** Pointer to a page table entry. */
1995typedef X86PDE4MBITS *PX86PDE4MBITS;
1996/** Pointer to a const page table entry. */
1997typedef const X86PDE4MBITS *PCX86PDE4MBITS;
1998
1999
2000/**
2001 * 2MB PAE page directory entry.
2002 */
2003typedef struct X86PDE2MPAEBITS
2004{
2005 /** Flags whether(=1) or not the page is present. */
2006 uint32_t u1Present : 1;
2007 /** Read(=0) / Write(=1) flag. */
2008 uint32_t u1Write : 1;
2009 /** User(=1) / Supervisor(=0) flag. */
2010 uint32_t u1User : 1;
2011 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
2012 uint32_t u1WriteThru : 1;
2013 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
2014 uint32_t u1CacheDisable : 1;
2015 /** Accessed flag.
2016 * Indicates that the page have been read or written to. */
2017 uint32_t u1Accessed : 1;
2018 /** Dirty flag.
2019 * Indicates that the page has been written to. */
2020 uint32_t u1Dirty : 1;
2021 /** Page size flag - always 1 for 2MB entries. */
2022 uint32_t u1Size : 1;
2023 /** Global flag. */
2024 uint32_t u1Global : 1;
2025 /** Available for use to system software. */
2026 uint32_t u3Available : 3;
2027 /** Reserved / If PAT enabled, bit 2 of the index. */
2028 uint32_t u1PAT : 1;
2029 /** Reserved. */
2030 uint32_t u9Reserved : 9;
2031 /** Physical Page number of the next level - Low part. Don't use! */
2032 uint32_t u10PageNoLow : 10;
2033 /** Physical Page number of the next level - High part. Don't use! */
2034 uint32_t u20PageNoHigh : 20;
2035 /** MBZ bits */
2036 uint32_t u11Reserved : 11;
2037 /** No Execute flag. */
2038 uint32_t u1NoExecute : 1;
2039} X86PDE2MPAEBITS;
2040#ifndef VBOX_FOR_DTRACE_LIB
2041AssertCompileSize(X86PDE2MPAEBITS, 8);
2042#endif
2043/** Pointer to a 2MB PAE page table entry. */
2044typedef X86PDE2MPAEBITS *PX86PDE2MPAEBITS;
2045/** Pointer to a 2MB PAE page table entry. */
2046typedef const X86PDE2MPAEBITS *PCX86PDE2MPAEBITS;
2047
2048/** @} */
2049
2050/**
2051 * Page directory entry.
2052 */
2053typedef union X86PDE
2054{
2055 /** Unsigned integer view. */
2056 X86PGUINT u;
2057 /** Normal view. */
2058 X86PDEBITS n;
2059 /** 4MB view (big). */
2060 X86PDE4MBITS b;
2061 /** 8 bit unsigned integer view. */
2062 uint8_t au8[4];
2063 /** 16 bit unsigned integer view. */
2064 uint16_t au16[2];
2065 /** 32 bit unsigned integer view. */
2066 uint32_t au32[1];
2067} X86PDE;
2068#ifndef VBOX_FOR_DTRACE_LIB
2069AssertCompileSize(X86PDE, 4);
2070#endif
2071/** Pointer to a page directory entry. */
2072typedef X86PDE *PX86PDE;
2073/** Pointer to a const page directory entry. */
2074typedef const X86PDE *PCX86PDE;
2075
2076/**
2077 * PAE page directory entry.
2078 */
2079typedef union X86PDEPAE
2080{
2081 /** Unsigned integer view. */
2082 X86PGPAEUINT u;
2083 /** Normal view. */
2084 X86PDEPAEBITS n;
2085 /** 2MB page view (big). */
2086 X86PDE2MPAEBITS b;
2087 /** 8 bit unsigned integer view. */
2088 uint8_t au8[8];
2089 /** 16 bit unsigned integer view. */
2090 uint16_t au16[4];
2091 /** 32 bit unsigned integer view. */
2092 uint32_t au32[2];
2093} X86PDEPAE;
2094#ifndef VBOX_FOR_DTRACE_LIB
2095AssertCompileSize(X86PDEPAE, 8);
2096#endif
2097/** Pointer to a page directory entry. */
2098typedef X86PDEPAE *PX86PDEPAE;
2099/** Pointer to a const page directory entry. */
2100typedef const X86PDEPAE *PCX86PDEPAE;
2101
2102/**
2103 * Page directory.
2104 */
2105typedef struct X86PD
2106{
2107 /** PDE Array. */
2108 X86PDE a[X86_PG_ENTRIES];
2109} X86PD;
2110#ifndef VBOX_FOR_DTRACE_LIB
2111AssertCompileSize(X86PD, 4096);
2112#endif
2113/** Pointer to a page directory. */
2114typedef X86PD *PX86PD;
2115/** Pointer to a const page directory. */
2116typedef const X86PD *PCX86PD;
2117
2118/** The page shift to get the PD index. */
2119#define X86_PD_SHIFT 22
2120/** The PD index mask (apply to a shifted page address). */
2121#define X86_PD_MASK 0x3ff
2122
2123
2124/**
2125 * PAE page directory.
2126 */
2127typedef struct X86PDPAE
2128{
2129 /** PDE Array. */
2130 X86PDEPAE a[X86_PG_PAE_ENTRIES];
2131} X86PDPAE;
2132#ifndef VBOX_FOR_DTRACE_LIB
2133AssertCompileSize(X86PDPAE, 4096);
2134#endif
2135/** Pointer to a PAE page directory. */
2136typedef X86PDPAE *PX86PDPAE;
2137/** Pointer to a const PAE page directory. */
2138typedef const X86PDPAE *PCX86PDPAE;
2139
2140/** The page shift to get the PAE PD index. */
2141#define X86_PD_PAE_SHIFT 21
2142/** The PAE PD index mask (apply to a shifted page address). */
2143#define X86_PD_PAE_MASK 0x1ff
2144
2145
2146/** @name Page Directory Pointer Table Entry (PAE)
2147 * @{
2148 */
2149/** Bit 0 - P - Present bit. */
2150#define X86_PDPE_P RT_BIT_32(0)
2151/** Bit 1 - R/W - Read (clear) / Write (set) bit. Long Mode only. */
2152#define X86_PDPE_RW RT_BIT_32(1)
2153/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. Long Mode only. */
2154#define X86_PDPE_US RT_BIT_32(2)
2155/** Bit 3 - PWT - Page level write thru bit. */
2156#define X86_PDPE_PWT RT_BIT_32(3)
2157/** Bit 4 - PCD - Page level cache disable bit. */
2158#define X86_PDPE_PCD RT_BIT_32(4)
2159/** Bit 5 - A - Access bit. Long Mode only. */
2160#define X86_PDPE_A RT_BIT_32(5)
2161/** Bit 7 - PS - Page size (1GB). Long Mode only. */
2162#define X86_PDPE_LM_PS RT_BIT_32(7)
2163/** Bits 9-11 - - Available for use to system software. */
2164#define X86_PDPE_AVL_MASK (RT_BIT_32(9) | RT_BIT_32(10) | RT_BIT_32(11))
2165/** Bits 12-51 - - PAE - Physical Page number of the next level. */
2166#define X86_PDPE_PG_MASK UINT64_C(0x000ffffffffff000)
2167/** Bits 63-52, 8-5, 2-1 - - PAE - MBZ bits (NX is long mode only). */
2168#define X86_PDPE_PAE_MBZ_MASK UINT64_C(0xfff00000000001e6)
2169/** Bits 63 - NX - LM - No execution flag. Long Mode only. */
2170#define X86_PDPE_LM_NX RT_BIT_64(63)
2171/** Bits 8, 7 - - LM - MBZ bits when NX is active. */
2172#define X86_PDPE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000180)
2173/** Bits 63, 8, 7 - - LM - MBZ bits when no NX. */
2174#define X86_PDPE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000180)
2175/** Bits 29-13 - - LM - MBZ bits for 1GB page entry when NX is active. */
2176#define X86_PDPE1G_LM_MBZ_MASK_NX UINT64_C(0x000000003fffe000)
2177/** Bits 63, 29-13 - - LM - MBZ bits for 1GB page entry when no NX. */
2178#define X86_PDPE1G_LM_MBZ_MASK_NO_NX UINT64_C(0x800000003fffe000)
2179
2180
2181/**
2182 * Page directory pointer table entry.
2183 */
2184typedef struct X86PDPEBITS
2185{
2186 /** Flags whether(=1) or not the page is present. */
2187 uint32_t u1Present : 1;
2188 /** Chunk of reserved bits. */
2189 uint32_t u2Reserved : 2;
2190 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
2191 uint32_t u1WriteThru : 1;
2192 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
2193 uint32_t u1CacheDisable : 1;
2194 /** Chunk of reserved bits. */
2195 uint32_t u4Reserved : 4;
2196 /** Available for use to system software. */
2197 uint32_t u3Available : 3;
2198 /** Physical Page number of the next level - Low Part. Don't use! */
2199 uint32_t u20PageNoLow : 20;
2200 /** Physical Page number of the next level - High Part. Don't use! */
2201 uint32_t u20PageNoHigh : 20;
2202 /** MBZ bits */
2203 uint32_t u12Reserved : 12;
2204} X86PDPEBITS;
2205#ifndef VBOX_FOR_DTRACE_LIB
2206AssertCompileSize(X86PDPEBITS, 8);
2207#endif
2208/** Pointer to a page directory pointer table entry. */
2209typedef X86PDPEBITS *PX86PTPEBITS;
2210/** Pointer to a const page directory pointer table entry. */
2211typedef const X86PDPEBITS *PCX86PTPEBITS;
2212
2213/**
2214 * Page directory pointer table entry. AMD64 version
2215 */
2216typedef struct X86PDPEAMD64BITS
2217{
2218 /** Flags whether(=1) or not the page is present. */
2219 uint32_t u1Present : 1;
2220 /** Read(=0) / Write(=1) flag. */
2221 uint32_t u1Write : 1;
2222 /** User(=1) / Supervisor (=0) flag. */
2223 uint32_t u1User : 1;
2224 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
2225 uint32_t u1WriteThru : 1;
2226 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
2227 uint32_t u1CacheDisable : 1;
2228 /** Accessed flag.
2229 * Indicates that the page have been read or written to. */
2230 uint32_t u1Accessed : 1;
2231 /** Chunk of reserved bits. */
2232 uint32_t u3Reserved : 3;
2233 /** Available for use to system software. */
2234 uint32_t u3Available : 3;
2235 /** Physical Page number of the next level - Low Part. Don't use! */
2236 uint32_t u20PageNoLow : 20;
2237 /** Physical Page number of the next level - High Part. Don't use! */
2238 uint32_t u20PageNoHigh : 20;
2239 /** MBZ bits */
2240 uint32_t u11Reserved : 11;
2241 /** No Execute flag. */
2242 uint32_t u1NoExecute : 1;
2243} X86PDPEAMD64BITS;
2244#ifndef VBOX_FOR_DTRACE_LIB
2245AssertCompileSize(X86PDPEAMD64BITS, 8);
2246#endif
2247/** Pointer to a page directory pointer table entry. */
2248typedef X86PDPEAMD64BITS *PX86PDPEAMD64BITS;
2249/** Pointer to a const page directory pointer table entry. */
2250typedef const X86PDPEAMD64BITS *PCX86PDPEAMD64BITS;
2251
2252/**
2253 * Page directory pointer table entry for 1GB page. (AMD64 only)
2254 */
2255typedef struct X86PDPE1GB
2256{
2257 /** 0: Flags whether(=1) or not the page is present. */
2258 uint32_t u1Present : 1;
2259 /** 1: Read(=0) / Write(=1) flag. */
2260 uint32_t u1Write : 1;
2261 /** 2: User(=1) / Supervisor (=0) flag. */
2262 uint32_t u1User : 1;
2263 /** 3: Write Thru flag. If PAT enabled, bit 0 of the index. */
2264 uint32_t u1WriteThru : 1;
2265 /** 4: Cache disabled flag. If PAT enabled, bit 1 of the index. */
2266 uint32_t u1CacheDisable : 1;
2267 /** 5: Accessed flag.
2268 * Indicates that the page have been read or written to. */
2269 uint32_t u1Accessed : 1;
2270 /** 6: Dirty flag for 1GB pages. */
2271 uint32_t u1Dirty : 1;
2272 /** 7: Indicates 1GB page if set. */
2273 uint32_t u1Size : 1;
2274 /** 8: Global 1GB page. */
2275 uint32_t u1Global: 1;
2276 /** 9-11: Available for use to system software. */
2277 uint32_t u3Available : 3;
2278 /** 12: PAT bit for 1GB page. */
2279 uint32_t u1PAT : 1;
2280 /** 13-29: MBZ bits. */
2281 uint32_t u17Reserved : 17;
2282 /** 30-31: Physical page number - Low Part. Don't use! */
2283 uint32_t u2PageNoLow : 2;
2284 /** 32-51: Physical Page number of the next level - High Part. Don't use! */
2285 uint32_t u20PageNoHigh : 20;
2286 /** 52-62: MBZ bits */
2287 uint32_t u11Reserved : 11;
2288 /** 63: No Execute flag. */
2289 uint32_t u1NoExecute : 1;
2290} X86PDPE1GB;
2291#ifndef VBOX_FOR_DTRACE_LIB
2292AssertCompileSize(X86PDPE1GB, 8);
2293#endif
2294/** Pointer to a page directory pointer table entry for a 1GB page. */
2295typedef X86PDPE1GB *PX86PDPE1GB;
2296/** Pointer to a const page directory pointer table entry for a 1GB page. */
2297typedef const X86PDPE1GB *PCX86PDPE1GB;
2298
2299/**
2300 * Page directory pointer table entry.
2301 */
2302typedef union X86PDPE
2303{
2304 /** Unsigned integer view. */
2305 X86PGPAEUINT u;
2306 /** Normal view. */
2307 X86PDPEBITS n;
2308 /** AMD64 view. */
2309 X86PDPEAMD64BITS lm;
2310 /** AMD64 big view. */
2311 X86PDPE1GB b;
2312 /** 8 bit unsigned integer view. */
2313 uint8_t au8[8];
2314 /** 16 bit unsigned integer view. */
2315 uint16_t au16[4];
2316 /** 32 bit unsigned integer view. */
2317 uint32_t au32[2];
2318} X86PDPE;
2319#ifndef VBOX_FOR_DTRACE_LIB
2320AssertCompileSize(X86PDPE, 8);
2321#endif
2322/** Pointer to a page directory pointer table entry. */
2323typedef X86PDPE *PX86PDPE;
2324/** Pointer to a const page directory pointer table entry. */
2325typedef const X86PDPE *PCX86PDPE;
2326
2327
2328/**
2329 * Page directory pointer table.
2330 */
2331typedef struct X86PDPT
2332{
2333 /** PDE Array. */
2334 X86PDPE a[X86_PG_AMD64_PDPE_ENTRIES];
2335} X86PDPT;
2336#ifndef VBOX_FOR_DTRACE_LIB
2337AssertCompileSize(X86PDPT, 4096);
2338#endif
2339/** Pointer to a page directory pointer table. */
2340typedef X86PDPT *PX86PDPT;
2341/** Pointer to a const page directory pointer table. */
2342typedef const X86PDPT *PCX86PDPT;
2343
2344/** The page shift to get the PDPT index. */
2345#define X86_PDPT_SHIFT 30
2346/** The PDPT index mask (apply to a shifted page address). (32 bits PAE) */
2347#define X86_PDPT_MASK_PAE 0x3
2348/** The PDPT index mask (apply to a shifted page address). (64 bits PAE)*/
2349#define X86_PDPT_MASK_AMD64 0x1ff
2350
2351/** @} */
2352
2353
2354/** @name Page Map Level-4 Entry (Long Mode PAE)
2355 * @{
2356 */
2357/** Bit 0 - P - Present bit. */
2358#define X86_PML4E_P RT_BIT_32(0)
2359/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
2360#define X86_PML4E_RW RT_BIT_32(1)
2361/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
2362#define X86_PML4E_US RT_BIT_32(2)
2363/** Bit 3 - PWT - Page level write thru bit. */
2364#define X86_PML4E_PWT RT_BIT_32(3)
2365/** Bit 4 - PCD - Page level cache disable bit. */
2366#define X86_PML4E_PCD RT_BIT_32(4)
2367/** Bit 5 - A - Access bit. */
2368#define X86_PML4E_A RT_BIT_32(5)
2369/** Bits 9-11 - - Available for use to system software. */
2370#define X86_PML4E_AVL_MASK (RT_BIT_32(9) | RT_BIT_32(10) | RT_BIT_32(11))
2371/** Bits 12-51 - - PAE - Physical Page number of the next level. */
2372#define X86_PML4E_PG_MASK UINT64_C(0x000ffffffffff000)
2373/** Bits 8, 7 - - MBZ bits when NX is active. */
2374#define X86_PML4E_MBZ_MASK_NX UINT64_C(0x0000000000000080)
2375/** Bits 63, 7 - - MBZ bits when no NX. */
2376#define X86_PML4E_MBZ_MASK_NO_NX UINT64_C(0x8000000000000080)
2377/** Bits 63 - NX - PAE - No execution flag. */
2378#define X86_PML4E_NX RT_BIT_64(63)
2379
2380/**
2381 * Page Map Level-4 Entry
2382 */
2383typedef struct X86PML4EBITS
2384{
2385 /** Flags whether(=1) or not the page is present. */
2386 uint32_t u1Present : 1;
2387 /** Read(=0) / Write(=1) flag. */
2388 uint32_t u1Write : 1;
2389 /** User(=1) / Supervisor (=0) flag. */
2390 uint32_t u1User : 1;
2391 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
2392 uint32_t u1WriteThru : 1;
2393 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
2394 uint32_t u1CacheDisable : 1;
2395 /** Accessed flag.
2396 * Indicates that the page have been read or written to. */
2397 uint32_t u1Accessed : 1;
2398 /** Chunk of reserved bits. */
2399 uint32_t u3Reserved : 3;
2400 /** Available for use to system software. */
2401 uint32_t u3Available : 3;
2402 /** Physical Page number of the next level - Low Part. Don't use! */
2403 uint32_t u20PageNoLow : 20;
2404 /** Physical Page number of the next level - High Part. Don't use! */
2405 uint32_t u20PageNoHigh : 20;
2406 /** MBZ bits */
2407 uint32_t u11Reserved : 11;
2408 /** No Execute flag. */
2409 uint32_t u1NoExecute : 1;
2410} X86PML4EBITS;
2411#ifndef VBOX_FOR_DTRACE_LIB
2412AssertCompileSize(X86PML4EBITS, 8);
2413#endif
2414/** Pointer to a page map level-4 entry. */
2415typedef X86PML4EBITS *PX86PML4EBITS;
2416/** Pointer to a const page map level-4 entry. */
2417typedef const X86PML4EBITS *PCX86PML4EBITS;
2418
2419/**
2420 * Page Map Level-4 Entry.
2421 */
2422typedef union X86PML4E
2423{
2424 /** Unsigned integer view. */
2425 X86PGPAEUINT u;
2426 /** Normal view. */
2427 X86PML4EBITS n;
2428 /** 8 bit unsigned integer view. */
2429 uint8_t au8[8];
2430 /** 16 bit unsigned integer view. */
2431 uint16_t au16[4];
2432 /** 32 bit unsigned integer view. */
2433 uint32_t au32[2];
2434} X86PML4E;
2435#ifndef VBOX_FOR_DTRACE_LIB
2436AssertCompileSize(X86PML4E, 8);
2437#endif
2438/** Pointer to a page map level-4 entry. */
2439typedef X86PML4E *PX86PML4E;
2440/** Pointer to a const page map level-4 entry. */
2441typedef const X86PML4E *PCX86PML4E;
2442
2443
2444/**
2445 * Page Map Level-4.
2446 */
2447typedef struct X86PML4
2448{
2449 /** PDE Array. */
2450 X86PML4E a[X86_PG_PAE_ENTRIES];
2451} X86PML4;
2452#ifndef VBOX_FOR_DTRACE_LIB
2453AssertCompileSize(X86PML4, 4096);
2454#endif
2455/** Pointer to a page map level-4. */
2456typedef X86PML4 *PX86PML4;
2457/** Pointer to a const page map level-4. */
2458typedef const X86PML4 *PCX86PML4;
2459
2460/** The page shift to get the PML4 index. */
2461#define X86_PML4_SHIFT 39
2462/** The PML4 index mask (apply to a shifted page address). */
2463#define X86_PML4_MASK 0x1ff
2464
2465/** @} */
2466
2467/** @} */
2468
2469/**
2470 * 32-bit protected mode FSTENV image.
2471 */
2472typedef struct X86FSTENV32P
2473{
2474 uint16_t FCW;
2475 uint16_t padding1;
2476 uint16_t FSW;
2477 uint16_t padding2;
2478 uint16_t FTW;
2479 uint16_t padding3;
2480 uint32_t FPUIP;
2481 uint16_t FPUCS;
2482 uint16_t FOP;
2483 uint32_t FPUDP;
2484 uint16_t FPUDS;
2485 uint16_t padding4;
2486} X86FSTENV32P;
2487/** Pointer to a 32-bit protected mode FSTENV image. */
2488typedef X86FSTENV32P *PX86FSTENV32P;
2489/** Pointer to a const 32-bit protected mode FSTENV image. */
2490typedef X86FSTENV32P const *PCX86FSTENV32P;
2491
2492
2493/**
2494 * 80-bit MMX/FPU register type.
2495 */
2496typedef struct X86FPUMMX
2497{
2498 uint8_t reg[10];
2499} X86FPUMMX;
2500#ifndef VBOX_FOR_DTRACE_LIB
2501AssertCompileSize(X86FPUMMX, 10);
2502#endif
2503/** Pointer to a 80-bit MMX/FPU register type. */
2504typedef X86FPUMMX *PX86FPUMMX;
2505/** Pointer to a const 80-bit MMX/FPU register type. */
2506typedef const X86FPUMMX *PCX86FPUMMX;
2507
2508/** FPU (x87) register. */
2509typedef union X86FPUREG
2510{
2511 /** MMX view. */
2512 uint64_t mmx;
2513 /** FPU view - todo. */
2514 X86FPUMMX fpu;
2515 /** Extended precision floating point view. */
2516 RTFLOAT80U r80;
2517 /** Extended precision floating point view v2 */
2518 RTFLOAT80U2 r80Ex;
2519 /** 8-bit view. */
2520 uint8_t au8[16];
2521 /** 16-bit view. */
2522 uint16_t au16[8];
2523 /** 32-bit view. */
2524 uint32_t au32[4];
2525 /** 64-bit view. */
2526 uint64_t au64[2];
2527 /** 128-bit view. (yeah, very helpful) */
2528 uint128_t au128[1];
2529} X86FPUREG;
2530#ifndef VBOX_FOR_DTRACE_LIB
2531AssertCompileSize(X86FPUREG, 16);
2532#endif
2533/** Pointer to a FPU register. */
2534typedef X86FPUREG *PX86FPUREG;
2535/** Pointer to a const FPU register. */
2536typedef X86FPUREG const *PCX86FPUREG;
2537
2538/**
2539 * XMM register union.
2540 */
2541typedef union X86XMMREG
2542{
2543 /** XMM Register view *. */
2544 uint128_t xmm;
2545 /** 8-bit view. */
2546 uint8_t au8[16];
2547 /** 16-bit view. */
2548 uint16_t au16[8];
2549 /** 32-bit view. */
2550 uint32_t au32[4];
2551 /** 64-bit view. */
2552 uint64_t au64[2];
2553 /** 128-bit view. (yeah, very helpful) */
2554 uint128_t au128[1];
2555} X86XMMREG;
2556#ifndef VBOX_FOR_DTRACE_LIB
2557AssertCompileSize(X86XMMREG, 16);
2558#endif
2559/** Pointer to an XMM register state. */
2560typedef X86XMMREG *PX86XMMREG;
2561/** Pointer to a const XMM register state. */
2562typedef X86XMMREG const *PCX86XMMREG;
2563
2564/**
2565 * YMM register union.
2566 */
2567typedef union X86YMMREG
2568{
2569 /** 8-bit view. */
2570 uint8_t au8[32];
2571 /** 16-bit view. */
2572 uint16_t au16[16];
2573 /** 32-bit view. */
2574 uint32_t au32[8];
2575 /** 64-bit view. */
2576 uint64_t au64[4];
2577 /** 128-bit view. (yeah, very helpful) */
2578 uint128_t au128[2];
2579 /** XMM sub register view. */
2580 X86XMMREG aXmm[2];
2581} X86YMMREG;
2582#ifndef VBOX_FOR_DTRACE_LIB
2583AssertCompileSize(X86YMMREG, 32);
2584#endif
2585/** Pointer to an YMM register state. */
2586typedef X86YMMREG *PX86YMMREG;
2587/** Pointer to a const YMM register state. */
2588typedef X86YMMREG const *PCX86YMMREG;
2589
2590/**
2591 * ZMM register union.
2592 */
2593typedef union X86ZMMREG
2594{
2595 /** 8-bit view. */
2596 uint8_t au8[64];
2597 /** 16-bit view. */
2598 uint16_t au16[32];
2599 /** 32-bit view. */
2600 uint32_t au32[16];
2601 /** 64-bit view. */
2602 uint64_t au64[8];
2603 /** 128-bit view. (yeah, very helpful) */
2604 uint128_t au128[4];
2605 /** XMM sub register view. */
2606 X86XMMREG aXmm[4];
2607 /** YMM sub register view. */
2608 X86YMMREG aYmm[2];
2609} X86ZMMREG;
2610#ifndef VBOX_FOR_DTRACE_LIB
2611AssertCompileSize(X86ZMMREG, 64);
2612#endif
2613/** Pointer to an ZMM register state. */
2614typedef X86ZMMREG *PX86ZMMREG;
2615/** Pointer to a const ZMM register state. */
2616typedef X86ZMMREG const *PCX86ZMMREG;
2617
2618
2619/**
2620 * 32-bit FPU state (aka FSAVE/FRSTOR Memory Region).
2621 * @todo verify this...
2622 */
2623#pragma pack(1)
2624typedef struct X86FPUSTATE
2625{
2626 /** 0x00 - Control word. */
2627 uint16_t FCW;
2628 /** 0x02 - Alignment word */
2629 uint16_t Dummy1;
2630 /** 0x04 - Status word. */
2631 uint16_t FSW;
2632 /** 0x06 - Alignment word */
2633 uint16_t Dummy2;
2634 /** 0x08 - Tag word */
2635 uint16_t FTW;
2636 /** 0x0a - Alignment word */
2637 uint16_t Dummy3;
2638
2639 /** 0x0c - Instruction pointer. */
2640 uint32_t FPUIP;
2641 /** 0x10 - Code selector. */
2642 uint16_t CS;
2643 /** 0x12 - Opcode. */
2644 uint16_t FOP;
2645 /** 0x14 - FOO. */
2646 uint32_t FPUOO;
2647 /** 0x18 - FOS. */
2648 uint32_t FPUOS;
2649 /** 0x1c - FPU register. */
2650 X86FPUREG regs[8];
2651} X86FPUSTATE;
2652#pragma pack()
2653/** Pointer to a FPU state. */
2654typedef X86FPUSTATE *PX86FPUSTATE;
2655/** Pointer to a const FPU state. */
2656typedef const X86FPUSTATE *PCX86FPUSTATE;
2657
2658/**
2659 * FPU Extended state (aka FXSAVE/FXRSTORE Memory Region).
2660 */
2661#pragma pack(1)
2662typedef struct X86FXSTATE
2663{
2664 /** 0x00 - Control word. */
2665 uint16_t FCW;
2666 /** 0x02 - Status word. */
2667 uint16_t FSW;
2668 /** 0x04 - Tag word. (The upper byte is always zero.) */
2669 uint16_t FTW;
2670 /** 0x06 - Opcode. */
2671 uint16_t FOP;
2672 /** 0x08 - Instruction pointer. */
2673 uint32_t FPUIP;
2674 /** 0x0c - Code selector. */
2675 uint16_t CS;
2676 uint16_t Rsrvd1;
2677 /** 0x10 - Data pointer. */
2678 uint32_t FPUDP;
2679 /** 0x14 - Data segment */
2680 uint16_t DS;
2681 /** 0x16 */
2682 uint16_t Rsrvd2;
2683 /** 0x18 */
2684 uint32_t MXCSR;
2685 /** 0x1c */
2686 uint32_t MXCSR_MASK;
2687 /** 0x20 - FPU registers. */
2688 X86FPUREG aRegs[8];
2689 /** 0xA0 - XMM registers - 8 registers in 32 bits mode, 16 in long mode. */
2690 X86XMMREG aXMM[16];
2691 /* - offset 416 - */
2692 uint32_t au32RsrvdRest[(464 - 416) / sizeof(uint32_t)];
2693 /* - offset 464 - Software usable reserved bits. */
2694 uint32_t au32RsrvdForSoftware[(512 - 464) / sizeof(uint32_t)];
2695} X86FXSTATE;
2696#pragma pack()
2697/** Pointer to a FPU Extended state. */
2698typedef X86FXSTATE *PX86FXSTATE;
2699/** Pointer to a const FPU Extended state. */
2700typedef const X86FXSTATE *PCX86FXSTATE;
2701
2702/** Offset for software usable reserved bits (464:511) where we store a 32-bit
2703 * magic. Don't forget to update x86.mac if you change this! */
2704#define X86_OFF_FXSTATE_RSVD 0x1d0
2705/** The 32-bit magic used to recognize if this a 32-bit FPU state. Don't
2706 * forget to update x86.mac if you change this!
2707 * @todo r=bird: This has nothing what-so-ever to do here.... */
2708#define X86_FXSTATE_RSVD_32BIT_MAGIC 0x32b3232b
2709#ifndef VBOX_FOR_DTRACE_LIB
2710AssertCompileSize(X86FXSTATE, 512);
2711AssertCompileMemberOffset(X86FXSTATE, au32RsrvdForSoftware, X86_OFF_FXSTATE_RSVD);
2712#endif
2713
2714/** @name FPU status word flags.
2715 * @{ */
2716/** Exception Flag: Invalid operation. */
2717#define X86_FSW_IE RT_BIT_32(0)
2718/** Exception Flag: Denormalized operand. */
2719#define X86_FSW_DE RT_BIT_32(1)
2720/** Exception Flag: Zero divide. */
2721#define X86_FSW_ZE RT_BIT_32(2)
2722/** Exception Flag: Overflow. */
2723#define X86_FSW_OE RT_BIT_32(3)
2724/** Exception Flag: Underflow. */
2725#define X86_FSW_UE RT_BIT_32(4)
2726/** Exception Flag: Precision. */
2727#define X86_FSW_PE RT_BIT_32(5)
2728/** Stack fault. */
2729#define X86_FSW_SF RT_BIT_32(6)
2730/** Error summary status. */
2731#define X86_FSW_ES RT_BIT_32(7)
2732/** Mask of exceptions flags, excluding the summary bit. */
2733#define X86_FSW_XCPT_MASK UINT16_C(0x007f)
2734/** Mask of exceptions flags, including the summary bit. */
2735#define X86_FSW_XCPT_ES_MASK UINT16_C(0x00ff)
2736/** Condition code 0. */
2737#define X86_FSW_C0 RT_BIT_32(8)
2738/** Condition code 1. */
2739#define X86_FSW_C1 RT_BIT_32(9)
2740/** Condition code 2. */
2741#define X86_FSW_C2 RT_BIT_32(10)
2742/** Top of the stack mask. */
2743#define X86_FSW_TOP_MASK UINT16_C(0x3800)
2744/** TOP shift value. */
2745#define X86_FSW_TOP_SHIFT 11
2746/** Mask for getting TOP value after shifting it right. */
2747#define X86_FSW_TOP_SMASK UINT16_C(0x0007)
2748/** Get the TOP value. */
2749#define X86_FSW_TOP_GET(a_uFsw) (((a_uFsw) >> X86_FSW_TOP_SHIFT) & X86_FSW_TOP_SMASK)
2750/** Condition code 3. */
2751#define X86_FSW_C3 RT_BIT_32(14)
2752/** Mask of exceptions flags, including the summary bit. */
2753#define X86_FSW_C_MASK UINT16_C(0x4700)
2754/** FPU busy. */
2755#define X86_FSW_B RT_BIT_32(15)
2756/** @} */
2757
2758
2759/** @name FPU control word flags.
2760 * @{ */
2761/** Exception Mask: Invalid operation. */
2762#define X86_FCW_IM RT_BIT_32(0)
2763/** Exception Mask: Denormalized operand. */
2764#define X86_FCW_DM RT_BIT_32(1)
2765/** Exception Mask: Zero divide. */
2766#define X86_FCW_ZM RT_BIT_32(2)
2767/** Exception Mask: Overflow. */
2768#define X86_FCW_OM RT_BIT_32(3)
2769/** Exception Mask: Underflow. */
2770#define X86_FCW_UM RT_BIT_32(4)
2771/** Exception Mask: Precision. */
2772#define X86_FCW_PM RT_BIT_32(5)
2773/** Mask all exceptions, the value typically loaded (by for instance fninit).
2774 * @remarks This includes reserved bit 6. */
2775#define X86_FCW_MASK_ALL UINT16_C(0x007f)
2776/** Mask all exceptions. Same as X86_FSW_XCPT_MASK. */
2777#define X86_FCW_XCPT_MASK UINT16_C(0x003f)
2778/** Precision control mask. */
2779#define X86_FCW_PC_MASK UINT16_C(0x0300)
2780/** Precision control: 24-bit. */
2781#define X86_FCW_PC_24 UINT16_C(0x0000)
2782/** Precision control: Reserved. */
2783#define X86_FCW_PC_RSVD UINT16_C(0x0100)
2784/** Precision control: 53-bit. */
2785#define X86_FCW_PC_53 UINT16_C(0x0200)
2786/** Precision control: 64-bit. */
2787#define X86_FCW_PC_64 UINT16_C(0x0300)
2788/** Rounding control mask. */
2789#define X86_FCW_RC_MASK UINT16_C(0x0c00)
2790/** Rounding control: To nearest. */
2791#define X86_FCW_RC_NEAREST UINT16_C(0x0000)
2792/** Rounding control: Down. */
2793#define X86_FCW_RC_DOWN UINT16_C(0x0400)
2794/** Rounding control: Up. */
2795#define X86_FCW_RC_UP UINT16_C(0x0800)
2796/** Rounding control: Towards zero. */
2797#define X86_FCW_RC_ZERO UINT16_C(0x0c00)
2798/** Bits which should be zero, apparently. */
2799#define X86_FCW_ZERO_MASK UINT16_C(0xf080)
2800/** @} */
2801
2802/** @name SSE MXCSR
2803 * @{ */
2804/** Exception Flag: Invalid operation. */
2805#define X86_MXSCR_IE RT_BIT_32(0)
2806/** Exception Flag: Denormalized operand. */
2807#define X86_MXSCR_DE RT_BIT_32(1)
2808/** Exception Flag: Zero divide. */
2809#define X86_MXSCR_ZE RT_BIT_32(2)
2810/** Exception Flag: Overflow. */
2811#define X86_MXSCR_OE RT_BIT_32(3)
2812/** Exception Flag: Underflow. */
2813#define X86_MXSCR_UE RT_BIT_32(4)
2814/** Exception Flag: Precision. */
2815#define X86_MXSCR_PE RT_BIT_32(5)
2816
2817/** Denormals are zero. */
2818#define X86_MXSCR_DAZ RT_BIT_32(6)
2819
2820/** Exception Mask: Invalid operation. */
2821#define X86_MXSCR_IM RT_BIT_32(7)
2822/** Exception Mask: Denormalized operand. */
2823#define X86_MXSCR_DM RT_BIT_32(8)
2824/** Exception Mask: Zero divide. */
2825#define X86_MXSCR_ZM RT_BIT_32(9)
2826/** Exception Mask: Overflow. */
2827#define X86_MXSCR_OM RT_BIT_32(10)
2828/** Exception Mask: Underflow. */
2829#define X86_MXSCR_UM RT_BIT_32(11)
2830/** Exception Mask: Precision. */
2831#define X86_MXSCR_PM RT_BIT_32(12)
2832
2833/** Rounding control mask. */
2834#define X86_MXSCR_RC_MASK UINT16_C(0x6000)
2835/** Rounding control: To nearest. */
2836#define X86_MXSCR_RC_NEAREST UINT16_C(0x0000)
2837/** Rounding control: Down. */
2838#define X86_MXSCR_RC_DOWN UINT16_C(0x2000)
2839/** Rounding control: Up. */
2840#define X86_MXSCR_RC_UP UINT16_C(0x4000)
2841/** Rounding control: Towards zero. */
2842#define X86_MXSCR_RC_ZERO UINT16_C(0x6000)
2843
2844/** Flush-to-zero for masked underflow. */
2845#define X86_MXSCR_FZ RT_BIT_32(15)
2846
2847/** Misaligned Exception Mask (AMD MISALIGNSSE). */
2848#define X86_MXSCR_MM RT_BIT_32(17)
2849/** @} */
2850
2851/**
2852 * XSAVE header.
2853 */
2854typedef struct X86XSAVEHDR
2855{
2856 /** XTATE_BV - Bitmap indicating whether a component is in the state. */
2857 uint64_t bmXState;
2858 /** XCOMP_BC - Bitmap used by instructions applying structure compaction. */
2859 uint64_t bmXComp;
2860 /** Reserved for furture extensions, probably MBZ. */
2861 uint64_t au64Reserved[6];
2862} X86XSAVEHDR;
2863#ifndef VBOX_FOR_DTRACE_LIB
2864AssertCompileSize(X86XSAVEHDR, 64);
2865#endif
2866/** Pointer to an XSAVE header. */
2867typedef X86XSAVEHDR *PX86XSAVEHDR;
2868/** Pointer to a const XSAVE header. */
2869typedef X86XSAVEHDR const *PCX86XSAVEHDR;
2870
2871
2872/**
2873 * The high 128-bit YMM register state (XSAVE_C_YMM).
2874 * (The lower 128-bits being in X86FXSTATE.)
2875 */
2876typedef struct X86XSAVEYMMHI
2877{
2878 /** 16 registers in 64-bit mode, 8 in 32-bit mode. */
2879 X86XMMREG aYmmHi[16];
2880} X86XSAVEYMMHI;
2881#ifndef VBOX_FOR_DTRACE_LIB
2882AssertCompileSize(X86XSAVEYMMHI, 256);
2883#endif
2884/** Pointer to a high 128-bit YMM register state. */
2885typedef X86XSAVEYMMHI *PX86XSAVEYMMHI;
2886/** Pointer to a const high 128-bit YMM register state. */
2887typedef X86XSAVEYMMHI const *PCX86XSAVEYMMHI;
2888
2889/**
2890 * Intel MPX bound registers state (XSAVE_C_BNDREGS).
2891 */
2892typedef struct X86XSAVEBNDREGS
2893{
2894 /** Array of registers (BND0...BND3). */
2895 struct
2896 {
2897 /** Lower bound. */
2898 uint64_t uLowerBound;
2899 /** Upper bound. */
2900 uint64_t uUpperBound;
2901 } aRegs[4];
2902} X86XSAVEBNDREGS;
2903#ifndef VBOX_FOR_DTRACE_LIB
2904AssertCompileSize(X86XSAVEBNDREGS, 64);
2905#endif
2906/** Pointer to a MPX bound register state. */
2907typedef X86XSAVEBNDREGS *PX86XSAVEBNDREGS;
2908/** Pointer to a const MPX bound register state. */
2909typedef X86XSAVEBNDREGS const *PCX86XSAVEBNDREGS;
2910
2911/**
2912 * Intel MPX bound config and status register state (XSAVE_C_BNDCSR).
2913 */
2914typedef struct X86XSAVEBNDCFG
2915{
2916 uint64_t fConfig;
2917 uint64_t fStatus;
2918} X86XSAVEBNDCFG;
2919#ifndef VBOX_FOR_DTRACE_LIB
2920AssertCompileSize(X86XSAVEBNDCFG, 16);
2921#endif
2922/** Pointer to a MPX bound config and status register state. */
2923typedef X86XSAVEBNDCFG *PX86XSAVEBNDCFG;
2924/** Pointer to a const MPX bound config and status register state. */
2925typedef X86XSAVEBNDCFG *PCX86XSAVEBNDCFG;
2926
2927/**
2928 * AVX-512 opmask state (XSAVE_C_OPMASK).
2929 */
2930typedef struct X86XSAVEOPMASK
2931{
2932 /** The K0..K7 values. */
2933 uint64_t aKRegs[8];
2934} X86XSAVEOPMASK;
2935#ifndef VBOX_FOR_DTRACE_LIB
2936AssertCompileSize(X86XSAVEOPMASK, 64);
2937#endif
2938/** Pointer to a AVX-512 opmask state. */
2939typedef X86XSAVEOPMASK *PX86XSAVEOPMASK;
2940/** Pointer to a const AVX-512 opmask state. */
2941typedef X86XSAVEOPMASK const *PCX86XSAVEOPMASK;
2942
2943/**
2944 * ZMM0-15 upper 256 bits introduced in AVX-512 (XSAVE_C_ZMM_HI256).
2945 */
2946typedef struct X86XSAVEZMMHI256
2947{
2948 /** Upper 256-bits of ZMM0-15. */
2949 X86YMMREG aHi256Regs[16];
2950} X86XSAVEZMMHI256;
2951#ifndef VBOX_FOR_DTRACE_LIB
2952AssertCompileSize(X86XSAVEZMMHI256, 512);
2953#endif
2954/** Pointer to a state comprising the upper 256-bits of ZMM0-15. */
2955typedef X86XSAVEZMMHI256 *PX86XSAVEZMMHI256;
2956/** Pointer to a const state comprising the upper 256-bits of ZMM0-15. */
2957typedef X86XSAVEZMMHI256 const *PCX86XSAVEZMMHI256;
2958
2959/**
2960 * ZMM16-31 register state introduced in AVX-512 (XSAVE_C_ZMM_16HI).
2961 */
2962typedef struct X86XSAVEZMM16HI
2963{
2964 /** ZMM16 thru ZMM31. */
2965 X86ZMMREG aRegs[16];
2966} X86XSAVEZMM16HI;
2967#ifndef VBOX_FOR_DTRACE_LIB
2968AssertCompileSize(X86XSAVEZMM16HI, 1024);
2969#endif
2970/** Pointer to a state comprising ZMM16-32. */
2971typedef X86XSAVEZMM16HI *PX86XSAVEZMM16HI;
2972/** Pointer to a const state comprising ZMM16-32. */
2973typedef X86XSAVEZMM16HI const *PCX86XSAVEZMM16HI;
2974
2975/**
2976 * AMD Light weight profiling state (XSAVE_C_LWP).
2977 *
2978 * We probably won't play with this as AMD seems to be dropping from their "zen"
2979 * processor micro architecture.
2980 */
2981typedef struct X86XSAVELWP
2982{
2983 /** Details when needed. */
2984 uint64_t auLater[128/8];
2985} X86XSAVELWP;
2986#ifndef VBOX_FOR_DTRACE_LIB
2987AssertCompileSize(X86XSAVELWP, 128);
2988#endif
2989
2990
2991/**
2992 * x86 FPU/SSE/AVX/XXXX state.
2993 *
2994 * Please bump DBGFCORE_FMT_VERSION by 1 in dbgfcorefmt.h if you make any
2995 * changes to this structure.
2996 */
2997typedef struct X86XSAVEAREA
2998{
2999 /** The x87 and SSE region (or legacy region if you like). */
3000 X86FXSTATE x87;
3001 /** The XSAVE header. */
3002 X86XSAVEHDR Hdr;
3003 /** Beyond the header, there isn't really a fixed layout, but we can
3004 generally assume the YMM (AVX) register extensions are present and
3005 follows immediately. */
3006 union
3007 {
3008 /** This is a typical layout on intel CPUs (good for debuggers). */
3009 struct
3010 {
3011 X86XSAVEYMMHI YmmHi;
3012 X86XSAVEBNDREGS BndRegs;
3013 X86XSAVEBNDCFG BndCfg;
3014 uint8_t abFudgeToMatchDocs[0xB0];
3015 X86XSAVEOPMASK Opmask;
3016 X86XSAVEZMMHI256 ZmmHi256;
3017 X86XSAVEZMM16HI Zmm16Hi;
3018 } Intel;
3019
3020 /** This is a typical layout on AMD Bulldozer type CPUs (good for debuggers). */
3021 struct
3022 {
3023 X86XSAVEYMMHI YmmHi;
3024 X86XSAVELWP Lwp;
3025 } AmdBd;
3026
3027 /** To enbling static deployments that have a reasonable chance of working for
3028 * the next 3-6 CPU generations without running short on space, we allocate a
3029 * lot of extra space here, making the structure a round 8KB in size. This
3030 * leaves us 7616 bytes for extended state. The skylake xeons are likely to use
3031 * 2112 of these, leaving us with 5504 bytes for future Intel generations. */
3032 uint8_t ab[8192 - 512 - 64];
3033 } u;
3034} X86XSAVEAREA;
3035#ifndef VBOX_FOR_DTRACE_LIB
3036AssertCompileSize(X86XSAVEAREA, 8192);
3037AssertCompileMemberSize(X86XSAVEAREA, u.Intel, 0x840 /*2112 => total 0xa80 (2688) */);
3038AssertCompileMemberOffset(X86XSAVEAREA, Hdr, 0x200);
3039AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.YmmHi, 0x240);
3040AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.BndRegs, 0x340);
3041AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.BndCfg, 0x380);
3042AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.Opmask, 0x440 /* 1088 */);
3043AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.ZmmHi256, 0x480 /* 1152 */);
3044AssertCompileMemberOffset(X86XSAVEAREA, u.Intel.Zmm16Hi, 0x680 /* 1664 */);
3045#endif
3046/** Pointer to a XSAVE area. */
3047typedef X86XSAVEAREA *PX86XSAVEAREA;
3048/** Pointer to a const XSAVE area. */
3049typedef X86XSAVEAREA const *PCX86XSAVEAREA;
3050
3051
3052/** @name XSAVE_C_XXX - XSAVE State Components Bits.
3053 * @{ */
3054/** Bit 0 - x87 - Legacy FPU state (bit number) */
3055#define XSAVE_C_X87_BIT 0
3056/** Bit 0 - x87 - Legacy FPU state. */
3057#define XSAVE_C_X87 RT_BIT_64(XSAVE_C_X87_BIT)
3058/** Bit 1 - SSE - 128-bit SSE state (bit number). */
3059#define XSAVE_C_SSE_BIT 1
3060/** Bit 1 - SSE - 128-bit SSE state. */
3061#define XSAVE_C_SSE RT_BIT_64(XSAVE_C_SSE_BIT)
3062/** Bit 2 - YMM_Hi128 - Upper 128 bits of YMM0-15 (AVX) (bit number). */
3063#define XSAVE_C_YMM_BIT 2
3064/** Bit 2 - YMM_Hi128 - Upper 128 bits of YMM0-15 (AVX). */
3065#define XSAVE_C_YMM RT_BIT_64(XSAVE_C_YMM_BIT)
3066/** Bit 3 - BNDREGS - MPX bound register state (bit number). */
3067#define XSAVE_C_BNDREGS_BIT 3
3068/** Bit 3 - BNDREGS - MPX bound register state. */
3069#define XSAVE_C_BNDREGS RT_BIT_64(XSAVE_C_BNDREGS_BIT)
3070/** Bit 4 - BNDCSR - MPX bound config and status state (bit number). */
3071#define XSAVE_C_BNDCSR_BIT 4
3072/** Bit 4 - BNDCSR - MPX bound config and status state. */
3073#define XSAVE_C_BNDCSR RT_BIT_64(XSAVE_C_BNDCSR_BIT)
3074/** Bit 5 - Opmask - opmask state (bit number). */
3075#define XSAVE_C_OPMASK_BIT 5
3076/** Bit 5 - Opmask - opmask state. */
3077#define XSAVE_C_OPMASK RT_BIT_64(XSAVE_C_OPMASK_BIT)
3078/** Bit 6 - ZMM_Hi256 - Upper 256 bits of ZMM0-15 (AVX-512) (bit number). */
3079#define XSAVE_C_ZMM_HI256_BIT 6
3080/** Bit 6 - ZMM_Hi256 - Upper 256 bits of ZMM0-15 (AVX-512). */
3081#define XSAVE_C_ZMM_HI256 RT_BIT_64(XSAVE_C_ZMM_HI256_BIT)
3082/** Bit 7 - Hi16_ZMM - 512-bits ZMM16-31 state (AVX-512) (bit number). */
3083#define XSAVE_C_ZMM_16HI_BIT 7
3084/** Bit 7 - Hi16_ZMM - 512-bits ZMM16-31 state (AVX-512). */
3085#define XSAVE_C_ZMM_16HI RT_BIT_64(XSAVE_C_ZMM_16HI_BIT)
3086/** Bit 9 - PKRU - Protection-key state (bit number). */
3087#define XSAVE_C_PKRU_BIT 9
3088/** Bit 9 - PKRU - Protection-key state. */
3089#define XSAVE_C_PKRU RT_BIT_64(XSAVE_C_PKRU_BIT)
3090/** Bit 62 - LWP - Lightweight Profiling (AMD) (bit number). */
3091#define XSAVE_C_LWP_BIT 62
3092/** Bit 62 - LWP - Lightweight Profiling (AMD). */
3093#define XSAVE_C_LWP RT_BIT_64(XSAVE_C_LWP_BIT)
3094/** @} */
3095
3096
3097
3098/** @name Selector Descriptor
3099 * @{
3100 */
3101
3102#ifndef VBOX_FOR_DTRACE_LIB
3103/**
3104 * Descriptor attributes (as seen by VT-x).
3105 */
3106typedef struct X86DESCATTRBITS
3107{
3108 /** 00 - Segment Type. */
3109 unsigned u4Type : 4;
3110 /** 04 - Descriptor Type. System(=0) or code/data selector */
3111 unsigned u1DescType : 1;
3112 /** 05 - Descriptor Privilege level. */
3113 unsigned u2Dpl : 2;
3114 /** 07 - Flags selector present(=1) or not. */
3115 unsigned u1Present : 1;
3116 /** 08 - Segment limit 16-19. */
3117 unsigned u4LimitHigh : 4;
3118 /** 0c - Available for system software. */
3119 unsigned u1Available : 1;
3120 /** 0d - 32 bits mode: Reserved - 0, long mode: Long Attribute Bit. */
3121 unsigned u1Long : 1;
3122 /** 0e - This flags meaning depends on the segment type. Try make sense out
3123 * of the intel manual yourself. */
3124 unsigned u1DefBig : 1;
3125 /** 0f - Granularity of the limit. If set 4KB granularity is used, if
3126 * clear byte. */
3127 unsigned u1Granularity : 1;
3128 /** 10 - "Unusable" selector, special Intel (VT-x only?) bit. */
3129 unsigned u1Unusable : 1;
3130} X86DESCATTRBITS;
3131#endif /* !VBOX_FOR_DTRACE_LIB */
3132
3133/** @name X86DESCATTR masks
3134 * @{ */
3135#define X86DESCATTR_TYPE UINT32_C(0x0000000f)
3136#define X86DESCATTR_DT UINT32_C(0x00000010)
3137#define X86DESCATTR_DPL UINT32_C(0x00000060)
3138#define X86DESCATTR_DPL_SHIFT 5 /**< Shift count for the DPL value. */
3139#define X86DESCATTR_P UINT32_C(0x00000080)
3140#define X86DESCATTR_LIMIT_HIGH UINT32_C(0x00000f00)
3141#define X86DESCATTR_AVL UINT32_C(0x00001000)
3142#define X86DESCATTR_L UINT32_C(0x00002000)
3143#define X86DESCATTR_D UINT32_C(0x00004000)
3144#define X86DESCATTR_G UINT32_C(0x00008000)
3145#define X86DESCATTR_UNUSABLE UINT32_C(0x00010000)
3146/** @} */
3147
3148#pragma pack(1)
3149typedef union X86DESCATTR
3150{
3151 /** Unsigned integer view. */
3152 uint32_t u;
3153#ifndef VBOX_FOR_DTRACE_LIB
3154 /** Normal view. */
3155 X86DESCATTRBITS n;
3156#endif
3157} X86DESCATTR;
3158#pragma pack()
3159/** Pointer to descriptor attributes. */
3160typedef X86DESCATTR *PX86DESCATTR;
3161/** Pointer to const descriptor attributes. */
3162typedef const X86DESCATTR *PCX86DESCATTR;
3163
3164#ifndef VBOX_FOR_DTRACE_LIB
3165
3166/**
3167 * Generic descriptor table entry
3168 */
3169#pragma pack(1)
3170typedef struct X86DESCGENERIC
3171{
3172 /** 00 - Limit - Low word. */
3173 unsigned u16LimitLow : 16;
3174 /** 10 - Base address - low word.
3175 * Don't try set this to 24 because MSC is doing stupid things then. */
3176 unsigned u16BaseLow : 16;
3177 /** 20 - Base address - first 8 bits of high word. */
3178 unsigned u8BaseHigh1 : 8;
3179 /** 28 - Segment Type. */
3180 unsigned u4Type : 4;
3181 /** 2c - Descriptor Type. System(=0) or code/data selector */
3182 unsigned u1DescType : 1;
3183 /** 2d - Descriptor Privilege level. */
3184 unsigned u2Dpl : 2;
3185 /** 2f - Flags selector present(=1) or not. */
3186 unsigned u1Present : 1;
3187 /** 30 - Segment limit 16-19. */
3188 unsigned u4LimitHigh : 4;
3189 /** 34 - Available for system software. */
3190 unsigned u1Available : 1;
3191 /** 35 - 32 bits mode: Reserved - 0, long mode: Long Attribute Bit. */
3192 unsigned u1Long : 1;
3193 /** 36 - This flags meaning depends on the segment type. Try make sense out
3194 * of the intel manual yourself. */
3195 unsigned u1DefBig : 1;
3196 /** 37 - Granularity of the limit. If set 4KB granularity is used, if
3197 * clear byte. */
3198 unsigned u1Granularity : 1;
3199 /** 38 - Base address - highest 8 bits. */
3200 unsigned u8BaseHigh2 : 8;
3201} X86DESCGENERIC;
3202#pragma pack()
3203/** Pointer to a generic descriptor entry. */
3204typedef X86DESCGENERIC *PX86DESCGENERIC;
3205/** Pointer to a const generic descriptor entry. */
3206typedef const X86DESCGENERIC *PCX86DESCGENERIC;
3207
3208/** @name Bit offsets of X86DESCGENERIC members.
3209 * @{*/
3210#define X86DESCGENERIC_BIT_OFF_LIMIT_LOW (0) /**< Bit offset of X86DESCGENERIC::u16LimitLow. */
3211#define X86DESCGENERIC_BIT_OFF_BASE_LOW (16) /**< Bit offset of X86DESCGENERIC::u16BaseLow. */
3212#define X86DESCGENERIC_BIT_OFF_BASE_HIGH1 (32) /**< Bit offset of X86DESCGENERIC::u8BaseHigh1. */
3213#define X86DESCGENERIC_BIT_OFF_TYPE (40) /**< Bit offset of X86DESCGENERIC::u4Type. */
3214#define X86DESCGENERIC_BIT_OFF_DESC_TYPE (44) /**< Bit offset of X86DESCGENERIC::u1DescType. */
3215#define X86DESCGENERIC_BIT_OFF_DPL (45) /**< Bit offset of X86DESCGENERIC::u2Dpl. */
3216#define X86DESCGENERIC_BIT_OFF_PRESENT (47) /**< Bit offset of X86DESCGENERIC::uu1Present. */
3217#define X86DESCGENERIC_BIT_OFF_LIMIT_HIGH (48) /**< Bit offset of X86DESCGENERIC::u4LimitHigh. */
3218#define X86DESCGENERIC_BIT_OFF_AVAILABLE (52) /**< Bit offset of X86DESCGENERIC::u1Available. */
3219#define X86DESCGENERIC_BIT_OFF_LONG (53) /**< Bit offset of X86DESCGENERIC::u1Long. */
3220#define X86DESCGENERIC_BIT_OFF_DEF_BIG (54) /**< Bit offset of X86DESCGENERIC::u1DefBig. */
3221#define X86DESCGENERIC_BIT_OFF_GRANULARITY (55) /**< Bit offset of X86DESCGENERIC::u1Granularity. */
3222#define X86DESCGENERIC_BIT_OFF_BASE_HIGH2 (56) /**< Bit offset of X86DESCGENERIC::u8BaseHigh2. */
3223/** @} */
3224
3225
3226/** @name LAR mask
3227 * @{ */
3228#define X86LAR_F_TYPE UINT16_C( 0x0f00)
3229#define X86LAR_F_DT UINT16_C( 0x1000)
3230#define X86LAR_F_DPL UINT16_C( 0x6000)
3231#define X86LAR_F_DPL_SHIFT 13 /**< Shift count for the DPL value. */
3232#define X86LAR_F_P UINT16_C( 0x8000)
3233#define X86LAR_F_AVL UINT32_C(0x00100000)
3234#define X86LAR_F_L UINT32_C(0x00200000)
3235#define X86LAR_F_D UINT32_C(0x00400000)
3236#define X86LAR_F_G UINT32_C(0x00800000)
3237/** @} */
3238
3239
3240/**
3241 * Call-, Interrupt-, Trap- or Task-gate descriptor (legacy).
3242 */
3243typedef struct X86DESCGATE
3244{
3245 /** 00 - Target code segment offset - Low word.
3246 * Ignored if task-gate. */
3247 unsigned u16OffsetLow : 16;
3248 /** 10 - Target code segment selector for call-, interrupt- and trap-gates,
3249 * TSS selector if task-gate. */
3250 unsigned u16Sel : 16;
3251 /** 20 - Number of parameters for a call-gate.
3252 * Ignored if interrupt-, trap- or task-gate. */
3253 unsigned u4ParmCount : 4;
3254 /** 24 - Reserved / ignored. */
3255 unsigned u4Reserved : 4;
3256 /** 28 - Segment Type. */
3257 unsigned u4Type : 4;
3258 /** 2c - Descriptor Type (0 = system). */
3259 unsigned u1DescType : 1;
3260 /** 2d - Descriptor Privilege level. */
3261 unsigned u2Dpl : 2;
3262 /** 2f - Flags selector present(=1) or not. */
3263 unsigned u1Present : 1;
3264 /** 30 - Target code segment offset - High word.
3265 * Ignored if task-gate. */
3266 unsigned u16OffsetHigh : 16;
3267} X86DESCGATE;
3268/** Pointer to a Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
3269typedef X86DESCGATE *PX86DESCGATE;
3270/** Pointer to a const Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
3271typedef const X86DESCGATE *PCX86DESCGATE;
3272
3273#endif /* VBOX_FOR_DTRACE_LIB */
3274
3275/**
3276 * Descriptor table entry.
3277 */
3278#pragma pack(1)
3279typedef union X86DESC
3280{
3281#ifndef VBOX_FOR_DTRACE_LIB
3282 /** Generic descriptor view. */
3283 X86DESCGENERIC Gen;
3284 /** Gate descriptor view. */
3285 X86DESCGATE Gate;
3286#endif
3287
3288 /** 8 bit unsigned integer view. */
3289 uint8_t au8[8];
3290 /** 16 bit unsigned integer view. */
3291 uint16_t au16[4];
3292 /** 32 bit unsigned integer view. */
3293 uint32_t au32[2];
3294 /** 64 bit unsigned integer view. */
3295 uint64_t au64[1];
3296 /** Unsigned integer view. */
3297 uint64_t u;
3298} X86DESC;
3299#ifndef VBOX_FOR_DTRACE_LIB
3300AssertCompileSize(X86DESC, 8);
3301#endif
3302#pragma pack()
3303/** Pointer to descriptor table entry. */
3304typedef X86DESC *PX86DESC;
3305/** Pointer to const descriptor table entry. */
3306typedef const X86DESC *PCX86DESC;
3307
3308/** @def X86DESC_BASE
3309 * Return the base address of a descriptor.
3310 */
3311#define X86DESC_BASE(a_pDesc) /*ASM-NOINC*/ \
3312 ( ((uint32_t)((a_pDesc)->Gen.u8BaseHigh2) << 24) \
3313 | ( (a_pDesc)->Gen.u8BaseHigh1 << 16) \
3314 | ( (a_pDesc)->Gen.u16BaseLow ) )
3315
3316/** @def X86DESC_LIMIT
3317 * Return the limit of a descriptor.
3318 */
3319#define X86DESC_LIMIT(a_pDesc) /*ASM-NOINC*/ \
3320 ( ((uint32_t)((a_pDesc)->Gen.u4LimitHigh) << 16) \
3321 | ( (a_pDesc)->Gen.u16LimitLow ) )
3322
3323/** @def X86DESC_LIMIT_G
3324 * Return the limit of a descriptor with the granularity bit taken into account.
3325 * @returns Selector limit (uint32_t).
3326 * @param a_pDesc Pointer to the descriptor.
3327 */
3328#define X86DESC_LIMIT_G(a_pDesc) /*ASM-NOINC*/ \
3329 ( (a_pDesc)->Gen.u1Granularity \
3330 ? ( ( ((uint32_t)(a_pDesc)->Gen.u4LimitHigh << 16) | (a_pDesc)->Gen.u16LimitLow ) << 12 ) | UINT32_C(0xfff) \
3331 : ((uint32_t)(a_pDesc)->Gen.u4LimitHigh << 16) | (a_pDesc)->Gen.u16LimitLow \
3332 )
3333
3334/** @def X86DESC_GET_HID_ATTR
3335 * Get the descriptor attributes for the hidden register.
3336 */
3337#define X86DESC_GET_HID_ATTR(a_pDesc) /*ASM-NOINC*/ \
3338 ( ((a_pDesc)->u >> (16+16+8)) & UINT32_C(0xf0ff) ) /** @todo do we have a define for 0xf0ff? */
3339
3340#ifndef VBOX_FOR_DTRACE_LIB
3341
3342/**
3343 * 64 bits generic descriptor table entry
3344 * Note: most of these bits have no meaning in long mode.
3345 */
3346#pragma pack(1)
3347typedef struct X86DESC64GENERIC
3348{
3349 /** Limit - Low word - *IGNORED*. */
3350 uint32_t u16LimitLow : 16;
3351 /** Base address - low word. - *IGNORED*
3352 * Don't try set this to 24 because MSC is doing stupid things then. */
3353 uint32_t u16BaseLow : 16;
3354 /** Base address - first 8 bits of high word. - *IGNORED* */
3355 uint32_t u8BaseHigh1 : 8;
3356 /** Segment Type. */
3357 uint32_t u4Type : 4;
3358 /** Descriptor Type. System(=0) or code/data selector */
3359 uint32_t u1DescType : 1;
3360 /** Descriptor Privilege level. */
3361 uint32_t u2Dpl : 2;
3362 /** Flags selector present(=1) or not. */
3363 uint32_t u1Present : 1;
3364 /** Segment limit 16-19. - *IGNORED* */
3365 uint32_t u4LimitHigh : 4;
3366 /** Available for system software. - *IGNORED* */
3367 uint32_t u1Available : 1;
3368 /** Long mode flag. */
3369 uint32_t u1Long : 1;
3370 /** This flags meaning depends on the segment type. Try make sense out
3371 * of the intel manual yourself. */
3372 uint32_t u1DefBig : 1;
3373 /** Granularity of the limit. If set 4KB granularity is used, if
3374 * clear byte. - *IGNORED* */
3375 uint32_t u1Granularity : 1;
3376 /** Base address - highest 8 bits. - *IGNORED* */
3377 uint32_t u8BaseHigh2 : 8;
3378 /** Base address - bits 63-32. */
3379 uint32_t u32BaseHigh3 : 32;
3380 uint32_t u8Reserved : 8;
3381 uint32_t u5Zeros : 5;
3382 uint32_t u19Reserved : 19;
3383} X86DESC64GENERIC;
3384#pragma pack()
3385/** Pointer to a generic descriptor entry. */
3386typedef X86DESC64GENERIC *PX86DESC64GENERIC;
3387/** Pointer to a const generic descriptor entry. */
3388typedef const X86DESC64GENERIC *PCX86DESC64GENERIC;
3389
3390/**
3391 * System descriptor table entry (64 bits)
3392 *
3393 * @remarks This is, save a couple of comments, identical to X86DESC64GENERIC...
3394 */
3395#pragma pack(1)
3396typedef struct X86DESC64SYSTEM
3397{
3398 /** Limit - Low word. */
3399 uint32_t u16LimitLow : 16;
3400 /** Base address - low word.
3401 * Don't try set this to 24 because MSC is doing stupid things then. */
3402 uint32_t u16BaseLow : 16;
3403 /** Base address - first 8 bits of high word. */
3404 uint32_t u8BaseHigh1 : 8;
3405 /** Segment Type. */
3406 uint32_t u4Type : 4;
3407 /** Descriptor Type. System(=0) or code/data selector */
3408 uint32_t u1DescType : 1;
3409 /** Descriptor Privilege level. */
3410 uint32_t u2Dpl : 2;
3411 /** Flags selector present(=1) or not. */
3412 uint32_t u1Present : 1;
3413 /** Segment limit 16-19. */
3414 uint32_t u4LimitHigh : 4;
3415 /** Available for system software. */
3416 uint32_t u1Available : 1;
3417 /** Reserved - 0. */
3418 uint32_t u1Reserved : 1;
3419 /** This flags meaning depends on the segment type. Try make sense out
3420 * of the intel manual yourself. */
3421 uint32_t u1DefBig : 1;
3422 /** Granularity of the limit. If set 4KB granularity is used, if
3423 * clear byte. */
3424 uint32_t u1Granularity : 1;
3425 /** Base address - bits 31-24. */
3426 uint32_t u8BaseHigh2 : 8;
3427 /** Base address - bits 63-32. */
3428 uint32_t u32BaseHigh3 : 32;
3429 uint32_t u8Reserved : 8;
3430 uint32_t u5Zeros : 5;
3431 uint32_t u19Reserved : 19;
3432} X86DESC64SYSTEM;
3433#pragma pack()
3434/** Pointer to a system descriptor entry. */
3435typedef X86DESC64SYSTEM *PX86DESC64SYSTEM;
3436/** Pointer to a const system descriptor entry. */
3437typedef const X86DESC64SYSTEM *PCX86DESC64SYSTEM;
3438
3439/**
3440 * Call-, Interrupt-, Trap- or Task-gate descriptor (64-bit).
3441 */
3442typedef struct X86DESC64GATE
3443{
3444 /** Target code segment offset - Low word. */
3445 uint32_t u16OffsetLow : 16;
3446 /** Target code segment selector. */
3447 uint32_t u16Sel : 16;
3448 /** Interrupt stack table for interrupt- and trap-gates.
3449 * Ignored by call-gates. */
3450 uint32_t u3IST : 3;
3451 /** Reserved / ignored. */
3452 uint32_t u5Reserved : 5;
3453 /** Segment Type. */
3454 uint32_t u4Type : 4;
3455 /** Descriptor Type (0 = system). */
3456 uint32_t u1DescType : 1;
3457 /** Descriptor Privilege level. */
3458 uint32_t u2Dpl : 2;
3459 /** Flags selector present(=1) or not. */
3460 uint32_t u1Present : 1;
3461 /** Target code segment offset - High word.
3462 * Ignored if task-gate. */
3463 uint32_t u16OffsetHigh : 16;
3464 /** Target code segment offset - Top dword.
3465 * Ignored if task-gate. */
3466 uint32_t u32OffsetTop : 32;
3467 /** Reserved / ignored / must be zero.
3468 * For call-gates bits 8 thru 12 must be zero, the other gates ignores this. */
3469 uint32_t u32Reserved : 32;
3470} X86DESC64GATE;
3471AssertCompileSize(X86DESC64GATE, 16);
3472/** Pointer to a Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
3473typedef X86DESC64GATE *PX86DESC64GATE;
3474/** Pointer to a const Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
3475typedef const X86DESC64GATE *PCX86DESC64GATE;
3476
3477#endif /* VBOX_FOR_DTRACE_LIB */
3478
3479/**
3480 * Descriptor table entry.
3481 */
3482#pragma pack(1)
3483typedef union X86DESC64
3484{
3485#ifndef VBOX_FOR_DTRACE_LIB
3486 /** Generic descriptor view. */
3487 X86DESC64GENERIC Gen;
3488 /** System descriptor view. */
3489 X86DESC64SYSTEM System;
3490 /** Gate descriptor view. */
3491 X86DESC64GATE Gate;
3492#endif
3493
3494 /** 8 bit unsigned integer view. */
3495 uint8_t au8[16];
3496 /** 16 bit unsigned integer view. */
3497 uint16_t au16[8];
3498 /** 32 bit unsigned integer view. */
3499 uint32_t au32[4];
3500 /** 64 bit unsigned integer view. */
3501 uint64_t au64[2];
3502} X86DESC64;
3503#ifndef VBOX_FOR_DTRACE_LIB
3504AssertCompileSize(X86DESC64, 16);
3505#endif
3506#pragma pack()
3507/** Pointer to descriptor table entry. */
3508typedef X86DESC64 *PX86DESC64;
3509/** Pointer to const descriptor table entry. */
3510typedef const X86DESC64 *PCX86DESC64;
3511
3512/** @def X86DESC64_BASE
3513 * Return the base of a 64-bit descriptor.
3514 */
3515#define X86DESC64_BASE(a_pDesc) /*ASM-NOINC*/ \
3516 ( ((uint64_t)((a_pDesc)->Gen.u32BaseHigh3) << 32) \
3517 | ((uint32_t)((a_pDesc)->Gen.u8BaseHigh2) << 24) \
3518 | ( (a_pDesc)->Gen.u8BaseHigh1 << 16) \
3519 | ( (a_pDesc)->Gen.u16BaseLow ) )
3520
3521
3522
3523/** @name Host system descriptor table entry - Use with care!
3524 * @{ */
3525/** Host system descriptor table entry. */
3526#if HC_ARCH_BITS == 64
3527typedef X86DESC64 X86DESCHC;
3528#else
3529typedef X86DESC X86DESCHC;
3530#endif
3531/** Pointer to a host system descriptor table entry. */
3532#if HC_ARCH_BITS == 64
3533typedef PX86DESC64 PX86DESCHC;
3534#else
3535typedef PX86DESC PX86DESCHC;
3536#endif
3537/** Pointer to a const host system descriptor table entry. */
3538#if HC_ARCH_BITS == 64
3539typedef PCX86DESC64 PCX86DESCHC;
3540#else
3541typedef PCX86DESC PCX86DESCHC;
3542#endif
3543/** @} */
3544
3545
3546/** @name Selector Descriptor Types.
3547 * @{
3548 */
3549
3550/** @name Non-System Selector Types.
3551 * @{ */
3552/** Code(=set)/Data(=clear) bit. */
3553#define X86_SEL_TYPE_CODE 8
3554/** Memory(=set)/System(=clear) bit. */
3555#define X86_SEL_TYPE_MEMORY RT_BIT_32(4)
3556/** Accessed bit. */
3557#define X86_SEL_TYPE_ACCESSED 1
3558/** Expand down bit (for data selectors only). */
3559#define X86_SEL_TYPE_DOWN 4
3560/** Conforming bit (for code selectors only). */
3561#define X86_SEL_TYPE_CONF 4
3562/** Write bit (for data selectors only). */
3563#define X86_SEL_TYPE_WRITE 2
3564/** Read bit (for code selectors only). */
3565#define X86_SEL_TYPE_READ 2
3566/** The bit number of the code segment read bit (relative to u4Type). */
3567#define X86_SEL_TYPE_READ_BIT 1
3568
3569/** Read only selector type. */
3570#define X86_SEL_TYPE_RO 0
3571/** Accessed read only selector type. */
3572#define X86_SEL_TYPE_RO_ACC (0 | X86_SEL_TYPE_ACCESSED)
3573/** Read write selector type. */
3574#define X86_SEL_TYPE_RW 2
3575/** Accessed read write selector type. */
3576#define X86_SEL_TYPE_RW_ACC (2 | X86_SEL_TYPE_ACCESSED)
3577/** Expand down read only selector type. */
3578#define X86_SEL_TYPE_RO_DOWN 4
3579/** Accessed expand down read only selector type. */
3580#define X86_SEL_TYPE_RO_DOWN_ACC (4 | X86_SEL_TYPE_ACCESSED)
3581/** Expand down read write selector type. */
3582#define X86_SEL_TYPE_RW_DOWN 6
3583/** Accessed expand down read write selector type. */
3584#define X86_SEL_TYPE_RW_DOWN_ACC (6 | X86_SEL_TYPE_ACCESSED)
3585/** Execute only selector type. */
3586#define X86_SEL_TYPE_EO (0 | X86_SEL_TYPE_CODE)
3587/** Accessed execute only selector type. */
3588#define X86_SEL_TYPE_EO_ACC (0 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
3589/** Execute and read selector type. */
3590#define X86_SEL_TYPE_ER (2 | X86_SEL_TYPE_CODE)
3591/** Accessed execute and read selector type. */
3592#define X86_SEL_TYPE_ER_ACC (2 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
3593/** Conforming execute only selector type. */
3594#define X86_SEL_TYPE_EO_CONF (4 | X86_SEL_TYPE_CODE)
3595/** Accessed Conforming execute only selector type. */
3596#define X86_SEL_TYPE_EO_CONF_ACC (4 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
3597/** Conforming execute and write selector type. */
3598#define X86_SEL_TYPE_ER_CONF (6 | X86_SEL_TYPE_CODE)
3599/** Accessed Conforming execute and write selector type. */
3600#define X86_SEL_TYPE_ER_CONF_ACC (6 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
3601/** @} */
3602
3603
3604/** @name System Selector Types.
3605 * @{ */
3606/** The TSS busy bit mask. */
3607#define X86_SEL_TYPE_SYS_TSS_BUSY_MASK 2
3608
3609/** Undefined system selector type. */
3610#define X86_SEL_TYPE_SYS_UNDEFINED 0
3611/** 286 TSS selector. */
3612#define X86_SEL_TYPE_SYS_286_TSS_AVAIL 1
3613/** LDT selector. */
3614#define X86_SEL_TYPE_SYS_LDT 2
3615/** 286 TSS selector - Busy. */
3616#define X86_SEL_TYPE_SYS_286_TSS_BUSY 3
3617/** 286 Callgate selector. */
3618#define X86_SEL_TYPE_SYS_286_CALL_GATE 4
3619/** Taskgate selector. */
3620#define X86_SEL_TYPE_SYS_TASK_GATE 5
3621/** 286 Interrupt gate selector. */
3622#define X86_SEL_TYPE_SYS_286_INT_GATE 6
3623/** 286 Trapgate selector. */
3624#define X86_SEL_TYPE_SYS_286_TRAP_GATE 7
3625/** Undefined system selector. */
3626#define X86_SEL_TYPE_SYS_UNDEFINED2 8
3627/** 386 TSS selector. */
3628#define X86_SEL_TYPE_SYS_386_TSS_AVAIL 9
3629/** Undefined system selector. */
3630#define X86_SEL_TYPE_SYS_UNDEFINED3 0xA
3631/** 386 TSS selector - Busy. */
3632#define X86_SEL_TYPE_SYS_386_TSS_BUSY 0xB
3633/** 386 Callgate selector. */
3634#define X86_SEL_TYPE_SYS_386_CALL_GATE 0xC
3635/** Undefined system selector. */
3636#define X86_SEL_TYPE_SYS_UNDEFINED4 0xD
3637/** 386 Interruptgate selector. */
3638#define X86_SEL_TYPE_SYS_386_INT_GATE 0xE
3639/** 386 Trapgate selector. */
3640#define X86_SEL_TYPE_SYS_386_TRAP_GATE 0xF
3641/** @} */
3642
3643/** @name AMD64 System Selector Types.
3644 * @{ */
3645/** LDT selector. */
3646#define AMD64_SEL_TYPE_SYS_LDT 2
3647/** TSS selector - Busy. */
3648#define AMD64_SEL_TYPE_SYS_TSS_AVAIL 9
3649/** TSS selector - Busy. */
3650#define AMD64_SEL_TYPE_SYS_TSS_BUSY 0xB
3651/** Callgate selector. */
3652#define AMD64_SEL_TYPE_SYS_CALL_GATE 0xC
3653/** Interruptgate selector. */
3654#define AMD64_SEL_TYPE_SYS_INT_GATE 0xE
3655/** Trapgate selector. */
3656#define AMD64_SEL_TYPE_SYS_TRAP_GATE 0xF
3657/** @} */
3658
3659/** @} */
3660
3661
3662/** @name Descriptor Table Entry Flag Masks.
3663 * These are for the 2nd 32-bit word of a descriptor.
3664 * @{ */
3665/** Bits 8-11 - TYPE - Descriptor type mask. */
3666#define X86_DESC_TYPE_MASK (RT_BIT_32(8) | RT_BIT_32(9) | RT_BIT_32(10) | RT_BIT_32(11))
3667/** Bit 12 - S - System (=0) or Code/Data (=1). */
3668#define X86_DESC_S RT_BIT_32(12)
3669/** Bits 13-14 - DPL - Descriptor Privilege Level. */
3670#define X86_DESC_DPL (RT_BIT_32(13) | RT_BIT_32(14))
3671/** Bit 15 - P - Present. */
3672#define X86_DESC_P RT_BIT_32(15)
3673/** Bit 20 - AVL - Available for system software. */
3674#define X86_DESC_AVL RT_BIT_32(20)
3675/** Bit 22 - DB - Default operation size. 0 = 16 bit, 1 = 32 bit. */
3676#define X86_DESC_DB RT_BIT_32(22)
3677/** Bit 23 - G - Granularity of the limit. If set 4KB granularity is
3678 * used, if clear byte. */
3679#define X86_DESC_G RT_BIT_32(23)
3680/** @} */
3681
3682/** @} */
3683
3684
3685/** @name Task Segments.
3686 * @{
3687 */
3688
3689/**
3690 * The minimum TSS descriptor limit for 286 tasks.
3691 */
3692#define X86_SEL_TYPE_SYS_286_TSS_LIMIT_MIN 0x2b
3693
3694/**
3695 * The minimum TSS descriptor segment limit for 386 tasks.
3696 */
3697#define X86_SEL_TYPE_SYS_386_TSS_LIMIT_MIN 0x67
3698
3699/**
3700 * 16-bit Task Segment (TSS).
3701 */
3702#pragma pack(1)
3703typedef struct X86TSS16
3704{
3705 /** Back link to previous task. (static) */
3706 RTSEL selPrev;
3707 /** Ring-0 stack pointer. (static) */
3708 uint16_t sp0;
3709 /** Ring-0 stack segment. (static) */
3710 RTSEL ss0;
3711 /** Ring-1 stack pointer. (static) */
3712 uint16_t sp1;
3713 /** Ring-1 stack segment. (static) */
3714 RTSEL ss1;
3715 /** Ring-2 stack pointer. (static) */
3716 uint16_t sp2;
3717 /** Ring-2 stack segment. (static) */
3718 RTSEL ss2;
3719 /** IP before task switch. */
3720 uint16_t ip;
3721 /** FLAGS before task switch. */
3722 uint16_t flags;
3723 /** AX before task switch. */
3724 uint16_t ax;
3725 /** CX before task switch. */
3726 uint16_t cx;
3727 /** DX before task switch. */
3728 uint16_t dx;
3729 /** BX before task switch. */
3730 uint16_t bx;
3731 /** SP before task switch. */
3732 uint16_t sp;
3733 /** BP before task switch. */
3734 uint16_t bp;
3735 /** SI before task switch. */
3736 uint16_t si;
3737 /** DI before task switch. */
3738 uint16_t di;
3739 /** ES before task switch. */
3740 RTSEL es;
3741 /** CS before task switch. */
3742 RTSEL cs;
3743 /** SS before task switch. */
3744 RTSEL ss;
3745 /** DS before task switch. */
3746 RTSEL ds;
3747 /** LDTR before task switch. */
3748 RTSEL selLdt;
3749} X86TSS16;
3750#ifndef VBOX_FOR_DTRACE_LIB
3751AssertCompileSize(X86TSS16, X86_SEL_TYPE_SYS_286_TSS_LIMIT_MIN + 1);
3752#endif
3753#pragma pack()
3754/** Pointer to a 16-bit task segment. */
3755typedef X86TSS16 *PX86TSS16;
3756/** Pointer to a const 16-bit task segment. */
3757typedef const X86TSS16 *PCX86TSS16;
3758
3759
3760/**
3761 * 32-bit Task Segment (TSS).
3762 */
3763#pragma pack(1)
3764typedef struct X86TSS32
3765{
3766 /** Back link to previous task. (static) */
3767 RTSEL selPrev;
3768 uint16_t padding1;
3769 /** Ring-0 stack pointer. (static) */
3770 uint32_t esp0;
3771 /** Ring-0 stack segment. (static) */
3772 RTSEL ss0;
3773 uint16_t padding_ss0;
3774 /** Ring-1 stack pointer. (static) */
3775 uint32_t esp1;
3776 /** Ring-1 stack segment. (static) */
3777 RTSEL ss1;
3778 uint16_t padding_ss1;
3779 /** Ring-2 stack pointer. (static) */
3780 uint32_t esp2;
3781 /** Ring-2 stack segment. (static) */
3782 RTSEL ss2;
3783 uint16_t padding_ss2;
3784 /** Page directory for the task. (static) */
3785 uint32_t cr3;
3786 /** EIP before task switch. */
3787 uint32_t eip;
3788 /** EFLAGS before task switch. */
3789 uint32_t eflags;
3790 /** EAX before task switch. */
3791 uint32_t eax;
3792 /** ECX before task switch. */
3793 uint32_t ecx;
3794 /** EDX before task switch. */
3795 uint32_t edx;
3796 /** EBX before task switch. */
3797 uint32_t ebx;
3798 /** ESP before task switch. */
3799 uint32_t esp;
3800 /** EBP before task switch. */
3801 uint32_t ebp;
3802 /** ESI before task switch. */
3803 uint32_t esi;
3804 /** EDI before task switch. */
3805 uint32_t edi;
3806 /** ES before task switch. */
3807 RTSEL es;
3808 uint16_t padding_es;
3809 /** CS before task switch. */
3810 RTSEL cs;
3811 uint16_t padding_cs;
3812 /** SS before task switch. */
3813 RTSEL ss;
3814 uint16_t padding_ss;
3815 /** DS before task switch. */
3816 RTSEL ds;
3817 uint16_t padding_ds;
3818 /** FS before task switch. */
3819 RTSEL fs;
3820 uint16_t padding_fs;
3821 /** GS before task switch. */
3822 RTSEL gs;
3823 uint16_t padding_gs;
3824 /** LDTR before task switch. */
3825 RTSEL selLdt;
3826 uint16_t padding_ldt;
3827 /** Debug trap flag */
3828 uint16_t fDebugTrap;
3829 /** Offset relative to the TSS of the start of the I/O Bitmap
3830 * and the end of the interrupt redirection bitmap. */
3831 uint16_t offIoBitmap;
3832} X86TSS32;
3833#pragma pack()
3834/** Pointer to task segment. */
3835typedef X86TSS32 *PX86TSS32;
3836/** Pointer to const task segment. */
3837typedef const X86TSS32 *PCX86TSS32;
3838#ifndef VBOX_FOR_DTRACE_LIB
3839AssertCompileSize(X86TSS32, X86_SEL_TYPE_SYS_386_TSS_LIMIT_MIN + 1);
3840AssertCompileMemberOffset(X86TSS32, cr3, 28);
3841AssertCompileMemberOffset(X86TSS32, offIoBitmap, 102);
3842#endif
3843
3844/**
3845 * 64-bit Task segment.
3846 */
3847#pragma pack(1)
3848typedef struct X86TSS64
3849{
3850 /** Reserved. */
3851 uint32_t u32Reserved;
3852 /** Ring-0 stack pointer. (static) */
3853 uint64_t rsp0;
3854 /** Ring-1 stack pointer. (static) */
3855 uint64_t rsp1;
3856 /** Ring-2 stack pointer. (static) */
3857 uint64_t rsp2;
3858 /** Reserved. */
3859 uint32_t u32Reserved2[2];
3860 /* IST */
3861 uint64_t ist1;
3862 uint64_t ist2;
3863 uint64_t ist3;
3864 uint64_t ist4;
3865 uint64_t ist5;
3866 uint64_t ist6;
3867 uint64_t ist7;
3868 /* Reserved. */
3869 uint16_t u16Reserved[5];
3870 /** Offset relative to the TSS of the start of the I/O Bitmap
3871 * and the end of the interrupt redirection bitmap. */
3872 uint16_t offIoBitmap;
3873} X86TSS64;
3874#pragma pack()
3875/** Pointer to a 64-bit task segment. */
3876typedef X86TSS64 *PX86TSS64;
3877/** Pointer to a const 64-bit task segment. */
3878typedef const X86TSS64 *PCX86TSS64;
3879#ifndef VBOX_FOR_DTRACE_LIB
3880AssertCompileSize(X86TSS64, X86_SEL_TYPE_SYS_386_TSS_LIMIT_MIN + 1);
3881#endif
3882
3883/** @} */
3884
3885
3886/** @name Selectors.
3887 * @{
3888 */
3889
3890/**
3891 * The shift used to convert a selector from and to index an index (C).
3892 */
3893#define X86_SEL_SHIFT 3
3894
3895/**
3896 * The mask used to mask off the table indicator and RPL of an selector.
3897 */
3898#define X86_SEL_MASK 0xfff8U
3899
3900/**
3901 * The mask used to mask off the RPL of an selector.
3902 * This is suitable for checking for NULL selectors.
3903 */
3904#define X86_SEL_MASK_OFF_RPL 0xfffcU
3905
3906/**
3907 * The bit indicating that a selector is in the LDT and not in the GDT.
3908 */
3909#define X86_SEL_LDT 0x0004U
3910
3911/**
3912 * The bit mask for getting the RPL of a selector.
3913 */
3914#define X86_SEL_RPL 0x0003U
3915
3916/**
3917 * The mask covering both RPL and LDT.
3918 * This is incidentally the same as sizeof(X86DESC) - 1, so good for limit
3919 * checks.
3920 */
3921#define X86_SEL_RPL_LDT 0x0007U
3922
3923/** @} */
3924
3925
3926/**
3927 * x86 Exceptions/Faults/Traps.
3928 */
3929typedef enum X86XCPT
3930{
3931 /** \#DE - Divide error. */
3932 X86_XCPT_DE = 0x00,
3933 /** \#DB - Debug event (single step, DRx, ..) */
3934 X86_XCPT_DB = 0x01,
3935 /** NMI - Non-Maskable Interrupt */
3936 X86_XCPT_NMI = 0x02,
3937 /** \#BP - Breakpoint (INT3). */
3938 X86_XCPT_BP = 0x03,
3939 /** \#OF - Overflow (INTO). */
3940 X86_XCPT_OF = 0x04,
3941 /** \#BR - Bound range exceeded (BOUND). */
3942 X86_XCPT_BR = 0x05,
3943 /** \#UD - Undefined opcode. */
3944 X86_XCPT_UD = 0x06,
3945 /** \#NM - Device not available (math coprocessor device). */
3946 X86_XCPT_NM = 0x07,
3947 /** \#DF - Double fault. */
3948 X86_XCPT_DF = 0x08,
3949 /** ??? - Coprocessor segment overrun (obsolete). */
3950 X86_XCPT_CO_SEG_OVERRUN = 0x09,
3951 /** \#TS - Taskswitch (TSS). */
3952 X86_XCPT_TS = 0x0a,
3953 /** \#NP - Segment no present. */
3954 X86_XCPT_NP = 0x0b,
3955 /** \#SS - Stack segment fault. */
3956 X86_XCPT_SS = 0x0c,
3957 /** \#GP - General protection fault. */
3958 X86_XCPT_GP = 0x0d,
3959 /** \#PF - Page fault. */
3960 X86_XCPT_PF = 0x0e,
3961 /* 0x0f is reserved (to avoid conflict with spurious interrupts in BIOS setup). */
3962 /** \#MF - Math fault (FPU). */
3963 X86_XCPT_MF = 0x10,
3964 /** \#AC - Alignment check. */
3965 X86_XCPT_AC = 0x11,
3966 /** \#MC - Machine check. */
3967 X86_XCPT_MC = 0x12,
3968 /** \#XF - SIMD Floating-Pointer Exception. */
3969 X86_XCPT_XF = 0x13,
3970 /** \#VE - Virtualization Exception. */
3971 X86_XCPT_VE = 0x14,
3972 /** \#SX - Security Exception. */
3973 X86_XCPT_SX = 0x1f
3974} X86XCPT;
3975/** Pointer to a x86 exception code. */
3976typedef X86XCPT *PX86XCPT;
3977/** Pointer to a const x86 exception code. */
3978typedef const X86XCPT *PCX86XCPT;
3979/** The maximum exception value. */
3980#define X86_XCPT_MAX (X86_XCPT_SX)
3981
3982
3983/** @name Trap Error Codes
3984 * @{
3985 */
3986/** External indicator. */
3987#define X86_TRAP_ERR_EXTERNAL 1
3988/** IDT indicator. */
3989#define X86_TRAP_ERR_IDT 2
3990/** Descriptor table indicator - If set LDT, if clear GDT. */
3991#define X86_TRAP_ERR_TI 4
3992/** Mask for getting the selector. */
3993#define X86_TRAP_ERR_SEL_MASK 0xfff8
3994/** Shift for getting the selector table index (C type index). */
3995#define X86_TRAP_ERR_SEL_SHIFT 3
3996/** @} */
3997
3998
3999/** @name \#PF Trap Error Codes
4000 * @{
4001 */
4002/** Bit 0 - P - Not present (clear) or page level protection (set) fault. */
4003#define X86_TRAP_PF_P RT_BIT_32(0)
4004/** Bit 1 - R/W - Read (clear) or write (set) access. */
4005#define X86_TRAP_PF_RW RT_BIT_32(1)
4006/** Bit 2 - U/S - CPU executing in user mode (set) or supervisor mode (clear). */
4007#define X86_TRAP_PF_US RT_BIT_32(2)
4008/** Bit 3 - RSVD- Reserved bit violation (set), i.e. reserved bit was set to 1. */
4009#define X86_TRAP_PF_RSVD RT_BIT_32(3)
4010/** Bit 4 - I/D - Instruction fetch (set) / Data access (clear) - PAE + NXE. */
4011#define X86_TRAP_PF_ID RT_BIT_32(4)
4012/** Bit 5 - PK - Protection-key violation (AMD64 mode only). */
4013#define X86_TRAP_PF_PK RT_BIT_32(5)
4014/** @} */
4015
4016#pragma pack(1)
4017/**
4018 * 16-bit IDTR.
4019 */
4020typedef struct X86IDTR16
4021{
4022 /** Offset. */
4023 uint16_t offSel;
4024 /** Selector. */
4025 uint16_t uSel;
4026} X86IDTR16, *PX86IDTR16;
4027#pragma pack()
4028
4029#pragma pack(1)
4030/**
4031 * 32-bit IDTR/GDTR.
4032 */
4033typedef struct X86XDTR32
4034{
4035 /** Size of the descriptor table. */
4036 uint16_t cb;
4037 /** Address of the descriptor table. */
4038#ifndef VBOX_FOR_DTRACE_LIB
4039 uint32_t uAddr;
4040#else
4041 uint16_t au16Addr[2];
4042#endif
4043} X86XDTR32, *PX86XDTR32;
4044#pragma pack()
4045
4046#pragma pack(1)
4047/**
4048 * 64-bit IDTR/GDTR.
4049 */
4050typedef struct X86XDTR64
4051{
4052 /** Size of the descriptor table. */
4053 uint16_t cb;
4054 /** Address of the descriptor table. */
4055#ifndef VBOX_FOR_DTRACE_LIB
4056 uint64_t uAddr;
4057#else
4058 uint16_t au16Addr[4];
4059#endif
4060} X86XDTR64, *PX86XDTR64;
4061#pragma pack()
4062
4063
4064/** @name ModR/M
4065 * @{ */
4066#define X86_MODRM_RM_MASK UINT8_C(0x07)
4067#define X86_MODRM_REG_MASK UINT8_C(0x38)
4068#define X86_MODRM_REG_SMASK UINT8_C(0x07)
4069#define X86_MODRM_REG_SHIFT 3
4070#define X86_MODRM_MOD_MASK UINT8_C(0xc0)
4071#define X86_MODRM_MOD_SMASK UINT8_C(0x03)
4072#define X86_MODRM_MOD_SHIFT 6
4073#ifndef VBOX_FOR_DTRACE_LIB
4074AssertCompile((X86_MODRM_RM_MASK | X86_MODRM_REG_MASK | X86_MODRM_MOD_MASK) == 0xff);
4075AssertCompile((X86_MODRM_REG_MASK >> X86_MODRM_REG_SHIFT) == X86_MODRM_REG_SMASK);
4076AssertCompile((X86_MODRM_MOD_MASK >> X86_MODRM_MOD_SHIFT) == X86_MODRM_MOD_SMASK);
4077#endif
4078/** @} */
4079
4080/** @name SIB
4081 * @{ */
4082#define X86_SIB_BASE_MASK UINT8_C(0x07)
4083#define X86_SIB_INDEX_MASK UINT8_C(0x38)
4084#define X86_SIB_INDEX_SMASK UINT8_C(0x07)
4085#define X86_SIB_INDEX_SHIFT 3
4086#define X86_SIB_SCALE_MASK UINT8_C(0xc0)
4087#define X86_SIB_SCALE_SMASK UINT8_C(0x03)
4088#define X86_SIB_SCALE_SHIFT 6
4089#ifndef VBOX_FOR_DTRACE_LIB
4090AssertCompile((X86_SIB_BASE_MASK | X86_SIB_INDEX_MASK | X86_SIB_SCALE_MASK) == 0xff);
4091AssertCompile((X86_SIB_INDEX_MASK >> X86_SIB_INDEX_SHIFT) == X86_SIB_INDEX_SMASK);
4092AssertCompile((X86_SIB_SCALE_MASK >> X86_SIB_SCALE_SHIFT) == X86_SIB_SCALE_SMASK);
4093#endif
4094/** @} */
4095
4096/** @name General register indexes
4097 * @{ */
4098#define X86_GREG_xAX 0
4099#define X86_GREG_xCX 1
4100#define X86_GREG_xDX 2
4101#define X86_GREG_xBX 3
4102#define X86_GREG_xSP 4
4103#define X86_GREG_xBP 5
4104#define X86_GREG_xSI 6
4105#define X86_GREG_xDI 7
4106#define X86_GREG_x8 8
4107#define X86_GREG_x9 9
4108#define X86_GREG_x10 10
4109#define X86_GREG_x11 11
4110#define X86_GREG_x12 12
4111#define X86_GREG_x13 13
4112#define X86_GREG_x14 14
4113#define X86_GREG_x15 15
4114/** @} */
4115
4116/** @name X86_SREG_XXX - Segment register indexes.
4117 * @{ */
4118#define X86_SREG_ES 0
4119#define X86_SREG_CS 1
4120#define X86_SREG_SS 2
4121#define X86_SREG_DS 3
4122#define X86_SREG_FS 4
4123#define X86_SREG_GS 5
4124/** @} */
4125/** Segment register count. */
4126#define X86_SREG_COUNT 6
4127
4128
4129/** @name X86_OP_XXX - Prefixes
4130 * @{ */
4131#define X86_OP_PRF_CS UINT8_C(0x2e)
4132#define X86_OP_PRF_SS UINT8_C(0x36)
4133#define X86_OP_PRF_DS UINT8_C(0x3e)
4134#define X86_OP_PRF_ES UINT8_C(0x26)
4135#define X86_OP_PRF_FS UINT8_C(0x64)
4136#define X86_OP_PRF_GS UINT8_C(0x65)
4137#define X86_OP_PRF_SIZE_OP UINT8_C(0x66)
4138#define X86_OP_PRF_SIZE_ADDR UINT8_C(0x67)
4139#define X86_OP_PRF_LOCK UINT8_C(0xf0)
4140#define X86_OP_PRF_REPZ UINT8_C(0xf2)
4141#define X86_OP_PRF_REPNZ UINT8_C(0xf3)
4142#define X86_OP_REX_B UINT8_C(0x41)
4143#define X86_OP_REX_X UINT8_C(0x42)
4144#define X86_OP_REX_R UINT8_C(0x44)
4145#define X86_OP_REX_W UINT8_C(0x48)
4146/** @} */
4147
4148
4149/** @} */
4150
4151#endif
4152
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