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
  42 using namespace std;
  43
  44 //
  45 // Debug event: place a breakpoint on the process function and
  46 // schedule the event to break at a particular cycle
  47 //
  48 struct DebugBreakEvent : public GlobalEvent
  49 {
  50     DebugBreakEvent(Tick when);
  51     void process();     // process event
  52     virtual const char *description() const;
  53 };
  54
  55 //
  56 // constructor: schedule at specified time
  57 //
  58 DebugBreakEvent::DebugBreakEvent(Tick when)
  59     : GlobalEvent(when, Debug_Break_Pri, AutoDelete)
  60 {
  61 }
  62
  63 //
  64 // handle debug event: set debugger breakpoint on this function
  65 //
  66 void
  67 DebugBreakEvent::process()
  68 {
  69     Debug::breakpoint();
  70 }
  71
  72
  73 const char *
  74 DebugBreakEvent::description() const
  75 {
  76     return "debug breakpoint";
  77 }
  78
  79 //
  80 // handy function to schedule DebugBreakEvent on main event queue
  81 // (callable from debugger)
  82 //
  83 void
  84 schedBreak(Tick when)
  85 {
  86     new DebugBreakEvent(when);
  87     warn("need to stop all queues");
  88 }
  89
  90 ///
  91 /// Function to cause the simulator to take a checkpoint from the debugger
  92 ///
  93 void
  94 takeCheckpoint(Tick when)
  95 {
  96     if (!when)
  97         when = curTick() + 1;
  98     exitSimLoop("checkpoint", 0, when, 0);
  99 }
 100
 101 void
 102 eventqDump()
 103 {
 104     for (uint32_t i = 0; i < numMainEventQueues; ++i) {
 105         mainEventQueue[i]->dump();
 106     }
 107 }
 108
 109 int remote_gdb_base_port = 7000;
 110
 111 int
 112 getRemoteGDBPort()
 113 {
 114     return remote_gdb_base_port;
 115 }
 116
 117 // Set remote GDB base port.  0 means disable remote GDB.
 118 // Callable from python.
 119 void
 120 setRemoteGDBPort(int port)
 121 {
 122     remote_gdb_base_port = port;
 123 }
 124