scripts/decode_stacktrace.sh

   1 #!/bin/bash
   2 # SPDX-License-Identifier: GPL-2.0
   3 # (c) 2014, Sasha Levin <sasha.levin@oracle.com>
   4 #set -x
   5
   6 if [[ $# < 2 ]]; then
   7         echo "Usage:"
   8         echo "  $0 [vmlinux] [base path] [modules path]"
   9         exit 1
  10 fi
  11
  12 vmlinux=$1
  13 basepath=$2
  14 modpath=$3
  15 declare -A cache
  16 declare -A modcache
  17
  18 parse_symbol() {
  19         # The structure of symbol at this point is:
  20         #   ([name]+[offset]/[total length])
  21         #
  22         # For example:
  23         #   do_basic_setup+0x9c/0xbf
  24
  25         if [[ $module == "" ]] ; then
  26                 local objfile=$vmlinux
  27         elif [[ "${modcache[$module]+isset}" == "isset" ]]; then
  28                 local objfile=${modcache[$module]}
  29         else
  30                 if [[ $modpath == "" ]]; then
  31                         echo "WARNING! Modules path isn't set, but is needed to parse this symbol" >&2
  32                         return
  33                 fi
  34                 local objfile=$(find "$modpath" -name "${module//_/[-_]}.ko*" -print -quit)
  35                 [[ $objfile == "" ]] && return
  36                 modcache[$module]=$objfile
  37         fi
  38
  39         # Remove the englobing parenthesis
  40         symbol=${symbol#\(}
  41         symbol=${symbol%\)}
  42
  43         # Strip segment
  44         local segment
  45         if [[ $symbol == *:* ]] ; then
  46                 segment=${symbol%%:*}:
  47                 symbol=${symbol#*:}
  48         fi
  49
  50         # Strip the symbol name so that we could look it up
  51         local name=${symbol%+*}
  52
  53         # Use 'nm vmlinux' to figure out the base address of said symbol.
  54         # It's actually faster to call it every time than to load it
  55         # all into bash.
  56         if [[ "${cache[$module,$name]+isset}" == "isset" ]]; then
  57                 local base_addr=${cache[$module,$name]}
  58         else
  59                 local base_addr=$(nm "$objfile" | grep -i ' t ' | awk "/ $name\$/ {print \$1}" | head -n1)
  60                 cache[$module,$name]="$base_addr"
  61         fi
  62         # Let's start doing the math to get the exact address into the
  63         # symbol. First, strip out the symbol total length.
  64         local expr=${symbol%/*}
  65
  66         # Now, replace the symbol name with the base address we found
  67         # before.
  68         expr=${expr/$name/0x$base_addr}
  69
  70         # Evaluate it to find the actual address
  71         expr=$((expr))
  72         local address=$(printf "%x\n" "$expr")
  73
  74         # Pass it to addr2line to get filename and line number
  75         # Could get more than one result
  76         if [[ "${cache[$module,$address]+isset}" == "isset" ]]; then
  77                 local code=${cache[$module,$address]}
  78         else
  79                 local code=$(${CROSS_COMPILE}addr2line -i -e "$objfile" "$address")
  80                 cache[$module,$address]=$code
  81         fi
  82
  83         # addr2line doesn't return a proper error code if it fails, so
  84         # we detect it using the value it prints so that we could preserve
  85         # the offset/size into the function and bail out
  86         if [[ $code == "??:0" ]]; then
  87                 return
  88         fi
  89
  90         # Strip out the base of the path
  91         code=${code#$basepath/}
  92
  93         # In the case of inlines, move everything to same line
  94         code=${code//$'\n'/' '}
  95
  96         # Replace old address with pretty line numbers
  97         symbol="$segment$name ($code)"
  98 }
  99
 100 decode_code() {
 101         local scripts=`dirname "${BASH_SOURCE[0]}"`
 102
 103         echo "$1" | $scripts/decodecode
 104 }
 105
 106 handle_line() {
 107         local words
 108
 109         # Tokenize
 110         read -a words <<<"$1"
 111
 112         # Remove hex numbers. Do it ourselves until it happens in the
 113         # kernel
 114
 115         # We need to know the index of the last element before we
 116         # remove elements because arrays are sparse
 117         local last=$(( ${#words[@]} - 1 ))
 118
 119         for i in "${!words[@]}"; do
 120                 # Remove the address
 121                 if [[ ${words[$i]} =~ \[\<([^]]+)\>\] ]]; then
 122                         unset words[$i]
 123                 fi
 124
 125                 # Format timestamps with tabs
 126                 if [[ ${words[$i]} == \[ && ${words[$i+1]} == *\] ]]; then
 127                         unset words[$i]
 128                         words[$i+1]=$(printf "[%13s\n" "${words[$i+1]}")
 129                 fi
 130         done
 131
 132         if [[ ${words[$last]} =~ \[([^]]+)\] ]]; then
 133                 module=${words[$last]}
 134                 module=${module#\[}
 135                 module=${module%\]}
 136                 symbol=${words[$last-1]}
 137                 unset words[$last-1]
 138         else
 139                 # The symbol is the last element, process it
 140                 symbol=${words[$last]}
 141                 module=
 142         fi
 143
 144         unset words[$last]
 145         parse_symbol # modifies $symbol
 146
 147         # Add up the line number to the symbol
 148         echo "${words[@]}" "$symbol $module"
 149 }
 150
 151 while read line; do
 152         # Let's see if we have an address in the line
 153         if [[ $line =~ \[\<([^]]+)\>\] ]] ||
 154            [[ $line =~ [^+\ ]+\+0x[0-9a-f]+/0x[0-9a-f]+ ]]; then
 155                 # Translate address to line numbers
 156                 handle_line "$line"
 157         # Is it a code line?
 158         elif [[ $line == *Code:* ]]; then
 159                 decode_code "$line"
 160         else
 161                 # Nothing special in this line, show it as is
 162                 echo "$line"
 163         fi
 164 done