Minor improvements intended to make profiling magma easier.

Author: ladar

.cproject

@@ -22,34 +22,46 @@ res/sql/Hostname.sql
 /lib/objects/
 /lib/sources/
 
+# Bundled Dependency Test Tool
+/lib/check/magma.open.check
+
 # Compiled Binaries
 /magmad
-/stripped-magmad
 /magmad.so
-/stripped-magmad.so
 /magmad.check
+
+# Stripped Binaries
+/magmad.stripped
+/magmad.so.stripped
+/magmad.check.stripped
+
+# Crypto Tools
 /dime
 /signet
 /genrec
 /dime.check
-/lib/check/magma.open.check
 
 # Tool Compiler Artifacts and Binaries
-dev/tools/pwtool/pwtool
-dev/tools/runner/runner
-dev/tools/testde/testde
-dev/tools/lockdown/lockdown
-dev/tools/shabench/shabench
-
+/dev/tools/pwtool/pwtool
+/dev/tools/runner/runner
+/dev/tools/testde/testde
+/dev/tools/lockdown/lockdown
+/dev/tools/shabench/shabench
 
 # Profiler Artifacts and Binaries
 /gmon.out
+/callgrind.out
+/massif.out.*
+/cachegrind.out.*
+/magmad.pprof.out
+/magmad.gprof.out.*
+/magmad.check.pprof.out
+/magmad.check.gprof.out.*
+
 /magmad.gprof
 /magmad.gprof.so
 /magmad.check.gprof
 
 /magmad.pprof
-/magmad.pprof.out
 /magmad.check.pprof
-/magmad.check.pprof.out
 

.gitignore

@@ -27,6 +27,10 @@ MAGMA_CHECK_PROGRAM_GPROF		= $(addsuffix $(EXEEXT), magmad.check.gprof)
 MAGMA_PROGRAM_PPROF				= $(addsuffix $(EXEEXT), magmad.pprof)
 MAGMA_CHECK_PROGRAM_PPROF		= $(addsuffix $(EXEEXT), magmad.check.pprof)
 
+MAGMA_PROGRAM_STRIPPED				= $(addsuffix .stripped, $(MAGMA_PROGRAM))
+MAGMA_CHECK_PROGRAM_STRIPPED	= $(addsuffix .stripped, $(MAGMA_CHECK_PROGRAM))
+MAGMA_SHARED_LIBRARY_STRIPPED = $(addsuffix .stripped, $(MAGMA_SHARED_LIBRARY))
+
 DIME_PROGRAM					= $(addsuffix $(EXEEXT), dime)
 SIGNET_PROGRAM					= $(addsuffix $(EXEEXT), signet)
 GENREC_PROGRAM					= $(addsuffix $(EXEEXT), genrec)
@@ -229,7 +233,9 @@ endif
 
 all: config warning $(MAGMA_PROGRAM) $(DIME_PROGRAM) $(SIGNET_PROGRAM) $(GENREC_PROGRAM) $(MAGMA_CHECK_PROGRAM) $(DIME_CHECK_PROGRAM) finished 
 
-strip: config warning stripped-$(MAGMA_PROGRAM) stripped-$(MAGMA_SHARED_LIBRARY) finished
+strip: config warning $(MAGMA_SHARED_LIBRARY_STRIPPED) $(MAGMA_PROGRAM_STRIPPED) $(MAGMA_CHECK_PROGRAM_STRIPPED) finished
+
+stripped: strip
 
 warning:
 ifeq ($(VERBOSE),no)
@@ -278,30 +284,37 @@ endif
 clean:
 	@$(RM) $(MAGMA_PROGRAM) $(DIME_PROGRAM) $(SIGNET_PROGRAM) $(GENREC_PROGRAM) $(MAGMA_CHECK_PROGRAM) $(DIME_CHECK_PROGRAM) 
 	@$(RM) $(MAGMA_PROGRAM_PPROF) $(MAGMA_CHECK_PROGRAM_PPROF) $(MAGMA_PROGRAM_GPROF) $(MAGMA_CHECK_PROGRAM_GPROF)
