Sequencer.cc revision 7537
1/* 2 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood 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 29#include "base/str.hh" 30#include "cpu/rubytest/RubyTester.hh" 31#include "mem/protocol/CacheMsg.hh" 32#include "mem/protocol/Protocol.hh" 33#include "mem/protocol/Protocol.hh" 34#include "mem/ruby/buffers/MessageBuffer.hh" 35#include "mem/ruby/common/Global.hh" 36#include "mem/ruby/common/SubBlock.hh" 37#include "mem/ruby/libruby.hh" 38#include "mem/ruby/profiler/Profiler.hh" 39#include "mem/ruby/recorder/Tracer.hh" 40#include "mem/ruby/slicc_interface/AbstractController.hh" 41#include "mem/ruby/system/CacheMemory.hh" 42#include "mem/ruby/system/Sequencer.hh" 43#include "mem/ruby/system/System.hh" 44#include "params/RubySequencer.hh" 45 46using namespace std; 47 48Sequencer * 49RubySequencerParams::create() 50{ 51 return new Sequencer(this); 52} 53 54Sequencer::Sequencer(const Params *p) 55 : RubyPort(p), deadlockCheckEvent(this) 56{ 57 m_store_waiting_on_load_cycles = 0; 58 m_store_waiting_on_store_cycles = 0; 59 m_load_waiting_on_store_cycles = 0; 60 m_load_waiting_on_load_cycles = 0; 61 62 m_outstanding_count = 0; 63 64 m_max_outstanding_requests = 0; 65 m_deadlock_threshold = 0; 66 m_instCache_ptr = NULL; 67 m_dataCache_ptr = NULL; 68 69 m_instCache_ptr = p->icache; 70 m_dataCache_ptr = p->dcache; 71 m_max_outstanding_requests = p->max_outstanding_requests; 72 m_deadlock_threshold = p->deadlock_threshold; 73 m_usingRubyTester = p->using_ruby_tester; 74 75 assert(m_max_outstanding_requests > 0); 76 assert(m_deadlock_threshold > 0); 77 assert(m_instCache_ptr != NULL); 78 assert(m_dataCache_ptr != NULL); 79} 80 81Sequencer::~Sequencer() 82{ 83} 84 85void 86Sequencer::wakeup() 87{ 88 // Check for deadlock of any of the requests 89 Time current_time = g_eventQueue_ptr->getTime(); 90 91 // Check across all outstanding requests 92 int total_outstanding = 0; 93 94 RequestTable::iterator read = m_readRequestTable.begin(); 95 RequestTable::iterator read_end = m_readRequestTable.end(); 96 for (; read != read_end; ++read) { 97 SequencerRequest* request = read->second; 98 if (current_time - request->issue_time < m_deadlock_threshold) 99 continue; 100 101 WARN_MSG("Possible Deadlock detected"); 102 WARN_EXPR(m_version); 103 WARN_EXPR(request->ruby_request.paddr); 104 WARN_EXPR(m_readRequestTable.size()); 105 WARN_EXPR(current_time); 106 WARN_EXPR(request->issue_time); 107 WARN_EXPR(current_time - request->issue_time); 108 ERROR_MSG("Aborting"); 109 } 110 111 RequestTable::iterator write = m_writeRequestTable.begin(); 112 RequestTable::iterator write_end = m_writeRequestTable.end(); 113 for (; write != write_end; ++write) { 114 SequencerRequest* request = write->second; 115 if (current_time - request->issue_time < m_deadlock_threshold) 116 continue; 117 118 WARN_MSG("Possible Deadlock detected"); 119 WARN_EXPR(m_version); 120 WARN_EXPR(request->ruby_request.paddr); 121 WARN_EXPR(current_time); 122 WARN_EXPR(request->issue_time); 123 WARN_EXPR(current_time - request->issue_time); 124 WARN_EXPR(m_writeRequestTable.size()); 125 ERROR_MSG("Aborting"); 126 } 127 128 total_outstanding += m_writeRequestTable.size(); 129 total_outstanding += m_readRequestTable.size(); 130 131 assert(m_outstanding_count == total_outstanding); 132 133 if (m_outstanding_count > 0) { 134 // If there are still outstanding requests, keep checking 135 schedule(deadlockCheckEvent, 136 m_deadlock_threshold * g_eventQueue_ptr->getClock() + 137 curTick); 138 } 139} 140 141void 142Sequencer::printStats(ostream & out) const 143{ 144 out << "Sequencer: " << m_name << endl 145 << " store_waiting_on_load_cycles: " 146 << m_store_waiting_on_load_cycles << endl 147 << " store_waiting_on_store_cycles: " 148 << m_store_waiting_on_store_cycles << endl 149 << " load_waiting_on_load_cycles: " 150 << m_load_waiting_on_load_cycles << endl 151 << " load_waiting_on_store_cycles: " 152 << m_load_waiting_on_store_cycles << endl; 153} 154 155void 156Sequencer::printProgress(ostream& out) const 157{ 158#if 0 159 int total_demand = 0; 160 out << "Sequencer Stats Version " << m_version << endl; 161 out << "Current time = " << g_eventQueue_ptr->getTime() << endl; 162 out << "---------------" << endl; 163 out << "outstanding requests" << endl; 164 165 out << "proc " << m_Read 166 << " version Requests = " << m_readRequestTable.size() << endl; 167 168 // print the request table 169 RequestTable::iterator read = m_readRequestTable.begin(); 170 RequestTable::iterator read_end = m_readRequestTable.end(); 171 for (; read != read_end; ++read) { 172 SequencerRequest* request = read->second; 173 out << "\tRequest[ " << i << " ] = " << request->type 174 << " Address " << rkeys[i] 175 << " Posted " << request->issue_time 176 << " PF " << PrefetchBit_No << endl; 177 total_demand++; 178 } 179 180 out << "proc " << m_version 181 << " Write Requests = " << m_writeRequestTable.size << endl; 182 183 // print the request table 184 RequestTable::iterator write = m_writeRequestTable.begin(); 185 RequestTable::iterator write_end = m_writeRequestTable.end(); 186 for (; write != write_end; ++write) { 187 SequencerRequest* request = write->second; 188 out << "\tRequest[ " << i << " ] = " << request.getType() 189 << " Address " << wkeys[i] 190 << " Posted " << request.getTime() 191 << " PF " << request.getPrefetch() << endl; 192 if (request.getPrefetch() == PrefetchBit_No) { 193 total_demand++; 194 } 195 } 196 197 out << endl; 198 199 out << "Total Number Outstanding: " << m_outstanding_count << endl 200 << "Total Number Demand : " << total_demand << endl 201 << "Total Number Prefetches : " << m_outstanding_count - total_demand 202 << endl << endl << endl; 203#endif 204} 205 206void 207Sequencer::printConfig(ostream& out) const 208{ 209 out << "Seqeuncer config: " << m_name << endl 210 << " controller: " << m_controller->getName() << endl 211 << " version: " << m_version << endl 212 << " max_outstanding_requests: " << m_max_outstanding_requests << endl 213 << " deadlock_threshold: " << m_deadlock_threshold << endl; 214} 215 216// Insert the request on the correct request table. Return true if 217// the entry was already present. 218bool 219Sequencer::insertRequest(SequencerRequest* request) 220{ 221 int total_outstanding = 222 m_writeRequestTable.size() + m_readRequestTable.size(); 223 224 assert(m_outstanding_count == total_outstanding); 225 226 // See if we should schedule a deadlock check 227 if (deadlockCheckEvent.scheduled() == false) { 228 schedule(deadlockCheckEvent, m_deadlock_threshold + curTick); 229 } 230 231 Address line_addr(request->ruby_request.paddr); 232 line_addr.makeLineAddress(); 233 if ((request->ruby_request.type == RubyRequestType_ST) || 234 (request->ruby_request.type == RubyRequestType_RMW_Read) || 235 (request->ruby_request.type == RubyRequestType_RMW_Write) || 236 (request->ruby_request.type == RubyRequestType_Locked_Read) || 237 (request->ruby_request.type == RubyRequestType_Locked_Write)) { 238 pair<RequestTable::iterator, bool> r = 239 m_writeRequestTable.insert(RequestTable::value_type(line_addr, 0)); 240 bool success = r.second; 241 RequestTable::iterator i = r.first; 242 if (!success) { 243 i->second = request; 244 // return true; 245 246 // drh5: isn't this an error? do you lose the initial request? 247 assert(0); 248 } 249 i->second = request; 250 m_outstanding_count++; 251 } else { 252 pair<RequestTable::iterator, bool> r = 253 m_readRequestTable.insert(RequestTable::value_type(line_addr, 0)); 254 bool success = r.second; 255 RequestTable::iterator i = r.first; 256 if (!success) { 257 i->second = request; 258 // return true; 259 260 // drh5: isn't this an error? do you lose the initial request? 261 assert(0); 262 } 263 i->second = request; 264 m_outstanding_count++; 265 } 266 267 g_system_ptr->getProfiler()->sequencerRequests(m_outstanding_count); 268 269 total_outstanding = m_writeRequestTable.size() + m_readRequestTable.size(); 270 assert(m_outstanding_count == total_outstanding); 271 272 return false; 273} 274 275void 276Sequencer::markRemoved() 277{ 278 m_outstanding_count--; 279 assert(m_outstanding_count == 280 m_writeRequestTable.size() + m_readRequestTable.size()); 281} 282 283void 284Sequencer::removeRequest(SequencerRequest* srequest) 285{ 286 assert(m_outstanding_count == 287 m_writeRequestTable.size() + m_readRequestTable.size()); 288 289 const RubyRequest & ruby_request = srequest->ruby_request; 290 Address line_addr(ruby_request.paddr); 291 line_addr.makeLineAddress(); 292 if ((ruby_request.type == RubyRequestType_ST) || 293 (ruby_request.type == RubyRequestType_RMW_Read) || 294 (ruby_request.type == RubyRequestType_RMW_Write) || 295 (ruby_request.type == RubyRequestType_Locked_Read) || 296 (ruby_request.type == RubyRequestType_Locked_Write)) { 297 m_writeRequestTable.erase(line_addr); 298 } else { 299 m_readRequestTable.erase(line_addr); 300 } 301 302 markRemoved(); 303} 304 305void 306Sequencer::writeCallback(const Address& address, DataBlock& data) 307{ 308 assert(address == line_address(address)); 309 assert(m_writeRequestTable.count(line_address(address))); 310 311 RequestTable::iterator i = m_writeRequestTable.find(address); 312 assert(i != m_writeRequestTable.end()); 313 SequencerRequest* request = i->second; 314 315 m_writeRequestTable.erase(i); 316 markRemoved(); 317 318 assert((request->ruby_request.type == RubyRequestType_ST) || 319 (request->ruby_request.type == RubyRequestType_RMW_Read) || 320 (request->ruby_request.type == RubyRequestType_RMW_Write) || 321 (request->ruby_request.type == RubyRequestType_Locked_Read) || 322 (request->ruby_request.type == RubyRequestType_Locked_Write)); 323 324 if (request->ruby_request.type == RubyRequestType_Locked_Read) { 325 m_dataCache_ptr->setLocked(address, m_version); 326 } else if (request->ruby_request.type == RubyRequestType_RMW_Read) { 327 m_controller->blockOnQueue(address, m_mandatory_q_ptr); 328 } else if (request->ruby_request.type == RubyRequestType_RMW_Write) { 329 m_controller->unblock(address); 330 } 331 332 hitCallback(request, data); 333} 334 335void 336Sequencer::readCallback(const Address& address, DataBlock& data) 337{ 338 assert(address == line_address(address)); 339 assert(m_readRequestTable.count(line_address(address))); 340 341 RequestTable::iterator i = m_readRequestTable.find(address); 342 assert(i != m_readRequestTable.end()); 343 SequencerRequest* request = i->second; 344 345 m_readRequestTable.erase(i); 346 markRemoved(); 347 348 assert((request->ruby_request.type == RubyRequestType_LD) || 349 (request->ruby_request.type == RubyRequestType_RMW_Read) || 350 (request->ruby_request.type == RubyRequestType_IFETCH)); 351 352 hitCallback(request, data); 353} 354 355void 356Sequencer::hitCallback(SequencerRequest* srequest, DataBlock& data) 357{ 358 const RubyRequest & ruby_request = srequest->ruby_request; 359 Address request_address(ruby_request.paddr); 360 Address request_line_address(ruby_request.paddr); 361 request_line_address.makeLineAddress(); 362 RubyRequestType type = ruby_request.type; 363 Time issued_time = srequest->issue_time; 364 365 // Set this cache entry to the most recently used 366 if (type == RubyRequestType_IFETCH) { 367 if (m_instCache_ptr->isTagPresent(request_line_address)) 368 m_instCache_ptr->setMRU(request_line_address); 369 } else { 370 if (m_dataCache_ptr->isTagPresent(request_line_address)) 371 m_dataCache_ptr->setMRU(request_line_address); 372 } 373 374 assert(g_eventQueue_ptr->getTime() >= issued_time); 375 Time miss_latency = g_eventQueue_ptr->getTime() - issued_time; 376 377 // Profile the miss latency for all non-zero demand misses 378 if (miss_latency != 0) { 379 g_system_ptr->getProfiler()->missLatency(miss_latency, type); 380 381 if (Debug::getProtocolTrace()) { 382 g_system_ptr->getProfiler()-> 383 profileTransition("Seq", m_version, 384 Address(ruby_request.paddr), "", "Done", "", 385 csprintf("%d cycles", miss_latency)); 386 } 387 } 388#if 0 389 if (request.getPrefetch() == PrefetchBit_Yes) { 390 return; // Ignore the prefetch 391 } 392#endif 393 394 // update the data 395 if (ruby_request.data != NULL) { 396 if ((type == RubyRequestType_LD) || 397 (type == RubyRequestType_IFETCH) || 398 (type == RubyRequestType_RMW_Read) || 399 (type == RubyRequestType_Locked_Read)) { 400 401 memcpy(ruby_request.data, 402 data.getData(request_address.getOffset(), ruby_request.len), 403 ruby_request.len); 404 } else { 405 data.setData(ruby_request.data, request_address.getOffset(), 406 ruby_request.len); 407 } 408 } else { 409 DPRINTF(MemoryAccess, 410 "WARNING. Data not transfered from Ruby to M5 for type %s\n", 411 RubyRequestType_to_string(type)); 412 } 413 414 // If using the RubyTester, update the RubyTester sender state's 415 // subBlock with the recieved data. The tester will later access 416 // this state. 417 // Note: RubyPort will access it's sender state before the 418 // RubyTester. 419 if (m_usingRubyTester) { 420 RubyPort::SenderState *requestSenderState = 421 safe_cast<RubyPort::SenderState*>(ruby_request.pkt->senderState); 422 RubyTester::SenderState* testerSenderState = 423 safe_cast<RubyTester::SenderState*>(requestSenderState->saved); 424 testerSenderState->subBlock->mergeFrom(data); 425 } 426 427 ruby_hit_callback(ruby_request.pkt); 428 delete srequest; 429} 430 431// Returns true if the sequencer already has a load or store outstanding 432RequestStatus 433Sequencer::getRequestStatus(const RubyRequest& request) 434{ 435 bool is_outstanding_store = 436 !!m_writeRequestTable.count(line_address(Address(request.paddr))); 437 bool is_outstanding_load = 438 !!m_readRequestTable.count(line_address(Address(request.paddr))); 439 if (is_outstanding_store) { 440 if ((request.type == RubyRequestType_LD) || 441 (request.type == RubyRequestType_IFETCH) || 442 (request.type == RubyRequestType_RMW_Read)) { 443 m_store_waiting_on_load_cycles++; 444 } else { 445 m_store_waiting_on_store_cycles++; 446 } 447 return RequestStatus_Aliased; 448 } else if (is_outstanding_load) { 449 if ((request.type == RubyRequestType_ST) || 450 (request.type == RubyRequestType_RMW_Write)) { 451 m_load_waiting_on_store_cycles++; 452 } else { 453 m_load_waiting_on_load_cycles++; 454 } 455 return RequestStatus_Aliased; 456 } 457 458 if (m_outstanding_count >= m_max_outstanding_requests) { 459 return RequestStatus_BufferFull; 460 } 461 462 return RequestStatus_Ready; 463} 464 465bool 466Sequencer::empty() const 467{ 468 return m_writeRequestTable.empty() && m_readRequestTable.empty(); 469} 470 471RequestStatus 472Sequencer::makeRequest(const RubyRequest &request) 473{ 474 assert(Address(request.paddr).getOffset() + request.len <= 475 RubySystem::getBlockSizeBytes()); 476 RequestStatus status = getRequestStatus(request); 477 if (status != RequestStatus_Ready) 478 return status; 479 480 SequencerRequest *srequest = 481 new SequencerRequest(request, g_eventQueue_ptr->getTime()); 482 bool found = insertRequest(srequest); 483 if (found) { 484 panic("Sequencer::makeRequest should never be called if the " 485 "request is already outstanding\n"); 486 return RequestStatus_NULL; 487 } 488 489 if (request.type == RubyRequestType_Locked_Write) { 490 // NOTE: it is OK to check the locked flag here as the 491 // mandatory queue will be checked first ensuring that nothing 492 // comes between checking the flag and servicing the store. 493 494 Address line_addr = line_address(Address(request.paddr)); 495 if (!m_dataCache_ptr->isLocked(line_addr, m_version)) { 496 removeRequest(srequest); 497 if (Debug::getProtocolTrace()) { 498 g_system_ptr->getProfiler()-> 499 profileTransition("Seq", m_version, 500 Address(request.paddr), 501 "", "SC Fail", "", 502 RubyRequestType_to_string(request.type)); 503 } 504 return RequestStatus_LlscFailed; 505 } else { 506 m_dataCache_ptr->clearLocked(line_addr); 507 } 508 } 509 issueRequest(request); 510 511 // TODO: issue hardware prefetches here 512 return RequestStatus_Issued; 513} 514 515void 516Sequencer::issueRequest(const RubyRequest& request) 517{ 518 // TODO: get rid of CacheMsg, CacheRequestType, and 519 // AccessModeTYpe, & have SLICC use RubyRequest and subtypes 520 // natively 521 CacheRequestType ctype; 522 switch(request.type) { 523 case RubyRequestType_IFETCH: 524 ctype = CacheRequestType_IFETCH; 525 break; 526 case RubyRequestType_LD: 527 ctype = CacheRequestType_LD; 528 break; 529 case RubyRequestType_ST: 530 ctype = CacheRequestType_ST; 531 break; 532 case RubyRequestType_Locked_Read: 533 case RubyRequestType_Locked_Write: 534 ctype = CacheRequestType_ATOMIC; 535 break; 536 case RubyRequestType_RMW_Read: 537 ctype = CacheRequestType_ATOMIC; 538 break; 539 case RubyRequestType_RMW_Write: 540 ctype = CacheRequestType_ATOMIC; 541 break; 542 default: 543 assert(0); 544 } 545 546 AccessModeType amtype; 547 switch(request.access_mode){ 548 case RubyAccessMode_User: 549 amtype = AccessModeType_UserMode; 550 break; 551 case RubyAccessMode_Supervisor: 552 amtype = AccessModeType_SupervisorMode; 553 break; 554 case RubyAccessMode_Device: 555 amtype = AccessModeType_UserMode; 556 break; 557 default: 558 assert(0); 559 } 560 561 Address line_addr(request.paddr); 562 line_addr.makeLineAddress(); 563 CacheMsg *msg = new CacheMsg(line_addr, Address(request.paddr), ctype, 564 Address(request.pc), amtype, request.len, PrefetchBit_No, 565 request.proc_id); 566 567 if (Debug::getProtocolTrace()) { 568 g_system_ptr->getProfiler()-> 569 profileTransition("Seq", m_version, Address(request.paddr), 570 "", "Begin", "", 571 RubyRequestType_to_string(request.type)); 572 } 573 574 if (g_system_ptr->getTracer()->traceEnabled()) { 575 g_system_ptr->getTracer()-> 576 traceRequest(this, line_addr, Address(request.pc), 577 request.type, g_eventQueue_ptr->getTime()); 578 } 579 580 Time latency = 0; // initialzed to an null value 581 582 if (request.type == RubyRequestType_IFETCH) 583 latency = m_instCache_ptr->getLatency(); 584 else 585 latency = m_dataCache_ptr->getLatency(); 586 587 // Send the message to the cache controller 588 assert(latency > 0); 589 590 assert(m_mandatory_q_ptr != NULL); 591 m_mandatory_q_ptr->enqueue(msg, latency); 592} 593 594#if 0 595bool 596Sequencer::tryCacheAccess(const Address& addr, CacheRequestType type, 597 AccessModeType access_mode, 598 int size, DataBlock*& data_ptr) 599{ 600 CacheMemory *cache = 601 (type == CacheRequestType_IFETCH) ? m_instCache_ptr : m_dataCache_ptr; 602 603 return cache->tryCacheAccess(line_address(addr), type, data_ptr); 604} 605#endif 606 607template <class KEY, class VALUE> 608std::ostream & 609operator<<(ostream &out, const m5::hash_map<KEY, VALUE> &map) 610{ 611 typename m5::hash_map<KEY, VALUE>::const_iterator i = map.begin(); 612 typename m5::hash_map<KEY, VALUE>::const_iterator end = map.end(); 613 614 out << "["; 615 for (; i != end; ++i) 616 out << " " << i->first << "=" << i->second; 617 out << " ]"; 618 619 return out; 620} 621 622void 623Sequencer::print(ostream& out) const 624{ 625 out << "[Sequencer: " << m_version 626 << ", outstanding requests: " << m_outstanding_count 627 << ", read request table: " << m_readRequestTable 628 << ", write request table: " << m_writeRequestTable 629 << "]"; 630} 631 632// this can be called from setState whenever coherence permissions are 633// upgraded when invoked, coherence violations will be checked for the 634// given block 635void 636Sequencer::checkCoherence(const Address& addr) 637{ 638#ifdef CHECK_COHERENCE 639 g_system_ptr->checkGlobalCoherenceInvariant(addr); 640#endif 641} 642