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 SimObject::~SimObject()
  74 {
  75     delete probeManager;
  76 }
  77
  78 void
  79 SimObject::init()
  80 {
  81 }
  82
  83 void
  84 SimObject::loadState(Checkpoint *cp)
  85 {
  86     if (cp->sectionExists(name())) {
  87         DPRINTF(Checkpoint, "unserializing\n");
  88         unserialize(cp, name());
  89     } else {
  90         DPRINTF(Checkpoint, "no checkpoint section found\n");
  91     }
  92 }
  93
  94 void
  95 SimObject::initState()
  96 {
  97 }
  98
  99 void
 100 SimObject::startup()
 101 {
 102 }
 103
 104 //
 105 // no default statistics, so nothing to do in base implementation
 106 //
 107 void
 108 SimObject::regStats()
 109 {
 110 }
 111
 112 void
 113 SimObject::resetStats()
 114 {
 115 }
 116
 117 /**
 118  * No probe points by default, so do nothing in base.
 119  */
 120 void
 121 SimObject::regProbePoints()
 122 {
 123 }
 124
 125 /**
 126  * No probe listeners by default, so do nothing in base.
 127  */
 128 void
 129 SimObject::regProbeListeners()
 130 {
 131 }
 132
 133 ProbeManager *
 134 SimObject::getProbeManager()
 135 {
 136     return probeManager;
 137 }
 138
 139 //
 140 // static function: serialize all SimObjects.
 141 //
 142 void
 143 SimObject::serializeAll(std::ostream &os)
 144 {
 145     SimObjectList::reverse_iterator ri = simObjectList.rbegin();
 146     SimObjectList::reverse_iterator rend = simObjectList.rend();
 147
 148     for (; ri != rend; ++ri) {
 149         SimObject *obj = *ri;
 150         obj->nameOut(os);
 151         obj->serialize(os);
 152    }
 153 }
 154
 155
 156 #ifdef DEBUG
 157 //
 158 // static function: flag which objects should have the debugger break
 159 //
 160 void
 161 SimObject::debugObjectBreak(const string &objs)
 162 {
 163     SimObjectList::const_iterator i = simObjectList.begin();
 164     SimObjectList::const_iterator end = simObjectList.end();
 165
 166     ObjectMatch match(objs);
 167     for (; i != end; ++i) {
 168         SimObject *obj = *i;
 169         obj->doDebugBreak = match.match(obj->name());
 170    }
 171 }
 172
 173 void
 174 debugObjectBreak(const char *objs)
 175 {
 176     SimObject::debugObjectBreak(string(objs));
 177 }
 178 #endif
 179
 180 unsigned int
 181 SimObject::drain(DrainManager *drain_manager)
 182 {
 183     setDrainState(Drained);
 184     return 0;
 185 }
 186
 187
 188 SimObject *
 189 SimObject::find(const char *name)
 190 {
 191     SimObjectList::const_iterator i = simObjectList.begin();
 192     SimObjectList::const_iterator end = simObjectList.end();
 193
 194     for (; i != end; ++i) {
 195         SimObject *obj = *i;
 196         if (obj->name() == name)
 197             return obj;
 198     }
 199
 200     return NULL;
 201 }