Debugger: Some changes floating around, added a UDP I/O provider to be used for GDB and the WinDbg/Kd backend, bugref:1098

git-svn-id: https://www.virtualbox.org/svn/vbox/trunk@96865 cfe28804-0f27-0410-a406-dd0f0b0b656f

7 files changed, 268 insertions, 0 deletions

diff --git a/src/VBox/Debugger/DBGCIo.cpp b/src/VBox/Debugger/DBGCIo.cpp
index 1cfa0951dce..cf1d5add686 100644
--- a/src/VBox/Debugger/DBGCIo.cpp
+++ b/src/VBox/Debugger/DBGCIo.cpp
@@ -132,6 +132,7 @@ typedef struct DBGCIOINT
 static PCDBGCIOPROVREG g_aIoProv[] =
 {
     &g_DbgcIoProvTcp,
+    &g_DbgcIoProvUdp,
     &g_DbgcIoProvIpc
 };
 
diff --git a/src/VBox/Debugger/DBGCIoProvInternal.h b/src/VBox/Debugger/DBGCIoProvInternal.h
index 286c24e9299..a473eb219ab 100644
--- a/src/VBox/Debugger/DBGCIoProvInternal.h
+++ b/src/VBox/Debugger/DBGCIoProvInternal.h
@@ -108,6 +108,7 @@ typedef const DBGCIOPROVREG *PCDBGCIOPROVREG;
 *   Global Variables                                                           *
 *******************************************************************************/
 extern const DBGCIOPROVREG    g_DbgcIoProvTcp;
+extern const DBGCIOPROVREG    g_DbgcIoProvUdp;
 extern const DBGCIOPROVREG    g_DbgcIoProvIpc;
 
 
