serialize.hh revision 4841
19241Sandreas.hansson@arm.com/* 29717Sandreas.hansson@arm.com * Copyright (c) 2002-2005 The Regents of The University of Michigan 39241Sandreas.hansson@arm.com * All rights reserved. 49241Sandreas.hansson@arm.com * 59241Sandreas.hansson@arm.com * Redistribution and use in source and binary forms, with or without 69241Sandreas.hansson@arm.com * modification, are permitted provided that the following conditions are 79241Sandreas.hansson@arm.com * met: redistributions of source code must retain the above copyright 89241Sandreas.hansson@arm.com * notice, this list of conditions and the following disclaimer; 99241Sandreas.hansson@arm.com * redistributions in binary form must reproduce the above copyright 109241Sandreas.hansson@arm.com * notice, this list of conditions and the following disclaimer in the 119241Sandreas.hansson@arm.com * documentation and/or other materials provided with the distribution; 129241Sandreas.hansson@arm.com * neither the name of the copyright holders nor the names of its 139241Sandreas.hansson@arm.com * contributors may be used to endorse or promote products derived from 149241Sandreas.hansson@arm.com * this software without specific prior written permission. 159241Sandreas.hansson@arm.com * 169241Sandreas.hansson@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 179241Sandreas.hansson@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 189241Sandreas.hansson@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 199241Sandreas.hansson@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 209241Sandreas.hansson@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 219241Sandreas.hansson@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 229241Sandreas.hansson@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 239241Sandreas.hansson@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 249241Sandreas.hansson@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 259241Sandreas.hansson@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 269241Sandreas.hansson@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 279241Sandreas.hansson@arm.com * 289241Sandreas.hansson@arm.com * Authors: Nathan Binkert 299241Sandreas.hansson@arm.com * Erik Hallnor 309241Sandreas.hansson@arm.com * Steve Reinhardt 319241Sandreas.hansson@arm.com */ 329241Sandreas.hansson@arm.com 339241Sandreas.hansson@arm.com/* @file 349241Sandreas.hansson@arm.com * Serialization Interface Declarations 359241Sandreas.hansson@arm.com */ 369241Sandreas.hansson@arm.com 379241Sandreas.hansson@arm.com#ifndef __SERIALIZE_HH__ 389241Sandreas.hansson@arm.com#define __SERIALIZE_HH__ 399241Sandreas.hansson@arm.com 409241Sandreas.hansson@arm.com 419241Sandreas.hansson@arm.com#include <list> 429241Sandreas.hansson@arm.com#include <vector> 439241Sandreas.hansson@arm.com#include <iostream> 449241Sandreas.hansson@arm.com#include <map> 459241Sandreas.hansson@arm.com 469241Sandreas.hansson@arm.com#include "sim/host.hh" 479241Sandreas.hansson@arm.com 489241Sandreas.hansson@arm.comclass IniFile; 499241Sandreas.hansson@arm.comclass Serializable; 509241Sandreas.hansson@arm.comclass Checkpoint; 519241Sandreas.hansson@arm.comclass SimObject; 529241Sandreas.hansson@arm.com 539241Sandreas.hansson@arm.comtemplate <class T> 549241Sandreas.hansson@arm.comvoid paramOut(std::ostream &os, const std::string &name, const T ¶m); 559241Sandreas.hansson@arm.com 569241Sandreas.hansson@arm.comtemplate <class T> 579718Sandreas.hansson@arm.comvoid paramIn(Checkpoint *cp, const std::string §ion, 589720Sandreas.hansson@arm.com const std::string &name, T ¶m); 599717Sandreas.hansson@arm.com 609719Sandreas.hansson@arm.comtemplate <class T> 619241Sandreas.hansson@arm.comvoid arrayParamOut(std::ostream &os, const std::string &name, 629719Sandreas.hansson@arm.com const T *param, int size); 639719Sandreas.hansson@arm.com 649719Sandreas.hansson@arm.comtemplate <class T> 659719Sandreas.hansson@arm.comvoid arrayParamOut(std::ostream &os, const std::string &name, 669241Sandreas.hansson@arm.com const std::vector<T> ¶m); 679241Sandreas.hansson@arm.com 689241Sandreas.hansson@arm.comtemplate <class T> 699241Sandreas.hansson@arm.comvoid arrayParamIn(Checkpoint *cp, const std::string §ion, 709241Sandreas.hansson@arm.com const std::string &name, T *param, int size); 719241Sandreas.hansson@arm.com 729241Sandreas.hansson@arm.comtemplate <class T> 739241Sandreas.hansson@arm.comvoid arrayParamIn(Checkpoint *cp, const std::string §ion, 749241Sandreas.hansson@arm.com const std::string &name, std::vector<T> ¶m); 759294Sandreas.hansson@arm.com 769294Sandreas.hansson@arm.comvoid 779241Sandreas.hansson@arm.comobjParamIn(Checkpoint *cp, const std::string §ion, 789241Sandreas.hansson@arm.com const std::string &name, SimObject * ¶m); 799241Sandreas.hansson@arm.com 809241Sandreas.hansson@arm.com 819241Sandreas.hansson@arm.com// 829241Sandreas.hansson@arm.com// These macros are streamlined to use in serialize/unserialize 839241Sandreas.hansson@arm.com// functions. It's assumed that serialize() has a parameter 'os' for 849241Sandreas.hansson@arm.com// the ostream, and unserialize() has parameters 'cp' and 'section'. 859241Sandreas.hansson@arm.com#define SERIALIZE_SCALAR(scalar) paramOut(os, #scalar, scalar) 869241Sandreas.hansson@arm.com 879241Sandreas.hansson@arm.com#define UNSERIALIZE_SCALAR(scalar) paramIn(cp, section, #scalar, scalar) 889241Sandreas.hansson@arm.com 899241Sandreas.hansson@arm.com// ENUMs are like SCALARs, but we cast them to ints on the way out 909241Sandreas.hansson@arm.com#define SERIALIZE_ENUM(scalar) paramOut(os, #scalar, (int)scalar) 919241Sandreas.hansson@arm.com 929524SAndreas.Sandberg@ARM.com#define UNSERIALIZE_ENUM(scalar) \ 939241Sandreas.hansson@arm.com do { \ 949241Sandreas.hansson@arm.com int tmp; \ 959718Sandreas.hansson@arm.com paramIn(cp, section, #scalar, tmp); \ 969718Sandreas.hansson@arm.com scalar = (typeof(scalar))tmp; \ 979241Sandreas.hansson@arm.com } while (0) 989717Sandreas.hansson@arm.com 999241Sandreas.hansson@arm.com#define SERIALIZE_ARRAY(member, size) \ 1009241Sandreas.hansson@arm.com arrayParamOut(os, #member, member, size) 1019241Sandreas.hansson@arm.com 1029241Sandreas.hansson@arm.com#define UNSERIALIZE_ARRAY(member, size) \ 1039241Sandreas.hansson@arm.com arrayParamIn(cp, section, #member, member, size) 1049241Sandreas.hansson@arm.com 1059241Sandreas.hansson@arm.com#define SERIALIZE_OBJPTR(objptr) paramOut(os, #objptr, (objptr)->name()) 1069241Sandreas.hansson@arm.com 1079241Sandreas.hansson@arm.com#define UNSERIALIZE_OBJPTR(objptr) \ 1089241Sandreas.hansson@arm.com do { \ 1099524SAndreas.Sandberg@ARM.com SimObject *sptr; \ 1109719Sandreas.hansson@arm.com objParamIn(cp, section, #objptr, sptr); \ 1119720Sandreas.hansson@arm.com objptr = dynamic_cast<typeof(objptr)>(sptr); \ 1129719Sandreas.hansson@arm.com } while (0) 1139241Sandreas.hansson@arm.com 1149241Sandreas.hansson@arm.com/* 1159241Sandreas.hansson@arm.com * Basic support for object serialization. 1169241Sandreas.hansson@arm.com */ 1179241Sandreas.hansson@arm.comclass Serializable 1189241Sandreas.hansson@arm.com{ 1199241Sandreas.hansson@arm.com protected: 1209342SAndreas.Sandberg@arm.com void nameOut(std::ostream &os); 1219241Sandreas.hansson@arm.com void nameOut(std::ostream &os, const std::string &_name); 12210051Srioshering@gmail.com 12310051Srioshering@gmail.com public: 12410051Srioshering@gmail.com Serializable() {} 12510051Srioshering@gmail.com virtual ~Serializable() {} 12610051Srioshering@gmail.com 1279719Sandreas.hansson@arm.com // manditory virtual function, so objects must provide names 1289719Sandreas.hansson@arm.com virtual const std::string name() const = 0; 1299719Sandreas.hansson@arm.com 1309719Sandreas.hansson@arm.com virtual void serialize(std::ostream &os) {} 1319719Sandreas.hansson@arm.com virtual void unserialize(Checkpoint *cp, const std::string §ion) {} 1329719Sandreas.hansson@arm.com 1339719Sandreas.hansson@arm.com static Serializable *create(Checkpoint *cp, 1349719Sandreas.hansson@arm.com const std::string §ion); 1359719Sandreas.hansson@arm.com 1369719Sandreas.hansson@arm.com static int ckptCount; 1379241Sandreas.hansson@arm.com static int ckptMaxCount; 1389241Sandreas.hansson@arm.com static int ckptPrevCount; 1399241Sandreas.hansson@arm.com static void serializeAll(const std::string &cpt_dir); 1409241Sandreas.hansson@arm.com static void unserializeAll(const std::string &cpt_dir); 1419241Sandreas.hansson@arm.com static void unserializeGlobals(Checkpoint *cp); 1429241Sandreas.hansson@arm.com}; 1439241Sandreas.hansson@arm.com 1449241Sandreas.hansson@arm.com// 1459719Sandreas.hansson@arm.com// A SerializableBuilder serves as an evaluation context for a set of 1469241Sandreas.hansson@arm.com// parameters that describe a specific instance of a Serializable. This 1479719Sandreas.hansson@arm.com// evaluation context corresponds to a section in the .ini file (as 1489241Sandreas.hansson@arm.com// with the base ParamContext) plus an optional node in the 1499717Sandreas.hansson@arm.com// configuration hierarchy (the configNode member) for resolving 1509241Sandreas.hansson@arm.com// Serializable references. SerializableBuilder is an abstract superclass; 1519241Sandreas.hansson@arm.com// derived classes specialize the class for particular subclasses of 1529241Sandreas.hansson@arm.com// Serializable (e.g., BaseCache). 1539719Sandreas.hansson@arm.com// 1549719Sandreas.hansson@arm.com// For typical usage, see the definition of 1559719Sandreas.hansson@arm.com// SerializableClass::createObject(). 1569241Sandreas.hansson@arm.com// 1579241Sandreas.hansson@arm.comclass SerializableBuilder 1589241Sandreas.hansson@arm.com{ 1599241Sandreas.hansson@arm.com public: 1609241Sandreas.hansson@arm.com 1619241Sandreas.hansson@arm.com SerializableBuilder() {} 1629717Sandreas.hansson@arm.com 1639717Sandreas.hansson@arm.com virtual ~SerializableBuilder() {} 1649717Sandreas.hansson@arm.com 1659717Sandreas.hansson@arm.com // Create the actual Serializable corresponding to the parameter 1669241Sandreas.hansson@arm.com // values in this context. This function is overridden in derived 1679241Sandreas.hansson@arm.com // classes to call a specific constructor for a particular 1689241Sandreas.hansson@arm.com // subclass of Serializable. 1699719Sandreas.hansson@arm.com virtual Serializable *create() = 0; 1709719Sandreas.hansson@arm.com}; 1719719Sandreas.hansson@arm.com 1729719Sandreas.hansson@arm.com// 1739719Sandreas.hansson@arm.com// An instance of SerializableClass corresponds to a class derived from 1749720Sandreas.hansson@arm.com// Serializable. The SerializableClass instance serves to bind the string 1759719Sandreas.hansson@arm.com// name (found in the config file) to a function that creates an 1769241Sandreas.hansson@arm.com// instance of the appropriate derived class. 1779241Sandreas.hansson@arm.com// 1789241Sandreas.hansson@arm.com// This would be much cleaner in Smalltalk or Objective-C, where types 1799717Sandreas.hansson@arm.com// are first-class objects themselves. 1809241Sandreas.hansson@arm.com// 1819717Sandreas.hansson@arm.comclass SerializableClass 1829717Sandreas.hansson@arm.com{ 1839717Sandreas.hansson@arm.com public: 1849717Sandreas.hansson@arm.com 1859717Sandreas.hansson@arm.com // Type CreateFunc is a pointer to a function that creates a new 1869719Sandreas.hansson@arm.com // simulation object builder based on a .ini-file parameter 1879719Sandreas.hansson@arm.com // section (specified by the first string argument), a unique name 1889718Sandreas.hansson@arm.com // for the object (specified by the second string argument), and 1899719Sandreas.hansson@arm.com // an optional config hierarchy node (specified by the third 1909719Sandreas.hansson@arm.com // argument). A pointer to the new SerializableBuilder is returned. 1919719Sandreas.hansson@arm.com typedef Serializable *(*CreateFunc)(Checkpoint *cp, 1929719Sandreas.hansson@arm.com const std::string §ion); 1939719Sandreas.hansson@arm.com 1949719Sandreas.hansson@arm.com static std::map<std::string,CreateFunc> *classMap; 1959719Sandreas.hansson@arm.com 1969719Sandreas.hansson@arm.com // Constructor. For example: 1979719Sandreas.hansson@arm.com // 1989719Sandreas.hansson@arm.com // SerializableClass baseCacheSerializableClass("BaseCacheSerializable", 1999719Sandreas.hansson@arm.com // newBaseCacheSerializableBuilder); 2009719Sandreas.hansson@arm.com // 2019719Sandreas.hansson@arm.com SerializableClass(const std::string &className, CreateFunc createFunc); 2029720Sandreas.hansson@arm.com 2039719Sandreas.hansson@arm.com // create Serializable given name of class and pointer to 2049719Sandreas.hansson@arm.com // configuration hierarchy node 2059719Sandreas.hansson@arm.com static Serializable *createObject(Checkpoint *cp, 2069717Sandreas.hansson@arm.com const std::string §ion); 2079241Sandreas.hansson@arm.com}; 2089241Sandreas.hansson@arm.com 2099241Sandreas.hansson@arm.com// 2109718Sandreas.hansson@arm.com// Macros to encapsulate the magic of declaring & defining 2119241Sandreas.hansson@arm.com// SerializableBuilder and SerializableClass objects 2129241Sandreas.hansson@arm.com// 2139241Sandreas.hansson@arm.com 2149241Sandreas.hansson@arm.com#define REGISTER_SERIALIZEABLE(CLASS_NAME, OBJ_CLASS) \ 2159241Sandreas.hansson@arm.comSerializableClass the##OBJ_CLASS##Class(CLASS_NAME, \ 2169241Sandreas.hansson@arm.com OBJ_CLASS::createForUnserialize); 2179241Sandreas.hansson@arm.com 2189718Sandreas.hansson@arm.comvoid 2199241Sandreas.hansson@arm.comsetCheckpointDir(const std::string &name); 2209241Sandreas.hansson@arm.com 2219718Sandreas.hansson@arm.comclass Checkpoint 2229241Sandreas.hansson@arm.com{ 2239241Sandreas.hansson@arm.com private: 22410128Sstan.czerniawski@arm.com 22510128Sstan.czerniawski@arm.com IniFile *db; 2269241Sandreas.hansson@arm.com const std::string basePath; 2279241Sandreas.hansson@arm.com std::map<std::string, Serializable*> objMap; 2289241Sandreas.hansson@arm.com 2299241Sandreas.hansson@arm.com public: 2309241Sandreas.hansson@arm.com Checkpoint(const std::string &cpt_dir, const std::string &path); 2319241Sandreas.hansson@arm.com 2329241Sandreas.hansson@arm.com const std::string cptDir; 2339241Sandreas.hansson@arm.com 2349241Sandreas.hansson@arm.com bool find(const std::string §ion, const std::string &entry, 2359241Sandreas.hansson@arm.com std::string &value); 2369241Sandreas.hansson@arm.com 2379241Sandreas.hansson@arm.com bool findObj(const std::string §ion, const std::string &entry, 2389241Sandreas.hansson@arm.com SimObject *&value); 2399241Sandreas.hansson@arm.com 2409241Sandreas.hansson@arm.com bool sectionExists(const std::string §ion); 2419241Sandreas.hansson@arm.com 2429241Sandreas.hansson@arm.com // The following static functions have to do with checkpoint 2439241Sandreas.hansson@arm.com // creation rather than restoration. This class makes a handy 2449241Sandreas.hansson@arm.com // namespace for them though. 2459241Sandreas.hansson@arm.com 2469241Sandreas.hansson@arm.com // Export current checkpoint directory name so other objects can 2479241Sandreas.hansson@arm.com // derive filenames from it (e.g., memory). The return value is 2489241Sandreas.hansson@arm.com // guaranteed to end in '/' so filenames can be directly appended. 2499241Sandreas.hansson@arm.com // This function is only valid while a checkpoint is being created. 2509241Sandreas.hansson@arm.com static std::string dir(); 2519241Sandreas.hansson@arm.com 2529241Sandreas.hansson@arm.com // Filename for base checkpoint file within directory. 2539241Sandreas.hansson@arm.com static const char *baseFilename; 2549718Sandreas.hansson@arm.com}; 2559241Sandreas.hansson@arm.com 2569241Sandreas.hansson@arm.com#endif // __SERIALIZE_HH__ 2579241Sandreas.hansson@arm.com