CacheRecorder.hh revision 7002 
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 <iostream>
42#include <string>
43
44#include "mem/protocol/CacheRequestType.hh"
45#include "mem/ruby/common/Global.hh"
46#include "mem/ruby/libruby_internal.hh"
47#include "mem/ruby/system/NodeID.hh"
48
49template <class TYPE> class PrioHeap;
50class Address;
51class TraceRecord;
52class Sequencer;
53
54class CacheRecorder {
55public:
56  // Constructors
57  CacheRecorder();
58
59  // Destructor
60  ~CacheRecorder();
61
62  // Public Methods
63  void addRecord(Sequencer* sequencer,
64                 const Address& data_addr,
65                 const Address& pc_addr,
66                 RubyRequestType type,
67                 Time time);
68  int dumpRecords(std::string filename);
69
70  void print(std::ostream& out) const;
71private:
72  // Private Methods
73
74  // Private copy constructor and assignment operator
75  CacheRecorder(const CacheRecorder& obj);
76  CacheRecorder& operator=(const CacheRecorder& obj);
77
78  // Data Members (m_ prefix)
79  PrioHeap<TraceRecord>* m_records_ptr;
80};
81
82// Output operator declaration
83std::ostream& operator<<(std::ostream& out, const CacheRecorder& obj);
84
85// ******************* Definitions *******************
86
87// Output operator definition
88extern inline
89std::ostream& operator<<(std::ostream& out, const CacheRecorder& obj)
90{
91  obj.print(out);
92  out << std::flush;
93  return out;
94}
95
96#endif //CACHERECORDER_H
97