Fix: lttng modules system call generation script
[lttng-modules.git] / instrumentation / syscalls / lttng-syscalls-generate-headers.sh
old mode 100644 (file)
new mode 100755 (executable)
index f241d34..a0ae0f2
 #!/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 3.0.4 x86-64-syscalls-3.0.4
-
-INPUTDIR=$1
-INPUTFILE=$2
+#
+# 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
+HEADER=headers/${INPUTFILE}_${CLASS}.h
+
+if [ x"$INPUTDIR" = x"" ]; then
+       echo "Error: Please specify input directory as second argument"
+       exit 1
+fi
+
+if [ x"$INPUTFILE" = x"" ]; then
+       echo "Error: Please specify input file as third argument"
+       exit 1
+fi
+
+if [ x"$BITNESS" != x"32" ] && [ x"$BITNESS" != x"64" ]; then
+       echo "Error: Please specify bitness as fourth argument (\"32\" or \"64\")"
+       exit 1
+fi
 
 cp ${INPUT} ${SRCFILE}
 
 #Cleanup
-sed 's/^\[.*\] //g' ${SRCFILE} > ${TMPFILE}
+perl -p -e 's/^\[.*\] //g' ${SRCFILE} > ${TMPFILE}
 mv ${TMPFILE} ${SRCFILE}
 
-sed 's/^syscall sys_\([^ ]*\)/syscall \1/g' ${SRCFILE} > ${TMPFILE}
+perl -p -e 's/^syscall sys_([^ ]*)/syscall $1/g' ${SRCFILE} > ${TMPFILE}
 mv ${TMPFILE} ${SRCFILE}
 
 #Filter
 
-#select only syscalls we currently support
-#move non-pointers with arguments to a integer-only file.
-CLASS=integers
-grep -v "\\*\|cap_user_header_t" ${SRCFILE} > ${TMPFILE}
-mv ${TMPFILE} ${SRCFILE}
+if [ "$CLASS" = integers ]; then
+       #select integers and no-args.
+       CLASSCAP=INTEGERS
+       grep -v "\\*\|cap_user_header_t" ${SRCFILE} > ${TMPFILE}
+       mv ${TMPFILE} ${SRCFILE}
+fi
 
-#TODO
-# move all system calls using pointers to a separate file.
-#CLASS=pointers
-#grep "\\*\|cap_#user_header_t" ${SRCFILE} > ${TMPFILE}
-#mv ${TMPFILE} ${SRCFILE}
 
-#TODO
-#move those without arguments to a separate file.
-#CLASS=noargs
-#grep "^syscall [^ ]* nr [^ ]* nbargs 0 " ${SRCFILE} > ${TMPFILE}
-#mv ${TMPFILE} ${SRCFILE}
+if [ "$CLASS" = pointers ]; then
+       #select system calls using pointers.
+       CLASSCAP=POINTERS
+       grep "\\*\|cap_#user_header_t" ${SRCFILE} > ${TMPFILE}
+       mv ${TMPFILE} ${SRCFILE}
+fi
 
-HEADER=headers/${INPUTFILE}-${CLASS}.h
+if [ x"$CLASSCAP" = x"" ]; then
+       echo "Error: Please specify \"integers\" or \"pointers\" as first argument"
+       rm -f ${SRCFILE}
+       exit 1
+fi
 
 echo "/* THIS FILE IS AUTO-GENERATED. DO NOT EDIT */" > ${HEADER}
 
 echo \
-"#undef TRACE_SYSTEM
-#define TRACE_SYSTEM syscalls
+"#ifndef CREATE_SYSCALL_TABLE
 
-#if !defined(_TRACE_SYSCALLS_H) || defined(TRACE_HEADER_MULTI_READ)
-#define _TRACE_SYSCALLS_H
+#if !defined(_TRACE_SYSCALLS_${CLASSCAP}_H) || defined(TRACE_HEADER_MULTI_READ)
+#define _TRACE_SYSCALLS_${CLASSCAP}_H
 
 #include <linux/tracepoint.h>
 #include <linux/syscalls.h>
+#include \"${INPUTFILE}_${CLASS}_override.h\"
+#include \"syscalls_${CLASS}_override.h\"
 " >> ${HEADER}
 
