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 15280031Sdim#ifndef LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_SVALBUILDER_H 16280031Sdim#define LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_SVALBUILDER_H 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); 86296417Sdim 87296417Sdim // Handles casts of type CK_IntegralCast. 88296417Sdim SVal evalIntegralCast(ProgramStateRef state, SVal val, QualType castTy, 89296417Sdim QualType originalType); 90296417Sdim 91218887Sdim virtual SVal evalMinus(NonLoc val) = 0; 92218887Sdim 93218887Sdim virtual SVal evalComplement(NonLoc val) = 0; 94218887Sdim 95276479Sdim /// Create a new value which represents a binary expression with two non- 96234353Sdim /// location operands. 97234353Sdim virtual SVal evalBinOpNN(ProgramStateRef state, BinaryOperator::Opcode op, 98218887Sdim NonLoc lhs, NonLoc rhs, QualType resultTy) = 0; 99218887Sdim 100234353Sdim /// Create a new value which represents a binary expression with two memory 101234353Sdim /// location operands. 102234353Sdim virtual SVal evalBinOpLL(ProgramStateRef state, BinaryOperator::Opcode op, 103218887Sdim Loc lhs, Loc rhs, QualType resultTy) = 0; 104218887Sdim 105234353Sdim /// Create a new value which represents a binary expression with a memory 106276479Sdim /// location and non-location operands. For example, this would be used to 107234353Sdim /// evaluate a pointer arithmetic operation. 108234353Sdim virtual SVal evalBinOpLN(ProgramStateRef state, BinaryOperator::Opcode op, 109218887Sdim Loc lhs, NonLoc rhs, QualType resultTy) = 0; 110218887Sdim 111234353Sdim /// Evaluates a given SVal. If the SVal has only one possible (integer) value, 112234353Sdim /// that value is returned. Otherwise, returns NULL. 113234353Sdim virtual const llvm::APSInt *getKnownValue(ProgramStateRef state, SVal val) = 0; 114218887Sdim 115239462Sdim /// Constructs a symbolic expression for two non-location values. 116239462Sdim SVal makeSymExprValNN(ProgramStateRef state, BinaryOperator::Opcode op, 117239462Sdim NonLoc lhs, NonLoc rhs, QualType resultTy); 118234353Sdim 119234353Sdim SVal evalBinOp(ProgramStateRef state, BinaryOperator::Opcode op, 120221345Sdim SVal lhs, SVal rhs, QualType type); 121218887Sdim 122234353Sdim DefinedOrUnknownSVal evalEQ(ProgramStateRef state, DefinedOrUnknownSVal lhs, 123221345Sdim DefinedOrUnknownSVal rhs); 124218887Sdim 125218887Sdim ASTContext &getContext() { return Context; } 126218887Sdim const ASTContext &getContext() const { return Context; } 127218887Sdim 128226633Sdim ProgramStateManager &getStateManager() { return StateMgr; } 129218887Sdim 130218887Sdim QualType getConditionType() const { 131249423Sdim return Context.getLangOpts().CPlusPlus ? Context.BoolTy : Context.IntTy; 132218887Sdim } 133218887Sdim 134218887Sdim QualType getArrayIndexType() const { 135218887Sdim return ArrayIndexTy; 136218887Sdim } 137218887Sdim 138218887Sdim BasicValueFactory &getBasicValueFactory() { return BasicVals; } 139218887Sdim const BasicValueFactory &getBasicValueFactory() const { return BasicVals; } 140218887Sdim 141218887Sdim SymbolManager &getSymbolManager() { return SymMgr; } 142218887Sdim const SymbolManager &getSymbolManager() const { return SymMgr; } 143218887Sdim 144218887Sdim MemRegionManager &getRegionManager() { return MemMgr; } 145218887Sdim const MemRegionManager &getRegionManager() const { return MemMgr; } 146218887Sdim 147218887Sdim // Forwarding methods to SymbolManager. 148218887Sdim 149243830Sdim const SymbolConjured* conjureSymbol(const Stmt *stmt, 150243830Sdim const LocationContext *LCtx, 151243830Sdim QualType type, 152243830Sdim unsigned visitCount, 153276479Sdim const void *symbolTag = nullptr) { 154243830Sdim return SymMgr.conjureSymbol(stmt, LCtx, type, visitCount, symbolTag); 155218887Sdim } 156218887Sdim 157243830Sdim const SymbolConjured* conjureSymbol(const Expr *expr, 158243830Sdim const LocationContext *LCtx, 159243830Sdim unsigned visitCount, 160276479Sdim const void *symbolTag = nullptr) { 161243830Sdim return SymMgr.conjureSymbol(expr, LCtx, visitCount, symbolTag); 162218887Sdim } 163218887Sdim 164234353Sdim /// Construct an SVal representing '0' for the specified type. 165221345Sdim DefinedOrUnknownSVal makeZeroVal(QualType type); 166218887Sdim 167234353Sdim /// Make a unique symbol for value of region. 168226633Sdim DefinedOrUnknownSVal getRegionValueSymbolVal(const TypedValueRegion *region); 169218887Sdim 170234353Sdim /// \brief Create a new symbol with a unique 'name'. 171234353Sdim /// 172234353Sdim /// We resort to conjured symbols when we cannot construct a derived symbol. 173234353Sdim /// The advantage of symbols derived/built from other symbols is that we 174234353Sdim /// preserve the relation between related(or even equivalent) expressions, so 175234353Sdim /// conjured symbols should be used sparingly. 176243830Sdim DefinedOrUnknownSVal conjureSymbolVal(const void *symbolTag, 177243830Sdim const Expr *expr, 178243830Sdim const LocationContext *LCtx, 179243830Sdim unsigned count); 180243830Sdim DefinedOrUnknownSVal conjureSymbolVal(const void *symbolTag, 181243830Sdim const Expr *expr, 182243830Sdim const LocationContext *LCtx, 183243830Sdim QualType type, 184243830Sdim unsigned count); 185234353Sdim 186243830Sdim DefinedOrUnknownSVal conjureSymbolVal(const Stmt *stmt, 187243830Sdim const LocationContext *LCtx, 188243830Sdim QualType type, 189243830Sdim unsigned visitCount); 190239462Sdim /// \brief Conjure a symbol representing heap allocated memory region. 191239462Sdim /// 192239462Sdim /// Note, the expression should represent a location. 193239462Sdim DefinedOrUnknownSVal getConjuredHeapSymbolVal(const Expr *E, 194239462Sdim const LocationContext *LCtx, 195239462Sdim unsigned Count); 196218887Sdim 197221345Sdim DefinedOrUnknownSVal getDerivedRegionValueSymbolVal( 198226633Sdim SymbolRef parentSymbol, const TypedValueRegion *region); 199218887Sdim 200221345Sdim DefinedSVal getMetadataSymbolVal( 201221345Sdim const void *symbolTag, const MemRegion *region, 202221345Sdim const Expr *expr, QualType type, unsigned count); 203218887Sdim 204221345Sdim DefinedSVal getFunctionPointer(const FunctionDecl *func); 205218887Sdim 206221345Sdim DefinedSVal getBlockPointer(const BlockDecl *block, CanQualType locTy, 207261991Sdim const LocationContext *locContext, 208261991Sdim unsigned blockCount); 209218887Sdim 210251662Sdim /// Returns the value of \p E, if it can be determined in a non-path-sensitive 211251662Sdim /// manner. 212251662Sdim /// 213251662Sdim /// If \p E is not a constant or cannot be modeled, returns \c None. 214251662Sdim Optional<SVal> getConstantVal(const Expr *E); 215251662Sdim 216221345Sdim NonLoc makeCompoundVal(QualType type, llvm::ImmutableList<SVal> vals) { 217221345Sdim return nonloc::CompoundVal(BasicVals.getCompoundValData(type, vals)); 218218887Sdim } 219218887Sdim 220226633Sdim NonLoc makeLazyCompoundVal(const StoreRef &store, 221226633Sdim const TypedValueRegion *region) { 222221345Sdim return nonloc::LazyCompoundVal( 223221345Sdim BasicVals.getLazyCompoundValData(store, region)); 224218887Sdim } 225218887Sdim 226218887Sdim NonLoc makeZeroArrayIndex() { 227218887Sdim return nonloc::ConcreteInt(BasicVals.getValue(0, ArrayIndexTy)); 228218887Sdim } 229218887Sdim 230218887Sdim NonLoc makeArrayIndex(uint64_t idx) { 231218887Sdim return nonloc::ConcreteInt(BasicVals.getValue(idx, ArrayIndexTy)); 232218887Sdim } 233218887Sdim 234221345Sdim SVal convertToArrayIndex(SVal val); 235218887Sdim 236221345Sdim nonloc::ConcreteInt makeIntVal(const IntegerLiteral* integer) { 237221345Sdim return nonloc::ConcreteInt( 238221345Sdim BasicVals.getValue(integer->getValue(), 239223017Sdim integer->getType()->isUnsignedIntegerOrEnumerationType())); 240218887Sdim } 241243830Sdim 242234353Sdim nonloc::ConcreteInt makeBoolVal(const ObjCBoolLiteralExpr *boolean) { 243234353Sdim return makeTruthVal(boolean->getValue(), boolean->getType()); 244218887Sdim } 245218887Sdim 246234353Sdim nonloc::ConcreteInt makeBoolVal(const CXXBoolLiteralExpr *boolean); 247234353Sdim 248221345Sdim nonloc::ConcreteInt makeIntVal(const llvm::APSInt& integer) { 249221345Sdim return nonloc::ConcreteInt(BasicVals.getValue(integer)); 250218887Sdim } 251218887Sdim 252221345Sdim loc::ConcreteInt makeIntLocVal(const llvm::APSInt &integer) { 253221345Sdim return loc::ConcreteInt(BasicVals.getValue(integer)); 254218887Sdim } 255218887Sdim 256221345Sdim NonLoc makeIntVal(const llvm::APInt& integer, bool isUnsigned) { 257221345Sdim return nonloc::ConcreteInt(BasicVals.getValue(integer, isUnsigned)); 258218887Sdim } 259218887Sdim 260221345Sdim DefinedSVal makeIntVal(uint64_t integer, QualType type) { 261221345Sdim if (Loc::isLocType(type)) 262221345Sdim return loc::ConcreteInt(BasicVals.getValue(integer, type)); 263218887Sdim 264221345Sdim return nonloc::ConcreteInt(BasicVals.getValue(integer, type)); 265218887Sdim } 266218887Sdim 267221345Sdim NonLoc makeIntVal(uint64_t integer, bool isUnsigned) { 268221345Sdim return nonloc::ConcreteInt(BasicVals.getIntValue(integer, isUnsigned)); 269218887Sdim } 270218887Sdim 271221345Sdim NonLoc makeIntValWithPtrWidth(uint64_t integer, bool isUnsigned) { 272221345Sdim return nonloc::ConcreteInt( 273221345Sdim BasicVals.getIntWithPtrWidth(integer, isUnsigned)); 274218887Sdim } 275218887Sdim 276221345Sdim NonLoc makeLocAsInteger(Loc loc, unsigned bits) { 277221345Sdim return nonloc::LocAsInteger(BasicVals.getPersistentSValWithData(loc, bits)); 278218887Sdim } 279218887Sdim 280218887Sdim NonLoc makeNonLoc(const SymExpr *lhs, BinaryOperator::Opcode op, 281221345Sdim const llvm::APSInt& rhs, QualType type); 282218887Sdim 283234353Sdim NonLoc makeNonLoc(const llvm::APSInt& rhs, BinaryOperator::Opcode op, 284234353Sdim const SymExpr *lhs, QualType type); 285234353Sdim 286218887Sdim NonLoc makeNonLoc(const SymExpr *lhs, BinaryOperator::Opcode op, 287221345Sdim const SymExpr *rhs, QualType type); 288218887Sdim 289234353Sdim /// \brief Create a NonLoc value for cast. 290234353Sdim NonLoc makeNonLoc(const SymExpr *operand, QualType fromTy, QualType toTy); 291234353Sdim 292221345Sdim nonloc::ConcreteInt makeTruthVal(bool b, QualType type) { 293221345Sdim return nonloc::ConcreteInt(BasicVals.getTruthValue(b, type)); 294218887Sdim } 295218887Sdim 296218887Sdim nonloc::ConcreteInt makeTruthVal(bool b) { 297218887Sdim return nonloc::ConcreteInt(BasicVals.getTruthValue(b)); 298218887Sdim } 299218887Sdim 300218887Sdim Loc makeNull() { 301218887Sdim return loc::ConcreteInt(BasicVals.getZeroWithPtrWidth()); 302218887Sdim } 303218887Sdim 304221345Sdim Loc makeLoc(SymbolRef sym) { 305221345Sdim return loc::MemRegionVal(MemMgr.getSymbolicRegion(sym)); 306218887Sdim } 307218887Sdim 308221345Sdim Loc makeLoc(const MemRegion* region) { 309221345Sdim return loc::MemRegionVal(region); 310218887Sdim } 311218887Sdim 312221345Sdim Loc makeLoc(const AddrLabelExpr *expr) { 313221345Sdim return loc::GotoLabel(expr->getLabel()); 314218887Sdim } 315218887Sdim 316221345Sdim Loc makeLoc(const llvm::APSInt& integer) { 317221345Sdim return loc::ConcreteInt(BasicVals.getValue(integer)); 318218887Sdim } 319218887Sdim 320239462Sdim /// Return a memory region for the 'this' object reference. 321239462Sdim loc::MemRegionVal getCXXThis(const CXXMethodDecl *D, 322239462Sdim const StackFrameContext *SFC); 323239462Sdim 324239462Sdim /// Return a memory region for the 'this' object reference. 325239462Sdim loc::MemRegionVal getCXXThis(const CXXRecordDecl *D, 326239462Sdim const StackFrameContext *SFC); 327218887Sdim}; 328218887Sdim 329218887SdimSValBuilder* createSimpleSValBuilder(llvm::BumpPtrAllocator &alloc, 330218887Sdim ASTContext &context, 331226633Sdim ProgramStateManager &stateMgr); 332218887Sdim 333218887Sdim} // end GR namespace 334218887Sdim 335218887Sdim} // end clang namespace 336218887Sdim 337218887Sdim#endif 338