pintool

이번 포스팅에서는 pintool 사용법 및 예제코드에 대한 간단한 분석을 진행한다.

 

pintool 이란, Intel PIN SDK 를 이용해 개발한 라이브러리이다. PIN 이란 프로그램의 플러그인(?) 이라 생각하면 될 것 같다.

혹여나 설치를 하지 못했다면, http://woosunbi.tistory.com/170 을 참고하기 바란다.

 

기본적인 사용 방법은,

# ./pin -t [ .so 파일] -- [분석하고자 하는 파일]

 

# Instrumentation Granularity

: Pin 의 Instrumentation Granularity 에 따라 4가지 방식으로 Binary Instrumentation(Just in time) 이 가능하다.

 

1. Trace Instrumentation (TRACE_AddInstrumenFunction API 호출)

: Trace 단위로 Instrument 하는 모드이다. Trace 는 일반적으로 Branch 의 Target 에서 시작하여 Call, Return 을 포함하여 무조건 분기에서 끝이 난다.

 

2. Instruction Instrumentation (INS_AddInstrumentFunction API 호출)

: 하나의 Instruction 단위로 Instrument 하는 모드이다.  즉, 모든 명령어 실행 시 호출하는 함수이다.

 

3. Image Instrumentation (IMG_AddInstrumentFunction API 호출)

: 실행 바이너리 또는 공용 라이브러리가 주소 공간에 올라올 때 Instrument 하는 모드이다.

IMG Loading, Unloading 등 이 때 실행되는 함수이다.

 

4. Routine Instrumentation(RTN_AddInstrumentFunction API 호출)

: 특정 함수를 실행함수의 전후로 Instrument 하는 모드이다. 모든 함수 실행과 관련해 호출하는 함수이다.

 

본인이 하고자하는 목적에 맞게 granularity 를 사용해야 한다.!  자칫 심각한 오버헤드를 초래할 수 있다..

 

 

# 예제코드 분석

#include <iostream>
#include <fstream>
#include "pin.H"
 
ofstream OutFile;
 
// The running count of instructions is kept here
// make it static to help the compiler optimize docount
static UINT64 icount = 0;
 
// This function is called before every instruction is executed
VOID docount() { icount++; }
 
// Pin calls this function every time a new instruction is encountered
VOID Instruction(INS ins, VOID *v)
{
    // Insert a call to docount before every instruction, no arguments are passed
    INS_InsertCall(ins, IPOINT_BEFORE, (AFUNPTR)docount, IARG_END);
}
 
KNOB<string> KnobOutputFile(KNOB_MODE_WRITEONCE, "pintool",
    "o", "inscount.out", "specify output file name");
 
// This function is called when the application exits
VOID Fini(INT32 code, VOID *v)
{
    // Write to a file since cout and cerr maybe closed by the application
    OutFile.setf(ios::showbase);
    OutFile << "Count " << icount << endl;
    OutFile.close();
}
 
/* ===================================================================== */
/* Print Help Message                                                    */
/* ===================================================================== */
 
INT32 Usage()
{
    cerr << "This tool counts the number of dynamic instructions executed" << endl;
    cerr << endl << KNOB_BASE::StringKnobSummary() << endl;
    return -1;
}
 
/* ===================================================================== */
/* Main                                                                  */
/* ===================================================================== */
/*   argc, argv are the entire command line: pin -t <toolname> -- ...    */
/* ===================================================================== */
 
int main(int argc, char * argv[])
{
    // Initialize pin
    if (PIN_Init(argc, argv)) return Usage();
 
    OutFile.open(KnobOutputFile.Value().c_str());
 
    // Register Instruction to be called to instrument instructions
    INS_AddInstrumentFunction(Instruction, 0);
 
    // Register Fini to be called when the application exits
    PIN_AddFiniFunction(Fini, 0);
 
    // Start the program, never returns
    PIN_StartProgram();
 
    return 0;
}
 
 

위의 샘플코드는 프로그램 시작부터 종료까지 수행된 명령어의 갯수를 출력한다.

 

먼저, 결과 값을 담아낼 파일을 오픈하고 있다.

그 후 INS_AddInstrumentFunction() 함수를 통해 각각의 Instrcution 마다 콜백함수를 지정한다.

 

VOID Instruction(INS ins, VOID *v)
{
    // Insert a call to docount before every instruction, no arguments are passed
    INS_InsertCall(ins, IPOINT_BEFORE, (AFUNPTR)docount, IARG_END);
}

콜백함수인 Instruction 함수를 살펴보면,

INS_InsertCall() 함수를 호출하는데, IPOINT_BEFORE 인자를 통해 각 Instruction 앞에 docount() 함수를 호출할 것임을 알린다.

결과적으로, 위 함수를 통해 각 Instruction 마다 docount() 호출하고 명령어의 갯수를 icount 변수에 저장한다.

 

마지막으로, PIN_AddFiniFunction() 함수를 사용하여 프로그램이 종료될 때 호출할 함수(Fini)를 지정해준다.

예제코드에서의 Fini() 함수는 오픈한 파일에 결과 값을 담는 역할을 한다.

 

이로써 pintool 의 가장 기본적인(?) 부분에 대해서  간단히 소개한거같다..

이후에는 본인이 원하는 업무나 공부에 활용하기 위한 pintool 을 만들어보는게 좋을 것 같다..