summaryrefslogtreecommitdiff
path: root/src/mem/bus.cc
blob: 86a148f8734239602f6def29fc0d5dddb3b3c532 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
/*
 * Copyright (c) 2006 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: Ali Saidi
 */

/**
 * @file
 * Definition of a bus object.
 */


#include "base/misc.hh"
#include "base/trace.hh"
#include "mem/bus.hh"
#include "sim/builder.hh"

Port *
Bus::getPort(const std::string &if_name, int idx)
{
    if (if_name == "default")
        if (defaultPort == NULL) {
            defaultPort = new BusPort(csprintf("%s-default",name()), this,
                    defaultId);
            return defaultPort;
        } else
            fatal("Default port already set\n");

    // if_name ignored?  forced to be empty?
    int id = interfaces.size();
    BusPort *bp = new BusPort(csprintf("%s-p%d", name(), id), this, id);
    interfaces.push_back(bp);
    return bp;
}

/** Get the ranges of anyone other buses that we are connected to. */
void
Bus::init()
{
    std::vector<BusPort*>::iterator intIter;

    for (intIter = interfaces.begin(); intIter != interfaces.end(); intIter++)
        (*intIter)->sendStatusChange(Port::RangeChange);
}

Bus::BusFreeEvent::BusFreeEvent(Bus *_bus) : Event(&mainEventQueue), bus(_bus)
{}

void Bus::BusFreeEvent::process()
{
    bus->recvRetry(-1);
}

const char * Bus::BusFreeEvent::description()
{
    return "bus became available";
}

void Bus::occupyBus(PacketPtr pkt)
{
    //Bring tickNextIdle up to the present tick
    //There is some potential ambiguity where a cycle starts, which might make
    //a difference when devices are acting right around a cycle boundary. Using
    //a < allows things which happen exactly on a cycle boundary to take up only
    //the following cycle. Anthing that happens later will have to "wait" for
    //the end of that cycle, and then start using the bus after that.
    while (tickNextIdle < curTick)
        tickNextIdle += clock;

    // The packet will be sent. Figure out how long it occupies the bus, and
    // how much of that time is for the first "word", aka bus width.
    int numCycles = 0;
    // Requests need one cycle to send an address
    if (pkt->isRequest())
        numCycles++;
    else if (pkt->isResponse() || pkt->hasData()) {
        // If a packet has data, it needs ceil(size/width) cycles to send it
        // We're using the "adding instead of dividing" trick again here
        if (pkt->hasData()) {
            int dataSize = pkt->getSize();
            for (int transmitted = 0; transmitted < dataSize;
                    transmitted += width) {
                numCycles++;
            }
        } else {
            // If the packet didn't have data, it must have been a response.
            // Those use the bus for one cycle to send their data.
            numCycles++;
        }
    }

    // The first word will be delivered after the current tick, the delivery
    // of the address if any, and one bus cycle to deliver the data
    pkt->firstWordTime =
        tickNextIdle +
        pkt->isRequest() ? clock : 0 +
        clock;

    //Advance it numCycles bus cycles.
    //XXX Should this use the repeated addition trick as well?
    tickNextIdle += (numCycles * clock);
    if (!busIdle.scheduled()) {
        busIdle.schedule(tickNextIdle);
    } else {
        busIdle.reschedule(tickNextIdle);
    }
    DPRINTF(Bus, "The bus is now occupied from tick %d to %d\n",
            curTick, tickNextIdle);

    // The bus will become idle once the current packet is delivered.
    pkt->finishTime = tickNextIdle;
}

/** Function called by the port when the bus is receiving a Timing
 * transaction.*/
