serialize.hh revision 11800
12SN/A/* 210905Sandreas.sandberg@arm.com * Copyright (c) 2015 ARM Limited 310905Sandreas.sandberg@arm.com * All rights reserved 410905Sandreas.sandberg@arm.com * 510905Sandreas.sandberg@arm.com * The license below extends only to copyright in the software and shall 610905Sandreas.sandberg@arm.com * not be construed as granting a license to any other intellectual 710905Sandreas.sandberg@arm.com * property including but not limited to intellectual property relating 810905Sandreas.sandberg@arm.com * to a hardware implementation of the functionality of the software 910905Sandreas.sandberg@arm.com * licensed hereunder. You may use the software subject to the license 1010905Sandreas.sandberg@arm.com * terms below provided that you ensure that this notice is replicated 1110905Sandreas.sandberg@arm.com * unmodified and in its entirety in all distributions of the software, 1210905Sandreas.sandberg@arm.com * modified or unmodified, in source code or in binary form. 1310905Sandreas.sandberg@arm.com * 141762SN/A * Copyright (c) 2002-2005 The Regents of The University of Michigan 152SN/A * All rights reserved. 162SN/A * 172SN/A * Redistribution and use in source and binary forms, with or without 182SN/A * modification, are permitted provided that the following conditions are 192SN/A * met: redistributions of source code must retain the above copyright 202SN/A * notice, this list of conditions and the following disclaimer; 212SN/A * redistributions in binary form must reproduce the above copyright 222SN/A * notice, this list of conditions and the following disclaimer in the 232SN/A * documentation and/or other materials provided with the distribution; 242SN/A * neither the name of the copyright holders nor the names of its 252SN/A * contributors may be used to endorse or promote products derived from 262SN/A * this software without specific prior written permission. 272SN/A * 282SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 292SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 302SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 312SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 322SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 332SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 342SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 352SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 362SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 372SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 382SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 392665Ssaidi@eecs.umich.edu * 402760Sbinkertn@umich.edu * Authors: Nathan Binkert 412760Sbinkertn@umich.edu * Erik Hallnor 422665Ssaidi@eecs.umich.edu * Steve Reinhardt 4310905Sandreas.sandberg@arm.com * Andreas Sandberg 442SN/A */ 452SN/A 462SN/A/* @file 472SN/A * Serialization Interface Declarations 482SN/A */ 492SN/A 502SN/A#ifndef __SERIALIZE_HH__ 512SN/A#define __SERIALIZE_HH__ 522SN/A 532SN/A 548229Snate@binkert.org#include <iostream> 552SN/A#include <list> 568229Snate@binkert.org#include <map> 5710905Sandreas.sandberg@arm.com#include <stack> 5811076SCurtis.Dunham@arm.com#include <set> 594841Ssaidi@eecs.umich.edu#include <vector> 602SN/A 6110459SAndreas.Sandberg@ARM.com#include "base/bitunion.hh" 622SN/A 6311800Sbrandon.potter@amd.comclass CheckpointIn; 642738Sstever@eecs.umich.educlass IniFile; 65395SN/Aclass Serializable; 664000Ssaidi@eecs.umich.educlass SimObject; 6711067Sandreas.sandberg@arm.comclass SimObjectResolver; 682SN/A 6910905Sandreas.sandberg@arm.comtypedef std::ostream CheckpointOut; 7010905Sandreas.sandberg@arm.com 7110905Sandreas.sandberg@arm.com 72217SN/Atemplate <class T> 7310905Sandreas.sandberg@arm.comvoid paramOut(CheckpointOut &cp, const std::string &name, const T ¶m); 74217SN/A 7510459SAndreas.Sandberg@ARM.comtemplate <typename DataType, typename BitUnion> 7610905Sandreas.sandberg@arm.comvoid paramOut(CheckpointOut &cp, const std::string &name, 7710459SAndreas.Sandberg@ARM.com const BitfieldBackend::BitUnionOperators<DataType, BitUnion> &p) 7810459SAndreas.Sandberg@ARM.com{ 7910905Sandreas.sandberg@arm.com paramOut(cp, name, p.__data); 8010459SAndreas.Sandberg@ARM.com} 8110459SAndreas.Sandberg@ARM.com 82217SN/Atemplate <class T> 8310905Sandreas.sandberg@arm.comvoid paramIn(CheckpointIn &cp, const std::string &name, T ¶m); 84217SN/A 8510459SAndreas.Sandberg@ARM.comtemplate <typename DataType, typename BitUnion> 8610905Sandreas.sandberg@arm.comvoid paramIn(CheckpointIn &cp, const std::string &name, 8710459SAndreas.Sandberg@ARM.com BitfieldBackend::BitUnionOperators<DataType, BitUnion> &p) 8810459SAndreas.Sandberg@ARM.com{ 8910905Sandreas.sandberg@arm.com paramIn(cp, name, p.__data); 9010459SAndreas.Sandberg@ARM.com} 9110459SAndreas.Sandberg@ARM.com 92217SN/Atemplate <class T> 9311075SCurtis.Dunham@arm.combool optParamIn(CheckpointIn &cp, const std::string &name, T ¶m, 9411075SCurtis.Dunham@arm.com bool warn = true); 956820SLisa.Hsu@amd.com 9610459SAndreas.Sandberg@ARM.comtemplate <typename DataType, typename BitUnion> 9710905Sandreas.sandberg@arm.combool optParamIn(CheckpointIn &cp, const std::string &name, 9811075SCurtis.Dunham@arm.com BitfieldBackend::BitUnionOperators<DataType, BitUnion> &p, 9911075SCurtis.Dunham@arm.com bool warn = true) 10010459SAndreas.Sandberg@ARM.com{ 10111075SCurtis.Dunham@arm.com return optParamIn(cp, name, p.__data, warn); 10210459SAndreas.Sandberg@ARM.com} 10310459SAndreas.Sandberg@ARM.com 1046820SLisa.Hsu@amd.comtemplate <class T> 10510905Sandreas.sandberg@arm.comvoid arrayParamOut(CheckpointOut &cp, const std::string &name, 1066227Snate@binkert.org const T *param, unsigned size); 107217SN/A 108217SN/Atemplate <class T> 10910905Sandreas.sandberg@arm.comvoid arrayParamOut(CheckpointOut &cp, const std::string &name, 1104841Ssaidi@eecs.umich.edu const std::vector<T> ¶m); 1114841Ssaidi@eecs.umich.edu 1124841Ssaidi@eecs.umich.edutemplate <class T> 11310905Sandreas.sandberg@arm.comvoid arrayParamOut(CheckpointOut &cp, const std::string &name, 1147948SAli.Saidi@ARM.com const std::list<T> ¶m); 1157948SAli.Saidi@ARM.com 1167948SAli.Saidi@ARM.comtemplate <class T> 11711076SCurtis.Dunham@arm.comvoid arrayParamOut(CheckpointOut &cp, const std::string &name, 11811076SCurtis.Dunham@arm.com const std::set<T> ¶m); 11911076SCurtis.Dunham@arm.com 12011076SCurtis.Dunham@arm.comtemplate <class T> 12110905Sandreas.sandberg@arm.comvoid arrayParamIn(CheckpointIn &cp, const std::string &name, 12210905Sandreas.sandberg@arm.com T *param, unsigned size); 123217SN/A 1244841Ssaidi@eecs.umich.edutemplate <class T> 12510905Sandreas.sandberg@arm.comvoid arrayParamIn(CheckpointIn &cp, const std::string &name, 12610905Sandreas.sandberg@arm.com std::vector<T> ¶m); 1274841Ssaidi@eecs.umich.edu 1287948SAli.Saidi@ARM.comtemplate <class T> 12910905Sandreas.sandberg@arm.comvoid arrayParamIn(CheckpointIn &cp, const std::string &name, 13010905Sandreas.sandberg@arm.com std::list<T> ¶m); 1317948SAli.Saidi@ARM.com 13211076SCurtis.Dunham@arm.comtemplate <class T> 13311076SCurtis.Dunham@arm.comvoid arrayParamIn(CheckpointIn &cp, const std::string &name, 13411076SCurtis.Dunham@arm.com std::set<T> ¶m); 13511076SCurtis.Dunham@arm.com 136237SN/Avoid 13710905Sandreas.sandberg@arm.comobjParamIn(CheckpointIn &cp, const std::string &name, SimObject * ¶m); 138237SN/A 139217SN/A// 140217SN/A// These macros are streamlined to use in serialize/unserialize 141217SN/A// functions. It's assumed that serialize() has a parameter 'os' for 142237SN/A// the ostream, and unserialize() has parameters 'cp' and 'section'. 14310905Sandreas.sandberg@arm.com#define SERIALIZE_SCALAR(scalar) paramOut(cp, #scalar, scalar) 144217SN/A 14510905Sandreas.sandberg@arm.com#define UNSERIALIZE_SCALAR(scalar) paramIn(cp, #scalar, scalar) 14610905Sandreas.sandberg@arm.com#define UNSERIALIZE_OPT_SCALAR(scalar) optParamIn(cp, #scalar, scalar) 147217SN/A 148223SN/A// ENUMs are like SCALARs, but we cast them to ints on the way out 14910905Sandreas.sandberg@arm.com#define SERIALIZE_ENUM(scalar) paramOut(cp, #scalar, (int)scalar) 150223SN/A 15111068Sandreas.sandberg@arm.com#define UNSERIALIZE_ENUM(scalar) \ 15211068Sandreas.sandberg@arm.com do { \ 15311068Sandreas.sandberg@arm.com int tmp; \ 15411068Sandreas.sandberg@arm.com paramIn(cp, #scalar, tmp); \ 15511068Sandreas.sandberg@arm.com scalar = static_cast<decltype(scalar)>(tmp); \ 15611068Sandreas.sandberg@arm.com } while (0) 157223SN/A 1585543Ssaidi@eecs.umich.edu#define SERIALIZE_ARRAY(member, size) \ 15910905Sandreas.sandberg@arm.com arrayParamOut(cp, #member, member, size) 160217SN/A 1615543Ssaidi@eecs.umich.edu#define UNSERIALIZE_ARRAY(member, size) \ 16210905Sandreas.sandberg@arm.com arrayParamIn(cp, #member, member, size) 163237SN/A 16410903Sandreas.sandberg@arm.com#define SERIALIZE_CONTAINER(member) \ 16510905Sandreas.sandberg@arm.com arrayParamOut(cp, #member, member) 16610903Sandreas.sandberg@arm.com 16710903Sandreas.sandberg@arm.com#define UNSERIALIZE_CONTAINER(member) \ 16810905Sandreas.sandberg@arm.com arrayParamIn(cp, #member, member) 16910903Sandreas.sandberg@arm.com 17010906Sandreas.sandberg@arm.com#define SERIALIZE_EVENT(event) event.serializeSection(cp, #event); 17110906Sandreas.sandberg@arm.com 17210906Sandreas.sandberg@arm.com#define UNSERIALIZE_EVENT(event) \ 17310906Sandreas.sandberg@arm.com do { \ 17410906Sandreas.sandberg@arm.com event.unserializeSection(cp, #event); \ 17510906Sandreas.sandberg@arm.com eventQueue()->checkpointReschedule(&event); \ 17611321Ssteve.reinhardt@amd.com } while (0) 17710906Sandreas.sandberg@arm.com 17810908Sandreas.sandberg@arm.com#define SERIALIZE_OBJ(obj) obj.serializeSection(cp, #obj) 17910908Sandreas.sandberg@arm.com#define UNSERIALIZE_OBJ(obj) obj.unserializeSection(cp, #obj) 18010906Sandreas.sandberg@arm.com 18110905Sandreas.sandberg@arm.com#define SERIALIZE_OBJPTR(objptr) paramOut(cp, #objptr, (objptr)->name()) 182237SN/A 1835543Ssaidi@eecs.umich.edu#define UNSERIALIZE_OBJPTR(objptr) \ 18411068Sandreas.sandberg@arm.com do { \ 18511068Sandreas.sandberg@arm.com SimObject *sptr; \ 18611068Sandreas.sandberg@arm.com objParamIn(cp, #objptr, sptr); \ 18711068Sandreas.sandberg@arm.com objptr = dynamic_cast<decltype(objptr)>(sptr); \ 18811068Sandreas.sandberg@arm.com } while (0) 189217SN/A 1909342SAndreas.Sandberg@arm.com/** 1912SN/A * Basic support for object serialization. 1929342SAndreas.Sandberg@arm.com * 19310905Sandreas.sandberg@arm.com * Objects that support serialization should derive from this 19410905Sandreas.sandberg@arm.com * class. Such objects can largely be divided into two categories: 1) 19510905Sandreas.sandberg@arm.com * True SimObjects (deriving from SimObject), and 2) child objects 19610905Sandreas.sandberg@arm.com * (non-SimObjects). 19710905Sandreas.sandberg@arm.com * 19810905Sandreas.sandberg@arm.com * SimObjects are serialized automatically into their own sections 19910905Sandreas.sandberg@arm.com * automatically by the SimObject base class (see 20010905Sandreas.sandberg@arm.com * SimObject::serializeAll(). 20110905Sandreas.sandberg@arm.com * 20210905Sandreas.sandberg@arm.com * SimObjects can contain other serializable objects that are not 20310905Sandreas.sandberg@arm.com * SimObjects. Much like normal serialized members are not serialized 20410905Sandreas.sandberg@arm.com * automatically, these objects will not be serialized automatically 20510905Sandreas.sandberg@arm.com * and it is expected that the objects owning such serializable 20610905Sandreas.sandberg@arm.com * objects call the required serialization/unserialization methods on 20710905Sandreas.sandberg@arm.com * child objects. The preferred method to serialize a child object is 20810905Sandreas.sandberg@arm.com * to call serializeSection() on the child, which serializes the 20910905Sandreas.sandberg@arm.com * object into a new subsection in the current section. Another option 21010905Sandreas.sandberg@arm.com * is to call serialize() directly, which serializes the object into 21110905Sandreas.sandberg@arm.com * the current section. The latter is not recommended as it can lead 21210905Sandreas.sandberg@arm.com * to naming clashes between objects. 21310905Sandreas.sandberg@arm.com * 2149342SAndreas.Sandberg@arm.com * @note Many objects that support serialization need to be put in a 2159342SAndreas.Sandberg@arm.com * consistent state when serialization takes place. We refer to the 2169342SAndreas.Sandberg@arm.com * action of forcing an object into a consistent state as 2179342SAndreas.Sandberg@arm.com * 'draining'. Objects that need draining inherit from Drainable. See 2189342SAndreas.Sandberg@arm.com * Drainable for more information. 2192SN/A */ 220395SN/Aclass Serializable 2212SN/A{ 2222SN/A protected: 22310905Sandreas.sandberg@arm.com /** 22410905Sandreas.sandberg@arm.com * Scoped checkpoint section helper class 22510905Sandreas.sandberg@arm.com * 22610905Sandreas.sandberg@arm.com * This helper class creates a section within a checkpoint without 22710905Sandreas.sandberg@arm.com * the need for a separate serializeable object. It is mainly used 22810905Sandreas.sandberg@arm.com * within the Serializable class when serializing or unserializing 22910905Sandreas.sandberg@arm.com * section (see serializeSection() and unserializeSection()). It 23010905Sandreas.sandberg@arm.com * can also be used to maintain backwards compatibility in 23110905Sandreas.sandberg@arm.com * existing code that serializes structs that are not inheriting 23210905Sandreas.sandberg@arm.com * from Serializable into subsections. 23310905Sandreas.sandberg@arm.com * 23410905Sandreas.sandberg@arm.com * When the class is instantiated, it appends a name to the active 23510905Sandreas.sandberg@arm.com * path in a checkpoint. The old path is later restored when the 23610905Sandreas.sandberg@arm.com * instance is destroyed. For example, serializeSection() could be 23710905Sandreas.sandberg@arm.com * implemented by instantiating a ScopedCheckpointSection and then 23810905Sandreas.sandberg@arm.com * calling serialize() on an object. 23910905Sandreas.sandberg@arm.com */ 24010905Sandreas.sandberg@arm.com class ScopedCheckpointSection { 24110905Sandreas.sandberg@arm.com public: 24210905Sandreas.sandberg@arm.com template<class CP> 24310905Sandreas.sandberg@arm.com ScopedCheckpointSection(CP &cp, const char *name) { 24410905Sandreas.sandberg@arm.com pushName(name); 24510905Sandreas.sandberg@arm.com nameOut(cp); 24610905Sandreas.sandberg@arm.com } 24710905Sandreas.sandberg@arm.com 24810905Sandreas.sandberg@arm.com template<class CP> 24910905Sandreas.sandberg@arm.com ScopedCheckpointSection(CP &cp, const std::string &name) { 25010905Sandreas.sandberg@arm.com pushName(name.c_str()); 25110905Sandreas.sandberg@arm.com nameOut(cp); 25210905Sandreas.sandberg@arm.com } 25310905Sandreas.sandberg@arm.com 25410905Sandreas.sandberg@arm.com ~ScopedCheckpointSection(); 25510905Sandreas.sandberg@arm.com 25610905Sandreas.sandberg@arm.com ScopedCheckpointSection() = delete; 25710905Sandreas.sandberg@arm.com ScopedCheckpointSection(const ScopedCheckpointSection &) = delete; 25810905Sandreas.sandberg@arm.com ScopedCheckpointSection &operator=( 25910905Sandreas.sandberg@arm.com const ScopedCheckpointSection &) = delete; 26010905Sandreas.sandberg@arm.com ScopedCheckpointSection &operator=( 26110905Sandreas.sandberg@arm.com ScopedCheckpointSection &&) = delete; 26210905Sandreas.sandberg@arm.com 26310905Sandreas.sandberg@arm.com private: 26410905Sandreas.sandberg@arm.com void pushName(const char *name); 26510905Sandreas.sandberg@arm.com void nameOut(CheckpointOut &cp); 26610905Sandreas.sandberg@arm.com void nameOut(CheckpointIn &cp) {}; 26710905Sandreas.sandberg@arm.com }; 2682SN/A 2692SN/A public: 2705739Snate@binkert.org Serializable(); 2715739Snate@binkert.org virtual ~Serializable(); 2722SN/A 27310905Sandreas.sandberg@arm.com /** 27410905Sandreas.sandberg@arm.com * Serialize an object 27510905Sandreas.sandberg@arm.com * 27610905Sandreas.sandberg@arm.com * Output an object's state into the current checkpoint section. 27710905Sandreas.sandberg@arm.com * 27810905Sandreas.sandberg@arm.com * @param cp Checkpoint state 27910905Sandreas.sandberg@arm.com */ 28010905Sandreas.sandberg@arm.com virtual void serialize(CheckpointOut &cp) const = 0; 2812SN/A 28210905Sandreas.sandberg@arm.com /** 28310905Sandreas.sandberg@arm.com * Unserialize an object 28410905Sandreas.sandberg@arm.com * 28510905Sandreas.sandberg@arm.com * Read an object's state from the current checkpoint section. 28610905Sandreas.sandberg@arm.com * 28710905Sandreas.sandberg@arm.com * @param cp Checkpoint state 28810905Sandreas.sandberg@arm.com */ 28910905Sandreas.sandberg@arm.com virtual void unserialize(CheckpointIn &cp) = 0; 290237SN/A 29110905Sandreas.sandberg@arm.com /** 29210905Sandreas.sandberg@arm.com * Serialize an object into a new section 29310905Sandreas.sandberg@arm.com * 29410905Sandreas.sandberg@arm.com * This method creates a new section in a checkpoint and calls 29510905Sandreas.sandberg@arm.com * serialize() to serialize the current object into that 29610905Sandreas.sandberg@arm.com * section. The name of the section is appended to the current 29710905Sandreas.sandberg@arm.com * checkpoint path. 29810905Sandreas.sandberg@arm.com * 29910905Sandreas.sandberg@arm.com * @param cp Checkpoint state 30010905Sandreas.sandberg@arm.com * @param name Name to append to the active path 30110905Sandreas.sandberg@arm.com */ 30210905Sandreas.sandberg@arm.com void serializeSection(CheckpointOut &cp, const char *name) const; 30310905Sandreas.sandberg@arm.com 30410905Sandreas.sandberg@arm.com void serializeSection(CheckpointOut &cp, const std::string &name) const { 30510905Sandreas.sandberg@arm.com serializeSection(cp, name.c_str()); 30610905Sandreas.sandberg@arm.com } 30710905Sandreas.sandberg@arm.com 30810905Sandreas.sandberg@arm.com /** 30910905Sandreas.sandberg@arm.com * Unserialize an a child object 31010905Sandreas.sandberg@arm.com * 31110905Sandreas.sandberg@arm.com * This method loads a child object from a checkpoint. The object 31210905Sandreas.sandberg@arm.com * name is appended to the active path to form a fully qualified 31310905Sandreas.sandberg@arm.com * section name and unserialize() is called. 31410905Sandreas.sandberg@arm.com * 31510905Sandreas.sandberg@arm.com * @param cp Checkpoint state 31610905Sandreas.sandberg@arm.com * @param name Name to append to the active path 31710905Sandreas.sandberg@arm.com */ 31810905Sandreas.sandberg@arm.com void unserializeSection(CheckpointIn &cp, const char *name); 31910905Sandreas.sandberg@arm.com 32010905Sandreas.sandberg@arm.com void unserializeSection(CheckpointIn &cp, const std::string &name) { 32110905Sandreas.sandberg@arm.com unserializeSection(cp, name.c_str()); 32210905Sandreas.sandberg@arm.com } 32310905Sandreas.sandberg@arm.com 32410905Sandreas.sandberg@arm.com /** Get the fully-qualified name of the active section */ 32510905Sandreas.sandberg@arm.com static const std::string ¤tSection(); 32610905Sandreas.sandberg@arm.com 3272287SN/A static int ckptCount; 3282287SN/A static int ckptMaxCount; 3292287SN/A static int ckptPrevCount; 3302868Sktlim@umich.edu static void serializeAll(const std::string &cpt_dir); 33110905Sandreas.sandberg@arm.com static void unserializeGlobals(CheckpointIn &cp); 33210905Sandreas.sandberg@arm.com 33310905Sandreas.sandberg@arm.com private: 33410905Sandreas.sandberg@arm.com static std::stack<std::string> path; 3352SN/A}; 3362SN/A 3379554Sandreas.hansson@arm.comvoid debug_serialize(const std::string &cpt_dir); 3389554Sandreas.hansson@arm.com 33910453SAndrew.Bardsley@arm.com 34010905Sandreas.sandberg@arm.comclass CheckpointIn 341237SN/A{ 342237SN/A private: 343237SN/A 344237SN/A IniFile *db; 345237SN/A 34610453SAndrew.Bardsley@arm.com SimObjectResolver &objNameResolver; 34710453SAndrew.Bardsley@arm.com 348237SN/A public: 34910905Sandreas.sandberg@arm.com CheckpointIn(const std::string &cpt_dir, SimObjectResolver &resolver); 35010905Sandreas.sandberg@arm.com ~CheckpointIn(); 351237SN/A 352937SN/A const std::string cptDir; 353937SN/A 354237SN/A bool find(const std::string §ion, const std::string &entry, 355237SN/A std::string &value); 356237SN/A 357237SN/A bool findObj(const std::string §ion, const std::string &entry, 3584000Ssaidi@eecs.umich.edu SimObject *&value); 359304SN/A 36011655Sandreas.sandberg@arm.com 36111655Sandreas.sandberg@arm.com bool entryExists(const std::string §ion, const std::string &entry); 362304SN/A bool sectionExists(const std::string §ion); 363449SN/A 364449SN/A // The following static functions have to do with checkpoint 365449SN/A // creation rather than restoration. This class makes a handy 3667491Ssteve.reinhardt@amd.com // namespace for them though. Currently no Checkpoint object is 3677491Ssteve.reinhardt@amd.com // created on serialization (only unserialization) so we track the 3687491Ssteve.reinhardt@amd.com // directory name as a global. It would be nice to change this 3697491Ssteve.reinhardt@amd.com // someday 3707491Ssteve.reinhardt@amd.com 3717491Ssteve.reinhardt@amd.com private: 3727491Ssteve.reinhardt@amd.com // current directory we're serializing into. 3737491Ssteve.reinhardt@amd.com static std::string currentDirectory; 3747491Ssteve.reinhardt@amd.com 3757491Ssteve.reinhardt@amd.com public: 3767491Ssteve.reinhardt@amd.com // Set the current directory. This function takes care of 3777823Ssteve.reinhardt@amd.com // inserting curTick() if there's a '%d' in the argument, and 3787491Ssteve.reinhardt@amd.com // appends a '/' if necessary. The final name is returned. 3797491Ssteve.reinhardt@amd.com static std::string setDir(const std::string &base_name); 380449SN/A 381449SN/A // Export current checkpoint directory name so other objects can 382449SN/A // derive filenames from it (e.g., memory). The return value is 383449SN/A // guaranteed to end in '/' so filenames can be directly appended. 384449SN/A // This function is only valid while a checkpoint is being created. 385449SN/A static std::string dir(); 386449SN/A 387449SN/A // Filename for base checkpoint file within directory. 388449SN/A static const char *baseFilename; 389237SN/A}; 3902SN/A 3912SN/A#endif // __SERIALIZE_HH__ 392