kernel/yosys.cc

   1 /*
   2  *  yosys -- Yosys Open SYnthesis Suite
   3  *
   4  *  Copyright (C) 2012  Clifford Wolf <clifford@clifford.at>
   5  *
   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.
   9  *
  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.
  17  *
  18  */
  19
  20 #include "kernel/yosys.h"
  21 #include "kernel/celltypes.h"
  22
  23 #ifdef YOSYS_ENABLE_READLINE
  24 #  include <readline/readline.h>
  25 #  include <readline/history.h>
  26 #endif
  27
  28 #ifdef YOSYS_ENABLE_EDITLINE
  29 #  include <editline/readline.h>
  30 #endif
  31
  32 #ifdef YOSYS_ENABLE_PLUGINS
  33 #  include <dlfcn.h>
  34 #endif
  35
  36 #if defined(_WIN32)
  37 #  include <windows.h>
  38 #  include <io.h>
  39 #elif defined(__APPLE__)
  40 #  include <mach-o/dyld.h>
  41 #  include <unistd.h>
  42 #  include <dirent.h>
  43 #  include <sys/stat.h>
  44 #else
  45 #  include <unistd.h>
  46 #  include <dirent.h>
  47 #  include <sys/types.h>
  48 #  include <sys/wait.h>
  49 #  include <sys/stat.h>
  50 #endif
  51
  52 #if !defined(_WIN32) && defined(YOSYS_ENABLE_GLOB)
  53 #  include <glob.h>
  54 #endif
  55
  56 #ifdef __FreeBSD__
  57 #  include <sys/sysctl.h>
  58 #endif
  59
  60 #ifdef WITH_PYTHON
  61 #if PY_MAJOR_VERSION >= 3
  62 #   define INIT_MODULE PyInit_libyosys
  63     extern "C" PyObject* INIT_MODULE();
  64 #else
  65 #   define INIT_MODULE initlibyosys
  66         extern "C" void INIT_MODULE();
  67 #endif
  68 #endif
  69
  70 #include <limits.h>
  71 #include <errno.h>
  72
  73 YOSYS_NAMESPACE_BEGIN
  74
  75 int autoidx = 1;
  76 int yosys_xtrace = 0;
  77 RTLIL::Design *yosys_design = NULL;
  78 CellTypes yosys_celltypes;
  79
  80 #ifdef YOSYS_ENABLE_TCL
  81 Tcl_Interp *yosys_tcl_interp = NULL;
  82 #endif
  83
  84 std::set<std::string> yosys_input_files, yosys_output_files;
  85
  86 bool memhasher_active = false;
  87 uint32_t memhasher_rng = 123456;
  88 std::vector<void*> memhasher_store;
  89
  90 void memhasher_on()
  91 {
  92 #if defined(__linux__) || defined(__FreeBSD__)
  93         memhasher_rng += time(NULL) << 16 ^ getpid();
  94 #endif
  95         memhasher_store.resize(0x10000);
  96         memhasher_active = true;
  97 }
  98
  99 void memhasher_off()
 100 {
 101         for (auto p : memhasher_store)
 102                 if (p) free(p);
 103         memhasher_store.clear();
 104         memhasher_active = false;
 105 }
 106
 107 void memhasher_do()
 108 {
 109         memhasher_rng ^= memhasher_rng << 13;
 110         memhasher_rng ^= memhasher_rng >> 17;
 111         memhasher_rng ^= memhasher_rng << 5;
 112
 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;
 119                 default: size = 0;
 120         }
 121         if (index < 16) size *= 16;
 122         memhasher_store[index] = realloc(memhasher_store[index], size);
 123 }
 124
 125 void yosys_banner()
 126 {
 127         log("\n");
 128         log(" /----------------------------------------------------------------------------\\\n");
 129         log(" |                                                                            |\n");
 130         log(" |  yosys -- Yosys Open SYnthesis Suite                                       |\n");
 131         log(" |                                                                            |\n");
 132         log(" |  Copyright (C) 2012 - 2019  Clifford Wolf <clifford@clifford.at>           |\n");
 133         log(" |                                                                            |\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");
 137         log(" |                                                                            |\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");
 145         log(" |                                                                            |\n");
 146         log(" \\----------------------------------------------------------------------------/\n");
 147         log("\n");
 148         log(" %s\n", yosys_version_str);
 149         log("\n");
 150 }
 151
 152 int ceil_log2(int x)
 153 {
 154 #if defined(__GNUC__)
 155         return x > 1 ? (8*sizeof(int)) - __builtin_clz(x-1) : 0;
 156 #else
 157         if (x <= 0)
 158                 return 0;
 159         for (int i = 0; i < 32; i++)
 160                 if (((x-1) >> i) == 0)
 161                         return i;
 162         log_abort();
 163 #endif
 164 }
 165
 166 std::string stringf(const char *fmt, ...)
 167 {
 168         std::string string;
 169         va_list ap;
 170
 171         va_start(ap, fmt);
 172         string = vstringf(fmt, ap);
 173         va_end(ap);
 174
 175         return string;
 176 }
 177
 178 std::string vstringf(const char *fmt, va_list ap)
 179 {
 180         std::string string;
 181         char *str = NULL;
 182
 183 #if defined(_WIN32 )|| defined(__CYGWIN__)
 184         int sz = 64, rc;
 185         while (1) {
 186                 va_list apc;
 187                 va_copy(apc, ap);
 188                 str = (char*)realloc(str, sz);
 189                 rc = vsnprintf(str, sz, fmt, apc);
 190                 va_end(apc);
 191                 if (rc >= 0 && rc < sz)
 192                         break;
 193                 sz *= 2;
 194         }
 195 #else
 196         if (vasprintf(&str, fmt, ap) < 0)
 197                 str = NULL;
 198 #endif
 199
 200         if (str != NULL) {
 201                 string = str;
 202                 free(str);
 203         }
 204
 205         return string;
 206 }
 207
 208 int readsome(std::istream &f, char *s, int n)
 209 {
 210         int rc = int(f.readsome(s, n));
 211
 212         // f.readsome() sometimes returns 0 on a non-empty stream..
 213         if (rc == 0) {
 214                 int c = f.get();
 215                 if (c != EOF) {
 216                         *s = c;
 217                         rc = 1;
 218                 }
 219         }
 220
 221         return rc;
 222 }
 223
 224 std::string next_token(std::string &text, const char *sep, bool long_strings)
 225 {
 226         size_t pos_begin = text.find_first_not_of(sep);
 227
 228         if (pos_begin == std::string::npos)
 229                 pos_begin = text.size();
 230
 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);
 237                                 return token;
 238                         }
 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);
 242                                 return token + ";";
 243                         }
 244                 }
 245         }
 246
 247         size_t pos_end = text.find_first_of(sep, pos_begin);
 248
 249         if (pos_end == std::string::npos)
 250                 pos_end = text.size();
 251
 252         std::string token = text.substr(pos_begin, pos_end-pos_begin);
 253         text = text.substr(pos_end);
 254         return token;
 255 }
 256
 257 std::vector<std::string> split_tokens(const std::string &text, const char *sep)
 258 {
 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();
 266                         }
 267                 } else
 268                         current_token += c;
 269         }
 270         if (!current_token.empty()) {
 271                 tokens.push_back(current_token);
 272                 current_token.clear();
 273         }
 274         return tokens;
 275 }
 276
 277 // this is very similar to fnmatch(). the exact rules used by this
 278 // function are:
 279 //
 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
 284 //
 285 // a backslash may be used to escape the next characters in the
 286 // pattern. each special character can also simply match itself.
 287 //
 288 bool patmatch(const char *pattern, const char *string)
 289 {
 290         if (*pattern == 0)
 291                 return *string == 0;
 292
 293         if (*pattern == '\\') {
 294                 if (pattern[1] == string[0] && patmatch(pattern+2, string+1))
 295                         return true;
 296         }
 297
 298         if (*pattern == '?') {
 299                 if (*string == 0)
 300                         return false;
 301                 return patmatch(pattern+1, string+1);
 302         }
 303
 304         if (*pattern == '*') {
 305                 while (*string) {
 306                         if (patmatch(pattern+1, string++))
 307                                 return true;
 308                 }
 309                 return pattern[1] == 0;
 310         }
 311
 312         if (*pattern == '[') {
 313                 bool found_match = false;
 314                 bool inverted_list = pattern[1] == '!';
 315                 const char *p = pattern + (inverted_list ? 1 : 0);
 316
 317                 while (*++p) {
 318                         if (*p == ']') {
 319                                 if (found_match != inverted_list && patmatch(p+1, string+1))
 320                                         return true;
 321                                 break;
 322                         }
 323
 324                         if (*p == '\\') {
 325                                 if (*++p == *string)
 326                                         found_match = true;
 327                         } else
 328                         if (*p == *string)
 329                                 found_match = true;
 330                 }
 331         }
 332
 333         if (*pattern == *string)
 334                 return patmatch(pattern+1, string+1);
 335
 336         return false;
 337 }
 338
 339 int run_command(const std::string &command, std::function<void(const std::string&)> process_line)
 340 {
 341         if (!process_line)
 342                 return system(command.c_str());
 343
 344         FILE *f = popen(command.c_str(), "r");
 345         if (f == nullptr)
 346                 return -1;
 347
 348         std::string line;
 349         char logbuf[128];
 350         while (fgets(logbuf, 128, f) != NULL) {
 351                 line += logbuf;
 352                 if (!line.empty() && line.back() == '\n')
 353                         process_line(line), line.clear();
 354         }
 355         if (!line.empty())
 356                 process_line(line);
 357
 358         int ret = pclose(f);
 359         if (ret < 0)
 360                 return -1;
 361 #ifdef _WIN32
 362         return ret;
 363 #else
 364         return WEXITSTATUS(ret);
 365 #endif
 366 }
 367
 368 std::string make_temp_file(std::string template_str)
 369 {
 370 #ifdef _WIN32
 371         if (template_str.rfind("/tmp/", 0) == 0) {
 372 #  ifdef __MINGW32__
 373                 char longpath[MAX_PATH + 1];
 374                 char shortpath[MAX_PATH + 1];
 375 #  else
 376                 WCHAR longpath[MAX_PATH + 1];
 377                 TCHAR shortpath[MAX_PATH + 1];
 378 #  endif
 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");
 383                 std::string path;
 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);
 387         }
 388
 389         size_t pos = template_str.rfind("XXXXXX");
 390         log_assert(pos != std::string::npos);
 391
 392         while (1) {
 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()];
 398                 }
 399                 if (_access(template_str.c_str(), 0) != 0)
 400                         break;
 401         }
 402 #else
 403         size_t pos = template_str.rfind("XXXXXX");
 404         log_assert(pos != std::string::npos);
 405
 406         int suffixlen = GetSize(template_str) - pos - 6;
 407
 408         char *p = strdup(template_str.c_str());
 409         close(mkstemps(p, suffixlen));
 410         template_str = p;
 411         free(p);
 412 #endif
 413
 414         return template_str;
 415 }
 416
 417 std::string make_temp_dir(std::string template_str)
 418 {
 419 #ifdef _WIN32
 420         template_str = make_temp_file(template_str);
 421         mkdir(template_str.c_str());
 422         return template_str;
 423 #else
 424 #  ifndef NDEBUG
 425         size_t pos = template_str.rfind("XXXXXX");
 426         log_assert(pos != std::string::npos);
 427
 428         int suffixlen = GetSize(template_str) - pos - 6;
 429         log_assert(suffixlen == 0);
 430 #  endif
 431
 432         char *p = strdup(template_str.c_str());
 433         p = mkdtemp(p);
 434         log_assert(p != NULL);
 435         template_str = p;
 436         free(p);
 437
 438         return template_str;
 439 #endif
 440 }
 441
 442 #ifdef _WIN32
 443 bool check_file_exists(std::string filename, bool)
 444 {
 445         return _access(filename.c_str(), 0) == 0;
 446 }
 447 #else
 448 bool check_file_exists(std::string filename, bool is_exec)
 449 {
 450         return access(filename.c_str(), is_exec ? X_OK : F_OK) == 0;
 451 }
 452 #endif
 453
 454 bool is_absolute_path(std::string filename)
 455 {
 456 #ifdef _WIN32
 457         return filename[0] == '/' || filename[0] == '\\' || (filename[0] != 0 && filename[1] == ':');
 458 #else
 459         return filename[0] == '/';
 460 #endif
 461 }
 462
 463 void remove_directory(std::string dirname)
 464 {
 465 #ifdef _WIN32
 466         run_command(stringf("rmdir /s /q \"%s\"", dirname.c_str()));
 467 #else
 468         struct stat stbuf;
 469         struct dirent **namelist;
 470         int n = scandir(dirname.c_str(), &namelist, nullptr, alphasort);
 471         log_assert(n >= 0);
 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());
 477                         } else
 478                                 remove_directory(buffer);
 479                 }
 480                 free(namelist[i]);
 481         }
 482         free(namelist);
 483         rmdir(dirname.c_str());
 484 #endif
 485 }
 486
 487 std::string escape_filename_spaces(const std::string& filename)
 488 {
 489         std::string out;
 490         out.reserve(filename.size());
 491         for (auto c : filename)
 492         {
 493                 if (c == ' ')
 494                         out += "\\ ";
 495                 else
 496                         out.push_back(c);
 497         }
 498         return out;
 499 }
 500
 501 int GetSize(RTLIL::Wire *wire)
 502 {
 503         return wire->width;
 504 }
 505
 506 bool already_setup = false;
 507
 508 void yosys_setup()
 509 {
 510         if(already_setup)
 511                 return;
 512         already_setup = true;
 513
 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";
 520
 521         #ifdef WITH_PYTHON
 522                 PyImport_AppendInittab((char*)"libyosys", INIT_MODULE);
 523                 Py_Initialize();
 524                 PyRun_SimpleString("import sys");
 525         #endif
 526
 527         RTLIL::constpad["abc9.script.default"] = "&scorr; &sweep; &dc2; &dch -f; &ps; &if {C} {W} {D} {R} -v; &mfs";
 528         RTLIL::constpad["abc9.script.default.area"] = "&scorr; &sweep; &dc2; &dch -f; &ps; &if {C} {W} {D} {R} -a -v; &mfs";
 529         RTLIL::constpad["abc9.script.default.fast"] = "&if {C} {W} {D} {R}";
 530         // Based on ABC's &flow
 531         RTLIL::constpad["abc9.script.flow"] = "&scorr; &sweep;" \
 532                 /* Round 1 */ \
 533                 "&unmap; &if {C} {W} {D} {R}; &mfs;" \
 534                 "&st; &dsdb;" \
 535                 "&unmap; &if {C} {W} {D} {R}; &mfs;" \
 536                 "&st; &syn2 -m -R 10; &dsdb;" \
 537                 "&blut -a -K 6;" \
 538                 "&unmap; &if {C} {W} {D} {R}; &mfs;" \
 539                 /* Round 2 */ \
 540                 "&st; &sopb;" \
 541                 "&unmap; &if {C} {W} {D} {R}; &mfs;" \
 542                 "&st; &dsdb;" \
 543                 "&unmap; &if {C} {W} {D} {R}; &mfs;" \
 544                 "&st; &syn2 -m -R 10; &dsdb;" \
 545                 "&blut -a -K 6;" \
 546                 "&unmap; &if {C} {W} {D} {R} -v; &mfs";
 547         // Based on ABC's &flow2
 548         RTLIL::constpad["abc9.script.flow2"] = "&scorr; &sweep;" \
 549                 /* Comm1 */ "&synch2 -K 6 -C 500; &if -m {C} {W} {D} {R} -v; &mfs "/*"-W 4 -M 500 -C 7000"*/"; &save;"\
 550                 /* Comm2 */ "&dch -C 500; &if -m {C} {W} {D} {R} -v; &mfs "/*"-W 4 -M 500 -C 7000"*/"; &save;"\
 551                 "&load; &st; &sopb -R 10 -C 4; " \
 552                 /* Comm3 */ "&synch2 -K 6 -C 500; &if -m "/*"-E 5"*/" {C} {W} {D} {R} -v; &mfs "/*"-W 4 -M 500 -C 7000"*/"; &save;"\
 553                 /* Comm2 */ "&dch -C 500; &if -m {C} {W} {D} {R} -v; &mfs "/*"-W 4 -M 500 -C 7000"*/"; &save; "\
 554                 "&load";
 555         // Based on ABC's &flow3
 556         RTLIL::constpad["abc9.script.flow3"] = "&scorr; &sweep;" \
 557                 "&if {C} {W} {D}; &save; &st; &syn2; &if {C} {W} {D} {R} -v; &save; &load;"\
 558                 "&st; &if {C} -g -K 6; &dch -f; &if {C} {W} {D} {R} -v; &save; &load;"\
 559                 "&st; &if {C} -g -K 6; &synch2; &if {C} {W} {D} {R} -v; &save; &load;"\
 560                 "&mfs";
 561
 562         Pass::init_register();
 563         yosys_design = new RTLIL::Design;
 564         yosys_celltypes.setup();
 565         log_push();
 566 }
 567
 568 bool yosys_already_setup()
 569 {
 570         return already_setup;
 571 }
 572
 573 bool already_shutdown = false;
 574
 575 void yosys_shutdown()
 576 {
 577         if(already_shutdown)
 578                 return;
 579         already_shutdown = true;
 580         log_pop();
 581
 582         Pass::done_register();
 583
 584         delete yosys_design;
 585         yosys_design = NULL;
 586
 587         for (auto f : log_files)
 588                 if (f != stderr)
 589                         fclose(f);
 590         log_errfile = NULL;
 591         log_files.clear();
 592
 593         yosys_celltypes.clear();
 594
 595 #ifdef YOSYS_ENABLE_TCL
 596         if (yosys_tcl_interp != NULL) {
 597                 Tcl_DeleteInterp(yosys_tcl_interp);
 598                 Tcl_Finalize();
 599                 yosys_tcl_interp = NULL;
 600         }
 601 #endif
 602
 603 #ifdef YOSYS_ENABLE_PLUGINS
 604         for (auto &it : loaded_plugins)
 605                 dlclose(it.second);
 606
 607         loaded_plugins.clear();
 608 #ifdef WITH_PYTHON
 609         loaded_python_plugins.clear();
 610 #endif
 611         loaded_plugin_aliases.clear();
 612 #endif
 613
 614 #ifdef WITH_PYTHON
 615         Py_Finalize();
 616 #endif
 617 }
 618
 619 RTLIL::IdString new_id(std::string file, int line, std::string func)
 620 {
 621 #ifdef _WIN32
 622         size_t pos = file.find_last_of("/\\");
 623 #else
 624         size_t pos = file.find_last_of('/');
 625 #endif
 626         if (pos != std::string::npos)
 627                 file = file.substr(pos+1);
 628
 629         pos = func.find_last_of(':');
 630         if (pos != std::string::npos)
 631                 func = func.substr(pos+1);
 632
 633         return stringf("$auto$%s:%d:%s$%d", file.c_str(), line, func.c_str(), autoidx++);
 634 }
 635
 636 RTLIL::Design *yosys_get_design()
 637 {
 638         return yosys_design;
 639 }
 640
 641 const char *create_prompt(RTLIL::Design *design, int recursion_counter)
 642 {
 643         static char buffer[100];
 644         std::string str = "\n";
 645         if (recursion_counter > 1)
 646                 str += stringf("(%d) ", recursion_counter);
 647         str += "yosys";
 648         if (!design->selected_active_module.empty())
 649                 str += stringf(" [%s]", RTLIL::unescape_id(design->selected_active_module).c_str());
 650         if (!design->selection_stack.empty() && !design->selection_stack.back().full_selection) {
 651                 if (design->selected_active_module.empty())
 652                         str += "*";
 653                 else if (design->selection_stack.back().selected_modules.size() != 1 || design->selection_stack.back().selected_members.size() != 0 ||
 654                                 design->selection_stack.back().selected_modules.count(design->selected_active_module) == 0)
 655                         str += "*";
 656         }
 657         snprintf(buffer, 100, "%s> ", str.c_str());
 658         return buffer;
 659 }
 660
 661 std::vector<std::string> glob_filename(const std::string &filename_pattern)
 662 {
 663         std::vector<std::string> results;
 664
 665 #if defined(_WIN32) || !defined(YOSYS_ENABLE_GLOB)
 666         results.push_back(filename_pattern);
 667 #else
 668         glob_t globbuf;
 669
 670         int err = glob(filename_pattern.c_str(), 0, NULL, &globbuf);
 671
 672         if(err == 0) {
 673                 for (size_t i = 0; i < globbuf.gl_pathc; i++)
 674                         results.push_back(globbuf.gl_pathv[i]);
 675                 globfree(&globbuf);
 676         } else {
 677                 results.push_back(filename_pattern);
 678         }
 679 #endif
 680
 681         return results;
 682 }
 683
 684 void rewrite_filename(std::string &filename)
 685 {
 686         if (filename.compare(0, 1, "\"") == 0 && filename.compare(GetSize(filename)-1, std::string::npos, "\"") == 0)
 687                 filename = filename.substr(1, GetSize(filename)-2);
 688         if (filename.compare(0, 2, "+/") == 0)
 689                 filename = proc_share_dirname() + filename.substr(2);
 690 #ifndef _WIN32
 691         if (filename.compare(0, 2, "~/") == 0)
 692                 filename = filename.replace(0, 1, getenv("HOME"));
 693 #endif
 694 }
 695
 696 #ifdef YOSYS_ENABLE_TCL
 697 static int tcl_yosys_cmd(ClientData, Tcl_Interp *interp, int argc, const char *argv[])
 698 {
 699         std::vector<std::string> args;
 700         for (int i = 1; i < argc; i++)
 701                 args.push_back(argv[i]);
 702
 703         if (args.size() >= 1 && args[0] == "-import") {
 704                 for (auto &it : pass_register) {
 705                         std::string tcl_command_name = it.first;
 706                         if (tcl_command_name == "proc")
 707                                 tcl_command_name = "procs";
 708                         else if (tcl_command_name == "rename")
 709                                 tcl_command_name = "renames";
 710                         Tcl_CmdInfo info;
 711                         if (Tcl_GetCommandInfo(interp, tcl_command_name.c_str(), &info) != 0) {
 712                                 log("[TCL: yosys -import] Command name collision: found pre-existing command `%s' -> skip.\n", it.first.c_str());
 713                         } else {
 714                                 std::string tcl_script = stringf("proc %s args { yosys %s {*}$args }", tcl_command_name.c_str(), it.first.c_str());
 715                                 Tcl_Eval(interp, tcl_script.c_str());
 716                         }
 717                 }
 718                 return TCL_OK;
 719         }
 720
 721         if (args.size() == 1) {
 722                 Pass::call(yosys_get_design(), args[0]);
 723                 return TCL_OK;
 724         }
 725
 726         Pass::call(yosys_get_design(), args);
 727         return TCL_OK;
 728 }
 729
 730 extern Tcl_Interp *yosys_get_tcl_interp()
 731 {
 732         if (yosys_tcl_interp == NULL) {
 733                 yosys_tcl_interp = Tcl_CreateInterp();
 734                 Tcl_CreateCommand(yosys_tcl_interp, "yosys", tcl_yosys_cmd, NULL, NULL);
 735         }
 736         return yosys_tcl_interp;
 737 }
 738
 739 struct TclPass : public Pass {
 740         TclPass() : Pass("tcl", "execute a TCL script file") { }
 741         void help() YS_OVERRIDE {
 742                 //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
 743                 log("\n");
 744                 log("    tcl <filename> [args]\n");
 745                 log("\n");
 746                 log("This command executes the tcl commands in the specified file.\n");
 747                 log("Use 'yosys cmd' to run the yosys command 'cmd' from tcl.\n");
 748                 log("\n");
 749                 log("The tcl command 'yosys -import' can be used to import all yosys\n");
 750                 log("commands directly as tcl commands to the tcl shell. Yosys commands\n");
 751                 log("'proc' and 'rename' are wrapped to tcl commands 'procs' and 'renames'\n");
 752                 log("in order to avoid a name collision with the built in commands.\n");
 753                 log("\n");
 754                 log("If any arguments are specified, these arguments are provided to the script via\n");
 755                 log("the standard $argc and $argv variables.\n");
 756                 log("\n");
 757         }
 758         void execute(std::vector<std::string> args, RTLIL::Design *) YS_OVERRIDE {
 759                 if (args.size() < 2)
 760                         log_cmd_error("Missing script file.\n");
 761
 762                 std::vector<Tcl_Obj*> script_args;
 763                 for (auto it = args.begin() + 2; it != args.end(); ++it)
 764                         script_args.push_back(Tcl_NewStringObj((*it).c_str(), (*it).size()));
 765
 766                 Tcl_Interp *interp = yosys_get_tcl_interp();
 767                 Tcl_ObjSetVar2(interp, Tcl_NewStringObj("argc", 4), NULL, Tcl_NewIntObj(script_args.size()), 0);
 768                 Tcl_ObjSetVar2(interp, Tcl_NewStringObj("argv", 4), NULL, Tcl_NewListObj(script_args.size(), script_args.data()), 0);
 769                 Tcl_ObjSetVar2(interp, Tcl_NewStringObj("argv0", 5), NULL, Tcl_NewStringObj(args[1].c_str(), args[1].size()), 0);
 770                 if (Tcl_EvalFile(interp, args[1].c_str()) != TCL_OK)
 771                         log_cmd_error("TCL interpreter returned an error: %s\n", Tcl_GetStringResult(interp));
 772         }
 773 } TclPass;
 774 #endif
 775
 776 #if defined(__linux__) || defined(__CYGWIN__)
 777 std::string proc_self_dirname()
 778 {
 779         char path[PATH_MAX];
 780         ssize_t buflen = readlink("/proc/self/exe", path, sizeof(path));
 781         if (buflen < 0) {
 782                 log_error("readlink(\"/proc/self/exe\") failed: %s\n", strerror(errno));
 783         }
 784         while (buflen > 0 && path[buflen-1] != '/')
 785                 buflen--;
 786         return std::string(path, buflen);
 787 }
 788 #elif defined(__FreeBSD__)
 789 std::string proc_self_dirname()
 790 {
 791         int mib[4] = {CTL_KERN, KERN_PROC, KERN_PROC_PATHNAME, -1};
 792         size_t buflen;
 793         char *buffer;
 794         std::string path;
 795         if (sysctl(mib, 4, NULL, &buflen, NULL, 0) != 0)
 796                 log_error("sysctl failed: %s\n", strerror(errno));
 797         buffer = (char*)malloc(buflen);
 798         if (buffer == NULL)
 799                 log_error("malloc failed: %s\n", strerror(errno));
 800         if (sysctl(mib, 4, buffer, &buflen, NULL, 0) != 0)
 801                 log_error("sysctl failed: %s\n", strerror(errno));
 802         while (buflen > 0 && buffer[buflen-1] != '/')
 803                 buflen--;
 804         path.assign(buffer, buflen);
 805         free(buffer);
 806         return path;
 807 }
 808 #elif defined(__APPLE__)
 809 std::string proc_self_dirname()
 810 {
 811         char *path = NULL;
 812         uint32_t buflen = 0;
 813         while (_NSGetExecutablePath(path, &buflen) != 0)
 814                 path = (char *) realloc((void *) path, buflen);
 815         while (buflen > 0 && path[buflen-1] != '/')
 816                 buflen--;
 817         return std::string(path, buflen);
 818 }
 819 #elif defined(_WIN32)
 820 std::string proc_self_dirname()
 821 {
 822         int i = 0;
 823 #  ifdef __MINGW32__
 824         char longpath[MAX_PATH + 1];
 825         char shortpath[MAX_PATH + 1];
 826 #  else
 827         WCHAR longpath[MAX_PATH + 1];
 828         TCHAR shortpath[MAX_PATH + 1];
 829 #  endif
 830         if (!GetModuleFileName(0, longpath, MAX_PATH+1))
 831                 log_error("GetModuleFileName() failed.\n");
 832         if (!GetShortPathName(longpath, shortpath, MAX_PATH+1))
 833                 log_error("GetShortPathName() failed.\n");
 834         while (shortpath[i] != 0)
 835                 i++;
 836         while (i > 0 && shortpath[i-1] != '/' && shortpath[i-1] != '\\')
 837                 shortpath[--i] = 0;
 838         std::string path;
 839         for (i = 0; shortpath[i]; i++)
 840                 path += char(shortpath[i]);
 841         return path;
 842 }
 843 #elif defined(EMSCRIPTEN)
 844 std::string proc_self_dirname()
 845 {
 846         return "/";
 847 }
 848 #else
 849         #error "Don't know how to determine process executable base path!"
 850 #endif
 851
 852 #ifdef EMSCRIPTEN
 853 std::string proc_share_dirname()
 854 {
 855         return "/share/";
 856 }
 857 #else
 858 std::string proc_share_dirname()
 859 {
 860         std::string proc_self_path = proc_self_dirname();
 861 #  if defined(_WIN32) && !defined(YOSYS_WIN32_UNIX_DIR)
 862         std::string proc_share_path = proc_self_path + "share\\";
 863         if (check_file_exists(proc_share_path, true))
 864                 return proc_share_path;
 865         proc_share_path = proc_self_path + "..\\share\\";
 866         if (check_file_exists(proc_share_path, true))
 867                 return proc_share_path;
 868 #  else
 869         std::string proc_share_path = proc_self_path + "share/";
 870         if (check_file_exists(proc_share_path, true))
 871                 return proc_share_path;
 872         proc_share_path = proc_self_path + "../share/yosys/";
 873         if (check_file_exists(proc_share_path, true))
 874                 return proc_share_path;
 875 #    ifdef YOSYS_DATDIR
 876         proc_share_path = YOSYS_DATDIR "/";
 877         if (check_file_exists(proc_share_path, true))
 878                 return proc_share_path;
 879 #    endif
 880 #  endif
 881         log_error("proc_share_dirname: unable to determine share/ directory!\n");
 882 }
 883 #endif
 884
 885 bool fgetline(FILE *f, std::string &buffer)
 886 {
 887         buffer = "";
 888         char block[4096];
 889         while (1) {
 890                 if (fgets(block, 4096, f) == NULL)
 891                         return false;
 892                 buffer += block;
 893                 if (buffer.size() > 0 && (buffer[buffer.size()-1] == '\n' ||  buffer[buffer.size()-1] == '\r')) {
 894                         while (buffer.size() > 0 && (buffer[buffer.size()-1] == '\n' ||  buffer[buffer.size()-1] == '\r'))
 895                                 buffer.resize(buffer.size()-1);
 896                         return true;
 897                 }
 898         }
 899 }
 900
 901 static void handle_label(std::string &command, bool &from_to_active, const std::string &run_from, const std::string &run_to)
 902 {
 903         int pos = 0;
 904         std::string label;
 905
 906         while (pos < GetSize(command) && (command[pos] == ' ' || command[pos] == '\t'))
 907                 pos++;
 908
 909         if (pos < GetSize(command) && command[pos] == '#')
 910                 return;
 911
 912         while (pos < GetSize(command) && command[pos] != ' ' && command[pos] != '\t' && command[pos] != '\r' && command[pos] != '\n')
 913                 label += command[pos++];
 914
 915         if (GetSize(label) > 1 && label.back() == ':')
 916         {
 917                 label = label.substr(0, GetSize(label)-1);
 918                 command = command.substr(pos);
 919
 920                 if (label == run_from)
 921                         from_to_active = true;
 922                 else if (label == run_to || (run_from == run_to && !run_from.empty()))
 923                         from_to_active = false;
 924         }
 925 }
 926
 927 void run_frontend(std::string filename, std::string command, std::string *backend_command, std::string *from_to_label, RTLIL::Design *design)
 928 {
 929         if (design == nullptr)
 930                 design = yosys_design;
 931
 932         if (command == "auto") {
 933                 std::string filename_trim = filename;
 934                 if (filename_trim.size() > 3 && filename_trim.compare(filename_trim.size()-3, std::string::npos, ".gz") == 0)
 935                         filename_trim.erase(filename_trim.size()-3);
 936                 if (filename_trim.size() > 2 && filename_trim.compare(filename_trim.size()-2, std::string::npos, ".v") == 0)
 937                         command = "verilog";
 938                 else if (filename_trim.size() > 2 && filename_trim.compare(filename_trim.size()-3, std::string::npos, ".sv") == 0)
 939                         command = "verilog -sv";
 940                 else if (filename_trim.size() > 3 && filename_trim.compare(filename_trim.size()-4, std::string::npos, ".vhd") == 0)
 941                         command = "vhdl";
 942                 else if (filename_trim.size() > 4 && filename_trim.compare(filename_trim.size()-5, std::string::npos, ".blif") == 0)
 943                         command = "blif";
 944                 else if (filename_trim.size() > 5 && filename_trim.compare(filename_trim.size()-6, std::string::npos, ".eblif") == 0)
 945                         command = "blif";
 946                 else if (filename_trim.size() > 4 && filename_trim.compare(filename_trim.size()-5, std::string::npos, ".json") == 0)
 947                         command = "json";
 948                 else if (filename_trim.size() > 3 && filename_trim.compare(filename_trim.size()-3, std::string::npos, ".il") == 0)
 949                         command = "ilang";
 950                 else if (filename_trim.size() > 3 && filename_trim.compare(filename_trim.size()-3, std::string::npos, ".ys") == 0)
 951                         command = "script";
 952                 else if (filename_trim.size() > 3 && filename_trim.compare(filename_trim.size()-4, std::string::npos, ".tcl") == 0)
 953                         command = "tcl";
 954                 else if (filename == "-")
 955                         command = "script";
 956                 else
 957                         log_error("Can't guess frontend for input file `%s' (missing -f option)!\n", filename.c_str());
 958         }
 959
 960         if (command == "script")
 961         {
 962                 std::string run_from, run_to;
 963                 bool from_to_active = true;
 964
 965                 if (from_to_label != NULL) {
 966                         size_t pos = from_to_label->find(':');
 967                         if (pos == std::string::npos) {
 968                                 run_from = *from_to_label;
 969                                 run_to = *from_to_label;
 970                         } else {
 971                                 run_from = from_to_label->substr(0, pos);
 972                                 run_to = from_to_label->substr(pos+1);
 973                         }
 974                         from_to_active = run_from.empty();
 975                 }
 976
 977                 log("\n-- Executing script file `%s' --\n", filename.c_str());
 978
 979                 FILE *f = stdin;
 980
 981                 if (filename != "-") {
 982                         f = fopen(filename.c_str(), "r");
 983                         yosys_input_files.insert(filename);
 984                 }
 985
 986                 if (f == NULL)
 987                         log_error("Can't open script file `%s' for reading: %s\n", filename.c_str(), strerror(errno));
 988
 989                 FILE *backup_script_file = Frontend::current_script_file;
 990                 Frontend::current_script_file = f;
 991
 992                 try {
 993                         std::string command;
 994                         while (fgetline(f, command)) {
 995                                 while (!command.empty() && command[command.size()-1] == '\\') {
 996                                         std::string next_line;
 997                                         if (!fgetline(f, next_line))
 998                                                 break;
 999                                         command.resize(command.size()-1);
1000                                         command += next_line;
1001                                 }
1002                                 handle_label(command, from_to_active, run_from, run_to);
1003                                 if (from_to_active) {
1004                                         Pass::call(design, command);
1005                                         design->check();
1006                                 }
1007                         }
1008
1009                         if (!command.empty()) {
1010                                 handle_label(command, from_to_active, run_from, run_to);
1011                                 if (from_to_active) {
1012                                         Pass::call(design, command);
1013                                         design->check();
1014                                 }
1015                         }
1016                 }
1017                 catch (...) {
1018                         Frontend::current_script_file = backup_script_file;
1019                         throw;
1020                 }
1021
1022                 Frontend::current_script_file = backup_script_file;
1023
1024                 if (filename != "-")
1025                         fclose(f);
1026
1027                 if (backend_command != NULL && *backend_command == "auto")
1028                         *backend_command = "";
1029
1030                 return;
1031         }
1032
1033         if (filename == "-") {
1034                 log("\n-- Parsing stdin using frontend `%s' --\n", command.c_str());
1035         } else {
1036                 log("\n-- Parsing `%s' using frontend `%s' --\n", filename.c_str(), command.c_str());
1037         }
1038
1039         if (command == "tcl")
1040                 Pass::call(design, vector<string>({command, filename}));
1041         else
1042                 Frontend::frontend_call(design, NULL, filename, command);
1043         design->check();
1044 }
1045
1046 void run_frontend(std::string filename, std::string command, RTLIL::Design *design)
1047 {
1048         run_frontend(filename, command, nullptr, nullptr, design);
1049 }
1050
1051 void run_pass(std::string command, RTLIL::Design *design)
1052 {
1053         if (design == nullptr)
1054                 design = yosys_design;
1055
1056         log("\n-- Running command `%s' --\n", command.c_str());
1057
1058         Pass::call(design, command);
1059 }
1060
1061 void run_backend(std::string filename, std::string command, RTLIL::Design *design)
1062 {
1063         if (design == nullptr)
1064                 design = yosys_design;
1065
1066         if (command == "auto") {
1067                 if (filename.size() > 2 && filename.compare(filename.size()-2, std::string::npos, ".v") == 0)
1068                         command = "verilog";
1069                 else if (filename.size() > 3 && filename.compare(filename.size()-3, std::string::npos, ".il") == 0)
1070                         command = "ilang";
1071                 else if (filename.size() > 4 && filename.compare(filename.size()-4, std::string::npos, ".aig") == 0)
1072                         command = "aiger";
1073                 else if (filename.size() > 5 && filename.compare(filename.size()-5, std::string::npos, ".blif") == 0)
1074                         command = "blif";
1075                 else if (filename.size() > 5 && filename.compare(filename.size()-5, std::string::npos, ".edif") == 0)
1076                         command = "edif";
1077                 else if (filename.size() > 5 && filename.compare(filename.size()-5, std::string::npos, ".json") == 0)
1078                         command = "json";
1079                 else if (filename == "-")
1080                         command = "ilang";
1081                 else if (filename.empty())
1082                         return;
1083                 else
1084                         log_error("Can't guess backend for output file `%s' (missing -b option)!\n", filename.c_str());
1085         }
1086
1087         if (filename.empty())
1088                 filename = "-";
1089
1090         if (filename == "-") {
1091                 log("\n-- Writing to stdout using backend `%s' --\n", command.c_str());
1092         } else {
1093                 log("\n-- Writing to `%s' using backend `%s' --\n", filename.c_str(), command.c_str());
1094         }
1095
1096         Backend::backend_call(design, NULL, filename, command);
1097 }
1098
1099 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1100 static char *readline_cmd_generator(const char *text, int state)
1101 {
1102         static std::map<std::string, Pass*>::iterator it;
1103         static int len;
1104
1105         if (!state) {
1106                 it = pass_register.begin();
1107                 len = strlen(text);
1108         }
1109
1110         for (; it != pass_register.end(); it++) {
1111                 if (it->first.compare(0, len, text) == 0)
1112                         return strdup((it++)->first.c_str());
1113         }
1114         return NULL;
1115 }
1116
1117 static char *readline_obj_generator(const char *text, int state)
1118 {
1119         static std::vector<char*> obj_names;
1120         static size_t idx;
1121
1122         if (!state)
1123         {
1124                 idx = 0;
1125                 obj_names.clear();
1126
1127                 RTLIL::Design *design = yosys_get_design();
1128                 int len = strlen(text);
1129
1130                 if (design->selected_active_module.empty())
1131                 {
1132                         for (auto &it : design->modules_)
1133                                 if (RTLIL::unescape_id(it.first).compare(0, len, text) == 0)
1134                                         obj_names.push_back(strdup(RTLIL::id2cstr(it.first)));
1135                 }
1136                 else
1137                 if (design->modules_.count(design->selected_active_module) > 0)
1138                 {
1139                         RTLIL::Module *module = design->modules_.at(design->selected_active_module);
1140
1141                         for (auto &it : module->wires_)
1142                                 if (RTLIL::unescape_id(it.first).compare(0, len, text) == 0)
1143                                         obj_names.push_back(strdup(RTLIL::id2cstr(it.first)));
1144
1145                         for (auto &it : module->memories)
1146                                 if (RTLIL::unescape_id(it.first).compare(0, len, text) == 0)
1147                                         obj_names.push_back(strdup(RTLIL::id2cstr(it.first)));
1148
1149                         for (auto &it : module->cells_)
1150                                 if (RTLIL::unescape_id(it.first).compare(0, len, text) == 0)
1151                                         obj_names.push_back(strdup(RTLIL::id2cstr(it.first)));
1152
1153                         for (auto &it : module->processes)
1154                                 if (RTLIL::unescape_id(it.first).compare(0, len, text) == 0)
1155                                         obj_names.push_back(strdup(RTLIL::id2cstr(it.first)));
1156                 }
1157
1158                 std::sort(obj_names.begin(), obj_names.end());
1159         }
1160
1161         if (idx < obj_names.size())
1162                 return strdup(obj_names[idx++]);
1163
1164         idx = 0;
1165         obj_names.clear();
1166         return NULL;
1167 }
1168
1169 static char **readline_completion(const char *text, int start, int)
1170 {
1171         if (start == 0)
1172                 return rl_completion_matches(text, readline_cmd_generator);
1173         if (strncmp(rl_line_buffer, "read_", 5) && strncmp(rl_line_buffer, "write_", 6))
1174                 return rl_completion_matches(text, readline_obj_generator);
1175         return NULL;
1176 }
1177 #endif
1178
1179 void shell(RTLIL::Design *design)
1180 {
1181         static int recursion_counter = 0;
1182
1183         recursion_counter++;
1184         log_cmd_error_throw = true;
1185
1186 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1187         rl_readline_name = (char*)"yosys";
1188         rl_attempted_completion_function = readline_completion;
1189         rl_basic_word_break_characters = (char*)" \t\n";
1190 #endif
1191
1192         char *command = NULL;
1193 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1194         while ((command = readline(create_prompt(design, recursion_counter))) != NULL)
1195         {
1196 #else
1197         char command_buffer[4096];
1198         while (1)
1199         {
1200                 fputs(create_prompt(design, recursion_counter), stdout);
1201                 fflush(stdout);
1202                 if ((command = fgets(command_buffer, 4096, stdin)) == NULL)
1203                         break;
1204 #endif
1205                 if (command[strspn(command, " \t\r\n")] == 0)
1206                         continue;
1207 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1208                 add_history(command);
1209 #endif
1210
1211                 char *p = command + strspn(command, " \t\r\n");
1212                 if (!strncmp(p, "exit", 4)) {
1213                         p += 4;
1214                         p += strspn(p, " \t\r\n");
1215                         if (*p == 0)
1216                                 break;
1217                 }
1218
1219                 try {
1220                         log_assert(design->selection_stack.size() == 1);
1221                         Pass::call(design, command);
1222                 } catch (log_cmd_error_exception) {
1223                         while (design->selection_stack.size() > 1)
1224                                 design->selection_stack.pop_back();
1225                         log_reset_stack();
1226                 }
1227                 design->check();
1228         }
1229         if (command == NULL)
1230                 printf("exit\n");
1231
1232         recursion_counter--;
1233         log_cmd_error_throw = false;
1234 }
1235
1236 struct ShellPass : public Pass {
1237         ShellPass() : Pass("shell", "enter interactive command mode") { }
1238         void help() YS_OVERRIDE {
1239                 log("\n");
1240                 log("    shell\n");
1241                 log("\n");
1242                 log("This command enters the interactive command mode. This can be useful\n");
1243                 log("in a script to interrupt the script at a certain point and allow for\n");
1244                 log("interactive inspection or manual synthesis of the design at this point.\n");
1245                 log("\n");
1246                 log("The command prompt of the interactive shell indicates the current\n");
1247                 log("selection (see 'help select'):\n");
1248                 log("\n");
1249                 log("    yosys>\n");
1250                 log("        the entire design is selected\n");
1251                 log("\n");
1252                 log("    yosys*>\n");
1253                 log("        only part of the design is selected\n");
1254                 log("\n");
1255                 log("    yosys [modname]>\n");
1256                 log("        the entire module 'modname' is selected using 'select -module modname'\n");
1257                 log("\n");
1258                 log("    yosys [modname]*>\n");
1259                 log("        only part of current module 'modname' is selected\n");
1260                 log("\n");
1261                 log("When in interactive shell, some errors (e.g. invalid command arguments)\n");
1262                 log("do not terminate yosys but return to the command prompt.\n");
1263                 log("\n");
1264                 log("This command is the default action if nothing else has been specified\n");
1265                 log("on the command line.\n");
1266                 log("\n");
1267                 log("Press Ctrl-D or type 'exit' to leave the interactive shell.\n");
1268                 log("\n");
1269         }
1270         void execute(std::vector<std::string> args, RTLIL::Design *design) YS_OVERRIDE {
1271                 extra_args(args, 1, design, false);
1272                 shell(design);
1273         }
1274 } ShellPass;
1275
1276 #if defined(YOSYS_ENABLE_READLINE) || defined(YOSYS_ENABLE_EDITLINE)
1277 struct HistoryPass : public Pass {
1278         HistoryPass() : Pass("history", "show last interactive commands") { }
1279         void help() YS_OVERRIDE {
1280                 log("\n");
1281                 log("    history\n");
1282                 log("\n");
1283                 log("This command prints all commands in the shell history buffer. This are\n");
1284                 log("all commands executed in an interactive session, but not the commands\n");
1285                 log("from executed scripts.\n");
1286                 log("\n");
1287         }
1288         void execute(std::vector<std::string> args, RTLIL::Design *design) YS_OVERRIDE {
1289                 extra_args(args, 1, design, false);
1290 #ifdef YOSYS_ENABLE_READLINE
1291                 for(HIST_ENTRY **list = history_list(); *list != NULL; list++)
1292                         log("%s\n", (*list)->line);
1293 #else
1294                 for (int i = where_history(); history_get(i); i++)
1295                         log("%s\n", history_get(i)->line);
1296 #endif
1297         }
1298 } HistoryPass;
1299 #endif
1300
1301 struct ScriptCmdPass : public Pass {
1302         ScriptCmdPass() : Pass("script", "execute commands from file or wire") { }
1303         void help() YS_OVERRIDE {
1304                 //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
1305                 log("\n");
1306                 log("    script <filename> [<from_label>:<to_label>]\n");
1307                 log("    script -scriptwire [selection]\n");
1308                 log("\n");
1309                 log("This command executes the yosys commands in the specified file (default\n");
1310                 log("behaviour), or commands embedded in the constant text value connected to the\n");
1311                 log("selected wires.\n");
1312                 log("\n");
1313                 log("In the default (file) case, the 2nd argument can be used to only execute the\n");
1314                 log("section of the file between the specified labels. An empty from label is\n");
1315                 log("synonymous with the beginning of the file and an empty to label is synonymous\n");
1316                 log("with the end of the file.\n");
1317                 log("\n");
1318                 log("If only one label is specified (without ':') then only the block\n");
1319                 log("marked with that label (until the next label) is executed.\n");
1320                 log("\n");
1321                 log("In \"-scriptwire\" mode, the commands on the selected wire(s) will be executed\n");
1322                 log("in the scope of (and thus, relative to) the wires' owning module(s). This\n");
1323                 log("'-module' mode can be exited by using the 'cd' command.\n");
1324                 log("\n");
1325         }
1326         void execute(std::vector<std::string> args, RTLIL::Design *design) YS_OVERRIDE
1327         {
1328                 bool scriptwire = false;
1329
1330                 size_t argidx;
1331                 for (argidx = 1; argidx < args.size(); argidx++) {
1332                         if (args[argidx] == "-scriptwire") {
1333                                 scriptwire = true;
1334                                 continue;
1335                         }
1336                         break;
1337                 }
1338                 if (scriptwire) {
1339                         extra_args(args, argidx, design);
1340
1341                         for (auto mod : design->selected_modules())
1342                                 for (auto &c : mod->connections()) {
1343                                         if (!c.first.is_wire())
1344                                                 continue;
1345                                         auto w = c.first.as_wire();
1346                                         if (!mod->selected(w))
1347                                                 continue;
1348                                         if (!c.second.is_fully_const())
1349                                                 log_error("RHS of selected wire %s.%s is not constant.\n", log_id(mod), log_id(w));
1350                                         auto v = c.second.as_const();
1351                                         Pass::call_on_module(design, mod, v.decode_string());
1352                                 }
1353                 }
1354                 else if (args.size() < 2)
1355                         log_cmd_error("Missing script file.\n");
1356                 else if (args.size() == 2)
1357                         run_frontend(args[1], "script", design);
1358                 else if (args.size() == 3)
1359                         run_frontend(args[1], "script", NULL, &args[2], design);
1360                 else
1361                         extra_args(args, 2, design, false);
1362         }
1363 } ScriptCmdPass;
1364
1365 YOSYS_NAMESPACE_END