dot_writer.py revision 10176
19852Sandreas.hansson@arm.com# Copyright (c) 2012-2013 ARM Limited 28999Suri.wiener@arm.com# All rights reserved. 38999Suri.wiener@arm.com# 48999Suri.wiener@arm.com# The license below extends only to copyright in the software and shall 58999Suri.wiener@arm.com# not be construed as granting a license to any other intellectual 68999Suri.wiener@arm.com# property including but not limited to intellectual property relating 78999Suri.wiener@arm.com# to a hardware implementation of the functionality of the software 88999Suri.wiener@arm.com# licensed hereunder. You may use the software subject to the license 98999Suri.wiener@arm.com# terms below provided that you ensure that this notice is replicated 108999Suri.wiener@arm.com# unmodified and in its entirety in all distributions of the software, 118999Suri.wiener@arm.com# modified or unmodified, in source code or in binary form. 128999Suri.wiener@arm.com# 138999Suri.wiener@arm.com# Redistribution and use in source and binary forms, with or without 148999Suri.wiener@arm.com# modification, are permitted provided that the following conditions are 158999Suri.wiener@arm.com# met: redistributions of source code must retain the above copyright 168999Suri.wiener@arm.com# notice, this list of conditions and the following disclaimer; 178999Suri.wiener@arm.com# redistributions in binary form must reproduce the above copyright 188999Suri.wiener@arm.com# notice, this list of conditions and the following disclaimer in the 198999Suri.wiener@arm.com# documentation and/or other materials provided with the distribution; 208999Suri.wiener@arm.com# neither the name of the copyright holders nor the names of its 218999Suri.wiener@arm.com# contributors may be used to endorse or promote products derived from 228999Suri.wiener@arm.com# this software without specific prior written permission. 238999Suri.wiener@arm.com# 248999Suri.wiener@arm.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 258999Suri.wiener@arm.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 268999Suri.wiener@arm.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 278999Suri.wiener@arm.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 288999Suri.wiener@arm.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 298999Suri.wiener@arm.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 308999Suri.wiener@arm.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 318999Suri.wiener@arm.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 328999Suri.wiener@arm.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 338999Suri.wiener@arm.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 348999Suri.wiener@arm.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 358999Suri.wiener@arm.com# 368999Suri.wiener@arm.com# Authors: Andreas Hansson 378999Suri.wiener@arm.com# Uri Wiener 388999Suri.wiener@arm.com 398999Suri.wiener@arm.com##################################################################### 408999Suri.wiener@arm.com# 418999Suri.wiener@arm.com# System visualization using DOT 428999Suri.wiener@arm.com# 438999Suri.wiener@arm.com# While config.ini and config.json provide an almost complete listing 449852Sandreas.hansson@arm.com# of a system's components and connectivity, they lack a birds-eye 459852Sandreas.hansson@arm.com# view. The output generated by do_dot() is a DOT-based figure (as a 469852Sandreas.hansson@arm.com# pdf and an editable svg file) and its source dot code. Nodes are 479852Sandreas.hansson@arm.com# components, and edges represent the memory hierarchy: the edges are 489852Sandreas.hansson@arm.com# directed, from a master to slave. Initially all nodes are 499852Sandreas.hansson@arm.com# generated, and then all edges are added. do_dot should be called 509852Sandreas.hansson@arm.com# with the top-most SimObject (namely root but not necessarily), the 519852Sandreas.hansson@arm.com# output folder and the output dot source filename. From the given 529852Sandreas.hansson@arm.com# node, both processes (node and edge creation) is performed 539852Sandreas.hansson@arm.com# recursivly, traversing all children of the given root. 548999Suri.wiener@arm.com# 558999Suri.wiener@arm.com# pydot is required. When missing, no output will be generated. 568999Suri.wiener@arm.com# 578999Suri.wiener@arm.com##################################################################### 588999Suri.wiener@arm.com 598999Suri.wiener@arm.comimport m5, os, re 608999Suri.wiener@arm.comfrom m5.SimObject import isRoot, isSimObjectVector 6110176Ssascha.bischoff@arm.comfrom m5.params import PortRef 629528Ssascha.bischoff@arm.comfrom m5.util import warn 638999Suri.wiener@arm.comtry: 648999Suri.wiener@arm.com import pydot 658999Suri.wiener@arm.comexcept: 668999Suri.wiener@arm.com pydot = False 678999Suri.wiener@arm.com 688999Suri.wiener@arm.com# need to create all nodes (components) before creating edges (memory channels) 698999Suri.wiener@arm.comdef dot_create_nodes(simNode, callgraph): 708999Suri.wiener@arm.com if isRoot(simNode): 718999Suri.wiener@arm.com label = "root" 728999Suri.wiener@arm.com else: 738999Suri.wiener@arm.com label = simNode._name 748999Suri.wiener@arm.com full_path = re.sub('\.', '_', simNode.path()) 759852Sandreas.hansson@arm.com # add class name under the label 769852Sandreas.hansson@arm.com label = "\"" + label + " \\n: " + simNode.__class__.__name__ + "\"" 778999Suri.wiener@arm.com 788999Suri.wiener@arm.com # each component is a sub-graph (cluster) 798999Suri.wiener@arm.com cluster = dot_create_cluster(simNode, full_path, label) 808999Suri.wiener@arm.com 818999Suri.wiener@arm.com # create nodes per port 828999Suri.wiener@arm.com for port_name in simNode._ports.keys(): 838999Suri.wiener@arm.com port = simNode._port_refs.get(port_name, None) 848999Suri.wiener@arm.com if port != None: 858999Suri.wiener@arm.com full_port_name = full_path + "_" + port_name 868999Suri.wiener@arm.com port_node = dot_create_node(simNode, full_port_name, port_name) 878999Suri.wiener@arm.com cluster.add_node(port_node) 888999Suri.wiener@arm.com 898999Suri.wiener@arm.com # recurse to children 908999Suri.wiener@arm.com if simNode._children: 918999Suri.wiener@arm.com for c in simNode._children: 928999Suri.wiener@arm.com child = simNode._children[c] 938999Suri.wiener@arm.com if isSimObjectVector(child): 948999Suri.wiener@arm.com for obj in child: 958999Suri.wiener@arm.com dot_create_nodes(obj, cluster) 968999Suri.wiener@arm.com else: 978999Suri.wiener@arm.com dot_create_nodes(child, cluster) 988999Suri.wiener@arm.com 998999Suri.wiener@arm.com callgraph.add_subgraph(cluster) 1008999Suri.wiener@arm.com 1018999Suri.wiener@arm.com# create all edges according to memory hierarchy 1028999Suri.wiener@arm.comdef dot_create_edges(simNode, callgraph): 1038999Suri.wiener@arm.com for port_name in simNode._ports.keys(): 1048999Suri.wiener@arm.com port = simNode._port_refs.get(port_name, None) 1058999Suri.wiener@arm.com if port != None: 1068999Suri.wiener@arm.com full_path = re.sub('\.', '_', simNode.path()) 1078999Suri.wiener@arm.com full_port_name = full_path + "_" + port_name 1088999Suri.wiener@arm.com port_node = dot_create_node(simNode, full_port_name, port_name) 1098999Suri.wiener@arm.com # create edges 11010176Ssascha.bischoff@arm.com if isinstance(port, PortRef): 1118999Suri.wiener@arm.com dot_add_edge(simNode, callgraph, full_port_name, port) 1128999Suri.wiener@arm.com else: 1138999Suri.wiener@arm.com for p in port.elements: 1148999Suri.wiener@arm.com dot_add_edge(simNode, callgraph, full_port_name, p) 1158999Suri.wiener@arm.com 1168999Suri.wiener@arm.com # recurse to children 1178999Suri.wiener@arm.com if simNode._children: 1188999Suri.wiener@arm.com for c in simNode._children: 1198999Suri.wiener@arm.com child = simNode._children[c] 1208999Suri.wiener@arm.com if isSimObjectVector(child): 1218999Suri.wiener@arm.com for obj in child: 1228999Suri.wiener@arm.com dot_create_edges(obj, callgraph) 1238999Suri.wiener@arm.com else: 1248999Suri.wiener@arm.com dot_create_edges(child, callgraph) 1258999Suri.wiener@arm.com 1268999Suri.wiener@arm.comdef dot_add_edge(simNode, callgraph, full_port_name, peerPort): 1278999Suri.wiener@arm.com if peerPort.role == "MASTER": 1288999Suri.wiener@arm.com peer_port_name = re.sub('\.', '_', peerPort.peer.simobj.path() \ 1298999Suri.wiener@arm.com + "." + peerPort.peer.name) 1308999Suri.wiener@arm.com callgraph.add_edge(pydot.Edge(full_port_name, peer_port_name)) 1318999Suri.wiener@arm.com 1328999Suri.wiener@arm.comdef dot_create_cluster(simNode, full_path, label): 1339854Sandreas.hansson@arm.com # get the parameter values of the node and use them as a tooltip 1349854Sandreas.hansson@arm.com ini_strings = [] 1359854Sandreas.hansson@arm.com for param in sorted(simNode._params.keys()): 1369854Sandreas.hansson@arm.com value = simNode._values.get(param) 1379854Sandreas.hansson@arm.com if value != None: 1389854Sandreas.hansson@arm.com # parameter name = value in HTML friendly format 1399854Sandreas.hansson@arm.com ini_strings.append(str(param) + "=" + 1409854Sandreas.hansson@arm.com simNode._values[param].ini_str()) 1419854Sandreas.hansson@arm.com # join all the parameters with an HTML newline 1429854Sandreas.hansson@arm.com tooltip = " ".join(ini_strings) 1439854Sandreas.hansson@arm.com 1448999Suri.wiener@arm.com return pydot.Cluster( \ 1458999Suri.wiener@arm.com full_path, \ 1468999Suri.wiener@arm.com shape = "Mrecord", \ 1478999Suri.wiener@arm.com label = label, \ 1489854Sandreas.hansson@arm.com tooltip = "\"" + tooltip + "\"", \ 1498999Suri.wiener@arm.com style = "\"rounded, filled\"", \ 1508999Suri.wiener@arm.com color = "#000000", \ 1519853Sandreas.hansson@arm.com fillcolor = dot_gen_colour(simNode), \ 1528999Suri.wiener@arm.com fontname = "Arial", \ 1538999Suri.wiener@arm.com fontsize = "14", \ 1548999Suri.wiener@arm.com fontcolor = "#000000" \ 1558999Suri.wiener@arm.com ) 1568999Suri.wiener@arm.com 1578999Suri.wiener@arm.comdef dot_create_node(simNode, full_path, label): 1588999Suri.wiener@arm.com return pydot.Node( \ 1598999Suri.wiener@arm.com full_path, \ 1608999Suri.wiener@arm.com shape = "Mrecord", \ 1618999Suri.wiener@arm.com label = label, \ 1628999Suri.wiener@arm.com style = "\"rounded, filled\"", \ 1638999Suri.wiener@arm.com color = "#000000", \ 1649853Sandreas.hansson@arm.com fillcolor = dot_gen_colour(simNode, True), \ 1658999Suri.wiener@arm.com fontname = "Arial", \ 1668999Suri.wiener@arm.com fontsize = "14", \ 1678999Suri.wiener@arm.com fontcolor = "#000000" \ 1688999Suri.wiener@arm.com ) 1698999Suri.wiener@arm.com 1709853Sandreas.hansson@arm.com# an enumerator for different kinds of node types, at the moment we 1719853Sandreas.hansson@arm.com# discern the majority of node types, with the caches being the 1729853Sandreas.hansson@arm.com# notable exception 1739853Sandreas.hansson@arm.comclass NodeType: 1749853Sandreas.hansson@arm.com SYS = 0 1759853Sandreas.hansson@arm.com CPU = 1 1769853Sandreas.hansson@arm.com BUS = 2 1779853Sandreas.hansson@arm.com MEM = 3 1789853Sandreas.hansson@arm.com DEV = 4 1799853Sandreas.hansson@arm.com OTHER = 5 1809853Sandreas.hansson@arm.com 1819853Sandreas.hansson@arm.com# based on the sim object, determine the node type 1829853Sandreas.hansson@arm.comdef get_node_type(simNode): 1839853Sandreas.hansson@arm.com if isinstance(simNode, m5.objects.System): 1849853Sandreas.hansson@arm.com return NodeType.SYS 1859853Sandreas.hansson@arm.com # NULL ISA has no BaseCPU or PioDevice, so check if these names 1869853Sandreas.hansson@arm.com # exists before using them 1879853Sandreas.hansson@arm.com elif 'BaseCPU' in dir(m5.objects) and \ 1889853Sandreas.hansson@arm.com isinstance(simNode, m5.objects.BaseCPU): 1899853Sandreas.hansson@arm.com return NodeType.CPU 1909853Sandreas.hansson@arm.com elif 'PioDevice' in dir(m5.objects) and \ 1919853Sandreas.hansson@arm.com isinstance(simNode, m5.objects.PioDevice): 1929853Sandreas.hansson@arm.com return NodeType.DEV 1939853Sandreas.hansson@arm.com elif isinstance(simNode, m5.objects.BaseBus): 1949853Sandreas.hansson@arm.com return NodeType.BUS 1959853Sandreas.hansson@arm.com elif isinstance(simNode, m5.objects.AbstractMemory): 1969853Sandreas.hansson@arm.com return NodeType.MEM 1979853Sandreas.hansson@arm.com else: 1989853Sandreas.hansson@arm.com return NodeType.OTHER 1999853Sandreas.hansson@arm.com 2009853Sandreas.hansson@arm.com# based on the node type, determine the colour as an RGB tuple, the 2019853Sandreas.hansson@arm.com# palette is rather arbitrary at this point (some coherent natural 2029853Sandreas.hansson@arm.com# tones), and someone that feels artistic should probably have a look 2039853Sandreas.hansson@arm.comdef get_type_colour(nodeType): 2049853Sandreas.hansson@arm.com if nodeType == NodeType.SYS: 2059853Sandreas.hansson@arm.com return (228, 231, 235) 2069853Sandreas.hansson@arm.com elif nodeType == NodeType.CPU: 2079853Sandreas.hansson@arm.com return (187, 198, 217) 2089853Sandreas.hansson@arm.com elif nodeType == NodeType.BUS: 2099853Sandreas.hansson@arm.com return (111, 121, 140) 2109853Sandreas.hansson@arm.com elif nodeType == NodeType.MEM: 2119853Sandreas.hansson@arm.com return (94, 89, 88) 2129853Sandreas.hansson@arm.com elif nodeType == NodeType.DEV: 2139853Sandreas.hansson@arm.com return (199, 167, 147) 2149853Sandreas.hansson@arm.com elif nodeType == NodeType.OTHER: 2159853Sandreas.hansson@arm.com # use a relatively gray shade 2169853Sandreas.hansson@arm.com return (186, 182, 174) 2179853Sandreas.hansson@arm.com 2189853Sandreas.hansson@arm.com# generate colour for a node, either corresponding to a sim object or a 2199853Sandreas.hansson@arm.com# port 2209853Sandreas.hansson@arm.comdef dot_gen_colour(simNode, isPort = False): 2219853Sandreas.hansson@arm.com # determine the type of the current node, and also its parent, if 2229853Sandreas.hansson@arm.com # the node is not the same type as the parent then we use the base 2239853Sandreas.hansson@arm.com # colour for its type 2249853Sandreas.hansson@arm.com node_type = get_node_type(simNode) 2259853Sandreas.hansson@arm.com if simNode._parent: 2269853Sandreas.hansson@arm.com parent_type = get_node_type(simNode._parent) 2279853Sandreas.hansson@arm.com else: 2289853Sandreas.hansson@arm.com parent_type = NodeType.OTHER 2299853Sandreas.hansson@arm.com 2309853Sandreas.hansson@arm.com # if this node is the same type as the parent, then scale the 2319853Sandreas.hansson@arm.com # colour based on the depth such that the deeper levels in the 2329853Sandreas.hansson@arm.com # hierarchy get darker colours 2339853Sandreas.hansson@arm.com if node_type == parent_type: 2349853Sandreas.hansson@arm.com # start out with a depth of zero 2359853Sandreas.hansson@arm.com depth = 0 2369853Sandreas.hansson@arm.com parent = simNode._parent 2379853Sandreas.hansson@arm.com # find the closes parent that is not the same type 2389853Sandreas.hansson@arm.com while parent and get_node_type(parent) == parent_type: 2399853Sandreas.hansson@arm.com depth = depth + 1 2409853Sandreas.hansson@arm.com parent = parent._parent 2419853Sandreas.hansson@arm.com node_colour = get_type_colour(parent_type) 2429853Sandreas.hansson@arm.com # slightly arbitrary, but assume that the depth is less than 2439853Sandreas.hansson@arm.com # five levels 2449853Sandreas.hansson@arm.com r, g, b = map(lambda x: x * max(1 - depth / 7.0, 0.3), node_colour) 2459853Sandreas.hansson@arm.com else: 2469853Sandreas.hansson@arm.com node_colour = get_type_colour(node_type) 2479853Sandreas.hansson@arm.com r, g, b = node_colour 2489853Sandreas.hansson@arm.com 2499853Sandreas.hansson@arm.com # if we are colouring a port, then make it a slightly darker shade 2509853Sandreas.hansson@arm.com # than the node that encapsulates it, once again use a magic constant 2519853Sandreas.hansson@arm.com if isPort: 2529853Sandreas.hansson@arm.com r, g, b = map(lambda x: 0.8 * x, (r, g, b)) 2538999Suri.wiener@arm.com 2549852Sandreas.hansson@arm.com return dot_rgb_to_html(r, g, b) 2559852Sandreas.hansson@arm.com 2569852Sandreas.hansson@arm.comdef dot_rgb_to_html(r, g, b): 2578999Suri.wiener@arm.com return "#%.2x%.2x%.2x" % (r, g, b) 2588999Suri.wiener@arm.com 2598999Suri.wiener@arm.comdef do_dot(root, outdir, dotFilename): 2608999Suri.wiener@arm.com if not pydot: 2618999Suri.wiener@arm.com return 2629852Sandreas.hansson@arm.com # * use ranksep > 1.0 for for vertical separation between nodes 2639852Sandreas.hansson@arm.com # especially useful if you need to annotate edges using e.g. visio 2649852Sandreas.hansson@arm.com # which accepts svg format 2659852Sandreas.hansson@arm.com # * no need for hoizontal separation as nothing moves horizonally 2669852Sandreas.hansson@arm.com callgraph = pydot.Dot(graph_type='digraph', ranksep='1.3') 2678999Suri.wiener@arm.com dot_create_nodes(root, callgraph) 2688999Suri.wiener@arm.com dot_create_edges(root, callgraph) 2698999Suri.wiener@arm.com dot_filename = os.path.join(outdir, dotFilename) 2708999Suri.wiener@arm.com callgraph.write(dot_filename) 2718999Suri.wiener@arm.com try: 2728999Suri.wiener@arm.com # dot crashes if the figure is extremely wide. 2738999Suri.wiener@arm.com # So avoid terminating simulation unnecessarily 2749852Sandreas.hansson@arm.com callgraph.write_svg(dot_filename + ".svg") 2758999Suri.wiener@arm.com callgraph.write_pdf(dot_filename + ".pdf") 2768999Suri.wiener@arm.com except: 2779853Sandreas.hansson@arm.com warn("failed to generate dot output from %s", dot_filename) 278