Sequencer.hh revision 9598 
1/*
2 * Copyright (c) 1999-2008 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_SYSTEM_SEQUENCER_HH__
30#define __MEM_RUBY_SYSTEM_SEQUENCER_HH__
31
32#include <iostream>
33
34#include "base/hashmap.hh"
35#include "mem/protocol/GenericMachineType.hh"
36#include "mem/protocol/RubyRequestType.hh"
37#include "mem/protocol/SequencerRequestType.hh"
38#include "mem/ruby/common/Address.hh"
39#include "mem/ruby/system/CacheMemory.hh"
40#include "mem/ruby/system/RubyPort.hh"
41#include "params/RubySequencer.hh"
42
43class DataBlock;
44
45struct SequencerRequest
46{
47    PacketPtr pkt;
48    RubyRequestType m_type;
49    Cycles issue_time;
50
51    SequencerRequest(PacketPtr _pkt, RubyRequestType _m_type,
52                     Cycles _issue_time)
53        : pkt(_pkt), m_type(_m_type), issue_time(_issue_time)
54    {}
55};
56
57std::ostream& operator<<(std::ostream& out, const SequencerRequest& obj);
58
59class Sequencer : public RubyPort
60{
61  public:
62    typedef RubySequencerParams Params;
63    Sequencer(const Params *);
64    ~Sequencer();
65
66    // Public Methods
67    void wakeup(); // Used only for deadlock detection
68
69    void printProgress(std::ostream& out) const;
70
71    void clearStats();
72
73    void writeCallback(const Address& address, DataBlock& data);
74
75    void writeCallback(const Address& address,
76                       GenericMachineType mach,
77                       DataBlock& data);
78
79    void writeCallback(const Address& address,
80                       GenericMachineType mach,
81                       DataBlock& data,
82                       Cycles initialRequestTime,
83                       Cycles forwardRequestTime,
84                       Cycles firstResponseTime);
85
86    void readCallback(const Address& address, DataBlock& data);
87
88    void readCallback(const Address& address,
89                      GenericMachineType mach,
90                      DataBlock& data);
91
92    void readCallback(const Address& address,
93                      GenericMachineType mach,
94                      DataBlock& data,
95                      Cycles initialRequestTime,
96                      Cycles forwardRequestTime,
97                      Cycles firstResponseTime);
98
99    RequestStatus makeRequest(PacketPtr pkt);
100    bool empty() const;
101    int outstandingCount() const { return m_outstanding_count; }
102
103    bool isDeadlockEventScheduled() const
104    { return deadlockCheckEvent.scheduled(); }
105
106    void descheduleDeadlockEvent()
107    { deschedule(deadlockCheckEvent); }
108
109    void print(std::ostream& out) const;
110    void printStats(std::ostream& out) const;
111    void checkCoherence(const Address& address);
112
113    void markRemoved();
114    void removeRequest(SequencerRequest* request);
115    void evictionCallback(const Address& address);
116    void invalidateSC(const Address& address);
117
118    void recordRequestType(SequencerRequestType requestType);
119    Histogram& getOutstandReqHist() { return m_outstandReqHist; }
120
121  private:
122    void issueRequest(PacketPtr pkt, RubyRequestType type);
123
124    void hitCallback(SequencerRequest* request,
125                     GenericMachineType mach,
126                     DataBlock& data,
127                     bool success,
128                     Cycles initialRequestTime,
129                     Cycles forwardRequestTime,
130                     Cycles firstResponseTime);
131
132    RequestStatus insertRequest(PacketPtr pkt, RubyRequestType request_type);
133
134    bool handleLlsc(const Address& address, SequencerRequest* request);
135
136    // Private copy constructor and assignment operator
137    Sequencer(const Sequencer& obj);
138    Sequencer& operator=(const Sequencer& obj);
139
140  private:
141    int m_max_outstanding_requests;
142    Cycles m_deadlock_threshold;
143
144    CacheMemory* m_dataCache_ptr;
145    CacheMemory* m_instCache_ptr;
146
147    typedef m5::hash_map<Address, SequencerRequest*> RequestTable;
148    RequestTable m_writeRequestTable;
149    RequestTable m_readRequestTable;
150    // Global outstanding request count, across all request tables
151    int m_outstanding_count;
152    bool m_deadlock_check_scheduled;
153
154    uint32_t m_store_waiting_on_load_cycles;
155    uint32_t m_store_waiting_on_store_cycles;
156    uint32_t m_load_waiting_on_store_cycles;
157    uint32_t m_load_waiting_on_load_cycles;
158
159    bool m_usingNetworkTester;
160
161    //! Histogram for number of outstanding requests per cycle.
162    Histogram m_outstandReqHist;
163
164    class SequencerWakeupEvent : public Event
165    {
166      private:
167        Sequencer *m_sequencer_ptr;
168
169      public:
170        SequencerWakeupEvent(Sequencer *_seq) : m_sequencer_ptr(_seq) {}
171        void process() { m_sequencer_ptr->wakeup(); }
172        const char *description() const { return "Sequencer deadlock check"; }
173    };
174
175    SequencerWakeupEvent deadlockCheckEvent;
176};
177
178inline std::ostream&
179operator<<(std::ostream& out, const Sequencer& obj)
180{
181    obj.print(out);
182    out << std::flush;
183    return out;
184}
185
186#endif // __MEM_RUBY_SYSTEM_SEQUENCER_HH__
187