bool
Bus::recvTiming(PacketPtr pkt)
{
    Port *port;
    DPRINTF(Bus, "recvTiming: packet src %d dest %d addr 0x%x cmd %s\n",
            pkt->getSrc(), pkt->getDest(), pkt->getAddr(), pkt->cmdString());

    BusPort *pktPort;
    if (pkt->getSrc() == defaultId)
        pktPort = defaultPort;
    else pktPort = interfaces[pkt->getSrc()];

    // If the bus is busy, or other devices are in line ahead of the current
    // one, put this device on the retry list.
    if (tickNextIdle > curTick ||
            (retryList.size() && (!inRetry || pktPort != retryList.front()))) {
        addToRetryList(pktPort);
        return false;
    }

    short dest = pkt->getDest();
    if (dest == Packet::Broadcast) {
        if (timingSnoop(pkt)) {
            bool success;

            pkt->flags |= SNOOP_COMMIT;
            success = timingSnoop(pkt);
            assert(success);

            if (pkt->flags & SATISFIED) {
                //Cache-Cache transfer occuring
                if (inRetry) {
                    retryList.front()->onRetryList(false);
                    retryList.pop_front();
                    inRetry = false;
                }
                occupyBus(pkt);
                return true;
            }
            port = findPort(pkt->getAddr(), pkt->getSrc());
        } else {
            //Snoop didn't succeed
            DPRINTF(Bus, "Adding a retry to RETRY list %i\n", pktPort);
            addToRetryList(pktPort);
            return false;
        }
    } else {
        assert(dest >= 0 && dest < interfaces.size());
        assert(dest != pkt->getSrc()); // catch infinite loops
        port = interfaces[dest];
    }

    occupyBus(pkt);

    if (port->sendTiming(pkt))  {
        // Packet was successfully sent. Return true.
        // Also take care of retries
        if (inRetry) {
            DPRINTF(Bus, "Remove retry from list %i\n", retryList.front());
            retryList.front()->onRetryList(false);
            retryList.pop_front();
            inRetry = false;
        }
        return true;
    }

    // Packet not successfully sent. Leave or put it on the retry list.
    DPRINTF(Bus, "Adding a retry to RETRY list %i\n", pktPort);
    addToRetryList(pktPort);
    return false;
}

void
Bus::recvRetry(int id)
{
    DPRINTF(Bus, "Received a retry\n");
    // If there's anything waiting, and the bus isn't busy...
    if (retryList.size() && curTick >= tickNextIdle) {
        //retryingPort = retryList.front();
        inRetry = true;
        DPRINTF(Bus, "Sending a retry\n");
        retryList.front()->sendRetry();
        // If inRetry is still true, sendTiming wasn't called
        if (inRetry)
        {
            retryList.front()->onRetryList(false);
            retryList.pop_front();
            inRetry = false;

            //Bring tickNextIdle up to the present
            while (tickNextIdle < curTick)
                tickNextIdle += clock;

            //Burn a cycle for the missed grant.
            tickNextIdle += clock;

            if (!busIdle.scheduled()) {
                busIdle.schedule(tickNextIdle);
            } else {
                busIdle.reschedule(tickNextIdle);
            }
        }
    }
}

Port *
Bus::findPort(Addr addr, int id)
{
    /* An interval tree would be a better way to do this. --ali. */
    int dest_id = -1;
    int i = 0;
    bool found = false;
    AddrRangeIter iter;

    while (i < portList.size() && !found)
    {
        if (portList[i].range == addr) {
            dest_id = portList[i].portId;
            found = true;
            DPRINTF(Bus, "  found addr %#llx on device %d\n", addr, dest_id);
        }
        i++;
    }

    // Check if this matches the default range
    if (dest_id == -1) {
        for (iter = defaultRange.begin(); iter != defaultRange.end(); iter++) {
            if (*iter == addr) {
                DPRINTF(Bus, "  found addr %#llx on default\n", addr);
                return defaultPort;
            }
        }
        panic("Unable to find destination for addr: %#llx", addr);
    }


    // we shouldn't be sending this back to where it came from
    assert(dest_id != id);

    return interfaces[dest_id];
}

