Changeset 52764 in vbox

Timestamp:

Sep 16, 2014 3:57:03 PM (10 years ago)

Author:

vboxsync

Message:

@cfgm adjustments.

Location:

trunk/src/VBox/VMM

Files:

• VMMR3/CPUM.cpp (modified) (5 diffs)
• VMMR3/GIM.cpp (modified) (2 diffs)
• VMMR3/MM.cpp (modified) (4 diffs)
• VMMR3/TM.cpp (modified) (10 diffs)
• VMMR3/VMM.cpp (modified) (2 diffs)
• include/PGMInternal.h (modified) (2 diffs)
• include/TMInternal.h (modified) (1 diff)

trunk/src/VBox/VMM/VMMR3/CPUM.cpp

@@ -1068 +1068 @@
      * Read the configuration.
      */
-    /** @cfgm{CPUM/SyntheticCpu, boolean, false}
+    /** @cfgm{/CPUM/SyntheticCpu, boolean, false}
      * Enables the Synthetic CPU.  The Vendor ID and Processor Name are
      * completely overridden by VirtualBox custom strings.  Some
@@ -1078 +1078 @@
     AssertRCReturn(rc, rc);
 
-    /** @cfgm{CPUM/PortableCpuIdLevel, 8-bit, 0, 3, 0}
+    /** @cfgm{/CPUM/PortableCpuIdLevel, 8-bit, 0, 3, 0}
      * When non-zero CPUID features that could cause portability issues will be
      * stripped.  The higher the value the more features gets stripped.  Higher
@@ -1086 +1086 @@
     AssertLogRelRCReturn(rc, rc);
 
-    /** @cfgm{CPUM/GuestCpuName, string}
+    /** @cfgm{/CPUM/GuestCpuName, string}
      * The name of the CPU we're to emulate.  The default is the host CPU.
      * Note! CPUs other than "host" one is currently unsupported. */
@@ -1158 +1158 @@
              : rc;
 
-    /** @cfgm{CPUM/MSRs/[Name]/[First|Last|Type|Value|...],}
+    /** @cfgm{/CPUM/MSRs/[Name]/[First|Last|Type|Value|...],}
      * Overrides the guest MSRs.
      */
     rc = cpumR3LoadMsrOverrides(pVM, CFGMR3GetChild(pCpumCfg, "MSRs"));
 
-    /** @cfgm{CPUM/HostCPUID/[000000xx|800000xx|c000000x]/[eax|ebx|ecx|edx],32-bit}
+    /** @cfgm{/CPUM/HostCPUID/[000000xx|800000xx|c000000x]/[eax|ebx|ecx|edx],32-bit}
      * Overrides the CPUID leaf values (from the host CPU usually) used for
      * calculating the guest CPUID leaves.  This can be used to preserve the CPUID
@@ -1712 +1712 @@
      * MSR fudging.
      */
-    /** @cfgm{CPUM/FudgeMSRs, boolean, true}
+    /** @cfgm{/CPUM/FudgeMSRs, boolean, true}
      * Fudges some common MSRs if not present in the selected CPU database entry.
      * This is for trying to keep VMs running when moved between different hosts

trunk/src/VBox/VMM/VMMR3/GIM.cpp

@@ -101 +101 @@
     PCFGMNODE pCfgNode = CFGMR3GetChild(CFGMR3GetRoot(pVM), "GIM/");
 
-    /** @cfgm{GIM/Provider, string}
+    /** @cfgm{/GIM/Provider, string}
      * The name of the GIM provider. The default is "none". */
     char szProvider[64];
@@ -107 +107 @@
     AssertLogRelRCReturn(rc, rc);
 
-    /** @cfgm{GIM/Version, uint32_t}
+    /** @cfgm{/GIM/Version, uint32_t}
      * The interface version. The default is 0, which means "provide the most
      * up-to-date implementation". */

trunk/src/VBox/VMM/VMMR3/MM.cpp

@@ -309 +309 @@
     }
 
