ruby: Working M5 interface and updated Ruby interface.

This changeset also includes a lot of work from Derek Hower <drh5@cs.wisc.edu>

RubyMemory is now both a driver for Ruby and a port for M5.  Changed
makeRequest/hitCallback interface. Brought packets (superficially)
into the sequencer. Modified tester infrastructure to be packet based.
and Ruby can be used together through the example ruby_se.py
script. SPARC parallel applications work, and the timing *seems* right
from combined M5/Ruby debug traces. To run,
% build/ALPHA_SE/m5.debug configs/example/ruby_se.py -c
  tests/test-progs/hello/bin/alpha/linux/hello -n 4 -t

1 files changed, 129 insertions, 0 deletions

diff --git a/src/mem/rubymem.hh b/src/mem/rubymem.hh
new file mode 100644
index 000000000..feb87ca6c
--- /dev/null
+++ b/src/mem/rubymem.hh
@@ -0,0 +1,129 @@
+/*
+ * Copyright (c) 2001-2005 The Regents of The University of Michigan
+ * 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: Daniel Sanchez
+ */
+
+#ifndef __RUBY_MEMORY_HH__
+#define __RUBY_MEMORY_HH__
+
+#include <map>
+
+#include "mem/physical.hh"
+#include "params/RubyMemory.hh"
+#include "base/callback.hh"
+#include "mem/ruby/common/Driver.hh"
+
+class RubyMemory : public PhysicalMemory, public Driver
+{
+    class RubyMemoryPort : public MemoryPort
+    {
+        RubyMemory* ruby_mem;
+
+      public:
+        RubyMemoryPort(const std::string &_name, RubyMemory *_memory);
+        void sendTiming(PacketPtr pkt);
+
+      protected:
+        virtual bool recvTiming(PacketPtr pkt);
+    };
+
+    class RubyEvent : public Event
+    {
+        RubyMemory *ruby_ptr;
+      public:
+        RubyEvent(RubyMemory *p)
+            : Event(), ruby_ptr(p) {}
+
+        virtual void process() { ruby_ptr->tick(); }
+
+        virtual const char *description() const { return "ruby tick"; }
+    };
+
+
+  private:
+    // prevent copying of a RubyMemory object
+    RubyMemory(const RubyMemory &specmem);
+    const RubyMemory &operator=(const RubyMemory &specmem);
+
+    RubyEvent* rubyTickEvent;
+
+  public:
+    typedef RubyMemoryParams Params;
+    RubyMemory(const Params *p);
+    virtual ~RubyMemory();
+
+  public:
+    virtual Port *getPort(const std::string &if_name, int idx = -1);
+    void virtual init();
+
+    //Ruby-related specifics
+    void printConfigStats(); //dsm: Maybe this function should disappear once the configuration options change & M5 determines the stats file to use
+
+    void hitCallback(Packet* pkt);  // called by the Ruby sequencer
+
+    void printStats(std::ostream & out) const;
+    void clearStats();
+    void printConfig(std::ostream & out) const;
+
+    void tick();
+
+  private:
+    //Parameters passed
+    std::string config_file, config_options, stats_file, debug_file;
+    bool debug;
+    int num_cpus;
+    Tick ruby_clock, ruby_phase;
+
+    std::map<Packet*, RubyMemoryPort*> m_packet_to_port_map;
+};
+
+class RubyExitCallback : public Callback
+{
+  private:
+   RubyMemory* ruby;
+
+  public:
+    /**
+     * virtualize the destructor to make sure that the correct one
+     * gets called.
+     */
+
+    virtual ~RubyExitCallback() {};
+
+    RubyExitCallback(RubyMemory* rm) {ruby=rm;};
+
+    /**
+     * virtual process function that is invoked when the callback
+     * queue is executed.
+     */
+    virtual void process() {ruby->printConfigStats();  /*delete ruby; was doing double delete...*/};
+};
+
+
+#endif //__RUBY_MEMORY_HH__
+