Changeset 9937

Timestamp:

06/25/08 20:18:13 (5 months ago)

Author:

vboxsync

Message:

Main: Corrected getProcessorUsage() impl (docs, spacing etc).

Files:

• trunk/src/VBox/Main/HostImpl.cpp (modified) (5 diffs)
• trunk/src/VBox/Main/MachineImpl.cpp (modified) (9 diffs)
• trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (3 diffs)
• trunk/src/VBox/Main/include/HostImpl.h (modified) (3 diffs)
• trunk/src/VBox/Main/include/MachineImpl.h (modified) (4 diffs)

trunk/src/VBox/Main/HostImpl.cpp

@@ -169 +169 @@
-
-#ifdef VBOX_WITH_RESOURCE_USAGE_API
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-    }
-#endif /* VBOX_WITH_RESOURCE_USAGE_API */
@@ -184 +183 @@
-    return S_OK;
-}
-
-#ifdef VBOX_WITH_RESOURCE_USAGE_API
-void Host::staticSamplerCallback(PRTTIMER pTimer, void *pvUser, uint64_t iTick)
-{
-    ((Host*)pvUser)->usageSamplerCallback();
-}
-
-void Host::usageSamplerCallback()
-{
-    int rc = RTSystemProcessorGetUsageStats(&m_CpuStats);
-    if (RT_FAILURE(rc))
-    {
-        AssertMsgFailed(("Failed to get CPU stats, rc=%d!\n", rc));
-    }
-    //printf("Host::usageSamplerCallback: user=%u%% system=%u%% &m_CpuStats=%p this=%p\n",
-    //     m_CpuStats.u32User / 10000000, m_CpuStats.u32System / 10000000, &m_CpuStats, this);
-    //printf("user=%.2f system=%.2f idle=%.2f\n", m_CpuStats.u32User/10000000., m_CpuStats.u32System/10000000., m_CpuStats.u32Idle/10000000.);
-}
-#endif /* VBOX_WITH_RESOURCE_USAGE_API */
-
-/**
@@ -231 +211 @@
-
-#ifdef VBOX_WITH_RESOURCE_USAGE_API
-
-
-
-
-
-
-
+
+
+
+
+
-    }
-#endif /* VBOX_WITH_RESOURCE_USAGE_API */
@@ -1128 +1106 @@
-}
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-{
-#ifdef VBOX_WITH_RESOURCE_USAGE_API
-
-
-
+
+
+
+
+
+
-
-    return S_OK;
@@ -2745 +2715 @@
-#endif /* RT_OS_WINDOWS */
-
+#ifdef VBOX_WITH_RESOURCE_USAGE_API
+
+/* static */
+void Host::UsageSamplerCallback (PRTTIMER pTimer, void *pvUser, uint64_t iTick)
+{
+    AssertReturnVoid (pvUser != NULL);
+    static_cast <Host *> (pvUser)->usageSamplerCallback();
+}
+
+void Host::usageSamplerCallback()
+{
+    int vrc = RTSystemProcessorGetUsageStats (&mCpuStats);
+    AssertMsgRC (vrc, ("Failed to get CPU stats (%Rra)\n", vrc));
+
+//  LogFlowThisFunc (("user=%u%% system=%u%% &mCpuStats=%p\n",
+//                    mCpuStats.u32User / 10000000,
+//                    mCpuStats.u32System / 10000000, &mCpuStats);
+//  LogFlowThisFunc (("user=%.2f system=%.2f idle=%.2f\n", mCpuStats.u32User/10000000.,
+//                    mCpuStats.u32System/10000000., mCpuStats.u32Idle/10000000.);
+}
+
+#endif /* VBOX_WITH_RESOURCE_USAGE_API */
+

trunk/src/VBox/Main/MachineImpl.cpp

@@ -147 +147 @@
-    mSession.mPid = NIL_RTPROCESS;
-    mSession.mState = SessionState_Closed;
+
+#ifdef VBOX_WITH_RESOURCE_USAGE_API
+    mUsageSampler = NULL;
+#endif /* VBOX_WITH_RESOURCE_USAGE_API */
-}
-
@@ -498 +502 @@
-
-#ifdef VBOX_WITH_RESOURCE_USAGE_API
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-    }
-#endif /* VBOX_WITH_RESOURCE_USAGE_API */
@@ -635 +638 @@
-
-#ifdef VBOX_WITH_RESOURCE_USAGE_API
-
-
-
-
-
-
-
+
+
+
+
+
-    }
-#endif /* VBOX_WITH_RESOURCE_USAGE_API */
@@ -702 +703 @@
-    LogFlowThisFuncLeave();
-}
-
-#ifdef VBOX_WITH_RESOURCE_USAGE_API
-void Machine::staticSamplerCallback(PRTTIMER pTimer, void *pvUser, uint64_t iTick)
-{
-    ((Machine*)pvUser)->usageSamplerCallback();
-}
-
-void Machine::usageSamplerCallback()
-{
-    //LogFlowThisFunc(("mData->mSession.mPid = %u &m_CpuStats = %p)\n", mData->mSession.mPid, &m_CpuStats));
-    if (mData->mSession.mPid != NIL_RTPROCESS) {
-        int rc = RTProcessGetProcessorUsageStats(mData->mSession.mPid, &m_CpuStats);
-        if (RT_FAILURE(rc))
-        {
-            AssertMsgFailed(("Failed to get CPU stats, rc=%d!\n", rc));
-        }
-    }
-    else
-    {
-        m_CpuStats.u32User   = 0;
-        m_CpuStats.u32System = 0;
-    }
-//  printf("Machine::usageSamplerCallback: user=%u%% system=%u%% &m_CpuStats=%p this=%p\n",
-//         m_CpuStats.u32User / 10000000, m_CpuStats.u32System / 10000000, &m_CpuStats, this);
-    //printf("user=%.2f system=%.2f\n", m_CpuStats.u32User/10000000., m_CpuStats.u32System/10000000.);
-}
-#endif /* VBOX_WITH_RESOURCE_USAGE_API */
-
-
-// IMachine properties
@@ -2711 +2684 @@
- * session.  Otherwise read the value from machine extra data, where it is
- * stored between sessions.
- 
+
- * @note since the way this method is implemented depends on whether or not
- *       a session is currently open, we grab a write lock on the object, in
- *       order to ensure that the session state does not change during the
- *       call, and to force us to block if it is currently changing (either
- 
+
- */
-STDMETHODIMP Machine::GetConfigRegistryValue (INPTR BSTR aKey, BSTR *aValue)
@@ -2782 +2755 @@
- * session.  Otherwise read the value from machine extra data, where it is
- * stored between sessions.
- 
+
- * @note since the way this method is implemented depends on whether or not
- *       a session is currently open, we grab a write lock on the object, in
- *       order to ensure that the session state does not change during the
- *       call, and to force us to block if it is currently changing (either
- 
+
- */
-STDMETHODIMP Machine::SetConfigRegistryValue (INPTR BSTR aKey, INPTR BSTR aValue)
@@ -2844 +2817 @@
-}
-
-
-
-
-
-
-
-
-
-
-
-
+
-{
-#ifdef VBOX_WITH_RESOURCE_USAGE_API
-
-
-
-
+
+
+
+
+
+
+
+
+
-    return S_OK;
-#else /* !VBOX_WITH_RESOURCE_USAGE_API */
@@ -7354 +7322 @@
-}
-
+#ifdef VBOX_WITH_RESOURCE_USAGE_API
+
+/* static */
+void Machine::UsageSamplerCallback (PRTTIMER pTimer, void *pvUser, uint64_t iTick)
+{
+    AssertReturnVoid (pvUser != NULL);
+    static_cast <Machine *> (pvUser)->usageSamplerCallback();
+}
+
+void Machine::usageSamplerCallback()
+{
+//  LogFlowThisFunc (("mData->mSession.mPid = %u &mData->mCpuStats = %p)\n",
+//                    mData->mSession.mPid, &m_CpuStats));
+    if (mData->mSession.mPid != NIL_RTPROCESS)
+    {
+        int vrc = RTProcessGetProcessorUsageStats (mData->mSession.mPid,
+                                                   &mData->mCpuStats);
+        AssertMsgRC (vrc, ("Failed to get CPU stats (%Rra)\n", vrc));
+    }
+    else
+    {
+        mData->mCpuStats.u32User   = 0;
+        mData->mCpuStats.u32System = 0;
+    }
+//  LogFlowThisFunc (("user=%u%% system=%u%% &mData->mCpuStats=%p\n",
+//                    mData->mCpuStats.u32User / 10000000,
+//                    mData->mCpuStats.u32System / 10000000, &mData->mCpuStats));
+//  LogFlowThisFunc (("user=%.2f system=%.2f\n",
+//                    mData->mCpuStats.u32User/10000000., mData->mCpuStats.u32System/10000000.));
+}
+
+#endif /* VBOX_WITH_RESOURCE_USAGE_API */
+
-/////////////////////////////////////////////////////////////////////////////
-// SessionMachine class
@@ -8606 +8607 @@
-}
-
-/**
- * Obtains the results of the latest measurement of CPU usage by 
- * this machine. 
- * 
- * @returns error code.
- *
- * @param   user      out   % of CPU time spent in user mode.
- * @param   system    out   % of CPU time spent in kernel mode.
- * 
- */
-STDMETHODIMP SessionMachine::GetProcessorUsage(ULONG *user, ULONG *system)
-{
-    return mPeer->GetProcessorUsage(user, system);
-}
-
-// public methods only for internal purposes
-/////////////////////////////////////////////////////////////////////////////

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -3467 +3467 @@
-      </param>
-    </method>
-
+
-    <method name="getConfigRegistryValue">
-      <desc>
@@ -3506 +3506 @@
-    <method name="getProcessorUsage">
-      <desc>
-measured over all cores of all
-processors in the host system. 
-
-<note>
-  The maximum value is 1000000000 which means that all cores of all CPUs 
-  are completely used.
-</note>
+by this virtual machine measured
+over all cores of all processors in the host system.
+
+The values returned for each parameter are in range from <tt>0</tt> (the
+machine is powered off or does not load the CPUs at all) to
+<tt>1 000 000 000</tt> (all cores of all CPUs are fully in use by this
+machine).
-      </desc>
-      <param name="user" type="unsigned long" dir="out">
-The pecentage of processor time spent executing in user 
-
+
+Pecentage of processor time spent executing in user 
-        </desc>
-      </param>
-      <param name="system" type="unsigned long" dir="out">
-The pecentage of processor time spent executing in kernel
-
+
+Pecentage of processor time spent executing in kernel 
-        </desc>
-      </param>
@@ -5044 +5044 @@
-    <method name="getProcessorUsage">
-      <desc>
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-          are completely used.
-        </note>
-      </desc>
-      <param name="user" type="unsigned long" dir="out">
-The pecentage of processor time spent executing in user 
-
+
+Pecentage of processor time spent executing in user 
-        </desc>
-      </param>
-      <param name="system" type="unsigned long" dir="out">
-The pecentage of processor time spent executing in kernel
-
+
+Pecentage of processor time spent executing in kernel 
-        </desc>
-      </param>
-      <param name="idle" type="unsigned long" dir="out">
-
+
+
-        </desc>
-      </param>

