About this guide
Getting Started
Building and debugging rustc
1.
How to Build and Run the Compiler
❱
1.1.
Prerequisites
1.2.
Suggested Workflows
1.3.
Bootstrapping
1.4.
Distribution artifacts
1.5.
Documenting Compiler
1.6.
Rustdoc
1.7.
ctags
1.8.
Adding a new target
2.
The compiler testing framework
❱
2.1.
Running tests
2.2.
Adding new tests
2.3.
Using compiletest commands to control test execution
3.
Debugging the Compiler
4.
Profiling the compiler
❱
4.1.
with the linux perf tool
5.
crates.io Dependencies
Contributing to Rust
6.
Introduction
7.
About the compiler team
8.
Using Git
9.
Mastering @rustbot
10.
Walkthrough: a typical contribution
11.
Bug Fix Procedure
12.
Implementing new features
13.
Stability attributes
14.
Stabilizing Features
15.
Coding conventions
16.
Notification groups
❱
16.1.
ARM
16.2.
Cleanup Crew
16.3.
LLVM
16.4.
RISC-V
16.5.
Windows
17.
Licenses
High-level Compiler Architecture
18.
Prologue
19.
Overview of the Compiler
20.
The compiler source code
21.
Queries: demand-driven compilation
❱
21.1.
The Query Evaluation Model in Detail
21.2.
Incremental compilation
21.3.
Incremental compilation In Detail
21.4.
Debugging and Testing
21.5.
Profiling Queries
21.6.
Salsa
22.
Memory Management in Rustc
23.
Serialization in Rustc
24.
Parallel Compilation
25.
Rustdoc
Source Code Representation
26.
Prologue
27.
Command-line arguments
28.
The Rustc Driver and Interface
❱
28.1.
Ex: Type checking through rustc_interface
28.2.
Ex: Getting diagnostics through rustc_interface
29.
Syntax and the AST
❱
29.1.
Lexing and Parsing
29.2.
Macro expansion
29.3.
Name resolution
29.4.
#[test] Implementation
29.5.
Panic Implementation
29.6.
AST Validation
29.7.
Feature Gate Checking
30.
The HIR (High-level IR)
❱
30.1.
Lowering AST to HIR
30.2.
Debugging
31.
The MIR (Mid-level IR)
❱
31.1.
THIR and MIR construction
31.2.
MIR visitor and traversal
31.3.
MIR passes: getting the MIR for a function
32.
Identifiers in the Compiler
33.
Closure expansion
Analysis
34.
Prologue
35.
The ty module: representing types
❱
35.1.
Generics and substitutions
35.2.
TypeFolder and TypeFoldable
35.3.
Generic arguments
36.
Type inference
37.
Trait solving
❱
37.1.
Early and Late Bound Parameters
37.2.
Higher-ranked trait bounds
37.3.
Caching subtleties
37.4.
Specialization
37.5.
Chalk-based trait solving
❱
37.5.1.
Lowering to logic
37.5.2.
Goals and clauses
37.5.3.
Canonical queries
37.5.4.
Lowering module in rustc
38.
Type checking
❱
38.1.
Method Lookup
38.2.
Variance
38.3.
Opaque Types
39.
Pattern and Exhaustiveness Checking
40.
MIR dataflow
41.
The borrow checker
❱
41.1.
Tracking moves and initialization
❱
41.1.1.
Move paths
41.2.
MIR type checker
41.3.
Region inference
❱
41.3.1.
Constraint propagation
41.3.2.
Lifetime parameters
41.3.3.
Member constraints
41.3.4.
Placeholders and universes
41.3.5.
Closure constraints
41.3.6.
Error reporting
41.4.
Two-phase-borrows
42.
Parameter Environments
43.
Errors and Lints
❱
43.1.
LintStore
43.2.
Diagnostic Codes
MIR to Binaries
44.
Prologue
45.
MIR optimizations
46.
Debugging
47.
Constant evaluation
❱
47.1.
miri const evaluator
48.
Monomorphization
49.
Lowering MIR
50.
Code Generation
❱
50.1.
Updating LLVM
50.2.
Debugging LLVM
50.3.
Backend Agnostic Codegen
50.4.
Implicit Caller Location
51.
Profile-guided Optimization
52.
Sanitizers Support
53.
Debugging Support in the Rust Compiler
Appendix A: Background topics
Appendix B: Glossary
Appendix C: Code Index
Appendix D: Compiler Lecture Series
Appendix E: Bibliography
Appendix Z: HumorRust
Light (default)
Rust
Coal
Navy
Ayu
Guide to Rustc Development
Feature Gate Checking
TODO
: this chapter