forked from The-OpenROAD-Project/OpenLane
-
Notifications
You must be signed in to change notification settings - Fork 35
/
flow.tcl
executable file
·411 lines (348 loc) · 11.9 KB
/
flow.tcl
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
#!/usr/bin/env tclsh
# Copyright 2020-2022 Efabless Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
set ::env(OPENLANE_ROOT) [file dirname [file normalize [info script]]]
if { ! [info exists ::env(OPENROAD_BIN) ] } {
set ::env(OPENROAD_BIN) openroad
}
lappend ::auto_path "$::env(OPENLANE_ROOT)/scripts/"
package require openlane; # provides the utils as well
proc run_placement_step {args} {
if { ! [ info exists ::env(PLACEMENT_CURRENT_DEF) ] } {
set ::env(PLACEMENT_CURRENT_DEF) $::env(CURRENT_DEF)
} else {
set ::env(CURRENT_DEF) $::env(PLACEMENT_CURRENT_DEF)
}
run_placement
}
proc run_cts_step {args} {
if { ! [ info exists ::env(CTS_CURRENT_DEF) ] } {
set ::env(CTS_CURRENT_DEF) $::env(CURRENT_DEF)
} else {
set ::env(CURRENT_DEF) $::env(CTS_CURRENT_DEF)
}
run_cts
run_resizer_timing
}
proc run_routing_step {args} {
if { ! [ info exists ::env(ROUTING_CURRENT_DEF) ] } {
set ::env(ROUTING_CURRENT_DEF) $::env(CURRENT_DEF)
} else {
set ::env(CURRENT_DEF) $::env(ROUTING_CURRENT_DEF)
}
run_routing
}
proc run_parasitics_sta_step {args} {
if { ! [ info exists ::env(PARSITICS_CURRENT_DEF) ] } {
set ::env(PARSITICS_CURRENT_DEF) $::env(CURRENT_DEF)
} else {
set ::env(CURRENT_DEF) $::env(PARSITICS_CURRENT_DEF)
}
if { $::env(RUN_SPEF_EXTRACTION)} {
run_parasitics_sta
}
}
proc run_irdrop_report_step {args} {
if { $::env(RUN_IRDROP_REPORT) } {
run_irdrop_report
}
}
proc run_lvs_step {{ lvs_enabled 1 }} {
if { ! [ info exists ::env(LVS_CURRENT_DEF) ] } {
set ::env(LVS_CURRENT_DEF) $::env(CURRENT_DEF)
} else {
set ::env(CURRENT_DEF) $::env(LVS_CURRENT_DEF)
}
if { $lvs_enabled && $::env(RUN_LVS) } {
run_magic_spice_export;
run_lvs; # requires run_magic_spice_export
}
}
proc run_drc_step {{ drc_enabled 1 }} {
if { ! [ info exists ::env(DRC_CURRENT_DEF) ] } {
set ::env(DRC_CURRENT_DEF) $::env(CURRENT_DEF)
} else {
set ::env(CURRENT_DEF) $::env(DRC_CURRENT_DEF)
}
if { $drc_enabled } {
if { $::env(RUN_MAGIC_DRC) } {
run_magic_drc
}
if {$::env(RUN_KLAYOUT_DRC)} {
run_klayout_drc
}
}
}
proc run_antenna_check_step {{ antenna_check_enabled 1 }} {
if { ! [ info exists ::env(ANTENNA_CHECK_CURRENT_DEF) ] } {
set ::env(ANTENNA_CHECK_CURRENT_DEF) $::env(CURRENT_DEF)
} else {
set ::env(CURRENT_DEF) $::env(ANTENNA_CHECK_CURRENT_DEF)
}
if { $antenna_check_enabled } {
run_antenna_check
}
}
proc run_erc_step {args} {
if { $::env(RUN_CVC) } {
run_erc
}
}
proc run_magic_step {args} {
if {$::env(RUN_MAGIC)} {
run_magic
}
}
proc run_klayout_step {args} {
if {$::env(RUN_KLAYOUT)} {
run_klayout
}
if {$::env(RUN_KLAYOUT_XOR)} {
run_klayout_gds_xor
}
}
proc run_timing_check_step {args} {
check_timing_violations\
-quit_on_hold_vios [expr $::env(QUIT_ON_TIMING_VIOLATIONS) && $::env(QUIT_ON_HOLD_VIOLATIONS)]\
-quit_on_setup_vios [expr $::env(QUIT_ON_TIMING_VIOLATIONS) && $::env(QUIT_ON_SETUP_VIOLATIONS)]
}
proc run_verilator_step {} {
if { $::env(RUN_LINTER) } {
run_verilator
}
}
proc run_non_interactive_mode {args} {
set options {
{-design optional}
{-from optional}
{-to optional}
{-save_path optional}
{-override_env optional}
}
set flags {-save -run_hooks -no_lvs -no_drc -no_antennacheck -gui}
parse_key_args "run_non_interactive_mode" args arg_values $options flags_map $flags -no_consume
if { [info exists arg_values(-from) ] || [info exists arg_values(-to)] } {
puts_err "-from and -to are no longer supported."
exit -1
}
if { [info exists flags_map(-gui)] } {
puts_err "Flag -gui is now deprecated. Refer to https://openlane.readthedocs.io/en/latest/reference/gui.html to view files graphically."
throw_error
}
prep {*}$args
# signal trap SIGINT save_state;
if { [info exists arg_values(-override_env)] } {
load_overrides $arg_values(-override_env)
}
set LVS_ENABLED [expr ![info exists flags_map(-no_lvs)] ]
set DRC_ENABLED [expr ![info exists flags_map(-no_drc)] ]
set ANTENNACHECK_ENABLED [expr ![info exists flags_map(-no_antennacheck)] ]
set steps [dict create \
"verilator_lint_check" "run_verilator_step" \
"synthesis" "run_synthesis" \
"floorplan" "run_floorplan" \
"placement" "run_placement_step" \
"cts" "run_cts_step" \
"routing" "run_routing_step" \
"parasitics_sta" "run_parasitics_sta_step" \
"irdrop" "run_irdrop_report_step" \
"gds_magic" "run_magic_step" \
"gds_klayout" "run_klayout_step" \
"lvs" "run_lvs_step $LVS_ENABLED " \
"drc" "run_drc_step $DRC_ENABLED " \
"antenna_check" "run_antenna_check_step $ANTENNACHECK_ENABLED "
]
set ::env(CURRENT_STEP) "verilator_lint_check"
set start_step $::env(CURRENT_STEP)
set end_step "antenna_check"
set failed 0;
set exe 0;
dict for {step_name step_exe} $steps {
if { [ string equal $start_step $step_name ] } {
set exe 1;
}
if { $exe } {
# For when it fails
set ::env(CURRENT_STEP) $step_name
set step_result [catch [lindex $step_exe 0] [lindex $step_exe 1] err];
if { $step_result } {
set failed 1;
puts_err "Step $::env(CURRENT_INDEX) ($step_name) failed with error:\n$err"
set exe 0;
break;
}
}
if { [ string equal $end_step $step_name ] } {
set exe 0:
break;
}
}
# for when it resumes
set steps_as_list [dict keys $steps]
set next_idx [expr [lsearch $steps_as_list $::env(CURRENT_STEP)] + 1]
set ::env(CURRENT_STEP) [lindex $steps_as_list $next_idx]
if { $failed } {
flow_fail
}
# Saves to <RUN_DIR>/results/final
save_final_views
# Saves to design directory or custom
if { [info exists flags_map(-save) ] } {
if { ! [info exists arg_values(-save_path)] } {
set arg_values(-save_path) $::env(DESIGN_DIR)
}
save_final_views -save_path $arg_values(-save_path) -tag $::env(RUN_TAG)
}
calc_total_runtime
save_state
generate_final_summary_report
if { [catch run_timing_check_step] } {
flow_fail
}
if { [info exists arg_values(-save_path)] && $arg_values(-save_path) != "" } {
set ::env(HOOK_OUTPUT_PATH) "[file normalize $arg_values(-save_path)]"
} else {
set ::env(HOOK_OUTPUT_PATH) $::env(RESULTS_DIR)/final
}
if {[info exists flags_map(-run_hooks)]} {
run_post_run_hooks
}
puts_success "Flow complete."
show_warnings "Note that the following warnings have been generated:"
}
proc run_interactive_mode {args} {
set options {
{-design optional}
}
set flags {}
parse_key_args "run_interactive_mode" args arg_values $options flags_map $flags -no_consume
if { [info exists arg_values(-design)] } {
prep {*}$args
}
set ::env(TCLLIBPATH) $::auto_path
exec tclsh >&@stdout
}
proc run_magic_drc_batch {args} {
set options {
{-magicrc optional}
{-tech optional}
{-report required}
{-design required}
{-gds required}
}
set flags {}
parse_key_args "run_magic_drc_batch" args arg_values $options flags_mag $flags
if { [info exists arg_values(-magicrc)] } {
set magicrc [file normalize $arg_values(-magicrc)]
}
if { [info exists arg_values(-tech)] } {
set ::env(TECH) [file normalize $arg_values(-tech)]
}
set ::env(GDS_INPUT) [file normalize $arg_values(-gds)]
set ::env(REPORT_OUTPUT) [file normalize $arg_values(-report)]
set ::env(DESIGN_NAME) $arg_values(-design)
if { [info exists magicrc] } {
exec magic \
-noconsole \
-dnull \
-rcfile $magicrc \
$::env(OPENLANE_ROOT)/scripts/magic/gds/drc_batch.tcl \
</dev/null |& tee /dev/tty
} else {
exec magic \
-noconsole \
-dnull \
$::env(OPENLANE_ROOT)/scripts/magic/gds/drc_batch.tcl \
</dev/null |& tee /dev/tty
}
}
proc run_lvs_batch {args} {
# runs device level lvs on -gds/CURRENT_GDS and -net/CURRENT_NETLIST
# extracts gds only if EXT_NETLIST does not exist
set options {
{-design required}
{-gds optional}
{-net optional}
}
set flags {}
parse_key_args "run_lvs_batch" args arg_values $options flags_lvs $flags -no_consume
prep {*}$args
if { [info exists arg_values(-gds)] } {
set ::env(CURRENT_GDS) [file normalize $arg_values(-gds)]
} else {
set ::env(CURRENT_GDS) $::env(signoff_results)/$::env(DESIGN_NAME).gds
}
if { [info exists arg_values(-net)] } {
set ::env(CURRENT_POWERED_NETLIST) [file normalize $arg_values(-net)]
}
assert_files_exist "$::env(CURRENT_GDS) $::env(CURRENT_POWERED_NETLIST)"
set ::env(MAGIC_EXT_USE_GDS) 1
set ::env(EXT_NETLIST) $::env(signoff_results)/$::env(DESIGN_NAME).gds.spice
if { [file exists $::env(EXT_NETLIST)] } {
puts_warn "The file $::env(EXT_NETLIST) will be used. If you would like the file re-exported, please delete it."
} else {
run_magic_spice_export
}
set ::env(LVS_INSERT_POWER_PINS) 0
run_lvs
calc_total_runtime
save_state
generate_final_summary_report
puts_success "LVS success."
show_warnings "Note that the following warnings have been generated:"
}
proc run_file {args} {
set ::env(TCLLIBPATH) $::auto_path
exec env EXIT_ON_ERROR=1 tclsh {*}$args >&@stdout
}
set options {
{-file optional}
}
set flags {-interactive -it -drc -lvs -synth_explore -run_hooks}
parse_key_args "flow.tcl" argv arg_values $options flags_map $flags -no_consume
if {[catch {exec cat /git_version} ::env(OPENLANE_VERSION)]} {
if {[catch {exec git --git-dir $::env(OPENLANE_ROOT)/.git rev-parse HEAD} ::env(OPENLANE_VERSION)]} {
set ::env(OPENLANE_VERSION) ""
}
}
if { [file isdirectory $::env(OPENLANE_ROOT)/.git] } {
if {![catch {exec git --git-dir $::env(OPENLANE_ROOT)/.git rev-parse HEAD} ::env(OPENLANE_MOUNTED_SCRIPTS_VERSION)]} {
if { $::env(OPENLANE_VERSION) == $::env(OPENLANE_MOUNTED_SCRIPTS_VERSION)} {
unset ::env(OPENLANE_MOUNTED_SCRIPTS_VERSION)
}
}
}
puts "OpenLane $::env(OPENLANE_VERSION)"
if { [info exists ::env(OPENLANE_MOUNTED_SCRIPTS_VERSION)] } {
puts "(with mounted scripts from $::env(OPENLANE_MOUNTED_SCRIPTS_VERSION))"
}
puts "All rights reserved. (c) 2020-2023 Efabless Corporation and contributors."
puts "Available under the Apache License, version 2.0. See the LICENSE file for more details."
puts ""
if { [info exists flags_map(-interactive)] || [info exists flags_map(-it)] } {
if { [info exists arg_values(-file)] } {
run_file [file normalize $arg_values(-file)] {*}$argv
} else {
run_interactive_mode {*}$argv
}
} elseif { [info exists flags_map(-drc)] } {
run_magic_drc_batch {*}$argv
} elseif { [info exists flags_map(-lvs)] } {
run_lvs_batch {*}$argv
} elseif { [info exists flags_map(-synth_explore)] } {
prep {*}$argv
run_synth_exploration
} else {
run_non_interactive_mode {*}$argv
}