src/mem/bus.hh

   1 /*
   2  * Copyright (c) 2002-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Ron Dreslinski
  29  *          Ali Saidi
  30  */
  31
  32 /**
  33  * @file
  34  * Declaration of a bus object.
  35  */
  36
  37 #ifndef __MEM_BUS_HH__
  38 #define __MEM_BUS_HH__
  39
  40 #include <string>
  41 #include <list>
  42 #include <inttypes.h>
  43
  44 #include "base/range.hh"
  45 #include "mem/mem_object.hh"
  46 #include "mem/packet.hh"
  47 #include "mem/port.hh"
  48 #include "mem/request.hh"
  49
  50 class Bus : public MemObject
  51 {
  52     /** a globally unique id for this bus. */
  53     int busId;
  54
  55     static const int defaultId = -1;
  56
  57     struct DevMap {
  58         int portId;
  59         Range<Addr> range;
  60     };
  61     std::vector<DevMap> portList;
  62     AddrRangeList defaultRange;
  63     std::vector<DevMap> portSnoopList;
  64
  65     /** Function called by the port when the bus is recieving a Timing
  66       transaction.*/
  67     bool recvTiming(Packet *pkt);
  68
  69     /** Function called by the port when the bus is recieving a Atomic
  70       transaction.*/
  71     Tick recvAtomic(Packet *pkt);
  72
  73     /** Function called by the port when the bus is recieving a Functional
  74         transaction.*/
  75     void recvFunctional(Packet *pkt);
  76
  77     /** Timing function called by port when it is once again able to process
  78      * requests. */
  79     void recvRetry(int id);
  80
  81     /** Function called by the port when the bus is recieving a status change.*/
  82     void recvStatusChange(Port::Status status, int id);
  83
  84     /** Find which port connected to this bus (if any) should be given a packet
  85      * with this address.
  86      * @param addr Address to find port for.
  87      * @param id Id of the port this packet was received from (to prevent
  88      *             loops)
  89      * @return pointer to port that the packet should be sent out of.
  90      */
  91     Port *findPort(Addr addr, int id);
  92
  93     /** Find all ports with a matching snoop range, except src port.  Keep in mind
  94      * that the ranges shouldn't overlap or you will get a double snoop to the same
  95      * interface.and the cache will assert out.
  96      * @param addr Address to find snoop prts for.
  97      * @param id Id of the src port of the request to avoid calling snoop on src
  98      * @return vector of IDs to snoop on
  99      */
 100     std::vector<int> findSnoopPorts(Addr addr, int id);
 101
 102     /** Snoop all relevant ports atomicly. */
 103     void atomicSnoop(Packet *pkt);
 104
 105     /** Call snoop on caches, be sure to set SNOOP_COMMIT bit if you want
 106      * the snoop to happen
 107      * @return True if succeds.
 108      */
 109     bool timingSnoop(Packet *pkt);
 110
 111     /** Process address range request.
 112      * @param resp addresses that we can respond to
 113      * @param snoop addresses that we would like to snoop
 114      * @param id ide of the busport that made the request.
 115      */
 116     void addressRanges(AddrRangeList &resp, AddrRangeList &snoop, int id);
 117
 118
 119     /** Declaration of the buses port type, one will be instantiated for each
 120         of the interfaces connecting to the bus. */
 121     class BusPort : public Port
 122     {
 123         /** A pointer to the bus to which this port belongs. */
 124         Bus *bus;
 125
 126         /** A id to keep track of the intercafe ID this port is connected to. */
 127         int id;
 128
 129       public:
 130
 131         /** Constructor for the BusPort.*/
 132         BusPort(const std::string &_name, Bus *_bus, int _id)
 133             : Port(_name), bus(_bus), id(_id)
 134         { }
 135
 136       protected:
 137
 138         /** When reciving a timing request from the peer port (at id),
 139             pass it to the bus. */
 140         virtual bool recvTiming(Packet *pkt)
 141         { pkt->setSrc(id); return bus->recvTiming(pkt); }
 142
 143         /** When reciving a Atomic requestfrom the peer port (at id),
 144             pass it to the bus. */
 145         virtual Tick recvAtomic(Packet *pkt)
 146         { pkt->setSrc(id); return bus->recvAtomic(pkt); }
 147
 148         /** When reciving a Functional requestfrom the peer port (at id),
 149             pass it to the bus. */
 150         virtual void recvFunctional(Packet *pkt)
 151         { pkt->setSrc(id); bus->recvFunctional(pkt); }
 152
 153         /** When reciving a status changefrom the peer port (at id),
 154             pass it to the bus. */
 155         virtual void recvStatusChange(Status status)
 156         { bus->recvStatusChange(status, id); }
 157
 158         /** When reciving a retry from the peer port (at id),
 159             pass it to the bus. */
 160         virtual void recvRetry()
 161         { bus->recvRetry(id); }
 162
 163         // This should return all the 'owned' addresses that are
 164         // downstream from this bus, yes?  That is, the union of all
 165         // the 'owned' address ranges of all the other interfaces on
 166         // this bus...
 167         virtual void getDeviceAddressRanges(AddrRangeList &resp,
 168                                             AddrRangeList &snoop)
 169         { bus->addressRanges(resp, snoop, id); }
 170
 171         // Hack to make translating port work without changes
 172         virtual int deviceBlockSize() { return 32; }
 173
 174     };
 175
 176     /** An array of pointers to the peer port interfaces
 177         connected to this bus.*/
 178     std::vector<Port*> interfaces;
 179
 180     /** An array of pointers to ports that retry should be called on because the
 181      * original send failed for whatever reason.*/
 182     std::list<Port*> retryList;
 183
 184     /** Port that handles requests that don't match any of the interfaces.*/
 185     Port *defaultPort;
 186
 187   public:
 188
 189     /** A function used to return the port associated with this bus object. */
 190     virtual Port *getPort(const std::string &if_name, int idx = -1);
 191
 192     virtual void init();
 193
 194     Bus(const std::string &n, int bus_id)
 195         : MemObject(n), busId(bus_id), defaultPort(NULL)  {}
 196
 197 };
 198
 199 #endif //__MEM_BUS_HH__