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