2 * yosys -- Yosys Open SYnthesis Suite
4 * Copyright (C) 2012 Claire Xenia Wolf <claire@yosyshq.com>
6 * Permission to use, copy, modify, and/or distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 #include "kernel/yosys.h"
21 #include "libs/sha1/sha1.h"
23 #ifdef YOSYS_ENABLE_READLINE
24 # include <readline/readline.h>
25 # include <readline/history.h>
28 #ifdef YOSYS_ENABLE_EDITLINE
29 # include <editline/readline.h>
37 #if defined (__linux__) || defined(__FreeBSD__)
38 # include <sys/resource.h>
39 # include <sys/types.h>
44 # include <sys/sysctl.h>
45 # include <sys/user.h>
48 #if !defined(_WIN32) || defined(__MINGW32__)
52 int optind
= 1, optcur
= 1;
53 int getopt(int argc
, char **argv
, const char *optstring
)
55 if (optind
>= argc
|| argv
[optind
][0] != '-')
58 bool takes_arg
= false;
59 int opt
= argv
[optind
][optcur
];
60 for (int i
= 0; optstring
[i
]; i
++)
61 if (opt
== optstring
[i
] && optstring
[i
+ 1] == ':')
65 if (argv
[optind
][++optcur
] == 0)
70 if (argv
[optind
][++optcur
]) {
71 optarg
= argv
[optind
++] + optcur
;
76 optarg
= argv
[++optind
];
86 # include <sys/stat.h>
87 # include <sys/types.h>
88 # include <emscripten.h>
90 extern "C" int main(int, char**);
91 extern "C" void run(const char*);
92 extern "C" const char *errmsg();
93 extern "C" const char *prompt();
95 int main(int argc
, char **argv
)
98 if (ENVIRONMENT_IS_NODE
)
100 FS
.mkdir('/hostcwd');
101 FS
.mount(NODEFS
, { root
: '.' }, '/hostcwd');
103 FS
.mount(NODEFS
, { root
: '/' }, '/hostfs');
107 mkdir("/work", 0777);
109 log_files
.push_back(stdout
);
110 log_error_stderr
= true;
114 PyRun_SimpleString(("sys.path.append(\""+proc_self_dirname()+"\")").c_str());
115 PyRun_SimpleString(("sys.path.append(\""+proc_share_dirname()+"plugins\")").c_str());
120 // Run the first argument as a script file
121 run_frontend(argv
[1], "script");
125 void run(const char *command
)
127 int selSize
= GetSize(yosys_get_design()->selection_stack
);
129 log_last_error
= "Internal error (see JavaScript console for details)";
133 while (GetSize(yosys_get_design()->selection_stack
) > selSize
)
134 yosys_get_design()->selection_stack
.pop_back();
141 return log_last_error
.c_str();
146 const char *p
= create_prompt(yosys_get_design(), 0);
147 while (*p
== '\n') p
++;
151 #else /* EMSCRIPTEN */
153 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
154 int yosys_history_offset
= 0;
155 std::string yosys_history_file
;
160 // FIXME: WASI does not currently support exceptions.
161 void* __cxa_allocate_exception(size_t thrown_size
) throw() {
162 return malloc(thrown_size
);
164 bool __cxa_uncaught_exception() throw();
165 void __cxa_throw(void* thrown_exception
, struct std::type_info
* tinfo
, void (*dest
)(void*)) {
173 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
174 if (!yosys_history_file
.empty()) {
175 #if defined(YOSYS_ENABLE_READLINE)
176 if (yosys_history_offset
> 0) {
177 history_truncate_file(yosys_history_file
.c_str(), 100);
178 append_history(where_history() - yosys_history_offset
, yosys_history_file
.c_str());
180 write_history(yosys_history_file
.c_str());
182 write_history(yosys_history_file
.c_str());
187 #if defined(YOSYS_ENABLE_READLINE)
188 HIST_ENTRY
**hist_list
= history_list();
189 if (hist_list
!= NULL
)
195 int main(int argc
, char **argv
)
197 std::string frontend_command
= "auto";
198 std::string backend_command
= "auto";
199 std::vector
<std::string
> vlog_defines
;
200 std::vector
<std::string
> passes_commands
;
201 std::vector
<std::string
> plugin_filenames
;
202 std::string output_filename
= "";
203 std::string scriptfile
= "";
204 std::string depsfile
= "";
205 std::string topmodule
= "";
206 bool scriptfile_tcl
= false;
207 bool print_banner
= true;
208 bool print_stats
= true;
209 bool call_abort
= false;
210 bool timing_details
= false;
211 bool run_shell
= true;
215 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
216 if (getenv("HOME") != NULL
) {
217 yosys_history_file
= stringf("%s/.yosys_history", getenv("HOME"));
218 read_history(yosys_history_file
.c_str());
219 yosys_history_offset
= where_history();
223 if (argc
== 2 && (!strcmp(argv
[1], "-h") || !strcmp(argv
[1], "-help") || !strcmp(argv
[1], "--help")))
226 printf("Usage: %s [options] [<infile> [..]]\n", argv
[0]);
229 printf(" suppress printing of banner (copyright, disclaimer, version)\n");
232 printf(" suppress printing of footer (log hash, version, timing statistics)\n");
235 printf(" quiet operation. only write warnings and error messages to console\n");
236 printf(" use this option twice to also quiet warning messages\n");
238 printf(" -v <level>\n");
239 printf(" print log headers up to level <level> to the console. (this\n");
240 printf(" implies -q for everything except the 'End of script.' message.)\n");
243 printf(" annotate all log messages with a time stamp\n");
246 printf(" print more detailed timing stats at exit\n");
248 printf(" -l logfile\n");
249 printf(" write log messages to the specified file\n");
251 printf(" -L logfile\n");
252 printf(" like -l but open log file in line buffered mode\n");
254 printf(" -o outfile\n");
255 printf(" write the design to the specified file on exit\n");
257 printf(" -b backend\n");
258 printf(" use this backend for the output file specified on the command line\n");
260 printf(" -f frontend\n");
261 printf(" use the specified frontend for the input files on the command line\n");
264 printf(" print the command list\n");
266 printf(" -h command\n");
267 printf(" print the help message for the specified command\n");
269 printf(" -s scriptfile\n");
270 printf(" execute the commands in the script file\n");
271 #ifdef YOSYS_ENABLE_TCL
273 printf(" -c tcl_scriptfile\n");
274 printf(" execute the commands in the tcl script file (see 'help tcl' for details)\n");
277 printf(" -p command\n");
278 printf(" execute the commands\n");
280 printf(" -m module_file\n");
281 printf(" load the specified module (aka plugin)\n");
284 printf(" enable tracing of core data structure changes. for debugging\n");
287 printf(" will slightly randomize allocated pointer addresses. for debugging\n");
290 printf(" will call abort() at the end of the script. for debugging\n");
292 printf(" -r <module_name>\n");
293 printf(" elaborate command line arguments using the specified top module\n");
295 printf(" -D <macro>[=<value>]\n");
296 printf(" set the specified Verilog define (via \"read -define\")\n");
298 printf(" -P <header_id>[:<filename>]\n");
299 printf(" dump the design when printing the specified log header to a file.\n");
300 printf(" yosys_dump_<header_id>.il is used as filename if none is specified.\n");
301 printf(" Use 'ALL' as <header_id> to dump at every header.\n");
303 printf(" -W regex\n");
304 printf(" print a warning for all log messages matching the regex.\n");
306 printf(" -w regex\n");
307 printf(" if a warning message matches the regex, it is printed as regular\n");
308 printf(" message instead.\n");
310 printf(" -e regex\n");
311 printf(" if a warning message matches the regex, it is printed as error\n");
312 printf(" message instead and the tool terminates with a nonzero return code.\n");
314 printf(" -E <depsfile>\n");
315 printf(" write a Makefile dependencies file with in- and output file names\n");
317 printf(" -x <feature>\n");
318 printf(" do not print warnings for the specified experimental feature\n");
321 printf(" globally enable debug log messages\n");
324 printf(" print version information and exit\n");
326 printf("The option -S is an shortcut for calling the \"synth\" command, a default\n");
327 printf("script for transforming the Verilog input to a gate-level netlist. For example:\n");
329 printf(" yosys -o output.blif -S input.v\n");
331 printf("For more complex synthesis jobs it is recommended to use the read_* and write_*\n");
332 printf("commands in a script file instead of specifying input and output files on the\n");
333 printf("command line.\n");
335 printf("When no commands, script files or input files are specified on the command\n");
336 printf("line, yosys automatically enters the interactive command mode. Use the 'help'\n");
337 printf("command to get information on the individual commands.\n");
342 if (argc
== 2 && (!strcmp(argv
[1], "-V") || !strcmp(argv
[1], "-version") || !strcmp(argv
[1], "--version")))
344 printf("%s\n", yosys_version_str
);
349 while ((opt
= getopt(argc
, argv
, "MXAQTVSgm:f:Hh:b:o:p:l:L:qv:tds:c:W:w:e:r:D:P:E:x:")) != -1)
363 print_banner
= false;
369 printf("%s\n", yosys_version_str
);
372 passes_commands
.push_back("synth");
379 plugin_filenames
.push_back(optarg
);
382 frontend_command
= optarg
;
385 passes_commands
.push_back("help");
389 passes_commands
.push_back(stringf("help %s", optarg
));
393 backend_command
= optarg
;
397 passes_commands
.push_back(optarg
);
401 output_filename
= optarg
;
406 log_files
.push_back(fopen(optarg
, "wt"));
407 if (log_files
.back() == NULL
) {
408 fprintf(stderr
, "Can't open log file `%s' for writing!\n", optarg
);
412 setvbuf(log_files
.back(), NULL
, _IOLBF
, 0);
416 if (log_errfile
== stderr
)
417 log_quiet_warnings
= true;
418 log_errfile
= stderr
;
422 log_errfile
= stderr
;
423 log_verbose_level
= atoi(optarg
);
429 timing_details
= true;
433 scriptfile_tcl
= false;
438 scriptfile_tcl
= true;
442 log_warn_regexes
.push_back(YS_REGEX_COMPILE(optarg
));
445 log_nowarn_regexes
.push_back(YS_REGEX_COMPILE(optarg
));
448 log_werror_regexes
.push_back(YS_REGEX_COMPILE(optarg
));
454 vlog_defines
.push_back(optarg
);
458 auto args
= split_tokens(optarg
, ":");
459 if (!args
.empty() && args
[0] == "ALL") {
460 if (GetSize(args
) != 1) {
461 fprintf(stderr
, "Invalid number of tokens in -D ALL.\n");
464 log_hdump_all
= true;
466 if (!args
.empty() && !args
[0].empty() && args
[0].back() == '.')
468 if (GetSize(args
) == 1)
469 args
.push_back("yosys_dump_" + args
[0] + ".il");
470 if (GetSize(args
) != 2) {
471 fprintf(stderr
, "Invalid number of tokens in -D.\n");
474 log_hdump
[args
[0]].insert(args
[1]);
482 log_experimentals_ignored
.insert(optarg
);
485 fprintf(stderr
, "Run '%s -h' for help.\n", argv
[0]);
490 if (log_errfile
== NULL
) {
491 log_files
.push_back(stdout
);
492 log_error_stderr
= true;
499 log_hasher
= new SHA1
;
501 #if defined(__linux__)
502 // set stack size to >= 128 MB
505 const rlim_t stack_size
= 128L * 1024L * 1024L;
506 if (getrlimit(RLIMIT_STACK
, &rl
) == 0 && rl
.rlim_cur
< stack_size
) {
507 rl
.rlim_cur
= stack_size
;
508 setrlimit(RLIMIT_STACK
, &rl
);
515 PyRun_SimpleString(("sys.path.append(\""+proc_self_dirname()+"\")").c_str());
516 PyRun_SimpleString(("sys.path.append(\""+proc_share_dirname()+"plugins\")").c_str());
518 log_error_atexit
= yosys_atexit
;
520 for (auto &fn
: plugin_filenames
)
523 if (!vlog_defines
.empty()) {
524 std::string vdef_cmd
= "read -define";
525 for (auto vdef
: vlog_defines
)
526 vdef_cmd
+= " " + vdef
;
530 while (optind
< argc
)
531 if (run_frontend(argv
[optind
++], frontend_command
))
534 if (!topmodule
.empty())
535 run_pass("hierarchy -top " + topmodule
);
537 if (!scriptfile
.empty()) {
538 if (scriptfile_tcl
) {
539 #ifdef YOSYS_ENABLE_TCL
540 if (Tcl_EvalFile(yosys_get_tcl_interp(), scriptfile
.c_str()) != TCL_OK
)
541 log_error("TCL interpreter returned an error: %s\n", Tcl_GetStringResult(yosys_get_tcl_interp()));
543 log_error("Can't exectue TCL script: this version of yosys is not built with TCL support enabled.\n");
546 run_frontend(scriptfile
, "script");
549 for (auto it
= passes_commands
.begin(); it
!= passes_commands
.end(); it
++)
555 run_backend(output_filename
, backend_command
);
557 yosys_design
->check();
558 for (auto it
: saved_designs
)
560 for (auto it
: pushed_designs
)
563 if (!depsfile
.empty())
565 FILE *f
= fopen(depsfile
.c_str(), "wt");
567 log_error("Can't open dependencies file for writing: %s\n", strerror(errno
));
569 for (auto fn
: yosys_output_files
) {
570 fprintf(f
, "%s%s", first
? "" : " ", escape_filename_spaces(fn
).c_str());
574 for (auto fn
: yosys_input_files
) {
575 if (yosys_output_files
.count(fn
) == 0)
576 fprintf(f
, " %s", escape_filename_spaces(fn
).c_str());
581 if (log_expect_no_warnings
&& log_warnings_count_noexpect
)
582 log_error("Unexpected warnings found: %d unique messages, %d total, %d expected\n", GetSize(log_warnings
),
583 log_warnings_count
, log_warnings_count
- log_warnings_count_noexpect
);
587 std::string hash
= log_hasher
->final().substr(0, 10);
589 log_hasher
= nullptr;
595 if (mode_v
&& !mode_q
)
596 log_files
.push_back(stderr
);
598 if (log_warnings_count
)
599 log("Warnings: %d unique messages, %d total\n", GetSize(log_warnings
), log_warnings_count
);
601 if (!log_experimentals
.empty())
602 log("Warnings: %d experimental features used (not excluded with -x).\n", GetSize(log_experimentals
));
605 log("End of script. Logfile hash: %s\n", hash
.c_str());
608 std::string stats_divider
= ", ";
610 struct rusage ru_buffer
;
611 getrusage(RUSAGE_SELF
, &ru_buffer
);
612 if (yosys_design
->scratchpad_get_bool("print_stats.include_children")) {
613 struct rusage ru_buffer_children
;
614 getrusage(RUSAGE_CHILDREN
, &ru_buffer_children
);
615 ru_buffer
.ru_utime
.tv_sec
+= ru_buffer_children
.ru_utime
.tv_sec
;
616 ru_buffer
.ru_utime
.tv_usec
+= ru_buffer_children
.ru_utime
.tv_usec
;
617 ru_buffer
.ru_stime
.tv_sec
+= ru_buffer_children
.ru_stime
.tv_sec
;
618 ru_buffer
.ru_stime
.tv_usec
+= ru_buffer_children
.ru_stime
.tv_usec
;
619 #if defined(__linux__) || defined(__FreeBSD__)
620 ru_buffer
.ru_maxrss
= std::max(ru_buffer
.ru_maxrss
, ru_buffer_children
.ru_maxrss
);
623 #if defined(__linux__) || defined(__FreeBSD__)
624 meminfo
= stringf(", MEM: %.2f MB peak",
625 ru_buffer
.ru_maxrss
/ 1024.0);
627 log("End of script. Logfile hash: %s%sCPU: user %.2fs system %.2fs%s\n", hash
.c_str(),
628 stats_divider
.c_str(), ru_buffer
.ru_utime
.tv_sec
+ 1e-6 * ru_buffer
.ru_utime
.tv_usec
,
629 ru_buffer
.ru_stime
.tv_sec
+ 1e-6 * ru_buffer
.ru_stime
.tv_usec
, meminfo
.c_str());
631 log("%s\n", yosys_version_str
);
633 int64_t total_ns
= 0;
634 std::set
<tuple
<int64_t, int, std::string
>> timedat
;
636 for (auto &it
: pass_register
)
637 if (it
.second
->call_counter
) {
638 total_ns
+= it
.second
->runtime_ns
+ 1;
639 timedat
.insert(make_tuple(it
.second
->runtime_ns
+ 1, it
.second
->call_counter
, it
.first
));
644 log("Time spent:\n");
645 for (auto it
= timedat
.rbegin(); it
!= timedat
.rend(); it
++) {
646 log("%5d%% %5d calls %8.3f sec %s\n", int(100*std::get
<0>(*it
) / total_ns
),
647 std::get
<1>(*it
), std::get
<0>(*it
) / 1000000000.0, std::get
<2>(*it
).c_str());
654 for (auto it
= timedat
.rbegin(); it
!= timedat
.rend() && out_count
< 4; it
++, out_count
++) {
655 if (out_count
>= 2 && (std::get
<0>(*it
) < 1000000000 || int(100*std::get
<0>(*it
) / total_ns
) < 20)) {
659 log("%s %d%% %dx %s (%d sec)", out_count
? "," : "", int(100*std::get
<0>(*it
) / total_ns
),
660 std::get
<1>(*it
), std::get
<2>(*it
).c_str(), int(std::get
<0>(*it
) / 1000000000));
662 log("%s\n", out_count
? "" : " no commands executed");
666 #if defined(YOSYS_ENABLE_COVER) && (defined(__linux__) || defined(__FreeBSD__))
667 if (getenv("YOSYS_COVER_DIR") || getenv("YOSYS_COVER_FILE"))
672 if (getenv("YOSYS_COVER_DIR")) {
673 filename
= stringf("%s/yosys_cover_%d_XXXXXX.txt", getenv("YOSYS_COVER_DIR"), getpid());
674 filename
= make_temp_file(filename
);
676 filename
= getenv("YOSYS_COVER_FILE");
679 f
= fopen(filename
.c_str(), "a+");
682 log_error("Can't create coverage file `%s'.\n", filename
.c_str());
684 log("<writing coverage file \"%s\">\n", filename
.c_str());
686 for (auto &it
: get_coverage_data())
687 fprintf(f
, "%-60s %10d %s\n", it
.second
.first
.c_str(), it
.second
.second
, it
.first
.c_str());
693 log_check_expected();
702 #if defined(_MSC_VER)
704 #elif defined(_WIN32)
713 #endif /* EMSCRIPTEN */