-#TODO 0
+if [ "$CLASS" = integers ]; then
+
+NRARGS=0
+
+printf \
+'SC_DECLARE_EVENT_CLASS_NOARGS(syscalls_noargs,\n'\
+'      TP_STRUCT__entry(),\n'\
+'      TP_fast_assign(),\n'\
+'      TP_printk()\n'\
+')\n'\
+       >> ${HEADER}
+
+grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
+perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
+'types: \(([^)]*)\) '\
+'args: \(([^)]*)\)/'\
+'#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
+'SC_DEFINE_EVENT_NOARGS(syscalls_noargs, sys_$1)\n'\
+'#endif/g'\
+       ${TMPFILE} >> ${HEADER}
+
+fi
+
 
 # types: 4
 # args   5
 
 NRARGS=1
 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
-sed 's/^syscall \([^ ]*\) nr \([^ ]*\) nbargs \([^ ]*\) '\
-'types: (\([^)]*\)) '\
-'args: (\([^)]*\))/'\
-'TRACE_EVENT(sys_\1,\n'\
-'      TP_PROTO(\4 \5),\n'\
-'      TP_ARGS(\5),\n'\
-'      TP_STRUCT__entry(__field(\4, \5)),\n'\
-'      TP_fast_assign(tp_assign(\5, \5)),\n'\
+perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
+'types: \(([^)]*)\) '\
+'args: \(([^)]*)\)/'\
+'#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
+'SC_TRACE_EVENT(sys_$1,\n'\
+'      TP_PROTO($4 $5),\n'\
+'      TP_ARGS($5),\n'\
+'      TP_STRUCT__entry(__field($4, $5)),\n'\
+'      TP_fast_assign(tp_assign($4, $5, $5)),\n'\
 '      TP_printk()\n'\
-')/g'\
+')\n'\
+'#endif/g'\
        ${TMPFILE} >> ${HEADER}
 
 # types: 4 5
@@ -78,16 +128,18 @@ sed 's/^syscall \([^ ]*\) nr \([^ ]*\) nbargs \([^ ]*\) '\
 
 NRARGS=2
 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
-sed 's/^syscall \([^ ]*\) nr \([^ ]*\) nbargs \([^ ]*\) '\
-'types: (\([^,]*\), \([^)]*\)) '\
-'args: (\([^,]*\), \([^)]*\))/'\
-'TRACE_EVENT(sys_\1,\n'\
-'      TP_PROTO(\4 \6, \5 \7),\n'\
-'      TP_ARGS(\6, \7),\n'\
-'      TP_STRUCT__entry(__field(\4, \6) __field(\5, \7)),\n'\
-'      TP_fast_assign(tp_assign(\6, \6) tp_assign(\7, \7)),\n'\
+perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
+'types: \(([^,]*), ([^)]*)\) '\
+'args: \(([^,]*), ([^)]*)\)/'\
+'#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
+'SC_TRACE_EVENT(sys_$1,\n'\
+'      TP_PROTO($4 $6, $5 $7),\n'\
+'      TP_ARGS($6, $7),\n'\
+'      TP_STRUCT__entry(__field($4, $6) __field($5, $7)),\n'\
+'      TP_fast_assign(tp_assign($4, $6, $6) tp_assign($5, $7, $7)),\n'\
 '      TP_printk()\n'\
-')/g'\
+')\n'\
+'#endif/g'\
        ${TMPFILE} >> ${HEADER}
 
 # types: 4 5 6
@@ -95,16 +147,18 @@ sed 's/^syscall \([^ ]*\) nr \([^ ]*\) nbargs \([^ ]*\) '\
 
 NRARGS=3
 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
-sed 's/^syscall \([^ ]*\) nr \([^ ]*\) nbargs \([^ ]*\) '\
-'types: (\([^,]*\), \([^,]*\), \([^)]*\)) '\
-'args: (\([^,]*\), \([^,]*\), \([^)]*\))/'\
-'TRACE_EVENT(sys_\1,\n'\
-'      TP_PROTO(\4 \7, \5 \8, \6 \9),\n'\
-'      TP_ARGS(\7, \8, \9),\n'\
-'      TP_STRUCT__entry(__field(\4, \7) __field(\5, \8) __field(\6, \9)),\n'\
-'      TP_fast_assign(tp_assign(\7, \7) tp_assign(\8, \8) tp_assign(\9, \9)),\n'\
+perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
+'types: \(([^,]*), ([^,]*), ([^)]*)\) '\
+'args: \(([^,]*), ([^,]*), ([^)]*)\)/'\
+'#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'\
+'      TP_STRUCT__entry(__field($4, $7) __field($5, $8) __field($6, $9)),\n'\
+'      TP_fast_assign(tp_assign($4, $7, $7) tp_assign($5, $8, $8) tp_assign($6, $9, $9)),\n'\
 '      TP_printk()\n'\
