【python脚本】当我需要一个完整的rtl list时，还是选择求助vcs吧

前言

现在我有很多需求需要基于完整的文件list来做，比如说检查所需文件和svn版本是否对齐、根据编译顺序检查宏定义、按照需求更新/上传文件等等，那么目前最大的拦路虎就是如何得到完整的文件路径了（cent的中文输入太弱了，拦路虎都联想不出来）。

要得到这个完整的文件目录有很多中方法，不过最后我思考了下，觉得既然有这么多轮子在，那干嘛还要自己写呢，干脆借用工具好了，因此最后还是决定通过vcs来获取下。

关键处理

大体上我的思路是，用一个函数调用一下vcs，编译出list后再删除其他的文件，只留下一个可以反复使用的list就够了，因此需要在脚本中集成这句代码调用最基本的vcs功能：

cmd = "vcs -f tb.f -l %s +libext+.sv+.v +v2k -sverilog -ntb_opts uvm-1.2 -timescale=1ns/1ps -unit_timescale=1ns/1ps" % sys_log
os.system(cmd) if re_cmp == True or not os.path.exists(sys_log) else ""

预留的全局变量re_cmp表示重新编译，sys_log表示可以使用的提取信息后的list文件。

由于vcs编译后的log格式是固定的，那么我只要抓取如下格式的文件就可以了：

Back to file '/tools/synopsys/vcs/vcs-mx_vL-2016.06/etc/uvm-1.2/vcs/uvm_vcs_recorder.svh'.
Back to file '/tools/synopsys/vcs/vcs-mx_vL-2016.06/etc/uvm-1.2/vcs/uvm_custom_install_vcs_recorder.sv'.
Parsing included file '/tools/synopsys/vcs/vcs-mx_vL-2016.06/etc/uvm-1.2/vcs/uvm_vcs_record_interface.sv'.
Back to file '/tools/synopsys/vcs/vcs-mx_vL-2016.06/etc/uvm-1.2/vcs/uvm_custom_install_vcs_recorder.sv'.
Parsing design file '../top/testbench.sv'
Parsing design file '../rtl/mem.v'
Parsing design file '../ver/pkt_if.sv'

抓取后去掉重复的文件，核心的函数完成：

def vcs_run_file():
    file_list = []
    global sys_log
    global all_lst
    global re_cmp
    
    cmd = "vcs -f tb.f -l %s +libext+.sv+.v +v2k -sverilog -ntb_opts uvm-1.2 -timescale=1ns/1ps -unit_timescale=1ns/1ps" % sys_log
    os.system(cmd) if re_cmp == True or not os.path.exists(sys_log) else ""
    with open(sys_log) as f:
        for line in f.readlines():
            if re.search(r"file '(.*)'", line):
                file_list.append(re.search(r"file '(.*)'", line).group(1))
    return list(set(file_list))

 

接下来的问题是，vcs会编译产生一些文件，对于我现在的工作其实是不需要的，那么就悄悄的删除吧。正好趁此机会学学修饰器怎么用，通过修饰器叫脚本执行前后多出来的文件删除掉：

def wrap_rm_add_file(f):
    @wraps(f)
    def rm_add_file(*args, **kwargs):
        before_file = os.listdir(os.getcwd())
        print(f.__name__ + " was called")
        file_list = f(*args, **kwargs)
        for file in os.listdir(os.getcwd()):
            if file not in before_file:
                print("rm %s" % file)
                os.system("rm -rf %s" % file)
        return file_list
    return rm_add_file

 

好的，把修饰器和函数放一起就好了。最后的点，组织下输入，可以直接-l 输入编译后的vcs.log，也可以-f输入待编译的list，或者-r强制重新编译（当然了，我就实现了-f后面的逻辑）:

def input_wrap():
    global lst
    global all_lst
    global sys_log
    global re_cmp
    parser = argparse.ArgumentParser()
    parser.add_argument("-f", "--file_list", help="list file path", default="")
    parser.add_argument("-l", "--all_list", help="list file path", default="")
    parser.add_argument("-r", help="re compile", action="store_true")
    args = parser.parse_args()
    lst = args.file_list
    all_lst = args.all_list
    re_cmp = args.r
    (filename,extension) = os.path.splitext(lst)
    sys_log = filename + "_sys_all_file.lst"

全部的工作完成后，完整代码如下：

#! /usr/bin/python

import os
import time
import sys
import re
import argparse
from functools import wraps

def input_wrap():
    global lst
    global all_lst
    global sys_log
    global re_cmp
    parser = argparse.ArgumentParser()
    parser.add_argument("-f", "--file_list", help="list file path", default="")
    parser.add_argument("-l", "--all_list", help="list file path", default="")
    parser.add_argument("-r", help="re compile", action="store_true")
    args = parser.parse_args()
    lst = args.file_list
    all_lst = args.all_list
    re_cmp = args.r
    (filename,extension) = os.path.splitext(lst)
    sys_log = filename + "_sys_all_file.lst"


def wrap_rm_add_file(f):
    @wraps(f)
    def rm_add_file(*args, **kwargs):
        before_file = os.listdir(os.getcwd())
        print(f.__name__ + " was called")
        file_list = f(*args, **kwargs)
        for file in os.listdir(os.getcwd()):
            if file not in before_file:
                print("rm %s" % file)
                os.system("rm -rf %s" % file)
        return file_list
    return rm_add_file

@wrap_rm_add_file
def vcs_run_file():
    file_list = []
    global sys_log
    global all_lst
    global re_cmp
    
    cmd = "vcs -f tb.f -l %s +libext+.sv+.v +v2k -sverilog -ntb_opts uvm-1.2 -timescale=1ns/1ps -unit_timescale=1ns/1ps" % sys_log
    os.system(cmd) if re_cmp == True or not os.path.exists(sys_log) else ""
    with open(sys_log) as f:
        for line in f.readlines():
            if re.search(r"file '(.*)'", line):
                file_list.append(re.search(r"file '(.*)'", line).group(1))
    return list(set(file_list))

def main():
    global all_lst
    global re_cmp
    
    input_wrap()
    
    if all_lst == "":
        file_list = vcs_run_file()
        if not os.path.exists(sys_log):
            with open(sys_log, "w") as f:
                for line in file_list:
                    f.write(line+"\n")

if __name__ == '__main__':
    main()

执行脚本后，会在当前目录下生成xxx_sys_all_file.lst文件（之后应该修改为在xxx.lst目录下生成，后面的逻辑中实际上还应该补充如果在没有re_cmp时检查到存在该文件存在时不要进行重复编译），当然也可以在脚本中使用file_list继续进行其他操作。

结束