Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

speed up String::push and String::insert #124810

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

lincot
Copy link

@lincot lincot commented May 6, 2024

Addresses the concerns described in #116235.

The performance gain comes mainly from avoiding temporary buffers.

Complex pattern matching in encode_utf8 (introduced in #67569) has been simplified to a comparison and an exhaustive match in the encode_utf8_raw_unchecked helper function. It takes a slice of MaybeUninit<u8> because otherwise we'd have to construct a normal slice to uninitialized data, which is not desirable, I guess.

Several functions still have that unneeded zeroing, but a single instruction is not that important, I guess.

@rustbot label T-libs C-optimization A-str

@rustbot
Copy link
Collaborator

rustbot commented May 6, 2024

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @scottmcm (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. A-str Area: str and String C-optimization Category: An issue highlighting optimization opportunities or PRs implementing such labels May 6, 2024
Copy link
Member

@scottmcm scottmcm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had a variety of thoughts; let me know what you think.

Also, is there anything here for which it would make sense to have a codegen test to confirm what's happening? Or some other test to help confirm it's better?

@rustbot rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 13, 2024
@lincot
Copy link
Author

lincot commented May 13, 2024

A codegen check for the absence of memcpy would be nice, since the original String::push has one.

@rust-timer
Copy link
Collaborator

Insufficient permissions to issue commands to rust-timer.

@bors
Copy link
Contributor

bors commented Jun 12, 2024

@lincot: 🔑 Insufficient privileges: not in try users

@rust-timer
Copy link
Collaborator

Insufficient permissions to issue commands to rust-timer.

@bors
Copy link
Contributor

bors commented Jun 22, 2024

☔ The latest upstream changes (presumably #116113) made this pull request unmergeable. Please resolve the merge conflicts.

@rustbot rustbot added the has-merge-commits PR has merge commits, merge with caution. label Jul 10, 2024
@rustbot
Copy link
Collaborator

rustbot commented Jul 10, 2024

There are merge commits (commits with multiple parents) in your changes. We have a no merge policy so these commits will need to be removed for this pull request to be merged.

You can start a rebase with the following commands:

$ # rebase
$ git pull --rebase https://github.com/rust-lang/rust.git master
$ git push --force-with-lease

The following commits are merge commits:

@lincot lincot force-pushed the speed-up-string-push-and-string-insert branch from 9511918 to 89fa55e Compare July 10, 2024 19:08
@rustbot rustbot removed the has-merge-commits PR has merge commits, merge with caution. label Jul 10, 2024
@bors
Copy link
Contributor

bors commented Jul 17, 2024

☔ The latest upstream changes (presumably #127840) made this pull request unmergeable. Please resolve the merge conflicts.

@lincot lincot force-pushed the speed-up-string-push-and-string-insert branch from 89fa55e to 2cb20b3 Compare August 6, 2024 19:00
@Dylan-DPC Dylan-DPC added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 15, 2024
@bors
Copy link
Contributor

bors commented Sep 19, 2024

☔ The latest upstream changes (presumably #130511) made this pull request unmergeable. Please resolve the merge conflicts.

@lincot
Copy link
Author

lincot commented Oct 6, 2024

The proposed implementation uses get_unchecked_mut, which cannot be used in char::encode_utf8, which is now const. Also, get_unchecked_mut actually has a cost when running with debug assertions. So I am reverting to using pointers. The codegen of String::push seems to be unchanged: godbolt.

@lincot lincot force-pushed the speed-up-string-push-and-string-insert branch from 2cb20b3 to 7a7cfb1 Compare October 6, 2024 17:07
@rust-log-analyzer

This comment has been minimized.

@bors
Copy link
Contributor

bors commented Oct 16, 2024

☔ The latest upstream changes (presumably #131460) made this pull request unmergeable. Please resolve the merge conflicts.

@lincot lincot force-pushed the speed-up-string-push-and-string-insert branch from b52db40 to 3a60212 Compare October 16, 2024 10:32
@rust-log-analyzer

This comment has been minimized.

@lincot lincot requested a review from scottmcm October 16, 2024 12:25
@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 16, 2024
@Dylan-DPC Dylan-DPC requested a review from clarfonthey October 25, 2024 05:27
@Dylan-DPC
Copy link
Member

(oops the review request was an accidental click)

Copy link
Contributor

@tgross35 tgross35 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like your perf job never got run, could you rebase?

library/alloc/src/string.rs Outdated Show resolved Hide resolved
library/core/src/char/methods.rs Outdated Show resolved Hide resolved
#[doc(hidden)]
#[inline]
#[cfg_attr(bootstrap, rustc_allow_const_fn_unstable(const_mut_refs))]
pub const unsafe fn encode_utf8_raw_unchecked(code: u32, dst: *mut u8) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dst could probably still be a &mut [u8] in this signature, call .as_mut_ptr() within this function. Then you can add a debug_assert!(dst.len() >= len).

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe &mut [u8] cannot point to uninitialized memory according to safety guidelines, which is why I used &mut [MaybeUninit<u8>] first. If a slice is necessary, we can revert to using &mut [MaybeUninit<u8>] and .as_mut_ptr().

tests/codegen/string-push.rs Outdated Show resolved Hide resolved
@tgross35
Copy link
Contributor

@rustbot author

@rustbot rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 19, 2024
@lincot lincot force-pushed the speed-up-string-push-and-string-insert branch from 9462d92 to a2effde Compare December 20, 2024 15:16
@rust-log-analyzer

This comment has been minimized.

@rust-log-analyzer

This comment has been minimized.

@lincot lincot requested a review from tgross35 December 20, 2024 17:31
@lincot
Copy link
Author

lincot commented Dec 20, 2024

@rustbot review

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Dec 20, 2024
@bors
Copy link
Contributor

bors commented Jan 24, 2025

☔ The latest upstream changes (presumably #135947) made this pull request unmergeable. Please resolve the merge conflicts.

@lincot lincot force-pushed the speed-up-string-push-and-string-insert branch from 49bd467 to b7f3a92 Compare February 2, 2025 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-str Area: str and String C-optimization Category: An issue highlighting optimization opportunities or PRs implementing such S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants