StoreTrace.hh revision 9171:ae88ecf37145 
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_STORETRACE_HH__
30#define __MEM_RUBY_PROFILER_STORETRACE_HH__
31
32#include <iostream>
33
34#include "mem/ruby/common/Address.hh"
35#include "mem/ruby/common/Histogram.hh"
36
37class StoreTrace
38{
39  public:
40    StoreTrace() { }
41    explicit StoreTrace(const Address& addr);
42    ~StoreTrace();
43
44    void store(NodeID node);
45    void downgrade(NodeID node);
46    int getTotal() const { return m_total_samples; }
47    static void initSummary();
48    static void printSummary(std::ostream& out);
49    static void clearSummary();
50
51    void print(std::ostream& out) const;
52
53  private:
54    static bool s_init;
55    static int64 s_total_samples; // Total number of store lifetimes
56                                  // of all lines
57    static Histogram* s_store_count_ptr;
58    static Histogram* s_store_first_to_stolen_ptr;
59    static Histogram* s_store_last_to_stolen_ptr;
60    static Histogram* s_store_first_to_last_ptr;
61
62    Address m_addr;
63    NodeID m_last_writer;
64    Time m_first_store;
65    Time m_last_store;
66    int m_stores_this_interval;
67
68    int64 m_total_samples; // Total number of store lifetimes of this line
69    Histogram m_store_count;
70    Histogram m_store_first_to_stolen;
71    Histogram m_store_last_to_stolen;
72    Histogram m_store_first_to_last;
73};
74
75inline bool
76node_less_then_eq(const StoreTrace* n1, const StoreTrace* n2)
77{
78    return n1->getTotal() > n2->getTotal();
79}
80
81inline std::ostream&
82operator<<(std::ostream& out, const StoreTrace& obj)
83{
84    obj.print(out);
85    out << std::flush;
86    return out;
87}
88
89#endif // __MEM_RUBY_PROFILER_STORETRACE_HH__
90