Release v1.0

Author: Alif Ahmed

MAPProfiler/MAPProfiler.cpp

@@ -43,13 +43,21 @@ 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.");
 
+// 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)].");
+
+// 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].");
+
 // Read logging (1: enable, 0: disable)
 KNOB<bool> knobRead(KNOB_MODE_WRITEONCE, "pintool", "read", "1", "Read logging \
-		(1: enable, 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, 0: disable).");
+		logging [1: enable (default), 0: disable].");
 
 
 
@@ -107,7 +115,6 @@ bool read_log_en = true;
 bool write_log_en = true;
 
 
-
 /*******************************************************************************
  * Functions
  ******************************************************************************/
@@ -169,8 +176,16 @@ VOID RecordMemWrite(THREADID tid, ADDRINT ea) {
  * Instruments instructions having read or write accesses.
  */
 VOID Instruction(INS ins, VOID *v){
-	if(INS_IsStackRead(ins) || INS_IsStackWrite(ins)){
-		return;
+	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.

MAPProfiler/README

@@ -37,20 +37,18 @@ IV. Usage
   ------------------------------------------------
     logger.py is a wrapper which invokes appropriate pin tool command.
 
-	~$ ./logger.py [-h] [--version] [--pin-bin <path-to-pin-binary>]
-                 [--read {0,1}] [--write {0,1}] [--trace-file <trace-file>]
+	~$ logger.py [-h] [--version] [--pin-bin <path-to-pin-binary>]
+                 [--read {0,1}] [--write {0,1}] [--stack-log {0,1}]
+                 [--ip-log {0,1}] [--trace-file <trace-file>]
                  [--trace-limit <limit>] [--max-threads <limit>]
                  [--func <func-to-trace>]
-                 <cmd> ...
-
-    Help on the arguments is shown by -h or --help option.
+                 <cmd>
 
 	positional arguments:
 	  <cmd>                 Command for running the program being profiled.
-	  ...
 
 	optional arguments:
-	  -h, --help            show this help message and exit
+	  -h, --help            show help message and exit
 	  --version             show program's version number and exit
 	  --pin-bin <path-to-pin-binary>
 		                    Path to Intel Pin binary. If not given, derives from
@@ -61,6 +59,10 @@ IV. Usage
 		                    enabled (defalut).
 	  --write {0,1}         Controls write operation tracing. 0: disabled, 1:
 		                    enabled (defalut).
+	  --stack-log {0,1}     Controls stack based access logging. 0: disabled
+		                    (default), 1: enabled.
+	  --ip-log {0,1}        Controls instruction pointer relative access logging.
+		                    0: disabled, 1: enabled (default).
 	  --trace-file <trace-file>
 		                    Memory trace will be written to this file by Pin. The
 		                    file is in simple human readable csv format. (default:
@@ -75,6 +77,7 @@ IV. Usage
 		                    Function to trace. Fully qualified name should be used
 		                    for C++ functions. (default: main)
 
+
   Sample command (after building example/openmp):
     ~$ ./logger.py examples/openmp/omp
 
@@ -130,8 +133,3 @@ IV. Usage
   This will open an interactive plot of the access pattern logged by mem_trace.csv.
 
 
-Copyright (c) 2019, University of Virginia
-All rights reserved.
-
-
-

MAPProfiler/examples/Makefile

@@ -0,0 +1,15 @@
+###############################################################################
+#
+# Top level makefile. Forwards $(MAKE) calls to $(SUBDIRS) subdirectories.
+#
+# Author: 	Alif Ahmed
+# email: 	alifahmed@virginia.edu
+# Updated: 	Aug 06, 2019
+#
+###############################################################################
+
+SUBDIRS = gather openmp rand scatter scatter_gather select_func seq
+
+include makedir.mk
+
+

MAPProfiler/examples/README

@@ -1,13 +1,35 @@
 Examples showcasing MAPProfiler usage.
 
+Build instructions
+==================
+
+	a) To build all examples, run 'make' from the current (examples) directory. e.g.,
+		$ make
+	b) To build a specific example, run 'make <example_name>' from the current directory. e.g.,
+		$ make scatter
+	c) Each example have their own makefile, which can also be uesd to build. e.g.,
+		$ cd scatter
+		$ make
+	d) To clean all examples, run 'clean' from the current directory. e.g.,
+		$ make clean
+	e) To clean a specific example, run 'make <example_name>.clean'. e.g.,
+		$ make scatter.clean
+	f) Another way of cleaning specific examples:
+		$ cd scatter
+		$ make clean
+
+
+Included examples
+=================
+
 1. openmp: 
    Multithreaded (with OpenMp) sequential read, write and read-modify-write operations.
 
 2. seq:
