SUMMARY.md

Summary

About this guide

---

• Part 1: Building, debugging, and contributing to Rustc
  • About the compiler team
  • How to Build and Run the Compiler
    • 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
  • Emitting Errors and other Diagnostics
    • LintStore
    • Diagnostic Codes
  • ICE-breaker teams
    • "Cleanup Crew" ICE-breakers
    • LLVM ICE-breakers
  • Licenses
• Part 2: How rustc works
  • Overview of rustc
  • High-level overview of the compiler source
  • The Rustc Driver and Interface
    • Rustdoc
    • Ex: Type checking through rustc_interface
  • 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
  • Lexing and Parsing
  • #[test] Implementation
  • Panic Implementation
  • Macro expansion
  • Name resolution
  • The HIR (High-level IR)
    • Lowering AST to HIR
    • Debugging
  • Closure expansion
  • The ty module: representing types
    • Generics and substitutions
    • TypeFolder and TypeFoldable
    • Generic arguments
  • Type inference
  • Trait solving (old-style)
    • Higher-ranked trait bounds
    • Caching subtleties
    • Specialization
  • Trait solving (new-style)
    • Lowering to logic
      • Goals and clauses
      • Equality and associated types
      • Implied bounds
      • Region constraints
      • The lowering module in rustc
      • Lowering rules
      • Well-formedness checking
    • Canonical queries
      • Canonicalization
    • The SLG solver
    • An Overview of Chalk
    • Bibliography
  • Type checking
    • Method Lookup
    • Variance
    • Opaque Types
  • The MIR (Mid-level IR)
    • MIR construction
    • MIR visitor and traversal
    • MIR passes: getting the MIR for a function
    • MIR optimizations
    • Debugging
  • 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
  • Constant evaluation
    • miri const evaluator
  • Parameter Environments
  • Compiler Backend
    • 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: Stupid Stats Appendix B: Background material Appendix C: Glossary Appendix D: Code Index Appendix E: Compiler Lecture Series Appendix F: Bibliography

Appendix Z: HumorRust

---