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#include "mem/ruby/profiler/StoreTrace.hh"
30
31#include "sim/core.hh"
32
33using namespace std;
34
35bool StoreTrace::s_init = false; // Total number of store lifetimes of
36                                 // all lines
37int64_t StoreTrace::s_total_samples = 0; // Total number of store
38                                       // lifetimes of all lines
39Histogram* StoreTrace::s_store_count_ptr = NULL;
40Histogram* StoreTrace::s_store_first_to_stolen_ptr = NULL;
41Histogram* StoreTrace::s_store_last_to_stolen_ptr = NULL;
42Histogram* StoreTrace::s_store_first_to_last_ptr = NULL;
43
44StoreTrace::StoreTrace(Addr addr)
45    : m_store_count(-1), m_store_first_to_stolen(-1),
46      m_store_last_to_stolen(-1), m_store_first_to_last(-1)
47{
48    StoreTrace::initSummary();
49    m_addr = addr;
50    m_total_samples = 0;
51
52    // Really -1 isn't valid, so this will trigger the initilization code
53    m_last_writer = -1;
54    m_stores_this_interval = 0;
55}
56
57StoreTrace::~StoreTrace()
58{
59}
60
61void
62StoreTrace::print(ostream& out) const
63{
64    out << m_addr
65        << " total_samples: " << m_total_samples << endl
66        << "store_count: " << m_store_count << endl
67        << "store_first_to_stolen: " << m_store_first_to_stolen << endl
68        << "store_last_to_stolen: " << m_store_last_to_stolen << endl
69        << "store_first_to_last: " << m_store_first_to_last  << endl;
70}
71
72void
73StoreTrace::initSummary()
74{
75    if (!s_init) {
76        s_total_samples = 0;
77        s_store_count_ptr = new Histogram(-1);
78        s_store_first_to_stolen_ptr = new Histogram(-1);
79        s_store_last_to_stolen_ptr = new Histogram(-1);
80        s_store_first_to_last_ptr = new Histogram(-1);
81    }
82    s_init = true;
83}
84
85void
86StoreTrace::printSummary(ostream& out)
87{
88    out << "total_samples: " << s_total_samples << endl;
89    out << "store_count: " << (*s_store_count_ptr) << endl;
90    out << "store_first_to_stolen: " << (*s_store_first_to_stolen_ptr) << endl;
91    out << "store_last_to_stolen: " << (*s_store_last_to_stolen_ptr) << endl;
92    out << "store_first_to_last: " << (*s_store_first_to_last_ptr) << endl;
93}
94
95void
96StoreTrace::clearSummary()
97{
98    StoreTrace::initSummary();
99    s_total_samples = 0;
100    s_store_count_ptr->clear();
101    s_store_first_to_stolen_ptr->clear();
102    s_store_last_to_stolen_ptr->clear();
103    s_store_first_to_last_ptr->clear();
104}
105
106void
107StoreTrace::store(NodeID node)
108{
109    Tick current = curTick();
110
111    assert((m_last_writer == -1) || (m_last_writer == node));
112
113    m_last_writer = node;
114    if (m_last_writer == -1) {
115        assert(m_stores_this_interval == 0);
116    }
117
118    if (m_stores_this_interval == 0) {
119        // A new proessor just wrote the line, so reset the stats
120        m_first_store = current;
121    }
122
123    m_last_store = current;
124    m_stores_this_interval++;
125}
126
127void
128StoreTrace::downgrade(NodeID node)
129{
130    if (node == m_last_writer) {
131        Tick current = curTick();
132        assert(m_stores_this_interval != 0);
133        assert(m_last_store != 0);
134        assert(m_first_store != 0);
135        assert(m_last_writer != -1);
136
137        // Per line stats
138        m_store_first_to_stolen.add(current - m_first_store);
139        m_store_count.add(m_stores_this_interval);
140        m_store_last_to_stolen.add(current - m_last_store);
141        m_store_first_to_last.add(m_last_store - m_first_store);
142        m_total_samples++;
143
144        // Global stats
145        assert(s_store_first_to_stolen_ptr != NULL);
146        s_store_first_to_stolen_ptr->add(current - m_first_store);
147        s_store_count_ptr->add(m_stores_this_interval);
148        s_store_last_to_stolen_ptr->add(current - m_last_store);
149        s_store_first_to_last_ptr->add(m_last_store - m_first_store);
150        s_total_samples++;
151
152        // Initilize for next go round
153        m_stores_this_interval = 0;
154        m_last_store = 0;
155        m_first_store = 0;
156        m_last_writer = -1;
157    }
158}
159