AddressProfiler.hh revision 9554:406fbcf60223 
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_PROFILER_ADDRESSPROFILER_HH__
30#define __MEM_RUBY_PROFILER_ADDRESSPROFILER_HH__
31
32#include <iostream>
33
34#include "base/hashmap.hh"
35#include "mem/protocol/AccessType.hh"
36#include "mem/protocol/RubyRequest.hh"
37#include "mem/ruby/common/Address.hh"
38#include "mem/ruby/common/Global.hh"
39#include "mem/ruby/common/Histogram.hh"
40#include "mem/ruby/profiler/AccessTraceForAddress.hh"
41
42class Set;
43
44class AddressProfiler
45{
46  public:
47    typedef m5::hash_map<Address, AccessTraceForAddress> AddressMap;
48
49  public:
50    AddressProfiler(int num_of_sequencers);
51    ~AddressProfiler();
52
53    void printStats(std::ostream& out) const;
54    void clearStats();
55
56    void addTraceSample(Address data_addr, Address pc_addr,
57                        RubyRequestType type, RubyAccessMode access_mode,
58                        NodeID id, bool sharing_miss);
59    void profileRetry(const Address& data_addr, AccessType type, int count);
60    void profileGetX(const Address& datablock, const Address& PC,
61                     const Set& owner, const Set& sharers, NodeID requestor);
62    void profileGetS(const Address& datablock, const Address& PC,
63                     const Set& owner, const Set& sharers, NodeID requestor);
64
65    void print(std::ostream& out) const;
66
67    //added by SS
68    void setHotLines(bool hot_lines);
69    void setAllInstructions(bool all_instructions);
70
71  private:
72    // Private copy constructor and assignment operator
73    AddressProfiler(const AddressProfiler& obj);
74    AddressProfiler& operator=(const AddressProfiler& obj);
75
76    int64 m_sharing_miss_counter;
77
78    AddressMap m_dataAccessTrace;
79    AddressMap m_macroBlockAccessTrace;
80    AddressMap m_programCounterAccessTrace;
81    AddressMap m_retryProfileMap;
82    Histogram m_retryProfileHisto;
83    Histogram m_retryProfileHistoWrite;
84    Histogram m_retryProfileHistoRead;
85    Histogram m_getx_sharing_histogram;
86    Histogram m_gets_sharing_histogram;
87
88    //added by SS
89    bool m_hot_lines;
90    bool m_all_instructions;
91
92    int m_num_of_sequencers;
93};
94
95AccessTraceForAddress& lookupTraceForAddress(const Address& addr,
96                                             AddressProfiler::AddressMap&
97                                             record_map);
98
99void printSorted(std::ostream& out, int num_of_sequencers,
100                 const AddressProfiler::AddressMap &record_map,
101                 std::string description);
102
103inline std::ostream&
104operator<<(std::ostream& out, const AddressProfiler& obj)
105{
106    obj.print(out);
107    out << std::flush;
108    return out;
109}
110
111#endif // __MEM_RUBY_PROFILER_ADDRESSPROFILER_HH__
112