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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
/* $Id: DBGCTcp.cpp $ */
/** @file
* DBGC - Debugger Console, TCP backend.
*/
/*
* Copyright (C) 2006-2019 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#include <VBox/dbg.h>
#include <VBox/vmm/cfgm.h>
#include <VBox/err.h>
#include <iprt/thread.h>
#include <iprt/tcp.h>
#include <VBox/log.h>
#include <iprt/assert.h>
#include <iprt/string.h>
/*********************************************************************************************************************************
* Structures and Typedefs *
*********************************************************************************************************************************/
/**
* Debug console TCP backend instance data.
*/
typedef struct DBGCTCP
{
/** The I/O backend for the console. */
DBGCBACK Back;
/** The socket of the connection. */
RTSOCKET Sock;
/** Connection status. */
bool fAlive;
} DBGCTCP;
/** Pointer to the instance data of the console TCP backend. */
typedef DBGCTCP *PDBGCTCP;
/** Converts a pointer to DBGCTCP::Back to a pointer to DBGCTCP. */
#define DBGCTCP_BACK2DBGCTCP(pBack) ( (PDBGCTCP)((char *)(pBack) - RT_UOFFSETOF(DBGCTCP, Back)) )
/*********************************************************************************************************************************
* Internal Functions *
*********************************************************************************************************************************/
static DECLCALLBACK(int) dbgcTcpConnection(RTSOCKET Sock, void *pvUser);
/**
* Checks if there is input.
*
* @returns true if there is input ready.
* @returns false if there not input ready.
* @param pBack Pointer to the backend structure supplied by
* the backend. The backend can use this to find
* it's instance data.
* @param cMillies Number of milliseconds to wait on input data.
*/
static DECLCALLBACK(bool) dbgcTcpBackInput(PDBGCBACK pBack, uint32_t cMillies)
{
PDBGCTCP pDbgcTcp = DBGCTCP_BACK2DBGCTCP(pBack);
if (!pDbgcTcp->fAlive)
return false;
int rc = RTTcpSelectOne(pDbgcTcp->Sock, cMillies);
if (RT_FAILURE(rc) && rc != VERR_TIMEOUT)
pDbgcTcp->fAlive = false;
return rc != VERR_TIMEOUT;
}
/**
* Read input.
*
* @returns VBox status code.
* @param pBack Pointer to the backend structure supplied by
* the backend. The backend can use this to find
* it's instance data.
* @param pvBuf Where to put the bytes we read.
* @param cbBuf Maximum nymber of bytes to read.
* @param pcbRead Where to store the number of bytes actually read.
* If NULL the entire buffer must be filled for a
* successful return.
*/
static DECLCALLBACK(int) dbgcTcpBackRead(PDBGCBACK pBack, void *pvBuf, size_t cbBuf, size_t *pcbRead)
{
PDBGCTCP pDbgcTcp = DBGCTCP_BACK2DBGCTCP(pBack);
if (!pDbgcTcp->fAlive)
return VERR_INVALID_HANDLE;
int rc = RTTcpRead(pDbgcTcp->Sock, pvBuf, cbBuf, pcbRead);
if (RT_SUCCESS(rc) && pcbRead != NULL && *pcbRead == 0)
rc = VERR_NET_SHUTDOWN;
if (RT_FAILURE(rc))
pDbgcTcp->fAlive = false;
return rc;
}
/**
* Write (output).
*
* @returns VBox status code.
* @param pBack Pointer to the backend structure supplied by
* the backend. The backend can use this to find
* it's instance data.
* @param pvBuf What to write.
* @param cbBuf Number of bytes to write.
* @param pcbWritten Where to store the number of bytes actually written.
* If NULL the entire buffer must be successfully written.
*/
static DECLCALLBACK(int) dbgcTcpBackWrite(PDBGCBACK pBack, const void *pvBuf, size_t cbBuf, size_t *pcbWritten)
{
PDBGCTCP pDbgcTcp = DBGCTCP_BACK2DBGCTCP(pBack);
if (!pDbgcTcp->fAlive)
return VERR_INVALID_HANDLE;
/*
* convert '\n' to '\r\n' while writing.
*/
int rc = 0;
size_t cbLeft = cbBuf;
while (cbLeft)
{
size_t cb = cbLeft;
/* write newlines */
if (*(const char *)pvBuf == '\n')
{
rc = RTTcpWrite(pDbgcTcp->Sock, "\r\n", 2);
cb = 1;
}
/* write till next newline */
else
{
const char *pszNL = (const char *)memchr(pvBuf, '\n', cbLeft);
if (pszNL)
cb = (uintptr_t)pszNL - (uintptr_t)pvBuf;
rc = RTTcpWrite(pDbgcTcp->Sock, pvBuf, cb);
}
if (RT_FAILURE(rc))
{
pDbgcTcp->fAlive = false;
break;
}
/* advance */
cbLeft -= cb;
pvBuf = (const char *)pvBuf + cb;
}
/*
* Set returned value and return.
*/
if (pcbWritten)
*pcbWritten = cbBuf - cbLeft;
return rc;
}
/** @copydoc FNDBGCBACKSETREADY */
static DECLCALLBACK(void) dbgcTcpBackSetReady(PDBGCBACK pBack, bool fReady)
{
/* stub */
NOREF(pBack);
NOREF(fReady);
}
/**
* Serve a TCP Server connection.
*
* @returns VBox status code.
* @returns VERR_TCP_SERVER_STOP to terminate the server loop forcing
* the RTTcpCreateServer() call to return.
* @param Sock The socket which the client is connected to.
* The call will close this socket.
* @param pvUser The VM handle.
*/
static DECLCALLBACK(int) dbgcTcpConnection(RTSOCKET Sock, void *pvUser)
{
LogFlow(("dbgcTcpConnection: connection! Sock=%d pvUser=%p\n", Sock, pvUser));
/*
* Start the console.
*/
DBGCTCP DbgcTcp;
DbgcTcp.Back.pfnInput = dbgcTcpBackInput;
DbgcTcp.Back.pfnRead = dbgcTcpBackRead;
DbgcTcp.Back.pfnWrite = dbgcTcpBackWrite;
DbgcTcp.Back.pfnSetReady = dbgcTcpBackSetReady;
DbgcTcp.fAlive = true;
DbgcTcp.Sock = Sock;
int rc = DBGCCreate((PUVM)pvUser, &DbgcTcp.Back, 0);
LogFlow(("dbgcTcpConnection: disconnect rc=%Rrc\n", rc));
return rc;
}
/**
* Spawns a new thread with a TCP based debugging console service.
*
* @returns VBox status code.
* @param pUVM The user mode VM handle.
* @param ppvData Where to store a pointer to the instance data.
*/
DBGDECL(int) DBGCTcpCreate(PUVM pUVM, void **ppvData)
{
/*
* Check what the configuration says.
*/
PCFGMNODE pKey = CFGMR3GetChild(CFGMR3GetRootU(pUVM), "DBGC");
bool fEnabled;
int rc = CFGMR3QueryBoolDef(pKey, "Enabled", &fEnabled,
#if defined(VBOX_WITH_DEBUGGER) && defined(VBOX_WITH_DEBUGGER_TCP_BY_DEFAULT) && !defined(__L4ENV__) && !defined(DEBUG_dmik)
true
#else
false
#endif
);
if (RT_FAILURE(rc))
return VM_SET_ERROR_U(pUVM, rc, "Configuration error: Failed querying \"DBGC/Enabled\"");
if (!fEnabled)
{
LogFlow(("DBGCTcpCreate: returns VINF_SUCCESS (Disabled)\n"));
return VINF_SUCCESS;
}
/*
* Get the port configuration.
*/
uint32_t u32Port;
rc = CFGMR3QueryU32Def(pKey, "Port", &u32Port, 5000);
if (RT_FAILURE(rc))
return VM_SET_ERROR_U(pUVM, rc, "Configuration error: Failed querying \"DBGC/Port\"");
/*
* Get the address configuration.
*/
char szAddress[512];
rc = CFGMR3QueryStringDef(pKey, "Address", szAddress, sizeof(szAddress), "");
if (RT_FAILURE(rc))
return VM_SET_ERROR_U(pUVM, rc, "Configuration error: Failed querying \"DBGC/Address\"");
/*
* Create the server (separate thread).
*/
PRTTCPSERVER pServer;
rc = RTTcpServerCreate(szAddress, u32Port, RTTHREADTYPE_DEBUGGER, "DBGC", dbgcTcpConnection, pUVM, &pServer);
if (RT_SUCCESS(rc))
{
LogFlow(("DBGCTcpCreate: Created server on port %d %s\n", u32Port, szAddress));
*ppvData = pServer;
return rc;
}
LogFlow(("DBGCTcpCreate: returns %Rrc\n", rc));
return VM_SET_ERROR_U(pUVM, rc, "Cannot start TCP-based debugging console service");
}
/**
* Terminates any running TCP base debugger console service.
*
* @returns VBox status code.
* @param pUVM The user mode VM handle.
* @param pvData The data returned by DBGCTcpCreate.
*/
DBGDECL(int) DBGCTcpTerminate(PUVM pUVM, void *pvData)
{
RT_NOREF1(pUVM);
/*
* Destroy the server instance if any.
*/
if (pvData)
{
int rc = RTTcpServerDestroy((PRTTCPSERVER)pvData);
AssertRC(rc);
}
return VINF_SUCCESS;
}
|
