Merge remote-tracking branch 'origin/master' into eddie/cleanup
[yosys.git] / backends / smt2 / smt2.cc
index e6e96901189227f5606b8da580692d1ff5ac9b3c..db849882e734501cf9f254a6486b77d96e2b31bb 100644 (file)
@@ -32,15 +32,18 @@ struct Smt2Worker
        CellTypes ct;
        SigMap sigmap;
        RTLIL::Module *module;
-       bool bvmode, memmode, wiresmode, verbose, statebv, statedt;
+       bool bvmode, memmode, wiresmode, verbose, statebv, statedt, forallmode;
        dict<IdString, int> &mod_stbv_width;
-       int idcounter, statebv_width;
+       int idcounter = 0, statebv_width = 0;
 
        std::vector<std::string> decls, trans, hier, dtmembers;
        std::map<RTLIL::SigBit, RTLIL::Cell*> bit_driver;
        std::set<RTLIL::Cell*> exported_cells, hiercells, hiercells_queue;
        pool<Cell*> recursive_cells, registers;
 
+       pool<SigBit> clock_posedge, clock_negedge;
+       vector<string> ex_state_eq, ex_input_eq;
+
        std::map<RTLIL::SigBit, std::pair<int, int>> fcache;
        std::map<Cell*, int> memarrays;
        std::map<int, int> bvsizes;
@@ -104,16 +107,24 @@ struct Smt2Worker
                        decls.push_back(decl_str + "\n");
        }
 
-       Smt2Worker(RTLIL::Module *module, bool bvmode, bool memmode, bool wiresmode, bool verbose, bool statebv, bool statedt, dict<IdString, int> &mod_stbv_width) :
+       Smt2Worker(RTLIL::Module *module, bool bvmode, bool memmode, bool wiresmode, bool verbose, bool statebv, bool statedt, bool forallmode,
+                       dict<IdString, int> &mod_stbv_width, dict<IdString, dict<IdString, pair<bool, bool>>> &mod_clk_cache) :
                        ct(module->design), sigmap(module), module(module), bvmode(bvmode), memmode(memmode), wiresmode(wiresmode),
