Add convenience functions
[satune.git] / src / csolver.cc
1 #include "csolver.h"
2 #include "set.h"
3 #include "mutableset.h"
4 #include "element.h"
5 #include "boolean.h"
6 #include "predicate.h"
7 #include "order.h"
8 #include "table.h"
9 #include "function.h"
10 #include "satencoder.h"
11 #include "sattranslator.h"
12 #include "tunable.h"
13 #include "polarityassignment.h"
14 #include "analyzer.h"
15 #include "autotuner.h"
16 #include "astops.h"
17 #include "structs.h"
18
19 CSolver::CSolver() :
20         boolTrue(new BooleanConst(true)),
21         boolFalse(new BooleanConst(false)),
22         unsat(false),
23         tuner(NULL),
24         elapsedTime(0)
25 {
26         satEncoder = new SATEncoder(this);
27 }
28
29 /** This function tears down the solver and the entire AST */
30
31 CSolver::~CSolver() {
32         uint size = allBooleans.getSize();
33         for (uint i = 0; i < size; i++) {
34                 delete allBooleans.get(i);
35         }
36
37         size = allSets.getSize();
38         for (uint i = 0; i < size; i++) {
39                 delete allSets.get(i);
40         }
41
42         size = allElements.getSize();
43         for (uint i = 0; i < size; i++) {
44                 delete allElements.get(i);
45         }
46
47         size = allTables.getSize();
48         for (uint i = 0; i < size; i++) {
49                 delete allTables.get(i);
50         }
51
52         size = allPredicates.getSize();
53         for (uint i = 0; i < size; i++) {
54                 delete allPredicates.get(i);
55         }
56
57         size = allOrders.getSize();
58         for (uint i = 0; i < size; i++) {
59                 delete allOrders.get(i);
60         }
61
62         size = allFunctions.getSize();
63         for (uint i = 0; i < size; i++) {
64                 delete allFunctions.get(i);
65         }
66
67         delete boolTrue;
68         delete boolFalse;
69         delete satEncoder;
70 }
71
72 CSolver *CSolver::clone() {
73         CSolver *copy = new CSolver();
74         CloneMap map;
75         SetIteratorBoolean *it = getConstraints();
76         while (it->hasNext()) {
77                 Boolean *b = it->next();
78                 copy->addConstraint(b->clone(copy, &map));
79         }
80         delete it;
81         return copy;
82 }
83
84 Set *CSolver::createSet(VarType type, uint64_t *elements, uint numelements) {
85         Set *set = new Set(type, elements, numelements);
86         allSets.push(set);
87         return set;
88 }
89
90 Set *CSolver::createRangeSet(VarType type, uint64_t lowrange, uint64_t highrange) {
91         Set *set = new Set(type, lowrange, highrange);
92         allSets.push(set);
93         return set;
94 }
95
96 Element *CSolver::createRangeVar(VarType type, uint64_t lowrange, uint64_t highrange) {
97         Set *s = createRangeSet(type, lowrange, highrange);
98         return getElementVar(s);
99 }
100
101 MutableSet *CSolver::createMutableSet(VarType type) {
102         MutableSet *set = new MutableSet(type);
103         allSets.push(set);
104         return set;
105 }
106
107 void CSolver::addItem(MutableSet *set, uint64_t element) {
108         set->addElementMSet(element);
109 }
110
111 uint64_t CSolver::createUniqueItem(MutableSet *set) {
112         uint64_t element = set->getNewUniqueItem();
113         set->addElementMSet(element);
114         return element;
115 }
116
117 Element *CSolver::getElementVar(Set *set) {
118         Element *element = new ElementSet(set);
119         allElements.push(element);
120         return element;
121 }
122
123 Element *CSolver::getElementConst(VarType type, uint64_t value) {
124         uint64_t array[] = {value};
125         Set *set = new Set(type, array, 1);
126         Element *element = new ElementConst(value, type, set);
127         Element *e = elemMap.get(element);
128         if (e == NULL) {
129                 allSets.push(set);
130                 allElements.push(element);
131                 elemMap.put(element, element);
132                 return element;
133         } else {
134                 delete set;
135                 delete element;
136                 return e;
137         }
138 }
139
140 Element *CSolver::applyFunction(Function *function, Element **array, uint numArrays, Boolean *overflowstatus) {
141         Element *element = new ElementFunction(function,array,numArrays,overflowstatus);
142         Element *e = elemMap.get(element);
143         if (e == NULL) {
144                 allElements.push(element);
145                 elemMap.put(element, element);
146                 return element;
147         } else {
148                 delete element;
149                 return e;
150         }
151 }
152
153 Function *CSolver::createFunctionOperator(ArithOp op, Set **domain, uint numDomain, Set *range,OverFlowBehavior overflowbehavior) {
154         Function *function = new FunctionOperator(op, domain, numDomain, range, overflowbehavior);
155         allFunctions.push(function);
156         return function;
157 }
158
159 Predicate *CSolver::createPredicateOperator(CompOp op, Set **domain, uint numDomain) {
160         Predicate *predicate = new PredicateOperator(op, domain,numDomain);
161         allPredicates.push(predicate);
162         return predicate;
163 }
164
165 Predicate *CSolver::createPredicateTable(Table *table, UndefinedBehavior behavior) {
166         Predicate *predicate = new PredicateTable(table, behavior);
167         allPredicates.push(predicate);
168         return predicate;
169 }
170
171 Table *CSolver::createTable(Set **domains, uint numDomain, Set *range) {
172         Table *table = new Table(domains,numDomain,range);
173         allTables.push(table);
174         return table;
175 }
176
177 Table *CSolver::createTableForPredicate(Set **domains, uint numDomain) {
178         return createTable(domains, numDomain, NULL);
179 }
180
181 void CSolver::addTableEntry(Table *table, uint64_t *inputs, uint inputSize, uint64_t result) {
182         table->addNewTableEntry(inputs, inputSize, result);
183 }
184
185 Function *CSolver::completeTable(Table *table, UndefinedBehavior behavior) {
186         Function *function = new FunctionTable(table, behavior);
187         allFunctions.push(function);
188         return function;
189 }
190
191 Boolean *CSolver::getBooleanVar(VarType type) {
192         Boolean *boolean = new BooleanVar(type);
193         allBooleans.push(boolean);
194         return boolean;
195 }
196
197 Boolean *CSolver::getBooleanTrue() {
198         return boolTrue;
199 }
200
201 Boolean *CSolver::getBooleanFalse() {
202         return boolFalse;
203 }
204
205 Boolean *CSolver::applyPredicate(Predicate *predicate, Element **inputs, uint numInputs) {
206         return applyPredicateTable(predicate, inputs, numInputs, NULL);
207 }
208
209 Boolean *CSolver::applyPredicateTable(Predicate *predicate, Element **inputs, uint numInputs, Boolean *undefinedStatus) {
210         BooleanPredicate *boolean = new BooleanPredicate(predicate, inputs, numInputs, undefinedStatus);
211         Boolean * b = boolMap.get(boolean);
212         if (b == NULL) {
213                 boolMap.put(boolean, boolean);
214                 allBooleans.push(boolean);
215                 return boolean;
216         } else {
217                 delete boolean;
218                 return b;
219         }
220 }
221
222 bool CSolver::isTrue(Boolean *b) {
223         return b->isTrue();
224 }
225
226 bool CSolver::isFalse(Boolean *b) {
227         return b->isFalse();
228 }
229
230 Boolean *CSolver::applyLogicalOperation(LogicOp op, Boolean * arg1, Boolean * arg2) {
231         Boolean * array[] = {arg1, arg2};
232         return applyLogicalOperation(op, array, 2);
233 }
234
235 Boolean *CSolver::applyLogicalOperation(LogicOp op, Boolean *arg) {
236         Boolean * array[] = {arg};
237         return applyLogicalOperation(op, array, 1);
238 }
239
240
241 Boolean *CSolver::applyLogicalOperation(LogicOp op, Boolean **array, uint asize) {
242         Boolean * newarray[asize];
243         switch(op) {
244         case SATC_NOT: {
245                 if (array[0]->type == LOGICOP && ((BooleanLogic *)array[0])->op==SATC_NOT) {
246                         return ((BooleanLogic *) array[0])->inputs.get(0);
247                 } else if (array[0]->type == BOOLCONST) {
248                         return array[0]->isTrue() ? boolFalse : boolTrue;
249                 }
250                 break;
251         }
252         case SATC_XOR: {
253                 for(uint i=0;i<2;i++) {
254                         if (array[i]->type == BOOLCONST) {
255                                 if (array[i]->isTrue()) {
256                                         newarray[0]=array[1-i];
257                                         return applyLogicalOperation(SATC_NOT, newarray, 1);
258                                 } else
259                                         return array[1-i];
260                         }
261                 }
262                 break;
263         }
264         case SATC_OR: {
265                 uint newindex=0;
266                 for(uint i=0;i<asize;i++) {
267                         Boolean *b=array[i];
268                         if (b->type == BOOLCONST) {
269                                 if (b->isTrue())
270                                         return b;
271                                 else
272                                         continue;
273                         } else
274                                 newarray[newindex++]=b;
275                 }
276                 if (newindex==1)
277                         return newarray[0];
278                 else if (newindex == 2) {
279                         bool isNot0 = (newarray[0]->type==BOOLCONST) && ((BooleanLogic *)newarray[0])->op == SATC_NOT;
280                         bool isNot1 = (newarray[1]->type==BOOLCONST) && ((BooleanLogic *)newarray[1])->op == SATC_NOT;
281
282                         if (isNot0 != isNot1) {
283                                 if (isNot0) {
284                                         newarray[0] = ((BooleanLogic *) newarray[0])->inputs.get(0);
285                                 } else {
286                                         Boolean *tmp =  ((BooleanLogic *) array[1])->inputs.get(0);
287                                         array[1] = array[0];
288                                         array[0] = tmp;
289                                 }
290                                 return applyLogicalOperation(SATC_IMPLIES, newarray, 2);
291                         }
292                 } else {
293                         array = newarray;
294                         asize = newindex;
295                 }
296                 break;
297         }
298         case SATC_AND: {
299                 uint newindex=0;
300                 for(uint i=0;i<asize;i++) {
301                         Boolean *b=array[i];
302                         if (b->type == BOOLCONST) {
303                                 if (b->isTrue())
304                                         continue;
305                                 else
306                                         return b;
307                         } else
308                                 newarray[newindex++]=b;
309                 }
310                 if(newindex==1) {
311                         return newarray[0];
312                 } else {
313                         array = newarray;
314                         asize = newindex;
315                 }
316                 break;
317         }
318         case SATC_IMPLIES: {
319                 if (array[0]->type == BOOLCONST) {
320                         if (array[0]->isTrue()) {
321                                 return array[1];
322                         } else {
323                                 return boolTrue;
324                         }
325                 } else if (array[1]->type == BOOLCONST) {
326                         if (array[1]->isTrue()) {
327                                 return array[1];
328                         } else {
329                                 return applyLogicalOperation(SATC_NOT, array, 1);
330                         }
331                 }
332                 break;
333         }
334         }
335         
336         Boolean *boolean = new BooleanLogic(this, op, array, asize);
337         Boolean *b = boolMap.get(boolean);
338         if (b == NULL) {
339                 boolMap.put(boolean, boolean);
340                 allBooleans.push(boolean);
341                 return boolean;         
342         } else {
343                 delete boolean;
344                 return b;
345         }
346 }
347
348 Boolean *CSolver::orderConstraint(Order *order, uint64_t first, uint64_t second) {
349         Boolean *constraint = new BooleanOrder(order, first, second);
350         allBooleans.push(constraint);
351         return constraint;
352 }
353
354 void CSolver::addConstraint(Boolean *constraint) {
355         if (constraint == boolTrue)
356                 return;
357         else if (constraint == boolFalse)
358                 setUnSAT();
359         else
360                 constraints.add(constraint);
361 }
362
363 Order *CSolver::createOrder(OrderType type, Set *set) {
364         Order *order = new Order(type, set);
365         allOrders.push(order);
366         return order;
367 }
368
369 int CSolver::startEncoding() {
370         bool deleteTuner = false;
371         if (tuner == NULL) {
372                 tuner = new DefaultTuner();
373                 deleteTuner = true;
374         }
375                 
376         long long startTime = getTimeNano();
377         computePolarities(this);
378         orderAnalysis(this);
379         naiveEncodingDecision(this);
380         satEncoder->encodeAllSATEncoder(this);
381         int result = unsat ? IS_UNSAT : satEncoder->solve();
382         long long finishTime = getTimeNano();
383         elapsedTime = finishTime - startTime;
384         if (deleteTuner) {
385                 delete tuner;
386                 tuner = NULL;
387         }
388         return result;
389 }
390
391 uint64_t CSolver::getElementValue(Element *element) {
392         switch (element->type) {
393         case ELEMSET:
394         case ELEMCONST:
395         case ELEMFUNCRETURN:
396                 return getElementValueSATTranslator(this, element);
397         default:
398                 ASSERT(0);
399         }
400         exit(-1);
401 }
402
403 bool CSolver::getBooleanValue(Boolean *boolean) {
404         switch (boolean->type) {
405         case BOOLEANVAR:
406                 return getBooleanVariableValueSATTranslator(this, boolean);
407         default:
408                 ASSERT(0);
409         }
410         exit(-1);
411 }
412
413 HappenedBefore CSolver::getOrderConstraintValue(Order *order, uint64_t first, uint64_t second) {
414         return getOrderConstraintValueSATTranslator(this, order, first, second);
415 }
416
417 long long CSolver::getEncodeTime() { return satEncoder->getEncodeTime(); }
418
419 long long CSolver::getSolveTime() { return satEncoder->getSolveTime(); }
420
421 void CSolver::autoTune(uint budget) {
422         AutoTuner * autotuner=new AutoTuner(budget);
423         autotuner->addProblem(this);
424         autotuner->tune();
425         delete autotuner;
426 }