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 <sys/types.h>
  33 #include <signal.h>
  34 #include <unistd.h>
  35
  36 #include <string>
  37 #include <vector>
  38
  39 #include "sim/debug.hh"
  40 #include "sim/eventq.hh"
  41 #include "sim/sim_events.hh"
  42
  43 using namespace std;
  44
  45 void
  46 debug_break()
  47 {
  48 #ifndef NDEBUG
  49     kill(getpid(), SIGTRAP);
  50 #else
  51     cprintf("debug_break suppressed, compiled with NDEBUG\n");
  52 #endif
  53 }
  54
  55 //
  56 // Debug event: place a breakpoint on the process function and
  57 // schedule the event to break at a particular cycle
  58 //
  59 class DebugBreakEvent : public Event
  60 {
  61   public:
  62
  63     DebugBreakEvent(EventQueue *q, Tick _when);
  64
  65     void process();     // process event
  66     virtual const char *description();
  67 };
  68
  69 //
  70 // constructor: schedule at specified time
  71 //
  72 DebugBreakEvent::DebugBreakEvent(EventQueue *q, Tick _when)
  73     : Event(q, Debug_Break_Pri)
  74 {
  75     setFlags(AutoDelete);
  76     schedule(_when);
  77 }
  78
  79 //
  80 // handle debug event: set debugger breakpoint on this function
  81 //
  82 void
  83 DebugBreakEvent::process()
  84 {
  85     debug_break();
  86 }
  87
  88
  89 const char *
  90 DebugBreakEvent::description()
  91 {
  92     return "debug break";
  93 }
  94
  95 //
  96 // handy function to schedule DebugBreakEvent on main event queue
  97 // (callable from debugger)
  98 //
  99 void
 100 schedBreakCycle(Tick when)
 101 {
 102     new DebugBreakEvent(&mainEventQueue, when);
 103 }
 104
 105 void
 106 eventqDump()
 107 {
 108     mainEventQueue.dump();
 109 }
 110