serialize.hh revision 7823:dac01f14f20f
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 * Authors: Nathan Binkert 29 * Erik Hallnor 30 * Steve Reinhardt 31 */ 32 33/* @file 34 * Serialization Interface Declarations 35 */ 36 37#ifndef __SERIALIZE_HH__ 38#define __SERIALIZE_HH__ 39 40 41#include <list> 42#include <vector> 43#include <iostream> 44#include <map> 45 46#include "base/types.hh" 47 48class IniFile; 49class Serializable; 50class Checkpoint; 51class SimObject; 52 53template <class T> 54void paramOut(std::ostream &os, const std::string &name, const T ¶m); 55 56template <class T> 57void paramIn(Checkpoint *cp, const std::string §ion, 58 const std::string &name, T ¶m); 59 60template <class T> 61bool optParamIn(Checkpoint *cp, const std::string §ion, 62 const std::string &name, T ¶m); 63 64template <class T> 65void arrayParamOut(std::ostream &os, const std::string &name, 66 const T *param, unsigned size); 67 68template <class T> 69void arrayParamOut(std::ostream &os, const std::string &name, 70 const std::vector<T> ¶m); 71 72template <class T> 73void arrayParamIn(Checkpoint *cp, const std::string §ion, 74 const std::string &name, T *param, unsigned size); 75 76template <class T> 77void arrayParamIn(Checkpoint *cp, const std::string §ion, 78 const std::string &name, std::vector<T> ¶m); 79 80void 81objParamIn(Checkpoint *cp, const std::string §ion, 82 const std::string &name, SimObject * ¶m); 83 84 85// 86// These macros are streamlined to use in serialize/unserialize 87// functions. It's assumed that serialize() has a parameter 'os' for 88// the ostream, and unserialize() has parameters 'cp' and 'section'. 89#define SERIALIZE_SCALAR(scalar) paramOut(os, #scalar, scalar) 90 91#define UNSERIALIZE_SCALAR(scalar) paramIn(cp, section, #scalar, scalar) 92#define UNSERIALIZE_OPT_SCALAR(scalar) optParamIn(cp, section, #scalar, scalar) 93 94// ENUMs are like SCALARs, but we cast them to ints on the way out 95#define SERIALIZE_ENUM(scalar) paramOut(os, #scalar, (int)scalar) 96 97#define UNSERIALIZE_ENUM(scalar) \ 98 do { \ 99 int tmp; \ 100 paramIn(cp, section, #scalar, tmp); \ 101 scalar = (typeof(scalar))tmp; \ 102 } while (0) 103 104#define SERIALIZE_ARRAY(member, size) \ 105 arrayParamOut(os, #member, member, size) 106 107#define UNSERIALIZE_ARRAY(member, size) \ 108 arrayParamIn(cp, section, #member, member, size) 109 110#define SERIALIZE_OBJPTR(objptr) paramOut(os, #objptr, (objptr)->name()) 111 112#define UNSERIALIZE_OBJPTR(objptr) \ 113 do { \ 114 SimObject *sptr; \ 115 objParamIn(cp, section, #objptr, sptr); \ 116 objptr = dynamic_cast<typeof(objptr)>(sptr); \ 117 } while (0) 118 119/* 120 * Basic support for object serialization. 121 */ 122class Serializable 123{ 124 protected: 125 void nameOut(std::ostream &os); 126 void nameOut(std::ostream &os, const std::string &_name); 127 128 public: 129 Serializable(); 130 virtual ~Serializable(); 131 132 // manditory virtual function, so objects must provide names 133 virtual const std::string name() const = 0; 134 135 virtual void serialize(std::ostream &os); 136 virtual void unserialize(Checkpoint *cp, const std::string §ion); 137 138 static Serializable *create(Checkpoint *cp, const std::string §ion); 139 140 static int ckptCount; 141 static int ckptMaxCount; 142 static int ckptPrevCount; 143 static void serializeAll(const std::string &cpt_dir); 144 static void unserializeGlobals(Checkpoint *cp); 145}; 146 147// 148// A SerializableBuilder serves as an evaluation context for a set of 149// parameters that describe a specific instance of a Serializable. This 150// evaluation context corresponds to a section in the .ini file (as 151// with the base ParamContext) plus an optional node in the 152// configuration hierarchy (the configNode member) for resolving 153// Serializable references. SerializableBuilder is an abstract superclass; 154// derived classes specialize the class for particular subclasses of 155// Serializable (e.g., BaseCache). 156// 157// For typical usage, see the definition of 158// SerializableClass::createObject(). 159// 160class SerializableBuilder 161{ 162 public: 163 164 SerializableBuilder() {} 165 166 virtual ~SerializableBuilder() {} 167 168 // Create the actual Serializable corresponding to the parameter 169 // values in this context. This function is overridden in derived 170 // classes to call a specific constructor for a particular 171 // subclass of Serializable. 172 virtual Serializable *create() = 0; 173}; 174 175// 176// An instance of SerializableClass corresponds to a class derived from 177// Serializable. The SerializableClass instance serves to bind the string 178// name (found in the config file) to a function that creates an 179// instance of the appropriate derived class. 180// 181// This would be much cleaner in Smalltalk or Objective-C, where types 182// are first-class objects themselves. 183// 184class SerializableClass 185{ 186 public: 187 188 // Type CreateFunc is a pointer to a function that creates a new 189 // simulation object builder based on a .ini-file parameter 190 // section (specified by the first string argument), a unique name 191 // for the object (specified by the second string argument), and 192 // an optional config hierarchy node (specified by the third 193 // argument). A pointer to the new SerializableBuilder is returned. 194 typedef Serializable *(*CreateFunc)(Checkpoint *cp, 195 const std::string §ion); 196 197 static std::map<std::string,CreateFunc> *classMap; 198 199 // Constructor. For example: 200 // 201 // SerializableClass baseCacheSerializableClass("BaseCacheSerializable", 202 // newBaseCacheSerializableBuilder); 203 // 204 SerializableClass(const std::string &className, CreateFunc createFunc); 205 206 // create Serializable given name of class and pointer to 207 // configuration hierarchy node 208 static Serializable *createObject(Checkpoint *cp, 209 const std::string §ion); 210}; 211 212// 213// Macros to encapsulate the magic of declaring & defining 214// SerializableBuilder and SerializableClass objects 215// 216 217#define REGISTER_SERIALIZEABLE(CLASS_NAME, OBJ_CLASS) \ 218SerializableClass the##OBJ_CLASS##Class(CLASS_NAME, \ 219 OBJ_CLASS::createForUnserialize); 220 221class Checkpoint 222{ 223 private: 224 225 IniFile *db; 226 227 public: 228 Checkpoint(const std::string &cpt_dir); 229 230 const std::string cptDir; 231 232 bool find(const std::string §ion, const std::string &entry, 233 std::string &value); 234 235 bool findObj(const std::string §ion, const std::string &entry, 236 SimObject *&value); 237 238 bool sectionExists(const std::string §ion); 239 240 // The following static functions have to do with checkpoint 241 // creation rather than restoration. This class makes a handy 242 // namespace for them though. Currently no Checkpoint object is 243 // created on serialization (only unserialization) so we track the 244 // directory name as a global. It would be nice to change this 245 // someday 246 247 private: 248 // current directory we're serializing into. 249 static std::string currentDirectory; 250 251 public: 252 // Set the current directory. This function takes care of 253 // inserting curTick() if there's a '%d' in the argument, and 254 // appends a '/' if necessary. The final name is returned. 255 static std::string setDir(const std::string &base_name); 256 257 // Export current checkpoint directory name so other objects can 258 // derive filenames from it (e.g., memory). The return value is 259 // guaranteed to end in '/' so filenames can be directly appended. 260 // This function is only valid while a checkpoint is being created. 261 static std::string dir(); 262 263 // Filename for base checkpoint file within directory. 264 static const char *baseFilename; 265}; 266 267#endif // __SERIALIZE_HH__ 268