From nobody Mon Feb 9 19:30:47 2026 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 676DFC76196 for ; Mon, 3 Apr 2023 09:35:31 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231422AbjDCJfa (ORCPT ); Mon, 3 Apr 2023 05:35:30 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34574 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232228AbjDCJev (ORCPT ); Mon, 3 Apr 2023 05:34:51 -0400 Received: from mail.marcansoft.com (marcansoft.com [212.63.210.85]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id DB6CB11166; Mon, 3 Apr 2023 02:34:23 -0700 (PDT) Received: from [127.0.0.1] (localhost [127.0.0.1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: linasend@asahilina.net) by mail.marcansoft.com (Postfix) with ESMTPSA id C65E842118; Mon, 3 Apr 2023 09:33:58 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=asahilina.net; s=default; t=1680514441; bh=bFkXHFNyb9LVEKt1rmM5zqGTtOh4DagUhZhRSzQ4E0w=; h=From:Date:Subject:References:In-Reply-To:To:Cc; b=JyUb9QqWj9s1yHTD9z5oE80E8+X2RfzLpsv7cQPYVDN9Rp2/jb7nzqydLxRmu9K5f z8dHVozLqhI9z1DG+v8ugeLPPhrDeMBWXUXiQenszpXeRypoSBnb3pHA1DJlpjdxTa SXAeeAOpjmsq2f8rVZ9J+kt8/9ULIhpydP9oHkvxw/81sTLBRudmBDPtSqYmwUtvLd xLzIUxNC7G47wFIc7akWTfbyRJr6aqgMvMsBwpQeeFTZIa75XD8IVpypI3u+amUZ+x uc/VNCcD63IIfXnBOKeDo6q/Jz89KYyfBdkRCuu5Gs2MSGWu2jJAMBEW8nHwc8tBFo pEemOPXDYFT0Q== From: Asahi Lina Date: Mon, 03 Apr 2023 18:33:52 +0900 Subject: [PATCH v2 1/2] rust: uapi: Add UAPI crate MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Message-Id: <20230329-rust-uapi-v2-1-bca5fb4d4a12@asahilina.net> References: <20230329-rust-uapi-v2-0-bca5fb4d4a12@asahilina.net> In-Reply-To: <20230329-rust-uapi-v2-0-bca5fb4d4a12@asahilina.net> To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Arnd Bergmann Cc: Martin Rodriguez Reboredo , linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org, asahi@lists.linux.dev, Asahi Lina X-Mailer: b4 0.12.0 X-Developer-Signature: v=1; a=ed25519-sha256; t=1680514434; l=4738; i=lina@asahilina.net; s=20230221; h=from:subject:message-id; bh=bFkXHFNyb9LVEKt1rmM5zqGTtOh4DagUhZhRSzQ4E0w=; b=goFV/tzbT+4lsSATOIankvn8nz7knSO1zBLYhh+zALKhcNHcpnwreuVmlqtMaKKfRo0LE5nux /ePmu9+0tTFBER+BRzUJQKyObx6U7/fmKkcJ+pJGRM3g2USByhKauMV X-Developer-Key: i=lina@asahilina.net; a=ed25519; pk=Qn8jZuOtR1m5GaiDfTrAoQ4NE1XoYVZ/wmt5YtXWFC4= Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This crate mirrors the `bindings` crate, but will contain only UAPI bindings. Unlike the bindings crate, drivers may directly use this crate if they have to interface with userspace. Initially, just bind the generic ioctl stuff. In the future, we would also like to add additional checks to ensure that all types exposed by this crate satisfy UAPI-safety guarantees (that is, they are safely castable to/from a "bag of bits"). Reviewed-by: Martin Rodriguez Reboredo Signed-off-by: Asahi Lina --- rust/.gitignore | 1 + rust/Makefile | 18 ++++++++++++++++-- rust/kernel/lib.rs | 1 + rust/uapi/lib.rs | 27 +++++++++++++++++++++++++++ rust/uapi/uapi_helper.h | 9 +++++++++ 5 files changed, 54 insertions(+), 2 deletions(-) diff --git a/rust/.gitignore b/rust/.gitignore index 168cb26a31b9..21552992b401 100644 --- a/rust/.gitignore +++ b/rust/.gitignore @@ -2,6 +2,7 @@ =20 bindings_generated.rs bindings_helpers_generated.rs +uapi_generated.rs exports_*_generated.h doc/ test/ diff --git a/rust/Makefile b/rust/Makefile index f88d108fbef0..f81fdefec0ab 100644 --- a/rust/Makefile +++ b/rust/Makefile @@ -16,6 +16,9 @@ obj-$(CONFIG_RUST) +=3D alloc.o bindings.o kernel.o always-$(CONFIG_RUST) +=3D exports_alloc_generated.h exports_bindings_gene= rated.h \ exports_kernel_generated.h =20 +always-$(CONFIG_RUST) +=3D uapi/uapi_generated.rs +obj-$(CONFIG_RUST) +=3D uapi.o + ifdef CONFIG_RUST_BUILD_ASSERT_ALLOW obj-$(CONFIG_RUST) +=3D build_error.o else @@ -288,6 +291,12 @@ $(obj)/bindings/bindings_generated.rs: $(src)/bindings= /bindings_helper.h \ $(src)/bindgen_parameters FORCE $(call if_changed_dep,bindgen) =20 +$(obj)/uapi/uapi_generated.rs: private bindgen_target_flags =3D \ + $(shell grep -v '^#\|^$$' $(srctree)/$(src)/bindgen_parameters) +$(obj)/uapi/uapi_generated.rs: $(src)/uapi/uapi_helper.h \ + $(src)/bindgen_parameters FORCE + $(call if_changed_dep,bindgen) + # See `CFLAGS_REMOVE_helpers.o` above. In addition, Clang on C does not wa= rn # with `-Wmissing-declarations` (unlike GCC), so it is not strictly needed= here # given it is `libclang`; but for consistency, future Clang changes and/or @@ -388,10 +397,15 @@ $(obj)/bindings.o: $(src)/bindings/lib.rs \ $(obj)/bindings/bindings_helpers_generated.rs FORCE $(call if_changed_dep,rustc_library) =20 +$(obj)/uapi.o: $(src)/uapi/lib.rs \ + $(obj)/compiler_builtins.o \ + $(obj)/uapi/uapi_generated.rs FORCE + $(call if_changed_dep,rustc_library) + $(obj)/kernel.o: private rustc_target_flags =3D --extern alloc \ - --extern build_error --extern macros --extern bindings + --extern build_error --extern macros --extern bindings --extern uapi $(obj)/kernel.o: $(src)/kernel/lib.rs $(obj)/alloc.o $(obj)/build_error.o \ - $(obj)/libmacros.so $(obj)/bindings.o FORCE + $(obj)/libmacros.so $(obj)/bindings.o $(obj)/uapi.o FORCE $(call if_changed_dep,rustc_library) =20 endif # CONFIG_RUST diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index 223564f9f0cc..afec0792d982 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -42,6 +42,7 @@ pub mod types; #[doc(hidden)] pub use bindings; pub use macros; +pub use uapi; =20 #[doc(hidden)] pub use build_error::build_error; diff --git a/rust/uapi/lib.rs b/rust/uapi/lib.rs new file mode 100644 index 000000000000..29f69f3a52de --- /dev/null +++ b/rust/uapi/lib.rs @@ -0,0 +1,27 @@ +// SPDX-License-Identifier: GPL-2.0 + +//! UAPI Bindings. +//! +//! Contains the bindings generated by `bindgen` for UAPI interfaces. +//! +//! This crate may be used directly by drivers that need to interact with +//! userspace APIs. + +#![no_std] +#![feature(core_ffi_c)] +// See . +#![cfg_attr(test, allow(deref_nullptr))] +#![cfg_attr(test, allow(unaligned_references))] +#![cfg_attr(test, allow(unsafe_op_in_unsafe_fn))] +#![allow( + clippy::all, + missing_docs, + non_camel_case_types, + non_upper_case_globals, + non_snake_case, + improper_ctypes, + unreachable_pub, + unsafe_op_in_unsafe_fn +)] + +include!(concat!(env!("OBJTREE"), "/rust/uapi/uapi_generated.rs")); diff --git a/rust/uapi/uapi_helper.h b/rust/uapi/uapi_helper.h new file mode 100644 index 000000000000..301f5207f023 --- /dev/null +++ b/rust/uapi/uapi_helper.h @@ -0,0 +1,9 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* + * Header that contains the headers for which Rust UAPI bindings + * will be automatically generated by `bindgen`. + * + * Sorted alphabetically. + */ + +#include --=20 2.40.0 From nobody Mon Feb 9 19:30:47 2026 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 vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id B2F41C76196 for ; Mon, 3 Apr 2023 09:35:45 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232179AbjDCJfo (ORCPT ); Mon, 3 Apr 2023 05:35:44 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34740 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231267AbjDCJfN (ORCPT ); Mon, 3 Apr 2023 05:35:13 -0400 Received: from mail.marcansoft.com (marcansoft.com [212.63.210.85]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 40A581025C; Mon, 3 Apr 2023 02:34:33 -0700 (PDT) Received: from [127.0.0.1] (localhost [127.0.0.1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: linasend@asahilina.net) by mail.marcansoft.com (Postfix) with ESMTPSA id 4CFCB423BA; Mon, 3 Apr 2023 09:34:02 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=asahilina.net; s=default; t=1680514445; bh=SDM5ek/CE6FiKqreYBHfMz3sZGIrU/VxZUpt63EoDg4=; h=From:Date:Subject:References:In-Reply-To:To:Cc; b=LmOYmscjE3LwgLD9P9o4Ci8hz4+jSYPZvRUlSSUpCYBmsCQCqPNounJCXWtPyd3Dc XoW9EgpI5XYSLM8a5gJlnfmYOGj2DYah5413Ob113FUniByPvTfA3GacsYCOnGqmV2 E+byz0Y0cL6xq6/M7DHJ5exwj5NmWv1gRXTL4J8x6nnOIQdH9QUJgthWPZ6hNgPjxu w+Q+uSfS12tTSgMTjtHkZkc3xvSFycNcC+lb+WoIO16mnQKr2rcWf8t5nIf3WhDTgA zmUwWUoX7ahUQp/sIvR8q3pkFv7G0JAi97dUc0s4Dx9Gh6eB2OMyb8W7VT9A6377OP WK9v6fwhcVoHg== From: Asahi Lina Date: Mon, 03 Apr 2023 18:33:53 +0900 Subject: [PATCH v2 2/2] rust: ioctl: Add ioctl number manipulation functions MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Message-Id: <20230329-rust-uapi-v2-2-bca5fb4d4a12@asahilina.net> References: <20230329-rust-uapi-v2-0-bca5fb4d4a12@asahilina.net> In-Reply-To: <20230329-rust-uapi-v2-0-bca5fb4d4a12@asahilina.net> To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Arnd Bergmann Cc: Martin Rodriguez Reboredo , linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org, asahi@lists.linux.dev, Asahi Lina X-Mailer: b4 0.12.0 X-Developer-Signature: v=1; a=ed25519-sha256; t=1680514434; l=3343; i=lina@asahilina.net; s=20230221; h=from:subject:message-id; bh=SDM5ek/CE6FiKqreYBHfMz3sZGIrU/VxZUpt63EoDg4=; b=LHDkVMUjIhnbPwKIIJMWnc8W7YRkmeOb6N304PCQzDppQzdlX/TcgenWDUJDtfPsp/sGbVj48 cpNbG13R5njA1zH3eTmFV8FL4Uv0D/p2BKjs2k2w2uQJ+7d9J4S8GOm X-Developer-Key: i=lina@asahilina.net; a=ed25519; pk=Qn8jZuOtR1m5GaiDfTrAoQ4NE1XoYVZ/wmt5YtXWFC4= Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Add simple 1:1 wrappers of the C ioctl number manipulation functions. Since these are macros we cannot bindgen them directly, and since they should be usable in const context we cannot use helper wrappers, so we'll have to reimplement them in Rust. Thankfully, the C headers do declare defines for the relevant bitfield positions, so we don't need to duplicate that. Signed-off-by: Asahi Lina --- rust/kernel/ioctl.rs | 71 ++++++++++++++++++++++++++++++++++++++++++++++++= ++++ rust/kernel/lib.rs | 1 + 2 files changed, 72 insertions(+) diff --git a/rust/kernel/ioctl.rs b/rust/kernel/ioctl.rs new file mode 100644 index 000000000000..007437959395 --- /dev/null +++ b/rust/kernel/ioctl.rs @@ -0,0 +1,71 @@ +// SPDX-License-Identifier: GPL-2.0 +#![allow(non_snake_case)] + +//! ioctl() number definitions +//! +//! C header: [`include/asm-generic/ioctl.h`](../../../../include/asm-gene= ric/ioctl.h) + +use crate::build_assert; + +/// Build an ioctl number, analogous to the C macro of the same name. +#[inline(always)] +const fn _IOC(dir: u32, ty: u32, nr: u32, size: usize) -> u32 { + build_assert!(dir <=3D uapi::_IOC_DIRMASK); + build_assert!(ty <=3D uapi::_IOC_TYPEMASK); + build_assert!(nr <=3D uapi::_IOC_NRMASK); + build_assert!(size <=3D (uapi::_IOC_SIZEMASK as usize)); + + (dir << uapi::_IOC_DIRSHIFT) + | (ty << uapi::_IOC_TYPESHIFT) + | (nr << uapi::_IOC_NRSHIFT) + | ((size as u32) << uapi::_IOC_SIZESHIFT) +} + +/// Build an ioctl number for an argumentless ioctl. +#[inline(always)] +pub const fn _IO(ty: u32, nr: u32) -> u32 { + _IOC(uapi::_IOC_NONE, ty, nr, 0) +} + +/// Build an ioctl number for an read-only ioctl. +#[inline(always)] +pub const fn _IOR(ty: u32, nr: u32) -> u32 { + _IOC(uapi::_IOC_READ, ty, nr, core::mem::size_of::()) +} + +/// Build an ioctl number for an write-only ioctl. +#[inline(always)] +pub const fn _IOW(ty: u32, nr: u32) -> u32 { + _IOC(uapi::_IOC_WRITE, ty, nr, core::mem::size_of::()) +} + +/// Build an ioctl number for a read-write ioctl. +#[inline(always)] +pub const fn _IOWR(ty: u32, nr: u32) -> u32 { + _IOC( + uapi::_IOC_READ | uapi::_IOC_WRITE, + ty, + nr, + core::mem::size_of::(), + ) +} + +/// Get the ioctl direction from an ioctl number. +pub const fn _IOC_DIR(nr: u32) -> u32 { + (nr >> uapi::_IOC_DIRSHIFT) & uapi::_IOC_DIRMASK +} + +/// Get the ioctl type from an ioctl number. +pub const fn _IOC_TYPE(nr: u32) -> u32 { + (nr >> uapi::_IOC_TYPESHIFT) & uapi::_IOC_TYPEMASK +} + +/// Get the ioctl number from an ioctl number. +pub const fn _IOC_NR(nr: u32) -> u32 { + (nr >> uapi::_IOC_NRSHIFT) & uapi::_IOC_NRMASK +} + +/// Get the ioctl size from an ioctl number. +pub const fn _IOC_SIZE(nr: u32) -> usize { + ((nr >> uapi::_IOC_SIZESHIFT) & uapi::_IOC_SIZEMASK) as usize +} diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index afec0792d982..63f796781b7c 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -30,6 +30,7 @@ compile_error!("Missing kernel configuration for conditio= nal compilation"); mod allocator; mod build_assert; pub mod error; +pub mod ioctl; pub mod prelude; pub mod print; mod static_assert; --=20 2.40.0