1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
###############################################################################
# Copyright (c) 2005-2024 by Altair Engineering, Inc.
# All rights reserved.
#
# Altair Engineering, Inc. makes this software available as part of the Vision
# tool platform.  As long as you are a licensee of the Vision tool platform
# you may make copies of the software and modify it to be used within the
# Vision tool platform, but you must include all of this notice on any copy.
# Redistribution without written permission to any third party, with or
# without modification, is not permitted.
# Altair Engineering, Inc. does not warrant that this software is error free
# or fit for any purpose.  Altair Engineering, Inc. disclaims any liability for
# all claims, expenses, losses, damages and costs any user may incur as a
# result of using, copying or modifying the software.
# =============================================================================
#   @plugin
#       Cone Status
#   @namespace
#       ConeStatus
#   @section
#       Miscellaneous Userware Examples
#   @description
#       Add a main menu entry to highlight complete or empty modules loaded
#       in the Cone window in different colors.
#   @files
#       coneStatus.tcl
#   @example
#       demo/rtl/aquarius/aquarius.f
#   @cmdline
#       -F @example[0]
#       -userware @files[0]
#   @tag
#       zdb gui
###############################################################################


# =============================================================================
# Init - Initialize the plugin.
# =============================================================================
#
proc ConeStatus:Init {} {
    ##
    # Add menu entries.
    #
    gui menu submenu {"Userware" "Cone Status"}
    gui menu command {"Userware" "Cone Status" "Highlight"} \
        [list ConeStatus:Run 1 0]
    gui menu command {"Userware" "Cone Status" "Dump"} \
        [list ConeStatus:Run 0 1]
    gui menu command {"Userware" "Cone Status" "Highlight & Dump"} \
        [list ConeStatus:Run 1 1]
}


# =============================================================================
# Finit - Finalize the plugin.
# =============================================================================
#
proc ConeStatus:Finit {} {
    ##
    # Undo modifications of the GUI.
    #
    gui menu removeEntry {"Userware" "Cone Status"}
}


# =============================================================================
# Run - If $highlight is true then this procedure highlights modules which are
#       completed in the cone window with color 1 and empty modules with
#       color 2.
#       If $dump is true then this procedure dumps a status of the cone window
#       to a file.
# =============================================================================
#
proc ConeStatus:Run {highlight dump} {
    ##
    # Get the database.
    #
    set db [gui database get]

    ##
    # Get the contents of the Cone window.
    #
    set oidList [gui cone contents]

    ##
    # Initialize some local lists.
    #
    set moduleList   {}
    set emptyMods    {}
    set completeMods {}

    ##
    # Browse for an output file.
    #
    if {$dump} {
        set file [gui window fileDialog saveFile "Dump Cone Status to File" \
                                          {{"Text Files" {.txt}}}]
        if {$file == ""} {
            return
        }
        set out [open $file w]
    }

    ##
    # Loop over all objects in the Cone window:
    # - Collect a list of modules.
    # - Flag all objects
    #
    foreach oid $oidList {
        if {([$db oid type $oid] == "inst") && [$db isModule $oid]} {
            lappend moduleList $oid
        }
        $db flatflag $oid set white
    }

    ##
    # Delete all existing highlights for color 1 and 2
    #
    if {$highlight} {
        $db flathilight * deleteAll 1
        $db flathilight * deleteAll 2
    }

    ##
    # Collect the list of empty and complete modules.
    #
    foreach oid $moduleList {
        if {[ConeStatus:_isEmpty $db $oid]} {
            lappend emptyMods $oid
        }
        if {[ConeStatus:_isFull  $db $oid]} {
            lappend completeMods $oid
        }
    }

    ##
    # Loop over the list of complete modules and highlight or dump them.
    #
    foreach oid $completeMods {
        if {$highlight} {
            $db flathilight $oid set 1
        }
        if {$dump}      {
            puts $out "COMPLETE: $oid"
        }
    }

    ##
    # Loop over the list of empty modules and highlight or dump them.
    #
    foreach oid $emptyMods {
        if {$highlight} {
            $db flathilight $oid set 2
        }
        if {$dump}      {
            puts $out "EMPTY:    $oid"
        }
    }

    ##
    # Inform the GUI that the highlight has changed.
    #
    if {$highlight} {
        gui highlight changed
    }

    ##
    # Remove the use flag
    #
    foreach oid $oidList {
        $db flatflag $oid clear white
    }

    ##
    # Close the output file.
    #
    if {$dump} {
        close $out
    }
}


# -----------------------------------------------------------------------------
# _isEmpty - return true if $oid is an empty module.
# -----------------------------------------------------------------------------
#
proc ConeStatus:_isEmpty {db oid} {
    set oid [$db moduleOf $oid]
    $db foreach inst   $oid i {
        if {[$db flatflag $i is white]} {
            return false
        }
    }
    $db foreach net    $oid n {
        if {[$db flatflag $n is white]} {
            return false
        }
    }
    $db foreach netBus $oid n {
        if {[$db flatflag $n is white]} {
            return false
        }
    }
    return true
}


# -----------------------------------------------------------------------------
# _isFull - return true if $oid is completely loaded to the Cone.
# -----------------------------------------------------------------------------
#
proc ConeStatus:_isFull {db oid} {
    set oid [$db moduleOf $oid]
    $db foreach inst   $oid i {
        if {![$db flatflag $i is white]} {
            return false
        }
    }
    $db foreach net    $oid n {
        if {![$db flatflag $n is white]} {
            return false
        }
    }
    $db foreach netBus $oid n {
        if {![$db flatflag $n is white]} {
            return false
        }
    }
    return true
}


# =============================================================================
# Call the initialization procedure.
# =============================================================================
#
ConeStatus:Init