Merge from master for release.

This commit is contained in:
Wilson Snyder 2026-01-01 07:32:37 -05:00
commit 7e7b6d7fb8
1557 changed files with 188625 additions and 36019 deletions

View File

@ -1,7 +1,7 @@
--- ---
# DESCRIPTION: codecov.io config # DESCRIPTION: codecov.io config
# #
# Copyright 2020-2025 by Wilson Snyder. This program is free software; you # Copyright 2020-2026 by Wilson Snyder. This program is free software; you
# can redistribute it and/or modify it under the terms of either the GNU # 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 # Lesser General Public License Version 3 or the Perl Artistic License
# Version 2.0. # Version 2.0.

View File

@ -138,11 +138,11 @@ jobs:
CCACHE_DIR: ${{ github.workspace }}/.ccache CCACHE_DIR: ${{ github.workspace }}/.ccache
CCACHE_LIMIT_MULTIPLE: 0.95 CCACHE_LIMIT_MULTIPLE: 0.95
steps: steps:
- uses: actions/checkout@v5 - uses: actions/checkout@v6
with: with:
path: repo path: repo
- name: Cache $CCACHE_DIR - name: Cache $CCACHE_DIR
uses: actions/cache@v4 uses: actions/cache@v5
with: with:
path: ${{ env.CCACHE_DIR }} path: ${{ env.CCACHE_DIR }}
key: msbuild-msvc-cmake key: msbuild-msvc-cmake
@ -155,7 +155,7 @@ jobs:
- name: Zip up repository - name: Zip up repository
run: Compress-Archive -LiteralPath install -DestinationPath verilator.zip run: Compress-Archive -LiteralPath install -DestinationPath verilator.zip
- name: Upload zip archive - name: Upload zip archive
uses: actions/upload-artifact@v5 uses: actions/upload-artifact@v6
with: with:
path: ${{ github.workspace }}/repo/verilator.zip path: ${{ github.workspace }}/repo/verilator.zip
name: verilator-win.zip name: verilator-win.zip

View File

@ -16,5 +16,5 @@ jobs:
name: "'docs/CONTRIBUTORS' was signed" name: "'docs/CONTRIBUTORS' was signed"
runs-on: ubuntu-24.04 runs-on: ubuntu-24.04
steps: steps:
- uses: actions/checkout@v5 - uses: actions/checkout@v6
- run: test_regress/t/t_dist_contributors.py - run: test_regress/t/t_dist_contributors.py

View File

@ -74,10 +74,10 @@ jobs:
runs-on: ubuntu-24.04 runs-on: ubuntu-24.04
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v5 uses: actions/checkout@v6
- name: Download code coverage data - name: Download code coverage data
uses: actions/download-artifact@v6 uses: actions/download-artifact@v7
with: with:
pattern: code-coverage-* pattern: code-coverage-*
path: obj_coverage path: obj_coverage
@ -113,7 +113,7 @@ jobs:
sudo apt install lcov sudo apt install lcov
- name: Download repository archive - name: Download repository archive
uses: actions/download-artifact@v6 uses: actions/download-artifact@v7
with: with:
name: ${{ needs.build.outputs.archive }} name: ${{ needs.build.outputs.archive }}
path: ${{ github.workspace }} path: ${{ github.workspace }}
@ -124,7 +124,7 @@ jobs:
ls -lsha ls -lsha
- name: Download code coverage data - name: Download code coverage data
uses: actions/download-artifact@v6 uses: actions/download-artifact@v7
with: with:
pattern: code-coverage-* pattern: code-coverage-*
path: repo/obj_coverage path: repo/obj_coverage
@ -169,14 +169,14 @@ jobs:
fi fi
- name: Upload report - name: Upload report
uses: actions/upload-artifact@v5 uses: actions/upload-artifact@v6
with: with:
path: repo/obj_coverage path: repo/obj_coverage
name: coverage-report name: coverage-report
- name: Upload notification - name: Upload notification
if: ${{ github.event_name == 'pull_request' }} if: ${{ github.event_name == 'pull_request' }}
uses: actions/upload-artifact@v5 uses: actions/upload-artifact@v6
with: with:
path: repo/notification path: repo/notification
name: coverage-pr-notification name: coverage-pr-notification
@ -192,7 +192,7 @@ jobs:
# Creating issues requires elevated privilege # Creating issues requires elevated privilege
- name: Generate access token - name: Generate access token
id: generate-token id: generate-token
uses: actions/create-github-app-token@v2.1.4 uses: actions/create-github-app-token@v2.2.1
with: with:
app-id: ${{ vars.VERILATOR_CI_ID }} app-id: ${{ vars.VERILATOR_CI_ID }}
private-key: ${{ secrets.VERILATOR_CI_KEY }} private-key: ${{ secrets.VERILATOR_CI_KEY }}

View File

@ -39,7 +39,7 @@ jobs:
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v5 uses: actions/checkout@v6
- name: Extract context variables - name: Extract context variables
run: | run: |

View File

@ -21,23 +21,23 @@ jobs:
CI_COMMIT: ${{ github.sha }} CI_COMMIT: ${{ github.sha }}
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v5 uses: actions/checkout@v6
with: with:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
- name: Install packages for build - name: Install packages for build
env: env:
CI_BUILD_STAGE_NAME: build CI_BUILD_STAGE_NAME: build
run: | run: |
bash ci/ci-install.bash && sudo apt install clang-format-18
sudo apt-get install clang-format-18 yapf3 && git config --global user.email "action@example.com"
sudo pip3 install gersemi mbake &&
git config --global user.email "action@example.com" &&
git config --global user.name "github action" git config --global user.name "github action"
- name: Format code - name: Format code
run: | run: |
autoconf && autoconf
./configure && ./configure
make -j 2 format CLANGFORMAT=clang-format-18 && make venv
source .venv/bin/activate
make -j 2 format CLANGFORMAT=clang-format-18
git status git status
- name: Push - name: Push
run: |- run: |-

View File

@ -6,11 +6,8 @@ name: Pages
on: on:
push: push:
branches: branches: [master]
- master paths: ["ci/**", ".github/workflows"]
paths:
- "ci/**"
- ".github/workflows"
workflow_dispatch: workflow_dispatch:
workflow_run: workflow_run:
workflows: ["Code coverage"] workflows: ["Code coverage"]
@ -41,7 +38,7 @@ jobs:
coverage-pr-run-ids: ${{ steps.build.outputs.coverage-pr-run-ids }} coverage-pr-run-ids: ${{ steps.build.outputs.coverage-pr-run-ids }}
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v5 uses: actions/checkout@v6
- name: Build pages - name: Build pages
id: build id: build
env: env:
@ -73,11 +70,11 @@ jobs:
if: ${{ github.repository == 'verilator/verilator' }} if: ${{ github.repository == 'verilator/verilator' }}
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v5 uses: actions/checkout@v6
# Use the Verilator CI app to post the comment # Use the Verilator CI app to post the comment
- name: Generate access token - name: Generate access token
id: generate-token id: generate-token
uses: actions/create-github-app-token@v2.1.4 uses: actions/create-github-app-token@v2.2.1
with: with:
app-id: ${{ vars.VERILATOR_CI_ID }} app-id: ${{ vars.VERILATOR_CI_ID }}
private-key: ${{ secrets.VERILATOR_CI_KEY }} private-key: ${{ secrets.VERILATOR_CI_KEY }}

View File

@ -61,14 +61,14 @@ jobs:
CCACHE_MAXSIZE: 1000M # Per build matrix entry (* 5 = 5000M in total) CCACHE_MAXSIZE: 1000M # Per build matrix entry (* 5 = 5000M in total)
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v5 uses: actions/checkout@v6
with: with:
path: repo path: repo
ref: ${{ inputs.sha }} ref: ${{ inputs.sha }}
fetch-depth: ${{ inputs.dev-gcov && '0' || '1' }} # Coverage flow needs full history fetch-depth: ${{ inputs.dev-gcov && '0' || '1' }} # Coverage flow needs full history
- name: Cache $CCACHE_DIR - name: Cache $CCACHE_DIR
uses: actions/cache@v4 uses: actions/cache@v5
env: env:
CACHE_KEY: ${{ env.CACHE_BASE_KEY }}-ccache CACHE_KEY: ${{ env.CACHE_BASE_KEY }}-ccache
with: with:
@ -93,7 +93,7 @@ jobs:
echo "archive=$ARCHIVE" >> "$GITHUB_OUTPUT" echo "archive=$ARCHIVE" >> "$GITHUB_OUTPUT"
- name: Upload repository archive - name: Upload repository archive
uses: actions/upload-artifact@v5 uses: actions/upload-artifact@v6
with: with:
path: ${{ github.workspace }}/${{ steps.create-archive.outputs.archive }} path: ${{ github.workspace }}/${{ steps.create-archive.outputs.archive }}
name: ${{ steps.create-archive.outputs.archive }} name: ${{ steps.create-archive.outputs.archive }}

View File

@ -27,20 +27,24 @@ jobs:
name: Sub-lint | Python name: Sub-lint | Python
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v5 uses: actions/checkout@v6
with: with:
path: repo path: repo
- name: Install packages for build - name: Install packages for build
run: ./ci/ci-install.bash run: ./ci/ci-install.bash
# We use specific version numbers, otherwise a Python package
# update may add a warning and break our build
- name: Install packages for lint
run: sudo pip3 install mypy==1.18.2 pylint==3.0.2 ruff==0.1.3 clang sphinx sphinx_rtd_theme sphinxcontrib-spelling breathe ruff
- name: Configure - name: Configure
run: autoconf && ./configure --enable-longtests --enable-ccwarn run: |
autoconf
./configure --enable-longtests --enable-ccwarn
- name: Install python dependencies
run: |
sudo apt install python3-clang
make venv
- name: Lint - name: Lint
run: make -k lint-py run: |-
source .venv/bin/activate
make -k lint-py

View File

@ -38,14 +38,14 @@ jobs:
sudo apt install ccache mold help2man libfl-dev libgoogle-perftools-dev libsystemc-dev sudo apt install ccache mold help2man libfl-dev libgoogle-perftools-dev libsystemc-dev
- name: Use saved ccache - name: Use saved ccache
uses: actions/cache@v4 uses: actions/cache@v5
with: with:
path: ccache path: ccache
key: rtlmeter-build-ccache-${{ inputs.runs-on }}-${{ inputs.cc }}-${{ github.run_id }}-${{ github.run_attempt }} key: rtlmeter-build-ccache-${{ inputs.runs-on }}-${{ inputs.cc }}-${{ github.run_id }}-${{ github.run_attempt }}
restore-keys: rtlmeter-build-ccache-${{ inputs.runs-on }}-${{ inputs.cc }} restore-keys: rtlmeter-build-ccache-${{ inputs.runs-on }}-${{ inputs.cc }}
- name: Checkout - name: Checkout
uses: actions/checkout@v5 uses: actions/checkout@v6
with: with:
path: repo path: repo
fetch-depth: 0 # Required for 'git describe' used for 'verilator --version' fetch-depth: 0 # Required for 'git describe' used for 'verilator --version'
@ -68,7 +68,7 @@ jobs:
run: tar --posix -c -z -f verilator-rtlmeter.tar.gz install run: tar --posix -c -z -f verilator-rtlmeter.tar.gz install
- name: Upload Verilator installation archive - name: Upload Verilator installation archive
uses: actions/upload-artifact@v5 uses: actions/upload-artifact@v6
with: with:
path: verilator-rtlmeter.tar.gz path: verilator-rtlmeter.tar.gz
name: verilator-rtlmeter-${{ inputs.runs-on }}-${{ inputs.cc }} name: verilator-rtlmeter-${{ inputs.runs-on }}-${{ inputs.cc }}

View File

@ -62,7 +62,7 @@ jobs:
sudo apt install ccache mold libfl-dev libgoogle-perftools-dev libsystemc-dev sudo apt install ccache mold libfl-dev libgoogle-perftools-dev libsystemc-dev
- name: Download Verilator installation archive - name: Download Verilator installation archive
uses: actions/download-artifact@v6 uses: actions/download-artifact@v7
with: with:
name: verilator-rtlmeter-${{ inputs.runs-on }}-${{ inputs.cc }} name: verilator-rtlmeter-${{ inputs.runs-on }}-${{ inputs.cc }}
@ -73,14 +73,14 @@ jobs:
- name: Use saved ccache - name: Use saved ccache
if: ${{ env.CCACHE_DISABLE == 0 }} if: ${{ env.CCACHE_DISABLE == 0 }}
uses: actions/cache@v4 uses: actions/cache@v5
with: with:
path: ${{ env.CCACHE_DIR }} path: ${{ env.CCACHE_DIR }}
key: rtlmeter-run-ccache-${{ inputs.runs-on }}-${{ inputs.cc }}-${{ inputs.cases }}-${{ inputs.compileArgs }}-${{ github.run_id }}-${{ github.run_attempt }} key: rtlmeter-run-ccache-${{ inputs.runs-on }}-${{ inputs.cc }}-${{ inputs.cases }}-${{ inputs.compileArgs }}-${{ github.run_id }}-${{ github.run_attempt }}
restore-keys: rtlmeter-run-ccache-${{ inputs.runs-on }}-${{ inputs.cc }}-${{ inputs.cases }}-${{ inputs.compileArgs }} restore-keys: rtlmeter-run-ccache-${{ inputs.runs-on }}-${{ inputs.cc }}-${{ inputs.cases }}-${{ inputs.compileArgs }}
- name: Checkout RTLMeter - name: Checkout RTLMeter
uses: actions/checkout@v5 uses: actions/checkout@v6
with: with:
repository: "verilator/rtlmeter" repository: "verilator/rtlmeter"
path: rtlmeter path: rtlmeter
@ -115,7 +115,7 @@ jobs:
./rtlmeter report --steps '*' --metrics '*' ../results-${{ steps.results.outputs.hash }}.json ./rtlmeter report --steps '*' --metrics '*' ../results-${{ steps.results.outputs.hash }}.json
- name: Upload results - name: Upload results
uses: actions/upload-artifact@v5 uses: actions/upload-artifact@v6
with: with:
path: results-${{ steps.results.outputs.hash }}.json path: results-${{ steps.results.outputs.hash }}.json
name: rtlmeter-${{ inputs.tag }}-results-${{ steps.results.outputs.hash }} name: rtlmeter-${{ inputs.tag }}-results-${{ steps.results.outputs.hash }}
@ -124,5 +124,5 @@ jobs:
- name: Report status - name: Report status
working-directory: rtlmeter working-directory: rtlmeter
run: | # This will fail the job if any of the runs failed run: |- # This will fail the job if any of the runs failed
./rtlmeter run --verbose --cases='${{inputs.cases}}' --compileArgs='${{inputs.compileArgs}}' --executeArgs='${{inputs.executeArgs}}' ./rtlmeter run --verbose --cases='${{inputs.cases}}' --compileArgs='${{inputs.compileArgs}}' --executeArgs='${{inputs.executeArgs}}'

View File

@ -55,7 +55,7 @@ jobs:
steps: steps:
- name: Download repository archive - name: Download repository archive
uses: actions/download-artifact@v6 uses: actions/download-artifact@v7
with: with:
name: ${{ inputs.archive }} name: ${{ inputs.archive }}
path: ${{ github.workspace }} path: ${{ github.workspace }}
@ -67,7 +67,7 @@ jobs:
ls -lsha ls -lsha
- name: Cache $CCACHE_DIR - name: Cache $CCACHE_DIR
uses: actions/cache@v4 uses: actions/cache@v5
env: env:
CACHE_KEY: ${{ env.CACHE_BASE_KEY }}-ccache2 CACHE_KEY: ${{ env.CACHE_BASE_KEY }}-ccache2
with: with:
@ -77,14 +77,18 @@ jobs:
${{ env.CACHE_KEY }}- ${{ env.CACHE_KEY }}-
- name: Install test dependencies - name: Install test dependencies
run: ./ci/ci-install.bash run: |
./ci/ci-install.bash
make venv
- name: Test - name: Test
id: run-test id: run-test
continue-on-error: true continue-on-error: true
env: env:
TESTS: ${{ inputs.suite }} TESTS: ${{ inputs.suite }}
run: ./ci/ci-script.bash run: |
source .venv/bin/activate
./ci/ci-script.bash
- name: Combine code coverage data - name: Combine code coverage data
if: ${{ inputs.dev-gcov }} if: ${{ inputs.dev-gcov }}
@ -95,7 +99,7 @@ jobs:
- name: Upload code coverage data - name: Upload code coverage data
if: ${{ inputs.dev-gcov }} if: ${{ inputs.dev-gcov }}
uses: actions/upload-artifact@v5 uses: actions/upload-artifact@v6
with: with:
path: ${{ github.workspace }}/repo/obj_coverage/verilator-${{ inputs.suite }}.info path: ${{ github.workspace }}/repo/obj_coverage/verilator-${{ inputs.suite }}.info
name: code-coverage-${{ inputs.suite }} name: code-coverage-${{ inputs.suite }}

View File

@ -20,13 +20,13 @@ jobs:
pull-requests: write pull-requests: write
steps: steps:
- name: Download report - name: Download report
uses: actions/download-artifact@v6 uses: actions/download-artifact@v7
with: with:
name: rtlmeter-pr-results name: rtlmeter-pr-results
run-id: ${{ github.event.workflow_run.id }} run-id: ${{ github.event.workflow_run.id }}
github-token: ${{ secrets.GITHUB_TOKEN }} github-token: ${{ secrets.GITHUB_TOKEN }}
- name: Download PR number - name: Download PR number
uses: actions/download-artifact@v6 uses: actions/download-artifact@v7
with: with:
name: pr-number name: pr-number
run-id: ${{ github.event.workflow_run.id }} run-id: ${{ github.event.workflow_run.id }}
@ -34,7 +34,7 @@ jobs:
# Use the Verilator CI app to post the comment # Use the Verilator CI app to post the comment
- name: Generate access token - name: Generate access token
id: generate-token id: generate-token
uses: actions/create-github-app-token@v2.1.4 uses: actions/create-github-app-token@v2.2.1
with: with:
app-id: ${{ vars.VERILATOR_CI_ID }} app-id: ${{ vars.VERILATOR_CI_ID }}
private-key: ${{ secrets.VERILATOR_CI_KEY }} private-key: ${{ secrets.VERILATOR_CI_KEY }}

View File

@ -77,6 +77,7 @@ jobs:
- "BlackParrot:1x1:*" - "BlackParrot:1x1:*"
- "BlackParrot:2x2:*" - "BlackParrot:2x2:*"
- "BlackParrot:4x4:*" - "BlackParrot:4x4:*"
- "Caliptra:default:*"
- "NVDLA:*" - "NVDLA:*"
- "OpenPiton:1x1:*" - "OpenPiton:1x1:*"
- "OpenPiton:2x2:*" - "OpenPiton:2x2:*"
@ -122,6 +123,7 @@ jobs:
- "BlackParrot:1x1:*" - "BlackParrot:1x1:*"
- "BlackParrot:2x2:*" - "BlackParrot:2x2:*"
- "BlackParrot:4x4:*" - "BlackParrot:4x4:*"
- "Caliptra:default:*"
- "NVDLA:*" - "NVDLA:*"
- "OpenPiton:1x1:*" - "OpenPiton:1x1:*"
- "OpenPiton:2x2:*" - "OpenPiton:2x2:*"
@ -188,7 +190,7 @@ jobs:
tag: [gcc, clang, gcc-hier] tag: [gcc, clang, gcc-hier]
steps: steps:
- name: Checkout RTLMeter - name: Checkout RTLMeter
uses: actions/checkout@v5 uses: actions/checkout@v6
with: with:
repository: "verilator/rtlmeter" repository: "verilator/rtlmeter"
path: rtlmeter path: rtlmeter
@ -196,7 +198,7 @@ jobs:
working-directory: rtlmeter working-directory: rtlmeter
run: make venv run: make venv
- name: Download all results - name: Download all results
uses: actions/download-artifact@v6 uses: actions/download-artifact@v7
with: with:
pattern: rtlmeter-${{ matrix.tag }}-results-* pattern: rtlmeter-${{ matrix.tag }}-results-*
path: all-results-${{ matrix.tag }} path: all-results-${{ matrix.tag }}
@ -206,7 +208,7 @@ jobs:
run: | run: |
./rtlmeter collate ../all-results-${{ matrix.tag }}/*.json > ../all-results-${{ matrix.tag }}.json ./rtlmeter collate ../all-results-${{ matrix.tag }}/*.json > ../all-results-${{ matrix.tag }}.json
- name: Upload combined results - name: Upload combined results
uses: actions/upload-artifact@v5 uses: actions/upload-artifact@v6
with: with:
path: all-results-${{ matrix.tag }}.json path: all-results-${{ matrix.tag }}.json
name: all-results-${{ matrix.tag }} name: all-results-${{ matrix.tag }}
@ -225,20 +227,20 @@ jobs:
runs-on: ubuntu-24.04 runs-on: ubuntu-24.04
steps: steps:
- name: Download combined results - name: Download combined results
uses: actions/download-artifact@v6 uses: actions/download-artifact@v7
with: with:
pattern: all-results-* pattern: all-results-*
path: results path: results
merge-multiple: true merge-multiple: true
- name: Upload published results - name: Upload published results
uses: actions/upload-artifact@v5 uses: actions/upload-artifact@v6
with: with:
path: results/*.json path: results/*.json
name: published-results name: published-results
# Pushing to verilator/verilator-rtlmeter-results requires elevated permissions # Pushing to verilator/verilator-rtlmeter-results requires elevated permissions
- name: Generate access token - name: Generate access token
id: generate-token id: generate-token
uses: actions/create-github-app-token@v2.1.4 uses: actions/create-github-app-token@v2.2.1
with: with:
app-id: ${{ vars.VERILATOR_CI_ID }} app-id: ${{ vars.VERILATOR_CI_ID }}
private-key: ${{ secrets.VERILATOR_CI_KEY }} private-key: ${{ secrets.VERILATOR_CI_KEY }}
@ -246,7 +248,7 @@ jobs:
repositories: verilator-rtlmeter-results repositories: verilator-rtlmeter-results
permission-contents: write permission-contents: write
- name: Checkout verilator-rtlmeter-results - name: Checkout verilator-rtlmeter-results
uses: actions/checkout@v5 uses: actions/checkout@v6
with: with:
repository: "verilator/verilator-rtlmeter-results" repository: "verilator/verilator-rtlmeter-results"
token: ${{ steps.generate-token.outputs.token }} token: ${{ steps.generate-token.outputs.token }}
@ -279,7 +281,7 @@ jobs:
actions: read actions: read
steps: steps:
- name: Checkout RTLMeter - name: Checkout RTLMeter
uses: actions/checkout@v5 uses: actions/checkout@v6
with: with:
repository: "verilator/rtlmeter" repository: "verilator/rtlmeter"
path: rtlmeter path: rtlmeter
@ -287,7 +289,7 @@ jobs:
working-directory: rtlmeter working-directory: rtlmeter
run: make venv run: make venv
- name: Download combined results - name: Download combined results
uses: actions/download-artifact@v6 uses: actions/download-artifact@v7
with: with:
pattern: all-results-* pattern: all-results-*
path: all-results path: all-results
@ -306,7 +308,7 @@ jobs:
DATE=$(gh run --repo ${{ github.repository }} view $ID --json createdAt --jq ".createdAt") DATE=$(gh run --repo ${{ github.repository }} view $ID --json createdAt --jq ".createdAt")
echo "date=$DATE" >> $GITHUB_OUTPUT echo "date=$DATE" >> $GITHUB_OUTPUT
- name: Download scheduled run results - name: Download scheduled run results
uses: actions/download-artifact@v6 uses: actions/download-artifact@v7
with: with:
name: published-results name: published-results
path: nightly-results path: nightly-results
@ -372,14 +374,14 @@ jobs:
done done
cat report.txt cat report.txt
- name: Upload report - name: Upload report
uses: actions/upload-artifact@v5 uses: actions/upload-artifact@v6
with: with:
path: report.txt path: report.txt
name: rtlmeter-pr-results name: rtlmeter-pr-results
- name: Save PR number - name: Save PR number
run: echo ${{ github.event.number }} > pr-number.txt run: echo ${{ github.event.number }} > pr-number.txt
- name: Upload PR number - name: Upload PR number
uses: actions/upload-artifact@v5 uses: actions/upload-artifact@v6
with: with:
path: pr-number.txt path: pr-number.txt
name: pr-number name: pr-number
@ -395,7 +397,7 @@ jobs:
# Creating issues requires elevated privilege # Creating issues requires elevated privilege
- name: Generate access token - name: Generate access token
id: generate-token id: generate-token
uses: actions/create-github-app-token@v2.1.4 uses: actions/create-github-app-token@v2.2.1
with: with:
app-id: ${{ vars.VERILATOR_CI_ID }} app-id: ${{ vars.VERILATOR_CI_ID }}
private-key: ${{ secrets.VERILATOR_CI_KEY }} private-key: ${{ secrets.VERILATOR_CI_KEY }}

1
.gitignore vendored
View File

@ -17,6 +17,7 @@
*.pdf *.pdf
/Makefile /Makefile
/.ccache /.ccache
/.venv/
/artifact/ /artifact/
README README
TAGS TAGS

View File

@ -1,3 +1,4 @@
---
# See https://citation-file-format.github.io/ # See https://citation-file-format.github.io/
cff-version: 1.2.0 cff-version: 1.2.0
title: Verilator title: Verilator
@ -14,14 +15,14 @@ authors:
family-names: Wasson family-names: Wasson
- given-names: Duane - given-names: Duane
family-names: Galbi family-names: Galbi
- given-names: Geza
family-names: Lore
- name: 'et al' - name: 'et al'
repository-code: 'https://github.com/verilator/verilator' repository-code: 'https://github.com/verilator/verilator'
url: 'https://verilator.org' url: 'https://verilator.org'
abstract: >- abstract: >-
The Verilator package converts Verilog and SystemVerilog hardware The Verilator package converts Verilog and SystemVerilog hardware
description language (HDL) designs into a fast C++ or SystemC model description language (HDL) designs into a fast C++ or SystemC model
that, after compiling, can be executed. Verilator is not a that, after compiling, can be executed. Verilator is not only a
traditional simulator but a compiler. traditional simulator but a compiler.
license: license: [LGPL-3.0-only, Artistic-2.0]
- LGPL-3.0-only
- Artistic-2.0

View File

@ -4,7 +4,7 @@
# #
#***************************************************************************** #*****************************************************************************
# #
# Copyright 2003-2025 by Wilson Snyder. This program is free software; you # Copyright 2003-2026 by Wilson Snyder. This program is free software; you
# can redistribute it and/or modify it under the terms of either the GNU # 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 # Lesser General Public License Version 3 or the Perl Artistic License
# Version 2.0. # Version 2.0.
@ -16,7 +16,7 @@ cmake_minimum_required(VERSION 3.15)
cmake_policy(SET CMP0091 NEW) # Use MSVC_RUNTIME_LIBRARY to select the runtime cmake_policy(SET CMP0091 NEW) # Use MSVC_RUNTIME_LIBRARY to select the runtime
project( project(
Verilator Verilator
VERSION 5.042 VERSION 5.044
HOMEPAGE_URL https://verilator.org HOMEPAGE_URL https://verilator.org
LANGUAGES CXX LANGUAGES CXX
) )

128
Changes
View File

@ -8,6 +8,130 @@ The changes in each Verilator version are described below. The
contributors that suggested or implemented a given issue are shown in []. Thanks! contributors that suggested or implemented a given issue are shown in []. Thanks!
Verilator 5.044 2026-01-01
==========================
**Important:**
* This is the last release supporting the deprecated `--xml-only` and
`--make cmake` options.
* Change `--lint-only` and `--json-only` to imply `--timing` (#6790).
**Other:**
* Add `--unroll-limit` option (#6654) (#6668). [Geza Lore, Fractile Ltd.]
* Add `-fno-inline-funcs-eager` option to disable excessive inlining (#6682). [Geza Lore, Fractile Ltd.]
* Add `-param`/`-port` options to `public_flat*` control directives (#6685). [Geza Lore, Fractile Ltd.]
* Add `--top` specifying `config` name (#6710). [Dan Ruelas-Petrisko]
* Add `sc_biguint` pragma (#6712). [Jakub Wasilewski, Antmicro Ltd.]
* Add `make venv` target (#6775). [Geza Lore]
* Add SUPERNFIRST error on super.new on non-first statement (#6784). [Artur Bieniek]
* Add fargs for reusability of `--dump-inputs` output (#6812). [Geza Lore]
* Add `--quiet-build` to suppress make/compiler informationals.
* Support `std::randomize(){...}` (#4706) (#6573). [Yilou Wang]
* Support force assignments to unpacked array elements (partial #4735) (#6787). [Ryszard Rozak, Antmicro Ltd.]
* Support `config' (#5891) (#6714) (#6717) (#6745) (#6764). [Dan Ruelas-Petrisko]
* Support unpacked struct in localparam (#6053 partial) (#6708). [Jonathan Drolet]
* Support `randsequence` (#6131).
* Support array reference arguments into 'std::randomize()' (#6384) (#6719). [Yilou Wang]
* Support basic global constraints (#6551) (#6552). [Yilou Wang]
* Support SystemC time resolution with step 10/100 (#6633) (#6715). [Aliaksei Chapyzhenka]
* Support `this.randomize()` with constraints (#6634). [Artur Bieniek, Antmicro Ltd.]
* Support multi-expression sequences (#6639). [Bartłomiej Chmiel, Antmicro Ltd.]
* Support `#1step` delay as statement (#6671). [Pawel Kojma, Antmicro Ltd.]
* Support clocking output delay `1step` (#6681). [Ondrej Ille]
* Support parsing of dotted `bins_expression` (#6683). [Pawel Kojma, Antmicro Ltd.]
* Support constant expression cycle delays in sequences (#6691). [Ryszard Rozak, Antmicro Ltd.]
* Support general global constraints (#6709) (#6711). [Yilou Wang]
* Support complex std::randomize patterns (#6736) (#6737). [Yilou Wang]
* Support `rand_mode` in global constraint gathering (#6740) (#6752). [Yilou Wang]
* Support reduction or in constraints (#6840). [Pawel Kojma, Antmicro Ltd.]
* Support vpiSigned (#6868) (#6870). [Kaleb Barrett]
* Optimize away calls to empty functions (#6626). [Geza Lore]
* Optimize redundant headers in Syms implementation files. [Geza Lore, Fractile Ltd.]
* Optimize constructor/destructor VerilatedModules (#6660). [Geza Lore, Fractile Ltd.]
* Optimize repeated function call during symbol table initialization (#6665). [Geza Lore, Fractile Ltd.]
* Optimize functions reading external parameters as pure (#6684). [Geza Lore, Fractile Ltd.]
* Optimize `$past` delayed variable reuse (#6689). [Geza Lore, Fractile Ltd.]
* Optimize combinational loops through sign extension (#6724). [Geza Lore]
* Optimize trace initialization code size (#6749). [Geza Lore]
* Optimize combinational cycles in DFG (#6744) (#6746) (#6744). [Geza Lore]
* Optimize inlining small C functions and add `-inline-cfuncs` (#6815). [Jose Drowne]
* Fix generate function(s) inside of generate blocks (#1011) (#6789). [em2machine]
* Fix typedef derived from type defined inside interface (#3441) (#6776). [em2machine]
* Fix warning lint directive ordering and consistency (#4185) (#5368) (#5610) (#6876).
* Fix extern function that returns parameterized class (#4924).
* Fix type deduction for variable parameterized classes (#6281) (#6813). [em2machine]
* Fix randomize called within func/task (#6144) (#6753). [Yilou Wang]
* Fix pre/post_randomize on extended classes (#6467). [Alex Solomatnikov]
* Fix expression short circuiting (#6483). [Todd Strader]
* Fix resized lvalues with warning suppressed (#6497) (#6816). [Alex Solomatnikov]
* Fix unsupported `if` virtual interface warning (#6558) (#6861). [Krzysztof Bieganski, Antmicro Ltd.]
* Fix expression coverage of system calls (#6592). [Todd Strader]
* Fix `--timing` with `--x-initial-edge` (#6603) (#6631). [Krzysztof Bieganski, Antmicro Ltd.]
* Fix merging of impure assignments in gate optimization (#6629) (#6630). [Geza Lore]
* Fix determining Verilator revision when within git submodules without tags.
* Fix initial random values for verilator-created variables (#6611). [Todd Strader]
* Fix parsing of `with` clause inside covergroups (#6618). [Pawel Kojma, Antmicro Ltd.]
* Fix slice memory overflow on large output arrays (#6636) (#6638). [Jens Yuechao Liu]
* Fix localparam type assignment from interface type parameters (#6637) (#6732). [em2machine]
* Fix memory usage statistics on MacOS (#6644). [Geza Lore, Fractile Ltd.]
* Fix command line statistics with --stats (#6645) (#6646). [Geza Lore, Fractile Ltd.]
* Fix slow compilation of generated sampled value code (#6652). [Geza Lore, Fractile Ltd.]
* Fix non-deterministic output when splitting Syms file. [Geza Lore, Fractile Ltd.]
* Fix crash on DFG driver lookup (#6649). [Geza Lore]
* Fix ccache-report with PCH files. [Geza Lore, Fractile Ltd.]
* Fix parameterized class function (#6659) (#6802). [em2machine]
* Fix local interface parameter hierarchical access (#6661) (#6666). [Paul Swirhun]
* Fix splitting of Syms constructor/destructor bodies (#6662). [Geza Lore, Fractile Ltd.]
* Fix long C++ compilation due to VerilatedScope constructors (#6664). [Geza Lore, Fractile Ltd.]
* Fix large array initialization (#6669). [Artur Bieniek, Antmicro Ltd.]
* Fix `--expand-limit` not respected for expressions (#6670). [Geza Lore, Fractile Ltd.]
* Fix `free` name collision (#6675). [Todd Strader]
* Fix bounds checking in non-inlined function (#6677). [Geza Lore, Fractile Ltd.]
* Fix stream operator widening (#6693) (#6697). [Jean-Nicolas Strauss]
* Fix multitop cross references (#6699).
* Fix DFG independent bits analysis performance (#6713) (#6743). [Geza Lore]
* Fix deleting linked node error in V3Randomize (#6718). [Igor Zaworski, Antmicro Ltd.]
* Fix runtime worker thread stack sizes on MacOS (#6721). [Geza Lore]
* Fix X handling in UDPs (#6722) (#6723). [Michael Bikovitsky]
* Fix `--prof-exec` using `--lib-create`. [Geza Lore]
* Fix fork scheduling semantics (#6730). [Artur Bieniek, Antmicro Ltd.]
* Fix JSON output case statements (#6733).
* Fix internal fault when cross-class calling with DPI (#6735) (#6742). [Matthew Ballance]
* Fix write variable placement for global constraints (#6740) (#6750) (#6797). [Yilou Wang]
* Fix JSON dump missing output ports (#6751) (#6831). [Oleh Maksymenko]
* Fix resolution of specialized typedefs (#6754) (#6808) (#6834). [em2machine]
* Fix UNSUPPORTED on force / release with complex selects (#6755). [Ryszard Rozak, Antmicro Ltd.]
* Fix select assignment expansion (#6757). [Geza Lore]
* Fix `--lib-create` with multi-bit clocks (#6759). [Geza Lore]
* Fix DFG reusing volatile variables. [Geza Lore]
* Fix DFG assertion on out-of-bounds selects. [Geza Lore]
* Fix process reference giving no return statement error (#6767) (#6823). [Krzysztof Bieganski, Antmicro Ltd.]
* Fix class param static not found again error (#6768).
* Fix crash when super.new() called without a base class (#6772). [Matthew Ballance]
* Fix class-in-class extends with parameters (#6773).
* Fix enum item references in class extends with parameters.
* Fix reordering of function body inlined on RHS of <= NBA (#6780). [Geza Lore]
* Fix clang `-Wno-vla-cxx-extension` warning for UVM DPI tests (#6782)
* Fix `disable iff` in simple properties (#6783). [Ryszard Rozak, Antmicro Ltd.]
* Fix input sampling of clocking block signals (#6788). [Pawel Kojma, Antmicro Ltd.]
* Fix O(n*2) analysis in const-bit-op-tree (#6791). [Geza Lore]
* Fix member select of variable without randmode (#6800) (#6833). [Yilou Wang]
* Fix duplicate name error with interface initial blocks (#6804) (#6805). [Thomas Dybdahl Ahle]
* Fix nested struct within parameter port list (#6818) (#6824). [Luca Colagrande]
* Fix setting thread count in VerilatedContext (#6826 partial) (#6841). [Yangyu Chen]
* Fix firing array selects of events (#6829). [Amal Araweelo Almis]
* Fix false IMPLICITSTATIC on localparam (#6835). [Geza Lore]
* Fix randcase under fork (#6843). [Amal Araweelo Almis]
* Fix JSON missing `signed` indication (#6845).
* Fix class reference throwing cannot detect changes error (#6851).
* Fix `randc` on extended class (#6852).
* Fix typedef `::` class reference error (#6862).
* Fix missing include on FreeBSD (#6864).
* Fix `--Wwarn-lint` to be inverse of `--Wno-lint`.
Verilator 5.042 2025-11-02 Verilator 5.042 2025-11-02
========================== ==========================
@ -39,6 +163,7 @@ Verilator 5.042 2025-11-02
* Support modports referencing clocking blocks (#4555) (#6436). [Ryszard Rozak, Antmicro Ltd.] * Support modports referencing clocking blocks (#4555) (#6436). [Ryszard Rozak, Antmicro Ltd.]
* Support class package reference on pattern keys (#5653). [Todd Strader] * Support class package reference on pattern keys (#5653). [Todd Strader]
* Support digits in `$sscanf` field width formats (#6083). [Iztok Jeras] * Support digits in `$sscanf` field width formats (#6083). [Iztok Jeras]
* Support assert under assert (#6146). [Alex Solomatnikov]
* Support pure functions in sensitivity lists (#6393). [Krzysztof Bieganski, Antmicro Ltd.] * Support pure functions in sensitivity lists (#6393). [Krzysztof Bieganski, Antmicro Ltd.]
* Support simple alias statements (#6339) (#6501). [Ryszard Rozak, Antmicro Ltd.] * Support simple alias statements (#6339) (#6501). [Ryszard Rozak, Antmicro Ltd.]
* Support simple cycle delay sequence expressions inside properties (#6508). [Bartłomiej Chmiel, Antmicro Ltd.] * Support simple cycle delay sequence expressions inside properties (#6508). [Bartłomiej Chmiel, Antmicro Ltd.]
@ -445,6 +570,7 @@ Verilator 5.034 2025-02-24
* Optimize labels as final `if` block statements (#5744). * Optimize labels as final `if` block statements (#5744).
* Optimize empty function definition bodies (#5750). * Optimize empty function definition bodies (#5750).
* Optimize splitting trigger computation and dump (#5798). [Geza Lore] * Optimize splitting trigger computation and dump (#5798). [Geza Lore]
* Optimize some DFG multiplexers (#6822). [Yangyu Chen]
* Fix error message when call task as a function (#3089). [Matthew Ballance] * Fix error message when call task as a function (#3089). [Matthew Ballance]
* Fix force VPI public signal visibility (#5225). [Frédéric Requin] * Fix force VPI public signal visibility (#5225). [Frédéric Requin]
* Fix VPI iteration over hierarchy (#5314) (#5731). [Natan Kreimer] * Fix VPI iteration over hierarchy (#5314) (#5731). [Natan Kreimer]
@ -5394,7 +5520,7 @@ Verilator 0.0 1994-07-08
Copyright Copyright
========= =========
Copyright 2001-2025 by Wilson Snyder. This program is free software; you Copyright 2001-2026 by Wilson Snyder. This program is free software; you
can redistribute it and/or modify it under the terms of either the GNU 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 Lesser General Public License Version 3 or the Perl Artistic License
Version 2.0. Version 2.0.

View File

@ -7,7 +7,7 @@
# #
#***************************************************************************** #*****************************************************************************
# #
# Copyright 2003-2025 by Wilson Snyder. This program is free software; you # Copyright 2003-2026 by Wilson Snyder. This program is free software; you
# can redistribute it and/or modify it under the terms of either the GNU # 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 # Lesser General Public License Version 3 or the Perl Artistic License
# Version 2.0. # Version 2.0.
@ -460,23 +460,19 @@ analyzer-include:
-rm -rf examples/*/obj* -rm -rf examples/*/obj*
scan-build $(MAKE) -k examples scan-build $(MAKE) -k examples
format: # Bash/sh files
$(MAKE) -j 5 format-c format-cmake format-exec format-py BASH_FILES = \
ci/ci-install.bash \
CLANGFORMAT = clang-format-18 ci/ci-pages-notify.bash \
CLANGFORMAT_FLAGS = -i ci/ci-pages.bash \
CLANGFORMAT_FILES = $(CHECK_CPP) $(CHECK_H) $(CHECK_YL) test_regress/t/*.c* test_regress/t/*.h ci/ci-script.bash \
ci/docker/run/hooks/post_push \
format-c clang-format: ci/docker/run/verilator-docker \
$(CLANGFORMAT) --version ci/docker/run/verilator-wrap.sh \
@$(CLANGFORMAT) --version | fgrep 'version 18' > /dev/null \ nodist/fuzzer/all \
|| echo "*** You are not using clang-format-18, indents may differ from master's ***" nodist/fuzzer/run \
$(CLANGFORMAT) $(CLANGFORMAT_FLAGS) $(CLANGFORMAT_FILES) nodist/fuzzer/setup_root \
nodist/fuzzer/setup_user \
YAMLFIX = YAMLFIX_WHITELINES=1 YAMLFIX_LINE_LENGTH=200 YAMLFIX_preserve_quotes=true yamlfix
yamlfix:
$(YAMLFIX) .
# CMake files # CMake files
CMAKE_FILES = \ CMAKE_FILES = \
@ -495,6 +491,12 @@ MAKE_FILES = \
src/Makefile*.in \ src/Makefile*.in \
test_regress/Makefile* \ test_regress/Makefile* \
# Perl programs
PERL_PROGRAMS = \
bin/redirect \
bin/verilator \
bin/verilator_coverage \
# Python programs, subject to format and lint # Python programs, subject to format and lint
PY_PROGRAMS = \ PY_PROGRAMS = \
bin/verilator_ccache_report \ bin/verilator_ccache_report \
@ -502,25 +504,28 @@ PY_PROGRAMS = \
bin/verilator_gantt \ bin/verilator_gantt \
bin/verilator_includer \ bin/verilator_includer \
bin/verilator_profcfunc \ bin/verilator_profcfunc \
examples/json_py/vl_file_copy \
examples/json_py/vl_hier_graph \
docs/guide/conf.py \
docs/bin/vl_sphinx_extract \ docs/bin/vl_sphinx_extract \
docs/bin/vl_sphinx_fix \ docs/bin/vl_sphinx_fix \
src/astgen \ docs/guide/conf.py \
src/bisonpre \ examples/json_py/vl_file_copy \
src/config_rev \ examples/json_py/vl_hier_graph \
src/flexfix \
src/vlcovgen \
src/.gdbinit.py \
test_regress/*.py \
test_regress/t/*.pf \
nodist/clang_check_attributes \ nodist/clang_check_attributes \
nodist/dot_importer \ nodist/dot_importer \
nodist/fuzzer/actual_fail \ nodist/fuzzer/actual_fail \
nodist/fuzzer/generate_dictionary \ nodist/fuzzer/generate_dictionary \
nodist/install_test \ nodist/install_test \
nodist/lint_py_test_filter \
nodist/log_changes \ nodist/log_changes \
nodist/uvm_pkg_packer \
nodist/verilator_saif_diff \
src/.gdbinit.py \
src/astgen \
src/bisonpre \
src/config_rev \
src/flexfix \
src/vlcovgen \
test_regress/*.py \
test_regress/t/*.pf \
# Python files, subject to format but not lint # Python files, subject to format but not lint
PY_FILES = \ PY_FILES = \
@ -530,26 +535,70 @@ PY_FILES = \
# Python files, test_regress tests # Python files, test_regress tests
PY_TEST_FILES = test_regress/t/*.py PY_TEST_FILES = test_regress/t/*.py
YAPF = yapf3 # YAML files
YAML_FILES = \
.*.yaml \
.*.yml \
.github/*.yml \
.github/*/*.yml \
CITATION.cff \
######################################################################
# Format
format:
$(MAKE) -j 5 format-c format-cmake format-exec format-py format-yaml
BEAUTYSH = beautysh
BEAUTYSH_FLAGS = --indent-size 2
format-bash:
$(BEAUTYSH) --version
$(BEAUTYSH) $(BEAUTYSH_FLAGS) $(BASH_FILES)
CLANGFORMAT = clang-format-18
CLANGFORMAT_FLAGS = -i
CLANGFORMAT_FILES = $(CHECK_CPP) $(CHECK_H) $(CHECK_YL) test_regress/t/*.c* test_regress/t/*.h
format-c clang-format:
$(CLANGFORMAT) --version
@$(CLANGFORMAT) --version | fgrep 'version 18' > /dev/null \
|| echo "*** You are not using clang-format-18, indents may differ from master's ***"
$(CLANGFORMAT) $(CLANGFORMAT_FLAGS) $(CLANGFORMAT_FILES)
GERSEMI = gersemi
GERSEMI_FLAGS = -i --no-warn-about-unknown-commands
format-cmake:
$(GERSEMI) --version
$(GERSEMI) $(GERSEMI_FLAGS) $(CMAKE_FILES)
MBAKE = mbake
MBAKE_FLAGS = format --config ./.bake.toml
format-exec:
-chmod a+x test_regress/t/*.py
format-make mbake:
$(MBAKE) --version
$(MBAKE) $(MBAKE_FLAGS) $(MAKE_FILES)
YAPF = yapf
YAPF_FLAGS = -i --parallel YAPF_FLAGS = -i --parallel
format-py yapf: format-py yapf:
$(YAPF) --version $(YAPF) --version
$(YAPF) $(YAPF_FLAGS) $(PY_FILES) $(YAPF) $(YAPF_FLAGS) $(PY_FILES)
GERSEMI = gersemi YAMLFIX = YAMLFIX_WHITELINES=1 YAMLFIX_LINE_LENGTH=200 YAMLFIX_preserve_quotes=true yamlfix
GERSEMI_FLAGS = -i --no-warn-about-unknown-commands YAMLFIX_FLAGS =
format-cmake: format-yaml yamlfix:
$(GERSEMI) $(GERSEMI_FLAGS) $(CMAKE_FILES) $(YAMLFIX) --version
$(YAMLFIX) $(YAMLFIX_FLAGS) $(YAML_FILES)
MBAKE = mbake ######################################################################
MBAKE_FLAGS = format --config ./.bake.toml # Lint
format-make:
$(MBAKE) $(MBAKE_FLAGS) $(MAKE_FILES)
format-yaml: yamlfix
MYPY = mypy MYPY = mypy
MYPY_FLAGS = --strict --no-error-summary MYPY_FLAGS = --strict --no-error-summary
@ -583,9 +632,6 @@ lint-py-pylint-tests:
lint-py-ruff: lint-py-ruff:
$(RUFF) $(RUFF_FLAGS) $(PY_PROGRAMS) $(RUFF) $(RUFF_FLAGS) $(PY_PROGRAMS)
format-exec:
-chmod a+x test_regress/t/*.py
###################################################################### ######################################################################
# Configure # Configure
@ -781,7 +827,7 @@ clean mostlyclean distclean maintainer-clean::
distclean maintainer-clean:: distclean maintainer-clean::
rm -f *.info* *.1 $(INFOS) $(INFOS_OLD) $(VL_INST_MAN_FILES) rm -f *.info* *.1 $(INFOS) $(INFOS_OLD) $(VL_INST_MAN_FILES)
rm -f Makefile config.status config.cache config.log TAGS rm -f Makefile config.status config.cache config.log configure~ TAGS
rm -f verilator_bin* verilator_coverage_bin* rm -f verilator_bin* verilator_coverage_bin*
rm -f bin/verilator_bin* bin/verilator_coverage_bin* rm -f bin/verilator_bin* bin/verilator_coverage_bin*
rm -f include/verilated.mk include/verilated_config.h rm -f include/verilated.mk include/verilated_config.h
@ -806,3 +852,20 @@ preexist:
maintainer-dist: preexist tag maintainer-dist: preexist tag
svnorcvs release $(DISTTAGNAME) svnorcvs release $(DISTTAGNAME)
######################################################################
# Python venv
VENV_PATH ?= .venv
.PHONY: venv
venv:
# Create virtual environment using the python3 picked up by configure
[ -e $(VENV_PATH) ] || @PYTHON3@ -m venv --system-site-packages $(VENV_PATH)
# Install python3 dependencies
$(VENV_PATH)/bin/pip3 install -r python-dev-requirements.txt
@echo
@echo "Installed Python virtual environment, in:"
@echo " $(VENV_PATH)"
@echo "To activate, run:"
@echo " source $(VENV_PATH)/bin/activate"

View File

@ -4,19 +4,19 @@
|badge1| |badge2| |badge3| |badge4| |badge5| |badge7| |badge8| |badge1| |badge2| |badge3| |badge4| |badge5| |badge7| |badge8|
.. |badge1| image:: https://img.shields.io/badge/Website-Verilator.org-181717.svg .. |badge1| image:: https://img.shields.io/badge/Website-Verilator.org-181717.svg
:target: https://verilator.org :target: https://verilator.org
.. |badge2| image:: https://img.shields.io/badge/License-LGPL%20v3-blue.svg .. |badge2| image:: https://img.shields.io/badge/License-LGPL%20v3-blue.svg
:target: https://www.gnu.org/licenses/lgpl-3.0 :target: https://www.gnu.org/licenses/lgpl-3.0
.. |badge3| image:: https://img.shields.io/badge/License-Artistic%202.0-0298c3.svg .. |badge3| image:: https://img.shields.io/badge/License-Artistic%202.0-0298c3.svg
:target: https://opensource.org/licenses/Artistic-2.0 :target: https://opensource.org/licenses/Artistic-2.0
.. |badge4| image:: https://repology.org/badge/tiny-repos/verilator.svg?header=distro%20packages .. |badge4| image:: https://repology.org/badge/tiny-repos/verilator.svg?header=distro%20packages
:target: https://repology.org/project/verilator/versions :target: https://repology.org/project/verilator/versions
.. |badge5| image:: https://img.shields.io/docker/pulls/verilator/verilator .. |badge5| image:: https://img.shields.io/docker/pulls/verilator/verilator
:target: https://hub.docker.com/r/verilator/verilator :target: https://hub.docker.com/r/verilator/verilator
.. |badge7| image:: https://github.com/verilator/verilator/workflows/build/badge.svg .. |badge7| image:: https://github.com/verilator/verilator/workflows/build/badge.svg
:target: https://github.com/verilator/verilator/actions?query=workflow%3Abuild :target: https://github.com/verilator/verilator/actions?query=workflow%3Abuild
.. |badge8| image:: https://img.shields.io/github/actions/workflow/status/verilator/verilator/rtlmeter.yml?branch=master&event=schedule&label=benchmarks .. |badge8| image:: https://img.shields.io/github/actions/workflow/status/verilator/verilator/rtlmeter.yml?branch=master&event=schedule&label=benchmarks
:target: https://verilator.github.io/verilator-rtlmeter-results :target: https://verilator.github.io/verilator-rtlmeter-results
Welcome to Verilator Welcome to Verilator
@ -54,7 +54,7 @@ Welcome to Verilator
What Verilator Does What Verilator Does
=================== ===================
Verilator is invoked with parameters similar to GCC or Synopsys's VCS. It Verilator is invoked with parameters similar to GCC or Synopsys's VCS. It
"Verilates" the specified Verilog or SystemVerilog code by reading it, "Verilates" the specified Verilog or SystemVerilog code by reading it,
performing lint checks, and optionally inserting assertion checks and performing lint checks, and optionally inserting assertion checks and
coverage-analysis points. It outputs single- or multithreaded .cpp and .h coverage-analysis points. It outputs single- or multithreaded .cpp and .h
@ -69,21 +69,21 @@ Verilated generated libraries, optionally encrypted, into other simulators.
Verilator may not be the best choice if you are expecting a full-featured Verilator may not be the best choice if you are expecting a full-featured
replacement for a closed-source Verilog simulator, need SDF annotation, replacement for a closed-source Verilog simulator, need SDF annotation,
mixed-signal simulation, or are doing a quick class project (we recommend mixed-signal simulation, or are doing a quick class project (we recommend
`Icarus Verilog`_ for classwork). However, if you are looking for a path `Icarus Verilog`_ for classwork). However, if you are looking for a path to
to migrate SystemVerilog to C++/SystemC, or want high-speed simulation of migrate SystemVerilog to C++/SystemC, or want high-speed simulation of
designs, Verilator is the tool for you. designs, Verilator is the tool for you.
Performance Performance
=========== ===========
Verilator does not directly translate Verilog HDL to C++ or SystemC. Rather, Verilator does not directly translate Verilog HDL to C++ or SystemC.
Verilator compiles your code into a much faster optimized and optionally Rather, Verilator compiles your code into a much faster optimized and
thread-partitioned model, which is in turn wrapped inside a C++/SystemC optionally thread-partitioned model, which is in turn wrapped inside a
module. The results are a compiled Verilog model that executes even on a C++/SystemC module. The results are a compiled Verilog model that executes
single thread over 10x faster than standalone SystemC, and on a single even on a single thread over 10x faster than standalone SystemC, and on a
thread is about 100 times faster than interpreted Verilog simulators such single thread is about 100 times faster than interpreted Verilog simulators
as `Icarus Verilog`_. Another 2-10x speedup might be gained from such as `Icarus Verilog`_. Another 2-10x speedup might be gained from
multithreading (yielding 200-1000x total over interpreted simulators). multithreading (yielding 200-1000x total over interpreted simulators).
Verilator has typically similar or better performance versus closed-source Verilator has typically similar or better performance versus closed-source
@ -101,8 +101,8 @@ For more information:
- `Verilator installation and package directory structure - `Verilator installation and package directory structure
<https://verilator.org/install>`_ <https://verilator.org/install>`_
- `Verilator manual (HTML) <https://verilator.org/verilator_doc.html>`_, - `Verilator manual (HTML) <https://verilator.org/verilator_doc.html>`_, or
or `Verilator manual (PDF) <https://verilator.org/verilator_doc.pdf>`_ `Verilator manual (PDF) <https://verilator.org/verilator_doc.pdf>`_
- `Subscribe to Verilator announcements - `Subscribe to Verilator announcements
<https://github.com/verilator/verilator-announce>`_ <https://github.com/verilator/verilator-announce>`_
@ -145,16 +145,16 @@ Related Projects
Open License Open License
============ ============
Verilator is Copyright 2003-2025 by Wilson Snyder. (Report bugs to Verilator is Copyright 2003-2026 by Wilson Snyder. (Report bugs to
`Verilator Issues <https://verilator.org/issues>`_.) `Verilator Issues <https://verilator.org/issues>`_.)
Verilator is free software; you can redistribute it and/or modify it under 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 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. Perl Artistic License Version 2.0. See the documentation for more details.
.. _CHIPS Alliance: https://chipsalliance.org .. _chips alliance: https://chipsalliance.org
.. _Icarus Verilog: https://steveicarus.github.io/iverilog .. _icarus verilog: https://steveicarus.github.io/iverilog
.. _Linux Foundation: https://www.linuxfoundation.org .. _linux foundation: https://www.linuxfoundation.org
.. |Logo| image:: https://www.veripool.org/img/verilator_256_200_min.png .. |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 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 usage| image:: https://www.veripool.org/img/verilator_usage_400x200-min.png

View File

@ -1,7 +1,7 @@
#!/usr/bin/env perl #!/usr/bin/env perl
###################################################################### ######################################################################
# #
# Copyright 2003-2025 by Wilson Snyder. This program is free software; you # Copyright 2003-2026 by Wilson Snyder. This program is free software; you
# can redistribute it and/or modify it under the terms of either the GNU # 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 # Lesser General Public License Version 3 or the Perl Artistic License
# Version 2.0. # Version 2.0.

View File

@ -1,7 +1,7 @@
#!/usr/bin/env perl #!/usr/bin/env perl
###################################################################### ######################################################################
# #
# Copyright 2003-2025 by Wilson Snyder. This program is free software; you # Copyright 2003-2026 by Wilson Snyder. This program is free software; you
# can redistribute it and/or modify it under the terms of either the GNU # 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 # Lesser General Public License Version 3 or the Perl Artistic License
# Version 2.0. # Version 2.0.
@ -42,6 +42,7 @@ if ($#ARGV < 0) {
} }
# Insert debugging options up front # Insert debugging options up front
# (VERILATOR_TEST_FLAGS is not a documented nor official supported feature)
push @ARGV, (split ' ', $ENV{VERILATOR_TEST_FLAGS} || ""); push @ARGV, (split ' ', $ENV{VERILATOR_TEST_FLAGS} || "");
# We sneak a look at the flags so we can do some pre-environment checks # We sneak a look at the flags so we can do some pre-environment checks
@ -408,6 +409,8 @@ detailed descriptions of these arguments.
-I<dir> Directory to search for includes -I<dir> Directory to search for includes
--if-depth <value> Tune IFDEPTH warning --if-depth <value> Tune IFDEPTH warning
+incdir+<dir> Directory to search for includes +incdir+<dir> Directory to search for includes
--inline-cfuncs <value> Inline CFuncs with <=value nodes (0=off)
--inline-cfuncs-product <value> Inline CFuncs if size*calls <= value
--inline-mult <value> Tune module inlining --inline-mult <value> Tune module inlining
--instr-count-dpi <value> Assumed dynamic instruction count of DPI imports --instr-count-dpi <value> Assumed dynamic instruction count of DPI imports
-j <jobs> Parallelism for --build-jobs/--verilate-jobs -j <jobs> Parallelism for --build-jobs/--verilate-jobs
@ -419,6 +422,7 @@ detailed descriptions of these arguments.
--l2-name <value> Verilog scope name of the top module --l2-name <value> Verilog scope name of the top module
--language <lang> Default language standard to parse --language <lang> Default language standard to parse
-LDFLAGS <flags> Linker pre-object arguments for makefile -LDFLAGS <flags> Linker pre-object arguments for makefile
-libmap Specify library mapping file
--lib-create <name> Create a DPI library --lib-create <name> Create a DPI library
+libext+<ext>+[ext]... Extensions for finding modules +libext+<ext>+[ext]... Extensions for finding modules
+librescan Ignored for compatibility +librescan Ignored for compatibility
@ -473,6 +477,7 @@ detailed descriptions of these arguments.
--public-params Mark all parameters as public_flat --public-params Mark all parameters as public_flat
-pvalue+<name>=<value> Overwrite toplevel parameter -pvalue+<name>=<value> Overwrite toplevel parameter
--quiet Minimize additional printing --quiet Minimize additional printing
--quiet-build Don't print build progress
--quiet-exit Don't print the command on failure --quiet-exit Don't print the command on failure
--quiet-stats Don't print statistics --quiet-stats Don't print statistics
--relative-includes Resolve includes relative to current file --relative-includes Resolve includes relative to current file
@ -517,6 +522,7 @@ detailed descriptions of these arguments.
-U<var> Undefine preprocessor define -U<var> Undefine preprocessor define
--no-unlimited-stack Don't disable stack size limit --no-unlimited-stack Don't disable stack size limit
--unroll-count <loops> Tune maximum loop iterations --unroll-count <loops> Tune maximum loop iterations
--unroll-limit <loops> Maximum loop iterations before assuming infinite loop
--unroll-stmts <stmts> Tune maximum loop body size --unroll-stmts <stmts> Tune maximum loop body size
--unused-regexp <regexp> Tune UNUSED lint signals --unused-regexp <regexp> Tune UNUSED lint signals
-V Verbose version and config -V Verbose version and config
@ -578,7 +584,7 @@ description of these arguments.
The latest version is available from L<https://verilator.org>. The latest version is available from L<https://verilator.org>.
Copyright 2003-2025 by Wilson Snyder. This program is free software; you can Copyright 2003-2026 by Wilson Snyder. This program is free software; you can
redistribute it and/or modify the Verilator internals under the terms of redistribute it and/or modify the Verilator internals under the terms of
either the GNU Lesser General Public License Version 3 or the Perl Artistic either the GNU Lesser General Public License Version 3 or the Perl Artistic
License Version 2.0. License Version 2.0.

View File

@ -17,18 +17,14 @@ parser = argparse.ArgumentParser(
For documentation see For documentation see
https://verilator.org/guide/latest/exe_verilator_ccache_report.html""", https://verilator.org/guide/latest/exe_verilator_ccache_report.html""",
epilog="""Copyright 2002-2025 by Wilson Snyder. This program is free software; you epilog="""Copyright 2002-2026 by Wilson Snyder. This program is free software; you
can redistribute it and/or modify it under the terms of either the GNU 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 Lesser General Public License Version 3 or the Perl Artistic License
Version 2.0. Version 2.0.
SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0""") SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0""")
parser.add_argument('-o', parser.add_argument('-o', type=pathlib.Path, metavar="OUTFILE", required=True, help='output file')
type=argparse.FileType('w'),
metavar="OUTFILE",
required=True,
help='output file')
parser.add_argument('logdir', type=pathlib.Path, help='log directory') parser.add_argument('logdir', type=pathlib.Path, help='log directory')
args = parser.parse_args() args = parser.parse_args()
@ -58,34 +54,35 @@ for logfile in args.logdir.iterdir():
elapsed[obj] = toDateTime(match.group(1)) - start elapsed[obj] = toDateTime(match.group(1)) - start
results[obj] = match.group(2) results[obj] = match.group(2)
args.o.write("#" * 80 + "\n") with args.o.open("w") as ofd:
args.o.write("ccache report (from verilator_ccache_report) :\n") ofd.write("#" * 80 + "\n")
ofd.write("ccache report (from verilator_ccache_report) :\n")
if not results: if not results:
args.o.write("\nAll object files up to date\n") ofd.write("\nAll object files up to date\n")
else: else:
args.o.write("\nCompiled object files:\n") ofd.write("\nCompiled object files:\n")
wnames = max(len(_) for _ in results) + 1 wnames = max(len(_) for _ in results) + 1
wresults = max(len(_) for _ in results.values()) + 1 wresults = max(len(_) for _ in results.values()) + 1
for k in sorted(results.keys()): for k in sorted(results.keys()):
args.o.write("{:{wnames}} : {:{wresults}} : {}s\n".format(k, ofd.write("{:{wnames}} : {:{wresults}} : {}s\n".format(k,
results[k], results[k],
elapsed[k].total_seconds(), elapsed[k].total_seconds(),
wnames=wnames, wnames=wnames,
wresults=wresults)) wresults=wresults))
args.o.write("\nSummary:\n") ofd.write("\nSummary:\n")
counts = collections.Counter(_ for _ in results.values()) counts = collections.Counter(_ for _ in results.values())
total = sum(counts.values()) total = sum(counts.values())
for k in sorted(counts.keys()): for k in sorted(counts.keys()):
c = counts[k] c = counts[k]
args.o.write("{:{width}}| {} ({:.2%})\n".format(k, c, c / total, width=wresults)) ofd.write("{:{width}}| {} ({:.2%})\n".format(k, c, c / total, width=wresults))
args.o.write("\nLongest:\n") ofd.write("\nLongest:\n")
longest = sorted(list(elapsed.items()), key=lambda kv: -kv[1].total_seconds()) longest = sorted(list(elapsed.items()), key=lambda kv: -kv[1].total_seconds())
for i, (k, v) in enumerate(longest): for i, (k, v) in enumerate(longest):
args.o.write("{:{width}}| {}s\n".format(k, v.total_seconds(), width=wnames)) ofd.write("{:{width}}| {}s\n".format(k, v.total_seconds(), width=wnames))
if i > 4: if i > 4:
break break
args.o.write("#" * 80 + "\n") ofd.write("#" * 80 + "\n")

View File

@ -1,7 +1,7 @@
#!/usr/bin/env perl #!/usr/bin/env perl
###################################################################### ######################################################################
# #
# Copyright 2003-2025 by Wilson Snyder. This program is free software; you # Copyright 2003-2026 by Wilson Snyder. This program is free software; you
# can redistribute it and/or modify it under the terms of either the GNU # 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 # Lesser General Public License Version 3 or the Perl Artistic License
# Version 2.0. # Version 2.0.
@ -192,7 +192,7 @@ L<https://verilator.org/guide/latest/exe_verilator_coverage.html>.
The latest version is available from L<https://verilator.org>. The latest version is available from L<https://verilator.org>.
Copyright 2003-2025 by Wilson Snyder. This program is free software; you Copyright 2003-2026 by Wilson Snyder. This program is free software; you
can redistribute it and/or modify the Verilator internals under the terms can redistribute it and/or modify the Verilator internals under the terms
of either the GNU Lesser General Public License Version 3 or the Perl of either the GNU Lesser General Public License Version 3 or the Perl
Artistic License Version 2.0. Artistic License Version 2.0.

View File

@ -110,7 +110,7 @@ It performs a diff between two files, or all files common between two
directories, ignoring irrelevant pointer differences. directories, ignoring irrelevant pointer differences.
Exit status is 0 if inputs are the same, 1 if different, 2 if trouble.""", Exit status is 0 if inputs are the same, 1 if different, 2 if trouble.""",
epilog="""Copyright 2005-2025 by Wilson Snyder. This program is free software; you epilog="""Copyright 2005-2026 by Wilson Snyder. This program is free software; you
can redistribute it and/or modify it under the terms of either the GNU 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 Lesser General Public License Version 3 or the Perl Artistic License
Version 2.0. Version 2.0.

View File

@ -613,7 +613,7 @@ Verilator_gantt creates a visual representation to help analyze Verilator
For documentation see For documentation see
https://verilator.org/guide/latest/exe_verilator_gantt.html""", https://verilator.org/guide/latest/exe_verilator_gantt.html""",
epilog="""Copyright 2018-2025 by Wilson Snyder. This program is free software; you epilog="""Copyright 2018-2026 by Wilson Snyder. This program is free software; you
can redistribute it and/or modify it under the terms of either the GNU 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 Lesser General Public License Version 3 or the Perl Artistic License
Version 2.0. Version 2.0.

View File

@ -2,7 +2,7 @@
# mypy: disallow-untyped-defs # mypy: disallow-untyped-defs
# pylint: disable=C0114,C0209 # pylint: disable=C0114,C0209
# #
# Copyright 2003-2025 by Wilson Snyder. This program is free software; you # Copyright 2003-2026 by Wilson Snyder. This program is free software; you
# can redistribute it and/or modify the Verilator internals under the terms # can redistribute it and/or modify the Verilator internals under the terms
# of either the GNU Lesser General Public License Version 3 or the Perl # of either the GNU Lesser General Public License Version 3 or the Perl
# Artistic License Version 2.0. # Artistic License Version 2.0.

View File

@ -173,7 +173,7 @@ in each Verilog block.
For documentation see For documentation see
https://verilator.org/guide/latest/exe_verilator_profcfunc.html""", https://verilator.org/guide/latest/exe_verilator_profcfunc.html""",
epilog="""Copyright 2002-2025 by Wilson Snyder. This program is free software; you epilog="""Copyright 2002-2026 by Wilson Snyder. This program is free software; you
can redistribute it and/or modify it under the terms of either the GNU 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 Lesser General Public License Version 3 or the Perl Artistic License
Version 2.0. Version 2.0.

View File

@ -94,18 +94,18 @@ elif [ "$CI_BUILD_STAGE_NAME" = "test" ]; then
TEST_REGRESS=test_regress TEST_REGRESS=test_regress
if [ "$CI_RELOC" == 1 ]; then if [ "$CI_RELOC" == 1 ]; then
# Testing that the installation is relocatable. # Testing that the installation is relocatable.
"$MAKE" install "$MAKE" install
mkdir -p "$RELOC_DIR" mkdir -p "$RELOC_DIR"
mv "$INSTALL_DIR" "$RELOC_DIR/relocated-install" mv "$INSTALL_DIR" "$RELOC_DIR/relocated-install"
export VERILATOR_ROOT="$RELOC_DIR/relocated-install/share/verilator" export VERILATOR_ROOT="$RELOC_DIR/relocated-install/share/verilator"
TEST_REGRESS="$RELOC_DIR/test_regress" TEST_REGRESS="$RELOC_DIR/test_regress"
mv test_regress "$TEST_REGRESS" mv test_regress "$TEST_REGRESS"
NODIST="$RELOC_DIR/nodist" NODIST="$RELOC_DIR/nodist"
mv nodist "$NODIST" mv nodist "$NODIST"
# Feeling brave? # Feeling brave?
find . -delete find . -delete
ls -la . ls -la .
fi fi
# Run the specified test # Run the specified test

View File

@ -1,7 +1,7 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
.. _Verilator Build Docker Container: .. _verilator build docker container:
Verilator Build Docker Container Verilator Build Docker Container
================================ ================================
@ -9,11 +9,11 @@ Verilator Build Docker Container
This Verilator Build Docker Container is set up to compile and test a This Verilator Build Docker Container is set up to compile and test a
Verilator build. It uses the following parameters: Verilator build. It uses the following parameters:
- Source repository (default: https://github.com/verilator/verilator) - Source repository (default: https://github.com/verilator/verilator)
- Source revision (default: master) - Source revision (default: master)
- Compiler (GCC 13.3.0, clang 18.1.3, default: 13.3.0) - Compiler (GCC 13.3.0, clang 18.1.3, default: 13.3.0)
The container is published as ``verilator/verilator-buildenv`` on `docker The container is published as ``verilator/verilator-buildenv`` on `docker
hub hub
@ -37,8 +37,9 @@ To change the compiler use the `-e` switch to pass environment variables:
docker run -ti -e CXX=clang++-18 verilator/verilator-buildenv test docker run -ti -e CXX=clang++-18 verilator/verilator-buildenv test
The tests, that involve numactl are not working due to security restrictions. The tests, that involve numactl are not working due to security
To run those too, add the CAP_SYS_NICE capability during the start of the container: restrictions. To run those too, add the CAP_SYS_NICE capability during the
start of the container:
:: ::

View File

@ -1,4 +1,4 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
Verilator Executable Docker Container Verilator Executable Docker Container
@ -11,12 +11,12 @@ easily as a docker image, e.g.:
docker run -ti verilator/verilator:latest --version docker run -ti verilator/verilator:latest --version
This will pull the container from `docker hub This will pull the container from `Docker Hub
<https://hub.docker.com/r/verilator/verilator>`_, run the latest Verilator and print <https://hub.docker.com/r/verilator/verilator>`_, run the latest Verilator
Verilator's version. and print Verilator's version.
Containers are automatically built and pushed to docker hub for all released versions, so you may Containers are automatically built and pushed to docker hub for all
easily compare results across versions, e.g.: released versions, so you may easily compare results across versions, e.g.:
:: ::
@ -38,7 +38,7 @@ or
./verilator-docker 4.030 --cc test.v ./verilator-docker 4.030 --cc test.v
If you prefer not to use ``verilator-docker`` you must give the container If you prefer not to use ``verilator-docker`` you must give the container
access to your files as a volume with appropriate user rights. For example access to your files as a volume with appropriate user rights. For example
to Verilate test.v: to Verilate test.v:
:: ::
@ -68,9 +68,9 @@ Internals
The Dockerfile builds Verilator and removes the tree when completed to The Dockerfile builds Verilator and removes the tree when completed to
reduce the image size. The entrypoint is a wrapper script reduce the image size. The entrypoint is a wrapper script
(``verilator-wrap.sh``). That script 1. calls Verilator, and 2. copies the (``verilator-wrap.sh``). That script 1. calls Verilator, and 2. copies the
Verilated runtime files to the ``obj_dir`` or the ``-Mdir`` Verilated runtime files to the ``obj_dir`` or the ``-Mdir`` respectively.
respectively. This allows the user to have the files to they may later This allows the user to have the files to they may later build the C++
build the C++ output with the matching runtime files. The wrapper also output with the matching runtime files. The wrapper also patches the
patches the Verilated Makefile accordingly. Verilated Makefile accordingly.
A hook is also defined and run by Docker Hub via automated builds. A hook is also defined and run by Docker Hub via automated builds.

View File

@ -8,6 +8,6 @@
# SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 # SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
if [ "$SOURCE_BRANCH"="stable" ]; then if [ "$SOURCE_BRANCH"="stable" ]; then
docker tag $IMAGE_NAME $DOCKER_REPO:latest docker tag $IMAGE_NAME $DOCKER_REPO:latest
docker push $DOCKER_REPO:latest docker push $DOCKER_REPO:latest
fi fi

View File

@ -11,21 +11,21 @@
perl /usr/local/bin/verilator "$@" perl /usr/local/bin/verilator "$@"
status=$? status=$?
if [ $status -ne 0 ]; then if [ $status -ne 0 ]; then
exit $status exit $status
fi fi
# Check if user set an obj_dir # Check if user set an obj_dir
obj_dir=$(echo " $@" | grep -oP '\s--Mdir\s*\K\S+') obj_dir=$(echo " $@" | grep -oP '\s--Mdir\s*\K\S+')
if [ "$obj_dir" == "" ]; then if [ "$obj_dir" == "" ]; then
obj_dir="obj_dir" obj_dir="obj_dir"
fi fi
# If the run was successful: Copy required files to allow build without this container # If the run was successful: Copy required files to allow build without this container
if [ -e ${obj_dir} ]; then if [ -e ${obj_dir} ]; then
# Copy files required for the build # Copy files required for the build
mkdir -p ${obj_dir}/vlt mkdir -p ${obj_dir}/vlt
cp -r /usr/local/share/verilator/bin ${obj_dir}/vlt cp -r /usr/local/share/verilator/bin ${obj_dir}/vlt
cp -r /usr/local/share/verilator/include ${obj_dir}/vlt cp -r /usr/local/share/verilator/include ${obj_dir}/vlt
# Point Makefile to that folder # Point Makefile to that folder
sed -i 's/VERILATOR_ROOT = \/usr\/local\/share\/verilator/VERILATOR_ROOT = vlt/g' ${obj_dir}/*.mk sed -i 's/VERILATOR_ROOT = \/usr\/local\/share\/verilator/VERILATOR_ROOT = vlt/g' ${obj_dir}/*.mk
fi fi

View File

@ -1,6 +1,6 @@
# DESCRIPTION: Process this file with autoconf to produce a configure script. # DESCRIPTION: Process this file with autoconf to produce a configure script.
# #
# Copyright 2003-2025 by Wilson Snyder. Verilator is free software; you # Copyright 2003-2026 by Wilson Snyder. Verilator is free software; you
# can redistribute it and/or modify it under the terms of either the GNU Lesser # 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. # General Public License Version 3 or the Perl Artistic License Version 2.0.
# SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 # SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
@ -11,7 +11,7 @@
# Then 'make maintainer-dist' # Then 'make maintainer-dist'
#AC_INIT([Verilator],[#.### YYYY-MM-DD]) #AC_INIT([Verilator],[#.### YYYY-MM-DD])
#AC_INIT([Verilator],[#.### devel]) #AC_INIT([Verilator],[#.### devel])
AC_INIT([Verilator],[5.042 2025-11-02], AC_INIT([Verilator],[5.044 2026-01-01],
[https://verilator.org], [https://verilator.org],
[verilator],[https://verilator.org]) [verilator],[https://verilator.org])
@ -475,6 +475,7 @@ _MY_CXX_CHECK_OPT(CFG_CXXFLAGS_SRC,-Wno-shadow)
_MY_CXX_CHECK_OPT(CFG_CXXFLAGS_SRC,-Wno-unused-parameter) _MY_CXX_CHECK_OPT(CFG_CXXFLAGS_SRC,-Wno-unused-parameter)
_MY_CXX_CHECK_OPT(CFG_CXXFLAGS_SRC,-Xclang -fno-pch-timestamp) _MY_CXX_CHECK_OPT(CFG_CXXFLAGS_SRC,-Xclang -fno-pch-timestamp)
_MY_CXX_CHECK_OPT(CFG_CXXFLAGS_SRC,-faligned-new) _MY_CXX_CHECK_OPT(CFG_CXXFLAGS_SRC,-faligned-new)
_MY_CXX_CHECK_OPT(CFG_CXXFLAGS_SRC,-fno-exceptions)
AC_SUBST(CFG_CXXFLAGS_SRC) AC_SUBST(CFG_CXXFLAGS_SRC)
# Flags for compiling Verilator parser always (in addition to above CFG_CXXFLAGS_SRC) # Flags for compiling Verilator parser always (in addition to above CFG_CXXFLAGS_SRC)
@ -533,7 +534,8 @@ m4_foreach([cflag],[
[-Wno-unused-but-set-parameter], [-Wno-unused-but-set-parameter],
[-Wno-unused-but-set-variable], [-Wno-unused-but-set-variable],
[-Wno-unused-parameter], [-Wno-unused-parameter],
[-Wno-unused-variable]],[ [-Wno-unused-variable],
[-Wno-vla-cxx-extension]],[
_MY_CXX_CHECK_OPT(CFG_CXXFLAGS_NO_UNUSED,cflag) _MY_CXX_CHECK_OPT(CFG_CXXFLAGS_NO_UNUSED,cflag)
# CMake will test what flags work itself, so pass all flags through to it # CMake will test what flags work itself, so pass all flags through to it
CFG_CXX_FLAGS_CMAKE="$CFG_CXX_FLAGS_CMAKE cflag" CFG_CXX_FLAGS_CMAKE="$CFG_CXX_FLAGS_CMAKE cflag"

View File

@ -23,8 +23,8 @@ Did you find a Verilator bug?
demonstrating the bug and expected behavior that is not occurring. demonstrating the bug and expected behavior that is not occurring.
- The ideal example works against other simulators, and is in the - The ideal example works against other simulators, and is in the
test_regress/t test format, as described in test_regress/t test format, as described in `Verilator Internals
`Verilator Internals Documentation Documentation
<https://github.com/verilator/verilator/blob/master/docs/internals.rst>`__. <https://github.com/verilator/verilator/blob/master/docs/internals.rst>`__.
@ -38,18 +38,18 @@ Did you write a patch that fixes a Verilator bug?
<https://github.com/verilator/verilator/pulls>`__. <https://github.com/verilator/verilator/pulls>`__.
- See the coding conventions, and other developer information in - See the coding conventions, and other developer information in
``docs/internals.rst`` in the distribution, or as rendered at ``docs/internals.rst`` in the distribution, or as rendered at `Verilator
`Verilator Internals Documentation Internals Documentation
<https://github.com/verilator/verilator/blob/master/docs/internals.rst>`__. <https://github.com/verilator/verilator/blob/master/docs/internals.rst>`__.
- Verilator uses GitHub Actions to provide continuous integration. You - Verilator uses GitHub Actions to provide continuous integration. You may
may want to enable Actions on your GitHub branch to ensure your changes want to enable Actions on your GitHub branch to ensure your changes keep
keep the tests passing. the tests passing.
- Your source-code contributions must be certified as open source, - Your source-code contributions must be certified as open source, under
under the `Developer Certificate of the `Developer Certificate of Origin
Origin <https://developercertificate.org/>`__. On your first <https://developercertificate.org/>`__. On your first contribution, you
contribution, you must either: must either:
- Have your patch include the addition of your name to `docs/CONTRIBUTORS - Have your patch include the addition of your name to `docs/CONTRIBUTORS
<CONTRIBUTORS>`__ (preferred). <CONTRIBUTORS>`__ (preferred).
@ -75,9 +75,9 @@ Did you write a patch that fixes a Verilator bug?
Do you have questions on Verilator? Do you have questions on Verilator?
----------------------------------- -----------------------------------
- Please see FAQ section and rest of the `Verilator - Please see FAQ section and rest of the `Verilator manual
manual <https://verilator.org/verilator_doc.html>`__, or `Verilator <https://verilator.org/verilator_doc.html>`__, or `Verilator manual (PDF)
manual (PDF) <https://verilator.org/verilator_doc.pdf>`__. <https://verilator.org/verilator_doc.pdf>`__.
- Ask any question in the `Verilator forum - Ask any question in the `Verilator forum
<https://verilator.org/forum>`__. <https://verilator.org/forum>`__.

View File

@ -38,7 +38,7 @@ Chuxuan Wang
Chykon Chykon
Congcong Cai Congcong Cai
Conor McCullough Conor McCullough
Dan Petrisko Dan Ruelas-Petrisko
Daniel Bates Daniel Bates
Danny Oler Danny Oler
Dave Sargeant Dave Sargeant
@ -105,6 +105,8 @@ Jamey Hicks
Jamie Iles Jamie Iles
Jan Van Winkel Jan Van Winkel
Jean Berniolles Jean Berniolles
Jean-Nicolas Strauss
Jens Yuechao Liu
Jeremy Bennett Jeremy Bennett
Jesse Taube Jesse Taube
Jevin Sweval Jevin Sweval
@ -123,6 +125,7 @@ John Wehle
Jonathan Drolet Jonathan Drolet
Jonathan Schröter Jonathan Schröter
Jordan McConnon Jordan McConnon
Jose Drowne
Jose Loyola Jose Loyola
Josep Sans Josep Sans
Joseph Nwabueze Joseph Nwabueze
@ -190,6 +193,7 @@ Paul Bowen-Huggett
Paul Swirhun Paul Swirhun
Paul Wright Paul Wright
Pawel Jewstafjew Pawel Jewstafjew
Pawel Kojma
Pawel Sagan Pawel Sagan
Pengcheng Xu Pengcheng Xu
Peter Birch Peter Birch
@ -230,6 +234,8 @@ Steven Hugg
Szymon Gizler Szymon Gizler
Sören Tempel Sören Tempel
Teng Huang Teng Huang
Thomas Aldrian
Thomas Dybdahl Ahle
Tim Hutt Tim Hutt
Tim Snyder Tim Snyder
Tobias Jensen Tobias Jensen
@ -270,8 +276,10 @@ Zhen Yan
Zhou Shen Zhou Shen
Zhouyi Shen Zhouyi Shen
Zixi Li Zixi Li
apocelipes
dependabot[bot] dependabot[bot]
february cozzocrea february cozzocrea
sumpster sumpster
em2machine
Àlex Torregrosa Àlex Torregrosa
Ícaro Lima Ícaro Lima

View File

@ -5,7 +5,7 @@
# #
# Code available from: https://verilator.org # Code available from: https://verilator.org
# #
# Copyright 2003-2025 by Wilson Snyder. This program is free software; you # Copyright 2003-2026 by Wilson Snyder. This program is free software; you
# can redistribute it and/or modify it under the terms of either the GNU # 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 # Lesser General Public License Version 3 or the Perl Artistic License
# Version 2.0. # Version 2.0.

View File

@ -10,8 +10,8 @@ For formatted documentation see:
- `Verilator installation and package directory structure - `Verilator installation and package directory structure
<https://verilator.org/install>`_ <https://verilator.org/install>`_
- `Verilator manual (HTML) <https://verilator.org/verilator_doc.html>`_, - `Verilator manual (HTML) <https://verilator.org/verilator_doc.html>`_, or
or `Verilator manual (PDF) <https://verilator.org/verilator_doc.pdf>`_ `Verilator manual (PDF) <https://verilator.org/verilator_doc.pdf>`_
- `Subscribe to Verilator announcements - `Subscribe to Verilator announcements
<https://github.com/verilator/verilator-announce>`_ <https://github.com/verilator/verilator-announce>`_

View File

@ -37,7 +37,7 @@ parser = argparse.ArgumentParser(
allow_abbrev=False, allow_abbrev=False,
formatter_class=argparse.RawDescriptionHelpFormatter, formatter_class=argparse.RawDescriptionHelpFormatter,
description="""Read a file and extract documentation data.""", description="""Read a file and extract documentation data.""",
epilog=""" Copyright 2021-2025 by Wilson Snyder. This package is free software; epilog=""" Copyright 2021-2026 by Wilson Snyder. This package is free software;
you can redistribute it and/or modify it under the terms of either the GNU 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 Lesser General Public License Version 3 or the Perl Artistic License
Version 2.0. Version 2.0.

View File

@ -52,7 +52,7 @@ parser = argparse.ArgumentParser(
allow_abbrev=False, allow_abbrev=False,
formatter_class=argparse.RawDescriptionHelpFormatter, formatter_class=argparse.RawDescriptionHelpFormatter,
description="""Post-process Sphinx HTML.""", description="""Post-process Sphinx HTML.""",
epilog=""" Copyright 2021-2025 by Wilson Snyder. This package is free software; epilog=""" Copyright 2021-2026 by Wilson Snyder. This package is free software;
you can redistribute it and/or modify it under the terms of either the GNU 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 Lesser General Public License Version 3 or the Perl Artistic License
Version 2.0. Version 2.0.

View File

@ -1,9 +1,8 @@
.. comment: generated by t_lint_assigneqexpr_bad .. comment: generated by t_lint_assigneqexpr_bad
.. code-block:: sv .. code-block:: sv
:linenos: :linenos:
:emphasize-lines: 3
assign d_o = // Note = not == below output logic c_o,
( output logic d_o
c_o = 1 // <--- Warning: ASSIGNEQEXPR );
) ? 1 : ( assign c_o = (a_i != 0) ? 1 : 0;

View File

@ -4,4 +4,4 @@
:emphasize-lines: 2 :emphasize-lines: 2
function void calls_timing_ctl; function void calls_timing_ctl;
@e; // <--- Bad IEEE 1800-2023 13.4 time-controlling @e; // <--- Bad IEEE 1800-2023 13.4 time-controlling

View File

@ -0,0 +1,8 @@
.. comment: generated by t_class_new_supernfirst_bad
.. code-block:: sv
:linenos:
:emphasize-lines: 3
function new();
int x = $random();
super.new(build_coverage(x), x); // <--- BAD, must be first statement

View File

@ -0,0 +1,4 @@
.. comment: generated by t_class_new_supernfirst_bad
.. code-block::
%Error-SUPERNFIRST: example.v:1:11 'super.new' must be first statement in a 'function new' (IEEE 1800-2023 8.15)

View File

@ -1,16 +1,17 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
**************** ****************
Revision History Revision History
**************** ****************
.. COMMENT above header must use ### so there is an extra level of headers ..
COMMENT above header must use *** so there is an extra level of headers
here so the index won't show the huge list of revisions when clicking on here so the index won't show the huge list of revisions when clicking on
"Revision History" in the sidebar. "Revision History" in the sidebar.
Changes are contained in the :file:`Changes` file of the distribution, and Changes are contained in the :file:`Changes` file of the distribution, and
also summarized below. To subscribe to new versions, see `Verilator also summarized below. To subscribe to new versions, see `Verilator
Announcements <https://github.com/verilator/verilator-announce>`_. Announcements <https://github.com/verilator/verilator-announce>`_.
.. include:: ../_build/gen/Changes .. include:: ../_build/gen/Changes

View File

@ -1,7 +1,7 @@
# pylint: disable=C0103,C0114,C0116,C0301,E0402,W0622 # pylint: disable=C0103,C0114,C0116,C0301,E0402,W0622
# #
# Configuration file for Verilator's Sphinx documentation builder. # Configuration file for Verilator's Sphinx documentation builder.
# Copyright 2003-2025 by Wilson Snyder. # Copyright 2003-2026 by Wilson Snyder.
# SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 # SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
# #
# This file only contains overridden options. For a full list: # This file only contains overridden options. For a full list:

View File

@ -1,7 +1,7 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
.. _Connecting: .. _connecting:
****************************** ******************************
Connecting to Verilated Models Connecting to Verilated Models
@ -11,13 +11,13 @@ Structure of the Verilated Model
================================ ================================
Verilator outputs a :file:`{prefix}.h` header file which defines a class Verilator outputs a :file:`{prefix}.h` header file which defines a class
named :code:`{prefix}` which represents the generated model the user is named ``{prefix}`` which represents the generated model the user is
supposed to instantiate. This model class defines the interface of the supposed to instantiate. This model class defines the interface of the
Verilated model. Verilated model.
Verilator will additionally create a :file:`{prefix}.cpp` file, together Verilator will additionally create a :file:`{prefix}.cpp` file, together
with additional .h and .cpp files for internals. See the :file:`examples` with additional .h and .cpp files for internals. See the :file:`examples`
directory in the kit for examples. See :ref:`Files Read/Written` for directory in the kit for examples. See :ref:`Files Read/Written` for
information on all the files Verilator might output. information on all the files Verilator might output.
The output of Verilator will contain a :file:`{prefix}.mk` file that may be The output of Verilator will contain a :file:`{prefix}.mk` file that may be
@ -32,91 +32,89 @@ model:
equivalents. equivalents.
* Public top level module instances are exposed as pointers to allow access * Public top level module instances are exposed as pointers to allow access
to :code:`/* verilator public */` items. to ``/* verilator public */`` items.
* The root of the design hierarchy (as in SystemVerilog :code:`$root`) is * The root of the design hierarchy (as in SystemVerilog ``$root``) is
exposed via the :code:`rootp` member pointer to allow access to model exposed via the ``rootp`` member pointer to allow access to model
internals, including :code:`/* verilator public_flat */` items. internals, including ``/* verilator public_flat */`` items.
.. _Porting from pre 4.210: .. _porting from pre 4.210:
Model interface changes in version 4.210 Model interface changes in version 4.210
------------------------------------------ ----------------------------------------
Starting from version 4.210, the model class is an interface object. Starting from version 4.210, the model class is an interface object.
Up until Verilator version 4.204 inclusive, the generated model class was Up until Verilator version 4.204 inclusive, the generated model class was
also the instance of the top level instance in the design hierarchy (what also the instance of the top level instance in the design hierarchy (what
you would refer to with :code:`$root` in SystemVerilog). This meant that you would refer to with ``$root`` in SystemVerilog). This meant that all
all internal variables that were implemented by Verilator in the root scope internal variables that were implemented by Verilator in the root scope
were accessible as members of the model class itself. Note there were often were accessible as members of the model class itself. Note there were often
many such variable due to module inlining, including many such variable due to module inlining, including ``/* verilator
:code:`/* verilator public_flat */` items. public_flat */`` items.
This means that user code that accesses internal signals in the model This means that user code that accesses internal signals in the model
(likely including :code:`/* verilator public_flat */` signals, as they are (likely including ``/* verilator public_flat */`` signals, as they are
often inlined into the root scope) will need to be updated as follows: often inlined into the root scope) will need to be updated as follows:
* No change required for accessing top level IO signals. These are directly * No change required for accessing top level IO signals. These are directly
accessible in the model class via references. accessible in the model class via references.
* No change required for accessing :code:`/* verilator public */` items. * No change required for accessing ``/* verilator public */`` items. These
These are directly accessible via sub-module pointers in the model class. are directly accessible via sub-module pointers in the model class.
* Accessing any other internal members, including * Accessing any other internal members, including
:code:`/* verilator public_flat */` items requires the following changes: ``/* verilator public_flat */`` items requires the following changes:
* Additionally include :file:`{prefix}___024root.h`. This header defines * Additionally include :file:`{prefix}___024root.h`. This header defines
type of the :code:`rootp` pointer within the model class. Note the type of the ``rootp`` pointer within the model class. Note the
:code:`__024` substring is the Verilator escape sequence for the ``__024`` substring is the Verilator escape sequence for the ``$``
:code:`$` character, i.e.: :code:`rootp` points to the Verilated character, i.e.: ``rootp`` points to the Verilated SystemVerilog
SystemVerilog :code:`$root` scope. ``$root`` scope.
* Replace :code:`modelp->internal->member` references with * Replace ``modelp->internal->member`` references with
:code:`modelp->rootp->internal->member` references, which ``modelp->rootp->internal->member`` references, which contain one
contain one additional indirection via the :code:`rootp` pointer. additional indirection via the ``rootp`` pointer.
.. _Connecting to C++: .. _connecting to c++:
Connecting to C++ Connecting to C++
================= =================
In C++ output mode (:vlopt:`--cc`), the Verilator generated model class is a In C++ output mode (:vlopt:`--cc`), the Verilator generated model class is
simple C++ class. The user must write a C++ wrapper and main loop for the a simple C++ class. The user must write a C++ wrapper and main loop for the
simulation, which instantiates the model class, and link with the Verilated simulation, which instantiates the model class, and link with the Verilated
model. model.
Refer to ``examples/make_tracing_c`` in the distribution for a detailed Refer to ``examples/make_tracing_c`` in the distribution for a detailed
commented example. commented example.
Top level IO signals are read and written as members of the model. You Top level IO signals are read and written as members of the model. You call
call the model's :code:`eval()` method to evaluate the model. When the the model's ``eval()`` method to evaluate the model. When the simulation is
simulation is complete call the model's :code:`final()` method to execute complete call the model's ``final()`` method to execute any SystemVerilog
any SystemVerilog final blocks, and complete any assertions. If using final blocks, and complete any assertions. If using :vlopt:`--timing`,
:vlopt:`--timing`, there are two additional functions for checking if there are two additional functions for checking if there are any events
there are any events pending in the simulation due to delays, and for pending in the simulation due to delays, and for retrieving the simulation
retrieving the simulation time of the next delayed event. See time of the next delayed event. See :ref:`Evaluation Loop`.
:ref:`Evaluation Loop`.
Connecting to SystemC Connecting to SystemC
===================== =====================
In SystemC output mode (:vlopt:`--sc`), the Verilator generated model class In SystemC output mode (:vlopt:`--sc`), the Verilator generated model class
is a SystemC SC_MODULE. This module will attach directly into a SystemC is a SystemC SC_MODULE. This module will attach directly into a SystemC
netlist as an instantiation. netlist as an instantiation.
The SC_MODULE gets the same pinout as the Verilog module, with the The SC_MODULE gets the same pinout as the Verilog module, with the
following type conversions: Pins of a single bit become bool. Pins 2-32 following type conversions: Pins of a single bit become bool. Pins 2-32
bits wide become uint32_t's. Pins 33-64 bits wide become sc_bv's or bits wide become uint32_t's. Pins 33-64 bits wide become sc_bv's or
uint64_t's depending on the :vlopt:`--no-pins64` option. Wider pins uint64_t's depending on the :vlopt:`--no-pins64` option. Wider pins become
become sc_bv's. (Uints simulate the fastest so are used where possible.) sc_bv's. (Uints simulate the fastest so are used where possible.)
Model internals, including lower level sub-modules are not pure SystemC Model internals, including lower level sub-modules are not pure SystemC
code. This is a feature, as using the SystemC pin interconnect scheme code. This is a feature, as using the SystemC pin interconnect scheme
everywhere would reduce performance by an order of magnitude. everywhere would reduce performance by an order of magnitude.
@ -124,41 +122,42 @@ Verilated API
============= =============
The API to a Verilated model is the C++ headers in the include/ directory The API to a Verilated model is the C++ headers in the include/ directory
in the distribution. These headers use Doxygen comments, `///` and `//<`, in the distribution. These headers use Doxygen comments, `///` and `//<`,
to indicate and document those functions that are part of the Verilated to indicate and document those functions that are part of the Verilated
public API. public API.
Process-Level Clone APIs Process-Level Clone APIs
-------------------------- ------------------------
Modern operating systems support process-level clone (a.k.a copying, forking) Modern operating systems support process-level clone (a.k.a copying,
with system call interfaces in C/C++, e.g., :code:`fork()` in Linux. forking) with system call interfaces in C/C++, e.g., ``fork()`` in Linux.
However, after cloning a parent process, some resources cannot be inherited However, after cloning a parent process, some resources cannot be inherited
in the child process. For example, in POSIX systems, when you fork a process, in the child process. For example, in POSIX systems, when you fork a
the child process inherits all the memory of the parent process. However, process, the child process inherits all the memory of the parent process.
only the thread that called fork is replicated in the child process. Other However, only the thread that called fork is replicated in the child
threads are not. process. Other threads are not.
Therefore, to support the process-level clone mechanisms, Verilator supports Therefore, to support the process-level clone mechanisms, Verilator
:code:`prepareClone()` and :code:`atClone()` APIs to allow the user to manually supports ``prepareClone()`` and ``atClone()`` APIs to allow the user to
re-construct the model in the child process. The two APIs handle all necessary manually re-construct the model in the child process. The two APIs handle
resources required for releasing and re-initializing before and after cloning. all necessary resources required for releasing and re-initializing before
and after cloning.
The two APIs are supported in the verilated models. Here is an example of usage The two APIs are supported in the verilated models. Here is an example of
with Linux :code:`fork()` and :code:`pthread_atfork` APIs: usage with Linux ``fork()`` and ``pthread_atfork`` APIs:
.. code-block:: C++ .. code-block:: C++
// static function pointers to fit pthread_atfork // static function pointers to fit pthread_atfork
static auto prepareClone = [](){ topp->prepareClone(); }; static auto prepareClone = [](){ topp->prepareClone(); };
static auto atClone = [](){ topp->atClone(); }; static auto atClone = [](){ topp->atClone(); };
// in main function, register the handlers: // in main function, register the handlers:
pthread_atfork(prepareClone, atClone, atClone); pthread_atfork(prepareClone, atClone, atClone);
For better flexibility, you can also manually call the handlers before and For better flexibility, you can also manually call the handlers before and
after :code:`fork()`. after ``fork()``.
With the process-level clone APIs, users can create process-level snapshots With the process-level clone APIs, users can create process-level snapshots
for the verilated models. While the Verilator save/restore option provides for the verilated models. While the Verilator save/restore option provides
@ -170,7 +169,7 @@ Direct Programming Interface (DPI)
================================== ==================================
Verilator supports SystemVerilog Direct Programming Interface import and Verilator supports SystemVerilog Direct Programming Interface import and
export statements. Only the SystemVerilog form ("DPI-C") is supported, not export statements. Only the SystemVerilog form ("DPI-C") is supported, not
the original Synopsys-only DPI. the original Synopsys-only DPI.
DPI Example DPI Example
@ -181,76 +180,76 @@ Verilog, put in our.v:
.. code-block:: .. code-block::
import "DPI-C" function int add (input int a, input int b); import "DPI-C" function int add (input int a, input int b);
initial begin initial begin
$display("%x + %x = %x", 1, 2, add(1,2)); $display("%x + %x = %x", 1, 2, add(1,2));
endtask endtask
Then after Verilating, Verilator will create a file Vour__Dpi.h with the Then after Verilating, Verilator will create a file Vour__Dpi.h with the
prototype to call this function: prototype to call this function:
.. code-block:: C++ .. code-block:: C++
extern int add(int a, int b); extern int add(int a, int b);
From the sc_main.cpp file (or another .cpp file passed to the Verilator From the sc_main.cpp file (or another .cpp file passed to the Verilator
command line, or the link), you'd then: command line, or the link), you'd then:
.. code-block:: C++ .. code-block:: C++
#include "svdpi.h" #include "svdpi.h"
#include "Vour__Dpi.h" #include "Vour__Dpi.h"
int add(int a, int b) { return a+b; } int add(int a, int b) { return a+b; }
DPI System Task/Functions DPI System Task/Functions
------------------------- -------------------------
Verilator extends the DPI format to allow using the same scheme to Verilator extends the DPI format to allow using the same scheme to
efficiently add system functions. Use a dollar-sign prefixed system efficiently add system functions. Use a dollar-sign prefixed system
function name for the import, but note it must be escaped. function name for the import, but note it must be escaped.
.. code-block:: sv .. code-block:: sv
export "DPI-C" function integer \$myRand; export "DPI-C" function integer \$myRand;
initial $display("myRand=%d", $myRand()); initial $display("myRand=%d", $myRand());
Going the other direction, you can export Verilog tasks so they can be Going the other direction, you can export Verilog tasks so they can be
called from C++: called from C++:
.. code-block:: sv .. code-block:: sv
export "DPI-C" task publicSetBool; export "DPI-C" task publicSetBool;
task publicSetBool; task publicSetBool;
input bit in_bool; input bit in_bool;
var_bool = in_bool; var_bool = in_bool;
endtask endtask
Then after Verilating, Verilator will create a file Vour__Dpi.h with the Then after Verilating, Verilator will create a file Vour__Dpi.h with the
prototype to call this function: prototype to call this function:
.. code-block:: C++ .. code-block:: C++
extern void publicSetBool(svBit in_bool); extern void publicSetBool(svBit in_bool);
From the sc_main.cpp file, you'd then: From the sc_main.cpp file, you'd then:
.. code-block:: C++ .. code-block:: C++
#include "Vour__Dpi.h" #include "Vour__Dpi.h"
publicSetBool(value); publicSetBool(value);
Or, alternatively, call the function under the design class. This isn't Or, alternatively, call the function under the design class. This isn't DPI
DPI compatible but is easier to read and better supports multiple designs. compatible but is easier to read and better supports multiple designs.
.. code-block:: C++ .. code-block:: C++
#include "Vour__Dpi.h" #include "Vour__Dpi.h"
Vour::publicSetBool(value); Vour::publicSetBool(value);
// or top->publicSetBool(value); // or top->publicSetBool(value);
Note that if the DPI task or function accesses any register or net within Note that if the DPI task or function accesses any register or net within
the RTL, it will require a scope to be set. This can be done using the the RTL, it will require a scope to be set. This can be done using the
@ -263,11 +262,11 @@ with respect to that top level module, then the scope could be set with
.. code-block:: C++ .. code-block:: C++
#include "svdpi.h" #include "svdpi.h"
... ...
const svScope scope = svGetScopeFromName("TOP.dut"); const svScope scope = svGetScopeFromName("TOP.dut");
assert(scope); // Check for nullptr if scope not found assert(scope); // Check for nullptr if scope not found
svSetScope(scope); svSetScope(scope);
(Remember that Verilator adds a "TOP" to the top of the module hierarchy.) (Remember that Verilator adds a "TOP" to the top of the module hierarchy.)
@ -282,24 +281,24 @@ DPI Imports that access signals
If a DPI import accesses a signal through the VPI Verilator will not be If a DPI import accesses a signal through the VPI Verilator will not be
able to know what variables are accessed and may schedule the code able to know what variables are accessed and may schedule the code
inappropriately. Ideally pass the values as inputs/outputs so the VPI is inappropriately. Ideally pass the values as inputs/outputs so the VPI is
not required. Alternatively a workaround is to use a non-inlined task as a not required. Alternatively a workaround is to use a non-inlined task as a
wrapper: wrapper:
.. code-block:: .. code-block::
logic din; logic din;
// This DPI function will read "din" // This DPI function will read "din"
import "DPI-C" context function void dpi_that_accesses_din(); import "DPI-C" context function void dpi_that_accesses_din();
always @(...) always @(...)
dpi_din_args(din); dpi_din_args(din);
task dpi_din_args(input din); task dpi_din_args(input din);
// verilator no_inline_task // verilator no_inline_task
dpi_that_accesses_din(); dpi_that_accesses_din();
endtask endtask
DPI Display Functions DPI Display Functions
@ -309,8 +308,8 @@ Verilator allows writing $display like functions using this syntax:
.. code-block:: .. code-block::
import "DPI-C" function void import "DPI-C" function void
\$my_display(input string formatted /*verilator sformat*/ ); \$my_display(input string formatted /*verilator sformat*/ );
The :option:`/*verilator&32;sformat*/` metacomment indicates that this The :option:`/*verilator&32;sformat*/` metacomment indicates that this
function accepts a $display like format specifier followed by any number of function accepts a $display like format specifier followed by any number of
@ -320,14 +319,14 @@ arguments to satisfy the format.
DPI Context Functions DPI Context Functions
--------------------- ---------------------
Verilator supports IEEE DPI Context Functions. Context imports pass the Verilator supports IEEE DPI Context Functions. Context imports pass the
simulator context, including calling scope name, and filename and line simulator context, including calling scope name, and filename and line
number to the C code. For example, in Verilog: number to the C code. For example, in Verilog:
.. code-block:: .. code-block::
import "DPI-C" context function int dpic_line(); import "DPI-C" context function int dpic_line();
initial $display("This is line %d, again, line %d\n", `line, dpic_line()); initial $display("This is line %d, again, line %d\n", `line, dpic_line());
This will call C++ code which may then use the svGet\* functions to read This will call C++ code which may then use the svGet\* functions to read
information, in this case the line number of the Verilog statement that information, in this case the line number of the Verilog statement that
@ -335,22 +334,22 @@ invoked the dpic_line function:
.. code-block:: C++ .. code-block:: C++
int dpic_line() { int dpic_line() {
// Get a scope: svScope scope = svGetScope(); // Get a scope: svScope scope = svGetScope();
const char* scopenamep = svGetNameFromScope(scope); const char* scopenamep = svGetNameFromScope(scope);
assert(scopenamep); assert(scopenamep);
const char* filenamep = ""; const char* filenamep = "";
int lineno = 0; int lineno = 0;
if (svGetCallerInfo(&filenamep, &lineno)) { if (svGetCallerInfo(&filenamep, &lineno)) {
printf("dpic_line called from scope %s on line %d\n", printf("dpic_line called from scope %s on line %d\n",
scopenamep, lineno); scopenamep, lineno);
return lineno; return lineno;
} else { } else {
return 0; return 0;
} }
} }
See the IEEE Standard for more information. See the IEEE Standard for more information.
@ -359,13 +358,12 @@ DPI Header Isolation
-------------------- --------------------
Verilator places the IEEE standard header files such as svdpi.h into a Verilator places the IEEE standard header files such as svdpi.h into a
separate include directory, vltstd (VeriLaTor STandarD). When compiling separate include directory, vltstd (VeriLaTor STandarD). When compiling
most applications $VERILATOR_ROOT/include/vltstd would be in the include most applications $VERILATOR_ROOT/include/vltstd would be in the include
path along with the normal $VERILATOR_ROOT/include. However, when path along with the normal $VERILATOR_ROOT/include. However, when compiling
compiling Verilated models into other simulators which have their own Verilated models into other simulators which have their own svdpi.h and
svdpi.h and similar standard files with different contents, the vltstd similar standard files with different contents, the vltstd directory should
directory should not be included to prevent picking up incompatible not be included to prevent picking up incompatible definitions.
definitions.
Public Functions Public Functions
@ -378,24 +376,23 @@ are slightly faster, but less compatible.
Verification Procedural Interface (VPI) Verification Procedural Interface (VPI)
======================================= =======================================
Verilator supports a limited subset of the VPI. This subset allows Verilator supports a limited subset of the VPI. This subset allows
inspection, examination, value change callbacks, and depositing of values inspection, examination, value change callbacks, and depositing of values
to public signals only. to public signals only.
VPI is enabled with the Verilator :vlopt:`--vpi` option. VPI is enabled with the Verilator :vlopt:`--vpi` option.
To access signals via the VPI, Verilator must be told exactly which signals To access signals via the VPI, Verilator must be told exactly which signals
are to be accessed. This is done using the Verilator public pragmas are to be accessed. This is done using the Verilator public pragmas
documented below. documented below.
Verilator has an important difference from an event based simulator; signal Verilator has an important difference from an event based simulator; signal
values that are changed by the VPI will not immediately propagate their values that are changed by the VPI will not immediately propagate their
values, instead the top level header file's :code:`eval()` method must be values, instead the top level header file's ``eval()`` method must be
called. Normally this would be part of the normal evaluation (i.e. the called. Normally this would be part of the normal evaluation (i.e. the next
next clock edge), not as part of the value change. This makes the clock edge), not as part of the value change. This makes the performance of
performance of VPI routines extremely fast compared to event based VPI routines extremely fast compared to event based simulators, but can
simulators, but can confuse some test-benches that expect immediate confuse some test-benches that expect immediate propagation.
propagation.
Note the VPI by its specified implementation will always be much slower Note the VPI by its specified implementation will always be much slower
than accessing the Verilator values by direct reference than accessing the Verilator values by direct reference
@ -405,132 +402,131 @@ while the direct references are evaluated by the compiler and result in
only a couple of instructions. only a couple of instructions.
For signal callbacks to work the main loop of the program must call For signal callbacks to work the main loop of the program must call
:code:`VerilatedVpi::callValueCbs()`. ``VerilatedVpi::callValueCbs()``.
Verilator also tracks when the model state has been modified via the VPI with Verilator also tracks when the model state has been modified via the VPI
an :code:`evalNeeded` flag. This flag can be checked with :code:`VerilatedVpi::evalNeeded()` with an ``evalNeeded`` flag. This flag can be checked with
and it can be cleared with :code:`VerilatedVpi::clearEvalNeeded()`. Used together ``VerilatedVpi::evalNeeded()`` and it can be cleared with
it is possible to skip :code:`eval()` calls if no model state has been changed ``VerilatedVpi::clearEvalNeeded()``. Used together it is possible to skip
since the last :code:`eval()`. ``eval()`` calls if no model state has been changed since the last
``eval()``.
Any data written via :code:`vpi_put_value` with :code:`vpiInertialDelay` will Any data written via ``vpi_put_value`` with ``vpiInertialDelay`` will be
be deferred for later. These delayed values can be flushed to the model with deferred for later. These delayed values can be flushed to the model with
:code:`VerilatedVpi::doInertialPuts()`. ``VerilatedVpi::doInertialPuts()``.
.. _VPI Example: .. _vpi example:
VPI Example VPI Example
----------- -----------
In the below example, we have readme marked read-only, and writeme marked In the below example, we have readme marked read-only, and writeme marked
read-write which if written from outside the model will have the same semantics read-write which if written from outside the model will have the same
as if it was a top level input. semantics as if it was a top level input.
.. code-block:: bash .. code-block:: bash
cat >our.v <<'EOF' cat >our.v <<'EOF'
module our #( module our #(
parameter WIDTH /*verilator public_flat_rd*/ = 32 parameter WIDTH /*verilator public_flat_rd*/ = 32
) (input clk); ) (input clk);
reg [WIDTH-1:0] readme /*verilator public_flat_rd*/; reg [WIDTH-1:0] readme /*verilator public_flat_rd*/;
reg [WIDTH-1:0] writeme /*verilator public_flat_rw*/; reg [WIDTH-1:0] writeme /*verilator public_flat_rw*/;
initial $finish; initial $finish;
endmodule endmodule
EOF EOF
There are many online tutorials and books on the VPI, but an example that There are many online tutorials and books on the VPI, but an example that
accesses the above signal "readme" would be: accesses the above signal "readme" would be:
.. code-block:: bash .. code-block:: bash
cat >sim_main.cpp <<'EOF' cat >sim_main.cpp <<'EOF'
#include "Vour.h" #include "Vour.h"
#include "verilated.h" #include "verilated.h"
#include "verilated_vpi.h" // Required to get definitions #include "verilated_vpi.h" // Required to get definitions
uint64_t main_time = 0; // See comments in first example uint64_t main_time = 0; // See comments in first example
double sc_time_stamp() { return main_time; } double sc_time_stamp() { return main_time; }
void read_and_check() { void read_and_check() {
vpiHandle vh1 = vpi_handle_by_name((PLI_BYTE8*)"TOP.our.readme", NULL); vpiHandle vh1 = vpi_handle_by_name((PLI_BYTE8*)"TOP.our.readme", NULL);
if (!vh1) vl_fatal(__FILE__, __LINE__, "sim_main", "No handle found"); if (!vh1) vl_fatal(__FILE__, __LINE__, "sim_main", "No handle found");
const char* name = vpi_get_str(vpiName, vh1); const char* name = vpi_get_str(vpiName, vh1);
const char* type = vpi_get_str(vpiType, vh1); const char* type = vpi_get_str(vpiType, vh1);
const int size = vpi_get(vpiSize, vh1); const int size = vpi_get(vpiSize, vh1);
printf("register name: %s, type: %s, size: %d\n", name, type, size); // Prints "register name: readme, type: vpiReg, size: 32" printf("register name: %s, type: %s, size: %d\n", name, type, size); // Prints "register name: readme, type: vpiReg, size: 32"
s_vpi_value v; s_vpi_value v;
v.format = vpiIntVal; v.format = vpiIntVal;
vpi_get_value(vh1, &v); vpi_get_value(vh1, &v);
printf("Value of %s: %d\n", name, v.value.integer); // Prints "Value of readme: 0" printf("Value of %s: %d\n", name, v.value.integer); // Prints "Value of readme: 0"
} }
int main(int argc, char** argv) { int main(int argc, char** argv) {
Verilated::commandArgs(argc, argv); Verilated::commandArgs(argc, argv);
const std::unique_ptr<VerilatedContext> contextp{new VerilatedContext}; const std::unique_ptr<VerilatedContext> contextp{new VerilatedContext};
const std::unique_ptr<Vour> top{new Vour{contextp.get()}}; const std::unique_ptr<Vour> top{new Vour{contextp.get()}};
contextp->internalsDump(); // See scopes to help debug contextp->internalsDump(); // See scopes to help debug
while (!contextp->gotFinish()) { while (!contextp->gotFinish()) {
top->eval(); top->eval();
VerilatedVpi::callValueCbs(); // For signal callbacks VerilatedVpi::callValueCbs(); // For signal callbacks
read_and_check(); read_and_check();
} }
return 0; return 0;
} }
EOF EOF
.. _Evaluation Loop: .. _evaluation loop:
Wrappers and Model Evaluation Loop Wrappers and Model Evaluation Loop
================================== ==================================
When using SystemC, evaluation of the Verilated model is managed by the When using SystemC, evaluation of the Verilated model is managed by the
SystemC kernel, and for the most part can be ignored. When using C++, the SystemC kernel, and for the most part can be ignored. When using C++, the
user must call :code:`eval()`, or :code:`eval_step()` and user must call ``eval()``, or ``eval_step()`` and ``eval_end_step()``.
:code:`eval_end_step()`.
1. When there is a single design instantiated at the C++ level that needs 1. When there is a single design instantiated at the C++ level that needs
to evaluate within a given context, call :code:`designp->eval()`. to evaluate within a given context, call ``designp->eval()``.
2. When there are multiple designs instantiated at the C++ level that need 2. When there are multiple designs instantiated at the C++ level that need
to evaluate within a context, call :code:`first_designp->eval_step()` then to evaluate within a context, call ``first_designp->eval_step()`` then
:code:`->eval_step()` on all other designs. Then call ``->eval_step()`` on all other designs. Then call ``->eval_end_step()`` on
:code:`->eval_end_step()` on the first design then all other designs. If the first design then all other designs. If there is only a single design,
there is only a single design, you would call :code:`eval_step()` then you would call ``eval_step()`` then ``eval_end_step()``; in fact ``eval()``
:code:`eval_end_step()`; in fact :code:`eval()` described above is just a described above is just a wrapper which calls these two functions.
wrapper which calls these two functions.
3. If using delays and :vlopt:`--timing`, there are two additional methods 3. If using delays and :vlopt:`--timing`, there are two additional methods
the user should call: the user should call:
* :code:`designp->eventsPending()`, which returns :code:`true` if there are * ``designp->eventsPending()``, which returns ``true`` if there are any
any delayed events pending, delayed events pending,
* :code:`designp->nextTimeSlot()`, which returns the simulation time of the * ``designp->nextTimeSlot()``, which returns the simulation time of the
next delayed event. This method can only be called if next delayed event. This method can only be called if
:code:`designp->eventsPending()` returned :code:`true`. ``designp->eventsPending()`` returned ``true``.
Call :code:`eventsPending()` to check if you should continue with the Call ``eventsPending()`` to check if you should continue with the
simulation, and then :code:`nextTimeSlot()` to move simulation time forward. simulation, and then ``nextTimeSlot()`` to move simulation time forward.
:vlopt:`--main` can be used with :vlopt:`--timing` to generate a basic example :vlopt:`--main` can be used with :vlopt:`--timing` to generate a basic
of a timing-enabled eval loop. example of a timing-enabled eval loop.
When :code:`eval()` (or :code:`eval_step()`) is called Verilator looks for When ``eval()`` (or ``eval_step()``) is called Verilator looks for changes
changes in clock signals and evaluates related sequential always blocks, in clock signals and evaluates related sequential always blocks, such as
such as computing always_ff @ (posedge...) outputs. With :vlopt:`--timing`, it computing always_ff @ (posedge...) outputs. With :vlopt:`--timing`, it
resumes any delayed processes awaiting the current simulation time. Then resumes any delayed processes awaiting the current simulation time. Then
Verilator evaluates combinational logic. Verilator evaluates combinational logic.
Note combinatorial logic is not computed before sequential always blocks Note combinatorial logic is not computed before sequential always blocks
are computed (for speed reasons). Therefore it is best to set any non-clock are computed (for speed reasons). Therefore it is best to set any non-clock
inputs up with a separate :code:`eval()` call before changing clocks. inputs up with a separate ``eval()`` call before changing clocks.
Alternatively, if all always_ff statements use only the posedge of clocks, Alternatively, if all always_ff statements use only the posedge of clocks,
or all inputs go directly to always_ff statements, as is typical, then you or all inputs go directly to always_ff statements, as is typical, then you
can change non-clock inputs on the negative edge of the input clock, which can change non-clock inputs on the negative edge of the input clock, which
will be faster as there will be fewer :code:`eval()` calls. will be faster as there will be fewer ``eval()`` calls.
For more information on evaluation, see :file:`docs/internals.rst` in the For more information on evaluation, see :file:`docs/internals.rst` in the
distribution. distribution.
@ -540,18 +536,18 @@ Verilated and VerilatedContext
============================== ==============================
Multiple C++ Verilated models may be part of the same simulation context, Multiple C++ Verilated models may be part of the same simulation context,
that is share a VPI interface, sense of time, and common settings. This that is share a VPI interface, sense of time, and common settings. This
common simulation context information is stored in a ``VerilatedContext`` common simulation context information is stored in a ``VerilatedContext``
structure. If a ``VerilatedContext`` is not created prior to creating a structure. If a ``VerilatedContext`` is not created prior to creating a
model, a default global one is created automatically. SystemC requires model, a default global one is created automatically. SystemC requires
using only the single, default VerilatedContext. using only the single, default VerilatedContext.
The ``Verilated::`` methods, including the ``Verilated::commandArgs`` call The ``Verilated::`` methods, including the ``Verilated::commandArgs`` call
shown above, call VerilatedContext methods using the default global shown above, call VerilatedContext methods using the default global
VerilatedContext. (Technically they operate on the last one used by a VerilatedContext. (Technically they operate on the last one used by a given
given thread.) If you are using multiple simulation contexts you should thread.) If you are using multiple simulation contexts you should not use
not use the Verilated:: methods, and instead always use VerilatedContext the Verilated:: methods, and instead always use VerilatedContext methods
methods called on the appropriate VerilatedContext object. called on the appropriate VerilatedContext object.
For methods available under Verilated and VerilatedContext see For methods available under Verilated and VerilatedContext see
:file:`include/verilated.h` in the distribution. :file:`include/verilated.h` in the distribution.

View File

@ -1,4 +1,4 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
******************************* *******************************
@ -19,50 +19,50 @@ Reporting Bugs
First, check the :ref:`Language Limitations` section. First, check the :ref:`Language Limitations` section.
Next, try the :vlopt:`--debug` option. This will enable additional Next, try the :vlopt:`--debug` option. This will enable additional internal
internal assertions, and may help identify the problem. assertions, and may help identify the problem.
Finally, reduce your code to the smallest possible routine that exhibits Finally, reduce your code to the smallest possible routine that exhibits
the bug (see: :ref:`Minimizing bug-inducing code`). Even better, create the bug (see: :ref:`Minimizing bug-inducing code`). Even better, create a
a test in the :file:`test_regress/t` directory, as follows: test in the :file:`test_regress/t` directory, as follows:
.. code-block:: bash .. code-block:: bash
cd test_regress cd test_regress
cp -p t/t_EXAMPLE.py t/t_BUG.py cp -p t/t_EXAMPLE.py t/t_BUG.py
cp -p t/t_EXAMPLE.v t/t_BUG.v cp -p t/t_EXAMPLE.v t/t_BUG.v
There are many hints on how to write a good test in the There are many hints on how to write a good test in the
:file:`test_regress/driver.py` documentation which can be seen by running: :file:`test_regress/driver.py` documentation which can be seen by running:
.. code-block:: bash .. code-block:: bash
cd $VERILATOR_ROOT # Need the original distribution kit cd $VERILATOR_ROOT # Need the original distribution kit
test_regress/driver.py --help test_regress/driver.py --help
Edit :file:`t/t_BUG.py` to suit your example; you can do anything you want Edit :file:`t/t_BUG.py` to suit your example; you can do anything you want
in the Verilog code there; just make sure it retains the single clk input in the Verilog code there; just make sure it retains the single clk input
and no outputs. Now, the following should fail: and no outputs. Now, the following should fail:
.. code-block:: bash .. code-block:: bash
cd $VERILATOR_ROOT # Need the original distribution kit cd $VERILATOR_ROOT # Need the original distribution kit
cd test_regress cd test_regress
t/t_BUG.py # Run on Verilator t/t_BUG.py # Run on Verilator
t/t_BUG.py --debug # Run on Verilator, passing --debug to Verilator t/t_BUG.py --debug # Run on Verilator, passing --debug to Verilator
t/t_BUG.py --vcs # Run on VCS simulator t/t_BUG.py --vcs # Run on VCS simulator
t/t_BUG.py --nc|--iv|--ghdl # Likewise on other simulators t/t_BUG.py --nc|--iv|--ghdl # Likewise on other simulators
The test driver accepts a number of options, many of which mirror the main The test driver accepts a number of options, many of which mirror the main
Verilator options. For example the previous test could have been run with Verilator options. For example the previous test could have been run with
debugging enabled. The full set of test options can be seen by running debugging enabled. The full set of test options can be seen by running
:command:`driver.py --help` as shown above. :command:`driver.py --help` as shown above.
Finally, report the bug at `Verilator Issues Finally, report the bug at `Verilator Issues
<https://verilator.org/issues>`_. The bug will become publicly visible; if <https://verilator.org/issues>`_. The bug will become publicly visible; if
this is unacceptable, mail the bug report to ``wsnyder@wsnyder.org``. this is unacceptable, mail the bug report to ``wsnyder@wsnyder.org``.
.. _Minimizing bug-inducing code: .. _minimizing bug-inducing code:
Minimizing bug-inducing code Minimizing bug-inducing code
============================ ============================
@ -73,12 +73,12 @@ caused by a complex interaction of many parts of the design, and it is not
clear which parts are necessary to reproduce the bug. In these cases, an clear which parts are necessary to reproduce the bug. In these cases, an
Open Source tool called `sv-bugpoint Open Source tool called `sv-bugpoint
<https://github.com/antmicro/sv-bugpoint>`_ can be used to automatically <https://github.com/antmicro/sv-bugpoint>`_ can be used to automatically
reduce a SystemVerilog design to the smallest possible reproducer. reduce a SystemVerilog design to the smallest possible reproducer. It can
It can be used to automatically reduce a design with hundreds of thousands of be used to automatically reduce a design with hundreds of thousands of
lines to a minimal test case while preserving the bug-inducing behavior. lines to a minimal test case while preserving the bug-inducing behavior.
With :vlopt:`--debug` or :vlopt:`--dump-inputs`, Verilator will write a With :vlopt:`--debug` or :vlopt:`--dump-inputs`, Verilator will write a
*{prefix}*\ __inputs\ .vpp file which has all of the individual input files *{prefix}*\ __inputs.vpp file which has all of the individual input files
combined and pre-processed, this is often useful as the input design into combined and pre-processed, this is often useful as the input design into
`sv-bugpoint`. `sv-bugpoint`.
@ -88,4 +88,5 @@ information on how to use `sv-bugpoint`.
.. Contributing .. Contributing
.. ============ .. ============
.. include:: ../CONTRIBUTING.rst .. include:: ../CONTRIBUTING.rst

View File

@ -1,4 +1,4 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
************************ ************************
@ -28,10 +28,11 @@ Alliance <https://chipsalliance.org>`_, and `Antmicro Ltd
Previous major corporate sponsors of Verilator, by providing significant Previous major corporate sponsors of Verilator, by providing significant
contributions of time or funds include: Antmicro Ltd., Atmel Corporation, contributions of time or funds include: Antmicro Ltd., Atmel Corporation,
Compaq Corporation, Digital Equipment Corporation, Embecosm Ltd., Hicamp Compaq Corporation, Digital Equipment Corporation, Embecosm Ltd., Fractile
Systems, Intel Corporation, Marvell Inc., Mindspeed Technologies Inc., Ltd., Hicamp Systems, Intel Corporation, Marvell Inc., Mindspeed
MicroTune Inc., picoChip Designs Ltd., Sun Microsystems Inc., Nauticus Technologies Inc., MicroTune Inc., picoChip Designs Ltd., Sun Microsystems
Networks Inc., SiCortex Inc, Shunyao CAD, and Western Digital Inc. Inc., Nauticus Networks Inc., SiCortex Inc, Shunyao CAD, and Western
Digital Inc.
The contributors of major functionality are: Jeremy Bennett, Krzysztof The contributors of major functionality are: Jeremy Bennett, Krzysztof
Bieganski, Byron Bradley, Lane Brooks, John Coiner, Duane Galbi, Arkadiusz Bieganski, Byron Bradley, Lane Brooks, John Coiner, Duane Galbi, Arkadiusz
@ -41,133 +42,158 @@ Paul Wasson, Jie Xu, and Wilson Snyder.
Some of the people who have provided ideas, and feedback for Verilator Some of the people who have provided ideas, and feedback for Verilator
include: include:
David Addison, Tariq B. Ahmad, Nikana Anastasiadis, John David Anglin, Gilberto Abram, David Addison, Joey Ah-kiow, Thomas Dybdahl Ahle, Tariq B.
Frederic Antonin, Hans Van Antwerpen, Vasu Arasanipalai, Jens Arm, Rohan Ahmad, Thomas Aldrian, Omar Alkhatib, Amal Araweelo Almis, Nikana
Arshid, Valentin Atepalikhin, Philip Axer, Gökçe Aydos, Chris Bachhuber, Anastasiadis, John David Anglin, Frederic Antonin, Hans Van Antwerpen, Vasu
Filip Badáň, Adam Bagley, Sharad Bagri, James Bailey, Robert Balas, Marco Arasanipalai, Jens Arm, Rohan Arshid, Valentin Atepalikhin, Philip Axer,
Balboni, Matthew Ballance, Ricardo Barbedo, Andrew Bardsley, Ilya Barkov, Gökçe Aydos, Chris Bachhuber, Filip Badáň, Adam Bagley, Sharad Bagri, James
Matthew Barr, Geoff Barrett, Kaleb Barrett, Daniel Bates, Julius Baxter, Bailey, Robert Balas, Marco Balboni, Matthew Ballance, Ricardo Barbedo,
Michael Berman, Jean Berniolles, Victor Besyakov, Narayan Bhagavatula, Andrew Bardsley, Ilya Barkov, Matthew Barr, Geoff Barrett, Kaleb Barrett,
Moinak Bhattacharyya, Kritik Bhimani, David Biancolin, Krzysztof Bieganski, Daniel Bates, Julius Baxter, Jeremy Bennett, Michael Berman, Jean
Michael Bikovitsky, David Binderman, Piotr Binkowski, Johan Björk, David Berniolles, Victor Besyakov, Narayan Bhagavatula, Moinak Bhattacharyya,
Black, Tymoteusz Blazejczyk, Scott Bleiweiss, David van der Bokke, Daniel Kritik Bhimani, David Biancolin, Krzysztof Bieganski, Artur Bieniek,
Bone, Guy Bonneau, Krzysztof Boroński, Gregg Bouchard, Christopher Michael Bikovitsky, David Binderman, Piotr Binkowski, Peter Birch, Johan
Boumenot, Paul Bowen-Huggett, Nick Bowler, Bryan Brady, Maarten De Björk, David Black, Tymoteusz Blazejczyk, Scott Bleiweiss, Joel Bodenmann,
Braekeleer, Liam Braun, Charlie Brej, J Briquet, John Brownlee, KC David van der Bokke, Daniel Bone, Guy Bonneau, Pierre-Yves Le Borgne,
Buckenmaier, Gijs Burghoorn, Jeff Bush, Lawrence Butcher, Tony Bybell, Iru Krzysztof Boroński, Gregg Bouchard, Christopher Boumenot, Paul
Cai, Ted Campbell, Anthony Campos, Chris Candler, Lauren Carlson, Gregory Bowen-Huggett, Nick Bowler, Byron Bradley, Bryan Brady, Maarten De
Carver, Donal Casey, Sebastien Van Cauwenberghe, Alex Chadwick, Greg Braekeleer, Liam Braun, Charlie Brej, Nick Brereton, J Briquet, Lane
Chadwick, Marcel Chang, Aliaksei Chapyzhenka, Chih-Mao Chen, Guokai Chen, Brooks, John Brownlee, KC Buckenmaier, Gijs Burghoorn, Jeff Bush, Lawrence
Kefa Chen, Terry Chen, Yangyu Chen, Yi-Chung Chen, Yurii Cherkasov, Butcher, Tony Bybell, Congcong Cai, Iru Cai, Ted Campbell, Anthony Campos,
Hennadii Chernyshchyk, Enzo Chi, Bartłomiej Chmiel, Robert A. Clark, Ryan Chris Candler, Lauren Carlson, Gregory Carver, Donal Casey, Sebastien Van
Clarke, Allan Cochrane, Keith Colbert, Quentin Corradi, Nassim Corteggiani, Cauwenberghe, Alex Chadwick, Greg Chadwick, Marcel Chang, Aliaksei
Gianfranco Costamagna, February Cozzocrea, Sean Cross, George Cuan, Michal Chapyzhenka, Chih-Mao Chen, Guokai Chen, Kefa Chen, Terry Chen, Yangyu
Czyz, Joe DErrico, Jim Dai, Lukasz Dalek, Laurens van Dam, Gunter Chen, Yi-Chung Chen, Yurii Cherkasov, Hennadii Chernyshchyk, Enzo Chi,
Dannoritzer, Ashutosh Das, Julian Daube, Greg Davill, Bernard Deadman, Bartłomiej Chmiel, Sergey Chusov, Robert A. Clark, Ryan Clarke, Allan
Peter Debacker, Josse Van Delm, John Demme, Mike Denio, John Deroo, Philip Cochrane, John Coiner, Luca Colagrande, Keith Colbert, Quentin Corradi,
Derrick, Aadi Desai, John Dickol, Ruben Diez, Danny Ding, Jacko Dirks, Ivan Nassim Corteggiani, Gianfranco Costamagna, February Cozzocrea, Sean Cross,
Djordjevic, Brad Dobbie, Paul Donahue, Jonathon Donaldson, Anthony Donlon, George Cuan, RJ Cunningham, Michal Czyz, Joe DErrico, Jim Dai, Lukasz
Caleb Donovick, Larry Doolittle, Leendert van Doorn, Sebastian Dressler, Dalek, Laurens van Dam, Gunter Dannoritzer, Ashutosh Das, Julian Daube,
Jonathan Drolet, Justin Yao Du, Maciej Dudek, Alex Duller, Jeff Dutton, Greg Davill, Bernard Deadman, Peter Debacker, Josse Van Delm, John Demme,
Tomas Dzetkulic, Usuario Eda, Charles Eddleston, Chandan Egbert, Joe Eiler, Mike Denio, John Deroo, Philip Derrick, Aadi Desai, John Dickol, Ruben
Ahmed El-Mahmoudy, Trevor Elbourne, Mats Engstrom, Robert Farrell, Julien Diez, Danny Ding, Jacko Dirks, Ivan Djordjevic, Brad Dobbie, Paul Donahue,
Faucher, Olivier Faure, Eugene Feinberg, Eugen Fekete, Fabrizio Ferrandi, Jonathon Donaldson, Anthony Donlon, Caleb Donovick, Larry Doolittle,
Udi Finkelstein, Brian Flachs, Bill Flynn, Andrea Foletto, Alex Forencich, Leendert van Doorn, Sebastian Dressler, Connor Driscoll, Jonathan Drolet,
Aurelien Francillon, Bob Fredieu, Manuel Freiberger, Mostafa Gamal, Vito Jose Drowne, Justin Yao Du, Maciej Dudek, Alex Duller, Jeff Dutton, Tomas
Gamberini, Mostafa Garnal, Benjamin Gartner, Christian Gelinek, Richard E Dzetkulic, Usuario Eda, Charles Eddleston, Chandan Egbert, Joe Eiler, Ahmed
George, Peter Gerst, Glen Gibb, Michael Gielda, Barbara Gigerl, Nimrod El-Mahmoudy, Trevor Elbourne, Schuyler Eldridge, Ahmed Elzeftawi, Mats
Gileadi, Shankar Giri, Dan Gisselquist, Szymon Gizler, Petr Gladkikh, Sam Engstrom, Augustin Fabre, Robert Farrell, Julien Faucher, Olivier Faure,
Gladstone, Mariusz Glebocki, Embedded Go, Andrew Goessling, Amir Gonnen, Sergey Fedorov, Eugene Feinberg, Eugen Fekete, Fabrizio Ferrandi, Adrian
Chitlesh Goorah, Tomasz Gorochowik, Kai Gossner, Tarik Graba, Sergi Fiergolski, Udi Finkelstein, Brian Flachs, Bill Flynn, Andrea Foletto,
Granell, Al Grant, Nathan Graybeal, Alexander Grobman, Qian Gu, Xuan Guo, Maxim Fonarev, Alex Forencich, Aurelien Francillon, Marco Frank, Bob
Prabhat Gupta, Deniz Güzel, Driss Hafdi, Abdul Hameed, Neil Hamilton, James Fredieu, Manuel Freiberger, Stephane Gagnon, Duane Galbi, Mostafa Gamal,
Hanlon, Tang Haojin, Øyvind Harboe, Jannis Harder, David Harris, Junji Vito Gamberini, Mateusz Gancarz, Mostafa Garnal, Benjamin Gartner,
Hashimoto, Thomas Hawkins, Mitch Hayenga, Harald Heckmann, Robert Henry, Christian Gelinek, Richard E George, Peter Gerst, Glen Gibb, Michael
Stephen Henry, Sebastian Hesselbarth, David Hewson, Jamey Hicks, Joel Gielda, Barbara Gigerl, Nimrod Gileadi, Shankar Giri, Dan Gisselquist,
Holdsworth, Andrew Holme, Peter Holmes, Hiroki Honda, Alex Hornung, Szymon Gizler, Petr Gladkikh, Sam Gladstone, Mariusz Glebocki, Embedded Go,
Pierre-Henri Horrein, David Horton, Peter Horvath, Jae Hossell, Kuoping Andrew Goessling, Emil Goh, Amir Gonnen, Chitlesh Goorah, Tomasz
Hsu, Shou-Li Hsu, Teng Huang, Steven Hugg, Alan Hunter, James Hutchinson, Gorochowik, Kai Gossner, Toshiki Goto, Tarik Graba, Sergi Granell, Al
Tim Hutt, Ehab Ibrahim, Edgar E. Iglesias, Shahid Ikram, Jamie Iles, Fuad Grant, Nathan Graybeal, Alexander Grobman, Dominick Grochowina, Qian Gu,
Ismail, Vighnesh Iyer, Ben Jackson, Daniel Jacques, Shareef Jalloq, Marlon Karol Gugala, Xuan Guo, Prabhat Gupta, Oscar Gustafsson, Deniz Güzel, Driss
James, Krzysztof Jankowski, Eyck Jentzsch, HyungKi Jeong, Iztok Jeras, Hafdi, Abdul Hameed, Neil Hamilton, Ali Hammoud, James Hanlon, Tang Haojin,
Pawel Jewstafjew, Alexandre Joannou, James Johnson, Christophe Joly, Justin Øyvind Harboe, Jannis Harder, David Harris, Junji Hashimoto, Thomas
Jones, William D. Jones, Abe Jordan, Larry Darryl Lee Jr., Franck Jullien, Hawkins, Mitch Hayenga, Christian Hecken, Harald Heckmann, Robin Heinemann,
James Jung, Mike Kagen, Arthur Kahlich, Kaalia Kahn, Guy-Armand Kamendje, Robert Henry, Stephen Henry, Sebastian Hesselbarth, David Hewson, Jamey
Vasu Kandadi, Yoshitomo Kaneda, Kanad Kanhere, Patricio Kaplan, Pieter Hicks, Joel Holdsworth, Andrew Holme, Peter Holmes, Hiroki Honda, Steve
Kapsenberg, Rafal Kapuscik, Ralf Karge, Per Karlsson, Dan Katz, Sol Hoover, Alex Hornung, Pierre-Henri Horrein, David Horton, Peter Horvath,
Katzman, Ian Kennedy, Ami Keren, Fabian Keßler, Michael Killough, Sun Kim, Jae Hossell, Kuoping Hsu, Shou-Li Hsu, Teng Huang, Steven Hugg, Alan
Jonathan Kimmitt, Olof Kindgren, Kevin Kiningham, Cameron Kirk, Dan Hunter, James Hutchinson, Tim Hutt, Ehab Ibrahim, Edgar E. Iglesias, Shahid
Kirkham, Aleksander Kiryk, Sobhan Klnv, Gernot Koch, Jack Koenig, Soon Koh, Ikram, Jamie Iles, Ondrej Ille, Ron K. Irvine, Fuad Ismail, Vighnesh Iyer,
Nathan Kohagen, Steve Kolecki, Brett Koonce, Will Korteland, Andrei Ben Jackson, Daniel Jacques, Shareef Jalloq, Marlon James, Krzysztof
Kostovski, Wojciech Koszek, Varun Koyyalagunta, Arkadiusz Kozdra, Markus Jankowski, Moubarak Jeje, Tobias Jensen, Eyck Jentzsch, HyungKi Jeong,
Krause, David Kravitz, Adam Krolnik, Roland Kruse, Mahesh Kumashikar, Iztok Jeras, Pawel Jewstafjew, Aditya Ranjan Jha, Xie Jiacheng, Alexandre
Andreas Kuster, Sergey Kvachonok, Charles Eric LaForest, Kevin Laeufer, Ed Joannou, James Johnson, Christophe Joly, Justin Jones, William D. Jones,
Lander, Steve Lang, Pierre Laroche, Stephane Laurent, Walter Lavino, Kees Jongenburger, Abe Jordan, Larry Darryl Lee Jr., Franck Jullien, James
Christian Leber, David Ledger, Alex Lee, Larry Lee, Yoda Lee, Michaël Jung, Yoshitomo KANEDA, Mike Kagen, Arthur Kahlich, Kaalia Kahn, G-A.
Lefebvre, Dag Lem, Igor Lesik, John Li, Kay Li, Zixi Li, Davide Libenzi, Kamendje, Guy-Armand Kamendje, Vasu Kandadi, Kanad Kanhere, Patricio
Nandor Licker, Eivind Liland, Ícaro Lima, Kevin Lin, Yu-Sheng Lin, Charlie Kaplan, Pieter Kapsenberg, Rafal Kapuscik, Ralf Karge, Per Karlsson, Dan
Lind, Andrew Ling, Jiuyang Liu, Joey Liu, Paul Liu, Derek Lockhart, Jake Katz, Sol Katzman, Amirreza Kazemi, Ian Kennedy, Ami Keren, Fabian
Longo, Geza Lore, Arthur Low, Jose Loyola, Stefan Ludwig, Dan Lussier, Keßler-Schulz, John Khoo, Michael Killough, Sun Kim, Jonathan Kimmitt, Olof
Konstantin Lübeck, Fred Ma, Liwei Ma, Duraid Madina, Oleh Maksymenko, Affe Kindgren, Kevin Kiningham, Cameron Kirk, Dan Kirkham, Aleksander Kiryk,
Mao, Julien Margetts, Chick Markley, Alexis Marquet, Mark Marshall, Alfonso Sobhan Klnv, Gernot Koch, Jack Koenig, Soon Koh, Nathan Kohagen, Pawel
Martinez, Unai Martinez-Corral, Adrien Le Masle, Yves Mathieu, Vladimir Kojma, Steve Kolecki, Brett Koonce, Will Korteland, Andrei Kostovski,
Matveyenko, Patrick Maupin, Stan Mayer, Jordan McConnon, Conor McCullough, Wojciech Koszek, Varun Koyyalagunta, Arkadiusz Kozdra, Markus Krause, David
Jason McMullan, Elliot Mednick, Yuan Mei, Andy Meier, Luiza de Melo, Kravitz, Natan Kreimer, Adam Krolnik, Roland Kruse, Jan Kubalek, Mahesh
Rodrigo A. Melo, Benjamin Menküc, Jake Merdich, David Metz, Wim Michiels, Kumashikar, Andreas Kuster, Sergey Kvachonok, Charles Eric LaForest, Kevin
Laeufer, Ed Lander, Steve Lang, Pierre Laroche, Stephane Laurent, Walter
Lavino, Christian Leber, David Ledger, Alex Lee, Larry Lee, Yoda Lee,
Michaël Lefebvre, Dag Lem, Igor Lesik, Brian Li, John Li, Kay Li, Zixi Li,
Davide Libenzi, Matt Liberty, Nandor Licker, Eivind Liland, Ícaro Lima,
Jian Nan Lin, Kevin Lin, Yu-Sheng Lin, Charlie Lind, Andrew Ling, Jens
Yuechao Liu, Jiuyang Liu, Joey Liu, Paul Liu, Derek Lockhart, Jake Longo,
Geza Lore, Arthur Low, Jose Loyola, Stefan Ludwig, Martin Lueker-Boden, Dan
Lussier, Konstantin Lübeck, Fred Ma, Liwei Ma, Duraid Madina, Oleh
Maksymenko, Alexander Mann, Affe Mao, Rémi Marche, Julien Margetts, Chick
Markley, Alexis Marquet, Mark Marshall, Alfonso Martinez, Unai
Martinez-Corral, Adrien Le Masle, Yves Mathieu, Vladimir Matveyenko,
Patrick Maupin, Stan Mayer, Jordan McConnon, Conor McCullough, Jason
McMullan, Elliot Mednick, Yuan Mei, Andy Meier, Luiza de Melo, Rodrigo A.
Melo, Benjamin Menküc, Niraj Menon, Jake Merdich, David Metz, Wim Michiels,
Miodrag Milanović, Darryl Miles, Kevin Millis, Andrew Miloradovsky, David Miodrag Milanović, Darryl Miles, Kevin Millis, Andrew Miloradovsky, David
Moberg, Wai Sum Mong, Peter Monsson, Anthony Moore, Sean Moore, Stuart Moberg, Wai Sum Mong, Peter Monsson, Anthony Moore, Sean Moore, Javier
Morris, Dennis Muhlestein, John Murphy, Matt Myers, Nathan Myers, Richard Mora, Rodrigo Batista de Moraes, Stuart Morris, Dennis Muhlestein, John
Myers, Alex Mykyta, Eric Müller, Dimitris Nalbantis, Peter Nelson, Felix Murphy, Matt Myers, Nathan Myers, Richard Myers, Alex Mykyta, Shivaram
Neumärker, Bob Newgard, Cong Van Nguyen, Rachit Nigam, Toru Niina, Paul Mysore, Eric Müller, Dimitris Nalbantis, Jitesh Nayak, Peter Nelson, Yuri
Nitza, Yossi Nivin, Pete Nixon, Lisa Noack, Mark Nodine, Michael Nolan, Nenakhov, Felix Neumärker, Bob Newgard, Cong Van Nguyen, Trung Nguyen,
Andrew Nolte, Joseph Nwabueze, Kevin Nygaard, Kuba Ober, Krzysztof Rachit Nigam, Toru Niina, Paul Nitza, Yossi Nivin, Pete Nixon, Lisa Noack,
Obłonczek, Andreas Olofsson, Baltazar Ortiz, Aleksander Osman, Don Owen, Mark Nodine, Petr Nohavica, Michael Nolan, Andrew Nolte, Mateusz
Tim Paine, Deepa Palaniappan, James Pallister, Vassilis Papaefstathiou, Nurczyński, Joseph Nwabueze, Kevin Nygaard, Thomas O'Keeffe, Kuba Ober,
Sanggyu Park, Brad Parker, Risto Pejašinović, Seth Pellegrino, Morten Borup Krzysztof Obłonczek, Danny Oler, Andreas Olofsson, Baltazar Ortiz,
Petersen, Dan Petrisko, Wesley Piard, Maciej Piechotka, David Pierce, Cody Aleksander Osman, Don Owen, Tim Paine, Deepa Palaniappan, James Pallister,
Piersall, T. Platz, Michael Platzer, Dominic Plunkett, Nolan Poe, David Vassilis Papaefstathiou, Sanggyu Park, Brad Parker, Risto Pejašinović, Seth
Poole, Michael Popoloski, Roman Popov, Aylon Chaim Porat, Oron Port, Rich Pellegrino, Joel Peltonen, Morten Borup Petersen, Dan Petrisko, Thanh Tung
Porter, Rick Porter, Stefan Post, Niranjan Prabhu, Damien Pretet, Harald Pham, Wesley Piard, Maciej Piechotka, David Pierce, Cody Piersall,
Pretl, Bill Pringlemeir, Usha Priyadharshini, Mark Jackson Pulver, Prateek T. Platz, Michael Platzer, Dominic Plunkett, Nolan Poe, Tuomas Poikela,
Puri, Han Qi, Jiacheng Qian, Marshal Qiao, Raynard Qiao, Yujia Qiao, Jasen George Polack, David Poole, Michael Popoloski, Roman Popov, Aylon Chaim
Qin, Frank Qiu, Nandu Raj, Kamil Rakoczy, Danilo Ramos, Drew Ranck, Chris Porat, Oron Port, Rich Porter, Rick Porter, Stefan Post, Niranjan Prabhu,
Randall, Anton Rapp, Josh Redford, Odd Magne Reitan, Frédéric Requin, Damien Pretet, Harald Pretl, Bill Pringlemeir, Usha Priyadharshini, Mark
Dustin Richmond, Samuel Riedel, Alberto Del Rio, Eric Rippey, Narcis Rodas, Jackson Pulver, Prateek Puri, Nikolay Puzanov, Han Qi, Jiacheng Qian,
Oleg Rodionov, Ludwig Rogiers, Paul Rolfe, Michail Rontionov, Arjen Marshal Qiao, Raynard Qiao, Yujia Qiao, Jasen Qin, Frank Qiu, Nandu Raj,
Roodselaar, Arthur Rosa, Tobias Rosenkranz, Yernagula Roshit, Ryszard Kamil Rakoczy, Danilo Ramos, Drew Ranck, Chris Randall, Anton Rapp, Josh
Rozak, Huang Rui, Graham Rushton, Jan Egil Ruud, Denis Rystsov, Pawel Redford, Odd Magne Reitan, Frédéric Requin, Wajahat Riaz, Dustin Richmond,
Sagan, Robert Sammelson, Adrian Sampson, John Sanguinetti, Josep Sans, Luca Samuel Riedel, Alberto Del Rio, Eric Rippey, Narcis Rodas, Oleg Rodionov,
Sasselli, Martin Scharrer, Martin Schmidt, Jonathan Schröter, Julie Ludwig Rogiers, Paul Rolfe, Michail Rontionov, Arjen Roodselaar, Arthur
Rosa, Tobias Rosenkranz, Yernagula Roshit, Diego Roux, Ryszard Rozak, Dan
Ruelas-Petrisko, Luca Rufer, Huang Rui, Graham Rushton, Jan Egil Ruud,
Denis Rystsov, Pawel Sagan, Robert Sammelson, Adrian Sampson, John
Sanguinetti, Josep Sans, Dave Sargeant, Luca Sasselli, Philippe Sauter,
Martin Scharrer, Parker Schless, Martin Schmidt, Jonathan Schröter, Julie
Schwartz, Galen Seitz, Sam Shahrestani, Joseph Shaker, Mark Shaw, Salman Schwartz, Galen Seitz, Sam Shahrestani, Joseph Shaker, Mark Shaw, Salman
Sheikh, Zhou Shen, Hao Shi, James Shi, Michael Shinkarovsky, Rafael Sheikh, Zhou Shen, Zhouyi Shen, Hao Shi, James Shi, Michael Shinkarovsky,
Shirakawa, Jeffrey Short, S Shuba, Fan Shupei, Ethan Sifferman, Anderson Rafael Shirakawa, Jeffrey Short, S Shuba, Fan Shupei, Ethan Sifferman,
Ignacio da Silva, Rodney Sinclair, Ameya Vikram Singh, Sanjay Singh, Frans Anderson Ignacio da Silva, Rodney Sinclair, Ameya Vikram Singh, Sanjay
Skarman, Nate Slager, Steven Slatter, Mladen Slijepcevic, Brian Small, Singh, Frans Skarman, Nate Slager, Steven Slatter, Mladen Slijepcevic,
Garrett Smith, Gus Smith, Tim Snyder, Maciej Sobkowski, Stan Sokorac, Alex Brian Small, Garrett Smith, Gus Smith, Rachel Smith, Tim Snyder, Maciej
Solomatnikov, Flavien Solt, Wei Song, Trefor Southwell, Martin Stadler, Art Sobkowski, Stan Sokorac, Alex Solomatnikov, Flavien Solt, Wei Song, Trefor
Stamness, David Stanford, Krzysztof Starecki, Baruch Sterin, John Southwell, Martin Stadler, Art Stamness, David Stanford, Krzysztof
Stevenson, Pete Stevenson, Patrick Stewart, Rob Stoddard, Tood Strader, Starecki, Baruch Sterin, John Stevenson, Pete Stevenson, Patrick Stewart,
John Stroebel, Ray Strouble, Sven Stucki, Howard Su, Udaya Raj Subedi, Rob Stoddard, Tood Strader, Jean-Nicolas Strauss, John Stroebel, Ray
Emerson Suguimoto, Gene Sullivan, Qingyao Sun, Renga Sundararajan, Kuba Strouble, Matt Stroud, Sven Stucki, Howard Su, Udaya Raj Subedi, Emerson
Suguimoto, Gene Sullivan, Qingyao Sun, Renga Sundararajan, Kuba
Sunderland-Ober, Gustav Svensk, Rupert Swarbrick, Jevin Sweval, Paul Sunderland-Ober, Gustav Svensk, Rupert Swarbrick, Jevin Sweval, Paul
Swirhun, Shinya T-Y, Thierry Tambe, Jesse Taube, Drew Taussig, Christopher Swirhun, Krzysztof Sychla, Shinya T-Y, Yutetsu Takatsukasa, Thierry Tambe,
Taylor, Greg Taylor, Jose Tejada, Sören Tempel, Peter Tengstrand, Wesley Jesse Taube, Drew Taussig, Christopher Taylor, David Taylor, Greg Taylor,
Michael Bedford Taylor, Jose Tejada, Sören Tempel, Peter Tengstrand, Wesley
Terpstra, Rui Terra, Stefan Thiede, Justin Thiel, Gary Thomas, Ian Terpstra, Rui Terra, Stefan Thiede, Justin Thiel, Gary Thomas, Ian
Thompson, Kevin Thompson, Mike Thyer, Hans Tichelaar, Tudor Timi, Viktor Thompson, Kevin Thompson, Mike Thyer, Jerry Tianchen, Hans Tichelaar, Tudor
Tomov, Steve Tong, Topa Topino, Àlex Torregrosa, Topa Tota, Michael Timi, Viktor Tomov, Steve Tong, Topa Topino, Àlex Torregrosa, Topa Tota,
Tresidder, Lenny Truong, David Turner, Neil Turton, Hideto Ueno, Mike Michael Tresidder, Lenny Truong, David Turner, Neil Turton, Hideto Ueno,
Urbach, Joel Vandergriendt, Srini Vemuri, Srinivasan Venkataramanan, Yuri Ethan Uppal, Mike Urbach, Joel Vandergriendt, Srini Vemuri, Srinivasan
Victorovich, Ivan Vnučec, Bogdan Vukobratovic, Holger Waechtler, Philipp Venkataramanan, Yuri Victorovich, Ivan Vnučec, Andrew Voznytsa, Bogdan
Wagner, Stefan Wallentowitz, Johannes Walter, CY Wang, Chuxuan Wang, Shawn Vukobratovic, Holger Waechtler, Justin Wagner, Philipp Wagner, Stefan
Wang, Yilou Wang, Zhanglei Wang, Greg Waters, Thomas Watts, Eugene Weber, Wallentowitz, Johannes Walter, CY Wang, Chuxuan Wang, Shawn Wang, Yilou
John Wehle, Tianrui Wei, David Welch, Thomas J Whatson, Martin Whitaker, Wang, Zhanglei Wang, Jakub Wasilewski, Paul Wasson, Greg Waters, Thomas
Marco Widmer, Leon Wildman, Daniel S. Wilkerson, Daniel Wilkerson, Gerald Watts, Eugene Weber, John Wehle, Tianrui Wei, Yin Weijie, David Welch,
Williams, Trevor Williams, Don Williamson, Jan Van Winkel, Jeff Winston, Thomas J Whatson, Martin Whitaker, Marco Widmer, Leon Wildman, Daniel S.
Joshua Wise, Clifford Wolf, Johan Wouters, Paul Wright, Tobias Wölfel, Wilkerson, Daniel Wilkerson, Gerald Williams, Trevor Williams, Don
Junyi Xi, Ding Xiaoliang, Liu Xiaoyi, Jinyan Xu, Mandy Xu, Pengcheng Xu, Williamson, Jan Van Winkel, Jeff Winston, Max Wipfli, Joshua Wise, Clifford
Shanshan Xu, Yan Xu, Yinan Xu, SU YANG, Felix Yan, Jiaxun Yang, Luke Yang, Wolf, Johan Wouters, Paul Wright, Tobias Wölfel, Domenic Wüthrich, Junyi
Amir Yazdanbakhsh, Chentai (Seven) Yuan, Florian Zaruba, Mat Zeno, Keyi Xi, Ding Xiaoliang, Liu Xiaoyi, Jie Xu, Jinyan Xu, Mandy Xu, Pengcheng Xu,
Zhang, Xi Zhang, Huanghuang Zhou, Yike Zhou, Jiamin Zhu, Ryan Ziegler. Shanshan Xu, Yan Xu, Yinan Xu, Felix Yan, Zhen Yan, Jiaxun Yang, Luke Yang,
Su Yang, Amir Yazdanbakhsh, Law Heng Yi, Ibrahim Burak Yorulmaz, Chentai
(Seven) Yuan, Florian Zaruba, Igor Zaworski, Mat Zeno, Keyi Zhang, Xi
Zhang, Alex Zhou, Huanghuang Zhou, Yike Zhou, Jiamin Zhu, Ryan Ziegler, Lan
Zongwei.
Thanks to them, and all those we've missed mentioning above, and to those Thanks to them, and all those we've missed mentioning above, and to those
whom have wished to remain anonymous. whom have wished to remain anonymous.
@ -177,24 +203,24 @@ Historical Origins
================== ==================
Verilator was conceived in 1994 by Paul Wasson at the Core Logic Group at Verilator was conceived in 1994 by Paul Wasson at the Core Logic Group at
Digital Equipment Corporation. The Verilog code that was converted to C Digital Equipment Corporation. The Verilog code that was converted to C was
was then merged with a C-based CPU model of the Alpha processor and then merged with a C-based CPU model of the Alpha processor and simulated
simulated in a C-based environment called CCLI. in a C-based environment called CCLI.
In 1995 Verilator started being used for Multimedia and Network Processor In 1995 Verilator started being used for Multimedia and Network Processor
development inside Digital. Duane Galbi took over the active development development inside Digital. Duane Galbi took over the active development of
of Verilator, and added several performance enhancements, and CCLI was Verilator, and added several performance enhancements, and CCLI was still
still being used as the shell. being used as the shell.
In 1998, through the efforts of existing DECies, mainly Duane Galbi, In 1998, through the efforts of existing DECies, mainly Duane Galbi,
Digital graciously agreed to release the source code. (Subject to the code Digital graciously agreed to release the source code. (Subject to the code
not being resold, which is compatible with the GNU Public License.) not being resold, which is compatible with the GNU Public License.)
In 2001, Wilson Snyder took the kit, added a SystemC mode, and called In 2001, Wilson Snyder took the kit, added a SystemC mode, and called it
it Verilator2. This was the first packaged public release. Verilator2. This was the first packaged public release.
In 2002, Wilson Snyder created Verilator 3.000 by rewriting Verilator from In 2002, Wilson Snyder created Verilator 3.000 by rewriting Verilator from
scratch in C++. This added many optimizations, yielding about a 2-5x scratch in C++. This added many optimizations, yielding about a 2-5x
performance gain. performance gain.
In 2009, major SystemVerilog and DPI language support was added. In 2009, major SystemVerilog and DPI language support was added.

View File

@ -1,14 +1,13 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
********* *********
Copyright Copyright
********* *********
The latest version of Verilator is available from `https://verilator.org The latest version of Verilator is available from https://verilator.org.
<https://verilator.org>`_.
Copyright 2003-2025 by Wilson Snyder. This program is free software; you Copyright 2003-2026 by Wilson Snyder. This program is free software; you
can redistribute it and/or modify the Verilator internals under the terms can redistribute it and/or modify the Verilator internals under the terms
of either the GNU Lesser General Public License Version 3 or the Perl of either the GNU Lesser General Public License Version 3 or the Perl
Artistic License Version 2.0. Artistic License Version 2.0.

View File

@ -1,4 +1,4 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
Deprecations Deprecations
@ -7,22 +7,23 @@ Deprecations
The following deprecated items are scheduled for future removal: The following deprecated items are scheduled for future removal:
C++14 compiler support C++14 compiler support
Verilator currently requires a C++20 or newer compiler for timing, and a Verilator currently requires a C++20 or newer compiler for timing, and a
C++14 or newer compiler for both compiling Verilator and compiling C++14 or newer compiler for both compiling Verilator and compiling
Verilated models with --no-timing. Verilated models with --no-timing.
Verilator will require C++20 or newer compilers for both compiling Verilator will require C++20 or newer compilers for both compiling
Verilator and compiling all Verilated models no sooner than May 2025. Verilator and compiling all Verilated models no sooner than May 2025.
(Likely to be removed shortly after GitHub removes Ubuntu 20.04 (Although this date has expired, this change is currently on hold until
continuous-integration action runners, which are used to test the older the Ubuntu LTS versions of GCC and clang use C++20 by default, estimated
C++ standard). May 2028.)
XML output XML output
Verilator currently supports XML parser output (enabled with `--xml-only`). Verilator currently supports XML parser output (enabled with
Support for `--xml-*` options will be deprecated no sooner than January 2026. `--xml-only`). Support for `--xml-*` options will be deprecated no
sooner than January 2026.
--make cmake `--make cmake`
The `--make cmake` options is deprecated and will be removed no sooner than The `--make cmake` options is deprecated and will be removed no sooner
January 2026. Use `--make json` instead. Note that the CMake integration than January 2026. Use `--make json` instead. Note that the CMake
shipping with Verilator (verilator-config.mk) already uses `--make json` so integration shipping with Verilator (verilator-config.mk) already uses
no changes are necessary if using that. `--make json` so no changes are necessary if using that.

View File

@ -1,4 +1,4 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
Environment Environment
@ -10,14 +10,14 @@ associated programs.
.. option:: LD_LIBRARY_PATH .. option:: LD_LIBRARY_PATH
A generic Linux/OS variable specifying what directories have shared A generic Linux/OS variable specifying what directories have shared
object (.so) files. This path should include SystemC and other object (.so) files. This path should include SystemC and other shared
shared objects needed at simulation runtime. objects needed at simulation runtime.
.. option:: MAKE .. option:: MAKE
Names the executable of the make command invoked when using the Names the executable of the make command invoked when using the
:vlopt:`--build` option. Some operating systems may require "gmake" to :vlopt:`--build` option. Some operating systems may require "gmake" to
this variable to launch GNU make. If this variable is not specified, this variable to launch GNU make. If this variable is not specified,
"make" is used. "make" is used.
.. option:: MAKEFLAGS .. option:: MAKEFLAGS
@ -29,33 +29,33 @@ associated programs.
.. option:: OBJCACHE .. option:: OBJCACHE
Optionally specifies a caching or distribution program to place in front Optionally specifies a caching or distribution program to place in front
of all runs of the C++ compiler. For example, "ccache" or "sccache". If using of all runs of the C++ compiler. For example, "ccache" or "sccache". If
:command:`distcc` or :command:`icecc`/:command:`icecream`, they would using :command:`distcc` or :command:`icecc`/:command:`icecream`, they
generally be run under :command:`ccache`; see the documentation for would generally be run under :command:`ccache`; see the documentation
those programs. If OBJCACHE is not set, and at configure time ccache for those programs. If OBJCACHE is not set, and at configure time ccache
was present, ccache will be used as a default. was present, ccache will be used as a default.
.. option:: SYSTEMC .. option:: SYSTEMC
Deprecated. Used only if :option:`SYSTEMC_INCLUDE` or Deprecated. Used only if :option:`SYSTEMC_INCLUDE` or
:option:`SYSTEMC_LIBDIR` is not set. If set, specifies the directory :option:`SYSTEMC_LIBDIR` is not set. If set, specifies the directory
containing the SystemC distribution. If not specified, it will come containing the SystemC distribution. If not specified, it will come from
from a default optionally specified at configure time (before Verilator a default optionally specified at configure time (before Verilator was
was compiled). compiled).
.. option:: SYSTEMC_ARCH .. option:: SYSTEMC_ARCH
Deprecated. Used only if :option:`SYSTEMC_LIBDIR` is not set. Deprecated. Used only if :option:`SYSTEMC_LIBDIR` is not set. Specifies
Specifies the architecture name used by the SystemC kit. This is the the architecture name used by the SystemC kit. This is the part after
part after the dash in the "lib-{...}" directory name created by a the dash in the "lib-{...}" directory name created by a :command:`make`
:command:`make` in the SystemC distribution. If not set, Verilator will in the SystemC distribution. If not set, Verilator will try to intuit
try to intuit the proper setting, or use the default optionally the proper setting, or use the default optionally specified at configure
specified at configure time (before Verilator was compiled). time (before Verilator was compiled).
.. option:: SYSTEMC_CXX_FLAGS .. option:: SYSTEMC_CXX_FLAGS
Specifies additional flags that are required to be passed to GCC when Specifies additional flags that are required to be passed to GCC when
building the SystemC model. System 2.3.0 may need this set to building the SystemC model. System 2.3.0 may need this set to
"-pthread". "-pthread".
.. option:: SYSTEMC_INCLUDE .. option:: SYSTEMC_INCLUDE
@ -67,27 +67,27 @@ associated programs.
.. option:: SYSTEMC_LIBDIR .. option:: SYSTEMC_LIBDIR
If set, specifies the directory containing the libsystemc.a library. If If set, specifies the directory containing the libsystemc.a library. If
not specified, it will come from a default optionally specified at not specified, it will come from a default optionally specified at
configure time (before Verilator was compiled), or computed from configure time (before Verilator was compiled), or computed from
SYSTEMC/lib-SYSTEMC_ARCH. SYSTEMC/lib-SYSTEMC_ARCH.
.. option:: VERILATOR_BIN .. option:: VERILATOR_BIN
If set, specifies an alternative name of the ``verilator`` binary. May If set, specifies an alternative name of the ``verilator`` binary. May
be used for debugging and selecting between multiple operating system be used for debugging and selecting between multiple operating system
builds. builds.
.. option:: VERILATOR_COVERAGE_BIN .. option:: VERILATOR_COVERAGE_BIN
If set, specifies an alternative name of the ``verilator_coverage`` If set, specifies an alternative name of the ``verilator_coverage``
binary. May be used for debugging and selecting between multiple binary. May be used for debugging and selecting between multiple
operating system builds. operating system builds.
.. option:: VERILATOR_GDB .. option:: VERILATOR_GDB
If set, the command to run when using the :vlopt:`--gdb` option, such as If set, the command to run when using the :vlopt:`--gdb` option, such as
"ddd". If not specified, it will use "gdb". "ddd". If not specified, it will use "gdb".
.. option:: VERILATOR_ROOT .. option:: VERILATOR_ROOT
@ -110,7 +110,7 @@ associated programs.
If you are using a pre-compiled Verilator package, you should not need If you are using a pre-compiled Verilator package, you should not need
to set ``VERILATOR_ROOT`` - the value embedded in the binary should be to set ``VERILATOR_ROOT`` - the value embedded in the binary should be
correct. In fact this option *does not work* with Verilator packages correct. In fact this option *does not work* with Verilator packages
that have been installed with ``make install``. If a Verilator package that have been installed with ``make install``. If a Verilator package
has been installed using ``./configure --prefix=/some/path && make has been installed using ``./configure --prefix=/some/path && make
install`` and then moved to another location, you cannot use install`` and then moved to another location, you cannot use
@ -121,13 +121,15 @@ associated programs.
.. option:: VERILATOR_SOLVER .. option:: VERILATOR_SOLVER
If set, the command to run as a constrained randomization backend, such If set, the command to run as a constrained randomization backend, such
as :command:`cvc4 --lang=smt2 --incremental`. If not specified, it will use as :command:`cvc4 --lang=smt2 --incremental`. If not specified, it will
the one supplied or found during configure, or :command:`z3 --in` if empty. use the one supplied or found during configure, or :command:`z3 --in` if
empty.
.. option:: VERILATOR_VALGRIND .. option:: VERILATOR_VALGRIND
If set, the command to run when using the :vlopt:`--valgrind` option, such as If set, the command to run when using the :vlopt:`--valgrind` option,
"valgrind --tool=callgrind". If not specified, it will use "valgrind". such as "valgrind --tool=callgrind". If not specified, it will use
"valgrind".
Make Variables Make Variables
@ -146,7 +148,7 @@ set by passing them to make e.g. ``make CXX=my-gcc ...``.
Optionally overrides the default compiler binary used by the Verilated Optionally overrides the default compiler binary used by the Verilated
makefiles. If CXX is not set, the version found at configure time is makefiles. If CXX is not set, the version found at configure time is
used. Note the default flags passed to the compiler are determined at used. Note the default flags passed to the compiler are determined at
configuration time, so changing the CXX compiler version using this configuration time, so changing the CXX compiler version using this
variable, as opposed to passing it at configuration time, may not give variable, as opposed to passing it at configuration time, may not give
desired results. desired results.
@ -155,7 +157,7 @@ set by passing them to make e.g. ``make CXX=my-gcc ...``.
Optionally overrides the default linker binary used by the Verilated Optionally overrides the default linker binary used by the Verilated
makefiles. If LINK is not set, the version found at configure time is makefiles. If LINK is not set, the version found at configure time is
used. Note the default flags passed to the linker are determined at used. Note the default flags passed to the linker are determined at
configuration time, so changing the LINK version using this variable, as configuration time, so changing the LINK version using this variable, as
opposed to passing it at configuration time, may not give desired opposed to passing it at configuration time, may not give desired
results. results.

View File

@ -1,14 +1,14 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
.. _Example Create-Binary Execution: .. _example create-binary execution:
Example Create-Binary Execution Example Create-Binary Execution
=============================== ===============================
We'll compile this SystemVerilog example into a Verilated simulation binary. For We'll compile this SystemVerilog example into a Verilated simulation
an example that discusses the next level of detail see :ref:`Example C++ binary. For an example that discusses the next level of detail see
Execution`. :ref:`Example C++ Execution`.
.. include:: example_common_install.rst .. include:: example_common_install.rst
@ -16,20 +16,20 @@ Now, let's create an example Verilog file:
.. code-block:: bash .. code-block:: bash
mkdir test_our mkdir test_our
cd test_our cd test_our
cat >our.v <<'EOF' cat >our.v <<'EOF'
module our; module our;
initial begin $display("Hello World"); $finish; end initial begin $display("Hello World"); $finish; end
endmodule endmodule
EOF EOF
Now we run Verilator on our little example. Now we run Verilator on our little example.
.. code-block:: bash .. code-block:: bash
verilator --binary -j 0 -Wall our.v verilator --binary -j 0 -Wall our.v
Breaking this command down: Breaking this command down:
@ -39,8 +39,7 @@ Breaking this command down:
#. :vlopt:`-j` `0` to Verilate using use as many CPU threads as the machine #. :vlopt:`-j` `0` to Verilate using use as many CPU threads as the machine
has. has.
#. :vlopt:`-Wall` so Verilator has stronger lint warnings #. :vlopt:`-Wall` so Verilator has stronger lint warnings enabled.
enabled.
#. An finally, :command:`our.v`, which is our SystemVerilog design file. #. An finally, :command:`our.v`, which is our SystemVerilog design file.
@ -48,16 +47,16 @@ And now we run it:
.. code-block:: bash .. code-block:: bash
obj_dir/Vour obj_dir/Vour
And we get as output: And we get as output:
.. code-block:: bash .. code-block:: bash
Hello World Hello World
- our.v:2: Verilog $finish - our.v:2: Verilog $finish
You're better off using a Makefile to run the steps for you, so when your You're better off using a Makefile to run the steps for you, so when your
source changes, it will automatically run all of the appropriate steps. To source changes, it will automatically run all of the appropriate steps. To
aid this, Verilator can create a makefile dependency file. For examples aid this, Verilator can create a makefile dependency file. For examples
that do this, see the :file:`examples` directory in the distribution. that do this, see the :file:`examples` directory in the distribution.

View File

@ -1,12 +1,12 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
.. _Example C++ Execution: .. _example c++ execution:
Example C++ Execution Example C++ Execution
===================== =====================
We'll compile this example into C++. For an extended and commented version We'll compile this example into C++. For an extended and commented version
of what this C++ code is doing, see of what this C++ code is doing, see
:file:`examples/make_tracing_c/sim_main.cpp` in the distribution. :file:`examples/make_tracing_c/sim_main.cpp` in the distribution.
@ -16,34 +16,34 @@ Now, let's create an example Verilog and C++ wrapper file:
.. code-block:: bash .. code-block:: bash
mkdir test_our mkdir test_our
cd test_our cd test_our
cat >our.v <<'EOF' cat >our.v <<'EOF'
module our; module our;
initial begin $display("Hello World"); $finish; end initial begin $display("Hello World"); $finish; end
endmodule endmodule
EOF EOF
cat >sim_main.cpp <<'EOF' cat >sim_main.cpp <<'EOF'
#include "Vour.h" #include "Vour.h"
#include "verilated.h" #include "verilated.h"
int main(int argc, char** argv) { int main(int argc, char** argv) {
VerilatedContext* contextp = new VerilatedContext; VerilatedContext* contextp = new VerilatedContext;
contextp->commandArgs(argc, argv); contextp->commandArgs(argc, argv);
Vour* top = new Vour{contextp}; Vour* top = new Vour{contextp};
while (!contextp->gotFinish()) { top->eval(); } while (!contextp->gotFinish()) { top->eval(); }
delete top; delete top;
delete contextp; delete contextp;
return 0; return 0;
} }
EOF EOF
Now we run Verilator on our little example; Now we run Verilator on our little example;
.. code-block:: bash .. code-block:: bash
verilator --cc --exe --build -j 0 -Wall sim_main.cpp our.v verilator --cc --exe --build -j 0 -Wall sim_main.cpp our.v
Breaking this command down: Breaking this command down:
@ -60,8 +60,7 @@ Breaking this command down:
#. :vlopt:`-j 0 <-j>` to Verilate using use as many CPU threads as the #. :vlopt:`-j 0 <-j>` to Verilate using use as many CPU threads as the
machine has. machine has.
#. :vlopt:`-Wall` so Verilator has stronger lint warnings #. :vlopt:`-Wall` so Verilator has stronger lint warnings enabled.
enabled.
#. And finally, :command:`our.v` which is our SystemVerilog design file. #. And finally, :command:`our.v` which is our SystemVerilog design file.
@ -70,7 +69,7 @@ Once Verilator completes we can see the generated C++ code under the
.. code-block:: bash .. code-block:: bash
ls -l obj_dir ls -l obj_dir
(See :ref:`Files Read/Written` for descriptions of some of the files that (See :ref:`Files Read/Written` for descriptions of some of the files that
were created.) were created.)
@ -79,16 +78,16 @@ And now we run it:
.. code-block:: bash .. code-block:: bash
obj_dir/Vour obj_dir/Vour
And we get as output: And we get as output:
.. code-block:: bash .. code-block:: bash
Hello World Hello World
- our.v:2: Verilog $finish - our.v:2: Verilog $finish
You're better off using a Makefile to run the steps for you, so when your You're better off using a Makefile to run the steps for you, so when your
source changes, it will automatically run all of the appropriate steps. To source changes, it will automatically run all of the appropriate steps. To
aid this, Verilator can create a makefile dependency file. For examples aid this, Verilator can create a makefile dependency file. For examples
that do this, see the :file:`examples` directory in the distribution. that do this, see the :file:`examples` directory in the distribution.

View File

@ -1,16 +1,16 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
First you need Verilator installed, see :ref:`Installation`. In brief, if First you need Verilator installed, see :ref:`Installation`. In brief, if
you installed Verilator using the package manager of your operating system, you installed Verilator using the package manager of your operating system,
or did a :command:`make install` to place Verilator into your default path, or did a :command:`make install` to place Verilator into your default path,
you do not need anything special in your environment, and should not have you do not need anything special in your environment, and should not have
VERILATOR_ROOT set. However, if you installed Verilator from sources and VERILATOR_ROOT set. However, if you installed Verilator from sources and
want to run Verilator out of where you compiled Verilator, you need to want to run Verilator out of where you compiled Verilator, you need to
point to the kit: point to the kit:
.. code-block:: bash .. code-block:: bash
# See above; don't do this if using an OS-distributed Verilator # See above; don't do this if using an OS-distributed Verilator
export VERILATOR_ROOT=/path/to/where/verilator/was/installed export VERILATOR_ROOT=/path/to/where/verilator/was/installed
export PATH=$VERILATOR_ROOT/bin:$PATH export PATH=$VERILATOR_ROOT/bin:$PATH

View File

@ -1,42 +1,52 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
.. _Examples in the Distribution: .. _examples in the distribution:
Examples in the Distribution Examples in the Distribution
============================ ============================
See the ``examples/`` directory that is part of the distribution, and See the ``examples/`` directory that is part of the distribution, and is
is installed (in an OS-specific place, often in e.g. installed (in an OS-specific place, often in e.g.
``/usr/local/share/verilator/examples``). These examples include: ``/usr/local/share/verilator/examples``). These examples include:
examples/make_hello_binary examples/make_hello_binary
Example GNU-make simple Verilog->binary conversion Example GNU-make simple Verilog->binary conversion
examples/make_hello_c examples/make_hello_c
Example GNU-make simple Verilog->C++ conversion Example GNU-make simple Verilog->C++ conversion
examples/make_hello_sc examples/make_hello_sc
Example GNU-make simple Verilog->SystemC conversion Example GNU-make simple Verilog->SystemC conversion
examples/make_tracing_c examples/make_tracing_c
Example GNU-make Verilog->C++ with tracing Example GNU-make Verilog->C++ with tracing
examples/make_tracing_sc examples/make_tracing_sc
Example GNU-make Verilog->SystemC with tracing Example GNU-make Verilog->SystemC with tracing
examples/make_protect_lib examples/make_protect_lib
Example using --protect-lib Example using --protect-lib
examples/cmake_hello_c examples/cmake_hello_c
Example building make_hello_c with CMake Example building make_hello_c with CMake
examples/cmake_hello_sc examples/cmake_hello_sc
Example building make_hello_sc with CMake Example building make_hello_sc with CMake
examples/cmake_tracing_c examples/cmake_tracing_c
Example building make_tracing_c with CMake Example building make_tracing_c with CMake
examples/cmake_tracing_sc examples/cmake_tracing_sc
Example building make_tracing_sc with CMake Example building make_tracing_sc with CMake
examples/cmake_protect_lib examples/cmake_protect_lib
Example building make_protect_lib with CMake Example building make_protect_lib with CMake
To run an example copy the example to a new directory and run it. To run an example copy the example to a new directory and run it.
:: .. code-block:: bash
cp -rp {path_to}/examples/make_hello_c make_hello_c cp -rp {path_to}/examples/make_hello_c make_hello_c
cd make_hello_c cd make_hello_c
make make

View File

@ -1,7 +1,7 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
.. _Example SystemC Execution: .. _example systemc execution:
Example SystemC Execution Example SystemC Execution
========================= =========================
@ -15,58 +15,58 @@ Now, let's create an example Verilog, and SystemC wrapper file:
.. code-block:: bash .. code-block:: bash
mkdir test_our_sc mkdir test_our_sc
cd test_our_sc cd test_our_sc
cat >our.v <<'EOF' cat >our.v <<'EOF'
module our (clk); module our (clk);
input clk; // Clock is required to get initial activation input clk; // Clock is required to get initial activation
always @(posedge clk) always @(posedge clk)
begin $display("Hello World"); $finish; end begin $display("Hello World"); $finish; end
endmodule endmodule
EOF EOF
cat >sc_main.cpp <<'EOF' cat >sc_main.cpp <<'EOF'
#include "Vour.h" #include "Vour.h"
using namespace sc_core; using namespace sc_core;
int sc_main(int argc, char** argv) { int sc_main(int argc, char** argv) {
Verilated::commandArgs(argc, argv); Verilated::commandArgs(argc, argv);
sc_clock clk{"clk", 10, SC_NS, 0.5, 3, SC_NS, true}; sc_clock clk{"clk", 10, SC_NS, 0.5, 3, SC_NS, true};
Vour* top = new Vour{"top"}; Vour* top = new Vour{"top"};
top->clk(clk); top->clk(clk);
while (!Verilated::gotFinish()) { sc_start(1, SC_NS); } while (!Verilated::gotFinish()) { sc_start(1, SC_NS); }
delete top; delete top;
return 0; return 0;
} }
EOF EOF
Now we run Verilator on our little example: Now we run Verilator on our little example:
.. code-block:: bash .. code-block:: bash
verilator --sc --exe -Wall sc_main.cpp our.v verilator --sc --exe -Wall sc_main.cpp our.v
This example does not use --build, therefore we need to explicitly compile This example does not use --build, therefore we need to explicitly compile
it: it:
.. code-block:: bash .. code-block:: bash
make -j -C obj_dir -f Vour.mk Vour make -j -C obj_dir -f Vour.mk Vour
And now we run it: And now we run it:
.. code-block:: bash .. code-block:: bash
obj_dir/Vour obj_dir/Vour
And we get, after the SystemC banner, the same output as the C++ example: And we get, after the SystemC banner, the same output as the C++ example:
.. code-block:: bash .. code-block:: bash
SystemC 2.3.3-Accellera SystemC 2.3.3-Accellera
Hello World Hello World
- our.v:4: Verilog $finish - our.v:4: Verilog $finish
Really, you're better off using a Makefile to run the steps for you so when Really, you're better off using a Makefile to run the steps for you so when
your source changes it will automatically run all of the appropriate steps. your source changes it will automatically run all of the appropriate steps.

View File

@ -1,7 +1,7 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
.. _Examples: .. _examples:
======== ========
Examples Examples

View File

@ -1,14 +1,14 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
.. _Simulation Runtime Arguments: .. _simulation runtime arguments:
Simulation Runtime Arguments Simulation Runtime Arguments
============================ ============================
The following are the arguments that may be passed to a Verilated The following are the arguments that may be passed to a Verilated
executable, provided that executable calls executable, provided that executable calls
:code:`VerilatedContext*->commandArgs(argc, argv)`. ``VerilatedContext*->commandArgs(argc, argv)``.
All simulation runtime arguments begin with "+verilator", so that the All simulation runtime arguments begin with "+verilator", so that the
user's executable may skip over all "+verilator" arguments when parsing its user's executable may skip over all "+verilator" arguments when parsing its
@ -18,15 +18,16 @@ Summary:
.. include:: ../_build/gen/args_verilated.rst .. include:: ../_build/gen/args_verilated.rst
Options:
.. option:: +verilator+coverage+file+<filename> .. option:: +verilator+coverage+file+<filename>
When a model was Verilated using :vlopt:`--coverage`, sets the filename When a model was Verilated using :vlopt:`--coverage`, sets the filename
to write coverage data into. Defaults to :file:`coverage.dat`. to write coverage data into. Defaults to :file:`coverage.dat`.
.. option:: +verilator+debug .. option:: +verilator+debug
Enable simulation runtime debugging. Equivalent to Enable simulation runtime debugging. Equivalent to
:vlopt:`+verilator+debugi+4 <+verilator+debugi+\<value\>>`. :vlopt:`+verilator+debugi+4 <+verilator+debugi+\<value\>>`.
To be useful, the model typically must first be compiled with debug To be useful, the model typically must first be compiled with debug
@ -50,12 +51,12 @@ Summary:
.. option:: +verilator+noassert .. option:: +verilator+noassert
Disable assert checking per runtime argument. This is the same as Disable assert checking per runtime argument. This is the same as
calling :code:`VerilatedContext*->assertOn(false)` in the model. calling ``VerilatedContext*->assertOn(false)`` in the model.
.. option:: +verilator+prof+exec+file+<filename> .. option:: +verilator+prof+exec+file+<filename>
When a model was Verilated using :vlopt:`--prof-exec`, sets the When a model was Verilated using :vlopt:`--prof-exec`, sets the
simulation runtime filename to dump to. Defaults to simulation runtime filename to dump to. Defaults to
:file:`profile_exec.dat`. :file:`profile_exec.dat`.
.. option:: +verilator+prof+exec+start+<value> .. option:: +verilator+prof+exec+start+<value>
@ -72,9 +73,9 @@ Summary:
When a model was Verilated using :vlopt:`--prof-exec`, after $time When a model was Verilated using :vlopt:`--prof-exec`, after $time
reaches :vlopt:`+verilator+prof+exec+start+\<value\>`, Verilator will reaches :vlopt:`+verilator+prof+exec+start+\<value\>`, Verilator will
warm up the profiling for this number of eval() calls, then will capture warm up the profiling for this number of eval() calls, then will capture
the profiling of this number of eval() calls. Defaults to 2, which the profiling of this number of eval() calls. Defaults to 2, which makes
makes sense for a single-clock-domain module where it's typical to want sense for a single-clock-domain module where it's typical to want to
to capture one posedge eval() and one negedge eval(). capture one posedge eval() and one negedge eval().
.. option:: +verilator+prof+threads+file+<filename> .. option:: +verilator+prof+threads+file+<filename>
@ -94,7 +95,7 @@ Summary:
.. option:: +verilator+prof+vlt+file+<filename> .. option:: +verilator+prof+vlt+file+<filename>
When a model was Verilated using :vlopt:`--prof-pgo`, sets the When a model was Verilated using :vlopt:`--prof-pgo`, sets the
profile-guided optimization data runtime filename to dump to. Defaults profile-guided optimization data runtime filename to dump to. Defaults
to :file:`profile.vlt`. to :file:`profile.vlt`.
.. option:: +verilator+quiet .. option:: +verilator+quiet
@ -104,15 +105,15 @@ Summary:
.. option:: +verilator+rand+reset+<value> .. option:: +verilator+rand+reset+<value>
When a model was Verilated using When a model was Verilated using :vlopt:`--x-initial unique
:vlopt:`--x-initial unique <--x-initial>`, sets the simulation runtime <--x-initial>`, sets the simulation runtime initialization technique. 0
initialization technique. 0 = Reset to zeros. 1 = Reset to all-ones. 2 = Reset to zeros. 1 = Reset to all-ones. 2 = Randomize. See
= Randomize. See :ref:`Unknown States`. :ref:`Unknown States`.
.. option:: +verilator+seed+<value> .. option:: +verilator+seed+<value>
For $random and :vlopt:`--x-initial unique <--x-initial>`, set the For $random and :vlopt:`--x-initial unique <--x-initial>`, set the
simulation runtime random seed value. If zero or not specified picks a simulation runtime random seed value. If zero or not specified picks a
value from the system random number generator. value from the system random number generator.
.. option:: +verilator+V .. option:: +verilator+V

File diff suppressed because it is too large Load Diff

View File

@ -1,4 +1,4 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
verilator_coverage verilator_coverage
@ -7,7 +7,7 @@ verilator_coverage
Verilator_coverage processes Verilated model-generated coverage reports. Verilator_coverage processes Verilated model-generated coverage reports.
With `--annotate`, it reads the specified coverage data file and generates With `--annotate`, it reads the specified coverage data file and generates
annotated source code with coverage metrics annotated. With annotated source code with coverage metrics annotated. With
`--annotate-points` the coverage points corresponding to each line are also `--annotate-points` the coverage points corresponding to each line are also
shown. shown.
@ -21,25 +21,26 @@ those statistics of interest and save to a new .dat file.
For Verilog conditions that should never occur, either add a $stop For Verilog conditions that should never occur, either add a $stop
statement to the appropriate statement block, or see statement to the appropriate statement block, or see
:option:`/*verilator&32;coverage_off*/`. This will remove the coverage :option:`/*verilator&32;coverage_off*/`. This will remove the coverage
points after the model is re-Verilated. points after the model is re-Verilated.
For an overview of the use of verilator_coverage, see :ref:`Coverage Analysis`. For an overview of the use of verilator_coverage, see :ref:`Coverage
Analysis`.
verilator_coverage Example Usage verilator_coverage Example Usage
-------------------------------- --------------------------------
.. .. code-block:: bash
verilator_coverage --help verilator_coverage --help
verilator_coverage --version verilator_coverage --version
verilator_coverage --annotate obj_dir coverage.dat verilator_coverage --annotate obj_dir coverage.dat
verilator_coverage --write merged.dat coverage.dat ... verilator_coverage --write merged.dat coverage.dat ...
verilator_coverage --write-info merged.info coverage.dat ... verilator_coverage --write-info merged.info coverage.dat ...
verilator_coverage Arguments verilator_coverage Arguments
@ -49,8 +50,8 @@ verilator_coverage Arguments
.. option:: <filename> .. option:: <filename>
Specifies the input coverage data file. Multiple filenames may be Specifies the input coverage data file. Multiple filenames may be
provided to read multiple inputs. If no data file is specified, by provided to read multiple inputs. If no data file is specified, by
default, "coverage.dat" will be read. default, "coverage.dat" will be read.
.. option:: --annotate <output_directory> .. option:: --annotate <output_directory>
@ -59,8 +60,8 @@ verilator_coverage Arguments
coverage data should be written. coverage data should be written.
Points are children of each line coverage- branches, expressions or Points are children of each line coverage- branches, expressions or
toggle points. When point counts are aggregated into a line, the toggle points. When point counts are aggregated into a line, the minimum
minimum and maximum counts are used to determine the status of the line and maximum counts are used to determine the status of the line
(complete, partial, failing) The count is equal to the maximum of the (complete, partial, failing) The count is equal to the maximum of the
points. points.
@ -73,7 +74,8 @@ verilator_coverage Arguments
* "%" indicates that all points on the line are below the coverage min. * "%" indicates that all points on the line are below the coverage min.
* "~" indicates that some points on the line are above the coverage min and some are below. * "~" indicates that some points on the line are above the coverage min and some are below.
* "+" coverage point was at or above the min. Only used with :option:`--annotate-points`. * "+" coverage point was at or above the min. Only used with :option:`--annotate-points`.
* "-" coverage point was below the min. Only used with :option:`--annotate-points`. * "-" coverage point was below the min. Only used with
:option:`--annotate-points`.
.. code-block:: .. code-block::
@ -92,8 +94,8 @@ verilator_coverage Arguments
.. option:: --annotate-all .. option:: --annotate-all
Specifies all files should be shown. By default, only those source Specifies all files should be shown. By default, only those source files
files with low coverage are written to the output directory. with low coverage are written to the output directory.
This option should be used together with :option:`--annotate`. This option should be used together with :option:`--annotate`.
@ -111,8 +113,8 @@ verilator_coverage Arguments
.. option:: --annotate-points .. option:: --annotate-points
Specifies all coverage points should be shown after each line of text. By Specifies all coverage points should be shown after each line of text.
default, only source lines are shown. By default, only source lines are shown.
.. code-block:: .. code-block::
@ -137,7 +139,7 @@ verilator_coverage Arguments
.. option:: --rank .. option:: --rank
Prints an experimental report listing the relative importance of each Prints an experimental report listing the relative importance of each
test in covering all of the coverage points. The report shows "Covered" test in covering all of the coverage points. The report shows "Covered"
which indicates the number of points the test covers; a test is which indicates the number of points the test covers; a test is
considered to cover a point if it has a bucket count of at least 1. The considered to cover a point if it has a bucket count of at least 1. The
"rank" column has a higher number t indicate the test is more critical, "rank" column has a higher number t indicate the test is more critical,
@ -159,7 +161,7 @@ verilator_coverage Arguments
Specifies the aggregate coverage results, summed across all the files, Specifies the aggregate coverage results, summed across all the files,
should be written to the given filename in verilator_coverage data should be written to the given filename in verilator_coverage data
format. This is useful in scripts to combine many coverage data files format. This is useful in scripts to combine many coverage data files
(likely generated from random test runs) into one master coverage file. (likely generated from random test runs) into one master coverage file.
.. option:: --write-info <filename.info> .. option:: --write-info <filename.info>

View File

@ -1,4 +1,4 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
verilator_gantt verilator_gantt
@ -31,50 +31,50 @@ In waveforms, there are the following signals. In GTKWave, use "decimal"
data format to remove the leading zeros and make the traces easier to read. data format to remove the leading zeros and make the traces easier to read.
trace/section trace/section
Shows the name of the current top of the execution section stack. Shows the name of the current top of the execution section stack. Set
Set GTKWave data format to "ASCII". GTKWave data format to "ASCII".
trace/depth trace/depth
Shows the depth of the execution section stack. Shows the depth of the execution section stack. Set GTKWave data format
Set GTKWave data format to "Analog". to "Analog".
measured_parallelism measured_parallelism
The number of mtasks active at this time, for best performance, this will The number of mtasks active at this time, for best performance, this
match the thread count. In GTKWave, use a data format of "analog step" to will match the thread count. In GTKWave, use a data format of "analog
view this signal. step" to view this signal.
predicted_parallelism predicted_parallelism
The number of mtasks Verilator predicted would be active at this time, The number of mtasks Verilator predicted would be active at this time,
for best performance this will match the thread count. In GTKWave, use a for best performance this will match the thread count. In GTKWave, use a
data format of "analog step" to view this signal. data format of "analog step" to view this signal.
cpu#_thread cpu#_thread
For the given CPU number, the thread number measured to be executing. For the given CPU number, the thread number measured to be executing.
cpu#_waiting cpu#_waiting
For the given CPU number, aggregated waiting time for mtask dependencies. For the given CPU number, aggregated waiting time for mtask
Visualized as `X` values. dependencies. Visualized as `X` values.
mtask#_cpu mtask#_cpu
For the given mtask id, the CPU it was measured to execute on. For the given mtask id, the CPU it was measured to execute on.
thread#_mtask thread#_mtask
For the given thread number, the mtask id it was executing. For the given thread number, the mtask id it was executing.
predicted_thread#_mtask predicted_thread#_mtask
For the given thread number, the mtask id Verilator predicted would be For the given thread number, the mtask id Verilator predicted would be
executing. executing.
verilator_gantt Example Usage verilator_gantt Example Usage
----------------------------- -----------------------------
.. .. code-block:: bash
verilator_gantt --help verilator_gantt --help
verilator_gantt --version verilator_gantt --version
verilator_gantt profile_exec.dat verilator_gantt profile_exec.dat
verilator_gantt Arguments verilator_gantt Arguments

View File

@ -1,29 +1,29 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
verilator_profcfunc verilator_profcfunc
=================== ===================
Verilator_profcfunc reads a profile report created by gprof. The names of Verilator_profcfunc reads a profile report created by gprof. The names of
the functions are then transformed, assuming the user used Verilator's the functions are then transformed, assuming the user used Verilator's
--prof-cfuncs, and a report printed showing the percentage of the time, --prof-cfuncs, and a report printed showing the percentage of the time,
etc., in each Verilog block. etc., in each Verilog block.
Due to rounding errors in gprof reports, the input report's percentages may Due to rounding errors in gprof reports, the input report's percentages may
not total 100%. In the verilator_profcfunc report this will get not total 100%. In the verilator_profcfunc report this will get reported as
reported as a rounding error. a rounding error.
For an overview of the use of verilator_profcfunc, see :ref:`Profiling`. For an overview of the use of verilator_profcfunc, see :ref:`Profiling`.
verilator_profcfunc Example Usage verilator_profcfunc Example Usage
--------------------------------- ---------------------------------
.. .. code-block:: bash
verilator_profcfunc --help verilator_profcfunc --help
verilator_profcfunc --version verilator_profcfunc --version
verilator_profcfunc gprof.out verilator_profcfunc gprof.out
verilator_profcfunc Arguments verilator_profcfunc Arguments

View File

@ -1,4 +1,4 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
********************************* *********************************

View File

@ -1,35 +1,35 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
===================== ===================
Language Extensions Language Extensions
===================== ===================
The following additional constructs are the extensions Verilator supports The following additional constructs are the extensions Verilator supports
on top of standard Verilog code. Using these features outside of comments on top of standard Verilog code. Using these features outside of comments
or "`ifdef`"'s may break other tools. or "`ifdef`"'s may break other tools.
.. option:: """ [string] """ .. option:: """ [string] """
A triple-quoted block specifies a string that may include newlines and A triple-quoted block specifies a string that may include newlines and
single quotes. This extension was standardized in IEEE 1800-2023. single quotes. This extension was standardized in IEEE 1800-2023.
.. option:: `__FILE__ .. option:: `__FILE__
The :option:`\`__FILE__` define expands to the current filename as a The :option:`\`__FILE__` define expands to the current filename as a
string, like C++'s __FILE__. This Verilator feature, added in 2006, was string, like C++'s __FILE__. This Verilator feature, added in 2006, was
incorporated into IEEE 1800-2009. incorporated into IEEE 1800-2009.
.. option:: `__LINE__ .. option:: `__LINE__
The :option:`\`__LINE__` define expands to the current line number like The :option:`\`__LINE__` define expands to the current line number like
C++'s __LINE__. This Verilator feature added in 2006 was incorporated C++'s __LINE__. This Verilator feature added in 2006 was incorporated
into IEEE 1800-2009. into IEEE 1800-2009.
.. option:: `coverage_block_off .. option:: `coverage_block_off
Specifies the entire begin/end block should be ignored for coverage Specifies the entire begin/end block should be ignored for coverage
analysis. Must be inside a code block, e.g., within a begin/end pair. analysis. Must be inside a code block, e.g., within a begin/end pair.
Same as :option:`coverage_block_off` in :ref:`Verilator Control Files`. Same as :option:`coverage_block_off` in :ref:`Verilator Control Files`.
.. option:: `error [string] .. option:: `error [string]
@ -50,14 +50,14 @@ or "`ifdef`"'s may break other tools.
blocks, replaced with the C++ class name generated for the given blocks, replaced with the C++ class name generated for the given
containing SystemVerilog class or module. Currently this is replaced containing SystemVerilog class or module. Currently this is replaced
blindly, ignoring quoting or other escapes; this behavior may change in blindly, ignoring quoting or other escapes; this behavior may change in
the future. This attribute is indented only to be used internally in the future. This attribute is indented only to be used internally in
`verilated_std.sv`. `verilated_std.sv`.
.. option:: `systemc_ctor .. option:: `systemc_ctor
Take the remaining text up to the next :option:`\`verilog` or Take the remaining text up to the next :option:`\`verilog` or
:option:`\`systemc_... <\`systemc_header>` mode switch and place it :option:`\`systemc_... <\`systemc_header>` mode switch and place it
verbatim into the C++ class constructor. Must be placed as a module or verbatim into the C++ class constructor. Must be placed as a module or
class item, e.g., directly inside a module/endmodule or class/endclass class item, e.g., directly inside a module/endmodule or class/endclass
pair. Despite the name of this macro, this also works in pure C++ code. pair. Despite the name of this macro, this also works in pure C++ code.
@ -65,7 +65,7 @@ or "`ifdef`"'s may break other tools.
Take the remaining text up to the next :option:`\`verilog` or Take the remaining text up to the next :option:`\`verilog` or
:option:`\`systemc_... <\`systemc_header>` mode switch and place it :option:`\`systemc_... <\`systemc_header>` mode switch and place it
verbatim into the C++ class destructor. Must be placed as a module or verbatim into the C++ class destructor. Must be placed as a module or
class item, e.g., directly inside a module/endmodule or class/endclass class item, e.g., directly inside a module/endmodule or class/endclass
pair. Despite the name of this macro, this also works in pure C++ code. pair. Despite the name of this macro, this also works in pure C++ code.
@ -73,10 +73,9 @@ or "`ifdef`"'s may break other tools.
Take the remaining text up to the next :option:`\`verilog` or Take the remaining text up to the next :option:`\`verilog` or
:option:`\`systemc_... <\`systemc_header>` mode switch and place it :option:`\`systemc_... <\`systemc_header>` mode switch and place it
verbatim into the output .h file's header. Must be placed as a module verbatim into the output .h file's header. Must be placed as a module or
or class item, e.g., directly inside a module/endmodule or class item, e.g., directly inside a module/endmodule or class/endclass
class/endclass pair. Despite the name of this macro, this also works in pair. Despite the name of this macro, this also works in pure C++ code.
pure C++ code.
.. option:: `systemc_header_post .. option:: `systemc_header_post
@ -100,21 +99,21 @@ or "`ifdef`"'s may break other tools.
Take the remaining text up to the next :option:`\`verilog` or Take the remaining text up to the next :option:`\`verilog` or
:option:`\`systemc_... <\`systemc_header>` mode switch and place it :option:`\`systemc_... <\`systemc_header>` mode switch and place it
verbatim into a single file of the C++ class implementation. Must be verbatim into a single file of the C++ class implementation. Must be
placed as a module or class item, e.g., directly inside a placed as a module or class item, e.g., directly inside a
module/endmodule or class/endclass pair. Despite the name of this macro, module/endmodule or class/endclass pair. Despite the name of this macro,
this also works in pure C++ code. this also works in pure C++ code.
If you will be reading or writing any Verilog variables in the C++ If you will be reading or writing any Verilog variables in the C++
functions, the Verilog signals must be declared with a functions, the Verilog signals must be declared with a
:option:`/*verilator&32;public*/` metacomment. See also the public task :option:`/*verilator&32;public*/` metacomment. See also the public task
feature; writing an accessor may result in cleaner code. feature; writing an accessor may result in cleaner code.
.. option:: `systemc_interface .. option:: `systemc_interface
Take the remaining text up to the next :option:`\`verilog` or Take the remaining text up to the next :option:`\`verilog` or
:option:`\`systemc_... <\`systemc_header>` mode switch and place it :option:`\`systemc_... <\`systemc_header>` mode switch and place it
verbatim into the C++ class interface. Must be placed as a module or verbatim into the C++ class interface. Must be placed as a module or
class item, e.g., directly inside a module/endmodule or class/endclass class item, e.g., directly inside a module/endmodule or class/endclass
pair. Despite the name of this macro, this also works in pure C++ code. pair. Despite the name of this macro, this also works in pure C++ code.
@ -136,22 +135,22 @@ or "`ifdef`"'s may break other tools.
.. option:: `verilator_config .. option:: `verilator_config
Take the remaining text up to the next :option:`\`verilog` mode switch Take the remaining text up to the next :option:`\`verilog` mode switch
and treat it as Verilator Control File commands. See :ref:`Verilator and treat it as Verilator Control File commands. See :ref:`Verilator
Control Files`. Control Files`.
.. option:: `VERILATOR_TIMING .. option:: `VERILATOR_TIMING
The VERILATOR_TIMING define is set when :vlopt:`--timing` is used to The VERILATOR_TIMING define is set when :vlopt:`--timing` is used to
allow an "\`ifdef" of code dependent on this feature. Note that this define allow an "\`ifdef" of code dependent on this feature. Note that this
is not affected by the :option:`timing_off` control file option define is not affected by the :option:`timing_off` control file option
nor timing metacomments. nor timing metacomments.
.. option:: `verilog .. option:: `verilog
Switch back to processing Verilog code after a Switch back to processing Verilog code after a :option:`\`systemc_...
:option:`\`systemc_... <\`systemc_header>` mode switch. The Verilog <\`systemc_header>` mode switch. The Verilog code returns to the last
code returns to the last language mode specified with language mode specified with "\`begin_keywords", or SystemVerilog if
"\`begin_keywords", or SystemVerilog if none was specified. none was specified.
.. t_dist_docs_style restart_sort .. t_dist_docs_style restart_sort
@ -159,7 +158,7 @@ or "`ifdef`"'s may break other tools.
.. option:: $c([string], ...);, $cpure([string], ...); .. option:: $c([string], ...);, $cpure([string], ...);
The string will be embedded directly in the output C++ code at the point The string will be embedded directly in the output C++ code at the point
where the surrounding Verilog code is compiled. It may either be a where the surrounding Verilog code is compiled. It may either be a
standalone statement (with a trailing ; in the string), or a function standalone statement (with a trailing ; in the string), or a function
that returns up to a 32-bit number (without a trailing ;). This can be that returns up to a 32-bit number (without a trailing ;). This can be
used to call C++ functions from your Verilog code. used to call C++ functions from your Verilog code.
@ -171,28 +170,27 @@ or "`ifdef`"'s may break other tools.
via an explicit 'this->' pointer dereference. via an explicit 'this->' pointer dereference.
Expression arguments will have the code to evaluate the expression Expression arguments will have the code to evaluate the expression
inserted. Thus to call a C++ function, :code:`$c("func(",a,")")` will inserted. Thus to call a C++ function, ``$c("func(",a,")")`` will result
result in :code:`func(a)` in the output C++ code. For input arguments, in ``func(a)`` in the output C++ code. For input arguments, rather than
rather than hard-coding variable names in the string hard-coding variable names in the string ``$c("func(a)")``, instead pass
:code:`$c("func(a)")`, instead pass the variable as an expression the variable as an expression :``$c("func(",a,")")``. This will allow
::code:`$c("func(",a,")")`. This will allow the call to work inside the call to work inside Verilog functions where the variable is
Verilog functions where the variable is flattened out and enable other flattened out and enable other optimizations.
optimizations.
Verilator does not use any text inside the quotes for Verilator does not use any text inside the quotes for
ordering/scheduling. If you need the $c to be called at a specific ordering/scheduling. If you need the $c to be called at a specific time,
time, e.g., when a variable changes, then the $c must be under an e.g., when a variable changes, then the $c must be under an appropriate
appropriate sensitivity statement, e.g., sensitivity statement, e.g., ``always @(posedge clk) $c("func()")`` to
:code:`always @(posedge clk) $c("func()")` to call it on every edge, or, call it on every edge, or, e.g., ``always @* c("func(",a,")")`` to call
e.g., :code:`always @* c("func(",a,")")` to call it when :code:`a` it when ``a`` changes (the latter working because ``a`` is outside the
changes (the latter working because :code:`a` is outside the quotes). quotes).
If you will be reading or writing any Verilog variables inside the C++ If you will be reading or writing any Verilog variables inside the C++
functions, the Verilog signals must be declared with functions, the Verilog signals must be declared with
:option:`/*verilator&32;public*/` metacomments. :option:`/*verilator&32;public*/` metacomments.
You may also append a number to $c, which specifies the bit width of You may also append a number to $c, which specifies the bit width of the
the output, e.g., :code:`signal_32_bits = $c32("...");`. This allows for output, e.g., ``signal_32_bits = $c32("...");``. This allows for
compatibility with other simulators, which require a differently named compatibility with other simulators, which require a differently named
PLI function name for each different output width. PLI function name for each different output width.
@ -203,31 +201,31 @@ or "`ifdef`"'s may break other tools.
.. option:: $display, $write, $fdisplay, $fwrite, $sformat, $swrite .. option:: $display, $write, $fdisplay, $fwrite, $sformat, $swrite
Format arguments may use C fprintf sizes after the % escape. Per the Format arguments may use C fprintf sizes after the % escape. Per the
Verilog standard, %x prints a number with the natural width, and %0x Verilog standard, %x prints a number with the natural width, and %0x
prints a number with minimum width. Verilator extends this so %5x prints a number with minimum width. Verilator extends this so %5x prints
prints 5 digits per the C standard. This extension was standardized into 5 digits per the C standard. This extension was standardized into
1800-2009. 1800-2009.
.. option:: $stacktrace .. option:: $stacktrace
Called as a task, print a stack trace. Called as a function, return a Called as a task, print a stack trace. Called as a function, return a
string with a stack trace. This relies on the C++ system trace, which string with a stack trace. This relies on the C++ system trace, which
may give less meaningful results if the model is not compiled with debug may give less meaningful results if the model is not compiled with debug
symbols. Also, the data represents the C++ stack; the SystemVerilog symbols. Also, the data represents the C++ stack; the SystemVerilog
functions/tasks involved may be renamed and/or inlined before becoming functions/tasks involved may be renamed and/or inlined before becoming
the C++ functions that may be visible in the stack trace. This the C++ functions that may be visible in the stack trace. This extension
extension was standardized in IEEE 1800-2023. was standardized in IEEE 1800-2023.
.. option:: $timeprecision .. option:: $timeprecision
Returns the timeprecision of the model as an integer. This extension is Returns the timeprecision of the model as an integer. This extension is
experimental and may be removed without deprecation. experimental and may be removed without deprecation.
.. option:: $timeunit .. option:: $timeunit
Returns the timeunit of the current module as an integer. This Returns the timeunit of the current module as an integer. This extension
extension is experimental and may be removed without deprecation. is experimental and may be removed without deprecation.
.. option:: /*verilator&32;clock_enable*/ .. option:: /*verilator&32;clock_enable*/
@ -242,10 +240,10 @@ or "`ifdef`"'s may break other tools.
.. code-block:: sv .. code-block:: sv
reg enable_r /*verilator clock_enable*/; reg enable_r /*verilator clock_enable*/;
wire gated_clk = clk & enable_r; wire gated_clk = clk & enable_r;
always_ff @(posedge clk) always_ff @(posedge clk)
enable_r <= enable_early; enable_r <= enable_early;
The clock_enable attribute will cause the clock gate to be ignored in The clock_enable attribute will cause the clock gate to be ignored in
the scheduling algorithm, sometimes required for correct clock behavior, the scheduling algorithm, sometimes required for correct clock behavior,
@ -287,6 +285,15 @@ or "`ifdef`"'s may break other tools.
(if appropriate :vlopt:`--coverage` flags are passed) after being (if appropriate :vlopt:`--coverage` flags are passed) after being
disabled earlier with :option:`/*verilator&32;coverage_off*/`. disabled earlier with :option:`/*verilator&32;coverage_off*/`.
.. option:: /*verilator&32;fargs <arguments>*/
For Verilator developers only. When a source file containing these `fargs`
metacomments is passed to Verilator on the command line via the :vlopt:`-f`
or :vlopt:`-F` option, the provided arguments will be added as if specified
on the command line. The source file is not preprocessed before parsing for
arguments, and all `fargs` comments will take effect, even if placed
undef an inactive `\`ifdef`.
.. option:: /*verilator&32;forceable*/ .. option:: /*verilator&32;forceable*/
Specifies that the signal (net or variable) should be made forceable from Specifies that the signal (net or variable) should be made forceable from
@ -306,10 +313,10 @@ or "`ifdef`"'s may break other tools.
.. option:: /*verilator&32;hier_block*/ .. option:: /*verilator&32;hier_block*/
Specifies that the module is a unit of hierarchical Verilation. This Specifies that the module is a unit of hierarchical Verilation. This
metacomment must be between :code:`module module_name(...);` and metacomment must be between ``module module_name(...);`` and
:code:`endmodule`. The module will not be inlined nor uniquified for ``endmodule``. The module will not be inlined nor uniquified for each
each instance in hierarchical Verilation. Note that the metacomment is instance in hierarchical Verilation. Note that the metacomment is
ignored unless the :vlopt:`--hierarchical` option is specified. ignored unless the :vlopt:`--hierarchical` option is specified.
See :ref:`Hierarchical Verilation`. See :ref:`Hierarchical Verilation`.
@ -317,17 +324,17 @@ or "`ifdef`"'s may break other tools.
.. option:: /*verilator&32;inline_module*/ .. option:: /*verilator&32;inline_module*/
Specifies the module the comment appears in may be inlined into any Specifies the module the comment appears in may be inlined into any
modules that use this module. This is useful to speed up simulation modules that use this module. This is useful to speed up simulation
runtime. Note if using :vlopt:`--public` that signals under inlined runtime. Note if using :vlopt:`--public` that signals under inlined
submodules will be named :code:`{submodule}__DOT__{subsignal}` as C++ submodules will be named ``{submodule}__DOT__{subsignal}`` as C++ does
does not allow "." in signal names. not allow "." in signal names.
Same as :option:`inline` control file option. Same as :option:`inline` control file option.
.. option:: /*verilator&32;isolate_assignments*/ .. option:: /*verilator&32;isolate_assignments*/
Used after a signal declaration to indicate the assignments to this Used after a signal declaration to indicate the assignments to this
signal in any blocks should be isolated into new blocks. When large signal in any blocks should be isolated into new blocks. When large
combinatorial block results in a :option:`UNOPTFLAT` warning, attaching combinatorial block results in a :option:`UNOPTFLAT` warning, attaching
this to the signal that was causing a false loop may work around the this to the signal that was causing a false loop may work around the
warning. warning.
@ -336,14 +343,14 @@ or "`ifdef`"'s may break other tools.
.. code-block:: sv .. code-block:: sv
reg splitme /* verilator isolate_assignments*/; reg splitme /* verilator isolate_assignments*/;
// Note the placement of the semicolon above // Note the placement of the semicolon above
always_comb begin always_comb begin
if (....) begin if (....) begin
splitme = ....; splitme = ....;
other assignments other assignments
end end
end end
Verilator will internally split the block that assigns to "splitme" into Verilator will internally split the block that assigns to "splitme" into
two blocks: two blocks:
@ -370,36 +377,36 @@ or "`ifdef`"'s may break other tools.
.. option:: /*verilator&32;lint_off <msgs>*/ .. option:: /*verilator&32;lint_off <msgs>*/
Disable the specified warning message(s) for any warnings following the Disable the specified warning message(s) for any warnings following the
comment. Multiple messages may be specified, separated with commas. comment. Multiple messages may be specified, separated with commas.
If a one-line slash-slash-format comment is used, then the metacomment If a one-line slash-slash-format comment is used, then the metacomment
ends at the newline or at an earlier next slash-slash. This allow ends at the newline or at an earlier next slash-slash. This allow
commenting the reason for the disable, e.g. :code:`// verilator lint_off commenting the reason for the disable, e.g. ``// verilator lint_off
MSG // Because...`. MSG // Because...``.
.. option:: /*verilator&32;lint_on <msgs>*/ .. option:: /*verilator&32;lint_on <msgs>*/
Re-enable the specified warning message(s) for any warnings following Re-enable the specified warning message(s) for any warnings following
the comment. Multiple messages may be specified, separated with commas. the comment. Multiple messages may be specified, separated with commas.
.. option:: /*verilator&32;lint_restore*/ .. option:: /*verilator&32;lint_restore*/
After a :code:`/*verilator&32;lint_save*/`, pop the stack containing lint After a ``/*verilator&32;lint_save*/``, pop the stack containing lint
message state. Often this is useful at the bottom of include files. message state. Often this is useful at the bottom of include files.
.. option:: /*verilator&32;lint_save*/ .. option:: /*verilator&32;lint_save*/
Push the current state of what lint messages are turned on or off Push the current state of what lint messages are turned on or off to a
to a stack. Later meta-comments may then lint_on or lint_off specific stack. Later meta-comments may then lint_on or lint_off specific
messages, then return to the earlier message state by using messages, then return to the earlier message state by using
:code:`/*verilator&32;lint_restore*/`. For example: ``/*verilator&32;lint_restore*/``. For example:
.. code-block:: sv .. code-block:: sv
// verilator lint_save // verilator lint_save
// verilator lint_off WIDTH // verilator lint_off WIDTH
... // code needing WIDTH turned off ... // code needing WIDTH turned off
// verilator lint_restore // verilator lint_restore
If WIDTH was on before the lint_off, it would now be restored to on, and If WIDTH was on before the lint_off, it would now be restored to on, and
if it was off before the lint_off it would remain off. if it was off before the lint_off it would remain off.
@ -414,11 +421,10 @@ or "`ifdef`"'s may break other tools.
.. option:: /*verilator&32;no_inline_task*/ .. option:: /*verilator&32;no_inline_task*/
Used in a function or task variable definition section to specify the Used in a function or task variable definition section to specify the
function or task should not be inlined into where it is used. This may function or task should not be inlined into where it is used. This may
reduce the size of the final executable when a task is used a very large reduce the size of the final executable when a task is used a very large
number of times. For this flag to work, the task and tasks below it number of times. For this flag to work, the task and tasks below it must
must be pure; they cannot reference any variables outside the task be pure; they cannot reference any variables outside the task itself.
itself.
Same as :option:`no_inline` control file option. Same as :option:`no_inline` control file option.
@ -430,21 +436,21 @@ or "`ifdef`"'s may break other tools.
.. code-block:: sv .. code-block:: sv
parameter [2:0] PARAM /*verilator public*/ = 2'b0; parameter [2:0] PARAM /*verilator public*/ = 2'b0;
.. option:: /*verilator&32;public*/ (on task/function) .. option:: /*verilator&32;public*/ (on task/function)
Used inside the declaration section of a function or task declaration to Used inside the declaration section of a function or task declaration to
indicate the function or task should be made into a C++ function, public indicate the function or task should be made into a C++ function, public
to outside callers. Public tasks will be declared as a void C++ to outside callers. Public tasks will be declared as a void C++
function, public functions will get the appropriate non-void (bool, function, public functions will get the appropriate non-void (bool,
uint32_t, etc.) return type. Any input arguments will become C++ uint32_t, etc.) return type. Any input arguments will become C++
arguments to the function. Any output arguments will become C++ arguments to the function. Any output arguments will become C++
reference arguments. Any local registers/integers will become function reference arguments. Any local registers/integers will become function
automatic variables on the stack. automatic variables on the stack.
Wide variables over 64 bits cannot be function returns, to avoid Wide variables over 64 bits cannot be function returns, to avoid
exposing complexities. However, wide variables can be input/outputs; exposing complexities. However, wide variables can be input/outputs;
they will be passed as references to an array of 32-bit numbers. they will be passed as references to an array of 32-bit numbers.
Generally, only the values of stored state (flops) should be written, as Generally, only the values of stored state (flops) should be written, as
@ -464,17 +470,17 @@ or "`ifdef`"'s may break other tools.
.. code-block:: sv .. code-block:: sv
typedef enum logic [2:0] { ZERO = 3'b0 } pub_t /*verilator public*/; typedef enum logic [2:0] { ZERO = 3'b0 } pub_t /*verilator public*/;
.. option:: /*verilator&32;public*/ (on variable) .. option:: /*verilator&32;public*/ (on variable)
Used after an input, output, register, or wire declaration to indicate Used after an input, output, register, or wire declaration to indicate
the signal should be declared so that C code may read or write the value the signal should be declared so that C code may read or write the value
of the signal. This will also declare this module public; otherwise, use of the signal. This will also declare this module public; otherwise, use
:code:`/*verilator&32;public_flat*/`. ``/*verilator&32;public_flat*/``.
Instead of using public variables, consider making a DPI or public Instead of using public variables, consider making a DPI or public
function that accesses the variable. This is nicer as it provides an function that accesses the variable. This is nicer as it provides an
obvious entry point compatible across simulators. obvious entry point compatible across simulators.
Same as :option:`public` control file option. Same as :option:`public` control file option.
@ -484,30 +490,30 @@ or "`ifdef`"'s may break other tools.
Used to wrap multiple signals and parameters with the respective public attribute. Used to wrap multiple signals and parameters with the respective public attribute.
See attribute above for their respective behavior. Cannot be nested. e.g: See attribute above for their respective behavior. Cannot be nested. e.g:
.. code-block:: sv .. code-block:: sv
/*verilator public_flat_rw_on*/ /*verilator public_flat_rw_on*/
logic clk; logic clk;
logic rst; logic rst;
parameter width = 8; parameter width = 8;
/* verilator public_off*/ /* verilator public_off*/
logic data; logic data;
Is equivalent to: Is equivalent to:
.. code-block:: sv .. code-block:: sv
logic clk /*verilator public_flat_rw*/; logic clk /*verilator public_flat_rw*/;
logic rst /*verilator public_flat_rw*/; logic rst /*verilator public_flat_rw*/;
parameter width /*verilator public_flat_rw*/ = 8; parameter width /*verilator public_flat_rw*/ = 8;
logic data; logic data;
.. option:: /*verilator&32;public_flat*/ (on variable) .. option:: /*verilator&32;public_flat*/ (on variable)
Used after an input, output, register, or wire declaration to indicate Used after an input, output, register, or wire declaration to indicate
the signal should be declared so that C code may read or write the value the signal should be declared so that C code may read or write the value
of the signal. This will not declare this module public, which means of the signal. This will not declare this module public, which means the
the name of the signal or path to it may change based upon the module name of the signal or path to it may change based upon the module
inlining which takes place. inlining which takes place.
Same as :option:`public_flat` control file option. Same as :option:`public_flat` control file option.
@ -536,9 +542,9 @@ or "`ifdef`"'s may break other tools.
Used after a module statement to indicate the module should not be Used after a module statement to indicate the module should not be
inlined (unless specifically requested) so that C code may access the inlined (unless specifically requested) so that C code may access the
module. Verilator automatically sets this attribute when the module module. Verilator automatically sets this attribute when the module
contains public signals or \`systemc_ directives. Use of this is contains public signals or \`systemc_ directives. Use of this is implied
implied when using the :vlopt:`--public` option. when using the :vlopt:`--public` option.
Same as :option:`public` control file option. Same as :option:`public` control file option.
@ -546,31 +552,40 @@ or "`ifdef`"'s may break other tools.
Terminates the previous `/*verilator public*_on*/` directive; see above. Terminates the previous `/*verilator public*_on*/` directive; see above.
.. option:: /*verilator&32;sc_biguint*/
Used after a port declaration. It sets the port to be of
``sc_biguint<{width}>`` type, for signals of any width. This may be
useful if the port width is parameterized and the instantiating C++ code
always wants to have a sc_biguint accept any width. In general, you
should avoid using this attribute when unnecessary, as the performance
decreases significantly with increasing usage of sc_biguint.
.. option:: /*verilator&32;sc_bv*/ .. option:: /*verilator&32;sc_bv*/
Used after a port declaration. It sets the port to be of Used after a port declaration. It sets the port to be of
:code:`sc_bv<{width}>` type, instead of bool, uint32_t, or uint64_t. ``sc_bv<{width}>`` type, instead of bool, uint32_t, or uint64_t. This
This may be useful if the port width is parameterized and the may be useful if the port width is parameterized and the instantiating
instantiating C++ code always wants to have a sc_bv accept any width. C++ code always wants to have a sc_bv accept any width. In general, you
In general, you should avoid using this attribute when unnecessary, as should avoid using this attribute when unnecessary, as the performance
the performance decreases significantly with increasing usage of sc_bv. decreases significantly with increasing usage of sc_bv.
Same as :option:`sc_bv` control file option. Same as :option:`sc_bv` control file option.
.. option:: /*verilator&32;sc_clock*/ .. option:: /*verilator&32;sc_clock*/
Deprecated and ignored. Previously used after an input declaration to Deprecated and ignored. Previously used after an input declaration to
indicate the signal should be declared in SystemC as a sc_clock instead indicate the signal should be declared in SystemC as a sc_clock instead
of a bool. This was needed in SystemC 1.1 and 1.2 only; versions 2.0 of a bool. This was needed in SystemC 1.1 and 1.2 only; versions 2.0 and
and later do not require clock pins to be sc_clocks, and this is no later do not require clock pins to be sc_clocks, and this is no longer
longer needed and is ignored. needed and is ignored.
.. option:: /*verilator&32;sformat*/ .. option:: /*verilator&32;sformat*/
Attached to the final argument of type "input string" of a function or Attached to the final argument of type "input string" of a function or
task to indicate that the function or task should pass all remaining task to indicate that the function or task should pass all remaining
arguments through $sformatf. This allows creation of DPI functions with arguments through $sformatf. This allows creation of DPI functions with
$display-like behavior. See the :file:`test_regress/t/t_dpi_display.v` $display-like behavior. See the :file:`test_regress/t/t_dpi_display.v`
file for an example. file for an example.
Same as :option:`sformat` control file option. Same as :option:`sformat` control file option.
@ -587,14 +602,14 @@ or "`ifdef`"'s may break other tools.
.. code-block:: sv .. code-block:: sv
logic [7:0] x [0:1] /*verilator split_var*/; logic [7:0] x [0:1] /*verilator split_var*/;
To: To:
.. code-block:: sv .. code-block:: sv
logic [7:0] x__BRA__0__KET__ /*verilator split_var*/; logic [7:0] x__BRA__0__KET__ /*verilator split_var*/;
logic [7:0] x__BRA__1__KET__ /*verilator split_var*/; logic [7:0] x__BRA__1__KET__ /*verilator split_var*/;
Note that the generated packed variables retain the split_var Note that the generated packed variables retain the split_var
metacomment because they may be split into smaller pieces according to metacomment because they may be split into smaller pieces according to
@ -602,7 +617,7 @@ or "`ifdef`"'s may break other tools.
This only supports unpacked arrays, packed arrays, and packed structs of This only supports unpacked arrays, packed arrays, and packed structs of
integer types (reg, logic, bit, byte, int...); otherwise, if a split was integer types (reg, logic, bit, byte, int...); otherwise, if a split was
requested but cannot occur, a SPLITVAR warning is issued. Splitting requested but cannot occur, a SPLITVAR warning is issued. Splitting
large arrays may slow down the Verilation speed, so use this only on large arrays may slow down the Verilation speed, so use this only on
variables that require it. variables that require it.
@ -613,12 +628,11 @@ or "`ifdef`"'s may break other tools.
.. code-block:: sv .. code-block:: sv
logic [1:0][31:0] tmp; logic [1:0][31:0] tmp;
assign tmp[0] = foo + a;
assign tmp[1] = tmp[1] + b;
assign bar = tmp[1] + c;
assign tmp[0] = foo + a;
assign tmp[1] = tmp[1] + b;
assign bar = tmp[1] + c;
Same as :option:`split_var` control file option. Same as :option:`split_var` control file option.
@ -632,8 +646,8 @@ or "`ifdef`"'s may break other tools.
Ignore all timing constructs after this metacomment. All timing controls Ignore all timing constructs after this metacomment. All timing controls
behave as if they were not there (the same way as with behave as if they were not there (the same way as with
:option:`--no-timing`), and :code:`fork`/:code:`join*` blocks are :option:`--no-timing`), and ``fork``/``join*`` blocks are
converted into :code:`begin`/:code:`end` blocks. converted into ``begin``/``end`` blocks.
Same as :option:`timing_off` control file option. Same as :option:`timing_off` control file option.
@ -658,7 +672,7 @@ or "`ifdef`"'s may break other tools.
.. option:: /*verilator&32;tracing_off*/ .. option:: /*verilator&32;tracing_off*/
Disable waveform tracing for all future signals declared in this module, Disable waveform tracing for all future signals declared in this module,
or instances below this module. Often this is placed just after a or instances below this module. Often this is placed just after a
primitive's module statement, so that the entire module and instances primitive's module statement, so that the entire module and instances
below it are not traced. below it are not traced.
@ -671,7 +685,7 @@ or "`ifdef`"'s may break other tools.
Used in a statement position to indicate the immediately following loop Used in a statement position to indicate the immediately following loop
at the same statement level should not be unrolled by Verilator, at the same statement level should not be unrolled by Verilator,
ignoring :vlopt:`--unroll-count`. This is similar to clang's ``#pragma ignoring :vlopt:`--unroll-count`. This is similar to clang's ``#pragma
clang loop unroll(disable)``. clang loop unroll(disable)``.
This option does not currently disable the C++ compiler's unrolling (or This option does not currently disable the C++ compiler's unrolling (or
@ -681,5 +695,5 @@ or "`ifdef`"'s may break other tools.
Rarely needed. Used in a statement position to indicate the immediately Rarely needed. Used in a statement position to indicate the immediately
following loop at the same statement level should always be fully following loop at the same statement level should always be fully
unrolled by Verilator, ignoring :vlopt:`--unroll-count`. This is unrolled by Verilator, ignoring :vlopt:`--unroll-count`. This is similar
similar to clang's ``#pragma clang loop unroll(full)``. to clang's ``#pragma clang loop unroll(full)``.

View File

@ -1,4 +1,4 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
****************************** ******************************
@ -13,9 +13,9 @@ Questions
Can I contribute? Can I contribute?
""""""""""""""""" """""""""""""""""
Please contribute! Just submit a pull request, or raise an issue to Please contribute! Just submit a pull request, or raise an issue to discuss
discuss if you are looking for something to help on. For more information if you are looking for something to help on. For more information see our
see our contributor agreement. contributor agreement.
How widely is Verilator used? How widely is Verilator used?
@ -25,10 +25,10 @@ Verilator is used by many of the largest silicon design companies, large
organizations such as CERN, and even by college student projects. organizations such as CERN, and even by college student projects.
Verilator is one of the "big 4" simulators, meaning one of the four leading Verilator is one of the "big 4" simulators, meaning one of the four leading
SystemVerilog simulators available, namely the closed-source products Synopsys SystemVerilog simulators available, namely the closed-source products
VCS (tm), Mentor Questa/ModelSim (tm), Cadence Synopsys VCS (tm), Mentor Questa/ModelSim (tm), Cadence
Xcelium/Incisive/NC-Verilog/NC-Sim (tm), and the open-source Verilator. Xcelium/Incisive/NC-Verilog/NC-Sim (tm), and the open-source Verilator. The
The three closed-source offerings are often collectively called the "big 3" three closed-source offerings are often collectively called the "big 3"
simulators. simulators.
@ -37,7 +37,7 @@ Does Verilator run under Windows?
Yes, ideally, run Ubuntu under Windows Subsystem for Linux (WSL2). Yes, ideally, run Ubuntu under Windows Subsystem for Linux (WSL2).
Alternatively, use Cygwin, though this tends to be slower and is not Alternatively, use Cygwin, though this tends to be slower and is not
regularly tested. Verilated output also compiles under Microsoft Visual regularly tested. Verilated output also compiles under Microsoft Visual
C++, but this is also not regularly tested. C++, but this is also not regularly tested.
@ -46,8 +46,8 @@ Can you provide binaries?
You can install Verilator via the system package manager (apt, yum, etc.) You can install Verilator via the system package manager (apt, yum, etc.)
on many Linux distributions, including Debian, Ubuntu, SuSE, Red Hat, and on many Linux distributions, including Debian, Ubuntu, SuSE, Red Hat, and
others. These packages are provided by the Linux distributions and others. These packages are provided by the Linux distributions and
generally will lag the version of the mainline Verilator repository. If no generally will lag the version of the mainline Verilator repository. If no
binary package is available for your distribution, how about you set one binary package is available for your distribution, how about you set one
up? up?
@ -59,24 +59,25 @@ Generally, the implied part of the question is "... with all of the
manpower they can put into developing it." manpower they can put into developing it."
Most simulators must comply with the complete IEEE 1364 (Verilog) and IEEE Most simulators must comply with the complete IEEE 1364 (Verilog) and IEEE
1800 (SystemVerilog) standards, meaning they have to be event-driven. This 1800 (SystemVerilog) standards, meaning they have to be event-driven. This
prevents them from being able to reorder blocks and make netlist-style prevents them from being able to reorder blocks and make netlist-style
optimizations, which are where most of the gains come from. optimizations, which are where most of the gains come from.
You should not be scared by non-compliance. Your synthesis tool isn't You should not be scared by non-compliance. Your synthesis tool isn't
compliant with the whole standard to start with, so your simulator need not compliant with the whole standard to start with, so your simulator need not
be either. Verilator is closer to the synthesis interpretation, which is be either. Verilator is closer to the synthesis interpretation, which is a
a good thing for getting working silicon. good thing for getting working silicon.
Will Verilator output remain under my own license/copyright? Will Verilator output remain under my own license/copyright?
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""
Your SystemVerilog, VPI/DPI, or main() C++ code remains under your own license. Your SystemVerilog, VPI/DPI, or main() C++ code remains under your own
license.
It's just like how using GCC on your programs does not change the copyright It's just like how using GCC on your programs does not change the copyright
of your program; this is why Verilator uses the "GNU **Lesser** Public of your program; this is why Verilator uses the "GNU **Lesser** Public
License Version 3" instead of the more typical "GNU Public License". See License Version 3" instead of the more typical "GNU Public License". See
the licenses for details. the licenses for details.
Some examples: Some examples:
@ -98,15 +99,15 @@ Some examples:
You also have the option of using the Perl Artistic License, which again You also have the option of using the Perl Artistic License, which again
does not require you to release your Verilog, C++, or generated code. This does not require you to release your Verilog, C++, or generated code. This
license also allows you to modify Verilator for internal use without license also allows you to modify Verilator for internal use without
distributing the modified version. But please contribute back to the distributing the modified version. But please contribute back to the
community! community!
Under both licenses, you can offer a commercial product based on Under both licenses, you can offer a commercial product based on Verilator
Verilator directly or embedded within. However, under both licenses, directly or embedded within. However, under both licenses, any changes you
any changes you make to Verilator for such a product must be open-sourced. make to Verilator for such a product must be open-sourced.
As is standard with Open Source, contributions back to Verilator will be As is standard with Open Source, contributions back to Verilator will be
placed under the Verilator copyright and LGPL/Artistic license. Small test placed under the Verilator copyright and LGPL/Artistic license. Small test
cases will be released into the public domain so they can be used anywhere, cases will be released into the public domain so they can be used anywhere,
and large tests under the LGPL/Artistic, unless requested otherwise. and large tests under the LGPL/Artistic, unless requested otherwise.
@ -114,13 +115,13 @@ and large tests under the LGPL/Artistic, unless requested otherwise.
Why is running Verilator (to create a model) so slow? Why is running Verilator (to create a model) so slow?
""""""""""""""""""""""""""""""""""""""""""""""""""""" """""""""""""""""""""""""""""""""""""""""""""""""""""
Verilator may require more memory than the resulting simulation, Verilator may require more memory than the resulting simulation, as
as Verilator internally creates all of the state of the resulting Verilator internally creates all of the state of the resulting generated
generated simulator to optimize it. If it takes more than a few simulator to optimize it. If it takes more than a few minutes or so (and
minutes or so (and you're not using :vlopt:`--debug` since debug mode is you're not using :vlopt:`--debug` since debug mode is disk bound), see if
disk bound), see if your machine is paging; most likely, you need to run it your machine is paging; most likely, you need to run it on a machine with
on a machine with more memory. Very large designs are known to have topped more memory. Very large designs are known to have topped 64 GB resident set
64 GB resident set size. Alternatively, see :ref:`Hierarchical Verilation`. size. Alternatively, see :ref:`Hierarchical Verilation`.
How do I generate waveforms (traces) in C++? How do I generate waveforms (traces) in C++?
@ -128,16 +129,16 @@ How do I generate waveforms (traces) in C++?
See also the next question for tracing in SystemC mode. See also the next question for tracing in SystemC mode.
A. Pass the :vlopt:`--trace-vcd` option to Verilator. Then you may use ``$dumpfile`` and A. Pass the :vlopt:`--trace-vcd` option to Verilator. Then you may use
``$dumpvars`` to enable traces, the same as with any Verilog simulator, ``$dumpfile`` and ``$dumpvars`` to enable traces, the same as with any
although Verilator ignores the arguments to ``$dumpvars``. See Verilog simulator, although Verilator ignores the arguments to
``examples/make_tracing_c`` in the distribution. ``$dumpvars``. See ``examples/make_tracing_c`` in the distribution.
If writing the top-level C code, call ``Verilated::traceEverOn(true)``; If writing the top-level C code, call ``Verilated::traceEverOn(true)``;
this is done for you if using :vlopt:`--binary`. this is done for you if using :vlopt:`--binary`.
B. Or, for finer-grained control, or C++ files with multiple Verilated B. Or, for finer-grained control, or C++ files with multiple Verilated
modules, you may also create the trace purely from C++. Create a modules, you may also create the trace purely from C++. Create a
VerilatedVcdC object, and in your main loop, right after ``eval()`` call VerilatedVcdC object, and in your main loop, right after ``eval()`` call
``trace_object->dump(contextp->time())`` every time step, and finally ``trace_object->dump(contextp->time())`` every time step, and finally
call ``trace_object->close()``. call ``trace_object->close()``.
@ -166,27 +167,26 @@ B. Or, for finer-grained control, or C++ files with multiple Verilated
You also need to compile :file:`verilated_vcd_c.cpp` and add it to your You also need to compile :file:`verilated_vcd_c.cpp` and add it to your
link, preferably by adding the dependencies in your Makefile's link, preferably by adding the dependencies in your Makefile's
:code:`$(VK_GLOBAL_OBJS)` link rule. This is done for you if you are using ``$(VK_GLOBAL_OBJS)`` link rule. This is done for you if you are using the
the Verilator :vlopt:`--binary` or :vlopt:`--exe` option. Verilator :vlopt:`--binary` or :vlopt:`--exe` option.
you can call :code:`trace_object->trace()` on multiple Verilated objects you can call ``trace_object->trace()`` on multiple Verilated objects with
with the same trace file if you want all data to land in the same output the same trace file if you want all data to land in the same output file.
file.
How do I generate waveforms (traces) in SystemC? How do I generate waveforms (traces) in SystemC?
"""""""""""""""""""""""""""""""""""""""""""""""" """"""""""""""""""""""""""""""""""""""""""""""""
A. Pass the :vlopt:`--trace-vcd` option to Verilator, and in your top-level A. Pass the :vlopt:`--trace-vcd` option to Verilator, and in your top-level
:code:`sc_main()`, call :code:`Verilated::traceEverOn(true)`. Then you ``sc_main()``, call ``Verilated::traceEverOn(true)``. Then you may use
may use :code:`$dumpfile` and code:`$dumpvars` to enable traces, as ``$dumpfile`` and code:`$dumpvars` to enable traces, as with any Verilog
with any Verilog simulator; see the non-SystemC example in simulator; see the non-SystemC example in
:file:`examples/make_tracing_c`. This will trace only the module :file:`examples/make_tracing_c`. This will trace only the module
containing the :code:`$dumpvar`. containing the ``$dumpvar``.
B. Or, you may create a trace purely from SystemC, which may trace all B. Or, you may create a trace purely from SystemC, which may trace all
Verilated designs in the SystemC model. Create a VerilatedVcdSc object Verilated designs in the SystemC model. Create a VerilatedVcdSc object
as you would create a standard SystemC trace file. For an example, see as you would create a standard SystemC trace file. For an example, see
the call to ``VerilatedVcdSc`` in the the call to ``VerilatedVcdSc`` in the
:file:`examples/make_tracing_sc/sc_main.cpp` file of the distribution, :file:`examples/make_tracing_sc/sc_main.cpp` file of the distribution,
and below. and below.
@ -212,57 +212,53 @@ C. Alternatively, you may use the C++ trace mechanism described in the
tfp->close(); tfp->close();
} }
You also need to compile :file:`verilated_vcd_sc.cpp` and You also need to compile :file:`verilated_vcd_sc.cpp` and
:file:`verilated_vcd_c.cpp` and add them to your link, preferably by adding :file:`verilated_vcd_c.cpp` and add them to your link, preferably by adding
the dependencies in your Makefile's :code:`$(VK_GLOBAL_OBJS)` link rule. the dependencies in your Makefile's ``$(VK_GLOBAL_OBJS)`` link rule. This
This is done for you if you are using the Verilator :vlopt:`--binary` or is done for you if you are using the Verilator :vlopt:`--binary` or
:vlopt:`--exe` option. :vlopt:`--exe` option.
You can call :code:`->trace()` on multiple Verilated objects with the same You can call ``->trace()`` on multiple Verilated objects with the same
trace file if you want all data to land in the same output file. trace file if you want all data to land in the same output file.
How do I generate FST waveforms (traces) in C++ or SystemC? How do I generate FST waveforms (traces) in C++ or SystemC?
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" """""""""""""""""""""""""""""""""""""""""""""""""""""""""""
FST is a trace file format developed by GTKWave. Verilator provides basic FST is a trace file format developed by GTKWave. Verilator provides basic
FST support. To dump traces in FST format, add the :vlopt:`--trace-fst` FST support. To dump traces in FST format, add the :vlopt:`--trace-fst`
option to Verilator and either: option to Verilator and either:
Use :code:`$dumpfile & $dumpvars` in Verilog as described in the VCD Use ``$dumpfile & $dumpvars`` in Verilog as described in the VCD example
example above, above,
Or, in C++ change the include described in the VCD example above: Or, in C++ change the include described in the VCD example above:
.. code-block:: C++ .. code-block:: C++
#include "verilated_fst_c.h"
VerilatedFstC* tfp = new VerilatedFstC;
#include "verilated_fst_c.h"
VerilatedFstC* tfp = new VerilatedFstC;
Or, in SystemC, change the include described in the VCD example above: Or, in SystemC, change the include described in the VCD example above:
.. code-block:: C++ .. code-block:: C++
#include "verilated_fst_sc.h"
VerilatedFstC* tfp = new VerilatedFstSc;
#include "verilated_fst_sc.h"
VerilatedFstC* tfp = new VerilatedFstSc;
Currently, supporting FST and VCD in a single simulation is not supported, Currently, supporting FST and VCD in a single simulation is not supported,
but such usage should be unlikely. You can however ifdef around the trace but such usage should be unlikely. You can however ifdef around the trace
format in your C++ main loop, and select VCD or FST at compile time. format in your C++ main loop, and select VCD or FST at compile time.
How do I view waveforms (aka dumps or traces)? How do I view waveforms (aka dumps or traces)?
"""""""""""""""""""""""""""""""""""""""""""""" """"""""""""""""""""""""""""""""""""""""""""""
Verilator creates standard VCD (Value Change Dump) and FST files. VCD Verilator creates standard VCD (Value Change Dump) and FST files. VCD files
files are viewable with the open-source are viewable with the open-source `GTKWave
`GTKWave <https://gtkwave.sourceforge.net/>`_, <https://gtkwave.sourceforge.net/>`_, `Surfer
`Surfer <https://surfer-project.org/>`_, Dinotrace (legacy), or any of the <https://surfer-project.org/>`_, Dinotrace (legacy), or any of the many
many closed-source viewer offerings; FST is supported only by GTKWave and closed-source viewer offerings; FST is supported only by GTKWave and
Surfer. Surfer.
@ -287,24 +283,24 @@ D. You can also consider using FST tracing instead of VCD. FST dumps are a
is prohibitively large. is prohibitively large.
E. Write your trace files to a machine-local solid-state drive instead of a E. Write your trace files to a machine-local solid-state drive instead of a
network drive. Network drives are generally far slower. network drive. Network drives are generally far slower.
Where is the translate_off command? (How do I ignore a construct?) Where is the translate_off command? (How do I ignore a construct?)
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
Translate on/off pragmas are generally a bad idea, as it's easy to have Translate on/off pragmas are generally a bad idea, as it's easy to have
mismatched pairs, and you can't see what another tool sees by just mismatched pairs, and you can't see what another tool sees by just
preprocessing the code. Instead, use the preprocessor; Verilator defines preprocessing the code. Instead, use the preprocessor; Verilator defines
the ``\`VERILATOR`` define for you, so just wrap the code in an ifndef the ``\`VERILATOR`` define for you, so just wrap the code in an ifndef
region: region:
.. code-block:: sv .. code-block:: sv
:emphasize-lines: 1 :emphasize-lines: 1
`ifndef VERILATOR `ifndef VERILATOR
Something_Verilator_Dislikes; Something_Verilator_Dislikes;
`endif `endif
Most synthesis tools similarly define SYNTHESIS for you. Most synthesis tools similarly define SYNTHESIS for you.
@ -312,10 +308,10 @@ Most synthesis tools similarly define SYNTHESIS for you.
Why do I get "unexpected 'do'" or "unexpected 'bit'" errors? Why do I get "unexpected 'do'" or "unexpected 'bit'" errors?
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""
The words \ ``do``\ , \ ``bit``\ , \ ``ref``\ , \ ``return``\ , and others The words ``do``, ``bit``, ``ref``, ``return``, and others are reserved
are reserved keywords in SystemVerilog. Older Verilog code might use these keywords in SystemVerilog. Older Verilog code might use these as
as identifiers, and you should change your code to not use them to ensure it identifiers, and you should change your code to not use them to ensure it
works with newer tools. Alternatively, surround them by the Verilog works with newer tools. Alternatively, surround them by the Verilog
2005/SystemVerilog begin_keywords pragma to indicate Verilog 2001 code. 2005/SystemVerilog begin_keywords pragma to indicate Verilog 2001 code.
.. code-block:: sv .. code-block:: sv
@ -325,7 +321,6 @@ works with newer tools. Alternatively, surround them by the Verilog
integer bit; initial bit = 1; integer bit; initial bit = 1;
`end_keywords `end_keywords
If you want the whole design parsed as Verilog 2001, see the If you want the whole design parsed as Verilog 2001, see the
:vlopt:`--default-language` option. :vlopt:`--default-language` option.
@ -333,8 +328,8 @@ If you want the whole design parsed as Verilog 2001, see the
How do I prevent my assertions from firing during reset? How do I prevent my assertions from firing during reset?
"""""""""""""""""""""""""""""""""""""""""""""""""""""""" """"""""""""""""""""""""""""""""""""""""""""""""""""""""
Call :code:`Verilated::assertOn(false)` before you first call the model, Call ``Verilated::assertOn(false)`` before you first call the model, then
then turn it back on after reset. It defaults to true. When false, all turn it back on after reset. It defaults to true. When false, all
assertions are disabled. assertions are disabled.
@ -342,36 +337,36 @@ Why do I get "undefined reference to sc_time_stamp()?
""""""""""""""""""""""""""""""""""""""""""""""""""""" """""""""""""""""""""""""""""""""""""""""""""""""""""
In Verilator 4.200 and later, using the timeInc function is recommended In Verilator 4.200 and later, using the timeInc function is recommended
instead. See the :ref:`Connecting to C++` examples. Some linkers (MSVC++) instead. See the :ref:`Connecting to C++` examples. Some linkers (MSVC++)
still require :code:`sc_time_stamp()` to be defined; either define this still require ``sc_time_stamp()`` to be defined; either define this with
with :code:`double sc_time_stamp() { return 0; }` or compile the Verilated ``double sc_time_stamp() { return 0; }`` or compile the Verilated code with
code with :code:`-CFLAGS -DVL_TIME_CONTEXT`. ``-CFLAGS -DVL_TIME_CONTEXT``.
Before Verilator 4.200, the :code:`sc_time_stamp()` function needs to be Before Verilator 4.200, the ``sc_time_stamp()`` function needs to be
defined in C++ (non SystemC) to return the current simulation time. defined in C++ (non SystemC) to return the current simulation time.
Why do I get "undefined reference to \`VL_RAND_RESET_I' or \`Verilated::...'"? Why do I get "undefined reference to \`VL_RAND_RESET_I' or \`Verilated::...'"?
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
You need to link your compiled Verilated code against the You need to link your compiled Verilated code against the ``verilated.cpp``
:code:`verilated.cpp` file found in the include directory of the Verilator file found in the include directory of the Verilator kit. This is one
kit. This is one target in the ``$(VK_GLOBAL_OBJS)`` make variable, which target in the ``$(VK_GLOBAL_OBJS)`` make variable, which should be part of
should be part of your Makefile's link rule. If you use :vlopt:`--exe` or your Makefile's link rule. If you use :vlopt:`--exe` or :vlopt:`--binary`,
:vlopt:`--binary`, this is done for you. this is done for you.
Is the PLI supported? Is the PLI supported?
""""""""""""""""""""" """""""""""""""""""""
Only somewhat. More specifically, the common PLI-ish calls $display, Only somewhat. More specifically, the common PLI-ish calls $display,
$finish, $stop, $time, $write are converted to C++ equivalents. You can $finish, $stop, $time, $write are converted to C++ equivalents. You can
also use the "import DPI" SystemVerilog feature to call C code (see the also use the "import DPI" SystemVerilog feature to call C code (see the
chapter above). There is also limited VPI access to public signals. chapter above). There is also limited VPI access to public signals.
If you want something more complex, since Verilator emits standard C++ If you want something more complex, since Verilator emits standard C++
code, you can write C++ routines that can access and modify signal code, you can write C++ routines that can access and modify signal values
values without needing any PLI interface code, and call it with without needing any PLI interface code, and call it with
$c("{any_c++_statement}"). $c("{any_c++_statement}").
See the :ref:`Connecting` section. See the :ref:`Connecting` section.
@ -380,8 +375,8 @@ See the :ref:`Connecting` section.
How do I make a Verilog module that contains a C++ object? How do I make a Verilog module that contains a C++ object?
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""" """"""""""""""""""""""""""""""""""""""""""""""""""""""""""
You need to add the object to the structure Verilator creates, then You need to add the object to the structure Verilator creates, then use $c
use $c to call a method inside your object. The to call a method inside your object. The
:file:`test_regress/t/t_extend_class` files in the distribution show an :file:`test_regress/t/t_extend_class` files in the distribution show an
example of how to do this. example of how to do this.
@ -399,17 +394,17 @@ How do I get faster build times?
disabled on these routines. See the OPT_FAST and OPT_SLOW make variables disabled on these routines. See the OPT_FAST and OPT_SLOW make variables
and :ref:`Benchmarking & Optimization`. and :ref:`Benchmarking & Optimization`.
* Use a recent compiler. Newer compilers tend to be faster. * Use a recent compiler. Newer compilers tend to be faster.
* Compile in parallel on many machines and use caching; see the web for the * Compile in parallel on many machines and use caching; see the web for the
ccache, sccache, distcc, or icecream packages. ccache will skip GCC runs between ccache, sccache, distcc, or icecream packages. ccache will skip GCC runs
identical source builds, even across different users. If ccache was between identical source builds, even across different users. If ccache
installed when Verilator was built, it is used, or see OBJCACHE was installed when Verilator was built, it is used, or see OBJCACHE
environment variable to override this. Also see the environment variable to override this. Also see the
:vlopt:`--output-split` option and :ref: `Profiling ccache efficiency`. :vlopt:`--output-split` option and :ref: `Profiling ccache efficiency`.
* To reduce the compile time of classes that use a Verilated module (e.g., a * To reduce the compile time of classes that use a Verilated module (e.g.,
top CPP file) you may wish to add a a top CPP file) you may wish to add a
:option:`/*verilator&32;no_inline_module*/` metacomment to your top-level :option:`/*verilator&32;no_inline_module*/` metacomment to your top-level
module. This will decrease the amount of code in the model's Verilated module. This will decrease the amount of code in the model's Verilated
class, improving compile times of any instantiating top-level C++ code, class, improving compile times of any instantiating top-level C++ code,
@ -421,27 +416,27 @@ How do I get faster build times?
Why do so many files need to recompile when I add a signal? Why do so many files need to recompile when I add a signal?
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" """""""""""""""""""""""""""""""""""""""""""""""""""""""""""
Adding a new signal requires the symbol table to be recompiled. Verilator Adding a new signal requires the symbol table to be recompiled. Verilator
uses one large symbol table, resulting in 2-3 fewer assembly uses one large symbol table, resulting in 2-3 fewer assembly instructions
instructions for each signal access. This makes the execution time 10-15% for each signal access. This makes the execution time 10-15% faster, but
faster, but can result in more compilations when something changes. can result in more compilations when something changes.
How do I access Verilog functions/tasks in C? How do I access Verilog functions/tasks in C?
""""""""""""""""""""""""""""""""""""""""""""" """""""""""""""""""""""""""""""""""""""""""""
Use the SystemVerilog Direct Programming Interface. You write a Verilog Use the SystemVerilog Direct Programming Interface. You write a Verilog
function or task with input/outputs that match what you want to call in function or task with input/outputs that match what you want to call in
with C. Then mark that function as a DPI export function. See the DPI with C. Then mark that function as a DPI export function. See the DPI
chapter in the IEEE Standard. chapter in the IEEE Standard.
How do I access C++ functions/tasks in Verilog? How do I access C++ functions/tasks in Verilog?
""""""""""""""""""""""""""""""""""""""""""""""" """""""""""""""""""""""""""""""""""""""""""""""
Use the SystemVerilog Direct Programming Interface. You write a Verilog Use the SystemVerilog Direct Programming Interface. You write a Verilog
function or task with input/outputs that match what you want to call in function or task with input/outputs that match what you want to call in
with C. Then mark that function as a DPI import function. See the DPI with C. Then mark that function as a DPI import function. See the DPI
chapter in the IEEE Standard. chapter in the IEEE Standard.
@ -450,44 +445,43 @@ How do I access signals in C?
The best thing to do is to make a SystemVerilog "export DPI" task or The best thing to do is to make a SystemVerilog "export DPI" task or
function that accesses that signal, as described in the DPI chapter in the function that accesses that signal, as described in the DPI chapter in the
manual and DPI tutorials on the web. This will allow Verilator to manual and DPI tutorials on the web. This will allow Verilator to optimize
optimize the model better and should be portable across simulators. the model better and should be portable across simulators.
If you really want raw access to the signals, declare the signals you will If you really want raw access to the signals, declare the signals you will
be accessing with a :option:`/*verilator&32;public*/` metacomment before be accessing with a :option:`/*verilator&32;public*/` metacomment before
the closing semicolon. Then scope into the C++ class to read the value of the closing semicolon. Then scope into the C++ class to read the value of
the signal, as you would any other member variable. the signal, as you would any other member variable.
Signals are the smallest of 8-bit unsigned chars (equivalent to uint8_t), Signals are the smallest of 8-bit unsigned chars (equivalent to uint8_t),
16-bit unsigned shorts (uint16_t), 32-bit unsigned longs (uint32_t), or 16-bit unsigned shorts (uint16_t), 32-bit unsigned longs (uint32_t), or
64-bit unsigned long longs (uint64_t) that fit the width of the signal. 64-bit unsigned long longs (uint64_t) that fit the width of the signal.
Generally, you can use just uint32_t's for 1 to 32 bits, or uint64_t for Generally, you can use just uint32_t's for 1 to 32 bits, or uint64_t for 1
1 to 64 bits, and the compiler will properly up-convert smaller entities. to 64 bits, and the compiler will properly up-convert smaller entities.
Note that even signed ports are declared as unsigned; you must sign extend Note that even signed ports are declared as unsigned; you must sign extend
yourself to the appropriate signal width. yourself to the appropriate signal width.
Signals wider than 64 bits are stored as an array of 32-bit uint32_t's. Signals wider than 64 bits are stored as an array of 32-bit uint32_t's.
Thus, to read bits 31:0, access signal[0], and for bits 63:32, access Thus, to read bits 31:0, access signal[0], and for bits 63:32, access
signal[1]. Unused bits (for example, bit numbers 65-96 of a 65-bit vector) signal[1]. Unused bits (for example, bit numbers 65-96 of a 65-bit vector)
will always be zero. If you change the value, you must pack will always be zero. If you change the value, you must pack zeros in the
zeros in the unused bits, or core-dumps may result because Verilator strips unused bits, or core-dumps may result because Verilator strips array bound
array bound checks where it believes them to be unnecessary to improve checks where it believes them to be unnecessary to improve performance.
performance.
In the SYSTEMC example above, if you had in our.v: In the SYSTEMC example above, if you had in our.v:
.. code-block:: sv .. code-block:: sv
input clk /*verilator public*/; input clk /*verilator public*/;
// Note the placement of the semicolon above // Note the placement of the semicolon above
From the sc_main.cpp file, you'd then: From the sc_main.cpp file, you'd then:
.. code-block:: C++ .. code-block:: C++
#include "Vour.h" #include "Vour.h"
#include "Vour_our.h" #include "Vour_our.h"
std::cout << "clock is " << top->our->clk << std::endl; std::cout << "clock is " << top->our->clk << std::endl;
In this example, clk is a bool you can read or set as any other variable. In this example, clk is a bool you can read or set as any other variable.
@ -498,11 +492,11 @@ clocks, or you'll get strange results.
Should a module be in Verilog or SystemC? Should a module be in Verilog or SystemC?
""""""""""""""""""""""""""""""""""""""""" """""""""""""""""""""""""""""""""""""""""
Sometimes there is a block that only interconnects instances, and you have a Sometimes there is a block that only interconnects instances, and you have
choice if you write it in Verilog or SystemC. Everything else being a choice if you write it in Verilog or SystemC. Everything else being
equal, the best performance is when Verilator sees all of the design. So, look equal, the best performance is when Verilator sees all of the design. So,
at the hierarchy of your design, labeling instances as to if they are look at the hierarchy of your design, labeling instances as to if they are
SystemC or Verilog. Then: SystemC or Verilog. Then:
* A module with only SystemC instances below must be SystemC. * A module with only SystemC instances below must be SystemC.
@ -510,7 +504,7 @@ SystemC or Verilog. Then:
SystemC. (As Verilator cannot connect to lower-level SystemC instances.) SystemC. (As Verilator cannot connect to lower-level SystemC instances.)
* A module with only Verilog instances below can be either, but for best * A module with only Verilog instances below can be either, but for best
performance should be Verilog. (The exception is if you have a design performance should be Verilog. (The exception is if you have a design
that is instantiated many times; in this case, Verilating one of the lower that is instantiated many times; in this case, Verilating one of the
modules and instantiating that Verilated instances multiple times into a lower modules and instantiating that Verilated instances multiple times
SystemC module *may* be faster.) into a SystemC module *may* be faster.)

View File

@ -1,11 +1,11 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
***** *****
Files Files
***** *****
.. _Files in the Distribution: .. _files in the distribution:
Files in the Git Tree Files in the Git Tree
===================== =====================
@ -28,7 +28,7 @@ Verilator:
test_regress => Internal tests test_regress => Internal tests
.. _Files Read/Written: .. _files read/written:
Files Read/Written Files Read/Written
================== ==================
@ -42,33 +42,33 @@ For --cc/--sc, it creates:
.. list-table:: .. list-table::
* - *{prefix}*\ .json * - *{prefix}*.json
- JSON build definition compiling (from --make json) - JSON build definition compiling (from --make json)
* - *{prefix}*\ .mk * - *{prefix}*.mk
- Make include file for compiling (from --make gmake) - Make include file for compiling (from --make gmake)
* - *{prefix}*\ _classes.mk * - *{prefix}*\ _classes.mk
- Make include file with class names (from --make gmake) - Make include file with class names (from --make gmake)
* - *{prefix}*\ .h * - *{prefix}*.h
- Model header - Model header
* - *{prefix}*\ .cpp * - *{prefix}*.cpp
- Model C++ file - Model C++ file
* - *{prefix}*\ ___024root.h * - *{prefix}*\ ___024root.h
- Top-level internal header file (from SystemVerilog $root) - Top-level internal header file (from SystemVerilog $root)
* - *{prefix}*\ ___024root.cpp * - *{prefix}*\ ___024root.cpp
- Top-level internal C++ file (from SystemVerilog $root) - Top-level internal C++ file (from SystemVerilog $root)
* - *{prefix}*\ ___024root\ *{__n}*\ .cpp * - *{prefix}*\ ___024root\ *{__n}*.cpp
- Additional top-level internal C++ files - Additional top-level internal C++ files
* - *{prefix}*\ ___024root__Slow\ *{__n}*\ .cpp * - *{prefix}*\ ___024root__Slow\ *{__n}*.cpp
- Infrequent cold routines - Infrequent cold routines
* - *{prefix}*\ ___024root__Trace\ *{__n}*\ .cpp * - *{prefix}*\ ___024root__Trace\ *{__n}*.cpp
- Wave file generation code (from --trace-\*) - Wave file generation code (from --trace-\*)
* - *{prefix}*\ ___024root__Trace__Slow\ *{__n}*\ .cpp * - *{prefix}*\ ___024root__Trace__Slow\ *{__n}*.cpp
- Wave file generation code (from --trace-\*) - Wave file generation code (from --trace-\*)
* - *{prefix}*\ __Dpi.h * - *{prefix}*\ __Dpi.h
- DPI import and export declarations (from --dpi) - DPI import and export declarations (from --dpi)
* - *{prefix}*\ __Dpi.cpp * - *{prefix}*\ __Dpi.cpp
- Global DPI export wrappers (from --dpi) - Global DPI export wrappers (from --dpi)
* - *{prefix}*\ __Dpi_Export\ *{__n}*\ .cpp * - *{prefix}*\ __Dpi_Export\ *{__n}*.cpp
- DPI export wrappers scoped to this particular model (from --dpi) - DPI export wrappers scoped to this particular model (from --dpi)
* - *{prefix}*\ __Inlines.h * - *{prefix}*\ __Inlines.h
- Inline support functions - Inline support functions
@ -76,11 +76,11 @@ For --cc/--sc, it creates:
- Global symbol table header - Global symbol table header
* - *{prefix}*\ __Syms.cpp * - *{prefix}*\ __Syms.cpp
- Global symbol table C++ - Global symbol table C++
* - *{prefix}{each_verilog_module}*\ .h * - *{prefix}{each_verilog_module}*.h
- Lower level internal header files - Lower level internal header files
* - *{prefix}{each_verilog_module}*\ .cpp * - *{prefix}{each_verilog_module}*.cpp
- Lower level internal C++ files - Lower level internal C++ files
* - *{prefix}{each_verilog_module}{__n}*\ .cpp * - *{prefix}{each_verilog_module}{__n}*.cpp
- Additional lower C++ files - Additional lower C++ files
For --hierarchical mode, it creates: For --hierarchical mode, it creates:
@ -106,13 +106,13 @@ In specific debug and other modes, it also creates:
.. list-table:: .. list-table::
* - *{prefix}*\ .sarif * - *{prefix}*.sarif
- SARIF diagnostics (from --diagnostics-sarif) - SARIF diagnostics (from --diagnostics-sarif)
* - *{prefix}*\ .tree.json * - *{prefix}*.tree.json
- JSON tree information (from --json-only) - JSON tree information (from --json-only)
* - *{prefix}*\ .tree.meta.json * - *{prefix}*.tree.meta.json
- JSON tree metadata (from --json-only) - JSON tree metadata (from --json-only)
* - *{prefix}*\ .xml * - *{prefix}*.xml
- XML tree information (from --xml) - XML tree information (from --xml)
* - *{prefix}*\ __cdc.txt * - *{prefix}*\ __cdc.txt
- Clock Domain Crossing checks (from --cdc) - Clock Domain Crossing checks (from --cdc)
@ -124,30 +124,30 @@ In specific debug and other modes, it also creates:
- Make dependencies (from -MMD) - Make dependencies (from -MMD)
* - *{prefix}*\ __verFiles.dat * - *{prefix}*\ __verFiles.dat
- Timestamps (from --skip-identical) - Timestamps (from --skip-identical)
* - *{prefix}{misc}*\ .dot * - *{prefix}{misc}*.dot
- Debugging graph files (from --debug) - Debugging graph files (from --debug)
* - *{prefix}{misc}*\ .tree * - *{prefix}{misc}*.tree
- Debugging files (from --debug) - Debugging files (from --debug)
* - *{prefix}*\ __inputs\ .vpp * - *{prefix}*\ __inputs.vpp
- Pre-processed verilog for all files (from --debug) - Pre-processed verilog for all files (from --debug)
* - *{prefix}*\ _ *{each_verilog_base_filename}*\ .vpp * - *{prefix}*\ _ *{each_verilog_base_filename}*.vpp
- Pre-processed verilog for each file (from --debug) - Pre-processed verilog for each file (from --debug)
After running Make, the C++ compiler may produce the following: After running Make, the C++ compiler may produce the following:
.. list-table:: .. list-table::
* - verilated{misc}*\ .d * - verilated{misc}*.d
- Intermediate dependencies - Intermediate dependencies
* - verilated{misc}*\ .o * - verilated{misc}*.o
- Intermediate objects - Intermediate objects
* - {mod_prefix}{misc}*\ .d * - {mod_prefix}{misc}*.d
- Intermediate dependencies - Intermediate dependencies
* - {mod_prefix}{misc}*\ .o * - {mod_prefix}{misc}*.o
- Intermediate objects - Intermediate objects
* - *{prefix}*\ * - *{prefix}*\
- Final executable (from --exe) - Final executable (from --exe)
* - lib\ *{prefix}*\ .a * - lib\ *{prefix}*.a
- Final archive (default lib mode) - Final archive (default lib mode)
* - libverilated.a * - libverilated.a
- Runtime for verilated model (default lib mode) - Runtime for verilated model (default lib mode)
@ -155,9 +155,9 @@ After running Make, the C++ compiler may produce the following:
- Library of all Verilated objects - Library of all Verilated objects
* - *{prefix}*\ __ALL.cpp * - *{prefix}*\ __ALL.cpp
- Include of all code for single compile - Include of all code for single compile
* - *{prefix}{misc}*\ .d * - *{prefix}{misc}*.d
- Intermediate dependencies - Intermediate dependencies
* - *{prefix}{misc}*\ .o * - *{prefix}{misc}*.o
- Intermediate objects - Intermediate objects
The Verilated executable may produce the following: The Verilated executable may produce the following:

View File

@ -1,4 +1,4 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
###################### ######################

View File

@ -1,36 +1,43 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
.. _CMakeInstallation: .. _cmakeinstallation:
****************** ******************
CMake Installation CMake Installation
****************** ******************
This section discusses how to build and install Verilator using cmake. This section discusses how to build and install Verilator using cmake.
Currently cmake is only officially supported for Windows builds (not Linux). Currently cmake is only officially supported for Windows builds (not
Linux).
.. _Tools Install: .. _tools install:
Quick Install Quick Install
============= =============
1. Install Python for your platform from https://www.python.org/downloads/. 1. Install Python for your platform from https://www.python.org/downloads/.
2. Install CMake for your platform from https://cmake.org/download/ or build it from source. 2. Install CMake for your platform from https://cmake.org/download/ or
3. If the compiler of your choice is MSVC, then install https://visualstudio.microsoft.com/downloads/. build it from source.
If the compiler of your choice is Clang, then install https://releases.llvm.org/download.html or build it from source. 3. If the compiler of your choice is MSVC, then install
4. For flex and bison use https://github.com/lexxmark/winflexbison to build and install. https://visualstudio.microsoft.com/downloads/. If the compiler of your
5. For build on Windows using MSVC set environment variable WIN_FLEX_BISON to install directory. choice is Clang, then install https://releases.llvm.org/download.html or
For build on Windows/Linux/OS-X using ninja set the environment variable build it from source.
FLEX_INCLUDE to the directory containing FlexLexer.h and ensure that flex/bison 4. For flex and bison use https://github.com/lexxmark/winflexbison to build
is available within the PATH. and install.
5. For build on Windows using MSVC set environment variable WIN_FLEX_BISON
to install directory. For build on Windows/Linux/OS-X using ninja set
the environment variable FLEX_INCLUDE to the directory containing
FlexLexer.h and ensure that flex/bison is available within the PATH.
To obtain verilator sources download https://github.com/verilator/verilator/archive/refs/heads/master.zip To obtain Verilator sources download
or clone https://github.com/verilator/verilator using git :ref:`Obtain Sources`. https://github.com/verilator/verilator/archive/refs/heads/master.zip or
clone https://github.com/verilator/verilator using git :ref:`Obtain
Sources`.
To build using MSVC: To build using MSVC:
:: .. code-block:: bash
cd verilator # directory containing source files of verilator cd verilator # directory containing source files of verilator
mkdir build mkdir build
@ -38,19 +45,18 @@ To build using MSVC:
cmake --build . --config Release cmake --build . --config Release
cmake --install . --prefix $PWD/../install cmake --install . --prefix $PWD/../install
To build using ninja: To build using ninja:
:: .. code-block:: bash
cd verilator cd verilator
mkdir build mkdir build
cmake -G Ninja .. -DCMAKE_BUILD_TYPE=Release --install-prefix $PWD/../install -DCMAKE_MAKE_PROGRAM=<path to ninja binary> -DBISON_EXECUTABLE=<path to bison> -DFLEX_EXECUTABLE=<path to flex> cmake -G Ninja .. -DCMAKE_BUILD_TYPE=Release --install-prefix $PWD/../install -DCMAKE_MAKE_PROGRAM=<path to ninja binary> -DBISON_EXECUTABLE=<path to bison> -DFLEX_EXECUTABLE=<path to flex>
<path to ninja binary> #execute ninja <path to ninja binary> #execute ninja
cmake --install . --prefix $PWD/../install cmake --install . --prefix $PWD/../install
.. _CMake Usage: .. _cmake usage:
Usage Usage
===== =====
@ -61,12 +67,12 @@ install directory specified in the above build.
Example Example
======= =======
:: .. code-block:: bash
cd verilator/examples cd verilator/examples
cd cmake_hello_c cd cmake_hello_c
mkdir build mkdir build
cd build cd build
cmake .. # cmake -G Ninja .. cmake .. # cmake -G Ninja ..
cmake --build . --config Release # ninja cmake --build . --config Release # ninja
# execute the generated binary # execute the generated binary

View File

@ -1,7 +1,7 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
.. _Installation: .. _installation:
************ ************
Installation Installation
@ -9,15 +9,15 @@ Installation
This section discusses how to install Verilator. This section discusses how to install Verilator.
.. _Package Manager Quick Install: .. _package manager quick install:
Package Manager Quick Install Package Manager Quick Install
============================= =============================
Using a distribution's package manager is the easiest way to get Using a distribution's package manager is the easiest way to get started.
started. (Note distribution packages almost never have the most recent (Note distribution packages almost never have the most recent Verilator
Verilator version, so we recommend following :ref:`Git Install` below, version, so we recommend following :ref:`Git Install` below, instead.) To
instead.) To install as a package: install as a package:
.. code-block:: bash .. code-block:: bash
@ -26,17 +26,18 @@ instead.) To install as a package:
For other distributions, refer to `Repology Verilator Distro Packages For other distributions, refer to `Repology Verilator Distro Packages
<https://repology.org/project/verilator>`__. <https://repology.org/project/verilator>`__.
.. _pre-commit Quick Install: .. _pre-commit quick install:
pre-commit Quick Install Pre-commit Quick Install
============================= ========================
You can use Verilator's `pre-commit <https://pre-commit.com/>`__ hook to You can use Verilator's `pre-commit <https://pre-commit.com/>`__ hook to
lint your code before committing it. It encapsulates the :ref:`Verilator lint your code before committing it. It encapsulates the :ref:`Verilator
Build Docker Container`, so you need docker on your system to use it. The Build Docker Container`, so you need docker on your system to use it. The
verilator image will be downloaded automatically. verilator image will be downloaded automatically.
To use the hook, add the following entry to your :code:`.pre-commit-config.yaml`: To use the hook, add the following entry to your
``.pre-commit-config.yaml``:
.. code-block:: yaml .. code-block:: yaml
@ -46,7 +47,7 @@ To use the hook, add the following entry to your :code:`.pre-commit-config.yaml`
hooks: hooks:
- id: verilator - id: verilator
.. _Git Install: .. _git install:
Git Quick Install Git Quick Install
================= =================
@ -83,7 +84,7 @@ In brief, to install from git:
sudo make install sudo make install
.. _Detailed Build Instructions: .. _detailed build instructions:
Detailed Build Instructions Detailed Build Instructions
=========================== ===========================
@ -129,15 +130,15 @@ For constraints:
sudo apt-get install z3 # Optional solver sudo apt-get install z3 # Optional solver
The following is optional but is recommended for nicely rendered command line The following is optional but is recommended for nicely rendered command
help when running Verilator: line help when running Verilator:
.. code-block:: bash .. code-block:: bash
sudo apt-get install perl-doc sudo apt-get install perl-doc
To build or run Verilator, the following are optional but should be installed To build or run Verilator, the following are optional but should be
for good performance: installed for good performance:
.. code-block:: bash .. code-block:: bash
@ -152,22 +153,37 @@ need to be present to run Verilator:
sudo apt-get install git autoconf flex bison sudo apt-get install git autoconf flex bison
Those developing Verilator itself also need these (see internals.rst): Those developing Verilator itself also need the following additional
packages (see internals.rst), and a Python virtual environment:
.. code-block:: bash .. code-block:: bash
sudo apt-get install clang clang-format-18 cmake gdb gprof graphviz lcov sudo apt-get install clang clang-format-18 cmake gdb gprof graphviz lcov
sudo apt-get install python3-clang python3-distro pipx yapf3 bear jq sudo apt-get install python3-clang bear jq
python3 -m venv --system-site-packages ~/.verilator_pyenv
source ~/.verilator_pyenv/bin/activate
pip3 install sphinx sphinx_rtd_theme sphinxcontrib-spelling breathe gersemi mbake mypy ruff
pip3 install git+https://github.com/antmicro/astsee.git
pipx install sarif-tools
cpan install Pod::Perldoc cpan install Pod::Perldoc
#
# Later, when building or testing Verilator, you will need
source ~/.verilator_pyenv/bin/activate
The Python virtual environment is only required for running the whole test
suite, and for additional development steps like linting and formatting. It
is not required for building Verilator itself. To install the python
virtual environment and all dependencies automatically, run the following
once, after ``configure``:
.. code-block:: bash
# Create Python virutal environment in .venv:
make venv
# Or alternatively, to put it somewhere else:
make venv VENV_PATH=where_you_want_it
Then activate the virtual environment in the shell using:
.. code-block:: bash
source .venv/bin/activate
# Or if installed somewhere else:
source where_you_want_it/bin/activate
Install SystemC Install SystemC
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
@ -176,7 +192,7 @@ SystemC code can be generated from Verilator (with :vlopt:`--sc`) if it is
installed as a package (see above). installed as a package (see above).
Alternatively, from their sources, download `SystemC Alternatively, from their sources, download `SystemC
<https://www.accellera.org/downloads/standards/systemc>`__. Follow their <https://www.accellera.org/downloads/standards/systemc>`__. Follow their
installation instructions. You will need to set the installation instructions. You will need to set the
:option:`SYSTEMC_INCLUDE` environment variable to point to the include :option:`SYSTEMC_INCLUDE` environment variable to point to the include
directory with ``systemc.h`` in it, and set the :option:`SYSTEMC_LIBDIR` directory with ``systemc.h`` in it, and set the :option:`SYSTEMC_LIBDIR`
@ -192,21 +208,21 @@ required at Verilator build time.
.. code-block:: bash .. code-block:: bash
sudo apt-get install gtkwave # Optional Waveform viewer sudo apt-get install gtkwave # Optional Waveform viewer
Install Z3 Install Z3
^^^^^^^^^^ ^^^^^^^^^^
In order to use constrained randomization the `Z3 Theorem Prover In order to use constrained randomization the `Z3 Theorem Prover
<https://github.com/z3prover/z3>`__ must be installed, however this is <https://github.com/z3prover/z3>`__ must be installed, however this is not
not required at Verilator build time. There are other compatible SMT solvers, required at Verilator build time. There are other compatible SMT solvers,
like CVC5/CVC4, but they are not guaranteed to work. Since different solvers are like CVC5/CVC4, but they are not guaranteed to work. Since different
faster for different scenarios, the solver to use at run-time can be specified solvers are faster for different scenarios, the solver to use at run-time
by the environment variable :option:`VERILATOR_SOLVER`. can be specified by the environment variable :option:`VERILATOR_SOLVER`.
.. _Obtain Sources: .. _obtain sources:
Obtain Sources Obtain Sources
-------------- --------------
@ -269,7 +285,7 @@ co-exist on a system.
./configure ./configure
# Running will use files from $VERILATOR_ROOT, so no install needed # Running will use files from $VERILATOR_ROOT, so no install needed
Note after installing (see `Installation`_), a calling program or shell Note after installing (see ref:`Installation`), a calling program or shell
must set the environment variable :option:`VERILATOR_ROOT` to point to this must set the environment variable :option:`VERILATOR_ROOT` to point to this
Git directory, then execute ``$VERILATOR_ROOT/bin/verilator``, which will Git directory, then execute ``$VERILATOR_ROOT/bin/verilator``, which will
find the path to all needed files. find the path to all needed files.
@ -281,7 +297,7 @@ find the path to all needed files.
You may be an OS package maintainer building a Verilator package, or you You may be an OS package maintainer building a Verilator package, or you
may eventually be installing onto a project/company-wide "CAD" tools disk may eventually be installing onto a project/company-wide "CAD" tools disk
that may support multiple versions of every tool. Tell configure the that may support multiple versions of every tool. Tell configure the
eventual destination directory name. We recommend that the destination eventual destination directory name. We recommend that the destination
location include the Verilator version name: location include the Verilator version name:
.. code-block:: bash .. code-block:: bash
@ -291,7 +307,7 @@ location include the Verilator version name:
# For the tarball, use the version number instead of git describe # For the tarball, use the version number instead of git describe
./configure --prefix /CAD_DISK/verilator/`git describe | sed "s/verilator_//"` ./configure --prefix /CAD_DISK/verilator/`git describe | sed "s/verilator_//"`
Note after installing (see `Installation`_), you need to add the path to Note after installing (see ref:`Installation`), you need to add the path to
the ``bin`` directory to your ``PATH``. Or, if you use `modulecmd the ``bin`` directory to your ``PATH``. Or, if you use `modulecmd
<https://modules.sourceforge.net/>`__, you'll want a module file like the <https://modules.sourceforge.net/>`__, you'll want a module file like the
following: following:
@ -317,7 +333,7 @@ configure's default system paths:
unsetenv VERILATOR_ROOT # if your shell is csh unsetenv VERILATOR_ROOT # if your shell is csh
./configure ./configure
Then after installing (see `Installation`_), the binaries should be in a Then after installing (see ref:`Installation`), the binaries should be in a
location already in your ``$PATH`` environment variable. location already in your ``$PATH`` environment variable.

View File

@ -1,11 +1,11 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
*************** ***************
Input Languages Input Languages
*************** ***************
This section describes the languages Verilator takes as input. See also This section describes the languages Verilator takes as input. See also
:ref:`Verilator Control Files`. :ref:`Verilator Control Files`.
@ -15,7 +15,7 @@ Language Standard Support
Verilog 2001 (IEEE 1364-2001) Support Verilog 2001 (IEEE 1364-2001) Support
------------------------------------- -------------------------------------
Verilator supports most Verilog 2001 language features. This includes Verilator supports most Verilog 2001 language features. This includes
signed numbers, "always @\*", generate statements, multidimensional arrays, signed numbers, "always @\*", generate statements, multidimensional arrays,
localparam, and C-style declarations inside port lists. localparam, and C-style declarations inside port lists.
@ -23,7 +23,7 @@ localparam, and C-style declarations inside port lists.
Verilog 2005 (IEEE 1364-2005) Support Verilog 2005 (IEEE 1364-2005) Support
------------------------------------- -------------------------------------
Verilator supports most Verilog 2005 language features. This includes the Verilator supports most Verilog 2005 language features. This includes the
\`begin_keywords and \`end_keywords compiler directives, $clog2, and the \`begin_keywords and \`end_keywords compiler directives, $clog2, and the
uwire keyword. uwire keyword.
@ -77,8 +77,8 @@ Verilog AMS Support
Verilator implements a very small subset of Verilog AMS (Verilog Analog and Verilator implements a very small subset of Verilog AMS (Verilog Analog and
Mixed-Signal Extensions) with the subset corresponding to those VMS Mixed-Signal Extensions) with the subset corresponding to those VMS
keywords with near-equivalents in Verilog IEEE 1364 or SystemVerilog keywords with near-equivalents in Verilog IEEE 1364 or SystemVerilog IEEE
IEEE 1800. 1800.
AMS parsing is enabled with :vlopt:`--language VAMS <--language>` or AMS parsing is enabled with :vlopt:`--language VAMS <--language>` or
:vlopt:`--language 1800+VAMS <--language>`. :vlopt:`--language 1800+VAMS <--language>`.
@ -90,10 +90,9 @@ wreal.
Synthesis Directive Assertion Support Synthesis Directive Assertion Support
------------------------------------- -------------------------------------
Verilator reads any :code:`//synopsys full_case` or :code:`//synopsys Verilator reads any ``//synopsys full_case`` or ``//synopsys
parallel_case` directives. The same applies to any :code:`//ambit parallel_case`` directives. The same applies to any ``//ambit synthesis``,
synthesis`, :code:`//cadence` or :code:`//pragma` directives of the same ``//cadence`` or ``//pragma`` directives of the same form.
form.
When these synthesis directives are discovered, unless When these synthesis directives are discovered, unless
:vlopt:`--no-assert-case` option is used, Verilator will either formally :vlopt:`--no-assert-case` option is used, Verilator will either formally
@ -102,7 +101,7 @@ appropriate code to detect failing cases at simulation runtime and print an
"Assertion failed" error message. "Assertion failed" error message.
Verilator likewise also asserts any "unique" or "priority" SystemVerilog Verilator likewise also asserts any "unique" or "priority" SystemVerilog
keywords on case statements, as well as "unique" on if statements. However, keywords on case statements, as well as "unique" on if statements. However,
"priority if" is currently ignored. "priority if" is currently ignored.
@ -115,17 +114,17 @@ With :vlopt:`--timing`, all timing controls are supported:
* event control statements not only at the top of a process, * event control statements not only at the top of a process,
* intra-assignment timing controls, * intra-assignment timing controls,
* net delays, * net delays,
* :code:`wait` statements, * ``wait`` statements,
as well as all flavors of :code:`fork`. as well as all flavors of ``fork``.
Compiling a Verilated design that uses these features requires a Compiling a Verilated design that uses these features requires a compiler
compiler with C++20 coroutine support, e.g. Clang 5, GCC 10, or newer. with C++20 coroutine support, e.g. Clang 5, GCC 10, or newer.
:code:`#0` delays cause Verilator to issue the :option:`ZERODLY` warning, as ``#0`` delays cause Verilator to issue the :option:`ZERODLY` warning, as
they work differently than described in the LRM. They do not schedule process they work differently than described in the LRM. They do not schedule
resumption in the Inactive region, though the process will get resumed in the process resumption in the Inactive region, though the process will get
same time slot. resumed in the same time slot.
Rising/falling/turn-off delays are currently unsupported and cause the Rising/falling/turn-off delays are currently unsupported and cause the
:option:`RISEFALLDLY` warning. :option:`RISEFALLDLY` warning.
@ -135,8 +134,8 @@ is always the one chosen. Such expressions cause the :option:`MINTYPMAXDLY`
warning. warning.
Another consequence of using :vlopt:`--timing` is that the :vlopt:`--main` Another consequence of using :vlopt:`--timing` is that the :vlopt:`--main`
option generates a main file with a proper timing eval loop, eliminating the option generates a main file with a proper timing eval loop, eliminating
need for writing any driving C++ code. You can simply compile the the need for writing any driving C++ code. You can simply compile the
simulation (perhaps using :vlopt:`--build`) and run it. simulation (perhaps using :vlopt:`--build`) and run it.
With :vlopt:`--no-timing`, all timing controls cause the :option:`NOTIMING` With :vlopt:`--no-timing`, all timing controls cause the :option:`NOTIMING`
@ -144,15 +143,15 @@ error, except:
* delay statements - they are ignored (as they are in synthesis), though they * delay statements - they are ignored (as they are in synthesis), though they
do issue a :option:`STMTDLY` warning, do issue a :option:`STMTDLY` warning,
* intra-assignment timing controls - they are ignored, though they do issue an * intra-assignment timing controls - they are ignored, though they do issue
:option:`ASSIGNDLY` warning, an :option:`ASSIGNDLY` warning,
* net delays - they are ignored, * net delays - they are ignored,
* event controls at the top of the procedure, * event controls at the top of the procedure,
Forks cause this error as well, except: Forks cause this error as well, except:
* forks with no statements, * forks with no statements,
* :code:`fork..join` or :code:`fork..join_any` with one statement, * ``fork..join`` or ``fork..join_any`` with one statement,
* forks with :vlopt:`--bbox-unsup`. * forks with :vlopt:`--bbox-unsup`.
If neither :vlopt:`--timing` nor :vlopt:`--no-timing` is specified, all If neither :vlopt:`--timing` nor :vlopt:`--no-timing` is specified, all
@ -160,19 +159,19 @@ timing controls cause the :option:`NEEDTIMINGOPT` error, except event
controls at the top of the process. Forks cause this error as well, except: controls at the top of the process. Forks cause this error as well, except:
* forks with no statements, * forks with no statements,
* :code:`fork..join` or :code:`fork..join_any` with one statement, * ``fork..join`` or ``fork..join_any`` with one statement,
* forks with :vlopt:`--bbox-unsup`. * forks with :vlopt:`--bbox-unsup`.
Timing controls and forks can also be ignored in specific files or parts of Timing controls and forks can also be ignored in specific files or parts of
files. The :option:`/*verilator&32;timing_off*/` and files. The :option:`/*verilator&32;timing_off*/` and
:option:`/*verilator&32;timing_off*/` metacomments will make Verilator ignore :option:`/*verilator&32;timing_off*/` metacomments will make Verilator
the encompassed timing controls and forks, regardless of the chosen ignore the encompassed timing controls and forks, regardless of the chosen
:vlopt:`--timing` or :vlopt:`--no-timing` option. This can also be achieved :vlopt:`--timing` or :vlopt:`--no-timing` option. This can also be achieved
using the :option:`timing_off` and :option:`timing_off` options in Verilator using the :option:`timing_off` and :option:`timing_off` options in
Control Files. Verilator Control Files.
.. _Language Limitations: .. _language limitations:
Language Limitations Language Limitations
==================== ====================
@ -189,38 +188,38 @@ Compiler would, namely given a block of the form:
.. code-block:: sv .. code-block:: sv
always @(x) y = x & z; always @(x) y = x & z;
This will recompute y when there is a potential for change in x or a change This will recompute y when there is a potential for change in x or a change
in z; that is when the flops computing x or z evaluate (which is what in z; that is when the flops computing x or z evaluate (which is what
Design Compiler will synthesize.) A compliant simulator will only Design Compiler will synthesize.) A compliant simulator will only calculate
calculate y if x changes. We recommend using always_comb to make the code y if x changes. We recommend using always_comb to make the code run the
run the same everywhere. Also avoid putting $displays in combo blocks, as same everywhere. Also avoid putting $displays in combo blocks, as they may
they may print multiple times when not desired, even on compliant print multiple times when not desired, even on compliant simulators as
simulators as event ordering is not specified. event ordering is not specified.
Signal Naming Signal Naming
------------- -------------
To avoid conflicts with C symbol naming, any character in a signal name To avoid conflicts with C symbol naming, any character in a signal name
that is not alphanumeric nor a single underscore will be replaced by __0hh that is not alphanumeric nor a single underscore will be replaced by
where hh is the hex code of the character. To avoid conflicts with `__0hh` where `hh` is the hex code of the character. To avoid conflicts
Verilator's internal symbols, any double underscore is replaced with with Verilator's internal symbols, any double underscore is replaced with
___05F (5F is the hex code of an underscore.) `___05F` (5F is the hex code of an underscore.)
Bind Bind
---- ----
Verilator only supports bind to a target module name, not to an Verilator only supports bind to a target module name, not to an instance
instance path. path.
Class Class
----- -----
Verilator class support is limited but in active development. Verilator Verilator class support is limited but in active development. Verilator
supports members, methods, class extend, and class parameters. supports members, methods, class extend, and class parameters.
@ -241,7 +240,7 @@ code.
Latches Latches
------- -------
Verilator is optimized for edge-sensitive (flop-based) designs. It will Verilator is optimized for edge-sensitive (flop-based) designs. It will
attempt to do the correct thing for latches, but most performance attempt to do the correct thing for latches, but most performance
optimizations will be disabled around the latch. optimizations will be disabled around the latch.
@ -254,7 +253,7 @@ generating one member of a structure from blocking, and another from
non-blocking assignments is unsupported. non-blocking assignments is unsupported.
.. _Unknown States: .. _unknown states:
Unknown States Unknown States
-------------- --------------
@ -264,33 +263,32 @@ However, it has two features that uncover most initialization bugs
(including many that a four-state simulator will miss.) (including many that a four-state simulator will miss.)
Identity comparisons (=== or !==) are converted to standard ==/!= when Identity comparisons (=== or !==) are converted to standard ==/!= when
neither side is a constant. This may make the expression yield a different neither side is a constant. This may make the expression yield a different
result than a four-state simulator. An === comparison to X will result than a four-state simulator. An === comparison to X will always be
always be false, so that Verilog code which checks for uninitialized logic false, so that Verilog code which checks for uninitialized logic will not
will not fire. fire.
Assigning X to a variable will assign a constant value as determined by the Assigning X to a variable will assign a constant value as determined by the
:vlopt:`--x-assign` option. This allows runtime randomization; thus, if :vlopt:`--x-assign` option. This allows runtime randomization; thus, if the
the value is used, the random value should cause downstream errors. value is used, the random value should cause downstream errors. Integers
Integers also get randomized, even though the Verilog 2001 specification also get randomized, even though the Verilog 2001 specification says they
says they initialize to zero. However, randomization happens at initialize to zero. However, randomization happens at initialization time;
initialization time; hence, during a single simulation run, the same hence, during a single simulation run, the same constant (but random) value
constant (but random) value will be used every time the assignment is will be used every time the assignment is executed.
executed.
All variables, depending on :vlopt:`--x-initial` setting, are typically All variables, depending on :vlopt:`--x-initial` setting, are typically
randomly initialized using a function. You can determine that reset is randomly initialized using a function. You can determine that reset is
working correctly by running several random simulation runs. On the first working correctly by running several random simulation runs. On the first
run, have the function initialize variables to zero. On the second, have run, have the function initialize variables to zero. On the second, have it
it initialize variables to one. On the third and following runs, have it initialize variables to one. On the third and following runs, have it
initialize them randomly. If the results match, reset works. (Note that initialize them randomly. If the results match, reset works. (Note that
this is what the hardware will do.) In practice, setting all variables to this is what the hardware will do.) In practice, setting all variables to
one at startup finds the most problems (since control signals are typically one at startup finds the most problems (since control signals are typically
active-high). active-high).
:vlopt:`--x-assign` applies to variables explicitly initialized or assigned :vlopt:`--x-assign` applies to variables explicitly initialized or assigned
an X. Uninitialized clocks are initialized to zero, while all other state an X. Uninitialized clocks are initialized to zero, while all other state
holding variables are initialized to a random value. Event-driven holding variables are initialized to a random value. Event-driven
simulators will generally trigger an edge on a transition from X to 1 simulators will generally trigger an edge on a transition from X to 1
(posedge) or X to 0 (negedge). However, by default, since clocks are (posedge) or X to 0 (negedge). However, by default, since clocks are
initialized to zero, Verilator will not trigger an initial negedge. Some initialized to zero, Verilator will not trigger an initial negedge. Some
@ -302,25 +300,24 @@ and without this option will find such problems.
Tri/Inout Tri/Inout
--------- ---------
Verilator converts some simple tristate structures into two state. Pullup, Verilator converts some simple tristate structures into two state. Pullup,
pulldown, bufif0, bufif1, notif0, notif1, pmos, nmos, tri0 and tri1 are pulldown, bufif0, bufif1, notif0, notif1, pmos, nmos, tri0 and tri1 are
also supported. Simple comparisons with :code:`=== 1'bz` are also also supported. Simple comparisons with ``=== 1'bz`` are also supported.
supported.
An assignment of the form: An assignment of the form:
.. code-block:: sv .. code-block:: sv
inout driver; inout driver;
wire driver = (enable) ? output_value : 1'bz; wire driver = (enable) ? output_value : 1'bz;
Will be converted to: Will be converted to:
.. code-block:: sv .. code-block:: sv
input driver; // Value being driven in from "external" drivers input driver; // Value being driven in from "external" drivers
output driver__en; // True if driven from this module output driver__en; // True if driven from this module
output driver__out; // Value being driven from this module output driver__out; // Value being driven from this module
External logic will be needed to combine these signals with any external External logic will be needed to combine these signals with any external
drivers. drivers.
@ -334,8 +331,8 @@ Gate Primitives
--------------- ---------------
The 2-state gate primitives (and, buf, nand, nor, not, or, xnor, xor) are The 2-state gate primitives (and, buf, nand, nor, not, or, xnor, xor) are
directly converted to behavioral equivalents. The 3-state and MOS gate directly converted to behavioral equivalents. The 3-state and MOS gate
primitives are not supported. User-defined primitive (UDP) tables are primitives are not supported. User-defined primitive (UDP) tables are
supported. supported.
@ -360,10 +357,10 @@ Array Out of Bounds
Writing a memory element outside the bounds specified for the array may Writing a memory element outside the bounds specified for the array may
cause a different memory element inside the array to be written instead. cause a different memory element inside the array to be written instead.
For power-of-2 sized arrays, Verilator will give a width warning and the For power-of-2 sized arrays, Verilator will give a width warning and the
address. For non-power-of-2-sizes arrays, index 0 will be written. address. For non-power-of-2-sizes arrays, index 0 will be written.
Reading a memory element outside the bounds specified for the array will Reading a memory element outside the bounds specified for the array will
give a width warning and wrap around the power-of-2 size. For give a width warning and wrap around the power-of-2 size. For
non-power-of-2 sizes, it will return an unspecified constant of the non-power-of-2 sizes, it will return an unspecified constant of the
appropriate width. appropriate width.
@ -371,21 +368,21 @@ appropriate width.
Assertions Assertions
---------- ----------
Verilator is beginning to add support for assertions. Verilator currently Verilator is beginning to add support for assertions. Verilator currently
only converts assertions to simple :code:`if (...) error` statements, and only converts assertions to simple ``if (...) error`` statements, and
coverage statements to increment the line counters described in the coverage statements to increment the line counters described in the
coverage section. coverage section.
Verilator does not support SEREs yet. All assertion and coverage Verilator does not support SEREs yet. All assertion and coverage statements
statements must be simple expressions that complete in one cycle. must be simple expressions that complete in one cycle.
Encrypted Verilog Encrypted Verilog
----------------- -----------------
Open-source simulators like Verilator cannot use encrypted RTL Open-source simulators like Verilator cannot use encrypted RTL (i.e. IEEE
(i.e. IEEE P1735). Talk to your IP vendor about delivering IP blocks via P1735). Talk to your IP vendor about delivering IP blocks using Verilator's
Verilator's :vlopt:`--protect-lib` feature. :vlopt:`--protect-lib` feature.
Language Keyword Limitations Language Keyword Limitations
@ -394,6 +391,7 @@ Language Keyword Limitations
This section describes specific limitations for each language keyword. This section describes specific limitations for each language keyword.
.. Hack to get long definition list: .. Hack to get long definition list:
.. |cmdslong1| replace:: \`__FILE__, \`__LINE__, \`begin_keywords, .. |cmdslong1| replace:: \`__FILE__, \`__LINE__, \`begin_keywords,
\`begin_keywords, \`begin_keywords, \`begin_keywords, \`begin_keywords, \`begin_keywords, \`begin_keywords, \`begin_keywords, \`begin_keywords,
\`define, \`else, \`elsif, \`end_keywords, \`endif, \`error, \`ifdef, \`define, \`else, \`elsif, \`end_keywords, \`endif, \`error, \`ifdef,
@ -402,8 +400,7 @@ This section describes specific limitations for each language keyword.
\`systemc_implementation, \`systemc_interface, \`undef, \`verilog \`systemc_implementation, \`systemc_interface, \`undef, \`verilog
|cmdslong1| |cmdslong1|
Fully supported. Fully supported.
.. Hack to get long definition list: .. Hack to get long definition list:
@ -417,125 +414,126 @@ This section describes specific limitations for each language keyword.
tri, typedef, var, vectored, while, wire, xnor, xor tri, typedef, var, vectored, while, wire, xnor, xor
|cmdslong2| |cmdslong2|
Generally supported. Generally supported.
++, -- operators ++, -- operators
Increment/decrement can only be used as standalone statements or in Increment/decrement can only be used as standalone statements or in
certain limited cases. certain limited cases.
'{} operator '{} operator
Assignment patterns with an order based, default, constant integer (array) Assignment patterns with an order based, default, constant integer
or member identifier (struct/union) keys are supported. Data type keys (array) or member identifier (struct/union) keys are supported. Data
and keys computed from a constant expression are not supported. type keys and keys computed from a constant expression are not
supported.
\`uselib \`uselib
Uselib, a vendor-specific library specification method, is ignored along Uselib, a vendor-specific library specification method, is ignored along
with anything following it until the end of that line. with anything following it until the end of that line.
cast operator cast operator
Casting is supported only between simple scalar types, signed and Casting is supported only between simple scalar types, signed and
unsigned, not arrays nor structs. unsigned, not arrays nor structs.
chandle chandle
Treated as a "longint"; does not yet warn about operations specified as Treated as a "longint"; does not yet warn about operations specified as
illegal on chandles. illegal on chandles.
checker checker
Treated as a "module"; does not yet warn about many constructs illegal Treated as a "module"; does not yet warn about many constructs illegal
inside a checker. inside a checker.
disable disable
Disable statements may be used only if the block being disabled is a Disable statements may be used only if the block being disabled is a
block the disable statement itself is inside. This was commonly used to block the disable statement itself is inside. This was commonly used to
provide loop break and continue functionality before SystemVerilog added provide loop break and continue functionality before SystemVerilog added
the break and continue keywords. the break and continue keywords.
force, release force, release
Verilator supports the procedural `force` (and corresponding `release`) Verilator supports the procedural `force` (and corresponding `release`)
statement. However, the behavior of the `force` statement does not statement. However, the behavior of the `force` statement does not
entirely comply with IEEE 1800-2023: entirely comply with IEEE 1800-2023:
#. Using forced variable as a value to another force statement is #. Using forced variable as a value to another force statement is
currently not supported. The dependent force statement is forced by an currently not supported. The dependent force statement is forced by
initial constant value. an initial constant value.
#. Force/release with procedural continuous assignment is not supported. #. Force/release with procedural continuous assignment is not supported.
The assignment is treated as procedural. The assignment is treated as procedural.
#. Expressions using multiple variable references or function calls on #. Expressions using multiple variable references or function calls on
forced right-hand side are not sensitive to dependency changes. forced right-hand side are not sensitive to dependency changes.
inside inside
Inside expressions may not include unpacked array traversal or $ as an Inside expressions may not include unpacked array traversal or $ as an
upper bound. Case inside and case matches are also unsupported. upper bound. Case inside and case matches are also unsupported.
interface interface
Interfaces and modports, including generated data types are Interfaces and modports, including generated data types are supported.
supported. Generate blocks around modports are not supported, nor are Generate blocks around modports are not supported, nor are virtual
virtual interfaces nor unnamed interfaces. interfaces nor unnamed interfaces.
shortreal shortreal
Short floating point (shortreal) numbers are converted to real. Most Short floating point (shortreal) numbers are converted to real. Most
other simulators either do not support float, or convert likewise. other simulators either do not support float, or convert likewise.
specify specparam specify specparam
All timing checks and specify blocks (except specparam, which is All timing checks and specify blocks (except specparam, which is
supported) are ignored. supported) are ignored.
uwire uwire
Verilator does not perform warning checking on uwires; it treats the Verilator does not perform warning checking on uwires; it treats the
uwire keyword as if it were the normal wire keyword. uwire keyword as if it were the normal wire keyword.
$bits, $countbits, $countones, $finish, $isunknown, $onehot, $onehot0, $signed, $stime, $stop, $time, $unsigned, $bits, $countbits, $countones, $finish, $isunknown, $onehot, $onehot0, $signed, $stime, $stop, $time, $unsigned,
Generally supported. Generally supported.
$dump/$dumpports and related $dump/$dumpports and related
$dumpfile or $dumpports will create a VCD or FST file (based on $dumpfile or $dumpports will create a VCD or FST file (based on the
the :vlopt:`--trace-vcd` option given when the model was Verilated). This :vlopt:`--trace-vcd` option given when the model was Verilated). This
will take effect starting at the next eval() call. If you have multiple will take effect starting at the next eval() call. If you have multiple
Verilated designs under the same C model, this will dump signals Verilated designs under the same C model, this will dump signals only
only from the design containing the $dumpvars. from the design containing the $dumpvars.
$dumpvars and $dumpports module identifier is ignored; the traced $dumpvars and $dumpports module identifier is ignored; the traced
instances will always start at the top of the design. The levels argument instances will always start at the top of the design. The levels
is also ignored; use tracing_on/tracing_off pragmas instead. argument is also ignored; use tracing_on/tracing_off pragmas instead.
$dumpportson/$dumpportsoff/$dumpportsall/$dumpportslimit filename $dumpportson/$dumpportsoff/$dumpportsall/$dumpportslimit filename
argument is ignored; only a single trace file may be active at once. argument is ignored; only a single trace file may be active at once.
$dumpall/$dumpportsall, $dumpon/$dumpportson, $dumpoff/$dumpportsoff, and $dumpall/$dumpportsall, $dumpon/$dumpportson, $dumpoff/$dumpportsoff,
$dumplimit/$dumpportlimit are currently ignored. and $dumplimit/$dumpportlimit are currently ignored.
$error, $fatal, $info, $warning. $error, $fatal, $info, $warning.
Generally supported. Generally supported.
$exit, $finish, $stop $exit, $finish, $stop
The rarely used optional parameter to $finish and $stop is ignored; $exit The rarely used optional parameter to $finish and $stop is ignored;
is aliased to $finish. $exit is aliased to $finish.
$fopen, $fclose, $fdisplay, $ferror, $feof, $fflush, $fgetc, $fgets, $fscanf, $fwrite, $fscanf, $sscanf $fopen, $fclose, $fdisplay, $ferror, $feof, $fflush, $fgetc, $fgets, $fscanf, $fwrite, $fscanf, $sscanf
Generally supported. Generally supported.
$fullskew, $hold, $nochange, $period, $recovery, $recrem, $removal, $setup, $setuphold, $skew, $timeskew, $width $fullskew, $hold, $nochange, $period, $recovery, $recrem, $removal, $setup, $setuphold, $skew, $timeskew, $width
All specify blocks and timing checks are ignored. All specify blocks and timing checks are ignored.
$random, $urandom, $urandom_range $random, $urandom, $urandom_range
Use :vlopt:`+verilator+seed+\<value\>` runtime option to set the seed if Use :vlopt:`+verilator+seed+\<value\>` runtime option to set the seed if
there is no $random nor $urandom optional argument to set the seed. there is no $random nor $urandom optional argument to set the seed.
There is one random seed per C thread, not per module for $random, nor There is one random seed per C thread, not per module for $random, nor
per object for random stability of $urandom/$urandom_range. per object for random stability of $urandom/$urandom_range.
$readmemb, $readmemh $readmemb, $readmemh
Read memory commands are supported. Verilator and the Verilog Read memory commands are supported. Verilator and the Verilog
specification do not include support for readmem to multi-dimensional specification do not include support for readmem to multi-dimensional
arrays. arrays.
$test$plusargs, $value$plusargs $test$plusargs, $value$plusargs
Supported, but the instantiating C++/SystemC wrapper must call Supported, but the instantiating C++/SystemC wrapper must call
.. code-block:: C++ .. code-block:: C++
{VerilatedContext*} ->commandArgs(argc, argv); {VerilatedContext*} ->commandArgs(argc, argv);
to register the command line before calling $test$plusargs or to register the command line before calling $test$plusargs or
$value$plusargs. Or use :vlopt:`--binary` or :vlopt:`--main`. $value$plusargs. Or use :vlopt:`--binary` or :vlopt:`--main`.

View File

@ -1,4 +1,4 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
******** ********
@ -9,22 +9,22 @@ Welcome to Verilator!
The Verilator package converts Verilog [#]_ and SystemVerilog [#]_ hardware The Verilator package converts Verilog [#]_ and SystemVerilog [#]_ hardware
description language (HDL) designs into a C++ or SystemC model that, after description language (HDL) designs into a C++ or SystemC model that, after
compiling, can be executed. Verilator is not a traditional simulator but a compiling, can be executed. Verilator is not a traditional simulator but a
compiler. compiler.
Verilator is typically used as follows: Verilator is typically used as follows:
1. The :command:`verilator` executable is invoked with parameters similar 1. The :command:`verilator` executable is invoked with parameters similar
to GCC or other simulators such as Cadence Verilog-XL/NC-Verilog, or to GCC or other simulators such as Cadence Verilog-XL/NC-Verilog, or
Synopsys VCS. Verilator reads the specified SystemVerilog code, lints it, Synopsys VCS. Verilator reads the specified SystemVerilog code, lints it,
optionally adds coverage and waveform tracing support, and compiles the optionally adds coverage and waveform tracing support, and compiles the
design into a source-level multithreaded C++ or SystemC "model". The design into a source-level multithreaded C++ or SystemC "model". The
resulting model's C++ or SystemC code is output as .cpp and .h files. This resulting model's C++ or SystemC code is output as .cpp and .h files. This
is referred to as "Verilating", and the process is "to Verilate"; the is referred to as "Verilating", and the process is "to Verilate"; the
output is a "Verilated" model. output is a "Verilated" model.
2. For simulation, a small user-written C++ wrapper file is required, the 2. For simulation, a small user-written C++ wrapper file is required, the
"wrapper". This wrapper defines the C++ standard function "main()", which "wrapper". This wrapper defines the C++ standard function "main()", which
instantiates the Verilated model as a C++/SystemC object. instantiates the Verilated model as a C++/SystemC object.
3. The user C++ wrapper, the files created by Verilator, a "runtime 3. The user C++ wrapper, the files created by Verilator, a "runtime
@ -35,21 +35,21 @@ then compiled using a C++ compiler to create a simulation executable.
"simulation runtime". "simulation runtime".
5. If appropriately enabled, the executable may also generate waveform 5. If appropriately enabled, the executable may also generate waveform
traces of the design that may be viewed. It may also create coverage traces of the design that may be viewed. It may also create coverage
analysis data for post-analysis. analysis data for post-analysis.
The best place to get started is to try the :ref:`Examples`. The best place to get started is to try the :ref:`Examples`.
.. [#] Verilog is defined by the `Institute of Electrical and Electronics .. [#] Verilog is defined by the `Institute of Electrical and Electronics
Engineers (IEEE) Standard for Verilog Hardware Description Engineers (IEEE) Standard for Verilog Hardware Description Language`,
Language`, Std. 1364, released in 1995, 2001, and 2005. The Std. 1364, released in 1995, 2001, and 2005. The Verilator documentation
Verilator documentation uses the shorthand, e.g., "IEEE 1364-2005", uses the shorthand, e.g., "IEEE 1364-2005", to refer to the, e.g., 2005
to refer to the, e.g., 2005 version of this standard. version of this standard.
.. [#] SystemVerilog is defined by the `Institute of Electrical and .. [#] SystemVerilog is defined by the `Institute of Electrical and
Electronics Engineers (IEEE) Standard for SystemVerilog - Unified Electronics Engineers (IEEE) Standard for SystemVerilog - Unified
Hardware Design, Specification, and Verification Language`, Standard Hardware Design, Specification, and Verification Language`, Standard
1800, released in 2005, 2009, 2012, 2017, and 2023. The Verilator 1800, released in 2005, 2009, 2012, 2017, and 2023. The Verilator
documentation uses the shorthand e.g., "IEEE 1800-2023", to refer to documentation uses the shorthand e.g., "IEEE 1800-2023", to refer to
the, e.g., 2023 version of this standard. the, e.g., 2023 version of this standard.

View File

@ -1,18 +1,18 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
.. _Simulating: .. _simulating:
************************************ ************************************
Simulating (Verilated-Model Runtime) Simulating (Verilated-Model Runtime)
************************************ ************************************
This section describes items related to simulating, that is, using a This section describes items related to simulating, that is, using a
Verilated model's executable. For the runtime arguments to a simulated Verilated model's executable. For the runtime arguments to a simulated
model, see :ref:`Simulation Runtime Arguments`. model, see :ref:`Simulation Runtime Arguments`.
.. _Simulation Summary Report: .. _simulation summary report:
Simulation Summary Report Simulation Summary Report
========================= =========================
@ -49,9 +49,9 @@ The information in this report is:
Simulated time (if non-zero) divided by wall time. e.g. `123 ns/s` means Simulated time (if non-zero) divided by wall time. e.g. `123 ns/s` means
123 simulated nanoseconds took 1 second of wall time; for a model with 123 simulated nanoseconds took 1 second of wall time; for a model with
only a 1 GHz clock that would be equivalent to 123.1 cycles per only a 1 GHz clock that would be equivalent to 123.1 cycles per second.
second. The units are automatically selected to give a number between 1 The units are automatically selected to give a number between 1
and 1000. The wall time includes initialization, initial and final and 1000. The wall time includes initialization, initial and final
process blocks, so indicates a slower speed than if the model had a process blocks, so indicates a slower speed than if the model had a
longer runtime. longer runtime.
@ -68,30 +68,28 @@ The information in this report is:
Total memory used during simulation in megabytes. Total memory used during simulation in megabytes.
.. _Benchmarking & Optimization: .. _benchmarking & optimization:
Benchmarking & Optimization Benchmarking & Optimization
=========================== ===========================
For best performance, run Verilator with the :vlopt:`-O3` For best performance, run Verilator with the :vlopt:`-O3`
:vlopt:`--x-assign fast <--x-assign>` :vlopt:`--x-assign fast <--x-assign>` :vlopt:`--x-initial fast
:vlopt:`--x-initial fast <--x-initial>` <--x-initial>` :vlopt:`--no-assert` options. The :vlopt:`-O3` option will
:vlopt:`--no-assert` options. The :vlopt:`-O3` require a longer time to run Verilator, and :vlopt:`--x-assign fast
option will require a longer time to run Verilator, and <--x-assign>` :vlopt:`--x-initial fast <--x-assign>` may increase the risk
:vlopt:`--x-assign fast <--x-assign>` of reset bugs in trade for performance. The :vlopt:`--no-assert` will
:vlopt:`--x-initial fast <--x-assign>` suppress checking assertions, which is faster and appropriate for
may increase the risk of reset bugs in trade for performance. The known-good models running software, but may hide design errors. See the
:vlopt:`--no-assert` will suppress checking assertions, which is faster and above documentation for these options.
appropriate for known-good models running software, but may hide design
errors. See the above documentation for these options.
If using Verilated multithreaded, consider overriding Verilator's default If using Verilated multithreaded, consider overriding Verilator's default
thread-to-processor assignment by using ``numactl``; see thread-to-processor assignment by using ``numactl``; see
:ref:`Multithreading`. Also, consider using profile-guided optimization; :ref:`Multithreading`. Also, consider using profile-guided optimization;
see :ref:`Thread PGO`. see :ref:`Thread PGO`.
Minor Verilog code changes can also give big wins. You should not have any Minor Verilog code changes can also give big wins. You should not have any
:option:`UNOPTFLAT` warnings from Verilator. Fixing these warnings can :option:`UNOPTFLAT` warnings from Verilator. Fixing these warnings can
result in huge improvements; one user fixed their one UNOPTFLAT warning by result in huge improvements; one user fixed their one UNOPTFLAT warning by
making a simple change to a clocked latch used to gate clocks and gained a making a simple change to a clocked latch used to gate clocks and gained a
60% performance improvement. 60% performance improvement.
@ -108,14 +106,14 @@ example:
.. code-block:: bash .. code-block:: bash
make OPT_FAST="-Os -march=native" -f Vour.mk Vour__ALL.a make OPT_FAST="-Os -march=native" -f Vour.mk Vour__ALL.a
OPT_FAST specifies optimization options for those parts of the model OPT_FAST specifies optimization options for those parts of the model on the
on the fast path. This is mostly code that is executed every fast path. This is mostly code that is executed every cycle. OPT_SLOW
cycle. OPT_SLOW applies to slow-path code, which rarely executes, often applies to slow-path code, which rarely executes, often only once at the
only once at the beginning or end of the simulation. OPT_SLOW is beginning or end of the simulation. OPT_SLOW is ignored if
ignored if VM_PARALLEL_BUILDS is not 1, in which case all generated code VM_PARALLEL_BUILDS is not 1, in which case all generated code will be
will be compiled in a single compilation unit using OPT_FAST. See also the compiled in a single compilation unit using OPT_FAST. See also the
Verilator :vlopt:`--output-split` option. The OPT_GLOBAL variable applies Verilator :vlopt:`--output-split` option. The OPT_GLOBAL variable applies
to common code in the runtime library used by Verilated models (shipped in to common code in the runtime library used by Verilated models (shipped in
$VERILATOR_ROOT/include). Additional C++ files passed on the verilator $VERILATOR_ROOT/include). Additional C++ files passed on the verilator
@ -134,10 +132,10 @@ benefit), but compile times may be excessively large even with medium-sized
designs. Compilation times can be improved at the expense of simulation designs. Compilation times can be improved at the expense of simulation
speed by reducing optimization, for example, with OPT_FAST="-O0". Often speed by reducing optimization, for example, with OPT_FAST="-O0". Often
good simulation speed can be achieved with OPT_FAST="-O1 -fstrict-aliasing" good simulation speed can be achieved with OPT_FAST="-O1 -fstrict-aliasing"
but with improved compilation times. Files controlled by OPT_SLOW have but with improved compilation times. Files controlled by OPT_SLOW have
little effect on performance, and therefore OPT_SLOW is empty by default little effect on performance, and therefore OPT_SLOW is empty by default
(equivalent to "-O0") for improved compilation speed. In common use cases, (equivalent to "-O0") for improved compilation speed. In common use cases,
there should be little benefit in changing OPT_SLOW. OPT_GLOBAL is set to there should be little benefit in changing OPT_SLOW. OPT_GLOBAL is set to
"-Os" by default, and there should rarely be a need to change it. As the "-Os" by default, and there should rarely be a need to change it. As the
runtime library is small compared to many Verilated models, disabling runtime library is small compared to many Verilated models, disabling
optimization on the runtime library should not seriously affect overall optimization on the runtime library should not seriously affect overall
@ -169,29 +167,29 @@ inlined functions that drive the compiler nuts.)
You may uncover further tuning possibilities by profiling the Verilog code. You may uncover further tuning possibilities by profiling the Verilog code.
See :ref:`profiling`. See :ref:`profiling`.
When done optimizing, please let the author know the results. We like to When done optimizing, please let the author know the results. We like to
keep tabs on how Verilator compares and may be able to suggest additional keep tabs on how Verilator compares and may be able to suggest additional
improvements. improvements.
.. _Coverage Analysis: .. _coverage analysis:
Coverage Analysis Coverage Analysis
================= =================
Verilator supports adding code to the Verilated model to support Verilator supports adding code to the Verilated model to support
SystemVerilog code coverage. With :vlopt:`--coverage`, Verilator enables SystemVerilog code coverage. With :vlopt:`--coverage`, Verilator enables
all forms of coverage: all forms of coverage:
* :ref:`User Coverage` - :ref:`User Coverage`
* :ref:`Line Coverage` - :ref:`Line Coverage`
* :ref:`Toggle Coverage` - :ref:`Toggle Coverage`
When a model with coverage is executed, it will create a coverage file for When a model with coverage is executed, it will create a coverage file for
collection and later analysis, see :ref:`Coverage Collection`. collection and later analysis, see :ref:`Coverage Collection`.
.. _User Coverage: .. _user coverage:
Functional Coverage Functional Coverage
------------------- -------------------
@ -205,18 +203,18 @@ point under the coverage name "DefaultClock":
.. code-block:: sv .. code-block:: sv
DefaultClock: cover property (@(posedge clk) cyc==3); DefaultClock: cover property (@(posedge clk) cyc==3);
.. _Line Coverage: .. _line coverage:
Line Coverage Line Coverage
------------- -------------
With :vlopt:`--coverage` or :vlopt:`--coverage-line`, Verilator will With :vlopt:`--coverage` or :vlopt:`--coverage-line`, Verilator will
automatically add coverage analysis at each code flow change point (e.g., automatically add coverage analysis at each code flow change point (e.g.,
at branches). At each such branch, a counter is incremented. At the end at branches). At each such branch, a counter is incremented. At the end of
of a test, the counters, filename, and line number corresponding to each a test, the counters, filename, and line number corresponding to each
counter are written into the coverage file. counter are written into the coverage file.
Verilator may over-count combinatorial (non-clocked) blocks when those Verilator may over-count combinatorial (non-clocked) blocks when those
@ -225,38 +223,38 @@ disabled; for the most accurate results, do not disable this warning when
using coverage. using coverage.
.. _Toggle Coverage: .. _toggle coverage:
Toggle Coverage Toggle Coverage
--------------- ---------------
With :vlopt:`--coverage` or :vlopt:`--coverage-toggle`, Verilator will With :vlopt:`--coverage` or :vlopt:`--coverage-toggle`, Verilator will
automatically add toggle coverage analysis into the Verilated model. automatically add toggle coverage analysis into the Verilated model.
Every bit of every signal in a module has a counter inserted, and the Every bit of every signal in a module has a counter inserted, and the
counter will increment on every edge change of the corresponding bit. counter will increment on every edge change of the corresponding bit.
Signals that are part of tasks or begin/end blocks are considered local Signals that are part of tasks or begin/end blocks are considered local
variables and are not covered. Signals that begin with underscores (see variables and are not covered. Signals that begin with underscores (see
:vlopt:`--coverage-underscore`), are integers, or are very wide (>256 bits :vlopt:`--coverage-underscore`), are integers, or are very wide (>256 bits
total storage across all dimensions, see :vlopt:`--coverage-max-width`) are total storage across all dimensions, see :vlopt:`--coverage-max-width`) are
also not covered. also not covered.
Hierarchy is compressed, so if a module is instantiated multiple times, Hierarchy is compressed, so if a module is instantiated multiple times,
coverage will be summed for that bit across **all** instantiations of that coverage will be summed for that bit across **all** instantiations of that
module with the same parameter set. A module instantiated with different module with the same parameter set. A module instantiated with different
parameter values is considered a different module and will get counted parameter values is considered a different module and will get counted
separately. separately.
Verilator makes a minimally-intelligent decision about what clock domain Verilator makes a minimally-intelligent decision about what clock domain
the signal goes to, and only looks for edges in that clock domain. This the signal goes to, and only looks for edges in that clock domain. This
means that edges may be ignored if it is known that the receiving logic means that edges may be ignored if it is known that the receiving logic
could never see the edge. This algorithm may improve in the future. The could never see the edge. This algorithm may improve in the future. The net
net result is that coverage may be lower than what would be seen by looking result is that coverage may be lower than what would be seen by looking at
at traces, but the coverage is a more accurate representation of the traces, but the coverage is a more accurate representation of the quality
quality of stimulus into the design. of stimulus into the design.
There may be edges counted near time zero while the model stabilizes. It's There may be edges counted near time zero while the model stabilizes. It's
a good practice to zero all coverage just before releasing reset to prevent a good practice to zero all coverage just before releasing reset to prevent
counting such behavior. counting such behavior.
@ -265,7 +263,7 @@ A :option:`/*verilator&32;coverage_off*/`
signals that do not need toggle analysis, such as RAMs and register files. signals that do not need toggle analysis, such as RAMs and register files.
.. _Expression Coverage: .. _expression coverage:
Expression Coverage Expression Coverage
------------------- -------------------
@ -276,20 +274,20 @@ truth table how every Boolean truth-table possibility in the expression
occurred. occurred.
Multi-bit expressions are ignored, but sub-expressions with are entirely Multi-bit expressions are ignored, but sub-expressions with are entirely
Boolean are analyzed. Expression coverage does not fully explore the truth Boolean are analyzed. Expression coverage does not fully explore the truth
table of an expression, rather is looks at each term's contribution. E.g. table of an expression, rather is looks at each term's contribution. E.g.
an AND operation will check coverage for TT, XF and FX. an AND operation will check coverage for TT, XF and FX.
Some expressions may produce too many cover points. Verilator limits the Some expressions may produce too many cover points. Verilator limits the
maximum number of cover points per expression to 32, but this may be maximum number of cover points per expression to 32, but this may be
controlled with :vlopt:`--coverage-expr-max`. controlled with :vlopt:`--coverage-expr-max`.
Below is an example showing expression coverage produced from `verilator_coverage` Below is an example showing expression coverage produced from
as applied to the condition expression inside an if statement. Each line `verilator_coverage` as applied to the condition expression inside an if
shows the minimum number of terms and their values (e.g. `(t1==0 && t2==1)`) needed statement. Each line shows the minimum number of terms and their values
to reach a result for the overall expression (e.g. `=> 1`). Each line also (e.g. `(t1==0 && t2==1)`) needed to reach a result for the overall
shows the number of times this combination was hit. Note that individual lines expression (e.g. `=> 1`). Each line also shows the number of times this
are not mutually exclusive. combination was hit. Note that individual lines are not mutually exclusive.
.. code-block:: .. code-block::
@ -301,7 +299,7 @@ are not mutually exclusive.
-000003 point: comment=(t2==0 && t4==0) => 0 hier=top.t -000003 point: comment=(t2==0 && t4==0) => 0 hier=top.t
-000002 point: comment=(t3==0 && t4==1) => 1 hier=top.t -000002 point: comment=(t3==0 && t4==1) => 1 hier=top.t
.. _Suppressing Coverage: .. _suppressing coverage:
Suppressing Coverage Suppressing Coverage
-------------------- --------------------
@ -313,11 +311,11 @@ and enable coverage respectively around that block. Or, use the
Verilator automatically disables coverage of lines and branches with a Verilator automatically disables coverage of lines and branches with a
$stop in them, as it is assumed that $stop branches contain an error check $stop in them, as it is assumed that $stop branches contain an error check
that should not occur. A :option:`/*verilator&32;coverage_block_off*/` that should not occur. A :option:`/*verilator&32;coverage_block_off*/`
metacomment will perform a similar function on any code in that block or metacomment will perform a similar function on any code in that block or
below. below.
.. _Coverage Collection: .. _coverage collection:
Coverage Collection Coverage Collection
------------------- -------------------
@ -332,17 +330,17 @@ To get the coverage data from the model, write the coverage with either:
:vlopt:`+verilator+coverage+file+\<filename\>`. :vlopt:`+verilator+coverage+file+\<filename\>`.
2. In the user wrapper code, typically at the end once a test passes, call 2. In the user wrapper code, typically at the end once a test passes, call
:code:`Verilated::threadContextp()->coveragep()->write` with an argument ``Verilated::threadContextp()->coveragep()->write`` with an argument of
of the filename for the coverage data file to write coverage data to the filename for the coverage data file to write coverage data to
(typically "logs/coverage.dat"). (typically "logs/coverage.dat").
Run each of your tests in different directories, potentially in parallel. Run each of your tests in different directories, potentially in parallel.
Each test will create the file specified above, Each test will create the file specified above, e.g.
e.g. :file:`logs/coverage.dat`. :file:`logs/coverage.dat`.
After running all of the tests, execute the :command:`verilator_coverage` After running all of the tests, execute the :command:`verilator_coverage`
command, passing arguments pointing to the filenames of all the command, passing arguments pointing to the filenames of all the individual
individual coverage files. :command:`verilator_coverage` will read the coverage files. :command:`verilator_coverage` will read the
:file:`logs/coverage.dat` file(s), and create an annotated source code :file:`logs/coverage.dat` file(s), and create an annotated source code
listing showing code coverage details. listing showing code coverage details.
@ -357,18 +355,17 @@ Additional options of :command:`verilator_coverage` allow for the merging
of coverage data files or other transformations. of coverage data files or other transformations.
Info files can be written by verilator_coverage for import to Info files can be written by verilator_coverage for import to
:command:`lcov`. This enables using :command:`genhtml` for HTML reports :command:`lcov`. This enables using :command:`genhtml` for HTML reports and
and importing reports to sites such as `https://codecov.io importing reports to sites such as https://codecov.io.
<https://codecov.io>`_.
.. _Profiling: .. _profiling:
Code Profiling Code Profiling
============== ==============
The Verilated model may be code-profiled using GCC or Clang's C++ profiling The Verilated model may be code-profiled using GCC or Clang's C++ profiling
mechanism. Verilator provides additional flags to help map the resulting mechanism. Verilator provides additional flags to help map the resulting
C++ profiling results back to the original Verilog code responsible for the C++ profiling results back to the original Verilog code responsible for the
profiled C++ code functions. profiled C++ code functions.
@ -387,13 +384,13 @@ To use profiling:
on which most of the time is being spent. on which most of the time is being spent.
.. _Execution Profiling: .. _execution profiling:
Execution Profiling Execution Profiling
=================== ===================
For performance optimization, it is helpful to see statistics and visualize how For performance optimization, it is helpful to see statistics and visualize
execution time is distributed in a verilated model. how execution time is distributed in a verilated model.
With the :vlopt:`--prof-exec` option, Verilator will: With the :vlopt:`--prof-exec` option, Verilator will:
@ -403,7 +400,7 @@ With the :vlopt:`--prof-exec` option, Verilator will:
specified with :vlopt:`+verilator+prof+exec+file+\<filename\>`. specified with :vlopt:`+verilator+prof+exec+file+\<filename\>`.
* In multithreaded models, add code to record each macro-task's start and * In multithreaded models, add code to record each macro-task's start and
end time across several calls to eval. (What is a macro-task? See the end time across several calls to eval. (What is a macro-task? See the
Verilator internals document (:file:`docs/internals.rst` in the Verilator internals document (:file:`docs/internals.rst` in the
distribution.) distribution.)
@ -414,16 +411,19 @@ saved profiling file into a visual format and produce related statistics.
Example verilator_gantt output, as viewed with GTKWave. Example verilator_gantt output, as viewed with GTKWave.
The measured_parallelism shows the number of CPUs being used at a given moment. The measured_parallelism shows the number of CPUs being used at a given
moment.
The cpu_thread section shows which thread is executing on each physical CPU. The cpu_thread section shows which thread is executing on each physical
CPU.
The thread_mtask section shows which macro-task is running on a given thread. The thread_mtask section shows which macro-task is running on a given
thread.
For more information, see :command:`verilator_gantt`. For more information, see :command:`verilator_gantt`.
.. _Profiling ccache efficiency: .. _profiling ccache efficiency:
Profiling ccache efficiency Profiling ccache efficiency
=========================== ===========================
@ -431,27 +431,28 @@ Profiling ccache efficiency
The Verilator-generated Makefile supports basic profiling of ccache The Verilator-generated Makefile supports basic profiling of ccache
behavior during the build. This can be used to track down files that might behavior during the build. This can be used to track down files that might
be unnecessarily rebuilt, though as of today, even minor code changes will be unnecessarily rebuilt, though as of today, even minor code changes will
usually require rebuilding a large number of files. Improving ccache usually require rebuilding a large number of files.
efficiency during the edit/compile/test loop is an active development area.
To get a basic report of how well ccache is doing, add the `ccache-report` To get a basic report of how well ccache is doing, add the `ccache-report`
target when invoking the generated Makefile: target when invoking the generated Makefile:
.. code-block:: bash .. code-block:: bash
make -C obj_dir -f Vout.mk Vout ccache-report make -C obj_dir -f Vout.mk Vout ccache-report
This will print a report based on all executions of ccache during this This will print a report based on all executions of ccache during this
invocation of Make. The report is also written to a file, in this example invocation of Make. The report is also written to a file, in this example
`obj_dir/Vout__cache_report.txt`. `obj_dir/Vout__cache_report.txt`.
To use the `ccache-report` target, at least one other explicit build target To use the `ccache-report` target, OBJCACHE must be set to 'ccache' (this
must be specified, and OBJCACHE must be set to 'ccache'. is done by `configure` if 'ccache' is installed). If no other explicit
build targets are specified, `cchache-report` will build the `default`
target.
This feature is currently experimental and might change in subsequent This feature is currently experimental and might change in subsequent
releases. releases.
.. _Save/Restore: .. _save/restore:
Save/Restore Save/Restore
============ ============
@ -459,32 +460,32 @@ Save/Restore
The intermediate state of a Verilated model may be saved so that it may The intermediate state of a Verilated model may be saved so that it may
later be restored. later be restored.
To enable this feature, use :vlopt:`--savable`. There are limitations in To enable this feature, use :vlopt:`--savable`. There are limitations in
what language features are supported along with :vlopt:`--savable`; if you what language features are supported along with :vlopt:`--savable`; if you
attempt to use an unsupported feature, Verilator will throw an error. attempt to use an unsupported feature, Verilator will throw an error.
To use save/restore, the user wrapper code must create a VerilatedSerialize To use save/restore, the user wrapper code must create a VerilatedSerialize
or VerilatedDeserialze object and then call the :code:`<<` or :code:`>>` or VerilatedDeserialze object and then call the ``<<`` or ``>>`` operators
operators on the generated model and any other data the process needs to be on the generated model and any other data the process needs to be
saved/restored. These functions are not thread-safe and are typically saved/restored. These functions are not thread-safe and are typically
called only by a main thread. called only by a main thread.
For example: For example:
.. code-block:: C++ .. code-block:: C++
void save_model(const char* filenamep) { void save_model(const char* filenamep) {
VerilatedSave os; VerilatedSave os;
os.open(filenamep); os.open(filenamep);
os << main_time; // user code must save the timestamp os << main_time; // user code must save the timestamp
os << *topp; os << *topp;
} }
void restore_model(const char* filenamep) { void restore_model(const char* filenamep) {
VerilatedRestore os; VerilatedRestore os;
os.open(filenamep); os.open(filenamep);
os >> main_time; os >> main_time;
os >> *topp; os >> *topp;
} }
Profile-Guided Optimization Profile-Guided Optimization
@ -494,9 +495,9 @@ Profile-guided optimization is the technique where profiling data is
collected by running your simulation executable; then this information is collected by running your simulation executable; then this information is
used to guide the next Verilation or compilation. used to guide the next Verilation or compilation.
There are two forms of profile-guided optimizations. Unfortunately, for There are two forms of profile-guided optimizations. Unfortunately, for
best results, they must each be performed from the highest level code to the best results, they must each be performed from the highest level code to
lowest, which means performing them separately and in this order: the lowest, which means performing them separately and in this order:
* :ref:`Thread PGO` * :ref:`Thread PGO`
* :ref:`Compiler PGO` * :ref:`Compiler PGO`
@ -506,25 +507,25 @@ toggle rate PGO, branch prediction PGO, statement execution time PGO, or
others, as they prove beneficial. others, as they prove beneficial.
.. _Thread PGO: .. _thread pgo:
Thread Profile-Guided Optimization Thread Profile-Guided Optimization
---------------------------------- ----------------------------------
Verilator supports profile-guided optimization (Verilation) of multithreaded Verilator supports profile-guided optimization (Verilation) of
models (Thread PGO) to improve performance. multithreaded models (Thread PGO) to improve performance.
When using multithreading, Verilator computes how long macro tasks take and When using multithreading, Verilator computes how long macro tasks take and
tries to balance those across threads. (What is a macro-task? See the tries to balance those across threads. (What is a macro-task? See the
Verilator internals document (:file:`docs/internals.rst` in the Verilator internals document (:file:`docs/internals.rst` in the
distribution.) If the estimations are incorrect, the threads will not be distribution.) If the estimations are incorrect, the threads will not be
balanced, leading to decreased performance. Thread PGO allows collecting balanced, leading to decreased performance. Thread PGO allows collecting
profiling data to replace the estimates and better optimize these profiling data to replace the estimates and better optimize these
decisions. decisions.
To use Thread PGO, Verilate the model with the :vlopt:`--prof-pgo` option. This To use Thread PGO, Verilate the model with the :vlopt:`--prof-pgo` option.
will code to the verilated model to save profiling data for profile-guided This will code to the verilated model to save profiling data for
optimization. profile-guided optimization.
Run the model executable. When the executable exits, it will create a Run the model executable. When the executable exits, it will create a
profile.vlt file. profile.vlt file.
@ -532,38 +533,38 @@ profile.vlt file.
Rerun Verilator, optionally omitting the :vlopt:`--prof-pgo` option and Rerun Verilator, optionally omitting the :vlopt:`--prof-pgo` option and
adding the :file:`profile.vlt` generated earlier to the command line. adding the :file:`profile.vlt` generated earlier to the command line.
Note there is no Verilator equivalent to GCC's --fprofile-use. Verilator's Note there is no Verilator equivalent to GCC's --fprofile-use. Verilator's
profile data file (:file:`profile.vlt`) can be placed directly on the profile data file (:file:`profile.vlt`) can be placed directly on the
verilator command line without any option prefix. verilator command line without any option prefix.
If results from multiple simulations are to be used in generating the If results from multiple simulations are to be used in generating the
optimization, multiple simulation's profile.vlt may be concatenated optimization, multiple simulation's profile.vlt may be concatenated
externally, or each file may be fed as separate command line options into externally, or each file may be fed as separate command line options into
Verilator. Verilator will sum the profile results, so a long-running test Verilator. Verilator will sum the profile results, so a long-running test
will have more weight for optimization proportionally than a will have more weight for optimization proportionally than a
shorter-running test. shorter-running test.
If you provide any profile feedback data to Verilator and it cannot use If you provide any profile feedback data to Verilator and it cannot use it,
it, it will issue the :option:`PROFOUTOFDATE` warning that threads were it will issue the :option:`PROFOUTOFDATE` warning that threads were
scheduled using estimated costs. This usually indicates that the profile scheduled using estimated costs. This usually indicates that the profile
data was generated from a different Verilog source code than Verilator is data was generated from a different Verilog source code than Verilator is
currently running against. Therefore, repeat the data collection phase to currently running against. Therefore, repeat the data collection phase to
create new profiling data, then rerun Verilator with the same input source create new profiling data, then rerun Verilator with the same input source
files and that new profiling data. files and that new profiling data.
.. _Compiler PGO: .. _compiler pgo:
Compiler Profile-Guided Optimization Compiler Profile-Guided Optimization
------------------------------------ ------------------------------------
GCC and Clang support compiler profile-guided optimization (PGO). This GCC and Clang support compiler profile-guided optimization (PGO). This
optimizes any C/C++ program, including Verilated code. Using compiler PGO optimizes any C/C++ program, including Verilated code. Using compiler PGO
typically yields improvements of 5-15% on both single-threaded and typically yields improvements of 5-15% on both single-threaded and
multithreaded models. multithreaded models.
Please see the appropriate compiler documentation to use PGO with GCC or Please see the appropriate compiler documentation to use PGO with GCC or
Clang. The process in GCC 10 was as follows: Clang. The process in GCC 10 was as follows:
1. Compile the Verilated model with the compiler's "-fprofile-generate" 1. Compile the Verilated model with the compiler's "-fprofile-generate"
flag: flag:
@ -573,8 +574,8 @@ Clang. The process in GCC 10 was as follows:
verilator [whatever_flags] --make \ verilator [whatever_flags] --make \
-CFLAGS -fprofile-generate -LDFLAGS -fprofile-generate -CFLAGS -fprofile-generate -LDFLAGS -fprofile-generate
Or, if calling make yourself, add -fprofile-generate appropriately to your Or, if calling make yourself, add -fprofile-generate appropriately to
Makefile. your Makefile.
2. Run your simulation. This will create \*.gcda file(s) in the same 2. Run your simulation. This will create \*.gcda file(s) in the same
directory as the source files. directory as the source files.
@ -601,19 +602,18 @@ Clang. The process in GCC 10 was as follows:
your Makefile. your Makefile.
Clang and GCC also support -fauto-profile, which uses sample-based Clang and GCC also support -fauto-profile, which uses sample-based
feedback-directed optimization. See the appropriate compiler feedback-directed optimization. See the appropriate compiler documentation.
documentation.
.. _Runtime Debugging: .. _runtime debugging:
Runtime Debugging Runtime Debugging
================= =================
To debug a Verilated executable, Verilate with :vlopt:`--runtime-debug`. To debug a Verilated executable, Verilate with :vlopt:`--runtime-debug`.
This will instruct the compiler to insert debugger, and enable various This will instruct the compiler to insert debugger, and enable various
library assertions. These options slow down the executable, so do this library assertions. These options slow down the executable, so do this only
only when debugging. when debugging.
If you are using your own Makefiles, adapt appropriately to pass the If you are using your own Makefiles, adapt appropriately to pass the
options documented under :vlopt:`--runtime-debug` to the compiler and options documented under :vlopt:`--runtime-debug` to the compiler and
@ -622,18 +622,18 @@ linker.
Once you have a debugging-enabled executable, run it using the the standard Once you have a debugging-enabled executable, run it using the the standard
GNU debugger ``gdb`` or a similar tool, and create a backtrace; e.g.: GNU debugger ``gdb`` or a similar tool, and create a backtrace; e.g.:
.. code-block:: bash .. code-block:: bash
gdb obj_dir/Vtop gdb obj_dir/Vtop
run {Vtop_command_arguments} run {Vtop_command_arguments}
{Vtop prints output, perhaps a segmentation faults} {Vtop prints output, perhaps a segmentation faults}
bt bt
Rarely the bug may disappear with :vlopt:`--runtime-debug`; if so, try Rarely the bug may disappear with :vlopt:`--runtime-debug`; if so, try
instead using the sub-options that :vlopt:`--runtime-debug` documents, to instead using the sub-options that :vlopt:`--runtime-debug` documents, to
find the maximum subset that still shows the issue. E.g. it is likely that find the maximum subset that still shows the issue. E.g. it is likely that
using `-CFLAGS -D_GLIBCXX_DEBUG` will not hide any bug, so may be used. using `-CFLAGS -D_GLIBCXX_DEBUG` will not hide any bug, so may be used.
Using :vlopt:`--runtime-debug` or `-CFLAGS -DVL_DEBUG=1` will only print a Using :vlopt:`--runtime-debug` or `-CFLAGS -DVL_DEBUG=1` will only print a
message if something goes wrong. To enable debug print messages at message if something goes wrong. To enable debug print messages at runtime,
runtime, additionally use the :vlopt:`+verilator+debug` runtime option. additionally use the :vlopt:`+verilator+debug` runtime option.

View File

@ -1,4 +1,4 @@
.. Copyright 2003-2025 by Wilson Snyder. .. Copyright 2003-2026 by Wilson Snyder.
.. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0 .. SPDX-License-Identifier: LGPL-3.0-only OR Artistic-2.0
********** **********
@ -8,11 +8,11 @@ Verilating
Verilator may be used in five major ways: Verilator may be used in five major ways:
* With the :vlopt:`--binary` option, Verilator will translate the design * With the :vlopt:`--binary` option, Verilator will translate the design
into an executable, via generating C++ and compiling it. See into an executable, via generating C++ and compiling it. See
:ref:`Binary, C++ and SystemC Generation`. :ref:`Binary, C++ and SystemC Generation`.
* With the :vlopt:`--cc` or :vlopt:`--sc` options, Verilator will translate * With the :vlopt:`--cc` or :vlopt:`--sc` options, Verilator will translate
the design into C++ or SystemC code, respectively. See :ref:`Binary, C++ the design into C++ or SystemC code, respectively. See :ref:`Binary, C++
and SystemC Generation`. and SystemC Generation`.
* With the :vlopt:`--lint-only` option, Verilator will lint the design to * With the :vlopt:`--lint-only` option, Verilator will lint the design to
@ -22,28 +22,28 @@ Verilator may be used in five major ways:
that may be used to feed into other user-designed tools. that may be used to feed into other user-designed tools.
* With the :vlopt:`-E` option, Verilator will preprocess the code according * With the :vlopt:`-E` option, Verilator will preprocess the code according
to IEEE preprocessing rules and write the output to standard out. This to IEEE preprocessing rules and write the output to standard out. This is
is useful to feed other tools and to debug how "\`define" statements are useful to feed other tools and to debug how "\`define" statements are
expanded. expanded.
.. _Binary, C++ and SystemC Generation: .. _binary, c++ and systemc generation:
Binary, C++ and SystemC Generation Binary, C++ and SystemC Generation
================================== ==================================
Verilator will translate a SystemVerilog design into C++ with the Verilator will translate a SystemVerilog design into C++ with the
:vlopt:`--cc` option, or into SystemC with the :vlopt:`--sc` option. It :vlopt:`--cc` option, or into SystemC with the :vlopt:`--sc` option. It
will translate into C++ and compile it into an executable binary with the will translate into C++ and compile it into an executable binary with the
:vlopt:`--binary` option. :vlopt:`--binary` option.
When using these options: When using these options:
#. Verilator reads the input Verilog code and determines all "top modules", that #. Verilator reads the input Verilog code and determines all "top modules",
is, modules or programs that are not used as instances under other cells. that is, modules or programs that are not used as instances under other
If :vlopt:`--top-module` is used, then that determines the top module, and cells. If :vlopt:`--top-module` is used, then that determines the top
all other top modules are removed; otherwise a :vlopt:`MULTITOP` warning module, and all other top modules are removed; otherwise a
is given. :vlopt:`MULTITOP` warning is given.
#. Verilator writes the C++/SystemC code to output files into the #. Verilator writes the C++/SystemC code to output files into the
:vlopt:`--Mdir` option-specified directory, or defaults to "obj_dir". :vlopt:`--Mdir` option-specified directory, or defaults to "obj_dir".
@ -65,22 +65,24 @@ Once a model is built, the next step is typically for the user to run it,
see :ref:`Simulating`. see :ref:`Simulating`.
.. _Finding and Binding Modules: .. _finding and binding modules:
Finding and Binding Modules Finding and Binding Modules
=========================== ===========================
Verilator provides several mechanisms to find the source code containing a Verilator provides several mechanisms to find the source code containing a
module, primitive, interface, or program ("module" in this section) and module, primitive, interface, or program ("module" in this section) and
bind them to an instantiation. These capabilities are similar to the bind them to an instantiation. These capabilities are similar to the
"Precompiling in a single-pass" use model described in IEEE 1800-2023 "Precompiling in a single-pass" use model described in IEEE 1800-2023
33.5.1, although `config` is not yet supported. 33.5.1.
Verilator first reads all files provided on the command line and Verilator first reads all files provided on the command line and
:vlopt:`-f` files, and parses all modules within. Each module is assigned :vlopt:`-f` files, and parses all modules within. Each module is assigned
to the most recent library specified with :vlopt:`-work`, thus `-work liba to the most recent library specified with :vlopt:`-work`, thus `-work liba
a.v -work libb b.v` will assign modules in `a.v` to `liba` and modules in a.v -work libb b.v` will assign modules in `a.v` to `liba` and modules in
`b.v` to `libb`. `b.v` to `libb`. In the absence of a `-work` mapping, each module is
optionally assigned to a library based on mappings provided by
:vlopt:`-libmap`.
If a module is not defined from a file on the command-line, Verilator If a module is not defined from a file on the command-line, Verilator
attempts to find a filename constructed from the module name using attempts to find a filename constructed from the module name using
@ -91,27 +93,27 @@ Verilator attempts to figure out the top module itself, and if multiple
tops result a :option:`MULTITOP` warning is issued which may be suppressed tops result a :option:`MULTITOP` warning is issued which may be suppressed
(see details in :option:`MULTITOP`). (see details in :option:`MULTITOP`).
Verilator will attempt to bind lower unresolved instances first in the same Verilator will attempt to bind lower unresolved instances based first on
library name as the parent's instantiation library, and if not found search IEEE `config` specifications, second based on using the same library name
globally across all libraries in the order modules were declared. This as the parent's instantiation library, and finally search globally across
allows otherwise conflicting duplicate module names between libraries to all libraries in the order modules were declared. This allows otherwise
coexist uniquely within each library name. When IEEE `config use` is conflicting duplicate module names between libraries to coexist uniquely
supported, more complicated selections will be able to be specified. within each library name.
.. _Hierarchical Verilation: .. _hierarchical verilation:
Hierarchical Verilation Hierarchical Verilation
======================= =======================
Large designs may take long (e.g., 10+ minutes) and huge memory (e.g., 100+ Large designs may take long (e.g., 10+ minutes) and huge memory (e.g., 100+
GB) to Verilate. In hierarchical mode, the user manually selects some GB) to Verilate. In hierarchical mode, the user manually selects some large
large lower-level hierarchy blocks to separate from the larger design. For lower-level hierarchy blocks to separate from the larger design. For
example, a core may be the hierarchy block separated out of a multi-core example, a core may be the hierarchy block separated out of a multi-core
SoC design. SoC design.
Verilator is run in hierarchical mode on the whole SoC. Verilator will Verilator is run in hierarchical mode on the whole SoC. Verilator will make
make two models, one for the CPU hierarchy block and one for the SoC. The two models, one for the CPU hierarchy block and one for the SoC. The
Verilated code for the SoC will automatically call the CPU Verilated model. Verilated code for the SoC will automatically call the CPU Verilated model.
The current hierarchical Verilation is based on :vlopt:`--lib-create`. Each The current hierarchical Verilation is based on :vlopt:`--lib-create`. Each
@ -135,7 +137,7 @@ The compilation is the same as when not using hierarchical mode.
.. code-block:: bash .. code-block:: bash
make -C obj_dir -f Vtop_module_name.mk make -C obj_dir -f Vtop_module_name.mk
Limitations Limitations
@ -165,20 +167,20 @@ But, the following usage is supported:
hierarchy blocks. hierarchy blocks.
* Parameterized hierarchy block. Parameters of a hierarchy block can be * Parameterized hierarchy block. Parameters of a hierarchy block can be
overridden using :code:`#(.param_name(value))` construct. overridden using ``#(.param_name(value))`` construct.
.. _Overlapping Verilation and Compilation: .. _overlapping verilation and compilation:
Overlapping Verilation and Compilation Overlapping Verilation and Compilation
-------------------------------------- --------------------------------------
Verilator needs to run 2 + *N* times in hierarchical Verilation, where *N* Verilator needs to run 2 + *N* times in hierarchical Verilation, where *N*
is the number of hierarchy blocks. One of the two is for the top module, is the number of hierarchy blocks. One of the two is for the top module,
which refers to the wrappers of all other hierarchy blocks. The second of the which refers to the wrappers of all other hierarchy blocks. The second of
two is the initial run that searches modules marked with the two is the initial run that searches modules marked with
:option:`/*verilator&32;hier_block*/` metacomment and creates a plan and :option:`/*verilator&32;hier_block*/` metacomment and creates a plan and
write in :file:`{prefix}_hier.mk`. This initial run internally invokes write in :file:`{prefix}_hier.mk`. This initial run internally invokes
other *N* + 1 runs, so you don't have to care about these *N* + 1 times of other *N* + 1 runs, so you don't have to care about these *N* + 1 times of
run. The additional *N* is the Verilator run for each hierarchical block. run. The additional *N* is the Verilator run for each hierarchical block.
@ -193,25 +195,25 @@ hierarchy blocks run simultaneously.
Cross Compilation Cross Compilation
================= =================
Verilator supports cross-compiling Verilated code. This is generally used Verilator supports cross-compiling Verilated code. This is generally used
to run Verilator on a Linux system and produce C++ code that is then compiled to run Verilator on a Linux system and produce C++ code that is then
on Windows. compiled on Windows.
Cross-compilation involves up to three different OSes. The build system is Cross-compilation involves up to three different OSes. The build system is
where you configure and compile Verilator, the host system is where you run where you configure and compile Verilator, the host system is where you run
Verilator, and the target system is where you compile the Verilated code Verilator, and the target system is where you compile the Verilated code
and run the simulation. and run the simulation.
Verilator requires the build and host system types to be the Verilator requires the build and host system types to be the same, though
same, though the target system type may be different. To support this, the target system type may be different. To support this,
:command:`./configure` and make Verilator on the build system. Then, run :command:`./configure` and make Verilator on the build system. Then, run
Verilator on the host system. Finally, the output of Verilator may be Verilator on the host system. Finally, the output of Verilator may be
compiled on the different target system. compiled on the different target system.
To support this, none of the files that Verilator produces will reference To support this, none of the files that Verilator produces will reference
any configure-generated build-system-specific files, such as any configure-generated build-system-specific files, such as
:file:`config.h` (which is renamed in Verilator to :file:`config_package.h` :file:`config.h` (which is renamed in Verilator to :file:`config_package.h`
to reduce confusion.) The disadvantage of this approach is that to reduce confusion.) The disadvantage of this approach is that
:file:`include/verilatedos.h` must self-detect the requirements of the :file:`include/verilatedos.h` must self-detect the requirements of the
target system, rather than using configure. target system, rather than using configure.
@ -220,7 +222,7 @@ Makefiles produced by Verilator presume the target system is the same type
as the build system. as the build system.
.. _Multithreading: .. _multithreading:
Multithreading Multithreading
============== ==============
@ -243,7 +245,7 @@ however, you can expect performance to be far worse than it would be with
the proper ratio of threads and CPU cores. the proper ratio of threads and CPU cores.
The thread used for constructing a model must be the same thread that calls The thread used for constructing a model must be the same thread that calls
:code:`eval()` into the model; this is called the "eval thread". The thread ``eval()`` into the model; this is called the "eval thread". The thread
used to perform certain global operations, such as saving and tracing, must used to perform certain global operations, such as saving and tracing, must
be done by a "main thread". In most cases, the eval thread and main thread be done by a "main thread". In most cases, the eval thread and main thread
are the same thread (i.e. the user's top C++ testbench runs on a single are the same thread (i.e. the user's top C++ testbench runs on a single
@ -257,12 +259,13 @@ time of DPI imports.
When using :vlopt:`--trace-vcd` to perform VCD tracing, the VCD trace When using :vlopt:`--trace-vcd` to perform VCD tracing, the VCD trace
construction is parallelized using the same number of threads as specified construction is parallelized using the same number of threads as specified
with :vlopt:`--threads`, and is executed on the same thread pool as the model. with :vlopt:`--threads`, and is executed on the same thread pool as the
model.
The :vlopt:`--trace-threads` options can be used with :vlopt:`--trace-fst` The :vlopt:`--trace-threads` options can be used with :vlopt:`--trace-fst`
to offload FST tracing using multiple threads. If :vlopt:`--trace-threads` is to offload FST tracing using multiple threads. If :vlopt:`--trace-threads`
given without :vlopt:`--threads`, then :vlopt:`--trace-threads` will imply is given without :vlopt:`--threads`, then :vlopt:`--trace-threads` will
:vlopt:`--threads 1 <--threads>`, i.e., the support libraries will be imply :vlopt:`--threads 1 <--threads>`, i.e., the support libraries will be
thread safe. thread safe.
With :vlopt:`--trace-threads 0 <--trace-threads>`, trace dumps are produced With :vlopt:`--trace-threads 0 <--trace-threads>`, trace dumps are produced
@ -271,8 +274,8 @@ on the main thread. This again gives the highest single-thread performance.
With :vlopt:`--trace-threads {N} <--trace-threads>`, where N is at least 1, With :vlopt:`--trace-threads {N} <--trace-threads>`, where N is at least 1,
up to N additional threads will be created and managed by the trace files up to N additional threads will be created and managed by the trace files
(e.g., VerilatedFstC), to offload construction of the trace dump. The main (e.g., VerilatedFstC), to offload construction of the trace dump. The main
thread will be released to proceed with execution as soon as possible, though thread will be released to proceed with execution as soon as possible,
some main thread blocking is still necessary while capturing the though some main thread blocking is still necessary while capturing the
trace. FST tracing can utilize up to 2 offload threads, so there is no use trace. FST tracing can utilize up to 2 offload threads, so there is no use
of setting :vlopt:`--trace-threads` higher than 2 at the moment. of setting :vlopt:`--trace-threads` higher than 2 at the moment.
@ -286,34 +289,34 @@ For best performance, use the :command:`numactl` program to (when the
threading count fits) select unique physical cores on the same socket. The threading count fits) select unique physical cores on the same socket. The
same applies for :vlopt:`--trace-threads` as well. same applies for :vlopt:`--trace-threads` as well.
As an example, if a model was Verilated with As an example, if a model was Verilated with :vlopt:`--threads 4
:vlopt:`--threads 4 <--threads>`, we consult: <--threads>`, we consult:
.. code-block:: bash .. code-block:: bash
egrep 'processor|physical id|core id' /proc/cpuinfo egrep 'processor|physical id|core id' /proc/cpuinfo
To select cores 0, 1, 2, and 3 that are all located on the same socket (0) To select cores 0, 1, 2, and 3 that are all located on the same socket (0)
but have different physical cores. (Also useful is but have different physical cores. (Also useful is :command:`numactl
:command:`numactl --hardware`, or :command:`lscpu`, but those don't show --hardware`, or :command:`lscpu`, but those don't show hyperthreading
hyperthreading cores.) Then we execute: cores.) Then we execute:
.. code-block:: bash .. code-block:: bash
numactl -m 0 -C 0,1,2,3 -- verilated_executable_name numactl -m 0 -C 0,1,2,3 -- verilated_executable_name
This will limit memory to socket 0, and threads to cores 0, 1, 2, 3, This will limit memory to socket 0, and threads to cores 0, 1, 2, 3,
(presumably on socket 0), optimizing performance. Of course, this must be (presumably on socket 0), optimizing performance. Of course, this must be
adjusted if you want another simulator to use, e.g., socket 1, or if you adjusted if you want another simulator to use, e.g., socket 1, or if you
Verilated with a different number of threads. To see what CPUs are Verilated with a different number of threads. To see what CPUs are actually
actually used, use :vlopt:`--prof-exec`. used, use :vlopt:`--prof-exec`.
Multithreaded Verilog and Library Support Multithreaded Verilog and Library Support
----------------------------------------- -----------------------------------------
$display/$stop/$finish are delayed until the end of an eval() call $display/$stop/$finish are delayed until the end of an eval() call to
to maintain ordering between threads. This may result in additional tasks maintain ordering between threads. This may result in additional tasks
completing after the $stop or $finish. completing after the $stop or $finish.
If using :vlopt:`--coverage`, the coverage routines are fully thread-safe. If using :vlopt:`--coverage`, the coverage routines are fully thread-safe.
@ -335,19 +338,19 @@ IEEE to be multithreaded, Verilator requires all VPI calls are only made
from the main thread. from the main thread.
.. _GNU Make: .. _gnu make:
GNU Make GNU Make
======== ========
Verilator defaults to creating GNU Make makefiles for the model. Verilator Verilator defaults to creating GNU Make makefiles for the model. Verilator
will call make automatically when the :vlopt:`--build` option is used. will call make automatically when the :vlopt:`--build` option is used.
If calling Verilator from a makefile, the :vlopt:`--MMD` option will create If calling Verilator from a makefile, the :vlopt:`--MMD` option will create
a dependency file, allowing Make to only run Verilator if input Verilog a dependency file, allowing Make to only run Verilator if input Verilog
files change. files change.
.. _CMake: .. _cmake:
CMake CMake
===== =====
@ -359,13 +362,13 @@ would build the code listed in :ref:`Example C++ Execution`
.. code-block:: CMake .. code-block:: CMake
project(cmake_example) project(cmake_example)
find_package(verilator HINTS $ENV{VERILATOR_ROOT}) find_package(verilator HINTS $ENV{VERILATOR_ROOT})
add_executable(Vour sim_main.cpp) add_executable(Vour sim_main.cpp)
verilate(Vour SOURCES our.v) verilate(Vour SOURCES our.v)
:code:`find_package` will automatically find an installed copy of ``find_package`` will automatically find an installed copy of Verilator, or
Verilator, or use a local build if VERILATOR_ROOT is set. use a local build if VERILATOR_ROOT is set.
Using CMake >= 3.12 and the Ninja generator is recommended, though other Using CMake >= 3.12 and the Ninja generator is recommended, though other
combinations should work. To build with CMake, change to the folder combinations should work. To build with CMake, change to the folder
@ -373,42 +376,42 @@ containing CMakeLists.txt and run:
.. code-block:: bash .. code-block:: bash
mkdir build mkdir build
cd build cd build
cmake -GNinja .. cmake -GNinja ..
ninja ninja
Or to build with your system default generator: Or to build with your system default generator:
.. code-block:: bash .. code-block:: bash
mkdir build mkdir build
cd build cd build
cmake .. cmake ..
cmake --build . cmake --build .
If you're building the example, you should have an executable to run: If you're building the example, you should have an executable to run:
.. code-block:: bash .. code-block:: bash
./Vour ./Vour
The package sets the CMake variables verilator_FOUND, VERILATOR_ROOT, The package sets the CMake variables verilator_FOUND, VERILATOR_ROOT, and
and VERILATOR_BIN to the appropriate values and creates a verilate() VERILATOR_BIN to the appropriate values and creates a verilate() function.
function. verilate() will automatically create custom commands to run verilate() will automatically create custom commands to run Verilator and
Verilator and add the generated C++ sources to the target specified. add the generated C++ sources to the target specified.
Verilate in CMake Verilate in CMake
----------------- -----------------
.. code-block:: CMake .. code-block:: CMake
verilate(target SOURCES source ... [TOP_MODULE top] [PREFIX name] verilate(target SOURCES source ... [TOP_MODULE top] [PREFIX name]
[COVERAGE] [SYSTEMC] [COVERAGE] [SYSTEMC]
[TRACE_FST] [TRACE_SAIF] [TRACE_VCD] [TRACE_THREADS num] [TRACE_FST] [TRACE_SAIF] [TRACE_VCD] [TRACE_THREADS num]
[INCLUDE_DIRS dir ...] [OPT_SLOW ...] [OPT_FAST ...] [INCLUDE_DIRS dir ...] [OPT_SLOW ...] [OPT_FAST ...]
[OPT_GLOBAL ..] [DIRECTORY dir] [THREADS num] [OPT_GLOBAL ..] [DIRECTORY dir] [THREADS num]
[VERILATOR_ARGS ...]) [VERILATOR_ARGS ...])
Lowercase and ... should be replaced with arguments; the uppercase parts Lowercase and ... should be replaced with arguments; the uppercase parts
delimit the arguments and can be passed in any order or left out entirely delimit the arguments and can be passed in any order or left out entirely
@ -417,8 +420,8 @@ if optional.
verilate(target ...) can be called multiple times to add other Verilog verilate(target ...) can be called multiple times to add other Verilog
modules to an executable or library target. modules to an executable or library target.
When generating Verilated SystemC sources, you should list the When generating Verilated SystemC sources, you should list the SystemC
SystemC include directories and link to the SystemC libraries. include directories and link to the SystemC libraries.
.. describe:: target .. describe:: target
@ -519,11 +522,11 @@ SystemC Link in CMake
--------------------- ---------------------
Verilator's CMake support provides a convenience function to automatically Verilator's CMake support provides a convenience function to automatically
find and link to the SystemC library. It can be used as: find and link to the SystemC library. It can be used as:
.. code-block:: CMake .. code-block:: CMake
verilator_link_systemc(target) verilator_link_systemc(target)
where target is the name of your target. where target is the name of your target.
@ -547,7 +550,7 @@ The search paths can be configured by setting some variables:
SYSTEMC_ROOT). SYSTEMC_ROOT).
.. _Verilation Summary Report: .. _verilation summary report:
Verilation Summary Report Verilation Summary Report
========================= =========================
@ -557,11 +560,11 @@ will print a report to stdout summarizing the build. For example:
.. code-block:: .. code-block::
- V e r i l a t i o n R e p o r t: Verilator .... - V e r i l a t i o n R e p o r t: Verilator ....
- Verilator: Built from 354 MB sources in 247 modules, - Verilator: Built from 354 MB sources in 247 modules,
into 74 MB in 89 C++ files needing 0.192 MB into 74 MB in 89 C++ files needing 0.192 MB
- Verilator: Walltime 26.580 s (elab=2.096, cvt=18.268, - Verilator: Walltime 26.580 s (elab=2.096, cvt=18.268,
bld=2.100); cpu 26.548 s on 1 threads; alloced 2894.672 MB bld=2.100); cpu 26.548 s on 1 threads; alloced 2894.672 MB
The information in this report is: The information in this report is:

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -1,11 +1,16 @@
ABCp ABCp
Aadi Aadi
Accellera Accellera
Aditya
Affe Affe
Aleksander Aleksander
Alexandre Alexandre
Alkhatib
Almis
Amal
Ami Ami
Amir Amir
Amirreza
Anastasiadis Anastasiadis
Anglin Anglin
Anikin Anikin
@ -13,6 +18,7 @@ Antmicro
Antonin Antonin
Antwerpen Antwerpen
Arasanipalai Arasanipalai
Araweelo
Arjen Arjen
Arshid Arshid
Asciidoc Asciidoc
@ -34,8 +40,10 @@ Biancolin
Binderman Binderman
Björk Björk
Bleiweiss Bleiweiss
Boden
Bogdan Bogdan
Bonneau Bonneau
Borgne
Bouchard Bouchard
Boumenot Boumenot
Brej Brej
@ -55,8 +63,10 @@ Cherkasov
Chih Chih
Chitlesh Chitlesh
Christophe Christophe
Chusov
Cochrane Cochrane
Conda Conda
Connor
Corteggiani Corteggiani
Cozzocrea Cozzocrea
Cuan Cuan
@ -87,11 +97,13 @@ Dinotrace
Djordjevic Djordjevic
Dobbie Dobbie
Dockerfile Dockerfile
Domenic
Donal Donal
Donovick Donovick
Doorn Doorn
Doxygen Doxygen
Dressler Dressler
Driscoll
Dudek Dudek
Duraid Duraid
Dutton Dutton
@ -105,6 +117,7 @@ Eiler
Eivind Eivind
El El
Elbourne Elbourne
Eldridge
Elzeftawi Elzeftawi
Embecosm Embecosm
Engstrom Engstrom
@ -117,18 +130,22 @@ Faure
Feinberg Feinberg
Fekete Fekete
Ferrandi Ferrandi
Fiergolski
Filip Filip
Flachs Flachs
Flavien Flavien
Florian Florian
Foletto Foletto
Fonarev
Forencich Forencich
Forker Forker
Fractile
Francillon Francillon
Fredieu Fredieu
Freiberger Freiberger
Frédéric Frédéric
GTKWave GTKWave
Gagnon
Galbi Galbi
Gantt Gantt
Garnal Garnal
@ -146,24 +163,30 @@ Gisselquist
Gladkikh Gladkikh
GmbH GmbH
Goessling Goessling
Goh
Gonnen Gonnen
Goorah Goorah
Gossner Gossner
Goto
Graba Graba
Graphviz Graphviz
Graybeal Graybeal
Grobman Grobman
Grulfen Grulfen
Gu Gu
Gugala
Gunter Gunter
Guo Guo
Gustafsson
Güzel Güzel
Hameed Hameed
Hammoud
Hao Hao
Haojin Haojin
Harboe Harboe
Hashimoto Hashimoto
Hayenga Hayenga
Heng
Hesselbarth Hesselbarth
Hewson Hewson
Hicamp Hicamp
@ -181,6 +204,7 @@ Hyperthreading
Ibrahim Ibrahim
Ikram Ikram
Iles Iles
Ille
Inlines Inlines
Inout Inout
Iru Iru
@ -194,10 +218,14 @@ Jannis
Jasen Jasen
Jens Jens
Jeras Jeras
Jha
Jian
Jiaxun Jiaxun
Jitesh
Jiuyang Jiuyang
Joannou Joannou
Joly Joly
Jongenburger
Josse Josse
Jullien Jullien
Junji Junji
@ -215,6 +243,8 @@ Karge
Karlsson Karlsson
Katz Katz
Katzman Katzman
Kazemi
Kees
Kelin Kelin
Keren Keren
Keyi Keyi
@ -234,6 +264,7 @@ Kouping
Kravitz Kravitz
Krolnik Krolnik
Kruse Kruse
Kubalek
Kumashikar Kumashikar
Kuoping Kuoping
Kurachi Kurachi
@ -255,6 +286,7 @@ Lockhart
Longo Longo
LteS LteS
Luca Luca
Lueker
Luiza Luiza
Lussier Lussier
Lübeck Lübeck
@ -268,6 +300,7 @@ Mahmoudy
Makefile Makefile
Makefiles Makefiles
Maksymenko Maksymenko
Marche
Markley Markley
Marquet Marquet
Matveyenko Matveyenko
@ -293,6 +326,7 @@ ModelSim
Modport Modport
Moinak Moinak
Mong Mong
Mora
Muhlestein Muhlestein
Multithreaded Multithreaded
Multithreading Multithreading
@ -305,31 +339,40 @@ Narayan
Narcis Narcis
Nassim Nassim
Nauticus Nauticus
Nayak
Nenakhov
Newgard Newgard
Nigam Nigam
Nikana Nikana
Nikolay
Niraj Niraj
Niranjan Niranjan
Nitza Nitza
Noack Noack
Nodine Nodine
Nurczyński
Ober Ober
Oleg Oleg
Oler Oler
Olof Olof
Olofsson Olofsson
Ondrej
Oron Oron
Oyvind Oyvind
PLI PLI
Palaniappan Palaniappan
Patricio Patricio
Peltonen
Petr Petr
Petrisko
Pham
Piard Piard
Piechotka Piechotka
Piersall Piersall
Platz Platz
Platzer Platzer
Plunkett Plunkett
Poikela
Popolon Popolon
Popov Popov
Prabhat Prabhat
@ -345,16 +388,19 @@ Priyadharshini
Pullup Pullup
Pulver Pulver
Puri Puri
Puzanov
Qin Qin
Qiu Qiu
Questa Questa
Rachit Rachit
Ralf Ralf
Ranjan
Rapp Rapp
Redhat Redhat
Reitan Reitan
Renga Renga
Requin Requin
Riaz
Rodas Rodas
Rodionov Rodionov
Rohan Rohan
@ -362,10 +408,12 @@ Rolfe
Rontionov Rontionov
Roodselaar Roodselaar
Roshit Roshit
Ruelas
Rufer Rufer
Runtime Runtime
Ruud Ruud
Rystsov Rystsov
Rémi
STandarD STandarD
Salman Salman
Sammelson Sammelson
@ -373,6 +421,7 @@ Sanggyu
Sanguinetti Sanguinetti
Sanjay Sanjay
Sasselli Sasselli
Sauter
Scharrer Scharrer
Schless Schless
Seitz Seitz
@ -388,6 +437,7 @@ Shi
Shinkarovsky Shinkarovsky
Shinya Shinya
Shirakawa Shirakawa
Shivaram
Shou Shou
Shuba Shuba
Shunyao Shunyao
@ -437,12 +487,15 @@ Timi
Tomov Tomov
Tood Tood
Topa Topa
Toshiki
Tota Tota
Trefor Trefor
Tresidder Tresidder
Tri Tri
Tristate Tristate
Truong Truong
Tung
Tuomas
Turton Turton
UNOPTFLAT UNOPTFLAT
Ubixum Ubixum
@ -451,6 +504,7 @@ Uints
Undefine Undefine
Undefines Undefines
Unsized Unsized
Uppal
Urbach Urbach
Uselib Uselib
Usha Usha
@ -479,7 +533,9 @@ Vlip
Vm Vm
Vukobratovic Vukobratovic
Wai Wai
Wajahat
Wasson Wasson
Weijie
Welch Welch
Werror Werror
Wfuture Wfuture
@ -495,10 +551,12 @@ Wouters
Wpedantic Wpedantic
Wunused Wunused
Wwarn Wwarn
Wüthrich
XSim XSim
Xcelium Xcelium
Xiaoliang Xiaoliang
Xiaoyi Xiaoyi
Xie
Xuan Xuan
Xuanqi Xuanqi
Yao Yao
@ -612,6 +670,7 @@ countbits
countones countones
cout cout
covergroup covergroup
covergroups
cpp cpp
cppstyle cppstyle
cpu cpu
@ -619,6 +678,7 @@ cpure
ctor ctor
ctrace ctrace
cutable cutable
cxx
cygwin cygwin
dM dM
da da
@ -713,6 +773,7 @@ expr
extern extern
ezchi ezchi
fanin fanin
fargs
fasttrace fasttrace
fauto fauto
fbranch fbranch
@ -792,6 +853,7 @@ incdir
includer includer
incrementing incrementing
inferfaces inferfaces
informationals
inhibitSim inhibitSim
initarray initarray
initializer initializer
@ -813,6 +875,7 @@ jobserver
json json
jwoutersymatra jwoutersymatra
killua killua
kiow
lang lang
lcov lcov
ld ld
@ -821,6 +884,7 @@ len
libc libc
libext libext
libgoogle libgoogle
liblist
libsystemc libsystemc
libtcmalloc libtcmalloc
libverilated libverilated
@ -876,6 +940,7 @@ multipoint
multithread multithread
multithreaded multithreaded
multithreading multithreading
multitop
musl musl
mutex mutex
mutexes mutexes
@ -976,6 +1041,8 @@ qrqiuren
radix radix
randc randc
randcase randcase
randmode
randsequence
randstate randstate
raphmaster raphmaster
rarr rarr
@ -1138,6 +1205,7 @@ vcoverage
vdhotre vdhotre
vec vec
ventana ventana
venv
ver ver
verFiles verFiles
verible verible
@ -1150,6 +1218,7 @@ verimake
veriuser veriuser
vl vl
vlSelf vlSelf
vla
vlopt vlopt
vlt vlt
vltstd vltstd
@ -1161,6 +1230,7 @@ vpiInertialDelay
vpiInstance vpiInstance
vpiLeftRange vpiLeftRange
vpiModule vpiModule
vpiSigned
vpiSize vpiSize
vpiSuppressVal vpiSuppressVal
vpiTimeUnit vpiTimeUnit

View File

@ -29,48 +29,47 @@ Structure
The XML document consists of 4 sections within the top level The XML document consists of 4 sections within the top level
``verilator_xml`` element: ``verilator_xml`` element:
``<files>``\ ... ``</files>`` ``<files>``... ``</files>``
This section contains a list of all design files read, including the This section contains a list of all design files read, including the
built-in constructs and the command line as their own entries. Each built-in constructs and the command line as their own entries. Each
``<file>`` has an attribute ``id`` which is a short ASCII string ``<file>`` has an attribute ``id`` which is a short ASCII string unique
unique to that file. Other elements' ``loc`` attributes use this id to that file. Other elements' ``loc`` attributes use this id to refer to
to refer to a particular file. a particular file.
``<module_files>``\ ... ``</module_files>`` ``<module_files>``... ``</module_files>``
All files containing Verilog module definitions are listed in this All files containing Verilog module definitions are listed in this
section. This element's contents is a subset of the ``<files>`` section. This element's contents is a subset of the ``<files>``
element's contents. element's contents.
``<cells>``\ ... ``</cells>`` ``<cells>``... ``</cells>``
The cells section of the XML document contains the design instance The cells section of the XML document contains the design instance
hierarchy. Each instance is represented with the ``<cell>`` element hierarchy. Each instance is represented with the ``<cell>`` element with
with the following attributes: the following attributes:
- ``loc``: The file id, first line number, last line number, first - ``loc``: The file id, first line number, last line number, first
column number and last column number of the identifier where the column number and last column number of the identifier where the
module was instanced, separated by commas. module was instanced, separated by commas.
- ``name``: The instance name. - ``name``: The instance name.
- ``submodname``: The module name uniquified with particular - ``submodname``: The module name uniquified with particular parameter
parameter values (if any). values (if any).
- ``hier``: The full hierarchy path. - ``hier``: The full hierarchy path.
``<netlist>``\ ... ``</netlist>`` ``<netlist>``... ``</netlist>``
The netlist section contains a number of The netlist section contains a number of ``<module>``... ``</module>``
``<module>``\ ... ``</module>`` elements, each describing the elements, each describing the contents of that module, and a single
contents of that module, and a single ``<typetable>``\ ... ``<typetable>``... ``</typetable>`` element which lists all used types
``</typetable>`` element which lists all used types used within the used within the modules. Each type has a numeric ``id`` attribute that
modules. Each type has a numeric ``id`` attribute that is referred to is referred to by elements in the ``<module>`` elements using the
by elements in the ``<module>`` elements using the ``dtype_id`` ``dtype_id`` attribute.
attribute.
Distribution Distribution
============ ============
Copyright 2020-2025 by Wilson Snyder. Verilator is free software; you can Copyright 2020-2026 by Wilson Snyder. Verilator is free software; you can
redistribute it and/or modify it under the terms of either the GNU Lesser 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. General Public License Version 3 or the Perl Artistic License Version 2.0.

View File

@ -5,12 +5,12 @@
// SPDX-License-Identifier: CC0-1.0 // SPDX-License-Identifier: CC0-1.0
// ====================================================================== // ======================================================================
module sub module sub #(
#(parameter type TYPE_t = logic) parameter type TYPE_t = logic
( ) (
input TYPE_t in, input TYPE_t in,
output TYPE_t out output TYPE_t out
); );
// Some simple logic // Some simple logic
always_comb out = ~in; always_comb out = ~in;

View File

@ -5,29 +5,37 @@
// SPDX-License-Identifier: CC0-1.0 // SPDX-License-Identifier: CC0-1.0
// ====================================================================== // ======================================================================
module top module top (
( input clk,
input clk, input fastclk,
input fastclk, input reset_l,
input reset_l,
output wire [1:0] out_small, output wire [1:0] out_small,
output wire [39:0] out_quad, output wire [39:0] out_quad,
output wire [69:0] out_wide, output wire [69:0] out_wide,
input [1:0] in_small, input [1:0] in_small,
input [39:0] in_quad, input [39:0] in_quad,
input [69:0] in_wide input [69:0] in_wide
); );
sub #(.TYPE_t(logic [1:0])) sub_small sub #(
(.in(in_small), .TYPE_t(logic [1:0])
.out(out_small)); ) sub_small (
.in(in_small),
.out(out_small)
);
sub #(.TYPE_t(logic [39:0])) sub_quad sub #(
(.in(in_quad), .TYPE_t(logic [39:0])
.out(out_quad)); ) sub_quad (
.in(in_quad),
.out(out_quad)
);
sub #(.TYPE_t(logic [69:0])) sub_wide sub #(
(.in(in_wide), .TYPE_t(logic [69:0])
.out(out_wide)); ) sub_wide (
.in(in_wide),
.out(out_wide)
);
endmodule endmodule

View File

@ -7,13 +7,13 @@
// This module will be used as libsecret.a or libsecret.so without // This module will be used as libsecret.a or libsecret.so without
// exposing the source. // exposing the source.
module secret_impl module secret_impl (
( input [31:0] a,
input [31:0] a, input [31:0] b,
input [31:0] b, output logic [31:0] x,
output logic [31:0] x, input clk,
input clk, input reset_l
input reset_l); );
logic [31:0] accum_q; logic [31:0] accum_q;
logic [31:0] secret_value; logic [31:0] secret_value;
@ -27,10 +27,8 @@ module secret_impl
end end
else begin else begin
accum_q <= accum_q + a; accum_q <= accum_q + a;
if (accum_q > 10) if (accum_q > 10) x <= b;
x <= b; else x <= a + b + secret_value;
else
x <= a + b + secret_value;
end end
end end

View File

@ -6,7 +6,9 @@
// See also https://verilator.org/guide/latest/examples.html" // See also https://verilator.org/guide/latest/examples.html"
module top (input clk); module top (
input clk
);
int cyc; int cyc;
logic reset_l; logic reset_l;
@ -14,7 +16,13 @@ module top (input clk);
logic [31:0] b; logic [31:0] b;
logic [31:0] x; logic [31:0] x;
verilated_secret secret (.a, .b, .x, .clk, .reset_l); verilated_secret secret (
.a,
.b,
.x,
.clk,
.reset_l
);
always @(posedge clk) begin always @(posedge clk) begin
$display("[%0t] cyc=%0d a=%0d b=%0d x=%0d", $time, cyc, a, b, x); $display("[%0t] cyc=%0d a=%0d b=%0d x=%0d", $time, cyc, a, b, x);

View File

@ -38,6 +38,10 @@ int main(int argc, char** argv) {
// May be overridden by commandArgs argument parsing // May be overridden by commandArgs argument parsing
contextp->debug(0); contextp->debug(0);
// Peak number of threads the model will use
// (e.g. match the --threads setting of the Verilation)
contextp->threads(1);
// Randomization reset policy // Randomization reset policy
// May be overridden by commandArgs argument parsing // May be overridden by commandArgs argument parsing
contextp->randReset(2); contextp->randReset(2);

View File

@ -5,11 +5,10 @@
// SPDX-License-Identifier: CC0-1.0 // SPDX-License-Identifier: CC0-1.0
// ====================================================================== // ======================================================================
module sub module sub (
( input clk,
input clk, input reset_l
input reset_l );
);
// Example counter/flop // Example counter/flop
reg [31:0] count_c; reg [31:0] count_c;

View File

@ -8,24 +8,23 @@
// This is intended to be a complex example of several features, please also // This is intended to be a complex example of several features, please also
// see the simpler examples/make_hello_c. // see the simpler examples/make_hello_c.
module top module top (
( // Declare some signals so we can see how I/O works
// Declare some signals so we can see how I/O works input clk,
input clk, input reset_l,
input reset_l,
output wire [1:0] out_small, output wire [1:0] out_small,
output wire [39:0] out_quad, output wire [39:0] out_quad,
output wire [69:0] out_wide, output wire [69:0] out_wide,
input [1:0] in_small, input [1:0] in_small,
input [39:0] in_quad, input [39:0] in_quad,
input [69:0] in_wide input [69:0] in_wide
); );
// Connect up the outputs, using some trivial logic // Connect up the outputs, using some trivial logic
assign out_small = ~reset_l ? '0 : (in_small + 2'b1); assign out_small = ~reset_l ? '0 : (in_small + 2'b1);
assign out_quad = ~reset_l ? '0 : (in_quad + 40'b1); assign out_quad = ~reset_l ? '0 : (in_quad + 40'b1);
assign out_wide = ~reset_l ? '0 : (in_wide + 70'b1); assign out_wide = ~reset_l ? '0 : (in_wide + 70'b1);
// And an example sub module. The submodule will print stuff. // And an example sub module. The submodule will print stuff.
sub sub (/*AUTOINST*/ sub sub (/*AUTOINST*/

View File

@ -5,12 +5,11 @@
// SPDX-License-Identifier: CC0-1.0 // SPDX-License-Identifier: CC0-1.0
// ====================================================================== // ======================================================================
module sub module sub (
( input clk,
input clk, input fastclk,
input fastclk, input reset_l
input reset_l );
);
// Example counter/flop // Example counter/flop
reg [31:0] count_f; reg [31:0] count_f;

View File

@ -8,25 +8,24 @@
// This is intended to be a complex example of several features, please also // This is intended to be a complex example of several features, please also
// see the simpler examples/make_hello_c. // see the simpler examples/make_hello_c.
module top module top (
( // Declare some signals so we can see how I/O works
// Declare some signals so we can see how I/O works input clk,
input clk, input fastclk,
input fastclk, input reset_l,
input reset_l,
output wire [1:0] out_small, output wire [1:0] out_small,
output wire [39:0] out_quad, output wire [39:0] out_quad,
output wire [69:0] out_wide, output wire [69:0] out_wide,
input [1:0] in_small, input [1:0] in_small,
input [39:0] in_quad, input [39:0] in_quad,
input [69:0] in_wide input [69:0] in_wide
); );
// Connect up the outputs, using some trivial logic // Connect up the outputs, using some trivial logic
assign out_small = ~reset_l ? '0 : (in_small + 2'b1); assign out_small = ~reset_l ? '0 : (in_small + 2'b1);
assign out_quad = ~reset_l ? '0 : (in_quad + 40'b1); assign out_quad = ~reset_l ? '0 : (in_quad + 40'b1);
assign out_wide = ~reset_l ? '0 : (in_wide + 70'b1); assign out_wide = ~reset_l ? '0 : (in_wide + 70'b1);
// And an example sub module. The submodule will print stuff. // And an example sub module. The submodule will print stuff.
sub sub (/*AUTOINST*/ sub sub (/*AUTOINST*/

View File

@ -3,7 +3,7 @@
// //
// Code available from: https://verilator.org // Code available from: https://verilator.org
// //
// Copyright 2003-2025 by Wilson Snyder. This program is free software; you can // Copyright 2003-2026 by Wilson Snyder. This program is free software; you can
// redistribute it and/or modify it under the terms of either the GNU // redistribute it and/or modify it under the terms of either the GNU
// Lesser General Public License Version 3 or the Perl Artistic License // Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0. // Version 2.0.
@ -3415,18 +3415,6 @@ VerilatedModel::VerilatedModel(VerilatedContext& context)
std::unique_ptr<VerilatedTraceConfig> VerilatedModel::traceConfig() const { return nullptr; } std::unique_ptr<VerilatedTraceConfig> VerilatedModel::traceConfig() const { return nullptr; }
//===========================================================================
// VerilatedModule:: Methods
VerilatedModule::VerilatedModule(const char* namep)
: m_namep{strdup(namep)} {}
VerilatedModule::~VerilatedModule() {
// Memory cleanup - not called during normal operation
// cppcheck-suppress cstyleCast // NOLINTNEXTLINE(google-readability-casting)
if (m_namep) VL_DO_CLEAR(free((void*)(m_namep)), m_namep = nullptr);
}
//====================================================================== //======================================================================
// VerilatedVar:: Methods // VerilatedVar:: Methods
@ -3466,37 +3454,36 @@ void* VerilatedVarProps::datapAdjustIndex(void* datap, int dim, int indx) const
//====================================================================== //======================================================================
// VerilatedScope:: Methods // VerilatedScope:: Methods
VerilatedScope::~VerilatedScope() { VerilatedScope::VerilatedScope(VerilatedSyms* symsp, const char* suffixp, const char* identifier,
// Memory cleanup - not called during normal operation const char* defnamep, int8_t timeunit, Type type)
Verilated::threadContextp()->impp()->scopeErase(this); : m_symsp{symsp}
if (m_namep) VL_DO_CLEAR(delete[] m_namep, m_namep = nullptr); , m_namep{[symsp, suffixp]() {
if (m_callbacksp) VL_DO_CLEAR(delete[] m_callbacksp, m_callbacksp = nullptr); // We don't want the space and reference-count access overhead of strings.
if (m_varsp) VL_DO_CLEAR(delete m_varsp, m_varsp = nullptr); const char* prefixp = symsp->name();
m_funcnumMax = 0; // Force callback table to empty
}
void VerilatedScope::configure(VerilatedSyms* symsp, const char* prefixp, const char* suffixp,
const char* identifier, const char* defnamep, int8_t timeunit,
const Type& type) VL_MT_UNSAFE {
// Slowpath - called once/scope at construction
// We don't want the space and reference-count access overhead of strings.
m_symsp = symsp;
m_type = type;
m_timeunit = timeunit;
{
char* const namep = new char[std::strlen(prefixp) + std::strlen(suffixp) + 2]; char* const namep = new char[std::strlen(prefixp) + std::strlen(suffixp) + 2];
char* dp = namep; char* dp = namep;
for (const char* sp = prefixp; *sp;) *dp++ = *sp++; for (const char* sp = prefixp; *sp;) *dp++ = *sp++;
if (*prefixp && *suffixp) *dp++ = '.'; if (*prefixp && *suffixp) *dp++ = '.';
for (const char* sp = suffixp; *sp;) *dp++ = *sp++; for (const char* sp = suffixp; *sp;) *dp++ = *sp++;
*dp++ = '\0'; *dp++ = '\0';
m_namep = namep; return namep;
} }()}
m_identifierp = identifier; , m_identifierp{identifier}
m_defnamep = defnamep; , m_defnamep{defnamep}
, m_timeunit{timeunit}
, m_type{type} {
Verilated::threadContextp()->impp()->scopeInsert(this); Verilated::threadContextp()->impp()->scopeInsert(this);
} }
VerilatedScope::~VerilatedScope() {
// Memory cleanup - not called during normal operation
Verilated::threadContextp()->impp()->scopeErase(this);
VL_DO_DANGLING(delete[] m_namep, m_namep);
VL_DO_DANGLING(delete[] m_callbacksp, m_callbacksp);
VL_DO_DANGLING(delete m_varsp, m_varsp);
VL_DEBUG_IFDEF(m_funcnumMax = 0;);
}
void VerilatedScope::exportInsert(int finalize, const char* namep, void* cb) VL_MT_UNSAFE { void VerilatedScope::exportInsert(int finalize, const char* namep, void* cb) VL_MT_UNSAFE {
// Slowpath - called once/scope*export at construction // Slowpath - called once/scope*export at construction
// Insert a exported function into scope table // Insert a exported function into scope table
@ -3518,13 +3505,12 @@ void VerilatedScope::exportInsert(int finalize, const char* namep, void* cb) VL_
} }
} }
void VerilatedScope::varInsert(int finalize, const char* namep, void* datap, bool isParam, void VerilatedScope::varInsert(const char* namep, void* datap, bool isParam,
VerilatedVarType vltype, int vlflags, int udims, VerilatedVarType vltype, int vlflags, int udims,
int pdims...) VL_MT_UNSAFE { int pdims...) VL_MT_UNSAFE {
// Grab dimensions // Grab dimensions
// In the future we may just create a large table at emit time and // In the future we may just create a large table at emit time and
// statically construct from that. // statically construct from that.
if (!finalize) return;
if (!m_varsp) m_varsp = new VerilatedVarNameMap; if (!m_varsp) m_varsp = new VerilatedVarNameMap;
VerilatedVar var(namep, datap, vltype, static_cast<VerilatedVarFlags>(vlflags), udims, pdims, VerilatedVar var(namep, datap, vltype, static_cast<VerilatedVarFlags>(vlflags), udims, pdims,
@ -3598,6 +3584,8 @@ void VerilatedHierarchy::remove(const VerilatedScope* fromp, const VerilatedScop
VerilatedImp::hierarchyRemove(fromp, top); VerilatedImp::hierarchyRemove(fromp, top);
} }
void VerilatedHierarchy::clear() { VerilatedImp::hierarchyClear(); }
//=========================================================================== //===========================================================================
// VerilatedOneThreaded:: Methods // VerilatedOneThreaded:: Methods

View File

@ -3,7 +3,7 @@
// //
// Code available from: https://verilator.org // Code available from: https://verilator.org
// //
// Copyright 2003-2025 by Wilson Snyder. This program is free software; you can // Copyright 2003-2026 by Wilson Snyder. This program is free software; you can
// redistribute it and/or modify it under the terms of either the GNU // redistribute it and/or modify it under the terms of either the GNU
// Lesser General Public License Version 3 or the Perl Artistic License // Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0. // Version 2.0.
@ -154,7 +154,8 @@ enum VerilatedVarFlags {
// Flags // Flags
VLVF_PUB_RD = (1 << 8), // Public readable VLVF_PUB_RD = (1 << 8), // Public readable
VLVF_PUB_RW = (1 << 9), // Public writable VLVF_PUB_RW = (1 << 9), // Public writable
VLVF_DPI_CLAY = (1 << 10) // DPI compatible C standard layout VLVF_DPI_CLAY = (1 << 10), // DPI compatible C standard layout
VLVF_SIGNED = (1 << 11) // Signed integer
}; };
// IEEE 1800-2023 Table 20-6 // IEEE 1800-2023 Table 20-6
@ -308,20 +309,6 @@ private:
virtual std::unique_ptr<VerilatedTraceConfig> traceConfig() const; virtual std::unique_ptr<VerilatedTraceConfig> traceConfig() const;
}; };
//=========================================================================
/// Base class for all Verilated module classes.
class VerilatedModule VL_NOT_FINAL {
VL_UNCOPYABLE(VerilatedModule);
private:
const char* m_namep; // Module name
public:
explicit VerilatedModule(const char* namep); // Create module with given hierarchy name
~VerilatedModule();
const char* name() const VL_MT_SAFE_POSTINIT { return m_namep; } ///< Return name of module
};
//========================================================================= //=========================================================================
// Functions overridable by user defines // Functions overridable by user defines
// (Internals however must use VL_PRINTF_MT, which calls these.) // (Internals however must use VL_PRINTF_MT, which calls these.)
@ -694,6 +681,8 @@ public: // But for internal use only
explicit VerilatedSyms(VerilatedContext* contextp); // Pass null for default context explicit VerilatedSyms(VerilatedContext* contextp); // Pass null for default context
~VerilatedSyms(); ~VerilatedSyms();
VL_UNCOPYABLE(VerilatedSyms); VL_UNCOPYABLE(VerilatedSyms);
virtual const char* name() const = 0;
}; };
//=========================================================================== //===========================================================================
@ -709,26 +698,25 @@ public:
}; // Type of a scope, currently only module and package are interesting }; // Type of a scope, currently only module and package are interesting
private: private:
// Fastpath: // Fastpath:
VerilatedSyms* m_symsp = nullptr; // Symbol table VerilatedSyms* const m_symsp; // Symbol table
void** m_callbacksp = nullptr; // Callback table pointer (Fastpath) void** m_callbacksp = nullptr; // Callback table pointer (Fastpath)
int m_funcnumMax = 0; // Maximum function number stored (Fastpath) int m_funcnumMax = 0; // Maximum function number stored (Fastpath)
// 4 bytes padding (on -m64), for rent. // 4 bytes padding (on -m64), for rent.
VerilatedVarNameMap* m_varsp = nullptr; // Variable map VerilatedVarNameMap* m_varsp = nullptr; // Variable map
const char* m_namep = nullptr; // Scope name (Slowpath) const char* const m_namep; // Scope name (Slowpath)
const char* m_identifierp = nullptr; // Identifier of scope (with escapes removed) const char* const m_identifierp; // Identifier of scope (with escapes removed)
const char* m_defnamep = nullptr; // Definition name (SCOPE_MODULE only) const char* const m_defnamep; // Definition name (SCOPE_MODULE only)
int8_t m_timeunit = 0; // Timeunit in negative power-of-10 const int8_t m_timeunit; // Timeunit in negative power-of-10
Type m_type = SCOPE_OTHER; // Type of the scope const Type m_type; // Type of the scope
public: // But internals only - called from VerilatedModule's public: // But internals only - called from verilated modules, VerilatedSyms
VerilatedScope() = default; VerilatedScope(VerilatedSyms* symsp, const char* suffixp, const char* identifier,
const char* defnamep, int8_t timeunit, Type type);
~VerilatedScope(); ~VerilatedScope();
void configure(VerilatedSyms* symsp, const char* prefixp, const char* suffixp,
const char* identifier, const char* defnamep, int8_t timeunit,
const Type& type) VL_MT_UNSAFE;
void exportInsert(int finalize, const char* namep, void* cb) VL_MT_UNSAFE; void exportInsert(int finalize, const char* namep, void* cb) VL_MT_UNSAFE;
void varInsert(int finalize, const char* namep, void* datap, bool isParam, void varInsert(const char* namep, void* datap, bool isParam, VerilatedVarType vltype,
VerilatedVarType vltype, int vlflags, int udims, int pdims, ...) VL_MT_UNSAFE; int vlflags, int udims, int pdims, ...) VL_MT_UNSAFE;
// ACCESSORS // ACCESSORS
const char* name() const VL_MT_SAFE_POSTINIT { return m_namep; } const char* name() const VL_MT_SAFE_POSTINIT { return m_namep; }
const char* identifier() const VL_MT_SAFE_POSTINIT { return m_identifierp; } const char* identifier() const VL_MT_SAFE_POSTINIT { return m_identifierp; }
@ -756,6 +744,7 @@ class VerilatedHierarchy final {
public: public:
static void add(const VerilatedScope* fromp, const VerilatedScope* top); static void add(const VerilatedScope* fromp, const VerilatedScope* top);
static void remove(const VerilatedScope* fromp, const VerilatedScope* top); static void remove(const VerilatedScope* fromp, const VerilatedScope* top);
static void clear();
}; };
//=========================================================================== //===========================================================================
@ -1039,18 +1028,13 @@ void VerilatedContext::timeprecision(int value) VL_MT_SAFE {
m_s.m_timeprecision = value; m_s.m_timeprecision = value;
#if VM_SC #if VM_SC
const sc_core::sc_time sc_res = sc_core::sc_get_time_resolution(); const sc_core::sc_time sc_res = sc_core::sc_get_time_resolution();
if (sc_res == sc_core::sc_time(1, sc_core::SC_SEC)) { double mult = 1.0;
sc_prec = 0; for (int i = 0; i < 16; i++) {
} else if (sc_res == sc_core::sc_time(1, sc_core::SC_MS)) { if (sc_res == sc_core::sc_time(mult, sc_core::SC_FS)) {
sc_prec = 3; sc_prec = 15 - i;
} else if (sc_res == sc_core::sc_time(1, sc_core::SC_US)) { break;
sc_prec = 6; }
} else if (sc_res == sc_core::sc_time(1, sc_core::SC_NS)) { mult *= 10.0;
sc_prec = 9;
} else if (sc_res == sc_core::sc_time(1, sc_core::SC_PS)) {
sc_prec = 12;
} else if (sc_res == sc_core::sc_time(1, sc_core::SC_FS)) {
sc_prec = 15;
} }
// SC_AS, SC_ZS, SC_YS not supported as no Verilog equivalent; will error below // SC_AS, SC_ZS, SC_YS not supported as no Verilog equivalent; will error below
#endif #endif

View File

@ -2,7 +2,7 @@
###################################################################### ######################################################################
# DESCRIPTION: Makefile commands for all verilated target files # DESCRIPTION: Makefile commands for all verilated target files
# #
# Copyright 2003-2025 by Wilson Snyder. This program is free software; you # Copyright 2003-2026 by Wilson Snyder. This program is free software; you
# can redistribute it and/or modify it under the terms of either the GNU # 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 # Lesser General Public License Version 3 or the Perl Artistic License
# Version 2.0. # Version 2.0.
@ -262,7 +262,7 @@ endif
# Truncate the dependency list file used in the %.a target above. # Truncate the dependency list file used in the %.a target above.
%.verilator_deplist.tmp: %.verilator_deplist.tmp:
echo "" > $@ @echo "" > $@
$(VM_PREFIX)__ALL.a: $(VK_OBJS) $(VM_HIER_LIBS) $(VM_PREFIX)__ALL.a: $(VK_OBJS) $(VM_HIER_LIBS)
@ -311,30 +311,27 @@ ifneq ($(findstring ccache-report,$(MAKECMDGOALS)),)
endif endif
VK_OTHER_GOALS := $(strip $(subst ccache-report,,$(MAKECMDGOALS))) VK_OTHER_GOALS := $(strip $(subst ccache-report,,$(MAKECMDGOALS)))
ifeq ($(VK_OTHER_GOALS),) ifeq ($(VK_OTHER_GOALS),)
$(error ccache-report must be used with at least one other explicit target) VK_OTHER_GOALS := default
endif endif
# Report ccache behaviour for this invocation of make # Report ccache behaviour for this invocation of make
VK_CCACHE_LOGDIR := ccache-logs VK_CCACHE_LOGDIR := ccache-logs
VK_CCACHE_REPORT := $(VM_PREFIX)__ccache_report.txt VK_CCACHE_REPORT := $(VM_PREFIX)__ccache_report.txt
# Remove previous logfiles and report
# Remove previous logfiles and report, then create log directory
$(shell rm -rf $(VK_CCACHE_LOGDIR) $(VK_CCACHE_REPORT)) $(shell rm -rf $(VK_CCACHE_LOGDIR) $(VK_CCACHE_REPORT))
$(shell mkdir -p $(VK_CCACHE_LOGDIR))
$(VK_CCACHE_LOGDIR): # Add ccache logging to compilation rules
mkdir -p $@
$(VK_OBJS): | $(VK_CCACHE_LOGDIR)
$(VK_OBJS): export CCACHE_LOGFILE=$(VK_CCACHE_LOGDIR)/$@.log $(VK_OBJS): export CCACHE_LOGFILE=$(VK_CCACHE_LOGDIR)/$@.log
$(VK_CCACHE_REPORT): $(VK_OBJS) # ccache-report runs last
$(VK_CCACHE_REPORT): $(VK_OBJS) $(VK_OTHER_GOALS)
$(VERILATOR_CCACHE_REPORT) -o $@ $(VK_CCACHE_LOGDIR) $(VERILATOR_CCACHE_REPORT) -o $@ $(VK_CCACHE_LOGDIR)
# ccache-report runs last
.PHONY: ccache-report .PHONY: ccache-report
ccache-report: $(VK_CCACHE_REPORT) $(VK_OTHER_GOALS) ccache-report: $(VK_CCACHE_REPORT)
@cat $< @cat $<
endif endif
###################################################################### ######################################################################

View File

@ -2,7 +2,7 @@
// //
// Code available from: https://verilator.org // Code available from: https://verilator.org
// //
// Copyright 2003-2025 by Wilson Snyder. This program is free software; you can // Copyright 2003-2026 by Wilson Snyder. This program is free software; you can
// redistribute it and/or modify it under the terms of either the GNU // redistribute it and/or modify it under the terms of either the GNU
// Lesser General Public License Version 3 or the Perl Artistic License // Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0. // Version 2.0.

View File

@ -3,7 +3,7 @@
// //
// Code available from: https://verilator.org // Code available from: https://verilator.org
// //
// Copyright 2003-2025 by Wilson Snyder. This program is free software; you can // Copyright 2003-2026 by Wilson Snyder. This program is free software; you can
// redistribute it and/or modify it under the terms of either the GNU // redistribute it and/or modify it under the terms of either the GNU
// Lesser General Public License Version 3 or the Perl Artistic License // Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0. // Version 2.0.

View File

@ -3,7 +3,7 @@
// //
// Code available from: https://verilator.org // Code available from: https://verilator.org
// //
// Copyright 2001-2025 by Wilson Snyder. This program is free software; you // Copyright 2001-2026 by Wilson Snyder. This program is free software; you
// can redistribute it and/or modify it under the terms of either the GNU // 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 // Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0. // Version 2.0.

View File

@ -3,7 +3,7 @@
// //
// Code available from: https://verilator.org // Code available from: https://verilator.org
// //
// Copyright 2001-2025 by Wilson Snyder. This program is free software; you // Copyright 2001-2026 by Wilson Snyder. This program is free software; you
// can redistribute it and/or modify it under the terms of either the GNU // 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 // Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0. // Version 2.0.

View File

@ -3,7 +3,7 @@
// //
// Code available from: https://verilator.org // Code available from: https://verilator.org
// //
// Copyright 2001-2025 by Wilson Snyder. This program is free software; you // Copyright 2001-2026 by Wilson Snyder. This program is free software; you
// can redistribute it and/or modify it under the terms of either the GNU // 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 // Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0. // Version 2.0.

View File

@ -3,7 +3,7 @@
// //
// Code available from: https://verilator.org // Code available from: https://verilator.org
// //
// Copyright 2009-2025 by Wilson Snyder. This program is free software; you can // Copyright 2009-2026 by Wilson Snyder. This program is free software; you can
// redistribute it and/or modify it under the terms of either the GNU // redistribute it and/or modify it under the terms of either the GNU
// Lesser General Public License Version 3 or the Perl Artistic License // Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0. // Version 2.0.

View File

@ -3,7 +3,7 @@
// //
// Code available from: https://verilator.org // Code available from: https://verilator.org
// //
// Copyright 2003-2025 by Wilson Snyder. This program is free software; you can // Copyright 2003-2026 by Wilson Snyder. This program is free software; you can
// redistribute it and/or modify it under the terms of either the GNU // redistribute it and/or modify it under the terms of either the GNU
// Lesser General Public License Version 3 or the Perl Artistic License // Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0. // Version 2.0.

View File

@ -3,7 +3,7 @@
// //
// Code available from: https://verilator.org // Code available from: https://verilator.org
// //
// Copyright 2001-2025 by Wilson Snyder. This program is free software; you // Copyright 2001-2026 by Wilson Snyder. This program is free software; you
// can redistribute it and/or modify it under the terms of either the GNU // 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 // Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0. // Version 2.0.
@ -149,8 +149,9 @@ static std::pair<bool, fstScopeType> toFstScopeType(VerilatedTracePrefixType typ
} }
} }
void VerilatedFst::pushPrefix(const std::string& name, VerilatedTracePrefixType type) { void VerilatedFst::pushPrefix(const char* namep, VerilatedTracePrefixType type) {
assert(!m_prefixStack.empty()); // Constructor makes an empty entry assert(!m_prefixStack.empty()); // Constructor makes an empty entry
const std::string name{namep};
// An empty name means this is the root of a model created with // An empty name means this is the root of a model created with
// name()=="". The tools get upset if we try to pass this as empty, so // name()=="". The tools get upset if we try to pass this as empty, so
// we put the signals under a new $rootio scope, but the signals // we put the signals under a new $rootio scope, but the signals

View File

@ -3,7 +3,7 @@
// //
// Code available from: https://verilator.org // Code available from: https://verilator.org
// //
// Copyright 2001-2025 by Wilson Snyder. This program is free software; you // Copyright 2001-2026 by Wilson Snyder. This program is free software; you
// can redistribute it and/or modify it under the terms of either the GNU // 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 // Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0. // Version 2.0.
@ -110,7 +110,7 @@ public:
//========================================================================= //=========================================================================
// Internal interface to Verilator generated code // Internal interface to Verilator generated code
void pushPrefix(const std::string&, VerilatedTracePrefixType); void pushPrefix(const char*, VerilatedTracePrefixType);
void popPrefix(); void popPrefix();
void declEvent(uint32_t code, uint32_t fidx, const char* name, int dtypenum, void declEvent(uint32_t code, uint32_t fidx, const char* name, int dtypenum,

View File

@ -3,7 +3,7 @@
// //
// THIS MODULE IS PUBLICLY LICENSED // THIS MODULE IS PUBLICLY LICENSED
// //
// Copyright 2001-2025 by Wilson Snyder. This program is free software; you // Copyright 2001-2026 by Wilson Snyder. This program is free software; you
// can redistribute it and/or modify it under the terms of either the GNU // 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 // Lesser General Public License Version 3 or the Perl Artistic License
// Version 2.0. // Version 2.0.

Some files were not shown because too many files have changed in this diff Show More