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"
22 #ifdef YOSYS_ENABLE_READLINE
23 # include <readline/readline.h>
24 # include <readline/history.h>
27 #ifdef YOSYS_ENABLE_PLUGINS
33 #elif defined(__APPLE__)
34 # include <mach-o/dyld.h>
38 # include <sys/types.h>
39 # include <sys/stat.h>
48 const char *yosys_version_str
= "Windows";
52 RTLIL::Design
*yosys_design
= NULL
;
54 #ifdef YOSYS_ENABLE_TCL
55 Tcl_Interp
*yosys_tcl_interp
= NULL
;
58 std::string
stringf(const char *fmt
, ...)
64 string
= vstringf(fmt
, ap
);
70 std::string
vstringf(const char *fmt
, va_list ap
)
80 str
= (char*)realloc(str
, sz
);
81 rc
= vsnprintf(str
, sz
, fmt
, apc
);
83 if (rc
>= 0 && rc
< sz
)
88 if (vasprintf(&str
, fmt
, ap
) < 0)
100 std::string
next_token(std::string
&text
, const char *sep
)
102 size_t pos_begin
= text
.find_first_not_of(sep
);
104 if (pos_begin
== std::string::npos
)
105 pos_begin
= text
.size();
107 size_t pos_end
= text
.find_first_of(sep
, pos_begin
);
109 if (pos_end
== std::string::npos
)
110 pos_end
= text
.size();
112 std::string token
= text
.substr(pos_begin
, pos_end
-pos_begin
);
113 text
= text
.substr(pos_end
);
117 // this is very similar to fnmatch(). the exact rules used by this
120 // ? matches any character except
121 // * matches any sequence of characters
122 // [...] matches any of the characters in the list
123 // [!..] matches any of the characters not in the list
125 // a backslash may be used to escape the next characters in the
126 // pattern. each special character can also simply match itself.
128 bool patmatch(const char *pattern
, const char *string
)
133 if (*pattern
== '\\') {
134 if (pattern
[1] == string
[0] && patmatch(pattern
+2, string
+1))
138 if (*pattern
== '?') {
141 return patmatch(pattern
+1, string
+1);
144 if (*pattern
== '*') {
146 if (patmatch(pattern
+1, string
++))
149 return pattern
[1] == 0;
152 if (*pattern
== '[') {
153 bool found_match
= false;
154 bool inverted_list
= pattern
[1] == '!';
155 const char *p
= pattern
+ (inverted_list
? 1 : 0);
159 if (found_match
!= inverted_list
&& patmatch(p
+1, string
+1))
173 if (*pattern
== *string
)
174 return patmatch(pattern
+1, string
+1);
179 int run_command(const std::string
&command
, std::function
<void(const std::string
&)> process_line
)
182 return system(command
.c_str());
184 FILE *f
= popen(command
.c_str(), "r");
190 while (fgets(logbuf
, 128, f
) != NULL
) {
192 if (!line
.empty() && line
.back() == '\n')
193 process_line(line
), line
.clear();
204 return WEXITSTATUS(ret
);
208 std::string
make_temp_file(std::string template_str
)
211 if (template_str
.rfind("/tmp/", 0) == 0) {
212 char path
[MAX_PATH
+1];
213 GetTempPath(MAX_PATH
+1, path
);
214 template_str
= stringf("%s\\%s", path
, template_str
.c_str() + 5);
217 size_t pos
= template_str
.rfind("XXXXXX");
218 log_assert(pos
!= std::string::npos
);
221 for (int i
= 0; i
< 6; i
++) {
222 static std::string y
= "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
223 static uint32_t x
= 314159265 ^ time(NULL
);
224 x
^= x
<< 13, x
^= x
>> 17, x
^= x
<< 5;
225 template_str
[pos
+i
] = y
[x
% y
.size()];
227 if (access(template_str
.c_str(), F_OK
) != 0)
231 size_t pos
= template_str
.rfind("XXXXXX");
232 log_assert(pos
!= std::string::npos
);
234 int suffixlen
= GetSize(template_str
) - pos
- 6;
236 char *p
= strdup(template_str
.c_str());
237 close(mkstemps(p
, suffixlen
));
245 std::string
make_temp_dir(std::string template_str
)
248 template_str
= make_temp_file(template_str
);
249 mkdir(template_str
.c_str());
252 size_t pos
= template_str
.rfind("XXXXXX");
253 log_assert(pos
!= std::string::npos
);
255 int suffixlen
= GetSize(template_str
) - pos
- 6;
256 log_assert(suffixlen
== 0);
258 char *p
= strdup(template_str
.c_str());
260 log_assert(p
!= NULL
);
268 void remove_directory(std::string dirname
)
271 run_command(stringf("rmdir /s /q \"%s\"", dirname
.c_str()));
274 struct dirent
**namelist
;
275 int n
= scandir(dirname
.c_str(), &namelist
, nullptr, alphasort
);
277 for (int i
= 0; i
< n
; i
++) {
278 if (strcmp(namelist
[i
]->d_name
, ".") && strcmp(namelist
[i
]->d_name
, "..")) {
279 std::string buffer
= stringf("%s/%s", dirname
.c_str(), namelist
[i
]->d_name
);
280 if (!stat(buffer
.c_str(), &stbuf
) && S_ISREG(stbuf
.st_mode
)) {
281 log("Removing `%s'.\n", buffer
.c_str());
282 remove(buffer
.c_str());
284 remove_directory(buffer
);
289 log("Removing `%s'.\n", dirname
.c_str());
290 rmdir(dirname
.c_str());
294 int GetSize(RTLIL::Wire
*wire
)
301 Pass::init_register();
302 yosys_design
= new RTLIL::Design
;
306 void yosys_shutdown()
313 for (auto f
: log_files
)
319 Pass::done_register();
321 #ifdef YOSYS_ENABLE_TCL
322 if (yosys_tcl_interp
!= NULL
) {
323 Tcl_DeleteInterp(yosys_tcl_interp
);
325 yosys_tcl_interp
= NULL
;
329 #ifdef YOSYS_ENABLE_PLUGINS
330 for (auto &it
: loaded_plugins
)
333 loaded_plugins
.clear();
334 loaded_plugin_aliases
.clear();
338 RTLIL::IdString
new_id(std::string file
, int line
, std::string func
)
340 std::string str
= "$auto$";
341 size_t pos
= file
.find_last_of('/');
342 str
+= pos
!= std::string::npos
? file
.substr(pos
+1) : file
;
343 str
+= stringf(":%d:%s$%d", line
, func
.c_str(), autoidx
++);
347 RTLIL::Design
*yosys_get_design()
352 const char *create_prompt(RTLIL::Design
*design
, int recursion_counter
)
354 static char buffer
[100];
355 std::string str
= "\n";
356 if (recursion_counter
> 1)
357 str
+= stringf("(%d) ", recursion_counter
);
359 if (!design
->selected_active_module
.empty())
360 str
+= stringf(" [%s]", RTLIL::unescape_id(design
->selected_active_module
).c_str());
361 if (!design
->selection_stack
.empty() && !design
->selection_stack
.back().full_selection
) {
362 if (design
->selected_active_module
.empty())
364 else if (design
->selection_stack
.back().selected_modules
.size() != 1 || design
->selection_stack
.back().selected_members
.size() != 0 ||
365 design
->selection_stack
.back().selected_modules
.count(design
->selected_active_module
) == 0)
368 snprintf(buffer
, 100, "%s> ", str
.c_str());
372 #ifdef YOSYS_ENABLE_TCL
373 static int tcl_yosys_cmd(ClientData
, Tcl_Interp
*interp
, int argc
, const char *argv
[])
375 std::vector
<std::string
> args
;
376 for (int i
= 1; i
< argc
; i
++)
377 args
.push_back(argv
[i
]);
379 if (args
.size() >= 1 && args
[0] == "-import") {
380 for (auto &it
: pass_register
) {
381 std::string tcl_command_name
= it
.first
;
382 if (tcl_command_name
== "proc")
383 tcl_command_name
= "procs";
385 if (Tcl_GetCommandInfo(interp
, tcl_command_name
.c_str(), &info
) != 0) {
386 log("[TCL: yosys -import] Command name collision: found pre-existing command `%s' -> skip.\n", it
.first
.c_str());
388 std::string tcl_script
= stringf("proc %s args { yosys %s {*}$args }", tcl_command_name
.c_str(), it
.first
.c_str());
389 Tcl_Eval(interp
, tcl_script
.c_str());
395 if (args
.size() == 1) {
396 Pass::call(yosys_get_design(), args
[0]);
400 Pass::call(yosys_get_design(), args
);
404 extern Tcl_Interp
*yosys_get_tcl_interp()
406 if (yosys_tcl_interp
== NULL
) {
407 yosys_tcl_interp
= Tcl_CreateInterp();
408 Tcl_CreateCommand(yosys_tcl_interp
, "yosys", tcl_yosys_cmd
, NULL
, NULL
);
410 return yosys_tcl_interp
;
413 struct TclPass
: public Pass
{
414 TclPass() : Pass("tcl", "execute a TCL script file") { }
415 virtual void help() {
417 log(" tcl <filename>\n");
419 log("This command executes the tcl commands in the specified file.\n");
420 log("Use 'yosys cmd' to run the yosys command 'cmd' from tcl.\n");
422 log("The tcl command 'yosys -import' can be used to import all yosys\n");
423 log("commands directly as tcl commands to the tcl shell. The yosys\n");
424 log("command 'proc' is wrapped using the tcl command 'procs' in order\n");
425 log("to avoid a name collision with the tcl builting command 'proc'.\n");
428 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
430 log_cmd_error("Missing script file.\n");
432 extra_args(args
, 1, design
, false);
433 if (Tcl_EvalFile(yosys_get_tcl_interp(), args
[1].c_str()) != TCL_OK
)
434 log_cmd_error("TCL interpreter returned an error: %s\n", Tcl_GetStringResult(yosys_get_tcl_interp()));
439 #if defined(__linux__)
440 std::string
proc_self_dirname()
443 ssize_t buflen
= readlink("/proc/self/exe", path
, sizeof(path
));
445 log_error("readlink(\"/proc/self/exe\") failed: %s\n", strerror(errno
));
447 while (buflen
> 0 && path
[buflen
-1] != '/')
449 return std::string(path
, buflen
);
451 #elif defined(__APPLE__)
452 std::string
proc_self_dirname()
456 while (_NSGetExecutablePath(path
, &buflen
) != 0)
457 path
= (char *) realloc((void *) path
, buflen
);
458 while (buflen
> 0 && path
[buflen
-1] != '/')
460 return std::string(path
, buflen
);
462 #elif defined(_WIN32)
463 std::string
proc_self_dirname()
465 char longpath
[MAX_PATH
+1], shortpath
[MAX_PATH
+1];
466 if (!GetModuleFileName(0, longpath
, MAX_PATH
+1))
467 log_error("GetModuleFileName() failed.\n");
468 if (!GetShortPathName(longpath
, shortpath
, MAX_PATH
+1))
469 log_error("GetShortPathName() failed.\n");
470 for (int i
= strlen(shortpath
)-1; i
>= 0 && shortpath
[i
] != '/' && shortpath
[i
] != '\\' ; i
--)
472 return std::string(shortpath
);
474 #elif defined(EMSCRIPTEN)
475 std::string
proc_self_dirname()
480 #error Dont know how to determine process executable base path!
483 std::string
proc_share_dirname()
485 std::string proc_self_path
= proc_self_dirname();
486 std::string proc_share_path
= proc_self_path
+ "share/";
487 if (access(proc_share_path
.c_str(), X_OK
) == 0)
488 return proc_share_path
;
489 proc_share_path
= proc_self_path
+ "../share/yosys/";
490 if (access(proc_share_path
.c_str(), X_OK
) == 0)
491 return proc_share_path
;
492 log_error("proc_share_dirname: unable to determine share/ directory!\n");
495 bool fgetline(FILE *f
, std::string
&buffer
)
500 if (fgets(block
, 4096, f
) == NULL
)
503 if (buffer
.size() > 0 && (buffer
[buffer
.size()-1] == '\n' || buffer
[buffer
.size()-1] == '\r')) {
504 while (buffer
.size() > 0 && (buffer
[buffer
.size()-1] == '\n' || buffer
[buffer
.size()-1] == '\r'))
505 buffer
.resize(buffer
.size()-1);
511 static void handle_label(std::string
&command
, bool &from_to_active
, const std::string
&run_from
, const std::string
&run_to
)
516 while (pos
< GetSize(command
) && (command
[pos
] == ' ' || command
[pos
] == '\t'))
519 while (pos
< GetSize(command
) && command
[pos
] != ' ' && command
[pos
] != '\t' && command
[pos
] != '\r' && command
[pos
] != '\n')
520 label
+= command
[pos
++];
522 if (label
.back() == ':' && GetSize(label
) > 1)
524 label
= label
.substr(0, GetSize(label
)-1);
525 command
= command
.substr(pos
);
527 if (label
== run_from
)
528 from_to_active
= true;
529 else if (label
== run_to
|| (run_from
== run_to
&& !run_from
.empty()))
530 from_to_active
= false;
534 void run_frontend(std::string filename
, std::string command
, RTLIL::Design
*design
, std::string
*backend_command
, std::string
*from_to_label
)
536 if (command
== "auto") {
537 if (filename
.size() > 2 && filename
.substr(filename
.size()-2) == ".v")
539 else if (filename
.size() > 2 && filename
.substr(filename
.size()-3) == ".sv")
540 command
= "verilog -sv";
541 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".il")
543 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".ys")
545 else if (filename
== "-")
548 log_error("Can't guess frontend for input file `%s' (missing -f option)!\n", filename
.c_str());
551 if (command
== "script")
553 std::string run_from
, run_to
;
554 bool from_to_active
= true;
556 if (from_to_label
!= NULL
) {
557 size_t pos
= from_to_label
->find(':');
558 if (pos
== std::string::npos
) {
559 run_from
= *from_to_label
;
560 run_to
= *from_to_label
;
562 run_from
= from_to_label
->substr(0, pos
);
563 run_to
= from_to_label
->substr(pos
+1);
565 from_to_active
= run_from
.empty();
568 log("\n-- Executing script file `%s' --\n", filename
.c_str());
573 f
= fopen(filename
.c_str(), "r");
576 log_error("Can't open script file `%s' for reading: %s\n", filename
.c_str(), strerror(errno
));
578 FILE *backup_script_file
= Frontend::current_script_file
;
579 Frontend::current_script_file
= f
;
583 while (fgetline(f
, command
)) {
584 while (!command
.empty() && command
[command
.size()-1] == '\\') {
585 std::string next_line
;
586 if (!fgetline(f
, next_line
))
588 command
.resize(command
.size()-1);
589 command
+= next_line
;
591 handle_label(command
, from_to_active
, run_from
, run_to
);
593 Pass::call(design
, command
);
596 if (!command
.empty()) {
597 handle_label(command
, from_to_active
, run_from
, run_to
);
599 Pass::call(design
, command
);
602 catch (log_cmd_error_expection
) {
603 Frontend::current_script_file
= backup_script_file
;
604 throw log_cmd_error_expection();
607 Frontend::current_script_file
= backup_script_file
;
612 if (backend_command
!= NULL
&& *backend_command
== "auto")
613 *backend_command
= "";
618 if (filename
== "-") {
619 log("\n-- Parsing stdin using frontend `%s' --\n", command
.c_str());
621 log("\n-- Parsing `%s' using frontend `%s' --\n", filename
.c_str(), command
.c_str());
624 Frontend::frontend_call(design
, NULL
, filename
, command
);
627 void run_pass(std::string command
, RTLIL::Design
*design
)
629 log("\n-- Running pass `%s' --\n", command
.c_str());
631 Pass::call(design
, command
);
634 void run_backend(std::string filename
, std::string command
, RTLIL::Design
*design
)
636 if (command
== "auto") {
637 if (filename
.size() > 2 && filename
.substr(filename
.size()-2) == ".v")
639 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".il")
641 else if (filename
.size() > 5 && filename
.substr(filename
.size()-5) == ".blif")
643 else if (filename
== "-")
645 else if (filename
.empty())
648 log_error("Can't guess backend for output file `%s' (missing -b option)!\n", filename
.c_str());
651 if (filename
.empty())
654 if (filename
== "-") {
655 log("\n-- Writing to stdout using backend `%s' --\n", command
.c_str());
657 log("\n-- Writing to `%s' using backend `%s' --\n", filename
.c_str(), command
.c_str());
660 Backend::backend_call(design
, NULL
, filename
, command
);
663 #ifdef YOSYS_ENABLE_READLINE
664 static char *readline_cmd_generator(const char *text
, int state
)
666 static std::map
<std::string
, Pass
*>::iterator it
;
670 it
= pass_register
.begin();
674 for (; it
!= pass_register
.end(); it
++) {
675 if (it
->first
.substr(0, len
) == text
)
676 return strdup((it
++)->first
.c_str());
681 static char *readline_obj_generator(const char *text
, int state
)
683 static std::vector
<char*> obj_names
;
691 RTLIL::Design
*design
= yosys_get_design();
692 int len
= strlen(text
);
694 if (design
->selected_active_module
.empty())
696 for (auto &it
: design
->modules_
)
697 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
698 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
701 if (design
->modules_
.count(design
->selected_active_module
) > 0)
703 RTLIL::Module
*module
= design
->modules_
.at(design
->selected_active_module
);
705 for (auto &it
: module
->wires_
)
706 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
707 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
709 for (auto &it
: module
->memories
)
710 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
711 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
713 for (auto &it
: module
->cells_
)
714 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
715 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
717 for (auto &it
: module
->processes
)
718 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
719 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
722 std::sort(obj_names
.begin(), obj_names
.end());
725 if (idx
< obj_names
.size())
726 return strdup(obj_names
[idx
++]);
733 static char **readline_completion(const char *text
, int start
, int)
736 return rl_completion_matches(text
, readline_cmd_generator
);
737 if (strncmp(rl_line_buffer
, "read_", 5) && strncmp(rl_line_buffer
, "write_", 6))
738 return rl_completion_matches(text
, readline_obj_generator
);
743 void shell(RTLIL::Design
*design
)
745 static int recursion_counter
= 0;
748 log_cmd_error_throw
= true;
750 #ifdef YOSYS_ENABLE_READLINE
751 rl_readline_name
= "yosys";
752 rl_attempted_completion_function
= readline_completion
;
753 rl_basic_word_break_characters
= " \t\n";
756 char *command
= NULL
;
757 #ifdef YOSYS_ENABLE_READLINE
758 while ((command
= readline(create_prompt(design
, recursion_counter
))) != NULL
)
760 char command_buffer
[4096];
761 while ((command
= fgets(command_buffer
, 4096, stdin
)) != NULL
)
764 if (command
[strspn(command
, " \t\r\n")] == 0)
766 #ifdef YOSYS_ENABLE_READLINE
767 add_history(command
);
770 char *p
= command
+ strspn(command
, " \t\r\n");
771 if (!strncmp(p
, "exit", 4)) {
773 p
+= strspn(p
, " \t\r\n");
779 log_assert(design
->selection_stack
.size() == 1);
780 Pass::call(design
, command
);
781 } catch (log_cmd_error_expection
) {
782 while (design
->selection_stack
.size() > 1)
783 design
->selection_stack
.pop_back();
791 log_cmd_error_throw
= false;
794 struct ShellPass
: public Pass
{
795 ShellPass() : Pass("shell", "enter interactive command mode") { }
796 virtual void help() {
800 log("This command enters the interactive command mode. This can be useful\n");
801 log("in a script to interrupt the script at a certain point and allow for\n");
802 log("interactive inspection or manual synthesis of the design at this point.\n");
804 log("The command prompt of the interactive shell indicates the current\n");
805 log("selection (see 'help select'):\n");
808 log(" the entire design is selected\n");
811 log(" only part of the design is selected\n");
813 log(" yosys [modname]>\n");
814 log(" the entire module 'modname' is selected using 'select -module modname'\n");
816 log(" yosys [modname]*>\n");
817 log(" only part of current module 'modname' is selected\n");
819 log("When in interactive shell, some errors (e.g. invalid command arguments)\n");
820 log("do not terminate yosys but return to the command prompt.\n");
822 log("This command is the default action if nothing else has been specified\n");
823 log("on the command line.\n");
825 log("Press Ctrl-D or type 'exit' to leave the interactive shell.\n");
828 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
829 extra_args(args
, 1, design
, false);
834 #ifdef YOSYS_ENABLE_READLINE
835 struct HistoryPass
: public Pass
{
836 HistoryPass() : Pass("history", "show last interactive commands") { }
837 virtual void help() {
841 log("This command prints all commands in the shell history buffer. This are\n");
842 log("all commands executed in an interactive session, but not the commands\n");
843 log("from executed scripts.\n");
846 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
847 extra_args(args
, 1, design
, false);
848 for(HIST_ENTRY
**list
= history_list(); *list
!= NULL
; list
++)
849 log("%s\n", (*list
)->line
);
854 struct ScriptPass
: public Pass
{
855 ScriptPass() : Pass("script", "execute commands from script file") { }
856 virtual void help() {
858 log(" script <filename> [<from_label>:<to_label>]\n");
860 log("This command executes the yosys commands in the specified file.\n");
862 log("The 2nd argument can be used to only execute the section of the\n");
863 log("file between the specified labels. An empty from label is synonymous\n");
864 log("for the beginning of the file and an empty to label is synonymous\n");
865 log("for the end of the file.\n");
867 log("If only one label is specified (without ':') then only the block\n");
868 log("marked with that label (until the next label) is executed.\n");
871 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
873 log_cmd_error("Missing script file.\n");
874 else if (args
.size() == 2)
875 run_frontend(args
[1], "script", design
, NULL
, NULL
);
876 else if (args
.size() == 3)
877 run_frontend(args
[1], "script", design
, NULL
, &args
[2]);
879 extra_args(args
, 2, design
, false);