diff --git a/src/VBox/Debugger/DBGCIoProvIpc.cpp b/src/VBox/Debugger/DBGCIoProvIpc.cpp
index 0034b8bafc4..6a468e42acf 100644
--- a/src/VBox/Debugger/DBGCIoProvIpc.cpp
+++ b/src/VBox/Debugger/DBGCIoProvIpc.cpp
@@ -199,6 +199,8 @@ static DECLCALLBACK(int) dbgcIoProvIpcWaitForConnect(DBGCIOPROV hDbgcIoProv, RTM
             pIpcCon->Io.pfnInput    = dbgcIoProvIpcIoInput;
             pIpcCon->Io.pfnRead     = dbgcIoProvIpcIoRead;
             pIpcCon->Io.pfnWrite    = dbgcIoProvIpcIoWrite;
+            pIpcCon->Io.pfnPktBegin = NULL;
+            pIpcCon->Io.pfnPktEnd   = NULL;
             pIpcCon->Io.pfnSetReady = dbgcIoProvIpcIoSetReady;
             pIpcCon->hSession       = hSession;
             pIpcCon->fAlive         = true;
diff --git a/src/VBox/Debugger/DBGCIoProvTcp.cpp b/src/VBox/Debugger/DBGCIoProvTcp.cpp
index d6a9066a440..7d91b289d2e 100644
--- a/src/VBox/Debugger/DBGCIoProvTcp.cpp
+++ b/src/VBox/Debugger/DBGCIoProvTcp.cpp
@@ -210,6 +210,8 @@ static DECLCALLBACK(int) dbgcIoProvTcpWaitForConnect(DBGCIOPROV hDbgcIoProv, RTM
             pTcpCon->Io.pfnInput    = dbgcIoProvTcpIoInput;
             pTcpCon->Io.pfnRead     = dbgcIoProvTcpIoRead;
             pTcpCon->Io.pfnWrite    = dbgcIoProvTcpIoWrite;
+            pTcpCon->Io.pfnPktBegin = NULL;
+            pTcpCon->Io.pfnPktEnd   = NULL;
             pTcpCon->Io.pfnSetReady = dbgcIoProvTcpIoSetReady;
             pTcpCon->hSock          = hSockCon;
             pTcpCon->fAlive         = true;
diff --git a/src/VBox/Debugger/DBGCIoProvUdp.cpp b/src/VBox/Debugger/DBGCIoProvUdp.cpp
new file mode 100644
index 00000000000..be995678e71
--- /dev/null
+++ b/src/VBox/Debugger/DBGCIoProvUdp.cpp
@@ -0,0 +1,259 @@
+/* $Id$ */
+/** @file
+ * DBGC - Debugger Console, UDP I/O provider.
+ */
+
+/*
+ * Copyright (C) 2022 Oracle and/or its affiliates.
+ *
+ * This file is part of VirtualBox base platform packages, as
+ * available from https://www.virtualbox.org.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, in version 3 of the
+ * License.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <https://www.gnu.org/licenses>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-only
+ */
+
+
+/*********************************************************************************************************************************
+*   Header Files                                                                                                                 *
+*********************************************************************************************************************************/
+#include <VBox/dbg.h>
+#include <VBox/err.h>
+#include <VBox/log.h>
+
+#include <iprt/mem.h>
+#include <iprt/udp.h>
+#include <iprt/assert.h>
+
+#include "DBGCIoProvInternal.h"
+
+
+/*********************************************************************************************************************************
+*   Structures and Typedefs                                                                                                      *
+*********************************************************************************************************************************/
+/**
+ * Debug console UDP connection data.
+ */
+typedef struct DBGCUDPSRV
+{
+    /** The I/O callback table for the console. */
+    DBGCIO      Io;
+    /** The socket of the connection. */
+    RTSOCKET    hSock;
+    /** The address of the peer. */
+    RTNETADDR   NetAddrPeer;
+    /** Flag whether the peer address was set. */
+    bool        fPeerSet;
+    /** Connection status. */
+    bool        fAlive;
+} DBGCUDPSRV;
+/** Pointer to the instance data of the console UDP backend. */
+typedef DBGCUDPSRV *PDBGCUDPSRV;
+
+
+/*********************************************************************************************************************************
+*   Internal Functions                                                                                                           *
+*********************************************************************************************************************************/
+
+/**
+ * @interface_method_impl{DBGCIO,pfnDestroy}
+ */
+static DECLCALLBACK(void) dbgcIoProvUdpIoDestroy(PCDBGCIO pIo)
+{
+    RT_NOREF(pIo);
+}
+
+
+/**
+ * @interface_method_impl{DBGCIO,pfnInput}
+ */
+static DECLCALLBACK(bool) dbgcIoProvUdpIoInput(PCDBGCIO pIo, uint32_t cMillies)
+{
+    PDBGCUDPSRV pUdpSrv = RT_FROM_MEMBER(pIo, DBGCUDPSRV, Io);
+    if (!pUdpSrv->fAlive)
+        return false;
+    int rc = RTSocketSelectOne(pUdpSrv->hSock, cMillies);
+    if (RT_FAILURE(rc) && rc != VERR_TIMEOUT)
+        pUdpSrv->fAlive = false;
+    return rc != VERR_TIMEOUT;
+}
+
+
+/**
+ * @interface_method_impl{DBGCIO,pfnRead}
+ */
+static DECLCALLBACK(int) dbgcIoProvUdpIoRead(PCDBGCIO pIo, void *pvBuf, size_t cbBuf, size_t *pcbRead)
+{
+    PDBGCUDPSRV pUdpSrv = RT_FROM_MEMBER(pIo, DBGCUDPSRV, Io);
+    if (!pUdpSrv->fAlive)
+        return VERR_INVALID_HANDLE;
+    int rc = RTSocketReadFrom(pUdpSrv->hSock, pvBuf, cbBuf, pcbRead, &pUdpSrv->NetAddrPeer);
+    if (RT_SUCCESS(rc) && pcbRead != NULL && *pcbRead == 0)
+        rc = VERR_NET_SHUTDOWN;
+    if (RT_FAILURE(rc))
+        pUdpSrv->fAlive = false;
+    pUdpSrv->fPeerSet = true;
+    return rc;
+}
+
+
+/**
+ * @interface_method_impl{DBGCIO,pfnWrite}
+ */
+static DECLCALLBACK(int) dbgcIoProvUdpIoWrite(PCDBGCIO pIo, const void *pvBuf, size_t cbBuf, size_t *pcbWritten)
+{
+    PDBGCUDPSRV pUdpSrv = RT_FROM_MEMBER(pIo, DBGCUDPSRV, Io);
+    if (   !pUdpSrv->fAlive
+        || !pUdpSrv->fPeerSet)
+        return VERR_INVALID_HANDLE;
+
+    int rc = RTSocketWriteTo(pUdpSrv->hSock, pvBuf, cbBuf, &pUdpSrv->NetAddrPeer);
+    if (RT_FAILURE(rc))
+        pUdpSrv->fAlive = false;
+
+    if (pcbWritten)
+        *pcbWritten = cbBuf;
+
+    return rc;
+}
+
+
+/**
+ * @interface_method_impl{DBGCIO,pfnSetReady}
+ */
+static DECLCALLBACK(void) dbgcIoProvUdpIoSetReady(PCDBGCIO pIo, bool fReady)
+{
+    /* stub */
+    NOREF(pIo);
+    NOREF(fReady);
+}
+
+
+/**
+ * @interface_method_impl{DBGCIOPROVREG,pfnCreate}
+ */
+static DECLCALLBACK(int) dbgcIoProvUdpCreate(PDBGCIOPROV phDbgcIoProv, PCFGMNODE pCfg)
+{
+    /*
+     * Get the port configuration.
+     */
+    uint32_t u32Port;
+    int rc = CFGMR3QueryU32Def(pCfg, "Port", &u32Port, 5000);
+    if (RT_FAILURE(rc))
+    {
+        LogRel(("Configuration error: Failed querying \"Port\" -> rc=%Rc\n", rc));
+        return rc;
+    }
+
+    /*
+     * Get the address configuration.
+     */
+    char szAddress[512];
+    rc = CFGMR3QueryStringDef(pCfg, "Address", szAddress, sizeof(szAddress), "");
+    if (RT_FAILURE(rc))
+    {
+        LogRel(("Configuration error: Failed querying \"Address\" -> rc=%Rc\n", rc));
+        return rc;
+    }
+
+    PDBGCUDPSRV pUdpSrv = (PDBGCUDPSRV)RTMemAllocZ(sizeof(*pUdpSrv));
+    if (RT_LIKELY(pUdpSrv))
+    {
+        pUdpSrv->Io.pfnDestroy  = dbgcIoProvUdpIoDestroy;
+        pUdpSrv->Io.pfnInput    = dbgcIoProvUdpIoInput;
+        pUdpSrv->Io.pfnRead     = dbgcIoProvUdpIoRead;
+        pUdpSrv->Io.pfnWrite    = dbgcIoProvUdpIoWrite;
+        pUdpSrv->Io.pfnPktBegin = NULL;
+        pUdpSrv->Io.pfnPktEnd   = NULL;
+        pUdpSrv->Io.pfnSetReady = dbgcIoProvUdpIoSetReady;
+        pUdpSrv->fPeerSet       = false;
+        pUdpSrv->fAlive         = true;
+
+        /*
+         * Create the server.
+         */
+        rc = RTUdpCreateServerSocket(szAddress, u32Port, &pUdpSrv->hSock);
+        if (RT_SUCCESS(rc))
+        {
+            LogFlow(("dbgcIoProvUdpCreate: Created server on port %d %s\n", u32Port, szAddress));
+            *phDbgcIoProv = (DBGCIOPROV)pUdpSrv;
+            return rc;
+        }
+    }
+    else
+        rc = VERR_NO_MEMORY;
+
+    return rc;
+}
+
+
+/**
+ * @interface_method_impl{DBGCIOPROVREG,pfnDestroy}
+ */
+static DECLCALLBACK(void) dbgcIoProvUdpDestroy(DBGCIOPROV hDbgcIoProv)
+{
+    PDBGCUDPSRV pUdpSrv = (PDBGCUDPSRV)hDbgcIoProv;
+
+    RTSocketRelease(pUdpSrv->hSock);
+    pUdpSrv->fAlive = false;
+    RTMemFree(pUdpSrv);
+}
+
+
+/**
+ * @interface_method_impl{DBGCIOPROVREG,pfnWaitForConnect}
+ */
+static DECLCALLBACK(int) dbgcIoProvUdpWaitForConnect(DBGCIOPROV hDbgcIoProv, RTMSINTERVAL cMsTimeout, PCDBGCIO *ppDbgcIo)
+{
+    PDBGCUDPSRV pUdpSrv = (PDBGCUDPSRV)hDbgcIoProv;
+
+    /* Wait for the first datagram. */
+    int rc = RTSocketSelectOne(pUdpSrv->hSock, cMsTimeout);
+    if (RT_SUCCESS(rc))
+        *ppDbgcIo = &pUdpSrv->Io;
+    return rc;
+}
+
+
+/**
+ * @interface_method_impl{DBGCIOPROVREG,pfnWaitInterrupt}
+ */
+static DECLCALLBACK(int) dbgcIoProvUdpWaitInterrupt(DBGCIOPROV hDbgcIoProv)
+{
+    RT_NOREF(hDbgcIoProv);
+    /** @todo */
+    return VINF_SUCCESS;
+}
+
+
+/**
+ * UDP I/O provider registration record.
+ */
+const DBGCIOPROVREG g_DbgcIoProvUdp =
+{
+    /** pszName */
+    "udp",
+    /** pszDesc */
+    "UDP I/O provider.",
+    /** pfnCreate */
+    dbgcIoProvUdpCreate,
+    /** pfnDestroy */
+    dbgcIoProvUdpDestroy,
+    /** pfnWaitForConnect */
+    dbgcIoProvUdpWaitForConnect,
+    /** pfnWaitInterrupt */
+    dbgcIoProvUdpWaitInterrupt
+};
+
diff --git a/src/VBox/Debugger/Makefile.kmk b/src/VBox/Debugger/Makefile.kmk
index 6fff781ff43..36aba0b4404 100644
--- a/src/VBox/Debugger/Makefile.kmk
+++ b/src/VBox/Debugger/Makefile.kmk
@@ -62,6 +62,7 @@ Debugger_SOURCES   = \
 	DBGCRemoteKd.cpp \
 	DBGCIo.cpp \
 	DBGCIoProvTcp.cpp \
+	DBGCIoProvUdp.cpp \
 	DBGCIoProvIpc.cpp \
 	DBGCScreenAscii.cpp
 
diff --git a/src/VBox/Debugger/testcase/tstDBGCParser.cpp b/src/VBox/Debugger/testcase/tstDBGCParser.cpp
index 7593dfaaa31..fda3e1867b9 100644
--- a/src/VBox/Debugger/testcase/tstDBGCParser.cpp
+++ b/src/VBox/Debugger/testcase/tstDBGCParser.cpp
@@ -59,6 +59,8 @@ static DBGCIO g_tstBack =
     tstDBGCBackInput,
     tstDBGCBackRead,
     tstDBGCBackWrite,
+    NULL, /**pfnPktBegin*/
+    NULL, /**pfnPktEnd*/
     tstDBGCBackSetReady
 };
 /** For keeping track of output prefixing. */