VirtualBox

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

Last change on this file since 83488 was 83328, checked in by vboxsync, 5 years ago

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