std::vector<int>
Bus::findSnoopPorts(Addr addr, int id)
{
    int i = 0;
    AddrRangeIter iter;
    std::vector<int> ports;

    while (i < portSnoopList.size())
    {
        if (portSnoopList[i].range == addr && portSnoopList[i].portId != id) {
            //Careful  to not overlap ranges
            //or snoop will be called more than once on the port
            ports.push_back(portSnoopList[i].portId);
//            DPRINTF(Bus, "  found snoop addr %#llx on device%d\n", addr,
//                    portSnoopList[i].portId);
        }
        i++;
    }
    return ports;
}

Tick
Bus::atomicSnoop(PacketPtr pkt)
{
    std::vector<int> ports = findSnoopPorts(pkt->getAddr(), pkt->getSrc());
    Tick response_time = 0;

    while (!ports.empty())
    {
        Tick response = interfaces[ports.back()]->sendAtomic(pkt);
        if (response) {
            assert(!response_time);  //Multiple responders
            response_time = response;
        }
        ports.pop_back();
    }
    return response_time;
}

void
Bus::functionalSnoop(PacketPtr pkt)
{
    std::vector<int> ports = findSnoopPorts(pkt->getAddr(), pkt->getSrc());

    while (!ports.empty() && pkt->result != Packet::Success)
    {
        interfaces[ports.back()]->sendFunctional(pkt);
        ports.pop_back();
    }
}

bool
Bus::timingSnoop(PacketPtr pkt)
{
    std::vector<int> ports = findSnoopPorts(pkt->getAddr(), pkt->getSrc());
    bool success = true;

    while (!ports.empty() && success)
    {
        success = interfaces[ports.back()]->sendTiming(pkt);
        ports.pop_back();
    }

    return success;
}


/** Function called by the port when the bus is receiving a Atomic
 * transaction.*/
Tick
Bus::recvAtomic(PacketPtr pkt)
{
    DPRINTF(Bus, "recvAtomic: packet src %d dest %d addr 0x%x cmd %s\n",
            pkt->getSrc(), pkt->getDest(), pkt->getAddr(), pkt->cmdString());
    assert(pkt->getDest() == Packet::Broadcast);
    Tick snoopTime = atomicSnoop(pkt);
    if (snoopTime)
        return snoopTime;  //Snoop satisfies it
    else
        return findPort(pkt->getAddr(), pkt->getSrc())->sendAtomic(pkt);
}

/** Function called by the port when the bus is receiving a Functional
 * transaction.*/
void
Bus::recvFunctional(PacketPtr pkt)
{
    DPRINTF(Bus, "recvFunctional: packet src %d dest %d addr 0x%x cmd %s\n",
            pkt->getSrc(), pkt->getDest(), pkt->getAddr(), pkt->cmdString());
    assert(pkt->getDest() == Packet::Broadcast);
    functionalSnoop(pkt);

    // If the snooping found what we were looking for, we're done.
    if (pkt->result != Packet::Success)
        findPort(pkt->getAddr(), pkt->getSrc())->sendFunctional(pkt);
}