-    /** @cfgm{RamSize, uint64_t, 0, 16TB, 0}
+    /** @cfgm{/RamSize, uint64_t, 0, 16TB, 0}
      * Specifies the size of the base RAM that is to be set up during
      * VM initialization.
@@ -324 +324 @@
     pVM->mm.s.cbRamBase = cbRam;
 
-    /** @cfgm{RamHoleSize, uint32_t, 0, 4032MB, 512MB}
+    /** @cfgm{/RamHoleSize, uint32_t, 0, 4032MB, 512MB}
      * Specifies the size of the memory hole. The memory hole is used
      * to avoid mapping RAM to the range normally used for PCI memory regions.
@@ -343 +343 @@
         Log(("MM: %RU64 bytes of RAM with a hole at %RU64 up to 4GB.\n", cbRam, offRamHole));
 
-    /** @cfgm{MM/Policy, string, no overcommitment}
+    /** @cfgm{/MM/Policy, string, no overcommitment}
      * Specifies the policy to use when reserving memory for this VM. The recognized
      * value is 'no overcommitment' (default). See GMMPOLICY.
@@ -363 +363 @@
         AssertMsgFailedReturn(("Configuration error: Failed to query string \"MM/Policy\", rc=%Rrc.\n", rc), rc);
 
-    /** @cfgm{MM/Priority, string, normal}
+    /** @cfgm{/MM/Priority, string, normal}
      * Specifies the memory priority of this VM. The priority comes into play when the
      * system is overcommitted and the VMs needs to be milked for memory. The recognized

trunk/src/VBox/VMM/VMMR3/TM.cpp

@@ -356 +356 @@
     }
 
-    /** @cfgm{TM/TSCTicksPerSecond, uint32_t, Current TSC frequency from GIP}
+    /** @cfgm{/TM/TSCTicksPerSecond, uint32_t, Current TSC frequency from GIP}
      * The number of TSC ticks per second (i.e. the TSC frequency). This will
      * override TSCUseRealTSC, TSCVirtualized and MaybeUseOffsettedHostTSC.
@@ -385 +385 @@
     }
 
-    /** @cfgm{TM/TSCTiedToExecution, bool, false}
+    /** @cfgm{/TM/TSCTiedToExecution, bool, false}
      * Whether the TSC should be tied to execution. This will exclude most of the
      * virtualization overhead, but will by default include the time spent in the
@@ -404 +404 @@
     }
 
-    /** @cfgm{TM/TSCNotTiedToHalt, bool, true}
+    /** @cfgm{/TM/TSCNotTiedToHalt, bool, true}
      * For overriding the default of TM/TSCTiedToExecution, i.e. set this to false
      * to make the TSC freeze during HLT. */
@@ -425 +425 @@
      * Configure the timer synchronous virtual time.
      */
-    /** @cfgm{TM/ScheduleSlack, uint32_t, ns, 0, UINT32_MAX, 100000}
+    /** @cfgm{/TM/ScheduleSlack, uint32_t, ns, 0, UINT32_MAX, 100000}
      * Scheduling slack when processing timers. */
     rc = CFGMR3QueryU32(pCfgHandle, "ScheduleSlack", &pVM->tm.s.u32VirtualSyncScheduleSlack);
@@ -434 +434 @@
                           N_("Configuration error: Failed to querying 32-bit integer value \"ScheduleSlack\""));
 
-    /** @cfgm{TM/CatchUpStopThreshold, uint64_t, ns, 0, UINT64_MAX, 500000}
+    /** @cfgm{/TM/CatchUpStopThreshold, uint64_t, ns, 0, UINT64_MAX, 500000}
      * When to stop a catch-up, considering it successful. */
     rc = CFGMR3QueryU64(pCfgHandle, "CatchUpStopThreshold", &pVM->tm.s.u64VirtualSyncCatchUpStopThreshold);
@@ -443 +443 @@
                           N_("Configuration error: Failed to querying 64-bit integer value \"CatchUpStopThreshold\""));
 
-    /** @cfgm{TM/CatchUpGiveUpThreshold, uint64_t, ns, 0, UINT64_MAX, 60000000000}
+    /** @cfgm{/TM/CatchUpGiveUpThreshold, uint64_t, ns, 0, UINT64_MAX, 60000000000}
      * When to give up a catch-up attempt. */
     rc = CFGMR3QueryU64(pCfgHandle, "CatchUpGiveUpThreshold", &pVM->tm.s.u64VirtualSyncCatchUpGiveUpThreshold);
@@ -453 +453 @@
 
 
-    /** @cfgm{TM/CatchUpPrecentage[0..9], uint32_t, %, 1, 2000, various}
+    /** @cfgm{/TM/CatchUpPrecentage[0..9], uint32_t, %, 1, 2000, various}
      * The catch-up percent for a given period.  */
-    /** @cfgm{TM/CatchUpStartThreshold[0..9], uint64_t, ns, 0, UINT64_MAX}
+    /** @cfgm{/TM/CatchUpStartThreshold[0..9], uint64_t, ns, 0, UINT64_MAX}
      * The catch-up period threshold, or if you like, when a period starts.  */
 #define TM_CFG_PERIOD(iPeriod, DefStart, DefPct) \
@@ -493 +493 @@
      * Configure real world time (UTC).
      */
-    /** @cfgm{TM/UTCOffset, int64_t, ns, INT64_MIN, INT64_MAX, 0}
+    /** @cfgm{/TM/UTCOffset, int64_t, ns, INT64_MIN, INT64_MAX, 0}
      * The UTC offset. This is used to put the guest back or forwards in time.  */
     rc = CFGMR3QueryS64(pCfgHandle, "UTCOffset", &pVM->tm.s.offUTC);
@@ -505 +505 @@
      * Setup the warp drive.
      */
-    /** @cfgm{TM/WarpDrivePercentage, uint32_t, %, 0, 20000, 100}
+    /** @cfgm{/TM/WarpDrivePercentage, uint32_t, %, 0, 20000, 100}
      * The warp drive percentage, 100% is normal speed.  This is used to speed up
      * or slow down the virtual clock, which can be useful for fast forwarding
@@ -562 +562 @@
      * Start the timer (guard against REM not yielding).
      */
