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
|
/* $Id: VirtualKD.cpp $ */
/** @file
* VirtualKD - Device stub/loader for fast Windows kernel-mode debugging.
*
* Contributed by: Ivan Shcherbakov
* Heavily modified after the contribution.
*/
/*
* Copyright (C) 2010-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 *
*********************************************************************************************************************************/
#define LOG_GROUP LOG_GROUP_DEV // LOG_GROUP_DEV_VIRTUALKD
#include <VBox/vmm/pdmdev.h>
#include <VBox/log.h>
#include <iprt/assert.h>
#include <iprt/path.h>
#include "VBoxDD.h"
/*********************************************************************************************************************************
* Defined Constants And Macros *
*********************************************************************************************************************************/
#define IKDClient_InterfaceVersion 3
/*********************************************************************************************************************************
* Structures and Typedefs *
*********************************************************************************************************************************/
typedef struct VKDREQUESTHDR
{
unsigned cbData;
unsigned cbReplyMax;
} VKDREQUESTHDR;
#pragma pack(1)
typedef struct VKDREPLYHDR
{
unsigned cbData;
char chOne;
char chSpace;
} VKDREPLYHDR;
#pragma pack()
AssertCompileSize(VKDREPLYHDR, 6);
class IKDClient
{
public:
virtual unsigned OnRequest(const char *pRequestIncludingRpcHeader, unsigned RequestSizeWithRpcHeader, char **ppReply)=0;
virtual ~IKDClient() {}
};
typedef IKDClient *(*PFNCreateVBoxKDClientEx)(unsigned version);
typedef struct VIRTUALKD
{
bool fOpenChannelDetected;
bool fChannelDetectSuccessful;
RTLDRMOD hLib;
IKDClient *pKDClient;
char abCmdBody[_256K];
} VIRTUALKD;
/*********************************************************************************************************************************
* Internal Functions *
*********************************************************************************************************************************/
static DECLCALLBACK(int) vkdPortRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb)
{
RT_NOREF(pvUser, Port, cb);
VIRTUALKD *pThis = PDMINS_2_DATA(pDevIns, VIRTUALKD *);
if (pThis->fOpenChannelDetected)
{
*pu32 = RT_MAKE_U32_FROM_U8('V', 'B', 'O', 'X'); /* 'XOBV', checked in VMWRPC.H */
pThis->fOpenChannelDetected = false;
pThis->fChannelDetectSuccessful = true;
}
else
*pu32 = UINT32_MAX;
return VINF_SUCCESS;
}
static DECLCALLBACK(int) vkdPortWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb)
{
RT_NOREF(pvUser, cb);
VIRTUALKD *pThis = PDMINS_2_DATA(pDevIns, VIRTUALKD *);
if (Port == 0x5659)
{
VKDREQUESTHDR RequestHeader = {0, };
int rc = PDMDevHlpPhysRead(pDevIns, (RTGCPHYS)u32, &RequestHeader, sizeof(RequestHeader));
if ( !RT_SUCCESS(rc)
|| !RequestHeader.cbData)
return VINF_SUCCESS;
unsigned cbData = RT_MIN(RequestHeader.cbData, sizeof(pThis->abCmdBody));
rc = PDMDevHlpPhysRead(pDevIns, (RTGCPHYS)(u32 + sizeof(RequestHeader)), pThis->abCmdBody, cbData);
if (!RT_SUCCESS(rc))
return VINF_SUCCESS;
char *pReply = NULL;
unsigned cbReply = pThis->pKDClient->OnRequest(pThis->abCmdBody, cbData, &pReply);
if (!pReply)
cbReply = 0;
VKDREPLYHDR ReplyHeader;
ReplyHeader.cbData = cbReply + 2;
ReplyHeader.chOne = '1';
ReplyHeader.chSpace = ' ';
rc = PDMDevHlpPhysWrite(pDevIns, (RTGCPHYS)u32, &ReplyHeader, sizeof(ReplyHeader));
if (!RT_SUCCESS(rc))
return VINF_SUCCESS;
if (cbReply)
{
rc = PDMDevHlpPhysWrite(pDevIns, (RTGCPHYS)(u32 + sizeof(ReplyHeader)), pReply, cbReply);
if (!RT_SUCCESS(rc))
return VINF_SUCCESS;
}
}
else if (Port == 0x5658)
{
if (u32 == 0x564D5868)
pThis->fOpenChannelDetected = true;
else
pThis->fOpenChannelDetected = false;
}
return VINF_SUCCESS;
}
/**
* @interface_method_impl{PDMDEVREG,pfnDestruct}
*/
static DECLCALLBACK(int) vkdDestruct(PPDMDEVINS pDevIns)
{
PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
VIRTUALKD *pThis = PDMINS_2_DATA(pDevIns, VIRTUALKD *);
delete pThis->pKDClient;
if (pThis->hLib != NIL_RTLDRMOD)
RTLdrClose(pThis->hLib);
return VINF_SUCCESS;
}
/**
* @interface_method_impl{PDMDEVREG,pfnConstruct}
*/
static DECLCALLBACK(int) vkdConstruct(PPDMDEVINS pDevIns, int iInstance, PCFGMNODE pCfg)
{
RT_NOREF(iInstance);
PDMDEV_CHECK_VERSIONS_RETURN(pDevIns);
VIRTUALKD *pThis = PDMINS_2_DATA(pDevIns, VIRTUALKD *);
pThis->fOpenChannelDetected = false;
pThis->fChannelDetectSuccessful = false;
pThis->hLib = NIL_RTLDRMOD;
pThis->pKDClient = NULL;
if (!CFGMR3AreValuesValid(pCfg,
"Path\0"))
return VERR_PDM_DEVINS_UNKNOWN_CFG_VALUES;
/* This device is a bit unusual, after this point it will not fail to be
* constructed, but there will be a warning and it will not work. */
char szPath[RTPATH_MAX] = "";
CFGMR3QueryString(pCfg, "Path", szPath, sizeof(szPath));
RTPathAppend(szPath, sizeof(szPath), HC_ARCH_BITS == 64 ? "kdclient64.dll" : "kdclient.dll");
int rc = RTLdrLoad(szPath, &pThis->hLib);
if (RT_FAILURE(rc))
{
PDMDevHlpVMSetRuntimeError(pDevIns, 0 /* fFlags */, "VirtualKD_LOAD",
N_("Failed to load VirtualKD library '%s'. Fast kernel-mode debugging will not work"), szPath);
return VINF_SUCCESS;
}
PFNCreateVBoxKDClientEx pfnInit;
rc = RTLdrGetSymbol(pThis->hLib, "CreateVBoxKDClientEx", (void **)&pfnInit);
if (RT_FAILURE(rc))
{
RTLdrClose(pThis->hLib);
pThis->hLib = NIL_RTLDRMOD;
PDMDevHlpVMSetRuntimeError(pDevIns, 0 /* fFlags */, "VirtualKD_SYMBOL",
N_("Failed to find entry point for VirtualKD library '%s'. Fast kernel-mode debugging will not work"), szPath);
return VINF_SUCCESS;
}
pThis->pKDClient = pfnInit(IKDClient_InterfaceVersion);
if (!pThis->pKDClient)
{
RTLdrClose(pThis->hLib);
pThis->hLib = NIL_RTLDRMOD;
PDMDevHlpVMSetRuntimeError(pDevIns, 0 /* fFlags */, "VirtualKD_INIT",
N_("Failed to initialize VirtualKD library '%s'. Fast kernel-mode debugging will not work"), szPath);
return VINF_SUCCESS;
}
return PDMDevHlpIOPortRegister(pDevIns, 0x5658, 2, NULL, vkdPortWrite, vkdPortRead, NULL, NULL, "VirtualKD");
}
/**
* The device registration structure.
*/
const PDMDEVREG g_DeviceVirtualKD =
{
/* u32Version */
PDM_DEVREG_VERSION,
/* szName */
"VirtualKD",
/* szRCMod */
"",
/* szR0Mod */
"",
/* pszDescription */
"Provides fast debugging interface when debugging Windows kernel",
/* fFlags */
PDM_DEVREG_FLAGS_DEFAULT_BITS,
/* fClass */
PDM_DEVREG_CLASS_MISC,
/* cMaxInstances */
1,
/* cbInstance */
sizeof(VIRTUALKD),
/* pfnConstruct */
vkdConstruct,
/* pfnDestruct */
vkdDestruct,
/* pfnRelocate */
NULL,
/* pfnIOCtl */
NULL,
/* pfnPowerOn */
NULL,
/* pfnReset */
NULL,
/* pfnSuspend */
NULL,
/* pfnResume */
NULL,
/* pfnAttach */
NULL,
/* pfnDetach */
NULL,
/* pfnQueryInterface */
NULL,
/* pfnInitComplete */
NULL,
/* pfnPowerOff */
NULL,
/* pfnSoftReset */
NULL,
/* u32VersionEnd */
PDM_DEVREG_VERSION
};
|
