clang 19.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
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
34namespace clang {
35
36class CXXBaseSpecifier;
37
38namespace ento {
39
40class CompoundValData : public llvm::FoldingSetNode {
41 QualType T;
42 llvm::ImmutableList<SVal> L;
43
44public:
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
62class LazyCompoundValData : public llvm::FoldingSetNode {
63 StoreRef store;
64 const TypedValueRegion *region;
65
66public:
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
86class PointerToMemberData : public llvm::FoldingSetNode {
87 const NamedDecl *D;
88 llvm::ImmutableList<const CXXBaseSpecifier *> L;
89
90public:
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
134public:
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
156 return APSIntType(Ctx.getIntWidth(T),
158 } else {
159 // implicitly handle case of T->isFixedPointType()
161 }
162
163 llvm_unreachable("Unsupported type in getAPSIntType!");
164 }
165
166 /// Convert - Create a new persistent APSInt with the same value as 'From'
167 /// but with the bitwidth and signedness of 'To'.
168 const llvm::APSInt &Convert(const llvm::APSInt& To,
169 const llvm::APSInt& From) {
170 APSIntType TargetType(To);
171 if (TargetType == APSIntType(From))
172 return From;
173
174 return getValue(TargetType.convert(From));
175 }
176
177 const llvm::APSInt &Convert(QualType T, const llvm::APSInt &From) {
178 APSIntType TargetType = getAPSIntType(T);
179 return Convert(TargetType, From);
180 }
181
182 const llvm::APSInt &Convert(APSIntType TargetType, const llvm::APSInt &From) {
183 if (TargetType == APSIntType(From))
184 return From;
185
186 return getValue(TargetType.convert(From));
187 }
188
189 const llvm::APSInt &getIntValue(uint64_t X, bool isUnsigned) {
191 return getValue(X, T);
192 }
193
194 const llvm::APSInt &getMaxValue(const llvm::APSInt &v) {
195 return getValue(APSIntType(v).getMaxValue());
196 }
197
198 const llvm::APSInt &getMinValue(const llvm::APSInt &v) {
199 return getValue(APSIntType(v).getMinValue());
200 }
201
202 const llvm::APSInt &getMaxValue(QualType T) {
203 return getMaxValue(getAPSIntType(T));
204 }
205
206 const llvm::APSInt &getMinValue(QualType T) {
207 return getMinValue(getAPSIntType(T));
208 }
209
210 const llvm::APSInt &getMaxValue(APSIntType T) {
211 return getValue(T.getMaxValue());
212 }
213
214 const llvm::APSInt &getMinValue(APSIntType T) {
215 return getValue(T.getMinValue());
216 }
217
218 const llvm::APSInt &Add1(const llvm::APSInt &V) {
219 llvm::APSInt X = V;
220 ++X;
221 return getValue(X);
222 }
223
224 const llvm::APSInt &Sub1(const llvm::APSInt &V) {
225 llvm::APSInt X = V;
226 --X;
227 return getValue(X);
228 }
229
230 const llvm::APSInt &getZeroWithTypeSize(QualType T) {
231 assert(T->isScalarType());
232 return getValue(0, Ctx.getTypeSize(T), true);
233 }
234
235 const llvm::APSInt &getTruthValue(bool b, QualType T) {
236 return getValue(b ? 1 : 0, Ctx.getIntWidth(T),
238 }
239
240 const llvm::APSInt &getTruthValue(bool b) {
242 }
243
245 llvm::ImmutableList<SVal> Vals);
246
248 const TypedValueRegion *region);
249
250 const PointerToMemberData *
252 llvm::ImmutableList<const CXXBaseSpecifier *> L);
253
254 llvm::ImmutableList<SVal> getEmptySValList() {
255 return SValListFactory.getEmptyList();
256 }
257
258 llvm::ImmutableList<SVal> prependSVal(SVal X, llvm::ImmutableList<SVal> L) {
259 return SValListFactory.add(X, L);
260 }
261
262 llvm::ImmutableList<const CXXBaseSpecifier *> getEmptyCXXBaseList() {
263 return CXXBaseListFactory.getEmptyList();
264 }
265
266 llvm::ImmutableList<const CXXBaseSpecifier *> prependCXXBase(
267 const CXXBaseSpecifier *CBS,
268 llvm::ImmutableList<const CXXBaseSpecifier *> L) {
269 return CXXBaseListFactory.add(CBS, L);
270 }
271
272 const PointerToMemberData *
273 accumCXXBase(llvm::iterator_range<CastExpr::path_const_iterator> PathRange,
274 const nonloc::PointerToMember &PTM, const clang::CastKind &kind);
275
276 const llvm::APSInt* evalAPSInt(BinaryOperator::Opcode Op,
277 const llvm::APSInt& V1,
278 const llvm::APSInt& V2);
279
280 const std::pair<SVal, uintptr_t>&
282
283 const std::pair<SVal, SVal>&
284 getPersistentSValPair(const SVal& V1, const SVal& V2);
285
287};
288
289} // namespace ento
290
291} // namespace clang
292
293#endif // LLVM_CLANG_STATICANALYZER_CORE_PATHSENSITIVE_BASICVALUEFACTORY_H
Defines the clang::ASTContext interface.
#define V(N, I)
Definition: ASTContext.h:3294
static char ID
Definition: Arena.cpp:183
static bool isUnsigned(SValBuilder &SVB, NonLoc Value)
#define X(type, name)
Definition: Value.h:143
C Language Family Type Representation.
__device__ __2f16 b
do v
Definition: arm_acle.h:83
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:185
unsigned getIntWidth(QualType T) const
CanQualType IntTy
Definition: ASTContext.h:1103
uint64_t getTypeSize(QualType T) const
Return the size of the specified (complete) type T, in bits.
Definition: ASTContext.h:2350
CanQualType UnsignedIntTy
Definition: ASTContext.h:1104
QualType getLogicalOperationType() const
The result type of logical operations, '<', '>', '!=', etc.
Definition: ASTContext.h:2009
Represents a base class of a C++ class.
Definition: DeclCXX.h:146
This represents a decl that may have a name.
Definition: Decl.h:249
A (possibly-)qualified type.
Definition: Type.h:940
bool isSignedIntegerOrEnumerationType() const
Determines whether this is an integer type that is signed or an enumeration types whose underlying ty...
Definition: Type.cpp:2166
bool isUnsignedIntegerOrEnumerationType() const
Determines whether this is an integer type that is unsigned or an enumeration types whose underlying ...
Definition: Type.cpp:2216
bool isScalarType() const
Definition: Type.h:8024
bool isIntegralOrEnumerationType() const
Determine whether this type is an integral or enumeration type.
Definition: Type.h:8040
bool isUnsignedFixedPointType() const
Return true if this is a fixed point type that is unsigned according to ISO/IEC JTC1 SC22 WG14 N1169.
Definition: Type.h:8020
const T * getAs() const
Member-template getAs<specific type>'.
Definition: Type.h:8146
A record of the "type" of an APSInt, used for conversions.
Definition: APSIntType.h:19
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
const llvm::APSInt & Add1(const llvm::APSInt &V)
const llvm::APSInt & getMinValue(QualType T)
const llvm::APSInt & Convert(APSIntType TargetType, const llvm::APSInt &From)
const CompoundValData * getCompoundValData(QualType T, llvm::ImmutableList< SVal > Vals)
const std::pair< SVal, SVal > & getPersistentSValPair(const SVal &V1, const SVal &V2)
const SVal * getPersistentSVal(SVal X)
BasicValueFactory(ASTContext &ctx, llvm::BumpPtrAllocator &Alloc)
const llvm::APSInt & getMaxValue(const llvm::APSInt &v)
const llvm::APSInt & Sub1(const llvm::APSInt &V)
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...
const llvm::APSInt & getTruthValue(bool b, QualType T)
const llvm::APSInt & getMaxValue(QualType T)
const llvm::APSInt & getTruthValue(bool b)
const std::pair< SVal, uintptr_t > & getPersistentSValWithData(const SVal &V, uintptr_t Data)
const llvm::APSInt & getIntValue(uint64_t X, bool isUnsigned)
const llvm::APSInt * evalAPSInt(BinaryOperator::Opcode Op, const llvm::APSInt &V1, const llvm::APSInt &V2)
APSIntType getAPSIntType(QualType T) const
Returns the type of the APSInt used to store values of the given QualType.
const llvm::APSInt & getMaxValue(APSIntType T)
const PointerToMemberData * getPointerToMemberData(const NamedDecl *ND, llvm::ImmutableList< const CXXBaseSpecifier * > L)
llvm::ImmutableList< const CXXBaseSpecifier * > prependCXXBase(const CXXBaseSpecifier *CBS, llvm::ImmutableList< const CXXBaseSpecifier * > L)
const llvm::APSInt & getMinValue(const llvm::APSInt &v)
llvm::ImmutableList< const CXXBaseSpecifier * > getEmptyCXXBaseList()
const LazyCompoundValData * getLazyCompoundValData(const StoreRef &store, const TypedValueRegion *region)
const PointerToMemberData * accumCXXBase(llvm::iterator_range< CastExpr::path_const_iterator > PathRange, const nonloc::PointerToMember &PTM, const clang::CastKind &kind)
const llvm::APSInt & getMinValue(APSIntType T)
llvm::ImmutableList< SVal > getEmptySValList()
const llvm::APSInt & getZeroWithTypeSize(QualType T)
llvm::ImmutableList< SVal > prependSVal(SVal X, llvm::ImmutableList< SVal > L)
const llvm::APSInt & Convert(QualType T, const llvm::APSInt &From)
static void Profile(llvm::FoldingSetNodeID &ID, QualType T, llvm::ImmutableList< SVal > L)
llvm::ImmutableList< SVal >::iterator iterator
void Profile(llvm::FoldingSetNodeID &ID)
CompoundValData(QualType t, llvm::ImmutableList< SVal > l)
static void Profile(llvm::FoldingSetNodeID &ID, const StoreRef &store, const TypedValueRegion *region)
LazyCompoundValData(const StoreRef &st, const TypedValueRegion *r)
const void * getStore() const
It might return null.
void Profile(llvm::FoldingSetNodeID &ID)
LLVM_ATTRIBUTE_RETURNS_NONNULL const TypedValueRegion * getRegion() const
static bool isLocType(QualType T)
Definition: SVals.h:259
static bool isCompoundType(QualType T)
Definition: SVals.h:242
llvm::ImmutableList< const CXXBaseSpecifier * > getCXXBaseList() const
void Profile(llvm::FoldingSetNodeID &ID)
llvm::ImmutableList< const CXXBaseSpecifier * >::iterator iterator
const NamedDecl * getDeclaratorDecl() const
It might return null.
static void Profile(llvm::FoldingSetNodeID &ID, const NamedDecl *D, llvm::ImmutableList< const CXXBaseSpecifier * > L)
PointerToMemberData(const NamedDecl *D, llvm::ImmutableList< const CXXBaseSpecifier * > L)
SVal - This represents a symbolic expression, which can be either an L-value or an R-value.
Definition: SVals.h:55
Store getStore() const
Definition: StoreRef.h:46
TypedValueRegion - An abstract class representing regions having a typed value.
Definition: MemRegion.h:530
virtual QualType getValueType() const =0
Value representing pointer-to-member.
Definition: SVals.h:382
The JSON file list parser is used to communicate input to InstallAPI.
BinaryOperatorKind
CastKind
CastKind - The kind of operation required for a conversion.
const FunctionProtoType * T
__UINTPTR_TYPE__ uintptr_t
An unsigned integer type with the property that any valid pointer to void can be converted to this ty...