Profiler.hh revision 7454:3a3e8e8cce1b 
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/*
30   This file has been modified by Kevin Moore and Dan Nussbaum of the
31   Scalable Systems Research Group at Sun Microsystems Laboratories
32   (http://research.sun.com/scalable/) to support the Adaptive
33   Transactional Memory Test Platform (ATMTP).
34
35   Please send email to atmtp-interest@sun.com with feedback, questions, or
36   to request future announcements about ATMTP.
37
38   ----------------------------------------------------------------------
39
40   File modification date: 2008-02-23
41
42   ----------------------------------------------------------------------
43*/
44
45#ifndef __MEM_RUBY_PROFILER_PROFILER_HH__
46#define __MEM_RUBY_PROFILER_PROFILER_HH__
47
48#include <iostream>
49#include <string>
50#include <vector>
51
52#include "mem/protocol/AccessModeType.hh"
53#include "mem/protocol/AccessType.hh"
54#include "mem/protocol/CacheRequestType.hh"
55#include "mem/protocol/GenericMachineType.hh"
56#include "mem/protocol/GenericRequestType.hh"
57#include "mem/protocol/PrefetchBit.hh"
58#include "mem/ruby/common/Address.hh"
59#include "mem/ruby/common/Consumer.hh"
60#include "mem/ruby/common/Global.hh"
61#include "mem/ruby/common/Histogram.hh"
62#include "mem/ruby/common/Set.hh"
63#include "mem/ruby/libruby.hh"
64#include "mem/ruby/system/MachineID.hh"
65#include "mem/ruby/system/MemoryControl.hh"
66#include "mem/ruby/system/NodeID.hh"
67#include "params/RubyProfiler.hh"
68#include "sim/sim_object.hh"
69
70class CacheMsg;
71class AddressProfiler;
72
73template <class KEY_TYPE, class VALUE_TYPE> class Map;
74
75class Profiler : public SimObject, public Consumer
76{
77  public:
78    typedef RubyProfilerParams Params;
79    Profiler(const Params *);
80    ~Profiler();
81
82    void wakeup();
83
84    void setPeriodicStatsFile(const std::string& filename);
85    void setPeriodicStatsInterval(integer_t period);
86
87    void printStats(std::ostream& out, bool short_stats=false);
88    void printShortStats(std::ostream& out) { printStats(out, true); }
89    void printTraceStats(std::ostream& out) const;
90    void clearStats();
91    void printConfig(std::ostream& out) const;
92    void printResourceUsage(std::ostream& out) const;
93
94    AddressProfiler* getAddressProfiler() { return m_address_profiler_ptr; }
95    AddressProfiler* getInstructionProfiler() { return m_inst_profiler_ptr; }
96
97    void addAddressTraceSample(const CacheMsg& msg, NodeID id);
98
99    void profileRequest(const std::string& requestStr);
100    void profileSharing(const Address& addr, AccessType type,
101                        NodeID requestor, const Set& sharers,
102                        const Set& owner);
103
104    void profileMulticastRetry(const Address& addr, int count);
105
106    void profileFilterAction(int action);
107
108    void profileConflictingRequests(const Address& addr);
109
110    void
111    profileOutstandingRequest(int outstanding)
112    {
113        m_outstanding_requests.add(outstanding);
114    }
115
116    void
117    profileOutstandingPersistentRequest(int outstanding)
118    {
119        m_outstanding_persistent_requests.add(outstanding);
120    }
121
122    void
123    profileAverageLatencyEstimate(int latency)
124    {
125        m_average_latency_estimate.add(latency);
126    }
127
128    void recordPrediction(bool wasGood, bool wasPredicted);
129
130    void startTransaction(int cpu);
131    void endTransaction(int cpu);
132    void profilePFWait(Time waitTime);
133
134    void controllerBusy(MachineID machID);
135    void bankBusy();
136    void missLatency(Time t, RubyRequestType type);
137    void swPrefetchLatency(Time t, CacheRequestType type,
138                           GenericMachineType respondingMach);
139    void sequencerRequests(int num) { m_sequencer_requests.add(num); }
140
141    void profileTransition(const std::string& component, NodeID version,
142        Address addr, const std::string& state, const std::string& event,
143        const std::string& next_state, const std::string& note);
144    void profileMsgDelay(int virtualNetwork, int delayCycles);
145
146    void print(std::ostream& out) const;
147
148    void rubyWatch(int proc);
149    bool watchAddress(Address addr);
150
151    // return Ruby's start time
152    Time
153    getRubyStartTime()
154    {
155        return m_ruby_start;
156    }
157
158    // added by SS
159    bool getHotLines() { return m_hot_lines; }
160    bool getAllInstructions() { return m_all_instructions; }
161
162  private:
163    // Private copy constructor and assignment operator
164    Profiler(const Profiler& obj);
165    Profiler& operator=(const Profiler& obj);
166
167    AddressProfiler* m_address_profiler_ptr;
168    AddressProfiler* m_inst_profiler_ptr;
169
170    std::vector<int64> m_instructions_executed_at_start;
171    std::vector<int64> m_cycles_executed_at_start;
172
173    std::ostream* m_periodic_output_file_ptr;
174    integer_t m_stats_period;
175
176    Time m_ruby_start;
177    time_t m_real_time_start_time;
178
179    std::vector<std::vector<integer_t> > m_busyControllerCount;
180    integer_t m_busyBankCount;
181    Histogram m_multicast_retry_histogram;
182
183    Histogram m_filter_action_histogram;
184    Histogram m_tbeProfile;
185
186    Histogram m_sequencer_requests;
187    Histogram m_read_sharing_histogram;
188    Histogram m_write_sharing_histogram;
189    Histogram m_all_sharing_histogram;
190    int64 m_cache_to_cache;
191    int64 m_memory_to_cache;
192
193    Histogram m_prefetchWaitHistogram;
194
195    std::vector<Histogram> m_missLatencyHistograms;
196    std::vector<Histogram> m_machLatencyHistograms;
197    Histogram m_allMissLatencyHistogram;
198
199    Histogram m_allSWPrefetchLatencyHistogram;
200    Histogram m_SWPrefetchL2MissLatencyHistogram;
201    std::vector<Histogram> m_SWPrefetchLatencyHistograms;
202    std::vector<Histogram> m_SWPrefetchMachLatencyHistograms;
203
204    Histogram m_delayedCyclesHistogram;
205    Histogram m_delayedCyclesNonPFHistogram;
206    std::vector<Histogram> m_delayedCyclesVCHistograms;
207
208    Histogram m_outstanding_requests;
209    Histogram m_outstanding_persistent_requests;
210
211    Histogram m_average_latency_estimate;
212
213    Map<Address, int>* m_watch_address_list_ptr;
214    // counts all initiated cache request including PUTs
215    int m_requests;
216    Map <std::string, int>* m_requestProfileMap_ptr;
217
218    //added by SS
219    bool m_hot_lines;
220    bool m_all_instructions;
221
222    int m_num_of_sequencers;
223};
224
225inline std::ostream&
226operator<<(std::ostream& out, const Profiler& obj)
227{
228    obj.print(out);
229    out << std::flush;
230    return out;
231}
232
233#endif // __MEM_RUBY_PROFILER_PROFILER_HH__
234
235
236