/*
+ * Copyright (c) 2015 ARM Limited
+ * 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) 2002-2005 The Regents of The University of Michigan
+ * Copyright (c) 2013 Advanced Micro Devices, Inc.
+ * Copyright (c) 2013 Mark D. Hill and David A. Wood
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* Authors: Nathan Binkert
* Erik Hallnor
* Steve Reinhardt
+ * Andreas Sandberg
*/
+#include "sim/serialize.hh"
+
+#include <sys/stat.h>
#include <sys/time.h>
#include <sys/types.h>
-#include <sys/stat.h>
-#include <errno.h>
+#include <cerrno>
#include <fstream>
#include <list>
#include <string>
#include <vector>
+#include "arch/generic/vec_reg.hh"
+#include "base/framebuffer.hh"
#include "base/inifile.hh"
-#include "base/misc.hh"
+#include "base/logging.hh"
#include "base/output.hh"
#include "base/str.hh"
#include "base/trace.hh"
+#include "debug/Checkpoint.hh"
#include "sim/eventq.hh"
-#include "sim/param.hh"
-#include "sim/serialize.hh"
#include "sim/sim_events.hh"
#include "sim/sim_exit.hh"
#include "sim/sim_object.hh"
using namespace std;
-extern SimObject *resolveSimObject(const string &);
+//
+// The base implementations use to_number for parsing and '<<' for
+// displaying, suitable for integer types.
+//
+template <class T>
+bool
+parseParam(const string &s, T &value)
+{
+ return to_number(s, value);
+}
+
+template <class T>
+void
+showParam(CheckpointOut &os, const T &value)
+{
+ os << value;
+}
+
+//
+// Template specializations:
+// - char (8-bit integer)
+// - floating-point types
+// - bool
+// - string
+//
+
+// Treat 8-bit ints (chars) as ints on output, not as chars
+template <>
+void
+showParam(CheckpointOut &os, const char &value)
+{
+ os << (int)value;
+}
+
+
+template <>
+void
+showParam(CheckpointOut &os, const signed char &value)
+{
+ os << (int)value;
+}
+
+
+template <>
+void
+showParam(CheckpointOut &os, const unsigned char &value)
+{
+ os << (unsigned int)value;
+}
+
+
+template <>
+bool
+parseParam(const string &s, float &value)
+{
+ return to_number(s, value);
+}
+
+template <>
+bool
+parseParam(const string &s, double &value)
+{
+ return to_number(s, value);
+}
+
+template <>
+bool
+parseParam(const string &s, bool &value)
+{
+ return to_bool(s, value);
+}
+
+// Display bools as strings
+template <>
+void
+showParam(CheckpointOut &os, const bool &value)
+{
+ os << (value ? "true" : "false");
+}
+
+
+// String requires no processing to speak of
+template <>
+bool
+parseParam(const string &s, string &value)
+{
+ value = s;
+ return true;
+}
int Serializable::ckptMaxCount = 0;
int Serializable::ckptCount = 0;
int Serializable::ckptPrevCount = -1;
+std::stack<std::string> Serializable::path;
+template <class T>
void
-Serializable::nameOut(ostream &os)
+paramOut(CheckpointOut &os, const string &name, const T ¶m)
{
- os << "\n[" << name() << "]\n";
+ os << name << "=";
+ showParam(os, param);
+ os << "\n";
}
+template <class T>
void
-Serializable::nameOut(ostream &os, const string &_name)
+arrayParamOut(CheckpointOut &os, const string &name, const vector<T> ¶m)
{
- os << "\n[" << _name << "]\n";
+ typename vector<T>::size_type size = param.size();
+ os << name << "=";
+ if (size > 0)
+ showParam(os, param[0]);
+ for (typename vector<T>::size_type i = 1; i < size; ++i) {
+ os << " ";
+ showParam(os, param[i]);
+ }
+ os << "\n";
}
template <class T>
void
-paramOut(ostream &os, const std::string &name, const T ¶m)
+arrayParamOut(CheckpointOut &os, const string &name, const list<T> ¶m)
{
+ typename list<T>::const_iterator it = param.begin();
+
os << name << "=";
- showParam(os, param);
+ if (param.size() > 0)
+ showParam(os, *it);
+ it++;
+ while (it != param.end()) {
+ os << " ";
+ showParam(os, *it);
+ it++;
+ }
os << "\n";
}
+template <class T>
+void
+arrayParamOut(CheckpointOut &os, const string &name, const set<T> ¶m)
+{
+ typename set<T>::const_iterator it = param.begin();
+
+ os << name << "=";
+ if (param.size() > 0)
+ showParam(os, *it);
+ it++;
+ while (it != param.end()) {
+ os << " ";
+ showParam(os, *it);
+ it++;
+ }
+ os << "\n";
+}
template <class T>
void
-paramIn(Checkpoint *cp, const std::string §ion,
- const std::string &name, T ¶m)
+paramIn(CheckpointIn &cp, const string &name, T ¶m)
{
- std::string str;
- if (!cp->find(section, name, str) || !parseParam(str, param)) {
+ const string §ion(Serializable::currentSection());
+ string str;
+ if (!cp.find(section, name, str) || !parseParam(str, param)) {
fatal("Can't unserialize '%s:%s'\n", section, name);
}
}
+template <class T>
+bool
+optParamIn(CheckpointIn &cp, const string &name, T ¶m, bool warn)
+{
+ const string §ion(Serializable::currentSection());
+ string str;
+ if (!cp.find(section, name, str) || !parseParam(str, param)) {
+ if (warn)
+ warn("optional parameter %s:%s not present\n", section, name);
+ return false;
+ } else {
+ return true;
+ }
+}
template <class T>
void
-arrayParamOut(ostream &os, const std::string &name,
- const T *param, int size)
+arrayParamOut(CheckpointOut &os, const string &name,
+ const T *param, unsigned size)
{
os << name << "=";
if (size > 0)
showParam(os, param[0]);
- for (int i = 1; i < size; ++i) {
+ for (unsigned i = 1; i < size; ++i) {
os << " ";
showParam(os, param[i]);
}
template <class T>
void
-arrayParamIn(Checkpoint *cp, const std::string §ion,
- const std::string &name, T *param, int size)
+arrayParamIn(CheckpointIn &cp, const string &name, T *param, unsigned size)
{
- std::string str;
- if (!cp->find(section, name, str)) {
+ const string §ion(Serializable::currentSection());
+ string str;
+ if (!cp.find(section, name, str)) {
fatal("Can't unserialize '%s:%s'\n", section, name);
}
fatal("Array size mismatch on %s:%s'\n", section, name);
}
- for (int i = 0; i < tokens.size(); i++) {
+ for (vector<string>::size_type i = 0; i < tokens.size(); i++) {
// need to parse into local variable to handle vector<bool>,
// for which operator[] returns a special reference class
// that's not the same as 'bool&', (since it's a packed
}
}
+template <class T>
+void
+arrayParamIn(CheckpointIn &cp, const string &name, vector<T> ¶m)
+{
+ const string §ion(Serializable::currentSection());
+ string str;
+ if (!cp.find(section, name, str)) {
+ fatal("Can't unserialize '%s:%s'\n", section, name);
+ }
+
+ // code below stolen from VectorParam<T>::parse().
+ // it would be nice to unify these somehow...
+
+ vector<string> tokens;
+
+ tokenize(tokens, str, ' ');
+
+ // Need this if we were doing a vector
+ // value.resize(tokens.size());
+
+ param.resize(tokens.size());
+
+ for (vector<string>::size_type i = 0; i < tokens.size(); i++) {
+ // need to parse into local variable to handle vector<bool>,
+ // for which operator[] returns a special reference class
+ // that's not the same as 'bool&', (since it's a packed
+ // vector)
+ T scalar_value;
+ if (!parseParam(tokens[i], scalar_value)) {
+ string err("could not parse \"");
+ err += str;
+ err += "\"";
+
+ fatal(err);
+ }
+
+ // assign parsed value to vector
+ param[i] = scalar_value;
+ }
+}
+
+template <class T>
void
-objParamIn(Checkpoint *cp, const std::string §ion,
- const std::string &name, SimObject * ¶m)
+arrayParamIn(CheckpointIn &cp, const string &name, list<T> ¶m)
{
- if (!cp->findObj(section, name, param)) {
+ const string §ion(Serializable::currentSection());
+ string str;
+ if (!cp.find(section, name, str)) {
fatal("Can't unserialize '%s:%s'\n", section, name);
}
+ param.clear();
+
+ vector<string> tokens;
+ tokenize(tokens, str, ' ');
+
+ for (vector<string>::size_type i = 0; i < tokens.size(); i++) {
+ T scalar_value;
+ if (!parseParam(tokens[i], scalar_value)) {
+ string err("could not parse \"");
+
+ err += str;
+ err += "\"";
+
+ fatal(err);
+ }
+
+ // assign parsed value to vector
+ param.push_back(scalar_value);
+ }
}
+template <class T>
+void
+arrayParamIn(CheckpointIn &cp, const string &name, set<T> ¶m)
+{
+ const string §ion(Serializable::currentSection());
+ string str;
+ if (!cp.find(section, name, str)) {
+ fatal("Can't unserialize '%s:%s'\n", section, name);
+ }
+ param.clear();
+
+ vector<string> tokens;
+ tokenize(tokens, str, ' ');
-#define INSTANTIATE_PARAM_TEMPLATES(type) \
-template void \
-paramOut(ostream &os, const std::string &name, type const ¶m); \
-template void \
-paramIn(Checkpoint *cp, const std::string §ion, \
- const std::string &name, type & param); \
-template void \
-arrayParamOut(ostream &os, const std::string &name, \
- type const *param, int size); \
-template void \
-arrayParamIn(Checkpoint *cp, const std::string §ion, \
- const std::string &name, type *param, int size);
+ for (vector<string>::size_type i = 0; i < tokens.size(); i++) {
+ T scalar_value;
+ if (!parseParam(tokens[i], scalar_value)) {
+ string err("could not parse \"");
+ err += str;
+ err += "\"";
+
+ fatal(err);
+ }
+
+ // assign parsed value to vector
+ param.insert(scalar_value);
+ }
+}
+
+
+void
+objParamIn(CheckpointIn &cp, const string &name, SimObject * ¶m)
+{
+ const string §ion(Serializable::currentSection());
+ if (!cp.findObj(section, name, param)) {
+ fatal("Can't unserialize '%s:%s'\n", section, name);
+ }
+}
+
+
+#define INSTANTIATE_PARAM_TEMPLATES(type) \
+ template void \
+ paramOut(CheckpointOut &os, const string &name, type const ¶m); \
+ template void \
+ paramIn(CheckpointIn &cp, const string &name, type & param); \
+ template bool \
+ optParamIn(CheckpointIn &cp, const string &name, type & param, \
+ bool warn); \
+ template void \
+ arrayParamOut(CheckpointOut &os, const string &name, \
+ type const *param, unsigned size); \
+ template void \
+ arrayParamIn(CheckpointIn &cp, const string &name, \
+ type *param, unsigned size); \
+ template void \
+ arrayParamOut(CheckpointOut &os, const string &name, \
+ const vector<type> ¶m); \
+ template void \
+ arrayParamIn(CheckpointIn &cp, const string &name, \
+ vector<type> ¶m); \
+ template void \
+ arrayParamOut(CheckpointOut &os, const string &name, \
+ const list<type> ¶m); \
+ template void \
+ arrayParamIn(CheckpointIn &cp, const string &name, \
+ list<type> ¶m);
+
+INSTANTIATE_PARAM_TEMPLATES(char)
INSTANTIATE_PARAM_TEMPLATES(signed char)
INSTANTIATE_PARAM_TEMPLATES(unsigned char)
INSTANTIATE_PARAM_TEMPLATES(signed short)
INSTANTIATE_PARAM_TEMPLATES(signed long long)
INSTANTIATE_PARAM_TEMPLATES(unsigned long long)
INSTANTIATE_PARAM_TEMPLATES(bool)
+INSTANTIATE_PARAM_TEMPLATES(float)
+INSTANTIATE_PARAM_TEMPLATES(double)
INSTANTIATE_PARAM_TEMPLATES(string)
+INSTANTIATE_PARAM_TEMPLATES(Pixel)
+INSTANTIATE_PARAM_TEMPLATES(VecRegContainer<8>)
+INSTANTIATE_PARAM_TEMPLATES(VecRegContainer<16>)
+// set is only used with strings and furthermore doesn't agree with Pixel
+template void
+arrayParamOut(CheckpointOut &, const string &, const set<string> &);
+template void
+arrayParamIn(CheckpointIn &, const string &, set<string> &);
/////////////////////////////
class Globals : public Serializable
{
public:
- const string name() const;
- void serialize(ostream &os);
- void unserialize(Checkpoint *cp);
+ Globals()
+ : unserializedCurTick(0) {}
+
+ void serialize(CheckpointOut &cp) const override;
+ void unserialize(CheckpointIn &cp) override;
+
+ Tick unserializedCurTick;
};
/// The one and only instance of the Globals class.
Globals globals;
-const string
-Globals::name() const
+/// The version tags for this build of the simulator, to be stored in the
+/// Globals section during serialization and compared upon unserialization.
+extern std::set<std::string> version_tags;
+
+void
+Globals::serialize(CheckpointOut &cp) const
{
- return "Globals";
+ paramOut(cp, "curTick", curTick());
+ SERIALIZE_CONTAINER(version_tags);
}
void
-Globals::serialize(ostream &os)
+Globals::unserialize(CheckpointIn &cp)
+{
+ paramIn(cp, "curTick", unserializedCurTick);
+
+ const std::string §ion(Serializable::currentSection());
+ std::string str;
+ if (!cp.find(section, "version_tags", str)) {
+ warn("**********************************************************\n");
+ warn("!!!! Checkpoint uses an old versioning scheme. !!!!\n");
+ warn("Run the checkpoint upgrader (util/cpt_upgrader.py) on your "
+ "checkpoint\n");
+ warn("**********************************************************\n");
+ return;
+ }
+
+ std::set<std::string> cpt_tags;
+ arrayParamIn(cp, "version_tags", cpt_tags); // UNSERIALIZE_CONTAINER
+
+ bool err = false;
+ for (const auto& t : version_tags) {
+ if (cpt_tags.find(t) == cpt_tags.end()) {
+ // checkpoint is missing tag that this binary has
+ if (!err) {
+ warn("*****************************************************\n");
+ warn("!!!! Checkpoint is missing the following version tags:\n");
+ err = true;
+ }
+ warn(" %s\n", t);
+ }
+ }
+ if (err) {
+ warn("You might experience some issues when restoring and should run "
+ "the checkpoint upgrader (util/cpt_upgrader.py) on your "
+ "checkpoint\n");
+ warn("**********************************************************\n");
+ }
+
+ err = false;
+ for (const auto& t : cpt_tags) {
+ if (version_tags.find(t) == version_tags.end()) {
+ // gem5 binary is missing tag that this checkpoint has
+ if (!err) {
+ warn("*****************************************************\n");
+ warn("!!!! gem5 is missing the following version tags:\n");
+ err = true;
+ }
+ warn(" %s\n", t);
+ }
+ }
+ if (err) {
+ warn("Running a checkpoint with incompatible version tags is not "
+ "supported. While it might work, you may experience incorrect "
+ "behavior or crashes.\n");
+ warn("**********************************************************\n");
+ }
+}
+
+Serializable::Serializable()
{
- nameOut(os);
- SERIALIZE_SCALAR(curTick);
+}
- nameOut(os, "MainEventQueue");
- mainEventQueue.serialize(os);
+Serializable::~Serializable()
+{
}
void
-Globals::unserialize(Checkpoint *cp)
+Serializable::serializeSection(CheckpointOut &cp, const char *name) const
{
- const string §ion = name();
- UNSERIALIZE_SCALAR(curTick);
+ Serializable::ScopedCheckpointSection sec(cp, name);
+ serialize(cp);
+}
- mainEventQueue.unserialize(cp, "MainEventQueue");
+void
+Serializable::unserializeSection(CheckpointIn &cp, const char *name)
+{
+ Serializable::ScopedCheckpointSection sec(cp, name);
+ unserialize(cp);
}
void
-Serializable::serializeAll(const std::string &cpt_dir)
+Serializable::serializeAll(const string &cpt_dir)
{
- setCheckpointDir(cpt_dir);
- string dir = Checkpoint::dir();
+ string dir = CheckpointIn::setDir(cpt_dir);
if (mkdir(dir.c_str(), 0775) == -1 && errno != EEXIST)
fatal("couldn't mkdir %s\n", dir);
- string cpt_file = dir + Checkpoint::baseFilename;
+ string cpt_file = dir + CheckpointIn::baseFilename;
ofstream outstream(cpt_file.c_str());
time_t t = time(NULL);
- outstream << "// checkpoint generated: " << ctime(&t);
+ if (!outstream.is_open())
+ fatal("Unable to open file %s for writing\n", cpt_file.c_str());
+ outstream << "## checkpoint generated: " << ctime(&t);
+
+ globals.serializeSection(outstream, "Globals");
- globals.serialize(outstream);
SimObject::serializeAll(outstream);
}
void
-Serializable::unserializeAll(const std::string &cpt_dir)
+Serializable::unserializeGlobals(CheckpointIn &cp)
{
- setCheckpointDir(cpt_dir);
- string dir = Checkpoint::dir();
- string cpt_file = dir + Checkpoint::baseFilename;
- string section = "";
-
- DPRINTFR(Config, "Loading checkpoint dir '%s'\n",
- dir);
- Checkpoint *cp = new Checkpoint(dir, section);
- unserializeGlobals(cp);
+ globals.unserializeSection(cp, "Globals");
- SimObject::unserializeAll(cp);
+ for (uint32_t i = 0; i < numMainEventQueues; ++i)
+ mainEventQueue[i]->setCurTick(globals.unserializedCurTick);
}
-void
-Serializable::unserializeGlobals(Checkpoint *cp)
+Serializable::ScopedCheckpointSection::~ScopedCheckpointSection()
{
- globals.unserialize(cp);
+ assert(!path.empty());
+ DPRINTF(Checkpoint, "Popping: %s\n", path.top());
+ path.pop();
}
-const char *Checkpoint::baseFilename = "m5.cpt";
-
-static string checkpointDirBase;
-
void
-setCheckpointDir(const std::string &name)
+Serializable::ScopedCheckpointSection::pushName(const char *obj_name)
{
- checkpointDirBase = name;
- if (checkpointDirBase[checkpointDirBase.size() - 1] != '/')
- checkpointDirBase += "/";
+ if (path.empty()) {
+ path.push(obj_name);
+ } else {
+ path.push(csprintf("%s.%s", path.top(), obj_name));
+ }
+ DPRINTF(Checkpoint, "ScopedCheckpointSection::pushName: %s\n", obj_name);
}
-string
-Checkpoint::dir()
+void
+Serializable::ScopedCheckpointSection::nameOut(CheckpointOut &cp)
{
- // use csprintf to insert curTick into directory name if it
- // appears to have a format placeholder in it.
- return (checkpointDirBase.find("%") != string::npos) ?
- csprintf(checkpointDirBase, curTick) : checkpointDirBase;
+ DPRINTF(Checkpoint, "ScopedCheckpointSection::nameOut: %s\n",
+ Serializable::currentSection());
+ cp << "\n[" << Serializable::currentSection() << "]\n";
}
void
-debug_serialize(const std::string &cpt_dir)
+debug_serialize(const string &cpt_dir)
{
Serializable::serializeAll(cpt_dir);
}
-
-////////////////////////////////////////////////////////////////////////
-//
-// SerializableClass member definitions
-//
-////////////////////////////////////////////////////////////////////////
-
-// Map of class names to SerializableBuilder creation functions.
-// Need to make this a pointer so we can force initialization on the
-// first reference; otherwise, some SerializableClass constructors
-// may be invoked before the classMap constructor.
-map<string,SerializableClass::CreateFunc> *SerializableClass::classMap = 0;
-
-// SerializableClass constructor: add mapping to classMap
-SerializableClass::SerializableClass(const string &className,
- CreateFunc createFunc)
-{
- if (classMap == NULL)
- classMap = new map<string,SerializableClass::CreateFunc>();
-
- if ((*classMap)[className])
- {
- cerr << "Error: simulation object class " << className << " redefined"
- << endl;
- fatal("");
- }
-
- // add className --> createFunc to class map
- (*classMap)[className] = createFunc;
-}
-
-
-//
-//
-Serializable *
-SerializableClass::createObject(Checkpoint *cp,
- const std::string §ion)
+const std::string &
+Serializable::currentSection()
{
- string className;
-
- if (!cp->find(section, "type", className)) {
- fatal("Serializable::create: no 'type' entry in section '%s'.\n",
- section);
- }
+ assert(!path.empty());
- CreateFunc createFunc = (*classMap)[className];
-
- if (createFunc == NULL) {
- fatal("Serializable::create: no create function for class '%s'.\n",
- className);
- }
+ return path.top();
+}
- Serializable *object = createFunc(cp, section);
+const char *CheckpointIn::baseFilename = "m5.cpt";
- assert(object != NULL);
+string CheckpointIn::currentDirectory;
- return object;
+string
+CheckpointIn::setDir(const string &name)
+{
+ // use csprintf to insert curTick() into directory name if it
+ // appears to have a format placeholder in it.
+ currentDirectory = (name.find("%") != string::npos) ?
+ csprintf(name, curTick()) : name;
+ if (currentDirectory[currentDirectory.size() - 1] != '/')
+ currentDirectory += "/";
+ return currentDirectory;
}
-
-Serializable *
-Serializable::create(Checkpoint *cp, const std::string §ion)
+string
+CheckpointIn::dir()
{
- Serializable *object = SerializableClass::createObject(cp, section);
- object->unserialize(cp, section);
- return object;
+ return currentDirectory;
}
-Checkpoint::Checkpoint(const std::string &cpt_dir, const std::string &path)
- : db(new IniFile), basePath(path), cptDir(cpt_dir)
+CheckpointIn::CheckpointIn(const string &cpt_dir, SimObjectResolver &resolver)
+ : db(new IniFile), objNameResolver(resolver), cptDir(setDir(cpt_dir))
{
- string filename = cpt_dir + "/" + Checkpoint::baseFilename;
+ string filename = cptDir + "/" + CheckpointIn::baseFilename;
if (!db->load(filename)) {
fatal("Can't load checkpoint file '%s'\n", filename);
}
}
+CheckpointIn::~CheckpointIn()
+{
+ delete db;
+}
bool
-Checkpoint::find(const std::string §ion, const std::string &entry,
- std::string &value)
+CheckpointIn::entryExists(const string §ion, const string &entry)
+{
+ return db->entryExists(section, entry);
+}
+
+bool
+CheckpointIn::find(const string §ion, const string &entry, string &value)
{
return db->find(section, entry, value);
}
bool
-Checkpoint::findObj(const std::string §ion, const std::string &entry,
+CheckpointIn::findObj(const string §ion, const string &entry,
SimObject *&value)
{
string path;
if (!db->find(section, entry, path))
return false;
- value = resolveSimObject(path);
+ value = objNameResolver.resolveSimObject(path);
return true;
}
bool
-Checkpoint::sectionExists(const std::string §ion)
+CheckpointIn::sectionExists(const string §ion)
{
return db->sectionExists(section);
}
-
-/** Hacked stat reset event */
-
-class StatresetParamContext : public ParamContext
-{
- public:
- StatresetParamContext(const string §ion);
- ~StatresetParamContext();
- void startup();
-};
-
-StatresetParamContext statParams("statsreset");
-
-Param<Tick> reset_cycle(&statParams, "reset_cycle",
- "Cycle to reset stats on", 0);
-
-StatresetParamContext::StatresetParamContext(const string §ion)
- : ParamContext(section)
-{ }
-
-StatresetParamContext::~StatresetParamContext()
-{
-}
-
-void
-StatresetParamContext::startup()
-{
- if (reset_cycle > 0) {
- Stats::SetupEvent(Stats::Reset, curTick + reset_cycle, 0);
- cprintf("Stats reset event scheduled for %lli\n",
- curTick + reset_cycle);
- }
-}
projects / gem5.git / blobdiff