sim_object.hh revision 7532
12SN/A/* 21762SN/A * Copyright (c) 2001-2005 The Regents of The University of Michigan 32SN/A * All rights reserved. 42SN/A * 52SN/A * Redistribution and use in source and binary forms, with or without 62SN/A * modification, are permitted provided that the following conditions are 72SN/A * met: redistributions of source code must retain the above copyright 82SN/A * notice, this list of conditions and the following disclaimer; 92SN/A * redistributions in binary form must reproduce the above copyright 102SN/A * notice, this list of conditions and the following disclaimer in the 112SN/A * documentation and/or other materials provided with the distribution; 122SN/A * neither the name of the copyright holders nor the names of its 132SN/A * contributors may be used to endorse or promote products derived from 142SN/A * this software without specific prior written permission. 152SN/A * 162SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 172SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 182SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 192SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 202SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 212SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 222SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 232SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 242SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 252SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 262SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 272665Ssaidi@eecs.umich.edu * 282665Ssaidi@eecs.umich.edu * Authors: Steve Reinhardt 292665Ssaidi@eecs.umich.edu * Nathan Binkert 302SN/A */ 312SN/A 322SN/A/* @file 332SN/A * User Console Definitions 342SN/A */ 352SN/A 362SN/A#ifndef __SIM_OBJECT_HH__ 372SN/A#define __SIM_OBJECT_HH__ 382SN/A 395491Sgblack@eecs.umich.edu#include <iostream> 405491Sgblack@eecs.umich.edu#include <list> 412SN/A#include <map> 425491Sgblack@eecs.umich.edu#include <string> 432SN/A#include <vector> 442SN/A 454762Snate@binkert.org#include "params/SimObject.hh" 465605Snate@binkert.org#include "sim/eventq.hh" 4756SN/A#include "sim/serialize.hh" 482SN/A 492797Sktlim@umich.educlass BaseCPU; 502797Sktlim@umich.educlass Event; 512609SN/A 522SN/A/* 532SN/A * Abstract superclass for simulation objects. Represents things that 542SN/A * correspond to physical components and can be specified via the 552SN/A * config file (CPUs, caches, etc.). 562SN/A */ 577492Ssteve.reinhardt@amd.comclass SimObject : public EventManager, public Serializable 582SN/A{ 591553SN/A public: 602797Sktlim@umich.edu enum State { 612901Ssaidi@eecs.umich.edu Running, 622839Sktlim@umich.edu Draining, 632901Ssaidi@eecs.umich.edu Drained 642797Sktlim@umich.edu }; 653202Shsul@eecs.umich.edu 662901Ssaidi@eecs.umich.edu private: 672901Ssaidi@eecs.umich.edu State state; 682797Sktlim@umich.edu 69265SN/A protected: 702797Sktlim@umich.edu void changeState(State new_state) { state = new_state; } 711553SN/A 721553SN/A public: 732797Sktlim@umich.edu State getState() { return state; } 742797Sktlim@umich.edu 752SN/A private: 762SN/A typedef std::vector<SimObject *> SimObjectList; 772SN/A 782SN/A // list of all instantiated simulation objects 792SN/A static SimObjectList simObjectList; 802SN/A 814762Snate@binkert.org protected: 824762Snate@binkert.org const SimObjectParams *_params; 834762Snate@binkert.org 842SN/A public: 854762Snate@binkert.org typedef SimObjectParams Params; 864762Snate@binkert.org const Params *params() const { return _params; } 874762Snate@binkert.org SimObject(const Params *_params); 882SN/A virtual ~SimObject() {} 892SN/A 905034Smilesck@eecs.umich.edu public: 915034Smilesck@eecs.umich.edu 921553SN/A virtual const std::string name() const { return params()->name; } 93265SN/A 947532Ssteve.reinhardt@amd.com // The following SimObject initialization methods are called from 957532Ssteve.reinhardt@amd.com // the instantiate() method in src/python/m5/simulate.py. See 967532Ssteve.reinhardt@amd.com // that function for details on how/when these methods are 977532Ssteve.reinhardt@amd.com // invoked. 987532Ssteve.reinhardt@amd.com 997532Ssteve.reinhardt@amd.com /** 1007532Ssteve.reinhardt@amd.com * init() is called after all C++ SimObjects have been created and 1017532Ssteve.reinhardt@amd.com * all ports are connected. Initializations that are independent 1027532Ssteve.reinhardt@amd.com * of unserialization but rely on a fully instantiated and 1037532Ssteve.reinhardt@amd.com * connected SimObject graph should be done here. 1047532Ssteve.reinhardt@amd.com */ 105465SN/A virtual void init(); 106465SN/A 1077532Ssteve.reinhardt@amd.com /** 1087532Ssteve.reinhardt@amd.com * loadState() is called on each SimObject when restoring from a 1097532Ssteve.reinhardt@amd.com * checkpoint. The default implementation simply calls 1107532Ssteve.reinhardt@amd.com * unserialize() if there is a corresponding section in the 1117532Ssteve.reinhardt@amd.com * checkpoint. However, objects can override loadState() to get 1127532Ssteve.reinhardt@amd.com * other behaviors, e.g., doing other programmed initializations 1137532Ssteve.reinhardt@amd.com * after unserialize(), or complaining if no checkpoint section is 1147532Ssteve.reinhardt@amd.com * found. 1157532Ssteve.reinhardt@amd.com */ 1167532Ssteve.reinhardt@amd.com virtual void loadState(Checkpoint *cp); 1177532Ssteve.reinhardt@amd.com 1187532Ssteve.reinhardt@amd.com /** 1197532Ssteve.reinhardt@amd.com * initState() is called on each SimObject when *not* restoring 1207532Ssteve.reinhardt@amd.com * from a checkpoint. This provides a hook for state 1217532Ssteve.reinhardt@amd.com * initializations that are only required for a "cold start". 1227532Ssteve.reinhardt@amd.com */ 1237532Ssteve.reinhardt@amd.com virtual void initState(); 1247532Ssteve.reinhardt@amd.com 1252SN/A // register statistics for this object 1262SN/A virtual void regStats(); 1272SN/A virtual void regFormulas(); 128330SN/A virtual void resetStats(); 1292SN/A 1307532Ssteve.reinhardt@amd.com /** 1317532Ssteve.reinhardt@amd.com * startup() is the final initialization call before simulation. 1327532Ssteve.reinhardt@amd.com * All state is initialized (including unserialized state, if any, 1337532Ssteve.reinhardt@amd.com * such as the curTick value), so this is the appropriate place to 1347532Ssteve.reinhardt@amd.com * schedule initial event(s) for objects that need them. 1357532Ssteve.reinhardt@amd.com */ 1367492Ssteve.reinhardt@amd.com virtual void startup(); 137330SN/A 138395SN/A // static: call nameOut() & serialize() on all SimObjects 139395SN/A static void serializeAll(std::ostream &); 1402797Sktlim@umich.edu static void unserializeAll(Checkpoint *cp); 141938SN/A 1422609SN/A // Methods to drain objects in order to take checkpoints 1432609SN/A // Or switch from timing -> atomic memory model 1442901Ssaidi@eecs.umich.edu // Drain returns 0 if the simobject can drain immediately or 1452901Ssaidi@eecs.umich.edu // the number of times the drain_event's process function will be called 1462901Ssaidi@eecs.umich.edu // before the object will be done draining. Normally this should be 1 1472901Ssaidi@eecs.umich.edu virtual unsigned int drain(Event *drain_event); 1482797Sktlim@umich.edu virtual void resume(); 1492797Sktlim@umich.edu virtual void setMemoryMode(State new_mode); 1502797Sktlim@umich.edu virtual void switchOut(); 1512797Sktlim@umich.edu virtual void takeOverFrom(BaseCPU *cpu); 1522609SN/A 1531031SN/A#ifdef DEBUG 1541031SN/A public: 1551031SN/A bool doDebugBreak; 1561031SN/A static void debugObjectBreak(const std::string &objs); 1571031SN/A#endif 1581031SN/A 1595314Sstever@gmail.com /** 1605314Sstever@gmail.com * Find the SimObject with the given name and return a pointer to 1615315Sstever@gmail.com * it. Primarily used for interactive debugging. Argument is 1625314Sstever@gmail.com * char* rather than std::string to make it callable from gdb. 1635314Sstever@gmail.com */ 1645314Sstever@gmail.com static SimObject *find(const char *name); 1652SN/A}; 1662SN/A 1672SN/A#endif // __SIM_OBJECT_HH__ 168