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 <iostream>
40#include <list>
41#include <map>
42#include <string>
43#include <vector>
44
45#include "params/SimObject.hh"
46#include "sim/serialize.hh"
47#include "sim/startup.hh"
48
49class BaseCPU;
50class Event;
51
52/*
53 * Abstract superclass for simulation objects. Represents things that
54 * correspond to physical components and can be specified via the
55 * config file (CPUs, caches, etc.).
56 */
57class SimObject : public Serializable, protected StartupCallback
58{
59 public:
60 enum State {
61 Running,
62 Draining,
63 Drained
64 };
65
66 private:
67 State state;
68
69 protected:
70 void changeState(State new_state) { state = new_state; }
71
72 public:
73 State getState() { return state; }
74
75 private:
76 typedef std::vector<SimObject *> SimObjectList;
77
78 // list of all instantiated simulation objects
79 static SimObjectList simObjectList;
80
81 protected:
82 const SimObjectParams *_params;
83
84 public:
85 typedef SimObjectParams Params;
86 const Params *params() const { return _params; }
87 SimObject(const Params *_params);
88 virtual ~SimObject() {}
89
90 public:
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 static void initAll();
98
99 // register statistics for this object
100 virtual void regStats();
101 virtual void regFormulas();
102 virtual void resetStats();
103
104 // static: call reg_stats on all SimObjects
105 static void regAllStats();
106
107 // static: call resetStats on all SimObjects
108 static void resetAllStats();
109
110 // static: call nameOut() & serialize() on all SimObjects
111 static void serializeAll(std::ostream &);
112 static void unserializeAll(Checkpoint *cp);
113
114 // Methods to drain objects in order to take checkpoints
115 // Or switch from timing -> atomic memory model
116 // Drain returns 0 if the simobject can drain immediately or
117 // the number of times the drain_event's process function will be called
118 // before the object will be done draining. Normally this should be 1
119 virtual unsigned int drain(Event *drain_event);
120 virtual void resume();
121 virtual void setMemoryMode(State new_mode);
122 virtual void switchOut();
123 virtual void takeOverFrom(BaseCPU *cpu);
124
125#ifdef DEBUG
126 public:
127 bool doDebugBreak;
128 static void debugObjectBreak(const std::string &objs);
129#endif
130
131 /**
132 * Find the SimObject with the given name and return a pointer to
133 * it. Primarily used for interactive debugging. Argument is
134 * char* rather than std::string to make it callable from gdb.
135 */
136 static SimObject *find(const char *name);
137
138 public:
139 void recordEvent(const std::string &stat);
140};
141
142#endif // __SIM_OBJECT_HH__