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>
47 # include <sys/types.h>
48 # include <sys/wait.h>
49 # include <sys/stat.h>
52 #if !defined(_WIN32) && defined(YOSYS_ENABLE_GLOB)
57 # include <sys/sysctl.h>
61 #if PY_MAJOR_VERSION >= 3
62 # define INIT_MODULE PyInit_libyosys
63 extern "C" PyObject
* INIT_MODULE();
65 # define INIT_MODULE initlibyosys
66 extern "C" void INIT_MODULE();
77 RTLIL::Design
*yosys_design
= NULL
;
78 CellTypes yosys_celltypes
;
80 #ifdef YOSYS_ENABLE_TCL
81 Tcl_Interp
*yosys_tcl_interp
= NULL
;
84 std::set
<std::string
> yosys_input_files
, yosys_output_files
;
86 bool memhasher_active
= false;
87 uint32_t memhasher_rng
= 123456;
88 std::vector
<void*> memhasher_store
;
92 #if defined(__linux__) || defined(__FreeBSD__)
93 memhasher_rng
+= time(NULL
) << 16 ^ getpid();
95 memhasher_store
.resize(0x10000);
96 memhasher_active
= true;
101 for (auto p
: memhasher_store
)
103 memhasher_store
.clear();
104 memhasher_active
= false;
109 memhasher_rng
^= memhasher_rng
<< 13;
110 memhasher_rng
^= memhasher_rng
>> 17;
111 memhasher_rng
^= memhasher_rng
<< 5;
113 int size
, index
= (memhasher_rng
>> 4) & 0xffff;
114 switch (memhasher_rng
& 7) {
115 case 0: size
= 16; break;
116 case 1: size
= 256; break;
117 case 2: size
= 1024; break;
118 case 3: size
= 4096; break;
121 if (index
< 16) size
*= 16;
122 memhasher_store
[index
] = realloc(memhasher_store
[index
], size
);
128 log(" /----------------------------------------------------------------------------\\\n");
130 log(" | yosys -- Yosys Open SYnthesis Suite |\n");
132 log(" | Copyright (C) 2012 - 2019 Clifford Wolf <clifford@clifford.at> |\n");
134 log(" | Permission to use, copy, modify, and/or distribute this software for any |\n");
135 log(" | purpose with or without fee is hereby granted, provided that the above |\n");
136 log(" | copyright notice and this permission notice appear in all copies. |\n");
138 log(" | THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |\n");
139 log(" | WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |\n");
140 log(" | MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |\n");
141 log(" | ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |\n");
142 log(" | WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |\n");
143 log(" | ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |\n");
144 log(" | OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |\n");
146 log(" \\----------------------------------------------------------------------------/\n");
148 log(" %s\n", yosys_version_str
);
154 #if defined(__GNUC__)
155 return x
> 1 ? (8*sizeof(int)) - __builtin_clz(x
-1) : 0;
159 for (int i
= 0; i
< 32; i
++)
160 if (((x
-1) >> i
) == 0)
166 std::string
stringf(const char *fmt
, ...)
172 string
= vstringf(fmt
, ap
);
178 std::string
vstringf(const char *fmt
, va_list ap
)
183 #if defined(_WIN32 )|| defined(__CYGWIN__)
188 str
= (char*)realloc(str
, sz
);
189 rc
= vsnprintf(str
, sz
, fmt
, apc
);
191 if (rc
>= 0 && rc
< sz
)
196 if (vasprintf(&str
, fmt
, ap
) < 0)
208 int readsome(std::istream
&f
, char *s
, int n
)
210 int rc
= int(f
.readsome(s
, n
));
212 // f.readsome() sometimes returns 0 on a non-empty stream..
224 std::string
next_token(std::string
&text
, const char *sep
, bool long_strings
)
226 size_t pos_begin
= text
.find_first_not_of(sep
);
228 if (pos_begin
== std::string::npos
)
229 pos_begin
= text
.size();
231 if (long_strings
&& pos_begin
!= text
.size() && text
[pos_begin
] == '"') {
232 string sep_string
= sep
;
233 for (size_t i
= pos_begin
+1; i
< text
.size(); i
++) {
234 if (text
[i
] == '"' && (i
+1 == text
.size() || sep_string
.find(text
[i
+1]) != std::string::npos
)) {
235 std::string token
= text
.substr(pos_begin
, i
-pos_begin
+1);
236 text
= text
.substr(i
+1);
239 if (i
+1 < text
.size() && text
[i
] == '"' && text
[i
+1] == ';' && (i
+2 == text
.size() || sep_string
.find(text
[i
+2]) != std::string::npos
)) {
240 std::string token
= text
.substr(pos_begin
, i
-pos_begin
+1);
241 text
= text
.substr(i
+2);
247 size_t pos_end
= text
.find_first_of(sep
, pos_begin
);
249 if (pos_end
== std::string::npos
)
250 pos_end
= text
.size();
252 std::string token
= text
.substr(pos_begin
, pos_end
-pos_begin
);
253 text
= text
.substr(pos_end
);
257 std::vector
<std::string
> split_tokens(const std::string
&text
, const char *sep
)
259 std::vector
<std::string
> tokens
;
260 std::string current_token
;
261 for (char c
: text
) {
262 if (strchr(sep
, c
)) {
263 if (!current_token
.empty()) {
264 tokens
.push_back(current_token
);
265 current_token
.clear();
270 if (!current_token
.empty()) {
271 tokens
.push_back(current_token
);
272 current_token
.clear();
277 // this is very similar to fnmatch(). the exact rules used by this
280 // ? matches any character except
281 // * matches any sequence of characters
282 // [...] matches any of the characters in the list
283 // [!..] matches any of the characters not in the list
285 // a backslash may be used to escape the next characters in the
286 // pattern. each special character can also simply match itself.
288 bool patmatch(const char *pattern
, const char *string
)
293 if (*pattern
== '\\') {
294 if (pattern
[1] == string
[0] && patmatch(pattern
+2, string
+1))
298 if (*pattern
== '?') {
301 return patmatch(pattern
+1, string
+1);
304 if (*pattern
== '*') {
306 if (patmatch(pattern
+1, string
++))
309 return pattern
[1] == 0;
312 if (*pattern
== '[') {
313 bool found_match
= false;
314 bool inverted_list
= pattern
[1] == '!';
315 const char *p
= pattern
+ (inverted_list
? 1 : 0);
319 if (found_match
!= inverted_list
&& patmatch(p
+1, string
+1))
333 if (*pattern
== *string
)
334 return patmatch(pattern
+1, string
+1);
339 int run_command(const std::string
&command
, std::function
<void(const std::string
&)> process_line
)
342 return system(command
.c_str());
344 FILE *f
= popen(command
.c_str(), "r");
350 while (fgets(logbuf
, 128, f
) != NULL
) {
352 if (!line
.empty() && line
.back() == '\n')
353 process_line(line
), line
.clear();
364 return WEXITSTATUS(ret
);
368 std::string
make_temp_file(std::string template_str
)
371 if (template_str
.rfind("/tmp/", 0) == 0) {
373 char longpath
[MAX_PATH
+ 1];
374 char shortpath
[MAX_PATH
+ 1];
376 WCHAR longpath
[MAX_PATH
+ 1];
377 TCHAR shortpath
[MAX_PATH
+ 1];
379 if (!GetTempPath(MAX_PATH
+1, longpath
))
380 log_error("GetTempPath() failed.\n");
381 if (!GetShortPathName(longpath
, shortpath
, MAX_PATH
+ 1))
382 log_error("GetShortPathName() failed.\n");
384 for (int i
= 0; shortpath
[i
]; i
++)
385 path
+= char(shortpath
[i
]);
386 template_str
= stringf("%s\\%s", path
.c_str(), template_str
.c_str() + 5);
389 size_t pos
= template_str
.rfind("XXXXXX");
390 log_assert(pos
!= std::string::npos
);
393 for (int i
= 0; i
< 6; i
++) {
394 static std::string y
= "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
395 static uint32_t x
= 314159265 ^ uint32_t(time(NULL
));
396 x
^= x
<< 13, x
^= x
>> 17, x
^= x
<< 5;
397 template_str
[pos
+i
] = y
[x
% y
.size()];
399 if (_access(template_str
.c_str(), 0) != 0)
403 size_t pos
= template_str
.rfind("XXXXXX");
404 log_assert(pos
!= std::string::npos
);
406 int suffixlen
= GetSize(template_str
) - pos
- 6;
408 char *p
= strdup(template_str
.c_str());
409 close(mkstemps(p
, suffixlen
));
417 std::string
make_temp_dir(std::string template_str
)
420 template_str
= make_temp_file(template_str
);
421 mkdir(template_str
.c_str());
425 size_t pos
= template_str
.rfind("XXXXXX");
426 log_assert(pos
!= std::string::npos
);
428 int suffixlen
= GetSize(template_str
) - pos
- 6;
429 log_assert(suffixlen
== 0);
432 char *p
= strdup(template_str
.c_str());
434 log_assert(p
!= NULL
);
443 bool check_file_exists(std::string filename
, bool)
445 return _access(filename
.c_str(), 0) == 0;
448 bool check_file_exists(std::string filename
, bool is_exec
)
450 return access(filename
.c_str(), is_exec
? X_OK
: F_OK
) == 0;
454 bool is_absolute_path(std::string filename
)
457 return filename
[0] == '/' || filename
[0] == '\\' || (filename
[0] != 0 && filename
[1] == ':');
459 return filename
[0] == '/';
463 void remove_directory(std::string dirname
)
466 run_command(stringf("rmdir /s /q \"%s\"", dirname
.c_str()));
469 struct dirent
**namelist
;
470 int n
= scandir(dirname
.c_str(), &namelist
, nullptr, alphasort
);
472 for (int i
= 0; i
< n
; i
++) {
473 if (strcmp(namelist
[i
]->d_name
, ".") && strcmp(namelist
[i
]->d_name
, "..")) {
474 std::string buffer
= stringf("%s/%s", dirname
.c_str(), namelist
[i
]->d_name
);
475 if (!stat(buffer
.c_str(), &stbuf
) && S_ISREG(stbuf
.st_mode
)) {
476 remove(buffer
.c_str());
478 remove_directory(buffer
);
483 rmdir(dirname
.c_str());
487 std::string
escape_filename_spaces(const std::string
& filename
)
490 out
.reserve(filename
.size());
491 for (auto c
: filename
)
501 int GetSize(RTLIL::Wire
*wire
)
506 bool already_setup
= false;
512 already_setup
= true;
514 RTLIL::ID::A
= "\\A";
515 RTLIL::ID::B
= "\\B";
516 RTLIL::ID::Y
= "\\Y";
517 RTLIL::ID::keep
= "\\keep";
518 RTLIL::ID::whitebox
= "\\whitebox";
519 RTLIL::ID::blackbox
= "\\blackbox";
522 PyImport_AppendInittab((char*)"libyosys", INIT_MODULE
);
524 PyRun_SimpleString("import sys");
527 Pass::init_register();
528 yosys_design
= new RTLIL::Design
;
529 yosys_celltypes
.setup();
533 bool yosys_already_setup()
535 return already_setup
;
538 bool already_shutdown
= false;
540 void yosys_shutdown()
544 already_shutdown
= true;
547 Pass::done_register();
552 for (auto f
: log_files
)
558 yosys_celltypes
.clear();
560 #ifdef YOSYS_ENABLE_TCL
561 if (yosys_tcl_interp
!= NULL
) {
562 Tcl_DeleteInterp(yosys_tcl_interp
);
564 yosys_tcl_interp
= NULL
;
568 #ifdef YOSYS_ENABLE_PLUGINS
569 for (auto &it
: loaded_plugins
)
572 loaded_plugins
.clear();
574 loaded_python_plugins
.clear();
576 loaded_plugin_aliases
.clear();
584 RTLIL::IdString
new_id(std::string file
, int line
, std::string func
)
587 size_t pos
= file
.find_last_of("/\\");
589 size_t pos
= file
.find_last_of('/');
591 if (pos
!= std::string::npos
)
592 file
= file
.substr(pos
+1);
594 pos
= func
.find_last_of(':');
595 if (pos
!= std::string::npos
)
596 func
= func
.substr(pos
+1);
598 return stringf("$auto$%s:%d:%s$%d", file
.c_str(), line
, func
.c_str(), autoidx
++);
601 RTLIL::Design
*yosys_get_design()
606 const char *create_prompt(RTLIL::Design
*design
, int recursion_counter
)
608 static char buffer
[100];
609 std::string str
= "\n";
610 if (recursion_counter
> 1)
611 str
+= stringf("(%d) ", recursion_counter
);
613 if (!design
->selected_active_module
.empty())
614 str
+= stringf(" [%s]", RTLIL::unescape_id(design
->selected_active_module
).c_str());
615 if (!design
->selection_stack
.empty() && !design
->selection_stack
.back().full_selection
) {
616 if (design
->selected_active_module
.empty())
618 else if (design
->selection_stack
.back().selected_modules
.size() != 1 || design
->selection_stack
.back().selected_members
.size() != 0 ||
619 design
->selection_stack
.back().selected_modules
.count(design
->selected_active_module
) == 0)
622 snprintf(buffer
, 100, "%s> ", str
.c_str());
626 std::vector
<std::string
> glob_filename(const std::string
&filename_pattern
)
628 std::vector
<std::string
> results
;
630 #if defined(_WIN32) || !defined(YOSYS_ENABLE_GLOB)
631 results
.push_back(filename_pattern
);
635 int err
= glob(filename_pattern
.c_str(), 0, NULL
, &globbuf
);
638 for (size_t i
= 0; i
< globbuf
.gl_pathc
; i
++)
639 results
.push_back(globbuf
.gl_pathv
[i
]);
642 results
.push_back(filename_pattern
);
649 void rewrite_filename(std::string
&filename
)
651 if (filename
.compare(0, 1, "\"") == 0 && filename
.compare(GetSize(filename
)-1, std::string::npos
, "\"") == 0)
652 filename
= filename
.substr(1, GetSize(filename
)-2);
653 if (filename
.compare(0, 2, "+/") == 0)
654 filename
= proc_share_dirname() + filename
.substr(2);
656 if (filename
.compare(0, 2, "~/") == 0)
657 filename
= filename
.replace(0, 1, getenv("HOME"));
661 #ifdef YOSYS_ENABLE_TCL
662 static int tcl_yosys_cmd(ClientData
, Tcl_Interp
*interp
, int argc
, const char *argv
[])
664 std::vector
<std::string
> args
;
665 for (int i
= 1; i
< argc
; i
++)
666 args
.push_back(argv
[i
]);
668 if (args
.size() >= 1 && args
[0] == "-import") {
669 for (auto &it
: pass_register
) {
670 std::string tcl_command_name
= it
.first
;
671 if (tcl_command_name
== "proc")
672 tcl_command_name
= "procs";
673 else if (tcl_command_name
== "rename")
674 tcl_command_name
= "renames";
676 if (Tcl_GetCommandInfo(interp
, tcl_command_name
.c_str(), &info
) != 0) {
677 log("[TCL: yosys -import] Command name collision: found pre-existing command `%s' -> skip.\n", it
.first
.c_str());
679 std::string tcl_script
= stringf("proc %s args { yosys %s {*}$args }", tcl_command_name
.c_str(), it
.first
.c_str());
680 Tcl_Eval(interp
, tcl_script
.c_str());
686 if (args
.size() == 1) {
687 Pass::call(yosys_get_design(), args
[0]);
691 Pass::call(yosys_get_design(), args
);
695 extern Tcl_Interp
*yosys_get_tcl_interp()
697 if (yosys_tcl_interp
== NULL
) {
698 yosys_tcl_interp
= Tcl_CreateInterp();
699 Tcl_CreateCommand(yosys_tcl_interp
, "yosys", tcl_yosys_cmd
, NULL
, NULL
);
701 return yosys_tcl_interp
;
704 struct TclPass
: public Pass
{
705 TclPass() : Pass("tcl", "execute a TCL script file") { }
706 void help() YS_OVERRIDE
{
707 // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
709 log(" tcl <filename> [args]\n");
711 log("This command executes the tcl commands in the specified file.\n");
712 log("Use 'yosys cmd' to run the yosys command 'cmd' from tcl.\n");
714 log("The tcl command 'yosys -import' can be used to import all yosys\n");
715 log("commands directly as tcl commands to the tcl shell. Yosys commands\n");
716 log("'proc' and 'rename' are wrapped to tcl commands 'procs' and 'renames'\n");
717 log("in order to avoid a name collision with the built in commands.\n");
719 log("If any arguments are specified, these arguments are provided to the script via\n");
720 log("the standard $argc and $argv variables.\n");
723 void execute(std::vector
<std::string
> args
, RTLIL::Design
*) YS_OVERRIDE
{
725 log_cmd_error("Missing script file.\n");
727 std::vector
<Tcl_Obj
*> script_args
;
728 for (auto it
= args
.begin() + 2; it
!= args
.end(); ++it
)
729 script_args
.push_back(Tcl_NewStringObj((*it
).c_str(), (*it
).size()));
731 Tcl_Interp
*interp
= yosys_get_tcl_interp();
732 Tcl_ObjSetVar2(interp
, Tcl_NewStringObj("argc", 4), NULL
, Tcl_NewIntObj(script_args
.size()), 0);
733 Tcl_ObjSetVar2(interp
, Tcl_NewStringObj("argv", 4), NULL
, Tcl_NewListObj(script_args
.size(), script_args
.data()), 0);
734 Tcl_ObjSetVar2(interp
, Tcl_NewStringObj("argv0", 5), NULL
, Tcl_NewStringObj(args
[1].c_str(), args
[1].size()), 0);
735 if (Tcl_EvalFile(interp
, args
[1].c_str()) != TCL_OK
)
736 log_cmd_error("TCL interpreter returned an error: %s\n", Tcl_GetStringResult(interp
));
741 #if defined(__linux__) || defined(__CYGWIN__)
742 std::string
proc_self_dirname()
745 ssize_t buflen
= readlink("/proc/self/exe", path
, sizeof(path
));
747 log_error("readlink(\"/proc/self/exe\") failed: %s\n", strerror(errno
));
749 while (buflen
> 0 && path
[buflen
-1] != '/')
751 return std::string(path
, buflen
);
753 #elif defined(__FreeBSD__)
754 std::string
proc_self_dirname()
756 int mib
[4] = {CTL_KERN
, KERN_PROC
, KERN_PROC_PATHNAME
, -1};
760 if (sysctl(mib
, 4, NULL
, &buflen
, NULL
, 0) != 0)
761 log_error("sysctl failed: %s\n", strerror(errno
));
762 buffer
= (char*)malloc(buflen
);
764 log_error("malloc failed: %s\n", strerror(errno
));
765 if (sysctl(mib
, 4, buffer
, &buflen
, NULL
, 0) != 0)
766 log_error("sysctl failed: %s\n", strerror(errno
));
767 while (buflen
> 0 && buffer
[buflen
-1] != '/')
769 path
.assign(buffer
, buflen
);
773 #elif defined(__APPLE__)
774 std::string
proc_self_dirname()
778 while (_NSGetExecutablePath(path
, &buflen
) != 0)
779 path
= (char *) realloc((void *) path
, buflen
);
780 while (buflen
> 0 && path
[buflen
-1] != '/')
782 return std::string(path
, buflen
);
784 #elif defined(_WIN32)
785 std::string
proc_self_dirname()
789 char longpath
[MAX_PATH
+ 1];
790 char shortpath
[MAX_PATH
+ 1];
792 WCHAR longpath
[MAX_PATH
+ 1];
793 TCHAR shortpath
[MAX_PATH
+ 1];
795 if (!GetModuleFileName(0, longpath
, MAX_PATH
+1))
796 log_error("GetModuleFileName() failed.\n");
797 if (!GetShortPathName(longpath
, shortpath
, MAX_PATH
+1))
798 log_error("GetShortPathName() failed.\n");
799 while (shortpath
[i
] != 0)
801 while (i
> 0 && shortpath
[i
-1] != '/' && shortpath
[i
-1] != '\\')
804 for (i
= 0; shortpath
[i
]; i
++)
805 path
+= char(shortpath
[i
]);
808 #elif defined(EMSCRIPTEN)
809 std::string
proc_self_dirname()
814 #error "Don't know how to determine process executable base path!"
818 std::string
proc_share_dirname()
823 std::string
proc_share_dirname()
825 std::string proc_self_path
= proc_self_dirname();
826 # if defined(_WIN32) && !defined(YOSYS_WIN32_UNIX_DIR)
827 std::string proc_share_path
= proc_self_path
+ "share\\";
828 if (check_file_exists(proc_share_path
, true))
829 return proc_share_path
;
830 proc_share_path
= proc_self_path
+ "..\\share\\";
831 if (check_file_exists(proc_share_path
, true))
832 return proc_share_path
;
834 std::string proc_share_path
= proc_self_path
+ "share/";
835 if (check_file_exists(proc_share_path
, true))
836 return proc_share_path
;
837 proc_share_path
= proc_self_path
+ "../share/yosys/";
838 if (check_file_exists(proc_share_path
, true))
839 return proc_share_path
;
841 proc_share_path
= YOSYS_DATDIR
"/";
842 if (check_file_exists(proc_share_path
, true))
843 return proc_share_path
;
846 log_error("proc_share_dirname: unable to determine share/ directory!\n");
850 bool fgetline(FILE *f
, std::string
&buffer
)
855 if (fgets(block
, 4096, f
) == NULL
)
858 if (buffer
.size() > 0 && (buffer
[buffer
.size()-1] == '\n' || buffer
[buffer
.size()-1] == '\r')) {
859 while (buffer
.size() > 0 && (buffer
[buffer
.size()-1] == '\n' || buffer
[buffer
.size()-1] == '\r'))
860 buffer
.resize(buffer
.size()-1);
866 static void handle_label(std::string
&command
, bool &from_to_active
, const std::string
&run_from
, const std::string
&run_to
)
871 while (pos
< GetSize(command
) && (command
[pos
] == ' ' || command
[pos
] == '\t'))
874 if (pos
< GetSize(command
) && command
[pos
] == '#')
877 while (pos
< GetSize(command
) && command
[pos
] != ' ' && command
[pos
] != '\t' && command
[pos
] != '\r' && command
[pos
] != '\n')
878 label
+= command
[pos
++];
880 if (GetSize(label
) > 1 && label
.back() == ':')
882 label
= label
.substr(0, GetSize(label
)-1);
883 command
= command
.substr(pos
);
885 if (label
== run_from
)
886 from_to_active
= true;
887 else if (label
== run_to
|| (run_from
== run_to
&& !run_from
.empty()))
888 from_to_active
= false;
892 void run_frontend(std::string filename
, std::string command
, std::string
*backend_command
, std::string
*from_to_label
, RTLIL::Design
*design
)
894 if (design
== nullptr)
895 design
= yosys_design
;
897 if (command
== "auto") {
898 std::string filename_trim
= filename
;
899 if (filename_trim
.size() > 3 && filename_trim
.compare(filename_trim
.size()-3, std::string::npos
, ".gz") == 0)
900 filename_trim
.erase(filename_trim
.size()-3);
901 if (filename_trim
.size() > 2 && filename_trim
.compare(filename_trim
.size()-2, std::string::npos
, ".v") == 0)
903 else if (filename_trim
.size() > 2 && filename_trim
.compare(filename_trim
.size()-3, std::string::npos
, ".sv") == 0)
904 command
= "verilog -sv";
905 else if (filename_trim
.size() > 3 && filename_trim
.compare(filename_trim
.size()-4, std::string::npos
, ".vhd") == 0)
907 else if (filename_trim
.size() > 4 && filename_trim
.compare(filename_trim
.size()-5, std::string::npos
, ".blif") == 0)
909 else if (filename_trim
.size() > 5 && filename_trim
.compare(filename_trim
.size()-6, std::string::npos
, ".eblif") == 0)
911 else if (filename_trim
.size() > 4 && filename_trim
.compare(filename_trim
.size()-5, std::string::npos
, ".json") == 0)
913 else if (filename_trim
.size() > 3 && filename_trim
.compare(filename_trim
.size()-3, std::string::npos
, ".il") == 0)
915 else if (filename_trim
.size() > 3 && filename_trim
.compare(filename_trim
.size()-3, std::string::npos
, ".ys") == 0)
917 else if (filename_trim
.size() > 3 && filename_trim
.compare(filename_trim
.size()-4, std::string::npos
, ".tcl") == 0)
919 else if (filename
== "-")
922 log_error("Can't guess frontend for input file `%s' (missing -f option)!\n", filename
.c_str());
925 if (command
== "script")
927 std::string run_from
, run_to
;
928 bool from_to_active
= true;
930 if (from_to_label
!= NULL
) {
931 size_t pos
= from_to_label
->find(':');
932 if (pos
== std::string::npos
) {
933 run_from
= *from_to_label
;
934 run_to
= *from_to_label
;
936 run_from
= from_to_label
->substr(0, pos
);
937 run_to
= from_to_label
->substr(pos
+1);
939 from_to_active
= run_from
.empty();
942 log("\n-- Executing script file `%s' --\n", filename
.c_str());
946 if (filename
!= "-") {
947 f
= fopen(filename
.c_str(), "r");
948 yosys_input_files
.insert(filename
);
952 log_error("Can't open script file `%s' for reading: %s\n", filename
.c_str(), strerror(errno
));
954 FILE *backup_script_file
= Frontend::current_script_file
;
955 Frontend::current_script_file
= f
;
959 while (fgetline(f
, command
)) {
960 while (!command
.empty() && command
[command
.size()-1] == '\\') {
961 std::string next_line
;
962 if (!fgetline(f
, next_line
))
964 command
.resize(command
.size()-1);
965 command
+= next_line
;
967 handle_label(command
, from_to_active
, run_from
, run_to
);
968 if (from_to_active
) {
969 Pass::call(design
, command
);
974 if (!command
.empty()) {
975 handle_label(command
, from_to_active
, run_from
, run_to
);
976 if (from_to_active
) {
977 Pass::call(design
, command
);
983 Frontend::current_script_file
= backup_script_file
;
987 Frontend::current_script_file
= backup_script_file
;
992 if (backend_command
!= NULL
&& *backend_command
== "auto")
993 *backend_command
= "";
998 if (filename
== "-") {
999 log("\n-- Parsing stdin using frontend `%s' --\n", command
.c_str());
1001 log("\n-- Parsing `%s' using frontend `%s' --\n", filename
.c_str(), command
.c_str());
1004 if (command
== "tcl")
1005 Pass::call(design
, vector
<string
>({command
, filename
}));
1007 Frontend::frontend_call(design
, NULL
, filename
, command
);
1011 void run_frontend(std::string filename
, std::string command
, RTLIL::Design
*design
)
1013 run_frontend(filename
, command
, nullptr, nullptr, design
);
1016 void run_pass(std::string command
, RTLIL::Design
*design
)
1018 if (design
== nullptr)
1019 design
= yosys_design
;
1021 log("\n-- Running command `%s' --\n", command
.c_str());
1023 Pass::call(design
, command
);
1026 void run_backend(std::string filename
, std::string command
, RTLIL::Design
*design
)
1028 if (design
== nullptr)
1029 design
= yosys_design
;
1031 if (command
== "auto") {
1032 if (filename
.size() > 2 && filename
.compare(filename
.size()-2, std::string::npos
, ".v") == 0)
1033 command
= "verilog";
1034 else if (filename
.size() > 3 && filename
.compare(filename
.size()-3, std::string::npos
, ".il") == 0)
1036 else if (filename
.size() > 4 && filename
.compare(filename
.size()-4, std::string::npos
, ".aig") == 0)
1038 else if (filename
.size() > 5 && filename
.compare(filename
.size()-5, std::string::npos
, ".blif") == 0)
1040 else if (filename
.size() > 5 && filename
.compare(filename
.size()-5, std::string::npos
, ".edif") == 0)
1042 else if (filename
.size() > 5 && filename
.compare(filename
.size()-5, std::string::npos
, ".json") == 0)
1044 else if (filename
== "-")
1046 else if (filename
.empty())
1049 log_error("Can't guess backend for output file `%s' (missing -b option)!\n", filename
.c_str());
1052 if (filename
.empty())
1055 if (filename
== "-") {
1056 log("\n-- Writing to stdout using backend `%s' --\n", command
.c_str());
1058 log("\n-- Writing to `%s' using backend `%s' --\n", filename
.c_str(), command
.c_str());
1061 Backend::backend_call(design
, NULL
, filename
, command
);
1064 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1065 static char *readline_cmd_generator(const char *text
, int state
)
1067 static std::map
<std::string
, Pass
*>::iterator it
;
1071 it
= pass_register
.begin();
1075 for (; it
!= pass_register
.end(); it
++) {
1076 if (it
->first
.compare(0, len
, text
) == 0)
1077 return strdup((it
++)->first
.c_str());
1082 static char *readline_obj_generator(const char *text
, int state
)
1084 static std::vector
<char*> obj_names
;
1092 RTLIL::Design
*design
= yosys_get_design();
1093 int len
= strlen(text
);
1095 if (design
->selected_active_module
.empty())
1097 for (auto &it
: design
->modules_
)
1098 if (RTLIL::unescape_id(it
.first
).compare(0, len
, text
) == 0)
1099 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1102 if (design
->modules_
.count(design
->selected_active_module
) > 0)
1104 RTLIL::Module
*module
= design
->modules_
.at(design
->selected_active_module
);
1106 for (auto &it
: module
->wires_
)
1107 if (RTLIL::unescape_id(it
.first
).compare(0, len
, text
) == 0)
1108 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1110 for (auto &it
: module
->memories
)
1111 if (RTLIL::unescape_id(it
.first
).compare(0, len
, text
) == 0)
1112 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1114 for (auto &it
: module
->cells_
)
1115 if (RTLIL::unescape_id(it
.first
).compare(0, len
, text
) == 0)
1116 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1118 for (auto &it
: module
->processes
)
1119 if (RTLIL::unescape_id(it
.first
).compare(0, len
, text
) == 0)
1120 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1123 std::sort(obj_names
.begin(), obj_names
.end());
1126 if (idx
< obj_names
.size())
1127 return strdup(obj_names
[idx
++]);
1134 static char **readline_completion(const char *text
, int start
, int)
1137 return rl_completion_matches(text
, readline_cmd_generator
);
1138 if (strncmp(rl_line_buffer
, "read_", 5) && strncmp(rl_line_buffer
, "write_", 6))
1139 return rl_completion_matches(text
, readline_obj_generator
);
1144 void shell(RTLIL::Design
*design
)
1146 static int recursion_counter
= 0;
1148 recursion_counter
++;
1149 log_cmd_error_throw
= true;
1151 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1152 rl_readline_name
= (char*)"yosys";
1153 rl_attempted_completion_function
= readline_completion
;
1154 rl_basic_word_break_characters
= (char*)" \t\n";
1157 char *command
= NULL
;
1158 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1159 while ((command
= readline(create_prompt(design
, recursion_counter
))) != NULL
)
1162 char command_buffer
[4096];
1165 fputs(create_prompt(design
, recursion_counter
), stdout
);
1167 if ((command
= fgets(command_buffer
, 4096, stdin
)) == NULL
)
1170 if (command
[strspn(command
, " \t\r\n")] == 0)
1172 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1173 add_history(command
);
1176 char *p
= command
+ strspn(command
, " \t\r\n");
1177 if (!strncmp(p
, "exit", 4)) {
1179 p
+= strspn(p
, " \t\r\n");
1185 log_assert(design
->selection_stack
.size() == 1);
1186 Pass::call(design
, command
);
1187 } catch (log_cmd_error_exception
) {
1188 while (design
->selection_stack
.size() > 1)
1189 design
->selection_stack
.pop_back();
1194 if (command
== NULL
)
1197 recursion_counter
--;
1198 log_cmd_error_throw
= false;
1201 struct ShellPass
: public Pass
{
1202 ShellPass() : Pass("shell", "enter interactive command mode") { }
1203 void help() YS_OVERRIDE
{
1207 log("This command enters the interactive command mode. This can be useful\n");
1208 log("in a script to interrupt the script at a certain point and allow for\n");
1209 log("interactive inspection or manual synthesis of the design at this point.\n");
1211 log("The command prompt of the interactive shell indicates the current\n");
1212 log("selection (see 'help select'):\n");
1215 log(" the entire design is selected\n");
1218 log(" only part of the design is selected\n");
1220 log(" yosys [modname]>\n");
1221 log(" the entire module 'modname' is selected using 'select -module modname'\n");
1223 log(" yosys [modname]*>\n");
1224 log(" only part of current module 'modname' is selected\n");
1226 log("When in interactive shell, some errors (e.g. invalid command arguments)\n");
1227 log("do not terminate yosys but return to the command prompt.\n");
1229 log("This command is the default action if nothing else has been specified\n");
1230 log("on the command line.\n");
1232 log("Press Ctrl-D or type 'exit' to leave the interactive shell.\n");
1235 void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) YS_OVERRIDE
{
1236 extra_args(args
, 1, design
, false);
1241 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1242 struct HistoryPass
: public Pass
{
1243 HistoryPass() : Pass("history", "show last interactive commands") { }
1244 void help() YS_OVERRIDE
{
1248 log("This command prints all commands in the shell history buffer. This are\n");
1249 log("all commands executed in an interactive session, but not the commands\n");
1250 log("from executed scripts.\n");
1253 void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) YS_OVERRIDE
{
1254 extra_args(args
, 1, design
, false);
1255 #ifdef YOSYS_ENABLE_READLINE
1256 for(HIST_ENTRY
**list
= history_list(); *list
!= NULL
; list
++)
1257 log("%s\n", (*list
)->line
);
1259 for (int i
= where_history(); history_get(i
); i
++)
1260 log("%s\n", history_get(i
)->line
);
1266 struct ScriptCmdPass
: public Pass
{
1267 ScriptCmdPass() : Pass("script", "execute commands from file or wire") { }
1268 void help() YS_OVERRIDE
{
1269 // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
1271 log(" script <filename> [<from_label>:<to_label>]\n");
1272 log(" script -scriptwire [selection]\n");
1274 log("This command executes the yosys commands in the specified file (default\n");
1275 log("behaviour), or commands embedded in the constant text value connected to the\n");
1276 log("selected wires.\n");
1278 log("In the default (file) case, the 2nd argument can be used to only execute the\n");
1279 log("section of the file between the specified labels. An empty from label is\n");
1280 log("synonymous with the beginning of the file and an empty to label is synonymous\n");
1281 log("with the end of the file.\n");
1283 log("If only one label is specified (without ':') then only the block\n");
1284 log("marked with that label (until the next label) is executed.\n");
1286 log("In \"-scriptwire\" mode, the commands on the selected wire(s) will be executed\n");
1287 log("in the scope of (and thus, relative to) the wires' owning module(s). This\n");
1288 log("'-module' mode can be exited by using the 'cd' command.\n");
1291 void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) YS_OVERRIDE
1293 bool scriptwire
= false;
1296 for (argidx
= 1; argidx
< args
.size(); argidx
++) {
1297 if (args
[argidx
] == "-scriptwire") {
1304 extra_args(args
, argidx
, design
);
1306 for (auto mod
: design
->selected_modules())
1307 for (auto &c
: mod
->connections()) {
1308 if (!c
.first
.is_wire())
1310 auto w
= c
.first
.as_wire();
1311 if (!mod
->selected(w
))
1313 if (!c
.second
.is_fully_const())
1314 log_error("RHS of selected wire %s.%s is not constant.\n", log_id(mod
), log_id(w
));
1315 auto v
= c
.second
.as_const();
1316 Pass::call_on_module(design
, mod
, v
.decode_string());
1319 else if (args
.size() < 2)
1320 log_cmd_error("Missing script file.\n");
1321 else if (args
.size() == 2)
1322 run_frontend(args
[1], "script", design
);
1323 else if (args
.size() == 3)
1324 run_frontend(args
[1], "script", NULL
, &args
[2], design
);
1326 extra_args(args
, 2, design
, false);