VirtualBox

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

Last change on this file since 11897 was 11688, checked in by vboxsync, 16 years ago

Some more MSR logging

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 84.0 KB
Line 
1/** @file
2 * X86 (and AMD64) Structures and Definitions.
3 */
4
5/*
6 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 *
25 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26 * Clara, CA 95054 USA or visit http://www.sun.com if you need
27 * additional information or have any questions.
28 */
29
30/*
31 * x86.mac is generated from this file using:
32 * sed -e '/__VBox_x86_h__/d' -e '/#define/!d' -e 's/#define/%define/' include/VBox/x86.h
33 */
34
35#ifndef ___VBox_x86_h
36#define ___VBox_x86_h
37
38#include <VBox/types.h>
39
40/* Workaround for Solaris sys/regset.h defining CS, DS */
41#if defined(RT_OS_SOLARIS)
42# undef CS
43# undef DS
44#endif
45
46/** @defgroup grp_x86 x86 Types and Definitions
47 * @{
48 */
49
50/**
51 * EFLAGS Bits.
52 */
53typedef struct X86EFLAGSBITS
54{
55 /** Bit 0 - CF - Carry flag - Status flag. */
56 unsigned u1CF : 1;
57 /** Bit 1 - 1 - Reserved flag. */
58 unsigned u1Reserved0 : 1;
59 /** Bit 2 - PF - Parity flag - Status flag. */
60 unsigned u1PF : 1;
61 /** Bit 3 - 0 - Reserved flag. */
62 unsigned u1Reserved1 : 1;
63 /** Bit 4 - AF - Auxiliary carry flag - Status flag. */
64 unsigned u1AF : 1;
65 /** Bit 5 - 0 - Reserved flag. */
66 unsigned u1Reserved2 : 1;
67 /** Bit 6 - ZF - Zero flag - Status flag. */
68 unsigned u1ZF : 1;
69 /** Bit 7 - SF - Signed flag - Status flag. */
70 unsigned u1SF : 1;
71 /** Bit 8 - TF - Trap flag - System flag. */
72 unsigned u1TF : 1;
73 /** Bit 9 - IF - Interrupt flag - System flag. */
74 unsigned u1IF : 1;
75 /** Bit 10 - DF - Direction flag - Control flag. */
76 unsigned u1DF : 1;
77 /** Bit 11 - OF - Overflow flag - Status flag. */
78 unsigned u1OF : 1;
79 /** Bit 12-13 - IOPL - I/O prvilege level flag - System flag. */
80 unsigned u2IOPL : 2;
81 /** Bit 14 - NT - Nested task flag - System flag. */
82 unsigned u1NT : 1;
83 /** Bit 15 - 0 - Reserved flag. */
84 unsigned u1Reserved3 : 1;
85 /** Bit 16 - RF - Resume flag - System flag. */
86 unsigned u1RF : 1;
87 /** Bit 17 - VM - Virtual 8086 mode - System flag. */
88 unsigned u1VM : 1;
89 /** Bit 18 - AC - Alignment check flag - System flag. Works with CR0.AM. */
90 unsigned u1AC : 1;
91 /** Bit 19 - VIF - Virtual interupt flag - System flag. */
92 unsigned u1VIF : 1;
93 /** Bit 20 - VIP - Virtual interupt pending flag - System flag. */
94 unsigned u1VIP : 1;
95 /** Bit 21 - ID - CPUID flag - System flag. If this responds to flipping CPUID is supported. */
96 unsigned u1ID : 1;
97 /** Bit 22-31 - 0 - Reserved flag. */
98 unsigned u10Reserved4 : 10;
99} X86EFLAGSBITS;
100/** Pointer to EFLAGS bits. */
101typedef X86EFLAGSBITS *PX86EFLAGSBITS;
102/** Pointer to const EFLAGS bits. */
103typedef const X86EFLAGSBITS *PCX86EFLAGSBITS;
104
105/**
106 * EFLAGS.
107 */
108typedef union X86EFLAGS
109{
110 /** The bitfield view. */
111 X86EFLAGSBITS Bits;
112 /** The 8-bit view. */
113 uint8_t au8[4];
114 /** The 16-bit view. */
115 uint16_t au16[2];
116 /** The 32-bit view. */
117 uint32_t au32[1];
118 /** The 32-bit view. */
119 uint32_t u32;
120 /** The plain unsigned view. */
121 uint32_t u;
122} X86EFLAGS;
123/** Pointer to EFLAGS. */
124typedef X86EFLAGS *PX86EFLAGS;
125/** Pointer to const EFLAGS. */
126typedef const X86EFLAGS *PCX86EFLAGS;
127
128/**
129 * RFLAGS (32 upper bits are reserved).
130 */
131typedef union X86RFLAGS
132{
133 /** The bitfield view. */
134 X86EFLAGSBITS Bits;
135 /** The 8-bit view. */
136 uint8_t au8[8];
137 /** The 16-bit view. */
138 uint16_t au16[4];
139 /** The 32-bit view. */
140 uint32_t au32[2];
141 /** The 64-bit view. */
142 uint64_t au64[1];
143 /** The 64-bit view. */
144 uint64_t u64;
145 /** The plain unsigned view. */
146 uint64_t u;
147} X86RFLAGS;
148/** Pointer to RFLAGS. */
149typedef X86RFLAGS *PX86RFLAGS;
150/** Pointer to const RFLAGS. */
151typedef const X86RFLAGS *PCX86RFLAGS;
152
153
154/** @name EFLAGS
155 * @{
156 */
157/** Bit 0 - CF - Carry flag - Status flag. */
158#define X86_EFL_CF RT_BIT(0)
159/** Bit 2 - PF - Parity flag - Status flag. */
160#define X86_EFL_PF RT_BIT(2)
161/** Bit 4 - AF - Auxiliary carry flag - Status flag. */
162#define X86_EFL_AF RT_BIT(4)
163/** Bit 6 - ZF - Zero flag - Status flag. */
164#define X86_EFL_ZF RT_BIT(6)
165/** Bit 7 - SF - Signed flag - Status flag. */
166#define X86_EFL_SF RT_BIT(7)
167/** Bit 8 - TF - Trap flag - System flag. */
168#define X86_EFL_TF RT_BIT(8)
169/** Bit 9 - IF - Interrupt flag - System flag. */
170#define X86_EFL_IF RT_BIT(9)
171/** Bit 10 - DF - Direction flag - Control flag. */
172#define X86_EFL_DF RT_BIT(10)
173/** Bit 11 - OF - Overflow flag - Status flag. */
174#define X86_EFL_OF RT_BIT(11)
175/** Bit 12-13 - IOPL - I/O prvilege level flag - System flag. */
176#define X86_EFL_IOPL (RT_BIT(12) | RT_BIT(13))
177/** Bit 14 - NT - Nested task flag - System flag. */
178#define X86_EFL_NT RT_BIT(14)
179/** Bit 16 - RF - Resume flag - System flag. */
180#define X86_EFL_RF RT_BIT(16)
181/** Bit 17 - VM - Virtual 8086 mode - System flag. */
182#define X86_EFL_VM RT_BIT(17)
183/** Bit 18 - AC - Alignment check flag - System flag. Works with CR0.AM. */
184#define X86_EFL_AC RT_BIT(18)
185/** Bit 19 - VIF - Virtual interupt flag - System flag. */
186#define X86_EFL_VIF RT_BIT(19)
187/** Bit 20 - VIP - Virtual interupt pending flag - System flag. */
188#define X86_EFL_VIP RT_BIT(20)
189/** Bit 21 - ID - CPUID flag - System flag. If this responds to flipping CPUID is supported. */
190#define X86_EFL_ID RT_BIT(21)
191/** IOPL shift. */
192#define X86_EFL_IOPL_SHIFT 12
193/** The the IOPL level from the flags. */
194#define X86_EFL_GET_IOPL(efl) (((efl) >> X86_EFL_IOPL_SHIFT) & 3)
195/** @} */
196
197
198/** CPUID Feature information - ECX.
199 * CPUID query with EAX=1.
200 */
201typedef struct X86CPUIDFEATECX
202{
203 /** Bit 0 - SSE3 - Supports SSE3 or not. */
204 unsigned u1SSE3 : 1;
205 /** Reserved. */
206 unsigned u2Reserved1 : 2;
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 /** Reserved. */
214 unsigned u1Reserved2 : 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 /** Reserved. */
224 unsigned u2Reserved4 : 2;
225 /** Bit 13 - CX16 - CMPXCHG16B. */
226 unsigned u1CX16 : 1;
227 /** Bit 14 - xTPR Update Control. Processor supports changing IA32_MISC_ENABLES[bit 23]. */
228 unsigned u1TPRUpdate : 1;
229 /** Reserved. */
230 unsigned u17Reserved5 : 17;
231
232} X86CPUIDFEATECX;
233/** Pointer to CPUID Feature Information - ECX. */
234typedef X86CPUIDFEATECX *PX86CPUIDFEATECX;
235/** Pointer to const CPUID Feature Information - ECX. */
236typedef const X86CPUIDFEATECX *PCX86CPUIDFEATECX;
237
238
239/** CPUID Feature Information - EDX.
240 * CPUID query with EAX=1.
241 */
242typedef struct X86CPUIDFEATEDX
243{
244 /** Bit 0 - FPU - x87 FPU on Chip. */
245 unsigned u1FPU : 1;
246 /** Bit 1 - VME - Virtual 8086 Mode Enhancements. */
247 unsigned u1VME : 1;
248 /** Bit 2 - DE - Debugging extensions. */
249 unsigned u1DE : 1;
250 /** Bit 3 - PSE - Page Size Extension. */
251 unsigned u1PSE : 1;
252 /** Bit 4 - TSC - Time Stamp Counter. */
253 unsigned u1TSC : 1;
254 /** Bit 5 - MSR - Model Specific Registers RDMSR and WRMSR Instructions. */
255 unsigned u1MSR : 1;
256 /** Bit 6 - PAE - Physical Address Extension. */
257 unsigned u1PAE : 1;
258 /** Bit 7 - MCE - Machine Check Exception. */
259 unsigned u1MCE : 1;
260 /** Bit 8 - CX8 - CMPXCHG8B instruction. */
261 unsigned u1CX8 : 1;
262 /** Bit 9 - APIC - APIC On-Chip. */
263 unsigned u1APIC : 1;
264 /** Bit 10 - Reserved. */
265 unsigned u1Reserved1 : 1;
266 /** Bit 11 - SEP - SYSENTER and SYSEXIT. */
267 unsigned u1SEP : 1;
268 /** Bit 12 - MTRR - Memory Type Range Registers. */
269 unsigned u1MTRR : 1;
270 /** Bit 13 - PGE - PTE Global Bit. */
271 unsigned u1PGE : 1;
272 /** Bit 14 - MCA - Machine Check Architecture. */
273 unsigned u1MCA : 1;
274 /** Bit 15 - CMOV - Conditional Move Instructions. */
275 unsigned u1CMOV : 1;
276 /** Bit 16 - PAT - Page Attribute Table. */
277 unsigned u1PAT : 1;
278 /** Bit 17 - PSE-36 - 36-bit Page Size Extention. */
279 unsigned u1PSE36 : 1;
280 /** Bit 18 - PSN - Processor Serial Number. */
281 unsigned u1PSN : 1;
282 /** Bit 19 - CLFSH - CLFLUSH Instruction. */
283 unsigned u1CLFSH : 1;
284 /** Bit 20 - Reserved. */
285 unsigned u1Reserved2 : 1;
286 /** Bit 21 - DS - Debug Store. */
287 unsigned u1DS : 1;
288 /** Bit 22 - ACPI - Thermal Monitor and Software Controlled Clock Facilities. */
289 unsigned u1ACPI : 1;
290 /** Bit 23 - MMX - Intel MMX 'Technology'. */
291 unsigned u1MMX : 1;
292 /** Bit 24 - FXSR - FXSAVE and FXRSTOR Instructions. */
293 unsigned u1FXSR : 1;
294 /** Bit 25 - SSE - SSE Support. */
295 unsigned u1SSE : 1;
296 /** Bit 26 - SSE2 - SSE2 Support. */
297 unsigned u1SSE2 : 1;
298 /** Bit 27 - SS - Self Snoop. */
299 unsigned u1SS : 1;
300 /** Bit 28 - HTT - Hyper-Threading Technology. */
301 unsigned u1HTT : 1;
302 /** Bit 29 - TM - Thermal Monitor. */
303 unsigned u1TM : 1;
304 /** Bit 30 - Reserved - . */
305 unsigned u1Reserved3 : 1;
306 /** Bit 31 - PBE - Pending Break Enabled. */
307 unsigned u1PBE : 1;
308} X86CPUIDFEATEDX;
309/** Pointer to CPUID Feature Information - EDX. */
310typedef X86CPUIDFEATEDX *PX86CPUIDFEATEDX;
311/** Pointer to const CPUID Feature Information - EDX. */
312typedef const X86CPUIDFEATEDX *PCX86CPUIDFEATEDX;
313
314/** @name CPUID Vendor information.
315 * CPUID query with EAX=0.
316 * @{
317 */
318#define X86_CPUID_VENDOR_INTEL_EBX 0x756e6547 /* Genu */
319#define X86_CPUID_VENDOR_INTEL_ECX 0x6c65746e /* ntel */
320#define X86_CPUID_VENDOR_INTEL_EDX 0x49656e69 /* ineI */
321
322#define X86_CPUID_VENDOR_AMD_EBX 0x68747541 /* Auth */
323#define X86_CPUID_VENDOR_AMD_ECX 0x444d4163 /* cAMD */
324#define X86_CPUID_VENDOR_AMD_EDX 0x69746e65 /* enti */
325/** @} */
326
327
328/** @name CPUID Feature information.
329 * CPUID query with EAX=1.
330 * @{
331 */
332/** ECX Bit 0 - SSE3 - Supports SSE3 or not. */
333#define X86_CPUID_FEATURE_ECX_SSE3 RT_BIT(0)
334/** ECX Bit 3 - MONITOR - Supports MONITOR/MWAIT. */
335#define X86_CPUID_FEATURE_ECX_MONITOR RT_BIT(3)
336/** ECX Bit 4 - CPL-DS - CPL Qualified Debug Store. */
337#define X86_CPUID_FEATURE_ECX_CPLDS RT_BIT(4)
338/** ECX Bit 5 - VMX - Virtual Machine Technology. */
339#define X86_CPUID_FEATURE_ECX_VMX RT_BIT(5)
340/** ECX Bit 7 - EST - Enh. SpeedStep Tech. */
341#define X86_CPUID_FEATURE_ECX_EST RT_BIT(7)
342/** ECX Bit 8 - TM2 - Terminal Monitor 2. */
343#define X86_CPUID_FEATURE_ECX_TM2 RT_BIT(8)
344/** ECX Bit 9 - SSSE3 - Supplemental Streaming SIMD Extensions 3. */
345#define X86_CPUID_FEATURE_ECX_SSSE3 RT_BIT(9)
346/** ECX Bit 10 - CNTX-ID - L1 Context ID. */
347#define X86_CPUID_FEATURE_ECX_CNTXID RT_BIT(10)
348/** ECX Bit 13 - CX16 - CMPXCHG16B. */
349#define X86_CPUID_FEATURE_ECX_CX16 RT_BIT(13)
350/** ECX Bit 14 - xTPR Update Control. Processor supports changing IA32_MISC_ENABLES[bit 23]. */
351#define X86_CPUID_FEATURE_ECX_TPRUPDATE RT_BIT(14)
352/** ECX Bit 23 - POPCOUNT instruction. */
353#define X86_CPUID_FEATURE_ECX_POPCOUNT RT_BIT(23)
354
355
356/** Bit 0 - FPU - x87 FPU on Chip. */
357#define X86_CPUID_FEATURE_EDX_FPU RT_BIT(0)
358/** Bit 1 - VME - Virtual 8086 Mode Enhancements. */
359#define X86_CPUID_FEATURE_EDX_VME RT_BIT(1)
360/** Bit 2 - DE - Debugging extensions. */
361#define X86_CPUID_FEATURE_EDX_DE RT_BIT(2)
362/** Bit 3 - PSE - Page Size Extension. */
363#define X86_CPUID_FEATURE_EDX_PSE RT_BIT(3)
364/** Bit 4 - TSC - Time Stamp Counter. */
365#define X86_CPUID_FEATURE_EDX_TSC RT_BIT(4)
366/** Bit 5 - MSR - Model Specific Registers RDMSR and WRMSR Instructions. */
367#define X86_CPUID_FEATURE_EDX_MSR RT_BIT(5)
368/** Bit 6 - PAE - Physical Address Extension. */
369#define X86_CPUID_FEATURE_EDX_PAE RT_BIT(6)
370/** Bit 7 - MCE - Machine Check Exception. */
371#define X86_CPUID_FEATURE_EDX_MCE RT_BIT(7)
372/** Bit 8 - CX8 - CMPXCHG8B instruction. */
373#define X86_CPUID_FEATURE_EDX_CX8 RT_BIT(8)
374/** Bit 9 - APIC - APIC On-Chip. */
375#define X86_CPUID_FEATURE_EDX_APIC RT_BIT(9)
376/** Bit 11 - SEP - SYSENTER and SYSEXIT. */
377#define X86_CPUID_FEATURE_EDX_SEP RT_BIT(11)
378/** Bit 12 - MTRR - Memory Type Range Registers. */
379#define X86_CPUID_FEATURE_EDX_MTRR RT_BIT(12)
380/** Bit 13 - PGE - PTE Global Bit. */
381#define X86_CPUID_FEATURE_EDX_PGE RT_BIT(13)
382/** Bit 14 - MCA - Machine Check Architecture. */
383#define X86_CPUID_FEATURE_EDX_MCA RT_BIT(14)
384/** Bit 15 - CMOV - Conditional Move Instructions. */
385#define X86_CPUID_FEATURE_EDX_CMOV RT_BIT(15)
386/** Bit 16 - PAT - Page Attribute Table. */
387#define X86_CPUID_FEATURE_EDX_PAT RT_BIT(16)
388/** Bit 17 - PSE-36 - 36-bit Page Size Extention. */
389#define X86_CPUID_FEATURE_EDX_PSE36 RT_BIT(17)
390/** Bit 18 - PSN - Processor Serial Number. */
391#define X86_CPUID_FEATURE_EDX_PSN RT_BIT(18)
392/** Bit 19 - CLFSH - CLFLUSH Instruction. */
393#define X86_CPUID_FEATURE_EDX_CLFSH RT_BIT(19)
394/** Bit 21 - DS - Debug Store. */
395#define X86_CPUID_FEATURE_EDX_DS RT_BIT(21)
396/** Bit 22 - ACPI - Termal Monitor and Software Controlled Clock Facilities. */
397#define X86_CPUID_FEATURE_EDX_ACPI RT_BIT(22)
398/** Bit 23 - MMX - Intel MMX Technology. */
399#define X86_CPUID_FEATURE_EDX_MMX RT_BIT(23)
400/** Bit 24 - FXSR - FXSAVE and FXRSTOR Instructions. */
401#define X86_CPUID_FEATURE_EDX_FXSR RT_BIT(24)
402/** Bit 25 - SSE - SSE Support. */
403#define X86_CPUID_FEATURE_EDX_SSE RT_BIT(25)
404/** Bit 26 - SSE2 - SSE2 Support. */
405#define X86_CPUID_FEATURE_EDX_SSE2 RT_BIT(26)
406/** Bit 27 - SS - Self Snoop. */
407#define X86_CPUID_FEATURE_EDX_SS RT_BIT(27)
408/** Bit 28 - HTT - Hyper-Threading Technology. */
409#define X86_CPUID_FEATURE_EDX_HTT RT_BIT(28)
410/** Bit 29 - TM - Therm. Monitor. */
411#define X86_CPUID_FEATURE_EDX_TM RT_BIT(29)
412/** Bit 31 - PBE - Pending Break Enabled. */
413#define X86_CPUID_FEATURE_EDX_PBE RT_BIT(31)
414/** @} */
415
416
417/** @name CPUID AMD Feature information.
418 * CPUID query with EAX=0x80000001.
419 * @{
420 */
421/** Bit 0 - FPU - x87 FPU on Chip. */
422#define X86_CPUID_AMD_FEATURE_EDX_FPU RT_BIT(0)
423/** Bit 1 - VME - Virtual 8086 Mode Enhancements. */
424#define X86_CPUID_AMD_FEATURE_EDX_VME RT_BIT(1)
425/** Bit 2 - DE - Debugging extensions. */
426#define X86_CPUID_AMD_FEATURE_EDX_DE RT_BIT(2)
427/** Bit 3 - PSE - Page Size Extension. */
428#define X86_CPUID_AMD_FEATURE_EDX_PSE RT_BIT(3)
429/** Bit 4 - TSC - Time Stamp Counter. */
430#define X86_CPUID_AMD_FEATURE_EDX_TSC RT_BIT(4)
431/** Bit 5 - MSR - K86 Model Specific Registers RDMSR and WRMSR Instructions. */
432#define X86_CPUID_AMD_FEATURE_EDX_MSR RT_BIT(5)
433/** Bit 6 - PAE - Physical Address Extension. */
434#define X86_CPUID_AMD_FEATURE_EDX_PAE RT_BIT(6)
435/** Bit 7 - MCE - Machine Check Exception. */
436#define X86_CPUID_AMD_FEATURE_EDX_MCE RT_BIT(7)
437/** Bit 8 - CX8 - CMPXCHG8B instruction. */
438#define X86_CPUID_AMD_FEATURE_EDX_CX8 RT_BIT(8)
439/** Bit 9 - APIC - APIC On-Chip. */
440#define X86_CPUID_AMD_FEATURE_EDX_APIC RT_BIT(9)
441/** Bit 11 - SEP - AMD SYSCALL and SYSRET. */
442#define X86_CPUID_AMD_FEATURE_EDX_SEP RT_BIT(11)
443/** Bit 12 - MTRR - Memory Type Range Registers. */
444#define X86_CPUID_AMD_FEATURE_EDX_MTRR RT_BIT(12)
445/** Bit 13 - PGE - PTE Global Bit. */
446#define X86_CPUID_AMD_FEATURE_EDX_PGE RT_BIT(13)
447/** Bit 14 - MCA - Machine Check Architecture. */
448#define X86_CPUID_AMD_FEATURE_EDX_MCA RT_BIT(14)
449/** Bit 15 - CMOV - Conditional Move Instructions. */
450#define X86_CPUID_AMD_FEATURE_EDX_CMOV RT_BIT(15)
451/** Bit 16 - PAT - Page Attribute Table. */
452#define X86_CPUID_AMD_FEATURE_EDX_PAT RT_BIT(16)
453/** Bit 17 - PSE-36 - 36-bit Page Size Extention. */
454#define X86_CPUID_AMD_FEATURE_EDX_PSE36 RT_BIT(17)
455/** Bit 20 - NX - AMD No-Execute Page Protection. */
456#define X86_CPUID_AMD_FEATURE_EDX_NX RT_BIT(20)
457/** Bit 22 - AXMMX - AMD Extensions to MMX Instructions. */
458#define X86_CPUID_AMD_FEATURE_EDX_AXMMX RT_BIT(22)
459/** Bit 23 - MMX - Intel MMX Technology. */
460#define X86_CPUID_AMD_FEATURE_EDX_MMX RT_BIT(23)
461/** Bit 24 - FXSR - FXSAVE and FXRSTOR Instructions. */
462#define X86_CPUID_AMD_FEATURE_EDX_FXSR RT_BIT(24)
463/** Bit 25 - FFXSR - AMD fast FXSAVE and FXRSTOR Instructions. */
464#define X86_CPUID_AMD_FEATURE_EDX_FFXSR RT_BIT(25)
465/** Bit 26 - PAGE1GB - AMD 1GB large page support. */
466#define X86_CPUID_AMD_FEATURE_EDX_PAGE1GB RT_BIT(26)
467/** Bit 27 - RDTSCP - AMD RDTSCP instruction. */
468#define X86_CPUID_AMD_FEATURE_EDX_RDTSCP RT_BIT(27)
469/** Bit 29 - LM - AMD Long Mode. */
470#define X86_CPUID_AMD_FEATURE_EDX_LONG_MODE RT_BIT(29)
471/** Bit 30 - 3DNOWEXT - AMD Extensions to 3DNow. */
472#define X86_CPUID_AMD_FEATURE_EDX_3DNOW_EX RT_BIT(30)
473/** Bit 31 - 3DNOW - AMD 3DNow. */
474#define X86_CPUID_AMD_FEATURE_EDX_3DNOW RT_BIT(31)
475
476/** Bit 0 - LAHF/SAHF - AMD LAHF and SAHF in 64-bit mode. */
477#define X86_CPUID_AMD_FEATURE_ECX_LAHF_SAHF RT_BIT(0)
478/** Bit 1 - CMPL - Core multi-processing legacy mode. */
479#define X86_CPUID_AMD_FEATURE_ECX_CMPL RT_BIT(1)
480/** Bit 2 - SVM - AMD VM extensions. */
481#define X86_CPUID_AMD_FEATURE_ECX_SVM RT_BIT(2)
482/** Bit 3 - EXTAPIC - AMD extended APIC registers starting at 0x400. */
483#define X86_CPUID_AMD_FEATURE_ECX_EXT_APIC RT_BIT(3)
484/** Bit 4 - CR8L - AMD LOCK MOV CR0 means MOV CR8. */
485#define X86_CPUID_AMD_FEATURE_ECX_CR8L RT_BIT(4)
486/** Bit 5 - ABM - AMD Advanced bit manipulation. LZCNT instruction support. */
487#define X86_CPUID_AMD_FEATURE_ECX_ABM RT_BIT(5)
488/** Bit 6 - SSE4A - AMD EXTRQ, INSERTQ, MOVNTSS, and MOVNTSD instruction support. */
489#define X86_CPUID_AMD_FEATURE_ECX_SSE4A RT_BIT(6)
490/** Bit 7 - MISALIGNSSE - AMD Misaligned SSE mode. */
491#define X86_CPUID_AMD_FEATURE_ECX_MISALNSSE RT_BIT(7)
492/** Bit 8 - 3DNOWPRF - AMD PREFETCH and PREFETCHW instruction support. */
493#define X86_CPUID_AMD_FEATURE_ECX_3DNOWPRF RT_BIT(8)
494/** Bit 9 - OSVW - AMD OS visible workaround. */
495#define X86_CPUID_AMD_FEATURE_ECX_OSVW RT_BIT(9)
496/** Bit 12 - SKINIT - AMD SKINIT: SKINIT, STGI, and DEV support. */
497#define X86_CPUID_AMD_FEATURE_ECX_SKINIT RT_BIT(12)
498/** Bit 13 - WDT - AMD Watchdog timer support. */
499#define X86_CPUID_AMD_FEATURE_ECX_WDT RT_BIT(13)
500
501/** @} */
502
503
504/** @name CPUID AMD Feature information.
505 * CPUID query with EAX=0x80000007.
506 * @{
507 */
508/** Bit 0 - TS - Temperature Sensor. */
509#define X86_CPUID_AMD_ADVPOWER_EDX_TS RT_BIT(0)
510/** Bit 1 - FID - Frequency ID Control. */
511#define X86_CPUID_AMD_ADVPOWER_EDX_FID RT_BIT(1)
512/** Bit 2 - VID - Voltage ID Control. */
513#define X86_CPUID_AMD_ADVPOWER_EDX_VID RT_BIT(2)
514/** Bit 3 - TTP - THERMTRIP. */
515#define X86_CPUID_AMD_ADVPOWER_EDX_TTP RT_BIT(3)
516/** Bit 4 - TM - Hardware Thermal Control. */
517#define X86_CPUID_AMD_ADVPOWER_EDX_TM RT_BIT(4)
518/** Bit 5 - STC - Software Thermal Control. */
519#define X86_CPUID_AMD_ADVPOWER_EDX_STC RT_BIT(5)
520/** Bit 6 - MC - 100 Mhz Multiplier Control. */
521#define X86_CPUID_AMD_ADVPOWER_EDX_MC RT_BIT(6)
522/** Bit 7 - HWPSTATE - Hardware P-State Control. */
523#define X86_CPUID_AMD_ADVPOWER_EDX_HWPSTATE RT_BIT(7)
524/** Bit 8 - TSCINVAR - TSC Invariant. */
525#define X86_CPUID_AMD_ADVPOWER_EDX_TSCINVAR RT_BIT(8)
526/** @} */
527
528
529/** @name CR0
530 * @{ */
531/** Bit 0 - PE - Protection Enabled */
532#define X86_CR0_PE RT_BIT(0)
533#define X86_CR0_PROTECTION_ENABLE RT_BIT(0)
534/** Bit 1 - MP - Monitor Coprocessor */
535#define X86_CR0_MP RT_BIT(1)
536#define X86_CR0_MONITOR_COPROCESSOR RT_BIT(1)
537/** Bit 2 - EM - Emulation. */
538#define X86_CR0_EM RT_BIT(2)
539#define X86_CR0_EMULATE_FPU RT_BIT(2)
540/** Bit 3 - TS - Task Switch. */
541#define X86_CR0_TS RT_BIT(3)
542#define X86_CR0_TASK_SWITCH RT_BIT(3)
543/** Bit 4 - ET - Extension flag. ('hardcoded' to 1) */
544#define X86_CR0_ET RT_BIT(4)
545#define X86_CR0_EXTENSION_TYPE RT_BIT(4)
546/** Bit 5 - NE - Numeric error. */
547#define X86_CR0_NE RT_BIT(5)
548#define X86_CR0_NUMERIC_ERROR RT_BIT(5)
549/** Bit 16 - WP - Write Protect. */
550#define X86_CR0_WP RT_BIT(16)
551#define X86_CR0_WRITE_PROTECT RT_BIT(16)
552/** Bit 18 - AM - Alignment Mask. */
553#define X86_CR0_AM RT_BIT(18)
554#define X86_CR0_ALIGMENT_MASK RT_BIT(18)
555/** Bit 29 - NW - Not Write-though. */
556#define X86_CR0_NW RT_BIT(29)
557#define X86_CR0_NOT_WRITE_THROUGH RT_BIT(29)
558/** Bit 30 - WP - Cache Disable. */
559#define X86_CR0_CD RT_BIT(30)
560#define X86_CR0_CACHE_DISABLE RT_BIT(30)
561/** Bit 31 - PG - Paging. */
562#define X86_CR0_PG RT_BIT(31)
563#define X86_CR0_PAGING RT_BIT(31)
564/** @} */
565
566
567/** @name CR3
568 * @{ */
569/** Bit 3 - PWT - Page-level Writes Transparent. */
570#define X86_CR3_PWT RT_BIT(3)
571/** Bit 4 - PCD - Page-level Cache Disable. */
572#define X86_CR3_PCD RT_BIT(4)
573/** Bits 12-31 - - Page directory page number. */
574#define X86_CR3_PAGE_MASK (0xfffff000)
575/** Bits 5-31 - - PAE Page directory page number. */
576#define X86_CR3_PAE_PAGE_MASK (0xffffffe0)
577/** Bits 12-51 - - AMD64 Page directory page number. */
578#define X86_CR3_AMD64_PAGE_MASK UINT64_C(0x000ffffffffff000)
579/** @} */
580
581
582/** @name CR4
583 * @{ */
584/** Bit 0 - VME - Virtual-8086 Mode Extensions. */
585#define X86_CR4_VME RT_BIT(0)
586/** Bit 1 - PVI - Protected-Mode Virtual Interrupts. */
587#define X86_CR4_PVI RT_BIT(1)
588/** Bit 2 - TSD - Time Stamp Disable. */
589#define X86_CR4_TSD RT_BIT(2)
590/** Bit 3 - DE - Debugging Extensions. */
591#define X86_CR4_DE RT_BIT(3)
592/** Bit 4 - PSE - Page Size Extension. */
593#define X86_CR4_PSE RT_BIT(4)
594/** Bit 5 - PAE - Physical Address Extension. */
595#define X86_CR4_PAE RT_BIT(5)
596/** Bit 6 - MCE - Machine-Check Enable. */
597#define X86_CR4_MCE RT_BIT(6)
598/** Bit 7 - PGE - Page Global Enable. */
599#define X86_CR4_PGE RT_BIT(7)
600/** Bit 8 - PCE - Performance-Monitoring Counter Enable. */
601#define X86_CR4_PCE RT_BIT(8)
602/** Bit 9 - OSFSXR - Operating System Support for FXSAVE and FXRSTORE instruction. */
603#define X86_CR4_OSFSXR RT_BIT(9)
604/** Bit 10 - OSXMMEEXCPT - Operating System Support for Unmasked SIMD Floating-Point Exceptions. */
605#define X86_CR4_OSXMMEEXCPT RT_BIT(10)
606/** Bit 13 - VMXE - VMX mode is enabled. */
607#define X86_CR4_VMXE RT_BIT(13)
608/** @} */
609
610
611/** @name DR6
612 * @{ */
613/** Bit 0 - B0 - Breakpoint 0 condition detected. */
614#define X86_DR6_B0 RT_BIT(0)
615/** Bit 1 - B1 - Breakpoint 1 condition detected. */
616#define X86_DR6_B1 RT_BIT(1)
617/** Bit 2 - B2 - Breakpoint 2 condition detected. */
618#define X86_DR6_B2 RT_BIT(2)
619/** Bit 3 - B3 - Breakpoint 3 condition detected. */
620#define X86_DR6_B3 RT_BIT(3)
621/** Bit 13 - BD - Debug register access detected. Corresponds to the X86_DR7_GD bit. */
622#define X86_DR6_BD RT_BIT(13)
623/** Bit 14 - BS - Single step */
624#define X86_DR6_BS RT_BIT(14)
625/** Bit 15 - BT - Task switch. (TSS T bit.) */
626#define X86_DR6_BT RT_BIT(15)
627/** @} */
628
629
630/** @name DR7
631 * @{ */
632/** Bit 0 - L0 - Local breakpoint enable. Cleared on task switch. */
633#define X86_DR7_L0 RT_BIT(0)
634/** Bit 1 - G0 - Global breakpoint enable. Not cleared on task switch. */
635#define X86_DR7_G0 RT_BIT(1)
636/** Bit 2 - L1 - Local breakpoint enable. Cleared on task switch. */
637#define X86_DR7_L1 RT_BIT(2)
638/** Bit 3 - G1 - Global breakpoint enable. Not cleared on task switch. */
639#define X86_DR7_G1 RT_BIT(3)
640/** Bit 4 - L2 - Local breakpoint enable. Cleared on task switch. */
641#define X86_DR7_L2 RT_BIT(4)
642/** Bit 5 - G2 - Global breakpoint enable. Not cleared on task switch. */
643#define X86_DR7_G2 RT_BIT(5)
644/** Bit 6 - L3 - Local breakpoint enable. Cleared on task switch. */
645#define X86_DR7_L3 RT_BIT(6)
646/** Bit 7 - G3 - Global breakpoint enable. Not cleared on task switch. */
647#define X86_DR7_G3 RT_BIT(7)
648/** Bit 8 - LE - Local breakpoint exact. (Not supported (read ignored) by P6 and later.) */
649#define X86_DR7_LE RT_BIT(8)
650/** Bit 9 - GE - Local breakpoint exact. (Not supported (read ignored) by P6 and later.) */
651#define X86_DR7_GE RT_BIT(9)
652
653/** Bit 13 - GD - General detect enable. Enables emulators to get exceptions when
654 * any DR register is accessed. */
655#define X86_DR7_GD RT_BIT(13)
656/** Bit 16 & 17 - R/W0 - Read write field 0. Values X86_DR7_RW_*. */
657#define X86_DR7_RW0_MASK (3 << 16)
658/** Bit 18 & 19 - LEN0 - Length field 0. Values X86_DR7_LEN_*. */
659#define X86_DR7_LEN0_MASK (3 << 18)
660/** Bit 20 & 21 - R/W1 - Read write field 0. Values X86_DR7_RW_*. */
661#define X86_DR7_RW1_MASK (3 << 20)
662/** Bit 22 & 23 - LEN1 - Length field 0. Values X86_DR7_LEN_*. */
663#define X86_DR7_LEN1_MASK (3 << 22)
664/** Bit 24 & 25 - R/W2 - Read write field 0. Values X86_DR7_RW_*. */
665#define X86_DR7_RW2_MASK (3 << 24)
666/** Bit 26 & 27 - LEN2 - Length field 0. Values X86_DR7_LEN_*. */
667#define X86_DR7_LEN2_MASK (3 << 26)
668/** Bit 28 & 29 - R/W3 - Read write field 0. Values X86_DR7_RW_*. */
669#define X86_DR7_RW3_MASK (3 << 28)
670/** Bit 30 & 31 - LEN3 - Length field 0. Values X86_DR7_LEN_*. */
671#define X86_DR7_LEN3_MASK (3 << 30)
672
673/** Bits which must be 1s. */
674#define X86_DR7_MB1_MASK (RT_BIT(10))
675
676/** Calcs the L bit of Nth breakpoint.
677 * @param iBp The breakpoint number [0..3].
678 */
679#define X86_DR7_L(iBp) ( 1 << (iBp * 2) )
680
681/** Calcs the G bit of Nth breakpoint.
682 * @param iBp The breakpoint number [0..3].
683 */
684#define X86_DR7_G(iBp) ( 1 << (iBp * 2 + 1) )
685
686/** @name Read/Write values.
687 * @{ */
688/** Break on instruction fetch only. */
689#define X86_DR7_RW_EO 0
690/** Break on write only. */
691#define X86_DR7_RW_WO 1
692/** Break on I/O read/write. This is only defined if CR4.DE is set. */
693#define X86_DR7_RW_IO 2
694/** Break on read or write (but not instruction fetches). */
695#define X86_DR7_RW_RW 3
696/** @} */
697
698/** Shifts a X86_DR7_RW_* value to its right place.
699 * @param iBp The breakpoint number [0..3].
700 * @param fRw One of the X86_DR7_RW_* value.
701 */
702#define X86_DR7_RW(iBp, fRw) ( (fRw) << ((iBp) * 4 + 16) )
703
704/** @name Length values.
705 * @{ */
706#define X86_DR7_LEN_BYTE 0
707#define X86_DR7_LEN_WORD 1
708#define X86_DR7_LEN_QWORD 2 /**< AMD64 long mode only. */
709#define X86_DR7_LEN_DWORD 3
710/** @} */
711
712/** Shifts a X86_DR7_LEN_* value to its right place.
713 * @param iBp The breakpoint number [0..3].
714 * @param cb One of the X86_DR7_LEN_* values.
715 */
716#define X86_DR7_LEN(iBp, cb) ( (cb) << ((iBp) * 4 + 18) )
717
718/** Mask used to check if any breakpoints are enabled. */
719#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))
720
721/** @} */
722
723
724/** @name Machine Specific Registers
725 * @{
726 */
727
728/** Time Stamp Counter. */
729#define MSR_IA32_TSC 0x10
730
731#define MSR_IA32_PLATFORM_ID 0x17
732
733#ifndef MSR_IA32_APICBASE /* qemu cpu.h klugde */
734#define MSR_IA32_APICBASE 0x1b
735#endif
736
737/** CPU Feature control. */
738#define MSR_IA32_FEATURE_CONTROL 0x3A
739#define MSR_IA32_FEATURE_CONTROL_LOCK RT_BIT(0)
740#define MSR_IA32_FEATURE_CONTROL_VMXON RT_BIT(2)
741
742/** BIOS update trigger (microcode update). */
743#define MSR_IA32_BIOS_UPDT_TRIG 0x79
744
745/** BIOS update signature (microcode). */
746#define MSR_IA32_BIOS_SIGN_ID 0x8B
747
748/** MTRR Capabilities. */
749#define MSR_IA32_MTRR_CAP 0xFE
750
751
752#ifndef MSR_IA32_SYSENTER_CS /* qemu cpu.h klugde */
753/** SYSENTER_CS - the R0 CS, indirectly giving R0 SS, R3 CS and R3 DS.
754 * R0 SS == CS + 8
755 * R3 CS == CS + 16
756 * R3 SS == CS + 24
757 */
758#define MSR_IA32_SYSENTER_CS 0x174
759/** SYSENTER_ESP - the R0 ESP. */
760#define MSR_IA32_SYSENTER_ESP 0x175
761/** SYSENTER_EIP - the R0 EIP. */
762#define MSR_IA32_SYSENTER_EIP 0x176
763#endif
764
765/** Machine Check Global Capabilities Register. */
766#define MSR_IA32_MCP_CAP 0x179
767/** Machine Check Global Status Register. */
768#define MSR_IA32_MCP_STATUS 0x17A
769/** Machine Check Global Control Register. */
770#define MSR_IA32_MCP_CTRL 0x17B
771
772/* Page Attribute Table. */
773#define MSR_IA32_CR_PAT 0x277
774
775/** MTRR Default Range. */
776#define MSR_IA32_MTRR_DEF_TYPE 0x2FF
777
778#define MSR_IA32_MC0_CTL 0x400
779#define MSR_IA32_MC0_STATUS 0x401
780
781/** Basic VMX information. */
782#define MSR_IA32_VMX_BASIC_INFO 0x480
783/** Allowed settings for pin-based VM execution controls */
784#define MSR_IA32_VMX_PINBASED_CTLS 0x481
785/** Allowed settings for proc-based VM execution controls */
786#define MSR_IA32_VMX_PROCBASED_CTLS 0x482
787/** Allowed settings for the VMX exit controls. */
788#define MSR_IA32_VMX_EXIT_CTLS 0x483
789/** Allowed settings for the VMX entry controls. */
790#define MSR_IA32_VMX_ENTRY_CTLS 0x484
791/** Misc VMX info. */
792#define MSR_IA32_VMX_MISC 0x485
793/** Fixed cleared bits in CR0. */
794#define MSR_IA32_VMX_CR0_FIXED0 0x486
795/** Fixed set bits in CR0. */
796#define MSR_IA32_VMX_CR0_FIXED1 0x487
797/** Fixed cleared bits in CR4. */
798#define MSR_IA32_VMX_CR4_FIXED0 0x488
799/** Fixed set bits in CR4. */
800#define MSR_IA32_VMX_CR4_FIXED1 0x489
801/** Information for enumerating fields in the VMCS. */
802#define MSR_IA32_VMX_VMCS_ENUM 0x48A
803/** Allowed settings for secondary proc-based VM execution controls */
804#define MSR_IA32_VMX_PROCBASED_CTLS2 0x48B
805/** EPT capabilities. */
806#define MSR_IA32_VMX_EPT_CAPS 0x48C
807
808/** K6 EFER - Extended Feature Enable Register. */
809#define MSR_K6_EFER 0xc0000080
810/** @todo document EFER */
811/** Bit 0 - SCE - System call extensions (SYSCALL / SYSRET). (R/W) */
812#define MSR_K6_EFER_SCE RT_BIT(0)
813/** Bit 8 - LME - Long mode enabled. (R/W) */
814#define MSR_K6_EFER_LME RT_BIT(8)
815/** Bit 10 - LMA - Long mode active. (R) */
816#define MSR_K6_EFER_LMA RT_BIT(10)
817/** Bit 11 - NXE - No-Execute Page Protection Enabled. (R/W) */
818#define MSR_K6_EFER_NXE RT_BIT(11)
819/** Bit 12 - SVME - Secure VM Extension Enabled. (R/W) */
820#define MSR_K6_EFER_SVME RT_BIT(12)
821/** Bit 13 - LMSLE - Long Mode Segment Limit Enable. (R/W?) */
822#define MSR_K6_EFER_LMSLE RT_BIT(13)
823/** Bit 14 - FFXSR - Fast FXSAVE / FXRSTOR (skip XMM*). (R/W) */
824#define MSR_K6_EFER_FFXSR RT_BIT(14)
825/** K6 STAR - SYSCALL/RET targets. */
826#define MSR_K6_STAR 0xc0000081
827/** Shift value for getting the SYSRET CS and SS value. */
828#define MSR_K6_STAR_SYSRET_CS_SS_SHIFT 48
829/** Shift value for getting the SYSCALL CS and SS value. */
830#define MSR_K6_STAR_SYSCALL_CS_SS_SHIFT 32
831/** Selector mask for use after shifting. */
832#define MSR_K6_STAR_SEL_MASK 0xffff
833/** The mask which give the SYSCALL EIP. */
834#define MSR_K6_STAR_SYSCALL_EIP_MASK 0xffffffff
835/** K6 WHCR - Write Handling Control Register. */
836#define MSR_K6_WHCR 0xc0000082
837/** K6 UWCCR - UC/WC Cacheability Control Register. */
838#define MSR_K6_UWCCR 0xc0000085
839/** K6 PSOR - Processor State Observability Register. */
840#define MSR_K6_PSOR 0xc0000087
841/** K6 PFIR - Page Flush/Invalidate Register. */
842#define MSR_K6_PFIR 0xc0000088
843
844#define MSR_K7_EVNTSEL0 0xc0010000
845#define MSR_K7_EVNTSEL1 0xc0010001
846#define MSR_K7_EVNTSEL2 0xc0010002
847#define MSR_K7_EVNTSEL3 0xc0010003
848#define MSR_K7_PERFCTR0 0xc0010004
849#define MSR_K7_PERFCTR1 0xc0010005
850#define MSR_K7_PERFCTR2 0xc0010006
851#define MSR_K7_PERFCTR3 0xc0010007
852
853/** K8 LSTAR - Long mode SYSCALL target (RIP). */
854#define MSR_K8_LSTAR 0xc0000082
855/** K8 CSTAR - Compatibility mode SYSCALL target (RIP). */
856#define MSR_K8_CSTAR 0xc0000083
857/** K8 SF_MASK - SYSCALL flag mask. (aka SFMASK) */
858#define MSR_K8_SF_MASK 0xc0000084
859/** K8 FS.base - The 64-bit base FS register. */
860#define MSR_K8_FS_BASE 0xc0000100
861/** K8 GS.base - The 64-bit base GS register. */
862#define MSR_K8_GS_BASE 0xc0000101
863/** K8 KernelGSbase - Used with SWAPGS. */
864#define MSR_K8_KERNEL_GS_BASE 0xc0000102
865#define MSR_K8_TSC_AUX 0xc0000103
866#define MSR_K8_SYSCFG 0xc0010010
867#define MSR_K8_HWCR 0xc0010015
868#define MSR_K8_IORRBASE0 0xc0010016
869#define MSR_K8_IORRMASK0 0xc0010017
870#define MSR_K8_IORRBASE1 0xc0010018
871#define MSR_K8_IORRMASK1 0xc0010019
872#define MSR_K8_TOP_MEM1 0xc001001a
873#define MSR_K8_TOP_MEM2 0xc001001d
874#define MSR_K8_VM_CR 0xc0010114
875#define MSR_K8_VM_CR_SVM_DISABLE RT_BIT(4)
876
877#define MSR_K8_IGNNE 0xc0010115
878#define MSR_K8_SMM_CTL 0xc0010116
879/** SVM - VM_HSAVE_PA - Physical address for saving and restoring
880 * host state during world switch.
881 */
882#define MSR_K8_VM_HSAVE_PA 0xc0010117
883
884/** @} */
885
886
887/** @name Page Table / Directory / Directory Pointers / L4.
888 * @{
889 */
890
891/** Page table/directory entry as an unsigned integer. */
892typedef uint32_t X86PGUINT;
893/** Pointer to a page table/directory table entry as an unsigned integer. */
894typedef X86PGUINT *PX86PGUINT;
895
896/** Number of entries in a 32-bit PT/PD. */
897#define X86_PG_ENTRIES 1024
898
899
900/** PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
901typedef uint64_t X86PGPAEUINT;
902/** Pointer to a PAE page table/page directory/pdpt/l4/l5 entry as an unsigned integer. */
903typedef X86PGPAEUINT *PX86PGPAEUINT;
904
905/** Number of entries in a PAE PT/PD. */
906#define X86_PG_PAE_ENTRIES 512
907/** Number of entries in a PAE PDPT. */
908#define X86_PG_PAE_PDPE_ENTRIES 4
909
910/** Number of entries in an AMD64 PT/PD/PDPT/L4/L5. */
911#define X86_PG_AMD64_ENTRIES X86_PG_PAE_ENTRIES
912/** Number of entries in an AMD64 PDPT.
913 * Just for complementing X86_PG_PAE_PDPE_ENTRIES, using X86_PG_AMD64_ENTRIES for this is fine too. */
914#define X86_PG_AMD64_PDPE_ENTRIES X86_PG_AMD64_ENTRIES
915
916/** The size of a 4KB page. */
917#define X86_PAGE_4K_SIZE _4K
918/** The page shift of a 4KB page. */
919#define X86_PAGE_4K_SHIFT 12
920/** The 4KB page offset mask. */
921#define X86_PAGE_4K_OFFSET_MASK 0xfff
922/** The 4KB page base mask for virtual addresses. */
923#define X86_PAGE_4K_BASE_MASK 0xfffffffffffff000ULL
924/** The 4KB page base mask for virtual addresses - 32bit version. */
925#define X86_PAGE_4K_BASE_MASK_32 0xfffff000U
926
927/** The size of a 2MB page. */
928#define X86_PAGE_2M_SIZE _2M
929/** The page shift of a 2MB page. */
930#define X86_PAGE_2M_SHIFT 21
931/** The 2MB page offset mask. */
932#define X86_PAGE_2M_OFFSET_MASK 0x001fffff
933/** The 2MB page base mask for virtual addresses. */
934#define X86_PAGE_2M_BASE_MASK 0xffffffffffe00000ULL
935/** The 2MB page base mask for virtual addresses - 32bit version. */
936#define X86_PAGE_2M_BASE_MASK_32 0xffe00000U
937
938/** The size of a 4MB page. */
939#define X86_PAGE_4M_SIZE _4M
940/** The page shift of a 4MB page. */
941#define X86_PAGE_4M_SHIFT 22
942/** The 4MB page offset mask. */
943#define X86_PAGE_4M_OFFSET_MASK 0x003fffff
944/** The 4MB page base mask for virtual addresses. */
945#define X86_PAGE_4M_BASE_MASK 0xffffffffffc00000ULL
946/** The 4MB page base mask for virtual addresses - 32bit version. */
947#define X86_PAGE_4M_BASE_MASK_32 0xffc00000U
948
949
950
951/** @name Page Table Entry
952 * @{
953 */
954/** Bit 0 - P - Present bit. */
955#define X86_PTE_P RT_BIT(0)
956/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
957#define X86_PTE_RW RT_BIT(1)
958/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
959#define X86_PTE_US RT_BIT(2)
960/** Bit 3 - PWT - Page level write thru bit. */
961#define X86_PTE_PWT RT_BIT(3)
962/** Bit 4 - PCD - Page level cache disable bit. */
963#define X86_PTE_PCD RT_BIT(4)
964/** Bit 5 - A - Access bit. */
965#define X86_PTE_A RT_BIT(5)
966/** Bit 6 - D - Dirty bit. */
967#define X86_PTE_D RT_BIT(6)
968/** Bit 7 - PAT - Page Attribute Table index bit. Reserved and 0 if not supported. */
969#define X86_PTE_PAT RT_BIT(7)
970/** Bit 8 - G - Global flag. */
971#define X86_PTE_G RT_BIT(8)
972/** Bits 9-11 - - Available for use to system software. */
973#define X86_PTE_AVL_MASK (RT_BIT(9) | RT_BIT(10) | RT_BIT(11))
974/** Bits 12-31 - - Physical Page number of the next level. */
975#define X86_PTE_PG_MASK ( 0xfffff000 )
976
977/** Bits 12-51 - - PAE - Physical Page number of the next level. */
978#if 1 /* we're using this internally and have to mask of the top 16-bit. */
979#define X86_PTE_PAE_PG_MASK ( 0x0000fffffffff000ULL )
980/** @todo Get rid of the above hack; makes code unreadable. */
981#define X86_PTE_PAE_PG_MASK_FULL ( 0x000ffffffffff000ULL )
982#else
983#define X86_PTE_PAE_PG_MASK ( 0x000ffffffffff000ULL )
984#endif
985/** Bits 63 - NX - PAE - No execution flag. */
986#define X86_PTE_PAE_NX RT_BIT_64(63)
987
988/**
989 * Page table entry.
990 */
991typedef struct X86PTEBITS
992{
993 /** Flags whether(=1) or not the page is present. */
994 unsigned u1Present : 1;
995 /** Read(=0) / Write(=1) flag. */
996 unsigned u1Write : 1;
997 /** User(=1) / Supervisor (=0) flag. */
998 unsigned u1User : 1;
999 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1000 unsigned u1WriteThru : 1;
1001 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1002 unsigned u1CacheDisable : 1;
1003 /** Accessed flag.
1004 * Indicates that the page have been read or written to. */
1005 unsigned u1Accessed : 1;
1006 /** Dirty flag.
1007 * Indicates that the page have been written to. */
1008 unsigned u1Dirty : 1;
1009 /** Reserved / If PAT enabled, bit 2 of the index. */
1010 unsigned u1PAT : 1;
1011 /** Global flag. (Ignored in all but final level.) */
1012 unsigned u1Global : 1;
1013 /** Available for use to system software. */
1014 unsigned u3Available : 3;
1015 /** Physical Page number of the next level. */
1016 unsigned u20PageNo : 20;
1017} X86PTEBITS;
1018/** Pointer to a page table entry. */
1019typedef X86PTEBITS *PX86PTEBITS;
1020/** Pointer to a const page table entry. */
1021typedef const X86PTEBITS *PCX86PTEBITS;
1022
1023/**
1024 * Page table entry.
1025 */
1026typedef union X86PTE
1027{
1028 /** Bit field view. */
1029 X86PTEBITS n;
1030 /** Unsigned integer view */
1031 X86PGUINT u;
1032 /** 32-bit view. */
1033 uint32_t au32[1];
1034 /** 16-bit view. */
1035 uint16_t au16[2];
1036 /** 8-bit view. */
1037 uint8_t au8[4];
1038} X86PTE;
1039/** Pointer to a page table entry. */
1040typedef X86PTE *PX86PTE;
1041/** Pointer to a const page table entry. */
1042typedef const X86PTE *PCX86PTE;
1043
1044
1045/**
1046 * PAE page table entry.
1047 */
1048typedef struct X86PTEPAEBITS
1049{
1050 /** Flags whether(=1) or not the page is present. */
1051 uint32_t u1Present : 1;
1052 /** Read(=0) / Write(=1) flag. */
1053 uint32_t u1Write : 1;
1054 /** User(=1) / Supervisor(=0) flag. */
1055 uint32_t u1User : 1;
1056 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1057 uint32_t u1WriteThru : 1;
1058 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1059 uint32_t u1CacheDisable : 1;
1060 /** Accessed flag.
1061 * Indicates that the page have been read or written to. */
1062 uint32_t u1Accessed : 1;
1063 /** Dirty flag.
1064 * Indicates that the page have been written to. */
1065 uint32_t u1Dirty : 1;
1066 /** Reserved / If PAT enabled, bit 2 of the index. */
1067 uint32_t u1PAT : 1;
1068 /** Global flag. (Ignored in all but final level.) */
1069 uint32_t u1Global : 1;
1070 /** Available for use to system software. */
1071 uint32_t u3Available : 3;
1072 /** Physical Page number of the next level - Low Part. Don't use this. */
1073 uint32_t u20PageNoLow : 20;
1074 /** Physical Page number of the next level - High Part. Don't use this. */
1075 uint32_t u20PageNoHigh : 20;
1076 /** MBZ bits */
1077 uint32_t u11Reserved : 11;
1078 /** No Execute flag. */
1079 uint32_t u1NoExecute : 1;
1080} X86PTEPAEBITS;
1081/** Pointer to a page table entry. */
1082typedef X86PTEPAEBITS *PX86PTEPAEBITS;
1083/** Pointer to a page table entry. */
1084typedef const X86PTEPAEBITS *PCX86PTEPAEBITS;
1085
1086/**
1087 * PAE Page table entry.
1088 */
1089typedef union X86PTEPAE
1090{
1091 /** Bit field view. */
1092 X86PTEPAEBITS n;
1093 /** Unsigned integer view */
1094 X86PGPAEUINT u;
1095 /** 32-bit view. */
1096 uint32_t au32[2];
1097 /** 16-bit view. */
1098 uint16_t au16[4];
1099 /** 8-bit view. */
1100 uint8_t au8[8];
1101} X86PTEPAE;
1102/** Pointer to a PAE page table entry. */
1103typedef X86PTEPAE *PX86PTEPAE;
1104/** Pointer to a const PAE page table entry. */
1105typedef const X86PTEPAE *PCX86PTEPAE;
1106/** @} */
1107
1108/**
1109 * Page table.
1110 */
1111typedef struct X86PT
1112{
1113 /** PTE Array. */
1114 X86PTE a[X86_PG_ENTRIES];
1115} X86PT;
1116/** Pointer to a page table. */
1117typedef X86PT *PX86PT;
1118/** Pointer to a const page table. */
1119typedef const X86PT *PCX86PT;
1120
1121/** The page shift to get the PT index. */
1122#define X86_PT_SHIFT 12
1123/** The PT index mask (apply to a shifted page address). */
1124#define X86_PT_MASK 0x3ff
1125
1126
1127/**
1128 * Page directory.
1129 */
1130typedef struct X86PTPAE
1131{
1132 /** PTE Array. */
1133 X86PTEPAE a[X86_PG_PAE_ENTRIES];
1134} X86PTPAE;
1135/** Pointer to a page table. */
1136typedef X86PTPAE *PX86PTPAE;
1137/** Pointer to a const page table. */
1138typedef const X86PTPAE *PCX86PTPAE;
1139
1140/** The page shift to get the PA PTE index. */
1141#define X86_PT_PAE_SHIFT 12
1142/** The PAE PT index mask (apply to a shifted page address). */
1143#define X86_PT_PAE_MASK 0x1ff
1144
1145
1146/** @name 4KB Page Directory Entry
1147 * @{
1148 */
1149/** Bit 0 - P - Present bit. */
1150#define X86_PDE_P RT_BIT(0)
1151/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1152#define X86_PDE_RW RT_BIT(1)
1153/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1154#define X86_PDE_US RT_BIT(2)
1155/** Bit 3 - PWT - Page level write thru bit. */
1156#define X86_PDE_PWT RT_BIT(3)
1157/** Bit 4 - PCD - Page level cache disable bit. */
1158#define X86_PDE_PCD RT_BIT(4)
1159/** Bit 5 - A - Access bit. */
1160#define X86_PDE_A RT_BIT(5)
1161/** Bit 7 - PS - Page size attribute.
1162 * Clear mean 4KB pages, set means large pages (2/4MB). */
1163#define X86_PDE_PS RT_BIT(7)
1164/** Bits 9-11 - - Available for use to system software. */
1165#define X86_PDE_AVL_MASK (RT_BIT(9) | RT_BIT(10) | RT_BIT(11))
1166/** Bits 12-31 - - Physical Page number of the next level. */
1167#define X86_PDE_PG_MASK ( 0xfffff000 )
1168
1169/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1170#if 1 /* we're using this internally and have to mask of the top 16-bit. */
1171/* Note: This is kind of dangerous if the guest uses these bits (legally or illegally);
1172 * we partly or that part into shadow page table entries. Will be corrected
1173 * soon.
1174 */
1175#define X86_PDE_PAE_PG_MASK ( 0x0000fffffffff000ULL )
1176#define X86_PDE_PAE_PG_MASK_FULL ( 0x000ffffffffff000ULL )
1177#else
1178#define X86_PDE_PAE_PG_MASK ( 0x000ffffffffff000ULL )
1179#endif
1180/** Bits 63 - NX - PAE - No execution flag. */
1181#define X86_PDE_PAE_NX RT_BIT_64(63)
1182
1183/**
1184 * Page directory entry.
1185 */
1186typedef struct X86PDEBITS
1187{
1188 /** Flags whether(=1) or not the page is present. */
1189 unsigned u1Present : 1;
1190 /** Read(=0) / Write(=1) flag. */
1191 unsigned u1Write : 1;
1192 /** User(=1) / Supervisor (=0) flag. */
1193 unsigned u1User : 1;
1194 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1195 unsigned u1WriteThru : 1;
1196 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1197 unsigned u1CacheDisable : 1;
1198 /** Accessed flag.
1199 * Indicates that the page have been read or written to. */
1200 unsigned u1Accessed : 1;
1201 /** Reserved / Ignored (dirty bit). */
1202 unsigned u1Reserved0 : 1;
1203 /** Size bit if PSE is enabled - in any event it's 0. */
1204 unsigned u1Size : 1;
1205 /** Reserved / Ignored (global bit). */
1206 unsigned u1Reserved1 : 1;
1207 /** Available for use to system software. */
1208 unsigned u3Available : 3;
1209 /** Physical Page number of the next level. */
1210 unsigned u20PageNo : 20;
1211} X86PDEBITS;
1212/** Pointer to a page directory entry. */
1213typedef X86PDEBITS *PX86PDEBITS;
1214/** Pointer to a const page directory entry. */
1215typedef const X86PDEBITS *PCX86PDEBITS;
1216
1217
1218/**
1219 * PAE page directory entry.
1220 */
1221typedef struct X86PDEPAEBITS
1222{
1223 /** Flags whether(=1) or not the page is present. */
1224 uint32_t u1Present : 1;
1225 /** Read(=0) / Write(=1) flag. */
1226 uint32_t u1Write : 1;
1227 /** User(=1) / Supervisor (=0) flag. */
1228 uint32_t u1User : 1;
1229 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1230 uint32_t u1WriteThru : 1;
1231 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1232 uint32_t u1CacheDisable : 1;
1233 /** Accessed flag.
1234 * Indicates that the page have been read or written to. */
1235 uint32_t u1Accessed : 1;
1236 /** Reserved / Ignored (dirty bit). */
1237 uint32_t u1Reserved0 : 1;
1238 /** Size bit if PSE is enabled - in any event it's 0. */
1239 uint32_t u1Size : 1;
1240 /** Reserved / Ignored (global bit). / */
1241 uint32_t u1Reserved1 : 1;
1242 /** Available for use to system software. */
1243 uint32_t u3Available : 3;
1244 /** Physical Page number of the next level - Low Part. Don't use! */
1245 uint32_t u20PageNoLow : 20;
1246 /** Physical Page number of the next level - High Part. Don't use! */
1247 uint32_t u20PageNoHigh : 20;
1248 /** MBZ bits */
1249 uint32_t u11Reserved : 11;
1250 /** No Execute flag. */
1251 uint32_t u1NoExecute : 1;
1252} X86PDEPAEBITS;
1253/** Pointer to a page directory entry. */
1254typedef X86PDEPAEBITS *PX86PDEPAEBITS;
1255/** Pointer to a const page directory entry. */
1256typedef const X86PDEPAEBITS *PCX86PDEPAEBITS;
1257
1258/** @} */
1259
1260
1261/** @name 2/4MB Page Directory Entry
1262 * @{
1263 */
1264/** Bit 0 - P - Present bit. */
1265#define X86_PDE4M_P RT_BIT(0)
1266/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1267#define X86_PDE4M_RW RT_BIT(1)
1268/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1269#define X86_PDE4M_US RT_BIT(2)
1270/** Bit 3 - PWT - Page level write thru bit. */
1271#define X86_PDE4M_PWT RT_BIT(3)
1272/** Bit 4 - PCD - Page level cache disable bit. */
1273#define X86_PDE4M_PCD RT_BIT(4)
1274/** Bit 5 - A - Access bit. */
1275#define X86_PDE4M_A RT_BIT(5)
1276/** Bit 6 - D - Dirty bit. */
1277#define X86_PDE4M_D RT_BIT(6)
1278/** Bit 7 - PS - Page size attribute. Clear mean 4KB pages, set means large pages (2/4MB). */
1279#define X86_PDE4M_PS RT_BIT(7)
1280/** Bit 8 - G - Global flag. */
1281#define X86_PDE4M_G RT_BIT(8)
1282/** Bits 9-11 - AVL - Available for use to system software. */
1283#define X86_PDE4M_AVL (RT_BIT(9) | RT_BIT(10) | RT_BIT(11))
1284/** Bit 12 - PAT - Page Attribute Table index bit. Reserved and 0 if not supported. */
1285#define X86_PDE4M_PAT RT_BIT(12)
1286/** Shift to get from X86_PTE_PAT to X86_PDE4M_PAT. */
1287#define X86_PDE4M_PAT_SHIFT (12 - 7)
1288/** Bits 22-31 - - Physical Page number. */
1289#define X86_PDE4M_PG_MASK ( 0xffc00000 )
1290/** Bits 13-20 - - Physical Page number high part (32-39 bits). AMD64 hack. */
1291#define X86_PDE4M_PG_HIGH_MASK ( 0x001fe000 )
1292/** The number of bits to the high part of the page number. */
1293#define X86_PDE4M_PG_HIGH_SHIFT 19
1294
1295/** Bits 21-51 - - PAE & AMD64 - Physical Page number.
1296 * (Bits 40-51 (long mode) & bits 36-51 (pae legacy) are reserved according to the Intel docs; AMD allows for more.) */
1297#define X86_PDE2M_PAE_PG_MASK ( 0x000fffffffe00000ULL )
1298/** Bits 63 - NX - PAE & AMD64 - No execution flag. */
1299#define X86_PDE2M_PAE_NX X86_PDE2M_PAE_NX
1300
1301/**
1302 * 4MB page directory entry.
1303 */
1304typedef struct X86PDE4MBITS
1305{
1306 /** Flags whether(=1) or not the page is present. */
1307 unsigned u1Present : 1;
1308 /** Read(=0) / Write(=1) flag. */
1309 unsigned u1Write : 1;
1310 /** User(=1) / Supervisor (=0) flag. */
1311 unsigned u1User : 1;
1312 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1313 unsigned u1WriteThru : 1;
1314 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1315 unsigned u1CacheDisable : 1;
1316 /** Accessed flag.
1317 * Indicates that the page have been read or written to. */
1318 unsigned u1Accessed : 1;
1319 /** Dirty flag.
1320 * Indicates that the page have been written to. */
1321 unsigned u1Dirty : 1;
1322 /** Page size flag - always 1 for 4MB entries. */
1323 unsigned u1Size : 1;
1324 /** Global flag. */
1325 unsigned u1Global : 1;
1326 /** Available for use to system software. */
1327 unsigned u3Available : 3;
1328 /** Reserved / If PAT enabled, bit 2 of the index. */
1329 unsigned u1PAT : 1;
1330 /** Bits 32-39 of the page number on AMD64.
1331 * This AMD64 hack allows accessing 40bits of physical memory without PAE. */
1332 unsigned u8PageNoHigh : 8;
1333 /** Reserved. */
1334 unsigned u1Reserved : 1;
1335 /** Physical Page number of the page. */
1336 unsigned u10PageNo : 10;
1337} X86PDE4MBITS;
1338/** Pointer to a page table entry. */
1339typedef X86PDE4MBITS *PX86PDE4MBITS;
1340/** Pointer to a const page table entry. */
1341typedef const X86PDE4MBITS *PCX86PDE4MBITS;
1342
1343
1344/**
1345 * 2MB PAE page directory entry.
1346 */
1347typedef struct X86PDE2MPAEBITS
1348{
1349 /** Flags whether(=1) or not the page is present. */
1350 uint32_t u1Present : 1;
1351 /** Read(=0) / Write(=1) flag. */
1352 uint32_t u1Write : 1;
1353 /** User(=1) / Supervisor(=0) flag. */
1354 uint32_t u1User : 1;
1355 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1356 uint32_t u1WriteThru : 1;
1357 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1358 uint32_t u1CacheDisable : 1;
1359 /** Accessed flag.
1360 * Indicates that the page have been read or written to. */
1361 uint32_t u1Accessed : 1;
1362 /** Dirty flag.
1363 * Indicates that the page have been written to. */
1364 uint32_t u1Dirty : 1;
1365 /** Page size flag - always 1 for 2MB entries. */
1366 uint32_t u1Size : 1;
1367 /** Global flag. */
1368 uint32_t u1Global : 1;
1369 /** Available for use to system software. */
1370 uint32_t u3Available : 3;
1371 /** Reserved / If PAT enabled, bit 2 of the index. */
1372 uint32_t u1PAT : 1;
1373 /** Reserved. */
1374 uint32_t u9Reserved : 9;
1375 /** Physical Page number of the next level - Low part. Don't use! */
1376 uint32_t u10PageNoLow : 10;
1377 /** Physical Page number of the next level - High part. Don't use! */
1378 uint32_t u20PageNoHigh : 20;
1379 /** MBZ bits */
1380 uint32_t u11Reserved : 11;
1381 /** No Execute flag. */
1382 uint32_t u1NoExecute : 1;
1383} X86PDE2MPAEBITS;
1384/** Pointer to a 4MB PAE page table entry. */
1385typedef X86PDE2MPAEBITS *PX86PDE2MPAEBITS;
1386/** Pointer to a 4MB PAE page table entry. */
1387typedef const X86PDE2MPAEBITS *PCX86PDE2MPAEBITS;
1388
1389/** @} */
1390
1391/**
1392 * Page directory entry.
1393 */
1394typedef union X86PDE
1395{
1396 /** Normal view. */
1397 X86PDEBITS n;
1398 /** 4MB view (big). */
1399 X86PDE4MBITS b;
1400 /** Unsigned integer view. */
1401 X86PGUINT u;
1402 /** 8 bit unsigned integer view. */
1403 uint8_t au8[4];
1404 /** 16 bit unsigned integer view. */
1405 uint16_t au16[2];
1406 /** 32 bit unsigned integer view. */
1407 uint32_t au32[1];
1408} X86PDE;
1409/** Pointer to a page directory entry. */
1410typedef X86PDE *PX86PDE;
1411/** Pointer to a const page directory entry. */
1412typedef const X86PDE *PCX86PDE;
1413
1414/**
1415 * PAE page directory entry.
1416 */
1417typedef union X86PDEPAE
1418{
1419 /** Normal view. */
1420 X86PDEPAEBITS n;
1421 /** 2MB page view (big). */
1422 X86PDE2MPAEBITS b;
1423 /** Unsigned integer view. */
1424 X86PGPAEUINT u;
1425 /** 8 bit unsigned integer view. */
1426 uint8_t au8[8];
1427 /** 16 bit unsigned integer view. */
1428 uint16_t au16[4];
1429 /** 32 bit unsigned integer view. */
1430 uint32_t au32[2];
1431} X86PDEPAE;
1432/** Pointer to a page directory entry. */
1433typedef X86PDEPAE *PX86PDEPAE;
1434/** Pointer to a const page directory entry. */
1435typedef const X86PDEPAE *PCX86PDEPAE;
1436
1437/**
1438 * Page directory.
1439 */
1440typedef struct X86PD
1441{
1442 /** PDE Array. */
1443 X86PDE a[X86_PG_ENTRIES];
1444} X86PD;
1445/** Pointer to a page directory. */
1446typedef X86PD *PX86PD;
1447/** Pointer to a const page directory. */
1448typedef const X86PD *PCX86PD;
1449
1450/** The page shift to get the PD index. */
1451#define X86_PD_SHIFT 22
1452/** The PD index mask (apply to a shifted page address). */
1453#define X86_PD_MASK 0x3ff
1454
1455
1456/**
1457 * PAE page directory.
1458 */
1459typedef struct X86PDPAE
1460{
1461 /** PDE Array. */
1462 X86PDEPAE a[X86_PG_PAE_ENTRIES];
1463} X86PDPAE;
1464/** Pointer to a PAE page directory. */
1465typedef X86PDPAE *PX86PDPAE;
1466/** Pointer to a const PAE page directory. */
1467typedef const X86PDPAE *PCX86PDPAE;
1468
1469/** The page shift to get the PAE PD index. */
1470#define X86_PD_PAE_SHIFT 21
1471/** The PAE PD index mask (apply to a shifted page address). */
1472#define X86_PD_PAE_MASK 0x1ff
1473
1474
1475/** @name Page Directory Pointer Table Entry (PAE)
1476 * @{
1477 */
1478/** Bit 0 - P - Present bit. */
1479#define X86_PDPE_P RT_BIT(0)
1480/** Bit 1 - R/W - Read (clear) / Write (set) bit. Long Mode only. */
1481#define X86_PDPE_RW RT_BIT(1)
1482/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. Long Mode only. */
1483#define X86_PDPE_US RT_BIT(2)
1484/** Bit 3 - PWT - Page level write thru bit. */
1485#define X86_PDPE_PWT RT_BIT(3)
1486/** Bit 4 - PCD - Page level cache disable bit. */
1487#define X86_PDPE_PCD RT_BIT(4)
1488/** Bit 5 - A - Access bit. Long Mode only. */
1489#define X86_PDPE_A RT_BIT(5)
1490/** Bits 9-11 - - Available for use to system software. */
1491#define X86_PDPE_AVL_MASK (RT_BIT(9) | RT_BIT(10) | RT_BIT(11))
1492/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1493#if 1 /* we're using this internally and have to mask of the top 16-bit. */
1494#define X86_PDPE_PG_MASK ( 0x0000fffffffff000ULL )
1495/** @todo Get rid of the above hack; makes code unreadable. */
1496#define X86_PDPE_PG_MASK_FULL ( 0x000ffffffffff000ULL )
1497#else
1498#define X86_PDPE_PG_MASK ( 0x000ffffffffff000ULL )
1499#endif
1500/** Bits 63 - NX - PAE - No execution flag. Long Mode only. */
1501#define X86_PDPE_NX RT_BIT_64(63)
1502
1503/**
1504 * Page directory pointer table entry.
1505 */
1506typedef struct X86PDPEBITS
1507{
1508 /** Flags whether(=1) or not the page is present. */
1509 uint32_t u1Present : 1;
1510 /** Chunk of reserved bits. */
1511 uint32_t u2Reserved : 2;
1512 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1513 uint32_t u1WriteThru : 1;
1514 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1515 uint32_t u1CacheDisable : 1;
1516 /** Chunk of reserved bits. */
1517 uint32_t u4Reserved : 4;
1518 /** Available for use to system software. */
1519 uint32_t u3Available : 3;
1520 /** Physical Page number of the next level - Low Part. Don't use! */
1521 uint32_t u20PageNoLow : 20;
1522 /** Physical Page number of the next level - High Part. Don't use! */
1523 uint32_t u20PageNoHigh : 20;
1524 /** MBZ bits */
1525 uint32_t u12Reserved : 12;
1526} X86PDPEBITS;
1527/** Pointer to a page directory pointer table entry. */
1528typedef X86PDPEBITS *PX86PTPEBITS;
1529/** Pointer to a const page directory pointer table entry. */
1530typedef const X86PDPEBITS *PCX86PTPEBITS;
1531
1532/**
1533 * Page directory pointer table entry. AMD64 version
1534 */
1535typedef struct X86PDPEAMD64BITS
1536{
1537 /** Flags whether(=1) or not the page is present. */
1538 uint32_t u1Present : 1;
1539 /** Read(=0) / Write(=1) flag. */
1540 uint32_t u1Write : 1;
1541 /** User(=1) / Supervisor (=0) flag. */
1542 uint32_t u1User : 1;
1543 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1544 uint32_t u1WriteThru : 1;
1545 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1546 uint32_t u1CacheDisable : 1;
1547 /** Accessed flag.
1548 * Indicates that the page have been read or written to. */
1549 uint32_t u1Accessed : 1;
1550 /** Chunk of reserved bits. */
1551 uint32_t u3Reserved : 3;
1552 /** Available for use to system software. */
1553 uint32_t u3Available : 3;
1554 /** Physical Page number of the next level - Low Part. Don't use! */
1555 uint32_t u20PageNoLow : 20;
1556 /** Physical Page number of the next level - High Part. Don't use! */
1557 uint32_t u20PageNoHigh : 20;
1558 /** MBZ bits */
1559 uint32_t u11Reserved : 11;
1560 /** No Execute flag. */
1561 uint32_t u1NoExecute : 1;
1562} X86PDPEAMD64BITS;
1563/** Pointer to a page directory pointer table entry. */
1564typedef X86PDPEAMD64BITS *PX86PDPEAMD64BITS;
1565/** Pointer to a const page directory pointer table entry. */
1566typedef const X86PDPEBITS *PCX86PDPEAMD64BITS;
1567
1568/**
1569 * Page directory pointer table entry.
1570 */
1571typedef union X86PDPE
1572{
1573 /** Normal view. */
1574 X86PDPEBITS n;
1575 /** AMD64 view. */
1576 X86PDPEAMD64BITS lm;
1577 /** Unsigned integer view. */
1578 X86PGPAEUINT u;
1579 /** 8 bit unsigned integer view. */
1580 uint8_t au8[8];
1581 /** 16 bit unsigned integer view. */
1582 uint16_t au16[4];
1583 /** 32 bit unsigned integer view. */
1584 uint32_t au32[2];
1585} X86PDPE;
1586/** Pointer to a page directory pointer table entry. */
1587typedef X86PDPE *PX86PDPE;
1588/** Pointer to a const page directory pointer table entry. */
1589typedef const X86PDPE *PCX86PDPE;
1590
1591
1592/**
1593 * Page directory pointer table.
1594 */
1595typedef struct X86PDPT
1596{
1597 /** PDE Array. */
1598 X86PDPE a[X86_PG_AMD64_PDPE_ENTRIES];
1599} X86PDPT;
1600/** Pointer to a page directory pointer table. */
1601typedef X86PDPT *PX86PDPT;
1602/** Pointer to a const page directory pointer table. */
1603typedef const X86PDPT *PCX86PDPT;
1604
1605/** The page shift to get the PDPT index. */
1606#define X86_PDPT_SHIFT 30
1607/** The PDPT index mask (apply to a shifted page address). (32 bits PAE) */
1608#define X86_PDPT_MASK_PAE 0x3
1609/** The PDPT index mask (apply to a shifted page address). (64 bits PAE)*/
1610#define X86_PDPT_MASK_AMD64 0x1ff
1611
1612/** @} */
1613
1614
1615/** @name Page Map Level-4 Entry (Long Mode PAE)
1616 * @{
1617 */
1618/** Bit 0 - P - Present bit. */
1619#define X86_PML4E_P RT_BIT(0)
1620/** Bit 1 - R/W - Read (clear) / Write (set) bit. */
1621#define X86_PML4E_RW RT_BIT(1)
1622/** Bit 2 - U/S - User (set) / Supervisor (clear) bit. */
1623#define X86_PML4E_US RT_BIT(2)
1624/** Bit 3 - PWT - Page level write thru bit. */
1625#define X86_PML4E_PWT RT_BIT(3)
1626/** Bit 4 - PCD - Page level cache disable bit. */
1627#define X86_PML4E_PCD RT_BIT(4)
1628/** Bit 5 - A - Access bit. */
1629#define X86_PML4E_A RT_BIT(5)
1630/** Bits 9-11 - - Available for use to system software. */
1631#define X86_PML4E_AVL_MASK (RT_BIT(9) | RT_BIT(10) | RT_BIT(11))
1632/** Bits 12-51 - - PAE - Physical Page number of the next level. */
1633#if 1 /* we're using this internally and have to mask of the top 16-bit. */
1634#define X86_PML4E_PG_MASK ( 0x0000fffffffff000ULL )
1635#define X86_PML4E_PG_MASK_FULL ( 0x000ffffffffff000ULL )
1636#else
1637#define X86_PML4E_PG_MASK ( 0x000ffffffffff000ULL )
1638#endif
1639/** Bits 63 - NX - PAE - No execution flag. */
1640#define X86_PML4E_NX RT_BIT_64(63)
1641
1642/**
1643 * Page Map Level-4 Entry
1644 */
1645typedef struct X86PML4EBITS
1646{
1647 /** Flags whether(=1) or not the page is present. */
1648 uint32_t u1Present : 1;
1649 /** Read(=0) / Write(=1) flag. */
1650 uint32_t u1Write : 1;
1651 /** User(=1) / Supervisor (=0) flag. */
1652 uint32_t u1User : 1;
1653 /** Write Thru flag. If PAT enabled, bit 0 of the index. */
1654 uint32_t u1WriteThru : 1;
1655 /** Cache disabled flag. If PAT enabled, bit 1 of the index. */
1656 uint32_t u1CacheDisable : 1;
1657 /** Accessed flag.
1658 * Indicates that the page have been read or written to. */
1659 uint32_t u1Accessed : 1;
1660 /** Chunk of reserved bits. */
1661 uint32_t u3Reserved : 3;
1662 /** Available for use to system software. */
1663 uint32_t u3Available : 3;
1664 /** Physical Page number of the next level - Low Part. Don't use! */
1665 uint32_t u20PageNoLow : 20;
1666 /** Physical Page number of the next level - High Part. Don't use! */
1667 uint32_t u20PageNoHigh : 20;
1668 /** MBZ bits */
1669 uint32_t u11Reserved : 11;
1670 /** No Execute flag. */
1671 uint32_t u1NoExecute : 1;
1672} X86PML4EBITS;
1673/** Pointer to a page map level-4 entry. */
1674typedef X86PML4EBITS *PX86PML4EBITS;
1675/** Pointer to a const page map level-4 entry. */
1676typedef const X86PML4EBITS *PCX86PML4EBITS;
1677
1678/**
1679 * Page Map Level-4 Entry.
1680 */
1681typedef union X86PML4E
1682{
1683 /** Normal view. */
1684 X86PML4EBITS n;
1685 /** Unsigned integer view. */
1686 X86PGPAEUINT u;
1687 /** 8 bit unsigned integer view. */
1688 uint8_t au8[8];
1689 /** 16 bit unsigned integer view. */
1690 uint16_t au16[4];
1691 /** 32 bit unsigned integer view. */
1692 uint32_t au32[2];
1693} X86PML4E;
1694/** Pointer to a page map level-4 entry. */
1695typedef X86PML4E *PX86PML4E;
1696/** Pointer to a const page map level-4 entry. */
1697typedef const X86PML4E *PCX86PML4E;
1698
1699
1700/**
1701 * Page Map Level-4.
1702 */
1703typedef struct X86PML4
1704{
1705 /** PDE Array. */
1706 X86PML4E a[X86_PG_PAE_ENTRIES];
1707} X86PML4;
1708/** Pointer to a page map level-4. */
1709typedef X86PML4 *PX86PML4;
1710/** Pointer to a const page map level-4. */
1711typedef const X86PML4 *PCX86PML4;
1712
1713/** The page shift to get the PML4 index. */
1714#define X86_PML4_SHIFT 39
1715/** The PML4 index mask (apply to a shifted page address). */
1716#define X86_PML4_MASK 0x1ff
1717
1718/** @} */
1719
1720/** @} */
1721
1722
1723/**
1724 * 80-bit MMX/FPU register type.
1725 */
1726typedef struct X86FPUMMX
1727{
1728 uint8_t reg[10];
1729} X86FPUMMX;
1730/** Pointer to a 80-bit MMX/FPU register type. */
1731typedef X86FPUMMX *PX86FPUMMX;
1732/** Pointer to a const 80-bit MMX/FPU register type. */
1733typedef const X86FPUMMX *PCX86FPUMMX;
1734
1735/**
1736 * FPU state (aka FSAVE/FRSTOR Memory Region).
1737 */
1738#pragma pack(1)
1739typedef struct X86FPUSTATE
1740{
1741 /** Control word. */
1742 uint16_t FCW;
1743 /** Alignment word */
1744 uint16_t Dummy1;
1745 /** Status word. */
1746 uint16_t FSW;
1747 /** Alignment word */
1748 uint16_t Dummy2;
1749 /** Tag word */
1750 uint16_t FTW;
1751 /** Alignment word */
1752 uint16_t Dummy3;
1753
1754 /** Instruction pointer. */
1755 uint32_t FPUIP;
1756 /** Code selector. */
1757 uint16_t CS;
1758 /** Opcode. */
1759 uint16_t FOP;
1760 /** FOO. */
1761 uint32_t FPUOO;
1762 /** FOS. */
1763 uint32_t FPUOS;
1764 /** FPU view - todo. */
1765 X86FPUMMX regs[8];
1766} X86FPUSTATE;
1767#pragma pack()
1768/** Pointer to a FPU state. */
1769typedef X86FPUSTATE *PX86FPUSTATE;
1770/** Pointer to a const FPU state. */
1771typedef const X86FPUSTATE *PCX86FPUSTATE;
1772
1773/**
1774 * FPU Extended state (aka FXSAVE/FXRSTORE Memory Region).
1775 */
1776#pragma pack(1)
1777typedef struct X86FXSTATE
1778{
1779 /** Control word. */
1780 uint16_t FCW;
1781 /** Status word. */
1782 uint16_t FSW;
1783 /** Tag word (it's a byte actually). */
1784 uint8_t FTW;
1785 uint8_t huh1;
1786 /** Opcode. */
1787 uint16_t FOP;
1788 /** Instruction pointer. */
1789 uint32_t FPUIP;
1790 /** Code selector. */
1791 uint16_t CS;
1792 uint16_t Rsvrd1;
1793 /* - offset 16 - */
1794 /** Data pointer. */
1795 uint32_t FPUDP;
1796 /** Data segment */
1797 uint16_t DS;
1798 uint16_t Rsrvd2;
1799 uint32_t MXCSR;
1800 uint32_t MXCSR_MASK;
1801 /* - offset 32 - */
1802 union
1803 {
1804 /** MMX view. */
1805 uint64_t mmx;
1806 /** FPU view - todo. */
1807 X86FPUMMX fpu;
1808 /** 8-bit view. */
1809 uint8_t au8[16];
1810 /** 16-bit view. */
1811 uint16_t au16[8];
1812 /** 32-bit view. */
1813 uint32_t au32[4];
1814 /** 64-bit view. */
1815 uint64_t au64[2];
1816 /** 128-bit view. (yeah, very helpful) */
1817 uint128_t au128[1];
1818 } aRegs[8];
1819 /* - offset 160 - */
1820 union
1821 {
1822 /** XMM Register view *. */
1823 uint128_t xmm;
1824 /** 8-bit view. */
1825 uint8_t au8[16];
1826 /** 16-bit view. */
1827 uint16_t au16[8];
1828 /** 32-bit view. */
1829 uint32_t au32[4];
1830 /** 64-bit view. */
1831 uint64_t au64[2];
1832 /** 128-bit view. (yeah, very helpful) */
1833 uint128_t au128[1];
1834 } aXMM[16]; /* 8 registers in 32 bits mode; 16 in long mode */
1835 /* - offset 416 - */
1836 uint32_t au32RsrvdRest[(512 - 416) / sizeof(uint32_t)];
1837} X86FXSTATE;
1838#pragma pack()
1839/** Pointer to a FPU Extended state. */
1840typedef X86FXSTATE *PX86FXSTATE;
1841/** Pointer to a const FPU Extended state. */
1842typedef const X86FXSTATE *PCX86FXSTATE;
1843
1844
1845/** @name Selector Descriptor
1846 * @{
1847 */
1848
1849/**
1850 * Generic descriptor table entry
1851 */
1852#pragma pack(1)
1853typedef struct X86DESCGENERIC
1854{
1855 /** Limit - Low word. */
1856 unsigned u16LimitLow : 16;
1857 /** Base address - lowe word.
1858 * Don't try set this to 24 because MSC is doing studing things then. */
1859 unsigned u16BaseLow : 16;
1860 /** Base address - first 8 bits of high word. */
1861 unsigned u8BaseHigh1 : 8;
1862 /** Segment Type. */
1863 unsigned u4Type : 4;
1864 /** Descriptor Type. System(=0) or code/data selector */
1865 unsigned u1DescType : 1;
1866 /** Descriptor Privelege level. */
1867 unsigned u2Dpl : 2;
1868 /** Flags selector present(=1) or not. */
1869 unsigned u1Present : 1;
1870 /** Segment limit 16-19. */
1871 unsigned u4LimitHigh : 4;
1872 /** Available for system software. */
1873 unsigned u1Available : 1;
1874 /** 32 bits mode: Reserved - 0, long mode: Long Attribute Bit. */
1875 unsigned u1Long : 1;
1876 /** This flags meaning depends on the segment type. Try make sense out
1877 * of the intel manual yourself. */
1878 unsigned u1DefBig : 1;
1879 /** Granularity of the limit. If set 4KB granularity is used, if
1880 * clear byte. */
1881 unsigned u1Granularity : 1;
1882 /** Base address - highest 8 bits. */
1883 unsigned u8BaseHigh2 : 8;
1884} X86DESCGENERIC;
1885#pragma pack()
1886/** Pointer to a generic descriptor entry. */
1887typedef X86DESCGENERIC *PX86DESCGENERIC;
1888/** Pointer to a const generic descriptor entry. */
1889typedef const X86DESCGENERIC *PCX86DESCGENERIC;
1890
1891
1892/**
1893 * Descriptor attributes.
1894 */
1895typedef struct X86DESCATTRBITS
1896{
1897 /** Segment Type. */
1898 unsigned u4Type : 4;
1899 /** Descriptor Type. System(=0) or code/data selector */
1900 unsigned u1DescType : 1;
1901 /** Descriptor Privelege level. */
1902 unsigned u2Dpl : 2;
1903 /** Flags selector present(=1) or not. */
1904 unsigned u1Present : 1;
1905 /** Segment limit 16-19. */
1906 unsigned u4LimitHigh : 4;
1907 /** Available for system software. */
1908 unsigned u1Available : 1;
1909 /** 32 bits mode: Reserved - 0, long mode: Long Attribute Bit. */
1910 unsigned u1Long : 1;
1911 /** This flags meaning depends on the segment type. Try make sense out
1912 * of the intel manual yourself. */
1913 unsigned u1DefBig : 1;
1914 /** Granularity of the limit. If set 4KB granularity is used, if
1915 * clear byte. */
1916 unsigned u1Granularity : 1;
1917} X86DESCATTRBITS;
1918
1919
1920#pragma pack(1)
1921typedef union X86DESCATTR
1922{
1923 /** Normal view. */
1924 X86DESCATTRBITS n;
1925 /** Unsigned integer view. */
1926 uint32_t u;
1927} X86DESCATTR;
1928#pragma pack()
1929
1930/** Pointer to descriptor attributes. */
1931typedef X86DESCATTR *PX86DESCATTR;
1932/** Pointer to const descriptor attributes. */
1933typedef const X86DESCATTR *PCX86DESCATTR;
1934
1935
1936/**
1937 * Descriptor table entry.
1938 */
1939#pragma pack(1)
1940typedef union X86DESC
1941{
1942 /** Generic descriptor view. */
1943 X86DESCGENERIC Gen;
1944#if 0
1945 /** IDT view. */
1946 VBOXIDTE Idt;
1947#endif
1948
1949 /** 8 bit unsigned interger view. */
1950 uint8_t au8[8];
1951 /** 16 bit unsigned interger view. */
1952 uint16_t au16[4];
1953 /** 32 bit unsigned interger view. */
1954 uint32_t au32[2];
1955} X86DESC;
1956#pragma pack()
1957/** Pointer to descriptor table entry. */
1958typedef X86DESC *PX86DESC;
1959/** Pointer to const descriptor table entry. */
1960typedef const X86DESC *PCX86DESC;
1961
1962
1963/** @def X86DESC_BASE
1964 * Return the base address of a descriptor.
1965 */
1966#define X86DESC_BASE(desc) \
1967 ( ((uint32_t)((desc).Gen.u8BaseHigh2) << 24) \
1968 | ( (desc).Gen.u8BaseHigh1 << 16) \
1969 | ( (desc).Gen.u16BaseLow ) )
1970
1971/** @def X86DESC_LIMIT
1972 * Return the limit of a descriptor.
1973 */
1974#define X86DESC_LIMIT(desc) \
1975 ( ((uint32_t)((desc).Gen.u4LimitHigh) << 16) \
1976 | ( (desc).Gen.u16LimitLow ) )
1977
1978/**
1979 * 64 bits generic descriptor table entry
1980 * Note: most of these bits have no meaning in long mode.
1981 */
1982#pragma pack(1)
1983typedef struct X86DESC64GENERIC
1984{
1985 /** Limit - Low word - *IGNORED*. */
1986 unsigned u16LimitLow : 16;
1987 /** Base address - lowe word. - *IGNORED*
1988 * Don't try set this to 24 because MSC is doing studing things then. */
1989 unsigned u16BaseLow : 16;
1990 /** Base address - first 8 bits of high word. - *IGNORED* */
1991 unsigned u8BaseHigh1 : 8;
1992 /** Segment Type. */
1993 unsigned u4Type : 4;
1994 /** Descriptor Type. System(=0) or code/data selector */
1995 unsigned u1DescType : 1;
1996 /** Descriptor Privelege level. */
1997 unsigned u2Dpl : 2;
1998 /** Flags selector present(=1) or not. */
1999 unsigned u1Present : 1;
2000 /** Segment limit 16-19. - *IGNORED* */
2001 unsigned u4LimitHigh : 4;
2002 /** Available for system software. - *IGNORED* */
2003 unsigned u1Available : 1;
2004 /** Long mode flag. */
2005 unsigned u1Long : 1;
2006 /** This flags meaning depends on the segment type. Try make sense out
2007 * of the intel manual yourself. */
2008 unsigned u1DefBig : 1;
2009 /** Granularity of the limit. If set 4KB granularity is used, if
2010 * clear byte. - *IGNORED* */
2011 unsigned u1Granularity : 1;
2012 /** Base address - highest 8 bits. - *IGNORED* */
2013 unsigned u8BaseHigh2 : 8;
2014 /** Base address - bits 63-32. */
2015 unsigned u32BaseHigh3 : 32;
2016 unsigned u8Reserved : 8;
2017 unsigned u5Zeros : 5;
2018 unsigned u19Reserved : 19;
2019} X86DESC64GENERIC;
2020#pragma pack()
2021/** Pointer to a generic descriptor entry. */
2022typedef X86DESC64GENERIC *PX86DESC64GENERIC;
2023/** Pointer to a const generic descriptor entry. */
2024typedef const X86DESC64GENERIC *PCX86DESC64GENERIC;
2025
2026/**
2027 * System descriptor table entry (64 bits)
2028 */
2029#pragma pack(1)
2030typedef struct X86DESC64SYSTEM
2031{
2032 /** Limit - Low word. */
2033 unsigned u16LimitLow : 16;
2034 /** Base address - lowe word.
2035 * Don't try set this to 24 because MSC is doing studing things then. */
2036 unsigned u16BaseLow : 16;
2037 /** Base address - first 8 bits of high word. */
2038 unsigned u8BaseHigh1 : 8;
2039 /** Segment Type. */
2040 unsigned u4Type : 4;
2041 /** Descriptor Type. System(=0) or code/data selector */
2042 unsigned u1DescType : 1;
2043 /** Descriptor Privelege level. */
2044 unsigned u2Dpl : 2;
2045 /** Flags selector present(=1) or not. */
2046 unsigned u1Present : 1;
2047 /** Segment limit 16-19. */
2048 unsigned u4LimitHigh : 4;
2049 /** Available for system software. */
2050 unsigned u1Available : 1;
2051 /** Reserved - 0. */
2052 unsigned u1Reserved : 1;
2053 /** This flags meaning depends on the segment type. Try make sense out
2054 * of the intel manual yourself. */
2055 unsigned u1DefBig : 1;
2056 /** Granularity of the limit. If set 4KB granularity is used, if
2057 * clear byte. */
2058 unsigned u1Granularity : 1;
2059 /** Base address - bits 31-24. */
2060 unsigned u8BaseHigh2 : 8;
2061 /** Base address - bits 63-32. */
2062 unsigned u32BaseHigh3 : 32;
2063 unsigned u8Reserved : 8;
2064 unsigned u5Zeros : 5;
2065 unsigned u19Reserved : 19;
2066} X86DESC64SYSTEM;
2067#pragma pack()
2068/** Pointer to a generic descriptor entry. */
2069typedef X86DESC64SYSTEM *PX86DESC64SYSTEM;
2070/** Pointer to a const generic descriptor entry. */
2071typedef const X86DESC64SYSTEM *PCX86DESC64SYSTEM;
2072
2073
2074/**
2075 * Descriptor table entry.
2076 */
2077#pragma pack(1)
2078typedef union X86DESC64
2079{
2080 /** Generic descriptor view. */
2081 X86DESC64GENERIC Gen;
2082 /** System descriptor view. */
2083 X86DESC64SYSTEM System;
2084#if 0
2085 X86DESC64GATE Gate;
2086#endif
2087
2088 /** 8 bit unsigned interger view. */
2089 uint8_t au8[16];
2090 /** 16 bit unsigned interger view. */
2091 uint16_t au16[8];
2092 /** 32 bit unsigned interger view. */
2093 uint32_t au32[4];
2094 /** 64 bit unsigned interger view. */
2095 uint64_t au64[2];
2096} X86DESC64;
2097#pragma pack()
2098/** Pointer to descriptor table entry. */
2099typedef X86DESC64 *PX86DESC64;
2100/** Pointer to const descriptor table entry. */
2101typedef const X86DESC64 *PCX86DESC64;
2102
2103#if HC_ARCH_BITS == 64
2104typedef X86DESC64 X86DESCHC;
2105typedef X86DESC64 *PX86DESCHC;
2106#else
2107typedef X86DESC X86DESCHC;
2108typedef X86DESC *PX86DESCHC;
2109#endif
2110
2111/** @def X86DESC_LIMIT
2112 * Return the base of a 64-bit descriptor.
2113 */
2114#define X86DESC64_BASE(desc) \
2115 ( ((uint64_t)((desc).Gen.u32BaseHigh3) << 32) \
2116 | ((uint32_t)((desc).Gen.u8BaseHigh2) << 24) \
2117 | ( (desc).Gen.u8BaseHigh1 << 16) \
2118 | ( (desc).Gen.u16BaseLow ) )
2119
2120
2121/** @name Selector Descriptor Types.
2122 * @{
2123 */
2124
2125/** @name Non-System Selector Types.
2126 * @{ */
2127/** Code(=set)/Data(=clear) bit. */
2128#define X86_SEL_TYPE_CODE 8
2129/** Memory(=set)/System(=clear) bit. */
2130#define X86_SEL_TYPE_MEMORY RT_BIT(4)
2131/** Accessed bit. */
2132#define X86_SEL_TYPE_ACCESSED 1
2133/** Expand down bit (for data selectors only). */
2134#define X86_SEL_TYPE_DOWN 4
2135/** Conforming bit (for code selectors only). */
2136#define X86_SEL_TYPE_CONF 4
2137/** Write bit (for data selectors only). */
2138#define X86_SEL_TYPE_WRITE 2
2139/** Read bit (for code selectors only). */
2140#define X86_SEL_TYPE_READ 2
2141
2142/** Read only selector type. */
2143#define X86_SEL_TYPE_RO 0
2144/** Accessed read only selector type. */
2145#define X86_SEL_TYPE_RO_ACC (0 | X86_SEL_TYPE_ACCESSED)
2146/** Read write selector type. */
2147#define X86_SEL_TYPE_RW 2
2148/** Accessed read write selector type. */
2149#define X86_SEL_TYPE_RW_ACC (2 | X86_SEL_TYPE_ACCESSED)
2150/** Expand down read only selector type. */
2151#define X86_SEL_TYPE_RO_DOWN 4
2152/** Accessed expand down read only selector type. */
2153#define X86_SEL_TYPE_RO_DOWN_ACC (4 | X86_SEL_TYPE_ACCESSED)
2154/** Expand down read write selector type. */
2155#define X86_SEL_TYPE_RW_DOWN 6
2156/** Accessed expand down read write selector type. */
2157#define X86_SEL_TYPE_RW_DOWN_ACC (6 | X86_SEL_TYPE_ACCESSED)
2158/** Execute only selector type. */
2159#define X86_SEL_TYPE_EO (0 | X86_SEL_TYPE_CODE)
2160/** Accessed execute only selector type. */
2161#define X86_SEL_TYPE_EO_ACC (0 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
2162/** Execute and read selector type. */
2163#define X86_SEL_TYPE_ER (2 | X86_SEL_TYPE_CODE)
2164/** Accessed execute and read selector type. */
2165#define X86_SEL_TYPE_ER_ACC (2 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
2166/** Conforming execute only selector type. */
2167#define X86_SEL_TYPE_EO_CONF (4 | X86_SEL_TYPE_CODE)
2168/** Accessed Conforming execute only selector type. */
2169#define X86_SEL_TYPE_EO_CONF_ACC (4 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
2170/** Conforming execute and write selector type. */
2171#define X86_SEL_TYPE_ER_CONF (6 | X86_SEL_TYPE_CODE)
2172/** Accessed Conforming execute and write selector type. */
2173#define X86_SEL_TYPE_ER_CONF_ACC (6 | X86_SEL_TYPE_CODE | X86_SEL_TYPE_ACCESSED)
2174/** @} */
2175
2176
2177/** @name System Selector Types.
2178 * @{ */
2179/** Undefined system selector type. */
2180#define X86_SEL_TYPE_SYS_UNDEFINED 0
2181/** 286 TSS selector. */
2182#define X86_SEL_TYPE_SYS_286_TSS_AVAIL 1
2183/** LDT selector. */
2184#define X86_SEL_TYPE_SYS_LDT 2
2185/** 286 TSS selector - Busy. */
2186#define X86_SEL_TYPE_SYS_286_TSS_BUSY 3
2187/** 286 Callgate selector. */
2188#define X86_SEL_TYPE_SYS_286_CALL_GATE 4
2189/** Taskgate selector. */
2190#define X86_SEL_TYPE_SYS_TASK_GATE 5
2191/** 286 Interrupt gate selector. */
2192#define X86_SEL_TYPE_SYS_286_INT_GATE 6
2193/** 286 Trapgate selector. */
2194#define X86_SEL_TYPE_SYS_286_TRAP_GATE 7
2195/** Undefined system selector. */
2196#define X86_SEL_TYPE_SYS_UNDEFINED2 8
2197/** 386 TSS selector. */
2198#define X86_SEL_TYPE_SYS_386_TSS_AVAIL 9
2199/** Undefined system selector. */
2200#define X86_SEL_TYPE_SYS_UNDEFINED3 0xA
2201/** 386 TSS selector - Busy. */
2202#define X86_SEL_TYPE_SYS_386_TSS_BUSY 0xB
2203/** 386 Callgate selector. */
2204#define X86_SEL_TYPE_SYS_386_CALL_GATE 0xC
2205/** Undefined system selector. */
2206#define X86_SEL_TYPE_SYS_UNDEFINED4 0xD
2207/** 386 Interruptgate selector. */
2208#define X86_SEL_TYPE_SYS_386_INT_GATE 0xE
2209/** 386 Trapgate selector. */
2210#define X86_SEL_TYPE_SYS_386_TRAP_GATE 0xF
2211/** @} */
2212
2213/** @name AMD64 System Selector Types.
2214 * @{ */
2215#define AMD64_SEL_TYPE_SYS_LDT 2
2216/** 286 TSS selector - Busy. */
2217#define AMD64_SEL_TYPE_SYS_TSS_AVAIL 9
2218/** 386 TSS selector - Busy. */
2219#define AMD64_SEL_TYPE_SYS_TSS_BUSY 0xB
2220/** 386 Callgate selector. */
2221#define AMD64_SEL_TYPE_SYS_CALL_GATE 0xC
2222/** 386 Interruptgate selector. */
2223#define AMD64_SEL_TYPE_SYS_INT_GATE 0xE
2224/** 386 Trapgate selector. */
2225#define AMD64_SEL_TYPE_SYS_TRAP_GATE 0xF
2226/** @} */
2227
2228/** @} */
2229
2230
2231/** @name Descriptor Table Entry Flag Masks.
2232 * These are for the 2nd 32-bit word of a descriptor.
2233 * @{ */
2234/** Bits 8-11 - TYPE - Descriptor type mask. */
2235#define X86_DESC_TYPE_MASK (RT_BIT(8) | RT_BIT(9) | RT_BIT(10) | RT_BIT(11))
2236/** Bit 12 - S - System (=0) or Code/Data (=1). */
2237#define X86_DESC_S RT_BIT(12)
2238/** Bits 13-14 - DPL - Descriptor Privilege Level. */
2239#define X86_DESC_DPL (RT_BIT(13) | RT_BIT(14))
2240/** Bit 15 - P - Present. */
2241#define X86_DESC_P RT_BIT(15)
2242/** Bit 20 - AVL - Available for system software. */
2243#define X86_DESC_AVL RT_BIT(20)
2244/** Bit 22 - DB - Default operation size. 0 = 16 bit, 1 = 32 bit. */
2245#define X86_DESC_DB RT_BIT(22)
2246/** Bit 23 - G - Granularity of the limit. If set 4KB granularity is
2247 * used, if clear byte. */
2248#define X86_DESC_G RT_BIT(23)
2249/** @} */
2250
2251/** @} */
2252
2253
2254/** @name Selectors.
2255 * @{
2256 */
2257
2258/**
2259 * The shift used to convert a selector from and to index an index (C).
2260 */
2261#define X86_SEL_SHIFT 3
2262
2263/**
2264 * The shift used to convert a selector from and to index an index (C).
2265 */
2266#define AMD64_SEL_SHIFT 4
2267
2268#if HC_ARCH_BITS == 64
2269#define X86_SEL_SHIFT_HC AMD64_SEL_SHIFT
2270#else
2271#define X86_SEL_SHIFT_HC X86_SEL_SHIFT
2272#endif
2273
2274/**
2275 * The mask used to mask off the table indicator and CPL of an selector.
2276 */
2277#define X86_SEL_MASK 0xfff8
2278
2279/**
2280 * The bit indicating that a selector is in the LDT and not in the GDT.
2281 */
2282#define X86_SEL_LDT 0x0004
2283/**
2284 * The bit mask for getting the RPL of a selector.
2285 */
2286#define X86_SEL_RPL 0x0003
2287
2288/** @} */
2289
2290
2291/**
2292 * x86 Exceptions/Faults/Traps.
2293 */
2294typedef enum X86XCPT
2295{
2296 /** \#DE - Divide error. */
2297 X86_XCPT_DE = 0x00,
2298 /** \#DB - Debug event (single step, DRx, ..) */
2299 X86_XCPT_DB = 0x01,
2300 /** NMI - Non-Maskable Interrupt */
2301 X86_XCPT_NMI = 0x02,
2302 /** \#BP - Breakpoint (INT3). */
2303 X86_XCPT_BP = 0x03,
2304 /** \#OF - Overflow (INTO). */
2305 X86_XCPT_OF = 0x04,
2306 /** \#BR - Bound range exceeded (BOUND). */
2307 X86_XCPT_BR = 0x05,
2308 /** \#UD - Undefined opcode. */
2309 X86_XCPT_UD = 0x06,
2310 /** \#NM - Device not available (math coprocessor device). */
2311 X86_XCPT_NM = 0x07,
2312 /** \#DF - Double fault. */
2313 X86_XCPT_DF = 0x08,
2314 /** ??? - Coprocessor segment overrun (obsolete). */
2315 X86_XCPT_CO_SEG_OVERRUN = 0x09,
2316 /** \#TS - Taskswitch (TSS). */
2317 X86_XCPT_TS = 0x0a,
2318 /** \#NP - Segment no present. */
2319 X86_XCPT_NP = 0x0b,
2320 /** \#SS - Stack segment fault. */
2321 X86_XCPT_SS = 0x0c,
2322 /** \#GP - General protection fault. */
2323 X86_XCPT_GP = 0x0d,
2324 /** \#PF - Page fault. */
2325 X86_XCPT_PF = 0x0e,
2326 /* 0x0f is reserved. */
2327 /** \#MF - Math fault (FPU). */
2328 X86_XCPT_MF = 0x10,
2329 /** \#AC - Alignment check. */
2330 X86_XCPT_AC = 0x11,
2331 /** \#MC - Machine check. */
2332 X86_XCPT_MC = 0x12,
2333 /** \#XF - SIMD Floating-Pointer Exception. */
2334 X86_XCPT_XF = 0x13
2335} X86XCPT;
2336/** Pointer to a x86 exception code. */
2337typedef X86XCPT *PX86XCPT;
2338/** Pointer to a const x86 exception code. */
2339typedef const X86XCPT *PCX86XCPT;
2340
2341
2342/** @name Trap Error Codes
2343 * @{
2344 */
2345/** External indicator. */
2346#define X86_TRAP_ERR_EXTERNAL 1
2347/** IDT indicator. */
2348#define X86_TRAP_ERR_IDT 2
2349/** Descriptor table indicator - If set LDT, if clear GDT. */
2350#define X86_TRAP_ERR_TI 4
2351/** Mask for getting the selector. */
2352#define X86_TRAP_ERR_SEL_MASK 0xfff8
2353/** Shift for getting the selector table index (C type index). */
2354#define X86_TRAP_ERR_SEL_SHIFT 3
2355/** @} */
2356
2357
2358/** @name \#PF Trap Error Codes
2359 * @{
2360 */
2361/** Bit 0 - P - Not present (clear) or page level protection (set) fault. */
2362#define X86_TRAP_PF_P RT_BIT(0)
2363/** Bit 1 - R/W - Read (clear) or write (set) access. */
2364#define X86_TRAP_PF_RW RT_BIT(1)
2365/** Bit 2 - U/S - CPU executing in user mode (set) or supervisor mode (clear). */
2366#define X86_TRAP_PF_US RT_BIT(2)
2367/** Bit 3 - RSVD- Reserved bit violation (set), i.e. reserved bit was set to 1. */
2368#define X86_TRAP_PF_RSVD RT_BIT(3)
2369/** Bit 4 - I/D - Instruction fetch (set) / Data access (clear) - PAE + NXE. */
2370#define X86_TRAP_PF_ID RT_BIT(4)
2371/** @} */
2372
2373#pragma pack(1)
2374/**
2375 * 32-bit IDTR/GDTR.
2376 */
2377typedef struct X86XDTR32
2378{
2379 /** Size of the descriptor table. */
2380 uint16_t cb;
2381 /** Address of the descriptor table. */
2382 uint32_t uAddr;
2383} X86XDTR32, *PX86XDTR32;
2384#pragma pack()
2385
2386#pragma pack(1)
2387/**
2388 * 64-bit IDTR/GDTR.
2389 */
2390typedef struct X86XDTR64
2391{
2392 /** Size of the descriptor table. */
2393 uint16_t cb;
2394 /** Address of the descriptor table. */
2395 uint64_t uAddr;
2396} X86XDTR64, *PX86XDTR64;
2397#pragma pack()
2398
2399/** @} */
2400
2401#endif
2402
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