replaced tabs with spaces

Author: Alif Ahmed

MAPProfiler/MAPProfiler.cpp

@@ -28,60 +28,60 @@ using namespace std;
  ******************************************************************************/
 // Name of the function to profile
 KNOB<string> knobFunctionName(KNOB_MODE_WRITEONCE, "pintool", "func", "main",
-		"Function to be profiled.");
+        "Function to be profiled.");
 
 // Max log items per thread
 KNOB<UINT64> knobMaxLog(KNOB_MODE_WRITEONCE, "pintool", "lim", "1000000", 
-		"Max number of read/writes to log per thread.");
+        "Max number of read/writes to log per thread.");
 
 // Output file name
 KNOB<string> knobOutFile(KNOB_MODE_WRITEONCE, "pintool", "out", "mem_trace.csv",
-		"Output file name.");
+        "Output file name.");
 
 // Max threads
 KNOB<UINT64> knobMaxThreads(KNOB_MODE_WRITEONCE, "pintool", "threads", "10000",
-		"Upper limit of the number of threads that can be used by the program \
-		being profiled.");
+        "Upper limit of the number of threads that can be used by the program \
+        being profiled.");
 
 // Stack based access logging (1: enable, 0: disable)
 KNOB<bool> knobStack(KNOB_MODE_WRITEONCE, "pintool", "stack", "0", "Stack based access logging \
-		[1: enable, 0: disable (default)].");
+        [1: enable, 0: disable (default)].");
 
 // Instruction pointer relative access logging (1: enable, 0: disable)
 KNOB<bool> knobIP(KNOB_MODE_WRITEONCE, "pintool", "ip", "1", "IP relative access logging \
-		[1: enable (default), 0: disable].");
+        [1: enable (default), 0: disable].");
 
 // Read logging (1: enable, 0: disable)
 KNOB<bool> knobRead(KNOB_MODE_WRITEONCE, "pintool", "read", "1", "Read logging \
-		[1: enable (default), 0: disable].");
+        [1: enable (default), 0: disable].");
 
 // Write logging (1: enable, 0: disable)
 KNOB<bool> knobWrite(KNOB_MODE_WRITEONCE, "pintool", "write", "1", "Write \
-		logging [1: enable (default), 0: disable].");
+        logging [1: enable (default), 0: disable].");
 
 
 
 /*******************************************************************************
  * Structs
  ******************************************************************************/
-#define LINE_SIZE	64
+#define LINE_SIZE   64
 
 // Structure for keeping thread specific data. Padded to LINE_SIZE for avoiding
 // false sharing.
 typedef struct{
-	// Tracks if the thread is inside the requested functions. Greater than 0
-	// means it is.
+    // Tracks if the thread is inside the requested functions. Greater than 0
+    // means it is.
     UINT64 rtnEntryCnt __attribute((aligned(LINE_SIZE)));
 } ThreadData;
 
 
 // Keeps information for each memory access. Padded to LINE_SIZE for avoiding
 // false sharing.
 typedef struct{
-	// Effective virtual address
+    // Effective virtual address
     ADDRINT ea __attribute((aligned(LINE_SIZE)));
 
-	// Type of access. 'R' for read and 'W' for write.
+    // Type of access. 'R' for read and 'W' for write.
     UINT8 type;
 } MemInfo;
 
