mirror of
https://github.com/verilator/verilator.git
synced 2025-01-05 22:27:35 +00:00
115 lines
4.2 KiB
Python
Executable File
115 lines
4.2 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
# -*- Python -*- See copyright, etc below
|
|
######################################################################
|
|
|
|
import argparse
|
|
import os
|
|
import re
|
|
import subprocess
|
|
import sys
|
|
import tempfile
|
|
import xml.etree.ElementTree as ET
|
|
from shutil import copy2
|
|
from pprint import pprint,pformat
|
|
|
|
#######################################################################
|
|
|
|
class VlFileCopy:
|
|
def __init__(self,
|
|
verilator_args, # presently all verilator options are passed-thru
|
|
# ideally this script would check against options mentioned in help
|
|
debug=0,
|
|
output_dir='copied'): # directory name we output file uses
|
|
self.debug = debug
|
|
|
|
xml_temp = tempfile.NamedTemporaryFile()
|
|
|
|
args = ['--xml-output', xml_temp.name,
|
|
'--bbox-sys', # Parse some stuff can't translate
|
|
'--bbox-unsup',
|
|
'--prefix vlxml'] # So we know name of .xml output
|
|
args += verilator_args
|
|
self.run_verilator(args)
|
|
self.tree = ET.parse(xml_temp.name)
|
|
|
|
os.makedirs(output_dir, 0o777, True)
|
|
|
|
# Find and copy the files
|
|
root = self.tree.getroot()
|
|
xfiles = root.find('files')
|
|
for xfile in xfiles.findall('file'):
|
|
filename = xfile.get('filename')
|
|
if not re.match('^<', filename): # e.g. <built-in>
|
|
if self.debug:
|
|
print("\tcp %s %s" % (filename, output_dir))
|
|
copy2(filename, output_dir)
|
|
|
|
def run_verilator(self, args):
|
|
"""Run Verilator command, check errors"""
|
|
if os.getenv("VERILATOR_ROOT"):
|
|
command = os.getenv("VERILATOR_ROOT") + "/bin/verilator"
|
|
else:
|
|
command = "verilator"
|
|
command += ' ' + ' '.join(args)
|
|
if self.debug:
|
|
print("\t%s " % command)
|
|
status = subprocess.call(command, shell=True)
|
|
if status != 0:
|
|
raise Exception("Command failed running Verilator with '"+command+"', stopped")
|
|
|
|
#######################################################################
|
|
|
|
if __name__=='__main__':
|
|
parser = argparse.ArgumentParser(
|
|
allow_abbrev=False,
|
|
formatter_class=argparse.RawTextHelpFormatter,
|
|
description=
|
|
"""Example of using Verilator XML output to copy a list of files to an
|
|
output directory (-odir, defaults to 'copied'), e.g. to easily create a
|
|
tarball of the design to pass to others.
|
|
|
|
Example usage:
|
|
vl_file_copy -f input.vc top.v -odir mycopy
|
|
# This will make at least mycopy/top.v
|
|
""",
|
|
epilog=
|
|
"""All other arguments are pass-thru to Verilator: e.g.:
|
|
|
|
+define+<var>=<value> Set preprocessor define
|
|
-F <file> Parse options from a file, relatively
|
|
-f <file> Parse options from a file
|
|
-G<name>=<value> Overwrite toplevel parameter
|
|
+incdir+<dir> Directory to search for includes
|
|
+libext+<ext>+[ext]... Extensions for finding modules
|
|
-v <filename> Verilog library
|
|
-y <dir> Directory to search for modules
|
|
|
|
This file ONLY is placed under the Creative Commons Public Domain, for
|
|
any use, without warranty, 2019 by Wilson Snyder.
|
|
SPDX-License-Identifier: CC0-1.0
|
|
"""
|
|
)
|
|
parser.add_argument('-debug', '--debug',
|
|
action='store_const', const=9,
|
|
help='enable debug')
|
|
parser.add_argument('-odir', '--odir',
|
|
action='store', metavar='directory', required=True,
|
|
help='target output directory')
|
|
(args, rem) = parser.parse_known_args()
|
|
|
|
print("NOTE: vl_file_copy is only an example starting point for writing your own tool.")
|
|
# That is:
|
|
# 1. We will accept basic patches
|
|
# 2. We are not expecting to make this globally useful. (e.g. we don't cleanup obj_dir)
|
|
# 3. "make install" will not install this.
|
|
# 4. This has not had production-worthy validation.
|
|
|
|
fc = VlFileCopy(output_dir = args.odir,
|
|
debug = args.debug,
|
|
verilator_args = rem)
|
|
|
|
######################################################################
|
|
### Local Variables:
|
|
### compile-command: "./vl_file_copy -h ; VERILATOR_ROOT=$V4 ./vl_file_copy +define+thru top.v"
|
|
### End:
|