Verilator User’s Guide

Getting Started

• Overview
• Examples
• Installation
  • Package Manager Quick Install
  • pre-commit Quick Install
  • Git Quick Install
  • Detailed Build Instructions
  • Verilator Build Docker Container
  • Verilator Executable Docker Container
• CMake Installation
  • Quick Install
  • Usage
  • Example

User's Guide

• Verilating
  • Binary, C++ and SystemC Generation
  • Hierarchical Verilation
  • Cross Compilation
  • Multithreading
  • GNU Make
  • CMake
  • Verilation Summary Report
• Connecting to Verilated Models
  • Structure of the Verilated Model
  • Connecting to C++
  • Connecting to SystemC
  • Verilated API
  • Direct Programming Interface (DPI)
  • Verification Procedural Interface (VPI)
  • Wrappers and Model Evaluation Loop
  • Verilated and VerilatedContext
• Simulating (Verilated-Model Runtime)
  • Simulation Summary Report
  • Benchmarking & Optimization
  • Coverage Analysis
  • Code Profiling
  • Execution Profiling
  • Profiling ccache efficiency
  • Save/Restore
  • Profile-Guided Optimization
  • Runtime Debugging
• Contributing and Reporting Bugs
  • Announcements
  • Reporting Bugs
  • Minimizing bug-inducing code
  • Contributing to Verilator
• FAQ/Frequently Asked Questions
  • Questions

Reference Guide

• Input Languages
• Language Extensions
• Executable and Argument Reference
• Errors and Warnings
• Files
• Environment
• Make Variables
• Deprecations
• Contributors and Origins
• Revision History
• Copyright