Skip to content

feat(data_structures): introduce PointerExt trait#11095

Merged
graphite-app[bot] merged 1 commit intomainfrom
05-17-feat_data_structures_introduce_pointerext_trait
May 18, 2025
Merged

feat(data_structures): introduce PointerExt trait#11095
graphite-app[bot] merged 1 commit intomainfrom
05-17-feat_data_structures_introduce_pointerext_trait

Conversation

@overlookmotel
Copy link
Member

@overlookmotel overlookmotel commented May 17, 2025

Rust v1.87.0 introduced new methods for pointers, notably offset_from_unsigned which calculates the distance between 2 pointers.

https://doc.rust-lang.org/std/primitive.pointer.html#method.offset_from_unsigned

offset_from_unsigned is the same as offset_from, except it require the source pointer to be before the target, and so returns a usize rather than an isize. In return for this restriction, the compiler is able to generate more efficient code in some cases.

We want to use these methods, but our MSRV won't hit 1.87.0 for 3 months.

This PR introduces a PointerExt trait which provides similar methods offset_from_usize and byte_offset_from_usize.

On versions of Rust >= 1.87.0, these delegate directly to the native Rust methods offset_from_unsigned and byte_offset_from_unsigned. On earlier versions of Rust, they use a fallback implementation.

This PR replaces all use of offset_from with offset_from_usize in our crates.

This will probably make little difference to perf, as we don't use these methods much, and the perf advantage is small anyway. But reason I'm making this PR now is that allocator will make liberal use of them on very hot paths.

Copy link
Member Author


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • 0-merge - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions github-actions bot added A-codegen Area - Code Generation C-enhancement Category - New feature or request labels May 17, 2025
@codspeed-hq
Copy link

codspeed-hq bot commented May 17, 2025

CodSpeed Instrumentation Performance Report

Merging #11095 will not alter performance

Comparing 05-17-feat_data_structures_introduce_pointerext_trait (c79a7d0) with main (6e3e37b)

Summary

✅ 36 untouched benchmarks

@overlookmotel overlookmotel marked this pull request as ready for review May 17, 2025 14:14
@overlookmotel overlookmotel force-pushed the 05-17-feat_data_structures_introduce_pointerext_trait branch from 6439301 to 5f756b9 Compare May 17, 2025 14:19
@overlookmotel overlookmotel requested a review from Boshen May 17, 2025 15:56
@Boshen Boshen added the 0-merge Merge with Graphite Merge Queue label May 18, 2025
Copy link
Member

Boshen commented May 18, 2025

Merge activity

Rust v1.87.0 introduced new methods for pointers, notably `offset_from_unsigned` which calculates the distance between 2 pointers.

https://doc.rust-lang.org/std/primitive.pointer.html#method.offset_from_unsigned

`offset_from_unsigned` is the same as `offset_from`, except it require the source pointer to be before the target, and so returns a `usize` rather than an `isize`. In return for this restriction, the compiler is able to generate more efficient code in some cases.

We want to use these methods, but our MSRV won't hit 1.87.0 for 3 months.

This PR introduces a `PointerExt` trait which provides similar methods `offset_from_usize` and `byte_offset_from_usize`.

On versions of Rust >= 1.87.0, these delegate directly to the native Rust methods `offset_from_unsigned` and `byte_offset_from_unsigned`. On earlier versions of Rust, they use a fallback implementation.

This PR replaces all use of `offset_from` with `offset_from_usize` in our crates.

This will probably make little difference to perf, as we don't use these methods much, and the perf advantage is small anyway. But reason I'm making this PR now is that allocator will make liberal use of them on very hot paths.
@graphite-app graphite-app bot force-pushed the 05-17-feat_data_structures_introduce_pointerext_trait branch from 5f756b9 to c79a7d0 Compare May 18, 2025 07:01
@graphite-app graphite-app bot merged commit c79a7d0 into main May 18, 2025
27 checks passed
@graphite-app graphite-app bot removed the 0-merge Merge with Graphite Merge Queue label May 18, 2025
@graphite-app graphite-app bot deleted the 05-17-feat_data_structures_introduce_pointerext_trait branch May 18, 2025 07:07
graphite-app bot pushed a commit that referenced this pull request May 18, 2025
… comparisons (#11116)

Lexer use `offset_from` and `offset_from_unsigned` pointer methods rather than comparing pointers as `usize`s.

This utilizes the `PointerExt` trait introduced in #11095. This change tells the compiler "both these pointers are into the same object, and origin pointer is before target pointer", which gives it more information for optimization, and alias analysis.

This change also allows simplifying `Source` a little - we now almost entirely now deal in `SourcePosition`s, rather than a mix of `SourcePosition`s, raw pointers, and `ptr as usize`.

Tiny improvement on lexer benchmarks. Interestingly, it seems to produce a consistent ~1% speed-up in the byte handler for `/`. It seems to particularly have a positive effect on lexing single-line comments, for some reason.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-codegen Area - Code Generation C-enhancement Category - New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants