Sequencer.hh revision 9184
16145Snate@binkert.org/* 26145Snate@binkert.org * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood 36145Snate@binkert.org * All rights reserved. 46145Snate@binkert.org * 56145Snate@binkert.org * Redistribution and use in source and binary forms, with or without 66145Snate@binkert.org * modification, are permitted provided that the following conditions are 76145Snate@binkert.org * met: redistributions of source code must retain the above copyright 86145Snate@binkert.org * notice, this list of conditions and the following disclaimer; 96145Snate@binkert.org * redistributions in binary form must reproduce the above copyright 106145Snate@binkert.org * notice, this list of conditions and the following disclaimer in the 116145Snate@binkert.org * documentation and/or other materials provided with the distribution; 126145Snate@binkert.org * neither the name of the copyright holders nor the names of its 136145Snate@binkert.org * contributors may be used to endorse or promote products derived from 146145Snate@binkert.org * this software without specific prior written permission. 156145Snate@binkert.org * 166145Snate@binkert.org * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 176145Snate@binkert.org * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 186145Snate@binkert.org * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 196145Snate@binkert.org * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 206145Snate@binkert.org * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 216145Snate@binkert.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 226145Snate@binkert.org * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 236145Snate@binkert.org * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 246145Snate@binkert.org * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 256145Snate@binkert.org * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 266145Snate@binkert.org * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 276145Snate@binkert.org */ 286145Snate@binkert.org 297039Snate@binkert.org#ifndef __MEM_RUBY_SYSTEM_SEQUENCER_HH__ 307039Snate@binkert.org#define __MEM_RUBY_SYSTEM_SEQUENCER_HH__ 316145Snate@binkert.org 327055Snate@binkert.org#include <iostream> 337055Snate@binkert.org 347455Snate@binkert.org#include "base/hashmap.hh" 358229Snate@binkert.org#include "mem/protocol/GenericMachineType.hh" 368165Snilay@cs.wisc.edu#include "mem/protocol/RubyRequestType.hh" 379104Shestness@cs.utexas.edu#include "mem/protocol/SequencerRequestType.hh" 387039Snate@binkert.org#include "mem/ruby/common/Address.hh" 399171Snilay@cs.wisc.edu#include "mem/ruby/system/CacheMemory.hh" 406285Snate@binkert.org#include "mem/ruby/system/RubyPort.hh" 419171Snilay@cs.wisc.edu#include "params/RubySequencer.hh" 426145Snate@binkert.org 436145Snate@binkert.orgclass DataBlock; 446145Snate@binkert.org 457039Snate@binkert.orgstruct SequencerRequest 467039Snate@binkert.org{ 478615Snilay@cs.wisc.edu PacketPtr pkt; 488615Snilay@cs.wisc.edu RubyRequestType m_type; 497039Snate@binkert.org Time issue_time; 506285Snate@binkert.org 518615Snilay@cs.wisc.edu SequencerRequest(PacketPtr _pkt, RubyRequestType _m_type, Time _issue_time) 528615Snilay@cs.wisc.edu : pkt(_pkt), m_type(_m_type), issue_time(_issue_time) 537039Snate@binkert.org {} 546285Snate@binkert.org}; 556285Snate@binkert.org 566763SBrad.Beckmann@amd.comstd::ostream& operator<<(std::ostream& out, const SequencerRequest& obj); 576763SBrad.Beckmann@amd.com 589171Snilay@cs.wisc.educlass Sequencer : public RubyPort 597039Snate@binkert.org{ 607039Snate@binkert.org public: 616876Ssteve.reinhardt@amd.com typedef RubySequencerParams Params; 627039Snate@binkert.org Sequencer(const Params *); 637039Snate@binkert.org ~Sequencer(); 646145Snate@binkert.org 657039Snate@binkert.org // Public Methods 667039Snate@binkert.org void wakeup(); // Used only for deadlock detection 676145Snate@binkert.org 687055Snate@binkert.org void printProgress(std::ostream& out) const; 696145Snate@binkert.org 707039Snate@binkert.org void writeCallback(const Address& address, DataBlock& data); 717546SBrad.Beckmann@amd.com 727546SBrad.Beckmann@amd.com void writeCallback(const Address& address, 737546SBrad.Beckmann@amd.com GenericMachineType mach, 747546SBrad.Beckmann@amd.com DataBlock& data); 757546SBrad.Beckmann@amd.com 767565SBrad.Beckmann@amd.com void writeCallback(const Address& address, 777565SBrad.Beckmann@amd.com GenericMachineType mach, 787565SBrad.Beckmann@amd.com DataBlock& data, 797565SBrad.Beckmann@amd.com Time initialRequestTime, 807565SBrad.Beckmann@amd.com Time forwardRequestTime, 817565SBrad.Beckmann@amd.com Time firstResponseTime); 827565SBrad.Beckmann@amd.com 837039Snate@binkert.org void readCallback(const Address& address, DataBlock& data); 846145Snate@binkert.org 857546SBrad.Beckmann@amd.com void readCallback(const Address& address, 867546SBrad.Beckmann@amd.com GenericMachineType mach, 877546SBrad.Beckmann@amd.com DataBlock& data); 887546SBrad.Beckmann@amd.com 897565SBrad.Beckmann@amd.com void readCallback(const Address& address, 907565SBrad.Beckmann@amd.com GenericMachineType mach, 917565SBrad.Beckmann@amd.com DataBlock& data, 927565SBrad.Beckmann@amd.com Time initialRequestTime, 937565SBrad.Beckmann@amd.com Time forwardRequestTime, 947565SBrad.Beckmann@amd.com Time firstResponseTime); 957565SBrad.Beckmann@amd.com 968615Snilay@cs.wisc.edu RequestStatus makeRequest(PacketPtr pkt); 977039Snate@binkert.org bool empty() const; 988688Snilay@cs.wisc.edu int outstandingCount() const { return m_outstanding_count; } 998688Snilay@cs.wisc.edu bool 1008688Snilay@cs.wisc.edu isDeadlockEventScheduled() const 1018688Snilay@cs.wisc.edu { 1028688Snilay@cs.wisc.edu return deadlockCheckEvent.scheduled(); 1038688Snilay@cs.wisc.edu } 1048688Snilay@cs.wisc.edu 1058688Snilay@cs.wisc.edu void 1068688Snilay@cs.wisc.edu descheduleDeadlockEvent() 1078688Snilay@cs.wisc.edu { 1088688Snilay@cs.wisc.edu deschedule(deadlockCheckEvent); 1098688Snilay@cs.wisc.edu } 1106145Snate@binkert.org 1117055Snate@binkert.org void print(std::ostream& out) const; 1127055Snate@binkert.org void printStats(std::ostream& out) const; 1137039Snate@binkert.org void checkCoherence(const Address& address); 1146145Snate@binkert.org 1157455Snate@binkert.org void markRemoved(); 1167039Snate@binkert.org void removeRequest(SequencerRequest* request); 1178717Snilay@cs.wisc.edu void evictionCallback(const Address& address); 1186145Snate@binkert.org 1199104Shestness@cs.utexas.edu void recordRequestType(SequencerRequestType requestType); 1209104Shestness@cs.utexas.edu 1217039Snate@binkert.org private: 1228615Snilay@cs.wisc.edu void issueRequest(PacketPtr pkt, RubyRequestType type); 1236145Snate@binkert.org 1247546SBrad.Beckmann@amd.com void hitCallback(SequencerRequest* request, 1257546SBrad.Beckmann@amd.com GenericMachineType mach, 1267560SBrad.Beckmann@amd.com DataBlock& data, 1277565SBrad.Beckmann@amd.com bool success, 1287565SBrad.Beckmann@amd.com Time initialRequestTime, 1297565SBrad.Beckmann@amd.com Time forwardRequestTime, 1307565SBrad.Beckmann@amd.com Time firstResponseTime); 1317546SBrad.Beckmann@amd.com 1328615Snilay@cs.wisc.edu RequestStatus insertRequest(PacketPtr pkt, RubyRequestType request_type); 1336285Snate@binkert.org 1347560SBrad.Beckmann@amd.com bool handleLlsc(const Address& address, SequencerRequest* request); 1356145Snate@binkert.org 1367039Snate@binkert.org // Private copy constructor and assignment operator 1377039Snate@binkert.org Sequencer(const Sequencer& obj); 1387039Snate@binkert.org Sequencer& operator=(const Sequencer& obj); 1396145Snate@binkert.org 1407039Snate@binkert.org private: 1417039Snate@binkert.org int m_max_outstanding_requests; 1429184Sandreas.hansson@arm.com Cycles m_deadlock_threshold; 1436145Snate@binkert.org 1447039Snate@binkert.org CacheMemory* m_dataCache_ptr; 1457039Snate@binkert.org CacheMemory* m_instCache_ptr; 1466285Snate@binkert.org 1477455Snate@binkert.org typedef m5::hash_map<Address, SequencerRequest*> RequestTable; 1487455Snate@binkert.org RequestTable m_writeRequestTable; 1497455Snate@binkert.org RequestTable m_readRequestTable; 1507039Snate@binkert.org // Global outstanding request count, across all request tables 1517039Snate@binkert.org int m_outstanding_count; 1527039Snate@binkert.org bool m_deadlock_check_scheduled; 1536145Snate@binkert.org 1547039Snate@binkert.org int m_store_waiting_on_load_cycles; 1557039Snate@binkert.org int m_store_waiting_on_store_cycles; 1567039Snate@binkert.org int m_load_waiting_on_store_cycles; 1577039Snate@binkert.org int m_load_waiting_on_load_cycles; 1586859Sdrh5@cs.wisc.edu 1598171Stushar@csail.mit.edu bool m_usingNetworkTester; 1608171Stushar@csail.mit.edu 1617039Snate@binkert.org class SequencerWakeupEvent : public Event 1627039Snate@binkert.org { 1637039Snate@binkert.org private: 1647039Snate@binkert.org Sequencer *m_sequencer_ptr; 1656899SBrad.Beckmann@amd.com 1667039Snate@binkert.org public: 1677039Snate@binkert.org SequencerWakeupEvent(Sequencer *_seq) : m_sequencer_ptr(_seq) {} 1687039Snate@binkert.org void process() { m_sequencer_ptr->wakeup(); } 1697039Snate@binkert.org const char *description() const { return "Sequencer deadlock check"; } 1707039Snate@binkert.org }; 1716886SBrad.Beckmann@amd.com 1727039Snate@binkert.org SequencerWakeupEvent deadlockCheckEvent; 1736145Snate@binkert.org}; 1746145Snate@binkert.org 1757055Snate@binkert.orginline std::ostream& 1767055Snate@binkert.orgoperator<<(std::ostream& out, const Sequencer& obj) 1776145Snate@binkert.org{ 1787039Snate@binkert.org obj.print(out); 1797055Snate@binkert.org out << std::flush; 1807039Snate@binkert.org return out; 1816145Snate@binkert.org} 1826145Snate@binkert.org 1837039Snate@binkert.org#endif // __MEM_RUBY_SYSTEM_SEQUENCER_HH__ 184