Verilator——最简单、最细节上手教程

已于 2024-11-22 10:43:56 修改
阅读量4.5k 收藏 39
点赞数 63
文章标签： fpga开发 硬件工程 嵌入式硬件 开源软件 ide
于 2024-10-14 11:35:08 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2201_75757246/article/details/142878616
版权

目录

前言

此教程会以ubuntu22.04为例
从如何安装，到如何使用
全程帮助你学习和使用verilator

狂肝3h，倾心之作

如有笔误、问题，欢迎指出、讨论~

点赞，收藏，长期翻看~

工具安装

Verilator 安装

利用git进行快速安装（安装方法摘自官网Verilator）

# 安装的前提:
sudo apt-get install git help2man perl python3 make autoconf g++ flex bison ccache
sudo apt-get install libgoogle-perftools-dev numactl perl-doc
sudo apt-get install libfl2  # 只有Ubuntu需要，如果报错就忽略
sudo apt-get install libfl-dev  # 只有Ubuntu需要，如果报错就忽略
sudo apt-get install zlibc zlib1g zlib1g-dev  # 只有Ubuntu需要，如果报错就忽略

git clone https://github.com/verilator/verilator   #只需克隆一次

# Every time you need to build:
unsetenv VERILATOR_ROOT  # 对csh操作，如果是使用bash就忽略
unset VERILATOR_ROOT  # 对bash操作
cd verilator
git pull         # 确保git的仓库是最新的
git tag          # 查看可选版本

#选择以下的其中一个执行：
#git checkout master      # 使用开发分支（例如最近的bug修复版本）
#git checkout stable      # 使用最新的稳定版本
#git checkout v{version}  # 切换到指定版本

autoconf         # 创建脚本
./configure      # 配置并创建makefile
make -j `nproc`  # 构建verilator （如果报错试试只输入“make”）
sudo make install

然后执行

verilator --version	#检查版本，检查是否安装成功

GTKwave 安装

用来查看verilator生成的波形文件

有两种安装方法：

  1. 直接从ubuntu自带的应用商城搜索gtkwave，即可安装在这里插入图片描述
  2. 使用apt-get命令来安装
sudo apt-get install gtkwave
gtkwave --version	//查看版本，检查是否安装成功

Verilator 基础用法

fst格式和vcd格式的wave文件

varilator可以生成两种格式的wave文件：

  1. fst格式
    • FST格式的波形文件大致是VCD格式的1/50
    • 该格式只能用gtkwave打开，其他波形查看软件不支持
  2. vcd格式
    • 文件大小较大
    • 可以用多种波形查看软件查看

鉴于fst格式的优点，以及网上很少关于生成fst格式的教程，因此我以生成fst为例，如若要生成vcd可以上网查阅资料

接下来我将介绍如何使用verilator

Verilator 的使用

以cpp为例，并介绍如何生成fst wave文件的生成

可以看官方的例程 ：官方c++例程
此处我挑出其中重点的部分来讲解

假设我们用verilog写一个双控开关：

//顶层文件名为top，因此等会include的头文件为Vtop
//若顶层文件名为example，则include的头文件名为Vexample
module top(
  input clk,
  input rst,
  input a,
  input b,
  output reg f
);

  always @(posedge clk) begin
    if(!rst) f <= a ^ b;
  end

endmodule

仿真过程用c++来描述，文件如下：

//与verilator无关的一些头文件
#include <stdio.h>
#include <stdlib.h>
#include <assert.h>

//使用verilater必须include
#include "Vtop.h" //仿真模型的头文件，由top.v生成，如果顶层文件名更改则也需要更改
#include <verilated.h>

#define CONFIG_FST_WAVE_TRACE 1

// contextp用来保存仿真的时间
VerilatedContext *contextp = new VerilatedContext;

// 构建一个名为top的仿真模型
Vtop *top = new Vtop{contextp};

//如果生成FST格式的wave
#if CONFIG_FST_WAVE_TRACE
#include "verilated_fst_c.h"			//波形文件所需的头文件
VerilatedFstC *tfp = new VerilatedFstC; // 创建一个波形文件指针
#endif

