syscalls: fix latent brk/obreak bug.
[gem5.git] / src / sim / sim_object.hh
index 76aba7ea1da0ee0675a1099f8416bbe7ab88ed4f..d6d08f2550bdf1cc8d93645f8b1cd528c675e4d8 100644 (file)
@@ -24,6 +24,9 @@
  * 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
 #ifndef __SIM_OBJECT_HH__
 #define __SIM_OBJECT_HH__
 
-#include <map>
+#include <iostream>
 #include <list>
+#include <map>
+#include <string>
 #include <vector>
-#include <iostream>
 
+#include "params/SimObject.hh"
+#include "sim/eventq.hh"
 #include "sim/serialize.hh"
 #include "sim/startup.hh"
 
-class Serializer;
+class BaseCPU;
+class Event;
 
 /*
  * Abstract superclass for simulation objects.  Represents things that
  * correspond to physical components and can be specified via the
  * config file (CPUs, caches, etc.).
  */
-class SimObject : public Serializable, protected StartupCallback
+class SimObject
+    : public EventManager, public Serializable, protected StartupCallback
 {
   public:
-    struct Params {
-        std::string name;
+    enum State {
+        Running,
+        Draining,
+        Drained
     };
 
+  private:
+    State state;
+
   protected:
-    Params *_params;
+    void changeState(State new_state) { state = new_state; }
 
   public:
-    const Params *params() const { return _params; }
+    State getState() { return state; }
 
   private:
-    friend class Serializer;
-
     typedef std::vector<SimObject *> SimObjectList;
 
     // list of all instantiated simulation objects
     static SimObjectList simObjectList;
 
-  public:
-    SimObject(Params *_params);
-    SimObject(const std::string &_name);
+  protected:
+    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; }
 
     // initialization pass of all objects.
     // Gets invoked after construction, before unserialize.
     virtual void init();
-    virtual void connect();
     static void initAll();
-    static void connectAll();
 
     // register statistics for this object
     virtual void regStats();
@@ -97,13 +111,18 @@ class SimObject : public Serializable, protected StartupCallback
 
     // static: call nameOut() & serialize() on all SimObjects
     static void serializeAll(std::ostream &);
+    static void unserializeAll(Checkpoint *cp);
 
     // Methods to drain objects in order to take checkpoints
     // Or switch from timing -> atomic memory model
-    virtual void drain(Serializer *serializer);
-    virtual void resume() { return;} ;
-    virtual void serializationComplete()
-    { assert(0 && "Unimplemented"); };
+    // Drain returns 0 if the simobject can drain immediately or
+    // the number of times the drain_event's process function will be called
+    // before the object will be done draining. Normally this should be 1
+    virtual unsigned int drain(Event *drain_event);
+    virtual void resume();
+    virtual void setMemoryMode(State new_mode);
+    virtual void switchOut();
+    virtual void takeOverFrom(BaseCPU *cpu);
 
 #ifdef DEBUG
   public:
@@ -111,8 +130,14 @@ class SimObject : public Serializable, protected StartupCallback
     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);
+
   public:
-    bool doRecordEvent;
     void recordEvent(const std::string &stat);
 };