def test_pbtype_generation_with_vlog_to_pbtype(pbtypecase):
"""Checks pb_type.xml files produced by the vlog_to_pbtype.
Parameters
----------
pbtypecase : dict
A dict of the filename of the model.xml file that should be produced
by the corresponding sim.v file ('goldenfile') and the corresponding
sim.v file ('simfile')
"""
testdatafile = pbtypecase['goldenfile']
testdatadir = os.path.dirname(testdatafile) + '/'
vlog_filename = pbtypecase['simfile']
testname = vlog_filename.split('/')[-1].split('.')[0]
generatedmodelfile = os.path.join(testdatadir, testname) + '.pb_type.xml'
pbtypeout = vlog_to_pbtype.vlog_to_pbtype([vlog_filename],
generatedmodelfile,
None)
with open(generatedmodelfile, 'w') as model:
model.write(pbtypeout)
convertedgolden = convert.vtr_stylize_xml(testdatafile)
convertedmodel = convert.vtr_stylize_xml(generatedmodelfile)
with open(generatedmodelfile + '.actual', 'w') as model:
model.write(convertedmodel)
assert convertedmodel == convertedgolden
def test_converting_and_merging_fpga_architecture(testdatafile):
inputname = testdatafile.replace('.golden.xml', '.xml')
result = convert.vtr_stylize_xml(inputname)
with open(testdatafile) as res:
golden = res.read()
assert result == golden
def make_xml_for_docs(vlog_src, output_dir):
"""
Recursively runs V2X (model and pb_type) on the given Verilog file and
all its includes. Output XMLs are stylized using vtr-xml-utils.
The Verilog file is copied to the output_dir. All include paths are
updated so that they reflect the module hierarchy. It is assumed that
a Verilog file is named <module>.sim.v. Next V2X is run followed by XML
stylization using vtr-xml-utils.
The process continues recursively (depth-first).
"""
# Make absolute paths
vlog_src = os.path.abspath(vlog_src)
output_dir = os.path.abspath(output_dir)
# Make the output directory
os.makedirs(output_dir, exist_ok=True)
# Copy the verilog file, rearrange includes
vlog_title = os.path.basename(vlog_src)
vlog_dir = os.path.dirname(vlog_src)
vlog_dst = os.path.join(output_dir, vlog_title)
# Scan it for dependencies (includes), rewrite them
# Try also to guess the top-level module name (assuming that there is only
# one module per file!).
vlog_deps = []
vlog_top = None
with open(vlog_src, "r") as fsrc, open(vlog_dst, "w") as fdst:
for src_line in fsrc:
line = src_line.strip()
# Modify included file path
if line.startswith("`include"):
fields = shlex.split(line)
assert len(fields) == 2, fields
dep_src = fields[1]
dep_mod = os.path.basename(dep_src).split(".")[0]
dep_dst = "./{f}/{f}.sim.v".format(f=dep_mod)
vlog_deps.append((dep_src, dep_dst,))
dst_line = "`include \"{}\"\n".format(dep_dst)
# Pass unchanges
else:
dst_line = src_line
# Detect top-level module
# FIXME: This is crude and assumes the syntax "module <name>...".
# Both the keyword and module name must be in the same line
match = MODULE_RE.match(line)
if vlog_top is None and match is not None:
vlog_top = match.group("module")
# Write the line
fdst.write(dst_line)
# Process dependencies recursively first
for dep_src, dep_dst in vlog_deps:
dep_file = os.path.join(vlog_dir, dep_src)
dep_dir = os.path.join(output_dir, os.path.dirname(dep_dst))
make_xml_for_docs(dep_file, dep_dir)
# Run V2X, but only if an XML is not already provided
vlog_mod = vlog_title.split(".")[0]
model_file = os.path.join(output_dir, vlog_mod + ".model.xml")
pbtype_file = os.path.join(output_dir, vlog_mod + ".pb_type.xml")
if not os.path.isfile(model_file):
xml = vlog_to_model.vlog_to_model([vlog_dst], None, vlog_top, model_file)
with open(model_file, "w") as fp:
fp.write(xml)
xml = vtr_stylize_xml(model_file)
with open(model_file, "w") as fp:
fp.write(xml)
if not os.path.isfile(pbtype_file):
xml = vlog_to_pbtype.vlog_to_pbtype([vlog_dst], pbtype_file, vlog_top)
with open(pbtype_file, "w") as fp:
fp.write(xml)
xml = vtr_stylize_xml(pbtype_file)
with open(pbtype_file, "w") as fp:
fp.write(xml)