clang  16.0.0git
BasicValueFactory.h
Go to the documentation of this file.
1 //==- BasicValueFactory.h - Basic values for Path Sens analysis --*- C++ -*-==//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines BasicValueFactory, a class that manages the lifetime
10 // of APSInt objects and symbolic constraints used by ExprEngine
11 // and related classes.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_BASICVALUEFACTORY_H
16 #define LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_BASICVALUEFACTORY_H
17 
18 #include "clang/AST/ASTContext.h"
19 #include "clang/AST/Expr.h"
20 #include "clang/AST/Type.h"
25 #include "llvm/ADT/APSInt.h"
26 #include "llvm/ADT/FoldingSet.h"
27 #include "llvm/ADT/ImmutableList.h"
28 #include "llvm/ADT/iterator_range.h"
29 #include "llvm/Support/Allocator.h"
30 #include <cassert>
31 #include <cstdint>
32 #include <utility>
33 
34 namespace clang {
35 
36 class CXXBaseSpecifier;
37 
38 namespace ento {
39 
40 class CompoundValData : public llvm::FoldingSetNode {
41  QualType T;
42  llvm::ImmutableList<SVal> L;
43 
44 public:
45  CompoundValData(QualType t, llvm::ImmutableList<SVal> l) : T(t), L(l) {
46  assert(NonLoc::isCompoundType(t));
47  }
48 
49  using iterator = llvm::ImmutableList<SVal>::iterator;
50 
51  iterator begin() const { return L.begin(); }
52  iterator end() const { return L.end(); }
53 
54  QualType getType() const { return T; }
55 
56  static void Profile(llvm::FoldingSetNodeID& ID, QualType T,
57  llvm::ImmutableList<SVal> L);
58 
59  void Profile(llvm::FoldingSetNodeID& ID) { Profile(ID, T, L); }
60 };
61 
62 class LazyCompoundValData : public llvm::FoldingSetNode {
63  StoreRef store;
64  const TypedValueRegion *region;
65 
66 public:
68  : store(st), region(r) {
69  assert(r);
71  }
72 
73  /// It might return null.
74  const void *getStore() const { return store.getStore(); }
75 
76  LLVM_ATTRIBUTE_RETURNS_NONNULL
77  const TypedValueRegion *getRegion() const { return region; }
78 
79  static void Profile(llvm::FoldingSetNodeID& ID,
80  const StoreRef &store,
81  const TypedValueRegion *region);
82 
83  void Profile(llvm::FoldingSetNodeID& ID) { Profile(ID, store, region); }
84 };
85 
86 class PointerToMemberData : public llvm::FoldingSetNode {
87  const NamedDecl *D;
88  llvm::ImmutableList<const CXXBaseSpecifier *> L;
89 
90 public:
92  llvm::ImmutableList<const CXXBaseSpecifier *> L)
93  : D(D), L(L) {}
94 
95  using iterator = llvm::ImmutableList<const CXXBaseSpecifier *>::iterator;
96 
97  iterator begin() const { return L.begin(); }
98  iterator end() const { return L.end(); }
99 
100  static void Profile(llvm::FoldingSetNodeID &ID, const NamedDecl *D,
101  llvm::ImmutableList<const CXXBaseSpecifier *> L);
102 
103  void Profile(llvm::FoldingSetNodeID &ID) { Profile(ID, D, L); }
104 
105  /// It might return null.
106  const NamedDecl *getDeclaratorDecl() const { return D; }
107 
108  llvm::ImmutableList<const CXXBaseSpecifier *> getCXXBaseList() const {
109  return L;
110  }
111 };
112 
114  using APSIntSetTy =
115  llvm::FoldingSet<llvm::FoldingSetNodeWrapper<llvm::APSInt>>;
116 
117  ASTContext &Ctx;
118  llvm::BumpPtrAllocator& BPAlloc;
119 
120  APSIntSetTy APSIntSet;
121  void *PersistentSVals = nullptr;
122  void *PersistentSValPairs = nullptr;
123 
124  llvm::ImmutableList<SVal>::Factory SValListFactory;
125  llvm::ImmutableList<const CXXBaseSpecifier *>::Factory CXXBaseListFactory;
126  llvm::FoldingSet<CompoundValData> CompoundValDataSet;
127  llvm::FoldingSet<LazyCompoundValData> LazyCompoundValDataSet;
128  llvm::FoldingSet<PointerToMemberData> PointerToMemberDataSet;
129 
130  // This is private because external clients should use the factory
131  // method that takes a QualType.
132  const llvm::APSInt& getValue(uint64_t X, unsigned BitWidth, bool isUnsigned);
133 
134 public:
135  BasicValueFactory(ASTContext &ctx, llvm::BumpPtrAllocator &Alloc)
136  : Ctx(ctx), BPAlloc(Alloc), SValListFactory(Alloc),
137  CXXBaseListFactory(Alloc) {}
138 
140 
141  ASTContext &getContext() const { return Ctx; }
142 
143  const llvm::APSInt& getValue(const llvm::APSInt& X);
144  const llvm::APSInt& getValue(const llvm::APInt& X, bool isUnsigned);
145  const llvm::APSInt& getValue(uint64_t X, QualType T);
146 
147  /// Returns the type of the APSInt used to store values of the given QualType.
149  // For the purposes of the analysis and constraints, we treat atomics
150  // as their underlying types.
151  if (const AtomicType *AT = T->getAs<AtomicType>()) {
152  T = AT->getValueType();
153  }
154 
155  assert(T->isIntegralOrEnumerationType() || Loc::isLocType(T));
156  return APSIntType(Ctx.getIntWidth(T),
158  }
159 
160  /// Convert - Create a new persistent APSInt with the same value as 'From'
161  /// but with the bitwidth and signedness of 'To'.
163  const llvm::APSInt& From) {
164  APSIntType TargetType(To);
165  if (TargetType == APSIntType(From))
166  return From;
167 
168  return getValue(TargetType.convert(From));
169  }
170 
171  const llvm::APSInt &Convert(QualType T, const llvm::APSInt &From) {
172  APSIntType TargetType = getAPSIntType(T);
173  return Convert(TargetType, From);
174  }
175 
176  const llvm::APSInt &Convert(APSIntType TargetType, const llvm::APSInt &From) {
177  if (TargetType == APSIntType(From))
178  return From;
179 
180  return getValue(TargetType.convert(From));
181  }
182 
183  const llvm::APSInt &getIntValue(uint64_t X, bool isUnsigned) {
184  QualType T = isUnsigned ? Ctx.UnsignedIntTy : Ctx.IntTy;
185  return getValue(X, T);
186  }
187 
189  return getValue(APSIntType(v).getMaxValue());
190  }
191 
193  return getValue(APSIntType(v).getMinValue());
194  }
195 
197  return getMaxValue(getAPSIntType(T));
198  }
199 
201  return getMinValue(getAPSIntType(T));
202  }
203 
205  return getValue(T.getMaxValue());
206  }
207 
209  return getValue(T.getMinValue());
210  }
211 
212  const llvm::APSInt &Add1(const llvm::APSInt &V) {
213  llvm::APSInt X = V;
214  ++X;
215  return getValue(X);
216  }
217 
218  const llvm::APSInt &Sub1(const llvm::APSInt &V) {
219  llvm::APSInt X = V;
220  --X;
221  return getValue(X);
222  }
223 
225  assert(T->isScalarType());
226  return getValue(0, Ctx.getTypeSize(T), true);
227  }
228 
230  return getValue(b ? 1 : 0, Ctx.getIntWidth(T),
232  }
233 
234  const llvm::APSInt &getTruthValue(bool b) {
235  return getTruthValue(b, Ctx.getLogicalOperationType());
236  }
237 
239  llvm::ImmutableList<SVal> Vals);
240 
242  const TypedValueRegion *region);
243 
244  const PointerToMemberData *
246  llvm::ImmutableList<const CXXBaseSpecifier *> L);
247 
248  llvm::ImmutableList<SVal> getEmptySValList() {
249  return SValListFactory.getEmptyList();
250  }
251 
252  llvm::ImmutableList<SVal> prependSVal(SVal X, llvm::ImmutableList<SVal> L) {
253  return SValListFactory.add(X, L);
254  }
255 
256  llvm::ImmutableList<const CXXBaseSpecifier *> getEmptyCXXBaseList() {
257  return CXXBaseListFactory.getEmptyList();
258  }
259 
260  llvm::ImmutableList<const CXXBaseSpecifier *> prependCXXBase(
261  const CXXBaseSpecifier *CBS,
262  llvm::ImmutableList<const CXXBaseSpecifier *> L) {
263  return CXXBaseListFactory.add(CBS, L);
264  }
265 
266  const PointerToMemberData *
267  accumCXXBase(llvm::iterator_range<CastExpr::path_const_iterator> PathRange,
268  const nonloc::PointerToMember &PTM, const clang::CastKind &kind);
269 
271  const llvm::APSInt& V1,
272  const llvm::APSInt& V2);
273 
274  const std::pair<SVal, uintptr_t>&
276 
277  const std::pair<SVal, SVal>&
278  getPersistentSValPair(const SVal& V1, const SVal& V2);
279 
280  const SVal* getPersistentSVal(SVal X);
281 };
282 
283 } // namespace ento
284 
285 } // namespace clang
286 
287 #endif // LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_BASICVALUEFACTORY_H
clang::ento::BasicValueFactory::getPersistentSValWithData
const std::pair< SVal, uintptr_t > & getPersistentSValWithData(const SVal &V, uintptr_t Data)
Definition: BasicValueFactory.cpp:345
clang::ento::BasicValueFactory::getTruthValue
const llvm::APSInt & getTruthValue(bool b)
Definition: BasicValueFactory.h:234
clang::ento::BasicValueFactory::~BasicValueFactory
~BasicValueFactory()
Definition: BasicValueFactory.cpp:79
clang::ento::Loc::isLocType
static bool isLocType(QualType T)
Definition: SVals.h:290
clang::ento::BasicValueFactory::getEmptySValList
llvm::ImmutableList< SVal > getEmptySValList()
Definition: BasicValueFactory.h:248
clang::interp::APInt
llvm::APInt APInt
Definition: Integral.h:27
clang::ento::BasicValueFactory
Definition: BasicValueFactory.h:113
clang::ento::LazyCompoundValData
Definition: BasicValueFactory.h:62
clang::ento::BasicValueFactory::prependCXXBase
llvm::ImmutableList< const CXXBaseSpecifier * > prependCXXBase(const CXXBaseSpecifier *CBS, llvm::ImmutableList< const CXXBaseSpecifier * > L)
Definition: BasicValueFactory.h:260
clang::ento::CompoundValData
Definition: BasicValueFactory.h:40
SVals.h
clang::ento::BasicValueFactory::Add1
const llvm::APSInt & Add1(const llvm::APSInt &V)
Definition: BasicValueFactory.h:212
clang::ento::BasicValueFactory::getMaxValue
const llvm::APSInt & getMaxValue(const llvm::APSInt &v)
Definition: BasicValueFactory.h:188
clang::ASTContext::getIntWidth
unsigned getIntWidth(QualType T) const
Definition: ASTContext.cpp:10901
clang::NamedDecl
This represents a decl that may have a name.
Definition: Decl.h:247
clang::QualType
A (possibly-)qualified type.
Definition: Type.h:737
clang::ento::PointerToMemberData::begin
iterator begin() const
Definition: BasicValueFactory.h:97
clang::Type::isScalarType
bool isScalarType() const
Definition: Type.h:7267
clang::ento::BasicValueFactory::Convert
const llvm::APSInt & Convert(APSIntType TargetType, const llvm::APSInt &From)
Definition: BasicValueFactory.h:176
clang::ento::BasicValueFactory::getMinValue
const llvm::APSInt & getMinValue(APSIntType T)
Definition: BasicValueFactory.h:208
clang::ento::CompoundValData::Profile
void Profile(llvm::FoldingSetNodeID &ID)
Definition: BasicValueFactory.h:59
clang::ento::BasicValueFactory::getPersistentSVal
const SVal * getPersistentSVal(SVal X)
Definition: BasicValueFactory.cpp:394
clang::ento::PointerToMemberData::getDeclaratorDecl
const NamedDecl * getDeclaratorDecl() const
It might return null.
Definition: BasicValueFactory.h:106
clang::tooling::X
static ToolExecutorPluginRegistry::Add< AllTUsToolExecutorPlugin > X("all-TUs", "Runs FrontendActions on all TUs in the compilation database. " "Tool results are stored in memory.")
clang::ento::BasicValueFactory::getCompoundValData
const CompoundValData * getCompoundValData(QualType T, llvm::ImmutableList< SVal > Vals)
Definition: BasicValueFactory.cpp:126
clang::ento::PointerToMemberData::Profile
static void Profile(llvm::FoldingSetNodeID &ID, const NamedDecl *D, llvm::ImmutableList< const CXXBaseSpecifier * > L)
Definition: BasicValueFactory.cpp:45
clang::ento::BasicValueFactory::getPointerToMemberData
const PointerToMemberData * getPointerToMemberData(const NamedDecl *ND, llvm::ImmutableList< const CXXBaseSpecifier * > L)
Definition: BasicValueFactory.cpp:162
b
__device__ __2f16 b
Definition: __clang_hip_libdevice_declares.h:319
clang::ento::APSIntType::getMaxValue
llvm::APSInt getMaxValue() const LLVM_READONLY
Returns the maximum value for this type.
Definition: APSIntType.h:65
clang::ento::BasicValueFactory::accumCXXBase
const PointerToMemberData * accumCXXBase(llvm::iterator_range< CastExpr::path_const_iterator > PathRange, const nonloc::PointerToMember &PTM, const clang::CastKind &kind)
Definition: BasicValueFactory.cpp:192
clang::ento::BasicValueFactory::getMinValue
const llvm::APSInt & getMinValue(QualType T)
Definition: BasicValueFactory.h:200
APSInt
llvm::APSInt APSInt
Definition: ByteCodeEmitter.cpp:19
clang::ento::LazyCompoundValData::LazyCompoundValData
LazyCompoundValData(const StoreRef &st, const TypedValueRegion *r)
Definition: BasicValueFactory.h:67
V
#define V(N, I)
Definition: ASTContext.h:3237
clang::ento::StoreRef::getStore
Store getStore() const
Definition: StoreRef.h:46
clang::ento::NonLoc::isCompoundType
static bool isCompoundType(QualType T)
Definition: SVals.h:274
clang::Type::isSignedIntegerOrEnumerationType
bool isSignedIntegerOrEnumerationType() const
Determines whether this is an integer type that is signed or an enumeration types whose underlying ty...
Definition: Type.cpp:2040
clang::ento::BasicValueFactory::Convert
const llvm::APSInt & Convert(const llvm::APSInt &To, const llvm::APSInt &From)
Convert - Create a new persistent APSInt with the same value as 'From' but with the bitwidth and sign...
Definition: BasicValueFactory.h:162
hlsl::uint64_t
unsigned long uint64_t
Definition: hlsl_basic_types.h:25
clang::ento::PointerToMemberData::PointerToMemberData
PointerToMemberData(const NamedDecl *D, llvm::ImmutableList< const CXXBaseSpecifier * > L)
Definition: BasicValueFactory.h:91
clang::ASTContext
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:209
clang::ento::StoreRef
Definition: StoreRef.h:29
clang::Type::getAs
const T * getAs() const
Member-template getAs<specific type>'.
Definition: Type.h:7386
clang::ento::nonloc::PointerToMember
Value representing pointer-to-member.
Definition: SVals.h:442
clang::ASTContext::getTypeSize
uint64_t getTypeSize(QualType T) const
Return the size of the specified (complete) type T, in bits.
Definition: ASTContext.h:2302
uintptr_t
__UINTPTR_TYPE__ uintptr_t
An unsigned integer type with the property that any valid pointer to void can be converted to this ty...
Definition: opencl-c-base.h:140
Type.h
Expr.h
clang::ento::BasicValueFactory::prependSVal
llvm::ImmutableList< SVal > prependSVal(SVal X, llvm::ImmutableList< SVal > L)
Definition: BasicValueFactory.h:252
ASTContext.h
clang::Type::isUnsignedIntegerOrEnumerationType
bool isUnsignedIntegerOrEnumerationType() const
Determines whether this is an integer type that is unsigned or an enumeration types whose underlying ...
Definition: Type.cpp:2090
clang::ento::BasicValueFactory::getIntValue
const llvm::APSInt & getIntValue(uint64_t X, bool isUnsigned)
Definition: BasicValueFactory.h:183
clang::ento::CompoundValData::Profile
static void Profile(llvm::FoldingSetNodeID &ID, QualType T, llvm::ImmutableList< SVal > L)
Definition: BasicValueFactory.cpp:32
clang::ento::APSIntType
A record of the "type" of an APSInt, used for conversions.
Definition: APSIntType.h:19
clang::ento::LazyCompoundValData::Profile
static void Profile(llvm::FoldingSetNodeID &ID, const StoreRef &store, const TypedValueRegion *region)
Definition: BasicValueFactory.cpp:38
clang::ento::BasicValueFactory::getContext
ASTContext & getContext() const
Definition: BasicValueFactory.h:141
clang::ento::APSIntType::getMinValue
llvm::APSInt getMinValue() const LLVM_READONLY
Returns the minimum value for this type.
Definition: APSIntType.h:60
clang::ento::BasicValueFactory::getMaxValue
const llvm::APSInt & getMaxValue(APSIntType T)
Definition: BasicValueFactory.h:204
clang::ASTContext::getLogicalOperationType
QualType getLogicalOperationType() const
The result type of logical operations, '<', '>', '!=', etc.
Definition: ASTContext.h:1982
clang::ento::PointerToMemberData::iterator
llvm::ImmutableList< const CXXBaseSpecifier * >::iterator iterator
Definition: BasicValueFactory.h:95
clang::ASTContext::UnsignedIntTy
CanQualType UnsignedIntTy
Definition: ASTContext.h:1117
clang::ento::LazyCompoundValData::getStore
const void * getStore() const
It might return null.
Definition: BasicValueFactory.h:74
clang::ento::CompoundValData::getType
QualType getType() const
Definition: BasicValueFactory.h:54
clang::ASTContext::IntTy
CanQualType IntTy
Definition: ASTContext.h:1116
clang::ento::BasicValueFactory::getEmptyCXXBaseList
llvm::ImmutableList< const CXXBaseSpecifier * > getEmptyCXXBaseList()
Definition: BasicValueFactory.h:256
clang::ento::LazyCompoundValData::getRegion
const LLVM_ATTRIBUTE_RETURNS_NONNULL TypedValueRegion * getRegion() const
Definition: BasicValueFactory.h:77
clang::ento::BasicValueFactory::BasicValueFactory
BasicValueFactory(ASTContext &ctx, llvm::BumpPtrAllocator &Alloc)
Definition: BasicValueFactory.h:135
clang::ento::BasicValueFactory::getLazyCompoundValData
const LazyCompoundValData * getLazyCompoundValData(const StoreRef &store, const TypedValueRegion *region)
Definition: BasicValueFactory.cpp:144
APSIntType.h
clang::BinaryOperatorKind
BinaryOperatorKind
Definition: OperationKinds.h:25
clang::ento::BasicValueFactory::getMinValue
const llvm::APSInt & getMinValue(const llvm::APSInt &v)
Definition: BasicValueFactory.h:192
clang::ento::TypedValueRegion::getValueType
virtual QualType getValueType() const =0
clang::Builtin::ID
ID
Definition: Builtins.h:52
clang
Definition: CalledOnceCheck.h:17
clang::ento::CompoundValData::begin
iterator begin() const
Definition: BasicValueFactory.h:51
clang::ento::PointerToMemberData::getCXXBaseList
llvm::ImmutableList< const CXXBaseSpecifier * > getCXXBaseList() const
Definition: BasicValueFactory.h:108
clang::ento::BasicValueFactory::Sub1
const llvm::APSInt & Sub1(const llvm::APSInt &V)
Definition: BasicValueFactory.h:218
clang::ento::CompoundValData::CompoundValData
CompoundValData(QualType t, llvm::ImmutableList< SVal > l)
Definition: BasicValueFactory.h:45
clang::ento::PointerToMemberData::end
iterator end() const
Definition: BasicValueFactory.h:98
MemRegion.h
clang::CXXBaseSpecifier
Represents a base class of a C++ class.
Definition: DeclCXX.h:146
clang::ento::BasicValueFactory::evalAPSInt
const llvm::APSInt * evalAPSInt(BinaryOperator::Opcode Op, const llvm::APSInt &V1, const llvm::APSInt &V2)
Definition: BasicValueFactory.cpp:250
clang::ento::APSIntType::convert
llvm::APSInt convert(const llvm::APSInt &Value) const LLVM_READONLY
Convert and return a new APSInt with the given value, but this type's bit width and signedness.
Definition: APSIntType.h:48
clang::ento::LazyCompoundValData::Profile
void Profile(llvm::FoldingSetNodeID &ID)
Definition: BasicValueFactory.h:83
clang::ento::BasicValueFactory::Convert
const llvm::APSInt & Convert(QualType T, const llvm::APSInt &From)
Definition: BasicValueFactory.h:171
clang::ento::PointerToMemberData
Definition: BasicValueFactory.h:86
clang::ento::SVal
SVal - This represents a symbolic expression, which can be either an L-value or an R-value.
Definition: SVals.h:73
v
do v
Definition: arm_acle.h:76
clang::ento::TypedValueRegion
TypedValueRegion - An abstract class representing regions having a typed value.
Definition: MemRegion.h:531
clang::AtomicType
Definition: Type.h:6440
clang::ento::BasicValueFactory::getMaxValue
const llvm::APSInt & getMaxValue(QualType T)
Definition: BasicValueFactory.h:196
clang::CastKind
CastKind
CastKind - The kind of operation required for a conversion.
Definition: OperationKinds.h:20
clang::ento::CompoundValData::iterator
llvm::ImmutableList< SVal >::iterator iterator
Definition: BasicValueFactory.h:49
StoreRef.h
clang::diag::kind
unsigned kind
All of the diagnostics that can be emitted by the frontend.
Definition: DiagnosticIDs.h:62
clang::ento::CompoundValData::end
iterator end() const
Definition: BasicValueFactory.h:52
clang::ento::BasicValueFactory::getAPSIntType
APSIntType getAPSIntType(QualType T) const
Returns the type of the APSInt used to store values of the given QualType.
Definition: BasicValueFactory.h:148
clang::ento::BasicValueFactory::getZeroWithTypeSize
const llvm::APSInt & getZeroWithTypeSize(QualType T)
Definition: BasicValueFactory.h:224
clang::Type::isIntegralOrEnumerationType
bool isIntegralOrEnumerationType() const
Determine whether this type is an integral or enumeration type.
Definition: Type.h:7283
clang::ento::BasicValueFactory::getTruthValue
const llvm::APSInt & getTruthValue(bool b, QualType T)
Definition: BasicValueFactory.h:229
clang::ento::PointerToMemberData::Profile
void Profile(llvm::FoldingSetNodeID &ID)
Definition: BasicValueFactory.h:103
clang::ento::BasicValueFactory::getPersistentSValPair
const std::pair< SVal, SVal > & getPersistentSValPair(const SVal &V1, const SVal &V2)
Definition: BasicValueFactory.cpp:370