summaryrefslogtreecommitdiffstats
path: root/src/VBox/Debugger/VBoxDbg.cpp
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-06 03:01:46 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-06 03:01:46 +0000
commitf8fe689a81f906d1b91bb3220acde2a4ecb14c5b (patch)
tree26484e9d7e2c67806c2d1760196ff01aaa858e8c /src/VBox/Debugger/VBoxDbg.cpp
parentInitial commit. (diff)
downloadvirtualbox-upstream.tar.xz
virtualbox-upstream.zip
Adding upstream version 6.0.4-dfsg.upstream/6.0.4-dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/VBox/Debugger/VBoxDbg.cpp')
-rw-r--r--src/VBox/Debugger/VBoxDbg.cpp259
1 files changed, 259 insertions, 0 deletions
diff --git a/src/VBox/Debugger/VBoxDbg.cpp b/src/VBox/Debugger/VBoxDbg.cpp
new file mode 100644
index 00000000..9b53c46a
--- /dev/null
+++ b/src/VBox/Debugger/VBoxDbg.cpp
@@ -0,0 +1,259 @@
+/* $Id: VBoxDbg.cpp $ */
+/** @file
+ * VBox Debugger GUI.
+ */
+
+/*
+ * 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 *
+*********************************************************************************************************************************/
+#define LOG_GROUP LOG_GROUP_DBGG
+#define VBOX_COM_NO_ATL
+#ifdef RT_OS_WINDOWS
+# include <VirtualBox.h>
+#else /* !RT_OS_WINDOWS */
+# include <VirtualBox_XPCOM.h>
+#endif /* !RT_OS_WINDOWS */
+#include <VBox/dbggui.h>
+#include <VBox/vmm/vm.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 ppGui See DBGGuiCreate.
+ * @param ppGuiVT See DBGGuiCreate.
+ */
+static int dbgGuiCreate(ISession *pSession, PUVM pUVM, 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);
+ 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, ppGui, ppGuiVT);
+}
+
+
+/**
+ * Creates the debugger GUI given a VM handle.
+ *
+ * @returns VBox status code.
+ * @param pUVM The VM handle.
+ * @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, PDBGGUI *ppGui, PCDBGGUIVT *ppGuiVT)
+{
+ AssertPtrReturn(pUVM, VERR_INVALID_POINTER);
+ AssertPtrReturn(VMR3RetainUVM(pUVM) != UINT32_MAX, VERR_INVALID_POINTER);
+
+ int rc = dbgGuiCreate(NULL, pUVM, ppGui, ppGuiVT);
+
+ VMR3ReleaseUVM(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().
+ */
+DBGDECL(int) DBGGuiShowStatistics(PDBGGUI pGui)
+{
+ AssertReturn(pGui, VERR_INVALID_PARAMETER);
+ AssertMsgReturn(pGui->u32Magic == DBGGUI_MAGIC, ("u32Magic=%#x\n", pGui->u32Magic), VERR_INVALID_PARAMETER);
+ return pGui->pVBoxDbgGui->showStatistics();
+}
+
+
+/**
+ * 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);
+}
+