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.
Distribution artifacts
1.4.
Documenting Compiler
1.5.
Rustdoc overview
1.6.
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
❱
3.1.
Using the tracing/logging instrumentation
4.
Profiling the compiler
❱
4.1.
with the linux perf tool
4.2.
with Windows Performance Analyzer
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.
Feature Gates
16.
Coding conventions
17.
Notification groups
❱
17.1.
ARM
17.2.
Cleanup Crew
17.3.
LLVM
17.4.
RISC-V
17.5.
Windows
18.
Licenses
High-level Compiler Architecture
19.
Prologue
20.
Overview of the Compiler
21.
The compiler source code
22.
Bootstrapping
23.
Queries: demand-driven compilation
❱
23.1.
The Query Evaluation Model in Detail
23.2.
Incremental compilation
23.3.
Incremental compilation In Detail
23.4.
Debugging and Testing
23.5.
Salsa
24.
Memory Management in Rustc
25.
Serialization in Rustc
26.
Parallel Compilation
27.
Rustdoc internals
Source Code Representation
28.
Prologue
29.
Command-line arguments
30.
The Rustc Driver and Interface
❱
30.1.
Ex: Type checking through rustc_interface
30.2.
Ex: Getting diagnostics through rustc_interface
31.
Syntax and the AST
❱
31.1.
Lexing and Parsing
31.2.
Macro expansion
31.3.
Name resolution
31.4.
#[test] Implementation
31.5.
Panic Implementation
31.6.
AST Validation
31.7.
Feature Gate Checking
31.8.
Lang Items
32.
The HIR (High-level IR)
❱
32.1.
Lowering AST to HIR
32.2.
Debugging
33.
The THIR (Typed High-level IR)
34.
The MIR (Mid-level IR)
❱
34.1.
MIR construction
34.2.
MIR visitor and traversal
34.3.
MIR passes: getting the MIR for a function
35.
Identifiers in the Compiler
36.
Closure expansion
Analysis
37.
Prologue
38.
The ty module: representing types
❱
38.1.
Generics and substitutions
38.2.
TypeFolder and TypeFoldable
38.3.
Generic arguments
38.4.
Constants in the type system
39.
Type inference
40.
Trait solving
❱
40.1.
Early and Late Bound Parameters
40.2.
Higher-ranked trait bounds
40.3.
Caching subtleties
40.4.
Specialization
40.5.
Chalk-based trait solving
❱
40.5.1.
Lowering to logic
40.5.2.
Goals and clauses
40.5.3.
Canonical queries
41.
Type checking
❱
41.1.
Method Lookup
41.2.
Variance
41.3.
Opaque Types
42.
Pattern and Exhaustiveness Checking
43.
MIR dataflow
44.
The borrow checker
❱
44.1.
Tracking moves and initialization
❱
44.1.1.
Move paths
44.2.
MIR type checker
44.3.
Region inference
❱
44.3.1.
Constraint propagation
44.3.2.
Lifetime parameters
44.3.3.
Member constraints
44.3.4.
Placeholders and universes
44.3.5.
Closure constraints
44.3.6.
Error reporting
44.4.
Two-phase-borrows
45.
Parameter Environments
46.
Errors and Lints
❱
46.1.
Creating Errors With SessionDiagnostic
46.2.
LintStore
46.3.
Diagnostic Codes
46.4.
Diagnostic Items
MIR to Binaries
47.
Prologue
48.
MIR optimizations
49.
Debugging
50.
Constant evaluation
❱
50.1.
miri const evaluator
51.
Monomorphization
52.
Lowering MIR
53.
Code Generation
❱
53.1.
Updating LLVM
53.2.
Debugging LLVM
53.3.
Backend Agnostic Codegen
53.4.
Implicit Caller Location
54.
Libraries and Metadata
55.
Profile-guided Optimization
56.
LLVM Source-Based Code Coverage
57.
Sanitizers Support
58.
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.