Changeset 83521 in vbox for trunk/src/VBox/Devices/Serial

Timestamp:

Apr 3, 2020 8:36:26 AM (5 years ago)

Author:

vboxsync

Message:

Devices/Serial/DrvHostSerial: Show a warning when the serial port encounters a fatal error and stop any I/O activity. Upon a suspend/resume cycle the serial port is reopened if a fatal error was encountered previously to try restarting I/O.

File:

• trunk/src/VBox/Devices/Serial/DrvHostSerial.cpp (modified) (19 diffs)

trunk/src/VBox/Devices/Serial/DrvHostSerial.cpp

@@ -62 +62 @@
     /** the device path */
     char                        *pszDevicePath;
+    /** The active config of the serial port. */
+    RTSERIALPORTCFG             Cfg;
 
     /** Flag whether data is available from the device/driver above as notified by the driver. */
@@ -81 +83 @@
     volatile size_t             cbReadBuf;
 
+    /* Flag whether the host device ran into a fatal error condition and I/O is suspended
+     * until the nuext VM suspend/resume cycle where we will try again. */
+    volatile bool               fIoFatalErr;
+    /** Event semaphore the I/O thread is waiting on */
+    RTSEMEVENT                  hSemEvtIoFatalErr;
+
     /** Read/write statistics */
     STAMCOUNTER                 StatBytesRead;
@@ -186 +194 @@
 
 
+/**
+ * Wakes up the serial port I/O thread.
+ *
+ * @returns VBox status code.
+ * @param   pThis               The host serial driver instance.
+ */
+static int drvHostSerialWakeupIoThread(PDRVHOSTSERIAL pThis)
+{
+
+    if (RT_UNLIKELY(pThis->fIoFatalErr))
+        return RTSemEventSignal(pThis->hSemEvtIoFatalErr);
+
+    return RTSerialPortEvtPollInterrupt(pThis->hSerialPort);
+}
+
+
 /* -=-=-=-=- IBase -=-=-=-=- */
 
@@ -212 +236 @@
     bool fAvailOld = ASMAtomicXchgBool(&pThis->fAvailWrExt, true);
     if (!fAvailOld)
-        rc = RTSerialPortEvtPollInterrupt(pThis->hSerialPort);
+        rc = drvHostSerialWakeupIoThread(pThis);
 
     return rc;
@@ -248 +272 @@
     /* Kick the I/O thread if there is nothing to read to recalculate the poll flags. */
     if (!drvHostSerialReadBufGetRead(pThis, NULL))
-        rc = RTSerialPortEvtPollInterrupt(pThis->hSerialPort);
+        rc = drvHostSerialWakeupIoThread(pThis);
 
     STAM_COUNTER_ADD(&pThis->StatBytesRead, cbReadAll);