-    /** @cfgm{TM/TimerMillies, uint32_t, ms, 1, 1000, 10}
+    /** @cfgm{/TM/TimerMillies, uint32_t, ms, 1, 1000, 10}
      * The watchdog timer interval.  */
     uint32_t u32Millies;

trunk/src/VBox/VMM/VMMR3/VMM.cpp

@@ -171 +171 @@
     pVM->vmm.s.hEvtRendezvousDoneCaller         = NIL_RTSEMEVENT;
 
-    /** @cfgm{YieldEMTInterval, uint32_t, 1, UINT32_MAX, 23, ms}
+    /** @cfgm{/YieldEMTInterval, uint32_t, 1, UINT32_MAX, 23, ms}
      * The EMT yield interval.  The EMT yielding is a hack we employ to play a
      * bit nicer with the rest of the system (like for instance the GUI).
@@ -180 +180 @@
 
 
-    /** @cfgm{VMM/UsePeriodicPreemptionTimers, boolean, true}
+    /** @cfgm{/VMM/UsePeriodicPreemptionTimers, boolean, true}
      * Controls whether we employ per-cpu preemption timers to limit the time
      * spent executing guest code.  This option is not available on all

trunk/src/VBox/VMM/include/PGMInternal.h

@@ -3106 +3106 @@
     int32_t                         offVCpuPGM;
 
-    /** @cfgm{RamPreAlloc, boolean, false}
+    /** @cfgm{/RamPreAlloc, boolean, false}
      * Indicates whether the base RAM should all be allocated before starting
      * the VM (default), or if it should be allocated when first written to.
@@ -3315 +3315 @@
         /** The number of mapped chunks. */
         uint32_t                    c;
-        /** The maximum number of mapped chunks.
-         * @cfgm    PGM/MaxRing3Chunks */
+        /** @cfgm{/PGM/MaxRing3Chunks, uint32_t, host dependent}
+         * The maximum number of mapped chunks.  On 64-bit this is unlimited by default,
+         * on 32-bit it defaults to 1 or 3 GB depending on the host. */
         uint32_t                    cMax;
         /** The current time.  This is incremented whenever a chunk is inserted. */

trunk/src/VBox/VMM/include/TMInternal.h

@@ -446 +446 @@
     /** Alignment */
     bool                        afAlignment2[3];
-    /** @cfgm{TM/HostHzMax, uint32_t, Hz, 0, UINT32_MAX, 20000}
+    /** @cfgm{/TM/HostHzMax, uint32_t, Hz, 0, UINT32_MAX, 20000}
      * The max host Hz frequency hint returned by TMCalcHostTimerFrequency.  */
     uint32_t                    cHostHzMax;
-    /** @cfgm{TM/HostHzFudgeFactorTimerCpu, uint32_t, Hz, 0, UINT32_MAX, 111}
+    /** @cfgm{/TM/HostHzFudgeFactorTimerCpu, uint32_t, Hz, 0, UINT32_MAX, 111}
      * The number of Hz TMCalcHostTimerFrequency adds for the timer CPU.  */
     uint32_t                    cPctHostHzFudgeFactorTimerCpu;
-    /** @cfgm{TM/HostHzFudgeFactorOtherCpu, uint32_t, Hz, 0, UINT32_MAX, 110}
+    /** @cfgm{/TM/HostHzFudgeFactorOtherCpu, uint32_t, Hz, 0, UINT32_MAX, 110}
      * The number of Hz TMCalcHostTimerFrequency adds for the other CPUs. */
     uint32_t                    cPctHostHzFudgeFactorOtherCpu;
-    /** @cfgm{TM/HostHzFudgeFactorCatchUp100, uint32_t, Hz, 0, UINT32_MAX, 300}
+    /** @cfgm{/TM/HostHzFudgeFactorCatchUp100, uint32_t, Hz, 0, UINT32_MAX, 300}
      *  The fudge factor (expressed in percent) that catch-up percentages below
      * 100% is multiplied by. */
     uint32_t                    cPctHostHzFudgeFactorCatchUp100;
-    /** @cfgm{TM/HostHzFudgeFactorCatchUp200, uint32_t, Hz, 0, UINT32_MAX, 250}
+    /** @cfgm{/TM/HostHzFudgeFactorCatchUp200, uint32_t, Hz, 0, UINT32_MAX, 250}
      * The fudge factor (expressed in percent) that catch-up percentages
      * 100%-199% is multiplied by. */
     uint32_t                    cPctHostHzFudgeFactorCatchUp200;
-    /** @cfgm{TM/HostHzFudgeFactorCatchUp400, uint32_t, Hz, 0, UINT32_MAX, 200}
+    /** @cfgm{/TM/HostHzFudgeFactorCatchUp400, uint32_t, Hz, 0, UINT32_MAX, 200}
      * The fudge factor (expressed in percent) that catch-up percentages
      * 200%-399% is multiplied by. */