/** Function called by the port when the bus is receiving a status change.*/
void
Bus::recvStatusChange(Port::Status status, int id)
{
    AddrRangeList ranges;
    AddrRangeList snoops;
    int x;
    AddrRangeIter iter;

    assert(status == Port::RangeChange &&
           "The other statuses need to be implemented.");

    DPRINTF(BusAddrRanges, "received RangeChange from device id %d\n", id);

    if (id == defaultId) {
        defaultRange.clear();
        defaultPort->getPeerAddressRanges(ranges, snoops);
        assert(snoops.size() == 0);
        for(iter = ranges.begin(); iter != ranges.end(); iter++) {
            defaultRange.push_back(*iter);
            DPRINTF(BusAddrRanges, "Adding range %#llx - %#llx for default range\n",
                    iter->start, iter->end);
        }
    } else {

        assert((id < interfaces.size() && id >= 0) || id == defaultId);
        Port *port = interfaces[id];
        std::vector<DevMap>::iterator portIter;
        std::vector<DevMap>::iterator snoopIter;

        // Clean out any previously existent ids
        for (portIter = portList.begin(); portIter != portList.end(); ) {
            if (portIter->portId == id)
                portIter = portList.erase(portIter);
            else
                portIter++;
        }

        for (snoopIter = portSnoopList.begin(); snoopIter != portSnoopList.end(); ) {
            if (snoopIter->portId == id)
                snoopIter = portSnoopList.erase(snoopIter);
            else
                snoopIter++;
        }

        port->getPeerAddressRanges(ranges, snoops);

        for(iter = snoops.begin(); iter != snoops.end(); iter++) {
            DevMap dm;
            dm.portId = id;
            dm.range = *iter;

            DPRINTF(BusAddrRanges, "Adding snoop range %#llx - %#llx for id %d\n",
                    dm.range.start, dm.range.end, id);
            portSnoopList.push_back(dm);
        }

        for(iter = ranges.begin(); iter != ranges.end(); iter++) {
            DevMap dm;
            dm.portId = id;
            dm.range = *iter;

            DPRINTF(BusAddrRanges, "Adding range %#llx - %#llx for id %d\n",
                    dm.range.start, dm.range.end, id);
            portList.push_back(dm);
        }
    }
    DPRINTF(MMU, "port list has %d entries\n", portList.size());

    // tell all our peers that our address range has changed.
    // Don't tell the device that caused this change, it already knows
    for (x = 0; x < interfaces.size(); x++)
        if (x != id)
            interfaces[x]->sendStatusChange(Port::RangeChange);

    if (id != defaultId && defaultPort)
        defaultPort->sendStatusChange(Port::RangeChange);
}

void
Bus::addressRanges(AddrRangeList &resp, AddrRangeList &snoop, int id)
{
    std::vector<DevMap>::iterator portIter;
    AddrRangeIter dflt_iter;
    bool subset;

    resp.clear();
    snoop.clear();

    DPRINTF(BusAddrRanges, "received address range request, returning:\n");

    for (dflt_iter = defaultRange.begin(); dflt_iter != defaultRange.end();
            dflt_iter++) {
        resp.push_back(*dflt_iter);
        DPRINTF(BusAddrRanges, "  -- %#llx : %#llx\n",dflt_iter->start,
                dflt_iter->end);
    }
    for (portIter = portList.begin(); portIter != portList.end(); portIter++) {
        subset = false;
        for (dflt_iter = defaultRange.begin(); dflt_iter != defaultRange.end();
                dflt_iter++) {
            if ((portIter->range.start < dflt_iter->start &&
                portIter->range.end >= dflt_iter->start) ||
               (portIter->range.start < dflt_iter->end &&
                portIter->range.end >= dflt_iter->end))
                fatal("Devices can not set ranges that itersect the default set\
                        but are not a subset of the default set.\n");
            if (portIter->range.start >= dflt_iter->start &&
                portIter->range.end <= dflt_iter->end) {
                subset = true;
                DPRINTF(BusAddrRanges, "  -- %#llx : %#llx is a SUBSET\n",
                    portIter->range.start, portIter->range.end);
            }
        }
        if (portIter->portId != id && !subset) {
            resp.push_back(portIter->range);
            DPRINTF(BusAddrRanges, "  -- %#llx : %#llx\n",
                    portIter->range.start, portIter->range.end);
        }
    }
}

BEGIN_DECLARE_SIM_OBJECT_PARAMS(Bus)

    Param<int> bus_id;
    Param<int> clock;
    Param<int> width;

END_DECLARE_SIM_OBJECT_PARAMS(Bus)

BEGIN_INIT_SIM_OBJECT_PARAMS(Bus)
    INIT_PARAM(bus_id, "a globally unique bus id"),
    INIT_PARAM(clock, "bus clock speed"),
    INIT_PARAM(width, "width of the bus (bits)")
END_INIT_SIM_OBJECT_PARAMS(Bus)

CREATE_SIM_OBJECT(Bus)
{
    return new Bus(getInstanceName(), bus_id, clock, width);
}

REGISTER_SIM_OBJECT("Bus", Bus)