From b13943ed4227ac0b51aeb117aae1fa4793c11916 Mon Sep 17 00:00:00 2001 From: Gerson <71728860+Gerson2102@users.noreply.github.com> Date: Mon, 27 May 2024 10:08:20 -0600 Subject: [PATCH] adding more env vars (#523) --- Readme.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/Readme.md b/Readme.md index 607a16cc209..01b00273ccb 100644 --- a/Readme.md +++ b/Readme.md @@ -16,6 +16,10 @@ A secondary goal is to check if using the gcc backend will provide any run-time **rustup:** Follow the instructions on the official [website](https://www.rust-lang.org/tools/install) +**DejaGnu:** Consider to install DejaGnu which is necessary for running the libgccjit test suite. [website](https://www.gnu.org/software/dejagnu/#downloading) + + + ## Building **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 ## Env vars
-
CG_GCCJIT_INCR_CACHE_DISABLED
-
Don't cache object files in the incremental cache. Useful during development of cg_gccjit - to make it possible to use incremental mode for all analyses performed by rustc without caching - object files when their content should have been changed by a change to cg_gccjit.
-
CG_GCCJIT_DISPLAY_CG_TIME
-
Display the time it took to perform codegen for a crate
+
CG_GCCJIT_DUMP_ALL_MODULES
+
Enables dumping of all compilation modules. When set to "1", a dump is created for each module during compilation and stored in `/tmp/reproducers/`.
+
CG_GCCJIT_DUMP_MODULE
+
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/`.
CG_RUSTFLAGS
Send additional flags to rustc. Can be used to build the sysroot without unwinding by setting `CG_RUSTFLAGS=-Cpanic=abort`.
CG_GCCJIT_DUMP_TO_FILE
Dump a C-like representation to /tmp/gccjit_dumps and enable debug info in order to debug this C-like representation.
+
CG_GCCJIT_DUMP_RTL
+
Dumps RTL (Register Transfer Language) for virtual registers.
+
CG_GCCJIT_DUMP_RTL_ALL
+
Dumps all RTL passes.
+
CG_GCCJIT_DUMP_TREE_ALL
+
Dumps all tree (GIMPLE) passes.
+
CG_GCCJIT_DUMP_IPA_ALL
+
Dumps all Interprocedural Analysis (IPA) passes.
+
CG_GCCJIT_DUMP_CODE
+
Dumps the final generated code.
+
CG_GCCJIT_DUMP_GIMPLE
+
Dumps the initial GIMPLE representation.
+
CG_GCCJIT_DUMP_EVERYTHING
+
Enables dumping of all intermediate representations and passes.
+
CG_GCCJIT_KEEP_INTERMEDIATES
+
Keeps intermediate files generated during the compilation process.
+
CG_GCCJIT_VERBOSE
+
Enables verbose output from the GCC driver.
## Extra documentation