//仿真的过程
int main(int argc, char **argv)
{
	// 传递参数给verilator
	contextp->commandArgs(argc, argv);

//如果生成FST格式的wave
#if CONFIG_FST_WAVE_TRACE
	contextp->traceEverOn(true);		  // 启用跟踪
	top->trace(tfp, 99);				  // 采样深度为99
	tfp->open("build/logs/cpu_wave.fst"); // 打开波形文件，文件地址和文件名可以自定义
#endif

	/***************对top端口的初始化*******************/
	top->clk = 0;
	top->rst = 0;
	
	int cycle = 50;	//定义仿真循环次数，即仿真50个循环后就自动结束
	/**************verilator的仿真循环*****************/
	while (cycle)	// 仿真50个循环后就自动结束
	{
	
		/************设置vtop仿真的输入信号************/
	int a = rand() & 1;
    int b = rand() & 1;
    top->a = a;
    top->b = b;
    top->clk = !top->clk; // 随着仿真时间倒转clk，产生时钟周期
    top->eval(); //更新电路状态
    printf("a = %d, b = %d, f = %d\n", a, b, top->f);	//按需打印想要的
    
    contextp->timeInc(1); //推动仿真时间
		
#if CONFIG_FST_WAVE_TRACE
		tfp->dump(contextp->time()); // 按照时间采样
#endif
	cycle--;
	
	}

/*****************仿真结束，一些善后工作***************/
#if CONFIG_FST_WAVE_TRACE
	tfp->close(); // 关闭波形文件
#endif

	// 清理top仿真模型，并销毁相关指针，并将指针变为空指针
	top->final();
	delete top;
	top = nullptr;
	delete contextp;
	contextp = nullptr;

	return 0;
}

完成文件的编写后，我们要让verilator编译并运行
在命令行中输入

verilator -Wall top.v top_main.cpp --cc --trace-fst --exe --build
rm -rf $(BUILD_DIR)/logs	//清空存放波形文件的文件夹
mkdir -p $(BUILD_DIR)/logs	//再创建新文件夹存放波形文件
./obj_dir/Vtop   //必须执行这个，才运行仿真，生成波形
gtkwave build/logs/cpu_wave.fst	//用gtk打开波形文件

Verilator 的进阶使用

与GDB搭配

gdb可以很方便得对仿真的过程进行调试

如何使用请详见 “与makefile搭配”

与makefile搭配

如果每次使用verilator都要在命令行中输入以上命令，有点太麻烦了
因此可以利用makefile

########### 不要在变量后面加多余空格，否则会导致变量名出问题 ###########
########### 因此也不要在变量后面加注释，以避免上述情况发生 ###########

#顶层文件的名字
TOPNAME = top

#指定verilator
VERILATOR = verilator

######################## 构建后的项目 ########################
#构建后的地址
BUILD_DIR = ./build/verilator

#构建后文件存放的地址
OBJ_DIR = $(BUILD_DIR)/obj_dir

#可执行文件的地址
BIN = $(OBJ_DIR)/$(TOPNAME)

######################## verilator选项 ########################
#创建生成文件的目录,存放生成的文件
VERILATOR_FLAGS += --Mdir $(OBJ_DIR)

#优化分配 
VERILATOR_FLAGS += -x-assign fast

#将所有warning 变成error
VERILATOR_FLAGS += -Wall

#Make waveforms,fst格式
VERILATOR_FLAGS += --trace-fst

#检查SystemVerilog断言
VERILATOR_FLAGS += --assert

#debug模式，生成更多调试信息
VERILATOR_FLAGS += --debug

#Add this trace to get a backtrace in gdb
VERILATOR_FLAGS += --gdbbt

# 可用gdb调试
VERILATOR_FLAGS += --gdb

#加速编译
VERILATOR_FLAGS += -j

#调用工具链来构建库，不加则由verilator自己构建
VERILATOR_FLAGS += --build

#指定顶层文件
VERILATOR_FLAGS += --top-module $(TOPNAME)

#生成C++可执行文件，并指定文件名字
VERILATOR_FLAGS += --cc --exe -o $(abspath $(BIN))

######################## 查找相关文件 ########################
#所有 .v 或者 .sv 文件
VSRCS = $(shell find $(abspath ./build/chisel) -name "*.v" -or -name "*.sv")

#所有 .c 或 .cc 或 .cpp 文件
CSRCS = $(shell find $(abspath ./src/main/cpp) -name "*.c" -or -name "*.cc" -or -name "*.cpp")

######################## 目标与命令 ########################
run:
	@echo "-------- VERILATE --- AND --- BUILD --------"
#清空再创建编译后文件放置的目录
	@rm -rf $(OBJ_DIR)
	@mkdir -p $(OBJ_DIR)

#使用verilator进行编译，产生可执行文件
	@$(VERILATOR) $(VERILATOR_FLAGS) $(VSRCS) $(CSRCS)

	@echo
	@echo "-------------------- RUN --------------------"

