wierd ini files. The ini files are still used as an intermediate step, but a sophisticated python library exists to help build them more easily. SConscript: add the new embedded file stuff remove all of the old object description junk base/inifile.cc: base/inifile.hh: get rid of findDefault and findAppend since they were the source of much evil. base/trace.cc: For now, if we don't have the dprintf_stream set up, dump to standard out. We probably want a command line option for this. dev/alpha_console.cc: PioDevice now takes a platform parameter. All PioDevices must have a pio_latency parameter. We stick a dummy parameter in here for now until we get rid of the builder stuff. dev/alpha_console.hh: don't need Platform anymore dev/baddev.cc: PioDevice now takes a platform parameter. All PioDevices must have a pio_latency parameter. We stick a dummy parameter in here for now until we get rid of the builder stuff. Same for the platform parameter, though we just pass the PioDevice a null parameter since it isn't used by this device and it's quicker. dev/baddev.hh: fix #include guards dev/etherlink.cc: rename parameters. dev/ethertap.cc: rename parameters dev/ide_ctrl.cc: All devices need an address even if it will get overwritten later. dev/ide_disk.cc: use an enum for the drive ID stuff. rename disk_delay -> delay Actually, I think that we should implement "cable select" and have the controller tell the drive what it is. dev/io_device.cc: dev/io_device.hh: All IO devices take a Platform * dev/ns_gige.cc: all devices need an io_bus. rename header_bus to io_bus We don't need stuff for the interrupt controller since it's all in the platform now. dev/ns_gige.hh: We don't need stuff for the interrupt controller now since it's all in the platform. dev/pciconfigall.cc: Pass a dummy NULL to the PioDevice for the platform since we don't need one. dev/pcidev.cc: Move a bunch of common functionality into the PciDev dev/platform.hh: remove unneeded code dev/tsunami.cc: remove unused param dev/tsunami_cchip.cc: pass platform pointer dev/tsunami_io.cc: dev/tsunami_pchip.cc: dev/uart.cc: pass platform variable dev/uart.hh: don't need to keep a platform pointer. it's in the base class kern/linux/linux_system.cc: kern/tru64/tru64_system.cc: rename some parameters sim/builder.cc: clean up builder code. use more parameters from the config node. all sections with a type= are now created, the old mechanisms no longer work sim/builder.hh: remove some extra variables since they are found in the ConfigNode sim/main.cc: add a quick hack command line argument -X to dump out the embedded files. (probably should be fixed up a little.) accept .mpy files printing to the streams has to happen after the hierarchy is built since we're moving away from param contexts sim/param.cc: add parsing support for ranges sim/process.cc: isValid isn't very useful anymore. interpret the names stdout, stderr, cout, cerr for the file descriptors sim/pyconfig/SConscript: Add Action handlers for creating an embedded python file and for creating an embedded C file. use these action handlers to embed all objects found in the objects tree into the binary along with the importer and the m5config stuff sim/pyconfig/m5config.py: Major changes to the original configuration file generator. These changes largely involve implementing copy-on-write like semantics for all of the SimObjects. Real documentation must be written. sim/universe.cc: Universe becomes a SimObject since we don't really have the notion of param contexts in the python code. --HG-- rename : sim/pyconfig/m5configbase.py => sim/pyconfig/m5config.py extra : convert_revision : c353453e5beb91c37f15755998fc0d8858c6829a
189 lines
7 KiB
C++
189 lines
7 KiB
C++
/*
|
|
* Copyright (c) 2003-2004 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 <iosfwd>
|
|
#include <list>
|
|
#include <map>
|
|
#include <vector>
|
|
|
|
#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:
|
|
// The corresponding node in the configuration hierarchy.
|
|
// (optional: may be null if the created object is not in the
|
|
// hierarchy)
|
|
ConfigNode *configNode;
|
|
|
|
public:
|
|
SimObjectBuilder(ConfigNode *_configNode);
|
|
|
|
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 iniSection; }
|
|
|
|
// 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)(ConfigNode *configNode);
|
|
|
|
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, 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(ConfigNode *configNode); \
|
|
virtual ~OBJ_CLASS##Builder() {} \
|
|
\
|
|
OBJ_CLASS *create(); \
|
|
};
|
|
|
|
#define BEGIN_INIT_SIM_OBJECT_PARAMS(OBJ_CLASS) \
|
|
OBJ_CLASS##Builder::OBJ_CLASS##Builder(ConfigNode *configNode) \
|
|
: SimObjectBuilder(configNode),
|
|
|
|
|
|
#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(ConfigNode *configNode) \
|
|
{ \
|
|
return new OBJ_CLASS##Builder(configNode); \
|
|
} \
|
|
\
|
|
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__
|