1/*
2 * Copyright (c) 1999-2012 Mark D. Hill and David A. Wood
3 * Copyright (c) 2010 Advanced Micro Devices, Inc.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/*
31 * Recording cache requests made to a ruby cache at certain ruby
32 * time. Also dump the requests to a gziped file.
33 */
34
35#ifndef __MEM_RUBY_SYSTEM_CACHERECORDER_HH__
36#define __MEM_RUBY_SYSTEM_CACHERECORDER_HH__
37
38#include <vector>
39
40#include "base/types.hh"
41#include "mem/ruby/common/Address.hh"
42#include "mem/ruby/common/DataBlock.hh"
43#include "mem/ruby/common/TypeDefines.hh"
44#include "mem/ruby/protocol/RubyRequestType.hh"
45
46class Sequencer;
47
48/*!
49 * Class for recording cache contents. Note that the last element of the
50 * class is an array of length zero. It is used for creating variable
51 * length object, so that while writing the data to a file one does not
52 * need to copy the meta data and the actual data separately.
53 */
54class TraceRecord {
55  public:
56    int m_cntrl_id;
57    Tick m_time;
58    Addr m_data_address;
59    Addr m_pc_address;
60    RubyRequestType m_type;
61    uint8_t m_data[0];
62
63    void print(std::ostream& out) const;
64};
65
66class CacheRecorder
67{
68  public:
69    CacheRecorder();
70    ~CacheRecorder();
71
72    CacheRecorder(uint8_t* uncompressed_trace,
73                  uint64_t uncompressed_trace_size,
74                  std::vector<Sequencer*>& SequencerMap,
75                  uint64_t block_size_bytes);
76    void addRecord(int cntrl, Addr data_addr, Addr pc_addr,
77                   RubyRequestType type, Tick time, DataBlock& data);
78
79    uint64_t aggregateRecords(uint8_t **data, uint64_t size);
80
81    /*!
82     * Function for flushing the memory contents of the caches to the
83     * main memory. It goes through the recorded contents of the caches,
84     * and issues flush requests. Except for the first one, a flush request
85     * is issued only after the previous one has completed. This currently
86     * requires use of MOESI Hammer protocol since only that protocol
87     * supports flush requests.
88     */
89    void enqueueNextFlushRequest();
90
91    /*!
92     * Function for fetching warming up the memory and the caches. It goes
93     * through the recorded contents of the caches, as available in the
94     * checkpoint and issues fetch requests. Except for the first one, a
95     * fetch request is issued only after the previous one has completed.
96     * It should be possible to use this with any protocol.
97     */
98    void enqueueNextFetchRequest();
99
100  private:
101    // Private copy constructor and assignment operator
102    CacheRecorder(const CacheRecorder& obj);
103    CacheRecorder& operator=(const CacheRecorder& obj);
104
105    std::vector<TraceRecord*> m_records;
106    uint8_t* m_uncompressed_trace;
107    uint64_t m_uncompressed_trace_size;
108    std::vector<Sequencer*> m_seq_map;
109    uint64_t m_bytes_read;
110    uint64_t m_records_read;
111    uint64_t m_records_flushed;
112    uint64_t m_block_size_bytes;
113};
114
115inline bool
116compareTraceRecords(const TraceRecord* n1, const TraceRecord* n2)
117{
118    return n1->m_time > n2->m_time;
119}
120
121inline std::ostream&
122operator<<(std::ostream& out, const TraceRecord& obj)
123{
124    obj.print(out);
125    out << std::flush;
126    return out;
127}
128
129#endif //__MEM_RUBY_SYSTEM_CACHERECORDER_HH__
130