1218887Sdim// SValBuilder.h - Construction of SVals from evaluating expressions -*- C++ -*- 2218887Sdim// 3218887Sdim// The LLVM Compiler Infrastructure 4218887Sdim// 5218887Sdim// This file is distributed under the University of Illinois Open Source 6218887Sdim// License. See LICENSE.TXT for details. 7218887Sdim// 8218887Sdim//===----------------------------------------------------------------------===// 9218887Sdim// 10218887Sdim// This file defines SValBuilder, a class that defines the interface for 11218887Sdim// "symbolical evaluators" which construct an SVal from an expression. 12218887Sdim// 13218887Sdim//===----------------------------------------------------------------------===// 14218887Sdim 15218887Sdim#ifndef LLVM_CLANG_GR_SVALBUILDER 16218887Sdim#define LLVM_CLANG_GR_SVALBUILDER 17218887Sdim 18239462Sdim#include "clang/AST/ASTContext.h" 19218887Sdim#include "clang/AST/Expr.h" 20234353Sdim#include "clang/AST/ExprObjC.h" 21218887Sdim#include "clang/StaticAnalyzer/Core/PathSensitive/BasicValueFactory.h" 22218887Sdim#include "clang/StaticAnalyzer/Core/PathSensitive/MemRegion.h" 23249423Sdim#include "clang/StaticAnalyzer/Core/PathSensitive/SVals.h" 24218887Sdim 25218887Sdimnamespace clang { 26218887Sdim 27234353Sdimclass CXXBoolLiteralExpr; 28234353Sdim 29218887Sdimnamespace ento { 30218887Sdim 31218887Sdimclass SValBuilder { 32234353Sdim virtual void anchor(); 33218887Sdimprotected: 34218887Sdim ASTContext &Context; 35218887Sdim 36218887Sdim /// Manager of APSInt values. 37218887Sdim BasicValueFactory BasicVals; 38218887Sdim 39218887Sdim /// Manages the creation of symbols. 40218887Sdim SymbolManager SymMgr; 41218887Sdim 42218887Sdim /// Manages the creation of memory regions. 43218887Sdim MemRegionManager MemMgr; 44218887Sdim 45226633Sdim ProgramStateManager &StateMgr; 46218887Sdim 47218887Sdim /// The scalar type to use for array indices. 48218887Sdim const QualType ArrayIndexTy; 49218887Sdim 50218887Sdim /// The width of the scalar type used for array indices. 51218887Sdim const unsigned ArrayIndexWidth; 52218887Sdim 53234353Sdim virtual SVal evalCastFromNonLoc(NonLoc val, QualType castTy) = 0; 54234353Sdim virtual SVal evalCastFromLoc(Loc val, QualType castTy) = 0; 55234353Sdim 56218887Sdimpublic: 57221345Sdim // FIXME: Make these protected again once RegionStoreManager correctly 58221345Sdim // handles loads from different bound value types. 59234353Sdim virtual SVal dispatchCast(SVal val, QualType castTy) = 0; 60218887Sdim 61218887Sdimpublic: 62218887Sdim SValBuilder(llvm::BumpPtrAllocator &alloc, ASTContext &context, 63226633Sdim ProgramStateManager &stateMgr) 64218887Sdim : Context(context), BasicVals(context, alloc), 65218887Sdim SymMgr(context, BasicVals, alloc), 66218887Sdim MemMgr(context, alloc), 67218887Sdim StateMgr(stateMgr), 68218887Sdim ArrayIndexTy(context.IntTy), 69218887Sdim ArrayIndexWidth(context.getTypeSize(ArrayIndexTy)) {} 70218887Sdim 71218887Sdim virtual ~SValBuilder() {} 72218887Sdim 73234353Sdim bool haveSameType(const SymExpr *Sym1, const SymExpr *Sym2) { 74243830Sdim return haveSameType(Sym1->getType(), Sym2->getType()); 75234353Sdim } 76234353Sdim 77234353Sdim bool haveSameType(QualType Ty1, QualType Ty2) { 78234353Sdim // FIXME: Remove the second disjunct when we support symbolic 79234353Sdim // truncation/extension. 80234353Sdim return (Context.getCanonicalType(Ty1) == Context.getCanonicalType(Ty2) || 81251662Sdim (Ty1->isIntegralOrEnumerationType() && 82251662Sdim Ty2->isIntegralOrEnumerationType())); 83234353Sdim } 84234353Sdim 85221345Sdim SVal evalCast(SVal val, QualType castTy, QualType originalType); 86218887Sdim 87218887Sdim virtual SVal evalMinus(NonLoc val) = 0; 88218887Sdim 89218887Sdim virtual SVal evalComplement(NonLoc val) = 0; 90218887Sdim 91234353Sdim /// Create a new value which represents a binary expression with two non 92234353Sdim /// location operands. 93234353Sdim virtual SVal evalBinOpNN(ProgramStateRef state, BinaryOperator::Opcode op, 94218887Sdim NonLoc lhs, NonLoc rhs, QualType resultTy) = 0; 95218887Sdim 96234353Sdim /// Create a new value which represents a binary expression with two memory 97234353Sdim /// location operands. 98234353Sdim virtual SVal evalBinOpLL(ProgramStateRef state, BinaryOperator::Opcode op, 99218887Sdim Loc lhs, Loc rhs, QualType resultTy) = 0; 100218887Sdim 101234353Sdim /// Create a new value which represents a binary expression with a memory 102234353Sdim /// location and non location operands. For example, this would be used to 103234353Sdim /// evaluate a pointer arithmetic operation. 104234353Sdim virtual SVal evalBinOpLN(ProgramStateRef state, BinaryOperator::Opcode op, 105218887Sdim Loc lhs, NonLoc rhs, QualType resultTy) = 0; 106218887Sdim 107234353Sdim /// Evaluates a given SVal. If the SVal has only one possible (integer) value, 108234353Sdim /// that value is returned. Otherwise, returns NULL. 109234353Sdim virtual const llvm::APSInt *getKnownValue(ProgramStateRef state, SVal val) = 0; 110218887Sdim 111239462Sdim /// Constructs a symbolic expression for two non-location values. 112239462Sdim SVal makeSymExprValNN(ProgramStateRef state, BinaryOperator::Opcode op, 113239462Sdim NonLoc lhs, NonLoc rhs, QualType resultTy); 114234353Sdim 115234353Sdim SVal evalBinOp(ProgramStateRef state, BinaryOperator::Opcode op, 116221345Sdim SVal lhs, SVal rhs, QualType type); 117218887Sdim 118234353Sdim DefinedOrUnknownSVal evalEQ(ProgramStateRef state, DefinedOrUnknownSVal lhs, 119221345Sdim DefinedOrUnknownSVal rhs); 120218887Sdim 121218887Sdim ASTContext &getContext() { return Context; } 122218887Sdim const ASTContext &getContext() const { return Context; } 123218887Sdim 124226633Sdim ProgramStateManager &getStateManager() { return StateMgr; } 125218887Sdim 126218887Sdim QualType getConditionType() const { 127249423Sdim return Context.getLangOpts().CPlusPlus ? Context.BoolTy : Context.IntTy; 128218887Sdim } 129218887Sdim 130218887Sdim QualType getArrayIndexType() const { 131218887Sdim return ArrayIndexTy; 132218887Sdim } 133218887Sdim 134218887Sdim BasicValueFactory &getBasicValueFactory() { return BasicVals; } 135218887Sdim const BasicValueFactory &getBasicValueFactory() const { return BasicVals; } 136218887Sdim 137218887Sdim SymbolManager &getSymbolManager() { return SymMgr; } 138218887Sdim const SymbolManager &getSymbolManager() const { return SymMgr; } 139218887Sdim 140218887Sdim MemRegionManager &getRegionManager() { return MemMgr; } 141218887Sdim const MemRegionManager &getRegionManager() const { return MemMgr; } 142218887Sdim 143218887Sdim // Forwarding methods to SymbolManager. 144218887Sdim 145243830Sdim const SymbolConjured* conjureSymbol(const Stmt *stmt, 146243830Sdim const LocationContext *LCtx, 147243830Sdim QualType type, 148243830Sdim unsigned visitCount, 149243830Sdim const void *symbolTag = 0) { 150243830Sdim return SymMgr.conjureSymbol(stmt, LCtx, type, visitCount, symbolTag); 151218887Sdim } 152218887Sdim 153243830Sdim const SymbolConjured* conjureSymbol(const Expr *expr, 154243830Sdim const LocationContext *LCtx, 155243830Sdim unsigned visitCount, 156243830Sdim const void *symbolTag = 0) { 157243830Sdim return SymMgr.conjureSymbol(expr, LCtx, visitCount, symbolTag); 158218887Sdim } 159218887Sdim 160234353Sdim /// Construct an SVal representing '0' for the specified type. 161221345Sdim DefinedOrUnknownSVal makeZeroVal(QualType type); 162218887Sdim 163234353Sdim /// Make a unique symbol for value of region. 164226633Sdim DefinedOrUnknownSVal getRegionValueSymbolVal(const TypedValueRegion *region); 165218887Sdim 166234353Sdim /// \brief Create a new symbol with a unique 'name'. 167234353Sdim /// 168234353Sdim /// We resort to conjured symbols when we cannot construct a derived symbol. 169234353Sdim /// The advantage of symbols derived/built from other symbols is that we 170234353Sdim /// preserve the relation between related(or even equivalent) expressions, so 171234353Sdim /// conjured symbols should be used sparingly. 172243830Sdim DefinedOrUnknownSVal conjureSymbolVal(const void *symbolTag, 173243830Sdim const Expr *expr, 174243830Sdim const LocationContext *LCtx, 175243830Sdim unsigned count); 176243830Sdim DefinedOrUnknownSVal conjureSymbolVal(const void *symbolTag, 177243830Sdim const Expr *expr, 178243830Sdim const LocationContext *LCtx, 179243830Sdim QualType type, 180243830Sdim unsigned count); 181234353Sdim 182243830Sdim DefinedOrUnknownSVal conjureSymbolVal(const Stmt *stmt, 183243830Sdim const LocationContext *LCtx, 184243830Sdim QualType type, 185243830Sdim unsigned visitCount); 186239462Sdim /// \brief Conjure a symbol representing heap allocated memory region. 187239462Sdim /// 188239462Sdim /// Note, the expression should represent a location. 189239462Sdim DefinedOrUnknownSVal getConjuredHeapSymbolVal(const Expr *E, 190239462Sdim const LocationContext *LCtx, 191239462Sdim unsigned Count); 192218887Sdim 193221345Sdim DefinedOrUnknownSVal getDerivedRegionValueSymbolVal( 194226633Sdim SymbolRef parentSymbol, const TypedValueRegion *region); 195218887Sdim 196221345Sdim DefinedSVal getMetadataSymbolVal( 197221345Sdim const void *symbolTag, const MemRegion *region, 198221345Sdim const Expr *expr, QualType type, unsigned count); 199218887Sdim 200221345Sdim DefinedSVal getFunctionPointer(const FunctionDecl *func); 201218887Sdim 202221345Sdim DefinedSVal getBlockPointer(const BlockDecl *block, CanQualType locTy, 203263508Sdim const LocationContext *locContext, 204263508Sdim unsigned blockCount); 205218887Sdim 206251662Sdim /// Returns the value of \p E, if it can be determined in a non-path-sensitive 207251662Sdim /// manner. 208251662Sdim /// 209251662Sdim /// If \p E is not a constant or cannot be modeled, returns \c None. 210251662Sdim Optional<SVal> getConstantVal(const Expr *E); 211251662Sdim 212221345Sdim NonLoc makeCompoundVal(QualType type, llvm::ImmutableList<SVal> vals) { 213221345Sdim return nonloc::CompoundVal(BasicVals.getCompoundValData(type, vals)); 214218887Sdim } 215218887Sdim 216226633Sdim NonLoc makeLazyCompoundVal(const StoreRef &store, 217226633Sdim const TypedValueRegion *region) { 218221345Sdim return nonloc::LazyCompoundVal( 219221345Sdim BasicVals.getLazyCompoundValData(store, region)); 220218887Sdim } 221218887Sdim 222218887Sdim NonLoc makeZeroArrayIndex() { 223218887Sdim return nonloc::ConcreteInt(BasicVals.getValue(0, ArrayIndexTy)); 224218887Sdim } 225218887Sdim 226218887Sdim NonLoc makeArrayIndex(uint64_t idx) { 227218887Sdim return nonloc::ConcreteInt(BasicVals.getValue(idx, ArrayIndexTy)); 228218887Sdim } 229218887Sdim 230221345Sdim SVal convertToArrayIndex(SVal val); 231218887Sdim 232221345Sdim nonloc::ConcreteInt makeIntVal(const IntegerLiteral* integer) { 233221345Sdim return nonloc::ConcreteInt( 234221345Sdim BasicVals.getValue(integer->getValue(), 235223017Sdim integer->getType()->isUnsignedIntegerOrEnumerationType())); 236218887Sdim } 237243830Sdim 238234353Sdim nonloc::ConcreteInt makeBoolVal(const ObjCBoolLiteralExpr *boolean) { 239234353Sdim return makeTruthVal(boolean->getValue(), boolean->getType()); 240218887Sdim } 241218887Sdim 242234353Sdim nonloc::ConcreteInt makeBoolVal(const CXXBoolLiteralExpr *boolean); 243234353Sdim 244221345Sdim nonloc::ConcreteInt makeIntVal(const llvm::APSInt& integer) { 245221345Sdim return nonloc::ConcreteInt(BasicVals.getValue(integer)); 246218887Sdim } 247218887Sdim 248221345Sdim loc::ConcreteInt makeIntLocVal(const llvm::APSInt &integer) { 249221345Sdim return loc::ConcreteInt(BasicVals.getValue(integer)); 250218887Sdim } 251218887Sdim 252221345Sdim NonLoc makeIntVal(const llvm::APInt& integer, bool isUnsigned) { 253221345Sdim return nonloc::ConcreteInt(BasicVals.getValue(integer, isUnsigned)); 254218887Sdim } 255218887Sdim 256221345Sdim DefinedSVal makeIntVal(uint64_t integer, QualType type) { 257221345Sdim if (Loc::isLocType(type)) 258221345Sdim return loc::ConcreteInt(BasicVals.getValue(integer, type)); 259218887Sdim 260221345Sdim return nonloc::ConcreteInt(BasicVals.getValue(integer, type)); 261218887Sdim } 262218887Sdim 263221345Sdim NonLoc makeIntVal(uint64_t integer, bool isUnsigned) { 264221345Sdim return nonloc::ConcreteInt(BasicVals.getIntValue(integer, isUnsigned)); 265218887Sdim } 266218887Sdim 267221345Sdim NonLoc makeIntValWithPtrWidth(uint64_t integer, bool isUnsigned) { 268221345Sdim return nonloc::ConcreteInt( 269221345Sdim BasicVals.getIntWithPtrWidth(integer, isUnsigned)); 270218887Sdim } 271218887Sdim 272221345Sdim NonLoc makeLocAsInteger(Loc loc, unsigned bits) { 273221345Sdim return nonloc::LocAsInteger(BasicVals.getPersistentSValWithData(loc, bits)); 274218887Sdim } 275218887Sdim 276218887Sdim NonLoc makeNonLoc(const SymExpr *lhs, BinaryOperator::Opcode op, 277221345Sdim const llvm::APSInt& rhs, QualType type); 278218887Sdim 279234353Sdim NonLoc makeNonLoc(const llvm::APSInt& rhs, BinaryOperator::Opcode op, 280234353Sdim const SymExpr *lhs, QualType type); 281234353Sdim 282218887Sdim NonLoc makeNonLoc(const SymExpr *lhs, BinaryOperator::Opcode op, 283221345Sdim const SymExpr *rhs, QualType type); 284218887Sdim 285234353Sdim /// \brief Create a NonLoc value for cast. 286234353Sdim NonLoc makeNonLoc(const SymExpr *operand, QualType fromTy, QualType toTy); 287234353Sdim 288221345Sdim nonloc::ConcreteInt makeTruthVal(bool b, QualType type) { 289221345Sdim return nonloc::ConcreteInt(BasicVals.getTruthValue(b, type)); 290218887Sdim } 291218887Sdim 292218887Sdim nonloc::ConcreteInt makeTruthVal(bool b) { 293218887Sdim return nonloc::ConcreteInt(BasicVals.getTruthValue(b)); 294218887Sdim } 295218887Sdim 296218887Sdim Loc makeNull() { 297218887Sdim return loc::ConcreteInt(BasicVals.getZeroWithPtrWidth()); 298218887Sdim } 299218887Sdim 300221345Sdim Loc makeLoc(SymbolRef sym) { 301221345Sdim return loc::MemRegionVal(MemMgr.getSymbolicRegion(sym)); 302218887Sdim } 303218887Sdim 304221345Sdim Loc makeLoc(const MemRegion* region) { 305221345Sdim return loc::MemRegionVal(region); 306218887Sdim } 307218887Sdim 308221345Sdim Loc makeLoc(const AddrLabelExpr *expr) { 309221345Sdim return loc::GotoLabel(expr->getLabel()); 310218887Sdim } 311218887Sdim 312221345Sdim Loc makeLoc(const llvm::APSInt& integer) { 313221345Sdim return loc::ConcreteInt(BasicVals.getValue(integer)); 314218887Sdim } 315218887Sdim 316239462Sdim /// Return a memory region for the 'this' object reference. 317239462Sdim loc::MemRegionVal getCXXThis(const CXXMethodDecl *D, 318239462Sdim const StackFrameContext *SFC); 319239462Sdim 320239462Sdim /// Return a memory region for the 'this' object reference. 321239462Sdim loc::MemRegionVal getCXXThis(const CXXRecordDecl *D, 322239462Sdim const StackFrameContext *SFC); 323218887Sdim}; 324218887Sdim 325218887SdimSValBuilder* createSimpleSValBuilder(llvm::BumpPtrAllocator &alloc, 326218887Sdim ASTContext &context, 327226633Sdim ProgramStateManager &stateMgr); 328218887Sdim 329218887Sdim} // end GR namespace 330218887Sdim 331218887Sdim} // end clang namespace 332218887Sdim 333218887Sdim#endif 334