serialize.cc revision 5739
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#include <sys/time.h>
34#include <sys/types.h>
35#include <sys/stat.h>
36#include <errno.h>
37
38#include <fstream>
39#include <list>
40#include <string>
41#include <vector>
42
43#include "base/inifile.hh"
44#include "base/misc.hh"
45#include "base/output.hh"
46#include "base/str.hh"
47#include "base/trace.hh"
48#include "sim/eventq.hh"
49#include "sim/serialize.hh"
50#include "sim/sim_events.hh"
51#include "sim/sim_exit.hh"
52#include "sim/sim_object.hh"
53
54// For stat reset hack
55#include "sim/stat_control.hh"
56
57using namespace std;
58
59extern SimObject *resolveSimObject(const string &);
60
61//
62// The base implementations use to_number for parsing and '<<' for
63// displaying, suitable for integer types.
64//
65template <class T>
66bool
67parseParam(const string &s, T &value)
68{
69    return to_number(s, value);
70}
71
72template <class T>
73void
74showParam(ostream &os, const T &value)
75{
76    os << value;
77}
78
79//
80// Template specializations:
81// - char (8-bit integer)
82// - floating-point types
83// - bool
84// - string
85//
86
87// Treat 8-bit ints (chars) as ints on output, not as chars
88template <>
89void
90showParam(ostream &os, const char &value)
91{
92    os << (int)value;
93}
94
95
96template <>
97void
98showParam(ostream &os, const unsigned char &value)
99{
100    os << (unsigned int)value;
101}
102
103
104// Use sscanf() for FP types as to_number() only handles integers
105template <>
106bool
107parseParam(const string &s, float &value)
108{
109    return (sscanf(s.c_str(), "%f", &value) == 1);
110}
111
112template <>
113bool
114parseParam(const string &s, double &value)
115{
116    return (sscanf(s.c_str(), "%lf", &value) == 1);
117}
118
119template <>
120bool
121parseParam(const string &s, bool &value)
122{
123    const string &ls = to_lower(s);
124
125    if (ls == "true") {
126        value = true;
127        return true;
128    }
129
130    if (ls == "false") {
131        value = false;
132        return true;
133    }
134
135    return false;
136}
137
138// Display bools as strings
139template <>
140void
141showParam(ostream &os, const bool &value)
142{
143    os << (value ? "true" : "false");
144}
145
146
147// String requires no processing to speak of
148template <>
149bool
150parseParam(const string &s, string &value)
151{
152    value = s;
153    return true;
154}
155
156int Serializable::ckptMaxCount = 0;
157int Serializable::ckptCount = 0;
158int Serializable::ckptPrevCount = -1;
159
160void
161Serializable::nameOut(ostream &os)
162{
163    os << "\n[" << name() << "]\n";
164}
165
166void
167Serializable::nameOut(ostream &os, const string &_name)
168{
169    os << "\n[" << _name << "]\n";
170}
171
172template <class T>
173void
174paramOut(ostream &os, const std::string &name, const T &param)
175{
176    os << name << "=";
177    showParam(os, param);
178    os << "\n";
179}
180
181template <class T>
182void
183arrayParamOut(ostream &os, const std::string &name,
184              const std::vector<T> &param)
185{
186    int size = param.size();
187    os << name << "=";
188    if (size > 0)
189        showParam(os, param[0]);
190    for (int i = 1; i < size; ++i) {
191        os << " ";
192        showParam(os, param[i]);
193    }
194    os << "\n";
195}
196
197
198template <class T>
199void
200paramIn(Checkpoint *cp, const std::string &section,
201        const std::string &name, T &param)
202{
203    std::string str;
204    if (!cp->find(section, name, str) || !parseParam(str, param)) {
205        fatal("Can't unserialize '%s:%s'\n", section, name);
206    }
207}
208
209
210template <class T>
211void
212arrayParamOut(ostream &os, const std::string &name,
213              const T *param, int size)
214{
215    os << name << "=";
216    if (size > 0)
217        showParam(os, param[0]);
218    for (int i = 1; i < size; ++i) {
219        os << " ";
220        showParam(os, param[i]);
221    }
222    os << "\n";
223}
224
225
226template <class T>
227void
228arrayParamIn(Checkpoint *cp, const std::string &section,
229             const std::string &name, T *param, int size)
230{
231    std::string str;
232    if (!cp->find(section, name, str)) {
233        fatal("Can't unserialize '%s:%s'\n", section, name);
234    }
235
236    // code below stolen from VectorParam<T>::parse().
237    // it would be nice to unify these somehow...
238
239    vector<string> tokens;
240
241    tokenize(tokens, str, ' ');
242
243    // Need this if we were doing a vector
244    // value.resize(tokens.size());
245
246    if (tokens.size() != size) {
247        fatal("Array size mismatch on %s:%s'\n", section, name);
248    }
249
250    for (int i = 0; i < tokens.size(); i++) {
251        // need to parse into local variable to handle vector<bool>,
252        // for which operator[] returns a special reference class
253        // that's not the same as 'bool&', (since it's a packed
254        // vector)
255        T scalar_value;
256        if (!parseParam(tokens[i], scalar_value)) {
257            string err("could not parse \"");
258
259            err += str;
260            err += "\"";
261
262            fatal(err);
263        }
264
265        // assign parsed value to vector
266        param[i] = scalar_value;
267    }
268}
269
270template <class T>
271void
272arrayParamIn(Checkpoint *cp, const std::string &section,
273             const std::string &name, std::vector<T> &param)
274{
275    std::string str;
276    if (!cp->find(section, name, str)) {
277        fatal("Can't unserialize '%s:%s'\n", section, name);
278    }
279
280    // code below stolen from VectorParam<T>::parse().
281    // it would be nice to unify these somehow...
282
283    vector<string> tokens;
284
285    tokenize(tokens, str, ' ');
286
287    // Need this if we were doing a vector
288    // value.resize(tokens.size());
289
290    param.resize(tokens.size());
291
292    for (int i = 0; i < tokens.size(); i++) {
293        // need to parse into local variable to handle vector<bool>,
294        // for which operator[] returns a special reference class
295        // that's not the same as 'bool&', (since it's a packed
296        // vector)
297        T scalar_value;
298        if (!parseParam(tokens[i], scalar_value)) {
299            string err("could not parse \"");
300
301            err += str;
302            err += "\"";
303
304            fatal(err);
305        }
306
307        // assign parsed value to vector
308        param[i] = scalar_value;
309    }
310}
311
312
313
314void
315objParamIn(Checkpoint *cp, const std::string &section,
316           const std::string &name, SimObject * &param)
317{
318    if (!cp->findObj(section, name, param)) {
319        fatal("Can't unserialize '%s:%s'\n", section, name);
320    }
321}
322
323
324#define INSTANTIATE_PARAM_TEMPLATES(type)                               \
325template void                                                           \
326paramOut(ostream &os, const std::string &name, type const &param);      \
327template void                                                           \
328paramIn(Checkpoint *cp, const std::string &section,                     \
329        const std::string &name, type & param);                         \
330template void                                                           \
331arrayParamOut(ostream &os, const std::string &name,                     \
332              type const *param, int size);                             \
333template void                                                           \
334arrayParamIn(Checkpoint *cp, const std::string &section,                \
335             const std::string &name, type *param, int size);           \
336template void                                                           \
337arrayParamOut(ostream &os, const std::string &name,                     \
338              const std::vector<type> &param);                          \
339template void                                                           \
340arrayParamIn(Checkpoint *cp, const std::string &section,                \
341             const std::string &name, std::vector<type> &param);
342
343INSTANTIATE_PARAM_TEMPLATES(signed char)
344INSTANTIATE_PARAM_TEMPLATES(unsigned char)
345INSTANTIATE_PARAM_TEMPLATES(signed short)
346INSTANTIATE_PARAM_TEMPLATES(unsigned short)
347INSTANTIATE_PARAM_TEMPLATES(signed int)
348INSTANTIATE_PARAM_TEMPLATES(unsigned int)
349INSTANTIATE_PARAM_TEMPLATES(signed long)
350INSTANTIATE_PARAM_TEMPLATES(unsigned long)
351INSTANTIATE_PARAM_TEMPLATES(signed long long)
352INSTANTIATE_PARAM_TEMPLATES(unsigned long long)
353INSTANTIATE_PARAM_TEMPLATES(bool)
354INSTANTIATE_PARAM_TEMPLATES(string)
355
356
357/////////////////////////////
358
359/// Container for serializing global variables (not associated with
360/// any serialized object).
361class Globals : public Serializable
362{
363  public:
364    const string name() const;
365    void serialize(ostream &os);
366    void unserialize(Checkpoint *cp);
367};
368
369/// The one and only instance of the Globals class.
370Globals globals;
371
372const string
373Globals::name() const
374{
375    return "Globals";
376}
377
378void
379Globals::serialize(ostream &os)
380{
381    nameOut(os);
382    SERIALIZE_SCALAR(curTick);
383
384    nameOut(os, "MainEventQueue");
385    mainEventQueue.serialize(os);
386}
387
388void
389Globals::unserialize(Checkpoint *cp)
390{
391    const string &section = name();
392    UNSERIALIZE_SCALAR(curTick);
393
394    mainEventQueue.unserialize(cp, "MainEventQueue");
395}
396
397Serializable::Serializable()
398{
399}
400
401Serializable::~Serializable()
402{
403}
404
405void
406Serializable::serialize(std::ostream &os)
407{
408}
409
410void
411Serializable::unserialize(Checkpoint *cp, const std::string &section)
412{
413}
414
415void
416Serializable::serializeAll(const std::string &cpt_dir)
417{
418    setCheckpointDir(cpt_dir);
419    string dir = Checkpoint::dir();
420    if (mkdir(dir.c_str(), 0775) == -1 && errno != EEXIST)
421            fatal("couldn't mkdir %s\n", dir);
422
423    string cpt_file = dir + Checkpoint::baseFilename;
424    ofstream outstream(cpt_file.c_str());
425    time_t t = time(NULL);
426    if (!outstream.is_open())
427        fatal("Unable to open file %s for writing\n", cpt_file.c_str());
428    outstream << "// checkpoint generated: " << ctime(&t);
429
430    globals.serialize(outstream);
431    SimObject::serializeAll(outstream);
432}
433
434void
435Serializable::unserializeAll(const std::string &cpt_dir)
436{
437    setCheckpointDir(cpt_dir);
438    string dir = Checkpoint::dir();
439    string cpt_file = dir + Checkpoint::baseFilename;
440    string section = "";
441
442    DPRINTFR(Config, "Loading checkpoint dir '%s'\n",
443             dir);
444    Checkpoint *cp = new Checkpoint(dir, section);
445    unserializeGlobals(cp);
446    SimObject::unserializeAll(cp);
447}
448
449void
450Serializable::unserializeGlobals(Checkpoint *cp)
451{
452    globals.unserialize(cp);
453}
454
455const char *Checkpoint::baseFilename = "m5.cpt";
456
457static string checkpointDirBase;
458
459void
460setCheckpointDir(const std::string &name)
461{
462    checkpointDirBase = name;
463    if (checkpointDirBase[checkpointDirBase.size() - 1] != '/')
464        checkpointDirBase += "/";
465}
466
467string
468Checkpoint::dir()
469{
470    // use csprintf to insert curTick into directory name if it
471    // appears to have a format placeholder in it.
472    return (checkpointDirBase.find("%") != string::npos) ?
473        csprintf(checkpointDirBase, curTick) : checkpointDirBase;
474}
475
476void
477debug_serialize(const std::string &cpt_dir)
478{
479    Serializable::serializeAll(cpt_dir);
480}
481
482
483////////////////////////////////////////////////////////////////////////
484//
485// SerializableClass member definitions
486//
487////////////////////////////////////////////////////////////////////////
488
489// Map of class names to SerializableBuilder creation functions.
490// Need to make this a pointer so we can force initialization on the
491// first reference; otherwise, some SerializableClass constructors
492// may be invoked before the classMap constructor.
493map<string,SerializableClass::CreateFunc> *SerializableClass::classMap = 0;
494
495// SerializableClass constructor: add mapping to classMap
496SerializableClass::SerializableClass(const string &className,
497                                       CreateFunc createFunc)
498{
499    if (classMap == NULL)
500        classMap = new map<string,SerializableClass::CreateFunc>();
501
502    if ((*classMap)[className])
503    {
504        cerr << "Error: simulation object class " << className << " redefined"
505             << endl;
506        fatal("");
507    }
508
509    // add className --> createFunc to class map
510    (*classMap)[className] = createFunc;
511}
512
513
514//
515//
516Serializable *
517SerializableClass::createObject(Checkpoint *cp,
518                                 const std::string &section)
519{
520    string className;
521
522    if (!cp->find(section, "type", className)) {
523        fatal("Serializable::create: no 'type' entry in section '%s'.\n",
524              section);
525    }
526
527    CreateFunc createFunc = (*classMap)[className];
528
529    if (createFunc == NULL) {
530        fatal("Serializable::create: no create function for class '%s'.\n",
531              className);
532    }
533
534    Serializable *object = createFunc(cp, section);
535
536    assert(object != NULL);
537
538    return object;
539}
540
541
542Serializable *
543Serializable::create(Checkpoint *cp, const std::string &section)
544{
545    Serializable *object = SerializableClass::createObject(cp, section);
546    object->unserialize(cp, section);
547    return object;
548}
549
550
551Checkpoint::Checkpoint(const std::string &cpt_dir, const std::string &path)
552    : db(new IniFile), basePath(path), cptDir(cpt_dir)
553{
554    string filename = cpt_dir + "/" + Checkpoint::baseFilename;
555    if (!db->load(filename)) {
556        fatal("Can't load checkpoint file '%s'\n", filename);
557    }
558}
559
560
561bool
562Checkpoint::find(const std::string &section, const std::string &entry,
563                 std::string &value)
564{
565    return db->find(section, entry, value);
566}
567
568
569bool
570Checkpoint::findObj(const std::string &section, const std::string &entry,
571                    SimObject *&value)
572{
573    string path;
574
575    if (!db->find(section, entry, path))
576        return false;
577
578    value = resolveSimObject(path);
579    return true;
580}
581
582
583bool
584Checkpoint::sectionExists(const std::string &section)
585{
586    return db->sectionExists(section);
587}
588