Changeset 70766 in vbox

Timestamp:

Jan 28, 2018 8:53:14 PM (7 years ago)

Author:

vboxsync

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

120539

Message:

Main,FE/VBoxManage: Allow changing the serial port attachment type during runtime

Location:

trunk/src/VBox

Files:

• Frontends/VBoxManage/VBoxManageControlVM.cpp (modified) (1 diff)
• Frontends/VBoxManage/VBoxManageHelp.cpp (modified) (1 diff)
• Main/include/ConsoleImpl.h (modified) (3 diffs)
• Main/src-client/ConsoleImpl.cpp (modified) (2 diffs)
• Main/src-client/ConsoleImpl2.cpp (modified) (4 diffs)
• Main/src-server/SerialPortImpl.cpp (modified) (3 diffs)

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

@@ -2111 +2111 @@
             CHECK_ERROR_BREAK(console, ClearAllDiskEncryptionPasswords());
         }
+        else if (!strncmp(a->argv[1], "changeuartmode", 14))
+        {
+            unsigned n = parseNum(&a->argv[1][14], 4, "UART");
+            if (!n)
+            {
+                rc = E_FAIL;
+                break;
+            }
+            if (a->argc < 3)
+            {
+                errorArgument("Missing argument to '%s'", a->argv[1]);
+                rc = E_FAIL;
+                break;
+            }
+
+            ComPtr<ISerialPort> uart;
+
+            CHECK_ERROR_BREAK(sessionMachine, GetSerialPort(n - 1, uart.asOutParam()));
+            ASSERT(uart);
+
+            if (!RTStrICmp(a->argv[2], "disconnected"))
+            {
+                if (a->argc != 3)
+                {
+                    errorArgument("Incorrect arguments to '%s'", a->argv[1]);
+                    rc = E_FAIL;
+                    break;
+                }
+                CHECK_ERROR(uart, COMSETTER(HostMode)(PortMode_Disconnected));
+            }
+            else if (   !RTStrICmp(a->argv[2], "server")
+                     || !RTStrICmp(a->argv[2], "client")
+                     || !RTStrICmp(a->argv[2], "tcpserver")
+                     || !RTStrICmp(a->argv[2], "tcpclient")
+                     || !RTStrICmp(a->argv[2], "file"))
+            {
+                const char *pszMode = a->argv[2];
+                if (a->argc != 4)
+                {
+                    errorArgument("Incorrect arguments to '%s'", a->argv[1]);
+                    rc = E_FAIL;
+                    break;
+                }
+
+                CHECK_ERROR(uart, COMSETTER(Path)(Bstr(a->argv[3]).raw()));
+
+                /*
+                 * Change to disconnected first to get changes in just a parameter causing
+                 * the correct changes later on.
+                 */
+                CHECK_ERROR(uart, COMSETTER(HostMode)(PortMode_Disconnected));
+                if (!RTStrICmp(pszMode, "server"))
+                {
+                    CHECK_ERROR(uart, COMSETTER(Server)(TRUE));
+                    CHECK_ERROR(uart, COMSETTER(HostMode)(PortMode_HostPipe));
+                }
+                else if (!RTStrICmp(pszMode, "client"))
+                {
+                    CHECK_ERROR(uart, COMSETTER(Server)(FALSE));
+                    CHECK_ERROR(uart, COMSETTER(HostMode)(PortMode_HostPipe));
+                }
+                else if (!RTStrICmp(pszMode, "tcpserver"))
+                {
+                    CHECK_ERROR(uart, COMSETTER(Server)(TRUE));
+                    CHECK_ERROR(uart, COMSETTER(HostMode)(PortMode_TCP));
+                }
+                else if (!RTStrICmp(pszMode, "tcpclient"))
+                {
+                    CHECK_ERROR(uart, COMSETTER(Server)(FALSE));
+                    CHECK_ERROR(uart, COMSETTER(HostMode)(PortMode_TCP));
+                }
+                else if (!RTStrICmp(pszMode, "file"))
+                {
+                    CHECK_ERROR(uart, COMSETTER(HostMode)(PortMode_RawFile));
+                }
+            }
+            else
+            {
+                if (a->argc != 3)
+                {
+                    errorArgument("Incorrect arguments to '%s'", a->argv[1]);
+                    rc = E_FAIL;
+                    break;
+                }
+                CHECK_ERROR(uart, COMSETTER(Path)(Bstr(a->argv[2]).raw()));
+                CHECK_ERROR(uart, COMSETTER(HostMode)(PortMode_HostDevice));
+            }
+        }
         else
         {

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

@@ -850 +850 @@
                      "                            removeencpassword <id>\n"
                      "                            removeallencpasswords\n"
+                     "                            changeuartmode<1-N> disconnected|\n"
+                     "                                                server <pipe>|\n"
+                     "                                                client <pipe>|\n"
+                     "                                                tcpserver <port>|\n"
+                     "                                                tcpclient <hostname:port>|\n"
+                     "                                                file <file>|\n"
+                     "                                                <devicename>]\n"
                      "\n", SEP);
     }

