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.

130 lines
4.0 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.
*/
/*
* This tool is meant to be used with the mt_thread.cpp application. It tests the correctness of PIN_AddDetachFunction.
* We expect to get exactly one detach callback regardless of the number of threads in the application or the number of
* detach requests.
* Also check detach callback was called
*/
#include <cstdio>
#include <cstdlib>
#include <iostream>
#include <fstream>
#include <cassert>
#include "pin.H"
#include "atomic.hpp"
using std::ofstream;
using std::cerr;
using std::string;
using std::endl;
KNOB<string> KnobOutFile(KNOB_MODE_WRITEONCE, "pintool",
"o", "jit_instr_detach.out", "Specify file name for the tool's output.");
ofstream outfile;
volatile UINT32 instrumentedInstructions = 0; // the number of instructions that were instrumented.
volatile UINT32 runtimeCount = 0; // the number of executed instructions until detaching.
INT32 threadCounter = 0;
PIN_LOCK pinLock;
volatile bool detached = false;
VOID docount()
{
ASSERT(!detached, "Analysis function was called after detach ended");
ATOMIC::OPS::Increment<UINT32>(&runtimeCount, (UINT32)1); // the instrumented application may be multi-threaded
}
VOID Instruction(INS ins, VOID *v)
{
ASSERT(!detached, "Callback function was called after detach ended");
++instrumentedInstructions;
if (threadCounter >= 2)
{
OS_THREAD_ID tid = PIN_GetTid();
outfile << "Thread " << tid << " is requesting detach." << endl;
PIN_Detach();
}
INS_InsertCall(ins, IPOINT_BEFORE, (AFUNPTR)docount, IARG_END);
}
VOID Detach(VOID *v)
{
if (detached) // sanity check
{
// This should never be reached because only one detach request should be executed.
cerr << "TOOL ERROR: jit_instr_detach is executing the Detach callback twice." << endl;
exit(20); // use exit instead of PIN_ExitProcess because we don't know if it is available at this point.
}
detached = true;
outfile << "Pin detached after " << instrumentedInstructions << " instrumented instructions." << endl;
outfile << "Pin detached after " << runtimeCount << " executed instructions." << endl;
outfile.close();
}
VOID ThreadStart(THREADID threadid, CONTEXT *ctxt, INT32 flags, VOID *v)
{
ASSERT(!detached, "Callback function was called after detach ended");
OS_THREAD_ID tid = PIN_GetTid();
PIN_GetLock(&pinLock, tid);
outfile << "Thread " << tid << " has started." << endl;
++threadCounter;
PIN_ReleaseLock(&pinLock);
}
VOID ThreadEnd(THREADID threadid, const CONTEXT *ctxt, INT32 code, VOID *v)
{
if (detached) // sanity check
{
// This should never be reached because the detach callback is called after all thread fini callbacks.
cerr << "TOOL ERROR: jit_instr_detach - executing thread fini callback after detach." << endl;
exit(30); // use exit instead of PIN_ExitProcess because we don't know if it is available at this point.
}
OS_THREAD_ID tid = PIN_GetTid();
PIN_GetLock(&pinLock, tid);
outfile << "Thread " << tid << " has ended." << endl;
assert(threadCounter > 0);
--threadCounter;
PIN_ReleaseLock(&pinLock);
}
int main(int argc, char * argv[])
{
PIN_Init(argc, argv);
outfile.open(KnobOutFile.Value().c_str());
if (!outfile.is_open() || outfile.fail())
{
cerr << "Failed to open output file " << KnobOutFile.Value().c_str() << "." << endl;
PIN_ExitProcess(10);
}
PIN_InitLock(&pinLock);
INS_AddInstrumentFunction(Instruction, 0);
PIN_AddThreadStartFunction(ThreadStart, 0);
PIN_AddThreadFiniFunction(ThreadEnd, 0);
PIN_AddDetachFunction(Detach, 0);
// Never returns
PIN_StartProgram();
return 0;
}