@@ -133,23 +133,23 @@ INT32 Usage() {
  * Records a read or write access to 'info' array.
  */
 inline VOID record(THREADID tid, ADDRINT ea, UINT8 type){
-	// First check if thread is inside the function beign profiled.
+    // First check if thread is inside the function beign profiled.
     UINT64 entCnt = tdata[tid].rtnEntryCnt;
     if(entCnt > 0){
-		// Inside the function. Atomically update the array index.
+        // Inside the function. Atomically update the array index.
         UINT64 idx;
         PIN_GetLock(&lock, tid + 1);
         idx = buf_log_cnt++;
         PIN_ReleaseLock(&lock);
 
-		// Check if log limit reached.
+        // Check if log limit reached.
         if(idx < buf_log_lim){
-			// Record entry.
+            // Record entry.
             info[idx].ea = ea;
             info[idx].type = type;
         } else {
-			// Log limit reached. Exit.
-			// Intenally calls FINI function before quitting.
+            // Log limit reached. Exit.
+            // Intenally calls FINI function before quitting.
             PIN_ExitApplication(0);
         }
     }
@@ -176,33 +176,33 @@ VOID RecordMemWrite(THREADID tid, ADDRINT ea) {
  * Instruments instructions having read or write accesses.
  */
 VOID Instruction(INS ins, VOID *v){
-	if(!knobStack.Value()){
-		if(INS_IsStackRead(ins) || INS_IsStackWrite(ins)){
-			return;
-		}
-	}
-
-	if(!knobIP.Value()){
-		if(INS_IsIpRelRead(ins) || INS_IsIpRelWrite(ins)){
-			return;
-		}
-	}
-
-	// Get the memory operand count of the current instruction.
-	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) && read_log_en) {
-			// Operand is read by this instruction.
-	        INS_InsertPredicatedCall(ins, IPOINT_BEFORE, (AFUNPTR)RecordMemRead, IARG_THREAD_ID, IARG_MEMORYOP_EA, memOp, IARG_END);
-	    }
-
-	    else if (INS_MemoryOperandIsWritten(ins, memOp) && write_log_en) {
-			// Operand is written by this instruction.
-	        INS_InsertPredicatedCall(ins, IPOINT_BEFORE, (AFUNPTR)RecordMemWrite, IARG_THREAD_ID, IARG_MEMORYOP_EA, memOp, IARG_END);
-	    }
-	}
+    if(!knobStack.Value()){
+        if(INS_IsStackRead(ins) || INS_IsStackWrite(ins)){
+            return;
+        }
+    }
+
+    if(!knobIP.Value()){
+        if(INS_IsIpRelRead(ins) || INS_IsIpRelWrite(ins)){
+            return;
+        }
+    }
+
+    // Get the memory operand count of the current instruction.
+    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) && read_log_en) {
+            // Operand is read by this instruction.
+            INS_InsertPredicatedCall(ins, IPOINT_BEFORE, (AFUNPTR)RecordMemRead, IARG_THREAD_ID, IARG_MEMORYOP_EA, memOp, IARG_END);
+        }
+
+        else if (INS_MemoryOperandIsWritten(ins, memOp) && write_log_en) {
+            // Operand is written by this instruction.
+            INS_InsertPredicatedCall(ins, IPOINT_BEFORE, (AFUNPTR)RecordMemWrite, IARG_THREAD_ID, IARG_MEMORYOP_EA, memOp, IARG_END);
+        }
+    }
 }
 
 
