Improve documentation of the syscall extractor script

[lttng-modules.git] / instrumentation / syscalls / lttng-syscalls-generate-headers.sh

diff --git a/instrumentation/syscalls/lttng-syscalls-generate-headers.sh b/instrumentation/syscalls/lttng-syscalls-generate-headers.sh
old mode 100644 (file)
new mode 100755 (executable)
index c6636e7..4ab4599
--- a/instrumentation/syscalls/lttng-syscalls-generate-headers.sh
+++ b/instrumentation/syscalls/lttng-syscalls-generate-headers.sh
@@ -1,14 +1,19 @@
 #!/bin/sh
 
 # Generate system call probe description macros from syscall metadata dump file.
+# The resulting header will be written in the headers subdirectory, in a file name
+# based on the name of the input file. 
+#
 # example usage:
 #
-# lttng-syscalls-generate-headers.sh integers 3.0.4 x86-64-syscalls-3.0.4
-# lttng-syscalls-generate-headers.sh pointers 3.0.4 x86-64-syscalls-3.0.4
+# lttng-syscalls-generate-headers.sh <type> <input_dir> <input_filename_in_dir> <bitness>
+# lttng-syscalls-generate-headers.sh integers 3.0.4 x86-64-syscalls-3.0.4 64
+# lttng-syscalls-generate-headers.sh pointers 3.0.4 x86-64-syscalls-3.0.4 64
 
 CLASS=$1
 INPUTDIR=$2
 INPUTFILE=$3
+BITNESS=$4
 INPUT=${INPUTDIR}/${INPUTFILE}
 SRCFILE=gen.tmp.0
 TMPFILE=gen.tmp.1
@@ -51,13 +56,14 @@ echo \
 #include <linux/tracepoint.h>
 #include <linux/syscalls.h>
 #include \"${INPUTFILE}_${CLASS}_override.h\"
+#include \"syscalls_${CLASS}_override.h\"
 " >> ${HEADER}
 
 if [ "$CLASS" = integers ]; then
 
 NRARGS=0
 
-echo \
+printf \
 'SC_DECLARE_EVENT_CLASS_NOARGS(syscalls_noargs,\n'\
 '      TP_STRUCT__entry(),\n'\
 '      TP_fast_assign(),\n'\
@@ -69,7 +75,7 @@ grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 'types: \(([^)]*)\) '\
 'args: \(([^)]*)\)/'\
-'#ifndef OVERRIDE_sys_$1\n'\
+'#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
 'SC_DEFINE_EVENT_NOARGS(syscalls_noargs, sys_$1)\n'\
 '#endif/g'\
        ${TMPFILE} >> ${HEADER}
@@ -85,7 +91,7 @@ grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 'types: \(([^)]*)\) '\
 'args: \(([^)]*)\)/'\
-'#ifndef OVERRIDE_sys_$1\n'\
+'#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
 'SC_TRACE_EVENT(sys_$1,\n'\
 '      TP_PROTO($4 $5),\n'\
 '      TP_ARGS($5),\n'\
@@ -104,7 +110,7 @@ grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 'types: \(([^,]*), ([^)]*)\) '\
 'args: \(([^,]*), ([^)]*)\)/'\
-'#ifndef OVERRIDE_sys_$1\n'\
+'#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
 'SC_TRACE_EVENT(sys_$1,\n'\
 '      TP_PROTO($4 $6, $5 $7),\n'\
 '      TP_ARGS($6, $7),\n'\
@@ -123,7 +129,7 @@ grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 'types: \(([^,]*), ([^,]*), ([^)]*)\) '\
 'args: \(([^,]*), ([^,]*), ([^)]*)\)/'\
-'#ifndef OVERRIDE_sys_$1\n'\
+'#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
 'SC_TRACE_EVENT(sys_$1,\n'\
 '      TP_PROTO($4 $7, $5 $8, $6 $9),\n'\
 '      TP_ARGS($7, $8, $9),\n'\
@@ -143,7 +149,7 @@ grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 'types: \(([^,]*), ([^,]*), ([^,]*), ([^)]*)\) '\
 'args: \(([^,]*), ([^,]*), ([^,]*), ([^)]*)\)/'\
-'#ifndef OVERRIDE_sys_$1\n'\
+'#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
 'SC_TRACE_EVENT(sys_$1,\n'\
 '      TP_PROTO($4 $8, $5 $9, $6 $10, $7 $11),\n'\
 '      TP_ARGS($8, $9, $10, $11),\n'\
@@ -162,7 +168,7 @@ grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 'types: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^)]*)\) '\
 'args: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^)]*)\)/'\
-'#ifndef OVERRIDE_sys_$1\n'\
+'#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
 'SC_TRACE_EVENT(sys_$1,\n'\
 '      TP_PROTO($4 $9, $5 $10, $6 $11, $7 $12, $8 $13),\n'\
 '      TP_ARGS($9, $10, $11, $12, $13),\n'\
@@ -182,7 +188,7 @@ grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 'types: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^\)]*)\) '\
 'args: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^\)]*)\)/'\
-'#ifndef OVERRIDE_sys_$1\n'\
+'#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
 'SC_TRACE_EVENT(sys_$1,\n'\
 '      TP_PROTO($4 $10, $5 $11, $6 $12, $7 $13, $8 $14, $9 $15),\n'\
 '      TP_ARGS($10, $11, $12, $13, $14, $15),\n'\
@@ -210,6 +216,7 @@ echo \
 #else /* CREATE_SYSCALL_TABLE */
 
 #include \"${INPUTFILE}_${CLASS}_override.h\"
+#include \"syscalls_${CLASS}_override.h\"
 " >> ${HEADER}
 
 NRARGS=0
@@ -218,7 +225,7 @@ if [ "$CLASS" = integers ]; then
 #noargs
 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) .*$/'\
-'#ifndef OVERRIDE_TABLE_sys_$1\n'\
+'#ifndef OVERRIDE_TABLE_'"${BITNESS}"'_sys_$1\n'\
 'TRACE_SYSCALL_TABLE\(syscalls_noargs, sys_$1, $2, $3\)\n'\
 '#endif/g'\
        ${TMPFILE} >> ${HEADER}
@@ -227,7 +234,7 @@ fi
 #others.
 grep -v "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) .*$/'\
-'#ifndef OVERRIDE_TABLE_sys_$1\n'\
+'#ifndef OVERRIDE_TABLE_'"${BITNESS}"'_sys_$1\n'\
 'TRACE_SYSCALL_TABLE(sys_$1, sys_$1, $2, $3)\n'\
 '#endif/g'\
        ${TMPFILE} >> ${HEADER}