trunk/src/VBox/Main/include/ConsoleImpl.h

@@ -713 +713 @@
                         PCFGMNODE pLunL0, PCFGMNODE pInst,
                         bool fAttachDetach, bool fIgnoreConnectFailure);
-
+    int i_configSerialPort(PCFGMNODE pInst, PortMode_T ePortMode, const char *pszPath, bool fServer);
     static DECLCALLBACK(int) i_configGuestProperties(void *pvConsole, PUVM pUVM);
     static DECLCALLBACK(int) i_configGuestControl(void *pvConsole);
@@ -728 +728 @@
                                                        unsigned uInstance, unsigned uLun,
                                                        INetworkAdapter *aNetworkAdapter);
+    static DECLCALLBACK(int) i_changeSerialPortAttachment(Console *pThis, PUVM pUVM,
+                                                          ISerialPort *pSerialPort);
 
     void i_changeClipboardMode(ClipboardMode_T aClipboardMode);
@@ -974 +976 @@
     unsigned               m_cDisksPwProvided;
 
+    /** Current active port modes of the supported serial ports. */
+    PortMode_T             m_aeSerialPortMode[4];
+
     /** Pointer to the key consumer -> provider (that's us) callbacks. */
     struct MYPDMISECKEY : public PDMISECKEY

trunk/src/VBox/Main/src-client/ConsoleImpl.cpp

@@ -5079 +5079 @@
 }
 
