Changeset 5889 in vbox

Timestamp:

Nov 30, 2007 12:39:22 PM (17 years ago)

Author:

vboxsync

Message:

r=bird: Use the right asserts (no function names in the msg, please). RTMem*Alloc* assers for you. Mark enum. You don't cast to void *. Doxygen autobrief.

File:

• trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3Lib.cpp (modified) (4 diffs)

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

@@ -35 +35 @@
 /** The VBoxGuest device handle. */
 static RTFILE g_File = NIL_RTFILE;
+
 
 VBGLR3DECL(int) VbglR3Init(void)
@@ -167 +168 @@
 }
 
+
 VBGLR3DECL(int) VbglR3GRAlloc(VMMDevRequestHeader **ppReq, uint32_t cbSize,
-                              VMMDevRequestType reqType)
+                              VMMDevRequestType enmReqType)
 {
     VMMDevRequestHeader *pReq;
-    int rc = VINF_SUCCESS;
-
-    if (!ppReq || cbSize < sizeof (VMMDevRequestHeader))
-    {
-        AssertMsgFailed(("VbglR3GRAlloc: Invalid parameter: ppReq = %p, cbSize = %d\n",
-                         ppReq, cbSize));
-        return VERR_INVALID_PARAMETER;
-    }
-    pReq = (VMMDevRequestHeader *)RTMemTmpAlloc (cbSize);
-    if (!pReq)
-    {
-        AssertMsgFailed(("VbglR3GRAlloc: no memory\n"));
-        rc = VERR_NO_MEMORY;
-    }
-    else
-    {
-        pReq->size        = cbSize;
-        pReq->version     = VMMDEV_REQUEST_HEADER_VERSION;
-        pReq->requestType = reqType;
-        pReq->rc          = VERR_GENERAL_FAILURE;
-        pReq->reserved1   = 0;
-        pReq->reserved2   = 0;
-
-        *ppReq = pReq;
-    }
-
-    return rc;
-}
+
+    AssertPtrReturn(ppReq, VERR_INVALID_PARAMETER);
+    AssertMsgReturn(cb >= sizeof(VMMDevRequestHeader), ("%#x vs %#zx\n", cb, sizeof(VMMDevRequestHeader)), 
+                    VERR_INVALID_PARAMETER);
+
+    pReq = (VMMDevRequestHeader *)RTMemTmpAlloc(cb);
+    if (RT_UNLIKELY(!pReq))
+        return VERR_NO_MEMORY;
+
+    pReq->size        = cbSize;
+    pReq->version     = VMMDEV_REQUEST_HEADER_VERSION;
+    pReq->requestType = enmReqType;
+    pReq->rc          = VERR_GENERAL_FAILURE;
+    pReq->reserved1   = 0;
+    pReq->reserved2   = 0;
+
+    *ppReq = pReq;
+
+    return VINF_SUCCESS;
+}
+
 
 VBGLR3DECL(int) VbglR3GRPerform(VMMDevRequestHeader *pReq)
@@ -205 +200 @@
 }
 
-VBGLR3DECL(void) VbglR3GRFree (VMMDevRequestHeader *pReq)
-{
-    RTMemTmpFree((void *)pReq);
-}
+
+VBGLR3DECL(void) VbglR3GRFree(VMMDevRequestHeader *pReq)
+{
+    RTMemTmpFree(pReq);
+}
+
 
 VBGLR3DECL(int) VbglR3GetHostTime(PRTTIMESPEC pTime)
@@ -221 +218 @@
 }
 
+
 /**
- * Cause any pending WaitEvent calls (VBOXGUEST_IOCTL_WAITEVENT) to return with a
- * VERR_INTERRUPTED error.  Can be used in combination with a termination flag variable for
- * interrupting event loops.  Avoiding race conditions is the responsibility of the caller.
+ * Cause any pending WaitEvent calls (VBOXGUEST_IOCTL_WAITEVENT) to return 
+ * with a VERR_INTERRUPTED status.
+ * 
+ * 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