VirtualBox

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

Last change on this file since 66274 was 66227, checked in by vboxsync, 8 years ago

VMM: Nested Hw.virt: Implement SVM VMRUN and #VMEXIT in IEM.

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