Skip to contentSkip to conversation

rust: sync: optimize rust symbol generation for CondVar

PATCH In review Kunwu Chan 4 participants 9 messages Mar 17, 2025 – Mar 24, 2025

Subsystems (2)
lore
Share & tools
lore

Kunwu Chan

author
#0 lore raw

PATCH 1/1 rust: sync: optimize rust symbol generation for CondVar

From: Kunwu Chan <[email protected]>

When build the kernel using the llvm-18.1.3-rust-1.85.0-x86_64 with ARCH=arm64, the following symbols are generated:

$nm vmlinux | grep ' _R'.*CondVar | rustfilt
... T <kernel::sync::condvar::CondVar>::notify_all
... T <kernel::sync::condvar::CondVar>::notify_one
... T <kernel::sync::condvar::CondVar>::notify_sync
... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar as core::ops::drop::Drop>::drop

These notify* symbols are trivial wrappers around the C functions __wake_up and __wake_up_sync.
It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.

---
 rust/kernel/sync/condvar.rs | 4 ++++
 1 file changed, 4 insertions(+)
rust/kernel/sync/condvar.rs +4 -0
index 7df565038d7d..a826896ba3f0 100644
@@ -181,6 +181,7 @@ pub fn wait_interruptible_timeout<T: ?Sized, B: Backend>(
     }
 
     /// Calls the kernel function to notify the appropriate number of threads.
