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