Changeset 26058 in vbox for trunk/src/VBox/Additions/common

Timestamp:

Jan 27, 2010 9:23:23 AM (15 years ago)

Author:

vboxsync

Message:

VBoxGuestR3LibCpuHotplug.cpp -> VBoxGuestR3LibCpuHotPlug.cpp; added missing docs and fix style.

Location:

trunk/src/VBox/Additions/common/VBoxGuestLib

Files:

• Makefile.kmk (modified) (1 diff)
• VBoxGuestR3LibCpuHotPlug.cpp (moved) (moved from trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibCpuHotplug.cpp ) (4 diffs)

trunk/src/VBox/Additions/common/VBoxGuestLib/Makefile.kmk

@@ -95 +95 @@
         VBoxGuestR3LibTime.cpp \
         VBoxGuestR3LibVideo.cpp \
-        VBoxGuestR3LibCpuHotplug.cpp
+        VBoxGuestR3LibCpuHotPlug.cpp
 ifeq ($(KBUILD_TARGET),win) ## @todo get rid of this hack (as soon as it's all implemented / #defined).
  VBoxGuestR3Lib_SOURCES   = \

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2007 Sun Microsystems, Inc.
+ * Copyright (C) 2010 Sun Microsystems, Inc.
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -26 +26 @@
 #include "VBGLR3Internal.h"
 
+
+/**
+ * Initialize CPU hot plugging.
+ *
+ * This will enable the CPU hot plugging events.
+ *
+ * @returns VBox status code.
+ */
 VBGLR3DECL(int) VbglR3CpuHotplugInit(void)
 {
-    int rc = VINF_SUCCESS;
+    int rc = VbglR3CtlFilterMask(VMMDEV_EVENT_CPU_HOTPLUG, 0);
+    if (RT_FAILURE(rc))
+        return rc;
+
     VMMDevCpuHotPlugStatusRequest Req;
     vmmdevInitRequest(&Req.header, VMMDevReq_SetCpuHotPlugStatus);
     Req.enmStatusType = VMMDevCpuStatusType_Enable;
-
-    rc = VbglR3CtlFilterMask(VMMDEV_EVENT_CPU_HOTPLUG, 0);
-    if (RT_FAILURE(rc))
-        return rc;
-
     rc = vbglR3GRPerform(&Req.header);
     if (RT_FAILURE(rc))
@@ -44 +50 @@
 }
 
+
+/**
+ * Terminate CPU hot plugging.
+ *
+ * This will disable the CPU hot plugging events.
+ *
+ * @returns VBox status.
+ */
 VBGLR3DECL(int) VbglR3CpuHotplugTerm(void)
 {
+    /* Clear the events. */
+    VbglR3CtlFilterMask(0, VMMDEV_EVENT_CPU_HOTPLUG);
+
     VMMDevCpuHotPlugStatusRequest Req;
     vmmdevInitRequest(&Req.header, VMMDevReq_SetCpuHotPlugStatus);
     Req.enmStatusType = VMMDevCpuStatusType_Disable;
-
-    /* Clear the events. */
-    VbglR3CtlFilterMask(0, VMMDEV_EVENT_CPU_HOTPLUG);
-
-    int rc = vbglR3GRPerform(&Req.header);
-    return rc;
+    return vbglR3GRPerform(&Req.header);
 }
 
+
+/**
+ * Waits for a CPU hot plugging event and retrive the data associated with it.
+ *
+ * @returns VBox status code.
+ * @param   penmEventType   Where to store the event type on success.
+ * @param   pidCpuCore      Where to store the CPU core ID on success.
+ * @param   pidCpuPackage   Where to store the CPU package ID on success.
+ */
 VBGLR3DECL(int) VbglR3CpuHotplugWaitForEvent(VMMDevCpuEventType *penmEventType, uint32_t *pidCpuCore, uint32_t *pidCpuPackage)
 {
+    AssertPtrReturn(penmEventType, VERR_INVALID_POINTER);
+    AssertPtrReturn(pidCpuCore, VERR_INVALID_POINTER);
+    AssertPtrReturn(pidCpuPackage, VERR_INVALID_POINTER);
+
     VBoxGuestWaitEventInfo waitEvent;
-    int rc;
-
-    AssertPtrReturn(penmEventType, VERR_INVALID_PARAMETER);
-    AssertPtrReturn(pidCpuCore, VERR_INVALID_PARAMETER);
-    AssertPtrReturn(pidCpuPackage, VERR_INVALID_PARAMETER);
     waitEvent.u32TimeoutIn = RT_INDEFINITE_WAIT;
     waitEvent.u32EventMaskIn = VMMDEV_EVENT_CPU_HOTPLUG;
     waitEvent.u32Result = VBOXGUEST_WAITEVENT_ERROR;
     waitEvent.u32EventFlagsOut = 0;
-    rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_WAITEVENT, &waitEvent, sizeof(waitEvent));
+    int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_WAITEVENT, &waitEvent, sizeof(waitEvent));
     if (RT_SUCCESS(rc))
     {
@@ -77 +97 @@
             VMMDevGetCpuHotPlugRequest Req;
 
-            /* get the seamless change request */
+            /* get the CPU hot plugging request */
             vmmdevInitRequest(&Req.header, VMMDevReq_GetCpuHotPlugRequest);
             Req.idCpuCore    = UINT32_MAX;