Make pylint happy.
[riscv-tests.git] / debug / testlib.py
index e1be100f41ad3288eddb7ae41b09160b121c5cfa..90702bf605652b08372a3a96f2b0b4af07403cf7 100644 (file)
@@ -12,6 +12,9 @@ import traceback
 
 import pexpect
 
+print_log_names = False
+real_stdout = sys.stdout
+
 # Note that gdb comes with its own testsuite. I was unable to figure out how to
 # run that testsuite against the spike simulator.
 
@@ -70,6 +73,8 @@ class Spike(object):
         self.logfile = tempfile.NamedTemporaryFile(prefix="spike-",
                 suffix=".log")
         self.logname = self.logfile.name
+        if print_log_names:
+            real_stdout.write("Temporary spike log: %s\n" % self.logname)
         self.logfile.write("+ %s\n" % " ".join(cmd))
         self.logfile.flush()
         self.process = subprocess.Popen(cmd, stdin=subprocess.PIPE,
@@ -182,7 +187,6 @@ class VcsSim(object):
 class Openocd(object):
     logfile = tempfile.NamedTemporaryFile(prefix='openocd', suffix='.log')
     logname = logfile.name
-    print "OpenOCD Temporary Log File: %s" % logname
 
     def __init__(self, server_cmd=None, config=None, debug=False, timeout=60):
         self.timeout = timeout
@@ -221,6 +225,8 @@ class Openocd(object):
             cmd.append("-d")
 
         logfile = open(Openocd.logname, "w")
+        if print_log_names:
+            real_stdout.write("Temporary OpenOCD log: %s\n" % Openocd.logname)
         logfile.write("+ %s\n" % " ".join(cmd))
         logfile.flush()
 
@@ -311,13 +317,20 @@ class Gdb(object):
     """A single gdb class which can interact with one or more gdb instances."""
 
     # pylint: disable=too-many-public-methods
+    # pylint: disable=too-many-instance-attributes
 
     def __init__(self, ports,
             cmd=os.path.expandvars("$RISCV/bin/riscv64-unknown-elf-gdb"),
-            binary=None):
+            timeout=60, binary=None):
         assert ports
 
+        self.ports = ports
+        self.cmd = cmd
+        self.timeout = timeout
+        self.binary = binary
+
         self.stack = []
+        self.harts = {}
 
         self.logfiles = []
         self.children = []
@@ -325,14 +338,16 @@ class Gdb(object):
             logfile = tempfile.NamedTemporaryFile(prefix="gdb@%d-" % port,
                     suffix=".log")
             self.logfiles.append(logfile)
+            if print_log_names:
+                real_stdout.write("Temporary gdb log: %s\n" % logfile.name)
             child = pexpect.spawn(cmd)
             child.logfile = logfile
             child.logfile.write("+ %s\n" % cmd)
             self.children.append(child)
         self.active_child = self.children[0]
 
-        self.harts = {}
-        for port, child in zip(ports, self.children):
+    def connect(self):
+        for port, child in zip(self.ports, self.children):
             self.select_child(child)
             self.wait()
             self.command("set confirm off")
@@ -340,9 +355,10 @@ class Gdb(object):
             self.command("set height 0")
             # Force consistency.
             self.command("set print entry-values no")
+            self.command("set remotetimeout %d" % self.timeout)
             self.command("target extended-remote localhost:%d" % port)
-            if binary:
-                self.command("file %s" % binary)
+            if self.binary:
+                self.command("file %s" % self.binary)
             threads = self.threads()
             for t in threads:
                 hartid = None
@@ -555,7 +571,7 @@ def run_all_tests(module, target, parsed):
 
     for name in dir(module):
         definition = getattr(module, name)
-        if type(definition) == type and hasattr(definition, 'test') and \
+        if isinstance(definition, type) and hasattr(definition, 'test') and \
                 (not parsed.test or any(test in name for test in parsed.test)):
             todo.append((name, definition, None))
 
@@ -581,10 +597,11 @@ def run_tests(parsed, target, todo):
         log_fd.write("Test: %s\n" % name)
         log_fd.write("Target: %s\n" % type(target).__name__)
         start = time.time()
