Skip to content

Commit 37d8183

Browse files
committed
fixup! [SandboxVec][Doc] Add documentation for the Sandbox Vectorizer
1 parent 75287f3 commit 37d8183

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

llvm/docs/SandboxVectorizer.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The `Seed Collection Pass` itself contains its own Region pass pipeline, which i
4040
```
4141
┌────────────────────────────────── Sandbox Vectorizer LLVM Function Pass ─────────────────────────────┐
4242
│ │
43-
│ ┌───────┐ ┌────────────────────────── sanboxir::Function Pass Manager ────────────────────────────┐ │
43+
│ ┌───────┐ ┌────────────────────────── sandboxir::Function Pass Manager ────────────────────────────┐ │
4444
│ │ │ │ │ │
4545
│ │ │ │ ┌────────────────────────────── Seed Collection Pass ──────────────────────────────┐ │ │
4646
│ │ │ │ │ │ │ │
@@ -89,7 +89,8 @@ There are two types of passes: [Transformation Passes](#transformation-passes) t
8989
| `tr-accept` | TransactionAlwaysAccept.h | Region | Unconditionally accepts the IR state |
9090
| `tr-revert` | TransactionAlwaysRevert.h | Region | Unconditionally rejects the IR state |
9191
| `tr-accept-or-revert` | TransactionAcceptOrRevert.h | Region | Checks cost model and either accepts or reverts the IR |
92-
| `null` | NullPass.h | Region | A test pass that prints the region instructions |
92+
| `null` | NullPass.h | Region | A dummy test pass that just returns |
93+
| `print-region` | PrintRegion.h | Region | A test pass that prints the region's IR |
9394
| `print-instruction-count` | PrintInstructionCount.h | Region | A test pass that counts instructions |
9495
| `regions-from-metadata` | RegionsFromMetadata.h | Function | Builds regions from IR metadata and runs a pipeline of region passes for each one of them. Used in lit tests for testing region passes in isolation |
9596
| `regions-from-bbs` | RegionsFromBBs.h | Function | Builds a region for each BB, adding all BB instructions into each region. Used in lit tests for stress-testing region passes in isolation |
@@ -185,7 +186,7 @@ The auxiliary vector is currently used by the Seed Collection pass to communicat
185186

186187
One of the great things about the Sandbox Vectorizer is that it allows you to test each internal pass in isolation with lit-tests.
187188

188-
Testing Function passes are straightforward, just run `FUNCTION_PASS` in isolation with `-sbvec-passes`, like so:
189+
Testing Function passes is straightforward, just run `FUNCTION_PASS` in isolation with `-sbvec-passes`, like so:
189190
```shell
190191
$ opt -p=sandbox-vectorizer -sbvec-passes='FUNCTION_PASS'
191192
```

0 commit comments

Comments
 (0)