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