You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
156 lines
4.5 KiB
156 lines
4.5 KiB
/*
|
|
* Copyright 2002-2019 Intel Corporation.
|
|
*
|
|
* This software is provided to you as Sample Source Code as defined in the accompanying
|
|
* End User License Agreement for the Intel(R) Software Development Products ("Agreement")
|
|
* section 1.L.
|
|
*
|
|
* This software and the related documents are provided as is, with no express or implied
|
|
* warranties, other than those that are expressly stated in the License.
|
|
*/
|
|
|
|
/*! @file
|
|
* This file contains an ISA-portable PIN tool for tracing instructions
|
|
*/
|
|
|
|
|
|
|
|
#include "pin.H"
|
|
#include <iostream>
|
|
#include <fstream>
|
|
using std::cerr;
|
|
using std::string;
|
|
using std::endl;
|
|
|
|
/* ===================================================================== */
|
|
/* Global Variables */
|
|
/* ===================================================================== */
|
|
|
|
std::ofstream TraceFile;
|
|
UINT32 count_trace = 0; // current trace number
|
|
|
|
/* ===================================================================== */
|
|
/* Commandline Switches */
|
|
/* ===================================================================== */
|
|
|
|
KNOB<string> KnobOutputFile(KNOB_MODE_WRITEONCE, "pintool",
|
|
"o", "trace.out", "specify trace file name");
|
|
KNOB<BOOL> KnobNoCompress(KNOB_MODE_WRITEONCE, "pintool",
|
|
"no_compress", "0", "Do not compress");
|
|
|
|
/* ===================================================================== */
|
|
/* Print Help Message */
|
|
/* ===================================================================== */
|
|
|
|
INT32 Usage()
|
|
{
|
|
cerr <<
|
|
"This tool produces a compressed (dynamic) instruction trace.\n"
|
|
"The trace is still in textual form but repeated sequences\n"
|
|
"of the same code are abbreviated with a number which dramatically\n"
|
|
"reduces the output size and the overhead of the tool.\n"
|
|
"\n";
|
|
|
|
cerr << KNOB_BASE::StringKnobSummary();
|
|
|
|
cerr << endl;
|
|
|
|
return -1;
|
|
}
|
|
|
|
|
|
/* ===================================================================== */
|
|
|
|
VOID docount(const string *s)
|
|
{
|
|
TraceFile.write(s->c_str(), s->size());
|
|
|
|
}
|
|
|
|
/* ===================================================================== */
|
|
|
|
VOID Trace(TRACE trace, VOID *v)
|
|
{
|
|
for (BBL bbl = TRACE_BblHead(trace); BBL_Valid(bbl); bbl = BBL_Next(bbl))
|
|
{
|
|
string traceString = "";
|
|
|
|
for ( INS ins = BBL_InsHead(bbl); INS_Valid(ins); ins = INS_Next(ins))
|
|
{
|
|
traceString += "%" + INS_Disassemble(ins) + "\n";
|
|
}
|
|
|
|
|
|
// we try to keep the overhead small
|
|
// so we only insert a call where control flow may leave the current trace
|
|
|
|
if (KnobNoCompress)
|
|
{
|
|
INS_InsertCall(BBL_InsTail(bbl), IPOINT_BEFORE, AFUNPTR(docount),
|
|
IARG_PTR, new string(traceString),
|
|
IARG_END);
|
|
}
|
|
else
|
|
{
|
|
// Identify traces with an id
|
|
count_trace++;
|
|
|
|
// Write the actual trace once at instrumentation time
|
|
string m = "@" + decstr(count_trace) + "\n";
|
|
TraceFile.write(m.c_str(), m.size());
|
|
TraceFile.write(traceString.c_str(), traceString.size());
|
|
|
|
|
|
// at run time, just print the id
|
|
string *s = new string(decstr(count_trace) + "\n");
|
|
INS_InsertCall(BBL_InsTail(bbl), IPOINT_BEFORE, AFUNPTR(docount),
|
|
IARG_PTR, s,
|
|
IARG_END);
|
|
}
|
|
}
|
|
}
|
|
|
|
/* ===================================================================== */
|
|
|
|
VOID Fini(INT32 code, VOID *v)
|
|
{
|
|
TraceFile << "# eof" << endl;
|
|
|
|
TraceFile.close();
|
|
}
|
|
|
|
/* ===================================================================== */
|
|
/* Main */
|
|
/* ===================================================================== */
|
|
|
|
int main(int argc, char *argv[])
|
|
{
|
|
string trace_header = string("#\n"
|
|
"# Compressed Instruction Trace Generated By Pin\n"
|
|
"#\n");
|
|
|
|
|
|
if( PIN_Init(argc,argv) )
|
|
{
|
|
return Usage();
|
|
}
|
|
|
|
|
|
TraceFile.open(KnobOutputFile.Value().c_str());
|
|
TraceFile.write(trace_header.c_str(),trace_header.size());
|
|
|
|
|
|
TRACE_AddInstrumentFunction(Trace, 0);
|
|
PIN_AddFiniFunction(Fini, 0);
|
|
|
|
// Never returns
|
|
|
|
PIN_StartProgram();
|
|
|
|
return 0;
|
|
}
|
|
|
|
/* ===================================================================== */
|
|
/* eof */
|
|
/* ===================================================================== */
|