Changeset 27080 in vbox for trunk/src/VBox/Additions/common/VBoxGuestLib

Timestamp:

Mar 5, 2010 12:49:22 PM (15 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

58404

Message:

VBoxGuestR3LibMisc.cpp,VBoxGuestLib.h: minor adjustments.

File:

• trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibMisc.cpp (modified) (17 diffs)

trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibMisc.cpp

@@ -39 +39 @@
 #include "VBGLR3Internal.h"
 
+/** @todo Split this file up so we can drop most of the VBOX_VBGLR3_XFREE86
+ *        #ifdef'ing. */
 
 /**
@@ -48 +50 @@
  * immediately and return those events.
  *
- * @returns IPRT status code
+ * @returns IPRT status code.
  *
  * @param   fMask       The events we want to wait for, or-ed together.
@@ -74 +76 @@
     {
 #if !defined(VBOX_VBGLR3_XFREE86) && !defined(RT_OS_WINDOWS)
-        AssertMsg(waitEvent.u32Result == VBOXGUEST_WAITEVENT_OK, ("%d rc=%d\n", waitEvent.u32Result, rc));
+        AssertMsg(waitEvent.u32Result == VBOXGUEST_WAITEVENT_OK, ("%d rc=%Rrc\n", waitEvent.u32Result, rc));
 #endif
         if (pfEvents)
@@ -93 +95 @@
  *
  * Can be used in combination with a termination flag variable for interrupting
- * event loops. Avoiding race conditions is the responsibility of the caller.
- *
- * @returns IPRT status code
+ * event loops.  Avoiding race conditions is the responsibility of the caller.
+ *
+ * @returns IPRT status code.
  */
 VBGLR3DECL(int) VbglR3InterruptEventWaits(void)
@@ -106 +108 @@
  * Write to the backdoor logger from ring 3 guest code.
  *
- * @returns IPRT status code
+ * @returns IPRT status code.
+ *
+ * @param   pch     The string to log.  Does not need to be terminated.
+ * @param   cb      The number of byte to log.
+ * @todo    cb -> cch.
  *
  * @remarks This currently does not accept more than 255 bytes of data at
@@ -161 +167 @@
  * Change the IRQ filter mask.
  *
- * @returns IPRT status code
+ * @returns IPRT status code.
  * @param   fOr     The OR mask.
  * @param   fNo     The NOT mask.
@@ -177 +183 @@
  * Report a change in the capabilities that we support to the host.
  *
- * @returns IPRT status value
+ * @returns IPRT status code.
  * @param   fOr     Capabilities which have been added.
  * @param   fNot    Capabilities which have been removed.
@@ -200 +206 @@
 }
 
-/**
- * Query the current statistics update interval
- *
- * @returns IPRT status code
- * @param   pu32Interval    Update interval in ms (out)
- */
-VBGLR3DECL(int) VbglR3StatQueryInterval(uint32_t *pu32Interval)
+#ifndef VBOX_VBGLR3_XFREE86
+
+/**
+ * Query the current statistics update interval.
+ *
+ * @returns IPRT status code.
+ * @param   pcMsInterval    Update interval in ms (out).
+ */
+VBGLR3DECL(int) VbglR3StatQueryInterval(PRTMSINTERVAL pcMsInterval)
 {
     VMMDevGetStatisticsChangeRequest Req;
@@ -212 +220 @@
     vmmdevInitRequest(&Req.header, VMMDevReq_GetStatisticsChangeRequest);
     Req.eventAck = VMMDEV_EVENT_STATISTICS_INTERVAL_CHANGE_REQUEST;
+    Req.u32StatInterval = 1;
     int rc = vbglR3GRPerform(&Req.header);
     if (RT_SUCCESS(rc))
-        *pu32Interval = Req.u32StatInterval * 1000;
-    return rc;
-}
-
-
-/**
- * Report guest statistics
- *
- * @returns IPRT status code
- * @param   pReq        Request packet with statistics
+    {
+        *pcMsInterval = Req.u32StatInterval * 1000;
+        if (*pcMsInterval / 1000 != Req.u32StatInterval)
+            *pcMsInterval = ~(RTMSINTERVAL)0;
+    }
+    return rc;
+}
+
+
+/**
+ * Report guest statistics.
+ *
+ * @returns IPRT status code.
+ * @param   pReq        Request packet with statistics.
  */
 VBGLR3DECL(int) VbglR3StatReport(VMMDevReportGuestStats *pReq)
@@ -233 +246 @@
 
 /**
- * Refresh the memory balloon after a change
- *
- * @returns IPRT status code
- * @param   pu32Size    Memory balloon size in MBs (out)
- * @param   pfHandleInR3 Allocating of memory in R3 required (out)
+ * Refresh the memory balloon after a change.
+ *
+ * @returns IPRT status code.
+ * @param   pcChunks        The size of the balloon in chunks of 1MB (out).
+ * @param   pfHandleInR3    Allocating of memory in R3 required (out).
  */
 VBGLR3DECL(int) VbglR3MemBalloonRefresh(uint32_t *pcChunks, bool *pfHandleInR3)
@@ -243 +256 @@
     VBoxGuestCheckBalloonInfo Info;
     int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_CHECK_BALLOON, &Info, sizeof(Info));
-    *pcChunks = Info.cBalloonChunks;
-    *pfHandleInR3 = Info.fHandleInR3;
+    if (RT_SUCCESS(rc))
+    {
+        *pcChunks = Info.cBalloonChunks;
+        Assert(Info.fHandleInR3 == false || Info.fHandleInR3 == true ||  RT_FAILURE(rc));
+        *pfHandleInR3 = Info.fHandleInR3 != false;
+    }
     return rc;
 }
@@ -252 +269 @@
  * Change the memory by granting/reclaiming memory to/from R0.
  *
- * @returns IPRT status code
- * @param   pv          Memory chunk (1MB)
- * @param   fInflate    true = inflate balloon (grant memory)
- *                      false = deflate balloon (reclaim memory)
+ * @returns IPRT status code.
+ * @param   pv          Memory chunk (1MB).
+ * @param   fInflate    true = inflate balloon (grant memory).
+ *                      false = deflate balloon (reclaim memory).
  */
 VBGLR3DECL(int) VbglR3MemBalloonChange(void *pv, bool fInflate)
@@ -266 +283 @@
 
 
-#ifndef VBOX_VBGLR3_XFREE86
 /**
  * Fallback for vbglR3GetAdditionsVersion.
@@ -297 +313 @@
     return VINF_SUCCESS;
 }
-#endif
-
 
 #ifdef RT_OS_WINDOWS
@@ -353 +367 @@
     return RTErrConvertFromWin32(RegCloseKey(hKey));
 }
+
 #endif /* RT_OS_WINDOWS */
 
-
-#ifndef VBOX_VBGLR3_XFREE86
 /**
  * Retrieves the installed Guest Additions version and/or revision.
@@ -451 +464 @@
 #endif /* !RT_OS_WINDOWS */
 }
-#endif /* !VBOX_VBGLR3_XFREE86 */
+
 
 /**
@@ -506 +519 @@
     return rc;
 }
+
+#endif /* !VBOX_VBGLR3_XFREE86 */
+