mirror of https://github.com/YosysHQ/yosys.git
553 lines
14 KiB
C++
553 lines
14 KiB
C++
/*
|
|
* yosys -- Yosys Open SYnthesis Suite
|
|
*
|
|
* Copyright (C) 2012 Clifford Wolf <clifford@clifford.at>
|
|
*
|
|
* Permission to use, copy, modify, and/or distribute this software for any
|
|
* purpose with or without fee is hereby granted, provided that the above
|
|
* copyright notice and this permission notice appear in all copies.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*
|
|
*/
|
|
|
|
#include "kernel/yosys.h"
|
|
#include "kernel/sigtools.h"
|
|
|
|
USING_YOSYS_NAMESPACE
|
|
PRIVATE_NAMESPACE_BEGIN
|
|
|
|
void aiger_encode(std::ostream &f, int x)
|
|
{
|
|
log_assert(x >= 0);
|
|
|
|
while (x & ~0x7f) {
|
|
f.put((x & 0x7f) | 0x80);
|
|
x = x >> 7;
|
|
}
|
|
|
|
f.put(x);
|
|
}
|
|
|
|
struct AigerWriter
|
|
{
|
|
Module *module;
|
|
bool zinit_mode;
|
|
SigMap sigmap;
|
|
|
|
dict<SigBit, bool> init_map;
|
|
pool<SigBit> input_bits, output_bits;
|
|
dict<SigBit, SigBit> not_map, ff_map;
|
|
dict<SigBit, pair<SigBit, SigBit>> and_map;
|
|
vector<pair<SigBit, SigBit>> asserts, assumes;
|
|
pool<SigBit> initstate_bits;
|
|
|
|
vector<pair<int, int>> aig_gates;
|
|
vector<int> aig_latchin, aig_latchinit, aig_outputs;
|
|
int aig_m = 0, aig_i = 0, aig_l = 0, aig_o = 0, aig_a = 0, aig_b = 0, aig_c = 0;
|
|
|
|
dict<SigBit, int> aig_map;
|
|
dict<SigBit, int> ordered_outputs;
|
|
dict<SigBit, int> ordered_latches;
|
|
|
|
dict<SigBit, int> init_inputs;
|
|
int initstate_ff = 0;
|
|
|
|
int mkgate(int a0, int a1)
|
|
{
|
|
aig_m++, aig_a++;
|
|
aig_gates.push_back(a0 > a1 ? make_pair(a0, a1) : make_pair(a1, a0));
|
|
return 2*aig_m;
|
|
}
|
|
|
|
int bit2aig(SigBit bit)
|
|
{
|
|
if (aig_map.count(bit) == 0)
|
|
{
|
|
aig_map[bit] = -1;
|
|
|
|
if (initstate_bits.count(bit)) {
|
|
log_assert(initstate_ff > 0);
|
|
aig_map[bit] = initstate_ff;
|
|
} else
|
|
if (not_map.count(bit)) {
|
|
int a = bit2aig(not_map.at(bit)) ^ 1;
|
|
aig_map[bit] = a;
|
|
} else
|
|
if (and_map.count(bit)) {
|
|
auto args = and_map.at(bit);
|
|
int a0 = bit2aig(args.first);
|
|
int a1 = bit2aig(args.second);
|
|
aig_map[bit] = mkgate(a0, a1);
|
|
}
|
|
}
|
|
|
|
log_assert(aig_map.at(bit) >= 0);
|
|
return aig_map.at(bit);
|
|
}
|
|
|
|
AigerWriter(Module *module, bool zinit_mode) : module(module), zinit_mode(zinit_mode), sigmap(module)
|
|
{
|
|
for (auto wire : module->wires())
|
|
{
|
|
if (wire->attributes.count("\\init")) {
|
|
SigSpec initsig = sigmap(wire);
|
|
Const initval = wire->attributes.at("\\init");
|
|
for (int i = 0; i < GetSize(wire) && i < GetSize(initval); i++)
|
|
if (initval[i] == State::S0 || initval[i] == State::S1)
|
|
init_map[initsig[i]] = initval[i] == State::S1;
|
|
}
|
|
|
|
if (wire->port_input)
|
|
for (auto bit : sigmap(wire))
|
|
input_bits.insert(bit);
|
|
|
|
if (wire->port_output)
|
|
for (auto bit : sigmap(wire))
|
|
output_bits.insert(bit);
|
|
}
|
|
|
|
for (auto cell : module->cells())
|
|
{
|
|
if (cell->type == "$_NOT_")
|
|
{
|
|
SigBit A = sigmap(cell->getPort("\\A").as_bit());
|
|
SigBit Y = sigmap(cell->getPort("\\Y").as_bit());
|
|
not_map[Y] = A;
|
|
continue;
|
|
}
|
|
|
|
if (cell->type.in("$_FF_", "$_DFF_N_", "$_DFF_P_"))
|
|
{
|
|
SigBit D = sigmap(cell->getPort("\\D").as_bit());
|
|
SigBit Q = sigmap(cell->getPort("\\Q").as_bit());
|
|
ff_map[Q] = D;
|
|
continue;
|
|
}
|
|
|
|
if (cell->type == "$_AND_")
|
|
{
|
|
SigBit A = sigmap(cell->getPort("\\A").as_bit());
|
|
SigBit B = sigmap(cell->getPort("\\B").as_bit());
|
|
SigBit Y = sigmap(cell->getPort("\\Y").as_bit());
|
|
and_map[Y] = make_pair(A, B);
|
|
continue;
|
|
}
|
|
|
|
if (cell->type == "$initstate")
|
|
{
|
|
SigBit Y = sigmap(cell->getPort("\\Y").as_bit());
|
|
initstate_bits.insert(Y);
|
|
continue;
|
|
}
|
|
|
|
if (cell->type == "$assert")
|
|
{
|
|
SigBit A = sigmap(cell->getPort("\\A").as_bit());
|
|
SigBit EN = sigmap(cell->getPort("\\EN").as_bit());
|
|
asserts.push_back(make_pair(A, EN));
|
|
continue;
|
|
}
|
|
|
|
if (cell->type == "$assume")
|
|
{
|
|
SigBit A = sigmap(cell->getPort("\\A").as_bit());
|
|
SigBit EN = sigmap(cell->getPort("\\EN").as_bit());
|
|
assumes.push_back(make_pair(A, EN));
|
|
continue;
|
|
}
|
|
|
|
if (cell->type == "$anyconst")
|
|
{
|
|
for (auto bit : sigmap(cell->getPort("\\Y")))
|
|
ff_map[bit] = bit;
|
|
continue;
|
|
}
|
|
|
|
log_error("Unsupported cell type: %s (%s)\n", log_id(cell->type), log_id(cell));
|
|
}
|
|
|
|
init_map.sort();
|
|
input_bits.sort();
|
|
output_bits.sort();
|
|
not_map.sort();
|
|
ff_map.sort();
|
|
and_map.sort();
|
|
|
|
aig_map[State::S0] = 0;
|
|
aig_map[State::S1] = 1;
|
|
|
|
for (auto bit : input_bits) {
|
|
aig_m++, aig_i++;
|
|
aig_map[bit] = 2*aig_m;
|
|
}
|
|
|
|
if (zinit_mode)
|
|
{
|
|
for (auto it : ff_map) {
|
|
if (init_map.count(it.first))
|
|
continue;
|
|
aig_m++, aig_i++;
|
|
init_inputs[it.first] = 2*aig_m;
|
|
}
|
|
}
|
|
|
|
for (auto it : ff_map) {
|
|
aig_m++, aig_l++;
|
|
aig_map[it.first] = 2*aig_m;
|
|
ordered_latches[it.first] = aig_l-1;
|
|
if (init_map.count(it.first) == 0)
|
|
aig_latchinit.push_back(2);
|
|
else
|
|
aig_latchinit.push_back(init_map.at(it.first) ? 1 : 0);
|
|
}
|
|
|
|
if (!initstate_bits.empty() || !init_inputs.empty()) {
|
|
aig_m++, aig_l++;
|
|
initstate_ff = 2*aig_m+1;
|
|
aig_latchinit.push_back(0);
|
|
}
|
|
|
|
if (zinit_mode)
|
|
{
|
|
for (auto it : ff_map)
|
|
{
|
|
int l = ordered_latches[it.first];
|
|
|
|
if (aig_latchinit.at(l) == 1)
|
|
aig_map[it.first] ^= 1;
|
|
|
|
if (aig_latchinit.at(l) == 2)
|
|
{
|
|
int gated_ffout = mkgate(aig_map[it.first], initstate_ff^1);
|
|
int gated_initin = mkgate(init_inputs[it.first], initstate_ff);
|
|
aig_map[it.first] = mkgate(gated_ffout^1, gated_initin^1)^1;
|
|
}
|
|
}
|
|
}
|
|
|
|
for (auto it : ff_map) {
|
|
int a = bit2aig(it.second);
|
|
int l = ordered_latches[it.first];
|
|
if (zinit_mode && aig_latchinit.at(l) == 1)
|
|
aig_latchin.push_back(a ^ 1);
|
|
else
|
|
aig_latchin.push_back(a);
|
|
}
|
|
|
|
if (!initstate_bits.empty() || !init_inputs.empty())
|
|
aig_latchin.push_back(1);
|
|
|
|
for (auto bit : output_bits) {
|
|
aig_o++;
|
|
ordered_outputs[bit] = aig_o-1;
|
|
aig_outputs.push_back(bit2aig(bit));
|
|
}
|
|
|
|
for (auto it : asserts) {
|
|
aig_b++;
|
|
int bit_a = bit2aig(it.first);
|
|
int bit_en = bit2aig(it.second);
|
|
aig_outputs.push_back(mkgate(bit_a^1, bit_en));
|
|
}
|
|
|
|
for (auto it : assumes) {
|
|
aig_c++;
|
|
int bit_a = bit2aig(it.first);
|
|
int bit_en = bit2aig(it.second);
|
|
aig_outputs.push_back(mkgate(bit_a^1, bit_en)^1);
|
|
}
|
|
}
|
|
|
|
void write_aiger(std::ostream &f, bool ascii_mode, bool miter_mode, bool symbols_mode)
|
|
{
|
|
log_assert(aig_m == aig_i + aig_l + aig_a);
|
|
log_assert(aig_l == GetSize(aig_latchin));
|
|
log_assert(aig_l == GetSize(aig_latchinit));
|
|
log_assert((aig_o + aig_b + aig_c) == GetSize(aig_outputs));
|
|
|
|
if (miter_mode) {
|
|
if (aig_b || aig_c)
|
|
log_error("Running AIGER back-end in -miter mode, but design contains $assert and/or $assume cells!\n");
|
|
f << stringf("%s %d %d %d 0 %d %d\n", ascii_mode ? "aag" : "aig", aig_m, aig_i, aig_l, aig_a, aig_o);
|
|
} else {
|
|
f << stringf("%s %d %d %d %d %d", ascii_mode ? "aag" : "aig", aig_m, aig_i, aig_l, aig_o, aig_a);
|
|
if (aig_b || aig_c)
|
|
f << stringf(" %d %d", aig_b, aig_c);
|
|
f << stringf("\n");
|
|
}
|
|
|
|
if (ascii_mode)
|
|
{
|
|
for (int i = 0; i < aig_i; i++)
|
|
f << stringf("%d\n", 2*i+2);
|
|
|
|
for (int i = 0; i < aig_l; i++) {
|
|
if (zinit_mode || aig_latchinit.at(i) == 0)
|
|
f << stringf("%d %d\n", 2*(aig_i+i)+2, aig_latchin.at(i));
|
|
else if (aig_latchinit.at(i) == 1)
|
|
f << stringf("%d %d 1\n", 2*(aig_i+i)+2, aig_latchin.at(i));
|
|
else if (aig_latchinit.at(i) == 2)
|
|
f << stringf("%d %d %d\n", 2*(aig_i+i)+2, aig_latchin.at(i), 2*(aig_i+i)+2);
|
|
}
|
|
|
|
for (int i = 0; i < aig_o + aig_b + aig_c; i++)
|
|
f << stringf("%d\n", aig_outputs.at(i));
|
|
|
|
for (int i = 0; i < aig_a; i++)
|
|
f << stringf("%d %d %d\n", 2*(aig_i+aig_l+i)+2, aig_gates.at(i).first, aig_gates.at(i).second);
|
|
}
|
|
else
|
|
{
|
|
for (int i = 0; i < aig_l; i++) {
|
|
if (zinit_mode || aig_latchinit.at(i) == 0)
|
|
f << stringf("%d\n", aig_latchin.at(i));
|
|
else if (aig_latchinit.at(i) == 1)
|
|
f << stringf("%d 1\n", aig_latchin.at(i));
|
|
else if (aig_latchinit.at(i) == 2)
|
|
f << stringf("%d %d\n", aig_latchin.at(i), 2*(aig_i+i)+2);
|
|
}
|
|
|
|
for (int i = 0; i < aig_o + aig_b + aig_c; i++)
|
|
f << stringf("%d\n", aig_outputs.at(i));
|
|
|
|
for (int i = 0; i < aig_a; i++) {
|
|
int lhs = 2*(aig_i+aig_l+i)+2;
|
|
int rhs0 = aig_gates.at(i).first;
|
|
int rhs1 = aig_gates.at(i).second;
|
|
int delta0 = lhs - rhs0;
|
|
int delta1 = rhs0 - rhs1;
|
|
aiger_encode(f, delta0);
|
|
aiger_encode(f, delta1);
|
|
}
|
|
}
|
|
|
|
if (symbols_mode)
|
|
{
|
|
for (auto wire : module->wires())
|
|
{
|
|
if (wire->name[0] == '$')
|
|
continue;
|
|
|
|
SigSpec sig = sigmap(wire);
|
|
|
|
for (int i = 0; i < GetSize(wire); i++)
|
|
{
|
|
if (wire->port_input) {
|
|
int a = aig_map.at(sig[i]);
|
|
log_assert((a & 1) == 0);
|
|
if (GetSize(wire) != 1)
|
|
f << stringf("i%d %s[%d]\n", (a >> 1)-1, log_id(wire), i);
|
|
else
|
|
f << stringf("i%d %s\n", (a >> 1)-1, log_id(wire));
|
|
}
|
|
|
|
if (wire->port_output) {
|
|
int o = ordered_outputs.at(sig[i]);
|
|
if (GetSize(wire) != 1)
|
|
f << stringf("%c%d %s[%d]\n", miter_mode ? 'b' : 'o', o, log_id(wire), i);
|
|
else
|
|
f << stringf("%c%d %s\n", miter_mode ? 'b' : 'o', o, log_id(wire));
|
|
}
|
|
|
|
if (init_inputs.count(sig[i])) {
|
|
int a = init_inputs.at(sig[i]);
|
|
log_assert((a & 1) == 0);
|
|
if (GetSize(wire) != 1)
|
|
f << stringf("i%d init:%s[%d]\n", (a >> 1)-1, log_id(wire), i);
|
|
else
|
|
f << stringf("i%d init:%s\n", (a >> 1)-1, log_id(wire));
|
|
}
|
|
|
|
if (ordered_latches.count(sig[i])) {
|
|
int l = ordered_latches.at(sig[i]);
|
|
const char *p = (zinit_mode && (aig_latchinit.at(l) == 1)) ? "!" : "";
|
|
if (GetSize(wire) != 1)
|
|
f << stringf("l%d %s%s[%d]\n", l, p, log_id(wire), i);
|
|
else
|
|
f << stringf("l%d %s%s\n", l, p, log_id(wire));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
f << stringf("c\nGenerated by %s\n", yosys_version_str);
|
|
}
|
|
|
|
void write_map(std::ostream &f, bool verbose_map)
|
|
{
|
|
dict<int, string> input_lines;
|
|
dict<int, string> init_lines;
|
|
dict<int, string> output_lines;
|
|
dict<int, string> latch_lines;
|
|
dict<int, string> wire_lines;
|
|
|
|
for (auto wire : module->wires())
|
|
{
|
|
if (!verbose_map && wire->name[0] == '$')
|
|
continue;
|
|
|
|
SigSpec sig = sigmap(wire);
|
|
|
|
for (int i = 0; i < GetSize(wire); i++)
|
|
{
|
|
if (aig_map.count(sig[i]) == 0)
|
|
continue;
|
|
|
|
int a = aig_map.at(sig[i]);
|
|
|
|
if (verbose_map)
|
|
wire_lines[a] += stringf("wire %d %d %s\n", a, i, log_id(wire));
|
|
|
|
if (wire->port_input) {
|
|
log_assert((a & 1) == 0);
|
|
input_lines[a] += stringf("input %d %d %s\n", (a >> 1)-1, i, log_id(wire));
|
|
}
|
|
|
|
if (wire->port_output) {
|
|
int o = ordered_outputs.at(sig[i]);
|
|
output_lines[o] += stringf("output %d %d %s\n", o, i, log_id(wire));
|
|
}
|
|
|
|
if (init_inputs.count(sig[i])) {
|
|
int a = init_inputs.at(sig[i]);
|
|
log_assert((a & 1) == 0);
|
|
init_lines[a] += stringf("init %d %d %s\n", (a >> 1)-1, i, log_id(wire));
|
|
}
|
|
|
|
if (ordered_latches.count(sig[i])) {
|
|
int l = ordered_latches.at(sig[i]);
|
|
if (zinit_mode && (aig_latchinit.at(l) == 1))
|
|
latch_lines[l] += stringf("invlatch %d %d %s\n", l, i, log_id(wire));
|
|
else
|
|
latch_lines[l] += stringf("latch %d %d %s\n", l, i, log_id(wire));
|
|
}
|
|
}
|
|
}
|
|
|
|
input_lines.sort();
|
|
for (auto &it : input_lines)
|
|
f << it.second;
|
|
|
|
init_lines.sort();
|
|
for (auto &it : init_lines)
|
|
f << it.second;
|
|
|
|
output_lines.sort();
|
|
for (auto &it : output_lines)
|
|
f << it.second;
|
|
|
|
latch_lines.sort();
|
|
for (auto &it : latch_lines)
|
|
f << it.second;
|
|
|
|
wire_lines.sort();
|
|
for (auto &it : wire_lines)
|
|
f << it.second;
|
|
}
|
|
};
|
|
|
|
struct AigerBackend : public Backend {
|
|
AigerBackend() : Backend("aiger", "write design to AIGER file") { }
|
|
virtual void help()
|
|
{
|
|
// |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
|
|
log("\n");
|
|
log(" write_aiger [options] [filename]\n");
|
|
log("\n");
|
|
log("Write the current design to an AIGER file. The design must be flattened and\n");
|
|
log("must not contain any cell types except $_AND_, $_NOT_, simple FF types,\n");
|
|
log("$assert and $assume cells, and $initstate cells.\n");
|
|
log("\n");
|
|
log("$assert and $assume cells are converted to AIGER bad state properties and\n");
|
|
log("invariant constraints.\n");
|
|
log("\n");
|
|
log(" -ascii\n");
|
|
log(" write ASCII version of AGIER format\n");
|
|
log("\n");
|
|
log(" -zinit\n");
|
|
log(" convert FFs to zero-initialized FFs, adding additional inputs for\n");
|
|
log(" uninitialized FFs.\n");
|
|
log("\n");
|
|
log(" -miter\n");
|
|
log(" design outputs are AIGER bad state properties\n");
|
|
log("\n");
|
|
log(" -symbols\n");
|
|
log(" include a symbol table in the generated AIGER file\n");
|
|
log("\n");
|
|
log(" -map <filename>\n");
|
|
log(" write an extra file with port and latch symbols\n");
|
|
log("\n");
|
|
log(" -vmap <filename>\n");
|
|
log(" like -map, but more verbose\n");
|
|
log("\n");
|
|
}
|
|
virtual void execute(std::ostream *&f, std::string filename, std::vector<std::string> args, RTLIL::Design *design)
|
|
{
|
|
bool ascii_mode = false;
|
|
bool zinit_mode = false;
|
|
bool miter_mode = false;
|
|
bool symbols_mode = false;
|
|
bool verbose_map = false;
|
|
std::string map_filename;
|
|
|
|
log_header(design, "Executing AIGER backend.\n");
|
|
|
|
size_t argidx;
|
|
for (argidx = 1; argidx < args.size(); argidx++)
|
|
{
|
|
if (args[argidx] == "-ascii") {
|
|
ascii_mode = true;
|
|
continue;
|
|
}
|
|
if (args[argidx] == "-zinit") {
|
|
zinit_mode = true;
|
|
continue;
|
|
}
|
|
if (args[argidx] == "-miter") {
|
|
miter_mode = true;
|
|
continue;
|
|
}
|
|
if (args[argidx] == "-symbols") {
|
|
symbols_mode = true;
|
|
continue;
|
|
}
|
|
if (map_filename.empty() && args[argidx] == "-map" && argidx+1 < args.size()) {
|
|
map_filename = args[++argidx];
|
|
continue;
|
|
}
|
|
if (map_filename.empty() && args[argidx] == "-vmap" && argidx+1 < args.size()) {
|
|
map_filename = args[++argidx];
|
|
verbose_map = true;
|
|
continue;
|
|
}
|
|
break;
|
|
}
|
|
extra_args(f, filename, args, argidx);
|
|
|
|
Module *top_module = design->top_module();
|
|
|
|
if (top_module == nullptr)
|
|
log_error("Can't find top module in current design!\n");
|
|
|
|
AigerWriter writer(top_module, zinit_mode);
|
|
writer.write_aiger(*f, ascii_mode, miter_mode, symbols_mode);
|
|
|
|
if (!map_filename.empty()) {
|
|
std::ofstream mapf;
|
|
mapf.open(map_filename.c_str(), std::ofstream::trunc);
|
|
if (mapf.fail())
|
|
log_error("Can't open file `%s' for writing: %s\n", map_filename.c_str(), strerror(errno));
|
|
writer.write_map(mapf, verbose_map);
|
|
}
|
|
}
|
|
} AigerBackend;
|
|
|
|
PRIVATE_NAMESPACE_END
|