CacheRecorder.hh revision 6890
112855Sgabeblack@google.com
212855Sgabeblack@google.com/*
312855Sgabeblack@google.com * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
412855Sgabeblack@google.com * All rights reserved.
512855Sgabeblack@google.com *
612855Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without
712855Sgabeblack@google.com * modification, are permitted provided that the following conditions are
812855Sgabeblack@google.com * met: redistributions of source code must retain the above copyright
912855Sgabeblack@google.com * notice, this list of conditions and the following disclaimer;
1012855Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright
1112855Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the
1212855Sgabeblack@google.com * documentation and/or other materials provided with the distribution;
1312855Sgabeblack@google.com * neither the name of the copyright holders nor the names of its
1412855Sgabeblack@google.com * contributors may be used to endorse or promote products derived from
1512855Sgabeblack@google.com * this software without specific prior written permission.
1612855Sgabeblack@google.com *
1712855Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
1812855Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
1912855Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
2012855Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
2112855Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
2212855Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
2312855Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
2412855Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
2512855Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
2612855Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
2712855Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2812855Sgabeblack@google.com */
2912855Sgabeblack@google.com
3012855Sgabeblack@google.com/*
3112855Sgabeblack@google.com * $Id$
3212855Sgabeblack@google.com *
3312855Sgabeblack@google.com * Description: Recording cache requests made to a ruby cache at certain
3412855Sgabeblack@google.com *              ruby time. Also dump the requests to a gziped file.
3512855Sgabeblack@google.com *
3612855Sgabeblack@google.com */
3712855Sgabeblack@google.com
3812855Sgabeblack@google.com#ifndef CACHERECORDER_H
3912855Sgabeblack@google.com#define CACHERECORDER_H
4012855Sgabeblack@google.com
4112855Sgabeblack@google.com#include "mem/ruby/libruby_internal.hh"
4212855Sgabeblack@google.com
4312855Sgabeblack@google.com#include "mem/ruby/common/Global.hh"
4412855Sgabeblack@google.com#include "mem/ruby/system/NodeID.hh"
4512855Sgabeblack@google.com#include "mem/protocol/CacheRequestType.hh"
4612855Sgabeblack@google.com
4712855Sgabeblack@google.comtemplate <class TYPE> class PrioHeap;
4812855Sgabeblack@google.comclass Address;
4912855Sgabeblack@google.comclass TraceRecord;
5012855Sgabeblack@google.comclass Sequencer;
5112855Sgabeblack@google.com
5212855Sgabeblack@google.comclass CacheRecorder {
5312855Sgabeblack@google.compublic:
5412855Sgabeblack@google.com  // Constructors
5512855Sgabeblack@google.com  CacheRecorder();
5612855Sgabeblack@google.com
5712855Sgabeblack@google.com  // Destructor
5812855Sgabeblack@google.com  ~CacheRecorder();
5912855Sgabeblack@google.com
6012855Sgabeblack@google.com  // Public Methods
6112855Sgabeblack@google.com  void addRecord(Sequencer* sequencer,
6212855Sgabeblack@google.com                 const Address& data_addr,
6312855Sgabeblack@google.com                 const Address& pc_addr,
6412855Sgabeblack@google.com                 RubyRequestType type,
6512855Sgabeblack@google.com                 Time time);
6612855Sgabeblack@google.com  int dumpRecords(string filename);
6712855Sgabeblack@google.com
6812855Sgabeblack@google.com  void print(ostream& out) const;
6912855Sgabeblack@google.comprivate:
7012855Sgabeblack@google.com  // Private Methods
7112855Sgabeblack@google.com
7212855Sgabeblack@google.com  // Private copy constructor and assignment operator
7312855Sgabeblack@google.com  CacheRecorder(const CacheRecorder& obj);
7412855Sgabeblack@google.com  CacheRecorder& operator=(const CacheRecorder& obj);
7512855Sgabeblack@google.com
7612855Sgabeblack@google.com  // Data Members (m_ prefix)
7712855Sgabeblack@google.com  PrioHeap<TraceRecord>* m_records_ptr;
7812855Sgabeblack@google.com};
7912855Sgabeblack@google.com
8012855Sgabeblack@google.com// Output operator declaration
8112855Sgabeblack@google.comostream& operator<<(ostream& out, const CacheRecorder& obj);
8212855Sgabeblack@google.com
8312855Sgabeblack@google.com// ******************* Definitions *******************
8412855Sgabeblack@google.com
8512855Sgabeblack@google.com// Output operator definition
8612855Sgabeblack@google.comextern inline
8712855Sgabeblack@google.comostream& operator<<(ostream& out, const CacheRecorder& obj)
8812855Sgabeblack@google.com{
8912855Sgabeblack@google.com  obj.print(out);
9012855Sgabeblack@google.com  out << flush;
9112855Sgabeblack@google.com  return out;
9212855Sgabeblack@google.com}
9312855Sgabeblack@google.com
9412855Sgabeblack@google.com#endif //CACHERECORDER_H
9512855Sgabeblack@google.com