.. Github doesn't render images unless absolute URL .. Do not know of a conditional tag, "only: github" nor "github display" works

.. image:: https://img.shields.io/badge/License-LGPL%20v3-blue.svg :target: https://www.gnu.org/licenses/lgpl-3.0] .. image:: https://img.shields.io/badge/License-Artistic%202.0-0298c3.svg :target: https://opensource.org/licenses/Artistic-2.0 .. image:: https://repology.org/badge/tiny-repos/verilator.svg?header=distro%20packages :target: https://repology.org/project/verilator/versions .. image:: https://api.codacy.com/project/badge/Grade/fa78caa433c84a4ab9049c43e9debc6f :target: https://www.codacy.com/gh/verilator/verilator .. image:: https://codecov.io/gh/verilator/verilator/branch/master/graph/badge.svg :target: https://codecov.io/gh/verilator/verilator .. image:: https://github.com/verilator/verilator/workflows/build/badge.svg :target: https://github.com/verilator/verilator/actions?query=workflow%3Abuild

Welcome to Verilator

.. list-table::

- Welcome to Verilator, the fastest Verilog/SystemVerilog simulator.
  - Accepts synthesizable Verilog or SystemVerilog
  - Performs lint code-quality checks
  - Compiles into multithreaded C++, or SystemC
  - Creates XML to front-end your own tools
  - |Logo|
- |verilator multithreaded performance|
  - Fast
  - Outperforms many commercial simulators
  - Single- and multi-threaded output models
- Widely Used
  - Wide industry and academic deployment
  - Out-of-the-box support from Arm, and RISC-V vendor IP
  - |verilator usage|
- |verilator community|
  - Community Driven & Openly Licensed
  - Guided by the CHIPS Alliance and Linux Foundation
  - Open, and free as in both speech and beer
  - More simulation for your verification budget
- Commercial Support Available
  - Commercial support contracts
  - Design support contracts
  - Enhancement contracts
  - |verilator support|

What Verilator Does

Verilator is invoked with parameters similar to GCC or Synopsys's VCS. It "Verilates" the specified Verilog or SystemVerilog code by reading it, performing lint checks, and optionally inserting assertion checks and coverage-analysis points. It outputs single- or multi-threaded .cpp and .h files, the "Verilated" code.

The user writes a little C++/SystemC wrapper file, which instantiates the "Verilated" model of the user's top level module. These C++/SystemC files are then compiled by a C++ compiler (gcc/clang/MSVC++). The resulting executable performs the design simulation. Verilator also supports linking its generated libraries, optionally encrypted, into other simulators.

Verilator may not be the best choice if you are expecting a full featured replacement for NC-Verilog, VCS or another commercial Verilog simulator, or if you are looking for a behavioral Verilog simulator e.g. for a quick class project (we recommend Icarus Verilog_ for this.) However, if you are looking for a path to migrate SystemVerilog to C++ or SystemC, or your team is comfortable writing just a touch of C++ code, Verilator is the tool for you.

Performance

Verilator does not simply convert Verilog HDL to C++ or SystemC. Rather, Verilator compiles your code into a much faster optimized and optionally thread-partitioned model, which is in turn wrapped inside a C++/SystemC module. The results are a compiled Verilog model that executes even on a single-thread over 10x faster than standalone SystemC, and on a single thread is about 100 times faster than interpreted Verilog simulators such as Icarus Verilog_. Another 2-10x speedup might be gained from multithreading (yielding 200-1000x total over interpreted simulators).

Verilator has typically similar or better performance versus the closed-source Verilog simulators (Carbon Design Systems Carbonator, Modelsim, Cadence Incisive/NC-Verilog, Synopsys VCS, VTOC, and Pragmatic CVer/CVC). But, Verilator is open-sourced, so you can spend on computes rather than licenses. Thus Verilator gives you the best cycles/dollar.

Installation & Documentation

For more information:

Verilator installation and package directory structure <https://verilator.org/install>_
Verilator manual (HTML) <https://verilator.org/verilator_doc.html>_, or Verilator manual (PDF) <https://verilator.org/verilator_doc.pdf>_
Subscribe to verilator announcements <https://github.com/verilator/verilator-announce>_
Verilator forum <https://verilator.org/forum>_
Verilator issues <https://verilator.org/issues>_

Support

Verilator is a community project, guided by the CHIPS Alliance under the Linux Foundation.

We appreciate and welcome your contributions in whatever form; please see Contributing to Verilator <https://github.com/verilator/verilator/blob/master/docs/CONTRIBUTING.rst>. Thanks to our Contributors and Sponsors <https://verilator.org/guide/latest/contributors.html>.

Verilator also supports and encourages commercial support models and organizations; please see Verilator Commercial Support <https://verilator.org/verilator_commercial_support>_.

Related Projects

GTKwave <http://gtkwave.sourceforge.net/>_ - Waveform viewer for Verilator traces.
Icarus Verilog_ - Icarus is a full featured interpreted Verilog simulator. If Verilator does not support your needs, perhaps Icarus may.

Open License

Verilator is free software; you can redistribute it and/or modify it under the terms of either the GNU Lesser General Public License Version 3 or the Perl Artistic License Version 2.0. See the documentation for more details.

.. _CHIPS Alliance: https://chipsalliance.org .. _Icarus Verilog: http://iverilog.icarus.com .. _Linux Foundation: https://www.linuxfoundation.org .. |Logo| image:: https://www.veripool.org/img/verilator_256_200_min.png .. |verilator multithreaded performance| image:: https://www.veripool.org/img/verilator_multithreaded_performance_bg-min.png .. |verilator usage| image:: https://www.veripool.org/img/verilator_usage_400x200-min.png .. |verilator community| image:: https://www.veripool.org/img/verilator_community_400x125-min.png .. |verilator support| image:: https://www.veripool.org/img/verilator_support_400x125-min.png

antmicro / verilator-old-archived