rust: file: optimize rust symbol generation for FileDescriptorReservation
PATCH 1/1 rust: file: optimize rust symbol generation for FileDescriptorReservation
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'.*FileDescriptorReservation | rustfilt ffff8000805b6ef0 T <kernel::fs::file::FileDescriptorReservation> ::fd_install ffff8000805b6e60 T <kernel::fs::file::FileDescriptorReservation> ::get_unused_fd_flags ffff8000805b6f08 T <kernel::fs::file::FileDescriptorReservation as core::ops::drop::Drop>::drop
These Rust symbols are trivial wrappers around the C functions fd_install, put_unused_fd and put_task_struct.It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.
After doing so, the above symbol will not in output.
--- rust/kernel/fs/file.rs | 3 +++ 1 file changed, 3 insertions(+)
rust/kernel/fs/file.rs +3 -0
@@ -392,6 +392,7 @@ pub struct FileDescriptorReservation {impl FileDescriptorReservation {/// Creates a new file descriptor reservation. +#[inline] pub fn get_unused_fd_flags (flags:u32 ) ->Result <Self > {// SAFETY: FFI call, there are no safety requirements on `flags`. let fd:i32 =unsafe { bindings::get_unused_fd_flags (flags) };
@@ -413,6 +414,7 @@ pub fn reserved_fd(&self) -> u32 {/// /// The previously reserved file descriptor is bound to `file`. This method consumes the /// [`FileDescriptorReservation`], so it will not be usable after this call. +#[inline] pub fn fd_install (self, file:ARef <File >) {// SAFETY: `self.fd` was previously returned by `get_unused_fd_flags`. We have not yet used // the fd, so it is still valid, and `current` still refers to the same task, as this type
@@ -433,6 +435,7 @@ pub fn fd_install(self, file: ARef<File>) { }impl Drop for FileDescriptorReservation { +#[inline] fn drop (&mut self) {// SAFETY: By the type invariants of this type, `self.fd` was previously returned by // `get_unused_fd_flags`. We have not yet used the fd, so it is still valid, and `current`
Signature · 1 line
2.43.0
Alice Ryhl
reviewerQuoted 18 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'.*FileDescriptorReservation | rustfilt ffff8000805b6ef0 T <kernel::fs::file::FileDescriptorReservation> ::fd_install ffff8000805b6e60 T <kernel::fs::file::FileDescriptorReservation> ::get_unused_fd_flags ffff8000805b6f08 T <kernel::fs::file::FileDescriptorReservation as core::ops::drop::Drop>::dropThese Rust symbols are trivial wrappers around the C functions
fd_install,put_unused_fdand put_task_struct.It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.
Quoted 5 lines
After doing so, the above symbol will not in output.
Signed-off-by Kunwu Chan <[email protected]>Co-developed-by Grace Deng <[email protected]>Signed-off-by Grace Deng <[email protected]>
A few notes:
* Your own Signed-off-by must always be last.
* You're missing Link: and Suggested-by: tags.
* There are some grammar issues, e.g. a missing space before "It" and the phrase "will not in output" is not good.
* Let's also add the marker to reserved_fd to be on the safe side.
* I think it is easier to read the symbols if you list each sybmol on one line like this:
ffff8000805b6ef0 T <kernel::fs::file::FileDescriptorReservation>::fd_install ffff8000805b6e60 T <kernel::fs::file::FileDescriptorReservation>::get_unused_fd_flags ffff8000805b6f08 T <kernel::fs::file::FileDescriptorReservation as core::ops::drop::Drop>::drop
Alice
Quoted 21 lines · Alice Ryhl
Quoted 20 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'.*FileDescriptorReservation | rustfilt ffff8000805b6ef0 T <kernel::fs::file::FileDescriptorReservation> ::fd_install ffff8000805b6e60 T <kernel::fs::file::FileDescriptorReservation> ::get_unused_fd_flags ffff8000805b6f08 T <kernel::fs::file::FileDescriptorReservation as core::ops::drop::Drop>::dropThese Rust symbols are trivial wrappers around the C functions
fd_install,put_unused_fdand put_task_struct.It doesn't make sense to go through a trivial wrapper for these functions, so mark them inline.After doing so, the above symbol will not in output.
Quoted 7 lines
Quoted 3 lines
Signed-off-by Kunwu Chan <[email protected]>Co-developed-by Grace Deng <[email protected]>Signed-off-by Grace Deng <[email protected]>A few notes:
* Your own Signed-off-by must always be last.
* You're missing Link: and Suggested-by: tags.
Thanks for the reply.
I'll change my own Signed-off-by be last and add Link and Suggested-by as the following:
Quoted 2 lines
* There are some grammar issues, e.g. a missing space before "It" and the phrase "will not in output" is not good.
I'll add a space before "It" and remove the last line.
Quoted 1 line
* Let's also add the marker to
reserved_fdto be on the safe side.
Sure, I'll make 'reserved_fd ' inline in v2.
Quoted 6 lines
* I think it is easier to read the symbols if you list each sybmol on one line like this:
ffff8000805b6ef0T <kernel::fs::file::FileDescriptorReservation>::fd_installffff8000805b6e60T <kernel::fs::file::FileDescriptorReservation>::get_unused_fd_flagsffff8000805b6f08T <kernel::fs::file::FileDescriptorReservationas core::ops::drop::Drop>::drop
If in one line, checkpatch.pl will report a warning:
WARNING:Prefer a maximum 75 chars per line (possible unwrapped commit description?)
If no need to bother with the warning, I'll change it to one line in v2.
Quoted 2 lines
Alice
Signature · 2 lines
Thanks, Kunwu.Chan(Tao.chan)
Alice Ryhl
reviewerQuoted 7 lines · Kunwu Chan
Quoted 6 lines
* I think it is easier to read the symbols if you list each sybmol on one line like this:
ffff8000805b6ef0T <kernel::fs::file::FileDescriptorReservation>::fd_installffff8000805b6e60T <kernel::fs::file::FileDescriptorReservation>::get_unused_fd_flagsffff8000805b6f08T <kernel::fs::file::FileDescriptorReservationas core::ops::drop::Drop>::drop
Quoted 6 lines
If in one line, checkpatch.pl will report a warning:
WARNING:Prefer a maximum 75 chars per line (possible unwrapped commit description?)
If no need to bother with the warning, I'll change it to one line in v2.
You could do this:
... T <kernel::fs::file::FileDescriptorReservation>::fd_install but if it's still too long I'd just ignore it.
Alice
Quoted 9 lines · Alice Ryhl
Quoted 8 lines · Kunwu Chan
Quoted 6 lines
* I think it is easier to read the symbols if you list each sybmol on one line like this:
ffff8000805b6ef0T <kernel::fs::file::FileDescriptorReservation>::fd_installffff8000805b6e60T <kernel::fs::file::FileDescriptorReservation>::get_unused_fd_flagsffff8000805b6f08T <kernel::fs::file::FileDescriptorReservationas core::ops::drop::Drop>::dropIf in one line, checkpatch.pl will report a warning:
Quoted 7 lines
Quoted 4 lines
WARNING:Prefer a maximum 75 chars per line (possible unwrapped commit description?)
If no need to bother with the warning, I'll change it to one line in v2.
You could do this:
... T <kernel::fs::file::FileDescriptorReservation>::fd_install but if it's still too long I'd just ignore it.
Thanks, I'll change it in v2.
Quoted 2 lines
Alice
Signature · 2 lines
Thanks, Kunwu.Chan