Received-SPF: pass (google.com: domain of linux-kernel+bounces-194661-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
From: Gary Guo <gary@garyguo.net>
To: Miguel Ojeda <ojeda@kernel.org>,
	Alex Gaynor <alex.gaynor@gmail.com>,
	Wedson Almeida Filho <wedsonaf@gmail.com>,
	Boqun Feng <boqun.feng@gmail.com>,
	Gary Guo <gary@garyguo.net>,
	=?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= <bjorn3_gh@protonmail.com>,
	Benno Lossin <benno.lossin@proton.me>,
	Andreas Hindborg <a.hindborg@samsung.com>,
	Alice Ryhl <aliceryhl@google.com>
Cc: rust-for-linux@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: [RFC PATCH 1/2] kbuild: rust: auto generate rust helper exports
Date: Wed, 29 May 2024 21:28:14 +0100
Message-ID: <20240529202817.3641974-2-gary@garyguo.net>
In-Reply-To: <20240529202817.3641974-1-gary@garyguo.net>
References: <20240529202817.3641974-1-gary@garyguo.net>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?7Hz9bzkeDNTL1PrvQYlCwjBsHVB7MOtzH8uLMq6kfzOPiHqkafkl9WmH37Yb?=
 =?us-ascii?Q?AXz8RtpjJKeMPkUgSBI9QRTrVquGNAxNDbs0TCffRl1FgQWSQNA73v+N9KcK?=
 =?us-ascii?Q?Xz0GszBIx/tnKTxS3eYzNYTPO2MV8Kk+sjeLplapdqMzh1BH5P3A7EkpHhIp?=
 =?us-ascii?Q?u1OQ45T00mjBzaqJc1yCGj05WlEc3vUamfVnvcWbF7DqZPW1plXaULmrviBu?=
 =?us-ascii?Q?J+TheZ6gyv7jwYF/DJ5VsE2QEdtUk3AEdVG1iBnNiDU3HvTi4kKogz6DNfio?=
 =?us-ascii?Q?qNJqcVdL/P5Y9dJB+ODx0IIXzlJWT/PRp0l87HZZPDsWfyADQZhIV4+5rHO+?=
 =?us-ascii?Q?+JPb5ra95kwznSwtF6V/dAFpHiUT2Yx9cgih/q07iXEPbJ/CWwSJdN+2tC56?=
 =?us-ascii?Q?/WT+gS7zgiDvX5cH7eBvhe/6GWuhHtRyP1rO99oo7+6VkczPdKqa4L6bIWik?=
 =?us-ascii?Q?q0Ov4/OC+ParDmFgNzyaz9jCDtzbYd+wILk0QBb+tJhNW5XSu6R00H++KdCz?=
 =?us-ascii?Q?27EqGZRjLC58r6jVywbDEEbjxYZibAiWYJvcWml7lQr5zBvpHhgb2frobJDC?=
 =?us-ascii?Q?J8/QA9AqNgvJSGfniplpaX66Vh1qy/SjtG+UiSTU9uCbGa7hBQcfm1PgFNw7?=
 =?us-ascii?Q?Gavt54lqrwzkzV0iUA4uL2kqWMAgetbQtT2f/k3/8VrFtodInGDaCVsiFYdr?=
 =?us-ascii?Q?3FAHTpYo2csSQN4XaRj4c6z6XPL1VH717sPFqJaDSUC2t391/jTRwh9xO7OJ?=
 =?us-ascii?Q?Bc/8NY0HzpZbmy96/hA9Rz09p/1AqKGIeIVdl7VMp4M36UGKXds7CwuLX1gb?=
 =?us-ascii?Q?nHGckj0Cfzx1jrdNMhbmLgd/YQebecsUnI3hOn4qezt6j+TJ6R0rOdSaTEdQ?=
 =?us-ascii?Q?tYqZ1UVrM7DtyAZIZUZwImPAmGj2a1xQAHh9gCU3DZoJVAVpT+YeKP+e+GOc?=
 =?us-ascii?Q?N5X8uAyvVRe+DmZ8M5ZqflAr2Zde1WnCnqyokgNjRYeRyoEpQ9O7NOrZ4Asz?=
 =?us-ascii?Q?kfCCTIPF7C68h993P3wGHXZowiGPtFUV3ujtdkXrpu8TXYc0dmqAtZOZNHcE?=
 =?us-ascii?Q?nA5j2MTg+ZypRD/3bhfonXQEhVsgahlPcrhvtvu9CxnaHIbmtoHnRw0DwCUw?=
 =?us-ascii?Q?oEl5BpGqYx5RvcnP8WZgiBGWNdeQkZZLi8DhJoaXciz/7KUvkrUZeuIGfq8f?=
 =?us-ascii?Q?u1nWo/4YLkLPnDeIvauMdCRIv09Uv1gvJjLQ5CqnVCYLI/Y+eoqJLXn7/bPA?=
 =?us-ascii?Q?l6pj+OQcahNaOq6Vt+dfz6iBzsQM31Qur9MzBzqK7Wgi+UmauTKKd5/u80Is?=
 =?us-ascii?Q?e7YAvq/Y3Oag285bnNZYAB45dPmFjVH3GlsGitsSmX+u7+PjsWz3RdF5P8v3?=
 =?us-ascii?Q?FPyFeTNbK5Hn7JCBjAzuQIfIXFjq4pHHk+1pnCsF+mNzO9iyypNGtsYmPBaE?=
 =?us-ascii?Q?rUXXbf79it6MPQlUSpXqVNNb4YqykV0lB9ZWD5+lraXyOk5EjQi3xWi3ginZ?=
 =?us-ascii?Q?Zd4WIKUGJUmd8TLKYoewFl2j5H48+LPqBDio8bJCQMusPu0wm9naELW/QSOR?=
 =?us-ascii?Q?z3hPL0vJ/J9eVa1STbgB8DhwAsJTrtnXMja4FL+0jifgT0bJ7QAL9VaTMPPu?=
 =?us-ascii?Q?OS8HWvHYL0ZF+G3C4tlyTFo7b0t22BDKKpBAxmI6YjVr?=
X-OriginatorOrg: garyguo.net
X-MS-Exchange-CrossTenant-Network-Message-Id: 63e00d28-16dc-4dc4-9267-08dc801e073e
X-MS-Exchange-CrossTenant-AuthSource: LO2P265MB5183.GBRP265.PROD.OUTLOOK.COM
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 29 May 2024 20:29:24.0030
 (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: APNKlsKBEksII8pmXisVlPFRW/wdhBBFwoJJNSeDUS0Kki7ger/qGJ0nOueOr8f/vkg5ytLPMrKHTHL5Z6kOZQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: LO9P265MB7874

Generate helper exports similar to what's currently done for Rust
crates. These helpers are exclusively called from within Rust code
and therefore can be treated similar as other Rust symbols.

This removes the need for explicit exporting all symbols. This change
also makes it easier to support inlining these symbols directly to Rust
crates without them being exported at all.

Signed-off-by: Gary Guo <gary@garyguo.net>
---
 rust/Makefile  |  5 ++++-
 rust/exports.c |  1 +
 rust/helpers.c | 20 --------------------
 3 files changed, 5 insertions(+), 21 deletions(-)

diff --git a/rust/Makefile b/rust/Makefile
index f70d5e244fee..b4d63ea9209f 100644
--- a/rust/Makefile
+++ b/rust/Makefile
@@ -17,7 +17,7 @@ no-clean-files += libmacros.so
 always-$(CONFIG_RUST) += bindings/bindings_generated.rs bindings/bindings_helpers_generated.rs
 obj-$(CONFIG_RUST) += alloc.o bindings.o kernel.o
 always-$(CONFIG_RUST) += exports_alloc_generated.h exports_bindings_generated.h \
-    exports_kernel_generated.h
+    exports_kernel_generated.h exports_helpers_generated.h
 
 always-$(CONFIG_RUST) += uapi/uapi_generated.rs
 obj-$(CONFIG_RUST) += uapi.o
@@ -373,6 +373,9 @@ $(obj)/exports_bindings_generated.h: $(obj)/bindings.o FORCE
 $(obj)/exports_kernel_generated.h: $(obj)/kernel.o FORCE
 	$(call if_changed,exports)
 
+$(obj)/exports_helpers_generated.h: $(obj)/helpers.o FORCE
+	$(call if_changed,exports)
+
 quiet_cmd_rustc_procmacro = $(RUSTC_OR_CLIPPY_QUIET) P $@
       cmd_rustc_procmacro = \
 	$(RUSTC_OR_CLIPPY) $(rust_common_flags) \
diff --git a/rust/exports.c b/rust/exports.c
index 3803c21d1403..aa1218b325e5 100644
--- a/rust/exports.c
+++ b/rust/exports.c
@@ -19,6 +19,7 @@
 #include "exports_alloc_generated.h"
 #include "exports_bindings_generated.h"
 #include "exports_kernel_generated.h"
+#include "exports_helpers_generated.h"
 
 // For modules using `rust/build_error.rs`.
 #ifdef CONFIG_RUST_BUILD_ASSERT_ALLOW
diff --git a/rust/helpers.c b/rust/helpers.c
index 2c37a0f5d7a8..895f4b696962 100644
--- a/rust/helpers.c
+++ b/rust/helpers.c
@@ -37,13 +37,11 @@ __noreturn void rust_helper_BUG(void)
 {
 	BUG();
 }
-EXPORT_SYMBOL_GPL(rust_helper_BUG);
 
 void rust_helper_mutex_lock(struct mutex *lock)
 {
 	mutex_lock(lock);
 }
-EXPORT_SYMBOL_GPL(rust_helper_mutex_lock);
 
 void rust_helper___spin_lock_init(spinlock_t *lock, const char *name,
 				  struct lock_class_key *key)
@@ -54,97 +52,81 @@ void rust_helper___spin_lock_init(spinlock_t *lock, const char *name,
 	spin_lock_init(lock);
 #endif
 }
-EXPORT_SYMBOL_GPL(rust_helper___spin_lock_init);
 
 void rust_helper_spin_lock(spinlock_t *lock)
 {
 	spin_lock(lock);
 }
-EXPORT_SYMBOL_GPL(rust_helper_spin_lock);
 
 void rust_helper_spin_unlock(spinlock_t *lock)
 {
 	spin_unlock(lock);
 }
-EXPORT_SYMBOL_GPL(rust_helper_spin_unlock);
 
 void rust_helper_init_wait(struct wait_queue_entry *wq_entry)
 {
 	init_wait(wq_entry);
 }
-EXPORT_SYMBOL_GPL(rust_helper_init_wait);
 
 int rust_helper_signal_pending(struct task_struct *t)
 {
 	return signal_pending(t);
 }
-EXPORT_SYMBOL_GPL(rust_helper_signal_pending);
 
 refcount_t rust_helper_REFCOUNT_INIT(int n)
 {
 	return (refcount_t)REFCOUNT_INIT(n);
 }
-EXPORT_SYMBOL_GPL(rust_helper_REFCOUNT_INIT);
 
 void rust_helper_refcount_inc(refcount_t *r)
 {
 	refcount_inc(r);
 }
-EXPORT_SYMBOL_GPL(rust_helper_refcount_inc);
 
 bool rust_helper_refcount_dec_and_test(refcount_t *r)
 {
 	return refcount_dec_and_test(r);
 }
-EXPORT_SYMBOL_GPL(rust_helper_refcount_dec_and_test);
 
 __force void *rust_helper_ERR_PTR(long err)
 {
 	return ERR_PTR(err);
 }
-EXPORT_SYMBOL_GPL(rust_helper_ERR_PTR);
 
 bool rust_helper_IS_ERR(__force const void *ptr)
 {
 	return IS_ERR(ptr);
 }
-EXPORT_SYMBOL_GPL(rust_helper_IS_ERR);
 
 long rust_helper_PTR_ERR(__force const void *ptr)
 {
 	return PTR_ERR(ptr);
 }
-EXPORT_SYMBOL_GPL(rust_helper_PTR_ERR);
 
 const char *rust_helper_errname(int err)
 {
 	return errname(err);
 }
-EXPORT_SYMBOL_GPL(rust_helper_errname);
 
 struct task_struct *rust_helper_get_current(void)
 {
 	return current;
 }
-EXPORT_SYMBOL_GPL(rust_helper_get_current);
 
 void rust_helper_get_task_struct(struct task_struct *t)
 {
 	get_task_struct(t);
 }
-EXPORT_SYMBOL_GPL(rust_helper_get_task_struct);
 
 void rust_helper_put_task_struct(struct task_struct *t)
 {
 	put_task_struct(t);
 }
-EXPORT_SYMBOL_GPL(rust_helper_put_task_struct);
 
 struct kunit *rust_helper_kunit_get_current_test(void)
 {
 	return kunit_get_current_test();
 }
-EXPORT_SYMBOL_GPL(rust_helper_kunit_get_current_test);
 
 void rust_helper_init_work_with_key(struct work_struct *work, work_func_t func,
 				    bool onstack, const char *name,
@@ -156,14 +138,12 @@ void rust_helper_init_work_with_key(struct work_struct *work, work_func_t func,
 	INIT_LIST_HEAD(&work->entry);
 	work->func = func;
 }
-EXPORT_SYMBOL_GPL(rust_helper_init_work_with_key);
 
 void * __must_check __realloc_size(2)
 rust_helper_krealloc(const void *objp, size_t new_size, gfp_t flags)
 {
 	return krealloc(objp, new_size, flags);
 }
-EXPORT_SYMBOL_GPL(rust_helper_krealloc);
 
 /*
  * `bindgen` binds the C `size_t` type as the Rust `usize` type, so we can
-- 
2.42.0