pseudo_inst.cc revision 3368
1/*
2 * Copyright (c) 2003-2006 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 */
30
31#include <errno.h>
32#include <fcntl.h>
33#include <unistd.h>
34
35#include <string>
36
37#include "sim/pseudo_inst.hh"
38#include "arch/vtophys.hh"
39#include "base/annotate.hh"
40#include "cpu/base.hh"
41#include "cpu/thread_context.hh"
42#include "cpu/quiesce_event.hh"
43#include "kern/kernel_stats.hh"
44#include "sim/param.hh"
45#include "sim/serialize.hh"
46#include "sim/sim_exit.hh"
47#include "sim/stat_control.hh"
48#include "sim/stats.hh"
49#include "sim/system.hh"
50#include "sim/debug.hh"
51#include "sim/vptr.hh"
52
53using namespace std;
54
55using namespace Stats;
56using namespace TheISA;
57
58namespace AlphaPseudo
59{
60    bool doStatisticsInsts;
61    bool doCheckpointInsts;
62    bool doQuiesce;
63
64    void
65    arm(ThreadContext *tc)
66    {
67        if (tc->getKernelStats())
68            tc->getKernelStats()->arm();
69    }
70
71    void
72    quiesce(ThreadContext *tc)
73    {
74        if (!doQuiesce)
75            return;
76
77        tc->suspend();
78        if (tc->getKernelStats())
79            tc->getKernelStats()->quiesce();
80    }
81
82    void
83    quiesceNs(ThreadContext *tc, uint64_t ns)
84    {
85        if (!doQuiesce || ns == 0)
86            return;
87
88        EndQuiesceEvent *quiesceEvent = tc->getQuiesceEvent();
89
90        Tick resume = curTick + Clock::Int::ns * ns;
91
92        if (quiesceEvent->scheduled())
93            quiesceEvent->reschedule(resume);
94        else
95            quiesceEvent->schedule(resume);
96
97        DPRINTF(Quiesce, "%s: quiesceNs(%d) until %d\n",
98                tc->getCpuPtr()->name(), ns, resume);
99
100        tc->suspend();
101        if (tc->getKernelStats())
102            tc->getKernelStats()->quiesce();
103    }
104
105    void
106    quiesceCycles(ThreadContext *tc, uint64_t cycles)
107    {
108        if (!doQuiesce || cycles == 0)
109            return;
110
111        EndQuiesceEvent *quiesceEvent = tc->getQuiesceEvent();
112
113        Tick resume = curTick + tc->getCpuPtr()->cycles(cycles);
114
115        if (quiesceEvent->scheduled())
116            quiesceEvent->reschedule(resume);
117        else
118            quiesceEvent->schedule(resume);
119
120        DPRINTF(Quiesce, "%s: quiesceCycles(%d) until %d\n",
121                tc->getCpuPtr()->name(), cycles, resume);
122
123        tc->suspend();
124        if (tc->getKernelStats())
125            tc->getKernelStats()->quiesce();
126    }
127
128    uint64_t
129    quiesceTime(ThreadContext *tc)
130    {
131        return (tc->readLastActivate() - tc->readLastSuspend()) / Clock::Int::ns;
132    }
133
134    void
135    ivlb(ThreadContext *tc)
136    {
137        if (tc->getKernelStats())
138            tc->getKernelStats()->ivlb();
139    }
140
141    void
142    ivle(ThreadContext *tc)
143    {
144    }
145
146    void
147    m5exit_old(ThreadContext *tc)
148    {
149        exitSimLoop("m5_exit_old instruction encountered");
150    }
151
152    void
153    m5exit(ThreadContext *tc, Tick delay)
154    {
155        Tick when = curTick + delay * Clock::Int::ns;
156        schedExitSimLoop("m5_exit instruction encountered", when);
157    }
158
159    void
160    loadsymbol(ThreadContext *tc)
161    {
162        const string &filename = tc->getCpuPtr()->system->params()->symbolfile;
163        if (filename.empty()) {
164            return;
165        }
166
167        std::string buffer;
168        ifstream file(filename.c_str());
169
170        if (!file)
171            fatal("file error: Can't open symbol table file %s\n", filename);
172
173        while (!file.eof()) {
174            getline(file, buffer);
175
176            if (buffer.empty())
177                continue;
178
179            int idx = buffer.find(' ');
180            if (idx == string::npos)
181                continue;
182
183            string address = "0x" + buffer.substr(0, idx);
184            eat_white(address);
185            if (address.empty())
186                continue;
187
188            // Skip over letter and space
189            string symbol = buffer.substr(idx + 3);
190            eat_white(symbol);
191            if (symbol.empty())
192                continue;
193
194            Addr addr;
195            if (!to_number(address, addr))
196                continue;
197
198            if (!tc->getSystemPtr()->kernelSymtab->insert(addr, symbol))
199                continue;
200
201
202            DPRINTF(Loader, "Loaded symbol: %s @ %#llx\n", symbol, addr);
203        }
204        file.close();
205    }
206
207    void
208    resetstats(ThreadContext *tc, Tick delay, Tick period)
209    {
210        if (!doStatisticsInsts)
211            return;
212
213
214        Tick when = curTick + delay * Clock::Int::ns;
215        Tick repeat = period * Clock::Int::ns;
216
217        using namespace Stats;
218        SetupEvent(Reset, when, repeat);
219    }
220
221    void
222    dumpstats(ThreadContext *tc, Tick delay, Tick period)
223    {
224        if (!doStatisticsInsts)
225            return;
226
227
228        Tick when = curTick + delay * Clock::Int::ns;
229        Tick repeat = period * Clock::Int::ns;
230
231        using namespace Stats;
232        SetupEvent(Dump, when, repeat);
233    }
234
235    void
236    addsymbol(ThreadContext *tc, Addr addr, Addr symbolAddr)
237    {
238        char symb[100];
239        CopyStringOut(tc, symb, symbolAddr, 100);
240        std::string symbol(symb);
241
242        DPRINTF(Loader, "Loaded symbol: %s @ %#llx\n", symbol, addr);
243
244        tc->getSystemPtr()->kernelSymtab->insert(addr,symbol);
245    }
246
247    void
248    anBegin(ThreadContext *tc, uint64_t cur)
249    {
250        Annotate::annotations.add(tc->getSystemPtr(), 0, cur >> 32, cur &
251                0xFFFFFFFF, 0,0);
252    }
253
254    void
255    anWait(ThreadContext *tc, uint64_t cur, uint64_t wait)
256    {
257        Annotate::annotations.add(tc->getSystemPtr(), 0, cur >> 32, cur &
258                0xFFFFFFFF, wait >> 32, wait & 0xFFFFFFFF);
259    }
260
261
262    void
263    dumpresetstats(ThreadContext *tc, Tick delay, Tick period)
264    {
265        if (!doStatisticsInsts)
266            return;
267
268
269        Tick when = curTick + delay * Clock::Int::ns;
270        Tick repeat = period * Clock::Int::ns;
271
272        using namespace Stats;
273        SetupEvent(Dump|Reset, when, repeat);
274    }
275
276    void
277    m5checkpoint(ThreadContext *tc, Tick delay, Tick period)
278    {
279        if (!doCheckpointInsts)
280            return;
281
282        Tick when = curTick + delay * Clock::Int::ns;
283        Tick repeat = period * Clock::Int::ns;
284
285        schedExitSimLoop("checkpoint", when, repeat);
286    }
287
288    uint64_t
289    readfile(ThreadContext *tc, Addr vaddr, uint64_t len, uint64_t offset)
290    {
291        const string &file = tc->getCpuPtr()->system->params()->readfile;
292        if (file.empty()) {
293            return ULL(0);
294        }
295
296        uint64_t result = 0;
297
298        int fd = ::open(file.c_str(), O_RDONLY, 0);
299        if (fd < 0)
300            panic("could not open file %s\n", file);
301
302        if (::lseek(fd, offset, SEEK_SET) < 0)
303            panic("could not seek: %s", strerror(errno));
304
305        char *buf = new char[len];
306        char *p = buf;
307        while (len > 0) {
308            int bytes = ::read(fd, p, len);
309            if (bytes <= 0)
310                break;
311
312            p += bytes;
313            result += bytes;
314            len -= bytes;
315        }
316
317        close(fd);
318        CopyIn(tc, vaddr, buf, result);
319        delete [] buf;
320        return result;
321    }
322
323    class Context : public ParamContext
324    {
325      public:
326        Context(const string &section) : ParamContext(section) {}
327        void checkParams();
328    };
329
330    Context context("pseudo_inst");
331
332    Param<bool> __quiesce(&context, "quiesce",
333                          "enable quiesce instructions",
334                          true);
335    Param<bool> __statistics(&context, "statistics",
336                             "enable statistics pseudo instructions",
337                             true);
338    Param<bool> __checkpoint(&context, "checkpoint",
339                             "enable checkpoint pseudo instructions",
340                             true);
341
342    void
343    Context::checkParams()
344    {
345        doQuiesce = __quiesce;
346        doStatisticsInsts = __statistics;
347        doCheckpointInsts = __checkpoint;
348    }
349
350    void debugbreak(ThreadContext *tc)
351    {
352        debug_break();
353    }
354
355    void switchcpu(ThreadContext *tc)
356    {
357        exitSimLoop("switchcpu");
358    }
359}
360