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 @*/
23 constraint inequalitySubstituteUnsound (constraint c, constraintList p);
25 constraintList reflectChanges (constraintList pre2, constraintList post1);
26 constraint substitute (constraint c, constraintList p);
27 constraint constraint_searchandreplace (constraint c, constraintExpr old, constraintExpr new);
28 bool rangeCheck (arithType ar1, constraintExpr expr1, arithType ar2, constraintExpr expr2);
29 bool satifies (constraint pre, constraint post);
30 bool resolve (constraint c, constraintList p);
31 constraintList reflectChangesEnsures (constraintList pre2, constraintList post1);
32 constraint constraint_simplify (constraint c);
34 constraintList constraintList_fixConflicts (constraintList list1, constraintList list2);
36 constraintList constraintList_subsumeEnsures (constraintList list1, constraintList list2);
38 constraintList constraintList_mergeEnsures (constraintList list1, constraintList list2);
39 constraint inequalitySubstitute (constraint c, constraintList p);
41 /*********************************************/
44 constraintList constraintList_mergeEnsures (constraintList list1, constraintList list2)
49 //ret = constraintList_makeNew();
54 DPRINTF(( message ("constraintList_mergeEnsures: list1 %s list2 %s",
55 constraintList_print(list1), constraintList_print(list2)
58 ret = constraintList_fixConflicts (list1, list2);
59 ret = reflectChangesEnsures (ret, list2);
60 ret = constraintList_subsumeEnsures (ret, list2);
61 list2 = constraintList_subsumeEnsures (list2, ret);
62 temp = constraintList_copy(list2);
64 temp = constraintList_addList (temp, ret);
66 DPRINTF(( message ("constraintList_mergeEnsures: returning %s ",
67 constraintList_print(temp) )
72 //ret = constraintList_addList (ret, list2);
76 constraintList constraintList_mergeRequires (constraintList list1, constraintList list2)
81 DPRINTF((message ("constraintList_mergeRequires: merging %s and %s ", constraintList_print (list1), constraintList_print(list2) ) ) );
83 /* get constraints in list1 not satified by list2 */
84 temp = reflectChanges (list1, list2);
85 DPRINTF((message ("constraintList_mergeRequires: temp = %s", constraintList_print(temp) ) ) );
87 /*get constraints in list2 not satified by temp*/
88 ret = reflectChanges (list2, temp);
90 DPRINTF((message ("constraintList_mergeRequires: ret = %s", constraintList_print(ret) ) ) );
92 ret = constraintList_addList (ret, temp);
94 DPRINTF((message ("constraintList_mergeRequires: returning %s", constraintList_print(ret) ) ) );
99 void checkArgumentList (exprNode temp, exprNodeList arglist, fileloc sequencePoint)
101 temp->requiresConstraints = constraintList_makeNew();
102 temp->ensuresConstraints = constraintList_makeNew();
103 temp->trueEnsuresConstraints = constraintList_makeNew();
104 temp->falseEnsuresConstraints = constraintList_makeNew();
106 exprNodeList_elements (arglist, el)
108 exprNode_exprTraverse (el, FALSE, FALSE, sequencePoint);
109 el->requiresConstraints = exprNode_traversRequiresConstraints(el);
110 el->ensuresConstraints = exprNode_traversEnsuresConstraints(el);
112 temp->requiresConstraints = constraintList_addList(temp->requiresConstraints,
113 el->requiresConstraints);
115 temp->ensuresConstraints = constraintList_addList(temp->ensuresConstraints,
116 el->ensuresConstraints);
118 end_exprNodeList_elements;
122 constraintList checkCall (exprNode fcn, exprNodeList arglist)
124 constraintList preconditions;
126 DPRINTF ( (message ("Got call that %s ( %s) ", exprNode_unparse(fcn), exprNodeList_unparse (arglist ) ) ) );
128 temp = exprNode_getUentry (fcn);
130 preconditions = uentry_getFcnPreconditions (temp);
134 preconditions = constraintList_copy(preconditions);
135 preconditions= constraintList_togglePost (preconditions);
136 preconditions = constraintList_doSRefFixConstraintParam (preconditions, arglist);
140 preconditions = constraintList_makeNew();
143 return preconditions;
146 constraintList getPostConditions (exprNode fcn, exprNodeList arglist, exprNode fcnCall)
148 constraintList postconditions;
150 DPRINTF ( (message ("Got call that %s ( %s) ", exprNode_unparse(fcn), exprNodeList_unparse (arglist ) ) ) );
152 temp = exprNode_getUentry (fcn);
154 postconditions = uentry_getFcnPostconditions (temp);
158 postconditions = constraintList_copy(postconditions);
159 postconditions = constraintList_doFixResult (postconditions, fcnCall);
160 postconditions = constraintList_doSRefFixConstraintParam (postconditions, arglist);
164 postconditions = constraintList_makeNew();
167 return postconditions;
170 void mergeResolve (exprNode parent, exprNode child1, exprNode child2)
174 DPRINTF( (message ("magically merging constraint into parent:%s for", exprNode_unparse (parent) )));
176 DPRINTF( (message (" children: %s and %s", exprNode_unparse (child1), exprNode_unparse(child2) ) ) );
178 if (exprNode_isError (child1) || exprNode_isError(child2) )
180 if (exprNode_isError (child1) && !exprNode_isError(child2) )
182 parent->requiresConstraints = constraintList_copy (child2->requiresConstraints);
183 parent->ensuresConstraints = constraintList_copy (child2->ensuresConstraints);
184 DPRINTF((message ("Copied child constraints: pre: %s and post: %s",
185 constraintList_print( child2->requiresConstraints),
186 constraintList_print (child2->ensuresConstraints)
193 llassert(exprNode_isError(child2) );
194 parent->requiresConstraints = constraintList_makeNew();
195 parent->ensuresConstraints = constraintList_makeNew();
200 llassert(!exprNode_isError (child1) && ! exprNode_isError(child2) );
202 DPRINTF( (message ("Child constraints are %s %s and %s %s",
203 constraintList_print (child1->requiresConstraints),
204 constraintList_print (child1->ensuresConstraints),
205 constraintList_print (child2->requiresConstraints),
206 constraintList_print (child2->ensuresConstraints)
209 parent->requiresConstraints = constraintList_makeNew();
210 parent->ensuresConstraints = constraintList_makeNew();
212 parent->requiresConstraints = constraintList_copy (child1->requiresConstraints);
214 if ( context_getFlag (FLG_ORCONSTRAINT) )
215 temp = reflectChangesOr (child2->requiresConstraints, child1->ensuresConstraints);
217 temp = reflectChanges (child2->requiresConstraints, child1->ensuresConstraints);
219 parent->requiresConstraints = constraintList_mergeRequires (parent->requiresConstraints, temp);
221 parent->ensuresConstraints = constraintList_mergeEnsures(child1->ensuresConstraints,
222 child2->ensuresConstraints);
224 DPRINTF( (message ("Parent constraints are %s and %s ",
225 constraintList_print (parent->requiresConstraints),
226 constraintList_print (parent->ensuresConstraints)
234 constraintList constraintList_subsumeEnsures (constraintList list1, constraintList list2)
237 ret = constraintList_makeNew();
238 constraintList_elements (list1, el)
241 DPRINTF ((message ("Examining %s", constraint_print (el) ) ) );
242 if (!resolve (el, list2) )
244 ret = constraintList_add (ret, el);
248 DPRINTF ( (message ("Subsuming %s", constraint_print (el) ) ) );
250 } end_constraintList_elements;
256 /* tries to resolve constraints in list pre2 using post1 */
257 constraintList reflectChanges (constraintList pre2, constraintList post1)
262 ret = constraintList_makeNew();
263 DPRINTF((message ("reflectChanges: lists %s and %s", constraintList_print(pre2), constraintList_print(post1) )));
265 constraintList_elements (pre2, el)
267 if (!resolve (el, post1) )
269 temp = substitute (el, post1);
270 if (!resolve (temp, post1) )
272 // try inequality substitution
275 // the inequality substitution may cause us to lose information
276 //so we don't want to store the result but we do it anyway
277 temp2 = constraint_copy (temp);
278 // if (context_getFlag (FLG_ORCONSTRAINT) )
279 temp2 = inequalitySubstitute (temp, post1);
280 if (!resolve (temp2, post1) )
282 temp2 = inequalitySubstituteUnsound (temp2, post1);
283 if (!resolve (temp2, post1) )
284 ret = constraintList_add (ret, temp2);
288 } end_constraintList_elements;
290 DPRINTF((message ("reflectChanges: returning %s", constraintList_print(ret) ) ) );
295 constraint constraint_addOr (constraint orig, constraint or)
300 DPRINTF((message("constraint_addor: oring %s onto %s", constraint_printOr(or), constraint_printOr(orig) ) ));
302 while (c->or != NULL)
306 c->or = constraint_copy(or);
308 DPRINTF((message("constraint_addor: returning %s",constraint_printOr(orig) ) ));
314 bool resolveOr (constraint c, constraintList list)
318 DPRINTF(( message("resolveOr: constraint %s and list %s", constraint_printOr(c), constraintList_print(list) ) ));
323 if (resolve (temp, list) )
333 constraint doResolve (constraint c, constraintList post1, bool * resolved)
337 if (!resolveOr (c, post1) )
339 temp = substitute (c, post1);
340 if (!resolveOr (temp, post1) )
342 // try inequality substitution
345 // the inequality substitution may cause us to lose information
346 //so we don't want to store the result but we do it anyway
347 temp2 = constraint_copy (c);
348 // if (context_getFlag (FLG_ORCONSTRAINT) )
349 temp2 = inequalitySubstitute (temp2, post1);
350 if (!resolveOr (temp2, post1) )
352 temp2 = inequalitySubstituteUnsound (temp2, post1);
353 if (!resolveOr (temp2, post1) )
355 if (!constraint_same (temp, temp2) )
356 temp = constraint_addOr (temp, temp2);
371 constraint doResolveOr (constraint c, constraintList post1, bool * resolved)
378 ret = constraint_copy(c);
382 ret = doResolve (ret, post1, resolved);
389 curr = doResolve (curr, post1, resolved);
393 ret = constraint_addOr (ret, curr);
403 /* tries to resolve constraints in list pr2 using post1 */
404 constraintList reflectChangesOr (constraintList pre2, constraintList post1)
409 ret = constraintList_makeNew();
410 DPRINTF((message ("reflectChangesOr: lists %s and %s", constraintList_print(pre2), constraintList_print(post1) )));
412 constraintList_elements (pre2, el)
414 temp = doResolveOr (el, post1, &resolved);
418 ret = constraintList_add(ret, temp);
420 } end_constraintList_elements;
422 DPRINTF((message ("reflectChangesOr: returning %s", constraintList_print(ret) ) ) );
426 constraintList reflectChangesEnsures (constraintList pre2, constraintList post1)
430 ret = constraintList_makeNew();
431 constraintList_elements (pre2, el)
433 if (!resolve (el, post1) )
435 temp = substitute (el, post1);
436 llassert (temp != NULL);
438 if (!resolve (temp, post1) )
439 ret = constraintList_add (ret, temp);
443 DPRINTF ( (message ("Resolved away %s ", constraint_print(el) ) ) );
445 } end_constraintList_elements;
451 bool constraint_conflict (constraint c1, constraint c2)
454 if (constraintExpr_similar(c1->lexpr, c2->lexpr) )
457 if (c1->ar == c2->ar)
459 DPRINTF ( (message ("%s conflicts with %s ", constraint_print (c1), constraint_print(c2) ) ) );
464 DPRINTF ( (message ("%s doesn't conflict with %s ", constraint_print (c1), constraint_print(c2) ) ) );
470 void constraint_fixConflict (constraint good, constraint conflicting)
473 if (conflicting->ar ==EQ )
475 good->expr = constraintExpr_searchandreplace (good->expr, conflicting->lexpr, conflicting->expr);
476 temp = constraint_simplify (good);
477 constraint_overWrite (good, temp);
483 bool conflict (constraint c, constraintList list)
486 constraintList_elements (list, el)
488 if ( constraint_conflict(el, c) )
490 constraint_fixConflict (el, c);
493 } end_constraintList_elements;
499 //check if constraint in list1 and conflict with constraints in List2. If so we
500 //remove form list1 and change list2.
501 constraintList constraintList_fixConflicts (/*@returned@*/constraintList list1, constraintList list2)
504 ret = constraintList_makeNew();
506 constraintList_elements (list1, el)
508 if (! conflict (el, list2) )
510 ret = constraintList_add (ret, el);
512 } end_constraintList_elements;
519 bool resolve (constraint c, constraintList p)
521 constraintList_elements (p, el)
523 if ( satifies (c, el) )
525 DPRINTF ( (message ("\n%s Satifies %s\n ", constraint_print(el), constraint_print(c) ) ) );
528 DPRINTF ( (message ("\n%s does not satify %s\n ", constraint_print(el), constraint_print(c) ) ) );
530 end_constraintList_elements;
531 DPRINTF ( (message ("no constraints satify %s", constraint_print(c) ) ));
536 /*returns true if constraint post satifies cosntriant pre */
537 bool satifies (constraint pre, constraint post)
539 if (constraint_isAlwaysTrue (pre) )
542 if (!constraintExpr_similar (pre->lexpr, post->lexpr) )
546 if (post->expr == NULL)
552 return rangeCheck (pre->ar, pre->expr, post->ar, post->expr);
555 bool arithType_canResolve (arithType ar1, arithType ar2)
561 if ( (ar2 == GT) || (ar2 == GTE) || (ar2 == EQ) )
575 if ( (ar2 == LT) || (ar2 == LTE) || (ar2 == EQ) )
583 /* We look for constraint which are tautologies */
585 bool constraint_isAlwaysTrue (constraint c)
588 bool lHasConstant, rHasConstant;
589 int lConstant, rConstant;
594 DPRINTF(( message("constraint_IsAlwaysTrue:examining %s", constraint_print(c) ) ));
596 if (constraintExpr_canGetValue(l) && constraintExpr_canGetValue(r) )
599 cmp = constraintExpr_compare (l, r);
619 if (constraintExpr_similar (l,r) )
637 l = constraintExpr_copy (c->lexpr);
638 r = constraintExpr_copy (c->expr);
640 // l = constraintExpr_propagateConstants (l, &lHasConstant, &lConstant);
641 r = constraintExpr_propagateConstants (r, &rHasConstant, &rConstant);
643 if (constraintExpr_similar (l,r) && (rHasConstant ) )
645 DPRINTF(( message("constraint_IsAlwaysTrue: after removing constants %s and %s are similar", constraintExpr_unparse(l), constraintExpr_unparse(r) ) ));
646 DPRINTF(( message("constraint_IsAlwaysTrue: rconstant is %d", rConstant ) ));
650 return (rConstant == 0);
652 return (rConstant > 0);
654 return (rConstant >= 0);
656 return (rConstant <= 0);
658 return (rConstant < 0);
667 DPRINTF(( message("Constraint %s is not always true", constraint_print(c) ) ));
674 bool rangeCheck (arithType ar1, constraintExpr expr1, arithType ar2, constraintExpr expr2)
677 DPRINTF ((message ("Doing Range CHECK %s and %s", constraintExpr_unparse(expr1), constraintExpr_unparse(expr2) ) ));
679 if (! arithType_canResolve (ar1, ar2) )
685 if (constraintExpr_similar (expr1, expr2) )
688 if (! (constraintExpr_canGetValue (expr1) &&
689 constraintExpr_canGetValue (expr2) ) )
691 constraintExpr e1, e2;
695 e1 = constraintExpr_propagateConstants (expr1, &p1, &const1);
697 e2 = constraintExpr_propagateConstants (expr2, &p2, &const2);
700 if (const1 <= const2)
701 if (constraintExpr_similar (e1, e2) )
704 DPRINTF( ("Can't Get value"));
708 if (constraintExpr_compare (expr2, expr1) >= 0)
713 if (constraintExpr_similar (expr1, expr2) )
718 if (constraintExpr_similar (expr1, expr2) )
721 if (! (constraintExpr_canGetValue (expr1) &&
722 constraintExpr_canGetValue (expr2) ) )
724 constraintExpr e1, e2;
728 e1 = constraintExpr_propagateConstants (expr1, &p1, &const1);
730 e2 = constraintExpr_propagateConstants (expr2, &p2, &const2);
733 if (const1 >= const2)
734 if (constraintExpr_similar (e1, e2) )
737 DPRINTF( ("Can't Get value"));
741 if (constraintExpr_compare (expr2, expr1) <= 0)
747 llcontbug((message("Unhandled case in switch: %s", arithType_print(ar1) ) ) );
754 constraint constraint_searchandreplace (constraint c, constraintExpr old, constraintExpr new)
756 DPRINTF (("Doing replace for lexpr") );
757 c->lexpr = constraintExpr_searchandreplace (c->lexpr, old, new);
758 DPRINTF (("Doing replace for expr") );
759 c->expr = constraintExpr_searchandreplace (c->expr, old, new);
763 bool constraint_search (constraint c, constraintExpr old)
768 ret = constraintExpr_search (c->lexpr, old);
769 ret = ret || constraintExpr_search (c->expr, old);
773 //adjust file locs and stuff
774 constraint constraint_adjust (constraint substitute, constraint old)
776 fileloc loc1, loc2, loc3;
778 DPRINTF ( (message("Start adjust on %s and %s", constraint_print(substitute),
779 constraint_print(old))
782 loc1 = constraint_getFileloc (old);
784 loc2 = constraintExpr_getFileloc (substitute->lexpr);
786 loc3 = constraintExpr_getFileloc (substitute->expr);
789 // special case of an equality that "contains itself"
790 if (constraintExpr_search (substitute->expr, substitute->lexpr) )
791 if (fileloc_closer (loc1, loc3, loc2))
794 DPRINTF ( (message("Doing adjust on %s", constraint_print(substitute) )
796 temp = substitute->lexpr;
797 substitute->lexpr = substitute->expr;
798 substitute->expr = temp;
799 substitute = constraint_simplify(substitute);
806 /* If function preforms substitutes based on inequality
808 It uses the rule x >= y && b < y ===> x >= b + 1
810 Warning this is sound but throws out information
812 constraint inequalitySubstitute (constraint c, constraintList p)
817 constraintList_elements (p, el)
820 // if (!constraint_conflict (c, el) )
823 constraintExpr temp2;
825 temp = constraint_copy(el);
827 // temp = constraint_adjust(temp, c);
829 if (constraintExpr_same (el->expr, c->expr) )
831 DPRINTF((message ("inequalitySubstitute Replacing %s in %s with %s",
832 constraintExpr_print (c->expr),
833 constraint_print (c),
834 constraintExpr_print (el->expr) )
836 temp2 = constraintExpr_copy (el->lexpr);
837 c->expr = constraintExpr_makeIncConstraintExpr (temp2);
842 end_constraintList_elements;
844 c = constraint_simplify(c);
848 /* This function performs substitutions based on the rule:
849 for a constraint of the form expr1 >= expr2; a < b =>
850 a = b -1 for all a in expr1. This will work in most cases.
852 Like inequalitySubstitute we're throwing away some information
855 constraint inequalitySubstituteUnsound (constraint c, constraintList p)
857 DPRINTF (( message ("Doing inequalitySubstituteUnsound " ) ));
862 constraintList_elements (p, el)
864 DPRINTF (( message ("inequalitySubstituteUnsound examining substituting %s on %s", constraint_print(el), constraint_print(c) ) ));
865 if ( ( el->ar == LTE) || (el->ar == LT) )
866 // if (!constraint_conflict (c, el) )
869 constraintExpr temp2;
871 temp = constraint_copy(el);
873 // temp = constraint_adjust(temp, c);
874 temp2 = constraintExpr_copy (el->expr);
877 temp2 = constraintExpr_makeDecConstraintExpr (temp2);
879 DPRINTF((message ("Replacing %s in %s with %s",
880 constraintExpr_print (el->lexpr),
881 constraintExpr_print (c->lexpr),
882 constraintExpr_print (temp2) ) ));
884 c->lexpr = constraintExpr_searchandreplace (c->lexpr, el->lexpr, temp2);
887 end_constraintList_elements;
889 c = constraint_simplify(c);
893 constraint substitute (constraint c, constraintList p)
897 ret = constraint_copy(c);
898 constraintList_elements (p, el)
901 if (!constraint_conflict (ret, el) )
905 temp = constraint_copy(el);
907 temp = constraint_adjust(temp, ret);
909 DPRINTF((message ("Substituting %s in the constraint %s",
910 constraint_print (temp), constraint_print (ret)
914 ret = constraint_searchandreplace (ret, temp->lexpr, temp->expr);
915 DPRINTF(( message ("The new constraint is %s", constraint_print (ret) ) ));
918 end_constraintList_elements;
920 ret = constraint_simplify(ret);
924 /* we try to do substitutions on each constraint in target using the constraint in sublist*/
926 constraintList constraintList_substitute (constraintList target, constraintList subList)
931 ret = constraintList_makeNew();
933 constraintList_elements(target, el)
935 el = substitute(el, subList);
936 ret = constraintList_add (ret, el);
938 end_constraintList_elements;
943 constraint constraint_solveWithFlag (constraint c, bool *b)
947 if (c->lexpr->kind == binaryexpr)
950 DPRINTF( (message ("Solving %s\n", constraint_print(c) ) ) );
951 c->expr = constraintExpr_solveBinaryExpr (c->lexpr, c->expr);
952 DPRINTF( (message ("Solved and got %s\n", constraint_print(c) ) ) );
957 constraint constraint_solve (constraint c)
959 DPRINTF( (message ("Solving %s\n", constraint_print(c) ) ) );
960 c->expr = constraintExpr_solveBinaryExpr (c->lexpr, c->expr);
961 DPRINTF( (message ("Solved and got %s\n", constraint_print(c) ) ) );
966 static arithType flipAr (arithType ar)
981 llcontbug (("unexpected value: case not handled"));
986 static constraint constraint_swapLeftRight (constraint c)
989 c->ar = flipAr (c->ar);
993 DPRINTF(("Swaped left and right sides of constraint"));
999 constraint constraint_simplify (constraint c)
1001 c->lexpr = constraintExpr_simplify (c->lexpr);
1002 c->expr = constraintExpr_simplify (c->expr);
1004 #warning check this 5/11/01
1006 if (c->lexpr->kind == binaryexpr)
1008 c = constraint_solve (c);
1010 c->lexpr = constraintExpr_simplify (c->lexpr);
1011 c->expr = constraintExpr_simplify (c->expr);
1014 if (constraintExpr_isLit(c->lexpr) && (!constraintExpr_isLit(c->expr) ) )
1016 c = constraint_swapLeftRight(c);
1017 /*I don't think this will be an infinate loop*/
1018 constraint_simplify(c);
1026 /* returns true if fileloc for term1 is closer to file for term2 than term3*/
1028 bool fileloc_closer (fileloc loc1, fileloc loc2, fileloc loc3)
1031 if (!fileloc_isDefined (loc1) )
1034 if (!fileloc_isDefined (loc2) )
1037 if (!fileloc_isDefined (loc3) )
1043 if (fileloc_equal (loc2, loc3) )
1046 if (fileloc_equal (loc1, loc2) )
1049 if (fileloc_equal (loc1, loc3) )
1052 if ( fileloc_lessthan (loc1, loc2) )
1054 if (fileloc_lessthan (loc2, loc3) )
1056 llassert (fileloc_lessthan (loc1, loc3) );
1065 if ( !fileloc_lessthan (loc1, loc2) )
1067 if (!fileloc_lessthan (loc2, loc3) )
1069 llassert (!fileloc_lessthan (loc1, loc3) );