2 * yosys -- Yosys Open SYnthesis Suite
4 * Copyright (C) 2012 Clifford Wolf <clifford@clifford.at>
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/celltypes.h"
23 #ifdef YOSYS_ENABLE_READLINE
24 # include <readline/readline.h>
25 # include <readline/history.h>
28 #ifdef YOSYS_ENABLE_PLUGINS
35 #elif defined(__APPLE__)
36 # include <mach-o/dyld.h>
39 # include <sys/stat.h>
43 # include <sys/types.h>
44 # include <sys/stat.h>
54 RTLIL::Design
*yosys_design
= NULL
;
55 CellTypes yosys_celltypes
;
57 #ifdef YOSYS_ENABLE_TCL
58 Tcl_Interp
*yosys_tcl_interp
= NULL
;
61 bool memhasher_active
= false;
62 uint32_t memhasher_rng
= 123456;
63 std::vector
<void*> memhasher_store
;
68 memhasher_rng
+= time(NULL
) << 16 ^ getpid();
70 memhasher_store
.resize(0x10000);
71 memhasher_active
= true;
76 for (auto p
: memhasher_store
)
78 memhasher_store
.clear();
79 memhasher_active
= false;
84 memhasher_rng
^= memhasher_rng
<< 13;
85 memhasher_rng
^= memhasher_rng
>> 17;
86 memhasher_rng
^= memhasher_rng
<< 5;
88 int size
, index
= (memhasher_rng
>> 4) & 0xffff;
89 switch (memhasher_rng
& 7) {
90 case 0: size
= 16; break;
91 case 1: size
= 256; break;
92 case 2: size
= 1024; break;
93 case 3: size
= 4096; break;
96 if (index
< 16) size
*= 16;
97 memhasher_store
[index
] = realloc(memhasher_store
[index
], size
);
103 log(" /----------------------------------------------------------------------------\\\n");
105 log(" | yosys -- Yosys Open SYnthesis Suite |\n");
107 log(" | Copyright (C) 2012 - 2015 Clifford Wolf <clifford@clifford.at> |\n");
109 log(" | Permission to use, copy, modify, and/or distribute this software for any |\n");
110 log(" | purpose with or without fee is hereby granted, provided that the above |\n");
111 log(" | copyright notice and this permission notice appear in all copies. |\n");
113 log(" | THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |\n");
114 log(" | WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |\n");
115 log(" | MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |\n");
116 log(" | ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |\n");
117 log(" | WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |\n");
118 log(" | ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |\n");
119 log(" | OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |\n");
121 log(" \\----------------------------------------------------------------------------/\n");
123 log(" %s\n", yosys_version_str
);
127 std::string
stringf(const char *fmt
, ...)
133 string
= vstringf(fmt
, ap
);
139 std::string
vstringf(const char *fmt
, va_list ap
)
149 str
= (char*)realloc(str
, sz
);
150 rc
= vsnprintf(str
, sz
, fmt
, apc
);
152 if (rc
>= 0 && rc
< sz
)
157 if (vasprintf(&str
, fmt
, ap
) < 0)
169 int readsome(std::istream
&f
, char *s
, int n
)
171 int rc
= f
.readsome(s
, n
);
173 // f.readsome() sometimes returns 0 on a non-empty stream..
185 std::string
next_token(std::string
&text
, const char *sep
)
187 size_t pos_begin
= text
.find_first_not_of(sep
);
189 if (pos_begin
== std::string::npos
)
190 pos_begin
= text
.size();
192 size_t pos_end
= text
.find_first_of(sep
, pos_begin
);
194 if (pos_end
== std::string::npos
)
195 pos_end
= text
.size();
197 std::string token
= text
.substr(pos_begin
, pos_end
-pos_begin
);
198 text
= text
.substr(pos_end
);
202 // this is very similar to fnmatch(). the exact rules used by this
205 // ? matches any character except
206 // * matches any sequence of characters
207 // [...] matches any of the characters in the list
208 // [!..] matches any of the characters not in the list
210 // a backslash may be used to escape the next characters in the
211 // pattern. each special character can also simply match itself.
213 bool patmatch(const char *pattern
, const char *string
)
218 if (*pattern
== '\\') {
219 if (pattern
[1] == string
[0] && patmatch(pattern
+2, string
+1))
223 if (*pattern
== '?') {
226 return patmatch(pattern
+1, string
+1);
229 if (*pattern
== '*') {
231 if (patmatch(pattern
+1, string
++))
234 return pattern
[1] == 0;
237 if (*pattern
== '[') {
238 bool found_match
= false;
239 bool inverted_list
= pattern
[1] == '!';
240 const char *p
= pattern
+ (inverted_list
? 1 : 0);
244 if (found_match
!= inverted_list
&& patmatch(p
+1, string
+1))
258 if (*pattern
== *string
)
259 return patmatch(pattern
+1, string
+1);
264 int run_command(const std::string
&command
, std::function
<void(const std::string
&)> process_line
)
267 return system(command
.c_str());
269 FILE *f
= popen(command
.c_str(), "r");
275 while (fgets(logbuf
, 128, f
) != NULL
) {
277 if (!line
.empty() && line
.back() == '\n')
278 process_line(line
), line
.clear();
289 return WEXITSTATUS(ret
);
293 std::string
make_temp_file(std::string template_str
)
296 if (template_str
.rfind("/tmp/", 0) == 0) {
298 char longpath
[MAX_PATH
+ 1];
299 char shortpath
[MAX_PATH
+ 1];
301 WCHAR longpath
[MAX_PATH
+ 1];
302 TCHAR shortpath
[MAX_PATH
+ 1];
304 if (!GetTempPath(MAX_PATH
+1, longpath
))
305 log_error("GetTempPath() failed.\n");
306 if (!GetShortPathName(longpath
, shortpath
, MAX_PATH
+ 1))
307 log_error("GetShortPathName() failed.\n");
309 for (int i
= 0; shortpath
[i
]; i
++)
310 path
+= char(shortpath
[i
]);
311 template_str
= stringf("%s\\%s", path
.c_str(), template_str
.c_str() + 5);
314 size_t pos
= template_str
.rfind("XXXXXX");
315 log_assert(pos
!= std::string::npos
);
318 for (int i
= 0; i
< 6; i
++) {
319 static std::string y
= "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
320 static uint32_t x
= 314159265 ^ uint32_t(time(NULL
));
321 x
^= x
<< 13, x
^= x
>> 17, x
^= x
<< 5;
322 template_str
[pos
+i
] = y
[x
% y
.size()];
324 if (_access(template_str
.c_str(), 0) != 0)
328 size_t pos
= template_str
.rfind("XXXXXX");
329 log_assert(pos
!= std::string::npos
);
331 int suffixlen
= GetSize(template_str
) - pos
- 6;
333 char *p
= strdup(template_str
.c_str());
334 close(mkstemps(p
, suffixlen
));
342 std::string
make_temp_dir(std::string template_str
)
345 template_str
= make_temp_file(template_str
);
346 mkdir(template_str
.c_str());
350 size_t pos
= template_str
.rfind("XXXXXX");
351 log_assert(pos
!= std::string::npos
);
353 int suffixlen
= GetSize(template_str
) - pos
- 6;
354 log_assert(suffixlen
== 0);
357 char *p
= strdup(template_str
.c_str());
359 log_assert(p
!= NULL
);
368 bool check_file_exists(std::string filename
, bool)
370 return _access(filename
.c_str(), 0) == 0;
373 bool check_file_exists(std::string filename
, bool is_exec
)
375 return access(filename
.c_str(), is_exec
? X_OK
: F_OK
) == 0;
379 void remove_directory(std::string dirname
)
382 run_command(stringf("rmdir /s /q \"%s\"", dirname
.c_str()));
385 struct dirent
**namelist
;
386 int n
= scandir(dirname
.c_str(), &namelist
, nullptr, alphasort
);
388 for (int i
= 0; i
< n
; i
++) {
389 if (strcmp(namelist
[i
]->d_name
, ".") && strcmp(namelist
[i
]->d_name
, "..")) {
390 std::string buffer
= stringf("%s/%s", dirname
.c_str(), namelist
[i
]->d_name
);
391 if (!stat(buffer
.c_str(), &stbuf
) && S_ISREG(stbuf
.st_mode
)) {
392 remove(buffer
.c_str());
394 remove_directory(buffer
);
399 rmdir(dirname
.c_str());
403 int GetSize(RTLIL::Wire
*wire
)
410 // if there are already IdString objects then we have a global initialization order bug
412 log_assert(empty_id
.index_
== 0);
413 IdString::get_reference(empty_id
.index_
);
415 Pass::init_register();
416 yosys_design
= new RTLIL::Design
;
417 yosys_celltypes
.setup();
421 void yosys_shutdown()
428 for (auto f
: log_files
)
434 Pass::done_register();
435 yosys_celltypes
.clear();
437 #ifdef YOSYS_ENABLE_TCL
438 if (yosys_tcl_interp
!= NULL
) {
439 Tcl_DeleteInterp(yosys_tcl_interp
);
441 yosys_tcl_interp
= NULL
;
445 #ifdef YOSYS_ENABLE_PLUGINS
446 for (auto &it
: loaded_plugins
)
449 loaded_plugins
.clear();
450 loaded_plugin_aliases
.clear();
454 IdString::put_reference(empty_id
.index_
);
457 RTLIL::IdString
new_id(std::string file
, int line
, std::string func
)
460 size_t pos
= file
.find_last_of("/\\");
462 size_t pos
= file
.find_last_of('/');
464 if (pos
!= std::string::npos
)
465 file
= file
.substr(pos
+1);
467 pos
= func
.find_last_of(':');
468 if (pos
!= std::string::npos
)
469 func
= func
.substr(pos
+1);
471 return stringf("$auto$%s:%d:%s$%d", file
.c_str(), line
, func
.c_str(), autoidx
++);
474 RTLIL::Design
*yosys_get_design()
479 const char *create_prompt(RTLIL::Design
*design
, int recursion_counter
)
481 static char buffer
[100];
482 std::string str
= "\n";
483 if (recursion_counter
> 1)
484 str
+= stringf("(%d) ", recursion_counter
);
486 if (!design
->selected_active_module
.empty())
487 str
+= stringf(" [%s]", RTLIL::unescape_id(design
->selected_active_module
).c_str());
488 if (!design
->selection_stack
.empty() && !design
->selection_stack
.back().full_selection
) {
489 if (design
->selected_active_module
.empty())
491 else if (design
->selection_stack
.back().selected_modules
.size() != 1 || design
->selection_stack
.back().selected_members
.size() != 0 ||
492 design
->selection_stack
.back().selected_modules
.count(design
->selected_active_module
) == 0)
495 snprintf(buffer
, 100, "%s> ", str
.c_str());
499 #ifdef YOSYS_ENABLE_TCL
500 static int tcl_yosys_cmd(ClientData
, Tcl_Interp
*interp
, int argc
, const char *argv
[])
502 std::vector
<std::string
> args
;
503 for (int i
= 1; i
< argc
; i
++)
504 args
.push_back(argv
[i
]);
506 if (args
.size() >= 1 && args
[0] == "-import") {
507 for (auto &it
: pass_register
) {
508 std::string tcl_command_name
= it
.first
;
509 if (tcl_command_name
== "proc")
510 tcl_command_name
= "procs";
512 if (Tcl_GetCommandInfo(interp
, tcl_command_name
.c_str(), &info
) != 0) {
513 log("[TCL: yosys -import] Command name collision: found pre-existing command `%s' -> skip.\n", it
.first
.c_str());
515 std::string tcl_script
= stringf("proc %s args { yosys %s {*}$args }", tcl_command_name
.c_str(), it
.first
.c_str());
516 Tcl_Eval(interp
, tcl_script
.c_str());
522 if (args
.size() == 1) {
523 Pass::call(yosys_get_design(), args
[0]);
527 Pass::call(yosys_get_design(), args
);
531 extern Tcl_Interp
*yosys_get_tcl_interp()
533 if (yosys_tcl_interp
== NULL
) {
534 yosys_tcl_interp
= Tcl_CreateInterp();
535 Tcl_CreateCommand(yosys_tcl_interp
, "yosys", tcl_yosys_cmd
, NULL
, NULL
);
537 return yosys_tcl_interp
;
540 struct TclPass
: public Pass
{
541 TclPass() : Pass("tcl", "execute a TCL script file") { }
542 virtual void help() {
544 log(" tcl <filename>\n");
546 log("This command executes the tcl commands in the specified file.\n");
547 log("Use 'yosys cmd' to run the yosys command 'cmd' from tcl.\n");
549 log("The tcl command 'yosys -import' can be used to import all yosys\n");
550 log("commands directly as tcl commands to the tcl shell. The yosys\n");
551 log("command 'proc' is wrapped using the tcl command 'procs' in order\n");
552 log("to avoid a name collision with the tcl builting command 'proc'.\n");
555 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
557 log_cmd_error("Missing script file.\n");
559 extra_args(args
, 1, design
, false);
560 if (Tcl_EvalFile(yosys_get_tcl_interp(), args
[1].c_str()) != TCL_OK
)
561 log_cmd_error("TCL interpreter returned an error: %s\n", Tcl_GetStringResult(yosys_get_tcl_interp()));
566 #if defined(__linux__)
567 std::string
proc_self_dirname()
570 ssize_t buflen
= readlink("/proc/self/exe", path
, sizeof(path
));
572 log_error("readlink(\"/proc/self/exe\") failed: %s\n", strerror(errno
));
574 while (buflen
> 0 && path
[buflen
-1] != '/')
576 return std::string(path
, buflen
);
578 #elif defined(__APPLE__)
579 std::string
proc_self_dirname()
583 while (_NSGetExecutablePath(path
, &buflen
) != 0)
584 path
= (char *) realloc((void *) path
, buflen
);
585 while (buflen
> 0 && path
[buflen
-1] != '/')
587 return std::string(path
, buflen
);
589 #elif defined(_WIN32)
590 std::string
proc_self_dirname()
594 char longpath
[MAX_PATH
+ 1];
595 char shortpath
[MAX_PATH
+ 1];
597 WCHAR longpath
[MAX_PATH
+ 1];
598 TCHAR shortpath
[MAX_PATH
+ 1];
600 if (!GetModuleFileName(0, longpath
, MAX_PATH
+1))
601 log_error("GetModuleFileName() failed.\n");
602 if (!GetShortPathName(longpath
, shortpath
, MAX_PATH
+1))
603 log_error("GetShortPathName() failed.\n");
604 while (shortpath
[i
] != 0)
606 while (i
> 0 && shortpath
[i
-1] != '/' && shortpath
[i
-1] != '\\')
609 for (i
= 0; shortpath
[i
]; i
++)
610 path
+= char(shortpath
[i
]);
613 #elif defined(EMSCRIPTEN)
614 std::string
proc_self_dirname()
619 #error Dont know how to determine process executable base path!
622 std::string
proc_share_dirname()
624 std::string proc_self_path
= proc_self_dirname();
626 std::string proc_share_path
= proc_self_path
+ "share\\";
627 if (check_file_exists(proc_share_path
, true))
628 return proc_share_path
;
629 proc_share_path
= proc_self_path
+ "..\\share\\";
630 if (check_file_exists(proc_share_path
, true))
631 return proc_share_path
;
633 std::string proc_share_path
= proc_self_path
+ "share/";
634 if (check_file_exists(proc_share_path
, true))
635 return proc_share_path
;
636 proc_share_path
= proc_self_path
+ "../share/yosys/";
637 if (check_file_exists(proc_share_path
, true))
638 return proc_share_path
;
640 log_error("proc_share_dirname: unable to determine share/ directory!\n");
643 bool fgetline(FILE *f
, std::string
&buffer
)
648 if (fgets(block
, 4096, f
) == NULL
)
651 if (buffer
.size() > 0 && (buffer
[buffer
.size()-1] == '\n' || buffer
[buffer
.size()-1] == '\r')) {
652 while (buffer
.size() > 0 && (buffer
[buffer
.size()-1] == '\n' || buffer
[buffer
.size()-1] == '\r'))
653 buffer
.resize(buffer
.size()-1);
659 static void handle_label(std::string
&command
, bool &from_to_active
, const std::string
&run_from
, const std::string
&run_to
)
664 while (pos
< GetSize(command
) && (command
[pos
] == ' ' || command
[pos
] == '\t'))
667 while (pos
< GetSize(command
) && command
[pos
] != ' ' && command
[pos
] != '\t' && command
[pos
] != '\r' && command
[pos
] != '\n')
668 label
+= command
[pos
++];
670 if (label
.back() == ':' && GetSize(label
) > 1)
672 label
= label
.substr(0, GetSize(label
)-1);
673 command
= command
.substr(pos
);
675 if (label
== run_from
)
676 from_to_active
= true;
677 else if (label
== run_to
|| (run_from
== run_to
&& !run_from
.empty()))
678 from_to_active
= false;
682 void run_frontend(std::string filename
, std::string command
, std::string
*backend_command
, std::string
*from_to_label
, RTLIL::Design
*design
)
684 if (design
== nullptr)
685 design
= yosys_design
;
687 if (command
== "auto") {
688 if (filename
.size() > 2 && filename
.substr(filename
.size()-2) == ".v")
690 else if (filename
.size() > 2 && filename
.substr(filename
.size()-3) == ".sv")
691 command
= "verilog -sv";
692 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".il")
694 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".ys")
696 else if (filename
== "-")
699 log_error("Can't guess frontend for input file `%s' (missing -f option)!\n", filename
.c_str());
702 if (command
== "script")
704 std::string run_from
, run_to
;
705 bool from_to_active
= true;
707 if (from_to_label
!= NULL
) {
708 size_t pos
= from_to_label
->find(':');
709 if (pos
== std::string::npos
) {
710 run_from
= *from_to_label
;
711 run_to
= *from_to_label
;
713 run_from
= from_to_label
->substr(0, pos
);
714 run_to
= from_to_label
->substr(pos
+1);
716 from_to_active
= run_from
.empty();
719 log("\n-- Executing script file `%s' --\n", filename
.c_str());
724 f
= fopen(filename
.c_str(), "r");
727 log_error("Can't open script file `%s' for reading: %s\n", filename
.c_str(), strerror(errno
));
729 FILE *backup_script_file
= Frontend::current_script_file
;
730 Frontend::current_script_file
= f
;
734 while (fgetline(f
, command
)) {
735 while (!command
.empty() && command
[command
.size()-1] == '\\') {
736 std::string next_line
;
737 if (!fgetline(f
, next_line
))
739 command
.resize(command
.size()-1);
740 command
+= next_line
;
742 handle_label(command
, from_to_active
, run_from
, run_to
);
744 Pass::call(design
, command
);
747 if (!command
.empty()) {
748 handle_label(command
, from_to_active
, run_from
, run_to
);
750 Pass::call(design
, command
);
754 Frontend::current_script_file
= backup_script_file
;
758 Frontend::current_script_file
= backup_script_file
;
763 if (backend_command
!= NULL
&& *backend_command
== "auto")
764 *backend_command
= "";
769 if (filename
== "-") {
770 log("\n-- Parsing stdin using frontend `%s' --\n", command
.c_str());
772 log("\n-- Parsing `%s' using frontend `%s' --\n", filename
.c_str(), command
.c_str());
775 Frontend::frontend_call(design
, NULL
, filename
, command
);
778 void run_frontend(std::string filename
, std::string command
, RTLIL::Design
*design
)
780 run_frontend(filename
, command
, nullptr, nullptr, design
);
783 void run_pass(std::string command
, RTLIL::Design
*design
)
785 if (design
== nullptr)
786 design
= yosys_design
;
788 log("\n-- Running command `%s' --\n", command
.c_str());
790 Pass::call(design
, command
);
793 void run_backend(std::string filename
, std::string command
, RTLIL::Design
*design
)
795 if (design
== nullptr)
796 design
= yosys_design
;
798 if (command
== "auto") {
799 if (filename
.size() > 2 && filename
.substr(filename
.size()-2) == ".v")
801 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".il")
803 else if (filename
.size() > 5 && filename
.substr(filename
.size()-5) == ".blif")
805 else if (filename
== "-")
807 else if (filename
.empty())
810 log_error("Can't guess backend for output file `%s' (missing -b option)!\n", filename
.c_str());
813 if (filename
.empty())
816 if (filename
== "-") {
817 log("\n-- Writing to stdout using backend `%s' --\n", command
.c_str());
819 log("\n-- Writing to `%s' using backend `%s' --\n", filename
.c_str(), command
.c_str());
822 Backend::backend_call(design
, NULL
, filename
, command
);
825 #ifdef YOSYS_ENABLE_READLINE
826 static char *readline_cmd_generator(const char *text
, int state
)
828 static std::map
<std::string
, Pass
*>::iterator it
;
832 it
= pass_register
.begin();
836 for (; it
!= pass_register
.end(); it
++) {
837 if (it
->first
.substr(0, len
) == text
)
838 return strdup((it
++)->first
.c_str());
843 static char *readline_obj_generator(const char *text
, int state
)
845 static std::vector
<char*> obj_names
;
853 RTLIL::Design
*design
= yosys_get_design();
854 int len
= strlen(text
);
856 if (design
->selected_active_module
.empty())
858 for (auto &it
: design
->modules_
)
859 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
860 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
863 if (design
->modules_
.count(design
->selected_active_module
) > 0)
865 RTLIL::Module
*module
= design
->modules_
.at(design
->selected_active_module
);
867 for (auto &it
: module
->wires_
)
868 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
869 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
871 for (auto &it
: module
->memories
)
872 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
873 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
875 for (auto &it
: module
->cells_
)
876 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
877 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
879 for (auto &it
: module
->processes
)
880 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
881 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
884 std::sort(obj_names
.begin(), obj_names
.end());
887 if (idx
< obj_names
.size())
888 return strdup(obj_names
[idx
++]);
895 static char **readline_completion(const char *text
, int start
, int)
898 return rl_completion_matches(text
, readline_cmd_generator
);
899 if (strncmp(rl_line_buffer
, "read_", 5) && strncmp(rl_line_buffer
, "write_", 6))
900 return rl_completion_matches(text
, readline_obj_generator
);
905 void shell(RTLIL::Design
*design
)
907 static int recursion_counter
= 0;
910 log_cmd_error_throw
= true;
912 #ifdef YOSYS_ENABLE_READLINE
913 rl_readline_name
= "yosys";
914 rl_attempted_completion_function
= readline_completion
;
915 rl_basic_word_break_characters
= " \t\n";
918 char *command
= NULL
;
919 #ifdef YOSYS_ENABLE_READLINE
920 while ((command
= readline(create_prompt(design
, recursion_counter
))) != NULL
)
923 char command_buffer
[4096];
926 fputs(create_prompt(design
, recursion_counter
), stdout
);
928 if ((command
= fgets(command_buffer
, 4096, stdin
)) == NULL
)
931 if (command
[strspn(command
, " \t\r\n")] == 0)
933 #ifdef YOSYS_ENABLE_READLINE
934 add_history(command
);
937 char *p
= command
+ strspn(command
, " \t\r\n");
938 if (!strncmp(p
, "exit", 4)) {
940 p
+= strspn(p
, " \t\r\n");
946 log_assert(design
->selection_stack
.size() == 1);
947 Pass::call(design
, command
);
948 } catch (log_cmd_error_exception
) {
949 while (design
->selection_stack
.size() > 1)
950 design
->selection_stack
.pop_back();
958 log_cmd_error_throw
= false;
961 struct ShellPass
: public Pass
{
962 ShellPass() : Pass("shell", "enter interactive command mode") { }
963 virtual void help() {
967 log("This command enters the interactive command mode. This can be useful\n");
968 log("in a script to interrupt the script at a certain point and allow for\n");
969 log("interactive inspection or manual synthesis of the design at this point.\n");
971 log("The command prompt of the interactive shell indicates the current\n");
972 log("selection (see 'help select'):\n");
975 log(" the entire design is selected\n");
978 log(" only part of the design is selected\n");
980 log(" yosys [modname]>\n");
981 log(" the entire module 'modname' is selected using 'select -module modname'\n");
983 log(" yosys [modname]*>\n");
984 log(" only part of current module 'modname' is selected\n");
986 log("When in interactive shell, some errors (e.g. invalid command arguments)\n");
987 log("do not terminate yosys but return to the command prompt.\n");
989 log("This command is the default action if nothing else has been specified\n");
990 log("on the command line.\n");
992 log("Press Ctrl-D or type 'exit' to leave the interactive shell.\n");
995 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
996 extra_args(args
, 1, design
, false);
1001 #ifdef YOSYS_ENABLE_READLINE
1002 struct HistoryPass
: public Pass
{
1003 HistoryPass() : Pass("history", "show last interactive commands") { }
1004 virtual void help() {
1008 log("This command prints all commands in the shell history buffer. This are\n");
1009 log("all commands executed in an interactive session, but not the commands\n");
1010 log("from executed scripts.\n");
1013 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
1014 extra_args(args
, 1, design
, false);
1015 for(HIST_ENTRY
**list
= history_list(); *list
!= NULL
; list
++)
1016 log("%s\n", (*list
)->line
);
1021 struct ScriptPass
: public Pass
{
1022 ScriptPass() : Pass("script", "execute commands from script file") { }
1023 virtual void help() {
1025 log(" script <filename> [<from_label>:<to_label>]\n");
1027 log("This command executes the yosys commands in the specified file.\n");
1029 log("The 2nd argument can be used to only execute the section of the\n");
1030 log("file between the specified labels. An empty from label is synonymous\n");
1031 log("for the beginning of the file and an empty to label is synonymous\n");
1032 log("for the end of the file.\n");
1034 log("If only one label is specified (without ':') then only the block\n");
1035 log("marked with that label (until the next label) is executed.\n");
1038 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
1039 if (args
.size() < 2)
1040 log_cmd_error("Missing script file.\n");
1041 else if (args
.size() == 2)
1042 run_frontend(args
[1], "script", design
);
1043 else if (args
.size() == 3)
1044 run_frontend(args
[1], "script", NULL
, &args
[2], design
);
1046 extra_args(args
, 2, design
, false);