Changeset 11583 in vbox for trunk/src/VBox/Main

Timestamp:

Aug 22, 2008 7:05:15 PM (16 years ago)

Author:

vboxsync

Message:

PerfAPI: New attribute PerformanceMetric::description

Location:

trunk/src/VBox/Main

Files:

• HostImpl.cpp (modified) (1 diff)
• MachineImpl.cpp (modified) (1 diff)
• Performance.cpp (modified) (1 diff)
• PerformanceImpl.cpp (modified) (2 diffs)
• idl/VirtualBox.xidl (modified) (2 diffs)
• include/Performance.h (modified) (2 diffs)
• include/PerformanceImpl.h (modified) (2 diffs)

trunk/src/VBox/Main/HostImpl.cpp

@@ -2736 +2736 @@
     pm::MetricFactory *metricFactory = aCollector->getMetricFactory();
     /* Create sub metrics */
-    pm::SubMetric *cpuLoadUser   = new pm::SubMetric ("CPU/Load/User");
-    pm::SubMetric *cpuLoadKernel = new pm::SubMetric ("CPU/Load/Kernel");
-    pm::SubMetric *cpuLoadIdle   = new pm::SubMetric ("CPU/Load/Idle");
-    pm::SubMetric *cpuMhzSM      = new pm::SubMetric ("CPU/MHz");
-    pm::SubMetric *ramUsageTotal = new pm::SubMetric ("RAM/Usage/Total");
-    pm::SubMetric *ramUsageUsed  = new pm::SubMetric ("RAM/Usage/Used");
-    pm::SubMetric *ramUsageFree  = new pm::SubMetric ("RAM/Usage/Free");
+    pm::SubMetric *cpuLoadUser   = new pm::SubMetric ("CPU/Load/User",
+        "Percentage of processor time spent in user mode.");
+    pm::SubMetric *cpuLoadKernel = new pm::SubMetric ("CPU/Load/Kernel",
+        "Percentage of processor time spent in kernel mode.");
+    pm::SubMetric *cpuLoadIdle   = new pm::SubMetric ("CPU/Load/Idle",
+        "Percentage of processor time spent idling.");
+    pm::SubMetric *cpuMhzSM      = new pm::SubMetric ("CPU/MHz",
+        "Average of current frequency of all processors.");
+    pm::SubMetric *ramUsageTotal = new pm::SubMetric ("RAM/Usage/Total",
+        "Total physical memory installed.");
+    pm::SubMetric *ramUsageUsed  = new pm::SubMetric ("RAM/Usage/Used",
+        "Physical memory currently occupied.");
+    pm::SubMetric *ramUsageFree  = new pm::SubMetric ("RAM/Usage/Free",
+        "Physical memory currently available to applications.");
     /* Create and register base metrics */
     IUnknown *objptr;

trunk/src/VBox/Main/MachineImpl.cpp

@@ -7583 +7583 @@
     pm::MetricFactory *metricFactory = aCollector->getMetricFactory();
     /* Create sub metrics */
-    pm::SubMetric *cpuLoadUser = new pm::SubMetric ("CPU/Load/User");
-    pm::SubMetric *cpuLoadKernel = new pm::SubMetric ("CPU/Load/Kernel");
-    pm::SubMetric *ramUsageUsed  = new pm::SubMetric ("RAM/Usage/Used");
+    pm::SubMetric *cpuLoadUser = new pm::SubMetric ("CPU/Load/User",
+        "Percentage of processor time spent in user mode by VM process.");
+    pm::SubMetric *cpuLoadKernel = new pm::SubMetric ("CPU/Load/Kernel",
+        "Percentage of processor time spent in kernel mode by VM process.");
+    pm::SubMetric *ramUsageUsed  = new pm::SubMetric ("RAM/Usage/Used",
+        "Size of resident portion of VM process in memory.");
     /* Create and register base metrics */
     IUnknown *objptr;

trunk/src/VBox/Main/Performance.cpp

@@ -26 +26 @@
  *
  * 1) Detection of erroneous metric names
- * 2) Wildcards in metric names
- * 3) Darwin backend
- * 4) [OS/2 backend]
  */
 

trunk/src/VBox/Main/PerformanceImpl.cpp

@@ -510 +510 @@
 HRESULT PerformanceMetric::init (pm::Metric *aMetric)
 {
-    m.name   = aMetric->getName();
-    m.object = aMetric->getObject();
-    m.period = aMetric->getPeriod();
-    m.count  = aMetric->getLength();
-    m.unit   = aMetric->getUnit();
-    m.min    = aMetric->getMinValue();
-    m.max    = aMetric->getMaxValue();
+    m.name        = aMetric->getName();
+    m.object      = aMetric->getObject();
+    m.description = aMetric->getDescription();
+    m.period      = aMetric->getPeriod();
+    m.count       = aMetric->getLength();
+    m.unit        = aMetric->getUnit();
+    m.min         = aMetric->getMinValue();
+    m.max         = aMetric->getMaxValue();
     return S_OK;
 }
@@ -539 +540 @@
 }
 
+STDMETHODIMP PerformanceMetric::COMGETTER(Description) (BSTR *aDescription)
+{
+    m.description.cloneTo (aDescription);
+    return S_OK;
+}
+
 STDMETHODIMP PerformanceMetric::COMGETTER(Period) (ULONG *aPeriod)
 {

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

@@ -10320 +10320 @@
   <interface
     name="IPerformanceMetric" extends="$unknown"
-    uuid="50831d4c-ed55-4221-836c-87b487d3b44a" wsmap="managed"
+    uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
   >
     <desc>
@@ -10336 +10336 @@
       <desc>
         Object this metric belongs to.
+      </desc>
+    </attribute>
+
+    <attribute name="description" type="wstring" readonly="yes">
+      <desc>
+        Textual description of the metric.
       </desc>
     </attribute>

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

@@ -53 +53 @@
     {
     public:
-        SubMetric(const char *name)
-        : mName(name) {};
+        SubMetric(const char *name, const char *description)
+        : mName(name), mDescription(description) {};
         void query(ULONG *data);
         const char *getName() { return mName; };
+        const char *getDescription() { return mDescription; };
     private:
         const char *mName;
+        const char *mDescription;
     };
 
@@ -271 +273 @@
         const char *getName() { return mName.c_str(); };
         ComPtr<IUnknown> getObject() { return mBaseMetric->getObject(); };
+        const char *getDescription()
+            { return mAggregate ? "" : mSubMetric->getDescription(); };
         const char *getUnit() { return mBaseMetric->getUnit(); };
         ULONG getMinValue() { return mBaseMetric->getMinValue(); };
         ULONG getMaxValue() { return mBaseMetric->getMaxValue(); };
         ULONG getPeriod() { return mBaseMetric->getPeriod(); };
-        ULONG getLength() { return mAggregate ? 1 : mBaseMetric->getLength(); };
+        ULONG getLength()
+            { return mAggregate ? 1 : mBaseMetric->getLength(); };
         void query(ULONG **data, ULONG *count);
 

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

@@ -73 +73 @@
     STDMETHOD(COMGETTER(MetricName)) (BSTR *aMetricName);
     STDMETHOD(COMGETTER(Object)) (IUnknown **anObject);
+    STDMETHOD(COMGETTER(Description)) (BSTR *aDescription);
     STDMETHOD(COMGETTER(Period)) (ULONG *aPeriod);
     STDMETHOD(COMGETTER(Count)) (ULONG *aCount);
@@ -95 +96 @@
         Bstr             name;
         ComPtr<IUnknown> object;
+        Bstr             description;
         ULONG            period;
         ULONG            count;