阅读yosys源码

see https://deepwiki.com/YosysHQ/yosys

工作流程

Subsystem	Function	Data Format
yosys_setup	Initialize environment	-
run_frontend	Read in HDL	HDL source → AST → RTLIL
run_pass	Transform/optimize design	RTLIL
run_backend	Output design	RTLIL → Netlist
yosys_shutdown	Cleanup and shutdown	-

控制与数据流相关定义

前端(frontend): 第一个被调用的子系统, 它不处理另一个子系统产生的数据, 而是读取用户输入
通道(passes): 中间级的子系统, 从前一个子系统获取数据, 并为下一个子系统产生数据; 这里, Pass只用于在RTLIL数据结构上操作的命令
后端(backend): 最后一个子系统, 将最后一次pass产生的数据转换为合适的输出格式, 并写入磁盘文件

Yosys中这些子系统基本都可以直接作为命令在综合脚本中使用 eg

启动

标准版本使用shell()函数提供完整的交互式环境,而EMSCRIPTEN版本通过run函数提供单命令执行接口,更适合Web环境的异步调用模式. 后者提供三个主要接口函数:

run(const char *command) - 执行命令

errmsg() - 获取错误信息

prompt() - 获取提示符

EMSCRIPTEN版本主函数位于driver.cc,调用yosys.cc中的yosys_setup()来初始化系统.如果程序收到了一个命令行参数,将第一个参数argv[1]作为脚本文件来进行前端处理;没有特殊参数时,启动交互式shell,实际的命令执行通过导出的run()函数来处理.(int main没有显式返回，函数会隐式返回0)

int main(int argc, char **argv)
{
	EM_ASM(
		if (ENVIRONMENT_IS_NODE)
		{
			FS.mkdir('/hostcwd');
			FS.mount(NODEFS, { root: '.' }, '/hostcwd');
			FS.mkdir('/hostfs');
			FS.mount(NODEFS, { root: '/' }, '/hostfs');
		}
	);

	mkdir("/work", 0777);
	chdir("/work");
	log_files.push_back(stdout);
	log_error_stderr = true;
	yosys_banner();
	yosys_setup();

...

	if (argc == 2)
	{
		// Run the first argument as a script file
		run_frontend(argv[1], "script");
	}
}

run(const char *command)函数保存选择栈状态,通过run_pass(command)调用Pass执行逻辑,将系统推入新的选择状态.执行过程中捕获异常并进行状态恢复. 选择栈selection_stack: vector<Selection>存放的是RTLIL::Selection对象,每个Selection对象代表设计中当前被选中的元素集合,包含以下核心数据:

selected_modules,存储完整选中的模块名称,以IdString(字符串标识符)的形式存储
selected_members,存储部分选中模块的具体成员(如wire,cell)
选择标志,包括是否全选、是否包含黑盒模块等状态信息

void run(const char *command)
{
	int selSize = GetSize(yosys_get_design()->selection_stack);
	try {
		log_last_error = "Internal error (see JavaScript console for details)";
		run_pass(command);
		log_last_error = "";
	} catch (...) {
		while (GetSize(yosys_get_design()->selection_stack) > selSize)
			yosys_get_design()->selection_stack.pop_back();
		throw;
	}
}

标准版本的main函数是一个功能完整的命令行程序入口,主要包括:

变量初始化和选项定义:函数首先定义了大量的配置变量和命令行选项,然后使用cxxopts库定义了三个主要的选项组：操作选项(operation,前端、后端、脚本文件等),日志选项(logging,控制输出格式和日志记录),开发者选项(developer,调试和性能分析相关)
命令行参数解析:auto result = options.parse(argc, argv);
系统初始化:调用yosys_setup()函数
文件处理和命令执行:函数按顺序处理不同类型的输入,处理前端文件->执行脚本文件->执行Pass命令
交互式模式或后端输出:根据配置决定是启动交互式shell(shell(yosys_design))还是执行后端输出(run_backend(output_filename, backend_command))

yosys_setup()函数为公共接口,设置共享目录路径和ABC工具路径,初始化RTLIL中使用的预定义标识符,调用Pass::init_register()注册所有Pass,创建全局的RTLIL设计对象,设置内置单元类型库,推入日志栈

void yosys_setup()
{
	if(already_setup)
		return;
	already_setup = true;
	init_share_dirname();
	init_abc_executable_name();

#define X(_id) RTLIL::ID::_id = "\\" # _id;
#include "kernel/constids.inc"
#undef X
...

	Pass::init_register();
	yosys_design = new RTLIL::Design;
	yosys_celltypes.setup();
	log_push();
}

对应的,yosys_shutdown函数在结束时清理资源

前端解析

Verilog前端将HDL转换为AST, 由Preprocessor, Lexer, Parser三个部分组成 AST前端将AST转换为RTLIL, 由Simplifier, RTLIL Generator组成

AST(abstract syntax tree)的数据结构

AST节点在Yosys中主要通过AstNode结构体实现

包括以下成员:
- AstNodeType type: 每个AST节点都有一个类型(如AST_DESIGN, AST_MODULE, AST_TASK, AST_FUNCTION, AST_DPI_FUNCTION,AST_WIRE等), 定义在AstNodeType枚举中 (see Table 4.1: AST node types with their corresponding Verilog constructs.)
- std::vector<AstNode*> children: AST采用树形结构, 每个节点通过children向量存储其子节点
- std::map<RTLIL::IdString, AstNode*> attributes: 节点可以携带Verilog属性, 存储在attributes映射中 (属性值也是AST节点);
- node content: 一些很多时候不常用的verilog属性, 如bool is_input, is_output, is_reg, is_logic, is_signed, is_string; uint32_t integer; double realvalue;
- std::string filename, int linenum: 在源码的位置
通过构造函数创建, 初始化所有成员变量，接受最多4个子节点作为参数: AstNode::AstNode(AstNodeType type, AstNode *child1, AstNode *child2, AstNode *child3, AstNode *child4)
节点深度克隆操作(deep recursive copy): AstNode *AstNode::clone() const

