1""" 2Base class for gdb-remote test cases. 3""" 4 5from __future__ import division, print_function 6 7 8import errno 9import os 10import os.path 11import random 12import re 13import select 14import socket 15import subprocess 16import sys 17import tempfile 18import time 19from lldbsuite.test import configuration 20from lldbsuite.test.lldbtest import * 21from lldbsuite.support import seven 22from lldbgdbserverutils import * 23import logging 24 25 26class _ConnectionRefused(IOError): 27 pass 28 29 30class GdbRemoteTestCaseFactory(type): 31 32 def __new__(cls, name, bases, attrs): 33 newattrs = {} 34 for attrname, attrvalue in attrs.items(): 35 if not attrname.startswith("test"): 36 newattrs[attrname] = attrvalue 37 continue 38 39 # If any debug server categories were explicitly tagged, assume 40 # that list to be authoritative. If none were specified, try 41 # all of them. 42 all_categories = set(["debugserver", "llgs"]) 43 categories = set( 44 getattr(attrvalue, "categories", [])) & all_categories 45 if not categories: 46 categories = all_categories 47 48 for cat in categories: 49 @decorators.add_test_categories([cat]) 50 @wraps(attrvalue) 51 def test_method(self, attrvalue=attrvalue): 52 return attrvalue(self) 53 54 method_name = attrname + "_" + cat 55 test_method.__name__ = method_name 56 test_method.debug_server = cat 57 newattrs[method_name] = test_method 58 59 return super(GdbRemoteTestCaseFactory, cls).__new__( 60 cls, name, bases, newattrs) 61 62@add_metaclass(GdbRemoteTestCaseFactory) 63class GdbRemoteTestCaseBase(Base): 64 65 # Default time out in seconds. The timeout is increased tenfold under Asan. 66 DEFAULT_TIMEOUT = 20 * (10 if ('ASAN_OPTIONS' in os.environ) else 1) 67 # Default sleep time in seconds. The sleep time is doubled under Asan. 68 DEFAULT_SLEEP = 5 * (2 if ('ASAN_OPTIONS' in os.environ) else 1) 69 70 _GDBREMOTE_KILL_PACKET = b"$k#6b" 71 72 # Start the inferior separately, attach to the inferior on the stub 73 # command line. 74 _STARTUP_ATTACH = "attach" 75 # Start the inferior separately, start the stub without attaching, allow 76 # the test to attach to the inferior however it wants (e.g. $vAttach;pid). 77 _STARTUP_ATTACH_MANUALLY = "attach_manually" 78 # Start the stub, and launch the inferior with an $A packet via the 79 # initial packet stream. 80 _STARTUP_LAUNCH = "launch" 81 82 # GDB Signal numbers that are not target-specific used for common 83 # exceptions 84 TARGET_EXC_BAD_ACCESS = 0x91 85 TARGET_EXC_BAD_INSTRUCTION = 0x92 86 TARGET_EXC_ARITHMETIC = 0x93 87 TARGET_EXC_EMULATION = 0x94 88 TARGET_EXC_SOFTWARE = 0x95 89 TARGET_EXC_BREAKPOINT = 0x96 90 91 _verbose_log_handler = None 92 _log_formatter = logging.Formatter( 93 fmt='%(asctime)-15s %(levelname)-8s %(message)s') 94 95 def setUpBaseLogging(self): 96 self.logger = logging.getLogger(__name__) 97 98 if len(self.logger.handlers) > 0: 99 return # We have set up this handler already 100 101 self.logger.propagate = False 102 self.logger.setLevel(logging.DEBUG) 103 104 # log all warnings to stderr 105 handler = logging.StreamHandler() 106 handler.setLevel(logging.WARNING) 107 handler.setFormatter(self._log_formatter) 108 self.logger.addHandler(handler) 109 110 def isVerboseLoggingRequested(self): 111 # We will report our detailed logs if the user requested that the "gdb-remote" channel is 112 # logged. 113 return any(("gdb-remote" in channel) 114 for channel in lldbtest_config.channels) 115 116 def getDebugServer(self): 117 method = getattr(self, self.testMethodName) 118 return getattr(method, "debug_server", None) 119 120 def setUp(self): 121 super(GdbRemoteTestCaseBase, self).setUp() 122 123 self.setUpBaseLogging() 124 self.debug_monitor_extra_args = [] 125 126 if self.isVerboseLoggingRequested(): 127 # If requested, full logs go to a log file 128 self._verbose_log_handler = logging.FileHandler( 129 self.getLogBasenameForCurrentTest() + "-host.log") 130 self._verbose_log_handler.setFormatter(self._log_formatter) 131 self._verbose_log_handler.setLevel(logging.DEBUG) 132 self.logger.addHandler(self._verbose_log_handler) 133 134 self.test_sequence = GdbRemoteTestSequence(self.logger) 135 self.set_inferior_startup_launch() 136 self.port = self.get_next_port() 137 self.stub_sends_two_stop_notifications_on_kill = False 138 if configuration.lldb_platform_url: 139 if configuration.lldb_platform_url.startswith('unix-'): 140 url_pattern = '(.+)://\[?(.+?)\]?/.*' 141 else: 142 url_pattern = '(.+)://(.+):\d+' 143 scheme, host = re.match( 144 url_pattern, configuration.lldb_platform_url).groups() 145 if configuration.lldb_platform_name == 'remote-android' and host != 'localhost': 146 self.stub_device = host 147 self.stub_hostname = 'localhost' 148 else: 149 self.stub_device = None 150 self.stub_hostname = host 151 else: 152 self.stub_hostname = "localhost" 153 154 debug_server = self.getDebugServer() 155 if debug_server == "debugserver": 156 self._init_debugserver_test() 157 else: 158 self._init_llgs_test() 159 160 def tearDown(self): 161 self.logger.removeHandler(self._verbose_log_handler) 162 self._verbose_log_handler = None 163 TestBase.tearDown(self) 164 165 def build(self, *args, **kwargs): 166 self.buildDefault(*args, **kwargs) 167 168 def getLocalServerLogFile(self): 169 return self.getLogBasenameForCurrentTest() + "-server.log" 170 171 def setUpServerLogging(self, is_llgs): 172 if len(lldbtest_config.channels) == 0: 173 return # No logging requested 174 175 if lldb.remote_platform: 176 log_file = lldbutil.join_remote_paths( 177 lldb.remote_platform.GetWorkingDirectory(), "server.log") 178 else: 179 log_file = self.getLocalServerLogFile() 180 181 if is_llgs: 182 self.debug_monitor_extra_args.append("--log-file=" + log_file) 183 self.debug_monitor_extra_args.append( 184 "--log-channels={}".format(":".join(lldbtest_config.channels))) 185 else: 186 self.debug_monitor_extra_args = [ 187 "--log-file=" + log_file, "--log-flags=0x800000"] 188 189 def get_next_port(self): 190 return 12000 + random.randint(0, 3999) 191 192 def reset_test_sequence(self): 193 self.test_sequence = GdbRemoteTestSequence(self.logger) 194 195 196 def _init_llgs_test(self): 197 reverse_connect = True 198 if lldb.remote_platform: 199 # Reverse connections may be tricky due to firewalls/NATs. 200 reverse_connect = False 201 202 # FIXME: This is extremely linux-oriented 203 204 # Grab the ppid from /proc/[shell pid]/stat 205 err, retcode, shell_stat = self.run_platform_command( 206 "cat /proc/$$/stat") 207 self.assertTrue( 208 err.Success() and retcode == 0, 209 "Failed to read file /proc/$$/stat: %s, retcode: %d" % 210 (err.GetCString(), 211 retcode)) 212 213 # [pid] ([executable]) [state] [*ppid*] 214 pid = re.match(r"^\d+ \(.+\) . (\d+)", shell_stat).group(1) 215 err, retcode, ls_output = self.run_platform_command( 216 "ls -l /proc/%s/exe" % pid) 217 self.assertTrue( 218 err.Success() and retcode == 0, 219 "Failed to read file /proc/%s/exe: %s, retcode: %d" % 220 (pid, 221 err.GetCString(), 222 retcode)) 223 exe = ls_output.split()[-1] 224 225 # If the binary has been deleted, the link name has " (deleted)" appended. 226 # Remove if it's there. 227 self.debug_monitor_exe = re.sub(r' \(deleted\)$', '', exe) 228 else: 229 self.debug_monitor_exe = get_lldb_server_exe() 230 231 self.debug_monitor_extra_args = ["gdbserver"] 232 self.setUpServerLogging(is_llgs=True) 233 234 self.reverse_connect = reverse_connect 235 236 def _init_debugserver_test(self): 237 self.debug_monitor_exe = get_debugserver_exe() 238 self.setUpServerLogging(is_llgs=False) 239 self.reverse_connect = True 240 241 # The debugserver stub has a race on handling the 'k' command, so it sends an X09 right away, then sends the real X notification 242 # when the process truly dies. 243 self.stub_sends_two_stop_notifications_on_kill = True 244 245 def forward_adb_port(self, source, target, direction, device): 246 adb = ['adb'] + (['-s', device] if device else []) + [direction] 247 248 def remove_port_forward(): 249 subprocess.call(adb + ["--remove", "tcp:%d" % source]) 250 251 subprocess.call(adb + ["tcp:%d" % source, "tcp:%d" % target]) 252 self.addTearDownHook(remove_port_forward) 253 254 def _verify_socket(self, sock): 255 # Normally, when the remote stub is not ready, we will get ECONNREFUSED during the 256 # connect() attempt. However, due to the way how ADB forwarding works, on android targets 257 # the connect() will always be successful, but the connection will be immediately dropped 258 # if ADB could not connect on the remote side. This function tries to detect this 259 # situation, and report it as "connection refused" so that the upper layers attempt the 260 # connection again. 261 triple = self.dbg.GetSelectedPlatform().GetTriple() 262 if not re.match(".*-.*-.*-android", triple): 263 return # Not android. 264 can_read, _, _ = select.select([sock], [], [], 0.1) 265 if sock not in can_read: 266 return # Data is not available, but the connection is alive. 267 if len(sock.recv(1, socket.MSG_PEEK)) == 0: 268 raise _ConnectionRefused() # Got EOF, connection dropped. 269 270 def create_socket(self): 271 try: 272 sock = socket.socket(family=socket.AF_INET) 273 except OSError as e: 274 if e.errno != errno.EAFNOSUPPORT: 275 raise 276 sock = socket.socket(family=socket.AF_INET6) 277 278 logger = self.logger 279 280 triple = self.dbg.GetSelectedPlatform().GetTriple() 281 if re.match(".*-.*-.*-android", triple): 282 self.forward_adb_port( 283 self.port, 284 self.port, 285 "forward", 286 self.stub_device) 287 288 logger.info( 289 "Connecting to debug monitor on %s:%d", 290 self.stub_hostname, 291 self.port) 292 connect_info = (self.stub_hostname, self.port) 293 try: 294 sock.connect(connect_info) 295 except socket.error as serr: 296 if serr.errno == errno.ECONNREFUSED: 297 raise _ConnectionRefused() 298 raise serr 299 300 def shutdown_socket(): 301 if sock: 302 try: 303 # send the kill packet so lldb-server shuts down gracefully 304 sock.sendall(GdbRemoteTestCaseBase._GDBREMOTE_KILL_PACKET) 305 except: 306 logger.warning( 307 "failed to send kill packet to debug monitor: {}; ignoring".format( 308 sys.exc_info()[0])) 309 310 try: 311 sock.close() 312 except: 313 logger.warning( 314 "failed to close socket to debug monitor: {}; ignoring".format( 315 sys.exc_info()[0])) 316 317 self.addTearDownHook(shutdown_socket) 318 319 self._verify_socket(sock) 320 321 return sock 322 323 def set_inferior_startup_launch(self): 324 self._inferior_startup = self._STARTUP_LAUNCH 325 326 def set_inferior_startup_attach(self): 327 self._inferior_startup = self._STARTUP_ATTACH 328 329 def set_inferior_startup_attach_manually(self): 330 self._inferior_startup = self._STARTUP_ATTACH_MANUALLY 331 332 def get_debug_monitor_command_line_args(self, attach_pid=None): 333 commandline_args = self.debug_monitor_extra_args 334 if attach_pid: 335 commandline_args += ["--attach=%d" % attach_pid] 336 if self.reverse_connect: 337 commandline_args += ["--reverse-connect", self.connect_address] 338 else: 339 if lldb.remote_platform: 340 commandline_args += ["*:{}".format(self.port)] 341 else: 342 commandline_args += ["localhost:{}".format(self.port)] 343 344 return commandline_args 345 346 def get_target_byte_order(self): 347 inferior_exe_path = self.getBuildArtifact("a.out") 348 target = self.dbg.CreateTarget(inferior_exe_path) 349 return target.GetByteOrder() 350 351 def launch_debug_monitor(self, attach_pid=None, logfile=None): 352 if self.reverse_connect: 353 family, type, proto, _, addr = socket.getaddrinfo("localhost", 0, proto=socket.IPPROTO_TCP)[0] 354 sock = socket.socket(family, type, proto) 355 sock.settimeout(self.DEFAULT_TIMEOUT) 356 357 sock.bind(addr) 358 sock.listen(1) 359 addr = sock.getsockname() 360 self.connect_address = "[{}]:{}".format(*addr) 361 362 363 # Create the command line. 364 commandline_args = self.get_debug_monitor_command_line_args( 365 attach_pid=attach_pid) 366 367 # Start the server. 368 server = self.spawnSubprocess( 369 self.debug_monitor_exe, 370 commandline_args, 371 install_remote=False) 372 self.assertIsNotNone(server) 373 374 if self.reverse_connect: 375 self.sock = sock.accept()[0] 376 self.sock.settimeout(self.DEFAULT_TIMEOUT) 377 378 return server 379 380 def connect_to_debug_monitor(self, attach_pid=None): 381 if self.reverse_connect: 382 # Create the stub. 383 server = self.launch_debug_monitor(attach_pid=attach_pid) 384 self.assertIsNotNone(server) 385 386 # Schedule debug monitor to be shut down during teardown. 387 logger = self.logger 388 389 self._server = Server(self.sock, server) 390 return server 391 392 # We're using a random port algorithm to try not to collide with other ports, 393 # and retry a max # times. 394 attempts = 0 395 MAX_ATTEMPTS = 20 396 397 while attempts < MAX_ATTEMPTS: 398 server = self.launch_debug_monitor(attach_pid=attach_pid) 399 400 # Schedule debug monitor to be shut down during teardown. 401 logger = self.logger 402 403 connect_attemps = 0 404 MAX_CONNECT_ATTEMPTS = 10 405 406 while connect_attemps < MAX_CONNECT_ATTEMPTS: 407 # Create a socket to talk to the server 408 try: 409 logger.info("Connect attempt %d", connect_attemps + 1) 410 self.sock = self.create_socket() 411 self._server = Server(self.sock, server) 412 return server 413 except _ConnectionRefused as serr: 414 # Ignore, and try again. 415 pass 416 time.sleep(0.5) 417 connect_attemps += 1 418 419 # We should close the server here to be safe. 420 server.terminate() 421 422 # Increment attempts. 423 print( 424 "connect to debug monitor on port %d failed, attempt #%d of %d" % 425 (self.port, attempts + 1, MAX_ATTEMPTS)) 426 attempts += 1 427 428 # And wait a random length of time before next attempt, to avoid 429 # collisions. 430 time.sleep(random.randint(1, 5)) 431 432 # Now grab a new port number. 433 self.port = self.get_next_port() 434 435 raise Exception( 436 "failed to create a socket to the launched debug monitor after %d tries" % 437 attempts) 438 439 def launch_process_for_attach( 440 self, 441 inferior_args=None, 442 sleep_seconds=3, 443 exe_path=None): 444 # We're going to start a child process that the debug monitor stub can later attach to. 445 # This process needs to be started so that it just hangs around for a while. We'll 446 # have it sleep. 447 if not exe_path: 448 exe_path = self.getBuildArtifact("a.out") 449 450 args = [] 451 if inferior_args: 452 args.extend(inferior_args) 453 if sleep_seconds: 454 args.append("sleep:%d" % sleep_seconds) 455 456 return self.spawnSubprocess(exe_path, args) 457 458 def prep_debug_monitor_and_inferior( 459 self, 460 inferior_args=None, 461 inferior_sleep_seconds=3, 462 inferior_exe_path=None, 463 inferior_env=None): 464 """Prep the debug monitor, the inferior, and the expected packet stream. 465 466 Handle the separate cases of using the debug monitor in attach-to-inferior mode 467 and in launch-inferior mode. 468 469 For attach-to-inferior mode, the inferior process is first started, then 470 the debug monitor is started in attach to pid mode (using --attach on the 471 stub command line), and the no-ack-mode setup is appended to the packet 472 stream. The packet stream is not yet executed, ready to have more expected 473 packet entries added to it. 474 475 For launch-inferior mode, the stub is first started, then no ack mode is 476 setup on the expected packet stream, then the verified launch packets are added 477 to the expected socket stream. The packet stream is not yet executed, ready 478 to have more expected packet entries added to it. 479 480 The return value is: 481 {inferior:<inferior>, server:<server>} 482 """ 483 inferior = None 484 attach_pid = None 485 486 if self._inferior_startup == self._STARTUP_ATTACH or self._inferior_startup == self._STARTUP_ATTACH_MANUALLY: 487 # Launch the process that we'll use as the inferior. 488 inferior = self.launch_process_for_attach( 489 inferior_args=inferior_args, 490 sleep_seconds=inferior_sleep_seconds, 491 exe_path=inferior_exe_path) 492 self.assertIsNotNone(inferior) 493 self.assertTrue(inferior.pid > 0) 494 if self._inferior_startup == self._STARTUP_ATTACH: 495 # In this case, we want the stub to attach via the command 496 # line, so set the command line attach pid here. 497 attach_pid = inferior.pid 498 499 if self._inferior_startup == self._STARTUP_LAUNCH: 500 # Build launch args 501 if not inferior_exe_path: 502 inferior_exe_path = self.getBuildArtifact("a.out") 503 504 if lldb.remote_platform: 505 remote_path = lldbutil.append_to_process_working_directory(self, 506 os.path.basename(inferior_exe_path)) 507 remote_file_spec = lldb.SBFileSpec(remote_path, False) 508 err = lldb.remote_platform.Install(lldb.SBFileSpec( 509 inferior_exe_path, True), remote_file_spec) 510 if err.Fail(): 511 raise Exception( 512 "remote_platform.Install('%s', '%s') failed: %s" % 513 (inferior_exe_path, remote_path, err)) 514 inferior_exe_path = remote_path 515 516 launch_args = [inferior_exe_path] 517 if inferior_args: 518 launch_args.extend(inferior_args) 519 520 # Launch the debug monitor stub, attaching to the inferior. 521 server = self.connect_to_debug_monitor(attach_pid=attach_pid) 522 self.assertIsNotNone(server) 523 524 self.do_handshake() 525 526 # Build the expected protocol stream 527 if inferior_env: 528 for name, value in inferior_env.items(): 529 self.add_set_environment_packets(name, value) 530 if self._inferior_startup == self._STARTUP_LAUNCH: 531 self.add_verified_launch_packets(launch_args) 532 533 return {"inferior": inferior, "server": server} 534 535 def do_handshake(self): 536 server = self._server 537 server.send_ack() 538 server.send_packet(b"QStartNoAckMode") 539 self.assertEqual(server.get_normal_packet(), b"+") 540 self.assertEqual(server.get_normal_packet(), b"OK") 541 server.send_ack() 542 543 def add_verified_launch_packets(self, launch_args): 544 self.test_sequence.add_log_lines( 545 ["read packet: %s" % build_gdbremote_A_packet(launch_args), 546 "send packet: $OK#00", 547 "read packet: $qLaunchSuccess#a5", 548 "send packet: $OK#00"], 549 True) 550 551 def add_thread_suffix_request_packets(self): 552 self.test_sequence.add_log_lines( 553 ["read packet: $QThreadSuffixSupported#e4", 554 "send packet: $OK#00", 555 ], True) 556 557 def add_process_info_collection_packets(self): 558 self.test_sequence.add_log_lines( 559 ["read packet: $qProcessInfo#dc", 560 {"direction": "send", "regex": r"^\$(.+)#[0-9a-fA-F]{2}$", "capture": {1: "process_info_raw"}}], 561 True) 562 563 def add_set_environment_packets(self, name, value): 564 self.test_sequence.add_log_lines( 565 ["read packet: $QEnvironment:" + name + "=" + value + "#00", 566 "send packet: $OK#00", 567 ], True) 568 569 _KNOWN_PROCESS_INFO_KEYS = [ 570 "pid", 571 "parent-pid", 572 "real-uid", 573 "real-gid", 574 "effective-uid", 575 "effective-gid", 576 "cputype", 577 "cpusubtype", 578 "ostype", 579 "triple", 580 "vendor", 581 "endian", 582 "elf_abi", 583 "ptrsize" 584 ] 585 586 def parse_process_info_response(self, context): 587 # Ensure we have a process info response. 588 self.assertIsNotNone(context) 589 process_info_raw = context.get("process_info_raw") 590 self.assertIsNotNone(process_info_raw) 591 592 # Pull out key:value; pairs. 593 process_info_dict = { 594 match.group(1): match.group(2) for match in re.finditer( 595 r"([^:]+):([^;]+);", process_info_raw)} 596 597 # Validate keys are known. 598 for (key, val) in list(process_info_dict.items()): 599 self.assertTrue(key in self._KNOWN_PROCESS_INFO_KEYS) 600 self.assertIsNotNone(val) 601 602 return process_info_dict 603 604 def add_register_info_collection_packets(self): 605 self.test_sequence.add_log_lines( 606 [{"type": "multi_response", "query": "qRegisterInfo", "append_iteration_suffix": True, 607 "end_regex": re.compile(r"^\$(E\d+)?#[0-9a-fA-F]{2}$"), 608 "save_key": "reg_info_responses"}], 609 True) 610 611 def parse_register_info_packets(self, context): 612 """Return an array of register info dictionaries, one per register info.""" 613 reg_info_responses = context.get("reg_info_responses") 614 self.assertIsNotNone(reg_info_responses) 615 616 # Parse register infos. 617 return [parse_reg_info_response(reg_info_response) 618 for reg_info_response in reg_info_responses] 619 620 def expect_gdbremote_sequence(self): 621 return expect_lldb_gdbserver_replay( 622 self, 623 self._server, 624 self.test_sequence, 625 self.DEFAULT_TIMEOUT * len(self.test_sequence), 626 self.logger) 627 628 _KNOWN_REGINFO_KEYS = [ 629 "name", 630 "alt-name", 631 "bitsize", 632 "offset", 633 "encoding", 634 "format", 635 "set", 636 "gcc", 637 "ehframe", 638 "dwarf", 639 "generic", 640 "container-regs", 641 "invalidate-regs", 642 "dynamic_size_dwarf_expr_bytes", 643 "dynamic_size_dwarf_len" 644 ] 645 646 def assert_valid_reg_info(self, reg_info): 647 # Assert we know about all the reginfo keys parsed. 648 for key in reg_info: 649 self.assertTrue(key in self._KNOWN_REGINFO_KEYS) 650 651 # Check the bare-minimum expected set of register info keys. 652 self.assertTrue("name" in reg_info) 653 self.assertTrue("bitsize" in reg_info) 654 655 if not self.getArchitecture() == 'aarch64': 656 self.assertTrue("offset" in reg_info) 657 658 self.assertTrue("encoding" in reg_info) 659 self.assertTrue("format" in reg_info) 660 661 def find_pc_reg_info(self, reg_infos): 662 lldb_reg_index = 0 663 for reg_info in reg_infos: 664 if ("generic" in reg_info) and (reg_info["generic"] == "pc"): 665 return (lldb_reg_index, reg_info) 666 lldb_reg_index += 1 667 668 return (None, None) 669 670 def add_lldb_register_index(self, reg_infos): 671 """Add a "lldb_register_index" key containing the 0-baed index of each reg_infos entry. 672 673 We'll use this when we want to call packets like P/p with a register index but do so 674 on only a subset of the full register info set. 675 """ 676 self.assertIsNotNone(reg_infos) 677 678 reg_index = 0 679 for reg_info in reg_infos: 680 reg_info["lldb_register_index"] = reg_index 681 reg_index += 1 682 683 def add_query_memory_region_packets(self, address): 684 self.test_sequence.add_log_lines( 685 ["read packet: $qMemoryRegionInfo:{0:x}#00".format(address), 686 {"direction": "send", "regex": r"^\$(.+)#[0-9a-fA-F]{2}$", "capture": {1: "memory_region_response"}}], 687 True) 688 689 def parse_key_val_dict(self, key_val_text, allow_dupes=True): 690 self.assertIsNotNone(key_val_text) 691 kv_dict = {} 692 for match in re.finditer(r";?([^:]+):([^;]+)", key_val_text): 693 key = match.group(1) 694 val = match.group(2) 695 if key in kv_dict: 696 if allow_dupes: 697 if isinstance(kv_dict[key], list): 698 kv_dict[key].append(val) 699 else: 700 # Promote to list 701 kv_dict[key] = [kv_dict[key], val] 702 else: 703 self.fail( 704 "key '{}' already present when attempting to add value '{}' (text='{}', dict={})".format( 705 key, val, key_val_text, kv_dict)) 706 else: 707 kv_dict[key] = val 708 return kv_dict 709 710 def parse_memory_region_packet(self, context): 711 # Ensure we have a context. 712 self.assertIsNotNone(context.get("memory_region_response")) 713 714 # Pull out key:value; pairs. 715 mem_region_dict = self.parse_key_val_dict( 716 context.get("memory_region_response")) 717 718 # Validate keys are known. 719 for (key, val) in list(mem_region_dict.items()): 720 self.assertIn(key, 721 ["start", 722 "size", 723 "permissions", 724 "flags", 725 "name", 726 "error", 727 "dirty-pages", 728 "type"]) 729 self.assertIsNotNone(val) 730 731 mem_region_dict["name"] = seven.unhexlify(mem_region_dict.get("name", "")) 732 # Return the dictionary of key-value pairs for the memory region. 733 return mem_region_dict 734 735 def assert_address_within_memory_region( 736 self, test_address, mem_region_dict): 737 self.assertIsNotNone(mem_region_dict) 738 self.assertTrue("start" in mem_region_dict) 739 self.assertTrue("size" in mem_region_dict) 740 741 range_start = int(mem_region_dict["start"], 16) 742 range_size = int(mem_region_dict["size"], 16) 743 range_end = range_start + range_size 744 745 if test_address < range_start: 746 self.fail( 747 "address 0x{0:x} comes before range 0x{1:x} - 0x{2:x} (size 0x{3:x})".format( 748 test_address, 749 range_start, 750 range_end, 751 range_size)) 752 elif test_address >= range_end: 753 self.fail( 754 "address 0x{0:x} comes after range 0x{1:x} - 0x{2:x} (size 0x{3:x})".format( 755 test_address, 756 range_start, 757 range_end, 758 range_size)) 759 760 def add_threadinfo_collection_packets(self): 761 self.test_sequence.add_log_lines( 762 [{"type": "multi_response", "first_query": "qfThreadInfo", "next_query": "qsThreadInfo", 763 "append_iteration_suffix": False, "end_regex": re.compile(r"^\$(l)?#[0-9a-fA-F]{2}$"), 764 "save_key": "threadinfo_responses"}], 765 True) 766 767 def parse_threadinfo_packets(self, context): 768 """Return an array of thread ids (decimal ints), one per thread.""" 769 threadinfo_responses = context.get("threadinfo_responses") 770 self.assertIsNotNone(threadinfo_responses) 771 772 thread_ids = [] 773 for threadinfo_response in threadinfo_responses: 774 new_thread_infos = parse_threadinfo_response(threadinfo_response) 775 thread_ids.extend(new_thread_infos) 776 return thread_ids 777 778 def wait_for_thread_count(self, thread_count): 779 start_time = time.time() 780 timeout_time = start_time + self.DEFAULT_TIMEOUT 781 782 actual_thread_count = 0 783 while actual_thread_count < thread_count: 784 self.reset_test_sequence() 785 self.add_threadinfo_collection_packets() 786 787 context = self.expect_gdbremote_sequence() 788 self.assertIsNotNone(context) 789 790 threads = self.parse_threadinfo_packets(context) 791 self.assertIsNotNone(threads) 792 793 actual_thread_count = len(threads) 794 795 if time.time() > timeout_time: 796 raise Exception( 797 'timed out after {} seconds while waiting for theads: waiting for at least {} threads, found {}'.format( 798 self.DEFAULT_TIMEOUT, thread_count, actual_thread_count)) 799 800 return threads 801 802 def add_set_breakpoint_packets( 803 self, 804 address, 805 z_packet_type=0, 806 do_continue=True, 807 breakpoint_kind=1): 808 self.test_sequence.add_log_lines( 809 [ # Set the breakpoint. 810 "read packet: $Z{2},{0:x},{1}#00".format( 811 address, breakpoint_kind, z_packet_type), 812 # Verify the stub could set it. 813 "send packet: $OK#00", 814 ], True) 815 816 if (do_continue): 817 self.test_sequence.add_log_lines( 818 [ # Continue the inferior. 819 "read packet: $c#63", 820 # Expect a breakpoint stop report. 821 {"direction": "send", 822 "regex": r"^\$T([0-9a-fA-F]{2})thread:([0-9a-fA-F]+);", 823 "capture": {1: "stop_signo", 824 2: "stop_thread_id"}}, 825 ], True) 826 827 def add_remove_breakpoint_packets( 828 self, 829 address, 830 z_packet_type=0, 831 breakpoint_kind=1): 832 self.test_sequence.add_log_lines( 833 [ # Remove the breakpoint. 834 "read packet: $z{2},{0:x},{1}#00".format( 835 address, breakpoint_kind, z_packet_type), 836 # Verify the stub could unset it. 837 "send packet: $OK#00", 838 ], True) 839 840 def add_qSupported_packets(self, client_features=[]): 841 features = ''.join(';' + x for x in client_features) 842 self.test_sequence.add_log_lines( 843 ["read packet: $qSupported{}#00".format(features), 844 {"direction": "send", "regex": r"^\$(.*)#[0-9a-fA-F]{2}", "capture": {1: "qSupported_response"}}, 845 ], True) 846 847 _KNOWN_QSUPPORTED_STUB_FEATURES = [ 848 "augmented-libraries-svr4-read", 849 "PacketSize", 850 "QStartNoAckMode", 851 "QThreadSuffixSupported", 852 "QListThreadsInStopReply", 853 "qXfer:auxv:read", 854 "qXfer:libraries:read", 855 "qXfer:libraries-svr4:read", 856 "qXfer:features:read", 857 "qEcho", 858 "QPassSignals", 859 "multiprocess", 860 "fork-events", 861 "vfork-events", 862 "memory-tagging", 863 ] 864 865 def parse_qSupported_response(self, context): 866 self.assertIsNotNone(context) 867 868 raw_response = context.get("qSupported_response") 869 self.assertIsNotNone(raw_response) 870 871 # For values with key=val, the dict key and vals are set as expected. For feature+, feature- and feature?, the 872 # +,-,? is stripped from the key and set as the value. 873 supported_dict = {} 874 for match in re.finditer(r";?([^=;]+)(=([^;]+))?", raw_response): 875 key = match.group(1) 876 val = match.group(3) 877 878 # key=val: store as is 879 if val and len(val) > 0: 880 supported_dict[key] = val 881 else: 882 if len(key) < 2: 883 raise Exception( 884 "singular stub feature is too short: must be stub_feature{+,-,?}") 885 supported_type = key[-1] 886 key = key[:-1] 887 if not supported_type in ["+", "-", "?"]: 888 raise Exception( 889 "malformed stub feature: final character {} not in expected set (+,-,?)".format(supported_type)) 890 supported_dict[key] = supported_type 891 # Ensure we know the supported element 892 if key not in self._KNOWN_QSUPPORTED_STUB_FEATURES: 893 raise Exception( 894 "unknown qSupported stub feature reported: %s" % 895 key) 896 897 return supported_dict 898 899 def run_process_then_stop(self, run_seconds=1): 900 # Tell the stub to continue. 901 self.test_sequence.add_log_lines( 902 ["read packet: $vCont;c#a8"], 903 True) 904 context = self.expect_gdbremote_sequence() 905 906 # Wait for run_seconds. 907 time.sleep(run_seconds) 908 909 # Send an interrupt, capture a T response. 910 self.reset_test_sequence() 911 self.test_sequence.add_log_lines( 912 ["read packet: {}".format(chr(3)), 913 {"direction": "send", "regex": r"^\$T([0-9a-fA-F]+)([^#]+)#[0-9a-fA-F]{2}$", "capture": {1: "stop_result"}}], 914 True) 915 context = self.expect_gdbremote_sequence() 916 self.assertIsNotNone(context) 917 self.assertIsNotNone(context.get("stop_result")) 918 919 return context 920 921 def continue_process_and_wait_for_stop(self): 922 self.test_sequence.add_log_lines( 923 [ 924 "read packet: $vCont;c#a8", 925 { 926 "direction": "send", 927 "regex": r"^\$T([0-9a-fA-F]{2})(.*)#[0-9a-fA-F]{2}$", 928 "capture": {1: "stop_signo", 2: "stop_key_val_text"}, 929 }, 930 ], 931 True, 932 ) 933 context = self.expect_gdbremote_sequence() 934 self.assertIsNotNone(context) 935 return self.parse_interrupt_packets(context) 936 937 def select_modifiable_register(self, reg_infos): 938 """Find a register that can be read/written freely.""" 939 PREFERRED_REGISTER_NAMES = set(["rax", ]) 940 941 # First check for the first register from the preferred register name 942 # set. 943 alternative_register_index = None 944 945 self.assertIsNotNone(reg_infos) 946 for reg_info in reg_infos: 947 if ("name" in reg_info) and ( 948 reg_info["name"] in PREFERRED_REGISTER_NAMES): 949 # We found a preferred register. Use it. 950 return reg_info["lldb_register_index"] 951 if ("generic" in reg_info) and (reg_info["generic"] == "fp" or 952 reg_info["generic"] == "arg1"): 953 # A frame pointer or first arg register will do as a 954 # register to modify temporarily. 955 alternative_register_index = reg_info["lldb_register_index"] 956 957 # We didn't find a preferred register. Return whatever alternative register 958 # we found, if any. 959 return alternative_register_index 960 961 def extract_registers_from_stop_notification(self, stop_key_vals_text): 962 self.assertIsNotNone(stop_key_vals_text) 963 kv_dict = self.parse_key_val_dict(stop_key_vals_text) 964 965 registers = {} 966 for (key, val) in list(kv_dict.items()): 967 if re.match(r"^[0-9a-fA-F]+$", key): 968 registers[int(key, 16)] = val 969 return registers 970 971 def gather_register_infos(self): 972 self.reset_test_sequence() 973 self.add_register_info_collection_packets() 974 975 context = self.expect_gdbremote_sequence() 976 self.assertIsNotNone(context) 977 978 reg_infos = self.parse_register_info_packets(context) 979 self.assertIsNotNone(reg_infos) 980 self.add_lldb_register_index(reg_infos) 981 982 return reg_infos 983 984 def find_generic_register_with_name(self, reg_infos, generic_name): 985 self.assertIsNotNone(reg_infos) 986 for reg_info in reg_infos: 987 if ("generic" in reg_info) and ( 988 reg_info["generic"] == generic_name): 989 return reg_info 990 return None 991 992 def find_register_with_name_and_dwarf_regnum(self, reg_infos, name, dwarf_num): 993 self.assertIsNotNone(reg_infos) 994 for reg_info in reg_infos: 995 if (reg_info["name"] == name) and (reg_info["dwarf"] == dwarf_num): 996 return reg_info 997 return None 998 999 def decode_gdbremote_binary(self, encoded_bytes): 1000 decoded_bytes = "" 1001 i = 0 1002 while i < len(encoded_bytes): 1003 if encoded_bytes[i] == "}": 1004 # Handle escaped char. 1005 self.assertTrue(i + 1 < len(encoded_bytes)) 1006 decoded_bytes += chr(ord(encoded_bytes[i + 1]) ^ 0x20) 1007 i += 2 1008 elif encoded_bytes[i] == "*": 1009 # Handle run length encoding. 1010 self.assertTrue(len(decoded_bytes) > 0) 1011 self.assertTrue(i + 1 < len(encoded_bytes)) 1012 repeat_count = ord(encoded_bytes[i + 1]) - 29 1013 decoded_bytes += decoded_bytes[-1] * repeat_count 1014 i += 2 1015 else: 1016 decoded_bytes += encoded_bytes[i] 1017 i += 1 1018 return decoded_bytes 1019 1020 def build_auxv_dict(self, endian, word_size, auxv_data): 1021 self.assertIsNotNone(endian) 1022 self.assertIsNotNone(word_size) 1023 self.assertIsNotNone(auxv_data) 1024 1025 auxv_dict = {} 1026 1027 # PowerPC64le's auxvec has a special key that must be ignored. 1028 # This special key may be used multiple times, resulting in 1029 # multiple key/value pairs with the same key, which would otherwise 1030 # break this test check for repeated keys. 1031 # 1032 # AT_IGNOREPPC = 22 1033 ignored_keys_for_arch = { 'powerpc64le' : [22] } 1034 arch = self.getArchitecture() 1035 ignore_keys = None 1036 if arch in ignored_keys_for_arch: 1037 ignore_keys = ignored_keys_for_arch[arch] 1038 1039 while len(auxv_data) > 0: 1040 # Chop off key. 1041 raw_key = auxv_data[:word_size] 1042 auxv_data = auxv_data[word_size:] 1043 1044 # Chop of value. 1045 raw_value = auxv_data[:word_size] 1046 auxv_data = auxv_data[word_size:] 1047 1048 # Convert raw text from target endian. 1049 key = unpack_endian_binary_string(endian, raw_key) 1050 value = unpack_endian_binary_string(endian, raw_value) 1051 1052 if ignore_keys and key in ignore_keys: 1053 continue 1054 1055 # Handle ending entry. 1056 if key == 0: 1057 self.assertEqual(value, 0) 1058 return auxv_dict 1059 1060 # The key should not already be present. 1061 self.assertFalse(key in auxv_dict) 1062 auxv_dict[key] = value 1063 1064 self.fail( 1065 "should not reach here - implies required double zero entry not found") 1066 return auxv_dict 1067 1068 def read_binary_data_in_chunks(self, command_prefix, chunk_length): 1069 """Collect command_prefix{offset:x},{chunk_length:x} until a single 'l' or 'l' with data is returned.""" 1070 offset = 0 1071 done = False 1072 decoded_data = "" 1073 1074 while not done: 1075 # Grab the next iteration of data. 1076 self.reset_test_sequence() 1077 self.test_sequence.add_log_lines( 1078 [ 1079 "read packet: ${}{:x},{:x}:#00".format( 1080 command_prefix, 1081 offset, 1082 chunk_length), 1083 { 1084 "direction": "send", 1085 "regex": re.compile( 1086 r"^\$([^E])(.*)#[0-9a-fA-F]{2}$", 1087 re.MULTILINE | re.DOTALL), 1088 "capture": { 1089 1: "response_type", 1090 2: "content_raw"}}], 1091 True) 1092 1093 context = self.expect_gdbremote_sequence() 1094 self.assertIsNotNone(context) 1095 1096 response_type = context.get("response_type") 1097 self.assertIsNotNone(response_type) 1098 self.assertTrue(response_type in ["l", "m"]) 1099 1100 # Move offset along. 1101 offset += chunk_length 1102 1103 # Figure out if we're done. We're done if the response type is l. 1104 done = response_type == "l" 1105 1106 # Decode binary data. 1107 content_raw = context.get("content_raw") 1108 if content_raw and len(content_raw) > 0: 1109 self.assertIsNotNone(content_raw) 1110 decoded_data += self.decode_gdbremote_binary(content_raw) 1111 return decoded_data 1112 1113 def add_interrupt_packets(self): 1114 self.test_sequence.add_log_lines([ 1115 # Send the intterupt. 1116 "read packet: {}".format(chr(3)), 1117 # And wait for the stop notification. 1118 {"direction": "send", 1119 "regex": r"^\$T([0-9a-fA-F]{2})(.*)#[0-9a-fA-F]{2}$", 1120 "capture": {1: "stop_signo", 1121 2: "stop_key_val_text"}}, 1122 ], True) 1123 1124 def parse_interrupt_packets(self, context): 1125 self.assertIsNotNone(context.get("stop_signo")) 1126 self.assertIsNotNone(context.get("stop_key_val_text")) 1127 return (int(context["stop_signo"], 16), self.parse_key_val_dict( 1128 context["stop_key_val_text"])) 1129 1130 def add_QSaveRegisterState_packets(self, thread_id): 1131 if thread_id: 1132 # Use the thread suffix form. 1133 request = "read packet: $QSaveRegisterState;thread:{:x}#00".format( 1134 thread_id) 1135 else: 1136 request = "read packet: $QSaveRegisterState#00" 1137 1138 self.test_sequence.add_log_lines([request, 1139 {"direction": "send", 1140 "regex": r"^\$(E?.*)#[0-9a-fA-F]{2}$", 1141 "capture": {1: "save_response"}}, 1142 ], 1143 True) 1144 1145 def parse_QSaveRegisterState_response(self, context): 1146 self.assertIsNotNone(context) 1147 1148 save_response = context.get("save_response") 1149 self.assertIsNotNone(save_response) 1150 1151 if len(save_response) < 1 or save_response[0] == "E": 1152 # error received 1153 return (False, None) 1154 else: 1155 return (True, int(save_response)) 1156 1157 def add_QRestoreRegisterState_packets(self, save_id, thread_id=None): 1158 if thread_id: 1159 # Use the thread suffix form. 1160 request = "read packet: $QRestoreRegisterState:{};thread:{:x}#00".format( 1161 save_id, thread_id) 1162 else: 1163 request = "read packet: $QRestoreRegisterState:{}#00".format( 1164 save_id) 1165 1166 self.test_sequence.add_log_lines([ 1167 request, 1168 "send packet: $OK#00" 1169 ], True) 1170 1171 def flip_all_bits_in_each_register_value( 1172 self, reg_infos, endian, thread_id=None): 1173 self.assertIsNotNone(reg_infos) 1174 1175 successful_writes = 0 1176 failed_writes = 0 1177 1178 for reg_info in reg_infos: 1179 # Use the lldb register index added to the reg info. We're not necessarily 1180 # working off a full set of register infos, so an inferred register 1181 # index could be wrong. 1182 reg_index = reg_info["lldb_register_index"] 1183 self.assertIsNotNone(reg_index) 1184 1185 reg_byte_size = int(reg_info["bitsize"]) // 8 1186 self.assertTrue(reg_byte_size > 0) 1187 1188 # Handle thread suffix. 1189 if thread_id: 1190 p_request = "read packet: $p{:x};thread:{:x}#00".format( 1191 reg_index, thread_id) 1192 else: 1193 p_request = "read packet: $p{:x}#00".format(reg_index) 1194 1195 # Read the existing value. 1196 self.reset_test_sequence() 1197 self.test_sequence.add_log_lines([ 1198 p_request, 1199 {"direction": "send", "regex": r"^\$([0-9a-fA-F]+)#", "capture": {1: "p_response"}}, 1200 ], True) 1201 context = self.expect_gdbremote_sequence() 1202 self.assertIsNotNone(context) 1203 1204 # Verify the response length. 1205 p_response = context.get("p_response") 1206 self.assertIsNotNone(p_response) 1207 initial_reg_value = unpack_register_hex_unsigned( 1208 endian, p_response) 1209 1210 # Flip the value by xoring with all 1s 1211 all_one_bits_raw = "ff" * (int(reg_info["bitsize"]) // 8) 1212 flipped_bits_int = initial_reg_value ^ int(all_one_bits_raw, 16) 1213 # print("reg (index={}, name={}): val={}, flipped bits (int={}, hex={:x})".format(reg_index, reg_info["name"], initial_reg_value, flipped_bits_int, flipped_bits_int)) 1214 1215 # Handle thread suffix for P. 1216 if thread_id: 1217 P_request = "read packet: $P{:x}={};thread:{:x}#00".format( 1218 reg_index, pack_register_hex( 1219 endian, flipped_bits_int, byte_size=reg_byte_size), thread_id) 1220 else: 1221 P_request = "read packet: $P{:x}={}#00".format( 1222 reg_index, pack_register_hex( 1223 endian, flipped_bits_int, byte_size=reg_byte_size)) 1224 1225 # Write the flipped value to the register. 1226 self.reset_test_sequence() 1227 self.test_sequence.add_log_lines([P_request, 1228 {"direction": "send", 1229 "regex": r"^\$(OK|E[0-9a-fA-F]+)#[0-9a-fA-F]{2}", 1230 "capture": {1: "P_response"}}, 1231 ], 1232 True) 1233 context = self.expect_gdbremote_sequence() 1234 self.assertIsNotNone(context) 1235 1236 # Determine if the write succeeded. There are a handful of registers that can fail, or partially fail 1237 # (e.g. flags, segment selectors, etc.) due to register value restrictions. Don't worry about them 1238 # all flipping perfectly. 1239 P_response = context.get("P_response") 1240 self.assertIsNotNone(P_response) 1241 if P_response == "OK": 1242 successful_writes += 1 1243 else: 1244 failed_writes += 1 1245 # print("reg (index={}, name={}) write FAILED (error: {})".format(reg_index, reg_info["name"], P_response)) 1246 1247 # Read back the register value, ensure it matches the flipped 1248 # value. 1249 if P_response == "OK": 1250 self.reset_test_sequence() 1251 self.test_sequence.add_log_lines([ 1252 p_request, 1253 {"direction": "send", "regex": r"^\$([0-9a-fA-F]+)#", "capture": {1: "p_response"}}, 1254 ], True) 1255 context = self.expect_gdbremote_sequence() 1256 self.assertIsNotNone(context) 1257 1258 verify_p_response_raw = context.get("p_response") 1259 self.assertIsNotNone(verify_p_response_raw) 1260 verify_bits = unpack_register_hex_unsigned( 1261 endian, verify_p_response_raw) 1262 1263 if verify_bits != flipped_bits_int: 1264 # Some registers, like mxcsrmask and others, will permute what's written. Adjust succeed/fail counts. 1265 # print("reg (index={}, name={}): read verify FAILED: wrote {:x}, verify read back {:x}".format(reg_index, reg_info["name"], flipped_bits_int, verify_bits)) 1266 successful_writes -= 1 1267 failed_writes += 1 1268 1269 return (successful_writes, failed_writes) 1270 1271 def is_bit_flippable_register(self, reg_info): 1272 if not reg_info: 1273 return False 1274 if not "set" in reg_info: 1275 return False 1276 if reg_info["set"] != "General Purpose Registers": 1277 return False 1278 if ("container-regs" in reg_info) and ( 1279 len(reg_info["container-regs"]) > 0): 1280 # Don't try to bit flip registers contained in another register. 1281 return False 1282 if re.match("^.s$", reg_info["name"]): 1283 # This is a 2-letter register name that ends in "s", like a segment register. 1284 # Don't try to bit flip these. 1285 return False 1286 if re.match("^(c|)psr$", reg_info["name"]): 1287 # This is an ARM program status register; don't flip it. 1288 return False 1289 # Okay, this looks fine-enough. 1290 return True 1291 1292 def read_register_values(self, reg_infos, endian, thread_id=None): 1293 self.assertIsNotNone(reg_infos) 1294 values = {} 1295 1296 for reg_info in reg_infos: 1297 # We append a register index when load reg infos so we can work 1298 # with subsets. 1299 reg_index = reg_info.get("lldb_register_index") 1300 self.assertIsNotNone(reg_index) 1301 1302 # Handle thread suffix. 1303 if thread_id: 1304 p_request = "read packet: $p{:x};thread:{:x}#00".format( 1305 reg_index, thread_id) 1306 else: 1307 p_request = "read packet: $p{:x}#00".format(reg_index) 1308 1309 # Read it with p. 1310 self.reset_test_sequence() 1311 self.test_sequence.add_log_lines([ 1312 p_request, 1313 {"direction": "send", "regex": r"^\$([0-9a-fA-F]+)#", "capture": {1: "p_response"}}, 1314 ], True) 1315 context = self.expect_gdbremote_sequence() 1316 self.assertIsNotNone(context) 1317 1318 # Convert value from target endian to integral. 1319 p_response = context.get("p_response") 1320 self.assertIsNotNone(p_response) 1321 self.assertTrue(len(p_response) > 0) 1322 self.assertFalse(p_response[0] == "E") 1323 1324 values[reg_index] = unpack_register_hex_unsigned( 1325 endian, p_response) 1326 1327 return values 1328 1329 def add_vCont_query_packets(self): 1330 self.test_sequence.add_log_lines(["read packet: $vCont?#49", 1331 {"direction": "send", 1332 "regex": r"^\$(vCont)?(.*)#[0-9a-fA-F]{2}$", 1333 "capture": {2: "vCont_query_response"}}, 1334 ], 1335 True) 1336 1337 def parse_vCont_query_response(self, context): 1338 self.assertIsNotNone(context) 1339 vCont_query_response = context.get("vCont_query_response") 1340 1341 # Handle case of no vCont support at all - in which case the capture 1342 # group will be none or zero length. 1343 if not vCont_query_response or len(vCont_query_response) == 0: 1344 return {} 1345 1346 return {key: 1 for key in vCont_query_response.split( 1347 ";") if key and len(key) > 0} 1348 1349 def count_single_steps_until_true( 1350 self, 1351 thread_id, 1352 predicate, 1353 args, 1354 max_step_count=100, 1355 use_Hc_packet=True, 1356 step_instruction="s"): 1357 """Used by single step test that appears in a few different contexts.""" 1358 single_step_count = 0 1359 1360 while single_step_count < max_step_count: 1361 self.assertIsNotNone(thread_id) 1362 1363 # Build the packet for the single step instruction. We replace 1364 # {thread}, if present, with the thread_id. 1365 step_packet = "read packet: ${}#00".format( 1366 re.sub(r"{thread}", "{:x}".format(thread_id), step_instruction)) 1367 # print("\nstep_packet created: {}\n".format(step_packet)) 1368 1369 # Single step. 1370 self.reset_test_sequence() 1371 if use_Hc_packet: 1372 self.test_sequence.add_log_lines( 1373 [ # Set the continue thread. 1374 "read packet: $Hc{0:x}#00".format(thread_id), 1375 "send packet: $OK#00", 1376 ], True) 1377 self.test_sequence.add_log_lines([ 1378 # Single step. 1379 step_packet, 1380 # "read packet: $vCont;s:{0:x}#00".format(thread_id), 1381 # Expect a breakpoint stop report. 1382 {"direction": "send", 1383 "regex": r"^\$T([0-9a-fA-F]{2})thread:([0-9a-fA-F]+);", 1384 "capture": {1: "stop_signo", 1385 2: "stop_thread_id"}}, 1386 ], True) 1387 context = self.expect_gdbremote_sequence() 1388 self.assertIsNotNone(context) 1389 self.assertIsNotNone(context.get("stop_signo")) 1390 self.assertEqual(int(context.get("stop_signo"), 16), 1391 lldbutil.get_signal_number('SIGTRAP')) 1392 1393 single_step_count += 1 1394 1395 # See if the predicate is true. If so, we're done. 1396 if predicate(args): 1397 return (True, single_step_count) 1398 1399 # The predicate didn't return true within the runaway step count. 1400 return (False, single_step_count) 1401 1402 def g_c1_c2_contents_are(self, args): 1403 """Used by single step test that appears in a few different contexts.""" 1404 g_c1_address = args["g_c1_address"] 1405 g_c2_address = args["g_c2_address"] 1406 expected_g_c1 = args["expected_g_c1"] 1407 expected_g_c2 = args["expected_g_c2"] 1408 1409 # Read g_c1 and g_c2 contents. 1410 self.reset_test_sequence() 1411 self.test_sequence.add_log_lines( 1412 ["read packet: $m{0:x},{1:x}#00".format(g_c1_address, 1), 1413 {"direction": "send", "regex": r"^\$(.+)#[0-9a-fA-F]{2}$", "capture": {1: "g_c1_contents"}}, 1414 "read packet: $m{0:x},{1:x}#00".format(g_c2_address, 1), 1415 {"direction": "send", "regex": r"^\$(.+)#[0-9a-fA-F]{2}$", "capture": {1: "g_c2_contents"}}], 1416 True) 1417 1418 # Run the packet stream. 1419 context = self.expect_gdbremote_sequence() 1420 self.assertIsNotNone(context) 1421 1422 # Check if what we read from inferior memory is what we are expecting. 1423 self.assertIsNotNone(context.get("g_c1_contents")) 1424 self.assertIsNotNone(context.get("g_c2_contents")) 1425 1426 return (seven.unhexlify(context.get("g_c1_contents")) == expected_g_c1) and ( 1427 seven.unhexlify(context.get("g_c2_contents")) == expected_g_c2) 1428 1429 def single_step_only_steps_one_instruction( 1430 self, use_Hc_packet=True, step_instruction="s"): 1431 """Used by single step test that appears in a few different contexts.""" 1432 # Start up the inferior. 1433 procs = self.prep_debug_monitor_and_inferior( 1434 inferior_args=[ 1435 "get-code-address-hex:swap_chars", 1436 "get-data-address-hex:g_c1", 1437 "get-data-address-hex:g_c2", 1438 "sleep:1", 1439 "call-function:swap_chars", 1440 "sleep:5"]) 1441 1442 # Run the process 1443 self.test_sequence.add_log_lines( 1444 [ # Start running after initial stop. 1445 "read packet: $c#63", 1446 # Match output line that prints the memory address of the function call entry point. 1447 # Note we require launch-only testing so we can get inferior otuput. 1448 {"type": "output_match", "regex": r"^code address: 0x([0-9a-fA-F]+)\r\ndata address: 0x([0-9a-fA-F]+)\r\ndata address: 0x([0-9a-fA-F]+)\r\n$", 1449 "capture": {1: "function_address", 2: "g_c1_address", 3: "g_c2_address"}}, 1450 # Now stop the inferior. 1451 "read packet: {}".format(chr(3)), 1452 # And wait for the stop notification. 1453 {"direction": "send", "regex": r"^\$T([0-9a-fA-F]{2})thread:([0-9a-fA-F]+);", "capture": {1: "stop_signo", 2: "stop_thread_id"}}], 1454 True) 1455 1456 # Run the packet stream. 1457 context = self.expect_gdbremote_sequence() 1458 self.assertIsNotNone(context) 1459 1460 # Grab the main thread id. 1461 self.assertIsNotNone(context.get("stop_thread_id")) 1462 main_thread_id = int(context.get("stop_thread_id"), 16) 1463 1464 # Grab the function address. 1465 self.assertIsNotNone(context.get("function_address")) 1466 function_address = int(context.get("function_address"), 16) 1467 1468 # Grab the data addresses. 1469 self.assertIsNotNone(context.get("g_c1_address")) 1470 g_c1_address = int(context.get("g_c1_address"), 16) 1471 1472 self.assertIsNotNone(context.get("g_c2_address")) 1473 g_c2_address = int(context.get("g_c2_address"), 16) 1474 1475 # Set a breakpoint at the given address. 1476 if self.getArchitecture().startswith("arm"): 1477 # TODO: Handle case when setting breakpoint in thumb code 1478 BREAKPOINT_KIND = 4 1479 else: 1480 BREAKPOINT_KIND = 1 1481 self.reset_test_sequence() 1482 self.add_set_breakpoint_packets( 1483 function_address, 1484 do_continue=True, 1485 breakpoint_kind=BREAKPOINT_KIND) 1486 context = self.expect_gdbremote_sequence() 1487 self.assertIsNotNone(context) 1488 1489 # Remove the breakpoint. 1490 self.reset_test_sequence() 1491 self.add_remove_breakpoint_packets( 1492 function_address, breakpoint_kind=BREAKPOINT_KIND) 1493 context = self.expect_gdbremote_sequence() 1494 self.assertIsNotNone(context) 1495 1496 # Verify g_c1 and g_c2 match expected initial state. 1497 args = {} 1498 args["g_c1_address"] = g_c1_address 1499 args["g_c2_address"] = g_c2_address 1500 args["expected_g_c1"] = "0" 1501 args["expected_g_c2"] = "1" 1502 1503 self.assertTrue(self.g_c1_c2_contents_are(args)) 1504 1505 # Verify we take only a small number of steps to hit the first state. 1506 # Might need to work through function entry prologue code. 1507 args["expected_g_c1"] = "1" 1508 args["expected_g_c2"] = "1" 1509 (state_reached, 1510 step_count) = self.count_single_steps_until_true(main_thread_id, 1511 self.g_c1_c2_contents_are, 1512 args, 1513 max_step_count=25, 1514 use_Hc_packet=use_Hc_packet, 1515 step_instruction=step_instruction) 1516 self.assertTrue(state_reached) 1517 1518 # Verify we hit the next state. 1519 args["expected_g_c1"] = "1" 1520 args["expected_g_c2"] = "0" 1521 (state_reached, 1522 step_count) = self.count_single_steps_until_true(main_thread_id, 1523 self.g_c1_c2_contents_are, 1524 args, 1525 max_step_count=5, 1526 use_Hc_packet=use_Hc_packet, 1527 step_instruction=step_instruction) 1528 self.assertTrue(state_reached) 1529 expected_step_count = 1 1530 arch = self.getArchitecture() 1531 1532 # MIPS required "3" (ADDIU, SB, LD) machine instructions for updation 1533 # of variable value 1534 if re.match("mips", arch): 1535 expected_step_count = 3 1536 # S390X requires "2" (LARL, MVI) machine instructions for updation of 1537 # variable value 1538 if re.match("s390x", arch): 1539 expected_step_count = 2 1540 # ARM64 requires "4" instructions: 2 to compute the address (adrp, add), 1541 # one to materialize the constant (mov) and the store 1542 if re.match("arm64", arch): 1543 expected_step_count = 4 1544 1545 self.assertEqual(step_count, expected_step_count) 1546 1547 # ARM64: Once addresses and constants are materialized, only one 1548 # instruction is needed. 1549 if re.match("arm64", arch): 1550 expected_step_count = 1 1551 1552 # Verify we hit the next state. 1553 args["expected_g_c1"] = "0" 1554 args["expected_g_c2"] = "0" 1555 (state_reached, 1556 step_count) = self.count_single_steps_until_true(main_thread_id, 1557 self.g_c1_c2_contents_are, 1558 args, 1559 max_step_count=5, 1560 use_Hc_packet=use_Hc_packet, 1561 step_instruction=step_instruction) 1562 self.assertTrue(state_reached) 1563 self.assertEqual(step_count, expected_step_count) 1564 1565 # Verify we hit the next state. 1566 args["expected_g_c1"] = "0" 1567 args["expected_g_c2"] = "1" 1568 (state_reached, 1569 step_count) = self.count_single_steps_until_true(main_thread_id, 1570 self.g_c1_c2_contents_are, 1571 args, 1572 max_step_count=5, 1573 use_Hc_packet=use_Hc_packet, 1574 step_instruction=step_instruction) 1575 self.assertTrue(state_reached) 1576 self.assertEqual(step_count, expected_step_count) 1577 1578 def maybe_strict_output_regex(self, regex): 1579 return '.*' + regex + \ 1580 '.*' if lldbplatformutil.hasChattyStderr(self) else '^' + regex + '$' 1581 1582 def install_and_create_launch_args(self): 1583 exe_path = self.getBuildArtifact("a.out") 1584 if not lldb.remote_platform: 1585 return [exe_path] 1586 remote_path = lldbutil.append_to_process_working_directory(self, 1587 os.path.basename(exe_path)) 1588 remote_file_spec = lldb.SBFileSpec(remote_path, False) 1589 err = lldb.remote_platform.Install(lldb.SBFileSpec(exe_path, True), 1590 remote_file_spec) 1591 if err.Fail(): 1592 raise Exception("remote_platform.Install('%s', '%s') failed: %s" % 1593 (exe_path, remote_path, err)) 1594 return [remote_path] 1595