Branch data     Line data    Source code

       1                 :            : /******************************************************************************
       2                 :            :  * Top contributors (to current version):
       3                 :            :  *   Andrew Reynolds, Gereon Kremer, Morgan Deters
       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                 :            :  * An additional layer between commands and invoking them.
      14                 :            :  */
      15                 :            : 
      16                 :            : #include "main/command_executor.h"
      17                 :            : 
      18                 :            : #ifndef __WIN32__
      19                 :            : #  include <sys/resource.h>
      20                 :            : #endif /* ! __WIN32__ */
      21                 :            : 
      22                 :            : #include <cvc5/cvc5_parser.h>
      23                 :            : 
      24                 :            : #include <iomanip>
      25                 :            : #include <iostream>
      26                 :            : #include <memory>
      27                 :            : #include <string>
      28                 :            : #include <vector>
      29                 :            : 
      30                 :            : #include "base/output.h"
      31                 :            : #include "main/main.h"
      32                 :            : #include "parser/commands.h"
      33                 :            : #include "smt/solver_engine.h"
      34                 :            : 
      35                 :            : using namespace cvc5::parser;
      36                 :            : 
      37                 :            : namespace cvc5::main {
      38                 :            : 
      39                 :            : // Function to cancel any (externally-imposed) limit on CPU time.
      40                 :            : // This is used for competitions while a solution (proof or model)
      41                 :            : // is being dumped (so that we don't give "sat" or "unsat" then get
      42                 :            : // interrupted partway through outputting a proof!).
      43                 :          0 : void setNoLimitCPU() {
      44                 :            :   // Windows doesn't have these things, just ignore
      45                 :            : #ifndef __WIN32__
      46                 :            :   struct rlimit rlc;
      47                 :          0 :   int st = getrlimit(RLIMIT_CPU, &rlc);
      48         [ -  - ]:          0 :   if(st == 0) {
      49                 :          0 :     rlc.rlim_cur = rlc.rlim_max;
      50                 :          0 :     setrlimit(RLIMIT_CPU, &rlc);
      51                 :            :   }
      52                 :            : #endif /* ! __WIN32__ */
      53                 :          0 : }
      54                 :            : 
      55                 :      28320 : CommandExecutor::CommandExecutor(std::unique_ptr<cvc5::Solver>& solver)
      56                 :            :     : d_solver(solver),
      57                 :      28320 :       d_symman(new SymbolManager(d_solver->getTermManager())),
      58                 :            :       d_result(),
      59                 :      56640 :       d_parseOnly(false)
      60                 :            : {
      61                 :      28320 : }
      62                 :      56640 : CommandExecutor::~CommandExecutor()
      63                 :            : {
      64                 :      56640 : }
      65                 :            : 
      66                 :      24353 : void CommandExecutor::storeOptionsAsOriginal()
      67                 :            : {
      68                 :      24353 :   d_solver->d_originalOptions->copyValues(d_solver->d_slv->getOptions());
      69                 :            :   // cache the value of parse-only, which is set by the command line only
      70                 :            :   // and thus will not change in a run.
      71                 :      24353 :   d_parseOnly = d_solver->getOptionInfo("parse-only").boolValue();
      72                 :      24353 : }
      73                 :            : 
      74                 :      92197 : void CommandExecutor::setOptionInternal(const std::string& key,
      75                 :            :                                         const std::string& value)
      76                 :            : {
      77                 :            :   // set option, marked not from user.
      78                 :      92197 :   d_solver->d_slv->setOption(key, value, false);
      79                 :      92197 : }
      80                 :            : 
      81                 :      24305 : void CommandExecutor::printStatistics(std::ostream& out) const
      82                 :            : {
      83         [ -  + ]:      24305 :   if (d_solver->getOptionInfo("stats").boolValue())
      84                 :            :   {
      85                 :            :     {
      86                 :          0 :       const auto& stats = d_solver->getStatistics();
      87                 :            :       auto it =
      88                 :          0 :           stats.begin(d_solver->getOptionInfo("stats-internal").boolValue(),
      89                 :          0 :                       d_solver->getOptionInfo("stats-all").boolValue());
      90         [ -  - ]:          0 :       for (; it != stats.end(); ++it)
      91                 :            :       {
      92                 :          0 :         out << it->first << " = " << it->second << std::endl;
      93                 :            :       }
      94                 :            :     }
      95                 :            :     {
      96                 :          0 :       const auto& stats = d_solver->getTermManager().getStatistics();
      97                 :            :       auto it =
      98                 :          0 :           stats.begin(d_solver->getOptionInfo("stats-internal").boolValue(),
      99                 :          0 :                       d_solver->getOptionInfo("stats-all").boolValue());
     100         [ -  - ]:          0 :       for (; it != stats.end(); ++it)
     101                 :            :       {
     102                 :          0 :         out << it->first << " = " << it->second << std::endl;
     103                 :            :       }
     104                 :            :     }
     105                 :            :   }
     106                 :      24305 : }
     107                 :            : 
     108                 :          0 : void CommandExecutor::printStatisticsSafe(int fd) const
     109                 :            : {
     110         [ -  - ]:          0 :   if (d_solver->getOptionInfo("stats").boolValue())
     111                 :            :   {
     112                 :          0 :     d_solver->getTermManager().printStatisticsSafe(fd);
     113                 :          0 :     d_solver->printStatisticsSafe(fd);
     114                 :            :   }
     115                 :          0 : }
     116                 :            : 
     117                 :     705781 : bool CommandExecutor::doCommand(Command* cmd)
     118                 :            : {
     119                 :            :   // formerly was guarded by verbosity > 2
     120         [ +  - ]:     705781 :   Trace("cmd-exec") << "Invoking: " << *cmd << std::endl;
     121                 :     705781 :   return doCommandSingleton(cmd->d_cmd.get());
     122                 :            : }
     123                 :            : 
     124                 :          0 : void CommandExecutor::reset()
     125                 :            : {
     126                 :          0 :   printStatistics(d_solver->getDriverOptions().err());
     127                 :          0 :   Cmd::resetSolver(d_solver.get());
     128                 :          0 : }
     129                 :            : 
     130                 :     710623 : bool CommandExecutor::doCommandSingleton(Cmd* cmd)
     131                 :            : {
     132                 :     710623 :   bool status = solverInvoke(d_solver.get(),
     133                 :            :                              d_symman->toSymManager(),
     134                 :            :                              cmd);
     135                 :            : 
     136                 :    1421240 :   cvc5::Result res;
     137                 :     710621 :   bool hasResult = false;
     138         [ +  - ]:     710621 :   const CheckSatCommand* cs = dynamic_cast<const CheckSatCommand*>(cmd);
     139         [ +  + ]:     710621 :   if (cs != nullptr)
     140                 :            :   {
     141                 :      27679 :     d_result = res = cs->getResult();
     142                 :      27679 :     hasResult = true;
     143                 :            :   }
     144                 :            :   const CheckSatAssumingCommand* csa =
     145         [ +  - ]:     710621 :       dynamic_cast<const CheckSatAssumingCommand*>(cmd);
     146         [ +  + ]:     710621 :   if (csa != nullptr)
     147                 :            :   {
     148                 :       4481 :     d_result = res = csa->getResult();
     149                 :       4481 :     hasResult = true;
     150                 :            :   }
     151                 :            : 
     152                 :            :   // if we didnt set a result, return the status
     153         [ +  + ]:     710621 :   if (!hasResult)
     154                 :            :   {
     155                 :     678461 :     return status;
     156                 :            :   }
     157                 :            : 
     158                 :            :   // dump the model/proof/unsat core if option is set
     159         [ +  + ]:      32160 :   if (status) {
     160                 :      32112 :     bool isResultUnsat = res.isUnsat();
     161                 :      32112 :     bool isResultSat = res.isSat();
     162                 :      64224 :     std::vector<std::unique_ptr<Cmd> > getterCommands;
     163                 :      64224 :     if (d_solver->getOptionInfo("dump-models").boolValue()
     164 [ +  + ][ +  + ]:      64234 :         && (isResultSat
                 [ +  - ]
     165         [ -  + ]:         10 :             || (res.isUnknown()
     166         [ -  - ]:          0 :                 && res.getUnknownExplanation()
     167                 :            :                        == cvc5::UnknownExplanation::INCOMPLETE)))
     168                 :            :     {
     169                 :         10 :       getterCommands.emplace_back(new GetModelCommand());
     170                 :            :     }
     171                 :      32112 :     if (d_solver->getOptionInfo("dump-proofs").boolValue() && isResultUnsat)
     172                 :            :     {
     173                 :       4802 :       getterCommands.emplace_back(new GetProofCommand());
     174                 :            :     }
     175                 :            : 
     176                 :      64224 :     if ((d_solver->getOptionInfo("dump-instantiations").boolValue()
     177                 :      64200 :          || d_solver->getOptionInfo("dump-instantiations-debug").boolValue())
     178 [ +  + ][ +  + ]:      96312 :         && GetInstantiationsCommand::isEnabled(d_solver.get(), res))
                 [ +  + ]
     179                 :            :     {
     180                 :         14 :       getterCommands.emplace_back(new GetInstantiationsCommand());
     181                 :            :     }
     182                 :            : 
     183                 :      64224 :     if (d_solver->getOptionInfo("dump-unsat-cores").boolValue()
     184 [ +  + ][ +  + ]:      64224 :         && isResultUnsat)
                 [ +  - ]
     185                 :            :     {
     186                 :          4 :       getterCommands.emplace_back(new GetUnsatCoreCommand());
     187                 :            :     }
     188                 :            : 
     189                 :      64224 :     if (d_solver->getOptionInfo("dump-unsat-cores-lemmas").boolValue()
     190 [ -  + ][ -  - ]:      64224 :         && isResultUnsat)
                 [ +  - ]
     191                 :            :     {
     192                 :          0 :       getterCommands.emplace_back(new GetUnsatCoreLemmasCommand());
     193                 :            :     }
     194                 :            : 
     195                 :      64224 :     if (d_solver->getOptionInfo("dump-difficulty").boolValue()
     196 [ +  + ][ +  + ]:      64224 :         && (isResultUnsat || isResultSat || res.isUnknown()))
         [ +  + ][ -  + ]
                 [ +  - ]
     197                 :            :     {
     198                 :         12 :       getterCommands.emplace_back(new GetDifficultyCommand());
     199                 :            :     }
     200                 :            : 
     201         [ +  + ]:      32112 :     if (!getterCommands.empty()) {
     202                 :            :       // set no time limit during dumping if applicable
     203         [ -  + ]:       4842 :       if (d_solver->getOptionInfo("force-no-limit-cpu-while-dump").boolValue())
     204                 :            :       {
     205                 :          0 :         setNoLimitCPU();
     206                 :            :       }
     207         [ +  + ]:       9684 :       for (const auto& getterCommand : getterCommands) {
     208                 :       4842 :         status = doCommandSingleton(getterCommand.get());
     209         [ -  + ]:       4842 :         if (!status)
     210                 :            :         {
     211                 :          0 :           break;
     212                 :            :         }
     213                 :            :       }
     214                 :            :     }
     215                 :            :   }
     216                 :      32160 :   return status;
     217                 :            : }
     218                 :            : 
     219                 :     710623 : bool CommandExecutor::solverInvoke(cvc5::Solver* solver,
     220                 :            :                                    SymManager* sm,
     221                 :            :                                    Cmd* cmd)
     222                 :            : {
     223                 :            :   // print output for -o raw-benchmark
     224         [ +  + ]:     710623 :   if (solver->isOutputOn("raw-benchmark"))
     225                 :            :   {
     226                 :     135896 :     solver->getOutput("raw-benchmark") << cmd->toString() << std::endl;
     227                 :            :   }
     228                 :            : 
     229                 :            :   // In parse-only mode, we do not invoke any of the commands except define-*
     230                 :            :   // declare-*, set-logic, and reset commands. We invoke define-* and declare-*
     231                 :            :   // commands because they add function names to the symbol table.
     232 [ +  - ][ +  + ]:     271724 :   if (d_parseOnly && dynamic_cast<SetBenchmarkLogicCommand*>(cmd) == nullptr
     233 [ +  - ][ +  + ]:     263744 :       && dynamic_cast<ResetCommand*>(cmd) == nullptr
     234 [ +  - ][ +  + ]:     263709 :       && dynamic_cast<DeclarationDefinitionCommand*>(cmd) == nullptr
     235 [ +  - ][ +  + ]:      98758 :       && dynamic_cast<DatatypeDeclarationCommand*>(cmd) == nullptr
     236 [ +  + ][ +  - ]:     982347 :       && dynamic_cast<DefineFunctionRecCommand*>(cmd) == nullptr)
         [ +  + ][ +  + ]
     237                 :            :   {
     238                 :      97216 :     return true;
     239                 :            :   }
     240                 :            : 
     241                 :     613407 :   cmd->invokeAndPrintResult(solver, sm);
     242                 :     613405 :   return !cmd->fail();
     243                 :            : }
     244                 :            : 
     245                 :      24305 : void CommandExecutor::flushOutputStreams() {
     246                 :      24305 :   printStatistics(d_solver->getDriverOptions().err());
     247                 :            : 
     248                 :            :   // make sure out and err streams are flushed too
     249                 :      24305 :   d_solver->getDriverOptions().out() << std::flush;
     250                 :      24305 :   d_solver->getDriverOptions().err() << std::flush;
     251                 :      24305 : }
     252                 :            : 
     253                 :            : }  // namespace cvc5::main