instrumentation/syscalls/lttng-syscalls-generate-headers.sh

   1 #!/bin/sh
   2
   3 # Generate system call probe description macros from syscall metadata dump file.
   4 # The resulting header will be written in the headers subdirectory, in a file name
   5 # based on the name of the input file.
   6 #
   7 # example usage:
   8 #
   9 # lttng-syscalls-generate-headers.sh <type> <input_dir> <input_filename_in_dir> <bitness>
  10 # lttng-syscalls-generate-headers.sh integers 3.0.4 x86-64-syscalls-3.0.4 64
  11 # lttng-syscalls-generate-headers.sh pointers 3.0.4 x86-64-syscalls-3.0.4 64
  12
  13 CLASS=$1
  14 INPUTDIR=$2
  15 INPUTFILE=$3
  16 BITNESS=$4
  17 INPUT=${INPUTDIR}/${INPUTFILE}
  18 SRCFILE=gen.tmp.0
  19 TMPFILE=gen.tmp.1
  20 HEADER=headers/${INPUTFILE}_${CLASS}.h
  21
  22 cp ${INPUT} ${SRCFILE}
  23
  24 #Cleanup
  25 perl -p -e 's/^\[.*\] //g' ${SRCFILE} > ${TMPFILE}
  26 mv ${TMPFILE} ${SRCFILE}
  27
  28 perl -p -e 's/^syscall sys_([^ ]*)/syscall $1/g' ${SRCFILE} > ${TMPFILE}
  29 mv ${TMPFILE} ${SRCFILE}
  30
  31 #Filter
  32
  33 if [ "$CLASS" = integers ]; then
  34         #select integers and no-args.
  35         CLASSCAP=INTEGERS
  36         grep -v "\\*\|cap_user_header_t" ${SRCFILE} > ${TMPFILE}
  37         mv ${TMPFILE} ${SRCFILE}
  38 fi
  39
  40
  41 if [ "$CLASS" = pointers ]; then
  42         #select system calls using pointers.
  43         CLASSCAP=POINTERS
  44         grep "\\*\|cap_#user_header_t" ${SRCFILE} > ${TMPFILE}
  45         mv ${TMPFILE} ${SRCFILE}
  46 fi
  47
  48 echo "/* THIS FILE IS AUTO-GENERATED. DO NOT EDIT */" > ${HEADER}
  49
  50 echo \
  51 "#ifndef CREATE_SYSCALL_TABLE
  52
  53 #if !defined(_TRACE_SYSCALLS_${CLASSCAP}_H) || defined(TRACE_HEADER_MULTI_READ)
  54 #define _TRACE_SYSCALLS_${CLASSCAP}_H
  55
  56 #include <linux/tracepoint.h>
  57 #include <linux/syscalls.h>
  58 #include \"${INPUTFILE}_${CLASS}_override.h\"
  59 #include \"syscalls_${CLASS}_override.h\"
  60 " >> ${HEADER}
  61
  62 if [ "$CLASS" = integers ]; then
  63
  64 NRARGS=0
  65
  66 printf \
  67 'SC_DECLARE_EVENT_CLASS_NOARGS(syscalls_noargs,\n'\
  68 '       TP_STRUCT__entry(),\n'\
  69 '       TP_fast_assign(),\n'\
  70 '       TP_printk()\n'\
  71 ')'\
  72         >> ${HEADER}
  73
  74 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
  75 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
  76 'types: \(([^)]*)\) '\
  77 'args: \(([^)]*)\)/'\
  78 '#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
  79 'SC_DEFINE_EVENT_NOARGS(syscalls_noargs, sys_$1)\n'\
  80 '#endif/g'\
  81         ${TMPFILE} >> ${HEADER}
  82
  83 fi
  84
  85
  86 # types: 4
  87 # args   5
  88
  89 NRARGS=1
  90 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
  91 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
  92 'types: \(([^)]*)\) '\
  93 'args: \(([^)]*)\)/'\
  94 '#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
  95 'SC_TRACE_EVENT(sys_$1,\n'\
  96 '       TP_PROTO($4 $5),\n'\
  97 '       TP_ARGS($5),\n'\
  98 '       TP_STRUCT__entry(__field($4, $5)),\n'\
  99 '       TP_fast_assign(tp_assign($4, $5, $5)),\n'\
 100 '       TP_printk()\n'\
 101 ')\n'\
 102 '#endif/g'\
 103         ${TMPFILE} >> ${HEADER}
 104
 105 # types: 4 5
 106 # args   6 7
 107
 108 NRARGS=2
 109 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 110 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 111 'types: \(([^,]*), ([^)]*)\) '\
 112 'args: \(([^,]*), ([^)]*)\)/'\
 113 '#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
 114 'SC_TRACE_EVENT(sys_$1,\n'\
 115 '       TP_PROTO($4 $6, $5 $7),\n'\
 116 '       TP_ARGS($6, $7),\n'\
 117 '       TP_STRUCT__entry(__field($4, $6) __field($5, $7)),\n'\
 118 '       TP_fast_assign(tp_assign($4, $6, $6) tp_assign($5, $7, $7)),\n'\
 119 '       TP_printk()\n'\
 120 ')\n'\
 121 '#endif/g'\
 122         ${TMPFILE} >> ${HEADER}
 123
 124 # types: 4 5 6
 125 # args   7 8 9
 126
 127 NRARGS=3
 128 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 129 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 130 'types: \(([^,]*), ([^,]*), ([^)]*)\) '\
 131 'args: \(([^,]*), ([^,]*), ([^)]*)\)/'\
 132 '#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
 133 'SC_TRACE_EVENT(sys_$1,\n'\
 134 '       TP_PROTO($4 $7, $5 $8, $6 $9),\n'\
 135 '       TP_ARGS($7, $8, $9),\n'\
 136 '       TP_STRUCT__entry(__field($4, $7) __field($5, $8) __field($6, $9)),\n'\
 137 '       TP_fast_assign(tp_assign($4, $7, $7) tp_assign($5, $8, $8) tp_assign($6, $9, $9)),\n'\
 138 '       TP_printk()\n'\
 139 ')\n'\
 140 '#endif/g'\
 141         ${TMPFILE} >> ${HEADER}
 142
 143
 144 # types: 4 5  6  7
 145 # args   8 9 10 11
 146
 147 NRARGS=4
 148 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 149 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 150 'types: \(([^,]*), ([^,]*), ([^,]*), ([^)]*)\) '\
 151 'args: \(([^,]*), ([^,]*), ([^,]*), ([^)]*)\)/'\
 152 '#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
 153 'SC_TRACE_EVENT(sys_$1,\n'\
 154 '       TP_PROTO($4 $8, $5 $9, $6 $10, $7 $11),\n'\
 155 '       TP_ARGS($8, $9, $10, $11),\n'\
 156 '       TP_STRUCT__entry(__field($4, $8) __field($5, $9) __field($6, $10) __field($7, $11)),\n'\
 157 '       TP_fast_assign(tp_assign($4, $8, $8) tp_assign($5, $9, $9) tp_assign($6, $10, $10) tp_assign($7, $11, $11)),\n'\
 158 '       TP_printk()\n'\
 159 ')\n'\
 160 '#endif/g'\
 161         ${TMPFILE} >> ${HEADER}
 162
 163 # types: 4  5  6  7  8
 164 # args   9 10 11 12 13
 165
 166 NRARGS=5
 167 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 168 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 169 'types: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^)]*)\) '\
 170 'args: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^)]*)\)/'\
 171 '#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
 172 'SC_TRACE_EVENT(sys_$1,\n'\
 173 '       TP_PROTO($4 $9, $5 $10, $6 $11, $7 $12, $8 $13),\n'\
 174 '       TP_ARGS($9, $10, $11, $12, $13),\n'\
 175 '       TP_STRUCT__entry(__field($4, $9) __field($5, $10) __field($6, $11) __field($7, $12) __field($8, $13)),\n'\
 176 '       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'\
 177 '       TP_printk()\n'\
 178 ')\n'\
 179 '#endif/g'\
 180         ${TMPFILE} >> ${HEADER}
 181
 182
 183 # types: 4   5  6  7  8  9
 184 # args   10 11 12 13 14 15
 185
 186 NRARGS=6
 187 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 188 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 189 'types: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^\)]*)\) '\
 190 'args: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^\)]*)\)/'\
 191 '#ifndef OVERRIDE_'"${BITNESS}"'_sys_$1\n'\
 192 'SC_TRACE_EVENT(sys_$1,\n'\
 193 '       TP_PROTO($4 $10, $5 $11, $6 $12, $7 $13, $8 $14, $9 $15),\n'\
 194 '       TP_ARGS($10, $11, $12, $13, $14, $15),\n'\
 195 '       TP_STRUCT__entry(__field($4, $10) __field($5, $11) __field($6, $12) __field($7, $13) __field($8, $14) __field($9, $15)),\n'\
 196 '       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'\
 197 '       TP_printk()\n'\
 198 ')\n'\
 199 '#endif/g'\
 200         ${TMPFILE} >> ${HEADER}
 201
 202 # Macro for tracing syscall table
 203
 204 rm -f ${TMPFILE}
 205 for NRARGS in $(seq 0 6); do
 206         grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} >> ${TMPFILE}
 207 done
 208
 209 echo \
 210 "
 211 #endif /*  _TRACE_SYSCALLS_${CLASSCAP}_H */
 212
 213 /* This part must be outside protection */
 214 #include \"../../../probes/define_trace.h\"
 215
 216 #else /* CREATE_SYSCALL_TABLE */
 217
 218 #include \"${INPUTFILE}_${CLASS}_override.h\"
 219 #include \"syscalls_${CLASS}_override.h\"
 220 " >> ${HEADER}
 221
 222 NRARGS=0
 223
 224 if [ "$CLASS" = integers ]; then
 225 #noargs
 226 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 227 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) .*$/'\
 228 '#ifndef OVERRIDE_TABLE_'"${BITNESS}"'_sys_$1\n'\
 229 'TRACE_SYSCALL_TABLE\(syscalls_noargs, sys_$1, $2, $3\)\n'\
 230 '#endif/g'\
 231         ${TMPFILE} >> ${HEADER}
 232 fi
 233
 234 #others.
 235 grep -v "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 236 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) .*$/'\
 237 '#ifndef OVERRIDE_TABLE_'"${BITNESS}"'_sys_$1\n'\
 238 'TRACE_SYSCALL_TABLE(sys_$1, sys_$1, $2, $3)\n'\
 239 '#endif/g'\
 240         ${TMPFILE} >> ${HEADER}
 241
 242 echo -n \
 243 "
 244 #endif /* CREATE_SYSCALL_TABLE */
 245 " >> ${HEADER}
 246
 247 #fields names: ...char * type with *name* or *file* or *path* or *root*
 248 # or *put_old* or *type*
 249 cp -f ${HEADER} ${TMPFILE}
 250 rm -f ${HEADER}
 251 perl -p -e 's/__field\(([^,)]*char \*), ([^\)]*)(name|file|path|root|put_old|type)([^\)]*)\)/__string_from_user($2$3$4, $2$3$4)/g'\
 252         ${TMPFILE} >> ${HEADER}
 253 cp -f ${HEADER} ${TMPFILE}
 254 rm -f ${HEADER}
 255 perl -p -e 's/tp_assign\(([^,)]*char \*), ([^,]*)(name|file|path|root|put_old|type)([^,]*), ([^\)]*)\)/tp_copy_string_from_user($2$3$4, $5)/g'\
 256         ${TMPFILE} >> ${HEADER}
 257
 258 #prettify addresses heuristics.
 259 #field names with addr or ptr
 260 cp -f ${HEADER} ${TMPFILE}
 261 rm -f ${HEADER}
 262 perl -p -e 's/__field\(([^,)]*), ([^,)]*addr|[^,)]*ptr)([^),]*)\)/__field_hex($1, $2$3)/g'\
 263         ${TMPFILE} >> ${HEADER}
 264
 265 #field types ending with '*'
 266 cp -f ${HEADER} ${TMPFILE}
 267 rm -f ${HEADER}
 268 perl -p -e 's/__field\(([^,)]*\*), ([^),]*)\)/__field_hex($1, $2)/g'\
 269         ${TMPFILE} >> ${HEADER}
 270
 271 #strip the extra type information from tp_assign.
 272 cp -f ${HEADER} ${TMPFILE}
 273 rm -f ${HEADER}
 274 perl -p -e 's/tp_assign\(([^,)]*), ([^,]*), ([^\)]*)\)/tp_assign($2, $3)/g'\
 275         ${TMPFILE} >> ${HEADER}
 276
 277 rm -f ${INPUTFILE}.tmp
 278 rm -f ${TMPFILE}
 279 rm -f ${SRCFILE}