Add solver independent quantifier elimination with ultimate eliminator

.classpath

@@ -14,6 +14,15 @@ SPDX-License-Identifier: Apache-2.0
 	<classpathentry kind="src" path="src"/>
 	<classpathentry kind="lib" path="bin/"/>
 	<classpathentry kind="lib" path="lib/java/core/guava.jar" sourcepath="lib/java-contrib/guava-sources.jar"/>
+
+	<classpathentry kind="lib" path="lib/java/core/ultimate-model-checker-utils.jar" sourcepath="lib/java-contrib/ultimate-model-checker-utils-sources.jar"/>
+        <classpathentry kind="lib" path="lib/java/core/ultimate-core-rcp.jar" sourcepath="lib/java-contrib/ultimate-core-rcp-sources.jar"/>
+	<classpathentry kind="lib" path="lib/java/core/ultimate-core.jar" sourcepath="lib/java-contrib/ultimate-core-sources.jar"/>
+	<classpathentry kind="lib" path="lib/java/core/ultimate-model.jar" sourcepath="lib/java-contrib/ultimate-model-sources.jar"/>
+	<classpathentry kind="lib" path="lib/java/core/ultimate-library-smtlib.jar" sourcepath="lib/java-contrib/ultimate-library-smtlib-sources.jar"/>
+	<classpathentry kind="lib" path="lib/java/core/ultimate-library-smtlib-utils.jar" sourcepath="lib/java-contrib/ultimate-library-smtlib-utils-sources.jar"/>
+	<classpathentry kind="lib" path="lib/java/core/ultimate-util.jar" sourcepath="lib/java-contrib/ultimate-util-sources.jar"/>
+
 	<classpathentry kind="lib" path="lib/java/test/guava-testlib.jar" sourcepath="lib/java-contrib/guava-testlib-sources.jar"/>
 	<classpathentry kind="lib" path="lib/java/test/truth.jar" sourcepath="lib/java-contrib/truth-sources.jar"/>
 	<classpathentry kind="lib" path="lib/java/test/junit.jar"/>

lib/ivy.xml

@@ -167,6 +167,28 @@ SPDX-License-Identifier: Apache-2.0
         <!-- SmtInterpol -->
         <dependency org="de.uni-freiburg.informatik.ultimate" name="smtinterpol" rev="2.5-1242-g5c50fb6d" conf="runtime-smtinterpol->master; contrib->sources"/>
 
+        <!-- UltimateEliminator -->
+        <dependency org="de.uni-freiburg.informatik.ultimate" name="ultimate-model-checker-utils"
+                    rev="2022-10-13-r05bfb7ad3d" conf="core->runtime; contrib->sources"/>
+        <dependency org="de.uni-freiburg.informatik.ultimate" name="ultimate-core-rcp"
+                    rev="2022-10-13-r05bfb7ad3d" conf="core->runtime; contrib->sources"/>
+        <dependency org="de.uni-freiburg.informatik.ultimate" name="ultimate-core"
+                    rev="2022-10-13-r05bfb7ad3d" conf="core->runtime; contrib->sources"/>
+        <dependency org="de.uni-freiburg.informatik.ultimate" name="ultimate-model"
+                    rev="2022-10-13-r05bfb7ad3d" conf="core->runtime; contrib->sources"/>
+        <dependency org="de.uni-freiburg.informatik.ultimate" name="ultimate-library-smtlib"
+                    rev="2022-10-13-r05bfb7ad3d" conf="core->runtime; contrib->sources"/>
+        <dependency org="de.uni-freiburg.informatik.ultimate" name="ultimate-library-smtlib-utils"
+                    rev="2022-10-13-r05bfb7ad3d" conf="core->runtime; contrib->sources"/>
+        <dependency org="de.uni-freiburg.informatik.ultimate" name="ultimate-util"
+                    rev="2022-10-13-r05bfb7ad3d" conf="core->runtime; contrib->sources"/>
+
+        <!-- Princess for our Maven release -->
+        <dependency org="io.github.uuverifiers" name="princess_2.13" rev="2024-01-12" conf="runtime-princess-with-javacup->default; contrib->sources"/>
+        <!-- Princess for our Ivy release-->
+        <dependency org="io.github.uuverifiers" name="princess_2.13" rev="2024-01-12"
+                    conf="runtime-princess->default; contrib->sources"/>
+          <!-- Exclude dependency on java-cup and replace it with java-cup-runtime, which is enough.-->
         <!-- Princess and Ostrich for our Maven release -->
         <dependency org="io.github.uuverifiers" name="princess_2.13" rev="2024-11-08" conf="runtime-princess-with-javacup->default; contrib->sources"/>
         <dependency org="io.github.uuverifiers" name="ostrich_2.13" rev="1.4.1" conf="runtime-princess-with-javacup->default; contrib->sources"/>

