/*
+ * Copyright (c) 2010-2012, 2015, 2017 ARM Limited
+ * Copyright (c) 2020 Barkhausen Institut
+ * All rights reserved
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder. You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+ *
+ * Copyright (c) 2011 Advanced Micro Devices, Inc.
* Copyright (c) 2003-2006 The Regents of The University of Michigan
* All rights reserved.
*
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * Authors: Nathan Binkert
*/
-#include <errno.h>
+#include "sim/pseudo_inst.hh"
+
#include <fcntl.h>
#include <unistd.h>
+#include <array>
+#include <cerrno>
#include <fstream>
#include <string>
+#include <vector>
-#include "arch/kernel_stats.hh"
-#include "arch/vtophys.hh"
-#include "base/annotate.hh"
+#include "base/debug.hh"
+#include "base/output.hh"
+#include "config/the_isa.hh"
#include "cpu/base.hh"
#include "cpu/thread_context.hh"
-#include "cpu/quiesce_event.hh"
+#include "debug/Loader.hh"
+#include "debug/Quiesce.hh"
+#include "debug/WorkItems.hh"
+#include "dev/net/dist_iface.hh"
#include "params/BaseCPU.hh"
-#include "sim/pseudo_inst.hh"
+#include "sim/process.hh"
#include "sim/serialize.hh"
#include "sim/sim_events.hh"
#include "sim/sim_exit.hh"
#include "sim/stat_control.hh"
#include "sim/stats.hh"
#include "sim/system.hh"
-#include "sim/debug.hh"
-#include "sim/vptr.hh"
-
-using namespace std;
using namespace Stats;
-using namespace TheISA;
-namespace PseudoInst {
+namespace PseudoInst
+{
+
+/**
+ * Unique keys to retrieve various params by the initParam pseudo inst.
+ *
+ * @note Each key may be at most 16 characters (because we use
+ * two 64-bit registers to pass in the key to the initparam function).
+ */
+namespace InitParamKey
+{
+
+/**
+ * The default key (empty string)
+ */
+const std::string DEFAULT = "";
+/**
+ * Unique key for "rank" param (distributed gem5 runs)
+ */
+const std::string DIST_RANK = "dist-rank";
+/**
+ * Unique key for "size" param (distributed gem5 runs)
+ */
+const std::string DIST_SIZE = "dist-size";
+
+} // namespace InitParamKey
void
arm(ThreadContext *tc)
{
- if (tc->getKernelStats())
- tc->getKernelStats()->arm();
+ DPRINTF(PseudoInst, "PseudoInst::arm()\n");
+
+ auto *workload = tc->getSystemPtr()->workload;
+ if (workload)
+ workload->recordArm();
}
void
quiesce(ThreadContext *tc)
{
- if (!tc->getCpuPtr()->params()->do_quiesce)
- return;
-
- DPRINTF(Quiesce, "%s: quiesce()\n", tc->getCpuPtr()->name());
+ DPRINTF(PseudoInst, "PseudoInst::quiesce()\n");
+ tc->quiesce();
+}
- tc->suspend();
- if (tc->getKernelStats())
- tc->getKernelStats()->quiesce();
+void
+quiesceSkip(ThreadContext *tc)
+{
+ DPRINTF(PseudoInst, "PseudoInst::quiesceSkip()\n");
+ tc->quiesceTick(tc->getCpuPtr()->nextCycle() + 1);
}
void
quiesceNs(ThreadContext *tc, uint64_t ns)
{
- if (!tc->getCpuPtr()->params()->do_quiesce || ns == 0)
- return;
-
- EndQuiesceEvent *quiesceEvent = tc->getQuiesceEvent();
-
- Tick resume = curTick + Clock::Int::ns * ns;
-
- mainEventQueue.reschedule(quiesceEvent, resume, true);
-
- DPRINTF(Quiesce, "%s: quiesceNs(%d) until %d\n",
- tc->getCpuPtr()->name(), ns, resume);
-
- tc->suspend();
- if (tc->getKernelStats())
- tc->getKernelStats()->quiesce();
+ DPRINTF(PseudoInst, "PseudoInst::quiesceNs(%i)\n", ns);
+ tc->quiesceTick(curTick() + SimClock::Int::ns * ns);
}
void
quiesceCycles(ThreadContext *tc, uint64_t cycles)
{
- if (!tc->getCpuPtr()->params()->do_quiesce || cycles == 0)
- return;
+ DPRINTF(PseudoInst, "PseudoInst::quiesceCycles(%i)\n", cycles);
+ tc->quiesceTick(tc->getCpuPtr()->clockEdge(Cycles(cycles)));
+}
+
+uint64_t
+quiesceTime(ThreadContext *tc)
+{
+ DPRINTF(PseudoInst, "PseudoInst::quiesceTime()\n");
- EndQuiesceEvent *quiesceEvent = tc->getQuiesceEvent();
+ return (tc->readLastActivate() - tc->readLastSuspend()) /
+ SimClock::Int::ns;
+}
- Tick resume = curTick + tc->getCpuPtr()->ticks(cycles);
+uint64_t
+rpns(ThreadContext *tc)
+{
+ DPRINTF(PseudoInst, "PseudoInst::rpns()\n");
+ return curTick() / SimClock::Int::ns;
+}
- mainEventQueue.reschedule(quiesceEvent, resume, true);
+void
+wakeCPU(ThreadContext *tc, uint64_t cpuid)
+{
+ DPRINTF(PseudoInst, "PseudoInst::wakeCPU(%i)\n", cpuid);
+ System *sys = tc->getSystemPtr();
- DPRINTF(Quiesce, "%s: quiesceCycles(%d) until %d\n",
- tc->getCpuPtr()->name(), cycles, resume);
+ if (sys->threads.size() <= cpuid) {
+ warn("PseudoInst::wakeCPU(%i), cpuid greater than number of contexts"
+ "(%i)\n", cpuid, sys->threads.size());
+ return;
+ }
- tc->suspend();
- if (tc->getKernelStats())
- tc->getKernelStats()->quiesce();
+ ThreadContext *other_tc = sys->threads[cpuid];
+ if (other_tc->status() == ThreadContext::Suspended)
+ other_tc->activate();
}
-uint64_t
-quiesceTime(ThreadContext *tc)
+void
+m5exit(ThreadContext *tc, Tick delay)
{
- return (tc->readLastActivate() - tc->readLastSuspend()) / Clock::Int::ns;
+ DPRINTF(PseudoInst, "PseudoInst::m5exit(%i)\n", delay);
+ if (DistIface::readyToExit(delay)) {
+ Tick when = curTick() + delay * SimClock::Int::ns;
+ exitSimLoop("m5_exit instruction encountered", 0, when, 0, true);
+ }
}
+// m5sum is for sanity checking the gem5 op interface.
uint64_t
-rpns(ThreadContext *tc)
+m5sum(ThreadContext *tc, uint64_t a, uint64_t b, uint64_t c,
+ uint64_t d, uint64_t e, uint64_t f)
{
- return curTick / Clock::Int::ns;
+ DPRINTF(PseudoInst, "PseudoInst::m5sum(%#x, %#x, %#x, %#x, %#x, %#x)\n",
+ a, b, c, d, e, f);
+ return a + b + c + d + e + f;
}
void
-m5exit(ThreadContext *tc, Tick delay)
+m5fail(ThreadContext *tc, Tick delay, uint64_t code)
{
- Tick when = curTick + delay * Clock::Int::ns;
- Event *event = new SimLoopExitEvent("m5_exit instruction encountered", 0);
- mainEventQueue.schedule(event, when);
+ DPRINTF(PseudoInst, "PseudoInst::m5fail(%i, %i)\n", delay, code);
+ Tick when = curTick() + delay * SimClock::Int::ns;
+ exitSimLoop("m5_fail instruction encountered", code, when, 0, true);
}
void
loadsymbol(ThreadContext *tc)
{
- const string &filename = tc->getCpuPtr()->system->params()->symbolfile;
+ DPRINTF(PseudoInst, "PseudoInst::loadsymbol()\n");
+
+ const std::string &filename = tc->getCpuPtr()->system->params().symbolfile;
if (filename.empty()) {
return;
}
std::string buffer;
- ifstream file(filename.c_str());
+ std::ifstream file(filename.c_str());
if (!file)
fatal("file error: Can't open symbol table file %s\n", filename);
if (buffer.empty())
continue;
- int idx = buffer.find(' ');
- if (idx == string::npos)
+ std::string::size_type idx = buffer.find(' ');
+ if (idx == std::string::npos)
continue;
- string address = "0x" + buffer.substr(0, idx);
+ std::string address = "0x" + buffer.substr(0, idx);
eat_white(address);
if (address.empty())
continue;
// Skip over letter and space
- string symbol = buffer.substr(idx + 3);
+ std::string symbol = buffer.substr(idx + 3);
eat_white(symbol);
if (symbol.empty())
continue;
if (!to_number(address, addr))
continue;
- if (!tc->getSystemPtr()->kernelSymtab->insert(addr, symbol))
+ if (!tc->getSystemPtr()->workload->insertSymbol(
+ { Loader::Symbol::Binding::Global, symbol, addr })) {
continue;
+ }
DPRINTF(Loader, "Loaded symbol: %s @ %#llx\n", symbol, addr);
}
void
-resetstats(ThreadContext *tc, Tick delay, Tick period)
+addsymbol(ThreadContext *tc, Addr addr, Addr symbolAddr)
{
- if (!tc->getCpuPtr()->params()->do_statistics_insts)
- return;
+ DPRINTF(PseudoInst, "PseudoInst::addsymbol(0x%x, 0x%x)\n",
+ addr, symbolAddr);
+ std::string symbol;
+ tc->getVirtProxy().readString(symbol, symbolAddr);
- Tick when = curTick + delay * Clock::Int::ns;
- Tick repeat = period * Clock::Int::ns;
+ DPRINTF(Loader, "Loaded symbol: %s @ %#llx\n", symbol, addr);
- Stats::StatEvent(false, true, when, repeat);
+ tc->getSystemPtr()->workload->insertSymbol(
+ { Loader::Symbol::Binding::Global, symbol, addr });
+ Loader::debugSymbolTable.insert(
+ { Loader::Symbol::Binding::Global, symbol, addr });
}
+uint64_t
+initParam(ThreadContext *tc, uint64_t key_str1, uint64_t key_str2)
+{
+ DPRINTF(PseudoInst, "PseudoInst::initParam() key:%s%s\n", (char *)&key_str1,
+ (char *)&key_str2);
+
+ // The key parameter string is passed in via two 64-bit registers. We copy
+ // out the characters from the 64-bit integer variables here, and
+ // concatenate them in the key character buffer
+ const int len = 2 * sizeof(uint64_t) + 1;
+ char key[len];
+ std::memset(key, '\0', len);
+
+ std::array<uint64_t, 2> key_regs = {{ key_str1, key_str2 }};
+ key_regs = letoh(key_regs);
+ std::memcpy(key, key_regs.data(), sizeof(key_regs));
+
+ // Check key parameter to figure out what to return.
+ const std::string key_str(key);
+ if (key == InitParamKey::DEFAULT)
+ return tc->getCpuPtr()->system->init_param;
+ else if (key == InitParamKey::DIST_RANK)
+ return DistIface::rankParam();
+ else if (key == InitParamKey::DIST_SIZE)
+ return DistIface::sizeParam();
+ else
+ panic("Unknown key for initparam pseudo instruction:\"%s\"", key_str);
+}
+
+
void
-dumpstats(ThreadContext *tc, Tick delay, Tick period)
+resetstats(ThreadContext *tc, Tick delay, Tick period)
{
- if (!tc->getCpuPtr()->params()->do_statistics_insts)
+ DPRINTF(PseudoInst, "PseudoInst::resetstats(%i, %i)\n", delay, period);
+ if (!tc->getCpuPtr()->params().do_statistics_insts)
return;
- Tick when = curTick + delay * Clock::Int::ns;
- Tick repeat = period * Clock::Int::ns;
+ Tick when = curTick() + delay * SimClock::Int::ns;
+ Tick repeat = period * SimClock::Int::ns;
- Stats::StatEvent(true, false, when, repeat);
+ Stats::schedStatEvent(false, true, when, repeat);
}
void
-addsymbol(ThreadContext *tc, Addr addr, Addr symbolAddr)
+dumpstats(ThreadContext *tc, Tick delay, Tick period)
{
- char symb[100];
- CopyStringOut(tc, symb, symbolAddr, 100);
- std::string symbol(symb);
+ DPRINTF(PseudoInst, "PseudoInst::dumpstats(%i, %i)\n", delay, period);
+ if (!tc->getCpuPtr()->params().do_statistics_insts)
+ return;
- DPRINTF(Loader, "Loaded symbol: %s @ %#llx\n", symbol, addr);
- tc->getSystemPtr()->kernelSymtab->insert(addr,symbol);
+ Tick when = curTick() + delay * SimClock::Int::ns;
+ Tick repeat = period * SimClock::Int::ns;
+
+ Stats::schedStatEvent(true, false, when, repeat);
}
void
dumpresetstats(ThreadContext *tc, Tick delay, Tick period)
{
- if (!tc->getCpuPtr()->params()->do_statistics_insts)
+ DPRINTF(PseudoInst, "PseudoInst::dumpresetstats(%i, %i)\n", delay, period);
+ if (!tc->getCpuPtr()->params().do_statistics_insts)
return;
- Tick when = curTick + delay * Clock::Int::ns;
- Tick repeat = period * Clock::Int::ns;
+ Tick when = curTick() + delay * SimClock::Int::ns;
+ Tick repeat = period * SimClock::Int::ns;
- Stats::StatEvent(true, true, when, repeat);
+ Stats::schedStatEvent(true, true, when, repeat);
}
void
m5checkpoint(ThreadContext *tc, Tick delay, Tick period)
{
- if (!tc->getCpuPtr()->params()->do_checkpoint_insts)
+ DPRINTF(PseudoInst, "PseudoInst::m5checkpoint(%i, %i)\n", delay, period);
+ if (!tc->getCpuPtr()->params().do_checkpoint_insts)
return;
- Tick when = curTick + delay * Clock::Int::ns;
- Tick repeat = period * Clock::Int::ns;
-
- Event *event = new SimLoopExitEvent("checkpoint", 0, repeat);
- mainEventQueue.schedule(event, when);
+ if (DistIface::readyToCkpt(delay, period)) {
+ Tick when = curTick() + delay * SimClock::Int::ns;
+ Tick repeat = period * SimClock::Int::ns;
+ exitSimLoop("checkpoint", 0, when, repeat);
+ }
}
uint64_t
readfile(ThreadContext *tc, Addr vaddr, uint64_t len, uint64_t offset)
{
- const string &file = tc->getSystemPtr()->params()->readfile;
+ DPRINTF(PseudoInst, "PseudoInst::readfile(0x%x, 0x%x, 0x%x)\n",
+ vaddr, len, offset);
+
+ const std::string &file = tc->getSystemPtr()->params().readfile;
if (file.empty()) {
return ULL(0);
}
}
close(fd);
- CopyIn(tc, vaddr, buf, result);
+ tc->getVirtProxy().writeBlob(vaddr, buf, result);
delete [] buf;
return result;
}
+uint64_t
+writefile(ThreadContext *tc, Addr vaddr, uint64_t len, uint64_t offset,
+ Addr filename_addr)
+{
+ DPRINTF(PseudoInst, "PseudoInst::writefile(0x%x, 0x%x, 0x%x, 0x%x)\n",
+ vaddr, len, offset, filename_addr);
+
+ // copy out target filename
+ std::string filename;
+ tc->getVirtProxy().readString(filename, filename_addr);
+
+ OutputStream *out;
+ if (offset == 0) {
+ // create a new file (truncate)
+ out = simout.create(filename, true, true);
+ } else {
+ // do not truncate file if offset is non-zero
+ // (ios::in flag is required as well to keep the existing data
+ // intact, otherwise existing data will be zeroed out.)
+ out = simout.open(filename,
+ std::ios::in | std::ios::out | std::ios::binary, true);
+ }
+
+ std::ostream *os(out->stream());
+ if (!os)
+ panic("could not open file %s\n", filename);
+
+ if (offset != 0) {
+ // seek to offset
+ os->seekp(offset);
+ }
+
+ // copy out data and write to file
+ char *buf = new char[len];
+ tc->getVirtProxy().readBlob(vaddr, buf, len);
+ os->write(buf, len);
+ if (os->fail() || os->bad())
+ panic("Error while doing writefile!\n");
+
+ simout.close(out);
+
+ delete [] buf;
+
+ return len;
+}
+
void
debugbreak(ThreadContext *tc)
{
- debug_break();
+ DPRINTF(PseudoInst, "PseudoInst::debugbreak()\n");
+ Debug::breakpoint();
}
void
switchcpu(ThreadContext *tc)
{
+ DPRINTF(PseudoInst, "PseudoInst::switchcpu()\n");
exitSimLoop("switchcpu");
}
-/* namespace PseudoInst */ }
+void
+togglesync(ThreadContext *tc)
+{
+ DPRINTF(PseudoInst, "PseudoInst::togglesync()\n");
+ DistIface::toggleSync(tc);
+}
+
+void
+triggerWorkloadEvent(ThreadContext *tc)
+{
+ DPRINTF(PseudoInst, "PseudoInst::triggerWorkloadEvent()\n");
+ tc->getSystemPtr()->workload->event(tc);
+}
+
+//
+// This function is executed when annotated work items begin. Depending on
+// what the user specified at the command line, the simulation may exit and/or
+// take a checkpoint when a certain work item begins.
+//
+void
+workbegin(ThreadContext *tc, uint64_t workid, uint64_t threadid)
+{
+ DPRINTF(PseudoInst, "PseudoInst::workbegin(%i, %i)\n", workid, threadid);
+ System *sys = tc->getSystemPtr();
+ const System::Params ¶ms = sys->params();
+
+ if (params.exit_on_work_items) {
+ exitSimLoop("workbegin", static_cast<int>(workid));
+ return;
+ }
+
+ DPRINTF(WorkItems, "Work Begin workid: %d, threadid %d\n", workid,
+ threadid);
+ tc->getCpuPtr()->workItemBegin();
+ sys->workItemBegin(threadid, workid);
+
+ //
+ // If specified, determine if this is the specific work item the user
+ // identified
+ //
+ if (params.work_item_id == -1 || params.work_item_id == workid) {
+
+ uint64_t systemWorkBeginCount = sys->incWorkItemsBegin();
+ int cpuId = tc->getCpuPtr()->cpuId();
+
+ if (params.work_cpus_ckpt_count != 0 &&
+ sys->markWorkItem(cpuId) >= params.work_cpus_ckpt_count) {
+ //
+ // If active cpus equals checkpoint count, create checkpoint
+ //
+ exitSimLoop("checkpoint");
+ }
+
+ if (systemWorkBeginCount == params.work_begin_ckpt_count) {
+ //
+ // Note: the string specified as the cause of the exit event must
+ // exactly equal "checkpoint" inorder to create a checkpoint
+ //
+ exitSimLoop("checkpoint");
+ }
+
+ if (systemWorkBeginCount == params.work_begin_exit_count) {
+ //
+ // If a certain number of work items started, exit simulation
+ //
+ exitSimLoop("work started count reach");
+ }
+
+ if (cpuId == params.work_begin_cpu_id_exit) {
+ //
+ // If work started on the cpu id specified, exit simulation
+ //
+ exitSimLoop("work started on specific cpu");
+ }
+ }
+}
+
+//
+// This function is executed when annotated work items end. Depending on
+// what the user specified at the command line, the simulation may exit and/or
+// take a checkpoint when a certain work item ends.
+//
+void
+workend(ThreadContext *tc, uint64_t workid, uint64_t threadid)
+{
+ DPRINTF(PseudoInst, "PseudoInst::workend(%i, %i)\n", workid, threadid);
+ System *sys = tc->getSystemPtr();
+ const System::Params ¶ms = sys->params();
+
+ if (params.exit_on_work_items) {
+ exitSimLoop("workend", static_cast<int>(workid));
+ return;
+ }
+
+ DPRINTF(WorkItems, "Work End workid: %d, threadid %d\n", workid, threadid);
+ tc->getCpuPtr()->workItemEnd();
+ sys->workItemEnd(threadid, workid);
+
+ //
+ // If specified, determine if this is the specific work item the user
+ // identified
+ //
+ if (params.work_item_id == -1 || params.work_item_id == workid) {
+
+ uint64_t systemWorkEndCount = sys->incWorkItemsEnd();
+ int cpuId = tc->getCpuPtr()->cpuId();
+
+ if (params.work_cpus_ckpt_count != 0 &&
+ sys->markWorkItem(cpuId) >= params.work_cpus_ckpt_count) {
+ //
+ // If active cpus equals checkpoint count, create checkpoint
+ //
+ exitSimLoop("checkpoint");
+ }
+
+ if (params.work_end_ckpt_count != 0 &&
+ systemWorkEndCount == params.work_end_ckpt_count) {
+ //
+ // If total work items completed equals checkpoint count, create
+ // checkpoint
+ //
+ exitSimLoop("checkpoint");
+ }
+
+ if (params.work_end_exit_count != 0 &&
+ systemWorkEndCount == params.work_end_exit_count) {
+ //
+ // If total work items completed equals exit count, exit simulation
+ //
+ exitSimLoop("work items exit count reached");
+ }
+ }
+}
+
+} // namespace PseudoInst
projects / gem5.git / blobdiff