Sequencer.hh revision 8615
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; 426145Snate@binkert.orgclass CacheMsg; 436145Snate@binkert.orgclass MachineID; 446285Snate@binkert.orgclass CacheMemory; 456876Ssteve.reinhardt@amd.com 466876Ssteve.reinhardt@amd.comclass RubySequencerParams; 476145Snate@binkert.org 487039Snate@binkert.orgstruct SequencerRequest 497039Snate@binkert.org{ 508615Snilay@cs.wisc.edu PacketPtr pkt; 518615Snilay@cs.wisc.edu RubyRequestType m_type; 527039Snate@binkert.org Time issue_time; 536285Snate@binkert.org 548615Snilay@cs.wisc.edu SequencerRequest(PacketPtr _pkt, RubyRequestType _m_type, Time _issue_time) 558615Snilay@cs.wisc.edu : pkt(_pkt), m_type(_m_type), issue_time(_issue_time) 567039Snate@binkert.org {} 576285Snate@binkert.org}; 586285Snate@binkert.org 596763SBrad.Beckmann@amd.comstd::ostream& operator<<(std::ostream& out, const SequencerRequest& obj); 606763SBrad.Beckmann@amd.com 617039Snate@binkert.orgclass Sequencer : public RubyPort, public Consumer 627039Snate@binkert.org{ 637039Snate@binkert.org public: 646876Ssteve.reinhardt@amd.com typedef RubySequencerParams Params; 657039Snate@binkert.org Sequencer(const Params *); 667039Snate@binkert.org ~Sequencer(); 676145Snate@binkert.org 687039Snate@binkert.org // Public Methods 697039Snate@binkert.org void wakeup(); // Used only for deadlock detection 706145Snate@binkert.org 717055Snate@binkert.org void printConfig(std::ostream& out) const; 726145Snate@binkert.org 737055Snate@binkert.org void printProgress(std::ostream& out) const; 746145Snate@binkert.org 757039Snate@binkert.org void writeCallback(const Address& address, DataBlock& data); 767546SBrad.Beckmann@amd.com 777546SBrad.Beckmann@amd.com void writeCallback(const Address& address, 787546SBrad.Beckmann@amd.com GenericMachineType mach, 797546SBrad.Beckmann@amd.com DataBlock& data); 807546SBrad.Beckmann@amd.com 817565SBrad.Beckmann@amd.com void writeCallback(const Address& address, 827565SBrad.Beckmann@amd.com GenericMachineType mach, 837565SBrad.Beckmann@amd.com DataBlock& data, 847565SBrad.Beckmann@amd.com Time initialRequestTime, 857565SBrad.Beckmann@amd.com Time forwardRequestTime, 867565SBrad.Beckmann@amd.com Time firstResponseTime); 877565SBrad.Beckmann@amd.com 887039Snate@binkert.org void readCallback(const Address& address, DataBlock& data); 896145Snate@binkert.org 907546SBrad.Beckmann@amd.com void readCallback(const Address& address, 917546SBrad.Beckmann@amd.com GenericMachineType mach, 927546SBrad.Beckmann@amd.com DataBlock& data); 937546SBrad.Beckmann@amd.com 947565SBrad.Beckmann@amd.com void readCallback(const Address& address, 957565SBrad.Beckmann@amd.com GenericMachineType mach, 967565SBrad.Beckmann@amd.com DataBlock& data, 977565SBrad.Beckmann@amd.com Time initialRequestTime, 987565SBrad.Beckmann@amd.com Time forwardRequestTime, 997565SBrad.Beckmann@amd.com Time firstResponseTime); 1007565SBrad.Beckmann@amd.com 1018615Snilay@cs.wisc.edu RequestStatus makeRequest(PacketPtr pkt); 1027039Snate@binkert.org bool empty() const; 1036145Snate@binkert.org 1047055Snate@binkert.org void print(std::ostream& out) const; 1057055Snate@binkert.org void printStats(std::ostream& out) const; 1067039Snate@binkert.org void checkCoherence(const Address& address); 1076145Snate@binkert.org 1087455Snate@binkert.org void markRemoved(); 1097039Snate@binkert.org void removeRequest(SequencerRequest* request); 1106145Snate@binkert.org 1117039Snate@binkert.org private: 1128615Snilay@cs.wisc.edu void issueRequest(PacketPtr pkt, RubyRequestType type); 1136145Snate@binkert.org 1147546SBrad.Beckmann@amd.com void hitCallback(SequencerRequest* request, 1157546SBrad.Beckmann@amd.com GenericMachineType mach, 1167560SBrad.Beckmann@amd.com DataBlock& data, 1177565SBrad.Beckmann@amd.com bool success, 1187565SBrad.Beckmann@amd.com Time initialRequestTime, 1197565SBrad.Beckmann@amd.com Time forwardRequestTime, 1207565SBrad.Beckmann@amd.com Time firstResponseTime); 1217546SBrad.Beckmann@amd.com 1228615Snilay@cs.wisc.edu RequestStatus insertRequest(PacketPtr pkt, RubyRequestType request_type); 1236285Snate@binkert.org 1247560SBrad.Beckmann@amd.com bool handleLlsc(const Address& address, SequencerRequest* request); 1256145Snate@binkert.org 1267039Snate@binkert.org // Private copy constructor and assignment operator 1277039Snate@binkert.org Sequencer(const Sequencer& obj); 1287039Snate@binkert.org Sequencer& operator=(const Sequencer& obj); 1296145Snate@binkert.org 1307039Snate@binkert.org private: 1317039Snate@binkert.org int m_max_outstanding_requests; 1327039Snate@binkert.org int m_deadlock_threshold; 1336145Snate@binkert.org 1347039Snate@binkert.org CacheMemory* m_dataCache_ptr; 1357039Snate@binkert.org CacheMemory* m_instCache_ptr; 1366285Snate@binkert.org 1377455Snate@binkert.org typedef m5::hash_map<Address, SequencerRequest*> RequestTable; 1387455Snate@binkert.org RequestTable m_writeRequestTable; 1397455Snate@binkert.org RequestTable m_readRequestTable; 1407039Snate@binkert.org // Global outstanding request count, across all request tables 1417039Snate@binkert.org int m_outstanding_count; 1427039Snate@binkert.org bool m_deadlock_check_scheduled; 1436145Snate@binkert.org 1447039Snate@binkert.org int m_store_waiting_on_load_cycles; 1457039Snate@binkert.org int m_store_waiting_on_store_cycles; 1467039Snate@binkert.org int m_load_waiting_on_store_cycles; 1477039Snate@binkert.org int m_load_waiting_on_load_cycles; 1486859Sdrh5@cs.wisc.edu 1498171Stushar@csail.mit.edu bool m_usingNetworkTester; 1508171Stushar@csail.mit.edu 1517039Snate@binkert.org class SequencerWakeupEvent : public Event 1527039Snate@binkert.org { 1537039Snate@binkert.org private: 1547039Snate@binkert.org Sequencer *m_sequencer_ptr; 1556899SBrad.Beckmann@amd.com 1567039Snate@binkert.org public: 1577039Snate@binkert.org SequencerWakeupEvent(Sequencer *_seq) : m_sequencer_ptr(_seq) {} 1587039Snate@binkert.org void process() { m_sequencer_ptr->wakeup(); } 1597039Snate@binkert.org const char *description() const { return "Sequencer deadlock check"; } 1607039Snate@binkert.org }; 1616886SBrad.Beckmann@amd.com 1627039Snate@binkert.org SequencerWakeupEvent deadlockCheckEvent; 1636145Snate@binkert.org}; 1646145Snate@binkert.org 1657055Snate@binkert.orginline std::ostream& 1667055Snate@binkert.orgoperator<<(std::ostream& out, const Sequencer& obj) 1676145Snate@binkert.org{ 1687039Snate@binkert.org obj.print(out); 1697055Snate@binkert.org out << std::flush; 1707039Snate@binkert.org return out; 1716145Snate@binkert.org} 1726145Snate@binkert.org 1737039Snate@binkert.org#endif // __MEM_RUBY_SYSTEM_SEQUENCER_HH__ 1746145Snate@binkert.org 175