@@ -229,98 +229,98 @@ VOID ImgCallback(IMG img, VOID* arg){
     if (!IMG_IsMainExecutable(img))
         return;
 
-	int match_count = 0;
-	cout << "Tagging functions with \"" << rtn_name << "\"..." << endl;
+    int match_count = 0;
+    cout << "Tagging functions with \"" << rtn_name << "\"..." << endl;
 
-	//First try for exact match of function
-	for( SEC sec= IMG_SecHead(img); SEC_Valid(sec); sec = SEC_Next(sec)){
+    //First try for exact match of function
+    for( SEC sec= IMG_SecHead(img); SEC_Valid(sec); sec = SEC_Next(sec)){
         if(SEC_Name(sec) == ".text"){
             for(RTN rtn= SEC_RtnHead(sec); RTN_Valid(rtn); rtn = RTN_Next(rtn)){
                 string name = PIN_UndecorateSymbolName(RTN_Name(rtn), UNDECORATION_NAME_ONLY);
-				// add suffix for openmp functions
-				string rtn_name_omp = rtn_name + "._omp_fn.";	
+                // add suffix for openmp functions
+                string rtn_name_omp = rtn_name + "._omp_fn.";   
 
-				// Try exact name match
+                // Try exact name match
                 if((name == rtn_name) || (name.find(rtn_name_omp) != string::npos)){
-					// Match found!
-					match_count++;
-					cout << "    Tagged function \"" << name << "\"" << endl;
+                    // Match found!
+                    match_count++;
+                    cout << "    Tagged function \"" << name << "\"" << endl;
 
-					// Instrument function entry and exit
-					RTN_Open(rtn);
+                    // Instrument function entry and exit
+                    RTN_Open(rtn);
                     RTN_InsertCall(rtn, IPOINT_BEFORE, (AFUNPTR)RtnEntry, IARG_THREAD_ID, IARG_END);
                     RTN_InsertCall(rtn, IPOINT_AFTER, (AFUNPTR)RtnLeave, IARG_THREAD_ID, IARG_END);
-					RTN_Close(rtn);
-				}
+                    RTN_Close(rtn);
+                }
             }
         }
     }
-	if(match_count)	return;
-	
-	//Exact match not found. Try to find a function containing the given function name.
-	cout << "Exact match not found! Tagging all functions containing \"" << rtn_name << "\"..." << endl;
-	for( SEC sec= IMG_SecHead(img); SEC_Valid(sec); sec = SEC_Next(sec)){
+    if(match_count) return;
+    
+    //Exact match not found. Try to find a function containing the given function name.
+    cout << "Exact match not found! Tagging all functions containing \"" << rtn_name << "\"..." << endl;
+    for( SEC sec= IMG_SecHead(img); SEC_Valid(sec); sec = SEC_Next(sec)){
         if(SEC_Name(sec) == ".text"){
             for(RTN rtn= SEC_RtnHead(sec); RTN_Valid(rtn); rtn = RTN_Next(rtn)){
                 string name = PIN_UndecorateSymbolName(RTN_Name(rtn), UNDECORATION_NAME_ONLY);
 
-				// Check if the current routine contains the requested routine name
+                // Check if the current routine contains the requested routine name
                 if(name.find(rtn_name) != string::npos){
-					// Match found!
-					match_count++;
-					cout << "    Tagged function \"" << name << "\"" << endl;
+                    // Match found!
+                    match_count++;
+                    cout << "    Tagged function \"" << name << "\"" << endl;
 
-					// Instrument function entry and exit
-					RTN_Open(rtn);
+                    // Instrument function entry and exit
+                    RTN_Open(rtn);
                     RTN_InsertCall(rtn, IPOINT_BEFORE, (AFUNPTR)RtnEntry, IARG_THREAD_ID, IARG_END);
                     RTN_InsertCall(rtn, IPOINT_AFTER, (AFUNPTR)RtnLeave, IARG_THREAD_ID, IARG_END);
-					RTN_Close(rtn);
-				}
+                    RTN_Close(rtn);
+                }
             }
         }
     }
 
-	//Not found
-	if(!match_count){
-		cout << "Unable to find any function containing \"" << rtn_name << "\"... Quitting..." << endl;
-		PIN_ExitProcess(11);
-	}
+    //Not found
+    if(!match_count){
+        cout << "Unable to find any function containing \"" << rtn_name << "\"... Quitting..." << endl;
+        PIN_ExitProcess(11);
+    }
 }
 
 
 /**
  * This function is called when exiting Pin. Writes the entries into a log file.
  */
 VOID Fini(INT32 code, VOID *v) {
-	// Open log file.
+    // Open log file.
     string out_file = knobOutFile.Value();
     ofstream log(out_file.c_str());
     if(!log.is_open()) {
         cerr << "Cannot open log file:" << out_file << endl;
-    	PIN_ExitProcess(11);
+        PIN_ExitProcess(11);
+    }
+    else{
+        cout << "Writing trace to " << out_file << "... " ;
     }
-	else{
-		cout << "Writing trace to " << out_file << "... " ;
-	}
 
     //Write headers for csv files
     log << "R0_W1,Addr\n";
 
-	// write log
+    // write log
     if(buf_log_cnt > buf_log_lim){
         buf_log_cnt = buf_log_lim;
     }
 
     for(UINT64 i=0; i < buf_log_cnt; i++){
-		log << info[i].type << "," << info[i].ea << "\n";
+        log << info[i].type << "," << info[i].ea << "\n";
     }
 
-	// cleanup tasks
+    // cleanup tasks
     log.close();
     delete [] info;
-	delete [] tdata;
+    delete [] tdata;
 
-	cout << "Done" << endl;
+    cout << "Done" << endl;
 }
 
 
@@ -332,20 +332,20 @@ int main(int argc, char *argv[]) {
         return Usage();
     }
 
-	// Initializations
+    // Initializations
     PIN_InitLock(&lock);
     PIN_InitSymbolsAlt(IFUNC_SYMBOLS);
 
     buf_log_lim = knobMaxLog.Value();
     info = new MemInfo[buf_log_lim];
-	UINT64 max_threads = knobMaxThreads.Value();
-	tdata = new ThreadData[max_threads];
-	for(UINT64 i = 0; i < max_threads; ++i){
-		tdata[i].rtnEntryCnt = 0;
-	}
+    UINT64 max_threads = knobMaxThreads.Value();
+    tdata = new ThreadData[max_threads];
+    for(UINT64 i = 0; i < max_threads; ++i){
+        tdata[i].rtnEntryCnt = 0;
+    }
     rtn_name = knobFunctionName.Value();
-	read_log_en = knobRead.Value();
-	write_log_en = knobWrite.Value();
+    read_log_en = knobRead.Value();
+    write_log_en = knobWrite.Value();
 
     IMG_AddInstrumentFunction(ImgCallback, NULL);
     INS_AddInstrumentFunction(Instruction, NULL);