AbstractController.hh revision 9302:c2e70a9bc340
1/* 2 * Copyright (c) 2009 Mark D. Hill and David A. Wood 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are 7 * met: redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer; 9 * redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution; 12 * neither the name of the copyright holders nor the names of its 13 * contributors may be used to endorse or promote products derived from 14 * this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29#ifndef __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 30#define __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 31 32#include <iostream> 33#include <string> 34 35#include "mem/packet.hh" 36#include "mem/protocol/AccessPermission.hh" 37#include "mem/ruby/common/Address.hh" 38#include "mem/ruby/common/Consumer.hh" 39#include "mem/ruby/common/DataBlock.hh" 40#include "mem/ruby/network/Network.hh" 41#include "mem/ruby/recorder/CacheRecorder.hh" 42#include "params/RubyController.hh" 43#include "sim/sim_object.hh" 44 45class MessageBuffer; 46class Network; 47 48class AbstractController : public SimObject, public Consumer 49{ 50 public: 51 typedef RubyControllerParams Params; 52 AbstractController(const Params *p); 53 const Params *params() const { return (const Params *)_params; } 54 virtual MessageBuffer* getMandatoryQueue() const = 0; 55 virtual const int & getVersion() const = 0; 56 virtual const std::string toString() const = 0; // returns text version of 57 // controller type 58 virtual const std::string getName() const = 0; // return instance name 59 virtual void blockOnQueue(Address, MessageBuffer*) = 0; 60 virtual void unblock(Address) = 0; 61 virtual void initNetworkPtr(Network* net_ptr) = 0; 62 virtual AccessPermission getAccessPermission(const Address& addr) = 0; 63 virtual DataBlock& getDataBlock(const Address& addr) = 0; 64 65 virtual void print(std::ostream & out) const = 0; 66 virtual void printStats(std::ostream & out) const = 0; 67 virtual void wakeup() = 0; 68 // virtual void dumpStats(std::ostream & out) = 0; 69 virtual void clearStats() = 0; 70 virtual void recordCacheTrace(int cntrl, CacheRecorder* tr) = 0; 71 virtual Sequencer* getSequencer() const = 0; 72 73 //! These functions are used by ruby system to read/write the message 74 //! queues that exist with in the controller. 75 //! The boolean return value indicates if the read was performed 76 //! successfully. 77 virtual bool functionalReadBuffers(PacketPtr&) = 0; 78 //! The return value indicates the number of messages written with the 79 //! data from the packet. 80 virtual uint32_t functionalWriteBuffers(PacketPtr&) = 0; 81}; 82 83#endif // __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 84