RTLIL中间形式

AST经过简化处理后, 通过genRTLIL()方法转换为RTLIL表示: 递归处理AST节点, 为表达式生成相应的电路, 并返回信号规格 RTLIL(Register-Transfer-Level-Intermediate-Language)是Yosys中贯穿始终的核心中间表示形式,作为中央数据结构，是前端解析器生成的目标格式,所有优化处理流程的操作对象,后端代码生成器的输入源.

graph LR;
    A[HDL代码] --> B[前端]
    B --> C["Abstract Syntax Tree (AST)"]
    C --> D[RTLIL]
    D --> E[优化传递]
    E --> F[工艺映射]
    F --> G[Target-Specific Synthesis]
    G --> H[后端]
    H --> I["输出(Netlist/Bitstream)"]

RTLIL的生成通常分为两个阶段：

前端解析器生成抽象语法树(AST):以Verilog解析器为代表的前端工具首先构建AST,该过程由各语言前端的独立解析器完成
AST到RTLIL的转换:通过genrtlil.cc中的转换函数实现,形成完整的寄存器传输级中间表示

具体转换规则处理以下Verilog结构：

结构类型	转换目标
顶层设计	RTLIL::Design对象
模块定义(module)	RTLIL::Module对象
线网声明(wire)	RTLIL::Wire对象
单元实例化	RTLIL::Cell对象
always语句块	RTLIL::Process对象
多个信号位	RTLIL::SigSpec对象
常量或线网	RTLIL::SigBit对象

传递管理

Yosys中的传递管理系统为硬件设计转换操作提供了定义、注册和执行的框架. ‘Pass’是指对设计进行转换,分析或执行实用功能的独立操作,作为综合流程的基础构建模块.

Pass是一个抽象基类，定义了所有变换操作的统一接口.每个Pass都有唯一标识名称和执行方法，本质上就是一条可执行的指令.在初始化时，所有Pass都会注册到全局的pass_register映射表中,这样就可以通过名称来查找和调用它们.通过命令行或脚本调用这些名称,系统会解析命令字符串,查找对应的Pass并执行.

# 一般可以用这样的格式调用:
pass_name [options] [selection]
# 例如:
opt -full top_module

后端系统

优化

函数开头的std::vector<std::string> args;是什么意思? 这个声明创建了一个可以动态增长的字符串数组,初始为空(0个元素),可以像数组一样通过索引访问(如args[0]),提供push_back()等方法添加元素 std::vector即是std命名空间中的动态数组容器vector <std::string>是模板参数，指定vector中存储的元素类型为标准字符串类

Yosys中的pass_register以及register.cc文件中其他寄存器的用途

pass_register是Yosys中用于注册和管理所有Pass（处理步骤）的全局映射表，它将Pass名称映射到对应的Pass对象指针。 1

在register.cc中定义了三个核心寄存器：

pass_register - 存储所有Pass（包括Frontend和Backend） 1
frontend_register - 专门存储Frontend（输入格式解析器） 2
backend_register - 专门存储Backend（输出格式生成器） 3

Pass通过以下流程注册到这些寄存器中：

构造时排队：Pass在构造函数中被添加到队列 4
批量注册：Pass::init_register()遍历队列并调用每个Pass的run_register() 5
实际注册：run_register()将Pass添加到相应的寄存器中 6

这些寄存器在Pass执行时被使用：

命令查找：当用户执行命令时，系统通过pass_register查找对应的Pass 7
执行Pass：找到Pass后调用其execute()方法 8
帮助系统：help命令遍历pass_register显示所有可用命令 9

Frontend和Backend继承自Pass，但有额外的注册逻辑：

Frontend注册：同时注册到pass_register和frontend_register 10
Backend注册：同时注册到pass_register和backend_register 11

Yosys的TCL接口

static int tcl_yosys_cmd(ClientData, Tcl_Interp *interp, int argc, const char *argv[]) 这是标准的TCL命令回调函数签名:其中ClientData是TCL的客户端数据(这里未使用),Tcl_Interp *interp是TCL解释器指针当第一个参数是-import时，函数会将所有Yosys Pass导入为TCL命令

	if (args.size() >= 1 && args[0] == "-import") {
		for (auto &it : pass_register) {
			std::string tcl_command_name = it.first;
			if (tcl_command_name == "proc")
				tcl_command_name = "procs";
			else if (tcl_command_name == "rename")
				tcl_command_name = "renames";
			Tcl_CmdInfo info;
			if (Tcl_GetCommandInfo(interp, tcl_command_name.c_str(), &info) != 0) {
				log("[TCL: yosys -import] Command name collision: found pre-existing command `%s' -> skip.\n", it.first.c_str());
			} else {
				std::string tcl_script = stringf("proc %s args { yosys %s {*}$args }", tcl_command_name.c_str(), it.first.c_str());
				Tcl_Eval(interp, tcl_script.c_str());
			}
		}
		return TCL_OK;
	}

使用C++的异常处理来捕获Yosys命令执行中的错误:调用Pass::call(args),如果出现log_cmd_error_exception异常,作出响应

PREVIOUS嵌入式系统原理与设计

NEXT使用picker与toffee框架进行芯片验证