src/sim/debug.hh

   1 /*
   2  * Copyright (c) 2003-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Nathan Binkert
  29  */
  30
  31 #ifndef __SIM_DEBUG_HH__
  32 #define __SIM_DEBUG_HH__
  33
  34 #include "base/types.hh"
  35
  36 /** @file This file provides the definitions for some useful debugging
  37  * functions. These are intended to be called from a debugger such as
  38  * gdb.
  39  */
  40
  41
  42 /** Cause the simulator to execute a breakpoint
  43  * @param when the tick to break
  44  */
  45 void schedBreak(Tick when);
  46
  47 /**
  48  * Cause the simulator to execute a breakpoint
  49  * relative to the current tick.
  50  * @param delta the number of ticks to execute until breaking
  51  */
  52 void schedRelBreak(Tick delta);
  53
  54 /**
  55  * Cause the simulator to execute a breakpoint when
  56  * the given kernel function is reached
  57  * @param funcName the name of the kernel function at which to break
  58  */
  59 void breakAtKernelFunction(const char* funcName);
  60
  61 /** Cause the simulator to return to python to create a checkpoint
  62  * @param when the cycle to break
  63  */
  64 void takeCheckpoint(Tick when);
  65
  66 /** Dump all the events currently on the event queue
  67  */
  68 void eventqDump();
  69
  70 int getRemoteGDBPort();
  71 // Remote gdb base port.  0 disables remote gdb.
  72 void setRemoteGDBPort(int port);
  73
  74 #endif // __SIM_DEBUG_HH__