+
+/**
+ * Performs the Serial Port attachment change in EMT.
+ *
+ * @returns VBox status code.
+ *
+ * @param   pThis               Pointer to the Console object.
+ * @param   pUVM                The VM handle.
+ * @param   pSerialPort         The serial port whose attachment needs to be changed
+ *
+ * @thread  EMT
+ * @note Locks the Console object for writing.
+ * @note The VM must not be running.
+ */
+DECLCALLBACK(int) Console::i_changeSerialPortAttachment(Console *pThis, PUVM pUVM,
+                                                        ISerialPort *pSerialPort)
+{
+    LogFlowFunc(("pThis=%p pUVM=%p pSerialPort=%p\n", pThis, pUVM, pSerialPort));
+
+    AssertReturn(pThis, VERR_INVALID_PARAMETER);
+
+    AutoCaller autoCaller(pThis);
+    AssertComRCReturn(autoCaller.rc(), VERR_ACCESS_DENIED);
+
+    AutoWriteLock alock(pThis COMMA_LOCKVAL_SRC_POS);
+
+    /*
+     * Check the VM for correct state.
+     */
+    VMSTATE enmVMState = VMR3GetStateU(pUVM);
+    AssertReturn(enmVMState == VMSTATE_SUSPENDED, VERR_INVALID_STATE);
+
+    HRESULT hrc = S_OK;
+    int rc = VINF_SUCCESS;
+    ULONG ulSlot;
+    hrc = pSerialPort->COMGETTER(Slot)(&ulSlot);
+    if (SUCCEEDED(hrc))
+    {
+        /* Check whether the port mode changed and act accordingly. */
+        Assert(ulSlot < 4);
+
+        PortMode_T eHostMode;
+        hrc = pSerialPort->COMGETTER(HostMode)(&eHostMode);
+        if (SUCCEEDED(hrc))
+        {
+            PCFGMNODE pInst = CFGMR3GetChildF(CFGMR3GetRootU(pUVM), "Devices/serial/%d/", ulSlot);
+            AssertRelease(pInst);
+
+            /* Remove old driver. */
+            if (pThis->m_aeSerialPortMode[ulSlot] != PortMode_Disconnected)
+            {
+                rc = PDMR3DeviceDetach(pUVM, "serial", ulSlot, 0, 0);
+                PCFGMNODE pLunL0 = CFGMR3GetChildF(pInst, "LUN#0");
+                CFGMR3RemoveNode(pLunL0);
+            }
+
+            if (RT_SUCCESS(rc))
+            {
+                BOOL fServer;
+                Bstr bstrPath;
+                hrc = pSerialPort->COMGETTER(Server)(&fServer);
+                if (SUCCEEDED(hrc))
+                    hrc = pSerialPort->COMGETTER(Path)(bstrPath.asOutParam());
+
+                /* Configure new driver. */
+                if (   SUCCEEDED(hrc)
+                    && eHostMode != PortMode_Disconnected)
+                {
+                    rc = pThis->i_configSerialPort(pInst, eHostMode, Utf8Str(bstrPath).c_str(), RT_BOOL(fServer));
+                    if (RT_SUCCESS(rc))
+                    {
+                        /*
+                         * Attach the driver.
+                         */
+                        PPDMIBASE pBase;
+                        rc = PDMR3DeviceAttach(pUVM, "serial", ulSlot, 0, 0, &pBase);
+
+                        CFGMR3Dump(pInst);
+                    }
+                }
+            }
+        }
+    }
+
+    if (RT_SUCCESS(rc) && FAILED(hrc))
+        rc = VERR_INTERNAL_ERROR;
+
+    LogFlowFunc(("Returning %Rrc\n", rc));
+    return rc;
+}
+
+
 /**
  * Called by IInternalSessionControl::OnSerialPortChange().
@@ -5089 +5181 @@
     AssertComRCReturnRC(autoCaller.rc());
 
-    fireSerialPortChangedEvent(mEventSource, aSerialPort);
+    HRESULT hrc = S_OK;
+
+    /* don't trigger audio changes if the VM isn't running */
+    SafeVMPtrQuiet ptrVM(this);
+    if (ptrVM.isOk())
+    {
+        ULONG ulSlot;
+        BOOL fEnabled;
+        hrc = aSerialPort->COMGETTER(Slot)(&ulSlot);
+        if (SUCCEEDED(hrc))
+            hrc = aSerialPort->COMGETTER(Enabled)(&fEnabled);
+        if (SUCCEEDED(hrc) && fEnabled)
+        {
+            /* Check whether the port mode changed and act accordingly. */
+            Assert(ulSlot < 4);
+
+            PortMode_T eHostMode;
+            hrc = aSerialPort->COMGETTER(HostMode)(&eHostMode);
+            if (m_aeSerialPortMode[ulSlot] != eHostMode)
+            {
+                /*
+                 * Suspend the VM first.
+                 */
+                bool fResume = false;
+                HRESULT hr = i_suspendBeforeConfigChange(ptrVM.rawUVM(), NULL, &fResume);
+                if (FAILED(hr))
+                    return hr;
+
+                /*
+                 * Call worker in EMT, that's faster and safer than doing everything
+                 * using VM3ReqCallWait.
+                 */
+                int rc = VMR3ReqCallWaitU(ptrVM.rawUVM(), 0 /*idDstCpu*/,
+                                          (PFNRT)i_changeSerialPortAttachment, 6,
+                                          this, ptrVM.rawUVM(), aSerialPort);
+
+                if (fResume)
+                    i_resumeAfterConfigChange(ptrVM.rawUVM());
+                if (RT_SUCCESS(rc))
+                    m_aeSerialPortMode[ulSlot] = eHostMode;
+                else
+                    hrc = setError(E_FAIL,
+                                   tr("Failed to change the serial port attachment (%Rrc)"), rc);
+            }
+        }
+    }
+
+    if (SUCCEEDED(hrc))
+        fireSerialPortChangedEvent(mEventSource, aSerialPort);
 
     LogFlowThisFunc(("Leaving rc=%#x\n", S_OK));
