Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 | #!/usr/bin/env python3
# SPDX-License-Identifier: BSD-2-Clause
#
# Copyright (c) 2017, Linaro Limited
#
import argparse
import errno
import glob
import os
import re
import subprocess
import sys
import termios
CALL_STACK_RE = re.compile('Call stack:')
TEE_LOAD_ADDR_RE = re.compile(r'TEE load address @ (?P<load_addr>0x[0-9a-f]+)')
# This gets the address from lines looking like this:
# E/TC:0 0x001044a8
STACK_ADDR_RE = re.compile(
r'[UEIDFM]/(TC|LD):([0-9]+ )?(\?*|[0-9]*) [0-9]* +(?P<addr>0x[0-9a-f]+)')
ABORT_ADDR_RE = re.compile(r'-abort at address (?P<addr>0x[0-9a-f]+)')
TA_PANIC_RE = re.compile(r'TA panicked with code (?P<code>0x[0-9a-f]+)')
REGION_RE = re.compile(r'region +[0-9]+: va (?P<addr>0x[0-9a-f]+) '
r'pa 0x[0-9a-f]+ size (?P<size>0x[0-9a-f]+)'
r'( flags .{4} (\[(?P<elf_idx>[0-9]+)\])?)?')
ELF_LIST_RE = re.compile(r'\[(?P<idx>[0-9]+)\] (?P<uuid>[0-9a-f\-]+)'
r' @ (?P<load_addr>0x[0-9a-f\-]+)')
FUNC_GRAPH_RE = re.compile(r'Function graph')
GRAPH_ADDR_RE = re.compile(r'(?P<addr>0x[0-9a-f]+)')
GRAPH_RE = re.compile(r'}')
epilog = '''
This scripts reads an OP-TEE abort or panic message from stdin and adds debug
information to the output, such as '<function> at <file>:<line>' next to each
address in the call stack. Any message generated by OP-TEE and containing a
call stack can in principle be processed by this script. This currently
includes aborts and panics from the TEE core as well as from any TA.
The paths provided on the command line are used to locate the appropriate ELF
binary (tee.elf or Trusted Application). The GNU binutils (addr2line, objdump,
nm) are used to extract the debug info. If the CROSS_COMPILE environment
variable is set, it is used as a prefix to the binutils tools. That is, the
script will invoke $(CROSS_COMPILE)addr2line etc. If it is not set however,
the prefix will be determined automatically for each ELF file based on its
architecture. The resulting command is then expected to be found in the user's
PATH.
OP-TEE abort and panic messages are sent to the secure console. They look like
the following:
E/TC:0 User TA data-abort at address 0xffffdecd (alignment fault)
...
E/TC:0 Call stack:
E/TC:0 0x4000549e
E/TC:0 0x40001f4b
E/TC:0 0x4000273f
E/TC:0 0x40005da7
Inspired by a script of the same name by the Chromium project.
Sample usage:
$ scripts/symbolize.py -d out/arm-plat-hikey/core -d ../optee_test/out/ta/*
<paste whole dump here>
^D
Also, this script reads function graph generated for OP-TEE user TA from
/tmp/ftrace-<ta_uuid>.out file and resolves function addresses to corresponding
symbols.
Sample usage:
$ cat /tmp/ftrace-<ta_uuid>.out | scripts/symbolize.py -d <ta_uuid>.elf
<paste function graph here>
^D
'''
tee_result_names = {
'0xf0100001': 'TEE_ERROR_CORRUPT_OBJECT',
'0xf0100002': 'TEE_ERROR_CORRUPT_OBJECT_2',
'0xf0100003': 'TEE_ERROR_STORAGE_NOT_AVAILABLE',
'0xf0100004': 'TEE_ERROR_STORAGE_NOT_AVAILABLE_2',
'0xf0100006': 'TEE_ERROR_CIPHERTEXT_INVALID ',
'0xffff0000': 'TEE_ERROR_GENERIC',
'0xffff0001': 'TEE_ERROR_ACCESS_DENIED',
'0xffff0002': 'TEE_ERROR_CANCEL',
'0xffff0003': 'TEE_ERROR_ACCESS_CONFLICT',
'0xffff0004': 'TEE_ERROR_EXCESS_DATA',
'0xffff0005': 'TEE_ERROR_BAD_FORMAT',
'0xffff0006': 'TEE_ERROR_BAD_PARAMETERS',
'0xffff0007': 'TEE_ERROR_BAD_STATE',
'0xffff0008': 'TEE_ERROR_ITEM_NOT_FOUND',
'0xffff0009': 'TEE_ERROR_NOT_IMPLEMENTED',
'0xffff000a': 'TEE_ERROR_NOT_SUPPORTED',
'0xffff000b': 'TEE_ERROR_NO_DATA',
'0xffff000c': 'TEE_ERROR_OUT_OF_MEMORY',
'0xffff000d': 'TEE_ERROR_BUSY',
'0xffff000e': 'TEE_ERROR_COMMUNICATION',
'0xffff000f': 'TEE_ERROR_SECURITY',
'0xffff0010': 'TEE_ERROR_SHORT_BUFFER',
'0xffff0011': 'TEE_ERROR_EXTERNAL_CANCEL',
'0xffff300f': 'TEE_ERROR_OVERFLOW',
'0xffff3024': 'TEE_ERROR_TARGET_DEAD',
'0xffff3041': 'TEE_ERROR_STORAGE_NO_SPACE',
'0xffff3071': 'TEE_ERROR_MAC_INVALID',
'0xffff3072': 'TEE_ERROR_SIGNATURE_INVALID',
'0xffff5000': 'TEE_ERROR_TIME_NOT_SET',
'0xffff5001': 'TEE_ERROR_TIME_NEEDS_RESET',
}
def get_args():
parser = argparse.ArgumentParser(
formatter_class=argparse.RawDescriptionHelpFormatter,
description='Symbolizes OP-TEE abort dumps or function graphs',
epilog=epilog)
parser.add_argument('-d', '--dir', action='append', nargs='+',
help='Search for ELF file in DIR. tee.elf is needed '
'to decode a TEE Core or pseudo-TA abort, while '
'<TA_uuid>.elf is required if a user-mode TA has '
'crashed. For convenience, ELF files may also be '
'given.')
parser.add_argument('-s', '--strip_path', nargs='?',
help='Strip STRIP_PATH from file paths (default: '
'current directory, use -s with no argument to show '
'full paths)', default=os.getcwd())
return parser.parse_args()
class Symbolizer(object):
def __init__(self, out, dirs, strip_path):
self._out = out
self._dirs = dirs
self._strip_path = strip_path
self._addr2line = None
self.reset()
def my_Popen(self, cmd):
try:
return subprocess.Popen(cmd, stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
universal_newlines=True,
bufsize=1)
except OSError as e:
if e.errno == errno.ENOENT:
print("*** Error:{}: command not found".format(cmd[0]),
file=sys.stderr)
sys.exit(1)
def get_elf(self, elf_or_uuid):
if not elf_or_uuid.endswith('.elf'):
elf_or_uuid += '.elf'
for d in self._dirs:
if d.endswith(elf_or_uuid) and os.path.isfile(d):
return d
elf = glob.glob(d + '/' + elf_or_uuid)
if elf:
return elf[0]
def set_arch(self, elf):
self._arch = os.getenv('CROSS_COMPILE')
if self._arch:
return
p = subprocess.Popen(['file', '-L', elf], stdout=subprocess.PIPE)
output = p.stdout.readlines()
p.terminate()
if b'ARM aarch64,' in output[0]:
self._arch = 'aarch64-linux-gnu-'
elif b'ARM,' in output[0]:
self._arch = 'arm-linux-gnueabihf-'
elif b'RISC-V,' in output[0]:
if b'32-bit' in output[0]:
self._arch = 'riscv32-unknown-linux-gnu-'
elif b'64-bit' in output[0]:
self._arch = 'riscv64-unknown-linux-gnu-'
def arch_prefix(self, cmd, elf):
self.set_arch(elf)
if self._arch is None:
return ''
return self._arch + cmd
def spawn_addr2line(self, elf_name):
if elf_name is None:
return
if self._addr2line_elf_name is elf_name:
return
if self._addr2line:
self._addr2line.terminate
self._addr2line = None
elf = self.get_elf(elf_name)
if not elf:
return
cmd = self.arch_prefix('addr2line', elf)
if not cmd:
return
self._addr2line = self.my_Popen([cmd, '-f', '-p', '-e', elf])
self._addr2line_elf_name = elf_name
# If addr falls into a region that maps a TA ELF file, return the load
# address of that file.
def elf_load_addr(self, addr):
if self._regions:
for r in self._regions:
r_addr = int(r[0], 16)
r_size = int(r[1], 16)
i_addr = int(addr, 16)
if (i_addr >= r_addr and i_addr < (r_addr + r_size)):
# Found region
elf_idx = r[2]
if elf_idx is not None:
return self._elfs[int(elf_idx)][1]
# In case address is not found in TA ELF file, fallback to tee.elf
# especially to symbolize mixed (user-space and kernel) addresses
# which is true when syscall ftrace is enabled along with TA
# ftrace.
return self._tee_load_addr
else:
# tee.elf
return self._tee_load_addr
def elf_for_addr(self, addr):
l_addr = self.elf_load_addr(addr)
if l_addr == self._tee_load_addr:
return 'tee.elf'
for k in self._elfs:
e = self._elfs[k]
if int(e[1], 16) == int(l_addr, 16):
return e[0]
return None
def subtract_load_addr(self, addr):
l_addr = self.elf_load_addr(addr)
if l_addr is None:
return None
if int(l_addr, 16) > int(addr, 16):
return ''
return '0x{:x}'.format(int(addr, 16) - int(l_addr, 16))
def resolve(self, addr):
reladdr = self.subtract_load_addr(addr)
self.spawn_addr2line(self.elf_for_addr(addr))
if not reladdr or not self._addr2line:
return '???'
if self.elf_for_addr(addr) == 'tee.elf':
reladdr = '0x{:x}'.format(int(reladdr, 16) +
int(self.first_vma('tee.elf'), 16))
try:
print(reladdr, file=self._addr2line.stdin)
ret = self._addr2line.stdout.readline().rstrip('\n')
except IOError:
ret = '!!!'
return ret
def symbol_plus_offset(self, addr):
ret = ''
prevsize = 0
reladdr = self.subtract_load_addr(addr)
elf_name = self.elf_for_addr(addr)
if elf_name is None:
return ''
elf = self.get_elf(elf_name)
if elf is None:
return ''
cmd = self.arch_prefix('nm', elf)
if not reladdr or not elf or not cmd:
return ''
ireladdr = int(reladdr, 16)
nm = self.my_Popen([cmd, '--numeric-sort', '--print-size', elf])
for line in iter(nm.stdout.readline, ''):
try:
addr, size, _, name = line.split()
except ValueError:
# Size is missing
try:
addr, _, name = line.split()
size = '0'
except ValueError:
# E.g., undefined (external) symbols (line = "U symbol")
continue
iaddr = int(addr, 16)
isize = int(size, 16)
if iaddr == ireladdr:
ret = name
break
if iaddr < ireladdr and iaddr + isize >= ireladdr:
offs = ireladdr - iaddr
ret = name + '+' + str(offs)
break
if iaddr > ireladdr and prevsize == 0:
offs = iaddr + ireladdr
ret = prevname + '+' + str(offs)
break
prevsize = size
prevname = name
nm.terminate()
return ret
def section_plus_offset(self, addr):
ret = ''
reladdr = self.subtract_load_addr(addr)
elf_name = self.elf_for_addr(addr)
if elf_name is None:
return ''
elf = self.get_elf(elf_name)
if elf is None:
return ''
cmd = self.arch_prefix('objdump', elf)
if not reladdr or not elf or not cmd:
return ''
iaddr = int(reladdr, 16)
objdump = self.my_Popen([cmd, '--section-headers', elf])
for line in iter(objdump.stdout.readline, ''):
try:
idx, name, size, vma, lma, offs, algn = line.split()
except ValueError:
continue
ivma = int(vma, 16)
isize = int(size, 16)
if ivma == iaddr:
ret = name
break
if ivma < iaddr and ivma + isize >= iaddr:
offs = iaddr - ivma
ret = name + '+' + str(offs)
break
objdump.terminate()
return ret
def process_abort(self, line):
ret = ''
match = re.search(ABORT_ADDR_RE, line)
addr = match.group('addr')
pre = match.start('addr')
post = match.end('addr')
sym = self.symbol_plus_offset(addr)
sec = self.section_plus_offset(addr)
if sym or sec:
ret += line[:pre]
ret += addr
if sym:
ret += ' ' + sym
if sec:
ret += ' ' + sec
ret += line[post:]
return ret
# Return all ELF sections with the ALLOC flag
def read_sections(self, elf_name):
if elf_name is None:
return
if elf_name in self._sections:
return
elf = self.get_elf(elf_name)
if not elf:
return
cmd = self.arch_prefix('objdump', elf)
if not elf or not cmd:
return
self._sections[elf_name] = []
objdump = self.my_Popen([cmd, '--section-headers', elf])
for line in iter(objdump.stdout.readline, ''):
try:
_, name, size, vma, _, _, _ = line.split()
except ValueError:
if 'ALLOC' in line:
self._sections[elf_name].append([name, int(vma, 16),
int(size, 16)])
def first_vma(self, elf_name):
self.read_sections(elf_name)
return '0x{:x}'.format(self._sections[elf_name][0][1])
def overlaps(self, section, addr, size):
sec_addr = section[1]
sec_size = section[2]
if not size or not sec_size:
return False
return ((addr <= (sec_addr + sec_size - 1)) and
((addr + size - 1) >= sec_addr))
def sections_in_region(self, addr, size, elf_idx):
ret = ''
addr = self.subtract_load_addr(addr)
if not addr:
return ''
iaddr = int(addr, 16)
isize = int(size, 16)
elf = self._elfs[int(elf_idx)][0]
if elf is None:
return ''
self.read_sections(elf)
if elf not in self._sections:
return ''
for s in self._sections[elf]:
if self.overlaps(s, iaddr, isize):
ret += ' ' + s[0]
return ret
def reset(self):
self._call_stack_found = False
if self._addr2line:
self._addr2line.terminate()
self._addr2line = None
self._addr2line_elf_name = None
self._arch = None
self._saved_abort_line = ''
self._sections = {} # {elf_name: [[name, addr, size], ...], ...}
self._regions = [] # [[addr, size, elf_idx, saved line], ...]
self._elfs = {0: ["tee.elf", 0]} # {idx: [uuid, load_addr], ...}
self._tee_load_addr = '0x0'
self._func_graph_found = False
self._func_graph_skip_line = True
def pretty_print_path(self, path):
if self._strip_path:
return re.sub(re.escape(self._strip_path) + '/*', '', path)
return path
def write(self, line):
if self._call_stack_found:
match = re.search(STACK_ADDR_RE, line)
if match:
addr = match.group('addr')
pre = match.start('addr')
post = match.end('addr')
self._out.write(line[:pre])
self._out.write(addr)
# The call stack contains return addresses (LR/ELR values).
# Heuristic: subtract 2 to obtain the call site of the function
# or the location of the exception. This value works for A64,
# A32 as well as Thumb.
pc = 0
lr = int(addr, 16)
if lr:
pc = lr - 2
res = self.resolve('0x{:x}'.format(pc))
res = self.pretty_print_path(res)
self._out.write(' ' + res)
self._out.write(line[post:])
return
else:
self.reset()
if self._func_graph_found:
match = re.search(GRAPH_ADDR_RE, line)
match_re = re.search(GRAPH_RE, line)
if match:
addr = match.group('addr')
pre = match.start('addr')
post = match.end('addr')
self._out.write(line[:pre])
res = self.resolve(addr)
res_arr = re.split(' ', res)
self._out.write(res_arr[0])
self._out.write(line[post:])
self._func_graph_skip_line = False
return
elif match_re:
self._out.write(line)
return
elif self._func_graph_skip_line:
return
else:
self.reset()
match = re.search(REGION_RE, line)
if match:
# Region table: save info for later processing once
# we know which UUID corresponds to which ELF index
addr = match.group('addr')
size = match.group('size')
elf_idx = match.group('elf_idx')
self._regions.append([addr, size, elf_idx, line])
return
match = re.search(ELF_LIST_RE, line)
if match:
# ELF list: save info for later. Region table and ELF list
# will be displayed when the call stack is reached
i = int(match.group('idx'))
self._elfs[i] = [match.group('uuid'), match.group('load_addr'),
line]
return
match = re.search(TA_PANIC_RE, line)
if match:
code = match.group('code')
if code in tee_result_names:
line = line.strip() + ' (' + tee_result_names[code] + ')\n'
self._out.write(line)
return
match = re.search(TEE_LOAD_ADDR_RE, line)
if match:
self._tee_load_addr = match.group('load_addr')
match = re.search(CALL_STACK_RE, line)
if match:
self._call_stack_found = True
if self._regions:
for r in self._regions:
r_addr = r[0]
r_size = r[1]
elf_idx = r[2]
saved_line = r[3]
if elf_idx is None:
self._out.write(saved_line)
else:
self._out.write(saved_line.strip() +
self.sections_in_region(r_addr,
r_size,
elf_idx) +
'\n')
if self._elfs:
for k in self._elfs:
e = self._elfs[k]
if (len(e) >= 3):
# TA executable or library
self._out.write(e[2].strip())
elf = self.get_elf(e[0])
if elf:
rpath = os.path.realpath(elf)
path = self.pretty_print_path(rpath)
self._out.write(' (' + path + ')')
self._out.write('\n')
# Here is a good place to resolve the abort address because we
# have all the information we need
if self._saved_abort_line:
self._out.write(self.process_abort(self._saved_abort_line))
match = re.search(FUNC_GRAPH_RE, line)
if match:
self._func_graph_found = True
match = re.search(ABORT_ADDR_RE, line)
if match:
self.reset()
# At this point the arch and TA load address are unknown.
# Save the line so We can translate the abort address later.
self._saved_abort_line = line
self._out.write(line)
def flush(self):
self._out.flush()
def main():
args = get_args()
if args.dir:
# Flatten list in case -d is used several times *and* with multiple
# arguments
args.dirs = [item for sublist in args.dir for item in sublist]
else:
args.dirs = []
symbolizer = Symbolizer(sys.stdout, args.dirs, args.strip_path)
fd = sys.stdin.fileno()
isatty = os.isatty(fd)
if isatty:
old = termios.tcgetattr(fd)
new = termios.tcgetattr(fd)
new[3] = new[3] & ~termios.ECHO # lflags
try:
if isatty:
termios.tcsetattr(fd, termios.TCSADRAIN, new)
for line in sys.stdin:
symbolizer.write(line)
finally:
symbolizer.flush()
if isatty:
termios.tcsetattr(fd, termios.TCSADRAIN, old)
if __name__ == "__main__":
main()
|