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
###############################################################################
# Copyright (c) 2018-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.
# =============================================================================
#   @script
#       Create Inventory Report of the loaded design.
###############################################################################


# =============================================================================
# Configure lists to either keep or skip cells matching the given patterns.
# =============================================================================
#
set Inventory(keepCells) {}
set Inventory(skipCells) {}


# =============================================================================
# Report - Create an inventory report of the loaded design in the form:
#          <primitive_name>: <number of instances>
#          ...
# =============================================================================
#
proc Inventory:Report {db fname} {
    global Inventory

    ##
    # Return if no database is given.
    #
    if {$db == {}} {
        zmessage print ERR "Inventory Report: no database."
        return
    }

    ##
    # Return if no filename is given.
    #
    if {$fname == {}} {
        zmessage print ERR "Inventory Report: no output filename."
        return
    }

    ##
    # Return if a keep and skip list is given.
    #
    if {($Inventory(keepCells) != {}) && ($Inventory(skipCells) != {})} {
        zmessage print ERR "options '-keep' and '-skip' are mutual exclusive."
        return
    }

    ##
    # Open the output file where the collected inventory information is stored.
    #
    set out [open $fname "w"]

    ##
    # Fill the array 'reportTab' with the design statistics.
    #
    array set reportTab {}
    $db report instCount reportTab [$db get_top_design]

    ##
    # Fill the report list with the primitive statistic.
    #
    set report {}
    foreach {name count} [array get reportTab] {
        ##
        # Skip non-primitive cells.
        #
        if {[string index $name 0] ne "P"} {
            continue
        }

        ##
        # Set the actual cell name.
        #
        set name [string range $name 1 end]

        ##
        # Check if this cell should be kept or skipped.
        #
        set keep true
        foreach keepPattern $Inventory(keepCells) {
            set keep false
            if {[string match $keepPattern $name]} {
                set keep true
                break
            }
        }
        foreach skipPattern $Inventory(skipCells) {
            set keep true
            if {[string match $skipPattern $name]} {
                set keep false
                break
            }
        }

        ##
        # Add this cell to the final report of 'keep' is true.
        #
        if {$keep} {
            lappend report [list $name $count]
        }
    }

    ##
    # Sort the report list and create the report file.
    #
    foreach item [lsort -integer -decreasing -index 1 $report] {
        puts $out "[lindex $item 0]: [lindex $item 1]"
    }

    ##
    # Close the report file.
    #
    close $out
}


# -----------------------------------------------------------------------------
# _startFromMenu - Invoke the report procedure from the main menu.
# -----------------------------------------------------------------------------
#
proc Inventory:_startFromMenu {} {
    ##
    # Ask the user for a file name.
    #
    set fname [gui window fileDialog saveFile "Inventory Report" \
                {{"Report File" {.txt}}}]

    if {$fname != {}} {
        Inventory:Report [gui database get] $fname
    }
}


# =============================================================================
# If running in a *Vision GUI then extend the main menu and add
# an "Save Inventory Report" entry.
# =============================================================================
#
if {[string match "*vision*" [file tail [info nameofexecutable]]]} {
    gui menu command {"Userware" "Save Inventory Report"} \
        "Inventory:_startFromMenu"
}


# =============================================================================
# If a binfile and an output file is given on the command line then open the
# binfile and invoke the Inventory:Report procedure with the opened database
# and given output filename.
# =============================================================================
#
if {$argc >= 2} {
    set db [zdb open [lindex $argv 0]]
    if {$argc >= 4} {
        set mode    [lindex $argv 2]
        switch -- $mode {
            "-keep" {
                set key "keepCells"
            }
            "-skip" {
                set key "skipCells"
            }
            default {
                error "Unknown option '$mode', use either -keep or -skip."
            }
        }
        foreach pattern [lrange $argv 3 end] {
            lappend Inventory($key) $pattern
        }
    }
    Inventory:Report $db [lindex $argv 1]
    $db close
}