Automated merge with ssh://repo.gem5.org/gem5
[gem5.git] / src / cpu / pc_event.cc
1 /*
2 * Copyright (c) 2002-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 <algorithm>
33 #include <map>
34 #include <string>
35 #include <utility>
36
37 #include "base/debug.hh"
38 #include "base/trace.hh"
39 #include "config/full_system.hh"
40 #include "cpu/base.hh"
41 #include "cpu/pc_event.hh"
42 #include "cpu/thread_context.hh"
43 #include "debug/PCEvent.hh"
44 #include "sim/core.hh"
45 #include "sim/system.hh"
46
47 using namespace std;
48
49 PCEventQueue::PCEventQueue()
50 {}
51
52 PCEventQueue::~PCEventQueue()
53 {}
54
55 bool
56 PCEventQueue::remove(PCEvent *event)
57 {
58 int removed = 0;
59 range_t range = equal_range(event);
60 for (iterator i = range.first; i != range.second; ++i) {
61 if (*i == event) {
62 DPRINTF(PCEvent, "PC based event removed at %#x: %s\n",
63 event->pc(), event->descr());
64 pc_map.erase(i);
65 ++removed;
66 }
67 }
68
69 return removed > 0;
70 }
71
72 bool
73 PCEventQueue::schedule(PCEvent *event)
74 {
75 pc_map.push_back(event);
76 sort(pc_map.begin(), pc_map.end(), MapCompare());
77
78 DPRINTF(PCEvent, "PC based event scheduled for %#x: %s\n",
79 event->pc(), event->descr());
80
81 return true;
82 }
83
84 bool
85 PCEventQueue::doService(ThreadContext *tc)
86 {
87 // This will fail to break on Alpha PALcode addresses, but that is
88 // a rare use case.
89 Addr pc = tc->instAddr();
90 int serviced = 0;
91 range_t range = equal_range(pc);
92 for (iterator i = range.first; i != range.second; ++i) {
93 // Make sure that the pc wasn't changed as the side effect of
94 // another event. This for example, prevents two invocations
95 // of the SkipFuncEvent. Maybe we should have separate PC
96 // event queues for each processor?
97 if (pc != tc->instAddr())
98 continue;
99
100 DPRINTF(PCEvent, "PC based event serviced at %#x: %s\n",
101 (*i)->pc(), (*i)->descr());
102
103 (*i)->process(tc);
104 ++serviced;
105 }
106
107 return serviced > 0;
108 }
109
110 void
111 PCEventQueue::dump() const
112 {
113 const_iterator i = pc_map.begin();
114 const_iterator e = pc_map.end();
115
116 for (; i != e; ++i)
117 cprintf("%d: event at %#x: %s\n", curTick(), (*i)->pc(),
118 (*i)->descr());
119 }
120
121 PCEventQueue::range_t
122 PCEventQueue::equal_range(Addr pc)
123 {
124 return std::equal_range(pc_map.begin(), pc_map.end(), pc, MapCompare());
125 }
126
127 BreakPCEvent::BreakPCEvent(PCEventQueue *q, const std::string &desc, Addr addr,
128 bool del)
129 : PCEvent(q, desc, addr), remove(del)
130 {
131 }
132
133 void
134 BreakPCEvent::process(ThreadContext *tc)
135 {
136 StringWrap name(tc->getCpuPtr()->name() + ".break_event");
137 DPRINTFN("break event %s triggered\n", descr());
138 Debug::breakpoint();
139 if (remove)
140 delete this;
141 }
142
143 #if FULL_SYSTEM
144 void
145 sched_break_pc_sys(System *sys, Addr addr)
146 {
147 new BreakPCEvent(&sys->pcEventQueue, "debug break", addr, true);
148 }
149
150 void
151 sched_break_pc(Addr addr)
152 {
153 for (vector<System *>::iterator sysi = System::systemList.begin();
154 sysi != System::systemList.end(); ++sysi) {
155 sched_break_pc_sys(*sysi, addr);
156 }
157
158 }
159 #endif