sim/serialize.hh

   1 /*
   2  * Copyright (c) 2002-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   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.
  15  *
  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.
  27  */
  28
  29 /* @file
  30  * Serialization Interface Declarations
  31  */
  32
  33 #ifndef __SERIALIZE_HH__
  34 #define __SERIALIZE_HH__
  35
  36
  37 #include <list>
  38 #include <iostream>
  39 #include <map>
  40
  41 #include "sim/host.hh"
  42 #include "sim/configfile.hh"
  43
  44 class Serializable;
  45 class Checkpoint;
  46
  47 template <class T>
  48 void paramOut(std::ostream &os, const std::string &name, const T &param);
  49
  50 template <class T>
  51 void paramIn(Checkpoint *cp, const std::string &section,
  52              const std::string &name, T &param);
  53
  54 template <class T>
  55 void arrayParamOut(std::ostream &os, const std::string &name,
  56                    const T *param, int size);
  57
  58 template <class T>
  59 void arrayParamIn(Checkpoint *cp, const std::string &section,
  60                   const std::string &name, T *param, int size);
  61
  62 void
  63 objParamIn(Checkpoint *cp, const std::string &section,
  64            const std::string &name, Serializable * &param);
  65
  66
  67 //
  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)
  72
  73 #define UNSERIALIZE_SCALAR(scalar)      paramIn(cp, section, #scalar, scalar)
  74
  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)
  77
  78 #define UNSERIALIZE_ENUM(scalar)                \
  79  do {                                           \
  80     int tmp;                                    \
  81     paramIn(cp, section, #scalar, tmp);         \
  82     scalar = (typeof(scalar))tmp;               \
  83   } while (0)
  84
  85 #define SERIALIZE_ARRAY(member, size)   \
  86         arrayParamOut(os, #member, member, size)
  87
  88 #define UNSERIALIZE_ARRAY(member, size) \
  89         arrayParamIn(cp, section, #member, member, size)
  90
  91 #define SERIALIZE_OBJPTR(objptr)        paramOut(os, #objptr, (objptr)->name())
  92
  93 #define UNSERIALIZE_OBJPTR(objptr)                      \
  94   do {                                                  \
  95     Serializable *sptr;                         \
  96     objParamIn(cp, section, #objptr, sptr);             \
  97     objptr = dynamic_cast<typeof(objptr)>(sptr);        \
  98   } while (0)
  99
 100 /*
 101  * Basic support for object serialization.
 102  */
 103 class Serializable
 104 {
 105   protected:
 106     void nameOut(std::ostream &os);
 107     void nameOut(std::ostream &os, const std::string &_name);
 108
 109   public:
 110     Serializable() {}
 111     virtual ~Serializable() {}
 112
 113     // manditory virtual function, so objects must provide names
 114     virtual const std::string name() const = 0;
 115
 116     virtual void serialize(std::ostream &os) {}
 117     virtual void unserialize(Checkpoint *cp, const std::string &section) {}
 118
 119     static Serializable *create(Checkpoint *cp,
 120                                  const std::string &section);
 121
 122     static int count;
 123     static int maxCount;
 124     static void serializeAll();
 125     static void unserializeGlobals(Checkpoint *cp);
 126 };
 127
 128 //
 129 // A SerializableBuilder serves as an evaluation context for a set of
 130 // parameters that describe a specific instance of a Serializable.  This
 131 // evaluation context corresponds to a section in the .ini file (as
 132 // with the base ParamContext) plus an optional node in the
 133 // configuration hierarchy (the configNode member) for resolving
 134 // Serializable references.  SerializableBuilder is an abstract superclass;
 135 // derived classes specialize the class for particular subclasses of
 136 // Serializable (e.g., BaseCache).
 137 //
 138 // For typical usage, see the definition of
 139 // SerializableClass::createObject().
 140 //
 141 class SerializableBuilder
 142 {
 143   public:
 144
 145     SerializableBuilder() {}
 146
 147     virtual ~SerializableBuilder() {}
 148
 149     // Create the actual Serializable corresponding to the parameter
 150     // values in this context.  This function is overridden in derived
 151     // classes to call a specific constructor for a particular
 152     // subclass of Serializable.
 153     virtual Serializable *create() = 0;
 154 };
 155
 156 //
 157 // An instance of SerializableClass corresponds to a class derived from
 158 // Serializable.  The SerializableClass instance serves to bind the string
 159 // name (found in the config file) to a function that creates an
 160 // instance of the appropriate derived class.
 161 //
 162 // This would be much cleaner in Smalltalk or Objective-C, where types
 163 // are first-class objects themselves.
 164 //
 165 class SerializableClass
 166 {
 167   public:
 168
 169     // Type CreateFunc is a pointer to a function that creates a new
 170     // simulation object builder based on a .ini-file parameter
 171     // section (specified by the first string argument), a unique name
 172     // for the object (specified by the second string argument), and
 173     // an optional config hierarchy node (specified by the third
 174     // argument).  A pointer to the new SerializableBuilder is returned.
 175     typedef Serializable *(*CreateFunc)(Checkpoint *cp,
 176                                          const std::string &section);
 177
 178     static std::map<std::string,CreateFunc> *classMap;
 179
 180     // Constructor.  For example:
 181     //
 182     // SerializableClass baseCacheSerializableClass("BaseCacheSerializable",
 183     //                         newBaseCacheSerializableBuilder);
 184     //
 185     SerializableClass(const std::string &className, CreateFunc createFunc);
 186
 187     // create Serializable given name of class and pointer to
 188     // configuration hierarchy node
 189     static Serializable *createObject(Checkpoint *cp,
 190                                        const std::string &section);
 191 };
 192
 193 //
 194 // Macros to encapsulate the magic of declaring & defining
 195 // SerializableBuilder and SerializableClass objects
 196 //
 197
 198 #define REGISTER_SERIALIZEABLE(CLASS_NAME, OBJ_CLASS)                      \
 199 SerializableClass the##OBJ_CLASS##Class(CLASS_NAME,                        \
 200                                          OBJ_CLASS::createForUnserialize);
 201
 202 class Checkpoint
 203 {
 204   private:
 205
 206     IniFile *db;
 207     const std::string basePath;
 208     const ConfigNode *configNode;
 209     std::map<std::string, Serializable*> objMap;
 210
 211   public:
 212     Checkpoint(const std::string &cpt_dir, const std::string &path,
 213                const ConfigNode *_configNode);
 214
 215     const std::string cptDir;
 216
 217     bool find(const std::string &section, const std::string &entry,
 218               std::string &value);
 219
 220     bool findObj(const std::string &section, const std::string &entry,
 221                  Serializable *&value);
 222
 223     bool sectionExists(const std::string &section);
 224
 225     // The following static functions have to do with checkpoint
 226     // creation rather than restoration.  This class makes a handy
 227     // namespace for them though.
 228
 229     // Export current checkpoint directory name so other objects can
 230     // derive filenames from it (e.g., memory).  The return value is
 231     // guaranteed to end in '/' so filenames can be directly appended.
 232     // This function is only valid while a checkpoint is being created.
 233     static std::string dir();
 234
 235     // Filename for base checkpoint file within directory.
 236     static const char *baseFilename;
 237
 238     // Set up a checkpoint creation event or series of events.
 239     static void setup(Tick when, Tick period = 0);
 240 };
 241
 242 #endif // __SERIALIZE_HH__