text: /*BEGIN_LEGAL 
  Intel Open Source License 
  
  Copyright (c) 2002-2015 Intel Corporation. All rights reserved.
   
  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are
  met:
  
  Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.  Redistributions
  in binary form must reproduce the above copyright notice, this list of
  conditions and the following disclaimer in the documentation and/or
  other materials provided with the distribution.  Neither the name of
  the Intel Corporation nor the names of its contributors may be used to
  endorse or promote products derived from this software without
  specific prior written permission.
   
  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INTEL OR
  ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  END_LEGAL */
  /*
   * Sample buffering tool
   * 
   * This tool collects an address trace, including PC, read/write EA,
   * and read/write size, by filling a buffer.  When the buffer overflows,
   * the callback writes all of the collected records to a file.
   *
   */
  
  #include "pin.H"
  #include <iostream>
  #include <stdio.h>
  #include <stddef.h>
  
  /* Struct for holding memory references.  Rather than having two separate
   * buffers for loads and stores, we just use one struct that includes a
   * flag for type.
   */
  struct MEMREF
  {
      ADDRINT pc;
      ADDRINT address;
      UINT32 size;
      UINT32 load;
  };
  
  FILE *outfile;
  KNOB<string> KnobOutputFile(KNOB_MODE_WRITEONCE, "pintool", "o", "allocate.out", "output file");
  
  BUFFER_ID bufId;
  PIN_LOCK fileLock;
  
  #define NUM_BUF_PAGES 64
  
  /*!
   *  Print out help message.
   */
  INT32 Usage()
  {
      cerr << "This tool demonstrates the basic use of the buffering API." << endl << endl;
  
      return -1;
  }
  
  VOID Trace(TRACE trace, VOID *v){
  
      UINT32 refSize;
             
      for(BBL bbl = TRACE_BblHead(trace); BBL_Valid(bbl); bbl=BBL_Next(bbl)){
          for(INS ins = BBL_InsHead(bbl); INS_Valid(ins); ins=INS_Next(ins)){
              if(INS_IsMemoryRead(ins)){
  
                  refSize = INS_MemoryReadSize(ins);
  
                  INS_InsertFillBuffer(ins, IPOINT_BEFORE, bufId,
                      IARG_INST_PTR, offsetof(struct MEMREF, pc),
                      IARG_MEMORYREAD_EA, offsetof(struct MEMREF, address),
                      IARG_UINT32, refSize, offsetof(struct MEMREF, size),
                      IARG_UINT32, 1, offsetof(struct MEMREF, load),
                      IARG_END);
  
              }
              if(INS_HasMemoryRead2(ins)){
  
                  refSize = INS_MemoryReadSize(ins);
  
                  INS_InsertFillBuffer(ins, IPOINT_BEFORE, bufId,
                      IARG_INST_PTR, offsetof(struct MEMREF, pc),
                      IARG_MEMORYREAD2_EA, offsetof(struct MEMREF, address),
                      IARG_UINT32, refSize, offsetof(struct MEMREF, size),
                      IARG_UINT32, 1, offsetof(struct MEMREF, load),
                      IARG_END);
  
              }
              if(INS_IsMemoryWrite(ins)){
  
                  refSize = INS_MemoryWriteSize(ins);
  
                  INS_InsertFillBuffer(ins, IPOINT_BEFORE, bufId,
                      IARG_INST_PTR, offsetof(struct MEMREF, pc),
                      IARG_MEMORYWRITE_EA, offsetof(struct MEMREF, address),
                      IARG_UINT32, refSize, offsetof(struct MEMREF, size),
                      IARG_UINT32, 0, offsetof(struct MEMREF, load),
                      IARG_END);
              }
          }
      }
  }
  
  /*!
   * Called when a buffer fills up, or the thread exits, so we can process it or pass it off
   * as we see fit.
   * @param[in] id		buffer handle
   * @param[in] tid		id of owning thread
   * @param[in] ctxt		application context when the buffer filled
   * @param[in] buf		actual pointer to buffer
   * @param[in] numElements	number of records
   * @param[in] v			callback value
   * @return  A pointer to the buffer to resume filling.
   */
  VOID * BufferFull(BUFFER_ID id, THREADID tid, const CONTEXT *ctxt, VOID *buf,
                    UINT64 numElements, VOID *v)
  {
      PIN_GetLock(&fileLock, 1);
  
      struct MEMREF* reference=(struct MEMREF*)buf;
      UINT64 i;
  
      for(i=0; i<numElements; i++, reference++){
          fprintf(outfile, "%lx %lx %u %u\n", (unsigned long)reference->pc, (unsigned long)reference->address,
                  reference->size, reference->load);   
      }
      
      fflush(outfile);
      PIN_ReleaseLock(&fileLock);
  
      // Test deallocate and allocate
      VOID * newbuf = PIN_AllocateBuffer(id);
  
      PIN_DeallocateBuffer( id, buf );
  
      return newbuf;
  }
  
  /*!
   * Print out analysis results.
   * This function is called when the application exits.
   * @param[in]   code            exit code of the application
   * @param[in]   v               value specified by the tool in the 
   *                              PIN_AddFiniFunction function call
   */
  VOID Fini(INT32 code, VOID *v)
  {
  
      PIN_GetLock(&fileLock, 1);
      fclose(outfile);
      printf("outfile closed\n");
      PIN_ReleaseLock(&fileLock);
  }
  
  /*!
   * The main procedure of the tool.
   * This function is called when the application image is loaded but not yet started.
   * @param[in]   argc            total number of elements in the argv array
   * @param[in]   argv            array of command line arguments, 
   *                              including pin -t <toolname> -- ...
   */
  int main(int argc, char *argv[])
  {
      // Initialize PIN library. Print help message if -h(elp) is specified
      // in the command line or the command line is invalid 
      if( PIN_Init(argc,argv) )
      {
          return Usage();
      }
      
      // Initialize the memory reference buffer
      bufId = PIN_DefineTraceBuffer(sizeof(struct MEMREF), NUM_BUF_PAGES,
                                    BufferFull, 0);
  
      if(bufId == BUFFER_ID_INVALID){
          cerr << "Error allocating initial buffer" << endl;
          return 1;
      }
  
      outfile = fopen(KnobOutputFile.Value().c_str(), "w");
      if(!outfile){
          cerr << "Couldn't open " << KnobOutputFile.Value() << endl;
          return 1;
      }
  
      PIN_InitLock(&fileLock);
  
      // add an instrumentation function
      TRACE_AddInstrumentFunction(Trace, 0);
      
      // Register function to be called when the application exits
      PIN_AddFiniFunction(Fini, 0);
  
      // Start the program, never returns
      PIN_StartProgram();
      
      return 0;
  }
  
  
  