CacheRecorder.hh revision 6890 
1
2/*
3 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
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 * $Id$
32 *
33 * Description: Recording cache requests made to a ruby cache at certain
34 *              ruby time. Also dump the requests to a gziped file.
35 *
36 */
37
38#ifndef CACHERECORDER_H
39#define CACHERECORDER_H
40
41#include "mem/ruby/libruby_internal.hh"
42
43#include "mem/ruby/common/Global.hh"
44#include "mem/ruby/system/NodeID.hh"
45#include "mem/protocol/CacheRequestType.hh"
46
47template <class TYPE> class PrioHeap;
48class Address;
49class TraceRecord;
50class Sequencer;
51
52class CacheRecorder {
53public:
54  // Constructors
55  CacheRecorder();
56
57  // Destructor
58  ~CacheRecorder();
59
60  // Public Methods
61  void addRecord(Sequencer* sequencer,
62                 const Address& data_addr,
63                 const Address& pc_addr,
64                 RubyRequestType type,
65                 Time time);
66  int dumpRecords(string filename);
67
68  void print(ostream& out) const;
69private:
70  // Private Methods
71
72  // Private copy constructor and assignment operator
73  CacheRecorder(const CacheRecorder& obj);
74  CacheRecorder& operator=(const CacheRecorder& obj);
75
76  // Data Members (m_ prefix)
77  PrioHeap<TraceRecord>* m_records_ptr;
78};
79
80// Output operator declaration
81ostream& operator<<(ostream& out, const CacheRecorder& obj);
82
83// ******************* Definitions *******************
84
85// Output operator definition
86extern inline
87ostream& operator<<(ostream& out, const CacheRecorder& obj)
88{
89  obj.print(out);
90  out << flush;
91  return out;
92}
93
94#endif //CACHERECORDER_H
95