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/sim_object.hh"
  43 #include "sim/stats.hh"
  44
  45 using namespace std;
  46
  47
  48 ////////////////////////////////////////////////////////////////////////
  49 //
  50 // SimObject member definitions
  51 //
  52 ////////////////////////////////////////////////////////////////////////
  53
  54 //
  55 // static list of all SimObjects, used for initialization etc.
  56 //
  57 SimObject::SimObjectList SimObject::simObjectList;
  58
  59 //
  60 // SimObject constructor: used to maintain static simObjectList
  61 //
  62 SimObject::SimObject(const Params *p)
  63     : EventManager(p->eventq), _params(p)
  64 {
  65 #ifdef DEBUG
  66     doDebugBreak = false;
  67 #endif
  68
  69     simObjectList.push_back(this);
  70 }
  71
  72 void
  73 SimObject::init()
  74 {
  75 }
  76
  77 void
  78 SimObject::loadState(Checkpoint *cp)
  79 {
  80     if (cp->sectionExists(name())) {
  81         DPRINTF(Checkpoint, "unserializing\n");
  82         unserialize(cp, name());
  83     } else {
  84         DPRINTF(Checkpoint, "no checkpoint section found\n");
  85     }
  86 }
  87
  88 void
  89 SimObject::initState()
  90 {
  91 }
  92
  93 void
  94 SimObject::startup()
  95 {
  96 }
  97
  98 //
  99 // no default statistics, so nothing to do in base implementation
 100 //
 101 void
 102 SimObject::regStats()
 103 {
 104 }
 105
 106 void
 107 SimObject::resetStats()
 108 {
 109 }
 110
 111 //
 112 // static function: serialize all SimObjects.
 113 //
 114 void
 115 SimObject::serializeAll(std::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
 128 #ifdef DEBUG
 129 //
 130 // static function: flag which objects should have the debugger break
 131 //
 132 void
 133 SimObject::debugObjectBreak(const string &objs)
 134 {
 135     SimObjectList::const_iterator i = simObjectList.begin();
 136     SimObjectList::const_iterator end = simObjectList.end();
 137
 138     ObjectMatch match(objs);
 139     for (; i != end; ++i) {
 140         SimObject *obj = *i;
 141         obj->doDebugBreak = match.match(obj->name());
 142    }
 143 }
 144
 145 void
 146 debugObjectBreak(const char *objs)
 147 {
 148     SimObject::debugObjectBreak(string(objs));
 149 }
 150 #endif
 151
 152 unsigned int
 153 SimObject::drain(DrainManager *drain_manager)
 154 {
 155     setDrainState(Drained);
 156     return 0;
 157 }
 158
 159
 160 SimObject *
 161 SimObject::find(const char *name)
 162 {
 163     SimObjectList::const_iterator i = simObjectList.begin();
 164     SimObjectList::const_iterator end = simObjectList.end();
 165
 166     for (; i != end; ++i) {
 167         SimObject *obj = *i;
 168         if (obj->name() == name)
 169             return obj;
 170     }
 171
 172     return NULL;
 173 }