CacheRecorder.hh revision 7456 
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/*
30 * Recording cache requests made to a ruby cache at certain ruby
31 * time. Also dump the requests to a gziped file.
32 */
33
34#ifndef __MEM_RUBY_RECORDER_CACHERECORDER_HH__
35#define __MEM_RUBY_RECORDER_CACHERECORDER_HH__
36
37#include <iostream>
38#include <string>
39#include <vector>
40
41#include "mem/protocol/CacheRequestType.hh"
42#include "mem/ruby/common/Global.hh"
43#include "mem/ruby/libruby_internal.hh"
44#include "mem/ruby/system/NodeID.hh"
45#include "mem/ruby/recorder/TraceRecord.hh"
46
47class Address;
48class TraceRecord;
49class Sequencer;
50
51class CacheRecorder
52{
53  public:
54    void addRecord(Sequencer* sequencer, const Address& data_addr,
55        const Address& pc_addr, RubyRequestType type, Time time);
56    int dumpRecords(std::string filename);
57
58    void print(std::ostream& out) const;
59
60  private:
61    // Private copy constructor and assignment operator
62    CacheRecorder(const CacheRecorder& obj);
63    CacheRecorder& operator=(const CacheRecorder& obj);
64
65    std::vector<TraceRecord> m_records;
66};
67
68inline std::ostream&
69operator<<(std::ostream& out, const CacheRecorder& obj)
70{
71    obj.print(out);
72    out << std::flush;
73    return out;
74}
75
76#endif // __MEM_RUBY_RECORDER_CACHERECORDER_HH__
77