sim_object.hh revision 395
1/* 2 * Copyright (c) 2003 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 43/* 44 * Abstract superclass for simulation objects. Represents things that 45 * correspond to physical components and can be specified via the 46 * config file (CPUs, caches, etc.). 47 */ 48class SimObject : public Serializable 49{ 50 protected: 51 std::string objName; 52 53 private: 54 friend class Serializer; 55 56 typedef std::vector<SimObject *> SimObjectList; 57 58 // list of all instantiated simulation objects 59 static SimObjectList simObjectList; 60 61 public: 62 SimObject(const std::string &_name); 63 64 virtual ~SimObject() {} 65 66 virtual std::string name() const { return objName; } 67 68 // register statistics for this object 69 virtual void regStats(); 70 virtual void regFormulas(); 71 virtual void resetStats(); 72 73 // print extra results for this object not covered by registered 74 // statistics (called at end of simulation) 75 virtual void printExtraOutput(std::ostream&); 76 77 // static: call reg_stats on all SimObjects 78 static void regAllStats(); 79 80 // static: call resetStats on all SimObjects 81 static void resetAllStats(); 82 83 // static: call printExtraOutput on all SimObjects 84 static void printAllExtraOutput(std::ostream&); 85 86 // static: call nameOut() & serialize() on all SimObjects 87 static void serializeAll(std::ostream &); 88}; 89 90#endif // __SIM_OBJECT_HH__ 91