Profiler.hh revision 9747:fbe79534d024 
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 <map>
50#include <string>
51#include <vector>
52
53#include "base/hashmap.hh"
54#include "mem/protocol/AccessType.hh"
55#include "mem/protocol/GenericMachineType.hh"
56#include "mem/protocol/PrefetchBit.hh"
57#include "mem/protocol/RubyAccessMode.hh"
58#include "mem/protocol/RubyRequestType.hh"
59#include "mem/ruby/common/Address.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/system/MachineID.hh"
64#include "mem/ruby/system/MemoryControl.hh"
65#include "params/RubyProfiler.hh"
66#include "sim/sim_object.hh"
67
68class RubyRequest;
69class AddressProfiler;
70
71class Profiler : public SimObject
72{
73  public:
74    typedef RubyProfilerParams Params;
75    Profiler(const Params *);
76    ~Profiler();
77
78    void wakeup();
79
80    void setPeriodicStatsFile(const std::string& filename);
81    void setPeriodicStatsInterval(int64_t period);
82
83    void printStats(std::ostream& out, bool short_stats=false);
84    void printShortStats(std::ostream& out) { printStats(out, true); }
85    void printTraceStats(std::ostream& out) const;
86    void clearStats();
87    void printResourceUsage(std::ostream& out) const;
88
89    AddressProfiler* getAddressProfiler() { return m_address_profiler_ptr; }
90    AddressProfiler* getInstructionProfiler() { return m_inst_profiler_ptr; }
91
92    void addAddressTraceSample(const RubyRequest& msg, NodeID id);
93
94    void profileRequest(const std::string& requestStr);
95    void profileSharing(const Address& addr, AccessType type,
96                        NodeID requestor, const Set& sharers,
97                        const Set& owner);
98
99    void profileMulticastRetry(const Address& addr, int count);
100
101    void profileFilterAction(int action);
102
103    void profileConflictingRequests(const Address& addr);
104
105    void
106    profileAverageLatencyEstimate(int latency)
107    {
108        m_average_latency_estimate.add(latency);
109    }
110
111    void controllerBusy(MachineID machID);
112    void bankBusy();
113
114    void missLatency(Cycles t, RubyRequestType type,
115                     const GenericMachineType respondingMach);
116
117    void missLatencyWcc(Cycles issuedTime, Cycles initialRequestTime,
118                        Cycles forwardRequestTime, Cycles firstResponseTime,
119                        Cycles completionTime);
120
121    void missLatencyDir(Cycles issuedTime, Cycles initialRequestTime,
122                        Cycles forwardRequestTime, Cycles firstResponseTime,
123                        Cycles completionTime);
124
125    void swPrefetchLatency(Cycles t, RubyRequestType type,
126                           const GenericMachineType respondingMach);
127
128    void print(std::ostream& out) const;
129
130    void rubyWatch(int proc);
131    bool watchAddress(Address addr);
132
133    // return Ruby's start time
134    Cycles getRubyStartTime() { return m_ruby_start; }
135
136    // added by SS
137    bool getHotLines() { return m_hot_lines; }
138    bool getAllInstructions() { return m_all_instructions; }
139
140  private:
141    void printRequestProfile(std::ostream &out) const;
142    void printDelayProfile(std::ostream &out) const;
143    void printOutstandingReqProfile(std::ostream &out) const;
144
145  private:
146    // Private copy constructor and assignment operator
147    Profiler(const Profiler& obj);
148    Profiler& operator=(const Profiler& obj);
149
150    AddressProfiler* m_address_profiler_ptr;
151    AddressProfiler* m_inst_profiler_ptr;
152
153    Cycles m_ruby_start;
154    time_t m_real_time_start_time;
155
156    int64_t m_busyBankCount;
157
158    Histogram m_read_sharing_histogram;
159    Histogram m_write_sharing_histogram;
160    Histogram m_all_sharing_histogram;
161    int64 m_cache_to_cache;
162    int64 m_memory_to_cache;
163
164    std::vector<Histogram> m_missLatencyHistograms;
165    std::vector<Histogram> m_machLatencyHistograms;
166    std::vector< std::vector<Histogram> > m_missMachLatencyHistograms;
167    Histogram m_wCCIssueToInitialRequestHistogram;
168    Histogram m_wCCInitialRequestToForwardRequestHistogram;
169    Histogram m_wCCForwardRequestToFirstResponseHistogram;
170    Histogram m_wCCFirstResponseToCompleteHistogram;
171    int64 m_wCCIncompleteTimes;
172    Histogram m_dirIssueToInitialRequestHistogram;
173    Histogram m_dirInitialRequestToForwardRequestHistogram;
174    Histogram m_dirForwardRequestToFirstResponseHistogram;
175    Histogram m_dirFirstResponseToCompleteHistogram;
176    int64 m_dirIncompleteTimes;
177
178    Histogram m_allMissLatencyHistogram;
179
180    Histogram m_allSWPrefetchLatencyHistogram;
181    Histogram m_SWPrefetchL2MissLatencyHistogram;
182    std::vector<Histogram> m_SWPrefetchLatencyHistograms;
183    std::vector<Histogram> m_SWPrefetchMachLatencyHistograms;
184
185    Histogram m_average_latency_estimate;
186    m5::hash_set<Address> m_watch_address_set;
187
188    //added by SS
189    bool m_hot_lines;
190    bool m_all_instructions;
191
192    int m_num_of_sequencers;
193};
194
195inline std::ostream&
196operator<<(std::ostream& out, const Profiler& obj)
197{
198    obj.print(out);
199    out << std::flush;
200    return out;
201}
202
203#endif // __MEM_RUBY_PROFILER_PROFILER_HH__
204