About this guide
1.
Part 1: Building, debugging, and contributing to Rustc
❱
1.1.
About the compiler team
1.2.
How to Build and Run the Compiler
❱
1.2.1.
Suggested Workflows
1.2.2.
Bootstrapping
1.2.3.
Distribution artifacts
1.2.4.
Documenting Compiler
1.2.5.
ctags
1.3.
The compiler testing framework
❱
1.3.1.
Running tests
1.3.2.
Adding new tests
1.3.3.
Using compiletest + commands to control test execution
1.4.
Walkthrough: a typical contribution
1.5.
Bug Fix Procedure
1.6.
Implementing new features
1.7.
Stability attributes
1.8.
Stabilizing Features
1.9.
Debugging the Compiler
1.10.
Profiling the compiler
❱
1.10.1.
with the linux perf tool
1.11.
Coding conventions
1.12.
crates.io Dependencies
1.13.
Emitting Errors and other Diagnostics
❱
1.13.1.
LintStore
1.13.2.
Diagnostic Codes
1.14.
ICE-breaker teams
❱
1.14.1.
"Cleanup Crew" ICE-breakers
1.14.2.
LLVM ICE-breakers
1.15.
Licenses
2.
Part 2: High-level Compiler Architecture
❱
2.1.
Overview of the Compiler
2.2.
The compiler source code
2.3.
Queries: demand-driven compilation
❱
2.3.1.
The Query Evaluation Model in Detail
2.3.2.
Incremental compilation
2.3.3.
Incremental compilation In Detail
2.3.4.
Debugging and Testing
2.3.5.
Profiling Queries
2.3.6.
Salsa
2.4.
Memory Management in Rustc
2.5.
Parallel Compilation
3.
Part 3: Source Code Representations
❱
3.1.
Command-line arguments
3.2.
The Rustc Driver and Interface
❱
3.2.1.
Rustdoc
3.2.2.
Ex: Type checking through rustc_interface
3.2.3.
Ex: Getting diagnostics through rustc_interface
3.3.
Syntax and the AST
❱
3.3.1.
Lexing and Parsing
3.3.2.
Macro expansion
3.3.3.
Name resolution
3.3.4.
#[test] Implementation
3.3.5.
Panic Implementation
3.3.6.
AST Validation
3.3.7.
Feature Gate Checking
3.4.
The HIR (High-level IR)
❱
3.4.1.
Lowering AST to HIR
3.4.2.
Debugging
3.5.
The MIR (Mid-level IR)
❱
3.5.1.
HAIR and MIR construction
3.5.2.
MIR visitor and traversal
3.5.3.
MIR passes: getting the MIR for a function
3.6.
Closure expansion
4.
Part 4: Analysis
❱
4.1.
The ty module: representing types
❱
4.1.1.
Generics and substitutions
4.1.2.
TypeFolder and TypeFoldable
4.1.3.
Generic arguments
4.2.
Type inference
4.3.
Trait solving
❱
4.3.1.
Higher-ranked trait bounds
4.3.2.
Caching subtleties
4.3.3.
Specialization
4.3.4.
Chalk-based trait solving
❱
4.3.4.1.
Lowering to logic
4.3.4.2.
Goals and clauses
4.3.4.3.
Canonical queries
4.3.4.4.
Lowering module in rustc
4.4.
Type checking
❱
4.4.1.
Method Lookup
4.4.2.
Variance
4.4.3.
Opaque Types
4.5.
Pattern and Exhaustiveness Checking
4.6.
The borrow checker
❱
4.6.1.
Tracking moves and initialization
❱
4.6.1.1.
Move paths
4.6.2.
MIR type checker
4.6.3.
Region inference
❱
4.6.3.1.
Constraint propagation
4.6.3.2.
Lifetime parameters
4.6.3.3.
Member constraints
4.6.3.4.
Placeholders and universes
4.6.3.5.
Closure constraints
4.6.3.6.
Error reporting
4.6.4.
Two-phase-borrows
4.7.
Parameter Environments
5.
Part 5: From MIR to binaries
❱
5.1.
The MIR (Mid-level IR)
❱
5.1.1.
MIR optimizations
5.1.2.
Debugging
5.2.
Constant evaluation
❱
5.2.1.
miri const evaluator
5.3.
Monomorphization
5.4.
Lowering MIR
5.5.
Code Generation
❱
5.5.1.
Updating LLVM
5.5.2.
Debugging LLVM
5.5.3.
Backend Agnostic Codegen
5.5.4.
Implicit Caller Location
5.6.
Profile-guided Optimization
5.7.
Sanitizers Support
5.8.
Debugging Support in Rust Compiler
Appendix A: Background material
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