fixing alloy performance bugs
[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 "decomposeordertransform.h"
15 #include "autotuner.h"
16 #include "astops.h"
17 #include "structs.h"
18 #include "orderresolver.h"
19 #include "integerencoding.h"
20 #include "qsort.h"
21 #include "preprocess.h"
22 #include "serializer.h"
23 #include "deserializer.h"
24 #include "encodinggraph.h"
25 #include "ordergraph.h"
26 #include "orderedge.h"
27 #include "orderanalysis.h"
28 #include "elementopt.h"
29 #include "varorderingopt.h"
30 #include <time.h>
31 #include <stdarg.h>
32 #include "alloyenc.h"
33
34 CSolver::CSolver() :
35         boolTrue(BooleanEdge(new BooleanConst(true))),
36         boolFalse(boolTrue.negate()),
37         unsat(false),
38         booleanVarUsed(false),
39         tuner(NULL),
40         elapsedTime(0),
41         satsolverTimeout(NOTIMEOUT),
42         alloyEncoder(NULL)
43 {
44         satEncoder = new SATEncoder(this);
45 }
46
47 /** This function tears down the solver and the entire AST */
48
49 CSolver::~CSolver() {
50         //serialize();
51         uint size = allBooleans.getSize();
52         for (uint i = 0; i < size; i++) {
53                 delete allBooleans.get(i);
54         }
55
56         size = allSets.getSize();
57         for (uint i = 0; i < size; i++) {
58                 delete allSets.get(i);
59         }
60
61         size = allElements.getSize();
62         for (uint i = 0; i < size; i++) {
63                 Element *el = allElements.get(i);
64                 delete el;
65         }
66
67         size = allTables.getSize();
68         for (uint i = 0; i < size; i++) {
69                 delete allTables.get(i);
70         }
71
72         size = allPredicates.getSize();
73         for (uint i = 0; i < size; i++) {
74                 delete allPredicates.get(i);
75         }
76
77         size = allOrders.getSize();
78         for (uint i = 0; i < size; i++) {
79                 delete allOrders.get(i);
80         }
81         size = allFunctions.getSize();
82         for (uint i = 0; i < size; i++) {
83                 delete allFunctions.get(i);
84         }
85
86         delete boolTrue.getBoolean();
87         delete satEncoder;
88 }
89
90 void CSolver::resetSolver() {
91         //serialize();
92         uint size = allBooleans.getSize();
93         for (uint i = 0; i < size; i++) {
94                 delete allBooleans.get(i);
95         }
96
97         size = allSets.getSize();
98         for (uint i = 0; i < size; i++) {
99                 delete allSets.get(i);
100         }
101
102         size = allElements.getSize();
103         for (uint i = 0; i < size; i++) {
104                 Element *el = allElements.get(i);
105                 delete el;
106         }
107
108         size = allTables.getSize();
109         for (uint i = 0; i < size; i++) {
110                 delete allTables.get(i);
111         }
112
113         size = allPredicates.getSize();
114         for (uint i = 0; i < size; i++) {
115                 delete allPredicates.get(i);
116         }
117
118         size = allOrders.getSize();
119         for (uint i = 0; i < size; i++) {
120                 delete allOrders.get(i);
121         }
122         size = allFunctions.getSize();
123         for (uint i = 0; i < size; i++) {
124                 delete allFunctions.get(i);
125         }
126         delete boolTrue.getBoolean();
127         allBooleans.clear();
128         allSets.clear();
129         allElements.clear();
130         allTables.clear();
131         allPredicates.clear();
132         allOrders.clear();
133         allFunctions.clear();
134         constraints.reset();
135         activeOrders.reset();
136         boolMap.reset();
137         elemMap.reset();
138
139         boolTrue = BooleanEdge(new BooleanConst(true));
140         boolFalse = boolTrue.negate();
141         unsat = false;
142         booleanVarUsed = false;
143         elapsedTime = 0;
144         tuner = NULL;
145         satEncoder->resetSATEncoder();
146
147 }
148
149 CSolver *CSolver::clone() {
150         CSolver *copy = new CSolver();
151         CloneMap map;
152         SetIteratorBooleanEdge *it = getConstraints();
153         while (it->hasNext()) {
154                 BooleanEdge b = it->next();
155                 copy->addConstraint(cloneEdge(copy, &map, b));
156         }
157         delete it;
158         return copy;
159 }
160
161 CSolver *CSolver::deserialize(const char *file) {
162         model_print("deserializing %s ...\n", file);
163         Deserializer deserializer(file);
164         return deserializer.deserialize();
165 }
166
167 void CSolver::serialize() {
168         model_print("serializing ...\n");
169         char buffer[255];
170         long long nanotime = getTimeNano();
171         int numchars = sprintf(buffer, "DUMP%llu", nanotime);
172         Serializer serializer(buffer);
173         SetIteratorBooleanEdge *it = getConstraints();
174         while (it->hasNext()) {
175                 BooleanEdge b = it->next();
176                 serializeBooleanEdge(&serializer, b, true);
177         }
178         delete it;
179 }
180
181 Set *CSolver::createSet(VarType type, uint64_t *elements, uint numelements) {
182         Set *set = new Set(type, elements, numelements);
183         allSets.push(set);
184         return set;
185 }
186
187 Set *CSolver::createRangeSet(VarType type, uint64_t lowrange, uint64_t highrange) {
188         Set *set = new Set(type, lowrange, highrange);
189         allSets.push(set);
190         return set;
191 }
192
193 bool CSolver::itemExistInSet(Set *set, uint64_t item) {
194         return set->exists(item);
195 }
196
197 VarType CSolver::getSetVarType(Set *set) {
198         return set->getType();
199 }
200
201 Element *CSolver::createRangeVar(VarType type, uint64_t lowrange, uint64_t highrange) {
202         Set *s = createRangeSet(type, lowrange, highrange);
203         return getElementVar(s);
204 }
205
206 MutableSet *CSolver::createMutableSet(VarType type) {
207         MutableSet *set = new MutableSet(type);
208         allSets.push(set);
209         return set;
210 }
211
212 void CSolver::addItem(MutableSet *set, uint64_t element) {
213         set->addElementMSet(element);
214 }
215
216 uint64_t CSolver::createUniqueItem(MutableSet *set) {
217         uint64_t element = set->getNewUniqueItem();
218         set->addElementMSet(element);
219         return element;
220 }
221
222 void CSolver::finalizeMutableSet(MutableSet *set) {
223         set->finalize();
224 }
225
226 Element *CSolver::getElementVar(Set *set) {
227         Element *element = new ElementSet(set);
228         allElements.push(element);
229         return element;
230 }
231
232 void CSolver::mustHaveValue(Element *element) {
233         element->anyValue = true;
234 }
235
236 Set *CSolver::getElementRange (Element *element) {
237         return element->getRange();
238 }
239
240
241 Element *CSolver::getElementConst(VarType type, uint64_t value) {
242         uint64_t array[] = {value};
243         Set *set = new Set(type, array, 1);
244         Element *element = new ElementConst(value, set);
245         Element *e = elemMap.get(element);
246         if (e == NULL) {
247                 allSets.push(set);
248                 allElements.push(element);
249                 elemMap.put(element, element);
250                 return element;
251         } else {
252                 delete set;
253                 delete element;
254                 return e;
255         }
256 }
257
258
259 Element *CSolver::applyFunction(Function *function, Element **array, uint numArrays, BooleanEdge overflowstatus) {
260         ASSERT(numArrays == 2);
261         Element *element = new ElementFunction(function,array,numArrays,overflowstatus);
262         Element *e = elemMap.get(element);
263         if (e == NULL) {
264                 element->updateParents();
265                 allElements.push(element);
266                 elemMap.put(element, element);
267                 return element;
268         } else {
269                 delete element;
270                 return e;
271         }
272 }
273
274 Function *CSolver::createFunctionOperator(ArithOp op, Set *range, OverFlowBehavior overflowbehavior) {
275         Function *function = new FunctionOperator(op, range, overflowbehavior);
276         allFunctions.push(function);
277         return function;
278 }
279
280 Predicate *CSolver::createPredicateOperator(CompOp op) {
281         Predicate *predicate = new PredicateOperator(op);
282         allPredicates.push(predicate);
283         return predicate;
284 }
285
286 Predicate *CSolver::createPredicateTable(Table *table, UndefinedBehavior behavior) {
287         Predicate *predicate = new PredicateTable(table, behavior);
288         allPredicates.push(predicate);
289         return predicate;
290 }
291
292 Table *CSolver::createTable(Set *range) {
293         Table *table = new Table(range);
294         allTables.push(table);
295         return table;
296 }
297
298 Table *CSolver::createTableForPredicate() {
299         return createTable(NULL);
300 }
301
302 void CSolver::addTableEntry(Table *table, uint64_t *inputs, uint inputSize, uint64_t result) {
303         table->addNewTableEntry(inputs, inputSize, result);
304 }
305
306 Function *CSolver::completeTable(Table *table, UndefinedBehavior behavior) {
307         Function *function = new FunctionTable(table, behavior);
308         allFunctions.push(function);
309         return function;
310 }
311
312 BooleanEdge CSolver::getBooleanVar(VarType type) {
313         Boolean *boolean = new BooleanVar(type);
314         allBooleans.push(boolean);
315         if(!booleanVarUsed)
316                 booleanVarUsed = true;
317         return BooleanEdge(boolean);
318 }
319
320 BooleanEdge CSolver::getBooleanTrue() {
321         return boolTrue;
322 }
323
324 BooleanEdge CSolver::getBooleanFalse() {
325         return boolFalse;
326 }
327
328 BooleanEdge CSolver::applyPredicate(Predicate *predicate, Element **inputs, uint numInputs) {
329         return applyPredicateTable(predicate, inputs, numInputs, BooleanEdge(NULL));
330 }
331
332 BooleanEdge CSolver::applyPredicateTable(Predicate *predicate, Element **inputs, uint numInputs, BooleanEdge undefinedStatus) {
333         BooleanPredicate *boolean = new BooleanPredicate(predicate, inputs, numInputs, undefinedStatus);
334         Boolean *b = boolMap.get(boolean);
335         if (b == NULL) {
336                 boolean->updateParents();
337                 boolMap.put(boolean, boolean);
338                 allBooleans.push(boolean);
339                 return BooleanEdge(boolean);
340         } else {
341                 delete boolean;
342                 return BooleanEdge(b);
343         }
344 }
345
346 bool CSolver::isTrue(BooleanEdge b) {
347         return b.isNegated() ? b->isFalse() : b->isTrue();
348 }
349
350 bool CSolver::isFalse(BooleanEdge b) {
351         return b.isNegated() ? b->isTrue() : b->isFalse();
352 }
353
354 BooleanEdge CSolver::applyLogicalOperation(LogicOp op, BooleanEdge arg1, BooleanEdge arg2) {
355         BooleanEdge array[] = {arg1, arg2};
356         return applyLogicalOperation(op, array, 2);
357 }
358
359 BooleanEdge CSolver::applyLogicalOperation(LogicOp op, BooleanEdge arg) {
360         BooleanEdge array[] = {arg};
361         return applyLogicalOperation(op, array, 1);
362 }
363
364 static int booleanEdgeCompares(const void *p1, const void *p2) {
365         BooleanEdge be1 = *(BooleanEdge const *) p1;
366         BooleanEdge be2 = *(BooleanEdge const *) p2;
367         uint64_t b1 = be1->id;
368         uint64_t b2 = be2->id;
369         if (b1 < b2)
370                 return -1;
371         else if (b1 == b2)
372                 return 0;
373         else
374                 return 1;
375 }
376
377 BooleanEdge CSolver::rewriteLogicalOperation(LogicOp op, BooleanEdge *array, uint asize) {
378         BooleanEdge newarray[asize];
379         memcpy(newarray, array, asize * sizeof(BooleanEdge));
380         for (uint i = 0; i < asize; i++) {
381                 BooleanEdge b = newarray[i];
382                 if (b->type == LOGICOP) {
383                         if (((BooleanLogic *) b.getBoolean())->replaced) {
384                                 newarray[i] = doRewrite(newarray[i]);
385                                 i--;//Check again
386                         }
387                 }
388         }
389         return applyLogicalOperation(op, newarray, asize);
390 }
391
392 BooleanEdge CSolver::applyLogicalOperation(LogicOp op, BooleanEdge *array, uint asize) {
393         BooleanEdge newarray[asize];
394         switch (op) {
395         case SATC_NOT: {
396                 return array[0].negate();
397         }
398         case SATC_IFF: {
399                 for (uint i = 0; i < 2; i++) {
400                         if (isTrue(array[i])) { // It can be undefined
401                                 return array[1 - i];
402                         } else if (isFalse(array[i])) {
403                                 newarray[0] = array[1 - i];
404                                 return applyLogicalOperation(SATC_NOT, newarray, 1);
405                         } else if (array[i]->type == LOGICOP) {
406                                 BooleanLogic *b = (BooleanLogic *)array[i].getBoolean();
407                                 if (b->replaced) {
408                                         return rewriteLogicalOperation(op, array, asize);
409                                 }
410                         }
411                 }
412                 break;
413         }
414         case SATC_OR: {
415                 for (uint i = 0; i < asize; i++) {
416                         newarray[i] = applyLogicalOperation(SATC_NOT, array[i]);
417                 }
418                 return applyLogicalOperation(SATC_NOT, applyLogicalOperation(SATC_AND, newarray, asize));
419         }
420         case SATC_AND: {
421                 uint newindex = 0;
422                 for (uint i = 0; i < asize; i++) {
423                         BooleanEdge b = array[i];
424                         if (b->type == LOGICOP) {
425                                 if (((BooleanLogic *)b.getBoolean())->replaced)
426                                         return rewriteLogicalOperation(op, array, asize);
427                         }
428                         if (isTrue(b))
429                                 continue;
430                         else if (isFalse(b)) {
431                                 return boolFalse;
432                         } else
433                                 newarray[newindex++] = b;
434                 }
435                 if (newindex == 0) {
436                         return boolTrue;
437                 } else if (newindex == 1) {
438                         return newarray[0];
439                 } else {
440                         bsdqsort(newarray, newindex, sizeof(BooleanEdge), booleanEdgeCompares);
441                         array = newarray;
442                         asize = newindex;
443                 }
444                 break;
445         }
446         case SATC_XOR: {
447                 //handle by translation
448                 return applyLogicalOperation(SATC_NOT, applyLogicalOperation(SATC_IFF, array, asize));
449         }
450         case SATC_IMPLIES: {
451                 //handle by translation
452                 return applyLogicalOperation(SATC_OR, applyLogicalOperation(SATC_NOT, array[0]), array[1]);
453         }
454         }
455
456         ASSERT(asize != 0);
457         Boolean *boolean = new BooleanLogic(this, op, array, asize);
458         Boolean *b = boolMap.get(boolean);
459         if (b == NULL) {
460                 boolean->updateParents();
461                 boolMap.put(boolean, boolean);
462                 allBooleans.push(boolean);
463                 return BooleanEdge(boolean);
464         } else {
465                 delete boolean;
466                 return BooleanEdge(b);
467         }
468 }
469
470 BooleanEdge CSolver::orderConstraint(Order *order, uint64_t first, uint64_t second) {
471         //      ASSERT(first != second);
472         if (first == second)
473                 return getBooleanFalse();
474
475         bool negate = false;
476         if (order->type == SATC_TOTAL) {
477                 if (first > second) {
478                         uint64_t tmp = first;
479                         first = second;
480                         second = tmp;
481                         negate = true;
482                 }
483         }
484         Boolean *constraint = new BooleanOrder(order, first, second);
485         Boolean *b = boolMap.get(constraint);
486
487         if (b == NULL) {
488                 allBooleans.push(constraint);
489                 boolMap.put(constraint, constraint);
490                 constraint->updateParents();
491                 if (order->graph != NULL) {
492                         OrderGraph *graph = order->graph;
493                         OrderNode *from = graph->lookupOrderNodeFromOrderGraph(first);
494                         if (from != NULL) {
495                                 OrderNode *to = graph->lookupOrderNodeFromOrderGraph(second);
496                                 if (to != NULL) {
497                                         OrderEdge *edge = graph->lookupOrderEdgeFromOrderGraph(from, to);
498                                         OrderEdge *invedge;
499
500                                         if (edge != NULL && edge->mustPos) {
501                                                 replaceBooleanWithTrueNoRemove(constraint);
502                                         } else if (edge != NULL && edge->mustNeg) {
503                                                 replaceBooleanWithFalseNoRemove(constraint);
504                                         } else if ((invedge = graph->lookupOrderEdgeFromOrderGraph(to, from)) != NULL
505                                                                                  && invedge->mustPos) {
506                                                 replaceBooleanWithFalseNoRemove(constraint);
507                                         }
508                                 }
509                         }
510                 }
511         } else {
512                 delete constraint;
513                 constraint = b;
514         }
515
516         BooleanEdge be = BooleanEdge(constraint);
517         return negate ? be.negate() : be;
518 }
519
520 void CSolver::addConstraint(BooleanEdge constraint) {
521         if (isTrue(constraint))
522                 return;
523         else if (isFalse(constraint)) {
524                 setUnSAT();
525         }
526         else {
527                 if (constraint->type == LOGICOP) {
528                         BooleanLogic *b = (BooleanLogic *) constraint.getBoolean();
529                         if (!constraint.isNegated()) {
530                                 if (b->op == SATC_AND) {
531                                         uint size = b->inputs.getSize();
532                                         //Handle potential concurrent modification
533                                         BooleanEdge array[size];
534                                         for (uint i = 0; i < size; i++) {
535                                                 array[i] = b->inputs.get(i);
536                                         }
537                                         for (uint i = 0; i < size; i++) {
538                                                 addConstraint(array[i]);
539                                         }
540                                         return;
541                                 }
542                         }
543                         if (b->replaced) {
544                                 addConstraint(doRewrite(constraint));
545                                 return;
546                         }
547                 }
548                 constraints.add(constraint);
549                 Boolean *ptr = constraint.getBoolean();
550
551                 if (ptr->boolVal == BV_UNSAT) {
552                         setUnSAT();
553                 }
554
555                 replaceBooleanWithTrueNoRemove(constraint);
556                 constraint->parents.clear();
557         }
558 }
559
560 Order *CSolver::createOrder(OrderType type, Set *set) {
561         Order *order = new Order(type, set);
562         allOrders.push(order);
563         activeOrders.add(order);
564         return order;
565 }
566
567 /** Computes static ordering information to allow isTrue/isFalse
568     queries on newly created orders to work. */
569
570 void CSolver::inferFixedOrder(Order *order) {
571         if (order->graph != NULL) {
572                 delete order->graph;
573         }
574         order->graph = buildMustOrderGraph(order);
575         reachMustAnalysis(this, order->graph, true);
576 }
577
578 void CSolver::inferFixedOrders() {
579         SetIteratorOrder *orderit = activeOrders.iterator();
580         while (orderit->hasNext()) {
581                 Order *order = orderit->next();
582                 inferFixedOrder(order);
583         }
584 }
585
586 int CSolver::solve() {
587         long long startTime = getTimeNano();
588         bool deleteTuner = false;
589         if (tuner == NULL) {
590                 tuner = new DefaultTuner();
591                 deleteTuner = true;
592         }
593
594
595         {
596                 SetIteratorOrder *orderit = activeOrders.iterator();
597                 while (orderit->hasNext()) {
598                         Order *order = orderit->next();
599                         if (order->graph != NULL) {
600                                 delete order->graph;
601                                 order->graph = NULL;
602                         }
603                 }
604                 delete orderit;
605         }
606         computePolarities(this);
607         long long time1 = getTimeNano();
608         model_print("Polarity time: %f\n", (time1 - startTime) / NANOSEC);
609         Preprocess pp(this);
610         pp.doTransform();
611         long long time2 = getTimeNano();
612         model_print("Preprocess time: %f\n", (time2 - time1) / NANOSEC);
613
614         DecomposeOrderTransform dot(this);
615         dot.doTransform();
616         time1 = getTimeNano();
617         model_print("Decompose Order: %f\n", (time1 - time2) / NANOSEC);
618
619         IntegerEncodingTransform iet(this);
620         iet.doTransform();
621
622         ElementOpt eop(this);
623         eop.doTransform();
624
625         EncodingGraph eg(this);
626         eg.encode();
627
628         naiveEncodingDecision(this);
629 //      eg.validate();
630
631         VarOrderingOpt bor(this, satEncoder);
632         bor.doTransform();
633
634         time2 = getTimeNano();
635         model_print("Encoding Graph Time: %f\n", (time2 - time1) / NANOSEC);
636
637         satEncoder->encodeAllSATEncoder(this);
638         time1 = getTimeNano();
639
640         model_print("Elapse Encode time: %f\n", (time1 - startTime) / NANOSEC);
641
642         model_print("Is problem UNSAT after encoding: %d\n", unsat);
643         int result = IS_INDETER;
644         if(alloyEncoder != NULL){
645                 alloyEncoder->encode();
646                 result = alloyEncoder->solve();
647         }else{
648                 result = unsat ? IS_UNSAT : satEncoder->solve(satsolverTimeout);
649                 model_print("Result Computed in SAT solver:\t%s\n", result == IS_SAT ? "SAT" : result == IS_INDETER ? "INDETERMINATE" : " UNSAT");
650                 time2 = getTimeNano();
651                 elapsedTime = time2 - startTime;
652                 model_print("CSOLVER solve time: %f\n", elapsedTime / NANOSEC);
653         }
654         if (deleteTuner) {
655                 delete tuner;
656                 tuner = NULL;
657         }
658         return result;
659 }
660
661 void CSolver::setAlloyEncoder(){
662         alloyEncoder = new AlloyEnc(this);
663 }
664
665 void CSolver::printConstraints() {
666         SetIteratorBooleanEdge *it = getConstraints();
667         while (it->hasNext()) {
668                 BooleanEdge b = it->next();
669                 b.print();
670         }
671         delete it;
672 }
673
674 void CSolver::printConstraint(BooleanEdge b) {
675         b.print();
676 }
677
678 uint64_t CSolver::getElementValue(Element *element) {
679         switch (element->type) {
680         case ELEMSET:
681         case ELEMCONST:
682         case ELEMFUNCRETURN:
683                 return useAlloyCompiler()? alloyEncoder->getValue(element):
684                         getElementValueSATTranslator(this, element);
685         default:
686                 ASSERT(0);
687         }
688         exit(-1);
689 }
690
691 bool CSolver::getBooleanValue(BooleanEdge bedge) {
692         Boolean *boolean = bedge.getBoolean();
693         switch (boolean->type) {
694         case BOOLEANVAR:
695                 return useAlloyCompiler()? alloyEncoder->getBooleanValue(boolean):
696                         getBooleanVariableValueSATTranslator(this, boolean);
697         default:
698                 ASSERT(0);
699         }
700         exit(-1);
701 }
702
703 bool CSolver::getOrderConstraintValue(Order *order, uint64_t first, uint64_t second) {
704         return order->encoding.resolver->resolveOrder(first, second);
705 }
706
707 long long CSolver::getEncodeTime() { return satEncoder->getEncodeTime(); }
708
709 long long CSolver::getSolveTime() { return satEncoder->getSolveTime(); }
710
711 void CSolver::autoTune(uint budget) {
712         AutoTuner *autotuner = new AutoTuner(budget);
713         autotuner->addProblem(this);
714         autotuner->tune();
715         delete autotuner;
716 }
717
718