summaryrefslogtreecommitdiff
path: root/src/mem/cache/base_cache.cc
blob: d9e6c5e1f89798f825a23d3e02cae35c4ceb1f61 (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
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
/*
 * Copyright (c) 2003-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: Erik Hallnor
 */

/**
 * @file
 * Definition of BaseCache functions.
 */

#include "cpu/base.hh"
#include "cpu/smt.hh"
#include "mem/cache/base_cache.hh"
#include "mem/cache/miss/mshr.hh"

using namespace std;

BaseCache::CachePort::CachePort(const std::string &_name, BaseCache *_cache,
                                bool _isCpuSide)
    : Port(_name, _cache), cache(_cache), isCpuSide(_isCpuSide)
{
    blocked = false;
    waitingOnRetry = false;
    //Start ports at null if more than one is created we should panic
    //cpuSidePort = NULL;
    //memSidePort = NULL;
}


void
BaseCache::CachePort::recvStatusChange(Port::Status status)
{
    cache->recvStatusChange(status, isCpuSide);
}

void
BaseCache::CachePort::getDeviceAddressRanges(AddrRangeList &resp,
                                       AddrRangeList &snoop)
{
    cache->getAddressRanges(resp, snoop, isCpuSide);
}

int
BaseCache::CachePort::deviceBlockSize()
{
    return cache->getBlockSize();
}

bool
BaseCache::CachePort::checkFunctional(PacketPtr pkt)
{
    //Check storage here first
    list<PacketPtr>::iterator i = drainList.begin();
    list<PacketPtr>::iterator iend = drainList.end();
    bool notDone = true;
    while (i != iend && notDone) {
        PacketPtr target = *i;
        // If the target contains data, and it overlaps the
        // probed request, need to update data
        if (target->intersect(pkt)) {
            DPRINTF(Cache, "Functional %s access to blk_addr %x intersects a drain\n",
                    pkt->cmdString(), pkt->getAddr() & ~(cache->getBlockSize() - 1));
            notDone = fixPacket(pkt, target);
        }
        i++;
    }
    //Also check the response not yet ready to be on the list
    std::list<std::pair<Tick,PacketPtr> >::iterator j = transmitList.begin();
    std::list<std::pair<Tick,PacketPtr> >::iterator jend = transmitList.end();

    while (j != jend && notDone) {
        PacketPtr target = j->second;
        // If the target contains data, and it overlaps the
        // probed request, need to update data
        if (target->intersect(pkt)) {
            DPRINTF(Cache, "Functional %s access to blk_addr %x intersects a response\n",
                    pkt->cmdString(), pkt->getAddr() & ~(cache->getBlockSize() - 1));
            notDone = fixDelayedResponsePacket(pkt, target);
        }
        j++;
    }
    return notDone;
}

void
BaseCache::CachePort::checkAndSendFunctional(PacketPtr pkt)
{
    bool notDone = checkFunctional(pkt);
    if (notDone)
        sendFunctional(pkt);
}

void
BaseCache::CachePort::recvRetry()
{
    PacketPtr pkt;
    assert(waitingOnRetry);
    if (!drainList.empty()) {
        DPRINTF(CachePort, "%s attempting to send a retry for response (%i waiting)\n"
                , name(), drainList.size());
        //We have some responses to drain first
        pkt = drainList.front();
        drainList.pop_front();
        if (sendTiming(pkt)) {
            DPRINTF(CachePort, "%s sucessful in sending a retry for"
                    "response (%i still waiting)\n", name(), drainList.size());
            if (!drainList.empty() ||
                !isCpuSide && cache->doMasterRequest() ||
                isCpuSide && cache->doSlaveRequest()) {

                DPRINTF(CachePort, "%s has more responses/requests\n", name());
                BaseCache::CacheEvent * reqCpu = new BaseCache::CacheEvent(this, false);
                reqCpu->schedule(curTick + 1);
            }
            waitingOnRetry = false;
        }
        else {
            drainList.push_front(pkt);
        }
        // Check if we're done draining once this list is empty
        if (drainList.empty())
            cache->checkDrain();
    }
    else if (!isCpuSide)
    {
        DPRINTF(CachePort, "%s attempting to send a retry for MSHR\n", name());
        if (!cache->doMasterRequest()) {
            //This can happen if I am the owner of a block and see an upgrade
            //while the block was in my WB Buffers.  I just remove the
            //wb and de-assert the masterRequest
            waitingOnRetry = false;
            return;
        }
        pkt = cache->getPacket();
        MSHR* mshr = (MSHR*) pkt->senderState;
        //Copy the packet, it may be modified/destroyed elsewhere
        PacketPtr copyPkt = new Packet(*pkt);
        copyPkt->dataStatic<uint8_t>(pkt->getPtr<uint8_t>());
        mshr->pkt = copyPkt;

        bool success = sendTiming(pkt);
        DPRINTF(Cache, "Address %x was %s in sending the timing request\n",
                pkt->getAddr(), success ? "succesful" : "unsuccesful");

        waitingOnRetry = !success;
        if (waitingOnRetry) {
            DPRINTF(CachePort, "%s now waiting on a retry\n", name());
        }

        cache->sendResult(pkt, mshr, success);

        if (success && cache->doMasterRequest())
        {
            DPRINTF(CachePort, "%s has more requests\n", name());
            //Still more to issue, rerequest in 1 cycle
            BaseCache::CacheEvent * reqCpu = new BaseCache::CacheEvent(this, false);
            reqCpu->schedule(curTick + 1);
        }
    }
    else
    {
        assert(cache->doSlaveRequest());
        //pkt = cache->getCoherencePacket();
        //We save the packet, no reordering on CSHRS
        pkt = cache->getCoherencePacket();
        MSHR* cshr = (MSHR*)pkt->senderState;
        bool success = sendTiming(pkt);
        cache->sendCoherenceResult(pkt, cshr, success);
        waitingOnRetry = !success;
        if (success && cache->doSlaveRequest())
        {
            DPRINTF(CachePort, "%s has more requests\n", name());
            //Still more to issue, rerequest in 1 cycle
            BaseCache::CacheEvent * reqCpu = new BaseCache::CacheEvent(this, false);
            reqCpu->schedule(curTick + 1);
        }
    }
    if (waitingOnRetry) DPRINTF(CachePort, "%s STILL Waiting on retry\n", name());
    else DPRINTF(CachePort, "%s no longer waiting on retry\n", name());
    return;
}
void
BaseCache::CachePort::setBlocked()
{
    assert(!blocked);
    DPRINTF(Cache, "Cache Blocking\n");
    blocked = true;
    //Clear the retry flag
    mustSendRetry = false;
}

void
BaseCache::CachePort::clearBlocked()
{
    assert(blocked);
    DPRINTF(Cache, "Cache Unblocking\n");
    blocked = false;
    if (mustSendRetry)
    {
        DPRINTF(Cache, "Cache Sending Retry\n");
        mustSendRetry = false;
        sendRetry();
    }
}

BaseCache::CacheEvent::CacheEvent(CachePort *_cachePort, bool _newResponse)
    : Event(&mainEventQueue, CPU_Tick_Pri), cachePort(_cachePort),
      newResponse(_newResponse)
{
    if (!newResponse)
        this->setFlags(AutoDelete);
    pkt = NULL;
}

void
BaseCache::CacheEvent::process()
{
    if (!newResponse)
    {
        if (cachePort->waitingOnRetry) return;
       //We have some responses to drain first
        if (!cachePort->drainList.empty()) {
            DPRINTF(CachePort, "%s trying to drain a response\n", cachePort->name());
            if (cachePort->sendTiming(cachePort->drainList.front())) {
                DPRINTF(CachePort, "%s drains a response succesfully\n", cachePort->name());
                cachePort->drainList.pop_front();
                if (!cachePort->drainList.empty() ||
                    !cachePort->isCpuSide && cachePort->cache->doMasterRequest() ||
                    cachePort->isCpuSide && cachePort->cache->doSlaveRequest()) {

                    DPRINTF(CachePort, "%s still has outstanding bus reqs\n", cachePort->name());
                    this->schedule(curTick + 1);
                }
            }
            else {
                cachePort->waitingOnRetry = true;
                DPRINTF(CachePort, "%s now waiting on a retry\n", cachePort->name());
            }
        }
        else if (!cachePort->isCpuSide)
        {            //MSHR
            DPRINTF(CachePort, "%s trying to send a MSHR request\n", cachePort->name());
            if (!cachePort->cache->doMasterRequest()) {
                //This can happen if I am the owner of a block and see an upgrade
                //while the block was in my WB Buffers.  I just remove the
                //wb and de-assert the masterRequest
                return;
            }

            pkt = cachePort->cache->getPacket();
            MSHR* mshr = (MSHR*) pkt->senderState;
            //Copy the packet, it may be modified/destroyed elsewhere
            PacketPtr copyPkt = new Packet(*pkt);
            copyPkt->dataStatic<uint8_t>(pkt->getPtr<uint8_t>());
            mshr->pkt = copyPkt;

            bool success = cachePort->sendTiming(pkt);
            DPRINTF(Cache, "Address %x was %s in sending the timing request\n",
                    pkt->getAddr(), success ? "succesful" : "unsuccesful");

            cachePort->waitingOnRetry = !success;
            if (cachePort->waitingOnRetry) {
                DPRINTF(CachePort, "%s now waiting on a retry\n", cachePort->name());
            }

            cachePort->cache->sendResult(pkt, mshr, success);
            if (success && cachePort->cache->doMasterRequest())
            {
                DPRINTF(CachePort, "%s still more MSHR requests to send\n",
                        cachePort->name());
                //Still more to issue, rerequest in 1 cycle
                pkt = NULL;
                this->schedule(curTick+1);
            }
        }
        else
        {
            //CSHR
            assert(cachePort->cache->doSlaveRequest());
            pkt = cachePort->cache->getCoherencePacket();
            MSHR* cshr = (MSHR*) pkt->senderState;
            bool success = cachePort->sendTiming(pkt);
            cachePort->cache->sendCoherenceResult(pkt, cshr, success);
            cachePort->waitingOnRetry = !success;
            if (cachePort->waitingOnRetry)
                DPRINTF(CachePort, "%s now waiting on a retry\n", cachePort->name());
            if (success && cachePort->cache->doSlaveRequest())
            {
                DPRINTF(CachePort, "%s still more CSHR requests to send\n",
                        cachePort->name());
                //Still more to issue, rerequest in 1 cycle
                pkt = NULL;
                this->schedule(curTick+1);
            }
        }
        return;
    }
    //Else it's a response
    assert(cachePort->transmitList.size());
    assert(cachePort->transmitList.front().first <= curTick);
    pkt = cachePort->transmitList.front().second;
    cachePort->transmitList.pop_front();
    if (!cachePort->transmitList.empty()) {
        Tick time = cachePort->transmitList.front().first;
        schedule(time <= curTick ? curTick+1 : time);
    }

    if (pkt->flags & NACKED_LINE)
        pkt->result = Packet::Nacked;
    else
        pkt->result = Packet::Success;
    pkt->makeTimingResponse();
    DPRINTF(CachePort, "%s attempting to send a response\n", cachePort->name());
    if (!cachePort->drainList.empty() || cachePort->waitingOnRetry) {
        //Already have a list, just append
        cachePort->drainList.push_back(pkt);
        DPRINTF(CachePort, "%s appending response onto drain list\n", cachePort->name());
    }
    else if (!cachePort->sendTiming(pkt)) {
        //It failed, save it to list of drain events
        DPRINTF(CachePort, "%s now waiting for a retry\n", cachePort->name());
        cachePort->drainList.push_back(pkt);
        cachePort->waitingOnRetry = true;
    }

    // Check if we're done draining once this list is empty
    if (cachePort->drainList.empty() && cachePort->transmitList.empty())
        cachePort->cache->checkDrain();
}

const char *
BaseCache::CacheEvent::description()
{
    return "timing event\n";
}

void
BaseCache::init()
{
    if (!cpuSidePort || !memSidePort)
        panic("Cache not hooked up on both sides\n");
    cpuSidePort->sendStatusChange(Port::RangeChange);
}

void
BaseCache::regStats()
{
    Request temp_req((Addr) NULL, 4, 0);
    Packet::Command temp_cmd = Packet::ReadReq;
    Packet temp_pkt(&temp_req, temp_cmd, 0);  //@todo FIx command strings so this isn't neccessary
    temp_pkt.allocate(); //Temp allocate, all need data

    using namespace Stats;

    // Hit statistics
    for (int access_idx = 0; access_idx < NUM_MEM_CMDS; ++access_idx) {
        Packet::Command cmd = (Packet::Command)access_idx;
        const string &cstr = temp_pkt.cmdIdxToString(cmd);

        hits[access_idx]
            .init(maxThreadsPerCPU)
            .name(name() + "." + cstr + "_hits")
            .desc("number of " + cstr + " hits")
            .flags(total | nozero | nonan)
            ;
    }

    demandHits
        .name(name() + ".demand_hits")
        .desc("number of demand (read+write) hits")
        .flags(total)
        ;
    demandHits = hits[Packet::ReadReq] + hits[Packet::WriteReq];

    overallHits
        .name(name() + ".overall_hits")
        .desc("number of overall hits")
        .flags(total)
        ;
    overallHits = demandHits + hits[Packet::SoftPFReq] + hits[Packet::HardPFReq]
        + hits[Packet::Writeback];

    // Miss statistics
    for (int access_idx = 0; access_idx < NUM_MEM_CMDS; ++access_idx) {
        Packet::Command cmd = (Packet::Command)access_idx;
        const string &cstr = temp_pkt.cmdIdxToString(cmd);

        misses[access_idx]
            .init(maxThreadsPerCPU)
            .name(name() + "." + cstr + "_misses")
            .desc("number of " + cstr + " misses")
            .flags(total | nozero | nonan)
            ;
    }

    demandMisses
        .name(name() + ".demand_misses")
        .desc("number of demand (read+write) misses")
        .flags(total)
        ;
    demandMisses = misses[Packet::ReadReq] + misses[Packet::WriteReq];

    overallMisses
        .name(name() + ".overall_misses")
        .desc("number of overall misses")
        .flags(total)
        ;
    overallMisses = demandMisses + misses[Packet::SoftPFReq] +
        misses[Packet::HardPFReq] + misses[Packet::Writeback];

    // Miss latency statistics
    for (int access_idx = 0; access_idx < NUM_MEM_CMDS; ++access_idx) {
        Packet::Command cmd = (Packet::Command)access_idx;
        const string &cstr = temp_pkt.cmdIdxToString(cmd);

        missLatency[access_idx]
            .init(maxThreadsPerCPU)
            .name(name() + "." + cstr + "_miss_latency")
            .desc("number of " + cstr + " miss cycles")
            .flags(total | nozero | nonan)
            ;
    }

    demandMissLatency
        .name(name() + ".demand_miss_latency")
        .desc("number of demand (read+write) miss cycles")
        .flags(total)
        ;
    demandMissLatency = missLatency[Packet::ReadReq] + missLatency[Packet::WriteReq];

    overallMissLatency
        .name(name() + ".overall_miss_latency")
        .desc("number of overall miss cycles")
        .flags(total)
        ;
    overallMissLatency = demandMissLatency + missLatency[Packet::SoftPFReq] +
        missLatency[Packet::HardPFReq];

    // access formulas
    for (int access_idx = 0; access_idx < NUM_MEM_CMDS; ++access_idx) {
        Packet::Command cmd = (Packet::Command)access_idx;
        const string &cstr = temp_pkt.cmdIdxToString(cmd);

        accesses[access_idx]
            .name(name() + "." + cstr + "_accesses")
            .desc("number of " + cstr + " accesses(hits+misses)")
            .flags(total | nozero | nonan)
            ;

        accesses[access_idx] = hits[access_idx] + misses[access_idx];
    }

    demandAccesses
        .name(name() + ".demand_accesses")
        .desc("number of demand (read+write) accesses")
        .flags(total)
        ;
    demandAccesses = demandHits + demandMisses;

    overallAccesses
        .name(name() + ".overall_accesses")
        .desc("number of overall (read+write) accesses")
        .flags(total)
        ;
    overallAccesses = overallHits + overallMisses;

    // miss rate formulas
    for (int access_idx = 0; access_idx < NUM_MEM_CMDS; ++access_idx) {
        Packet::Command cmd = (Packet::Command)access_idx;
        const string &cstr = temp_pkt.cmdIdxToString(cmd);

        missRate[access_idx]
            .name(name() + "." + cstr + "_miss_rate")
            .desc("miss rate for " + cstr + " accesses")
            .flags(total | nozero | nonan)
            ;

        missRate[access_idx] = misses[access_idx] / accesses[access_idx];
    }

    demandMissRate
        .name(name() + ".demand_miss_rate")
        .desc("miss rate for demand accesses")
        .flags(total)
        ;
    demandMissRate = demandMisses / demandAccesses;

    overallMissRate
        .name(name() + ".overall_miss_rate")
        .desc("miss rate for overall accesses")
        .flags(total)
        ;
    overallMissRate = overallMisses / overallAccesses;

    // miss latency formulas
    for (int access_idx = 0; access_idx < NUM_MEM_CMDS; ++access_idx) {
        Packet::Command cmd = (Packet::Command)access_idx;
        const string &cstr = temp_pkt.cmdIdxToString(cmd);

        avgMissLatency[access_idx]
            .name(name() + "." + cstr + "_avg_miss_latency")
            .desc("average " + cstr + " miss latency")
            .flags(total | nozero | nonan)
            ;

        avgMissLatency[access_idx] =
            missLatency[access_idx] / misses[access_idx];
    }

    demandAvgMissLatency
        .name(name() + ".demand_avg_miss_latency")
        .desc("average overall miss latency")
        .flags(total)
        ;
    demandAvgMissLatency = demandMissLatency / demandMisses;

    overallAvgMissLatency
        .name(name() + ".overall_avg_miss_latency")
        .desc("average overall miss latency")
        .flags(total)
        ;
    overallAvgMissLatency = overallMissLatency / overallMisses;

    blocked_cycles.init(NUM_BLOCKED_CAUSES);
    blocked_cycles
        .name(name() + ".blocked_cycles")
        .desc("number of cycles access was blocked")
        .subname(Blocked_NoMSHRs, "no_mshrs")
        .subname(Blocked_NoTargets, "no_targets")
        ;


    blocked_causes.init(NUM_BLOCKED_CAUSES);
    blocked_causes
        .name(name() + ".blocked")
        .desc("number of cycles access was blocked")
        .subname(Blocked_NoMSHRs, "no_mshrs")
        .subname(Blocked_NoTargets, "no_targets")
        ;

    avg_blocked
        .name(name() + ".avg_blocked_cycles")
        .desc("average number of cycles each access was blocked")
        .subname(Blocked_NoMSHRs, "no_mshrs")
        .subname(Blocked_NoTargets, "no_targets")
        ;

    avg_blocked = blocked_cycles / blocked_causes;

    fastWrites
        .name(name() + ".fast_writes")
        .desc("number of fast writes performed")
        ;

    cacheCopies
        .name(name() + ".cache_copies")
        .desc("number of cache copies performed")
        ;

}

unsigned int
BaseCache::drain(Event *de)
{
    // Set status
    if (!canDrain()) {
        drainEvent = de;

        changeState(SimObject::Draining);
        return 1;
    }

    changeState(SimObject::Drained);
    return 0;
}