@@ -263 +287 @@
 {
     PDRVHOSTSERIAL pThis = RT_FROM_MEMBER(pInterface, DRVHOSTSERIAL, ISerialConnector);
-    RTSERIALPORTCFG Cfg;
-
-    Cfg.uBaudRate = uBps;
+
+    pThis->Cfg.uBaudRate = uBps;
 
     switch (enmParity)
     {
         case PDMSERIALPARITY_EVEN:
-            Cfg.enmParity = RTSERIALPORTPARITY_EVEN;
+            pThis->Cfg.enmParity = RTSERIALPORTPARITY_EVEN;
             break;
         case PDMSERIALPARITY_ODD:
-            Cfg.enmParity = RTSERIALPORTPARITY_ODD;
+            pThis->Cfg.enmParity = RTSERIALPORTPARITY_ODD;
             break;
         case PDMSERIALPARITY_NONE:
-            Cfg.enmParity = RTSERIALPORTPARITY_NONE;
+            pThis->Cfg.enmParity = RTSERIALPORTPARITY_NONE;
             break;
         case PDMSERIALPARITY_MARK:
-            Cfg.enmParity = RTSERIALPORTPARITY_MARK;
+            pThis->Cfg.enmParity = RTSERIALPORTPARITY_MARK;
             break;
         case PDMSERIALPARITY_SPACE:
-            Cfg.enmParity = RTSERIALPORTPARITY_SPACE;
+            pThis->Cfg.enmParity = RTSERIALPORTPARITY_SPACE;
             break;
         default:
             AssertMsgFailed(("Unsupported parity setting %d\n", enmParity)); /* Should not happen. */
-            Cfg.enmParity = RTSERIALPORTPARITY_NONE;
+            pThis->Cfg.enmParity = RTSERIALPORTPARITY_NONE;
     }
 
@@ -292 +315 @@
     {
         case 5:
-            Cfg.enmDataBitCount = RTSERIALPORTDATABITS_5BITS;
+            pThis->Cfg.enmDataBitCount = RTSERIALPORTDATABITS_5BITS;
             break;
         case 6:
-            Cfg.enmDataBitCount = RTSERIALPORTDATABITS_6BITS;
+            pThis->Cfg.enmDataBitCount = RTSERIALPORTDATABITS_6BITS;
             break;
         case 7:
-            Cfg.enmDataBitCount = RTSERIALPORTDATABITS_7BITS;
+            pThis->Cfg.enmDataBitCount = RTSERIALPORTDATABITS_7BITS;
             break;
         case 8:
-            Cfg.enmDataBitCount = RTSERIALPORTDATABITS_8BITS;
+            pThis->Cfg.enmDataBitCount = RTSERIALPORTDATABITS_8BITS;
             break;
         default:
             AssertMsgFailed(("Unsupported data bit count %u\n", cDataBits)); /* Should not happen. */
-            Cfg.enmDataBitCount = RTSERIALPORTDATABITS_8BITS;
+            pThis->Cfg.enmDataBitCount = RTSERIALPORTDATABITS_8BITS;
     }
 
@@ -311 +334 @@
     {
         case PDMSERIALSTOPBITS_ONE:
-            Cfg.enmStopBitCount = RTSERIALPORTSTOPBITS_ONE;
+            pThis->Cfg.enmStopBitCount = RTSERIALPORTSTOPBITS_ONE;
             break;
         case PDMSERIALSTOPBITS_ONEPOINTFIVE:
-            Cfg.enmStopBitCount = RTSERIALPORTSTOPBITS_ONEPOINTFIVE;
+            pThis->Cfg.enmStopBitCount = RTSERIALPORTSTOPBITS_ONEPOINTFIVE;
             break;
         case PDMSERIALSTOPBITS_TWO:
-            Cfg.enmStopBitCount = RTSERIALPORTSTOPBITS_TWO;
+            pThis->Cfg.enmStopBitCount = RTSERIALPORTSTOPBITS_TWO;
             break;
         default:
             AssertMsgFailed(("Unsupported stop bit count %d\n", enmStopBits)); /* Should not happen. */
-            Cfg.enmStopBitCount = RTSERIALPORTSTOPBITS_ONE;
-    }
-
-    return RTSerialPortCfgSet(pThis->hSerialPort, &Cfg, NULL);
+            pThis->Cfg.enmStopBitCount = RTSERIALPORTSTOPBITS_ONE;
+    }
+
+    return RTSerialPortCfgSet(pThis->hSerialPort, &pThis->Cfg, NULL);
 }
 
@@ -388 +411 @@
         size_t cbOld = drvHostSerialReadBufReset(pThis);
         if (cbOld) /* Kick the I/O thread to fetch new data. */
-            rc = RTSerialPortEvtPollInterrupt(pThis->hSerialPort);
+            rc = drvHostSerialWakeupIoThread(pThis);
     }
 
@@ -399 +422 @@
 
 /**
- * I/O thread loop.
- *
- * @returns VINF_SUCCESS.
- * @param   pDrvIns     PDM driver instance data.
- * @param   pThread     The PDM thread data.
- */
-static DECLCALLBACK(int) drvHostSerialIoThread(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
-{
-    PDRVHOSTSERIAL pThis = PDMINS_2_DATA(pDrvIns, PDRVHOSTSERIAL);
-
-    if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
-        return VINF_SUCCESS;
-
-    while (pThread->enmState == PDMTHREADSTATE_RUNNING)
+ * The normal I/O loop.
+ *
+ * @returns VBox status code.
+ * @param   pDrvIns             Pointer to the driver instance data.
+ * @param   pThis               Host serial driver instance data.
+ * @param   pThread             Thread instance data.
+ */
+static int drvHostSerialIoLoopNormal(PPDMDRVINS pDrvIns, PDRVHOSTSERIAL pThis, PPDMTHREAD pThread)
+{
+    int rc = VINF_SUCCESS;
+    while (   pThread->enmState == PDMTHREADSTATE_RUNNING
+           && RT_SUCCESS(rc))
     {
         uint32_t fEvtFlags = RTSERIALPORT_EVT_F_STATUS_LINE_CHANGED | RTSERIALPORT_EVT_F_BREAK_DETECTED;
@@ -429 +450 @@
 
         uint32_t fEvtsRecv = 0;
-        int rc = RTSerialPortEvtPoll(pThis->hSerialPort, fEvtFlags, &fEvtsRecv, RT_INDEFINITE_WAIT);
+        rc = RTSerialPortEvtPoll(pThis->hSerialPort, fEvtFlags, &fEvtsRecv, RT_INDEFINITE_WAIT);
         if (RT_SUCCESS(rc))
         {
@@ -464 +485 @@
                         {
                             /* Move the data in the TX buffer to the front to fill the end again. */
-                            memmove(&pThis->abTxBuf[0], &pThis->abTxBuf[cbProcessed], pThis->cbTxUsed);                        }
+                            memmove(&pThis->abTxBuf[0], &pThis->abTxBuf[cbProcessed], pThis->cbTxUsed);
+                        }
                         else
                             pThis->pDrvSerialPort->pfnDataSentNotify(pThis->pDrvSerialPort);
@@ -531 +553 @@
                         LogRelMax(10, ("HostSerial#%d: Notifying device about changed status lines failed with error %Rrc; continuing.\n",
                                        pDrvIns->iInstance, rc));
+                        rc = VINF_SUCCESS;
                     }
                 }
                 else
+                {
                     LogRelMax(10, ("HostSerial#%d: Getting status lines state failed with error %Rrc; continuing.\n", pDrvIns->iInstance, rc));
+                    rc = VINF_SUCCESS;
+                }
             }
 
@@ -547 +573 @@
     }
 
