sim/sim_object.cc

   1 /*
   2  * Copyright (c) 2003 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/misc.hh"
  34 #include "base/trace.hh"
  35 #include "sim/configfile.hh"
  36 #include "sim/host.hh"
  37 #include "sim/sim_object.hh"
  38 #include "sim/sim_stats.hh"
  39
  40 using namespace std;
  41
  42
  43 ////////////////////////////////////////////////////////////////////////
  44 //
  45 // SimObject member definitions
  46 //
  47 ////////////////////////////////////////////////////////////////////////
  48
  49 //
  50 // static list of all SimObjects, used for initialization etc.
  51 //
  52 SimObject::SimObjectList SimObject::simObjectList;
  53
  54 //
  55 // SimObject constructor: used to maintain static simObjectList
  56 //
  57 SimObject::SimObject(const string &_name)
  58     : objName(_name)
  59 {
  60     simObjectList.push_back(this);
  61 }
  62
  63 void
  64 SimObject::init()
  65 {
  66 }
  67
  68 //
  69 // no default statistics, so nothing to do in base implementation
  70 //
  71 void
  72 SimObject::regStats()
  73 {
  74 }
  75
  76 void
  77 SimObject::regFormulas()
  78 {
  79 }
  80
  81 void
  82 SimObject::resetStats()
  83 {
  84 }
  85
  86 //
  87 // no default extra output
  88 //
  89 void
  90 SimObject::printExtraOutput(ostream &os)
  91 {
  92 }
  93
  94 //
  95 // static function:
  96 //   call regStats() on all SimObjects and then regFormulas() on all
  97 //   SimObjects.
  98 //
  99 struct SimObjectResetCB : public Callback
 100 {
 101     virtual void process() { SimObject::resetAllStats(); }
 102 };
 103
 104 namespace {
 105     static SimObjectResetCB StatResetCB;
 106 }
 107
 108 void
 109 SimObject::regAllStats()
 110 {
 111     SimObjectList::iterator i;
 112     SimObjectList::iterator end = simObjectList.end();
 113
 114     /**
 115      * @todo change cprintfs to DPRINTFs
 116      */
 117     for (i = simObjectList.begin(); i != end; ++i) {
 118 #ifdef STAT_DEBUG
 119         cprintf("registering stats for %s\n", (*i)->name());
 120 #endif
 121         (*i)->regStats();
 122     }
 123
 124     for (i = simObjectList.begin(); i != end; ++i) {
 125 #ifdef STAT_DEBUG
 126         cprintf("registering formulas for %s\n", (*i)->name());
 127 #endif
 128         (*i)->regFormulas();
 129     }
 130
 131     Statistics::registerResetCallback(&StatResetCB);
 132 }
 133
 134 //
 135 // static function: call init() on all SimObjects.
 136 //
 137 void
 138 SimObject::initAll()
 139 {
 140     SimObjectList::iterator i = simObjectList.begin();
 141     SimObjectList::iterator end = simObjectList.end();
 142
 143     for (; i != end; ++i) {
 144         SimObject *obj = *i;
 145         obj->init();
 146     }
 147 }
 148
 149 //
 150 // static function: call resetStats() on all SimObjects.
 151 //
 152 void
 153 SimObject::resetAllStats()
 154 {
 155     SimObjectList::iterator i = simObjectList.begin();
 156     SimObjectList::iterator end = simObjectList.end();
 157
 158     for (; i != end; ++i) {
 159         SimObject *obj = *i;
 160         obj->resetStats();
 161     }
 162 }
 163
 164 //
 165 // static function: call printExtraOutput() on all SimObjects.
 166 //
 167 void
 168 SimObject::printAllExtraOutput(ostream &os)
 169 {
 170     SimObjectList::iterator i = simObjectList.begin();
 171     SimObjectList::iterator end = simObjectList.end();
 172
 173     for (; i != end; ++i) {
 174         SimObject *obj = *i;
 175         obj->printExtraOutput(os);
 176    }
 177 }
 178
 179 //
 180 // static function: serialize all SimObjects.
 181 //
 182 void
 183 SimObject::serializeAll(ostream &os)
 184 {
 185     SimObjectList::reverse_iterator ri = simObjectList.rbegin();
 186     SimObjectList::reverse_iterator rend = simObjectList.rend();
 187
 188     for (; ri != rend; ++ri) {
 189         SimObject *obj = *ri;
 190         obj->nameOut(os);
 191         obj->serialize(os);
 192    }
 193 }