-')/g'\
+')\n'\
+'#endif/g'\
        ${TMPFILE} >> ${HEADER}
 
 
@@ -113,16 +167,18 @@ sed 's/^syscall \([^ ]*\) nr \([^ ]*\) nbargs \([^ ]*\) '\
 
 NRARGS=4
 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
-sed 's/^syscall \([^ ]*\) nr \([^ ]*\) nbargs \([^ ]*\) '\
-'types: (\([^,]*\), \([^,]*\), \([^,]*\), \([^)]*\)) '\
-'args: (\([^,]*\), \([^,]*\), \([^,]*\), \([^)]*\))/'\
-'TRACE_EVENT(sys_\1,\n'\
-'      TP_PROTO(\4 \8, \5 \9, \6 \10, \7 \11),\n'\
-'      TP_ARGS(\8, \9, \10, \11),\n'\
-'      TP_STRUCT__entry(__field(\4, \8) __field(\5, \9) __field(\6, \10) __field(\7, \11)),\n'\
-'      TP_fast_assign(tp_assign(\8, \8) tp_assign(\9, \9) tp_assign(\10, \10) tp_assign(\11, \11)),\n'\
+perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
+'types: \(([^,]*), ([^,]*), ([^,]*), ([^)]*)\) '\
+'args: \(([^,]*), ([^,]*), ([^,]*), ([^)]*)\)/'\
+'#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'\
+'      TP_STRUCT__entry(__field($4, $8) __field($5, $9) __field($6, $10) __field($7, $11)),\n'\
+'      TP_fast_assign(tp_assign($4, $8, $8) tp_assign($5, $9, $9) tp_assign($6, $10, $10) tp_assign($7, $11, $11)),\n'\
 '      TP_printk()\n'\
-')/g'\
+')\n'\
+'#endif/g'\
        ${TMPFILE} >> ${HEADER}
 
 # types: 4  5  6  7  8
@@ -130,16 +186,18 @@ sed 's/^syscall \([^ ]*\) nr \([^ ]*\) nbargs \([^ ]*\) '\
 
 NRARGS=5
 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
-sed 's/^syscall \([^ ]*\) nr \([^ ]*\) nbargs \([^ ]*\) '\
-'types: (\([^,]*\), \([^,]*\), \([^,]*\), \([^,]*\), \([^)]*\)) '\
-'args: (\([^,]*\), \([^,]*\), \([^,]*\), \([^,]*\), \([^)]*\))/'\
-'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'\
-'      TP_STRUCT__entry(__field(\4, \9) __field(\5, \10) __field(\6, \11) __field(\7, \12) __field(\8, \13)),\n'\
-'      TP_fast_assign(tp_assign(\9, \9) tp_assign(\10, \10) tp_assign(\11, \11) tp_assign(\12, \12) tp_assign(\13, \13)),\n'\
+perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
+'types: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^)]*)\) '\
+'args: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^)]*)\)/'\
+'#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'\
+'      TP_STRUCT__entry(__field($4, $9) __field($5, $10) __field($6, $11) __field($7, $12) __field($8, $13)),\n'\
+'      TP_fast_assign(tp_assign($4, $9, $9) tp_assign($5, $10, $10) tp_assign($6, $11, $11) tp_assign($7, $12, $12) tp_assign($8, $13, $13)),\n'\
 '      TP_printk()\n'\
-')/g'\
+')\n'\
+'#endif/g'\
        ${TMPFILE} >> ${HEADER}
 
 
@@ -148,26 +206,90 @@ sed 's/^syscall \([^ ]*\) nr \([^ ]*\) nbargs \([^ ]*\) '\
 
 NRARGS=6
 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
