2 * yosys -- Yosys Open SYnthesis Suite
4 * Copyright (C) 2012 Clifford Wolf <clifford@clifford.at>
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.
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.
20 #include "kernel/rtlil.h"
21 #include "kernel/register.h"
22 #include "kernel/sigtools.h"
23 #include "kernel/celltypes.h"
24 #include "kernel/log.h"
28 PRIVATE_NAMESPACE_BEGIN
34 RTLIL::Module
*module
;
38 int initstate_nid
= -1;
41 dict
<int, int> sorts_bv
;
43 // (<address-width>, <data-width>) => <sid>
44 dict
<pair
<int, int>, int> sorts_mem
;
46 // SigBit => (<nid>, <bitidx>)
47 dict
<SigBit
, pair
<int, int>> bit_nid
;
50 dict
<int, int> nid_width
;
53 dict
<SigSpec
, int> sig_nid
;
55 // bit to driving cell
56 dict
<SigBit
, Cell
*> bit_cell
;
59 dict
<Const
, int> consts
;
61 // ff inputs that need to be evaluated (<nid>, <ff_cell>)
62 vector
<pair
<int, Cell
*>> ff_todo
;
64 pool
<Cell
*> cell_recursion_guard
;
65 pool
<string
> output_symbols
;
68 void btorf(const char *fmt
, ...)
72 f
<< indent
<< vstringf(fmt
, ap
);
76 void btorf_push(const string
&id
)
79 f
<< indent
<< stringf(" ; begin %s\n", id
.c_str());
84 void btorf_pop(const string
&id
)
87 indent
= indent
.substr(4);
88 f
<< indent
<< stringf(" ; end %s\n", id
.c_str());
92 int get_bv_sid(int width
)
94 if (sorts_bv
.count(width
) == 0) {
96 btorf("%d sort bitvec %d\n", nid
, width
);
97 sorts_bv
[width
] = nid
;
99 return sorts_bv
.at(width
);
102 void add_nid_sig(int nid
, const SigSpec
&sig
)
104 for (int i
= 0; i
< GetSize(sig
); i
++)
105 bit_nid
[sig
[i
]] = make_pair(nid
, i
);
108 nid_width
[nid
] = GetSize(sig
);
111 void export_cell(Cell
*cell
)
113 log_assert(cell_recursion_guard
.count(cell
) == 0);
114 cell_recursion_guard
.insert(cell
);
115 btorf_push(log_id(cell
));
117 if (cell
->type
.in("$add", "$sub", "$xor"))
120 if (cell
->type
== "$add") btor_op
= "add";
121 if (cell
->type
== "$sub") btor_op
= "sub";
122 if (cell
->type
== "$xor") btor_op
= "xor";
123 log_assert(!btor_op
.empty());
125 int width
= GetSize(cell
->getPort("\\Y"));
126 width
= std::max(width
, GetSize(cell
->getPort("\\A")));
127 width
= std::max(width
, GetSize(cell
->getPort("\\B")));
129 bool a_signed
= cell
->hasParam("\\A_SIGNED") ? cell
->getParam("\\A_SIGNED").as_bool() : false;
130 bool b_signed
= cell
->hasParam("\\B_SIGNED") ? cell
->getParam("\\B_SIGNED").as_bool() : false;
132 int sid
= get_bv_sid(width
);
133 int nid_a
= get_sig_nid(cell
->getPort("\\A"), width
, a_signed
);
134 int nid_b
= get_sig_nid(cell
->getPort("\\B"), width
, b_signed
);
136 int nid
= next_nid
++;
137 btorf("%d %s %d %d %d\n", nid
, btor_op
.c_str(), sid
, nid_a
, nid_b
);
139 SigSpec sig
= sigmap(cell
->getPort("\\Y"));
141 if (GetSize(sig
) < width
) {
142 int sid
= get_bv_sid(GetSize(sig
));
143 int nid2
= next_nid
++;
144 btorf("%d slice %d %d %d 0\n", nid2
, sid
, nid
, GetSize(sig
)-1);
148 add_nid_sig(nid
, sig
);
152 if (cell
->type
.in("$logic_and", "$logic_or"))
155 if (cell
->type
== "$logic_and") btor_op
= "and";
156 if (cell
->type
== "$logic_or") btor_op
= "or";
157 log_assert(!btor_op
.empty());
159 int sid
= get_bv_sid(1);
160 int nid_a
= get_sig_nid(cell
->getPort("\\A"));
161 int nid_b
= get_sig_nid(cell
->getPort("\\B"));
163 if (GetSize(cell
->getPort("\\A")) > 1) {
164 int nid_red_a
= next_nid
++;
165 btorf("%d redor %d %d\n", nid_red_a
, sid
, nid_a
);
169 if (GetSize(cell
->getPort("\\B")) > 1) {
170 int nid_red_b
= next_nid
++;
171 btorf("%d redor %d %d\n", nid_red_b
, sid
, nid_b
);
175 int nid
= next_nid
++;
176 btorf("%d %s %d %d %d\n", nid
, btor_op
.c_str(), sid
, nid_a
, nid_b
);
178 SigSpec sig
= sigmap(cell
->getPort("\\Y"));
180 if (GetSize(sig
) > 1) {
181 int sid
= get_bv_sid(GetSize(sig
));
182 int zeros_nid
= get_sig_nid(Const(0, GetSize(sig
)-1));
183 int nid2
= next_nid
++;
184 btorf("%d concat %d %d %d\n", nid2
, sid
, zeros_nid
, nid
);
188 add_nid_sig(nid
, sig
);
192 if (cell
->type
.in("$mux", "$_MUX_"))
194 SigSpec sig_a
= sigmap(cell
->getPort("\\A"));
195 SigSpec sig_b
= sigmap(cell
->getPort("\\B"));
196 SigSpec sig_s
= sigmap(cell
->getPort("\\S"));
197 SigSpec sig_y
= sigmap(cell
->getPort("\\Y"));
199 int nid_a
= get_sig_nid(sig_a
);
200 int nid_b
= get_sig_nid(sig_b
);
201 int nid_s
= get_sig_nid(sig_s
);
203 int sid
= get_bv_sid(GetSize(sig_y
));
204 int nid
= next_nid
++;
205 btorf("%d ite %d %d %d %d\n", nid
, sid
, nid_s
, nid_b
, nid_a
);
207 add_nid_sig(nid
, sig_y
);
211 if (cell
->type
.in("$dff", "$ff", "$_DFF_P_", "$_DFF_N", "$_FF_"))
213 SigSpec sig_d
= sigmap(cell
->getPort("\\D"));
214 SigSpec sig_q
= sigmap(cell
->getPort("\\Q"));
216 string symbol
= log_signal(sig_q
);
217 if (symbol
.find(' ') != string::npos
)
218 symbol
= log_id(cell
);
220 if (symbol
[0] == '\\')
221 symbol
= symbol
.substr(1);
223 int sid
= get_bv_sid(GetSize(sig_q
));
224 int nid
= next_nid
++;
226 if (output_symbols
.count(symbol
))
227 btorf("%d state %d\n", nid
, sid
);
229 btorf("%d state %d %s\n", nid
, sid
, symbol
.c_str());
231 ff_todo
.push_back(make_pair(nid
, cell
));
232 add_nid_sig(nid
, sig_q
);
236 if (cell
->type
== "$initstate")
238 SigSpec sig_y
= sigmap(cell
->getPort("\\Y"));
240 if (initstate_nid
< 0)
242 int sid
= get_bv_sid(1);
243 int one_nid
= get_sig_nid(Const(1, 1));
244 int zero_nid
= get_sig_nid(Const(0, 1));
245 initstate_nid
= next_nid
++;
246 btorf("%d state %d\n", initstate_nid
, sid
);
247 btorf("%d init %d %d %d\n", next_nid
++, sid
, initstate_nid
, one_nid
);
248 btorf("%d next %d %d %d\n", next_nid
++, sid
, initstate_nid
, zero_nid
);
251 add_nid_sig(initstate_nid
, sig_y
);
255 log_error("Unsupported cell type: %s (%s)\n", log_id(cell
->type
), log_id(cell
));
258 btorf_pop(log_id(cell
));
259 cell_recursion_guard
.erase(cell
);
262 int get_sig_nid(SigSpec sig
, int to_width
= -1, bool is_signed
= false)
266 if (sig_nid
.count(sig
) == 0)
269 vector
<pair
<int, int>> nidbits
;
272 for (int i
= 0; i
< GetSize(sig
); i
++)
276 if (bit_nid
.count(bit
) == 0)
278 if (bit
.wire
== nullptr)
282 while (i
+GetSize(c
) < GetSize(sig
) && sig
[i
+GetSize(c
)].wire
== nullptr)
283 c
.bits
.push_back(sig
[i
+GetSize(c
)].data
);
285 if (consts
.count(c
) == 0) {
286 int sid
= get_bv_sid(GetSize(c
));
287 int nid
= next_nid
++;
288 btorf("%d const %d %s\n", nid
, sid
, c
.as_string().c_str());
290 nid_width
[nid
] = GetSize(c
);
293 int nid
= consts
.at(c
);
295 for (int j
= 0; j
< GetSize(c
); j
++)
296 nidbits
.push_back(make_pair(nid
, j
));
303 export_cell(bit_cell
.at(bit
));
304 log_assert(bit_nid
.count(bit
));
308 nidbits
.push_back(bit_nid
.at(bit
));
314 // group bits and emit slice-concat chain
315 for (int i
= 0; i
< GetSize(nidbits
); i
++)
317 int nid2
= nidbits
[i
].first
;
318 int lower
= nidbits
[i
].second
;
321 while (i
+1 < GetSize(nidbits
) && nidbits
[i
+1].first
== nidbits
[i
].first
&&
322 nidbits
[i
+1].second
== nidbits
[i
].second
+1)
327 if (lower
!= 0 || upper
+1 != nid_width
.at(nid2
)) {
328 int sid
= get_bv_sid(upper
-lower
+1);
330 btorf("%d slice %d %d %d %d\n", nid3
, sid
, nid2
, upper
, lower
);
336 int sid
= get_bv_sid(width
+upper
-lower
+1);
337 int nid4
= next_nid
++;
338 btorf("%d concat %d %d %d\n", nid4
, sid
, nid
, nid3
);
341 width
+= upper
-lower
+1;
346 nid_width
[nid
] = width
;
349 int nid
= sig_nid
.at(sig
);
351 if (to_width
>= 0 && to_width
!= GetSize(sig
))
353 if (to_width
< GetSize(sig
))
355 int sid
= get_bv_sid(to_width
);
356 int nid2
= next_nid
++;
357 btorf("%d slice %d %d %d 0\n", nid2
, sid
, nid
, to_width
-1);
362 int sid
= get_bv_sid(to_width
);
363 int nid2
= next_nid
++;
364 btorf("%d %s %d %d %d\n", nid2
, is_signed
? "sext" : "uext",
365 sid
, nid
, to_width
- GetSize(sig
));
373 BtorWorker(std::ostream
&f
, RTLIL::Module
*module
, bool verbose
) :
374 f(f
), sigmap(module
), module(module
), verbose(verbose
)
376 btorf_push("inputs");
378 for (auto wire
: module
->wires())
380 if (!wire
->port_id
|| !wire
->port_input
)
383 SigSpec sig
= sigmap(wire
);
384 int sid
= get_bv_sid(GetSize(sig
));
385 int nid
= next_nid
++;
387 btorf("%d input %d %s\n", nid
, sid
, log_id(wire
));
388 add_nid_sig(nid
, sig
);
393 for (auto cell
: module
->cells())
394 for (auto &conn
: cell
->connections())
396 if (!cell
->output(conn
.first
))
399 for (auto bit
: sigmap(conn
.second
))
400 bit_cell
[bit
] = cell
;
403 for (auto wire
: module
->wires())
404 if (wire
->port_output
)
405 output_symbols
.insert(log_id(wire
));
407 for (auto wire
: module
->wires())
409 if (!wire
->port_id
|| !wire
->port_output
)
412 btorf_push(stringf("output %s", log_id(wire
)));
414 int nid
= get_sig_nid(wire
);
415 btorf("%d output %d %s\n", next_nid
++, nid
, log_id(wire
));
417 btorf_pop(stringf("output %s", log_id(wire
)));
420 for (auto cell
: module
->cells())
422 if (cell
->type
== "$assume")
424 btorf_push(log_id(cell
));
426 int sid
= get_bv_sid(1);
427 int nid_a
= get_sig_nid(cell
->getPort("\\A"));
428 int nid_en
= get_sig_nid(cell
->getPort("\\EN"));
429 int nid_not_en
= next_nid
++;
430 int nid_a_or_not_en
= next_nid
++;
431 int nid
= next_nid
++;
433 btorf("%d not %d %d\n", nid_not_en
, sid
, nid_en
);
434 btorf("%d or %d %d %d\n", nid_a_or_not_en
, sid
, nid_a
, nid_not_en
);
435 btorf("%d constraint %d\n", nid
, nid_a_or_not_en
);
437 btorf_pop(log_id(cell
));
440 if (cell
->type
== "$assert")
442 btorf_push(log_id(cell
));
444 int sid
= get_bv_sid(1);
445 int nid_a
= get_sig_nid(cell
->getPort("\\A"));
446 int nid_en
= get_sig_nid(cell
->getPort("\\EN"));
447 int nid_not_a
= next_nid
++;
448 int nid_en_and_not_a
= next_nid
++;
449 int nid
= next_nid
++;
451 btorf("%d not %d %d\n", nid_not_a
, sid
, nid_a
);
452 btorf("%d and %d %d %d\n", nid_en_and_not_a
, sid
, nid_en
, nid_not_a
);
453 btorf("%d bad %d\n", nid
, nid_en_and_not_a
);
455 btorf_pop(log_id(cell
));
459 while (!ff_todo
.empty())
461 vector
<pair
<int, Cell
*>> todo
;
464 for (auto &it
: todo
)
466 btorf_push(stringf("next %s", log_id(it
.second
)));
468 SigSpec sig
= sigmap(it
.second
->getPort("\\D"));
470 int nid
= get_sig_nid(sig
);
471 int sid
= get_bv_sid(GetSize(sig
));
472 btorf("%d next %d %d %d\n", next_nid
++, sid
, it
.first
, nid
);
474 btorf_pop(stringf("next %s", log_id(it
.second
)));
480 struct BtorBackend
: public Backend
{
481 BtorBackend() : Backend("btor", "write design to BTOR file") { }
484 // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
486 log(" write_btor [options] [filename]\n");
488 log("Write a BTOR description of the current design.\n");
491 log(" Add comments and indentation to BTOR output file\n");
494 virtual void execute(std::ostream
*&f
, std::string filename
, std::vector
<std::string
> args
, RTLIL::Design
*design
)
496 bool verbose
= false;
498 log_header(design
, "Executing BTOR backend.\n");
501 for (argidx
= 1; argidx
< args
.size(); argidx
++)
503 if (args
[argidx
] == "-v") {
509 extra_args(f
, filename
, args
, argidx
);
511 RTLIL::Module
*topmod
= design
->top_module();
513 if (topmod
== nullptr)
514 log_cmd_error("No top module found.\n");
516 *f
<< stringf("; BTOR description generated by %s for module %s.\n",
517 yosys_version_str
, log_id(topmod
));
519 BtorWorker(*f
, topmod
, verbose
);
521 *f
<< stringf("; end of yosys output\n");
525 PRIVATE_NAMESPACE_END