AbstractController.hh revision 9364:e5fc9d588132 
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/protocol/AccessPermission.hh"
36#include "mem/ruby/common/Address.hh"
37#include "mem/ruby/common/Consumer.hh"
38#include "mem/ruby/common/DataBlock.hh"
39#include "mem/ruby/network/Network.hh"
40#include "mem/ruby/recorder/CacheRecorder.hh"
41#include "mem/ruby/system/MachineID.hh"
42#include "mem/packet.hh"
43#include "params/RubyController.hh"
44#include "sim/sim_object.hh"
45
46class MessageBuffer;
47class Network;
48
49class AbstractController : public SimObject, public Consumer
50{
51  public:
52    typedef RubyControllerParams Params;
53    AbstractController(const Params *p);
54    const Params *params() const { return (const Params *)_params; }
55    virtual MessageBuffer* getMandatoryQueue() const = 0;
56    virtual const int & getVersion() const = 0;
57    virtual const std::string toString() const = 0;  // returns text version of
58                                                     // controller type
59    virtual const std::string getName() const = 0;   // return instance name
60    virtual void blockOnQueue(Address, MessageBuffer*) = 0;
61    virtual void unblock(Address) = 0;
62    virtual void initNetworkPtr(Network* net_ptr) = 0;
63    virtual AccessPermission getAccessPermission(const Address& addr) = 0;
64    virtual DataBlock& getDataBlock(const Address& addr) = 0;
65
66    virtual void print(std::ostream & out) const = 0;
67    virtual void printStats(std::ostream & out) const = 0;
68    virtual void wakeup() = 0;
69    //  virtual void dumpStats(std::ostream & out) = 0;
70    virtual void clearStats() = 0;
71    virtual void recordCacheTrace(int cntrl, CacheRecorder* tr) = 0;
72    virtual Sequencer* getSequencer() const = 0;
73
74    //! These functions are used by ruby system to read/write the message
75    //! queues that exist with in the controller.
76    //! The boolean return value indicates if the read was performed
77    //! successfully.
78    virtual bool functionalReadBuffers(PacketPtr&) = 0;
79    //! The return value indicates the number of messages written with the
80    //! data from the packet.
81    virtual uint32_t functionalWriteBuffers(PacketPtr&) = 0;
82
83    //! Function for enqueuing a prefetch request
84    virtual void enqueuePrefetch(const Address&, const RubyRequestType&)
85    { fatal("Prefetches not implemented!");}
86
87  protected:
88    int m_transitions_per_cycle;
89    int m_buffer_size;
90    int m_recycle_latency;
91    std::string m_name;
92    std::map<std::string, std::string> m_cfg;
93    NodeID m_version;
94    Network* m_net_ptr;
95    MachineID m_machineID;
96    bool m_is_blocking;
97    std::map<Address, MessageBuffer*> m_block_map;
98    typedef std::vector<MessageBuffer*> MsgVecType;
99    typedef std::map< Address, MsgVecType* > WaitingBufType;
100    WaitingBufType m_waiting_buffers;
101    int m_max_in_port_rank;
102    int m_cur_in_port_rank;
103    int m_number_of_TBEs;
104};
105
106#endif // __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__
107