From patchwork Thu Aug 8 17:23:38 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alice Ryhl X-Patchwork-Id: 13757981 Received: from mail-yb1-f202.google.com (mail-yb1-f202.google.com [209.85.219.202]) (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 9F5C61917FB for ; Thu, 8 Aug 2024 17:23:50 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.219.202 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723137833; cv=none; b=LfI3dhpyPEYu8RY+zcsTvOmtCJC+evgONZhcRuDFI5PhC/ZFvelxuJYOxSJCMQB13TVtp9RzYZrC0TgKMc6dJOasSK6tox7+0J3Pxa9aD0rsGCB54gyWY1nIop2CMU6dlZFJX09aRDzPWegOV9XmJWdwt/MTJd7GNQGCGlky+MU= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723137833; c=relaxed/simple; bh=ScFhXqb37Sff9tROWdFZiuOFbIagmHmjk+412o40cBM=; h=Date:In-Reply-To:Mime-Version:References:Message-ID:Subject:From: To:Cc:Content-Type; b=arRKkU5T3eweXNBlvd751c4yAaSOgd65cMB5GT+pnDUbNZDWY109vsEO7CIXRAZASR0WGM90k7Guoe1bZ4aL2QBNhjeLsiqi5TnPqTYNuPmzSMBSD5GIOX7g60J0C3c+fvmZmf5HXysOyT7tZFbwfrsvE4j8tNHBon48RrBYcx8= 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=XSdj//9I; arc=none smtp.client-ip=209.85.219.202 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="XSdj//9I" Received: by mail-yb1-f202.google.com with SMTP id 3f1490d57ef6-e035949cc4eso2428366276.1 for ; Thu, 08 Aug 2024 10:23:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1723137830; x=1723742630; 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=T2BfL5qwScrigsjrjdMgd0qeyg2ikaATGXdmtZgZMqs=; b=XSdj//9I64N+DFDxSvbknsjcA8b7NhIHBdTqD/taeQ+usaSwX4PL79Vj74qT0MA7E1 qrc5+ykVf8duobuadNbu+59vS0QipT7KhqdhsZji9S52CDbpYJgYGxlE7BH7J3QexE9H BgQ487+s2dO1Dw1s0LOB8RGZic4GMquDldlkZclaYwYUk0XhyRuLtssZIK+OeYcCNBzm uHkWtdIqnBz/Hjld5ygSNyPQUFbEQ3+szni/7aO+fQoYEFASRSyMUGOymx581dX9VTLu TBzYlSIIi5k6KLM8NTE2FpK6U5eZAyrQ5QLGOHXDnvXl99qkCRmWs+3gUUuBbulACmFn xEgw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723137830; x=1723742630; 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=T2BfL5qwScrigsjrjdMgd0qeyg2ikaATGXdmtZgZMqs=; b=rpeFdOJnZHDDA1gAWJUvQon/9n5JaGYr61kN+3/oRij6UyilxSUEnk7Ml/onlDauCF IjvEcL7+JzfwcJlwMIePdtiM/tXg9r2Rw4m3NSDImnI/7l3tnPJH8lZahz+6gDQWPIj/ 5eum1fHOnCwiU+2E3kqCQXTkuHB+Ji7DLdutOU5cUmrdtj2bmqOJ5WrHvHleZNs4fq21 9iiQ04UbfGVnXNHtiFxTKZYLigoVXJDqkQWMtBu+JFxZbkz2cj2SBKgP1+NonINKf74i 5fOUhOZRhTPlLaGeG/V38ECqV2QKJG42OGmQRvEg9AD83b9A55YZO08tTm9xvYQDqiwY cHpw== X-Gm-Message-State: AOJu0YzbaqdQFTMXIFoX3+OIB/+uByfgD11xtwPV01c/O3JjQ+OFRKMV f404njVpHhT1Q/+NWcfifNG7tIXRCjH5v05DkByrHnzNcRWOGbIi7wIQFg2FotjlmzSOcPq83mK o+/cJAl3D+dkyfA== X-Google-Smtp-Source: AGHT+IFs/QBztwofGn6gdEx9lIRoKacN+f2juIEvrjczeOQ+1VBZECHa8m0Py7oBu3JwuvTxeSxySbI30Na6JbI= X-Received: from aliceryhl.c.googlers.com ([fda3:e722:ac3:cc00:28:9cb1:c0a8:35bd]) (user=aliceryhl job=sendgmr) by 2002:a25:5304:0:b0:dfb:b4e:407a with SMTP id 3f1490d57ef6-e0e9dc06144mr100237276.9.1723137829660; Thu, 08 Aug 2024 10:23:49 -0700 (PDT) Date: Thu, 08 Aug 2024 17:23:38 +0000 In-Reply-To: <20240808-tracepoint-v6-0-a23f800f1189@google.com> Precedence: bulk X-Mailing-List: linux-trace-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: Mime-Version: 1.0 References: <20240808-tracepoint-v6-0-a23f800f1189@google.com> X-Developer-Key: i=aliceryhl@google.com; a=openpgp; fpr=49F6C1FAA74960F43A5B86A1EE7A392FDE96209F X-Developer-Signature: v=1; a=openpgp-sha256; l=6823; i=aliceryhl@google.com; h=from:subject:message-id; bh=ScFhXqb37Sff9tROWdFZiuOFbIagmHmjk+412o40cBM=; b=owEBbQKS/ZANAwAKAQRYvu5YxjlGAcsmYgBmtP8bKBJQzPdHrRNULXgDOiP9J4adZ8/RL3zY1 TwE9qCPENyJAjMEAAEKAB0WIQSDkqKUTWQHCvFIvbIEWL7uWMY5RgUCZrT/GwAKCRAEWL7uWMY5 RpH0D/0fxo5D4TfrvpMcRHlO64Kfv3c4LOEheRcCbCJugkos8/63GXm2Ocfb5W+ClDXQlJh8jg+ CJoPzQ7zfhn3wnmY4DDPtSb9WTwzasXXKrxPrs7tibbH/yCofkcvnXzuABlu0Ul6hlGnvSTZBNu GD/JWO4+baZG7hvNMr7vNpdVGX5VsHTGNm6DnsD+DWo6XRd+bPE70COn2MccXdzlDWYBeuCYT3g tM0a39nhMhqUnSdcBoAc6zRbtKxM8zk7dki9AhpTF0gYVEeeuxj6xsS1IZ/SknH6ozZtAP9eb56 4TB4YELJXs4K5JoJxd54kTOBQK+uPoC9HJ2ZbE6QSzZv7VIKFDibIBK+BFndK3rueR0gwLqNjZ1 wAOVBb5Zgvj4RG5DJJeAWMOFDxSHWulkNkiCm6t9nmFIgTUos8MFCYy4Tq3ZxZSZg5hAjiCGN7U micU59j4FQnI1hxZQxN4FbPi5KV2vbxxeFQl6iM8r8/bLNaOKICvTyuf6BrNka3+S//V26PBU/d Uu66oMpFnNWc8/R7thO/icIUF75gwBC6Ix6rfueypp/75MuWQZGNMsRpwYCTpho62Nw2Bj5vsy0 nHEjgNgs+M1/4bf3Vw4JDpFGforqASjYFzvsMstM5fWUQI0nvzWxKxs8NaB28r4Q7myo+j8A1pF YsISQxO7z82a0LQ== X-Mailer: b4 0.13.0 Message-ID: <20240808-tracepoint-v6-2-a23f800f1189@google.com> Subject: [PATCH v6 2/5] 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 Reviewed-by: Gary Guo --- 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 8fd092e1b809..fc6f94729789 100644 --- a/rust/bindings/bindings_helper.h +++ b/rust/bindings/bindings_helper.h @@ -20,6 +20,7 @@ #include #include #include +#include #include #include diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index 91af9f75d121..d00a44b000b6 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -51,6 +51,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..cf2d9ad15912 --- /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 unsafe 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::jump_label::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;