Merge branch 'master' into clk2ff-better-names
[yosys.git] / backends / aiger / xaiger.cc
index 3c7c745fe8815a2bdc20c9f1d8d957919c51953e..e223f185e5e40c52cca3847cda995c85d00a0a39 100644 (file)
@@ -1,7 +1,7 @@
 /*
  *  yosys -- Yosys Open SYnthesis Suite
  *
- *  Copyright (C) 2012  Clifford Wolf <clifford@clifford.at>
+ *  Copyright (C) 2012  Claire Xenia Wolf <claire@yosyshq.com>
  *                2019  Eddie Hung <eddie@fpgeh.com>
  *
  *  Permission to use, copy, modify, and/or distribute this software for any
@@ -76,14 +76,16 @@ void aiger_encode(std::ostream &f, int x)
 
 struct XAigerWriter
 {
+       Design *design;
        Module *module;
        SigMap sigmap;
 
+       dict<SigBit, State> init_map;
        pool<SigBit> input_bits, output_bits;
        dict<SigBit, SigBit> not_map, alias_map;
        dict<SigBit, pair<SigBit, SigBit>> and_map;
        vector<SigBit> ci_bits, co_bits;
-       dict<SigBit, Cell*> ff_bits;
+       vector<Cell*> ff_list;
        dict<SigBit, float> arrival_times;
 
        vector<pair<int, int>> aig_gates;
@@ -137,14 +139,14 @@ struct XAigerWriter
                return a;
        }
 
-       XAigerWriter(Module *module, bool holes_mode=false) : module(module), sigmap(module)
+       XAigerWriter(Module *module, bool dff_mode) : design(module->design), module(module), sigmap(module)
        {
                pool<SigBit> undriven_bits;
                pool<SigBit> unused_bits;
 
                // promote public wires
                for (auto wire : module->wires())
-                       if (wire->name[0] == '\\')
+                       if (wire->name.isPublic())
                                sigmap.add(wire);
 
                // promote input wires
@@ -157,7 +159,8 @@ struct XAigerWriter
                        if (wire->get_bool_attribute(ID::keep))
                                sigmap.add(wire);
 
-               for (auto wire : module->wires())
+               for (auto wire : module->wires()) {
+                       auto it = wire->attributes.find(ID::init);
                        for (int i = 0; i < GetSize(wire); i++)
                        {
                                SigBit wirebit(wire, i);
@@ -174,17 +177,26 @@ struct XAigerWriter
                                undriven_bits.insert(bit);
                                unused_bits.insert(bit);
 
-                               bool scc = wire->attributes.count(ID::abc9_scc);
-                               if (wire->port_input || scc)
+                               if (wire->port_input)
                                        input_bits.insert(bit);
 
                                bool keep = wire->get_bool_attribute(ID::keep);
-                               if (wire->port_output || keep || scc) {
+                               if (wire->port_output || keep) {
                                        if (bit != wirebit)
                                                alias_map[wirebit] = bit;
                                        output_bits.insert(wirebit);
                                }
+
+                               if (it != wire->attributes.end()) {
+                                       auto s = it->second[i];
+                                       if (s != State::Sx) {
+                                               auto r = init_map.insert(std::make_pair(bit, it->second[i]));
+                                               if (!r.second && r.first->second != it->second[i])
+                                                       log_error("Bit '%s' has a conflicting (* init *) value.\n", log_signal(bit));
+                                       }
+                               }
                        }
+               }
 
                TimingInfo timing;
 
@@ -212,18 +224,14 @@ struct XAigerWriter
                                        continue;
                                }
 
-                               if (cell->type == ID($__ABC9_FF_) &&
-                                               // The presence of an abc9_mergeability attribute indicates
-                                               //   that we do want to pass this flop to ABC
-                                               cell->attributes.count(ID::abc9_mergeability))
+                               if (dff_mode && cell->type.in(ID($_DFF_N_), ID($_DFF_P_)) && !cell->get_bool_attribute(ID::abc9_keep))
                                {
                                        SigBit D = sigmap(cell->getPort(ID::D).as_bit());
                                        SigBit Q = sigmap(cell->getPort(ID::Q).as_bit());
                                        unused_bits.erase(D);
                                        undriven_bits.erase(Q);
                                        alias_map[Q] = D;
-                                       auto r YS_ATTRIBUTE(unused) = ff_bits.insert(std::make_pair(D, cell));
-                                       log_assert(r.second);
+                                       ff_list.emplace_back(cell);
                                        continue;
                                }
 
@@ -231,59 +239,54 @@ struct XAigerWriter
                                        continue;
                        }
 
-                       RTLIL::Module* inst_module = module->design->module(cell->type);
-                       if (inst_module) {
-                               IdString derived_type = inst_module->derive(module->design, cell->parameters);
-                               inst_module = module->design->module(derived_type);
-                               log_assert(inst_module);
-
+                       RTLIL::Module* inst_module = design->module(cell->type);
+                       if (inst_module && inst_module->get_blackbox_attribute()) {
                                bool abc9_flop = false;
-                               if (!cell->has_keep_attr()) {
-                                       auto it = cell->attributes.find(ID::abc9_box_seq);
-                                       if (it != cell->attributes.end()) {
-                                               int abc9_box_seq = it->second.as_int();
-                                               if (GetSize(box_list) <= abc9_box_seq)
-                                                       box_list.resize(abc9_box_seq+1);
-                                               box_list[abc9_box_seq] = cell;
-                                               // Only flop boxes may have arrival times
-                                               //   (all others are combinatorial)
-                                               abc9_flop = inst_module->get_bool_attribute(ID::abc9_flop);
-                                               if (!abc9_flop)
-                                                       continue;
-                                       }
+
+                               auto it = cell->attributes.find(ID::abc9_box_seq);
+                               if (it != cell->attributes.end()) {
+                                       log_assert(!cell->has_keep_attr());
+                                       log_assert(cell->parameters.empty());
+                                       int abc9_box_seq = it->second.as_int();
+                                       if (GetSize(box_list) <= abc9_box_seq)
+                                               box_list.resize(abc9_box_seq+1);
+                                       box_list[abc9_box_seq] = cell;
+                                       // Only flop boxes may have arrival times
+                                       //   (all others are combinatorial)
+                                       log_assert(cell->parameters.empty());
+                                       abc9_flop = inst_module->get_bool_attribute(ID::abc9_flop);
+                                       if (!abc9_flop)
+                                               continue;
                                }
 
-                               if (!timing.count(derived_type))
+                               if (!timing.count(inst_module->name))
                                        timing.setup_module(inst_module);
-                               auto &t = timing.at(derived_type).arrival;
-                               for (const auto &conn : cell->connections()) {
-                                       auto port_wire = inst_module->wire(conn.first);
-                                       if (!port_wire->port_output)
+
+                               for (auto &i : timing.at(inst_module->name).arrival) {
+                                       if (!cell->hasPort(i.first.name))
                                                continue;
 
-                                       for (int i = 0; i < GetSize(conn.second); i++) {
-                                               auto d = t.at(TimingInfo::NameBit(conn.first,i), 0);
-                                               if (d == 0)
-                                                       continue;
+                                       auto port_wire = inst_module->wire(i.first.name);
+                                       log_assert(port_wire->port_output);
+
+                                       auto d = i.second.first;
+                                       if (d == 0)
+                                               continue;
+                                       auto offset = i.first.offset;
 
 #ifndef NDEBUG
-                                               if (ys_debug(1)) {
-                                                       static std::set<std::tuple<IdString,IdString,int>> seen;
-                                                       if (seen.emplace(derived_type, conn.first, i).second) log("%s.%s[%d] abc9_arrival = %d\n",
-                                                                       log_id(cell->type), log_id(conn.first), i, d);
-                                               }
-#endif
-                                               arrival_times[conn.second[i]] = d;
+                                       if (ys_debug(1)) {
+                                               static pool<std::pair<IdString,TimingInfo::NameBit>> seen;
+                                               if (seen.emplace(inst_module->name, i.first).second) log("%s.%s[%d] abc9_arrival = %d\n",
+                                                               log_id(cell->type), log_id(i.first.name), offset, d);
                                        }
+#endif
+                                       arrival_times[cell->getPort(i.first.name)[offset]] = d;
                                }
 
                                if (abc9_flop)
                                        continue;
                        }
-                       else {
-                               if (cell->type == ID($__ABC9_DELAY))
-                                       log_error("Cell type '%s' not recognised. Check that '+/abc9_model.v' has been read.\n", cell->type.c_str());
-                       }
 
                        bool cell_known = inst_module || cell->known();
                        for (const auto &c : cell->connections()) {
@@ -317,9 +320,9 @@ struct XAigerWriter
                for (auto cell : box_list) {
                        log_assert(cell);
 
-                       RTLIL::Module* box_module = module->design->module(cell->type);
+                       RTLIL::Module* box_module = design->module(cell->type);
                        log_assert(box_module);
-                       log_assert(box_module->attributes.count(ID::abc9_box_id) || box_module->get_bool_attribute(ID::abc9_flop));
+                       log_assert(box_module->has_attribute(ID::abc9_box_id));
 
                        auto r = box_ports.insert(cell->type);
                        if (r.second) {
@@ -383,27 +386,6 @@ struct XAigerWriter
                                                undriven_bits.erase(O);
                                        }
                        }
-
-                       // Connect <cell>.abc9_ff.Q (inserted by abc9_map.v) as the last input to the flop box
-                       if (box_module->get_bool_attribute(ID::abc9_flop)) {
-                               SigSpec rhs = module->wire(stringf("%s.abc9_ff.Q", cell->name.c_str()));
-                               if (rhs.empty())
-                                       log_error("'%s.abc9_ff.Q' is not a wire present in module '%s'.\n", log_id(cell), log_id(module));
-
-                               for (auto b : rhs) {
-                                       SigBit I = sigmap(b);
-                                       if (b == RTLIL::Sx)
-                                               b = State::S0;
-                                       else if (I != b) {
-                                               if (I == RTLIL::Sx)
-                                                       alias_map[b] = State::S0;
-                                               else
-                                                       alias_map[b] = I;
-                                       }
-                                       co_bits.emplace_back(b);
-                                       unused_bits.erase(I);
-                               }
-                       }
                }
 
                for (auto bit : input_bits)
@@ -419,16 +401,14 @@ struct XAigerWriter
                        undriven_bits.erase(bit);
                }
 
-               if (holes_mode) {
-                       struct sort_by_port_id {
-                               bool operator()(const RTLIL::SigBit& a, const RTLIL::SigBit& b) const {
-                                       return a.wire->port_id < b.wire->port_id ||
-                                           (a.wire->port_id == b.wire->port_id && a.offset < b.offset);
-                               }
-                       };
-                       input_bits.sort(sort_by_port_id());
-                       output_bits.sort(sort_by_port_id());
-               }
+               struct sort_by_port_id {
+                       bool operator()(const RTLIL::SigBit& a, const RTLIL::SigBit& b) const {
+                               return a.wire->port_id < b.wire->port_id ||
+                                   (a.wire->port_id == b.wire->port_id && a.offset < b.offset);
+                       }
+               };
+               input_bits.sort(sort_by_port_id());
+               output_bits.sort(sort_by_port_id());
 
                aig_map[State::S0] = 0;
                aig_map[State::S1] = 1;
@@ -439,8 +419,7 @@ struct XAigerWriter
                        aig_map[bit] = 2*aig_m;
                }
 
-               for (const auto &i : ff_bits) {
-                       const Cell *cell = i.second;
+               for (auto cell : ff_list) {
                        const SigBit &q = sigmap(cell->getPort(ID::Q));
                        aig_m++, aig_i++;
                        log_assert(!aig_map.count(q));
@@ -453,7 +432,8 @@ struct XAigerWriter
                        //   that has been padded to its full width
                        if (bit == State::Sx)
                                continue;
-                       log_assert(!aig_map.count(bit));
+                       if (aig_map.count(bit))
+                               log_error("Visited AIG node more than once; this could be a combinatorial loop that has not been broken\n");
                        aig_map[bit] = 2*aig_m;
                }
 
@@ -487,8 +467,8 @@ struct XAigerWriter
                        aig_outputs.push_back(aig);
                }
 
-               for (auto &i : ff_bits) {
-                       const SigBit &d = i.first;
+               for (auto cell : ff_list) {
+                       const SigBit &d = sigmap(cell->getPort(ID::D));
                        aig_o++;
                        aig_outputs.push_back(aig_map.at(d));
                }
@@ -560,16 +540,16 @@ struct XAigerWriter
                std::stringstream h_buffer;
                auto write_h_buffer = std::bind(write_buffer, std::ref(h_buffer), std::placeholders::_1);
                write_h_buffer(1);
-               log_debug("ciNum = %d\n", GetSize(input_bits) + GetSize(ff_bits) + GetSize(ci_bits));
-               write_h_buffer(input_bits.size() + ff_bits.size() + ci_bits.size());
-               log_debug("coNum = %d\n", GetSize(output_bits) + GetSize(ff_bits) + GetSize(co_bits));
-               write_h_buffer(output_bits.size() + GetSize(ff_bits) + GetSize(co_bits));
-               log_debug("piNum = %d\n", GetSize(input_bits) + GetSize(ff_bits));
-               write_h_buffer(input_bits.size() + ff_bits.size());
-               log_debug("poNum = %d\n", GetSize(output_bits) + GetSize(ff_bits));
-               write_h_buffer(output_bits.size() + ff_bits.size());
+               log_debug("ciNum = %d\n", GetSize(input_bits) + GetSize(ff_list) + GetSize(ci_bits));
+               write_h_buffer(GetSize(input_bits) + GetSize(ff_list) + GetSize(ci_bits));
+               log_debug("coNum = %d\n", GetSize(output_bits) + GetSize(ff_list) + GetSize(co_bits));
+               write_h_buffer(GetSize(output_bits) + GetSize(ff_list) + GetSize(co_bits));
+               log_debug("piNum = %d\n", GetSize(input_bits) + GetSize(ff_list));
+               write_h_buffer(GetSize(input_bits) + GetSize(ff_list));
+               log_debug("poNum = %d\n", GetSize(output_bits) + GetSize(ff_list));
+               write_h_buffer(GetSize(output_bits) + GetSize(ff_list));
                log_debug("boxNum = %d\n", GetSize(box_list));
-               write_h_buffer(box_list.size());
+               write_h_buffer(GetSize(box_list));
 
                auto write_buffer_float = [](std::stringstream &buffer, float f32) {
                        buffer.write(reinterpret_cast<const char*>(&f32), sizeof(f32));
@@ -583,23 +563,20 @@ struct XAigerWriter
                //for (auto bit : output_bits)
                //      write_o_buffer(0);
 
-               if (!box_list.empty() || !ff_bits.empty()) {
+               if (!box_list.empty() || !ff_list.empty()) {
                        dict<IdString, std::tuple<int,int,int>> cell_cache;
 
                        int box_count = 0;
                        for (auto cell : box_list) {
                                log_assert(cell);
+                               log_assert(cell->parameters.empty());
 
-                               RTLIL::Module* box_module = module->design->module(cell->type);
-                               log_assert(box_module);
-
-                               IdString derived_type = box_module->derive(box_module->design, cell->parameters);
-                               box_module = box_module->design->module(derived_type);
-                               log_assert(box_module);
-
-                               auto r = cell_cache.insert(derived_type);
+                               auto r = cell_cache.insert(cell->type);
                                auto &v = r.first->second;
                                if (r.second) {
+                                       RTLIL::Module* box_module = design->module(cell->type);
+                                       log_assert(box_module);
+
                                        int box_inputs = 0, box_outputs = 0;
                                        for (auto port_name : box_module->ports) {
                                                RTLIL::Wire *w = box_module->wire(port_name);
@@ -610,11 +587,6 @@ struct XAigerWriter
                                                        box_outputs += GetSize(w);
                                        }
 
-                                       // For flops only, create an extra 1-bit input that drives a new wire
-                                       //   called "<cell>.abc9_ff.Q" that is used below
-                                       if (box_module->get_bool_attribute(ID::abc9_flop))
-                                               box_inputs++;
-
                                        std::get<0>(v) = box_inputs;
                                        std::get<1>(v) = box_outputs;
                                        std::get<2>(v) = box_module->attributes.at(ID::abc9_box_id).as_int();
@@ -628,30 +600,33 @@ struct XAigerWriter
 
                        std::stringstream r_buffer;
                        auto write_r_buffer = std::bind(write_buffer, std::ref(r_buffer), std::placeholders::_1);
-                       log_debug("flopNum = %d\n", GetSize(ff_bits));
-                       write_r_buffer(ff_bits.size());
+                       log_debug("flopNum = %d\n", GetSize(ff_list));
+                       write_r_buffer(ff_list.size());
 
                        std::stringstream s_buffer;
                        auto write_s_buffer = std::bind(write_buffer, std::ref(s_buffer), std::placeholders::_1);
-                       write_s_buffer(ff_bits.size());
+                       write_s_buffer(ff_list.size());
 
-                       for (const auto &i : ff_bits) {
-                               const SigBit &d = i.first;
-                               const Cell *cell = i.second;
+                       dict<SigSpec, int> clk_to_mergeability;
+                       for (const auto cell : ff_list) {
+                               const SigBit &d = sigmap(cell->getPort(ID::D));
+                               const SigBit &q = sigmap(cell->getPort(ID::Q));
 
-                               int mergeability = cell->attributes.at(ID::abc9_mergeability).as_int();
+                               SigSpec clk_and_pol{sigmap(cell->getPort(ID::C)), cell->type[6] == 'P' ? State::S1 : State::S0};
+                               auto r = clk_to_mergeability.insert(std::make_pair(clk_and_pol, clk_to_mergeability.size()+1));
+                               int mergeability = r.first->second;
                                log_assert(mergeability > 0);
                                write_r_buffer(mergeability);
 
-                               Const init = cell->attributes.at(ID::abc9_init, State::Sx);
-                               log_assert(GetSize(init) == 1);
+                               State init = init_map.at(q, State::Sx);
+                               log_debug("Cell '%s' (type %s) has (* init *) value '%s'.\n", log_id(cell), log_id(cell->type), log_signal(init));
                                if (init == State::S1)
                                        write_s_buffer(1);
                                else if (init == State::S0)
                                        write_s_buffer(0);
                                else {
                                        log_assert(init == State::Sx);
-                                       write_s_buffer(0);
+                                       write_s_buffer(2);
                                }
 
                                // Use arrival time from output of flop box
@@ -671,10 +646,16 @@ struct XAigerWriter
                        f.write(reinterpret_cast<const char*>(&buffer_size_be), sizeof(buffer_size_be));
                        f.write(buffer_str.data(), buffer_str.size());
 
-                       RTLIL::Module *holes_module = module->design->module(stringf("%s$holes", module->name.c_str()));
+                       RTLIL::Design *holes_design;
+                       auto it = saved_designs.find("$abc9_holes");
+                       if (it != saved_designs.end())
+                               holes_design = it->second;
+                       else
+                               holes_design = nullptr;
+                       RTLIL::Module *holes_module = holes_design ? holes_design->module(module->name) : nullptr;
                        if (holes_module) {
                                std::stringstream a_buffer;
-                               XAigerWriter writer(holes_module, true /* holes_mode */);
+                               XAigerWriter writer(holes_module, false /* dff_mode */);
                                writer.write_aiger(a_buffer, false /*ascii_mode*/);
 
                                f << "a";
