Changeset 10534 in vbox for trunk/include/iprt/system.h

Timestamp:

Jul 11, 2008 3:21:53 PM (16 years ago)

Author:

vboxsync

Message:

Backed out Performance API changes.

File:

• trunk/include/iprt/system.h (modified) (2 diffs)

trunk/include/iprt/system.h

@@ -34 +34 @@
 #include <iprt/types.h>
 
+#define IPRT_USAGE_MULTIPLIER   UINT64_C(1000000000)
+
+/**
+ * This structure holds both computed and raw values of overall CPU load counters.
+ *
+ * @todo r=bird: What does these values mean?
+ *
+ *               Also, I no longer use 'u32', 'u16', 'u8', 'u64', etc unless this information
+ *               is really important for the user. So, unless there is a better prefix just
+ *               stick to 'u' here.
+ *
+ *               The name of the struct should include the prefix or a shortened
+ *               version of it: RTSYSCPUUSAGESTATS
+ *
+ *               Also, I'd sugest calling it RTSYSCPULOADSTATS, replacing 'usage' with 'load',
+ *               no particular reason, other than that it is easier to read in the (silly)
+ *               condensed form we use for typedefs here.
+ *
+ *               Finally, I'm wondering how portable this is. I'd like to see what APIs are
+ *               available on the important systems (Windows, Solaris, Linux) and compare
+ *               the kind of info they return. This should be done in the defect *before*
+ *               any of the above, please.
+ */
+typedef struct RTSYSCPUUSAGESTATS
+{
+    uint32_t u32User;
+    uint32_t u32System;
+    uint32_t u32Idle;
+    /* Internal raw counter values. */
+    uint32_t u32RawUser;
+    uint32_t u32RawNice;
+    uint32_t u32RawSystem;
+    uint32_t u32RawIdle;
+} RTCPUUSAGESTATS;
+typedef RTCPUUSAGESTATS *PRTCPUUSAGESTATS;
+
+/* This structure holds both computed and raw values of per-VM CPU load counters. */
+typedef struct
+{
+    uint32_t u32User;
+    uint32_t u32System;
+    /* Internal raw counter values. */
+    uint64_t u64RawTotal;
+    uint32_t u32RawProcUser;
+    uint32_t u32RawProcSystem;
+} RTPROCCPUUSAGESTATS;
+typedef RTPROCCPUUSAGESTATS *PRTPROCCPUUSAGESTATS;
+
 
 __BEGIN_DECLS
@@ -60 +108 @@
 RTDECL(uint64_t) RTSystemProcessorGetActiveMask(void);
 
+/**
+ * Gets the current figures of overall system processor usage.
+ *
+ * @remarks To get meaningful stats this function has to be
+ *          called twice with a bit of delay between calls. This
+ *          is due to the fact that at least two samples of
+ *          system usage stats are needed to calculate the load.
+ *
+ * @returns IPRT status code.
+ * @param   pStats  Pointer to the structure that contains the
+ *                  results. Note that this structure is
+ *                  modified with each call to this function and
+ *                  is used to provide both in and out values.
+ * @todo r=bird: Change to RTSystemGetCpuLoadStats.
+ */
+RTDECL(int) RTSystemProcessorGetUsageStats(PRTCPUUSAGESTATS pStats);
+
+/**
+ * Gets the current processor usage for a partucilar process.
+ *
+ * @remarks To get meaningful stats this function has to be
+ *          called twice with a bit of delay between calls. This
+ *          is due to the fact that at least two samples of
+ *          system usage stats are needed to calculate the load.
+ *
+ * @returns IPRT status code.
+ * @param   pid     VM process id.
+ * @param   pStats  Pointer to the structure that contains the
+ *                  results. Note that this structure is
+ *                  modified with each call to this function and
+ *                  is used to provide both in and out values.
+ *
+ * @todo    Perharps this function should be moved somewhere
+ *          else.
+ * @todo    r=bird: Yes is should, iprt/proc.h. RTProcGetCpuLoadStats.
+ */
+RTDECL(int) RTProcessGetProcessorUsageStats(RTPROCESS pid, PRTPROCCPUUSAGESTATS pStats);
+
 /** @} */