summaryrefslogtreecommitdiff
path: root/sim/serialize.hh
blob: 5ebbfaba5e026a0bb60cf3eeeb45779e91769a19 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
/*
 * Copyright (c) 2003 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/* @file
 * Serialization Interface Declarations
 */

#ifndef __SERIALIZE_HH__
#define __SERIALIZE_HH__


#include <list>
#include <iostream>
#include <map>

#include "sim/host.hh"
#include "sim/configfile.hh"

class IniFile;

template <class T>
void paramOut(std::ostream &os, const std::string &name, const T& param);

template <class T>
void paramIn(IniFile &db, const std::string &section,
             const std::string &name, T& param);

template <class T>
void arrayParamOut(std::ostream &os, const std::string &name,
                   const T *param, int size);

template <class T>
void arrayParamIn(IniFile &db, const std::string &section,
                  const std::string &name, T *param, int size);

//
// These macros are streamlined to use in serialize/unserialize
// functions.  It's assumed that serialize() has a parameter 'os' for
// the ostream, and unserialize() has parameters 'db' and 'section'.
#define SERIALIZE_MEMBER(member)	paramOut(os, #member, member)

#define UNSERIALIZE_MEMBER(member)	paramIn(db, section, #member, member)

#define SERIALIZE_ARRAY(member, size)	\
        arrayParamOut(os, #member, member, size)

#define UNSERIALIZE_ARRAY(member, size)	\
        arrayParamIn(db, section, #member, member, size)

/*
 * Basic support for object serialization.
 */
class Serializeable
{
  public:

    friend class Serializer;

  protected:
    // object name: should be unique
    std::string objName;

    bool serialized;
    static Serializer *serializer;

    void mark();
    void nameOut(std::ostream& os);
    void nameOut(std::ostream& os, const std::string &_name);

  public:
    Serializeable(const std::string &n);
    virtual ~Serializeable();

    void setName(const std::string &name);

    // return name
    const std::string &name() const { return objName; }

    virtual void nameChildren() {}
    virtual void serialize(std::ostream& os) {}
    virtual void unserialize(IniFile &db, const std::string &section) {}
};

class Serializer
{
    friend class Serializeable;

  protected:
    typedef std::list<Serializeable *> serlist_t;
    serlist_t objects;
    std::string file;
    std::ostream *output;
    std::ostream &out() const;

  public:
    Serializer();
    virtual ~Serializer();

  private:
    void add_object(Serializeable *obj);
    void add_objects();

  public:
    void serialize(const std::string &file);
    const std::string &filename() const { return file; }
};

//
// A SerializeableBuilder serves as an evaluation context for a set of
// parameters that describe a specific instance of a Serializeable.  This
// evaluation context corresponds to a section in the .ini file (as
// with the base ParamContext) plus an optional node in the
// configuration hierarchy (the configNode member) for resolving
// Serializeable references.  SerializeableBuilder is an abstract superclass;
// derived classes specialize the class for particular subclasses of
// Serializeable (e.g., BaseCache).
//
// For typical usage, see the definition of
// SerializeableClass::createObject().
//
class SerializeableBuilder
{
  public:

    SerializeableBuilder() {}

    virtual ~SerializeableBuilder() {}

    // Create the actual Serializeable corresponding to the parameter
    // values in this context.  This function is overridden in derived
    // classes to call a specific constructor for a particular
    // subclass of Serializeable.
    virtual Serializeable *create() = 0;
};

//
// An instance of SerializeableClass corresponds to a class derived from
// Serializeable.  The SerializeableClass instance serves to bind the string
// name (found in the config file) to a function that creates an
// instance of the appropriate derived class.
//
// This would be much cleaner in Smalltalk or Objective-C, where types
// are first-class objects themselves.
//
class SerializeableClass
{
  public:

    // Type CreateFunc is a pointer to a function that creates a new
    // simulation object builder based on a .ini-file parameter
    // section (specified by the first string argument), a unique name
    // for the object (specified by the second string argument), and
    // an optional config hierarchy node (specified by the third
    // argument).  A pointer to the new SerializeableBuilder is returned.
    typedef SerializeableBuilder *(*CreateFunc)();

    static std::map<std::string,CreateFunc> *classMap;

    // Constructor.  For example:
    //
    // SerializeableClass baseCacheSerializeableClass("BaseCacheSerializeable",
    //                         newBaseCacheSerializeableBuilder);
    //
    SerializeableClass(const std::string &className, CreateFunc createFunc);

    // create Serializeable given name of class and pointer to
    // configuration hierarchy node
    static Serializeable *createObject(IniFile &configDB,
                                       const std::string &configClassName);

};

//
// Macros to encapsulate the magic of declaring & defining
// SerializeableBuilder and SerializeableClass objects
//

#define CREATE_SERIALIZEABLE(OBJ_CLASS)				\
OBJ_CLASS *OBJ_CLASS##Builder::create()

#define REGISTER_SERIALIZEABLE(CLASS_NAME, OBJ_CLASS)		\
class OBJ_CLASS##Builder : public SerializeableBuilder		\
{								\
  public: 							\
                                                                \
    OBJ_CLASS##Builder() {}					\
    virtual ~OBJ_CLASS##Builder() {}				\
                                                                \
    OBJ_CLASS *create();					\
};								\
                                                                \
                                                                \
SerializeableBuilder *						\
new##OBJ_CLASS##Builder()					\
{								\
    return new OBJ_CLASS##Builder();				\
}								\
                                                                \
SerializeableClass the##OBJ_CLASS##Class(CLASS_NAME,		\
                                     new##OBJ_CLASS##Builder);



#endif // __SERIALIZE_HH__