sim_object.cc revision 1553 
1/*
2 * Copyright (c) 2001-2004 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#include <assert.h>
30
31#include "base/callback.hh"
32#include "base/inifile.hh"
33#include "base/match.hh"
34#include "base/misc.hh"
35#include "base/trace.hh"
36#include "base/stats/events.hh"
37#include "sim/configfile.hh"
38#include "sim/host.hh"
39#include "sim/sim_object.hh"
40#include "sim/stats.hh"
41#include "sim/param.hh"
42
43using namespace std;
44
45
46////////////////////////////////////////////////////////////////////////
47//
48// SimObject member definitions
49//
50////////////////////////////////////////////////////////////////////////
51
52//
53// static list of all SimObjects, used for initialization etc.
54//
55SimObject::SimObjectList SimObject::simObjectList;
56
57namespace Stats {
58    extern ObjectMatch event_ignore;
59}
60
61//
62// SimObject constructor: used to maintain static simObjectList
63//
64SimObject::SimObject(Params *p)
65    : _params(p)
66{
67#ifdef DEBUG
68    doDebugBreak = false;
69#endif
70
71    doRecordEvent = !Stats::event_ignore.match(name());
72    simObjectList.push_back(this);
73}
74
75//
76// SimObject constructor: used to maintain static simObjectList
77//
78SimObject::SimObject(const string &_name)
79    : _params(new Params)
80{
81    _params->name = _name;
82#ifdef DEBUG
83    doDebugBreak = false;
84#endif
85
86    doRecordEvent = !Stats::event_ignore.match(name());
87    simObjectList.push_back(this);
88}
89
90void
91SimObject::init()
92{
93}
94
95//
96// no default statistics, so nothing to do in base implementation
97//
98void
99SimObject::regStats()
100{
101}
102
103void
104SimObject::regFormulas()
105{
106}
107
108void
109SimObject::resetStats()
110{
111}
112
113//
114// static function:
115//   call regStats() on all SimObjects and then regFormulas() on all
116//   SimObjects.
117//
118struct SimObjectResetCB : public Callback
119{
120    virtual void process() { SimObject::resetAllStats(); }
121};
122
123namespace {
124    static SimObjectResetCB StatResetCB;
125}
126
127void
128SimObject::regAllStats()
129{
130    SimObjectList::iterator i;
131    SimObjectList::iterator end = simObjectList.end();
132
133    /**
134     * @todo change cprintfs to DPRINTFs
135     */
136    for (i = simObjectList.begin(); i != end; ++i) {
137#ifdef STAT_DEBUG
138        cprintf("registering stats for %s\n", (*i)->name());
139#endif
140        (*i)->regStats();
141    }
142
143    for (i = simObjectList.begin(); i != end; ++i) {
144#ifdef STAT_DEBUG
145        cprintf("registering formulas for %s\n", (*i)->name());
146#endif
147        (*i)->regFormulas();
148    }
149
150    Stats::registerResetCallback(&StatResetCB);
151}
152
153//
154// static function: call init() on all SimObjects.
155//
156void
157SimObject::initAll()
158{
159    SimObjectList::iterator i = simObjectList.begin();
160    SimObjectList::iterator end = simObjectList.end();
161
162    for (; i != end; ++i) {
163        SimObject *obj = *i;
164        obj->init();
165    }
166}
167
168//
169// static function: call resetStats() on all SimObjects.
170//
171void
172SimObject::resetAllStats()
173{
174    SimObjectList::iterator i = simObjectList.begin();
175    SimObjectList::iterator end = simObjectList.end();
176
177    for (; i != end; ++i) {
178        SimObject *obj = *i;
179        obj->resetStats();
180    }
181}
182
183//
184// static function: serialize all SimObjects.
185//
186void
187SimObject::serializeAll(ostream &os)
188{
189    SimObjectList::reverse_iterator ri = simObjectList.rbegin();
190    SimObjectList::reverse_iterator rend = simObjectList.rend();
191
192    for (; ri != rend; ++ri) {
193        SimObject *obj = *ri;
194        obj->nameOut(os);
195        obj->serialize(os);
196   }
197}
198
199#ifdef DEBUG
200//
201// static function: flag which objects should have the debugger break
202//
203void
204SimObject::debugObjectBreak(const string &objs)
205{
206    SimObjectList::const_iterator i = simObjectList.begin();
207    SimObjectList::const_iterator end = simObjectList.end();
208
209    ObjectMatch match(objs);
210    for (; i != end; ++i) {
211        SimObject *obj = *i;
212        obj->doDebugBreak = match.match(obj->name());
213   }
214}
215
216extern "C"
217void
218debugObjectBreak(const char *objs)
219{
220    SimObject::debugObjectBreak(string(objs));
221}
222#endif
223
224void
225SimObject::recordEvent(const std::string &stat)
226{
227    if (doRecordEvent)
228        Stats::recordEvent(stat);
229}
230
231DEFINE_SIM_OBJECT_CLASS_NAME("SimObject", SimObject)
232