110695SAli.Saidi@ARM.com/* 210695SAli.Saidi@ARM.com * Copyright (c) 2014 ARM Limited 310695SAli.Saidi@ARM.com * All rights reserved 410695SAli.Saidi@ARM.com * 510695SAli.Saidi@ARM.com * The license below extends only to copyright in the software and shall 610695SAli.Saidi@ARM.com * not be construed as granting a license to any other intellectual 710695SAli.Saidi@ARM.com * property including but not limited to intellectual property relating 810695SAli.Saidi@ARM.com * to a hardware implementation of the functionality of the software 910695SAli.Saidi@ARM.com * licensed hereunder. You may use the software subject to the license 1010695SAli.Saidi@ARM.com * terms below provided that you ensure that this notice is replicated 1110695SAli.Saidi@ARM.com * unmodified and in its entirety in all distributions of the software, 1210695SAli.Saidi@ARM.com * modified or unmodified, in source code or in binary form. 1310695SAli.Saidi@ARM.com * 1410695SAli.Saidi@ARM.com * Redistribution and use in source and binary forms, with or without 1510695SAli.Saidi@ARM.com * modification, are permitted provided that the following conditions are 1610695SAli.Saidi@ARM.com * met: redistributions of source code must retain the above copyright 1710695SAli.Saidi@ARM.com * notice, this list of conditions and the following disclaimer; 1810695SAli.Saidi@ARM.com * redistributions in binary form must reproduce the above copyright 1910695SAli.Saidi@ARM.com * notice, this list of conditions and the following disclaimer in the 2010695SAli.Saidi@ARM.com * documentation and/or other materials provided with the distribution; 2110695SAli.Saidi@ARM.com * neither the name of the copyright holders nor the names of its 2210695SAli.Saidi@ARM.com * contributors may be used to endorse or promote products derived from 2310695SAli.Saidi@ARM.com * this software without specific prior written permission. 2410695SAli.Saidi@ARM.com * 2510695SAli.Saidi@ARM.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2610695SAli.Saidi@ARM.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2710695SAli.Saidi@ARM.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2810695SAli.Saidi@ARM.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2910695SAli.Saidi@ARM.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3010695SAli.Saidi@ARM.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3110695SAli.Saidi@ARM.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3210695SAli.Saidi@ARM.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3310695SAli.Saidi@ARM.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3410695SAli.Saidi@ARM.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3510695SAli.Saidi@ARM.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3610695SAli.Saidi@ARM.com * 3710695SAli.Saidi@ARM.com * Authors: Ali Saidi 3810695SAli.Saidi@ARM.com */ 3910695SAli.Saidi@ARM.com 4010695SAli.Saidi@ARM.com#include "cpu/inst_pb_trace.hh" 4110695SAli.Saidi@ARM.com 4210695SAli.Saidi@ARM.com#include "base/callback.hh" 4310695SAli.Saidi@ARM.com#include "base/output.hh" 4410695SAli.Saidi@ARM.com#include "config/the_isa.hh" 4510695SAli.Saidi@ARM.com#include "cpu/static_inst.hh" 4610695SAli.Saidi@ARM.com#include "cpu/thread_context.hh" 4710695SAli.Saidi@ARM.com#include "debug/ExecEnable.hh" 4810695SAli.Saidi@ARM.com#include "params/InstPBTrace.hh" 4910695SAli.Saidi@ARM.com#include "proto/inst.pb.h" 5010695SAli.Saidi@ARM.com#include "sim/core.hh" 5110695SAli.Saidi@ARM.com 5210695SAli.Saidi@ARM.comnamespace Trace { 5310695SAli.Saidi@ARM.com 5410695SAli.Saidi@ARM.comProtoOutputStream *InstPBTrace::traceStream; 5510695SAli.Saidi@ARM.com 5610695SAli.Saidi@ARM.comvoid 5710695SAli.Saidi@ARM.comInstPBTraceRecord::dump() 5810695SAli.Saidi@ARM.com{ 5910695SAli.Saidi@ARM.com // We're trying to build an instruction trace so we just want macro-ops and 6010695SAli.Saidi@ARM.com // instructions that aren't macro-oped 6110695SAli.Saidi@ARM.com if ((macroStaticInst && staticInst->isFirstMicroop()) || 6210695SAli.Saidi@ARM.com !staticInst->isMicroop()) { 6310695SAli.Saidi@ARM.com tracer.traceInst(thread, staticInst, pc); 6410695SAli.Saidi@ARM.com } 6510695SAli.Saidi@ARM.com 6610695SAli.Saidi@ARM.com // If this instruction accessed memory lets record it 6710695SAli.Saidi@ARM.com if (getMemValid()) 6810695SAli.Saidi@ARM.com tracer.traceMem(staticInst, getAddr(), getSize(), getFlags()); 6910695SAli.Saidi@ARM.com} 7010695SAli.Saidi@ARM.com 7110695SAli.Saidi@ARM.comInstPBTrace::InstPBTrace(const InstPBTraceParams *p) 7212615Sgabeblack@google.com : InstTracer(p), buf(nullptr), bufSize(0), curMsg(nullptr) 7310695SAli.Saidi@ARM.com{ 7410695SAli.Saidi@ARM.com // Create our output file 7510695SAli.Saidi@ARM.com createTraceFile(p->file_name); 7610695SAli.Saidi@ARM.com} 7710695SAli.Saidi@ARM.com 7810695SAli.Saidi@ARM.comvoid 7910695SAli.Saidi@ARM.comInstPBTrace::createTraceFile(std::string filename) 8010695SAli.Saidi@ARM.com{ 8110695SAli.Saidi@ARM.com // Since there is only one output file for all tracers check if it exists 8210695SAli.Saidi@ARM.com if (traceStream) 8310695SAli.Saidi@ARM.com return; 8410695SAli.Saidi@ARM.com 8510695SAli.Saidi@ARM.com traceStream = new ProtoOutputStream(simout.resolve(filename)); 8610695SAli.Saidi@ARM.com 8710695SAli.Saidi@ARM.com // Output the header 8810695SAli.Saidi@ARM.com ProtoMessage::InstHeader header_msg; 8910695SAli.Saidi@ARM.com header_msg.set_obj_id("gem5 generated instruction trace"); 9010695SAli.Saidi@ARM.com header_msg.set_ver(0); 9110695SAli.Saidi@ARM.com header_msg.set_tick_freq(SimClock::Frequency); 9210695SAli.Saidi@ARM.com header_msg.set_has_mem(true); 9310695SAli.Saidi@ARM.com traceStream->write(header_msg); 9410695SAli.Saidi@ARM.com 9510695SAli.Saidi@ARM.com // get a callback when we exit so we can close the file 9610695SAli.Saidi@ARM.com Callback *cb = new MakeCallback<InstPBTrace, 9710695SAli.Saidi@ARM.com &InstPBTrace::closeStreams>(this); 9810695SAli.Saidi@ARM.com registerExitCallback(cb); 9910695SAli.Saidi@ARM.com} 10010695SAli.Saidi@ARM.com 10110695SAli.Saidi@ARM.comvoid 10210695SAli.Saidi@ARM.comInstPBTrace::closeStreams() 10310695SAli.Saidi@ARM.com{ 10410695SAli.Saidi@ARM.com if (curMsg) { 10510695SAli.Saidi@ARM.com traceStream->write(*curMsg); 10610695SAli.Saidi@ARM.com delete curMsg; 10710695SAli.Saidi@ARM.com curMsg = NULL; 10810695SAli.Saidi@ARM.com } 10910695SAli.Saidi@ARM.com 11010695SAli.Saidi@ARM.com if (!traceStream) 11110695SAli.Saidi@ARM.com return; 11210695SAli.Saidi@ARM.com 11310695SAli.Saidi@ARM.com delete traceStream; 11410695SAli.Saidi@ARM.com traceStream = NULL; 11510695SAli.Saidi@ARM.com} 11610695SAli.Saidi@ARM.com 11710695SAli.Saidi@ARM.comInstPBTrace::~InstPBTrace() 11810695SAli.Saidi@ARM.com{ 11910695SAli.Saidi@ARM.com closeStreams(); 12010695SAli.Saidi@ARM.com} 12110695SAli.Saidi@ARM.com 12210695SAli.Saidi@ARM.comInstPBTraceRecord* 12310695SAli.Saidi@ARM.comInstPBTrace::getInstRecord(Tick when, ThreadContext *tc, const StaticInstPtr si, 12410695SAli.Saidi@ARM.com TheISA::PCState pc, const StaticInstPtr mi) 12510695SAli.Saidi@ARM.com{ 12611153SCurtis.Dunham@arm.com // Only record the trace if Exec debugging is enabled 12711153SCurtis.Dunham@arm.com if (!Debug::ExecEnable) 12810695SAli.Saidi@ARM.com return NULL; 12910695SAli.Saidi@ARM.com 13010695SAli.Saidi@ARM.com return new InstPBTraceRecord(*this, when, tc, si, pc, mi); 13110695SAli.Saidi@ARM.com 13210695SAli.Saidi@ARM.com} 13310695SAli.Saidi@ARM.com 13410695SAli.Saidi@ARM.comvoid 13510695SAli.Saidi@ARM.comInstPBTrace::traceInst(ThreadContext *tc, StaticInstPtr si, TheISA::PCState pc) 13610695SAli.Saidi@ARM.com{ 13710695SAli.Saidi@ARM.com if (curMsg) { 13810695SAli.Saidi@ARM.com /// @todo if we are running multi-threaded I assume we'd need a lock here 13910695SAli.Saidi@ARM.com traceStream->write(*curMsg); 14010695SAli.Saidi@ARM.com delete curMsg; 14110695SAli.Saidi@ARM.com curMsg = NULL; 14210695SAli.Saidi@ARM.com } 14310695SAli.Saidi@ARM.com 14412615Sgabeblack@google.com size_t instSize = si->asBytes(buf.get(), bufSize); 14512615Sgabeblack@google.com if (instSize > bufSize) { 14612615Sgabeblack@google.com bufSize = instSize; 14712615Sgabeblack@google.com buf.reset(new uint8_t[bufSize]); 14812615Sgabeblack@google.com instSize = si->asBytes(buf.get(), bufSize); 14912615Sgabeblack@google.com } 15012615Sgabeblack@google.com 15110695SAli.Saidi@ARM.com // Create a new instruction message and fill out the fields 15210695SAli.Saidi@ARM.com curMsg = new ProtoMessage::Inst; 15310695SAli.Saidi@ARM.com curMsg->set_pc(pc.pc()); 15412615Sgabeblack@google.com if (instSize == sizeof(uint32_t)) { 15512615Sgabeblack@google.com curMsg->set_inst(letoh(*reinterpret_cast<uint32_t *>(buf.get()))); 15612615Sgabeblack@google.com } else if (instSize) { 15712615Sgabeblack@google.com curMsg->set_inst_bytes( 15812615Sgabeblack@google.com std::string(reinterpret_cast<const char *>(buf.get()), bufSize)); 15912615Sgabeblack@google.com } 16010695SAli.Saidi@ARM.com curMsg->set_cpuid(tc->cpuId()); 16110695SAli.Saidi@ARM.com curMsg->set_tick(curTick()); 16210695SAli.Saidi@ARM.com curMsg->set_type(static_cast<ProtoMessage::Inst_InstType>(si->opClass())); 16310695SAli.Saidi@ARM.com} 16410695SAli.Saidi@ARM.com 16510695SAli.Saidi@ARM.comvoid 16610695SAli.Saidi@ARM.comInstPBTrace::traceMem(StaticInstPtr si, Addr a, Addr s, unsigned f) 16710695SAli.Saidi@ARM.com{ 16810695SAli.Saidi@ARM.com panic_if(!curMsg, "Memory access w/o msg?!"); 16910695SAli.Saidi@ARM.com 17010695SAli.Saidi@ARM.com // We do a poor job identifying macro-ops that are load/stores 17110695SAli.Saidi@ARM.com curMsg->set_type(static_cast<ProtoMessage::Inst_InstType>(si->opClass())); 17210695SAli.Saidi@ARM.com 17310695SAli.Saidi@ARM.com ProtoMessage::Inst::MemAccess *mem_msg = curMsg->add_mem_access(); 17410695SAli.Saidi@ARM.com mem_msg->set_addr(a); 17510695SAli.Saidi@ARM.com mem_msg->set_size(s); 17610695SAli.Saidi@ARM.com mem_msg->set_mem_flags(f); 17710695SAli.Saidi@ARM.com 17810695SAli.Saidi@ARM.com} 17910695SAli.Saidi@ARM.com 18010695SAli.Saidi@ARM.com} // namespace Trace 18110695SAli.Saidi@ARM.com 18210695SAli.Saidi@ARM.com 18310695SAli.Saidi@ARM.comTrace::InstPBTrace* 18410695SAli.Saidi@ARM.comInstPBTraceParams::create() 18510695SAli.Saidi@ARM.com{ 18610695SAli.Saidi@ARM.com return new Trace::InstPBTrace(this); 18710695SAli.Saidi@ARM.com} 18810695SAli.Saidi@ARM.com 189