include/clang/GR/PathSensitive/BasicValueFactory.h

   1 //=== BasicValueFactory.h - Basic values for Path Sens analysis --*- C++ -*---//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  This file defines BasicValueFactory, a class that manages the lifetime
  11 //  of APSInt objects and symbolic constraints used by GRExprEngine
  12 //  and related classes.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_CLANG_ANALYSIS_BASICVALUEFACTORY_H
  17 #define LLVM_CLANG_ANALYSIS_BASICVALUEFACTORY_H
  18
  19 #include "clang/GR/PathSensitive/SVals.h"
  20 #include "clang/AST/ASTContext.h"
  21 #include "llvm/ADT/FoldingSet.h"
  22 #include "llvm/ADT/APSInt.h"
  23 #include "llvm/ADT/ImmutableList.h"
  24
  25 namespace clang {
  26
  27   class GRState;
  28
  29 class CompoundValData : public llvm::FoldingSetNode {
  30   QualType T;
  31   llvm::ImmutableList<SVal> L;
  32
  33 public:
  34   CompoundValData(QualType t, llvm::ImmutableList<SVal> l)
  35     : T(t), L(l) {}
  36
  37   typedef llvm::ImmutableList<SVal>::iterator iterator;
  38   iterator begin() const { return L.begin(); }
  39   iterator end() const { return L.end(); }
  40
  41   static void Profile(llvm::FoldingSetNodeID& ID, QualType T,
  42                       llvm::ImmutableList<SVal> L);
  43
  44   void Profile(llvm::FoldingSetNodeID& ID) { Profile(ID, T, L); }
  45 };
  46
  47 class LazyCompoundValData : public llvm::FoldingSetNode {
  48   const void *store;
  49   const TypedRegion *region;
  50 public:
  51   LazyCompoundValData(const void *st, const TypedRegion *r)
  52     : store(st), region(r) {}
  53
  54   const void *getStore() const { return store; }
  55   const TypedRegion *getRegion() const { return region; }
  56
  57   static void Profile(llvm::FoldingSetNodeID& ID, const void *store,
  58                       const TypedRegion *region);
  59
  60   void Profile(llvm::FoldingSetNodeID& ID) { Profile(ID, store, region); }
  61 };
  62
  63 class BasicValueFactory {
  64   typedef llvm::FoldingSet<llvm::FoldingSetNodeWrapper<llvm::APSInt> >
  65           APSIntSetTy;
  66
  67   ASTContext& Ctx;
  68   llvm::BumpPtrAllocator& BPAlloc;
  69
  70   APSIntSetTy   APSIntSet;
  71   void*         PersistentSVals;
  72   void*         PersistentSValPairs;
  73
  74   llvm::ImmutableList<SVal>::Factory SValListFactory;
  75   llvm::FoldingSet<CompoundValData>  CompoundValDataSet;
  76   llvm::FoldingSet<LazyCompoundValData> LazyCompoundValDataSet;
  77
  78 public:
  79   BasicValueFactory(ASTContext& ctx, llvm::BumpPtrAllocator& Alloc)
  80   : Ctx(ctx), BPAlloc(Alloc), PersistentSVals(0), PersistentSValPairs(0),
  81     SValListFactory(Alloc) {}
  82
  83   ~BasicValueFactory();
  84
  85   ASTContext& getContext() const { return Ctx; }
  86
  87   const llvm::APSInt& getValue(const llvm::APSInt& X);
  88   const llvm::APSInt& getValue(const llvm::APInt& X, bool isUnsigned);
  89   const llvm::APSInt& getValue(uint64_t X, unsigned BitWidth, bool isUnsigned);
  90   const llvm::APSInt& getValue(uint64_t X, QualType T);
  91
  92   /// Convert - Create a new persistent APSInt with the same value as 'From'
  93   ///  but with the bitwidth and signedness of 'To'.
  94   const llvm::APSInt &Convert(const llvm::APSInt& To,
  95                               const llvm::APSInt& From) {
  96
  97     if (To.isUnsigned() == From.isUnsigned() &&
  98         To.getBitWidth() == From.getBitWidth())
  99       return From;
 100
 101     return getValue(From.getSExtValue(), To.getBitWidth(), To.isUnsigned());
 102   }
 103
 104   const llvm::APSInt &Convert(QualType T, const llvm::APSInt &From) {
 105     assert(T->isIntegerType() || Loc::IsLocType(T));
 106     unsigned bitwidth = Ctx.getTypeSize(T);
 107     bool isUnsigned = T->isUnsignedIntegerType() || Loc::IsLocType(T);
 108
 109     if (isUnsigned == From.isUnsigned() && bitwidth == From.getBitWidth())
 110       return From;
 111
 112     return getValue(From.getSExtValue(), bitwidth, isUnsigned);
 113   }
 114
 115   const llvm::APSInt& getIntValue(uint64_t X, bool isUnsigned) {
 116     QualType T = isUnsigned ? Ctx.UnsignedIntTy : Ctx.IntTy;
 117     return getValue(X, T);
 118   }
 119
 120   inline const llvm::APSInt& getMaxValue(const llvm::APSInt &v) {
 121     return getValue(llvm::APSInt::getMaxValue(v.getBitWidth(), v.isUnsigned()));
 122   }
 123
 124   inline const llvm::APSInt& getMinValue(const llvm::APSInt &v) {
 125     return getValue(llvm::APSInt::getMinValue(v.getBitWidth(), v.isUnsigned()));
 126   }
 127
 128   inline const llvm::APSInt& getMaxValue(QualType T) {
 129     assert(T->isIntegerType() || Loc::IsLocType(T));
 130     bool isUnsigned = T->isUnsignedIntegerType() || Loc::IsLocType(T);
 131     return getValue(llvm::APSInt::getMaxValue(Ctx.getTypeSize(T), isUnsigned));
 132   }
 133
 134   inline const llvm::APSInt& getMinValue(QualType T) {
 135     assert(T->isIntegerType() || Loc::IsLocType(T));
 136     bool isUnsigned = T->isUnsignedIntegerType() || Loc::IsLocType(T);
 137     return getValue(llvm::APSInt::getMinValue(Ctx.getTypeSize(T), isUnsigned));
 138   }
 139
 140   inline const llvm::APSInt& Add1(const llvm::APSInt& V) {
 141     llvm::APSInt X = V;
 142     ++X;
 143     return getValue(X);
 144   }
 145
 146   inline const llvm::APSInt& Sub1(const llvm::APSInt& V) {
 147     llvm::APSInt X = V;
 148     --X;
 149     return getValue(X);
 150   }
 151
 152   inline const llvm::APSInt& getZeroWithPtrWidth(bool isUnsigned = true) {
 153     return getValue(0, Ctx.getTypeSize(Ctx.VoidPtrTy), isUnsigned);
 154   }
 155
 156   inline const llvm::APSInt &getIntWithPtrWidth(uint64_t X, bool isUnsigned) {
 157     return getValue(X, Ctx.getTypeSize(Ctx.VoidPtrTy), isUnsigned);
 158   }
 159
 160   inline const llvm::APSInt& getTruthValue(bool b, QualType T) {
 161     return getValue(b ? 1 : 0, Ctx.getTypeSize(T), false);
 162   }
 163
 164   inline const llvm::APSInt& getTruthValue(bool b) {
 165     return getTruthValue(b, Ctx.IntTy);
 166   }
 167
 168   const CompoundValData *getCompoundValData(QualType T,
 169                                             llvm::ImmutableList<SVal> Vals);
 170
 171   const LazyCompoundValData *getLazyCompoundValData(const void *store,
 172                                                     const TypedRegion *region);
 173
 174   llvm::ImmutableList<SVal> getEmptySValList() {
 175     return SValListFactory.getEmptyList();
 176   }
 177
 178   llvm::ImmutableList<SVal> consVals(SVal X, llvm::ImmutableList<SVal> L) {
 179     return SValListFactory.add(X, L);
 180   }
 181
 182   const llvm::APSInt* evalAPSInt(BinaryOperator::Opcode Op,
 183                                      const llvm::APSInt& V1,
 184                                      const llvm::APSInt& V2);
 185
 186   const std::pair<SVal, uintptr_t>&
 187   getPersistentSValWithData(const SVal& V, uintptr_t Data);
 188
 189   const std::pair<SVal, SVal>&
 190   getPersistentSValPair(const SVal& V1, const SVal& V2);
 191
 192   const SVal* getPersistentSVal(SVal X);
 193 };
 194
 195 } // end clang namespace
 196
 197 #endif