tests: Add --host tag

A host tag has been added to take into consideration the host ISA which
is running gem5 (default is X86).
There might be regressions which are supposed to be run on a particular
host machine only. This could be the case of dynamically linked
regressions which require dynamic linker/loader + shared libraries of
the same ISA as the target.

Change-Id: I4c4044a4f1b8899f443856340df302df7c1aaf8e
Signed-off-by: Giacomo Travaglini <giacomo.travaglini@arm.com>
Reviewed-by: Ciro Santilli <ciro.santilli@arm.com>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/24527
Reviewed-by: Jason Lowe-Power <jason@lowepower.com>
Maintainer: Bobby R. Bruce <bbruce@ucdavis.edu>
Tested-by: kokoro <noreply+kokoro@google.com>
diff --git a/ext/testlib/config.py b/ext/testlib/config.py
index 513463f..643ef68 100644
--- a/ext/testlib/config.py
+++ b/ext/testlib/config.py
@@ -251,6 +251,11 @@
     constants.quick_tag = 'quick'
     constants.long_tag = 'long'
 
+    constants.host_isa_tag_type = 'host'
+    constants.host_x86_64_tag = 'x86_64'
+    constants.host_i386_tag = 'i386'
+    constants.host_arm_tag = 'aarch64'
+
     constants.supported_tags = {
         constants.isa_tag_type : (
             constants.x86_tag,
@@ -271,11 +276,30 @@
             constants.quick_tag,
             constants.long_tag,
         ),
+        constants.host_isa_tag_type: (
+            constants.host_x86_64_tag,
+            constants.host_i386_tag,
+            constants.host_arm_tag,
+        ),
+    }
+
+    # Binding target ISA with host ISA. This is useful for the
+    # case where host ISA and target ISA need to coincide
+    constants.target_host = {
+        constants.arm_tag   : (constants.host_arm_tag,),
+        constants.x86_tag   : (constants.host_x86_64_tag, constants.host_i386_tag),
+        constants.sparc_tag : (constants.host_x86_64_tag, constants.host_i386_tag),
+        constants.alpha_tag : (constants.host_x86_64_tag, constants.host_i386_tag),
+        constants.riscv_tag : (constants.host_x86_64_tag, constants.host_i386_tag),
+        constants.mips_tag  : (constants.host_x86_64_tag, constants.host_i386_tag),
+        constants.power_tag : (constants.host_x86_64_tag, constants.host_i386_tag),
+        constants.null_tag  : (None,)
     }
 
     constants.supported_isas = constants.supported_tags['isa']
     constants.supported_variants = constants.supported_tags['variant']
     constants.supported_lengths = constants.supported_tags['length']
+    constants.supported_hosts = constants.supported_tags['host']
 
     constants.tempdir_fixture_name = 'tempdir'
     constants.gem5_simulation_stderr = 'simerr'
@@ -347,6 +371,19 @@
         else:
             return length
 
+    def default_host(host):
+        if not host[0]:
+            try:
+                import platform
+                host_machine = platform.machine()
+                if host_machine not in constants.supported_hosts:
+                    raise ValueError("Invalid host machine")
+                return [[host_machine]]
+            except:
+                return [[constants.host_x86_64_tag]]
+        else:
+            return host
+
     def compile_tag_regex(positional_tags):
         if not positional_tags:
             return positional_tags
@@ -370,6 +407,7 @@
     config._add_post_processor('isa', default_isa)
     config._add_post_processor('variant', default_variant)
     config._add_post_processor('length', default_length)
