Generation of flamegraphs for rootbenchmarks (script)

Author: HLilit

cmake/modules/AddRootBench.cmake

@@ -20,7 +20,7 @@ function(RB_ADD_GBENCHMARK benchmark)
     set(postcmd POSTCMD ${ARG_POSTCMD})
   endif()
   if(flamegraph)
-      set(postcmd ${postcmd} "${PROJECT_SOURCE_DIR}/rootbench-scripts/flamegraph.sh")
+      set(postcmd ${postcmd} "${PROJECT_SOURCE_DIR}/rootbench-scripts/flamegraph.sh ${PROJECT_BINARY_DIR} -b ${CMAKE_CURRENT_BINARY_DIR}/${benchmark}")
       add_dependencies(${benchmark} flamegraph-download)
   endif()
   if(${ARG_LABEL} STREQUAL "long")

rootbench-scripts/flamegraph.sh

@@ -1,20 +1,14 @@
 #!/bin/bash
 
-
 BENCHMARKPATTERN="*benchmark*"
-ROOTBENCHBUILDDIR=$1 #/home/lharutyu/ROOT/rootbench-build2   # Enter path to rootbench-build folder
-shift                  
-FLAMEGRAPHBASEDIR=$ROOTBENCHBUILDDIR/FlameGraph
-
 MKDIR=/bin/mkdir
 BASENAME=/usr/bin/basename
 DIRNAME=/usr/bin/dirname
 FIND=/usr/bin/find
 SED=/bin/sed
 PERF=/usr/bin/perf
-STACKCOLLASE=stackcollapse-perf.pl          
-FLAMEGRAPG=flamegraph.pl                   
-
+STACKCOLLASE=stackcollapse-perf.pl
+FLAMEGRAPG=flamegraph.pl
 
 usage()
 {
@@ -23,30 +17,42 @@ usage()
     echo
     echo "Usage: $0 [OPTION]..."
     echo "This script generates FlameGraphs for benchmarks !!!"
-    echo "    Enter path/to/rootbench/build/dir"
     echo "OPTIONS"
     echo "   -b, --benchmarkfile path       Location of ROOT benchmark file"
     echo "   -a, --all                      Create all benchmarks."
+    echo "   -d, --builddir path            Create all benchmarks."
     echo "   -h, --help                     Display this help and exit"
 }
 
 usage_short()
 {
-    echo "FlameGraph Generator"
-    echo "Usage: $0 [path/to/rootbench/build/dir] [-b |--benchmarkfile filepath] [-a | --all] [-h | --help]"
+#    echo "FlameGraph Generator"
+    echo "Usage: $0 -d | --builddir path [-b | --benchmarkfile filepath] [-a | --all] [-h | --help]"
+    exit 1
 }
 
 get_bm_fn()
 {
     if [ ! -f $1 ] ; then
-        echo "Can't find the executable"
+        echo "Can't find the benchmark file"
         exit 1
     else
         bm_fn_full=$1
         bm_fn=`$BASENAME $bm_fn_full`
     fi
 }
 
+get_build_dir()
+{
+    if [ ! -d $1 ] ; then
+	echo "Can't find the build directory. Exiting..."
+	exit 1
+    else
+	build_dir=$1
+	flamegraph_base_dir=$build_dir/FlameGraph
+    fi
+}
+
 get_bm_fn_interactive()
 {
     read -p "Enter benchmark filename: " bm_fn_full
@@ -57,84 +63,53 @@ get_bm_fn_interactive()
     get_bm_fn $bm_fn_full
 }
 
-
-
 perf_record()
 {
-	$PERF record -F 50 --call-graph dwarf $1 --benchmark_filter=$2 
+    $PERF record -F 50 --call-graph dwarf $1 --benchmark_filter=${2}$ 
 }
 
 perf_script()
 {
-	$PERF script | stackcollapse-perf.pl | flamegraph.pl > $1.svg
+    $PERF script | stackcollapse-perf.pl | flamegraph.pl --title $1 > $2.svg
 }
 
-perf_rec_scr()           
+perf_rec_scr()
 {
-	perf_record $1 $2
-	perf_script $3
-	# $PERF record --call-graph dwarf $1 | $PERF script | $STACKCOLLASE | $FLAMEGRAPG > $2
+    perf_record $1 $2
+    perf_script $2 $3
+    # $PERF record --call-graph dwarf $1 | $PERF script | $STACKCOLLASE | $FLAMEGRAPG > $2
 }
 