+    LogRel(("HostSerial#%d: The underlying host device run into a fatal error condition %Rrc, any data transfer is disabled\n",
+            pDrvIns->iInstance, rc));
+
+    return rc;
+}
+
+
+/**
+ * The error I/O loop.
+ *
+ * @returns VBox status code.
+ * @param   pDrvIns             Pointer to the driver instance data.
+ * @param   pThis               Host serial driver instance data.
+ * @param   pThread             Thread instance data.
+ */
+static void drvHostSerialIoLoopError(PDRVHOSTSERIAL pThis, PPDMTHREAD pThread)
+{
+    ASMAtomicXchgBool(&pThis->fIoFatalErr, true);
+
+    PDMDrvHlpVMSetRuntimeError(pThis->pDrvIns, 0 /*fFlags*/, "SerialPortIoError",
+                               N_("The host serial port \"%s\" encountered a fatal error and stopped functioning. "
+                                  "This can be caused by bad cabling or USB to serial converters being unplugged by accident. "
+                                  "To restart I/O transfers suspend and resume the VM after fixing the underlying issue."),
+                               pThis->pszDevicePath);
+
+    while (pThread->enmState == PDMTHREADSTATE_RUNNING)
+    {
+        /*
+         * We have to discard any data which is going to be send (the error
+         * mode resembles the "someone just pulled the plug on the serial port" situation)
+         */
+        RTSemEventWait(pThis->hSemEvtIoFatalErr, RT_INDEFINITE_WAIT);
+
+        if (ASMAtomicXchgBool(&pThis->fAvailWrExt, false))
+        {
+            size_t cbFetched = 0;
+
+            do
+            {
+                /* Stuff as much data into the TX buffer as we can. */
+                uint8_t abDiscard[64];
+                int rc = pThis->pDrvSerialPort->pfnReadWr(pThis->pDrvSerialPort, &abDiscard, sizeof(abDiscard),
+                                                          &cbFetched);
+                AssertRC(rc);
+            } while (cbFetched > 0);
+
+            /* Acknowledge the sent data. */
+            pThis->pDrvSerialPort->pfnDataSentNotify(pThis->pDrvSerialPort);
+
+            /*
+             * Sleep a bit to avoid excessive I/O loop CPU usage, timing is not important in
+             * this mode.
+             */
+            PDMR3ThreadSleep(pThread, 100);
+        }
+    }
+}
+
+
+/**
+ * I/O thread loop.
+ *
+ * @returns VINF_SUCCESS.
+ * @param   pDrvIns     PDM driver instance data.
+ * @param   pThread     The PDM thread data.
+ */
+static DECLCALLBACK(int) drvHostSerialIoThread(PPDMDRVINS pDrvIns, PPDMTHREAD pThread)
+{
+    PDRVHOSTSERIAL pThis = PDMINS_2_DATA(pDrvIns, PDRVHOSTSERIAL);
+
+    if (pThread->enmState == PDMTHREADSTATE_INITIALIZING)
+        return VINF_SUCCESS;
+
+    int rc = VINF_SUCCESS;
+    if (!pThis->fIoFatalErr)
+        rc = drvHostSerialIoLoopNormal(pDrvIns, pThis, pThread);
+
+    if (   RT_FAILURE(rc)
+        || pThis->fIoFatalErr)
+        drvHostSerialIoLoopError(pThis, pThread);
+
     return VINF_SUCCESS;
 }
