2 * yosys -- Yosys Open SYnthesis Suite
4 * Copyright (C) 2012 Clifford Wolf <clifford@clifford.at>
6 * Permission to use, copy, modify, and/or distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 #include "kernel/yosys.h"
21 #include "kernel/celltypes.h"
23 #ifdef YOSYS_ENABLE_READLINE
24 # include <readline/readline.h>
25 # include <readline/history.h>
28 #ifdef YOSYS_ENABLE_PLUGINS
35 #elif defined(__APPLE__)
36 # include <mach-o/dyld.h>
39 # include <sys/stat.h>
43 # include <sys/types.h>
44 # include <sys/stat.h>
54 RTLIL::Design
*yosys_design
= NULL
;
55 CellTypes yosys_celltypes
;
57 #ifdef YOSYS_ENABLE_TCL
58 Tcl_Interp
*yosys_tcl_interp
= NULL
;
61 bool memhasher_active
= false;
62 uint32_t memhasher_rng
= 123456;
63 std::vector
<void*> memhasher_store
;
68 memhasher_rng
+= time(NULL
) << 16 ^ getpid();
70 memhasher_store
.resize(0x10000);
71 memhasher_active
= true;
76 for (auto p
: memhasher_store
)
78 memhasher_store
.clear();
79 memhasher_active
= false;
84 memhasher_rng
^= memhasher_rng
<< 13;
85 memhasher_rng
^= memhasher_rng
>> 17;
86 memhasher_rng
^= memhasher_rng
<< 5;
88 int size
, index
= (memhasher_rng
>> 4) & 0xffff;
89 switch (memhasher_rng
& 7) {
90 case 0: size
= 16; break;
91 case 1: size
= 256; break;
92 case 2: size
= 1024; break;
93 case 3: size
= 4096; break;
96 if (index
< 16) size
*= 16;
97 memhasher_store
[index
] = realloc(memhasher_store
[index
], size
);
100 std::string
stringf(const char *fmt
, ...)
106 string
= vstringf(fmt
, ap
);
112 std::string
vstringf(const char *fmt
, va_list ap
)
122 str
= (char*)realloc(str
, sz
);
123 rc
= vsnprintf(str
, sz
, fmt
, apc
);
125 if (rc
>= 0 && rc
< sz
)
130 if (vasprintf(&str
, fmt
, ap
) < 0)
142 int readsome(std::istream
&f
, char *s
, int n
)
144 int rc
= f
.readsome(s
, n
);
146 // f.readsome() sometimes returns 0 on a non-empty stream..
158 std::string
next_token(std::string
&text
, const char *sep
)
160 size_t pos_begin
= text
.find_first_not_of(sep
);
162 if (pos_begin
== std::string::npos
)
163 pos_begin
= text
.size();
165 size_t pos_end
= text
.find_first_of(sep
, pos_begin
);
167 if (pos_end
== std::string::npos
)
168 pos_end
= text
.size();
170 std::string token
= text
.substr(pos_begin
, pos_end
-pos_begin
);
171 text
= text
.substr(pos_end
);
175 // this is very similar to fnmatch(). the exact rules used by this
178 // ? matches any character except
179 // * matches any sequence of characters
180 // [...] matches any of the characters in the list
181 // [!..] matches any of the characters not in the list
183 // a backslash may be used to escape the next characters in the
184 // pattern. each special character can also simply match itself.
186 bool patmatch(const char *pattern
, const char *string
)
191 if (*pattern
== '\\') {
192 if (pattern
[1] == string
[0] && patmatch(pattern
+2, string
+1))
196 if (*pattern
== '?') {
199 return patmatch(pattern
+1, string
+1);
202 if (*pattern
== '*') {
204 if (patmatch(pattern
+1, string
++))
207 return pattern
[1] == 0;
210 if (*pattern
== '[') {
211 bool found_match
= false;
212 bool inverted_list
= pattern
[1] == '!';
213 const char *p
= pattern
+ (inverted_list
? 1 : 0);
217 if (found_match
!= inverted_list
&& patmatch(p
+1, string
+1))
231 if (*pattern
== *string
)
232 return patmatch(pattern
+1, string
+1);
237 int run_command(const std::string
&command
, std::function
<void(const std::string
&)> process_line
)
240 return system(command
.c_str());
242 FILE *f
= popen(command
.c_str(), "r");
248 while (fgets(logbuf
, 128, f
) != NULL
) {
250 if (!line
.empty() && line
.back() == '\n')
251 process_line(line
), line
.clear();
262 return WEXITSTATUS(ret
);
266 std::string
make_temp_file(std::string template_str
)
269 if (template_str
.rfind("/tmp/", 0) == 0) {
271 char longpath
[MAX_PATH
+ 1];
272 char shortpath
[MAX_PATH
+ 1];
274 WCHAR longpath
[MAX_PATH
+ 1];
275 TCHAR shortpath
[MAX_PATH
+ 1];
277 if (!GetTempPath(MAX_PATH
+1, longpath
))
278 log_error("GetTempPath() failed.\n");
279 if (!GetShortPathName(longpath
, shortpath
, MAX_PATH
+ 1))
280 log_error("GetShortPathName() failed.\n");
282 for (int i
= 0; shortpath
[i
]; i
++)
283 path
+= char(shortpath
[i
]);
284 template_str
= stringf("%s\\%s", path
.c_str(), template_str
.c_str() + 5);
287 size_t pos
= template_str
.rfind("XXXXXX");
288 log_assert(pos
!= std::string::npos
);
291 for (int i
= 0; i
< 6; i
++) {
292 static std::string y
= "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
293 static uint32_t x
= 314159265 ^ uint32_t(time(NULL
));
294 x
^= x
<< 13, x
^= x
>> 17, x
^= x
<< 5;
295 template_str
[pos
+i
] = y
[x
% y
.size()];
297 if (_access(template_str
.c_str(), 0) != 0)
301 size_t pos
= template_str
.rfind("XXXXXX");
302 log_assert(pos
!= std::string::npos
);
304 int suffixlen
= GetSize(template_str
) - pos
- 6;
306 char *p
= strdup(template_str
.c_str());
307 close(mkstemps(p
, suffixlen
));
315 std::string
make_temp_dir(std::string template_str
)
318 template_str
= make_temp_file(template_str
);
319 mkdir(template_str
.c_str());
322 size_t pos
= template_str
.rfind("XXXXXX");
323 log_assert(pos
!= std::string::npos
);
325 int suffixlen
= GetSize(template_str
) - pos
- 6;
326 log_assert(suffixlen
== 0);
328 char *p
= strdup(template_str
.c_str());
330 log_assert(p
!= NULL
);
339 bool check_file_exists(std::string filename
, bool)
341 return _access(filename
.c_str(), 0) == 0;
344 bool check_file_exists(std::string filename
, bool is_exec
)
346 return access(filename
.c_str(), is_exec
? X_OK
: F_OK
) == 0;
350 void remove_directory(std::string dirname
)
353 run_command(stringf("rmdir /s /q \"%s\"", dirname
.c_str()));
356 struct dirent
**namelist
;
357 int n
= scandir(dirname
.c_str(), &namelist
, nullptr, alphasort
);
359 for (int i
= 0; i
< n
; i
++) {
360 if (strcmp(namelist
[i
]->d_name
, ".") && strcmp(namelist
[i
]->d_name
, "..")) {
361 std::string buffer
= stringf("%s/%s", dirname
.c_str(), namelist
[i
]->d_name
);
362 if (!stat(buffer
.c_str(), &stbuf
) && S_ISREG(stbuf
.st_mode
)) {
363 remove(buffer
.c_str());
365 remove_directory(buffer
);
370 rmdir(dirname
.c_str());
374 int GetSize(RTLIL::Wire
*wire
)
381 // if there are already IdString objects then we have a global initialization order bug
383 log_assert(empty_id
.index_
== 0);
384 IdString::get_reference(empty_id
.index_
);
386 Pass::init_register();
387 yosys_design
= new RTLIL::Design
;
388 yosys_celltypes
.setup();
392 void yosys_shutdown()
399 for (auto f
: log_files
)
405 Pass::done_register();
406 yosys_celltypes
.clear();
408 #ifdef YOSYS_ENABLE_TCL
409 if (yosys_tcl_interp
!= NULL
) {
410 Tcl_DeleteInterp(yosys_tcl_interp
);
412 yosys_tcl_interp
= NULL
;
416 #ifdef YOSYS_ENABLE_PLUGINS
417 for (auto &it
: loaded_plugins
)
420 loaded_plugins
.clear();
421 loaded_plugin_aliases
.clear();
425 RTLIL::IdString
new_id(std::string file
, int line
, std::string func
)
428 size_t pos
= file
.find_last_of("/\\");
430 size_t pos
= file
.find_last_of('/');
432 if (pos
!= std::string::npos
)
433 file
= file
.substr(pos
+1);
435 pos
= func
.find_last_of(':');
436 if (pos
!= std::string::npos
)
437 func
= func
.substr(pos
+1);
439 return stringf("$auto$%s:%d:%s$%d", file
.c_str(), line
, func
.c_str(), autoidx
++);
442 RTLIL::Design
*yosys_get_design()
447 const char *create_prompt(RTLIL::Design
*design
, int recursion_counter
)
449 static char buffer
[100];
450 std::string str
= "\n";
451 if (recursion_counter
> 1)
452 str
+= stringf("(%d) ", recursion_counter
);
454 if (!design
->selected_active_module
.empty())
455 str
+= stringf(" [%s]", RTLIL::unescape_id(design
->selected_active_module
).c_str());
456 if (!design
->selection_stack
.empty() && !design
->selection_stack
.back().full_selection
) {
457 if (design
->selected_active_module
.empty())
459 else if (design
->selection_stack
.back().selected_modules
.size() != 1 || design
->selection_stack
.back().selected_members
.size() != 0 ||
460 design
->selection_stack
.back().selected_modules
.count(design
->selected_active_module
) == 0)
463 snprintf(buffer
, 100, "%s> ", str
.c_str());
467 #ifdef YOSYS_ENABLE_TCL
468 static int tcl_yosys_cmd(ClientData
, Tcl_Interp
*interp
, int argc
, const char *argv
[])
470 std::vector
<std::string
> args
;
471 for (int i
= 1; i
< argc
; i
++)
472 args
.push_back(argv
[i
]);
474 if (args
.size() >= 1 && args
[0] == "-import") {
475 for (auto &it
: pass_register
) {
476 std::string tcl_command_name
= it
.first
;
477 if (tcl_command_name
== "proc")
478 tcl_command_name
= "procs";
480 if (Tcl_GetCommandInfo(interp
, tcl_command_name
.c_str(), &info
) != 0) {
481 log("[TCL: yosys -import] Command name collision: found pre-existing command `%s' -> skip.\n", it
.first
.c_str());
483 std::string tcl_script
= stringf("proc %s args { yosys %s {*}$args }", tcl_command_name
.c_str(), it
.first
.c_str());
484 Tcl_Eval(interp
, tcl_script
.c_str());
490 if (args
.size() == 1) {
491 Pass::call(yosys_get_design(), args
[0]);
495 Pass::call(yosys_get_design(), args
);
499 extern Tcl_Interp
*yosys_get_tcl_interp()
501 if (yosys_tcl_interp
== NULL
) {
502 yosys_tcl_interp
= Tcl_CreateInterp();
503 Tcl_CreateCommand(yosys_tcl_interp
, "yosys", tcl_yosys_cmd
, NULL
, NULL
);
505 return yosys_tcl_interp
;
508 struct TclPass
: public Pass
{
509 TclPass() : Pass("tcl", "execute a TCL script file") { }
510 virtual void help() {
512 log(" tcl <filename>\n");
514 log("This command executes the tcl commands in the specified file.\n");
515 log("Use 'yosys cmd' to run the yosys command 'cmd' from tcl.\n");
517 log("The tcl command 'yosys -import' can be used to import all yosys\n");
518 log("commands directly as tcl commands to the tcl shell. The yosys\n");
519 log("command 'proc' is wrapped using the tcl command 'procs' in order\n");
520 log("to avoid a name collision with the tcl builting command 'proc'.\n");
523 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
525 log_cmd_error("Missing script file.\n");
527 extra_args(args
, 1, design
, false);
528 if (Tcl_EvalFile(yosys_get_tcl_interp(), args
[1].c_str()) != TCL_OK
)
529 log_cmd_error("TCL interpreter returned an error: %s\n", Tcl_GetStringResult(yosys_get_tcl_interp()));
534 #if defined(__linux__)
535 std::string
proc_self_dirname()
538 ssize_t buflen
= readlink("/proc/self/exe", path
, sizeof(path
));
540 log_error("readlink(\"/proc/self/exe\") failed: %s\n", strerror(errno
));
542 while (buflen
> 0 && path
[buflen
-1] != '/')
544 return std::string(path
, buflen
);
546 #elif defined(__APPLE__)
547 std::string
proc_self_dirname()
551 while (_NSGetExecutablePath(path
, &buflen
) != 0)
552 path
= (char *) realloc((void *) path
, buflen
);
553 while (buflen
> 0 && path
[buflen
-1] != '/')
555 return std::string(path
, buflen
);
557 #elif defined(_WIN32)
558 std::string
proc_self_dirname()
562 char longpath
[MAX_PATH
+ 1];
563 char shortpath
[MAX_PATH
+ 1];
565 WCHAR longpath
[MAX_PATH
+ 1];
566 TCHAR shortpath
[MAX_PATH
+ 1];
568 if (!GetModuleFileName(0, longpath
, MAX_PATH
+1))
569 log_error("GetModuleFileName() failed.\n");
570 if (!GetShortPathName(longpath
, shortpath
, MAX_PATH
+1))
571 log_error("GetShortPathName() failed.\n");
572 while (shortpath
[i
] != 0)
574 while (i
> 0 && shortpath
[i
-1] != '/' && shortpath
[i
-1] != '\\')
577 for (i
= 0; shortpath
[i
]; i
++)
578 path
+= char(shortpath
[i
]);
581 #elif defined(EMSCRIPTEN)
582 std::string
proc_self_dirname()
587 #error Dont know how to determine process executable base path!
590 std::string
proc_share_dirname()
592 std::string proc_self_path
= proc_self_dirname();
594 std::string proc_share_path
= proc_self_path
+ "share\\";
595 if (check_file_exists(proc_share_path
, true))
596 return proc_share_path
;
597 proc_share_path
= proc_self_path
+ "..\\share\\";
598 if (check_file_exists(proc_share_path
, true))
599 return proc_share_path
;
601 std::string proc_share_path
= proc_self_path
+ "share/";
602 if (check_file_exists(proc_share_path
, true))
603 return proc_share_path
;
604 proc_share_path
= proc_self_path
+ "../share/yosys/";
605 if (check_file_exists(proc_share_path
, true))
606 return proc_share_path
;
608 log_error("proc_share_dirname: unable to determine share/ directory!\n");
611 bool fgetline(FILE *f
, std::string
&buffer
)
616 if (fgets(block
, 4096, f
) == NULL
)
619 if (buffer
.size() > 0 && (buffer
[buffer
.size()-1] == '\n' || buffer
[buffer
.size()-1] == '\r')) {
620 while (buffer
.size() > 0 && (buffer
[buffer
.size()-1] == '\n' || buffer
[buffer
.size()-1] == '\r'))
621 buffer
.resize(buffer
.size()-1);
627 static void handle_label(std::string
&command
, bool &from_to_active
, const std::string
&run_from
, const std::string
&run_to
)
632 while (pos
< GetSize(command
) && (command
[pos
] == ' ' || command
[pos
] == '\t'))
635 while (pos
< GetSize(command
) && command
[pos
] != ' ' && command
[pos
] != '\t' && command
[pos
] != '\r' && command
[pos
] != '\n')
636 label
+= command
[pos
++];
638 if (label
.back() == ':' && GetSize(label
) > 1)
640 label
= label
.substr(0, GetSize(label
)-1);
641 command
= command
.substr(pos
);
643 if (label
== run_from
)
644 from_to_active
= true;
645 else if (label
== run_to
|| (run_from
== run_to
&& !run_from
.empty()))
646 from_to_active
= false;
650 void run_frontend(std::string filename
, std::string command
, RTLIL::Design
*design
, std::string
*backend_command
, std::string
*from_to_label
)
652 if (command
== "auto") {
653 if (filename
.size() > 2 && filename
.substr(filename
.size()-2) == ".v")
655 else if (filename
.size() > 2 && filename
.substr(filename
.size()-3) == ".sv")
656 command
= "verilog -sv";
657 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".il")
659 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".ys")
661 else if (filename
== "-")
664 log_error("Can't guess frontend for input file `%s' (missing -f option)!\n", filename
.c_str());
667 if (command
== "script")
669 std::string run_from
, run_to
;
670 bool from_to_active
= true;
672 if (from_to_label
!= NULL
) {
673 size_t pos
= from_to_label
->find(':');
674 if (pos
== std::string::npos
) {
675 run_from
= *from_to_label
;
676 run_to
= *from_to_label
;
678 run_from
= from_to_label
->substr(0, pos
);
679 run_to
= from_to_label
->substr(pos
+1);
681 from_to_active
= run_from
.empty();
684 log("\n-- Executing script file `%s' --\n", filename
.c_str());
689 f
= fopen(filename
.c_str(), "r");
692 log_error("Can't open script file `%s' for reading: %s\n", filename
.c_str(), strerror(errno
));
694 FILE *backup_script_file
= Frontend::current_script_file
;
695 Frontend::current_script_file
= f
;
699 while (fgetline(f
, command
)) {
700 while (!command
.empty() && command
[command
.size()-1] == '\\') {
701 std::string next_line
;
702 if (!fgetline(f
, next_line
))
704 command
.resize(command
.size()-1);
705 command
+= next_line
;
707 handle_label(command
, from_to_active
, run_from
, run_to
);
709 Pass::call(design
, command
);
712 if (!command
.empty()) {
713 handle_label(command
, from_to_active
, run_from
, run_to
);
715 Pass::call(design
, command
);
718 catch (log_cmd_error_exception
) {
719 Frontend::current_script_file
= backup_script_file
;
720 throw log_cmd_error_exception();
723 Frontend::current_script_file
= backup_script_file
;
728 if (backend_command
!= NULL
&& *backend_command
== "auto")
729 *backend_command
= "";
734 if (filename
== "-") {
735 log("\n-- Parsing stdin using frontend `%s' --\n", command
.c_str());
737 log("\n-- Parsing `%s' using frontend `%s' --\n", filename
.c_str(), command
.c_str());
740 Frontend::frontend_call(design
, NULL
, filename
, command
);
743 void run_pass(std::string command
, RTLIL::Design
*design
)
745 log("\n-- Running pass `%s' --\n", command
.c_str());
747 Pass::call(design
, command
);
750 void run_backend(std::string filename
, std::string command
, RTLIL::Design
*design
)
752 if (command
== "auto") {
753 if (filename
.size() > 2 && filename
.substr(filename
.size()-2) == ".v")
755 else if (filename
.size() > 3 && filename
.substr(filename
.size()-3) == ".il")
757 else if (filename
.size() > 5 && filename
.substr(filename
.size()-5) == ".blif")
759 else if (filename
== "-")
761 else if (filename
.empty())
764 log_error("Can't guess backend for output file `%s' (missing -b option)!\n", filename
.c_str());
767 if (filename
.empty())
770 if (filename
== "-") {
771 log("\n-- Writing to stdout using backend `%s' --\n", command
.c_str());
773 log("\n-- Writing to `%s' using backend `%s' --\n", filename
.c_str(), command
.c_str());
776 Backend::backend_call(design
, NULL
, filename
, command
);
779 #ifdef YOSYS_ENABLE_READLINE
780 static char *readline_cmd_generator(const char *text
, int state
)
782 static std::map
<std::string
, Pass
*>::iterator it
;
786 it
= pass_register
.begin();
790 for (; it
!= pass_register
.end(); it
++) {
791 if (it
->first
.substr(0, len
) == text
)
792 return strdup((it
++)->first
.c_str());
797 static char *readline_obj_generator(const char *text
, int state
)
799 static std::vector
<char*> obj_names
;
807 RTLIL::Design
*design
= yosys_get_design();
808 int len
= strlen(text
);
810 if (design
->selected_active_module
.empty())
812 for (auto &it
: design
->modules_
)
813 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
814 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
817 if (design
->modules_
.count(design
->selected_active_module
) > 0)
819 RTLIL::Module
*module
= design
->modules_
.at(design
->selected_active_module
);
821 for (auto &it
: module
->wires_
)
822 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
823 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
825 for (auto &it
: module
->memories
)
826 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
827 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
829 for (auto &it
: module
->cells_
)
830 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
831 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
833 for (auto &it
: module
->processes
)
834 if (RTLIL::unescape_id(it
.first
).substr(0, len
) == text
)
835 obj_names
.push_back(strdup(RTLIL::id2cstr(it
.first
)));
838 std::sort(obj_names
.begin(), obj_names
.end());
841 if (idx
< obj_names
.size())
842 return strdup(obj_names
[idx
++]);
849 static char **readline_completion(const char *text
, int start
, int)
852 return rl_completion_matches(text
, readline_cmd_generator
);
853 if (strncmp(rl_line_buffer
, "read_", 5) && strncmp(rl_line_buffer
, "write_", 6))
854 return rl_completion_matches(text
, readline_obj_generator
);
859 void shell(RTLIL::Design
*design
)
861 static int recursion_counter
= 0;
864 log_cmd_error_throw
= true;
866 #ifdef YOSYS_ENABLE_READLINE
867 rl_readline_name
= "yosys";
868 rl_attempted_completion_function
= readline_completion
;
869 rl_basic_word_break_characters
= " \t\n";
872 char *command
= NULL
;
873 #ifdef YOSYS_ENABLE_READLINE
874 while ((command
= readline(create_prompt(design
, recursion_counter
))) != NULL
)
877 char command_buffer
[4096];
880 fputs(create_prompt(design
, recursion_counter
), stdout
);
882 if ((command
= fgets(command_buffer
, 4096, stdin
)) == NULL
)
885 if (command
[strspn(command
, " \t\r\n")] == 0)
887 #ifdef YOSYS_ENABLE_READLINE
888 add_history(command
);
891 char *p
= command
+ strspn(command
, " \t\r\n");
892 if (!strncmp(p
, "exit", 4)) {
894 p
+= strspn(p
, " \t\r\n");
900 log_assert(design
->selection_stack
.size() == 1);
901 Pass::call(design
, command
);
902 } catch (log_cmd_error_exception
) {
903 while (design
->selection_stack
.size() > 1)
904 design
->selection_stack
.pop_back();
912 log_cmd_error_throw
= false;
915 struct ShellPass
: public Pass
{
916 ShellPass() : Pass("shell", "enter interactive command mode") { }
917 virtual void help() {
921 log("This command enters the interactive command mode. This can be useful\n");
922 log("in a script to interrupt the script at a certain point and allow for\n");
923 log("interactive inspection or manual synthesis of the design at this point.\n");
925 log("The command prompt of the interactive shell indicates the current\n");
926 log("selection (see 'help select'):\n");
929 log(" the entire design is selected\n");
932 log(" only part of the design is selected\n");
934 log(" yosys [modname]>\n");
935 log(" the entire module 'modname' is selected using 'select -module modname'\n");
937 log(" yosys [modname]*>\n");
938 log(" only part of current module 'modname' is selected\n");
940 log("When in interactive shell, some errors (e.g. invalid command arguments)\n");
941 log("do not terminate yosys but return to the command prompt.\n");
943 log("This command is the default action if nothing else has been specified\n");
944 log("on the command line.\n");
946 log("Press Ctrl-D or type 'exit' to leave the interactive shell.\n");
949 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
950 extra_args(args
, 1, design
, false);
955 #ifdef YOSYS_ENABLE_READLINE
956 struct HistoryPass
: public Pass
{
957 HistoryPass() : Pass("history", "show last interactive commands") { }
958 virtual void help() {
962 log("This command prints all commands in the shell history buffer. This are\n");
963 log("all commands executed in an interactive session, but not the commands\n");
964 log("from executed scripts.\n");
967 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
968 extra_args(args
, 1, design
, false);
969 for(HIST_ENTRY
**list
= history_list(); *list
!= NULL
; list
++)
970 log("%s\n", (*list
)->line
);
975 struct ScriptPass
: public Pass
{
976 ScriptPass() : Pass("script", "execute commands from script file") { }
977 virtual void help() {
979 log(" script <filename> [<from_label>:<to_label>]\n");
981 log("This command executes the yosys commands in the specified file.\n");
983 log("The 2nd argument can be used to only execute the section of the\n");
984 log("file between the specified labels. An empty from label is synonymous\n");
985 log("for the beginning of the file and an empty to label is synonymous\n");
986 log("for the end of the file.\n");
988 log("If only one label is specified (without ':') then only the block\n");
989 log("marked with that label (until the next label) is executed.\n");
992 virtual void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) {
994 log_cmd_error("Missing script file.\n");
995 else if (args
.size() == 2)
996 run_frontend(args
[1], "script", design
, NULL
, NULL
);
997 else if (args
.size() == 3)
998 run_frontend(args
[1], "script", design
, NULL
, &args
[2]);
1000 extra_args(args
, 2, design
, false);