HLTCFDot.py

Go to the documentation of this file.

# Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
 

 
from AthenaCommon.AlgSequence import AthSequencer
from TriggerMenuMT.HLT.Config.ControlFlow.HLTCFTools import algColor
from TriggerMenuMT.HLT.Config.ControlFlow.HLTCFComponents import isPassSequence
import itertools
from AthenaCommon.CFElements import isSequence
 
 
DrawHypoTools=True
 
def drawHypoTools(file, all_hypos):
    all_hypos=list(set(all_hypos))
    for hp in all_hypos:
        for hypotool in hp.Alg.HypoTools:
            file.write("   \"%s\"[fillcolor=yellow,style=filled,shape= Mdiamond]\n" % hypotool.getName())
            file.write("   \"%s\" -> \"%s\" [style=dashed, color=grey]\n" % (hp.Alg.name, hypotool.getName()))
 
 
def stepCF_ControlFlow_to_dot(stepCF):
    def _dump (seq, indent):
        o = list()
        if isSequence(seq):
            for c in seq.Members:
                if isSequence(c):
                    o.append( ("%s[color=%s, shape=circle, width=.5, fixedsize=true ,style=filled]\n"%(c.name,_seqColor(c)), indent) )
                else:
                    o.append( ("%s[fillcolor=%s,style=filled]\n"%(c.name,algColor(c)), indent) )
                o.append( ("%s -> %s\n"%(seq.name, c.name), indent))
                o.extend( _dump (c, indent+1) )
        return o
 
    def _parOR (seq):
        try:
            if seq.ModeOR is True:
                if seq.Sequential is False:
                    if seq.StopOverride is True:
                        return True
        except AttributeError:
            return False # Offline sequence may not have these set
        return False
 
    def _seqAND(seq):
        try:
            if seq.ModeOR is False:
                if seq.Sequential is True:
                    if seq.StopOverride is False:
                        return True
        except AttributeError:
            return False # Offline sequence may not have these set
        return False
 
    def _seqColor(seq):
        if _parOR(seq): 
            return "red"
        if _seqAND(seq): 
            return "dodgerblue3"
 
        return "black"
 
   
 
    with open('%s.CF.dot'%stepCF.name, mode="wt") as file:
    #strict
        file.write( 'digraph step  {  \n'\
                    +' concentrate=true;\n'\
                    +' rankdir="LR";\n'
                    +'  node [ shape=polygon, fontname=Helvetica ]\n'\
                    +'  edge [ fontname=Helvetica ]\n'
                    +'  %s   [shape=Mdiamond]\n'%stepCF.name)
 
        indent=0
    #    out = [("%s[color=%s shape=circle]\n"%(stepCF.getName(),_seqColor(stepCF)), indent)]
        out = [("",indent)]
        out.extend( _dump( stepCF, indent=indent+1 ) )
        for n,i in out:
            line= "  "*i+ n
            file.write(line)
 
        file.write( '}\n')
 
 
 
def all_DataFlow_to_dot(name, step_list):
    with open('%s.dot'%(name), mode="wt") as file:
        file.write( 'digraph step  {  \n'\
                        +' concentrate=true;\n'\
                        +' rankdir="LR";\n'
                        +'  node [ shape=polygon, fontname=Helvetica ]\n'\
                        +'  edge [ fontname=Helvetica ]\n'
                        +'  %s   [shape=Mdiamond]\n'%name)
 
        nstep=1
        last_step_hypoNodes=[]
        all_hypos=[]
        for cfseq_list in step_list:
            # loop over steps
            step_connections = []
            step_connections.extend(last_step_hypoNodes)
            # reset the last step
            last_step_hypoNodes =[]
            for cfseq in cfseq_list:
                file.write("  %s[fillcolor=%s style=filled]\n"%(cfseq.sequenceCA.filterNode.Alg.name,algColor(cfseq.sequenceCA.filterNode.Alg)))
                step_connections.append(cfseq.sequenceCA.filterNode)                      
                file.write(  '\n  subgraph cluster_%s {\n'%(cfseq.sequenceCA.step.name)\
                            +'     concentrate=true;\n'
                            +'     node [color=white style=filled]\n'\
                            +'     style=filled\n'\
                            +'     color=lightgrey\n'\
                            +'     fontname=Helvetica\n'\
                            +'     label = %s\n'%(cfseq.sequenceCA.step.name))
 
                cfseq_algs = []
                cfseq_algs.append(cfseq.sequenceCA.filterNode)
 
                if len(cfseq.sequenceCA.step.sequences)==0:
                    last_step_hypoNodes.append(cfseq.sequenceCA.filterNode)
 
                for menuseq in cfseq.sequenceCA.step.sequences:
                    cfseq_algs, all_hypos, last_step_hypoNodes = menuseq.buildDFDot(cfseq_algs,
                                                                                    all_hypos,                                                                                    
                                                                                    last_step_hypoNodes,
                                                                                    file)
 
                                                                                     
                if cfseq.sequenceCA.step.combo is not None:
                    file.write("    %s[color=%s]\n"%(cfseq.sequenceCA.step.combo.Alg.name, algColor(cfseq.sequenceCA.step.combo.Alg)))
                    cfseq_algs.append(cfseq.sequenceCA.step.combo)
                    last_step_hypoNodes.append(cfseq.sequenceCA.step.combo)
                file.write('  }\n')              
                file.write(findConnections(cfseq_algs))
                file.write('\n')
 