-sed 's/^syscall \([^ ]*\) nr \([^ ]*\) nbargs \([^ ]*\) '\
-'types: (\([^,]*\), \([^,]*\), \([^,]*\), \([^,]*\), \([^,]*\), \([^)]*\)) '\
-'args: (\([^,]*\), \([^,]*\), \([^,]*\), \([^,]*\), \([^,]*\), \([^)]*\))/'\
-'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'\
-'      TP_STRUCT__entry(__field(\4, \10) __field(\5, \11) __field(\6, \12) __field(\7, \13) __field(\8, \14) __field(\9, \15)),\n'\
-'      TP_fast_assign(tp_assign(\10, \10) tp_assign(\11, \11) tp_assign(\12, 12) tp_assign(\13, \13) tp_assign(\14, \14) tp_assign(\15, \15)),\n'\
+perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
+'types: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^\)]*)\) '\
+'args: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^\)]*)\)/'\
+'#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'\
+'      TP_STRUCT__entry(__field($4, $10) __field($5, $11) __field($6, $12) __field($7, $13) __field($8, $14) __field($9, $15)),\n'\
+'      TP_fast_assign(tp_assign($4, $10, $10) tp_assign($5, $11, $11) tp_assign($6, $12, $12) tp_assign($7, $13, $13) tp_assign($8, $14, $14) tp_assign($9, $15, $15)),\n'\
 '      TP_printk()\n'\
-')/g'\
+')\n'\
+'#endif/g'\
        ${TMPFILE} >> ${HEADER}
 
-echo -n \
+# Macro for tracing syscall table
+
+echo \
 "
-#endif /*  _TRACE_SYSCALLS_H */
+#endif /*  _TRACE_SYSCALLS_${CLASSCAP}_H */
 
 /* This part must be outside protection */
 #include \"../../../probes/define_trace.h\"
+
+#else /* CREATE_SYSCALL_TABLE */
+
+#include \"${INPUTFILE}_${CLASS}_override.h\"
+#include \"syscalls_${CLASS}_override.h\"
 " >> ${HEADER}
 
+NRARGS=0
+
+if [ "$CLASS" = integers ]; then
+#noargs
+grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
+perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) .*$/'\
+'#ifndef OVERRIDE_TABLE_'"${BITNESS}"'_sys_$1\n'\
+'TRACE_SYSCALL_TABLE\(syscalls_noargs, sys_$1, $2, $3\)\n'\
+'#endif/g'\
+       ${TMPFILE} >> ${HEADER}
+fi
+
+#others.
+grep -v "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
+perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) .*$/'\
+'#ifndef OVERRIDE_TABLE_'"${BITNESS}"'_sys_$1\n'\
+'TRACE_SYSCALL_TABLE(sys_$1, sys_$1, $2, $3)\n'\
+'#endif/g'\
+       ${TMPFILE} >> ${HEADER}
+
+echo -n \
+"
+#endif /* CREATE_SYSCALL_TABLE */
+" >> ${HEADER}
+
+#fields names: ...char * type with *name* or *file* or *path* or *root*
+# or *put_old* or *type*
+cp -f ${HEADER} ${TMPFILE}
+rm -f ${HEADER}
+perl -p -e 's/__field\(([^,)]*char \*), ([^\)]*)(name|file|path|root|put_old|type)([^\)]*)\)/__string_from_user($2$3$4, $2$3$4)/g'\
+       ${TMPFILE} >> ${HEADER}
+cp -f ${HEADER} ${TMPFILE}
+rm -f ${HEADER}
+perl -p -e 's/tp_assign\(([^,)]*char \*), ([^,]*)(name|file|path|root|put_old|type)([^,]*), ([^\)]*)\)/tp_copy_string_from_user($2$3$4, $5)/g'\
+       ${TMPFILE} >> ${HEADER}
+
+#prettify addresses heuristics.
+#field names with addr or ptr
+cp -f ${HEADER} ${TMPFILE}
+rm -f ${HEADER}
+perl -p -e 's/__field\(([^,)]*), ([^,)]*addr|[^,)]*ptr)([^),]*)\)/__field_hex($1, $2$3)/g'\
+       ${TMPFILE} >> ${HEADER}
+
+#field types ending with '*'
+cp -f ${HEADER} ${TMPFILE}
+rm -f ${HEADER}
+perl -p -e 's/__field\(([^,)]*\*), ([^),]*)\)/__field_hex($1, $2)/g'\
+       ${TMPFILE} >> ${HEADER}
+
+#strip the extra type information from tp_assign.
+cp -f ${HEADER} ${TMPFILE}
+rm -f ${HEADER}
+perl -p -e 's/tp_assign\(([^,)]*), ([^,]*), ([^\)]*)\)/tp_assign($2, $3)/g'\
+       ${TMPFILE} >> ${HEADER}
+
 rm -f ${INPUTFILE}.tmp
 rm -f ${TMPFILE}
 rm -f ${SRCFILE}
This page took 0.027144 seconds and 4 git commands to generate.