src/org/sosy_lab/java_smt/SolverContextFactory.java

@@ -292,17 +292,23 @@ private SolverContext generateContext0(Solvers solverToCreate)
 
       case PRINCESS:
         return PrincessSolverContext.create(
-            config, shutdownNotifier, logfile, (int) randomSeed, nonLinearArithmetic);
+            config, shutdownNotifier, logfile, (int) randomSeed, nonLinearArithmetic, logger);
 
       case YICES2:
-        return Yices2SolverContext.create(nonLinearArithmetic, shutdownNotifier, loader);
+        return Yices2SolverContext.create(nonLinearArithmetic, shutdownNotifier, loader, logger);
 
       case BOOLECTOR:
         return BoolectorSolverContext.create(config, shutdownNotifier, logfile, randomSeed, loader);
 
       case BITWUZLA:
         return BitwuzlaSolverContext.create(
-            config, shutdownNotifier, logfile, randomSeed, floatingPointRoundingMode, loader);
+            config,
+            shutdownNotifier,
+            logfile,
+            randomSeed,
+            floatingPointRoundingMode,
+            loader,
+            logger);
 
       default:
         throw new AssertionError("no solver selected");

src/org/sosy_lab/java_smt/api/QuantifiedFormulaManager.java

@@ -9,7 +9,9 @@
 package org.sosy_lab.java_smt.api;
 
 import com.google.common.collect.ImmutableList;
+import java.io.IOException;
 import java.util.List;
+import org.sosy_lab.java_smt.api.SolverContext.ProverOptions;
 
 /**
  * This interface contains methods for working with any theory with quantifiers.
@@ -24,44 +26,54 @@ enum Quantifier {
   }
 
   /**
-   * @return An existentially quantified formula.
    * @param pVariables The variables that will get bound (variables) by the quantification.
    * @param pBody The {@link BooleanFormula}} within that the binding will be performed.
+   * @return An existentially quantified formula.
    * @throws IllegalArgumentException If the list {@code pVariables} is empty.
    */
-  default BooleanFormula exists(List<? extends Formula> pVariables, BooleanFormula pBody) {
+  default BooleanFormula exists(List<? extends Formula> pVariables, BooleanFormula pBody)
+      throws IOException {
     return mkQuantifier(Quantifier.EXISTS, pVariables, pBody);
   }
 
   /**
-   * @return A universally quantified formula.
    * @param pVariables The variables that will get bound (variables) by the quantification.
    * @param pBody The {@link BooleanFormula}} within that the binding will be performed.
+   * @return A universally quantified formula.
    * @throws IllegalArgumentException If the list {@code pVariables} is empty.
    */
-  default BooleanFormula forall(List<? extends Formula> pVariables, BooleanFormula pBody) {
+  default BooleanFormula forall(List<? extends Formula> pVariables, BooleanFormula pBody)
+      throws IOException {
     return mkQuantifier(Quantifier.FORALL, pVariables, pBody);
   }
 
   /** Syntax sugar, see {@link #forall(List, BooleanFormula)}. */
   default BooleanFormula forall(Formula quantifiedArg, BooleanFormula pBody) {
-    return forall(ImmutableList.of(quantifiedArg), pBody);
+    try {
+      return forall(ImmutableList.of(quantifiedArg), pBody);
+    } catch (IOException e) {
+      throw new RuntimeException(e);
+    }
   }
 
   /** Syntax sugar, see {@link #exists(List, BooleanFormula)}. */
   default BooleanFormula exists(Formula quantifiedArg, BooleanFormula pBody) {
-    return exists(ImmutableList.of(quantifiedArg), pBody);
+    try {
+      return exists(ImmutableList.of(quantifiedArg), pBody);
+    } catch (IOException e) {
+      throw new RuntimeException(e);
+    }
   }
 
   /**
-   * @return A quantified formula
    * @param q Quantifier type
    * @param pVariables The variables that will get bound (variables) by the quantification.
    * @param pBody The {@link BooleanFormula}} within that the binding will be performed.
+   * @return A quantified formula
    * @throws IllegalArgumentException If the list {@code pVariables} is empty.
    */
   BooleanFormula mkQuantifier(
-      Quantifier q, List<? extends Formula> pVariables, BooleanFormula pBody);
+      Quantifier q, List<? extends Formula> pVariables, BooleanFormula pBody) throws IOException;
 
   /**
    * Eliminate the quantifiers for a given formula. If this is not possible, it will return the
@@ -72,4 +84,6 @@ BooleanFormula mkQuantifier(
    */
   BooleanFormula eliminateQuantifiers(BooleanFormula pF)
       throws InterruptedException, SolverException;
+
+  void setOptions(ProverOptions... opt);
 }

