kernel/register.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/satgen.h"
  22
  23 #include <string.h>
  24 #include <stdlib.h>
  25 #include <stdio.h>
  26 #include <errno.h>
  27
  28 #ifdef YOSYS_ENABLE_ZLIB
  29 #include <zlib.h>
  30
  31 PRIVATE_NAMESPACE_BEGIN
  32 #define GZ_BUFFER_SIZE 8192
  33 void decompress_gzip(const std::string &filename, std::stringstream &out)
  34 {
  35         char buffer[GZ_BUFFER_SIZE];
  36         int bytes_read;
  37         gzFile gzf = gzopen(filename.c_str(), "rb");
  38         while(!gzeof(gzf)) {
  39                 bytes_read = gzread(gzf, reinterpret_cast<void *>(buffer), GZ_BUFFER_SIZE);
  40                 out.write(buffer, bytes_read);
  41         }
  42         gzclose(gzf);
  43 }
  44
  45 /*
  46 An output stream that uses a stringbuf to buffer data internally,
  47 using zlib to write gzip-compressed data every time the stream is flushed.
  48 */
  49 class gzip_ostream : public std::ostream  {
  50 public:
  51         gzip_ostream() : std::ostream(nullptr)
  52         {
  53                 rdbuf(&outbuf);
  54         }
  55         bool open(const std::string &filename)
  56         {
  57                 return outbuf.open(filename);
  58         }
  59 private:
  60         class gzip_streambuf : public std::stringbuf {
  61         public:
  62                 gzip_streambuf() { };
  63                 bool open(const std::string &filename)
  64                 {
  65                         gzf = gzopen(filename.c_str(), "wb");
  66                         return gzf != nullptr;
  67                 }
  68                 virtual int sync() override
  69                 {
  70                         gzwrite(gzf, reinterpret_cast<const void *>(str().c_str()), unsigned(str().size()));
  71                         str("");
  72                         return 0;
  73                 }
  74                 virtual ~gzip_streambuf()
  75                 {
  76                         sync();
  77                         gzclose(gzf);
  78                 }
  79         private:
  80                 gzFile gzf = nullptr;
  81         } outbuf;
  82 };
  83 PRIVATE_NAMESPACE_END
  84
  85 #endif
  86
  87 YOSYS_NAMESPACE_BEGIN
  88
  89 #define MAX_REG_COUNT 1000
  90
  91 bool echo_mode = false;
  92 Pass *first_queued_pass;
  93 Pass *current_pass;
  94
  95 std::map<std::string, Frontend*> frontend_register;
  96 std::map<std::string, Pass*> pass_register;
  97 std::map<std::string, Backend*> backend_register;
  98
  99 std::vector<std::string> Frontend::next_args;
 100
 101 Pass::Pass(std::string name, std::string short_help) : pass_name(name), short_help(short_help)
 102 {
 103         next_queued_pass = first_queued_pass;
 104         first_queued_pass = this;
 105         call_counter = 0;
 106         runtime_ns = 0;
 107 }
 108
 109 void Pass::run_register()
 110 {
 111         log_assert(pass_register.count(pass_name) == 0);
 112         pass_register[pass_name] = this;
 113 }
 114
 115 void Pass::init_register()
 116 {
 117         vector<Pass*> added_passes;
 118         while (first_queued_pass) {
 119                 added_passes.push_back(first_queued_pass);
 120                 first_queued_pass->run_register();
 121                 first_queued_pass = first_queued_pass->next_queued_pass;
 122         }
 123         for (auto added_pass : added_passes)
 124                 added_pass->on_register();
 125 }
 126
 127 void Pass::done_register()
 128 {
 129         for (auto &it : pass_register)
 130                 it.second->on_shutdown();
 131
 132         frontend_register.clear();
 133         pass_register.clear();
 134         backend_register.clear();
 135         log_assert(first_queued_pass == NULL);
 136 }
 137
 138 void Pass::on_register()
 139 {
 140 }
 141
 142 void Pass::on_shutdown()
 143 {
 144 }
 145
 146 Pass::~Pass()
 147 {
 148 }
 149
 150 Pass::pre_post_exec_state_t Pass::pre_execute()
 151 {
 152         pre_post_exec_state_t state;
 153         call_counter++;
 154         state.begin_ns = PerformanceTimer::query();
 155         state.parent_pass = current_pass;
 156         current_pass = this;
 157         clear_flags();
 158         return state;
 159 }
 160
 161 void Pass::post_execute(Pass::pre_post_exec_state_t state)
 162 {
 163         IdString::checkpoint();
 164         log_suppressed();
 165
 166         int64_t time_ns = PerformanceTimer::query() - state.begin_ns;
 167         runtime_ns += time_ns;
 168         current_pass = state.parent_pass;
 169         if (current_pass)
 170                 current_pass->runtime_ns -= time_ns;
 171 }
 172
 173 void Pass::help()
 174 {
 175         log("\n");
 176         log("No help message for command `%s'.\n", pass_name.c_str());
 177         log("\n");
 178 }
 179
 180 void Pass::clear_flags()
 181 {
 182 }
 183
 184 void Pass::cmd_log_args(const std::vector<std::string> &args)
 185 {
 186         if (args.size() <= 1)
 187                 return;
 188         log("Full command line:");
 189         for (size_t i = 0; i < args.size(); i++)
 190                 log(" %s", args[i].c_str());
 191         log("\n");
 192 }
 193
 194 void Pass::cmd_error(const std::vector<std::string> &args, size_t argidx, std::string msg)
 195 {
 196         std::string command_text;
 197         int error_pos = 0;
 198
 199         for (size_t i = 0; i < args.size(); i++) {
 200                 if (i < argidx)
 201                         error_pos += args[i].size() + 1;
 202                 command_text = command_text + (command_text.empty() ? "" : " ") + args[i];
 203         }
 204
 205         log("\nSyntax error in command `%s':\n", command_text.c_str());
 206         help();
 207
 208         log_cmd_error("Command syntax error: %s\n> %s\n> %*s^\n",
 209                         msg.c_str(), command_text.c_str(), error_pos, "");
 210 }
 211
 212 void Pass::extra_args(std::vector<std::string> args, size_t argidx, RTLIL::Design *design, bool select)
 213 {
 214         for (; argidx < args.size(); argidx++)
 215         {
 216                 std::string arg = args[argidx];
 217
 218                 if (arg.compare(0, 1, "-") == 0)
 219                         cmd_error(args, argidx, "Unknown option or option in arguments.");
 220
 221                 if (!select)
 222                         cmd_error(args, argidx, "Extra argument.");
 223
 224                 handle_extra_select_args(this, args, argidx, args.size(), design);
 225                 break;
 226         }
 227         // cmd_log_args(args);
 228 }
 229
 230 void Pass::call(RTLIL::Design *design, std::string command)
 231 {
 232         std::vector<std::string> args;
 233
 234         std::string cmd_buf = command;
 235         std::string tok = next_token(cmd_buf, " \t\r\n", true);
 236
 237         if (tok.empty())
 238                 return;
 239
 240         if (tok[0] == '!') {
 241                 cmd_buf = command.substr(command.find('!') + 1);
 242                 while (!cmd_buf.empty() && (cmd_buf.back() == ' ' || cmd_buf.back() == '\t' ||
 243                                 cmd_buf.back() == '\r' || cmd_buf.back() == '\n'))
 244                         cmd_buf.resize(cmd_buf.size()-1);
 245                 log_header(design, "Shell command: %s\n", cmd_buf.c_str());
 246                 int retCode = run_command(cmd_buf);
 247                 if (retCode != 0)
 248                         log_cmd_error("Shell command returned error code %d.\n", retCode);
 249                 return;
 250         }
 251
 252         while (!tok.empty()) {
 253                 if (tok[0] == '#') {
 254                         int stop;
 255                         for (stop = 0; stop < GetSize(cmd_buf); stop++)
 256                                 if (cmd_buf[stop] == '\r' || cmd_buf[stop] == '\n')
 257                                         break;
 258                         cmd_buf = cmd_buf.substr(stop);
 259                 } else
 260                 if (tok.back() == ';') {
 261                         int num_semikolon = 0;
 262                         while (!tok.empty() && tok.back() == ';')
 263                                 tok.resize(tok.size()-1), num_semikolon++;
 264                         if (!tok.empty())
 265                                 args.push_back(tok);
 266                         call(design, args);
 267                         args.clear();
 268                         if (num_semikolon == 2)
 269                                 call(design, "clean");
 270                         if (num_semikolon == 3)
 271                                 call(design, "clean -purge");
 272                 } else
 273                         args.push_back(tok);
 274                 bool found_nl = false;
 275                 for (auto c : cmd_buf) {
 276                         if (c == ' ' || c == '\t')
 277                                 continue;
 278                         if (c == '\r' || c == '\n')
 279                                 found_nl = true;
 280                         break;
 281                 }
 282                 if (found_nl) {
 283                         call(design, args);
 284                         args.clear();
 285                 }
 286                 tok = next_token(cmd_buf, " \t\r\n", true);
 287         }
 288
 289         call(design, args);
 290 }
 291
 292 void Pass::call(RTLIL::Design *design, std::vector<std::string> args)
 293 {
 294         if (args.size() == 0 || args[0][0] == '#' || args[0][0] == ':')
 295                 return;
 296
 297         if (echo_mode) {
 298                 log("%s", create_prompt(design, 0));
 299                 for (size_t i = 0; i < args.size(); i++)
 300                         log("%s%s", i ? " " : "", args[i].c_str());
 301                 log("\n");
 302         }
 303
 304         if (pass_register.count(args[0]) == 0)
 305                 log_cmd_error("No such command: %s (type 'help' for a command overview)\n", args[0].c_str());
 306
 307         if (pass_register[args[0]]->experimental_flag)
 308                 log_experimental("%s", args[0].c_str());
 309
 310         size_t orig_sel_stack_pos = design->selection_stack.size();
 311         auto state = pass_register[args[0]]->pre_execute();
 312         pass_register[args[0]]->execute(args, design);
 313         pass_register[args[0]]->post_execute(state);
 314         while (design->selection_stack.size() > orig_sel_stack_pos)
 315                 design->selection_stack.pop_back();
 316 }
 317
 318 void Pass::call_on_selection(RTLIL::Design *design, const RTLIL::Selection &selection, std::string command)
 319 {
 320         std::string backup_selected_active_module = design->selected_active_module;
 321         design->selected_active_module.clear();
 322         design->selection_stack.push_back(selection);
 323
 324         Pass::call(design, command);
 325
 326         design->selection_stack.pop_back();
 327         design->selected_active_module = backup_selected_active_module;
 328 }
 329
 330 void Pass::call_on_selection(RTLIL::Design *design, const RTLIL::Selection &selection, std::vector<std::string> args)
 331 {
 332         std::string backup_selected_active_module = design->selected_active_module;
 333         design->selected_active_module.clear();
 334         design->selection_stack.push_back(selection);
 335
 336         Pass::call(design, args);
 337
 338         design->selection_stack.pop_back();
 339         design->selected_active_module = backup_selected_active_module;
 340 }
 341
 342 void Pass::call_on_module(RTLIL::Design *design, RTLIL::Module *module, std::string command)
 343 {
 344         std::string backup_selected_active_module = design->selected_active_module;
 345         design->selected_active_module = module->name.str();
 346         design->selection_stack.push_back(RTLIL::Selection(false));
 347         design->selection_stack.back().select(module);
 348
 349         Pass::call(design, command);
 350
 351         design->selection_stack.pop_back();
 352         design->selected_active_module = backup_selected_active_module;
 353 }
 354
 355 void Pass::call_on_module(RTLIL::Design *design, RTLIL::Module *module, std::vector<std::string> args)
 356 {
 357         std::string backup_selected_active_module = design->selected_active_module;
 358         design->selected_active_module = module->name.str();
 359         design->selection_stack.push_back(RTLIL::Selection(false));
 360         design->selection_stack.back().select(module);
 361
 362         Pass::call(design, args);
 363
 364         design->selection_stack.pop_back();
 365         design->selected_active_module = backup_selected_active_module;
 366 }
 367
 368 bool ScriptPass::check_label(std::string label, std::string info)
 369 {
 370         if (active_design == nullptr) {
 371                 log("\n");
 372                 if (info.empty())
 373                         log("    %s:\n", label.c_str());
 374                 else
 375                         log("    %s:    %s\n", label.c_str(), info.c_str());
 376                 return true;
 377         } else {
 378                 if (!active_run_from.empty() && active_run_from == active_run_to) {
 379                         block_active = (label == active_run_from);
 380                 } else {
 381                         if (label == active_run_from)
 382                                 block_active = true;
 383                         if (label == active_run_to)
 384                                 block_active = false;
 385                 }
 386                 return block_active;
 387         }
 388 }
 389
 390 void ScriptPass::run(std::string command, std::string info)
 391 {
 392         if (active_design == nullptr) {
 393                 if (info.empty())
 394                         log("        %s\n", command.c_str());
 395                 else
 396                         log("        %s    %s\n", command.c_str(), info.c_str());
 397         } else {
 398                 Pass::call(active_design, command);
 399                 active_design->check();
 400         }
 401 }
 402
 403 void ScriptPass::run_nocheck(std::string command, std::string info)
 404 {
 405         if (active_design == nullptr) {
 406                 if (info.empty())
 407                         log("        %s\n", command.c_str());
 408                 else
 409                         log("        %s    %s\n", command.c_str(), info.c_str());
 410         } else {
 411                 Pass::call(active_design, command);
 412         }
 413 }
 414
 415 void ScriptPass::run_script(RTLIL::Design *design, std::string run_from, std::string run_to)
 416 {
 417         help_mode = false;
 418         active_design = design;
 419         block_active = run_from.empty();
 420         active_run_from = run_from;
 421         active_run_to = run_to;
 422         script();
 423 }
 424
 425 void ScriptPass::help_script()
 426 {
 427         clear_flags();
 428         help_mode = true;
 429         active_design = nullptr;
 430         block_active = true;
 431         active_run_from.clear();
 432         active_run_to.clear();
 433         script();
 434 }
 435
 436 Frontend::Frontend(std::string name, std::string short_help) :
 437                 Pass(name.rfind("=", 0) == 0 ? name.substr(1) : "read_" + name, short_help),
 438                 frontend_name(name.rfind("=", 0) == 0 ? name.substr(1) : name)
 439 {
 440 }
 441
 442 void Frontend::run_register()
 443 {
 444         log_assert(pass_register.count(pass_name) == 0);
 445         pass_register[pass_name] = this;
 446
 447         log_assert(frontend_register.count(frontend_name) == 0);
 448         frontend_register[frontend_name] = this;
 449 }
 450
 451 Frontend::~Frontend()
 452 {
 453 }
 454
 455 void Frontend::execute(std::vector<std::string> args, RTLIL::Design *design)
 456 {
 457         log_assert(next_args.empty());
 458         do {
 459                 std::istream *f = NULL;
 460                 next_args.clear();
 461                 auto state = pre_execute();
 462                 execute(f, std::string(), args, design);
 463                 post_execute(state);
 464                 args = next_args;
 465                 delete f;
 466         } while (!args.empty());
 467 }
 468
 469 FILE *Frontend::current_script_file = NULL;
 470 std::string Frontend::last_here_document;
 471
 472 void Frontend::extra_args(std::istream *&f, std::string &filename, std::vector<std::string> args, size_t argidx, bool bin_input)
 473 {
 474         bool called_with_fp = f != NULL;
 475
 476         next_args.clear();
 477
 478         if (argidx < args.size())
 479         {
 480                 std::string arg = args[argidx];
 481
 482                 if (arg.compare(0, 1, "-") == 0)
 483                         cmd_error(args, argidx, "Unknown option or option in arguments.");
 484                 if (f != NULL)
 485                         cmd_error(args, argidx, "Extra filename argument in direct file mode.");
 486
 487                 filename = arg;
 488                 if (filename == "<<" && argidx+1 < args.size())
 489                         filename += args[++argidx];
 490                 if (filename.compare(0, 2, "<<") == 0) {
 491                         if (Frontend::current_script_file == NULL)
 492                                 log_error("Unexpected here document '%s' outside of script!\n", filename.c_str());
 493                         if (filename.size() <= 2)
 494                                 log_error("Missing EOT marker in here document!\n");
 495                         std::string eot_marker = filename.substr(2);
 496                         last_here_document.clear();
 497                         while (1) {
 498                                 std::string buffer;
 499                                 char block[4096];
 500                                 while (1) {
 501                                         if (fgets(block, 4096, Frontend::current_script_file) == NULL)
 502                                                 log_error("Unexpected end of file in here document '%s'!\n", filename.c_str());
 503                                         buffer += block;
 504                                         if (buffer.size() > 0 && (buffer[buffer.size() - 1] == '\n' || buffer[buffer.size() - 1] == '\r'))
 505                                                 break;
 506                                 }
 507                                 size_t indent = buffer.find_first_not_of(" \t\r\n");
 508                                 if (indent != std::string::npos && buffer.compare(indent, eot_marker.size(), eot_marker) == 0)
 509                                         break;
 510                                 last_here_document += buffer;
 511                         }
 512                         f = new std::istringstream(last_here_document);
 513                 } else {
 514                         rewrite_filename(filename);
 515                         vector<string> filenames = glob_filename(filename);
 516                         filename = filenames.front();
 517                         if (GetSize(filenames) > 1) {
 518                                 next_args.insert(next_args.end(), args.begin(), args.begin()+argidx);
 519                                 next_args.insert(next_args.end(), filenames.begin()+1, filenames.end());
 520                         }
 521                         std::ifstream *ff = new std::ifstream;
 522                         ff->open(filename.c_str(), bin_input ? std::ifstream::binary : std::ifstream::in);
 523                         yosys_input_files.insert(filename);
 524                         if (ff->fail())
 525                                 delete ff;
 526                         else
 527                                 f = ff;
 528                         if (f != NULL) {
 529                                 // Check for gzip magic
 530                                 unsigned char magic[3];
 531                                 int n = 0;
 532                                 while (n < 3)
 533                                 {
 534                                         int c = ff->get();
 535                                         if (c != EOF) {
 536                                                 magic[n] = (unsigned char) c;
 537                                         }
 538                                         n++;
 539                                 }
 540                                 if (n == 3 && magic[0] == 0x1f && magic[1] == 0x8b) {
 541         #ifdef YOSYS_ENABLE_ZLIB
 542                                         log("Found gzip magic in file `%s', decompressing using zlib.\n", filename.c_str());
 543                                         if (magic[2] != 8)
 544                                                 log_cmd_error("gzip file `%s' uses unsupported compression type %02x\n",
 545                                                         filename.c_str(), unsigned(magic[2]));
 546                                         delete ff;
 547                                         std::stringstream *df = new std::stringstream();
 548                                         decompress_gzip(filename, *df);
 549                                         f = df;
 550         #else
 551                                         log_cmd_error("File `%s' is a gzip file, but Yosys is compiled without zlib.\n", filename.c_str());
 552         #endif
 553                                 } else {
 554                                         ff->clear();
 555                                         ff->seekg(0, std::ios::beg);
 556                                 }
 557                         }
 558                 }
 559                 if (f == NULL)
 560                         log_cmd_error("Can't open input file `%s' for reading: %s\n", filename.c_str(), strerror(errno));
 561
 562                 for (size_t i = argidx+1; i < args.size(); i++)
 563                         if (args[i].compare(0, 1, "-") == 0)
 564                                 cmd_error(args, i, "Found option, expected arguments.");
 565
 566                 if (argidx+1 < args.size()) {
 567                         if (next_args.empty())
 568                                 next_args.insert(next_args.end(), args.begin(), args.begin()+argidx);
 569                         next_args.insert(next_args.end(), args.begin()+argidx+1, args.end());
 570                         args.erase(args.begin()+argidx+1, args.end());
 571                 }
 572         }
 573
 574         if (f == NULL)
 575                 cmd_error(args, argidx, "No filename given.");
 576
 577         if (called_with_fp)
 578                 args.push_back(filename);
 579         args[0] = pass_name;
 580         // cmd_log_args(args);
 581 }
 582
 583 void Frontend::frontend_call(RTLIL::Design *design, std::istream *f, std::string filename, std::string command)
 584 {
 585         std::vector<std::string> args;
 586         char *s = strdup(command.c_str());
 587         for (char *p = strtok(s, " \t\r\n"); p; p = strtok(NULL, " \t\r\n"))
 588                 args.push_back(p);
 589         free(s);
 590         frontend_call(design, f, filename, args);
 591 }
 592
 593 void Frontend::frontend_call(RTLIL::Design *design, std::istream *f, std::string filename, std::vector<std::string> args)
 594 {
 595         if (args.size() == 0)
 596                 return;
 597         if (frontend_register.count(args[0]) == 0)
 598                 log_cmd_error("No such frontend: %s\n", args[0].c_str());
 599
 600         if (f != NULL) {
 601                 auto state = frontend_register[args[0]]->pre_execute();
 602                 frontend_register[args[0]]->execute(f, filename, args, design);
 603                 frontend_register[args[0]]->post_execute(state);
 604         } else if (filename == "-") {
 605                 std::istream *f_cin = &std::cin;
 606                 auto state = frontend_register[args[0]]->pre_execute();
 607                 frontend_register[args[0]]->execute(f_cin, "<stdin>", args, design);
 608                 frontend_register[args[0]]->post_execute(state);
 609         } else {
 610                 if (!filename.empty())
 611                         args.push_back(filename);
 612                 frontend_register[args[0]]->execute(args, design);
 613         }
 614 }
 615
 616 Backend::Backend(std::string name, std::string short_help) :
 617                 Pass(name.rfind("=", 0) == 0 ? name.substr(1) : "write_" + name, short_help),
 618                 backend_name(name.rfind("=", 0) == 0 ? name.substr(1) : name)
 619 {
 620 }
 621
 622 void Backend::run_register()
 623 {
 624         log_assert(pass_register.count(pass_name) == 0);
 625         pass_register[pass_name] = this;
 626
 627         log_assert(backend_register.count(backend_name) == 0);
 628         backend_register[backend_name] = this;
 629 }
 630
 631 Backend::~Backend()
 632 {
 633 }
 634
 635 void Backend::execute(std::vector<std::string> args, RTLIL::Design *design)
 636 {
 637         std::ostream *f = NULL;
 638         auto state = pre_execute();
 639         execute(f, std::string(), args, design);
 640         post_execute(state);
 641         if (f != &std::cout)
 642                 delete f;
 643 }
 644
 645 void Backend::extra_args(std::ostream *&f, std::string &filename, std::vector<std::string> args, size_t argidx, bool bin_output)
 646 {
 647         bool called_with_fp = f != NULL;
 648
 649         for (; argidx < args.size(); argidx++)
 650         {
 651                 std::string arg = args[argidx];
 652
 653                 if (arg.compare(0, 1, "-") == 0 && arg != "-")
 654                         cmd_error(args, argidx, "Unknown option or option in arguments.");
 655                 if (f != NULL)
 656                         cmd_error(args, argidx, "Extra filename argument in direct file mode.");
 657
 658                 if (arg == "-") {
 659                         filename = "<stdout>";
 660                         f = &std::cout;
 661                         continue;
 662                 }
 663
 664                 filename = arg;
 665                 rewrite_filename(filename);
 666                 if (filename.size() > 3 && filename.compare(filename.size()-3, std::string::npos, ".gz") == 0) {
 667 #ifdef YOSYS_ENABLE_ZLIB
 668                         gzip_ostream *gf = new gzip_ostream;
 669                         if (!gf->open(filename)) {
 670                                 delete gf;
 671                                 log_cmd_error("Can't open output file `%s' for writing: %s\n", filename.c_str(), strerror(errno));
 672                         }
 673                         yosys_output_files.insert(filename);
 674                         f = gf;
 675 #else
 676                         log_cmd_error("Yosys is compiled without zlib support, unable to write gzip output.\n");
 677 #endif
 678                 } else {
 679                         std::ofstream *ff = new std::ofstream;
 680                         ff->open(filename.c_str(), bin_output ? (std::ofstream::trunc | std::ofstream::binary) : std::ofstream::trunc);
 681                         yosys_output_files.insert(filename);
 682                         if (ff->fail()) {
 683                                 delete ff;
 684                                 log_cmd_error("Can't open output file `%s' for writing: %s\n", filename.c_str(), strerror(errno));
 685                         }
 686                         f = ff;
 687                 }
 688         }
 689
 690         if (called_with_fp)
 691                 args.push_back(filename);
 692         args[0] = pass_name;
 693         // cmd_log_args(args);
 694
 695         if (f == NULL) {
 696                 filename = "<stdout>";
 697                 f = &std::cout;
 698         }
 699 }
 700
 701 void Backend::backend_call(RTLIL::Design *design, std::ostream *f, std::string filename, std::string command)
 702 {
 703         std::vector<std::string> args;
 704         char *s = strdup(command.c_str());
 705         for (char *p = strtok(s, " \t\r\n"); p; p = strtok(NULL, " \t\r\n"))
 706                 args.push_back(p);
 707         free(s);
 708         backend_call(design, f, filename, args);
 709 }
 710
 711 void Backend::backend_call(RTLIL::Design *design, std::ostream *f, std::string filename, std::vector<std::string> args)
 712 {
 713         if (args.size() == 0)
 714                 return;
 715         if (backend_register.count(args[0]) == 0)
 716                 log_cmd_error("No such backend: %s\n", args[0].c_str());
 717
 718         size_t orig_sel_stack_pos = design->selection_stack.size();
 719
 720         if (f != NULL) {
 721                 auto state = backend_register[args[0]]->pre_execute();
 722                 backend_register[args[0]]->execute(f, filename, args, design);
 723                 backend_register[args[0]]->post_execute(state);
 724         } else if (filename == "-") {
 725                 std::ostream *f_cout = &std::cout;
 726                 auto state = backend_register[args[0]]->pre_execute();
 727                 backend_register[args[0]]->execute(f_cout, "<stdout>", args, design);
 728                 backend_register[args[0]]->post_execute(state);
 729         } else {
 730                 if (!filename.empty())
 731                         args.push_back(filename);
 732                 backend_register[args[0]]->execute(args, design);
 733         }
 734
 735         while (design->selection_stack.size() > orig_sel_stack_pos)
 736                 design->selection_stack.pop_back();
 737 }
 738
 739 static struct CellHelpMessages {
 740         dict<string, string> cell_help, cell_code;
 741         CellHelpMessages() {
 742 #include "techlibs/common/simlib_help.inc"
 743 #include "techlibs/common/simcells_help.inc"
 744                 cell_help.sort();
 745                 cell_code.sort();
 746         }
 747 } cell_help_messages;
 748
 749 struct HelpPass : public Pass {
 750         HelpPass() : Pass("help", "display help messages") { }
 751         void help() YS_OVERRIDE
 752         {
 753                 log("\n");
 754                 log("    help  ................  list all commands\n");
 755                 log("    help <command>  ......  print help message for given command\n");
 756                 log("    help -all  ...........  print complete command reference\n");
 757                 log("\n");
 758                 log("    help -cells ..........  list all cell types\n");
 759                 log("    help <celltype>  .....  print help message for given cell type\n");
 760                 log("    help <celltype>+  ....  print verilog code for given cell type\n");
 761                 log("\n");
 762         }
 763         void escape_tex(std::string &tex)
 764         {
 765                 for (size_t pos = 0; (pos = tex.find('_', pos)) != std::string::npos; pos += 2)
 766                         tex.replace(pos, 1, "\\_");
 767                 for (size_t pos = 0; (pos = tex.find('$', pos)) != std::string::npos; pos += 2)
 768                         tex.replace(pos, 1, "\\$");
 769         }
 770         void write_tex(FILE *f, std::string cmd, std::string title, std::string text)
 771         {
 772                 size_t begin = text.find_first_not_of("\n"), end = text.find_last_not_of("\n");
 773                 if (begin != std::string::npos && end != std::string::npos && begin < end)
 774                         text = text.substr(begin, end-begin+1);
 775                 std::string cmd_unescaped = cmd;
 776                 escape_tex(cmd);
 777                 escape_tex(title);
 778                 fprintf(f, "\\section{%s -- %s}\n", cmd.c_str(), title.c_str());
 779                 fprintf(f, "\\label{cmd:%s}\n", cmd_unescaped.c_str());
 780                 fprintf(f, "\\begin{lstlisting}[numbers=left,frame=single]\n");
 781                 fprintf(f, "%s\n\\end{lstlisting}\n\n", text.c_str());
 782         }
 783         void escape_html(std::string &html)
 784         {
 785                 size_t pos = 0;
 786                 while ((pos = html.find_first_of("<>&", pos)) != std::string::npos)
 787                         switch (html[pos]) {
 788                         case '<':
 789                                 html.replace(pos, 1, "&lt;");
 790                                 pos += 4;
 791                                 break;
 792                         case '>':
 793                                 html.replace(pos, 1, "&gt;");
 794                                 pos += 4;
 795                                 break;
 796                         case '&':
 797                                 html.replace(pos, 1, "&amp;");
 798                                 pos += 5;
 799                                 break;
 800                         }
 801         }
 802         void write_html(FILE *idxf, std::string cmd, std::string title, std::string text)
 803         {
 804                 FILE *f = fopen(stringf("cmd_%s.in", cmd.c_str()).c_str(), "wt");
 805                 fprintf(idxf, "<li><a href=\"cmd_%s.html\"> ", cmd.c_str());
 806
 807                 escape_html(cmd);
 808                 escape_html(title);
 809                 escape_html(text);
 810
 811                 fprintf(idxf, "%s</a> <span>%s</span></a>\n", cmd.c_str(), title.c_str());
 812
 813                 fprintf(f, "@cmd_header %s@\n", cmd.c_str());
 814                 fprintf(f, "<h1>%s - %s</h1>\n", cmd.c_str(), title.c_str());
 815                 fprintf(f, "<pre>%s</pre>\n", text.c_str());
 816                 fprintf(f, "@footer@\n");
 817
 818                 fclose(f);
 819         }
 820         void execute(std::vector<std::string> args, RTLIL::Design*) YS_OVERRIDE
 821         {
 822                 if (args.size() == 1) {
 823                         log("\n");
 824                         for (auto &it : pass_register)
 825                                 log("    %-20s %s\n", it.first.c_str(), it.second->short_help.c_str());
 826                         log("\n");
 827                         log("Type 'help <command>' for more information on a command.\n");
 828                         log("Type 'help -cells' for a list of all cell types.\n");
 829                         log("\n");
 830                         return;
 831                 }
 832
 833                 if (args.size() == 2) {
 834                         if (args[1] == "-all") {
 835                                 for (auto &it : pass_register) {
 836                                         log("\n\n");
 837                                         log("%s  --  %s\n", it.first.c_str(), it.second->short_help.c_str());
 838                                         for (size_t i = 0; i < it.first.size() + it.second->short_help.size() + 6; i++)
 839                                                 log("=");
 840                                         log("\n");
 841                                         it.second->help();
 842                                         if (it.second->experimental_flag) {
 843                                                 log("\n");
 844                                                 log("WARNING: THE '%s' COMMAND IS EXPERIMENTAL.\n", it.first.c_str());
 845                                                 log("\n");
 846                                         }
 847                                 }
 848                         }
 849                         else if (args[1] == "-cells") {
 850                                 log("\n");
 851                                 for (auto &it : cell_help_messages.cell_help) {
 852                                         string line = split_tokens(it.second, "\n").at(0);
 853                                         string cell_name = next_token(line);
 854                                         log("    %-15s %s\n", cell_name.c_str(), line.c_str());
 855                                 }
 856                                 log("\n");
 857                                 log("Type 'help <cell_type>' for more information on a cell type.\n");
 858                                 log("\n");
 859                                 return;
 860                         }
 861                         // this option is undocumented as it is for internal use only
 862                         else if (args[1] == "-write-tex-command-reference-manual") {
 863                                 FILE *f = fopen("command-reference-manual.tex", "wt");
 864                                 fprintf(f, "%% Generated using the yosys 'help -write-tex-command-reference-manual' command.\n\n");
 865                                 for (auto &it : pass_register) {
 866                                         std::ostringstream buf;
 867                                         log_streams.push_back(&buf);
 868                                         it.second->help();
 869                                         if (it.second->experimental_flag) {
 870                                                 log("\n");
 871                                                 log("WARNING: THE '%s' COMMAND IS EXPERIMENTAL.\n", it.first.c_str());
 872                                                 log("\n");
 873                                         }
 874                                         log_streams.pop_back();
 875                                         write_tex(f, it.first, it.second->short_help, buf.str());
 876                                 }
 877                                 fclose(f);
 878                         }
 879                         // this option is undocumented as it is for internal use only
 880                         else if (args[1] == "-write-web-command-reference-manual") {
 881                                 FILE *f = fopen("templates/cmd_index.in", "wt");
 882                                 for (auto &it : pass_register) {
 883                                         std::ostringstream buf;
 884                                         log_streams.push_back(&buf);
 885                                         it.second->help();
 886                                         if (it.second->experimental_flag) {
 887                                                 log("\n");
 888                                                 log("WARNING: THE '%s' COMMAND IS EXPERIMENTAL.\n", it.first.c_str());
 889                                                 log("\n");
 890                                         }
 891                                         log_streams.pop_back();
 892                                         write_html(f, it.first, it.second->short_help, buf.str());
 893                                 }
 894                                 fclose(f);
 895                         }
 896                         else if (pass_register.count(args[1])) {
 897                                 pass_register.at(args[1])->help();
 898                                 if (pass_register.at(args[1])->experimental_flag) {
 899                                         log("\n");
 900                                         log("WARNING: THE '%s' COMMAND IS EXPERIMENTAL.\n", args[1].c_str());
 901                                         log("\n");
 902                                 }
 903                         }
 904                         else if (cell_help_messages.cell_help.count(args[1])) {
 905                                 log("%s", cell_help_messages.cell_help.at(args[1]).c_str());
 906                                 log("Run 'help %s+' to display the Verilog model for this cell type.\n", args[1].c_str());
 907                                 log("\n");
 908                         }
 909                         else if (cell_help_messages.cell_code.count(args[1])) {
 910                                 log("\n");
 911                                 log("%s", cell_help_messages.cell_code.at(args[1]).c_str());
 912                         }
 913                         else
 914                                 log("No such command or cell type: %s\n", args[1].c_str());
 915                         return;
 916                 }
 917
 918                 help();
 919         }
 920 } HelpPass;
 921
 922 struct EchoPass : public Pass {
 923         EchoPass() : Pass("echo", "turning echoing back of commands on and off") { }
 924         void help() YS_OVERRIDE
 925         {
 926                 log("\n");
 927                 log("    echo on\n");
 928                 log("\n");
 929                 log("Print all commands to log before executing them.\n");
 930                 log("\n");
 931                 log("\n");
 932                 log("    echo off\n");
 933                 log("\n");
 934                 log("Do not print all commands to log before executing them. (default)\n");
 935                 log("\n");
 936         }
 937         void execute(std::vector<std::string> args, RTLIL::Design*) YS_OVERRIDE
 938         {
 939                 if (args.size() > 2)
 940                         cmd_error(args, 2, "Unexpected argument.");
 941
 942                 if (args.size() == 2) {
 943                         if (args[1] == "on")
 944                                 echo_mode = true;
 945                         else if (args[1] == "off")
 946                                 echo_mode = false;
 947                         else
 948                                 cmd_error(args, 1, "Unexpected argument.");
 949                 }
 950
 951                 log("echo %s\n", echo_mode ? "on" : "off");
 952         }
 953 } EchoPass;
 954
 955 SatSolver *yosys_satsolver_list;
 956 SatSolver *yosys_satsolver;
 957
 958 struct MinisatSatSolver : public SatSolver {
 959         MinisatSatSolver() : SatSolver("minisat") {
 960                 yosys_satsolver = this;
 961         }
 962         ezSAT *create() YS_OVERRIDE {
 963                 return new ezMiniSAT();
 964         }
 965 } MinisatSatSolver;
 966
 967 YOSYS_NAMESPACE_END