Sequencer.hh revision 8717
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" 377039Snate@binkert.org#include "mem/ruby/common/Address.hh" 387039Snate@binkert.org#include "mem/ruby/common/Consumer.hh" 396285Snate@binkert.org#include "mem/ruby/system/RubyPort.hh" 406145Snate@binkert.org 416145Snate@binkert.orgclass DataBlock; 426285Snate@binkert.orgclass CacheMemory; 436876Ssteve.reinhardt@amd.com 446876Ssteve.reinhardt@amd.comclass RubySequencerParams; 456145Snate@binkert.org 467039Snate@binkert.orgstruct SequencerRequest 477039Snate@binkert.org{ 488615Snilay@cs.wisc.edu PacketPtr pkt; 498615Snilay@cs.wisc.edu RubyRequestType m_type; 507039Snate@binkert.org Time issue_time; 516285Snate@binkert.org 528615Snilay@cs.wisc.edu SequencerRequest(PacketPtr _pkt, RubyRequestType _m_type, Time _issue_time) 538615Snilay@cs.wisc.edu : pkt(_pkt), m_type(_m_type), issue_time(_issue_time) 547039Snate@binkert.org {} 556285Snate@binkert.org}; 566285Snate@binkert.org 576763SBrad.Beckmann@amd.comstd::ostream& operator<<(std::ostream& out, const SequencerRequest& obj); 586763SBrad.Beckmann@amd.com 597039Snate@binkert.orgclass Sequencer : public RubyPort, public Consumer 607039Snate@binkert.org{ 617039Snate@binkert.org public: 626876Ssteve.reinhardt@amd.com typedef RubySequencerParams Params; 637039Snate@binkert.org Sequencer(const Params *); 647039Snate@binkert.org ~Sequencer(); 656145Snate@binkert.org 667039Snate@binkert.org // Public Methods 677039Snate@binkert.org void wakeup(); // Used only for deadlock detection 686145Snate@binkert.org 697055Snate@binkert.org void printConfig(std::ostream& out) const; 706145Snate@binkert.org 717055Snate@binkert.org void printProgress(std::ostream& out) const; 726145Snate@binkert.org 737039Snate@binkert.org void writeCallback(const Address& address, DataBlock& data); 747546SBrad.Beckmann@amd.com 757546SBrad.Beckmann@amd.com void writeCallback(const Address& address, 767546SBrad.Beckmann@amd.com GenericMachineType mach, 777546SBrad.Beckmann@amd.com DataBlock& data); 787546SBrad.Beckmann@amd.com 797565SBrad.Beckmann@amd.com void writeCallback(const Address& address, 807565SBrad.Beckmann@amd.com GenericMachineType mach, 817565SBrad.Beckmann@amd.com DataBlock& data, 827565SBrad.Beckmann@amd.com Time initialRequestTime, 837565SBrad.Beckmann@amd.com Time forwardRequestTime, 847565SBrad.Beckmann@amd.com Time firstResponseTime); 857565SBrad.Beckmann@amd.com 867039Snate@binkert.org void readCallback(const Address& address, DataBlock& data); 876145Snate@binkert.org 887546SBrad.Beckmann@amd.com void readCallback(const Address& address, 897546SBrad.Beckmann@amd.com GenericMachineType mach, 907546SBrad.Beckmann@amd.com DataBlock& data); 917546SBrad.Beckmann@amd.com 927565SBrad.Beckmann@amd.com void readCallback(const Address& address, 937565SBrad.Beckmann@amd.com GenericMachineType mach, 947565SBrad.Beckmann@amd.com DataBlock& data, 957565SBrad.Beckmann@amd.com Time initialRequestTime, 967565SBrad.Beckmann@amd.com Time forwardRequestTime, 977565SBrad.Beckmann@amd.com Time firstResponseTime); 987565SBrad.Beckmann@amd.com 998615Snilay@cs.wisc.edu RequestStatus makeRequest(PacketPtr pkt); 1007039Snate@binkert.org bool empty() const; 1018688Snilay@cs.wisc.edu int outstandingCount() const { return m_outstanding_count; } 1028688Snilay@cs.wisc.edu bool 1038688Snilay@cs.wisc.edu isDeadlockEventScheduled() const 1048688Snilay@cs.wisc.edu { 1058688Snilay@cs.wisc.edu return deadlockCheckEvent.scheduled(); 1068688Snilay@cs.wisc.edu } 1078688Snilay@cs.wisc.edu 1088688Snilay@cs.wisc.edu void 1098688Snilay@cs.wisc.edu descheduleDeadlockEvent() 1108688Snilay@cs.wisc.edu { 1118688Snilay@cs.wisc.edu deschedule(deadlockCheckEvent); 1128688Snilay@cs.wisc.edu } 1136145Snate@binkert.org 1147055Snate@binkert.org void print(std::ostream& out) const; 1157055Snate@binkert.org void printStats(std::ostream& out) const; 1167039Snate@binkert.org void checkCoherence(const Address& address); 1176145Snate@binkert.org 1187455Snate@binkert.org void markRemoved(); 1197039Snate@binkert.org void removeRequest(SequencerRequest* request); 1208717Snilay@cs.wisc.edu void evictionCallback(const Address& address); 1216145Snate@binkert.org 1227039Snate@binkert.org private: 1238615Snilay@cs.wisc.edu void issueRequest(PacketPtr pkt, RubyRequestType type); 1246145Snate@binkert.org 1257546SBrad.Beckmann@amd.com void hitCallback(SequencerRequest* request, 1267546SBrad.Beckmann@amd.com GenericMachineType mach, 1277560SBrad.Beckmann@amd.com DataBlock& data, 1287565SBrad.Beckmann@amd.com bool success, 1297565SBrad.Beckmann@amd.com Time initialRequestTime, 1307565SBrad.Beckmann@amd.com Time forwardRequestTime, 1317565SBrad.Beckmann@amd.com Time firstResponseTime); 1327546SBrad.Beckmann@amd.com 1338615Snilay@cs.wisc.edu RequestStatus insertRequest(PacketPtr pkt, RubyRequestType request_type); 1346285Snate@binkert.org 1357560SBrad.Beckmann@amd.com bool handleLlsc(const Address& address, SequencerRequest* request); 1366145Snate@binkert.org 1377039Snate@binkert.org // Private copy constructor and assignment operator 1387039Snate@binkert.org Sequencer(const Sequencer& obj); 1397039Snate@binkert.org Sequencer& operator=(const Sequencer& obj); 1406145Snate@binkert.org 1417039Snate@binkert.org private: 1427039Snate@binkert.org int m_max_outstanding_requests; 1437039Snate@binkert.org int m_deadlock_threshold; 1446145Snate@binkert.org 1457039Snate@binkert.org CacheMemory* m_dataCache_ptr; 1467039Snate@binkert.org CacheMemory* m_instCache_ptr; 1476285Snate@binkert.org 1487455Snate@binkert.org typedef m5::hash_map<Address, SequencerRequest*> RequestTable; 1497455Snate@binkert.org RequestTable m_writeRequestTable; 1507455Snate@binkert.org RequestTable m_readRequestTable; 1517039Snate@binkert.org // Global outstanding request count, across all request tables 1527039Snate@binkert.org int m_outstanding_count; 1537039Snate@binkert.org bool m_deadlock_check_scheduled; 1546145Snate@binkert.org 1557039Snate@binkert.org int m_store_waiting_on_load_cycles; 1567039Snate@binkert.org int m_store_waiting_on_store_cycles; 1577039Snate@binkert.org int m_load_waiting_on_store_cycles; 1587039Snate@binkert.org int m_load_waiting_on_load_cycles; 1596859Sdrh5@cs.wisc.edu 1608171Stushar@csail.mit.edu bool m_usingNetworkTester; 1618171Stushar@csail.mit.edu 1627039Snate@binkert.org class SequencerWakeupEvent : public Event 1637039Snate@binkert.org { 1647039Snate@binkert.org private: 1657039Snate@binkert.org Sequencer *m_sequencer_ptr; 1666899SBrad.Beckmann@amd.com 1677039Snate@binkert.org public: 1687039Snate@binkert.org SequencerWakeupEvent(Sequencer *_seq) : m_sequencer_ptr(_seq) {} 1697039Snate@binkert.org void process() { m_sequencer_ptr->wakeup(); } 1707039Snate@binkert.org const char *description() const { return "Sequencer deadlock check"; } 1717039Snate@binkert.org }; 1726886SBrad.Beckmann@amd.com 1737039Snate@binkert.org SequencerWakeupEvent deadlockCheckEvent; 1746145Snate@binkert.org}; 1756145Snate@binkert.org 1767055Snate@binkert.orginline std::ostream& 1777055Snate@binkert.orgoperator<<(std::ostream& out, const Sequencer& obj) 1786145Snate@binkert.org{ 1797039Snate@binkert.org obj.print(out); 1807055Snate@binkert.org out << std::flush; 1817039Snate@binkert.org return out; 1826145Snate@binkert.org} 1836145Snate@binkert.org 1847039Snate@binkert.org#endif // __MEM_RUBY_SYSTEM_SEQUENCER_HH__ 185