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 "kernel/satgen.h"
28 #ifdef YOSYS_ENABLE_ZLIB
31 PRIVATE_NAMESPACE_BEGIN
32 #define GZ_BUFFER_SIZE 8192
33 void decompress_gzip(const std::string
&filename
, std::stringstream
&out
)
35 char buffer
[GZ_BUFFER_SIZE
];
37 gzFile gzf
= gzopen(filename
.c_str(), "rb");
39 bytes_read
= gzread(gzf
, reinterpret_cast<void *>(buffer
), GZ_BUFFER_SIZE
);
40 out
.write(buffer
, bytes_read
);
46 An output stream that uses a stringbuf to buffer data internally,
47 using zlib to write gzip-compressed data every time the stream is flushed.
49 class gzip_ostream
: public std::ostream
{
51 gzip_ostream() : std::ostream(nullptr)
55 bool open(const std::string
&filename
)
57 return outbuf
.open(filename
);
60 class gzip_streambuf
: public std::stringbuf
{
63 bool open(const std::string
&filename
)
65 gzf
= gzopen(filename
.c_str(), "wb");
66 return gzf
!= nullptr;
68 virtual int sync() override
70 gzwrite(gzf
, reinterpret_cast<const void *>(str().c_str()), unsigned(str().size()));
74 virtual ~gzip_streambuf()
89 #define MAX_REG_COUNT 1000
91 bool echo_mode
= false;
92 Pass
*first_queued_pass
;
95 std::map
<std::string
, Frontend
*> frontend_register
;
96 std::map
<std::string
, Pass
*> pass_register
;
97 std::map
<std::string
, Backend
*> backend_register
;
99 std::vector
<std::string
> Frontend::next_args
;
101 Pass::Pass(std::string name
, std::string short_help
) : pass_name(name
), short_help(short_help
)
103 next_queued_pass
= first_queued_pass
;
104 first_queued_pass
= this;
109 void Pass::run_register()
111 log_assert(pass_register
.count(pass_name
) == 0);
112 pass_register
[pass_name
] = this;
115 void Pass::init_register()
117 vector
<Pass
*> added_passes
;
118 while (first_queued_pass
) {
119 added_passes
.push_back(first_queued_pass
);
120 first_queued_pass
->run_register();
121 first_queued_pass
= first_queued_pass
->next_queued_pass
;
123 for (auto added_pass
: added_passes
)
124 added_pass
->on_register();
127 void Pass::done_register()
129 for (auto &it
: pass_register
)
130 it
.second
->on_shutdown();
132 frontend_register
.clear();
133 pass_register
.clear();
134 backend_register
.clear();
135 log_assert(first_queued_pass
== NULL
);
138 void Pass::on_register()
142 void Pass::on_shutdown()
150 Pass::pre_post_exec_state_t
Pass::pre_execute()
152 pre_post_exec_state_t state
;
154 state
.begin_ns
= PerformanceTimer::query();
155 state
.parent_pass
= current_pass
;
161 void Pass::post_execute(Pass::pre_post_exec_state_t state
)
163 IdString::checkpoint();
166 int64_t time_ns
= PerformanceTimer::query() - state
.begin_ns
;
167 runtime_ns
+= time_ns
;
168 current_pass
= state
.parent_pass
;
170 current_pass
->runtime_ns
-= time_ns
;
176 log("No help message for command `%s'.\n", pass_name
.c_str());
180 void Pass::clear_flags()
184 void Pass::cmd_log_args(const std::vector
<std::string
> &args
)
186 if (args
.size() <= 1)
188 log("Full command line:");
189 for (size_t i
= 0; i
< args
.size(); i
++)
190 log(" %s", args
[i
].c_str());
194 void Pass::cmd_error(const std::vector
<std::string
> &args
, size_t argidx
, std::string msg
)
196 std::string command_text
;
199 for (size_t i
= 0; i
< args
.size(); i
++) {
201 error_pos
+= args
[i
].size() + 1;
202 command_text
= command_text
+ (command_text
.empty() ? "" : " ") + args
[i
];
205 log("\nSyntax error in command `%s':\n", command_text
.c_str());
208 log_cmd_error("Command syntax error: %s\n> %s\n> %*s^\n",
209 msg
.c_str(), command_text
.c_str(), error_pos
, "");
212 void Pass::extra_args(std::vector
<std::string
> args
, size_t argidx
, RTLIL::Design
*design
, bool select
)
214 for (; argidx
< args
.size(); argidx
++)
216 std::string arg
= args
[argidx
];
218 if (arg
.compare(0, 1, "-") == 0)
219 cmd_error(args
, argidx
, "Unknown option or option in arguments.");
222 cmd_error(args
, argidx
, "Extra argument.");
224 handle_extra_select_args(this, args
, argidx
, args
.size(), design
);
227 // cmd_log_args(args);
230 void Pass::call(RTLIL::Design
*design
, std::string command
)
232 std::vector
<std::string
> args
;
234 std::string cmd_buf
= command
;
235 std::string tok
= next_token(cmd_buf
, " \t\r\n", true);
241 #if !defined(YOSYS_DISABLE_SPAWN)
242 cmd_buf
= command
.substr(command
.find('!') + 1);
243 while (!cmd_buf
.empty() && (cmd_buf
.back() == ' ' || cmd_buf
.back() == '\t' ||
244 cmd_buf
.back() == '\r' || cmd_buf
.back() == '\n'))
245 cmd_buf
.resize(cmd_buf
.size()-1);
246 log_header(design
, "Shell command: %s\n", cmd_buf
.c_str());
247 int retCode
= run_command(cmd_buf
);
249 log_cmd_error("Shell command returned error code %d.\n", retCode
);
252 log_cmd_error("Shell is not available.\n");
256 while (!tok
.empty()) {
259 for (stop
= 0; stop
< GetSize(cmd_buf
); stop
++)
260 if (cmd_buf
[stop
] == '\r' || cmd_buf
[stop
] == '\n')
262 cmd_buf
= cmd_buf
.substr(stop
);
264 if (tok
.back() == ';') {
265 int num_semikolon
= 0;
266 while (!tok
.empty() && tok
.back() == ';')
267 tok
.resize(tok
.size()-1), num_semikolon
++;
272 if (num_semikolon
== 2)
273 call(design
, "clean");
274 if (num_semikolon
== 3)
275 call(design
, "clean -purge");
278 bool found_nl
= false;
279 for (auto c
: cmd_buf
) {
280 if (c
== ' ' || c
== '\t')
282 if (c
== '\r' || c
== '\n')
290 tok
= next_token(cmd_buf
, " \t\r\n", true);
296 void Pass::call(RTLIL::Design
*design
, std::vector
<std::string
> args
)
298 if (args
.size() == 0 || args
[0][0] == '#' || args
[0][0] == ':')
302 log("%s", create_prompt(design
, 0));
303 for (size_t i
= 0; i
< args
.size(); i
++)
304 log("%s%s", i
? " " : "", args
[i
].c_str());
308 if (pass_register
.count(args
[0]) == 0)
309 log_cmd_error("No such command: %s (type 'help' for a command overview)\n", args
[0].c_str());
311 if (pass_register
[args
[0]]->experimental_flag
)
312 log_experimental("%s", args
[0].c_str());
314 size_t orig_sel_stack_pos
= design
->selection_stack
.size();
315 auto state
= pass_register
[args
[0]]->pre_execute();
316 pass_register
[args
[0]]->execute(args
, design
);
317 pass_register
[args
[0]]->post_execute(state
);
318 while (design
->selection_stack
.size() > orig_sel_stack_pos
)
319 design
->selection_stack
.pop_back();
322 void Pass::call_on_selection(RTLIL::Design
*design
, const RTLIL::Selection
&selection
, std::string command
)
324 std::string backup_selected_active_module
= design
->selected_active_module
;
325 design
->selected_active_module
.clear();
326 design
->selection_stack
.push_back(selection
);
328 Pass::call(design
, command
);
330 design
->selection_stack
.pop_back();
331 design
->selected_active_module
= backup_selected_active_module
;
334 void Pass::call_on_selection(RTLIL::Design
*design
, const RTLIL::Selection
&selection
, std::vector
<std::string
> args
)
336 std::string backup_selected_active_module
= design
->selected_active_module
;
337 design
->selected_active_module
.clear();
338 design
->selection_stack
.push_back(selection
);
340 Pass::call(design
, args
);
342 design
->selection_stack
.pop_back();
343 design
->selected_active_module
= backup_selected_active_module
;
346 void Pass::call_on_module(RTLIL::Design
*design
, RTLIL::Module
*module
, std::string command
)
348 std::string backup_selected_active_module
= design
->selected_active_module
;
349 design
->selected_active_module
= module
->name
.str();
350 design
->selection_stack
.push_back(RTLIL::Selection(false));
351 design
->selection_stack
.back().select(module
);
353 Pass::call(design
, command
);
355 design
->selection_stack
.pop_back();
356 design
->selected_active_module
= backup_selected_active_module
;
359 void Pass::call_on_module(RTLIL::Design
*design
, RTLIL::Module
*module
, std::vector
<std::string
> args
)
361 std::string backup_selected_active_module
= design
->selected_active_module
;
362 design
->selected_active_module
= module
->name
.str();
363 design
->selection_stack
.push_back(RTLIL::Selection(false));
364 design
->selection_stack
.back().select(module
);
366 Pass::call(design
, args
);
368 design
->selection_stack
.pop_back();
369 design
->selected_active_module
= backup_selected_active_module
;
372 bool ScriptPass::check_label(std::string label
, std::string info
)
374 if (active_design
== nullptr) {
377 log(" %s:\n", label
.c_str());
379 log(" %s: %s\n", label
.c_str(), info
.c_str());
382 if (!active_run_from
.empty() && active_run_from
== active_run_to
) {
383 block_active
= (label
== active_run_from
);
385 if (label
== active_run_from
)
387 if (label
== active_run_to
)
388 block_active
= false;
394 void ScriptPass::run(std::string command
, std::string info
)
396 if (active_design
== nullptr) {
398 log(" %s\n", command
.c_str());
400 log(" %s %s\n", command
.c_str(), info
.c_str());
402 Pass::call(active_design
, command
);
403 active_design
->check();
407 void ScriptPass::run_nocheck(std::string command
, std::string info
)
409 if (active_design
== nullptr) {
411 log(" %s\n", command
.c_str());
413 log(" %s %s\n", command
.c_str(), info
.c_str());
415 Pass::call(active_design
, command
);
419 void ScriptPass::run_script(RTLIL::Design
*design
, std::string run_from
, std::string run_to
)
422 active_design
= design
;
423 block_active
= run_from
.empty();
424 active_run_from
= run_from
;
425 active_run_to
= run_to
;
429 void ScriptPass::help_script()
433 active_design
= nullptr;
435 active_run_from
.clear();
436 active_run_to
.clear();
440 Frontend::Frontend(std::string name
, std::string short_help
) :
441 Pass(name
.rfind("=", 0) == 0 ? name
.substr(1) : "read_" + name
, short_help
),
442 frontend_name(name
.rfind("=", 0) == 0 ? name
.substr(1) : name
)
446 void Frontend::run_register()
448 log_assert(pass_register
.count(pass_name
) == 0);
449 pass_register
[pass_name
] = this;
451 log_assert(frontend_register
.count(frontend_name
) == 0);
452 frontend_register
[frontend_name
] = this;
455 Frontend::~Frontend()
459 void Frontend::execute(std::vector
<std::string
> args
, RTLIL::Design
*design
)
461 log_assert(next_args
.empty());
463 std::istream
*f
= NULL
;
465 auto state
= pre_execute();
466 execute(f
, std::string(), args
, design
);
470 } while (!args
.empty());
473 FILE *Frontend::current_script_file
= NULL
;
474 std::string
Frontend::last_here_document
;
476 void Frontend::extra_args(std::istream
*&f
, std::string
&filename
, std::vector
<std::string
> args
, size_t argidx
, bool bin_input
)
478 bool called_with_fp
= f
!= NULL
;
482 if (argidx
< args
.size())
484 std::string arg
= args
[argidx
];
486 if (arg
.compare(0, 1, "-") == 0)
487 cmd_error(args
, argidx
, "Unknown option or option in arguments.");
489 cmd_error(args
, argidx
, "Extra filename argument in direct file mode.");
492 //Accommodate heredocs with EOT marker spaced out from "<<", e.g. "<< EOT" vs. "<<EOT"
493 if (filename
== "<<" && argidx
+1 < args
.size())
494 filename
+= args
[++argidx
];
495 if (filename
.compare(0, 2, "<<") == 0) {
496 if (filename
.size() <= 2)
497 log_error("Missing EOT marker in here document!\n");
498 std::string eot_marker
= filename
.substr(2);
499 if (Frontend::current_script_file
== nullptr)
500 filename
= "<stdin>";
501 last_here_document
.clear();
506 if (fgets(block
, 4096, Frontend::current_script_file
== nullptr? stdin
: Frontend::current_script_file
) == nullptr)
507 log_error("Unexpected end of file in here document '%s'!\n", filename
.c_str());
509 if (buffer
.size() > 0 && (buffer
[buffer
.size() - 1] == '\n' || buffer
[buffer
.size() - 1] == '\r'))
512 size_t indent
= buffer
.find_first_not_of(" \t\r\n");
513 if (indent
!= std::string::npos
&& buffer
.compare(indent
, eot_marker
.size(), eot_marker
) == 0)
515 last_here_document
+= buffer
;
517 f
= new std::istringstream(last_here_document
);
519 rewrite_filename(filename
);
520 vector
<string
> filenames
= glob_filename(filename
);
521 filename
= filenames
.front();
522 if (GetSize(filenames
) > 1) {
523 next_args
.insert(next_args
.end(), args
.begin(), args
.begin()+argidx
);
524 next_args
.insert(next_args
.end(), filenames
.begin()+1, filenames
.end());
526 std::ifstream
*ff
= new std::ifstream
;
527 ff
->open(filename
.c_str(), bin_input
? std::ifstream::binary
: std::ifstream::in
);
528 yosys_input_files
.insert(filename
);
534 // Check for gzip magic
535 unsigned char magic
[3];
541 magic
[n
] = (unsigned char) c
;
545 if (n
== 3 && magic
[0] == 0x1f && magic
[1] == 0x8b) {
546 #ifdef YOSYS_ENABLE_ZLIB
547 log("Found gzip magic in file `%s', decompressing using zlib.\n", filename
.c_str());
549 log_cmd_error("gzip file `%s' uses unsupported compression type %02x\n",
550 filename
.c_str(), unsigned(magic
[2]));
552 std::stringstream
*df
= new std::stringstream();
553 decompress_gzip(filename
, *df
);
556 log_cmd_error("File `%s' is a gzip file, but Yosys is compiled without zlib.\n", filename
.c_str());
560 ff
->seekg(0, std::ios::beg
);
565 log_cmd_error("Can't open input file `%s' for reading: %s\n", filename
.c_str(), strerror(errno
));
567 for (size_t i
= argidx
+1; i
< args
.size(); i
++)
568 if (args
[i
].compare(0, 1, "-") == 0)
569 cmd_error(args
, i
, "Found option, expected arguments.");
571 if (argidx
+1 < args
.size()) {
572 if (next_args
.empty())
573 next_args
.insert(next_args
.end(), args
.begin(), args
.begin()+argidx
);
574 next_args
.insert(next_args
.end(), args
.begin()+argidx
+1, args
.end());
575 args
.erase(args
.begin()+argidx
+1, args
.end());
580 cmd_error(args
, argidx
, "No filename given.");
583 args
.push_back(filename
);
585 // cmd_log_args(args);
588 void Frontend::frontend_call(RTLIL::Design
*design
, std::istream
*f
, std::string filename
, std::string command
)
590 std::vector
<std::string
> args
;
591 char *s
= strdup(command
.c_str());
592 for (char *p
= strtok(s
, " \t\r\n"); p
; p
= strtok(NULL
, " \t\r\n"))
595 frontend_call(design
, f
, filename
, args
);
598 void Frontend::frontend_call(RTLIL::Design
*design
, std::istream
*f
, std::string filename
, std::vector
<std::string
> args
)
600 if (args
.size() == 0)
602 if (frontend_register
.count(args
[0]) == 0)
603 log_cmd_error("No such frontend: %s\n", args
[0].c_str());
606 auto state
= frontend_register
[args
[0]]->pre_execute();
607 frontend_register
[args
[0]]->execute(f
, filename
, args
, design
);
608 frontend_register
[args
[0]]->post_execute(state
);
609 } else if (filename
== "-") {
610 std::istream
*f_cin
= &std::cin
;
611 auto state
= frontend_register
[args
[0]]->pre_execute();
612 frontend_register
[args
[0]]->execute(f_cin
, "<stdin>", args
, design
);
613 frontend_register
[args
[0]]->post_execute(state
);
615 if (!filename
.empty())
616 args
.push_back(filename
);
617 frontend_register
[args
[0]]->execute(args
, design
);
621 Backend::Backend(std::string name
, std::string short_help
) :
622 Pass(name
.rfind("=", 0) == 0 ? name
.substr(1) : "write_" + name
, short_help
),
623 backend_name(name
.rfind("=", 0) == 0 ? name
.substr(1) : name
)
627 void Backend::run_register()
629 log_assert(pass_register
.count(pass_name
) == 0);
630 pass_register
[pass_name
] = this;
632 log_assert(backend_register
.count(backend_name
) == 0);
633 backend_register
[backend_name
] = this;
640 void Backend::execute(std::vector
<std::string
> args
, RTLIL::Design
*design
)
642 std::ostream
*f
= NULL
;
643 auto state
= pre_execute();
644 execute(f
, std::string(), args
, design
);
650 void Backend::extra_args(std::ostream
*&f
, std::string
&filename
, std::vector
<std::string
> args
, size_t argidx
, bool bin_output
)
652 bool called_with_fp
= f
!= NULL
;
654 for (; argidx
< args
.size(); argidx
++)
656 std::string arg
= args
[argidx
];
658 if (arg
.compare(0, 1, "-") == 0 && arg
!= "-")
659 cmd_error(args
, argidx
, "Unknown option or option in arguments.");
661 cmd_error(args
, argidx
, "Extra filename argument in direct file mode.");
664 filename
= "<stdout>";
670 rewrite_filename(filename
);
671 if (filename
.size() > 3 && filename
.compare(filename
.size()-3, std::string::npos
, ".gz") == 0) {
672 #ifdef YOSYS_ENABLE_ZLIB
673 gzip_ostream
*gf
= new gzip_ostream
;
674 if (!gf
->open(filename
)) {
676 log_cmd_error("Can't open output file `%s' for writing: %s\n", filename
.c_str(), strerror(errno
));
678 yosys_output_files
.insert(filename
);
681 log_cmd_error("Yosys is compiled without zlib support, unable to write gzip output.\n");
684 std::ofstream
*ff
= new std::ofstream
;
685 ff
->open(filename
.c_str(), bin_output
? (std::ofstream::trunc
| std::ofstream::binary
) : std::ofstream::trunc
);
686 yosys_output_files
.insert(filename
);
689 log_cmd_error("Can't open output file `%s' for writing: %s\n", filename
.c_str(), strerror(errno
));
696 args
.push_back(filename
);
698 // cmd_log_args(args);
701 filename
= "<stdout>";
706 void Backend::backend_call(RTLIL::Design
*design
, std::ostream
*f
, std::string filename
, std::string command
)
708 std::vector
<std::string
> args
;
709 char *s
= strdup(command
.c_str());
710 for (char *p
= strtok(s
, " \t\r\n"); p
; p
= strtok(NULL
, " \t\r\n"))
713 backend_call(design
, f
, filename
, args
);
716 void Backend::backend_call(RTLIL::Design
*design
, std::ostream
*f
, std::string filename
, std::vector
<std::string
> args
)
718 if (args
.size() == 0)
720 if (backend_register
.count(args
[0]) == 0)
721 log_cmd_error("No such backend: %s\n", args
[0].c_str());
723 size_t orig_sel_stack_pos
= design
->selection_stack
.size();
726 auto state
= backend_register
[args
[0]]->pre_execute();
727 backend_register
[args
[0]]->execute(f
, filename
, args
, design
);
728 backend_register
[args
[0]]->post_execute(state
);
729 } else if (filename
== "-") {
730 std::ostream
*f_cout
= &std::cout
;
731 auto state
= backend_register
[args
[0]]->pre_execute();
732 backend_register
[args
[0]]->execute(f_cout
, "<stdout>", args
, design
);
733 backend_register
[args
[0]]->post_execute(state
);
735 if (!filename
.empty())
736 args
.push_back(filename
);
737 backend_register
[args
[0]]->execute(args
, design
);
740 while (design
->selection_stack
.size() > orig_sel_stack_pos
)
741 design
->selection_stack
.pop_back();
744 static struct CellHelpMessages
{
745 dict
<string
, string
> cell_help
, cell_code
;
747 #include "techlibs/common/simlib_help.inc"
748 #include "techlibs/common/simcells_help.inc"
752 } cell_help_messages
;
754 struct HelpPass
: public Pass
{
755 HelpPass() : Pass("help", "display help messages") { }
759 log(" help ................ list all commands\n");
760 log(" help <command> ...... print help message for given command\n");
761 log(" help -all ........... print complete command reference\n");
763 log(" help -cells .......... list all cell types\n");
764 log(" help <celltype> ..... print help message for given cell type\n");
765 log(" help <celltype>+ .... print verilog code for given cell type\n");
768 void escape_tex(std::string
&tex
)
770 for (size_t pos
= 0; (pos
= tex
.find('_', pos
)) != std::string::npos
; pos
+= 2)
771 tex
.replace(pos
, 1, "\\_");
772 for (size_t pos
= 0; (pos
= tex
.find('$', pos
)) != std::string::npos
; pos
+= 2)
773 tex
.replace(pos
, 1, "\\$");
775 void write_tex(FILE *f
, std::string cmd
, std::string title
, std::string text
)
777 size_t begin
= text
.find_first_not_of("\n"), end
= text
.find_last_not_of("\n");
778 if (begin
!= std::string::npos
&& end
!= std::string::npos
&& begin
< end
)
779 text
= text
.substr(begin
, end
-begin
+1);
780 std::string cmd_unescaped
= cmd
;
783 fprintf(f
, "\\section{%s -- %s}\n", cmd
.c_str(), title
.c_str());
784 fprintf(f
, "\\label{cmd:%s}\n", cmd_unescaped
.c_str());
785 fprintf(f
, "\\begin{lstlisting}[numbers=left,frame=single]\n");
786 fprintf(f
, "%s\n\\end{lstlisting}\n\n", text
.c_str());
788 void escape_html(std::string
&html
)
791 while ((pos
= html
.find_first_of("<>&", pos
)) != std::string::npos
)
794 html
.replace(pos
, 1, "<");
798 html
.replace(pos
, 1, ">");
802 html
.replace(pos
, 1, "&");
807 void write_html(FILE *idxf
, std::string cmd
, std::string title
, std::string text
)
809 FILE *f
= fopen(stringf("cmd_%s.in", cmd
.c_str()).c_str(), "wt");
810 fprintf(idxf
, "<li><a href=\"cmd_%s.html\"> ", cmd
.c_str());
816 fprintf(idxf
, "%s</a> <span>%s</span></a>\n", cmd
.c_str(), title
.c_str());
818 fprintf(f
, "@cmd_header %s@\n", cmd
.c_str());
819 fprintf(f
, "<h1>%s - %s</h1>\n", cmd
.c_str(), title
.c_str());
820 fprintf(f
, "<pre>%s</pre>\n", text
.c_str());
821 fprintf(f
, "@footer@\n");
825 void execute(std::vector
<std::string
> args
, RTLIL::Design
*) override
827 if (args
.size() == 1) {
829 for (auto &it
: pass_register
)
830 log(" %-20s %s\n", it
.first
.c_str(), it
.second
->short_help
.c_str());
832 log("Type 'help <command>' for more information on a command.\n");
833 log("Type 'help -cells' for a list of all cell types.\n");
838 if (args
.size() == 2) {
839 if (args
[1] == "-all") {
840 for (auto &it
: pass_register
) {
842 log("%s -- %s\n", it
.first
.c_str(), it
.second
->short_help
.c_str());
843 for (size_t i
= 0; i
< it
.first
.size() + it
.second
->short_help
.size() + 6; i
++)
847 if (it
.second
->experimental_flag
) {
849 log("WARNING: THE '%s' COMMAND IS EXPERIMENTAL.\n", it
.first
.c_str());
854 else if (args
[1] == "-cells") {
856 for (auto &it
: cell_help_messages
.cell_help
) {
857 string line
= split_tokens(it
.second
, "\n").at(0);
858 string cell_name
= next_token(line
);
859 log(" %-15s %s\n", cell_name
.c_str(), line
.c_str());
862 log("Type 'help <cell_type>' for more information on a cell type.\n");
866 // this option is undocumented as it is for internal use only
867 else if (args
[1] == "-write-tex-command-reference-manual") {
868 FILE *f
= fopen("command-reference-manual.tex", "wt");
869 fprintf(f
, "%% Generated using the yosys 'help -write-tex-command-reference-manual' command.\n\n");
870 for (auto &it
: pass_register
) {
871 std::ostringstream buf
;
872 log_streams
.push_back(&buf
);
874 if (it
.second
->experimental_flag
) {
876 log("WARNING: THE '%s' COMMAND IS EXPERIMENTAL.\n", it
.first
.c_str());
879 log_streams
.pop_back();
880 write_tex(f
, it
.first
, it
.second
->short_help
, buf
.str());
884 // this option is undocumented as it is for internal use only
885 else if (args
[1] == "-write-web-command-reference-manual") {
886 FILE *f
= fopen("templates/cmd_index.in", "wt");
887 for (auto &it
: pass_register
) {
888 std::ostringstream buf
;
889 log_streams
.push_back(&buf
);
891 if (it
.second
->experimental_flag
) {
893 log("WARNING: THE '%s' COMMAND IS EXPERIMENTAL.\n", it
.first
.c_str());
896 log_streams
.pop_back();
897 write_html(f
, it
.first
, it
.second
->short_help
, buf
.str());
901 else if (pass_register
.count(args
[1])) {
902 pass_register
.at(args
[1])->help();
903 if (pass_register
.at(args
[1])->experimental_flag
) {
905 log("WARNING: THE '%s' COMMAND IS EXPERIMENTAL.\n", args
[1].c_str());
909 else if (cell_help_messages
.cell_help
.count(args
[1])) {
910 log("%s", cell_help_messages
.cell_help
.at(args
[1]).c_str());
911 log("Run 'help %s+' to display the Verilog model for this cell type.\n", args
[1].c_str());
914 else if (cell_help_messages
.cell_code
.count(args
[1])) {
916 log("%s", cell_help_messages
.cell_code
.at(args
[1]).c_str());
919 log("No such command or cell type: %s\n", args
[1].c_str());
927 struct EchoPass
: public Pass
{
928 EchoPass() : Pass("echo", "turning echoing back of commands on and off") { }
934 log("Print all commands to log before executing them.\n");
939 log("Do not print all commands to log before executing them. (default)\n");
942 void execute(std::vector
<std::string
> args
, RTLIL::Design
*) override
945 cmd_error(args
, 2, "Unexpected argument.");
947 if (args
.size() == 2) {
950 else if (args
[1] == "off")
953 cmd_error(args
, 1, "Unexpected argument.");
956 log("echo %s\n", echo_mode
? "on" : "off");
960 SatSolver
*yosys_satsolver_list
;
961 SatSolver
*yosys_satsolver
;
963 struct MinisatSatSolver
: public SatSolver
{
964 MinisatSatSolver() : SatSolver("minisat") {
965 yosys_satsolver
= this;
967 ezSAT
*create() override
{
968 return new ezMiniSAT();