rustc-dev-guide/src/SUMMARY.md

Summary

About this guide

---

• Part 1: Building, debugging, and contributing to Rustc

  • Prerequisites
  • Getting Started
  • About the compiler team
  • How to Build and Run the Compiler
    • Prerequisites
    • Suggested Workflows
    • Bootstrapping
    • Distribution artifacts
    • Documenting Compiler
    • ctags
  • The compiler testing framework
    • Running tests
    • Adding new tests
    • Using compiletest + commands to control test execution
  • Walkthrough: a typical contribution
  • Bug Fix Procedure
  • Implementing new features
  • Stability attributes
  • Stabilizing Features
  • Debugging the Compiler
  • Profiling the compiler
    • with the linux perf tool
  • Coding conventions
  • crates.io Dependencies
  • Errors and Lints
    • LintStore
    • Diagnostic Codes
  • Notification groups
    • "Cleanup Crew"
    • LLVM
    • Windows
    • ARM
  • Licenses

• Part 2: High-level Compiler Architecture

  • Overview of the Compiler
  • The compiler source code
  • 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
  • Parallel Compilation

• Part 3: Source Code Representations

  • Command-line arguments
  • The Rustc Driver and Interface
    • Rustdoc
    • 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 MIR (Mid-level IR)
    • HAIR and MIR construction
    • MIR visitor and traversal
    • MIR passes: getting the MIR for a function
  • Closure expansion

• Part 4: Analysis

  • 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
      • Lowering module in rustc
  • Type checking
    • Method Lookup
    • Variance
    • Opaque Types
  • Pattern and Exhaustiveness Checking
  • 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

• Part 5: From MIR to binaries

  • The MIR (Mid-level IR)
    • MIR optimizations
    • Debugging
  • Constant evaluation
    • miri const evaluator
  • Monomorphization
  • Lowering MIR
  • Code Generation
    • Updating LLVM
    • Debugging LLVM
    • Backend Agnostic Codegen
    • Implicit Caller Location
  • Profile-guided Optimization
  • Sanitizers Support
  • 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

---