mem_trace.cc revision 11139:bd894d2bdd7c
1/* 2 * Copyright (c) 2015 ARM Limited 3 * All rights reserved 4 * 5 * The license below extends only to copyright in the software and shall 6 * not be construed as granting a license to any other intellectual 7 * property including but not limited to intellectual property relating 8 * to a hardware implementation of the functionality of the software 9 * licensed hereunder. You may use the software subject to the license 10 * terms below provided that you ensure that this notice is replicated 11 * unmodified and in its entirety in all distributions of the software, 12 * modified or unmodified, in source code or in binary form. 13 * 14 * Redistribution and use in source and binary forms, with or without 15 * modification, are permitted provided that the following conditions are 16 * met: redistributions of source code must retain the above copyright 17 * notice, this list of conditions and the following disclaimer; 18 * redistributions in binary form must reproduce the above copyright 19 * notice, this list of conditions and the following disclaimer in the 20 * documentation and/or other materials provided with the distribution; 21 * neither the name of the copyright holders nor the names of its 22 * contributors may be used to endorse or promote products derived from 23 * this software without specific prior written permission. 24 * 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 26 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 27 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 28 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 29 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 30 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 31 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 35 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 36 * 37 * Authors: Andreas Hansson 38 * Andreas Sandberg 39 */ 40 41#include "mem/probes/mem_trace.hh" 42 43#include "base/callback.hh" 44#include "base/output.hh" 45#include "params/MemTraceProbe.hh" 46#include "proto/packet.pb.h" 47 48MemTraceProbe::MemTraceProbe(MemTraceProbeParams *p) 49 : BaseMemProbe(p), 50 traceStream(nullptr) 51{ 52 std::string filename; 53 if (p->trace_file != "") { 54 // If the trace file is not specified as an absolute path, 55 // append the current simulation output directory 56 filename = simout.resolve(p->trace_file); 57 58 const std::string suffix = ".gz"; 59 // If trace_compress has been set, check the suffix. Append 60 // accordingly. 61 if (p->trace_compress && 62 filename.compare(filename.size() - suffix.size(), suffix.size(), 63 suffix) != 0) 64 filename = filename + suffix; 65 } else { 66 // Generate a filename from the name of the SimObject. Append .trc 67 // and .gz if we want compression enabled. 68 filename = simout.resolve(name() + ".trc" + 69 (p->trace_compress ? ".gz" : "")); 70 } 71 72 traceStream = new ProtoOutputStream(filename); 73 74 // Create a protobuf message for the header and write it to 75 // the stream 76 ProtoMessage::PacketHeader header_msg; 77 header_msg.set_obj_id(name()); 78 header_msg.set_tick_freq(SimClock::Frequency); 79 traceStream->write(header_msg); 80 81 // Register a callback to compensate for the destructor not 82 // being called. The callback forces the stream to flush and 83 // closes the output file. 84 registerExitCallback( 85 new MakeCallback<MemTraceProbe, &MemTraceProbe::closeStreams>(this)); 86} 87 88void 89MemTraceProbe::closeStreams() 90{ 91 if (traceStream != NULL) 92 delete traceStream; 93} 94 95void 96MemTraceProbe::handleRequest(const ProbePoints::PacketInfo &pkt_info) 97{ 98 ProtoMessage::Packet pkt_msg; 99 100 pkt_msg.set_tick(curTick()); 101 pkt_msg.set_cmd(pkt_info.cmd.toInt()); 102 pkt_msg.set_flags(pkt_info.flags); 103 pkt_msg.set_addr(pkt_info.addr); 104 pkt_msg.set_size(pkt_info.size); 105 106 traceStream->write(pkt_msg); 107} 108 109 110MemTraceProbe * 111MemTraceProbeParams::create() 112{ 113 return new MemTraceProbe(this); 114} 115