From patchwork Mon Apr 3 09:33:52 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Asahi Lina X-Patchwork-Id: 78441 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp2174130vqo; Mon, 3 Apr 2023 02:40:06 -0700 (PDT) X-Google-Smtp-Source: AKy350biFQCv1FilJtw1iv/nxcewYELsT4xB+EIswZu4qhctHohENdZkz20+4wIxr4m13gu1i4Qy X-Received: by 2002:a17:906:8607:b0:880:a42d:dfb4 with SMTP id o7-20020a170906860700b00880a42ddfb4mr33671214ejx.16.1680514806455; Mon, 03 Apr 2023 02:40:06 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1680514806; cv=none; d=google.com; s=arc-20160816; b=CDSRPG2cAcMixZd/292bIV/vAztCKLpf+3jBdfjThdkpxC6RnXwm/g2Dyijwo1fJ6+ ikMkGJm6/XVHSYsw+I5iLOKGQmc9Eb5AFnNpHRp4kq67RjonHlr9Ou5iig0Wlx2zUtAq puP503qsSSuPjbaeeEyjpi5EkyLdxOsG3L1iObaNy3IjqdTfy/nZXowB51LitEsI0SFV Dx4rTKoE8EUjDt/DV1HBker41LC9iy7l26BkEaCU5I/N03LXSVHsDLbLwtxboPBWgpeP sjWctEIYxq3wqBp2fuu4ANputSDwfrlUH2ouYXOyuZvv269Pvwlvhdt8bmnzgbsUp3jP qodA== 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=xvJN9MX5pwuuFSVKUACNrGRGUxMrA8PaJV97+HWiVSQ=; b=LbPo3uAPG4l/CykL83Tzjo6ONO8YmBHrsKQ5GroBJmMgtDfXfB2n9/4qIi3Xp8nZJU wVuyRyA9UKMD5dwt45glWjVIPU3AP+bfi9ywkUDtFn8bV7qBi8kuX+hm/QYRI2g9MzaB 2orJ5SRFb8jVpg8B1kvrUPtOK88d0J86n1axcgEx5wfEn7ZsuGcC1ixZkveFxB9/F0aw 7l+E99cYupGvo2S6vf+VoGU7RDEhneMlYSVR7mndOpuFbLemP2dhxm1WZoxii0gr89V6 KlTloJzWvAlYXjCfky/h+u4vHVUwFGAb6C+TUyDc6g5Kc0bS36XmuhzT7yMJlx34ByHu LcHg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@asahilina.net header.s=default header.b=JyUb9QqW; 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 d13-20020a1709061f4d00b00933486cd75asi4894624ejk.518.2023.04.03.02.39.43; Mon, 03 Apr 2023 02:40:06 -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=JyUb9QqW; 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 S232220AbjDCJf3 (ORCPT + 99 others); Mon, 3 Apr 2023 05:35:29 -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 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= 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?1762147493872659257?= X-GMAIL-MSGID: =?utf-8?q?1762147493872659257?= 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 @@ 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) += 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 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; #[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