From nobody Mon Feb 9 15:10:06 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 EA087C77B60 for ; Wed, 29 Mar 2023 11:40:50 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229896AbjC2Lkt (ORCPT ); Wed, 29 Mar 2023 07:40:49 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41634 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229675AbjC2Lkp (ORCPT ); Wed, 29 Mar 2023 07:40:45 -0400 Received: from mail.marcansoft.com (marcansoft.com [212.63.210.85]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2F1D410F; Wed, 29 Mar 2023 04:40:44 -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 44AE54249C; Wed, 29 Mar 2023 11:40:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=asahilina.net; s=default; t=1680090042; bh=op/MvH8FI1eaZn0mWBwxw30yZPebXAjGRe5pwINXIX8=; h=From:Date:Subject:References:In-Reply-To:To:Cc; b=laM3guzYqlofOX5ArDj2VyS20jgM0Qpgg/W59vG5AGtywZDLVZjOCijiR2coy9inm c14QXgDrgQkrL1BNEeRbNdKAEJHOyawQD4EM+712HlfHYAt2r9JB47S0bI9FQiyuDf KGMdf5EFwOLL3lJeZXqyCxxsSMedkIviJSQvObVeSQ7YVIkfxTdpVG4naOv7nSxz/U qwS7Oz2/phkSCUNAvZS4Qn5xtIqeLdxehwj/md1KOqmC8JiQEk8p+LfHxYZrJS589U 7aq/+bq0Gif9tem6BiEnD2OmGuU559GWWEkhvJ0lW3ptGATcpZYCX748wH1tURj1xE 0cWgbRYWAxGIQ== From: Asahi Lina Date: Wed, 29 Mar 2023 20:40:18 +0900 Subject: [PATCH 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-v1-1-ee78f2933726@asahilina.net> References: <20230329-rust-uapi-v1-0-ee78f2933726@asahilina.net> In-Reply-To: <20230329-rust-uapi-v1-0-ee78f2933726@asahilina.net> To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= Cc: 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=1680090036; l=4678; i=lina@asahilina.net; s=20230221; h=from:subject:message-id; bh=op/MvH8FI1eaZn0mWBwxw30yZPebXAjGRe5pwINXIX8=; b=+TFoSsDQaePj1U3bW/UnEdo6ELlQoPqtT4aoKzc4FE4Sn8CAhFJAAs/MrR/8IxUzOVBI0JkmP WVdnwWnUzeYCzwUdeiSYgcwi+MkNxI7yyaDHKE9fEAiG1/eZH87fDSy 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"). Signed-off-by: Asahi Lina Reviewed-by: Martin Rodriguez Reboredo --- 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..59a327f0fa1a 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 7610b18ee642..63f796781b7c 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -43,6 +43,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 15:10:06 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 7F51CC6FD18 for ; Wed, 29 Mar 2023 11:40:54 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229649AbjC2Lkw (ORCPT ); Wed, 29 Mar 2023 07:40:52 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:41716 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229898AbjC2Lks (ORCPT ); Wed, 29 Mar 2023 07:40:48 -0400 Received: from mail.marcansoft.com (marcansoft.com [212.63.210.85]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 45F3A449A; Wed, 29 Mar 2023 04:40:47 -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 558A7424A5; Wed, 29 Mar 2023 11:40:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=asahilina.net; s=default; t=1680090045; bh=36jyt17+gpMhtBUVGOnMVEqQehMLVw5t+BF+sC4kAO8=; h=From:Date:Subject:References:In-Reply-To:To:Cc; b=KPAnbJo8Tq/Bj92pG1Isa8rQKjE9Iqk0vQqsUPpIhachljQJImGeJzRfySV62vase 0FbEB2LyLTN98m/ukAUNt/bmQecQ7++tp37YQaaQF303uaoBuFpkJRtFcMDQHJiBJi n1HGe+HyBRLZcl2sGo/y23Gd1//ncThaGaatsLA9mALLs9y/4NQyEkGM6KWDZ0uOLX UTj0Fr1LmeP+2LykGDPYF6RKF7A6LwV0JxJSnD5WZaQ+JKcgwkr+Mno1I5XSk5LMGZ EbtfHMdG+vXhu2Le+VmQOoity6dhyDT0bfI3CaU+dBLCoPP0yUN4SOKDVdyyO1GHmv Mqj8+KNQnK1ZA== From: Asahi Lina Date: Wed, 29 Mar 2023 20:40:19 +0900 Subject: [PATCH 2/2] rust: ioctl: Move to the uapi crate MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Message-Id: <20230329-rust-uapi-v1-2-ee78f2933726@asahilina.net> References: <20230329-rust-uapi-v1-0-ee78f2933726@asahilina.net> In-Reply-To: <20230329-rust-uapi-v1-0-ee78f2933726@asahilina.net> To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= Cc: 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=1680090036; l=3405; i=lina@asahilina.net; s=20230221; h=from:subject:message-id; bh=36jyt17+gpMhtBUVGOnMVEqQehMLVw5t+BF+sC4kAO8=; b=nfZZd5UugBCJimQIF7tuA5PmeTswIM2a3l93eYTyrBNnpczR4cUCJ2lZUU/rtF2f2DzVoYUUd 5PcEeiYQVXfBCBwFrOxAsN2Ylw9JJ8m0Y1YLNgb8qasKBPd5/8YlbmV X-Developer-Key: i=lina@asahilina.net; a=ed25519; pk=Qn8jZuOtR1m5GaiDfTrAoQ4NE1XoYVZ/wmt5YtXWFC4= Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Now that we have the uapi crate, this abstraction can use that instead of bindings. Signed-off-by: Asahi Lina Reviewed-by: Martin Rodriguez Reboredo --- rust/kernel/ioctl.rs | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/rust/kernel/ioctl.rs b/rust/kernel/ioctl.rs index b2076113b6a8..007437959395 100644 --- a/rust/kernel/ioctl.rs +++ b/rust/kernel/ioctl.rs @@ -10,40 +10,40 @@ 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 bindings::_IOC_DIRMASK); - build_assert!(ty <=3D bindings::_IOC_TYPEMASK); - build_assert!(nr <=3D bindings::_IOC_NRMASK); - build_assert!(size <=3D (bindings::_IOC_SIZEMASK as usize)); + 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)); =20 - (dir << bindings::_IOC_DIRSHIFT) - | (ty << bindings::_IOC_TYPESHIFT) - | (nr << bindings::_IOC_NRSHIFT) - | ((size as u32) << bindings::_IOC_SIZESHIFT) + (dir << uapi::_IOC_DIRSHIFT) + | (ty << uapi::_IOC_TYPESHIFT) + | (nr << uapi::_IOC_NRSHIFT) + | ((size as u32) << uapi::_IOC_SIZESHIFT) } =20 /// Build an ioctl number for an argumentless ioctl. #[inline(always)] pub const fn _IO(ty: u32, nr: u32) -> u32 { - _IOC(bindings::_IOC_NONE, ty, nr, 0) + _IOC(uapi::_IOC_NONE, ty, nr, 0) } =20 /// Build an ioctl number for an read-only ioctl. #[inline(always)] pub const fn _IOR(ty: u32, nr: u32) -> u32 { - _IOC(bindings::_IOC_READ, ty, nr, core::mem::size_of::()) + _IOC(uapi::_IOC_READ, ty, nr, core::mem::size_of::()) } =20 /// Build an ioctl number for an write-only ioctl. #[inline(always)] pub const fn _IOW(ty: u32, nr: u32) -> u32 { - _IOC(bindings::_IOC_WRITE, ty, nr, core::mem::size_of::()) + _IOC(uapi::_IOC_WRITE, ty, nr, core::mem::size_of::()) } =20 /// Build an ioctl number for a read-write ioctl. #[inline(always)] pub const fn _IOWR(ty: u32, nr: u32) -> u32 { _IOC( - bindings::_IOC_READ | bindings::_IOC_WRITE, + uapi::_IOC_READ | uapi::_IOC_WRITE, ty, nr, core::mem::size_of::(), @@ -52,20 +52,20 @@ pub const fn _IOWR(ty: u32, nr: u32) -> u32 { =20 /// Get the ioctl direction from an ioctl number. pub const fn _IOC_DIR(nr: u32) -> u32 { - (nr >> bindings::_IOC_DIRSHIFT) & bindings::_IOC_DIRMASK + (nr >> uapi::_IOC_DIRSHIFT) & uapi::_IOC_DIRMASK } =20 /// Get the ioctl type from an ioctl number. pub const fn _IOC_TYPE(nr: u32) -> u32 { - (nr >> bindings::_IOC_TYPESHIFT) & bindings::_IOC_TYPEMASK + (nr >> uapi::_IOC_TYPESHIFT) & uapi::_IOC_TYPEMASK } =20 /// Get the ioctl number from an ioctl number. pub const fn _IOC_NR(nr: u32) -> u32 { - (nr >> bindings::_IOC_NRSHIFT) & bindings::_IOC_NRMASK + (nr >> uapi::_IOC_NRSHIFT) & uapi::_IOC_NRMASK } =20 /// Get the ioctl size from an ioctl number. pub const fn _IOC_SIZE(nr: u32) -> usize { - ((nr >> bindings::_IOC_SIZESHIFT) & bindings::_IOC_SIZEMASK) as usize + ((nr >> uapi::_IOC_SIZESHIFT) & uapi::_IOC_SIZEMASK) as usize } --=20 2.40.0