+    config._add_post_processor('host', default_host)
     config._add_post_processor('threads', threads_as_int)
     config._add_post_processor('test_threads', test_threads_as_int)
     config._add_post_processor(StorePositionalTagsAction.position_kword,
@@ -487,6 +525,11 @@
             default=[],
             help="Only tests that are one of these lengths. Comma separated."),
         Argument(
+            '--host',
+            action='append',
+            default=[],
+            help="Only tests that are meant to runnable on the selected host"),
+        Argument(
             '--uid',
             action='store',
             default=None,
@@ -601,6 +644,7 @@
         common_args.isa.add_to(parser)
         common_args.variant.add_to(parser)
         common_args.length.add_to(parser)
+        common_args.host.add_to(parser)
         common_args.include_tags.add_to(parser)
         common_args.exclude_tags.add_to(parser)
 
@@ -653,6 +697,7 @@
         common_args.isa.add_to(parser)
         common_args.variant.add_to(parser)
         common_args.length.add_to(parser)
+        common_args.host.add_to(parser)
         common_args.include_tags.add_to(parser)
         common_args.exclude_tags.add_to(parser)
 
@@ -675,6 +720,7 @@
         common_args.isa.add_to(parser)
         common_args.variant.add_to(parser)
         common_args.length.add_to(parser)
+        common_args.host.add_to(parser)
 
 config = _Config()
 define_constants(config.constants)
diff --git a/ext/testlib/main.py b/ext/testlib/main.py
index cbba000..3827f78 100644
--- a/ext/testlib/main.py
+++ b/ext/testlib/main.py
@@ -114,6 +114,7 @@
     special_tags = (
         cfg.constants.isa_tag_type,
         cfg.constants.length_tag_type,
+        cfg.constants.host_isa_tag_type,
         cfg.constants.variant_tag_type
     )
 
diff --git a/tests/gem5/.testignore b/tests/gem5/.testignore
index 99911b8..bca395d 100644
--- a/tests/gem5/.testignore
+++ b/tests/gem5/.testignore
@@ -1,12 +1,36 @@
-test-hello-RISCV-opt
-test-hello-RISCV-debug
-test-hello-RISCV-fast
-test-hello-SPARC-opt
-test-hello-SPARC-debug
-test-hello-SPARC-fast
-test-hello-MIPS-opt
-test-hello-MIPS-debug
-test-hello-MIPS-fast
-test-hello-ALPHA-opt
-test-hello-ALPHA-debug
-test-hello-ALPHA-fast
+test-hello-RISCV-x86_64-opt
+test-hello-RISCV-x86_64-debug
+test-hello-RISCV-x86_64-fast
+test-hello-RISCV-i386-opt
+test-hello-RISCV-i386-debug
+test-hello-RISCV-i386-fast
+test-hello-RISCV-aarch64-opt
+test-hello-RISCV-aarch64-debug
+test-hello-RISCV-aarch64-fast
+test-hello-SPARC-x86_64-opt
+test-hello-SPARC-x86_64-debug
+test-hello-SPARC-x86_64-fast
+test-hello-SPARC-i386-opt
+test-hello-SPARC-i386-debug
+test-hello-SPARC-i386-fast
+test-hello-SPARC-aarch64-opt
+test-hello-SPARC-aarch64-debug
+test-hello-SPARC-aarch64-fast
+test-hello-MIPS-x86_64-opt
+test-hello-MIPS-x86_64-debug
+test-hello-MIPS-x86_64-fast
+test-hello-MIPS-i386-opt
+test-hello-MIPS-i386-debug
+test-hello-MIPS-i386-fast
+test-hello-MIPS-aarch64-opt
+test-hello-MIPS-aarch64-debug
+test-hello-MIPS-aarch64-fast
+test-hello-ALPHA-x86_64-opt
+test-hello-ALPHA-x86_64-debug
+test-hello-ALPHA-x86_64-fast
+test-hello-ALPHA-i386-opt
+test-hello-ALPHA-i386-debug
+test-hello-ALPHA-i386-fast
+test-hello-ALPHA-aarch64-opt
+test-hello-ALPHA-aarch64-debug
+test-hello-ALPHA-aarch64-fast
diff --git a/tests/gem5/suite.py b/tests/gem5/suite.py
index 2c48797..85ffeda 100644
--- a/tests/gem5/suite.py
+++ b/tests/gem5/suite.py
@@ -1,3 +1,15 @@
+# Copyright (c) 2020 ARM Limited
+# All rights reserved
+#
+# The license below extends only to copyright in the software and shall
+# not be construed as granting a license to any other intellectual
+# property including but not limited to intellectual property relating
+# to a hardware implementation of the functionality of the software
+# licensed hereunder.  You may use the software subject to the license
+# terms below provided that you ensure that this notice is replicated
+# unmodified and in its entirety in all distributions of the software,
+# modified or unmodified, in source code or in binary form.
+#
 # Copyright (c) 2017 Mark D. Hill and David A. Wood
 # All rights reserved.
 #
@@ -47,6 +59,7 @@
                        valid_isas=constants.supported_isas,
                        valid_variants=constants.supported_variants,
                        length=constants.supported_lengths[0],
+                       valid_hosts=constants.supported_hosts,
                        protocol=None):
     '''
     Helper class to generate common gem5 tests using verifiers.
@@ -85,58 +98,60 @@
     if os.path.exists(_test_ignore_file_loc):
         ignore.update(open(_test_ignore_file_loc).read().splitlines())
 
-    for opt in valid_variants:
-        for isa in valid_isas:
+    for host in valid_hosts:
+        for opt in valid_variants:
+            for isa in valid_isas:
 
-            # Create a tempdir fixture to be shared throughout the test.
-            tempdir = TempdirFixture()
-            gem5_returncode = VariableFixture(
-                    name=constants.gem5_returncode_fixture_name)
+                # Create a tempdir fixture to be shared throughout the test.
+                tempdir = TempdirFixture()
+                gem5_returncode = VariableFixture(
+                        name=constants.gem5_returncode_fixture_name)
 
-            # Common name of this generated testcase.
-            _name = '{given_name}-{isa}-{opt}'.format(
-                    given_name=name,
-                    isa=isa,
-                    opt=opt)
-            if protocol:
-                _name += '-'+protocol
+                # Common name of this generated testcase.
+                _name = '{given_name}-{isa}-{host}-{opt}'.format(
+                        given_name=name,
+                        isa=isa,
+                        host=host,
+                        opt=opt)
+                if protocol:
+                    _name += '-'+protocol
 
-            # We check to see if this test suite is to be ignored. If so, we
-            # skip it.
-            if _name in ignore:
-                continue
+                # We check to see if this test suite is to be ignored. If so,
+                # we skip it.
+                if _name in ignore:
+                    continue
 
-            # Create the running of gem5 subtest.
-            # NOTE: We specifically create this test before our verifiers so
-            # this is listed first.
-            tests = []
-            gem5_execution = TestFunction(
-                    _create_test_run_gem5(config, config_args, gem5_args),
-                    name=_name)
-            tests.append(gem5_execution)
+                # Create the running of gem5 subtest.  NOTE: We specifically
+                # create this test before our verifiers so this is listed
+                # first.
+                tests = []
+                gem5_execution = TestFunction(
+                        _create_test_run_gem5(config, config_args, gem5_args),
+                        name=_name)
+                tests.append(gem5_execution)
 
-            # Create copies of the verifier subtests for this isa and
-            # variant.
-            for verifier in verifiers:
-                tests.append(verifier.instantiate_test(_name))
+                # Create copies of the verifier subtests for this isa and
+                # variant.
+                for verifier in verifiers:
+                    tests.append(verifier.instantiate_test(_name))
 
-            # Add the isa and variant to tags list.
-            tags = [isa, opt, length]
+                # Add the isa and variant to tags list.
+                tags = [isa, opt, length, host]
 
-            # Create the gem5 target for the specific architecture and
-            # variant.
-            _fixtures = copy.copy(fixtures)
-            _fixtures.append(Gem5Fixture(isa, opt, protocol))
-            _fixtures.append(tempdir)
-            _fixtures.append(gem5_returncode)
+                # Create the gem5 target for the specific architecture and
+                # variant.
+                _fixtures = copy.copy(fixtures)
+                _fixtures.append(Gem5Fixture(isa, opt, protocol))
+                _fixtures.append(tempdir)
+                _fixtures.append(gem5_returncode)
 
-            # Finally construct the self contained TestSuite out of our
-            # tests.
-            testsuites.append(TestSuite(
-                name=_name,
-                fixtures=_fixtures,
-                tags=tags,
-                tests=tests))
+                # Finally construct the self contained TestSuite out of our
+                # tests.
+                testsuites.append(TestSuite(
+                    name=_name,
+                    fixtures=_fixtures,
+                    tags=tags,
+                    tests=tests))
     return testsuites
 
 def _create_test_run_gem5(config, config_args, gem5_args):