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
###############################################################################
# Copyright (c) 2023-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.
# =============================================================================
#   @userware
#       Flat Modules in the Design
#   @section
#       Modify the Loaded Database
#   @description
#       Flat all instances of a given module.
#       For the simple case of only one hierarchy '$db oper expand' may be an
#       simpler approach.
#   @files
#       cust11/flatModule.tcl
#   @example
#       demo/spice/param.sp
#   @cmdline
#       -hspice @example[0]
#       -userware @files[0]
#   @tag
#       zdb netlist
###############################################################################


# -----------------------------------------------------------------------------
# _main - collect all instances of modules which should be flattened.
#         sort list to process deepest instances first.
#         singlize each instance before rmhier.
# -----------------------------------------------------------------------------
#
proc FlatModule:_main {db moduleNameList} {
    global FlatModule

    foreach moduleName $moduleNameList {
        set FlatModule(moduleName:$moduleName) 1
    }

    set top [$db get_top_design]

    FlatModule:_process $db $top false

    set instList [lsort -command FlatModule:_cmpLength $FlatModule(instList)]

    foreach inst $instList {
        $db oper singlize $inst
        FlatModule:_updateAttrs $db $inst
        $db oper rmhier $inst -delzombies
    }
}


# -----------------------------------------------------------------------------
# _cmpLength - compare length of instance paths.
# -----------------------------------------------------------------------------
#
proc FlatModule:_cmpLength {a b} {
    set la [llength $a]
    set lb [llength $b]
    return [expr {-($la - $lb)}]
}


# -----------------------------------------------------------------------------
# _updateAttrs - update attribute values.
# -----------------------------------------------------------------------------
#
proc FlatModule:_updateAttrs {db parentInst} {
    set downModule [$db down $parentInst]

    $db foreach inst $downModule inst {
        set newAttrs {}
        $db attr $inst foreach attr {
            set pos [string first "=" $attr]
            if {$pos < 0} {
                continue
            }
            set name  [string range $attr 0 [expr {$pos - 1}]]
            set value [string range $attr [expr {$pos + 1}] end]
            if {$value != ""} {
                set newValue ""
                set len [string length $value]
                for {set i 0} {$i < $len} {incr i} {
                    set c [string index $value $i]
                    if {[string is alnum -strict $c] || ($c == ".")} {
                        set n ""
                        while {[string is alnum -strict $c] || ($c == ".")} {
                            append n $c
                            incr i
                            set c [string index $value $i]
                        }
                        incr i -1
                        set v [$db attr $parentInst getValue $n]
                        set v [string trim $v "\""]
                        set v [string trim $v "'"]
                        if {$v != ""} {
                            append newValue "($v)"
                        } else {
                            append newValue $n
                        }
                    } else {
                        append newValue $c
                    }
                }
                set str [string trim $newValue "\""]
                set str [string trim $newValue "'"]
                if {![catch {expr $str} ex]} {
                    set newValue $ex
                }
                set newAttr "$name=$newValue"
                lappend newAttrs $newAttr
            }
        }
        foreach newAttr $newAttrs {
            $db attr $inst set $newAttr
        }
    }
}


# -----------------------------------------------------------------------------
# _process - process all instances of given module.
#            recursive decent to all sub module instances.
#            collect all instances which should be removed.
# -----------------------------------------------------------------------------
#
proc FlatModule:_process {db module flatten} {
    global FlatModule

    set moduleName [$db oid oname $module]
    if {[info exists FlatModule(processed:$moduleName)]} {
        return
    }

    $db foreach inst $module inst {
        if {![$db isModule $inst]} {
            continue
        }

        set downModule [$db down $inst]
        set downName [$db oid oname $downModule]
        if {[info exists FlatModule(moduleName:$downName)]} {
            set flatten true
        }

        if {$flatten} {
            lappend FlatModule(instList) $inst
        }

        FlatModule:_process $db $downModule $flatten
    }

    set FlatModule(processed:$moduleName) 1
}


# -----------------------------------------------------------------------------
# _run - start with given list of modules.
# -----------------------------------------------------------------------------
#
proc FlatModule:_run {db} {
    set moduleList {
        inv
        inv2
        nand2
    }

    if {$db != {}} {
        $db flat tree use false
        FlatModule:_main $db $moduleList
    }
}


##
# Use gui database runOrRegisterChangedCallback to immediately run
# FlatModule:_run if we have a database, or otherwise register the proc to
# be executed after the database is available.
#
gui database runOrRegisterChangedCallback FlatModule:_run