-   Single threaded sequential read, write and read-modify-write operations.
+   Single-threaded sequential read, write and read-modify-write operations.
 
 3. rand:
-   Single threaded rendom and sequential read, write and read-modify-write operations.
+   Single-threaded random and sequential read, write and read-modify-write operations.
 
 4. select_func:
    Example showing function selection.
@@ -19,4 +41,4 @@ Examples showcasing MAPProfiler usage.
    Scatter operation. Sequential read, random write.
 
 7. scatter_gather:
-   Scatter_gather operation. Sequential + random read, random write.
+   Scatter-gather operation. Sequential + random read, random write.

MAPProfiler/examples/gather/Makefile

@@ -1,9 +1,11 @@
 .PHONY: all clean
 
-all: gather
+TARGET=gather
 
-gather: gather.c
-	gcc -g -O0 gather.c -o gather
+all: $(TARGET)
+
+$(TARGET): $(TARGET).c
+	gcc -g -O0 $(TARGET).c -o $(TARGET)
 
 clean:
-	rm -rf gather
+	rm -rf $(TARGET)

MAPProfiler/examples/makedir.mk

@@ -0,0 +1,26 @@
+###############################################################################
+#
+# Makefile helper. Forward $(MAKE) calls to the subdirectories specified by
+# $(SUBDIRS). This file is included by the top level makefiles.
+#
+# Author: 	Alif Ahmed
+# email: 	alifahmed@virginia.edu
+# Updated: 	Aug 06, 2019
+#
+###############################################################################
+
+CLEAN_DIRS = $(addsuffix .clean,$(SUBDIRS))
+
+.PHONY: all clean $(SUBDIRS) $(CLEAN_DIRS)
+
+all: $(SUBDIRS)
+
+clean: $(CLEAN_DIRS)
+
+$(SUBDIRS):
+	@$(MAKE) -C $@ --no-print-directory
+
+$(CLEAN_DIRS): %.clean :
+	@$(MAKE) -C $* --no-print-directory clean
+
+

MAPProfiler/examples/openmp/Makefile

@@ -1,9 +1,11 @@
 .PHONY: all clean
 
-all: omp
+TARGET=omp
 
-omp: omp.c
-	gcc -g -O3 omp.c -o omp -fopenmp
+all: $(TARGET)
+
+$(TARGET): $(TARGET).c
+	gcc -g -O0 $(TARGET).c -o $(TARGET) -fopenmp
 
 clean:
-	rm -rf omp
+	rm -rf $(TARGET)

MAPProfiler/examples/rand/Makefile

@@ -1,9 +1,11 @@
 .PHONY: all clean
 
-all: rand
+TARGET=rand
 
-rand: rand.c
-	gcc -g -O0 rand.c -o rand
+all: $(TARGET)
+
+$(TARGET): $(TARGET).c
+	gcc -g -O0 $(TARGET).c -o $(TARGET)
 
 clean:
-	rm -rf rand
+	rm -rf $(TARGET)

MAPProfiler/examples/scatter/Makefile

@@ -1,9 +1,11 @@
 .PHONY: all clean
 
-all: scatter
+TARGET=scatter
 
-scatter: scatter.c
-	gcc -g -O0 scatter.c -o scatter
+all: $(TARGET)
+
+$(TARGET): $(TARGET).c
+	gcc -g -O0 $(TARGET).c -o $(TARGET)
 
 clean:
-	rm -rf scatter
+	rm -rf $(TARGET)

MAPProfiler/examples/scatter_gather/Makefile

@@ -1,9 +1,11 @@
 .PHONY: all clean
 
-all: scatter_gather
+TARGET=scatter_gather
 
-scatter_gather: scatter_gather.c
-	gcc -g -O0 scatter_gather.c -o scatter_gather
+all: $(TARGET)
+
+$(TARGET): $(TARGET).c
+	gcc -g -O0 $(TARGET).c -o $(TARGET)
 
 clean:
-	rm -rf scatter_gather
+	rm -rf $(TARGET)