a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync/* $Id$ */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync/** @file
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * DBGC - Debugger Console, Command Worker Routines.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync/*
506df97a8c78dacfe69bc4d3ee5d3de832d0f19avboxsync * Copyright (C) 2006-2011 Oracle Corporation
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync *
6ec4e1827eab6a424d672ef0e5a17b065e52db20vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
6ec4e1827eab6a424d672ef0e5a17b065e52db20vboxsync * available from http://www.virtualbox.org. This file is free software;
6ec4e1827eab6a424d672ef0e5a17b065e52db20vboxsync * you can redistribute it and/or modify it under the terms of the GNU
6ec4e1827eab6a424d672ef0e5a17b065e52db20vboxsync * General Public License (GPL) as published by the Free Software
6ec4e1827eab6a424d672ef0e5a17b065e52db20vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
6ec4e1827eab6a424d672ef0e5a17b065e52db20vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
6ec4e1827eab6a424d672ef0e5a17b065e52db20vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync/*******************************************************************************
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync* Header Files *
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync*******************************************************************************/
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync#define LOG_GROUP LOG_GROUP_DBGC
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync#include <VBox/dbg.h>
43747b1f0bc8302a238fb35e55857a5e9aa1933dvboxsync#include <VBox/vmm/dbgf.h>
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync#include <VBox/param.h>
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync#include <VBox/err.h>
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync#include <VBox/log.h>
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync#include <iprt/alloc.h>
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync#include <iprt/string.h>
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync#include <iprt/assert.h>
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync#include "DBGCInternal.h"
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync//
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync//
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync// B r e a k p o i n t M a n a g e m e n t
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync//
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync//
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync/**
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Adds a breakpoint to the DBGC breakpoint list.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsyncint dbgcBpAdd(PDBGC pDbgc, RTUINT iBp, const char *pszCmd)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync{
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync /*
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Check if it already exists.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync PDBGCBP pBp = dbgcBpGet(pDbgc, iBp);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync if (pBp)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync return VERR_DBGC_BP_EXISTS;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync /*
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Add the breakpoint.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync if (pszCmd)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pszCmd = RTStrStripL(pszCmd);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync size_t cchCmd = pszCmd ? strlen(pszCmd) : 0;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pBp = (PDBGCBP)RTMemAlloc(RT_OFFSETOF(DBGCBP, szCmd[cchCmd + 1]));
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync if (!pBp)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync return VERR_NO_MEMORY;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync if (cchCmd)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync memcpy(pBp->szCmd, pszCmd, cchCmd + 1);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync else
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pBp->szCmd[0] = '\0';
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pBp->cchCmd = cchCmd;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pBp->iBp = iBp;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pBp->pNext = pDbgc->pFirstBp;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pDbgc->pFirstBp = pBp;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync return VINF_SUCCESS;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync}
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync/**
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Updates the a breakpoint.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync *
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @returns VBox status code.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @param pDbgc The DBGC instance.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @param iBp The breakpoint to update.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @param pszCmd The new command.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsyncint dbgcBpUpdate(PDBGC pDbgc, RTUINT iBp, const char *pszCmd)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync{
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync /*
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Find the breakpoint.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync PDBGCBP pBp = dbgcBpGet(pDbgc, iBp);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync if (!pBp)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync return VERR_DBGC_BP_NOT_FOUND;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync /*
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Do we need to reallocate?
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync if (pszCmd)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pszCmd = RTStrStripL(pszCmd);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync if (!pszCmd || !*pszCmd)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pBp->szCmd[0] = '\0';
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync else
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync {
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync size_t cchCmd = strlen(pszCmd);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync if (strlen(pBp->szCmd) >= cchCmd)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync {
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync memcpy(pBp->szCmd, pszCmd, cchCmd + 1);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pBp->cchCmd = cchCmd;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync }
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync else
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync {
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync /*
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Yes, let's do it the simple way...
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync int rc = dbgcBpDelete(pDbgc, iBp);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync AssertRC(rc);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync return dbgcBpAdd(pDbgc, iBp, pszCmd);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync }
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync }
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync return VINF_SUCCESS;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync}
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync/**
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Deletes a breakpoint.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync *
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @returns VBox status code.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @param pDbgc The DBGC instance.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @param iBp The breakpoint to delete.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsyncint dbgcBpDelete(PDBGC pDbgc, RTUINT iBp)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync{
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync /*
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Search thru the list, when found unlink and free it.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync PDBGCBP pBpPrev = NULL;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync PDBGCBP pBp = pDbgc->pFirstBp;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync for (; pBp; pBp = pBp->pNext)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync {
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync if (pBp->iBp == iBp)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync {
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync if (pBpPrev)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pBpPrev->pNext = pBp->pNext;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync else
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pDbgc->pFirstBp = pBp->pNext;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync RTMemFree(pBp);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync return VINF_SUCCESS;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync }
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pBpPrev = pBp;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync }
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync return VERR_DBGC_BP_NOT_FOUND;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync}
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync/**
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Get a breakpoint.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync *
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @returns Pointer to the breakpoint.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @returns NULL if the breakpoint wasn't found.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @param pDbgc The DBGC instance.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @param iBp The breakpoint to get.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsyncPDBGCBP dbgcBpGet(PDBGC pDbgc, RTUINT iBp)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync{
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync /*
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Enumerate the list.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync PDBGCBP pBp = pDbgc->pFirstBp;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync for (; pBp; pBp = pBp->pNext)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync if (pBp->iBp == iBp)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync return pBp;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync return NULL;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync}
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync/**
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Executes the command of a breakpoint.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync *
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @returns VINF_DBGC_BP_NO_COMMAND if there is no command associated with the breakpoint.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @returns VERR_DBGC_BP_NOT_FOUND if the breakpoint wasn't found.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @returns VERR_BUFFER_OVERFLOW if the is not enough space in the scratch buffer for the command.
6ffa2eb79bdf1b3299aacf589ece7b124ec34dc7vboxsync * @returns VBox status code from dbgcEvalCommand() otherwise.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @param pDbgc The DBGC instance.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * @param iBp The breakpoint to execute.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsyncint dbgcBpExec(PDBGC pDbgc, RTUINT iBp)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync{
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync /*
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Find the breakpoint.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync PDBGCBP pBp = dbgcBpGet(pDbgc, iBp);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync if (!pBp)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync return VERR_DBGC_BP_NOT_FOUND;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync /*
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Anything to do?
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync if (!pBp->cchCmd)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync return VINF_DBGC_BP_NO_COMMAND;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync /*
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * Execute the command.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * This means copying it to the scratch buffer and process it as if it
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync * were user input. We must save and restore the state of the scratch buffer.
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync /* Save the scratch state. */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync char *pszScratch = pDbgc->pszScratch;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync unsigned iArg = pDbgc->iArg;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync /* Copy the command to the scratch buffer. */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync size_t cbScratch = sizeof(pDbgc->achScratch) - (pDbgc->pszScratch - &pDbgc->achScratch[0]);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync if (pBp->cchCmd >= cbScratch)
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync return VERR_BUFFER_OVERFLOW;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync memcpy(pDbgc->pszScratch, pBp->szCmd, pBp->cchCmd + 1);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync /* Execute the command. */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pDbgc->pszScratch = pDbgc->pszScratch + pBp->cchCmd + 1;
506df97a8c78dacfe69bc4d3ee5d3de832d0f19avboxsync int rc = dbgcEvalCommand(pDbgc, pszScratch, pBp->cchCmd, false /* fNoExecute */);
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync /* Restore the scratch state. */
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pDbgc->iArg = iArg;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync pDbgc->pszScratch = pszScratch;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync return rc;
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync}
a33af978add1a03aab11b2895f441af5cb2a11a6vboxsync