Bug Summary

File:clang/lib/StaticAnalyzer/Core/MemRegion.cpp
Warning:line 951, column 36
Called C++ object pointer is null

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -clear-ast-before-backend -disable-llvm-verifier -discard-value-names -main-file-name MemRegion.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mframe-pointer=none -relaxed-aliasing -fmath-errno -fno-rounding-math -mconstructor-aliases -funwind-tables=2 -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -ffunction-sections -fdata-sections -fcoverage-compilation-dir=/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/build-llvm -resource-dir /usr/lib/llvm-14/lib/clang/14.0.0 -D CLANG_ROUND_TRIP_CC1_ARGS=ON -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I tools/clang/lib/StaticAnalyzer/Core -I /build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core -I /build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include -I tools/clang/include -I include -I /build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/llvm/include -D NDEBUG -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/x86_64-linux-gnu/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10/backward -internal-isystem /usr/lib/llvm-14/lib/clang/14.0.0/include -internal-isystem /usr/local/include -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../x86_64-linux-gnu/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-command-line-argument -Wno-unknown-warning-option -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-class-memaccess -Wno-redundant-move -Wno-pessimizing-move -Wno-noexcept-type -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir=/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/build-llvm -ferror-limit 19 -fvisibility-inlines-hidden -fgnuc-version=4.2.1 -fcolor-diagnostics -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /tmp/scan-build-2021-10-17-004846-21170-1 -x c++ /build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp

/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp

