2 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
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.
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.
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).
35 Please send email to atmtp-interest@sun.com with feedback, questions, or
36 to request future announcements about ATMTP.
38 ----------------------------------------------------------------------
40 File modification date: 2008-02-23
42 ----------------------------------------------------------------------
45 #ifndef __MEM_RUBY_PROFILER_PROFILER_HH__
46 #define __MEM_RUBY_PROFILER_PROFILER_HH__
53 #include "base/hashmap.hh"
54 #include "mem/protocol/AccessType.hh"
55 #include "mem/protocol/GenericMachineType.hh"
56 #include "mem/protocol/GenericRequestType.hh"
57 #include "mem/protocol/PrefetchBit.hh"
58 #include "mem/protocol/RubyAccessMode.hh"
59 #include "mem/protocol/RubyRequestType.hh"
60 #include "mem/ruby/common/Address.hh"
61 #include "mem/ruby/common/Consumer.hh"
62 #include "mem/ruby/common/Global.hh"
63 #include "mem/ruby/common/Histogram.hh"
64 #include "mem/ruby/common/Set.hh"
65 #include "mem/ruby/system/MachineID.hh"
66 #include "mem/ruby/system/MemoryControl.hh"
67 #include "params/RubyProfiler.hh"
68 #include "sim/sim_object.hh"
71 class AddressProfiler;
73 class Profiler : public SimObject, public Consumer
76 typedef RubyProfilerParams Params;
77 Profiler(const Params *);
82 void setPeriodicStatsFile(const std::string& filename);
83 void setPeriodicStatsInterval(integer_t period);
85 void printStats(std::ostream& out, bool short_stats=false);
86 void printShortStats(std::ostream& out) { printStats(out, true); }
87 void printTraceStats(std::ostream& out) const;
89 void printConfig(std::ostream& out) const;
90 void printResourceUsage(std::ostream& out) const;
92 AddressProfiler* getAddressProfiler() { return m_address_profiler_ptr; }
93 AddressProfiler* getInstructionProfiler() { return m_inst_profiler_ptr; }
95 void addAddressTraceSample(const RubyRequest& msg, NodeID id);
97 void profileRequest(const std::string& requestStr);
98 void profileSharing(const Address& addr, AccessType type,
99 NodeID requestor, const Set& sharers,
102 void profileMulticastRetry(const Address& addr, int count);
104 void profileFilterAction(int action);
106 void profileConflictingRequests(const Address& addr);
109 profileOutstandingRequest(int outstanding)
111 m_outstanding_requests.add(outstanding);
115 profileOutstandingPersistentRequest(int outstanding)
117 m_outstanding_persistent_requests.add(outstanding);
121 profileAverageLatencyEstimate(int latency)
123 m_average_latency_estimate.add(latency);
126 void recordPrediction(bool wasGood, bool wasPredicted);
128 void startTransaction(int cpu);
129 void endTransaction(int cpu);
130 void profilePFWait(Time waitTime);
132 void controllerBusy(MachineID machID);
135 void missLatency(Time t,
136 RubyRequestType type,
137 const GenericMachineType respondingMach);
139 void missLatencyWcc(Time issuedTime,
140 Time initialRequestTime,
141 Time forwardRequestTime,
142 Time firstResponseTime,
143 Time completionTime);
145 void missLatencyDir(Time issuedTime,
146 Time initialRequestTime,
147 Time forwardRequestTime,
148 Time firstResponseTime,
149 Time completionTime);
151 void swPrefetchLatency(Time t,
152 RubyRequestType type,
153 const GenericMachineType respondingMach);
155 void sequencerRequests(int num) { m_sequencer_requests.add(num); }
157 void profileMsgDelay(int virtualNetwork, int delayCycles);
159 void print(std::ostream& out) const;
161 void rubyWatch(int proc);
162 bool watchAddress(Address addr);
164 // return Ruby's start time
172 bool getHotLines() { return m_hot_lines; }
173 bool getAllInstructions() { return m_all_instructions; }
176 // Private copy constructor and assignment operator
177 Profiler(const Profiler& obj);
178 Profiler& operator=(const Profiler& obj);
180 AddressProfiler* m_address_profiler_ptr;
181 AddressProfiler* m_inst_profiler_ptr;
183 std::vector<int64> m_instructions_executed_at_start;
184 std::vector<int64> m_cycles_executed_at_start;
186 std::ostream* m_periodic_output_file_ptr;
187 integer_t m_stats_period;
190 time_t m_real_time_start_time;
192 std::vector<std::vector<integer_t> > m_busyControllerCount;
193 integer_t m_busyBankCount;
194 Histogram m_multicast_retry_histogram;
196 Histogram m_filter_action_histogram;
197 Histogram m_tbeProfile;
199 Histogram m_sequencer_requests;
200 Histogram m_read_sharing_histogram;
201 Histogram m_write_sharing_histogram;
202 Histogram m_all_sharing_histogram;
203 int64 m_cache_to_cache;
204 int64 m_memory_to_cache;
206 Histogram m_prefetchWaitHistogram;
208 std::vector<Histogram> m_missLatencyHistograms;
209 std::vector<Histogram> m_machLatencyHistograms;
210 std::vector< std::vector<Histogram> > m_missMachLatencyHistograms;
211 Histogram m_wCCIssueToInitialRequestHistogram;
212 Histogram m_wCCInitialRequestToForwardRequestHistogram;
213 Histogram m_wCCForwardRequestToFirstResponseHistogram;
214 Histogram m_wCCFirstResponseToCompleteHistogram;
215 int64 m_wCCIncompleteTimes;
216 Histogram m_dirIssueToInitialRequestHistogram;
217 Histogram m_dirInitialRequestToForwardRequestHistogram;
218 Histogram m_dirForwardRequestToFirstResponseHistogram;
219 Histogram m_dirFirstResponseToCompleteHistogram;
220 int64 m_dirIncompleteTimes;
222 Histogram m_allMissLatencyHistogram;
224 Histogram m_allSWPrefetchLatencyHistogram;
225 Histogram m_SWPrefetchL2MissLatencyHistogram;
226 std::vector<Histogram> m_SWPrefetchLatencyHistograms;
227 std::vector<Histogram> m_SWPrefetchMachLatencyHistograms;
229 Histogram m_delayedCyclesHistogram;
230 Histogram m_delayedCyclesNonPFHistogram;
231 std::vector<Histogram> m_delayedCyclesVCHistograms;
233 Histogram m_outstanding_requests;
234 Histogram m_outstanding_persistent_requests;
236 Histogram m_average_latency_estimate;
238 m5::hash_set<Address> m_watch_address_set;
239 // counts all initiated cache request including PUTs
241 std::map<std::string, int> m_requestProfileMap;
245 bool m_all_instructions;
247 int m_num_of_sequencers;
251 operator<<(std::ostream& out, const Profiler& obj)
258 #endif // __MEM_RUBY_PROFILER_PROFILER_HH__