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