src/sim/sim_object.cc

   1 /*
   2  * Copyright (c) 2001-2005 The Regents of The University of Michigan
   3  * Copyright (c) 2010 Advanced Micro Devices, Inc.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are
   8  * met: redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer;
  10  * redistributions in binary form must reproduce the above copyright
  11  * notice, this list of conditions and the following disclaimer in the
  12  * documentation and/or other materials provided with the distribution;
  13  * neither the name of the copyright holders nor the names of its
  14  * contributors may be used to endorse or promote products derived from
  15  * this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  *
  29  * Authors: Steve Reinhardt
  30  *          Nathan Binkert
  31  */
  32
  33 #include <cassert>
  34
  35 #include "base/callback.hh"
  36 #include "base/inifile.hh"
  37 #include "base/match.hh"
  38 #include "base/misc.hh"
  39 #include "base/trace.hh"
  40 #include "base/types.hh"
  41 #include "debug/Checkpoint.hh"
  42 #include "sim/probe/probe.hh"
  43 #include "sim/sim_object.hh"
  44 #include "sim/stats.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 //
  61 // SimObject constructor: used to maintain static simObjectList
  62 //
  63 SimObject::SimObject(const Params *p)
  64     : EventManager(getEventQueue(p->eventq_index)), _params(p)
  65 {
  66 #ifdef DEBUG
  67     doDebugBreak = false;
  68 #endif
  69     simObjectList.push_back(this);
  70     probeManager = new ProbeManager(this);
  71 }
  72
  73 void
  74 SimObject::init()
  75 {
  76 }
  77
  78 void
  79 SimObject::loadState(Checkpoint *cp)
  80 {
  81     if (cp->sectionExists(name())) {
  82         DPRINTF(Checkpoint, "unserializing\n");
  83         unserialize(cp, name());
  84     } else {
  85         DPRINTF(Checkpoint, "no checkpoint section found\n");
  86     }
  87 }
  88
  89 void
  90 SimObject::initState()
  91 {
  92 }
  93
  94 void
  95 SimObject::startup()
  96 {
  97 }
  98
  99 //
 100 // no default statistics, so nothing to do in base implementation
 101 //
 102 void
 103 SimObject::regStats()
 104 {
 105 }
 106
 107 void
 108 SimObject::resetStats()
 109 {
 110 }
 111
 112 /**
 113  * No probe points by default, so do nothing in base.
 114  */
 115 void
 116 SimObject::regProbePoints()
 117 {
 118 }
 119
 120 /**
 121  * No probe listeners by default, so do nothing in base.
 122  */
 123 void
 124 SimObject::regProbeListeners()
 125 {
 126 }
 127
 128 ProbeManager *
 129 SimObject::getProbeManager()
 130 {
 131     return probeManager;
 132 }
 133
 134 //
 135 // static function: serialize all SimObjects.
 136 //
 137 void
 138 SimObject::serializeAll(std::ostream &os)
 139 {
 140     SimObjectList::reverse_iterator ri = simObjectList.rbegin();
 141     SimObjectList::reverse_iterator rend = simObjectList.rend();
 142
 143     for (; ri != rend; ++ri) {
 144         SimObject *obj = *ri;
 145         obj->nameOut(os);
 146         obj->serialize(os);
 147    }
 148 }
 149
 150
 151 #ifdef DEBUG
 152 //
 153 // static function: flag which objects should have the debugger break
 154 //
 155 void
 156 SimObject::debugObjectBreak(const string &objs)
 157 {
 158     SimObjectList::const_iterator i = simObjectList.begin();
 159     SimObjectList::const_iterator end = simObjectList.end();
 160
 161     ObjectMatch match(objs);
 162     for (; i != end; ++i) {
 163         SimObject *obj = *i;
 164         obj->doDebugBreak = match.match(obj->name());
 165    }
 166 }
 167
 168 void
 169 debugObjectBreak(const char *objs)
 170 {
 171     SimObject::debugObjectBreak(string(objs));
 172 }
 173 #endif
 174
 175 unsigned int
 176 SimObject::drain(DrainManager *drain_manager)
 177 {
 178     setDrainState(Drained);
 179     return 0;
 180 }
 181
 182
 183 SimObject *
 184 SimObject::find(const char *name)
 185 {
 186     SimObjectList::const_iterator i = simObjectList.begin();
 187     SimObjectList::const_iterator end = simObjectList.end();
 188
 189     for (; i != end; ++i) {
 190         SimObject *obj = *i;
 191         if (obj->name() == name)
 192             return obj;
 193     }
 194
 195     return NULL;
 196 }