@@ -563 +670 @@
     PDRVHOSTSERIAL pThis = PDMINS_2_DATA(pDrvIns, PDRVHOSTSERIAL);
 
-    return RTSerialPortEvtPollInterrupt(pThis->hSerialPort);
+    return drvHostSerialWakeupIoThread(pThis);
 }
 
 
 /* -=-=-=-=- driver interface -=-=-=-=- */
+
+/**
+ * @callback_method_impl{FNPDMDRVRESUME}
+ */
+static DECLCALLBACK(void) drvHostSerialResume(PPDMDRVINS pDrvIns)
+{
+    PDRVHOSTSERIAL pThis = PDMINS_2_DATA(pDrvIns, PDRVHOSTSERIAL);
+
+    if (RT_UNLIKELY(pThis->fIoFatalErr))
+    {
+        /* Try to reopen the device and set the old config. */
+        uint32_t fOpenFlags =   RTSERIALPORT_OPEN_F_READ
+                              | RTSERIALPORT_OPEN_F_WRITE
+                              | RTSERIALPORT_OPEN_F_SUPPORT_STATUS_LINE_MONITORING
+                              | RTSERIALPORT_OPEN_F_DETECT_BREAK_CONDITION;
+        int rc = RTSerialPortOpen(&pThis->hSerialPort, pThis->pszDevicePath, fOpenFlags);
+        if (rc == VERR_NOT_SUPPORTED)
+        {
+            /*
+             * For certain devices (or pseudo terminals) status line monitoring does not work
+             * so try again without it.
+             */
+            fOpenFlags &= ~RTSERIALPORT_OPEN_F_SUPPORT_STATUS_LINE_MONITORING;
+            rc = RTSerialPortOpen(&pThis->hSerialPort, pThis->pszDevicePath, fOpenFlags);
+        }
+
+        if (RT_SUCCESS(rc))
+        {
+            /* Set the config which is currently active. */
+            rc = RTSerialPortCfgSet(pThis->hSerialPort, &pThis->Cfg, NULL);
+            if (RT_FAILURE(rc))
+                LogRelMax(10, ("HostSerial#%d: Setting the active serial port config failed with error %Rrc during VM resume; continuing.\n", pDrvIns->iInstance, rc));
+            /* Reset the I/O error flag on success to resume the normal I/O thread loop. */
+            ASMAtomicXchgBool(&pThis->fIoFatalErr, false);
+        }
+    }
+}
+
+
+/**
+ * @callback_method_impl{FNPDMDRVSUSPEND}
+ */
+static DECLCALLBACK(void) drvHostSerialSuspend(PPDMDRVINS pDrvIns)
+{
+    PDRVHOSTSERIAL pThis = PDMINS_2_DATA(pDrvIns, PDRVHOSTSERIAL);
+
+    if (RT_UNLIKELY(pThis->fIoFatalErr))
+    {
+        /* Close the device and try reopening it on resume. */
+        if (pThis->hSerialPort != NIL_RTSERIALPORT)
+        {
+            RTSerialPortClose(pThis->hSerialPort);
+            pThis->hSerialPort = NIL_RTSERIALPORT;
+        }
+    }
+}
+
 
 /**
@@ -587 +751 @@
         RTSerialPortClose(pThis->hSerialPort);
         pThis->hSerialPort = NIL_RTSERIALPORT;
+    }
+
+    if (pThis->hSemEvtIoFatalErr != NIL_RTSEMEVENT)
+    {
+        RTSemEventDestroy(pThis->hSemEvtIoFatalErr);
+        pThis->hSemEvtIoFatalErr = NIL_RTSEMEVENT;
     }
 
@@ -620 +790 @@
     pThis->offRead                               = 0;
     pThis->cbReadBuf                             = 0;
+    pThis->fIoFatalErr                           = false;
+    pThis->hSemEvtIoFatalErr                     = NIL_RTSEMEVENT;
     /* IBase. */
     pDrvIns->IBase.pfnQueryInterface             = drvHostSerialQueryInterface;
@@ -683 +855 @@
         }
     }
+
+    rc = RTSemEventCreate(&pThis->hSemEvtIoFatalErr);
+    if (RT_FAILURE(rc))
+        return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, N_("HostSerial#%d failed to create event semaphore"), pDrvIns->iInstance);
 
     /*
@@ -745 +921 @@
     NULL,
     /* pfnSuspend */
-    NULL,
+    drvHostSerialSuspend,
     /* pfnResume */
-    NULL,
+    drvHostSerialResume,
     /* pfnAttach */
     NULL,