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_EDITLINE
29 # include <editline/readline.h>
32 #ifdef YOSYS_ENABLE_PLUGINS
39 #elif defined(__APPLE__)
40 # include <mach-o/dyld.h>
43 # include <sys/stat.h>
48 # include <sys/types.h>
49 # include <sys/wait.h>
50 # include <sys/stat.h>
55 # include <sys/sysctl.h>
59 #if PY_MAJOR_VERSION >= 3
60 # define INIT_MODULE PyInit_libyosys
61 extern "C" PyObject
* INIT_MODULE();
63 # define INIT_MODULE initlibyosys
64 extern "C" void INIT_MODULE();
75 RTLIL::Design
*yosys_design
= NULL
;
76 CellTypes yosys_celltypes
;
78 #ifdef YOSYS_ENABLE_TCL
79 Tcl_Interp
*yosys_tcl_interp
= NULL
;
82 std::set
<std::string
> yosys_input_files
, yosys_output_files
;
84 bool memhasher_active
= false;
85 uint32_t memhasher_rng
= 123456;
86 std::vector
<void*> memhasher_store
;
90 #if defined(__linux__) || defined(__FreeBSD__)
91 memhasher_rng
+= time(NULL
) << 16 ^ getpid();
93 memhasher_store
.resize(0x10000);
94 memhasher_active
= true;
99 for (auto p
: memhasher_store
)
101 memhasher_store
.clear();
102 memhasher_active
= false;
107 memhasher_rng
^= memhasher_rng
<< 13;
108 memhasher_rng
^= memhasher_rng
>> 17;
109 memhasher_rng
^= memhasher_rng
<< 5;
111 int size
, index
= (memhasher_rng
>> 4) & 0xffff;
112 switch (memhasher_rng
& 7) {
113 case 0: size
= 16; break;
114 case 1: size
= 256; break;
115 case 2: size
= 1024; break;
116 case 3: size
= 4096; break;
119 if (index
< 16) size
*= 16;
120 memhasher_store
[index
] = realloc(memhasher_store
[index
], size
);
126 log(" /----------------------------------------------------------------------------\\\n");
128 log(" | yosys -- Yosys Open SYnthesis Suite |\n");
130 log(" | Copyright (C) 2012 - 2018 Clifford Wolf <clifford@clifford.at> |\n");
132 log(" | Permission to use, copy, modify, and/or distribute this software for any |\n");
133 log(" | purpose with or without fee is hereby granted, provided that the above |\n");
134 log(" | copyright notice and this permission notice appear in all copies. |\n");
136 log(" | THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |\n");
137 log(" | WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |\n");
138 log(" | MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |\n");
139 log(" | ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |\n");
140 log(" | WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |\n");
141 log(" | ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |\n");
142 log(" | OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |\n");
144 log(" \\----------------------------------------------------------------------------/\n");
146 log(" %s\n", yosys_version_str
);
155 for (int i
= 0; i
< 32; i
++)
156 if (((x
-1) >> i
) == 0)
162 std::string
stringf(const char *fmt
, ...)
168 string
= vstringf(fmt
, ap
);
174 std::string
vstringf(const char *fmt
, va_list ap
)
184 str
= (char*)realloc(str
, sz
);
185 rc
= vsnprintf(str
, sz
, fmt
, apc
);
187 if (rc
>= 0 && rc
< sz
)
192 if (vasprintf(&str
, fmt
, ap
) < 0)
204 int readsome(std::istream
&f
, char *s
, int n
)
206 int rc
= int(f
.readsome(s
, n
));
208 // f.readsome() sometimes returns 0 on a non-empty stream..
220 std::string
next_token(std::string
&text
, const char *sep
, bool long_strings
)
222 size_t pos_begin
= text
.find_first_not_of(sep
);
224 if (pos_begin
== std::string::npos
)
225 pos_begin
= text
.size();
227 if (long_strings
&& pos_begin
!= text
.size() && text
[pos_begin
] == '"') {
228 string sep_string
= sep
;
229 for (size_t i
= pos_begin
+1; i
< text
.size(); i
++)
230 if (text
[i
] == '"' && (i
+1 == text
.size() || sep_string
.find(text
[i
+1]) != std::string::npos
)) {
231 std::string token
= text
.substr(pos_begin
, i
-pos_begin
+1);
232 text
= text
.substr(i
+1);
237 size_t pos_end
= text
.find_first_of(sep
, pos_begin
);
239 if (pos_end
== std::string::npos
)
240 pos_end
= text
.size();
242 std::string token
= text
.substr(pos_begin
, pos_end
-pos_begin
);
243 text
= text
.substr(pos_end
);
247 std::vector
<std::string
> split_tokens(const std::string
&text
, const char *sep
)
249 std::vector
<std::string
> tokens
;
250 std::string current_token
;
251 for (char c
: text
) {
252 if (strchr(sep
, c
)) {
253 if (!current_token
.empty()) {
254 tokens
.push_back(current_token
);
255 current_token
.clear();
260 if (!current_token
.empty()) {
261 tokens
.push_back(current_token
);
262 current_token
.clear();
267 // this is very similar to fnmatch(). the exact rules used by this
270 // ? matches any character except
271 // * matches any sequence of characters
272 // [...] matches any of the characters in the list
273 // [!..] matches any of the characters not in the list
275 // a backslash may be used to escape the next characters in the
276 // pattern. each special character can also simply match itself.
278 bool patmatch(const char *pattern
, const char *string
)
283 if (*pattern
== '\\') {
284 if (pattern
[1] == string
[0] && patmatch(pattern
+2, string
+1))
288 if (*pattern
== '?') {
291 return patmatch(pattern
+1, string
+1);
294 if (*pattern
== '*') {
296 if (patmatch(pattern
+1, string
++))
299 return pattern
[1] == 0;
302 if (*pattern
== '[') {
303 bool found_match
= false;
304 bool inverted_list
= pattern
[1] == '!';
305 const char *p
= pattern
+ (inverted_list
? 1 : 0);
309 if (found_match
!= inverted_list
&& patmatch(p
+1, string
+1))
323 if (*pattern
== *string
)
324 return patmatch(pattern
+1, string
+1);
329 int run_command(const std::string
&command
, std::function
<void(const std::string
&)> process_line
)
332 return system(command
.c_str());
334 FILE *f
= popen(command
.c_str(), "r");
340 while (fgets(logbuf
, 128, f
) != NULL
) {
342 if (!line
.empty() && line
.back() == '\n')
343 process_line(line
), line
.clear();
354 return WEXITSTATUS(ret
);
358 std::string
make_temp_file(std::string template_str
)
361 if (template_str
.rfind("/tmp/", 0) == 0) {
363 char longpath
[MAX_PATH
+ 1];
364 char shortpath
[MAX_PATH
+ 1];
366 WCHAR longpath
[MAX_PATH
+ 1];
367 TCHAR shortpath
[MAX_PATH
+ 1];
369 if (!GetTempPath(MAX_PATH
+1, longpath
))
370 log_error("GetTempPath() failed.\n");
371 if (!GetShortPathName(longpath
, shortpath
, MAX_PATH
+ 1))
372 log_error("GetShortPathName() failed.\n");
374 for (int i
= 0; shortpath
[i
]; i
++)
375 path
+= char(shortpath
[i
]);
376 template_str
= stringf("%s\\%s", path
.c_str(), template_str
.c_str() + 5);
379 size_t pos
= template_str
.rfind("XXXXXX");
380 log_assert(pos
!= std::string::npos
);
383 for (int i
= 0; i
< 6; i
++) {
384 static std::string y
= "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
385 static uint32_t x
= 314159265 ^ uint32_t(time(NULL
));
386 x
^= x
<< 13, x
^= x
>> 17, x
^= x
<< 5;
387 template_str
[pos
+i
] = y
[x
% y
.size()];
389 if (_access(template_str
.c_str(), 0) != 0)
393 size_t pos
= template_str
.rfind("XXXXXX");
394 log_assert(pos
!= std::string::npos
);
396 int suffixlen
= GetSize(template_str
) - pos
- 6;
398 char *p
= strdup(template_str
.c_str());
399 close(mkstemps(p
, suffixlen
));
407 std::string
make_temp_dir(std::string template_str
)
410 template_str
= make_temp_file(template_str
);
411 mkdir(template_str
.c_str());
415 size_t pos
= template_str
.rfind("XXXXXX");
416 log_assert(pos
!= std::string::npos
);
418 int suffixlen
= GetSize(template_str
) - pos
- 6;
419 log_assert(suffixlen
== 0);
422 char *p
= strdup(template_str
.c_str());
424 log_assert(p
!= NULL
);
433 bool check_file_exists(std::string filename
, bool)
435 return _access(filename
.c_str(), 0) == 0;
438 bool check_file_exists(std::string filename
, bool is_exec
)
440 return access(filename
.c_str(), is_exec
? X_OK
: F_OK
) == 0;
444 bool is_absolute_path(std::string filename
)
447 return filename
[0] == '/' || filename
[0] == '\\' || (filename
[0] != 0 && filename
[1] == ':');
449 return filename
[0] == '/';
453 void remove_directory(std::string dirname
)
456 run_command(stringf("rmdir /s /q \"%s\"", dirname
.c_str()));
459 struct dirent
**namelist
;
460 int n
= scandir(dirname
.c_str(), &namelist
, nullptr, alphasort
);
462 for (int i
= 0; i
< n
; i
++) {
463 if (strcmp(namelist
[i
]->d_name
, ".") && strcmp(namelist
[i
]->d_name
, "..")) {
464 std::string buffer
= stringf("%s/%s", dirname
.c_str(), namelist
[i
]->d_name
);
465 if (!stat(buffer
.c_str(), &stbuf
) && S_ISREG(stbuf
.st_mode
)) {
466 remove(buffer
.c_str());
468 remove_directory(buffer
);
473 rmdir(dirname
.c_str());
477 int GetSize(RTLIL::Wire
*wire
)
482 bool already_setup
= false;
488 already_setup
= true;
489 // if there are already IdString objects then we have a global initialization order bug
491 log_assert(empty_id
.index_
== 0);
492 IdString::get_reference(empty_id
.index_
);
495 PyImport_AppendInittab((char*)"libyosys", INIT_MODULE
);
497 PyRun_SimpleString("import sys");
498 PyRun_SimpleString(("sys.path.append(\""+proc_share_dirname()+"plugins\")").c_str());
501 Pass::init_register();
502 yosys_design
= new RTLIL::Design
;
503 yosys_celltypes
.setup();
507 bool yosys_already_setup()
509 return already_setup
;
512 bool already_shutdown
= false;
514 void yosys_shutdown()
518 already_shutdown
= true;
524 for (auto f
: log_files
)
530 Pass::done_register();
531 yosys_celltypes
.clear();
533 #ifdef YOSYS_ENABLE_TCL
534 if (yosys_tcl_interp
!= NULL
) {
535 Tcl_DeleteInterp(yosys_tcl_interp
);
537 yosys_tcl_interp
= NULL
;
541 #ifdef YOSYS_ENABLE_PLUGINS
542 for (auto &it
: loaded_plugins
)
545 loaded_plugins
.clear();
547 loaded_python_plugins
.clear();
549 loaded_plugin_aliases
.clear();
557 IdString::put_reference(empty_id
.index_
);
560 RTLIL::IdString
new_id(std::string file
, int line
, std::string func
)
563 size_t pos
= file
.find_last_of("/\\");
565 size_t pos
= file
.find_last_of('/');
567 if (pos
!= std::string::npos
)
568 file
= file
.substr(pos
+1);
570 pos
= func
.find_last_of(':');
571 if (pos
!= std::string::npos
)
572 func
= func
.substr(pos
+1);
574 return stringf("$auto$%s:%d:%s$%d", file
.c_str(), line
, func
.c_str(), autoidx
++);
577 RTLIL::Design
*yosys_get_design()
582 const char *create_prompt(RTLIL::Design
*design
, int recursion_counter
)
584 static char buffer
[100];
585 std::string str
= "\n";
586 if (recursion_counter
> 1)
587 str
+= stringf("(%d) ", recursion_counter
);
589 if (!design
->selected_active_module
.empty())
590 str
+= stringf(" [%s]", RTLIL::unescape_id(design
->selected_active_module
).c_str());
591 if (!design
->selection_stack
.empty() && !design
->selection_stack
.back().full_selection
) {
592 if (design
->selected_active_module
.empty())
594 else if (design
->selection_stack
.back().selected_modules
.size() != 1 || design
->selection_stack
.back().selected_members
.size() != 0 ||
595 design
->selection_stack
.back().selected_modules
.count(design
->selected_active_module
) == 0)
598 snprintf(buffer
, 100, "%s> ", str
.c_str());
602 std::vector
<std::string
> glob_filename(const std::string
&filename_pattern
)
604 std::vector
<std::string
> results
;
607 results
.push_back(filename_pattern
);
611 int err
= glob(filename_pattern
.c_str(), 0, NULL
, &globbuf
);
614 for (size_t i
= 0; i
< globbuf
.gl_pathc
; i
++)
615 results
.push_back(globbuf
.gl_pathv
[i
]);
618 results
.push_back(filename_pattern
);
625 void rewrite_filename(std::string
&filename
)
627 if (filename
.substr(0, 1) == "\"" && filename
.substr(GetSize(filename
)-1) == "\"")
628 filename
= filename
.substr(1, GetSize(filename
)-2);
629 if (filename
.substr(0, 2) == "+/")
630 filename
= proc_share_dirname() + filename
.substr(2);
633 #ifdef YOSYS_ENABLE_TCL
634 static int tcl_yosys_cmd(ClientData
, Tcl_Interp
*interp
, int argc
, const char *argv
[])
636 std::vector
<std::string
> args
;
637 for (int i
= 1; i
< argc
; i
++)
638 args
.push_back(argv
[i
]);
640 if (args
.size() >= 1 && args
[0] == "-import") {
641 for (auto &it
: pass_register
) {
642 std::string tcl_command_name
= it
.first
;
643 if (tcl_command_name
== "proc")
644 tcl_command_name
= "procs";
645 else if (tcl_command_name
== "rename")
646 tcl_command_name
= "renames";
648 if (Tcl_GetCommandInfo(interp
, tcl_command_name
.c_str(), &info
) != 0) {
649 log("[TCL: yosys -import] Command name collision: found pre-existing command `%s' -> skip.\n", it
.first
.c_str());
651 std::string tcl_script
= stringf("proc %s args { yosys %s {*}$args }", tcl_command_name
.c_str(), it
.first
.c_str());
652 Tcl_Eval(interp
, tcl_script
.c_str());
658 if (args
.size() == 1) {
659 Pass::call(yosys_get_design(), args
[0]);
663 Pass::call(yosys_get_design(), args
);
667 extern Tcl_Interp
*yosys_get_tcl_interp()
669 if (yosys_tcl_interp
== NULL
) {
670 yosys_tcl_interp
= Tcl_CreateInterp();
671 Tcl_CreateCommand(yosys_tcl_interp
, "yosys", tcl_yosys_cmd
, NULL
, NULL
);
673 return yosys_tcl_interp
;
676 struct TclPass
: public Pass
{
677 TclPass() : Pass("tcl", "execute a TCL script file") { }
678 virtual void help() {
680 log(" tcl <filename>\n");
682 log("This command executes the tcl commands in the specified file.\n");
683 log("Use 'yosys cmd' to run the yosys command 'cmd' from tcl.\n");
685 log("The tcl command 'yosys -import' can be used to import all yosys\n");
686 log("commands directly as tcl commands to the tcl shell. Yosys commands\n");
687 log("'proc' and 'rename' are wrapped to tcl commands 'procs' and 'renames'\n");
688 log("in order to avoid a name collision with the built in commands.\n");
691 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
693 log_cmd_error("Missing script file.\n");
695 extra_args(args
, 1, design
, false);
696 if (Tcl_EvalFile(yosys_get_tcl_interp(), args
[1].c_str()) != TCL_OK
)
697 log_cmd_error("TCL interpreter returned an error: %s\n", Tcl_GetStringResult(yosys_get_tcl_interp()));
702 #if defined(__linux__) || defined(__CYGWIN__)
703 std::string
proc_self_dirname()
706 ssize_t buflen
= readlink("/proc/self/exe", path
, sizeof(path
));
708 log_error("readlink(\"/proc/self/exe\") failed: %s\n", strerror(errno
));
710 while (buflen
> 0 && path
[buflen
-1] != '/')
712 return std::string(path
, buflen
);
714 #elif defined(__FreeBSD__)
715 std::string
proc_self_dirname()
717 int mib
[4] = {CTL_KERN
, KERN_PROC
, KERN_PROC_PATHNAME
, -1};
721 if (sysctl(mib
, 4, NULL
, &buflen
, NULL
, 0) != 0)
722 log_error("sysctl failed: %s\n", strerror(errno
));
723 buffer
= (char*)malloc(buflen
);
725 log_error("malloc failed: %s\n", strerror(errno
));
726 if (sysctl(mib
, 4, buffer
, &buflen
, NULL
, 0) != 0)
727 log_error("sysctl failed: %s\n", strerror(errno
));
728 while (buflen
> 0 && buffer
[buflen
-1] != '/')
730 path
.assign(buffer
, buflen
);
734 #elif defined(__APPLE__)
735 std::string
proc_self_dirname()
739 while (_NSGetExecutablePath(path
, &buflen
) != 0)
740 path
= (char *) realloc((void *) path
, buflen
);
741 while (buflen
> 0 && path
[buflen
-1] != '/')
743 return std::string(path
, buflen
);
745 #elif defined(_WIN32)
746 std::string
proc_self_dirname()
750 char longpath
[MAX_PATH
+ 1];
751 char shortpath
[MAX_PATH
+ 1];
753 WCHAR longpath
[MAX_PATH
+ 1];
754 TCHAR shortpath
[MAX_PATH
+ 1];
756 if (!GetModuleFileName(0, longpath
, MAX_PATH
+1))
757 log_error("GetModuleFileName() failed.\n");
758 if (!GetShortPathName(longpath
, shortpath
, MAX_PATH
+1))
759 log_error("GetShortPathName() failed.\n");
760 while (shortpath
[i
] != 0)
762 while (i
> 0 && shortpath
[i
-1] != '/' && shortpath
[i
-1] != '\\')
765 for (i
= 0; shortpath
[i
]; i
++)
766 path
+= char(shortpath
[i
]);
769 #elif defined(EMSCRIPTEN)
770 std::string
proc_self_dirname()
775 #error Dont know how to determine process executable base path!
779 std::string
proc_share_dirname()
784 std::string
proc_share_dirname()
786 std::string proc_self_path
= proc_self_dirname();
787 # if defined(_WIN32) && !defined(YOSYS_WIN32_UNIX_DIR)
788 std::string proc_share_path
= proc_self_path
+ "share\\";
789 if (check_file_exists(proc_share_path
, true))
790 return proc_share_path
;
791 proc_share_path
= proc_self_path
+ "..\\share\\";
792 if (check_file_exists(proc_share_path
, true))
793 return proc_share_path
;
795 std::string proc_share_path
= proc_self_path
+ "share/";
796 if (check_file_exists(proc_share_path
, true))
797 return proc_share_path
;
798 proc_share_path
= proc_self_path
+ "../share/yosys/";
799 if (check_file_exists(proc_share_path
, true))
800 return proc_share_path
;
802 proc_share_path
= YOSYS_DATDIR
"/";
803 if (check_file_exists(proc_share_path
, true))
804 return proc_share_path
;
807 log_error("proc_share_dirname: unable to determine share/ directory!\n");
811 bool fgetline(FILE *f
, std::string
&buffer
)
816 if (fgets(block
, 4096, f
) == NULL
)
819 if (buffer
.size() > 0 && (buffer
[buffer
.size()-1] == '\n' || buffer
[buffer
.size()-1] == '\r')) {
820 while (buffer
.size() > 0 && (buffer
[buffer
.size()-1] == '\n' || buffer
[buffer
.size()-1] == '\r'))
821 buffer
.resize(buffer
.size()-1);
827 static void handle_label(std::string
&command
, bool &from_to_active
, const std::string
&run_from
, const std::string
&run_to
)
832 while (pos
< GetSize(command
) && (command
[pos
] == ' ' || command
[pos
] == '\t'))
835 if (pos
< GetSize(command
) && command
[pos
] == '#')
838 while (pos
< GetSize(command
) && command
[pos
] != ' ' && command
[pos
] != '\t' && command
[pos
] != '\r' && command
[pos
] != '\n')
839 label
+= command
[pos
++];
841 if (label
.back() == ':' && GetSize(label
) > 1)
843 label
= label
.substr(0, GetSize(label
)-1);
844 command
= command
.substr(pos
);
846 if (label
== run_from
)
847 from_to_active
= true;
848 else if (label
== run_to
|| (run_from
== run_to
&& !run_from
.empty()))
849 from_to_active
= false;
853 void run_frontend(std::string filename
, std::string command
, std::string
*backend_command
, std::string
*from_to_label
, RTLIL::Design
*design
)
855 if (design
== nullptr)
856 design
= yosys_design
;
858 if (command
== "auto") {
859 if (filename
.size() > 2 && filename
.substr(filename
.size()-2) == ".v")
861 else if (filename
.size() > 2 && filename
.substr(filename
.size()-3) == ".sv")
862 command
= "verilog -sv";
863 else if (filename
.size() > 2 && filename
.substr(filename
.size()-4) == ".vhd")
865 else if (filename
.size() > 4 && filename
.substr(filename
.size()-5) == ".blif")
867 else if (filename
.size() > 4 && filename
.substr(filename
.size()-5) == ".json")
869 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".il")
871 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".ys")
873 else if (filename
.size() > 2 && filename
.substr(filename
.size()-4) == ".tcl")
875 else if (filename
== "-")
878 log_error("Can't guess frontend for input file `%s' (missing -f option)!\n", filename
.c_str());
881 if (command
== "script")
883 std::string run_from
, run_to
;
884 bool from_to_active
= true;
886 if (from_to_label
!= NULL
) {
887 size_t pos
= from_to_label
->find(':');
888 if (pos
== std::string::npos
) {
889 run_from
= *from_to_label
;
890 run_to
= *from_to_label
;
892 run_from
= from_to_label
->substr(0, pos
);
893 run_to
= from_to_label
->substr(pos
+1);
895 from_to_active
= run_from
.empty();
898 log("\n-- Executing script file `%s' --\n", filename
.c_str());
902 if (filename
!= "-") {
903 f
= fopen(filename
.c_str(), "r");
904 yosys_input_files
.insert(filename
);
908 log_error("Can't open script file `%s' for reading: %s\n", filename
.c_str(), strerror(errno
));
910 FILE *backup_script_file
= Frontend::current_script_file
;
911 Frontend::current_script_file
= f
;
915 while (fgetline(f
, command
)) {
916 while (!command
.empty() && command
[command
.size()-1] == '\\') {
917 std::string next_line
;
918 if (!fgetline(f
, next_line
))
920 command
.resize(command
.size()-1);
921 command
+= next_line
;
923 handle_label(command
, from_to_active
, run_from
, run_to
);
925 Pass::call(design
, command
);
928 if (!command
.empty()) {
929 handle_label(command
, from_to_active
, run_from
, run_to
);
931 Pass::call(design
, command
);
935 Frontend::current_script_file
= backup_script_file
;
939 Frontend::current_script_file
= backup_script_file
;
944 if (backend_command
!= NULL
&& *backend_command
== "auto")
945 *backend_command
= "";
950 if (filename
== "-") {
951 log("\n-- Parsing stdin using frontend `%s' --\n", command
.c_str());
953 log("\n-- Parsing `%s' using frontend `%s' --\n", filename
.c_str(), command
.c_str());
956 if (command
== "tcl")
957 Pass::call(design
, vector
<string
>({command
, filename
}));
959 Frontend::frontend_call(design
, NULL
, filename
, command
);
962 void run_frontend(std::string filename
, std::string command
, RTLIL::Design
*design
)
964 run_frontend(filename
, command
, nullptr, nullptr, design
);
967 void run_pass(std::string command
, RTLIL::Design
*design
)
969 if (design
== nullptr)
970 design
= yosys_design
;
972 log("\n-- Running command `%s' --\n", command
.c_str());
974 Pass::call(design
, command
);
977 void run_backend(std::string filename
, std::string command
, RTLIL::Design
*design
)
979 if (design
== nullptr)
980 design
= yosys_design
;
982 if (command
== "auto") {
983 if (filename
.size() > 2 && filename
.substr(filename
.size()-2) == ".v")
985 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".il")
987 else if (filename
.size() > 4 && filename
.substr(filename
.size()-4) == ".aig")
989 else if (filename
.size() > 5 && filename
.substr(filename
.size()-5) == ".blif")
991 else if (filename
.size() > 5 && filename
.substr(filename
.size()-5) == ".edif")
993 else if (filename
.size() > 5 && filename
.substr(filename
.size()-5) == ".json")
995 else if (filename
== "-")
997 else if (filename
.empty())
1000 log_error("Can't guess backend for output file `%s' (missing -b option)!\n", filename
.c_str());
1003 if (filename
.empty())
1006 if (filename
== "-") {
1007 log("\n-- Writing to stdout using backend `%s' --\n", command
.c_str());
1009 log("\n-- Writing to `%s' using backend `%s' --\n", filename
.c_str(), command
.c_str());
1012 Backend::backend_call(design
, NULL
, filename
, command
);
1015 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1016 static char *readline_cmd_generator(const char *text
, int state
)
1018 static std::map
<std::string
, Pass
*>::iterator it
;
1022 it
= pass_register
.begin();
1026 for (; it
!= pass_register
.end(); it
++) {
1027 if (it
->first
.substr(0, len
) == text
)
1028 return strdup((it
++)->first
.c_str());
1033 static char *readline_obj_generator(const char *text
, int state
)
1035 static std::vector
<char*> obj_names
;
1043 RTLIL::Design
*design
= yosys_get_design();
1044 int len
= strlen(text
);
1046 if (design
->selected_active_module
.empty())
1048 for (auto &it
: design
->modules_
)
1049 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
1050 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1053 if (design
->modules_
.count(design
->selected_active_module
) > 0)
1055 RTLIL::Module
*module
= design
->modules_
.at(design
->selected_active_module
);
1057 for (auto &it
: module
->wires_
)
1058 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
1059 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1061 for (auto &it
: module
->memories
)
1062 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
1063 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1065 for (auto &it
: module
->cells_
)
1066 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
1067 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1069 for (auto &it
: module
->processes
)
1070 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
1071 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1074 std::sort(obj_names
.begin(), obj_names
.end());
1077 if (idx
< obj_names
.size())
1078 return strdup(obj_names
[idx
++]);
1085 static char **readline_completion(const char *text
, int start
, int)
1088 return rl_completion_matches(text
, readline_cmd_generator
);
1089 if (strncmp(rl_line_buffer
, "read_", 5) && strncmp(rl_line_buffer
, "write_", 6))
1090 return rl_completion_matches(text
, readline_obj_generator
);
1095 void shell(RTLIL::Design
*design
)
1097 static int recursion_counter
= 0;
1099 recursion_counter
++;
1100 log_cmd_error_throw
= true;
1102 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1103 rl_readline_name
= (char*)"yosys";
1104 rl_attempted_completion_function
= readline_completion
;
1105 rl_basic_word_break_characters
= (char*)" \t\n";
1108 char *command
= NULL
;
1109 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1110 while ((command
= readline(create_prompt(design
, recursion_counter
))) != NULL
)
1113 char command_buffer
[4096];
1116 fputs(create_prompt(design
, recursion_counter
), stdout
);
1118 if ((command
= fgets(command_buffer
, 4096, stdin
)) == NULL
)
1121 if (command
[strspn(command
, " \t\r\n")] == 0)
1123 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1124 add_history(command
);
1127 char *p
= command
+ strspn(command
, " \t\r\n");
1128 if (!strncmp(p
, "exit", 4)) {
1130 p
+= strspn(p
, " \t\r\n");
1136 log_assert(design
->selection_stack
.size() == 1);
1137 Pass::call(design
, command
);
1138 } catch (log_cmd_error_exception
) {
1139 while (design
->selection_stack
.size() > 1)
1140 design
->selection_stack
.pop_back();
1144 if (command
== NULL
)
1147 recursion_counter
--;
1148 log_cmd_error_throw
= false;
1151 struct ShellPass
: public Pass
{
1152 ShellPass() : Pass("shell", "enter interactive command mode") { }
1153 virtual void help() {
1157 log("This command enters the interactive command mode. This can be useful\n");
1158 log("in a script to interrupt the script at a certain point and allow for\n");
1159 log("interactive inspection or manual synthesis of the design at this point.\n");
1161 log("The command prompt of the interactive shell indicates the current\n");
1162 log("selection (see 'help select'):\n");
1165 log(" the entire design is selected\n");
1168 log(" only part of the design is selected\n");
1170 log(" yosys [modname]>\n");
1171 log(" the entire module 'modname' is selected using 'select -module modname'\n");
1173 log(" yosys [modname]*>\n");
1174 log(" only part of current module 'modname' is selected\n");
1176 log("When in interactive shell, some errors (e.g. invalid command arguments)\n");
1177 log("do not terminate yosys but return to the command prompt.\n");
1179 log("This command is the default action if nothing else has been specified\n");
1180 log("on the command line.\n");
1182 log("Press Ctrl-D or type 'exit' to leave the interactive shell.\n");
1185 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
1186 extra_args(args
, 1, design
, false);
1191 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1192 struct HistoryPass
: public Pass
{
1193 HistoryPass() : Pass("history", "show last interactive commands") { }
1194 virtual void help() {
1198 log("This command prints all commands in the shell history buffer. This are\n");
1199 log("all commands executed in an interactive session, but not the commands\n");
1200 log("from executed scripts.\n");
1203 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
1204 extra_args(args
, 1, design
, false);
1205 #ifdef YOSYS_ENABLE_READLINE
1206 for(HIST_ENTRY
**list
= history_list(); *list
!= NULL
; list
++)
1207 log("%s\n", (*list
)->line
);
1209 for (int i
= where_history(); history_get(i
); i
++)
1210 log("%s\n", history_get(i
)->line
);
1216 struct ScriptCmdPass
: public Pass
{
1217 ScriptCmdPass() : Pass("script", "execute commands from script file") { }
1218 virtual void help() {
1220 log(" script <filename> [<from_label>:<to_label>]\n");
1222 log("This command executes the yosys commands in the specified file.\n");
1224 log("The 2nd argument can be used to only execute the section of the\n");
1225 log("file between the specified labels. An empty from label is synonymous\n");
1226 log("for the beginning of the file and an empty to label is synonymous\n");
1227 log("for the end of the file.\n");
1229 log("If only one label is specified (without ':') then only the block\n");
1230 log("marked with that label (until the next label) is executed.\n");
1233 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
1234 if (args
.size() < 2)
1235 log_cmd_error("Missing script file.\n");
1236 else if (args
.size() == 2)
1237 run_frontend(args
[1], "script", design
);
1238 else if (args
.size() == 3)
1239 run_frontend(args
[1], "script", NULL
, &args
[2], design
);
1241 extra_args(args
, 2, design
, false);