Changeset 12599 in vbox for trunk/src

Timestamp:

Sep 19, 2008 12:57:35 PM (16 years ago)

Author:

vboxsync

Message:

r=bird: VBoxManage: Variables modified by asynchronous callbacks (signal handlers) should always be declared volatile. As mentioned several times before, if you have to cast a function pointer there is 99% chance you're doing something wrong - don't rely on windows mopping up for you. And finally, please stick to doxygen comments. (A bit more docs wouldn't hurt.)

File:

• trunk/src/VBox/Frontends/VBoxManage/VBoxManage.cpp (modified) (8 diffs)

trunk/src/VBox/Frontends/VBoxManage/VBoxManage.cpp

@@ +1 @@
+/* $Id$ */
 /** @file
- *
- * VBox frontends: VBoxManage (command-line interface)
- *
- * VBoxManage is VirtualBox's command-line interface. This is its rather
- * long source.
+ * VBoxManage - VirtualBox's command-line interface.
  */
 
@@ -7810 +7807 @@
 }
 
-/*********************************************************************
-* list                                                               *
-*********************************************************************/
+/**
+ * list                                                               *
+ */
 static int handleMetricsList(int argc, char *argv[],
                              ComPtr<IVirtualBox> aVirtualBox,
@@ -7861 +7858 @@
 }
 
-/*********************************************************************
-* setup                                                              *
-*********************************************************************/
+/**
+ * Metics setup
+ */
 static int handleMetricsSetup(int argc, char *argv[],
                               ComPtr<IVirtualBox> aVirtualBox,
@@ -7873 +7870 @@
     com::SafeIfaceArray<IUnknown> objects;
     ULONG period = 1, samples = 1;
-    bool listMatches = false;
+    /*bool listMatches = false;*/
     int i;
 
@@ -7922 +7919 @@
 }
 
-/*********************************************************************
-* query                                                              *
-*********************************************************************/
+/**
+ * metrics query
+ */
 static int handleMetricsQuery(int argc, char *argv[],
                               ComPtr<IVirtualBox> aVirtualBox,
@@ -8009 +8006 @@
 }
 
-static bool fKeepGoing = true;
+/** Used by the handleMetricsCollect loop. */
+static bool volatile g_fKeepGoing = true;
 
 #ifdef RT_OS_WINDOWS
-static bool ctrlHandler(DWORD fdwCtrlType)
-{ 
-    switch( fdwCtrlType ) 
-    { 
+/**
+ * Handler routine for catching Ctrl-C, Ctrl-Break and closing of
+ * the console.
+ *
+ * @returns true if handled, false if not handled.
+ * @param   dwCtrlType      The type of control signal.
+ *
+ * @remarks This is called on a new thread.
+ */
+static BOOL WINAPI ctrlHandler(DWORD dwCtrlType)
+{
+    switch (dwCtrlType)
+    {
         /* Ctrl-C or Ctrl-Break or Close */
         case CTRL_C_EVENT:
         case CTRL_BREAK_EVENT:
-        case CTRL_CLOSE_EVENT: 
+        case CTRL_CLOSE_EVENT:
             /* Let's shut down gracefully. */
-            fKeepGoing = false;
+            ASMAtomicWriteBool(&g_fKeepGoing, true);
             return true;
     }
     /* Don't care about the rest -- let it die a horrible death. */
     return false;
-} 
+}
 #endif /* RT_OS_WINDOWS */
 
-/*********************************************************************
-* collect                                                            *
-*********************************************************************/
+/**
+ * collect
+ */
 static int handleMetricsCollect(int argc, char *argv[],
                                 ComPtr<IVirtualBox> aVirtualBox,
@@ -8097 +8104 @@
 
 #ifdef RT_OS_WINDOWS
-    SetConsoleCtrlHandler((PHANDLER_ROUTINE)ctrlHandler, true);
+    SetConsoleCtrlHandler(ctrlHandler, true);
 #endif /* RT_OS_WINDOWS */
 
     RTPrintf("Time stamp   Object     Metric               Value\n");
 
-    while (fKeepGoing)
+    while (g_fKeepGoing)
     {
         RTPrintf("------------ ---------- -------------------- --------------------\n");
@@ -8157 +8164 @@
 
 #ifdef RT_OS_WINDOWS
-    SetConsoleCtrlHandler((PHANDLER_ROUTINE)ctrlHandler, false);
+    SetConsoleCtrlHandler(ctrlHandler, false);
 #endif /* RT_OS_WINDOWS */