cpum.h@ 20374

Last change on this file since 20374 was 20374, checked in by vboxsync, 15 years ago
*: s/RT_\(BEGIN\|END\)_DECLS/RT_C_DECLS_\1/g
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 32.2 KB

Line
1	/** @file
2	* CPUM - CPU Monitor(/ Manager).
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	#ifndef ___VBox_cpum_h
31	#define ___VBox_cpum_h
32
33	#include <VBox/cdefs.h>
34	#include <VBox/types.h>
35	#include <VBox/x86.h>
36
37
38	RT_C_DECLS_BEGIN
39
40	/** @defgroup grp_cpum The CPU Monitor / Manager API
41	* @{
42	*/
43
44	/**
45	* Selector hidden registers.
46	*/
47	typedef struct CPUMSELREGHID
48	{
49	/** Base register.
50	*
51	* Long mode remarks:
52	* - Unused in long mode for CS, DS, ES, SS
53	* - 32 bits for FS & GS; FS(GS)_BASE msr used for the base address
54	* - 64 bits for TR & LDTR
55	*/
56	uint64_t u64Base;
57	/** Limit (expanded). */
58	uint32_t u32Limit;
59	/** Flags.
60	* This is the high 32-bit word of the descriptor entry.
61	* Only the flags, dpl and type are used. */
62	X86DESCATTR Attr;
63	} CPUMSELREGHID;
64
65
66	/**
67	* The sysenter register set.
68	*/
69	typedef struct CPUMSYSENTER
70	{
71	/** Ring 0 cs.
72	* This value + 8 is the Ring 0 ss.
73	* This value + 16 is the Ring 3 cs.
74	* This value + 24 is the Ring 3 ss.
75	*/
76	uint64_t cs;
77	/** Ring 0 eip. */
78	uint64_t eip;
79	/** Ring 0 esp. */
80	uint64_t esp;
81	} CPUMSYSENTER;
82
83
84	/**
85	* CPU context core.
86	*/
87	#pragma pack(1)
88	typedef struct CPUMCTXCORE
89	{
90	union
91	{
92	uint16_t di;
93	uint32_t edi;
94	uint64_t rdi;
95	};
96	union
97	{
98	uint16_t si;
99	uint32_t esi;
100	uint64_t rsi;
101	};
102	union
103	{
104	uint16_t bp;
105	uint32_t ebp;
106	uint64_t rbp;
107	};
108	union
109	{
110	uint16_t ax;
111	uint32_t eax;
112	uint64_t rax;
113	};
114	union
115	{
116	uint16_t bx;
117	uint32_t ebx;
118	uint64_t rbx;
119	};
120	union
121	{
122	uint16_t dx;
123	uint32_t edx;
124	uint64_t rdx;
125	};
126	union
127	{
128	uint16_t cx;
129	uint32_t ecx;
130	uint64_t rcx;
131	};
132	union
133	{
134	uint16_t sp;
135	uint32_t esp;
136	uint64_t rsp;
137	};
138	/* Note: lss esp, [] in the switcher needs some space, so we reserve it here instead of relying on the exact esp & ss layout as before. */
139	uint32_t lss_esp;
140	RTSEL ss;
141	RTSEL ssPadding;
142
143	RTSEL gs;
144	RTSEL gsPadding;
145	RTSEL fs;
146	RTSEL fsPadding;
147	RTSEL es;
148	RTSEL esPadding;
149	RTSEL ds;
150	RTSEL dsPadding;
151	RTSEL cs;
152	RTSEL csPadding[3]; /* 3 words to force 8 byte alignment for the remainder */
153
154	union
155	{
156	X86EFLAGS eflags;
157	X86RFLAGS rflags;
158	};
159	union
160	{
161	uint16_t ip;
162	uint32_t eip;
163	uint64_t rip;
164	};
165
166	uint64_t r8;
167	uint64_t r9;
168	uint64_t r10;
169	uint64_t r11;
170	uint64_t r12;
171	uint64_t r13;
172	uint64_t r14;
173	uint64_t r15;
174
175	/** Hidden selector registers.
176	* @{ */
177	CPUMSELREGHID esHid;
178	CPUMSELREGHID csHid;
179	CPUMSELREGHID ssHid;
180	CPUMSELREGHID dsHid;
181	CPUMSELREGHID fsHid;
182	CPUMSELREGHID gsHid;
183	/** @} */
184
185	} CPUMCTXCORE;
186	#pragma pack()
187
188
189	/**
190	* CPU context.
191	*/
192	#pragma pack(1)
193	typedef struct CPUMCTX
194	{
195	/** FPU state. (16-byte alignment)
196	* @todo This doesn't have to be in X86FXSTATE on CPUs without fxsr - we need a type for the
197	* actual format or convert it (waste of time). */
198	X86FXSTATE fpu;
199
200	/** CPUMCTXCORE Part.
201	* @{ */
202	union
203	{
204	uint16_t di;
205	uint32_t edi;
206	uint64_t rdi;
207	};
208	union
209	{
210	uint16_t si;
211	uint32_t esi;
212	uint64_t rsi;
213	};
214	union
215	{
216	uint16_t bp;
217	uint32_t ebp;
218	uint64_t rbp;
219	};
220	union
221	{
222	uint16_t ax;
223	uint32_t eax;
224	uint64_t rax;
225	};
226	union
227	{
228	uint16_t bx;
229	uint32_t ebx;
230	uint64_t rbx;
231	};
232	union
233	{
234	uint16_t dx;
235	uint32_t edx;
236	uint64_t rdx;
237	};
238	union
239	{
240	uint16_t cx;
241	uint32_t ecx;
242	uint64_t rcx;
243	};
244	union
245	{
246	uint16_t sp;
247	uint32_t esp;
248	uint64_t rsp;
249	};
250	/* Note: lss esp, [] in the switcher needs some space, so we reserve it here instead of relying on the exact esp & ss layout as before (prevented us from using a union with rsp). */
251	uint32_t lss_esp;
252	RTSEL ss;
253	RTSEL ssPadding;
254
255	RTSEL gs;
256	RTSEL gsPadding;
257	RTSEL fs;
258	RTSEL fsPadding;
259	RTSEL es;
260	RTSEL esPadding;
261	RTSEL ds;
262	RTSEL dsPadding;
263	RTSEL cs;
264	RTSEL csPadding[3]; /* 3 words to force 8 byte alignment for the remainder */
265
266	union
267	{
268	X86EFLAGS eflags;
269	X86RFLAGS rflags;
270	};
271	union
272	{
273	uint16_t ip;
274	uint32_t eip;
275	uint64_t rip;
276	};
277
278	uint64_t r8;
279	uint64_t r9;
280	uint64_t r10;
281	uint64_t r11;
282	uint64_t r12;
283	uint64_t r13;
284	uint64_t r14;
285	uint64_t r15;
286
287	/** Hidden selector registers.
288	* @{ */
289	CPUMSELREGHID esHid;
290	CPUMSELREGHID csHid;
291	CPUMSELREGHID ssHid;
292	CPUMSELREGHID dsHid;
293	CPUMSELREGHID fsHid;
294	CPUMSELREGHID gsHid;
295	/** @} */
296
297	/** @} */
298
299	/** Control registers.
300	* @{ */
301	uint64_t cr0;
302	uint64_t cr2;
303	uint64_t cr3;
304	uint64_t cr4;
305	/** @} */
306
307	/** Debug registers.
308	* @remarks DR4 and DR5 should not be used since they are aliases for
309	* DR6 and DR7 respectively on both AMD and Intel CPUs.
310	* @remarks DR8-15 are currently not supported by AMD or Intel, so
311	* neither do we.
312	* @{ */
313	uint64_t dr[8];
314	/** @} */
315
316	/** Global Descriptor Table register. */
317	VBOXGDTR gdtr;
318	uint16_t gdtrPadding;
319	/** Interrupt Descriptor Table register. */
320	VBOXIDTR idtr;
321	uint16_t idtrPadding;
322	/** The task register.
323	* Only the guest context uses all the members. */
324	RTSEL ldtr;
325	RTSEL ldtrPadding;
326	/** The task register.
327	* Only the guest context uses all the members. */
328	RTSEL tr;
329	RTSEL trPadding;
330
331	/** The sysenter msr registers.
332	* This member is not used by the hypervisor context. */
333	CPUMSYSENTER SysEnter;
334
335	/** System MSRs.
336	* @{ */
337	uint64_t msrEFER;
338	uint64_t msrSTAR; /* legacy syscall eip, cs & ss */
339	uint64_t msrPAT;
340	uint64_t msrLSTAR; /* 64 bits mode syscall rip */
341	uint64_t msrCSTAR; /* compatibility mode syscall rip */
342	uint64_t msrSFMASK; /* syscall flag mask */
343	uint64_t msrKERNELGSBASE;/* swapgs exchange value */
344	/** @} */
345
346	/** Hidden selector registers.
347	* @{ */
348	CPUMSELREGHID ldtrHid;
349	CPUMSELREGHID trHid;
350	/** @} */
351
352	#if 0
353	/& Padding to align the size on a 64 byte boundrary. /
354	uint32_t padding[6];
355	#endif
356	} CPUMCTX;
357	#pragma pack()
358
359	/**
360	* Gets the CPUMCTXCORE part of a CPUMCTX.
361	*/
362	#define CPUMCTX2CORE(pCtx) ((PCPUMCTXCORE)(void *)&(pCtx)->edi)
363
364	/**
365	* Selector hidden registers, for version 1.6 saved state.
366	*/
367	typedef struct CPUMSELREGHID_VER1_6
368	{
369	/** Base register. */
370	uint32_t u32Base;
371	/** Limit (expanded). */
372	uint32_t u32Limit;
373	/** Flags.
374	* This is the high 32-bit word of the descriptor entry.
375	* Only the flags, dpl and type are used. */
376	X86DESCATTR Attr;
377	} CPUMSELREGHID_VER1_6;
378
379	/**
380	* CPU context, for version 1.6 saved state.
381	* @remarks PATM uses this, which is why it has to be here.
382	*/
383	#pragma pack(1)
384	typedef struct CPUMCTX_VER1_6
385	{
386	/** FPU state. (16-byte alignment)
387	* @todo This doesn't have to be in X86FXSTATE on CPUs without fxsr - we need a type for the
388	* actual format or convert it (waste of time). */
389	X86FXSTATE fpu;
390
391	/** CPUMCTXCORE Part.
392	* @{ */
393	union
394	{
395	uint32_t edi;
396	uint64_t rdi;
397	};
398	union
399	{
400	uint32_t esi;
401	uint64_t rsi;
402	};
403	union
404	{
405	uint32_t ebp;
406	uint64_t rbp;
407	};
408	union
409	{
410	uint32_t eax;
411	uint64_t rax;
412	};
413	union
414	{
415	uint32_t ebx;
416	uint64_t rbx;
417	};
418	union
419	{
420	uint32_t edx;
421	uint64_t rdx;
422	};
423	union
424	{
425	uint32_t ecx;
426	uint64_t rcx;
427	};
428	/* Note: we rely on the exact layout, because we use lss esp, [] in the switcher */
429	uint32_t esp;
430	RTSEL ss;
431	RTSEL ssPadding;
432	/* Note: no overlap with esp here. */
433	uint64_t rsp_notused;
434
435	RTSEL gs;
436	RTSEL gsPadding;
437	RTSEL fs;
438	RTSEL fsPadding;
439	RTSEL es;
440	RTSEL esPadding;
441	RTSEL ds;
442	RTSEL dsPadding;
443	RTSEL cs;
444	RTSEL csPadding[3]; /* 3 words to force 8 byte alignment for the remainder */
445
446	union
447	{
448	X86EFLAGS eflags;
449	X86RFLAGS rflags;
450	};
451	union
452	{
453	uint32_t eip;
454	uint64_t rip;
455	};
456
457	uint64_t r8;
458	uint64_t r9;
459	uint64_t r10;
460	uint64_t r11;
461	uint64_t r12;
462	uint64_t r13;
463	uint64_t r14;
464	uint64_t r15;
465
466	/** Hidden selector registers.
467	* @{ */
468	CPUMSELREGHID_VER1_6 esHid;
469	CPUMSELREGHID_VER1_6 csHid;
470	CPUMSELREGHID_VER1_6 ssHid;
471	CPUMSELREGHID_VER1_6 dsHid;
472	CPUMSELREGHID_VER1_6 fsHid;
473	CPUMSELREGHID_VER1_6 gsHid;
474	/** @} */
475
476	/** @} */
477
478	/** Control registers.
479	* @{ */
480	uint64_t cr0;
481	uint64_t cr2;
482	uint64_t cr3;
483	uint64_t cr4;
484	uint64_t cr8;
485	/** @} */
486
487	/** Debug registers.
488	* @{ */
489	uint64_t dr0;
490	uint64_t dr1;
491	uint64_t dr2;
492	uint64_t dr3;
493	uint64_t dr4; /*< @todo remove dr4 and dr5. /
494	uint64_t dr5;
495	uint64_t dr6;
496	uint64_t dr7;
497	/* DR8-15 are currently not supported */
498	/** @} */
499
500	/** Global Descriptor Table register. */
501	VBOXGDTR_VER1_6 gdtr;
502	uint16_t gdtrPadding;
503	uint32_t gdtrPadding64;/** @todo fix this hack */
504	/** Interrupt Descriptor Table register. */
505	VBOXIDTR_VER1_6 idtr;
506	uint16_t idtrPadding;
507	uint32_t idtrPadding64;/** @todo fix this hack */
508	/** The task register.
509	* Only the guest context uses all the members. */
510	RTSEL ldtr;
511	RTSEL ldtrPadding;
512	/** The task register.
513	* Only the guest context uses all the members. */
514	RTSEL tr;
515	RTSEL trPadding;
516
517	/** The sysenter msr registers.
518	* This member is not used by the hypervisor context. */
519	CPUMSYSENTER SysEnter;
520
521	/** System MSRs.
522	* @{ */
523	uint64_t msrEFER;
524	uint64_t msrSTAR;
525	uint64_t msrPAT;
526	uint64_t msrLSTAR;
527	uint64_t msrCSTAR;
528	uint64_t msrSFMASK;
529	uint64_t msrFSBASE;
530	uint64_t msrGSBASE;
531	uint64_t msrKERNELGSBASE;
532	/** @} */
533
534	/** Hidden selector registers.
535	* @{ */
536	CPUMSELREGHID_VER1_6 ldtrHid;
537	CPUMSELREGHID_VER1_6 trHid;
538	/** @} */
539
540	/* padding to get 32byte aligned size */
541	uint32_t padding[2];
542	} CPUMCTX_VER1_6;
543	#pragma pack()
544
545	/* Guest MSR state. */
546	typedef union CPUMCTXMSR
547	{
548	struct
549	{
550	uint64_t tscAux; /* MSR_K8_TSC_AUX */
551	} msr;
552	uint64_t au64[64];
553	} CPUMCTXMSR;
554	/** Pointer to the guest MSR state. */
555	typedef CPUMCTXMSR *PCPUMCTXMSR;
556	/** Pointer to the const guest MSR state. */
557	typedef const CPUMCTXMSR *PCCPUMCTXMSR;
558
559
560	/**
561	* The register set returned by a CPUID operation.
562	*/
563	typedef struct CPUMCPUID
564	{
565	uint32_t eax;
566	uint32_t ebx;
567	uint32_t ecx;
568	uint32_t edx;
569	} CPUMCPUID;
570	/** Pointer to a CPUID leaf. */
571	typedef CPUMCPUID *PCPUMCPUID;
572	/** Pointer to a const CPUID leaf. */
573	typedef const CPUMCPUID *PCCPUMCPUID;
574
575	/**
576	* CPUID feature to set or clear.
577	*/
578	typedef enum CPUMCPUIDFEATURE
579	{
580	CPUMCPUIDFEATURE_INVALID = 0,
581	/** The APIC feature bit. (Std+Ext) */
582	CPUMCPUIDFEATURE_APIC,
583	/** The sysenter/sysexit feature bit. (Std) */
584	CPUMCPUIDFEATURE_SEP,
585	/** The SYSCALL/SYSEXIT feature bit (64 bits mode only for Intel CPUs). (Ext) */
586	CPUMCPUIDFEATURE_SYSCALL,
587	/** The PAE feature bit. (Std+Ext) */
588	CPUMCPUIDFEATURE_PAE,
589	/** The NXE feature bit. (Ext) */
590	CPUMCPUIDFEATURE_NXE,
591	/** The LAHF/SAHF feature bit (64 bits mode only). (Ext) */
592	CPUMCPUIDFEATURE_LAHF,
593	/** The LONG MODE feature bit. (Ext) */
594	CPUMCPUIDFEATURE_LONG_MODE,
595	/** The PAT feature bit. (Std+Ext) */
596	CPUMCPUIDFEATURE_PAT,
597	/** The x2APIC feature bit. (Std) */
598	CPUMCPUIDFEATURE_X2APIC,
599	/** The RDTSCP feature bit. (Ext) */
600	CPUMCPUIDFEATURE_RDTSCP,
601	/** 32bit hackishness. */
602	CPUMCPUIDFEATURE_32BIT_HACK = 0x7fffffff
603	} CPUMCPUIDFEATURE;
604
605	/**
606	* CPU Vendor.
607	*/
608	typedef enum CPUMCPUVENDOR
609	{
610	CPUMCPUVENDOR_INVALID = 0,
611	CPUMCPUVENDOR_INTEL,
612	CPUMCPUVENDOR_AMD,
613	CPUMCPUVENDOR_VIA,
614	CPUMCPUVENDOR_UNKNOWN,
615	/** 32bit hackishness. */
616	CPUMCPUVENDOR_32BIT_HACK = 0x7fffffff
617	} CPUMCPUVENDOR;
618
619
620	/** @name Guest Register Getters.
621	* @{ */
622	VMMDECL(void) CPUMGetGuestGDTR(PVMCPU pVCpu, PVBOXGDTR pGDTR);
623	VMMDECL(RTGCPTR) CPUMGetGuestIDTR(PVMCPU pVCpu, uint16_t *pcbLimit);
624	VMMDECL(RTSEL) CPUMGetGuestTR(PVMCPU pVCpu, PCPUMSELREGHID pHidden);
625	VMMDECL(RTSEL) CPUMGetGuestLDTR(PVMCPU pVCpu);
626	VMMDECL(uint64_t) CPUMGetGuestCR0(PVMCPU pVCpu);
627	VMMDECL(uint64_t) CPUMGetGuestCR2(PVMCPU pVCpu);
628	VMMDECL(uint64_t) CPUMGetGuestCR3(PVMCPU pVCpu);
629	VMMDECL(uint64_t) CPUMGetGuestCR4(PVMCPU pVCpu);
630	VMMDECL(int) CPUMGetGuestCRx(PVMCPU pVCpu, unsigned iReg, uint64_t *pValue);
631	VMMDECL(uint32_t) CPUMGetGuestEFlags(PVMCPU pVCpu);
632	VMMDECL(uint32_t) CPUMGetGuestEIP(PVMCPU pVCpu);
633	VMMDECL(uint64_t) CPUMGetGuestRIP(PVMCPU pVCpu);
634	VMMDECL(uint32_t) CPUMGetGuestEAX(PVMCPU pVCpu);
635	VMMDECL(uint32_t) CPUMGetGuestEBX(PVMCPU pVCpu);
636	VMMDECL(uint32_t) CPUMGetGuestECX(PVMCPU pVCpu);
637	VMMDECL(uint32_t) CPUMGetGuestEDX(PVMCPU pVCpu);
638	VMMDECL(uint32_t) CPUMGetGuestESI(PVMCPU pVCpu);
639	VMMDECL(uint32_t) CPUMGetGuestEDI(PVMCPU pVCpu);
640	VMMDECL(uint32_t) CPUMGetGuestESP(PVMCPU pVCpu);
641	VMMDECL(uint32_t) CPUMGetGuestEBP(PVMCPU pVCpu);
642	VMMDECL(RTSEL) CPUMGetGuestCS(PVMCPU pVCpu);
643	VMMDECL(RTSEL) CPUMGetGuestDS(PVMCPU pVCpu);
644	VMMDECL(RTSEL) CPUMGetGuestES(PVMCPU pVCpu);
645	VMMDECL(RTSEL) CPUMGetGuestFS(PVMCPU pVCpu);
646	VMMDECL(RTSEL) CPUMGetGuestGS(PVMCPU pVCpu);
647	VMMDECL(RTSEL) CPUMGetGuestSS(PVMCPU pVCpu);
648	VMMDECL(uint64_t) CPUMGetGuestDR0(PVMCPU pVCpu);
649	VMMDECL(uint64_t) CPUMGetGuestDR1(PVMCPU pVCpu);
650	VMMDECL(uint64_t) CPUMGetGuestDR2(PVMCPU pVCpu);
651	VMMDECL(uint64_t) CPUMGetGuestDR3(PVMCPU pVCpu);
652	VMMDECL(uint64_t) CPUMGetGuestDR6(PVMCPU pVCpu);
653	VMMDECL(uint64_t) CPUMGetGuestDR7(PVMCPU pVCpu);
654	VMMDECL(int) CPUMGetGuestDRx(PVMCPU pVCpu, uint32_t iReg, uint64_t *pValue);
655	VMMDECL(void) CPUMGetGuestCpuId(PVMCPU pVCpu, uint32_t iLeaf, uint32_t pEax, uint32_t pEbx, uint32_t pEcx, uint32_t pEdx);
656	VMMDECL(uint32_t) CPUMGetGuestCpuIdStdMax(PVM pVM);
657	VMMDECL(uint32_t) CPUMGetGuestCpuIdExtMax(PVM pVM);
658	VMMDECL(uint32_t) CPUMGetGuestCpuIdCentaurMax(PVM pVM);
659	VMMDECL(uint64_t) CPUMGetGuestEFER(PVMCPU pVCpu);
660	VMMDECL(uint64_t) CPUMGetGuestMsr(PVMCPU pVCpu, unsigned idMsr);
661	VMMDECL(void) CPUMSetGuestMsr(PVMCPU pVCpu, unsigned idMsr, uint64_t valMsr);
662	/** @} */
663
664	/** @name Guest Register Setters.
665	* @{ */
666	VMMDECL(int) CPUMSetGuestGDTR(PVMCPU pVCpu, uint32_t addr, uint16_t limit);
667	VMMDECL(int) CPUMSetGuestIDTR(PVMCPU pVCpu, uint32_t addr, uint16_t limit);
668	VMMDECL(int) CPUMSetGuestTR(PVMCPU pVCpu, uint16_t tr);
669	VMMDECL(int) CPUMSetGuestLDTR(PVMCPU pVCpu, uint16_t ldtr);
670	VMMDECL(int) CPUMSetGuestCR0(PVMCPU pVCpu, uint64_t cr0);
671	VMMDECL(int) CPUMSetGuestCR2(PVMCPU pVCpu, uint64_t cr2);
672	VMMDECL(int) CPUMSetGuestCR3(PVMCPU pVCpu, uint64_t cr3);
673	VMMDECL(int) CPUMSetGuestCR4(PVMCPU pVCpu, uint64_t cr4);
674	VMMDECL(int) CPUMSetGuestDR0(PVMCPU pVCpu, uint64_t uDr0);
675	VMMDECL(int) CPUMSetGuestDR1(PVMCPU pVCpu, uint64_t uDr1);
676	VMMDECL(int) CPUMSetGuestDR2(PVMCPU pVCpu, uint64_t uDr2);
677	VMMDECL(int) CPUMSetGuestDR3(PVMCPU pVCpu, uint64_t uDr3);
678	VMMDECL(int) CPUMSetGuestDR6(PVMCPU pVCpu, uint64_t uDr6);
679	VMMDECL(int) CPUMSetGuestDR7(PVMCPU pVCpu, uint64_t uDr7);
680	VMMDECL(int) CPUMSetGuestDRx(PVMCPU pVCpu, uint32_t iReg, uint64_t Value);
681	VMMDECL(int) CPUMSetGuestEFlags(PVMCPU pVCpu, uint32_t eflags);
682	VMMDECL(int) CPUMSetGuestEIP(PVMCPU pVCpu, uint32_t eip);
683	VMMDECL(int) CPUMSetGuestEAX(PVMCPU pVCpu, uint32_t eax);
684	VMMDECL(int) CPUMSetGuestEBX(PVMCPU pVCpu, uint32_t ebx);
685	VMMDECL(int) CPUMSetGuestECX(PVMCPU pVCpu, uint32_t ecx);
686	VMMDECL(int) CPUMSetGuestEDX(PVMCPU pVCpu, uint32_t edx);
687	VMMDECL(int) CPUMSetGuestESI(PVMCPU pVCpu, uint32_t esi);
688	VMMDECL(int) CPUMSetGuestEDI(PVMCPU pVCpu, uint32_t edi);
689	VMMDECL(int) CPUMSetGuestESP(PVMCPU pVCpu, uint32_t esp);
690	VMMDECL(int) CPUMSetGuestEBP(PVMCPU pVCpu, uint32_t ebp);
691	VMMDECL(int) CPUMSetGuestCS(PVMCPU pVCpu, uint16_t cs);
692	VMMDECL(int) CPUMSetGuestDS(PVMCPU pVCpu, uint16_t ds);
693	VMMDECL(int) CPUMSetGuestES(PVMCPU pVCpu, uint16_t es);
694	VMMDECL(int) CPUMSetGuestFS(PVMCPU pVCpu, uint16_t fs);
695	VMMDECL(int) CPUMSetGuestGS(PVMCPU pVCpu, uint16_t gs);
696	VMMDECL(int) CPUMSetGuestSS(PVMCPU pVCpu, uint16_t ss);
697	VMMDECL(void) CPUMSetGuestEFER(PVMCPU pVCpu, uint64_t val);
698	VMMDECL(void) CPUMSetGuestCpuIdFeature(PVM pVM, CPUMCPUIDFEATURE enmFeature);
699	VMMDECL(void) CPUMClearGuestCpuIdFeature(PVM pVM, CPUMCPUIDFEATURE enmFeature);
700	VMMDECL(bool) CPUMGetGuestCpuIdFeature(PVM pVM, CPUMCPUIDFEATURE enmFeature);
701	VMMDECL(void) CPUMSetGuestCtx(PVMCPU pVCpu, const PCPUMCTX pCtx);
702	/** @} */
703
704	/** @name Misc Guest Predicate Functions.
705	* @{ */
706
707
708	VMMDECL(bool) CPUMIsGuestIn16BitCode(PVMCPU pVCpu);
709	VMMDECL(bool) CPUMIsGuestIn32BitCode(PVMCPU pVCpu);
710	VMMDECL(CPUMCPUVENDOR) CPUMGetCPUVendor(PVM pVM);
711
712	/**
713	* Tests if the guest is running in real mode or not.
714	*
715	* @returns true if in real mode, otherwise false.
716	* @param pVM The VM handle.
717	*/
718	DECLINLINE(bool) CPUMIsGuestInRealMode(PVMCPU pVCpu)
719	{
720	return !(CPUMGetGuestCR0(pVCpu) & X86_CR0_PE);
721	}
722
723	/**
724	* Tests if the guest is running in real mode or not.
725	*
726	* @returns true if in real mode, otherwise false.
727	* @param pCtx Current CPU context
728	*/
729	DECLINLINE(bool) CPUMIsGuestInRealModeEx(PCPUMCTX pCtx)
730	{
731	return !(pCtx->cr0 & X86_CR0_PE);
732	}
733
734	/**
735	* Tests if the guest is running in protected or not.
736	*
737	* @returns true if in protected mode, otherwise false.
738	* @param pVM The VM handle.
739	*/
740	DECLINLINE(bool) CPUMIsGuestInProtectedMode(PVMCPU pVCpu)
741	{
742	return !!(CPUMGetGuestCR0(pVCpu) & X86_CR0_PE);
743	}
744
745	/**
746	* Tests if the guest is running in paged protected or not.
747	*
748	* @returns true if in paged protected mode, otherwise false.
749	* @param pVM The VM handle.
750	*/
751	DECLINLINE(bool) CPUMIsGuestInPagedProtectedMode(PVMCPU pVCpu)
752	{
753	return (CPUMGetGuestCR0(pVCpu) & (X86_CR0_PE \| X86_CR0_PG)) == (X86_CR0_PE \| X86_CR0_PG);
754	}
755
756	/**
757	* Tests if the guest is running in paged protected or not.
758	*
759	* @returns true if in paged protected mode, otherwise false.
760	* @param pVM The VM handle.
761	*/
762	DECLINLINE(bool) CPUMIsGuestInPagedProtectedModeEx(PCPUMCTX pCtx)
763	{
764	return (pCtx->cr0 & (X86_CR0_PE \| X86_CR0_PG)) == (X86_CR0_PE \| X86_CR0_PG);
765	}
766
767	/**
768	* Tests if the guest is running in long mode or not.
769	*
770	* @returns true if in long mode, otherwise false.
771	* @param pVM The VM handle.
772	*/
773	DECLINLINE(bool) CPUMIsGuestInLongMode(PVMCPU pVCpu)
774	{
775	return (CPUMGetGuestEFER(pVCpu) & MSR_K6_EFER_LMA) == MSR_K6_EFER_LMA;
776	}
777
778	/**
779	* Tests if the guest is running in long mode or not.
780	*
781	* @returns true if in long mode, otherwise false.
782	* @param pCtx Current CPU context
783	*/
784	DECLINLINE(bool) CPUMIsGuestInLongModeEx(PCPUMCTX pCtx)
785	{
786	return (pCtx->msrEFER & MSR_K6_EFER_LMA) == MSR_K6_EFER_LMA;
787	}
788
789	/**
790	* Tests if the guest is running in 64 bits mode or not.
791	*
792	* @returns true if in 64 bits protected mode, otherwise false.
793	* @param pVM The VM handle.
794	* @param pCtx Current CPU context
795	*/
796	DECLINLINE(bool) CPUMIsGuestIn64BitCode(PVMCPU pVCpu, PCCPUMCTXCORE pCtx)
797	{
798	if (!CPUMIsGuestInLongMode(pVCpu))
799	return false;
800
801	return pCtx->csHid.Attr.n.u1Long;
802	}
803
804	/**
805	* Tests if the guest is running in 64 bits mode or not.
806	*
807	* @returns true if in 64 bits protected mode, otherwise false.
808	* @param pVM The VM handle.
809	* @param pCtx Current CPU context
810	*/
811	DECLINLINE(bool) CPUMIsGuestIn64BitCodeEx(PCCPUMCTX pCtx)
812	{
813	if (!(pCtx->msrEFER & MSR_K6_EFER_LMA))
814	return false;
815
816	return pCtx->csHid.Attr.n.u1Long;
817	}
818
819	/**
820	* Tests if the guest is running in PAE mode or not.
821	*
822	* @returns true if in PAE mode, otherwise false.
823	* @param pVM The VM handle.
824	*/
825	DECLINLINE(bool) CPUMIsGuestInPAEMode(PVMCPU pVCpu)
826	{
827	return ( CPUMIsGuestInPagedProtectedMode(pVCpu)
828	&& (CPUMGetGuestCR4(pVCpu) & X86_CR4_PAE)
829	&& !CPUMIsGuestInLongMode(pVCpu));
830	}
831
832	/**
833	* Tests if the guest is running in PAE mode or not.
834	*
835	* @returns true if in PAE mode, otherwise false.
836	* @param pCtx Current CPU context
837	*/
838	DECLINLINE(bool) CPUMIsGuestInPAEModeEx(PCPUMCTX pCtx)
839	{
840	return ( CPUMIsGuestInPagedProtectedModeEx(pCtx)
841	&& (pCtx->cr4 & X86_CR4_PAE)
842	&& !CPUMIsGuestInLongModeEx(pCtx));
843	}
844
845	/** @} */
846
847
848	/** @name Hypervisor Register Getters.
849	* @{ */
850	VMMDECL(RTSEL) CPUMGetHyperCS(PVMCPU pVCpu);
851	VMMDECL(RTSEL) CPUMGetHyperDS(PVMCPU pVCpu);
852	VMMDECL(RTSEL) CPUMGetHyperES(PVMCPU pVCpu);
853	VMMDECL(RTSEL) CPUMGetHyperFS(PVMCPU pVCpu);
854	VMMDECL(RTSEL) CPUMGetHyperGS(PVMCPU pVCpu);
855	VMMDECL(RTSEL) CPUMGetHyperSS(PVMCPU pVCpu);
856	#if 0 /* these are not correct. */
857	VMMDECL(uint32_t) CPUMGetHyperCR0(PVMCPU pVCpu);
858	VMMDECL(uint32_t) CPUMGetHyperCR2(PVMCPU pVCpu);
859	VMMDECL(uint32_t) CPUMGetHyperCR3(PVMCPU pVCpu);
860	VMMDECL(uint32_t) CPUMGetHyperCR4(PVMCPU pVCpu);
861	#endif
862	/** This register is only saved on fatal traps. */
863	VMMDECL(uint32_t) CPUMGetHyperEAX(PVMCPU pVCpu);
864	VMMDECL(uint32_t) CPUMGetHyperEBX(PVMCPU pVCpu);
865	/** This register is only saved on fatal traps. */
866	VMMDECL(uint32_t) CPUMGetHyperECX(PVMCPU pVCpu);
867	/** This register is only saved on fatal traps. */
868	VMMDECL(uint32_t) CPUMGetHyperEDX(PVMCPU pVCpu);
869	VMMDECL(uint32_t) CPUMGetHyperESI(PVMCPU pVCpu);
870	VMMDECL(uint32_t) CPUMGetHyperEDI(PVMCPU pVCpu);
871	VMMDECL(uint32_t) CPUMGetHyperEBP(PVMCPU pVCpu);
872	VMMDECL(uint32_t) CPUMGetHyperESP(PVMCPU pVCpu);
873	VMMDECL(uint32_t) CPUMGetHyperEFlags(PVMCPU pVCpu);
874	VMMDECL(uint32_t) CPUMGetHyperEIP(PVMCPU pVCpu);
875	VMMDECL(uint64_t) CPUMGetHyperRIP(PVMCPU pVCpu);
876	VMMDECL(uint32_t) CPUMGetHyperIDTR(PVMCPU pVCpu, uint16_t *pcbLimit);
877	VMMDECL(uint32_t) CPUMGetHyperGDTR(PVMCPU pVCpu, uint16_t *pcbLimit);
878	VMMDECL(RTSEL) CPUMGetHyperLDTR(PVMCPU pVCpu);
879	VMMDECL(RTGCUINTREG) CPUMGetHyperDR0(PVMCPU pVCpu);
880	VMMDECL(RTGCUINTREG) CPUMGetHyperDR1(PVMCPU pVCpu);
881	VMMDECL(RTGCUINTREG) CPUMGetHyperDR2(PVMCPU pVCpu);
882	VMMDECL(RTGCUINTREG) CPUMGetHyperDR3(PVMCPU pVCpu);
883	VMMDECL(RTGCUINTREG) CPUMGetHyperDR6(PVMCPU pVCpu);
884	VMMDECL(RTGCUINTREG) CPUMGetHyperDR7(PVMCPU pVCpu);
885	VMMDECL(void) CPUMGetHyperCtx(PVMCPU pVCpu, PCPUMCTX pCtx);
886	VMMDECL(uint32_t) CPUMGetHyperCR3(PVMCPU pVCpu);
887	/** @} */
888
889	/** @name Hypervisor Register Setters.
890	* @{ */
891	VMMDECL(void) CPUMSetHyperGDTR(PVMCPU pVCpu, uint32_t addr, uint16_t limit);
892	VMMDECL(void) CPUMSetHyperLDTR(PVMCPU pVCpu, RTSEL SelLDTR);
893	VMMDECL(void) CPUMSetHyperIDTR(PVMCPU pVCpu, uint32_t addr, uint16_t limit);
894	VMMDECL(void) CPUMSetHyperCR3(PVMCPU pVCpu, uint32_t cr3);
895	VMMDECL(void) CPUMSetHyperTR(PVMCPU pVCpu, RTSEL SelTR);
896	VMMDECL(void) CPUMSetHyperCS(PVMCPU pVCpu, RTSEL SelCS);
897	VMMDECL(void) CPUMSetHyperDS(PVMCPU pVCpu, RTSEL SelDS);
898	VMMDECL(void) CPUMSetHyperES(PVMCPU pVCpu, RTSEL SelDS);
899	VMMDECL(void) CPUMSetHyperFS(PVMCPU pVCpu, RTSEL SelDS);
900	VMMDECL(void) CPUMSetHyperGS(PVMCPU pVCpu, RTSEL SelDS);
901	VMMDECL(void) CPUMSetHyperSS(PVMCPU pVCpu, RTSEL SelSS);
902	VMMDECL(void) CPUMSetHyperESP(PVMCPU pVCpu, uint32_t u32ESP);
903	VMMDECL(int) CPUMSetHyperEFlags(PVMCPU pVCpu, uint32_t Efl);
904	VMMDECL(void) CPUMSetHyperEIP(PVMCPU pVCpu, uint32_t u32EIP);
905	VMMDECL(void) CPUMSetHyperDR0(PVMCPU pVCpu, RTGCUINTREG uDr0);
906	VMMDECL(void) CPUMSetHyperDR1(PVMCPU pVCpu, RTGCUINTREG uDr1);
907	VMMDECL(void) CPUMSetHyperDR2(PVMCPU pVCpu, RTGCUINTREG uDr2);
908	VMMDECL(void) CPUMSetHyperDR3(PVMCPU pVCpu, RTGCUINTREG uDr3);
909	VMMDECL(void) CPUMSetHyperDR6(PVMCPU pVCpu, RTGCUINTREG uDr6);
910	VMMDECL(void) CPUMSetHyperDR7(PVMCPU pVCpu, RTGCUINTREG uDr7);
911	VMMDECL(void) CPUMSetHyperCtx(PVMCPU pVCpu, const PCPUMCTX pCtx);
912	VMMDECL(int) CPUMRecalcHyperDRx(PVMCPU pVCpu);
913	/** @} */
914
915	VMMDECL(void) CPUMPushHyper(PVMCPU pVCpu, uint32_t u32);
916	VMMDECL(void) CPUMHyperSetCtxCore(PVMCPU pVCpu, PCPUMCTXCORE pCtxCore);
917	VMMDECL(int) CPUMQueryHyperCtxPtr(PVMCPU pVCpu, PCPUMCTX *ppCtx);
918	VMMDECL(PCCPUMCTXCORE) CPUMGetHyperCtxCore(PVMCPU pVCpu);
919	VMMDECL(PCPUMCTX) CPUMQueryGuestCtxPtr(PVMCPU pVCpu);
920	VMMDECL(PCCPUMCTXCORE) CPUMGetGuestCtxCore(PVMCPU pVCpu);
921	VMMDECL(void) CPUMSetGuestCtxCore(PVMCPU pVCpu, PCCPUMCTXCORE pCtxCore);
922	VMMDECL(int) CPUMRawEnter(PVMCPU pVCpu, PCPUMCTXCORE pCtxCore);
923	VMMDECL(int) CPUMRawLeave(PVMCPU pVCpu, PCPUMCTXCORE pCtxCore, int rc);
924	VMMDECL(uint32_t) CPUMRawGetEFlags(PVMCPU pVCpu, PCPUMCTXCORE pCtxCore);
925	VMMDECL(void) CPUMRawSetEFlags(PVMCPU pVCpu, PCPUMCTXCORE pCtxCore, uint32_t eflags);
926	VMMDECL(int) CPUMHandleLazyFPU(PVMCPU pVCpu);
927
928	/** @name Changed flags
929	* These flags are used to keep track of which important register that
930	* have been changed since last they were reset. The only one allowed
931	* to clear them is REM!
932	* @{
933	*/
934	#define CPUM_CHANGED_FPU_REM RT_BIT(0)
935	#define CPUM_CHANGED_CR0 RT_BIT(1)
936	#define CPUM_CHANGED_CR4 RT_BIT(2)
937	#define CPUM_CHANGED_GLOBAL_TLB_FLUSH RT_BIT(3)
938	#define CPUM_CHANGED_CR3 RT_BIT(4)
939	#define CPUM_CHANGED_GDTR RT_BIT(5)
940	#define CPUM_CHANGED_IDTR RT_BIT(6)
941	#define CPUM_CHANGED_LDTR RT_BIT(7)
942	#define CPUM_CHANGED_TR RT_BIT(8)
943	#define CPUM_CHANGED_SYSENTER_MSR RT_BIT(9)
944	#define CPUM_CHANGED_HIDDEN_SEL_REGS RT_BIT(10)
945	#define CPUM_CHANGED_CPUID RT_BIT(11)
946	#define CPUM_CHANGED_ALL (CPUM_CHANGED_FPU_REM\|CPUM_CHANGED_CR0\|CPUM_CHANGED_CR3\|CPUM_CHANGED_CR4\|CPUM_CHANGED_GDTR\|CPUM_CHANGED_IDTR\|CPUM_CHANGED_LDTR\|CPUM_CHANGED_TR\|CPUM_CHANGED_SYSENTER_MSR\|CPUM_CHANGED_HIDDEN_SEL_REGS\|CPUM_CHANGED_CPUID)
947	/** @} */
948
949	VMMDECL(unsigned) CPUMGetAndClearChangedFlagsREM(PVMCPU pVCpu);
950	VMMDECL(void) CPUMSetChangedFlags(PVMCPU pVCpu, uint32_t fChangedFlags);
951	VMMDECL(bool) CPUMSupportsFXSR(PVM pVM);
952	VMMDECL(bool) CPUMIsHostUsingSysEnter(PVM pVM);
953	VMMDECL(bool) CPUMIsHostUsingSysCall(PVM pVM);
954	VMMDECL(bool) CPUMIsGuestFPUStateActive(PVMCPU pVCPU);
955	VMMDECL(void) CPUMDeactivateGuestFPUState(PVMCPU pVCpu);
956	VMMDECL(bool) CPUMIsGuestDebugStateActive(PVMCPU pVCpu);
957	VMMDECL(void) CPUMDeactivateGuestDebugState(PVMCPU pVCpu);
958	VMMDECL(uint32_t) CPUMGetGuestCPL(PVMCPU pVCpu, PCPUMCTXCORE pCtxCore);
959	VMMDECL(bool) CPUMAreHiddenSelRegsValid(PVM pVM);
960
961	/**
962	* CPU modes.
963	*/
964	typedef enum CPUMMODE
965	{
966	/** The usual invalid zero entry. */
967	CPUMMODE_INVALID = 0,
968	/** Real mode. */
969	CPUMMODE_REAL,
970	/** Protected mode (32-bit). */
971	CPUMMODE_PROTECTED,
972	/** Long mode (64-bit). */
973	CPUMMODE_LONG
974	} CPUMMODE;
975
976	VMMDECL(CPUMMODE) CPUMGetGuestMode(PVMCPU pVCpu);
977
978
979	#ifdef IN_RING3
980	/** @defgroup grp_cpum_r3 The CPU Monitor(/Manager) API
981	* @ingroup grp_cpum
982	* @{
983	*/
984
985	VMMR3DECL(int) CPUMR3Init(PVM pVM);
986	VMMR3DECL(int) CPUMR3InitCPU(PVM pVM);
987	VMMR3DECL(void) CPUMR3Relocate(PVM pVM);
988	VMMR3DECL(int) CPUMR3Term(PVM pVM);
989	VMMR3DECL(int) CPUMR3TermCPU(PVM pVM);
990	VMMR3DECL(void) CPUMR3Reset(PVM pVM);
991	VMMR3DECL(void) CPUMR3ResetCpu(PVMCPU pVCpu);
992	# ifdef DEBUG
993	VMMR3DECL(void) CPUMR3SaveEntryCtx(PVM pVM);
994	# endif
995	VMMR3DECL(int) CPUMR3SetCR4Feature(PVM pVM, RTHCUINTREG fOr, RTHCUINTREG fAnd);
996
997	VMMR3DECL(RCPTRTYPE(PCCPUMCPUID)) CPUMR3GetGuestCpuIdStdRCPtr(PVM pVM);
998	VMMR3DECL(RCPTRTYPE(PCCPUMCPUID)) CPUMR3GetGuestCpuIdExtRCPtr(PVM pVM);
999	VMMR3DECL(RCPTRTYPE(PCCPUMCPUID)) CPUMR3GetGuestCpuIdCentaurRCPtr(PVM pVM);
1000	VMMR3DECL(RCPTRTYPE(PCCPUMCPUID)) CPUMR3GetGuestCpuIdDefRCPtr(PVM pVM);
1001
1002	/** @} */
1003	#endif /* IN_RING3 */
1004
1005	#ifdef IN_RC
1006	/** @defgroup grp_cpum_gc The CPU Monitor(/Manager) API
1007	* @ingroup grp_cpum
1008	* @{
1009	*/
1010
1011	/**
1012	* Calls a guest trap/interrupt handler directly
1013	* Assumes a trap stack frame has already been setup on the guest's stack!
1014	*
1015	* @param pRegFrame Original trap/interrupt context
1016	* @param selCS Code selector of handler
1017	* @param pHandler GC virtual address of handler
1018	* @param eflags Callee's EFLAGS
1019	* @param selSS Stack selector for handler
1020	* @param pEsp Stack address for handler
1021	*
1022	* This function does not return!
1023	*/
1024	DECLASM(void) CPUMGCCallGuestTrapHandler(PCPUMCTXCORE pRegFrame, uint32_t selCS, RTRCPTR pHandler, uint32_t eflags, uint32_t selSS, RTRCPTR pEsp);
1025	VMMRCDECL(void) CPUMGCCallV86Code(PCPUMCTXCORE pRegFrame);
1026
1027	/** @} */
1028	#endif /* IN_RC */
1029
1030	#ifdef IN_RING0
1031	/** @defgroup grp_cpum_r0 The CPU Monitor(/Manager) API
1032	* @ingroup grp_cpum
1033	* @{
1034	*/
1035	VMMR0DECL(int) CPUMR0Init(PVM pVM);
1036	VMMR0DECL(int) CPUMR0LoadGuestFPU(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx);
1037	VMMR0DECL(int) CPUMR0SaveGuestFPU(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx);
1038	VMMR0DECL(int) CPUMR0SaveGuestDebugState(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, bool fDR6);
1039	VMMR0DECL(int) CPUMR0LoadGuestDebugState(PVM pVM, PVMCPU pVCpu, PCPUMCTX pCtx, bool fDR6);
1040
1041	/** @} */
1042	#endif /* IN_RING0 */
1043
1044	/** @} */
1045	RT_C_DECLS_END
1046
1047
1048	#endif
1049

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/VBox/cpum.h@ 20374

Download in other formats: