From patchwork Fri Jun 28 13:23:31 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alice Ryhl X-Patchwork-Id: 13716141 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 BE7C6C2BD09 for ; Fri, 28 Jun 2024 13:24:19 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:Cc:To:From:Subject:Message-ID: References:Mime-Version:In-Reply-To:Date:Reply-To:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Owner; bh=26ziV7mwqqrOd+sZrI+gBQNWeY+uQlvlfpFnksVFoAc=; b=KFv6jnQb9TvA4DXf7wZUAnoqQv CSe96D7pGwW+jzzm5+AK/qWmjm6qVkDWhfLK+PEc+3cwh99nANVlwdLFGIlOspmmpjFB/YsZlmDDs tLm1jbOccYDXUSkrGdL7oMyqcGx4kUgC9e+6XDrvzPpIsz5P9wtK4jYZVYkz2NGkVxS2VqdMkJkul 8AeC4nTSpDYQUO1AL27a5B9k8QIrauFwfQnf0j45152Z1OEWZNyrB4fuVHjt137Sh1Wt3ytv0UX1c gOKEu9dPfvh74luq7lFFWoSBTHoxAtytebVFzZUTMlnb2wEd3QW69d6c2zyBALgv+2ZiYmRifsmcI YBvcH5aA==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1sNBaI-0000000Do8D-21hd; Fri, 28 Jun 2024 13:24:14 +0000 Received: from mail-yb1-xb4a.google.com ([2607:f8b0:4864:20::b4a]) by bombadil.infradead.org with esmtps (Exim 4.97.1 #2 (Red Hat Linux)) id 1sNBaE-0000000Do5E-06gc for linux-riscv@lists.infradead.org; Fri, 28 Jun 2024 13:24:11 +0000 Received: by mail-yb1-xb4a.google.com with SMTP id 3f1490d57ef6-dfdff0a9f26so1131965276.1 for ; Fri, 28 Jun 2024 06:24:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1719581048; x=1720185848; darn=lists.infradead.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=/a2ZCUdqZnx3gcLssluxRqmW7oZjQjPUNJsEztKYUiU=; b=WshEx9akVPcc7cvw/itB4HN6xwOxKZ1LPo/Hrc4QkZqmLuT8RcBvuTV/2TV1BRxUwG 0IUkIW3hYBaBm5r/68yNyFawyp/lCmBShvWxEpcqd/UDKu7P/hayAB8Y7Ss/xQMFdB66 F+D54Z4XzKx6wD2qaaCbh3PhrLVJkaAEhWJ6yxaLBBlBAuPCnqQD97+6RsXmkHMclwKH QHH/3Nu8SsXmmJqu5bhf/8Ae8fYXHHneZuKqQoUas1wDGqdTRImMqApNpJvvGr6gp3cJ f9Pf7CDgaDnhdHk0uzJ0pDy01eVp2NU8F1h7Um8p/Khk5w5oXIrT4oIGbj/2CaIxJyiY Kjbw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1719581048; x=1720185848; 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=/a2ZCUdqZnx3gcLssluxRqmW7oZjQjPUNJsEztKYUiU=; b=Eo3UJSmid3MfI4usRubP/5G2+XFjAs83/CgqKiuahagDtOl/lhVQNFnW8caUIcpotU fvW4afKimm+00ORL0BeHaV9bRZiDTZMtVZUpeR2yEBv50zIbqrn9Dtgcw/d85EvhWhRc Z/BnnTdg2ISLYHH3PH7S/IWeMSbKMQfT+GXDIw/Ex8VXxpF4Ex84LaVoUydtL5anuYOM zWXDdheffvP7q7jJ16BJhs9rjTPbWVbCGHV4VxyLieSX5vnuBoCAWZmmlvCtsTLvslxm b/l4vwqENEF/BLFp/hJ+OjUufLjkEdEI6iDirIbngYo98d6f/G+KQkYLJT/mWSjGWhBO /B5A== X-Forwarded-Encrypted: i=1; AJvYcCXTZlGzBX9kMEIhDVnDDPa0LMOILyMHpO+fVgo2UMC8chBvXl66dh0KIrL4X9z1feeKA/ASDl24NpKWekBkBBKdKJpv8swLobHG7ZUROUFv X-Gm-Message-State: AOJu0YyCLFLwAiW7rYxm8FzjzOJOOoXzSfrnBvzo0b06y7XoCvHK8Yh2 yvSijrpSlGUg/l1Whr4kbXYTAUEWnfbQbf4UAGeyy/Q+XwwabmDkYSx1rRQ8wrx53qotBLfPoQu oTMtAF1h7B3W9YQ== X-Google-Smtp-Source: AGHT+IGK2JbrDPOIj4UtdPPGCRvHLr6NwiAv2YDbVcCcknMSROVSjrnV3BiQa7tDUYtaKr8A5oiO1msI8gMbuL0= X-Received: from aliceryhl2.c.googlers.com ([fda3:e722:ac3:cc00:68:949d:c0a8:572]) (user=aliceryhl job=sendgmr) by 2002:a05:6902:1009:b0:e03:252a:f931 with SMTP id 3f1490d57ef6-e03252afca1mr21180276.1.1719581048085; Fri, 28 Jun 2024 06:24:08 -0700 (PDT) Date: Fri, 28 Jun 2024 13:23:31 +0000 In-Reply-To: <20240628-tracepoint-v4-0-353d523a9c15@google.com> Mime-Version: 1.0 References: <20240628-tracepoint-v4-0-353d523a9c15@google.com> X-Developer-Key: i=aliceryhl@google.com; a=openpgp; fpr=49F6C1FAA74960F43A5B86A1EE7A392FDE96209F X-Developer-Signature: v=1; a=openpgp-sha256; l=9288; i=aliceryhl@google.com; h=from:subject:message-id; bh=smlzFG650Bjyj/G17d9Nx6uQENcjy/0hVqprbqaAZSk=; b=owEBbQKS/ZANAwAKAQRYvu5YxjlGAcsmYgBmfrlw3bHKyORe0dE0EbrR0xejztmzSskCkdb1q 8YpniSF/amJAjMEAAEKAB0WIQSDkqKUTWQHCvFIvbIEWL7uWMY5RgUCZn65cAAKCRAEWL7uWMY5 RmF6D/4s+/xnuVSiUlgtEsduacVpUm4pE1jcx/Do8fGJ9OQfkiODdmUNe7KHShGgcJff1bKG5jr J0ZxJr/GVN2vslbojoTLkBHwhCEfY/aXJcT6/dmCWylHIKd1Z8xSA4Uf0fVDCph0gmr0+3fDl+3 ND1WW57X9ZfVHYrNw53br5PavOcA/zTYzyyqoXKzUwHYXuRfPlWF+KGCAh5vHSPp+xJMUNJ9/rd xe6DRQ2I6mNjE14bZDgjixPJMnYetZDsn7OHtfGhTcxWNCeOCO+AtkETX+DPb1YywcwJQkbpBSC HT0GMYoa4klrOEj/1IL5aAtIQJjaWuqgOHYOS9+TvHqhfxBq8Zx6n4zibWP23zxPcTOyJect/An uVR+SRz9sbdH0HI2vVszXlm51cx5gNGxIFRYc81pbGbPGO6jLOvkEqPEeYUCCY5nnguSgWDqpjA 9TYpro/ubpYC45Ry9XzS2m2iHQPBaaj4QPYiKO86g1vpdUlp0+FLAoJqyu1WZNk08i8+smeXe7U 3mLF114P0UL1tpd1dwL8eOsFkoHg02AAy6IvTvcCxOR/fDqaT0blCbsr7FFTCyhuuF9EkQrNCW7 xzvTGAOLliUGNSDFfoW/wnVuxKy4GxlwizdVQnlf3CvIZug0MGICixjVL8aALVEQDDweYf5BJGG DAULc4DNwd64I9Q== X-Mailer: b4 0.13-dev-26615 Message-ID: <20240628-tracepoint-v4-1-353d523a9c15@google.com> Subject: [PATCH v4 1/2] rust: add static_key_false 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" , "Peter Zijlstra (Intel)" , 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 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240628_062410_249711_E0C20A48 X-CRM114-Status: GOOD ( 22.36 ) X-BeenThere: linux-riscv@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-riscv" Errors-To: linux-riscv-bounces+linux-riscv=archiver.kernel.org@lists.infradead.org Add just enough support for static key so that we can use it from tracepoints. Tracepoints rely on `static_key_false` even though it is deprecated, so we add the same functionality to Rust. It is not possible to use the existing C implementation of arch_static_branch because it passes the argument `key` to inline assembly as an 'i' parameter, so any attempt to add a C helper for this function will fail to compile because the value of `key` must be known at compile-time. Signed-off-by: Alice Ryhl Tested-by: WANG Rui --- rust/kernel/arch/arm64/jump_label.rs | 34 ++++++++++++++++++++++++++++ rust/kernel/arch/loongarch/jump_label.rs | 35 +++++++++++++++++++++++++++++ rust/kernel/arch/mod.rs | 24 ++++++++++++++++++++ rust/kernel/arch/riscv/jump_label.rs | 38 ++++++++++++++++++++++++++++++++ rust/kernel/arch/x86/jump_label.rs | 35 +++++++++++++++++++++++++++++ rust/kernel/lib.rs | 2 ++ rust/kernel/static_key.rs | 32 +++++++++++++++++++++++++++ scripts/Makefile.build | 2 +- 8 files changed, 201 insertions(+), 1 deletion(-) diff --git a/rust/kernel/arch/arm64/jump_label.rs b/rust/kernel/arch/arm64/jump_label.rs new file mode 100644 index 000000000000..5eede2245718 --- /dev/null +++ b/rust/kernel/arch/arm64/jump_label.rs @@ -0,0 +1,34 @@ +// SPDX-License-Identifier: GPL-2.0 + +// Copyright (C) 2024 Google LLC. + +//! Arm64 Rust implementation of jump_label.h + +/// arm64 implementation of arch_static_branch +#[macro_export] +#[cfg(target_arch = "aarch64")] +macro_rules! arch_static_branch { + ($key:path, $keytyp:ty, $field:ident, $branch:expr) => {'my_label: { + core::arch::asm!( + r#" + 1: nop + + .pushsection __jump_table, "aw" + .align 3 + .long 1b - ., {0} - . + .quad {1} + {2} + {3} - . + .popsection + "#, + label { + break 'my_label true; + }, + sym $key, + const ::core::mem::offset_of!($keytyp, $field), + const $crate::arch::bool_to_int($branch), + ); + + break 'my_label false; + }}; +} + +pub use arch_static_branch; diff --git a/rust/kernel/arch/loongarch/jump_label.rs b/rust/kernel/arch/loongarch/jump_label.rs new file mode 100644 index 000000000000..8d31318aeb11 --- /dev/null +++ b/rust/kernel/arch/loongarch/jump_label.rs @@ -0,0 +1,35 @@ +// SPDX-License-Identifier: GPL-2.0 + +// Copyright (C) 2024 Google LLC. + +//! Loongarch Rust implementation of jump_label.h + +/// loongarch implementation of arch_static_branch +#[doc(hidden)] +#[macro_export] +#[cfg(target_arch = "loongarch64")] +macro_rules! arch_static_branch { + ($key:path, $keytyp:ty, $field:ident, $branch:expr) => {'my_label: { + core::arch::asm!( + r#" + 1: nop + + .pushsection __jump_table, "aw" + .align 3 + .long 1b - ., {0} - . + .quad {1} + {2} + {3} - . + .popsection + "#, + label { + break 'my_label true; + }, + sym $key, + const ::core::mem::offset_of!($keytyp, $field), + const $crate::arch::bool_to_int($branch), + ); + + break 'my_label false; + }}; +} + +pub use arch_static_branch; diff --git a/rust/kernel/arch/mod.rs b/rust/kernel/arch/mod.rs new file mode 100644 index 000000000000..14271d2530e9 --- /dev/null +++ b/rust/kernel/arch/mod.rs @@ -0,0 +1,24 @@ +// SPDX-License-Identifier: GPL-2.0 + +// Copyright (C) 2024 Google LLC. + +//! Architecture specific code. + +#[cfg_attr(target_arch = "aarch64", path = "arm64")] +#[cfg_attr(target_arch = "x86_64", path = "x86")] +#[cfg_attr(target_arch = "loongarch64", path = "loongarch")] +#[cfg_attr(target_arch = "riscv64", path = "riscv")] +mod inner { + pub mod jump_label; +} + +pub use self::inner::*; + +/// A helper used by inline assembly to pass a boolean to as a `const` parameter. +/// +/// Using this function instead of a cast lets you assert that the input is a boolean, rather than +/// some other type that can be cast to an integer. +#[doc(hidden)] +pub const fn bool_to_int(b: bool) -> i32 { + b as i32 +} diff --git a/rust/kernel/arch/riscv/jump_label.rs b/rust/kernel/arch/riscv/jump_label.rs new file mode 100644 index 000000000000..2672e0c6f033 --- /dev/null +++ b/rust/kernel/arch/riscv/jump_label.rs @@ -0,0 +1,38 @@ +// SPDX-License-Identifier: GPL-2.0 + +// Copyright (C) 2024 Google LLC. + +//! RiscV Rust implementation of jump_label.h + +/// riscv implementation of arch_static_branch +#[macro_export] +#[cfg(target_arch = "riscv64")] +macro_rules! arch_static_branch { + ($key:path, $keytyp:ty, $field:ident, $branch:expr) => {'my_label: { + core::arch::asm!( + r#" + .align 2 + .option push + .option norelax + .option norvc + 1: nop + .option pop + .pushsection __jump_table, "aw" + .align 3 + .long 1b - ., {0} - . + .dword {1} + {2} + {3} - . + .popsection + "#, + label { + break 'my_label true; + }, + sym $key, + const ::core::mem::offset_of!($keytyp, $field), + const $crate::arch::bool_to_int($branch), + ); + + break 'my_label false; + }}; +} + +pub use arch_static_branch; diff --git a/rust/kernel/arch/x86/jump_label.rs b/rust/kernel/arch/x86/jump_label.rs new file mode 100644 index 000000000000..383bed273c50 --- /dev/null +++ b/rust/kernel/arch/x86/jump_label.rs @@ -0,0 +1,35 @@ +// SPDX-License-Identifier: GPL-2.0 + +// Copyright (C) 2024 Google LLC. + +//! X86 Rust implementation of jump_label.h + +/// x86 implementation of arch_static_branch +#[macro_export] +#[cfg(target_arch = "x86_64")] +macro_rules! arch_static_branch { + ($key:path, $keytyp:ty, $field:ident, $branch:expr) => {'my_label: { + core::arch::asm!( + r#" + 1: .byte 0x0f,0x1f,0x44,0x00,0x00 + + .pushsection __jump_table, "aw" + .balign 8 + .long 1b - . + .long {0} - . + .quad {1} + {2} + {3} - . + .popsection + "#, + label { + break 'my_label true; + }, + sym $key, + const ::core::mem::offset_of!($keytyp, $field), + const $crate::arch::bool_to_int($branch), + ); + + break 'my_label false; + }}; +} + +pub use arch_static_branch; diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index fbd91a48ff8b..fffd4e1dd1c1 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -27,6 +27,7 @@ extern crate self as kernel; pub mod alloc; +pub mod arch; mod build_assert; pub mod error; pub mod init; @@ -38,6 +39,7 @@ pub mod prelude; pub mod print; mod static_assert; +pub mod static_key; #[doc(hidden)] pub mod std_vendor; pub mod str; diff --git a/rust/kernel/static_key.rs b/rust/kernel/static_key.rs new file mode 100644 index 000000000000..32cf027ef091 --- /dev/null +++ b/rust/kernel/static_key.rs @@ -0,0 +1,32 @@ +// SPDX-License-Identifier: GPL-2.0 + +// Copyright (C) 2024 Google LLC. + +//! Logic for static keys. + +use crate::bindings::*; + +/// Branch based on a static key. +/// +/// Takes three arguments: +/// +/// * `key` - the path to the static variable containing the `static_key`. +/// * `keytyp` - the type of `key`. +/// * `field` - the name of the field of `key` that contains the `static_key`. +#[macro_export] +macro_rules! static_key_false { + ($key:path, $keytyp:ty, $field:ident) => {{ + // Assert that `$key` has type `$keytyp` and that `$key.$field` has type `static_key`. + // + // SAFETY: We know that `$key` is a static because otherwise the inline assembly will not + // compile. The raw pointers created in this block are in-bounds of `$key`. + static _TY_ASSERT: () = unsafe { + let key: *const $keytyp = ::core::ptr::addr_of!($key); + let _: *const $crate::bindings::static_key = ::core::ptr::addr_of!((*key).$field); + }; + + $crate::arch::jump_label::arch_static_branch! { $key, $keytyp, $field, false } + }}; +} + +pub use static_key_false; diff --git a/scripts/Makefile.build b/scripts/Makefile.build index efacca63c897..60197c1c063f 100644 --- a/scripts/Makefile.build +++ b/scripts/Makefile.build @@ -263,7 +263,7 @@ $(obj)/%.lst: $(obj)/%.c FORCE # Compile Rust sources (.rs) # --------------------------------------------------------------------------- -rust_allowed_features := new_uninit +rust_allowed_features := asm_const,asm_goto,new_uninit # `--out-dir` is required to avoid temporaries being created by `rustc` in the # current working directory, which may be not accessible in the out-of-tree From patchwork Fri Jun 28 13:23:32 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alice Ryhl X-Patchwork-Id: 13716143 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 6068EC3065B for ; Fri, 28 Jun 2024 13:24:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:Cc:To:From:Subject:Message-ID: References:Mime-Version:In-Reply-To:Date:Reply-To:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Owner; bh=GyBWTrmuIigZeDwciNH+DfgBR5tDRsf2t/yJ8TZxxFc=; b=gCAOwY5ee2JPN7GQaEkkXGgIMD htcBHgDO8Stxh9bRRtu9JpxcJUgC7/pHsrBVEmW68tXssiXz5FKBzse1GgHxBEFHlk63FTzMvTbtu Bqej59Lcy4mRHoHS3K6sYW/4T0Q3ZWo+6qAuPtK/Iwztbpx7BGUPx37BJxBVPK+odCHB+S68Kf80p EMYYL7MSd20JgezY/Hen9ThJntRubwOuys+7FOp+DtsaN4ptHSqYkzglLyEElGpt2RIo+ux6vdJdd 7BySXCFMhGKv8eIiMFxNQXwqv0+m73Ihejq7chgkKGv110H9N7fT94lSGsxF2rhzYufumQRP01p56 NnmnKQ7A==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.97.1 #2 (Red Hat Linux)) id 1sNBaL-0000000Do9g-3GEY; Fri, 28 Jun 2024 13:24:17 +0000 Received: from mail-lf1-x149.google.com ([2a00:1450:4864:20::149]) by bombadil.infradead.org with esmtps (Exim 4.97.1 #2 (Red Hat Linux)) id 1sNBaH-0000000Do6F-461t for linux-riscv@lists.infradead.org; Fri, 28 Jun 2024 13:24:15 +0000 Received: by mail-lf1-x149.google.com with SMTP id 2adb3069b0e04-52cd90d8da1so699416e87.0 for ; Fri, 28 Jun 2024 06:24:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1719581051; x=1720185851; darn=lists.infradead.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=969O3CWF12Jm+ipcoNEWf7U/TfwGyBpHNp6wtcZC710=; b=KAktD8q50xXy7EIay7bPzsfex4mDJ107zI77eM4Eb3h0uPpoMqPl6eTzTC/GcQPMFo /+GYEgSjbaT4oQqJfttIMLqxbSuyUGYqdCNls3iIAgMs5RsI0QhtgqFrTVVv7U3vmDnA mMBZq+KswB3XL+crcIa66WmY85d2vjFWe1v43mAdZGjMN8vAgM5jlhrTDDh455A+f06m GTNyHrCF/jBHVCvE6lLpbJmIInaYRKoUVrW0uPwfp10PuLXJJ7TtdzQocAtg1w2EM0gY GX837H1VPIumwknfPB9ET2jpVP2efFiubTuA0l1O7rf6MN0d1oW3+tlHyvvjHUIcoV9G Kphg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1719581051; x=1720185851; 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=969O3CWF12Jm+ipcoNEWf7U/TfwGyBpHNp6wtcZC710=; b=C1pxYcYu6Mz92ySSOpeesUPy+lGZa99wxg/eE8D8oVg4DsR7mnYSKMjVaUG6a6vGWJ xqUkZ+CccgO+wqZs/gmEB4n1/qCduP7BzCFZREt2Jic9nKzZQIWjjqrEGGws7Z4XyhYq 6fLm3BpgMJXyayqHSv5jybgHyR4c2V0kCn4fGteH/UK5FvonyL+LzBT6xl7Ngmf5sYiw ZO6E+LKe8QBqPtxbeWPqInCuUu/bM2sDaRR3fIggUrNVE/8xhv4nOcqtOqEnYz8ZT7aE Y9pKlPdyGYTvL/Wfu5X8TB5WWYwg5upIwaKSPxqi8DM9lnhyb1rHAR2lqgpdY5wWQEg0 tK1Q== X-Forwarded-Encrypted: i=1; AJvYcCWhZVq6shXSHFavgrS+qT3My+kvT1Rui/e01DVYN3bPvwjvkdScTTH9vnTjoUbsPXIKwZLfJZnPCXWF76/gKVcj/hHU+t9OS4+TE82AFPG7 X-Gm-Message-State: AOJu0YwdpdwOpzQdyhetN9We7TOhoaQLuv+HLfu4715wael34gyE7Qa2 Qg9fg1ZaQ2xHO9vkkbnwnlkR85nCAeoL8z9/lSSBSO2k/GLEheBU7w1+sYNPUJC0wd76wehx3NT /eeMzHBp7S+GpoQ== X-Google-Smtp-Source: AGHT+IHOuhMH8lCZyqgPZo0IUCZguSKcNbXCdaWjj3cdEvBVq1Q+0LN7WSNqoq7E7NvkH+V+nQUqXL0VRBCHifE= X-Received: from aliceryhl2.c.googlers.com ([fda3:e722:ac3:cc00:68:949d:c0a8:572]) (user=aliceryhl job=sendgmr) by 2002:a05:6512:3e28:b0:52c:7f96:81d1 with SMTP id 2adb3069b0e04-52ce061ab41mr20614e87.6.1719581050857; Fri, 28 Jun 2024 06:24:10 -0700 (PDT) Date: Fri, 28 Jun 2024 13:23:32 +0000 In-Reply-To: <20240628-tracepoint-v4-0-353d523a9c15@google.com> Mime-Version: 1.0 References: <20240628-tracepoint-v4-0-353d523a9c15@google.com> X-Developer-Key: i=aliceryhl@google.com; a=openpgp; fpr=49F6C1FAA74960F43A5B86A1EE7A392FDE96209F X-Developer-Signature: v=1; a=openpgp-sha256; l=5954; i=aliceryhl@google.com; h=from:subject:message-id; bh=v/CwpANb/enEE59VpWuqO+vG2Bs6iq8UapwpRJZ9hQA=; b=owEBbQKS/ZANAwAKAQRYvu5YxjlGAcsmYgBmfrlxFoRsS4nKuM5f791HMS0zaizWUN/GuWPSF 5DmAsQIie+JAjMEAAEKAB0WIQSDkqKUTWQHCvFIvbIEWL7uWMY5RgUCZn65cQAKCRAEWL7uWMY5 Rnn4D/9tLGOpO3gm1Mdg7+V3aBKPndVvoDIfPVKiSkD+ATgpOSjsralpHwXujxhx1IqP3lYgOdz F4tE/qK42GPiG2qOTjpSpJDaMSQfw1d9ndqFJp3KG71VnpHJGL3k4nwnKr4SGu5BoznL6eyv+wX GMjXIqpL1Aml+w5cF+MMfEs4FjjCVM/HRlpM4z5A/gCBUEAQqixk+LexC5R/qvVJJYOxiqTALFu idNa0gDOJwenzkvtOUM8hu1iBrNFC9/7BtwnCQ6dY14wy+j1zXRNORSmO4KK7TqxLuqtVRpBRm+ +ZFo3ePJ2Cv3ppirCqmoxPx2ntkTkPSMtU32nFAWBumNIIUDyH+gG/XFzLYK3nFLghDsB8WjPpZ FpJDBtbmHzuGz4yQU3sNeN6piB8QumLbHKi3cHoLdujMGDkno25gVUSRCXe7h70q0g1x2RlEmjg sFElazH5qpsztWiLuPlFMNPJo7W6iijAV0RGTCLtTYg+NNrInG+xze+KV4I/vuK6GiZkTbR4X21 YDrhSxVEt4S5Kv0bycWgW7FOOGIlWo7tDcn61JvMW8f9acRFHeVsKElIdbwzOnt1ThoUpvUbw7I HwsSEBS9BKACnoLcUCP1aDFTlZqDkmUTMcefFdHWM/6jPz92m7LbDPq2vWSCFmM2u/rum1QCrjY 6gmxPd34WQQHtZA== X-Mailer: b4 0.13-dev-26615 Message-ID: <20240628-tracepoint-v4-2-353d523a9c15@google.com> Subject: [PATCH v4 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" , "Peter Zijlstra (Intel)" , 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 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20240628_062414_027991_9A0B8CB7 X-CRM114-Status: GOOD ( 23.85 ) X-BeenThere: linux-riscv@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-riscv" Errors-To: linux-riscv-bounces+linux-riscv=archiver.kernel.org@lists.infradead.org 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. Signed-off-by: Alice Ryhl --- include/linux/tracepoint.h | 18 +++++++++++++++- include/trace/define_trace.h | 12 +++++++++++ rust/bindings/bindings_helper.h | 1 + rust/kernel/lib.rs | 1 + rust/kernel/tracepoint.rs | 47 +++++++++++++++++++++++++++++++++++++++++ 5 files changed, 78 insertions(+), 1 deletion(-) diff --git a/include/linux/tracepoint.h b/include/linux/tracepoint.h index 689b6d71590e..d82af4d77c9f 100644 --- a/include/linux/tracepoint.h +++ b/include/linux/tracepoint.h @@ -238,6 +238,20 @@ 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_REAL(name, proto, args) \ + notrace void rust_do_trace_##name(proto) \ + { \ + __DO_TRACE(name, \ + TP_ARGS(args), \ + cpu_online(raw_smp_processor_id()), 0); \ + } + /* * Make sure the alignment of the structure in the __tracepoints section will * not add unwanted padding between the beginning of the section and the @@ -253,6 +267,7 @@ 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 trace_##name(proto) \ { \ if (static_key_false(&__tracepoint_##name.key)) \ @@ -337,7 +352,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..08ed5ce63a96 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_REAL(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 ddb5644d4fd9..d442f9ccfc2c 100644 --- a/rust/bindings/bindings_helper.h +++ b/rust/bindings/bindings_helper.h @@ -15,6 +15,7 @@ #include #include #include +#include #include #include diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index fffd4e1dd1c1..9ae90eb69020 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -46,6 +46,7 @@ pub mod sync; pub mod task; pub mod time; +pub mod tracepoint; pub mod types; pub mod workqueue; diff --git a/rust/kernel/tracepoint.rs b/rust/kernel/tracepoint.rs new file mode 100644 index 000000000000..1005f09e0330 --- /dev/null +++ b/rust/kernel/tracepoint.rs @@ -0,0 +1,47 @@ +// SPDX-License-Identifier: GPL-2.0 + +// Copyright (C) 2024 Google LLC. + +//! Logic for tracepoints. + +/// Declare the Rust entry point for a tracepoint. +#[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)] + { + use $crate::bindings::*; + + // 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!( + [< __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 { [< 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;