sim/debug.cc

   1 /*
   2  * Copyright (c) 2003 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
  29 #include <sys/types.h>
  30 #include <signal.h>
  31 #include <unistd.h>
  32
  33 #include <string>
  34 #include <vector>
  35
  36 #include "sim/debug.hh"
  37 #include "sim/eventq.hh"
  38 #include "sim/param.hh"
  39 #include "sim/sim_events.hh"
  40
  41 using namespace std;
  42
  43 #ifdef DEBUG
  44 void
  45 debug_break()
  46 {
  47     kill(getpid(), SIGTRAP);
  48 }
  49 #endif
  50
  51 //
  52 // Debug event: place a breakpoint on the process function and
  53 // schedule the event to break at a particular cycle
  54 //
  55 class DebugBreakEvent : public Event
  56 {
  57   public:
  58
  59     DebugBreakEvent(EventQueue *q, Tick _when);
  60
  61     void process();     // process event
  62     virtual const char *description();
  63 };
  64
  65 //
  66 // constructor: schedule at specified time
  67 //
  68 DebugBreakEvent::DebugBreakEvent(EventQueue *q, Tick _when)
  69     : Event(q, Debug_Break_Pri)
  70 {
  71     setFlags(AutoDelete);
  72     schedule(_when);
  73 }
  74
  75 //
  76 // handle debug event: set debugger breakpoint on this function
  77 //
  78 void
  79 DebugBreakEvent::process()
  80 {
  81     debug_break();
  82 }
  83
  84
  85 const char *
  86 DebugBreakEvent::description()
  87 {
  88     return "debug break";
  89 }
  90
  91 //
  92 // Parameter context for global debug options
  93 //
  94 class DebugContext : public ParamContext
  95 {
  96   public:
  97     DebugContext(const string &_iniSection)
  98         : ParamContext(_iniSection) {}
  99     void checkParams();
 100 };
 101
 102 DebugContext debugParams("debug");
 103
 104 VectorParam<Tick> break_cycles(&debugParams, "break_cycles",
 105                                  "cycle(s) to create breakpoint events");
 106
 107 void
 108 DebugContext::checkParams()
 109 {
 110     if (break_cycles.isValid()) {
 111         vector<Tick> &cycles = break_cycles;
 112
 113         vector<Tick>::iterator i = cycles.begin();
 114         vector<Tick>::iterator end = cycles.end();
 115
 116         for (; i < end; ++i)
 117             new DebugBreakEvent(&mainEventQueue, *i);
 118     }
 119 }
 120
 121 //
 122 // handy function to schedule DebugBreakEvent on main event queue
 123 // (callable from debugger)
 124 //
 125 extern "C" void sched_break_cycle(Tick when)
 126 {
 127     new DebugBreakEvent(&mainEventQueue, when);
 128 }
 129
 130 extern "C" void eventq_dump()
 131 {
 132     mainEventQueue.dump();
 133 }
 134