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