1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
/* $Id: DBGCIoProvUdp.cpp $ */
/** @file
* DBGC - Debugger Console, UDP I/O provider.
*/
/*
* Copyright (C) 2022-2023 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
};
|
