All of lore.kernel.org
 help / color / mirror / Atom feed
From: Miguel Ojeda <ojeda@kernel.org>
To: Linus Torvalds <torvalds@linux-foundation.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
	Miguel Ojeda <ojeda@kernel.org>, Gary Guo <gary@garyguo.net>,
	Alex Gaynor <alex.gaynor@gmail.com>,
	Wedson Almeida Filho <wedsonaf@google.com>
Subject: [PATCH v5 07/20] rust: add `build_error` crate
Date: Thu, 17 Mar 2022 19:09:55 +0100	[thread overview]
Message-ID: <20220317181032.15436-8-ojeda@kernel.org> (raw)
In-Reply-To: <20220317181032.15436-1-ojeda@kernel.org>

From: Gary Guo <gary@garyguo.net>

The `build_error` crate provides the `build_error` function which
is then used to provide the `build_error!` and the `build_assert!`
macros.

`build_assert!` is intended to be used when `static_assert!` cannot
be used, e.g. when the condition refers to generic parameters or
parameters of an inline function.

Co-developed-by: Alex Gaynor <alex.gaynor@gmail.com>
Signed-off-by: Alex Gaynor <alex.gaynor@gmail.com>
Co-developed-by: Wedson Almeida Filho <wedsonaf@google.com>
Signed-off-by: Wedson Almeida Filho <wedsonaf@google.com>
Signed-off-by: Gary Guo <gary@garyguo.net>
Co-developed-by: Miguel Ojeda <ojeda@kernel.org>
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
 rust/build_error.rs | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 rust/build_error.rs

diff --git a/rust/build_error.rs b/rust/build_error.rs
new file mode 100644
index 000000000000..34e589149d3e
--- /dev/null
+++ b/rust/build_error.rs
@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: GPL-2.0
+
+//! Build-time error.
+//!
+//! This crate provides a function `build_error`, which will panic in
+//! compile-time if executed in const context, and will cause a build error
+//! if not executed at compile time and the optimizer does not optimise away the
+//! call.
+//!
+//! It is used by `build_assert!` in the kernel crate, allowing checking of
+//! conditions that could be checked statically, but could not be enforced in
+//! Rust yet (e.g. perform some checks in const functions, but those
+//! functions could still be called in the runtime).
+
+#![no_std]
+
+/// Panics if executed in const context, or triggers a build error if not.
+#[inline(never)]
+#[cold]
+#[no_mangle]
+#[track_caller]
+pub const fn build_error(msg: &'static str) -> ! {
+    panic!("{}", msg);
+}
+
+#[cfg(CONFIG_RUST_BUILD_ASSERT_WARN)]
+#[link_section = ".gnu.warning.build_error"]
+#[used]
+static BUILD_ERROR_WARNING: [u8; 45] = *b"call to build_error present after compilation";
-- 
2.35.1


  parent reply	other threads:[~2022-03-17 18:11 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-17 18:09 [PATCH v5 00/20] Rust support Miguel Ojeda
2022-03-17 18:09 ` Miguel Ojeda
2022-03-17 18:09 ` Miguel Ojeda
2022-03-17 18:09 ` Miguel Ojeda
2022-03-17 18:09 ` [PATCH v5 01/20] kallsyms: support "big" kernel symbols Miguel Ojeda
2022-03-17 18:09 ` [PATCH v5 02/20] kallsyms: increase maximum kernel symbol length to 512 Miguel Ojeda
2022-03-17 18:09 ` [PATCH v5 03/20] kallsyms: use the correct buffer size for symbols Miguel Ojeda
2022-03-17 18:09 ` [PATCH v5 04/20] rust: add C helpers Miguel Ojeda
2022-03-17 18:09 ` [PATCH v5 05/20] rust: add `compiler_builtins` crate Miguel Ojeda
2022-03-17 18:09 ` [PATCH v5 06/20] rust: add `alloc` crate Miguel Ojeda
2022-03-31 12:42   ` Greg Kroah-Hartman
2022-03-31 13:19     ` Miguel Ojeda
2022-03-31 13:35       ` Greg Kroah-Hartman
2022-03-17 18:09 ` Miguel Ojeda [this message]
2022-03-17 18:09 ` [PATCH v5 08/20] rust: add `macros` crate Miguel Ojeda
2022-03-17 18:09 ` [PATCH v5 09/20] rust: add `kernel` crate's `sync` module Miguel Ojeda
2022-03-17 18:09 ` [PATCH v5 10/20] rust: add `kernel` crate Miguel Ojeda
2022-03-17 18:09 ` [PATCH v5 11/20] rust: export generated symbols Miguel Ojeda
2022-03-17 18:10 ` [PATCH v5 12/20] vsprintf: add new `%pA` format specifier Miguel Ojeda
2022-03-18 14:07   ` Andy Shevchenko
2022-03-18 16:04     ` Petr Mladek
2022-03-22  4:16       ` Sergey Senozhatsky
2022-03-17 18:10 ` [PATCH v5 13/20] scripts: add `generate_rust_analyzer.py` Miguel Ojeda
2022-03-17 18:10 ` [PATCH v5 14/20] scripts: decode_stacktrace: demangle Rust symbols Miguel Ojeda
2022-03-17 18:10 ` [PATCH v5 15/20] docs: add Rust documentation Miguel Ojeda
2022-03-17 18:10 ` [PATCH v5 16/20] Kbuild: add Rust support Miguel Ojeda
2022-03-17 18:10   ` Miguel Ojeda
2022-03-17 18:10   ` Miguel Ojeda
2022-03-17 18:10   ` Miguel Ojeda
2022-03-17 18:10 ` [PATCH v5 17/20] samples: add Rust examples Miguel Ojeda
2022-03-17 18:10 ` [PATCH v5 18/20] MAINTAINERS: Rust Miguel Ojeda
2022-03-17 18:10 ` [PATCH v5 19/20] [RFC] drivers: gpio: PrimeCell PL061 in Rust Miguel Ojeda
2022-03-17 18:10 ` [PATCH v5 20/20] [RFC] drivers: android: Binder IPC " Miguel Ojeda

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=20220317181032.15436-8-ojeda@kernel.org \
    --to=ojeda@kernel.org \
    --cc=alex.gaynor@gmail.com \
    --cc=gary@garyguo.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=torvalds@linux-foundation.org \
    --cc=wedsonaf@google.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.