#清空再创建波形文件夹
	@rm -rf $(BUILD_DIR)/logs
	@mkdir -p $(BUILD_DIR)/logs

#执行可执行文件，运行并仿真，生成波形
	@$(BIN) +trace

	@echo
	@echo "-------------------- DONE --------------------"
	@echo "To see waveforms, open $(BUILD_DIR)/logs/cpu_wave.fst in a waveform viewer"
	@echo


gdb:
	@echo "-------- VERILATE --- AND --- BUILD --------"

#清空再创建编译后文件放置的目录
	@rm -rf $(OBJ_DIR)
	@mkdir -p $(OBJ_DIR)

#使用verilator进行编译，产生可执行文件
	@$(VERILATOR) $(VERILATOR_FLAGS) $(VSRCS) $(CSRCS)

	@echo
	@echo "-------------------- GDB --------------------"

#清空再创建波形文件夹
	@rm -rf $(BUILD_DIR)/logs
	@mkdir -p $(BUILD_DIR)/logs

#gbd执行可执行文件，运行并仿真，生成波形
	gdb -s $(BIN) --args $(BIN)

	@echo
	@echo "-------------------- DONE --------------------"
	@echo "To see waveforms, open $(BUILD_DIR)/logs/cpu_wave.fst in a waveform viewer"
	@echo

然后在当前目录下执行

make run	//执行仿真
make gdb	//使用gdb

即可

Verilator 的高阶用法

访问模块内部数据

前面的介绍中，我们要访问模块的数据，只能访问到顶层模块top的输入输出端口，假如我要访问其中内部的wire和reg数据该怎么办呢？

verilator为在将verilog文件编译为cpp文件进行仿真的时候，我们可以在仿真文件中访问verilator将.v文件转化后的cpp文件来访问数据

只需在上面的仿真文件中增加以下内容

#include "../build/obj_dir/Vtop___024root.h"