trunk/src/VBox/Main/include/HostImpl.h

@@ -110 +110 @@
-    STDMETHOD(RemoveUSBDeviceFilter) (ULONG aPosition, IHostUSBDeviceFilter **aFilter);
-
-user, ULONG *system, ULONG *i
+aUser, ULONG *aSystem, ULONG *aI
-
-    // public methods only for internal purposes
@@ -170 +170 @@
-#endif
-
+#ifdef VBOX_WITH_RESOURCE_USAGE_API
+    /** Static timer callback. */
+    static void UsageSamplerCallback (PRTTIMER pTimer, void *pvUser, uint64_t iTick);
+    /** Member timer callback. */
+    void usageSamplerCallback();
+#endif /* VBOX_WITH_RESOURCE_USAGE_API */
+
-    ComObjPtr <VirtualBox, ComWeakRef> mParent;
-
@@ -180 +187 @@
-
-#ifdef VBOX_WITH_RESOURCE_USAGE_API
-    /** Static timer callback. */
-    static void staticSamplerCallback(PRTTIMER pTimer, void *pvUser, uint64_t iTick);
-    /** Member timer callback. */
-    void usageSamplerCallback();
-
-    /** Pointer to the usage sampling timer. */
-
-
-
+
-    /** Structure to hold processor usage stats. */
-_
+
-#endif /* VBOX_WITH_RESOURCE_USAGE_API */
-};