+        global real_stdout  # pylint: disable=global-statement
         real_stdout = sys.stdout
         sys.stdout = log_fd
         try:
-            result = instance.run(real_stdout)
+            result = instance.run()
             log_fd.write("Result: %s\n" % result)
         finally:
             sys.stdout = real_stdout
@@ -618,6 +635,9 @@ def add_test_run_options(parser):
             help="Exit as soon as any test fails.")
     parser.add_argument("--print-failures", action="store_true",
             help="When a test fails, print the log file to stdout.")
+    parser.add_argument("--print-log-names", "--pln", action="store_true",
+            help="Print names of temporary log files as soon as they are "
+            "created.")
     parser.add_argument("test", nargs='*',
             help="Run only tests that are named here.")
     parser.add_argument("--gdb",
@@ -670,7 +690,6 @@ class BaseTest(object):
         compile_args = getattr(self, 'compile_args', None)
         if compile_args:
             if compile_args not in BaseTest.compiled:
-                # pylint: disable=star-args
                 BaseTest.compiled[compile_args] = \
                         self.target.compile(self.hart, *compile_args)
         self.binary = BaseTest.compiled.get(compile_args)
@@ -695,7 +714,7 @@ class BaseTest(object):
     def postMortem(self):
         pass
 
-    def run(self, real_stdout):
+    def run(self):
         """
         If compile_args is set, compile a program and set self.binary.
 
@@ -714,8 +733,6 @@ class BaseTest(object):
 
         try:
             self.classSetup()
-            real_stdout.write("[%s] Temporary logs: %s\n" % (
-                type(self).__name__, ", ".join(self.logs)))
             self.setup()
             result = self.test()    # pylint: disable=no-member
         except TestNotApplicable:
@@ -758,16 +775,18 @@ class GdbTest(BaseTest):
         BaseTest.classSetup(self)
 
         if gdb_cmd:
-            self.gdb = Gdb(self.server.gdb_ports, gdb_cmd, binary=self.binary)
+            self.gdb = Gdb(self.server.gdb_ports, gdb_cmd,
+                    timeout=self.target.timeout_sec, binary=self.binary)
         else:
-            self.gdb = Gdb(self.server.gdb_ports, binary=self.binary)
+            self.gdb = Gdb(self.server.gdb_ports,
+                    timeout=self.target.timeout_sec, binary=self.binary)
 
         self.logs += self.gdb.lognames()
+        self.gdb.connect()
 
-        if self.target:
-            self.gdb.global_command("set arch riscv:rv%d" % self.hart.xlen)
-            self.gdb.global_command("set remotetimeout %d" %
-                    self.target.timeout_sec)
+        self.gdb.global_command("set arch riscv:rv%d" % self.hart.xlen)
+        self.gdb.global_command("set remotetimeout %d" %
+            self.target.timeout_sec)
 
         for cmd in self.target.gdb_setup:
             self.gdb.command(cmd)
@@ -806,16 +825,23 @@ class ExamineTarget(GdbTest):
             hart.misa = self.gdb.p("$misa")
 
             txt = "RV"
-            if (hart.misa >> 30) == 1:
-                txt += "32"
-            elif (hart.misa >> 62) == 2:
-                txt += "64"
-            elif (hart.misa >> 126) == 3:
-                txt += "128"
+            misa_xlen = 0
+            if ((hart.misa & 0xFFFFFFFF) >> 30) == 1:
+                misa_xlen = 32
+            elif ((hart.misa & 0xFFFFFFFFFFFFFFFF) >> 62) == 2:
+                misa_xlen = 64
+            elif ((hart.misa & 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF) >> 126) == 3:
+                misa_xlen = 128
             else:
                 raise TestFailed("Couldn't determine XLEN from $misa (0x%x)" %
                         self.hart.misa)
 
+            if misa_xlen != hart.xlen:
+                raise TestFailed("MISA reported XLEN of %d but we were "\
+                        "expecting XLEN of %d\n" % (misa_xlen, hart.xlen))
+
+            txt += ("%d" % misa_xlen)
+
             for i in range(26):
                 if hart.misa & (1<<i):
                     txt += chr(i + ord('A'))