#            print ("Step connections: ")
#            print (step_connections)
            file.write(findConnections(step_connections))
            nstep+=1
 
        file.write( '}')
        file.close()
    
 
def stepCF_DataFlow_to_dot(name, cfseq_list):
    with open( '%s.DF.dot'%name, mode="wt" ) as file:
    #strict
        file.write( 'digraph step  {  \n'\
                    +' concentrate=true; \n'\
                    +' rankdir="LR";\n'
                    +'  node [ shape=polygon, fontname=Helvetica ]\n'\
                    +'  edge [ fontname=Helvetica ]\n'
                    +'  %s   [shape=Mdiamond]\n'%name)
 
 
        all_hypos = []
        for cfseq in cfseq_list:
            file.write("  %s[fillcolor=%s style=filled]\n"%(cfseq.sequenceCA.filterNode.Alg.name,algColor(cfseq.sequenceCA.filterNode.Alg)))
            for inp in cfseq.sequenceCA.filterNode.getInputList():
                file.write(addConnection(name, cfseq.sequenceCA.filterNode.Alg.name, inp))
 
            file.write(  '\n  subgraph cluster_%s {\n'%(cfseq.sequenceCA.step.name)\
                        +'     concentrate=true;\n'
                        +'     node [color=white style=filled]\n'\
                        +'     style=filled\n'\
                        +'     color=lightgrey\n'\
                        +'     fontname=Helvetica\n'\
                        +'     label = %s\n'%(cfseq.sequenceCA.step.name))
 
            cfseq_algs = []
            cfseq_algs.append(cfseq.sequenceCA.filterNode)
 
            for menuseq in cfseq.sequenceCA.step.sequences:
                    cfseq_algs, all_hypos, _ = menuseq.buildDFDot(cfseq_algs,
                                                                  all_hypos,                                                                 
                                                                  None,
                                                                  file)
            if cfseq.sequenceCA.step.combo is not None:
                file.write("    %s[color=%s]\n"%(cfseq.sequenceCA.step.combo.Alg.name, algColor(cfseq.sequenceCA.step.combo.Alg)))
                cfseq_algs.append(cfseq.sequenceCA.step.combo)
            file.write('  }\n')              
 
            file.write(findConnections(cfseq_algs))
            file.write('\n')
 
        if DrawHypoTools:
            drawHypoTools(file, all_hypos)
            
        file.write( '}')
        file.close()
 
 
def findConnections(alg_list):
    lineconnect=''
 
    alg_set = set(alg_list) # make them unique
    for nodeA, nodeB in itertools.permutations(alg_set, 2):
        if isPassSequence(nodeA) or isPassSequence(nodeB):
            continue
        ins=nodeB.getInputList()
        outs=nodeA.getOutputList()       
        dataIntersection = list(set(outs) & set(ins))
        if len(dataIntersection) > 0:
            for line in dataIntersection:
                lineconnect+=addConnection(nodeA.Alg.name, nodeB.Alg.name, line)
                #print ("Data connections between ", compName(nodeA.Alg)," and ",compName(nodeB.Alg) ,": ", line)
 
    return lineconnect
 
 
def findConnections_within_sequence(alg_list):
    lineconnect=''
    import itertools
    for nodeA, nodeB in itertools.combinations(alg_list, 2):
        lineconnect+=findDHconnections(nodeA, nodeB)                                    
    return lineconnect
 
def findDHconnections(nodeA, nodeB):
    lineconnect=''
    # search connections vis DH
    outs= getValuesProperties(nodeA)
    ins = getValuesProperties(nodeB)
    dataIntersection = list(set(outs) & set(ins))
    if len(dataIntersection) > 0:
        for line in dataIntersection:
            lineconnect+=addConnection(nodeA.Alg.name, nodeB.Alg.name, line)
            #print 'Data DH connections between %s and %s: %s'%(nodeA.Alg.getName(), nodeB.Alg.getName(), line)
    return lineconnect
    
 
 
def getValuesProperties(node):
    Excluded = ["StoreGateSvc/DetectorStore", "StoreGateSvc"]
    values = []
    algs = []
    if isinstance(node.Alg, AthSequencer):
         seq=node.Alg
         seq.Members.pop(0) # remove InputMaker
    else:
        algs.append(node.Alg)
 
    
    for alg in algs:        
        for k, cval in alg.getValuedProperties().items():
            if type(cval) is list:  
                for val in cval:
                    if val == '': # CAT type(val) is None ??
                        if val not in Excluded:
                            values.append(val)            
            elif cval == '': # CAT type(val) is None ??
                if cval not in Excluded:
                    values.append(cval)
            else:
                continue
    return set(values)
        
 
def addConnection(nodeA, nodeB, label=''):
    line = "    %s -> %s \n"%(nodeA,nodeB)
    #line = "    %s -> %s [label=%s]\n"%(nodeA,nodeB,label)
    # print line
    return line