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