tests: move host vs guest cpu features into a single test

pb8o · pb8o · commit f4f7536eae69 · 2024-12-05T16:11:20.000+01:00
This is the same test spread over two files. Putting it together in a
new file so they don't drift over time.

Signed-off-by: Pablo Barbáchano &lt;pablob@amazon.com&gt;
diff --git a/tests/integration_tests/functional/test_cpu_features_aarch64.py b/tests/integration_tests/functional/test_cpu_features_aarch64.py
@@ -2,11 +2,8 @@
 # SPDX-License-Identifier: Apache-2.0
 """Tests for the CPU features for aarch64."""
 
-import os
-
 import pytest
 
-from framework import utils
 from framework.properties import global_props
 from framework.utils_cpuid import CPU_FEATURES_CMD, CpuModel
 
@@ -49,78 +46,3 @@ def test_guest_cpu_features(uvm_any):
 
     guest_feats = set(vm.ssh.check_output(CPU_FEATURES_CMD).stdout.split())
     assert guest_feats == expected_cpu_features
-
-
-def test_host_vs_guest_cpu_features(uvm_nano):
-    """Check CPU features host vs guest"""
-
-    vm = uvm_nano
-    vm.add_net_iface()
-    vm.start()
-    host_feats = set(utils.check_output(CPU_FEATURES_CMD).stdout.split())
-    guest_feats = set(vm.ssh.check_output(CPU_FEATURES_CMD).stdout.split())
-    cpu_model = global_props.cpu_model
-    match cpu_model:
-        case CpuModel.ARM_NEOVERSE_N1:
-            expected_guest_minus_host = set()
-            expected_host_minus_guest = set()
-
-            # Upstream kernel v6.11+ hides "ssbs" from "lscpu" on Neoverse-N1 and Neoverse-V1 since
-            # they have an errata whereby an MSR to the SSBS special-purpose register does not
-            # affect subsequent speculative instructions, permitting speculative store bypassing for
-            # a window of time.
-            # https://github.com/torvalds/linux/commit/adeec61a4723fd3e39da68db4cc4d924e6d7f641
-            #
-            # While Amazon Linux kernels (v5.10 and v6.1) backported the above commit, our test
-            # ubuntu kernel (v6.8) and our guest kernels (v5.10 and v6.1) don't pick it.
-            host_has_ssbs = global_props.host_os not in {
-                "amzn2",
-                "amzn2023",
-            } and global_props.host_linux_version_tpl < (6, 11)
-            guest_has_ssbs = vm.guest_kernel_version < (6, 11)
-
-            if host_has_ssbs and not guest_has_ssbs:
-                expected_host_minus_guest |= {"ssbs"}
-            if not host_has_ssbs and guest_has_ssbs:
-                expected_guest_minus_host |= {"ssbs"}
-
-            assert host_feats - guest_feats == expected_host_minus_guest
-            assert guest_feats - host_feats == expected_guest_minus_host
-        case CpuModel.ARM_NEOVERSE_V1:
-            expected_guest_minus_host = set()
-            # KVM does not enable PAC or SVE features by default
-            # and Firecracker does not enable them either.
-            expected_host_minus_guest = {
-                "paca",
-                "pacg",
-                "sve",
-                "svebf16",
-                "svei8mm",
-            }
-
-            # Upstream kernel v6.11+ hides "ssbs" from "lscpu" on Neoverse-N1 and Neoverse-V1 since
-            # they have an errata whereby an MSR to the SSBS special-purpose register does not
-            # affect subsequent speculative instructions, permitting speculative store bypassing for
-            # a window of time.
-            # https://github.com/torvalds/linux/commit/adeec61a4723fd3e39da68db4cc4d924e6d7f641
-            #
-            # While Amazon Linux kernels (v5.10 and v6.1) backported the above commit, our test
-            # ubuntu kernel (v6.8) and our guest kernels (v5.10 and v6.1) don't pick it.
-            host_has_ssbs = global_props.host_os not in {
-                "amzn2",
-                "amzn2023",
-            } and global_props.host_linux_version_tpl < (6, 11)
-            guest_has_ssbs = vm.guest_kernel_version < (6, 11)
-
-            if host_has_ssbs and not guest_has_ssbs:
-                expected_host_minus_guest |= {"ssbs"}
-            if not host_has_ssbs and guest_has_ssbs:
-                expected_guest_minus_host |= {"ssbs"}
-
-            assert host_feats - guest_feats == expected_host_minus_guest
-            assert guest_feats - host_feats == expected_guest_minus_host
-        case _:
-            if os.environ.get("BUILDKITE") is not None:
-                assert (
-                    False
-                ), f"Cpu model {cpu_model} is not supported, please onboard it."
diff --git a/tests/integration_tests/functional/test_cpu_features_host_vs_guest.py b/tests/integration_tests/functional/test_cpu_features_host_vs_guest.py
@@ -0,0 +1,272 @@
+# Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+# pylint: disable=too-many-statements
+
+"""
+Check CPU features in the host vs the guest.
+
+This test can highlight differences between the host and what the guest sees.
+
+No CPU templates as we are interested only on what is passed through to the guest by default.
+For that, check test_feat_parity.py
+"""
+
+import os
+
+from framework import utils
+from framework.properties import global_props
+from framework.utils_cpuid import CPU_FEATURES_CMD, CpuModel
+
+CPU_MODEL = global_props.cpu_codename
+
+INTEL_HOST_ONLY_FEATS = {
+    "acpi",
+    "aperfmperf",
+    "arch_perfmon",
+    "art",
+    "bts",
+    "cat_l3",
+    "cdp_l3",
+    "cqm",
+    "cqm_llc",
+    "cqm_mbm_local",
+    "cqm_mbm_total",
+    "cqm_occup_llc",
+    "dca",
+    "ds_cpl",
+    "dtes64",
+    "dtherm",
+    "dts",
+    "epb",
+    "ept",
+    "ept_ad",
+    "est",
+    "flexpriority",
+    "flush_l1d",
+    "hwp",
+    "hwp_act_window",
+    "hwp_epp",
+    "hwp_pkg_req",
+    "ida",
+    "intel_ppin",
+    "intel_pt",
+    "mba",
+    "monitor",
+    "pbe",
+    "pdcm",
+    "pebs",
+    "pln",
+    "pts",
+    "rdt_a",
+    "sdbg",
+    "smx",
+    "tm",
+    "tm2",
+    "tpr_shadow",
+    "vmx",
+    "vnmi",
+    "vpid",
+    "xtpr",
+}
+
+
+def test_host_vs_guest_cpu_features(uvm_nano):
+    """Check CPU features host vs guest"""
+
+    vm = uvm_nano
+    vm.add_net_iface()
+    vm.start()
+    host_feats = set(utils.check_output(CPU_FEATURES_CMD).stdout.split())
+    guest_feats = set(vm.ssh.check_output(CPU_FEATURES_CMD).stdout.split())
+
+    match CPU_MODEL:
+        case CpuModel.AMD_MILAN:
+            host_guest_diff_5_10 = {
+                "amd_ppin",
+                "aperfmperf",
+                "bpext",
+                "cat_l3",
+                "cdp_l3",
+                "cpb",
+                "cqm",
+                "cqm_llc",
+                "cqm_mbm_local",
+                "cqm_mbm_total",
+                "cqm_occup_llc",
+                "decodeassists",
+                "extapic",
+                "extd_apicid",
+                "flushbyasid",
+                "hw_pstate",
+                "ibs",
+                "irperf",
+                "lbrv",
+                "mba",
+                "monitor",
+                "mwaitx",
+                "overflow_recov",
+                "pausefilter",
+                "perfctr_llc",
+                "perfctr_nb",
+                "pfthreshold",
+                "rdpru",
+                "rdt_a",
+                "sev",
+                "sev_es",
+                "skinit",
+                "smca",
+                "sme",
+                "succor",
+                "svm_lock",
+                "tce",
+                "tsc_scale",
+                "v_vmsave_vmload",
+                "vgif",
+                "vmcb_clean",
+                "wdt",
+            }
+
+            host_guest_diff_6_1 = host_guest_diff_5_10 - {
+                "lbrv",
+                "pausefilter",
+                "pfthreshold",
+                "sme",
+                "tsc_scale",
+                "v_vmsave_vmload",
+                "vgif",
+                "vmcb_clean",
+            } | {"brs", "rapl", "v_spec_ctrl"}
+
+            if global_props.host_linux_version_tpl < (6, 1):
+                assert host_feats - guest_feats == host_guest_diff_5_10
+            else:
+                assert host_feats - guest_feats == host_guest_diff_6_1
+
+            assert guest_feats - host_feats == {
+                "hypervisor",
+                "tsc_adjust",
+                "tsc_deadline_timer",
+                "tsc_known_freq",
+            }
+
+        case CpuModel.INTEL_SKYLAKE:
+            assert host_feats - guest_feats == INTEL_HOST_ONLY_FEATS
+            assert guest_feats - host_feats == {
+                "hypervisor",
+                "tsc_known_freq",
+                "umip",
+            }
+
+        case CpuModel.INTEL_CASCADELAKE:
+            expected_host_minus_guest = INTEL_HOST_ONLY_FEATS
+            expected_guest_minus_host = {
+                "hypervisor",
+                "tsc_known_freq",
+                "umip",
+            }
+
+            # Linux kernel v6.4+ passes through the CPUID bit for "flush_l1d" to guests.
+            # https://github.com/torvalds/linux/commit/45cf86f26148e549c5ba4a8ab32a390e4bde216e
+            #
+            # Our test ubuntu host kernel is v6.8 and has the commit.
+            if global_props.host_linux_version_tpl >= (6, 4):
+                expected_host_minus_guest -= {"flush_l1d"}
+
+            # Linux kernel v6.6+ drops the "invpcid_single" synthetic feature bit.
+            # https://github.com/torvalds/linux/commit/54e3d9434ef61b97fd3263c141b928dc5635e50d
+            #
+            # Our test ubuntu host kernel is v6.8 and has the commit.
+            host_has_invpcid_single = global_props.host_linux_version_tpl < (6, 6)
+            guest_has_invpcid_single = vm.guest_kernel_version < (6, 6)
+            if host_has_invpcid_single and not guest_has_invpcid_single:
+                expected_host_minus_guest |= {"invpcid_single"}
+            if not host_has_invpcid_single and guest_has_invpcid_single:
+                expected_guest_minus_host |= {"invpcid_single"}
+
+            assert host_feats - guest_feats == expected_host_minus_guest
+            assert guest_feats - host_feats == expected_guest_minus_host
+
+        case CpuModel.INTEL_ICELAKE:
+            host_guest_diff_5_10 = INTEL_HOST_ONLY_FEATS - {"cdp_l3"} | {
+                "pconfig",
+                "tme",
+                "split_lock_detect",
+            }
+            host_guest_diff_6_1 = host_guest_diff_5_10 - {
+                "bts",
+                "dtes64",
+                "dts",
+                "pebs",
+            }
+
+            if global_props.host_linux_version_tpl < (6, 1):
+                assert host_feats - guest_feats == host_guest_diff_5_10
+            else:
+                assert host_feats - guest_feats == host_guest_diff_6_1
+
+            assert guest_feats - host_feats == {
+                "hypervisor",
+                "tsc_known_freq",
+            }
+
+        case CpuModel.ARM_NEOVERSE_N1:
+            expected_guest_minus_host = set()
+            expected_host_minus_guest = set()
+
+            # Upstream kernel v6.11+ hides "ssbs" from "lscpu" on Neoverse-N1 and Neoverse-V1 since
+            # they have an errata whereby an MSR to the SSBS special-purpose register does not
+            # affect subsequent speculative instructions, permitting speculative store bypassing for
+            # a window of time.
+            # https://github.com/torvalds/linux/commit/adeec61a4723fd3e39da68db4cc4d924e6d7f641
+            #
+            # While Amazon Linux kernels (v5.10 and v6.1) backported the above commit, our test
+            # ubuntu kernel (v6.8) and our guest kernels (v5.10 and v6.1) don't pick it.
+            host_has_ssbs = global_props.host_os not in {
+                "amzn2",
+                "amzn2023",
+            } and global_props.host_linux_version_tpl < (6, 11)
+            guest_has_ssbs = vm.guest_kernel_version < (6, 11)
+
+            if host_has_ssbs and not guest_has_ssbs:
+                expected_host_minus_guest |= {"ssbs"}
+            if not host_has_ssbs and guest_has_ssbs:
+                expected_guest_minus_host |= {"ssbs"}
+
+            assert host_feats - guest_feats == expected_host_minus_guest
+            assert guest_feats - host_feats == expected_guest_minus_host
+
+        case CpuModel.ARM_NEOVERSE_V1:
+            expected_guest_minus_host = set()
+            # KVM does not enable PAC or SVE features by default
+            # and Firecracker does not enable them either.
+            expected_host_minus_guest = {"paca", "pacg", "sve", "svebf16", "svei8mm"}
+
+            # Upstream kernel v6.11+ hides "ssbs" from "lscpu" on Neoverse-N1 and Neoverse-V1 since
+            # they have an errata whereby an MSR to the SSBS special-purpose register does not
+            # affect subsequent speculative instructions, permitting speculative store bypassing for
+            # a window of time.
+            # https://github.com/torvalds/linux/commit/adeec61a4723fd3e39da68db4cc4d924e6d7f641
+            #
+            # While Amazon Linux kernels (v5.10 and v6.1) backported the above commit, our test
+            # ubuntu kernel (v6.8) and our guest kernels (v5.10 and v6.1) don't pick it.
+            host_has_ssbs = global_props.host_os not in {
+                "amzn2",
+                "amzn2023",
+            } and global_props.host_linux_version_tpl < (6, 11)
+            guest_has_ssbs = vm.guest_kernel_version < (6, 11)
+
+            if host_has_ssbs and not guest_has_ssbs:
+                expected_host_minus_guest |= {"ssbs"}
+            if not host_has_ssbs and guest_has_ssbs:
+                expected_guest_minus_host |= {"ssbs"}
+
+            assert host_feats - guest_feats == expected_host_minus_guest
+            assert guest_feats - host_feats == expected_guest_minus_host
+
+        case _:
+            # only fail if running in CI
+            if os.environ.get("BUILDKITE") is not None:
+                assert (
+                    guest_feats == host_feats
+                ), f"Cpu model {CPU_MODEL} is not supported"
diff --git a/tests/integration_tests/functional/test_cpu_features_x86_64.py b/tests/integration_tests/functional/test_cpu_features_x86_64.py