-    return S_OK;
+    return hrc;
 }
 

trunk/src/VBox/Main/src-client/ConsoleImpl2.cpp

@@ -1384 +1384 @@
         PCFGMNODE pLunL0 = NULL;        /* /Devices/Dev/0/LUN#0/ */
         PCFGMNODE pLunL1 = NULL;        /* /Devices/Dev/0/LUN#0/AttachedDriver/ */
-        PCFGMNODE pLunL2 = NULL;        /* /Devices/Dev/0/LUN#0/AttachedDriver/Config/ */
         PCFGMNODE pBiosCfg = NULL;      /* /Devices/pcbios/0/Config/ */
         PCFGMNODE pNetBootCfg = NULL;   /* /Devices/pcbios/0/Config/NetBoot/ */
@@ -2661 +2660 @@
             }
             if (!fEnabledSerPort)
+            {
+                m_aeSerialPortMode[ulInstance] = PortMode_Disconnected;
                 continue;
+            }
 
             InsertConfigNode(pDev, Utf8StrFmt("%u", ulInstance).c_str(), &pInst);
@@ -2681 +2683 @@
             PortMode_T eHostMode;
             hrc = serialPort->COMGETTER(HostMode)(&eHostMode);                              H();
+
+            m_aeSerialPortMode[ulInstance] = eHostMode;
             if (eHostMode != PortMode_Disconnected)
             {
-                InsertConfigNode(pInst,     "LUN#0", &pLunL0);
-                if (eHostMode == PortMode_HostPipe)
-                {
-                    InsertConfigString(pLunL0,  "Driver", "Char");
-                    InsertConfigNode(pLunL0,    "AttachedDriver", &pLunL1);
-                    InsertConfigString(pLunL1,  "Driver", "NamedPipe");
-                    InsertConfigNode(pLunL1,    "Config", &pLunL2);
-                    InsertConfigString(pLunL2,  "Location", bstr);
-                    InsertConfigInteger(pLunL2, "IsServer", fServer);
-                }
-                else if (eHostMode == PortMode_HostDevice)
-                {
-                    InsertConfigString(pLunL0,  "Driver", "Host Serial");
-                    InsertConfigNode(pLunL0,    "Config", &pLunL1);
-                    InsertConfigString(pLunL1,  "DevicePath", bstr);
-                }
-                else if (eHostMode == PortMode_TCP)
-                {
-                    InsertConfigString(pLunL0,  "Driver", "Char");
-                    InsertConfigNode(pLunL0,    "AttachedDriver", &pLunL1);
-                    InsertConfigString(pLunL1,  "Driver", "TCP");
-                    InsertConfigNode(pLunL1,    "Config", &pLunL2);
-                    InsertConfigString(pLunL2,  "Location", bstr);
-                    InsertConfigInteger(pLunL2, "IsServer", fServer);
-                }
-                else if (eHostMode == PortMode_RawFile)
-                {
-                    InsertConfigString(pLunL0,  "Driver", "Char");
-                    InsertConfigNode(pLunL0,    "AttachedDriver", &pLunL1);
-                    InsertConfigString(pLunL1,  "Driver", "RawFile");
-                    InsertConfigNode(pLunL1,    "Config", &pLunL2);
-                    InsertConfigString(pLunL2,  "Location", bstr);
-                }
+                rc = i_configSerialPort(pInst, eHostMode, Utf8Str(bstr).c_str(), RT_BOOL(fServer));
+                if (RT_FAILURE(rc))
+                    return rc;
             }
         }
