You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
-31Lines changed: 0 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,37 +26,6 @@ This repository is shipped with:
26
26
- A set of unit tests for the **FunctionCounter** pass using `llvm-lit` and `FileCheck` (see [Testing](#testing) section for more details).
27
27
- A benchmarking setup using `llvm-test-suite` to measure the performance impact of your pass (see [Benchmarking with llvm-test-suite](#benchmarking-with-llvm-test-suite) section for more details).
28
28
29
-
## Utility script: `x.sh`
30
-
31
-
This repository includes a utility script called `x.sh` that streamlines the most common build, test, and usage operations for the LLVM pass.
32
-
You can use this script from the root of the repository to quickly execute the main commands without having to remember all the manual instructions.
33
-
34
-
> [!NOTE]
35
-
> The script uses the `LLVM_DIR` environment variable to locate your LLVM installation. If `LLVM_DIR` is not set, it defaults to `~/dev/llvm-project/llvm-build`.
36
-
37
-
### Main available commands:
38
-
39
-
-`config` — configure the project with CMake for a debug build.
40
-
-`build` — build the project.
41
-
-`rebuild` — reconfigure and rebuild the project from scratch.
42
-
-`run <file.ll>` — run the pass on a specific LLVM IR file.
43
-
-`test` — run the test suite with `lit`.
44
-
-`pipeline [level]` — print the optimization pipeline (default: -O0).
45
-
-`inject <level> <file.ll>` — inject/replace the custom pass in an optimization pipeline.
46
-
-`emit-llvm <file.c> [level]` — generate LLVM IR from a C file (default: -O0).
47
-
-`clean` — clean the build directory.
48
-
-`help` — show the help message and list of commands.
49
-
50
-
For example, to configure, build, and test the project you can simply run:
51
-
52
-
```bash
53
-
./x.sh config
54
-
./x.sh build
55
-
./x.sh test
56
-
```
57
-
58
-
Run `./x.sh help` for the complete and detailed list of available commands.
59
-
60
29
## Building the pass
61
30
62
31
The [LLVM_INSTALLATION.md](LLVM_INSTALLATION.md) file includes detailed instructions on how to set up the system to have an LLVM 21 installation, and how to set the `LLVM_DIR` environment variable accordingly.
0 commit comments