sim/sim_object.cc

   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
  43 using 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 //
  55 SimObject::SimObjectList SimObject::simObjectList;
  56
  57 namespace Stats {
  58     extern ObjectMatch event_ignore;
  59 }
  60
  61 //
  62 // SimObject constructor: used to maintain static simObjectList
  63 //
  64 SimObject::SimObject(const string &_name)
  65     : objName(_name)
  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 void
  76 SimObject::init()
  77 {
  78 }
  79
  80 //
  81 // no default statistics, so nothing to do in base implementation
  82 //
  83 void
  84 SimObject::regStats()
  85 {
  86 }
  87
  88 void
  89 SimObject::regFormulas()
  90 {
  91 }
  92
  93 void
  94 SimObject::resetStats()
  95 {
  96 }
  97
  98 //
  99 // static function:
 100 //   call regStats() on all SimObjects and then regFormulas() on all
 101 //   SimObjects.
 102 //
 103 struct SimObjectResetCB : public Callback
 104 {
 105     virtual void process() { SimObject::resetAllStats(); }
 106 };
 107
 108 namespace {
 109     static SimObjectResetCB StatResetCB;
 110 }
 111
 112 void
 113 SimObject::regAllStats()
 114 {
 115     SimObjectList::iterator i;
 116     SimObjectList::iterator end = simObjectList.end();
 117
 118     /**
 119      * @todo change cprintfs to DPRINTFs
 120      */
 121     for (i = simObjectList.begin(); i != end; ++i) {
 122 #ifdef STAT_DEBUG
 123         cprintf("registering stats for %s\n", (*i)->name());
 124 #endif
 125         (*i)->regStats();
 126     }
 127
 128     for (i = simObjectList.begin(); i != end; ++i) {
 129 #ifdef STAT_DEBUG
 130         cprintf("registering formulas for %s\n", (*i)->name());
 131 #endif
 132         (*i)->regFormulas();
 133     }
 134
 135     Stats::registerResetCallback(&StatResetCB);
 136 }
 137
 138 //
 139 // static function: call init() on all SimObjects.
 140 //
 141 void
 142 SimObject::initAll()
 143 {
 144     SimObjectList::iterator i = simObjectList.begin();
 145     SimObjectList::iterator end = simObjectList.end();
 146
 147     for (; i != end; ++i) {
 148         SimObject *obj = *i;
 149         obj->init();
 150     }
 151 }
 152
 153 //
 154 // static function: call resetStats() on all SimObjects.
 155 //
 156 void
 157 SimObject::resetAllStats()
 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->resetStats();
 165     }
 166 }
 167
 168 //
 169 // static function: serialize all SimObjects.
 170 //
 171 void
 172 SimObject::serializeAll(ostream &os)
 173 {
 174     SimObjectList::reverse_iterator ri = simObjectList.rbegin();
 175     SimObjectList::reverse_iterator rend = simObjectList.rend();
 176
 177     for (; ri != rend; ++ri) {
 178         SimObject *obj = *ri;
 179         obj->nameOut(os);
 180         obj->serialize(os);
 181    }
 182 }
 183
 184 #ifdef DEBUG
 185 //
 186 // static function: flag which objects should have the debugger break
 187 //
 188 void
 189 SimObject::debugObjectBreak(const string &objs)
 190 {
 191     SimObjectList::const_iterator i = simObjectList.begin();
 192     SimObjectList::const_iterator end = simObjectList.end();
 193
 194     ObjectMatch match(objs);
 195     for (; i != end; ++i) {
 196         SimObject *obj = *i;
 197         obj->doDebugBreak = match.match(obj->name());
 198    }
 199 }
 200
 201 extern "C"
 202 void
 203 debugObjectBreak(const char *objs)
 204 {
 205     SimObject::debugObjectBreak(string(objs));
 206 }
 207 #endif
 208
 209 void
 210 SimObject::recordEvent(const std::string &stat)
 211 {
 212     if (doRecordEvent)
 213         Stats::recordEvent(stat);
 214 }
 215
 216 DEFINE_SIM_OBJECT_CLASS_NAME("SimObject", SimObject)