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>

ext/testlib/config.py

@@ -251,6 +251,11 @@ def define_constants(constants):
     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 @@ def define_constants(constants):
             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 @@ def define_post_processors(config):
         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 @@ def define_post_processors(config):
     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,
@@ -486,6 +524,11 @@ def define_common_args(config):
             action='append',
             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',
@@ -601,6 +644,7 @@ class RunParser(ArgParser):
         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 @@ class ListParser(ArgParser):
         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 @@ class RerunParser(ArgParser):
         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)

ext/testlib/main.py

@@ -114,6 +114,7 @@ def filter_with_config_tags(loaded_library):
     special_tags = (
         cfg.constants.isa_tag_type,
         cfg.constants.length_tag_type,
+        cfg.constants.host_isa_tag_type,
         cfg.constants.variant_tag_type
     )