5ffc165939
This patch adds support to different entities in the ruby memory system for more reliable functional read/write accesses. Only the simple network has been augmented as of now. Later on Garnet will also support functional accesses. The patch adds functional access code to all the different types of messages that protocols can send around. These messages are functionally accessed by going through the buffers maintained by the network entities. The patch also rectifies some of the bugs found in coherence protocols while testing the patch. With this patch applied, functional writes always succeed. But functional reads can still fail.
84 lines
3.7 KiB
C++
84 lines
3.7 KiB
C++
/*
|
|
* Copyright (c) 2009 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.
|
|
*/
|
|
|
|
#ifndef __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__
|
|
#define __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__
|
|
|
|
#include <iostream>
|
|
#include <string>
|
|
|
|
#include "mem/packet.hh"
|
|
#include "mem/protocol/AccessPermission.hh"
|
|
#include "mem/ruby/common/Address.hh"
|
|
#include "mem/ruby/common/Consumer.hh"
|
|
#include "mem/ruby/common/DataBlock.hh"
|
|
#include "mem/ruby/network/Network.hh"
|
|
#include "mem/ruby/recorder/CacheRecorder.hh"
|
|
#include "params/RubyController.hh"
|
|
#include "sim/sim_object.hh"
|
|
|
|
class MessageBuffer;
|
|
class Network;
|
|
|
|
class AbstractController : public SimObject, public Consumer
|
|
{
|
|
public:
|
|
typedef RubyControllerParams Params;
|
|
AbstractController(const Params *p);
|
|
const Params *params() const { return (const Params *)_params; }
|
|
virtual MessageBuffer* getMandatoryQueue() const = 0;
|
|
virtual const int & getVersion() const = 0;
|
|
virtual const std::string toString() const = 0; // returns text version of
|
|
// controller type
|
|
virtual const std::string getName() const = 0; // return instance name
|
|
virtual void blockOnQueue(Address, MessageBuffer*) = 0;
|
|
virtual void unblock(Address) = 0;
|
|
virtual void initNetworkPtr(Network* net_ptr) = 0;
|
|
virtual AccessPermission getAccessPermission(const Address& addr) = 0;
|
|
virtual DataBlock& getDataBlock(const Address& addr) = 0;
|
|
|
|
virtual void print(std::ostream & out) const = 0;
|
|
virtual void printStats(std::ostream & out) const = 0;
|
|
virtual void wakeup() = 0;
|
|
// virtual void dumpStats(std::ostream & out) = 0;
|
|
virtual void clearStats() = 0;
|
|
virtual void recordCacheTrace(int cntrl, CacheRecorder* tr) = 0;
|
|
virtual Sequencer* getSequencer() const = 0;
|
|
|
|
//! These functions are used by ruby system to read/write the message
|
|
//! queues that exist with in the controller.
|
|
//! The boolean return value indicates if the read was performed
|
|
//! successfully.
|
|
virtual bool functionalReadBuffers(PacketPtr&) = 0;
|
|
//! The return value indicates the number of messages written with the
|
|
//! data from the packet.
|
|
virtual uint32_t functionalWriteBuffers(PacketPtr&) = 0;
|
|
};
|
|
|
|
#endif // __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__
|