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 "sim/debug.hh"
33
34#include <string>
35#include <vector>
36
37#include "base/debug.hh"
38#include "cpu/pc_event.hh"
39#include "sim/eventq_impl.hh"
40#include "sim/global_event.hh"
41#include "sim/sim_events.hh"
42#include "sim/sim_exit.hh"
43#include "sim/system.hh"
44
45using namespace std;
46
47//
48// Debug event: place a breakpoint on the process function and
49// schedule the event to break at a particular cycle
50//
51struct DebugBreakEvent : public GlobalEvent
52{
53    DebugBreakEvent(Tick when);
54    void process();     // process event
55    virtual const char *description() const;
56};
57
58//
59// constructor: schedule at specified time
60//
61DebugBreakEvent::DebugBreakEvent(Tick when)
62    : GlobalEvent(when, Debug_Break_Pri, AutoDelete)
63{
64}
65
66//
67// handle debug event: set debugger breakpoint on this function
68//
69void
70DebugBreakEvent::process()
71{
72    Debug::breakpoint();
73}
74
75
76const char *
77DebugBreakEvent::description() const
78{
79    return "debug breakpoint";
80}
81
82//
83// handy function to schedule DebugBreakEvent on main event queue
84// (callable from debugger)
85//
86void
87schedBreak(Tick when)
88{
89    new DebugBreakEvent(when);
90    warn("need to stop all queues");
91}
92
93void
94schedRelBreak(Tick delta)
95{
96    schedBreak(curTick() + delta);
97}
98
99void
100breakAtKernelFunction(const char* funcName)
101{
102    System* curSystem = System::systemList[0];
103    curSystem->addKernelFuncEvent<BreakPCEvent>(funcName,
104                                                "GDB scheduled break", true);
105}
106
107///
108/// Function to cause the simulator to take a checkpoint from the debugger
109///
110void
111takeCheckpoint(Tick when)
112{
113    if (!when)
114        when = curTick() + 1;
115    exitSimLoop("checkpoint", 0, when, 0);
116}
117
118void
119eventqDump()
120{
121    for (uint32_t i = 0; i < numMainEventQueues; ++i) {
122        mainEventQueue[i]->dump();
123    }
124}
125
126int remote_gdb_base_port = 7000;
127
128int
129getRemoteGDBPort()
130{
131    return remote_gdb_base_port;
132}
133
134// Set remote GDB base port.  0 means disable remote GDB.
135// Callable from python.
136void
137setRemoteGDBPort(int port)
138{
139    remote_gdb_base_port = port;
140}
141
142