4d48c1bc07
Both the report() function as well as the initial gdbstub test sequence are copy-pasted into ~10 files with slight modifications. This indicates that they are indeed generic, so factor them out. While at it, add a few newlines to make the formatting closer to PEP-8. Signed-off-by: Ilya Leoshkevich <iii@linux.ibm.com> Message-Id: <20240129093410.3151-3-iii@linux.ibm.com> Signed-off-by: Richard Henderson <richard.henderson@linaro.org>
122 lines
3.7 KiB
Python
Executable File
122 lines
3.7 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
#
|
|
# Run a gdbstub test case
|
|
#
|
|
# Copyright (c) 2019 Linaro
|
|
#
|
|
# Author: Alex Bennée <alex.bennee@linaro.org>
|
|
#
|
|
# This work is licensed under the terms of the GNU GPL, version 2 or later.
|
|
# See the COPYING file in the top-level directory.
|
|
#
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
import argparse
|
|
import subprocess
|
|
import shutil
|
|
import shlex
|
|
import os
|
|
from time import sleep
|
|
from tempfile import TemporaryDirectory
|
|
|
|
def get_args():
|
|
parser = argparse.ArgumentParser(description="A gdbstub test runner")
|
|
parser.add_argument("--qemu", help="Qemu binary for test",
|
|
required=True)
|
|
parser.add_argument("--qargs", help="Qemu arguments for test")
|
|
parser.add_argument("--binary", help="Binary to debug",
|
|
required=True)
|
|
parser.add_argument("--test", help="GDB test script")
|
|
parser.add_argument("--gdb", help="The gdb binary to use",
|
|
default=None)
|
|
parser.add_argument("--gdb-args", help="Additional gdb arguments")
|
|
parser.add_argument("--output", help="A file to redirect output to")
|
|
parser.add_argument("--stderr", help="A file to redirect stderr to")
|
|
|
|
return parser.parse_args()
|
|
|
|
|
|
def log(output, msg):
|
|
if output:
|
|
output.write(msg + "\n")
|
|
output.flush()
|
|
else:
|
|
print(msg)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
args = get_args()
|
|
|
|
# Search for a gdb we can use
|
|
if not args.gdb:
|
|
args.gdb = shutil.which("gdb-multiarch")
|
|
if not args.gdb:
|
|
args.gdb = shutil.which("gdb")
|
|
if not args.gdb:
|
|
print("We need gdb to run the test")
|
|
exit(-1)
|
|
if args.output:
|
|
output = open(args.output, "w")
|
|
else:
|
|
output = None
|
|
if args.stderr:
|
|
stderr = open(args.stderr, "w")
|
|
else:
|
|
stderr = None
|
|
|
|
socket_dir = TemporaryDirectory("qemu-gdbstub")
|
|
socket_name = os.path.join(socket_dir.name, "gdbstub.socket")
|
|
|
|
# Launch QEMU with binary
|
|
if "system" in args.qemu:
|
|
cmd = f'{args.qemu} {args.qargs} {args.binary}' \
|
|
f' -S -gdb unix:path={socket_name},server=on'
|
|
else:
|
|
cmd = f'{args.qemu} {args.qargs} -g {socket_name} {args.binary}'
|
|
|
|
log(output, "QEMU CMD: %s" % (cmd))
|
|
inferior = subprocess.Popen(shlex.split(cmd))
|
|
|
|
# Now launch gdb with our test and collect the result
|
|
gdb_cmd = "%s %s" % (args.gdb, args.binary)
|
|
if args.gdb_args:
|
|
gdb_cmd += " %s" % (args.gdb_args)
|
|
# run quietly and ignore .gdbinit
|
|
gdb_cmd += " -q -n -batch"
|
|
# disable pagination
|
|
gdb_cmd += " -ex 'set pagination off'"
|
|
# disable prompts in case of crash
|
|
gdb_cmd += " -ex 'set confirm off'"
|
|
# connect to remote
|
|
gdb_cmd += " -ex 'target remote %s'" % (socket_name)
|
|
# finally the test script itself
|
|
if args.test:
|
|
gdb_cmd += " -x %s" % (args.test)
|
|
|
|
|
|
sleep(1)
|
|
log(output, "GDB CMD: %s" % (gdb_cmd))
|
|
|
|
gdb_env = dict(os.environ)
|
|
gdb_pythonpath = gdb_env.get("PYTHONPATH", "").split(os.pathsep)
|
|
gdb_pythonpath.append(os.path.dirname(os.path.realpath(__file__)))
|
|
gdb_env["PYTHONPATH"] = os.pathsep.join(gdb_pythonpath)
|
|
result = subprocess.call(gdb_cmd, shell=True, stdout=output, stderr=stderr,
|
|
env=gdb_env)
|
|
|
|
# A result of greater than 128 indicates a fatal signal (likely a
|
|
# crash due to gdb internal failure). That's a problem for GDB and
|
|
# not the test so we force a return of 0 so we don't fail the test on
|
|
# account of broken external tools.
|
|
if result > 128:
|
|
log(output, "GDB crashed? (%d, %d) SKIPPING" % (result, result - 128))
|
|
exit(0)
|
|
|
|
try:
|
|
inferior.wait(2)
|
|
except subprocess.TimeoutExpired:
|
|
log(output, "GDB never connected? Killed guest")
|
|
inferior.kill()
|
|
|
|
exit(result)
|