serialize.hh revision 11076
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" 626214Snate@binkert.org#include "base/types.hh" 632SN/A 642738Sstever@eecs.umich.educlass IniFile; 65395SN/Aclass Serializable; 6610905Sandreas.sandberg@arm.comclass CheckpointIn; 674000Ssaidi@eecs.umich.educlass SimObject; 6811067Sandreas.sandberg@arm.comclass SimObjectResolver; 699983Sstever@gmail.comclass EventQueue; 702SN/A 7110905Sandreas.sandberg@arm.comtypedef std::ostream CheckpointOut; 7210905Sandreas.sandberg@arm.com 7310905Sandreas.sandberg@arm.com 749048SAli.Saidi@ARM.com/** The current version of the checkpoint format. 759048SAli.Saidi@ARM.com * This should be incremented by 1 and only 1 for every new version, where a new 769056SAli.Saidi@ARM.com * version is defined as a checkpoint created before this version won't work on 779048SAli.Saidi@ARM.com * the current version until the checkpoint format is updated. Adding a new 789048SAli.Saidi@ARM.com * SimObject shouldn't cause the version number to increase, only changes to 799056SAli.Saidi@ARM.com * existing objects such as serializing/unserializing more state, changing sizes 809048SAli.Saidi@ARM.com * of serialized arrays, etc. */ 8110930Sbrandon.potter@amd.comstatic const uint64_t gem5CheckpointVersion = 0x000000000000000f; 829048SAli.Saidi@ARM.com 83217SN/Atemplate <class T> 8410905Sandreas.sandberg@arm.comvoid paramOut(CheckpointOut &cp, const std::string &name, const T ¶m); 85217SN/A 8610459SAndreas.Sandberg@ARM.comtemplate <typename DataType, typename BitUnion> 8710905Sandreas.sandberg@arm.comvoid paramOut(CheckpointOut &cp, const std::string &name, 8810459SAndreas.Sandberg@ARM.com const BitfieldBackend::BitUnionOperators<DataType, BitUnion> &p) 8910459SAndreas.Sandberg@ARM.com{ 9010905Sandreas.sandberg@arm.com paramOut(cp, name, p.__data); 9110459SAndreas.Sandberg@ARM.com} 9210459SAndreas.Sandberg@ARM.com 93217SN/Atemplate <class T> 9410905Sandreas.sandberg@arm.comvoid paramIn(CheckpointIn &cp, const std::string &name, T ¶m); 95217SN/A 9610459SAndreas.Sandberg@ARM.comtemplate <typename DataType, typename BitUnion> 9710905Sandreas.sandberg@arm.comvoid paramIn(CheckpointIn &cp, const std::string &name, 9810459SAndreas.Sandberg@ARM.com BitfieldBackend::BitUnionOperators<DataType, BitUnion> &p) 9910459SAndreas.Sandberg@ARM.com{ 10010905Sandreas.sandberg@arm.com paramIn(cp, name, p.__data); 10110459SAndreas.Sandberg@ARM.com} 10210459SAndreas.Sandberg@ARM.com 103217SN/Atemplate <class T> 10411075SCurtis.Dunham@arm.combool optParamIn(CheckpointIn &cp, const std::string &name, T ¶m, 10511075SCurtis.Dunham@arm.com bool warn = true); 1066820SLisa.Hsu@amd.com 10710459SAndreas.Sandberg@ARM.comtemplate <typename DataType, typename BitUnion> 10810905Sandreas.sandberg@arm.combool optParamIn(CheckpointIn &cp, const std::string &name, 10911075SCurtis.Dunham@arm.com BitfieldBackend::BitUnionOperators<DataType, BitUnion> &p, 11011075SCurtis.Dunham@arm.com bool warn = true) 11110459SAndreas.Sandberg@ARM.com{ 11211075SCurtis.Dunham@arm.com return optParamIn(cp, name, p.__data, warn); 11310459SAndreas.Sandberg@ARM.com} 11410459SAndreas.Sandberg@ARM.com 1156820SLisa.Hsu@amd.comtemplate <class T> 11610905Sandreas.sandberg@arm.comvoid arrayParamOut(CheckpointOut &cp, const std::string &name, 1176227Snate@binkert.org const T *param, unsigned size); 118217SN/A 119217SN/Atemplate <class T> 12010905Sandreas.sandberg@arm.comvoid arrayParamOut(CheckpointOut &cp, const std::string &name, 1214841Ssaidi@eecs.umich.edu const std::vector<T> ¶m); 1224841Ssaidi@eecs.umich.edu 1234841Ssaidi@eecs.umich.edutemplate <class T> 12410905Sandreas.sandberg@arm.comvoid arrayParamOut(CheckpointOut &cp, const std::string &name, 1257948SAli.Saidi@ARM.com const std::list<T> ¶m); 1267948SAli.Saidi@ARM.com 1277948SAli.Saidi@ARM.comtemplate <class T> 12811076SCurtis.Dunham@arm.comvoid arrayParamOut(CheckpointOut &cp, const std::string &name, 12911076SCurtis.Dunham@arm.com const std::set<T> ¶m); 13011076SCurtis.Dunham@arm.com 13111076SCurtis.Dunham@arm.comtemplate <class T> 13210905Sandreas.sandberg@arm.comvoid arrayParamIn(CheckpointIn &cp, const std::string &name, 13310905Sandreas.sandberg@arm.com T *param, unsigned size); 134217SN/A 1354841Ssaidi@eecs.umich.edutemplate <class T> 13610905Sandreas.sandberg@arm.comvoid arrayParamIn(CheckpointIn &cp, const std::string &name, 13710905Sandreas.sandberg@arm.com std::vector<T> ¶m); 1384841Ssaidi@eecs.umich.edu 1397948SAli.Saidi@ARM.comtemplate <class T> 14010905Sandreas.sandberg@arm.comvoid arrayParamIn(CheckpointIn &cp, const std::string &name, 14110905Sandreas.sandberg@arm.com std::list<T> ¶m); 1427948SAli.Saidi@ARM.com 14311076SCurtis.Dunham@arm.comtemplate <class T> 14411076SCurtis.Dunham@arm.comvoid arrayParamIn(CheckpointIn &cp, const std::string &name, 14511076SCurtis.Dunham@arm.com std::set<T> ¶m); 14611076SCurtis.Dunham@arm.com 147237SN/Avoid 14810905Sandreas.sandberg@arm.comobjParamIn(CheckpointIn &cp, const std::string &name, SimObject * ¶m); 149237SN/A 150217SN/A// 151217SN/A// These macros are streamlined to use in serialize/unserialize 152217SN/A// functions. It's assumed that serialize() has a parameter 'os' for 153237SN/A// the ostream, and unserialize() has parameters 'cp' and 'section'. 15410905Sandreas.sandberg@arm.com#define SERIALIZE_SCALAR(scalar) paramOut(cp, #scalar, scalar) 155217SN/A 15610905Sandreas.sandberg@arm.com#define UNSERIALIZE_SCALAR(scalar) paramIn(cp, #scalar, scalar) 15710905Sandreas.sandberg@arm.com#define UNSERIALIZE_OPT_SCALAR(scalar) optParamIn(cp, #scalar, scalar) 158217SN/A 159223SN/A// ENUMs are like SCALARs, but we cast them to ints on the way out 16010905Sandreas.sandberg@arm.com#define SERIALIZE_ENUM(scalar) paramOut(cp, #scalar, (int)scalar) 161223SN/A 16211068Sandreas.sandberg@arm.com#define UNSERIALIZE_ENUM(scalar) \ 16311068Sandreas.sandberg@arm.com do { \ 16411068Sandreas.sandberg@arm.com int tmp; \ 16511068Sandreas.sandberg@arm.com paramIn(cp, #scalar, tmp); \ 16611068Sandreas.sandberg@arm.com scalar = static_cast<decltype(scalar)>(tmp); \ 16711068Sandreas.sandberg@arm.com } while (0) 168223SN/A 1695543Ssaidi@eecs.umich.edu#define SERIALIZE_ARRAY(member, size) \ 17010905Sandreas.sandberg@arm.com arrayParamOut(cp, #member, member, size) 171217SN/A 1725543Ssaidi@eecs.umich.edu#define UNSERIALIZE_ARRAY(member, size) \ 17310905Sandreas.sandberg@arm.com arrayParamIn(cp, #member, member, size) 174237SN/A 17510903Sandreas.sandberg@arm.com#define SERIALIZE_CONTAINER(member) \ 17610905Sandreas.sandberg@arm.com arrayParamOut(cp, #member, member) 17710903Sandreas.sandberg@arm.com 17810903Sandreas.sandberg@arm.com#define UNSERIALIZE_CONTAINER(member) \ 17910905Sandreas.sandberg@arm.com arrayParamIn(cp, #member, member) 18010903Sandreas.sandberg@arm.com 18110906Sandreas.sandberg@arm.com#define SERIALIZE_EVENT(event) event.serializeSection(cp, #event); 18210906Sandreas.sandberg@arm.com 18310906Sandreas.sandberg@arm.com#define UNSERIALIZE_EVENT(event) \ 18410906Sandreas.sandberg@arm.com do { \ 18510906Sandreas.sandberg@arm.com event.unserializeSection(cp, #event); \ 18610906Sandreas.sandberg@arm.com eventQueue()->checkpointReschedule(&event); \ 18710906Sandreas.sandberg@arm.com } while(0) 18810906Sandreas.sandberg@arm.com 18910908Sandreas.sandberg@arm.com#define SERIALIZE_OBJ(obj) obj.serializeSection(cp, #obj) 19010908Sandreas.sandberg@arm.com#define UNSERIALIZE_OBJ(obj) obj.unserializeSection(cp, #obj) 19110906Sandreas.sandberg@arm.com 19210905Sandreas.sandberg@arm.com#define SERIALIZE_OBJPTR(objptr) paramOut(cp, #objptr, (objptr)->name()) 193237SN/A 1945543Ssaidi@eecs.umich.edu#define UNSERIALIZE_OBJPTR(objptr) \ 19511068Sandreas.sandberg@arm.com do { \ 19611068Sandreas.sandberg@arm.com SimObject *sptr; \ 19711068Sandreas.sandberg@arm.com objParamIn(cp, #objptr, sptr); \ 19811068Sandreas.sandberg@arm.com objptr = dynamic_cast<decltype(objptr)>(sptr); \ 19911068Sandreas.sandberg@arm.com } while (0) 200217SN/A 2019342SAndreas.Sandberg@arm.com/** 2022SN/A * Basic support for object serialization. 2039342SAndreas.Sandberg@arm.com * 20410905Sandreas.sandberg@arm.com * Objects that support serialization should derive from this 20510905Sandreas.sandberg@arm.com * class. Such objects can largely be divided into two categories: 1) 20610905Sandreas.sandberg@arm.com * True SimObjects (deriving from SimObject), and 2) child objects 20710905Sandreas.sandberg@arm.com * (non-SimObjects). 20810905Sandreas.sandberg@arm.com * 20910905Sandreas.sandberg@arm.com * SimObjects are serialized automatically into their own sections 21010905Sandreas.sandberg@arm.com * automatically by the SimObject base class (see 21110905Sandreas.sandberg@arm.com * SimObject::serializeAll(). 21210905Sandreas.sandberg@arm.com * 21310905Sandreas.sandberg@arm.com * SimObjects can contain other serializable objects that are not 21410905Sandreas.sandberg@arm.com * SimObjects. Much like normal serialized members are not serialized 21510905Sandreas.sandberg@arm.com * automatically, these objects will not be serialized automatically 21610905Sandreas.sandberg@arm.com * and it is expected that the objects owning such serializable 21710905Sandreas.sandberg@arm.com * objects call the required serialization/unserialization methods on 21810905Sandreas.sandberg@arm.com * child objects. The preferred method to serialize a child object is 21910905Sandreas.sandberg@arm.com * to call serializeSection() on the child, which serializes the 22010905Sandreas.sandberg@arm.com * object into a new subsection in the current section. Another option 22110905Sandreas.sandberg@arm.com * is to call serialize() directly, which serializes the object into 22210905Sandreas.sandberg@arm.com * the current section. The latter is not recommended as it can lead 22310905Sandreas.sandberg@arm.com * to naming clashes between objects. 22410905Sandreas.sandberg@arm.com * 2259342SAndreas.Sandberg@arm.com * @note Many objects that support serialization need to be put in a 2269342SAndreas.Sandberg@arm.com * consistent state when serialization takes place. We refer to the 2279342SAndreas.Sandberg@arm.com * action of forcing an object into a consistent state as 2289342SAndreas.Sandberg@arm.com * 'draining'. Objects that need draining inherit from Drainable. See 2299342SAndreas.Sandberg@arm.com * Drainable for more information. 2302SN/A */ 231395SN/Aclass Serializable 2322SN/A{ 2332SN/A protected: 23410905Sandreas.sandberg@arm.com /** 23510905Sandreas.sandberg@arm.com * Scoped checkpoint section helper class 23610905Sandreas.sandberg@arm.com * 23710905Sandreas.sandberg@arm.com * This helper class creates a section within a checkpoint without 23810905Sandreas.sandberg@arm.com * the need for a separate serializeable object. It is mainly used 23910905Sandreas.sandberg@arm.com * within the Serializable class when serializing or unserializing 24010905Sandreas.sandberg@arm.com * section (see serializeSection() and unserializeSection()). It 24110905Sandreas.sandberg@arm.com * can also be used to maintain backwards compatibility in 24210905Sandreas.sandberg@arm.com * existing code that serializes structs that are not inheriting 24310905Sandreas.sandberg@arm.com * from Serializable into subsections. 24410905Sandreas.sandberg@arm.com * 24510905Sandreas.sandberg@arm.com * When the class is instantiated, it appends a name to the active 24610905Sandreas.sandberg@arm.com * path in a checkpoint. The old path is later restored when the 24710905Sandreas.sandberg@arm.com * instance is destroyed. For example, serializeSection() could be 24810905Sandreas.sandberg@arm.com * implemented by instantiating a ScopedCheckpointSection and then 24910905Sandreas.sandberg@arm.com * calling serialize() on an object. 25010905Sandreas.sandberg@arm.com */ 25110905Sandreas.sandberg@arm.com class ScopedCheckpointSection { 25210905Sandreas.sandberg@arm.com public: 25310905Sandreas.sandberg@arm.com template<class CP> 25410905Sandreas.sandberg@arm.com ScopedCheckpointSection(CP &cp, const char *name) { 25510905Sandreas.sandberg@arm.com pushName(name); 25610905Sandreas.sandberg@arm.com nameOut(cp); 25710905Sandreas.sandberg@arm.com } 25810905Sandreas.sandberg@arm.com 25910905Sandreas.sandberg@arm.com template<class CP> 26010905Sandreas.sandberg@arm.com ScopedCheckpointSection(CP &cp, const std::string &name) { 26110905Sandreas.sandberg@arm.com pushName(name.c_str()); 26210905Sandreas.sandberg@arm.com nameOut(cp); 26310905Sandreas.sandberg@arm.com } 26410905Sandreas.sandberg@arm.com 26510905Sandreas.sandberg@arm.com ~ScopedCheckpointSection(); 26610905Sandreas.sandberg@arm.com 26710905Sandreas.sandberg@arm.com ScopedCheckpointSection() = delete; 26810905Sandreas.sandberg@arm.com ScopedCheckpointSection(const ScopedCheckpointSection &) = delete; 26910905Sandreas.sandberg@arm.com ScopedCheckpointSection &operator=( 27010905Sandreas.sandberg@arm.com const ScopedCheckpointSection &) = delete; 27110905Sandreas.sandberg@arm.com ScopedCheckpointSection &operator=( 27210905Sandreas.sandberg@arm.com ScopedCheckpointSection &&) = delete; 27310905Sandreas.sandberg@arm.com 27410905Sandreas.sandberg@arm.com private: 27510905Sandreas.sandberg@arm.com void pushName(const char *name); 27610905Sandreas.sandberg@arm.com void nameOut(CheckpointOut &cp); 27710905Sandreas.sandberg@arm.com void nameOut(CheckpointIn &cp) {}; 27810905Sandreas.sandberg@arm.com }; 2792SN/A 2802SN/A public: 2815739Snate@binkert.org Serializable(); 2825739Snate@binkert.org virtual ~Serializable(); 2832SN/A 28410905Sandreas.sandberg@arm.com /** 28510905Sandreas.sandberg@arm.com * Serialize an object 28610905Sandreas.sandberg@arm.com * 28710905Sandreas.sandberg@arm.com * Output an object's state into the current checkpoint section. 28810905Sandreas.sandberg@arm.com * 28910905Sandreas.sandberg@arm.com * @param cp Checkpoint state 29010905Sandreas.sandberg@arm.com */ 29110905Sandreas.sandberg@arm.com virtual void serialize(CheckpointOut &cp) const = 0; 2922SN/A 29310905Sandreas.sandberg@arm.com /** 29410905Sandreas.sandberg@arm.com * Unserialize an object 29510905Sandreas.sandberg@arm.com * 29610905Sandreas.sandberg@arm.com * Read an object's state from the current checkpoint section. 29710905Sandreas.sandberg@arm.com * 29810905Sandreas.sandberg@arm.com * @param cp Checkpoint state 29910905Sandreas.sandberg@arm.com */ 30010905Sandreas.sandberg@arm.com virtual void unserialize(CheckpointIn &cp) = 0; 301237SN/A 30210905Sandreas.sandberg@arm.com /** 30310905Sandreas.sandberg@arm.com * Serialize an object into a new section 30410905Sandreas.sandberg@arm.com * 30510905Sandreas.sandberg@arm.com * This method creates a new section in a checkpoint and calls 30610905Sandreas.sandberg@arm.com * serialize() to serialize the current object into that 30710905Sandreas.sandberg@arm.com * section. The name of the section is appended to the current 30810905Sandreas.sandberg@arm.com * checkpoint path. 30910905Sandreas.sandberg@arm.com * 31010905Sandreas.sandberg@arm.com * @param cp Checkpoint state 31110905Sandreas.sandberg@arm.com * @param name Name to append to the active path 31210905Sandreas.sandberg@arm.com */ 31310905Sandreas.sandberg@arm.com void serializeSection(CheckpointOut &cp, const char *name) const; 31410905Sandreas.sandberg@arm.com 31510905Sandreas.sandberg@arm.com void serializeSection(CheckpointOut &cp, const std::string &name) const { 31610905Sandreas.sandberg@arm.com serializeSection(cp, name.c_str()); 31710905Sandreas.sandberg@arm.com } 31810905Sandreas.sandberg@arm.com 31910905Sandreas.sandberg@arm.com /** 32010905Sandreas.sandberg@arm.com * Unserialize an a child object 32110905Sandreas.sandberg@arm.com * 32210905Sandreas.sandberg@arm.com * This method loads a child object from a checkpoint. The object 32310905Sandreas.sandberg@arm.com * name is appended to the active path to form a fully qualified 32410905Sandreas.sandberg@arm.com * section name and unserialize() is called. 32510905Sandreas.sandberg@arm.com * 32610905Sandreas.sandberg@arm.com * @param cp Checkpoint state 32710905Sandreas.sandberg@arm.com * @param name Name to append to the active path 32810905Sandreas.sandberg@arm.com */ 32910905Sandreas.sandberg@arm.com void unserializeSection(CheckpointIn &cp, const char *name); 33010905Sandreas.sandberg@arm.com 33110905Sandreas.sandberg@arm.com void unserializeSection(CheckpointIn &cp, const std::string &name) { 33210905Sandreas.sandberg@arm.com unserializeSection(cp, name.c_str()); 33310905Sandreas.sandberg@arm.com } 33410905Sandreas.sandberg@arm.com 33510905Sandreas.sandberg@arm.com /** 33610905Sandreas.sandberg@arm.com * @{ 33710905Sandreas.sandberg@arm.com * @name Legacy interface 33810905Sandreas.sandberg@arm.com * 33910905Sandreas.sandberg@arm.com * Interface for objects that insist on changing their state when 34010905Sandreas.sandberg@arm.com * serializing. Such state change should be done in drain(), 34110905Sandreas.sandberg@arm.com * memWriteback(), or memInvalidate() and not in the serialization 34210905Sandreas.sandberg@arm.com * method. In general, if state changes occur in serialize, it 34310905Sandreas.sandberg@arm.com * complicates testing since it breaks assumptions about draining 34410905Sandreas.sandberg@arm.com * and serialization. It potentially also makes components more 34510905Sandreas.sandberg@arm.com * fragile since they there are no ordering guarantees when 34610905Sandreas.sandberg@arm.com * serializing SimObjects. 34710905Sandreas.sandberg@arm.com * 34810905Sandreas.sandberg@arm.com * @warn This interface is considered deprecated and should never 34910905Sandreas.sandberg@arm.com * be used. 35010905Sandreas.sandberg@arm.com */ 35110905Sandreas.sandberg@arm.com 35210905Sandreas.sandberg@arm.com virtual void serializeOld(CheckpointOut &cp) { 35310905Sandreas.sandberg@arm.com serialize(cp); 35410905Sandreas.sandberg@arm.com } 35510905Sandreas.sandberg@arm.com void serializeSectionOld(CheckpointOut &cp, const char *name); 35610905Sandreas.sandberg@arm.com void serializeSectionOld(CheckpointOut &cp, const std::string &name) { 35710905Sandreas.sandberg@arm.com serializeSectionOld(cp, name.c_str()); 35810905Sandreas.sandberg@arm.com } 35910905Sandreas.sandberg@arm.com /** @} */ 36010905Sandreas.sandberg@arm.com 36110905Sandreas.sandberg@arm.com /** Get the fully-qualified name of the active section */ 36210905Sandreas.sandberg@arm.com static const std::string ¤tSection(); 36310905Sandreas.sandberg@arm.com 3642287SN/A static int ckptCount; 3652287SN/A static int ckptMaxCount; 3662287SN/A static int ckptPrevCount; 3672868Sktlim@umich.edu static void serializeAll(const std::string &cpt_dir); 36810905Sandreas.sandberg@arm.com static void unserializeGlobals(CheckpointIn &cp); 36910905Sandreas.sandberg@arm.com 37010905Sandreas.sandberg@arm.com private: 37110905Sandreas.sandberg@arm.com static std::stack<std::string> path; 3722SN/A}; 3732SN/A 3749554Sandreas.hansson@arm.comvoid debug_serialize(const std::string &cpt_dir); 3759554Sandreas.hansson@arm.com 37610453SAndrew.Bardsley@arm.com 37710905Sandreas.sandberg@arm.comclass CheckpointIn 378237SN/A{ 379237SN/A private: 380237SN/A 381237SN/A IniFile *db; 382237SN/A 38310453SAndrew.Bardsley@arm.com SimObjectResolver &objNameResolver; 38410453SAndrew.Bardsley@arm.com 385237SN/A public: 38610905Sandreas.sandberg@arm.com CheckpointIn(const std::string &cpt_dir, SimObjectResolver &resolver); 38710905Sandreas.sandberg@arm.com ~CheckpointIn(); 388237SN/A 389937SN/A const std::string cptDir; 390937SN/A 391237SN/A bool find(const std::string §ion, const std::string &entry, 392237SN/A std::string &value); 393237SN/A 394237SN/A bool findObj(const std::string §ion, const std::string &entry, 3954000Ssaidi@eecs.umich.edu SimObject *&value); 396304SN/A 397304SN/A bool sectionExists(const std::string §ion); 398449SN/A 399449SN/A // The following static functions have to do with checkpoint 400449SN/A // creation rather than restoration. This class makes a handy 4017491Ssteve.reinhardt@amd.com // namespace for them though. Currently no Checkpoint object is 4027491Ssteve.reinhardt@amd.com // created on serialization (only unserialization) so we track the 4037491Ssteve.reinhardt@amd.com // directory name as a global. It would be nice to change this 4047491Ssteve.reinhardt@amd.com // someday 4057491Ssteve.reinhardt@amd.com 4067491Ssteve.reinhardt@amd.com private: 4077491Ssteve.reinhardt@amd.com // current directory we're serializing into. 4087491Ssteve.reinhardt@amd.com static std::string currentDirectory; 4097491Ssteve.reinhardt@amd.com 4107491Ssteve.reinhardt@amd.com public: 4117491Ssteve.reinhardt@amd.com // Set the current directory. This function takes care of 4127823Ssteve.reinhardt@amd.com // inserting curTick() if there's a '%d' in the argument, and 4137491Ssteve.reinhardt@amd.com // appends a '/' if necessary. The final name is returned. 4147491Ssteve.reinhardt@amd.com static std::string setDir(const std::string &base_name); 415449SN/A 416449SN/A // Export current checkpoint directory name so other objects can 417449SN/A // derive filenames from it (e.g., memory). The return value is 418449SN/A // guaranteed to end in '/' so filenames can be directly appended. 419449SN/A // This function is only valid while a checkpoint is being created. 420449SN/A static std::string dir(); 421449SN/A 422449SN/A // Filename for base checkpoint file within directory. 423449SN/A static const char *baseFilename; 424237SN/A}; 4252SN/A 4262SN/A#endif // __SERIALIZE_HH__ 427