src/org/sosy_lab/java_smt/api/SolverContext.java

@@ -53,7 +53,40 @@ enum ProverOptions {
     GENERATE_UNSAT_CORE_OVER_ASSUMPTIONS,
 
     /** Whether the solver should enable support for formulae build in SL theory. */
-    ENABLE_SEPARATION_LOGIC
+    ENABLE_SEPARATION_LOGIC,
+
+    /** Whether the solver should enable quantifier eliminiation via UltimateEliminator. */
+    SOLVER_INDEPENDENT_QUANTIFIER_ELIMINATION,
+
+    /**
+     * Whether the solver should eliminiate the quantifier via UltimateEliminator before inserting
+     * it to the native quantified formula.
+     */
+    EXTERNAL_QUANTIFIER_CREATION,
+
+    /**
+     * Whether the solver should fall back to the alternative quantifier creation if the current
+     * creation method fails. The solver will log a warning in this case.
+     */
+    EXTERNAL_QUANTIFIER_CREATION_FALLBACK_WARN_ON_FAILURE,
+
+    /**
+     * Whether the solver should fall back to the alternative quantifier creation if the current
+     * creation method fails. The solver will not log a warning in this case.
+     */
+    EXTERNAL_QUANTIFIER_CREATION_FALLBACK,
+
+    /**
+     * Whether the solver should fall back to the alternative quantifier elimination if the current
+     * elimination method fails. The solver will log a warning in this case.
+     */
+    QUANTIFIER_ELIMINATION_FALLBACK_WARN_ON_FAILURE,
+
+    /**
+     * Whether the solver should fall back to the alternative quantifier elimination if the current
+     * elimination method fails. The solver will not log a warning in this case.
+     */
+    QUANTIFIER_ELIMINATION_FALLBACK,
   }
 
   /**

src/org/sosy_lab/java_smt/api/visitors/BooleanFormulaTransformationVisitor.java

@@ -8,6 +8,7 @@
 
 package org.sosy_lab.java_smt.api.visitors;
 
+import java.io.IOException;
 import java.util.List;
 import org.sosy_lab.java_smt.api.BooleanFormula;
 import org.sosy_lab.java_smt.api.BooleanFormulaManager;
@@ -93,7 +94,8 @@ public BooleanFormula visitQuantifier(
       Quantifier quantifier,
       BooleanFormula quantifiedAST,
       List<Formula> boundVars,
-      BooleanFormula processedBody) {
+      BooleanFormula processedBody)
+      throws IOException {
     return mgr.getQuantifiedFormulaManager().mkQuantifier(quantifier, boundVars, processedBody);
   }
 }

src/org/sosy_lab/java_smt/api/visitors/BooleanFormulaVisitor.java

@@ -8,6 +8,7 @@
 
 package org.sosy_lab.java_smt.api.visitors;
 
+import java.io.IOException;
 import java.util.List;
 import org.sosy_lab.java_smt.api.BooleanFormula;
 import org.sosy_lab.java_smt.api.BooleanFormulaManager;
@@ -108,7 +109,8 @@ R visitQuantifier(
       Quantifier quantifier,
       BooleanFormula quantifiedAST,
       List<Formula> boundVars,
-      BooleanFormula body);
+      BooleanFormula body)
+      throws IOException;
 
   /**
    * Visit an SMT atom. An atom can be a theory expression, constant, or a variable.

src/org/sosy_lab/java_smt/api/visitors/FormulaTransformationVisitor.java

@@ -8,6 +8,7 @@
 
 package org.sosy_lab.java_smt.api.visitors;
 
+import java.io.IOException;
 import java.util.List;
 import org.sosy_lab.java_smt.api.BooleanFormula;
 import org.sosy_lab.java_smt.api.Formula;
@@ -69,7 +70,8 @@ public BooleanFormula visitQuantifier(
       BooleanFormula f,
       Quantifier quantifier,
       List<Formula> boundVariables,
-      BooleanFormula transformedBody) {
+      BooleanFormula transformedBody)
+      throws IOException {
     return fmgr.getQuantifiedFormulaManager()
         .mkQuantifier(quantifier, boundVariables, transformedBody);
   }