Skip to content

syscall/js: allocate arg slices on stack for small numbers of args #66684

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

syscall/js: allocate arg slices on stack for small numbers of args #66684

wants to merge 1 commit into from

Conversation

unitoftime
Copy link

@unitoftime unitoftime commented Apr 4, 2024 •
edited
Loading

The existing implementation causes unnecessary heap allocations for
javascript syscalls: Call, Invoke, and New. The new change seeks to
hint the Go compiler to allocate arg slices with length <=16 to the
stack.

Original Work: CL 367045

  • Calling a JavaScript function with 16 arguments or fewer will not
    induce two additional heap allocations, at least with the current Go
    compiler.
  • Using syscall/js features with slices and strings of
    statically-known length will not cause them to be escaped to the heap,
    at least with the current Go compiler.
  • The reduction in allocations has the additional benefit that the
    garbage collector runs less often, blocking WebAssembly's one and only
    thread less often.

Fixes #39740

@gopherbot
Copy link
Contributor

This PR (HEAD: c29c1b7) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/go/+/576575.

Important tips:

  • Don't comment on this PR. All discussion takes place in Gerrit.
  • You need a Gmail or other Google account to log in to Gerrit.
  • To change your code in response to feedback:
    • Push a new commit to the branch used by your GitHub PR.
    • A new "patch set" will then appear in Gerrit.
    • Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
    • Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
    • Multiple commits in the PR will be squashed by GerritBot.
  • The title and description of the GitHub PR are used to construct the final commit message.
    • Edit these as needed via the GitHub web interface (not via Gerrit or git).
    • You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
  • See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 1:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 1:

Congratulations on opening your first change. Thank you for your contribution!

Next steps:
A maintainer will review your change and provide feedback. See
https://go.dev/doc/contribute#review for more info and tips to get your
patch through code review.

Most changes in the Go project go through a few rounds of revision. This can be
surprising to people new to the project. The careful, iterative review process
is our way of helping mentor contributors and ensuring that their contributions
have a lasting impact.

During May-July and Nov-Jan the Go project is in a code freeze, during which
little code gets reviewed or merged. If a reviewer responds with a comment like
R=go1.11 or adds a tag like "wait-release", it means that this CL will be
reviewed as part of the next development cycle. See https://go.dev/s/release
for more details.

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@unitoftime
Copy link
Author