1//===- MemRegion.cpp - Abstract memory regions for static analysis --------===//
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 MemRegion and its subclasses. MemRegion defines a
10// partially-typed abstraction of memory useful for path-sensitive dataflow
11// analyses.
12//
13//===----------------------------------------------------------------------===//
14
15#include "clang/StaticAnalyzer/Core/PathSensitive/MemRegion.h"
16#include "clang/AST/ASTContext.h"
17#include "clang/AST/Attr.h"
18#include "clang/AST/CharUnits.h"
19#include "clang/AST/Decl.h"
20#include "clang/AST/DeclCXX.h"
21#include "clang/AST/DeclObjC.h"
22#include "clang/AST/Expr.h"
23#include "clang/AST/PrettyPrinter.h"
24#include "clang/AST/RecordLayout.h"
25#include "clang/AST/Type.h"
26#include "clang/Analysis/AnalysisDeclContext.h"
27#include "clang/Analysis/Support/BumpVector.h"
28#include "clang/Basic/IdentifierTable.h"
29#include "clang/Basic/LLVM.h"
30#include "clang/Basic/SourceManager.h"
31#include "clang/StaticAnalyzer/Core/AnalyzerOptions.h"
32#include "clang/StaticAnalyzer/Core/PathSensitive/DynamicExtent.h"
33#include "clang/StaticAnalyzer/Core/PathSensitive/SValBuilder.h"
34#include "clang/StaticAnalyzer/Core/PathSensitive/SVals.h"
35#include "clang/StaticAnalyzer/Core/PathSensitive/SymbolManager.h"
36#include "llvm/ADT/APInt.h"
37#include "llvm/ADT/FoldingSet.h"
38#include "llvm/ADT/Optional.h"
39#include "llvm/ADT/PointerUnion.h"
40#include "llvm/ADT/SmallString.h"
41#include "llvm/ADT/StringRef.h"
42#include "llvm/ADT/Twine.h"
43#include "llvm/Support/Allocator.h"
44#include "llvm/Support/Casting.h"
45#include "llvm/Support/CheckedArithmetic.h"
46#include "llvm/Support/Compiler.h"
47#include "llvm/Support/Debug.h"
48#include "llvm/Support/ErrorHandling.h"
49#include "llvm/Support/raw_ostream.h"
50#include <cassert>
51#include <cstdint>
52#include <functional>
53#include <iterator>
54#include <string>
55#include <tuple>
56#include <utility>
57
58using namespace clang;
59using namespace ento;
60
61#define DEBUG_TYPE"MemRegion" "MemRegion"
62
63//===----------------------------------------------------------------------===//
64// MemRegion Construction.
65//===----------------------------------------------------------------------===//
66
67template <typename RegionTy, typename SuperTy, typename Arg1Ty>
68RegionTy* MemRegionManager::getSubRegion(const Arg1Ty arg1,
69 const SuperTy *superRegion) {
70 llvm::FoldingSetNodeID ID;
71 RegionTy::ProfileRegion(ID, arg1, superRegion);
72 void *InsertPos;
73 auto *R = cast_or_null<RegionTy>(Regions.FindNodeOrInsertPos(ID, InsertPos));
74
75 if (!R) {
76 R = A.Allocate<RegionTy>();
77 new (R) RegionTy(arg1, superRegion);
78 Regions.InsertNode(R, InsertPos);
79 }
80
81 return R;
82}
83
84template <typename RegionTy, typename SuperTy, typename Arg1Ty, typename Arg2Ty>
85RegionTy* MemRegionManager::getSubRegion(const Arg1Ty arg1, const Arg2Ty arg2,
86 const SuperTy *superRegion) {
87 llvm::FoldingSetNodeID ID;
88 RegionTy::ProfileRegion(ID, arg1, arg2, superRegion);
89 void *InsertPos;
90 auto *R = cast_or_null<RegionTy>(Regions.FindNodeOrInsertPos(ID, InsertPos));
91
92 if (!R) {
93 R = A.Allocate<RegionTy>();
94 new (R) RegionTy(arg1, arg2, superRegion);
95 Regions.InsertNode(R, InsertPos);
96 }
97
98 return R;
99}
100
101template <typename RegionTy, typename SuperTy,
102 typename Arg1Ty, typename Arg2Ty, typename Arg3Ty>
103RegionTy* MemRegionManager::getSubRegion(const Arg1Ty arg1, const Arg2Ty arg2,
104 const Arg3Ty arg3,
105 const SuperTy *superRegion) {
106 llvm::FoldingSetNodeID ID;
107 RegionTy::ProfileRegion(ID, arg1, arg2, arg3, superRegion);
108 void *InsertPos;
109 auto *R = cast_or_null<RegionTy>(Regions.FindNodeOrInsertPos(ID, InsertPos));
110
111 if (!R) {
112 R = A.Allocate<RegionTy>();
113 new (R) RegionTy(arg1, arg2, arg3, superRegion);
114 Regions.InsertNode(R, InsertPos);
115 }
116
117 return R;
118}
119
120//===----------------------------------------------------------------------===//
121// Object destruction.
122//===----------------------------------------------------------------------===//
123
124MemRegion::~MemRegion() = default;
125
126// All regions and their data are BumpPtrAllocated. No need to call their
127// destructors.
128MemRegionManager::~MemRegionManager() = default;
129
130//===----------------------------------------------------------------------===//
131// Basic methods.
132//===----------------------------------------------------------------------===//
133
134bool SubRegion::isSubRegionOf(const MemRegion* R) const {
135 const MemRegion* r = this;
136 do {
137 if (r == R)
138 return true;
139 if (const auto *sr = dyn_cast<SubRegion>(r))
140 r = sr->getSuperRegion();
141 else
142 break;
143 } while (r != nullptr);
144 return false;
145}
146
147MemRegionManager &SubRegion::getMemRegionManager() const {
148 const SubRegion* r = this;
149 do {
150 const MemRegion *superRegion = r->getSuperRegion();
151 if (const auto *sr = dyn_cast<SubRegion>(superRegion)) {
152 r = sr;
153 continue;
154 }
155 return superRegion->getMemRegionManager();
156 } while (true);
157}
158
159const StackFrameContext *VarRegion::getStackFrame() const {
160 const auto *SSR = dyn_cast<StackSpaceRegion>(getMemorySpace());
161 return SSR ? SSR->getStackFrame() : nullptr;
162}
163
164ObjCIvarRegion::ObjCIvarRegion(const ObjCIvarDecl *ivd, const SubRegion *sReg)
165 : DeclRegion(sReg, ObjCIvarRegionKind), IVD(ivd) {}
166
167const ObjCIvarDecl *ObjCIvarRegion::getDecl() const { return IVD; }
168
169QualType ObjCIvarRegion::getValueType() const {
170 return getDecl()->getType();
171}
172
173QualType CXXBaseObjectRegion::getValueType() const {
174 return QualType(getDecl()->getTypeForDecl(), 0);
175}
176
177QualType CXXDerivedObjectRegion::getValueType() const {
178 return QualType(getDecl()->getTypeForDecl(), 0);
179}
180
181QualType ParamVarRegion::getValueType() const {
182 assert(getDecl() &&(static_cast <bool> (getDecl() && "`ParamVarRegion` support functions without `Decl` not implemented"
" yet.") ? void (0) : __assert_fail ("getDecl() && \"`ParamVarRegion` support functions without `Decl` not implemented\" \" yet.\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 184, __extension__ __PRETTY_FUNCTION__))
183 "`ParamVarRegion` support functions without `Decl` not implemented"(static_cast <bool> (getDecl() && "`ParamVarRegion` support functions without `Decl` not implemented"
" yet.") ? void (0) : __assert_fail ("getDecl() && \"`ParamVarRegion` support functions without `Decl` not implemented\" \" yet.\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 184, __extension__ __PRETTY_FUNCTION__))
184 " yet.")(static_cast <bool> (getDecl() && "`ParamVarRegion` support functions without `Decl` not implemented"
" yet.") ? void (0) : __assert_fail ("getDecl() && \"`ParamVarRegion` support functions without `Decl` not implemented\" \" yet.\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 184, __extension__ __PRETTY_FUNCTION__))
;
185 return getDecl()->getType();
186}
187
188const ParmVarDecl *ParamVarRegion::getDecl() const {
189 const Decl *D = getStackFrame()->getDecl();
190
191 if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
192 assert(Index < FD->param_size())(static_cast <bool> (Index < FD->param_size()) ? void
(0) : __assert_fail ("Index < FD->param_size()", "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 192, __extension__ __PRETTY_FUNCTION__))
;
193 return FD->parameters()[Index];
194 } else if (const auto *BD = dyn_cast<BlockDecl>(D)) {
195 assert(Index < BD->param_size())(static_cast <bool> (Index < BD->param_size()) ? void
(0) : __assert_fail ("Index < BD->param_size()", "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 195, __extension__ __PRETTY_FUNCTION__))
;
196 return BD->parameters()[Index];
197 } else if (const auto *MD = dyn_cast<ObjCMethodDecl>(D)) {
198 assert(Index < MD->param_size())(static_cast <bool> (Index < MD->param_size()) ? void
(0) : __assert_fail ("Index < MD->param_size()", "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 198, __extension__ __PRETTY_FUNCTION__))
;
199 return MD->parameters()[Index];
200 } else if (const auto *CD = dyn_cast<CXXConstructorDecl>(D)) {
201 assert(Index < CD->param_size())(static_cast <bool> (Index < CD->param_size()) ? void
(0) : __assert_fail ("Index < CD->param_size()", "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 201, __extension__ __PRETTY_FUNCTION__))
;
202 return CD->parameters()[Index];
203 } else {
204 llvm_unreachable("Unexpected Decl kind!")::llvm::llvm_unreachable_internal("Unexpected Decl kind!", "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 204)
;
205 }
206}
207
208//===----------------------------------------------------------------------===//
209// FoldingSet profiling.
210//===----------------------------------------------------------------------===//
211
212void MemSpaceRegion::Profile(llvm::FoldingSetNodeID &ID) const {
213 ID.AddInteger(static_cast<unsigned>(getKind()));
214}
215
216void StackSpaceRegion::Profile(llvm::FoldingSetNodeID &ID) const {
217 ID.AddInteger(static_cast<unsigned>(getKind()));
218 ID.AddPointer(getStackFrame());
219}
220
221void StaticGlobalSpaceRegion::Profile(llvm::FoldingSetNodeID &ID) const {
222 ID.AddInteger(static_cast<unsigned>(getKind()));
223 ID.AddPointer(getCodeRegion());
224}
225
226void StringRegion::ProfileRegion(llvm::FoldingSetNodeID &ID,
227 const StringLiteral *Str,
228 const MemRegion *superRegion) {
229 ID.AddInteger(static_cast<unsigned>(StringRegionKind));
230 ID.AddPointer(Str);
231 ID.AddPointer(superRegion);
232}
233
234void ObjCStringRegion::ProfileRegion(llvm::FoldingSetNodeID &ID,
235 const ObjCStringLiteral *Str,
236 const MemRegion *superRegion) {
237 ID.AddInteger(static_cast<unsigned>(ObjCStringRegionKind));
238 ID.AddPointer(Str);
239 ID.AddPointer(superRegion);
240}
241
242void AllocaRegion::ProfileRegion(llvm::FoldingSetNodeID& ID,
243 const Expr *Ex, unsigned cnt,
244 const MemRegion *superRegion) {
245 ID.AddInteger(static_cast<unsigned>(AllocaRegionKind));
246 ID.AddPointer(Ex);
247 ID.AddInteger(cnt);
248 ID.AddPointer(superRegion);
249}
250
251void AllocaRegion::Profile(llvm::FoldingSetNodeID& ID) const {
252 ProfileRegion(ID, Ex, Cnt, superRegion);
253}
254
255void CompoundLiteralRegion::Profile(llvm::FoldingSetNodeID& ID) const {
256 CompoundLiteralRegion::ProfileRegion(ID, CL, superRegion);
257}
258
259void CompoundLiteralRegion::ProfileRegion(llvm::FoldingSetNodeID& ID,
260 const CompoundLiteralExpr *CL,
261 const MemRegion* superRegion) {
262 ID.AddInteger(static_cast<unsigned>(CompoundLiteralRegionKind));
263 ID.AddPointer(CL);
264 ID.AddPointer(superRegion);
265}
266
267void CXXThisRegion::ProfileRegion(llvm::FoldingSetNodeID &ID,
268 const PointerType *PT,
269 const MemRegion *sRegion) {
270 ID.AddInteger(static_cast<unsigned>(CXXThisRegionKind));
271 ID.AddPointer(PT);
272 ID.AddPointer(sRegion);
273}
274
275void CXXThisRegion::Profile(llvm::FoldingSetNodeID &ID) const {
276 CXXThisRegion::ProfileRegion(ID, ThisPointerTy, superRegion);
277}
278
279void FieldRegion::Profile(llvm::FoldingSetNodeID &ID) const {
280 ProfileRegion(ID, getDecl(), superRegion);
281}
282
283void ObjCIvarRegion::ProfileRegion(llvm::FoldingSetNodeID& ID,
284 const ObjCIvarDecl *ivd,
285 const MemRegion* superRegion) {
286 ID.AddInteger(static_cast<unsigned>(ObjCIvarRegionKind));
287 ID.AddPointer(ivd);
288 ID.AddPointer(superRegion);
289}
290
291void ObjCIvarRegion::Profile(llvm::FoldingSetNodeID &ID) const {
292 ProfileRegion(ID, getDecl(), superRegion);
293}
294
295void NonParamVarRegion::ProfileRegion(llvm::FoldingSetNodeID &ID,
296 const VarDecl *VD,
297 const MemRegion *superRegion) {
298 ID.AddInteger(static_cast<unsigned>(NonParamVarRegionKind));
299 ID.AddPointer(VD);
300 ID.AddPointer(superRegion);
301}
302
303void NonParamVarRegion::Profile(llvm::FoldingSetNodeID &ID) const {
304 ProfileRegion(ID, getDecl(), superRegion);
305}
306
307void ParamVarRegion::ProfileRegion(llvm::FoldingSetNodeID &ID, const Expr *OE,
308 unsigned Idx, const MemRegion *SReg) {
309 ID.AddInteger(static_cast<unsigned>(ParamVarRegionKind));
310 ID.AddPointer(OE);
311 ID.AddInteger(Idx);
312 ID.AddPointer(SReg);
313}
314
315void ParamVarRegion::Profile(llvm::FoldingSetNodeID &ID) const {
316 ProfileRegion(ID, getOriginExpr(), getIndex(), superRegion);
317}
318
319void SymbolicRegion::ProfileRegion(llvm::FoldingSetNodeID& ID, SymbolRef sym,
320 const MemRegion *sreg) {
321 ID.AddInteger(static_cast<unsigned>(MemRegion::SymbolicRegionKind));
322 ID.Add(sym);
323 ID.AddPointer(sreg);
324}
325
326void SymbolicRegion::Profile(llvm::FoldingSetNodeID& ID) const {
327 SymbolicRegion::ProfileRegion(ID, sym, getSuperRegion());
328}
329
330void ElementRegion::ProfileRegion(llvm::FoldingSetNodeID& ID,
331 QualType ElementType, SVal Idx,
332 const MemRegion* superRegion) {
333 ID.AddInteger(MemRegion::ElementRegionKind);
334 ID.Add(ElementType);
335 ID.AddPointer(superRegion);
336 Idx.Profile(ID);
337}
338
339void ElementRegion::Profile(llvm::FoldingSetNodeID& ID) const {
340 ElementRegion::ProfileRegion(ID, ElementType, Index, superRegion);
341}
342
343void FunctionCodeRegion::ProfileRegion(llvm::FoldingSetNodeID& ID,
344 const NamedDecl *FD,
345 const MemRegion*) {
346 ID.AddInteger(MemRegion::FunctionCodeRegionKind);
347 ID.AddPointer(FD);
348}
349
350void FunctionCodeRegion::Profile(llvm::FoldingSetNodeID& ID) const {
351 FunctionCodeRegion::ProfileRegion(ID, FD, superRegion);
352}
353
354void BlockCodeRegion::ProfileRegion(llvm::FoldingSetNodeID& ID,
355 const BlockDecl *BD, CanQualType,
356 const AnalysisDeclContext *AC,
357 const MemRegion*) {
358 ID.AddInteger(MemRegion::BlockCodeRegionKind);
359 ID.AddPointer(BD);
360}
361
362void BlockCodeRegion::Profile(llvm::FoldingSetNodeID& ID) const {
363 BlockCodeRegion::ProfileRegion(ID, BD, locTy, AC, superRegion);
364}
365
366void BlockDataRegion::ProfileRegion(llvm::FoldingSetNodeID& ID,
367 const BlockCodeRegion *BC,
368 const LocationContext *LC,
369 unsigned BlkCount,
370 const MemRegion *sReg) {
371 ID.AddInteger(MemRegion::BlockDataRegionKind);
372 ID.AddPointer(BC);
373 ID.AddPointer(LC);
374 ID.AddInteger(BlkCount);
375 ID.AddPointer(sReg);
376}
377
378void BlockDataRegion::Profile(llvm::FoldingSetNodeID& ID) const {
379 BlockDataRegion::ProfileRegion(ID, BC, LC, BlockCount, getSuperRegion());
380}
381
382void CXXTempObjectRegion::ProfileRegion(llvm::FoldingSetNodeID &ID,
383 Expr const *Ex,
384 const MemRegion *sReg) {
385 ID.AddPointer(Ex);
386 ID.AddPointer(sReg);
387}
388
389void CXXTempObjectRegion::Profile(llvm::FoldingSetNodeID &ID) const {
390 ProfileRegion(ID, Ex, getSuperRegion());
391}
392
393void CXXBaseObjectRegion::ProfileRegion(llvm::FoldingSetNodeID &ID,
394 const CXXRecordDecl *RD,
395 bool IsVirtual,
396 const MemRegion *SReg) {
397 ID.AddPointer(RD);
398 ID.AddBoolean(IsVirtual);
399 ID.AddPointer(SReg);
400}
401
402void CXXBaseObjectRegion::Profile(llvm::FoldingSetNodeID &ID) const {
403 ProfileRegion(ID, getDecl(), isVirtual(), superRegion);
404}
405
406void CXXDerivedObjectRegion::ProfileRegion(llvm::FoldingSetNodeID &ID,
407 const CXXRecordDecl *RD,
408 const MemRegion *SReg) {
409 ID.AddPointer(RD);
410 ID.AddPointer(SReg);
411}
412
413void CXXDerivedObjectRegion::Profile(llvm::FoldingSetNodeID &ID) const {
414 ProfileRegion(ID, getDecl(), superRegion);
415}
416
417//===----------------------------------------------------------------------===//
418// Region anchors.
419//===----------------------------------------------------------------------===//
420
421void GlobalsSpaceRegion::anchor() {}
422
423void NonStaticGlobalSpaceRegion::anchor() {}
424
425void StackSpaceRegion::anchor() {}
426
427void TypedRegion::anchor() {}
428
429void TypedValueRegion::anchor() {}
430
431void CodeTextRegion::anchor() {}
432
433void SubRegion::anchor() {}
434
435//===----------------------------------------------------------------------===//
436// Region pretty-printing.
437//===----------------------------------------------------------------------===//
438
439LLVM_DUMP_METHOD__attribute__((noinline)) __attribute__((__used__)) void MemRegion::dump() const {
440 dumpToStream(llvm::errs());
441}
442
443std::string MemRegion::getString() const {
444 std::string s;
445 llvm::raw_string_ostream os(s);
446 dumpToStream(os);
447 return os.str();
448}
449
450void MemRegion::dumpToStream(raw_ostream &os) const {
451 os << "<Unknown Region>";
452}
453
454void AllocaRegion::dumpToStream(raw_ostream &os) const {
455 os << "alloca{S" << Ex->getID(getContext()) << ',' << Cnt << '}';
456}
457
458void FunctionCodeRegion::dumpToStream(raw_ostream &os) const {
459 os << "code{" << getDecl()->getDeclName().getAsString() << '}';
460}
461
462void BlockCodeRegion::dumpToStream(raw_ostream &os) const {
463 os << "block_code{" << static_cast<const void *>(this) << '}';
464}
465
466void BlockDataRegion::dumpToStream(raw_ostream &os) const {
467 os << "block_data{" << BC;
468 os << "; ";
469 for (BlockDataRegion::referenced_vars_iterator
470 I = referenced_vars_begin(),
471 E = referenced_vars_end(); I != E; ++I)
472 os << "(" << I.getCapturedRegion() << "<-" <<
473 I.getOriginalRegion() << ") ";
474 os << '}';
475}
476
477void CompoundLiteralRegion::dumpToStream(raw_ostream &os) const {
478 // FIXME: More elaborate pretty-printing.
479 os << "{ S" << CL->getID(getContext()) << " }";
480}
481
482void CXXTempObjectRegion::dumpToStream(raw_ostream &os) const {
483 os << "temp_object{" << getValueType().getAsString() << ", "
484 << "S" << Ex->getID(getContext()) << '}';
485}
486
487void CXXBaseObjectRegion::dumpToStream(raw_ostream &os) const {
488 os << "Base{" << superRegion << ',' << getDecl()->getName() << '}';
489}
490
491void CXXDerivedObjectRegion::dumpToStream(raw_ostream &os) const {
492 os << "Derived{" << superRegion << ',' << getDecl()->getName() << '}';
493}
494
495void CXXThisRegion::dumpToStream(raw_ostream &os) const {
496 os << "this";
497}
498
499void ElementRegion::dumpToStream(raw_ostream &os) const {
500 os << "Element{" << superRegion << ','
501 << Index << ',' << getElementType().getAsString() << '}';
502}
503
504void FieldRegion::dumpToStream(raw_ostream &os) const {
505 os << superRegion << "." << *getDecl();
506}
507
508void ObjCIvarRegion::dumpToStream(raw_ostream &os) const {
509 os << "Ivar{" << superRegion << ',' << *getDecl() << '}';
510}
511
512void StringRegion::dumpToStream(raw_ostream &os) const {
513 assert(Str != nullptr && "Expecting non-null StringLiteral")(static_cast <bool> (Str != nullptr && "Expecting non-null StringLiteral"
) ? void (0) : __assert_fail ("Str != nullptr && \"Expecting non-null StringLiteral\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 513, __extension__ __PRETTY_FUNCTION__))
;
514 Str->printPretty(os, nullptr, PrintingPolicy(getContext().getLangOpts()));
515}
516
517void ObjCStringRegion::dumpToStream(raw_ostream &os) const {
518 assert(Str != nullptr && "Expecting non-null ObjCStringLiteral")(static_cast <bool> (Str != nullptr && "Expecting non-null ObjCStringLiteral"
) ? void (0) : __assert_fail ("Str != nullptr && \"Expecting non-null ObjCStringLiteral\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 518, __extension__ __PRETTY_FUNCTION__))
;
519 Str->printPretty(os, nullptr, PrintingPolicy(getContext().getLangOpts()));
520}
521
522void SymbolicRegion::dumpToStream(raw_ostream &os) const {
523 if (isa<HeapSpaceRegion>(getSuperRegion()))
524 os << "Heap";
525 os << "SymRegion{" << sym << '}';
526}
527
528void NonParamVarRegion::dumpToStream(raw_ostream &os) const {
529 if (const IdentifierInfo *ID = VD->getIdentifier())
530 os << ID->getName();
531 else
532 os << "NonParamVarRegion{D" << VD->getID() << '}';
533}
534
535LLVM_DUMP_METHOD__attribute__((noinline)) __attribute__((__used__)) void RegionRawOffset::dump() const {
536 dumpToStream(llvm::errs());
537}
538
539void RegionRawOffset::dumpToStream(raw_ostream &os) const {
540 os << "raw_offset{" << getRegion() << ',' << getOffset().getQuantity() << '}';
541}
542
543void CodeSpaceRegion::dumpToStream(raw_ostream &os) const {
544 os << "CodeSpaceRegion";
545}
546
547void StaticGlobalSpaceRegion::dumpToStream(raw_ostream &os) const {
548 os << "StaticGlobalsMemSpace{" << CR << '}';
549}
550
551void GlobalInternalSpaceRegion::dumpToStream(raw_ostream &os) const {
552 os << "GlobalInternalSpaceRegion";
553}
554
555void GlobalSystemSpaceRegion::dumpToStream(raw_ostream &os) const {
556 os << "GlobalSystemSpaceRegion";
557}
558
559void GlobalImmutableSpaceRegion::dumpToStream(raw_ostream &os) const {
560 os << "GlobalImmutableSpaceRegion";
561}
562
563void HeapSpaceRegion::dumpToStream(raw_ostream &os) const {
564 os << "HeapSpaceRegion";
565}
566
567void UnknownSpaceRegion::dumpToStream(raw_ostream &os) const {
568 os << "UnknownSpaceRegion";
569}
570
571void StackArgumentsSpaceRegion::dumpToStream(raw_ostream &os) const {
572 os << "StackArgumentsSpaceRegion";
573}
574
575void StackLocalsSpaceRegion::dumpToStream(raw_ostream &os) const {
576 os << "StackLocalsSpaceRegion";
577}
578
579void ParamVarRegion::dumpToStream(raw_ostream &os) const {
580 const ParmVarDecl *PVD = getDecl();
581 assert(PVD &&(static_cast <bool> (PVD && "`ParamVarRegion` support functions without `Decl` not implemented"
" yet.") ? void (0) : __assert_fail ("PVD && \"`ParamVarRegion` support functions without `Decl` not implemented\" \" yet.\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 583, __extension__ __PRETTY_FUNCTION__))
582 "`ParamVarRegion` support functions without `Decl` not implemented"(static_cast <bool> (PVD && "`ParamVarRegion` support functions without `Decl` not implemented"
" yet.") ? void (0) : __assert_fail ("PVD && \"`ParamVarRegion` support functions without `Decl` not implemented\" \" yet.\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 583, __extension__ __PRETTY_FUNCTION__))
583 " yet.")(static_cast <bool> (PVD && "`ParamVarRegion` support functions without `Decl` not implemented"
" yet.") ? void (0) : __assert_fail ("PVD && \"`ParamVarRegion` support functions without `Decl` not implemented\" \" yet.\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 583, __extension__ __PRETTY_FUNCTION__))
;
584 if (const IdentifierInfo *ID = PVD->getIdentifier()) {
585 os << ID->getName();
586 } else {
587 os << "ParamVarRegion{P" << PVD->getID() << '}';
588 }
589}
590
591bool MemRegion::canPrintPretty() const {
592 return canPrintPrettyAsExpr();
593}
594
595bool MemRegion::canPrintPrettyAsExpr() const {
596 return false;
597}
598
599void MemRegion::printPretty(raw_ostream &os) const {
600 assert(canPrintPretty() && "This region cannot be printed pretty.")(static_cast <bool> (canPrintPretty() && "This region cannot be printed pretty."
) ? void (0) : __assert_fail ("canPrintPretty() && \"This region cannot be printed pretty.\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 600, __extension__ __PRETTY_FUNCTION__))
;
601 os << "'";
602 printPrettyAsExpr(os);
603 os << "'";
604}
605
606void MemRegion::printPrettyAsExpr(raw_ostream &) const {
607 llvm_unreachable("This region cannot be printed pretty.")::llvm::llvm_unreachable_internal("This region cannot be printed pretty."
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 607)
;
608}
609
610bool NonParamVarRegion::canPrintPrettyAsExpr() const { return true; }
611
612void NonParamVarRegion::printPrettyAsExpr(raw_ostream &os) const {
613 os << getDecl()->getName();
614}
615
616bool ParamVarRegion::canPrintPrettyAsExpr() const { return true; }
617
618void ParamVarRegion::printPrettyAsExpr(raw_ostream &os) const {
619 assert(getDecl() &&(static_cast <bool> (getDecl() && "`ParamVarRegion` support functions without `Decl` not implemented"
" yet.") ? void (0) : __assert_fail ("getDecl() && \"`ParamVarRegion` support functions without `Decl` not implemented\" \" yet.\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 621, __extension__ __PRETTY_FUNCTION__))
620 "`ParamVarRegion` support functions without `Decl` not implemented"(static_cast <bool> (getDecl() && "`ParamVarRegion` support functions without `Decl` not implemented"
" yet.") ? void (0) : __assert_fail ("getDecl() && \"`ParamVarRegion` support functions without `Decl` not implemented\" \" yet.\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 621, __extension__ __PRETTY_FUNCTION__))
621 " yet.")(static_cast <bool> (getDecl() && "`ParamVarRegion` support functions without `Decl` not implemented"
" yet.") ? void (0) : __assert_fail ("getDecl() && \"`ParamVarRegion` support functions without `Decl` not implemented\" \" yet.\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 621, __extension__ __PRETTY_FUNCTION__))
;
622 os << getDecl()->getName();
623}
624
625bool ObjCIvarRegion::canPrintPrettyAsExpr() const {
626 return true;
627}
628
629void ObjCIvarRegion::printPrettyAsExpr(raw_ostream &os) const {
630 os << getDecl()->getName();
631}
632
633bool FieldRegion::canPrintPretty() const {
634 return true;
635}
636
637bool FieldRegion::canPrintPrettyAsExpr() const {
638 return superRegion->canPrintPrettyAsExpr();
639}
640
641void FieldRegion::printPrettyAsExpr(raw_ostream &os) const {
642 assert(canPrintPrettyAsExpr())(static_cast <bool> (canPrintPrettyAsExpr()) ? void (0)
: __assert_fail ("canPrintPrettyAsExpr()", "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 642, __extension__ __PRETTY_FUNCTION__))
;
643 superRegion->printPrettyAsExpr(os);
644 os << "." << getDecl()->getName();
645}
646
647void FieldRegion::printPretty(raw_ostream &os) const {
648 if (canPrintPrettyAsExpr()) {
649 os << "\'";
650 printPrettyAsExpr(os);
651 os << "'";
652 } else {
653 os << "field " << "\'" << getDecl()->getName() << "'";
654 }
655}
656
657bool CXXBaseObjectRegion::canPrintPrettyAsExpr() const {
658 return superRegion->canPrintPrettyAsExpr();
659}
660
661void CXXBaseObjectRegion::printPrettyAsExpr(raw_ostream &os) const {
662 superRegion->printPrettyAsExpr(os);
663}
664
665bool CXXDerivedObjectRegion::canPrintPrettyAsExpr() const {
666 return superRegion->canPrintPrettyAsExpr();
667}
668
669void CXXDerivedObjectRegion::printPrettyAsExpr(raw_ostream &os) const {
670 superRegion->printPrettyAsExpr(os);
671}
672
673std::string MemRegion::getDescriptiveName(bool UseQuotes) const {
674 std::string VariableName;
675 std::string ArrayIndices;
676 const MemRegion *R = this;
677 SmallString<50> buf;
678 llvm::raw_svector_ostream os(buf);
679
680 // Obtain array indices to add them to the variable name.
681 const ElementRegion *ER = nullptr;
682 while ((ER = R->getAs<ElementRegion>())) {
683 // Index is a ConcreteInt.
684 if (auto CI = ER->getIndex().getAs<nonloc::ConcreteInt>()) {
685 llvm::SmallString<2> Idx;
686 CI->getValue().toString(Idx);
687 ArrayIndices = (llvm::Twine("[") + Idx.str() + "]" + ArrayIndices).str();
688 }
689 // If not a ConcreteInt, try to obtain the variable
690 // name by calling 'getDescriptiveName' recursively.
691 else {
692 std::string Idx = ER->getDescriptiveName(false);
693 if (!Idx.empty()) {
694 ArrayIndices = (llvm::Twine("[") + Idx + "]" + ArrayIndices).str();
695 }
696 }
697 R = ER->getSuperRegion();
698 }
699
700 // Get variable name.
701 if (R && R->canPrintPrettyAsExpr()) {
702 R->printPrettyAsExpr(os);
703 if (UseQuotes)
704 return (llvm::Twine("'") + os.str() + ArrayIndices + "'").str();
705 else
706 return (llvm::Twine(os.str()) + ArrayIndices).str();
707 }
708
709 return VariableName;
710}
711
712SourceRange MemRegion::sourceRange() const {
713 const auto *const VR = dyn_cast<VarRegion>(this->getBaseRegion());
714 const auto *const FR = dyn_cast<FieldRegion>(this);
715
716 // Check for more specific regions first.
717 // FieldRegion
718 if (FR) {
719 return FR->getDecl()->getSourceRange();
720 }
721 // VarRegion
722 else if (VR) {
723 return VR->getDecl()->getSourceRange();
724 }
725 // Return invalid source range (can be checked by client).
726 else
727 return {};
728}
729
730//===----------------------------------------------------------------------===//
731// MemRegionManager methods.
732//===----------------------------------------------------------------------===//
733
734DefinedOrUnknownSVal MemRegionManager::getStaticSize(const MemRegion *MR,
735 SValBuilder &SVB) const {
736 const auto *SR = cast<SubRegion>(MR);
737 SymbolManager &SymMgr = SVB.getSymbolManager();
738
739 switch (SR->getKind()) {
740 case MemRegion::AllocaRegionKind:
741 case MemRegion::SymbolicRegionKind:
742 return nonloc::SymbolVal(SymMgr.getExtentSymbol(SR));
743 case MemRegion::StringRegionKind:
744 return SVB.makeIntVal(
745 cast<StringRegion>(SR)->getStringLiteral()->getByteLength() + 1,
746 SVB.getArrayIndexType());
747 case MemRegion::CompoundLiteralRegionKind:
748 case MemRegion::CXXBaseObjectRegionKind:
749 case MemRegion::CXXDerivedObjectRegionKind:
750 case MemRegion::CXXTempObjectRegionKind:
751 case MemRegion::CXXThisRegionKind:
752 case MemRegion::ObjCIvarRegionKind:
753 case MemRegion::NonParamVarRegionKind:
754 case MemRegion::ParamVarRegionKind:
755 case MemRegion::ElementRegionKind:
756 case MemRegion::ObjCStringRegionKind: {
757 QualType Ty = cast<TypedValueRegion>(SR)->getDesugaredValueType(Ctx);
758 if (isa<VariableArrayType>(Ty))
759 return nonloc::SymbolVal(SymMgr.getExtentSymbol(SR));
760
761 if (Ty->isIncompleteType())
762 return UnknownVal();
763
764 return getElementExtent(Ty, SVB);
765 }
766 case MemRegion::FieldRegionKind: {
767 // Force callers to deal with bitfields explicitly.
768 if (cast<FieldRegion>(SR)->getDecl()->isBitField())
769 return UnknownVal();
770
771 QualType Ty = cast<TypedValueRegion>(SR)->getDesugaredValueType(Ctx);
772 const DefinedOrUnknownSVal Size = getElementExtent(Ty, SVB);
773
774 // We currently don't model flexible array members (FAMs), which are:
775 // - int array[]; of IncompleteArrayType
776 // - int array[0]; of ConstantArrayType with size 0
777 // - int array[1]; of ConstantArrayType with size 1 (*)
778 // (*): Consider single element array object members as FAM candidates only
779 // if the consider-single-element-arrays-as-flexible-array-members
780 // analyzer option is true.
781 // https://gcc.gnu.org/onlinedocs/gcc/Zero-Length.html
782 const auto isFlexibleArrayMemberCandidate = [this,
783 &SVB](QualType Ty) -> bool {
784 const ArrayType *AT = Ctx.getAsArrayType(Ty);
785 if (!AT)
786 return false;
787 if (isa<IncompleteArrayType>(AT))
788 return true;
789
790 if (const auto *CAT = dyn_cast<ConstantArrayType>(AT)) {
791 const llvm::APInt &Size = CAT->getSize();
792 if (Size.isZero())
793 return true;
794
795 const AnalyzerOptions &Opts = SVB.getAnalyzerOptions();
796 if (Opts.ShouldConsiderSingleElementArraysAsFlexibleArrayMembers &&
797 Size.isOne())
798 return true;
799 }
800 return false;
801 };
802
803 if (isFlexibleArrayMemberCandidate(Ty))
804 return UnknownVal();
805
806 return Size;
807 }
808 // FIXME: The following are being used in 'SimpleSValBuilder' and in
809 // 'ArrayBoundChecker::checkLocation' because there is no symbol to
810 // represent the regions more appropriately.
811 case MemRegion::BlockDataRegionKind:
812 case MemRegion::BlockCodeRegionKind:
813 case MemRegion::FunctionCodeRegionKind:
814 return nonloc::SymbolVal(SymMgr.getExtentSymbol(SR));
815 default:
816 llvm_unreachable("Unhandled region")::llvm::llvm_unreachable_internal("Unhandled region", "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 816)
;
817 }
818}
819
820template <typename REG>
821const REG *MemRegionManager::LazyAllocate(REG*& region) {
822 if (!region) {
823 region = A.Allocate<REG>();
824 new (region) REG(*this);
825 }
826
827 return region;
828}
829
830template <typename REG, typename ARG>
831const REG *MemRegionManager::LazyAllocate(REG*& region, ARG a) {
832 if (!region) {
833 region = A.Allocate<REG>();
834 new (region) REG(this, a);
835 }
836
837 return region;
838}
839
840const StackLocalsSpaceRegion*
841MemRegionManager::getStackLocalsRegion(const StackFrameContext *STC) {
842 assert(STC)(static_cast <bool> (STC) ? void (0) : __assert_fail ("STC"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 842, __extension__ __PRETTY_FUNCTION__))
;
843 StackLocalsSpaceRegion *&R = StackLocalsSpaceRegions[STC];
844
845 if (R)
846 return R;
847
848 R = A.Allocate<StackLocalsSpaceRegion>();
849 new (R) StackLocalsSpaceRegion(*this, STC);
850 return R;
851}
852
853const StackArgumentsSpaceRegion *
854MemRegionManager::getStackArgumentsRegion(const StackFrameContext *STC) {
855 assert(STC)(static_cast <bool> (STC) ? void (0) : __assert_fail ("STC"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 855, __extension__ __PRETTY_FUNCTION__))
;
856 StackArgumentsSpaceRegion *&R = StackArgumentsSpaceRegions[STC];
857
858 if (R)
859 return R;
860
861 R = A.Allocate<StackArgumentsSpaceRegion>();
862 new (R) StackArgumentsSpaceRegion(*this, STC);
863 return R;
864}
865
866const GlobalsSpaceRegion
867*MemRegionManager::getGlobalsRegion(MemRegion::Kind K,
868 const CodeTextRegion *CR) {
869 if (!CR) {
870 if (K == MemRegion::GlobalSystemSpaceRegionKind)
871 return LazyAllocate(SystemGlobals);
872 if (K == MemRegion::GlobalImmutableSpaceRegionKind)
873 return LazyAllocate(ImmutableGlobals);
874 assert(K == MemRegion::GlobalInternalSpaceRegionKind)(static_cast <bool> (K == MemRegion::GlobalInternalSpaceRegionKind
) ? void (0) : __assert_fail ("K == MemRegion::GlobalInternalSpaceRegionKind"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 874, __extension__ __PRETTY_FUNCTION__))
;
875 return LazyAllocate(InternalGlobals);
876 }
877
878 assert(K == MemRegion::StaticGlobalSpaceRegionKind)(static_cast <bool> (K == MemRegion::StaticGlobalSpaceRegionKind
) ? void (0) : __assert_fail ("K == MemRegion::StaticGlobalSpaceRegionKind"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 878, __extension__ __PRETTY_FUNCTION__))
;
879 StaticGlobalSpaceRegion *&R = StaticsGlobalSpaceRegions[CR];
880 if (R)
881 return R;
882
883 R = A.Allocate<StaticGlobalSpaceRegion>();
884 new (R) StaticGlobalSpaceRegion(*this, CR);
885 return R;
886}
887
888const HeapSpaceRegion *MemRegionManager::getHeapRegion() {
889 return LazyAllocate(heap);
890}
891
892const UnknownSpaceRegion *MemRegionManager::getUnknownRegion() {
893 return LazyAllocate(unknown);
894}
895
896const CodeSpaceRegion *MemRegionManager::getCodeRegion() {
897 return LazyAllocate(code);
898}
899
900//===----------------------------------------------------------------------===//
901// Constructing regions.
902//===----------------------------------------------------------------------===//
903
904const StringRegion *MemRegionManager::getStringRegion(const StringLiteral *Str){
905 return getSubRegion<StringRegion>(
906 Str, cast<GlobalInternalSpaceRegion>(getGlobalsRegion()));
907}
908
909const ObjCStringRegion *
910MemRegionManager::getObjCStringRegion(const ObjCStringLiteral *Str){
911 return getSubRegion<ObjCStringRegion>(
912 Str, cast<GlobalInternalSpaceRegion>(getGlobalsRegion()));
913}
914
915/// Look through a chain of LocationContexts to either find the
916/// StackFrameContext that matches a DeclContext, or find a VarRegion
917/// for a variable captured by a block.
918static llvm::PointerUnion<const StackFrameContext *, const VarRegion *>
919getStackOrCaptureRegionForDeclContext(const LocationContext *LC,
920 const DeclContext *DC,
921 const VarDecl *VD) {
922 while (LC) {
923 if (const auto *SFC = dyn_cast<StackFrameContext>(LC)) {
924 if (cast<DeclContext>(SFC->getDecl()) == DC)
925 return SFC;
926 }
927 if (const auto *BC = dyn_cast<BlockInvocationContext>(LC)) {
928 const auto *BR = static_cast<const BlockDataRegion *>(BC->getData());
929 // FIXME: This can be made more efficient.
930 for (BlockDataRegion::referenced_vars_iterator
931 I = BR->referenced_vars_begin(),
932 E = BR->referenced_vars_end(); I != E; ++I) {
933 const TypedValueRegion *OrigR = I.getOriginalRegion();
934 if (const auto *VR = dyn_cast<VarRegion>(OrigR)) {
935 if (VR->getDecl() == VD)
936 return cast<VarRegion>(I.getCapturedRegion());
937 }
938 }
939 }
940
941 LC = LC->getParent();
942 }
943 return (const StackFrameContext *)nullptr;
944}
945
946const VarRegion *MemRegionManager::getVarRegion(const VarDecl *D,
947 const LocationContext *LC) {
948 const auto *PVD = dyn_cast<ParmVarDecl>(D);
26
Assuming 'D' is a 'ParmVarDecl'
949 if (PVD
26.1
'PVD' is non-null
26.1
'PVD' is non-null
26.1
'PVD' is non-null
) {
27
Taking true branch
950 unsigned Index = PVD->getFunctionScopeIndex();
951 const StackFrameContext *SFC = LC->getStackFrame();
28
Called C++ object pointer is null
952 const Stmt *CallSite = SFC->getCallSite();
953 if (CallSite) {
954 const Decl *D = SFC->getDecl();
955 if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
956 if (Index < FD->param_size() && FD->parameters()[Index] == PVD)
957 return getSubRegion<ParamVarRegion>(cast<Expr>(CallSite), Index,
958 getStackArgumentsRegion(SFC));
959 } else if (const auto *BD = dyn_cast<BlockDecl>(D)) {
960 if (Index < BD->param_size() && BD->parameters()[Index] == PVD)
961 return getSubRegion<ParamVarRegion>(cast<Expr>(CallSite), Index,
962 getStackArgumentsRegion(SFC));
963 } else {
964 return getSubRegion<ParamVarRegion>(cast<Expr>(CallSite), Index,
965 getStackArgumentsRegion(SFC));
966 }
967 }
968 }
969
970 D = D->getCanonicalDecl();
971 const MemRegion *sReg = nullptr;
972
973 if (D->hasGlobalStorage() && !D->isStaticLocal()) {
974
975 // First handle the globals defined in system headers.
976 if (Ctx.getSourceManager().isInSystemHeader(D->getLocation())) {
977 // Whitelist the system globals which often DO GET modified, assume the
978 // rest are immutable.
979 if (D->getName().find("errno") != StringRef::npos)
980 sReg = getGlobalsRegion(MemRegion::GlobalSystemSpaceRegionKind);
981 else
982 sReg = getGlobalsRegion(MemRegion::GlobalImmutableSpaceRegionKind);
983
984 // Treat other globals as GlobalInternal unless they are constants.
985 } else {
986 QualType GQT = D->getType();
987 const Type *GT = GQT.getTypePtrOrNull();
988 // TODO: We could walk the complex types here and see if everything is
989 // constified.
990 if (GT && GQT.isConstQualified() && GT->isArithmeticType())
991 sReg = getGlobalsRegion(MemRegion::GlobalImmutableSpaceRegionKind);
992 else
993 sReg = getGlobalsRegion();
994 }
995
996 // Finally handle static locals.
997 } else {
998 // FIXME: Once we implement scope handling, we will need to properly lookup
999 // 'D' to the proper LocationContext.
1000 const DeclContext *DC = D->getDeclContext();
1001 llvm::PointerUnion<const StackFrameContext *, const VarRegion *> V =
1002 getStackOrCaptureRegionForDeclContext(LC, DC, D);
1003
1004 if (V.is<const VarRegion*>())
1005 return V.get<const VarRegion*>();
1006
1007 const auto *STC = V.get<const StackFrameContext *>();
1008
1009 if (!STC) {
1010 // FIXME: Assign a more sensible memory space to static locals
1011 // we see from within blocks that we analyze as top-level declarations.
1012 sReg = getUnknownRegion();
1013 } else {
1014 if (D->hasLocalStorage()) {
1015 sReg = isa<ParmVarDecl>(D) || isa<ImplicitParamDecl>(D)
1016 ? static_cast<const MemRegion*>(getStackArgumentsRegion(STC))
1017 : static_cast<const MemRegion*>(getStackLocalsRegion(STC));
1018 }
1019 else {
1020 assert(D->isStaticLocal())(static_cast <bool> (D->isStaticLocal()) ? void (0) :
__assert_fail ("D->isStaticLocal()", "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1020, __extension__ __PRETTY_FUNCTION__))
;
1021 const Decl *STCD = STC->getDecl();
1022 if (isa<FunctionDecl>(STCD) || isa<ObjCMethodDecl>(STCD))
1023 sReg = getGlobalsRegion(MemRegion::StaticGlobalSpaceRegionKind,
1024 getFunctionCodeRegion(cast<NamedDecl>(STCD)));
1025 else if (const auto *BD = dyn_cast<BlockDecl>(STCD)) {
1026 // FIXME: The fallback type here is totally bogus -- though it should
1027 // never be queried, it will prevent uniquing with the real
1028 // BlockCodeRegion. Ideally we'd fix the AST so that we always had a
1029 // signature.
1030 QualType T;
1031 if (const TypeSourceInfo *TSI = BD->getSignatureAsWritten())
1032 T = TSI->getType();
1033 if (T.isNull())
1034 T = getContext().VoidTy;
1035 if (!T->getAs<FunctionType>())
1036 T = getContext().getFunctionNoProtoType(T);
1037 T = getContext().getBlockPointerType(T);
1038
1039 const BlockCodeRegion *BTR =
1040 getBlockCodeRegion(BD, Ctx.getCanonicalType(T),
1041 STC->getAnalysisDeclContext());
1042 sReg = getGlobalsRegion(MemRegion::StaticGlobalSpaceRegionKind,
1043 BTR);
1044 }
1045 else {
1046 sReg = getGlobalsRegion();
1047 }
1048 }
1049 }
1050 }
1051
1052 return getSubRegion<NonParamVarRegion>(D, sReg);
1053}
1054
1055const NonParamVarRegion *
1056MemRegionManager::getNonParamVarRegion(const VarDecl *D,
1057 const MemRegion *superR) {
1058 D = D->getCanonicalDecl();
1059 return getSubRegion<NonParamVarRegion>(D, superR);
1060}
1061
1062const ParamVarRegion *
1063MemRegionManager::getParamVarRegion(const Expr *OriginExpr, unsigned Index,
1064 const LocationContext *LC) {
1065 const StackFrameContext *SFC = LC->getStackFrame();
1066 assert(SFC)(static_cast <bool> (SFC) ? void (0) : __assert_fail ("SFC"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1066, __extension__ __PRETTY_FUNCTION__))
;
1067 return getSubRegion<ParamVarRegion>(OriginExpr, Index,
1068 getStackArgumentsRegion(SFC));
1069}
1070
1071const BlockDataRegion *
1072MemRegionManager::getBlockDataRegion(const BlockCodeRegion *BC,
1073 const LocationContext *LC,
1074 unsigned blockCount) {
1075 const MemSpaceRegion *sReg = nullptr;
1076 const BlockDecl *BD = BC->getDecl();
1077 if (!BD->hasCaptures()) {
1078 // This handles 'static' blocks.
1079 sReg = getGlobalsRegion(MemRegion::GlobalImmutableSpaceRegionKind);
1080 }
1081 else {
1082 if (LC) {
1083 // FIXME: Once we implement scope handling, we want the parent region
1084 // to be the scope.
1085 const StackFrameContext *STC = LC->getStackFrame();
1086 assert(STC)(static_cast <bool> (STC) ? void (0) : __assert_fail ("STC"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1086, __extension__ __PRETTY_FUNCTION__))
;
1087 sReg = getStackLocalsRegion(STC);
1088 }
1089 else {
1090 // We allow 'LC' to be NULL for cases where want BlockDataRegions
1091 // without context-sensitivity.
1092 sReg = getUnknownRegion();
1093 }
1094 }
1095
1096 return getSubRegion<BlockDataRegion>(BC, LC, blockCount, sReg);
1097}
1098
1099const CXXTempObjectRegion *
1100MemRegionManager::getCXXStaticTempObjectRegion(const Expr *Ex) {
1101 return getSubRegion<CXXTempObjectRegion>(
1102 Ex, getGlobalsRegion(MemRegion::GlobalInternalSpaceRegionKind, nullptr));
1103}
1104
1105const CompoundLiteralRegion*
1106MemRegionManager::getCompoundLiteralRegion(const CompoundLiteralExpr *CL,
1107 const LocationContext *LC) {
1108 const MemSpaceRegion *sReg = nullptr;
1109
1110 if (CL->isFileScope())
1111 sReg = getGlobalsRegion();
1112 else {
1113 const StackFrameContext *STC = LC->getStackFrame();
1114 assert(STC)(static_cast <bool> (STC) ? void (0) : __assert_fail ("STC"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1114, __extension__ __PRETTY_FUNCTION__))
;
1115 sReg = getStackLocalsRegion(STC);
1116 }
1117
1118 return getSubRegion<CompoundLiteralRegion>(CL, sReg);
1119}
1120
1121const ElementRegion*
1122MemRegionManager::getElementRegion(QualType elementType, NonLoc Idx,
1123 const SubRegion* superRegion,
1124 ASTContext &Ctx){
1125 QualType T = Ctx.getCanonicalType(elementType).getUnqualifiedType();
1126
1127 llvm::FoldingSetNodeID ID;
1128 ElementRegion::ProfileRegion(ID, T, Idx, superRegion);
1129
1130 void *InsertPos;
1131 MemRegion* data = Regions.FindNodeOrInsertPos(ID, InsertPos);
1132 auto *R = cast_or_null<ElementRegion>(data);
1133
1134 if (!R) {
1135 R = A.Allocate<ElementRegion>();
1136 new (R) ElementRegion(T, Idx, superRegion);
1137 Regions.InsertNode(R, InsertPos);
1138 }
1139
1140 return R;
1141}
1142
1143const FunctionCodeRegion *
1144MemRegionManager::getFunctionCodeRegion(const NamedDecl *FD) {
1145 // To think: should we canonicalize the declaration here?
1146 return getSubRegion<FunctionCodeRegion>(FD, getCodeRegion());
1147}
1148
1149const BlockCodeRegion *
1150MemRegionManager::getBlockCodeRegion(const BlockDecl *BD, CanQualType locTy,
1151 AnalysisDeclContext *AC) {
1152 return getSubRegion<BlockCodeRegion>(BD, locTy, AC, getCodeRegion());
1153}
1154
1155/// getSymbolicRegion - Retrieve or create a "symbolic" memory region.
1156const SymbolicRegion *MemRegionManager::getSymbolicRegion(SymbolRef sym) {
1157 return getSubRegion<SymbolicRegion>(sym, getUnknownRegion());
1158}
1159
1160const SymbolicRegion *MemRegionManager::getSymbolicHeapRegion(SymbolRef Sym) {
1161 return getSubRegion<SymbolicRegion>(Sym, getHeapRegion());
1162}
1163
1164const FieldRegion*
1165MemRegionManager::getFieldRegion(const FieldDecl *d,
1166 const SubRegion* superRegion){
1167 return getSubRegion<FieldRegion>(d, superRegion);
1168}
1169
1170const ObjCIvarRegion*
1171MemRegionManager::getObjCIvarRegion(const ObjCIvarDecl *d,
1172 const SubRegion* superRegion) {
1173 return getSubRegion<ObjCIvarRegion>(d, superRegion);
1174}
1175
1176const CXXTempObjectRegion*
1177MemRegionManager::getCXXTempObjectRegion(Expr const *E,
1178 LocationContext const *LC) {
1179 const StackFrameContext *SFC = LC->getStackFrame();
1180 assert(SFC)(static_cast <bool> (SFC) ? void (0) : __assert_fail ("SFC"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1180, __extension__ __PRETTY_FUNCTION__))
;
1181 return getSubRegion<CXXTempObjectRegion>(E, getStackLocalsRegion(SFC));
1182}
1183
1184/// Checks whether \p BaseClass is a valid virtual or direct non-virtual base
1185/// class of the type of \p Super.
1186static bool isValidBaseClass(const CXXRecordDecl *BaseClass,
1187 const TypedValueRegion *Super,
1188 bool IsVirtual) {
1189 BaseClass = BaseClass->getCanonicalDecl();
1190
1191 const CXXRecordDecl *Class = Super->getValueType()->getAsCXXRecordDecl();
1192 if (!Class)
1193 return true;
1194
1195 if (IsVirtual)
1196 return Class->isVirtuallyDerivedFrom(BaseClass);
1197
1198 for (const auto &I : Class->bases()) {
1199 if (I.getType()->getAsCXXRecordDecl()->getCanonicalDecl() == BaseClass)
1200 return true;
1201 }
1202
1203 return false;
1204}
1205
1206const CXXBaseObjectRegion *
1207MemRegionManager::getCXXBaseObjectRegion(const CXXRecordDecl *RD,
1208 const SubRegion *Super,
1209 bool IsVirtual) {
1210 if (isa<TypedValueRegion>(Super)) {
1211 assert(isValidBaseClass(RD, cast<TypedValueRegion>(Super), IsVirtual))(static_cast <bool> (isValidBaseClass(RD, cast<TypedValueRegion
>(Super), IsVirtual)) ? void (0) : __assert_fail ("isValidBaseClass(RD, cast<TypedValueRegion>(Super), IsVirtual)"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1211, __extension__ __PRETTY_FUNCTION__))
;
1212 (void)&isValidBaseClass;
1213
1214 if (IsVirtual) {
1215 // Virtual base regions should not be layered, since the layout rules
1216 // are different.
1217 while (const auto *Base = dyn_cast<CXXBaseObjectRegion>(Super))
1218 Super = cast<SubRegion>(Base->getSuperRegion());
1219 assert(Super && !isa<MemSpaceRegion>(Super))(static_cast <bool> (Super && !isa<MemSpaceRegion
>(Super)) ? void (0) : __assert_fail ("Super && !isa<MemSpaceRegion>(Super)"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1219, __extension__ __PRETTY_FUNCTION__))
;
1220 }
1221 }
1222
1223 return getSubRegion<CXXBaseObjectRegion>(RD, IsVirtual, Super);
1224}
1225
1226const CXXDerivedObjectRegion *
1227MemRegionManager::getCXXDerivedObjectRegion(const CXXRecordDecl *RD,
1228 const SubRegion *Super) {
1229 return getSubRegion<CXXDerivedObjectRegion>(RD, Super);
1230}
1231
1232const CXXThisRegion*
1233MemRegionManager::getCXXThisRegion(QualType thisPointerTy,
1234 const LocationContext *LC) {
1235 const auto *PT = thisPointerTy->getAs<PointerType>();
1236 assert(PT)(static_cast <bool> (PT) ? void (0) : __assert_fail ("PT"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1236, __extension__ __PRETTY_FUNCTION__))
;
1237 // Inside the body of the operator() of a lambda a this expr might refer to an
1238 // object in one of the parent location contexts.
1239 const auto *D = dyn_cast<CXXMethodDecl>(LC->getDecl());
1240 // FIXME: when operator() of lambda is analyzed as a top level function and
1241 // 'this' refers to a this to the enclosing scope, there is no right region to
1242 // return.
1243 while (!LC->inTopFrame() && (!D || D->isStatic() ||
1244 PT != D->getThisType()->getAs<PointerType>())) {
1245 LC = LC->getParent();
1246 D = dyn_cast<CXXMethodDecl>(LC->getDecl());
1247 }
1248 const StackFrameContext *STC = LC->getStackFrame();
1249 assert(STC)(static_cast <bool> (STC) ? void (0) : __assert_fail ("STC"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1249, __extension__ __PRETTY_FUNCTION__))
;
1250 return getSubRegion<CXXThisRegion>(PT, getStackArgumentsRegion(STC));
1251}
1252
1253const AllocaRegion*
1254MemRegionManager::getAllocaRegion(const Expr *E, unsigned cnt,
1255 const LocationContext *LC) {
1256 const StackFrameContext *STC = LC->getStackFrame();
1257 assert(STC)(static_cast <bool> (STC) ? void (0) : __assert_fail ("STC"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1257, __extension__ __PRETTY_FUNCTION__))
;
1258 return getSubRegion<AllocaRegion>(E, cnt, getStackLocalsRegion(STC));
1259}
1260
1261const MemSpaceRegion *MemRegion::getMemorySpace() const {
1262 const MemRegion *R = this;
1263 const auto *SR = dyn_cast<SubRegion>(this);
1264
1265 while (SR) {
1266 R = SR->getSuperRegion();
1267 SR = dyn_cast<SubRegion>(R);
1268 }
1269
1270 return dyn_cast<MemSpaceRegion>(R);
1271}
1272
1273bool MemRegion::hasStackStorage() const {
1274 return isa<StackSpaceRegion>(getMemorySpace());
1275}
1276
1277bool MemRegion::hasStackNonParametersStorage() const {
1278 return isa<StackLocalsSpaceRegion>(getMemorySpace());
1279}
1280
1281bool MemRegion::hasStackParametersStorage() const {
1282 return isa<StackArgumentsSpaceRegion>(getMemorySpace());
1283}
1284
1285bool MemRegion::hasGlobalsOrParametersStorage() const {
1286 const MemSpaceRegion *MS = getMemorySpace();
1287 return isa<StackArgumentsSpaceRegion>(MS) ||
1288 isa<GlobalsSpaceRegion>(MS);
1289}
1290
1291// getBaseRegion strips away all elements and fields, and get the base region
1292// of them.
1293const MemRegion *MemRegion::getBaseRegion() const {
1294 const MemRegion *R = this;
1295 while (true) {
1296 switch (R->getKind()) {
1297 case MemRegion::ElementRegionKind:
1298 case MemRegion::FieldRegionKind:
1299 case MemRegion::ObjCIvarRegionKind:
1300 case MemRegion::CXXBaseObjectRegionKind:
1301 case MemRegion::CXXDerivedObjectRegionKind:
1302 R = cast<SubRegion>(R)->getSuperRegion();
1303 continue;
1304 default:
1305 break;
1306 }
1307 break;
1308 }
1309 return R;
1310}
1311
1312// getgetMostDerivedObjectRegion gets the region of the root class of a C++
1313// class hierarchy.
1314const MemRegion *MemRegion::getMostDerivedObjectRegion() const {
1315 const MemRegion *R = this;
1316 while (const auto *BR = dyn_cast<CXXBaseObjectRegion>(R))
1317 R = BR->getSuperRegion();
1318 return R;
1319}
1320
1321bool MemRegion::isSubRegionOf(const MemRegion *) const {
1322 return false;
1323}
1324
1325//===----------------------------------------------------------------------===//
1326// View handling.
1327//===----------------------------------------------------------------------===//
1328
1329const MemRegion *MemRegion::StripCasts(bool StripBaseAndDerivedCasts) const {
1330 const MemRegion *R = this;
1331 while (true) {
1332 switch (R->getKind()) {
1333 case ElementRegionKind: {
1334 const auto *ER = cast<ElementRegion>(R);
1335 if (!ER->getIndex().isZeroConstant())
1336 return R;
1337 R = ER->getSuperRegion();
1338 break;
1339 }
1340 case CXXBaseObjectRegionKind:
1341 case CXXDerivedObjectRegionKind:
1342 if (!StripBaseAndDerivedCasts)
1343 return R;
1344 R = cast<TypedValueRegion>(R)->getSuperRegion();
1345 break;
1346 default:
1347 return R;
1348 }
1349 }
1350}
1351
1352const SymbolicRegion *MemRegion::getSymbolicBase() const {
1353 const auto *SubR = dyn_cast<SubRegion>(this);
1354
1355 while (SubR) {
1356 if (const auto *SymR = dyn_cast<SymbolicRegion>(SubR))
1357 return SymR;
1358 SubR = dyn_cast<SubRegion>(SubR->getSuperRegion());
1359 }
1360 return nullptr;
1361}
1362
1363RegionRawOffset ElementRegion::getAsArrayOffset() const {
1364 int64_t offset = 0;
1365 const ElementRegion *ER = this;
1366 const MemRegion *superR = nullptr;
1367 ASTContext &C = getContext();
1368
1369 // FIXME: Handle multi-dimensional arrays.
1370
1371 while (ER) {
1372 superR = ER->getSuperRegion();
1373
1374 // FIXME: generalize to symbolic offsets.
1375 SVal index = ER->getIndex();
1376 if (auto CI = index.getAs<nonloc::ConcreteInt>()) {
1377 // Update the offset.
1378 int64_t i = CI->getValue().getSExtValue();
1379
1380 if (i != 0) {
1381 QualType elemType = ER->getElementType();
1382
1383 // If we are pointing to an incomplete type, go no further.
1384 if (elemType->isIncompleteType()) {
1385 superR = ER;
1386 break;
1387 }
1388
1389 int64_t size = C.getTypeSizeInChars(elemType).getQuantity();
1390 if (auto NewOffset = llvm::checkedMulAdd(i, size, offset)) {
1391 offset = *NewOffset;
1392 } else {
1393 LLVM_DEBUG(llvm::dbgs() << "MemRegion::getAsArrayOffset: "do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("MemRegion")) { llvm::dbgs() << "MemRegion::getAsArrayOffset: "
<< "offset overflowing, returning unknown\n"; } } while
(false)
1394 << "offset overflowing, returning unknown\n")do { if (::llvm::DebugFlag && ::llvm::isCurrentDebugType
("MemRegion")) { llvm::dbgs() << "MemRegion::getAsArrayOffset: "
<< "offset overflowing, returning unknown\n"; } } while
(false)
;
1395
1396 return nullptr;
1397 }
1398 }
1399
1400 // Go to the next ElementRegion (if any).
1401 ER = dyn_cast<ElementRegion>(superR);
1402 continue;
1403 }
1404
1405 return nullptr;
1406 }
1407
1408 assert(superR && "super region cannot be NULL")(static_cast <bool> (superR && "super region cannot be NULL"
) ? void (0) : __assert_fail ("superR && \"super region cannot be NULL\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1408, __extension__ __PRETTY_FUNCTION__))
;
1409 return RegionRawOffset(superR, CharUnits::fromQuantity(offset));
1410}
1411
1412/// Returns true if \p Base is an immediate base class of \p Child
1413static bool isImmediateBase(const CXXRecordDecl *Child,
1414 const CXXRecordDecl *Base) {
1415 assert(Child && "Child must not be null")(static_cast <bool> (Child && "Child must not be null"
) ? void (0) : __assert_fail ("Child && \"Child must not be null\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1415, __extension__ __PRETTY_FUNCTION__))
;
1416 // Note that we do NOT canonicalize the base class here, because
1417 // ASTRecordLayout doesn't either. If that leads us down the wrong path,
1418 // so be it; at least we won't crash.
1419 for (const auto &I : Child->bases()) {
1420 if (I.getType()->getAsCXXRecordDecl() == Base)
1421 return true;
1422 }
1423
1424 return false;
1425}
1426
1427static RegionOffset calculateOffset(const MemRegion *R) {
1428 const MemRegion *SymbolicOffsetBase = nullptr;
1429 int64_t Offset = 0;
1430
1431 while (true) {
1432 switch (R->getKind()) {
1433 case MemRegion::CodeSpaceRegionKind:
1434 case MemRegion::StackLocalsSpaceRegionKind:
1435 case MemRegion::StackArgumentsSpaceRegionKind:
1436 case MemRegion::HeapSpaceRegionKind:
1437 case MemRegion::UnknownSpaceRegionKind:
1438 case MemRegion::StaticGlobalSpaceRegionKind:
1439 case MemRegion::GlobalInternalSpaceRegionKind:
1440 case MemRegion::GlobalSystemSpaceRegionKind:
1441 case MemRegion::GlobalImmutableSpaceRegionKind:
1442 // Stores can bind directly to a region space to set a default value.
1443 assert(Offset == 0 && !SymbolicOffsetBase)(static_cast <bool> (Offset == 0 && !SymbolicOffsetBase
) ? void (0) : __assert_fail ("Offset == 0 && !SymbolicOffsetBase"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1443, __extension__ __PRETTY_FUNCTION__))
;
1444 goto Finish;
1445
1446 case MemRegion::FunctionCodeRegionKind:
1447 case MemRegion::BlockCodeRegionKind:
1448 case MemRegion::BlockDataRegionKind:
1449 // These will never have bindings, but may end up having values requested
1450 // if the user does some strange casting.
1451 if (Offset != 0)
1452 SymbolicOffsetBase = R;
1453 goto Finish;
1454
1455 case MemRegion::SymbolicRegionKind:
1456 case MemRegion::AllocaRegionKind:
1457 case MemRegion::CompoundLiteralRegionKind:
1458 case MemRegion::CXXThisRegionKind:
1459 case MemRegion::StringRegionKind:
1460 case MemRegion::ObjCStringRegionKind:
1461 case MemRegion::NonParamVarRegionKind:
1462 case MemRegion::ParamVarRegionKind:
1463 case MemRegion::CXXTempObjectRegionKind:
1464 // Usual base regions.
1465 goto Finish;
1466
1467 case MemRegion::ObjCIvarRegionKind:
1468 // This is a little strange, but it's a compromise between
1469 // ObjCIvarRegions having unknown compile-time offsets (when using the
1470 // non-fragile runtime) and yet still being distinct, non-overlapping
1471 // regions. Thus we treat them as "like" base regions for the purposes
1472 // of computing offsets.
1473 goto Finish;
1474
1475 case MemRegion::CXXBaseObjectRegionKind: {
1476 const auto *BOR = cast<CXXBaseObjectRegion>(R);
1477 R = BOR->getSuperRegion();
1478
1479 QualType Ty;
1480 bool RootIsSymbolic = false;
1481 if (const auto *TVR = dyn_cast<TypedValueRegion>(R)) {
1482 Ty = TVR->getDesugaredValueType(R->getContext());
1483 } else if (const auto *SR = dyn_cast<SymbolicRegion>(R)) {
1484 // If our base region is symbolic, we don't know what type it really is.
1485 // Pretend the type of the symbol is the true dynamic type.
1486 // (This will at least be self-consistent for the life of the symbol.)
1487 Ty = SR->getSymbol()->getType()->getPointeeType();
1488 RootIsSymbolic = true;
1489 }
1490
1491 const CXXRecordDecl *Child = Ty->getAsCXXRecordDecl();
1492 if (!Child) {
1493 // We cannot compute the offset of the base class.
1494 SymbolicOffsetBase = R;
1495 } else {
1496 if (RootIsSymbolic) {
1497 // Base layers on symbolic regions may not be type-correct.
1498 // Double-check the inheritance here, and revert to a symbolic offset
1499 // if it's invalid (e.g. due to a reinterpret_cast).
1500 if (BOR->isVirtual()) {
1501 if (!Child->isVirtuallyDerivedFrom(BOR->getDecl()))
1502 SymbolicOffsetBase = R;
1503 } else {
1504 if (!isImmediateBase(Child, BOR->getDecl()))
1505 SymbolicOffsetBase = R;
1506 }
1507 }
1508 }
1509
1510 // Don't bother calculating precise offsets if we already have a
1511 // symbolic offset somewhere in the chain.
1512 if (SymbolicOffsetBase)
1513 continue;
1514
1515 CharUnits BaseOffset;
1516 const ASTRecordLayout &Layout = R->getContext().getASTRecordLayout(Child);
1517 if (BOR->isVirtual())
1518 BaseOffset = Layout.getVBaseClassOffset(BOR->getDecl());
1519 else
1520 BaseOffset = Layout.getBaseClassOffset(BOR->getDecl());
1521
1522 // The base offset is in chars, not in bits.
1523 Offset += BaseOffset.getQuantity() * R->getContext().getCharWidth();
1524 break;
1525 }
1526
1527 case MemRegion::CXXDerivedObjectRegionKind: {
1528 // TODO: Store the base type in the CXXDerivedObjectRegion and use it.
1529 goto Finish;
1530 }
1531
1532 case MemRegion::ElementRegionKind: {
1533 const auto *ER = cast<ElementRegion>(R);
1534 R = ER->getSuperRegion();
1535
1536 QualType EleTy = ER->getValueType();
1537 if (EleTy->isIncompleteType()) {
1538 // We cannot compute the offset of the base class.
1539 SymbolicOffsetBase = R;
1540 continue;
1541 }
1542
1543 SVal Index = ER->getIndex();
1544 if (Optional<nonloc::ConcreteInt> CI =
1545 Index.getAs<nonloc::ConcreteInt>()) {
1546 // Don't bother calculating precise offsets if we already have a
1547 // symbolic offset somewhere in the chain.
1548 if (SymbolicOffsetBase)
1549 continue;
1550
1551 int64_t i = CI->getValue().getSExtValue();
1552 // This type size is in bits.
1553 Offset += i * R->getContext().getTypeSize(EleTy);
1554 } else {
1555 // We cannot compute offset for non-concrete index.
1556 SymbolicOffsetBase = R;
1557 }
1558 break;
1559 }
1560 case MemRegion::FieldRegionKind: {
1561 const auto *FR = cast<FieldRegion>(R);
1562 R = FR->getSuperRegion();
1563 assert(R)(static_cast <bool> (R) ? void (0) : __assert_fail ("R"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1563, __extension__ __PRETTY_FUNCTION__))
;
1564
1565 const RecordDecl *RD = FR->getDecl()->getParent();
1566 if (RD->isUnion() || !RD->isCompleteDefinition()) {
1567 // We cannot compute offset for incomplete type.
1568 // For unions, we could treat everything as offset 0, but we'd rather
1569 // treat each field as a symbolic offset so they aren't stored on top
1570 // of each other, since we depend on things in typed regions actually
1571 // matching their types.
1572 SymbolicOffsetBase = R;
1573 }
1574
1575 // Don't bother calculating precise offsets if we already have a
1576 // symbolic offset somewhere in the chain.
1577 if (SymbolicOffsetBase)
1578 continue;
1579
1580 // Get the field number.
1581 unsigned idx = 0;
1582 for (RecordDecl::field_iterator FI = RD->field_begin(),
1583 FE = RD->field_end(); FI != FE; ++FI, ++idx) {
1584 if (FR->getDecl() == *FI)
1585 break;
1586 }
1587 const ASTRecordLayout &Layout = R->getContext().getASTRecordLayout(RD);
1588 // This is offset in bits.
1589 Offset += Layout.getFieldOffset(idx);
1590 break;
1591 }
1592 }
1593 }
1594
1595 Finish:
1596 if (SymbolicOffsetBase)
1597 return RegionOffset(SymbolicOffsetBase, RegionOffset::Symbolic);
1598 return RegionOffset(R, Offset);
1599}
1600
1601RegionOffset MemRegion::getAsOffset() const {
1602 if (!cachedOffset)
1603 cachedOffset = calculateOffset(this);
1604 return *cachedOffset;
1605}
1606
1607//===----------------------------------------------------------------------===//
1608// BlockDataRegion
1609//===----------------------------------------------------------------------===//
1610
1611std::pair<const VarRegion *, const VarRegion *>
1612BlockDataRegion::getCaptureRegions(const VarDecl *VD) {
1613 MemRegionManager &MemMgr = getMemRegionManager();
9
Value assigned to field 'LC'
1614 const VarRegion *VR = nullptr;
1615 const VarRegion *OriginalVR = nullptr;
1616
1617 if (!VD->hasAttr<BlocksAttr>() && VD->hasLocalStorage()) {
10
Calling 'Decl::hasAttr'
13
Returning from 'Decl::hasAttr'
14
Calling 'VarDecl::hasLocalStorage'
20
Returning from 'VarDecl::hasLocalStorage'
21
Taking false branch
1618 VR = MemMgr.getNonParamVarRegion(VD, this);
1619 OriginalVR = MemMgr.getVarRegion(VD, LC);
1620 }
1621 else {
1622 if (LC) {
22
Assuming field 'LC' is null
23
Taking false branch
1623 VR = MemMgr.getVarRegion(VD, LC);
1624 OriginalVR = VR;
1625 }
1626 else {
1627 VR = MemMgr.getNonParamVarRegion(VD, MemMgr.getUnknownRegion());
1628 OriginalVR = MemMgr.getVarRegion(VD, LC);
24
Passing null pointer value via 2nd parameter 'LC'
25
Calling 'MemRegionManager::getVarRegion'
1629 }
1630 }
1631 return std::make_pair(VR, OriginalVR);
1632}
1633
1634void BlockDataRegion::LazyInitializeReferencedVars() {
1635 if (ReferencedVars)
3
Assuming field 'ReferencedVars' is null
4
Taking false branch
1636 return;
1637
1638 AnalysisDeclContext *AC = getCodeRegion()->getAnalysisDeclContext();
1639 const auto &ReferencedBlockVars = AC->getReferencedBlockVars(BC->getDecl());
1640 auto NumBlockVars =
1641 std::distance(ReferencedBlockVars.begin(), ReferencedBlockVars.end());
1642
1643 if (NumBlockVars == 0) {
5
Assuming 'NumBlockVars' is not equal to 0
6
Taking false branch
1644 ReferencedVars = (void*) 0x1;
1645 return;
1646 }
1647
1648 MemRegionManager &MemMgr = getMemRegionManager();
1649 llvm::BumpPtrAllocator &A = MemMgr.getAllocator();
1650 BumpVectorContext BC(A);
1651
1652 using VarVec = BumpVector<const MemRegion *>;
1653
1654 auto *BV = A.Allocate<VarVec>();
1655 new (BV) VarVec(BC, NumBlockVars);
1656 auto *BVOriginal = A.Allocate<VarVec>();
1657 new (BVOriginal) VarVec(BC, NumBlockVars);
1658
1659 for (const auto *VD : ReferencedBlockVars) {
7
Assuming '__begin1' is not equal to '__end1'
1660 const VarRegion *VR = nullptr;
1661 const VarRegion *OriginalVR = nullptr;
1662 std::tie(VR, OriginalVR) = getCaptureRegions(VD);
8
Calling 'BlockDataRegion::getCaptureRegions'
1663 assert(VR)(static_cast <bool> (VR) ? void (0) : __assert_fail ("VR"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1663, __extension__ __PRETTY_FUNCTION__))
;
1664 assert(OriginalVR)(static_cast <bool> (OriginalVR) ? void (0) : __assert_fail
("OriginalVR", "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1664, __extension__ __PRETTY_FUNCTION__))
;
1665 BV->push_back(VR, BC);
1666 BVOriginal->push_back(OriginalVR, BC);
1667 }
1668
1669 ReferencedVars = BV;
1670 OriginalVars = BVOriginal;
1671}
1672
1673BlockDataRegion::referenced_vars_iterator
1674BlockDataRegion::referenced_vars_begin() const {
1675 const_cast<BlockDataRegion*>(this)->LazyInitializeReferencedVars();
2
Calling 'BlockDataRegion::LazyInitializeReferencedVars'
1676
1677 auto *Vec = static_cast<BumpVector<const MemRegion *> *>(ReferencedVars);
1678
1679 if (Vec == (void*) 0x1)
1680 return BlockDataRegion::referenced_vars_iterator(nullptr, nullptr);
1681
1682 auto *VecOriginal =
1683 static_cast<BumpVector<const MemRegion *> *>(OriginalVars);
1684
1685 return BlockDataRegion::referenced_vars_iterator(Vec->begin(),
1686 VecOriginal->begin());
1687}
1688
1689BlockDataRegion::referenced_vars_iterator
1690BlockDataRegion::referenced_vars_end() const {
1691 const_cast<BlockDataRegion*>(this)->LazyInitializeReferencedVars();
1692
1693 auto *Vec = static_cast<BumpVector<const MemRegion *> *>(ReferencedVars);
1694
1695 if (Vec == (void*) 0x1)
1696 return BlockDataRegion::referenced_vars_iterator(nullptr, nullptr);
1697
1698 auto *VecOriginal =
1699 static_cast<BumpVector<const MemRegion *> *>(OriginalVars);
1700
1701 return BlockDataRegion::referenced_vars_iterator(Vec->end(),
1702 VecOriginal->end());
1703}
1704
1705const VarRegion *BlockDataRegion::getOriginalRegion(const VarRegion *R) const {
1706 for (referenced_vars_iterator I = referenced_vars_begin(),
1
Calling 'BlockDataRegion::referenced_vars_begin'
1707 E = referenced_vars_end();
1708 I != E; ++I) {
1709 if (I.getCapturedRegion() == R)
1710 return I.getOriginalRegion();
1711 }
1712 return nullptr;
1713}
1714
1715//===----------------------------------------------------------------------===//
1716// RegionAndSymbolInvalidationTraits
1717//===----------------------------------------------------------------------===//
1718
1719void RegionAndSymbolInvalidationTraits::setTrait(SymbolRef Sym,
1720 InvalidationKinds IK) {
1721 SymTraitsMap[Sym] |= IK;
1722}
1723
1724void RegionAndSymbolInvalidationTraits::setTrait(const MemRegion *MR,
1725 InvalidationKinds IK) {
1726 assert(MR)(static_cast <bool> (MR) ? void (0) : __assert_fail ("MR"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/lib/StaticAnalyzer/Core/MemRegion.cpp"
, 1726, __extension__ __PRETTY_FUNCTION__))
;
1727 if (const auto *SR = dyn_cast<SymbolicRegion>(MR))
1728 setTrait(SR->getSymbol(), IK);
1729 else
1730 MRTraitsMap[MR] |= IK;
1731}
1732
1733bool RegionAndSymbolInvalidationTraits::hasTrait(SymbolRef Sym,
1734 InvalidationKinds IK) const {
1735 const_symbol_iterator I = SymTraitsMap.find(Sym);
1736 if (I != SymTraitsMap.end())
1737 return I->second & IK;
1738
1739 return false;
1740}
1741
1742bool RegionAndSymbolInvalidationTraits::hasTrait(const MemRegion *MR,
1743 InvalidationKinds IK) const {
1744 if (!MR)
1745 return false;
1746
1747 if (const auto *SR = dyn_cast<SymbolicRegion>(MR))
1748 return hasTrait(SR->getSymbol(), IK);
1749
1750 const_region_iterator I = MRTraitsMap.find(MR);
1751 if (I != MRTraitsMap.end())
1752 return I->second & IK;
1753
1754 return false;
1755}

/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h

1//===- DeclBase.h - Base Classes for representing declarations --*- 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 the Decl and DeclContext interfaces.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_CLANG_AST_DECLBASE_H
14#define LLVM_CLANG_AST_DECLBASE_H
15
16#include "clang/AST/ASTDumperUtils.h"
17#include "clang/AST/AttrIterator.h"
18#include "clang/AST/DeclarationName.h"
19#include "clang/Basic/IdentifierTable.h"
20#include "clang/Basic/LLVM.h"
21#include "clang/Basic/SourceLocation.h"
22#include "clang/Basic/Specifiers.h"
23#include "llvm/ADT/ArrayRef.h"
24#include "llvm/ADT/PointerIntPair.h"
25#include "llvm/ADT/PointerUnion.h"
26#include "llvm/ADT/iterator.h"
27#include "llvm/ADT/iterator_range.h"
28#include "llvm/Support/Casting.h"
29#include "llvm/Support/Compiler.h"
30#include "llvm/Support/PrettyStackTrace.h"
31#include "llvm/Support/VersionTuple.h"
32#include <algorithm>
33#include <cassert>
34#include <cstddef>
35#include <iterator>
36#include <string>
37#include <type_traits>
38#include <utility>
39
40namespace clang {
41
42class ASTContext;
43class ASTMutationListener;
44class Attr;
45class BlockDecl;
46class DeclContext;
47class ExternalSourceSymbolAttr;
48class FunctionDecl;
49class FunctionType;
50class IdentifierInfo;
51enum Linkage : unsigned char;
52class LinkageSpecDecl;
53class Module;
54class NamedDecl;
55class ObjCCategoryDecl;
56class ObjCCategoryImplDecl;
57class ObjCContainerDecl;
58class ObjCImplDecl;
59class ObjCImplementationDecl;
60class ObjCInterfaceDecl;
61class ObjCMethodDecl;
62class ObjCProtocolDecl;
63struct PrintingPolicy;
64class RecordDecl;
65class SourceManager;
66class Stmt;
67class StoredDeclsMap;
68class TemplateDecl;
69class TemplateParameterList;
70class TranslationUnitDecl;
71class UsingDirectiveDecl;
72
73/// Captures the result of checking the availability of a
74/// declaration.
75enum AvailabilityResult {
76 AR_Available = 0,
77 AR_NotYetIntroduced,
78 AR_Deprecated,
79 AR_Unavailable
80};
81
82/// Decl - This represents one declaration (or definition), e.g. a variable,
83/// typedef, function, struct, etc.
84///
85/// Note: There are objects tacked on before the *beginning* of Decl
86/// (and its subclasses) in its Decl::operator new(). Proper alignment
87/// of all subclasses (not requiring more than the alignment of Decl) is
88/// asserted in DeclBase.cpp.
89class alignas(8) Decl {
90public:
91 /// Lists the kind of concrete classes of Decl.
92 enum Kind {
93#define DECL(DERIVED, BASE) DERIVED,
94#define ABSTRACT_DECL(DECL)
95#define DECL_RANGE(BASE, START, END) \
96 first##BASE = START, last##BASE = END,
97#define LAST_DECL_RANGE(BASE, START, END) \
98 first##BASE = START, last##BASE = END
99#include "clang/AST/DeclNodes.inc"
100 };
101
102 /// A placeholder type used to construct an empty shell of a
103 /// decl-derived type that will be filled in later (e.g., by some
104 /// deserialization method).
105 struct EmptyShell {};
106
107 /// IdentifierNamespace - The different namespaces in which
108 /// declarations may appear. According to C99 6.2.3, there are
109 /// four namespaces, labels, tags, members and ordinary
110 /// identifiers. C++ describes lookup completely differently:
111 /// certain lookups merely "ignore" certain kinds of declarations,
112 /// usually based on whether the declaration is of a type, etc.
113 ///
114 /// These are meant as bitmasks, so that searches in
115 /// C++ can look into the "tag" namespace during ordinary lookup.
116 ///
117 /// Decl currently provides 15 bits of IDNS bits.
118 enum IdentifierNamespace {
119 /// Labels, declared with 'x:' and referenced with 'goto x'.
120 IDNS_Label = 0x0001,
121
122 /// Tags, declared with 'struct foo;' and referenced with
123 /// 'struct foo'. All tags are also types. This is what
124 /// elaborated-type-specifiers look for in C.
125 /// This also contains names that conflict with tags in the
126 /// same scope but that are otherwise ordinary names (non-type
127 /// template parameters and indirect field declarations).
128 IDNS_Tag = 0x0002,
129
130 /// Types, declared with 'struct foo', typedefs, etc.
131 /// This is what elaborated-type-specifiers look for in C++,
132 /// but note that it's ill-formed to find a non-tag.
133 IDNS_Type = 0x0004,
134
135 /// Members, declared with object declarations within tag
136 /// definitions. In C, these can only be found by "qualified"
137 /// lookup in member expressions. In C++, they're found by
138 /// normal lookup.
139 IDNS_Member = 0x0008,
140
141 /// Namespaces, declared with 'namespace foo {}'.
142 /// Lookup for nested-name-specifiers find these.
143 IDNS_Namespace = 0x0010,
144
145 /// Ordinary names. In C, everything that's not a label, tag,
146 /// member, or function-local extern ends up here.
147 IDNS_Ordinary = 0x0020,
148
149 /// Objective C \@protocol.
150 IDNS_ObjCProtocol = 0x0040,
151
152 /// This declaration is a friend function. A friend function
153 /// declaration is always in this namespace but may also be in
154 /// IDNS_Ordinary if it was previously declared.
155 IDNS_OrdinaryFriend = 0x0080,
156
157 /// This declaration is a friend class. A friend class
158 /// declaration is always in this namespace but may also be in
159 /// IDNS_Tag|IDNS_Type if it was previously declared.
160 IDNS_TagFriend = 0x0100,
161
162 /// This declaration is a using declaration. A using declaration
163 /// *introduces* a number of other declarations into the current
164 /// scope, and those declarations use the IDNS of their targets,
165 /// but the actual using declarations go in this namespace.
166 IDNS_Using = 0x0200,
167
168 /// This declaration is a C++ operator declared in a non-class
169 /// context. All such operators are also in IDNS_Ordinary.
170 /// C++ lexical operator lookup looks for these.
171 IDNS_NonMemberOperator = 0x0400,
172
173 /// This declaration is a function-local extern declaration of a
174 /// variable or function. This may also be IDNS_Ordinary if it
175 /// has been declared outside any function. These act mostly like
176 /// invisible friend declarations, but are also visible to unqualified
177 /// lookup within the scope of the declaring function.
178 IDNS_LocalExtern = 0x0800,
179
180 /// This declaration is an OpenMP user defined reduction construction.
181 IDNS_OMPReduction = 0x1000,
182
183 /// This declaration is an OpenMP user defined mapper.
184 IDNS_OMPMapper = 0x2000,
185 };
186
187 /// ObjCDeclQualifier - 'Qualifiers' written next to the return and
188 /// parameter types in method declarations. Other than remembering
189 /// them and mangling them into the method's signature string, these
190 /// are ignored by the compiler; they are consumed by certain
191 /// remote-messaging frameworks.
192 ///
193 /// in, inout, and out are mutually exclusive and apply only to
194 /// method parameters. bycopy and byref are mutually exclusive and
195 /// apply only to method parameters (?). oneway applies only to
196 /// results. All of these expect their corresponding parameter to
197 /// have a particular type. None of this is currently enforced by
198 /// clang.
199 ///
200 /// This should be kept in sync with ObjCDeclSpec::ObjCDeclQualifier.
201 enum ObjCDeclQualifier {
202 OBJC_TQ_None = 0x0,
203 OBJC_TQ_In = 0x1,
204 OBJC_TQ_Inout = 0x2,
205 OBJC_TQ_Out = 0x4,
206 OBJC_TQ_Bycopy = 0x8,
207 OBJC_TQ_Byref = 0x10,
208 OBJC_TQ_Oneway = 0x20,
209
210 /// The nullability qualifier is set when the nullability of the
211 /// result or parameter was expressed via a context-sensitive
212 /// keyword.
213 OBJC_TQ_CSNullability = 0x40
214 };
215
216 /// The kind of ownership a declaration has, for visibility purposes.
217 /// This enumeration is designed such that higher values represent higher
218 /// levels of name hiding.
219 enum class ModuleOwnershipKind : unsigned {
220 /// This declaration is not owned by a module.
221 Unowned,
222
223 /// This declaration has an owning module, but is globally visible
224 /// (typically because its owning module is visible and we know that
225 /// modules cannot later become hidden in this compilation).
226 /// After serialization and deserialization, this will be converted
227 /// to VisibleWhenImported.
228 Visible,
229
230 /// This declaration has an owning module, and is visible when that
231 /// module is imported.
232 VisibleWhenImported,
233
234 /// This declaration has an owning module, but is only visible to
235 /// lookups that occur within that module.
236 ModulePrivate
237 };
238
239protected:
240 /// The next declaration within the same lexical
241 /// DeclContext. These pointers form the linked list that is
242 /// traversed via DeclContext's decls_begin()/decls_end().
243 ///
244 /// The extra two bits are used for the ModuleOwnershipKind.
245 llvm::PointerIntPair<Decl *, 2, ModuleOwnershipKind> NextInContextAndBits;
246
247private:
248 friend class DeclContext;
249
250 struct MultipleDC {
251 DeclContext *SemanticDC;
252 DeclContext *LexicalDC;
253 };
254
255 /// DeclCtx - Holds either a DeclContext* or a MultipleDC*.
256 /// For declarations that don't contain C++ scope specifiers, it contains
257 /// the DeclContext where the Decl was declared.
258 /// For declarations with C++ scope specifiers, it contains a MultipleDC*
259 /// with the context where it semantically belongs (SemanticDC) and the
260 /// context where it was lexically declared (LexicalDC).
261 /// e.g.:
262 ///
263 /// namespace A {
264 /// void f(); // SemanticDC == LexicalDC == 'namespace A'
265 /// }
266 /// void A::f(); // SemanticDC == namespace 'A'
267 /// // LexicalDC == global namespace
268 llvm::PointerUnion<DeclContext*, MultipleDC*> DeclCtx;
269
270 bool isInSemaDC() const { return DeclCtx.is<DeclContext*>(); }
271 bool isOutOfSemaDC() const { return DeclCtx.is<MultipleDC*>(); }
272
273 MultipleDC *getMultipleDC() const {
274 return DeclCtx.get<MultipleDC*>();
275 }
276
277 DeclContext *getSemanticDC() const {
278 return DeclCtx.get<DeclContext*>();
279 }
280
281 /// Loc - The location of this decl.
282 SourceLocation Loc;
283
284 /// DeclKind - This indicates which class this is.
285 unsigned DeclKind : 7;
286
287 /// InvalidDecl - This indicates a semantic error occurred.
288 unsigned InvalidDecl : 1;
289
290 /// HasAttrs - This indicates whether the decl has attributes or not.
291 unsigned HasAttrs : 1;
292
293 /// Implicit - Whether this declaration was implicitly generated by
294 /// the implementation rather than explicitly written by the user.
295 unsigned Implicit : 1;
296
297 /// Whether this declaration was "used", meaning that a definition is
298 /// required.
299 unsigned Used : 1;
300
301 /// Whether this declaration was "referenced".
302 /// The difference with 'Used' is whether the reference appears in a
303 /// evaluated context or not, e.g. functions used in uninstantiated templates
304 /// are regarded as "referenced" but not "used".
305 unsigned Referenced : 1;
306
307 /// Whether this declaration is a top-level declaration (function,
308 /// global variable, etc.) that is lexically inside an objc container
309 /// definition.
310 unsigned TopLevelDeclInObjCContainer : 1;
311
312 /// Whether statistic collection is enabled.
313 static bool StatisticsEnabled;
314
315protected:
316 friend class ASTDeclReader;
317 friend class ASTDeclWriter;
318 friend class ASTNodeImporter;
319 friend class ASTReader;
320 friend class CXXClassMemberWrapper;
321 friend class LinkageComputer;
322 template<typename decl_type> friend class Redeclarable;
323
324 /// Access - Used by C++ decls for the access specifier.
325 // NOTE: VC++ treats enums as signed, avoid using the AccessSpecifier enum
326 unsigned Access : 2;
327
328 /// Whether this declaration was loaded from an AST file.
329 unsigned FromASTFile : 1;
330
331 /// IdentifierNamespace - This specifies what IDNS_* namespace this lives in.
332 unsigned IdentifierNamespace : 14;
333
334 /// If 0, we have not computed the linkage of this declaration.
335 /// Otherwise, it is the linkage + 1.
336 mutable unsigned CacheValidAndLinkage : 3;
337
338 /// Allocate memory for a deserialized declaration.
339 ///
340 /// This routine must be used to allocate memory for any declaration that is
341 /// deserialized from a module file.
342 ///
343 /// \param Size The size of the allocated object.
344 /// \param Ctx The context in which we will allocate memory.
345 /// \param ID The global ID of the deserialized declaration.
346 /// \param Extra The amount of extra space to allocate after the object.
347 void *operator new(std::size_t Size, const ASTContext &Ctx, unsigned ID,
348 std::size_t Extra = 0);
349
350 /// Allocate memory for a non-deserialized declaration.
351 void *operator new(std::size_t Size, const ASTContext &Ctx,
352 DeclContext *Parent, std::size_t Extra = 0);
353
354private:
355 bool AccessDeclContextSanity() const;
356
357 /// Get the module ownership kind to use for a local lexical child of \p DC,
358 /// which may be either a local or (rarely) an imported declaration.
359 static ModuleOwnershipKind getModuleOwnershipKindForChildOf(DeclContext *DC) {
360 if (DC) {
361 auto *D = cast<Decl>(DC);
362 auto MOK = D->getModuleOwnershipKind();
363 if (MOK != ModuleOwnershipKind::Unowned &&
364 (!D->isFromASTFile() || D->hasLocalOwningModuleStorage()))
365 return MOK;
366 // If D is not local and we have no local module storage, then we don't
367 // need to track module ownership at all.
368 }
369 return ModuleOwnershipKind::Unowned;
370 }
371
372public:
373 Decl() = delete;
374 Decl(const Decl&) = delete;
375 Decl(Decl &&) = delete;
376 Decl &operator=(const Decl&) = delete;
377 Decl &operator=(Decl&&) = delete;
378
379protected:
380 Decl(Kind DK, DeclContext *DC, SourceLocation L)
381 : NextInContextAndBits(nullptr, getModuleOwnershipKindForChildOf(DC)),
382 DeclCtx(DC), Loc(L), DeclKind(DK), InvalidDecl(false), HasAttrs(false),
383 Implicit(false), Used(false), Referenced(false),
384 TopLevelDeclInObjCContainer(false), Access(AS_none), FromASTFile(0),
385 IdentifierNamespace(getIdentifierNamespaceForKind(DK)),
386 CacheValidAndLinkage(0) {
387 if (StatisticsEnabled) add(DK);
388 }
389
390 Decl(Kind DK, EmptyShell Empty)
391 : DeclKind(DK), InvalidDecl(false), HasAttrs(false), Implicit(false),
392 Used(false), Referenced(false), TopLevelDeclInObjCContainer(false),
393 Access(AS_none), FromASTFile(0),
394 IdentifierNamespace(getIdentifierNamespaceForKind(DK)),
395 CacheValidAndLinkage(0) {
396 if (StatisticsEnabled) add(DK);
397 }
398
399 virtual ~Decl();
400
401 /// Update a potentially out-of-date declaration.
402 void updateOutOfDate(IdentifierInfo &II) const;
403
404 Linkage getCachedLinkage() const {
405 return Linkage(CacheValidAndLinkage - 1);
406 }
407
408 void setCachedLinkage(Linkage L) const {
409 CacheValidAndLinkage = L + 1;
410 }
411
412 bool hasCachedLinkage() const {
413 return CacheValidAndLinkage;
414 }
415
416public:
417 /// Source range that this declaration covers.
418 virtual SourceRange getSourceRange() const LLVM_READONLY__attribute__((__pure__)) {
419 return SourceRange(getLocation(), getLocation());
420 }
421
422 SourceLocation getBeginLoc() const LLVM_READONLY__attribute__((__pure__)) {
423 return getSourceRange().getBegin();
424 }
425
426 SourceLocation getEndLoc() const LLVM_READONLY__attribute__((__pure__)) {
427 return getSourceRange().getEnd();
428 }
429
430 SourceLocation getLocation() const { return Loc; }
431 void setLocation(SourceLocation L) { Loc = L; }
432
433 Kind getKind() const { return static_cast<Kind>(DeclKind); }
434 const char *getDeclKindName() const;
435
436 Decl *getNextDeclInContext() { return NextInContextAndBits.getPointer(); }
437 const Decl *getNextDeclInContext() const {return NextInContextAndBits.getPointer();}
438
439 DeclContext *getDeclContext() {
440 if (isInSemaDC())
441 return getSemanticDC();
442 return getMultipleDC()->SemanticDC;
443 }
444 const DeclContext *getDeclContext() const {
445 return const_cast<Decl*>(this)->getDeclContext();
446 }
447
448 /// Find the innermost non-closure ancestor of this declaration,
449 /// walking up through blocks, lambdas, etc. If that ancestor is
450 /// not a code context (!isFunctionOrMethod()), returns null.
451 ///
452 /// A declaration may be its own non-closure context.
453 Decl *getNonClosureContext();
454 const Decl *getNonClosureContext() const {
455 return const_cast<Decl*>(this)->getNonClosureContext();
456 }
457
458 TranslationUnitDecl *getTranslationUnitDecl();
459 const TranslationUnitDecl *getTranslationUnitDecl() const {
460 return const_cast<Decl*>(this)->getTranslationUnitDecl();
461 }
462
463 bool isInAnonymousNamespace() const;
464
465 bool isInStdNamespace() const;
466
467 ASTContext &getASTContext() const LLVM_READONLY__attribute__((__pure__));
468
469 /// Helper to get the language options from the ASTContext.
470 /// Defined out of line to avoid depending on ASTContext.h.
471 const LangOptions &getLangOpts() const LLVM_READONLY__attribute__((__pure__));
472
473 void setAccess(AccessSpecifier AS) {
474 Access = AS;
475 assert(AccessDeclContextSanity())(static_cast <bool> (AccessDeclContextSanity()) ? void (
0) : __assert_fail ("AccessDeclContextSanity()", "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 475, __extension__ __PRETTY_FUNCTION__))
;
476 }
477
478 AccessSpecifier getAccess() const {
479 assert(AccessDeclContextSanity())(static_cast <bool> (AccessDeclContextSanity()) ? void (
0) : __assert_fail ("AccessDeclContextSanity()", "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 479, __extension__ __PRETTY_FUNCTION__))
;
480 return AccessSpecifier(Access);
481 }
482
483 /// Retrieve the access specifier for this declaration, even though
484 /// it may not yet have been properly set.
485 AccessSpecifier getAccessUnsafe() const {
486 return AccessSpecifier(Access);
487 }
488
489 bool hasAttrs() const { return HasAttrs; }
490
491 void setAttrs(const AttrVec& Attrs) {
492 return setAttrsImpl(Attrs, getASTContext());
493 }
494
495 AttrVec &getAttrs() {
496 return const_cast<AttrVec&>(const_cast<const Decl*>(this)->getAttrs());
497 }
498
499 const AttrVec &getAttrs() const;
500 void dropAttrs();
501 void addAttr(Attr *A);
502
503 using attr_iterator = AttrVec::const_iterator;
504 using attr_range = llvm::iterator_range<attr_iterator>;
505
506 attr_range attrs() const {
507 return attr_range(attr_begin(), attr_end());
508 }
509
510 attr_iterator attr_begin() const {
511 return hasAttrs() ? getAttrs().begin() : nullptr;
512 }
513 attr_iterator attr_end() const {
514 return hasAttrs() ? getAttrs().end() : nullptr;
515 }
516
517 template <typename T>
518 void dropAttr() {
519 if (!HasAttrs) return;
520
521 AttrVec &Vec = getAttrs();
522 llvm::erase_if(Vec, [](Attr *A) { return isa<T>(A); });
523
524 if (Vec.empty())
525 HasAttrs = false;
526 }
527
528 template <typename T>
529 llvm::iterator_range<specific_attr_iterator<T>> specific_attrs() const {
530 return llvm::make_range(specific_attr_begin<T>(), specific_attr_end<T>());
531 }
532
533 template <typename T>
534 specific_attr_iterator<T> specific_attr_begin() const {
535 return specific_attr_iterator<T>(attr_begin());
536 }
537
538 template <typename T>
539 specific_attr_iterator<T> specific_attr_end() const {
540 return specific_attr_iterator<T>(attr_end());
541 }
542
543 template<typename T> T *getAttr() const {
544 return hasAttrs() ? getSpecificAttr<T>(getAttrs()) : nullptr;
545 }
546
547 template<typename T> bool hasAttr() const {
548 return hasAttrs() && hasSpecificAttr<T>(getAttrs());
11
Assuming the condition is false
12
Returning zero, which participates in a condition later
549 }
550
551 /// getMaxAlignment - return the maximum alignment specified by attributes
552 /// on this decl, 0 if there are none.
553 unsigned getMaxAlignment() const;
554
555 /// setInvalidDecl - Indicates the Decl had a semantic error. This
556 /// allows for graceful error recovery.
557 void setInvalidDecl(bool Invalid = true);
558 bool isInvalidDecl() const { return (bool) InvalidDecl; }
559
560 /// isImplicit - Indicates whether the declaration was implicitly
561 /// generated by the implementation. If false, this declaration
562 /// was written explicitly in the source code.
563 bool isImplicit() const { return Implicit; }
564 void setImplicit(bool I = true) { Implicit = I; }
565
566 /// Whether *any* (re-)declaration of the entity was used, meaning that
567 /// a definition is required.
568 ///
569 /// \param CheckUsedAttr When true, also consider the "used" attribute
570 /// (in addition to the "used" bit set by \c setUsed()) when determining
571 /// whether the function is used.
572 bool isUsed(bool CheckUsedAttr = true) const;
573
574 /// Set whether the declaration is used, in the sense of odr-use.
575 ///
576 /// This should only be used immediately after creating a declaration.
577 /// It intentionally doesn't notify any listeners.
578 void setIsUsed() { getCanonicalDecl()->Used = true; }
579
580 /// Mark the declaration used, in the sense of odr-use.
581 ///
582 /// This notifies any mutation listeners in addition to setting a bit
583 /// indicating the declaration is used.
584 void markUsed(ASTContext &C);
585
586 /// Whether any declaration of this entity was referenced.
587 bool isReferenced() const;
588
589 /// Whether this declaration was referenced. This should not be relied
590 /// upon for anything other than debugging.
591 bool isThisDeclarationReferenced() const { return Referenced; }
592
593 void setReferenced(bool R = true) { Referenced = R; }
594
595 /// Whether this declaration is a top-level declaration (function,
596 /// global variable, etc.) that is lexically inside an objc container
597 /// definition.
598 bool isTopLevelDeclInObjCContainer() const {
599 return TopLevelDeclInObjCContainer;
600 }
601
602 void setTopLevelDeclInObjCContainer(bool V = true) {
603 TopLevelDeclInObjCContainer = V;
604 }
605
606 /// Looks on this and related declarations for an applicable
607 /// external source symbol attribute.
608 ExternalSourceSymbolAttr *getExternalSourceSymbolAttr() const;
609
610 /// Whether this declaration was marked as being private to the
611 /// module in which it was defined.
612 bool isModulePrivate() const {
613 return getModuleOwnershipKind() == ModuleOwnershipKind::ModulePrivate;
614 }
615
616 /// Return true if this declaration has an attribute which acts as
617 /// definition of the entity, such as 'alias' or 'ifunc'.
618 bool hasDefiningAttr() const;
619
620 /// Return this declaration's defining attribute if it has one.
621 const Attr *getDefiningAttr() const;
622
623protected:
624 /// Specify that this declaration was marked as being private
625 /// to the module in which it was defined.
626 void setModulePrivate() {
627 // The module-private specifier has no effect on unowned declarations.
628 // FIXME: We should track this in some way for source fidelity.
629 if (getModuleOwnershipKind() == ModuleOwnershipKind::Unowned)
630 return;
631 setModuleOwnershipKind(ModuleOwnershipKind::ModulePrivate);
632 }
633
634public:
635 /// Set the FromASTFile flag. This indicates that this declaration
636 /// was deserialized and not parsed from source code and enables
637 /// features such as module ownership information.
638 void setFromASTFile() {
639 FromASTFile = true;
640 }
641
642 /// Set the owning module ID. This may only be called for
643 /// deserialized Decls.
644 void setOwningModuleID(unsigned ID) {
645 assert(isFromASTFile() && "Only works on a deserialized declaration")(static_cast <bool> (isFromASTFile() && "Only works on a deserialized declaration"
) ? void (0) : __assert_fail ("isFromASTFile() && \"Only works on a deserialized declaration\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 645, __extension__ __PRETTY_FUNCTION__))
;
646 *((unsigned*)this - 2) = ID;
647 }
648
649public:
650 /// Determine the availability of the given declaration.
651 ///
652 /// This routine will determine the most restrictive availability of
653 /// the given declaration (e.g., preferring 'unavailable' to
654 /// 'deprecated').
655 ///
656 /// \param Message If non-NULL and the result is not \c
657 /// AR_Available, will be set to a (possibly empty) message
658 /// describing why the declaration has not been introduced, is
659 /// deprecated, or is unavailable.
660 ///
661 /// \param EnclosingVersion The version to compare with. If empty, assume the
662 /// deployment target version.
663 ///
664 /// \param RealizedPlatform If non-NULL and the availability result is found
665 /// in an available attribute it will set to the platform which is written in
666 /// the available attribute.
667 AvailabilityResult
668 getAvailability(std::string *Message = nullptr,
669 VersionTuple EnclosingVersion = VersionTuple(),
670 StringRef *RealizedPlatform = nullptr) const;
671
672 /// Retrieve the version of the target platform in which this
673 /// declaration was introduced.
674 ///
675 /// \returns An empty version tuple if this declaration has no 'introduced'
676 /// availability attributes, or the version tuple that's specified in the
677 /// attribute otherwise.
678 VersionTuple getVersionIntroduced() const;
679
680 /// Determine whether this declaration is marked 'deprecated'.
681 ///
682 /// \param Message If non-NULL and the declaration is deprecated,
683 /// this will be set to the message describing why the declaration
684 /// was deprecated (which may be empty).
685 bool isDeprecated(std::string *Message = nullptr) const {
686 return getAvailability(Message) == AR_Deprecated;
687 }
688
689 /// Determine whether this declaration is marked 'unavailable'.
690 ///
691 /// \param Message If non-NULL and the declaration is unavailable,
692 /// this will be set to the message describing why the declaration
693 /// was made unavailable (which may be empty).
694 bool isUnavailable(std::string *Message = nullptr) const {
695 return getAvailability(Message) == AR_Unavailable;
696 }
697
698 /// Determine whether this is a weak-imported symbol.
699 ///
700 /// Weak-imported symbols are typically marked with the
701 /// 'weak_import' attribute, but may also be marked with an
702 /// 'availability' attribute where we're targing a platform prior to
703 /// the introduction of this feature.
704 bool isWeakImported() const;
705
706 /// Determines whether this symbol can be weak-imported,
707 /// e.g., whether it would be well-formed to add the weak_import
708 /// attribute.
709 ///
710 /// \param IsDefinition Set to \c true to indicate that this
711 /// declaration cannot be weak-imported because it has a definition.
712 bool canBeWeakImported(bool &IsDefinition) const;
713
714 /// Determine whether this declaration came from an AST file (such as
715 /// a precompiled header or module) rather than having been parsed.
716 bool isFromASTFile() const { return FromASTFile; }
717
718 /// Retrieve the global declaration ID associated with this
719 /// declaration, which specifies where this Decl was loaded from.
720 unsigned getGlobalID() const {
721 if (isFromASTFile())
722 return *((const unsigned*)this - 1);
723 return 0;
724 }
725
726 /// Retrieve the global ID of the module that owns this particular
727 /// declaration.
728 unsigned getOwningModuleID() const {
729 if (isFromASTFile())
730 return *((const unsigned*)this - 2);
731 return 0;
732 }
733
734private:
735 Module *getOwningModuleSlow() const;
736
737protected:
738 bool hasLocalOwningModuleStorage() const;
739
740public:
741 /// Get the imported owning module, if this decl is from an imported
742 /// (non-local) module.
743 Module *getImportedOwningModule() const {
744 if (!isFromASTFile() || !hasOwningModule())
745 return nullptr;
746
747 return getOwningModuleSlow();
748 }
749
750 /// Get the local owning module, if known. Returns nullptr if owner is
751 /// not yet known or declaration is not from a module.
752 Module *getLocalOwningModule() const {
753 if (isFromASTFile() || !hasOwningModule())
754 return nullptr;
755
756 assert(hasLocalOwningModuleStorage() &&(static_cast <bool> (hasLocalOwningModuleStorage() &&
"owned local decl but no local module storage") ? void (0) :
__assert_fail ("hasLocalOwningModuleStorage() && \"owned local decl but no local module storage\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 757, __extension__ __PRETTY_FUNCTION__))
757 "owned local decl but no local module storage")(static_cast <bool> (hasLocalOwningModuleStorage() &&
"owned local decl but no local module storage") ? void (0) :
__assert_fail ("hasLocalOwningModuleStorage() && \"owned local decl but no local module storage\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 757, __extension__ __PRETTY_FUNCTION__))
;
758 return reinterpret_cast<Module *const *>(this)[-1];
759 }
760 void setLocalOwningModule(Module *M) {
761 assert(!isFromASTFile() && hasOwningModule() &&(static_cast <bool> (!isFromASTFile() && hasOwningModule
() && hasLocalOwningModuleStorage() && "should not have a cached owning module"
) ? void (0) : __assert_fail ("!isFromASTFile() && hasOwningModule() && hasLocalOwningModuleStorage() && \"should not have a cached owning module\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 763, __extension__ __PRETTY_FUNCTION__))
762 hasLocalOwningModuleStorage() &&(static_cast <bool> (!isFromASTFile() && hasOwningModule
() && hasLocalOwningModuleStorage() && "should not have a cached owning module"
) ? void (0) : __assert_fail ("!isFromASTFile() && hasOwningModule() && hasLocalOwningModuleStorage() && \"should not have a cached owning module\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 763, __extension__ __PRETTY_FUNCTION__))
763 "should not have a cached owning module")(static_cast <bool> (!isFromASTFile() && hasOwningModule
() && hasLocalOwningModuleStorage() && "should not have a cached owning module"
) ? void (0) : __assert_fail ("!isFromASTFile() && hasOwningModule() && hasLocalOwningModuleStorage() && \"should not have a cached owning module\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 763, __extension__ __PRETTY_FUNCTION__))
;
764 reinterpret_cast<Module **>(this)[-1] = M;
765 }
766
767 /// Is this declaration owned by some module?
768 bool hasOwningModule() const {
769 return getModuleOwnershipKind() != ModuleOwnershipKind::Unowned;
770 }
771
772 /// Get the module that owns this declaration (for visibility purposes).
773 Module *getOwningModule() const {
774 return isFromASTFile() ? getImportedOwningModule() : getLocalOwningModule();
775 }
776
777 /// Get the module that owns this declaration for linkage purposes.
778 /// There only ever is such a module under the C++ Modules TS.
779 ///
780 /// \param IgnoreLinkage Ignore the linkage of the entity; assume that
781 /// all declarations in a global module fragment are unowned.
782 Module *getOwningModuleForLinkage(bool IgnoreLinkage = false) const;
783
784 /// Determine whether this declaration is definitely visible to name lookup,
785 /// independent of whether the owning module is visible.
786 /// Note: The declaration may be visible even if this returns \c false if the
787 /// owning module is visible within the query context. This is a low-level
788 /// helper function; most code should be calling Sema::isVisible() instead.
789 bool isUnconditionallyVisible() const {
790 return (int)getModuleOwnershipKind() <= (int)ModuleOwnershipKind::Visible;
791 }
792
793 /// Set that this declaration is globally visible, even if it came from a
794 /// module that is not visible.
795 void setVisibleDespiteOwningModule() {
796 if (!isUnconditionallyVisible())
797 setModuleOwnershipKind(ModuleOwnershipKind::Visible);
798 }
799
800 /// Get the kind of module ownership for this declaration.
801 ModuleOwnershipKind getModuleOwnershipKind() const {
802 return NextInContextAndBits.getInt();
803 }
804
805 /// Set whether this declaration is hidden from name lookup.
806 void setModuleOwnershipKind(ModuleOwnershipKind MOK) {
807 assert(!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned &&(static_cast <bool> (!(getModuleOwnershipKind() == ModuleOwnershipKind
::Unowned && MOK != ModuleOwnershipKind::Unowned &&
!isFromASTFile() && !hasLocalOwningModuleStorage()) &&
"no storage available for owning module for this declaration"
) ? void (0) : __assert_fail ("!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned && MOK != ModuleOwnershipKind::Unowned && !isFromASTFile() && !hasLocalOwningModuleStorage()) && \"no storage available for owning module for this declaration\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 810, __extension__ __PRETTY_FUNCTION__))
808 MOK != ModuleOwnershipKind::Unowned && !isFromASTFile() &&(static_cast <bool> (!(getModuleOwnershipKind() == ModuleOwnershipKind
::Unowned && MOK != ModuleOwnershipKind::Unowned &&
!isFromASTFile() && !hasLocalOwningModuleStorage()) &&
"no storage available for owning module for this declaration"
) ? void (0) : __assert_fail ("!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned && MOK != ModuleOwnershipKind::Unowned && !isFromASTFile() && !hasLocalOwningModuleStorage()) && \"no storage available for owning module for this declaration\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 810, __extension__ __PRETTY_FUNCTION__))
809 !hasLocalOwningModuleStorage()) &&(static_cast <bool> (!(getModuleOwnershipKind() == ModuleOwnershipKind
::Unowned && MOK != ModuleOwnershipKind::Unowned &&
!isFromASTFile() && !hasLocalOwningModuleStorage()) &&
"no storage available for owning module for this declaration"
) ? void (0) : __assert_fail ("!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned && MOK != ModuleOwnershipKind::Unowned && !isFromASTFile() && !hasLocalOwningModuleStorage()) && \"no storage available for owning module for this declaration\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 810, __extension__ __PRETTY_FUNCTION__))
810 "no storage available for owning module for this declaration")(static_cast <bool> (!(getModuleOwnershipKind() == ModuleOwnershipKind
::Unowned && MOK != ModuleOwnershipKind::Unowned &&
!isFromASTFile() && !hasLocalOwningModuleStorage()) &&
"no storage available for owning module for this declaration"
) ? void (0) : __assert_fail ("!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned && MOK != ModuleOwnershipKind::Unowned && !isFromASTFile() && !hasLocalOwningModuleStorage()) && \"no storage available for owning module for this declaration\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 810, __extension__ __PRETTY_FUNCTION__))
;
811 NextInContextAndBits.setInt(MOK);
812 }
813
814 unsigned getIdentifierNamespace() const {
815 return IdentifierNamespace;
816 }
817
818 bool isInIdentifierNamespace(unsigned NS) const {
819 return getIdentifierNamespace() & NS;
820 }
821
822 static unsigned getIdentifierNamespaceForKind(Kind DK);
823
824 bool hasTagIdentifierNamespace() const {
825 return isTagIdentifierNamespace(getIdentifierNamespace());
826 }
827
828 static bool isTagIdentifierNamespace(unsigned NS) {
829 // TagDecls have Tag and Type set and may also have TagFriend.
830 return (NS & ~IDNS_TagFriend) == (IDNS_Tag | IDNS_Type);
831 }
832
833 /// getLexicalDeclContext - The declaration context where this Decl was
834 /// lexically declared (LexicalDC). May be different from
835 /// getDeclContext() (SemanticDC).
836 /// e.g.:
837 ///
838 /// namespace A {
839 /// void f(); // SemanticDC == LexicalDC == 'namespace A'
840 /// }
841 /// void A::f(); // SemanticDC == namespace 'A'
842 /// // LexicalDC == global namespace
843 DeclContext *getLexicalDeclContext() {
844 if (isInSemaDC())
845 return getSemanticDC();
846 return getMultipleDC()->LexicalDC;
847 }
848 const DeclContext *getLexicalDeclContext() const {
849 return const_cast<Decl*>(this)->getLexicalDeclContext();
850 }
851
852 /// Determine whether this declaration is declared out of line (outside its
853 /// semantic context).
854 virtual bool isOutOfLine() const;
855
856 /// setDeclContext - Set both the semantic and lexical DeclContext
857 /// to DC.
858 void setDeclContext(DeclContext *DC);
859
860 void setLexicalDeclContext(DeclContext *DC);
861
862 /// Determine whether this declaration is a templated entity (whether it is
863 // within the scope of a template parameter).
864 bool isTemplated() const;
865
866 /// Determine the number of levels of template parameter surrounding this
867 /// declaration.
868 unsigned getTemplateDepth() const;
869
870 /// isDefinedOutsideFunctionOrMethod - This predicate returns true if this
871 /// scoped decl is defined outside the current function or method. This is
872 /// roughly global variables and functions, but also handles enums (which
873 /// could be defined inside or outside a function etc).
874 bool isDefinedOutsideFunctionOrMethod() const {
875 return getParentFunctionOrMethod() == nullptr;
876 }
877
878 /// Determine whether a substitution into this declaration would occur as
879 /// part of a substitution into a dependent local scope. Such a substitution
880 /// transitively substitutes into all constructs nested within this
881 /// declaration.
882 ///
883 /// This recognizes non-defining declarations as well as members of local
884 /// classes and lambdas:
885 /// \code
886 /// template<typename T> void foo() { void bar(); }
887 /// template<typename T> void foo2() { class ABC { void bar(); }; }
888 /// template<typename T> inline int x = [](){ return 0; }();
889 /// \endcode
890 bool isInLocalScopeForInstantiation() const;
891
892 /// If this decl is defined inside a function/method/block it returns
893 /// the corresponding DeclContext, otherwise it returns null.
894 const DeclContext *getParentFunctionOrMethod() const;
895 DeclContext *getParentFunctionOrMethod() {
896 return const_cast<DeclContext*>(
897 const_cast<const Decl*>(this)->getParentFunctionOrMethod());
898 }
899
900 /// Retrieves the "canonical" declaration of the given declaration.
901 virtual Decl *getCanonicalDecl() { return this; }
902 const Decl *getCanonicalDecl() const {
903 return const_cast<Decl*>(this)->getCanonicalDecl();
904 }
905
906 /// Whether this particular Decl is a canonical one.
907 bool isCanonicalDecl() const { return getCanonicalDecl() == this; }
908
909protected:
910 /// Returns the next redeclaration or itself if this is the only decl.
911 ///
912 /// Decl subclasses that can be redeclared should override this method so that
913 /// Decl::redecl_iterator can iterate over them.
914 virtual Decl *getNextRedeclarationImpl() { return this; }
915
916 /// Implementation of getPreviousDecl(), to be overridden by any
917 /// subclass that has a redeclaration chain.
918 virtual Decl *getPreviousDeclImpl() { return nullptr; }
919
920 /// Implementation of getMostRecentDecl(), to be overridden by any
921 /// subclass that has a redeclaration chain.
922 virtual Decl *getMostRecentDeclImpl() { return this; }
923
924public:
925 /// Iterates through all the redeclarations of the same decl.
926 class redecl_iterator {
927 /// Current - The current declaration.
928 Decl *Current = nullptr;
929 Decl *Starter;
930
931 public:
932 using value_type = Decl *;
933 using reference = const value_type &;
934 using pointer = const value_type *;
935 using iterator_category = std::forward_iterator_tag;
936 using difference_type = std::ptrdiff_t;
937
938 redecl_iterator() = default;
939 explicit redecl_iterator(Decl *C) : Current(C), Starter(C) {}
940
941 reference operator*() const { return Current; }
942 value_type operator->() const { return Current; }
943
944 redecl_iterator& operator++() {
945 assert(Current && "Advancing while iterator has reached end")(static_cast <bool> (Current && "Advancing while iterator has reached end"
) ? void (0) : __assert_fail ("Current && \"Advancing while iterator has reached end\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 945, __extension__ __PRETTY_FUNCTION__))
;
946 // Get either previous decl or latest decl.
947 Decl *Next = Current->getNextRedeclarationImpl();
948 assert(Next && "Should return next redeclaration or itself, never null!")(static_cast <bool> (Next && "Should return next redeclaration or itself, never null!"
) ? void (0) : __assert_fail ("Next && \"Should return next redeclaration or itself, never null!\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 948, __extension__ __PRETTY_FUNCTION__))
;
949 Current = (Next != Starter) ? Next : nullptr;
950 return *this;
951 }
952
953 redecl_iterator operator++(int) {
954 redecl_iterator tmp(*this);
955 ++(*this);
956 return tmp;
957 }
958
959 friend bool operator==(redecl_iterator x, redecl_iterator y) {
960 return x.Current == y.Current;
961 }
962
963 friend bool operator!=(redecl_iterator x, redecl_iterator y) {
964 return x.Current != y.Current;
965 }
966 };
967
968 using redecl_range = llvm::iterator_range<redecl_iterator>;
969
970 /// Returns an iterator range for all the redeclarations of the same
971 /// decl. It will iterate at least once (when this decl is the only one).
972 redecl_range redecls() const {
973 return redecl_range(redecls_begin(), redecls_end());
974 }
975
976 redecl_iterator redecls_begin() const {
977 return redecl_iterator(const_cast<Decl *>(this));
978 }
979
980 redecl_iterator redecls_end() const { return redecl_iterator(); }
981
982 /// Retrieve the previous declaration that declares the same entity
983 /// as this declaration, or NULL if there is no previous declaration.
984 Decl *getPreviousDecl() { return getPreviousDeclImpl(); }
985
986 /// Retrieve the previous declaration that declares the same entity
987 /// as this declaration, or NULL if there is no previous declaration.
988 const Decl *getPreviousDecl() const {
989 return const_cast<Decl *>(this)->getPreviousDeclImpl();
990 }
991
992 /// True if this is the first declaration in its redeclaration chain.
993 bool isFirstDecl() const {
994 return getPreviousDecl() == nullptr;
995 }
996
997 /// Retrieve the most recent declaration that declares the same entity
998 /// as this declaration (which may be this declaration).
999 Decl *getMostRecentDecl() { return getMostRecentDeclImpl(); }
1000
1001 /// Retrieve the most recent declaration that declares the same entity
1002 /// as this declaration (which may be this declaration).
1003 const Decl *getMostRecentDecl() const {
1004 return const_cast<Decl *>(this)->getMostRecentDeclImpl();
1005 }
1006
1007 /// getBody - If this Decl represents a declaration for a body of code,
1008 /// such as a function or method definition, this method returns the
1009 /// top-level Stmt* of that body. Otherwise this method returns null.
1010 virtual Stmt* getBody() const { return nullptr; }
1011
1012 /// Returns true if this \c Decl represents a declaration for a body of
1013 /// code, such as a function or method definition.
1014 /// Note that \c hasBody can also return true if any redeclaration of this
1015 /// \c Decl represents a declaration for a body of code.
1016 virtual bool hasBody() const { return getBody() != nullptr; }
1017
1018 /// getBodyRBrace - Gets the right brace of the body, if a body exists.
1019 /// This works whether the body is a CompoundStmt or a CXXTryStmt.
1020 SourceLocation getBodyRBrace() const;
1021
1022 // global temp stats (until we have a per-module visitor)
1023 static void add(Kind k);
1024 static void EnableStatistics();
1025 static void PrintStats();
1026
1027 /// isTemplateParameter - Determines whether this declaration is a
1028 /// template parameter.
1029 bool isTemplateParameter() const;
1030
1031 /// isTemplateParameter - Determines whether this declaration is a
1032 /// template parameter pack.
1033 bool isTemplateParameterPack() const;
1034
1035 /// Whether this declaration is a parameter pack.
1036 bool isParameterPack() const;
1037
1038 /// returns true if this declaration is a template
1039 bool isTemplateDecl() const;
1040
1041 /// Whether this declaration is a function or function template.
1042 bool isFunctionOrFunctionTemplate() const {
1043 return (DeclKind >= Decl::firstFunction &&
1044 DeclKind <= Decl::lastFunction) ||
1045 DeclKind == FunctionTemplate;
1046 }
1047
1048 /// If this is a declaration that describes some template, this
1049 /// method returns that template declaration.
1050 ///
1051 /// Note that this returns nullptr for partial specializations, because they
1052 /// are not modeled as TemplateDecls. Use getDescribedTemplateParams to handle
1053 /// those cases.
1054 TemplateDecl *getDescribedTemplate() const;
1055
1056 /// If this is a declaration that describes some template or partial
1057 /// specialization, this returns the corresponding template parameter list.
1058 const TemplateParameterList *getDescribedTemplateParams() const;
1059
1060 /// Returns the function itself, or the templated function if this is a
1061 /// function template.
1062 FunctionDecl *getAsFunction() LLVM_READONLY__attribute__((__pure__));
1063
1064 const FunctionDecl *getAsFunction() const {
1065 return const_cast<Decl *>(this)->getAsFunction();
1066 }
1067
1068 /// Changes the namespace of this declaration to reflect that it's
1069 /// a function-local extern declaration.
1070 ///
1071 /// These declarations appear in the lexical context of the extern
1072 /// declaration, but in the semantic context of the enclosing namespace
1073 /// scope.
1074 void setLocalExternDecl() {
1075 Decl *Prev = getPreviousDecl();
1076 IdentifierNamespace &= ~IDNS_Ordinary;
1077
1078 // It's OK for the declaration to still have the "invisible friend" flag or
1079 // the "conflicts with tag declarations in this scope" flag for the outer
1080 // scope.
1081 assert((IdentifierNamespace & ~(IDNS_OrdinaryFriend | IDNS_Tag)) == 0 &&(static_cast <bool> ((IdentifierNamespace & ~(IDNS_OrdinaryFriend
| IDNS_Tag)) == 0 && "namespace is not ordinary") ? void
(0) : __assert_fail ("(IdentifierNamespace & ~(IDNS_OrdinaryFriend | IDNS_Tag)) == 0 && \"namespace is not ordinary\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1082, __extension__ __PRETTY_FUNCTION__))
1082 "namespace is not ordinary")(static_cast <bool> ((IdentifierNamespace & ~(IDNS_OrdinaryFriend
| IDNS_Tag)) == 0 && "namespace is not ordinary") ? void
(0) : __assert_fail ("(IdentifierNamespace & ~(IDNS_OrdinaryFriend | IDNS_Tag)) == 0 && \"namespace is not ordinary\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1082, __extension__ __PRETTY_FUNCTION__))
;
1083
1084 IdentifierNamespace |= IDNS_LocalExtern;
1085 if (Prev && Prev->getIdentifierNamespace() & IDNS_Ordinary)
1086 IdentifierNamespace |= IDNS_Ordinary;
1087 }
1088
1089 /// Determine whether this is a block-scope declaration with linkage.
1090 /// This will either be a local variable declaration declared 'extern', or a
1091 /// local function declaration.
1092 bool isLocalExternDecl() {
1093 return IdentifierNamespace & IDNS_LocalExtern;
1094 }
1095
1096 /// Changes the namespace of this declaration to reflect that it's
1097 /// the object of a friend declaration.
1098 ///
1099 /// These declarations appear in the lexical context of the friending
1100 /// class, but in the semantic context of the actual entity. This property
1101 /// applies only to a specific decl object; other redeclarations of the
1102 /// same entity may not (and probably don't) share this property.
1103 void setObjectOfFriendDecl(bool PerformFriendInjection = false) {
1104 unsigned OldNS = IdentifierNamespace;
1105 assert((OldNS & (IDNS_Tag | IDNS_Ordinary |(static_cast <bool> ((OldNS & (IDNS_Tag | IDNS_Ordinary
| IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern | IDNS_NonMemberOperator
)) && "namespace includes neither ordinary nor tag") ?
void (0) : __assert_fail ("(OldNS & (IDNS_Tag | IDNS_Ordinary | IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern | IDNS_NonMemberOperator)) && \"namespace includes neither ordinary nor tag\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1108, __extension__ __PRETTY_FUNCTION__))
1106 IDNS_TagFriend | IDNS_OrdinaryFriend |(static_cast <bool> ((OldNS & (IDNS_Tag | IDNS_Ordinary
| IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern | IDNS_NonMemberOperator
)) && "namespace includes neither ordinary nor tag") ?
void (0) : __assert_fail ("(OldNS & (IDNS_Tag | IDNS_Ordinary | IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern | IDNS_NonMemberOperator)) && \"namespace includes neither ordinary nor tag\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1108, __extension__ __PRETTY_FUNCTION__))
1107 IDNS_LocalExtern | IDNS_NonMemberOperator)) &&(static_cast <bool> ((OldNS & (IDNS_Tag | IDNS_Ordinary
| IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern | IDNS_NonMemberOperator
)) && "namespace includes neither ordinary nor tag") ?
void (0) : __assert_fail ("(OldNS & (IDNS_Tag | IDNS_Ordinary | IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern | IDNS_NonMemberOperator)) && \"namespace includes neither ordinary nor tag\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1108, __extension__ __PRETTY_FUNCTION__))
1108 "namespace includes neither ordinary nor tag")(static_cast <bool> ((OldNS & (IDNS_Tag | IDNS_Ordinary
| IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern | IDNS_NonMemberOperator
)) && "namespace includes neither ordinary nor tag") ?
void (0) : __assert_fail ("(OldNS & (IDNS_Tag | IDNS_Ordinary | IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern | IDNS_NonMemberOperator)) && \"namespace includes neither ordinary nor tag\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1108, __extension__ __PRETTY_FUNCTION__))
;
1109 assert(!(OldNS & ~(IDNS_Tag | IDNS_Ordinary | IDNS_Type |(static_cast <bool> (!(OldNS & ~(IDNS_Tag | IDNS_Ordinary
| IDNS_Type | IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern
| IDNS_NonMemberOperator)) && "namespace includes other than ordinary or tag"
) ? void (0) : __assert_fail ("!(OldNS & ~(IDNS_Tag | IDNS_Ordinary | IDNS_Type | IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern | IDNS_NonMemberOperator)) && \"namespace includes other than ordinary or tag\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1112, __extension__ __PRETTY_FUNCTION__))
1110 IDNS_TagFriend | IDNS_OrdinaryFriend |(static_cast <bool> (!(OldNS & ~(IDNS_Tag | IDNS_Ordinary
| IDNS_Type | IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern
| IDNS_NonMemberOperator)) && "namespace includes other than ordinary or tag"
) ? void (0) : __assert_fail ("!(OldNS & ~(IDNS_Tag | IDNS_Ordinary | IDNS_Type | IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern | IDNS_NonMemberOperator)) && \"namespace includes other than ordinary or tag\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1112, __extension__ __PRETTY_FUNCTION__))
1111 IDNS_LocalExtern | IDNS_NonMemberOperator)) &&(static_cast <bool> (!(OldNS & ~(IDNS_Tag | IDNS_Ordinary
| IDNS_Type | IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern
| IDNS_NonMemberOperator)) && "namespace includes other than ordinary or tag"
) ? void (0) : __assert_fail ("!(OldNS & ~(IDNS_Tag | IDNS_Ordinary | IDNS_Type | IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern | IDNS_NonMemberOperator)) && \"namespace includes other than ordinary or tag\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1112, __extension__ __PRETTY_FUNCTION__))
1112 "namespace includes other than ordinary or tag")(static_cast <bool> (!(OldNS & ~(IDNS_Tag | IDNS_Ordinary
| IDNS_Type | IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern
| IDNS_NonMemberOperator)) && "namespace includes other than ordinary or tag"
) ? void (0) : __assert_fail ("!(OldNS & ~(IDNS_Tag | IDNS_Ordinary | IDNS_Type | IDNS_TagFriend | IDNS_OrdinaryFriend | IDNS_LocalExtern | IDNS_NonMemberOperator)) && \"namespace includes other than ordinary or tag\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1112, __extension__ __PRETTY_FUNCTION__))
;
1113
1114 Decl *Prev = getPreviousDecl();
1115 IdentifierNamespace &= ~(IDNS_Ordinary | IDNS_Tag | IDNS_Type);
1116
1117 if (OldNS & (IDNS_Tag | IDNS_TagFriend)) {
1118 IdentifierNamespace |= IDNS_TagFriend;
1119 if (PerformFriendInjection ||
1120 (Prev && Prev->getIdentifierNamespace() & IDNS_Tag))
1121 IdentifierNamespace |= IDNS_Tag | IDNS_Type;
1122 }
1123
1124 if (OldNS & (IDNS_Ordinary | IDNS_OrdinaryFriend |
1125 IDNS_LocalExtern | IDNS_NonMemberOperator)) {
1126 IdentifierNamespace |= IDNS_OrdinaryFriend;
1127 if (PerformFriendInjection ||
1128 (Prev && Prev->getIdentifierNamespace() & IDNS_Ordinary))
1129 IdentifierNamespace |= IDNS_Ordinary;
1130 }
1131 }
1132
1133 enum FriendObjectKind {
1134 FOK_None, ///< Not a friend object.
1135 FOK_Declared, ///< A friend of a previously-declared entity.
1136 FOK_Undeclared ///< A friend of a previously-undeclared entity.
1137 };
1138
1139 /// Determines whether this declaration is the object of a
1140 /// friend declaration and, if so, what kind.
1141 ///
1142 /// There is currently no direct way to find the associated FriendDecl.
1143 FriendObjectKind getFriendObjectKind() const {
1144 unsigned mask =
1145 (IdentifierNamespace & (IDNS_TagFriend | IDNS_OrdinaryFriend));
1146 if (!mask) return FOK_None;
1147 return (IdentifierNamespace & (IDNS_Tag | IDNS_Ordinary) ? FOK_Declared
1148 : FOK_Undeclared);
1149 }
1150
1151 /// Specifies that this declaration is a C++ overloaded non-member.
1152 void setNonMemberOperator() {
1153 assert(getKind() == Function || getKind() == FunctionTemplate)(static_cast <bool> (getKind() == Function || getKind()
== FunctionTemplate) ? void (0) : __assert_fail ("getKind() == Function || getKind() == FunctionTemplate"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1153, __extension__ __PRETTY_FUNCTION__))
;
1154 assert((IdentifierNamespace & IDNS_Ordinary) &&(static_cast <bool> ((IdentifierNamespace & IDNS_Ordinary
) && "visible non-member operators should be in ordinary namespace"
) ? void (0) : __assert_fail ("(IdentifierNamespace & IDNS_Ordinary) && \"visible non-member operators should be in ordinary namespace\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1155, __extension__ __PRETTY_FUNCTION__))
1155 "visible non-member operators should be in ordinary namespace")(static_cast <bool> ((IdentifierNamespace & IDNS_Ordinary
) && "visible non-member operators should be in ordinary namespace"
) ? void (0) : __assert_fail ("(IdentifierNamespace & IDNS_Ordinary) && \"visible non-member operators should be in ordinary namespace\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1155, __extension__ __PRETTY_FUNCTION__))
;
1156 IdentifierNamespace |= IDNS_NonMemberOperator;
1157 }
1158
1159 static bool classofKind(Kind K) { return true; }
1160 static DeclContext *castToDeclContext(const Decl *);
1161 static Decl *castFromDeclContext(const DeclContext *);
1162
1163 void print(raw_ostream &Out, unsigned Indentation = 0,
1164 bool PrintInstantiation = false) const;
1165 void print(raw_ostream &Out, const PrintingPolicy &Policy,
1166 unsigned Indentation = 0, bool PrintInstantiation = false) const;
1167 static void printGroup(Decl** Begin, unsigned NumDecls,
1168 raw_ostream &Out, const PrintingPolicy &Policy,
1169 unsigned Indentation = 0);
1170
1171 // Debuggers don't usually respect default arguments.
1172 void dump() const;
1173
1174 // Same as dump(), but forces color printing.
1175 void dumpColor() const;
1176
1177 void dump(raw_ostream &Out, bool Deserialize = false,
1178 ASTDumpOutputFormat OutputFormat = ADOF_Default) const;
1179
1180 /// \return Unique reproducible object identifier
1181 int64_t getID() const;
1182
1183 /// Looks through the Decl's underlying type to extract a FunctionType
1184 /// when possible. Will return null if the type underlying the Decl does not
1185 /// have a FunctionType.
1186 const FunctionType *getFunctionType(bool BlocksToo = true) const;
1187
1188private:
1189 void setAttrsImpl(const AttrVec& Attrs, ASTContext &Ctx);
1190 void setDeclContextsImpl(DeclContext *SemaDC, DeclContext *LexicalDC,
1191 ASTContext &Ctx);
1192
1193protected:
1194 ASTMutationListener *getASTMutationListener() const;
1195};
1196
1197/// Determine whether two declarations declare the same entity.
1198inline bool declaresSameEntity(const Decl *D1, const Decl *D2) {
1199 if (!D1 || !D2)
1200 return false;
1201
1202 if (D1 == D2)
1203 return true;
1204
1205 return D1->getCanonicalDecl() == D2->getCanonicalDecl();
1206}
1207
1208/// PrettyStackTraceDecl - If a crash occurs, indicate that it happened when
1209/// doing something to a specific decl.
1210class PrettyStackTraceDecl : public llvm::PrettyStackTraceEntry {
1211 const Decl *TheDecl;
1212 SourceLocation Loc;
1213 SourceManager &SM;
1214 const char *Message;
1215
1216public:
1217 PrettyStackTraceDecl(const Decl *theDecl, SourceLocation L,
1218 SourceManager &sm, const char *Msg)
1219 : TheDecl(theDecl), Loc(L), SM(sm), Message(Msg) {}
1220
1221 void print(raw_ostream &OS) const override;
1222};
1223} // namespace clang
1224
1225// Required to determine the layout of the PointerUnion<NamedDecl*> before
1226// seeing the NamedDecl definition being first used in DeclListNode::operator*.
1227namespace llvm {
1228 template <> struct PointerLikeTypeTraits<::clang::NamedDecl *> {
1229 static inline void *getAsVoidPointer(::clang::NamedDecl *P) { return P; }
1230 static inline ::clang::NamedDecl *getFromVoidPointer(void *P) {
1231 return static_cast<::clang::NamedDecl *>(P);
1232 }
1233 static constexpr int NumLowBitsAvailable = 3;
1234 };
1235}
1236
1237namespace clang {
1238/// A list storing NamedDecls in the lookup tables.
1239class DeclListNode {
1240 friend class ASTContext; // allocate, deallocate nodes.
1241 friend class StoredDeclsList;
1242public:
1243 using Decls = llvm::PointerUnion<NamedDecl*, DeclListNode*>;
1244 class iterator {
1245 friend class DeclContextLookupResult;
1246 friend class StoredDeclsList;
1247
1248 Decls Ptr;
1249 iterator(Decls Node) : Ptr(Node) { }
1250 public:
1251 using difference_type = ptrdiff_t;
1252 using value_type = NamedDecl*;
1253 using pointer = void;
1254 using reference = value_type;
1255 using iterator_category = std::forward_iterator_tag;
1256
1257 iterator() = default;
1258
1259 reference operator*() const {
1260 assert(Ptr && "dereferencing end() iterator")(static_cast <bool> (Ptr && "dereferencing end() iterator"
) ? void (0) : __assert_fail ("Ptr && \"dereferencing end() iterator\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1260, __extension__ __PRETTY_FUNCTION__))
;
1261 if (DeclListNode *CurNode = Ptr.dyn_cast<DeclListNode*>())
1262 return CurNode->D;
1263 return Ptr.get<NamedDecl*>();
1264 }
1265 void operator->() const { } // Unsupported.
1266 bool operator==(const iterator &X) const { return Ptr == X.Ptr; }
1267 bool operator!=(const iterator &X) const { return Ptr != X.Ptr; }
1268 inline iterator &operator++() { // ++It
1269 assert(!Ptr.isNull() && "Advancing empty iterator")(static_cast <bool> (!Ptr.isNull() && "Advancing empty iterator"
) ? void (0) : __assert_fail ("!Ptr.isNull() && \"Advancing empty iterator\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 1269, __extension__ __PRETTY_FUNCTION__))
;
1270
1271 if (DeclListNode *CurNode = Ptr.dyn_cast<DeclListNode*>())
1272 Ptr = CurNode->Rest;
1273 else
1274 Ptr = nullptr;
1275 return *this;
1276 }
1277 iterator operator++(int) { // It++
1278 iterator temp = *this;
1279 ++(*this);
1280 return temp;
1281 }
1282 // Enables the pattern for (iterator I =..., E = I.end(); I != E; ++I)
1283 iterator end() { return iterator(); }
1284 };
1285private:
1286 NamedDecl *D = nullptr;
1287 Decls Rest = nullptr;
1288 DeclListNode(NamedDecl *ND) : D(ND) {}
1289};
1290
1291/// The results of name lookup within a DeclContext.
1292class DeclContextLookupResult {
1293 using Decls = DeclListNode::Decls;
1294
1295 /// When in collection form, this is what the Data pointer points to.
1296 Decls Result;
1297
1298public:
1299 DeclContextLookupResult() = default;
1300 DeclContextLookupResult(Decls Result) : Result(Result) {}
1301
1302 using iterator = DeclListNode::iterator;
1303 using const_iterator = iterator;
1304 using reference = iterator::reference;
1305
1306 iterator begin() { return iterator(Result); }
1307 iterator end() { return iterator(); }
1308 const_iterator begin() const {
1309 return const_cast<DeclContextLookupResult*>(this)->begin();
1310 }
1311 const_iterator end() const { return iterator(); }
1312
1313 bool empty() const { return Result.isNull(); }
1314 bool isSingleResult() const { return Result.dyn_cast<NamedDecl*>(); }
1315 reference front() const { return *begin(); }
1316
1317 // Find the first declaration of the given type in the list. Note that this
1318 // is not in general the earliest-declared declaration, and should only be
1319 // used when it's not possible for there to be more than one match or where
1320 // it doesn't matter which one is found.
1321 template<class T> T *find_first() const {
1322 for (auto *D : *this)
1323 if (T *Decl = dyn_cast<T>(D))
1324 return Decl;
1325
1326 return nullptr;
1327 }
1328};
1329
1330/// DeclContext - This is used only as base class of specific decl types that
1331/// can act as declaration contexts. These decls are (only the top classes
1332/// that directly derive from DeclContext are mentioned, not their subclasses):
1333///
1334/// TranslationUnitDecl
1335/// ExternCContext
1336/// NamespaceDecl
1337/// TagDecl
1338/// OMPDeclareReductionDecl
1339/// OMPDeclareMapperDecl
1340/// FunctionDecl
1341/// ObjCMethodDecl
1342/// ObjCContainerDecl
1343/// LinkageSpecDecl
1344/// ExportDecl
1345/// BlockDecl
1346/// CapturedDecl
1347class DeclContext {
1348 /// For makeDeclVisibleInContextImpl
1349 friend class ASTDeclReader;
1350 /// For reconcileExternalVisibleStorage, CreateStoredDeclsMap,
1351 /// hasNeedToReconcileExternalVisibleStorage
1352 friend class ExternalASTSource;
1353 /// For CreateStoredDeclsMap
1354 friend class DependentDiagnostic;
1355 /// For hasNeedToReconcileExternalVisibleStorage,
1356 /// hasLazyLocalLexicalLookups, hasLazyExternalLexicalLookups
1357 friend class ASTWriter;
1358
1359 // We use uint64_t in the bit-fields below since some bit-fields
1360 // cross the unsigned boundary and this breaks the packing.
1361
1362 /// Stores the bits used by DeclContext.
1363 /// If modified NumDeclContextBit, the ctor of DeclContext and the accessor
1364 /// methods in DeclContext should be updated appropriately.
1365 class DeclContextBitfields {
1366 friend class DeclContext;
1367 /// DeclKind - This indicates which class this is.
1368 uint64_t DeclKind : 7;
1369
1370 /// Whether this declaration context also has some external
1371 /// storage that contains additional declarations that are lexically
1372 /// part of this context.
1373 mutable uint64_t ExternalLexicalStorage : 1;
1374
1375 /// Whether this declaration context also has some external
1376 /// storage that contains additional declarations that are visible
1377 /// in this context.
1378 mutable uint64_t ExternalVisibleStorage : 1;
1379
1380 /// Whether this declaration context has had externally visible
1381 /// storage added since the last lookup. In this case, \c LookupPtr's
1382 /// invariant may not hold and needs to be fixed before we perform
1383 /// another lookup.
1384 mutable uint64_t NeedToReconcileExternalVisibleStorage : 1;
1385
1386 /// If \c true, this context may have local lexical declarations
1387 /// that are missing from the lookup table.
1388 mutable uint64_t HasLazyLocalLexicalLookups : 1;
1389
1390 /// If \c true, the external source may have lexical declarations
1391 /// that are missing from the lookup table.
1392 mutable uint64_t HasLazyExternalLexicalLookups : 1;
1393
1394 /// If \c true, lookups should only return identifier from
1395 /// DeclContext scope (for example TranslationUnit). Used in
1396 /// LookupQualifiedName()
1397 mutable uint64_t UseQualifiedLookup : 1;
1398 };
1399
1400 /// Number of bits in DeclContextBitfields.
1401 enum { NumDeclContextBits = 13 };
1402
1403 /// Stores the bits used by TagDecl.
1404 /// If modified NumTagDeclBits and the accessor
1405 /// methods in TagDecl should be updated appropriately.
1406 class TagDeclBitfields {
1407 friend class TagDecl;
1408 /// For the bits in DeclContextBitfields
1409 uint64_t : NumDeclContextBits;
1410
1411 /// The TagKind enum.
1412 uint64_t TagDeclKind : 3;
1413
1414 /// True if this is a definition ("struct foo {};"), false if it is a
1415 /// declaration ("struct foo;"). It is not considered a definition
1416 /// until the definition has been fully processed.
1417 uint64_t IsCompleteDefinition : 1;
1418
1419 /// True if this is currently being defined.
1420 uint64_t IsBeingDefined : 1;
1421
1422 /// True if this tag declaration is "embedded" (i.e., defined or declared
1423 /// for the very first time) in the syntax of a declarator.
1424 uint64_t IsEmbeddedInDeclarator : 1;
1425
1426 /// True if this tag is free standing, e.g. "struct foo;".
1427 uint64_t IsFreeStanding : 1;
1428
1429 /// Indicates whether it is possible for declarations of this kind
1430 /// to have an out-of-date definition.
1431 ///
1432 /// This option is only enabled when modules are enabled.
1433 uint64_t MayHaveOutOfDateDef : 1;
1434
1435 /// Has the full definition of this type been required by a use somewhere in
1436 /// the TU.
1437 uint64_t IsCompleteDefinitionRequired : 1;
1438 };
1439
1440 /// Number of non-inherited bits in TagDeclBitfields.
1441 enum { NumTagDeclBits = 9 };
1442
1443 /// Stores the bits used by EnumDecl.
1444 /// If modified NumEnumDeclBit and the accessor
1445 /// methods in EnumDecl should be updated appropriately.
1446 class EnumDeclBitfields {
1447 friend class EnumDecl;
1448 /// For the bits in DeclContextBitfields.
1449 uint64_t : NumDeclContextBits;
1450 /// For the bits in TagDeclBitfields.
1451 uint64_t : NumTagDeclBits;
1452
1453 /// Width in bits required to store all the non-negative
1454 /// enumerators of this enum.
1455 uint64_t NumPositiveBits : 8;
1456
1457 /// Width in bits required to store all the negative
1458 /// enumerators of this enum.
1459 uint64_t NumNegativeBits : 8;
1460
1461 /// True if this tag declaration is a scoped enumeration. Only
1462 /// possible in C++11 mode.
1463 uint64_t IsScoped : 1;
1464
1465 /// If this tag declaration is a scoped enum,
1466 /// then this is true if the scoped enum was declared using the class
1467 /// tag, false if it was declared with the struct tag. No meaning is
1468 /// associated if this tag declaration is not a scoped enum.
1469 uint64_t IsScopedUsingClassTag : 1;
1470
1471 /// True if this is an enumeration with fixed underlying type. Only
1472 /// possible in C++11, Microsoft extensions, or Objective C mode.
1473 uint64_t IsFixed : 1;
1474
1475 /// True if a valid hash is stored in ODRHash.
1476 uint64_t HasODRHash : 1;
1477 };
1478
1479 /// Number of non-inherited bits in EnumDeclBitfields.
1480 enum { NumEnumDeclBits = 20 };
1481
1482 /// Stores the bits used by RecordDecl.
1483 /// If modified NumRecordDeclBits and the accessor
1484 /// methods in RecordDecl should be updated appropriately.
1485 class RecordDeclBitfields {
1486 friend class RecordDecl;
1487 /// For the bits in DeclContextBitfields.
1488 uint64_t : NumDeclContextBits;
1489 /// For the bits in TagDeclBitfields.
1490 uint64_t : NumTagDeclBits;
1491
1492 /// This is true if this struct ends with a flexible
1493 /// array member (e.g. int X[]) or if this union contains a struct that does.
1494 /// If so, this cannot be contained in arrays or other structs as a member.
1495 uint64_t HasFlexibleArrayMember : 1;
1496
1497 /// Whether this is the type of an anonymous struct or union.
1498 uint64_t AnonymousStructOrUnion : 1;
1499
1500 /// This is true if this struct has at least one member
1501 /// containing an Objective-C object pointer type.
1502 uint64_t HasObjectMember : 1;
1503
1504 /// This is true if struct has at least one member of
1505 /// 'volatile' type.
1506 uint64_t HasVolatileMember : 1;
1507
1508 /// Whether the field declarations of this record have been loaded
1509 /// from external storage. To avoid unnecessary deserialization of
1510 /// methods/nested types we allow deserialization of just the fields
1511 /// when needed.
1512 mutable uint64_t LoadedFieldsFromExternalStorage : 1;
1513
1514 /// Basic properties of non-trivial C structs.
1515 uint64_t NonTrivialToPrimitiveDefaultInitialize : 1;
1516 uint64_t NonTrivialToPrimitiveCopy : 1;
1517 uint64_t NonTrivialToPrimitiveDestroy : 1;
1518
1519 /// The following bits indicate whether this is or contains a C union that
1520 /// is non-trivial to default-initialize, destruct, or copy. These bits
1521 /// imply the associated basic non-triviality predicates declared above.
1522 uint64_t HasNonTrivialToPrimitiveDefaultInitializeCUnion : 1;
1523 uint64_t HasNonTrivialToPrimitiveDestructCUnion : 1;
1524 uint64_t HasNonTrivialToPrimitiveCopyCUnion : 1;
1525
1526 /// Indicates whether this struct is destroyed in the callee.
1527 uint64_t ParamDestroyedInCallee : 1;
1528
1529 /// Represents the way this type is passed to a function.
1530 uint64_t ArgPassingRestrictions : 2;
1531 };
1532
1533 /// Number of non-inherited bits in RecordDeclBitfields.
1534 enum { NumRecordDeclBits = 14 };
1535
1536 /// Stores the bits used by OMPDeclareReductionDecl.
1537 /// If modified NumOMPDeclareReductionDeclBits and the accessor
1538 /// methods in OMPDeclareReductionDecl should be updated appropriately.
1539 class OMPDeclareReductionDeclBitfields {
1540 friend class OMPDeclareReductionDecl;
1541 /// For the bits in DeclContextBitfields
1542 uint64_t : NumDeclContextBits;
1543
1544 /// Kind of initializer,
1545 /// function call or omp_priv<init_expr> initializtion.
1546 uint64_t InitializerKind : 2;
1547 };
1548
1549 /// Number of non-inherited bits in OMPDeclareReductionDeclBitfields.
1550 enum { NumOMPDeclareReductionDeclBits = 2 };
1551
1552 /// Stores the bits used by FunctionDecl.
1553 /// If modified NumFunctionDeclBits and the accessor
1554 /// methods in FunctionDecl and CXXDeductionGuideDecl
1555 /// (for IsCopyDeductionCandidate) should be updated appropriately.
1556 class FunctionDeclBitfields {
1557 friend class FunctionDecl;
1558 /// For IsCopyDeductionCandidate
1559 friend class CXXDeductionGuideDecl;
1560 /// For the bits in DeclContextBitfields.
1561 uint64_t : NumDeclContextBits;
1562
1563 uint64_t SClass : 3;
1564 uint64_t IsInline : 1;
1565 uint64_t IsInlineSpecified : 1;
1566
1567 uint64_t IsVirtualAsWritten : 1;
1568 uint64_t IsPure : 1;
1569 uint64_t HasInheritedPrototype : 1;
1570 uint64_t HasWrittenPrototype : 1;
1571 uint64_t IsDeleted : 1;
1572 /// Used by CXXMethodDecl
1573 uint64_t IsTrivial : 1;
1574
1575 /// This flag indicates whether this function is trivial for the purpose of
1576 /// calls. This is meaningful only when this function is a copy/move
1577 /// constructor or a destructor.
1578 uint64_t IsTrivialForCall : 1;
1579
1580 uint64_t IsDefaulted : 1;
1581 uint64_t IsExplicitlyDefaulted : 1;
1582 uint64_t HasDefaultedFunctionInfo : 1;
1583 uint64_t HasImplicitReturnZero : 1;
1584 uint64_t IsLateTemplateParsed : 1;
1585
1586 /// Kind of contexpr specifier as defined by ConstexprSpecKind.
1587 uint64_t ConstexprKind : 2;
1588 uint64_t InstantiationIsPending : 1;
1589
1590 /// Indicates if the function uses __try.
1591 uint64_t UsesSEHTry : 1;
1592
1593 /// Indicates if the function was a definition
1594 /// but its body was skipped.
1595 uint64_t HasSkippedBody : 1;
1596
1597 /// Indicates if the function declaration will
1598 /// have a body, once we're done parsing it.
1599 uint64_t WillHaveBody : 1;
1600
1601 /// Indicates that this function is a multiversioned
1602 /// function using attribute 'target'.
1603 uint64_t IsMultiVersion : 1;
1604
1605 /// [C++17] Only used by CXXDeductionGuideDecl. Indicates that
1606 /// the Deduction Guide is the implicitly generated 'copy
1607 /// deduction candidate' (is used during overload resolution).
1608 uint64_t IsCopyDeductionCandidate : 1;
1609
1610 /// Store the ODRHash after first calculation.
1611 uint64_t HasODRHash : 1;
1612
1613 /// Indicates if the function uses Floating Point Constrained Intrinsics
1614 uint64_t UsesFPIntrin : 1;
1615 };
1616
1617 /// Number of non-inherited bits in FunctionDeclBitfields.
1618 enum { NumFunctionDeclBits = 27 };
1619
1620 /// Stores the bits used by CXXConstructorDecl. If modified
1621 /// NumCXXConstructorDeclBits and the accessor
1622 /// methods in CXXConstructorDecl should be updated appropriately.
1623 class CXXConstructorDeclBitfields {
1624 friend class CXXConstructorDecl;
1625 /// For the bits in DeclContextBitfields.
1626 uint64_t : NumDeclContextBits;
1627 /// For the bits in FunctionDeclBitfields.
1628 uint64_t : NumFunctionDeclBits;
1629
1630 /// 24 bits to fit in the remaining available space.
1631 /// Note that this makes CXXConstructorDeclBitfields take
1632 /// exactly 64 bits and thus the width of NumCtorInitializers
1633 /// will need to be shrunk if some bit is added to NumDeclContextBitfields,
1634 /// NumFunctionDeclBitfields or CXXConstructorDeclBitfields.
1635 uint64_t NumCtorInitializers : 21;
1636 uint64_t IsInheritingConstructor : 1;
1637
1638 /// Whether this constructor has a trail-allocated explicit specifier.
1639 uint64_t HasTrailingExplicitSpecifier : 1;
1640 /// If this constructor does't have a trail-allocated explicit specifier.
1641 /// Whether this constructor is explicit specified.
1642 uint64_t IsSimpleExplicit : 1;
1643 };
1644
1645 /// Number of non-inherited bits in CXXConstructorDeclBitfields.
1646 enum {
1647 NumCXXConstructorDeclBits = 64 - NumDeclContextBits - NumFunctionDeclBits
1648 };
1649
1650 /// Stores the bits used by ObjCMethodDecl.
1651 /// If modified NumObjCMethodDeclBits and the accessor
1652 /// methods in ObjCMethodDecl should be updated appropriately.
1653 class ObjCMethodDeclBitfields {
1654 friend class ObjCMethodDecl;
1655
1656 /// For the bits in DeclContextBitfields.
1657 uint64_t : NumDeclContextBits;
1658
1659 /// The conventional meaning of this method; an ObjCMethodFamily.
1660 /// This is not serialized; instead, it is computed on demand and
1661 /// cached.
1662 mutable uint64_t Family : ObjCMethodFamilyBitWidth;
1663
1664 /// instance (true) or class (false) method.
1665 uint64_t IsInstance : 1;
1666 uint64_t IsVariadic : 1;
1667
1668 /// True if this method is the getter or setter for an explicit property.
1669 uint64_t IsPropertyAccessor : 1;
1670
1671 /// True if this method is a synthesized property accessor stub.
1672 uint64_t IsSynthesizedAccessorStub : 1;
1673
1674 /// Method has a definition.
1675 uint64_t IsDefined : 1;
1676
1677 /// Method redeclaration in the same interface.
1678 uint64_t IsRedeclaration : 1;
1679
1680 /// Is redeclared in the same interface.
1681 mutable uint64_t HasRedeclaration : 1;
1682
1683 /// \@required/\@optional
1684 uint64_t DeclImplementation : 2;
1685
1686 /// in, inout, etc.
1687 uint64_t objcDeclQualifier : 7;
1688
1689 /// Indicates whether this method has a related result type.
1690 uint64_t RelatedResultType : 1;
1691
1692 /// Whether the locations of the selector identifiers are in a
1693 /// "standard" position, a enum SelectorLocationsKind.
1694 uint64_t SelLocsKind : 2;
1695
1696 /// Whether this method overrides any other in the class hierarchy.
1697 ///
1698 /// A method is said to override any method in the class's
1699 /// base classes, its protocols, or its categories' protocols, that has
1700 /// the same selector and is of the same kind (class or instance).
1701 /// A method in an implementation is not considered as overriding the same
1702 /// method in the interface or its categories.
1703 uint64_t IsOverriding : 1;
1704
1705 /// Indicates if the method was a definition but its body was skipped.
1706 uint64_t HasSkippedBody : 1;
1707 };
1708
1709 /// Number of non-inherited bits in ObjCMethodDeclBitfields.
1710 enum { NumObjCMethodDeclBits = 24 };
1711
1712 /// Stores the bits used by ObjCContainerDecl.
1713 /// If modified NumObjCContainerDeclBits and the accessor
1714 /// methods in ObjCContainerDecl should be updated appropriately.
1715 class ObjCContainerDeclBitfields {
1716 friend class ObjCContainerDecl;
1717 /// For the bits in DeclContextBitfields
1718 uint32_t : NumDeclContextBits;
1719
1720 // Not a bitfield but this saves space.
1721 // Note that ObjCContainerDeclBitfields is full.
1722 SourceLocation AtStart;
1723 };
1724
1725 /// Number of non-inherited bits in ObjCContainerDeclBitfields.
1726 /// Note that here we rely on the fact that SourceLocation is 32 bits
1727 /// wide. We check this with the static_assert in the ctor of DeclContext.
1728 enum { NumObjCContainerDeclBits = 64 - NumDeclContextBits };
1729
1730 /// Stores the bits used by LinkageSpecDecl.
1731 /// If modified NumLinkageSpecDeclBits and the accessor
1732 /// methods in LinkageSpecDecl should be updated appropriately.
1733 class LinkageSpecDeclBitfields {
1734 friend class LinkageSpecDecl;
1735 /// For the bits in DeclContextBitfields.
1736 uint64_t : NumDeclContextBits;
1737
1738 /// The language for this linkage specification with values
1739 /// in the enum LinkageSpecDecl::LanguageIDs.
1740 uint64_t Language : 3;
1741
1742 /// True if this linkage spec has braces.
1743 /// This is needed so that hasBraces() returns the correct result while the
1744 /// linkage spec body is being parsed. Once RBraceLoc has been set this is
1745 /// not used, so it doesn't need to be serialized.
1746 uint64_t HasBraces : 1;
1747 };
1748
1749 /// Number of non-inherited bits in LinkageSpecDeclBitfields.
1750 enum { NumLinkageSpecDeclBits = 4 };
1751
1752 /// Stores the bits used by BlockDecl.
1753 /// If modified NumBlockDeclBits and the accessor
1754 /// methods in BlockDecl should be updated appropriately.
1755 class BlockDeclBitfields {
1756 friend class BlockDecl;
1757 /// For the bits in DeclContextBitfields.
1758 uint64_t : NumDeclContextBits;
1759
1760 uint64_t IsVariadic : 1;
1761 uint64_t CapturesCXXThis : 1;
1762 uint64_t BlockMissingReturnType : 1;
1763 uint64_t IsConversionFromLambda : 1;
1764
1765 /// A bit that indicates this block is passed directly to a function as a
1766 /// non-escaping parameter.
1767 uint64_t DoesNotEscape : 1;
1768
1769 /// A bit that indicates whether it's possible to avoid coying this block to
1770 /// the heap when it initializes or is assigned to a local variable with
1771 /// automatic storage.
1772 uint64_t CanAvoidCopyToHeap : 1;
1773 };
1774
1775 /// Number of non-inherited bits in BlockDeclBitfields.
1776 enum { NumBlockDeclBits = 5 };
1777
1778 /// Pointer to the data structure used to lookup declarations
1779 /// within this context (or a DependentStoredDeclsMap if this is a
1780 /// dependent context). We maintain the invariant that, if the map
1781 /// contains an entry for a DeclarationName (and we haven't lazily
1782 /// omitted anything), then it contains all relevant entries for that
1783 /// name (modulo the hasExternalDecls() flag).
1784 mutable StoredDeclsMap *LookupPtr = nullptr;
1785
1786protected:
1787 /// This anonymous union stores the bits belonging to DeclContext and classes
1788 /// deriving from it. The goal is to use otherwise wasted
1789 /// space in DeclContext to store data belonging to derived classes.
1790 /// The space saved is especially significient when pointers are aligned
1791 /// to 8 bytes. In this case due to alignment requirements we have a
1792 /// little less than 8 bytes free in DeclContext which we can use.
1793 /// We check that none of the classes in this union is larger than
1794 /// 8 bytes with static_asserts in the ctor of DeclContext.
1795 union {
1796 DeclContextBitfields DeclContextBits;
1797 TagDeclBitfields TagDeclBits;
1798 EnumDeclBitfields EnumDeclBits;
1799 RecordDeclBitfields RecordDeclBits;
1800 OMPDeclareReductionDeclBitfields OMPDeclareReductionDeclBits;
1801 FunctionDeclBitfields FunctionDeclBits;
1802 CXXConstructorDeclBitfields CXXConstructorDeclBits;
1803 ObjCMethodDeclBitfields ObjCMethodDeclBits;
1804 ObjCContainerDeclBitfields ObjCContainerDeclBits;
1805 LinkageSpecDeclBitfields LinkageSpecDeclBits;
1806 BlockDeclBitfields BlockDeclBits;
1807
1808 static_assert(sizeof(DeclContextBitfields) <= 8,
1809 "DeclContextBitfields is larger than 8 bytes!");
1810 static_assert(sizeof(TagDeclBitfields) <= 8,
1811 "TagDeclBitfields is larger than 8 bytes!");
1812 static_assert(sizeof(EnumDeclBitfields) <= 8,
1813 "EnumDeclBitfields is larger than 8 bytes!");
1814 static_assert(sizeof(RecordDeclBitfields) <= 8,
1815 "RecordDeclBitfields is larger than 8 bytes!");
1816 static_assert(sizeof(OMPDeclareReductionDeclBitfields) <= 8,
1817 "OMPDeclareReductionDeclBitfields is larger than 8 bytes!");
1818 static_assert(sizeof(FunctionDeclBitfields) <= 8,
1819 "FunctionDeclBitfields is larger than 8 bytes!");
1820 static_assert(sizeof(CXXConstructorDeclBitfields) <= 8,
1821 "CXXConstructorDeclBitfields is larger than 8 bytes!");
1822 static_assert(sizeof(ObjCMethodDeclBitfields) <= 8,
1823 "ObjCMethodDeclBitfields is larger than 8 bytes!");
1824 static_assert(sizeof(ObjCContainerDeclBitfields) <= 8,
1825 "ObjCContainerDeclBitfields is larger than 8 bytes!");
1826 static_assert(sizeof(LinkageSpecDeclBitfields) <= 8,
1827 "LinkageSpecDeclBitfields is larger than 8 bytes!");
1828 static_assert(sizeof(BlockDeclBitfields) <= 8,
1829 "BlockDeclBitfields is larger than 8 bytes!");
1830 };
1831
1832 /// FirstDecl - The first declaration stored within this declaration
1833 /// context.
1834 mutable Decl *FirstDecl = nullptr;
1835
1836 /// LastDecl - The last declaration stored within this declaration
1837 /// context. FIXME: We could probably cache this value somewhere
1838 /// outside of the DeclContext, to reduce the size of DeclContext by
1839 /// another pointer.
1840 mutable Decl *LastDecl = nullptr;
1841
1842 /// Build up a chain of declarations.
1843 ///
1844 /// \returns the first/last pair of declarations.
1845 static std::pair<Decl *, Decl *>
1846 BuildDeclChain(ArrayRef<Decl*> Decls, bool FieldsAlreadyLoaded);
1847
1848 DeclContext(Decl::Kind K);
1849
1850public:
1851 ~DeclContext();
1852
1853 Decl::Kind getDeclKind() const {
1854 return static_cast<Decl::Kind>(DeclContextBits.DeclKind);
1855 }
1856
1857 const char *getDeclKindName() const;
1858
1859 /// getParent - Returns the containing DeclContext.
1860 DeclContext *getParent() {
1861 return cast<Decl>(this)->getDeclContext();
1862 }
1863 const DeclContext *getParent() const {
1864 return const_cast<DeclContext*>(this)->getParent();
1865 }
1866
1867 /// getLexicalParent - Returns the containing lexical DeclContext. May be
1868 /// different from getParent, e.g.:
1869 ///
1870 /// namespace A {
1871 /// struct S;
1872 /// }
1873 /// struct A::S {}; // getParent() == namespace 'A'
1874 /// // getLexicalParent() == translation unit
1875 ///
1876 DeclContext *getLexicalParent() {
1877 return cast<Decl>(this)->getLexicalDeclContext();
1878 }
1879 const DeclContext *getLexicalParent() const {
1880 return const_cast<DeclContext*>(this)->getLexicalParent();
1881 }
1882
1883 DeclContext *getLookupParent();
1884
1885 const DeclContext *getLookupParent() const {
1886 return const_cast<DeclContext*>(this)->getLookupParent();
1887 }
1888
1889 ASTContext &getParentASTContext() const {
1890 return cast<Decl>(this)->getASTContext();
1891 }
1892
1893 bool isClosure() const { return getDeclKind() == Decl::Block; }
1894
1895 /// Return this DeclContext if it is a BlockDecl. Otherwise, return the
1896 /// innermost enclosing BlockDecl or null if there are no enclosing blocks.
1897 const BlockDecl *getInnermostBlockDecl() const;
1898
1899 bool isObjCContainer() const {
1900 switch (getDeclKind()) {
1901 case Decl::ObjCCategory:
1902 case Decl::ObjCCategoryImpl:
1903 case Decl::ObjCImplementation:
1904 case Decl::ObjCInterface:
1905 case Decl::ObjCProtocol:
1906 return true;
1907 default:
1908 return false;
1909 }
1910 }
1911
1912 bool isFunctionOrMethod() const {
1913 switch (getDeclKind()) {
1914 case Decl::Block:
1915 case Decl::Captured:
1916 case Decl::ObjCMethod:
1917 return true;
1918 default:
1919 return getDeclKind() >= Decl::firstFunction &&
1920 getDeclKind() <= Decl::lastFunction;
1921 }
1922 }
1923
1924 /// Test whether the context supports looking up names.
1925 bool isLookupContext() const {
1926 return !isFunctionOrMethod() && getDeclKind() != Decl::LinkageSpec &&
1927 getDeclKind() != Decl::Export;
1928 }
1929
1930 bool isFileContext() const {
1931 return getDeclKind() == Decl::TranslationUnit ||
1932 getDeclKind() == Decl::Namespace;
1933 }
1934
1935 bool isTranslationUnit() const {
1936 return getDeclKind() == Decl::TranslationUnit;
1937 }
1938
1939 bool isRecord() const {
1940 return getDeclKind() >= Decl::firstRecord &&
1941 getDeclKind() <= Decl::lastRecord;
1942 }
1943
1944 bool isNamespace() const { return getDeclKind() == Decl::Namespace; }
1945
1946 bool isStdNamespace() const;
1947
1948 bool isInlineNamespace() const;
1949
1950 /// Determines whether this context is dependent on a
1951 /// template parameter.
1952 bool isDependentContext() const;
1953
1954 /// isTransparentContext - Determines whether this context is a
1955 /// "transparent" context, meaning that the members declared in this
1956 /// context are semantically declared in the nearest enclosing
1957 /// non-transparent (opaque) context but are lexically declared in
1958 /// this context. For example, consider the enumerators of an
1959 /// enumeration type:
1960 /// @code
1961 /// enum E {
1962 /// Val1
1963 /// };
1964 /// @endcode
1965 /// Here, E is a transparent context, so its enumerator (Val1) will
1966 /// appear (semantically) that it is in the same context of E.
1967 /// Examples of transparent contexts include: enumerations (except for
1968 /// C++0x scoped enums), and C++ linkage specifications.
1969 bool isTransparentContext() const;
1970
1971 /// Determines whether this context or some of its ancestors is a
1972 /// linkage specification context that specifies C linkage.
1973 bool isExternCContext() const;
1974
1975 /// Retrieve the nearest enclosing C linkage specification context.
1976 const LinkageSpecDecl *getExternCContext() const;
1977
1978 /// Determines whether this context or some of its ancestors is a
1979 /// linkage specification context that specifies C++ linkage.
1980 bool isExternCXXContext() const;
1981
1982 /// Determine whether this declaration context is equivalent
1983 /// to the declaration context DC.
1984 bool Equals(const DeclContext *DC) const {
1985 return DC && this->getPrimaryContext() == DC->getPrimaryContext();
1986 }
1987
1988 /// Determine whether this declaration context encloses the
1989 /// declaration context DC.
1990 bool Encloses(const DeclContext *DC) const;
1991
1992 /// Find the nearest non-closure ancestor of this context,
1993 /// i.e. the innermost semantic parent of this context which is not
1994 /// a closure. A context may be its own non-closure ancestor.
1995 Decl *getNonClosureAncestor();
1996 const Decl *getNonClosureAncestor() const {
1997 return const_cast<DeclContext*>(this)->getNonClosureAncestor();
1998 }
1999
2000 // Retrieve the nearest context that is not a transparent context.
2001 DeclContext *getNonTransparentContext();
2002 const DeclContext *getNonTransparentContext() const {
2003 return const_cast<DeclContext *>(this)->getNonTransparentContext();
2004 }
2005
2006 /// getPrimaryContext - There may be many different
2007 /// declarations of the same entity (including forward declarations
2008 /// of classes, multiple definitions of namespaces, etc.), each with
2009 /// a different set of declarations. This routine returns the
2010 /// "primary" DeclContext structure, which will contain the
2011 /// information needed to perform name lookup into this context.
2012 DeclContext *getPrimaryContext();
2013 const DeclContext *getPrimaryContext() const {
2014 return const_cast<DeclContext*>(this)->getPrimaryContext();
2015 }
2016
2017 /// getRedeclContext - Retrieve the context in which an entity conflicts with
2018 /// other entities of the same name, or where it is a redeclaration if the
2019 /// two entities are compatible. This skips through transparent contexts.
2020 DeclContext *getRedeclContext();
2021 const DeclContext *getRedeclContext() const {
2022 return const_cast<DeclContext *>(this)->getRedeclContext();
2023 }
2024
2025 /// Retrieve the nearest enclosing namespace context.
2026 DeclContext *getEnclosingNamespaceContext();
2027 const DeclContext *getEnclosingNamespaceContext() const {
2028 return const_cast<DeclContext *>(this)->getEnclosingNamespaceContext();
2029 }
2030
2031 /// Retrieve the outermost lexically enclosing record context.
2032 RecordDecl *getOuterLexicalRecordContext();
2033 const RecordDecl *getOuterLexicalRecordContext() const {
2034 return const_cast<DeclContext *>(this)->getOuterLexicalRecordContext();
2035 }
2036
2037 /// Test if this context is part of the enclosing namespace set of
2038 /// the context NS, as defined in C++0x [namespace.def]p9. If either context
2039 /// isn't a namespace, this is equivalent to Equals().
2040 ///
2041 /// The enclosing namespace set of a namespace is the namespace and, if it is
2042 /// inline, its enclosing namespace, recursively.
2043 bool InEnclosingNamespaceSetOf(const DeclContext *NS) const;
2044
2045 /// Collects all of the declaration contexts that are semantically
2046 /// connected to this declaration context.
2047 ///
2048 /// For declaration contexts that have multiple semantically connected but
2049 /// syntactically distinct contexts, such as C++ namespaces, this routine
2050 /// retrieves the complete set of such declaration contexts in source order.
2051 /// For example, given:
2052 ///
2053 /// \code
2054 /// namespace N {
2055 /// int x;
2056 /// }
2057 /// namespace N {
2058 /// int y;
2059 /// }
2060 /// \endcode
2061 ///
2062 /// The \c Contexts parameter will contain both definitions of N.
2063 ///
2064 /// \param Contexts Will be cleared and set to the set of declaration
2065 /// contexts that are semanticaly connected to this declaration context,
2066 /// in source order, including this context (which may be the only result,
2067 /// for non-namespace contexts).
2068 void collectAllContexts(SmallVectorImpl<DeclContext *> &Contexts);
2069
2070 /// decl_iterator - Iterates through the declarations stored
2071 /// within this context.
2072 class decl_iterator {
2073 /// Current - The current declaration.
2074 Decl *Current = nullptr;
2075
2076 public:
2077 using value_type = Decl *;
2078 using reference = const value_type &;
2079 using pointer = const value_type *;
2080 using iterator_category = std::forward_iterator_tag;
2081 using difference_type = std::ptrdiff_t;
2082
2083 decl_iterator() = default;
2084 explicit decl_iterator(Decl *C) : Current(C) {}
2085
2086 reference operator*() const { return Current; }
2087
2088 // This doesn't meet the iterator requirements, but it's convenient
2089 value_type operator->() const { return Current; }
2090
2091 decl_iterator& operator++() {
2092 Current = Current->getNextDeclInContext();
2093 return *this;
2094 }
2095
2096 decl_iterator operator++(int) {
2097 decl_iterator tmp(*this);
2098 ++(*this);
2099 return tmp;
2100 }
2101
2102 friend bool operator==(decl_iterator x, decl_iterator y) {
2103 return x.Current == y.Current;
2104 }
2105
2106 friend bool operator!=(decl_iterator x, decl_iterator y) {
2107 return x.Current != y.Current;
2108 }
2109 };
2110
2111 using decl_range = llvm::iterator_range<decl_iterator>;
2112
2113 /// decls_begin/decls_end - Iterate over the declarations stored in
2114 /// this context.
2115 decl_range decls() const { return decl_range(decls_begin(), decls_end()); }
2116 decl_iterator decls_begin() const;
2117 decl_iterator decls_end() const { return decl_iterator(); }
2118 bool decls_empty() const;
2119
2120 /// noload_decls_begin/end - Iterate over the declarations stored in this
2121 /// context that are currently loaded; don't attempt to retrieve anything
2122 /// from an external source.
2123 decl_range noload_decls() const {
2124 return decl_range(noload_decls_begin(), noload_decls_end());
2125 }
2126 decl_iterator noload_decls_begin() const { return decl_iterator(FirstDecl); }
2127 decl_iterator noload_decls_end() const { return decl_iterator(); }
2128
2129 /// specific_decl_iterator - Iterates over a subrange of
2130 /// declarations stored in a DeclContext, providing only those that
2131 /// are of type SpecificDecl (or a class derived from it). This
2132 /// iterator is used, for example, to provide iteration over just
2133 /// the fields within a RecordDecl (with SpecificDecl = FieldDecl).
2134 template<typename SpecificDecl>
2135 class specific_decl_iterator {
2136 /// Current - The current, underlying declaration iterator, which
2137 /// will either be NULL or will point to a declaration of
2138 /// type SpecificDecl.
2139 DeclContext::decl_iterator Current;
2140
2141 /// SkipToNextDecl - Advances the current position up to the next
2142 /// declaration of type SpecificDecl that also meets the criteria
2143 /// required by Acceptable.
2144 void SkipToNextDecl() {
2145 while (*Current && !isa<SpecificDecl>(*Current))
2146 ++Current;
2147 }
2148
2149 public:
2150 using value_type = SpecificDecl *;
2151 // TODO: Add reference and pointer types (with some appropriate proxy type)
2152 // if we ever have a need for them.
2153 using reference = void;
2154 using pointer = void;
2155 using difference_type =
2156 std::iterator_traits<DeclContext::decl_iterator>::difference_type;
2157 using iterator_category = std::forward_iterator_tag;
2158
2159 specific_decl_iterator() = default;
2160
2161 /// specific_decl_iterator - Construct a new iterator over a
2162 /// subset of the declarations the range [C,
2163 /// end-of-declarations). If A is non-NULL, it is a pointer to a
2164 /// member function of SpecificDecl that should return true for
2165 /// all of the SpecificDecl instances that will be in the subset
2166 /// of iterators. For example, if you want Objective-C instance
2167 /// methods, SpecificDecl will be ObjCMethodDecl and A will be
2168 /// &ObjCMethodDecl::isInstanceMethod.
2169 explicit specific_decl_iterator(DeclContext::decl_iterator C) : Current(C) {
2170 SkipToNextDecl();
2171 }
2172
2173 value_type operator*() const { return cast<SpecificDecl>(*Current); }
2174
2175 // This doesn't meet the iterator requirements, but it's convenient
2176 value_type operator->() const { return **this; }
2177
2178 specific_decl_iterator& operator++() {
2179 ++Current;
2180 SkipToNextDecl();
2181 return *this;
2182 }
2183
2184 specific_decl_iterator operator++(int) {
2185 specific_decl_iterator tmp(*this);
2186 ++(*this);
2187 return tmp;
2188 }
2189
2190 friend bool operator==(const specific_decl_iterator& x,
2191 const specific_decl_iterator& y) {
2192 return x.Current == y.Current;
2193 }
2194
2195 friend bool operator!=(const specific_decl_iterator& x,
2196 const specific_decl_iterator& y) {
2197 return x.Current != y.Current;
2198 }
2199 };
2200
2201 /// Iterates over a filtered subrange of declarations stored
2202 /// in a DeclContext.
2203 ///
2204 /// This iterator visits only those declarations that are of type
2205 /// SpecificDecl (or a class derived from it) and that meet some
2206 /// additional run-time criteria. This iterator is used, for
2207 /// example, to provide access to the instance methods within an
2208 /// Objective-C interface (with SpecificDecl = ObjCMethodDecl and
2209 /// Acceptable = ObjCMethodDecl::isInstanceMethod).
2210 template<typename SpecificDecl, bool (SpecificDecl::*Acceptable)() const>
2211 class filtered_decl_iterator {
2212 /// Current - The current, underlying declaration iterator, which
2213 /// will either be NULL or will point to a declaration of
2214 /// type SpecificDecl.
2215 DeclContext::decl_iterator Current;
2216
2217 /// SkipToNextDecl - Advances the current position up to the next
2218 /// declaration of type SpecificDecl that also meets the criteria
2219 /// required by Acceptable.
2220 void SkipToNextDecl() {
2221 while (*Current &&
2222 (!isa<SpecificDecl>(*Current) ||
2223 (Acceptable && !(cast<SpecificDecl>(*Current)->*Acceptable)())))
2224 ++Current;
2225 }
2226
2227 public:
2228 using value_type = SpecificDecl *;
2229 // TODO: Add reference and pointer types (with some appropriate proxy type)
2230 // if we ever have a need for them.
2231 using reference = void;
2232 using pointer = void;
2233 using difference_type =
2234 std::iterator_traits<DeclContext::decl_iterator>::difference_type;
2235 using iterator_category = std::forward_iterator_tag;
2236
2237 filtered_decl_iterator() = default;
2238
2239 /// filtered_decl_iterator - Construct a new iterator over a
2240 /// subset of the declarations the range [C,
2241 /// end-of-declarations). If A is non-NULL, it is a pointer to a
2242 /// member function of SpecificDecl that should return true for
2243 /// all of the SpecificDecl instances that will be in the subset
2244 /// of iterators. For example, if you want Objective-C instance
2245 /// methods, SpecificDecl will be ObjCMethodDecl and A will be
2246 /// &ObjCMethodDecl::isInstanceMethod.
2247 explicit filtered_decl_iterator(DeclContext::decl_iterator C) : Current(C) {
2248 SkipToNextDecl();
2249 }
2250
2251 value_type operator*() const { return cast<SpecificDecl>(*Current); }
2252 value_type operator->() const { return cast<SpecificDecl>(*Current); }
2253
2254 filtered_decl_iterator& operator++() {
2255 ++Current;
2256 SkipToNextDecl();
2257 return *this;
2258 }
2259
2260 filtered_decl_iterator operator++(int) {
2261 filtered_decl_iterator tmp(*this);
2262 ++(*this);
2263 return tmp;
2264 }
2265
2266 friend bool operator==(const filtered_decl_iterator& x,
2267 const filtered_decl_iterator& y) {
2268 return x.Current == y.Current;
2269 }
2270
2271 friend bool operator!=(const filtered_decl_iterator& x,
2272 const filtered_decl_iterator& y) {
2273 return x.Current != y.Current;
2274 }
2275 };
2276
2277 /// Add the declaration D into this context.
2278 ///
2279 /// This routine should be invoked when the declaration D has first
2280 /// been declared, to place D into the context where it was
2281 /// (lexically) defined. Every declaration must be added to one
2282 /// (and only one!) context, where it can be visited via
2283 /// [decls_begin(), decls_end()). Once a declaration has been added
2284 /// to its lexical context, the corresponding DeclContext owns the
2285 /// declaration.
2286 ///
2287 /// If D is also a NamedDecl, it will be made visible within its
2288 /// semantic context via makeDeclVisibleInContext.
2289 void addDecl(Decl *D);
2290
2291 /// Add the declaration D into this context, but suppress
2292 /// searches for external declarations with the same name.
2293 ///
2294 /// Although analogous in function to addDecl, this removes an
2295 /// important check. This is only useful if the Decl is being
2296 /// added in response to an external search; in all other cases,
2297 /// addDecl() is the right function to use.
2298 /// See the ASTImporter for use cases.
2299 void addDeclInternal(Decl *D);
2300
2301 /// Add the declaration D to this context without modifying
2302 /// any lookup tables.
2303 ///
2304 /// This is useful for some operations in dependent contexts where
2305 /// the semantic context might not be dependent; this basically
2306 /// only happens with friends.
2307 void addHiddenDecl(Decl *D);
2308
2309 /// Removes a declaration from this context.
2310 void removeDecl(Decl *D);
2311
2312 /// Checks whether a declaration is in this context.
2313 bool containsDecl(Decl *D) const;
2314
2315 /// Checks whether a declaration is in this context.
2316 /// This also loads the Decls from the external source before the check.
2317 bool containsDeclAndLoad(Decl *D) const;
2318
2319 using lookup_result = DeclContextLookupResult;
2320 using lookup_iterator = lookup_result::iterator;
2321
2322 /// lookup - Find the declarations (if any) with the given Name in
2323 /// this context. Returns a range of iterators that contains all of
2324 /// the declarations with this name, with object, function, member,
2325 /// and enumerator names preceding any tag name. Note that this
2326 /// routine will not look into parent contexts.
2327 lookup_result lookup(DeclarationName Name) const;
2328
2329 /// Find the declarations with the given name that are visible
2330 /// within this context; don't attempt to retrieve anything from an
2331 /// external source.
2332 lookup_result noload_lookup(DeclarationName Name);
2333
2334 /// A simplistic name lookup mechanism that performs name lookup
2335 /// into this declaration context without consulting the external source.
2336 ///
2337 /// This function should almost never be used, because it subverts the
2338 /// usual relationship between a DeclContext and the external source.
2339 /// See the ASTImporter for the (few, but important) use cases.
2340 ///
2341 /// FIXME: This is very inefficient; replace uses of it with uses of
2342 /// noload_lookup.
2343 void localUncachedLookup(DeclarationName Name,
2344 SmallVectorImpl<NamedDecl *> &Results);
2345
2346 /// Makes a declaration visible within this context.
2347 ///
2348 /// This routine makes the declaration D visible to name lookup
2349 /// within this context and, if this is a transparent context,
2350 /// within its parent contexts up to the first enclosing
2351 /// non-transparent context. Making a declaration visible within a
2352 /// context does not transfer ownership of a declaration, and a
2353 /// declaration can be visible in many contexts that aren't its
2354 /// lexical context.
2355 ///
2356 /// If D is a redeclaration of an existing declaration that is
2357 /// visible from this context, as determined by
2358 /// NamedDecl::declarationReplaces, the previous declaration will be
2359 /// replaced with D.
2360 void makeDeclVisibleInContext(NamedDecl *D);
2361
2362 /// all_lookups_iterator - An iterator that provides a view over the results
2363 /// of looking up every possible name.
2364 class all_lookups_iterator;
2365
2366 using lookups_range = llvm::iterator_range<all_lookups_iterator>;
2367
2368 lookups_range lookups() const;
2369 // Like lookups(), but avoids loading external declarations.
2370 // If PreserveInternalState, avoids building lookup data structures too.
2371 lookups_range noload_lookups(bool PreserveInternalState) const;
2372
2373 /// Iterators over all possible lookups within this context.
2374 all_lookups_iterator lookups_begin() const;
2375 all_lookups_iterator lookups_end() const;
2376
2377 /// Iterators over all possible lookups within this context that are
2378 /// currently loaded; don't attempt to retrieve anything from an external
2379 /// source.
2380 all_lookups_iterator noload_lookups_begin() const;
2381 all_lookups_iterator noload_lookups_end() const;
2382
2383 struct udir_iterator;
2384
2385 using udir_iterator_base =
2386 llvm::iterator_adaptor_base<udir_iterator, lookup_iterator,
2387 typename lookup_iterator::iterator_category,
2388 UsingDirectiveDecl *>;
2389
2390 struct udir_iterator : udir_iterator_base {
2391 udir_iterator(lookup_iterator I) : udir_iterator_base(I) {}
2392
2393 UsingDirectiveDecl *operator*() const;
2394 };
2395
2396 using udir_range = llvm::iterator_range<udir_iterator>;
2397
2398 udir_range using_directives() const;
2399
2400 // These are all defined in DependentDiagnostic.h.
2401 class ddiag_iterator;
2402
2403 using ddiag_range = llvm::iterator_range<DeclContext::ddiag_iterator>;
2404
2405 inline ddiag_range ddiags() const;
2406
2407 // Low-level accessors
2408
2409 /// Mark that there are external lexical declarations that we need
2410 /// to include in our lookup table (and that are not available as external
2411 /// visible lookups). These extra lookup results will be found by walking
2412 /// the lexical declarations of this context. This should be used only if
2413 /// setHasExternalLexicalStorage() has been called on any decl context for
2414 /// which this is the primary context.
2415 void setMustBuildLookupTable() {
2416 assert(this == getPrimaryContext() &&(static_cast <bool> (this == getPrimaryContext() &&
"should only be called on primary context") ? void (0) : __assert_fail
("this == getPrimaryContext() && \"should only be called on primary context\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 2417, __extension__ __PRETTY_FUNCTION__))
2417 "should only be called on primary context")(static_cast <bool> (this == getPrimaryContext() &&
"should only be called on primary context") ? void (0) : __assert_fail
("this == getPrimaryContext() && \"should only be called on primary context\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/DeclBase.h"
, 2417, __extension__ __PRETTY_FUNCTION__))
;
2418 DeclContextBits.HasLazyExternalLexicalLookups = true;
2419 }
2420
2421 /// Retrieve the internal representation of the lookup structure.
2422 /// This may omit some names if we are lazily building the structure.
2423 StoredDeclsMap *getLookupPtr() const { return LookupPtr; }
2424
2425 /// Ensure the lookup structure is fully-built and return it.
2426 StoredDeclsMap *buildLookup();
2427
2428 /// Whether this DeclContext has external storage containing
2429 /// additional declarations that are lexically in this context.
2430 bool hasExternalLexicalStorage() const {
2431 return DeclContextBits.ExternalLexicalStorage;
2432 }
2433
2434 /// State whether this DeclContext has external storage for
2435 /// declarations lexically in this context.
2436 void setHasExternalLexicalStorage(bool ES = true) const {
2437 DeclContextBits.ExternalLexicalStorage = ES;
2438 }
2439
2440 /// Whether this DeclContext has external storage containing
2441 /// additional declarations that are visible in this context.
2442 bool hasExternalVisibleStorage() const {
2443 return DeclContextBits.ExternalVisibleStorage;
2444 }
2445
2446 /// State whether this DeclContext has external storage for
2447 /// declarations visible in this context.
2448 void setHasExternalVisibleStorage(bool ES = true) const {
2449 DeclContextBits.ExternalVisibleStorage = ES;
2450 if (ES && LookupPtr)
2451 DeclContextBits.NeedToReconcileExternalVisibleStorage = true;
2452 }
2453
2454 /// Determine whether the given declaration is stored in the list of
2455 /// declarations lexically within this context.
2456 bool isDeclInLexicalTraversal(const Decl *D) const {
2457 return D && (D->NextInContextAndBits.getPointer() || D == FirstDecl ||
2458 D == LastDecl);
2459 }
2460
2461 bool setUseQualifiedLookup(bool use = true) const {
2462 bool old_value = DeclContextBits.UseQualifiedLookup;
2463 DeclContextBits.UseQualifiedLookup = use;
2464 return old_value;
2465 }
2466
2467 bool shouldUseQualifiedLookup() const {
2468 return DeclContextBits.UseQualifiedLookup;
2469 }
2470
2471 static bool classof(const Decl *D);
2472 static bool classof(const DeclContext *D) { return true; }
2473
2474 void dumpDeclContext() const;
2475 void dumpLookups() const;
2476 void dumpLookups(llvm::raw_ostream &OS, bool DumpDecls = false,
2477 bool Deserialize = false) const;
2478
2479private:
2480 /// Whether this declaration context has had externally visible
2481 /// storage added since the last lookup. In this case, \c LookupPtr's
2482 /// invariant may not hold and needs to be fixed before we perform
2483 /// another lookup.
2484 bool hasNeedToReconcileExternalVisibleStorage() const {
2485 return DeclContextBits.NeedToReconcileExternalVisibleStorage;
2486 }
2487
2488 /// State that this declaration context has had externally visible
2489 /// storage added since the last lookup. In this case, \c LookupPtr's
2490 /// invariant may not hold and needs to be fixed before we perform
2491 /// another lookup.
2492 void setNeedToReconcileExternalVisibleStorage(bool Need = true) const {
2493 DeclContextBits.NeedToReconcileExternalVisibleStorage = Need;
2494 }
2495
2496 /// If \c true, this context may have local lexical declarations
2497 /// that are missing from the lookup table.
2498 bool hasLazyLocalLexicalLookups() const {
2499 return DeclContextBits.HasLazyLocalLexicalLookups;
2500 }
2501
2502 /// If \c true, this context may have local lexical declarations
2503 /// that are missing from the lookup table.
2504 void setHasLazyLocalLexicalLookups(bool HasLLLL = true) const {
2505 DeclContextBits.HasLazyLocalLexicalLookups = HasLLLL;
2506 }
2507
2508 /// If \c true, the external source may have lexical declarations
2509 /// that are missing from the lookup table.
2510 bool hasLazyExternalLexicalLookups() const {
2511 return DeclContextBits.HasLazyExternalLexicalLookups;
2512 }
2513
2514 /// If \c true, the external source may have lexical declarations
2515 /// that are missing from the lookup table.
2516 void setHasLazyExternalLexicalLookups(bool HasLELL = true) const {
2517 DeclContextBits.HasLazyExternalLexicalLookups = HasLELL;
2518 }
2519
2520 void reconcileExternalVisibleStorage() const;
2521 bool LoadLexicalDeclsFromExternalStorage() const;
2522
2523 /// Makes a declaration visible within this context, but
2524 /// suppresses searches for external declarations with the same
2525 /// name.
2526 ///
2527 /// Analogous to makeDeclVisibleInContext, but for the exclusive
2528 /// use of addDeclInternal().
2529 void makeDeclVisibleInContextInternal(NamedDecl *D);
2530
2531 StoredDeclsMap *CreateStoredDeclsMap(ASTContext &C) const;
2532
2533 void loadLazyLocalLexicalLookups();
2534 void buildLookupImpl(DeclContext *DCtx, bool Internal);
2535 void makeDeclVisibleInContextWithFlags(NamedDecl *D, bool Internal,
2536 bool Rediscoverable);
2537 void makeDeclVisibleInContextImpl(NamedDecl *D, bool Internal);
2538};
2539
2540inline bool Decl::isTemplateParameter() const {
2541 return getKind() == TemplateTypeParm || getKind() == NonTypeTemplateParm ||
2542 getKind() == TemplateTemplateParm;
2543}
2544
2545// Specialization selected when ToTy is not a known subclass of DeclContext.
2546template <class ToTy,
2547 bool IsKnownSubtype = ::std::is_base_of<DeclContext, ToTy>::value>
2548struct cast_convert_decl_context {
2549 static const ToTy *doit(const DeclContext *Val) {
2550 return static_cast<const ToTy*>(Decl::castFromDeclContext(Val));
2551 }
2552
2553 static ToTy *doit(DeclContext *Val) {
2554 return static_cast<ToTy*>(Decl::castFromDeclContext(Val));
2555 }
2556};
2557
2558// Specialization selected when ToTy is a known subclass of DeclContext.
2559template <class ToTy>
2560struct cast_convert_decl_context<ToTy, true> {
2561 static const ToTy *doit(const DeclContext *Val) {
2562 return static_cast<const ToTy*>(Val);
2563 }
2564
2565 static ToTy *doit(DeclContext *Val) {
2566 return static_cast<ToTy*>(Val);
2567 }
2568};
2569
2570} // namespace clang
2571
2572namespace llvm {
2573
2574/// isa<T>(DeclContext*)
2575template <typename To>
2576struct isa_impl<To, ::clang::DeclContext> {
2577 static bool doit(const ::clang::DeclContext &Val) {
2578 return To::classofKind(Val.getDeclKind());
2579 }
2580};
2581
2582/// cast<T>(DeclContext*)
2583template<class ToTy>
2584struct cast_convert_val<ToTy,
2585 const ::clang::DeclContext,const ::clang::DeclContext> {
2586 static const ToTy &doit(const ::clang::DeclContext &Val) {
2587 return *::clang::cast_convert_decl_context<ToTy>::doit(&Val);
2588 }
2589};
2590
2591template<class ToTy>
2592struct cast_convert_val<ToTy, ::clang::DeclContext, ::clang::DeclContext> {
2593 static ToTy &doit(::clang::DeclContext &Val) {
2594 return *::clang::cast_convert_decl_context<ToTy>::doit(&Val);
2595 }
2596};
2597
2598template<class ToTy>
2599struct cast_convert_val<ToTy,
2600 const ::clang::DeclContext*, const ::clang::DeclContext*> {
2601 static const ToTy *doit(const ::clang::DeclContext *Val) {
2602 return ::clang::cast_convert_decl_context<ToTy>::doit(Val);
2603 }
2604};
2605
2606template<class ToTy>
2607struct cast_convert_val<ToTy, ::clang::DeclContext*, ::clang::DeclContext*> {
2608 static ToTy *doit(::clang::DeclContext *Val) {
2609 return ::clang::cast_convert_decl_context<ToTy>::doit(Val);
2610 }
2611};
2612
2613/// Implement cast_convert_val for Decl -> DeclContext conversions.
2614template<class FromTy>
2615struct cast_convert_val< ::clang::DeclContext, FromTy, FromTy> {
2616 static ::clang::DeclContext &doit(const FromTy &Val) {
2617 return *FromTy::castToDeclContext(&Val);
2618 }
2619};
2620
2621template<class FromTy>
2622struct cast_convert_val< ::clang::DeclContext, FromTy*, FromTy*> {
2623 static ::clang::DeclContext *doit(const FromTy *Val) {
2624 return FromTy::castToDeclContext(Val);
2625 }
2626};
2627
2628template<class FromTy>
2629struct cast_convert_val< const ::clang::DeclContext, FromTy, FromTy> {
2630 static const ::clang::DeclContext &doit(const FromTy &Val) {
2631 return *FromTy::castToDeclContext(&Val);
2632 }
2633};
2634
2635template<class FromTy>
2636struct cast_convert_val< const ::clang::DeclContext, FromTy*, FromTy*> {
2637 static const ::clang::DeclContext *doit(const FromTy *Val) {
2638 return FromTy::castToDeclContext(Val);
2639 }
2640};
2641
2642} // namespace llvm
2643
2644#endif // LLVM_CLANG_AST_DECLBASE_H

/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/Decl.h

1//===- Decl.h - Classes for representing declarations -----------*- 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 the Decl subclasses.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_CLANG_AST_DECL_H
14#define LLVM_CLANG_AST_DECL_H
15
16#include "clang/AST/APValue.h"
17#include "clang/AST/ASTContextAllocate.h"
18#include "clang/AST/DeclAccessPair.h"
19#include "clang/AST/DeclBase.h"
20#include "clang/AST/DeclarationName.h"
21#include "clang/AST/ExternalASTSource.h"
22#include "clang/AST/NestedNameSpecifier.h"
23#include "clang/AST/Redeclarable.h"
24#include "clang/AST/Type.h"
25#include "clang/Basic/AddressSpaces.h"
26#include "clang/Basic/Diagnostic.h"
27#include "clang/Basic/IdentifierTable.h"
28#include "clang/Basic/LLVM.h"
29#include "clang/Basic/Linkage.h"
30#include "clang/Basic/OperatorKinds.h"
31#include "clang/Basic/PartialDiagnostic.h"
32#include "clang/Basic/PragmaKinds.h"
33#include "clang/Basic/SourceLocation.h"
34#include "clang/Basic/Specifiers.h"
35#include "clang/Basic/Visibility.h"
36#include "llvm/ADT/APSInt.h"
37#include "llvm/ADT/ArrayRef.h"
38#include "llvm/ADT/Optional.h"
39#include "llvm/ADT/PointerIntPair.h"
40#include "llvm/ADT/PointerUnion.h"
41#include "llvm/ADT/StringRef.h"
42#include "llvm/ADT/iterator_range.h"
43#include "llvm/Support/Casting.h"
44#include "llvm/Support/Compiler.h"
45#include "llvm/Support/TrailingObjects.h"
46#include <cassert>
47#include <cstddef>
48#include <cstdint>
49#include <string>
50#include <utility>
51
52namespace clang {
53
54class ASTContext;
55struct ASTTemplateArgumentListInfo;
56class Attr;
57class CompoundStmt;
58class DependentFunctionTemplateSpecializationInfo;
59class EnumDecl;
60class Expr;
61class FunctionTemplateDecl;
62class FunctionTemplateSpecializationInfo;
63class FunctionTypeLoc;
64class LabelStmt;
65class MemberSpecializationInfo;
66class Module;
67class NamespaceDecl;
68class ParmVarDecl;
69class RecordDecl;
70class Stmt;
71class StringLiteral;
72class TagDecl;
73class TemplateArgumentList;
74class TemplateArgumentListInfo;
75class TemplateParameterList;
76class TypeAliasTemplateDecl;
77class TypeLoc;
78class UnresolvedSetImpl;
79class VarTemplateDecl;
80
81/// The top declaration context.
82class TranslationUnitDecl : public Decl,
83 public DeclContext,
84 public Redeclarable<TranslationUnitDecl> {
85 using redeclarable_base = Redeclarable<TranslationUnitDecl>;
86
87 TranslationUnitDecl *getNextRedeclarationImpl() override {
88 return getNextRedeclaration();
89 }
90
91 TranslationUnitDecl *getPreviousDeclImpl() override {
92 return getPreviousDecl();
93 }
94
95 TranslationUnitDecl *getMostRecentDeclImpl() override {
96 return getMostRecentDecl();
97 }
98
99 ASTContext &Ctx;
100
101 /// The (most recently entered) anonymous namespace for this
102 /// translation unit, if one has been created.
103 NamespaceDecl *AnonymousNamespace = nullptr;
104
105 explicit TranslationUnitDecl(ASTContext &ctx);
106
107 virtual void anchor();
108
109public:
110 using redecl_range = redeclarable_base::redecl_range;
111 using redecl_iterator = redeclarable_base::redecl_iterator;
112
113 using redeclarable_base::getMostRecentDecl;
114 using redeclarable_base::getPreviousDecl;
115 using redeclarable_base::isFirstDecl;
116 using redeclarable_base::redecls;
117 using redeclarable_base::redecls_begin;
118 using redeclarable_base::redecls_end;
119
120 ASTContext &getASTContext() const { return Ctx; }
121
122 NamespaceDecl *getAnonymousNamespace() const { return AnonymousNamespace; }
123 void setAnonymousNamespace(NamespaceDecl *D) { AnonymousNamespace = D; }
124
125 static TranslationUnitDecl *Create(ASTContext &C);
126
127 // Implement isa/cast/dyncast/etc.
128 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
129 static bool classofKind(Kind K) { return K == TranslationUnit; }
130 static DeclContext *castToDeclContext(const TranslationUnitDecl *D) {
131 return static_cast<DeclContext *>(const_cast<TranslationUnitDecl*>(D));
132 }
133 static TranslationUnitDecl *castFromDeclContext(const DeclContext *DC) {
134 return static_cast<TranslationUnitDecl *>(const_cast<DeclContext*>(DC));
135 }
136};
137
138/// Represents a `#pragma comment` line. Always a child of
139/// TranslationUnitDecl.
140class PragmaCommentDecl final
141 : public Decl,
142 private llvm::TrailingObjects<PragmaCommentDecl, char> {
143 friend class ASTDeclReader;
144 friend class ASTDeclWriter;
145 friend TrailingObjects;
146
147 PragmaMSCommentKind CommentKind;
148
149 PragmaCommentDecl(TranslationUnitDecl *TU, SourceLocation CommentLoc,
150 PragmaMSCommentKind CommentKind)
151 : Decl(PragmaComment, TU, CommentLoc), CommentKind(CommentKind) {}
152
153 virtual void anchor();
154
155public:
156 static PragmaCommentDecl *Create(const ASTContext &C, TranslationUnitDecl *DC,
157 SourceLocation CommentLoc,
158 PragmaMSCommentKind CommentKind,
159 StringRef Arg);
160 static PragmaCommentDecl *CreateDeserialized(ASTContext &C, unsigned ID,
161 unsigned ArgSize);
162
163 PragmaMSCommentKind getCommentKind() const { return CommentKind; }
164
165 StringRef getArg() const { return getTrailingObjects<char>(); }
166
167 // Implement isa/cast/dyncast/etc.
168 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
169 static bool classofKind(Kind K) { return K == PragmaComment; }
170};
171
172/// Represents a `#pragma detect_mismatch` line. Always a child of
173/// TranslationUnitDecl.
174class PragmaDetectMismatchDecl final
175 : public Decl,
176 private llvm::TrailingObjects<PragmaDetectMismatchDecl, char> {
177 friend class ASTDeclReader;
178 friend class ASTDeclWriter;
179 friend TrailingObjects;
180
181 size_t ValueStart;
182
183 PragmaDetectMismatchDecl(TranslationUnitDecl *TU, SourceLocation Loc,
184 size_t ValueStart)
185 : Decl(PragmaDetectMismatch, TU, Loc), ValueStart(ValueStart) {}
186
187 virtual void anchor();
188
189public:
190 static PragmaDetectMismatchDecl *Create(const ASTContext &C,
191 TranslationUnitDecl *DC,
192 SourceLocation Loc, StringRef Name,
193 StringRef Value);
194 static PragmaDetectMismatchDecl *
195 CreateDeserialized(ASTContext &C, unsigned ID, unsigned NameValueSize);
196
197 StringRef getName() const { return getTrailingObjects<char>(); }
198 StringRef getValue() const { return getTrailingObjects<char>() + ValueStart; }
199
200 // Implement isa/cast/dyncast/etc.
201 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
202 static bool classofKind(Kind K) { return K == PragmaDetectMismatch; }
203};
204
205/// Declaration context for names declared as extern "C" in C++. This
206/// is neither the semantic nor lexical context for such declarations, but is
207/// used to check for conflicts with other extern "C" declarations. Example:
208///
209/// \code
210/// namespace N { extern "C" void f(); } // #1
211/// void N::f() {} // #2
212/// namespace M { extern "C" void f(); } // #3
213/// \endcode
214///
215/// The semantic context of #1 is namespace N and its lexical context is the
216/// LinkageSpecDecl; the semantic context of #2 is namespace N and its lexical
217/// context is the TU. However, both declarations are also visible in the
218/// extern "C" context.
219///
220/// The declaration at #3 finds it is a redeclaration of \c N::f through
221/// lookup in the extern "C" context.
222class ExternCContextDecl : public Decl, public DeclContext {
223 explicit ExternCContextDecl(TranslationUnitDecl *TU)
224 : Decl(ExternCContext, TU, SourceLocation()),
225 DeclContext(ExternCContext) {}
226
227 virtual void anchor();
228
229public:
230 static ExternCContextDecl *Create(const ASTContext &C,
231 TranslationUnitDecl *TU);
232
233 // Implement isa/cast/dyncast/etc.
234 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
235 static bool classofKind(Kind K) { return K == ExternCContext; }
236 static DeclContext *castToDeclContext(const ExternCContextDecl *D) {
237 return static_cast<DeclContext *>(const_cast<ExternCContextDecl*>(D));
238 }
239 static ExternCContextDecl *castFromDeclContext(const DeclContext *DC) {
240 return static_cast<ExternCContextDecl *>(const_cast<DeclContext*>(DC));
241 }
242};
243
244/// This represents a decl that may have a name. Many decls have names such
245/// as ObjCMethodDecl, but not \@class, etc.
246///
247/// Note that not every NamedDecl is actually named (e.g., a struct might
248/// be anonymous), and not every name is an identifier.
249class NamedDecl : public Decl {
250 /// The name of this declaration, which is typically a normal
251 /// identifier but may also be a special kind of name (C++
252 /// constructor, Objective-C selector, etc.)
253 DeclarationName Name;
254
255 virtual void anchor();
256
257private:
258 NamedDecl *getUnderlyingDeclImpl() LLVM_READONLY__attribute__((__pure__));
259
260protected:
261 NamedDecl(Kind DK, DeclContext *DC, SourceLocation L, DeclarationName N)
262 : Decl(DK, DC, L), Name(N) {}
263
264public:
265 /// Get the identifier that names this declaration, if there is one.
266 ///
267 /// This will return NULL if this declaration has no name (e.g., for
268 /// an unnamed class) or if the name is a special name (C++ constructor,
269 /// Objective-C selector, etc.).
270 IdentifierInfo *getIdentifier() const { return Name.getAsIdentifierInfo(); }
271
272 /// Get the name of identifier for this declaration as a StringRef.
273 ///
274 /// This requires that the declaration have a name and that it be a simple
275 /// identifier.
276 StringRef getName() const {
277 assert(Name.isIdentifier() && "Name is not a simple identifier")(static_cast <bool> (Name.isIdentifier() && "Name is not a simple identifier"
) ? void (0) : __assert_fail ("Name.isIdentifier() && \"Name is not a simple identifier\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/Decl.h"
, 277, __extension__ __PRETTY_FUNCTION__))
;
278 return getIdentifier() ? getIdentifier()->getName() : "";
279 }
280
281 /// Get a human-readable name for the declaration, even if it is one of the
282 /// special kinds of names (C++ constructor, Objective-C selector, etc).
283 ///
284 /// Creating this name requires expensive string manipulation, so it should
285 /// be called only when performance doesn't matter. For simple declarations,
286 /// getNameAsCString() should suffice.
287 //
288 // FIXME: This function should be renamed to indicate that it is not just an
289 // alternate form of getName(), and clients should move as appropriate.
290 //
291 // FIXME: Deprecated, move clients to getName().
292 std::string getNameAsString() const { return Name.getAsString(); }
293
294 /// Pretty-print the unqualified name of this declaration. Can be overloaded
295 /// by derived classes to provide a more user-friendly name when appropriate.
296 virtual void printName(raw_ostream &os) const;
297
298 /// Get the actual, stored name of the declaration, which may be a special
299 /// name.
300 ///
301 /// Note that generally in diagnostics, the non-null \p NamedDecl* itself
302 /// should be sent into the diagnostic instead of using the result of
303 /// \p getDeclName().
304 ///
305 /// A \p DeclarationName in a diagnostic will just be streamed to the output,
306 /// which will directly result in a call to \p DeclarationName::print.
307 ///
308 /// A \p NamedDecl* in a diagnostic will also ultimately result in a call to
309 /// \p DeclarationName::print, but with two customisation points along the
310 /// way (\p getNameForDiagnostic and \p printName). These are used to print
311 /// the template arguments if any, and to provide a user-friendly name for
312 /// some entities (such as unnamed variables and anonymous records).
313 DeclarationName getDeclName() const { return Name; }
314
315 /// Set the name of this declaration.
316 void setDeclName(DeclarationName N) { Name = N; }
317
318 /// Returns a human-readable qualified name for this declaration, like
319 /// A::B::i, for i being member of namespace A::B.
320 ///
321 /// If the declaration is not a member of context which can be named (record,
322 /// namespace), it will return the same result as printName().
323 ///
324 /// Creating this name is expensive, so it should be called only when
325 /// performance doesn't matter.
326 void printQualifiedName(raw_ostream &OS) const;
327 void printQualifiedName(raw_ostream &OS, const PrintingPolicy &Policy) const;
328
329 /// Print only the nested name specifier part of a fully-qualified name,
330 /// including the '::' at the end. E.g.
331 /// when `printQualifiedName(D)` prints "A::B::i",
332 /// this function prints "A::B::".
333 void printNestedNameSpecifier(raw_ostream &OS) const;
334 void printNestedNameSpecifier(raw_ostream &OS,
335 const PrintingPolicy &Policy) const;
336
337 // FIXME: Remove string version.
338 std::string getQualifiedNameAsString() const;
339
340 /// Appends a human-readable name for this declaration into the given stream.
341 ///
342 /// This is the method invoked by Sema when displaying a NamedDecl
343 /// in a diagnostic. It does not necessarily produce the same
344 /// result as printName(); for example, class template
345 /// specializations are printed with their template arguments.
346 virtual void getNameForDiagnostic(raw_ostream &OS,
347 const PrintingPolicy &Policy,
348 bool Qualified) const;
349
350 /// Determine whether this declaration, if known to be well-formed within
351 /// its context, will replace the declaration OldD if introduced into scope.
352 ///
353 /// A declaration will replace another declaration if, for example, it is
354 /// a redeclaration of the same variable or function, but not if it is a
355 /// declaration of a different kind (function vs. class) or an overloaded
356 /// function.
357 ///
358 /// \param IsKnownNewer \c true if this declaration is known to be newer
359 /// than \p OldD (for instance, if this declaration is newly-created).
360 bool declarationReplaces(NamedDecl *OldD, bool IsKnownNewer = true) const;
361
362 /// Determine whether this declaration has linkage.
363 bool hasLinkage() const;
364
365 using Decl::isModulePrivate;
366 using Decl::setModulePrivate;
367
368 /// Determine whether this declaration is a C++ class member.
369 bool isCXXClassMember() const {
370 const DeclContext *DC = getDeclContext();
371
372 // C++0x [class.mem]p1:
373 // The enumerators of an unscoped enumeration defined in
374 // the class are members of the class.
375 if (isa<EnumDecl>(DC))
376 DC = DC->getRedeclContext();
377
378 return DC->isRecord();
379 }
380
381 /// Determine whether the given declaration is an instance member of
382 /// a C++ class.
383 bool isCXXInstanceMember() const;
384
385 /// Determine if the declaration obeys the reserved identifier rules of the
386 /// given language.
387 ReservedIdentifierStatus isReserved(const LangOptions &LangOpts) const;
388
389 /// Determine what kind of linkage this entity has.
390 ///
391 /// This is not the linkage as defined by the standard or the codegen notion
392 /// of linkage. It is just an implementation detail that is used to compute
393 /// those.
394 Linkage getLinkageInternal() const;
395
396 /// Get the linkage from a semantic point of view. Entities in
397 /// anonymous namespaces are external (in c++98).
398 Linkage getFormalLinkage() const {
399 return clang::getFormalLinkage(getLinkageInternal());
400 }
401
402 /// True if this decl has external linkage.
403 bool hasExternalFormalLinkage() const {
404 return isExternalFormalLinkage(getLinkageInternal());
405 }
406
407 bool isExternallyVisible() const {
408 return clang::isExternallyVisible(getLinkageInternal());
409 }
410
411 /// Determine whether this declaration can be redeclared in a
412 /// different translation unit.
413 bool isExternallyDeclarable() const {
414 return isExternallyVisible() && !getOwningModuleForLinkage();
415 }
416
417 /// Determines the visibility of this entity.
418 Visibility getVisibility() const {
419 return getLinkageAndVisibility().getVisibility();
420 }
421
422 /// Determines the linkage and visibility of this entity.
423 LinkageInfo getLinkageAndVisibility() const;
424
425 /// Kinds of explicit visibility.
426 enum ExplicitVisibilityKind {
427 /// Do an LV computation for, ultimately, a type.
428 /// Visibility may be restricted by type visibility settings and
429 /// the visibility of template arguments.
430 VisibilityForType,
431
432 /// Do an LV computation for, ultimately, a non-type declaration.
433 /// Visibility may be restricted by value visibility settings and
434 /// the visibility of template arguments.
435 VisibilityForValue
436 };
437
438 /// If visibility was explicitly specified for this
439 /// declaration, return that visibility.
440 Optional<Visibility>
441 getExplicitVisibility(ExplicitVisibilityKind kind) const;
442
443 /// True if the computed linkage is valid. Used for consistency
444 /// checking. Should always return true.
445 bool isLinkageValid() const;
446
447 /// True if something has required us to compute the linkage
448 /// of this declaration.
449 ///
450 /// Language features which can retroactively change linkage (like a
451 /// typedef name for linkage purposes) may need to consider this,
452 /// but hopefully only in transitory ways during parsing.
453 bool hasLinkageBeenComputed() const {
454 return hasCachedLinkage();
455 }
456
457 /// Looks through UsingDecls and ObjCCompatibleAliasDecls for
458 /// the underlying named decl.
459 NamedDecl *getUnderlyingDecl() {
460 // Fast-path the common case.
461 if (this->getKind() != UsingShadow &&
462 this->getKind() != ConstructorUsingShadow &&
463 this->getKind() != ObjCCompatibleAlias &&
464 this->getKind() != NamespaceAlias)
465 return this;
466
467 return getUnderlyingDeclImpl();
468 }
469 const NamedDecl *getUnderlyingDecl() const {
470 return const_cast<NamedDecl*>(this)->getUnderlyingDecl();
471 }
472
473 NamedDecl *getMostRecentDecl() {
474 return cast<NamedDecl>(static_cast<Decl *>(this)->getMostRecentDecl());
475 }
476 const NamedDecl *getMostRecentDecl() const {
477 return const_cast<NamedDecl*>(this)->getMostRecentDecl();
478 }
479
480 ObjCStringFormatFamily getObjCFStringFormattingFamily() const;
481
482 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
483 static bool classofKind(Kind K) { return K >= firstNamed && K <= lastNamed; }
484};
485
486inline raw_ostream &operator<<(raw_ostream &OS, const NamedDecl &ND) {
487 ND.printName(OS);
488 return OS;
489}
490
491/// Represents the declaration of a label. Labels also have a
492/// corresponding LabelStmt, which indicates the position that the label was
493/// defined at. For normal labels, the location of the decl is the same as the
494/// location of the statement. For GNU local labels (__label__), the decl
495/// location is where the __label__ is.
496class LabelDecl : public NamedDecl {
497 LabelStmt *TheStmt;
498 StringRef MSAsmName;
499 bool MSAsmNameResolved = false;
500
501 /// For normal labels, this is the same as the main declaration
502 /// label, i.e., the location of the identifier; for GNU local labels,
503 /// this is the location of the __label__ keyword.
504 SourceLocation LocStart;
505
506 LabelDecl(DeclContext *DC, SourceLocation IdentL, IdentifierInfo *II,
507 LabelStmt *S, SourceLocation StartL)
508 : NamedDecl(Label, DC, IdentL, II), TheStmt(S), LocStart(StartL) {}
509
510 void anchor() override;
511
512public:
513 static LabelDecl *Create(ASTContext &C, DeclContext *DC,
514 SourceLocation IdentL, IdentifierInfo *II);
515 static LabelDecl *Create(ASTContext &C, DeclContext *DC,
516 SourceLocation IdentL, IdentifierInfo *II,
517 SourceLocation GnuLabelL);
518 static LabelDecl *CreateDeserialized(ASTContext &C, unsigned ID);
519
520 LabelStmt *getStmt() const { return TheStmt; }
521 void setStmt(LabelStmt *T) { TheStmt = T; }
522
523 bool isGnuLocal() const { return LocStart != getLocation(); }
524 void setLocStart(SourceLocation L) { LocStart = L; }
525
526 SourceRange getSourceRange() const override LLVM_READONLY__attribute__((__pure__)) {
527 return SourceRange(LocStart, getLocation());
528 }
529
530 bool isMSAsmLabel() const { return !MSAsmName.empty(); }
531 bool isResolvedMSAsmLabel() const { return isMSAsmLabel() && MSAsmNameResolved; }
532 void setMSAsmLabel(StringRef Name);
533 StringRef getMSAsmLabel() const { return MSAsmName; }
534 void setMSAsmLabelResolved() { MSAsmNameResolved = true; }
535
536 // Implement isa/cast/dyncast/etc.
537 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
538 static bool classofKind(Kind K) { return K == Label; }
539};
540
541/// Represent a C++ namespace.
542class NamespaceDecl : public NamedDecl, public DeclContext,
543 public Redeclarable<NamespaceDecl>
544{
545 /// The starting location of the source range, pointing
546 /// to either the namespace or the inline keyword.
547 SourceLocation LocStart;
548
549 /// The ending location of the source range.
550 SourceLocation RBraceLoc;
551
552 /// A pointer to either the anonymous namespace that lives just inside
553 /// this namespace or to the first namespace in the chain (the latter case
554 /// only when this is not the first in the chain), along with a
555 /// boolean value indicating whether this is an inline namespace.
556 llvm::PointerIntPair<NamespaceDecl *, 1, bool> AnonOrFirstNamespaceAndInline;
557
558 NamespaceDecl(ASTContext &C, DeclContext *DC, bool Inline,
559 SourceLocation StartLoc, SourceLocation IdLoc,
560 IdentifierInfo *Id, NamespaceDecl *PrevDecl);
561
562 using redeclarable_base = Redeclarable<NamespaceDecl>;
563
564 NamespaceDecl *getNextRedeclarationImpl() override;
565 NamespaceDecl *getPreviousDeclImpl() override;
566 NamespaceDecl *getMostRecentDeclImpl() override;
567
568public:
569 friend class ASTDeclReader;
570 friend class ASTDeclWriter;
571
572 static NamespaceDecl *Create(ASTContext &C, DeclContext *DC,
573 bool Inline, SourceLocation StartLoc,
574 SourceLocation IdLoc, IdentifierInfo *Id,
575 NamespaceDecl *PrevDecl);
576
577 static NamespaceDecl *CreateDeserialized(ASTContext &C, unsigned ID);
578
579 using redecl_range = redeclarable_base::redecl_range;
580 using redecl_iterator = redeclarable_base::redecl_iterator;
581
582 using redeclarable_base::redecls_begin;
583 using redeclarable_base::redecls_end;
584 using redeclarable_base::redecls;
585 using redeclarable_base::getPreviousDecl;
586 using redeclarable_base::getMostRecentDecl;
587 using redeclarable_base::isFirstDecl;
588
589 /// Returns true if this is an anonymous namespace declaration.
590 ///
591 /// For example:
592 /// \code
593 /// namespace {
594 /// ...
595 /// };
596 /// \endcode
597 /// q.v. C++ [namespace.unnamed]
598 bool isAnonymousNamespace() const {
599 return !getIdentifier();
600 }
601
602 /// Returns true if this is an inline namespace declaration.
603 bool isInline() const {
604 return AnonOrFirstNamespaceAndInline.getInt();
605 }
606
607 /// Set whether this is an inline namespace declaration.
608 void setInline(bool Inline) {
609 AnonOrFirstNamespaceAndInline.setInt(Inline);
610 }
611
612 /// Returns true if the inline qualifier for \c Name is redundant.
613 bool isRedundantInlineQualifierFor(DeclarationName Name) const {
614 if (!isInline())
615 return false;
616 auto X = lookup(Name);
617 // We should not perform a lookup within a transparent context, so find a
618 // non-transparent parent context.
619 auto Y = getParent()->getNonTransparentContext()->lookup(Name);
620 return std::distance(X.begin(), X.end()) ==
621 std::distance(Y.begin(), Y.end());
622 }
623
624 /// Get the original (first) namespace declaration.
625 NamespaceDecl *getOriginalNamespace();
626
627 /// Get the original (first) namespace declaration.
628 const NamespaceDecl *getOriginalNamespace() const;
629
630 /// Return true if this declaration is an original (first) declaration
631 /// of the namespace. This is false for non-original (subsequent) namespace
632 /// declarations and anonymous namespaces.
633 bool isOriginalNamespace() const;
634
635 /// Retrieve the anonymous namespace nested inside this namespace,
636 /// if any.
637 NamespaceDecl *getAnonymousNamespace() const {
638 return getOriginalNamespace()->AnonOrFirstNamespaceAndInline.getPointer();
639 }
640
641 void setAnonymousNamespace(NamespaceDecl *D) {
642 getOriginalNamespace()->AnonOrFirstNamespaceAndInline.setPointer(D);
643 }
644
645 /// Retrieves the canonical declaration of this namespace.
646 NamespaceDecl *getCanonicalDecl() override {
647 return getOriginalNamespace();
648 }
649 const NamespaceDecl *getCanonicalDecl() const {
650 return getOriginalNamespace();
651 }
652
653 SourceRange getSourceRange() const override LLVM_READONLY__attribute__((__pure__)) {
654 return SourceRange(LocStart, RBraceLoc);
655 }
656
657 SourceLocation getBeginLoc() const LLVM_READONLY__attribute__((__pure__)) { return LocStart; }
658 SourceLocation getRBraceLoc() const { return RBraceLoc; }
659 void setLocStart(SourceLocation L) { LocStart = L; }
660 void setRBraceLoc(SourceLocation L) { RBraceLoc = L; }
661
662 // Implement isa/cast/dyncast/etc.
663 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
664 static bool classofKind(Kind K) { return K == Namespace; }
665 static DeclContext *castToDeclContext(const NamespaceDecl *D) {
666 return static_cast<DeclContext *>(const_cast<NamespaceDecl*>(D));
667 }
668 static NamespaceDecl *castFromDeclContext(const DeclContext *DC) {
669 return static_cast<NamespaceDecl *>(const_cast<DeclContext*>(DC));
670 }
671};
672
673/// Represent the declaration of a variable (in which case it is
674/// an lvalue) a function (in which case it is a function designator) or
675/// an enum constant.
676class ValueDecl : public NamedDecl {
677 QualType DeclType;
678
679 void anchor() override;
680
681protected:
682 ValueDecl(Kind DK, DeclContext *DC, SourceLocation L,
683 DeclarationName N, QualType T)
684 : NamedDecl(DK, DC, L, N), DeclType(T) {}
685
686public:
687 QualType getType() const { return DeclType; }
688 void setType(QualType newType) { DeclType = newType; }
689
690 /// Determine whether this symbol is weakly-imported,
691 /// or declared with the weak or weak-ref attr.
692 bool isWeak() const;
693
694 // Implement isa/cast/dyncast/etc.
695 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
696 static bool classofKind(Kind K) { return K >= firstValue && K <= lastValue; }
697};
698
699/// A struct with extended info about a syntactic
700/// name qualifier, to be used for the case of out-of-line declarations.
701struct QualifierInfo {
702 NestedNameSpecifierLoc QualifierLoc;
703
704 /// The number of "outer" template parameter lists.
705 /// The count includes all of the template parameter lists that were matched
706 /// against the template-ids occurring into the NNS and possibly (in the
707 /// case of an explicit specialization) a final "template <>".
708 unsigned NumTemplParamLists = 0;
709
710 /// A new-allocated array of size NumTemplParamLists,
711 /// containing pointers to the "outer" template parameter lists.
712 /// It includes all of the template parameter lists that were matched
713 /// against the template-ids occurring into the NNS and possibly (in the
714 /// case of an explicit specialization) a final "template <>".
715 TemplateParameterList** TemplParamLists = nullptr;
716
717 QualifierInfo() = default;
718 QualifierInfo(const QualifierInfo &) = delete;
719 QualifierInfo& operator=(const QualifierInfo &) = delete;
720
721 /// Sets info about "outer" template parameter lists.
722 void setTemplateParameterListsInfo(ASTContext &Context,
723 ArrayRef<TemplateParameterList *> TPLists);
724};
725
726/// Represents a ValueDecl that came out of a declarator.
727/// Contains type source information through TypeSourceInfo.
728class DeclaratorDecl : public ValueDecl {
729 // A struct representing a TInfo, a trailing requires-clause and a syntactic
730 // qualifier, to be used for the (uncommon) case of out-of-line declarations
731 // and constrained function decls.
732 struct ExtInfo : public QualifierInfo {
733 TypeSourceInfo *TInfo;
734 Expr *TrailingRequiresClause = nullptr;
735 };
736
737 llvm::PointerUnion<TypeSourceInfo *, ExtInfo *> DeclInfo;
738
739 /// The start of the source range for this declaration,
740 /// ignoring outer template declarations.
741 SourceLocation InnerLocStart;
742
743 bool hasExtInfo() const { return DeclInfo.is<ExtInfo*>(); }
744 ExtInfo *getExtInfo() { return DeclInfo.get<ExtInfo*>(); }
745 const ExtInfo *getExtInfo() const { return DeclInfo.get<ExtInfo*>(); }
746
747protected:
748 DeclaratorDecl(Kind DK, DeclContext *DC, SourceLocation L,
749 DeclarationName N, QualType T, TypeSourceInfo *TInfo,
750 SourceLocation StartL)
751 : ValueDecl(DK, DC, L, N, T), DeclInfo(TInfo), InnerLocStart(StartL) {}
752
753public:
754 friend class ASTDeclReader;
755 friend class ASTDeclWriter;
756
757 TypeSourceInfo *getTypeSourceInfo() const {
758 return hasExtInfo()
759 ? getExtInfo()->TInfo
760 : DeclInfo.get<TypeSourceInfo*>();
761 }
762
763 void setTypeSourceInfo(TypeSourceInfo *TI) {
764 if (hasExtInfo())
765 getExtInfo()->TInfo = TI;
766 else
767 DeclInfo = TI;
768 }
769
770 /// Return start of source range ignoring outer template declarations.
771 SourceLocation getInnerLocStart() const { return InnerLocStart; }
772 void setInnerLocStart(SourceLocation L) { InnerLocStart = L; }
773
774 /// Return start of source range taking into account any outer template
775 /// declarations.
776 SourceLocation getOuterLocStart() const;
777
778 SourceRange getSourceRange() const override LLVM_READONLY__attribute__((__pure__));
779
780 SourceLocation getBeginLoc() const LLVM_READONLY__attribute__((__pure__)) {
781 return getOuterLocStart();
782 }
783
784 /// Retrieve the nested-name-specifier that qualifies the name of this
785 /// declaration, if it was present in the source.
786 NestedNameSpecifier *getQualifier() const {
787 return hasExtInfo() ? getExtInfo()->QualifierLoc.getNestedNameSpecifier()
788 : nullptr;
789 }
790
791 /// Retrieve the nested-name-specifier (with source-location
792 /// information) that qualifies the name of this declaration, if it was
793 /// present in the source.
794 NestedNameSpecifierLoc getQualifierLoc() const {
795 return hasExtInfo() ? getExtInfo()->QualifierLoc
796 : NestedNameSpecifierLoc();
797 }
798
799 void setQualifierInfo(NestedNameSpecifierLoc QualifierLoc);
800
801 /// \brief Get the constraint-expression introduced by the trailing
802 /// requires-clause in the function/member declaration, or null if no
803 /// requires-clause was provided.
804 Expr *getTrailingRequiresClause() {
805 return hasExtInfo() ? getExtInfo()->TrailingRequiresClause
806 : nullptr;
807 }
808
809 const Expr *getTrailingRequiresClause() const {
810 return hasExtInfo() ? getExtInfo()->TrailingRequiresClause
811 : nullptr;
812 }
813
814 void setTrailingRequiresClause(Expr *TrailingRequiresClause);
815
816 unsigned getNumTemplateParameterLists() const {
817 return hasExtInfo() ? getExtInfo()->NumTemplParamLists : 0;
818 }
819
820 TemplateParameterList *getTemplateParameterList(unsigned index) const {
821 assert(index < getNumTemplateParameterLists())(static_cast <bool> (index < getNumTemplateParameterLists
()) ? void (0) : __assert_fail ("index < getNumTemplateParameterLists()"
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/Decl.h"
, 821, __extension__ __PRETTY_FUNCTION__))
;
822 return getExtInfo()->TemplParamLists[index];
823 }
824
825 void setTemplateParameterListsInfo(ASTContext &Context,
826 ArrayRef<TemplateParameterList *> TPLists);
827
828 SourceLocation getTypeSpecStartLoc() const;
829 SourceLocation getTypeSpecEndLoc() const;
830
831 // Implement isa/cast/dyncast/etc.
832 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
833 static bool classofKind(Kind K) {
834 return K >= firstDeclarator && K <= lastDeclarator;
835 }
836};
837
838/// Structure used to store a statement, the constant value to
839/// which it was evaluated (if any), and whether or not the statement
840/// is an integral constant expression (if known).
841struct EvaluatedStmt {
842 /// Whether this statement was already evaluated.
843 bool WasEvaluated : 1;
844
845 /// Whether this statement is being evaluated.
846 bool IsEvaluating : 1;
847
848 /// Whether this variable is known to have constant initialization. This is
849 /// currently only computed in C++, for static / thread storage duration
850 /// variables that might have constant initialization and for variables that
851 /// are usable in constant expressions.
852 bool HasConstantInitialization : 1;
853
854 /// Whether this variable is known to have constant destruction. That is,
855 /// whether running the destructor on the initial value is a side-effect
856 /// (and doesn't inspect any state that might have changed during program
857 /// execution). This is currently only computed if the destructor is
858 /// non-trivial.
859 bool HasConstantDestruction : 1;
860
861 /// In C++98, whether the initializer is an ICE. This affects whether the
862 /// variable is usable in constant expressions.
863 bool HasICEInit : 1;
864 bool CheckedForICEInit : 1;
865
866 Stmt *Value;
867 APValue Evaluated;
868
869 EvaluatedStmt()
870 : WasEvaluated(false), IsEvaluating(false),
871 HasConstantInitialization(false), HasConstantDestruction(false),
872 HasICEInit(false), CheckedForICEInit(false) {}
873};
874
875/// Represents a variable declaration or definition.
876class VarDecl : public DeclaratorDecl, public Redeclarable<VarDecl> {
877public:
878 /// Initialization styles.
879 enum InitializationStyle {
880 /// C-style initialization with assignment
881 CInit,
882
883 /// Call-style initialization (C++98)
884 CallInit,
885
886 /// Direct list-initialization (C++11)
887 ListInit
888 };
889
890 /// Kinds of thread-local storage.
891 enum TLSKind {
892 /// Not a TLS variable.
893 TLS_None,
894
895 /// TLS with a known-constant initializer.
896 TLS_Static,
897
898 /// TLS with a dynamic initializer.
899 TLS_Dynamic
900 };
901
902 /// Return the string used to specify the storage class \p SC.
903 ///
904 /// It is illegal to call this function with SC == None.
905 static const char *getStorageClassSpecifierString(StorageClass SC);
906
907protected:
908 // A pointer union of Stmt * and EvaluatedStmt *. When an EvaluatedStmt, we
909 // have allocated the auxiliary struct of information there.
910 //
911 // TODO: It is a bit unfortunate to use a PointerUnion inside the VarDecl for
912 // this as *many* VarDecls are ParmVarDecls that don't have default
913 // arguments. We could save some space by moving this pointer union to be
914 // allocated in trailing space when necessary.
915 using InitType = llvm::PointerUnion<Stmt *, EvaluatedStmt *>;
916
917 /// The initializer for this variable or, for a ParmVarDecl, the
918 /// C++ default argument.
919 mutable InitType Init;
920
921private:
922 friend class ASTDeclReader;
923 friend class ASTNodeImporter;
924 friend class StmtIteratorBase;
925
926 class VarDeclBitfields {
927 friend class ASTDeclReader;
928 friend class VarDecl;
929
930 unsigned SClass : 3;
931 unsigned TSCSpec : 2;
932 unsigned InitStyle : 2;
933
934 /// Whether this variable is an ARC pseudo-__strong variable; see
935 /// isARCPseudoStrong() for details.
936 unsigned ARCPseudoStrong : 1;
937 };
938 enum { NumVarDeclBits = 8 };
939
940protected:
941 enum { NumParameterIndexBits = 8 };
942
943 enum DefaultArgKind {
944 DAK_None,
945 DAK_Unparsed,
946 DAK_Uninstantiated,
947 DAK_Normal
948 };
949
950 enum { NumScopeDepthOrObjCQualsBits = 7 };
951
952 class ParmVarDeclBitfields {
953 friend class ASTDeclReader;
954 friend class ParmVarDecl;
955
956 unsigned : NumVarDeclBits;
957
958 /// Whether this parameter inherits a default argument from a
959 /// prior declaration.
960 unsigned HasInheritedDefaultArg : 1;
961
962 /// Describes the kind of default argument for this parameter. By default
963 /// this is none. If this is normal, then the default argument is stored in
964 /// the \c VarDecl initializer expression unless we were unable to parse
965 /// (even an invalid) expression for the default argument.
966 unsigned DefaultArgKind : 2;
967
968 /// Whether this parameter undergoes K&R argument promotion.
969 unsigned IsKNRPromoted : 1;
970
971 /// Whether this parameter is an ObjC method parameter or not.
972 unsigned IsObjCMethodParam : 1;
973
974 /// If IsObjCMethodParam, a Decl::ObjCDeclQualifier.
975 /// Otherwise, the number of function parameter scopes enclosing
976 /// the function parameter scope in which this parameter was
977 /// declared.
978 unsigned ScopeDepthOrObjCQuals : NumScopeDepthOrObjCQualsBits;
979
980 /// The number of parameters preceding this parameter in the
981 /// function parameter scope in which it was declared.
982 unsigned ParameterIndex : NumParameterIndexBits;
983 };
984
985 class NonParmVarDeclBitfields {
986 friend class ASTDeclReader;
987 friend class ImplicitParamDecl;
988 friend class VarDecl;
989
990 unsigned : NumVarDeclBits;
991
992 // FIXME: We need something similar to CXXRecordDecl::DefinitionData.
993 /// Whether this variable is a definition which was demoted due to
994 /// module merge.
995 unsigned IsThisDeclarationADemotedDefinition : 1;
996
997 /// Whether this variable is the exception variable in a C++ catch
998 /// or an Objective-C @catch statement.
999 unsigned ExceptionVar : 1;
1000
1001 /// Whether this local variable could be allocated in the return
1002 /// slot of its function, enabling the named return value optimization
1003 /// (NRVO).
1004 unsigned NRVOVariable : 1;
1005
1006 /// Whether this variable is the for-range-declaration in a C++0x
1007 /// for-range statement.
1008 unsigned CXXForRangeDecl : 1;
1009
1010 /// Whether this variable is the for-in loop declaration in Objective-C.
1011 unsigned ObjCForDecl : 1;
1012
1013 /// Whether this variable is (C++1z) inline.
1014 unsigned IsInline : 1;
1015
1016 /// Whether this variable has (C++1z) inline explicitly specified.
1017 unsigned IsInlineSpecified : 1;
1018
1019 /// Whether this variable is (C++0x) constexpr.
1020 unsigned IsConstexpr : 1;
1021
1022 /// Whether this variable is the implicit variable for a lambda
1023 /// init-capture.
1024 unsigned IsInitCapture : 1;
1025
1026 /// Whether this local extern variable's previous declaration was
1027 /// declared in the same block scope. This controls whether we should merge
1028 /// the type of this declaration with its previous declaration.
1029 unsigned PreviousDeclInSameBlockScope : 1;
1030
1031 /// Defines kind of the ImplicitParamDecl: 'this', 'self', 'vtt', '_cmd' or
1032 /// something else.
1033 unsigned ImplicitParamKind : 3;
1034
1035 unsigned EscapingByref : 1;
1036 };
1037
1038 union {
1039 unsigned AllBits;
1040 VarDeclBitfields VarDeclBits;
1041 ParmVarDeclBitfields ParmVarDeclBits;
1042 NonParmVarDeclBitfields NonParmVarDeclBits;
1043 };
1044
1045 VarDecl(Kind DK, ASTContext &C, DeclContext *DC, SourceLocation StartLoc,
1046 SourceLocation IdLoc, IdentifierInfo *Id, QualType T,
1047 TypeSourceInfo *TInfo, StorageClass SC);
1048
1049 using redeclarable_base = Redeclarable<VarDecl>;
1050
1051 VarDecl *getNextRedeclarationImpl() override {
1052 return getNextRedeclaration();
1053 }
1054
1055 VarDecl *getPreviousDeclImpl() override {
1056 return getPreviousDecl();
1057 }
1058
1059 VarDecl *getMostRecentDeclImpl() override {
1060 return getMostRecentDecl();
1061 }
1062
1063public:
1064 using redecl_range = redeclarable_base::redecl_range;
1065 using redecl_iterator = redeclarable_base::redecl_iterator;
1066
1067 using redeclarable_base::redecls_begin;
1068 using redeclarable_base::redecls_end;
1069 using redeclarable_base::redecls;
1070 using redeclarable_base::getPreviousDecl;
1071 using redeclarable_base::getMostRecentDecl;
1072 using redeclarable_base::isFirstDecl;
1073
1074 static VarDecl *Create(ASTContext &C, DeclContext *DC,
1075 SourceLocation StartLoc, SourceLocation IdLoc,
1076 IdentifierInfo *Id, QualType T, TypeSourceInfo *TInfo,
1077 StorageClass S);
1078
1079 static VarDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1080
1081 SourceRange getSourceRange() const override LLVM_READONLY__attribute__((__pure__));
1082
1083 /// Returns the storage class as written in the source. For the
1084 /// computed linkage of symbol, see getLinkage.
1085 StorageClass getStorageClass() const {
1086 return (StorageClass) VarDeclBits.SClass;
1087 }
1088 void setStorageClass(StorageClass SC);
1089
1090 void setTSCSpec(ThreadStorageClassSpecifier TSC) {
1091 VarDeclBits.TSCSpec = TSC;
1092 assert(VarDeclBits.TSCSpec == TSC && "truncation")(static_cast <bool> (VarDeclBits.TSCSpec == TSC &&
"truncation") ? void (0) : __assert_fail ("VarDeclBits.TSCSpec == TSC && \"truncation\""
, "/build/llvm-toolchain-snapshot-14~++20211016100712+8e1d532707fd/clang/include/clang/AST/Decl.h"
, 1092, __extension__ __PRETTY_FUNCTION__))
;
1093 }
1094 ThreadStorageClassSpecifier getTSCSpec() const {
1095 return static_cast<ThreadStorageClassSpecifier>(VarDeclBits.TSCSpec);
1096 }
1097 TLSKind getTLSKind() const;
1098
1099 /// Returns true if a variable with function scope is a non-static local
1100 /// variable.
1101 bool hasLocalStorage() const {
1102 if (getStorageClass() == SC_None) {
15
Assuming the condition is false
1103 // OpenCL v1.2 s6.5.3: The __constant or constant address space name is
1104 // used to describe variables allocated in global memory and which are
1105 // accessed inside a kernel(s) as read-only variables. As such, variables
1106 // in constant address space cannot have local storage.
1107 if (getType().getAddressSpace() == LangAS::opencl_constant)
1108 return false;
1109 // Second check is for C++11 [dcl.stc]p4.
1110 return !isFileVarDecl() && getTSCSpec() == TSCS_unspecified;
1111 }
1112
1113 // Global Named Register (GNU extension)
1114 if (getStorageClass() == SC_Register && !isLocalVarDeclOrParm())
16
Assuming the condition is true
17
Assuming the condition is true
18
Taking true branch
1115 return false;
19
Returning zero, which participates in a condition later
1116
1117 // Return true for: Auto, Register.
1118 // Return false for: Extern, Static, PrivateExtern, OpenCLWorkGroupLocal.
1119
1120 return getStorageClass() >= SC_Auto;
1121 }
1122
1123 /// Returns true if a variable with function scope is a static local
1124 /// variable.
1125 bool isStaticLocal() const {
1126 return (getStorageClass() == SC_Static ||
1127 // C++11 [dcl.stc]p4
1128 (getStorageClass() == SC_None && getTSCSpec() == TSCS_thread_local))
1129 && !isFileVarDecl();
1130 }
1131
1132 /// Returns true if a variable has extern or __private_extern__
1133 /// storage.
1134 bool hasExternalStorage() const {
1135 return getStorageClass() == SC_Extern ||
1136 getStorageClass() == SC_PrivateExtern;
1137 }
1138
1139 /// Returns true for all variables that do not have local storage.
1140 ///
1141 /// This includes all global variables as well as static variables declared
1142 /// within a function.
1143 bool hasGlobalStorage() const { return !hasLocalStorage(); }
1144
1145 /// Get the storage duration of this variable, per C++ [basic.stc].
1146 StorageDuration getStorageDuration() const {
1147 return hasLocalStorage() ? SD_Automatic :
1148 getTSCSpec() ? SD_Thread : SD_Static;
1149 }
1150
1151 /// Compute the language linkage.
1152 LanguageLinkage getLanguageLinkage() const;
1153
1154 /// Determines whether this variable is a variable with external, C linkage.
1155 bool isExternC() const;
1156
1157 /// Determines whether this variable's context is, or is nested within,
1158 /// a C++ extern "C" linkage spec.
1159 bool isInExternCContext() const;
1160
1161 /// Determines whether this variable's context is, or is nested within,
1162 /// a C++ extern "C++" linkage spec.
1163 bool isInExternCXXContext() const;
1164
1165 /// Returns true for local variable declarations other than parameters.
1166 /// Note that this includes static variables inside of functions. It also
1167 /// includes variables inside blocks.
1168 ///
1169 /// void foo() { int x; static int y; extern int z; }
1170 bool isLocalVarDecl() const {
1171 if (getKind() != Decl::Var && getKind() != Decl::Decomposition)
1172 return false;
1173 if (const DeclContext *DC = getLexicalDeclContext())
1174 return DC->getRedeclContext()->isFunctionOrMethod();
1175 return false;
1176 }
1177
1178 /// Similar to isLocalVarDecl but also includes parameters.
1179 bool isLocalVarDeclOrParm() const {
1180 return isLocalVarDecl() || getKind() == Decl::ParmVar;
1181 }
1182
1183 /// Similar to isLocalVarDecl, but excludes variables declared in blocks.
1184 bool isFunctionOrMethodVarDecl() const {
1185 if (getKind() != Decl::Var && getKind() != Decl::Decomposition)
1186 return false;
1187 const DeclContext *DC = getLexicalDeclContext()->getRedeclContext();
1188 return DC->isFunctionOrMethod() && DC->getDeclKind() != Decl::Block;
1189 }
1190
1191 /// Determines whether this is a static data member.
1192 ///
1193 /// This will only be true in C++, and applies to, e.g., the
1194 /// variable 'x' in:
1195 /// \code
1196 /// struct S {
1197 /// static int x;
1198 /// };
1199 /// \endcode
1200 bool isStaticDataMember() const {
1201 // If it wasn't static, it would be a FieldDecl.
1202 return getKind() != Decl::ParmVar && getDeclContext()->isRecord();
1203 }
1204
1205 VarDecl *getCanonicalDecl() override;
1206 const VarDecl *getCanonicalDecl() const {
1207 return const_cast<VarDecl*>(this)->getCanonicalDecl();
1208 }
1209
1210 enum DefinitionKind {
1211 /// This declaration is only a declaration.
1212 DeclarationOnly,
1213
1214 /// This declaration is a tentative definition.
1215 TentativeDefinition,
1216
1217 /// This declaration is definitely a definition.
1218 Definition
1219 };
1220
1221 /// Check whether this declaration is a definition. If this could be
1222 /// a tentative definition (in C), don't check whether there's an overriding
1223 /// definition.
1224 DefinitionKind isThisDeclarationADefinition(ASTContext &) const;
1225 DefinitionKind isThisDeclarationADefinition() const {
1226 return isThisDeclarationADefinition(getASTContext());
1227 }
1228
1229 /// Check whether this variable is defined in this translation unit.
1230 DefinitionKind hasDefinition(ASTContext &) const;
1231 DefinitionKind hasDefinition() const {
1232 return hasDefinition(getASTContext());
1233 }
1234
1235 /// Get the tentative definition that acts as the real definition in a TU.
1236 /// Returns null if there is a proper definition available.
1237 VarDecl *getActingDefinition();
1238 const VarDecl *getActingDefinition() const {
1239 return const_cast<VarDecl*>(this)->getActingDefinition();
1240 }
1241
1242 /// Get the real (not just tentative) definition for this declaration.
1243 VarDecl *getDefinition(ASTContext &);
1244 const VarDecl *getDefinition(ASTContext &C) const {
1245 return const_cast<VarDecl*>(this)->getDefinition(C);
1246 }
1247 VarDecl *getDefinition() {
1248 return getDefinition(getASTContext());
1249 }
1250 const VarDecl *getDefinition() const {
1251 return const_cast<VarDecl*>(this)->getDefinition();
1252 }
1253
1254 /// Determine whether this is or was instantiated from an out-of-line
1255 /// definition of a static data member.
1256 bool isOutOfLine() const override;
1257
1258 /// Returns true for file scoped variable declaration.
1259 bool isFileVarDecl() const {
1260 Kind K = getKind();
1261 if (K == ParmVar || K == ImplicitParam)
1262 return false;
1263
1264 if (getLexicalDeclContext()->getRedeclContext()->isFileContext())
1265 return true;
1266
1267 if (isStaticDataMember())
1268 return true;
1269
1270 return false;
1271 }
1272
1273 /// Get the initializer for this variable, no matter which
1274 /// declaration it is attached to.
1275 const Expr *getAnyInitializer() const {
1276 const VarDecl *D;
1277 return getAnyInitializer(D);
1278 }
1279
1280 /// Get the initializer for this variable, no matter which
1281 /// declaration it is attached to. Also get that declaration.
1282 const Expr *getAnyInitializer(const VarDecl *&D) const;
1283
1284 bool hasInit() const;
1285 const Expr *getInit() const {
1286 return const_cast<VarDecl *>(this)->getInit();
1287 }
1288 Expr *getInit();
1289
1290 /// Retrieve the address of the initializer expression.
1291 Stmt **getInitAddress();
1292
1293 void setInit(Expr *I);
1294
1295 /// Get the initializing declaration of this variable, if any. This is
1296 /// usually the definition, except that for a static data member it can be
1297 /// the in-class declaration.
1298 VarDecl *getInitializingDeclaration();
1299 const VarDecl *getInitializingDeclaration() const {
1300 return const_cast<VarDecl *>(this)->getInitializingDeclaration();
1301 }
1302
1303 /// Determine whether this variable's value might be usable in a
1304 /// constant expression, according to the relevant language standard.
1305 /// This only checks properties of the declaration, and does not check
1306 /// whether the initializer is in fact a constant expression.
1307 ///
1308 /// This corresponds to C++20 [expr.const]p3's notion of a
1309 /// "potentially-constant" variable.
1310 bool mightBeUsableInConstantExpressions(const ASTContext &C) const;
1311
1312 /// Determine whether this variable's value can be used in a
1313 /// constant expression, according to the relevant language standard,
1314 /// including checking whether it was initialized by a constant expression.
1315 bool isUsableInConstantExpressions(const ASTContext &C) const;
1316
1317 EvaluatedStmt *ensureEvaluatedStmt() const;
1318 EvaluatedStmt *getEvaluatedStmt() const;
1319
1320 /// Attempt to evaluate the value of the initializer attached to this
1321 /// declaration, and produce notes explaining why it cannot be evaluated.
1322 /// Returns a pointer to the value if evaluation succeeded, 0 otherwise.
1323 APValue *evaluateValue() const;
1324
1325private:
1326 APValue *evaluateValueImpl(SmallVectorImpl<PartialDiagnosticAt> &Notes,
1327 bool IsConstantInitialization) const;
1328
1329public:
1330 /// Return the already-evaluated value of this variable's
1331 /// initializer, or NULL if the value is not yet known. Returns pointer
1332 /// to untyped APValue if the value could not be evaluated.
1333 APValue *getEvaluatedValue() const;
1334
1335 /// Evaluate the destruction of this variable to determine if it constitutes
1336 /// constant destruction.
1337 ///
1338 /// \pre hasConstantInitialization()
1339 /// \return \c true if this variable has constant destruction, \c false if
1340 /// not.
1341 bool evaluateDestruction(SmallVectorImpl<PartialDiagnosticAt> &Notes) const;
1342
1343 /// Determine whether this variable has constant initialization.
1344 ///
1345 /// This is only set in two cases: when the language semantics require
1346 /// constant initialization (globals in C and some globals in C++), and when
1347 /// the variable is usable in constant expressions (constexpr, const int, and
1348 /// reference variables in C++).
1349 bool hasConstantInitialization() const;
1350
1351 /// Determine whether the initializer of this variable is an integer constant
1352 /// expression. For use in C++98, where this affects whether the variable is
1353 /// usable in constant expressions.
1354 bool hasICEInitializer(const ASTContext &Context) const;
1355
1356 /// Evaluate the initializer of this variable to determine whether it's a
1357 /// constant initializer. Should only be called once, after completing the
1358 /// definition of the variable.
1359 bool checkForConstantInitialization(
1360 SmallVectorImpl<PartialDiagnosticAt> &Notes) const;
1361
1362 void setInitStyle(InitializationStyle Style) {
1363 VarDeclBits.InitStyle = Style;
1364 }
1365
1366 /// The style of initialization for this declaration.
1367 ///
1368 /// C-style initialization is "int x = 1;". Call-style initialization is
1369 /// a C++98 direct-initializer, e.g. "int x(1);". The Init expression will be
1370 /// the expression inside the parens or a "ClassType(a,b,c)" class constructor
1371 /// expression for class types. List-style initialization is C++11 syntax,
1372 /// e.g. "int x{1};". Clients can distinguish between different forms of
1373 /// initialization by checking this value. In particular, "int x = {1};" is
1374 /// C-style, "int x({1})" is call-style, and "int x{1};" is list-style; the
1375 /// Init expression in all three cases is an InitListExpr.
1376 InitializationStyle getInitStyle() const {
1377 return static_cast<InitializationStyle>(VarDeclBits.InitStyle);
1378 }
1379
1380 /// Whether the initializer is a direct-initializer (list or call).
1381 bool isDirectInit() const {
1382 return getInitStyle() != CInit;
1383 }
1384
1385 /// If this definition should pretend to be a declaration.