pin ——pin tool代碼註釋 各pin tool的用途

pin tool 各個工具分類及作用：

 insount0                        記錄指令執行的次數

 inscount                        記錄指令執行的次數，與inscount0不同的是，它分BBL塊記錄然後累加

 itrace                              記錄每個指令地址

pinatrace                        記錄指令讀取和寫入的內存地址

imageload                      image載入或卸載時打印一條信息，image指與程序有關的所有數據結構（windows下是dll、exe）

proccount                       記錄routine的數目和一個routine中指令執行的次數

safecopy                         記錄程序從內存中複製信息到寄存器的指令

invocation                       說明和程序都有點曖昧，暫時沒看懂

malloctrace                    輸出malloc()和free()的輸入參數以及malloc()的返回值

下面以malloctrace工具爲例對pintool代碼進行說明：

    前面已經說過，瞭解pintool的自定義函數是看懂其代碼的關鍵，pintool的主函數可分爲三個部分，輸出文件建立部分、程序檢測函數部分和結尾部分（忽略最後一句）。

輸出文件建立部分確定輸出文件的格式和說明內容，程序檢測函數部分調用各函數對可執行程序進行檢測，結尾部分一般爲其自定義的Fini函數,用來做將檢測數據寫入輸出文件、關閉文件等的收尾工作。

    顯然，第二部分是最重要的一部分，從前面聲明的函數可知，

IMG_AddInstrumentFunction函數調用Image函數，Image函數的參數爲要監測的image，若image中含有malloc函數，則RTN_InsertCall函數一次調用Arg1Bfore和MallocAfter函數，這兩個函數實現我們所要的輸出，注意前面定義的寫入文件的函數，這裏是我們想要的輸出，InsertCall函數調用這些寫入函數，瞭解這些規律就很容易看懂這些代碼。

#include "pin.H"
#include <iostream>
#include <fstream>

/* ===================================================================== */
/* Names of malloc and free */
/* ===================================================================== */
#if defined(TARGET_MAC)
#define MALLOC "_malloc"
#define FREE "_free"
#else
#define MALLOC "malloc"
#define FREE "free"
#endif

/* ===================================================================== */
/* Global Variables */
/* ===================================================================== */

std::ofstream TraceFile;

/* ===================================================================== */
/* Commandline Switches */
/* ===================================================================== */

KNOB<string> KnobOutputFile(KNOB_MODE_WRITEONCE, "pintool",
    "o", "malloctrace.out", "specify trace file name");

/* ===================================================================== */
/* Print Help Message                                                    */
/* ===================================================================== */

INT32 Usage()
{
    cerr <<
        "This tool produces a trace of calls to malloc.\n"
        "\n";

    cerr << KNOB_BASE::StringKnobSummary();

    cerr << endl;

    return -1;
}

/* ===================================================================== */

VOID Arg1Before(CHAR * name, ADDRINT size)
{
    TraceFile << name << "(" << size << ")" << endl;
}

/* ===================================================================== */

VOID MallocAfter(ADDRINT ret)
{
    TraceFile << "  returns " << ret << endl;
}

/* ===================================================================== */

VOID Image(IMG img, VOID *v)
{
    RTN mallocRtn = RTN_FindByName(img, MALLOC);
    if (RTN_Valid(mallocRtn))
    {
        RTN_Open(mallocRtn);
        RTN_InsertCall(mallocRtn, IPOINT_BEFORE, (AFUNPTR)Arg1Before, IARG_ADDRINT, MALLOC, IARG_G_ARG0_CALLEE, IARG_END);
        RTN_InsertCall(mallocRtn, IPOINT_AFTER, (AFUNPTR)MallocAfter, IARG_G_RESULT0, IARG_END);
        RTN_Close(mallocRtn);
    }
    
    RTN freeRtn = RTN_FindByName(img, FREE);
    if (RTN_Valid(freeRtn))
    {
        RTN_Open(freeRtn);
        RTN_InsertCall(freeRtn, IPOINT_BEFORE, (AFUNPTR)Arg1Before, IARG_ADDRINT, FREE, IARG_G_ARG0_CALLEE, IARG_END);
        RTN_Close(freeRtn);
    }
}

/* ===================================================================== */

VOID Fini(INT32 code, VOID *v)
{
    TraceFile.close();
}

/* ===================================================================== */
/* Main                                                                  */
/* ===================================================================== */

int main(int argc, char *argv[])
{
    PIN_InitSymbols();

    if( PIN_Init(argc,argv) )
    {
        return Usage();
    }
    

    TraceFile.open(KnobOutputFile.Value().c_str());

    TraceFile << hex;
    TraceFile.setf(ios::showbase);

    cout << hex;
    cout.setf(ios::showbase);
    
    IMG_AddInstrumentFunction(Image, 0);
    PIN_AddFiniFunction(Fini, 0);

    // Never returns
    PIN_StartProgram();
    
    return 0;
}

/* ===================================================================== */
/* eof */
/* ===================================================================== */