/********************* */ /*! \file smt_engine.cpp ** \verbatim ** Original author: mdeters ** Major contributors: dejan ** Minor contributors (to current version): cconway ** This file is part of the CVC4 prototype. ** Copyright (c) 2009, 2010, 2011 The Analysis of Computer Systems Group (ACSys) ** Courant Institute of Mathematical Sciences ** New York University ** See the file COPYING in the top-level source directory for licensing ** information.\endverbatim ** ** \brief The main entry point into the CVC4 library's SMT interface. ** ** The main entry point into the CVC4 library's SMT interface. **/ #include #include #include #include #include "context/cdlist.h" #include "context/cdset.h" #include "context/context.h" #include "expr/command.h" #include "expr/expr.h" #include "expr/node_builder.h" #include "prop/prop_engine.h" #include "smt/bad_option_exception.h" #include "smt/modal_exception.h" #include "smt/no_such_function_exception.h" #include "smt/smt_engine.h" #include "theory/theory_engine.h" #include "util/configuration.h" #include "util/exception.h" #include "util/options.h" #include "util/output.h" #include "util/hash.h" #include "theory/builtin/theory_builtin.h" #include "theory/booleans/theory_bool.h" #include "theory/uf/theory_uf.h" #include "theory/uf/morgan/theory_uf_morgan.h" #include "theory/uf/tim/theory_uf_tim.h" #include "theory/arith/theory_arith.h" #include "theory/arrays/theory_arrays.h" #include "theory/bv/theory_bv.h" #include "theory/datatypes/theory_datatypes.h" using namespace std; using namespace CVC4; using namespace CVC4::smt; using namespace CVC4::prop; using namespace CVC4::context; namespace CVC4 { namespace smt { /** * Representation of a defined function. We keep these around in * SmtEngine to permit expanding definitions late (and lazily), to * support getValue() over defined functions, to support user output * in terms of defined functions, etc. */ class DefinedFunction { Node d_func; std::vector d_formals; Node d_formula; public: DefinedFunction() {} DefinedFunction(Node func, vector formals, Node formula) : d_func(func), d_formals(formals), d_formula(formula) { } Node getFunction() const { return d_func; } vector getFormals() const { return d_formals; } Node getFormula() const { return d_formula; } };/* class DefinedFunction */ /** * This is an inelegant solution, but for the present, it will work. * The point of this is to separate the public and private portions of * the SmtEngine class, so that smt_engine.h doesn't * #include "expr/node.h", which is a private CVC4 header (and can lead * to linking errors due to the improper inlining of non-visible symbols * into user code!). * * The "real" solution (that which is usually implemented) is to move * ALL the implementation to SmtEnginePrivate and maintain a * heap-allocated instance of it in SmtEngine. SmtEngine (the public * one) becomes an "interface shell" which simply acts as a forwarder * of method calls. */ class SmtEnginePrivate { public: /** * Pre-process a Node. This is expected to be highly-variable, * with a lot of "source-level configurability" to add multiple * passes over the Node. */ static Node preprocess(SmtEngine& smt, TNode n) throw(NoSuchFunctionException, AssertionException); /** * Adds a formula to the current context. */ static void addFormula(SmtEngine& smt, TNode n) throw(NoSuchFunctionException, AssertionException); /** * Expand definitions in n. */ static Node expandDefinitions(SmtEngine& smt, TNode n, hash_map& cache) throw(NoSuchFunctionException, AssertionException); };/* class SmtEnginePrivate */ }/* namespace CVC4::smt */ using namespace CVC4::smt; SmtEngine::SmtEngine(ExprManager* em) throw(AssertionException) : d_context(em->getContext()), d_userContext(new Context()), d_exprManager(em), d_nodeManager(d_exprManager->getNodeManager()), d_definitionExpansionTime("smt::SmtEngine::definitionExpansionTime"), d_nonclausalSimplificationTime("smt::SmtEngine::nonclausalSimplificationTime"), d_staticLearningTime("smt::SmtEngine::staticLearningTime") { NodeManagerScope nms(d_nodeManager); StatisticsRegistry::registerStat(&d_definitionExpansionTime); StatisticsRegistry::registerStat(&d_nonclausalSimplificationTime); StatisticsRegistry::registerStat(&d_staticLearningTime); // We have mutual dependancy here, so we add the prop engine to the theory // engine later (it is non-essential there) d_theoryEngine = new TheoryEngine(d_context); // Add the theories d_theoryEngine->addTheory(); d_theoryEngine->addTheory(); d_theoryEngine->addTheory(); d_theoryEngine->addTheory(); d_theoryEngine->addTheory(); d_theoryEngine->addTheory(); switch(Options::current()->uf_implementation) { case Options::TIM: d_theoryEngine->addTheory(); break; case Options::MORGAN: d_theoryEngine->addTheory(); break; default: Unhandled(Options::current()->uf_implementation); } d_propEngine = new PropEngine(d_theoryEngine, d_context); d_theoryEngine->setPropEngine(d_propEngine); d_definedFunctions = new(true) DefinedFunctionMap(d_userContext); d_assertionList = NULL; if(Options::current()->interactive) { d_assertionList = new(true) AssertionList(d_userContext); } d_assignments = NULL; d_haveAdditions = false; d_queryMade = false; } void SmtEngine::shutdown() { d_propEngine->shutdown(); d_theoryEngine->shutdown(); } SmtEngine::~SmtEngine() { NodeManagerScope nms(d_nodeManager); shutdown(); if(d_assignments != NULL) { d_assignments->deleteSelf(); } if(d_assertionList != NULL) { d_assertionList->deleteSelf(); } d_definedFunctions->deleteSelf(); StatisticsRegistry::unregisterStat(&d_definitionExpansionTime); StatisticsRegistry::unregisterStat(&d_nonclausalSimplificationTime); StatisticsRegistry::unregisterStat(&d_staticLearningTime); delete d_userContext; delete d_theoryEngine; delete d_propEngine; } void SmtEngine::setLogic(const std::string& s) throw(ModalException) { if(d_logic != "") { throw ModalException("logic already set"); } d_logic = s; } void SmtEngine::setInfo(const std::string& key, const SExpr& value) throw(BadOptionException, ModalException) { Debug("smt") << "SMT setInfo(" << key << ", " << value << ")" << endl; if(key == ":name" || key == ":source" || key == ":category" || key == ":difficulty" || key == ":smt-lib-version" || key == ":notes") { // ignore these return; } else if(key == ":status") { string s; if(value.isAtom()) { s = value.getValue(); } if(s != "sat" && s != "unsat" && s != "unknown") { throw BadOptionException("argument to (set-info :status ..) must be " "`sat' or `unsat' or `unknown'"); } d_status = Result(s); return; } throw BadOptionException(); } SExpr SmtEngine::getInfo(const std::string& key) const throw(BadOptionException) { Debug("smt") << "SMT getInfo(" << key << ")" << endl; if(key == ":all-statistics") { vector stats; for(StatisticsRegistry::const_iterator i = StatisticsRegistry::begin(); i != StatisticsRegistry::end(); ++i) { vector v; v.push_back((*i)->getName()); v.push_back((*i)->getValue()); stats.push_back(v); } return stats; } else if(key == ":error-behavior") { return SExpr("immediate-exit"); } else if(key == ":name") { return Configuration::getName(); } else if(key == ":version") { return Configuration::getVersionString(); } else if(key == ":authors") { return Configuration::about(); } else if(key == ":status") { return d_status.asSatisfiabilityResult().toString(); } else if(key == ":reason-unknown") { if(d_status.isUnknown()) { stringstream ss; ss << d_status.whyUnknown(); return ss.str(); } else { throw ModalException("Can't get-info :reason-unknown when the " "last result wasn't unknown!"); } } else { throw BadOptionException(); } } void SmtEngine::setOption(const std::string& key, const SExpr& value) throw(BadOptionException, ModalException) { Debug("smt") << "SMT setOption(" << key << ", " << value << ")" << endl; if(key == ":print-success") { throw BadOptionException(); } else if(key == ":expand-definitions") { throw BadOptionException(); } else if(key == ":interactive-mode") { throw BadOptionException(); } else if(key == ":regular-output-channel") { throw BadOptionException(); } else if(key == ":diagnostic-output-channel") { throw BadOptionException(); } else if(key == ":random-seed") { throw BadOptionException(); } else if(key == ":verbosity") { throw BadOptionException(); } else { // The following options can only be set at the beginning; we throw // a ModalException if someone tries. if(d_logic != "") { throw ModalException("logic already set; cannot set options"); } if(key == ":produce-proofs") { throw BadOptionException(); } else if(key == ":produce-unsat-cores") { throw BadOptionException(); } else if(key == ":produce-models") { throw BadOptionException(); } else if(key == ":produce-assignments") { throw BadOptionException(); } else { throw BadOptionException(); } } } SExpr SmtEngine::getOption(const std::string& key) const throw(BadOptionException) { Debug("smt") << "SMT getOption(" << key << ")" << endl; if(key == ":print-success") { return SExpr("true"); } else if(key == ":expand-definitions") { throw BadOptionException(); } else if(key == ":interactive-mode") { throw BadOptionException(); } else if(key == ":produce-proofs") { throw BadOptionException(); } else if(key == ":produce-unsat-cores") { throw BadOptionException(); } else if(key == ":produce-models") { throw BadOptionException(); } else if(key == ":produce-assignments") { throw BadOptionException(); } else if(key == ":regular-output-channel") { return SExpr("stdout"); } else if(key == ":diagnostic-output-channel") { return SExpr("stderr"); } else if(key == ":random-seed") { throw BadOptionException(); } else if(key == ":verbosity") { throw BadOptionException(); } else { throw BadOptionException(); } } void SmtEngine::defineFunction(Expr func, const std::vector& formals, Expr formula) { Debug("smt") << "SMT defineFunction(" << func << ")" << endl; NodeManagerScope nms(d_nodeManager); Type formulaType = formula.getType(Options::current()->typeChecking);// type check body Type funcType = func.getType(); Type rangeType = funcType.isFunction() ? FunctionType(funcType).getRangeType() : funcType; if(formulaType != rangeType) { stringstream ss; ss << Expr::setlanguage(language::toOutputLanguage(Options::current()->inputLanguage)) << "Defined function's declared type does not match that of body\n" << "The function : " << func << "\n" << "Its range type: " << rangeType << "\n" << "The body : " << formula << "\n" << "Body type : " << formulaType; throw TypeCheckingException(func, ss.str()); } TNode funcNode = func.getTNode(); vector formalsNodes; for(vector::const_iterator i = formals.begin(), iend = formals.end(); i != iend; ++i) { formalsNodes.push_back((*i).getNode()); } TNode formulaNode = formula.getTNode(); DefinedFunction def(funcNode, formalsNodes, formulaNode); // Permit (check-sat) (define-fun ...) (get-value ...) sequences. // Otherwise, (check-sat) (get-value ((! foo :named bar))) breaks // d_haveAdditions = true; d_definedFunctions->insert(funcNode, def); } Node SmtEnginePrivate::expandDefinitions(SmtEngine& smt, TNode n, hash_map& cache) throw(NoSuchFunctionException, AssertionException) { if(n.getKind() != kind::APPLY && n.getNumChildren() == 0) { // don't bother putting in the cache return n; } // maybe it's in the cache hash_map::iterator cacheHit = cache.find(n); if(cacheHit != cache.end()) { return (*cacheHit).second; } // otherwise expand it if(n.getKind() == kind::APPLY) { TNode func = n.getOperator(); SmtEngine::DefinedFunctionMap::const_iterator i = smt.d_definedFunctions->find(func); DefinedFunction def = (*i).second; vector formals = def.getFormals(); if(Debug.isOn("expand")) { Debug("expand") << "found: " << n << endl; Debug("expand") << " func: " << func << endl; string name = func.getAttribute(expr::VarNameAttr()); Debug("expand") << " : \"" << name << "\"" << endl; if(i == smt.d_definedFunctions->end()) { throw NoSuchFunctionException(Expr(smt.d_exprManager, new Node(func))); } Debug("expand") << " defn: " << def.getFunction() << endl << " ["; if(formals.size() > 0) { copy( formals.begin(), formals.end() - 1, ostream_iterator(Debug("expand"), ", ") ); Debug("expand") << formals.back(); } Debug("expand") << "]" << endl << " " << def.getFunction().getType() << endl << " " << def.getFormula() << endl; } TNode fm = def.getFormula(); Node instance = fm.substitute(formals.begin(), formals.end(), n.begin(), n.end()); Debug("expand") << "made : " << instance << endl; Node expanded = expandDefinitions(smt, instance, cache); cache[n] = expanded; return expanded; } else { Debug("expand") << "cons : " << n << endl; NodeBuilder<> nb(n.getKind()); if(n.getMetaKind() == kind::metakind::PARAMETERIZED) { Debug("expand") << "op : " << n.getOperator() << endl; nb << n.getOperator(); } for(TNode::iterator i = n.begin(), iend = n.end(); i != iend; ++i) { Node expanded = expandDefinitions(smt, *i, cache); Debug("expand") << "exchld: " << expanded << endl; nb << expanded; } Node node = nb; cache[n] = node; return node; } } Node SmtEnginePrivate::preprocess(SmtEngine& smt, TNode in) throw(NoSuchFunctionException, AssertionException) { try { Node n; if(!Options::current()->lazyDefinitionExpansion) { TimerStat::CodeTimer codeTimer(smt.d_definitionExpansionTime); //Chat() << "Expanding definitions: " << in << endl; Debug("expand") << "have: " << n << endl; hash_map cache; n = expandDefinitions(smt, in, cache); Debug("expand") << "made: " << n << endl; } else { n = in; } // For now, don't re-statically-learn from learned facts; this could // be useful though (e.g., theory T1 could learn something further // from something learned previously by T2). //Chat() << "Performing static learning: " << n << endl; TimerStat::CodeTimer codeTimer(smt.d_staticLearningTime); NodeBuilder<> learned(kind::AND); learned << n; smt.d_theoryEngine->staticLearning(n, learned); if(learned.getNumChildren() == 1) { learned.clear(); } else { n = learned; } return smt.d_theoryEngine->preprocess(n); } catch(TypeCheckingExceptionPrivate& tcep) { // Calls to this function should have already weeded out any // typechecking exceptions via (e.g.) ensureBoolean(). But a // theory could still create a new expression that isn't // well-typed, and we don't want the C++ runtime to abort our // process without any error notice. stringstream ss; ss << Expr::setlanguage(language::toOutputLanguage(Options::current()->inputLanguage)) << "A bad expression was produced. Original exception follows:\n" << tcep; InternalError(ss.str().c_str()); } } Result SmtEngine::check() { Debug("smt") << "SMT check()" << endl; return d_propEngine->checkSat(); } Result SmtEngine::quickCheck() { Debug("smt") << "SMT quickCheck()" << endl; return Result(Result::VALIDITY_UNKNOWN, Result::REQUIRES_FULL_CHECK); } void SmtEnginePrivate::addFormula(SmtEngine& smt, TNode n) throw(NoSuchFunctionException, AssertionException) { try { Debug("smt") << "push_back assertion " << n << endl; smt.d_haveAdditions = true; Node node = SmtEnginePrivate::preprocess(smt, n); smt.d_propEngine->assertFormula(node); } catch(TypeCheckingExceptionPrivate& tcep) { // Calls to this function should have already weeded out any // typechecking exceptions via (e.g.) ensureBoolean(). But a // theory could still create a new expression that isn't // well-typed, and we don't want the C++ runtime to abort our // process without any error notice. stringstream ss; ss << Expr::setlanguage(language::toOutputLanguage(Options::current()->inputLanguage)) << "A bad expression was produced internally. Original exception follows:\n" << tcep; InternalError(ss.str().c_str()); } } void SmtEngine::ensureBoolean(const BoolExpr& e) { Type type = e.getType(Options::current()->typeChecking); Type boolType = d_exprManager->booleanType(); if(type != boolType) { stringstream ss; ss << Expr::setlanguage(language::toOutputLanguage(Options::current()->inputLanguage)) << "Expected " << boolType << "\n" << "The assertion : " << e << "\n" << "Its type : " << type; throw TypeCheckingException(e, ss.str()); } } Result SmtEngine::checkSat(const BoolExpr& e) { Assert(e.getExprManager() == d_exprManager); NodeManagerScope nms(d_nodeManager); Debug("smt") << "SMT checkSat(" << e << ")" << endl; if(d_queryMade && !Options::current()->incrementalSolving) { throw ModalException("Cannot make multiple queries unless " "incremental solving is enabled " "(try --incremental)"); } d_queryMade = true; ensureBoolean(e);// ensure expr is type-checked at this point internalPush(); SmtEnginePrivate::addFormula(*this, e.getNode()); Result r = check().asSatisfiabilityResult(); internalPop(); d_status = r; d_haveAdditions = false; Debug("smt") << "SMT checkSat(" << e << ") ==> " << r << endl; return r; } Result SmtEngine::query(const BoolExpr& e) { Assert(e.getExprManager() == d_exprManager); NodeManagerScope nms(d_nodeManager); Debug("smt") << "SMT query(" << e << ")" << endl; if(d_queryMade && !Options::current()->incrementalSolving) { throw ModalException("Cannot make multiple queries unless " "incremental solving is enabled " "(try --incremental)"); } d_queryMade = true; ensureBoolean(e);// ensure expr is type-checked at this point internalPush(); smt::SmtEnginePrivate::addFormula(*this, e.getNode().notNode()); Result r = check().asValidityResult(); internalPop(); d_status = r; d_haveAdditions = false; Debug("smt") << "SMT query(" << e << ") ==> " << r << endl; return r; } Result SmtEngine::assertFormula(const BoolExpr& e) { Assert(e.getExprManager() == d_exprManager); NodeManagerScope nms(d_nodeManager); Debug("smt") << "SMT assertFormula(" << e << ")" << endl; ensureBoolean(e);// type check node if(d_assertionList != NULL) { d_assertionList->push_back(e); } smt::SmtEnginePrivate::addFormula(*this, e.getNode()); return quickCheck().asValidityResult(); } Expr SmtEngine::simplify(const Expr& e) { Assert(e.getExprManager() == d_exprManager); NodeManagerScope nms(d_nodeManager); if( Options::current()->typeChecking ) { e.getType(true);// ensure expr is type-checked at this point } Debug("smt") << "SMT simplify(" << e << ")" << endl; // probably want to do an addFormula(), to get preprocessing, static // learning, definition expansion... Unimplemented(); } Expr SmtEngine::getValue(const Expr& e) throw(ModalException, AssertionException) { Assert(e.getExprManager() == d_exprManager); NodeManagerScope nms(d_nodeManager); Type type = e.getType(Options::current()->typeChecking);// ensure expr is type-checked at this point Debug("smt") << "SMT getValue(" << e << ")" << endl; if(!Options::current()->produceModels) { const char* msg = "Cannot get value when produce-models options is off."; throw ModalException(msg); } if(d_status.isNull() || d_status.asSatisfiabilityResult() != Result::SAT || d_haveAdditions) { const char* msg = "Cannot get value unless immediately proceded by SAT/INVALID response."; throw ModalException(msg); } if(type.isFunction() || type.isPredicate() || type.isKind() || type.isSortConstructor()) { const char* msg = "Cannot get value of a function, predicate, or sort."; throw ModalException(msg); } Node eNode = e.getNode(); Node n = smt::SmtEnginePrivate::preprocess(*this, eNode); Debug("smt") << "--- getting value of " << n << endl; Node resultNode = d_theoryEngine->getValue(n); // type-check the result we got Assert(resultNode.isNull() || resultNode.getType() == eNode.getType()); return Expr(d_exprManager, new Node(resultNode)); } bool SmtEngine::addToAssignment(const Expr& e) throw(AssertionException) { NodeManagerScope nms(d_nodeManager); Type type = e.getType(Options::current()->typeChecking); // must be Boolean CheckArgument( type.isBoolean(), e, "expected Boolean-typed variable or function application " "in addToAssignment()" ); Node n = e.getNode(); // must be an APPLY of a zero-ary defined function, or a variable CheckArgument( ( ( n.getKind() == kind::APPLY && ( d_definedFunctions->find(n.getOperator()) != d_definedFunctions->end() ) && n.getNumChildren() == 0 ) || n.getMetaKind() == kind::metakind::VARIABLE ), e, "expected variable or defined-function application " "in addToAssignment(),\ngot %s", e.toString().c_str() ); if(!Options::current()->produceAssignments) { return false; } if(d_assignments == NULL) { d_assignments = new(true) AssignmentSet(d_context); } d_assignments->insert(n); return true; } SExpr SmtEngine::getAssignment() throw(ModalException, AssertionException) { Debug("smt") << "SMT getAssignment()" << endl; if(!Options::current()->produceAssignments) { const char* msg = "Cannot get the current assignment when " "produce-assignments option is off."; throw ModalException(msg); } if(d_status.isNull() || d_status.asSatisfiabilityResult() != Result::SAT || d_haveAdditions) { const char* msg = "Cannot get value unless immediately proceded by SAT/INVALID response."; throw ModalException(msg); } if(d_assignments == NULL) { return SExpr(); } NodeManagerScope nms(d_nodeManager); vector sexprs; TypeNode boolType = d_nodeManager->booleanType(); for(AssignmentSet::const_iterator i = d_assignments->begin(), iend = d_assignments->end(); i != iend; ++i) { Assert((*i).getType() == boolType); Node n = smt::SmtEnginePrivate::preprocess(*this, *i); Debug("smt") << "--- getting value of " << n << endl; Node resultNode = d_theoryEngine->getValue(n); // type-check the result we got Assert(resultNode.isNull() || resultNode.getType() == boolType); vector v; if((*i).getKind() == kind::APPLY) { Assert((*i).getNumChildren() == 0); v.push_back((*i).getOperator().toString()); } else { Assert((*i).getMetaKind() == kind::metakind::VARIABLE); v.push_back((*i).toString()); } v.push_back(resultNode.toString()); sexprs.push_back(v); } return SExpr(sexprs); } vector SmtEngine::getAssertions() throw(ModalException, AssertionException) { NodeManagerScope nms(d_nodeManager); Debug("smt") << "SMT getAssertions()" << endl; if(!Options::current()->interactive) { const char* msg = "Cannot query the current assertion list when not in interactive mode."; throw ModalException(msg); } Assert(d_assertionList != NULL); return vector(d_assertionList->begin(), d_assertionList->end()); } void SmtEngine::push() { NodeManagerScope nms(d_nodeManager); Debug("smt") << "SMT push()" << endl; if(!Options::current()->incrementalSolving) { throw ModalException("Cannot push when not solving incrementally (use --incremental)"); } d_userLevels.push_back(d_userContext->getLevel()); internalPush(); Debug("userpushpop") << "SmtEngine: pushed to level " << d_userContext->getLevel() << endl; } void SmtEngine::pop() { NodeManagerScope nms(d_nodeManager); Debug("smt") << "SMT pop()" << endl; if(!Options::current()->incrementalSolving) { throw ModalException("Cannot pop when not solving incrementally (use --incremental)"); } AlwaysAssert(d_userLevels.size() > 0 && d_userLevels.back() < d_userContext->getLevel()); while (d_userLevels.back() < d_userContext->getLevel()) { internalPop(); } d_userLevels.pop_back(); Debug("userpushpop") << "SmtEngine: popped to level " << d_userContext->getLevel() << endl; // FIXME: should we reset d_status here? // SMT-LIBv2 spec seems to imply no, but it would make sense to.. } void SmtEngine::internalPop() { Debug("smt") << "internalPop()" << endl; d_propEngine->pop(); d_userContext->pop(); } void SmtEngine::internalPush() { Debug("smt") << "internalPush()" << endl; d_userContext->push(); d_propEngine->push(); } StatisticsRegistry* SmtEngine::getStatisticsRegistry() const { return d_exprManager->d_nodeManager->getStatisticsRegistry(); } }/* CVC4 namespace */