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.
Mastering @rustbot
9.
Walkthrough: a typical contribution
10.
Bug Fix Procedure
11.
Implementing new features
12.
Stability attributes
13.
Stabilizing Features
14.
Coding conventions
15.
Notification groups
❱
15.1.
ARM
15.2.
Cleanup Crew
15.3.
LLVM
15.4.
RISC-V
15.5.
Windows
16.
Licenses
High-level Compiler Architecture
17.
Prologue
18.
Overview of the Compiler
19.
The compiler source code
20.
Queries: demand-driven compilation
❱
20.1.
The Query Evaluation Model in Detail
20.2.
Incremental compilation
20.3.
Incremental compilation In Detail
20.4.
Debugging and Testing
20.5.
Profiling Queries
20.6.
Salsa
21.
Memory Management in Rustc
22.
Serialization in Rustc
23.
Parallel Compilation
24.
Rustdoc
Source Code Representation
25.
Prologue
26.
Command-line arguments
27.
The Rustc Driver and Interface
❱
27.1.
Ex: Type checking through rustc_interface
27.2.
Ex: Getting diagnostics through rustc_interface
28.
Syntax and the AST
❱
28.1.
Lexing and Parsing
28.2.
Macro expansion
28.3.
Name resolution
28.4.
#[test] Implementation
28.5.
Panic Implementation
28.6.
AST Validation
28.7.
Feature Gate Checking
29.
The HIR (High-level IR)
❱
29.1.
Lowering AST to HIR
29.2.
Debugging
30.
The MIR (Mid-level IR)
❱
30.1.
THIR and MIR construction
30.2.
MIR visitor and traversal
30.3.
MIR passes: getting the MIR for a function
31.
Identifiers in the Compiler
32.
Closure expansion
Analysis
33.
Prologue
34.
The ty module: representing types
❱
34.1.
Generics and substitutions
34.2.
TypeFolder and TypeFoldable
34.3.
Generic arguments
35.
Type inference
36.
Trait solving
❱
36.1.
Early and Late Bound Parameters
36.2.
Higher-ranked trait bounds
36.3.
Caching subtleties
36.4.
Specialization
36.5.
Chalk-based trait solving
❱
36.5.1.
Lowering to logic
36.5.2.
Goals and clauses
36.5.3.
Canonical queries
36.5.4.
Lowering module in rustc
37.
Type checking
❱
37.1.
Method Lookup
37.2.
Variance
37.3.
Opaque Types
38.
Pattern and Exhaustiveness Checking
39.
MIR dataflow
40.
The borrow checker
❱
40.1.
Tracking moves and initialization
❱
40.1.1.
Move paths
40.2.
MIR type checker
40.3.
Region inference
❱
40.3.1.
Constraint propagation
40.3.2.
Lifetime parameters
40.3.3.
Member constraints
40.3.4.
Placeholders and universes
40.3.5.
Closure constraints
40.3.6.
Error reporting
40.4.
Two-phase-borrows
41.
Parameter Environments
42.
Errors and Lints
❱
42.1.
LintStore
42.2.
Diagnostic Codes
MIR to Binaries
43.
Prologue
44.
MIR optimizations
45.
Debugging
46.
Constant evaluation
❱
46.1.
miri const evaluator
47.
Monomorphization
48.
Lowering MIR
49.
Code Generation
❱
49.1.
Updating LLVM
49.2.
Debugging LLVM
49.3.
Backend Agnostic Codegen
49.4.
Implicit Caller Location
50.
Profile-guided Optimization
51.
Sanitizers Support
52.
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
Reporting region errors
TODO: we should discuss how to generate errors from the results of these analyses.