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;
Date:   Mon, 8 May 2023 12:47:01 +0100
From:   Gary Guo <gary@garyguo.net>
To:     Alice Ryhl <aliceryhl@google.com>
Cc:     Miguel Ojeda <ojeda@kernel.org>,
        Wedson Almeida Filho <wedsonaf@gmail.com>,
        Alex Gaynor <alex.gaynor@gmail.com>,
        Boqun Feng <boqun.feng@gmail.com>,
        "=?UTF-8?B?QmrDtnJu?= Roy Baron" <bjorn3_gh@protonmail.com>,
        Benno Lossin <benno.lossin@proton.me>,
        rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
        patches@lists.linux.dev
Subject: Re: [PATCH v2] rust: error: add missing error codes
Message-ID: <20230508124701.443ba331.gary@garyguo.net>
In-Reply-To: <20230504064854.774820-1-aliceryhl@google.com>
References: <20230504064854.774820-1-aliceryhl@google.com>
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?PDi5xTJFu1uLCSUNVgmKyz/zW1wqBcb0BUz9wkmK5AXGG1/6aCTbnp3aWQl+?=
 =?us-ascii?Q?TRz17YqaUIvn9UEu22kJh506V+Ld4m7zVCgpaYPTGX55dEt7UA4r2RWuCqVn?=
 =?us-ascii?Q?50G4/lF8bj5Dhqw53y6Ufg7nd1IQIPQixlxcgCN0JQ9P54CXxdxySDnTXOeG?=
 =?us-ascii?Q?mWUMIUUVHVi6XouGfpDmBZ0dsOJFdnQYB8x4RxNxEoM4wt0inHzhYy0hJhCt?=
 =?us-ascii?Q?QFZxPBXIzVdQDMG6YXWORPQZ7posBAO1f1HeGl7ms9jwhYyOvJdXqxvsCxIz?=
 =?us-ascii?Q?nwv/SMjYDpyTQzVY+weolgvjZ/Jjs4PVoTC7DTGeO3hH5Il56E879jt84QD8?=
 =?us-ascii?Q?AE8bbID/DkJZPiQBOa7km/WcDmfrUtIXx0JFN8WDhObXg/LR0kfW5XKUEXM0?=
 =?us-ascii?Q?LAA6833UU5XgIW4U2Xcie7dCOaRJluxCF8QkVH1DzAb0eoc2CJzx6nwLIGhI?=
 =?us-ascii?Q?eF+BY8orNHXWePNsrw8OWu3RSSgqubXi0WuAejZ1bSKhEFAH008OAm/IH7Vf?=
 =?us-ascii?Q?Z/yPqAf98IvuMD9OVq7VALpslT8nRADd0fvQur3Tc3BPWRDf8w1t97fyYeBZ?=
 =?us-ascii?Q?ARxDLPtMrB3djTa5JGp3ZpEpzrA+6/kY628We6qwwAfdBbdOgzgqOP7BepIk?=
 =?us-ascii?Q?lt0+7f1OkGdqltDtWRIhO4W+wsGrQklg5CV3LFlhYJkxADifmG3DIgQAo0e4?=
 =?us-ascii?Q?N6YEjsglbsNF5mNjn1KZ4F5Y8r/PRAtr56Hor5GLPxSY/mt1u9B6SbxCP0fZ?=
 =?us-ascii?Q?yi/5jhkDttQTK9kuH/HvloYHLbGI/WqkBRFHb2t8VdGNntSJY/UoxjPOzGqi?=
 =?us-ascii?Q?Tn6DPuZqVqNVnFPuscn+QNEKrSpLPt66BzWepMWvjSTbxqK+7LAAjN3gqAxb?=
 =?us-ascii?Q?pK+LH7CWdTpyZ5khdjqV2moWwEbsdlA3zAwDZEYhwZU1p4a8cKX7smp5w5o1?=
 =?us-ascii?Q?OhzHITmoOILYjSFuILXjhAiapQ7Jn2g6vm35CJlfNKi/aOL8J6yJuwFHU5/k?=
 =?us-ascii?Q?Fo7AdbIeApgIMLbB/ffSAHNJt4AoO8A7ZCjYJN/PGZdZqo2rSOcIHpANonC4?=
 =?us-ascii?Q?1wgecbFeHENAj24H2A48niDQWlncdrXgN82VOhm951zb058eSAzfe2ab3yQ5?=
 =?us-ascii?Q?0VCo+sYCx7GvCWF8QTqKo0o5a3gVFw1rVpG1NvELNnz0KalbEGP7AXxEBomG?=
 =?us-ascii?Q?3L2HD5QbtAdOREOu82RwpWkaNwTO6tW1b/D6ohmiIIexBy9rVps7WWE1NglA?=
 =?us-ascii?Q?ykCOfZSMs4tIKAJtTOVZfVSmVU9h7aanSzBTGFWODpqo56abCMmGJdfwEuQz?=
 =?us-ascii?Q?JAzBsV+p2F4CtM5MvM77DVFt/KDEOrexgzjGBlf5VeoyvhtuXFI+6sl7k0Pd?=
 =?us-ascii?Q?WfarDukKg1KMilJxVanQQ3O7kF+K60C7hmr9kxsuz6F55BkW2+/VNKi7sMuI?=
 =?us-ascii?Q?uKzTSbQfpJxRqJ2zlrIpGzJfzkGmYmGsh4FS8viU0ByrOUZdkB+1bsR4ElRw?=
 =?us-ascii?Q?weC46k02E4cX4fmetmiMMgZRCWU7FBlv4lco4VOo9YbqkyPU1LKWSgOIWIku?=
 =?us-ascii?Q?huNBsayyuGQxFji81OJsh5FK7qzvO6x6wt5gFP+P?=
