2 * Copyright (c) 2003 The Regents of The University of Michigan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 * Serialization Interface Declarations
33 #ifndef __SERIALIZE_HH__
34 #define __SERIALIZE_HH__
41 #include "sim/host.hh"
42 #include "sim/configfile.hh"
48 void paramOut(std::ostream &os, const std::string &name, const T ¶m);
51 void paramIn(Checkpoint *cp, const std::string §ion,
52 const std::string &name, T ¶m);
55 void arrayParamOut(std::ostream &os, const std::string &name,
56 const T *param, int size);
59 void arrayParamIn(Checkpoint *cp, const std::string §ion,
60 const std::string &name, T *param, int size);
63 objParamIn(Checkpoint *cp, const std::string §ion,
64 const std::string &name, Serializable * ¶m);
68 // These macros are streamlined to use in serialize/unserialize
69 // functions. It's assumed that serialize() has a parameter 'os' for
70 // the ostream, and unserialize() has parameters 'cp' and 'section'.
71 #define SERIALIZE_SCALAR(scalar) paramOut(os, #scalar, scalar)
73 #define UNSERIALIZE_SCALAR(scalar) paramIn(cp, section, #scalar, scalar)
75 // ENUMs are like SCALARs, but we cast them to ints on the way out
76 #define SERIALIZE_ENUM(scalar) paramOut(os, #scalar, (int)scalar)
78 #define UNSERIALIZE_ENUM(scalar) \
81 paramIn(cp, section, #scalar, tmp); \
82 scalar = (typeof(scalar))tmp; \
85 #define SERIALIZE_ARRAY(member, size) \
86 arrayParamOut(os, #member, member, size)
88 #define UNSERIALIZE_ARRAY(member, size) \
89 arrayParamIn(cp, section, #member, member, size)
91 #define SERIALIZE_OBJPTR(objptr) paramOut(os, #objptr, (objptr)->name())
93 #define UNSERIALIZE_OBJPTR(objptr) \
96 objParamIn(cp, section, #objptr, sptr); \
97 objptr = dynamic_cast<typeof(objptr)>(sptr); \
101 * Basic support for object serialization.
106 void nameOut(std::ostream& os);
107 void nameOut(std::ostream& os, const std::string &_name);
111 virtual ~Serializable() {}
113 // manditory virtual function, so objects must provide names
114 virtual std::string name() const = 0;
116 virtual void serialize(std::ostream& os) {}
117 virtual void unserialize(Checkpoint *cp, const std::string §ion) {}
119 static Serializable *create(Checkpoint *cp,
120 const std::string §ion);
122 static void serializeAll();
123 static void unserializeGlobals(Checkpoint *cp);
127 // A SerializableBuilder serves as an evaluation context for a set of
128 // parameters that describe a specific instance of a Serializable. This
129 // evaluation context corresponds to a section in the .ini file (as
130 // with the base ParamContext) plus an optional node in the
131 // configuration hierarchy (the configNode member) for resolving
132 // Serializable references. SerializableBuilder is an abstract superclass;
133 // derived classes specialize the class for particular subclasses of
134 // Serializable (e.g., BaseCache).
136 // For typical usage, see the definition of
137 // SerializableClass::createObject().
139 class SerializableBuilder
143 SerializableBuilder() {}
145 virtual ~SerializableBuilder() {}
147 // Create the actual Serializable corresponding to the parameter
148 // values in this context. This function is overridden in derived
149 // classes to call a specific constructor for a particular
150 // subclass of Serializable.
151 virtual Serializable *create() = 0;
155 // An instance of SerializableClass corresponds to a class derived from
156 // Serializable. The SerializableClass instance serves to bind the string
157 // name (found in the config file) to a function that creates an
158 // instance of the appropriate derived class.
160 // This would be much cleaner in Smalltalk or Objective-C, where types
161 // are first-class objects themselves.
163 class SerializableClass
167 // Type CreateFunc is a pointer to a function that creates a new
168 // simulation object builder based on a .ini-file parameter
169 // section (specified by the first string argument), a unique name
170 // for the object (specified by the second string argument), and
171 // an optional config hierarchy node (specified by the third
172 // argument). A pointer to the new SerializableBuilder is returned.
173 typedef Serializable *(*CreateFunc)(Checkpoint *cp,
174 const std::string §ion);
176 static std::map<std::string,CreateFunc> *classMap;
178 // Constructor. For example:
180 // SerializableClass baseCacheSerializableClass("BaseCacheSerializable",
181 // newBaseCacheSerializableBuilder);
183 SerializableClass(const std::string &className, CreateFunc createFunc);
185 // create Serializable given name of class and pointer to
186 // configuration hierarchy node
187 static Serializable *createObject(Checkpoint *cp,
188 const std::string §ion);
192 // Macros to encapsulate the magic of declaring & defining
193 // SerializableBuilder and SerializableClass objects
196 #define REGISTER_SERIALIZEABLE(CLASS_NAME, OBJ_CLASS) \
197 SerializableClass the##OBJ_CLASS##Class(CLASS_NAME, \
198 OBJ_CLASS::createForUnserialize);
205 const std::string basePath;
206 const ConfigNode *configNode;
207 std::map<std::string, Serializable*> objMap;
210 Checkpoint(const std::string &cpt_dir, const std::string &path,
211 const ConfigNode *_configNode);
213 bool find(const std::string §ion, const std::string &entry,
216 bool findObj(const std::string §ion, const std::string &entry,
217 Serializable *&value);
219 bool sectionExists(const std::string §ion);
221 // The following static functions have to do with checkpoint
222 // creation rather than restoration. This class makes a handy
223 // namespace for them though.
225 // Export current checkpoint directory name so other objects can
226 // derive filenames from it (e.g., memory). The return value is
227 // guaranteed to end in '/' so filenames can be directly appended.
228 // This function is only valid while a checkpoint is being created.
229 static std::string dir();
231 // Filename for base checkpoint file within directory.
232 static const char *baseFilename;
234 // Set up a checkpoint creation event or series of events.
235 static void setup(Tick when, Tick period = 0);
238 #endif // __SERIALIZE_HH__