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 | ###############################################################################
# Copyright (c) 2020-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
# Report Instance Parameters
# @section
# Create Reports
# @description
# Example Tcl script that uses ZDB API commands to extract non-default
# instance parameters and print a report to an output file.
# Usage:
# starsh reportInstanceParameters.tcl design.zdb report.txt
# @files
# cust33/reportInstanceParameters.tcl
# @tag
# zdb batch report rtl
###############################################################################
# =============================================================================
# Start - Report instances with non-default parameters.
# =============================================================================
#
proc ReportInstanceParameters:Start {db report} {
##
# Open the report file.
#
set out [open $report "w"]
##
# Mark all cells containing parameter values in their name with $flag.
# Clear flags first.
#
set flag "red"
$db flag -db clear $flag
set hasFlaggedCells 0
$db foreach cell cell {
##
# Determine the cell's name, which may contain parameter values.
#
set name [$db oid oname $cell]
##
# Check if there are parameter values.
#
if {[regexp {^.*\(.*\).*$} $name]} {
##
# Mark the cell with $flag.
#
$db flag $cell set $flag
set hasFlaggedCells 1
}
}
##
# No parametrized cells found.
#
if {!$hasFlaggedCells} {
puts $out "No instances with non-default parameters in design."
##
# Close the report file.
#
close $out
return
}
##
# Get the top design.
#
set top [$db get_top_design]
##
# Find all instances of marked cells.
#
$db flat foreach instOfCell $flag $top instance {
##
# Print the instance's path.
#
set instancePath [$db oid print $instance -notype]
puts $out $instancePath
##
# Determine the instantiated cell.
#
set cell [$db oid down $instance]
##
# Determine the cell's name (which contains parameters!).
#
set parametrized_name [$db oid oname $cell]
##
# Extract the original name and the parameters from the cell's name.
#
regexp {^([^\(\)]*)\((.*)\)([^\(\)])*$} $parametrized_name \
-> name parameters suffix
##
# Print the original cell name.
#
puts $out "\tcell: $name"
##
# Print the parameters.
#
set msg {}
set parameterList [ReportInstanceParameters:Split $parameters msg]
if {$msg != {}} {
puts "WARNING: when parsing parameters from instance name\
$parametrized_name"
puts "WARNING: $msg"
puts "WARNING: -> reported parameters may be wrong"
}
foreach parameter $parameterList {
puts $out "\t$parameter"
}
}
##
# Close the report file.
#
close $out
}
# =============================================================================
# Split - Split a parameter string by ","; ignore "," within parenthesis.
# =============================================================================
#
proc ReportInstanceParameters:Split {s msgName} {
upvar 1 $msgName msg
set parameters {}
set parameter ""
set parens 0
foreach c [split $s ""] {
switch -exact -- $c {
"(" {
incr parens
append parameter $c
}
")" {
incr parens -1
append parameter $c
if {$parens < 0} {
set msg "Unbalanced parenthesis."
}
}
"," {
if {$parens == 0} {
lappend parameters $parameter
set parameter ""
} else {
append parameter $c
}
}
default {
append parameter $c
}
}
}
if {$parameter ne ""} {
lappend parameters $parameter
}
if {$parens != 0} {
set msg "Unbalanced parenthesis."
}
return $parameters
}
##
# Check for 2 command line options
#
if {$argc != 2} {
set msg "Wrong #of args. Usage:\n"
append msg "[info nameofexecutable] [info script] <BINFILE> <REPORTFILE>"
error $msg
}
##
# The design is given as the first argument on the command line.
#
set binfile [lindex $argv 0]
##
# The report file is the second argument on the command line.
#
set report [lindex $argv 1]
##
# Open the binfile.
#
set db [zdb open $binfile]
##
# Create instance parameters report.
#
ReportInstanceParameters:Start $db $report
##
# Close the opened database.
#
$db close
|