src/csolver.h

   1 #ifndef CSOLVER_H
   2 #define CSOLVER_H
   3 #include "classes.h"
   4 #include "ops.h"
   5 #include "corestructs.h"
   6 #include "asthash.h"
   7
   8 class CSolver {
   9 public:
  10         CSolver();
  11         ~CSolver();
  12
  13         /** This function creates a set containing the elements passed in the array. */
  14         Set *createSet(VarType type, uint64_t *elements, uint num);
  15
  16         /** This function creates a set from lowrange to highrange (inclusive). */
  17
  18         Set *createRangeSet(VarType type, uint64_t lowrange, uint64_t highrange);
  19
  20         Element *createRangeVar(VarType type, uint64_t lowrange, uint64_t highrange);
  21
  22         /** This function creates a mutable set. */
  23
  24         MutableSet *createMutableSet(VarType type);
  25
  26         /** This function adds a new item to a set. */
  27
  28         void addItem(MutableSet *set, uint64_t element);
  29
  30         /** This function adds a new unique item to the set and returns it.
  31             This function cannot be used in conjunction with manually adding
  32             items to the set. */
  33
  34         uint64_t createUniqueItem(MutableSet *set);
  35
  36         /** This function creates an element variable over a set. */
  37
  38         Element *getElementVar(Set *set);
  39
  40         /** This function creates an element constrant. */
  41         Element *getElementConst(VarType type, uint64_t value);
  42
  43         Boolean *getBooleanTrue();
  44
  45         Boolean *getBooleanFalse();
  46
  47         /** This function creates a boolean variable. */
  48
  49         Boolean *getBooleanVar(VarType type);
  50
  51         /** This function creates a function operator. */
  52
  53         Function *createFunctionOperator(ArithOp op, Set **domain, uint numDomain, Set *range,
  54                                                                                                                                          OverFlowBehavior overflowbehavior);
  55
  56         /** This function creates a predicate operator. */
  57
  58         Predicate *createPredicateOperator(CompOp op, Set **domain, uint numDomain);
  59
  60         Predicate *createPredicateTable(Table *table, UndefinedBehavior behavior);
  61
  62         /** This function creates an empty instance table.*/
  63
  64         Table *createTable(Set **domains, uint numDomain, Set *range);
  65
  66         Table *createTableForPredicate(Set **domains, uint numDomain);
  67         /** This function adds an input output relation to a table. */
  68
  69         void addTableEntry(Table *table, uint64_t *inputs, uint inputSize, uint64_t result);
  70
  71         /** This function converts a completed table into a function. */
  72
  73         Function *completeTable(Table *, UndefinedBehavior behavior);
  74
  75         /** This function applies a function to the Elements in its input. */
  76
  77         Element *applyFunction(Function *function, Element **array, uint numArrays, Boolean *overflowstatus);
  78
  79         /** This function applies a predicate to the Elements in its input. */
  80
  81         Boolean *applyPredicateTable(Predicate *predicate, Element **inputs, uint numInputs, Boolean *undefinedStatus);
  82
  83         Boolean *applyPredicate(Predicate *predicate, Element **inputs, uint numInputs);
  84
  85         /** This function applies a logical operation to the Booleans in its input. */
  86
  87         Boolean *applyLogicalOperation(LogicOp op, Boolean **array, uint asize);
  88
  89         /** This function adds a boolean constraint to the set of constraints
  90             to be satisfied */
  91
  92         void addConstraint(Boolean *constraint);
  93
  94         /** This function instantiates an order of type type over the set set. */
  95         Order *createOrder(OrderType type, Set *set);
  96
  97         /** This function instantiates a boolean on two items in an order. */
  98         Boolean *orderConstraint(Order *order, uint64_t first, uint64_t second);
  99
 100         /** When everything is done, the client calls this function and then csolver starts to encode*/
 101         int startEncoding();
 102
 103         /** After getting the solution from the SAT solver, client can get the value of an element via this function*/
 104         uint64_t getElementValue(Element *element);
 105
 106         /** After getting the solution from the SAT solver, client can get the value of a boolean via this function*/
 107         bool getBooleanValue(Boolean *boolean);
 108
 109         HappenedBefore getOrderConstraintValue(Order *order, uint64_t first, uint64_t second);
 110
 111         bool isTrue(Boolean *b);
 112         bool isFalse(Boolean *b);
 113
 114         void setUnSAT() { unsat = true; }
 115
 116         bool isUnSAT() { return unsat; }
 117
 118         Vector<Order *> *getOrders() { return &allOrders;}
 119
 120         Tuner *getTuner() { return tuner; }
 121
 122         SetIteratorBoolean *getConstraints() { return constraints.iterator(); }
 123
 124         SATEncoder *getSATEncoder() {return satEncoder;}
 125
 126         void replaceBooleanWithTrue(Boolean *bexpr);
 127         void replaceBooleanWithFalse(Boolean *bexpr);
 128         void replaceBooleanWithBoolean(Boolean *oldb, Boolean *newb);
 129         CSolver *clone();
 130         void autoTune(uint budget);
 131
 132         void setTuner(Tuner * _tuner) { tuner = _tuner; }
 133         long long getElapsedTime() { return elapsedTime; }
 134         long long getEncodeTime();
 135         long long getSolveTime();
 136
 137         CMEMALLOC;
 138
 139 private:
 140         void handleXORFalse(BooleanLogic *bexpr, Boolean *child);
 141         void handleIMPLIESTrue(BooleanLogic *bexpr, Boolean *child);
 142         void handleIMPLIESFalse(BooleanLogic *bexpr, Boolean *child);
 143         void handleANDTrue(BooleanLogic *bexpr, Boolean *child);
 144         void handleORFalse(BooleanLogic *bexpr, Boolean *child);
 145
 146         /** This is a vector of constraints that must be satisfied. */
 147         HashsetBoolean constraints;
 148
 149         /** This is a vector of all boolean structs that we have allocated. */
 150         Vector<Boolean *> allBooleans;
 151
 152         /** This is a vector of all set structs that we have allocated. */
 153         Vector<Set *> allSets;
 154
 155         /** This is a vector of all element structs that we have allocated. */
 156         Vector<Element *> allElements;
 157
 158         /** This is a vector of all predicate structs that we have allocated. */
 159         Vector<Predicate *> allPredicates;
 160
 161         /** This is a vector of all table structs that we have allocated. */
 162         Vector<Table *> allTables;
 163
 164         /** This is a vector of all order structs that we have allocated. */
 165         Vector<Order *> allOrders;
 166
 167         /** This is a vector of all function structs that we have allocated. */
 168         Vector<Function *> allFunctions;
 169
 170         Boolean * boolTrue;
 171         Boolean * boolFalse;
 172
 173         /** These two tables are used for deduplicating entries. */
 174         BooleanMatchMap boolMap;
 175         ElementMatchMap elemMap;
 176
 177         SATEncoder *satEncoder;
 178         bool unsat;
 179         Tuner *tuner;
 180
 181         long long elapsedTime;
 182 };
 183 #endif