File size: 5,832 Bytes
f61bac1
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
openroad(0)							   openroad(0)



NAME
       openroad - OpenROAD command-line-interface.

SYNOPSIS
       openroad	 [-help]  [-version]  [-no_init]  [-no_splash]	[-exit] [-gui]
       [-threads count|max] [-log file_name]  [-metrics	 file_name]  [-python]
       cmd_file

DESCRIPTION
       The  openroad  command  is  the command-line interface for OpenROAD, an
       open-source initiative for chip design and optimization.	 It provides a
       range of options to control its behavior and execute commands specified
       in the cmd_file.

OPTIONS
       -help: Display help information.

       -version: Display version information.

       -no_init: Skip initialization steps.

       -no_splash: Do not show the license splash at startup.

       -exit: Exit after executing commands in cmd_file.

       -gui: Launch the graphical user interface (GUI).

       -threads	 count|max: Specify the number of threads to use (or  use  max
       available).

       -log file_name: Log output to the specified file.

       -metrics file_name: Save performance metrics to the specified file.

       -python: Execute the cmd_file as a Python script.

ARGUMENTS
       cmd_file: The command file containing OpenROAD commands to be executed.

EXAMPLES
       openroad -help: Prints the help information

       openroad	 -version -exit: Prints the version information, and exits the
       program thereafter.

       openroad -threads max -log test.log -metrics test.metrics:  Prints  the
       log  and	 metric	 respectively to test.log and test.metrics.  Also runs
       the script with maximum available number of threads.

       openroad -gui: Launches OpenROAD GUI,  which  further  interactive  Tcl
       commands can be run.

TCL COMMANDS
       These Tcl-based commands are callable from within the OpenROAD binary.

       • read_lef [-tech] [-library] filename

	 • Read Library Exchange Format (.lef) files.

	 • tech: Technology-specific information

	 • library: .lib files

       • read_def filename

	 • Read Design Exchange Format (.def) files.

       • write_def [-version 5.8|5.7|5.6|5.5|5.4|5.3] filename

	 • Write Design Exchange Format (.def) files.

	 • version 5.8|5.7|5.6|5.5|5.4|5.3: Corresponding DEF version to use.

       • read_verilog filename
	 • Read Verilog (.v) input file.

       • write_verilog filename

	 • Write Verilog (.v) file based on current database.

       • read_db filename

	 • Read OpenDB (.odb) database files.

       • write_db filename

	 • Write OpenDB (.odb) database files.

       • write_abstract_lef filename

	 • Write  abstract  Library Exchange Format (.lef) files based on cur‐
	   rent database.

       • write_cdl [-include_fillers] -masters out_filename

	 • Write Circuit Design Language (.cdl) netlist file.

ENVIRONMENT
FILES
SEE ALSO
HISTORY
BUGS
				  2024/02/09			   openroad(0)

openroad(0)							   openroad(0)



NAME
       openroad - OpenROAD command-line-interface.

SYNOPSIS
       openroad	 [-help]  [-version]  [-no_init]  [-no_splash]	[-exit] [-gui]
       [-threads count|max] [-log file_name]  [-metrics	 file_name]  [-python]
       cmd_file

DESCRIPTION
       The  openroad  command  is  the command-line interface for OpenROAD, an
       open-source initiative for chip design and optimization.	 It provides a
       range of options to control its behavior and execute commands specified
       in the cmd_file.

OPTIONS
       -help: Display help information.

       -version: Display version information.

       -no_init: Skip initialization steps.

       -no_splash: Do not show the license splash at startup.

       -exit: Exit after executing commands in cmd_file.

       -gui: Launch the graphical user interface (GUI).

       -threads	 count|max: Specify the number of threads to use (or  use  max
       available).

       -log file_name: Log output to the specified file.

       -metrics file_name: Save performance metrics to the specified file.

       -python: Execute the cmd_file as a Python script.

ARGUMENTS
       cmd_file: The command file containing OpenROAD commands to be executed.

EXAMPLES
       openroad -help: Prints the help information

       openroad	 -version -exit: Prints the version information, and exits the
       program thereafter.

       openroad -threads max -log test.log -metrics test.metrics:  Prints  the
       log  and	 metric	 respectively to test.log and test.metrics.  Also runs
       the script with maximum available number of threads.

       openroad -gui: Launches OpenROAD GUI,  which  further  interactive  Tcl
       commands can be run.

TCL COMMANDS
       These Tcl-based commands are callable from within the OpenROAD binary.

       • read_lef [-tech] [-library] filename

	 • Read Library Exchange Format (.lef) files.

	 • tech: Technology-specific information

	 • library: .lib files

       • read_def filename

	 • Read Design Exchange Format (.def) files.

       • write_def [-version 5.8|5.7|5.6|5.5|5.4|5.3] filename

	 • Write Design Exchange Format (.def) files.

	 • version 5.8|5.7|5.6|5.5|5.4|5.3: Corresponding DEF version to use.

       • read_verilog filename
	 • Read Verilog (.v) input file.

       • write_verilog filename

	 • Write Verilog (.v) file based on current database.

       • read_db filename

	 • Read OpenDB (.odb) database files.

       • write_db filename

	 • Write OpenDB (.odb) database files.

       • write_abstract_lef filename

	 • Write  abstract  Library Exchange Format (.lef) files based on cur‐
	   rent database.

       • write_cdl [-include_fillers] -masters out_filename

	 • Write Circuit Design Language (.cdl) netlist file.

ENVIRONMENT
FILES
SEE ALSO
HISTORY
BUGS
				  2024/02/09			   openroad(0)