Changeset 9380 in vbox for trunk/src

Timestamp:

Jun 4, 2008 11:44:45 AM (17 years ago)

Author:

vboxsync

Message:

Wrote a quick summary of CPUM for doxygen. Use UTINTxx_C(). Adjusted some spaces and comments.

File:

• trunk/src/VBox/VMM/CPUM.cpp (modified) (15 diffs)

trunk/src/VBox/VMM/CPUM.cpp

@@ -1 +1 @@
 /* $Id$ */
 /** @file
- * CPUM - CPU Monitor(/Manager)
+ * CPUM - CPU Monitor / Manager.
  */
 
@@ -20 +20 @@
  */
 
+/** @page pg_cpum
+ * The CPU Monitor / Manager keeps track of all the CPU registers. It is
+ * also responsible for lazy FPU handling and some of the context loading
+ * in raw mode.
+ *
+ * There are three CPU contexts, the most important one is the guest one (GC).
+ * When running in raw-mode (RC) there is a special hyper context for the VMM
+ * that floats around inside the guest address space. When running in raw-mode
+ * or when using 64-bit guests on a 32-bit host, CPUM also maintains a host
+ * context for saving and restoring registers accross world switches. This latter
+ * is done in cooperation with the world switcher (@see pg_vmm).
+ */
 
 /*******************************************************************************
@@ -58 +70 @@
 
 /**
- * What kind of cpu info dump to performe.
+ * What kind of cpu info dump to perform.
  */
 typedef enum CPUMDUMPTYPE
@@ -66 +78 @@
     CPUMDUMPTYPE_VERBOSE
 
-} CPUMDUMPTYPE, *PCPUMDUMPTYPE;
+} CPUMDUMPTYPE;
+/** Pointer to a cpu info dump type. */
+typedef CPUMDUMPTYPE *PCPUMDUMPTYPE;
 
 
@@ -73 +87 @@
 *******************************************************************************/
 static int cpumR3CpuIdInit(PVM pVM);
-static DECLCALLBACK(int) cpumR3Save(PVM pVM, PSSMHANDLE pSSM);
-static DECLCALLBACK(int) cpumR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t u32Version);
+static DECLCALLBACK(int)  cpumR3Save(PVM pVM, PSSMHANDLE pSSM);
+static DECLCALLBACK(int)  cpumR3Load(PVM pVM, PSSMHANDLE pSSM, uint32_t u32Version);
 static DECLCALLBACK(void) cpumR3InfoAll(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
 static DECLCALLBACK(void) cpumR3InfoGuest(PVM pVM, PCDBGFINFOHLP pHlp, const char *pszArgs);
@@ -147 +161 @@
     /* Bogus on AMD? */
     if (!pVM->cpum.s.CPUFeatures.edx.u1SEP)
-    {
         Log(("The CPU doesn't support SYSENTER/SYSEXIT!\n"));
-    }
 
     /*
@@ -171 +183 @@
         &&  uECX == X86_CPUID_VENDOR_AMD_ECX
         &&  uEDX == X86_CPUID_VENDOR_AMD_EDX)
-    {
         pVM->cpum.s.enmCPUVendor = CPUMCPUVENDOR_AMD;
-    }
     else if (    uEAX >= 1
-                &&  uEBX == X86_CPUID_VENDOR_INTEL_EBX
-                &&  uECX == X86_CPUID_VENDOR_INTEL_ECX
-                &&  uEDX == X86_CPUID_VENDOR_INTEL_EDX)
-    {
+             &&  uEBX == X86_CPUID_VENDOR_INTEL_EBX
+             &&  uECX == X86_CPUID_VENDOR_INTEL_ECX
+             &&  uEDX == X86_CPUID_VENDOR_INTEL_EDX)
         pVM->cpum.s.enmCPUVendor = CPUMCPUVENDOR_INTEL;
-    }
-    else /* @todo Via */
+    else /** @todo Via */
         pVM->cpum.s.enmCPUVendor = CPUMCPUVENDOR_UNKNOWN;
 
@@ -502 +510 @@
 CPUMR3DECL(int) CPUMR3Term(PVM pVM)
 {
-    /** @todo */
+    /** @todo ? */
     return 0;
 }
@@ -530 +538 @@
 
     pCtx->cs                        = 0xf000;
-    pCtx->csHid.u32Base             = 0xffff0000;
+    pCtx->csHid.u32Base             = UINT32_C(0xffff0000);
     pCtx->csHid.u32Limit            = 0x0000ffff;
     pCtx->csHid.Attr.n.u1DescType   = 1; /* code/data segment */
@@ -572 +580 @@
     pCtx->trHid.Attr.n.u4Type       = X86_SEL_TYPE_SYS_286_TSS_BUSY;
 
-    pCtx->dr6                       = 0xFFFF0FF0;
+    pCtx->dr6                       = UINT32_C(0xFFFF0FF0);
     pCtx->dr7                       = 0x400;
 
@@ -579 +587 @@
 
     /* Init PAT MSR */
-    pCtx->msrPAT                    = 0x0007040600070406ULL; /* @todo correct? */
-}
-
+    pCtx->msrPAT                    = UINT64_C(0x0007040600070406); /** @todo correct? */
+}
 
 
@@ -1034 +1041 @@
 #endif
 }
+
 
 /**
@@ -1869 +1877 @@
 }
 
-
 #ifdef DEBUG
+
 /**
  * Disassemble an instruction and dump it to the log
@@ -1911 +1919 @@
 }
 
-#endif
+#endif /* DEBUG */
 
 #ifdef DEBUG
@@ -1923 +1931 @@
     pVM->cpum.s.GuestEntry = pVM->cpum.s.Guest;
 }
-#endif
+#endif /* DEBUG */