From patchwork Fri Aug 2 09:31:28 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alice Ryhl X-Patchwork-Id: 13751346 Received: from mail-wr1-f74.google.com (mail-wr1-f74.google.com [209.85.221.74]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 626EE1DB452 for ; Fri, 2 Aug 2024 09:32:00 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.74 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1722591122; cv=none; b=f+O6BOuySAsT+rtjyk7QgE/lPcJLM+EUu4lM0VUiie/Zl3N9AhisqAc/D+vwGbo7PcUU8hL80rX9+hnPm3J7uk3CljnlgQJBVb2Mqcw1iQbLieCIS1VLH1iKXZSemelBnoNv5p9/boFBmUZc5hZLYO/fCPR6w7aftEmGxwk7frg= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1722591122; c=relaxed/simple; bh=w0kjkNp9tXlUo73XWRVbps/1uhcBH0l+7rWOWIsb964=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=RhD/gyURJsQUIWORuZEzGisl7yxYVlHxkOUd4fydIRG6WjcRGGnm6DZySRqlnuL3cOyRC8RN9i/x8lJablFt1iTRi+VfwF2OEUCxSb/i5I9jMvRGEZDr1tBVbaLurNQedc2FjEsgXgkNJ1Qd/tv53RTCZ6oAMe9tVpMEqH/7PAg= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=flex--aliceryhl.bounces.google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=XMD0gA69; arc=none smtp.client-ip=209.85.221.74 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=flex--aliceryhl.bounces.google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="XMD0gA69" Received: by mail-wr1-f74.google.com with SMTP id ffacd0b85a97d-36848f30d39so3755331f8f.3 for ; Fri, 02 Aug 2024 02:32:00 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1722591119; x=1723195919; darn=vger.kernel.org; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:from:to:cc:subject:date:message-id:reply-to; bh=pFX002WF5KycYvj+q55NDLygad2v8oW7DNGZypmpcz0=; b=XMD0gA690QjQ0URgReqh05CF6/+h2vlWChtio7oskbbRvW09Yiw3H/A8Pu4G4GczPH I51o9NW2GotqIT6eTTZz26GGOUMg4ZHigisGy/Q5hgBpl9tQ5tOVf6jrAFUI16SNssCB p+t+a8D+WfsAEU/PBuZlXqHsFqcTblTLAXJOaHRXhOS8eGygWgBuEjQhTu6PVZlSs6QD 5mxutVd2zD2kp+LrEZOv9IQo2lwARkmtsmZC5GZSnSZO6kt82GSYHGSM5Y6HkuSjU8P/ /iCbs4cOQQgzDyjMges6hlDKYyLmOUfbhsWzSqZkN8vPJeRzmuLaTouThRtYcRI2XYr7 6wng== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1722591119; x=1723195919; h=cc:to:from:subject:message-id:references:mime-version:in-reply-to :date:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=pFX002WF5KycYvj+q55NDLygad2v8oW7DNGZypmpcz0=; b=vcop/RFwYRnYN6slC4FT3ocQup+KdmhAL9wSlK6mrN6Tm7ExqN5MlqdN/pWQO4XFut CdRoKv4i8INa7BHm0koqzRsCiyzKcsvH3fyXE+VTnSWdQCgT4w9N2hiJB9UVkmLSDVq6 Hg4klnnkyYwIx6wlliBZN66qSX/B3n233t3o5uTrZ5JkHFYkTWPoerTcxWFbj/gqq6nr 15tkMQ/PDZyNz+8rgkwTRjbpBV0gBU1tpGXgpQwkqmzoUGn2/L92ZTPQDrO6GR5TTl6y JgwLVADyHlaPVkkn58I/f+F1hqGnQEKrLGc6xJrEV/ib6l78wdIIGWsAOZGVUvGEnHig XASA== X-Gm-Message-State: AOJu0Yy1v3siFINnulimofw28X9Dl9M27RYFBmiInQw1nouw8BdA1X7r I1gZDN1B2zVvm5WFAonIhxeKe1tnUB4N1kJAry5Yn/ojkbN7R1O9xunBP6sOAPOsmRT6oYghf+j 7KT7JcI0YWD/fDQ== X-Google-Smtp-Source: AGHT+IF6TeSE4s9eo+99KIz96YHlhNQA6ZSJ6aPAHp3y6TccqHauRJLpWLajZIVv2ZcexsnAul3c4G3kS9jn4ac= X-Received: from aliceryhl.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:35bd]) (user=aliceryhl job=sendgmr) by 2002:a5d:4a49:0:b0:367:8f81:2086 with SMTP id ffacd0b85a97d-36bbc0c268dmr3057f8f.3.1722591118384; Fri, 02 Aug 2024 02:31:58 -0700 (PDT) Date: Fri, 02 Aug 2024 09:31:28 +0000 In-Reply-To: <20240802-tracepoint-v5-0-faa164494dcb@google.com> Precedence: bulk X-Mailing-List: linux-trace-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20240802-tracepoint-v5-0-faa164494dcb@google.com> X-Developer-Key: i=aliceryhl@google.com; a=openpgp; fpr=49F6C1FAA74960F43A5B86A1EE7A392FDE96209F X-Developer-Signature: v=1; a=openpgp-sha256; l=6821; i=aliceryhl@google.com; h=from:subject:message-id; bh=w0kjkNp9tXlUo73XWRVbps/1uhcBH0l+7rWOWIsb964=; b=owEBbQKS/ZANAwAKAQRYvu5YxjlGAcsmYgBmrKeGhEkip34Q57vcFdE7eAZCn8m33EEqxM86s 0iQvqOQFKGJAjMEAAEKAB0WIQSDkqKUTWQHCvFIvbIEWL7uWMY5RgUCZqynhgAKCRAEWL7uWMY5 RnLNEACz4FN/ONZ7Vt9T1opNcvYM0M1wnNDNzPcCJVfPGUgOOXaPaqXXozfu2ApS6kqEaBAAIw2 jmFl+Luvdm/Dc+ITPOn9yqJdJ2lNZU9voXBpEssxVH+3TOlfNRn+9/MA8s4qzx1kEpzpX9TPZfR LsxFJQrNmp7EFcr/AS+esS8K89ZItQezsxbMNeVeIivkqs5juoxhLg06cvOTp488pwN9KIcIwNr M7KTeOVqZETJOZrScjCWw8WQ9udaxlHY5w8XcCF6+Kgw5gXMMCulYgxyVigHok6zIK8WpeRONdN Lj2yBJB7eiPyQ27XrASFlSz3SjqzeK55VfDJlAAu36xQHhXy94+KlZkkthdV7dxAJy6fFF0bkL2 O6KYmORTKz8V7vehTZ0c36Iq0euccI1UtxBmR2rCMMoqV/oI/wTNwTwXRDTjMAXKE4up5znQFlb 6Ysqrc9uXVAiKGPZDaPwXYPX6exhQo1Q/JRMFRUoejHXYPyQ9XhDlfp8568aFNP+cd+Jt+Mbpsz 0uKE3uQyWMyrpU3lwlDL3hbFxNbh8RpVDNfW6L9T8PqbHE7j1eBq5k2VG7lGyQwq4y6Mev1FRuv XTFGZ+Ejy0DS7DWzMIsPa8Wvmv7PvdN0BRrBpmu4LePqlgzIN2wktBWcKnfhmuRkzjpiXbRKagC vcc8t+dAXUfcPRQ== X-Mailer: b4 0.13.0 Message-ID: <20240802-tracepoint-v5-2-faa164494dcb@google.com> Subject: [PATCH v5 2/2] rust: add tracepoint support From: Alice Ryhl To: Steven Rostedt , Masami Hiramatsu , Mathieu Desnoyers , Peter Zijlstra , Josh Poimboeuf , Jason Baron , Ard Biesheuvel , Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , " =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= " , Benno Lossin , Andreas Hindborg Cc: linux-trace-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Arnd Bergmann , linux-arch@vger.kernel.org, Thomas Gleixner , Ingo Molnar , Borislav Petkov , Dave Hansen , x86@kernel.org, "H. Peter Anvin" , Sean Christopherson , Uros Bizjak , Catalin Marinas , Will Deacon , Marc Zyngier , Oliver Upton , Mark Rutland , Ryan Roberts , Fuad Tabba , linux-arm-kernel@lists.infradead.org, Paul Walmsley , Palmer Dabbelt , Albert Ou , Anup Patel , Andrew Jones , Alexandre Ghiti , Conor Dooley , Samuel Holland , linux-riscv@lists.infradead.org, Huacai Chen , WANG Xuerui , Bibo Mao , Tiezhu Yang , Andrew Morton , Tianrui Zhao , loongarch@lists.linux.dev, Alice Ryhl , Carlos Llamas Make it possible to have Rust code call into tracepoints defined by C code. It is still required that the tracepoint is declared in a C header, and that this header is included in the input to bindgen. Instead of calling __DO_TRACE directly, the exported rust_do_trace_ function calls an inline helper function. This is because the `cond` argument does not exist at the callsite of DEFINE_RUST_DO_TRACE. __DECLARE_TRACE always emits an inline static and an extern declaration that is only used when CREATE_RUST_TRACE_POINTS is set. These should not end up in the final binary so it is not a problem that they sometimes are emitted without a user. Reviewed-by: Carlos Llamas Signed-off-by: Alice Ryhl --- include/linux/tracepoint.h | 22 +++++++++++++++++- include/trace/define_trace.h | 12 ++++++++++ rust/bindings/bindings_helper.h | 1 + rust/kernel/lib.rs | 1 + rust/kernel/tracepoint.rs | 49 +++++++++++++++++++++++++++++++++++++++++ 5 files changed, 84 insertions(+), 1 deletion(-) diff --git a/include/linux/tracepoint.h b/include/linux/tracepoint.h index 6be396bb4297..5042ca588e41 100644 --- a/include/linux/tracepoint.h +++ b/include/linux/tracepoint.h @@ -237,6 +237,18 @@ static inline struct tracepoint *tracepoint_ptr_deref(tracepoint_ptr_t *p) #define __DECLARE_TRACE_RCU(name, proto, args, cond) #endif +/* + * Declare an exported function that Rust code can call to trigger this + * tracepoint. This function does not include the static branch; that is done + * in Rust to avoid a function call when the tracepoint is disabled. + */ +#define DEFINE_RUST_DO_TRACE(name, proto, args) +#define __DEFINE_RUST_DO_TRACE(name, proto, args) \ + notrace void rust_do_trace_##name(proto) \ + { \ + __rust_do_trace_##name(args); \ + } + /* * Make sure the alignment of the structure in the __tracepoints section will * not add unwanted padding between the beginning of the section and the @@ -252,6 +264,13 @@ static inline struct tracepoint *tracepoint_ptr_deref(tracepoint_ptr_t *p) extern int __traceiter_##name(data_proto); \ DECLARE_STATIC_CALL(tp_func_##name, __traceiter_##name); \ extern struct tracepoint __tracepoint_##name; \ + extern void rust_do_trace_##name(proto); \ + static inline void __rust_do_trace_##name(proto) \ + { \ + __DO_TRACE(name, \ + TP_ARGS(args), \ + TP_CONDITION(cond), 0); \ + } \ static inline void trace_##name(proto) \ { \ if (static_key_false(&__tracepoint_##name.key)) \ @@ -336,7 +355,8 @@ static inline struct tracepoint *tracepoint_ptr_deref(tracepoint_ptr_t *p) void __probestub_##_name(void *__data, proto) \ { \ } \ - DEFINE_STATIC_CALL(tp_func_##_name, __traceiter_##_name); + DEFINE_STATIC_CALL(tp_func_##_name, __traceiter_##_name); \ + DEFINE_RUST_DO_TRACE(_name, TP_PROTO(proto), TP_ARGS(args)) #define DEFINE_TRACE(name, proto, args) \ DEFINE_TRACE_FN(name, NULL, NULL, PARAMS(proto), PARAMS(args)); diff --git a/include/trace/define_trace.h b/include/trace/define_trace.h index 00723935dcc7..8159294c2041 100644 --- a/include/trace/define_trace.h +++ b/include/trace/define_trace.h @@ -72,6 +72,13 @@ #define DECLARE_TRACE(name, proto, args) \ DEFINE_TRACE(name, PARAMS(proto), PARAMS(args)) +/* If requested, create helpers for calling these tracepoints from Rust. */ +#ifdef CREATE_RUST_TRACE_POINTS +#undef DEFINE_RUST_DO_TRACE +#define DEFINE_RUST_DO_TRACE(name, proto, args) \ + __DEFINE_RUST_DO_TRACE(name, PARAMS(proto), PARAMS(args)) +#endif + #undef TRACE_INCLUDE #undef __TRACE_INCLUDE @@ -129,6 +136,11 @@ # undef UNDEF_TRACE_INCLUDE_PATH #endif +#ifdef CREATE_RUST_TRACE_POINTS +# undef DEFINE_RUST_DO_TRACE +# define DEFINE_RUST_DO_TRACE(name, proto, args) +#endif + /* We may be processing more files */ #define CREATE_TRACE_POINTS diff --git a/rust/bindings/bindings_helper.h b/rust/bindings/bindings_helper.h index b940a5777330..142ee71ae7c4 100644 --- a/rust/bindings/bindings_helper.h +++ b/rust/bindings/bindings_helper.h @@ -19,6 +19,7 @@ #include #include #include +#include #include #include diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index da1f69868d0d..64f2b09920e3 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -52,6 +52,7 @@ pub mod sync; pub mod task; pub mod time; +pub mod tracepoint; pub mod types; pub mod uaccess; pub mod workqueue; diff --git a/rust/kernel/tracepoint.rs b/rust/kernel/tracepoint.rs new file mode 100644 index 000000000000..69dafdb8bfe8 --- /dev/null +++ b/rust/kernel/tracepoint.rs @@ -0,0 +1,49 @@ +// SPDX-License-Identifier: GPL-2.0 + +// Copyright (C) 2024 Google LLC. + +//! Logic for tracepoints. + +/// Declare the Rust entry point for a tracepoint. +/// +/// This macro generates an unsafe function that calls into C, and its safety requirements will be +/// whatever the relevant C code requires. To document these safety requirements, you may add +/// doc-comments when invoking the macro. +#[macro_export] +macro_rules! declare_trace { + ($($(#[$attr:meta])* $pub:vis fn $name:ident($($argname:ident : $argtyp:ty),* $(,)?);)*) => {$( + $( #[$attr] )* + #[inline(always)] + $pub unsafe fn $name($($argname : $argtyp),*) { + #[cfg(CONFIG_TRACEPOINTS)] + { + // SAFETY: It's always okay to query the static key for a tracepoint. + let should_trace = unsafe { + $crate::macros::paste! { + $crate::static_key::static_key_false!( + $crate::bindings::[< __tracepoint_ $name >], + $crate::bindings::tracepoint, + key + ) + } + }; + + if should_trace { + $crate::macros::paste! { + // SAFETY: The caller guarantees that it is okay to call this tracepoint. + unsafe { $crate::bindings::[< rust_do_trace_ $name >]($($argname),*) }; + } + } + } + + #[cfg(not(CONFIG_TRACEPOINTS))] + { + // If tracepoints are disabled, insert a trivial use of each argument + // to avoid unused argument warnings. + $( let _unused = $argname; )* + } + } + )*} +} + +pub use declare_trace;