src/mem/bus.cc

   1 /*
   2  * Copyright (c) 2006 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: Ali Saidi
  29  */
  30
  31 /**
  32  * @file
  33  * Definition of a bus object.
  34  */
  35
  36
  37 #include "base/misc.hh"
  38 #include "base/trace.hh"
  39 #include "mem/bus.hh"
  40 #include "sim/builder.hh"
  41
  42 Port *
  43 Bus::getPort(const std::string &if_name, int idx)
  44 {
  45     if (if_name == "default")
  46         if (defaultPort == NULL) {
  47             defaultPort = new BusPort(csprintf("%s-default",name()), this,
  48                     defaultId);
  49             return defaultPort;
  50         } else
  51             fatal("Default port already set\n");
  52
  53     // if_name ignored?  forced to be empty?
  54     int id = interfaces.size();
  55     BusPort *bp = new BusPort(csprintf("%s-p%d", name(), id), this, id);
  56     interfaces.push_back(bp);
  57     return bp;
  58 }
  59
  60 /** Get the ranges of anyone other buses that we are connected to. */
  61 void
  62 Bus::init()
  63 {
  64     std::vector<BusPort*>::iterator intIter;
  65
  66     for (intIter = interfaces.begin(); intIter != interfaces.end(); intIter++)
  67         (*intIter)->sendStatusChange(Port::RangeChange);
  68 }
  69
  70 Bus::BusFreeEvent::BusFreeEvent(Bus *_bus) : Event(&mainEventQueue), bus(_bus)
  71 {}
  72
  73 void Bus::BusFreeEvent::process()
  74 {
  75     bus->recvRetry(-1);
  76 }
  77
  78 const char * Bus::BusFreeEvent::description()
  79 {
  80     return "bus became available";
  81 }
  82
  83 void Bus::occupyBus(PacketPtr pkt)
  84 {
  85     //Bring tickNextIdle up to the present tick
  86     //There is some potential ambiguity where a cycle starts, which might make
  87     //a difference when devices are acting right around a cycle boundary. Using
  88     //a < allows things which happen exactly on a cycle boundary to take up only
  89     //the following cycle. Anthing that happens later will have to "wait" for
  90     //the end of that cycle, and then start using the bus after that.
  91     while (tickNextIdle < curTick)
  92         tickNextIdle += clock;
  93
  94     // The packet will be sent. Figure out how long it occupies the bus, and
  95     // how much of that time is for the first "word", aka bus width.
  96     int numCycles = 0;
  97     // Requests need one cycle to send an address
  98     if (pkt->isRequest())
  99         numCycles++;
 100     else if (pkt->isResponse() || pkt->hasData()) {
 101         // If a packet has data, it needs ceil(size/width) cycles to send it
 102         // We're using the "adding instead of dividing" trick again here
 103         if (pkt->hasData()) {
 104             int dataSize = pkt->getSize();
 105             for (int transmitted = 0; transmitted < dataSize;
 106                     transmitted += width) {
 107                 numCycles++;
 108             }
 109         } else {
 110             // If the packet didn't have data, it must have been a response.
 111             // Those use the bus for one cycle to send their data.
 112             numCycles++;
 113         }
 114     }
 115
 116     // The first word will be delivered after the current tick, the delivery
 117     // of the address if any, and one bus cycle to deliver the data
 118     pkt->firstWordTime =
 119         tickNextIdle +
 120         pkt->isRequest() ? clock : 0 +
 121         clock;
 122
 123     //Advance it numCycles bus cycles.
 124     //XXX Should this use the repeated addition trick as well?
 125     tickNextIdle += (numCycles * clock);
 126     if (!busIdle.scheduled()) {
 127         busIdle.schedule(tickNextIdle);
 128     } else {
 129         busIdle.reschedule(tickNextIdle);
 130     }
 131     DPRINTF(Bus, "The bus is now occupied from tick %d to %d\n",
 132             curTick, tickNextIdle);
 133
 134     // The bus will become idle once the current packet is delivered.
 135     pkt->finishTime = tickNextIdle;
 136 }
 137
 138 /** Function called by the port when the bus is receiving a Timing
 139  * transaction.*/
 140 bool
 141 Bus::recvTiming(Packet *pkt)
 142 {
 143     Port *port;
 144     DPRINTF(Bus, "recvTiming: packet src %d dest %d addr 0x%x cmd %s\n",
 145             pkt->getSrc(), pkt->getDest(), pkt->getAddr(), pkt->cmdString());
 146
 147     BusPort *pktPort = interfaces[pkt->getSrc()];
 148
 149     // If the bus is busy, or other devices are in line ahead of the current
 150     // one, put this device on the retry list.
 151     if (tickNextIdle > curTick ||
 152             (retryList.size() && (!inRetry || pktPort != retryList.front()))) {
 153         addToRetryList(pktPort);
 154         return false;
 155     }
 156
 157     short dest = pkt->getDest();
 158     if (dest == Packet::Broadcast) {
 159         if (timingSnoop(pkt)) {
 160             pkt->flags |= SNOOP_COMMIT;
 161             bool success = timingSnoop(pkt);
 162             assert(success);
 163             if (pkt->flags & SATISFIED) {
 164                 //Cache-Cache transfer occuring
 165                 if (inRetry) {
 166                     retryList.front()->onRetryList(false);
 167                     retryList.pop_front();
 168                     inRetry = false;
 169                 }
 170                 occupyBus(pkt);
 171                 return true;
 172             }
 173             port = findPort(pkt->getAddr(), pkt->getSrc());
 174         } else {
 175             //Snoop didn't succeed
 176             addToRetryList(pktPort);
 177             return false;
 178         }
 179     } else {
 180         assert(dest >= 0 && dest < interfaces.size());
 181         assert(dest != pkt->getSrc()); // catch infinite loops
 182         port = interfaces[dest];
 183     }
 184
 185     occupyBus(pkt);
 186
 187     if (port->sendTiming(pkt))  {
 188         // Packet was successfully sent. Return true.
 189         // Also take care of retries
 190         if (inRetry) {
 191             DPRINTF(Bus, "Remove retry from list %i\n", retryList.front());
 192             retryList.front()->onRetryList(false);
 193             retryList.pop_front();
 194             inRetry = false;
 195         }
 196         return true;
 197     }
 198
 199     // Packet not successfully sent. Leave or put it on the retry list.
 200     DPRINTF(Bus, "Adding a retry to RETRY list %i\n", pktPort);
 201     addToRetryList(pktPort);
 202     return false;
 203 }
 204
 205 void
 206 Bus::recvRetry(int id)
 207 {
 208     DPRINTF(Bus, "Received a retry\n");
 209     // If there's anything waiting...
 210     if (retryList.size()) {
 211         //retryingPort = retryList.front();
 212         inRetry = true;
 213         DPRINTF(Bus, "Sending a retry\n");
 214         retryList.front()->sendRetry();
 215         // If inRetry is still true, sendTiming wasn't called
 216         if (inRetry)
 217             panic("Port %s didn't call sendTiming in it's recvRetry\n",\
 218                     retryList.front()->getPeer()->name());
 219         //assert(!inRetry);
 220     }
 221 }
 222
 223 Port *
 224 Bus::findPort(Addr addr, int id)
 225 {
 226     /* An interval tree would be a better way to do this. --ali. */
 227     int dest_id = -1;
 228     int i = 0;
 229     bool found = false;
 230     AddrRangeIter iter;
 231
 232     while (i < portList.size() && !found)
 233     {
 234         if (portList[i].range == addr) {
 235             dest_id = portList[i].portId;
 236             found = true;
 237             DPRINTF(Bus, "  found addr %#llx on device %d\n", addr, dest_id);
 238         }
 239         i++;
 240     }
 241
 242     // Check if this matches the default range
 243     if (dest_id == -1) {
 244         for (iter = defaultRange.begin(); iter != defaultRange.end(); iter++) {
 245             if (*iter == addr) {
 246                 DPRINTF(Bus, "  found addr %#llx on default\n", addr);
 247                 return defaultPort;
 248             }
 249         }
 250         panic("Unable to find destination for addr: %#llx", addr);
 251     }
 252
 253
 254     // we shouldn't be sending this back to where it came from
 255     assert(dest_id != id);
 256
 257     return interfaces[dest_id];
 258 }
 259
 260 std::vector<int>
 261 Bus::findSnoopPorts(Addr addr, int id)
 262 {
 263     int i = 0;
 264     AddrRangeIter iter;
 265     std::vector<int> ports;
 266
 267     while (i < portSnoopList.size())
 268     {
 269         if (portSnoopList[i].range == addr && portSnoopList[i].portId != id) {
 270             //Careful  to not overlap ranges
 271             //or snoop will be called more than once on the port
 272             ports.push_back(portSnoopList[i].portId);
 273 //            DPRINTF(Bus, "  found snoop addr %#llx on device%d\n", addr,
 274 //                    portSnoopList[i].portId);
 275         }
 276         i++;
 277     }
 278     return ports;
 279 }
 280
 281 void
 282 Bus::atomicSnoop(Packet *pkt)
 283 {
 284     std::vector<int> ports = findSnoopPorts(pkt->getAddr(), pkt->getSrc());
 285
 286     while (!ports.empty())
 287     {
 288         interfaces[ports.back()]->sendAtomic(pkt);
 289         ports.pop_back();
 290     }
 291 }
 292
 293 void
 294 Bus::functionalSnoop(Packet *pkt)
 295 {
 296     std::vector<int> ports = findSnoopPorts(pkt->getAddr(), pkt->getSrc());
 297
 298     while (!ports.empty())
 299     {
 300         interfaces[ports.back()]->sendFunctional(pkt);
 301         ports.pop_back();
 302     }
 303 }
 304
 305 bool
 306 Bus::timingSnoop(Packet *pkt)
 307 {
 308     std::vector<int> ports = findSnoopPorts(pkt->getAddr(), pkt->getSrc());
 309     bool success = true;
 310
 311     while (!ports.empty() && success)
 312     {
 313         success = interfaces[ports.back()]->sendTiming(pkt);
 314         ports.pop_back();
 315     }
 316
 317     return success;
 318 }
 319
 320
 321 /** Function called by the port when the bus is receiving a Atomic
 322  * transaction.*/
 323 Tick
 324 Bus::recvAtomic(Packet *pkt)
 325 {
 326     DPRINTF(Bus, "recvAtomic: packet src %d dest %d addr 0x%x cmd %s\n",
 327             pkt->getSrc(), pkt->getDest(), pkt->getAddr(), pkt->cmdString());
 328     assert(pkt->getDest() == Packet::Broadcast);
 329     atomicSnoop(pkt);
 330     return findPort(pkt->getAddr(), pkt->getSrc())->sendAtomic(pkt);
 331 }
 332
 333 /** Function called by the port when the bus is receiving a Functional
 334  * transaction.*/
 335 void
 336 Bus::recvFunctional(Packet *pkt)
 337 {
 338     DPRINTF(Bus, "recvFunctional: packet src %d dest %d addr 0x%x cmd %s\n",
 339             pkt->getSrc(), pkt->getDest(), pkt->getAddr(), pkt->cmdString());
 340     assert(pkt->getDest() == Packet::Broadcast);
 341     functionalSnoop(pkt);
 342     findPort(pkt->getAddr(), pkt->getSrc())->sendFunctional(pkt);
 343 }
 344
 345 /** Function called by the port when the bus is receiving a status change.*/
 346 void
 347 Bus::recvStatusChange(Port::Status status, int id)
 348 {
 349     AddrRangeList ranges;
 350     AddrRangeList snoops;
 351     int x;
 352     AddrRangeIter iter;
 353
 354     assert(status == Port::RangeChange &&
 355            "The other statuses need to be implemented.");
 356
 357     DPRINTF(BusAddrRanges, "received RangeChange from device id %d\n", id);
 358
 359     if (id == defaultId) {
 360         defaultRange.clear();
 361         defaultPort->getPeerAddressRanges(ranges, snoops);
 362         assert(snoops.size() == 0);
 363         for(iter = ranges.begin(); iter != ranges.end(); iter++) {
 364             defaultRange.push_back(*iter);
 365             DPRINTF(BusAddrRanges, "Adding range %#llx - %#llx for default range\n",
 366                     iter->start, iter->end);
 367         }
 368     } else {
 369
 370         assert((id < interfaces.size() && id >= 0) || id == -1);
 371         Port *port = interfaces[id];
 372         std::vector<DevMap>::iterator portIter;
 373         std::vector<DevMap>::iterator snoopIter;
 374
 375         // Clean out any previously existent ids
 376         for (portIter = portList.begin(); portIter != portList.end(); ) {
 377             if (portIter->portId == id)
 378                 portIter = portList.erase(portIter);
 379             else
 380                 portIter++;
 381         }
 382
 383         for (snoopIter = portSnoopList.begin(); snoopIter != portSnoopList.end(); ) {
 384             if (snoopIter->portId == id)
 385                 snoopIter = portSnoopList.erase(snoopIter);
 386             else
 387                 snoopIter++;
 388         }
 389
 390         port->getPeerAddressRanges(ranges, snoops);
 391
 392         for(iter = snoops.begin(); iter != snoops.end(); iter++) {
 393             DevMap dm;
 394             dm.portId = id;
 395             dm.range = *iter;
 396
 397             DPRINTF(BusAddrRanges, "Adding snoop range %#llx - %#llx for id %d\n",
 398                     dm.range.start, dm.range.end, id);
 399             portSnoopList.push_back(dm);
 400         }
 401
 402         for(iter = ranges.begin(); iter != ranges.end(); iter++) {
 403             DevMap dm;
 404             dm.portId = id;
 405             dm.range = *iter;
 406
 407             DPRINTF(BusAddrRanges, "Adding range %#llx - %#llx for id %d\n",
 408                     dm.range.start, dm.range.end, id);
 409             portList.push_back(dm);
 410         }
 411     }
 412     DPRINTF(MMU, "port list has %d entries\n", portList.size());
 413
 414     // tell all our peers that our address range has changed.
 415     // Don't tell the device that caused this change, it already knows
 416     for (x = 0; x < interfaces.size(); x++)
 417         if (x != id)
 418             interfaces[x]->sendStatusChange(Port::RangeChange);
 419
 420     if (id != defaultId && defaultPort)
 421         defaultPort->sendStatusChange(Port::RangeChange);
 422 }
 423
 424 void
 425 Bus::addressRanges(AddrRangeList &resp, AddrRangeList &snoop, int id)
 426 {
 427     std::vector<DevMap>::iterator portIter;
 428     AddrRangeIter dflt_iter;
 429     bool subset;
 430
 431     resp.clear();
 432     snoop.clear();
 433
 434     DPRINTF(BusAddrRanges, "received address range request, returning:\n");
 435
 436     for (dflt_iter = defaultRange.begin(); dflt_iter != defaultRange.end();
 437             dflt_iter++) {
 438         resp.push_back(*dflt_iter);
 439         DPRINTF(BusAddrRanges, "  -- %#llx : %#llx\n",dflt_iter->start,
 440                 dflt_iter->end);
 441     }
 442     for (portIter = portList.begin(); portIter != portList.end(); portIter++) {
 443         subset = false;
 444         for (dflt_iter = defaultRange.begin(); dflt_iter != defaultRange.end();
 445                 dflt_iter++) {
 446             if ((portIter->range.start < dflt_iter->start &&
 447                 portIter->range.end >= dflt_iter->start) ||
 448                (portIter->range.start < dflt_iter->end &&
 449                 portIter->range.end >= dflt_iter->end))
 450                 fatal("Devices can not set ranges that itersect the default set\
 451                         but are not a subset of the default set.\n");
 452             if (portIter->range.start >= dflt_iter->start &&
 453                 portIter->range.end <= dflt_iter->end) {
 454                 subset = true;
 455                 DPRINTF(BusAddrRanges, "  -- %#llx : %#llx is a SUBSET\n",
 456                     portIter->range.start, portIter->range.end);
 457             }
 458         }
 459         if (portIter->portId != id && !subset) {
 460             resp.push_back(portIter->range);
 461             DPRINTF(BusAddrRanges, "  -- %#llx : %#llx\n",
 462                     portIter->range.start, portIter->range.end);
 463         }
 464     }
 465 }
 466
 467 BEGIN_DECLARE_SIM_OBJECT_PARAMS(Bus)
 468
 469     Param<int> bus_id;
 470     Param<int> clock;
 471     Param<int> width;
 472
 473 END_DECLARE_SIM_OBJECT_PARAMS(Bus)
 474
 475 BEGIN_INIT_SIM_OBJECT_PARAMS(Bus)
 476     INIT_PARAM(bus_id, "a globally unique bus id"),
 477     INIT_PARAM(clock, "bus clock speed"),
 478     INIT_PARAM(width, "width of the bus (bits)")
 479 END_INIT_SIM_OBJECT_PARAMS(Bus)
 480
 481 CREATE_SIM_OBJECT(Bus)
 482 {
 483     return new Bus(getInstanceName(), bus_id, clock, width);
 484 }
 485
 486 REGISTER_SIM_OBJECT("Bus", Bus)