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: Ali Saidi
29 * Nathan Binkert
30 */
31
32#include <sys/signal.h>
33
34#include "arch/alpha/ev5.hh"
35#include "arch/alpha/system.hh"
36#include "arch/vtophys.hh"
37#include "base/loader/object_file.hh"
38#include "base/loader/symtab.hh"
39#include "base/trace.hh"
40#include "debug/Loader.hh"
41#include "mem/fs_translating_port_proxy.hh"
42#include "params/AlphaSystem.hh"
43#include "sim/byteswap.hh"
44
45using namespace AlphaISA;
46
47AlphaSystem::AlphaSystem(Params *p)
48 : System(p), intrFreq(0)
49{
50 consoleSymtab = new SymbolTable;
51 palSymtab = new SymbolTable;
52
53
54 /**
55 * Load the pal, and console code into memory
56 */
57 // Load Console Code
58 console = createObjectFile(params()->console);
59 if (console == NULL)
60 fatal("Could not load console file %s", params()->console);
61
62 // Load pal file
63 pal = createObjectFile(params()->pal);
64 if (pal == NULL)
65 fatal("Could not load PALcode file %s", params()->pal);
66
67 // load symbols
68 if (!console->loadGlobalSymbols(consoleSymtab))
69 panic("could not load console symbols\n");
70
71 if (!pal->loadGlobalSymbols(palSymtab))
72 panic("could not load pal symbols\n");
73
74 if (!pal->loadLocalSymbols(palSymtab))
75 panic("could not load pal symbols\n");
76
77 if (!console->loadGlobalSymbols(debugSymbolTable))
78 panic("could not load console symbols\n");
79
80 if (!pal->loadGlobalSymbols(debugSymbolTable))
81 panic("could not load pal symbols\n");
82
83 if (!pal->loadLocalSymbols(debugSymbolTable))
84 panic("could not load pal symbols\n");
85
86
87}
88
89AlphaSystem::~AlphaSystem()
90{
91 delete consoleSymtab;
92 delete console;
93 delete pal;
94#ifdef DEBUG
95 delete consolePanicEvent;
96#endif
97}
98
99void
100AlphaSystem::initState()
101{
102 Addr addr = 0;
103
104 // Moved from the constructor to here since it relies on the
105 // address map being resolved in the interconnect
106
107 // Call the initialisation of the super class
108 System::initState();
109
110 // Load program sections into memory
111 pal->loadSections(physProxy, loadAddrMask);
112 console->loadSections(physProxy, loadAddrMask);
113
91 // load symbols
92 if (!console->loadGlobalSymbols(consoleSymtab))
93 panic("could not load console symbols\n");
94
95 if (!pal->loadGlobalSymbols(palSymtab))
96 panic("could not load pal symbols\n");
97
98 if (!pal->loadLocalSymbols(palSymtab))
99 panic("could not load pal symbols\n");
100
101 if (!console->loadGlobalSymbols(debugSymbolTable))
102 panic("could not load console symbols\n");
103
104 if (!pal->loadGlobalSymbols(debugSymbolTable))
105 panic("could not load pal symbols\n");
106
107 if (!pal->loadLocalSymbols(debugSymbolTable))
108 panic("could not load pal symbols\n");
109
110 Addr addr = 0;
111#ifndef NDEBUG
112 consolePanicEvent = addConsoleFuncEvent<BreakPCEvent>("panic");
113#endif
114
114 /**
115 * Copy the osflags (kernel arguments) into the consoles
116 * memory. (Presently Linux does not use the console service
117 * routine to get these command line arguments, but Tru64 and
118 * others do.)
119 */
120 if (consoleSymtab->findAddress("env_booted_osflags", addr)) {
121 virtProxy.writeBlob(addr, (uint8_t*)params()->boot_osflags.c_str(),
122 strlen(params()->boot_osflags.c_str()));
123 }
124
125 /**
126 * Set the hardware reset parameter block system type and revision
127 * information to Tsunami.
128 */
129 if (consoleSymtab->findAddress("m5_rpb", addr)) {
130 uint64_t data;
131 data = htog(params()->system_type);
132 virtProxy.write(addr+0x50, data);
133 data = htog(params()->system_rev);
134 virtProxy.write(addr+0x58, data);
135 } else
136 panic("could not find hwrpb\n");
137
138 // Setup all the function events now that we have a system and a symbol
139 // table
140 setupFuncEvents();
141}
142
143void
144AlphaSystem::loadState(Checkpoint *cp)
145{
146 System::loadState(cp);
147
148 // Setup all the function events now that we have a system and a symbol
149 // table
150 setupFuncEvents();
151
152}
153
154void
155AlphaSystem::setupFuncEvents()
156{
157#ifndef NDEBUG
158 consolePanicEvent = addConsoleFuncEvent<BreakPCEvent>("panic");
159#endif
160}
161
162/**
163 * This function fixes up addresses that are used to match PCs for
164 * hooking simulator events on to target function executions.
165 *
166 * Alpha binaries may have multiple global offset table (GOT)
167 * sections. A function that uses the GOT starts with a
168 * two-instruction prolog which sets the global pointer (gp == r29) to
169 * the appropriate GOT section. The proper gp value is calculated
170 * based on the function address, which must be passed by the caller
171 * in the procedure value register (pv aka t12 == r27). This sequence
172 * looks like the following:
173 *
174 * opcode Ra Rb offset
175 * ldah gp,X(pv) 09 29 27 X
176 * lda gp,Y(gp) 08 29 29 Y
177 *
178 * for some constant offsets X and Y. The catch is that the linker
179 * (or maybe even the compiler, I'm not sure) may recognize that the
180 * caller and callee are using the same GOT section, making this
181 * prolog redundant, and modify the call target to skip these
182 * instructions. If we check for execution of the first instruction
183 * of a function (the one the symbol points to) to detect when to skip
184 * it, we'll miss all these modified calls. It might work to
185 * unconditionally check for the third instruction, but not all
186 * functions have this prolog, and there's some chance that those
187 * first two instructions could have undesired consequences. So we do
188 * the Right Thing and pattern-match the first two instructions of the
189 * function to decide where to patch.
190 *
191 * Eventually this code should be moved into an ISA-specific file.
192 */
193Addr
194AlphaSystem::fixFuncEventAddr(Addr addr)
195{
196 // mask for just the opcode, Ra, and Rb fields (not the offset)
197 const uint32_t inst_mask = 0xffff0000;
198 // ldah gp,X(pv): opcode 9, Ra = 29, Rb = 27
199 const uint32_t gp_ldah_pattern = (9 << 26) | (29 << 21) | (27 << 16);
200 // lda gp,Y(gp): opcode 8, Ra = 29, rb = 29
201 const uint32_t gp_lda_pattern = (8 << 26) | (29 << 21) | (29 << 16);
202
203 uint32_t i1 = virtProxy.read<uint32_t>(addr);
204 uint32_t i2 = virtProxy.read<uint32_t>(addr + sizeof(MachInst));
205
206 if ((i1 & inst_mask) == gp_ldah_pattern &&
207 (i2 & inst_mask) == gp_lda_pattern) {
208 Addr new_addr = addr + 2 * sizeof(MachInst);
209 DPRINTF(Loader, "fixFuncEventAddr: %p -> %p", addr, new_addr);
210 return new_addr;
211 } else {
212 return addr;
213 }
214}
215
216void
217AlphaSystem::setAlphaAccess(Addr access)
218{
219 Addr addr = 0;
220 if (consoleSymtab->findAddress("m5AlphaAccess", addr)) {
221 virtProxy.write(addr, htog(Phys2K0Seg(access)));
222 } else {
223 panic("could not find m5AlphaAccess\n");
224 }
225}
226
227void
228AlphaSystem::serialize(std::ostream &os)
229{
230 System::serialize(os);
231 consoleSymtab->serialize("console_symtab", os);
232 palSymtab->serialize("pal_symtab", os);
233}
234
235void
236AlphaSystem::unserialize(Checkpoint *cp, const std::string &section)
237{
238 System::unserialize(cp,section);
239 consoleSymtab->unserialize("console_symtab", cp, section);
240 palSymtab->unserialize("pal_symtab", cp, section);
241}
242
243AlphaSystem *
244AlphaSystemParams::create()
245{
246 return new AlphaSystem(this);
247}