Mike Frysinger | e58c0e2 | 2017-10-04 15:43:30 -0400 | [diff] [blame] | 1 | # -*- coding: utf-8 -*- |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 2 | # Copyright 2014 The Chromium OS Authors. All rights reserved. |
| 3 | # Use of this source code is governed by a BSD-style license that can be |
| 4 | # found in the LICENSE file. |
| 5 | |
| 6 | """Connect to a DUT in firmware via remote GDB, install custom GDB commands.""" |
| 7 | |
Mike Frysinger | 383367e | 2014-09-16 15:06:17 -0400 | [diff] [blame] | 8 | from __future__ import print_function |
| 9 | |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 10 | import errno |
Raul E Rangel | eb8aadc | 2018-05-17 09:10:27 -0600 | [diff] [blame] | 11 | import glob |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 12 | import os |
| 13 | import re |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 14 | import socket |
| 15 | import time |
| 16 | |
Aviv Keshet | b7519e1 | 2016-10-04 00:50:00 -0700 | [diff] [blame] | 17 | from chromite.lib import constants |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 18 | from chromite.lib import commandline |
| 19 | from chromite.lib import cros_build_lib |
Ralph Nathan | 91874ca | 2015-03-19 13:29:41 -0700 | [diff] [blame] | 20 | from chromite.lib import cros_logging as logging |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 21 | from chromite.lib import timeout_util |
| 22 | |
Julius Werner | 149fe78 | 2018-10-10 15:18:14 -0700 | [diff] [blame] | 23 | from elftools.elf.elffile import ELFFile |
| 24 | |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 25 | # Need to do this before Servo import |
| 26 | cros_build_lib.AssertInsideChroot() |
| 27 | |
Mike Frysinger | 92bdef5 | 2019-08-21 21:05:13 -0400 | [diff] [blame] | 28 | # pylint: disable=import-error,wrong-import-position |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 29 | from servo import client |
Ruben Rodriguez Buchillon | 15bdd45 | 2018-10-09 08:31:41 +0800 | [diff] [blame] | 30 | from servo import servo_parsing |
Aseda Aboagye | 6e21d3f | 2016-10-21 11:37:56 -0700 | [diff] [blame] | 31 | from servo import terminal_freezer |
Mike Frysinger | 92bdef5 | 2019-08-21 21:05:13 -0400 | [diff] [blame] | 32 | # pylint: enable=import-error,wrong-import-position |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 33 | |
Ralph Nathan | 91874ca | 2015-03-19 13:29:41 -0700 | [diff] [blame] | 34 | |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 35 | _SRC_ROOT = os.path.join(constants.CHROOT_SOURCE_ROOT, 'src') |
| 36 | _SRC_DC = os.path.join(_SRC_ROOT, 'platform/depthcharge') |
| 37 | _SRC_VB = os.path.join(_SRC_ROOT, 'platform/vboot_reference') |
| 38 | _SRC_LP = os.path.join(_SRC_ROOT, 'third_party/coreboot/payloads/libpayload') |
| 39 | |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 40 | _PTRN_GDB = 'Ready for GDB connection' |
Julius Werner | 20dfc99 | 2014-07-21 18:40:11 -0700 | [diff] [blame] | 41 | _PTRN_BOARD = 'Starting(?: read-only| read/write)? depthcharge on ([a-z_]+)...' |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 42 | |
| 43 | |
Julius Werner | 149fe78 | 2018-10-10 15:18:14 -0700 | [diff] [blame] | 44 | def GetGdbForElf(elf): |
| 45 | """Return the correct C compiler prefix for the target ELF file.""" |
Mike Frysinger | 17844a0 | 2019-08-24 18:21:02 -0400 | [diff] [blame] | 46 | with open(elf, 'rb') as fp: |
Julius Werner | 149fe78 | 2018-10-10 15:18:14 -0700 | [diff] [blame] | 47 | return { |
| 48 | 'EM_386': 'x86_64-cros-linux-gnu-gdb', |
| 49 | 'EM_X86_64': 'x86_64-cros-linux-gnu-gdb', |
| 50 | 'EM_ARM': 'armv7a-cros-linux-gnueabihf-gdb', |
| 51 | 'EM_AARCH64': 'aarch64-cros-linux-gnu-gdb', |
Mike Frysinger | 17844a0 | 2019-08-24 18:21:02 -0400 | [diff] [blame] | 52 | }[ELFFile(fp).header.e_machine] |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 53 | |
| 54 | |
| 55 | def ParseArgs(argv): |
| 56 | """Parse and validate command line arguments.""" |
| 57 | parser = commandline.ArgumentParser(default_log_level='warning') |
| 58 | |
| 59 | parser.add_argument('-b', '--board', |
| 60 | help='The board overlay name (auto-detect by default)') |
Raul E Rangel | 72f3271 | 2018-05-29 11:42:59 -0600 | [diff] [blame] | 61 | parser.add_argument('-c', '--cgdb', action='store_true', |
| 62 | help='Use cgdb curses interface rather than plain gdb') |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 63 | parser.add_argument('-s', '--symbols', |
| 64 | help='Root directory or complete path to symbolized ELF ' |
| 65 | '(defaults to /build/<BOARD>/firmware)') |
| 66 | parser.add_argument('-r', '--reboot', choices=['yes', 'no', 'auto'], |
| 67 | help='Reboot the DUT before connect (default: reboot if ' |
| 68 | 'the remote and is unreachable)', default='auto') |
| 69 | parser.add_argument('-e', '--execute', action='append', default=[], |
| 70 | help='GDB command to run after connect (can be supplied ' |
| 71 | 'multiple times)') |
Ruben Rodriguez Buchillon | 483426c | 2018-12-10 10:10:34 +0800 | [diff] [blame] | 72 | parser.add_argument('--servod-rcfile', default=servo_parsing.DEFAULT_RC_FILE, |
| 73 | dest='rcfile') |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 74 | parser.add_argument('--servod-server') |
Ruben Rodriguez Buchillon | 483426c | 2018-12-10 10:10:34 +0800 | [diff] [blame] | 75 | # Add --name for rc servod configuration. |
| 76 | servo_parsing.ServodRCParser.AddRCEnabledNameArg(parser) |
| 77 | # Add |port_flags| as the port arguments. |
Ruben Rodriguez Buchillon | d7c65bd | 2018-12-10 10:10:19 +0800 | [diff] [blame] | 78 | port_flags = ['-p', '--servod-port'] |
Ruben Rodriguez Buchillon | 483426c | 2018-12-10 10:10:34 +0800 | [diff] [blame] | 79 | servo_parsing.BaseServodParser.AddRCEnabledPortArg(parser, |
| 80 | port_flags=port_flags) |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 81 | parser.add_argument('-t', '--tty', |
| 82 | help='TTY file to connect to (defaults to cpu_uart_pty)') |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 83 | opts = parser.parse_args(argv) |
Ruben Rodriguez Buchillon | d7c65bd | 2018-12-10 10:10:19 +0800 | [diff] [blame] | 84 | |
| 85 | # Set |.port| and |.board| in |opts| if there's a rc match for opts.name. |
Ruben Rodriguez Buchillon | 483426c | 2018-12-10 10:10:34 +0800 | [diff] [blame] | 86 | servo_parsing.ServodRCParser.PostProcessRCElements(opts) |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 87 | |
| 88 | if not opts.servod_server: |
| 89 | opts.servod_server = client.DEFAULT_HOST |
| 90 | if not opts.port: |
| 91 | opts.port = client.DEFAULT_PORT |
| 92 | |
| 93 | return opts |
| 94 | |
| 95 | |
Julius Werner | 193c914 | 2018-05-09 16:25:38 -0700 | [diff] [blame] | 96 | def FindSymbols(firmware_dir, board): |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 97 | """Find the symbolized depthcharge ELF (may be supplied by -s flag).""" |
Raul E Rangel | eb8aadc | 2018-05-17 09:10:27 -0600 | [diff] [blame] | 98 | |
| 99 | # Allow overriding the file directly just in case our detection screws up. |
| 100 | if firmware_dir and firmware_dir.endswith('.elf'): |
| 101 | return firmware_dir |
| 102 | |
| 103 | if not firmware_dir: |
| 104 | # Unified builds have the format |
| 105 | # /build/<board|family>/firmware/<build_target|model>/. The board in |
| 106 | # depthcharge corresponds to the build_target in unified builds. For this |
| 107 | # reason we need to glob all boards to find the correct build_target. |
| 108 | unified_build_dirs = glob.glob('/build/*/firmware/%s' % board) |
| 109 | if len(unified_build_dirs) == 1: |
| 110 | firmware_dir = unified_build_dirs[0] |
| 111 | elif len(unified_build_dirs) > 1: |
| 112 | raise ValueError( |
| 113 | 'Multiple boards were found (%s). Use -s to specify manually' % |
| 114 | (', '.join(unified_build_dirs))) |
| 115 | |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 116 | if not firmware_dir: |
| 117 | firmware_dir = os.path.join(cros_build_lib.GetSysroot(board), 'firmware') |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 118 | |
Julius Werner | 193c914 | 2018-05-09 16:25:38 -0700 | [diff] [blame] | 119 | # Very old firmware you might still find on GoldenEye had dev.ro.elf. |
| 120 | basenames = ['dev.elf', 'dev.ro.elf'] |
| 121 | for basename in basenames: |
| 122 | path = os.path.join(firmware_dir, 'depthcharge', basename) |
| 123 | if not os.path.exists(path): |
| 124 | path = os.path.join(firmware_dir, basename) |
| 125 | if os.path.exists(path): |
| 126 | logging.warning('Auto-detected symbol file at %s... make sure that this' |
| 127 | ' matches the image on your DUT!', path) |
| 128 | return path |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 129 | |
Julius Werner | 193c914 | 2018-05-09 16:25:38 -0700 | [diff] [blame] | 130 | raise ValueError('Could not find depthcharge symbol file (dev.elf)! ' |
| 131 | '(You can use -s to supply it manually.)') |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 132 | |
| 133 | |
| 134 | # TODO(jwerner): Fine tune |wait| delay or maybe even make it configurable if |
| 135 | # this causes problems due to load on the host. The callers where this is |
| 136 | # critical should all have their own timeouts now, though, so it's questionable |
| 137 | # whether the delay here is even needed at all anymore. |
| 138 | def ReadAll(fd, wait=0.03): |
| 139 | """Read from |fd| until no more data has come for at least |wait| seconds.""" |
| 140 | data = '' |
| 141 | try: |
| 142 | while True: |
| 143 | time.sleep(wait) |
Julius Werner | 193c914 | 2018-05-09 16:25:38 -0700 | [diff] [blame] | 144 | new_data = os.read(fd, 4096) |
| 145 | if not new_data: |
| 146 | break |
| 147 | data += new_data |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 148 | except OSError as e: |
Julius Werner | 193c914 | 2018-05-09 16:25:38 -0700 | [diff] [blame] | 149 | if e.errno != errno.EAGAIN: |
| 150 | raise |
| 151 | logging.debug(data) |
| 152 | return data |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 153 | |
| 154 | |
| 155 | def GdbChecksum(message): |
| 156 | """Calculate a remote-GDB style checksum.""" |
| 157 | chksum = sum([ord(x) for x in message]) |
| 158 | return ('%.2x' % chksum)[-2:] |
| 159 | |
| 160 | |
| 161 | def TestConnection(fd): |
| 162 | """Return True iff there is a resposive GDB stub on the other end of 'fd'.""" |
| 163 | cmd = 'vUnknownCommand' |
Mike Frysinger | 79cca96 | 2019-06-13 15:26:53 -0400 | [diff] [blame] | 164 | for _ in range(3): |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 165 | os.write(fd, '$%s#%s\n' % (cmd, GdbChecksum(cmd))) |
| 166 | reply = ReadAll(fd) |
| 167 | if '+$#00' in reply: |
| 168 | os.write(fd, '+') |
Mike Frysinger | 2403af4 | 2015-04-30 06:25:03 -0400 | [diff] [blame] | 169 | logging.info('TestConnection: Could successfully connect to remote end.') |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 170 | return True |
Mike Frysinger | 2403af4 | 2015-04-30 06:25:03 -0400 | [diff] [blame] | 171 | logging.info('TestConnection: Remote end does not respond.') |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 172 | return False |
| 173 | |
| 174 | |
| 175 | def main(argv): |
| 176 | opts = ParseArgs(argv) |
| 177 | servo = client.ServoClient(host=opts.servod_server, port=opts.port) |
| 178 | |
| 179 | if not opts.tty: |
| 180 | try: |
| 181 | opts.tty = servo.get('cpu_uart_pty') |
| 182 | except (client.ServoClientError, socket.error): |
Mike Frysinger | 2403af4 | 2015-04-30 06:25:03 -0400 | [diff] [blame] | 183 | logging.error('Cannot auto-detect TTY file without servod. Use the --tty ' |
| 184 | 'option.') |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 185 | raise |
Aseda Aboagye | 6e21d3f | 2016-10-21 11:37:56 -0700 | [diff] [blame] | 186 | with terminal_freezer.TerminalFreezer(opts.tty): |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 187 | fd = os.open(opts.tty, os.O_RDWR | os.O_NONBLOCK) |
| 188 | |
| 189 | data = ReadAll(fd) |
| 190 | if opts.reboot == 'auto': |
| 191 | if TestConnection(fd): |
| 192 | opts.reboot = 'no' |
| 193 | else: |
| 194 | opts.reboot = 'yes' |
| 195 | |
| 196 | if opts.reboot == 'yes': |
Mike Frysinger | 2403af4 | 2015-04-30 06:25:03 -0400 | [diff] [blame] | 197 | logging.info('Rebooting DUT...') |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 198 | try: |
| 199 | servo.set('warm_reset', 'on') |
| 200 | time.sleep(0.1) |
| 201 | servo.set('warm_reset', 'off') |
| 202 | except (client.ServoClientError, socket.error): |
Mike Frysinger | 2403af4 | 2015-04-30 06:25:03 -0400 | [diff] [blame] | 203 | logging.error('Cannot reboot without a Servo board. You have to boot ' |
| 204 | 'into developer mode and press CTRL+G manually before ' |
| 205 | 'running fwgdb.') |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 206 | raise |
| 207 | |
| 208 | # Throw away old data to avoid confusion from messages before the reboot |
| 209 | data = '' |
Julius Werner | 193c914 | 2018-05-09 16:25:38 -0700 | [diff] [blame] | 210 | msg = ('Could not reboot into depthcharge!') |
Mike Frysinger | d6e2df0 | 2014-11-26 02:55:04 -0500 | [diff] [blame] | 211 | with timeout_util.Timeout(10, msg): |
Julius Werner | 193c914 | 2018-05-09 16:25:38 -0700 | [diff] [blame] | 212 | while not re.search(_PTRN_BOARD, data): |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 213 | data += ReadAll(fd) |
| 214 | |
Mike Frysinger | d6e2df0 | 2014-11-26 02:55:04 -0500 | [diff] [blame] | 215 | msg = ('Could not enter GDB mode with CTRL+G! ' |
Julius Werner | 193c914 | 2018-05-09 16:25:38 -0700 | [diff] [blame] | 216 | '(Confirm that you flashed an "image.dev.bin" image to this DUT, ' |
| 217 | 'and that you have GBB_FLAG_FORCE_DEV_SWITCH_ON (0x8) set.)') |
| 218 | with timeout_util.Timeout(5, msg): |
| 219 | while not re.search(_PTRN_GDB, data): |
| 220 | # Send a CTRL+G to tell depthcharge to trap into GDB. |
| 221 | logging.debug('[Ctrl+G]') |
| 222 | os.write(fd, chr(ord('G') & 0x1f)) |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 223 | data += ReadAll(fd) |
| 224 | |
| 225 | if not opts.board: |
| 226 | matches = re.findall(_PTRN_BOARD, data) |
| 227 | if not matches: |
| 228 | raise ValueError('Could not auto-detect board! Please use -b option.') |
| 229 | opts.board = matches[-1] |
Mike Frysinger | 2403af4 | 2015-04-30 06:25:03 -0400 | [diff] [blame] | 230 | logging.info('Auto-detected board as %s from DUT console output.', |
| 231 | opts.board) |
Julius Werner | 634ccac | 2014-06-24 13:59:18 -0700 | [diff] [blame] | 232 | |
| 233 | if not TestConnection(fd): |
| 234 | raise IOError('Could not connect to remote end! Confirm that your DUT is ' |
| 235 | 'running in GDB mode on %s.' % opts.tty) |
| 236 | |
| 237 | # Eat up leftover data or it will spill back to terminal |
| 238 | ReadAll(fd) |
| 239 | os.close(fd) |
| 240 | |
| 241 | opts.execute.insert(0, 'target remote %s' % opts.tty) |
| 242 | ex_args = sum([['--ex', cmd] for cmd in opts.execute], []) |
| 243 | |
Julius Werner | 149fe78 | 2018-10-10 15:18:14 -0700 | [diff] [blame] | 244 | elf = FindSymbols(opts.symbols, opts.board) |
| 245 | gdb_cmd = GetGdbForElf(elf) |
Raul E Rangel | 72f3271 | 2018-05-29 11:42:59 -0600 | [diff] [blame] | 246 | |
Raul E Rangel | 72f3271 | 2018-05-29 11:42:59 -0600 | [diff] [blame] | 247 | gdb_args = [ |
Julius Werner | 149fe78 | 2018-10-10 15:18:14 -0700 | [diff] [blame] | 248 | '--symbols', elf, |
Raul E Rangel | 72f3271 | 2018-05-29 11:42:59 -0600 | [diff] [blame] | 249 | '--directory', _SRC_DC, |
| 250 | '--directory', _SRC_VB, |
| 251 | '--directory', _SRC_LP, |
| 252 | ] + ex_args |
| 253 | |
| 254 | if opts.cgdb: |
| 255 | full_cmd = ['cgdb', '-d', gdb_cmd, '--'] + gdb_args |
| 256 | else: |
| 257 | full_cmd = [gdb_cmd] + gdb_args |
| 258 | |
Julius Werner | 149fe78 | 2018-10-10 15:18:14 -0700 | [diff] [blame] | 259 | logging.info('Launching GDB...') |
Mike Frysinger | 45602c7 | 2019-09-22 02:15:11 -0400 | [diff] [blame] | 260 | cros_build_lib.run( |
Raul E Rangel | 72f3271 | 2018-05-29 11:42:59 -0600 | [diff] [blame] | 261 | full_cmd, ignore_sigint=True, debug_level=logging.WARNING) |