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