trunk/src/VBox/Main/include/MachineImpl.h

@@ -168 +168 @@
-        ComObjPtr <Snapshot> mFirstSnapshot;
-        ComObjPtr <Snapshot> mCurrentSnapshot;
+
+#ifdef VBOX_WITH_RESOURCE_USAGE_API
+        /** Pointer to the usage sampling timer. */
+        PRTTIMER mUsageSampler;
+        /** Structure to hold processor usage stats. */
+        RTPROCCPUUSAGESTATS mCpuStats;
+#endif /* VBOX_WITH_RESOURCE_USAGE_API */
-    };
-
@@ -713 +720 @@
-    void copyFrom (Machine *aThat);
-
+#ifdef VBOX_WITH_RESOURCE_USAGE_API
+    /** Static timer callback. */
+    static void UsageSamplerCallback (PRTTIMER pTimer, void *pvUser, uint64_t iTick);
+    /** Member timer callback. */
+    void usageSamplerCallback();
+#endif /* VBOX_WITH_RESOURCE_USAGE_API */
+
-    const InstanceType mType;
-
@@ -745 +759 @@
-    friend class SessionMachine;
-    friend class SnapshotMachine;
-
-#ifdef VBOX_WITH_RESOURCE_USAGE_API
-    /** Static timer callback. */
-    static void staticSamplerCallback(PRTTIMER pTimer, void *pvUser, uint64_t iTick);
-    /** Member timer callback. */
-    void usageSamplerCallback();
-    /** Pointer to the usage sampling timer. */
-    PRTTIMER m_pUsageSampler;
-    /** Structure to hold processor usage stats. */
-    RTPROCCPUUSAGESTATS m_CpuStats;
-#endif /* VBOX_WITH_RESOURCE_USAGE_API */
-};
-
@@ -826 +829 @@
-        IConsole *aInitiator, MachineState_T *aMachineState, IProgress **aProgress);
-
-    /* We need to override and call real Machine's method. */
-    STDMETHOD(GetProcessorUsage) (ULONG *user, ULONG *system);
-
-    // public methods only for internal purposes
-