2 ** Splint - annotation-assisted static program checker
3 ** Copyright (C) 1994-2000 University of Virginia,
4 ** Massachusetts Institute of Technology
6 ** This program is free software; you can redistribute it and/or modify it
7 ** under the terms of the GNU General Public License as published by the
8 ** Free Software Foundation; either version 2 of the License, or (at your
9 ** option) any later version.
11 ** This program is distributed in the hope that it will be useful, but
12 ** WITHOUT ANY WARRANTY; without even the implied warranty of
13 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 ** General Public License for more details.
16 ** The GNU General Public License is available from http://www.gnu.org/ or
17 ** the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
18 ** MA 02111-1307, USA.
20 ** For information on splint: info@splint.org
21 ** To report a bug: splint-bug@splint.org
22 ** For more information: http://www.splint.org
28 ** based on list_template.c
30 ** where T has T_equal (or change this) and T_unparse
33 # include "splintMacros.nf"
36 /*@iter constraintList_elements_private_only (sef constraintList x, yield only constraint el); @*/
37 # define constraintList_elements_private_only(x, m_el) \
38 { if (constraintList_isDefined (x)) { int m_ind; constraint *m_elements = &((x)->elements[0]); \
39 for (m_ind = 0 ; m_ind < (x)->nelements; m_ind++) \
40 { constraint m_el = *(m_elements++);
42 # define end_constraintList_elements_private_only }}}
45 /*@iter constraintList_elements_private (sef constraintList x, yield constraint el); @*/
46 # define constraintList_elements_private(x, m_el) \
47 { if (constraintList_isDefined (x)) { int m_ind; constraint *m_elements = &((x)->elements[0]); \
48 for (m_ind = 0 ; m_ind < (x)->nelements; m_ind++) \
49 { constraint m_el = *(m_elements++);
51 # define end_constraintList_elements_private }}}
54 /*@only@*/ constraintList constraintList_makeNew ()
56 constraintList s = (constraintList) dmalloc (sizeof (*s));
59 s->nspace = constraintListBASESIZE;
60 s->elements = (constraint *)
61 dmalloc (sizeof (*s->elements) * constraintListBASESIZE);
67 constraintList_grow (constraintList s)
70 constraint *newelements;
72 llassert (constraintList_isDefined (s));
74 s->nspace += constraintListBASESIZE;
75 newelements = (constraint *) dmalloc (sizeof (*newelements)
76 * (s->nelements + s->nspace));
78 for (i = 0; i < s->nelements; i++)
80 newelements[i] = s->elements[i];
84 s->elements = newelements;
89 constraintList_add (/*@returned@*/ constraintList s, /*@only@*/ constraint el)
91 llassert (constraintList_isDefined (s));
95 if (constraintList_resolve (el, s) )
102 constraintList_grow (s);
105 s->elements[s->nelements] = el;
110 /* frees everything but actual constraints */
111 /* This function should only be used if you have
112 other references to unshared constraints
114 static void constraintList_freeShallow (/*@only@*/ constraintList c)
116 if (constraintList_isDefined(c) )
127 /*@only@*/ constraintList constraintList_addList (/*@only@*/ /*@returned@*/ constraintList s, /*@observer@*/ /*@temp@*/ constraintList newList)
129 llassert(constraintList_isDefined(s) );
130 llassert(constraintList_isDefined(newList) );
132 if (newList == constraintList_undefined)
135 constraintList_elements (newList, elem)
137 s = constraintList_add (s, constraint_copy(elem) );
139 end_constraintList_elements;
144 constraintList constraintList_addListFree (/*@returned@*/ constraintList s, /*@only@*/ constraintList newList)
146 llassert(constraintList_isDefined(s) );
147 llassert(constraintList_isDefined(newList) );
149 if (constraintList_isUndefined(newList) )
152 constraintList_elements_private_only(newList, elem)
154 s = constraintList_add (s, elem);
156 end_constraintList_elements_private_only
158 constraintList_freeShallow(newList);
163 constraintList constraintList_removeSurpressed (/*@only@*/ constraintList s)
167 llassert(constraintList_isDefined(s) );
169 ret = constraintList_makeNew();
171 constraintList_elements_private_only(s, elem)
173 loc = constraint_getFileloc(elem);
175 if (fileloc_isUndefined(loc))
177 ret = constraintList_add (ret, elem);
180 else if (context_suppressFlagMsg(FLG_BOUNDSWRITE, loc) )
182 DPRINTF ((message ("constraintList_removeSurpressed getting rid of surpressed constraint %q",
183 constraint_unparse(elem))));
184 constraint_free(elem);
187 else if (!constraint_hasMaxSet(elem) && context_suppressFlagMsg(FLG_BOUNDSREAD, loc))
189 DPRINTF ((message("constraintList_removeSurpressed getting rid of surpressed constraint %q",
190 constraint_unparse(elem))));
191 constraint_free(elem);
195 ret = constraintList_add (ret, elem);
199 end_constraintList_elements_private_only;
201 constraintList_freeShallow(s);
207 static /*@only@*/ cstring
208 constraintList_unparseLocation (/*@temp@*/ constraintList s) /*@*/
211 cstring st = cstring_undefined;
214 if (!constraintList_isDefined (s))
216 return cstring_makeLiteral ("<undefined>");
219 if (s->nelements == 0)
221 st = cstring_makeLiteral("<List Empty>");
225 for (i = 0; i < s->nelements; i++)
227 cstring type = cstring_undefined;
228 constraint current = s->elements[i];
230 if (constraint_isDefined(current) )
233 temp1 = constraint_unparseLocation(current);
234 type = message ("%q %q\n", type, temp1 );
244 st = message ("%q, %q", st, type);
253 constraintList_unparse (/*@temp@*/ constraintList s) /*@*/
256 cstring st = cstring_undefined;
259 if (!constraintList_isDefined (s))
261 return cstring_makeLiteral ("<undefined>");
264 if (s->nelements == 0)
266 st = cstring_makeLiteral("<List Empty>");
270 for (i = 0; i < s->nelements; i++)
272 cstring type = cstring_undefined;
273 constraint current = s->elements[i];
275 if (constraint_isDefined(current) )
279 if (context_getFlag (FLG_ORCONSTRAINT))
281 temp1 = constraint_unparseOr(current);
285 temp1 = constraint_unparse (current);
287 type = message ("%q %q\n", type, temp1 );
297 st = message ("%q, %q", st, type);
304 void constraintList_unparseErrorPostConditions (constraintList s, fileloc loc)
307 constraintList_elements (s, elem)
309 if (constraint_isDefined(elem))
311 constraint_printErrorPostCondition (elem, loc);
314 end_constraintList_elements;
318 void constraintList_unparseError (constraintList s, fileloc loc)
321 constraintList_elements (s, elem)
323 if (constraint_isDefined(elem) )
325 if (constraint_isPost(elem) )
326 constraint_printErrorPostCondition (elem, loc);
328 constraint_printError (elem, loc);
331 end_constraintList_elements;
337 constraintList_unparseDetailed (constraintList s)
340 cstring st = cstring_undefined;
343 if (!constraintList_isDefined (s))
345 return cstring_makeLiteral ("<undefined>");
348 if (s->nelements == 0)
350 st = cstring_makeLiteral("<List Empty>");
354 for (i = 0; i < s->nelements; i++)
356 cstring type = cstring_undefined;
357 constraint current = s->elements[i];
359 if (constraint_isDefined(current ) )
361 cstring temp1 = constraint_unparseDetailed (current);
362 type = message ("%s %s\n", type, temp1 );
374 st = message ("%q %q", st, type);
380 /*{ x: constraint | (x in l1 -> resolve (x, l2) || (x in l2 -> resolve (x, l1)
384 constraintList_logicalOr (/*@observer@*/ constraintList l1, /*@observer@*/ constraintList l2)
388 DPRINTF ((message ("Logical or on %s and %s",
389 constraintList_unparse(l1),
390 constraintList_unparse(l2)) ) );
392 ret = constraintList_makeNew();
393 constraintList_elements (l1, el)
395 temp = constraint_substitute (el, l2);
397 if (constraintList_resolve (el, l2) || constraintList_resolve(temp,l2) )
398 { /*avoid redundant constraints*/
399 if (!constraintList_resolve (el, ret) )
402 temp2 = constraint_copy(el);
403 ret = constraintList_add (ret, temp2);
406 constraint_free(temp);
408 end_constraintList_elements;
410 constraintList_elements (l2, el)
412 temp = constraint_substitute (el, l1);
414 if (constraintList_resolve (el, l1) || constraintList_resolve(temp,l1) )
416 /*avoid redundant constraints*/
417 if (!constraintList_resolve (el, ret) )
420 temp2 = constraint_copy(el);
421 ret = constraintList_add (ret, temp2);
424 constraint_free(temp);
426 end_constraintList_elements;
433 constraintList_free (/*@only@*/ constraintList s)
435 if (constraintList_isDefined (s))
439 for (i = 0; i < s->nelements; i++)
441 constraint_free (s->elements[i]);
454 constraintList_copy (/*@observer@*/ /*@temp@*/ constraintList s)
456 constraintList ret = constraintList_makeNew ();
458 constraintList_elements (s, el)
460 ret = constraintList_add (ret, constraint_copy (el));
461 } end_constraintList_elements;
466 constraintList constraintList_preserveOrig (constraintList c)
468 DPRINTF((message("constraintList_preserveOrig preserving the originial constraints for %s ", constraintList_unparse (c) ) ));
470 constraintList_elements_private (c, el)
472 el = constraint_preserveOrig (el);
474 end_constraintList_elements_private;
478 constraintList constraintList_preserveCallInfo (/*@returned@*/ constraintList c,/*@observer@*/ /*@dependent@*/ /*@observer@*/ exprNode fcn)
480 DPRINTF((message("constraintList_preserveCallInfo %s ", constraintList_unparse (c) ) ));
482 constraintList_elements_private (c, el)
484 el = constraint_setFcnPre(el);
485 el = constraint_origAddGeneratingExpr (el, fcn);
487 end_constraintList_elements_private;
491 constraintList constraintList_single (constraint c)
494 res = constraintList_makeNew();
495 res = constraintList_add (res, c);
499 constraintList constraintList_addGeneratingExpr (constraintList c,/*@dependent@*/ exprNode e)
501 DPRINTF ((message ("entering constraintList_addGeneratingExpr for %s ", exprNode_unparse(e) ) ));
503 constraintList_elements_private (c, el)
505 DPRINTF ((message ("setting generatingExpr for %s to %s", constraint_unparse(el), exprNode_unparse(e) ) ));
506 el = constraint_addGeneratingExpr (el, e);
508 end_constraintList_elements_private;
512 /*@only@*/ constraintList constraintList_doFixResult (/*@only@*/constraintList postconditions, exprNode fcnCall)
515 ret = constraintList_makeNew();
516 constraintList_elements_private (postconditions, el)
518 ret = constraintList_add (ret, constraint_doFixResult (el, fcnCall) );
520 end_constraintList_elements_private;
522 constraintList_free(postconditions);
526 Commenting out because function is not yet stable
528 / *@only@* / constraintList constraintList_doSRefFixStructConstraint(constraintList invars, sRef s, ctype ct )
531 ret = constraintList_makeNew();
533 constraintList_elements (invars, el)
535 ret = constraintList_add(ret, constraint_doSRefFixInvarConstraint (el, s, ct) );
537 end_constraintList_elements;
539 / * constraintList_free (invars);* /
545 /*@only@*/ constraintList constraintList_doSRefFixConstraintParam (constraintList preconditions, /*@temp@*/ /*@observer@*/ exprNodeList arglist)
548 ret = constraintList_makeNew();
550 constraintList_elements (preconditions, el)
552 ret = constraintList_add(ret, constraint_doSRefFixConstraintParam (el, arglist) );
554 end_constraintList_elements;
556 constraintList_free (preconditions);
560 constraintList constraintList_doSRefFixBaseParam (constraintList preconditions, /*@observer@*/
561 exprNodeList arglist)
565 ret = constraintList_makeNew();
567 constraintList_elements (preconditions, el)
569 temp = constraint_copy(el);
570 ret = constraintList_add(ret, constraint_doSRefFixBaseParam (temp, arglist) );
572 end_constraintList_elements;
577 constraintList constraintList_togglePost (/*@returned@*/ constraintList c)
579 constraintList_elements_private (c, el)
581 el = constraint_togglePost(el);
582 if (constraint_hasOrig(el) )
584 el = constraint_togglePostOrig (el);
587 end_constraintList_elements_private;
591 /*@only@*/ constraintList constraintList_undump (FILE *f)
597 ret = constraintList_makeNew();
599 os = mstring_create (MAX_DUMP_LINE_LENGTH);
600 s = fgets (os, MAX_DUMP_LINE_LENGTH, f);
602 while (s != NULL && *s != ';')
607 c = reader_getWord(&s);
609 if (! mstring_isDefined(c) )
611 llfatalbug(message("Library file is corrupted") );
615 if (strcmp (c, "C") != 0)
617 llfatalbug(message("Error reading library. File may be corrupted"));
620 temp = constraint_undump (f);
621 ret = constraintList_add (ret, temp);
622 s = fgets (os, MAX_DUMP_LINE_LENGTH, f);
631 void constraintList_dump (/*@observer@*/ constraintList c, FILE *f)
633 constraintList_elements (c, el)
636 constraint_dump (el, f);
638 end_constraintList_elements; ;
642 constraintList constraintList_sort (/*@returned@*/ constraintList ret)
644 if (constraintList_isUndefined(ret) )
649 qsort (ret->elements, (size_t) ret->nelements,
650 (sizeof (*ret->elements)),
651 (int (*)(const void *, const void *)) constraint_compare);
653 DPRINTF((message("onstraint_sort returning") ));