+	@$(RM) $(MAGMA_PROGRAM_STRIPPED) $(MAGMA_CHECK_PROGRAM_STRIPPED) $(MAGMA_SHARED_LIBRARY_STRIPPED)
 	@$(RM) $(MAGMA_OBJFILES) $(DIME_OBJFILES) $(SIGNET_OBJFILES) $(GENREC_OBJFILES) $(MAGMA_CHECK_OBJFILES) $(DIME_CHECK_OBJFILES) $(MAGMA_PROF_OBJFILES) $(MAGMA_CHECK_PROF_OBJFILES) 
 	@$(RM) $(MAGMA_DEPFILES) $(DIME_DEPFILES) $(SIGNET_DEPFILES) $(GENREC_DEPFILES) $(MAGMA_CHECK_DEPFILES) $(DIME_CHECK_DEPFILES)
 	@for d in $(sort $(dir $(MAGMA_OBJFILES)) $(dir $(MAGMA_CHECK_OBJFILES)) $(dir $(DIME_OBJFILES)) $(dir $(SIGNET_OBJFILES)) $(dir $(GENREC_OBJFILES))); \
 		do if test -d "$$d"; then $(RMDIR) "$$d"; fi; done
 	@for d in $(sort $(dir $(MAGMA_DEPFILES)) $(dir $(MAGMA_CHECK_DEPFILES)) $(dir $(DIME_DEPFILES)) $(dir $(SIGNET_DEPFILES)) $(dir $(GENREC_DEPFILES))); \
 		do if test -d "$$d"; then $(RMDIR) "$$d"; fi; done
+	@$(RM) --force gmon.out callgrind.out callgraph.dot callgraph.dot.ps massif.out.* cachegrind.out.* \
+		magmad.pprof.out magmad.check.pprof.out magmad.gprof.* magmad.check.gprof.*
 	@echo 'Finished' $(BOLD)$(GREEN)$(TARGETGOAL)$(NORMAL)
 
 distclean: 
 	@$(RM) $(MAGMA_PROGRAM) $(DIME_PROGRAM) $(SIGNET_PROGRAM) $(GENREC_PROGRAM) $(MAGMA_CHECK_PROGRAM) $(DIME_CHECK_PROGRAM) 
-	@$(RM) $(MAGMA_PROGRAM_PPROF) $(MAGMA_CHECK_PROGRAM_PPROF) $(MAGMA_PROGRAM_GPROF) $(MAGMA_CHECK_PROGRAM_GPROF) $(MAGMA_SHARED_LIBRARY)
+	@$(RM) $(MAGMA_PROGRAM_STRIPPED) $(MAGMA_CHECK_PROGRAM_STRIPPED) $(MAGMA_SHARED_LIBRARY_STRIPPED)
+	@$(RM) $(MAGMA_PROGRAM_PPROF) $(MAGMA_CHECK_PROGRAM_PPROF) $(MAGMA_PROGRAM_GPROF) $(MAGMA_CHECK_PROGRAM_GPROF)
 	@$(RM) $(MAGMA_OBJFILES) $(DIME_OBJFILES) $(SIGNET_OBJFILES) $(GENREC_OBJFILES) $(MAGMA_CHECK_OBJFILES) $(DIME_CHECK_OBJFILES) $(MAGMA_PROF_OBJFILES) $(MAGMA_CHECK_PROF_OBJFILES)  
 	@$(RM) $(MAGMA_DEPFILES) $(DIME_DEPFILES) $(SIGNET_DEPFILES) $(GENREC_DEPFILES) $(MAGMA_CHECK_DEPFILES) $(DIME_CHECK_DEPFILES)
-	@$(RM) --recursive --force $(DEPDIR) $(OBJDIR) lib/local lib/logs lib/objects lib/sources
+	@$(RM) --force --recursive lib/local lib/logs lib/objects lib/sources $(DEPDIR) $(OBJDIR)
+	@$(RM) --force gmon.out callgrind.out callgraph.dot callgraph.dot.ps massif.out.* cachegrind.out.* \
+		magmad.pprof.out magmad.check.pprof.out magmad.gprof.* magmad.check.gprof.*
+	@$(RM) $(MAGMA_SHARED_LIBRARY)
 	@echo 'Finished' $(BOLD)$(GREEN)$(TARGETGOAL)$(NORMAL)
 
-stripped-%: $(MAGMA_PROGRAM) $(MAGMA_SHARED_LIBRARY)
+%.stripped $(addsuffix $(DYNLIBEXT), %.stripped): %
 ifeq ($(VERBOSE),no)
 	@echo 'Creating' $(RED)$@$(NORMAL)
 else
 	@echo 
 endif
-	$(RUN)$(STRIP) $(STRIPFLAGS) --output-format=$(shell objdump -p "$(subst stripped-,,$@)" | grep "file format" | head -1 | \
-	awk -F'file format' '{print $$2}' | tr --delete [:space:]) -o "$@" "$(subst stripped-,,$@)"
+	$(RUN)$(STRIP) $(STRIPFLAGS) --output-format=$(shell objdump -p "$(subst .stripped,,$@)" | grep "file format" | head -1 | \
+	awk -F'file format' '{print $$2}' | tr --delete [:space:]) -o "$@" "$(subst .stripped,,$@)"
 
 install: $(MAGMA_PROGRAM) $(MAGMA_SHARED_LIBRARY)
 ifeq ($(VERBOSE),no)
