mem_trace.cc revision 10996
110996Sandreas.sandberg@arm.com/* 210996Sandreas.sandberg@arm.com * Copyright (c) 2015 ARM Limited 310996Sandreas.sandberg@arm.com * All rights reserved 410996Sandreas.sandberg@arm.com * 510996Sandreas.sandberg@arm.com * The license below extends only to copyright in the software and shall 610996Sandreas.sandberg@arm.com * not be construed as granting a license to any other intellectual 710996Sandreas.sandberg@arm.com * property including but not limited to intellectual property relating 810996Sandreas.sandberg@arm.com * to a hardware implementation of the functionality of the software 910996Sandreas.sandberg@arm.com * licensed hereunder. You may use the software subject to the license 1010996Sandreas.sandberg@arm.com * terms below provided that you ensure that this notice is replicated 1110996Sandreas.sandberg@arm.com * unmodified and in its entirety in all distributions of the software, 1210996Sandreas.sandberg@arm.com * modified or unmodified, in source code or in binary form. 1310996Sandreas.sandberg@arm.com * 1410996Sandreas.sandberg@arm.com * Redistribution and use in source and binary forms, with or without 1510996Sandreas.sandberg@arm.com * modification, are permitted provided that the following conditions are 1610996Sandreas.sandberg@arm.com * met: redistributions of source code must retain the above copyright 1710996Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer; 1810996Sandreas.sandberg@arm.com * redistributions in binary form must reproduce the above copyright 1910996Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer in the 2010996Sandreas.sandberg@arm.com * documentation and/or other materials provided with the distribution; 2110996Sandreas.sandberg@arm.com * neither the name of the copyright holders nor the names of its 2210996Sandreas.sandberg@arm.com * contributors may be used to endorse or promote products derived from 2310996Sandreas.sandberg@arm.com * this software without specific prior written permission. 2410996Sandreas.sandberg@arm.com * 2510996Sandreas.sandberg@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2610996Sandreas.sandberg@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2710996Sandreas.sandberg@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2810996Sandreas.sandberg@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2910996Sandreas.sandberg@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3010996Sandreas.sandberg@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3110996Sandreas.sandberg@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3210996Sandreas.sandberg@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3310996Sandreas.sandberg@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3410996Sandreas.sandberg@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3510996Sandreas.sandberg@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3610996Sandreas.sandberg@arm.com * 3710996Sandreas.sandberg@arm.com * Authors: Andreas Hansson 3810996Sandreas.sandberg@arm.com * Andreas Sandberg 3910996Sandreas.sandberg@arm.com */ 4010996Sandreas.sandberg@arm.com 4110996Sandreas.sandberg@arm.com#include "mem/probes/mem_trace.hh" 4210996Sandreas.sandberg@arm.com 4310996Sandreas.sandberg@arm.com#include "base/callback.hh" 4410996Sandreas.sandberg@arm.com#include "base/output.hh" 4510996Sandreas.sandberg@arm.com#include "params/MemTraceProbe.hh" 4610996Sandreas.sandberg@arm.com#include "proto/packet.pb.h" 4710996Sandreas.sandberg@arm.com 4810996Sandreas.sandberg@arm.comMemTraceProbe::MemTraceProbe(MemTraceProbeParams *p) 4910996Sandreas.sandberg@arm.com : BaseMemProbe(p), 5010996Sandreas.sandberg@arm.com traceStream(nullptr) 5110996Sandreas.sandberg@arm.com{ 5210996Sandreas.sandberg@arm.com std::string filename; 5310996Sandreas.sandberg@arm.com if (p->trace_file != "") { 5410996Sandreas.sandberg@arm.com // If the trace file is not specified as an absolute path, 5510996Sandreas.sandberg@arm.com // append the current simulation output directory 5610996Sandreas.sandberg@arm.com filename = simout.resolve(p->trace_file); 5710996Sandreas.sandberg@arm.com 5810996Sandreas.sandberg@arm.com const std::string suffix = ".gz"; 5910996Sandreas.sandberg@arm.com // If trace_compress has been set, check the suffix. Append 6010996Sandreas.sandberg@arm.com // accordingly. 6110996Sandreas.sandberg@arm.com if (p->trace_compress && 6210996Sandreas.sandberg@arm.com filename.compare(filename.size() - suffix.size(), suffix.size(), 6310996Sandreas.sandberg@arm.com suffix) != 0) 6410996Sandreas.sandberg@arm.com filename = filename + suffix; 6510996Sandreas.sandberg@arm.com } else { 6610996Sandreas.sandberg@arm.com // Generate a filename from the name of the SimObject. Append .trc 6710996Sandreas.sandberg@arm.com // and .gz if we want compression enabled. 6810996Sandreas.sandberg@arm.com filename = simout.resolve(name() + ".trc" + 6910996Sandreas.sandberg@arm.com (p->trace_compress ? ".gz" : "")); 7010996Sandreas.sandberg@arm.com } 7110996Sandreas.sandberg@arm.com 7210996Sandreas.sandberg@arm.com traceStream = new ProtoOutputStream(filename); 7310996Sandreas.sandberg@arm.com 7410996Sandreas.sandberg@arm.com // Create a protobuf message for the header and write it to 7510996Sandreas.sandberg@arm.com // the stream 7610996Sandreas.sandberg@arm.com ProtoMessage::PacketHeader header_msg; 7710996Sandreas.sandberg@arm.com header_msg.set_obj_id(name()); 7810996Sandreas.sandberg@arm.com header_msg.set_tick_freq(SimClock::Frequency); 7910996Sandreas.sandberg@arm.com traceStream->write(header_msg); 8010996Sandreas.sandberg@arm.com 8110996Sandreas.sandberg@arm.com // Register a callback to compensate for the destructor not 8210996Sandreas.sandberg@arm.com // being called. The callback forces the stream to flush and 8310996Sandreas.sandberg@arm.com // closes the output file. 8410996Sandreas.sandberg@arm.com registerExitCallback( 8510996Sandreas.sandberg@arm.com new MakeCallback<MemTraceProbe, &MemTraceProbe::closeStreams>(this)); 8610996Sandreas.sandberg@arm.com} 8710996Sandreas.sandberg@arm.com 8810996Sandreas.sandberg@arm.comvoid 8910996Sandreas.sandberg@arm.comMemTraceProbe::closeStreams() 9010996Sandreas.sandberg@arm.com{ 9110996Sandreas.sandberg@arm.com if (traceStream != NULL) 9210996Sandreas.sandberg@arm.com delete traceStream; 9310996Sandreas.sandberg@arm.com} 9410996Sandreas.sandberg@arm.com 9510996Sandreas.sandberg@arm.comvoid 9610996Sandreas.sandberg@arm.comMemTraceProbe::handleRequest(const PacketPtr &pkt) 9710996Sandreas.sandberg@arm.com{ 9810996Sandreas.sandberg@arm.com ProtoMessage::Packet pkt_msg; 9910996Sandreas.sandberg@arm.com 10010996Sandreas.sandberg@arm.com pkt_msg.set_tick(curTick()); 10110996Sandreas.sandberg@arm.com pkt_msg.set_cmd(pkt->cmdToIndex()); 10210996Sandreas.sandberg@arm.com pkt_msg.set_flags(pkt->req->getFlags()); 10310996Sandreas.sandberg@arm.com pkt_msg.set_addr(pkt->getAddr()); 10410996Sandreas.sandberg@arm.com pkt_msg.set_size(pkt->getSize()); 10510996Sandreas.sandberg@arm.com 10610996Sandreas.sandberg@arm.com traceStream->write(pkt_msg); 10710996Sandreas.sandberg@arm.com} 10810996Sandreas.sandberg@arm.com 10910996Sandreas.sandberg@arm.com 11010996Sandreas.sandberg@arm.comMemTraceProbe * 11110996Sandreas.sandberg@arm.comMemTraceProbeParams::create() 11210996Sandreas.sandberg@arm.com{ 11310996Sandreas.sandberg@arm.com return new MemTraceProbe(this); 11410996Sandreas.sandberg@arm.com} 115