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