From patchwork Wed Mar 29 11:40:18 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Asahi Lina X-Patchwork-Id: 76534 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp351940vqo; Wed, 29 Mar 2023 04:54:51 -0700 (PDT) X-Google-Smtp-Source: AKy350aPnkucE12zhQ99JaiwtrJ2WKKM0ZFZ2Qz+0FoHfQb4jL+7B2VA1RZwa07tKCbr8XJTMrXp X-Received: by 2002:a62:29c4:0:b0:627:fc3b:4ca9 with SMTP id p187-20020a6229c4000000b00627fc3b4ca9mr2042451pfp.0.1680090891170; Wed, 29 Mar 2023 04:54:51 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1680090891; cv=none; d=google.com; s=arc-20160816; b=L7e543nAT03go5nJ1Pd+BfV2cYBrA/cEf0I7r6L8QKb6QL5QXlYwMdv9t12gxh/CaA TJm0OFwB0LKpB2XnPjwloKRu3m5CU8JIcElYSPe881a6XG0n95QjsceF2IlbGM2R0lV2 iB3zR7qjPLiHrj/RlaV7itT4VDUCNAXlzK8/rlpjNAGrm/ToBX5AhnedbU/ofBq0DiVy W7BLvpEZvSmssnOGRDiNqgI4Z9AS6YdH4hRe2XPUFa2iaG8pRAHdmzIaxwNSfwvm0rcy e2oF8/UplH7MGLn+9lf5WGRdtPXsKpRpm3VM+7V1u9jqt9oE/Pj228vNUjMI4XG4wtjt kwnw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:cc:to:in-reply-to:references:message-id :content-transfer-encoding:mime-version:subject:date:from :dkim-signature; bh=kFyJHT5gMSZ+xj9KqDpvms6psBYqiaJ0yCCCvViCqMc=; b=UufIlQh860ImRAMAYw6dCt1luEnwZA68KpCRwMui9EjGuPtu8ZPKfK/WG58we36P/O EabhULvGTulkNHLKNnWT4maWA10if5Afl3Z7QUFBDIgJVXy+r57lMo6+8e7VmRZAbacI nJBR5GQNDNrPOcKmRnCbMoWJI4Pp46Hd3SEb0aSSr2JKhSfBIHf3rmS9kS+MxBJk/tju Iljr+yZxfEZ8Ltc3jmeaZIx7fX9RTgmPxQtsd85+WGeihzPyog/Ao2Yfk+bCuR0ASCAJ w4mV1/XxPzf7UQ4aIv2OPgfnRydWg+EQOMqcyo6EwS0tDQKUVgSP+mmNrjl+O3J7qdIb utLQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@asahilina.net header.s=default header.b=laM3guzY; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=asahilina.net Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id w204-20020a627bd5000000b0062ae6345c6fsi12016505pfc.394.2023.03.29.04.54.39; Wed, 29 Mar 2023 04:54:51 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@asahilina.net header.s=default header.b=laM3guzY; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=asahilina.net Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229900AbjC2Lks (ORCPT + 99 others); Wed, 29 Mar 2023 07:40:48 -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 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= X-Spam-Status: No, score=-0.2 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1761702986227140664?= X-GMAIL-MSGID: =?utf-8?q?1761702986227140664?= 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 @@ 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) += alloc.o bindings.o kernel.o always-$(CONFIG_RUST) += exports_alloc_generated.h exports_bindings_generated.h \ exports_kernel_generated.h +always-$(CONFIG_RUST) += uapi/uapi_generated.rs +obj-$(CONFIG_RUST) += uapi.o + ifdef CONFIG_RUST_BUILD_ASSERT_ALLOW obj-$(CONFIG_RUST) += 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) +$(obj)/uapi/uapi_generated.rs: private bindgen_target_flags = \ + $(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 warn # 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) +$(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 = --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) 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; #[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