Skip to content

New pass: PropagateStructGets - #9271

Open
kripken wants to merge 74 commits into
WebAssembly:mainfrom
kripken:psgs
Open

kripken wants to merge 74 commits into
WebAssembly:mainfrom
kripken:psgs

Conversation

@kripken

@kripken kripken commented Oct 16, 2026

Copy link
Copy Markdown
Member

Our main escape analysis pass, Heap2Local, does not handle overlapping
live ranges, things like this:

x = new Foo(42);
if (condition) x = new Foo(1337);
bar(x.value, x.value);

More than one allocation is being read from in those x.value operations,
so Heap2Local sees the uses are not "exclusive", and it gives up.

Handling live ranges, sort of like liveness of locals for register allocation /
local coalescing, is possible, but quite complex. However, the pattern
above can be optimized in another way, which this new pass handles:
when the reference is always read from (using struct.get, which is the
.value operations above), then we can just shift from using the reference
to using data:

x_value = (new Foo(42)).value;
if (condition) x_value = (new Foo(1337)).value;
bar(x_value, x_value);

We store the data in a new local x_value, and that is all we need.

That is, this pass handles a situation that is more restricted than
Heap2Local, in that it doesn't do complex analysis of control flow
and handling of ref.eq and such, but it is more general in that it
can handle overlapping live ranges in a trivial way.

Fixes #8641 , a Dart testcase, and I saw this helps real-world binaries from
Kotlin and Java too - this is a common pattern.

@kripken
kripken requested a review from tlively October 16, 2026 20:36
@kripken
kripken requested a review from a team as a code owner October 16, 2026 20:36
Comment thread src/passes/PropagateStructGets.cpp
Comment thread src/passes/PropagateStructGets.cpp Outdated
Comment thread src/passes/PropagateStructGets.cpp Outdated
Comment thread src/passes/PropagateStructGets.cpp Outdated
// The parent struct.gets for each local index's gets.
std::unordered_map<Index, std::vector<StructGet*>> getParents;

// The parent struct.get for each tee.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It would be good to briefly say what happens when a local.get or local.tee does not have a parent struct.get.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Comments added.

Comment thread src/passes/PropagateStructGets.cpp Outdated
Comment on lines +124 to +126
// Avoid unreachable code, and leave atomic operations for now TODO
if (curr->type == Type::unreachable ||
curr->order != MemoryOrder::Unordered) {

@tlively tlively Oct 19, 2026 •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

There should be no need to leave atomic struct.gets for later. If the accessed allocations don't escape, they can't be part of any synchronization between threads, so they can be optimized just like non-atomic accesses.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Also, if we can optimize structs that don't come from allocations, this would still be valid when all their fields are immutable. Immutable fields cannot participate in cross-thread synchronization.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

We do optimize cases where structs arrive from e.g. parameters, i.e. not allocations that we view. See e.g. the test $set-unknown-immutable. Yes, that depends on immutability, as you said.

Is that enough for atomic synchronization? Would the struct.gets need to be atomic?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes, we can still optimize in that case. No, the struct.gets do not need to be atomic.

@kripken kripken Oct 20, 2026 •

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Is that because a Publish must happen after the immutable field is written at creation?

Added optimizing of atomic operations + tests.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

No, it's because cross-thread synchronization requires a release (or stronger) write on one thread that is then read from by an acquire (or stronger) read on another thread. The first half of that cannot happen with an immutable field. The initializing write done by struct.new and friends is not a release write.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

So other threads can read immutable fields non-atomically? Immutable writes (i.e. creations) are guaranteed to synchronize without atomics?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes, that pattern is safe due to the publish built into struct.new. But the synchronization effect of the publish does not extend to anything besides the fields of the particular published struct.

Comment thread src/passes/PropagateStructGets.cpp
Comment on lines +208 to +212
if (teeIt == teeParents.end()) {
// This tee does not feed into a struct.get, so the allocation(s)
// might escape.
ok = false;
break;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This also could have been checked directly via an ExpressionStackWalker rather than after the fact.

Comment on lines +226 to +228
// Each used field's value must not change between the local.set and
// local.get: either the field is immutable, or every set writes a fresh
// struct.new that only ever flows into this local's struct.gets. (Note

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

How could the field's value change, given that we have ruled out struct.sets? Also, it is not clear which local.set and local.get this refers to.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Gemini says we've only ruled out struct.sets through this particular local, but aliasing could allow other sets to slip through. It would be good to clarify that in the comment.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Added a comment.

// bar(x_value, x_value);
//
// Note how the `.value` (the struct.get) happens *before* `foo()`,
// after the optimization, so we may have moved a trap around here. It is

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Don't we know the local.set values always come from allocations, though?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Gemini says the pass also supports structs coming from parameters or calls as long as their fields are all immutable. It would be good to update the top-level comment to reflect that.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Added to the top-level comment to clarify that.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Though this does make me think, should we optimize cases without any allocation? atm we do, and it is not obvious to me if that is helpful or not.


void visitTry(Try* curr) { hasTry = true; }

void visitFunction(Function* func) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It would be nice to break this up into helper functions. It's huge.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Split up into find-locals-to-optimize and optimize functions. I didn't see other obvious opportunities to split stuff up, as the rest would require a bunch of outparams etc.

Comment thread test/lit/passes/propagate-struct-gets.wast

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Optimization issue where allocation is not eliminated

2 participants