blob: 887e7bcc5a0d75ed93ac43e3e5c2efd9dc456cc1 [file] [log] [blame]
Mike Frysingere58c0e22017-10-04 15:43:30 -04001# -*- coding: utf-8 -*-
Julius Werner634ccac2014-06-24 13:59:18 -07002# 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 Frysinger383367e2014-09-16 15:06:17 -04008from __future__ import print_function
9
Julius Werner634ccac2014-06-24 13:59:18 -070010import errno
Raul E Rangeleb8aadc2018-05-17 09:10:27 -060011import glob
Julius Werner634ccac2014-06-24 13:59:18 -070012import os
13import re
Julius Werner634ccac2014-06-24 13:59:18 -070014import socket
15import time
16
Aviv Keshetb7519e12016-10-04 00:50:00 -070017from chromite.lib import constants
Julius Werner634ccac2014-06-24 13:59:18 -070018from chromite.lib import commandline
19from chromite.lib import cros_build_lib
Ralph Nathan91874ca2015-03-19 13:29:41 -070020from chromite.lib import cros_logging as logging
Julius Werner634ccac2014-06-24 13:59:18 -070021from chromite.lib import timeout_util
22
Julius Werner149fe782018-10-10 15:18:14 -070023from elftools.elf.elffile import ELFFile
24
Julius Werner634ccac2014-06-24 13:59:18 -070025# Need to do this before Servo import
26cros_build_lib.AssertInsideChroot()
27
Mike Frysinger92bdef52019-08-21 21:05:13 -040028# pylint: disable=import-error,wrong-import-position
Julius Werner634ccac2014-06-24 13:59:18 -070029from servo import client
Ruben Rodriguez Buchillon15bdd452018-10-09 08:31:41 +080030from servo import servo_parsing
Aseda Aboagye6e21d3f2016-10-21 11:37:56 -070031from servo import terminal_freezer
Mike Frysinger92bdef52019-08-21 21:05:13 -040032# pylint: enable=import-error,wrong-import-position
Julius Werner634ccac2014-06-24 13:59:18 -070033
Ralph Nathan91874ca2015-03-19 13:29:41 -070034
Julius Werner634ccac2014-06-24 13:59:18 -070035_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 Werner634ccac2014-06-24 13:59:18 -070040_PTRN_GDB = 'Ready for GDB connection'
Julius Werner20dfc992014-07-21 18:40:11 -070041_PTRN_BOARD = 'Starting(?: read-only| read/write)? depthcharge on ([a-z_]+)...'
Julius Werner634ccac2014-06-24 13:59:18 -070042
43
Julius Werner149fe782018-10-10 15:18:14 -070044def GetGdbForElf(elf):
45 """Return the correct C compiler prefix for the target ELF file."""
46 with open(elf, 'rb') as elf:
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',
52 }[ELFFile(elf).header.e_machine]
Julius Werner634ccac2014-06-24 13:59:18 -070053
54
55def 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 Rangel72f32712018-05-29 11:42:59 -060061 parser.add_argument('-c', '--cgdb', action='store_true',
62 help='Use cgdb curses interface rather than plain gdb')
Julius Werner634ccac2014-06-24 13:59:18 -070063 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)')
72
73 parser.add_argument('-n', '--servod-name', dest='name')
Ruben Rodriguez Buchillon15bdd452018-10-09 08:31:41 +080074 parser.add_argument('--servod-rcfile', default=servo_parsing.DEFAULT_RC_FILE)
Julius Werner634ccac2014-06-24 13:59:18 -070075 parser.add_argument('--servod-server')
76 parser.add_argument('-p', '--servod-port', type=int, dest='port')
77 parser.add_argument('-t', '--tty',
78 help='TTY file to connect to (defaults to cpu_uart_pty)')
79
80 opts = parser.parse_args(argv)
Ruben Rodriguez Buchillon15bdd452018-10-09 08:31:41 +080081 servo_parsing.get_env_options(logging, opts)
Julius Werner634ccac2014-06-24 13:59:18 -070082 if opts.name:
Ruben Rodriguez Buchillon15bdd452018-10-09 08:31:41 +080083 rc = servo_parsing.parse_rc(logging, opts.servod_rcfile)
Julius Werner634ccac2014-06-24 13:59:18 -070084 if opts.name not in rc:
85 raise parser.error('%s not in %s' % (opts.name, opts.servod_rcfile))
86 if not opts.servod_server:
87 opts.servod_server = rc[opts.name]['sn']
88 if not opts.port:
89 opts.port = rc[opts.name].get('port', client.DEFAULT_PORT)
90 if not opts.board and 'board' in rc[opts.name]:
91 opts.board = rc[opts.name]['board']
Bertrand SIMONNET0ddf7762015-05-20 14:38:00 -070092 logging.warning('Inferring board %s from %s; make sure this is correct!',
93 opts.board, opts.servod_rcfile)
Julius Werner634ccac2014-06-24 13:59:18 -070094
95 if not opts.servod_server:
96 opts.servod_server = client.DEFAULT_HOST
97 if not opts.port:
98 opts.port = client.DEFAULT_PORT
99
100 return opts
101
102
Julius Werner193c9142018-05-09 16:25:38 -0700103def FindSymbols(firmware_dir, board):
Julius Werner634ccac2014-06-24 13:59:18 -0700104 """Find the symbolized depthcharge ELF (may be supplied by -s flag)."""
Raul E Rangeleb8aadc2018-05-17 09:10:27 -0600105
106 # Allow overriding the file directly just in case our detection screws up.
107 if firmware_dir and firmware_dir.endswith('.elf'):
108 return firmware_dir
109
110 if not firmware_dir:
111 # Unified builds have the format
112 # /build/<board|family>/firmware/<build_target|model>/. The board in
113 # depthcharge corresponds to the build_target in unified builds. For this
114 # reason we need to glob all boards to find the correct build_target.
115 unified_build_dirs = glob.glob('/build/*/firmware/%s' % board)
116 if len(unified_build_dirs) == 1:
117 firmware_dir = unified_build_dirs[0]
118 elif len(unified_build_dirs) > 1:
119 raise ValueError(
120 'Multiple boards were found (%s). Use -s to specify manually' %
121 (', '.join(unified_build_dirs)))
122
Julius Werner634ccac2014-06-24 13:59:18 -0700123 if not firmware_dir:
124 firmware_dir = os.path.join(cros_build_lib.GetSysroot(board), 'firmware')
Julius Werner634ccac2014-06-24 13:59:18 -0700125
Julius Werner193c9142018-05-09 16:25:38 -0700126 # Very old firmware you might still find on GoldenEye had dev.ro.elf.
127 basenames = ['dev.elf', 'dev.ro.elf']
128 for basename in basenames:
129 path = os.path.join(firmware_dir, 'depthcharge', basename)
130 if not os.path.exists(path):
131 path = os.path.join(firmware_dir, basename)
132 if os.path.exists(path):
133 logging.warning('Auto-detected symbol file at %s... make sure that this'
134 ' matches the image on your DUT!', path)
135 return path
Julius Werner634ccac2014-06-24 13:59:18 -0700136
Julius Werner193c9142018-05-09 16:25:38 -0700137 raise ValueError('Could not find depthcharge symbol file (dev.elf)! '
138 '(You can use -s to supply it manually.)')
Julius Werner634ccac2014-06-24 13:59:18 -0700139
140
141# TODO(jwerner): Fine tune |wait| delay or maybe even make it configurable if
142# this causes problems due to load on the host. The callers where this is
143# critical should all have their own timeouts now, though, so it's questionable
144# whether the delay here is even needed at all anymore.
145def ReadAll(fd, wait=0.03):
146 """Read from |fd| until no more data has come for at least |wait| seconds."""
147 data = ''
148 try:
149 while True:
150 time.sleep(wait)
Julius Werner193c9142018-05-09 16:25:38 -0700151 new_data = os.read(fd, 4096)
152 if not new_data:
153 break
154 data += new_data
Julius Werner634ccac2014-06-24 13:59:18 -0700155 except OSError as e:
Julius Werner193c9142018-05-09 16:25:38 -0700156 if e.errno != errno.EAGAIN:
157 raise
158 logging.debug(data)
159 return data
Julius Werner634ccac2014-06-24 13:59:18 -0700160
161
162def GdbChecksum(message):
163 """Calculate a remote-GDB style checksum."""
164 chksum = sum([ord(x) for x in message])
165 return ('%.2x' % chksum)[-2:]
166
167
168def TestConnection(fd):
169 """Return True iff there is a resposive GDB stub on the other end of 'fd'."""
170 cmd = 'vUnknownCommand'
Mike Frysinger79cca962019-06-13 15:26:53 -0400171 for _ in range(3):
Julius Werner634ccac2014-06-24 13:59:18 -0700172 os.write(fd, '$%s#%s\n' % (cmd, GdbChecksum(cmd)))
173 reply = ReadAll(fd)
174 if '+$#00' in reply:
175 os.write(fd, '+')
Mike Frysinger2403af42015-04-30 06:25:03 -0400176 logging.info('TestConnection: Could successfully connect to remote end.')
Julius Werner634ccac2014-06-24 13:59:18 -0700177 return True
Mike Frysinger2403af42015-04-30 06:25:03 -0400178 logging.info('TestConnection: Remote end does not respond.')
Julius Werner634ccac2014-06-24 13:59:18 -0700179 return False
180
181
182def main(argv):
183 opts = ParseArgs(argv)
184 servo = client.ServoClient(host=opts.servod_server, port=opts.port)
185
186 if not opts.tty:
187 try:
188 opts.tty = servo.get('cpu_uart_pty')
189 except (client.ServoClientError, socket.error):
Mike Frysinger2403af42015-04-30 06:25:03 -0400190 logging.error('Cannot auto-detect TTY file without servod. Use the --tty '
191 'option.')
Julius Werner634ccac2014-06-24 13:59:18 -0700192 raise
Aseda Aboagye6e21d3f2016-10-21 11:37:56 -0700193 with terminal_freezer.TerminalFreezer(opts.tty):
Julius Werner634ccac2014-06-24 13:59:18 -0700194 fd = os.open(opts.tty, os.O_RDWR | os.O_NONBLOCK)
195
196 data = ReadAll(fd)
197 if opts.reboot == 'auto':
198 if TestConnection(fd):
199 opts.reboot = 'no'
200 else:
201 opts.reboot = 'yes'
202
203 if opts.reboot == 'yes':
Mike Frysinger2403af42015-04-30 06:25:03 -0400204 logging.info('Rebooting DUT...')
Julius Werner634ccac2014-06-24 13:59:18 -0700205 try:
206 servo.set('warm_reset', 'on')
207 time.sleep(0.1)
208 servo.set('warm_reset', 'off')
209 except (client.ServoClientError, socket.error):
Mike Frysinger2403af42015-04-30 06:25:03 -0400210 logging.error('Cannot reboot without a Servo board. You have to boot '
211 'into developer mode and press CTRL+G manually before '
212 'running fwgdb.')
Julius Werner634ccac2014-06-24 13:59:18 -0700213 raise
214
215 # Throw away old data to avoid confusion from messages before the reboot
216 data = ''
Julius Werner193c9142018-05-09 16:25:38 -0700217 msg = ('Could not reboot into depthcharge!')
Mike Frysingerd6e2df02014-11-26 02:55:04 -0500218 with timeout_util.Timeout(10, msg):
Julius Werner193c9142018-05-09 16:25:38 -0700219 while not re.search(_PTRN_BOARD, data):
Julius Werner634ccac2014-06-24 13:59:18 -0700220 data += ReadAll(fd)
221
Mike Frysingerd6e2df02014-11-26 02:55:04 -0500222 msg = ('Could not enter GDB mode with CTRL+G! '
Julius Werner193c9142018-05-09 16:25:38 -0700223 '(Confirm that you flashed an "image.dev.bin" image to this DUT, '
224 'and that you have GBB_FLAG_FORCE_DEV_SWITCH_ON (0x8) set.)')
225 with timeout_util.Timeout(5, msg):
226 while not re.search(_PTRN_GDB, data):
227 # Send a CTRL+G to tell depthcharge to trap into GDB.
228 logging.debug('[Ctrl+G]')
229 os.write(fd, chr(ord('G') & 0x1f))
Julius Werner634ccac2014-06-24 13:59:18 -0700230 data += ReadAll(fd)
231
232 if not opts.board:
233 matches = re.findall(_PTRN_BOARD, data)
234 if not matches:
235 raise ValueError('Could not auto-detect board! Please use -b option.')
236 opts.board = matches[-1]
Mike Frysinger2403af42015-04-30 06:25:03 -0400237 logging.info('Auto-detected board as %s from DUT console output.',
238 opts.board)
Julius Werner634ccac2014-06-24 13:59:18 -0700239
240 if not TestConnection(fd):
241 raise IOError('Could not connect to remote end! Confirm that your DUT is '
242 'running in GDB mode on %s.' % opts.tty)
243
244 # Eat up leftover data or it will spill back to terminal
245 ReadAll(fd)
246 os.close(fd)
247
248 opts.execute.insert(0, 'target remote %s' % opts.tty)
249 ex_args = sum([['--ex', cmd] for cmd in opts.execute], [])
250
Julius Werner149fe782018-10-10 15:18:14 -0700251 elf = FindSymbols(opts.symbols, opts.board)
252 gdb_cmd = GetGdbForElf(elf)
Raul E Rangel72f32712018-05-29 11:42:59 -0600253
Raul E Rangel72f32712018-05-29 11:42:59 -0600254 gdb_args = [
Julius Werner149fe782018-10-10 15:18:14 -0700255 '--symbols', elf,
Raul E Rangel72f32712018-05-29 11:42:59 -0600256 '--directory', _SRC_DC,
257 '--directory', _SRC_VB,
258 '--directory', _SRC_LP,
259 ] + ex_args
260
261 if opts.cgdb:
262 full_cmd = ['cgdb', '-d', gdb_cmd, '--'] + gdb_args
263 else:
264 full_cmd = [gdb_cmd] + gdb_args
265
Julius Werner149fe782018-10-10 15:18:14 -0700266 logging.info('Launching GDB...')
Mike Frysinger45602c72019-09-22 02:15:11 -0400267 cros_build_lib.run(
Raul E Rangel72f32712018-05-29 11:42:59 -0600268 full_cmd, ignore_sigint=True, debug_level=logging.WARNING)