gem5/src/mem/ruby/system/Sequencer.hh

185 lines
5.9 KiB
C++
Raw Normal View History

/*
* 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.
*/
2010-03-23 02:43:53 +01:00
#ifndef __MEM_RUBY_SYSTEM_SEQUENCER_HH__
#define __MEM_RUBY_SYSTEM_SEQUENCER_HH__
#include <iostream>
2010-06-11 08:17:07 +02:00
#include "base/hashmap.hh"
#include "mem/protocol/GenericMachineType.hh"
2011-04-15 19:44:06 +02:00
#include "mem/protocol/RubyRequestType.hh"
#include "mem/ruby/common/Address.hh"
2010-03-23 02:43:53 +01:00
#include "mem/ruby/common/Consumer.hh"
#include "mem/ruby/system/RubyPort.hh"
class DataBlock;
class CacheMemory;
struct RubySequencerParams;
2010-03-23 02:43:53 +01:00
struct SequencerRequest
{
PacketPtr pkt;
RubyRequestType m_type;
2010-03-23 02:43:53 +01:00
Time issue_time;
SequencerRequest(PacketPtr _pkt, RubyRequestType _m_type, Time _issue_time)
: pkt(_pkt), m_type(_m_type), issue_time(_issue_time)
2010-03-23 02:43:53 +01:00
{}
};
std::ostream& operator<<(std::ostream& out, const SequencerRequest& obj);
2010-03-23 02:43:53 +01:00
class Sequencer : public RubyPort, public Consumer
{
public:
typedef RubySequencerParams Params;
2010-03-23 02:43:53 +01:00
Sequencer(const Params *);
~Sequencer();
2010-03-23 02:43:53 +01:00
// Public Methods
void wakeup(); // Used only for deadlock detection
void printConfig(std::ostream& out) const;
void printProgress(std::ostream& out) const;
2010-03-23 02:43:53 +01:00
void writeCallback(const Address& address, DataBlock& data);
void writeCallback(const Address& address,
GenericMachineType mach,
DataBlock& data);
void writeCallback(const Address& address,
GenericMachineType mach,
DataBlock& data,
Time initialRequestTime,
Time forwardRequestTime,
Time firstResponseTime);
2010-03-23 02:43:53 +01:00
void readCallback(const Address& address, DataBlock& data);
void readCallback(const Address& address,
GenericMachineType mach,
DataBlock& data);
void readCallback(const Address& address,
GenericMachineType mach,
DataBlock& data,
Time initialRequestTime,
Time forwardRequestTime,
Time firstResponseTime);
RequestStatus makeRequest(PacketPtr pkt);
2010-03-23 02:43:53 +01:00
bool empty() const;
int outstandingCount() const { return m_outstanding_count; }
bool
isDeadlockEventScheduled() const
{
return deadlockCheckEvent.scheduled();
}
void
descheduleDeadlockEvent()
{
deschedule(deadlockCheckEvent);
}
void print(std::ostream& out) const;
void printStats(std::ostream& out) const;
2010-03-23 02:43:53 +01:00
void checkCoherence(const Address& address);
2010-06-11 08:17:07 +02:00
void markRemoved();
2010-03-23 02:43:53 +01:00
void removeRequest(SequencerRequest* request);
void evictionCallback(const Address& address);
2010-03-23 02:43:53 +01:00
private:
void issueRequest(PacketPtr pkt, RubyRequestType type);
void hitCallback(SequencerRequest* request,
GenericMachineType mach,
DataBlock& data,
bool success,
Time initialRequestTime,
Time forwardRequestTime,
Time firstResponseTime);
RequestStatus insertRequest(PacketPtr pkt, RubyRequestType request_type);
bool handleLlsc(const Address& address, SequencerRequest* request);
2010-03-23 02:43:53 +01:00
// Private copy constructor and assignment operator
Sequencer(const Sequencer& obj);
Sequencer& operator=(const Sequencer& obj);
2010-03-23 02:43:53 +01:00
private:
int m_max_outstanding_requests;
int m_deadlock_threshold;
2010-03-23 02:43:53 +01:00
CacheMemory* m_dataCache_ptr;
CacheMemory* m_instCache_ptr;
2010-06-11 08:17:07 +02:00
typedef m5::hash_map<Address, SequencerRequest*> RequestTable;
RequestTable m_writeRequestTable;
RequestTable m_readRequestTable;
2010-03-23 02:43:53 +01:00
// Global outstanding request count, across all request tables
int m_outstanding_count;
bool m_deadlock_check_scheduled;
2010-03-23 02:43:53 +01:00
int m_store_waiting_on_load_cycles;
int m_store_waiting_on_store_cycles;
int m_load_waiting_on_store_cycles;
int m_load_waiting_on_load_cycles;
bool m_usingNetworkTester;
2010-03-23 02:43:53 +01:00
class SequencerWakeupEvent : public Event
{
private:
Sequencer *m_sequencer_ptr;
2010-03-23 02:43:53 +01:00
public:
SequencerWakeupEvent(Sequencer *_seq) : m_sequencer_ptr(_seq) {}
void process() { m_sequencer_ptr->wakeup(); }
const char *description() const { return "Sequencer deadlock check"; }
};
2010-03-23 02:43:53 +01:00
SequencerWakeupEvent deadlockCheckEvent;
};
inline std::ostream&
operator<<(std::ostream& out, const Sequencer& obj)
{
2010-03-23 02:43:53 +01:00
obj.print(out);
out << std::flush;
2010-03-23 02:43:53 +01:00
return out;
}
2010-03-23 02:43:53 +01:00
#endif // __MEM_RUBY_SYSTEM_SEQUENCER_HH__