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 // [[CITE]] Temporal Induction by Incremental SAT Solving
21 // Niklas Een and Niklas Sörensson (2003)
22 // http://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.4.8161
24 #include "kernel/register.h"
25 #include "kernel/celltypes.h"
26 #include "kernel/consteval.h"
27 #include "kernel/sigtools.h"
28 #include "kernel/log.h"
29 #include "kernel/satgen.h"
37 PRIVATE_NAMESPACE_BEGIN
41 RTLIL::Design
*design
;
42 RTLIL::Module
*module
;
50 // additional constraints
51 std::vector
<std::pair
<std::string
, std::string
>> sets
, prove
, prove_x
, sets_init
;
52 std::map
<int, std::vector
<std::pair
<std::string
, std::string
>>> sets_at
;
53 std::map
<int, std::vector
<std::string
>> unsets_at
;
54 bool prove_asserts
, set_assumes
;
57 bool enable_undef
, set_init_def
, set_init_undef
, set_init_zero
, ignore_unknown_cells
;
58 std::vector
<std::string
> sets_def
, sets_any_undef
, sets_all_undef
;
59 std::map
<int, std::vector
<std::string
>> sets_def_at
, sets_any_undef_at
, sets_all_undef_at
;
62 std::vector
<std::string
> shows
;
63 SigPool show_signal_pool
;
64 SigSet
<RTLIL::Cell
*> show_drivers
;
65 int max_timestep
, timeout
;
68 SatHelper(RTLIL::Design
*design
, RTLIL::Module
*module
, bool enable_undef
) :
69 design(design
), module(module
), sigmap(module
), ct(design
), satgen(ez
.get(), &sigmap
)
71 this->enable_undef
= enable_undef
;
72 satgen
.model_undef
= enable_undef
;
74 set_init_undef
= false;
75 set_init_zero
= false;
76 ignore_unknown_cells
= false;
82 void check_undef_enabled(const RTLIL::SigSpec
&sig
)
87 std::vector
<RTLIL::SigBit
> sigbits
= sig
.to_sigbit_vector();
88 for (size_t i
= 0; i
< sigbits
.size(); i
++)
89 if (sigbits
[i
].wire
== NULL
&& sigbits
[i
].data
== RTLIL::State::Sx
)
90 log_cmd_error("Bit %d of %s is undef but option -enable_undef is missing!\n", int(i
), log_signal(sig
));
93 void setup(int timestep
= -1, bool initstate
= false)
96 log ("\nSetting up time step %d:\n", timestep
);
98 log ("\nSetting up SAT problem:\n");
101 satgen
.setInitState(timestep
);
103 if (timestep
> max_timestep
)
104 max_timestep
= timestep
;
106 RTLIL::SigSpec big_lhs
, big_rhs
;
110 RTLIL::SigSpec lhs
, rhs
;
112 if (!RTLIL::SigSpec::parse_sel(lhs
, design
, module
, s
.first
))
113 log_cmd_error("Failed to parse lhs set expression `%s'.\n", s
.first
.c_str());
114 if (!RTLIL::SigSpec::parse_rhs(lhs
, rhs
, module
, s
.second
))
115 log_cmd_error("Failed to parse rhs set expression `%s'.\n", s
.second
.c_str());
116 show_signal_pool
.add(sigmap(lhs
));
117 show_signal_pool
.add(sigmap(rhs
));
119 if (lhs
.size() != rhs
.size())
120 log_cmd_error("Set expression with different lhs and rhs sizes: %s (%s, %d bits) vs. %s (%s, %d bits)\n",
121 s
.first
.c_str(), log_signal(lhs
), lhs
.size(), s
.second
.c_str(), log_signal(rhs
), rhs
.size());
123 log("Import set-constraint: %s = %s\n", log_signal(lhs
), log_signal(rhs
));
124 big_lhs
.remove2(lhs
, &big_rhs
);
129 for (auto &s
: sets_at
[timestep
])
131 RTLIL::SigSpec lhs
, rhs
;
133 if (!RTLIL::SigSpec::parse_sel(lhs
, design
, module
, s
.first
))
134 log_cmd_error("Failed to parse lhs set expression `%s'.\n", s
.first
.c_str());
135 if (!RTLIL::SigSpec::parse_rhs(lhs
, rhs
, module
, s
.second
))
136 log_cmd_error("Failed to parse rhs set expression `%s'.\n", s
.second
.c_str());
137 show_signal_pool
.add(sigmap(lhs
));
138 show_signal_pool
.add(sigmap(rhs
));
140 if (lhs
.size() != rhs
.size())
141 log_cmd_error("Set expression with different lhs and rhs sizes: %s (%s, %d bits) vs. %s (%s, %d bits)\n",
142 s
.first
.c_str(), log_signal(lhs
), lhs
.size(), s
.second
.c_str(), log_signal(rhs
), rhs
.size());
144 log("Import set-constraint for this timestep: %s = %s\n", log_signal(lhs
), log_signal(rhs
));
145 big_lhs
.remove2(lhs
, &big_rhs
);
150 for (auto &s
: unsets_at
[timestep
])
154 if (!RTLIL::SigSpec::parse_sel(lhs
, design
, module
, s
))
155 log_cmd_error("Failed to parse lhs set expression `%s'.\n", s
.c_str());
156 show_signal_pool
.add(sigmap(lhs
));
158 log("Import unset-constraint for this timestep: %s\n", log_signal(lhs
));
159 big_lhs
.remove2(lhs
, &big_rhs
);
162 log("Final constraint equation: %s = %s\n", log_signal(big_lhs
), log_signal(big_rhs
));
163 check_undef_enabled(big_lhs
), check_undef_enabled(big_rhs
);
164 ez
->assume(satgen
.signals_eq(big_lhs
, big_rhs
, timestep
));
167 // 1 = sets_any_undef
168 // 2 = sets_all_undef
169 std::set
<RTLIL::SigSpec
> sets_def_undef
[3];
171 for (auto &s
: sets_def
) {
173 if (!RTLIL::SigSpec::parse_sel(sig
, design
, module
, s
))
174 log_cmd_error("Failed to parse set-def expression `%s'.\n", s
.c_str());
175 sets_def_undef
[0].insert(sig
);
178 for (auto &s
: sets_any_undef
) {
180 if (!RTLIL::SigSpec::parse_sel(sig
, design
, module
, s
))
181 log_cmd_error("Failed to parse set-def expression `%s'.\n", s
.c_str());
182 sets_def_undef
[1].insert(sig
);
185 for (auto &s
: sets_all_undef
) {
187 if (!RTLIL::SigSpec::parse_sel(sig
, design
, module
, s
))
188 log_cmd_error("Failed to parse set-def expression `%s'.\n", s
.c_str());
189 sets_def_undef
[2].insert(sig
);
192 for (auto &s
: sets_def_at
[timestep
]) {
194 if (!RTLIL::SigSpec::parse_sel(sig
, design
, module
, s
))
195 log_cmd_error("Failed to parse set-def expression `%s'.\n", s
.c_str());
196 sets_def_undef
[0].insert(sig
);
197 sets_def_undef
[1].erase(sig
);
198 sets_def_undef
[2].erase(sig
);
201 for (auto &s
: sets_any_undef_at
[timestep
]) {
203 if (!RTLIL::SigSpec::parse_sel(sig
, design
, module
, s
))
204 log_cmd_error("Failed to parse set-def expression `%s'.\n", s
.c_str());
205 sets_def_undef
[0].erase(sig
);
206 sets_def_undef
[1].insert(sig
);
207 sets_def_undef
[2].erase(sig
);
210 for (auto &s
: sets_all_undef_at
[timestep
]) {
212 if (!RTLIL::SigSpec::parse_sel(sig
, design
, module
, s
))
213 log_cmd_error("Failed to parse set-def expression `%s'.\n", s
.c_str());
214 sets_def_undef
[0].erase(sig
);
215 sets_def_undef
[1].erase(sig
);
216 sets_def_undef
[2].insert(sig
);
219 for (int t
= 0; t
< 3; t
++)
220 for (auto &sig
: sets_def_undef
[t
]) {
221 log("Import %s constraint for this timestep: %s\n", t
== 0 ? "def" : t
== 1 ? "any_undef" : "all_undef", log_signal(sig
));
222 std::vector
<int> undef_sig
= satgen
.importUndefSigSpec(sig
, timestep
);
224 ez
->assume(ez
->NOT(ez
->expression(ezSAT::OpOr
, undef_sig
)));
226 ez
->assume(ez
->expression(ezSAT::OpOr
, undef_sig
));
228 ez
->assume(ez
->expression(ezSAT::OpAnd
, undef_sig
));
231 int import_cell_counter
= 0;
232 for (auto cell
: module
->cells())
233 if (design
->selected(module
, cell
)) {
234 // log("Import cell: %s\n", RTLIL::id2cstr(cell->name));
235 if (satgen
.importCell(cell
, timestep
)) {
236 for (auto &p
: cell
->connections())
237 if (ct
.cell_output(cell
->type
, p
.first
))
238 show_drivers
.insert(sigmap(p
.second
), cell
);
239 import_cell_counter
++;
240 } else if (ignore_unknown_cells
)
241 log_warning("Failed to import cell %s (type %s) to SAT database.\n", RTLIL::id2cstr(cell
->name
), RTLIL::id2cstr(cell
->type
));
243 log_error("Failed to import cell %s (type %s) to SAT database.\n", RTLIL::id2cstr(cell
->name
), RTLIL::id2cstr(cell
->type
));
245 log("Imported %d cells to SAT database.\n", import_cell_counter
);
248 RTLIL::SigSpec assumes_a
, assumes_en
;
249 satgen
.getAssumes(assumes_a
, assumes_en
, timestep
);
250 for (int i
= 0; i
< GetSize(assumes_a
); i
++)
251 log("Import constraint from assume cell: %s when %s.\n", log_signal(assumes_a
[i
]), log_signal(assumes_en
[i
]));
252 ez
->assume(satgen
.importAssumes(timestep
));
257 RTLIL::SigSpec big_lhs
, big_rhs
;
259 for (auto &it
: module
->wires_
)
261 if (it
.second
->attributes
.count("\\init") == 0)
264 RTLIL::SigSpec lhs
= sigmap(it
.second
);
265 RTLIL::SigSpec rhs
= it
.second
->attributes
.at("\\init");
266 log_assert(lhs
.size() == rhs
.size());
268 RTLIL::SigSpec removed_bits
;
269 for (int i
= 0; i
< lhs
.size(); i
++) {
270 RTLIL::SigSpec bit
= lhs
.extract(i
, 1);
271 if (!satgen
.initial_state
.check_all(bit
)) {
272 removed_bits
.append(bit
);
279 if (removed_bits
.size())
280 log_warning("ignoring initial value on non-register: %s\n", log_signal(removed_bits
));
283 log("Import set-constraint from init attribute: %s = %s\n", log_signal(lhs
), log_signal(rhs
));
284 big_lhs
.remove2(lhs
, &big_rhs
);
290 for (auto &s
: sets_init
)
292 RTLIL::SigSpec lhs
, rhs
;
294 if (!RTLIL::SigSpec::parse_sel(lhs
, design
, module
, s
.first
))
295 log_cmd_error("Failed to parse lhs set expression `%s'.\n", s
.first
.c_str());
296 if (!RTLIL::SigSpec::parse_rhs(lhs
, rhs
, module
, s
.second
))
297 log_cmd_error("Failed to parse rhs set expression `%s'.\n", s
.second
.c_str());
298 show_signal_pool
.add(sigmap(lhs
));
299 show_signal_pool
.add(sigmap(rhs
));
301 if (lhs
.size() != rhs
.size())
302 log_cmd_error("Set expression with different lhs and rhs sizes: %s (%s, %d bits) vs. %s (%s, %d bits)\n",
303 s
.first
.c_str(), log_signal(lhs
), lhs
.size(), s
.second
.c_str(), log_signal(rhs
), rhs
.size());
305 log("Import init set-constraint: %s = %s\n", log_signal(lhs
), log_signal(rhs
));
306 big_lhs
.remove2(lhs
, &big_rhs
);
311 if (!satgen
.initial_state
.check_all(big_lhs
)) {
312 RTLIL::SigSpec rem
= satgen
.initial_state
.remove(big_lhs
);
313 log_cmd_error("Found -set-init bits that are not part of the initial_state: %s\n", log_signal(rem
));
317 RTLIL::SigSpec rem
= satgen
.initial_state
.export_all();
318 std::vector
<int> undef_rem
= satgen
.importUndefSigSpec(rem
, 1);
319 ez
->assume(ez
->NOT(ez
->expression(ezSAT::OpOr
, undef_rem
)));
322 if (set_init_undef
) {
323 RTLIL::SigSpec rem
= satgen
.initial_state
.export_all();
326 big_rhs
.append(RTLIL::SigSpec(RTLIL::State::Sx
, rem
.size()));
330 RTLIL::SigSpec rem
= satgen
.initial_state
.export_all();
333 big_rhs
.append(RTLIL::SigSpec(RTLIL::State::S0
, rem
.size()));
336 if (big_lhs
.size() == 0) {
337 log("No constraints for initial state found.\n\n");
341 log("Final init constraint equation: %s = %s\n", log_signal(big_lhs
), log_signal(big_rhs
));
342 check_undef_enabled(big_lhs
), check_undef_enabled(big_rhs
);
343 ez
->assume(satgen
.signals_eq(big_lhs
, big_rhs
, timestep
));
347 int setup_proof(int timestep
= -1)
349 log_assert(prove
.size() || prove_x
.size() || prove_asserts
);
351 RTLIL::SigSpec big_lhs
, big_rhs
;
352 std::vector
<int> prove_bits
;
354 if (prove
.size() > 0)
356 for (auto &s
: prove
)
358 RTLIL::SigSpec lhs
, rhs
;
360 if (!RTLIL::SigSpec::parse_sel(lhs
, design
, module
, s
.first
))
361 log_cmd_error("Failed to parse lhs proof expression `%s'.\n", s
.first
.c_str());
362 if (!RTLIL::SigSpec::parse_rhs(lhs
, rhs
, module
, s
.second
))
363 log_cmd_error("Failed to parse rhs proof expression `%s'.\n", s
.second
.c_str());
364 show_signal_pool
.add(sigmap(lhs
));
365 show_signal_pool
.add(sigmap(rhs
));
367 if (lhs
.size() != rhs
.size())
368 log_cmd_error("Proof expression with different lhs and rhs sizes: %s (%s, %d bits) vs. %s (%s, %d bits)\n",
369 s
.first
.c_str(), log_signal(lhs
), lhs
.size(), s
.second
.c_str(), log_signal(rhs
), rhs
.size());
371 log("Import proof-constraint: %s = %s\n", log_signal(lhs
), log_signal(rhs
));
372 big_lhs
.remove2(lhs
, &big_rhs
);
377 log("Final proof equation: %s = %s\n", log_signal(big_lhs
), log_signal(big_rhs
));
378 check_undef_enabled(big_lhs
), check_undef_enabled(big_rhs
);
379 prove_bits
.push_back(satgen
.signals_eq(big_lhs
, big_rhs
, timestep
));
382 if (prove_x
.size() > 0)
384 for (auto &s
: prove_x
)
386 RTLIL::SigSpec lhs
, rhs
;
388 if (!RTLIL::SigSpec::parse_sel(lhs
, design
, module
, s
.first
))
389 log_cmd_error("Failed to parse lhs proof-x expression `%s'.\n", s
.first
.c_str());
390 if (!RTLIL::SigSpec::parse_rhs(lhs
, rhs
, module
, s
.second
))
391 log_cmd_error("Failed to parse rhs proof-x expression `%s'.\n", s
.second
.c_str());
392 show_signal_pool
.add(sigmap(lhs
));
393 show_signal_pool
.add(sigmap(rhs
));
395 if (lhs
.size() != rhs
.size())
396 log_cmd_error("Proof-x expression with different lhs and rhs sizes: %s (%s, %d bits) vs. %s (%s, %d bits)\n",
397 s
.first
.c_str(), log_signal(lhs
), lhs
.size(), s
.second
.c_str(), log_signal(rhs
), rhs
.size());
399 log("Import proof-x-constraint: %s = %s\n", log_signal(lhs
), log_signal(rhs
));
400 big_lhs
.remove2(lhs
, &big_rhs
);
405 log("Final proof-x equation: %s = %s\n", log_signal(big_lhs
), log_signal(big_rhs
));
407 std::vector
<int> value_lhs
= satgen
.importDefSigSpec(big_lhs
, timestep
);
408 std::vector
<int> value_rhs
= satgen
.importDefSigSpec(big_rhs
, timestep
);
410 std::vector
<int> undef_lhs
= satgen
.importUndefSigSpec(big_lhs
, timestep
);
411 std::vector
<int> undef_rhs
= satgen
.importUndefSigSpec(big_rhs
, timestep
);
413 for (size_t i
= 0; i
< value_lhs
.size(); i
++)
414 prove_bits
.push_back(ez
->OR(undef_lhs
.at(i
), ez
->AND(ez
->NOT(undef_rhs
.at(i
)), ez
->NOT(ez
->XOR(value_lhs
.at(i
), value_rhs
.at(i
))))));
418 RTLIL::SigSpec asserts_a
, asserts_en
;
419 satgen
.getAsserts(asserts_a
, asserts_en
, timestep
);
420 for (int i
= 0; i
< GetSize(asserts_a
); i
++)
421 log("Import proof for assert: %s when %s.\n", log_signal(asserts_a
[i
]), log_signal(asserts_en
[i
]));
422 prove_bits
.push_back(satgen
.importAsserts(timestep
));
425 return ez
->expression(ezSAT::OpAnd
, prove_bits
);
428 void force_unique_state(int timestep_from
, int timestep_to
)
430 RTLIL::SigSpec state_signals
= satgen
.initial_state
.export_all();
431 for (int i
= timestep_from
; i
< timestep_to
; i
++)
432 ez
->assume(ez
->NOT(satgen
.signals_eq(state_signals
, state_signals
, i
, timestep_to
)));
435 bool solve(const std::vector
<int> &assumptions
)
437 log_assert(gotTimeout
== false);
438 ez
->setSolverTimeout(timeout
);
439 bool success
= ez
->solve(modelExpressions
, modelValues
, assumptions
);
440 if (ez
->getSolverTimoutStatus())
445 bool solve(int a
= 0, int b
= 0, int c
= 0, int d
= 0, int e
= 0, int f
= 0)
447 log_assert(gotTimeout
== false);
448 ez
->setSolverTimeout(timeout
);
449 bool success
= ez
->solve(modelExpressions
, modelValues
, a
, b
, c
, d
, e
, f
);
450 if (ez
->getSolverTimoutStatus())
455 struct ModelBlockInfo
{
456 int timestep
, offset
, width
;
457 std::string description
;
458 bool operator < (const ModelBlockInfo
&other
) const {
459 if (timestep
!= other
.timestep
)
460 return timestep
< other
.timestep
;
461 if (description
!= other
.description
)
462 return description
< other
.description
;
463 if (offset
!= other
.offset
)
464 return offset
< other
.offset
;
465 if (width
!= other
.width
)
466 return width
< other
.width
;
471 std::vector
<int> modelExpressions
;
472 std::vector
<bool> modelValues
;
473 std::set
<ModelBlockInfo
> modelInfo
;
475 void maximize_undefs()
477 log_assert(enable_undef
);
478 std::vector
<bool> backupValues
;
482 std::vector
<int> must_undef
, maybe_undef
;
484 for (size_t i
= 0; i
< modelExpressions
.size()/2; i
++)
485 if (modelValues
.at(modelExpressions
.size()/2 + i
))
486 must_undef
.push_back(modelExpressions
.at(modelExpressions
.size()/2 + i
));
488 maybe_undef
.push_back(modelExpressions
.at(modelExpressions
.size()/2 + i
));
490 backupValues
.swap(modelValues
);
491 if (!solve(ez
->expression(ezSAT::OpAnd
, must_undef
), ez
->expression(ezSAT::OpOr
, maybe_undef
)))
495 backupValues
.swap(modelValues
);
498 void generate_model()
500 RTLIL::SigSpec modelSig
;
501 modelExpressions
.clear();
504 // Add "show" signals or alternatively the leaves on the input cone on all set and prove signals
506 if (shows
.size() == 0)
508 SigPool queued_signals
, handled_signals
, final_signals
;
509 queued_signals
= show_signal_pool
;
510 while (queued_signals
.size() > 0) {
511 RTLIL::SigSpec sig
= queued_signals
.export_one();
512 queued_signals
.del(sig
);
513 handled_signals
.add(sig
);
514 std::set
<RTLIL::Cell
*> drivers
= show_drivers
.find(sig
);
515 if (drivers
.size() == 0) {
516 final_signals
.add(sig
);
518 for (auto &d
: drivers
)
519 for (auto &p
: d
->connections()) {
520 if (d
->type
== "$dff" && p
.first
== "\\CLK")
522 if (d
->type
.substr(0, 6) == "$_DFF_" && p
.first
== "\\C")
524 queued_signals
.add(handled_signals
.remove(sigmap(p
.second
)));
528 modelSig
= final_signals
.export_all();
530 // additionally add all set and prove signals directly
531 // (it improves user confidence if we write the constraints back ;-)
532 modelSig
.append(show_signal_pool
.export_all());
536 for (auto &s
: shows
) {
538 if (!RTLIL::SigSpec::parse_sel(sig
, design
, module
, s
))
539 log_cmd_error("Failed to parse show expression `%s'.\n", s
.c_str());
540 log("Import show expression: %s\n", log_signal(sig
));
541 modelSig
.append(sig
);
545 modelSig
.sort_and_unify();
546 // log("Model signals: %s\n", log_signal(modelSig));
548 std::vector
<int> modelUndefExpressions
;
550 for (auto &c
: modelSig
.chunks())
554 RTLIL::SigSpec chunksig
= c
;
555 info
.width
= chunksig
.size();
556 info
.description
= log_signal(chunksig
);
558 for (int timestep
= -1; timestep
<= max_timestep
; timestep
++)
560 if ((timestep
== -1 && max_timestep
> 0) || timestep
== 0)
563 info
.timestep
= timestep
;
564 info
.offset
= modelExpressions
.size();
565 modelInfo
.insert(info
);
567 std::vector
<int> vec
= satgen
.importSigSpec(chunksig
, timestep
);
568 modelExpressions
.insert(modelExpressions
.end(), vec
.begin(), vec
.end());
571 std::vector
<int> undef_vec
= satgen
.importUndefSigSpec(chunksig
, timestep
);
572 modelUndefExpressions
.insert(modelUndefExpressions
.end(), undef_vec
.begin(), undef_vec
.end());
577 // Add initial state signals as collected by satgen
579 modelSig
= satgen
.initial_state
.export_all();
580 for (auto &c
: modelSig
.chunks())
584 RTLIL::SigSpec chunksig
= c
;
587 info
.offset
= modelExpressions
.size();
588 info
.width
= chunksig
.size();
589 info
.description
= log_signal(chunksig
);
590 modelInfo
.insert(info
);
592 std::vector
<int> vec
= satgen
.importSigSpec(chunksig
, 1);
593 modelExpressions
.insert(modelExpressions
.end(), vec
.begin(), vec
.end());
596 std::vector
<int> undef_vec
= satgen
.importUndefSigSpec(chunksig
, 1);
597 modelUndefExpressions
.insert(modelUndefExpressions
.end(), undef_vec
.begin(), undef_vec
.end());
601 modelExpressions
.insert(modelExpressions
.end(), modelUndefExpressions
.begin(), modelUndefExpressions
.end());
606 int maxModelName
= 10;
607 int maxModelWidth
= 10;
609 for (auto &info
: modelInfo
) {
610 maxModelName
= max(maxModelName
, int(info
.description
.size()));
611 maxModelWidth
= max(maxModelWidth
, info
.width
);
616 int last_timestep
= -2;
617 for (auto &info
: modelInfo
)
620 bool found_undef
= false;
622 for (int i
= 0; i
< info
.width
; i
++) {
623 value
.bits
.push_back(modelValues
.at(info
.offset
+i
) ? RTLIL::State::S1
: RTLIL::State::S0
);
624 if (enable_undef
&& modelValues
.at(modelExpressions
.size()/2 + info
.offset
+ i
))
625 value
.bits
.back() = RTLIL::State::Sx
, found_undef
= true;
628 if (info
.timestep
!= last_timestep
) {
629 const char *hline
= "---------------------------------------------------------------------------------------------------"
630 "---------------------------------------------------------------------------------------------------"
631 "---------------------------------------------------------------------------------------------------";
632 if (last_timestep
== -2) {
633 log(max_timestep
> 0 ? " Time " : " ");
634 log("%-*s %11s %9s %*s\n", maxModelName
+5, "Signal Name", "Dec", "Hex", maxModelWidth
+3, "Bin");
636 log(max_timestep
> 0 ? " ---- " : " ");
637 log("%*.*s %11.11s %9.9s %*.*s\n", maxModelName
+5, maxModelName
+5,
638 hline
, hline
, hline
, maxModelWidth
+3, maxModelWidth
+3, hline
);
639 last_timestep
= info
.timestep
;
642 if (max_timestep
> 0) {
643 if (info
.timestep
> 0)
644 log(" %4d ", info
.timestep
);
650 if (info
.width
<= 32 && !found_undef
)
651 log("%-*s %11d %9x %*s\n", maxModelName
+5, info
.description
.c_str(), value
.as_int(), value
.as_int(), maxModelWidth
+3, value
.as_string().c_str());
653 log("%-*s %11s %9s %*s\n", maxModelName
+5, info
.description
.c_str(), "--", "--", maxModelWidth
+3, value
.as_string().c_str());
656 if (last_timestep
== -2)
657 log(" no model variables selected for display.\n");
660 void dump_model_to_vcd(std::string vcd_file_name
)
662 FILE *f
= fopen(vcd_file_name
.c_str(), "w");
664 log_cmd_error("Can't open output file `%s' for writing: %s\n", vcd_file_name
.c_str(), strerror(errno
));
666 log("Dumping SAT model to VCD file %s\n", vcd_file_name
.c_str());
670 char stime
[128] = {};
672 now
= localtime(×tamp
);
673 strftime(stime
, sizeof(stime
), "%c", now
);
675 std::string module_fname
= "unknown";
676 auto apos
= module
->attributes
.find("\\src");
677 if(apos
!= module
->attributes
.end())
678 module_fname
= module
->attributes
["\\src"].decode_string();
680 fprintf(f
, "$date\n");
681 fprintf(f
, " %s\n", stime
);
682 fprintf(f
, "$end\n");
683 fprintf(f
, "$version\n");
684 fprintf(f
, " Generated by %s\n", yosys_version_str
);
685 fprintf(f
, "$end\n");
686 fprintf(f
, "$comment\n");
687 fprintf(f
, " Generated from SAT problem in module %s (declared at %s)\n",
688 module
->name
.c_str(), module_fname
.c_str());
689 fprintf(f
, "$end\n");
691 // VCD has some limits on internal (non-display) identifier names, so make legal ones
692 std::map
<std::string
, std::string
> vcdnames
;
694 fprintf(f
, "$scope module %s $end\n", module
->name
.c_str());
695 for (auto &info
: modelInfo
)
697 if (vcdnames
.find(info
.description
) != vcdnames
.end())
701 snprintf(namebuf
, sizeof(namebuf
), "v%d", static_cast<int>(vcdnames
.size()));
702 vcdnames
[info
.description
] = namebuf
;
704 // Even display identifiers can't use some special characters
705 std::string legal_desc
= info
.description
.c_str();
706 for (auto &c
: legal_desc
) {
713 fprintf(f
, "$var wire %d %s %s $end\n", info
.width
, namebuf
, legal_desc
.c_str());
715 // Need to look at first *two* cycles!
716 // We need to put a name on all variables but those without an initialization clause
717 // have no value at timestep 0
718 if(info
.timestep
> 1)
721 fprintf(f
, "$upscope $end\n");
722 fprintf(f
, "$enddefinitions $end\n");
723 fprintf(f
, "$dumpvars\n");
725 static const char bitvals
[] = "01xzxx";
727 int last_timestep
= -2;
728 for (auto &info
: modelInfo
)
732 for (int i
= 0; i
< info
.width
; i
++) {
733 value
.bits
.push_back(modelValues
.at(info
.offset
+i
) ? RTLIL::State::S1
: RTLIL::State::S0
);
734 if (enable_undef
&& modelValues
.at(modelExpressions
.size()/2 + info
.offset
+ i
))
735 value
.bits
.back() = RTLIL::State::Sx
;
738 if (info
.timestep
!= last_timestep
) {
739 if(last_timestep
== 0)
740 fprintf(f
, "$end\n");
742 fprintf(f
, "#%d\n", info
.timestep
);
743 last_timestep
= info
.timestep
;
746 if(info
.width
== 1) {
747 fprintf(f
, "%c%s\n", bitvals
[value
.bits
[0]], vcdnames
[info
.description
].c_str());
750 for(int k
=info
.width
-1; k
>= 0; k
--) //need to flip bit ordering for VCD
751 fprintf(f
, "%c", bitvals
[value
.bits
[k
]]);
752 fprintf(f
, " %s\n", vcdnames
[info
.description
].c_str());
756 if (last_timestep
== -2)
757 log(" no model variables selected for display.\n");
762 void dump_model_to_json(std::string json_file_name
)
764 FILE *f
= fopen(json_file_name
.c_str(), "w");
766 log_cmd_error("Can't open output file `%s' for writing: %s\n", json_file_name
.c_str(), strerror(errno
));
768 log("Dumping SAT model to WaveJSON file '%s'.\n", json_file_name
.c_str());
770 int mintime
= 1, maxtime
= 0, maxwidth
= 0;;
771 dict
<string
, pair
<int, dict
<int, Const
>>> wavedata
;
773 for (auto &info
: modelInfo
)
776 for (int i
= 0; i
< info
.width
; i
++) {
777 value
.bits
.push_back(modelValues
.at(info
.offset
+i
) ? RTLIL::State::S1
: RTLIL::State::S0
);
778 if (enable_undef
&& modelValues
.at(modelExpressions
.size()/2 + info
.offset
+ i
))
779 value
.bits
.back() = RTLIL::State::Sx
;
782 wavedata
[info
.description
].first
= info
.width
;
783 wavedata
[info
.description
].second
[info
.timestep
] = value
;
784 mintime
= min(mintime
, info
.timestep
);
785 maxtime
= max(maxtime
, info
.timestep
);
786 maxwidth
= max(maxwidth
, info
.width
);
789 fprintf(f
, "{ \"signal\": [");
790 bool fist_wavedata
= true;
791 for (auto &wd
: wavedata
)
793 fprintf(f
, "%s", fist_wavedata
? "\n" : ",\n");
794 fist_wavedata
= false;
797 string name
= wd
.first
.c_str();
798 while (name
.substr(0, 1) == "\\")
799 name
= name
.substr(1);
801 fprintf(f
, " { \"name\": \"%s\", \"wave\": \"", name
.c_str());
802 for (int i
= mintime
; i
<= maxtime
; i
++) {
803 if (wd
.second
.second
.count(i
)) {
804 string this_data
= wd
.second
.second
[i
].as_string();
806 if (wd
.second
.first
== 1)
808 if (!data
.empty() && data
.back() == this_data
) {
811 data
.push_back(this_data
);
812 fprintf(f
, "%c", ch
);
819 if (wd
.second
.first
!= 1) {
820 fprintf(f
, "\", \"data\": [");
821 for (int i
= 0; i
< GetSize(data
); i
++)
822 fprintf(f
, "%s\"%s\"", i
? ", " : "", data
[i
].c_str());
828 fprintf(f
, "\n ],\n");
829 fprintf(f
, " \"config\": {\n");
830 fprintf(f
, " \"hscale\": %.2f\n", maxwidth
/ 4.0);
836 void invalidate_model(bool max_undef
)
838 std::vector
<int> clause
;
840 for (size_t i
= 0; i
< modelExpressions
.size()/2; i
++) {
841 int bit
= modelExpressions
.at(i
), bit_undef
= modelExpressions
.at(modelExpressions
.size()/2 + i
);
842 bool val
= modelValues
.at(i
), val_undef
= modelValues
.at(modelExpressions
.size()/2 + i
);
843 if (!max_undef
|| !val_undef
)
844 clause
.push_back(val_undef
? ez
->NOT(bit_undef
) : val
? ez
->NOT(bit
) : bit
);
847 for (size_t i
= 0; i
< modelExpressions
.size(); i
++)
848 clause
.push_back(modelValues
.at(i
) ? ez
->NOT(modelExpressions
.at(i
)) : modelExpressions
.at(i
));
849 ez
->assume(ez
->expression(ezSAT::OpOr
, clause
));
853 void print_proof_failed()
856 log(" ______ ___ ___ _ _ _ _ \n");
857 log(" (_____ \\ / __) / __) (_) | | | |\n");
858 log(" _____) )___ ___ ___ _| |__ _| |__ _____ _| | _____ __| | |\n");
859 log(" | ____/ ___) _ \\ / _ (_ __) (_ __|____ | | || ___ |/ _ |_|\n");
860 log(" | | | | | |_| | |_| || | | | / ___ | | || ____( (_| |_ \n");
861 log(" |_| |_| \\___/ \\___/ |_| |_| \\_____|_|\\_)_____)\\____|_|\n");
868 log(" _____ _ _ _____ ____ _ _____\n");
869 log(" /__ __\\/ \\/ \\__/|/ __// _ \\/ \\ /\\/__ __\\\n");
870 log(" / \\ | || |\\/||| \\ | / \\|| | || / \\\n");
871 log(" | | | || | ||| /_ | \\_/|| \\_/| | |\n");
872 log(" \\_/ \\_/\\_/ \\|\\____\\\\____/\\____/ \\_/\n");
879 log(" /$$$$$$ /$$$$$$$$ /$$$$$$$ \n");
880 log(" /$$__ $$ | $$_____/ | $$__ $$ \n");
881 log(" | $$ \\ $$ | $$ | $$ \\ $$ \n");
882 log(" | $$ | $$ | $$$$$ | $$ | $$ \n");
883 log(" | $$ | $$ | $$__/ | $$ | $$ \n");
884 log(" | $$/$$ $$ | $$ | $$ | $$ \n");
885 log(" | $$$$$$/ /$$| $$$$$$$$ /$$| $$$$$$$//$$\n");
886 log(" \\____ $$$|__/|________/|__/|_______/|__/\n");
891 struct SatPass
: public Pass
{
892 SatPass() : Pass("sat", "solve a SAT problem in the circuit") { }
893 void help() YS_OVERRIDE
895 // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
897 log(" sat [options] [selection]\n");
899 log("This command solves a SAT problem defined over the currently selected circuit\n");
900 log("and additional constraints passed as parameters.\n");
903 log(" show all solutions to the problem (this can grow exponentially, use\n");
904 log(" -max <N> instead to get <N> solutions)\n");
907 log(" like -all, but limit number of solutions to <N>\n");
909 log(" -enable_undef\n");
910 log(" enable modeling of undef value (aka 'x-bits')\n");
911 log(" this option is implied by -set-def, -set-undef et. cetera\n");
913 log(" -max_undef\n");
914 log(" maximize the number of undef bits in solutions, giving a better\n");
915 log(" picture of which input bits are actually vital to the solution.\n");
917 log(" -set <signal> <value>\n");
918 log(" set the specified signal to the specified value.\n");
920 log(" -set-def <signal>\n");
921 log(" add a constraint that all bits of the given signal must be defined\n");
923 log(" -set-any-undef <signal>\n");
924 log(" add a constraint that at least one bit of the given signal is undefined\n");
926 log(" -set-all-undef <signal>\n");
927 log(" add a constraint that all bits of the given signal are undefined\n");
929 log(" -set-def-inputs\n");
930 log(" add -set-def constraints for all module inputs\n");
932 log(" -show <signal>\n");
933 log(" show the model for the specified signal. if no -show option is\n");
934 log(" passed then a set of signals to be shown is automatically selected.\n");
936 log(" -show-inputs, -show-outputs, -show-ports\n");
937 log(" add all module (input/output) ports to the list of shown signals\n");
939 log(" -show-regs, -show-public, -show-all\n");
940 log(" show all registers, show signals with 'public' names, show all signals\n");
942 log(" -ignore_div_by_zero\n");
943 log(" ignore all solutions that involve a division by zero\n");
945 log(" -ignore_unknown_cells\n");
946 log(" ignore all cells that can not be matched to a SAT model\n");
948 log("The following options can be used to set up a sequential problem:\n");
951 log(" set up a sequential problem with <N> time steps. The steps will\n");
952 log(" be numbered from 1 to N.\n");
954 log(" note: for large <N> it can be significantly faster to use\n");
955 log(" -tempinduct-baseonly -maxsteps <N> instead of -seq <N>.\n");
957 log(" -set-at <N> <signal> <value>\n");
958 log(" -unset-at <N> <signal>\n");
959 log(" set or unset the specified signal to the specified value in the\n");
960 log(" given timestep. this has priority over a -set for the same signal.\n");
962 log(" -set-assumes\n");
963 log(" set all assumptions provided via $assume cells\n");
965 log(" -set-def-at <N> <signal>\n");
966 log(" -set-any-undef-at <N> <signal>\n");
967 log(" -set-all-undef-at <N> <signal>\n");
968 log(" add undef constraints in the given timestep.\n");
970 log(" -set-init <signal> <value>\n");
971 log(" set the initial value for the register driving the signal to the value\n");
973 log(" -set-init-undef\n");
974 log(" set all initial states (not set using -set-init) to undef\n");
976 log(" -set-init-def\n");
977 log(" do not force a value for the initial state but do not allow undef\n");
979 log(" -set-init-zero\n");
980 log(" set all initial states (not set using -set-init) to zero\n");
982 log(" -dump_vcd <vcd-file-name>\n");
983 log(" dump SAT model (counter example in proof) to VCD file\n");
985 log(" -dump_json <json-file-name>\n");
986 log(" dump SAT model (counter example in proof) to a WaveJSON file.\n");
988 log(" -dump_cnf <cnf-file-name>\n");
989 log(" dump CNF of SAT problem (in DIMACS format). in temporal induction\n");
990 log(" proofs this is the CNF of the first induction step.\n");
992 log("The following additional options can be used to set up a proof. If also -seq\n");
993 log("is passed, a temporal induction proof is performed.\n");
995 log(" -tempinduct\n");
996 log(" Perform a temporal induction proof. In a temporal induction proof it is\n");
997 log(" proven that the condition holds forever after the number of time steps\n");
998 log(" specified using -seq.\n");
1000 log(" -tempinduct-def\n");
1001 log(" Perform a temporal induction proof. Assume an initial state with all\n");
1002 log(" registers set to defined values for the induction step.\n");
1004 log(" -tempinduct-baseonly\n");
1005 log(" Run only the basecase half of temporal induction (requires -maxsteps)\n");
1007 log(" -tempinduct-inductonly\n");
1008 log(" Run only the induction half of temporal induction\n");
1010 log(" -tempinduct-skip <N>\n");
1011 log(" Skip the first <N> steps of the induction proof.\n");
1013 log(" note: this will assume that the base case holds for <N> steps.\n");
1014 log(" this must be proven independently with \"-tempinduct-baseonly\n");
1015 log(" -maxsteps <N>\". Use -initsteps if you just want to set a\n");
1016 log(" minimal induction length.\n");
1018 log(" -prove <signal> <value>\n");
1019 log(" Attempt to proof that <signal> is always <value>.\n");
1021 log(" -prove-x <signal> <value>\n");
1022 log(" Like -prove, but an undef (x) bit in the lhs matches any value on\n");
1023 log(" the right hand side. Useful for equivalence checking.\n");
1025 log(" -prove-asserts\n");
1026 log(" Prove that all asserts in the design hold.\n");
1028 log(" -prove-skip <N>\n");
1029 log(" Do not enforce the prove-condition for the first <N> time steps.\n");
1031 log(" -maxsteps <N>\n");
1032 log(" Set a maximum length for the induction.\n");
1034 log(" -initsteps <N>\n");
1035 log(" Set initial length for the induction.\n");
1036 log(" This will speed up the search of the right induction length\n");
1037 log(" for deep induction proofs.\n");
1039 log(" -stepsize <N>\n");
1040 log(" Increase the size of the induction proof in steps of <N>.\n");
1041 log(" This will speed up the search of the right induction length\n");
1042 log(" for deep induction proofs.\n");
1044 log(" -timeout <N>\n");
1045 log(" Maximum number of seconds a single SAT instance may take.\n");
1048 log(" Return an error and stop the synthesis script if the proof fails.\n");
1050 log(" -verify-no-timeout\n");
1051 log(" Like -verify but do not return an error for timeouts.\n");
1054 log(" Return an error and stop the synthesis script if the proof succeeds.\n");
1056 log(" -falsify-no-timeout\n");
1057 log(" Like -falsify but do not return an error for timeouts.\n");
1060 void execute(std::vector
<std::string
> args
, RTLIL::Design
*design
) YS_OVERRIDE
1062 std::vector
<std::pair
<std::string
, std::string
>> sets
, sets_init
, prove
, prove_x
;
1063 std::map
<int, std::vector
<std::pair
<std::string
, std::string
>>> sets_at
;
1064 std::map
<int, std::vector
<std::string
>> unsets_at
, sets_def_at
, sets_any_undef_at
, sets_all_undef_at
;
1065 std::vector
<std::string
> shows
, sets_def
, sets_any_undef
, sets_all_undef
;
1066 int loopcount
= 0, seq_len
= 0, maxsteps
= 0, initsteps
= 0, timeout
= 0, prove_skip
= 0;
1067 bool verify
= false, fail_on_timeout
= false, enable_undef
= false, set_def_inputs
= false;
1068 bool ignore_div_by_zero
= false, set_init_undef
= false, set_init_zero
= false, max_undef
= false;
1069 bool tempinduct
= false, prove_asserts
= false, show_inputs
= false, show_outputs
= false;
1070 bool show_regs
= false, show_public
= false, show_all
= false;
1071 bool ignore_unknown_cells
= false, falsify
= false, tempinduct_def
= false, set_init_def
= false;
1072 bool tempinduct_baseonly
= false, tempinduct_inductonly
= false, set_assumes
= false;
1073 int tempinduct_skip
= 0, stepsize
= 1;
1074 std::string vcd_file_name
, json_file_name
, cnf_file_name
;
1076 log_header(design
, "Executing SAT pass (solving SAT problems in the circuit).\n");
1079 for (argidx
= 1; argidx
< args
.size(); argidx
++) {
1080 if (args
[argidx
] == "-all") {
1084 if (args
[argidx
] == "-verify") {
1085 fail_on_timeout
= true;
1089 if (args
[argidx
] == "-verify-no-timeout") {
1093 if (args
[argidx
] == "-falsify") {
1094 fail_on_timeout
= true;
1098 if (args
[argidx
] == "-falsify-no-timeout") {
1102 if (args
[argidx
] == "-timeout" && argidx
+1 < args
.size()) {
1103 timeout
= atoi(args
[++argidx
].c_str());
1106 if (args
[argidx
] == "-max" && argidx
+1 < args
.size()) {
1107 loopcount
= atoi(args
[++argidx
].c_str());
1110 if (args
[argidx
] == "-maxsteps" && argidx
+1 < args
.size()) {
1111 maxsteps
= atoi(args
[++argidx
].c_str());
1114 if (args
[argidx
] == "-initsteps" && argidx
+1 < args
.size()) {
1115 initsteps
= atoi(args
[++argidx
].c_str());
1118 if (args
[argidx
] == "-stepsize" && argidx
+1 < args
.size()) {
1119 stepsize
= max(1, atoi(args
[++argidx
].c_str()));
1122 if (args
[argidx
] == "-ignore_div_by_zero") {
1123 ignore_div_by_zero
= true;
1126 if (args
[argidx
] == "-enable_undef") {
1127 enable_undef
= true;
1130 if (args
[argidx
] == "-max_undef") {
1131 enable_undef
= true;
1135 if (args
[argidx
] == "-set-def-inputs") {
1136 enable_undef
= true;
1137 set_def_inputs
= true;
1140 if (args
[argidx
] == "-set" && argidx
+2 < args
.size()) {
1141 std::string lhs
= args
[++argidx
];
1142 std::string rhs
= args
[++argidx
];
1143 sets
.push_back(std::pair
<std::string
, std::string
>(lhs
, rhs
));
1146 if (args
[argidx
] == "-set-def" && argidx
+1 < args
.size()) {
1147 sets_def
.push_back(args
[++argidx
]);
1148 enable_undef
= true;
1151 if (args
[argidx
] == "-set-any-undef" && argidx
+1 < args
.size()) {
1152 sets_any_undef
.push_back(args
[++argidx
]);
1153 enable_undef
= true;
1156 if (args
[argidx
] == "-set-all-undef" && argidx
+1 < args
.size()) {
1157 sets_all_undef
.push_back(args
[++argidx
]);
1158 enable_undef
= true;
1161 if (args
[argidx
] == "-set-assumes") {
1165 if (args
[argidx
] == "-tempinduct") {
1169 if (args
[argidx
] == "-tempinduct-def") {
1171 tempinduct_def
= true;
1172 enable_undef
= true;
1175 if (args
[argidx
] == "-tempinduct-baseonly") {
1177 tempinduct_baseonly
= true;
1180 if (args
[argidx
] == "-tempinduct-inductonly") {
1182 tempinduct_inductonly
= true;
1185 if (args
[argidx
] == "-tempinduct-skip" && argidx
+1 < args
.size()) {
1186 tempinduct_skip
= atoi(args
[++argidx
].c_str());
1189 if (args
[argidx
] == "-prove" && argidx
+2 < args
.size()) {
1190 std::string lhs
= args
[++argidx
];
1191 std::string rhs
= args
[++argidx
];
1192 prove
.push_back(std::pair
<std::string
, std::string
>(lhs
, rhs
));
1195 if (args
[argidx
] == "-prove-x" && argidx
+2 < args
.size()) {
1196 std::string lhs
= args
[++argidx
];
1197 std::string rhs
= args
[++argidx
];
1198 prove_x
.push_back(std::pair
<std::string
, std::string
>(lhs
, rhs
));
1199 enable_undef
= true;
1202 if (args
[argidx
] == "-prove-asserts") {
1203 prove_asserts
= true;
1206 if (args
[argidx
] == "-prove-skip" && argidx
+1 < args
.size()) {
1207 prove_skip
= atoi(args
[++argidx
].c_str());
1210 if (args
[argidx
] == "-seq" && argidx
+1 < args
.size()) {
1211 seq_len
= atoi(args
[++argidx
].c_str());
1214 if (args
[argidx
] == "-set-at" && argidx
+3 < args
.size()) {
1215 int timestep
= atoi(args
[++argidx
].c_str());
1216 std::string lhs
= args
[++argidx
];
1217 std::string rhs
= args
[++argidx
];
1218 sets_at
[timestep
].push_back(std::pair
<std::string
, std::string
>(lhs
, rhs
));
1221 if (args
[argidx
] == "-unset-at" && argidx
+2 < args
.size()) {
1222 int timestep
= atoi(args
[++argidx
].c_str());
1223 unsets_at
[timestep
].push_back(args
[++argidx
]);
1226 if (args
[argidx
] == "-set-def-at" && argidx
+2 < args
.size()) {
1227 int timestep
= atoi(args
[++argidx
].c_str());
1228 sets_def_at
[timestep
].push_back(args
[++argidx
]);
1229 enable_undef
= true;
1232 if (args
[argidx
] == "-set-any-undef-at" && argidx
+2 < args
.size()) {
1233 int timestep
= atoi(args
[++argidx
].c_str());
1234 sets_any_undef_at
[timestep
].push_back(args
[++argidx
]);
1235 enable_undef
= true;
1238 if (args
[argidx
] == "-set-all-undef-at" && argidx
+2 < args
.size()) {
1239 int timestep
= atoi(args
[++argidx
].c_str());
1240 sets_all_undef_at
[timestep
].push_back(args
[++argidx
]);
1241 enable_undef
= true;
1244 if (args
[argidx
] == "-set-init" && argidx
+2 < args
.size()) {
1245 std::string lhs
= args
[++argidx
];
1246 std::string rhs
= args
[++argidx
];
1247 sets_init
.push_back(std::pair
<std::string
, std::string
>(lhs
, rhs
));
1250 if (args
[argidx
] == "-set-init-undef") {
1251 set_init_undef
= true;
1252 enable_undef
= true;
1255 if (args
[argidx
] == "-set-init-def") {
1256 set_init_def
= true;
1259 if (args
[argidx
] == "-set-init-zero") {
1260 set_init_zero
= true;
1263 if (args
[argidx
] == "-show" && argidx
+1 < args
.size()) {
1264 shows
.push_back(args
[++argidx
]);
1267 if (args
[argidx
] == "-show-inputs") {
1271 if (args
[argidx
] == "-show-outputs") {
1272 show_outputs
= true;
1275 if (args
[argidx
] == "-show-ports") {
1277 show_outputs
= true;
1280 if (args
[argidx
] == "-show-regs") {
1284 if (args
[argidx
] == "-show-public") {
1288 if (args
[argidx
] == "-show-all") {
1292 if (args
[argidx
] == "-ignore_unknown_cells") {
1293 ignore_unknown_cells
= true;
1296 if (args
[argidx
] == "-dump_vcd" && argidx
+1 < args
.size()) {
1297 vcd_file_name
= args
[++argidx
];
1300 if (args
[argidx
] == "-dump_json" && argidx
+1 < args
.size()) {
1301 json_file_name
= args
[++argidx
];
1304 if (args
[argidx
] == "-dump_cnf" && argidx
+1 < args
.size()) {
1305 cnf_file_name
= args
[++argidx
];
1310 extra_args(args
, argidx
, design
);
1312 RTLIL::Module
*module
= NULL
;
1313 for (auto mod
: design
->selected_modules()) {
1315 log_cmd_error("Only one module must be selected for the SAT pass! (selected: %s and %s)\n", log_id(module
), log_id(mod
));
1319 log_cmd_error("Can't perform SAT on an empty selection!\n");
1321 if (!prove
.size() && !prove_x
.size() && !prove_asserts
&& tempinduct
)
1322 log_cmd_error("Got -tempinduct but nothing to prove!\n");
1324 if (prove_skip
&& tempinduct
)
1325 log_cmd_error("Options -prove-skip and -tempinduct don't work with each other. Use -seq instead of -prove-skip.\n");
1327 if (prove_skip
>= seq_len
&& prove_skip
> 0)
1328 log_cmd_error("The value of -prove-skip must be smaller than the one of -seq.\n");
1330 if (set_init_undef
+ set_init_zero
+ set_init_def
> 1)
1331 log_cmd_error("The options -set-init-undef, -set-init-def, and -set-init-zero are exclusive!\n");
1333 if (set_def_inputs
) {
1334 for (auto &it
: module
->wires_
)
1335 if (it
.second
->port_input
)
1336 sets_def
.push_back(it
.second
->name
.str());
1340 for (auto &it
: module
->wires_
)
1341 if (it
.second
->port_input
)
1342 shows
.push_back(it
.second
->name
.str());
1346 for (auto &it
: module
->wires_
)
1347 if (it
.second
->port_output
)
1348 shows
.push_back(it
.second
->name
.str());
1352 pool
<Wire
*> reg_wires
;
1353 for (auto cell
: module
->cells()) {
1354 if (cell
->type
== "$dff" || cell
->type
.substr(0, 6) == "$_DFF_")
1355 for (auto bit
: cell
->getPort("\\Q"))
1357 reg_wires
.insert(bit
.wire
);
1359 for (auto wire
: reg_wires
)
1360 shows
.push_back(wire
->name
.str());
1364 for (auto wire
: module
->wires())
1365 if (wire
->name
[0] == '\\')
1366 shows
.push_back(wire
->name
.str());
1370 for (auto wire
: module
->wires())
1371 shows
.push_back(wire
->name
.str());
1376 if (loopcount
> 0 || max_undef
)
1377 log_cmd_error("The options -max, -all, and -max_undef are not supported for temporal induction proofs!\n");
1379 SatHelper
basecase(design
, module
, enable_undef
);
1380 SatHelper
inductstep(design
, module
, enable_undef
);
1382 basecase
.sets
= sets
;
1383 basecase
.set_assumes
= set_assumes
;
1384 basecase
.prove
= prove
;
1385 basecase
.prove_x
= prove_x
;
1386 basecase
.prove_asserts
= prove_asserts
;
1387 basecase
.sets_at
= sets_at
;
1388 basecase
.unsets_at
= unsets_at
;
1389 basecase
.shows
= shows
;
1390 basecase
.timeout
= timeout
;
1391 basecase
.sets_def
= sets_def
;
1392 basecase
.sets_any_undef
= sets_any_undef
;
1393 basecase
.sets_all_undef
= sets_all_undef
;
1394 basecase
.sets_def_at
= sets_def_at
;
1395 basecase
.sets_any_undef_at
= sets_any_undef_at
;
1396 basecase
.sets_all_undef_at
= sets_all_undef_at
;
1397 basecase
.sets_init
= sets_init
;
1398 basecase
.set_init_def
= set_init_def
;
1399 basecase
.set_init_undef
= set_init_undef
;
1400 basecase
.set_init_zero
= set_init_zero
;
1401 basecase
.satgen
.ignore_div_by_zero
= ignore_div_by_zero
;
1402 basecase
.ignore_unknown_cells
= ignore_unknown_cells
;
1404 for (int timestep
= 1; timestep
<= seq_len
; timestep
++)
1405 if (!tempinduct_inductonly
)
1406 basecase
.setup(timestep
, timestep
== 1);
1408 inductstep
.sets
= sets
;
1409 inductstep
.set_assumes
= set_assumes
;
1410 inductstep
.prove
= prove
;
1411 inductstep
.prove_x
= prove_x
;
1412 inductstep
.prove_asserts
= prove_asserts
;
1413 inductstep
.shows
= shows
;
1414 inductstep
.timeout
= timeout
;
1415 inductstep
.sets_def
= sets_def
;
1416 inductstep
.sets_any_undef
= sets_any_undef
;
1417 inductstep
.sets_all_undef
= sets_all_undef
;
1418 inductstep
.satgen
.ignore_div_by_zero
= ignore_div_by_zero
;
1419 inductstep
.ignore_unknown_cells
= ignore_unknown_cells
;
1421 if (!tempinduct_baseonly
) {
1422 inductstep
.setup(1);
1423 inductstep
.ez
->assume(inductstep
.setup_proof(1));
1426 if (tempinduct_def
) {
1427 std::vector
<int> undef_state
= inductstep
.satgen
.importUndefSigSpec(inductstep
.satgen
.initial_state
.export_all(), 1);
1428 inductstep
.ez
->assume(inductstep
.ez
->NOT(inductstep
.ez
->expression(ezSAT::OpOr
, undef_state
)));
1431 for (int inductlen
= 1; inductlen
<= maxsteps
|| maxsteps
== 0; inductlen
++)
1433 log("\n** Trying induction with length %d **\n", inductlen
);
1435 // phase 1: proving base case
1437 if (!tempinduct_inductonly
)
1439 basecase
.setup(seq_len
+ inductlen
, seq_len
+ inductlen
== 1);
1440 int property
= basecase
.setup_proof(seq_len
+ inductlen
);
1441 basecase
.generate_model();
1444 basecase
.force_unique_state(seq_len
+ 1, seq_len
+ inductlen
);
1446 if (tempinduct_skip
< inductlen
)
1448 log("\n[base case %d] Solving problem with %d variables and %d clauses..\n",
1449 inductlen
, basecase
.ez
->numCnfVariables(), basecase
.ez
->numCnfClauses());
1452 if (basecase
.solve(basecase
.ez
->NOT(property
))) {
1453 log("SAT temporal induction proof finished - model found for base case: FAIL!\n");
1454 print_proof_failed();
1455 basecase
.print_model();
1456 if(!vcd_file_name
.empty())
1457 basecase
.dump_model_to_vcd(vcd_file_name
);
1458 if(!json_file_name
.empty())
1459 basecase
.dump_model_to_json(json_file_name
);
1463 if (basecase
.gotTimeout
)
1466 log("Base case for induction length %d proven.\n", inductlen
);
1470 log("\n[base case %d] Skipping prove for this step (-tempinduct-skip %d).",
1471 inductlen
, tempinduct_skip
);
1472 log("\n[base case %d] Problem size so far: %d variables and %d clauses.\n",
1473 inductlen
, basecase
.ez
->numCnfVariables(), basecase
.ez
->numCnfClauses());
1475 basecase
.ez
->assume(property
);
1478 // phase 2: proving induction step
1480 if (!tempinduct_baseonly
)
1482 inductstep
.setup(inductlen
+ 1);
1483 int property
= inductstep
.setup_proof(inductlen
+ 1);
1484 inductstep
.generate_model();
1487 inductstep
.force_unique_state(1, inductlen
+ 1);
1489 if (inductlen
<= tempinduct_skip
|| inductlen
<= initsteps
|| inductlen
% stepsize
!= 0)
1491 if (inductlen
< tempinduct_skip
)
1492 log("\n[induction step %d] Skipping prove for this step (-tempinduct-skip %d).",
1493 inductlen
, tempinduct_skip
);
1494 if (inductlen
< initsteps
)
1495 log("\n[induction step %d] Skipping prove for this step (-initsteps %d).",
1496 inductlen
, tempinduct_skip
);
1497 if (inductlen
% stepsize
!= 0)
1498 log("\n[induction step %d] Skipping prove for this step (-stepsize %d).",
1499 inductlen
, stepsize
);
1500 log("\n[induction step %d] Problem size so far: %d variables and %d clauses.\n",
1501 inductlen
, inductstep
.ez
->numCnfVariables(), inductstep
.ez
->numCnfClauses());
1502 inductstep
.ez
->assume(property
);
1506 if (!cnf_file_name
.empty())
1508 FILE *f
= fopen(cnf_file_name
.c_str(), "w");
1510 log_cmd_error("Can't open output file `%s' for writing: %s\n", cnf_file_name
.c_str(), strerror(errno
));
1512 log("Dumping CNF to file `%s'.\n", cnf_file_name
.c_str());
1513 cnf_file_name
.clear();
1515 inductstep
.ez
->printDIMACS(f
, false);
1519 log("\n[induction step %d] Solving problem with %d variables and %d clauses..\n",
1520 inductlen
, inductstep
.ez
->numCnfVariables(), inductstep
.ez
->numCnfClauses());
1523 if (!inductstep
.solve(inductstep
.ez
->NOT(property
))) {
1524 if (inductstep
.gotTimeout
)
1526 log("Induction step proven: SUCCESS!\n");
1531 log("Induction step failed. Incrementing induction length.\n");
1532 inductstep
.ez
->assume(property
);
1533 inductstep
.print_model();
1538 if (tempinduct_baseonly
) {
1539 log("\nReached maximum number of time steps -> proved base case for %d steps: SUCCESS!\n", maxsteps
);
1543 log("\nReached maximum number of time steps -> proof failed.\n");
1544 if(!vcd_file_name
.empty())
1545 inductstep
.dump_model_to_vcd(vcd_file_name
);
1546 if(!json_file_name
.empty())
1547 inductstep
.dump_model_to_json(json_file_name
);
1548 print_proof_failed();
1553 log_error("Called with -verify and proof did fail!\n");
1560 log_error("Called with -falsify and proof did succeed!\n");
1566 log_cmd_error("The options -maxsteps is only supported for temporal induction proofs!\n");
1568 SatHelper
sathelper(design
, module
, enable_undef
);
1570 sathelper
.sets
= sets
;
1571 sathelper
.set_assumes
= set_assumes
;
1572 sathelper
.prove
= prove
;
1573 sathelper
.prove_x
= prove_x
;
1574 sathelper
.prove_asserts
= prove_asserts
;
1575 sathelper
.sets_at
= sets_at
;
1576 sathelper
.unsets_at
= unsets_at
;
1577 sathelper
.shows
= shows
;
1578 sathelper
.timeout
= timeout
;
1579 sathelper
.sets_def
= sets_def
;
1580 sathelper
.sets_any_undef
= sets_any_undef
;
1581 sathelper
.sets_all_undef
= sets_all_undef
;
1582 sathelper
.sets_def_at
= sets_def_at
;
1583 sathelper
.sets_any_undef_at
= sets_any_undef_at
;
1584 sathelper
.sets_all_undef_at
= sets_all_undef_at
;
1585 sathelper
.sets_init
= sets_init
;
1586 sathelper
.set_init_def
= set_init_def
;
1587 sathelper
.set_init_undef
= set_init_undef
;
1588 sathelper
.set_init_zero
= set_init_zero
;
1589 sathelper
.satgen
.ignore_div_by_zero
= ignore_div_by_zero
;
1590 sathelper
.ignore_unknown_cells
= ignore_unknown_cells
;
1594 if (sathelper
.prove
.size() || sathelper
.prove_x
.size() || sathelper
.prove_asserts
)
1595 sathelper
.ez
->assume(sathelper
.ez
->NOT(sathelper
.setup_proof()));
1597 std::vector
<int> prove_bits
;
1598 for (int timestep
= 1; timestep
<= seq_len
; timestep
++) {
1599 sathelper
.setup(timestep
, timestep
== 1);
1600 if (sathelper
.prove
.size() || sathelper
.prove_x
.size() || sathelper
.prove_asserts
)
1601 if (timestep
> prove_skip
)
1602 prove_bits
.push_back(sathelper
.setup_proof(timestep
));
1604 if (sathelper
.prove
.size() || sathelper
.prove_x
.size() || sathelper
.prove_asserts
)
1605 sathelper
.ez
->assume(sathelper
.ez
->NOT(sathelper
.ez
->expression(ezSAT::OpAnd
, prove_bits
)));
1607 sathelper
.generate_model();
1609 if (!cnf_file_name
.empty())
1611 FILE *f
= fopen(cnf_file_name
.c_str(), "w");
1613 log_cmd_error("Can't open output file `%s' for writing: %s\n", cnf_file_name
.c_str(), strerror(errno
));
1615 log("Dumping CNF to file `%s'.\n", cnf_file_name
.c_str());
1616 cnf_file_name
.clear();
1618 sathelper
.ez
->printDIMACS(f
, false);
1622 int rerun_counter
= 0;
1625 log("\nSolving problem with %d variables and %d clauses..\n",
1626 sathelper
.ez
->numCnfVariables(), sathelper
.ez
->numCnfClauses());
1629 if (sathelper
.solve())
1632 log("SAT model found. maximizing number of undefs.\n");
1633 sathelper
.maximize_undefs();
1636 if (!prove
.size() && !prove_x
.size() && !prove_asserts
) {
1637 log("SAT solving finished - model found:\n");
1639 log("SAT proof finished - model found: FAIL!\n");
1640 print_proof_failed();
1643 sathelper
.print_model();
1645 if(!vcd_file_name
.empty())
1646 sathelper
.dump_model_to_vcd(vcd_file_name
);
1647 if(!json_file_name
.empty())
1648 sathelper
.dump_model_to_json(json_file_name
);
1650 if (loopcount
!= 0) {
1651 loopcount
--, rerun_counter
++;
1652 sathelper
.invalidate_model(max_undef
);
1656 if (!prove
.size() && !prove_x
.size() && !prove_asserts
) {
1659 log_error("Called with -falsify and found a model!\n");
1664 log_error("Called with -verify and proof did fail!\n");
1670 if (sathelper
.gotTimeout
)
1673 log("SAT solving finished - no more models found (after %d distinct solutions).\n", rerun_counter
);
1674 else if (!prove
.size() && !prove_x
.size() && !prove_asserts
) {
1675 log("SAT solving finished - no model found.\n");
1678 log_error("Called with -verify and found no model!\n");
1681 log("SAT proof finished - no model found: SUCCESS!\n");
1685 log_error("Called with -falsify and proof did succeed!\n");
1690 if (!prove
.size() && !prove_x
.size() && !prove_asserts
) {
1691 if (falsify
&& rerun_counter
) {
1693 log_error("Called with -falsify and found a model!\n");
1696 if (verify
&& rerun_counter
) {
1698 log_error("Called with -verify and proof did fail!\n");
1705 log("Interrupted SAT solver: TIMEOUT!\n");
1707 if (fail_on_timeout
)
1708 log_error("Called with -verify and proof did time out!\n");
1713 PRIVATE_NAMESPACE_END