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
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.
Walkthrough: a typical contribution
9.
Bug Fix Procedure
10.
Implementing new features
11.
Stability attributes
12.
Stabilizing Features
13.
Coding conventions
14.
Notification groups
❱
14.1.
"Cleanup Crew"
14.2.
LLVM
14.3.
Windows
14.4.
ARM
15.
Licenses
High-level Compiler Architecture
16.
Prologue
17.
Overview of the Compiler
18.
The compiler source code
19.
Queries: demand-driven compilation
❱
19.1.
The Query Evaluation Model in Detail
19.2.
Incremental compilation
19.3.
Incremental compilation In Detail
19.4.
Debugging and Testing
19.5.
Profiling Queries
19.6.
Salsa
20.
Memory Management in Rustc
21.
Parallel Compilation
22.
Rustdoc
Source Code Representations
23.
Prologue
24.
Command-line arguments
25.
The Rustc Driver and Interface
❱
25.1.
Rustdoc
25.2.
Ex: Type checking through rustc_interface
25.3.
Ex: Getting diagnostics through rustc_interface
26.
Syntax and the AST
❱
26.1.
Lexing and Parsing
26.2.
Macro expansion
26.3.
Name resolution
26.4.
#[test] Implementation
26.5.
Panic Implementation
26.6.
AST Validation
26.7.
Feature Gate Checking
27.
The HIR (High-level IR)
❱
27.1.
Lowering AST to HIR
27.2.
Debugging
28.
The MIR (Mid-level IR)
❱
28.1.
HAIR and MIR construction
28.2.
MIR visitor and traversal
28.3.
MIR passes: getting the MIR for a function
29.
Closure expansion
Analysis
30.
Prologue
31.
The ty module: representing types
❱
31.1.
Generics and substitutions
31.2.
TypeFolder and TypeFoldable
31.3.
Generic arguments
32.
Type inference
33.
Trait solving
❱
33.1.
Early and Late Bound Parameters
33.2.
Higher-ranked trait bounds
33.3.
Caching subtleties
33.4.
Specialization
33.5.
Chalk-based trait solving
❱
33.5.1.
Lowering to logic
33.5.2.
Goals and clauses
33.5.3.
Canonical queries
33.5.4.
Lowering module in rustc
34.
Type checking
❱
34.1.
Method Lookup
34.2.
Variance
34.3.
Opaque Types
35.
Pattern and Exhaustiveness Checking
36.
The borrow checker
❱
36.1.
Tracking moves and initialization
❱
36.1.1.
Move paths
36.2.
MIR type checker
36.3.
Region inference
❱
36.3.1.
Constraint propagation
36.3.2.
Lifetime parameters
36.3.3.
Member constraints
36.3.4.
Placeholders and universes
36.3.5.
Closure constraints
36.3.6.
Error reporting
36.4.
Two-phase-borrows
37.
Parameter Environments
38.
Errors and Lints
❱
38.1.
LintStore
38.2.
Diagnostic Codes
MIR to Binaries
39.
Prologue
40.
The MIR (Mid-level IR)
❱
40.1.
MIR optimizations
40.2.
Debugging
41.
Constant evaluation
❱
41.1.
miri const evaluator
42.
Monomorphization
43.
Lowering MIR
44.
Code Generation
❱
44.1.
Updating LLVM
44.2.
Debugging LLVM
44.3.
Backend Agnostic Codegen
44.4.
Implicit Caller Location
45.
Profile-guided Optimization
46.
Sanitizers Support
47.
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
Reporting region errors
TODO: we should discuss how to generate errors from the results of these analyses.