8 # include <ctype.h> /* for isdigit */
9 # include "lclintMacros.nf"
11 # include "cgrammar.h"
12 # include "cgrammar_tokens.h"
14 # include "exprChecks.h"
15 # include "aliasChecks.h"
16 # include "exprNodeSList.h"
17 //# include "exprData.i"
20 /*@access constraint, exprNode @*/
23 constraint inequalitySubstituteUnsound (constraint c, constraintList p);
25 static constraint constraint_searchandreplace (constraint c, constraintExpr old, constraintExpr new);
26 //bool rangeCheck (arithType ar1, constraintExpr expr1, arithType ar2, constraintExpr expr2);
27 //bool satifies (constraint pre, constraint post);
28 //bool resolve (constraint c, constraintList p);
29 //constraintList reflectChangesEnsures (constraintList pre2, constraintList post1);
30 //constraint constraint_simplify (constraint c);
32 //constraintList constraintList_fixConflicts (constraintList list1, constraintList list2);
34 //constraintList constraintList_subsumeEnsures (constraintList list1, constraintList list2);
36 //constraintList constraintList_mergeEnsures (constraintList list1, constraintList list2);
37 constraint inequalitySubstitute (constraint c, constraintList p);
39 /*********************************************/
42 constraintList constraintList_mergeEnsures (constraintList list1, constraintList list2)
47 //ret = constraintList_makeNew();
49 llassert(constraintList_isDefined(list1) );
50 llassert(constraintList_isDefined(list1) );
52 DPRINTF(( message ("constraintList_mergeEnsures: list1 %s list2 %s",
53 constraintList_print(list1), constraintList_print(list2)
56 ret = constraintList_fixConflicts (list1, list2);
57 ret = reflectChangesEnsures (ret, list2);
58 ret = constraintList_subsumeEnsures (ret, list2);
59 list2 = constraintList_subsumeEnsures (list2, ret);
60 temp = constraintList_copy(list2);
62 temp = constraintList_addList (temp, ret);
64 DPRINTF(( message ("constraintList_mergeEnsures: returning %s ",
65 constraintList_print(temp) )
70 //ret = constraintList_addList (ret, list2);
74 constraintList constraintList_mergeRequires (constraintList list1, constraintList list2)
79 DPRINTF((message ("constraintList_mergeRequires: merging %s and %s ", constraintList_print (list1), constraintList_print(list2) ) ) );
81 /* get constraints in list1 not satified by list2 */
82 temp = reflectChanges (list1, list2);
83 DPRINTF((message ("constraintList_mergeRequires: temp = %s", constraintList_print(temp) ) ) );
85 /*get constraints in list2 not satified by temp*/
86 ret = reflectChanges (list2, temp);
88 DPRINTF((message ("constraintList_mergeRequires: ret = %s", constraintList_print(ret) ) ) );
90 ret = constraintList_addList (ret, temp);
92 DPRINTF((message ("constraintList_mergeRequires: returning %s", constraintList_print(ret) ) ) );
97 void checkArgumentList (exprNode temp, exprNodeList arglist, fileloc sequencePoint)
99 temp->requiresConstraints = constraintList_makeNew();
100 temp->ensuresConstraints = constraintList_makeNew();
101 temp->trueEnsuresConstraints = constraintList_makeNew();
102 temp->falseEnsuresConstraints = constraintList_makeNew();
104 exprNodeList_elements (arglist, el)
106 exprNode_exprTraverse (el, FALSE, FALSE, sequencePoint);
107 el->requiresConstraints = exprNode_traversRequiresConstraints(el);
108 el->ensuresConstraints = exprNode_traversEnsuresConstraints(el);
110 temp->requiresConstraints = constraintList_addList(temp->requiresConstraints,
111 el->requiresConstraints);
113 temp->ensuresConstraints = constraintList_addList(temp->ensuresConstraints,
114 el->ensuresConstraints);
116 end_exprNodeList_elements;
120 constraintList checkCall (exprNode fcn, exprNodeList arglist)
122 constraintList preconditions;
124 DPRINTF ( (message ("Got call that %s ( %s) ", exprNode_unparse(fcn), exprNodeList_unparse (arglist ) ) ) );
126 temp = exprNode_getUentry (fcn);
128 preconditions = uentry_getFcnPreconditions (temp);
132 preconditions = constraintList_copy(preconditions);
133 preconditions= constraintList_togglePost (preconditions);
134 preconditions = constraintList_doSRefFixConstraintParam (preconditions, arglist);
138 preconditions = constraintList_makeNew();
141 return preconditions;
144 constraintList getPostConditions (exprNode fcn, exprNodeList arglist, exprNode fcnCall)
146 constraintList postconditions;
148 DPRINTF ( (message ("Got call that %s ( %s) ", exprNode_unparse(fcn), exprNodeList_unparse (arglist ) ) ) );
150 temp = exprNode_getUentry (fcn);
152 postconditions = uentry_getFcnPostconditions (temp);
156 postconditions = constraintList_copy(postconditions);
157 postconditions = constraintList_doFixResult (postconditions, fcnCall);
158 postconditions = constraintList_doSRefFixConstraintParam (postconditions, arglist);
162 postconditions = constraintList_makeNew();
165 return postconditions;
168 void mergeResolve (exprNode parent, exprNode child1, exprNode child2)
172 DPRINTF( (message ("magically merging constraint into parent:%s for", exprNode_unparse (parent) )));
174 DPRINTF( (message (" children: %s and %s", exprNode_unparse (child1), exprNode_unparse(child2) ) ) );
176 if (exprNode_isError (child1) || exprNode_isError(child2) )
178 if (exprNode_isError (child1) && !exprNode_isError(child2) )
180 parent->requiresConstraints = constraintList_copy (child2->requiresConstraints);
181 parent->ensuresConstraints = constraintList_copy (child2->ensuresConstraints);
182 DPRINTF((message ("Copied child constraints: pre: %s and post: %s",
183 constraintList_print( child2->requiresConstraints),
184 constraintList_print (child2->ensuresConstraints)
191 llassert(exprNode_isError(child2) );
192 parent->requiresConstraints = constraintList_makeNew();
193 parent->ensuresConstraints = constraintList_makeNew();
198 llassert(!exprNode_isError (child1) && ! exprNode_isError(child2) );
200 DPRINTF( (message ("Child constraints are %s %s and %s %s",
201 constraintList_print (child1->requiresConstraints),
202 constraintList_print (child1->ensuresConstraints),
203 constraintList_print (child2->requiresConstraints),
204 constraintList_print (child2->ensuresConstraints)
207 parent->requiresConstraints = constraintList_makeNew();
208 parent->ensuresConstraints = constraintList_makeNew();
210 parent->requiresConstraints = constraintList_copy (child1->requiresConstraints);
212 if ( context_getFlag (FLG_ORCONSTRAINT) )
213 temp = reflectChangesOr (child2->requiresConstraints, child1->ensuresConstraints);
215 temp = reflectChanges (child2->requiresConstraints, child1->ensuresConstraints);
217 parent->requiresConstraints = constraintList_mergeRequires (parent->requiresConstraints, temp);
219 parent->ensuresConstraints = constraintList_mergeEnsures(child1->ensuresConstraints,
220 child2->ensuresConstraints);
222 DPRINTF( (message ("Parent constraints are %s and %s ",
223 constraintList_print (parent->requiresConstraints),
224 constraintList_print (parent->ensuresConstraints)
232 constraintList constraintList_subsumeEnsures (constraintList list1, constraintList list2)
235 ret = constraintList_makeNew();
236 constraintList_elements (list1, el)
239 DPRINTF ((message ("Examining %s", constraint_print (el) ) ) );
240 if (!resolve (el, list2) )
242 ret = constraintList_add (ret, el);
246 DPRINTF ( (message ("Subsuming %s", constraint_print (el) ) ) );
248 } end_constraintList_elements;
254 /* tries to resolve constraints in list pre2 using post1 */
255 constraintList reflectChanges (constraintList pre2, constraintList post1)
260 ret = constraintList_makeNew();
261 DPRINTF((message ("reflectChanges: lists %s and %s", constraintList_print(pre2), constraintList_print(post1) )));
263 constraintList_elements (pre2, el)
265 if (!resolve (el, post1) )
267 temp = substitute (el, post1);
268 if (!resolve (temp, post1) )
270 // try inequality substitution
273 // the inequality substitution may cause us to lose information
274 //so we don't want to store the result but we do it anyway
275 temp2 = constraint_copy (temp);
276 // if (context_getFlag (FLG_ORCONSTRAINT) )
277 temp2 = inequalitySubstitute (temp, post1);
278 if (!resolve (temp2, post1) )
280 temp2 = inequalitySubstituteUnsound (temp2, post1);
281 if (!resolve (temp2, post1) )
282 ret = constraintList_add (ret, temp2);
286 } end_constraintList_elements;
288 DPRINTF((message ("reflectChanges: returning %s", constraintList_print(ret) ) ) );
293 constraint constraint_addOr (constraint orig, constraint or)
298 DPRINTF((message("constraint_addor: oring %s onto %s", constraint_printOr(or), constraint_printOr(orig) ) ));
300 while (c->or != NULL)
304 c->or = constraint_copy(or);
306 DPRINTF((message("constraint_addor: returning %s",constraint_printOr(orig) ) ));
312 bool resolveOr (constraint c, constraintList list)
316 DPRINTF(( message("resolveOr: constraint %s and list %s", constraint_printOr(c), constraintList_print(list) ) ));
321 if (resolve (temp, list) )
325 while (constraint_isDefined(temp));
331 constraint doResolve (constraint c, constraintList post1, bool * resolved)
335 if (!resolveOr (c, post1) )
337 temp = substitute (c, post1);
338 if (!resolveOr (temp, post1) )
340 // try inequality substitution
343 // the inequality substitution may cause us to lose information
344 //so we don't want to store the result but we do it anyway
345 temp2 = constraint_copy (c);
346 // if (context_getFlag (FLG_ORCONSTRAINT) )
347 temp2 = inequalitySubstitute (temp2, post1);
348 if (!resolveOr (temp2, post1) )
350 temp2 = inequalitySubstituteUnsound (temp2, post1);
351 if (!resolveOr (temp2, post1) )
353 if (!constraint_same (temp, temp2) )
354 temp = constraint_addOr (temp, temp2);
369 constraint doResolveOr (constraint c, constraintList post1, /*@out@*/bool * resolved)
376 ret = constraint_copy(c);
380 ret = doResolve (ret, post1, resolved);
387 curr = doResolve (curr, post1, resolved);
391 ret = constraint_addOr (ret, curr);
401 /* tries to resolve constraints in list pr2 using post1 */
402 constraintList reflectChangesOr (constraintList pre2, constraintList post1)
407 ret = constraintList_makeNew();
408 DPRINTF((message ("reflectChangesOr: lists %s and %s", constraintList_print(pre2), constraintList_print(post1) )));
410 constraintList_elements (pre2, el)
412 temp = doResolveOr (el, post1, &resolved);
416 ret = constraintList_add(ret, temp);
418 } end_constraintList_elements;
420 DPRINTF((message ("reflectChangesOr: returning %s", constraintList_print(ret) ) ) );
424 constraintList reflectChangesEnsures (constraintList pre2, constraintList post1)
428 ret = constraintList_makeNew();
429 constraintList_elements (pre2, el)
431 if (!resolve (el, post1) )
433 temp = substitute (el, post1);
434 llassert (temp != NULL);
436 if (!resolve (temp, post1) )
437 ret = constraintList_add (ret, temp);
441 DPRINTF ( (message ("Resolved away %s ", constraint_print(el) ) ) );
443 } end_constraintList_elements;
449 bool constraint_conflict (constraint c1, constraint c2)
452 if (constraintExpr_similar(c1->lexpr, c2->lexpr) )
455 if (c1->ar == c2->ar)
457 DPRINTF ( (message ("%s conflicts with %s ", constraint_print (c1), constraint_print(c2) ) ) );
462 DPRINTF ( (message ("%s doesn't conflict with %s ", constraint_print (c1), constraint_print(c2) ) ) );
468 void constraint_fixConflict (constraint good, constraint conflicting)
471 if (conflicting->ar ==EQ )
473 good->expr = constraintExpr_searchandreplace (good->expr, conflicting->lexpr, conflicting->expr);
474 temp = constraint_simplify (good);
475 constraint_overWrite (good, temp);
481 bool conflict (constraint c, constraintList list)
484 constraintList_elements (list, el)
486 if ( constraint_conflict(el, c) )
488 constraint_fixConflict (el, c);
491 } end_constraintList_elements;
497 //check if constraint in list1 and conflict with constraints in List2. If so we
498 //remove form list1 and change list2.
499 constraintList constraintList_fixConflicts (constraintList list1, constraintList list2)
502 ret = constraintList_makeNew();
503 llassert(constraintList_isDefined(list1) );
504 constraintList_elements (list1, el)
506 if (! conflict (el, list2) )
508 ret = constraintList_add (ret, el);
510 } end_constraintList_elements;
517 bool resolve (/*@observer@*/ constraint c, /*@observer@*/ constraintList p)
519 constraintList_elements (p, el)
521 if ( satifies (c, el) )
523 DPRINTF ( (message ("\n%s Satifies %s\n ", constraint_print(el), constraint_print(c) ) ) );
526 DPRINTF ( (message ("\n%s does not satify %s\n ", constraint_print(el), constraint_print(c) ) ) );
528 end_constraintList_elements;
529 DPRINTF ( (message ("no constraints satify %s", constraint_print(c) ) ));
534 /*returns true if constraint post satifies cosntriant pre */
535 bool satifies (constraint pre, constraint post)
537 if (constraint_isAlwaysTrue (pre) )
540 if (!constraintExpr_similar (pre->lexpr, post->lexpr) )
544 if (post->expr == NULL)
550 return rangeCheck (pre->ar, pre->expr, post->ar, post->expr);
553 bool arithType_canResolve (arithType ar1, arithType ar2)
559 if ( (ar2 == GT) || (ar2 == GTE) || (ar2 == EQ) )
573 if ( (ar2 == LT) || (ar2 == LTE) || (ar2 == EQ) )
582 /* We look for constraint which are tautologies */
584 bool constraint_isAlwaysTrue (constraint c)
587 bool /*@unused@*/ lHasConstant, rHasConstant;
588 int /*@unused@*/ lConstant, rConstant;
593 DPRINTF(( message("constraint_IsAlwaysTrue:examining %s", constraint_print(c) ) ));
595 if (constraintExpr_canGetValue(l) && constraintExpr_canGetValue(r) )
598 cmp = constraintExpr_compare (l, r);
619 if (constraintExpr_similar (l,r) )
638 l = constraintExpr_copy (c->lexpr);
639 r = constraintExpr_copy (c->expr);
641 // l = constraintExpr_propagateConstants (l, &lHasConstant, &lConstant);
642 r = constraintExpr_propagateConstants (r, &rHasConstant, &rConstant);
644 if (constraintExpr_similar (l,r) && (rHasConstant ) )
646 DPRINTF(( message("constraint_IsAlwaysTrue: after removing constants %s and %s are similar", constraintExpr_unparse(l), constraintExpr_unparse(r) ) ));
647 DPRINTF(( message("constraint_IsAlwaysTrue: rconstant is %d", rConstant ) ));
651 return (rConstant == 0);
653 return (rConstant > 0);
655 return (rConstant >= 0);
657 return (rConstant <= 0);
659 return (rConstant < 0);
669 DPRINTF(( message("Constraint %s is not always true", constraint_print(c) ) ));
676 bool rangeCheck (arithType ar1, constraintExpr expr1, arithType ar2, constraintExpr expr2)
679 DPRINTF ((message ("Doing Range CHECK %s and %s", constraintExpr_unparse(expr1), constraintExpr_unparse(expr2) ) ));
681 if (! arithType_canResolve (ar1, ar2) )
687 if (constraintExpr_similar (expr1, expr2) )
691 if (! (constraintExpr_canGetValue (expr1) &&
692 constraintExpr_canGetValue (expr2) ) )
694 constraintExpr e1, e2;
698 e1 = constraintExpr_propagateConstants (expr1, &p1, &const1);
700 e2 = constraintExpr_propagateConstants (expr2, &p2, &const2);
703 if (const1 <= const2)
704 if (constraintExpr_similar (e1, e2) )
707 DPRINTF( ("Can't Get value"));
711 if (constraintExpr_compare (expr2, expr1) >= 0)
716 if (constraintExpr_similar (expr1, expr2) )
721 if (constraintExpr_similar (expr1, expr2) )
725 if (! (constraintExpr_canGetValue (expr1) &&
726 constraintExpr_canGetValue (expr2) ) )
728 constraintExpr e1, e2;
732 e1 = constraintExpr_propagateConstants (expr1, &p1, &const1);
734 e2 = constraintExpr_propagateConstants (expr2, &p2, &const2);
737 if (const1 >= const2)
738 if (constraintExpr_similar (e1, e2) )
741 DPRINTF( ("Can't Get value"));
745 if (constraintExpr_compare (expr2, expr1) <= 0)
751 llcontbug((message("Unhandled case in switch: %s", arithType_print(ar1) ) ) );
757 constraint constraint_searchandreplace (constraint c, constraintExpr old, constraintExpr new)
759 DPRINTF (("Doing replace for lexpr") );
760 c->lexpr = constraintExpr_searchandreplace (c->lexpr, old, new);
761 DPRINTF (("Doing replace for expr") );
762 c->expr = constraintExpr_searchandreplace (c->expr, old, new);
766 bool constraint_search (constraint c, constraintExpr old) /*@*/
771 ret = constraintExpr_search (c->lexpr, old);
772 ret = ret || constraintExpr_search (c->expr, old);
776 //adjust file locs and stuff
777 constraint constraint_adjust (constraint substitute, constraint old)
779 fileloc loc1, loc2, loc3;
781 DPRINTF ( (message("Start adjust on %s and %s", constraint_print(substitute),
782 constraint_print(old))
785 loc1 = constraint_getFileloc (old);
787 loc2 = constraintExpr_getFileloc (substitute->lexpr);
789 loc3 = constraintExpr_getFileloc (substitute->expr);
792 // special case of an equality that "contains itself"
793 if (constraintExpr_search (substitute->expr, substitute->lexpr) )
794 if (fileloc_closer (loc1, loc3, loc2))
797 DPRINTF ( (message("Doing adjust on %s", constraint_print(substitute) )
799 temp = substitute->lexpr;
800 substitute->lexpr = substitute->expr;
801 substitute->expr = temp;
802 substitute = constraint_simplify(substitute);
809 /* If function preforms substitutes based on inequality
811 It uses the rule x >= y && b < y ===> x >= b + 1
813 Warning this is sound but throws out information
815 constraint inequalitySubstitute (constraint c, constraintList p)
820 constraintList_elements (p, el)
823 // if (!constraint_conflict (c, el) )
826 constraintExpr temp2;
828 temp = constraint_copy(el);
830 // temp = constraint_adjust(temp, c);
832 if (constraintExpr_same (el->expr, c->expr) )
834 DPRINTF((message ("inequalitySubstitute Replacing %s in %s with %s",
835 constraintExpr_print (c->expr),
836 constraint_print (c),
837 constraintExpr_print (el->expr) )
839 temp2 = constraintExpr_copy (el->lexpr);
840 c->expr = constraintExpr_makeIncConstraintExpr (temp2);
845 end_constraintList_elements;
847 c = constraint_simplify(c);
851 /* This function performs substitutions based on the rule:
852 for a constraint of the form expr1 >= expr2; a < b =>
853 a = b -1 for all a in expr1. This will work in most cases.
855 Like inequalitySubstitute we're throwing away some information
858 constraint inequalitySubstituteUnsound (constraint c, constraintList p)
860 DPRINTF (( message ("Doing inequalitySubstituteUnsound " ) ));
865 constraintList_elements (p, el)
867 DPRINTF (( message ("inequalitySubstituteUnsound examining substituting %s on %s", constraint_print(el), constraint_print(c) ) ));
868 if ( ( el->ar == LTE) || (el->ar == LT) )
869 // if (!constraint_conflict (c, el) )
872 constraintExpr temp2;
874 temp = constraint_copy(el);
876 // temp = constraint_adjust(temp, c);
877 temp2 = constraintExpr_copy (el->expr);
880 temp2 = constraintExpr_makeDecConstraintExpr (temp2);
882 DPRINTF((message ("Replacing %s in %s with %s",
883 constraintExpr_print (el->lexpr),
884 constraintExpr_print (c->lexpr),
885 constraintExpr_print (temp2) ) ));
887 c->lexpr = constraintExpr_searchandreplace (c->lexpr, el->lexpr, temp2);
890 end_constraintList_elements;
892 c = constraint_simplify(c);
896 constraint substitute (constraint c, constraintList p)
900 ret = constraint_copy(c);
901 constraintList_elements (p, el)
904 if (!constraint_conflict (ret, el) )
908 temp = constraint_copy(el);
910 temp = constraint_adjust(temp, ret);
912 DPRINTF((message ("Substituting %s in the constraint %s",
913 constraint_print (temp), constraint_print (ret)
917 ret = constraint_searchandreplace (ret, temp->lexpr, temp->expr);
918 DPRINTF(( message ("The new constraint is %s", constraint_print (ret) ) ));
921 end_constraintList_elements;
923 ret = constraint_simplify(ret);
927 /* we try to do substitutions on each constraint in target using the constraint in sublist*/
929 constraintList constraintList_substitute (constraintList target, constraintList subList)
934 ret = constraintList_makeNew();
936 constraintList_elements(target, el)
938 el = substitute(el, subList);
939 ret = constraintList_add (ret, el);
941 end_constraintList_elements;
946 constraint constraint_solveWithFlag (constraint c, bool *b)
950 if (c->lexpr->kind == binaryexpr)
953 DPRINTF( (message ("Solving %s\n", constraint_print(c) ) ) );
954 c->expr = constraintExpr_solveBinaryExpr (c->lexpr, c->expr);
955 DPRINTF( (message ("Solved and got %s\n", constraint_print(c) ) ) );
960 constraint constraint_solve (constraint c)
962 DPRINTF( (message ("Solving %s\n", constraint_print(c) ) ) );
963 c->expr = constraintExpr_solveBinaryExpr (c->lexpr, c->expr);
964 DPRINTF( (message ("Solved and got %s\n", constraint_print(c) ) ) );
969 static arithType flipAr (arithType ar)
984 llcontbug (message("unexpected value: case not handled"));
989 static constraint constraint_swapLeftRight (constraint c)
992 c->ar = flipAr (c->ar);
996 DPRINTF(("Swaped left and right sides of constraint"));
1002 constraint constraint_simplify (constraint c)
1004 c->lexpr = constraintExpr_simplify (c->lexpr);
1005 c->expr = constraintExpr_simplify (c->expr);
1007 if (c->lexpr->kind == binaryexpr)
1009 c = constraint_solve (c);
1011 c->lexpr = constraintExpr_simplify (c->lexpr);
1012 c->expr = constraintExpr_simplify (c->expr);
1015 if (constraintExpr_isLit(c->lexpr) && (!constraintExpr_isLit(c->expr) ) )
1017 c = constraint_swapLeftRight(c);
1018 /*I don't think this will be an infinate loop*/
1019 c = constraint_simplify(c);
1027 /* returns true if fileloc for term1 is closer to file for term2 than term3*/
1029 bool fileloc_closer (fileloc loc1, fileloc loc2, fileloc loc3)
1032 if (!fileloc_isDefined (loc1) )
1035 if (!fileloc_isDefined (loc2) )
1038 if (!fileloc_isDefined (loc3) )
1044 if (fileloc_equal (loc2, loc3) )
1047 if (fileloc_equal (loc1, loc2) )
1050 if (fileloc_equal (loc1, loc3) )
1053 if ( fileloc_lessthan (loc1, loc2) )
1055 if (fileloc_lessthan (loc2, loc3) )
1057 llassert (fileloc_lessthan (loc1, loc3) );
1066 if ( !fileloc_lessthan (loc1, loc2) )
1068 if (!fileloc_lessthan (loc2, loc3) )
1070 llassert (!fileloc_lessthan (loc1, loc3) );