sim_object.hh revision 2901:f9a45473ab55 
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 * Authors: Steve Reinhardt
29 *          Nathan Binkert
30 */
31
32/* @file
33 * User Console Definitions
34 */
35
36#ifndef __SIM_OBJECT_HH__
37#define __SIM_OBJECT_HH__
38
39#include <map>
40#include <list>
41#include <vector>
42#include <iostream>
43
44#include "sim/serialize.hh"
45#include "sim/startup.hh"
46
47class BaseCPU;
48class Event;
49
50/*
51 * Abstract superclass for simulation objects.  Represents things that
52 * correspond to physical components and can be specified via the
53 * config file (CPUs, caches, etc.).
54 */
55class SimObject : public Serializable, protected StartupCallback
56{
57  public:
58    struct Params {
59        std::string name;
60    };
61
62    enum State {
63        Running,
64        Draining,
65        Drained
66    };
67  private:
68    State state;
69
70  protected:
71    Params *_params;
72
73    void changeState(State new_state) { state = new_state; }
74
75  public:
76    const Params *params() const { return _params; }
77
78    State getState() { return state; }
79
80  private:
81    typedef std::vector<SimObject *> SimObjectList;
82
83    // list of all instantiated simulation objects
84    static SimObjectList simObjectList;
85
86  public:
87    SimObject(Params *_params);
88    SimObject(const std::string &_name);
89
90    virtual ~SimObject() {}
91
92    virtual const std::string name() const { return params()->name; }
93
94    // initialization pass of all objects.
95    // Gets invoked after construction, before unserialize.
96    virtual void init();
97    virtual void connect();
98    static void initAll();
99    static void connectAll();
100
101    // register statistics for this object
102    virtual void regStats();
103    virtual void regFormulas();
104    virtual void resetStats();
105
106    // static: call reg_stats on all SimObjects
107    static void regAllStats();
108
109    // static: call resetStats on all SimObjects
110    static void resetAllStats();
111
112    // static: call nameOut() & serialize() on all SimObjects
113    static void serializeAll(std::ostream &);
114    static void unserializeAll(Checkpoint *cp);
115
116    // Methods to drain objects in order to take checkpoints
117    // Or switch from timing -> atomic memory model
118    // Drain returns 0 if the simobject can drain immediately or
119    // the number of times the drain_event's process function will be called
120    // before the object will be done draining. Normally this should be 1
121    virtual unsigned int drain(Event *drain_event);
122    virtual void resume();
123    virtual void setMemoryMode(State new_mode);
124    virtual void switchOut();
125    virtual void takeOverFrom(BaseCPU *cpu);
126
127#ifdef DEBUG
128  public:
129    bool doDebugBreak;
130    static void debugObjectBreak(const std::string &objs);
131#endif
132
133  public:
134    bool doRecordEvent;
135    void recordEvent(const std::string &stat);
136};
137
138#endif // __SIM_OBJECT_HH__
139