DBGConsole.cpp revision 5dd0f48aea5b772d5b217101f71606345feb8d3b
/* $Id$ */
/** @file
* DBGC - Debugger Console.
*/
/*
* Copyright (C) 2006-2011 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* 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.
*/
/** @page pg_dbgc DBGC - The Debug Console
*
* The debugger console is an early attempt to make some interactive
* debugging facilities for the VirtualBox VMM. It was initially only
* accessible thru a telnet session on debug builds. Later it was hastily
* built into the VBoxDbg module with a very simple Qt wrapper around it.
*
* The debugger is optional and presently not built into release builds
* of VirtualBox. It is therefore necessary to enclose code related to it
* in \#ifdef VBOX_WITH_DEBUGGER blocks. This is mandatory for components
* that register extenral commands.
*
*
* @section sec_dbgc_op Operation (intentions)
*
* The console will process commands in a manner similar to the OS/2 and
* windows kernel debuggers. This means ';' is a command separator and
* that when possible we'll use the same command names as these two uses.
*
*
* @subsection sec_dbg_op_numbers Numbers
*
* Numbers are hexadecimal unless specified with a prefix indicating
* elsewise. Prefixes:
* - '0x' - hexadecimal.
* - '0i' - decimal
* - '0t' - octal.
* - '0y' - binary.
*
* Some of the prefixes are a bit uncommon, the reason for this that
* the typical binary prefix '0b' can also be a hexadecimal value since
* no prefix or suffix is required for such values. Ditto for '0d' and
* '0' for decimal and octal.
*
*
* @subsection sec_dbg_op_address Addressing modes
*
* - Default is flat. For compatibility '%' also means flat.
* - Segmented addresses are specified selector:offset.
* - Physical addresses are specified using '%%'.
* - The default target for the addressing is the guest context, the '#'
* will override this and set it to the host.
* Note that several operations won't work on host addresses.
*
* The '%', '%%' and '#' prefixes is implemented as unary operators, while ':'
* is a binary operator. Operator precedence takes care of evaluation order.
*
*
* @subsection sec_dbg_op_evalution Evaluation
*
* Most unary and binary C operators are supported, check the help text for
* details. However, some of these are not yet implemented because this is
* tiresome and annoying work. So, if something is missing and you need it
* you implement it or complain to bird. (Ditto for missing functions.)
*
* Simple variable support is provided thru the 'set' and 'unset' commands and
* the unary '$' operator.
*
* The unary '@' operator will indicate function calls. Commands and functions
* are the same thing, except that functions has a return type.
*
*
* @subsection sec_dbg_op_registers Registers
*
* Registers are addressed using their name. Some registers which have several fields
* (like gdtr) will have separate names indicating the different fields. The default
* register set is the guest one. To access the hypervisor register one have to
* prefix the register names with '.'.
*
* The registers are implemented as built-in symbols. For making gdb guys more at
* home it is possible to access them with the '$' operator, i.e. as a variable.
*
*
* @subsection sec_dbg_op_commands Commands and Functions
*
* Commands and functions are the same thing, except that functions may return a
* can detect whether they are invoked as a command or function by checking whether
* there is a return variable or not.
*
* with a letter. Operator characters are not permitted in the names of course.
* Space is allowed, but must be flagged so the parser can check for multiple
* spaces and tabs. (This feature is for 'dump xyz' and for emulating the
* gdb 'info abc'.)
*
* The '.' prefix indicates the set of external commands. External commands are
* command registered by VMM components.
*
*
* @section sec_dbgc_logging Logging
*
* The idea is to be able to pass thru debug and release logs to the console
* if the user so wishes. This feature requires some kind of hook into the
* logger instance and while this was sketched it hasn't yet been implemented
* (dbgcProcessLog and DBGC::fLog).
*
*
*
* @section sec_dbgc_linking Linking and API
*
* The DBGC code is linked into the VBoxVMM module. (At present it is also
* linked into VBoxDbg, but this is obviously very wrong.)
*
* A COM object will be created for the DBGC so it can be operated remotely
* without using TCP. VBoxDbg is the intended audience for this usage. Some
* questions about callbacks (for output) and security (you may wish to
* restrict users from debugging a VM) needs to be answered first though.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#define LOG_GROUP LOG_GROUP_DBGC
#include "DBGCInternal.h"
#include "DBGPlugIns.h"
/*******************************************************************************
* Internal Functions *
*******************************************************************************/
/**
* Resolves a symbol (or tries to do so at least).
*
* @returns 0 on success.
* @returns VBox status on failure.
* @param pDbgc The debug console instance.
* @param pszSymbol The symbol name.
* @param enmType The result type. Specifying DBGCVAR_TYPE_GC_FAR may
* cause failure, avoid it.
* @param pResult Where to store the result.
*/
{
int rc;
/*
* Builtin?
*/
if (pSymDesc)
{
return VERR_DBGC_PARSE_WRITEONLY_SYMBOL;
}
/*
* A typical register? (Guest only)
*/
static const char s_szSixLetterRegisters[] =
"rflags;eflags;"
;
static const char s_szThreeLetterRegisters[] =
"eax;rax;" "r10;" "r8d;r8w;r8b;" "cr0;" "dr0;"
"ebx;rbx;" "r11;" "r9d;r9w;r8b;" "dr1;"
"ecx;rcx;" "r12;" "cr2;" "dr2;"
"edx;rdx;" "r13;" "cr3;" "dr3;"
"edi;rdi;dil;" "r14;" "cr4;" "dr4;"
"esi;rsi;sil;" "r15;" "cr8;"
"ebp;rbp;"
"esp;rsp;" "dr6;"
"rip;eip;" "dr7;"
"efl;"
;
static const char s_szTwoLetterRegisters[] =
"ax;al;ah;" "r8;"
"bx;bl;bh;" "r9;"
"cx;cl;ch;" "cs;"
"dx;dl;dh;" "ds;"
"di;" "es;"
"si;" "fs;"
"bp;" "gs;"
"sp;" "ss;"
"ip;"
;
{
{
if (RT_SUCCESS(rc))
}
}
/*
* Ask PDM.
*/
/** @todo resolve symbols using PDM. */
/*
* Ask the debug info manager.
*/
if (RT_SUCCESS(rc))
{
/*
* Default return is a flat gc address.
*/
switch (enmType)
{
/* nothing to do. */
case DBGCVAR_TYPE_GC_FLAT:
case DBGCVAR_TYPE_ANY:
return VINF_SUCCESS;
/* impossible at the moment. */
case DBGCVAR_TYPE_GC_FAR:
/* simply make it numeric. */
case DBGCVAR_TYPE_NUMBER:
return VINF_SUCCESS;
/* cast it. */
case DBGCVAR_TYPE_GC_PHYS:
case DBGCVAR_TYPE_HC_FLAT:
case DBGCVAR_TYPE_HC_PHYS:
default:
return VERR_INVALID_PARAMETER;
}
}
return VERR_DBGC_PARSE_NOT_IMPLEMENTED;
}
/**
* Process all commands currently in the buffer.
*
* @returns VBox status code. Any error indicates the termination of the console session.
* @param pDbgc Debugger console instance data.
* @param fNoExecute Indicates that no commands should actually be executed.
*/
{
* allows doing function, loops, if, cases, and such. */
int rc = VINF_SUCCESS;
while (pDbgc->cInputLines)
{
/*
* Empty the log buffer if we're hooking the log.
*/
{
if (RT_FAILURE(rc))
break;
}
{
pDbgc->cInputLines = 0;
return 0;
}
/*
* Copy the command to the parse buffer.
*/
char ch;
{
{
pDbgc->cInputLines = 0;
return 0;
}
pszTrg++;
}
*pszTrg = '\0';
/*
* Advance the buffer.
*/
if (ch == '\n')
pDbgc->cInputLines--;
/*
* Parse and execute this command.
*/
if ( rc == VERR_DBGC_QUIT
|| rc == VWRN_DBGC_CMD_PENDING)
break;
}
return rc;
}
/**
* Handle input buffer overflow.
*
* Will read any available input looking for a '\n' to reset the buffer on.
*
* @returns VBox status.
* @param pDbgc Debugger console instance data.
*/
{
/*
* Assert overflow status and reset the input buffer.
*/
if (!pDbgc->fInputOverflow)
{
pDbgc->fInputOverflow = true;
pDbgc->cInputLines = 0;
}
/*
* Eat input till no more or there is a '\n'.
* When finding a '\n' we'll continue normal processing.
*/
{
int rc = pDbgc->pBack->pfnRead(pDbgc->pBack, &pDbgc->achInput[0], sizeof(pDbgc->achInput) - 1, &cbRead);
if (RT_FAILURE(rc))
return rc;
if (psz)
{
pDbgc->fInputOverflow = false;
pDbgc->cInputLines = 0;
break;
}
}
return 0;
}
/**
* Read input and do some preprocessing.
*
* @returns VBox status.
* In addition to the iWrite and achInput, cInputLines is maintained.
* In case of an input overflow the fInputOverflow flag will be set.
* @param pDbgc Debugger console instance data.
*/
{
/*
* We have ready input.
* Read it till we don't have any or we have a full input buffer.
*/
int rc = 0;
do
{
/*
* More available buffer space?
*/
else
if (!cbLeft)
{
/* overflow? */
if (!pDbgc->cInputLines)
break;
}
/*
* Read one char and interpret it.
*/
char achRead[128];
if (RT_FAILURE(rc))
return rc;
while (cbRead-- > 0)
{
switch (ch)
{
/*
* Ignore.
*/
case '\0':
case '\r':
case '\a':
break;
/*
* Backspace.
*/
case '\b':
Log2(("DBGC: backspace\n"));
{
else
}
break;
/*
* Add char to buffer.
*/
case '\t':
case '\n':
case ';':
switch (ch)
{
}
default:
break;
}
}
/* Terminate it to make it easier to read in the debugger. */
return rc;
}
/**
* Reads input, parses it and executes commands on '\n'.
*
* @returns VBox status.
* @param pDbgc Debugger console instance data.
* @param fNoExecute Indicates that no commands should actually be executed.
*/
{
/*
* We know there's input ready, so let's read it first.
*/
if (RT_FAILURE(rc))
return rc;
/*
* Now execute any ready commands.
*/
if (pDbgc->cInputLines)
{
if ( RT_SUCCESS(rc)
if ( RT_SUCCESS(rc)
}
else
/* Received nonsense; just skip it. */
return rc;
}
/**
* Gets the event context identifier string.
* @returns Read only string.
* @param enmCtx The context.
*/
{
switch (enmCtx)
{
case DBGFEVENTCTX_RAW: return "raw";
case DBGFEVENTCTX_REM: return "rem";
case DBGFEVENTCTX_HWACCL: return "hwaccl";
case DBGFEVENTCTX_HYPER: return "hyper";
case DBGFEVENTCTX_OTHER: return "other";
case DBGFEVENTCTX_INVALID: return "!Invalid Event Ctx!";
default:
return "!Unknown Event Ctx!";
}
}
/**
* Processes debugger events.
*
* @returns VBox status.
* @param pDbgc DBGC Instance data.
* @param pEvent Pointer to event data.
*/
{
/*
* Flush log first.
*/
{
if (RT_FAILURE(rc))
return rc;
}
/*
* Process the event.
*/
bool fPrintPrompt = true;
int rc = VINF_SUCCESS;
{
/*
* The first part is events we have initiated with commands.
*/
case DBGFEVENT_HALT_DONE:
{
if (RT_SUCCESS(rc))
break;
}
/*
* The second part is events which can occur at any time.
*/
case DBGFEVENT_FATAL_ERROR:
{
if (RT_SUCCESS(rc))
break;
}
case DBGFEVENT_BREAKPOINT:
{
switch (rc)
{
case VERR_DBGC_BP_NOT_FOUND:
break;
case VINF_DBGC_BP_NO_COMMAND:
break;
case VINF_BUFFER_OVERFLOW:
rc = pDbgc->CmdHlp.pfnPrintf(&pDbgc->CmdHlp, NULL, "\ndbgf event: Breakpoint %u! Command too long to execute! (%s)\n",
break;
default:
break;
}
else
break;
}
case DBGFEVENT_STEPPED:
case DBGFEVENT_STEPPED_HYPER:
{
rc = pDbgc->CmdHlp.pfnPrintf(&pDbgc->CmdHlp, NULL, "\ndbgf event: Single step! (%s)\n", dbgcGetEventCtx(pEvent->enmCtx));
if (RT_SUCCESS(rc))
break;
}
{
pDbgc->fRegCtxGuest = false;
"\ndbgf event: Hypervisor Assertion! (%s)\n"
"%s"
"%s"
"\n",
if (RT_SUCCESS(rc))
break;
}
case DBGFEVENT_DEV_STOP:
{
"\n"
"dbgf event: DBGFSTOP (%s)\n"
"File: %s\n"
"Line: %d\n"
"Function: %s\n",
"Message: %s\n",
if (RT_SUCCESS(rc))
break;
}
{
break;
}
case DBGFEVENT_TERMINATING:
{
fPrintPrompt = false;
break;
}
default:
{
rc = pDbgc->CmdHlp.pfnPrintf(&pDbgc->CmdHlp, NULL, "\ndbgf/dbgc error: Unknown event %d!\n", pEvent->enmType);
break;
}
}
/*
* Prompt, anyone?
*/
{
if (RT_SUCCESS(rc))
}
return rc;
}
/**
* Prints any log lines from the log buffer.
*
* The caller must not call function this unless pDbgc->fLog is set.
*
* @returns VBox status. (output related)
* @param pDbgc Debugger console instance data.
*/
{
/** @todo */
return 0;
}
/**
* Run the debugger console.
*
* @returns VBox status.
* @param pDbgc Pointer to the debugger console instance data.
*/
{
/*
* We're ready for commands now.
*/
/*
* Main Debugger Loop.
*
* This loop will either block on waiting for input or on waiting on
* debug events. If we're forwarding the log we cannot wait for long
* before we must flush the log.
*/
int rc = VINF_SUCCESS;
for (;;)
{
{
/*
* Wait for a debug event.
*/
if (RT_SUCCESS(rc))
{
if (RT_FAILURE(rc))
break;
}
else if (rc != VERR_TIMEOUT)
break;
/*
* Check for input.
*/
{
if (RT_FAILURE(rc))
break;
}
}
else
{
/*
* Wait for input. If Logging is enabled we'll only wait very briefly.
*/
{
if (RT_FAILURE(rc))
break;
}
}
/*
* Forward log output.
*/
{
if (RT_FAILURE(rc))
break;
}
}
return rc;
}
/**
* Creates a a new instance.
*
* @returns VBox status code.
* @param ppDbgc Where to store the pointer to the instance data.
* @param pBack Pointer to the backend.
* @param fFlags The flags.
*/
{
/*
* Validate input.
*/
/*
* Allocate and initialize.
*/
if (!pDbgc)
return VERR_NO_MEMORY;
//pDbgc->fLog = false;
pDbgc->fRegCtxGuest = true;
//pDbgc->cPagingHierarchyDumps = 0;
//pDbgc->DisasmPos = {0};
//pDbgc->SourcePos = {0};
//pDbgc->DumpPos = {0};
//pDbgc->cbDumpElement = 0;
//pDbgc->cVars = 0;
//pDbgc->paVars = NULL;
//pDbgc->pPlugInHead = NULL;
//pDbgc->pFirstBp = NULL;
//pDbgc->abSearch = {0};
//pDbgc->cbSearch = 0;
//pDbgc->SearchAddr = {0};
//pDbgc->cbSearchRange = 0;
//pDbgc->uInputZero = 0;
//pDbgc->iRead = 0;
//pDbgc->iWrite = 0;
//pDbgc->cInputLines = 0;
//pDbgc->fInputOverflow = false;
//pDbgc->iArg = 0;
//pDbgc->rcOutput = 0;
//pDbgc->rcCmd = 0;
dbgcEvalInit();
return VINF_SUCCESS;
}
/**
* Destroys a DBGC instance created by dbgcCreate.
*
* @param pDbgc Pointer to the debugger console instance data.
*/
{
/* Disable log hook. */
{
}
/* Unload all plug-ins. */
/* Detach from the VM. */
/* finally, free the instance memory. */
}
/**
* Make a console instance.
*
* This will not return until either an 'exit' command is issued or a error code
* indicating connection loss is encountered.
*
* @returns VINF_SUCCESS if console termination caused by the 'exit' command.
* @returns The VBox status code causing the console termination.
*
* @param pVM VM Handle.
* @param pBack Pointer to the backend structure. This must contain
* a full set of function pointers to service the console.
* @param fFlags Reserved, must be zero.
* @remark A forced termination of the console is easiest done by forcing the
* callbacks to return fatal failures.
*/
{
/*
* Validate input.
*/
/*
* Allocate and initialize instance data
*/
if (RT_FAILURE(rc))
return rc;
/*
* Print welcome message.
*/
"Welcome to the VirtualBox Debugger!\n");
/*
* Attach to the specified VM.
*/
{
if (RT_SUCCESS(rc))
{
"Current VM is %08x, CPU #%u\n" /** @todo get and print the VM name! */
}
else
rc = pDbgc->CmdHlp.pfnVBoxError(&pDbgc->CmdHlp, rc, "When trying to attach to VM %p\n", pDbgc->pVM);
}
/*
* Load plugins.
*/
if (RT_SUCCESS(rc))
{
if (pVM)
}
else
/*
* Run the debugger main loop.
*/
if (RT_SUCCESS(rc))
/*
* Cleanup console debugger session.
*/
}