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
|
/* $Id: VBoxDbg.cpp $ */
/** @file
* VBox Debugger GUI.
*/
/*
* Copyright (C) 2006-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 *
*********************************************************************************************************************************/
#define LOG_GROUP LOG_GROUP_DBGG
#define VBOX_COM_NO_ATL
#ifdef RT_OS_WINDOWS
# include <iprt/win/windows.h> /* Include via cleanup wrapper before VirtualBox.h includes it via rpc.h. */
# include <VirtualBox.h>
#else /* !RT_OS_WINDOWS */
# include <VirtualBox_XPCOM.h>
#endif /* !RT_OS_WINDOWS */
#include <VBox/dbggui.h>
#include <iprt/errcore.h>
#include <iprt/assert.h>
#include <iprt/alloc.h>
#include "VBoxDbgGui.h"
/*********************************************************************************************************************************
* Structures and Typedefs *
*********************************************************************************************************************************/
/**
* Debugger GUI instance data.
*/
typedef struct DBGGUI
{
/** Magic number (DBGGUI_MAGIC). */
uint32_t u32Magic;
/** Pointer to the Debugger GUI manager object. */
VBoxDbgGui *pVBoxDbgGui;
} DBGGUI;
/** DBGGUI magic value (Werner Heisenberg). */
#define DBGGUI_MAGIC 0x19011205
/** Invalid DBGGUI magic value. */
#define DBGGUI_MAGIC_DEAD 0x19760201
/*********************************************************************************************************************************
* Global Variables *
*********************************************************************************************************************************/
/** Virtual method table for simplifying dynamic linking. */
static const DBGGUIVT g_dbgGuiVT =
{
DBGGUIVT_VERSION,
DBGGuiDestroy,
DBGGuiAdjustRelativePos,
DBGGuiShowStatistics,
DBGGuiShowCommandLine,
DBGGuiSetParent,
DBGGuiSetMenu,
DBGGUIVT_VERSION
};
/**
* Internal worker for DBGGuiCreate and DBGGuiCreateForVM.
*
* @returns VBox status code.
* @param pSession The ISession interface. (DBGGuiCreate)
* @param pUVM The VM handle. (DBGGuiCreateForVM)
* @param pVMM The VMM function table.
* @param ppGui See DBGGuiCreate.
* @param ppGuiVT See DBGGuiCreate.
*/
static int dbgGuiCreate(ISession *pSession, PUVM pUVM, PCVMMR3VTABLE pVMM, PDBGGUI *ppGui, PCDBGGUIVT *ppGuiVT)
{
/*
* Allocate and initialize the Debugger GUI handle.
*/
PDBGGUI pGui = (PDBGGUI)RTMemAlloc(sizeof(*pGui));
if (!pGui)
return VERR_NO_MEMORY;
pGui->u32Magic = DBGGUI_MAGIC;
pGui->pVBoxDbgGui = new VBoxDbgGui();
int rc;
if (pSession)
rc = pGui->pVBoxDbgGui->init(pSession);
else
rc = pGui->pVBoxDbgGui->init(pUVM, pVMM);
if (RT_SUCCESS(rc))
{
/*
* Successfully initialized.
*/
*ppGui = pGui;
if (ppGuiVT)
*ppGuiVT = &g_dbgGuiVT;
return rc;
}
/*
* Failed, cleanup.
*/
delete pGui->pVBoxDbgGui;
RTMemFree(pGui);
*ppGui = NULL;
if (ppGuiVT)
*ppGuiVT = NULL;
return rc;
}
/**
* Creates the debugger GUI.
*
* @returns VBox status code.
* @param pSession The VirtualBox session.
* @param ppGui Where to store the pointer to the debugger instance.
* @param ppGuiVT Where to store the virtual method table pointer.
* Optional.
*/
DBGDECL(int) DBGGuiCreate(ISession *pSession, PDBGGUI *ppGui, PCDBGGUIVT *ppGuiVT)
{
AssertPtrReturn(pSession, VERR_INVALID_POINTER);
return dbgGuiCreate(pSession, NULL, NULL, ppGui, ppGuiVT);
}
/**
* Creates the debugger GUI given a VM handle.
*
* @returns VBox status code.
* @param pUVM The VM handle.
* @param pVMM The VMM function table.
* @param ppGui Where to store the pointer to the debugger instance.
* @param ppGuiVT Where to store the virtual method table pointer.
* Optional.
*/
DBGDECL(int) DBGGuiCreateForVM(PUVM pUVM, PCVMMR3VTABLE pVMM, PDBGGUI *ppGui, PCDBGGUIVT *ppGuiVT)
{
AssertPtrReturn(pUVM, VERR_INVALID_POINTER);
AssertPtrReturn(pVMM, VERR_INVALID_POINTER);
AssertReturn(VMMR3VTABLE_IS_COMPATIBLE(pVMM->uMagicVersion), VERR_VERSION_MISMATCH);
AssertReturn(pVMM->pfnVMR3RetainUVM(pUVM) != UINT32_MAX, VERR_INVALID_POINTER);
int rc = dbgGuiCreate(NULL, pUVM, pVMM, ppGui, ppGuiVT);
pVMM->pfnVMR3ReleaseUVM(pUVM);
return rc;
}
/**
* Destroys the debugger GUI.
*
* @returns VBox status code.
* @param pGui The instance returned by DBGGuiCreate().
*/
DBGDECL(int) DBGGuiDestroy(PDBGGUI pGui)
{
/*
* Validate.
*/
if (!pGui)
return VERR_INVALID_PARAMETER;
AssertMsgReturn(pGui->u32Magic == DBGGUI_MAGIC, ("u32Magic=%#x\n", pGui->u32Magic), VERR_INVALID_PARAMETER);
/*
* Do the job.
*/
pGui->u32Magic = DBGGUI_MAGIC_DEAD;
delete pGui->pVBoxDbgGui;
RTMemFree(pGui);
return VINF_SUCCESS;
}
/**
* Notifies the debugger GUI that the console window (or whatever) has changed
* size or position.
*
* @param pGui The instance returned by DBGGuiCreate().
* @param x The x-coordinate of the window the debugger is relative to.
* @param y The y-coordinate of the window the debugger is relative to.
* @param cx The width of the window the debugger is relative to.
* @param cy The height of the window the debugger is relative to.
*/
DBGDECL(void) DBGGuiAdjustRelativePos(PDBGGUI pGui, int x, int y, unsigned cx, unsigned cy)
{
AssertReturn(pGui, (void)VERR_INVALID_PARAMETER);
AssertMsgReturn(pGui->u32Magic == DBGGUI_MAGIC, ("u32Magic=%#x\n", pGui->u32Magic), (void)VERR_INVALID_PARAMETER);
pGui->pVBoxDbgGui->adjustRelativePos(x, y, cx, cy);
}
/**
* Shows the default statistics window.
*
* @returns VBox status code.
* @param pGui The instance returned by DBGGuiCreate().
* @param pszFilter Filter pattern.
* @param pszExpand Expand pattern.
*/
DBGDECL(int) DBGGuiShowStatistics(PDBGGUI pGui, const char *pszFilter, const char *pszExpand)
{
AssertReturn(pGui, VERR_INVALID_PARAMETER);
AssertMsgReturn(pGui->u32Magic == DBGGUI_MAGIC, ("u32Magic=%#x\n", pGui->u32Magic), VERR_INVALID_PARAMETER);
return pGui->pVBoxDbgGui->showStatistics(pszFilter, pszExpand);
}
/**
* Shows the default command line window.
*
* @returns VBox status code.
* @param pGui The instance returned by DBGGuiCreate().
*/
DBGDECL(int) DBGGuiShowCommandLine(PDBGGUI pGui)
{
AssertReturn(pGui, VERR_INVALID_PARAMETER);
AssertMsgReturn(pGui->u32Magic == DBGGUI_MAGIC, ("u32Magic=%#x\n", pGui->u32Magic), VERR_INVALID_PARAMETER);
return pGui->pVBoxDbgGui->showConsole();
}
/**
* Sets the parent windows.
*
* @param pGui The instance returned by DBGGuiCreate().
* @param pvParent Pointer to a QWidget object.
*
* @remarks This will no affect any existing windows, so call it right after
* creating the thing.
*/
DBGDECL(void) DBGGuiSetParent(PDBGGUI pGui, void *pvParent)
{
return pGui->pVBoxDbgGui->setParent((QWidget *)pvParent);
}
/**
* Sets the debug menu object.
*
* @param pGui The instance returned by DBGGuiCreate().
* @param pvMenu Pointer to a QMenu object.
*
* @remarks Call right after creation or risk losing menu item.
*/
DBGDECL(void) DBGGuiSetMenu(PDBGGUI pGui, void *pvMenu)
{
return pGui->pVBoxDbgGui->setMenu((QMenu *)pvMenu);
}
|
