Merge pull request #3 from ArmDeveloperEcosystem/temp-QDEIG4MDQT

Correct detection of some features

Author: james-whitaker-arm

.gitignore

@@ -0,0 +1,3 @@
+/venv
+__pycache__
+*.bak

README.md

@@ -1,12 +1,12 @@
 # System Capabilities Reporter
 
-Sysreport is a system capability reporting tool that gives application developers a quick summary of what performance features are available on the Linux system the tool is running on.
+Sysreport is a system capability reporting tool that gives application developers a quick summary of how the system is configured and what performance features are available, on the Linux system the tool is running on.
 
 This tool is aimed at anyone trying to profile performance on Arm-based systems; this includes cloud instances, bare metal servers, and small devices such as developer boards and Raspberry Pi devices.
 
 The tool is invoked on the command-line and takes about a second to run. It displays a single page of output in text format.
 
-Sysreport is not a benchmarking tool and does not modify the system in any way.
+Sysreport is not a benchmarking tool and does not modify the system in any way. It is also not intended to report current system status, only system configuration.
 
 This tool aims to:
 * Report system configuration in a way that is focused on performance analysis, list which performance tools and features are available
@@ -66,4 +66,4 @@ Please consider raising an issue in GitHub if this tool does not work as expecte
 
 ## Acknowledgements
 
-This project was created on behalf of the [Arm Software Developers](https://www.arm.com/developer-hub/) team, follow them on Twitter: [@ArmSoftwareDev](https://twitter.com/armsoftwaredev) and YouTube: [Arm Software Developers](https://www.youtube.com/channel/UCHUAckhCfRom2EHDGxwhfOg) for more resources!
+This project was created on behalf of the [Arm Software Developers](https://www.arm.com/developer-hub/) team, follow them on Twitter: [@ArmSoftwareDev](https://twitter.com/armsoftwaredev) and YouTube: [Arm Software Developers](https://www.youtube.com/channel/UCHUAckhCfRom2EHDGxwhfOg) for more resources!

src/cpulist.py

@@ -60,7 +60,7 @@
 
 from __future__ import print_function
 
-import platform, sys, os, itertools
+import platform, sys, os, itertools, re
 
 o_verbose = 0
 
@@ -452,7 +452,8 @@ def read_sys_cpus():
     0x50: ("APM",       {}),
     0x51: ("Qualcomm",  {}),
     0x56: ("Marvell",   {}),
-    0x69: ("Intel",     {})
+    0x69: ("Intel",     {}),
+    0x6d: ("Microsoft", {0xd49: "Cobalt 100"}),
 }
 
 
@@ -487,7 +488,7 @@ def cpu_mask(self):
         return 1 << self.cpuno
 
     def sysfs(self):
-        s = "/sys/devices/system/cpu/cpu" + int(self.cpuno)
+        s = "/sys/devices/system/cpu/cpu" + str(self.cpuno)
         assert os.path.isdir(s)
         return s
 
@@ -613,7 +614,7 @@ def discover(self):
         self.max_cpuno = 0
         self.n_cpus_online = 0
         self.cpus_by_core = {}        # map 'core_id' -> CPU
-        self.cpus_by_node = {}        # map NUMA node number -> CPU
+        self.numa_nodes = {}          # each NUMA node is a tuple of: (size, cpu list)
         self.cpus_by_package = {}
         self.groups_by_cpumask = {}
         allcpu_mask = 0
@@ -711,9 +712,10 @@ def discover(self):
             if not os.path.exists(node):
                 # Maybe built with CONFIG_NUMA=n
                 break
-            node_cpus = intmask_list(cpusetstr_mask(file_word(node + "/cpulist")))
-            self.cpus_by_node[n] = node_cpus
-            for i in node_cpus:
+            size = int(re.search(r"MemTotal:\s*([0-9]*)", file_word(node + "/meminfo")).group(1))
+            cpu_list = intmask_list(cpusetstr_mask(file_word(node + "/cpulist")))
+            self.numa_nodes[n] = (size, cpu_list)
+            for i in cpu_list:
                 c = self.cpus_by_number[i]
                 c.numa_node = n
         self.top = self.group(allcpu_mask)
@@ -826,7 +828,7 @@ def n_nodes(self):
         Number of NUMA nodes. Sometimes corresponds to packages, but not always.
         If the kernel has been built with CONFIG_NUMA=n, this will return 0.
         """
-        return len(self.cpus_by_node)
+        return len(self.numa_nodes)
 
     def n_packages(self):
         """

src/hugepages.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python
+
+"""
+Show huge pages
+"""
+
+from __future__ import print_function
+
+import os
+
+hpdir = "/sys/kernel/mm/hugepages"
+
+def file_int(fn):
+    return int(open(fn).read().strip())
+
+for d in os.listdir(hpdir):
+    dp = os.path.join(hpdir, d)
+    print("  %20s  %5u  " % (d, file_int(dp + "/nr_hugepages")))

src/strcolor.py

@@ -34,6 +34,7 @@
 from __future__ import print_function
 
 import os, sys, platform, subprocess, multiprocessing, json, datetime, struct
+
 # import gzip for reading /proc/config.gz
 try:
     import gzip
@@ -131,6 +132,9 @@ def run_cmd(cmd):
     args = cmd.split()
     p = subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
     (out, err) = p.communicate()
+    if o_verbose:
+        print("#o# %s" % (out), file=sys.stderr)
+        print("#e# %s" % (err), file=sys.stderr)
     return (out, err)
 
 
@@ -242,6 +246,7 @@ def acpi_irqs():
     (0x41, 0xd40): (8, 4),   # Neoverse V1
     (0x41, 0xd49): (9, 0),   # Neoverse N2
     (0x41, 0xd4f): (9, 0),   # Neoverse V2
+    (0x6d, 0xd49): (9, 0),   # Azure Cobalt 100
 }
 
 def arm_arch(s):
