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