1 #!/bin/bash 1 #!/bin/bash
2 # SPDX-License-Identifier: GPL-2.0 <<
3 # 2 #
4 # Translate stack dump function offsets. 3 # Translate stack dump function offsets.
5 # 4 #
6 # addr2line doesn't work with KASLR addresses. 5 # addr2line doesn't work with KASLR addresses. This works similarly to
7 # addr2line, but instead takes the 'func+0x123 6 # addr2line, but instead takes the 'func+0x123' format as input:
8 # 7 #
9 # $ ./scripts/faddr2line ~/k/vmlinux meminfo 8 # $ ./scripts/faddr2line ~/k/vmlinux meminfo_proc_show+0x5/0x568
10 # meminfo_proc_show+0x5/0x568: 9 # meminfo_proc_show+0x5/0x568:
11 # meminfo_proc_show at fs/proc/meminfo.c:27 10 # meminfo_proc_show at fs/proc/meminfo.c:27
12 # 11 #
13 # If the address is part of an inlined functio 12 # If the address is part of an inlined function, the full inline call chain is
14 # printed: 13 # printed:
15 # 14 #
16 # $ ./scripts/faddr2line ~/k/vmlinux native_ 15 # $ ./scripts/faddr2line ~/k/vmlinux native_write_msr+0x6/0x27
17 # native_write_msr+0x6/0x27: 16 # native_write_msr+0x6/0x27:
18 # arch_static_branch at arch/x86/include/asm 17 # arch_static_branch at arch/x86/include/asm/msr.h:121
19 # (inlined by) static_key_false at include/ 18 # (inlined by) static_key_false at include/linux/jump_label.h:125
20 # (inlined by) native_write_msr at arch/x86 19 # (inlined by) native_write_msr at arch/x86/include/asm/msr.h:125
21 # 20 #
22 # The function size after the '/' in the input 21 # The function size after the '/' in the input is optional, but recommended.
23 # It's used to help disambiguate any duplicate 22 # It's used to help disambiguate any duplicate symbol names, which can occur
24 # rarely. If the size is omitted for a duplic 23 # rarely. If the size is omitted for a duplicate symbol then it's possible for
25 # multiple code sites to be printed: 24 # multiple code sites to be printed:
26 # 25 #
27 # $ ./scripts/faddr2line ~/k/vmlinux raw_ioc 26 # $ ./scripts/faddr2line ~/k/vmlinux raw_ioctl+0x5
28 # raw_ioctl+0x5/0x20: 27 # raw_ioctl+0x5/0x20:
29 # raw_ioctl at drivers/char/raw.c:122 28 # raw_ioctl at drivers/char/raw.c:122
30 # 29 #
31 # raw_ioctl+0x5/0xb1: 30 # raw_ioctl+0x5/0xb1:
32 # raw_ioctl at net/ipv4/raw.c:876 31 # raw_ioctl at net/ipv4/raw.c:876
33 # 32 #
34 # Multiple addresses can be specified on a sin 33 # Multiple addresses can be specified on a single command line:
35 # 34 #
36 # $ ./scripts/faddr2line ~/k/vmlinux type_sh 35 # $ ./scripts/faddr2line ~/k/vmlinux type_show+0x10/45 free_reserved_area+0x90
37 # type_show+0x10/0x2d: 36 # type_show+0x10/0x2d:
38 # type_show at drivers/video/backlight/backl 37 # type_show at drivers/video/backlight/backlight.c:213
39 # 38 #
40 # free_reserved_area+0x90/0x123: 39 # free_reserved_area+0x90/0x123:
41 # free_reserved_area at mm/page_alloc.c:6429 40 # free_reserved_area at mm/page_alloc.c:6429 (discriminator 2)
42 41
43 42
44 set -o errexit 43 set -o errexit
45 set -o nounset 44 set -o nounset
46 45
>> 46 command -v awk >/dev/null 2>&1 || die "awk isn't installed"
>> 47 command -v readelf >/dev/null 2>&1 || die "readelf isn't installed"
>> 48 command -v addr2line >/dev/null 2>&1 || die "addr2line isn't installed"
>> 49
47 usage() { 50 usage() {
48 echo "usage: faddr2line [--list] <obje !! 51 echo "usage: faddr2line <object file> <func+offset> <func+offset>..." >&2
49 exit 1 52 exit 1
50 } 53 }
51 54
52 warn() { 55 warn() {
53 echo "$1" >&2 56 echo "$1" >&2
54 } 57 }
55 58
56 die() { 59 die() {
57 echo "ERROR: $1" >&2 60 echo "ERROR: $1" >&2
58 exit 1 61 exit 1
59 } 62 }
60 63
61 UTIL_SUFFIX="" <<
62 if [[ "${LLVM:-}" == "" ]]; then <<
63 UTIL_PREFIX=${CROSS_COMPILE:-} <<
64 else <<
65 UTIL_PREFIX=llvm- <<
66 <<
67 if [[ "${LLVM}" == *"/" ]]; then <<
68 UTIL_PREFIX=${LLVM}${UTIL_PREF <<
69 elif [[ "${LLVM}" == "-"* ]]; then <<
70 UTIL_SUFFIX=${LLVM} <<
71 fi <<
72 fi <<
73 <<
74 READELF="${UTIL_PREFIX}readelf${UTIL_SUFFIX}" <<
75 ADDR2LINE="${UTIL_PREFIX}addr2line${UTIL_SUFFI <<
76 AWK="awk" <<
77 GREP="grep" <<
78 <<
79 command -v ${AWK} >/dev/null 2>&1 || die "${AW <<
80 command -v ${READELF} >/dev/null 2>&1 || die " <<
81 command -v ${ADDR2LINE} >/dev/null 2>&1 || die <<
82 <<
83 # Try to figure out the source directory prefi 64 # Try to figure out the source directory prefix so we can remove it from the
84 # addr2line output. HACK ALERT: This assumes 65 # addr2line output. HACK ALERT: This assumes that start_kernel() is in
85 # init/main.c! This only works for vmlinux. !! 66 # kernel/init.c! This only works for vmlinux. Otherwise it falls back to
86 # printing the absolute path. 67 # printing the absolute path.
87 find_dir_prefix() { 68 find_dir_prefix() {
88 local start_kernel_addr=$(echo "${ELF_ !! 69 local objfile=$1
89 ${AWK} '$8 == "start_kernel" { !! 70
>> 71 local start_kernel_addr=$(readelf -sW $objfile | awk '$8 == "start_kernel" {printf "0x%s", $2}')
90 [[ -z $start_kernel_addr ]] && return 72 [[ -z $start_kernel_addr ]] && return
91 73
92 run_addr2line ${start_kernel_addr} "" !! 74 local file_line=$(addr2line -e $objfile $start_kernel_addr)
93 [[ -z $ADDR2LINE_OUT ]] && return !! 75 [[ -z $file_line ]] && return
94 76
95 local file_line=${ADDR2LINE_OUT#* at } <<
96 if [[ -z $file_line ]] || [[ $file_lin <<
97 return <<
98 fi <<
99 local prefix=${file_line%init/main.c:* 77 local prefix=${file_line%init/main.c:*}
100 if [[ -z $prefix ]] || [[ $prefix = $f 78 if [[ -z $prefix ]] || [[ $prefix = $file_line ]]; then
101 return 79 return
102 fi 80 fi
103 81
104 DIR_PREFIX=$prefix 82 DIR_PREFIX=$prefix
105 return 0 83 return 0
106 } 84 }
107 85
108 run_readelf() { <<
109 local objfile=$1 <<
110 local out=$(${READELF} --file-header - <<
111 <<
112 # This assumes that readelf first prin <<
113 # Note: It seems that GNU readelf does <<
114 # line when multiple options are given <<
115 ELF_FILEHEADER=$(echo "${out}" | sed - <<
116 ELF_SECHEADERS=$(echo "${out}" | sed - <<
117 ELF_SYMS=$(echo "${out}" | sed -n '/Sy <<
118 } <<
119 <<
120 check_vmlinux() { <<
121 # vmlinux uses absolute addresses in t <<
122 # section offsets. <<
123 IS_VMLINUX=0 <<
124 local file_type=$(echo "${ELF_FILEHEAD <<
125 ${AWK} '$1 == "Type:" { print <<
126 if [[ $file_type = "EXEC" ]] || [[ $fi <<
127 IS_VMLINUX=1 <<
128 fi <<
129 } <<
130 <<
131 init_addr2line() { <<
132 local objfile=$1 <<
133 <<
134 check_vmlinux <<
135 <<
136 ADDR2LINE_ARGS="--functions --pretty-p <<
137 if [[ $IS_VMLINUX = 1 ]]; then <<
138 # If the executable file is vm <<
139 # addr2line, so we can launch <<
140 coproc ADDR2LINE_PROC (${ADDR2 <<
141 fi <<
142 } <<
143 <<
144 run_addr2line() { <<
145 local addr=$1 <<
146 local sec_name=$2 <<
147 <<
148 if [[ $IS_VMLINUX = 1 ]]; then <<
149 # We send to the addr2line pro <<
150 # value, i.e., something that <<
151 # (i.e., ","). This causes add <<
152 # our address, then (2) either <<
153 # using binutils' addr2line), <<
154 echo ${addr} >& "${ADDR2LINE_P <<
155 echo "," >& "${ADDR2LINE_PROC[ <<
156 local first_line <<
157 read -r first_line <& "${ADDR2 <<
158 ADDR2LINE_OUT=$(echo "${first_ <<
159 while read -r line <& "${ADDR2 <<
160 if [[ "$line" == "?? ? <<
161 break <<
162 fi <<
163 ADDR2LINE_OUT+=$'\n'$( <<
164 done <<
165 else <<
166 # Run addr2line as a single in <<
167 local sec_arg <<
168 [[ -z $sec_name ]] && sec_arg= <<
169 ADDR2LINE_OUT=$(${ADDR2LINE} $ <<
170 fi <<
171 } <<
172 <<
173 __faddr2line() { 86 __faddr2line() {
174 local objfile=$1 87 local objfile=$1
175 local func_addr=$2 88 local func_addr=$2
176 local dir_prefix=$3 89 local dir_prefix=$3
177 local print_warnings=$4 90 local print_warnings=$4
178 91
179 local sym_name=${func_addr%+*} !! 92 local func=${func_addr%+*}
180 local func_offset=${func_addr#*+} !! 93 local offset=${func_addr#*+}
181 func_offset=${func_offset%/*} !! 94 offset=${offset%/*}
182 local user_size= !! 95 local size=
183 [[ $func_addr =~ "/" ]] && user_size=$ !! 96 [[ $func_addr =~ "/" ]] && size=${func_addr#*/}
184 97
185 if [[ -z $sym_name ]] || [[ -z $func_o !! 98 if [[ -z $func ]] || [[ -z $offset ]] || [[ $func = $func_addr ]]; then
186 warn "bad func+offset $func_ad 99 warn "bad func+offset $func_addr"
187 DONE=1 100 DONE=1
188 return 101 return
189 fi 102 fi
190 103
191 # Go through each of the object's symb 104 # Go through each of the object's symbols which match the func name.
192 # In rare cases there might be duplica !! 105 # In rare cases there might be duplicates.
193 # matches. !! 106 while read symbol; do
194 while read line; do !! 107 local fields=($symbol)
195 local fields=($line) !! 108 local sym_base=0x${fields[1]}
196 local sym_addr=0x${fields[1]} !! 109 local sym_size=${fields[2]}
197 local sym_elf_size=${fields[2] !! 110 local sym_type=${fields[3]}
198 local sym_sec=${fields[6]} <<
199 local sec_size <<
200 local sec_name <<
201 <<
202 # Get the section size: <<
203 sec_size=$(echo "${ELF_SECHEAD <<
204 ${AWK} -v sec=$sym_sec <<
205 <<
206 if [[ -z $sec_size ]]; then <<
207 warn "bad section size <<
208 DONE=1 <<
209 return <<
210 fi <<
211 111
212 # Get the section name: !! 112 # calculate the address
213 sec_name=$(echo "${ELF_SECHEAD !! 113 local addr=$(($sym_base + $offset))
214 ${AWK} -v sec=$sym_sec !! 114 if [[ -z $addr ]] || [[ $addr = 0 ]]; then
215 !! 115 warn "bad address: $sym_base + $offset"
216 if [[ -z $sec_name ]]; then <<
217 warn "bad section name <<
218 DONE=1 <<
219 return <<
220 fi <<
221 <<
222 # Calculate the symbol size. <<
223 # <<
224 # Unfortunately we can't use t <<
225 # also includes the padding by <<
226 # kallsyms, the size calculati <<
227 # symbol and the next symbol i <<
228 local sym_size <<
229 local cur_sym_addr <<
230 local found=0 <<
231 while read line; do <<
232 local fields=($line) <<
233 cur_sym_addr=0x${field <<
234 local cur_sym_elf_size <<
235 local cur_sym_name=${f <<
236 <<
237 # is_mapping_symbol(cu <<
238 if [[ ${cur_sym_name} <<
239 continue <<
240 fi <<
241 <<
242 if [[ $cur_sym_addr = <<
243 [[ $cur_sym_elf_siz <<
244 [[ $cur_sym_name = <<
245 found=1 <<
246 continue <<
247 fi <<
248 <<
249 if [[ $found = 1 ]]; t <<
250 sym_size=$(($c <<
251 [[ $sym_size - <<
252 found=2 <<
253 break <<
254 fi <<
255 done < <(echo "${ELF_SYMS}" | <<
256 <<
257 if [[ $found = 0 ]]; then <<
258 warn "can't find symbo <<
259 DONE=1 <<
260 return <<
261 fi <<
262 <<
263 # If nothing was found after t <<
264 # symbol in the section. <<
265 [[ $found = 1 ]] && sym_size=$ <<
266 <<
267 if [[ -z $sym_size ]] || [[ $s <<
268 warn "bad symbol size: <<
269 DONE=1 116 DONE=1
270 return 117 return
271 fi 118 fi
>> 119 local hexaddr=0x$(printf %x $addr)
272 120
273 sym_size=0x$(printf %x $sym_si !! 121 # weed out non-function symbols
274 !! 122 if [[ $sym_type != "FUNC" ]]; then
275 # Calculate the address from u !! 123 [[ $print_warnings = 1 ]] &&
276 local addr=$(($sym_addr + $fun !! 124 echo "skipping $func address at $hexaddr due to non-function symbol"
277 if [[ -z $addr ]] || [[ $addr !! 125 continue
278 warn "bad address: $sy <<
279 DONE=1 <<
280 return <<
281 fi 126 fi
282 addr=0x$(printf %x $addr) <<
283 127
284 # If the user provided a size, !! 128 # if the user provided a size, make sure it matches the symbol's size
285 if [[ -n $user_size ]] && [[ $ !! 129 if [[ -n $size ]] && [[ $size -ne $sym_size ]]; then
286 [[ $print_warnings = 1 130 [[ $print_warnings = 1 ]] &&
287 echo "skipping !! 131 echo "skipping $func address at $hexaddr due to size mismatch ($size != $sym_size)"
288 continue; 132 continue;
289 fi 133 fi
290 134
291 # Make sure the provided offse !! 135 # make sure the provided offset is within the symbol's range
292 if [[ $func_offset -gt $sym_si !! 136 if [[ $offset -gt $sym_size ]]; then
293 [[ $print_warnings = 1 137 [[ $print_warnings = 1 ]] &&
294 echo "skipping !! 138 echo "skipping $func address at $hexaddr due to size mismatch ($offset > $sym_size)"
295 continue 139 continue
296 fi 140 fi
297 141
298 # In case of duplicates or mul !! 142 # separate multiple entries with a blank line
299 # cmdline, separate multiple e <<
300 [[ $FIRST = 0 ]] && echo 143 [[ $FIRST = 0 ]] && echo
301 FIRST=0 144 FIRST=0
302 145
303 echo "$sym_name+$func_offset/$ !! 146 local hexsize=0x$(printf %x $sym_size)
304 !! 147 echo "$func+$offset/$hexsize:"
305 # Pass section address to addr !! 148 addr2line -fpie $objfile $hexaddr | sed "s; $dir_prefix\(\./\)*; ;"
306 # from the output: <<
307 run_addr2line $addr $sec_name <<
308 local output=$(echo "${ADDR2LI <<
309 [[ -z $output ]] && continue <<
310 <<
311 # Default output (non --list): <<
312 if [[ $LIST = 0 ]]; then <<
313 echo "$output" | while <<
314 do <<
315 echo $line <<
316 done <<
317 DONE=1; <<
318 continue <<
319 fi <<
320 <<
321 # For --list, show each line w <<
322 echo "$output" | while read -r <<
323 do <<
324 echo <<
325 echo $line <<
326 n=$(echo $line | sed ' <<
327 n1=$[$n-5] <<
328 n2=$[$n+5] <<
329 f=$(echo $line | sed ' <<
330 ${AWK} 'NR>=strtonum(" <<
331 done <<
332 <<
333 DONE=1 149 DONE=1
334 150
335 done < <(echo "${ELF_SYMS}" | sed 's/\ !! 151 done < <(readelf -sW $objfile | awk -v f=$func '$8 == f {print}')
336 } 152 }
337 153
338 [[ $# -lt 2 ]] && usage 154 [[ $# -lt 2 ]] && usage
339 155
340 objfile=$1 156 objfile=$1
341 <<
342 LIST=0 <<
343 [[ "$objfile" == "--list" ]] && LIST=1 && shif <<
344 <<
345 [[ ! -f $objfile ]] && die "can't find objfile 157 [[ ! -f $objfile ]] && die "can't find objfile $objfile"
346 shift 158 shift
347 159
348 run_readelf $objfile <<
349 <<
350 echo "${ELF_SECHEADERS}" | ${GREP} -q '\.debug <<
351 <<
352 init_addr2line $objfile <<
353 <<
354 DIR_PREFIX=supercalifragilisticexpialidocious 160 DIR_PREFIX=supercalifragilisticexpialidocious
355 find_dir_prefix !! 161 find_dir_prefix $objfile
356 162
357 FIRST=1 163 FIRST=1
358 while [[ $# -gt 0 ]]; do 164 while [[ $# -gt 0 ]]; do
359 func_addr=$1 165 func_addr=$1
360 shift 166 shift
361 167
362 # print any matches found 168 # print any matches found
363 DONE=0 169 DONE=0
364 __faddr2line $objfile $func_addr $DIR_ 170 __faddr2line $objfile $func_addr $DIR_PREFIX 0
365 171
366 # if no match was found, print warning 172 # if no match was found, print warnings
367 if [[ $DONE = 0 ]]; then 173 if [[ $DONE = 0 ]]; then
368 __faddr2line $objfile $func_ad 174 __faddr2line $objfile $func_addr $DIR_PREFIX 1
369 warn "no match for $func_addr" 175 warn "no match for $func_addr"
370 fi 176 fi
371 done 177 done
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.