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