Branch data     Line data    Source code

       1                 :            : /******************************************************************************
       2                 :            :  * Top contributors (to current version):
       3                 :            :  *   Andrew Reynolds, Aina Niemetz, Gereon Kremer
       4                 :            :  *
       5                 :            :  * This file is part of the cvc5 project.
       6                 :            :  *
       7                 :            :  * Copyright (c) 2009-2025 by the authors listed in the file AUTHORS
       8                 :            :  * in the top-level source directory and their institutional affiliations.
       9                 :            :  * All rights reserved.  See the file COPYING in the top-level source
      10                 :            :  * directory for licensing information.
      11                 :            :  * ****************************************************************************
      12                 :            :  *
      13                 :            :  * The solver for SMT queries in an SolverEngine.
      14                 :            :  */
      15                 :            : 
      16                 :            : #include "smt/smt_solver.h"
      17                 :            : 
      18                 :            : #include "options/arrays_options.h"
      19                 :            : #include "options/base_options.h"
      20                 :            : #include "options/main_options.h"
      21                 :            : #include "options/smt_options.h"
      22                 :            : #include "preprocessing/assertion_pipeline.h"
      23                 :            : #include "prop/prop_engine.h"
      24                 :            : #include "smt/assertions.h"
      25                 :            : #include "smt/env.h"
      26                 :            : #include "smt/logic_exception.h"
      27                 :            : #include "smt/preprocessor.h"
      28                 :            : #include "smt/proof_manager.h"
      29                 :            : #include "smt/solver_engine_stats.h"
      30                 :            : #include "theory/logic_info.h"
      31                 :            : #include "theory/theory_engine.h"
      32                 :            : #include "theory/theory_traits.h"
      33                 :            : 
      34                 :            : using namespace std;
      35                 :            : 
      36                 :            : namespace cvc5::internal {
      37                 :            : namespace smt {
      38                 :            : 
      39                 :      72393 : SmtSolver::SmtSolver(Env& env, SolverEngineStatistics& stats)
      40                 :            :     : EnvObj(env),
      41                 :            :       d_pp(env, stats),
      42                 :            :       d_asserts(env),
      43                 :            :       d_stats(stats),
      44                 :            :       d_theoryEngine(nullptr),
      45                 :            :       d_propEngine(nullptr),
      46                 :     144786 :       d_ppAssertions(userContext()),
      47                 :      72393 :       d_ppSkolemMap(userContext())
      48                 :            : {
      49                 :      72393 : }
      50                 :            : 
      51                 :     135494 : SmtSolver::~SmtSolver() {}
      52                 :            : 
      53                 :      51384 : void SmtSolver::finishInit()
      54                 :            : {
      55                 :            :   // We have mutual dependency here, so we add the prop engine to the theory
      56                 :            :   // engine later (it is non-essential there)
      57                 :      51384 :   d_theoryEngine.reset(new TheoryEngine(d_env));
      58                 :            : 
      59                 :            :   // Add the theories
      60         [ +  + ]:     770760 :   for (theory::TheoryId id = theory::THEORY_FIRST; id < theory::THEORY_LAST;
      61                 :     719376 :        ++id)
      62                 :            :   {
      63                 :     719376 :     theory::TheoryConstructor::addTheory(d_theoryEngine.get(), id);
      64                 :            :   }
      65                 :            :   // Add the proof checkers for each theory
      66                 :      51384 :   ProofNodeManager* pnm = d_env.getProofNodeManager();
      67         [ +  + ]:      51384 :   if (pnm)
      68                 :            :   {
      69                 :            :     // reset the rule checkers
      70                 :      20439 :     pnm->getChecker()->reset();
      71                 :            :     // add rule checkers from the theory engine
      72                 :      20439 :     d_theoryEngine->initializeProofChecker(pnm->getChecker());
      73                 :            :   }
      74         [ +  - ]:      51384 :   Trace("smt-debug") << "Making prop engine..." << std::endl;
      75                 :            :   /* force destruction of referenced PropEngine to enforce that statistics
      76                 :            :    * are unregistered by the obsolete PropEngine object before registered
      77                 :            :    * again by the new PropEngine object */
      78                 :      51384 :   d_propEngine.reset(nullptr);
      79                 :      51384 :   d_propEngine.reset(new prop::PropEngine(d_env, d_theoryEngine.get()));
      80                 :            : 
      81         [ +  - ]:      51384 :   Trace("smt-debug") << "Setting up theory engine..." << std::endl;
      82                 :      51384 :   d_theoryEngine->setPropEngine(getPropEngine());
      83         [ +  - ]:      51384 :   Trace("smt-debug") << "Finishing init for theory engine..." << std::endl;
      84                 :      51384 :   d_theoryEngine->finishInit();
      85                 :      51384 :   d_propEngine->finishInit();
      86                 :      51384 :   finishInitPreprocessor();
      87                 :            : 
      88         [ -  + ]:      51384 :   if (options().proof.proofLog)
      89                 :            :   {
      90                 :          0 :     smt::PfManager* pm = d_env.getProofManager();
      91         [ -  - ]:          0 :     if (pm != nullptr)
      92                 :            :     {
      93                 :            :       // Logs proofs on the base output stream of the solver
      94                 :          0 :       pm->startProofLogging(options().base.out, d_asserts);
      95                 :            :     }
      96                 :            :   }
      97                 :            : 
      98                 :            :   // Determine any illegal kinds that are dependent on options that need to be
      99                 :            :   // guarded here. Note that nearly all illegal kinds should be properly guarded
     100                 :            :   // by either the theory engine, theory solvers, or by theory rewriters. We
     101                 :            :   // only require special handling for rare cases, including array constants,
     102                 :            :   // where array constants *must* be rewritten by the rewriter for the purposes
     103                 :            :   // of model verification, but we do not want array constants to appear in
     104                 :            :   // assertions unless --arrays-exp is enabled.
     105                 :            : 
     106                 :            :   // Array constants are not supported unless arraysExp is enabled
     107                 :      51384 :   if (logicInfo().isTheoryEnabled(internal::theory::THEORY_ARRAYS)
     108 [ +  + ][ +  + ]:      51384 :       && !options().arrays.arraysExp)
                 [ +  + ]
     109                 :            :   {
     110                 :      32530 :     d_illegalKinds.insert(Kind::STORE_ALL);
     111                 :            :   }
     112                 :      51384 : }
     113                 :            : 
     114                 :        597 : void SmtSolver::resetAssertions()
     115                 :            : {
     116                 :            :   /* Create new PropEngine.
     117                 :            :    * First force destruction of referenced PropEngine to enforce that
     118                 :            :    * statistics are unregistered by the obsolete PropEngine object before
     119                 :            :    * registered again by the new PropEngine object */
     120                 :        597 :   d_propEngine.reset(nullptr);
     121                 :        597 :   d_propEngine.reset(new prop::PropEngine(d_env, d_theoryEngine.get()));
     122                 :        597 :   d_theoryEngine->setPropEngine(getPropEngine());
     123                 :            :   // Notice that we do not reset TheoryEngine, nor does it require calling
     124                 :            :   // finishInit again. In particular, TheoryEngine::finishInit does not
     125                 :            :   // depend on knowing the associated PropEngine.
     126                 :        597 :   d_propEngine->finishInit();
     127                 :            :   // must reset the preprocessor as well
     128                 :        597 :   finishInitPreprocessor();
     129                 :        597 : }
     130                 :            : 
     131                 :     686441 : void SmtSolver::interrupt()
     132                 :            : {
     133         [ +  - ]:     686441 :   if (d_propEngine != nullptr)
     134                 :            :   {
     135                 :     686441 :     d_propEngine->interrupt();
     136                 :            :   }
     137         [ +  - ]:     686441 :   if (d_theoryEngine != nullptr)
     138                 :            :   {
     139                 :     686441 :     d_theoryEngine->interrupt();
     140                 :            :   }
     141                 :     686441 : }
     142                 :            : 
     143                 :      51383 : Result SmtSolver::checkSatInternal()
     144                 :            : {
     145                 :            :   // call the prop engine to check sat
     146                 :      51383 :   return d_propEngine->checkSat();
     147                 :            : }
     148                 :            : 
     149                 :      68223 : void SmtSolver::preprocess(preprocessing::AssertionPipeline& ap)
     150                 :            : {
     151                 :     136446 :   TimerStat::CodeTimer paTimer(d_stats.d_processAssertionsTime);
     152                 :      68223 :   d_env.getResourceManager()->spendResource(Resource::PreprocessStep);
     153                 :            : 
     154                 :            :   // check illegal kinds here
     155         [ +  + ]:      68223 :   if (!d_illegalKinds.empty())
     156                 :            :   {
     157                 :      37402 :     const std::vector<Node>& assertions = ap.ref();
     158                 :      74804 :     std::unordered_set<TNode> visited;
     159         [ +  + ]:     185733 :     for (const Node& a : assertions)
     160                 :            :     {
     161                 :     148331 :       Kind k = expr::hasSubtermKinds(d_illegalKinds, a, visited);
     162         [ -  + ]:     148331 :       if (k != Kind::UNDEFINED_KIND)
     163                 :            :       {
     164                 :          0 :         std::stringstream ss;
     165                 :          0 :         ss << "ERROR: cannot handle assertion with term of kind " << k
     166                 :          0 :            << " in this configuration";
     167         [ -  - ]:          0 :         if (k == Kind::STORE_ALL)
     168                 :            :         {
     169                 :          0 :           ss << ", unless --arrays-exp is enabled";
     170                 :            :         }
     171                 :          0 :         throw LogicException(ss.str());
     172                 :            :       }
     173                 :            :     }
     174                 :            :   }
     175                 :            : 
     176                 :            :   // process the assertions with the preprocessor
     177                 :      68223 :   d_pp.process(ap);
     178                 :            : 
     179                 :            :   // end: INVARIANT to maintain: no reordering of assertions or
     180                 :            :   // introducing new ones
     181                 :      68199 : }
     182                 :            : 
     183                 :      68199 : void SmtSolver::assertToInternal(preprocessing::AssertionPipeline& ap)
     184                 :            : {
     185                 :            :   // carry information about soundness to the theory engine we are sending to
     186         [ +  + ]:      68199 :   if (ap.isRefutationUnsound())
     187                 :            :   {
     188                 :         44 :     d_theoryEngine->setRefutationUnsound(theory::IncompleteId::PREPROCESSING);
     189                 :            :   }
     190         [ -  + ]:      68199 :   if (ap.isModelUnsound())
     191                 :            :   {
     192                 :          0 :     d_theoryEngine->setModelUnsound(theory::IncompleteId::PREPROCESSING);
     193                 :            :   }
     194                 :            :   // get the assertions
     195                 :      68199 :   const std::vector<Node>& assertions = ap.ref();
     196                 :      68199 :   preprocessing::IteSkolemMap& ism = ap.getIteSkolemMap();
     197                 :            :   // assert to prop engine, which will convert to CNF
     198                 :      68199 :   d_env.verbose(2) << "converting to CNF..." << endl;
     199                 :      68199 :   d_propEngine->assertInputFormulas(assertions, ism);
     200                 :            : 
     201                 :            :   // It is important to distinguish the input assertions from the skolem
     202                 :            :   // definitions, as the decision justification heuristic treates the latter
     203                 :            :   // specially. Note that we don't pass the preprocess learned literals
     204                 :            :   // d_pp.getLearnedLiterals() here, since they may not exactly correspond
     205                 :            :   // to the actual preprocessed learned literals, as the input may have
     206                 :            :   // undergone further preprocessing.
     207                 :            :   // if we can deep restart, we always remember the preprocessed formulas,
     208                 :            :   // which are the basis for the next check-sat.
     209         [ +  + ]:      68183 :   if (trackPreprocessedAssertions())
     210                 :            :   {
     211                 :            :     // incompatible with global negation
     212 [ -  + ][ -  + ]:      30113 :     Assert(!options().quantifiers.globalNegate);
                 [ -  - ]
     213                 :      30113 :     theory::SubstitutionMap& sm = d_env.getTopLevelSubstitutions().get();
     214                 :      30113 :     size_t startIndex = d_ppAssertions.size();
     215                 :            :     // remember the assertions and Skolem mapping
     216         [ +  + ]:     395655 :     for (const Node& a : assertions)
     217                 :            :     {
     218                 :     365542 :       d_ppAssertions.push_back(a);
     219                 :            :     }
     220         [ +  + ]:      49202 :     for (const std::pair<const size_t, Node>& k : ism)
     221                 :            :     {
     222                 :            :       // optimization: skip skolems that were eliminated in preprocessing
     223         [ +  + ]:      19089 :       if (sm.hasSubstitution(k.second))
     224                 :            :       {
     225                 :          2 :         continue;
     226                 :            :       }
     227                 :      19087 :       size_t newIndex = k.first + startIndex;
     228                 :      19087 :       d_ppSkolemMap[newIndex] = k.second;
     229                 :            :     }
     230                 :            :   }
     231                 :      68183 : }
     232                 :            : 
     233                 :        602 : const context::CDList<Node>& SmtSolver::getPreprocessedAssertions() const
     234                 :            : {
     235                 :        602 :   return d_ppAssertions;
     236                 :            : }
     237                 :            : 
     238                 :        588 : const context::CDHashMap<size_t, Node>& SmtSolver::getPreprocessedSkolemMap()
     239                 :            :     const
     240                 :            : {
     241                 :        588 :   return d_ppSkolemMap;
     242                 :            : }
     243                 :            : 
     244                 :      68183 : bool SmtSolver::trackPreprocessedAssertions() const
     245                 :            : {
     246                 :      68183 :   return options().smt.deepRestartMode != options::DeepRestartMode::NONE
     247 [ +  + ][ +  + ]:      68183 :          || options().smt.produceProofs;
     248                 :            : }
     249                 :            : 
     250                 :      26728 : TheoryEngine* SmtSolver::getTheoryEngine() { return d_theoryEngine.get(); }
     251                 :            : 
     252                 :     129673 : prop::PropEngine* SmtSolver::getPropEngine() { return d_propEngine.get(); }
     253                 :            : 
     254                 :       4385 : theory::QuantifiersEngine* SmtSolver::getQuantifiersEngine()
     255                 :            : {
     256 [ -  + ][ -  + ]:       4385 :   Assert(d_theoryEngine != nullptr);
                 [ -  - ]
     257                 :       4385 :   return d_theoryEngine->getQuantifiersEngine();
     258                 :            : }
     259                 :            : 
     260                 :     145018 : Preprocessor* SmtSolver::getPreprocessor() { return &d_pp; }
     261                 :            : 
     262                 :     439074 : Assertions& SmtSolver::getAssertions() { return d_asserts; }
     263                 :            : 
     264                 :       9062 : void SmtSolver::pushPropContext()
     265                 :            : {
     266                 :      18124 :   TimerStat::CodeTimer pushPopTimer(d_stats.d_pushPopTime);
     267 [ -  + ][ -  + ]:       9062 :   Assert(d_propEngine != nullptr);
                 [ -  - ]
     268                 :       9062 :   d_propEngine->push();
     269                 :       9062 : }
     270                 :            : 
     271                 :       9057 : void SmtSolver::popPropContext()
     272                 :            : {
     273                 :      18114 :   TimerStat::CodeTimer pushPopTimer(d_stats.d_pushPopTime);
     274 [ -  + ][ -  + ]:       9057 :   Assert(d_propEngine != nullptr);
                 [ -  - ]
     275                 :       9057 :   d_propEngine->pop();
     276                 :       9057 : }
     277                 :            : 
     278                 :      50542 : void SmtSolver::resetTrail()
     279                 :            : {
     280 [ -  + ][ -  + ]:      50542 :   Assert(d_propEngine != nullptr);
                 [ -  - ]
     281                 :      50542 :   d_propEngine->resetTrail();
     282                 :      50542 : }
     283                 :            : 
     284                 :      51981 : void SmtSolver::finishInitPreprocessor()
     285                 :            : {
     286                 :            :   // determine if we are assigning a preprocess proof generator here
     287                 :      51981 :   smt::PfManager* pm = d_env.getProofManager();
     288                 :      51981 :   smt::PreprocessProofGenerator* pppg = nullptr;
     289         [ +  + ]:      51981 :   if (pm != nullptr)
     290                 :            :   {
     291                 :      20656 :     pppg = pm->getPreprocessProofGenerator();
     292                 :            :   }
     293                 :      51981 :   d_pp.finishInit(d_theoryEngine.get(), d_propEngine.get(), pppg);
     294                 :      51981 : }
     295                 :            : 
     296                 :            : }  // namespace smt
     297                 :            : }  // namespace cvc5::internal