@@ -313,6 +318,9 @@ def get_distribution(self):
             s = "<unknown>"
         return s
 
+    def is_ACPI(self):
+        return boot_info_type() == "ACPI"
+
     def get_kernel_version(self):
         """
         Get kernel version, as a string, e.g. "6.5.1-rc7" returns "6.5.1"
@@ -515,15 +523,45 @@ def pyperf_installed():
 g_perf_installed = None
 
 
+def is_exec_shell_script(file):
+    """
+    Returns a boolean indicating whether the specified file is an executable
+    shell script or not.
+    """
+    is_script = False
+    if not os.path.exists(file):
+        return False
+    with open(file, "rb") as f:
+        bytes = f.read(2)
+        if bytes == b"#!" and os.access(file, os.X_OK):
+            is_script = True
+    return is_script
+
+
 def perf_binary():
     """
     Get the canonical location of the perf binary. This might not exist.
+
+    /usr/bin/perf is usually a redirector script, but it's possible that perf
+    was built by hand and copied to this location.
+
+    # If $PATH contains a redirector script, return the actual install path.
+    # Otherwise assume it's a user-installed binary and honour that path.
     """
-    return "/usr/lib/linux-tools/" + platform.release() + "/perf"
+    cmd = "which perf"
+    (out, err) = run_cmd(cmd)
+    path = out.decode().strip()
+    if is_exec_shell_script(path):
+        return "/usr/lib/linux-tools/" + platform.release() + "/perf"
+    else:
+        return path
 
 
 def perf_binary_imports(lib):
-    p = subprocess.Popen(["ldd", perf_binary()], stdout=subprocess.PIPE)
+    perf_bin = perf_binary()
+    if not os.path.exists(perf_bin):
+        return False
+    p = subprocess.Popen(["ldd", perf_bin], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
     (out, err) = p.communicate()
     return lib in out.decode()
 
@@ -539,7 +577,9 @@ def perf_installed():
     global g_perf_installed
     if g_perf_installed is not None:
         return g_perf_installed
-    rc = os.system("perf stat -- true >/dev/null 2>/dev/null")
+    # Run a very simple "perf" subcommand - don't use "perf stat" as this may fail
+    # for unprivileged due to security settings, even if events are available.
+    rc = os.system("perf config >/dev/null 2>/dev/null")
     g_perf_installed = (rc == 0)
     return rc == 0
 
@@ -702,6 +742,9 @@ def kernel_hugepages(s, skip_zero=False):
     """
     # return file_int("/proc/sys/vm/nr_hugepages")
     hpdir = "/sys/kernel/mm/hugepages"
+    if not os.path.exists(hpdir):
+        return
+
     for d in os.listdir(hpdir):
         if not d.startswith("hugepages-"):
             continue
@@ -712,7 +755,10 @@ def kernel_hugepages(s, skip_zero=False):
 
 
 def kernel_hugepages_str(s, skip_zero=False):
-    return ", ".join(["%s: %u" % (sz, nr) for (sz, nr) in kernel_hugepages(s, skip_zero=skip_zero)])
+    huge_pages = list(kernel_hugepages(s, skip_zero=skip_zero))
+    if huge_pages:
+        return ", ".join(["%s: %u" % (sz, nr) for (sz, nr) in huge_pages])
+    return "disabled"
 
 
 def kernel_thp(s):
@@ -812,11 +858,12 @@ def advice(s):
         #   Amazon Linux: "yum install perf"
         yield ("perf tools not installed", ["install perf package (see https://learn.arm.com/install-guides/perf)", "or build from kernel sources"])
     else:
+        # ensure perf is built with OpenCSD
         if _is_arm and not perf_binary_has_opencsd():
             yield ("perf tools cannot decode hardware trace", ["build with CORESIGHT=1"])
     if perf_event_paranoid() > 0:
         yield ("System-level events can only be monitored by privileged users", ["sysctl kernel.perf_event_paranoid=0"])