Putting this here for posterity (Also linked in code review: https://go-review.googlesource.com/c/go/+/576575/comments/16d89df8_6a869458 )

Hi, Thanks for reviewing this change.

I just wanted to give some additional context about this change and where it came from. As I did not author all of it. The original research and work was done by finnbear (https://github.com/finnbear): #49799 - I'm hoping to help get his changes through the review process. Notes from his original PR (this is from Finnbear):

  • Calling a JavaScript function with 16 arguments or fewer will not induce two additional heap allocations, at least with the current Go compiler
  • Using syscall/js features with slices and strings of statically-known length will not cause them to be escaped to the heap, at least with the current Go compiler
  • The reduction in allocations has the additional benefit that the garbage collector runs less often, blocking WebAssembly's one and only thread less often
    Other Notes (The rest is from me):
  1. Tested locally on a WASM game I am building to verify that the heap allocations have all been removed in the expected areas
  2. Ran what appears to be the full test suite of the go repo: ./all.bash

This is my first PR to golang, so please let me know if I've done anything incorrectly, or if you need anything else! Thanks!

@gopherbot
Copy link
Contributor

Message from Jacob Stewart:

Patch Set 2:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Jacob Stewart:

Patch Set 2:

(2 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@finnbear finnbear mentioned this pull request Apr 4, 2024
Closed
@gopherbot
Copy link
Contributor

Message from Cherry Mui:

Patch Set 2: Commit-Queue+1

(6 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Go LUCI:

Patch Set 2:

Dry run: CV is trying the patch.

Bot data: {"action":"start","triggered_at":"2024-04-04T21:29:07Z","revision":"0ce27014775373c0d26c2069213ac4bdf1999ebd"}

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Cherry Mui:

Patch Set 2: -Commit-Queue

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Go LUCI:

Patch Set 2:

This CL has passed the run

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Go LUCI:

Patch Set 2: LUCI-TryBot-Result+1

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

This PR (HEAD: c5a7508) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/go/+/576575.

Important tips:

  • Don't comment on this PR. All discussion takes place in Gerrit.
  • You need a Gmail or other Google account to log in to Gerrit.
  • To change your code in response to feedback:
    • Push a new commit to the branch used by your GitHub PR.
    • A new "patch set" will then appear in Gerrit.
    • Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
    • Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
    • Multiple commits in the PR will be squashed by GerritBot.
  • The title and description of the GitHub PR are used to construct the final commit message.
    • Edit these as needed via the GitHub web interface (not via Gerrit or git).
    • You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
  • See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

@gopherbot
Copy link
Contributor

Message from Jacob Stewart:

Patch Set 3:

(7 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Cherry Mui:

Patch Set 3: Commit-Queue+1

(3 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Go LUCI:

Patch Set 3:

Dry run: CV is trying the patch.

Bot data: {"action":"start","triggered_at":"2024-04-17T19:32:17Z","revision":"725ed8063eaf707bcd890528e1b99cd9e607a350"}

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Cherry Mui:

Patch Set 3: -Commit-Queue

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Go LUCI:

Patch Set 3:

This CL has passed the run

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Go LUCI:

Patch Set 3: LUCI-TryBot-Result+1

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@griesemer griesemer mentioned this pull request Apr 17, 2024
Closed
syscall/js: allocate arg slices on stack for small numbers of args
36df1b3 
The existing implementation causes unnecessary heap allocations for
javascript syscalls: Call, Invoke, and New. The new change seeks to
hint the Go compiler to allocate arg slices with length <=16 to the
stack.

Original Work: CL 367045
- Calling a JavaScript function with 16 arguments or fewer will not
induce two additional heap allocations, at least with the current Go
compiler.
- Using syscall/js features with slices and strings of
statically-known length will not cause them to be escaped to the heap,
at least with the current Go compiler.
- The reduction in allocations has the additional benefit that the
garbage collector runs less often, blocking WebAssembly's one and only
thread less often.

Fixes golang#39740
@gopherbot
Copy link
Contributor

This PR (HEAD: 36df1b3) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/go/+/576575.

Important tips:

  • Don't comment on this PR. All discussion takes place in Gerrit.
  • You need a Gmail or other Google account to log in to Gerrit.
  • To change your code in response to feedback:
    • Push a new commit to the branch used by your GitHub PR.
    • A new "patch set" will then appear in Gerrit.
    • Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
    • Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
    • Multiple commits in the PR will be squashed by GerritBot.
  • The title and description of the GitHub PR are used to construct the final commit message.
    • Edit these as needed via the GitHub web interface (not via Gerrit or git).
    • You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
  • See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

@gopherbot
Copy link
Contributor

Message from Jacob Stewart:

Patch Set 4:

(4 comments)

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Cherry Mui:

Patch Set 4: Code-Review+2 Commit-Queue+1

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Go LUCI:

Patch Set 4:

Dry run: CV is trying the patch.

Bot data: {"action":"start","triggered_at":"2024-04-18T16:32:27Z","revision":"2766bebd7035d7ba443e8ae394f1b7fa682373d2"}

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Cherry Mui:

Patch Set 4: -Commit-Queue

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Go LUCI:

Patch Set 4:

This CL has passed the run

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Go LUCI:

Patch Set 4: LUCI-TryBot-Result+1

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Dmitri Shuralyov:

Patch Set 4: Code-Review+1

Please don’t reply on this GitHub thread. Visit golang.org/cl/576575.
After addressing review feedback, remember to publish your drafts!

gopherbot pushed a commit that referenced this pull request Apr 19, 2024
@cherrymui
syscall/js: allocate arg slices on stack for small numbers of args
104c293 
The existing implementation causes unnecessary heap allocations for
javascript syscalls: Call, Invoke, and New. The new change seeks to
hint the Go compiler to allocate arg slices with length <=16 to the
stack.

Original Work: CL 367045
- Calling a JavaScript function with 16 arguments or fewer will not
induce two additional heap allocations, at least with the current Go
compiler.
- Using syscall/js features with slices and strings of
statically-known length will not cause them to be escaped to the heap,
at least with the current Go compiler.
- The reduction in allocations has the additional benefit that the
garbage collector runs less often, blocking WebAssembly's one and only
thread less often.

Fixes #39740

Change-Id: I815047e1d4f8ada796318e2064d38d3e63f73098
GitHub-Last-Rev: 36df1b3
GitHub-Pull-Request: #66684
Reviewed-on: https://go-review.googlesource.com/c/go/+/576575
Reviewed-by: Cherry Mui <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>
@gopherbot
Copy link
Contributor

This PR is being closed because golang.org/cl/576575 has been merged.

@gopherbot gopherbot closed this Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

syscall/js: increase performance of Call, Invoke, and New by not allowing new slices to escape onto the heap
2 participants
@unitoftime @gopherbot