forked from github/verilator
149 lines
5.5 KiB
Python
Executable File
149 lines
5.5 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
# -*- Python -*- See copyright, etc below
|
|
# pylint: disable=C0103,C0114,C0115,C0115,C0116,C0209,R0914
|
|
######################################################################
|
|
|
|
import argparse
|
|
import os
|
|
import subprocess
|
|
import tempfile
|
|
import xml.etree.ElementTree as ET
|
|
# from pprint import pprint, pformat
|
|
|
|
#######################################################################
|
|
|
|
|
|
class VlHierGraph:
|
|
|
|
def __init__(
|
|
self,
|
|
verilator_args, # presently all verilator options are passed-thru
|
|
debug=0,
|
|
output_filename='graph.dot'): # output filename
|
|
self.debug = debug
|
|
self.next_vertex_number = 0
|
|
self.name_to_number = {}
|
|
|
|
with tempfile.NamedTemporaryFile() as xml_temp:
|
|
vargs = [
|
|
'--xml-output',
|
|
xml_temp.name,
|
|
'--bbox-sys', # Parse some stuff can't translate
|
|
'--bbox-unsup',
|
|
'--prefix vlxml'
|
|
] # So we know name of .xml output
|
|
vargs += verilator_args
|
|
self.run_verilator(vargs)
|
|
self.tree = ET.parse(xml_temp.name)
|
|
|
|
with open(output_filename, "w", encoding="utf8") as fh:
|
|
# For more serious purposes, use the python graphviz package instead
|
|
fh.write("digraph {\n")
|
|
fh.write(" dpi=300;\n")
|
|
fh.write(" order=LR;\n")
|
|
fh.write(
|
|
" node [fontsize=8 shape=\"box\" margin=0.01 width=0 height=0]"
|
|
)
|
|
fh.write(" edge [fontsize=6]")
|
|
# Find cells
|
|
root = self.tree.getroot()
|
|
netlist = root.find('netlist')
|
|
for module in netlist.findall('module'):
|
|
# origNames are before parameterization, name if after
|
|
mod_name = module.get('name')
|
|
mod_number = self.name_to_vertex_number(mod_name)
|
|
fh.write(" n%d [label=\"%s\"" % (mod_number, mod_name))
|
|
if module.get('topModule'):
|
|
fh.write(" color=\"red\" rank=1")
|
|
fh.write("];\n")
|
|
|
|
for instance in module.findall('instance'):
|
|
inst_name = instance.get('name')
|
|
def_name = instance.get('defName')
|
|
def_number = self.name_to_vertex_number(def_name)
|
|
fh.write(" n%d->n%d [label=\"%s\"];\n" %
|
|
(mod_number, def_number, inst_name))
|
|
|
|
fh.write("}\n")
|
|
|
|
def name_to_vertex_number(self, name):
|
|
if name not in self.name_to_number:
|
|
self.next_vertex_number += 1
|
|
self.name_to_number[name] = self.next_vertex_number
|
|
return self.name_to_number[name]
|
|
|
|
def run_verilator(self, vargs):
|
|
"""Run Verilator command, check errors"""
|
|
if os.getenv("VERILATOR_ROOT"):
|
|
command = os.getenv("VERILATOR_ROOT") + "/bin/verilator"
|
|
else:
|
|
command = "verilator"
|
|
command += ' ' + ' '.join(vargs)
|
|
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 create a .dot file showing the
|
|
design module hierarchy.
|
|
|
|
Example usage:
|
|
vl_hier_graph -f input.vc top.v -o graph.dot
|
|
dot -Tpdf -o graph.pdf graph.dot
|
|
""",
|
|
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('-o',
|
|
'--o',
|
|
action='store',
|
|
metavar='filename',
|
|
required=True,
|
|
help='output filename')
|
|
(args, rem) = parser.parse_known_args()
|
|
|
|
print(
|
|
"NOTE: vl_hier_graph 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 = VlHierGraph(output_filename=args.o,
|
|
debug=args.debug,
|
|
verilator_args=rem)
|
|
|
|
######################################################################
|
|
# Local Variables:
|
|
# compile-command: "./vl_hier_graph -h ; VERILATOR_ROOT=$V4 ./vl_hier_graph +define+thru top.v"
|
|
# End:
|