src/Headers/sRef.h

   1 /*
   2 ** Copyright (C) University of Virginia, Massachusetts Institue of Technology 1994-2001.
   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,
  25   SR_SYSTEM,
  26   SR_GLOBALMARKER
  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
  49 typedef struct
  50 {
  51   int    lexlevel;
  52   usymId index;
  53 } *cref;
  54
  55 typedef struct
  56 {
  57   /*@exposed@*/ /*@notnull@*/ sRef arr;
  58   bool indknown;
  59   int  ind;
  60 } *ainfo;
  61
  62 typedef struct
  63 {
  64   /*@exposed@*/ /*@notnull@*/  sRef rec;
  65   /*@observer@*/ cstring field;
  66 } *fldinfo ;
  67
  68 typedef struct
  69 {
  70   /*@exposed@*/ /*@notnull@*/ sRef a;
  71   /*@exposed@*/ /*@notnull@*/ sRef b;
  72 } *cjinfo ;
  73
  74 typedef union
  75 {
  76   /*@only@*/ cref     cvar;
  77              int      paramno;
  78   /*@only@*/ ainfo    arrayfetch;
  79   /*@only@*/ fldinfo  field;
  80              ctype    object;
  81   /*@observer@*/ cstring fname; /* unconstrained, new */
  82   /*@exposed@*/ /*@notnull@*/ sRef ref;
  83   /*@only@*/ cjinfo   conj;
  84              speckind   spec;
  85 } *sinfo;
  86
  87 struct s_sRef
  88 {
  89   /* does it need to be inside parens (macros) */
  90   bool safe;
  91
  92   /* has it been modified */
  93   bool modified; /*  BOOLBITS; */
  94
  95   /* for debugging: make this sRef as immutable. */
  96   bool immut; /*  BOOLBITS; */
  97
  98   skind kind;
  99   ctype type;
 100
 101   multiVal val; /* Some sRef's have known values */
 102
 103   sstate defstate;
 104   nstate nullstate;
 105
 106   /* start modifications: We keep a track of the buf state(nullterm info)*/
 107   struct s_bbufinfo bufinfo;
 108   /* end modifications */
 109
 110   alkind aliaskind;
 111   alkind oaliaskind;
 112
 113   exkind expkind;     /* exposed, observer, normal */
 114   exkind oexpkind;
 115
 116   /* where it becomes observer/exposed */
 117   /*@null@*/ /*@only@*/ stateInfo expinfo;
 118
 119   /* where it changed alias kind */
 120   /*@null@*/ /*@only@*/ stateInfo aliasinfo;
 121
 122   /* where it is defined/allocated */
 123   /*@null@*/ /*@only@*/ stateInfo definfo;
 124
 125   /* where it is null */
 126   /*@null@*/ /*@only@*/ stateInfo nullinfo;
 127
 128   /*@only@*/ /*@relnull@*/ sinfo info;
 129
 130   /* stores fields for structs, elements for arrays, derefs for pointers */
 131   /*@only@*/ sRefSet deriv;
 132
 133   /* sRef's include a lookup table of state variables. */
 134   /*@only@*/ valueTable state;
 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
 141 extern bool sRef_definitelyNullContext (sRef p_s);
 142 extern bool sRef_definitelyNullAltContext (sRef p_s);
 143
 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);
 148 extern void sRef_setNullStateN (sRef p_s, nstate p_n);
 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 /*@nullwhentrue@*/ bool sRef_isInvalid (sRef p_s) /*@*/ ;
 154 extern /*@falsewhennull@*/ 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
 166 extern bool sRef_isDefinitelyNull (sRef p_s) /*@*/ ;
 167
 168 extern /*@falsewhennull@*/ bool sRef_isLocalVar (sRef p_s) /*@*/ ;
 169 extern /*@falsewhennull@*/ bool sRef_isNSLocalVar (sRef p_s) /*@*/ ;
 170 extern /*@falsewhennull@*/ bool sRef_isRealLocalVar (sRef p_s) /*@*/ ;
 171 extern /*@falsewhennull@*/ bool sRef_isLocalParamVar (sRef p_s) /*@*/ ;
 172 extern /*@falsewhennull@*/ 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) /*@*/ ;
 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 /*@falsewhennull@*/ 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
 220 extern /*@observer@*/ sRefSet sRef_derivedFields (/*@temp@*/ sRef p_rec) /*@*/ ;
 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 /*@falsewhennull@*/ 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) /*@*/ ;
 243 extern bool sRef_isGlobalMarker (sRef p_s) /*@*/ ;
 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
 250 extern bool sRef_isFileOrGlobalScope (sRef p_s) /*@*/ ;
 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
 256 extern void sRef_markImmutable (sRef p_s) /*@modifies p_s@*/ ;
 257
 258 extern /*@falsewhennull@*/ bool sRef_isAddress (sRef p_s) /*@*/ ;
 259 extern /*@falsewhennull@*/ bool sRef_isArrayFetch (sRef p_s) /*@*/ ;
 260 extern /*@falsewhennull@*/ bool sRef_isConst (sRef p_s) /*@*/ ;
 261 extern /*@falsewhennull@*/ bool sRef_isCvar (sRef p_s) /*@*/ ;
 262 extern /*@falsewhennull@*/ bool sRef_isField (sRef p_s) /*@*/ ;
 263 extern /*@falsewhennull@*/ bool sRef_isParam (sRef p_s) /*@*/ ;
 264 extern /*@falsewhennull@*/ 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);
 269 extern void sRef_setLastReference (/*@temp@*/ sRef p_s, /*@exposed@*/ sRef p_ref, fileloc p_loc);
 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) /*@*/ ;
 279 extern bool sRef_sameObject (sRef p_s1, sRef p_s2) /*@*/ ;
 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
 292 /* Use this one to clear after error */
 293 extern void sRef_setDefinedCompleteDirect (sRef p_s, fileloc p_loc) ;
 294
 295 extern void sRef_setDefinedComplete (sRef p_s, fileloc p_loc) ;
 296 extern void sRef_setDefinedNCComplete (sRef p_s, fileloc p_loc) ;
 297 extern int sRef_getParam (sRef p_s) /*@*/ ;
 298 extern int sRef_lexLevel (sRef p_s) /*@*/ ;
 299 extern void sRef_setOrigAliasKind (sRef p_s, alkind p_kind);
 300
 301 extern /*@exposed@*/ sRef
 302   sRef_fixBase (/*@returned@*/ sRef p_s, /*@returned@*/ sRef p_base)
 303   /*@modifies p_s, p_base@*/ ;
 304
 305 extern void sRef_showNotReallyDefined (sRef p_s) /*@modifies g_msgstream@*/ ;
 306
 307 extern void sRef_enterFunctionScope (void) /*@modifies internalState@*/ ;
 308 extern void sRef_setGlobalScope (void) /*@modifies internalState@*/ ;
 309 extern bool sRef_inGlobalScope (void) /*@*/ ;
 310 extern void sRef_exitFunctionScope (void) /*@modifies internalState@*/ ;
 311 extern void sRef_clearGlobalScopeSafe (void) /*@modifies internalState@*/ ;
 312 extern void sRef_setGlobalScopeSafe (void) /*@modifies internalState@*/ ;
 313
 314 extern /*@notnull@*/ /*@exposed@*/ sRef
 315   sRef_buildArrayFetch (/*@exposed@*/ sRef p_arr);
 316 extern /*@notnull@*/ /*@exposed@*/ sRef sRef_buildArrayFetchKnown (/*@exposed@*/ sRef p_arr, int p_i);
 317 extern /*@exposed@*/ sRef
 318   sRef_buildField (/*@exposed@*/ sRef p_rec, /*@dependent@*/ cstring p_f)
 319   /*@modifies p_rec@*/ ;
 320 extern /*@exposed@*/ sRef sRef_buildPointer (/*@exposed@*/ sRef p_t)
 321   /*@modifies p_t@*/ ;
 322
 323 extern /*@exposed@*/ sRef sRef_makeAddress (/*@exposed@*/ sRef p_t);
 324 extern /*@notnull@*/ /*@dependent@*/ sRef sRef_makeUnconstrained (/*@exposed@*/ cstring) /*@*/ ;
 325
 326 extern /*@falsewhennull@*/ bool sRef_isUnconstrained (sRef p_s) /*@*/ ;
 327
 328 extern /*@observer@*/ cstring sRef_unconstrainedName (sRef p_s) /*@*/ ;
 329
 330 extern /*@notnull@*/ /*@exposed@*/ sRef sRef_makeArrayFetch (/*@exposed@*/ sRef p_arr) /*@*/ ;
 331 extern /*@notnull@*/ /*@exposed@*/ sRef
 332   sRef_makeArrayFetchKnown (/*@exposed@*/ sRef p_arr, int p_i);
 333 extern /*@notnull@*/ /*@dependent@*/ sRef
 334   sRef_makeConj (/*@exposed@*/ /*@returned@*/ sRef p_a, /*@exposed@*/ sRef p_b);
 335 extern /*@notnull@*/ /*@dependent@*/ sRef
 336   sRef_makeCvar (int p_level, usymId p_index, ctype p_ct, /*@only@*/ stateInfo p_stinfo);
 337 extern /*@notnull@*/ /*@dependent@*/ sRef
 338   sRef_makeConst (ctype p_ct);
 339 extern /*@exposed@*/ sRef
 340   sRef_makeField (sRef p_rec, /*@dependent@*/ cstring p_f);
 341 extern /*@notnull@*/ /*@dependent@*/ sRef
 342   sRef_makeGlobal (usymId p_l, ctype p_ct, /*@only@*/ stateInfo);
 343 extern /*@exposed@*/ sRef
 344   sRef_makeNCField (/*@exposed@*/ sRef p_rec, /*@dependent@*/ cstring p_f) /*@*/ ;
 345 extern void sRef_maybeKill (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 346 extern /*@unused@*/ /*@notnull@*/ /*@dependent@*/ sRef
 347   sRef_makeObject (ctype p_o) /*@*/ ;
 348 extern /*@notnull@*/ /*@dependent@*/ sRef sRef_makeType (ctype p_ct) /*@*/ ;
 349 extern /*@notnull@*/ /*@dependent@*/ sRef sRef_makeParam (int p_l, ctype p_ct, /*@only@*/ stateInfo p_stinfo) /*@*/ ;
 350 extern /*@exposed@*/ sRef sRef_makePointer (/*@exposed@*/ sRef p_s) /*@modifies p_s@*/ ;
 351 extern void sRef_makeSafe (sRef p_s) /*@modifies p_s@*/ ;
 352 extern void sRef_makeUnsafe (sRef p_s) /*@modifies p_s@*/ ;
 353
 354 extern /*@dependent@*/ sRef sRef_makeUnknown (void) /*@*/ ;
 355 extern /*@dependent@*/ sRef sRef_makeNothing (void) /*@*/ ;
 356 extern /*@dependent@*/ sRef sRef_makeInternalState (void) /*@*/ ;
 357 extern /*@dependent@*/ sRef sRef_makeSpecState (void) /*@*/ ;
 358 extern /*@dependent@*/ sRef sRef_makeGlobalMarker (void) /*@*/ ;
 359 extern /*@dependent@*/ sRef sRef_makeSystemState (void) /*@*/ ;
 360
 361 extern /*@dependent@*/ /*@notnull@*/ sRef sRef_makeResult (ctype) /*@*/ ;
 362 extern /*@exposed@*/ sRef
 363   sRef_fixResultType (/*@returned@*/ sRef p_s, ctype p_typ, uentry p_ue)
 364   /*@modifies p_s@*/;
 365
 366 extern void sRef_setParamNo (sRef p_s, int p_l) /*@modifies p_s;@*/;
 367
 368 extern /*@notnull@*/ /*@dependent@*/ sRef
 369   sRef_makeNew (ctype p_ct, sRef p_t, /*@exposed@*/ cstring p_name) ;
 370
 371 extern usymId sRef_getScopeIndex (sRef p_s) /*@*/ ;
 372 extern /*@exposed@*/ uentry sRef_getBaseUentry (sRef p_s);
 373
 374 extern /*@exposed@*/ sRef
 375   sRef_fixBaseParam (/*@returned@*/ sRef p_s, exprNodeList p_args)
 376   /*@modifies p_s@*/ ;
 377
 378   /*
 379     drl7x
 380     added function
 381     12/24/2000
 382   */
 383
 384 /*@only@*/ constraintExpr sRef_fixConstraintParam (/*@observer@*/  sRef p_s, /*@observer@*/ /*@temp@*/ exprNodeList p_args);
 385
 386 extern bool sRef_isUnionField (sRef p_s);
 387 extern void sRef_setModified (sRef p_s);
 388
 389 extern void sRef_resetState (sRef p_s);
 390 extern void sRef_resetStateComplete (sRef p_s);
 391
 392 extern void sRef_storeState (sRef p_s);
 393 extern /*@exposed@*/ sRef sRef_getBase (sRef p_s) /*@*/ ;
 394 extern /*@exposed@*/ sRef sRef_getRootBase (sRef p_s) /*@*/ ;
 395
 396 extern /*@observer@*/ uentry sRef_getUentry (sRef p_s);
 397
 398 extern cstring sRef_dump (sRef p_s) /*@*/ ;
 399 extern cstring sRef_dumpGlobal (sRef p_s) /*@*/ ;
 400 extern /*@exposed@*/ sRef sRef_undump (char **p_c) /*@modifies *p_c@*/ ;
 401 extern /*@exposed@*/ sRef sRef_undumpGlobal (char **p_c) /*@modifies *p_c@*/ ;
 402
 403 extern /*@only@*/ sRef sRef_saveCopy (sRef p_s);
 404 extern /*@dependent@*/ sRef sRef_copy (sRef p_s);
 405
 406 extern cstring sRef_unparseState (sRef p_s) /*@*/ ;
 407 extern ynm sRef_isWriteable (sRef p_s) /*@*/ ;
 408 extern ynm sRef_isValidLvalue (sRef p_s) /*@*/ ;
 409 extern bool sRef_isStrictReadable (sRef p_s) /*@*/ ;
 410 extern bool sRef_hasNoStorage (sRef p_s) /*@*/ ;
 411 extern void sRef_showExpInfo (sRef p_s) /*@modifies g_msgstream*/ ;
 412 extern void sRef_setDefined (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 413 extern void sRef_setUndefined (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 414 extern void sRef_setOnly (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 415 extern void sRef_setDependent (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 416 extern void sRef_setOwned (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 417 extern void sRef_setKept (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 418 extern void sRef_setKeptComplete (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 419 extern void sRef_setFresh (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 420 extern void sRef_setShared (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 421 extern void sRef_showAliasInfo (sRef p_s) /*@modifies g_msgstream@*/ ;
 422 extern void sRef_showMetaStateInfo (sRef p_s, cstring p_key) /*@modifies g_msgstream@*/ ;
 423 extern void sRef_showNullInfo (sRef p_s) /*@modifies g_msgstream@*/ ;
 424 extern void sRef_showStateInfo (sRef p_s) /*@modifies g_msgstream@*/ ;
 425 extern void sRef_setStateFromType (sRef p_s, ctype p_ct) /*@modifies p_s@*/ ;
 426 extern void sRef_kill (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 427 extern void sRef_setAllocated (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 428 extern void sRef_setAllocatedShallowComplete (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 429 extern void sRef_setAllocatedComplete (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 430 extern /*@only@*/ cstring sRef_unparseKindNamePlain (sRef p_s) /*@*/ ;
 431 extern /*@falsewhennull@*/ bool sRef_isRealGlobal(sRef p_s) /*@*/ ;
 432 extern /*@falsewhennull@*/ bool sRef_isFileStatic (sRef p_s) /*@*/ ;
 433
 434 extern int sRef_getScope (sRef p_s) /*@*/ ;
 435 extern /*@observer@*/ cstring sRef_getScopeName (sRef p_s) /*@*/ ;
 436
 437 /* must be real function (passed as function param) */
 438 extern /*@falsewhennull@*/ bool sRef_isDead (sRef p_s) /*@*/ ;
 439 extern /*@falsewhennull@*/ bool sRef_isDeadStorage (sRef p_s) /*@*/ ;
 440 extern bool sRef_isStateLive (sRef p_s) /*@*/ ;
 441 extern /*@falsewhennull@*/ bool sRef_isPossiblyDead (sRef p_s) /*@*/ ;
 442 extern /*@nullwhentrue@*/ bool sRef_isStateUndefined (sRef p_s) /*@*/ ;
 443 extern bool sRef_isUnuseable (sRef p_s) /*@*/ ;
 444
 445 extern /*@exposed@*/ sRef sRef_constructDeref (sRef p_t)
 446    /*@modifies p_t@*/ ;
 447
 448 extern /*@exposed@*/ sRef sRef_constructDeadDeref (sRef p_t)
 449    /*@modifies p_t@*/ ;
 450
 451 extern bool sRef_isJustAllocated (sRef p_s) /*@*/ ;
 452
 453 extern /*@falsewhennull@*/ bool sRef_isAllocated (sRef p_s) /*@*/ ;
 454
 455 extern bool sRef_isUndefGlob (/*@sef@*/ sRef p_s) /*@*/ ;
 456 # define sRef_isUndefGlob(s) \
 457     ((sRef_isValid(s)) \
 458      && ((s)->defstate == SS_UNDEFGLOB || (s)->defstate == SS_UNDEFKILLED))
 459
 460 extern bool sRef_isKilledGlob (/*@sef@*/ sRef p_s) /*@*/ ;
 461 # define sRef_isKilledGlob(s) \
 462     ((sRef_isValid(s)) \
 463      && ((s)->defstate == SS_KILLED || (s)->defstate == SS_UNDEFKILLED))
 464
 465 extern bool sRef_isRelDef (/*@sef@*/ sRef p_s) /*@*/ ;
 466 # define sRef_isRelDef(s) \
 467   ((sRef_isValid(s)) && ((s)->defstate == SS_RELDEF))
 468
 469 extern bool sRef_isPartial (/*@sef@*/ sRef p_s) /*@*/ ;
 470 # define sRef_isPartial(s) \
 471   ((sRef_isValid(s)) && ((s)->defstate == SS_PARTIAL))
 472
 473 extern bool sRef_isStateSpecial (/*@sef@*/ sRef p_s) /*@*/ ;
 474 # define sRef_isStateSpecial(s) \
 475   ((sRef_isValid(s)) && ((s)->defstate == SS_SPECIAL))
 476
 477 extern bool sRef_makeStateSpecial (sRef p_s)
 478      /*@modifies p_s@*/
 479      /* returns false is sRef already has an inconsistend defstate */ ;
 480
 481 extern bool sRef_isStateDefined (/*@sef@*/ sRef p_s) /*@*/ ;
 482 # define sRef_isStateDefined(s) \
 483   ((sRef_isValid(s)) && (((s)->defstate == SS_DEFINED) \
 484                          || (s)->defstate == SS_RELDEF))
 485
 486 extern bool sRef_isAnyDefined (/*@sef@*/ sRef p_s) /*@*/ ;
 487 # define sRef_isAnyDefined(s)   ((sRef_isValid(s)) && \
 488                                  (((s)->defstate == SS_DEFINED) \
 489                                   || ((s)->defstate == SS_RELDEF) \
 490                                   || ((s)->defstate == SS_PARTIAL)))
 491
 492 extern /*@falsewhennull@*/ bool sRef_isPdefined (/*@sef@*/ sRef p_s) /*@*/ ;
 493 # define sRef_isPdefined(s) \
 494   ((sRef_isValid(s)) && ((s)->defstate == SS_PDEFINED))
 495
 496 extern bool sRef_isReallyDefined (sRef p_s) /*@*/ ;
 497
 498 extern bool sRef_isStateUnknown (/*@sef@*/ sRef p_s) /*@*/ ;
 499 # define sRef_isStateUnknown(s) \
 500   ((sRef_isValid(s)) && ((s)->defstate == SS_UNKNOWN))
 501
 502 extern /*@falsewhennull@*/ bool sRef_isRefCounted (/*@sef@*/ sRef p_s) /*@*/ ;
 503 # define sRef_isRefCounted(s) \
 504   ((sRef_isValid(s)) && ((s)->aliaskind == AK_REFCOUNTED))
 505
 506 extern /*@falsewhennull@*/ bool sRef_isNewRef (/*@sef@*/ sRef p_s) /*@*/ ;
 507 # define sRef_isNewRef(s) \
 508   ((sRef_isValid(s)) && ((s)->aliaskind == AK_NEWREF))
 509
 510 extern /*@falsewhennull@*/ bool sRef_isKillRef (/*@sef@*/ sRef p_s) /*@*/ ;
 511 # define sRef_isKillRef(s) \
 512   ((sRef_isValid(s)) && ((s)->aliaskind == AK_KILLREF))
 513
 514 extern bool sRef_isOnly (sRef p_s) /*@*/ ;
 515 extern bool sRef_isDependent (sRef p_s) /*@*/ ;
 516 extern bool sRef_isOwned (/*@sef@*/ sRef p_s) /*@*/ ;
 517 extern bool sRef_isKeep (/*@sef@*/ sRef p_s) /*@*/ ;
 518
 519 extern bool sRef_isKept (/*@sef@*/ sRef p_s) /*@*/ ;
 520 # define sRef_isKept(s) \
 521   ((sRef_isValid(s)) && ((s)->aliaskind == AK_KEPT))
 522
 523 extern /*@unused@*/ bool sRef_isTemp (sRef p_s) /*@*/ ;
 524
 525 extern bool sRef_isStack (sRef p_s) /*@*/ ;
 526 extern bool sRef_isLocalState (sRef p_s) /*@*/ ;
 527 extern bool sRef_isUnique (sRef p_s) /*@*/ ;
 528 extern bool sRef_isShared (sRef p_s) /*@*/ ;
 529 extern bool sRef_isExposed (sRef p_s) /*@*/ ;
 530 extern bool sRef_isObserver (sRef p_s) /*@*/ ;
 531 extern bool sRef_isFresh (sRef p_s) /*@*/ ;
 532
 533 extern bool sRef_isRefsField (/*@sef@*/ sRef p_s) /*@*/ ;
 534 # define sRef_isRefsField(s) \
 535   ((sRef_isValid(s)) && ((s)->aliaskind == AK_REFS))
 536
 537 extern void sRef_protectDerivs (void) /*@modifies internalState@*/ ;
 538 extern void sRef_clearProtectDerivs (void) /*@modifies internalState@*/ ;
 539
 540 extern exkind sRef_getExKind (sRef p_s) /*@*/ ;
 541 extern exkind sRef_getOrigExKind (sRef p_s) /*@*/ ;
 542 extern void sRef_setExKind (sRef p_s, exkind p_exp, fileloc p_loc) /*@modifies p_s@*/ ;
 543 extern void sRef_setExposed (sRef p_s, fileloc p_loc) /*@modifies p_s@*/;
 544
 545 extern bool sRef_isAnyParam (sRef p_s) /*@*/ ;
 546 extern /*@observer@*/ sRef sRef_getAliasInfoRef (/*@temp@*/ sRef p_s) /*@*/ ;
 547 extern bool sRef_hasAliasInfoRef (sRef p_s) /*@*/ ;
 548
 549 extern /*@exposed@*/ sRef sRef_constructPointer (/*@exposed@*/ sRef p_t) /*@modifies p_t*/ ;
 550 extern bool sRef_isAliasCheckedGlobal (sRef p_s) /*@*/ ;
 551 extern bool sRef_includedBy (sRef p_small, sRef p_big) /*@*/ ;
 552 extern /*@dependent@*/ /*@exposed@*/ sRef sRef_makeExternal (/*@exposed@*/ sRef p_t) /*@*/ ;
 553 extern bool sRef_similarRelaxed (sRef p_s1, sRef p_s2) /*@*/ ;
 554 extern /*@only@*/ cstring sRef_unparseKindName (sRef p_s) /*@*/ ;
 555 extern void sRef_copyState (sRef p_s1, sRef p_s2) /*@modifies p_s1@*/ ;
 556 extern /*@unused@*/ bool sRef_isObject (sRef p_s) /*@*/ ;
 557 extern bool sRef_isNotUndefined (sRef p_s) /*@*/ ;
 558 extern bool sRef_isExternal (sRef p_s) /*@*/ ;
 559 extern cstring sRef_unparseDeep (sRef p_s) /*@*/ ;
 560 extern cstring sRef_unparseFull (sRef p_s) /*@*/ ;
 561 extern /*@observer@*/ cstring sRef_unparseScope (sRef p_s) /*@*/ ;
 562 extern void sRef_mergeState (sRef p_res, sRef p_other, clause p_cl, fileloc p_loc)
 563    /*@modifies p_res, p_other@*/ ;
 564 extern void sRef_mergeOptState (sRef p_res, sRef p_other, clause p_cl, fileloc p_loc)
 565    /*@modifies p_res, p_other@*/ ;
 566 extern void sRef_mergeStateQuiet (sRef p_res, sRef p_other)
 567    /*@modifies p_res@*/ ;
 568 extern void sRef_mergeStateQuietReverse (/*@dependent@*/ sRef p_res, /*@dependent@*/ sRef p_other)
 569    /*@modifies p_res@*/ ;
 570 extern void sRef_setStateFromUentry (sRef p_s, uentry p_ue)
 571    /*@modifies p_s@*/ ;
 572 extern bool sRef_isStackAllocated (sRef p_s) /*@*/ ;
 573 extern bool sRef_modInFunction (void) /*@*/ ;
 574 extern void sRef_clearAliasState (sRef p_s, fileloc p_loc)
 575    /*@modifies p_s@*/ ;
 576 extern void sRef_setPartial (sRef p_s, fileloc p_loc)
 577    /*@modifies p_s@*/ ;
 578 extern void sRef_setDerivNullState (sRef p_set, sRef p_guide, nstate p_ns)
 579    /*@modifies p_set@*/ ;
 580
 581 extern void sRef_clearGlobalScope (void) /*@modifies internalState@*/ ;
 582
 583 extern /*@dependent@*/ sRef sRef_makeDerived (/*@exposed@*/ sRef p_t);
 584
 585 extern sstate sRef_getDefState (sRef p_s) /*@*/ ;
 586 extern void sRef_setDefState (sRef p_s, sstate p_defstate, fileloc p_loc);
 587 extern void sRef_showRefLost (sRef p_s);
 588 extern void sRef_showRefKilled (sRef p_s);
 589 extern /*@exposed@*/ sRef sRef_updateSref (sRef p_s);
 590
 591 extern void sRef_reflectAnnotation (sRef p_s, annotationInfo p_a, fileloc p_loc);
 592 extern /*@observer@*/ valueTable sRef_getValueTable (sRef p_s) /*@*/ ;
 593
 594 extern void sRef_aliasCheckPred (bool (p_predf) (sRef, exprNode, sRef, exprNode),
 595                                  /*@null@*/ bool (p_checkAliases) (sRef),
 596                                  sRef p_s, exprNode p_e, exprNode p_err);
 597 extern bool sRef_aliasCheckSimplePred (sRefTest p_predf, sRef p_s);
 598
 599 extern void sRef_showStateInconsistent (sRef p_s);
 600
 601 extern void sRef_setDependentComplete (sRef p_s, fileloc p_loc);
 602
 603 extern void sRef_setAliasKindComplete (sRef p_s, alkind p_kind, fileloc p_loc);
 604
 605 extern bool sRef_isThroughArrayFetch (sRef p_s) /*@*/ ;
 606
 607 extern /*@exposed@*/ /*@notnull@*/ sRef sRef_getConjA (sRef p_s) /*@*/ ;
 608 extern /*@exposed@*/ /*@notnull@*/ sRef sRef_getConjB (sRef p_s) /*@*/ ;
 609
 610 extern /*@only@*/ cstring sRef_unparsePreOpt (sRef p_s) /*@*/ ;
 611
 612 extern bool sRef_hasName (sRef p_s) /*@*/ ;
 613 extern void sRef_free (/*@only@*/ sRef p_s);
 614 extern void sRef_setObserver (sRef p_s, fileloc p_loc) /*@modifies p_s@*/ ;
 615
 616 /* start modifications */
 617 /* functions for making modification to null-term info */
 618 extern void sRef_setNullTerminatedStateInnerComplete(sRef p_s, struct s_bbufinfo p_b, fileloc p_loc);
 619 extern struct s_bbufinfo sRef_getNullTerminatedState(sRef p_s);
 620 extern void sRef_setNullTerminatedState (sRef p_s);
 621 extern void sRef_setPossiblyNullTerminatedState (sRef p_s);
 622 extern void sRef_setNotNullTerminatedState (sRef p_s);
 623 extern void sRef_setSize(sRef p_s, int p_size);
 624 extern void sRef_setLen(sRef p_s, int p_len);
 625
 626 extern int sRef_getSize(sRef p_s);
 627
 628 /*@-nullderef@*/
 629
 630 #define sRef_getSize(p_s) \
 631    ((p_s)->bufinfo.size)
 632
 633 extern int sRef_getLen(sRef p_s);
 634 #define sRef_getLen(p_s) \
 635    ((p_s)->bufinfo.len)
 636
 637 extern bool sRef_hasBufStateInfo(sRef p_s);
 638 # define sRef_hasBufStateInfo(p_s) \
 639     (sRef_isValid(p_s))
 640
 641 extern bool sRef_isNullTerminated(/*@sef@*/sRef p_s);
 642 # define sRef_isNullTerminated(p_s) \
 643    ( sRef_hasBufStateInfo((p_s)) ? ((p_s)->bufinfo.bufstate \
 644                == BB_NULLTERMINATED) : FALSE)
 645
 646 extern bool sRef_isPossiblyNullTerminated(/*@sef@*/sRef p_s);
 647 # define sRef_isPossiblyNullTerminated(p_s) \
 648    ( sRef_hasBufStateInfo((p_s)) ? ((p_s)->bufinfo.bufstate \
 649                == BB_POSSIBLYNULLTERMINATED) : FALSE)
 650
 651 extern bool sRef_isNotNullTerminated(/*@sef@*/sRef p_s);
 652 # define sRef_isNotNullTerminated(p_s) \
 653    ( sRef_hasBufStateInfo((p_s)) ? ((p_s)->bufinfo.bufstate \
 654                == BB_NOTNULLTERMINATED) : FALSE)
 655
 656 /*@=nullderef@*/
 657
 658
 659      /*drl7x 11/28/00*/
 660 extern  bool sRef_isFixedArray (sRef p_s) /*@*/;
 661
 662 extern long int sRef_getArraySize (sRef p_s) /*@*/;
 663
 664 extern /*@observer@*/ cstring sRef_ntMessage (sRef p_s);
 665 extern void sRef_resetLen (sRef p_s) /*@modifies p_s@*/ ;
 666
 667 /* end modifications */
 668
 669 extern void sRef_setMetaStateValueComplete (sRef p_s, cstring p_key, int p_value, fileloc p_loc)
 670    /*@modifies p_s@*/ ;
 671
 672 extern void sRef_setMetaStateValue (sRef p_s, cstring p_key, int p_value, fileloc p_loc)
 673    /*@modifies p_s@*/ ;
 674
 675 extern /*@observer@*/ stateValue sRef_getMetaStateValue (sRef p_s, cstring p_key) /*@*/ ;
 676
 677 extern bool sRef_checkMetaStateValue (sRef p_s, cstring p_key, int p_value)
 678    /*@modifies p_s@*/ ;
 679
 680 extern void sRef_setValue (sRef p_s, /*@only@*/ multiVal p_val) /*@modifies p_s@*/ ;
 681 extern bool sRef_hasValue (sRef p_s) /*@*/ ;
 682 extern /*@observer@*/ multiVal sRef_getValue (sRef p_s) /*@*/ ;
 683
 684 extern /*@maynotreturn@*/ void sRef_checkValid (/*@temp@*/ sRef p_s) /*@modifies stderr@*/ ;
 685
 686 extern void
 687 sRef_aliasSetComplete (void (p_predf) (sRef, fileloc), sRef p_s, fileloc p_loc)
 688      /*@modifies p_s@*/ ;
 689
 690 extern void
 691 sRef_aliasSetCompleteParam (void (p_predf) (sRef, int, fileloc), sRef p_s,
 692                             int p_kind, fileloc p_loc)
 693    /*@modifies p_s@*/ ;
 694
 695 extern void
 696 sRef_aliasSetCompleteAlkParam (void (p_predf) (sRef, alkind, fileloc), sRef p_s,
 697                                alkind p_kind, fileloc p_loc)
 698      /*@modifies p_s@*/ ;
 699
 700 # else
 701 # error "Multiple include"
 702 # endif
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715