modify readme

Author: x2c3z4

README.md

@@ -56,6 +56,46 @@ Other Graphs
 ============
 ![callgraph of sdopen(simplify version)](/examples/images/sdopen.simplify.cg.png)
 
+Advances
+========
+The gen_stap.sh tool is used to generate systemtap scripts for advanced feature like probing more modules.
+You could add '-m' with modules name.
+For instance, add '-m target_core_mod.ko,iscsi_target_mod.ko,target_core_file.ko' for probing target core module, iscsi module and file-based backstore target module.
+
+You could do as you need.
+
+1. Usage
+----------
+```
+ $ ./gen_stap.sh -h
+
+Usage:
+ -e, --entry func, must options here
+ -m, --modules modules, put multi modules splitted with comma(,)
+ -f, --force_cache
+ -o, --out_stap
+ -v, --verbose, probe suffix ?
+```
+
+2. Create stap as your want
+-------
+```
+ $ ./gen_stap.sh -m target_core_mod.ko,iscsi_target_mod.ko,target_core_file.ko -e iscsi_sw_tcp_conn_create -o test.stp
+Entry func: module("iscsi_tcp").function("iscsi_sw_tcp_conn_create")
+Inject modules: target_core_mod.ko,iscsi_target_mod.ko,target_core_file.ko,iscsi_tcp
+Out_stap: test.stp
+Force cache: 0
+Probe check: 0
+```
+
+3. Run stap
+------------
+
+```
+ $ bash ./iscsi_sw_tcp_conn_create.stap -v 
+ or
+ $ bash ./iscsi_sw_tcp_conn_create.stap
+```
 
 Details
 =======
@@ -97,4 +137,4 @@ You can go to `example/log/` and play.
 Contact
 =======
 Alex Feng
-lifeng1519@gmail.com
+lifeng1519@gmail.com

gen_stap.sh

@@ -4,8 +4,10 @@ function usage() {
 	echo $1
 	echo "Usage:"
 	echo " -e, --entry func, must options here"
-	echo " -m, --modules modules, put multi modules splited with comma(,)"
+	echo " -m, --modules modules, put multi modules splitted with comma(,)"
 	echo " -f, --force_cache"
+  echo " -o, --out_stap"
+	echo " -v, --verbose, probe suffix ?"
 }
 function make_caches() {
 	cache_dir=~/.kernel_visualization.cache
@@ -62,7 +64,7 @@ done
 
 
 [[ -z $entry ]] && usage && exit
-[[ -z $out ]] && out=$entry.stap
+[[ -z $out_stap ]] && out_stap=$entry.stap
 
 calls=""
 returns=""
@@ -102,19 +104,19 @@ if [ -z "$calls" ];then
 	returns="probe kernel.function(\"*\").return?"
 fi
 
-echo "Entry func: $probe"
-echo "Inject modules: $modules"
-echo "Out_stap: $out"
-echo "Force cache: $force_cache"
-echo "Probe check: $verbose"
+echo "[+] Entry func: $probe"
+echo "[+] Inject modules: $modules"
+echo "[+] Out_stap: $out_stap"
+echo "[+] Force cache: $force_cache"
+echo "[+] Probe check: $verbose"
 
 
-sed -e "s/\$1/$probe/g" -e "s/probe \$2.call/$calls/g" -e "s/probe \$2.return/$returns/g" stap_base.stp >$out
-cat >>$out <<EOF
+sed -e "s/\$1/$probe/g" -e "s/probe \$2.call/$calls/g" -e "s/probe \$2.return/$returns/g" stap_base.stp >$out_stap
+cat >>$out_stap <<EOF
 ##############################################################################
 #                      Generated by gen_stap.sh using cmd:
 #                          $cmd
 #                      Author: Feng Li (lifeng1519@gmail.com)
 EOF
-chmod a+x $out
-cat $out
+chmod a+x $out_stap
+cat $out_stap