Developer Guide

• Contribution Guidelines
  • Common Scenarios
    • I have a question
    • I found a bug!
    • It would be great if VTR supported …
    • I have a bug-fix/feature I’d like to include in VTR
  • The Details
    • Enhancing Documentation
    • How do I build the documentation?
    • Filling Bug Reports
    • Filling Enhancement Requests
    • Submitting Code to VTR
    • Making Pull Requests
• Commit Procedures
• Commit Messages and Structure
  • Commit Messages
  • Commit Structure
• Code Formatting
  • Large Scale Reformatting
  • Python Linting
• Running Tests
  • Tests
    • vtr_reg_basic
    • vtr_reg_strong
    • vtr_reg_nightly_test1-N
    • vtr_reg_weekly
  • Running in a large cluster using SLURM
  • Continuous integration (CI)
    • Re-run CI Tests
  • Odin Functionality Tests
  • Unit Tests
    • Running Individual Testers
• Evaluating Quality of Result (QoR) Changes
  • General QoR Evaluation Principles
    • Key QoR Metrics
    • Benchmark Selection
    • Fairly measuring tool run-time
  • Collecting QoR Measurements
    • Example: VTR Benchmarks QoR Measurement
    • Example: Titan Benchmarks QoR Measurement
      • Running and Integrating the Titan Benchmarks with VTR
    • Example: NoC Benchmarks QoR Measurements
      • Running and Integrating the NoC Benchmarks with VTR
    • Example: Koios Benchmarks QoR Measurement
    • Example: Extracting QoR Data from CI Runs
  • Comparing QoR Measurements
    • QoR Comparison Gotchas
    • Example QoR Comparison
    • Automated QoR Comparison Script
    • Generating New QoR Golden Result
• Adding Tests
  • Adding a test to vtr_reg_strong
  • Creating Unit Tests
    • Example: Creating and Running a VPR Test Case
• Debugging Aids
  • Basic
  • Sanitizers
  • Valgrind
  • Assertion Levels
  • GDB Pretty Printers
    • STL Pretty Printers
    • VTR Pretty Printers
  • RR (Record Replay) Debugger
• Speeding up the edit-compile-test cycle
• Speeding Compilation
• Profiling VTR
  • Use GNU Profiler gprof
  • Use Linux Perf Tool
• External Subtrees
  • Updating an existing Subtree
    • External Ref Does Not Change
    • External Ref Changes
  • Adding a new Subtree
  • Pushing VTR Changes Back to Upstream Subtree
  • Tutorial: Syncing Tatum with VTR
  • Subtree Rationale
• Finding Bugs with Coverity
  • Browsing Defects
  • Submitting a build
  • No files emitted
• Release Procedures
  • General Principles
  • Checklist
• Sphinx API Documentation for C/C++ Projects
  • Create Doxyfile
  • Breathe Configuration
  • Create RST with API Documentation
  • Generate the Documentation
• Documenting VTR Code with Doxygen
  • Documenting Code
    • Block Comments
    • One-line Comments Before an Element
    • One-line Comments After an Element Member
  • Documenting Files
  • Validation of Doxygen Comments (Updating API Reference)
  • Additional Resources
• Developer Tutorials
  • New Developer Tutorial
    • Overview
    • Environment Setup
    • Background Reading
    • Setup VTR
    • Use VTR
    • Open the Black Box
    • Submitting Changes and Regression Testing
  • Timing Graph Debugging Tutorial
    • Generating a GraphViz DOT file of the Entire Timing Graph
    • Generating a GraphViz DOT file of a subset of the Timing Graph
    • Cross-referencing Node IDs with VPR Timing Reports
  • VPR UI and Graphics
• VTR Support Resources
• VTR License