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 <cassert>
  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/types.hh"
  40 #include "sim/sim_object.hh"
  41 #include "sim/stats.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 //
  58 // SimObject constructor: used to maintain static simObjectList
  59 //
  60 SimObject::SimObject(const Params *p)
  61     : EventManager(p->eventq), _params(p)
  62 {
  63 #ifdef DEBUG
  64     doDebugBreak = false;
  65 #endif
  66
  67     simObjectList.push_back(this);
  68     state = Running;
  69 }
  70
  71 void
  72 SimObject::init()
  73 {
  74 }
  75
  76 void
  77 SimObject::loadState(Checkpoint *cp)
  78 {
  79     if (cp->sectionExists(name()))
  80         unserialize(cp, name());
  81 }
  82
  83 void
  84 SimObject::initState()
  85 {
  86 }
  87
  88 void
  89 SimObject::startup()
  90 {
  91 }
  92
  93 //
  94 // no default statistics, so nothing to do in base implementation
  95 //
  96 void
  97 SimObject::regStats()
  98 {
  99 }
 100
 101 void
 102 SimObject::regFormulas()
 103 {
 104 }
 105
 106 void
 107 SimObject::resetStats()
 108 {
 109 }
 110
 111 //
 112 // static function: serialize all SimObjects.
 113 //
 114 void
 115 SimObject::serializeAll(ostream &os)
 116 {
 117     SimObjectList::reverse_iterator ri = simObjectList.rbegin();
 118     SimObjectList::reverse_iterator rend = simObjectList.rend();
 119
 120     for (; ri != rend; ++ri) {
 121         SimObject *obj = *ri;
 122         obj->nameOut(os);
 123         obj->serialize(os);
 124    }
 125 }
 126
 127 void
 128 SimObject::unserializeAll(Checkpoint *cp)
 129 {
 130     SimObjectList::reverse_iterator ri = simObjectList.rbegin();
 131     SimObjectList::reverse_iterator rend = simObjectList.rend();
 132
 133     for (; ri != rend; ++ri) {
 134         SimObject *obj = *ri;
 135         DPRINTFR(Config, "Unserializing '%s'\n",
 136                  obj->name());
 137         if(cp->sectionExists(obj->name()))
 138             obj->unserialize(cp, obj->name());
 139         else
 140             warn("Not unserializing '%s': no section found in checkpoint.\n",
 141                  obj->name());
 142    }
 143 }
 144
 145
 146
 147 #ifdef DEBUG
 148 //
 149 // static function: flag which objects should have the debugger break
 150 //
 151 void
 152 SimObject::debugObjectBreak(const string &objs)
 153 {
 154     SimObjectList::const_iterator i = simObjectList.begin();
 155     SimObjectList::const_iterator end = simObjectList.end();
 156
 157     ObjectMatch match(objs);
 158     for (; i != end; ++i) {
 159         SimObject *obj = *i;
 160         obj->doDebugBreak = match.match(obj->name());
 161    }
 162 }
 163
 164 void
 165 debugObjectBreak(const char *objs)
 166 {
 167     SimObject::debugObjectBreak(string(objs));
 168 }
 169 #endif
 170
 171 unsigned int
 172 SimObject::drain(Event *drain_event)
 173 {
 174     state = Drained;
 175     return 0;
 176 }
 177
 178 void
 179 SimObject::resume()
 180 {
 181     state = Running;
 182 }
 183
 184 void
 185 SimObject::setMemoryMode(State new_mode)
 186 {
 187     panic("setMemoryMode() should only be called on systems");
 188 }
 189
 190 void
 191 SimObject::switchOut()
 192 {
 193     panic("Unimplemented!");
 194 }
 195
 196 void
 197 SimObject::takeOverFrom(BaseCPU *cpu)
 198 {
 199     panic("Unimplemented!");
 200 }
 201
 202
 203 SimObject *
 204 SimObject::find(const char *name)
 205 {
 206     SimObjectList::const_iterator i = simObjectList.begin();
 207     SimObjectList::const_iterator end = simObjectList.end();
 208
 209     for (; i != end; ++i) {
 210         SimObject *obj = *i;
 211         if (obj->name() == name)
 212             return obj;
 213     }
 214
 215     return NULL;
 216 }