mem_trace.cc revision 12189:18937fe3cc31
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 withPC(p->with_pc) 52{ 53 std::string filename; 54 if (p->trace_file != "") { 55 // If the trace file is not specified as an absolute path, 56 // append the current simulation output directory 57 filename = simout.resolve(p->trace_file); 58 59 const std::string suffix = ".gz"; 60 // If trace_compress has been set, check the suffix. Append 61 // accordingly. 62 if (p->trace_compress && 63 filename.compare(filename.size() - suffix.size(), suffix.size(), 64 suffix) != 0) 65 filename = filename + suffix; 66 } else { 67 // Generate a filename from the name of the SimObject. Append .trc 68 // and .gz if we want compression enabled. 69 filename = simout.resolve(name() + ".trc" + 70 (p->trace_compress ? ".gz" : "")); 71 } 72 73 traceStream = new ProtoOutputStream(filename); 74 75 // Create a protobuf message for the header and write it to 76 // the stream 77 ProtoMessage::PacketHeader header_msg; 78 header_msg.set_obj_id(name()); 79 header_msg.set_tick_freq(SimClock::Frequency); 80 traceStream->write(header_msg); 81 82 // Register a callback to compensate for the destructor not 83 // being called. The callback forces the stream to flush and 84 // closes the output file. 85 registerExitCallback( 86 new MakeCallback<MemTraceProbe, &MemTraceProbe::closeStreams>(this)); 87} 88 89void 90MemTraceProbe::closeStreams() 91{ 92 if (traceStream != NULL) 93 delete traceStream; 94} 95 96void 97MemTraceProbe::handleRequest(const ProbePoints::PacketInfo &pkt_info) 98{ 99 ProtoMessage::Packet pkt_msg; 100 101 pkt_msg.set_tick(curTick()); 102 pkt_msg.set_cmd(pkt_info.cmd.toInt()); 103 pkt_msg.set_flags(pkt_info.flags); 104 pkt_msg.set_addr(pkt_info.addr); 105 pkt_msg.set_size(pkt_info.size); 106 if (withPC && pkt_info.pc != 0) 107 pkt_msg.set_pc(pkt_info.pc); 108 pkt_msg.set_pkt_id(pkt_info.master); 109 110 traceStream->write(pkt_msg); 111} 112 113 114MemTraceProbe * 115MemTraceProbeParams::create() 116{ 117 return new MemTraceProbe(this); 118} 119