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