+    #[inline]
     fn notify(&self, count: c_int) {
         // SAFETY: `wait_queue_head` points to valid memory.
         unsafe {
@@ -198,6 +199,7 @@ fn notify(&self, count: c_int) {
     /// This method behaves like `notify_one`, except that it hints to the scheduler that the
     /// current thread is about to go to sleep, so it should schedule the target thread on the same
     /// CPU.
+    #[inline]
     pub fn notify_sync(&self) {
         // SAFETY: `wait_queue_head` points to valid memory.
         unsafe { bindings::__wake_up_sync(self.wait_queue_head.get(), TASK_NORMAL) };
@@ -207,6 +209,7 @@ pub fn notify_sync(&self) {
     ///
     /// This is not 'sticky' in the sense that if no thread is waiting, the notification is lost
     /// completely (as opposed to automatically waking up the next waiter).
+    #[inline]
     pub fn notify_one(&self) {
         self.notify(1);
     }
@@ -215,6 +218,7 @@ pub fn notify_one(&self) {
     ///
     /// This is not 'sticky' in the sense that if no thread is waiting, the notification is lost
     /// completely (as opposed to automatically waking up the next waiter).
+    #[inline]
     pub fn notify_all(&self) {
         self.notify(0);
     }
Signature · 1 line
2.43.0
Reviewed-by on v1 1/1
#1 lore raw
Quoted 19 lines · Kunwu Chan

From: Kunwu Chan <[email protected]>

When build the kernel using the llvm-18.1.3-rust-1.85.0-x86_64 with ARCH=arm64, the following symbols are generated:

$nm vmlinux | grep ' _R'.*CondVar | rustfilt
... T <kernel::sync::condvar::CondVar>::notify_all
... T <kernel::sync::condvar::CondVar>::notify_one
... T <kernel::sync::condvar::CondVar>::notify_sync
... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar as core::ops::drop::Drop>::drop

These notify* symbols are trivial wrappers around the C functions __wake_up and __wake_up_sync.
It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.

Quoted 5 lines

---
Cheers,
Benno

Quoted 3 lines
---
 rust/kernel/sync/condvar.rs | 4 ++++
 1 file changed, 4 insertions(+)
maintainer Reviewed-by on v1 1/1
#2 lore raw
In reply to Kunwu Chan
Quoted 14 lines · Kunwu Chan

From: Kunwu Chan <[email protected]>

When build the kernel using the llvm-18.1.3-rust-1.85.0-x86_64 with ARCH=arm64, the following symbols are generated:

$nm vmlinux | grep ' _R'.*CondVar | rustfilt
... T <kernel::sync::condvar::CondVar>::notify_all
... T <kernel::sync::condvar::CondVar>::notify_one
... T <kernel::sync::condvar::CondVar>::notify_sync
... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar as core::ops::drop::Drop>::drop

Quoted 4 lines

These notify* symbols are trivial wrappers around the C functions __wake_up and __wake_up_sync.
It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.

You don't need to send a new version just for this, but please format the paragraphs better in the future. For example:

The notify* symbols are trivial wrappers around the C functions __wake_up and __wake_up_sync. It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.

Quoted 5 lines
author
#3 lore raw
Quoted 19 lines · Alice Ryhl
Quoted 14 lines · Kunwu Chan

From: Kunwu Chan <[email protected]>

When build the kernel using the llvm-18.1.3-rust-1.85.0-x86_64 with ARCH=arm64, the following symbols are generated:

$nm vmlinux | grep ' _R'.*CondVar | rustfilt
... T <kernel::sync::condvar::CondVar>::notify_all
... T <kernel::sync::condvar::CondVar>::notify_one
... T <kernel::sync::condvar::CondVar>::notify_sync
... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar as core::ops::drop::Drop>::drop

Quoted 4 lines

These notify* symbols are trivial wrappers around the C functions __wake_up and __wake_up_sync.
It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.

Quoted 6 lines

You don't need to send a new version just for this, but please format the paragraphs better in the future. For example:

The notify* symbols are trivial wrappers around the C functions __wake_up and __wake_up_sync. It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.

Thanks, I'll remember that, try to fill one line first and don't start a new one easily.

Quoted 7 lines
Quoted 5 lines
Signature · 2 lines
Thanks,
  Kunwu.Chan
#4 lore raw
In reply to Alice Ryhl
Quoted 27 lines · Alice Ryhl
Quoted 14 lines · Kunwu Chan

From: Kunwu Chan <[email protected]>

When build the kernel using the llvm-18.1.3-rust-1.85.0-x86_64 with ARCH=arm64, the following symbols are generated:

$nm vmlinux | grep ' _R'.*CondVar | rustfilt
... T <kernel::sync::condvar::CondVar>::notify_all
... T <kernel::sync::condvar::CondVar>::notify_one
... T <kernel::sync::condvar::CondVar>::notify_sync
... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar as core::ops::drop::Drop>::drop

Quoted 4 lines

These notify* symbols are trivial wrappers around the C functions __wake_up and __wake_up_sync.
It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.

You don't need to send a new version just for this, but please format the paragraphs better in the future. For example:

The notify* symbols are trivial wrappers around the C functions __wake_up and __wake_up_sync. It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.

Quoted 8 lines
Quoted 5 lines

Queued for future tests and reviews, thank you all.

Regards,
Boqun

#5 lore raw
In reply to Kunwu Chan
Quoted 33 lines · Kunwu Chan

From: Kunwu Chan <[email protected]>

When build the kernel using the llvm-18.1.3-rust-1.85.0-x86_64 with ARCH=arm64, the following symbols are generated:

$nm vmlinux | grep ' _R'.*CondVar | rustfilt
... T <kernel::sync::condvar::CondVar>::notify_all
... T <kernel::sync::condvar::CondVar>::notify_one
... T <kernel::sync::condvar::CondVar>::notify_sync
... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar as core::ops::drop::Drop>::drop

These notify* symbols are trivial wrappers around the C functions __wake_up and __wake_up_sync.
It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.

---
 rust/kernel/sync/condvar.rs | 4 ++++
 1 file changed, 4 insertions(+)
rust/kernel/sync/condvar.rs +0 -0
index 7df565038d7d..a826896ba3f0 100644

rust/kernel/sync/condvar.rs pub fn wait_interruptible_timeout<T: ?Sized, B: Backend>( · line 185

Quoted 5 lines
rust/kernel/sync/condvar.rs +1 -0
@@ -181,6 +181,7 @@ pub fn wait_interruptible_timeout<T: ?Sized, B: Backend>(
     }
 
     /// Calls the kernel function to notify the appropriate number of threads.
+    #[inline]
     fn notify(&self, count: c_int) {

Hmm.. I think CondVar::notify() gets inlined even without this #[inline] attribute, do we need this actually?

Regards,
Boqun

Quoted 2 lines
rust/kernel/sync/condvar.rs +0 -0
         // SAFETY: `wait_queue_head` points to valid memory.
         unsafe {

[...]

author
#6 lore raw
Quoted 36 lines · Boqun Feng
Quoted 35 lines · Kunwu Chan

From: Kunwu Chan <[email protected]>

When build the kernel using the llvm-18.1.3-rust-1.85.0-x86_64 with ARCH=arm64, the following symbols are generated:

$nm vmlinux | grep ' _R'.*CondVar | rustfilt
... T <kernel::sync::condvar::CondVar>::notify_all
... T <kernel::sync::condvar::CondVar>::notify_one
... T <kernel::sync::condvar::CondVar>::notify_sync
... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar as core::ops::drop::Drop>::drop

These notify* symbols are trivial wrappers around the C functions __wake_up and __wake_up_sync.
It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.

---
  rust/kernel/sync/condvar.rs | 4 ++++
  1 file changed, 4 insertions(+)
rust/kernel/sync/condvar.rs +0 -0
index 7df565038d7d..a826896ba3f0 100644
@@ -181,6 +181,7 @@ pub fn wait_interruptible_timeout<T: ?Sized, B: Backend>(
      }
 
Quoted 5 lines

rust/kernel/sync/condvar.rs pub fn wait_interruptible_timeout<T: ?Sized, B: Backend>( · line 185

Quoted 3 lines
rust/kernel/sync/condvar.rs +1 -0
      /// Calls the kernel function to notify the appropriate number of threads.
+    #[inline]
      fn notify(&self, count: c_int) {

Hmm.. I think CondVar::notify() gets inlined even without this #[inline] attribute, do we need this actually?

Actualy, after add '#[inline]', the build result is (compilecmd is 'make ARCH=arm64 LLVM=1-j8' ):

$nm vmlinux | grep ' _R'.*CondVar | rustfilt
ffff800080019e90 T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_ex plicit
ffff800080019e90 T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_ex plicit
ffff800080019e90 T <kernel::sync::poll::PollCondVar>::new::{closure#0}::{closure#0}::panic_cold_e xplicit
ffff8000805b8c7c T <kernel::sync::poll::PollCondVar as core::ops::drop::Drop>::drop

And before add '#[inline]',the 'nm vmlinux | grep ' _R'.*CondVar | rustfilt' appear 'notify' function,

Seems like the LLVM didn't make it inline.

Quoted 6 lines

Regards,
Boqun

Quoted 2 lines
rust/kernel/sync/condvar.rs +0 -0
          // SAFETY: `wait_queue_head` points to valid memory.
          unsafe {

[...]

Signature · 2 lines
Thanks,
  Kunwu.Chan(Tao.Chan)
#7 lore raw
Quoted 56 lines · Kunwu Chan
Quoted 29 lines · Boqun Feng
Quoted 28 lines · Kunwu Chan

From: Kunwu Chan <[email protected]>

When build the kernel using the llvm-18.1.3-rust-1.85.0-x86_64 with ARCH=arm64, the following symbols are generated:

$nm vmlinux | grep ' _R'.*CondVar | rustfilt
... T <kernel::sync::condvar::CondVar>::notify_all
... T <kernel::sync::condvar::CondVar>::notify_one
... T <kernel::sync::condvar::CondVar>::notify_sync
... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar as core::ops::drop::Drop>::drop

These notify* symbols are trivial wrappers around the C functions __wake_up and __wake_up_sync.
It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.

---
  rust/kernel/sync/condvar.rs | 4 ++++
  1 file changed, 4 insertions(+)
Quoted 11 lines

rust/kernel/sync/condvar.rs pub fn wait_interruptible_timeout<T: ?Sized, B: Backend>( · line 184

Quoted 9 lines
rust/kernel/sync/condvar.rs +1 -0
index 7df565038d7d..a826896ba3f0 100644
@@ -181,6 +181,7 @@ pub fn wait_interruptible_timeout<T: ?Sized, B: Backend>(
      }
      /// Calls the kernel function to notify the appropriate number of threads.
+    #[inline]
      fn notify(&self, count: c_int) {

Hmm.. I think CondVar::notify() gets inlined even without this #[inline] attribute, do we need this actually?

Actualy, after add '#[inline]', the build result is (compilecmd is 'make ARCH=arm64 LLVM=1-j8' ):

$nm vmlinux | grep ' _R'.*CondVar | rustfilt
ffff800080019e90 T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_ex plicit
ffff800080019e90 T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_ex plicit
ffff800080019e90 T <kernel::sync::poll::PollCondVar>::new::{closure#0}::{closure#0}::panic_cold_e xplicit
ffff8000805b8c7c T <kernel::sync::poll::PollCondVar as core::ops::drop::Drop>::drop

Quoted 5 lines

And before add '#[inline]',the 'nm vmlinux | grep ' _R'.*CondVar | rustfilt' appear 'notify' function,

Seems like the LLVM didn't make it inline.

Your commit log said:

... the following symbols are generated:

$nm vmlinux | grep ' _R'.*CondVar | rustfilt
... T <kernel::sync::condvar::CondVar>::notify_all
... T <kernel::sync::condvar::CondVar>::notify_one
... T <kernel::sync::condvar::CondVar>::notify_sync
... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar as core::ops::drop::Drop>::drop

so no *notify* symbol even before the patch, right? I also checked with my local build, without your patch, there is still no symbol for notify().

Regards,
Boqun

author
#8 lore raw
Quoted 74 lines · Boqun Feng
Quoted 55 lines · Kunwu Chan
Quoted 29 lines · Boqun Feng
Quoted 28 lines · Kunwu Chan

From: Kunwu Chan <[email protected]>

When build the kernel using the llvm-18.1.3-rust-1.85.0-x86_64 with ARCH=arm64, the following symbols are generated:

$nm vmlinux | grep ' _R'.*CondVar | rustfilt
... T <kernel::sync::condvar::CondVar>::notify_all
... T <kernel::sync::condvar::CondVar>::notify_one
... T <kernel::sync::condvar::CondVar>::notify_sync
... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar as core::ops::drop::Drop>::drop

These notify* symbols are trivial wrappers around the C functions __wake_up and __wake_up_sync.
It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.

---
   rust/kernel/sync/condvar.rs | 4 ++++
   1 file changed, 4 insertions(+)
Quoted 11 lines

rust/kernel/sync/condvar.rs pub fn wait_interruptible_timeout<T: ?Sized, B: Backend>( · line 184

Quoted 9 lines
rust/kernel/sync/condvar.rs +1 -0
index 7df565038d7d..a826896ba3f0 100644
@@ -181,6 +181,7 @@ pub fn wait_interruptible_timeout<T: ?Sized, B: Backend>(
       }
       /// Calls the kernel function to notify the appropriate number of threads.
+    #[inline]
       fn notify(&self, count: c_int) {

Hmm.. I think CondVar::notify() gets inlined even without this #[inline] attribute, do we need this actually?

Actualy, after add '#[inline]', the build result is (compilecmd is 'make ARCH=arm64 LLVM=1-j8' ):

$nm vmlinux | grep ' _R'.*CondVar | rustfilt
ffff800080019e90 T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_ex plicit
ffff800080019e90 T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_ex plicit
ffff800080019e90 T <kernel::sync::poll::PollCondVar>::new::{closure#0}::{closure#0}::panic_cold_e xplicit
ffff8000805b8c7c T <kernel::sync::poll::PollCondVar as core::ops::drop::Drop>::drop

Quoted 5 lines

And before add '#[inline]',the 'nm vmlinux | grep ' _R'.*CondVar | rustfilt' appear 'notify' function,

Seems like the LLVM didn't make it inline.

Your commit log said:

... the following symbols are generated:

$nm vmlinux | grep ' _R'.*CondVar | rustfilt
... T <kernel::sync::condvar::CondVar>::notify_all
... T <kernel::sync::condvar::CondVar>::notify_one
... T <kernel::sync::condvar::CondVar>::notify_sync
... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::condvar::CondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar>::new::{closure#0}::{closure#0}::panic_cold_explicit ... T <kernel::sync::poll::PollCondVar as core::ops::drop::Drop>::drop

Quoted 1 line

so no *notify* symbol even before the patch, right? I also checked with

My bad,I mistakenly thought it was some other 'notify_*' functions,

it should be LLVM automatically inline 'notify', I will remove it in the next version.

Quoted 5 lines

my local build, without your patch, there is still no symbol for notify().

Regards,
Boqun

Signature · 2 lines
Thanks,
  Kunwu.Chan(Tao.Chan)