VirtualBox

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

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

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