From patchwork Fri Feb 24 07:36:42 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Asahi Lina X-Patchwork-Id: 61178 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:5915:0:0:0:0:0 with SMTP id v21csp765516wrd; Thu, 23 Feb 2023 23:58:25 -0800 (PST) X-Google-Smtp-Source: AK7set8pylFB2/JMKQKSq/m8xECkniyrPPHWveNmTNr0p97d6yS/52UCfC76i5b5KOJy0PMd+vSK X-Received: by 2002:a05:6a20:3d18:b0:bd:17a4:c35f with SMTP id y24-20020a056a203d1800b000bd17a4c35fmr17544142pzi.23.1677225505525; Thu, 23 Feb 2023 23:58:25 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1677225505; cv=none; d=google.com; s=arc-20160816; b=0/J/eWDXYWBVQ3hckcC2nu/sW0S5GGcQP5I1JLel0wnWEddeIOjS2Y3WSYabS5NQky 4ySq+WyqKZwKOcOwpaYHeDb2Gcb0y9Aphb60AO85YM97V33hbqq7V5QN3M11QQRXIs84 jEfxOi52EMpCY6tBXYRf+CIIeI9vGWWFWOr6R8lACJV2A4jLNiI6HtiGPgclO/mLBaiD nBxZJzjzivDoREQqYS8LbQUnqaD4e9UFdXTeWlQUWCdzZNZK1HG+ufwwf4+l96BW7a+R s+9aDlvmpChOm4MAaraCmVwJURPtOoQKzSbB5jyJu7UV/ouOjSpCsscEKTTKJX0NL4Me CzOQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:cc:to:message-id:content-transfer-encoding :mime-version:subject:date:from:dkim-signature; bh=pbjpbJP6KlupgnmHV/hIM286DWHchH7dkGadEnI7OQo=; b=eVpf3J5l6jA4MH376tmE90Efex1C8pEI+FL56i+X5rXSk4tPguY+ELWa2YfhIakBZo mDbH/fc+WtzNZr8ek3v8hDixfz2y0UHiMCzjuGyq2wR0+J8aUAEoR5eQDlOONfwOcJ/D tSkCR+YajbEJRMNTUDaS4gxwVzeGZqM6W0uw7SJh9QE++PsUiyH1aBp2SQj/eE1OpuFT OS46Fzyq6cW7VGezL0uAULIb6MBLNYxOvWGhO03D0NugSdpmvGIGPZlt9ZEglceEYmgF ZGQRcMwCkfAQesDoXlUvhwRqwmpMCKHhQI5t7Ng3GeWvFmLuyFkfJk7+3T/3j4/Z/KFz pQEA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@asahilina.net header.s=default header.b=drjwKx3R; 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 x35-20020a056a000be300b0058db4725798si13632729pfu.160.2023.02.23.23.58.13; Thu, 23 Feb 2023 23:58:25 -0800 (PST) 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=drjwKx3R; 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 S229618AbjBXHjD (ORCPT + 99 others); Fri, 24 Feb 2023 02:39:03 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:58876 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229491AbjBXHjB (ORCPT ); Fri, 24 Feb 2023 02:39:01 -0500 Received: from mail.marcansoft.com (marcansoft.com [212.63.210.85]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E0C6A41B4D; Thu, 23 Feb 2023 23:38:23 -0800 (PST) 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 032ED4248B; Fri, 24 Feb 2023 07:36:51 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=asahilina.net; s=default; t=1677224215; bh=ftldOtsJAJMVwxmGhAw4Tv8zQ8GizSKOo29lCYZdWFw=; h=From:Date:Subject:To:Cc; b=drjwKx3RRPHd19TUf2L1KqJDkXjkcmyQ2GRSY6Ui8dR/CfJ+Sw6D0JqyPjm2AQZbt tFzoC/B7PjT5+wweNJHdIqXYCVAwM/ZWa+tsZReQyZ5fxgJwnLJ7OLxazMBqE2BLxu y/TZmrv1iHCwA7Jn6yr3eGeedTfhYUt5lo7p21DIqmp/3WnDG0FDTxJnaCb0bGSb1s KNMc+40Yt0WtjaZ48onP3+vBR2ZS8rWwU7RzkPwnS+92zRfuACznHlN0w8bN7tks16 2eAQUNBqMOxW9WEcq6DeGjdbhRdRmEEG0BEeoxOPWsrUqqxOPeMJUA9yWqtPHHmRoB cBlmCEAp2nnIA== From: Asahi Lina Date: Fri, 24 Feb 2023 16:36:42 +0900 Subject: [PATCH] rust: ioctl: Add ioctl number manipulation functions MIME-Version: 1.0 Message-Id: <20230224-rust-ioctl-v1-1-5142d365a934@asahilina.net> X-B4-Tracking: v=1; b=H4sIAAlp+GMC/x2NwQrCQAxEf6XkbHDNKoi/Ih6ya9oGZFuSVoTSf 3e3xzczj9nAxVQcHt0GJl91nUqFy6mDPHIZBPVdGShQDERXtNUX1CkvH+QbhT5Kisx3qEJiF0z GJY9NGeb1fKxb3vrZpNffcfZ87fsfDKl8yHwAAAA= To: Miguel Ojeda , Alex Gaynor , Wedson Almeida Filho , Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Arnd Bergmann Cc: linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org, asahi@lists.linux.dev, linux-arch@vger.kernel.org, Asahi Lina X-Mailer: b4 0.12.0 X-Developer-Signature: v=1; a=ed25519-sha256; t=1677224211; l=3944; i=lina@asahilina.net; s=20230221; h=from:subject:message-id; bh=ftldOtsJAJMVwxmGhAw4Tv8zQ8GizSKOo29lCYZdWFw=; b=UY88w5bi8StsTR72L84kydfChihsTIsd1ljE84ofuZgXcNUupsV6puBS6LpRaX5W7GYsjNZL7 JWpEx6b0TwJBHTDCcjpBs0HRith3EWOhm6d65lU7lhrI8c5SvAON3Hy X-Developer-Key: i=lina@asahilina.net; a=ed25519; pk=Qn8jZuOtR1m5GaiDfTrAoQ4NE1XoYVZ/wmt5YtXWFC4= X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS autolearn=ham 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?1758698411713750748?= X-GMAIL-MSGID: =?utf-8?q?1758698411713750748?= 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/bindings/bindings_helper.h | 3 +- rust/kernel/ioctl.rs | 64 +++++++++++++++++++++++++++++++++++++++++ rust/kernel/lib.rs | 1 + 3 files changed, 67 insertions(+), 1 deletion(-) --- base-commit: 83f978b63fa7ad474ca22d7e2772c5988101c9bd change-id: 20230224-rust-ioctl-a520f3eb3aa8 Thank you, ~~ Lina diff --git a/rust/bindings/bindings_helper.h b/rust/bindings/bindings_helper.h index 75d85bd6c592..aef60f300be0 100644 --- a/rust/bindings/bindings_helper.h +++ b/rust/bindings/bindings_helper.h @@ -6,8 +6,9 @@ * Sorted alphabetically. */ -#include +#include #include +#include /* `bindgen` gets confused at certain things. */ const gfp_t BINDINGS_GFP_KERNEL = GFP_KERNEL; diff --git a/rust/kernel/ioctl.rs b/rust/kernel/ioctl.rs new file mode 100644 index 000000000000..6cd8e5738b91 --- /dev/null +++ b/rust/kernel/ioctl.rs @@ -0,0 +1,64 @@ +// SPDX-License-Identifier: GPL-2.0 +#![allow(non_snake_case)] + +//! ioctl() number definitions +//! +//! C header: [`include/asm-generic/ioctl.h`](../../../../include/asm-generic/ioctl.h) + +/// Build an ioctl number, analogous to the C macro of the same name. +const fn _IOC(dir: u32, ty: u32, nr: u32, size: usize) -> u32 { + core::assert!(dir <= bindings::_IOC_DIRMASK); + core::assert!(ty <= bindings::_IOC_TYPEMASK); + core::assert!(nr <= bindings::_IOC_NRMASK); + core::assert!(size <= (bindings::_IOC_SIZEMASK as usize)); + + (dir << bindings::_IOC_DIRSHIFT) + | (ty << bindings::_IOC_TYPESHIFT) + | (nr << bindings::_IOC_NRSHIFT) + | ((size as u32) << bindings::_IOC_SIZESHIFT) +} + +/// Build an ioctl number for an argumentless ioctl. +pub const fn _IO(ty: u32, nr: u32) -> u32 { + _IOC(bindings::_IOC_NONE, ty, nr, 0) +} + +/// Build an ioctl number for an read-only ioctl. +pub const fn _IOR(ty: u32, nr: u32) -> u32 { + _IOC(bindings::_IOC_READ, ty, nr, core::mem::size_of::()) +} + +/// Build an ioctl number for an write-only ioctl. +pub const fn _IOW(ty: u32, nr: u32) -> u32 { + _IOC(bindings::_IOC_WRITE, ty, nr, core::mem::size_of::()) +} + +/// Build an ioctl number for a read-write ioctl. +pub const fn _IOWR(ty: u32, nr: u32) -> u32 { + _IOC( + bindings::_IOC_READ | bindings::_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 >> bindings::_IOC_DIRSHIFT) & bindings::_IOC_DIRMASK +} + +/// Get the ioctl type from an ioctl number. +pub const fn _IOC_TYPE(nr: u32) -> u32 { + (nr >> bindings::_IOC_TYPESHIFT) & bindings::_IOC_TYPEMASK +} + +/// Get the ioctl number from an ioctl number. +pub const fn _IOC_NR(nr: u32) -> u32 { + (nr >> bindings::_IOC_NRSHIFT) & bindings::_IOC_NRMASK +} + +/// 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 +} diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs index 223564f9f0cc..7610b18ee642 100644 --- a/rust/kernel/lib.rs +++ b/rust/kernel/lib.rs @@ -30,6 +30,7 @@ compile_error!("Missing kernel configuration for conditional compilation"); mod allocator; mod build_assert; pub mod error; +pub mod ioctl; pub mod prelude; pub mod print; mod static_assert;