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 - 2018 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;
513 // if there are already IdString objects then we have a global initialization order bug
515 log_assert(empty_id
.index_
== 0);
516 IdString::get_reference(empty_id
.index_
);
519 PyImport_AppendInittab((char*)"libyosys", INIT_MODULE
);
521 PyRun_SimpleString("import sys");
524 Pass::init_register();
525 yosys_design
= new RTLIL::Design
;
526 yosys_celltypes
.setup();
530 bool yosys_already_setup()
532 return already_setup
;
535 bool already_shutdown
= false;
537 void yosys_shutdown()
541 already_shutdown
= true;
547 for (auto f
: log_files
)
553 Pass::done_register();
554 yosys_celltypes
.clear();
556 #ifdef YOSYS_ENABLE_TCL
557 if (yosys_tcl_interp
!= NULL
) {
558 Tcl_DeleteInterp(yosys_tcl_interp
);
560 yosys_tcl_interp
= NULL
;
564 #ifdef YOSYS_ENABLE_PLUGINS
565 for (auto &it
: loaded_plugins
)
568 loaded_plugins
.clear();
570 loaded_python_plugins
.clear();
572 loaded_plugin_aliases
.clear();
580 IdString::put_reference(empty_id
.index_
);
583 RTLIL::IdString
new_id(std::string file
, int line
, std::string func
)
586 size_t pos
= file
.find_last_of("/\\");
588 size_t pos
= file
.find_last_of('/');
590 if (pos
!= std::string::npos
)
591 file
= file
.substr(pos
+1);
593 pos
= func
.find_last_of(':');
594 if (pos
!= std::string::npos
)
595 func
= func
.substr(pos
+1);
597 return stringf("$auto$%s:%d:%s$%d", file
.c_str(), line
, func
.c_str(), autoidx
++);
600 RTLIL::Design
*yosys_get_design()
605 const char *create_prompt(RTLIL::Design
*design
, int recursion_counter
)
607 static char buffer
[100];
608 std::string str
= "\n";
609 if (recursion_counter
> 1)
610 str
+= stringf("(%d) ", recursion_counter
);
612 if (!design
->selected_active_module
.empty())
613 str
+= stringf(" [%s]", RTLIL::unescape_id(design
->selected_active_module
).c_str());
614 if (!design
->selection_stack
.empty() && !design
->selection_stack
.back().full_selection
) {
615 if (design
->selected_active_module
.empty())
617 else if (design
->selection_stack
.back().selected_modules
.size() != 1 || design
->selection_stack
.back().selected_members
.size() != 0 ||
618 design
->selection_stack
.back().selected_modules
.count(design
->selected_active_module
) == 0)
621 snprintf(buffer
, 100, "%s> ", str
.c_str());
625 std::vector
<std::string
> glob_filename(const std::string
&filename_pattern
)
627 std::vector
<std::string
> results
;
629 #if defined(_WIN32) || !defined(YOSYS_ENABLE_GLOB)
630 results
.push_back(filename_pattern
);
634 int err
= glob(filename_pattern
.c_str(), 0, NULL
, &globbuf
);
637 for (size_t i
= 0; i
< globbuf
.gl_pathc
; i
++)
638 results
.push_back(globbuf
.gl_pathv
[i
]);
641 results
.push_back(filename_pattern
);
648 void rewrite_filename(std::string
&filename
)
650 if (filename
.substr(0, 1) == "\"" && filename
.substr(GetSize(filename
)-1) == "\"")
651 filename
= filename
.substr(1, GetSize(filename
)-2);
652 if (filename
.substr(0, 2) == "+/")
653 filename
= proc_share_dirname() + filename
.substr(2);
656 #ifdef YOSYS_ENABLE_TCL
657 static int tcl_yosys_cmd(ClientData
, Tcl_Interp
*interp
, int argc
, const char *argv
[])
659 std::vector
<std::string
> args
;
660 for (int i
= 1; i
< argc
; i
++)
661 args
.push_back(argv
[i
]);
663 if (args
.size() >= 1 && args
[0] == "-import") {
664 for (auto &it
: pass_register
) {
665 std::string tcl_command_name
= it
.first
;
666 if (tcl_command_name
== "proc")
667 tcl_command_name
= "procs";
668 else if (tcl_command_name
== "rename")
669 tcl_command_name
= "renames";
671 if (Tcl_GetCommandInfo(interp
, tcl_command_name
.c_str(), &info
) != 0) {
672 log("[TCL: yosys -import] Command name collision: found pre-existing command `%s' -> skip.\n", it
.first
.c_str());
674 std::string tcl_script
= stringf("proc %s args { yosys %s {*}$args }", tcl_command_name
.c_str(), it
.first
.c_str());
675 Tcl_Eval(interp
, tcl_script
.c_str());
681 if (args
.size() == 1) {
682 Pass::call(yosys_get_design(), args
[0]);
686 Pass::call(yosys_get_design(), args
);
690 extern Tcl_Interp
*yosys_get_tcl_interp()
692 if (yosys_tcl_interp
== NULL
) {
693 yosys_tcl_interp
= Tcl_CreateInterp();
694 Tcl_CreateCommand(yosys_tcl_interp
, "yosys", tcl_yosys_cmd
, NULL
, NULL
);
696 return yosys_tcl_interp
;
699 struct TclPass
: public Pass
{
700 TclPass() : Pass("tcl", "execute a TCL script file") { }
701 void help() YS_OVERRIDE
{
702 // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
704 log(" tcl <filename> [args]\n");
706 log("This command executes the tcl commands in the specified file.\n");
707 log("Use 'yosys cmd' to run the yosys command 'cmd' from tcl.\n");
709 log("The tcl command 'yosys -import' can be used to import all yosys\n");
710 log("commands directly as tcl commands to the tcl shell. Yosys commands\n");
711 log("'proc' and 'rename' are wrapped to tcl commands 'procs' and 'renames'\n");
712 log("in order to avoid a name collision with the built in commands.\n");
714 log("If any arguments are specified, these arguments are provided to the script via\n");
715 log("the standard $argc and $argv variables.\n");
718 void execute(std::vector
<std::string
> args
, RTLIL::Design
*) YS_OVERRIDE
{
720 log_cmd_error("Missing script file.\n");
722 std::vector
<Tcl_Obj
*> script_args
;
723 for (auto it
= args
.begin() + 2; it
!= args
.end(); ++it
)
724 script_args
.push_back(Tcl_NewStringObj((*it
).c_str(), (*it
).size()));
726 Tcl_Interp
*interp
= yosys_get_tcl_interp();
727 Tcl_ObjSetVar2(interp
, Tcl_NewStringObj("argc", 4), NULL
, Tcl_NewIntObj(script_args
.size()), 0);
728 Tcl_ObjSetVar2(interp
, Tcl_NewStringObj("argv", 4), NULL
, Tcl_NewListObj(script_args
.size(), script_args
.data()), 0);
729 Tcl_ObjSetVar2(interp
, Tcl_NewStringObj("argv0", 5), NULL
, Tcl_NewStringObj(args
[1].c_str(), args
[1].size()), 0);
730 if (Tcl_EvalFile(interp
, args
[1].c_str()) != TCL_OK
)
731 log_cmd_error("TCL interpreter returned an error: %s\n", Tcl_GetStringResult(interp
));
736 #if defined(__linux__) || defined(__CYGWIN__)
737 std::string
proc_self_dirname()
740 ssize_t buflen
= readlink("/proc/self/exe", path
, sizeof(path
));
742 log_error("readlink(\"/proc/self/exe\") failed: %s\n", strerror(errno
));
744 while (buflen
> 0 && path
[buflen
-1] != '/')
746 return std::string(path
, buflen
);
748 #elif defined(__FreeBSD__)
749 std::string
proc_self_dirname()
751 int mib
[4] = {CTL_KERN
, KERN_PROC
, KERN_PROC_PATHNAME
, -1};
755 if (sysctl(mib
, 4, NULL
, &buflen
, NULL
, 0) != 0)
756 log_error("sysctl failed: %s\n", strerror(errno
));
757 buffer
= (char*)malloc(buflen
);
759 log_error("malloc failed: %s\n", strerror(errno
));
760 if (sysctl(mib
, 4, buffer
, &buflen
, NULL
, 0) != 0)
761 log_error("sysctl failed: %s\n", strerror(errno
));
762 while (buflen
> 0 && buffer
[buflen
-1] != '/')
764 path
.assign(buffer
, buflen
);
768 #elif defined(__APPLE__)
769 std::string
proc_self_dirname()
773 while (_NSGetExecutablePath(path
, &buflen
) != 0)
774 path
= (char *) realloc((void *) path
, buflen
);
775 while (buflen
> 0 && path
[buflen
-1] != '/')
777 return std::string(path
, buflen
);
779 #elif defined(_WIN32)
780 std::string
proc_self_dirname()
784 char longpath
[MAX_PATH
+ 1];
785 char shortpath
[MAX_PATH
+ 1];
787 WCHAR longpath
[MAX_PATH
+ 1];
788 TCHAR shortpath
[MAX_PATH
+ 1];
790 if (!GetModuleFileName(0, longpath
, MAX_PATH
+1))
791 log_error("GetModuleFileName() failed.\n");
792 if (!GetShortPathName(longpath
, shortpath
, MAX_PATH
+1))
793 log_error("GetShortPathName() failed.\n");
794 while (shortpath
[i
] != 0)
796 while (i
> 0 && shortpath
[i
-1] != '/' && shortpath
[i
-1] != '\\')
799 for (i
= 0; shortpath
[i
]; i
++)
800 path
+= char(shortpath
[i
]);
803 #elif defined(EMSCRIPTEN)
804 std::string
proc_self_dirname()
809 #error "Don't know how to determine process executable base path!"
813 std::string
proc_share_dirname()
818 std::string
proc_share_dirname()
820 std::string proc_self_path
= proc_self_dirname();
821 # if defined(_WIN32) && !defined(YOSYS_WIN32_UNIX_DIR)
822 std::string proc_share_path
= proc_self_path
+ "share\\";
823 if (check_file_exists(proc_share_path
, true))
824 return proc_share_path
;
825 proc_share_path
= proc_self_path
+ "..\\share\\";
826 if (check_file_exists(proc_share_path
, true))
827 return proc_share_path
;
829 std::string proc_share_path
= proc_self_path
+ "share/";
830 if (check_file_exists(proc_share_path
, true))
831 return proc_share_path
;
832 proc_share_path
= proc_self_path
+ "../share/yosys/";
833 if (check_file_exists(proc_share_path
, true))
834 return proc_share_path
;
836 proc_share_path
= YOSYS_DATDIR
"/";
837 if (check_file_exists(proc_share_path
, true))
838 return proc_share_path
;
841 log_error("proc_share_dirname: unable to determine share/ directory!\n");
845 bool fgetline(FILE *f
, std::string
&buffer
)
850 if (fgets(block
, 4096, f
) == NULL
)
853 if (buffer
.size() > 0 && (buffer
[buffer
.size()-1] == '\n' || buffer
[buffer
.size()-1] == '\r')) {
854 while (buffer
.size() > 0 && (buffer
[buffer
.size()-1] == '\n' || buffer
[buffer
.size()-1] == '\r'))
855 buffer
.resize(buffer
.size()-1);
861 static void handle_label(std::string
&command
, bool &from_to_active
, const std::string
&run_from
, const std::string
&run_to
)
866 while (pos
< GetSize(command
) && (command
[pos
] == ' ' || command
[pos
] == '\t'))
869 if (pos
< GetSize(command
) && command
[pos
] == '#')
872 while (pos
< GetSize(command
) && command
[pos
] != ' ' && command
[pos
] != '\t' && command
[pos
] != '\r' && command
[pos
] != '\n')
873 label
+= command
[pos
++];
875 if (GetSize(label
) > 1 && label
.back() == ':')
877 label
= label
.substr(0, GetSize(label
)-1);
878 command
= command
.substr(pos
);
880 if (label
== run_from
)
881 from_to_active
= true;
882 else if (label
== run_to
|| (run_from
== run_to
&& !run_from
.empty()))
883 from_to_active
= false;
887 void run_frontend(std::string filename
, std::string command
, std::string
*backend_command
, std::string
*from_to_label
, RTLIL::Design
*design
)
889 if (design
== nullptr)
890 design
= yosys_design
;
892 if (command
== "auto") {
893 if (filename
.size() > 2 && filename
.substr(filename
.size()-2) == ".v")
895 else if (filename
.size() > 2 && filename
.substr(filename
.size()-3) == ".sv")
896 command
= "verilog -sv";
897 else if (filename
.size() > 3 && filename
.substr(filename
.size()-4) == ".vhd")
899 else if (filename
.size() > 4 && filename
.substr(filename
.size()-5) == ".blif")
901 else if (filename
.size() > 5 && filename
.substr(filename
.size()-6) == ".eblif")
903 else if (filename
.size() > 4 && filename
.substr(filename
.size()-5) == ".json")
905 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".il")
907 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".ys")
909 else if (filename
.size() > 3 && filename
.substr(filename
.size()-4) == ".tcl")
911 else if (filename
== "-")
914 log_error("Can't guess frontend for input file `%s' (missing -f option)!\n", filename
.c_str());
917 if (command
== "script")
919 std::string run_from
, run_to
;
920 bool from_to_active
= true;
922 if (from_to_label
!= NULL
) {
923 size_t pos
= from_to_label
->find(':');
924 if (pos
== std::string::npos
) {
925 run_from
= *from_to_label
;
926 run_to
= *from_to_label
;
928 run_from
= from_to_label
->substr(0, pos
);
929 run_to
= from_to_label
->substr(pos
+1);
931 from_to_active
= run_from
.empty();
934 log("\n-- Executing script file `%s' --\n", filename
.c_str());
938 if (filename
!= "-") {
939 f
= fopen(filename
.c_str(), "r");
940 yosys_input_files
.insert(filename
);
944 log_error("Can't open script file `%s' for reading: %s\n", filename
.c_str(), strerror(errno
));
946 FILE *backup_script_file
= Frontend::current_script_file
;
947 Frontend::current_script_file
= f
;
951 while (fgetline(f
, command
)) {
952 while (!command
.empty() && command
[command
.size()-1] == '\\') {
953 std::string next_line
;
954 if (!fgetline(f
, next_line
))
956 command
.resize(command
.size()-1);
957 command
+= next_line
;
959 handle_label(command
, from_to_active
, run_from
, run_to
);
961 Pass::call(design
, command
);
964 if (!command
.empty()) {
965 handle_label(command
, from_to_active
, run_from
, run_to
);
967 Pass::call(design
, command
);
971 Frontend::current_script_file
= backup_script_file
;
975 Frontend::current_script_file
= backup_script_file
;
980 if (backend_command
!= NULL
&& *backend_command
== "auto")
981 *backend_command
= "";
986 if (filename
== "-") {
987 log("\n-- Parsing stdin using frontend `%s' --\n", command
.c_str());
989 log("\n-- Parsing `%s' using frontend `%s' --\n", filename
.c_str(), command
.c_str());
992 if (command
== "tcl")
993 Pass::call(design
, vector
<string
>({command
, filename
}));
995 Frontend::frontend_call(design
, NULL
, filename
, command
);
998 void run_frontend(std::string filename
, std::string command
, RTLIL::Design
*design
)
1000 run_frontend(filename
, command
, nullptr, nullptr, design
);
1003 void run_pass(std::string command
, RTLIL::Design
*design
)
1005 if (design
== nullptr)
1006 design
= yosys_design
;
1008 log("\n-- Running command `%s' --\n", command
.c_str());
1010 Pass::call(design
, command
);
1013 void run_backend(std::string filename
, std::string command
, RTLIL::Design
*design
)
1015 if (design
== nullptr)
1016 design
= yosys_design
;
1018 if (command
== "auto") {
1019 if (filename
.size() > 2 && filename
.substr(filename
.size()-2) == ".v")
1020 command
= "verilog";
1021 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".il")
1023 else if (filename
.size() > 4 && filename
.substr(filename
.size()-4) == ".aig")
1025 else if (filename
.size() > 5 && filename
.substr(filename
.size()-5) == ".blif")
1027 else if (filename
.size() > 5 && filename
.substr(filename
.size()-5) == ".edif")
1029 else if (filename
.size() > 5 && filename
.substr(filename
.size()-5) == ".json")
1031 else if (filename
== "-")
1033 else if (filename
.empty())
1036 log_error("Can't guess backend for output file `%s' (missing -b option)!\n", filename
.c_str());
1039 if (filename
.empty())
1042 if (filename
== "-") {
1043 log("\n-- Writing to stdout using backend `%s' --\n", command
.c_str());
1045 log("\n-- Writing to `%s' using backend `%s' --\n", filename
.c_str(), command
.c_str());
1048 Backend::backend_call(design
, NULL
, filename
, command
);
1051 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1052 static char *readline_cmd_generator(const char *text
, int state
)
1054 static std::map
<std::string
, Pass
*>::iterator it
;
1058 it
= pass_register
.begin();
1062 for (; it
!= pass_register
.end(); it
++) {
1063 if (it
->first
.substr(0, len
) == text
)
1064 return strdup((it
++)->first
.c_str());
1069 static char *readline_obj_generator(const char *text
, int state
)
1071 static std::vector
<char*> obj_names
;
1079 RTLIL::Design
*design
= yosys_get_design();
1080 int len
= strlen(text
);
1082 if (design
->selected_active_module
.empty())
1084 for (auto &it
: design
->modules_
)
1085 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
1086 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1089 if (design
->modules_
.count(design
->selected_active_module
) > 0)
1091 RTLIL::Module
*module
= design
->modules_
.at(design
->selected_active_module
);
1093 for (auto &it
: module
->wires_
)
1094 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
1095 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1097 for (auto &it
: module
->memories
)
1098 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
1099 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1101 for (auto &it
: module
->cells_
)
1102 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
1103 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1105 for (auto &it
: module
->processes
)
1106 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
1107 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
1110 std::sort(obj_names
.begin(), obj_names
.end());
1113 if (idx
< obj_names
.size())
1114 return strdup(obj_names
[idx
++]);
1121 static char **readline_completion(const char *text
, int start
, int)
1124 return rl_completion_matches(text
, readline_cmd_generator
);
1125 if (strncmp(rl_line_buffer
, "read_", 5) && strncmp(rl_line_buffer
, "write_", 6))
1126 return rl_completion_matches(text
, readline_obj_generator
);
1131 void shell(RTLIL::Design
*design
)
1133 static int recursion_counter
= 0;
1135 recursion_counter
++;
1136 log_cmd_error_throw
= true;
1138 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1139 rl_readline_name
= (char*)"yosys";
1140 rl_attempted_completion_function
= readline_completion
;
1141 rl_basic_word_break_characters
= (char*)" \t\n";
1144 char *command
= NULL
;
1145 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1146 while ((command
= readline(create_prompt(design
, recursion_counter
))) != NULL
)
1149 char command_buffer
[4096];
1152 fputs(create_prompt(design
, recursion_counter
), stdout
);
1154 if ((command
= fgets(command_buffer
, 4096, stdin
)) == NULL
)
1157 if (command
[strspn(command
, " \t\r\n")] == 0)
1159 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1160 add_history(command
);
1163 char *p
= command
+ strspn(command
, " \t\r\n");
1164 if (!strncmp(p
, "exit", 4)) {
1166 p
+= strspn(p
, " \t\r\n");
1172 log_assert(design
->selection_stack
.size() == 1);
1173 Pass::call(design
, command
);
1174 } catch (log_cmd_error_exception
) {
1175 while (design
->selection_stack
.size() > 1)
1176 design
->selection_stack
.pop_back();
1180 if (command
== NULL
)
1183 recursion_counter
--;
1184 log_cmd_error_throw
= false;
1187 struct ShellPass
: public Pass
{
1188 ShellPass() : Pass("shell", "enter interactive command mode") { }
1189 void help() YS_OVERRIDE
{
1193 log("This command enters the interactive command mode. This can be useful\n");
1194 log("in a script to interrupt the script at a certain point and allow for\n");
1195 log("interactive inspection or manual synthesis of the design at this point.\n");
1197 log("The command prompt of the interactive shell indicates the current\n");
1198 log("selection (see 'help select'):\n");
1201 log(" the entire design is selected\n");
1204 log(" only part of the design is selected\n");
1206 log(" yosys [modname]>\n");
1207 log(" the entire module 'modname' is selected using 'select -module modname'\n");
1209 log(" yosys [modname]*>\n");
1210 log(" only part of current module 'modname' is selected\n");
1212 log("When in interactive shell, some errors (e.g. invalid command arguments)\n");
1213 log("do not terminate yosys but return to the command prompt.\n");
1215 log("This command is the default action if nothing else has been specified\n");
1216 log("on the command line.\n");
1218 log("Press Ctrl-D or type 'exit' to leave the interactive shell.\n");
1221 void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) YS_OVERRIDE
{
1222 extra_args(args
, 1, design
, false);
1227 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1228 struct HistoryPass
: public Pass
{
1229 HistoryPass() : Pass("history", "show last interactive commands") { }
1230 void help() YS_OVERRIDE
{
1234 log("This command prints all commands in the shell history buffer. This are\n");
1235 log("all commands executed in an interactive session, but not the commands\n");
1236 log("from executed scripts.\n");
1239 void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) YS_OVERRIDE
{
1240 extra_args(args
, 1, design
, false);
1241 #ifdef YOSYS_ENABLE_READLINE
1242 for(HIST_ENTRY
**list
= history_list(); *list
!= NULL
; list
++)
1243 log("%s\n", (*list
)->line
);
1245 for (int i
= where_history(); history_get(i
); i
++)
1246 log("%s\n", history_get(i
)->line
);
1252 struct ScriptCmdPass
: public Pass
{
1253 ScriptCmdPass() : Pass("script", "execute commands from script file") { }
1254 void help() YS_OVERRIDE
{
1256 log(" script <filename> [<from_label>:<to_label>]\n");
1258 log("This command executes the yosys commands in the specified file.\n");
1260 log("The 2nd argument can be used to only execute the section of the\n");
1261 log("file between the specified labels. An empty from label is synonymous\n");
1262 log("for the beginning of the file and an empty to label is synonymous\n");
1263 log("for the end of the file.\n");
1265 log("If only one label is specified (without ':') then only the block\n");
1266 log("marked with that label (until the next label) is executed.\n");
1269 void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) YS_OVERRIDE
{
1270 if (args
.size() < 2)
1271 log_cmd_error("Missing script file.\n");
1272 else if (args
.size() == 2)
1273 run_frontend(args
[1], "script", design
);
1274 else if (args
.size() == 3)
1275 run_frontend(args
[1], "script", NULL
, &args
[2], design
);
1277 extra_args(args
, 2, design
, false);