-                       verbose(verbose), statebv(statebv), statedt(statedt), mod_stbv_width(mod_stbv_width), idcounter(0), statebv_width(0)
+                       verbose(verbose), statebv(statebv), statedt(statedt), forallmode(forallmode), mod_stbv_width(mod_stbv_width)
        {
+               pool<SigBit> noclock;
+
                makebits(stringf("%s_is", get_id(module)));
 
                for (auto cell : module->cells())
-               for (auto &conn : cell->connections()) {
+               for (auto &conn : cell->connections())
+               {
+                       if (GetSize(conn.second) == 0)
+                               continue;
+
                        bool is_input = ct.cell_input(cell->type, conn.first);
                        bool is_output = ct.cell_output(cell->type, conn.first);
+
                        if (is_output && !is_input)
                                for (auto bit : sigmap(conn.second)) {
                                        if (bit_driver.count(bit))
@@ -123,6 +134,66 @@ struct Smt2Worker
                        else if (is_output || !is_input)
                                log_error("Unsupported or unknown directionality on port %s of cell %s.%s (%s).\n",
                                                log_id(conn.first), log_id(module), log_id(cell), log_id(cell->type));
+
+                       if (cell->type.in("$mem") && conn.first.in("\\RD_CLK", "\\WR_CLK"))
+                       {
+                               SigSpec clk = sigmap(conn.second);
+                               for (int i = 0; i < GetSize(clk); i++)
+                               {
+                                       if (clk[i].wire == nullptr)
+                                               continue;
+
+                                       if (cell->getParam(conn.first == "\\RD_CLK" ? "\\RD_CLK_ENABLE" : "\\WR_CLK_ENABLE")[i] != State::S1)
+                                               continue;
+
+                                       if (cell->getParam(conn.first == "\\RD_CLK" ? "\\RD_CLK_POLARITY" : "\\WR_CLK_POLARITY")[i] == State::S1)
+                                               clock_posedge.insert(clk[i]);
+                                       else
+                                               clock_negedge.insert(clk[i]);
+                               }
+                       }
+                       else
+                       if (cell->type.in("$dff", "$_DFF_P_", "$_DFF_N_") && conn.first.in("\\CLK", "\\C"))
+                       {
+                               bool posedge = (cell->type == "$_DFF_N_") || (cell->type == "$dff" && cell->getParam("\\CLK_POLARITY").as_bool());
+                               for (auto bit : sigmap(conn.second)) {
+                                       if (posedge)
+                                               clock_posedge.insert(bit);
+                                       else
+                                               clock_negedge.insert(bit);
+                               }
+                       }
+                       else
+                       if (mod_clk_cache.count(cell->type) && mod_clk_cache.at(cell->type).count(conn.first))
+                       {
+                               for (auto bit : sigmap(conn.second)) {
+                                       if (mod_clk_cache.at(cell->type).at(conn.first).first)
+                                               clock_posedge.insert(bit);
+                                       if (mod_clk_cache.at(cell->type).at(conn.first).second)
+                                               clock_negedge.insert(bit);
+                               }
+                       }
+                       else
+                       {
+                               for (auto bit : sigmap(conn.second))
+                                       noclock.insert(bit);
+                       }
+               }
+
+               for (auto bit : noclock) {
+                       clock_posedge.erase(bit);
+                       clock_negedge.erase(bit);
+               }
+
+               for (auto wire : module->wires())
+               {
+                       if (!wire->port_input || GetSize(wire) != 1)
+                               continue;
+                       SigBit bit = sigmap(wire);
+                       if (clock_posedge.count(bit))
+                               mod_clk_cache[module->name][wire->name].first = true;
+                       if (clock_negedge.count(bit))
+                               mod_clk_cache[module->name][wire->name].second = true;
                }
        }
 
@@ -326,7 +397,8 @@ struct Smt2Worker
 
                if (type == 's' || type == 'd' || type == 'b') {
                        width = max(width, GetSize(cell->getPort("\\A")));
-                       width = max(width, GetSize(cell->getPort("\\B")));
+                       if (cell->hasPort("\\B"))
+                               width = max(width, GetSize(cell->getPort("\\B")));
                }
 
                if (cell->hasPort("\\A")) {
@@ -344,6 +416,7 @@ struct Smt2Worker
                for (char ch : expr) {
                        if (ch == 'A') processed_expr += get_bv(sig_a);
                        else if (ch == 'B') processed_expr += get_bv(sig_b);
+                       else if (ch == 'P') processed_expr += get_bv(cell->getPort("\\B"));
                        else if (ch == 'L') processed_expr += is_signed ? "a" : "l";
                        else if (ch == 'U') processed_expr += is_signed ? "s" : "u";
                        else processed_expr += ch;
@@ -437,6 +510,7 @@ struct Smt2Worker
                if (cell->type == "$_ANDNOT_") return export_gate(cell, "(and A (not B))");
                if (cell->type == "$_ORNOT_") return export_gate(cell, "(or A (not B))");
                if (cell->type == "$_MUX_") return export_gate(cell, "(ite S B A)");
+               if (cell->type == "$_NMUX_") return export_gate(cell, "(not (ite S B A))");
                if (cell->type == "$_AOI3_") return export_gate(cell, "(not (or (and A B) C))");
                if (cell->type == "$_OAI3_") return export_gate(cell, "(not (and (or A B) C))");
                if (cell->type == "$_AOI4_") return export_gate(cell, "(not (or (and A B) (and C D)))");
@@ -455,14 +529,16 @@ struct Smt2Worker
                                return;
                        }
 
-                       if (cell->type.in("$anyconst", "$anyseq"))
+                       if (cell->type.in("$anyconst", "$anyseq", "$allconst", "$allseq"))
                        {
                                registers.insert(cell);
                                string infostr = cell->attributes.count("\\src") ? cell->attributes.at("\\src").decode_string().c_str() : get_id(cell);
                                if (cell->attributes.count("\\reg"))
                                        infostr += " " + cell->attributes.at("\\reg").decode_string();
-                               decls.push_back(stringf("; yosys-smt2-%s %s#%d %s\n", cell->type.c_str() + 1, get_id(module), idcounter, infostr.c_str()));
+                               decls.push_back(stringf("; yosys-smt2-%s %s#%d %d %s\n", cell->type.c_str() + 1, get_id(module), idcounter, GetSize(cell->getPort("\\Y")), infostr.c_str()));
                                makebits(stringf("%s#%d", get_id(module), idcounter), GetSize(cell->getPort("\\Y")), log_signal(cell->getPort("\\Y")));
+                               if (cell->type == "$anyseq")
+                                       ex_input_eq.push_back(stringf("  (= (|%s#%d| state) (|%s#%d| other_state))", get_id(module), idcounter, get_id(module), idcounter));
                                register_bv(cell->getPort("\\Y"), idcounter++);
                                recursive_cells.erase(cell);
                                return;
@@ -480,7 +556,9 @@ struct Smt2Worker
 
                        if (cell->type.in("$shift", "$shiftx")) {
                                if (cell->getParam("\\B_SIGNED").as_bool()) {
-                                       /* FIXME */
+                                       return export_bvop(cell, stringf("(ite (bvsge P #b%0*d) "
+                                                       "(bvlshr A B) (bvlshr A (bvneg B)))",
+                                                       GetSize(cell->getPort("\\B")), 0), 's');
                                } else {
                                        return export_bvop(cell, "(bvlshr A B)", 's');
                                }
@@ -506,6 +584,13 @@ struct Smt2Worker
                        if (cell->type == "$div") return export_bvop(cell, "(bvUdiv A B)", 'd');
                        if (cell->type == "$mod") return export_bvop(cell, "(bvUrem A B)", 'd');
 
+                       if (cell->type.in("$reduce_and", "$reduce_or", "$reduce_bool") &&
+                                       2*GetSize(cell->getPort("\\A").chunks()) < GetSize(cell->getPort("\\A"))) {
+                               bool is_and = cell->type == "$reduce_and";
+                               string bits(GetSize(cell->getPort("\\A")), is_and ? '1' : '0');
+                               return export_bvop(cell, stringf("(%s A #b%s)", is_and ? "=" : "distinct", bits.c_str()), 'b');
+                       }
+
                        if (cell->type == "$reduce_and") return export_reduce(cell, "(and A)", true);
                        if (cell->type == "$reduce_or") return export_reduce(cell, "(or A)", false);
                        if (cell->type == "$reduce_xor") return export_reduce(cell, "(xor A)", false);
@@ -516,7 +601,7 @@ struct Smt2Worker
                        if (cell->type == "$logic_and") return export_reduce(cell, "(and (or A) (or B))", false);
                        if (cell->type == "$logic_or") return export_reduce(cell, "(or A B)", false);
 
-                       if (cell->type == "$mux" || cell->type == "$pmux")
+                       if (cell->type.in("$mux", "$pmux"))
                        {
                                int width = GetSize(cell->getPort("\\Y"));
                                std::string processed_expr = get_bv(cell->getPort("\\A"));
@@ -659,6 +744,9 @@ struct Smt2Worker
 
                        for (auto &conn : cell->connections())
                        {
+                               if (GetSize(conn.second) == 0)
+                                       continue;
+
                                Wire *w = m->wire(conn.first);
                                SigSpec sig = sigmap(conn.second);
 
@@ -682,7 +770,7 @@ struct Smt2Worker
 
                        if (statebv)
                                makebits(stringf("%s_h %s", get_id(module), get_id(cell->name)), mod_stbv_width.at(cell->type));
-                       if (statedt)
+                       else if (statedt)
                                dtmembers.push_back(stringf("  (|%s_h %s| |%s_s|)\n",
                                                get_id(module), get_id(cell->name), get_id(cell->type)));
                        else
@@ -726,17 +814,30 @@ struct Smt2Worker
                                        decls.push_back(stringf("; yosys-smt2-register %s %d\n", get_id(wire), wire->width));
                                if (wire->get_bool_attribute("\\keep") || (wiresmode && wire->name[0] == '\\'))
                                        decls.push_back(stringf("; yosys-smt2-wire %s %d\n", get_id(wire), wire->width));
+                               if (GetSize(wire) == 1 && (clock_posedge.count(sig) || clock_negedge.count(sig)))
+                                       decls.push_back(stringf("; yosys-smt2-clock %s%s%s\n", get_id(wire),
+                                                       clock_posedge.count(sig) ? " posedge" : "", clock_negedge.count(sig) ? " negedge" : ""));
                                if (bvmode && GetSize(sig) > 1) {
                                        decls.push_back(stringf("(define-fun |%s_n %s| ((state |%s_s|)) (_ BitVec %d) %s)\n",
                                                        get_id(module), get_id(wire), get_id(module), GetSize(sig), get_bv(sig).c_str()));
+                                       if (wire->port_input)
+                                               ex_input_eq.push_back(stringf("  (= (|%s_n %s| state) (|%s_n %s| other_state))",
+                                                               get_id(module), get_id(wire), get_id(module), get_id(wire)));
                                } else {
                                        for (int i = 0; i < GetSize(sig); i++)
-                                               if (GetSize(sig) > 1)
+                                               if (GetSize(sig) > 1) {
                                                        decls.push_back(stringf("(define-fun |%s_n %s %d| ((state |%s_s|)) Bool %s)\n",
                                                                        get_id(module), get_id(wire), i, get_id(module), get_bool(sig[i]).c_str()));
-                                               else
+                                                       if (wire->port_input)
+                                                               ex_input_eq.push_back(stringf("  (= (|%s_n %s %d| state) (|%s_n %s %d| other_state))",
+                                                                               get_id(module), get_id(wire), i, get_id(module), get_id(wire), i));
+                                               } else {
                                                        decls.push_back(stringf("(define-fun |%s_n %s| ((state |%s_s|)) Bool %s)\n",
                                                                        get_id(module), get_id(wire), get_id(module), get_bool(sig[i]).c_str()));
+                                                       if (wire->port_input)
+                                                               ex_input_eq.push_back(stringf("  (= (|%s_n %s| state) (|%s_n %s| other_state))",
+                                                                               get_id(module), get_id(wire), get_id(module), get_id(wire)));
+                                               }
                                }
                        }
                }
@@ -788,8 +889,8 @@ struct Smt2Worker
 
                                string name_a = get_bool(cell->getPort("\\A"));
                                string name_en = get_bool(cell->getPort("\\EN"));
-                               decls.push_back(stringf("; yosys-smt2-%s %d %s\n", cell->type.c_str() + 1, id,
-                                               cell->attributes.count("\\src") ? cell->attributes.at("\\src").decode_string().c_str() : get_id(cell)));
+                               string infostr = (cell->name[0] == '$' && cell->attributes.count("\\src")) ? cell->attributes.at("\\src").decode_string() : get_id(cell);
+                               decls.push_back(stringf("; yosys-smt2-%s %d %s\n", cell->type.c_str() + 1, id, infostr.c_str()));
 
                                if (cell->type == "$cover")
                                        decls.push_back(stringf("(define-fun |%s_%c %d| ((state |%s_s|)) Bool (and %s %s)) ; %s\n",
@@ -829,6 +930,9 @@ struct Smt2Worker
 
                                for (auto &conn : cell->connections())
                                {
+                                       if (GetSize(conn.second) == 0)
+                                               continue;
+
                                        Wire *w = m->wire(conn.first);
                                        SigSpec sig = sigmap(conn.second);
 
@@ -858,6 +962,7 @@ struct Smt2Worker
                                        std::string expr_d = get_bool(cell->getPort("\\D"));
                                        std::string expr_q = get_bool(cell->getPort("\\Q"), "next_state");
                                        trans.push_back(stringf("  (= %s %s) ; %s %s\n", expr_d.c_str(), expr_q.c_str(), get_id(cell), log_signal(cell->getPort("\\Q"))));
+                                       ex_state_eq.push_back(stringf("(= %s %s)", get_bool(cell->getPort("\\Q")).c_str(), get_bool(cell->getPort("\\Q"), "other_state").c_str()));
                                }
 
                                if (cell->type.in("$ff", "$dff"))
@@ -865,13 +970,16 @@ struct Smt2Worker
                                        std::string expr_d = get_bv(cell->getPort("\\D"));
                                        std::string expr_q = get_bv(cell->getPort("\\Q"), "next_state");
                                        trans.push_back(stringf("  (= %s %s) ; %s %s\n", expr_d.c_str(), expr_q.c_str(), get_id(cell), log_signal(cell->getPort("\\Q"))));
+                                       ex_state_eq.push_back(stringf("(= %s %s)", get_bv(cell->getPort("\\Q")).c_str(), get_bv(cell->getPort("\\Q"), "other_state").c_str()));
                                }
 
-                               if (cell->type == "$anyconst")
+                               if (cell->type.in("$anyconst", "$allconst"))
                                {
                                        std::string expr_d = get_bv(cell->getPort("\\Y"));
                                        std::string expr_q = get_bv(cell->getPort("\\Y"), "next_state");
                                        trans.push_back(stringf("  (= %s %s) ; %s %s\n", expr_d.c_str(), expr_q.c_str(), get_id(cell), log_signal(cell->getPort("\\Y"))));
+                                       if (cell->type == "$anyconst")
+                                               ex_state_eq.push_back(stringf("(= %s %s)", get_bv(cell->getPort("\\Y")).c_str(), get_bv(cell->getPort("\\Y"), "other_state").c_str()));
                                }
 
                                if (cell->type == "$mem")
@@ -983,6 +1091,7 @@ struct Smt2Worker
                                        std::string expr_d = stringf("(|%s#%d#%d| state)", get_id(module), arrayid, wr_ports);
                                        std::string expr_q = stringf("(|%s#%d#0| next_state)", get_id(module), arrayid);
                                        trans.push_back(stringf("  (= %s %s) ; %s\n", expr_d.c_str(), expr_q.c_str(), get_id(cell)));
+                                       ex_state_eq.push_back(stringf("(= (|%s#%d#0| state) (|%s#%d#0| other_state))", get_id(module), arrayid, get_id(module), arrayid));
 
                                        if (async_read)
                                                hier.push_back(stringf("  (= %s (|%s| state)) ; %s\n", expr_d.c_str(), final_memstate.c_str(), get_id(cell)));
@@ -996,20 +1105,27 @@ struct Smt2Worker
                                                        break;
 
                                                Const initword = init_data.extract(i*width, width, State::Sx);
+                                               Const initmask = initword;
                                                bool gen_init_constr = false;
 
-                                               for (auto bit : initword.bits)
-                                                       if (bit == State::S0 || bit == State::S1)
+                                               for (int k = 0; k < GetSize(initword); k++) {
+                                                       if (initword[k] == State::S0 || initword[k] == State::S1) {
                                                                gen_init_constr = true;
+                                                               initmask[k] = State::S1;
+                                                       } else {
+                                                               initmask[k] = State::S0;
+                                                               initword[k] = State::S0;
+                                                       }
+                                               }
 
                                                if (gen_init_constr)
                                                {
                                                        if (statebv)
                                                                /* FIXME */;
                                                        else
-                                                               init_list.push_back(stringf("(= (select (|%s#%d#0| state) #b%s) #b%s) ; %s[%d]",
+                                                               init_list.push_back(stringf("(= (bvand (select (|%s#%d#0| state) #b%s) #b%s) #b%s) ; %s[%d]",
                                                                                get_id(module), arrayid, Const(i, abits).as_string().c_str(),
-                                                                               initword.as_string().c_str(), get_id(cell), i));
+                                                                               initmask.as_string().c_str(), initword.as_string().c_str(), get_id(cell), i));
                                                }
                                        }
                                }
@@ -1025,6 +1141,37 @@ struct Smt2Worker
                        hier.push_back(stringf("  (|%s_h| (|%s_h %s| state))\n", get_id(c->type), get_id(module), get_id(c->name)));
                        trans.push_back(stringf("  (|%s_t| (|%s_h %s| state) (|%s_h %s| next_state))\n",
                                        get_id(c->type), get_id(module), get_id(c->name), get_id(module), get_id(c->name)));
+                       ex_state_eq.push_back(stringf("(|%s_ex_state_eq| (|%s_h %s| state) (|%s_h %s| other_state))\n",
+                                       get_id(c->type), get_id(module), get_id(c->name), get_id(module), get_id(c->name)));
+               }
+
+               if (forallmode)
+               {
+                       string expr = ex_state_eq.empty() ? "true" : "(and";
+                       if (!ex_state_eq.empty()) {
+                               if (GetSize(ex_state_eq) == 1) {
+                                       expr = "\n  " + ex_state_eq.front() + "\n";
+                               } else {
+                                       for (auto &str : ex_state_eq)
+                                               expr += stringf("\n  %s", str.c_str());
+                                       expr += "\n)";
+                               }
+                       }
+                       decls.push_back(stringf("(define-fun |%s_ex_state_eq| ((state |%s_s|) (other_state |%s_s|)) Bool %s)\n",
+                               get_id(module), get_id(module), get_id(module), expr.c_str()));
+
+                       expr = ex_input_eq.empty() ? "true" : "(and";
+                       if (!ex_input_eq.empty()) {
+                               if (GetSize(ex_input_eq) == 1) {
+                                       expr = "\n  " + ex_input_eq.front() + "\n";
+                               } else {
+                                       for (auto &str : ex_input_eq)
+                                               expr += stringf("\n  %s", str.c_str());
+                                       expr += "\n)";
+                               }
+                       }
+                       decls.push_back(stringf("(define-fun |%s_ex_input_eq| ((state |%s_s|) (other_state |%s_s|)) Bool %s)\n",
+                               get_id(module), get_id(module), get_id(module), expr.c_str()));
                }
 
                string assert_expr = assert_list.empty() ? "true" : "(and";
@@ -1115,7 +1262,7 @@ struct Smt2Worker
 
 struct Smt2Backend : public Backend {
        Smt2Backend() : Backend("smt2", "write design to SMT-LIBv2 file") { }
-       virtual void help()
+       void help() YS_OVERRIDE
        {
                //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
                log("\n");
@@ -1271,10 +1418,11 @@ struct Smt2Backend : public Backend {
                log("from non-zero to zero in the test design.\n");
                log("\n");
        }
-       virtual void execute(std::ostream *&f, std::string filename, std::vector<std::string> args, RTLIL::Design *design)
+       void execute(std::ostream *&f, std::string filename, std::vector<std::string> args, RTLIL::Design *design) YS_OVERRIDE
        {
                std::ifstream template_f;
                bool bvmode = true, memmode = true, wiresmode = false, verbose = false, statebv = false, statedt = false;
+               bool forallmode = false;
 
                log_header(design, "Executing SMT2 backend.\n");
 
@@ -1378,17 +1526,30 @@ struct Smt2Backend : public Backend {
                }
 
                dict<IdString, int> mod_stbv_width;
+               dict<IdString, dict<IdString, pair<bool, bool>>> mod_clk_cache;
                Module *topmod = design->top_module();
                std::string topmod_id;
 
+               for (auto module : sorted_modules)
+                       for (auto cell : module->cells())
+                               if (cell->type.in("$allconst", "$allseq"))
+                                       goto found_forall;
+               if (0) {
+       found_forall:
+                       forallmode = true;
+                       *f << stringf("; yosys-smt2-forall\n");
+                       if (!statebv && !statedt)
+                               log_error("Forall-exists problems are only supported in -stbv or -stdt mode.\n");
+               }
+
                for (auto module : sorted_modules)
                {
-                       if (module->get_bool_attribute("\\blackbox") || module->has_memories_warn() || module->has_processes_warn())
+                       if (module->get_blackbox_attribute() || module->has_memories_warn() || module->has_processes_warn())
                                continue;
 
                        log("Creating SMT-LIBv2 representation of module %s.\n", log_id(module));
 
-                       Smt2Worker worker(module, bvmode, memmode, wiresmode, verbose, statebv, statedt, mod_stbv_width);
+                       Smt2Worker worker(module, bvmode, memmode, wiresmode, verbose, statebv, statedt, forallmode, mod_stbv_width, mod_clk_cache);
                        worker.run();
                        worker.write(*f);