pseudo_inst.cc revision 11793:ef606668d247 
1/*
2 * Copyright (c) 2010-2012, 2015 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2011 Advanced Micro Devices, Inc.
15 * Copyright (c) 2003-2006 The Regents of The University of Michigan
16 * All rights reserved.
17 *
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are
20 * met: redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer;
22 * redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution;
25 * neither the name of the copyright holders nor the names of its
26 * contributors may be used to endorse or promote products derived from
27 * this software without specific prior written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Authors: Nathan Binkert
42 */
43
44#include "sim/pseudo_inst.hh"
45
46#include <fcntl.h>
47#include <unistd.h>
48
49#include <cerrno>
50#include <fstream>
51#include <string>
52#include <vector>
53
54#include "arch/kernel_stats.hh"
55#include "arch/pseudo_inst.hh"
56#include "arch/utility.hh"
57#include "arch/vtophys.hh"
58#include "base/debug.hh"
59#include "base/output.hh"
60#include "config/the_isa.hh"
61#include "cpu/base.hh"
62#include "cpu/quiesce_event.hh"
63#include "cpu/thread_context.hh"
64#include "debug/Loader.hh"
65#include "debug/PseudoInst.hh"
66#include "debug/Quiesce.hh"
67#include "debug/WorkItems.hh"
68#include "dev/net/dist_iface.hh"
69#include "params/BaseCPU.hh"
70#include "sim/full_system.hh"
71#include "sim/initparam_keys.hh"
72#include "sim/process.hh"
73#include "sim/serialize.hh"
74#include "sim/sim_events.hh"
75#include "sim/sim_exit.hh"
76#include "sim/stat_control.hh"
77#include "sim/stats.hh"
78#include "sim/system.hh"
79#include "sim/vptr.hh"
80
81using namespace std;
82
83using namespace Stats;
84using namespace TheISA;
85
86namespace PseudoInst {
87
88static inline void
89panicFsOnlyPseudoInst(const char *name)
90{
91    panic("Pseudo inst \"%s\" is only available in Full System mode.");
92}
93
94uint64_t
95pseudoInst(ThreadContext *tc, uint8_t func, uint8_t subfunc)
96{
97    uint64_t args[4];
98
99    DPRINTF(PseudoInst, "PseudoInst::pseudoInst(%i, %i)\n", func, subfunc);
100
101    // We need to do this in a slightly convoluted way since
102    // getArgument() might have side-effects on arg_num. We could have
103    // used the Argument class, but due to the possible side effects
104    // from getArgument, it'd most likely break.
105    int arg_num(0);
106    for (int i = 0; i < sizeof(args) / sizeof(*args); ++i) {
107        args[arg_num] = getArgument(tc, arg_num, sizeof(uint64_t), false);
108        ++arg_num;
109    }
110
111    switch (func) {
112      case 0x00: // arm_func
113        arm(tc);
114        break;
115
116      case 0x01: // quiesce_func
117        quiesce(tc);
118        break;
119
120      case 0x02: // quiescens_func
121        quiesceSkip(tc);
122        break;
123
124      case 0x03: // quiescecycle_func
125        quiesceNs(tc, args[0]);
126        break;
127
128      case 0x04: // quiescetime_func
129        return quiesceTime(tc);
130
131      case 0x07: // rpns_func
132        return rpns(tc);
133
134      case 0x09: // wakecpu_func
135        wakeCPU(tc, args[0]);
136        break;
137
138      case 0x21: // exit_func
139        m5exit(tc, args[0]);
140        break;
141
142      case 0x22:
143        m5fail(tc, args[0], args[1]);
144        break;
145
146      case 0x30: // initparam_func
147        return initParam(tc, args[0], args[1]);
148
149      case 0x31: // loadsymbol_func
150        loadsymbol(tc);
151        break;
152
153      case 0x40: // resetstats_func
154        resetstats(tc, args[0], args[1]);
155        break;
156
157      case 0x41: // dumpstats_func
158        dumpstats(tc, args[0], args[1]);
159        break;
160
161      case 0x42: // dumprststats_func
162        dumpresetstats(tc, args[0], args[1]);
163        break;
164
165      case 0x43: // ckpt_func
166        m5checkpoint(tc, args[0], args[1]);
167        break;
168
169      case 0x4f: // writefile_func
170        return writefile(tc, args[0], args[1], args[2], args[3]);
171
172      case 0x50: // readfile_func
173        return readfile(tc, args[0], args[1], args[2]);
174
175      case 0x51: // debugbreak_func
176        debugbreak(tc);
177        break;
178
179      case 0x52: // switchcpu_func
180        switchcpu(tc);
181        break;
182
183      case 0x53: // addsymbol_func
184        addsymbol(tc, args[0], args[1]);
185        break;
186
187      case 0x54: // panic_func
188        panic("M5 panic instruction called at %s\n", tc->pcState());
189
190      case 0x5a: // work_begin_func
191        workbegin(tc, args[0], args[1]);
192        break;
193
194      case 0x5b: // work_end_func
195        workend(tc, args[0], args[1]);
196        break;
197
198      case 0x55: // annotate_func
199      case 0x56: // reserved2_func
200      case 0x57: // reserved3_func
201      case 0x58: // reserved4_func
202      case 0x59: // reserved5_func
203        warn("Unimplemented m5 op (0x%x)\n", func);
204        break;
205
206      /* SE mode functions */
207      case 0x60: // syscall_func
208        m5Syscall(tc);
209        break;
210
211      case 0x61: // pagefault_func
212        m5PageFault(tc);
213        break;
214
215      /* dist-gem5 functions */
216      case 0x62: // distToggleSync_func
217        togglesync(tc);
218        break;
219
220      default:
221        warn("Unhandled m5 op: 0x%x\n", func);
222        break;
223    }
224
225    return 0;
226}
227
228void
229arm(ThreadContext *tc)
230{
231    DPRINTF(PseudoInst, "PseudoInst::arm()\n");
232    if (!FullSystem)
233        panicFsOnlyPseudoInst("arm");
234
235    if (tc->getKernelStats())
236        tc->getKernelStats()->arm();
237}
238
239void
240quiesce(ThreadContext *tc)
241{
242    DPRINTF(PseudoInst, "PseudoInst::quiesce()\n");
243    tc->quiesce();
244}
245
246void
247quiesceSkip(ThreadContext *tc)
248{
249    DPRINTF(PseudoInst, "PseudoInst::quiesceSkip()\n");
250    tc->quiesceTick(tc->getCpuPtr()->nextCycle() + 1);
251}
252
253void
254quiesceNs(ThreadContext *tc, uint64_t ns)
255{
256    DPRINTF(PseudoInst, "PseudoInst::quiesceNs(%i)\n", ns);
257    tc->quiesceTick(curTick() + SimClock::Int::ns * ns);
258}
259
260void
261quiesceCycles(ThreadContext *tc, uint64_t cycles)
262{
263    DPRINTF(PseudoInst, "PseudoInst::quiesceCycles(%i)\n", cycles);
264    tc->quiesceTick(tc->getCpuPtr()->clockEdge(Cycles(cycles)));
265}
266
267uint64_t
268quiesceTime(ThreadContext *tc)
269{
270    DPRINTF(PseudoInst, "PseudoInst::quiesceTime()\n");
271
272    return (tc->readLastActivate() - tc->readLastSuspend()) /
273        SimClock::Int::ns;
274}
275
276uint64_t
277rpns(ThreadContext *tc)
278{
279    DPRINTF(PseudoInst, "PseudoInst::rpns()\n");
280    return curTick() / SimClock::Int::ns;
281}
282
283void
284wakeCPU(ThreadContext *tc, uint64_t cpuid)
285{
286    DPRINTF(PseudoInst, "PseudoInst::wakeCPU(%i)\n", cpuid);
287    System *sys = tc->getSystemPtr();
288    ThreadContext *other_tc = sys->threadContexts[cpuid];
289    if (other_tc->status() == ThreadContext::Suspended)
290        other_tc->activate();
291}
292
293void
294m5exit(ThreadContext *tc, Tick delay)
295{
296    DPRINTF(PseudoInst, "PseudoInst::m5exit(%i)\n", delay);
297    if (DistIface::readyToExit(delay)) {
298        Tick when = curTick() + delay * SimClock::Int::ns;
299        exitSimLoop("m5_exit instruction encountered", 0, when, 0, true);
300    }
301}
302
303void
304m5fail(ThreadContext *tc, Tick delay, uint64_t code)
305{
306    DPRINTF(PseudoInst, "PseudoInst::m5fail(%i, %i)\n", delay, code);
307    Tick when = curTick() + delay * SimClock::Int::ns;
308    exitSimLoop("m5_fail instruction encountered", code, when, 0, true);
309}
310
311void
312loadsymbol(ThreadContext *tc)
313{
314    DPRINTF(PseudoInst, "PseudoInst::loadsymbol()\n");
315    if (!FullSystem)
316        panicFsOnlyPseudoInst("loadsymbol");
317
318    const string &filename = tc->getCpuPtr()->system->params()->symbolfile;
319    if (filename.empty()) {
320        return;
321    }
322
323    std::string buffer;
324    ifstream file(filename.c_str());
325
326    if (!file)
327        fatal("file error: Can't open symbol table file %s\n", filename);
328
329    while (!file.eof()) {
330        getline(file, buffer);
331
332        if (buffer.empty())
333            continue;
334
335        string::size_type idx = buffer.find(' ');
336        if (idx == string::npos)
337            continue;
338
339        string address = "0x" + buffer.substr(0, idx);
340        eat_white(address);
341        if (address.empty())
342            continue;
343
344        // Skip over letter and space
345        string symbol = buffer.substr(idx + 3);
346        eat_white(symbol);
347        if (symbol.empty())
348            continue;
349
350        Addr addr;
351        if (!to_number(address, addr))
352            continue;
353
354        if (!tc->getSystemPtr()->kernelSymtab->insert(addr, symbol))
355            continue;
356
357
358        DPRINTF(Loader, "Loaded symbol: %s @ %#llx\n", symbol, addr);
359    }
360    file.close();
361}
362
363void
364addsymbol(ThreadContext *tc, Addr addr, Addr symbolAddr)
365{
366    DPRINTF(PseudoInst, "PseudoInst::addsymbol(0x%x, 0x%x)\n",
367            addr, symbolAddr);
368    if (!FullSystem)
369        panicFsOnlyPseudoInst("addSymbol");
370
371    char symb[100];
372    CopyStringOut(tc, symb, symbolAddr, 100);
373    std::string symbol(symb);
374
375    DPRINTF(Loader, "Loaded symbol: %s @ %#llx\n", symbol, addr);
376
377    tc->getSystemPtr()->kernelSymtab->insert(addr,symbol);
378    debugSymbolTable->insert(addr,symbol);
379}
380
381uint64_t
382initParam(ThreadContext *tc, uint64_t key_str1, uint64_t key_str2)
383{
384    DPRINTF(PseudoInst, "PseudoInst::initParam() key:%s%s\n", (char *)&key_str1,
385            (char *)&key_str2);
386    if (!FullSystem) {
387        panicFsOnlyPseudoInst("initParam");
388        return 0;
389    }
390
391    // The key parameter string is passed in via two 64-bit registers. We copy
392    // out the characters from the 64-bit integer variables here and concatenate
393    // them in the key_str character buffer
394    const int len = 2 * sizeof(uint64_t) + 1;
395    char key_str[len];
396    memset(key_str, '\0', len);
397    if (key_str1 == 0) {
398        assert(key_str2 == 0);
399    } else {
400        strncpy(key_str, (char *)&key_str1, sizeof(uint64_t));
401    }
402
403    if (strlen(key_str) == sizeof(uint64_t)) {
404        strncpy(key_str + sizeof(uint64_t), (char *)&key_str2,
405                sizeof(uint64_t));
406    } else {
407        assert(key_str2 == 0);
408    }
409
410    // Compare the key parameter with the known values to select the return
411    // value
412    uint64_t val;
413    if (strcmp(key_str, InitParamKey::DEFAULT) == 0) {
414        val = tc->getCpuPtr()->system->init_param;
415    } else if (strcmp(key_str, InitParamKey::DIST_RANK) == 0) {
416        val = DistIface::rankParam();
417    } else if (strcmp(key_str, InitParamKey::DIST_SIZE) == 0) {
418        val = DistIface::sizeParam();
419    } else {
420        panic("Unknown key for initparam pseudo instruction:\"%s\"", key_str);
421    }
422    return val;
423}
424
425
426void
427resetstats(ThreadContext *tc, Tick delay, Tick period)
428{
429    DPRINTF(PseudoInst, "PseudoInst::resetstats(%i, %i)\n", delay, period);
430    if (!tc->getCpuPtr()->params()->do_statistics_insts)
431        return;
432
433
434    Tick when = curTick() + delay * SimClock::Int::ns;
435    Tick repeat = period * SimClock::Int::ns;
436
437    Stats::schedStatEvent(false, true, when, repeat);
438}
439
440void
441dumpstats(ThreadContext *tc, Tick delay, Tick period)
442{
443    DPRINTF(PseudoInst, "PseudoInst::dumpstats(%i, %i)\n", delay, period);
444    if (!tc->getCpuPtr()->params()->do_statistics_insts)
445        return;
446
447
448    Tick when = curTick() + delay * SimClock::Int::ns;
449    Tick repeat = period * SimClock::Int::ns;
450
451    Stats::schedStatEvent(true, false, when, repeat);
452}
453
454void
455dumpresetstats(ThreadContext *tc, Tick delay, Tick period)
456{
457    DPRINTF(PseudoInst, "PseudoInst::dumpresetstats(%i, %i)\n", delay, period);
458    if (!tc->getCpuPtr()->params()->do_statistics_insts)
459        return;
460
461
462    Tick when = curTick() + delay * SimClock::Int::ns;
463    Tick repeat = period * SimClock::Int::ns;
464
465    Stats::schedStatEvent(true, true, when, repeat);
466}
467
468void
469m5checkpoint(ThreadContext *tc, Tick delay, Tick period)
470{
471    DPRINTF(PseudoInst, "PseudoInst::m5checkpoint(%i, %i)\n", delay, period);
472    if (!tc->getCpuPtr()->params()->do_checkpoint_insts)
473        return;
474
475    if (DistIface::readyToCkpt(delay, period)) {
476        Tick when = curTick() + delay * SimClock::Int::ns;
477        Tick repeat = period * SimClock::Int::ns;
478        exitSimLoop("checkpoint", 0, when, repeat);
479    }
480}
481
482uint64_t
483readfile(ThreadContext *tc, Addr vaddr, uint64_t len, uint64_t offset)
484{
485    DPRINTF(PseudoInst, "PseudoInst::readfile(0x%x, 0x%x, 0x%x)\n",
486            vaddr, len, offset);
487    if (!FullSystem) {
488        panicFsOnlyPseudoInst("readfile");
489        return 0;
490    }
491
492    const string &file = tc->getSystemPtr()->params()->readfile;
493    if (file.empty()) {
494        return ULL(0);
495    }
496
497    uint64_t result = 0;
498
499    int fd = ::open(file.c_str(), O_RDONLY, 0);
500    if (fd < 0)
501        panic("could not open file %s\n", file);
502
503    if (::lseek(fd, offset, SEEK_SET) < 0)
504        panic("could not seek: %s", strerror(errno));
505
506    char *buf = new char[len];
507    char *p = buf;
508    while (len > 0) {
509        int bytes = ::read(fd, p, len);
510        if (bytes <= 0)
511            break;
512
513        p += bytes;
514        result += bytes;
515        len -= bytes;
516    }
517
518    close(fd);
519    CopyIn(tc, vaddr, buf, result);
520    delete [] buf;
521    return result;
522}
523
524uint64_t
525writefile(ThreadContext *tc, Addr vaddr, uint64_t len, uint64_t offset,
526            Addr filename_addr)
527{
528    DPRINTF(PseudoInst, "PseudoInst::writefile(0x%x, 0x%x, 0x%x, 0x%x)\n",
529            vaddr, len, offset, filename_addr);
530
531    // copy out target filename
532    char fn[100];
533    std::string filename;
534    CopyStringOut(tc, fn, filename_addr, 100);
535    filename = std::string(fn);
536
537    OutputStream *out;
538    if (offset == 0) {
539        // create a new file (truncate)
540        out = simout.create(filename, true, true);
541    } else {
542        // do not truncate file if offset is non-zero
543        // (ios::in flag is required as well to keep the existing data
544        //  intact, otherwise existing data will be zeroed out.)
545        out = simout.open(filename, ios::in | ios::out | ios::binary, true);
546    }
547
548    ostream *os(out->stream());
549    if (!os)
550        panic("could not open file %s\n", filename);
551
552    // seek to offset
553    os->seekp(offset);
554
555    // copy out data and write to file
556    char *buf = new char[len];
557    CopyOut(tc, buf, vaddr, len);
558    os->write(buf, len);
559    if (os->fail() || os->bad())
560        panic("Error while doing writefile!\n");
561
562    simout.close(out);
563
564    delete [] buf;
565
566    return len;
567}
568
569void
570debugbreak(ThreadContext *tc)
571{
572    DPRINTF(PseudoInst, "PseudoInst::debugbreak()\n");
573    Debug::breakpoint();
574}
575
576void
577switchcpu(ThreadContext *tc)
578{
579    DPRINTF(PseudoInst, "PseudoInst::switchcpu()\n");
580    exitSimLoop("switchcpu");
581}
582
583void
584togglesync(ThreadContext *tc)
585{
586    DPRINTF(PseudoInst, "PseudoInst::togglesync()\n");
587    DistIface::toggleSync(tc);
588}
589
590//
591// This function is executed when annotated work items begin.  Depending on
592// what the user specified at the command line, the simulation may exit and/or
593// take a checkpoint when a certain work item begins.
594//
595void
596workbegin(ThreadContext *tc, uint64_t workid, uint64_t threadid)
597{
598    DPRINTF(PseudoInst, "PseudoInst::workbegin(%i, %i)\n", workid, threadid);
599    System *sys = tc->getSystemPtr();
600    const System::Params *params = sys->params();
601
602    if (params->exit_on_work_items) {
603        exitSimLoop("workbegin", static_cast<int>(workid));
604        return;
605    }
606
607    DPRINTF(WorkItems, "Work Begin workid: %d, threadid %d\n", workid,
608            threadid);
609    tc->getCpuPtr()->workItemBegin();
610    sys->workItemBegin(threadid, workid);
611
612    //
613    // If specified, determine if this is the specific work item the user
614    // identified
615    //
616    if (params->work_item_id == -1 || params->work_item_id == workid) {
617
618        uint64_t systemWorkBeginCount = sys->incWorkItemsBegin();
619        int cpuId = tc->getCpuPtr()->cpuId();
620
621        if (params->work_cpus_ckpt_count != 0 &&
622            sys->markWorkItem(cpuId) >= params->work_cpus_ckpt_count) {
623            //
624            // If active cpus equals checkpoint count, create checkpoint
625            //
626            exitSimLoop("checkpoint");
627        }
628
629        if (systemWorkBeginCount == params->work_begin_ckpt_count) {
630            //
631            // Note: the string specified as the cause of the exit event must
632            // exactly equal "checkpoint" inorder to create a checkpoint
633            //
634            exitSimLoop("checkpoint");
635        }
636
637        if (systemWorkBeginCount == params->work_begin_exit_count) {
638            //
639            // If a certain number of work items started, exit simulation
640            //
641            exitSimLoop("work started count reach");
642        }
643
644        if (cpuId == params->work_begin_cpu_id_exit) {
645            //
646            // If work started on the cpu id specified, exit simulation
647            //
648            exitSimLoop("work started on specific cpu");
649        }
650    }
651}
652
653//
654// This function is executed when annotated work items end.  Depending on
655// what the user specified at the command line, the simulation may exit and/or
656// take a checkpoint when a certain work item ends.
657//
658void
659workend(ThreadContext *tc, uint64_t workid, uint64_t threadid)
660{
661    DPRINTF(PseudoInst, "PseudoInst::workend(%i, %i)\n", workid, threadid);
662    System *sys = tc->getSystemPtr();
663    const System::Params *params = sys->params();
664
665    if (params->exit_on_work_items) {
666        exitSimLoop("workend", static_cast<int>(workid));
667        return;
668    }
669
670    DPRINTF(WorkItems, "Work End workid: %d, threadid %d\n", workid, threadid);
671    tc->getCpuPtr()->workItemEnd();
672    sys->workItemEnd(threadid, workid);
673
674    //
675    // If specified, determine if this is the specific work item the user
676    // identified
677    //
678    if (params->work_item_id == -1 || params->work_item_id == workid) {
679
680        uint64_t systemWorkEndCount = sys->incWorkItemsEnd();
681        int cpuId = tc->getCpuPtr()->cpuId();
682
683        if (params->work_cpus_ckpt_count != 0 &&
684            sys->markWorkItem(cpuId) >= params->work_cpus_ckpt_count) {
685            //
686            // If active cpus equals checkpoint count, create checkpoint
687            //
688            exitSimLoop("checkpoint");
689        }
690
691        if (params->work_end_ckpt_count != 0 &&
692            systemWorkEndCount == params->work_end_ckpt_count) {
693            //
694            // If total work items completed equals checkpoint count, create
695            // checkpoint
696            //
697            exitSimLoop("checkpoint");
698        }
699
700        if (params->work_end_exit_count != 0 &&
701            systemWorkEndCount == params->work_end_exit_count) {
702            //
703            // If total work items completed equals exit count, exit simulation
704            //
705            exitSimLoop("work items exit count reached");
706        }
707    }
708}
709
710} // namespace PseudoInst
711