-
 get_bm_files()
 {
-	bm_file_list=`$FIND $ROOTBENCHBUILDDIR/root -iname "$BENCHMARKPATTERN" |grep -v "CMakeFiles"`
-
+    bm_file_list=`$FIND $build_dir/root -iname "$BENCHMARKPATTERN" |grep -v "CMakeFiles"`
 }
 
-run_all_bm()
+run_bm()
 {
-	get_bm_files
-	for bm_fn_full in $bm_file_list
+    for bm_fn_full in $bm_file_list
+    do
+	bm_fn=`$BASENAME $bm_fn_full`
+	bm_dn=`$DIRNAME $bm_fn_full`
+	bm_path=`echo "$bm_dn" | $SED -n "s|^$build_dir/||p"`
+	bm_sub_list=`$bm_fn_full --benchmark_list_tests`
+	outputdir_full=${flamegraph_base_dir}/$bm_path/$bm_fn
+	$MKDIR -p $outputdir_full
+	if [ $? -ne 0 ]; then
+	    echo "Can't create directory $1. Exiting..."
+	    exit 1
+	fi
+	for bm in $bm_sub_list
 	do
-   	    bm_fn=`$BASENAME $bm_fn_full`
-   	    bm_dn=`$DIRNAME $bm_fn_full`
-		bm_path=`echo "$bm_dn" | $SED -n "s|^$ROOTBENCHBUILDDIR/||p"`
-	    bm_list_exec=`./$bm_path/$bm_fn --benchmark_list_tests`
-   		outputdir_full=${FLAMEGRAPHBASEDIR}/$bm_path/$bm_fn
-   		$MKDIR -p $outputdir_full
-    	if [ $? -ne 0 ]; then
-        	echo "Can't create directory $1. Exiting..."
-        exit 1
-    fi
-		for benchmark in $bm_list_exec
-		do
-    		perf_rec_scr $bm_fn_full $benchmark ${outputdir_full}/${benchmark}_FlameGraph
-		done
+	    bm_modified_fn=`echo "$bm" | $SED "s|[/:]|-|g"`    #replacing all "/" and ":" with "-"
+ 	    perf_rec_scr $bm_fn_full $bm ${outputdir_full}/${bm_modified_fn}_FlameGraph
 	done
+    done
 }
 
 
-run_spec_bm() 
-{
-spec_bm_list_exec=`$ROOTBENCHBUILDDIR/$bm_fn_full --benchmark_list_tests`
-spec_outputdir_full=$ROOTBENCHBUILDDIR/$bm_fn
-$MKDIR $spec_outputdir_full
-	if [ $? -ne 0 ]; then
-        echo "Can't create directory $1. Exiting..."
-        exit 1
-    fi
-	for benchmark in $spec_bm_list_exec
-		do
-    		perf_rec_scr $ROOTBENCHBUILDDIR/$bm_fn_full $benchmark ${spec_outputdir_full}/${benchmark}_FlameGraph
-		done
-}		
-
-
 #####  Main  #####
 
-
-if [ \( "$ROOTBENCHBUILDDIR" = "-h" \) -o \( "$ROOTBENCHBUILDDIR" = "--help" \) ] ; then
-	usage
-	exit 1
-fi
-
-if [ ! -d $ROOTBENCHBUILDDIR ] ; then
-	echo "Can't find the build directory. Exiting..."
-	exit 1
-fi
-
 [ $# -eq 0 ] && usage_short
 
 while [ $# -gt 0 ]; do
@@ -143,6 +118,11 @@ while [ $# -gt 0 ]; do
                               shift
                               get_bm_fn $1
         ;;
+        -d | --builddir )
+                              shift
+                              get_build_dir $1
+        ;;
+
         -a | --all )
                               all=y
         ;;
@@ -158,26 +138,19 @@ while [ $# -gt 0 ]; do
         shift
 done
 
-if [ "$all" = "y" ] ; then
-   run_all_bm
+if [ -z $build_dir ] ; then
+    echo "************* Rootbench Build dir is mandatory *****************"
+    usage_short
 fi
 
-###    If no "-b" option, we go with interactive mode.   ###
-# if [ -z $bm_fn_full  ] ; then
-#	get_bm_fn_interactive
-# fi
- 
-if [ ! -z $bm_fn_full ] ; then
-	run_spec_bm
+if [ "$all" = "y" ] ; then
+    get_bm_files
+    run_bm
+else
+    if [ ! -z $bm_fn_full ] ; then
+	bm_file_list=$bm_fn_full
+	run_bm
+    fi
 fi
 
 exit $?
-
-
-
-
-
-
-
-
-