Skip to content

Commit b13943e

Browse files
authored
adding more env vars (#523)
1 parent d7c8e0f commit b13943e

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

Readme.md

+26-6
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ A secondary goal is to check if using the gcc backend will provide any run-time
1616

1717
**rustup:** Follow the instructions on the official [website](https://www.rust-lang.org/tools/install)
1818

19+
**DejaGnu:** Consider to install DejaGnu which is necessary for running the libgccjit test suite. [website](https://www.gnu.org/software/dejagnu/#downloading)
20+
21+
22+
1923
## Building
2024

2125
**This requires a patched libgccjit in order to work.
@@ -143,16 +147,32 @@ $ LIBRARY_PATH="[gcc-path value]" LD_LIBRARY_PATH="[gcc-path value]" rustc +$(ca
143147
## Env vars
144148

145149
<dl>
146-
<dt>CG_GCCJIT_INCR_CACHE_DISABLED</dt>
147-
<dd>Don't cache object files in the incremental cache. Useful during development of cg_gccjit
148-
to make it possible to use incremental mode for all analyses performed by rustc without caching
149-
object files when their content should have been changed by a change to cg_gccjit.</dd>
150-
<dt>CG_GCCJIT_DISPLAY_CG_TIME</dt>
151-
<dd>Display the time it took to perform codegen for a crate</dd>
150+
<dt>CG_GCCJIT_DUMP_ALL_MODULES</dt>
151+
<dd>Enables dumping of all compilation modules. When set to "1", a dump is created for each module during compilation and stored in `/tmp/reproducers/`.</dd>
152+
<dt>CG_GCCJIT_DUMP_MODULE</dt>
153+
<dd>Enables dumping of a specific module. When set with the module name, e.g., `CG_GCCJIT_DUMP_MODULE=module_name`, a dump of that specific module is created in `/tmp/reproducers/`.</dd>
152154
<dt>CG_RUSTFLAGS</dt>
153155
<dd>Send additional flags to rustc. Can be used to build the sysroot without unwinding by setting `CG_RUSTFLAGS=-Cpanic=abort`.</dd>
154156
<dt>CG_GCCJIT_DUMP_TO_FILE</dt>
155157
<dd>Dump a C-like representation to /tmp/gccjit_dumps and enable debug info in order to debug this C-like representation.</dd>
158+
<dt>CG_GCCJIT_DUMP_RTL</dt>
159+
<dd>Dumps RTL (Register Transfer Language) for virtual registers.</dd>
160+
<dt>CG_GCCJIT_DUMP_RTL_ALL</dt>
161+
<dd>Dumps all RTL passes.</dd>
162+
<dt>CG_GCCJIT_DUMP_TREE_ALL</dt>
163+
<dd>Dumps all tree (GIMPLE) passes.</dd>
164+
<dt>CG_GCCJIT_DUMP_IPA_ALL</dt>
165+
<dd>Dumps all Interprocedural Analysis (IPA) passes.</dd>
166+
<dt>CG_GCCJIT_DUMP_CODE</dt>
167+
<dd>Dumps the final generated code.</dd>
168+
<dt>CG_GCCJIT_DUMP_GIMPLE</dt>
169+
<dd>Dumps the initial GIMPLE representation.</dd>
170+
<dt>CG_GCCJIT_DUMP_EVERYTHING</dt>
171+
<dd>Enables dumping of all intermediate representations and passes.</dd>
172+
<dt>CG_GCCJIT_KEEP_INTERMEDIATES</dt>
173+
<dd>Keeps intermediate files generated during the compilation process.</dd>
174+
<dt>CG_GCCJIT_VERBOSE</dt>
175+
<dd>Enables verbose output from the GCC driver.</dd>
156176
</dl>
157177

158178
## Extra documentation

0 commit comments

Comments
 (0)