@@ -450,6 +463,6 @@ endif
 # Special Make Directives
 .SUFFIXES: .c .cc .cpp .o 
 #.NOTPARALLEL: warning conifg $(PACKAGE_DEPENDENCIES)
-.PHONY: all strip warning config finished check setup clean distclean install pprof gprof
+.PHONY: all strip stripped warning config finished check setup clean distclean install pprof gprof
 
 # vim:set softtabstop=4 shiftwidth=4 tabstop=4:

Makefile

@@ -85,7 +85,7 @@ void suite_check_testcase(Suite *s, const char *tags, const char *name, TFun fun
 
 /***
  * @return Will return -1 if the code is unable to determine whether tracing is active, 0 if tracing is disabled and
- *		1 if tracing has been detected.
+ *		1 if tracing has been detected. Tracing indicates the process is running atop a debugger.
  */
 int_t running_on_debugger(void) {
 
@@ -120,6 +120,21 @@ int_t running_on_debugger(void) {
 	return -1;
 }
 
+/***
+ * @return Will return -1 if the code is unable to determine whether profiling is active, 0 if profiling is disabled and
+ *		1 if profiling has been detected.
+ */
+int_t running_on_profiler(void) {
+
+	void *mcount = NULL;
+
+	if ((mcount = dlsym(NULL, "mcount"))) {
+		return 1;
+	}
+
+return 0;
+}
+
 /**
  * @brief	Show the check program usage information.
  * @see		display_usage()
@@ -230,7 +245,7 @@ int_t check_args_parse(int argc, char *argv[]) {
 int main(int argc, char *argv[]) {
 
 	SRunner *sr;
-	int_t failed = 0, result;
+	int_t failed = 0, debugger = 0, profiler = 0, result;
 	pthread_t *net_listen_thread = NULL;
 	time_t prog_start, test_start, test_end;
 
@@ -287,17 +302,26 @@ int main(int argc, char *argv[]) {
 		srunner_add_suite(sr, suite_check_regression());
 	}
 
-	// If were being run under Valgrind, we need to disable forking and increase the default timeout.
-	// Under Valgrind, forked checks appear to improperly timeout.
-	if (RUNNING_ON_VALGRIND == 0 && (failed = running_on_debugger()) == 0) {
+
+	// Check whether valgrind, gdb, or gprof are active. Otherwise execute normally. The profiler check should be done
+	// before the debugger check, as the latter involves forking, which will result in a spurious gprof output file if
+	// if profiling is indeed active.
+	if (RUNNING_ON_VALGRIND == 0 && (profiler = running_on_profiler()) == 0 && (debugger = running_on_debugger()) == 0) {
 		log_unit("Not being traced or profiled...\n");
 		srunner_set_fork_status (sr, CK_FORK);
 		case_timeout = RUN_TEST_CASE_TIMEOUT;
 	}
 
-	// Trace detection attempted was thwarted.
+	// A profiler was detected.
+	else if (profiler) {
+		log_unit("A profiler has been detected...\n");
+		srunner_set_fork_status (sr, CK_NOFORK);
+		case_timeout = RUN_TEST_CASE_TIMEOUT;
+	}
+
+	// If were being run under Valgrind, or atop a debugger like gdb, we disable forking and increase the default timeout.
 	else {
-		if (failed == -1) log_unit("Trace detection was thwarted.\n");
+		if (debugger == -1) log_unit("Trace detection was thwarted.\n");
 		else log_unit("Tracing or debugging is active...\n");
 		srunner_set_fork_status (sr, CK_NOFORK);
 		case_timeout = PROFILE_TEST_CASE_TIMEOUT;

check/magma/magma_check.c

@@ -30,7 +30,7 @@ valgrind --tool=cachegrind \
 --read-var-info=yes \
 --cache-sim=yes \
 --branch-sim=no \
---cachegrind-out-file=$HOME/cachegrind.out.%p \
+--cachegrind-out-file=$MAGMA_DIST/cachegrind.out.%p \
 --suppressions=/usr/lib64/valgrind/default.supp \
 --suppressions=$MAGMA_DIST/sandbox/etc/magma.suppressions \ 
 $MAGMA_DIST/magmad.check $MAGMA_DIST/sandbox/etc/magma.sandbox.config

dev/scripts/launch/check.cachegrind.sh

@@ -1,4 +1,4 @@
-#!/bin/bash -x
+#!/bin/bash
 
 # Name: check.callgrind.sh
 # Author: Ladar Levison
@@ -38,13 +38,13 @@ valgrind --tool=callgrind \
 --trace-jump=yes \
 --collect-atstart=yes \
 --instr-atstart=yes  \
---callgrind-out-file=$HOME/Desktop/callgrind.out \
+--callgrind-out-file=$MAGMA_DIST/callgrind.out \
 --suppressions=/usr/lib64/valgrind/default.supp \
 --suppressions=$MAGMA_DIST/sandbox/etc/magma.suppressions \
 $MAGMA_DIST/magmad.check $MAGMA_DIST/sandbox/etc/magma.sandbox.config 
 
 export VPID=$!
-export VLOG=$HOME/Desktop/callgrind.out
+export VLOG=$MAGMA_DIST/callgrind.out
 
 wait $VPID
 

dev/scripts/launch/check.callgrind.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+# Name: check.gprof.sh
+# Author: Ladar Levison
+#
+# Description: Used for profiling the magmad unit tests. The tests are executed using the gprof profiler.
+
+LINK=`readlink -f $0`
+BASE=`dirname $LINK`
+
+cd $BASE/../../../
+
+MAGMA_DIST=`pwd`
+
+if [ ! -e "$MAGMA_DIST/magmad.check.gprof" ] || [ ! -f "$MAGMA_DIST/magmad.check.gprof" ]; then
+	tput setaf 1; tput bold; echo "The magmad.check.gprof binary doesn't exist. Please compile it first."; tput sgr0
+	exit 1
+fi
+GMON_OUT_PREFIX="$MAGMA_DIST/magmad.check.gprof.out" $MAGMA_DIST/magmad.check.gprof $MAGMA_DIST/sandbox/etc/magma.sandbox.config & MAGMA_PID=$!
+wait $MAGMA_PID
+
+if [ -e "$MAGMA_DIST/magmad.check.gprof.out.$MAGMA_PID" ] && [ -f "$MAGMA_DIST/magmad.check.gprof.out.$MAGMA_PID" ]; then
+	gprof $MAGMA_DIST/magmad.check.gprof $MAGMA_DIST/magmad.check.gprof.out.$MAGMA_PID
+fi

dev/scripts/launch/check.gprof.sh

@@ -37,7 +37,7 @@ valgrind --tool=massif \
 --time-unit=i \
 --detailed-freq=10 \
 --max-snapshots=100 \
---massif-out-file=$HOME/massif.out.%p \
+--massif-out-file=$MAGMA_DIST/massif.out.%p \
 --suppressions=/usr/lib64/valgrind/default.supp \
 --suppressions=$MAGMA_DIST/sandbox/etc/magma.suppressions \
 $MAGMA_DIST/magmad.check $MAGMA_DIST/sandbox/etc/magma.sandbox.config

dev/scripts/launch/check.massif.sh

@@ -1,4 +1,4 @@
-#!/bin/bash -x
+#!/bin/bash
 
 # Name: check.callgrind.sh
 # Author: Ladar Levison
@@ -38,13 +38,13 @@ valgrind --tool=callgrind \
 --trace-jump=yes \
 --collect-atstart=yes \
 --instr-atstart=yes  \
---callgrind-out-file=$HOME/Desktop/callgrind.out \
+--callgrind-out-file=$MAGMA_DIST/callgrind.out \
 --suppressions=/usr/lib64/valgrind/default.supp \
 --suppressions=$MAGMA_DIST/sandbox/etc/magma.suppressions \
 $MAGMA_DIST/magmad $MAGMA_DIST/sandbox/etc/magma.sandbox.config 
 
 export VPID=$!
-export VLOG=$HOME/Desktop/callgrind.out
+export VLOG=$MAGMA_DIST/callgrind.out
 
 wait $VPID
 

dev/scripts/launch/magma.callgrind.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+# Name: check.gprof.sh
+# Author: Ladar Levison
+#
+# Description: Used for profiling the magma daemon. The daemon is executed using the gprof profiler.
+
+LINK=`readlink -f $0`
+BASE=`dirname $LINK`
+
+cd $BASE/../../../
+
+MAGMA_DIST=`pwd`
+
+if [ ! -e "$MAGMA_DIST/magmad.gprof" ] || [ ! -f "$MAGMA_DIST/magmad.gprof" ]; then
+	tput setaf 1; tput bold; echo "The magmad.gprof binary doesn't exist. Please compile it first."; tput sgr0
+	exit 1
+fi
+
+GMON_OUT_PREFIX="$MAGMA_DIST/magmad.check.gprof.out" $MAGMA_DIST/magmad.check.gprof $MAGMA_DIST/sandbox/etc/magma.sandbox.config & MAGMA_PID=$!
+wait $MAGMA_PID
+
+if [ -e "$MAGMA_DIST/magmad.check.gprof.out.$MAGMA_PID" ] && [ -f "$MAGMA_DIST/magmad.check.gprof.out.$MAGMA_PID" ]; then
+	gprof $MAGMA_DIST/magmad.check.gprof $MAGMA_DIST/magmad.check.gprof.out.$MAGMA_PID
+fi