[SandboxVec][Doc] Add documentation for the Sandbox Vectorizer #133504
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
slackito
approved these changes
Mar 29, 2025
llvm/docs/SandboxVectorizer.md
Outdated
| ``` | ||
| ┌────────────────────────────────── Sandbox Vectorizer LLVM Function Pass ─────────────────────────────┐ | ||
| │ │ | ||
| │ ┌───────┐ ┌────────────────────────── sanboxir::Function Pass Manager ─────────────────────────────┐ │ |
llvm/docs/SandboxVectorizer.md
Outdated
| | `tr-accept` | TransactionAlwaysAccept.h | Region | Unconditionally accepts the IR state | | ||
| | `tr-revert` | TransactionAlwaysRevert.h | Region | Unconditionally rejects the IR state | | ||
| | `tr-accept-or-revert` | TransactionAcceptOrRevert.h | Region | Checks cost model and either accepts or reverts the IR | | ||
| | `null` | NullPass.h | Region | A test pass that prints the region instructions | |
llvm/docs/SandboxVectorizer.md
Outdated
|
|
||
| One of the great things about the Sandbox Vectorizer is that it allows you to test each internal pass in isolation with lit-tests. | ||
|
|
||
| Testing Function passes are straightforward, just run `FUNCTION_PASS` in isolation with `-sbvec-passes`, like so: |
There was a problem hiding this comment.
Should be "Testing Function passes is straightforward".
vporpo
commented
Mar 29, 2025
llvm/docs/SandboxVectorizer.md
Outdated
| ``` | ||
| ┌────────────────────────────────── Sandbox Vectorizer LLVM Function Pass ─────────────────────────────┐ | ||
| │ │ | ||
| │ ┌───────┐ ┌────────────────────────── sanboxir::Function Pass Manager ─────────────────────────────┐ │ |
llvm/docs/SandboxVectorizer.md
Outdated
| | `tr-accept` | TransactionAlwaysAccept.h | Region | Unconditionally accepts the IR state | | ||
| | `tr-revert` | TransactionAlwaysRevert.h | Region | Unconditionally rejects the IR state | | ||
| | `tr-accept-or-revert` | TransactionAcceptOrRevert.h | Region | Checks cost model and either accepts or reverts the IR | | ||
| | `null` | NullPass.h | Region | A test pass that prints the region instructions | |
There was a problem hiding this comment.
Good catch! Fixed.
I also added one line for #131019
llvm/docs/SandboxVectorizer.md
Outdated
|
|
||
| One of the great things about the Sandbox Vectorizer is that it allows you to test each internal pass in isolation with lit-tests. | ||
|
|
||
| Testing Function passes are straightforward, just run `FUNCTION_PASS` in isolation with `-sbvec-passes`, like so: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.