src/sim/debug.cc

   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  *          Steve Reinhardt
  30  */
  31
  32 #include <Python.h>
  33
  34 #include <string>
  35 #include <vector>
  36
  37 #include "base/debug.hh"
  38 #include "sim/debug.hh"
  39 #include "sim/eventq.hh"
  40 #include "sim/sim_events.hh"
  41 #include "sim/sim_exit.hh"
  42
  43 using namespace std;
  44
  45 //
  46 // Debug event: place a breakpoint on the process function and
  47 // schedule the event to break at a particular cycle
  48 //
  49 struct DebugBreakEvent : public Event
  50 {
  51     DebugBreakEvent();
  52     void process();     // process event
  53     virtual const char *description() const;
  54 };
  55
  56 //
  57 // constructor: schedule at specified time
  58 //
  59 DebugBreakEvent::DebugBreakEvent()
  60     : Event(Debug_Break_Pri, AutoDelete)
  61 {
  62 }
  63
  64 //
  65 // handle debug event: set debugger breakpoint on this function
  66 //
  67 void
  68 DebugBreakEvent::process()
  69 {
  70     Debug::breakpoint();
  71 }
  72
  73
  74 const char *
  75 DebugBreakEvent::description() const
  76 {
  77     return "debug breakpoint";
  78 }
  79
  80 //
  81 // handy function to schedule DebugBreakEvent on main event queue
  82 // (callable from debugger)
  83 //
  84 void
  85 schedBreakCycle(Tick when)
  86 {
  87     mainEventQueue.schedule(new DebugBreakEvent, when);
  88     warn("need to stop all queues");
  89 }
  90
  91 ///
  92 /// Function to cause the simulator to take a checkpoint from the debugger
  93 ///
  94 void
  95 takeCheckpoint(Tick when)
  96 {
  97     if (!when)
  98         when = curTick() + 1;
  99     exitSimLoop("checkpoint", 0, when, 0);
 100 }
 101
 102 void
 103 eventqDump()
 104 {
 105     mainEventQueue.dump();
 106     warn("need to dump all queues");
 107 }
 108
 109 void
 110 py_interact()
 111 {
 112     PyObject *globals;
 113     PyObject *locals;
 114
 115     globals = PyEval_GetGlobals();
 116     Py_INCREF(globals);
 117     locals = PyDict_New();
 118     PyRun_String("import code", Py_file_input, globals, locals);
 119     PyRun_String("code.interact(local=globals())", Py_file_input,
 120                  globals, locals);
 121     Py_DECREF(globals);
 122     Py_DECREF(locals);
 123 }
 124
 125 int remote_gdb_base_port = 7000;
 126
 127 int
 128 getRemoteGDBPort()
 129 {
 130     return remote_gdb_base_port;
 131 }
 132
 133 // Set remote GDB base port.  0 means disable remote GDB.
 134 // Callable from python.
 135 void
 136 setRemoteGDBPort(int port)
 137 {
 138     remote_gdb_base_port = port;
 139 }
 140