# Copyright (c) Meta Platforms, Inc. and affiliates. # SPDX-License-Identifier: LGPL-2.1-or-later import dataclasses import inspect import os from pathlib import Path import subprocess from typing import Dict, Mapping, NamedTuple, Optional, Sequence, Union from _drgn_util.platform import NORMALIZED_MACHINE_NAME from util import KernelVersion, out_of_date # Kernel versions that we run tests on and therefore support. Keep this in sync # with docs/support_matrix.rst. SUPPORTED_KERNEL_VERSIONS = ( "7.1", "7.0", "6.19", "6.18", "6.17", "6.16", "6.15", "6.14", "6.13", "6.12", "6.11", "6.10", "6.9", "6.8", "6.7", "6.6", "6.5", "6.4", "6.3", "6.2", "6.1", "6.0", "5.19", "5.18", "5.17", "5.16", "5.15", "5.14", "5.13", "5.12", "5.11", "5.10", "5.4", "4.19", "4.14", "4.9", ) KERNEL_ORG_COMPILER_VERSION = "12.5.0" BASE_KCONFIG = """ CONFIG_EXPERT=y CONFIG_MODULES=y CONFIG_MODULE_UNLOAD=y CONFIG_CC_OPTIMIZE_FOR_SIZE=y # We run the tests in KVM. CONFIG_HYPERVISOR_GUEST=y CONFIG_KVM_GUEST=y CONFIG_PARAVIRT=y CONFIG_PARAVIRT_SPINLOCKS=y # Minimum requirements for vmtest. CONFIG_9P_FS=y CONFIG_DEVTMPFS=y CONFIG_INET=y CONFIG_NET=y CONFIG_NETWORK_FILESYSTEMS=y CONFIG_NET_9P=y CONFIG_NET_9P_VIRTIO=y CONFIG_OVERLAY_FS=y CONFIG_PCI=y CONFIG_PROC_FS=y CONFIG_SYSFS=y CONFIG_TMPFS=y CONFIG_TMPFS_XATTR=y CONFIG_VIRTIO_BLK=y CONFIG_VIRTIO_CONSOLE=y CONFIG_VIRTIO_PCI=y CONFIG_HW_RANDOM=m CONFIG_HW_RANDOM_VIRTIO=m # Lots of things expect Unix sockets. CONFIG_UNIX=y # drgn needs debug info. CONFIG_DEBUG_KERNEL=y CONFIG_DEBUG_INFO=y CONFIG_DEBUG_INFO_DWARF4=y # For testing live kernel debugging with /proc/kcore. CONFIG_PROC_KCORE=y # drgn needs /proc/kallsyms in some cases. Some test cases also need it. CONFIG_KALLSYMS=y CONFIG_KALLSYMS_ALL=y # For testing kernel core dumps with /proc/vmcore. CONFIG_CRASH_DUMP=y CONFIG_PROC_VMCORE=y CONFIG_KEXEC=y CONFIG_KEXEC_FILE=y # Needed for CONFIG_KEXEC_FILE. CONFIG_CRYPTO=y CONFIG_CRYPTO_SHA256=y # So that we can trigger a crash with /proc/sysrq-trigger. CONFIG_MAGIC_SYSRQ=y # For testing kernel core dumps from QEMU's dump-guest-memory command. CONFIG_FW_CFG_SYSFS=y # kmodify breakpoints need kprobes. CONFIG_KPROBES=y # For BPF tests. CONFIG_BPF_SYSCALL=y CONFIG_BPF_JIT=y CONFIG_BPF_JIT_ALWAYS_ON=y CONFIG_CGROUP_BPF=y CONFIG_DEBUG_INFO_BTF=y CONFIG_DEBUG_INFO_BTF_MODULES=y # For cgroup tests. CONFIG_CGROUPS=y # To select CONFIG_SOCK_CGROUP_DATA. (CONFIG_CGROUP_BPF also selects # CONFIG_SOCK_CGROUP_DATA, but that's only present since Linux kernel commit # 3007098494be ("cgroup: add support for eBPF programs") (in v4.10)). CONFIG_CGROUP_NET_CLASSID=y # For ipc tests. CONFIG_SYSVIPC=y # For kconfig tests. CONFIG_IKCONFIG=m CONFIG_IKCONFIG_PROC=y # For filesystem tests. CONFIG_BTRFS_FS=m # Don't waste time benchmarking in raid6_pq just to load the Btrfs module. CONFIG_RAID6_PQ_BENCHMARK=n CONFIG_EXT4_FS=m CONFIG_XFS_FS=m # For mm tests. CONFIG_ANON_VMA_NAME=y CONFIG_HUGETLBFS=y CONFIG_MEMORY_HOTPLUG=y CONFIG_MEMORY_HOTREMOVE=y # For net tests. CONFIG_NAMESPACES=y # For nodemask tests. CONFIG_NUMA=y # For sched tests. CONFIG_CGROUP_SCHED=y CONFIG_FAIR_GROUP_SCHED=y CONFIG_SCHEDSTATS=y # For slab allocator tests. CONFIG_SLAB_FREELIST_HARDENED=y # For Traffic Control tests. CONFIG_NET_SCHED=y CONFIG_NET_SCH_PRIO=m CONFIG_NET_SCH_SFQ=m CONFIG_NET_SCH_TBF=m CONFIG_NET_SCH_INGRESS=m CONFIG_NET_CLS_ACT=y CONFIG_NETDEVICES=y CONFIG_DUMMY=m # To enable CONFIG_XARRAY_MULTI for xarray tests. CONFIG_TRANSPARENT_HUGEPAGE=y CONFIG_READ_ONLY_THP_FOR_FS=y # For tools/fsrefs.py tests. CONFIG_BINFMT_MISC=m CONFIG_BLK_DEV_LOOP=m CONFIG_DNOTIFY=y CONFIG_FANOTIFY=y CONFIG_INOTIFY_USER=y CONFIG_PERF_EVENTS=y CONFIG_SWAP=y # We need to try two names here because of Linux kernel commit 6b0b7551428e # ("perf/core: Rename CONFIG_[UK]PROBE_EVENT to CONFIG_[UK]PROBE_EVENTS") (in # v4.11). CONFIG_UPROBE_EVENT=y CONFIG_UPROBE_EVENTS=y CONFIG_USER_NS=y """ @dataclasses.dataclass(frozen=True, eq=False) class KernelFlavor: name: str description: str config: str KERNEL_FLAVORS = { flavor.name: flavor for flavor in ( KernelFlavor( name="default", description="Default configuration", config=""" CONFIG_SMP=y CONFIG_SLUB=y # For slab tests. CONFIG_SLUB_DEBUG=y CONFIG_RANDOMIZE_BASE=y """, ), KernelFlavor( name="alternative", description="SLAB allocator, module versioning, no KASLR", config=""" CONFIG_SMP=y CONFIG_SLAB=y # Linux kernel commit eb07c4f39c3e ("mm/slab: rename # CONFIG_SLAB to CONFIG_SLAB_DEPRECATED") (in v6.5) renamed the # option for SLAB. CONFIG_SLAB_DEPRECATED=y # Linux kernel commit 16a1d968358a ("mm/slab: remove mm/slab.c # and slab_def.h") (in v6.8) removed SLAB. Test this # non-default SLUB option instead. CONFIG_SLUB_CPU_PARTIAL=n CONFIG_RANDOMIZE_BASE=n # Options that require additional metadata for kmodify. CONFIG_MEM_ALLOC_PROFILING=y CONFIG_MEM_ALLOC_PROFILING_ENABLED_BY_DEFAULT=y CONFIG_MODVERSIONS=y """, ), KernelFlavor( name="tiny", description="no SMP, no PREEMPT, no KASLR, and SLUB_TINY or SLOB allocator", config=""" CONFIG_SMP=n CONFIG_SLOB=y # Linux kernel commit 149b6fa228ed ("mm, slob: rename CONFIG_SLOB to # CONFIG_SLOB_DEPRECATED") (in v6.2) renamed the option for SLOB. CONFIG_SLOB_DEPRECATED=y # Linux kernel commit c9929f0e344a ("mm/slob: remove # CONFIG_SLOB") (in v6.4) removed SLOB. Use SLUB_TINY instead, # which was introduced in Linux kernel commit e240e53ae0ab # ("mm, slub: add CONFIG_SLUB_TINY") (in v6.2). CONFIG_SLUB_TINY=y # Cover the case of disabling this feature on kernel versions # that support it. CONFIG_ANON_VMA_NAME=n # CONFIG_PREEMPT_DYNAMIC is not set CONFIG_PREEMPT_NONE=y # !PREEMPTION && !SMP will also select TINY_RCU. CONFIG_RANDOMIZE_BASE=n """, ), ) } @dataclasses.dataclass(frozen=True, eq=False) class Architecture: # Architecture name. This matches the names used by # _drgn_util.platform.NORMALIZED_MACHINE_NAME and qemu-system-$arch_name. name: str # Value of ARCH variable to build the Linux kernel. kernel_arch: str # Directory under arch/ in the Linux kernel source tree. kernel_srcarch: str # Name of the architecture in Debian. debian_arch: str # GCC target triplet on Debian. debian_gcc_target: str # Linux kernel configuration options. kernel_config: str # Flavor-specific Linux kernel configuration options. kernel_flavor_configs: Mapping[str, str] # Name of compiler host on # https://mirrors.kernel.org/pub/tools/crosstool/. kernel_org_compiler_host_name: Optional[str] # Name of compiler target on # https://mirrors.kernel.org/pub/tools/crosstool/. kernel_org_compiler_target_name: str # Options to pass to QEMU. qemu_options: Sequence[str] # Console device when using QEMU. qemu_console: str # Minimum supported kernel version. min_kernel_version: Optional[KernelVersion] = None def kernel_version_supported(self, version: Union[KernelVersion, str]) -> bool: if self.min_kernel_version is None: return True if not isinstance(version, KernelVersion): version = KernelVersion(version) return version >= self.min_kernel_version ARCHITECTURES = { arch.name: arch for arch in ( Architecture( name="aarch64", kernel_arch="arm64", kernel_srcarch="arm64", debian_arch="arm64", debian_gcc_target="aarch64-linux-gnu", kernel_config=""" CONFIG_PCI_HOST_GENERIC=y CONFIG_RTC_CLASS=y CONFIG_RTC_DRV_PL031=y CONFIG_SERIAL_AMBA_PL011=y CONFIG_SERIAL_AMBA_PL011_CONSOLE=y """, kernel_flavor_configs={ "default": """ CONFIG_ARM64_4K_PAGES=y """, "alternative": """ CONFIG_ARM64_64K_PAGES=y """, "tiny": """ CONFIG_ARM64_16K_PAGES=y """, }, kernel_org_compiler_host_name="arm64", kernel_org_compiler_target_name="aarch64-linux", qemu_options=("-M", "virt", "-cpu", "cortex-a76"), qemu_console="ttyAMA0", # /proc/kcore is broken on older versions. min_kernel_version=KernelVersion("4.19"), ), Architecture( name="arm", kernel_arch="arm", kernel_srcarch="arm", debian_arch="armhf", debian_gcc_target="arm-linux-gnueabihf", kernel_config=""" CONFIG_NR_CPUS=8 # Debian armhf userspace assumes EABI and VFP. CONFIG_AEABI=y CONFIG_VFP=y CONFIG_ARCH_VIRT=y CONFIG_PCI_HOST_GENERIC=y CONFIG_RTC_CLASS=y CONFIG_RTC_DRV_PL031=y CONFIG_SERIAL_AMBA_PL011=y CONFIG_SERIAL_AMBA_PL011_CONSOLE=y # Before Linux kernel commit f05eb1d24eb5 ("ARM: # stackprotector: prefer compiler for TLS based per-task # protector") (in v5.18), this enables the # arm_ssp_per_task_plugin GCC plugin, which fails to build with # the kernel.org cross compiler. CONFIG_STACKPROTECTOR_PER_TASK=n """, kernel_flavor_configs={ "default": """ CONFIG_VMSPLIT_2G=y CONFIG_HIGHMEM=n CONFIG_ARM_LPAE=n """, "alternative": """ CONFIG_VMSPLIT_2G=y CONFIG_HIGHMEM=n CONFIG_ARM_LPAE=y """, "tiny": """ CONFIG_VMSPLIT_3G=y CONFIG_HIGHMEM=y CONFIG_ARM_LPAE=n """, }, kernel_org_compiler_host_name=None, kernel_org_compiler_target_name="arm-linux-gnueabi", qemu_options=("-M", "virt,highmem=off"), qemu_console="ttyAMA0", # /proc/kcore is broken on older versions. min_kernel_version=KernelVersion("4.19"), ), Architecture( name="ppc64", kernel_arch="powerpc", kernel_srcarch="powerpc", debian_arch="ppc64el", debian_gcc_target="powerpc64le-linux-gnu", kernel_config=""" CONFIG_PPC64=y CONFIG_CPU_LITTLE_ENDIAN=y # Debian ppc64el userspace assumes AltiVec and VSX support. CONFIG_ALTIVEC=y CONFIG_VSX=y CONFIG_RTC_CLASS=y CONFIG_RTC_DRV_GENERIC=y CONFIG_HVC_CONSOLE=y # This has a missing dependency in v6.5-rc1 that causes a build # failure, and we don't need it. CONFIG_CRYPTO_AES_GCM_P10=n """, kernel_flavor_configs={}, kernel_org_compiler_host_name="ppc64le", kernel_org_compiler_target_name="powerpc64-linux", qemu_options=(), qemu_console="hvc0", # Need an implementation of # linux_kernel_live_direct_mapping_fallback in libdrgn. min_kernel_version=KernelVersion("4.11"), ), Architecture( name="riscv64", kernel_arch="riscv", kernel_srcarch="riscv", debian_arch="riscv64", debian_gcc_target="riscv64-linux-gnu", kernel_config=""" CONFIG_ARCH_RV64I=y CONFIG_KERNEL_UNCOMPRESSED=y CONFIG_PCI_HOST_GENERIC=y CONFIG_SERIAL_8250=y CONFIG_SERIAL_8250_CONSOLE=y CONFIG_SERIAL_OF_PLATFORM=y # For some reason, tests run significantly slower on a # relocatable kernel. Additionally, as of Linux 6.19, the KASLR # offset is not in VMCOREINFO: # https://lore.kernel.org/linux-riscv/aXiF55y5D49gcpUg@adminpc-PowerEdge-R7525/. # So, disable KASLR for now. CONFIG_RANDOMIZE_BASE=n """, kernel_flavor_configs={}, kernel_org_compiler_host_name=None, kernel_org_compiler_target_name="riscv64-linux", qemu_options=("-M", "virt"), qemu_console="ttyS0", # RISC-V support was added in Linux 4.15. Linux 6.11 and older need # patches to handle more relocation types in kexec_file_load(), and # even after patching, 6.7-6.11 hang on kexec. Linux 6.6 and older # need a backport of Linux kernel commit e0c0a7c35f67 ("riscv: # select ARCH_PROC_KCORE_TEXT"). Linux 6.2 is the oldest version # that I can get to boot in QEMU so far. Linux 5.15 is the oldest # version that will build without additional patches. min_kernel_version=KernelVersion("6.12"), ), Architecture( name="s390x", kernel_arch="s390", kernel_srcarch="s390", debian_arch="s390x", debian_gcc_target="s390x-linux-gnu", kernel_config=""" # Needed for CONFIG_KEXEC_FILE. CONFIG_CRYPTO_SHA256_S390=y # Before Linux kernel commit e950d1f84d3c ("s390/percpu: Get # rid of ARCH_MODULE_NEEDS_WEAK_PER_CPU") (in v6.19), memory # allocation profiling triggers a bunch of # WARN_ON(tag->counters) warnings on s390x. It's not worth # dealing with. CONFIG_MEM_ALLOC_PROFILING=n """, kernel_flavor_configs={}, kernel_org_compiler_host_name=None, kernel_org_compiler_target_name="s390-linux", qemu_options=(), qemu_console="ttysclp0", # Need an implementation of # linux_kernel_live_direct_mapping_fallback in libdrgn. min_kernel_version=KernelVersion("4.11"), ), Architecture( name="x86_64", kernel_arch="x86_64", kernel_srcarch="x86", debian_arch="amd64", debian_gcc_target="x86_64-linux-gnu", kernel_config=""" CONFIG_RTC_CLASS=y CONFIG_RTC_DRV_CMOS=y CONFIG_SERIAL_8250=y CONFIG_SERIAL_8250_CONSOLE=y """, kernel_flavor_configs={ "alternative": """ CONFIG_UNWINDER_FRAME_POINTER=y # Before Linux kernel commit 11af847446ed ("x86/unwind: # Rename unwinder config options to 'CONFIG_UNWINDER_*'") # (in v4.15). CONFIG_FRAME_POINTER_UNWINDER=y """, }, kernel_org_compiler_host_name="x86_64", kernel_org_compiler_target_name="x86_64-linux", qemu_options=("-nodefaults",), qemu_console="ttyS0", ), ) } HOST_ARCHITECTURE = ARCHITECTURES.get(NORMALIZED_MACHINE_NAME) class Kernel(NamedTuple): arch: Architecture release: str path: Path def local_kernel(arch: Architecture, path: Path) -> Kernel: return Kernel( arch=arch, release=(path / "build/include/config/kernel.release").read_text().strip(), path=path, ) class Compiler(NamedTuple): target: Architecture bin: Path prefix: str def env(self) -> Dict[str, str]: path = str(self.bin.resolve()) try: path += ":" + os.environ["PATH"] except KeyError: pass return { "PATH": path, "CROSS_COMPILE": self.prefix, } def compiler_name(host_name: str, target_name: str) -> str: return f"{host_name}-gcc-{KERNEL_ORG_COMPILER_VERSION}-nolibc-{target_name}" def compiler_url(host_name: str, target_name: str) -> str: return f"https://github.com/osandov/drgn/releases/download/vmtest-compilers/{compiler_name(host_name, target_name)}.tar.xz" def kconfig_localversion(arch: Architecture, flavor: KernelFlavor, version: str) -> str: vmtest_kernel_version = [ # Increment the major version to rebuild every # architecture/flavor/version combination. 40, # The minor version makes the default flavor the "latest" version. 1 if flavor.name == "default" else 0, ] patch_level = 0 # If only specific architecture/flavor/version combinations need to be # rebuilt, conditionally increment the patch level here. if flavor.name == "alternative" and KernelVersion(version) >= KernelVersion("6.10"): patch_level += 1 if arch.name == "s390x": patch_level += 1 if patch_level: vmtest_kernel_version.append(patch_level) return "-vmtest" + ".".join(str(n) for n in vmtest_kernel_version) + flavor.name def kconfig(arch: Architecture, flavor: KernelFlavor) -> str: return f"""\ # Minimal Linux kernel configuration for booting into vmtest and running drgn # tests ({arch.name} {flavor.name} flavor). CONFIG_LOCALVERSION="" CONFIG_LOCALVERSION_AUTO=n # base options {inspect.cleandoc(BASE_KCONFIG)} # {flavor.name} flavor options {inspect.cleandoc(flavor.config)} # {arch.name} options {inspect.cleandoc(arch.kernel_config)} # {arch.name} {flavor.name} flavor options {inspect.cleandoc(arch.kernel_flavor_configs.get(flavor.name, ""))} """ def _run_autoreconf() -> None: if out_of_date( "libdrgn/Makefile.in", "libdrgn/Makefile.am", "libdrgn/configure.ac" ) or out_of_date("libdrgn/configure", "libdrgn/configure.ac"): try: subprocess.check_call(["autoreconf", "-i", "libdrgn"]) except BaseException: try: os.remove("libdrgn/configure") except FileNotFoundError: pass try: os.remove("libdrgn/Makefile.in") except FileNotFoundError: pass raise