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 <string>
  33 #include <vector>
  34
  35 #include "base/debug.hh"
  36 #include "sim/debug.hh"
  37 #include "sim/eventq_impl.hh"
  38 #include "sim/global_event.hh"
  39 #include "sim/sim_events.hh"
  40 #include "sim/sim_exit.hh"
  41 #include "cpu/pc_event.hh"
  42 #include "sim/system.hh"
  43
  44 using namespace std;
  45
  46 //
  47 // Debug event: place a breakpoint on the process function and
  48 // schedule the event to break at a particular cycle
  49 //
  50 struct DebugBreakEvent : public GlobalEvent
  51 {
  52     DebugBreakEvent(Tick when);
  53     void process();     // process event
  54     virtual const char *description() const;
  55 };
  56
  57 //
  58 // constructor: schedule at specified time
  59 //
  60 DebugBreakEvent::DebugBreakEvent(Tick when)
  61     : GlobalEvent(when, Debug_Break_Pri, AutoDelete)
  62 {
  63 }
  64
  65 //
  66 // handle debug event: set debugger breakpoint on this function
  67 //
  68 void
  69 DebugBreakEvent::process()
  70 {
  71     Debug::breakpoint();
  72 }
  73
  74
  75 const char *
  76 DebugBreakEvent::description() const
  77 {
  78     return "debug breakpoint";
  79 }
  80
  81 //
  82 // handy function to schedule DebugBreakEvent on main event queue
  83 // (callable from debugger)
  84 //
  85 void
  86 schedBreak(Tick when)
  87 {
  88     new DebugBreakEvent(when);
  89     warn("need to stop all queues");
  90 }
  91
  92 void
  93 schedRelBreak(Tick delta)
  94 {
  95     schedBreak(curTick() + delta);
  96 }
  97
  98 void
  99 breakAtKernelFunction(const char* funcName)
 100 {
 101     System* curSystem = System::systemList[0];
 102     curSystem->addKernelFuncEvent<BreakPCEvent>(funcName,
 103                                                 "GDB scheduled break", true);
 104 }
 105
 106 ///
 107 /// Function to cause the simulator to take a checkpoint from the debugger
 108 ///
 109 void
 110 takeCheckpoint(Tick when)
 111 {
 112     if (!when)
 113         when = curTick() + 1;
 114     exitSimLoop("checkpoint", 0, when, 0);
 115 }
 116
 117 void
 118 eventqDump()
 119 {
 120     for (uint32_t i = 0; i < numMainEventQueues; ++i) {
 121         mainEventQueue[i]->dump();
 122     }
 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