CODEWITHSUNDEEP
c++instrumentationintel-pin
aGGeRReS
aGGeRReS

Reputation: 79

Using IARG_MEMORYWRITE_SIZE and IARG_MEMORYREAD_SIZE parameter in Intel Pin

I am trying to use Intel Pin for investigating memory activity of an executable. I want to modify pinatrace example from Pin kit. I tried to use IARG_MEMORYWRITE_SIZE/IARG_MEMORYREAD_SIZE parameters. Here is the source code.

#include <stdio.h>
#include <chrono>
#include "pin.H"
#include <string> 
using std::chrono::nanoseconds;

FILE * trace;
auto start=std::chrono::high_resolution_clock::now();

std::string buffer;
// Print a memory read record
VOID RecordMemRead(VOID * ip, VOID * addr,VOID * size)
{
    auto elapsed = (std::chrono::high_resolution_clock::now()) - start;
    nanoseconds ns= std::chrono::duration_cast<std::chrono::nanoseconds>(elapsed);

//sprintf(buffer,trace,"%p: R %p Time,ns %lld \n", ip, addr,ns);

    //std::string fout = fout + std::to_string("%p: R %p Time,ns %lld \n", ip, addr,ns);

    fprintf(trace,"%p: R,bytes %p Size,bytes %lld \n", ip, addr,size);
}

// Print a memory write record
VOID RecordMemWrite(VOID * ip, VOID * addr, VOID * size)
{
    auto elapsed = (std::chrono::high_resolution_clock::now()) - start;
    nanoseconds ns= std::chrono::duration_cast<std::chrono::nanoseconds>(elapsed);

    fprintf(trace,"%p: W,bytes %p Size,bytes %lld \n", ip, addr,size);
}

// Is called for every instruction and instruments reads and writes
VOID Instruction(INS ins, VOID *v)
{
    // Instruments memory accesses using a predicated call, i.e.
    // the instrumentation is called iff the instruction will actually be executed.
    //
    // On the IA-32 and Intel(R) 64 architectures conditional moves and REP 
    // prefixed instructions appear as predicated instructions in Pin.
    UINT32 memOperands = INS_MemoryOperandCount(ins);

    // Iterate over each memory operand of the instruction.
    for (UINT32 memOp = 0; memOp < memOperands; memOp++)
    {
        if (INS_MemoryOperandIsRead(ins, memOp))
        {
            INS_InsertCall(
            //INS_InsertIfCall(
            ins, IPOINT_BEFORE, (AFUNPTR)RecordMemRead,
                IARG_INST_PTR,
                IARG_MEMORYOP_EA,
                IARG_MEMORYREAD_SIZE, memOp,
                IARG_END);
        }
        // Note that in some architectures a single memory operand can be 
        // both read and written (for instance incl (%eax) on IA-32)
        // In that case we instrument it once for read and once for write.
        //IARG_MEMORYREAD_SIZE  Type: UINT32. Size in bytes of memory read.
        //IARG_MEMORYOP_EA
        //IARG_MEMORYWRITE_SIZE     Type: UINT32. Size in bytes of memory write. 
        if (INS_MemoryOperandIsWritten(ins, memOp))
        {
            INS_InsertCall(
           //INS_InsertPredicatedCall(
                ins, IPOINT_BEFORE, (AFUNPTR)RecordMemWrite,
                IARG_INST_PTR,
                IARG_MEMORYOP_EA,
                IARG_MEMORYWRITE_SIZE, memOp,
                IARG_END);
        }
    }
}

VOID Fini(INT32 code, VOID *v)
{
    fprintf(trace, "#eof\n");
    fclose(trace);
}

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

INT32 Usage()
{
    PIN_ERROR( "This Pintool prints a trace of memory addresses\n" 
              + KNOB_BASE::StringKnobSummary() + "\n");
    return -1;
}

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


int main(int argc, char *argv[])
{
    if (PIN_Init(argc, argv)) return Usage();

    trace = fopen("pinatrace2.out", "w");

    start = std::chrono::high_resolution_clock::now();

    INS_AddInstrumentFunction(Instruction, 0);
    PIN_AddFiniFunction(Fini, 0);

    // Never returns
    PIN_StartProgram();

    return 0;
}

After compilation I am trying to run it, but receiving this error. If I remove this arguments and edit RecordMemWrite/RecordMemRead functions - everything works perfectly.

>..\..\..\..\ia32\bin\pin.exe -t MyPinTool -- cmd /C dir
A: Source\pin\vm\iarglist.cpp: LEVEL_VM::IARGLIST_CLASS::AddArgumentsAndParams: 330: IARG_INVALID seen
NO STACK TRACE AVAILABLE
Detach Service Count: 1
Pin 2.14
Copyright (c) 2003-2015, Intel Corporation. All rights reserved.
@CHARM-VERSION: $Rev: 71293 $
@CHARM-BUILDER: BUILDER
@CHARM-COMPILER: MS-cl 1700
@CHARM-TARGET: ia32
@CHARM-CFLAGS:  __OPTIMIZE__=__OPTIMIZE__  __NO_INLINE__=__NO_INLINE__

Does anybody have any idea about what am I doing wrong?

Upvotes: 0

Views: 990

Answers (1)

Neitsa
Neitsa

Reputation: 8166

You made an error with IARG_ operands.

  • IARG_MEMORYOP_EA require an additional argument
  • IARG_MEMORYREAD_SIZE and IARG_MEMORYWRITE_SIZE do not require an additional argument

From Intel PIN documentation:

IARG_MEMORYOP_EA Type: ADDRINT. Effective address of a memory op (memory op index is next arg); only valid at IPOINT_BEFORE

For the above IARG it is clearly stated that "memory op index" is the next argument.

IARG_MEMORYREAD_SIZE Type: UINT32. Size in bytes of memory read IARG_MEMORYWRITE_SIZE Type: UINT32. Size in bytes of memory write.

The documentation doesn't state something is required after ARG_MEMORYxxx_SIZE (it just indicates what your receive in your callback).

Fixed code (do the same for the other call):

        INS_InsertCall(
        //INS_InsertIfCall(
        ins, IPOINT_BEFORE, (AFUNPTR)RecordMemRead,
            IARG_INST_PTR,
            IARG_MEMORYOP_EA, memop, // memory op index required
            IARG_MEMORYREAD_SIZE, // no arg
            IARG_END);

Upvotes: 4

Related Questions