summaryrefslogtreecommitdiff
path: root/src/mem/ruby/system/Sequencer.cc
blob: a473ccf445b9d8f4ad45cf6b8595abac5ca40d7c (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
/*
 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
 * 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.
 */

#include "cpu/rubytest/RubyTester.hh"
#include "mem/gems_common/Map.hh"
#include "mem/protocol/CacheMsg.hh"
#include "mem/protocol/Protocol.hh"
#include "mem/protocol/Protocol.hh"
#include "mem/ruby/buffers/MessageBuffer.hh"
#include "mem/ruby/common/Global.hh"
#include "mem/ruby/common/SubBlock.hh"
#include "mem/ruby/libruby.hh"
#include "mem/ruby/profiler/Profiler.hh"
#include "mem/ruby/recorder/Tracer.hh"
#include "mem/ruby/slicc_interface/AbstractController.hh"
#include "mem/ruby/system/CacheMemory.hh"
#include "mem/ruby/system/Sequencer.hh"
#include "mem/ruby/system/System.hh"
#include "params/RubySequencer.hh"

Sequencer *
RubySequencerParams::create()
{
    return new Sequencer(this);
}

Sequencer::Sequencer(const Params *p)
    : RubyPort(p), deadlockCheckEvent(this)
{
    m_store_waiting_on_load_cycles = 0;
    m_store_waiting_on_store_cycles = 0;
    m_load_waiting_on_store_cycles = 0;
    m_load_waiting_on_load_cycles = 0;

    m_outstanding_count = 0;

    m_max_outstanding_requests = 0;
    m_deadlock_threshold = 0;
    m_instCache_ptr = NULL;
    m_dataCache_ptr = NULL;

    m_instCache_ptr = p->icache;
    m_dataCache_ptr = p->dcache;
    m_max_outstanding_requests = p->max_outstanding_requests;
    m_deadlock_threshold = p->deadlock_threshold;
    m_usingRubyTester = p->using_ruby_tester;

    assert(m_max_outstanding_requests > 0);
    assert(m_deadlock_threshold > 0);
    assert(m_instCache_ptr != NULL);
    assert(m_dataCache_ptr != NULL);
}

Sequencer::~Sequencer()
{
}

void
Sequencer::wakeup()
{
    // Check for deadlock of any of the requests
    Time current_time = g_eventQueue_ptr->getTime();

    // Check across all outstanding requests
    int total_outstanding = 0;

    Vector<Address> keys = m_readRequestTable.keys();
    for (int i = 0; i < keys.size(); i++) {
        SequencerRequest* request = m_readRequestTable.lookup(keys[i]);
        if (current_time - request->issue_time >= m_deadlock_threshold) {
            WARN_MSG("Possible Deadlock detected");
            WARN_EXPR(request);
            WARN_EXPR(m_version);
            WARN_EXPR(request->ruby_request.paddr);
            WARN_EXPR(keys.size());
            WARN_EXPR(current_time);
            WARN_EXPR(request->issue_time);
            WARN_EXPR(current_time - request->issue_time);
            ERROR_MSG("Aborting");
        }
    }

    keys = m_writeRequestTable.keys();
    for (int i = 0; i < keys.size(); i++) {
        SequencerRequest* request = m_writeRequestTable.lookup(keys[i]);
        if (current_time - request->issue_time >= m_deadlock_threshold) {
            WARN_MSG("Possible Deadlock detected");
            WARN_EXPR(request);
            WARN_EXPR(m_version);
            WARN_EXPR(current_time);
            WARN_EXPR(request->issue_time);
            WARN_EXPR(current_time - request->issue_time);
            WARN_EXPR(keys.size());
            ERROR_MSG("Aborting");
        }
    }

    total_outstanding += m_writeRequestTable.size();
    total_outstanding += m_readRequestTable.size();

    assert(m_outstanding_count == total_outstanding);

    if (m_outstanding_count > 0) {
        // If there are still outstanding requests, keep checking
        schedule(deadlockCheckEvent,
                 m_deadlock_threshold * g_eventQueue_ptr->getClock() +
                 curTick);
    }
}

void
Sequencer::printStats(ostream & out) const
{
    out << "Sequencer: " << m_name << endl
        << "  store_waiting_on_load_cycles: "
        << m_store_waiting_on_load_cycles << endl
        << "  store_waiting_on_store_cycles: "
        << m_store_waiting_on_store_cycles << endl
        << "  load_waiting_on_load_cycles: "
        << m_load_waiting_on_load_cycles << endl
        << "  load_waiting_on_store_cycles: "
        << m_load_waiting_on_store_cycles << endl;
}

void
Sequencer::printProgress(ostream& out) const
{
#if 0
    int total_demand = 0;
    out << "Sequencer Stats Version " << m_version << endl;
    out << "Current time = " << g_eventQueue_ptr->getTime() << endl;
    out << "---------------" << endl;
    out << "outstanding requests" << endl;

    Vector<Address> rkeys = m_readRequestTable.keys();
    int read_size = rkeys.size();
    out << "proc " << m_version << " Read Requests = " << read_size << endl;

    // print the request table
    for (int i = 0; i < read_size; ++i) {
        SequencerRequest *request = m_readRequestTable.lookup(rkeys[i]);
        out << "\tRequest[ " << i << " ] = " << request->type
            << " Address " << rkeys[i]
            << " Posted " << request->issue_time
            << " PF " << PrefetchBit_No << endl;
        total_demand++;
    }

    Vector<Address> wkeys = m_writeRequestTable.keys();
    int write_size = wkeys.size();
    out << "proc " << m_version << " Write Requests = " << write_size << endl;

    // print the request table
    for (int i = 0; i < write_size; ++i){
        CacheMsg &request = m_writeRequestTable.lookup(wkeys[i]);
        out << "\tRequest[ " << i << " ] = " << request.getType()
            << " Address " << wkeys[i]
            << " Posted " << request.getTime()
            << " PF " << request.getPrefetch() << endl;
        if (request.getPrefetch() == PrefetchBit_No) {
            total_demand++;
        }
    }

    out << endl;

    out << "Total Number Outstanding: " << m_outstanding_count << endl
        << "Total Number Demand     : " << total_demand << endl
        << "Total Number Prefetches : " << m_outstanding_count - total_demand
        << endl << endl << endl;
#endif
}

void
Sequencer::printConfig(ostream& out) const
{
    out << "Seqeuncer config: " << m_name << endl
        << "  controller: " << m_controller->getName() << endl
        << "  version: " << m_version << endl
        << "  max_outstanding_requests: " << m_max_outstanding_requests << endl
        << "  deadlock_threshold: " << m_deadlock_threshold << endl;
}

// Insert the request on the correct request table.  Return true if
// the entry was already present.
bool
Sequencer::insertRequest(SequencerRequest* request)
{
    int total_outstanding =
        m_writeRequestTable.size() + m_readRequestTable.size();

    assert(m_outstanding_count == total_outstanding);

    // See if we should schedule a deadlock check
    if (deadlockCheckEvent.scheduled() == false) {
        schedule(deadlockCheckEvent, m_deadlock_threshold + curTick);
    }

    Address line_addr(request->ruby_request.paddr);
    line_addr.makeLineAddress();
    if ((request->ruby_request.type == RubyRequestType_ST) ||
        (request->ruby_request.type == RubyRequestType_RMW_Read) ||
        (request->ruby_request.type == RubyRequestType_RMW_Write) ||
        (request->ruby_request.type == RubyRequestType_Locked_Read) ||
        (request->ruby_request.type == RubyRequestType_Locked_Write)) {
        if (m_writeRequestTable.exist(line_addr)) {
            m_writeRequestTable.lookup(line_addr) = request;
            // return true;

            // drh5: isn't this an error?  do you lose the initial request?
            assert(0);
        }
        m_writeRequestTable.allocate(line_addr);
        m_writeRequestTable.lookup(line_addr) = request;
        m_outstanding_count++;
    } else {
        if (m_readRequestTable.exist(line_addr)) {
            m_readRequestTable.lookup(line_addr) = request;
            // return true;

            // drh5: isn't this an error?  do you lose the initial request?
            assert(0);
        }
        m_readRequestTable.allocate(line_addr);
        m_readRequestTable.lookup(line_addr) = request;
        m_outstanding_count++;
    }

    g_system_ptr->getProfiler()->sequencerRequests(m_outstanding_count);

    total_outstanding = m_writeRequestTable.size() + m_readRequestTable.size();
    assert(m_outstanding_count == total_outstanding);

    return false;
}

void
Sequencer::removeRequest(SequencerRequest* srequest)
{
    assert(m_outstanding_count ==
           m_writeRequestTable.size() + m_readRequestTable.size());

    const RubyRequest & ruby_request = srequest->ruby_request;
    Address line_addr(ruby_request.paddr);
    line_addr.makeLineAddress();
    if ((ruby_request.type == RubyRequestType_ST) ||
        (ruby_request.type == RubyRequestType_RMW_Read) ||
        (ruby_request.type == RubyRequestType_RMW_Write) ||
        (ruby_request.type == RubyRequestType_Locked_Read) ||
        (ruby_request.type == RubyRequestType_Locked_Write)) {
        m_writeRequestTable.deallocate(line_addr);
    } else {
        m_readRequestTable.deallocate(line_addr);
    }
    m_outstanding_count--;

    assert(m_outstanding_count == m_writeRequestTable.size() + m_readRequestTable.size());
}

void
Sequencer::writeCallback(const Address& address, DataBlock& data)
{
    assert(address == line_address(address));
    assert(m_writeRequestTable.exist(line_address(address)));

    SequencerRequest* request = m_writeRequestTable.lookup(address);

    removeRequest(request);

    assert((request->ruby_request.type == RubyRequestType_ST) ||
           (request->ruby_request.type == RubyRequestType_RMW_Read) ||
           (request->ruby_request.type == RubyRequestType_RMW_Write) ||
           (request->ruby_request.type == RubyRequestType_Locked_Read) ||
           (request->ruby_request.type == RubyRequestType_Locked_Write));

    if (request->ruby_request.type == RubyRequestType_Locked_Read) {
        m_dataCache_ptr->setLocked(address, m_version);
    } else if (request->ruby_request.type == RubyRequestType_RMW_Read) {
        m_controller->blockOnQueue(address, m_mandatory_q_ptr);
    } else if (request->ruby_request.type == RubyRequestType_RMW_Write) {
        m_controller->unblock(address);
    }

    hitCallback(request, data);
}

void
Sequencer::readCallback(const Address& address, DataBlock& data)
{
    assert(address == line_address(address));
    assert(m_readRequestTable.exist(line_address(address)));

    SequencerRequest* request = m_readRequestTable.lookup(address);
    removeRequest(request);

    assert((request->ruby_request.type == RubyRequestType_LD) ||
           (request->ruby_request.type == RubyRequestType_RMW_Read) ||
           (request->ruby_request.type == RubyRequestType_IFETCH));

    hitCallback(request, data);
}

void
Sequencer::hitCallback(SequencerRequest* srequest, DataBlock& data)
{
    const RubyRequest & ruby_request = srequest->ruby_request;
    Address request_address(ruby_request.paddr);
    Address request_line_address(ruby_request.paddr);
    request_line_address.makeLineAddress();
    RubyRequestType type = ruby_request.type;
    Time issued_time = srequest->issue_time;

    // Set this cache entry to the most recently used
    if (type == RubyRequestType_IFETCH) {
        if (m_instCache_ptr->isTagPresent(request_line_address))
            m_instCache_ptr->setMRU(request_line_address);
    } else {
        if (m_dataCache_ptr->isTagPresent(request_line_address))
            m_dataCache_ptr->setMRU(request_line_address);
    }

    assert(g_eventQueue_ptr->getTime() >= issued_time);
    Time miss_latency = g_eventQueue_ptr->getTime() - issued_time;

    // Profile the miss latency for all non-zero demand misses
    if (miss_latency != 0) {
        g_system_ptr->getProfiler()->missLatency(miss_latency, type);

        if (Debug::getProtocolTrace()) {
            g_system_ptr->getProfiler()->
                profileTransition("Seq", m_version,
                                  Address(ruby_request.paddr), "", "Done", "",
                                  csprintf("%d cycles", miss_latency));
        }
    }
#if 0
    if (request.getPrefetch() == PrefetchBit_Yes) {
        return; // Ignore the prefetch
    }
#endif

    // update the data
    if (ruby_request.data != NULL) {
        if ((type == RubyRequestType_LD) ||
            (type == RubyRequestType_IFETCH) ||
            (type == RubyRequestType_RMW_Read) ||
            (type == RubyRequestType_Locked_Read)) {

            memcpy(ruby_request.data,
                   data.getData(request_address.getOffset(), ruby_request.len),
                   ruby_request.len);
        } else {
            data.setData(ruby_request.data, request_address.getOffset(),
                         ruby_request.len);
        }
    } else {
        DPRINTF(MemoryAccess,
                "WARNING.  Data not transfered from Ruby to M5 for type %s\n",
                RubyRequestType_to_string(type));
    }

    // If using the RubyTester, update the RubyTester sender state's
    // subBlock with the recieved data.  The tester will later access
    // this state.
    // Note: RubyPort will access it's sender state before the
    // RubyTester.
    if (m_usingRubyTester) {
        RubyPort::SenderState *requestSenderState =
            safe_cast<RubyPort::SenderState*>(ruby_request.pkt->senderState);
        RubyTester::SenderState* testerSenderState =
            safe_cast<RubyTester::SenderState*>(requestSenderState->saved);
        testerSenderState->subBlock->mergeFrom(data);
    }

    ruby_hit_callback(ruby_request.pkt);
    delete srequest;
}

// Returns true if the sequencer already has a load or store outstanding
RequestStatus
Sequencer::getRequestStatus(const RubyRequest& request)
{
    bool is_outstanding_store =
        m_writeRequestTable.exist(line_address(Address(request.paddr)));
    bool is_outstanding_load =
        m_readRequestTable.exist(line_address(Address(request.paddr)));
    if (is_outstanding_store) {
        if ((request.type == RubyRequestType_LD) ||
            (request.type == RubyRequestType_IFETCH) ||
            (request.type == RubyRequestType_RMW_Read)) {
            m_store_waiting_on_load_cycles++;
        } else {
            m_store_waiting_on_store_cycles++;
        }
        return RequestStatus_Aliased;
    } else if (is_outstanding_load) {
        if ((request.type == RubyRequestType_ST) ||
            (request.type == RubyRequestType_RMW_Write)) {
            m_load_waiting_on_store_cycles++;
        } else {
            m_load_waiting_on_load_cycles++;
        }
        return RequestStatus_Aliased;
    }

    if (m_outstanding_count >= m_max_outstanding_requests) {
        return RequestStatus_BufferFull;
    }

    return RequestStatus_Ready;
}

bool
Sequencer::empty() const
{
    return m_writeRequestTable.size() == 0 && m_readRequestTable.size() == 0;
}

RequestStatus
Sequencer::makeRequest(const RubyRequest &request)
{
    assert(Address(request.paddr).getOffset() + request.len <=
           RubySystem::getBlockSizeBytes());
    RequestStatus status = getRequestStatus(request);
    if (status != RequestStatus_Ready)
        return status;

    SequencerRequest *srequest =
        new SequencerRequest(request, g_eventQueue_ptr->getTime());
    bool found = insertRequest(srequest);
    if (found) {
        panic("Sequencer::makeRequest should never be called if the "
              "request is already outstanding\n");
        return RequestStatus_NULL;
    }

    if (request.type == RubyRequestType_Locked_Write) {
        // NOTE: it is OK to check the locked flag here as the
        // mandatory queue will be checked first ensuring that nothing
        // comes between checking the flag and servicing the store.

        Address line_addr = line_address(Address(request.paddr));
        if (!m_dataCache_ptr->isLocked(line_addr, m_version)) {
            removeRequest(srequest);
            if (Debug::getProtocolTrace()) {
                g_system_ptr->getProfiler()->
                    profileTransition("Seq", m_version,
                                      Address(request.paddr),
                                      "", "SC Fail", "",
                                      RubyRequestType_to_string(request.type));
            }
            return RequestStatus_LlscFailed;
        } else {
            m_dataCache_ptr->clearLocked(line_addr);
        }
    }
    issueRequest(request);

    // TODO: issue hardware prefetches here
    return RequestStatus_Issued;
}

void
Sequencer::issueRequest(const RubyRequest& request)
{
    // TODO: get rid of CacheMsg, CacheRequestType, and
    // AccessModeTYpe, & have SLICC use RubyRequest and subtypes
    // natively
    CacheRequestType ctype;
    switch(request.type) {
      case RubyRequestType_IFETCH:
        ctype = CacheRequestType_IFETCH;
        break;
      case RubyRequestType_LD:
        ctype = CacheRequestType_LD;
        break;
      case RubyRequestType_ST:
        ctype = CacheRequestType_ST;
        break;
      case RubyRequestType_Locked_Read:
      case RubyRequestType_Locked_Write:
        ctype = CacheRequestType_ATOMIC;
        break;
      case RubyRequestType_RMW_Read:
        ctype = CacheRequestType_ATOMIC;
        break;
      case RubyRequestType_RMW_Write:
        ctype = CacheRequestType_ATOMIC;
        break;
      default:
        assert(0);
    }

    AccessModeType amtype;
    switch(request.access_mode){
      case RubyAccessMode_User:
        amtype = AccessModeType_UserMode;
        break;
      case RubyAccessMode_Supervisor:
        amtype = AccessModeType_SupervisorMode;
        break;
      case RubyAccessMode_Device:
        amtype = AccessModeType_UserMode;
        break;
      default:
        assert(0);
    }

    Address line_addr(request.paddr);
    line_addr.makeLineAddress();
    CacheMsg msg(line_addr, Address(request.paddr), ctype,
                 Address(request.pc), amtype, request.len, PrefetchBit_No,
                 request.proc_id);

    if (Debug::getProtocolTrace()) {
        g_system_ptr->getProfiler()->
            profileTransition("Seq", m_version, Address(request.paddr),
                              "", "Begin", "",
                              RubyRequestType_to_string(request.type));
    }

    if (g_system_ptr->getTracer()->traceEnabled()) {
        g_system_ptr->getTracer()->
            traceRequest(this, line_addr, Address(request.pc),
                         request.type, g_eventQueue_ptr->getTime());
    }

    Time latency = 0;  // initialzed to an null value

    if (request.type == RubyRequestType_IFETCH)
        latency = m_instCache_ptr->getLatency();
    else
        latency = m_dataCache_ptr->getLatency();

    // Send the message to the cache controller
    assert(latency > 0);

    assert(m_mandatory_q_ptr != NULL);
    m_mandatory_q_ptr->enqueue(msg, latency);
}

#if 0
bool
Sequencer::tryCacheAccess(const Address& addr, CacheRequestType type,
                          AccessModeType access_mode,
                          int size, DataBlock*& data_ptr)
{
    CacheMemory *cache =
        (type == CacheRequestType_IFETCH) ? m_instCache_ptr : m_dataCache_ptr;

    return cache->tryCacheAccess(line_address(addr), type, data_ptr);
}
#endif

void
Sequencer::print(ostream& out) const
{
    out << "[Sequencer: " << m_version
        << ", outstanding requests: " << m_outstanding_count
        << ", read request table: " << m_readRequestTable
        << ", write request table: " << m_writeRequestTable
        << "]";
}

// this can be called from setState whenever coherence permissions are
// upgraded when invoked, coherence violations will be checked for the
// given block
void
Sequencer::checkCoherence(const Address& addr)
{
#ifdef CHECK_COHERENCE
    g_system_ptr->checkGlobalCoherenceInvariant(addr);
#endif
}