yosys/backends/smt2/smtbmc.py

1959 lines
68 KiB
Python
Raw Normal View History

2015-10-13 10:17:23 -05:00
#!/usr/bin/env python3
2015-10-13 18:31:54 -05:00
#
# yosys -- Yosys Open SYnthesis Suite
#
# Copyright (C) 2012 Claire Xenia Wolf <claire@yosyshq.com>
2015-10-13 18:31:54 -05:00
#
# 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.
#
2015-10-13 10:17:23 -05:00
import os, sys, getopt, re, bisect
2015-10-13 18:31:54 -05:00
##yosys-sys-path##
from smtio import SmtIo, SmtOpts, MkVcd
from ywio import ReadWitness, WriteWitness, WitnessValues
2016-08-24 16:18:29 -05:00
from collections import defaultdict
2015-10-13 10:17:23 -05:00
2016-12-01 05:57:26 -06:00
got_topt = False
2015-10-13 18:27:55 -05:00
skip_steps = 0
2015-12-20 02:58:54 -06:00
step_size = 1
2015-10-13 18:27:55 -05:00
num_steps = 20
2016-11-22 14:21:13 -06:00
append_steps = 0
2015-10-13 10:17:23 -05:00
vcdfile = None
inywfile = None
outywfile = None
2016-10-17 07:57:28 -05:00
cexfile = None
aimfile = None
aiwfile = None
aigheader = True
btorwitfile = None
2016-08-20 09:32:50 -05:00
vlogtbfile = None
2017-07-01 11:19:23 -05:00
vlogtbtop = None
2016-08-22 10:27:43 -05:00
inconstr = list()
2016-08-22 09:48:46 -05:00
outconstr = None
2016-08-20 09:32:50 -05:00
gentrace = False
covermode = False
2015-10-13 10:17:23 -05:00
tempind = False
2016-08-29 15:41:45 -05:00
dumpall = False
2015-10-13 18:27:55 -05:00
assume_skipped = None
final_only = False
2015-10-15 08:08:41 -05:00
topmod = None
noinfo = False
2017-07-06 19:47:30 -05:00
presat = False
smtcinit = False
smtctop = None
noinit = False
binarymode = False
keep_going = False
check_witness = False
detect_loops = False
so = SmtOpts()
2015-10-13 10:17:23 -05:00
2015-10-13 17:18:38 -05:00
def help():
2020-04-10 03:38:40 -05:00
print(os.path.basename(sys.argv[0]) + """ [options] <yosys_smt2_output>
2015-10-13 10:17:23 -05:00
-h, --help
show this message
-t <num_steps>
-t <skip_steps>:<num_steps>
-t <skip_steps>:<step_size>:<num_steps>
default: skip_steps=0, step_size=1, num_steps=20
2015-10-13 10:17:23 -05:00
2016-08-20 09:32:50 -05:00
-g
generate an arbitrary trace that satisfies
all assertions and assumptions.
2015-10-13 18:27:55 -05:00
-i
2015-10-13 10:17:23 -05:00
instead of BMC run temporal induction
-c
instead of regular BMC run cover analysis
2015-10-13 10:17:23 -05:00
-m <module_name>
2015-10-15 08:08:41 -05:00
name of the top module
2016-08-20 09:07:59 -05:00
2016-08-24 15:09:50 -05:00
--smtc <constr_filename>
2016-08-22 10:27:43 -05:00
read constraints file
2016-10-17 07:57:28 -05:00
--cex <cex_filename>
read cex file as written by ABC's "write_cex -n"
2016-12-01 05:57:26 -06:00
--aig <prefix>
read AIGER map file (as written by Yosys' "write_aiger -map")
and AIGER witness file. The file names are <prefix>.aim for
the map file and <prefix>.aiw for the witness file.
--aig <aim_filename>:<aiw_filename>
like above, but for map files and witness files that do not
share a filename prefix (or use different file extensions).
--aig-noheader
the AIGER witness file does not include the status and
properties lines.
--yw <yosys_witness_filename>
read a Yosys witness.
--btorwit <btor_witness_filename>
read a BTOR witness.
--noinfo
only run the core proof, do not collect and print any
additional information (e.g. which assert failed)
2017-07-06 19:47:30 -05:00
--presat
check if the design with assumptions but without assertions
is SAT before checking if assertions are UNSAT. This will
detect if there are contradicting assumptions. In some cases
this will also help to "warm up" the solver, potentially
2017-07-06 19:47:30 -05:00
yielding a speedup.
--final-only
only check final constraints, assume base case
--assume-skipped <start_step>
assume asserts in skipped steps in BMC.
no assumptions are created for skipped steps
before <start_step>.
2016-08-20 09:07:59 -05:00
--dump-vcd <vcd_filename>
2016-08-20 09:32:50 -05:00
write trace to this VCD file
2016-08-20 09:07:59 -05:00
(hint: use 'write_smt2 -wires' for maximum
coverage of signals in generated VCD file)
2016-08-20 11:43:39 -05:00
--dump-yw <yw_filename>
write trace as a Yosys witness trace
2016-08-20 11:43:39 -05:00
--dump-vlogtb <verilog_filename>
write trace as Verilog test bench
2016-08-22 09:48:46 -05:00
2017-07-01 11:19:23 -05:00
--vlogtb-top <hierarchical_name>
use the given entity as top module for the generated
Verilog test bench. The <hierarchical_name> is relative
to the design top module without the top module name.
2016-08-24 15:09:50 -05:00
--dump-smtc <constr_filename>
2016-08-22 09:48:46 -05:00
write trace as constraints file
2016-08-29 15:41:45 -05:00
--smtc-init
write just the last state as initial constraint to smtc file
--smtc-top <old>[:<new>]
replace <old> with <new> in constraints dumped to smtc
file and only dump object below <old> in design hierarchy.
--noinit
do not assume initial conditions in state 0
2016-08-29 15:41:45 -05:00
--dump-all
when using -g or -i, create a dump file for each
step. The character '%' is replaced in all dump
2016-08-29 15:41:45 -05:00
filenames with the step number.
2016-11-22 14:21:13 -06:00
--append <num_steps>
add <num_steps> time steps at the end of the trace
when creating a counter example (this additional time
steps will still be constrained by assumptions)
--binary
dump anyconst values as raw bit strings
--keep-going
continue BMC after the first failed assertion and report
further failed assertions. To output multiple traces
covering all found failed assertions, the character '%' is
replaced in all dump filenames with an increasing number.
In cover mode, don't stop when a cover trace contains a failed
assertion.
--check-witness
check that the used witness file contains sufficient
constraints to force an assertion failure.
--detect-loops
check if states are unique in temporal induction counter examples
(this feature is experimental and incomplete)
2015-10-13 10:17:23 -05:00
""" + so.helpmsg())
def usage():
help()
2015-10-13 10:17:23 -05:00
sys.exit(1)
2015-10-13 17:18:38 -05:00
2015-10-13 10:17:23 -05:00
try:
opts, args = getopt.getopt(sys.argv[1:], so.shortopts + "t:higcm:", so.longopts +
["help", "final-only", "assume-skipped=", "smtc=", "cex=", "aig=", "aig-noheader", "yw=", "btorwit=", "presat",
"dump-vcd=", "dump-yw=", "dump-vlogtb=", "vlogtb-top=", "dump-smtc=", "dump-all", "noinfo", "append=",
"smtc-init", "smtc-top=", "noinit", "binary", "keep-going", "check-witness", "detect-loops"])
2015-10-13 10:17:23 -05:00
except:
usage()
for o, a in opts:
if o in ("-h", "--help"):
help()
sys.exit(0)
elif o == "-t":
2016-12-01 05:57:26 -06:00
got_topt = True
a = a.split(":")
if len(a) == 1:
num_steps = int(a[0])
elif len(a) == 2:
skip_steps = int(a[0])
num_steps = int(a[1])
elif len(a) == 3:
skip_steps = int(a[0])
step_size = int(a[1])
num_steps = int(a[2])
2015-10-13 18:27:55 -05:00
else:
2016-12-01 05:57:26 -06:00
assert False
elif o == "--assume-skipped":
2015-10-13 18:27:55 -05:00
assume_skipped = int(a)
elif o == "--final-only":
final_only = True
2016-08-24 15:09:50 -05:00
elif o == "--smtc":
2016-08-22 10:27:43 -05:00
inconstr.append(a)
2016-10-17 07:57:28 -05:00
elif o == "--cex":
cexfile = a
2016-12-01 05:57:26 -06:00
elif o == "--aig":
if ":" in a:
aimfile, aiwfile = a.split(":")
else:
aimfile = a + ".aim"
aiwfile = a + ".aiw"
elif o == "--aig-noheader":
aigheader = False
elif o == "--yw":
inywfile = a
elif o == "--btorwit":
btorwitfile = a
2016-08-20 09:07:59 -05:00
elif o == "--dump-vcd":
2015-10-13 10:17:23 -05:00
vcdfile = a
elif o == "--dump-yw":
outywfile = a
2016-08-20 11:43:39 -05:00
elif o == "--dump-vlogtb":
vlogtbfile = a
2017-07-01 11:19:23 -05:00
elif o == "--vlogtb-top":
vlogtbtop = a
2016-08-24 15:09:50 -05:00
elif o == "--dump-smtc":
2016-08-22 09:48:46 -05:00
outconstr = a
elif o == "--smtc-init":
smtcinit = True
elif o == "--smtc-top":
smtctop = a.split(":")
if len(smtctop) == 1:
smtctop.append("")
assert len(smtctop) == 2
smtctop = tuple(smtctop)
2016-08-29 15:41:45 -05:00
elif o == "--dump-all":
dumpall = True
2017-07-06 19:47:30 -05:00
elif o == "--presat":
presat = True
elif o == "--noinfo":
noinfo = True
elif o == "--noinit":
noinit = True
2016-11-22 14:21:13 -06:00
elif o == "--append":
append_steps = int(a)
2015-10-13 10:17:23 -05:00
elif o == "-i":
tempind = True
2016-08-20 09:32:50 -05:00
elif o == "-g":
gentrace = True
elif o == "-c":
covermode = True
2015-10-13 17:37:41 -05:00
elif o == "-m":
topmod = a
elif o == "--binary":
binarymode = True
elif o == "--keep-going":
keep_going = True
elif o == "--check-witness":
check_witness = True
elif o == "--detect-loops":
detect_loops = True
2015-10-13 10:17:23 -05:00
elif so.handle(o, a):
pass
else:
usage()
if len(args) != 1:
usage()
if sum([tempind, gentrace, covermode]) > 1:
usage()
2015-10-13 17:18:38 -05:00
2016-08-27 07:30:36 -05:00
constr_final_start = None
2016-08-24 16:18:29 -05:00
constr_asserts = defaultdict(list)
constr_assumes = defaultdict(list)
2016-09-24 13:40:22 -05:00
constr_write = list()
2016-08-22 10:27:43 -05:00
for fn in inconstr:
2016-08-24 16:18:29 -05:00
current_states = None
current_line = 0
2016-08-22 10:27:43 -05:00
with open(fn, "r") as f:
for line in f:
current_line += 1
2016-08-24 16:18:29 -05:00
if line.startswith("#"):
continue
2016-08-22 10:27:43 -05:00
tokens = line.split()
if len(tokens) == 0:
continue
if tokens[0] == "initial":
2016-08-24 16:18:29 -05:00
current_states = set()
if not tempind:
current_states.add(0)
2016-08-22 10:27:43 -05:00
continue
2016-08-27 07:30:36 -05:00
if tokens[0] == "final":
constr_final = True
if len(tokens) == 1:
current_states = set(["final-%d" % i for i in range(0, num_steps+1)])
constr_final_start = 0
elif len(tokens) == 2:
arg = abs(int(tokens[1]))
current_states = set(["final-%d" % i for i in range(arg, num_steps+1)])
constr_final_start = arg if constr_final_start is None else min(constr_final_start, arg)
2016-08-27 07:30:36 -05:00
else:
2016-12-01 05:57:26 -06:00
assert False
2016-08-27 07:30:36 -05:00
continue
2016-08-22 10:27:43 -05:00
if tokens[0] == "state":
2016-08-24 16:18:29 -05:00
current_states = set()
if not tempind:
for token in tokens[1:]:
tok = token.split(":")
if len(tok) == 1:
current_states.add(int(token))
elif len(tok) == 2:
lower = int(tok[0])
if tok[1] == "*":
upper = num_steps
else:
upper = int(tok[1])
for i in range(lower, upper+1):
current_states.add(i)
2016-08-24 16:18:29 -05:00
else:
2016-12-01 05:57:26 -06:00
assert False
2016-08-24 16:18:29 -05:00
continue
if tokens[0] == "always":
if len(tokens) == 1:
current_states = set(range(0, num_steps+1))
elif len(tokens) == 2:
arg = abs(int(tokens[1]))
current_states = set(range(arg, num_steps+1))
2016-08-24 16:18:29 -05:00
else:
2016-12-01 05:57:26 -06:00
assert False
2016-08-22 10:27:43 -05:00
continue
if tokens[0] == "assert":
2016-08-24 16:18:29 -05:00
assert current_states is not None
2016-08-22 10:27:43 -05:00
2016-08-24 16:18:29 -05:00
for state in current_states:
constr_asserts[state].append(("%s:%d" % (fn, current_line), " ".join(tokens[1:])))
2016-08-22 10:27:43 -05:00
continue
if tokens[0] == "assume":
2016-08-24 16:18:29 -05:00
assert current_states is not None
2016-08-22 10:27:43 -05:00
2016-08-24 16:18:29 -05:00
for state in current_states:
constr_assumes[state].append(("%s:%d" % (fn, current_line), " ".join(tokens[1:])))
2016-08-22 10:27:43 -05:00
continue
2016-09-24 13:40:22 -05:00
if tokens[0] == "write":
constr_write.append(" ".join(tokens[1:]))
continue
if tokens[0] == "logic":
so.logic = " ".join(tokens[1:])
continue
2016-12-01 05:57:26 -06:00
assert False
2016-08-22 10:27:43 -05:00
def get_constr_expr(db, state, final=False, getvalues=False, individual=False):
2016-08-27 07:30:36 -05:00
if final:
if ("final-%d" % state) not in db:
return ([], [], []) if getvalues or individual else "true"
2016-08-27 07:30:36 -05:00
else:
if state not in db:
return ([], [], []) if getvalues or individual else "true"
2016-08-22 10:27:43 -05:00
netref_regex = re.compile(r'(^|[( ])\[(-?[0-9]+:|)([^\]]*|\S*)\](?=[ )]|$)')
2016-08-24 16:18:29 -05:00
def replace_netref(match):
state_sel = match.group(2)
if state_sel == "":
st = state
elif state_sel[0] == "-":
st = state + int(state_sel[:-1])
else:
st = int(state_sel[:-1])
expr = smt.net_expr(topmod, "s%d" % st, smt.get_path(topmod, match.group(3)))
return match.group(1) + expr
2016-08-22 10:27:43 -05:00
expr_list = list()
for loc, expr in db[("final-%d" % state) if final else state]:
actual_expr = netref_regex.sub(replace_netref, expr)
if getvalues or individual:
expr_list.append((loc, expr, actual_expr))
else:
expr_list.append(actual_expr)
if getvalues or individual:
loc_list, expr_list, actual_expr_list = zip(*expr_list)
if individual:
return loc_list, expr_list, actual_expr_list
else:
value_list = smt.get_list(actual_expr_list)
return loc_list, expr_list, value_list
2016-08-22 10:27:43 -05:00
2016-08-22 10:45:01 -05:00
if len(expr_list) == 0:
return "true"
if len(expr_list) == 1:
return expr_list[0]
2016-08-22 10:27:43 -05:00
return "(and %s)" % " ".join(expr_list)
smt = SmtIo(opts=so)
2015-10-13 10:17:23 -05:00
2016-09-24 13:40:22 -05:00
if noinfo and vcdfile is None and vlogtbfile is None and outconstr is None:
smt.produce_models = False
def print_msg(msg):
print("%s %s" % (smt.timestamp(), msg))
sys.stdout.flush()
print_msg("Solver: %s" % (so.solver))
2015-10-13 10:17:23 -05:00
with open(args[0], "r") as f:
for line in f:
smt.write(line)
2016-09-24 13:40:22 -05:00
for line in constr_write:
smt.write(line)
if topmod is None:
topmod = smt.topmod
2015-10-15 08:08:41 -05:00
assert topmod is not None
assert topmod in smt.modinfo
2015-10-13 17:18:38 -05:00
2016-10-17 07:57:28 -05:00
if cexfile is not None:
if not got_topt:
skip_steps = 0
num_steps = 0
2016-10-17 07:57:28 -05:00
with open(cexfile, "r") as f:
cex_regex = re.compile(r'([^\[@=]+)(\[\d+\])?([^@=]*)(@\d+)=([01])')
2016-10-17 07:57:28 -05:00
for entry in f.read().split():
match = cex_regex.match(entry)
assert match
name, bit, extra_name, step, val = match.group(1), match.group(2), match.group(3), match.group(4), match.group(5)
if extra_name != "":
continue
2016-10-17 07:57:28 -05:00
if name not in smt.modinfo[topmod].inputs:
continue
if bit is None:
bit = 0
else:
bit = int(bit[1:-1])
step = int(step[1:])
val = int(val)
if smt.modinfo[topmod].wsize[name] == 1:
assert bit == 0
smtexpr = "(= [%s] %s)" % (name, "true" if val else "false")
else:
smtexpr = "(= ((_ extract %d %d) [%s]) #b%d)" % (bit, bit, name, val)
# print("cex@%d: %s" % (step, smtexpr))
constr_assumes[step].append((cexfile, smtexpr))
if not got_topt:
if not check_witness:
skip_steps = max(skip_steps, step)
num_steps = max(num_steps, step+1)
if aimfile is not None:
2016-12-01 05:57:26 -06:00
input_map = dict()
init_map = dict()
latch_map = dict()
if not got_topt:
skip_steps = 0
num_steps = 0
with open(aimfile, "r") as f:
2016-12-01 05:57:26 -06:00
for entry in f.read().splitlines():
entry = entry.split()
if entry[0] == "input":
input_map[int(entry[1])] = (entry[3], int(entry[2]))
continue
if entry[0] == "init":
init_map[int(entry[1])] = (entry[3], int(entry[2]))
continue
if entry[0] in ["latch", "invlatch"]:
latch_map[int(entry[1])] = (entry[3], int(entry[2]), entry[0] == "invlatch")
continue
if entry[0] in ["output", "wire"]:
continue
assert False
with open(aiwfile, "r") as f:
2016-12-01 05:57:26 -06:00
got_state = False
got_ffinit = False
step = 0
if not aigheader:
got_state = True
2016-12-01 05:57:26 -06:00
for entry in f.read().splitlines():
2022-03-24 04:19:17 -05:00
if len(entry) == 0 or entry[0] in "bcjfu.#":
2016-12-01 05:57:26 -06:00
continue
if not got_state:
got_state = True
assert entry == "1"
continue
if not got_ffinit:
got_ffinit = True
if len(init_map) == 0:
for i in range(len(entry)):
if entry[i] == "x":
continue
if i in latch_map:
value = int(entry[i])
name = latch_map[i][0]
bitidx = latch_map[i][1]
invert = latch_map[i][2]
if invert:
value = 1 - value
path = smt.get_path(topmod, name)
width = smt.net_width(topmod, path)
if width == 1:
assert bitidx == 0
smtexpr = "(= [%s] %s)" % (name, "true" if value else "false")
else:
smtexpr = "(= ((_ extract %d %d) [%s]) #b%d)" % (bitidx, bitidx, name, value)
constr_assumes[0].append((cexfile, smtexpr))
continue
for i in range(len(entry)):
if entry[i] == "x":
continue
if (step == 0) and (i in init_map):
value = int(entry[i])
name = init_map[i][0]
bitidx = init_map[i][1]
path = smt.get_path(topmod, name)
if not smt.net_exists(topmod, path):
match = re.match(r"(.*)\[(\d+)\]$", path[-1])
if match:
path[-1] = match.group(1)
addr = int(match.group(2))
if not match or not smt.mem_exists(topmod, path):
print_msg("Ignoring init value for unknown net: %s" % (name))
continue
meminfo = smt.mem_info(topmod, path)
smtexpr = "(select [%s] #b%s)" % (".".join(path), bin(addr)[2:].zfill(meminfo[0]))
width = meminfo[1]
else:
smtexpr = "[%s]" % name
width = smt.net_width(topmod, path)
2016-12-01 05:57:26 -06:00
if width == 1:
assert bitidx == 0
smtexpr = "(= %s %s)" % (smtexpr, "true" if value else "false")
2016-12-01 05:57:26 -06:00
else:
smtexpr = "(= ((_ extract %d %d) %s) #b%d)" % (bitidx, bitidx, smtexpr, value)
2016-12-01 05:57:26 -06:00
constr_assumes[0].append((cexfile, smtexpr))
if i in input_map:
value = int(entry[i])
name = input_map[i][0]
bitidx = input_map[i][1]
path = smt.get_path(topmod, name)
width = smt.net_width(topmod, path)
if width == 1:
assert bitidx == 0
smtexpr = "(= [%s] %s)" % (name, "true" if value else "false")
else:
smtexpr = "(= ((_ extract %d %d) [%s]) #b%d)" % (bitidx, bitidx, name, value)
constr_assumes[step].append((cexfile, smtexpr))
if not got_topt:
if not check_witness:
skip_steps = max(skip_steps, step)
# some solvers optimize the properties so that they fail one cycle early,
# thus we check the properties in the cycle the aiger witness ends, and
# if that doesn't work, we check the cycle after that as well.
num_steps = max(num_steps, step+2)
2016-12-01 05:57:26 -06:00
step += 1
if inywfile is not None:
if not got_topt:
skip_steps = 0
num_steps = 0
with open(inywfile, "r") as f:
inyw = ReadWitness(f)
inits, seqs, clocks, mems = smt.hierwitness(topmod, allregs=True, blackbox=True)
smt_wires = defaultdict(list)
smt_mems = defaultdict(list)
for wire in inits + seqs:
smt_wires[wire["path"]].append(wire)
for mem in mems:
smt_mems[mem["path"]].append(mem)
addr_re = re.compile(r'\\\[[0-9]+\]$')
bits_re = re.compile(r'[01?]*$')
for t, step in inyw.steps():
present_signals, missing = step.present_signals(inyw.sigmap)
for sig in present_signals:
bits = step[sig]
if not bits_re.match(bits):
raise ValueError("unsupported bit value in Yosys witness file")
sig_end = sig.offset + len(bits)
if sig.path in smt_wires:
for wire in smt_wires[sig.path]:
width, offset = wire["width"], wire["offset"]
smt_bool = smt.net_width(topmod, wire["smtpath"]) == 1
offset = max(offset, 0)
end = width + offset
common_offset = max(sig.offset, offset)
common_end = min(sig_end, end)
if common_end <= common_offset:
continue
smt_expr = smt.witness_net_expr(topmod, f"s{t}", wire)
if not smt_bool:
slice_high = common_end - offset - 1
slice_low = common_offset - offset
smt_expr = "((_ extract %d %d) %s)" % (slice_high, slice_low, smt_expr)
bit_slice = bits[len(bits) - (common_end - sig.offset):len(bits) - (common_offset - sig.offset)]
if bit_slice.count("?") == len(bit_slice):
continue
if smt_bool:
assert width == 1
smt_constr = "(= %s %s)" % (smt_expr, "true" if bit_slice == "1" else "false")
else:
if "?" in bit_slice:
mask = bit_slice.replace("0", "1").replace("?", "0")
bit_slice = bit_slice.replace("?", "0")
smt_expr = "(bvand %s #b%s)" % (smt_expr, mask)
smt_constr = "(= %s #b%s)" % (smt_expr, bit_slice)
constr_assumes[t].append((inywfile, smt_constr))
if sig.memory_path:
if sig.memory_path in smt_mems:
for mem in smt_mems[sig.memory_path]:
width, size, bv = mem["width"], mem["size"], mem["statebv"]
smt_expr = smt.net_expr(topmod, f"s{t}", mem["smtpath"])
if bv:
word_low = sig.memory_addr * width
word_high = word_low + width - 1
smt_expr = "((_ extract %d %d) %s)" % (word_high, word_low, smt_expr)
else:
addr_width = (size - 1).bit_length()
addr_bits = f"{sig.memory_addr:0{addr_width}b}"
smt_expr = "(select %s #b%s )" % (smt_expr, addr_bits)
if len(bits) < width:
slice_high = sig.offset + len(bits) - 1
smt_expr = "((_ extract %d %d) %s)" % (slice_high, sig.offset, smt_expr)
bit_slice = bits
if "?" in bit_slice:
mask = bit_slice.replace("0", "1").replace("?", "0")
bit_slice = bit_slice.replace("?", "0")
smt_expr = "(bvand %s #b%s)" % (smt_expr, mask)
smt_constr = "(= %s #b%s)" % (smt_expr, bit_slice)
constr_assumes[t].append((inywfile, smt_constr))
if not got_topt:
if not check_witness:
skip_steps = max(skip_steps, t)
num_steps = max(num_steps, t+1)
if btorwitfile is not None:
with open(btorwitfile, "r") as f:
step = None
suffix = None
altsuffix = None
header_okay = False
for line in f:
line = line.strip()
if line == "sat":
header_okay = True
continue
if not header_okay:
continue
if line == "" or line[0] == "b" or line[0] == "j":
continue
if line == ".":
break
if line[0] == '#' or line[0] == '@':
step = int(line[1:])
suffix = line
altsuffix = suffix
if suffix[0] == "@":
altsuffix = "#" + suffix[1:]
else:
altsuffix = "@" + suffix[1:]
continue
line = line.split()
if len(line) == 0:
continue
if line[-1].endswith(suffix):
line[-1] = line[-1][0:len(line[-1]) - len(suffix)]
if line[-1].endswith(altsuffix):
line[-1] = line[-1][0:len(line[-1]) - len(altsuffix)]
if line[-1][0] == "$":
continue
# BV assignments
if len(line) == 3 and line[1][0] != "[":
value = line[1]
name = line[2]
path = smt.get_path(topmod, name)
if not smt.net_exists(topmod, path):
continue
width = smt.net_width(topmod, path)
if width == 1:
assert value in ["0", "1"]
value = "true" if value == "1" else "false"
else:
value = "#b" + value
smtexpr = "(= [%s] %s)" % (name, value)
constr_assumes[step].append((btorwitfile, smtexpr))
# Array assignments
if len(line) == 4 and line[1][0] == "[":
index = line[1]
value = line[2]
name = line[3]
path = smt.get_path(topmod, name)
if not smt.mem_exists(topmod, path):
continue
meminfo = smt.mem_info(topmod, path)
if meminfo[1] == 1:
assert value in ["0", "1"]
value = "true" if value == "1" else "false"
else:
value = "#b" + value
assert index[0] == "["
assert index[-1] == "]"
index = "#b" + index[1:-1]
smtexpr = "(= (select [%s] %s) %s)" % (name, index, value)
constr_assumes[step].append((btorwitfile, smtexpr))
skip_steps = step
num_steps = step+1
def collect_mem_trace_data(steps_start, steps_stop, vcd=None):
mem_trace_data = dict()
2015-10-13 10:17:23 -05:00
for mempath in sorted(smt.hiermems(topmod)):
abits, width, rports, wports, asyncwr = smt.mem_info(topmod, mempath)
expr_id = list()
expr_list = list()
for i in range(steps_start, steps_stop):
for j in range(rports):
expr_id.append(('R', i-steps_start, j, 'A'))
expr_id.append(('R', i-steps_start, j, 'D'))
expr_list.append(smt.mem_expr(topmod, "s%d" % i, mempath, "R%dA" % j))
expr_list.append(smt.mem_expr(topmod, "s%d" % i, mempath, "R%dD" % j))
for j in range(wports):
expr_id.append(('W', i-steps_start, j, 'A'))
expr_id.append(('W', i-steps_start, j, 'D'))
expr_id.append(('W', i-steps_start, j, 'M'))
expr_list.append(smt.mem_expr(topmod, "s%d" % i, mempath, "W%dA" % j))
expr_list.append(smt.mem_expr(topmod, "s%d" % i, mempath, "W%dD" % j))
expr_list.append(smt.mem_expr(topmod, "s%d" % i, mempath, "W%dM" % j))
rdata = list()
wdata = list()
addrs = set()
for eid, edat in zip(expr_id, smt.get_list(expr_list)):
t, i, j, f = eid
if t == 'R':
c = rdata
elif t == 'W':
c = wdata
else:
assert False
2015-10-13 10:17:23 -05:00
while len(c) <= i:
c.append(list())
c = c[i]
while len(c) <= j:
c.append(dict())
c = c[j]
c[f] = smt.bv2bin(edat)
if f == 'A':
addrs.add(c[f])
for addr in addrs:
tdata = list()
data = ["x"] * width
gotread = False
if len(wdata) == 0 and len(rdata) != 0:
wdata = [[]] * len(rdata)
assert len(rdata) == len(wdata)
for i in range(len(wdata)):
if not gotread:
for j_data in rdata[i]:
if j_data["A"] == addr:
data = list(j_data["D"])
gotread = True
break
if gotread:
buf = data[:]
for ii in reversed(range(len(tdata))):
for k in range(width):
if tdata[ii][k] == "x":
tdata[ii][k] = buf[k]
else:
buf[k] = tdata[ii][k]
if not asyncwr:
tdata.append(data[:])
for j_data in wdata[i]:
if j_data["A"] != addr:
continue
D = j_data["D"]
M = j_data["M"]
for k in range(width):
if M[k] == "1":
data[k] = D[k]
if asyncwr:
tdata.append(data[:])
assert len(tdata) == len(rdata)
int_addr = int(addr, 2)
netpath = mempath[:]
if vcd:
netpath[-1] += "<%0*x>" % ((len(addr)+3) // 4, int_addr)
vcd.add_net([topmod] + netpath, width)
for i in range(steps_start, steps_stop):
if i not in mem_trace_data:
mem_trace_data[i] = list()
mem_trace_data[i].append((netpath, int_addr, "".join(tdata[i-steps_start])))
return mem_trace_data
def write_vcd_trace(steps_start, steps_stop, index):
filename = vcdfile.replace("%", index)
print_msg("Writing trace to VCD file: %s" % (filename))
with open(filename, "w") as vcd_file:
vcd = MkVcd(vcd_file)
path_list = list()
for netpath in sorted(smt.hiernets(topmod)):
hidden_net = False
for n in netpath:
if n.startswith("$"):
hidden_net = True
if not hidden_net:
edge = smt.net_clock(topmod, netpath)
if edge is None:
vcd.add_net([topmod] + netpath, smt.net_width(topmod, netpath))
else:
vcd.add_clock([topmod] + netpath, edge)
path_list.append(netpath)
mem_trace_data = collect_mem_trace_data(steps_start, steps_stop, vcd)
2016-08-29 15:41:45 -05:00
for i in range(steps_start, steps_stop):
vcd.set_time(i)
value_list = smt.get_net_bin_list(topmod, path_list, "s%d" % i)
for path, value in zip(path_list, value_list):
vcd.set_net([topmod] + path, value)
if i in mem_trace_data:
for path, addr, value in mem_trace_data[i]:
vcd.set_net([topmod] + path, value)
2015-10-13 10:17:23 -05:00
2016-08-29 15:41:45 -05:00
vcd.set_time(steps_stop)
2015-10-13 10:17:23 -05:00
def detect_state_loop(steps_start, steps_stop):
print_msg(f"Checking for loops in found induction counter example")
print_msg(f"This feature is experimental and incomplete")
path_list = sorted(smt.hiernets(topmod, regs_only=True))
mem_trace_data = collect_mem_trace_data(steps_start, steps_stop)
# Map state to index of step when it occurred
states = dict()
for i in range(steps_start, steps_stop):
value_list = smt.get_net_bin_list(topmod, path_list, "s%d" % i)
mem_state = sorted(
[(tuple(path), addr, data)
for path, addr, data in mem_trace_data.get(i, [])])
state = tuple(value_list), tuple(mem_state)
if state in states:
return (i, states[state])
else:
states[state] = i
return None
def char_ok_in_verilog(c,i):
if ('A' <= c <= 'Z'): return True
if ('a' <= c <= 'z'): return True
if ('0' <= c <= '9' and i>0): return True
if (c == '_'): return True
if (c == '$'): return True
return False
def escape_identifier(identifier):
if type(identifier) is list:
return map(escape_identifier, identifier)
if "." in identifier:
return ".".join(escape_identifier(identifier.split(".")))
if (all(char_ok_in_verilog(identifier[i],i) for i in range(0, len(identifier)))):
return identifier
return "\\"+identifier+" "
2015-10-13 10:17:23 -05:00
2016-08-29 15:41:45 -05:00
def write_vlogtb_trace(steps_start, steps_stop, index):
filename = vlogtbfile.replace("%", index)
print_msg("Writing trace to Verilog testbench: %s" % (filename))
2016-08-20 11:43:39 -05:00
2017-07-01 11:19:23 -05:00
vlogtb_topmod = topmod
vlogtb_state = "s@@step_idx@@"
if vlogtbtop is not None:
for item in vlogtbtop.split("."):
if item in smt.modinfo[vlogtb_topmod].cells:
vlogtb_state = "(|%s_h %s| %s)" % (vlogtb_topmod, item, vlogtb_state)
vlogtb_topmod = smt.modinfo[vlogtb_topmod].cells[item]
else:
print_msg("Vlog top module '%s' not found: no cell '%s' in module '%s'" % (vlogtbtop, item, vlogtb_topmod))
break
2017-07-01 11:19:23 -05:00
2016-08-29 15:41:45 -05:00
with open(filename, "w") as f:
print("`ifndef VERILATOR", file=f)
2016-08-20 11:43:39 -05:00
print("module testbench;", file=f)
print(" reg [4095:0] vcdfile;", file=f)
print(" reg clock;", file=f)
print("`else", file=f)
print("module testbench(input clock, output reg genclock);", file=f)
print(" initial genclock = 1;", file=f)
print("`endif", file=f)
print(" reg genclock = 1;", file=f)
print(" reg [31:0] cycle = 0;", file=f)
2016-08-20 11:43:39 -05:00
primary_inputs = list()
clock_inputs = set()
2017-07-01 11:19:23 -05:00
for name in smt.modinfo[vlogtb_topmod].inputs:
2016-08-20 11:43:39 -05:00
if name in ["clk", "clock", "CLK", "CLOCK"]:
clock_inputs.add(name)
2017-07-01 11:19:23 -05:00
width = smt.modinfo[vlogtb_topmod].wsize[name]
2016-08-20 11:43:39 -05:00
primary_inputs.append((name, width))
for name, width in primary_inputs:
if name in clock_inputs:
print(" wire [%d:0] %s = clock;" % (width-1, escape_identifier("PI_"+name)), file=f)
2016-08-20 11:43:39 -05:00
else:
print(" reg [%d:0] %s;" % (width-1, escape_identifier("PI_"+name)), file=f)
2016-08-20 11:43:39 -05:00
print(" %s UUT (" % escape_identifier(vlogtb_topmod), file=f)
print(",\n".join(" .%s(%s)" % (escape_identifier(name), escape_identifier("PI_"+name)) for name, _ in primary_inputs), file=f)
2016-08-20 11:43:39 -05:00
print(" );", file=f)
print("`ifndef VERILATOR", file=f)
2016-08-20 11:43:39 -05:00
print(" initial begin", file=f)
print(" if ($value$plusargs(\"vcd=%s\", vcdfile)) begin", file=f)
print(" $dumpfile(vcdfile);", file=f)
print(" $dumpvars(0, testbench);", file=f)
print(" end", file=f)
print(" #5 clock = 0;", file=f)
2016-08-20 11:43:39 -05:00
print(" while (genclock) begin", file=f)
print(" #5 clock = 0;", file=f)
print(" #5 clock = 1;", file=f)
2016-08-20 11:43:39 -05:00
print(" end", file=f)
print(" end", file=f)
print("`endif", file=f)
2016-08-20 11:43:39 -05:00
print(" initial begin", file=f)
2017-07-01 11:19:23 -05:00
regs = sorted(smt.hiernets(vlogtb_topmod, regs_only=True))
regvals = smt.get_net_bin_list(vlogtb_topmod, regs, vlogtb_state.replace("@@step_idx@@", str(steps_start)))
2016-08-20 11:43:39 -05:00
print("`ifndef VERILATOR", file=f)
print(" #1;", file=f)
print("`endif", file=f)
2016-08-20 11:43:39 -05:00
for reg, val in zip(regs, regvals):
hidden_net = False
for n in reg:
if n.startswith("$"):
hidden_net = True
print(" %sUUT.%s = %d'b%s;" % ("// " if hidden_net else "", ".".join(escape_identifier(reg)), len(val), val), file=f)
2016-08-20 11:43:39 -05:00
2017-07-01 11:19:23 -05:00
anyconsts = sorted(smt.hieranyconsts(vlogtb_topmod))
for info in anyconsts:
if info[3] is not None:
2017-07-01 11:19:23 -05:00
modstate = smt.net_expr(vlogtb_topmod, vlogtb_state.replace("@@step_idx@@", str(steps_start)), info[0])
value = smt.bv2bin(smt.get("(|%s| %s)" % (info[1], modstate)))
print(" UUT.%s = %d'b%s;" % (".".join(escape_identifier(info[0] + [info[3]])), len(value), value), file=f);
2017-07-01 11:19:23 -05:00
mems = sorted(smt.hiermems(vlogtb_topmod))
2016-08-20 11:43:39 -05:00
for mempath in mems:
abits, width, rports, wports, asyncwr = smt.mem_info(vlogtb_topmod, mempath)
addr_expr_list = list()
data_expr_list = list()
2016-08-29 15:41:45 -05:00
for i in range(steps_start, steps_stop):
2017-02-24 11:24:53 -06:00
for j in range(rports):
2017-07-01 11:19:23 -05:00
addr_expr_list.append(smt.mem_expr(vlogtb_topmod, vlogtb_state.replace("@@step_idx@@", str(i)), mempath, "R%dA" % j))
data_expr_list.append(smt.mem_expr(vlogtb_topmod, vlogtb_state.replace("@@step_idx@@", str(i)), mempath, "R%dD" % j))
addr_list = smt.get_list(addr_expr_list)
data_list = smt.get_list(data_expr_list)
2016-08-20 11:43:39 -05:00
addr_data = dict()
for addr, data in zip(addr_list, data_list):
addr = smt.bv2bin(addr)
data = smt.bv2bin(data)
if addr not in addr_data:
addr_data[addr] = data
2016-08-20 11:43:39 -05:00
for addr, data in addr_data.items():
print(" UUT.%s[%d'b%s] = %d'b%s;" % (".".join(escape_identifier(mempath)), len(addr), addr, len(data), data), file=f)
2016-08-20 11:43:39 -05:00
print("", file=f)
2017-07-01 11:19:23 -05:00
anyseqs = sorted(smt.hieranyseqs(vlogtb_topmod))
2016-08-29 15:41:45 -05:00
for i in range(steps_start, steps_stop):
2016-08-20 11:43:39 -05:00
pi_names = [[name] for name, _ in primary_inputs if name not in clock_inputs]
2017-07-01 11:19:23 -05:00
pi_values = smt.get_net_bin_list(vlogtb_topmod, pi_names, vlogtb_state.replace("@@step_idx@@", str(i)))
2016-08-20 11:43:39 -05:00
print(" // state %d" % i, file=f)
2016-08-20 11:43:39 -05:00
if i > 0:
print(" if (cycle == %d) begin" % (i-1), file=f)
2016-08-20 11:43:39 -05:00
for name, val in zip(pi_names, pi_values):
if i > 0:
print(" %s <= %d'b%s;" % (escape_identifier("PI_"+".".join(name)), len(val), val), file=f)
else:
print(" %s = %d'b%s;" % (escape_identifier("PI_"+".".join(name)), len(val), val), file=f)
2016-08-20 11:43:39 -05:00
for info in anyseqs:
if info[3] is not None:
2017-07-01 11:19:23 -05:00
modstate = smt.net_expr(vlogtb_topmod, vlogtb_state.replace("@@step_idx@@", str(i)), info[0])
value = smt.bv2bin(smt.get("(|%s| %s)" % (info[1], modstate)))
if i > 0:
print(" UUT.%s <= %d'b%s;" % (".".join(escape_identifier(info[0] + [info[3]])), len(value), value), file=f);
else:
print(" UUT.%s = %d'b%s;" % (".".join(escape_identifier(info[0] + [info[3]])), len(value), value), file=f);
if i > 0:
print(" end", file=f)
print("", file=f)
if i == 0:
print(" end", file=f)
print(" always @(posedge clock) begin", file=f)
print(" genclock <= cycle < %d;" % (steps_stop-1), file=f)
print(" cycle <= cycle + 1;", file=f)
2016-08-20 11:43:39 -05:00
print(" end", file=f)
print("endmodule", file=f)
2016-08-29 15:41:45 -05:00
def write_constr_trace(steps_start, steps_stop, index):
filename = outconstr.replace("%", index)
print_msg("Writing trace to constraints file: %s" % (filename))
2016-08-22 09:48:46 -05:00
constr_topmod = topmod
constr_state = "s@@step_idx@@"
constr_prefix = ""
if smtctop is not None:
for item in smtctop[0].split("."):
assert item in smt.modinfo[constr_topmod].cells
constr_state = "(|%s_h %s| %s)" % (constr_topmod, item, constr_state)
constr_topmod = smt.modinfo[constr_topmod].cells[item]
if smtctop[1] != "":
constr_prefix = smtctop[1] + "."
if smtcinit:
steps_start = steps_stop - 1
2016-08-29 15:41:45 -05:00
with open(filename, "w") as f:
2016-08-22 09:48:46 -05:00
primary_inputs = list()
for name in smt.modinfo[constr_topmod].inputs:
width = smt.modinfo[constr_topmod].wsize[name]
2016-08-22 09:48:46 -05:00
primary_inputs.append((name, width))
if steps_start == 0 or smtcinit:
2016-08-29 15:41:45 -05:00
print("initial", file=f)
else:
print("state %d" % steps_start, file=f)
2016-08-22 09:48:46 -05:00
regnames = sorted(smt.hiernets(constr_topmod, regs_only=True))
regvals = smt.get_net_list(constr_topmod, regnames, constr_state.replace("@@step_idx@@", str(steps_start)))
2016-08-22 09:48:46 -05:00
for name, val in zip(regnames, regvals):
print("assume (= [%s%s] %s)" % (constr_prefix, ".".join(name), val), file=f)
2016-08-22 09:48:46 -05:00
mems = sorted(smt.hiermems(constr_topmod))
for mempath in mems:
abits, width, rports, wports, asyncwr = smt.mem_info(constr_topmod, mempath)
2016-08-22 09:48:46 -05:00
addr_expr_list = list()
data_expr_list = list()
2016-08-29 15:41:45 -05:00
for i in range(steps_start, steps_stop):
2017-02-24 11:24:53 -06:00
for j in range(rports):
addr_expr_list.append(smt.mem_expr(constr_topmod, constr_state.replace("@@step_idx@@", str(i)), mempath, "R%dA" % j))
data_expr_list.append(smt.mem_expr(constr_topmod, constr_state.replace("@@step_idx@@", str(i)), mempath, "R%dD" % j))
2016-08-22 09:48:46 -05:00
addr_list = smt.get_list(addr_expr_list)
data_list = smt.get_list(data_expr_list)
addr_data = dict()
for addr, data in zip(addr_list, data_list):
if addr not in addr_data:
addr_data[addr] = data
for addr, data in addr_data.items():
print("assume (= (select [%s%s] %s) %s)" % (constr_prefix, ".".join(mempath), addr, data), file=f)
2016-08-22 09:48:46 -05:00
2016-08-29 15:41:45 -05:00
for k in range(steps_start, steps_stop):
if not smtcinit:
print("", file=f)
print("state %d" % k, file=f)
2016-08-22 09:48:46 -05:00
pi_names = [[name] for name, _ in sorted(primary_inputs)]
pi_values = smt.get_net_list(constr_topmod, pi_names, constr_state.replace("@@step_idx@@", str(k)))
2016-08-22 09:48:46 -05:00
for name, val in zip(pi_names, pi_values):
print("assume (= [%s%s] %s)" % (constr_prefix, ".".join(name), val), file=f)
2016-08-22 09:48:46 -05:00
def write_yw_trace(steps_start, steps_stop, index, allregs=False):
filename = outywfile.replace("%", index)
print_msg("Writing trace to Yosys witness file: %s" % (filename))
mem_trace_data = collect_mem_trace_data(steps_start, steps_stop)
with open(filename, "w") as f:
inits, seqs, clocks, mems = smt.hierwitness(topmod, allregs)
yw = WriteWitness(f, "smtbmc")
for clock in clocks:
yw.add_clock(clock["path"], clock["offset"], clock["type"])
for seq in seqs:
seq["sig"] = yw.add_sig(seq["path"], seq["offset"], seq["width"])
for init in inits:
init["sig"] = yw.add_sig(init["path"], init["offset"], init["width"], True)
inits = seqs + inits
mem_dict = {tuple(mem["smtpath"]): mem for mem in mems}
mem_init_values = []
for path, addr, value in mem_trace_data.get(0, ()):
json_mem = mem_dict.get(tuple(path))
if not json_mem:
continue
bit_addr = addr * json_mem["width"]
uninit_chunks = [(chunk["width"] + chunk["offset"], chunk["offset"]) for chunk in json_mem["uninitialized"]]
first_chunk_nr = bisect.bisect_left(uninit_chunks, (bit_addr + 1,))
for uninit_end, uninit_offset in uninit_chunks[first_chunk_nr:]:
assert uninit_end > bit_addr
if uninit_offset > bit_addr + json_mem["width"]:
break
word_path = (*json_mem["path"], f"\\[{addr}]")
overlap_start = max(uninit_offset - bit_addr, 0)
overlap_end = min(uninit_end - bit_addr, json_mem["width"])
overlap_bits = value[len(value)-overlap_end:len(value)-overlap_start]
sig = yw.add_sig(word_path, overlap_start, overlap_end - overlap_start, True)
mem_init_values.append((sig, overlap_bits.replace("x", "?")))
for k in range(steps_start, steps_stop):
step_values = WitnessValues()
2016-08-22 09:48:46 -05:00
if k == steps_start:
for sig, value in mem_init_values:
step_values[sig] = value
sigs = inits + seqs
else:
sigs = seqs
for sig in sigs:
value = smt.bv2bin(smt.get(smt.witness_net_expr(topmod, f"s{k}", sig)))
step_values[sig["sig"]] = value
yw.step(step_values)
yw.end_trace()
def write_trace(steps_start, steps_stop, index, allregs=False):
2016-08-20 11:43:39 -05:00
if vcdfile is not None:
2016-08-29 15:41:45 -05:00
write_vcd_trace(steps_start, steps_stop, index)
2016-08-20 11:43:39 -05:00
if vlogtbfile is not None:
2016-08-29 15:41:45 -05:00
write_vlogtb_trace(steps_start, steps_stop, index)
2016-08-20 11:43:39 -05:00
2016-08-22 09:48:46 -05:00
if outconstr is not None:
2016-08-29 15:41:45 -05:00
write_constr_trace(steps_start, steps_stop, index)
2016-08-22 09:48:46 -05:00
if outywfile is not None:
write_yw_trace(steps_start, steps_stop, index, allregs)
2016-08-20 11:43:39 -05:00
def print_failed_asserts_worker(mod, state, path, extrainfo, infomap, infokey=()):
assert mod in smt.modinfo
2017-02-04 14:22:17 -06:00
found_failed_assert = False
2016-09-13 06:23:06 -05:00
if smt.get("(|%s_a| %s)" % (mod, state)) in ["true", "#b1"]:
return
for cellname, celltype in smt.modinfo[mod].cells.items():
cell_infokey = (mod, cellname, infokey)
if print_failed_asserts_worker(celltype, "(|%s_h %s| %s)" % (mod, cellname, state), path + "." + cellname, extrainfo, infomap, cell_infokey):
2017-02-04 14:22:17 -06:00
found_failed_assert = True
for assertfun, assertinfo in smt.modinfo[mod].asserts.items():
2016-09-13 06:23:06 -05:00
if smt.get("(|%s| %s)" % (assertfun, state)) in ["false", "#b0"]:
assert_key = (assertfun, infokey)
print_msg("Assert failed in %s: %s%s%s" % (path, assertinfo, extrainfo, infomap.get(assert_key, '')))
2017-02-04 14:22:17 -06:00
found_failed_assert = True
2017-02-04 14:22:17 -06:00
return found_failed_assert
2017-02-04 14:22:17 -06:00
def print_failed_asserts(state, final=False, extrainfo="", infomap={}):
if noinfo: return
loc_list, expr_list, value_list = get_constr_expr(constr_asserts, state, final=final, getvalues=True)
2017-02-04 14:22:17 -06:00
found_failed_assert = False
for loc, expr, value in zip(loc_list, expr_list, value_list):
if smt.bv2int(value) == 0:
print_msg("Assert %s failed: %s%s%s" % (loc, expr, extrainfo, infomap.get(loc, '')))
2017-02-04 14:22:17 -06:00
found_failed_assert = True
if not final:
if print_failed_asserts_worker(topmod, "s%d" % state, topmod, extrainfo, infomap):
2017-02-04 14:22:17 -06:00
found_failed_assert = True
return found_failed_assert
def print_anyconsts_worker(mod, state, path):
assert mod in smt.modinfo
for cellname, celltype in smt.modinfo[mod].cells.items():
print_anyconsts_worker(celltype, "(|%s_h %s| %s)" % (mod, cellname, state), path + "." + cellname)
for fun, info in smt.modinfo[mod].anyconsts.items():
if info[1] is None:
if not binarymode:
print_msg("Value for anyconst in %s (%s): %d" % (path, info[0], smt.bv2int(smt.get("(|%s| %s)" % (fun, state)))))
else:
print_msg("Value for anyconst in %s (%s): %s" % (path, info[0], smt.bv2bin(smt.get("(|%s| %s)" % (fun, state)))))
else:
if not binarymode:
print_msg("Value for anyconst %s.%s (%s): %d" % (path, info[1], info[0], smt.bv2int(smt.get("(|%s| %s)" % (fun, state)))))
else:
print_msg("Value for anyconst %s.%s (%s): %s" % (path, info[1], info[0], smt.bv2bin(smt.get("(|%s| %s)" % (fun, state)))))
def print_anyconsts(state):
if noinfo: return
print_anyconsts_worker(topmod, "s%d" % state, topmod)
def get_cover_list(mod, base):
assert mod in smt.modinfo
cover_expr = list()
cover_desc = list()
for expr, desc in smt.modinfo[mod].covers.items():
cover_expr.append("(ite (|%s| %s) #b1 #b0)" % (expr, base))
cover_desc.append(desc)
for cell, submod in smt.modinfo[mod].cells.items():
e, d = get_cover_list(submod, "(|%s_h %s| %s)" % (mod, cell, base))
cover_expr += e
cover_desc += d
return cover_expr, cover_desc
def get_assert_map(mod, base, path, key_base=()):
assert mod in smt.modinfo
assert_map = dict()
for expr, desc in smt.modinfo[mod].asserts.items():
assert_map[(expr, key_base)] = ("(|%s| %s)" % (expr, base), path, desc)
for cell, submod in smt.modinfo[mod].cells.items():
assert_map.update(get_assert_map(submod, "(|%s_h %s| %s)" % (mod, cell, base), path + "." + cell, (mod, cell, key_base)))
return assert_map
def get_assert_keys():
keys = set()
keys.update(get_assert_map(topmod, 'state', topmod).keys())
for step_constr_asserts in constr_asserts.values():
keys.update(loc for loc, expr in step_constr_asserts)
return keys
def get_active_assert_map(step, active):
assert_map = dict()
for key, assert_data in get_assert_map(topmod, "s%s" % step, topmod).items():
if key in active:
assert_map[key] = assert_data
for loc, expr, actual_expr in zip(*get_constr_expr(constr_asserts, step, individual=True)):
if loc in active:
assert_map[loc] = (actual_expr, None, (expr, loc))
return assert_map
states = list()
asserts_antecedent_cache = [list()]
asserts_consequent_cache = [list()]
asserts_cache_dirty = False
def smt_state(step):
smt.write("(declare-fun s%d () |%s_s|)" % (step, topmod))
states.append("s%d" % step)
def smt_assert(expr):
if expr == "true":
return
smt.write("(assert %s)" % expr)
def smt_assert_antecedent(expr):
if expr == "true":
return
smt.write("(assert %s)" % expr)
global asserts_cache_dirty
asserts_cache_dirty = True
asserts_antecedent_cache[-1].append(expr)
def smt_assert_consequent(expr):
if expr == "true":
return
smt.write("(assert %s)" % expr)
global asserts_cache_dirty
asserts_cache_dirty = True
asserts_consequent_cache[-1].append(expr)
def smt_forall_assert():
if not smt.forall:
return
global asserts_cache_dirty
asserts_cache_dirty = False
assert (len(smt.modinfo[topmod].maximize) + len(smt.modinfo[topmod].minimize) <= 1)
def make_assert_expr(asserts_cache):
expr = list()
for lst in asserts_cache:
expr += lst
assert len(expr) != 0
if len(expr) == 1:
expr = expr[0]
else:
expr = "(and %s)" % (" ".join(expr))
return expr
antecedent_expr = make_assert_expr(asserts_antecedent_cache)
consequent_expr = make_assert_expr(asserts_consequent_cache)
states_db = set(states)
used_states_db = set()
new_antecedent_expr = list()
new_consequent_expr = list()
assert_expr = list()
def make_new_expr(new_expr, expr):
cursor = 0
while cursor < len(expr):
l = 1
if expr[cursor] in '|"':
while cursor+l+1 < len(expr) and expr[cursor] != expr[cursor+l]:
l += 1
l += 1
elif expr[cursor] not in '() ':
while cursor+l < len(expr) and expr[cursor+l] not in '|"() ':
l += 1
word = expr[cursor:cursor+l]
if word in states_db:
used_states_db.add(word)
word += "_"
new_expr.append(word)
cursor += l
make_new_expr(new_antecedent_expr, antecedent_expr)
make_new_expr(new_consequent_expr, consequent_expr)
new_antecedent_expr = ["".join(new_antecedent_expr)]
new_consequent_expr = ["".join(new_consequent_expr)]
if states[0] in used_states_db:
new_antecedent_expr.append("(|%s_ex_state_eq| %s %s_)" % (topmod, states[0], states[0]))
for s in states:
if s in used_states_db:
new_antecedent_expr.append("(|%s_ex_input_eq| %s %s_)" % (topmod, s, s))
if len(new_antecedent_expr) == 0:
new_antecedent_expr = "true"
elif len(new_antecedent_expr) == 1:
new_antecedent_expr = new_antecedent_expr[0]
else:
new_antecedent_expr = "(and %s)" % (" ".join(new_antecedent_expr))
if len(new_consequent_expr) == 0:
new_consequent_expr = "true"
elif len(new_consequent_expr) == 1:
new_consequent_expr = new_consequent_expr[0]
else:
new_consequent_expr = "(and %s)" % (" ".join(new_consequent_expr))
assert_expr.append("(assert (forall (")
first_state = True
for s in states:
if s in used_states_db:
assert_expr.append("%s(%s_ |%s_s|)" % ("" if first_state else " ", s, topmod))
first_state = False
assert_expr.append(") (=> %s %s)))" % (new_antecedent_expr, new_consequent_expr))
smt.write("".join(assert_expr))
if len(smt.modinfo[topmod].maximize) > 0:
for s in states:
if s in used_states_db:
smt.write("(maximize (|%s| %s))\n" % (smt.modinfo[topmod].maximize.copy().pop(), s))
break
if len(smt.modinfo[topmod].minimize) > 0:
for s in states:
if s in used_states_db:
smt.write("(minimize (|%s| %s))\n" % (smt.modinfo[topmod].minimize.copy().pop(), s))
break
def smt_push():
global asserts_cache_dirty
asserts_cache_dirty = True
asserts_antecedent_cache.append(list())
asserts_consequent_cache.append(list())
smt.write("(push 1)")
def smt_pop():
global asserts_cache_dirty
asserts_cache_dirty = True
asserts_antecedent_cache.pop()
asserts_consequent_cache.pop()
smt.write("(pop 1)")
def smt_check_sat(expected=["sat", "unsat"]):
if asserts_cache_dirty:
smt_forall_assert()
return smt.check_sat(expected=expected)
2015-10-13 17:18:38 -05:00
if tempind:
retstatus = "FAILED"
2015-12-20 02:58:54 -06:00
skip_counter = step_size
2015-10-13 18:27:55 -05:00
for step in range(num_steps, -1, -1):
if smt.forall:
print_msg("Temporal induction not supported for exists-forall problems.")
break
smt_state(step)
smt_assert_consequent("(|%s_u| s%d)" % (topmod, step))
smt_assert_antecedent("(|%s_h| s%d)" % (topmod, step))
smt_assert_antecedent("(not (|%s_is| s%d))" % (topmod, step))
smt_assert_consequent(get_constr_expr(constr_assumes, step))
2015-10-13 10:17:23 -05:00
2015-10-13 18:27:55 -05:00
if step == num_steps:
smt_assert("(not (and (|%s_a| s%d) %s))" % (topmod, step, get_constr_expr(constr_asserts, step)))
2015-10-13 17:18:38 -05:00
else:
smt_assert_antecedent("(|%s_t| s%d s%d)" % (topmod, step, step+1))
smt_assert("(|%s_a| s%d)" % (topmod, step))
smt_assert(get_constr_expr(constr_asserts, step))
2015-10-13 17:18:38 -05:00
2015-10-13 18:27:55 -05:00
if step > num_steps-skip_steps:
print_msg("Skipping induction in step %d.." % (step))
2015-10-13 17:18:38 -05:00
continue
2015-12-20 02:58:54 -06:00
skip_counter += 1
if skip_counter < step_size:
print_msg("Skipping induction in step %d.." % (step))
2015-12-20 02:58:54 -06:00
continue
skip_counter = 0
print_msg("Trying induction in step %d.." % (step))
2015-10-13 17:18:38 -05:00
if smt_check_sat() == "sat":
2015-10-13 17:18:38 -05:00
if step == 0:
print_msg("Temporal induction failed!")
print_anyconsts(num_steps)
print_failed_asserts(num_steps)
write_trace(step, num_steps+1, '%', allregs=True)
if detect_loops:
loop = detect_state_loop(step, num_steps+1)
if loop:
print_msg(f"Loop detected, increasing induction depth will not help. Step {loop[0]} = step {loop[1]}")
2016-08-29 15:41:45 -05:00
elif dumpall:
print_anyconsts(num_steps)
2016-08-29 15:41:45 -05:00
print_failed_asserts(num_steps)
write_trace(step, num_steps+1, "%d" % step, allregs=True)
2015-10-13 17:18:38 -05:00
else:
print_msg("Temporal induction successful.")
retstatus = "PASSED"
2015-10-13 17:18:38 -05:00
break
elif covermode:
cover_expr, cover_desc = get_cover_list(topmod, "state")
2017-02-04 14:10:24 -06:00
cover_mask = "1" * len(cover_desc)
if len(cover_expr) > 1:
cover_expr = "(concat %s)" % " ".join(cover_expr)
elif len(cover_expr) == 1:
cover_expr = cover_expr[0]
else:
cover_expr = "#b0"
coveridx = 0
smt.write("(define-fun covers_0 ((state |%s_s|)) (_ BitVec %d) %s)" % (topmod, len(cover_desc), cover_expr))
step = 0
retstatus = "FAILED"
2017-02-04 14:22:17 -06:00
found_failed_assert = False
assert step_size == 1
while step < num_steps:
smt_state(step)
smt_assert_consequent("(|%s_u| s%d)" % (topmod, step))
smt_assert_antecedent("(|%s_h| s%d)" % (topmod, step))
smt_assert_consequent(get_constr_expr(constr_assumes, step))
if step == 0:
if noinit:
smt_assert_antecedent("(not (|%s_is| s%d))" % (topmod, step))
else:
smt_assert_antecedent("(|%s_i| s0)" % (topmod))
smt_assert_antecedent("(|%s_is| s0)" % (topmod))
else:
smt_assert_antecedent("(|%s_t| s%d s%d)" % (topmod, step-1, step))
smt_assert_antecedent("(not (|%s_is| s%d))" % (topmod, step))
2017-02-04 14:10:24 -06:00
while "1" in cover_mask:
print_msg("Checking cover reachability in step %d.." % (step))
smt_push()
smt_assert("(distinct (covers_%d s%d) #b%s)" % (coveridx, step, "0" * len(cover_desc)))
if smt_check_sat() == "unsat":
smt_pop()
break
if append_steps > 0:
for i in range(step+1, step+1+append_steps):
print_msg("Appending additional step %d." % i)
smt_state(i)
smt_assert_antecedent("(not (|%s_is| s%d))" % (topmod, i))
smt_assert_consequent("(|%s_u| s%d)" % (topmod, i))
smt_assert_antecedent("(|%s_h| s%d)" % (topmod, i))
smt_assert_antecedent("(|%s_t| s%d s%d)" % (topmod, i-1, i))
smt_assert_consequent(get_constr_expr(constr_assumes, i))
print_msg("Re-solving with appended steps..")
if smt_check_sat() == "unsat":
print("%s Cannot appended steps without violating assumptions!" % smt.timestamp())
found_failed_assert = True
retstatus = "FAILED"
break
reached_covers = smt.bv2bin(smt.get("(covers_%d s%d)" % (coveridx, step)))
2017-02-04 14:10:24 -06:00
assert len(reached_covers) == len(cover_desc)
new_cover_mask = []
for i in range(len(reached_covers)):
if reached_covers[i] == "0":
2017-02-04 14:10:24 -06:00
new_cover_mask.append(cover_mask[i])
continue
2017-02-04 14:10:24 -06:00
print_msg("Reached cover statement at %s in step %d." % (cover_desc[i], step))
new_cover_mask.append("0")
2017-02-04 14:22:17 -06:00
cover_mask = "".join(new_cover_mask)
for i in range(step+1+append_steps):
2017-02-04 14:22:17 -06:00
if print_failed_asserts(i, extrainfo=" (step %d)" % i):
found_failed_assert = True
write_trace(0, step+1+append_steps, "%d" % coveridx)
2017-02-04 14:22:17 -06:00
if found_failed_assert:
break
2017-02-04 14:10:24 -06:00
coveridx += 1
smt_pop()
2017-02-04 14:10:24 -06:00
smt.write("(define-fun covers_%d ((state |%s_s|)) (_ BitVec %d) (bvand (covers_%d state) #b%s))" % (coveridx, topmod, len(cover_desc), coveridx-1, cover_mask))
if found_failed_assert and not keep_going:
2017-02-04 14:22:17 -06:00
break
2017-02-04 14:10:24 -06:00
if "1" not in cover_mask:
retstatus = "PASSED"
break
step += 1
2016-08-22 10:27:43 -05:00
2017-02-04 14:10:24 -06:00
if "1" in cover_mask:
for i in range(len(cover_mask)):
if cover_mask[i] == "1":
print_msg("Unreached cover statement at %s." % cover_desc[i])
else: # not tempind, covermode
active_assert_keys = get_assert_keys()
failed_assert_infomap = dict()
traceidx = 0
2015-12-20 02:58:54 -06:00
step = 0
retstatus = "PASSED"
2015-12-20 02:58:54 -06:00
while step < num_steps:
smt_state(step)
smt_assert_consequent("(|%s_u| s%d)" % (topmod, step))
smt_assert_antecedent("(|%s_h| s%d)" % (topmod, step))
smt_assert_consequent(get_constr_expr(constr_assumes, step))
2015-10-13 17:18:38 -05:00
if step == 0:
if noinit:
smt_assert_antecedent("(not (|%s_is| s%d))" % (topmod, step))
else:
smt_assert_antecedent("(|%s_i| s0)" % (topmod))
smt_assert_antecedent("(|%s_is| s0)" % (topmod))
2015-10-13 17:18:38 -05:00
else:
smt_assert_antecedent("(|%s_t| s%d s%d)" % (topmod, step-1, step))
smt_assert_antecedent("(not (|%s_is| s%d))" % (topmod, step))
2015-10-13 17:18:38 -05:00
2015-10-13 18:27:55 -05:00
if step < skip_steps:
if assume_skipped is not None and step >= assume_skipped:
print_msg("Skipping step %d (and assuming pass).." % (step))
smt_assert("(|%s_a| s%d)" % (topmod, step))
smt_assert(get_constr_expr(constr_asserts, step))
2015-10-13 18:27:55 -05:00
else:
print_msg("Skipping step %d.." % (step))
2015-12-20 02:58:54 -06:00
step += 1
2015-10-13 18:27:55 -05:00
continue
2015-12-20 02:58:54 -06:00
last_check_step = step
for i in range(1, step_size):
if step+i < num_steps:
smt_state(step+i)
smt_assert_antecedent("(not (|%s_is| s%d))" % (topmod, step+i))
smt_assert_consequent("(|%s_u| s%d)" % (topmod, step+i))
smt_assert_antecedent("(|%s_h| s%d)" % (topmod, step+i))
smt_assert_antecedent("(|%s_t| s%d s%d)" % (topmod, step+i-1, step+i))
smt_assert_consequent(get_constr_expr(constr_assumes, step+i))
2015-12-20 02:58:54 -06:00
last_check_step = step+i
2016-08-24 15:09:50 -05:00
if not gentrace:
2017-07-06 19:47:30 -05:00
if presat:
if last_check_step == step:
print_msg("Checking assumptions in step %d.." % (step))
else:
print_msg("Checking assumptions in steps %d to %d.." % (step, last_check_step))
if smt_check_sat() == "unsat":
print("%s Assumptions are unsatisfiable!" % smt.timestamp())
retstatus = "PREUNSAT"
2017-07-06 19:47:30 -05:00
break
if not final_only:
recheck_current_step = True
while recheck_current_step:
recheck_current_step = False
if last_check_step == step:
print_msg("Checking assertions in step %d.." % (step))
else:
print_msg("Checking assertions in steps %d to %d.." % (step, last_check_step))
smt_push()
active_assert_maps = dict()
active_assert_exprs = list()
for i in range(step, last_check_step+1):
assert_expr_map = get_active_assert_map(i, active_assert_keys)
active_assert_maps[i] = assert_expr_map
active_assert_exprs.extend(assert_data[0] for assert_data in assert_expr_map.values())
if active_assert_exprs:
if len(active_assert_exprs) == 1:
active_assert_expr = active_assert_exprs[0]
else:
active_assert_expr = "(and %s)" % " ".join(active_assert_exprs)
smt_assert("(not %s)" % active_assert_expr)
else:
active_assert_expr = "true"
smt_assert("false")
if smt_check_sat() == "sat":
if retstatus != "FAILED":
print("%s BMC failed!" % smt.timestamp())
if check_witness:
print_msg("Checking witness constraints...")
smt_pop()
smt_push()
smt_assert(active_assert_expr)
if smt_check_sat() != "sat":
retstatus = "PASSED"
check_witness = False
num_steps = -1
break
if append_steps > 0:
for i in range(last_check_step+1, last_check_step+1+append_steps):
print_msg("Appending additional step %d." % i)
smt_state(i)
smt_assert_antecedent("(not (|%s_is| s%d))" % (topmod, i))
smt_assert_consequent("(|%s_u| s%d)" % (topmod, i))
smt_assert_antecedent("(|%s_h| s%d)" % (topmod, i))
smt_assert_antecedent("(|%s_t| s%d s%d)" % (topmod, i-1, i))
smt_assert_consequent(get_constr_expr(constr_assumes, i))
print_msg("Re-solving with appended steps..")
if smt_check_sat() == "unsat":
print("%s Cannot append steps without violating assumptions!" % smt.timestamp())
retstatus = "FAILED"
break
print_anyconsts(step)
for i in range(step, last_check_step+1):
print_failed_asserts(i, infomap=failed_assert_infomap)
if keep_going:
for i in range(step, last_check_step+1):
for key, (expr, path, desc) in active_assert_maps[i].items():
if key in active_assert_keys and not smt.bv2int(smt.get(expr)):
failed_assert_infomap[key] = " [failed before]"
active_assert_keys.remove(key)
if active_assert_keys:
recheck_current_step = True
write_trace(0, last_check_step+1+append_steps, "%d" % traceidx if keep_going else '%')
traceidx += 1
retstatus = "FAILED"
smt_pop()
if recheck_current_step:
print_msg("Checking remaining assertions..")
if retstatus == "FAILED" and not (keep_going and active_assert_keys):
break
2015-10-13 10:17:23 -05:00
2016-09-24 13:40:22 -05:00
if (constr_final_start is not None) or (last_check_step+1 != num_steps):
for i in range(step, last_check_step+1):
assert_expr_map = get_active_assert_map(i, active_assert_keys)
for assert_data in assert_expr_map.values():
smt_assert(assert_data[0])
2016-08-24 15:09:50 -05:00
2016-08-27 07:30:36 -05:00
if constr_final_start is not None:
for i in range(step, last_check_step+1):
if i < constr_final_start:
continue
print_msg("Checking final constraints in step %d.." % (i))
smt_push()
2016-08-27 07:30:36 -05:00
smt_assert_consequent(get_constr_expr(constr_assumes, i, final=True))
smt_assert("(not %s)" % get_constr_expr(constr_asserts, i, final=True))
2016-08-27 07:30:36 -05:00
if smt_check_sat() == "sat":
2016-08-27 07:30:36 -05:00
print("%s BMC failed!" % smt.timestamp())
print_anyconsts(i)
print_failed_asserts(i, final=True)
2016-08-29 15:41:45 -05:00
write_trace(0, i+1, '%')
retstatus = "FAILED"
2016-08-27 07:30:36 -05:00
break
smt_pop()
2020-05-14 12:07:59 -05:00
if retstatus == "FAILED" or retstatus == "PREUNSAT":
2016-08-27 07:30:36 -05:00
break
2016-09-02 05:09:09 -05:00
else: # gentrace
2016-08-27 07:30:36 -05:00
for i in range(step, last_check_step+1):
smt_assert("(|%s_a| s%d)" % (topmod, i))
smt_assert(get_constr_expr(constr_asserts, i))
2016-08-24 15:09:50 -05:00
print_msg("Solving for step %d.." % (last_check_step))
status = smt_check_sat()
if status != "sat":
print("%s No solution found! (%s)" % (smt.timestamp(), status))
retstatus = "FAILED"
2016-08-24 15:09:50 -05:00
break
2015-12-20 02:58:54 -06:00
2016-08-29 15:41:45 -05:00
elif dumpall:
print_anyconsts(0)
2016-08-29 15:41:45 -05:00
write_trace(0, last_check_step+1, "%d" % step)
2015-12-20 02:58:54 -06:00
step += step_size
2015-10-13 10:17:23 -05:00
2020-05-14 12:07:59 -05:00
if gentrace and retstatus == "PASSED":
print_anyconsts(0)
2016-08-29 15:41:45 -05:00
write_trace(0, num_steps, '%')
2016-08-24 15:09:50 -05:00
if check_witness:
retstatus = "FAILED"
2015-10-13 10:17:23 -05:00
smt.write("(exit)")
smt.wait()
print_msg("Status: %s" % retstatus)
sys.exit(0 if retstatus == "PASSED" else 1)