//然后就可以通过top来访问了
printf("data:%x",top->rootp->top__DOT__my_regfile__DOT__reg_f[1])
//my_regfile为实例化的模块名
//reg_f为模块中定义的reg型
//若你想输出你想要的数据可以在 ../build/obj_dir/Vtop___024root.h 头文件中寻找
vim + syntastic + verilator or iverilog
nkfustKai的博客
10-25 2076
若文章有錯誤請留言指證 需要轉載請通知筆者 syntastic讓你可以在vim裡可以使用lint功能,讓你在寫code時檢查看看有沒有語法上的錯誤或者可能潛在的錯誤這裡我是透過vundle安裝syntastic,如果不會使用vundle,請參考官方Installlinter首先要先安裝linter有兩種選擇: Icarus Verilog或是verilator,看你偏好哪一種 我是經由hom
Verilator实例
海岛Blog
04-28 322
Verilator是一种将Verilog和SystemVerilog源代码编译为高度优化（可选多线程）的循环精确C++或SystemC代码的工具。转换后的模块可以实例化并在C++或SystemC测试台中使用，用于验证和/或建模目的。Verilator包将Verilog 1和SystemVerilog 2硬件描述语言（HDL）设计转换为C++或SystemC模型，编译后即可执行。Verilator不是传统的模拟器，而是编译器。
【Verilator】简单用法
m0_63642416的博客
03-10 1963
Verilator是一个仿真器。其中经常用到的就是自己撰写CPP激励文件。CPP激励文件主要可以分为三个方面的内容，硬件管理方、波形管理方、仿真管理方。
EDA开源仿真工具Verilator：简介及Hello World
yang1573的博客
11-17 2578
本文对于Verilator的基本功能做了简要的叙述，并简要讲解了hello world的运行过程。
在 Ubuntu 22.04 LTS上部署verilator
最新发布
Yiming1106的博客
03-25 664
因为我一开始没有好好安装依赖，所以看到很多 ‘checking for xxx…’ 都是no，不要学我哈哈哈。安装完成后，在开始菜单中找到 Ubuntu 22.04 LTS 的快捷方式，点击即可运行。命令中的任务数要根据自己电脑的配置来调整，数量不要超过电脑最大线程数。如果输出了 Verilator 的版本号，说明已经安装成功。之前，必须要保证依赖全都安装完，如果缺东西，就执行。在 Windows 系统上，我们可以通过访问。编译过程可能需要较长时间，请耐心等待。，全部安装好之后再执行。
EDA开源仿真工具verilator入门1：安装和测试
fangfanglovezhou的博客
06-08 1万+
EDA开源仿真工具verilator入门值安装和测试，Ubuntu环境下的安装以及测试示例：hello world程序和gtkwave显示程序。
【Verilator】 1 简明教程
一名FPGA芯片设计爱好者的技术博客
11-10 8895
我是，一名FPGA爱好者，研究方向是FPGA架构探索和数字IC设计。欢迎来关注我的B站账号，我将定期更新IC设计教程。，
Verilator+gtkwave快速上手教程1
08-03
1. 编辑 verilog 顶层文件$(top).v：实现模块内部逻辑，向外部提供 IO 信号端口 2. 编辑应用程序代码：在测试文件$(test).cpp 中
Verilator入门使用教程
m0_64636251的博客
02-01 1341
Verilator入门使用教程（安装到测试和基本代码详解）
Verilator入门（一）
Yuxin_Yu的博客
06-25 5356
Verilator可将硬件描述语言Verilog/SystemVerilog编译成优化后的支持多线程的高级语言C++/SystemC模型，通过在高级语言中例化硬件描述语言，进而使用高级语言的特性实现对Verilog/SystemVerilog的验证。简单来说，Verilator对Verilog/SystemVerilog等硬件描述语言添加了一个基于C++/SystemC的wrapper，而后借助C++和Verilator的特定库实现对Verilog/SystemVerilog的高效仿真。
从新手到专家：EDA仿真技术的5大关键提升点
!... # 摘要 电子设计自动化（EDA）仿真技术是集成电路设计过程中不可或缺的环节，它通过模拟电子系统的运行来验证设计的正确性。本文从EDA仿真技术的基础概念出发，详细探讨了仿真环境的建立、配置方法，以及硬件描述...
verilator:Verilator示例集合
05-23
验证者 Verilator示例集合 例1 Verilator手册中提供的示例的直接副本
Verilator开源SystemVerilog模拟器和lint系统- Verilator / Verilator
01-27
Verilator开源SystemVerilog模拟器和lint系统- Verilator / Verilator-源码
Verilator简易使用教程——一个简单的测试案例
小水的博客
02-18 1857
Verilator的一个简单使用案例。
verilator入门资料
zyx2232的博客
04-13 2248
首先呢，请根据官网指南安装好verilator+systemc环境 一、搭建环境 安装官网的包就可以了，然后教程走一遍文档里的3个案例 二、Verilator仿真器入门 | Hu's Blog（梯子） 帖子很有用，建议跟着编译命令一步一步走一遍， Vtop *top; // 模块的实例 vluint64_t main_time = 0; // 当前的仿真时间 // This is a 64-bit integer to reduce wrap over issues and // allow
Verilator简介与使用
热门推荐
Daturasee的博客
04-29 2万+
本文将对Verilator进行简单的介绍与使用演示，Verilator是一款开源的支持Verilog和System Verilog仿真工具，它支持代码质量检查等功能，能够将给定的电路设计（由Verilog或System Verilog编写）编译成（或者说翻译成）C++或者System C的库等中间文件，最后再编写testbench（在Verilator中叫做wrapper file），去调用前面生成的中间文件，然后统一由C编译器编译执行，来完成仿真。
Verilator
timewh的专栏
07-08 3462
https://en.wikipedia.org/wiki/Verilator
Verilator 安装和配置指南
gitblog_07923的博客
09-13 618
Verilator 安装和配置指南 verilator Verilator open-source SystemVerilog simulator and lint system 项目地址: https://gitcode.com...
Verilator安装流程
qq_41134662的博客
05-29 492
安装Verilator流程
verilator手册
01-13
### 查找 Verilator 文档或手册的方法 对于希望获取 Verilator 的文档或手册的用户而言，官方资源是最可靠的选择。Verilator 是一款开源工具，其官方网站提供了详尽的手册和指南[^1]。 访问 Verilator 官方网站可以找到最新版本的手册和其他辅助材料。通常，在项目主页上会有明显的链接指向这些资料。此外，GitHub 上也托管着 Verilator 的源码仓库，其中包含了 README 文件以及详细的 INSTALL 和 QUICKSTART 指南，这些都是非常有价值的参考资料[^2]。 如果偏好命令行操作，安装完成后可以通过 `man verilator` 来查看本地的手册页（前提是系统已经正确设置了 man page）。这种方式适合熟悉 Unix/Linux 环境下的开发者使用[^3]。 ```bash man verilator ``` 为了更方便地在线查阅文档，也可以直接搜索 "Verilator Documentation" 或者前往特定页面如： - [Verilator Manual](https://verilator.org/) 通过上述途径可以获得关于如何配置、编译及调试由 Verilator 生成的 C++ 或 SystemC 代码的具体指导。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值