Linux Documentation
 help / color / mirror / Atom feed
From: Dirk Behme <dirk.behme@de.bosch.com>
To: Harish-CS <harish.cs.ss24@gmail.com>,
	Andy Whitcroft <apw@canonical.com>, Joe Perches <joe@perches.com>
Cc: Dwaipayan Ray <dwaipayanray1@gmail.com>,
	Lukas Bulwahn <lukas.bulwahn@gmail.com>,
	Jonathan Corbet <corbet@lwn.net>,
	Shuah Khan <skhan@linuxfoundation.org>,
	Miguel Ojeda <ojeda@kernel.org>, <linux-kernel@vger.kernel.org>,
	<workflows@vger.kernel.org>, <linux-doc@vger.kernel.org>,
	<rust-for-linux@vger.kernel.org>
Subject: Re: [PATCH] checkpatch: warn on Rust unwrap and expect calls
Date: Wed, 8 Jul 2026 07:41:05 +0200	[thread overview]
Message-ID: <db94b1a3-cc1e-47e8-92ee-976400209a43@de.bosch.com> (raw)
In-Reply-To: <20260707082104.90951-1-harish.cs.ss24@gmail.com>

Hi Harish,

On 07.07.2026 10:21, Harish-CS wrote:
> Rust panic paths are discouraged in kernel code because panics currently
> lead to BUG-like behavior. Add a checkpatch warning for newly added Rust
> uses of unwrap(), unwrap_err(), expect() and expect_err() so contributors
> notice them during patch review.

We've had something similar some month ago, already. Maybe you like to 
check that discussion:

https://lore.kernel.org/rust-for-linux/20260707082104.90951-1-harish.cs.ss24@gmail.com/T/#u

If I remember correctly the main concern was how to filter out the 
allowed/required usages. I think the example used that time was

https://lore.kernel.org/rust-for-linux/20260131154016.270385-3-shivamklr@cock.li/

Best regards

Dirk


> Suggested-by: Miguel Ojeda <ojeda@kernel.org>
> Link: https://github.com/Rust-for-Linux/linux/issues/1191
> Signed-off-by: Harish-CS <harish.cs.ss24@gmail.com>
> ---
>   Documentation/dev-tools/checkpatch.rst | 4 ++++
>   scripts/checkpatch.pl                  | 9 +++++++++
>   2 files changed, 13 insertions(+)
> 
> diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
> index 6139a08c34cd..afa9787c1b9f 100644
> --- a/Documentation/dev-tools/checkpatch.rst
> +++ b/Documentation/dev-tools/checkpatch.rst
> @@ -303,6 +303,10 @@ API usage
>   
>       See: https://www.kernel.org/doc/html/latest/process/deprecated.html#bug-and-bug-on
>   
> +  **RUST_PANIC_METHODS**
> +    Rust methods that panic, such as unwrap() and expect(), should be
> +    avoided.  Handle the error explicitly instead.
> +
>     **CONSIDER_KSTRTO**
>       The simple_strtol(), simple_strtoll(), simple_strtoul(), and
>       simple_strtoull() functions explicitly ignore overflows, which
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 2b7a42bbdd94..5bdb065370ea 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -3972,6 +3972,15 @@ sub process {
>   			}
>   		}
>   
> +# avoid Rust panicking methods
> +		if ($realfile =~ /\.rs$/ &&
> +		    $line =~ /^\+.*\.(?:unwrap(?:_err)?|expect(?:_err)?)\s*\(/) {
> +			my $msg_level = \&WARN;
> +			$msg_level = \&CHK if ($file);
> +			&{$msg_level}("RUST_PANIC_METHODS",
> +				      "Avoid Rust panicking methods such as unwrap() and expect(); handle the error instead\n" . $herecurr);
> +		}
> +
>   # check for .L prefix local symbols in .S files
>   		if ($realfile =~ /\.S$/ &&
>   		    $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) {


  reply	other threads:[~2026-07-08  5:41 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-07-07  8:21 [PATCH] checkpatch: warn on Rust unwrap and expect calls Harish-CS
2026-07-08  5:41 ` Dirk Behme [this message]
2026-07-08  5:45   ` Dirk Behme
     [not found]     ` <CAGjpMsQgjBLTMt3PU8FHokCOBWc59YFagSjqcE2ZJSBGixLGOA@mail.gmail.com>
     [not found]       ` <CAGjpMsTvHHbfaGXDTK+pK9j59wpAx1zitfgRDeC1NAnbt2K67A@mail.gmail.com>
2026-07-08 13:02         ` Miguel Ojeda
2026-07-08  9:14 ` FUJITA Tomonori

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=db94b1a3-cc1e-47e8-92ee-976400209a43@de.bosch.com \
    --to=dirk.behme@de.bosch.com \
    --cc=apw@canonical.com \
    --cc=corbet@lwn.net \
    --cc=dwaipayanray1@gmail.com \
    --cc=harish.cs.ss24@gmail.com \
    --cc=joe@perches.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lukas.bulwahn@gmail.com \
    --cc=ojeda@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=skhan@linuxfoundation.org \
    --cc=workflows@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox