Ruby: Get rid of the dead ruby tester.
[gem5.git] / src / mem / bus.hh
index f5cad058661da09e29c9a0afe81f21ca699bcbad..ba02e3328709d6b3d7a7ef469babbc164f98c61c 100644 (file)
 #define __MEM_BUS_HH__
 
 #include <string>
+#include <set>
 #include <list>
-#include <inttypes.h>
 
-#include "base/range.hh"
 #include "base/hashmap.hh"
+#include "base/range.hh"
 #include "base/range_map.hh"
+#include "base/types.hh"
 #include "mem/mem_object.hh"
 #include "mem/packet.hh"
 #include "mem/port.hh"
 #include "mem/request.hh"
+#include "params/Bus.hh"
 #include "sim/eventq.hh"
 
 class Bus : public MemObject
@@ -117,7 +119,7 @@ class Bus : public MemObject
         // Ask the bus to ask everyone on the bus what their block size is and
         // take the max of it. This might need to be changed a bit if we ever
         // support multiple block sizes.
-        virtual int deviceBlockSize()
+        virtual unsigned deviceBlockSize() const
         { return bus->findBlockSize(id); }
 
     };
@@ -129,13 +131,15 @@ class Bus : public MemObject
       public:
         BusFreeEvent(Bus * _bus);
         void process();
-        const char *description();
+        const char *description() const;
     };
 
     /** a globally unique id for this bus. */
     int busId;
     /** the clock speed for the bus */
     int clock;
+    /** cycles of overhead per transaction */
+    int headerCycles;
     /** the width of the bus in bytes */
     int width;
     /** the next tick at which the bus will be idle */
@@ -196,11 +200,13 @@ class Bus : public MemObject
         if (portCache[0].valid && addr >= portCache[0].start &&
             addr < portCache[0].end) {
             return portCache[0].id;
-        } else if (portCache[1].valid && addr >= portCache[1].start &&
+        }
+        if (portCache[1].valid && addr >= portCache[1].start &&
                    addr < portCache[1].end) {
             return portCache[1].id;
-        } else if (portCache[2].valid && addr >= portCache[2].start &&
-                   addr < portCache[2].end) {
+        }
+        if (portCache[2].valid && addr >= portCache[2].start &&
+            addr < portCache[2].end) {
             return portCache[2].id;
         }
 
@@ -239,18 +245,26 @@ class Bus : public MemObject
      */
     void addressRanges(AddrRangeList &resp, bool &snoop, int id);
 
-    /** Occupy the bus with transmitting the packet pkt */
-    void occupyBus(PacketPtr pkt);
+    /** Calculate the timing parameters for the packet.  Updates the
+     * firstWordTime and finishTime fields of the packet object.
+     * Returns the tick at which the packet header is completed (which
+     * will be all that is sent if the target rejects the packet).
+     */
+    Tick calcPacketTiming(PacketPtr pkt);
+
+    /** Occupy the bus until until */
+    void occupyBus(Tick until);
 
     /** Ask everyone on the bus what their size is
      * @param id id of the busport that made the request
      * @return the max of all the sizes
      */
-    int findBlockSize(int id);
+    unsigned findBlockSize(int id);
 
     BusFreeEvent busIdle;
 
     bool inRetry;
+    std::set<int> inRecvStatusChange;
 
     /** max number of bus ids we've handed out so far */
     short maxId;
@@ -291,11 +305,14 @@ class Bus : public MemObject
     BusPort *funcPort;
     int funcPortId;
 
-    /** Has the user specified their own default responder? */
-    bool responderSet;
+    /** If true, use address range provided by default device.  Any
+       address not handled by another port and not in default device's
+       range will cause a fatal error.  If false, just send all
+       addresses not handled by another port to default device. */
+    bool useDefaultRange;
 
-    int defaultBlockSize;
-    int cachedBlockSize;
+    unsigned defaultBlockSize;
+    unsigned cachedBlockSize;
     bool cachedBlockSizeValid;
 
    // Cache for the peer port interfaces
@@ -312,9 +329,11 @@ class Bus : public MemObject
     inline BusPort* checkBusCache(short id) {
         if (busCache[0].valid && id == busCache[0].id) {
             return busCache[0].port;
-        } else if (busCache[1].valid && id == busCache[1].id) {
+        }
+        if (busCache[1].valid && id == busCache[1].id) {
             return busCache[1].port;
-        } else if (busCache[2].valid && id == busCache[2].id) {
+        }
+        if (busCache[2].valid && id == busCache[2].id) {
             return busCache[2].port;
         }
 
@@ -338,7 +357,6 @@ class Bus : public MemObject
 
     // Invalidates the cache. Needs to be called in constructor.
     inline void clearBusCache() {
-        // memset(busCache, 0, 3 * sizeof(BusCache));
         busCache[2].valid = false;
         busCache[1].valid = false;
         busCache[0].valid = false;
@@ -356,23 +374,7 @@ class Bus : public MemObject
 
     unsigned int drain(Event *de);
 
-    Bus(const std::string &n, int bus_id, int _clock, int _width,
-        bool responder_set, int dflt_blk_size)
-        : MemObject(n), busId(bus_id), clock(_clock), width(_width),
-          tickNextIdle(0), drainEvent(NULL), busIdle(this), inRetry(false),
-          maxId(0), defaultPort(NULL), funcPort(NULL), funcPortId(-4),
-          responderSet(responder_set), defaultBlockSize(dflt_blk_size),
-          cachedBlockSize(0), cachedBlockSizeValid(false)
-    {
-        //Both the width and clock period must be positive
-        if (width <= 0)
-            fatal("Bus width must be positive\n");
-        if (clock <= 0)
-            fatal("Bus clock period must be positive\n");
-        clearBusCache();
-        clearPortCache();
-    }
-
+    Bus(const BusParams *p);
 };
 
 #endif //__MEM_BUS_HH__