VirtualBox

source: vbox/trunk/include/VBox/x86.h@ 37517

Last change on this file since 37517 was 37139, checked in by vboxsync, 14 years ago

forgot to commit

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 105.4 KB
Line 
1/** @file
2 * X86 (and AMD64) Structures and Definitions (VMM,++).
3 *
4 * x86.mac is generated from this file by running 'kmk incs' in the root.
5 */
6
7/*
8 * Copyright (C) 2006-2009 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 ___VBox_x86_h
29#define ___VBox_x86_h
30
31#include <VBox/types.h>
32#include <iprt/assert.h>
33
34/* Workaround for Solaris sys/regset.h defining CS, DS */
35#ifdef RT_OS_SOLARIS
36# undef CS
37# undef DS
38#endif
39
40/** @defgroup grp_x86 x86 Types and Definitions
41 * @{
42 */
43
44/**
45 * EFLAGS Bits.
46 */
47typedef struct X86EFLAGSBITS
48{
49 /** Bit 0 - CF - Carry flag - Status flag. */
50 unsigned u1CF : 1;
51 /** Bit 1 - 1 - Reserved flag. */
52 unsigned u1Reserved0 : 1;
53 /** Bit 2 - PF - Parity flag - Status flag. */
54 unsigned u1PF : 1;
55 /** Bit 3 - 0 - Reserved flag. */
56 unsigned u1Reserved1 : 1;
57 /** Bit 4 - AF - Auxiliary carry flag - Status flag. */
58 unsigned u1AF : 1;
59 /** Bit 5 - 0 - Reserved flag. */
60 unsigned u1Reserved2 : 1;
61 /** Bit 6 - ZF - Zero flag - Status flag. */
62 unsigned u1ZF : 1;
63 /** Bit 7 - SF - Signed flag - Status flag. */
64 unsigned u1SF : 1;
65 /** Bit 8 - TF - Trap flag - System flag. */
66 unsigned u1TF : 1;
67 /** Bit 9 - IF - Interrupt flag - System flag. */
68 unsigned u1IF : 1;
69 /** Bit 10 - DF - Direction flag - Control flag. */
70 unsigned u1DF : 1;
71 /** Bit 11 - OF - Overflow flag - Status flag. */
72 unsigned u1OF : 1;
73 /** Bit 12-13 - IOPL - I/O prvilege level flag - System flag. */
74 unsigned u2IOPL : 2;
75 /** Bit 14 - NT - Nested task flag - System flag. */
76 unsigned u1NT : 1;
77 /** Bit 15 - 0 - Reserved flag. */
78 unsigned u1Reserved3 : 1;
79 /** Bit 16 - RF - Resume flag - System flag. */
80 unsigned u1RF : 1;
81 /** Bit 17 - VM - Virtual 8086 mode - System flag. */
82 unsigned u1VM : 1;
83 /** Bit 18 - AC - Alignment check flag - System flag. Works with CR0.AM. */
84 unsigned u1AC : 1;
85 /** Bit 19 - VIF - Virtual interrupt flag - System flag. */
86 unsigned u1VIF : 1;
87 /** Bit 20 - VIP - Virtual interrupt pending flag - System flag. */
88 unsigned u1VIP : 1;
89 /** Bit 21 - ID - CPUID flag - System flag. If this responds to flipping CPUID is supported. */
90 unsigned u1ID : 1;
91 /** Bit 22-31 - 0 - Reserved flag. */
92 unsigned u10Reserved4 : 10;
93} X86EFLAGSBITS;
94/** Pointer to EFLAGS bits. */
95typedef X86EFLAGSBITS *PX86EFLAGSBITS;
96/** Pointer to const EFLAGS bits. */
97typedef const X86EFLAGSBITS *PCX86EFLAGSBITS;
98
99/**
100 * EFLAGS.
101 */
102typedef union X86EFLAGS
103{
104 /** The plain unsigned view. */
105 uint32_t u;
106 /** The bitfield view. */
107 X86EFLAGSBITS Bits;
108 /** The 8-bit view. */
109 uint8_t au8[4];
110 /** The 16-bit view. */
111 uint16_t au16[2];
112 /** The 32-bit view. */
113 uint32_t au32[1];
114 /** The 32-bit view. */
115 uint32_t u32;
116} X86EFLAGS;
117/** Pointer to EFLAGS. */
118typedef X86EFLAGS *PX86EFLAGS;
119/** Pointer to const EFLAGS. */
120typedef const X86EFLAGS *PCX86EFLAGS;
121
122/**
123 * RFLAGS (32 upper bits are reserved).
124 */
125typedef union X86RFLAGS
126{
127 /** The plain unsigned view. */
128 uint64_t u;
129 /** The bitfield view. */
130 X86EFLAGSBITS Bits;
131 /** The 8-bit view. */
132 uint8_t au8[8];
133 /** The 16-bit view. */
134 uint16_t au16[4];
135 /** The 32-bit view. */
136 uint32_t au32[2];
137 /** The 64-bit view. */
138 uint64_t au64[1];
139 /** The 64-bit view. */
140 uint64_t u64;
141} X86RFLAGS;
142/** Pointer to RFLAGS. */
143typedef X86RFLAGS *PX86RFLAGS;
144/** Pointer to const RFLAGS. */
145typedef const X86RFLAGS *PCX86RFLAGS;
146
147
148/** @name EFLAGS
149 * @{
150 */
151/** Bit 0 - CF - Carry flag - Status flag. */
152#define X86_EFL_CF RT_BIT(0)
153/** Bit 1 - Reserved, reads as 1. */
154#define X86_EFL_1 RT_BIT(1)
155/** Bit 2 - PF - Parity flag - Status flag. */
156#define X86_EFL_PF RT_BIT(2)
157/** Bit 4 - AF - Auxiliary carry flag - Status flag. */
158#define X86_EFL_AF RT_BIT(4)
159/** Bit 6 - ZF - Zero flag - Status flag. */
160#define X86_EFL_ZF RT_BIT(6)
161/** Bit 7 - SF - Signed flag - Status flag. */
162#define X86_EFL_SF RT_BIT(7)
163/** Bit 8 - TF - Trap flag - System flag. */
164#define X86_EFL_TF RT_BIT(8)
165/** Bit 9 - IF - Interrupt flag - System flag. */
166#define X86_EFL_IF RT_BIT(9)
167/** Bit 10 - DF - Direction flag - Control flag. */
168#define X86_EFL_DF RT_BIT(10)
169/** Bit 11 - OF - Overflow flag - Status flag. */
170#define X86_EFL_OF RT_BIT(11)
171/** Bit 12-13 - IOPL - I/O prvilege level flag - System flag. */
172#define X86_EFL_IOPL (RT_BIT(12) | RT_BIT(13))
173/** Bit 14 - NT - Nested task flag - System flag. */
174#define X86_EFL_NT RT_BIT(14)
175/** Bit 16 - RF - Resume flag - System flag. */
176#define X86_EFL_RF RT_BIT(16)
177/** Bit 17 - VM - Virtual 8086 mode - System flag. */
178#define X86_EFL_VM RT_BIT(17)
179/** Bit 18 - AC - Alignment check flag - System flag. Works with CR0.AM. */
180#define X86_EFL_AC RT_BIT(18)
181/** Bit 19 - VIF - Virtual interrupt flag - System flag. */
182#define X86_EFL_VIF RT_BIT(19)
183/** Bit 20 - VIP - Virtual interrupt pending flag - System flag. */
184#define X86_EFL_VIP RT_BIT(20)
185/** Bit 21 - ID - CPUID flag - System flag. If this responds to flipping CPUID is supported. */
186#define X86_EFL_ID RT_BIT(21)
187/** IOPL shift. */
188#define X86_EFL_IOPL_SHIFT 12
189/** The the IOPL level from the flags. */
190#define X86_EFL_GET_IOPL(efl) (((efl) >> X86_EFL_IOPL_SHIFT) & 3)
191/** Bits restored by popf */
192#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 | X86_EFL_DF | X86_EFL_OF | X86_EFL_IOPL | X86_EFL_NT | X86_EFL_AC | X86_EFL_ID)
193/** @} */
194
195
196/** CPUID Feature information - ECX.
197 * CPUID query with EAX=1.
198 */
199typedef struct X86CPUIDFEATECX
200{
201 /** Bit 0 - SSE3 - Supports SSE3 or not. */
202 unsigned u1SSE3 : 1;
203 /** Bit 1 - PCLMULQDQ. */
204 unsigned u1PCLMULQDQ : 1;
205 /** Bit 2 - DS Area 64-bit layout. */
206 unsigned u1DTE64 : 1;
207 /** Bit 3 - MONITOR - Supports MONITOR/MWAIT. */
208 unsigned u1Monitor : 1;
209 /** Bit 4 - CPL-DS - CPL Qualified Debug Store. */
210 unsigned u1CPLDS : 1;
211 /** Bit 5 - VMX - Virtual Machine Technology. */
212 unsigned u1VMX : 1;
213 /** Bit 6 - SMX: Safer Mode Extensions. */
214 unsigned u1SMX : 1;
215 /** Bit 7 - EST - Enh. SpeedStep Tech. */
216 unsigned u1EST : 1;
217 /** Bit 8 - TM2 - Terminal Monitor 2. */
218 unsigned u1TM2 : 1;
219 /** Bit 9 - SSSE3 - Supplemental Streaming SIMD Extensions 3. */
220 unsigned u1SSSE3 : 1;
221 /** Bit 10 - CNTX-ID - L1 Context ID. */
222 unsigned u1CNTXID : 1;
223 /** Bit 11 - Reserved. */
224 unsigned u1Reserved1 : 1;
225 /** Bit 12 - FMA. */
226 unsigned u1FMA : 1;
227 /** Bit 13 - CX16 - CMPXCHG16B. */
228 unsigned u1CX16 : 1;
229 /** Bit 14 - xTPR Update Control. Processor supports changing IA32_MISC_ENABLES[bit 23]. */
230 unsigned u1TPRUpdate : 1;
231 /** Bit 15 - PDCM - Perf/Debug Capability MSR. */
232 unsigned u1PDCM : 1;
233 /** Bit 16 - Reserved. */
234 unsigned u1Reserved2 : 1;
235 /** Bit 17 - PCID - Process-context identifiers. */
236 unsigned u1PCID : 1;
237 /** Bit 18 - Direct Cache Access. */
238 unsigned u1DCA : 1;
239 /** Bit 19 - SSE4_1 - Supports SSE4_1 or not. */
240 unsigned u1SSE4_1 : 1;
241 /** Bit 20 - SSE4_2 - Supports SSE4_2 or not. */
242 unsigned u1SSE4_2 : 1;
243 /** Bit 21 - x2APIC. */
244 unsigned u1x2APIC : 1;
245 /** Bit 22 - MOVBE - Supports MOVBE. */
246 unsigned u1MOVBE : 1;
247 /** Bit 23 - POPCNT - Supports POPCNT. */
248 unsigned u1POPCNT : 1;
249 /** Bit 24 - TSC-Deadline. */
250 unsigned u1TSCDEADLINE : 1;
251 /** Bit 25 - AES. */
252 unsigned u1AES : 1;
253 /** Bit 26 - XSAVE - Supports XSAVE. */
254 unsigned u1XSAVE : 1;
255 /** Bit 27 - OSXSAVE - Supports OSXSAVE. */
256 unsigned u1OSXSAVE : 1;
257 /** Bit 28 - AVX - Supports AVX instruction extensions. */
258 unsigned u1AVX : 1;
259 /** Bit 29 - 30 - Reserved */
260 unsigned u2Reserved3 : 2;
261 /** Bit 31 - Hypervisor present (we're a guest). */
262 unsigned u1HVP : 1;
263} X86CPUIDFEATECX;
264/** Pointer to CPUID Feature Information - ECX. */
265typedef X86CPUIDFEATECX *PX86CPUIDFEATECX;
266/** Pointer to const CPUID Feature Information - ECX. */
267typedef const X86CPUIDFEATECX *PCX86CPUIDFEATECX;
268
269
270/** CPUID Feature Information - EDX.
271 * CPUID query with EAX=1.
272 */
273typedef struct X86CPUIDFEATEDX
274{
275 /** Bit 0 - FPU - x87 FPU on Chip. */
276 unsigned u1FPU : 1;
277 /** Bit 1 - VME - Virtual 8086 Mode Enhancements. */
278 unsigned u1VME : 1;
279 /** Bit 2 - DE - Debugging extensions. */
280 unsigned u1DE : 1;
281 /** Bit 3 - PSE - Page Size Extension. */
282 unsigned u1PSE : 1;
283 /** Bit 4 - TSC - Time Stamp Counter. */
284 unsigned u1TSC : 1;
285 /** Bit 5 - MSR - Model Specific Registers RDMSR and WRMSR Instructions. */
286 unsigned u1MSR : 1;
287 /** Bit 6 - PAE - Physical Address Extension. */
288 unsigned u1PAE : 1;
289 /** Bit 7 - MCE - Machine Check Exception. */
290 unsigned u1MCE : 1;
291 /** Bit 8 - CX8 - CMPXCHG8B instruction. */
292 unsigned u1CX8 : 1;
293 /** Bit 9 - APIC - APIC On-Chip. */
294 unsigned u1APIC : 1;
295 /** Bit 10 - Reserved. */
296 unsigned u1Reserved1 : 1;
297 /** Bit 11 - SEP - SYSENTER and SYSEXIT. */
298 unsigned u1SEP : 1;
299 /** Bit 12 - MTRR - Memory Type Range Registers. */
300 unsigned u1MTRR : 1;
301 /** Bit 13 - PGE - PTE Global Bit. */
302 unsigned u1PGE : 1;
303 /** Bit 14 - MCA - Machine Check Architecture. */
304 unsigned u1MCA : 1;
305 /** Bit 15 - CMOV - Conditional Move Instructions. */
306 unsigned u1CMOV : 1;
307 /** Bit 16 - PAT - Page Attribute Table. */
308 unsigned u1PAT : 1;
309 /** Bit 17 - PSE-36 - 36-bit Page Size Extention. */
310 unsigned u1PSE36 : 1;
311 /** Bit 18 - PSN - Processor Serial Number. */
312 unsigned u1PSN : 1;
313 /** Bit 19 - CLFSH - CLFLUSH Instruction. */
314 unsigned u1CLFSH : 1;
315 /** Bit 20 - Reserved. */
316 unsigned u1Reserved2 : 1;
317 /** Bit 21 - DS - Debug Store. */
318 unsigned u1DS : 1;
319 /** Bit 22 - ACPI - Thermal Monitor and Software Controlled Clock Facilities. */
320 unsigned u1ACPI : 1;
321 /** Bit 23 - MMX - Intel MMX 'Technology'. */
322 unsigned u1MMX : 1;
323 /** Bit 24 - FXSR - FXSAVE and FXRSTOR Instructions. */
324 unsigned u1FXSR : 1;
325 /** Bit 25 - SSE - SSE Support. */
326 unsigned u1SSE : 1;
327 /** Bit 26 - SSE2 - SSE2 Support. */
328 unsigned u1SSE2 : 1;
329 /** Bit 27 - SS - Self Snoop. */
330 unsigned u1SS : 1;
331 /** Bit 28 - HTT - Hyper-Threading Technology. */
332 unsigned u1HTT : 1;
333 /** Bit 29 - TM - Thermal Monitor. */
334 unsigned u1TM : 1;
335 /** Bit 30 - Reserved - . */
336 unsigned u1Reserved3 : 1;
337 /** Bit 31 - PBE - Pending Break Enabled. */
338 unsigned u1PBE : 1;
339} X86CPUIDFEATEDX;
340/** Pointer to CPUID Feature Information - EDX. */
341typedef X86CPUIDFEATEDX *PX86CPUIDFEATEDX;
342/** Pointer to const CPUID Feature Information - EDX. */
343typedef const X86CPUIDFEATEDX *PCX86CPUIDFEATEDX;
344
345/** @name CPUID Vendor information.
346 * CPUID query with EAX=0.
347 * @{
348 */
349#define X86_CPUID_VENDOR_INTEL_EBX 0x756e6547 /* Genu */
350#define X86_CPUID_VENDOR_INTEL_ECX 0x6c65746e /* ntel */
351#define X86_CPUID_VENDOR_INTEL_EDX 0x49656e69 /* ineI */
352
353#define X86_CPUID_VENDOR_AMD_EBX 0x68747541 /* Auth */
354#define X86_CPUID_VENDOR_AMD_ECX 0x444d4163 /* cAMD */
355#define X86_CPUID_VENDOR_AMD_EDX 0x69746e65 /* enti */
356/** @} */
357
358
359/** @name CPUID Feature information.
360 * CPUID query with EAX=1.
361 * @{
362 */
363/** ECX Bit 0 - SSE3 - Supports SSE3 or not. */
364#define X86_CPUID_FEATURE_ECX_SSE3 RT_BIT(0)
365/** ECX Bit 1 - PCLMUL - PCLMULQDQ support (for AES-GCM). */
366#define X86_CPUID_FEATURE_ECX_PCLMUL RT_BIT(1)
367/** ECX Bit 2 - DTES64 - DS Area 64-bit Layout. */
368#define X86_CPUID_FEATURE_ECX_DTES64 RT_BIT(2)
369/** ECX Bit 3 - MONITOR - Supports MONITOR/MWAIT. */
370#define X86_CPUID_FEATURE_ECX_MONITOR RT_BIT(3)
371/** ECX Bit 4 - CPL-DS - CPL Qualified Debug Store. */
372#define X86_CPUID_FEATURE_ECX_CPLDS RT_BIT(4)
373/** ECX Bit 5 - VMX - Virtual Machine Technology. */
374#define X86_CPUID_FEATURE_ECX_VMX RT_BIT(5)
375/** ECX Bit 6 - SMX - Safer Mode Extensions. */
376#define X86_CPUID_FEATURE_ECX_SMX RT_BIT(6)
377/** ECX Bit 7 - EST - Enh. SpeedStep Tech. */
378#define X86_CPUID_FEATURE_ECX_EST RT_BIT(7)
379/** ECX Bit 8 - TM2 - Terminal Monitor 2. */
380#define X86_CPUID_FEATURE_ECX_TM2 RT_BIT(8)
381/** ECX Bit 9 - SSSE3 - Supplemental Streaming SIMD Extensions 3. */
382#define X86_CPUID_FEATURE_ECX_SSSE3 RT_BIT(9)
383/** ECX Bit 10 - CNTX-ID - L1 Context ID. */
384#define X86_CPUID_FEATURE_ECX_CNTXID RT_BIT(10)
385/** ECX Bit 12 - FMA. */
386#define X86_CPUID_FEATURE_ECX_FMA RT_BIT(12)
387/** ECX Bit 13 - CX16 - CMPXCHG16B. */
388#define X86_CPUID_FEATURE_ECX_CX16 RT_BIT(13)
389/** ECX Bit 14 - xTPR Update Control. Processor supports changing IA32_MISC_ENABLES[bit 23]. */
390#define X86_CPUID_FEATURE_ECX_TPRUPDATE RT_BIT(14)
391/** ECX Bit 15 - PDCM - Perf/Debug Capability MSR. */
392#define X86_CPUID_FEATURE_ECX_PDCM RT_BIT(15)
393/** ECX Bit 17 - PCID - Process-context identifiers. */
394#define X86_CPUID_FEATURE_ECX_PCID RT_BIT(17)
395/** ECX Bit 18 - DCA - Direct Cache Access. */
396#define X86_CPUID_FEATURE_ECX_DCA RT_BIT(18)
397/** ECX Bit 19 - SSE4_1 - Supports SSE4_1 or not. */
398#define X86_CPUID_FEATURE_ECX_SSE4_1 RT_BIT(19)
399/** ECX Bit 20 - SSE4_2 - Supports SSE4_2 or not. */
400#define X86_CPUID_FEATURE_ECX_SSE4_2 RT_BIT(20)
401/** ECX Bit 21 - x2APIC support. */
402#define X86_CPUID_FEATURE_ECX_X2APIC RT_BIT(21)
403/** ECX Bit 22 - MOVBE instruction. */
404#define X86_CPUID_FEATURE_ECX_MOVBE RT_BIT(22)
405/** ECX Bit 23 - POPCNT instruction. */
406#define X86_CPUID_FEATURE_ECX_POPCNT RT_BIT(23)
407/** ECX Bir 24 - TSC-Deadline. */
408#define X86_CPUID_FEATURE_ECX_TSCDEADL RT_BIT(24)
409/** ECX Bit 25 - AES instructions. */
410#define X86_CPUID_FEATURE_ECX_AES RT_BIT(25)
411/** ECX Bit 26 - XSAVE instruction. */
412#define X86_CPUID_FEATURE_ECX_XSAVE RT_BIT(26)
413/** ECX Bit 27 - OSXSAVE instruction. */
414#define X86_CPUID_FEATURE_ECX_OSXSAVE RT_BIT(27)
415/** ECX Bit 28 - AVX. */
416#define X86_CPUID_FEATURE_ECX_AVX RT_BIT(28)
417/** ECX Bit 31 - Hypervisor Present (software only). */
418#define X86_CPUID_FEATURE_ECX_HVP RT_BIT(31)
419
420
421/** Bit 0 - FPU - x87 FPU on Chip. */
422#define X86_CPUID_FEATURE_EDX_FPU RT_BIT(0)
423/** Bit 1 - VME - Virtual 8086 Mode Enhancements. */
424#define X86_CPUID_FEATURE_EDX_VME RT_BIT(1)
425/** Bit 2 - DE - Debugging extensions. */
426#define X86_CPUID_FEATURE_EDX_DE RT_BIT(2)
427/** Bit 3 - PSE - Page Size Extension. */
428#define X86_CPUID_FEATURE_EDX_PSE RT_BIT(3)
429/** Bit 4 - TSC - Time Stamp Counter. */
430#define X86_CPUID_FEATURE_EDX_TSC RT_BIT(4)
431/** Bit 5 - MSR - Model Specific Registers RDMSR and WRMSR Instructions. */
432#define X86_CPUID_FEATURE_EDX_MSR RT_BIT(5)
433/** Bit 6 - PAE - Physical Address Extension. */
434#define X86_CPUID_FEATURE_EDX_PAE RT_BIT(6)
435/** Bit 7 - MCE - Machine Check Exception. */
436#define X86_CPUID_FEATURE_EDX_MCE RT_BIT(7)
437/** Bit 8 - CX8 - CMPXCHG8B instruction. */
438#define X86_CPUID_FEATURE_EDX_CX8 RT_BIT(8)
439/** Bit 9 - APIC - APIC On-Chip. */
440#define X86_CPUID_FEATURE_EDX_APIC RT_BIT(9)
441/** Bit 11 - SEP - SYSENTER and SYSEXIT. */
442#define X86_CPUID_FEATURE_EDX_SEP RT_BIT(11)
443/** Bit 12 - MTRR - Memory Type Range Registers. */
444#define X86_CPUID_FEATURE_EDX_MTRR RT_BIT(12)
445/** Bit 13 - PGE - PTE Global Bit. */
446#define X86_CPUID_FEATURE_EDX_PGE RT_BIT(13)
447/** Bit 14 - MCA - Machine Check Architecture. */
448#define X86_CPUID_FEATURE_EDX_MCA RT_BIT(14)
449/** Bit 15 - CMOV - Conditional Move Instructions. */
450#define X86_CPUID_FEATURE_EDX_CMOV RT_BIT(15)
451/** Bit 16 - PAT - Page Attribute Table. */
452#define X86_CPUID_FEATURE_EDX_PAT RT_BIT(16)
453/** Bit 17 - PSE-36 - 36-bit Page Size Extention. */
454#define X86_CPUID_FEATURE_EDX_PSE36 RT_BIT(17)
455/** Bit 18 - PSN - Processor Serial Number. */
456#define X86_CPUID_FEATURE_EDX_PSN RT_BIT(18)
457/** Bit 19 - CLFSH - CLFLUSH Instruction. */
458#define X86_CPUID_FEATURE_EDX_CLFSH RT_BIT(19)
459/** Bit 21 - DS - Debug Store. */
460#define X86_CPUID_FEATURE_EDX_DS RT_BIT(21)
461/** Bit 22 - ACPI - Termal Monitor and Software Controlled Clock Facilities. */
462#define X86_CPUID_FEATURE_EDX_ACPI RT_BIT(22)
463/** Bit 23 - MMX - Intel MMX Technology. */
464#define X86_CPUID_FEATURE_EDX_MMX RT_BIT(23)
465/** Bit 24 - FXSR - FXSAVE and FXRSTOR Instructions. */
466#define X86_CPUID_FEATURE_EDX_FXSR RT_BIT(24)
467/** Bit 25 - SSE - SSE Support. */
468#define X86_CPUID_FEATURE_EDX_SSE RT_BIT(25)
469/** Bit 26 - SSE2 - SSE2 Support. */
470#define X86_CPUID_FEATURE_EDX_SSE2 RT_BIT(26)
471/** Bit 27 - SS - Self Snoop. */
472#define X86_CPUID_FEATURE_EDX_SS RT_BIT(27)
473/** Bit 28 - HTT - Hyper-Threading Technology. */
474#define X86_CPUID_FEATURE_EDX_HTT RT_BIT(28)
475/** Bit 29 - TM - Therm. Monitor. */
476#define X86_CPUID_FEATURE_EDX_TM RT_BIT(29)
477/** Bit 31 - PBE - Pending Break Enabled. */
478#define X86_CPUID_FEATURE_EDX_PBE RT_BIT(31)
479/** @} */
480
481/** @name CPUID mwait/monitor information.
482 * CPUID query with EAX=5.
483 * @{
484 */
485/** ECX Bit 0 - MWAITEXT - Supports mwait/monitor extensions or not. */
486#define X86_CPUID_MWAIT_ECX_EXT RT_BIT(0)
487/** ECX Bit 1 - MWAITBREAK - Break mwait for external interrupt even if EFLAGS.IF=0. */
488#define X86_CPUID_MWAIT_ECX_BREAKIRQIF0 RT_BIT(1)
489/** @} */
490
491
492/** @name CPUID AMD Feature information.
493 * CPUID query with EAX=0x80000001.
494 * @{
495 */
496/** Bit 0 - FPU - x87 FPU on Chip. */
497#define X86_CPUID_AMD_FEATURE_EDX_FPU RT_BIT(0)
498/** Bit 1 - VME - Virtual 8086 Mode Enhancements. */
499#define X86_CPUID_AMD_FEATURE_EDX_VME RT_BIT(1)
500/** Bit 2 - DE - Debugging extensions. */
501#define X86_CPUID_AMD_FEATURE_EDX_DE RT_BIT(2)
502/** Bit 3 - PSE - Page Size Extension. */
503#define X86_CPUID_AMD_FEATURE_EDX_PSE RT_BIT(3)
504/** Bit 4 - TSC - Time Stamp Counter. */
505#define X86_CPUID_AMD_FEATURE_EDX_TSC RT_BIT(4)
506/** Bit 5 - MSR - K86 Model Specific Registers RDMSR and WRMSR Instructions. */
507#define X86_CPUID_AMD_FEATURE_EDX_MSR RT_BIT(5)
508/** Bit 6 - PAE - Physical Address Extension. */
509#define X86_CPUID_AMD_FEATURE_EDX_PAE RT_BIT(6)
510/** Bit 7 - MCE - Machine Check Exception. */
511#define X86_CPUID_AMD_FEATURE_EDX_MCE RT_BIT(7)
512/** Bit 8 - CX8 - CMPXCHG8B instruction. */
513#define X86_CPUID_AMD_FEATURE_EDX_CX8 RT_BIT(8)
514/** Bit 9 - APIC - APIC On-Chip. */
515#define X86_CPUID_AMD_FEATURE_EDX_APIC RT_BIT(9)
516/** Bit 11 - SEP - AMD SYSCALL and SYSRET. */
517#define X86_CPUID_AMD_FEATURE_EDX_SEP RT_BIT(11)
518/** Bit 12 - MTRR - Memory Type Range Registers. */
519#define X86_CPUID_AMD_FEATURE_EDX_MTRR RT_BIT(12)
520/** Bit 13 - PGE - PTE Global Bit. */
521#define X86_CPUID_AMD_FEATURE_EDX_PGE RT_BIT(13)
522/** Bit 14 - MCA - Machine Check Architecture. */
523#define X86_CPUID_AMD_FEATURE_EDX_MCA RT_BIT(14)
524/** Bit 15 - CMOV - Conditional Move Instructions. */
525#define X86_CPUID_AMD_FEATURE_EDX_CMOV RT_BIT(15)
526/** Bit 16 - PAT - Page Attribute Table. */
527#define X86_CPUID_AMD_FEATURE_EDX_PAT RT_BIT(16)
528/** Bit 17 - PSE-36 - 36-bit Page Size Extention. */
529#define X86_CPUID_AMD_FEATURE_EDX_PSE36 RT_BIT(17)
530/** Bit 20 - NX - AMD No-Execute Page Protection. */
531#define X86_CPUID_AMD_FEATURE_EDX_NX RT_BIT(20)
532/** Bit 22 - AXMMX - AMD Extensions to MMX Instructions. */
533#define X86_CPUID_AMD_FEATURE_EDX_AXMMX RT_BIT(22)
534/** Bit 23 - MMX - Intel MMX Technology. */
535#define X86_CPUID_AMD_FEATURE_EDX_MMX RT_BIT(23)
536/** Bit 24 - FXSR - FXSAVE and FXRSTOR Instructions. */
537#define X86_CPUID_AMD_FEATURE_EDX_FXSR RT_BIT(24)
538/** Bit 25 - FFXSR - AMD fast FXSAVE and FXRSTOR Instructions. */
539#define X86_CPUID_AMD_FEATURE_EDX_FFXSR RT_BIT(25)
540/** Bit 26 - PAGE1GB - AMD 1GB large page support. */
541#define X86_CPUID_AMD_FEATURE_EDX_PAGE1GB RT_BIT(26)
542/** Bit 27 - RDTSCP - AMD RDTSCP instruction. */
543#define X86_CPUID_AMD_FEATURE_EDX_RDTSCP RT_BIT(27)
544/** Bit 29 - LM - AMD Long Mode. */
545#define X86_CPUID_AMD_FEATURE_EDX_LONG_MODE RT_BIT(29)
546/** Bit 30 - 3DNOWEXT - AMD Extensions to 3DNow. */
547#define X86_CPUID_AMD_FEATURE_EDX_3DNOW_EX RT_BIT(30)
548/** Bit 31 - 3DNOW - AMD 3DNow. */
549#define X86_CPUID_AMD_FEATURE_EDX_3DNOW RT_BIT(31)
550
551/** Bit 0 - LAHF/SAHF - AMD LAHF and SAHF in 64-bit mode. */
552#define X86_CPUID_AMD_FEATURE_ECX_LAHF_SAHF RT_BIT(0)
553/** Bit 1 - CMPL - Core multi-processing legacy mode. */
554#define X86_CPUID_AMD_FEATURE_ECX_CMPL RT_BIT(1)
555/** Bit 2 - SVM - AMD VM extensions. */
556#define X86_CPUID_AMD_FEATURE_ECX_SVM RT_BIT(2)
557/** Bit 3 - EXTAPIC - AMD extended APIC registers starting at 0x400. */
558#define X86_CPUID_AMD_FEATURE_ECX_EXT_APIC RT_BIT(3)
559/** Bit 4 - CR8L - AMD LOCK MOV CR0 means MOV CR8. */
560#define X86_CPUID_AMD_FEATURE_ECX_CR8L RT_BIT(4)
561/** Bit 5 - ABM - AMD Advanced bit manipulation. LZCNT instruction support. */
562#define X86_CPUID_AMD_FEATURE_ECX_ABM RT_BIT(5)
563/** Bit 6 - SSE4A - AMD EXTRQ, INSERTQ, MOVNTSS, and MOVNTSD instruction support. */
564#define X86_CPUID_AMD_FEATURE_ECX_SSE4A RT_BIT(6)
565/** Bit 7 - MISALIGNSSE - AMD Misaligned SSE mode. */
566#define X86_CPUID_AMD_FEATURE_ECX_MISALNSSE RT_BIT(7)
567/** Bit 8 - 3DNOWPRF - AMD PREFETCH and PREFETCHW instruction support. */
568#define X86_CPUID_AMD_FEATURE_ECX_3DNOWPRF RT_BIT(8)
569/** Bit 9 - OSVW - AMD OS visible workaround. */
570#define X86_CPUID_AMD_FEATURE_ECX_OSVW RT_BIT(9)
571/** Bit 10 - IBS - Instruct based sampling. */
572#define X86_CPUID_AMD_FEATURE_ECX_IBS RT_BIT(10)
573/** Bit 11 - SSE5 - SSE5 instruction support. */
574#define X86_CPUID_AMD_FEATURE_ECX_SSE5 RT_BIT(11)
575/** Bit 12 - SKINIT - AMD SKINIT: SKINIT, STGI, and DEV support. */
576#define X86_CPUID_AMD_FEATURE_ECX_SKINIT RT_BIT(12)
577/** Bit 13 - WDT - AMD Watchdog timer support. */
578#define X86_CPUID_AMD_FEATURE_ECX_WDT RT_BIT(13)
579
580/** @} */
581
582
583/** @name CPUID AMD Feature information.
584 * CPUID query with EAX=0x80000007.
585 * @{
586 */
587/** Bit 0 - TS - Temperature Sensor. */
588#define X86_CPUID_AMD_ADVPOWER_EDX_TS RT_BIT(0)
589/** Bit 1 - FID - Frequency ID Control. */
590#define X86_CPUID_AMD_ADVPOWER_EDX_FID RT_BIT(1)
591/** Bit 2 - VID - Voltage ID Control. */
592#define X86_CPUID_AMD_ADVPOWER_EDX_VID RT_BIT(2)
593/** Bit 3 - TTP - THERMTRIP. */
594#define X86_CPUID_AMD_ADVPOWER_EDX_TTP RT_BIT(3)
595/** Bit 4 - TM - Hardware Thermal Control. */
596#define X86_CPUID_AMD_ADVPOWER_EDX_TM RT_BIT(4)
597/** Bit 5 - STC - Software Thermal Control. */
598#define X86_CPUID_AMD_ADVPOWER_EDX_STC RT_BIT(5)
599/** Bit 6 - MC - 100 Mhz Multiplier Control. */
600#define X86_CPUID_AMD_ADVPOWER_EDX_MC RT_BIT(6)
601/** Bit 7 - HWPSTATE - Hardware P-State Control. */
602#define X86_CPUID_AMD_ADVPOWER_EDX_HWPSTATE RT_BIT(7)
603/** Bit 8 - TSCINVAR - TSC Invariant. */
604#define X86_CPUID_AMD_ADVPOWER_EDX_TSCINVAR RT_BIT(8)
605/** @} */
606
607
608/** @name CR0
609 * @{ */
610/** Bit 0 - PE - Protection Enabled */
611#define X86_CR0_PE RT_BIT(0)
612#define X86_CR0_PROTECTION_ENABLE RT_BIT(0)
613/** Bit 1 - MP - Monitor Coprocessor */
614#define X86_CR0_MP RT_BIT(1)
615#define X86_CR0_MONITOR_COPROCESSOR RT_BIT(1)
616/** Bit 2 - EM - Emulation. */
617#define X86_CR0_EM RT_BIT(2)
618#define X86_CR0_EMULATE_FPU RT_BIT(2)
619/** Bit 3 - TS - Task Switch. */
620#define X86_CR0_TS RT_BIT(3)
621#define X86_CR0_TASK_SWITCH RT_BIT(3)
622/** Bit 4 - ET - Extension flag. ('hardcoded' to 1) */
623#define X86_CR0_ET RT_BIT(4)
624#define X86_CR0_EXTENSION_TYPE RT_BIT(4)
625/** Bit 5 - NE - Numeric error. */
626#define X86_CR0_NE RT_BIT(5)
627#define X86_CR0_NUMERIC_ERROR RT_BIT(5)
628/** Bit 16 - WP - Write Protect. */
629#define X86_CR0_WP RT_BIT(16)
630#define X86_CR0_WRITE_PROTECT RT_BIT(16)
631/** Bit 18 - AM - Alignment Mask. */
632#define X86_CR0_AM RT_BIT(18)
633#define X86_CR0_ALIGMENT_MASK RT_BIT(18)
634/** Bit 29 - NW - Not Write-though. */
635#define X86_CR0_NW RT_BIT(29)
636#define X86_CR0_NOT_WRITE_THROUGH RT_BIT(29)
637/** Bit 30 - WP - Cache Disable. */
638#define X86_CR0_CD RT_BIT(30)
639#define X86_CR0_CACHE_DISABLE RT_BIT(30)
640/** Bit 31 - PG - Paging. */
641#define X86_CR0_PG RT_BIT(31)
642#define X86_CR0_PAGING RT_BIT(31)
643/** @} */
644
645
646/** @name CR3
647 * @{ */
648/** Bit 3 - PWT - Page-level Writes Transparent. */
649#define X86_CR3_PWT RT_BIT(3)
650/** Bit 4 - PCD - Page-level Cache Disable. */
651#define X86_CR3_PCD RT_BIT(4)
652/** Bits 12-31 - - Page directory page number. */
653#define X86_CR3_PAGE_MASK (0xfffff000)
654/** Bits 5-31 - - PAE Page directory page number. */
655#define X86_CR3_PAE_PAGE_MASK (0xffffffe0)
656/** Bits 12-51 - - AMD64 Page directory page number. */
657#define X86_CR3_AMD64_PAGE_MASK UINT64_C(0x000ffffffffff000)
658/** @} */
659
660
661/** @name CR4
662 * @{ */
663/** Bit 0 - VME - Virtual-8086 Mode Extensions. */
664#define X86_CR4_VME RT_BIT(0)
665/** Bit 1 - PVI - Protected-Mode Virtual Interrupts. */
666#define X86_CR4_PVI RT_BIT(1)
667/** Bit 2 - TSD - Time Stamp Disable. */
668#define X86_CR4_TSD RT_BIT(2)
669/** Bit 3 - DE - Debugging Extensions. */
670#define X86_CR4_DE RT_BIT(3)
671/** Bit 4 - PSE - Page Size Extension. */
672#define X86_CR4_PSE RT_BIT(4)
673/** Bit 5 - PAE - Physical Address Extension. */
674#define X86_CR4_PAE RT_BIT(5)
675/** Bit 6 - MCE - Machine-Check Enable. */
676#define X86_CR4_MCE RT_BIT(6)
677/** Bit 7 - PGE - Page Global Enable. */
678#define X86_CR4_PGE RT_BIT(7)
679/** Bit 8 - PCE - Performance-Monitoring Counter Enable. */
680#define X86_CR4_PCE RT_BIT(8)
681/** Bit 9 - OSFSXR - Operating System Support for FXSAVE and FXRSTORE instruction. */
682#define X86_CR4_OSFSXR RT_BIT(9)
683/** Bit 10 - OSXMMEEXCPT - Operating System Support for Unmasked SIMD Floating-Point Exceptions. */
684#define X86_CR4_OSXMMEEXCPT RT_BIT(10)
685/** Bit 13 - VMXE - VMX mode is enabled. */
686#define X86_CR4_VMXE RT_BIT(13)
687/** @} */
688
689
690/** @name DR6
691 * @{ */
692/** Bit 0 - B0 - Breakpoint 0 condition detected. */
693#define X86_DR6_B0 RT_BIT(0)
694/** Bit 1 - B1 - Breakpoint 1 condition detected. */
695#define X86_DR6_B1 RT_BIT(1)
696/** Bit 2 - B2 - Breakpoint 2 condition detected. */
697#define X86_DR6_B2 RT_BIT(2)
698/** Bit 3 - B3 - Breakpoint 3 condition detected. */
699#define X86_DR6_B3 RT_BIT(3)
700/** Bit 13 - BD - Debug register access detected. Corresponds to the X86_DR7_GD bit. */
701#define X86_DR6_BD RT_BIT(13)
702/** Bit 14 - BS - Single step */
703#define X86_DR6_BS RT_BIT(14)
704/** Bit 15 - BT - Task switch. (TSS T bit.) */
705#define X86_DR6_BT RT_BIT(15)
706/** Value of DR6 after powerup/reset. */
707#define X86_DR6_INIT_VAL UINT64_C(0xFFFF0FF0)
708/** @} */
709
710
711/** @name DR7
712 * @{ */
713/** Bit 0 - L0 - Local breakpoint enable. Cleared on task switch. */
714#define X86_DR7_L0 RT_BIT(0)
715/** Bit 1 - G0 - Global breakpoint enable. Not cleared on task switch. */
716#define X86_DR7_G0 RT_BIT(1)
717/** Bit 2 - L1 - Local breakpoint enable. Cleared on task switch. */
718#define X86_DR7_L1 RT_BIT(2)
719/** Bit 3 - G1 - Global breakpoint enable. Not cleared on task switch. */
720#define X86_DR7_G1 RT_BIT(3)
721/** Bit 4 - L2 - Local breakpoint enable. Cleared on task switch. */
722#define X86_DR7_L2 RT_BIT(4)
723/** Bit 5 - G2 - Global breakpoint enable. Not cleared on task switch. */
724#define X86_DR7_G2 RT_BIT(5)
725/** Bit 6 - L3 - Local breakpoint enable. Cleared on task switch. */
726#define X86_DR7_L3 RT_BIT(6)
727/** Bit 7 - G3 - Global breakpoint enable. Not cleared on task switch. */
728#define X86_DR7_G3 RT_BIT(7)
729/** Bit 8 - LE - Local breakpoint exact. (Not supported (read ignored) by P6 and later.) */
730#define X86_DR7_LE RT_BIT(8)
731/** Bit 9 - GE - Local breakpoint exact. (Not supported (read ignored) by P6 and later.) */
732#define X86_DR7_GE RT_BIT(9)
733
734/** Bit 13 - GD - General detect enable. Enables emulators to get exceptions when
735 * any DR register is accessed. */
736#define X86_DR7_GD RT_BIT(13)
737/** Bit 16 & 17 - R/W0 - Read write field 0. Values X86_DR7_RW_*. */
738#define X86_DR7_RW0_MASK (3 << 16)
739/** Bit 18 & 19 - LEN0 - Length field 0. Values X86_DR7_LEN_*. */
740#define X86_DR7_LEN0_MASK (3 << 18)
741/** Bit 20 & 21 - R/W1 - Read write field 0. Values X86_DR7_RW_*. */
742#define X86_DR7_RW1_MASK (3 << 20)
743/** Bit 22 & 23 - LEN1 - Length field 0. Values X86_DR7_LEN_*. */
744#define X86_DR7_LEN1_MASK (3 << 22)
745/** Bit 24 & 25 - R/W2 - Read write field 0. Values X86_DR7_RW_*. */
746#define X86_DR7_RW2_MASK (3 << 24)
747/** Bit 26 & 27 - LEN2 - Length field 0. Values X86_DR7_LEN_*. */
748#define X86_DR7_LEN2_MASK (3 << 26)
749/** Bit 28 & 29 - R/W3 - Read write field 0. Values X86_DR7_RW_*. */
750#define X86_DR7_RW3_MASK (3 << 28)
751/** Bit 30 & 31 - LEN3 - Length field 0. Values X86_DR7_LEN_*. */
752#define X86_DR7_LEN3_MASK (3 << 30)
753
754/** Bits which must be 1s. */
755#define X86_DR7_MB1_MASK (RT_BIT(10))
756
757/** Calcs the L bit of Nth breakpoint.
758 * @param iBp The breakpoint number [0..3].
759 */
760#define X86_DR7_L(iBp) ( UINT32_C(1) << (iBp * 2) )
761
762/** Calcs the G bit of Nth breakpoint.
763 * @param iBp The breakpoint number [0..3].
764 */
765#define X86_DR7_G(iBp) ( UINT32_C(1) << (iBp * 2 + 1) )
766
767/** @name Read/Write values.
768 * @{ */
769/** Break on instruction fetch only. */
770#define X86_DR7_RW_EO 0U
771/** Break on write only. */
772#define X86_DR7_RW_WO 1U
773/** Break on I/O read/write. This is only defined if CR4.DE is set. */
774#define X86_DR7_RW_IO 2U
775/** Break on read or write (but not instruction fetches). */
776#define X86_DR7_RW_RW 3U
777/** @} */
778
779/** Shifts a X86_DR7_RW_* value to its right place.
780 * @param iBp The breakpoint number [0..3].
781 * @param fRw One of the X86_DR7_RW_* value.
782 */
783#define X86_DR7_RW(iBp, fRw) ( (fRw) << ((iBp) * 4 + 16) )
784
785/** @name Length values.
786 * @{ */
787#define X86_DR7_LEN_BYTE 0U
788#define X86_DR7_LEN_WORD 1U
789#define X86_DR7_LEN_QWORD 2U /**< AMD64 long mode only. */
790#define X86_DR7_LEN_DWORD 3U
791/** @} */
792
793/** Shifts a X86_DR7_LEN_* value to its right place.
794 * @param iBp The breakpoint number [0..3].
795 * @param cb One of the X86_DR7_LEN_* values.
796 */
797#define X86_DR7_LEN(iBp, cb) ( (cb) << ((iBp) * 4 + 18) )
798
799/** Fetch the breakpoint length bits from the DR7 value.
800 * @param uDR7 DR7 value
801 * @param iBp The breakpoint number [0..3].
802 */
803#define X86_DR7_GET_LEN(uDR7, iBp) ( ( (uDR7) >> ((iBp) * 4 + 18) ) & 0x3U)
804
805/** Mask used to check if any breakpoints are enabled. */
806#define X86_DR7_ENABLED_MASK (RT_BIT(0) | RT_BIT(1) | RT_BIT(2) | RT_BIT(3) | RT_BIT(4) | RT_BIT(5) | RT_BIT(6) | RT_BIT(7))
807
808/** Mask used to check if any io breakpoints are set. */
809#define X86_DR7_IO_ENABLED_MASK (X86_DR7_RW(0, X86_DR7_RW_IO) | X86_DR7_RW(1, X86_DR7_RW_IO) | X86_DR7_RW(2, X86_DR7_RW_IO) | X86_DR7_RW(3, X86_DR7_RW_IO))
810
811/** Value of DR7 after powerup/reset. */
812#define X86_DR7_INIT_VAL 0x400
813/** @} */
814
815
816/** @name Machine Specific Registers
817 * @{
818 */
819
820/** Time Stamp Counter. */
821#define MSR_IA32_TSC 0x10
822
823#define MSR_IA32_PLATFORM_ID 0x17
824
825#ifndef MSR_IA32_APICBASE /* qemu cpu.h kludge */
826#define MSR_IA32_APICBASE 0x1b
827#endif
828
829/** CPU Feature control. */
830#define MSR_IA32_FEATURE_CONTROL 0x3A
831#define MSR_IA32_FEATURE_CONTROL_LOCK RT_BIT(0)
832#define MSR_IA32_FEATURE_CONTROL_VMXON RT_BIT(2)
833
834/** BIOS update trigger (microcode update). */
835#define MSR_IA32_BIOS_UPDT_TRIG 0x79
836
837/** BIOS update signature (microcode). */
838#define MSR_IA32_BIOS_SIGN_ID 0x8B
839
840/** General performance counter no. 0. */
841#define MSR_IA32_PMC0 0xC1
842/** General performance counter no. 1. */
843#define MSR_IA32_PMC1 0xC2
844/** General performance counter no. 2. */
845#define MSR_IA32_PMC2 0xC3
846/** General performance counter no. 3. */
847#define MSR_IA32_PMC3 0xC4
848
849/** Nehalem power control. */
850#define MSR_IA32_PLATFORM_INFO 0xCE
851
852/** Get FSB clock status (Intel-specific). */
853#define MSR_IA32_FSB_CLOCK_STS 0xCD
854
855/** MTRR Capabilities. */
856#define MSR_IA32_MTRR_CAP 0xFE
857
858
859#ifndef MSR_IA32_SYSENTER_CS /* qemu cpu.h kludge */
860/** SYSENTER_CS - the R0 CS, indirectly giving R0 SS, R3 CS and R3 DS.
861 * R0 SS == CS + 8
862 * R3 CS == CS + 16
863 * R3 SS == CS + 24
864 */
865#define MSR_IA32_SYSENTER_CS 0x174
866/** SYSENTER_ESP - the R0 ESP. */
867#define MSR_IA32_SYSENTER_ESP 0x175
868/** SYSENTER_EIP - the R0 EIP. */
869#define MSR_IA32_SYSENTER_EIP 0x176
870#endif
871
872/** Machine Check Global Capabilities Register. */
873#define MSR_IA32_MCP_CAP 0x179
874/** Machine Check Global Status Register. */
875#define MSR_IA32_MCP_STATUS 0x17A
876/** Machine Check Global Control Register. */
877#define MSR_IA32_MCP_CTRL 0x17B
878
879/** Trace/Profile Resource Control (R/W) */
880#define MSR_IA32_DEBUGCTL 0x1D9
881
882/** Page Attribute Table. */
883#define MSR_IA32_CR_PAT 0x277
884
885/** Performance counter MSRs. (Intel only) */
886#define MSR_IA32_PERFEVTSEL0 0x186
887#define MSR_IA32_PERFEVTSEL1 0x187
888#define MSR_IA32_FLEX_RATIO 0x194
889#define MSR_IA32_PERF_STATUS 0x198
890#define MSR_IA32_PERF_CTL 0x199
891#define MSR_IA32_THERM_STATUS 0x19c
892
893/** Enable misc. processor features (R/W). */
894#define MSR_IA32_MISC_ENABLE 0x1A0
895/** Enable fast-strings feature (for REP MOVS and REP STORS). */
896#define MSR_IA32_MISC_ENABLE_FAST_STRINGS RT_BIT(0)
897/** Automatic Thermal Control Circuit Enable (R/W). */
898#define MSR_IA32_MISC_ENABLE_TCC RT_BIT(3)
899/** Performance Monitoring Available (R). */
900#define MSR_IA32_MISC_ENABLE_PERF_MON RT_BIT(7)
901/** Branch Trace Storage Unavailable (R/O). */
902#define MSR_IA32_MISC_ENABLE_BTS_UNAVAIL RT_BIT(11)
903/** Precise Event Based Sampling (PEBS) Unavailable (R/O). */
904#define MSR_IA32_MISC_ENABLE_PEBS_UNAVAIL RT_BIT(12)
905/** Enhanced Intel SpeedStep Technology Enable (R/W). */
906#define MSR_IA32_MISC_ENABLE_SST_ENABLE RT_BIT(16)
907/** If MONITOR/MWAIT is supported (R/W). */
908#define MSR_IA32_MISC_ENABLE_MONITOR RT_BIT(18)
909/** Limit CPUID Maxval to 3 leafs (R/W). */
910#define MSR_IA32_MISC_ENABLE_LIMIT_CPUID RT_BIT(22)
911/** When set to 1, xTPR messages are disabled (R/W). */
912#define MSR_IA32_MISC_ENABLE_XTPR_MSG_DISABLE RT_BIT(23)
913/** When set to 1, the Execute Disable Bit feature (XD Bit) is disabled (R/W). */
914#define MSR_IA32_MISC_ENABLE_XD_DISABLE RT_BIT(34)
915
916/** MTRR Default Range. */
917#define MSR_IA32_MTRR_DEF_TYPE 0x2FF
918
919#define MSR_IA32_MC0_CTL 0x400
920#define MSR_IA32_MC0_STATUS 0x401
921
922/** Basic VMX information. */
923#define MSR_IA32_VMX_BASIC_INFO 0x480
924/** Allowed settings for pin-based VM execution controls */
925#define MSR_IA32_VMX_PINBASED_CTLS 0x481
926/** Allowed settings for proc-based VM execution controls */
927#define MSR_IA32_VMX_PROCBASED_CTLS 0x482
928/** Allowed settings for the VMX exit controls. */
929#define MSR_IA32_VMX_EXIT_CTLS 0x483
930/** Allowed settings for the VMX entry controls. */
931#define MSR_IA32_VMX_ENTRY_CTLS 0x484
932/** Misc VMX info. */
933#define MSR_IA32_VMX_MISC 0x485
934/** Fixed cleared bits in CR0. */
935#define MSR_IA32_VMX_CR0_FIXED0 0x486
936/** Fixed set bits in CR0. */
937#define MSR_IA32_VMX_CR0_FIXED1 0x487
938/** Fixed cleared bits in CR4. */
939#define MSR_IA32_VMX_CR4_FIXED0 0x488
940/** Fixed set bits in CR4. */
941#define MSR_IA32_VMX_CR4_FIXED1 0x489
942/** Information for enumerating fields in the VMCS. */
943#define MSR_IA32_VMX_VMCS_ENUM 0x48A
944/** Allowed settings for secondary proc-based VM execution controls */
945#define MSR_IA32_VMX_PROCBASED_CTLS2 0x48B
946/** EPT capabilities. */
947#define MSR_IA32_VMX_EPT_CAPS 0x48C
948/** DS Save Area (R/W). */
949#define MSR_IA32_DS_AREA 0x600
950/** X2APIC MSR ranges. */
951#define MSR_IA32_APIC_START 0x800
952#define MSR_IA32_APIC_END 0x900
953
954/** K6 EFER - Extended Feature Enable Register. */
955#define MSR_K6_EFER 0xc0000080
956/** @todo document EFER */
957/** Bit 0 - SCE - System call extensions (SYSCALL / SYSRET). (R/W) */
958#define MSR_K6_EFER_SCE RT_BIT(0)
959/** Bit 8 - LME - Long mode enabled. (R/W) */
960#define MSR_K6_EFER_LME RT_BIT(8)
961/** Bit 10 - LMA - Long mode active. (R) */
962#define MSR_K6_EFER_LMA RT_BIT(10)
963/** Bit 11 - NXE - No-Execute Page Protection Enabled. (R/W) */
964#define MSR_K6_EFER_NXE RT_BIT(11)
965/** Bit 12 - SVME - Secure VM Extension Enabled. (R/W) */
966#define MSR_K6_EFER_SVME RT_BIT(12)
967/** Bit 13 - LMSLE - Long Mode Segment Limit Enable. (R/W?) */
968#define MSR_K6_EFER_LMSLE RT_BIT(13)
969/** Bit 14 - FFXSR - Fast FXSAVE / FXRSTOR (skip XMM*). (R/W) */
970#define MSR_K6_EFER_FFXSR RT_BIT(14)
971/** K6 STAR - SYSCALL/RET targets. */
972#define MSR_K6_STAR 0xc0000081
973/** Shift value for getting the SYSRET CS and SS value. */
974#define MSR_K6_STAR_SYSRET_CS_SS_SHIFT 48
975/** Shift value for getting the SYSCALL CS and SS value. */
976#define MSR_K6_STAR_SYSCALL_CS_SS_SHIFT 32
977/** Selector mask for use after shifting. */
978#define MSR_K6_STAR_SEL_MASK 0xffff
979/** The mask which give the SYSCALL EIP. */
980#define MSR_K6_STAR_SYSCALL_EIP_MASK 0xffffffff
981/** K6 WHCR - Write Handling Control Register. */
982#define MSR_K6_WHCR 0xc0000082
983/** K6 UWCCR - UC/WC Cacheability Control Register. */
984#define MSR_K6_UWCCR 0xc0000085
985/** K6 PSOR - Processor State Observability Register. */
986#define MSR_K6_PSOR 0xc0000087
987/** K6 PFIR - Page Flush/Invalidate Register. */
988#define MSR_K6_PFIR 0xc0000088
989
990/** Performance counter MSRs. (AMD only) */
991#define MSR_K7_EVNTSEL0 0xc0010000
992#define MSR_K7_EVNTSEL1 0xc0010001
993#define MSR_K7_EVNTSEL2 0xc0010002
994#define MSR_K7_EVNTSEL3 0xc0010003
995#define MSR_K7_PERFCTR0 0xc0010004
996#define MSR_K7_PERFCTR1 0xc0010005
997#define MSR_K7_PERFCTR2 0xc0010006
998#define MSR_K7_PERFCTR3 0xc0010007
999
1000#define MSR_K8_HWCR 0xc0010015
1001
1002/** K8 LSTAR - Long mode SYSCALL target (RIP). */
1003#define MSR_K8_LSTAR 0xc0000082
1004/** K8 CSTAR - Compatibility mode SYSCALL target (RIP). */
1005#define MSR_K8_CSTAR 0xc0000083
1006/** K8 SF_MASK - SYSCALL flag mask. (aka SFMASK) */
1007#define MSR_K8_SF_MASK 0xc0000084
1008/** K8 FS.base - The 64-bit base FS register. */
1009#define MSR_K8_FS_BASE 0xc0000100
1010/** K8 GS.base - The 64-bit base GS register. */
1011#define MSR_K8_GS_BASE 0xc0000101
1012/** K8 KernelGSbase - Used with SWAPGS. */
1013#define MSR_K8_KERNEL_GS_BASE 0xc0000102
1014#define MSR_K8_TSC_AUX 0xc0000103
1015#define MSR_K8_SYSCFG 0xc0010010
1016#define MSR_K8_HWCR 0xc0010015
1017#define MSR_K8_IORRBASE0 0xc0010016
1018#define MSR_K8_IORRMASK0 0xc0010017
1019#define MSR_K8_IORRBASE1 0xc0010018
1020#define MSR_K8_IORRMASK1 0xc0010019
1021#define MSR_K8_TOP_MEM1 0xc001001a
1022#define MSR_K8_TOP_MEM2 0xc001001d
1023#define MSR_K8_VM_CR 0xc0010114
1024#define MSR_K8_VM_CR_SVM_DISABLE RT_BIT(4)
1025
1026#define MSR_K8_IGNNE 0xc0010115
1027#define MSR_K8_SMM_CTL 0xc0010116
1028/** SVM - VM_HSAVE_PA - Physical address for saving and restoring
1029 * host state during world switch.
1030 */
1031#define MSR_K8_VM_HSAVE_PA 0xc0010117
1032
1033/** @} */
1034
1035
1036/** @name Page Table / Directory / Directory Pointers / L4.
1037 * @{
1038 */
1039
1040/** Page table/directory entry as an unsigned integer. */
1041typedef uint32_t X86PGUINT;
1042/** Pointer to a page table/directory table entry as an unsigned integer. */
1043typedef X86PGUINT *PX86PGUINT;
1044/** Pointer to an const page table/directory table entry as an unsigned integer. */
1045typedef X86PGUINT const *PCX86PGUINT;
1046
1047/** Number of entries in a 32-bit PT/PD. */
1048#define X86_PG_ENTRIES 1024
1049
1050
1051/** PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1052typedef uint64_t X86PGPAEUINT;
1053/** Pointer to a PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1054typedef X86PGPAEUINT *PX86PGPAEUINT;
1055/** Pointer to an const PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
1056typedef X86PGPAEUINT const *PCX86PGPAEUINT;
1057
1058/** Number of entries in a PAE PT/PD. */
1059#define X86_PG_PAE_ENTRIES 512
1060/** Number of entries in a PAE PDPT. */
1061#define X86_PG_PAE_PDPE_ENTRIES 4
1062
1063/** Number of entries in an AMD64 PT/PD/PDPT/L4/L5. */
1064#define X86_PG_AMD64_ENTRIES X86_PG_PAE_ENTRIES
1065/** Number of entries in an AMD64 PDPT.
1066 * Just for complementing X86_PG_PAE_PDPE_ENTRIES, using X86_PG_AMD64_ENTRIES for this is fine too. */
1067#define X86_PG_AMD64_PDPE_ENTRIES X86_PG_AMD64_ENTRIES
1068
1069/** The size of a 4KB page. */
1070#define X86_PAGE_4K_SIZE _4K
1071/** The page shift of a 4KB page. */
1072#define X86_PAGE_4K_SHIFT 12
1073/** The 4KB page offset mask. */
1074#define X86_PAGE_4K_OFFSET_MASK 0xfff
1075/** The 4KB page base mask for virtual addresses. */
1076#define X86_PAGE_4K_BASE_MASK 0xfffffffffffff000ULL
1077/** The 4KB page base mask for virtual addresses - 32bit version. */
1078#define X86_PAGE_4K_BASE_MASK_32 0xfffff000U
1079
1080/** The size of a 2MB page. */
1081#define X86_PAGE_2M_SIZE _2M
1082/** The page shift of a 2MB page. */
1083#define X86_PAGE_2M_SHIFT 21
1084/** The 2MB page offset mask. */
1085#define X86_PAGE_2M_OFFSET_MASK 0x001fffff
1086/** The 2MB page base mask for virtual addresses. */
1087#define X86_PAGE_2M_BASE_MASK 0xffffffffffe00000ULL
1088/** The 2MB page base mask for virtual addresses - 32bit version. */
1089#define X86_PAGE_2M_BASE_MASK_32 0xffe00000U
1090
1091/** The size of a 4MB page. */
1092#define X86_PAGE_4M_SIZE _4M
1093/** The page shift of a 4MB page. */
1094#define X86_PAGE_4M_SHIFT 22
1095/** The 4MB page offset mask. */
1096#define X86_PAGE_4M_OFFSET_MASK 0x003fffff
1097/** The 4MB page base mask for virtual addresses. */
1098#define X86_PAGE_4M_BASE_MASK 0xffffffffffc00000ULL
1099/** The 4MB page base mask for virtual addresses - 32bit version. */
1100#define X86_PAGE_4M_BASE_MASK_32 0xffc00000U
1101
1102
1103
1104/** @name Page Table Entry
1105 * @{
1106 */
1107/** Bit 0 - P - Present bit. */
1108#define X86_PTE_BIT_P 0
1109/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1110#define X86_PTE_BIT_RW 1
1111/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1112#define X86_PTE_BIT_US 2
1113/** Bit 3 - PWT - Page level write thru bit. */
1114#define X86_PTE_BIT_PWT 3
1115/** Bit 4 - PCD - Page level cache disable bit. */
1116#define X86_PTE_BIT_PCD 4
1117/** Bit 5 - A - Access bit. */
1118#define X86_PTE_BIT_A 5
1119/** Bit 6 - D - Dirty bit. */
1120#define X86_PTE_BIT_D 6
1121/** Bit 7 - PAT - Page Attribute Table index bit. Reserved and 0 if not supported. */
1122#define X86_PTE_BIT_PAT 7
1123/** Bit 8 - G - Global flag. */
1124#define X86_PTE_BIT_G 8
1125
1126/** Bit 0 - P - Present bit mask. */
1127#define X86_PTE_P RT_BIT(0)
1128/** Bit 1 - R/W - Read (clear) / Write (set) bit mask. */
1129#define X86_PTE_RW RT_BIT(1)
1130/** Bit 2 - U/S - User (set) / Supervisor (clear) bit mask. */
1131#define X86_PTE_US RT_BIT(2)
1132/** Bit 3 - PWT - Page level write thru bit mask. */
1133#define X86_PTE_PWT RT_BIT(3)
1134/** Bit 4 - PCD - Page level cache disable bit mask. */
1135#define X86_PTE_PCD RT_BIT(4)
1136/** Bit 5 - A - Access bit mask. */
1137#define X86_PTE_A RT_BIT(5)
1138/** Bit 6 - D - Dirty bit mask. */
1139#define X86_PTE_D RT_BIT(6)
1140/** Bit 7 - PAT - Page Attribute Table index bit mask. Reserved and 0 if not supported. */
1141#define X86_PTE_PAT RT_BIT(7)
1142/** Bit 8 - G - Global bit mask. */
1143#define X86_PTE_G RT_BIT(8)
1144
1145/** Bits 9-11 - - Available for use to system software. */
1146#define X86_PTE_AVL_MASK (RT_BIT(9) | RT_BIT(10) | RT_BIT(11))
1147/** Bits 12-31 - - Physical Page number of the next level. */
1148#define X86_PTE_PG_MASK ( 0xfffff000 )
1149
1150/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1151#define X86_PTE_PAE_PG_MASK UINT64_C(0x000ffffffffff000)
1152/** Bits 63 - NX - PAE/LM - No execution flag. */
1153#define X86_PTE_PAE_NX RT_BIT_64(63)
1154/** Bits 62-52 - - PAE - MBZ bits when NX is active. */
1155#define X86_PTE_PAE_MBZ_MASK_NX UINT64_C(0x7ff0000000000000)
1156/** Bits 63-52 - - PAE - MBZ bits when no NX. */
1157#define X86_PTE_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff0000000000000)
1158/** No bits - - LM - MBZ bits when NX is active. */
1159#define X86_PTE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000000)
1160/** Bits 63 - - LM - MBZ bits when no NX. */
1161#define X86_PTE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000000)
1162
1163/**
1164 * Page table entry.
1165 */
1166typedef struct X86PTEBITS
1167{
1168 /** Flags whether(=1) or not the page is present. */
1169 unsigned u1Present : 1;
1170 /** Read(=0) / Write(=1) flag. */
1171 unsigned u1Write : 1;
1172 /** User(=1) / Supervisor (=0) flag. */
1173 unsigned u1User : 1;
1174 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1175 unsigned u1WriteThru : 1;
1176 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1177 unsigned u1CacheDisable : 1;
1178 /** Accessed flag.
1179 * Indicates that the page have been read or written to. */
1180 unsigned u1Accessed : 1;
1181 /** Dirty flag.
1182 * Indicates that the page has been written to. */
1183 unsigned u1Dirty : 1;
1184 /** Reserved / If PAT enabled, bit 2 of the index. */
1185 unsigned u1PAT : 1;
1186 /** Global flag. (Ignored in all but final level.) */
1187 unsigned u1Global : 1;
1188 /** Available for use to system software. */
1189 unsigned u3Available : 3;
1190 /** Physical Page number of the next level. */
1191 unsigned u20PageNo : 20;
1192} X86PTEBITS;
1193/** Pointer to a page table entry. */
1194typedef X86PTEBITS *PX86PTEBITS;
1195/** Pointer to a const page table entry. */
1196typedef const X86PTEBITS *PCX86PTEBITS;
1197
1198/**
1199 * Page table entry.
1200 */
1201typedef union X86PTE
1202{
1203 /** Unsigned integer view */
1204 X86PGUINT u;
1205 /** Bit field view. */
1206 X86PTEBITS n;
1207 /** 32-bit view. */
1208 uint32_t au32[1];
1209 /** 16-bit view. */
1210 uint16_t au16[2];
1211 /** 8-bit view. */
1212 uint8_t au8[4];
1213} X86PTE;
1214/** Pointer to a page table entry. */
1215typedef X86PTE *PX86PTE;
1216/** Pointer to a const page table entry. */
1217typedef const X86PTE *PCX86PTE;
1218
1219
1220/**
1221 * PAE page table entry.
1222 */
1223typedef struct X86PTEPAEBITS
1224{
1225 /** Flags whether(=1) or not the page is present. */
1226 uint32_t u1Present : 1;
1227 /** Read(=0) / Write(=1) flag. */
1228 uint32_t u1Write : 1;
1229 /** User(=1) / Supervisor(=0) flag. */
1230 uint32_t u1User : 1;
1231 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1232 uint32_t u1WriteThru : 1;
1233 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1234 uint32_t u1CacheDisable : 1;
1235 /** Accessed flag.
1236 * Indicates that the page have been read or written to. */
1237 uint32_t u1Accessed : 1;
1238 /** Dirty flag.
1239 * Indicates that the page has been written to. */
1240 uint32_t u1Dirty : 1;
1241 /** Reserved / If PAT enabled, bit 2 of the index. */
1242 uint32_t u1PAT : 1;
1243 /** Global flag. (Ignored in all but final level.) */
1244 uint32_t u1Global : 1;
1245 /** Available for use to system software. */
1246 uint32_t u3Available : 3;
1247 /** Physical Page number of the next level - Low Part. Don't use this. */
1248 uint32_t u20PageNoLow : 20;
1249 /** Physical Page number of the next level - High Part. Don't use this. */
1250 uint32_t u20PageNoHigh : 20;
1251 /** MBZ bits */
1252 uint32_t u11Reserved : 11;
1253 /** No Execute flag. */
1254 uint32_t u1NoExecute : 1;
1255} X86PTEPAEBITS;
1256/** Pointer to a page table entry. */
1257typedef X86PTEPAEBITS *PX86PTEPAEBITS;
1258/** Pointer to a page table entry. */
1259typedef const X86PTEPAEBITS *PCX86PTEPAEBITS;
1260
1261/**
1262 * PAE Page table entry.
1263 */
1264typedef union X86PTEPAE
1265{
1266 /** Unsigned integer view */
1267 X86PGPAEUINT u;
1268 /** Bit field view. */
1269 X86PTEPAEBITS n;
1270 /** 32-bit view. */
1271 uint32_t au32[2];
1272 /** 16-bit view. */
1273 uint16_t au16[4];
1274 /** 8-bit view. */
1275 uint8_t au8[8];
1276} X86PTEPAE;
1277/** Pointer to a PAE page table entry. */
1278typedef X86PTEPAE *PX86PTEPAE;
1279/** Pointer to a const PAE page table entry. */
1280typedef const X86PTEPAE *PCX86PTEPAE;
1281/** @} */
1282
1283/**
1284 * Page table.
1285 */
1286typedef struct X86PT
1287{
1288 /** PTE Array. */
1289 X86PTE a[X86_PG_ENTRIES];
1290} X86PT;
1291/** Pointer to a page table. */
1292typedef X86PT *PX86PT;
1293/** Pointer to a const page table. */
1294typedef const X86PT *PCX86PT;
1295
1296/** The page shift to get the PT index. */
1297#define X86_PT_SHIFT 12
1298/** The PT index mask (apply to a shifted page address). */
1299#define X86_PT_MASK 0x3ff
1300
1301
1302/**
1303 * Page directory.
1304 */
1305typedef struct X86PTPAE
1306{
1307 /** PTE Array. */
1308 X86PTEPAE a[X86_PG_PAE_ENTRIES];
1309} X86PTPAE;
1310/** Pointer to a page table. */
1311typedef X86PTPAE *PX86PTPAE;
1312/** Pointer to a const page table. */
1313typedef const X86PTPAE *PCX86PTPAE;
1314
1315/** The page shift to get the PA PTE index. */
1316#define X86_PT_PAE_SHIFT 12
1317/** The PAE PT index mask (apply to a shifted page address). */
1318#define X86_PT_PAE_MASK 0x1ff
1319
1320
1321/** @name 4KB Page Directory Entry
1322 * @{
1323 */
1324/** Bit 0 - P - Present bit. */
1325#define X86_PDE_P RT_BIT(0)
1326/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1327#define X86_PDE_RW RT_BIT(1)
1328/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1329#define X86_PDE_US RT_BIT(2)
1330/** Bit 3 - PWT - Page level write thru bit. */
1331#define X86_PDE_PWT RT_BIT(3)
1332/** Bit 4 - PCD - Page level cache disable bit. */
1333#define X86_PDE_PCD RT_BIT(4)
1334/** Bit 5 - A - Access bit. */
1335#define X86_PDE_A RT_BIT(5)
1336/** Bit 7 - PS - Page size attribute.
1337 * Clear mean 4KB pages, set means large pages (2/4MB). */
1338#define X86_PDE_PS RT_BIT(7)
1339/** Bits 9-11 - - Available for use to system software. */
1340#define X86_PDE_AVL_MASK (RT_BIT(9) | RT_BIT(10) | RT_BIT(11))
1341/** Bits 12-31 - - Physical Page number of the next level. */
1342#define X86_PDE_PG_MASK ( 0xfffff000 )
1343
1344/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1345#define X86_PDE_PAE_PG_MASK UINT64_C(0x000ffffffffff000)
1346/** Bits 63 - NX - PAE/LM - No execution flag. */
1347#define X86_PDE_PAE_NX RT_BIT_64(63)
1348/** Bits 62-52, 7 - - PAE - MBZ bits when NX is active. */
1349#define X86_PDE_PAE_MBZ_MASK_NX UINT64_C(0x7ff0000000000080)
1350/** Bits 63-52, 7 - - PAE - MBZ bits when no NX. */
1351#define X86_PDE_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff0000000000080)
1352/** Bit 7 - - LM - MBZ bits when NX is active. */
1353#define X86_PDE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000080)
1354/** Bits 63, 7 - - LM - MBZ bits when no NX. */
1355#define X86_PDE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000080)
1356
1357/**
1358 * Page directory entry.
1359 */
1360typedef struct X86PDEBITS
1361{
1362 /** Flags whether(=1) or not the page is present. */
1363 unsigned u1Present : 1;
1364 /** Read(=0) / Write(=1) flag. */
1365 unsigned u1Write : 1;
1366 /** User(=1) / Supervisor (=0) flag. */
1367 unsigned u1User : 1;
1368 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1369 unsigned u1WriteThru : 1;
1370 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1371 unsigned u1CacheDisable : 1;
1372 /** Accessed flag.
1373 * Indicates that the page has been read or written to. */
1374 unsigned u1Accessed : 1;
1375 /** Reserved / Ignored (dirty bit). */
1376 unsigned u1Reserved0 : 1;
1377 /** Size bit if PSE is enabled - in any event it's 0. */
1378 unsigned u1Size : 1;
1379 /** Reserved / Ignored (global bit). */
1380 unsigned u1Reserved1 : 1;
1381 /** Available for use to system software. */
1382 unsigned u3Available : 3;
1383 /** Physical Page number of the next level. */
1384 unsigned u20PageNo : 20;
1385} X86PDEBITS;
1386/** Pointer to a page directory entry. */
1387typedef X86PDEBITS *PX86PDEBITS;
1388/** Pointer to a const page directory entry. */
1389typedef const X86PDEBITS *PCX86PDEBITS;
1390
1391
1392/**
1393 * PAE page directory entry.
1394 */
1395typedef struct X86PDEPAEBITS
1396{
1397 /** Flags whether(=1) or not the page is present. */
1398 uint32_t u1Present : 1;
1399 /** Read(=0) / Write(=1) flag. */
1400 uint32_t u1Write : 1;
1401 /** User(=1) / Supervisor (=0) flag. */
1402 uint32_t u1User : 1;
1403 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1404 uint32_t u1WriteThru : 1;
1405 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1406 uint32_t u1CacheDisable : 1;
1407 /** Accessed flag.
1408 * Indicates that the page has been read or written to. */
1409 uint32_t u1Accessed : 1;
1410 /** Reserved / Ignored (dirty bit). */
1411 uint32_t u1Reserved0 : 1;
1412 /** Size bit if PSE is enabled - in any event it's 0. */
1413 uint32_t u1Size : 1;
1414 /** Reserved / Ignored (global bit). / */
1415 uint32_t u1Reserved1 : 1;
1416 /** Available for use to system software. */
1417 uint32_t u3Available : 3;
1418 /** Physical Page number of the next level - Low Part. Don't use! */
1419 uint32_t u20PageNoLow : 20;
1420 /** Physical Page number of the next level - High Part. Don't use! */
1421 uint32_t u20PageNoHigh : 20;
1422 /** MBZ bits */
1423 uint32_t u11Reserved : 11;
1424 /** No Execute flag. */
1425 uint32_t u1NoExecute : 1;
1426} X86PDEPAEBITS;
1427/** Pointer to a page directory entry. */
1428typedef X86PDEPAEBITS *PX86PDEPAEBITS;
1429/** Pointer to a const page directory entry. */
1430typedef const X86PDEPAEBITS *PCX86PDEPAEBITS;
1431
1432/** @} */
1433
1434
1435/** @name 2/4MB Page Directory Entry
1436 * @{
1437 */
1438/** Bit 0 - P - Present bit. */
1439#define X86_PDE4M_P RT_BIT(0)
1440/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1441#define X86_PDE4M_RW RT_BIT(1)
1442/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1443#define X86_PDE4M_US RT_BIT(2)
1444/** Bit 3 - PWT - Page level write thru bit. */
1445#define X86_PDE4M_PWT RT_BIT(3)
1446/** Bit 4 - PCD - Page level cache disable bit. */
1447#define X86_PDE4M_PCD RT_BIT(4)
1448/** Bit 5 - A - Access bit. */
1449#define X86_PDE4M_A RT_BIT(5)
1450/** Bit 6 - D - Dirty bit. */
1451#define X86_PDE4M_D RT_BIT(6)
1452/** Bit 7 - PS - Page size attribute. Clear mean 4KB pages, set means large pages (2/4MB). */
1453#define X86_PDE4M_PS RT_BIT(7)
1454/** Bit 8 - G - Global flag. */
1455#define X86_PDE4M_G RT_BIT(8)
1456/** Bits 9-11 - AVL - Available for use to system software. */
1457#define X86_PDE4M_AVL (RT_BIT(9) | RT_BIT(10) | RT_BIT(11))
1458/** Bit 12 - PAT - Page Attribute Table index bit. Reserved and 0 if not supported. */
1459#define X86_PDE4M_PAT RT_BIT(12)
1460/** Shift to get from X86_PTE_PAT to X86_PDE4M_PAT. */
1461#define X86_PDE4M_PAT_SHIFT (12 - 7)
1462/** Bits 22-31 - - Physical Page number. */
1463#define X86_PDE4M_PG_MASK ( 0xffc00000 )
1464/** Bits 20-13 - - Physical Page number high part (32-39 bits). AMD64 hack. */
1465#define X86_PDE4M_PG_HIGH_MASK ( 0x001fe000 )
1466/** The number of bits to the high part of the page number. */
1467#define X86_PDE4M_PG_HIGH_SHIFT 19
1468/** Bit 21 - - MBZ bits for AMD CPUs, no PSE36. */
1469#define X86_PDE4M_MBZ_MASK RT_BIT_32(21)
1470
1471/** Bits 21-51 - - PAE/LM - Physical Page number.
1472 * (Bits 40-51 (long mode) & bits 36-51 (pae legacy) are reserved according to the Intel docs; AMD allows for more.) */
1473#define X86_PDE2M_PAE_PG_MASK UINT64_C(0x000fffffffe00000)
1474/** Bits 63 - NX - PAE/LM - No execution flag. */
1475#define X86_PDE2M_PAE_NX RT_BIT_64(63)
1476/** Bits 62-52, 20-13 - - PAE - MBZ bits when NX is active. */
1477#define X86_PDE2M_PAE_MBZ_MASK_NX UINT64_C(0x7ff00000001fe000)
1478/** Bits 63-52, 20-13 - - PAE - MBZ bits when no NX. */
1479#define X86_PDE2M_PAE_MBZ_MASK_NO_NX UINT64_C(0xfff00000001fe000)
1480/** Bits 20-13 - - LM - MBZ bits when NX is active. */
1481#define X86_PDE2M_LM_MBZ_MASK_NX UINT64_C(0x00000000001fe000)
1482/** Bits 63, 20-13 - - LM - MBZ bits when no NX. */
1483#define X86_PDE2M_LM_MBZ_MASK_NO_NX UINT64_C(0x80000000001fe000)
1484
1485/**
1486 * 4MB page directory entry.
1487 */
1488typedef struct X86PDE4MBITS
1489{
1490 /** Flags whether(=1) or not the page is present. */
1491 unsigned u1Present : 1;
1492 /** Read(=0) / Write(=1) flag. */
1493 unsigned u1Write : 1;
1494 /** User(=1) / Supervisor (=0) flag. */
1495 unsigned u1User : 1;
1496 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1497 unsigned u1WriteThru : 1;
1498 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1499 unsigned u1CacheDisable : 1;
1500 /** Accessed flag.
1501 * Indicates that the page have been read or written to. */
1502 unsigned u1Accessed : 1;
1503 /** Dirty flag.
1504 * Indicates that the page has been written to. */
1505 unsigned u1Dirty : 1;
1506 /** Page size flag - always 1 for 4MB entries. */
1507 unsigned u1Size : 1;
1508 /** Global flag. */
1509 unsigned u1Global : 1;
1510 /** Available for use to system software. */
1511 unsigned u3Available : 3;
1512 /** Reserved / If PAT enabled, bit 2 of the index. */
1513 unsigned u1PAT : 1;
1514 /** Bits 32-39 of the page number on AMD64.
1515 * This AMD64 hack allows accessing 40bits of physical memory without PAE. */
1516 unsigned u8PageNoHigh : 8;
1517 /** Reserved. */
1518 unsigned u1Reserved : 1;
1519 /** Physical Page number of the page. */
1520 unsigned u10PageNo : 10;
1521} X86PDE4MBITS;
1522/** Pointer to a page table entry. */
1523typedef X86PDE4MBITS *PX86PDE4MBITS;
1524/** Pointer to a const page table entry. */
1525typedef const X86PDE4MBITS *PCX86PDE4MBITS;
1526
1527
1528/**
1529 * 2MB PAE page directory entry.
1530 */
1531typedef struct X86PDE2MPAEBITS
1532{
1533 /** Flags whether(=1) or not the page is present. */
1534 uint32_t u1Present : 1;
1535 /** Read(=0) / Write(=1) flag. */
1536 uint32_t u1Write : 1;
1537 /** User(=1) / Supervisor(=0) flag. */
1538 uint32_t u1User : 1;
1539 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1540 uint32_t u1WriteThru : 1;
1541 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1542 uint32_t u1CacheDisable : 1;
1543 /** Accessed flag.
1544 * Indicates that the page have been read or written to. */
1545 uint32_t u1Accessed : 1;
1546 /** Dirty flag.
1547 * Indicates that the page has been written to. */
1548 uint32_t u1Dirty : 1;
1549 /** Page size flag - always 1 for 2MB entries. */
1550 uint32_t u1Size : 1;
1551 /** Global flag. */
1552 uint32_t u1Global : 1;
1553 /** Available for use to system software. */
1554 uint32_t u3Available : 3;
1555 /** Reserved / If PAT enabled, bit 2 of the index. */
1556 uint32_t u1PAT : 1;
1557 /** Reserved. */
1558 uint32_t u9Reserved : 9;
1559 /** Physical Page number of the next level - Low part. Don't use! */
1560 uint32_t u10PageNoLow : 10;
1561 /** Physical Page number of the next level - High part. Don't use! */
1562 uint32_t u20PageNoHigh : 20;
1563 /** MBZ bits */
1564 uint32_t u11Reserved : 11;
1565 /** No Execute flag. */
1566 uint32_t u1NoExecute : 1;
1567} X86PDE2MPAEBITS;
1568/** Pointer to a 2MB PAE page table entry. */
1569typedef X86PDE2MPAEBITS *PX86PDE2MPAEBITS;
1570/** Pointer to a 2MB PAE page table entry. */
1571typedef const X86PDE2MPAEBITS *PCX86PDE2MPAEBITS;
1572
1573/** @} */
1574
1575/**
1576 * Page directory entry.
1577 */
1578typedef union X86PDE
1579{
1580 /** Unsigned integer view. */
1581 X86PGUINT u;
1582 /** Normal view. */
1583 X86PDEBITS n;
1584 /** 4MB view (big). */
1585 X86PDE4MBITS b;
1586 /** 8 bit unsigned integer view. */
1587 uint8_t au8[4];
1588 /** 16 bit unsigned integer view. */
1589 uint16_t au16[2];
1590 /** 32 bit unsigned integer view. */
1591 uint32_t au32[1];
1592} X86PDE;
1593/** Pointer to a page directory entry. */
1594typedef X86PDE *PX86PDE;
1595/** Pointer to a const page directory entry. */
1596typedef const X86PDE *PCX86PDE;
1597
1598/**
1599 * PAE page directory entry.
1600 */
1601typedef union X86PDEPAE
1602{
1603 /** Unsigned integer view. */
1604 X86PGPAEUINT u;
1605 /** Normal view. */
1606 X86PDEPAEBITS n;
1607 /** 2MB page view (big). */
1608 X86PDE2MPAEBITS b;
1609 /** 8 bit unsigned integer view. */
1610 uint8_t au8[8];
1611 /** 16 bit unsigned integer view. */
1612 uint16_t au16[4];
1613 /** 32 bit unsigned integer view. */
1614 uint32_t au32[2];
1615} X86PDEPAE;
1616/** Pointer to a page directory entry. */
1617typedef X86PDEPAE *PX86PDEPAE;
1618/** Pointer to a const page directory entry. */
1619typedef const X86PDEPAE *PCX86PDEPAE;
1620
1621/**
1622 * Page directory.
1623 */
1624typedef struct X86PD
1625{
1626 /** PDE Array. */
1627 X86PDE a[X86_PG_ENTRIES];
1628} X86PD;
1629/** Pointer to a page directory. */
1630typedef X86PD *PX86PD;
1631/** Pointer to a const page directory. */
1632typedef const X86PD *PCX86PD;
1633
1634/** The page shift to get the PD index. */
1635#define X86_PD_SHIFT 22
1636/** The PD index mask (apply to a shifted page address). */
1637#define X86_PD_MASK 0x3ff
1638
1639
1640/**
1641 * PAE page directory.
1642 */
1643typedef struct X86PDPAE
1644{
1645 /** PDE Array. */
1646 X86PDEPAE a[X86_PG_PAE_ENTRIES];
1647} X86PDPAE;
1648/** Pointer to a PAE page directory. */
1649typedef X86PDPAE *PX86PDPAE;
1650/** Pointer to a const PAE page directory. */
1651typedef const X86PDPAE *PCX86PDPAE;
1652
1653/** The page shift to get the PAE PD index. */
1654#define X86_PD_PAE_SHIFT 21
1655/** The PAE PD index mask (apply to a shifted page address). */
1656#define X86_PD_PAE_MASK 0x1ff
1657
1658
1659/** @name Page Directory Pointer Table Entry (PAE)
1660 * @{
1661 */
1662/** Bit 0 - P - Present bit. */
1663#define X86_PDPE_P RT_BIT(0)
1664/** Bit 1 - R/W - Read (clear) / Write (set) bit. Long Mode only. */
1665#define X86_PDPE_RW RT_BIT(1)
1666/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. Long Mode only. */
1667#define X86_PDPE_US RT_BIT(2)
1668/** Bit 3 - PWT - Page level write thru bit. */
1669#define X86_PDPE_PWT RT_BIT(3)
1670/** Bit 4 - PCD - Page level cache disable bit. */
1671#define X86_PDPE_PCD RT_BIT(4)
1672/** Bit 5 - A - Access bit. Long Mode only. */
1673#define X86_PDPE_A RT_BIT(5)
1674/** Bit 7 - PS - Page size (1GB). Long Mode only. */
1675#define X86_PDPE_LM_PS RT_BIT(7)
1676/** Bits 9-11 - - Available for use to system software. */
1677#define X86_PDPE_AVL_MASK (RT_BIT(9) | RT_BIT(10) | RT_BIT(11))
1678/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1679#define X86_PDPE_PG_MASK UINT64_C(0x000ffffffffff000)
1680/** Bits 63-52, 8-5, 2-1 - - PAE - MBZ bits (NX is long mode only). */
1681#define X86_PDPE_PAE_MBZ_MASK UINT64_C(0xfff00000000001e6)
1682/** Bits 63 - NX - LM - No execution flag. Long Mode only. */
1683#define X86_PDPE_LM_NX RT_BIT_64(63)
1684/** Bits 8, 7 - - LM - MBZ bits when NX is active. */
1685#define X86_PDPE_LM_MBZ_MASK_NX UINT64_C(0x0000000000000180)
1686/** Bits 63, 8, 7 - - LM - MBZ bits when no NX. */
1687#define X86_PDPE_LM_MBZ_MASK_NO_NX UINT64_C(0x8000000000000180)
1688/** Bits 29-13 - - LM - MBZ bits for 1GB page entry when NX is active. */
1689#define X86_PDPE1G_LM_MBZ_MASK_NX UINT64_C(0x000000003fffe000)
1690/** Bits 63, 29-13 - - LM - MBZ bits for 1GB page entry when no NX. */
1691#define X86_PDPE1G_LM_MBZ_MASK_NO_NX UINT64_C(0x800000003fffe000)
1692
1693
1694/**
1695 * Page directory pointer table entry.
1696 */
1697typedef struct X86PDPEBITS
1698{
1699 /** Flags whether(=1) or not the page is present. */
1700 uint32_t u1Present : 1;
1701 /** Chunk of reserved bits. */
1702 uint32_t u2Reserved : 2;
1703 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1704 uint32_t u1WriteThru : 1;
1705 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1706 uint32_t u1CacheDisable : 1;
1707 /** Chunk of reserved bits. */
1708 uint32_t u4Reserved : 4;
1709 /** Available for use to system software. */
1710 uint32_t u3Available : 3;
1711 /** Physical Page number of the next level - Low Part. Don't use! */
1712 uint32_t u20PageNoLow : 20;
1713 /** Physical Page number of the next level - High Part. Don't use! */
1714 uint32_t u20PageNoHigh : 20;
1715 /** MBZ bits */
1716 uint32_t u12Reserved : 12;
1717} X86PDPEBITS;
1718/** Pointer to a page directory pointer table entry. */
1719typedef X86PDPEBITS *PX86PTPEBITS;
1720/** Pointer to a const page directory pointer table entry. */
1721typedef const X86PDPEBITS *PCX86PTPEBITS;
1722
1723/**
1724 * Page directory pointer table entry. AMD64 version
1725 */
1726typedef struct X86PDPEAMD64BITS
1727{
1728 /** Flags whether(=1) or not the page is present. */
1729 uint32_t u1Present : 1;
1730 /** Read(=0) / Write(=1) flag. */
1731 uint32_t u1Write : 1;
1732 /** User(=1) / Supervisor (=0) flag. */
1733 uint32_t u1User : 1;
1734 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1735 uint32_t u1WriteThru : 1;
1736 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1737 uint32_t u1CacheDisable : 1;
1738 /** Accessed flag.
1739 * Indicates that the page have been read or written to. */
1740 uint32_t u1Accessed : 1;
1741 /** Chunk of reserved bits. */
1742 uint32_t u3Reserved : 3;
1743 /** Available for use to system software. */
1744 uint32_t u3Available : 3;
1745 /** Physical Page number of the next level - Low Part. Don't use! */
1746 uint32_t u20PageNoLow : 20;
1747 /** Physical Page number of the next level - High Part. Don't use! */
1748 uint32_t u20PageNoHigh : 20;
1749 /** MBZ bits */
1750 uint32_t u11Reserved : 11;
1751 /** No Execute flag. */
1752 uint32_t u1NoExecute : 1;
1753} X86PDPEAMD64BITS;
1754/** Pointer to a page directory pointer table entry. */
1755typedef X86PDPEAMD64BITS *PX86PDPEAMD64BITS;
1756/** Pointer to a const page directory pointer table entry. */
1757typedef const X86PDPEAMD64BITS *PCX86PDPEAMD64BITS;
1758
1759/**
1760 * Page directory pointer table entry.
1761 */
1762typedef union X86PDPE
1763{
1764 /** Unsigned integer view. */
1765 X86PGPAEUINT u;
1766 /** Normal view. */
1767 X86PDPEBITS n;
1768 /** AMD64 view. */
1769 X86PDPEAMD64BITS lm;
1770 /** 8 bit unsigned integer view. */
1771 uint8_t au8[8];
1772 /** 16 bit unsigned integer view. */
1773 uint16_t au16[4];
1774 /** 32 bit unsigned integer view. */
1775 uint32_t au32[2];
1776} X86PDPE;
1777/** Pointer to a page directory pointer table entry. */
1778typedef X86PDPE *PX86PDPE;
1779/** Pointer to a const page directory pointer table entry. */
1780typedef const X86PDPE *PCX86PDPE;
1781
1782
1783/**
1784 * Page directory pointer table.
1785 */
1786typedef struct X86PDPT
1787{
1788 /** PDE Array. */
1789 X86PDPE a[X86_PG_AMD64_PDPE_ENTRIES];
1790} X86PDPT;
1791/** Pointer to a page directory pointer table. */
1792typedef X86PDPT *PX86PDPT;
1793/** Pointer to a const page directory pointer table. */
1794typedef const X86PDPT *PCX86PDPT;
1795
1796/** The page shift to get the PDPT index. */
1797#define X86_PDPT_SHIFT 30
1798/** The PDPT index mask (apply to a shifted page address). (32 bits PAE) */
1799#define X86_PDPT_MASK_PAE 0x3
1800/** The PDPT index mask (apply to a shifted page address). (64 bits PAE)*/
1801#define X86_PDPT_MASK_AMD64 0x1ff
1802
1803/** @} */
1804
1805
1806/** @name Page Map Level-4 Entry (Long Mode PAE)
1807 * @{
1808 */
1809/** Bit 0 - P - Present bit. */
1810#define X86_PML4E_P RT_BIT(0)
1811/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1812#define X86_PML4E_RW RT_BIT(1)
1813/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1814#define X86_PML4E_US RT_BIT(2)
1815/** Bit 3 - PWT - Page level write thru bit. */
1816#define X86_PML4E_PWT RT_BIT(3)
1817/** Bit 4 - PCD - Page level cache disable bit. */
1818#define X86_PML4E_PCD RT_BIT(4)
1819/** Bit 5 - A - Access bit. */
1820#define X86_PML4E_A RT_BIT(5)
1821/** Bits 9-11 - - Available for use to system software. */
1822#define X86_PML4E_AVL_MASK (RT_BIT(9) | RT_BIT(10) | RT_BIT(11))
1823/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1824#define X86_PML4E_PG_MASK UINT64_C(0x000ffffffffff000)
1825/** Bits 8, 7 - - MBZ bits when NX is active. */
1826#define X86_PML4E_MBZ_MASK_NX UINT64_C(0x0000000000000080)
1827/** Bits 63, 7 - - MBZ bits when no NX. */
1828#define X86_PML4E_MBZ_MASK_NO_NX UINT64_C(0x8000000000000080)
1829/** Bits 63 - NX - PAE - No execution flag. */
1830#define X86_PML4E_NX RT_BIT_64(63)
1831
1832/**
1833 * Page Map Level-4 Entry
1834 */
1835typedef struct X86PML4EBITS
1836{
1837 /** Flags whether(=1) or not the page is present. */
1838 uint32_t u1Present : 1;
1839 /** Read(=0) / Write(=1) flag. */
1840 uint32_t u1Write : 1;
1841 /** User(=1) / Supervisor (=0) flag. */
1842 uint32_t u1User : 1;
1843 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1844 uint32_t u1WriteThru : 1;
1845 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1846 uint32_t u1CacheDisable : 1;
1847 /** Accessed flag.
1848 * Indicates that the page have been read or written to. */
1849 uint32_t u1Accessed : 1;
1850 /** Chunk of reserved bits. */
1851 uint32_t u3Reserved : 3;
1852 /** Available for use to system software. */
1853 uint32_t u3Available : 3;
1854 /** Physical Page number of the next level - Low Part. Don't use! */
1855 uint32_t u20PageNoLow : 20;
1856 /** Physical Page number of the next level - High Part. Don't use! */
1857 uint32_t u20PageNoHigh : 20;
1858 /** MBZ bits */
1859 uint32_t u11Reserved : 11;
1860 /** No Execute flag. */
1861 uint32_t u1NoExecute : 1;
1862} X86PML4EBITS;
1863/** Pointer to a page map level-4 entry. */
1864typedef X86PML4EBITS *PX86PML4EBITS;
1865/** Pointer to a const page map level-4 entry. */
1866typedef const X86PML4EBITS *PCX86PML4EBITS;
1867
1868/**
1869 * Page Map Level-4 Entry.
1870 */
1871typedef union X86PML4E
1872{
1873 /** Unsigned integer view. */
1874 X86PGPAEUINT u;
1875 /** Normal view. */
1876 X86PML4EBITS n;
1877 /** 8 bit unsigned integer view. */
1878 uint8_t au8[8];
1879 /** 16 bit unsigned integer view. */
1880 uint16_t au16[4];
1881 /** 32 bit unsigned integer view. */
1882 uint32_t au32[2];
1883} X86PML4E;
1884/** Pointer to a page map level-4 entry. */
1885typedef X86PML4E *PX86PML4E;
1886/** Pointer to a const page map level-4 entry. */
1887typedef const X86PML4E *PCX86PML4E;
1888
1889
1890/**
1891 * Page Map Level-4.
1892 */
1893typedef struct X86PML4
1894{
1895 /** PDE Array. */
1896 X86PML4E a[X86_PG_PAE_ENTRIES];
1897} X86PML4;
1898/** Pointer to a page map level-4. */
1899typedef X86PML4 *PX86PML4;
1900/** Pointer to a const page map level-4. */
1901typedef const X86PML4 *PCX86PML4;
1902
1903/** The page shift to get the PML4 index. */
1904#define X86_PML4_SHIFT 39
1905/** The PML4 index mask (apply to a shifted page address). */
1906#define X86_PML4_MASK 0x1ff
1907
1908/** @} */
1909
1910/** @} */
1911
1912
1913/**
1914 * 80-bit MMX/FPU register type.
1915 */
1916typedef struct X86FPUMMX
1917{
1918 uint8_t reg[10];
1919} X86FPUMMX;
1920/** Pointer to a 80-bit MMX/FPU register type. */
1921typedef X86FPUMMX *PX86FPUMMX;
1922/** Pointer to a const 80-bit MMX/FPU register type. */
1923typedef const X86FPUMMX *PCX86FPUMMX;
1924
1925/**
1926 * 32-bit FPU state (aka FSAVE/FRSTOR Memory Region).
1927 * @todo verify this...
1928 */
1929#pragma pack(1)
1930typedef struct X86FPUSTATE
1931{
1932 /** 0x00 - Control word. */
1933 uint16_t FCW;
1934 /** 0x02 - Alignment word */
1935 uint16_t Dummy1;
1936 /** 0x04 - Status word. */
1937 uint16_t FSW;
1938 /** 0x06 - Alignment word */
1939 uint16_t Dummy2;
1940 /** 0x08 - Tag word */
1941 uint16_t FTW;
1942 /** 0x0a - Alignment word */
1943 uint16_t Dummy3;
1944
1945 /** 0x0c - Instruction pointer. */
1946 uint32_t FPUIP;
1947 /** 0x10 - Code selector. */
1948 uint16_t CS;
1949 /** 0x12 - Opcode. */
1950 uint16_t FOP;
1951 /** 0x14 - FOO. */
1952 uint32_t FPUOO;
1953 /** 0x18 - FOS. */
1954 uint32_t FPUOS;
1955 /** 0x1c */
1956 union
1957 {
1958 /** MMX view. */
1959 uint64_t mmx;
1960 /** FPU view - todo. */
1961 X86FPUMMX fpu;
1962 /** Extended precision floating point view. */
1963 RTFLOAT80U2 r80;
1964 /** 8-bit view. */
1965 uint8_t au8[16];
1966 /** 16-bit view. */
1967 uint16_t au16[8];
1968 /** 32-bit view. */
1969 uint32_t au32[4];
1970 /** 64-bit view. */
1971 uint64_t au64[2];
1972 /** 128-bit view. (yeah, very helpful) */
1973 uint128_t au128[1];
1974 } regs[8];
1975} X86FPUSTATE;
1976#pragma pack()
1977/** Pointer to a FPU state. */
1978typedef X86FPUSTATE *PX86FPUSTATE;
1979/** Pointer to a const FPU state. */
1980typedef const X86FPUSTATE *PCX86FPUSTATE;
1981
1982/**
1983 * FPU Extended state (aka FXSAVE/FXRSTORE Memory Region).
1984 */
1985#pragma pack(1)
1986typedef struct X86FXSTATE
1987{
1988 /** 0x00 - Control word. */
1989 uint16_t FCW;
1990 /** 0x02 - Status word. */
1991 uint16_t FSW;
1992 /** 0x04 - Tag word. (The upper byte is always zero.) */
1993 uint16_t FTW;
1994 /** 0x06 - Opcode. */
1995 uint16_t FOP;
1996 /** 0x08 - Instruction pointer. */
1997 uint32_t FPUIP;
1998 /** 0x0c - Code selector. */
1999 uint16_t CS;
2000 uint16_t Rsrvd1;
2001 /** 0x10 - Data pointer. */
2002 uint32_t FPUDP;
2003 /** 0x14 - Data segment */
2004 uint16_t DS;
2005 /** 0x16 */
2006 uint16_t Rsrvd2;
2007 /** 0x18 */
2008 uint32_t MXCSR;
2009 /** 0x1c */
2010 uint32_t MXCSR_MASK;
2011 /** 0x20 */
2012 union
2013 {
2014 /** MMX view. */
2015 uint64_t mmx;
2016 /** FPU view - todo. */
2017 X86FPUMMX fpu;
2018 /** Extended precision floating point view. */
2019 RTFLOAT80U2 r80;
2020 /** 8-bit view. */
2021 uint8_t au8[16];
2022 /** 16-bit view. */
2023 uint16_t au16[8];
2024 /** 32-bit view. */
2025 uint32_t au32[4];
2026 /** 64-bit view. */
2027 uint64_t au64[2];
2028 /** 128-bit view. (yeah, very helpful) */
2029 uint128_t au128[1];
2030 } aRegs[8];
2031 /* - offset 160 - */
2032 union
2033 {
2034 /** XMM Register view *. */
2035 uint128_t xmm;
2036 /** 8-bit view. */
2037 uint8_t au8[16];
2038 /** 16-bit view. */
2039 uint16_t au16[8];
2040 /** 32-bit view. */
2041 uint32_t au32[4];
2042 /** 64-bit view. */
2043 uint64_t au64[2];
2044 /** 128-bit view. (yeah, very helpful) */
2045 uint128_t au128[1];
2046 } aXMM[16]; /* 8 registers in 32 bits mode; 16 in long mode */
2047 /* - offset 416 - */
2048 uint32_t au32RsrvdRest[(512 - 416) / sizeof(uint32_t)];
2049} X86FXSTATE;
2050#pragma pack()
2051/** Pointer to a FPU Extended state. */
2052typedef X86FXSTATE *PX86FXSTATE;
2053/** Pointer to a const FPU Extended state. */
2054typedef const X86FXSTATE *PCX86FXSTATE;
2055
2056/** @name FPU status word flags.
2057 * @{ */
2058/** Exception Flag: Invalid operation. */
2059#define X86_FSW_IE RT_BIT(0)
2060/** Exception Flag: Denormalized operand. */
2061#define X86_FSW_DE RT_BIT(1)
2062/** Exception Flag: Zero divide. */
2063#define X86_FSW_ZE RT_BIT(2)
2064/** Exception Flag: Overflow. */
2065#define X86_FSW_OE RT_BIT(3)
2066/** Exception Flag: Underflow. */
2067#define X86_FSW_UE RT_BIT(4)
2068/** Exception Flag: Precision. */
2069#define X86_FSW_PE RT_BIT(5)
2070/** Stack fault. */
2071#define X86_FSW_SF RT_BIT(6)
2072/** Error summary status. */
2073#define X86_FSW_ES RT_BIT(7)
2074/** Condition code 0. */
2075#define X86_FSW_C0 RT_BIT(8)
2076/** Condition code 1. */
2077#define X86_FSW_C1 RT_BIT(9)
2078/** Condition code 2. */
2079#define X86_FSW_C2 RT_BIT(10)
2080/** Top of the stack mask. */
2081#define X86_FSW_TOP_MASK UINT16_C(0x3800)
2082/** TOP shift value. */
2083#define X86_FSW_TOP_SHIFT 11
2084/** Mask for getting TOP value after shifting it right. */
2085#define X86_FSW_TOP_SMASK UINT16_C(0x0007)
2086/** Get the TOP value. */
2087#define X86_FSW_TOP_GET(a_uFsw) (((a_uFsw) >> X86_FSW_TOP_SHIFT) & X86_FSW_TOP_SMASK)
2088/** Condition code 3. */
2089#define X86_FSW_C3 RT_BIT(14)
2090/** FPU busy. */
2091#define X86_FSW_B RT_BIT(15)
2092/** @} */
2093
2094
2095/** @name Selector Descriptor
2096 * @{
2097 */
2098
2099/**
2100 * Descriptor attributes.
2101 */
2102typedef struct X86DESCATTRBITS
2103{
2104 /** 00 - Segment Type. */
2105 unsigned u4Type : 4;
2106 /** 04 - Descriptor Type. System(=0) or code/data selector */
2107 unsigned u1DescType : 1;
2108 /** 05 - Descriptor Privelege level. */
2109 unsigned u2Dpl : 2;
2110 /** 07 - Flags selector present(=1) or not. */
2111 unsigned u1Present : 1;
2112 /** 08 - Segment limit 16-19. */
2113 unsigned u4LimitHigh : 4;
2114 /** 0c - Available for system software. */
2115 unsigned u1Available : 1;
2116 /** 0d - 32 bits mode: Reserved - 0, long mode: Long Attribute Bit. */
2117 unsigned u1Long : 1;
2118 /** 0e - This flags meaning depends on the segment type. Try make sense out
2119 * of the intel manual yourself. */
2120 unsigned u1DefBig : 1;
2121 /** 0f - Granularity of the limit. If set 4KB granularity is used, if
2122 * clear byte. */
2123 unsigned u1Granularity : 1;
2124} X86DESCATTRBITS;
2125
2126
2127#pragma pack(1)
2128typedef union X86DESCATTR
2129{
2130 /** Unsigned integer view. */
2131 uint32_t u;
2132 /** Normal view. */
2133 X86DESCATTRBITS n;
2134} X86DESCATTR;
2135#pragma pack()
2136/** Pointer to descriptor attributes. */
2137typedef X86DESCATTR *PX86DESCATTR;
2138/** Pointer to const descriptor attributes. */
2139typedef const X86DESCATTR *PCX86DESCATTR;
2140
2141
2142/**
2143 * Generic descriptor table entry
2144 */
2145#pragma pack(1)
2146typedef struct X86DESCGENERIC
2147{
2148 /** Limit - Low word. */
2149 unsigned u16LimitLow : 16;
2150 /** Base address - lowe word.
2151 * Don't try set this to 24 because MSC is doing stupid things then. */
2152 unsigned u16BaseLow : 16;
2153 /** Base address - first 8 bits of high word. */
2154 unsigned u8BaseHigh1 : 8;
2155 /** Segment Type. */
2156 unsigned u4Type : 4;
2157 /** Descriptor Type. System(=0) or code/data selector */
2158 unsigned u1DescType : 1;
2159 /** Descriptor Privelege level. */
2160 unsigned u2Dpl : 2;
2161 /** Flags selector present(=1) or not. */
2162 unsigned u1Present : 1;
2163 /** Segment limit 16-19. */
2164 unsigned u4LimitHigh : 4;
2165 /** Available for system software. */
2166 unsigned u1Available : 1;
2167 /** 32 bits mode: Reserved - 0, long mode: Long Attribute Bit. */
2168 unsigned u1Long : 1;
2169 /** This flags meaning depends on the segment type. Try make sense out
2170 * of the intel manual yourself. */
2171 unsigned u1DefBig : 1;
2172 /** Granularity of the limit. If set 4KB granularity is used, if
2173 * clear byte. */
2174 unsigned u1Granularity : 1;
2175 /** Base address - highest 8 bits. */
2176 unsigned u8BaseHigh2 : 8;
2177} X86DESCGENERIC;
2178#pragma pack()
2179/** Pointer to a generic descriptor entry. */
2180typedef X86DESCGENERIC *PX86DESCGENERIC;
2181/** Pointer to a const generic descriptor entry. */
2182typedef const X86DESCGENERIC *PCX86DESCGENERIC;
2183
2184/**
2185 * Call-, Interrupt-, Trap- or Task-gate descriptor (legacy).
2186 */
2187typedef struct X86DESCGATE
2188{
2189 /** 00 - Target code segment offset - Low word.
2190 * Ignored if task-gate. */
2191 unsigned u16OffsetLow : 16;
2192 /** 10 - Target code segment selector for call-, interrupt- and trap-gates,
2193 * TSS selector if task-gate. */
2194 unsigned u16Sel : 16;
2195 /** 20 - Number of parameters for a call-gate.
2196 * Ignored if interrupt-, trap- or task-gate. */
2197 unsigned u4ParmCount : 4;
2198 /** 24 - Reserved / ignored. */
2199 unsigned u4Reserved : 4;
2200 /** 28 - Segment Type. */
2201 unsigned u4Type : 4;
2202 /** 2c - Descriptor Type (0 = system). */
2203 unsigned u1DescType : 1;
2204 /** 2d - Descriptor Privelege level. */
2205 unsigned u2Dpl : 2;
2206 /** 2f - Flags selector present(=1) or not. */
2207 unsigned u1Present : 1;
2208 /** 30 - Target code segment offset - High word.
2209 * Ignored if task-gate. */
2210 unsigned u16OffsetHigh : 16;
2211} X86DESCGATE;
2212AssertCompileSize(X86DESCGATE, 8);
2213/** Pointer to a Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
2214typedef X86DESCGATE *PX86DESCGATE;
2215/** Pointer to a const Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
2216typedef const X86DESCGATE *PCX86DESCGATE;
2217
2218/**
2219 * Descriptor table entry.
2220 */
2221#pragma pack(1)
2222typedef union X86DESC
2223{
2224 /** Generic descriptor view. */
2225 X86DESCGENERIC Gen;
2226 /** Gate descriptor view. */
2227 X86DESCGATE Gate;
2228
2229 /** 8 bit unsigned integer view. */
2230 uint8_t au8[8];
2231 /** 16 bit unsigned integer view. */
2232 uint16_t au16[4];
2233 /** 32 bit unsigned integer view. */
2234 uint32_t au32[2];
2235 /** 64 bit unsigned integer view. */
2236 uint64_t au64[1];
2237 /** Unsigned integer view. */
2238 uint64_t u;
2239} X86DESC;
2240AssertCompileSize(X86DESC, 8);
2241#pragma pack()
2242/** Pointer to descriptor table entry. */
2243typedef X86DESC *PX86DESC;
2244/** Pointer to const descriptor table entry. */
2245typedef const X86DESC *PCX86DESC;
2246
2247/** @def X86DESC_BASE
2248 * Return the base address of a descriptor.
2249 */
2250#define X86DESC_BASE(desc) /*ASM-NOINC*/ \
2251 ( ((uint32_t)((desc).Gen.u8BaseHigh2) << 24) \
2252 | ( (desc).Gen.u8BaseHigh1 << 16) \
2253 | ( (desc).Gen.u16BaseLow ) )
2254
2255/** @def X86DESC_LIMIT
2256 * Return the limit of a descriptor.
2257 */
2258#define X86DESC_LIMIT(desc) /*ASM-NOINC*/ \
2259 ( ((uint32_t)((desc).Gen.u4LimitHigh) << 16) \
2260 | ( (desc).Gen.u16LimitLow ) )
2261
2262/** @def X86DESC_GET_HID_ATTR
2263 * Get the descriptor attributes for the hidden register.
2264 */
2265#define X86DESC_GET_HID_ATTR(desc) /*ASM-NOINC*/ \
2266 ( (desc.u >> (16+16+8)) & UINT32_C(0xf0ff) ) /** @todo do we have a define for 0xf0ff? */
2267
2268
2269/**
2270 * 64 bits generic descriptor table entry
2271 * Note: most of these bits have no meaning in long mode.
2272 */
2273#pragma pack(1)
2274typedef struct X86DESC64GENERIC
2275{
2276 /** Limit - Low word - *IGNORED*. */
2277 unsigned u16LimitLow : 16;
2278 /** Base address - lowe word. - *IGNORED*
2279 * Don't try set this to 24 because MSC is doing stupid things then. */
2280 unsigned u16BaseLow : 16;
2281 /** Base address - first 8 bits of high word. - *IGNORED* */
2282 unsigned u8BaseHigh1 : 8;
2283 /** Segment Type. */
2284 unsigned u4Type : 4;
2285 /** Descriptor Type. System(=0) or code/data selector */
2286 unsigned u1DescType : 1;
2287 /** Descriptor Privelege level. */
2288 unsigned u2Dpl : 2;
2289 /** Flags selector present(=1) or not. */
2290 unsigned u1Present : 1;
2291 /** Segment limit 16-19. - *IGNORED* */
2292 unsigned u4LimitHigh : 4;
2293 /** Available for system software. - *IGNORED* */
2294 unsigned u1Available : 1;
2295 /** Long mode flag. */
2296 unsigned u1Long : 1;
2297 /** This flags meaning depends on the segment type. Try make sense out
2298 * of the intel manual yourself. */
2299 unsigned u1DefBig : 1;
2300 /** Granularity of the limit. If set 4KB granularity is used, if
2301 * clear byte. - *IGNORED* */
2302 unsigned u1Granularity : 1;
2303 /** Base address - highest 8 bits. - *IGNORED* */
2304 unsigned u8BaseHigh2 : 8;
2305 /** Base address - bits 63-32. */
2306 unsigned u32BaseHigh3 : 32;
2307 unsigned u8Reserved : 8;
2308 unsigned u5Zeros : 5;
2309 unsigned u19Reserved : 19;
2310} X86DESC64GENERIC;
2311#pragma pack()
2312/** Pointer to a generic descriptor entry. */
2313typedef X86DESC64GENERIC *PX86DESC64GENERIC;
2314/** Pointer to a const generic descriptor entry. */
2315typedef const X86DESC64GENERIC *PCX86DESC64GENERIC;
2316
2317/**
2318 * System descriptor table entry (64 bits)
2319 *
2320 * @remarks This is, save a couple of comments, identical to X86DESC64GENERIC...
2321 */
2322#pragma pack(1)
2323typedef struct X86DESC64SYSTEM
2324{
2325 /** Limit - Low word. */
2326 unsigned u16LimitLow : 16;
2327 /** Base address - lowe word.
2328 * Don't try set this to 24 because MSC is doing stupid things then. */
2329 unsigned u16BaseLow : 16;
2330 /** Base address - first 8 bits of high word. */
2331 unsigned u8BaseHigh1 : 8;
2332 /** Segment Type. */
2333 unsigned u4Type : 4;
2334 /** Descriptor Type. System(=0) or code/data selector */
2335 unsigned u1DescType : 1;
2336 /** Descriptor Privelege level. */
2337 unsigned u2Dpl : 2;
2338 /** Flags selector present(=1) or not. */
2339 unsigned u1Present : 1;
2340 /** Segment limit 16-19. */
2341 unsigned u4LimitHigh : 4;
2342 /** Available for system software. */
2343 unsigned u1Available : 1;
2344 /** Reserved - 0. */
2345 unsigned u1Reserved : 1;
2346 /** This flags meaning depends on the segment type. Try make sense out
2347 * of the intel manual yourself. */
2348 unsigned u1DefBig : 1;
2349 /** Granularity of the limit. If set 4KB granularity is used, if
2350 * clear byte. */
2351 unsigned u1Granularity : 1;
2352 /** Base address - bits 31-24. */
2353 unsigned u8BaseHigh2 : 8;
2354 /** Base address - bits 63-32. */
2355 unsigned u32BaseHigh3 : 32;
2356 unsigned u8Reserved : 8;
2357 unsigned u5Zeros : 5;
2358 unsigned u19Reserved : 19;
2359} X86DESC64SYSTEM;
2360#pragma pack()
2361/** Pointer to a system descriptor entry. */
2362typedef X86DESC64SYSTEM *PX86DESC64SYSTEM;
2363/** Pointer to a const system descriptor entry. */
2364typedef const X86DESC64SYSTEM *PCX86DESC64SYSTEM;
2365
2366/**
2367 * Call-, Interrupt-, Trap- or Task-gate descriptor (64-bit).
2368 */
2369typedef struct X86DESC64GATE
2370{
2371 /** Target code segment offset - Low word. */
2372 unsigned u16OffsetLow : 16;
2373 /** Target code segment selector. */
2374 unsigned u16Sel : 16;
2375 /** Interrupt stack table for interrupt- and trap-gates.
2376 * Ignored by call-gates. */
2377 unsigned u3IST : 3;
2378 /** Reserved / ignored. */
2379 unsigned u5Reserved : 5;
2380 /** Segment Type. */
2381 unsigned u4Type : 4;
2382 /** Descriptor Type (0 = system). */
2383 unsigned u1DescType : 1;
2384 /** Descriptor Privelege level. */
2385 unsigned u2Dpl : 2;
2386 /** Flags selector present(=1) or not. */
2387 unsigned u1Present : 1;
2388 /** Target code segment offset - High word.
2389 * Ignored if task-gate. */
2390 unsigned u16OffsetHigh : 16;
2391 /** Target code segment offset - Top dword.
2392 * Ignored if task-gate. */
2393 unsigned u32OffsetTop : 32;
2394 /** Reserved / ignored / must be zero.
2395 * For call-gates bits 8 thru 12 must be zero, the other gates ignores this. */
2396 unsigned u32Reserved : 32;
2397} X86DESC64GATE;
2398AssertCompileSize(X86DESC64GATE, 16);
2399/** Pointer to a Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
2400typedef X86DESC64GATE *PX86DESC64GATE;
2401/** Pointer to a const Call-, Interrupt-, Trap- or Task-gate descriptor entry. */
2402typedef const X86DESC64GATE *PCX86DESC64GATE;
2403
2404
2405/**
2406 * Descriptor table entry.
2407 */
2408#pragma pack(1)
2409typedef union X86DESC64
2410{
2411 /** Generic descriptor view. */
2412 X86DESC64GENERIC Gen;
2413 /** System descriptor view. */
2414 X86DESC64SYSTEM System;
2415 /** Gate descriptor view. */
2416 X86DESC64GATE Gate;
2417
2418 /** 8 bit unsigned integer view. */
2419 uint8_t au8[16];
2420 /** 16 bit unsigned integer view. */
2421 uint16_t au16[8];
2422 /** 32 bit unsigned integer view. */
2423 uint32_t au32[4];
2424 /** 64 bit unsigned integer view. */
2425 uint64_t au64[2];
2426} X86DESC64;
2427AssertCompileSize(X86DESC64, 16);
2428#pragma pack()
2429/** Pointer to descriptor table entry. */
2430typedef X86DESC64 *PX86DESC64;
2431/** Pointer to const descriptor table entry. */
2432typedef const X86DESC64 *PCX86DESC64;
2433
2434/** @def X86DESC64_BASE
2435 * Return the base of a 64-bit descriptor.
2436 */
2437#define X86DESC64_BASE(desc) /*ASM-NOINC*/ \
2438 ( ((uint64_t)((desc).Gen.u32BaseHigh3) << 32) \
2439 | ((uint32_t)((desc).Gen.u8BaseHigh2) << 24) \
2440 | ( (desc).Gen.u8BaseHigh1 << 16) \
2441 | ( (desc).Gen.u16BaseLow ) )
2442
2443
2444
2445/** @name Host system descriptor table entry - Use with care!
2446 * @{ */
2447/** Host system descriptor table entry. */
2448#if HC_ARCH_BITS == 64
2449typedef X86DESC64 X86DESCHC;
2450#else
2451typedef X86DESC X86DESCHC;
2452#endif
2453/** Pointer to a host system descriptor table entry. */
2454#if HC_ARCH_BITS == 64
2455typedef PX86DESC64 PX86DESCHC;
2456#else
2457typedef PX86DESC PX86DESCHC;
2458#endif
2459/** Pointer to a const host system descriptor table entry. */
2460#if HC_ARCH_BITS == 64
2461typedef PCX86DESC64 PCX86DESCHC;
2462#else
2463typedef PCX86DESC PCX86DESCHC;
2464#endif
2465/** @} */
2466
2467
2468/** @name Selector Descriptor Types.
2469 * @{
2470 */
2471
2472/** @name Non-System Selector Types.
2473 * @{ */
2474/** Code(=set)/Data(=clear) bit. */
2475#define X86_SEL_TYPE_CODE 8
2476/** Memory(=set)/System(=clear) bit. */
2477#define X86_SEL_TYPE_MEMORY RT_BIT(4)
2478/** Accessed bit. */
2479#define X86_SEL_TYPE_ACCESSED 1
2480/** Expand down bit (for data selectors only). */
2481#define X86_SEL_TYPE_DOWN 4
2482/** Conforming bit (for code selectors only). */
2483#define X86_SEL_TYPE_CONF 4
2484/** Write bit (for data selectors only). */
2485#define X86_SEL_TYPE_WRITE 2
2486/** Read bit (for code selectors only). */
2487#define X86_SEL_TYPE_READ 2
2488
2489/** Read only selector type. */
2490#define X86_SEL_TYPE_RO 0
2491/** Accessed read only selector type. */
2492#define X86_SEL_TYPE_RO_ACC (0 | X86_SEL_TYPE_ACCESSED)
2493/** Read write selector type. */
2494#define X86_SEL_TYPE_RW 2
2495/** Accessed read write selector type. */
2496#define X86_SEL_TYPE_RW_ACC (2 | X86_SEL_TYPE_ACCESSED)
2497/** Expand down read only selector type. */
2498#define X86_SEL_TYPE_RO_DOWN 4
2499/** Accessed expand down read only selector type. */
2500#define X86_SEL_TYPE_RO_DOWN_ACC (4 | X86_SEL_TYPE_ACCESSED)
2501/** Expand down read write selector type. */
2502#define X86_SEL_TYPE_RW_DOWN 6
2503/** Accessed expand down read write selector type. */
2504#define X86_SEL_TYPE_RW_DOWN_ACC (6 | X86_SEL_TYPE_ACCESSED)
2505/** Execute only selector type. */
2506#define X86_SEL_TYPE_EO (0 | X86_SEL_TYPE_CODE)
2507/** Accessed execute only selector type. */
2508#define X86_SEL_TYPE_EO_ACC (0 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
2509/** Execute and read selector type. */
2510#define X86_SEL_TYPE_ER (2 | X86_SEL_TYPE_CODE)
2511/** Accessed execute and read selector type. */
2512#define X86_SEL_TYPE_ER_ACC (2 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
2513/** Conforming execute only selector type. */
2514#define X86_SEL_TYPE_EO_CONF (4 | X86_SEL_TYPE_CODE)
2515/** Accessed Conforming execute only selector type. */
2516#define X86_SEL_TYPE_EO_CONF_ACC (4 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
2517/** Conforming execute and write selector type. */
2518#define X86_SEL_TYPE_ER_CONF (6 | X86_SEL_TYPE_CODE)
2519/** Accessed Conforming execute and write selector type. */
2520#define X86_SEL_TYPE_ER_CONF_ACC (6 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
2521/** @} */
2522
2523
2524/** @name System Selector Types.
2525 * @{ */
2526/** The TSS busy bit mask. */
2527#define X86_SEL_TYPE_SYS_TSS_BUSY_MASK 2
2528
2529/** Undefined system selector type. */
2530#define X86_SEL_TYPE_SYS_UNDEFINED 0
2531/** 286 TSS selector. */
2532#define X86_SEL_TYPE_SYS_286_TSS_AVAIL 1
2533/** LDT selector. */
2534#define X86_SEL_TYPE_SYS_LDT 2
2535/** 286 TSS selector - Busy. */
2536#define X86_SEL_TYPE_SYS_286_TSS_BUSY 3
2537/** 286 Callgate selector. */
2538#define X86_SEL_TYPE_SYS_286_CALL_GATE 4
2539/** Taskgate selector. */
2540#define X86_SEL_TYPE_SYS_TASK_GATE 5
2541/** 286 Interrupt gate selector. */
2542#define X86_SEL_TYPE_SYS_286_INT_GATE 6
2543/** 286 Trapgate selector. */
2544#define X86_SEL_TYPE_SYS_286_TRAP_GATE 7
2545/** Undefined system selector. */
2546#define X86_SEL_TYPE_SYS_UNDEFINED2 8
2547/** 386 TSS selector. */
2548#define X86_SEL_TYPE_SYS_386_TSS_AVAIL 9
2549/** Undefined system selector. */
2550#define X86_SEL_TYPE_SYS_UNDEFINED3 0xA
2551/** 386 TSS selector - Busy. */
2552#define X86_SEL_TYPE_SYS_386_TSS_BUSY 0xB
2553/** 386 Callgate selector. */
2554#define X86_SEL_TYPE_SYS_386_CALL_GATE 0xC
2555/** Undefined system selector. */
2556#define X86_SEL_TYPE_SYS_UNDEFINED4 0xD
2557/** 386 Interruptgate selector. */
2558#define X86_SEL_TYPE_SYS_386_INT_GATE 0xE
2559/** 386 Trapgate selector. */
2560#define X86_SEL_TYPE_SYS_386_TRAP_GATE 0xF
2561/** @} */
2562
2563/** @name AMD64 System Selector Types.
2564 * @{ */
2565/** LDT selector. */
2566#define AMD64_SEL_TYPE_SYS_LDT 2
2567/** TSS selector - Busy. */
2568#define AMD64_SEL_TYPE_SYS_TSS_AVAIL 9
2569/** TSS selector - Busy. */
2570#define AMD64_SEL_TYPE_SYS_TSS_BUSY 0xB
2571/** Callgate selector. */
2572#define AMD64_SEL_TYPE_SYS_CALL_GATE 0xC
2573/** Interruptgate selector. */
2574#define AMD64_SEL_TYPE_SYS_INT_GATE 0xE
2575/** Trapgate selector. */
2576#define AMD64_SEL_TYPE_SYS_TRAP_GATE 0xF
2577/** @} */
2578
2579/** @} */
2580
2581
2582/** @name Descriptor Table Entry Flag Masks.
2583 * These are for the 2nd 32-bit word of a descriptor.
2584 * @{ */
2585/** Bits 8-11 - TYPE - Descriptor type mask. */
2586#define X86_DESC_TYPE_MASK (RT_BIT(8) | RT_BIT(9) | RT_BIT(10) | RT_BIT(11))
2587/** Bit 12 - S - System (=0) or Code/Data (=1). */
2588#define X86_DESC_S RT_BIT(12)
2589/** Bits 13-14 - DPL - Descriptor Privilege Level. */
2590#define X86_DESC_DPL (RT_BIT(13) | RT_BIT(14))
2591/** Bit 15 - P - Present. */
2592#define X86_DESC_P RT_BIT(15)
2593/** Bit 20 - AVL - Available for system software. */
2594#define X86_DESC_AVL RT_BIT(20)
2595/** Bit 22 - DB - Default operation size. 0 = 16 bit, 1 = 32 bit. */
2596#define X86_DESC_DB RT_BIT(22)
2597/** Bit 23 - G - Granularity of the limit. If set 4KB granularity is
2598 * used, if clear byte. */
2599#define X86_DESC_G RT_BIT(23)
2600/** @} */
2601
2602/** @} */
2603
2604
2605/** @name Task Segments.
2606 * @{
2607 */
2608
2609/**
2610 * 16-bit Task Segment (TSS).
2611 */
2612#pragma pack(1)
2613typedef struct X86TSS16
2614{
2615 /** Back link to previous task. (static) */
2616 RTSEL selPrev;
2617 /** Ring-0 stack pointer. (static) */
2618 uint16_t sp0;
2619 /** Ring-0 stack segment. (static) */
2620 RTSEL ss0;
2621 /** Ring-1 stack pointer. (static) */
2622 uint16_t sp1;
2623 /** Ring-1 stack segment. (static) */
2624 RTSEL ss1;
2625 /** Ring-2 stack pointer. (static) */
2626 uint16_t sp2;
2627 /** Ring-2 stack segment. (static) */
2628 RTSEL ss2;
2629 /** IP before task switch. */
2630 uint16_t ip;
2631 /** FLAGS before task switch. */
2632 uint16_t flags;
2633 /** AX before task switch. */
2634 uint16_t ax;
2635 /** CX before task switch. */
2636 uint16_t cx;
2637 /** DX before task switch. */
2638 uint16_t dx;
2639 /** BX before task switch. */
2640 uint16_t bx;
2641 /** SP before task switch. */
2642 uint16_t sp;
2643 /** BP before task switch. */
2644 uint16_t bp;
2645 /** SI before task switch. */
2646 uint16_t si;
2647 /** DI before task switch. */
2648 uint16_t di;
2649 /** ES before task switch. */
2650 RTSEL es;
2651 /** CS before task switch. */
2652 RTSEL cs;
2653 /** SS before task switch. */
2654 RTSEL ss;
2655 /** DS before task switch. */
2656 RTSEL ds;
2657 /** LDTR before task switch. */
2658 RTSEL selLdt;
2659} X86TSS16;
2660AssertCompileSize(X86TSS16, 44);
2661#pragma pack()
2662/** Pointer to a 16-bit task segment. */
2663typedef X86TSS16 *PX86TSS16;
2664/** Pointer to a const 16-bit task segment. */
2665typedef const X86TSS16 *PCX86TSS16;
2666
2667
2668/**
2669 * 32-bit Task Segment (TSS).
2670 */
2671#pragma pack(1)
2672typedef struct X86TSS32
2673{
2674 /** Back link to previous task. (static) */
2675 RTSEL selPrev;
2676 uint16_t padding1;
2677 /** Ring-0 stack pointer. (static) */
2678 uint32_t esp0;
2679 /** Ring-0 stack segment. (static) */
2680 RTSEL ss0;
2681 uint16_t padding_ss0;
2682 /** Ring-1 stack pointer. (static) */
2683 uint32_t esp1;
2684 /** Ring-1 stack segment. (static) */
2685 RTSEL ss1;
2686 uint16_t padding_ss1;
2687 /** Ring-2 stack pointer. (static) */
2688 uint32_t esp2;
2689 /** Ring-2 stack segment. (static) */
2690 RTSEL ss2;
2691 uint16_t padding_ss2;
2692 /** Page directory for the task. (static) */
2693 uint32_t cr3;
2694 /** EIP before task switch. */
2695 uint32_t eip;
2696 /** EFLAGS before task switch. */
2697 uint32_t eflags;
2698 /** EAX before task switch. */
2699 uint32_t eax;
2700 /** ECX before task switch. */
2701 uint32_t ecx;
2702 /** EDX before task switch. */
2703 uint32_t edx;
2704 /** EBX before task switch. */
2705 uint32_t ebx;
2706 /** ESP before task switch. */
2707 uint32_t esp;
2708 /** EBP before task switch. */
2709 uint32_t ebp;
2710 /** ESI before task switch. */
2711 uint32_t esi;
2712 /** EDI before task switch. */
2713 uint32_t edi;
2714 /** ES before task switch. */
2715 RTSEL es;
2716 uint16_t padding_es;
2717 /** CS before task switch. */
2718 RTSEL cs;
2719 uint16_t padding_cs;
2720 /** SS before task switch. */
2721 RTSEL ss;
2722 uint16_t padding_ss;
2723 /** DS before task switch. */
2724 RTSEL ds;
2725 uint16_t padding_ds;
2726 /** FS before task switch. */
2727 RTSEL fs;
2728 uint16_t padding_fs;
2729 /** GS before task switch. */
2730 RTSEL gs;
2731 uint16_t padding_gs;
2732 /** LDTR before task switch. */
2733 RTSEL selLdt;
2734 uint16_t padding_ldt;
2735 /** Debug trap flag */
2736 uint16_t fDebugTrap;
2737 /** Offset relative to the TSS of the start of the I/O Bitmap
2738 * and the end of the interrupt redirection bitmap. */
2739 uint16_t offIoBitmap;
2740 /** 32 bytes for the virtual interrupt redirection bitmap. (VME) */
2741 uint8_t IntRedirBitmap[32];
2742} X86TSS32;
2743#pragma pack()
2744/** Pointer to task segment. */
2745typedef X86TSS32 *PX86TSS32;
2746/** Pointer to const task segment. */
2747typedef const X86TSS32 *PCX86TSS32;
2748
2749
2750/**
2751 * 64-bit Task segment.
2752 */
2753#pragma pack(1)
2754typedef struct X86TSS64
2755{
2756 /** Reserved. */
2757 uint32_t u32Reserved;
2758 /** Ring-0 stack pointer. (static) */
2759 uint64_t rsp0;
2760 /** Ring-1 stack pointer. (static) */
2761 uint64_t rsp1;
2762 /** Ring-2 stack pointer. (static) */
2763 uint64_t rsp2;
2764 /** Reserved. */
2765 uint32_t u32Reserved2[2];
2766 /* IST */
2767 uint64_t ist1;
2768 uint64_t ist2;
2769 uint64_t ist3;
2770 uint64_t ist4;
2771 uint64_t ist5;
2772 uint64_t ist6;
2773 uint64_t ist7;
2774 /* Reserved. */
2775 uint16_t u16Reserved[5];
2776 /** Offset relative to the TSS of the start of the I/O Bitmap
2777 * and the end of the interrupt redirection bitmap. */
2778 uint16_t offIoBitmap;
2779 /** 32 bytes for the virtual interrupt redirection bitmap. (VME) */
2780 uint8_t IntRedirBitmap[32];
2781} X86TSS64;
2782#pragma pack()
2783/** Pointer to a 64-bit task segment. */
2784typedef X86TSS64 *PX86TSS64;
2785/** Pointer to a const 64-bit task segment. */
2786typedef const X86TSS64 *PCX86TSS64;
2787AssertCompileSize(X86TSS64, 136);
2788
2789/** @} */
2790
2791
2792/** @name Selectors.
2793 * @{
2794 */
2795
2796/**
2797 * The shift used to convert a selector from and to index an index (C).
2798 */
2799#define X86_SEL_SHIFT 3
2800
2801/**
2802 * The mask used to mask off the table indicator and CPL of an selector.
2803 */
2804#define X86_SEL_MASK 0xfff8U
2805
2806/**
2807 * The bit indicating that a selector is in the LDT and not in the GDT.
2808 */
2809#define X86_SEL_LDT 0x0004U
2810/**
2811 * The bit mask for getting the RPL of a selector.
2812 */
2813#define X86_SEL_RPL 0x0003U
2814
2815/** @} */
2816
2817
2818/**
2819 * x86 Exceptions/Faults/Traps.
2820 */
2821typedef enum X86XCPT
2822{
2823 /** \#DE - Divide error. */
2824 X86_XCPT_DE = 0x00,
2825 /** \#DB - Debug event (single step, DRx, ..) */
2826 X86_XCPT_DB = 0x01,
2827 /** NMI - Non-Maskable Interrupt */
2828 X86_XCPT_NMI = 0x02,
2829 /** \#BP - Breakpoint (INT3). */
2830 X86_XCPT_BP = 0x03,
2831 /** \#OF - Overflow (INTO). */
2832 X86_XCPT_OF = 0x04,
2833 /** \#BR - Bound range exceeded (BOUND). */
2834 X86_XCPT_BR = 0x05,
2835 /** \#UD - Undefined opcode. */
2836 X86_XCPT_UD = 0x06,
2837 /** \#NM - Device not available (math coprocessor device). */
2838 X86_XCPT_NM = 0x07,
2839 /** \#DF - Double fault. */
2840 X86_XCPT_DF = 0x08,
2841 /** ??? - Coprocessor segment overrun (obsolete). */
2842 X86_XCPT_CO_SEG_OVERRUN = 0x09,
2843 /** \#TS - Taskswitch (TSS). */
2844 X86_XCPT_TS = 0x0a,
2845 /** \#NP - Segment no present. */
2846 X86_XCPT_NP = 0x0b,
2847 /** \#SS - Stack segment fault. */
2848 X86_XCPT_SS = 0x0c,
2849 /** \#GP - General protection fault. */
2850 X86_XCPT_GP = 0x0d,
2851 /** \#PF - Page fault. */
2852 X86_XCPT_PF = 0x0e,
2853 /* 0x0f is reserved. */
2854 /** \#MF - Math fault (FPU). */
2855 X86_XCPT_MF = 0x10,
2856 /** \#AC - Alignment check. */
2857 X86_XCPT_AC = 0x11,
2858 /** \#MC - Machine check. */
2859 X86_XCPT_MC = 0x12,
2860 /** \#XF - SIMD Floating-Pointer Exception. */
2861 X86_XCPT_XF = 0x13
2862} X86XCPT;
2863/** Pointer to a x86 exception code. */
2864typedef X86XCPT *PX86XCPT;
2865/** Pointer to a const x86 exception code. */
2866typedef const X86XCPT *PCX86XCPT;
2867
2868
2869/** @name Trap Error Codes
2870 * @{
2871 */
2872/** External indicator. */
2873#define X86_TRAP_ERR_EXTERNAL 1
2874/** IDT indicator. */
2875#define X86_TRAP_ERR_IDT 2
2876/** Descriptor table indicator - If set LDT, if clear GDT. */
2877#define X86_TRAP_ERR_TI 4
2878/** Mask for getting the selector. */
2879#define X86_TRAP_ERR_SEL_MASK 0xfff8
2880/** Shift for getting the selector table index (C type index). */
2881#define X86_TRAP_ERR_SEL_SHIFT 3
2882/** @} */
2883
2884
2885/** @name \#PF Trap Error Codes
2886 * @{
2887 */
2888/** Bit 0 - P - Not present (clear) or page level protection (set) fault. */
2889#define X86_TRAP_PF_P RT_BIT(0)
2890/** Bit 1 - R/W - Read (clear) or write (set) access. */
2891#define X86_TRAP_PF_RW RT_BIT(1)
2892/** Bit 2 - U/S - CPU executing in user mode (set) or supervisor mode (clear). */
2893#define X86_TRAP_PF_US RT_BIT(2)
2894/** Bit 3 - RSVD- Reserved bit violation (set), i.e. reserved bit was set to 1. */
2895#define X86_TRAP_PF_RSVD RT_BIT(3)
2896/** Bit 4 - I/D - Instruction fetch (set) / Data access (clear) - PAE + NXE. */
2897#define X86_TRAP_PF_ID RT_BIT(4)
2898/** @} */
2899
2900#pragma pack(1)
2901/**
2902 * 32-bit IDTR/GDTR.
2903 */
2904typedef struct X86XDTR32
2905{
2906 /** Size of the descriptor table. */
2907 uint16_t cb;
2908 /** Address of the descriptor table. */
2909 uint32_t uAddr;
2910} X86XDTR32, *PX86XDTR32;
2911#pragma pack()
2912
2913#pragma pack(1)
2914/**
2915 * 64-bit IDTR/GDTR.
2916 */
2917typedef struct X86XDTR64
2918{
2919 /** Size of the descriptor table. */
2920 uint16_t cb;
2921 /** Address of the descriptor table. */
2922 uint64_t uAddr;
2923} X86XDTR64, *PX86XDTR64;
2924#pragma pack()
2925
2926
2927/** @name ModR/M
2928 * @{ */
2929#define X86_MODRM_RM_MASK UINT8_C(0x07)
2930#define X86_MODRM_REG_MASK UINT8_C(0x38)
2931#define X86_MODRM_REG_SMASK UINT8_C(0x07)
2932#define X86_MODRM_REG_SHIFT 3
2933#define X86_MODRM_MOD_MASK UINT8_C(0xc0)
2934#define X86_MODRM_MOD_SMASK UINT8_C(0x03)
2935#define X86_MODRM_MOD_SHIFT 6
2936AssertCompile((X86_MODRM_RM_MASK | X86_MODRM_REG_MASK | X86_MODRM_MOD_MASK) == 0xff);
2937AssertCompile((X86_MODRM_REG_MASK >> X86_MODRM_REG_SHIFT) == X86_MODRM_REG_SMASK);
2938AssertCompile((X86_MODRM_MOD_MASK >> X86_MODRM_MOD_SHIFT) == X86_MODRM_MOD_SMASK);
2939/** @} */
2940
2941/** @name SIB
2942 * @{ */
2943#define X86_SIB_BASE_MASK UINT8_C(0x07)
2944#define X86_SIB_INDEX_MASK UINT8_C(0x38)
2945#define X86_SIB_INDEX_SMASK UINT8_C(0x07)
2946#define X86_SIB_INDEX_SHIFT 3
2947#define X86_SIB_SCALE_MASK UINT8_C(0xc0)
2948#define X86_SIB_SCALE_SMASK UINT8_C(0x03)
2949#define X86_SIB_SCALE_SHIFT 6
2950AssertCompile((X86_SIB_BASE_MASK | X86_SIB_INDEX_MASK | X86_SIB_SCALE_MASK) == 0xff);
2951AssertCompile((X86_SIB_INDEX_MASK >> X86_SIB_INDEX_SHIFT) == X86_SIB_INDEX_SMASK);
2952AssertCompile((X86_SIB_SCALE_MASK >> X86_SIB_SCALE_SHIFT) == X86_SIB_SCALE_SMASK);
2953/** @} */
2954
2955/** @name General register indexes
2956 * @{ */
2957#define X86_GREG_xAX 0
2958#define X86_GREG_xCX 1
2959#define X86_GREG_xDX 2
2960#define X86_GREG_xBX 3
2961#define X86_GREG_xSP 4
2962#define X86_GREG_xBP 5
2963#define X86_GREG_xSI 6
2964#define X86_GREG_xDI 7
2965#define X86_GREG_x8 8
2966#define X86_GREG_x9 9
2967#define X86_GREG_x10 10
2968#define X86_GREG_x11 11
2969#define X86_GREG_x12 12
2970#define X86_GREG_x13 13
2971#define X86_GREG_x14 14
2972#define X86_GREG_x15 15
2973/** @} */
2974
2975/** @name X86_SREG_XXX - Segment register indexes.
2976 * @{ */
2977#define X86_SREG_ES 0
2978#define X86_SREG_CS 1
2979#define X86_SREG_SS 2
2980#define X86_SREG_DS 3
2981#define X86_SREG_FS 4
2982#define X86_SREG_GS 5
2983/** @} */
2984
2985
2986/** @} */
2987
2988#endif
2989
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