X-OriginatorOrg: garyguo.net
X-MS-Exchange-CrossTenant-Network-Message-Id: d501ed7b-c641-496a-52ad-08db4fb9f0e0
X-MS-Exchange-CrossTenant-AuthSource: LO2P265MB5183.GBRP265.PROD.OUTLOOK.COM
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 08 May 2023 11:47:03.3104
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: bbc898ad-b10f-4e10-8552-d9377b823d45
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: O+0YtEdC9a+tzKpns0gq82H1TZAs73p3VjNlMa0Kwwby7blBtAvRegHlNKv+ULnwAKf/PFRSIoC+m9g7WAKK5w==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: LO0P265MB6996
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS,T_SCC_BODY_TEXT_LINE
        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: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Thu,  4 May 2023 06:48:54 +0000
Alice Ryhl <aliceryhl@google.com> wrote:

> This adds the error codes from `include/linux/errno.h` to the list of
> Rust error constants. These errors were not included originally, because
> they are not supposed to be visible from userspace. However, they are
> still a perfectly valid error to use when writing a kernel driver. For
> example, you might want to return ERESTARTSYS if you receive a signal
> during a call to `schedule`.

`include/linux/errno.h` also includes all of `asm/errno.h`,
which defines EDEADLK - EHWPOISON, which is not included in this patch.
I feel like these error codes should be added first?

> 
> This patch inserts an annotation to skip rustfmt on the list of error
> codes. Without it, three of the error codes are split over several
> lines, which looks terribly inconsistent.
> 
> Signed-off-by: Alice Ryhl <aliceryhl@google.com>
> ---
>  rust/kernel/error.rs | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
> 
> diff --git a/rust/kernel/error.rs b/rust/kernel/error.rs
> index 5f4114b30b94..de4fa8640f29 100644
> --- a/rust/kernel/error.rs
> +++ b/rust/kernel/error.rs
> @@ -14,6 +14,7 @@ use core::num::TryFromIntError;
>  use core::str::Utf8Error;
>  
>  /// Contains the C-compatible error codes.
> +#[rustfmt::skip]
>  pub mod code {
>      macro_rules! declare_err {
>          ($err:tt $(,)? $($doc:expr),+) => {
> @@ -58,6 +59,25 @@ pub mod code {
>      declare_err!(EPIPE, "Broken pipe.");
>      declare_err!(EDOM, "Math argument out of domain of func.");
>      declare_err!(ERANGE, "Math result not representable.");
> +    declare_err!(ERESTARTSYS, "Restart the system call.");
> +    declare_err!(ERESTARTNOINTR, "System call was interrupted by a signal and will be restarted.");
> +    declare_err!(ERESTARTNOHAND, "Restart if no handler.");
> +    declare_err!(ENOIOCTLCMD, "No ioctl command.");
> +    declare_err!(ERESTART_RESTARTBLOCK, "Restart by calling sys_restart_syscall.");
> +    declare_err!(EPROBE_DEFER, "Driver requests probe retry.");
> +    declare_err!(EOPENSTALE, "Open found a stale dentry.");
> +    declare_err!(ENOPARAM, "Parameter not supported.");
> +    declare_err!(EBADHANDLE, "Illegal NFS file handle.");
> +    declare_err!(ENOTSYNC, "Update synchronization mismatch.");
> +    declare_err!(EBADCOOKIE, "Cookie is stale.");
> +    declare_err!(ENOTSUPP, "Operation is not supported.");
> +    declare_err!(ETOOSMALL, "Buffer or request is too small.");
> +    declare_err!(ESERVERFAULT, "An untranslatable error occurred.");
> +    declare_err!(EBADTYPE, "Type not supported by server.");
> +    declare_err!(EJUKEBOX, "Request initiated, but will not complete before timeout.");
> +    declare_err!(EIOCBQUEUED, "iocb queued, will get completion event.");
> +    declare_err!(ERECALLCONFLICT, "Conflict with recalled state.");
> +    declare_err!(ENOGRACE, "NFS file lock reclaim refused.");
>  }
>  
>  /// Generic integer kernel error.
> 
> base-commit: ea76e08f4d901a450619831a255e9e0a4c0ed162