sim_object.hh revision 2632:1bb2f91485ea 
1/*
2 * Copyright (c) 2001-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
29/* @file
30 * User Console Definitions
31 */
32
33#ifndef __SIM_OBJECT_HH__
34#define __SIM_OBJECT_HH__
35
36#include <map>
37#include <list>
38#include <vector>
39#include <iostream>
40
41#include "sim/serialize.hh"
42#include "sim/startup.hh"
43
44class Serializer;
45
46/*
47 * Abstract superclass for simulation objects.  Represents things that
48 * correspond to physical components and can be specified via the
49 * config file (CPUs, caches, etc.).
50 */
51class SimObject : public Serializable, protected StartupCallback
52{
53  public:
54    struct Params {
55        std::string name;
56    };
57
58  protected:
59    Params *_params;
60
61  public:
62    const Params *params() const { return _params; }
63
64  private:
65    friend class Serializer;
66
67    typedef std::vector<SimObject *> SimObjectList;
68
69    // list of all instantiated simulation objects
70    static SimObjectList simObjectList;
71
72  public:
73    SimObject(Params *_params);
74    SimObject(const std::string &_name);
75
76    virtual ~SimObject() {}
77
78    virtual const std::string name() const { return params()->name; }
79
80    // initialization pass of all objects.
81    // Gets invoked after construction, before unserialize.
82    virtual void init();
83    virtual void connect();
84    static void initAll();
85    static void connectAll();
86
87    // register statistics for this object
88    virtual void regStats();
89    virtual void regFormulas();
90    virtual void resetStats();
91
92    // static: call reg_stats on all SimObjects
93    static void regAllStats();
94
95    // static: call resetStats on all SimObjects
96    static void resetAllStats();
97
98    // static: call nameOut() & serialize() on all SimObjects
99    static void serializeAll(std::ostream &);
100
101    // Methods to drain objects in order to take checkpoints
102    // Or switch from timing -> atomic memory model
103    virtual void drain(Serializer *serializer);
104    virtual void resume() { return;} ;
105    virtual void serializationComplete()
106    { assert(0 && "Unimplemented"); };
107
108#ifdef DEBUG
109  public:
110    bool doDebugBreak;
111    static void debugObjectBreak(const std::string &objs);
112#endif
113
114  public:
115    bool doRecordEvent;
116    void recordEvent(const std::string &stat);
117};
118
119#endif // __SIM_OBJECT_HH__
120