-    if not s.perf_max_counters():
+    if perf_event_paranoid() <= 3 and not s.perf_max_counters():
         corrs = []
         if _is_arm and not s.has_irq("PMU"):
             corrs.append("ensure APIC table describes PMU interrupt")
@@ -836,6 +883,8 @@ def advice(s):
             corrs = []
             if not perf_noninvasive_sampling(s):
                 # CPU has SPE, but apparently not available in perf
+                if s.is_KPTI_enabled():
+                    corrs.append("disable kernel page-table isolation: boot with kpti=off")
                 if not s.has_irq("SPE"):
                     corrs.append("ensure APIC table describes SPE interrupt")
                 ck = s.get_kernel_config("CONFIG_ARM_SPE_PMU")
@@ -854,14 +903,15 @@ def advice(s):
         # advice for v9:
         #  - describe TRBE interrupt in ACPI APIC (or DT equivalent)
         #  - rebuild with CONFIG_CORESIGHT
-        # for both: ensure perf is built with OpenCSD
         if not s.kernel_config_enabled("CONFIG_CORESIGHT"):
             corrs.append("rebuild kernel with CONFIG_CORESIGHT")
         if s.is_arm_architecture(9):
-            if not s.has_irq("TRBE"):
-                corrs.append("ensure APIC table describes TRBE interrupt")
+            if s.is_ACPI():
+                if not s.has_irq("TRBE"):
+                    corrs.append("ensure APIC table describes TRBE interrupt")
         else:
-            corrs.append("ensure ACPI describes CoreSight trace fabric")
+            if s.is_ACPI():
+                corrs.append("ensure ACPI describes CoreSight trace fabric")
         yield ("hardware trace not enabled", corrs)
 
 
@@ -897,16 +947,19 @@ def show(s):
     print("  Atomic operations:   %s" % (colorize(has_atomics(s.system))))
     (itype, n) = s.system_interconnect()
     print("  interconnect:        %s x %u" % (colorize(itype), n))
-    print("  NUMA nodes:          %u" % (s.system.n_nodes()), end="")
+    n_nodes = s.system.n_nodes()
+    print("  NUMA nodes:          %u" % n_nodes)
     if not s.kernel_config_enabled("CONFIG_NUMA"):
         print(" (CONFIG_NUMA=n)", end="")
-    print()
+    if n_nodes > 1:
+        for node in range(n_nodes):
+            print("    node %u:            size: %10skB, cpu_list: %s" % (node, s.system.numa_nodes[node][0], s.system.numa_nodes[node][1]))
     print("  Sockets:             %u" % (s.system.n_packages()))
     # Kernel features
     print("OS configuration:")
     print("  Kernel:              %s" % (s.get_kernel_version()))
     print("  config:              %s" % (colorize(kernel_config_file())))
-    print("  32-bit support:      %s" % (colorize(s.kernel_config_enabled("CONFIG_COMPAT"))))
+    #print("  32-bit support:      %s" % (colorize(s.kernel_config_enabled("CONFIG_COMPAT"))))
     print("  build dir:           %s" % (colorize(kernel_build_dir())))
     print("  uses atomics:        %s" % (colorize(kernel_uses_atomics(s))))
     print("  huge pages:          %s" % (kernel_hugepages_str(s)))
@@ -917,17 +970,16 @@ def show(s):
     print("  Distribution:        %s" % (s.get_distribution()))
     print("  libc version:        %s" % (s.get_libc_version()))
     print("  boot info:           %s" % (colorize(boot_info_type())))
-    print("  KPTI enabled:        %s" % (colorize(s.is_KPTI_enabled(), invert=True)))
+    print("  KPTI enforced:       %s" % (s.is_KPTI_enabled()))
     print("  Lockdown:            %s" % (lockdown_str(s.get_lockdown())))
     print("  Mitigations:         %s" % (vulnerabilities_str(s.vulnerabilities())))
     # Perf features
     print("Performance features:")
-    print("  perf tools:          %s" % (colorize(perf_installed())))
-    print("  perf installed at:   %s" % (perf_binary()), end="")
-    if not os.path.exists(perf_binary()):
-        print(colorize(" (does not exist)", "red"), end="")
-    print()
-    print("  perf with OpenCSD:   %s" % (colorize_greenred(perf_binary_has_opencsd())))
+    perf_inst = perf_installed()
+    print("  perf tools:          %s" % (colorize(perf_inst)))
+    if perf_inst:
+        print("  perf installed at:   %s" % (perf_binary()))
+    print("  perf with OpenCSD:   %s" % (colorize(perf_binary_has_opencsd())))
     print("  perf counters:       %s" % (s.perf_max_counters()))
     print("  perf sampling:       %s" % (colorize_greenred(perf_noninvasive_sampling(s))))
     print("  perf HW trace:       %s" % (colorize_greenred(perf_hardware_trace(s))))