@@ -704,10 +685,10 @@ struct XAigerWriter
 
                f << stringf("Generated by %s\n", yosys_version_str);
 
-               module->design->scratchpad_set_int("write_xaiger.num_ands", and_map.size());
-               module->design->scratchpad_set_int("write_xaiger.num_wires", aig_map.size());
-               module->design->scratchpad_set_int("write_xaiger.num_inputs", input_bits.size());
-               module->design->scratchpad_set_int("write_xaiger.num_outputs", output_bits.size());
+               design->scratchpad_set_int("write_xaiger.num_ands", and_map.size());
+               design->scratchpad_set_int("write_xaiger.num_wires", aig_map.size());
+               design->scratchpad_set_int("write_xaiger.num_inputs", input_bits.size());
+               design->scratchpad_set_int("write_xaiger.num_outputs", output_bits.size());
        }
 
        void write_map(std::ostream &f)
@@ -717,22 +698,18 @@ struct XAigerWriter
 
                for (auto wire : module->wires())
                {
-                       SigSpec sig = sigmap(wire);
-
                        for (int i = 0; i < GetSize(wire); i++)
                        {
                                RTLIL::SigBit b(wire, i);
                                if (input_bits.count(b)) {
                                        int a = aig_map.at(b);
                                        log_assert((a & 1) == 0);
-                                       input_lines[a] += stringf("input %d %d %s\n", (a >> 1)-1, i, log_id(wire));
+                                       input_lines[a] += stringf("input %d %d %s\n", (a >> 1)-1, wire->start_offset+i, log_id(wire));
                                }
 
                                if (output_bits.count(b)) {
                                        int o = ordered_outputs.at(b);
-                                       int init = 2;
-                                       output_lines[o] += stringf("output %d %d %s %d\n", o - GetSize(co_bits), i, log_id(wire), init);
-                                       continue;
+                                       output_lines[o] += stringf("output %d %d %s\n", o - GetSize(co_bits), wire->start_offset+i, log_id(wire));
                                }
                        }
                }
