CacheRecorder.hh revision 11061
1/* 2 * Copyright (c) 1999-2012 Mark D. Hill and David A. Wood 3 * Copyright (c) 2010 Advanced Micro Devices, Inc. 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 * Recording cache requests made to a ruby cache at certain ruby 32 * time. Also dump the requests to a gziped file. 33 */ 34 35#ifndef __MEM_RUBY_RECORDER_CACHERECORDER_HH__ 36#define __MEM_RUBY_RECORDER_CACHERECORDER_HH__ 37 38#include <vector> 39 40#include "base/hashmap.hh" 41#include "base/types.hh" 42#include "mem/protocol/RubyRequestType.hh" 43#include "mem/ruby/common/Address.hh" 44#include "mem/ruby/common/DataBlock.hh" 45#include "mem/ruby/common/TypeDefines.hh" 46 47class Sequencer; 48 49/*! 50 * Class for recording cache contents. Note that the last element of the 51 * class is an array of length zero. It is used for creating variable 52 * length object, so that while writing the data to a file one does not 53 * need to copy the meta data and the actual data separately. 54 */ 55class TraceRecord { 56 public: 57 int m_cntrl_id; 58 Tick m_time; 59 Addr m_data_address; 60 Addr m_pc_address; 61 RubyRequestType m_type; 62 uint8_t m_data[0]; 63 64 void print(std::ostream& out) const; 65}; 66 67class CacheRecorder 68{ 69 public: 70 CacheRecorder(); 71 ~CacheRecorder(); 72 73 CacheRecorder(uint8_t* uncompressed_trace, 74 uint64_t uncompressed_trace_size, 75 std::vector<Sequencer*>& SequencerMap, 76 uint64_t block_size_bytes); 77 void addRecord(int cntrl, Addr data_addr, Addr pc_addr, 78 RubyRequestType type, Tick time, DataBlock& data); 79 80 uint64_t aggregateRecords(uint8_t **data, uint64_t size); 81 82 /*! 83 * Function for flushing the memory contents of the caches to the 84 * main memory. It goes through the recorded contents of the caches, 85 * and issues flush requests. Except for the first one, a flush request 86 * is issued only after the previous one has completed. This currently 87 * requires use of MOESI Hammer protocol since only that protocol 88 * supports flush requests. 89 */ 90 void enqueueNextFlushRequest(); 91 92 /*! 93 * Function for fetching warming up the memory and the caches. It goes 94 * through the recorded contents of the caches, as available in the 95 * checkpoint and issues fetch requests. Except for the first one, a 96 * fetch request is issued only after the previous one has completed. 97 * It should be possible to use this with any protocol. 98 */ 99 void enqueueNextFetchRequest(); 100 101 private: 102 // Private copy constructor and assignment operator 103 CacheRecorder(const CacheRecorder& obj); 104 CacheRecorder& operator=(const CacheRecorder& obj); 105 106 std::vector<TraceRecord*> m_records; 107 uint8_t* m_uncompressed_trace; 108 uint64_t m_uncompressed_trace_size; 109 std::vector<Sequencer*> m_seq_map; 110 uint64_t m_bytes_read; 111 uint64_t m_records_read; 112 uint64_t m_records_flushed; 113 uint64_t m_block_size_bytes; 114}; 115 116inline bool 117compareTraceRecords(const TraceRecord* n1, const TraceRecord* n2) 118{ 119 return n1->m_time > n2->m_time; 120} 121 122inline std::ostream& 123operator<<(std::ostream& out, const TraceRecord& obj) 124{ 125 obj.print(out); 126 out << std::flush; 127 return out; 128} 129 130#endif // __MEM_RUBY_RECORDER_CACHERECORDER_HH__ 131