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