/*
* 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
#ifndef __SIM_OBJECT_HH__
#define __SIM_OBJECT_HH__
-#include <map>
+#include <iostream>
#include <list>
+#include <map>
+#include <string>
#include <vector>
-#include <iostream>
+#include "enums/MemoryMode.hh"
+#include "params/SimObject.hh"
+#include "sim/drain.hh"
+#include "sim/eventq_impl.hh"
#include "sim/serialize.hh"
-#include "sim/startup.hh"
class BaseCPU;
class Event;
-
-/*
+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:
+ *
+ * <ol>
+ * <li>SimObject::init()
+ * <li>SimObject::regStats()
+ * <li><ul>
+ * <li>SimObject::initState() if starting afresh.
+ * <li>SimObject::loadState() if restoring from a checkpoint.
+ * </ul>
+ * <li>SimObject::resetStats()
+ * <li>SimObject::startup()
+ * <li>Drainable::drainResume() if resuming from a checkpoint.
+ * </ol>
+ *
+ * @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 <i>before</i> its children.
*/
-class SimObject : public Serializable, protected StartupCallback
+class SimObject : public EventManager, public Serializable, public Drainable
{
- public:
- struct Params {
- std::string name;
- };
-
- enum State {
- Atomic,
- Timing,
- Draining,
- DrainedAtomic,
- DrainedTiming
- };
-
- protected:
- Params *_params;
- State state;
-
- void changeState(State new_state) { state = new_state; }
-
- public:
- const Params *params() const { return _params; }
-
- State getState() { return state; }
-
private:
typedef std::vector<SimObject *> SimObjectList;
- // list of all instantiated simulation objects
+ /** 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:
- SimObject(Params *_params);
- SimObject(const std::string &_name);
+ typedef SimObjectParams Params;
+ const Params *params() const { return _params; }
+ SimObject(const Params *_params);
+ virtual ~SimObject();
- virtual ~SimObject() {}
+ public:
virtual const std::string name() const { return params()->name; }
- // initialization pass of all objects.
- // Gets invoked after construction, before unserialize.
+ /**
+ * 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();
- virtual void connect();
- static void initAll();
- static void connectAll();
- // register statistics for this object
+ /**
+ * 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(Checkpoint *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();
- virtual void regFormulas();
- virtual void resetStats();
- // static: call reg_stats on all SimObjects
- static void regAllStats();
-
- // static: call resetStats on all SimObjects
- static void resetAllStats();
-
- // static: call nameOut() & serialize() on all SimObjects
- static void serializeAll(std::ostream &);
- static void unserializeAll(Checkpoint *cp);
+ /**
+ * Reset statistics associated with this object.
+ */
+ virtual void resetStats();
- // Methods to drain objects in order to take checkpoints
- // Or switch from timing -> atomic memory model
- // Quiesce returns true if the SimObject cannot quiesce immediately.
- virtual bool drain(Event *drain_event);
- virtual void resume();
- virtual void setMemoryMode(State new_mode);
- virtual void switchOut();
- virtual void takeOverFrom(BaseCPU *cpu);
+ /**
+ * 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();
+
+ /**
+ * 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 that
+ * simply returns 0 (draining completed) and sets the drain state
+ * to Drained.
+ */
+ unsigned int drain(DrainManager *drainManger);
+
+ /**
+ * Serialize all SimObjects in the system.
+ */
+ static void serializeAll(std::ostream &os);
#ifdef DEBUG
public:
static void debugObjectBreak(const std::string &objs);
#endif
- public:
- bool doRecordEvent;
- void recordEvent(const std::string &stat);
+ /**
+ * 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);
};
+#ifdef DEBUG
+void debugObjectBreak(const char *objs);
+#endif
+
#endif // __SIM_OBJECT_HH__
projects / gem5.git / blobdiff