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(float)
355INSTANTIATE_PARAM_TEMPLATES(double)
356INSTANTIATE_PARAM_TEMPLATES(string)
357
358
359/////////////////////////////
360
361/// Container for serializing global variables (not associated with
362/// any serialized object).
363class Globals : public Serializable
364{
365 public:
366 const string name() const;
367 void serialize(ostream &os);
368 void unserialize(Checkpoint *cp);
369};
370
371/// The one and only instance of the Globals class.
372Globals globals;
373
374const string
375Globals::name() const
376{
377 return "Globals";
378}
379
380void
381Globals::serialize(ostream &os)
382{
383 nameOut(os);
384 SERIALIZE_SCALAR(curTick);
385
386 nameOut(os, "MainEventQueue");
387 mainEventQueue.serialize(os);
388}
389
390void
391Globals::unserialize(Checkpoint *cp)
392{
393 const string &section = name();
394 UNSERIALIZE_SCALAR(curTick);
395
396 mainEventQueue.unserialize(cp, "MainEventQueue");
397}
398
399Serializable::Serializable()
400{
401}
402
403Serializable::~Serializable()
404{
405}
406
407void
408Serializable::serialize(std::ostream &os)
409{
410}
411
412void
413Serializable::unserialize(Checkpoint *cp, const std::string &section)
414{
415}
416
417void
418Serializable::serializeAll(const std::string &cpt_dir)
419{
420 setCheckpointDir(cpt_dir);
421 string dir = Checkpoint::dir();
422 if (mkdir(dir.c_str(), 0775) == -1 && errno != EEXIST)
423 fatal("couldn't mkdir %s\n", dir);
424
425 string cpt_file = dir + Checkpoint::baseFilename;
426 ofstream outstream(cpt_file.c_str());
427 time_t t = time(NULL);
428 if (!outstream.is_open())
429 fatal("Unable to open file %s for writing\n", cpt_file.c_str());
430 outstream << "// checkpoint generated: " << ctime(&t);
431
432 globals.serialize(outstream);
433 SimObject::serializeAll(outstream);
434}
435
436void
437Serializable::unserializeAll(const std::string &cpt_dir)
438{
439 setCheckpointDir(cpt_dir);
440 string dir = Checkpoint::dir();
441 string cpt_file = dir + Checkpoint::baseFilename;
442 string section = "";
443
444 DPRINTFR(Config, "Loading checkpoint dir '%s'\n",
445 dir);
446 Checkpoint *cp = new Checkpoint(dir, section);
447 unserializeGlobals(cp);
448 SimObject::unserializeAll(cp);
449}
450
451void
452Serializable::unserializeGlobals(Checkpoint *cp)
453{
454 globals.unserialize(cp);
455}
456
457const char *Checkpoint::baseFilename = "m5.cpt";
458
459static string checkpointDirBase;
460
461void
462setCheckpointDir(const std::string &name)
463{
464 checkpointDirBase = name;
465 if (checkpointDirBase[checkpointDirBase.size() - 1] != '/')
466 checkpointDirBase += "/";
467}
468
469string
470Checkpoint::dir()
471{
472 // use csprintf to insert curTick into directory name if it
473 // appears to have a format placeholder in it.
474 return (checkpointDirBase.find("%") != string::npos) ?
475 csprintf(checkpointDirBase, curTick) : checkpointDirBase;
476}
477
478void
479debug_serialize(const std::string &cpt_dir)
480{
481 Serializable::serializeAll(cpt_dir);
482}
483
484
485////////////////////////////////////////////////////////////////////////
486//
487// SerializableClass member definitions
488//
489////////////////////////////////////////////////////////////////////////
490
491// Map of class names to SerializableBuilder creation functions.
492// Need to make this a pointer so we can force initialization on the
493// first reference; otherwise, some SerializableClass constructors
494// may be invoked before the classMap constructor.
495map *SerializableClass::classMap = 0;
496
497// SerializableClass constructor: add mapping to classMap
498SerializableClass::SerializableClass(const string &className,
499 CreateFunc createFunc)
500{
501 if (classMap == NULL)
502 classMap = new map();
503
504 if ((*classMap)[className])
505 {
506 cerr << "Error: simulation object class " << className << " redefined"
507 << endl;
508 fatal("");
509 }
510
511 // add className --> createFunc to class map
512 (*classMap)[className] = createFunc;
513}
514
515
516//
517//
518Serializable *
519SerializableClass::createObject(Checkpoint *cp,
520 const std::string &section)
521{
522 string className;
523
524 if (!cp->find(section, "type", className)) {
525 fatal("Serializable::create: no 'type' entry in section '%s'.\n",
526 section);
527 }
528
529 CreateFunc createFunc = (*classMap)[className];
530
531 if (createFunc == NULL) {
532 fatal("Serializable::create: no create function for class '%s'.\n",
533 className);
534 }
535
536 Serializable *object = createFunc(cp, section);
537
538 assert(object != NULL);
539
540 return object;
541}
542
543
544Serializable *
545Serializable::create(Checkpoint *cp, const std::string &section)
546{
547 Serializable *object = SerializableClass::createObject(cp, section);
548 object->unserialize(cp, section);
549 return object;
550}
551
552
553Checkpoint::Checkpoint(const std::string &cpt_dir, const std::string &path)
554 : db(new IniFile), basePath(path), cptDir(cpt_dir)
555{
556 string filename = cpt_dir + "/" + Checkpoint::baseFilename;
557 if (!db->load(filename)) {
558 fatal("Can't load checkpoint file '%s'\n", filename);
559 }
560}
561
562
563bool
564Checkpoint::find(const std::string &section, const std::string &entry,
565 std::string &value)
566{
567 return db->find(section, entry, value);
568}
569
570
571bool
572Checkpoint::findObj(const std::string &section, const std::string &entry,
573 SimObject *&value)
574{
575 string path;
576
577 if (!db->find(section, entry, path))
578 return false;
579
580 value = resolveSimObject(path);
581 return true;
582}
583
584
585bool
586Checkpoint::sectionExists(const std::string &section)
587{
588 return db->sectionExists(section);
589}