passes/equiv/equiv_opt.cc

   1 /*
   2  *  yosys -- Yosys Open SYnthesis Suite
   3  *
   4  *  Copyright (C) 2018  whitequark <whitequark@whitequark.org>
   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/register.h"
  21
  22 USING_YOSYS_NAMESPACE
  23 PRIVATE_NAMESPACE_BEGIN
  24
  25 struct EquivOptPass:public ScriptPass
  26 {
  27         EquivOptPass() : ScriptPass("equiv_opt", "prove equivalence for optimized circuit") { }
  28
  29         void help() YS_OVERRIDE
  30         {
  31                 //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
  32                 log("\n");
  33                 log("    equiv_opt [options] [command]\n");
  34                 log("\n");
  35                 log("This command checks circuit equivalence before and after an optimization pass.\n");
  36                 log("\n");
  37                 log("    -run <from_label>:<to_label>\n");
  38                 log("        only run the commands between the labels (see below). an empty\n");
  39                 log("        from label is synonymous to the start of the command list, and empty to\n");
  40                 log("        label is synonymous to the end of the command list.\n");
  41                 log("\n");
  42                 log("    -map <filename>\n");
  43                 log("        expand the modules in this file before proving equivalence. this is\n");
  44                 log("        useful for handling architecture-specific primitives.\n");
  45                 log("\n");
  46                 log("    -assert\n");
  47                 log("        produce an error if the circuits are not equivalent.\n");
  48                 log("\n");
  49                 log("    -multiclock\n");
  50                 log("        run clk2fflogic before equivalence checking.\n");
  51                 log("\n");
  52                 log("    -undef\n");
  53                 log("        enable modelling of undef states during equiv_induct.\n");
  54                 log("\n");
  55                 log("The following commands are executed by this verification command:\n");
  56                 help_script();
  57                 log("\n");
  58         }
  59
  60         std::string command, techmap_opts;
  61         bool assert, undef, multiclock, async2sync;
  62
  63         void clear_flags() YS_OVERRIDE
  64         {
  65                 command = "";
  66                 techmap_opts = "";
  67                 assert = false;
  68                 undef = false;
  69                 multiclock = false;
  70                 async2sync = false;
  71         }
  72
  73         void execute(std::vector < std::string > args, RTLIL::Design * design) YS_OVERRIDE
  74         {
  75                 string run_from, run_to;
  76                 clear_flags();
  77
  78                 size_t argidx;
  79                 for (argidx = 1; argidx < args.size(); argidx++) {
  80                         if (args[argidx] == "-run" && argidx + 1 < args.size()) {
  81                                 size_t pos = args[argidx + 1].find(':');
  82                                 if (pos == std::string::npos)
  83                                         break;
  84                                 run_from = args[++argidx].substr(0, pos);
  85                                 run_to = args[argidx].substr(pos + 1);
  86                                 continue;
  87                         }
  88                         if (args[argidx] == "-map" && argidx + 1 < args.size()) {
  89                                 techmap_opts += " -map " + args[++argidx];
  90                                 continue;
  91                         }
  92                         if (args[argidx] == "-assert") {
  93                                 assert = true;
  94                                 continue;
  95                         }
  96                         if (args[argidx] == "-undef") {
  97                                 undef = true;
  98                                 continue;
  99                         }
 100                         if (args[argidx] == "-multiclock") {
 101                                 multiclock = true;
 102                                 continue;
 103                         }
 104                         if (args[argidx] == "-async2sync") {
 105                                 async2sync = true;
 106                                 continue;
 107                         }
 108                         break;
 109                 }
 110
 111                 for (; argidx < args.size(); argidx++) {
 112                         if (command.empty()) {
 113                                 if (args[argidx].compare(0, 1, "-") == 0)
 114                                         cmd_error(args, argidx, "Unknown option.");
 115                         } else {
 116                                 command += " ";
 117                         }
 118                         command += args[argidx];
 119                 }
 120
 121                 if (command.empty())
 122                         log_cmd_error("No optimization pass specified!\n");
 123
 124                 if (!design->full_selection())
 125                         log_cmd_error("This command only operates on fully selected designs!\n");
 126
 127                 if (async2sync && multiclock)
 128                         log_cmd_error("The '-async2sync' and '-multiclock' options are mutually exclusive!\n");
 129
 130                 log_header(design, "Executing EQUIV_OPT pass.\n");
 131                 log_push();
 132
 133                 run_script(design, run_from, run_to);
 134
 135                 log_pop();
 136         }
 137
 138         void script() YS_OVERRIDE
 139         {
 140                 if (check_label("run_pass")) {
 141                         run("hierarchy -auto-top");
 142                         run("design -save preopt");
 143                         if (help_mode)
 144                                 run("[command]");
 145                         else
 146                                 run(command);
 147                         run("design -stash postopt");
 148                 }
 149
 150                 if (check_label("prepare")) {
 151                         run("design -copy-from preopt  -as gold A:top");
 152                         run("design -copy-from postopt -as gate A:top");
 153                 }
 154
 155                 if ((!techmap_opts.empty() || help_mode) && check_label("techmap", "(only with -map)")) {
 156                         string opts;
 157                         if (help_mode)
 158                                 opts = " -map <filename> ...";
 159                         else
 160                                 opts = techmap_opts;
 161                         run("techmap -wb -D EQUIV -autoproc" + opts);
 162                 }
 163
 164                 if (check_label("prove")) {
 165                         if (multiclock || help_mode)
 166                                 run("clk2fflogic", "(only with -multiclock)");
 167                         if (async2sync || help_mode)
 168                                 run("async2sync", "(only with -async2sync)");
 169                         run("equiv_make gold gate equiv");
 170                         if (help_mode)
 171                                 run("equiv_induct [-undef] equiv");
 172                         else if (undef)
 173                                 run("equiv_induct -undef equiv");
 174                         else
 175                                 run("equiv_induct equiv");
 176                         if (help_mode)
 177                                 run("equiv_status [-assert] equiv");
 178                         else if (assert)
 179                                 run("equiv_status -assert equiv");
 180                         else
 181                                 run("equiv_status equiv");
 182                 }
 183
 184                 if (check_label("restore")) {
 185                         run("design -load preopt");
 186                 }
 187         }
 188 } EquivOptPass;
 189
 190 PRIVATE_NAMESPACE_END