rustc_codegen_gcc: Progress Report #25
What is rustc_codegen_gcc?
rustc_codegen_gcc is a GCC ahead-of-time codegen for rustc, meaning that it can be loaded by the existing rustc frontend, but benefits from GCC by having more architectures supported and having access to GCC’s optimizations. It is not to be confused with gccrs, which is a GCC frontend for Rust.
GCC patches status
During the past 2 months, a lot of progress was made:
-
Add support for returns_twice attribute in libgccjit (thanks to GuillaumeGomez!)
-
Add pure attribute support in libgccjit (thanks to GuillaumeGomez!)
-
Add support for const attribute in libgccjit (thanks to GuillaumeGomez!)
-
Change the type of targetjitm to gcc_targetjitm (thanks to row454!)
-
Add support for restrict attribute on function parameters (and follow-up PR) (thanks to GuillaumeGomez!)
Only the last one was reviewed and merged in GCC upstream.
State of rustc_codegen_gcc
Here’s what has been done during the past 2 months:
-
Add support for "returns_twice" function attribute (thanks to GuillaumeGomez!)
-
Add support for "pure" function attribute (thanks to GuillaumeGomez!)
-
Extract a create_wrapper_function for use in allocator shim writing (thanks to bjorn3!)
-
Add support for "ffi_const" function attribute (thanks to GuillaumeGomez!)
-
Add instructions on how to generate GIMPLE format (thanks to GuillaumeGomez!)
-
Regenerate intrinsics (thanks to GuillaumeGomez!)
-
Add support for noalias function parameters (thanks to GuillaumeGomez!)
-
Fix command to run custom rustc (thanks to GuillaumeGomez!)
-
Add doc for sending patches to GCC (thanks to GuillaumeGomez!)
-
Rustify prepare.sh command (thanks to GuillaumeGomez!)
We accomplished quite a lot in the past two months and we finally got the support for Link-Time Optimization (LTO). LTO is not completely done yet, since there is an issue about some missing symbols when using proc-macros, but I merged the PR anyway since it works in most cases. I haven’t worked on ThinLTO yet: I don’t know if GCC has something that will be equivalent to LLVM’s ThinLTO.
The support for restrict
/noalias
brought a performance improvement of 3% in my test program.
Using hyperfine
to compare it against the same program compiled with the LLVM codegen, we are 3% slower (compared to 5% in last progress report), so we’re getter there.
As far as I know, adding the support for restrict
didn’t trigger any bugs in GCC, but that would probably require a crater run to make sure.
Next month, I plan to work on correctly handling the endianness for non-native 128-bit integers.
Here’s a rough summary of what has been implemented:
Feature | Last month completion | Completion | Delta |
---|---|---|---|
Unwinding. |
80% |
80% |
|
LTO. |
40% |
80% |
+40% |
More function and variable attributes. |
10% |
20% |
+10% |
Target features (to detect what is supported in an architecture, like SIMD). |
60% |
60% |
|
Thin LTO. |
0% |
||
Debug info. |
0% |
||
Endianness support for non-native 128-bit integers. |
0% |
||
Rustup distribution. |
0% |
||
SIMD for other architectures than x86-64. |
0% |
||
Support for new architectures in libraries (libc, object, …) and rustc. |
0% |
||
SIMD (x86-64). |
Done |
||
Basic and aggregate types. |
Done |
||
Operations, local and global variables, constants, functions, basic blocks. |
Done |
||
Atomics. |
Done |
||
Thread-local storage. |
Done |
||
Inline assembly. |
Done |
||
Many intrinsics. |
Done |
||
Metadata. |
Done |
||
Setting optimization level. |
Done |
||
Packed structures. |
Done |
||
Alignment, symbol visibility, attributes. |
Done |
||
128-bit integers. |
Done |
UI tests progress
Here are the results of running the UI tests in the CI:
-
https://github.com/rust-lang/rustc_codegen_gcc/actions/runs/6031856595/job/16366176936#step:20:1553
-
https://github.com/rust-lang/rustc_codegen_gcc/actions/runs/6031856595/job/16366177045#step:20:1565
-
https://github.com/rust-lang/rustc_codegen_gcc/actions/runs/6031856595/job/16366177161#step:20:6118 (failures)
Category | Last Month | This Month | Delta |
---|---|---|---|
Passed |
5352 |
5445 |
+93 |
Failed |
62 |
69 |
+7 |
(I removed the LTO tests from the failed row because those tests pass in the CI job where LTO is enabled.)
How to contribute
rustc_codegen_gcc
If you want to help on the project itself, please do the following:
-
Run the tests locally.
-
Choose a test that fails.
-
Investigate why it fails.
-
Fix the problem.
Even if you can’t fix the problem, your investigation could help, so if you enjoy staring at assembly code, have fun!
Crates and rustc
If you would like to contribute on adding support for Rust on
currently unsupported platforms, you can help by adding the support
for those platforms in some crates like libc
and object
and also
in the rust compiler itself.
Test this project
Otherwise, you can test this project on new platforms and also compare the assembly with LLVM to see if some optimization is missing.
Good first issue
Finally, another good way to help is to look at good first issues. Those are issues that should be easier to start with.
Thanks for your support!
I wanted to personally thank all the people that sponsor this project: your support is very much appreciated.
A special thanks to the following sponsors:
-
Futurewei
-
saethlin
-
embark-studios
-
Traverse-Research
-
Shnatsel
-
Rust Foundation
A big thank you to bjorn3 for his help, contributions and reviews. And a big thank you to lqd and GuillaumeGomez for answering my questions about rustc’s internals. Another big thank you to Commeownist for his contributions.
Also, a big thank you to the rest of my sponsors:
-
kpp
-
0x7CFE
-
repi
-
nevi-me
-
oleid
-
acshi
-
joshtriplett
-
djc
-
TimNN
-
sdroege
-
pcn
-
alanfalloon
-
steven-joruk
-
davidlattimore
-
colelawrence
-
zmanian
-
alexkirsz
-
berkus
-
belzael
-
yvt
-
Shoeboxam
-
yerke
-
bes
-
seanpianka
-
srijs
-
kkysen
-
riking
-
Lemmih
-
memoryruins
-
senden9
-
robjtede
-
Jonas Platte
-
spike grobstein
-
Oliver Marshall
-
Sam Harrington
-
Jonas
-
Jeff Muizelaar
-
Eugene Bulkin
-
Chris Butler
-
sierrafiveseven
-
Joseph Garvin
-
MarcoFalke
-
athre0z
-
icewind
-
Tommy Thorn
-
Sebastian Zivota
-
Oskar Nehlin
-
Nicolas Barbier
-
Daniel
-
Thomas Colliers
-
Justin Ossevoort
-
Chris
-
Bálint Horváth
-
kiyoshigawa
-
robinmoussu
-
Daniel Sheehan
-
Marvin Löbel
-
nacaclanga
-
Matthew Conolly
-
0x0177b11f
-
L.apz
-
JockeTF
-
davidcornu
-
stuhood
-
Myrik Lord
-
Mauve
-
icewind1991
-
T
-
nicholasbishop
-
Emily A. Bellows
-
David Vasak
-
Eric Driggers
-
Olaf Leidinger
-
UtherII
-
simonlindholm
-
lemmih
-
Eddddddd
-
rrbutani
-
Mateusz K
and a few others who preferred to stay anonymous.
Former sponsors/patreons:
-
igrr
-
finfet
-
Alovchin91
-
wezm
-
mexus
-
raymanfx
-
ghost
-
gilescope
-
olanod
-
Denis Zaletaev
-
Chai T. Rex
-
Paul Ellenbogen
-
Dakota Brink
-
Botlabs
-
Cass
-
Oliver Marshall
-
pthariensflame
-
tedbyron
-
sstadick
-
Absolucy
-
rafaelcaricio
-
dandxy89
-
luizirber
-
regiontog
-
vincentdephily
-
zebp
-
Hofer-Julian
-
messense
-
0xdeafbeef
-
fanquake
-
jam1garner
-
sbstp
-
evanrichter
-
Nehliin