src/sim/sim_object.cc

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