diff options
| -rw-r--r-- | arch/alpha/alpha_memory.cc | 9 | ||||
| -rw-r--r-- | cpu/intr_control.cc | 1 | ||||
| -rw-r--r-- | cpu/memtest/memtest.cc | 10 | ||||
| -rw-r--r-- | cpu/simple_cpu/simple_cpu.cc | 59 | ||||
| -rw-r--r-- | dev/alpha_console.cc | 18 | ||||
| -rw-r--r-- | dev/console.cc | 6 | ||||
| -rw-r--r-- | dev/disk_image.cc | 7 | ||||
| -rw-r--r-- | dev/etherbus.cc | 6 | ||||
| -rw-r--r-- | dev/etherdump.cc | 2 | ||||
| -rw-r--r-- | dev/etherlink.cc | 8 | ||||
| -rw-r--r-- | dev/ethertap.cc | 9 | ||||
| -rw-r--r-- | dev/simple_disk.cc | 13 | ||||
| -rw-r--r-- | kern/tru64/tru64_system.cc | 5 | ||||
| -rw-r--r-- | sim/builder.cc | 191 | ||||
| -rw-r--r-- | sim/builder.hh | 221 | ||||
| -rw-r--r-- | sim/main.cc | 15 | ||||
| -rw-r--r-- | sim/prog.cc | 17 | ||||
| -rw-r--r-- | sim/sim_object.cc | 152 | ||||
| -rw-r--r-- | sim/sim_object.hh | 181 |
19 files changed, 503 insertions, 427 deletions
diff --git a/arch/alpha/alpha_memory.cc b/arch/alpha/alpha_memory.cc index 669fe92bb..83dd5accf 100644 --- a/arch/alpha/alpha_memory.cc +++ b/arch/alpha/alpha_memory.cc @@ -30,12 +30,13 @@ #include <string> #include <vector> -#include "targetarch/alpha_memory.hh" -#include "targetarch/ev5.hh" -#include "cpu/exec_context.hh" -#include "base/trace.hh" #include "base/inifile.hh" #include "base/str.hh" +#include "base/trace.hh" +#include "cpu/exec_context.hh" +#include "sim/builder.hh" +#include "targetarch/alpha_memory.hh" +#include "targetarch/ev5.hh" using namespace std; diff --git a/cpu/intr_control.cc b/cpu/intr_control.cc index bce427eea..037b00ef4 100644 --- a/cpu/intr_control.cc +++ b/cpu/intr_control.cc @@ -31,6 +31,7 @@ #include "cpu/base_cpu.hh" #include "cpu/intr_control.hh" +#include "sim/builder.hh" #include "sim/sim_object.hh" using namespace std; diff --git a/cpu/memtest/memtest.cc b/cpu/memtest/memtest.cc index 6292911cd..e67a129d2 100644 --- a/cpu/memtest/memtest.cc +++ b/cpu/memtest/memtest.cc @@ -33,13 +33,13 @@ #include <iomanip> #include <vector> -#include "cpu/memtest/memtest.hh" #include "base/misc.hh" -#include "sim/sim_events.hh" -#include "mem/functional_mem/main_memory.hh" -#include "mem/cache/base_cache.hh" - #include "base/statistics.hh" +#include "cpu/memtest/memtest.hh" +#include "mem/cache/base_cache.hh" +#include "mem/functional_mem/main_memory.hh" +#include "sim/builder.hh" +#include "sim/sim_events.hh" #include "sim/sim_stats.hh" using namespace std; diff --git a/cpu/simple_cpu/simple_cpu.cc b/cpu/simple_cpu/simple_cpu.cc index 20790bfb6..3c9be172f 100644 --- a/cpu/simple_cpu/simple_cpu.cc +++ b/cpu/simple_cpu/simple_cpu.cc @@ -26,60 +26,53 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +#include <cmath> +#include <cstdio> +#include <cstdlib> #include <iostream> #include <iomanip> #include <list> #include <sstream> #include <string> -#include <stdio.h> -#include <stdlib.h> -#include <math.h> - -#include "sim/host.hh" #include "base/cprintf.hh" +#include "base/inifile.hh" +#include "base/loader/symtab.hh" #include "base/misc.hh" -#include "cpu/full_cpu/smt.hh" - -#include "sim/annotation.hh" -#include "cpu/exec_context.hh" +#include "base/pollevent.hh" +#include "base/range.hh" +#include "base/trace.hh" #include "cpu/base_cpu.hh" -#include "sim/debug.hh" +#include "cpu/exec_context.hh" +#include "cpu/exetrace.hh" +#include "cpu/full_cpu/smt.hh" #include "cpu/simple_cpu/simple_cpu.hh" -#include "base/inifile.hh" -#include "mem/mem_interface.hh" -#include "mem/base_mem.hh" #include "cpu/static_inst.hh" +#include "mem/base_mem.hh" +#include "mem/mem_interface.hh" +#include "sim/annotation.hh" +#include "sim/builder.hh" +#include "sim/debug.hh" +#include "sim/host.hh" +#include "sim/sim_events.hh" +#include "sim/sim_object.hh" +#include "sim/sim_stats.hh" #ifdef FULL_SYSTEM +#include "base/remote_gdb.hh" +#include "dev/alpha_access.h" +#include "dev/pciareg.h" #include "mem/functional_mem/memory_control.hh" #include "mem/functional_mem/physical_memory.hh" -#include "targetarch/alpha_memory.hh" #include "sim/system.hh" +#include "targetarch/alpha_memory.hh" +#include "targetarch/vtophys.hh" #else // !FULL_SYSTEM +#include "eio/eio.hh" #include "mem/functional_mem/functional_memory.hh" #include "sim/prog.hh" -#include "eio/eio.hh" #endif // FULL_SYSTEM -#include "cpu/exetrace.hh" -#include "base/trace.hh" -#include "sim/sim_events.hh" -#include "base/pollevent.hh" -#include "sim/sim_object.hh" -#include "sim/sim_stats.hh" - -#include "base/range.hh" -#include "base/loader/symtab.hh" - -#ifdef FULL_SYSTEM -#include "targetarch/vtophys.hh" -#include "dev/pciareg.h" -#include "base/remote_gdb.hh" -#include "dev/alpha_access.h" -#endif - - using namespace std; SimpleCPU::CacheCompletionEvent::CacheCompletionEvent(SimpleCPU *_cpu) diff --git a/dev/alpha_console.cc b/dev/alpha_console.cc index 526ef0b3c..b917d7a96 100644 --- a/dev/alpha_console.cc +++ b/dev/alpha_console.cc @@ -30,22 +30,22 @@ * System Console Definition */ -#include <stddef.h> -#include <stdio.h> - +#include <cstddef> +#include <cstdio> #include <string> -#include "dev/alpha_console.hh" +#include "base/inifile.hh" +#include "base/str.hh" // for to_number() +#include "base/trace.hh" #include "cpu/base_cpu.hh" -#include "dev/console.hh" #include "cpu/exec_context.hh" -#include "mem/functional_mem/memory_control.hh" +#include "dev/alpha_console.hh" +#include "dev/console.hh" #include "dev/simple_disk.hh" #include "dev/tlaser_clock.hh" +#include "mem/functional_mem/memory_control.hh" +#include "sim/builder.hh" #include "sim/system.hh" -#include "base/trace.hh" -#include "base/inifile.hh" -#include "base/str.hh" // for to_number() using namespace std; diff --git a/dev/console.cc b/dev/console.cc index 976118e2f..168907417 100644 --- a/dev/console.cc +++ b/dev/console.cc @@ -43,12 +43,12 @@ #include <string> #include "base/misc.hh" -#include "targetarch/ev5.hh" - -#include "dev/console.hh" #include "base/socket.hh" #include "base/trace.hh" +#include "dev/console.hh" #include "mem/functional_mem/memory_control.hh" +#include "sim/builder.hh" +#include "targetarch/ev5.hh" using namespace std; diff --git a/dev/disk_image.cc b/dev/disk_image.cc index 0a3955ed1..78599f8d7 100644 --- a/dev/disk_image.cc +++ b/dev/disk_image.cc @@ -33,18 +33,19 @@ #include <sys/types.h> #include <sys/uio.h> #include <errno.h> -#include <string.h> #include <unistd.h> #include <cstdio> +#include <cstring> #include <fstream> #include <string> -#include "dev/disk_image.hh" +#include "base/callback.hh" #include "base/misc.hh" #include "base/trace.hh" +#include "dev/disk_image.hh" +#include "sim/builder.hh" #include "sim/sim_exit.hh" -#include "base/callback.hh" using namespace std; diff --git a/dev/etherbus.cc b/dev/etherbus.cc index fa1d84272..3f6036f72 100644 --- a/dev/etherbus.cc +++ b/dev/etherbus.cc @@ -30,17 +30,17 @@ * Device module for modelling an ethernet hub */ +#include <cmath> #include <deque> #include <string> #include <vector> -#include <math.h> - +#include "base/trace.hh" #include "dev/etherbus.hh" #include "dev/etherdump.hh" #include "dev/etherint.hh" #include "dev/etherpkt.hh" -#include "base/trace.hh" +#include "sim/builder.hh" #include "sim/universe.hh" using namespace std; diff --git a/dev/etherdump.cc b/dev/etherdump.cc index dcca0e458..60dc1559d 100644 --- a/dev/etherdump.cc +++ b/dev/etherdump.cc @@ -34,8 +34,8 @@ #include <string> -#include "sim/universe.hh" #include "dev/etherdump.hh" +#include "sim/builder.hh" #include "sim/universe.hh" using std::string; diff --git a/dev/etherlink.cc b/dev/etherlink.cc index 699e9f331..e5665c7b1 100644 --- a/dev/etherlink.cc +++ b/dev/etherlink.cc @@ -30,17 +30,17 @@ * Device module for modelling a fixed bandwidth full duplex ethernet link */ +#include <cmath> #include <deque> #include <string> #include <vector> -#include <math.h> - -#include "dev/etherlink.hh" +#include "base/trace.hh" #include "dev/etherdump.hh" #include "dev/etherint.hh" +#include "dev/etherlink.hh" #include "dev/etherpkt.hh" -#include "base/trace.hh" +#include "sim/builder.hh" #include "sim/universe.hh" using namespace std; diff --git a/dev/ethertap.cc b/dev/ethertap.cc index e12c07c26..b99d46ce5 100644 --- a/dev/ethertap.cc +++ b/dev/ethertap.cc @@ -40,14 +40,15 @@ #include <deque> #include <string> +#include "base/misc.hh" +#include "base/pollevent.hh" +#include "base/socket.hh" +#include "base/trace.hh" #include "dev/etherdump.hh" #include "dev/etherint.hh" #include "dev/etherpkt.hh" #include "dev/ethertap.hh" -#include "base/pollevent.hh" -#include "base/socket.hh" -#include "base/trace.hh" -#include "base/misc.hh" +#include "sim/builder.hh" using namespace std; diff --git a/dev/simple_disk.cc b/dev/simple_disk.cc index d26cf44ea..aa6ff5b38 100644 --- a/dev/simple_disk.cc +++ b/dev/simple_disk.cc @@ -30,19 +30,20 @@ * Simple disk interface for the system console */ -#include <string> - #include <sys/types.h> #include <sys/uio.h> #include <fcntl.h> -#include <string.h> #include <unistd.h> -#include "dev/disk_image.hh" +#include <cstring> +#include <string> + #include "base/misc.hh" -#include "mem/functional_mem/physical_memory.hh" -#include "dev/simple_disk.hh" #include "base/trace.hh" +#include "dev/disk_image.hh" +#include "dev/simple_disk.hh" +#include "mem/functional_mem/physical_memory.hh" +#include "sim/builder.hh" using namespace std; diff --git a/kern/tru64/tru64_system.cc b/kern/tru64/tru64_system.cc index 02b6c4fae..b31b82644 100644 --- a/kern/tru64/tru64_system.cc +++ b/kern/tru64/tru64_system.cc @@ -26,17 +26,18 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -#include "base/remote_gdb.hh" -#include "base/trace.hh" #include "base/loader/aout_object.hh" #include "base/loader/ecoff_object.hh" #include "base/loader/object_file.hh" #include "base/loader/symtab.hh" +#include "base/remote_gdb.hh" +#include "base/trace.hh" #include "cpu/exec_context.hh" #include "kern/tru64/tru64_events.hh" #include "kern/tru64/tru64_system.hh" #include "mem/functional_mem/memory_control.hh" #include "mem/functional_mem/physical_memory.hh" +#include "sim/builder.hh" #include "targetarch/isa_traits.hh" #include "targetarch/vtophys.hh" diff --git a/sim/builder.cc b/sim/builder.cc new file mode 100644 index 000000000..fa435d322 --- /dev/null +++ b/sim/builder.cc @@ -0,0 +1,191 @@ +/* + * Copyright (c) 2003 The Regents of The University of Michigan + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer; + * redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution; + * neither the name of the copyright holders nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * 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. + */ + +#include <assert.h> + +#include "base/inifile.hh" +#include "base/misc.hh" +#include "sim/builder.hh" +#include "sim/configfile.hh" +#include "sim/host.hh" +#include "sim/sim_object.hh" +#include "sim/sim_stats.hh" + +using namespace std; + +/////////////////////////////////////////// +// +// SimObjectBuilder member definitions +// +/////////////////////////////////////////// + +// override ParamContext::parseParams() to check params based on +// instance name first. If not found, then check based on iniSection +// (as in default ParamContext implementation). +void +SimObjectBuilder::parseParams(IniFile &iniFile) +{ + iniFilePtr = &iniFile; // set object member + + ParamList::iterator i; + + for (i = paramList->begin(); i != paramList->end(); ++i) { + string string_value; + + if (iniFile.findDefault(instanceName, (*i)->name, string_value)) { + (*i)->parse(string_value); + } + else if (iniFile.findDefault(iniSection, (*i)->name, string_value)) { + (*i)->parse(string_value); + } + } +} + + +void +SimObjectBuilder::printErrorProlog(ostream &os) +{ + os << "Error creating object '" << getInstanceName() + << "' of type '" << simObjClassName + << "', section '" << iniSection << "':" << endl; +} + + +//////////////////////////////////////////////////////////////////////// +// +// SimObjectClass member definitions +// +//////////////////////////////////////////////////////////////////////// + +// Map of class names to SimObjectBuilder creation functions. Need to +// make this a pointer so we can force initialization on the first +// reference; otherwise, some SimObjectClass constructors may be invoked +// before the classMap constructor. +map<string,SimObjectClass::CreateFunc> *SimObjectClass::classMap = NULL; + +// SimObjectClass constructor: add mapping to classMap +SimObjectClass::SimObjectClass(const string &className, CreateFunc createFunc) +{ + if (classMap == NULL) + classMap = new map<string,SimObjectClass::CreateFunc>(); + + if ((*classMap)[className]) + { + cerr << "Error: simulation object class " << className << " redefined" + << endl; + fatal(""); + } + + // add className --> createFunc to class map + (*classMap)[className] = createFunc; +} + + +// +// +SimObject * +SimObjectClass::createObject(IniFile &configDB, + const string &configClassName, + const string &objName, + ConfigNode *configNode) +{ + // find simulation object class name from configuration class + // (specified by 'type=' parameter) + string simObjClassName; + + if (!configDB.findDefault(configClassName, "type", simObjClassName)) { + cerr << "Configuration class '" << configClassName << "' not found." + << endl; + abort(); + } + + // look up className to get appropriate createFunc + if (classMap->find(simObjClassName) == classMap->end()) { + cerr << "Simulator object class '" << simObjClassName << "' not found." + << endl; + abort(); + } + + CreateFunc createFunc = (*classMap)[simObjClassName]; + + // call createFunc with config hierarchy node to get object + // builder instance (context with parameters for object creation) + SimObjectBuilder *objectBuilder = (*createFunc)(configClassName, + objName, configNode, + simObjClassName); + + assert(objectBuilder != NULL); + + // parse all parameters in context to generate parameter values + objectBuilder->parseParams(configDB); + + // now create the actual simulation object + SimObject *object = objectBuilder->create(); + + assert(object != NULL); + + // echo object parameters to stats file (for documenting the + // config used to generate the associated stats) + *statStream << "[" << object->name() << "]" << endl; + *statStream << "type=" << simObjClassName << endl; + objectBuilder->showParams(*statStream); + *statStream << endl; + + // done with the SimObjectBuilder now + delete objectBuilder; + + return object; +} + + +// +// static method: +// +void +SimObjectClass::describeAllClasses(ostream &os) +{ + map<string,CreateFunc>::iterator iter; + + for (iter = classMap->begin(); iter != classMap->end(); ++iter) { + const string &className = iter->first; + CreateFunc createFunc = iter->second; + + os << "[" << className << "]\n"; + + // create dummy object builder just to instantiate parameters + SimObjectBuilder *objectBuilder = (*createFunc)("", "", NULL, ""); + + // now get the object builder to describe ite params + objectBuilder->describeParams(os); + + os << endl; + + // done with the object builder now + delete objectBuilder; + } +} diff --git a/sim/builder.hh b/sim/builder.hh new file mode 100644 index 000000000..0364276bf --- /dev/null +++ b/sim/builder.hh @@ -0,0 +1,221 @@ +/* + * Copyright (c) 2003 The Regents of The University of Michigan + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer; + * redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution; + * neither the name of the copyright holders nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * 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. + */ + +#ifndef __BUILDER_HH__ +#define __BUILDER_HH__ + +#include <map> +#include <list> +#include <vector> +#include <iostream> + +#include "sim/param.hh" + +class SimObject; + +// +// A SimObjectBuilder serves as an evaluation context for a set of +// parameters that describe a specific instance of a SimObject. This +// evaluation context corresponds to a section in the .ini file (as +// with the base ParamContext) plus an optional node in the +// configuration hierarchy (the configNode member) for resolving +// SimObject references. SimObjectBuilder is an abstract superclass; +// derived classes specialize the class for particular subclasses of +// SimObject (e.g., BaseCache). +// +// For typical usage, see the definition of +// SimObjectClass::createObject(). +// +class SimObjectBuilder : public ParamContext +{ + private: + // name of the instance we are creating + std::string instanceName; + + // The corresponding node in the configuration hierarchy. + // (optional: may be null if the created object is not in the + // hierarchy) + ConfigNode *configNode; + + // The external SimObject class name (for error messages) + std::string simObjClassName; + + public: + SimObjectBuilder(const std::string &_configClass, + const std::string &_instanceName, + ConfigNode *_configNode, + const std::string &_simObjClassName) + : ParamContext(_configClass, true), + instanceName(_instanceName), + configNode(_configNode), + simObjClassName(_simObjClassName) + { + } + + virtual ~SimObjectBuilder() {} + + // call parse() on all params in this context to convert string + // representations to parameter values + virtual void parseParams(IniFile &iniFile); + + // parameter error prolog (override of ParamContext) + virtual void printErrorProlog(std::ostream &); + + // generate the name for this SimObject instance (derived from the + // configuration hierarchy node label and position) + virtual const std::string &getInstanceName() { return instanceName; } + + // return the configuration hierarchy node for this context. + virtual ConfigNode *getConfigNode() { return configNode; } + + // Create the actual SimObject corresponding to the parameter + // values in this context. This function is overridden in derived + // classes to call a specific constructor for a particular + // subclass of SimObject. + virtual SimObject *create() = 0; +}; + + +// +// Handy macros for initializing parameter members of classes derived +// from SimObjectBuilder. Assumes that the name of the parameter +// member object is the same as the textual parameter name seen by the +// user. (Note that '#p' is expanded by the preprocessor to '"p"'.) +// +#define INIT_PARAM(p, desc) p(this, #p, desc) +#define INIT_PARAM_DFLT(p, desc, dflt) p(this, #p, desc, dflt) + +// +// Initialize an enumeration variable... assumes that 'map' is the +// name of an array of mappings (char * for SimpleEnumParam, or +// EnumParamMap for MappedEnumParam). +// +#define INIT_ENUM_PARAM(p, desc, map) \ + p(this, #p, desc, map, sizeof(map)/sizeof(map[0])) +#define INIT_ENUM_PARAM_DFLT(p, desc, map, dflt) \ + p(this, #p, desc, map, sizeof(map)/sizeof(map[0]), dflt) + +// +// An instance of SimObjectClass corresponds to a class derived from +// SimObject. The SimObjectClass instance serves to bind the string +// name (found in the config file) to a function that creates an +// instance of the appropriate derived class. +// +// This would be much cleaner in Smalltalk or Objective-C, where types +// are first-class objects themselves. +// +class SimObjectClass +{ + public: + // Type CreateFunc is a pointer to a function that creates a new + // simulation object builder based on a .ini-file parameter + // section (specified by the first string argument), a unique name + // for the object (specified by the second string argument), and + // an optional config hierarchy node (specified by the third + // argument). A pointer to the new SimObjectBuilder is returned. + typedef SimObjectBuilder *(*CreateFunc)(const std::string &configClassName, + const std::string &objName, + ConfigNode *configNode, + const std::string &simObjClassName); + + static std::map<std::string,CreateFunc> *classMap; + + // Constructor. For example: + // + // SimObjectClass baseCacheClass("BaseCache", newBaseCacheBuilder); + // + SimObjectClass(const std::string &className, CreateFunc createFunc); + + // create SimObject given name of class and pointer to + // configuration hierarchy node + static SimObject *createObject(IniFile &configDB, + const std::string &configClassName, + const std::string &objName, + ConfigNode *configNode); + + // print descriptions of all parameters registered with all + // SimObject classes + static void describeAllClasses(std::ostream &os); +}; + +// +// Macros to encapsulate the magic of declaring & defining +// SimObjectBuilder and SimObjectClass objects +// + +#define BEGIN_DECLARE_SIM_OBJECT_PARAMS(OBJ_CLASS) \ +class OBJ_CLASS##Builder : public SimObjectBuilder \ +{ \ + public: + +#define END_DECLARE_SIM_OBJECT_PARAMS(OBJ_CLASS) \ + \ + OBJ_CLASS##Builder(const std::string &configClass, \ + const std::string &instanceName, \ + ConfigNode *configNode, \ + const std::string &simObjClassName); \ + virtual ~OBJ_CLASS##Builder() {} \ + \ + OBJ_CLASS *create(); \ +}; + +#define BEGIN_INIT_SIM_OBJECT_PARAMS(OBJ_CLASS) \ +OBJ_CLASS##Builder::OBJ_CLASS##Builder(const std::string &configClass, \ + const std::string &instanceName, \ + ConfigNode *configNode, \ + const std::string &simObjClassName) \ + : SimObjectBuilder(configClass, instanceName, \ + configNode, simObjClassName), + + +#define END_INIT_SIM_OBJECT_PARAMS(OBJ_CLASS) \ +{ \ +} + +#define CREATE_SIM_OBJECT(OBJ_CLASS) \ +OBJ_CLASS *OBJ_CLASS##Builder::create() + +#define REGISTER_SIM_OBJECT(CLASS_NAME, OBJ_CLASS) \ +SimObjectBuilder * \ +new##OBJ_CLASS##Builder(const std::string &configClass, \ + const std::string &instanceName, \ + ConfigNode *configNode, \ + const std::string &simObjClassName) \ +{ \ + return new OBJ_CLASS##Builder(configClass, instanceName, \ + configNode, simObjClassName); \ +} \ + \ +SimObjectClass the##OBJ_CLASS##Class(CLASS_NAME, \ + new##OBJ_CLASS##Builder); \ + \ +/* see param.hh */ \ +DEFINE_SIM_OBJECT_CLASS_NAME(CLASS_NAME, OBJ_CLASS) + + +#endif // __BUILDER_HH__ diff --git a/sim/main.cc b/sim/main.cc index ae4b5af77..ce9ef5819 100644 --- a/sim/main.cc +++ b/sim/main.cc @@ -37,23 +37,22 @@ #include <string> #include <vector> -#include "sim/host.hh" -#include "base/misc.hh" - #include "base/copyright.hh" #include "base/inifile.hh" -#include "sim/configfile.hh" +#include "base/misc.hh" #include "base/pollevent.hh" #include "base/statistics.hh" +#include "cpu/base_cpu.hh" +#include "cpu/full_cpu/smt.hh" +#include "sim/async.hh" +#include "sim/builder.hh" +#include "sim/configfile.hh" +#include "sim/host.hh" #include "sim/sim_events.hh" #include "sim/sim_exit.hh" #include "sim/sim_object.hh" #include "sim/sim_stats.hh" #include "sim/sim_time.hh" -#include "cpu/full_cpu/smt.hh" - -#include "cpu/base_cpu.hh" -#include "sim/async.hh" using namespace std; diff --git a/sim/prog.cc b/sim/prog.cc index c52d51f63..275e1551b 100644 --- a/sim/prog.cc +++ b/sim/prog.cc @@ -28,22 +28,21 @@ #include <unistd.h> #include <fcntl.h> -#include <stdio.h> +#include <cstdio> #include <string> -#include "mem/functional_mem/main_memory.hh" -#include "sim/prog.hh" - -#include "eio/eio.hh" #include "base/intmath.hh" -#include "cpu/full_cpu/thread.hh" -#include "sim/fake_syscall.hh" #include "base/loader/object_file.hh" +#include "base/statistics.hh" #include "cpu/exec_context.hh" #include "cpu/full_cpu/smt.hh" - -#include "base/statistics.hh" +#include "cpu/full_cpu/thread.hh" +#include "eio/eio.hh" +#include "mem/functional_mem/main_memory.hh" +#include "sim/builder.hh" +#include "sim/fake_syscall.hh" +#include "sim/prog.hh" #include "sim/sim_stats.hh" using namespace std; diff --git a/sim/sim_object.cc b/sim/sim_object.cc index 955c43bb8..1ddb15c82 100644 --- a/sim/sim_object.cc +++ b/sim/sim_object.cc @@ -121,155 +121,3 @@ SimObject::printAllExtraOutput(ostream &os) (*i)->printExtraOutput(os); } } - -/////////////////////////////////////////// -// -// SimObjectBuilder member definitions -// -/////////////////////////////////////////// - -// override ParamContext::parseParams() to check params based on -// instance name first. If not found, then check based on iniSection -// (as in default ParamContext implementation). -void -SimObjectBuilder::parseParams(IniFile &iniFile) -{ - iniFilePtr = &iniFile; // set object member - - ParamList::iterator i; - - for (i = paramList->begin(); i != paramList->end(); ++i) { - string string_value; - - if (iniFile.findDefault(instanceName, (*i)->name, string_value)) { - (*i)->parse(string_value); - } - else if (iniFile.findDefault(iniSection, (*i)->name, string_value)) { - (*i)->parse(string_value); - } - } -} - - -void -SimObjectBuilder::printErrorProlog(ostream &os) -{ - os << "Error creating object '" << getInstanceName() - << "' of type '" << simObjClassName - << "', section '" << iniSection << "':" << endl; -} - - -//////////////////////////////////////////////////////////////////////// -// -// SimObjectClass member definitions -// -//////////////////////////////////////////////////////////////////////// - -// Map of class names to SimObjectBuilder creation functions. Need to -// make this a pointer so we can force initialization on the first -// reference; otherwise, some SimObjectClass constructors may be invoked -// before the classMap constructor. -map<string,SimObjectClass::CreateFunc> *SimObjectClass::classMap = NULL; - -// SimObjectClass constructor: add mapping to classMap -SimObjectClass::SimObjectClass(const string &className, CreateFunc createFunc) -{ - if (classMap == NULL) - classMap = new map<string,SimObjectClass::CreateFunc>(); - - if ((*classMap)[className]) - { - cerr << "Error: simulation object class " << className << " redefined" - << endl; - fatal(""); - } - - // add className --> createFunc to class map - (*classMap)[className] = createFunc; -} - - -// -// -SimObject * -SimObjectClass::createObject(IniFile &configDB, - const string &configClassName, - const string &objName, - ConfigNode *configNode) -{ - // find simulation object class name from configuration class - // (specified by 'type=' parameter) - string simObjClassName; - - if (!configDB.findDefault(configClassName, "type", simObjClassName)) { - cerr << "Configuration class '" << configClassName << "' not found." - << endl; - abort(); - } - - // look up className to get appropriate createFunc - if (classMap->find(simObjClassName) == classMap->end()) { - cerr << "Simulator object class '" << simObjClassName << "' not found." - << endl; - abort(); - } - - CreateFunc createFunc = (*classMap)[simObjClassName]; - - // call createFunc with config hierarchy node to get object - // builder instance (context with parameters for object creation) - SimObjectBuilder *objectBuilder = (*createFunc)(configClassName, - objName, configNode, - simObjClassName); - - assert(objectBuilder != NULL); - - // parse all parameters in context to generate parameter values - objectBuilder->parseParams(configDB); - - // now create the actual simulation object - SimObject *object = objectBuilder->create(); - - assert(object != NULL); - - // echo object parameters to stats file (for documenting the - // config used to generate the associated stats) - *statStream << "[" << object->name() << "]" << endl; - *statStream << "type=" << simObjClassName << endl; - objectBuilder->showParams(*statStream); - *statStream << endl; - - // done with the SimObjectBuilder now - delete objectBuilder; - - return object; -} - - -// -// static method: -// -void -SimObjectClass::describeAllClasses(ostream &os) -{ - map<string,CreateFunc>::iterator iter; - - for (iter = classMap->begin(); iter != classMap->end(); ++iter) { - const string &className = iter->first; - CreateFunc createFunc = iter->second; - - os << "[" << className << "]\n"; - - // create dummy object builder just to instantiate parameters - SimObjectBuilder *objectBuilder = (*createFunc)("", "", NULL, ""); - - // now get the object builder to describe ite params - objectBuilder->describeParams(os); - - os << endl; - - // done with the object builder now - delete objectBuilder; - } -} diff --git a/sim/sim_object.hh b/sim/sim_object.hh index 7f71d1852..6c15fc88f 100644 --- a/sim/sim_object.hh +++ b/sim/sim_object.hh @@ -76,185 +76,4 @@ class SimObject : public Serializeable static void printAllExtraOutput(std::ostream&); }; - -// -// A SimObjectBuilder serves as an evaluation context for a set of -// parameters that describe a specific instance of a SimObject. This -// evaluation context corresponds to a section in the .ini file (as -// with the base ParamContext) plus an optional node in the -// configuration hierarchy (the configNode member) for resolving -// SimObject references. SimObjectBuilder is an abstract superclass; -// derived classes specialize the class for particular subclasses of -// SimObject (e.g., BaseCache). -// -// For typical usage, see the definition of -// SimObjectClass::createObject(). -// -class SimObjectBuilder : public ParamContext -{ - private: - // name of the instance we are creating - std::string instanceName; - - // The corresponding node in the configuration hierarchy. - // (optional: may be null if the created object is not in the - // hierarchy) - ConfigNode *configNode; - - // The external SimObject class name (for error messages) - std::string simObjClassName; - - public: - SimObjectBuilder(const std::string &_configClass, - const std::string &_instanceName, - ConfigNode *_configNode, - const std::string &_simObjClassName) - : ParamContext(_configClass, true), - instanceName(_instanceName), - configNode(_configNode), - simObjClassName(_simObjClassName) - { - } - - virtual ~SimObjectBuilder() {} - - // call parse() on all params in this context to convert string - // representations to parameter values - virtual void parseParams(IniFile &iniFile); - - // parameter error prolog (override of ParamContext) - virtual void printErrorProlog(std::ostream &); - - // generate the name for this SimObject instance (derived from the - // configuration hierarchy node label and position) - virtual const std::string &getInstanceName() { return instanceName; } - - // return the configuration hierarchy node for this context. - virtual ConfigNode *getConfigNode() { return configNode; } - - // Create the actual SimObject corresponding to the parameter - // values in this context. This function is overridden in derived - // classes to call a specific constructor for a particular - // subclass of SimObject. - virtual SimObject *create() = 0; -}; - - -// -// Handy macros for initializing parameter members of classes derived -// from SimObjectBuilder. Assumes that the name of the parameter -// member object is the same as the textual parameter name seen by the -// user. (Note that '#p' is expanded by the preprocessor to '"p"'.) -// -#define INIT_PARAM(p, desc) p(this, #p, desc) -#define INIT_PARAM_DFLT(p, desc, dflt) p(this, #p, desc, dflt) - -// -// Initialize an enumeration variable... assumes that 'map' is the -// name of an array of mappings (char * for SimpleEnumParam, or -// EnumParamMap for MappedEnumParam). -// -#define INIT_ENUM_PARAM(p, desc, map) \ - p(this, #p, desc, map, sizeof(map)/sizeof(map[0])) -#define INIT_ENUM_PARAM_DFLT(p, desc, map, dflt) \ - p(this, #p, desc, map, sizeof(map)/sizeof(map[0]), dflt) - -// -// An instance of SimObjectClass corresponds to a class derived from -// SimObject. The SimObjectClass instance serves to bind the string -// name (found in the config file) to a function that creates an -// instance of the appropriate derived class. -// -// This would be much cleaner in Smalltalk or Objective-C, where types -// are first-class objects themselves. -// -class SimObjectClass -{ - public: - // Type CreateFunc is a pointer to a function that creates a new - // simulation object builder based on a .ini-file parameter - // section (specified by the first string argument), a unique name - // for the object (specified by the second string argument), and - // an optional config hierarchy node (specified by the third - // argument). A pointer to the new SimObjectBuilder is returned. - typedef SimObjectBuilder *(*CreateFunc)(const std::string &configClassName, - const std::string &objName, - ConfigNode *configNode, - const std::string &simObjClassName); - - static std::map<std::string,CreateFunc> *classMap; - - // Constructor. For example: - // - // SimObjectClass baseCacheClass("BaseCache", newBaseCacheBuilder); - // - SimObjectClass(const std::string &className, CreateFunc createFunc); - - // create SimObject given name of class and pointer to - // configuration hierarchy node - static SimObject *createObject(IniFile &configDB, - const std::string &configClassName, - const std::string &objName, - ConfigNode *configNode); - - // print descriptions of all parameters registered with all - // SimObject classes - static void describeAllClasses(std::ostream &os); -}; - -// -// Macros to encapsulate the magic of declaring & defining -// SimObjectBuilder and SimObjectClass objects -// - -#define BEGIN_DECLARE_SIM_OBJECT_PARAMS(OBJ_CLASS) \ -class OBJ_CLASS##Builder : public SimObjectBuilder \ -{ \ - public: - -#define END_DECLARE_SIM_OBJECT_PARAMS(OBJ_CLASS) \ - \ - OBJ_CLASS##Builder(const std::string &configClass, \ - const std::string &instanceName, \ - ConfigNode *configNode, \ - const std::string &simObjClassName); \ - virtual ~OBJ_CLASS##Builder() {} \ - \ - OBJ_CLASS *create(); \ -}; - -#define BEGIN_INIT_SIM_OBJECT_PARAMS(OBJ_CLASS) \ -OBJ_CLASS##Builder::OBJ_CLASS##Builder(const std::string &configClass, \ - const std::string &instanceName, \ - ConfigNode *configNode, \ - const std::string &simObjClassName) \ - : SimObjectBuilder(configClass, instanceName, \ - configNode, simObjClassName), - - -#define END_INIT_SIM_OBJECT_PARAMS(OBJ_CLASS) \ -{ \ -} - -#define CREATE_SIM_OBJECT(OBJ_CLASS) \ -OBJ_CLASS *OBJ_CLASS##Builder::create() - -#define REGISTER_SIM_OBJECT(CLASS_NAME, OBJ_CLASS) \ -SimObjectBuilder * \ -new##OBJ_CLASS##Builder(const std::string &configClass, \ - const std::string &instanceName, \ - ConfigNode *configNode, \ - const std::string &simObjClassName) \ -{ \ - return new OBJ_CLASS##Builder(configClass, instanceName, \ - configNode, simObjClassName); \ -} \ - \ -SimObjectClass the##OBJ_CLASS##Class(CLASS_NAME, \ - new##OBJ_CLASS##Builder); \ - \ -/* see param.hh */ \ -DEFINE_SIM_OBJECT_CLASS_NAME(CLASS_NAME, OBJ_CLASS) - - #endif // __SIM_OBJECT_HH__ |