/* * Copyright (c) 2015 ARM Limited * All rights reserved * * The license below extends only to copyright in the software and shall * not be construed as granting a license to any other intellectual * property including but not limited to intellectual property relating * to a hardware implementation of the functionality of the software * licensed hereunder. You may use the software subject to the license * terms below provided that you ensure that this notice is replicated * unmodified and in its entirety in all distributions of the software, * modified or unmodified, in source code or in binary form. * * Copyright (c) 2001-2005 The Regents of The University of Michigan * Copyright (c) 2010 Advanced Micro Devices, Inc. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer; * redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution; * neither the name of the copyright holders nor the names of its * contributors may be used to endorse or promote products derived from * this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * * Authors: Steve Reinhardt * Nathan Binkert */ /* @file * User Console Definitions */ #ifndef __SIM_OBJECT_HH__ #define __SIM_OBJECT_HH__ #include #include #include "params/SimObject.hh" #include "sim/drain.hh" #include "sim/eventq.hh" #include "sim/eventq_impl.hh" #include "sim/port.hh" #include "sim/serialize.hh" class EventManager; class ProbeManager; /** * Abstract superclass for simulation objects. Represents things that * correspond to physical components and can be specified via the * config file (CPUs, caches, etc.). * * SimObject initialization is controlled by the instantiate method in * src/python/m5/simulate.py. There are slightly different * initialization paths when starting the simulation afresh and when * loading from a checkpoint. After instantiation and connecting * ports, simulate.py initializes the object using the following call * sequence: * *
    *
  1. SimObject::init() *
  2. SimObject::regStats() *
    • *
    • SimObject::initState() if starting afresh. *
    • SimObject::loadState() if restoring from a checkpoint. *
    *
  3. SimObject::resetStats() *
  4. SimObject::startup() *
  5. Drainable::drainResume() if resuming from a checkpoint. *
* * @note Whenever a method is called on all objects in the simulator's * object tree (e.g., init(), startup(), or loadState()), a pre-order * depth-first traversal is performed (see descendants() in * SimObject.py). This has the effect of calling the method on the * parent node before its children. */ class SimObject : public EventManager, public Serializable, public Drainable { private: typedef std::vector SimObjectList; /** List of all instantiated simulation objects. */ static SimObjectList simObjectList; /** Manager coordinates hooking up probe points with listeners. */ ProbeManager *probeManager; protected: /** Cached copy of the object parameters. */ const SimObjectParams *_params; public: typedef SimObjectParams Params; const Params *params() const { return _params; } SimObject(const Params *_params); virtual ~SimObject(); public: virtual const std::string name() const { return params()->name; } /** * init() is called after all C++ SimObjects have been created and * all ports are connected. Initializations that are independent * of unserialization but rely on a fully instantiated and * connected SimObject graph should be done here. */ virtual void init(); /** * loadState() is called on each SimObject when restoring from a * checkpoint. The default implementation simply calls * unserialize() if there is a corresponding section in the * checkpoint. However, objects can override loadState() to get * other behaviors, e.g., doing other programmed initializations * after unserialize(), or complaining if no checkpoint section is * found. * * @param cp Checkpoint to restore the state from. */ virtual void loadState(CheckpointIn &cp); /** * initState() is called on each SimObject when *not* restoring * from a checkpoint. This provides a hook for state * initializations that are only required for a "cold start". */ virtual void initState(); /** * Register statistics for this object. */ virtual void regStats(); /** * Reset statistics associated with this object. */ virtual void resetStats(); /** * Register probe points for this object. */ virtual void regProbePoints(); /** * Register probe listeners for this object. */ virtual void regProbeListeners(); /** * Get the probe manager for this object. */ ProbeManager *getProbeManager(); /** * Get a port with a given name and index. This is used at binding time * and returns a reference to a protocol-agnostic port. * * @param if_name Port name * @param idx Index in the case of a VectorPort * * @return A reference to the given port */ virtual Port &getPort(const std::string &if_name, PortID idx=InvalidPortID); /** * startup() is the final initialization call before simulation. * All state is initialized (including unserialized state, if any, * such as the curTick() value), so this is the appropriate place to * schedule initial event(s) for objects that need them. */ virtual void startup(); /** * Provide a default implementation of the drain interface for * objects that don't need draining. */ DrainState drain() override { return DrainState::Drained; } /** * Write back dirty buffers to memory using functional writes. * * After returning, an object implementing this method should have * written all its dirty data back to memory. This method is * typically used to prepare a system with caches for * checkpointing. */ virtual void memWriteback() {}; /** * Invalidate the contents of memory buffers. * * When the switching to hardware virtualized CPU models, we need * to make sure that we don't have any cached state in the system * that might become stale when we return. This method is used to * flush all such state back to main memory. * * @warn This does not cause any dirty state to be written * back to memory. */ virtual void memInvalidate() {}; void serialize(CheckpointOut &cp) const override {}; void unserialize(CheckpointIn &cp) override {}; /** * Serialize all SimObjects in the system. */ static void serializeAll(CheckpointOut &cp); #ifdef DEBUG public: bool doDebugBreak; static void debugObjectBreak(const std::string &objs); #endif /** * Find the SimObject with the given name and return a pointer to * it. Primarily used for interactive debugging. Argument is * char* rather than std::string to make it callable from gdb. */ static SimObject *find(const char *name); }; /** * Base class to wrap object resolving functionality. * * This can be provided to the serialization framework to allow it to * map object names onto C++ objects. */ class SimObjectResolver { public: virtual ~SimObjectResolver() { } // Find a SimObject given a full path name virtual SimObject *resolveSimObject(const std::string &name) = 0; }; #ifdef DEBUG void debugObjectBreak(const char *objs); #endif #endif // __SIM_OBJECT_HH__