]>
Commit | Line | Data |
---|---|---|
885824d3 | 1 | /* |
28bf4b0b | 2 | ** Copyright (C) University of Virginia, Massachusetts Institue of Technology 1994-2001. |
885824d3 | 3 | ** See ../LICENSE for license information. |
4 | ** | |
5 | */ | |
6 | /* | |
7 | ** storeRef.h | |
8 | */ | |
9 | ||
10 | # ifndef STOREREF_H | |
11 | # define STOREREF_H | |
12 | ||
13 | /* | |
14 | ** note: forwardTypes defines sRef | |
15 | */ | |
16 | ||
17 | /* | |
18 | ** kinds of storage references | |
19 | */ | |
20 | ||
21 | typedef enum { | |
22 | SR_NOTHING, | |
23 | SR_INTERNAL, | |
24 | SR_SPECSTATE, | |
28bf4b0b | 25 | SR_SYSTEM, |
26 | SR_GLOBALMARKER | |
885824d3 | 27 | } speckind; |
28 | ||
29 | typedef enum { | |
30 | SK_PARAM, | |
31 | SK_ARRAYFETCH, | |
32 | SK_FIELD, | |
33 | SK_PTR, | |
34 | SK_ADR, | |
35 | SK_CONST, | |
36 | SK_CVAR, | |
37 | SK_UNCONSTRAINED, | |
38 | SK_OBJECT, | |
39 | SK_CONJ, | |
40 | SK_EXTERNAL, | |
41 | SK_DERIVED, | |
42 | SK_NEW, | |
43 | SK_TYPE, | |
44 | SK_RESULT, | |
45 | SK_SPECIAL, | |
46 | SK_UNKNOWN | |
47 | } skind; | |
48 | ||
28bf4b0b | 49 | typedef struct |
885824d3 | 50 | { |
51 | int lexlevel; | |
52 | usymId index; | |
53 | } *cref; | |
54 | ||
28bf4b0b | 55 | typedef struct |
885824d3 | 56 | { |
57 | /*@exposed@*/ /*@notnull@*/ sRef arr; | |
58 | bool indknown; | |
59 | int ind; | |
60 | } *ainfo; | |
61 | ||
28bf4b0b | 62 | typedef struct |
885824d3 | 63 | { |
64 | /*@exposed@*/ /*@notnull@*/ sRef rec; | |
65 | /*@observer@*/ cstring field; | |
66 | } *fldinfo ; | |
67 | ||
28bf4b0b | 68 | typedef struct |
885824d3 | 69 | { |
70 | /*@exposed@*/ /*@notnull@*/ sRef a; | |
71 | /*@exposed@*/ /*@notnull@*/ sRef b; | |
72 | } *cjinfo ; | |
73 | ||
28bf4b0b | 74 | typedef union |
885824d3 | 75 | { |
76 | /*@only@*/ cref cvar; | |
77 | int paramno; | |
78 | /*@only@*/ ainfo arrayfetch; | |
28bf4b0b | 79 | /*@only@*/ fldinfo field; |
885824d3 | 80 | ctype object; |
81 | /*@observer@*/ cstring fname; /* unconstrained, new */ | |
b9904f57 | 82 | /*@exposed@*/ /*@notnull@*/ sRef ref; |
885824d3 | 83 | /*@only@*/ cjinfo conj; |
84 | speckind spec; | |
85 | } *sinfo; | |
86 | ||
28bf4b0b | 87 | struct s_sRef |
885824d3 | 88 | { |
89 | /* does it need to be inside parens (macros) */ | |
28bf4b0b | 90 | bool safe; |
885824d3 | 91 | |
92 | /* has it been modified */ | |
28bf4b0b | 93 | bool modified; /* BOOLBITS; */ |
94 | ||
95 | /* for debugging: make this sRef as immutable. */ | |
96 | bool immut; /* BOOLBITS; */ | |
885824d3 | 97 | |
98 | skind kind; | |
99 | ctype type; | |
100 | ||
b9904f57 | 101 | multiVal val; /* Some sRef's have known values */ |
102 | ||
885824d3 | 103 | sstate defstate; |
104 | nstate nullstate; | |
105 | ||
1ac6313d | 106 | /* start modifications: We keep a track of the buf state(nullterm info)*/ |
28bf4b0b | 107 | struct s_bbufinfo bufinfo; |
1ac6313d | 108 | /* end modifications */ |
109 | ||
885824d3 | 110 | alkind aliaskind; |
111 | alkind oaliaskind; | |
112 | ||
113 | exkind expkind; /* exposed, observer, normal */ | |
114 | exkind oexpkind; | |
115 | ||
116 | /* where it becomes observer/exposed */ | |
28bf4b0b | 117 | /*@null@*/ /*@only@*/ stateInfo expinfo; |
885824d3 | 118 | |
119 | /* where it changed alias kind */ | |
28bf4b0b | 120 | /*@null@*/ /*@only@*/ stateInfo aliasinfo; |
885824d3 | 121 | |
122 | /* where it is defined/allocated */ | |
28bf4b0b | 123 | /*@null@*/ /*@only@*/ stateInfo definfo; |
885824d3 | 124 | |
28bf4b0b | 125 | /* where it is null */ |
126 | /*@null@*/ /*@only@*/ stateInfo nullinfo; | |
885824d3 | 127 | |
128 | /*@only@*/ /*@relnull@*/ sinfo info; | |
129 | ||
130 | /* stores fields for structs, elements for arrays, derefs for pointers */ | |
131 | /*@only@*/ sRefSet deriv; | |
28bf4b0b | 132 | |
133 | /* sRef's include a lookup table of state variables. */ | |
134 | /*@only@*/ valueTable state; | |
885824d3 | 135 | } ; |
136 | ||
137 | extern bool sRef_perhapsNull (sRef p_s); | |
138 | extern bool sRef_possiblyNull (sRef p_s); | |
139 | extern bool sRef_definitelyNull (sRef p_s); | |
140 | ||
28bf4b0b | 141 | extern bool sRef_definitelyNullContext (sRef p_s); |
142 | extern bool sRef_definitelyNullAltContext (sRef p_s); | |
143 | ||
885824d3 | 144 | extern void sRef_setNullError (sRef p_s); |
145 | extern void sRef_setNullUnknown (sRef p_s, fileloc p_loc); | |
146 | extern void sRef_setNotNull (sRef p_s, fileloc p_loc); | |
147 | extern void sRef_setNullState (sRef p_s, nstate p_n, fileloc p_loc); | |
28bf4b0b | 148 | extern void sRef_setNullStateN (sRef p_s, nstate p_n); |
885824d3 | 149 | extern void sRef_setNullStateInnerComplete (sRef p_s, nstate p_n, fileloc p_loc); |
150 | extern void sRef_setPosNull (sRef p_s, fileloc p_loc); | |
151 | extern void sRef_setDefNull (sRef p_s, fileloc p_loc); | |
152 | ||
153 | extern /*@truenull@*/ bool sRef_isInvalid (sRef p_s) /*@*/ ; | |
154 | extern /*@falsenull@*/ bool sRef_isValid (sRef p_s) /*@*/ ; | |
155 | ||
156 | /*@constant null sRef sRef_undefined; @*/ | |
157 | # define sRef_undefined ((sRef) NULL) | |
158 | # define sRef_isInvalid(s) ((s) == NULL) | |
159 | # define sRef_isValid(s) ((s) != NULL) | |
160 | ||
161 | extern bool sRef_isRecursiveField (sRef p_s) /*@*/ ; | |
162 | extern void sRef_copyRealDerivedComplete (sRef p_s1, sRef p_s2) /*@modifies p_s1@*/ ; | |
163 | extern nstate sRef_getNullState (/*@sef@*/ sRef p_s) /*@*/ ; | |
164 | extern bool sRef_isNotNull (sRef p_s) /*@*/ ; | |
165 | ||
885824d3 | 166 | extern bool sRef_isDefinitelyNull (sRef p_s) /*@*/ ; |
167 | ||
168 | extern /*@falsenull@*/ bool sRef_isLocalVar (sRef p_s) /*@*/ ; | |
169 | extern /*@falsenull@*/ bool sRef_isNSLocalVar (sRef p_s) /*@*/ ; | |
170 | extern /*@falsenull@*/ bool sRef_isRealLocalVar (sRef p_s) /*@*/ ; | |
171 | extern /*@falsenull@*/ bool sRef_isLocalParamVar (sRef p_s) /*@*/ ; | |
172 | extern /*@falsenull@*/ bool sRef_isKnown (/*@sef@*/ sRef p_s) /*@*/ ; | |
173 | ||
174 | extern bool sRef_hasLastReference (sRef p_s) /*@*/ ; | |
175 | # define sRef_hasLastReference(s) (sRef_hasAliasInfoRef (s)) | |
176 | ||
177 | # define sRef_isKnown(s) (sRef_isValid(s) && (s)->kind != SK_UNKNOWN) | |
178 | ||
179 | extern bool sRef_isMeaningful (/*@sef@*/ sRef p_s) /*@*/ ; | |
180 | # define sRef_isMeaningful(s) (sRef_isValid(s) && sRef_isKnown(s) \ | |
181 | && (s)->kind != SK_NEW && (s)->kind != SK_TYPE) | |
182 | extern bool sRef_isNew (/*@sef@*/ sRef p_s) /*@*/ ; | |
183 | # define sRef_isNew(s) (sRef_isValid(s) && (s)->kind == SK_NEW) | |
184 | ||
185 | extern bool sRef_isType (/*@sef@*/ sRef p_s) /*@*/ ; | |
186 | # define sRef_isType(s) (sRef_isValid(s) && (s)->kind == SK_TYPE) | |
187 | ||
188 | extern bool sRef_isSafe (/*@sef@*/ sRef p_s) /*@*/ ; | |
189 | # define sRef_isSafe(s) (sRef_isValid(s) && (s)->safe) | |
190 | ||
191 | extern bool sRef_isUnsafe (/*@sef@*/ sRef p_s) /*@*/ ; | |
192 | # define sRef_isUnsafe(s) (sRef_isValid(s) && !(s)->safe) | |
193 | ||
194 | extern void sRef_clearAliasKind (/*@sef@*/ sRef p_s) /*@modifies p_s@*/ ; | |
195 | # define sRef_clearAliasKind(s) (sRef_isValid(s) ? (s)->aliaskind = AK_UNKNOWN : AK_ERROR) | |
196 | ||
197 | extern bool sRef_stateKnown (/*@sef@*/ sRef p_s) /*@*/ ; | |
198 | # define sRef_stateKnown(s) (sRef_isValid(s) && (s)->defstate != SS_UNKNOWN) | |
199 | ||
200 | extern alkind sRef_getAliasKind (/*@sef@*/ sRef p_s) /*@*/ ; | |
885824d3 | 201 | |
202 | extern alkind sRef_getOrigAliasKind (/*@sef@*/ sRef p_s) /*@*/ ; | |
203 | # define sRef_getOrigAliasKind(s) (sRef_isValid(s) ? (s)->oaliaskind : AK_ERROR) | |
204 | ||
205 | extern /*@falsenull@*/ bool sRef_isConj (/*@sef@*/ sRef p_s) /*@*/ ; | |
206 | # define sRef_isConj(s) (sRef_isValid(s) && (s)->kind == SK_CONJ) | |
207 | ||
208 | extern /*@exposed@*/ sRef sRef_buildArrow (sRef p_s, /*@dependent@*/ cstring p_f); | |
209 | extern /*@exposed@*/ sRef sRef_makeArrow (sRef p_s, /*@dependent@*/ cstring p_f); | |
210 | ||
211 | extern bool sRef_isAllocIndexRef (sRef p_s) /*@*/ ; | |
212 | extern void sRef_setAliasKind (sRef p_s, alkind p_kind, fileloc p_loc) /*@modifies p_s@*/ ; | |
213 | extern void sRef_setPdefined (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
214 | ||
215 | extern /*@unused@*/ bool sRef_hasDerived (sRef p_s) /*@*/ ; | |
216 | extern void sRef_clearDerived (sRef p_s); | |
217 | extern void sRef_clearDerivedComplete (sRef p_s); | |
218 | extern /*@exposed@*/ sRef sRef_getBaseSafe (sRef p_s); | |
219 | ||
28bf4b0b | 220 | extern /*@observer@*/ sRefSet sRef_derivedFields (/*@temp@*/ sRef p_rec) /*@*/ ; |
885824d3 | 221 | extern bool sRef_sameName (sRef p_s1, sRef p_s2) /*@*/ ; |
222 | extern bool sRef_isDirectParam (sRef p_s) /*@*/ ; | |
223 | extern /*@exposed@*/ sRef sRef_makeAnyArrayFetch (/*@exposed@*/ sRef p_arr); | |
224 | extern bool sRef_isUnknownArrayFetch (sRef p_s) /*@*/ ; | |
225 | ||
226 | extern void sRef_setPartialDefinedComplete (sRef p_s, fileloc p_loc); | |
227 | extern bool sRef_isMacroParamRef (sRef p_s) /*@*/ ; | |
228 | ||
229 | extern void sRef_destroyMod (void) /*@modifies internalState@*/ ; | |
230 | ||
231 | extern bool sRef_deepPred (bool (p_predf) (sRef), sRef p_s); | |
232 | ||
233 | extern bool sRef_aliasCompleteSimplePred (bool (p_predf) (sRef), sRef p_s); | |
234 | ||
235 | extern void sRef_clearExKindComplete (sRef p_s, fileloc p_loc); | |
236 | ||
237 | extern /*@falsenull@*/ bool sRef_isKindSpecial (/*@sef@*/ sRef p_s) /*@*/ ; | |
238 | # define sRef_isKindSpecial(s) (sRef_isValid (s) && (s)->kind == SK_SPECIAL) | |
239 | ||
240 | extern /*@observer@*/ cstring sRef_nullMessage (sRef p_s) /*@*/ ; | |
241 | ||
242 | extern bool sRef_isSystemState (sRef p_s) /*@*/ ; | |
28bf4b0b | 243 | extern bool sRef_isGlobalMarker (sRef p_s) /*@*/ ; |
885824d3 | 244 | extern bool sRef_isInternalState (sRef p_s) /*@*/ ; |
245 | extern bool sRef_isResult (sRef p_s) /*@*/ ; | |
246 | extern bool sRef_isSpecInternalState (sRef p_s) /*@*/ ; | |
247 | extern bool sRef_isSpecState (sRef p_s) /*@*/ ; | |
248 | extern bool sRef_isNothing (sRef p_s) /*@*/ ; | |
249 | ||
28bf4b0b | 250 | extern bool sRef_isFileOrGlobalScope (sRef p_s) /*@*/ ; |
885824d3 | 251 | extern bool sRef_isReference (sRef p_s) /*@*/ ; |
252 | ||
253 | extern ctype sRef_deriveType (sRef p_s, uentryList p_cl) /*@*/ ; | |
254 | extern ctype sRef_getType (sRef p_s) /*@*/ ; | |
255 | ||
28bf4b0b | 256 | extern void sRef_markImmutable (sRef p_s) /*@modifies p_s@*/ ; |
257 | ||
885824d3 | 258 | extern /*@falsenull@*/ bool sRef_isAddress (sRef p_s) /*@*/ ; |
259 | extern /*@falsenull@*/ bool sRef_isArrayFetch (sRef p_s) /*@*/ ; | |
260 | extern /*@falsenull@*/ bool sRef_isConst (sRef p_s) /*@*/ ; | |
261 | extern /*@falsenull@*/ bool sRef_isCvar (sRef p_s) /*@*/ ; | |
262 | extern /*@falsenull@*/ bool sRef_isField (sRef p_s) /*@*/ ; | |
263 | extern /*@falsenull@*/ bool sRef_isParam (sRef p_s) /*@*/ ; | |
264 | extern /*@falsenull@*/ bool sRef_isPointer (sRef p_s) /*@*/ ; | |
265 | ||
266 | extern void sRef_setType (sRef p_s, ctype p_t); | |
267 | extern void sRef_setTypeFull (sRef p_s, ctype p_t); | |
268 | extern void sRef_mergeNullState (sRef p_s, nstate p_n); | |
28bf4b0b | 269 | extern void sRef_setLastReference (/*@temp@*/ sRef p_s, /*@exposed@*/ sRef p_ref, fileloc p_loc); |
885824d3 | 270 | extern bool sRef_canModify (sRef p_s, sRefSet p_sl) /*@modifies p_s@*/ ; |
271 | extern bool sRef_canModifyVal (sRef p_s, sRefSet p_sl) /*@modifies p_s@*/ ; | |
272 | extern bool sRef_isIReference (sRef p_s) /*@*/ ; | |
273 | extern bool sRef_isIndexKnown (sRef p_arr) /*@*/ ; | |
274 | extern bool sRef_isModified (sRef p_s) /*@*/ ; | |
275 | ||
276 | extern bool sRef_isExternallyVisible (sRef p_s) /*@*/ ; | |
277 | extern int sRef_compare (sRef p_s1, sRef p_s2) /*@*/ ; | |
278 | extern bool sRef_realSame (sRef p_s1, sRef p_s2) /*@*/ ; | |
28bf4b0b | 279 | extern bool sRef_sameObject (sRef p_s1, sRef p_s2) /*@*/ ; |
885824d3 | 280 | extern bool sRef_same (sRef p_s1, sRef p_s2) /*@*/ ; |
281 | extern bool sRef_similar (sRef p_s1, sRef p_s2) /*@*/ ; | |
282 | extern /*@observer@*/ cstring sRef_getField (sRef p_s) /*@*/ ; | |
283 | extern /*@only@*/ cstring sRef_unparse (sRef p_s) /*@*/ ; | |
284 | extern /*@observer@*/ cstring sRef_stateVerb (sRef p_s) /*@*/ ; | |
285 | extern /*@observer@*/ cstring sRef_stateAltVerb (sRef p_s) /*@*/ ; | |
286 | extern /*@only@*/ cstring sRef_unparseOpt (sRef p_s) /*@*/ ; | |
287 | extern /*@only@*/ cstring sRef_unparseDebug (sRef p_s) /*@*/ ; | |
288 | extern void sRef_killComplete (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
289 | extern int sRef_getIndex (sRef p_arr) /*@*/ ; | |
290 | extern /*@dependent@*/ sRef sRef_fixOuterRef (/*@returned@*/ sRef p_s); | |
291 | extern void sRef_setDefinedComplete (sRef p_s, fileloc p_loc); | |
292 | extern void sRef_setDefinedNCComplete (sRef p_s, fileloc p_loc); | |
293 | extern int sRef_getParam (sRef p_s) /*@*/ ; | |
294 | extern int sRef_lexLevel (sRef p_s) /*@*/ ; | |
295 | extern void sRef_setOrigAliasKind (sRef p_s, alkind p_kind); | |
28bf4b0b | 296 | |
885824d3 | 297 | extern /*@exposed@*/ sRef |
3120b462 | 298 | sRef_fixBase (/*@returned@*/ sRef p_s, /*@returned@*/ sRef p_base) |
885824d3 | 299 | /*@modifies p_s, p_base@*/ ; |
300 | ||
301 | extern void sRef_showNotReallyDefined (sRef p_s) /*@modifies g_msgstream@*/ ; | |
302 | ||
28bf4b0b | 303 | extern void sRef_enterFunctionScope (void) /*@modifies internalState@*/ ; |
304 | extern void sRef_setGlobalScope (void) /*@modifies internalState@*/ ; | |
305 | extern bool sRef_inGlobalScope (void) /*@*/ ; | |
306 | extern void sRef_exitFunctionScope (void) /*@modifies internalState@*/ ; | |
307 | extern void sRef_clearGlobalScopeSafe (void) /*@modifies internalState@*/ ; | |
308 | extern void sRef_setGlobalScopeSafe (void) /*@modifies internalState@*/ ; | |
885824d3 | 309 | |
310 | extern /*@notnull@*/ /*@exposed@*/ sRef | |
311 | sRef_buildArrayFetch (/*@exposed@*/ sRef p_arr); | |
312 | extern /*@notnull@*/ /*@exposed@*/ sRef sRef_buildArrayFetchKnown (/*@exposed@*/ sRef p_arr, int p_i); | |
313 | extern /*@exposed@*/ sRef | |
28bf4b0b | 314 | sRef_buildField (/*@exposed@*/ sRef p_rec, /*@dependent@*/ cstring p_f) |
885824d3 | 315 | /*@modifies p_rec@*/ ; |
316 | extern /*@exposed@*/ sRef sRef_buildPointer (/*@exposed@*/ sRef p_t) | |
317 | /*@modifies p_t@*/ ; | |
318 | ||
319 | extern /*@exposed@*/ sRef sRef_makeAddress (/*@exposed@*/ sRef p_t); | |
320 | extern /*@notnull@*/ /*@dependent@*/ sRef sRef_makeUnconstrained (/*@exposed@*/ cstring) /*@*/ ; | |
321 | ||
322 | extern /*@falsenull@*/ bool sRef_isUnconstrained (sRef p_s) /*@*/ ; | |
323 | ||
324 | extern /*@observer@*/ cstring sRef_unconstrainedName (sRef p_s) /*@*/ ; | |
325 | ||
28bf4b0b | 326 | extern /*@notnull@*/ /*@exposed@*/ sRef sRef_makeArrayFetch (/*@exposed@*/ sRef p_arr) /*@*/ ; |
885824d3 | 327 | extern /*@notnull@*/ /*@exposed@*/ sRef |
28bf4b0b | 328 | sRef_makeArrayFetchKnown (/*@exposed@*/ sRef p_arr, int p_i); |
885824d3 | 329 | extern /*@notnull@*/ /*@dependent@*/ sRef |
330 | sRef_makeConj (/*@exposed@*/ /*@returned@*/ sRef p_a, /*@exposed@*/ sRef p_b); | |
331 | extern /*@notnull@*/ /*@dependent@*/ sRef | |
6970c11b | 332 | sRef_makeCvar (int p_level, usymId p_index, ctype p_ct, /*@only@*/ stateInfo p_stinfo); |
885824d3 | 333 | extern /*@notnull@*/ /*@dependent@*/ sRef |
334 | sRef_makeConst (ctype p_ct); | |
335 | extern /*@exposed@*/ sRef | |
336 | sRef_makeField (sRef p_rec, /*@dependent@*/ cstring p_f); | |
337 | extern /*@notnull@*/ /*@dependent@*/ sRef | |
6970c11b | 338 | sRef_makeGlobal (usymId p_l, ctype p_ct, /*@only@*/ stateInfo); |
885824d3 | 339 | extern /*@exposed@*/ sRef |
28bf4b0b | 340 | sRef_makeNCField (/*@exposed@*/ sRef p_rec, /*@dependent@*/ cstring p_f) /*@*/ ; |
885824d3 | 341 | extern void sRef_maybeKill (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; |
342 | extern /*@unused@*/ /*@notnull@*/ /*@dependent@*/ sRef | |
343 | sRef_makeObject (ctype p_o) /*@*/ ; | |
344 | extern /*@notnull@*/ /*@dependent@*/ sRef sRef_makeType (ctype p_ct) /*@*/ ; | |
6970c11b | 345 | extern /*@notnull@*/ /*@dependent@*/ sRef sRef_makeParam (int p_l, ctype p_ct, /*@only@*/ stateInfo p_stinfo) /*@*/ ; |
28bf4b0b | 346 | extern /*@exposed@*/ sRef sRef_makePointer (/*@exposed@*/ sRef p_s) /*@modifies p_s@*/ ; |
885824d3 | 347 | extern void sRef_makeSafe (sRef p_s) /*@modifies p_s@*/ ; |
348 | extern void sRef_makeUnsafe (sRef p_s) /*@modifies p_s@*/ ; | |
885824d3 | 349 | |
28bf4b0b | 350 | extern /*@dependent@*/ sRef sRef_makeUnknown (void) /*@*/ ; |
351 | extern /*@dependent@*/ sRef sRef_makeNothing (void) /*@*/ ; | |
352 | extern /*@dependent@*/ sRef sRef_makeInternalState (void) /*@*/ ; | |
353 | extern /*@dependent@*/ sRef sRef_makeSpecState (void) /*@*/ ; | |
354 | extern /*@dependent@*/ sRef sRef_makeGlobalMarker (void) /*@*/ ; | |
355 | extern /*@dependent@*/ sRef sRef_makeSystemState (void) /*@*/ ; | |
885824d3 | 356 | |
b072092f | 357 | extern /*@dependent@*/ /*@notnull@*/ sRef sRef_makeResult (ctype) /*@*/ ; |
885824d3 | 358 | extern /*@exposed@*/ sRef |
359 | sRef_fixResultType (/*@returned@*/ sRef p_s, ctype p_typ, uentry p_ue) | |
360 | /*@modifies p_s@*/; | |
361 | ||
362 | extern void sRef_setParamNo (sRef p_s, int p_l) /*@modifies p_s;@*/; | |
363 | ||
28bf4b0b | 364 | extern /*@notnull@*/ /*@dependent@*/ sRef |
365 | sRef_makeNew (ctype p_ct, sRef p_t, /*@exposed@*/ cstring p_name) ; | |
885824d3 | 366 | |
367 | extern usymId sRef_getScopeIndex (sRef p_s) /*@*/ ; | |
368 | extern /*@exposed@*/ uentry sRef_getBaseUentry (sRef p_s); | |
369 | ||
370 | extern /*@exposed@*/ sRef | |
371 | sRef_fixBaseParam (/*@returned@*/ sRef p_s, exprNodeList p_args) | |
372 | /*@modifies p_s@*/ ; | |
373 | ||
ef2aa32a | 374 | /* |
375 | drl7x | |
376 | added function | |
377 | 12/24/2000 | |
378 | */ | |
4ab867d6 | 379 | |
28bf4b0b | 380 | /*@only@*/ constraintExpr sRef_fixConstraintParam (/*@observer@*/ sRef p_s, /*@observer@*/ /*@temp@*/ exprNodeList p_args); |
ef2aa32a | 381 | |
885824d3 | 382 | extern bool sRef_isUnionField (sRef p_s); |
383 | extern void sRef_setModified (sRef p_s); | |
384 | ||
385 | extern void sRef_resetState (sRef p_s); | |
386 | extern void sRef_resetStateComplete (sRef p_s); | |
387 | ||
388 | extern void sRef_storeState (sRef p_s); | |
389 | extern /*@exposed@*/ sRef sRef_getBase (sRef p_s) /*@*/ ; | |
390 | extern /*@exposed@*/ sRef sRef_getRootBase (sRef p_s) /*@*/ ; | |
391 | ||
392 | extern /*@observer@*/ uentry sRef_getUentry (sRef p_s); | |
393 | ||
394 | extern cstring sRef_dump (sRef p_s) /*@*/ ; | |
395 | extern cstring sRef_dumpGlobal (sRef p_s) /*@*/ ; | |
396 | extern /*@exposed@*/ sRef sRef_undump (char **p_c) /*@modifies *p_c@*/ ; | |
397 | extern /*@exposed@*/ sRef sRef_undumpGlobal (char **p_c) /*@modifies *p_c@*/ ; | |
398 | ||
399 | extern /*@only@*/ sRef sRef_saveCopy (sRef p_s); | |
400 | extern /*@dependent@*/ sRef sRef_copy (sRef p_s); | |
401 | ||
402 | extern cstring sRef_unparseState (sRef p_s) /*@*/ ; | |
403 | extern ynm sRef_isWriteable (sRef p_s) /*@*/ ; | |
404 | extern ynm sRef_isReadable (sRef p_s) /*@*/ ; | |
405 | extern bool sRef_isStrictReadable (sRef p_s) /*@*/ ; | |
406 | extern bool sRef_hasNoStorage (sRef p_s) /*@*/ ; | |
407 | extern void sRef_showExpInfo (sRef p_s) /*@modifies g_msgstream*/ ; | |
408 | extern void sRef_setDefined (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
409 | extern void sRef_setUndefined (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
410 | extern void sRef_setOnly (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
411 | extern void sRef_setDependent (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
412 | extern void sRef_setOwned (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
413 | extern void sRef_setKept (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
414 | extern void sRef_setKeptComplete (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
415 | extern void sRef_setFresh (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
416 | extern void sRef_setShared (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
417 | extern void sRef_showAliasInfo (sRef p_s) /*@modifies g_msgstream@*/ ; | |
28bf4b0b | 418 | extern void sRef_showMetaStateInfo (sRef p_s, cstring p_key) /*@modifies g_msgstream@*/ ; |
885824d3 | 419 | extern void sRef_showNullInfo (sRef p_s) /*@modifies g_msgstream@*/ ; |
420 | extern void sRef_showStateInfo (sRef p_s) /*@modifies g_msgstream@*/ ; | |
421 | extern void sRef_setStateFromType (sRef p_s, ctype p_ct) /*@modifies p_s@*/ ; | |
422 | extern void sRef_kill (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
423 | extern void sRef_setAllocated (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
424 | extern void sRef_setAllocatedShallowComplete (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
425 | extern void sRef_setAllocatedComplete (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; | |
426 | extern /*@only@*/ cstring sRef_unparseKindNamePlain (sRef p_s) /*@*/ ; | |
427 | extern /*@falsenull@*/ bool sRef_isRealGlobal(sRef p_s) /*@*/ ; | |
428 | extern /*@falsenull@*/ bool sRef_isFileStatic (sRef p_s) /*@*/ ; | |
429 | ||
430 | extern int sRef_getScope (sRef p_s) /*@*/ ; | |
431 | extern /*@observer@*/ cstring sRef_getScopeName (sRef p_s) /*@*/ ; | |
432 | ||
433 | /* must be real function (passed as function param) */ | |
434 | extern /*@falsenull@*/ bool sRef_isDead (sRef p_s) /*@*/ ; | |
435 | extern /*@falsenull@*/ bool sRef_isDeadStorage (sRef p_s) /*@*/ ; | |
436 | extern bool sRef_isStateLive (sRef p_s) /*@*/ ; | |
437 | extern /*@falsenull@*/ bool sRef_isPossiblyDead (sRef p_s) /*@*/ ; | |
438 | extern /*@truenull@*/ bool sRef_isStateUndefined (sRef p_s) /*@*/ ; | |
439 | extern bool sRef_isUnuseable (sRef p_s) /*@*/ ; | |
440 | ||
441 | extern /*@exposed@*/ sRef sRef_constructDeref (sRef p_t) | |
442 | /*@modifies p_t@*/ ; | |
443 | ||
444 | extern /*@exposed@*/ sRef sRef_constructDeadDeref (sRef p_t) | |
445 | /*@modifies p_t@*/ ; | |
446 | ||
447 | extern bool sRef_isJustAllocated (sRef p_s) /*@*/ ; | |
448 | ||
449 | extern /*@falsenull@*/ bool sRef_isAllocated (sRef p_s) /*@*/ ; | |
450 | ||
451 | extern bool sRef_isUndefGlob (/*@sef@*/ sRef p_s) /*@*/ ; | |
452 | # define sRef_isUndefGlob(s) \ | |
453 | ((sRef_isValid(s)) \ | |
454 | && ((s)->defstate == SS_UNDEFGLOB || (s)->defstate == SS_UNDEFKILLED)) | |
455 | ||
456 | extern bool sRef_isKilledGlob (/*@sef@*/ sRef p_s) /*@*/ ; | |
457 | # define sRef_isKilledGlob(s) \ | |
458 | ((sRef_isValid(s)) \ | |
459 | && ((s)->defstate == SS_KILLED || (s)->defstate == SS_UNDEFKILLED)) | |
460 | ||
461 | extern bool sRef_isRelDef (/*@sef@*/ sRef p_s) /*@*/ ; | |
462 | # define sRef_isRelDef(s) \ | |
463 | ((sRef_isValid(s)) && ((s)->defstate == SS_RELDEF)) | |
464 | ||
465 | extern bool sRef_isPartial (/*@sef@*/ sRef p_s) /*@*/ ; | |
466 | # define sRef_isPartial(s) \ | |
467 | ((sRef_isValid(s)) && ((s)->defstate == SS_PARTIAL)) | |
468 | ||
469 | extern bool sRef_isStateSpecial (/*@sef@*/ sRef p_s) /*@*/ ; | |
470 | # define sRef_isStateSpecial(s) \ | |
471 | ((sRef_isValid(s)) && ((s)->defstate == SS_SPECIAL)) | |
472 | ||
28bf4b0b | 473 | extern bool sRef_makeStateSpecial (sRef p_s) |
474 | /*@modifies p_s@*/ | |
475 | /* returns false is sRef already has an inconsistend defstate */ ; | |
476 | ||
885824d3 | 477 | extern bool sRef_isStateDefined (/*@sef@*/ sRef p_s) /*@*/ ; |
478 | # define sRef_isStateDefined(s) \ | |
479 | ((sRef_isValid(s)) && (((s)->defstate == SS_DEFINED) \ | |
480 | || (s)->defstate == SS_RELDEF)) | |
481 | ||
482 | extern bool sRef_isAnyDefined (/*@sef@*/ sRef p_s) /*@*/ ; | |
483 | # define sRef_isAnyDefined(s) ((sRef_isValid(s)) && \ | |
484 | (((s)->defstate == SS_DEFINED) \ | |
485 | || ((s)->defstate == SS_RELDEF) \ | |
486 | || ((s)->defstate == SS_PARTIAL))) | |
487 | ||
488 | extern /*@falsenull@*/ bool sRef_isPdefined (/*@sef@*/ sRef p_s) /*@*/ ; | |
489 | # define sRef_isPdefined(s) \ | |
490 | ((sRef_isValid(s)) && ((s)->defstate == SS_PDEFINED)) | |
491 | ||
492 | extern bool sRef_isReallyDefined (sRef p_s) /*@*/ ; | |
493 | ||
494 | extern bool sRef_isStateUnknown (/*@sef@*/ sRef p_s) /*@*/ ; | |
495 | # define sRef_isStateUnknown(s) \ | |
496 | ((sRef_isValid(s)) && ((s)->defstate == SS_UNKNOWN)) | |
497 | ||
498 | extern /*@falsenull@*/ bool sRef_isRefCounted (/*@sef@*/ sRef p_s) /*@*/ ; | |
499 | # define sRef_isRefCounted(s) \ | |
500 | ((sRef_isValid(s)) && ((s)->aliaskind == AK_REFCOUNTED)) | |
501 | ||
502 | extern /*@falsenull@*/ bool sRef_isNewRef (/*@sef@*/ sRef p_s) /*@*/ ; | |
503 | # define sRef_isNewRef(s) \ | |
504 | ((sRef_isValid(s)) && ((s)->aliaskind == AK_NEWREF)) | |
505 | ||
506 | extern /*@falsenull@*/ bool sRef_isKillRef (/*@sef@*/ sRef p_s) /*@*/ ; | |
507 | # define sRef_isKillRef(s) \ | |
508 | ((sRef_isValid(s)) && ((s)->aliaskind == AK_KILLREF)) | |
509 | ||
510 | extern bool sRef_isOnly (sRef p_s) /*@*/ ; | |
511 | extern bool sRef_isDependent (sRef p_s) /*@*/ ; | |
512 | extern bool sRef_isOwned (/*@sef@*/ sRef p_s) /*@*/ ; | |
513 | extern bool sRef_isKeep (/*@sef@*/ sRef p_s) /*@*/ ; | |
514 | ||
515 | extern bool sRef_isKept (/*@sef@*/ sRef p_s) /*@*/ ; | |
516 | # define sRef_isKept(s) \ | |
517 | ((sRef_isValid(s)) && ((s)->aliaskind == AK_KEPT)) | |
518 | ||
519 | extern /*@unused@*/ bool sRef_isTemp (sRef p_s) /*@*/ ; | |
520 | ||
521 | extern bool sRef_isStack (sRef p_s) /*@*/ ; | |
522 | extern bool sRef_isLocalState (sRef p_s) /*@*/ ; | |
523 | extern bool sRef_isUnique (sRef p_s) /*@*/ ; | |
524 | extern bool sRef_isShared (sRef p_s) /*@*/ ; | |
525 | extern bool sRef_isExposed (sRef p_s) /*@*/ ; | |
526 | extern bool sRef_isObserver (sRef p_s) /*@*/ ; | |
527 | extern bool sRef_isFresh (sRef p_s) /*@*/ ; | |
528 | ||
529 | extern bool sRef_isRefsField (/*@sef@*/ sRef p_s) /*@*/ ; | |
530 | # define sRef_isRefsField(s) \ | |
531 | ((sRef_isValid(s)) && ((s)->aliaskind == AK_REFS)) | |
532 | ||
533 | extern void sRef_protectDerivs (void) /*@modifies internalState@*/ ; | |
534 | extern void sRef_clearProtectDerivs (void) /*@modifies internalState@*/ ; | |
535 | ||
536 | extern exkind sRef_getExKind (sRef p_s) /*@*/ ; | |
537 | extern exkind sRef_getOrigExKind (sRef p_s) /*@*/ ; | |
538 | extern void sRef_setExKind (sRef p_s, exkind p_exp, fileloc p_loc) /*@modifies p_s@*/ ; | |
539 | extern void sRef_setExposed (sRef p_s, fileloc p_loc) /*@modifies p_s@*/; | |
540 | ||
541 | extern bool sRef_isAnyParam (sRef p_s) /*@*/ ; | |
28bf4b0b | 542 | extern /*@observer@*/ sRef sRef_getAliasInfoRef (/*@temp@*/ sRef p_s) /*@*/ ; |
885824d3 | 543 | extern bool sRef_hasAliasInfoRef (sRef p_s) /*@*/ ; |
544 | ||
28bf4b0b | 545 | extern /*@exposed@*/ sRef sRef_constructPointer (/*@exposed@*/ sRef p_t) /*@modifies p_t*/ ; |
885824d3 | 546 | extern bool sRef_isAliasCheckedGlobal (sRef p_s) /*@*/ ; |
547 | extern bool sRef_includedBy (sRef p_small, sRef p_big) /*@*/ ; | |
548 | extern /*@dependent@*/ /*@exposed@*/ sRef sRef_makeExternal (/*@exposed@*/ sRef p_t) /*@*/ ; | |
549 | extern bool sRef_similarRelaxed (sRef p_s1, sRef p_s2) /*@*/ ; | |
550 | extern /*@only@*/ cstring sRef_unparseKindName (sRef p_s) /*@*/ ; | |
551 | extern void sRef_copyState (sRef p_s1, sRef p_s2) /*@modifies p_s1@*/ ; | |
552 | extern /*@unused@*/ bool sRef_isObject (sRef p_s) /*@*/ ; | |
553 | extern bool sRef_isNotUndefined (sRef p_s) /*@*/ ; | |
554 | extern bool sRef_isExternal (sRef p_s) /*@*/ ; | |
555 | extern cstring sRef_unparseDeep (sRef p_s) /*@*/ ; | |
556 | extern cstring sRef_unparseFull (sRef p_s) /*@*/ ; | |
557 | extern /*@observer@*/ cstring sRef_unparseScope (sRef p_s) /*@*/ ; | |
558 | extern void sRef_mergeState (sRef p_res, sRef p_other, clause p_cl, fileloc p_loc) | |
559 | /*@modifies p_res, p_other@*/ ; | |
560 | extern void sRef_mergeOptState (sRef p_res, sRef p_other, clause p_cl, fileloc p_loc) | |
561 | /*@modifies p_res, p_other@*/ ; | |
562 | extern void sRef_mergeStateQuiet (sRef p_res, sRef p_other) | |
563 | /*@modifies p_res@*/ ; | |
28bf4b0b | 564 | extern void sRef_mergeStateQuietReverse (/*@dependent@*/ sRef p_res, /*@dependent@*/ sRef p_other) |
885824d3 | 565 | /*@modifies p_res@*/ ; |
566 | extern void sRef_setStateFromUentry (sRef p_s, uentry p_ue) | |
567 | /*@modifies p_s@*/ ; | |
568 | extern bool sRef_isStackAllocated (sRef p_s) /*@*/ ; | |
569 | extern bool sRef_modInFunction (void) /*@*/ ; | |
570 | extern void sRef_clearAliasState (sRef p_s, fileloc p_loc) | |
571 | /*@modifies p_s@*/ ; | |
572 | extern void sRef_setPartial (sRef p_s, fileloc p_loc) | |
573 | /*@modifies p_s@*/ ; | |
574 | extern void sRef_setDerivNullState (sRef p_set, sRef p_guide, nstate p_ns) | |
575 | /*@modifies p_set@*/ ; | |
576 | ||
577 | extern void sRef_clearGlobalScope (void) /*@modifies internalState@*/ ; | |
578 | ||
28bf4b0b | 579 | extern /*@dependent@*/ sRef sRef_makeDerived (/*@exposed@*/ sRef p_t); |
885824d3 | 580 | |
581 | extern sstate sRef_getDefState (sRef p_s) /*@*/ ; | |
582 | extern void sRef_setDefState (sRef p_s, sstate p_defstate, fileloc p_loc); | |
583 | extern void sRef_showRefLost (sRef p_s); | |
584 | extern void sRef_showRefKilled (sRef p_s); | |
585 | extern /*@exposed@*/ sRef sRef_updateSref (sRef p_s); | |
586 | ||
28bf4b0b | 587 | extern void sRef_reflectAnnotation (sRef p_s, annotationInfo p_a, fileloc p_loc); |
588 | extern /*@observer@*/ valueTable sRef_getValueTable (sRef p_s) /*@*/ ; | |
589 | ||
885824d3 | 590 | extern void sRef_aliasCheckPred (bool (p_predf) (sRef, exprNode, sRef, exprNode), |
591 | /*@null@*/ bool (p_checkAliases) (sRef), | |
592 | sRef p_s, exprNode p_e, exprNode p_err); | |
593 | extern bool sRef_aliasCheckSimplePred (sRefTest p_predf, sRef p_s); | |
594 | ||
595 | extern void sRef_showStateInconsistent (sRef p_s); | |
596 | ||
597 | extern void sRef_setDependentComplete (sRef p_s, fileloc p_loc); | |
598 | ||
599 | extern void sRef_setAliasKindComplete (sRef p_s, alkind p_kind, fileloc p_loc); | |
600 | ||
601 | extern bool sRef_isThroughArrayFetch (sRef p_s) /*@*/ ; | |
602 | ||
603 | extern /*@exposed@*/ /*@notnull@*/ sRef sRef_getConjA (sRef p_s) /*@*/ ; | |
604 | extern /*@exposed@*/ /*@notnull@*/ sRef sRef_getConjB (sRef p_s) /*@*/ ; | |
605 | ||
606 | extern /*@only@*/ cstring sRef_unparsePreOpt (sRef p_s) /*@*/ ; | |
607 | ||
608 | extern bool sRef_hasName (sRef p_s) /*@*/ ; | |
885824d3 | 609 | extern void sRef_free (/*@only@*/ sRef p_s); |
885824d3 | 610 | extern void sRef_setObserver (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ; |
611 | ||
1ac6313d | 612 | /* start modifications */ |
613 | /* functions for making modification to null-term info */ | |
28bf4b0b | 614 | extern void sRef_setNullTerminatedStateInnerComplete(sRef p_s, struct s_bbufinfo p_b, fileloc p_loc); |
615 | extern struct s_bbufinfo sRef_getNullTerminatedState(sRef p_s); | |
1ac6313d | 616 | extern void sRef_setNullTerminatedState (sRef p_s); |
617 | extern void sRef_setPossiblyNullTerminatedState (sRef p_s); | |
618 | extern void sRef_setNotNullTerminatedState (sRef p_s); | |
4cccc6ad | 619 | extern void sRef_setSize(sRef p_s, int p_size); |
620 | extern void sRef_setLen(sRef p_s, int p_len); | |
1ac6313d | 621 | |
622 | extern int sRef_getSize(sRef p_s); | |
84c9ffbf | 623 | |
624 | /*@-nullderef@*/ | |
625 | ||
1ac6313d | 626 | #define sRef_getSize(p_s) \ |
ef2aa32a | 627 | ((p_s)->bufinfo.size) |
1ac6313d | 628 | |
629 | extern int sRef_getLen(sRef p_s); | |
630 | #define sRef_getLen(p_s) \ | |
ef2aa32a | 631 | ((p_s)->bufinfo.len) |
1ac6313d | 632 | |
28bf4b0b | 633 | extern bool sRef_hasBufStateInfo(sRef p_s); |
1ac6313d | 634 | # define sRef_hasBufStateInfo(p_s) \ |
635 | (sRef_isValid(p_s)) | |
636 | ||
84c9ffbf | 637 | extern bool sRef_isNullTerminated(/*@sef@*/sRef p_s); |
1ac6313d | 638 | # define sRef_isNullTerminated(p_s) \ |
84c9ffbf | 639 | ( sRef_hasBufStateInfo((p_s)) ? ((p_s)->bufinfo.bufstate \ |
1ac6313d | 640 | == BB_NULLTERMINATED) : FALSE) |
641 | ||
84c9ffbf | 642 | extern bool sRef_isPossiblyNullTerminated(/*@sef@*/sRef p_s); |
1ac6313d | 643 | # define sRef_isPossiblyNullTerminated(p_s) \ |
34f0c5e7 | 644 | ( sRef_hasBufStateInfo((p_s)) ? ( (p_s)->bufinfo.bufstate \ |
1ac6313d | 645 | == BB_POSSIBLYNULLTERMINATED) : FALSE) |
646 | ||
84c9ffbf | 647 | extern bool sRef_isNotNullTerminated(/*@sef@*/sRef p_s); |
1ac6313d | 648 | # define sRef_isNotNullTerminated(p_s) \ |
84c9ffbf | 649 | ( sRef_hasBufStateInfo((p_s)) ? ((p_s)->bufinfo.bufstate \ |
1ac6313d | 650 | == BB_NOTNULLTERMINATED) : FALSE) |
34f0c5e7 | 651 | |
84c9ffbf | 652 | /*@=nullderef@*/ |
653 | ||
654 | ||
34f0c5e7 | 655 | /*drl7x 11/28/00*/ |
dc92450f | 656 | extern bool sRef_isFixedArray (sRef p_s) /*@*/; |
34f0c5e7 | 657 | |
dc92450f | 658 | extern long int sRef_getArraySize (sRef p_s) /*@*/; |
34f0c5e7 | 659 | |
4cccc6ad | 660 | extern /*@observer@*/ cstring sRef_ntMessage (sRef p_s); |
28bf4b0b | 661 | extern void sRef_resetLen (sRef p_s) /*@modifies p_s@*/ ; |
662 | ||
1ac6313d | 663 | /* end modifications */ |
664 | ||
28bf4b0b | 665 | extern void sRef_setMetaStateValueComplete (sRef p_s, cstring p_key, int p_value, fileloc p_loc) |
666 | /*@modifies p_s@*/ ; | |
667 | ||
668 | extern void sRef_setMetaStateValue (sRef p_s, cstring p_key, int p_value, fileloc p_loc) | |
669 | /*@modifies p_s@*/ ; | |
670 | ||
671 | extern /*@observer@*/ stateValue sRef_getMetaStateValue (sRef p_s, cstring p_key) /*@*/ ; | |
672 | ||
673 | extern bool sRef_checkMetaStateValue (sRef p_s, cstring p_key, int p_value) | |
674 | /*@modifies p_s@*/ ; | |
675 | ||
b9904f57 | 676 | extern void sRef_setValue (sRef p_s, /*@only@*/ multiVal p_val) /*@modifies p_s@*/ ; |
677 | extern bool sRef_hasValue (sRef p_s) /*@*/ ; | |
678 | extern /*@observer@*/ multiVal sRef_getValue (sRef p_s) /*@*/ ; | |
679 | ||
28bf4b0b | 680 | extern /*@mayexit@*/ void sRef_checkValid (/*@temp@*/ sRef p_s) /*@modifies stderr@*/ ; |
2934b455 | 681 | |
885824d3 | 682 | # else |
683 | # error "Multiple include" | |
684 | # endif | |
685 | ||
686 | ||
687 | ||
688 | ||
689 | ||
690 | ||
691 | ||
692 | ||
693 | ||
694 | ||
695 | ||
696 | ||
697 |