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