From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id C6BB6CCA471 for ; Fri, 3 Oct 2025 13:39:14 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:List-Subscribe:List-Help :List-Post:List-Archive:List-Unsubscribe:List-Id:Content-Type:Cc:To:From: Subject:Message-ID:Mime-Version:Date:Reply-To:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:In-Reply-To:References:List-Owner; bh=0G6Ha8J9TYSfUKDQ9rZ1sUdGKiFDIA6bJFtQAksW0vk=; b=IXo5GxSzV0YZGBkOUQ44F1wCIU HPbn0SpNjSHdZrKegVUWtnDIDgbFHNWh+NJ6yu8UI/MKryX6LOuqoK1JadULuTUr/TLBNFMDZ+n9s i0QUBXQNoZa9WbPgl837JbKRgn6eFG6EIHbwtZnlRXvOVpgUxyR6Eo1T4k7D0ITSqf+mopY5H+ewI NV4KWGkty+V3FRy74ZAs+tAawMHcFXWWENOFo8BEmjGfPbUIxxfEMWPJY/P+zdjdiMUSRD/TPb15K QA7PsEsgNTeNPMRDzJQGqe1gSM+m7JpGdoUmpsPNHR/OP3pY6fqfp2cvDtqPWiOhKB5rbCg+pOcNy uT4hh0Og==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.98.2 #2 (Red Hat Linux)) id 1v4fzx-0000000CQ41-43Xt; Fri, 03 Oct 2025 13:39:01 +0000 Received: from mail-wr1-x44a.google.com ([2a00:1450:4864:20::44a]) by bombadil.infradead.org with esmtps (Exim 4.98.2 #2 (Red Hat Linux)) id 1v4fzv-0000000CQ1n-0NWd for linux-arm-kernel@lists.infradead.org; Fri, 03 Oct 2025 13:39:00 +0000 Received: by mail-wr1-x44a.google.com with SMTP id ffacd0b85a97d-3ece14b9231so1080693f8f.0 for ; Fri, 03 Oct 2025 06:38:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1759498736; x=1760103536; darn=lists.infradead.org; h=cc:to:from:subject:message-id:mime-version:date:from:to:cc:subject :date:message-id:reply-to; bh=0G6Ha8J9TYSfUKDQ9rZ1sUdGKiFDIA6bJFtQAksW0vk=; b=nVghEx9eRLDJAcjJPccpp3JXUmhquLIXDMWwbdf4otC8dCZiFoBnwXnY+rHUJKX/Id i+cjXkqTj10LafsIQK0F8VpLump54DDlyBt5y2QJTCRUkXGqRw57zV5tzcsLnCHS8Sfq oqpwNCaWJ92B7f0NQ0ZJAmFl4pLpExqboGOoPg4lTQ8/c5HGyBWnbMF0uXxYzjnmtljG ze++NJgVavDiA3Q87XL7j4HkP7aVxA60Hde1cimuwkwMx13oQa/WhAzedcCwmAmSxayV YYP1asgm4Hqs/NUaDk75HXUEaPtEFt31IGKWw3YwsolGxEKXXIGXaWAN0hDMRk/PZEFx +zPg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1759498736; x=1760103536; h=cc:to:from:subject:message-id:mime-version:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=0G6Ha8J9TYSfUKDQ9rZ1sUdGKiFDIA6bJFtQAksW0vk=; b=JJPakWMmnZWbTwUVg8pEbv2rTwakr18MU5Rp/yNH5SeNhMc0GGKNBgfdtBJDuLL3YH J8/wM4wJ/y1wiBbmEDE7BIaCvY5PZ4xE4cO5PFv8UV6HDT9zE1OjyVavxJdiTirDNu8N 8RaYKk4jGfnj9zZbsyjZauMf723bKxUJ5odqOMCO3Hz7jmdRPH8tTh4O9mEVPD9PReBP /huDoxmLCoRFj8WUjl24KEg57HuOSODUS7jGox03lu6/R69fSig2916GZFilXR4bnprN K0gIztcOw5JdpaPr2ID/SH06VUBdzKl/A4YFgc6FLo9LXohlE6I2TLKzkuf8sMueIsgo lkLg== X-Forwarded-Encrypted: i=1; AJvYcCWxrwW9VXtnZg/XmTjxF8GSWBMHKWpinUxdwlnUzVwzwGa1e7KbcKy27HoWTgkhcAATVnI/0DSp+p31FB4VLQLI@lists.infradead.org X-Gm-Message-State: AOJu0YzKGijc66wfUIz28co7mse7oX/SqBQYQtClF0y72V5shWT6j7+P nywxtu5yw5WKPbgHXzS8E52vO3yfoi8nlZwUlZG4Q7WJWE+75m8FjJQNyulI+ZU5sCsg7XsOq7k Ha6Yn07oelo92YFswXUeWww== X-Google-Smtp-Source: AGHT+IFAIVm71GpZTc1R/ZHqdkjF4gjmwFkgLyAabA2OJ8UT/2SUKouZ3IF9pX6HfZSGhtPOD9yNLv4TEggvK/0d X-Received: from wmcq5.prod.google.com ([2002:a05:600c:c105:b0:46e:32e6:eb8f]) (user=vdonnefort job=prod-delivery.src-stubby-dispatcher) by 2002:a05:6000:220b:b0:3eb:a237:a03c with SMTP id ffacd0b85a97d-42567193b3amr2055990f8f.51.1759498736448; Fri, 03 Oct 2025 06:38:56 -0700 (PDT) Date: Fri, 3 Oct 2025 14:37:57 +0100 Mime-Version: 1.0 X-Mailer: git-send-email 2.51.0.618.g983fd99d29-goog Message-ID: <20251003133825.2068970-1-vdonnefort@google.com> Subject: [PATCH v7 00/28] Tracefs support for pKVM From: Vincent Donnefort To: rostedt@goodmis.org, mhiramat@kernel.org, mathieu.desnoyers@efficios.com, linux-trace-kernel@vger.kernel.org, maz@kernel.org, oliver.upton@linux.dev, joey.gouly@arm.com, suzuki.poulose@arm.com, yuzenghui@huawei.com Cc: kvmarm@lists.linux.dev, linux-arm-kernel@lists.infradead.org, jstultz@google.com, qperret@google.com, will@kernel.org, aneesh.kumar@kernel.org, kernel-team@android.com, linux-kernel@vger.kernel.org, Vincent Donnefort Content-Type: text/plain; charset="UTF-8" X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20251003_063859_199831_7348324C X-CRM114-Status: GOOD ( 32.54 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org The growing set of features supported by the hypervisor in protected mode necessitates debugging and profiling tools. Tracefs is the ideal candidate for this task: * It is simple to use and to script. * It is supported by various tools, from the trace-cmd CLI to the Android web-based perfetto. * The ring-buffer, where are stored trace events consists of linked pages, making it an ideal structure for sharing between kernel and hypervisor. This series first introduces a new generic way of creating remote events and remote buffers. Then it adds support to the pKVM hypervisor. 1. ring-buffer -------------- To setup the per-cpu ring-buffers, a new interface is created: ring_buffer_remote: Describes what the kernel needs to know about the remote writer, that is, the set of pages forming the ring-buffer and a callback for the reader/head swapping (enables consuming read) ring_buffer_remote(): Creates a read-only ring-buffer from a ring_buffer_remote. To keep the internals of `struct ring_buffer` in sync with the remote, the meta-page is used. It was originally introduced to enable user-space mapping of the ring-buffer [1]. In this case, the kernel is not the producer anymore but the reader. The function to read that meta-page is: ring_buffer_poll_remote(): Update `struct ring_buffer` based on the remote meta-page. Wake-up readers if necessary. The kernel has to poll the meta-page to be notified of newly written events. 2. Tracefs ---------- This series introduce a new trace_remote that does the link between tracefs and the remote ring-buffer. The interface is found in the remotes/ directory at the root of the tracefs mount point. Each remote is like an instance and you'll find there a subset of the regular Tracefs user-space interface: remotes/test |-- buffer_size_kb |-- events | |-- enable | |-- header_event | |-- header_page | `-- test | `-- selftest | |-- enable | |-- format | `-- id |-- per_cpu | `-- cpu0 | |-- trace | `-- trace_pipe |-- trace |-- trace_pipe |-- tracing_on Behind the scenes, kernel/trace/trace_remote.c creates this tracefs hierarchy without relying on kernel/trace/trace.c. This is due to fundamental differences: * Remote tracing doesn't support trace_array's system-specific features (snapshots, tracers, etc.). * Logged event formats differ (e.g., no PID for remote events). * Buffer operations require specific remote interactions. 3. Simple Ring-Buffer --------------------- As the current ring-buffer.c implementation has too many dependencies to be used directly by the pKVM hypervisor. A new simple implementation is created and can be found in kernel/trace/simple-ring-buffer.c. This implementation is write-only and is used by both the pKVM hypervisor and a trace_remote test module. 4. Events --------- A new REMOTE_EVENT() macro is added to simplify the creation of events on the kernel side. As remote tracing buffer are read only, only the event structure and a way of printing must be declared. The prototype of the macro is very similar to the well-known TRACE_EVENT() REMOTE_EVENT(my_event, id, RE_STRUCT( re_field(u64, foobar) ), RE_PRINTK("foobar=%lld", __entry->foobar) ) ) 5. pKVM ------- The pKVM support simply creates a "hypervisor" trace_remote on the kernel side and inherits from simple-ring-buffer.c on the hypervisor side. A new event macro is created HYP_EVENT() that is under the hood re-using REMOTE_EVENT() (defined in the previous paragaph) as well as generate hypervisor specific struct and trace_() functions. 5. Limitations: --------------- Non-consuming reading of the buffer isn't supported (i.e. cat trace -> -EPERM) due to current the lack of support in the ring-buffer meta-page. [1] https://tracingsummit.org/ts/2022/hypervisortracing/ [2] https://lore.kernel.org/all/20240510140435.3550353-1-vdonnefort@google.com/ Changes since v6 - Add requires field to the selftest (Masami) - Use guard() for ring_buffer_poll_remote (Steven) - Rename ring_buffer_remote() to ring_buffer_alloc_remote() (Steven) - kerneldoc for trace_buffer_remote and simple_ring_buffer (Steven) - Validate trace_buffer_desc size in trace_remote_alloc_buffer (Steven) - Add non-consuming ring-buffer read (Steven) - Add spinning failsafe in simple_ring_buffer (Steven) - Range check for hyp_trace_desc::bpages_backing_* in hyp_trace_desc_validate() - unsigned int cpu in hyp_trace_desc_validate() - Fix event/format file - Add tests with an offline CPU - Add tests for non-consuming read - Add documentation - Rebase on 6.17 Changes since v5 (https://lore.kernel.org/all/20250516134031.661124-1-vdonnefort@google.com/) - Add tishift lib to the hyp (Aneesh) - Rebase on 6.17-rc2 Changes since v4 (https://lore.kernel.org/all/20250506164820.515876-1-vdonnefort@google.com/) - Extend meta-page with pages_touched and pages_lost - Create ring_buffer_types.h - Fix simple_ring_buffer build for 32-bits arch and x86 - Try unload buffer on reset (+ test) - Minor renaming and comments Changes since v3 (https://lore.kernel.org/all/20250224121353.98697-1-vdonnefort@google.com/) - Move tracefs support from kvm/hyp_trace.c into a generic trace_remote.c. - Move ring-buffer implementation from nvhe/trace.c into a generic simple-ring-buffer.c - Rebase on 6.15-rc4. Changes since v2 (https://lore.kernel.org/all/20250108114536.627715-1-vdonnefort@google.com/) - Fix ring-buffer remote reset - Fix fast-forward in rb_page_desc() - Refactor nvhe/trace.c - struct hyp_buffer_page more compact - Add a struct_len to trace_page_desc - Extend reset testing - Rebase on 6.14-rc3 Changes since v1 (https://lore.kernel.org/all/20240911093029.3279154-1-vdonnefort@google.com/) - Add 128-bits mult fallback in the unlikely event of an overflow. (John) - Fix ELF section sort. - __always_inline trace_* event macros. - Fix events//enable permissions. - Rename ring-buffer "writer" to "remote". - Rename CONFIG_PROTECTED_NVHE_TESTING to PKVM_SELFTEST to align with Quentin's upcoming selftest - Rebase on 6.13-rc3. Changes since RFC (https://lore.kernel.org/all/20240805173234.3542917-1-vdonnefort@google.com/) - hypervisor trace clock: - mult/shift computed in hyp_trace.c. (John) - Update clock when it deviates from kernel boot clock. (John) - Add trace_clock file. - Separate patch for better readability. - Add a proper reset interface which does not need to teardown the tracing buffers. (Steven) - Return -EPERM on trace access. (Steven) - Add per-cpu trace file. - Automatically teardown and free the tracing buffer when it is empty, without readers and not currently tracing. - Show in buffer_size_kb if the buffer is loaded in the hypervisor or not. - Extend tests to cover reset and unload. - CC timekeeping folks on relevant patches (Marc) Vincent Donnefort (28): ring-buffer: Add page statistics to the meta-page ring-buffer: Store bpage pointers into subbuf_ids ring-buffer: Introduce ring-buffer remotes ring-buffer: Add non-consuming read for ring-buffer remotes tracing: Introduce trace remotes tracing: Add reset to trace remotes tracing: Add non-consuming read to trace remotes tracing: Add init callback to trace remotes tracing: Add events to trace remotes tracing: Add events/ root files to trace remotes tracing: Add helpers to create trace remote events ring-buffer: Export buffer_data_page and macros tracing: Introduce simple_ring_buffer tracing: Add a trace remote module for testing tracing: selftests: Add trace remote tests Documentation: tracing: Add tracing remotes tracing: load/unload page callbacks for simple_ring_buffer tracing: Check for undefined symbols in simple_ring_buffer KVM: arm64: Support unaligned fixmap in the pKVM hyp KVM: arm64: Add clock support for the pKVM hyp KVM: arm64: Add tracing capability for the pKVM hyp KVM: arm64: Add trace remote for the pKVM hyp KVM: arm64: Sync boot clock with the pKVM hyp KVM: arm64: Add trace reset to the pKVM hyp KVM: arm64: Add event support to the pKVM hyp and trace remote KVM: arm64: Add hyp_enter/hyp_exit events to pKVM hyp KVM: arm64: Add selftest event support to pKVM hyp tracing: selftests: Add pKVM trace remote tests Documentation/trace/index.rst | 11 + Documentation/trace/remotes.rst | 59 + arch/arm64/include/asm/kvm_asm.h | 8 + arch/arm64/include/asm/kvm_define_hypevents.h | 21 + arch/arm64/include/asm/kvm_hyp.h | 1 - arch/arm64/include/asm/kvm_hypevents.h | 41 + arch/arm64/include/asm/kvm_hyptrace.h | 26 + arch/arm64/kernel/image-vars.h | 4 + arch/arm64/kernel/vmlinux.lds.S | 18 + arch/arm64/kvm/Kconfig | 18 + arch/arm64/kvm/Makefile | 2 + arch/arm64/kvm/arm.c | 4 + arch/arm64/kvm/hyp/include/nvhe/arm-smccc.h | 13 + arch/arm64/kvm/hyp/include/nvhe/clock.h | 16 + .../kvm/hyp/include/nvhe/define_events.h | 21 + arch/arm64/kvm/hyp/include/nvhe/trace.h | 60 + arch/arm64/kvm/hyp/nvhe/Makefile | 3 +- arch/arm64/kvm/hyp/nvhe/clock.c | 65 + arch/arm64/kvm/hyp/nvhe/events.c | 36 + arch/arm64/kvm/hyp/nvhe/ffa.c | 2 +- arch/arm64/kvm/hyp/nvhe/hyp-main.c | 86 ++ arch/arm64/kvm/hyp/nvhe/hyp.lds.S | 6 + arch/arm64/kvm/hyp/nvhe/mm.c | 2 +- arch/arm64/kvm/hyp/nvhe/psci-relay.c | 5 +- arch/arm64/kvm/hyp/nvhe/switch.c | 5 +- arch/arm64/kvm/hyp/nvhe/trace.c | 292 ++++ arch/arm64/kvm/hyp_trace.c | 386 +++++ arch/arm64/kvm/hyp_trace.h | 11 + include/linux/ring_buffer.h | 58 + include/linux/ring_buffer_types.h | 41 + include/linux/simple_ring_buffer.h | 120 ++ include/linux/trace_remote.h | 92 ++ include/linux/trace_remote_event.h | 33 + include/trace/define_remote_events.h | 73 + include/uapi/linux/trace_mmap.h | 8 +- kernel/trace/Kconfig | 14 + kernel/trace/Makefile | 20 + kernel/trace/remote_test.c | 259 ++++ kernel/trace/remote_test_events.h | 10 + kernel/trace/ring_buffer.c | 356 ++++- kernel/trace/simple_ring_buffer.c | 461 ++++++ kernel/trace/trace.c | 2 +- kernel/trace/trace.h | 6 + kernel/trace/trace_remote.c | 1315 +++++++++++++++++ .../ftrace/test.d/remotes/buffer_size.tc | 25 + .../selftests/ftrace/test.d/remotes/functions | 88 ++ .../ftrace/test.d/remotes/pkvm/buffer_size.tc | 11 + .../ftrace/test.d/remotes/pkvm/reset.tc | 11 + .../ftrace/test.d/remotes/pkvm/trace.tc | 11 + .../ftrace/test.d/remotes/pkvm/trace_pipe.tc | 11 + .../ftrace/test.d/remotes/pkvm/unloading.tc | 11 + .../selftests/ftrace/test.d/remotes/reset.tc | 90 ++ .../selftests/ftrace/test.d/remotes/trace.tc | 127 ++ .../ftrace/test.d/remotes/trace_pipe.tc | 127 ++ .../ftrace/test.d/remotes/unloading.tc | 41 + 55 files changed, 4581 insertions(+), 62 deletions(-) create mode 100644 Documentation/trace/remotes.rst create mode 100644 arch/arm64/include/asm/kvm_define_hypevents.h create mode 100644 arch/arm64/include/asm/kvm_hypevents.h create mode 100644 arch/arm64/include/asm/kvm_hyptrace.h create mode 100644 arch/arm64/kvm/hyp/include/nvhe/arm-smccc.h create mode 100644 arch/arm64/kvm/hyp/include/nvhe/clock.h create mode 100644 arch/arm64/kvm/hyp/include/nvhe/define_events.h create mode 100644 arch/arm64/kvm/hyp/include/nvhe/trace.h create mode 100644 arch/arm64/kvm/hyp/nvhe/clock.c create mode 100644 arch/arm64/kvm/hyp/nvhe/events.c create mode 100644 arch/arm64/kvm/hyp/nvhe/trace.c create mode 100644 arch/arm64/kvm/hyp_trace.c create mode 100644 arch/arm64/kvm/hyp_trace.h create mode 100644 include/linux/ring_buffer_types.h create mode 100644 include/linux/simple_ring_buffer.h create mode 100644 include/linux/trace_remote.h create mode 100644 include/linux/trace_remote_event.h create mode 100644 include/trace/define_remote_events.h create mode 100644 kernel/trace/remote_test.c create mode 100644 kernel/trace/remote_test_events.h create mode 100644 kernel/trace/simple_ring_buffer.c create mode 100644 kernel/trace/trace_remote.c create mode 100644 tools/testing/selftests/ftrace/test.d/remotes/buffer_size.tc create mode 100644 tools/testing/selftests/ftrace/test.d/remotes/functions create mode 100644 tools/testing/selftests/ftrace/test.d/remotes/pkvm/buffer_size.tc create mode 100644 tools/testing/selftests/ftrace/test.d/remotes/pkvm/reset.tc create mode 100644 tools/testing/selftests/ftrace/test.d/remotes/pkvm/trace.tc create mode 100644 tools/testing/selftests/ftrace/test.d/remotes/pkvm/trace_pipe.tc create mode 100644 tools/testing/selftests/ftrace/test.d/remotes/pkvm/unloading.tc create mode 100644 tools/testing/selftests/ftrace/test.d/remotes/reset.tc create mode 100644 tools/testing/selftests/ftrace/test.d/remotes/trace.tc create mode 100644 tools/testing/selftests/ftrace/test.d/remotes/trace_pipe.tc create mode 100644 tools/testing/selftests/ftrace/test.d/remotes/unloading.tc base-commit: e5f0a698b34ed76002dc5cff3804a61c80233a7a -- 2.51.0.618.g983fd99d29-goog