rustc-dev-guide/src/SUMMARY.md

Summary

About this guide

Getting Started

---

Building and debugging rustc

• How to Build and Run the Compiler
  • Prerequisites
  • Suggested Workflows
  • Distribution artifacts
  • Documenting Compiler
  • Rustdoc overview
  • ctags
  • Adding a new target
• The compiler testing framework
  • Running tests
  • Adding new tests
  • Using compiletest commands to control test execution
• Debugging the Compiler
• Profiling the compiler
  • with the linux perf tool
  • with Windows Performance Analyzer
• crates.io Dependencies

Contributing to Rust

• Introduction
• About the compiler team
• Using Git
• Mastering @rustbot
• Walkthrough: a typical contribution
• Bug Fix Procedure
• Implementing new features
• Stability attributes
• Stabilizing Features
• Feature Gates
• Coding conventions
• Notification groups
  • ARM
  • Cleanup Crew
  • LLVM
  • RISC-V
  • Windows
• Licenses

High-level Compiler Architecture

• Prologue
• Overview of the Compiler
• The compiler source code
• Bootstrapping
• Queries: demand-driven compilation
  • The Query Evaluation Model in Detail
  • Incremental compilation
  • Incremental compilation In Detail
  • Debugging and Testing
  • Profiling Queries
  • Salsa
• Memory Management in Rustc
• Serialization in Rustc
• Parallel Compilation
• Rustdoc internals

Source Code Representation

• Prologue
• Command-line arguments
• The Rustc Driver and Interface
  • Ex: Type checking through rustc_interface
  • Ex: Getting diagnostics through rustc_interface
• Syntax and the AST
  • Lexing and Parsing
  • Macro expansion
  • Name resolution
  • #[test] Implementation
  • Panic Implementation
  • AST Validation
  • Feature Gate Checking
• The HIR (High-level IR)
  • Lowering AST to HIR
  • Debugging
• The THIR (Typed High-level IR)
• The MIR (Mid-level IR)
  • MIR construction
  • MIR visitor and traversal
  • MIR passes: getting the MIR for a function
• Identifiers in the Compiler
• Closure expansion

Analysis

• Prologue
• The ty module: representing types
  • Generics and substitutions
  • TypeFolder and TypeFoldable
  • Generic arguments
• Type inference
• Trait solving
  • Early and Late Bound Parameters
  • Higher-ranked trait bounds
  • Caching subtleties
  • Specialization
  • Chalk-based trait solving
    • Lowering to logic
    • Goals and clauses
    • Canonical queries
• Type checking
  • Method Lookup
  • Variance
  • Opaque Types
• Pattern and Exhaustiveness Checking
• MIR dataflow
• The borrow checker
  • Tracking moves and initialization
    • Move paths
  • MIR type checker
  • Region inference
    • Constraint propagation
    • Lifetime parameters
    • Member constraints
    • Placeholders and universes
    • Closure constraints
    • Error reporting
  • Two-phase-borrows
• Parameter Environments
• Errors and Lints
  • Creating Errors With SessionDiagnostic
  • LintStore
  • Diagnostic Codes

MIR to Binaries

• Prologue
• MIR optimizations
• Debugging
• Constant evaluation
  • miri const evaluator
• Monomorphization
• Lowering MIR
• Code Generation
  • Updating LLVM
  • Debugging LLVM
  • Backend Agnostic Codegen
  • Implicit Caller Location
• Libraries and Metadata
• Profile-guided Optimization
• LLVM Source-Based Code Coverage
• Sanitizers Support
• 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

---