sim_object.hh revision 1127
1/* 2 * Copyright (c) 2001-2004 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/* @file 30 * User Console Definitions 31 */ 32 33#ifndef __SIM_OBJECT_HH__ 34#define __SIM_OBJECT_HH__ 35 36#include <map> 37#include <list> 38#include <vector> 39#include <iostream> 40 41#include "sim/serialize.hh" 42#include "sim/startup.hh" 43 44/* 45 * Abstract superclass for simulation objects. Represents things that 46 * correspond to physical components and can be specified via the 47 * config file (CPUs, caches, etc.). 48 */ 49class SimObject : public Serializable, protected StartupCallback 50{ 51 protected: 52 std::string objName; 53 54 private: 55 friend class Serializer; 56 57 typedef std::vector<SimObject *> SimObjectList; 58 59 // list of all instantiated simulation objects 60 static SimObjectList simObjectList; 61 62 public: 63 SimObject(const std::string &_name); 64 65 virtual ~SimObject() {} 66 67 virtual const std::string name() const { return objName; } 68 69 // initialization pass of all objects. 70 // Gets invoked after construction, before unserialize. 71 virtual void init(); 72 static void initAll(); 73 74 // register statistics for this object 75 virtual void regStats(); 76 virtual void regFormulas(); 77 virtual void resetStats(); 78 79 // static: call reg_stats on all SimObjects 80 static void regAllStats(); 81 82 // static: call resetStats on all SimObjects 83 static void resetAllStats(); 84 85 // static: call nameOut() & serialize() on all SimObjects 86 static void serializeAll(std::ostream &); 87 88#ifdef DEBUG 89 public: 90 bool doDebugBreak; 91 static void debugObjectBreak(const std::string &objs); 92#endif 93 94 public: 95 bool doRecordEvent; 96 void recordEvent(const std::string &stat); 97}; 98 99#endif // __SIM_OBJECT_HH__ 100