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