X-Git-Url: http://plrg.eecs.uci.edu/git/?p=satune.git;a=blobdiff_plain;f=src%2Fcsolver.h;h=b27e3c00038d586908d6d17bb80f79a774b7eaed;hp=cde6c64688b83ee6f670912338f6196a294c19b6;hb=0fc529c88d7ea03156af7a2f1ad1fbb956c23c98;hpb=5f7ad155a72a38dda20e1ffd4e8bf8c7c1132251 diff --git a/src/csolver.h b/src/csolver.h index cde6c64..b27e3c0 100644 --- a/src/csolver.h +++ b/src/csolver.h @@ -1,135 +1,279 @@ #ifndef CSOLVER_H #define CSOLVER_H -#include "classlist.h" +#include "classes.h" #include "ops.h" -#include "structs.h" +#include "corestructs.h" +#include "asthash.h" +#include "solver_interface.h" +#include "common.h" -struct CSolver { - SATEncoder *satEncoder; - /** This is a vector of constraints that must be satisfied. */ - VectorBoolean *constraints; +class CSolver { +public: + CSolver(); + ~CSolver(); + void resetSolver(); + /** This function creates a set containing the elements passed in the array. */ + Set *createSet(VarType type, uint64_t *elements, uint num); - /** This is a vector of all boolean structs that we have allocated. */ - VectorBoolean *allBooleans; + /** This function creates a set from lowrange to highrange (inclusive). */ - /** This is a vector of all set structs that we have allocated. */ - VectorSet *allSets; + Set *createRangeSet(VarType type, uint64_t lowrange, uint64_t highrange); - /** This is a vector of all element structs that we have allocated. */ - VectorElement *allElements; + bool itemExistInSet(Set *set, uint64_t item); - /** This is a vector of all predicate structs that we have allocated. */ - VectorPredicate *allPredicates; + VarType getSetVarType(Set *set); - /** This is a vector of all table structs that we have allocated. */ - VectorTable *allTables; + Element *createRangeVar(VarType type, uint64_t lowrange, uint64_t highrange); - /** This is a vector of all order structs that we have allocated. */ - VectorOrder *allOrders; + /** This function creates a mutable set. + * Note: You should use addItem for adding new item to Mutable sets, and + * at the end, you should call finalizeMutableSet! + */ - /** This is a vector of all function structs that we have allocated. */ - VectorFunction *allFunctions; -}; + MutableSet *createMutableSet(VarType type); + + /** This function adds a new item to a set. */ -/** Create a new solver instance. */ + //Deprecating this unless we need it... + void addItem(MutableSet *set, uint64_t element); -CSolver *allocCSolver(); + /** This function adds a new unique item to the set and returns it. + This function cannot be used in conjunction with manually adding + items to the set. */ -/** Delete solver instance. */ + uint64_t createUniqueItem(MutableSet *set); -void deleteSolver(CSolver *This); + /** + * Freeze and finalize the mutableSet ... + */ + void finalizeMutableSet(MutableSet *set); -/** This function creates a set containing the elements passed in the array. */ + /** This function creates an element variable over a set. */ -Set *createSet(CSolver *, VarType type, uint64_t *elements, uint num); + Element *getElementVar(Set *set); -/** This function creates a set from lowrange to highrange (inclusive). */ + /** This function creates an element constrant. */ + Element *getElementConst(VarType type, uint64_t value); -Set *createRangeSet(CSolver *, VarType type, uint64_t lowrange, uint64_t highrange); + Set *getElementRange (Element *element); -/** This function creates a mutable set. */ + void mustHaveValue(Element *element); -MutableSet *createMutableSet(CSolver *, VarType type); + BooleanEdge getBooleanTrue(); -/** This function adds a new item to a set. */ + BooleanEdge getBooleanFalse(); -void addItem(CSolver *, MutableSet *set, uint64_t element); + /** This function creates a boolean variable. */ -/** This function adds a new unique item to the set and returns it. - This function cannot be used in conjunction with manually adding - items to the set. */ + BooleanEdge getBooleanVar(VarType type); -uint64_t createUniqueItem(CSolver *, MutableSet *set); + /** This function creates a function operator. */ -/** This function creates an element variable over a set. */ + Function *createFunctionOperator(ArithOp op, Set *range, + OverFlowBehavior overflowbehavior); -Element *getElementVar(CSolver *, Set *set); + /** This function creates a predicate operator. */ -/** This function creates an element constrant. */ -Element *getElementConst(CSolver *, VarType type, uint64_t value); + Predicate *createPredicateOperator(CompOp op); -/** This function creates a boolean variable. */ + Predicate *createPredicateTable(Table *table, UndefinedBehavior behavior); -Boolean *getBooleanVar(CSolver *, VarType type); + /** This function creates an empty instance table.*/ -/** This function creates a function operator. */ + Table *createTable(Set *range); -Function *createFunctionOperator(CSolver *solver, ArithOp op, Set **domain, uint numDomain, Set *range, - OverFlowBehavior overflowbehavior); + Table *createTableForPredicate(); + /** This function adds an input output relation to a table. */ -/** This function creates a predicate operator. */ + void addTableEntry(Table *table, uint64_t *inputs, uint inputSize, uint64_t result); -Predicate *createPredicateOperator(CSolver *solver, CompOp op, Set **domain, uint numDomain); + /** This function converts a completed table into a function. */ -Predicate *createPredicateTable(CSolver *solver, Table *table, UndefinedBehavior behavior); + Function *completeTable(Table *, UndefinedBehavior behavior); -/** This function creates an empty instance table.*/ + /** This function applies a function to the Elements in its input. */ -Table *createTable(CSolver *solver, Set **domains, uint numDomain, Set *range); + Element *applyFunction(Function *function, Element **array, uint numArrays, BooleanEdge overflowstatus); -Table *createTableForPredicate(CSolver *solver, Set **domains, uint numDomain); -/** This function adds an input output relation to a table. */ + /** This function applies a predicate to the Elements in its input. */ -void addTableEntry(CSolver *solver, Table *table, uint64_t *inputs, uint inputSize, uint64_t result); + BooleanEdge applyPredicateTable(Predicate *predicate, Element **inputs, uint numInputs, BooleanEdge undefinedStatus); -/** This function converts a completed table into a function. */ + BooleanEdge applyPredicate(Predicate *predicate, Element **inputs, uint numInputs); -Function *completeTable(CSolver *, Table *, UndefinedBehavior behavior); + /** This exactly one element of array can be true! (i.e. a1 + a2 + a3 + ... + an = 1)*/ + BooleanEdge applyExactlyOneConstraint (BooleanEdge *array, uint asize); -/** This function applies a function to the Elements in its input. */ + /** This function applies a logical operation to the Booleans in its input. */ -Element *applyFunction(CSolver *, Function *function, Element **array, uint numArrays, Boolean *overflowstatus); + BooleanEdge applyLogicalOperation(LogicOp op, BooleanEdge *array, uint asize); -/** This function applies a predicate to the Elements in its input. */ + /** This function applies a logical operation to the Booleans in its input. */ -Boolean *applyPredicateTable(CSolver *, Predicate *predicate, Element **inputs, uint numInputs, Boolean *undefinedStatus); + BooleanEdge applyLogicalOperation(LogicOp op, BooleanEdge arg1, BooleanEdge arg2); -Boolean *applyPredicate(CSolver *, Predicate *predicate, Element **inputs, uint numInputs); + /** This function applies a logical operation to the Booleans in its input. */ -/** This function applies a logical operation to the Booleans in its input. */ + BooleanEdge applyLogicalOperation(LogicOp op, BooleanEdge arg); -Boolean *applyLogicalOperation(CSolver *, LogicOp op, Boolean **array, uint asize); + /** This function adds a boolean constraint to the set of constraints + to be satisfied */ -/** This function adds a boolean constraint to the set of constraints - to be satisfied */ + void addConstraint(BooleanEdge constraint); -void addConstraint(CSolver *, Boolean *constraint); + /** This function instantiates an order of type type over the set set. */ + Order *createOrder(OrderType type, Set *set); -/** This function instantiates an order of type type over the set set. */ -Order *createOrder(CSolver *, OrderType type, Set *set); + /** This function instantiates a boolean on two items in an order. */ + BooleanEdge orderConstraint(Order *order, uint64_t first, uint64_t second); -/** This function instantiates a boolean on two items in an order. */ -Boolean *orderConstraint(CSolver *, Order *order, uint64_t first, uint64_t second); + /** When everything is done, the client calls this function and then csolver starts to encode*/ + int solve(); + /** + * Incremental Solving for SATUNE. + * It only supports incremental solving for elements! + * No support for BooleanVar, BooleanOrder or using interpreters + * @return + */ + int solveIncremental(); -/** When everything is done, the client calls this function and then csolver starts to encode*/ -int startEncoding(CSolver *); + /** After getting the solution from the SAT solver, client can get the value of an element via this function*/ + uint64_t getElementValue(Element *element); -/** After getting the solution from the SAT solver, client can get the value of an element via this function*/ -uint64_t getElementValue(CSolver *, Element *element); + void freezeElement(Element *e); -/** After getting the solution from the SAT solver, client can get the value of a boolean via this function*/ -bool getBooleanValue( CSolver *, Boolean *boolean); + /** After getting the solution from the SAT solver, client can get the value of a boolean via this function*/ + bool getBooleanValue(BooleanEdge boolean); -HappenedBefore getOrderConstraintValue(CSolver *, Order *order, uint64_t first, uint64_t second); + bool getOrderConstraintValue(Order *order, uint64_t first, uint64_t second); + + bool isTrue(BooleanEdge b); + bool isFalse(BooleanEdge b); + + void setUnSAT() { model_print("Setting UNSAT %%%%%%\n"); unsat = true; } + void setSatSolverTimeout(long seconds) { satsolverTimeout = seconds;} + bool isUnSAT() { return unsat; } + bool isBooleanVarUsed() {return booleanVarUsed;} + void printConstraint(BooleanEdge boolean); + void printConstraints(); + + Vector *getOrders() { return &allOrders;} + HashsetOrder *getActiveOrders() { return &activeOrders;} + + Tuner *getTuner() { return tuner; } + + SetIteratorBooleanEdge *getConstraints() { return constraints.iterator(); } + bool isConstraintEncoded(BooleanEdge be) { return encodedConstraints.contains(be);} + void addEncodedConstraint(BooleanEdge be) {encodedConstraints.add(be);} + + SATEncoder *getSATEncoder() {return satEncoder;} + + void replaceBooleanWithTrue(BooleanEdge bexpr); + void replaceBooleanWithTrueNoRemove(BooleanEdge bexpr); + void replaceBooleanWithFalseNoRemove(BooleanEdge bexpr); + void replaceBooleanWithFalse(BooleanEdge bexpr); + void replaceBooleanWithBoolean(BooleanEdge oldb, BooleanEdge newb); + CSolver *clone(); + void serialize(); + static CSolver *deserialize(const char *file, InterpreterType itype = SATUNE); + void autoTune(uint budget); + void inferFixedOrders(); + void inferFixedOrder(Order *order); + void setInterpreter(InterpreterType type); + bool useInterpreter() {return interpreter != NULL;} + void setTuner(Tuner *_tuner) { tuner = _tuner; } + long long getElapsedTime() { return elapsedTime; } + long long getEncodeTime(); + long long getSolveTime(); + long getSatSolverTimeout() { return satsolverTimeout;} + bool isIncrementalMode() {return incrementalMode;} + void freezeElementsVariables(); + CMEMALLOC; + +private: + void handleIFFTrue(BooleanLogic *bexpr, BooleanEdge child); + void handleANDTrue(BooleanLogic *bexpr, BooleanEdge child); + void handleFunction(ElementFunction *ef, BooleanEdge child); + + //These two functions are helpers if the client has a pointer to a + //Boolean object that we have since replaced + BooleanEdge rewriteLogicalOperation(LogicOp op, BooleanEdge *array, uint asize); + BooleanEdge doRewrite(BooleanEdge b); + /** This is a vector of constraints that must be satisfied. */ + HashsetBooleanEdge constraints; + HashsetBooleanEdge encodedConstraints; + + /** This is a vector of all boolean structs that we have allocated. */ + Vector allBooleans; + + /** This is a vector of all set structs that we have allocated. */ + Vector allSets; + + /** This is a vector of all element structs that we have allocated. */ + Vector allElements; + + /** This is a vector of all predicate structs that we have allocated. */ + Vector allPredicates; + + /** This is a vector of all table structs that we have allocated. */ + Vector allTables; + + /** This is a vector of all order structs that we have allocated. */ + Vector allOrders; + + HashsetOrder activeOrders; + + /** This is a vector of all function structs that we have allocated. */ + Vector allFunctions; + + BooleanEdge boolTrue; + BooleanEdge boolFalse; + + /** These two tables are used for deduplicating entries. */ + BooleanMatchMap boolMap; + ElementMatchMap elemMap; + + SATEncoder *satEncoder; + bool unsat; + bool booleanVarUsed; + bool incrementalMode; + Tuner *tuner; + long long elapsedTime; + long satsolverTimeout; + Interpreter *interpreter; + friend class ElementOpt; + friend class VarOrderingOpt; +}; +inline CompOp flipOp(CompOp op) { + switch (op) { + case SATC_EQUALS: + return SATC_EQUALS; + case SATC_LT: + return SATC_GT; + case SATC_GT: + return SATC_LT; + case SATC_LTE: + return SATC_GTE; + case SATC_GTE: + return SATC_LTE; + } + ASSERT(0); +} + +inline CompOp negateOp(CompOp op) { + switch (op) { + case SATC_EQUALS: + ASSERT(0); + case SATC_LT: + return SATC_GTE; + case SATC_GT: + return SATC_LTE; + case SATC_LTE: + return SATC_GT; + case SATC_GTE: + return SATC_LT; + } + ASSERT(0); +} #endif