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

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