@@ -5857 +5831 @@
 }
 
+
+/**
+ * Configures the serial port at the given CFGM node with the supplied parameters.
+ *
+ * @returns VBox status code.
+ * @param   pInst               The instance CFGM node.
+ * @param   ePortMode           The port mode to sue.
+ * @param   pszPath             The 
+ */
+int Console::i_configSerialPort(PCFGMNODE pInst, PortMode_T ePortMode, const char *pszPath, bool fServer)
+{
+    PCFGMNODE pLunL0 = NULL;        /* /Devices/Dev/0/LUN#0/ */
+    PCFGMNODE pLunL1 = NULL;        /* /Devices/Dev/0/LUN#0/AttachedDriver/ */
+    PCFGMNODE pLunL1Cfg = NULL;     /* /Devices/Dev/0/LUN#0/AttachedDriver/Config */
+
+    try
+    {
+        InsertConfigNode(pInst, "LUN#0", &pLunL0);
+        if (ePortMode == PortMode_HostPipe)
+        {
+            InsertConfigString(pLunL0,     "Driver", "Char");
+            InsertConfigNode(pLunL0,       "AttachedDriver", &pLunL1);
+            InsertConfigString(pLunL1,     "Driver", "NamedPipe");
+            InsertConfigNode(pLunL1,       "Config", &pLunL1Cfg);
+            InsertConfigString(pLunL1Cfg,  "Location", pszPath);
+            InsertConfigInteger(pLunL1Cfg, "IsServer", fServer);
+        }
+        else if (ePortMode == PortMode_HostDevice)
+        {
+            InsertConfigString(pLunL0,     "Driver", "Host Serial");
+            InsertConfigNode(pLunL0,       "Config", &pLunL1);
+            InsertConfigString(pLunL1,     "DevicePath", pszPath);
+        }
+        else if (ePortMode == PortMode_TCP)
+        {
+            InsertConfigString(pLunL0,     "Driver", "Char");
+            InsertConfigNode(pLunL0,       "AttachedDriver", &pLunL1);
+            InsertConfigString(pLunL1,     "Driver", "TCP");
+            InsertConfigNode(pLunL1,       "Config", &pLunL1Cfg);
+            InsertConfigString(pLunL1Cfg,  "Location", pszPath);
+            InsertConfigInteger(pLunL1Cfg, "IsServer", fServer);
+        }
+        else if (ePortMode == PortMode_RawFile)
+        {
+            InsertConfigString(pLunL0,     "Driver", "Char");
+            InsertConfigNode(pLunL0,       "AttachedDriver", &pLunL1);
+            InsertConfigString(pLunL1,     "Driver", "RawFile");
+            InsertConfigNode(pLunL1,       "Config", &pLunL1Cfg);
+            InsertConfigString(pLunL1Cfg,  "Location", pszPath);
+        }
+    }
+    catch (ConfigError &x)
+    {
+        /* InsertConfig threw something */
+        return x.m_vrc;
+    }
+
+    return VINF_SUCCESS;
+}
+
+
 #ifdef VBOX_WITH_GUEST_PROPS
 

trunk/src/VBox/Main/src-server/SerialPortImpl.cpp

@@ -250 +250 @@
 {
     /* the machine needs to be mutable */
-    AutoMutableOrSavedStateDependency adep(m->pMachine);
+    AutoMutableOrSavedOrRunningStateDependency adep(m->pMachine);
     if (FAILED(adep.rc())) return adep.rc();
 
@@ -424 +424 @@
 {
     /* the machine needs to be mutable */
-    AutoMutableOrSavedStateDependency adep(m->pMachine);
+    AutoMutableOrSavedOrRunningStateDependency adep(m->pMachine);
     if (FAILED(adep.rc())) return adep.rc();
 
@@ -463 +463 @@
 {
     /* the machine needs to be mutable */
-    AutoMutableOrSavedStateDependency adep(m->pMachine);
+    AutoMutableOrSavedOrRunningStateDependency adep(m->pMachine);
     if (FAILED(adep.rc())) return adep.rc();