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 #undef TRACE_SYSTEM
  49 #define TRACE_SYSTEM syscalls_${CLASS}
  50
  51 #if !defined(_TRACE_SYSCALLS_${CLASSCAP}_H) || defined(TRACE_HEADER_MULTI_READ)
  52 #define _TRACE_SYSCALLS_${CLASSCAP}_H
  53
  54 #include <linux/tracepoint.h>
  55 #include <linux/syscalls.h>
  56 #include \"${INPUTFILE}_${CLASS}_override.h\"
  57 " >> ${HEADER}
  58
  59 if [ "$CLASS" = integers ]; then
  60
  61 NRARGS=0
  62
  63 echo \
  64 'DECLARE_EVENT_CLASS_NOARGS(syscalls_noargs,\n'\
  65 '       TP_STRUCT__entry(),\n'\
  66 '       TP_fast_assign(),\n'\
  67 '       TP_printk()\n'\
  68 ')'\
  69         >> ${HEADER}
  70
  71 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
  72 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
  73 'types: \(([^)]*)\) '\
  74 'args: \(([^)]*)\)/'\
  75 '#ifndef OVERRIDE_sys_$1\n'\
  76 'DEFINE_EVENT_NOARGS(syscalls_noargs, sys_$1)\n'\
  77 '#endif/g'\
  78         ${TMPFILE} >> ${HEADER}
  79
  80 fi
  81
  82
  83 # types: 4
  84 # args   5
  85
  86 NRARGS=1
  87 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
  88 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
  89 'types: \(([^)]*)\) '\
  90 'args: \(([^)]*)\)/'\
  91 '#ifndef OVERRIDE_sys_$1\n'\
  92 'TRACE_EVENT(sys_$1,\n'\
  93 '       TP_PROTO($4 $5),\n'\
  94 '       TP_ARGS($5),\n'\
  95 '       TP_STRUCT__entry(__field($4, $5)),\n'\
  96 '       TP_fast_assign(tp_assign($5, $5)),\n'\
  97 '       TP_printk()\n'\
  98 ')\n'\
  99 '#endif/g'\
 100         ${TMPFILE} >> ${HEADER}
 101
 102 # types: 4 5
 103 # args   6 7
 104
 105 NRARGS=2
 106 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 107 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 108 'types: \(([^,]*), ([^)]*)\) '\
 109 'args: \(([^,]*), ([^)]*)\)/'\
 110 '#ifndef OVERRIDE_sys_$1\n'\
 111 'TRACE_EVENT(sys_$1,\n'\
 112 '       TP_PROTO($4 $6, $5 $7),\n'\
 113 '       TP_ARGS($6, $7),\n'\
 114 '       TP_STRUCT__entry(__field($4, $6) __field($5, $7)),\n'\
 115 '       TP_fast_assign(tp_assign($6, $6) tp_assign($7, $7)),\n'\
 116 '       TP_printk()\n'\
 117 ')\n'\
 118 '#endif/g'\
 119         ${TMPFILE} >> ${HEADER}
 120
 121 # types: 4 5 6
 122 # args   7 8 9
 123
 124 NRARGS=3
 125 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 126 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 127 'types: \(([^,]*), ([^,]*), ([^)]*)\) '\
 128 'args: \(([^,]*), ([^,]*), ([^)]*)\)/'\
 129 '#ifndef OVERRIDE_sys_$1\n'\
 130 'TRACE_EVENT(sys_$1,\n'\
 131 '       TP_PROTO($4 $7, $5 $8, $6 $9),\n'\
 132 '       TP_ARGS($7, $8, $9),\n'\
 133 '       TP_STRUCT__entry(__field($4, $7) __field($5, $8) __field($6, $9)),\n'\
 134 '       TP_fast_assign(tp_assign($7, $7) tp_assign($8, $8) tp_assign($9, $9)),\n'\
 135 '       TP_printk()\n'\
 136 ')\n'\
 137 '#endif/g'\
 138         ${TMPFILE} >> ${HEADER}
 139
 140
 141 # types: 4 5  6  7
 142 # args   8 9 10 11
 143
 144 NRARGS=4
 145 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 146 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 147 'types: \(([^,]*), ([^,]*), ([^,]*), ([^)]*)\) '\
 148 'args: \(([^,]*), ([^,]*), ([^,]*), ([^)]*)\)/'\
 149 '#ifndef OVERRIDE_sys_$1\n'\
 150 'TRACE_EVENT(sys_$1,\n'\
 151 '       TP_PROTO($4 $8, $5 $9, $6 $10, $7 $11),\n'\
 152 '       TP_ARGS($8, $9, $10, $11),\n'\
 153 '       TP_STRUCT__entry(__field($4, $8) __field($5, $9) __field($6, $10) __field($7, $11)),\n'\
 154 '       TP_fast_assign(tp_assign($8, $8) tp_assign($9, $9) tp_assign($10, $10) tp_assign($11, $11)),\n'\
 155 '       TP_printk()\n'\
 156 ')\n'\
 157 '#endif/g'\
 158         ${TMPFILE} >> ${HEADER}
 159
 160 # types: 4  5  6  7  8
 161 # args   9 10 11 12 13
 162
 163 NRARGS=5
 164 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 165 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 166 'types: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^)]*)\) '\
 167 'args: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^)]*)\)/'\
 168 '#ifndef OVERRIDE_sys_$1\n'\
 169 'TRACE_EVENT(sys_$1,\n'\
 170 '       TP_PROTO($4 $9, $5 $10, $6 $11, $7 $12, $8 $13),\n'\
 171 '       TP_ARGS($9, $10, $11, $12, $13),\n'\
 172 '       TP_STRUCT__entry(__field($4, $9) __field($5, $10) __field($6, $11) __field($7, $12) __field($8, $13)),\n'\
 173 '       TP_fast_assign(tp_assign($9, $9) tp_assign($10, $10) tp_assign($11, $11) tp_assign($12, $12) tp_assign($13, $13)),\n'\
 174 '       TP_printk()\n'\
 175 ')\n'\
 176 '#endif/g'\
 177         ${TMPFILE} >> ${HEADER}
 178
 179
 180 # types: 4   5  6  7  8  9
 181 # args   10 11 12 13 14 15
 182
 183 NRARGS=6
 184 grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} > ${TMPFILE}
 185 perl -p -e 's/^syscall ([^ ]*) nr ([^ ]*) nbargs ([^ ]*) '\
 186 'types: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^\)]*)\) '\
 187 'args: \(([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^,]*), ([^\)]*)\)/'\
 188 '#ifndef OVERRIDE_sys_$1\n'\
 189 'TRACE_EVENT(sys_$1,\n'\
 190 '       TP_PROTO($4 $10, $5 $11, $6 $12, $7 $13, $8 $14, $9 $15),\n'\
 191 '       TP_ARGS($10, $11, $12, $13, $14, $15),\n'\
 192 '       TP_STRUCT__entry(__field($4, $10) __field($5, $11) __field($6, $12) __field($7, $13) __field($8, $14) __field($9, $15)),\n'\
 193 '       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'\
 194 '       TP_printk()\n'\
 195 ')\n'\
 196 '#endif/g'\
 197         ${TMPFILE} >> ${HEADER}
 198
 199 # Macro for tracing syscall table
 200
 201 rm -f ${TMPFILE}
 202 for NRARGS in $(seq 0 6); do
 203         grep "^syscall [^ ]* nr [^ ]* nbargs ${NRARGS} " ${SRCFILE} >> ${TMPFILE}
 204 done
 205
 206 echo \
 207 "
 208 #endif /*  _TRACE_SYSCALLS_${CLASSCAP}_H */
 209
 210 /* This part must be outside protection */
 211 #include \"../../../probes/define_trace.h\"
 212
 213 #else /* CREATE_SYSCALL_TABLE */
 214
 215 #include \"${INPUTFILE}_${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_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_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 #prettify addresses heuristics.
 244 cp -f ${HEADER} ${TMPFILE}
 245 rm -f ${HEADER}
 246
 247 #field names with addr or ptr
 248 perl -p -e 's/__field\(([^,)]*), ([^a,)]*addr|[^p,)]*ptr)([^),]*)\)/__field_hex($1, $2$3)/g'\
 249         ${TMPFILE} >> ${HEADER}
 250
 251 #fields names: filename or pathname
 252 cp -f ${HEADER} ${TMPFILE}
 253 rm -f ${HEADER}
 254 perl -p -e 's/__field\(([^,)]*), (filename|pathname)\)/__string($2, $2)/g'\
 255         ${TMPFILE} >> ${HEADER}
 256 cp -f ${HEADER} ${TMPFILE}
 257 rm -f ${HEADER}
 258 perl -p -e 's/tp_assign\((filename|pathname), (filename|pathname)\)/tp_copy_string_from_user($1, $2)/g'\
 259         ${TMPFILE} >> ${HEADER}
 260
 261 cp -f ${HEADER} ${TMPFILE}
 262 rm -f ${HEADER}
 263
 264 #field types ending with '*'
 265 perl -p -e 's/__field\(([^,)]*\*), ([^),]*)\)/__field_hex($1, $2)/g'\
 266         ${TMPFILE} >> ${HEADER}
 267
 268
 269 rm -f ${INPUTFILE}.tmp
 270 rm -f ${TMPFILE}
 271 rm -f ${SRCFILE}