@@ -755,17 +732,17 @@ struct XAigerWriter
 
 struct XAigerBackend : public Backend {
        XAigerBackend() : Backend("xaiger", "write design to XAIGER file") { }
-       void help() YS_OVERRIDE
+       void help() override
        {
                //   |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
                log("\n");
                log("    write_xaiger [options] [filename]\n");
                log("\n");
                log("Write the top module (according to the (* top *) attribute or if only one module\n");
-               log("is currently selected) to an XAIGER file. Any non $_NOT_, $_AND_, $_ABC9_FF_, or");
-               log("non (* abc9_box_id *) cells will be converted into psuedo-inputs and\n");
-               log("pseudo-outputs. Whitebox contents will be taken from the '<module-name>$holes'\n");
-               log("module, if it exists.\n");
+               log("is currently selected) to an XAIGER file. Any non $_NOT_, $_AND_, (optionally\n");
+               log("$_DFF_N_, $_DFF_P_), or non (* abc9_box *) cells will be converted into psuedo-\n");
+               log("inputs and pseudo-outputs. Whitebox contents will be taken from the equivalent\n");
+               log("module in the '$abc9_holes' design, if it exists.\n");
                log("\n");
                log("    -ascii\n");
                log("        write ASCII version of AIGER format\n");
@@ -773,10 +750,13 @@ struct XAigerBackend : public Backend {
                log("    -map <filename>\n");
                log("        write an extra file with port and box symbols\n");
                log("\n");
+               log("    -dff\n");
+               log("        write $_DFF_[NP]_ cells\n");
+               log("\n");
        }
-       void execute(std::ostream *&f, std::string filename, std::vector<std::string> args, RTLIL::Design *design) YS_OVERRIDE
+       void execute(std::ostream *&f, std::string filename, std::vector<std::string> args, RTLIL::Design *design) override
        {
-               bool ascii_mode = false;
+               bool ascii_mode = false, dff_mode = false;
                std::string map_filename;
 
                log_header(design, "Executing XAIGER backend.\n");
@@ -792,6 +772,10 @@ struct XAigerBackend : public Backend {
                                map_filename = args[++argidx];
                                continue;
                        }
+                       if (args[argidx] == "-dff") {
+                               dff_mode = true;
+                               continue;
+                       }
                        break;
                }
                extra_args(f, filename, args, argidx, !ascii_mode);
@@ -809,7 +793,7 @@ struct XAigerBackend : public Backend {
                if (!top_module->memories.empty())
                        log_error("Found unmapped memories in module %s: unmapped memories are not supported in XAIGER backend!\n", log_id(top_module));
 
-               XAigerWriter writer(top_module);
+               XAigerWriter writer(top_module, dff_mode);
                writer.write_aiger(*f, ascii_mode);
 
                if (!map_filename.empty()) {