Bug Summary

File:clang/lib/Sema/SemaCast.cpp
Warning:line 1358, column 14
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 -disable-llvm-verifier -discard-value-names -main-file-name SemaCast.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 -munwind-tables -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -ffunction-sections -fdata-sections -fcoverage-compilation-dir=/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/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/Sema -I /build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema -I /build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include -I tools/clang/include -I include -I /build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/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~++20210926122410+d23fd8ae8906/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-09-26-234817-15343-1 -x c++ /build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp

/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp

1//===--- SemaCast.cpp - Semantic Analysis for Casts -----------------------===//
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 implements semantic analysis for cast expressions, including
10// 1) C-style casts like '(int) x'
11// 2) C++ functional casts like 'int(x)'
12// 3) C++ named casts like 'static_cast<int>(x)'
13//
14//===----------------------------------------------------------------------===//
15
16#include "clang/AST/ASTContext.h"
17#include "clang/AST/ASTStructuralEquivalence.h"
18#include "clang/AST/CXXInheritance.h"
19#include "clang/AST/ExprCXX.h"
20#include "clang/AST/ExprObjC.h"
21#include "clang/AST/RecordLayout.h"
22#include "clang/Basic/PartialDiagnostic.h"
23#include "clang/Basic/TargetInfo.h"
24#include "clang/Lex/Preprocessor.h"
25#include "clang/Sema/Initialization.h"
26#include "clang/Sema/SemaInternal.h"
27#include "llvm/ADT/SmallVector.h"
28#include <set>
29using namespace clang;
30
31
32
33enum TryCastResult {
34 TC_NotApplicable, ///< The cast method is not applicable.
35 TC_Success, ///< The cast method is appropriate and successful.
36 TC_Extension, ///< The cast method is appropriate and accepted as a
37 ///< language extension.
38 TC_Failed ///< The cast method is appropriate, but failed. A
39 ///< diagnostic has been emitted.
40};
41
42static bool isValidCast(TryCastResult TCR) {
43 return TCR == TC_Success || TCR == TC_Extension;
44}
45
46enum CastType {
47 CT_Const, ///< const_cast
48 CT_Static, ///< static_cast
49 CT_Reinterpret, ///< reinterpret_cast
50 CT_Dynamic, ///< dynamic_cast
51 CT_CStyle, ///< (Type)expr
52 CT_Functional, ///< Type(expr)
53 CT_Addrspace ///< addrspace_cast
54};
55
56namespace {
57 struct CastOperation {
58 CastOperation(Sema &S, QualType destType, ExprResult src)
59 : Self(S), SrcExpr(src), DestType(destType),
60 ResultType(destType.getNonLValueExprType(S.Context)),
61 ValueKind(Expr::getValueKindForType(destType)),
62 Kind(CK_Dependent), IsARCUnbridgedCast(false) {
63
64 // C++ [expr.type]/8.2.2:
65 // If a pr-value initially has the type cv-T, where T is a
66 // cv-unqualified non-class, non-array type, the type of the
67 // expression is adjusted to T prior to any further analysis.
68 if (!S.Context.getLangOpts().ObjC && !DestType->isRecordType() &&
69 !DestType->isArrayType()) {
70 DestType = DestType.getUnqualifiedType();
71 }
72
73 if (const BuiltinType *placeholder =
74 src.get()->getType()->getAsPlaceholderType()) {
75 PlaceholderKind = placeholder->getKind();
76 } else {
77 PlaceholderKind = (BuiltinType::Kind) 0;
78 }
79 }
80
81 Sema &Self;
82 ExprResult SrcExpr;
83 QualType DestType;
84 QualType ResultType;
85 ExprValueKind ValueKind;
86 CastKind Kind;
87 BuiltinType::Kind PlaceholderKind;
88 CXXCastPath BasePath;
89 bool IsARCUnbridgedCast;
90
91 SourceRange OpRange;
92 SourceRange DestRange;
93
94 // Top-level semantics-checking routines.
95 void CheckConstCast();
96 void CheckReinterpretCast();
97 void CheckStaticCast();
98 void CheckDynamicCast();
99 void CheckCXXCStyleCast(bool FunctionalCast, bool ListInitialization);
100 void CheckCStyleCast();
101 void CheckBuiltinBitCast();
102 void CheckAddrspaceCast();
103
104 void updatePartOfExplicitCastFlags(CastExpr *CE) {
105 // Walk down from the CE to the OrigSrcExpr, and mark all immediate
106 // ImplicitCastExpr's as being part of ExplicitCastExpr. The original CE
107 // (which is a ExplicitCastExpr), and the OrigSrcExpr are not touched.
108 for (; auto *ICE = dyn_cast<ImplicitCastExpr>(CE->getSubExpr()); CE = ICE)
109 ICE->setIsPartOfExplicitCast(true);
110 }
111
112 /// Complete an apparently-successful cast operation that yields
113 /// the given expression.
114 ExprResult complete(CastExpr *castExpr) {
115 // If this is an unbridged cast, wrap the result in an implicit
116 // cast that yields the unbridged-cast placeholder type.
117 if (IsARCUnbridgedCast) {
118 castExpr = ImplicitCastExpr::Create(
119 Self.Context, Self.Context.ARCUnbridgedCastTy, CK_Dependent,
120 castExpr, nullptr, castExpr->getValueKind(),
121 Self.CurFPFeatureOverrides());
122 }
123 updatePartOfExplicitCastFlags(castExpr);
124 return castExpr;
125 }
126
127 // Internal convenience methods.
128
129 /// Try to handle the given placeholder expression kind. Return
130 /// true if the source expression has the appropriate placeholder
131 /// kind. A placeholder can only be claimed once.
132 bool claimPlaceholder(BuiltinType::Kind K) {
133 if (PlaceholderKind != K) return false;
134
135 PlaceholderKind = (BuiltinType::Kind) 0;
136 return true;
137 }
138
139 bool isPlaceholder() const {
140 return PlaceholderKind != 0;
141 }
142 bool isPlaceholder(BuiltinType::Kind K) const {
143 return PlaceholderKind == K;
144 }
145
146 // Language specific cast restrictions for address spaces.
147 void checkAddressSpaceCast(QualType SrcType, QualType DestType);
148
149 void checkCastAlign() {
150 Self.CheckCastAlign(SrcExpr.get(), DestType, OpRange);
151 }
152
153 void checkObjCConversion(Sema::CheckedConversionKind CCK) {
154 assert(Self.getLangOpts().allowsNonTrivialObjCLifetimeQualifiers())(static_cast <bool> (Self.getLangOpts().allowsNonTrivialObjCLifetimeQualifiers
()) ? void (0) : __assert_fail ("Self.getLangOpts().allowsNonTrivialObjCLifetimeQualifiers()"
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 154, __extension__ __PRETTY_FUNCTION__))
;
155
156 Expr *src = SrcExpr.get();
157 if (Self.CheckObjCConversion(OpRange, DestType, src, CCK) ==
158 Sema::ACR_unbridged)
159 IsARCUnbridgedCast = true;
160 SrcExpr = src;
161 }
162
163 /// Check for and handle non-overload placeholder expressions.
164 void checkNonOverloadPlaceholders() {
165 if (!isPlaceholder() || isPlaceholder(BuiltinType::Overload))
166 return;
167
168 SrcExpr = Self.CheckPlaceholderExpr(SrcExpr.get());
169 if (SrcExpr.isInvalid())
170 return;
171 PlaceholderKind = (BuiltinType::Kind) 0;
172 }
173 };
174
175 void CheckNoDeref(Sema &S, const QualType FromType, const QualType ToType,
176 SourceLocation OpLoc) {
177 if (const auto *PtrType = dyn_cast<PointerType>(FromType)) {
178 if (PtrType->getPointeeType()->hasAttr(attr::NoDeref)) {
179 if (const auto *DestType = dyn_cast<PointerType>(ToType)) {
180 if (!DestType->getPointeeType()->hasAttr(attr::NoDeref)) {
181 S.Diag(OpLoc, diag::warn_noderef_to_dereferenceable_pointer);
182 }
183 }
184 }
185 }
186 }
187
188 struct CheckNoDerefRAII {
189 CheckNoDerefRAII(CastOperation &Op) : Op(Op) {}
190 ~CheckNoDerefRAII() {
191 if (!Op.SrcExpr.isInvalid())
192 CheckNoDeref(Op.Self, Op.SrcExpr.get()->getType(), Op.ResultType,
193 Op.OpRange.getBegin());
194 }
195
196 CastOperation &Op;
197 };
198}
199
200static void DiagnoseCastQual(Sema &Self, const ExprResult &SrcExpr,
201 QualType DestType);
202
203// The Try functions attempt a specific way of casting. If they succeed, they
204// return TC_Success. If their way of casting is not appropriate for the given
205// arguments, they return TC_NotApplicable and *may* set diag to a diagnostic
206// to emit if no other way succeeds. If their way of casting is appropriate but
207// fails, they return TC_Failed and *must* set diag; they can set it to 0 if
208// they emit a specialized diagnostic.
209// All diagnostics returned by these functions must expect the same three
210// arguments:
211// %0: Cast Type (a value from the CastType enumeration)
212// %1: Source Type
213// %2: Destination Type
214static TryCastResult TryLValueToRValueCast(Sema &Self, Expr *SrcExpr,
215 QualType DestType, bool CStyle,
216 CastKind &Kind,
217 CXXCastPath &BasePath,
218 unsigned &msg);
219static TryCastResult TryStaticReferenceDowncast(Sema &Self, Expr *SrcExpr,
220 QualType DestType, bool CStyle,
221 SourceRange OpRange,
222 unsigned &msg,
223 CastKind &Kind,
224 CXXCastPath &BasePath);
225static TryCastResult TryStaticPointerDowncast(Sema &Self, QualType SrcType,
226 QualType DestType, bool CStyle,
227 SourceRange OpRange,
228 unsigned &msg,
229 CastKind &Kind,
230 CXXCastPath &BasePath);
231static TryCastResult TryStaticDowncast(Sema &Self, CanQualType SrcType,
232 CanQualType DestType, bool CStyle,
233 SourceRange OpRange,
234 QualType OrigSrcType,
235 QualType OrigDestType, unsigned &msg,
236 CastKind &Kind,
237 CXXCastPath &BasePath);
238static TryCastResult TryStaticMemberPointerUpcast(Sema &Self, ExprResult &SrcExpr,
239 QualType SrcType,
240 QualType DestType,bool CStyle,
241 SourceRange OpRange,
242 unsigned &msg,
243 CastKind &Kind,
244 CXXCastPath &BasePath);
245
246static TryCastResult TryStaticImplicitCast(Sema &Self, ExprResult &SrcExpr,
247 QualType DestType,
248 Sema::CheckedConversionKind CCK,
249 SourceRange OpRange,
250 unsigned &msg, CastKind &Kind,
251 bool ListInitialization);
252static TryCastResult TryStaticCast(Sema &Self, ExprResult &SrcExpr,
253 QualType DestType,
254 Sema::CheckedConversionKind CCK,
255 SourceRange OpRange,
256 unsigned &msg, CastKind &Kind,
257 CXXCastPath &BasePath,
258 bool ListInitialization);
259static TryCastResult TryConstCast(Sema &Self, ExprResult &SrcExpr,
260 QualType DestType, bool CStyle,
261 unsigned &msg);
262static TryCastResult TryReinterpretCast(Sema &Self, ExprResult &SrcExpr,
263 QualType DestType, bool CStyle,
264 SourceRange OpRange, unsigned &msg,
265 CastKind &Kind);
266static TryCastResult TryAddressSpaceCast(Sema &Self, ExprResult &SrcExpr,
267 QualType DestType, bool CStyle,
268 unsigned &msg, CastKind &Kind);
269
270/// ActOnCXXNamedCast - Parse
271/// {dynamic,static,reinterpret,const,addrspace}_cast's.
272ExprResult
273Sema::ActOnCXXNamedCast(SourceLocation OpLoc, tok::TokenKind Kind,
274 SourceLocation LAngleBracketLoc, Declarator &D,
275 SourceLocation RAngleBracketLoc,
276 SourceLocation LParenLoc, Expr *E,
277 SourceLocation RParenLoc) {
278
279 assert(!D.isInvalidType())(static_cast <bool> (!D.isInvalidType()) ? void (0) : __assert_fail
("!D.isInvalidType()", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 279, __extension__ __PRETTY_FUNCTION__))
;
280
281 TypeSourceInfo *TInfo = GetTypeForDeclaratorCast(D, E->getType());
282 if (D.isInvalidType())
283 return ExprError();
284
285 if (getLangOpts().CPlusPlus) {
286 // Check that there are no default arguments (C++ only).
287 CheckExtraCXXDefaultArguments(D);
288 }
289
290 return BuildCXXNamedCast(OpLoc, Kind, TInfo, E,
291 SourceRange(LAngleBracketLoc, RAngleBracketLoc),
292 SourceRange(LParenLoc, RParenLoc));
293}
294
295ExprResult
296Sema::BuildCXXNamedCast(SourceLocation OpLoc, tok::TokenKind Kind,
297 TypeSourceInfo *DestTInfo, Expr *E,
298 SourceRange AngleBrackets, SourceRange Parens) {
299 ExprResult Ex = E;
300 QualType DestType = DestTInfo->getType();
301
302 // If the type is dependent, we won't do the semantic analysis now.
303 bool TypeDependent =
304 DestType->isDependentType() || Ex.get()->isTypeDependent();
305
306 CastOperation Op(*this, DestType, E);
307 Op.OpRange = SourceRange(OpLoc, Parens.getEnd());
308 Op.DestRange = AngleBrackets;
309
310 switch (Kind) {
311 default: llvm_unreachable("Unknown C++ cast!")::llvm::llvm_unreachable_internal("Unknown C++ cast!", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 311)
;
312
313 case tok::kw_addrspace_cast:
314 if (!TypeDependent) {
315 Op.CheckAddrspaceCast();
316 if (Op.SrcExpr.isInvalid())
317 return ExprError();
318 }
319 return Op.complete(CXXAddrspaceCastExpr::Create(
320 Context, Op.ResultType, Op.ValueKind, Op.Kind, Op.SrcExpr.get(),
321 DestTInfo, OpLoc, Parens.getEnd(), AngleBrackets));
322
323 case tok::kw_const_cast:
324 if (!TypeDependent) {
325 Op.CheckConstCast();
326 if (Op.SrcExpr.isInvalid())
327 return ExprError();
328 DiscardMisalignedMemberAddress(DestType.getTypePtr(), E);
329 }
330 return Op.complete(CXXConstCastExpr::Create(Context, Op.ResultType,
331 Op.ValueKind, Op.SrcExpr.get(), DestTInfo,
332 OpLoc, Parens.getEnd(),
333 AngleBrackets));
334
335 case tok::kw_dynamic_cast: {
336 // dynamic_cast is not supported in C++ for OpenCL.
337 if (getLangOpts().OpenCLCPlusPlus) {
338 return ExprError(Diag(OpLoc, diag::err_openclcxx_not_supported)
339 << "dynamic_cast");
340 }
341
342 if (!TypeDependent) {
343 Op.CheckDynamicCast();
344 if (Op.SrcExpr.isInvalid())
345 return ExprError();
346 }
347 return Op.complete(CXXDynamicCastExpr::Create(Context, Op.ResultType,
348 Op.ValueKind, Op.Kind, Op.SrcExpr.get(),
349 &Op.BasePath, DestTInfo,
350 OpLoc, Parens.getEnd(),
351 AngleBrackets));
352 }
353 case tok::kw_reinterpret_cast: {
354 if (!TypeDependent) {
355 Op.CheckReinterpretCast();
356 if (Op.SrcExpr.isInvalid())
357 return ExprError();
358 DiscardMisalignedMemberAddress(DestType.getTypePtr(), E);
359 }
360 return Op.complete(CXXReinterpretCastExpr::Create(Context, Op.ResultType,
361 Op.ValueKind, Op.Kind, Op.SrcExpr.get(),
362 nullptr, DestTInfo, OpLoc,
363 Parens.getEnd(),
364 AngleBrackets));
365 }
366 case tok::kw_static_cast: {
367 if (!TypeDependent) {
368 Op.CheckStaticCast();
369 if (Op.SrcExpr.isInvalid())
370 return ExprError();
371 DiscardMisalignedMemberAddress(DestType.getTypePtr(), E);
372 }
373
374 return Op.complete(CXXStaticCastExpr::Create(
375 Context, Op.ResultType, Op.ValueKind, Op.Kind, Op.SrcExpr.get(),
376 &Op.BasePath, DestTInfo, CurFPFeatureOverrides(), OpLoc,
377 Parens.getEnd(), AngleBrackets));
378 }
379 }
380}
381
382ExprResult Sema::ActOnBuiltinBitCastExpr(SourceLocation KWLoc, Declarator &D,
383 ExprResult Operand,
384 SourceLocation RParenLoc) {
385 assert(!D.isInvalidType())(static_cast <bool> (!D.isInvalidType()) ? void (0) : __assert_fail
("!D.isInvalidType()", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 385, __extension__ __PRETTY_FUNCTION__))
;
386
387 TypeSourceInfo *TInfo = GetTypeForDeclaratorCast(D, Operand.get()->getType());
388 if (D.isInvalidType())
389 return ExprError();
390
391 return BuildBuiltinBitCastExpr(KWLoc, TInfo, Operand.get(), RParenLoc);
392}
393
394ExprResult Sema::BuildBuiltinBitCastExpr(SourceLocation KWLoc,
395 TypeSourceInfo *TSI, Expr *Operand,
396 SourceLocation RParenLoc) {
397 CastOperation Op(*this, TSI->getType(), Operand);
398 Op.OpRange = SourceRange(KWLoc, RParenLoc);
399 TypeLoc TL = TSI->getTypeLoc();
400 Op.DestRange = SourceRange(TL.getBeginLoc(), TL.getEndLoc());
401
402 if (!Operand->isTypeDependent() && !TSI->getType()->isDependentType()) {
403 Op.CheckBuiltinBitCast();
404 if (Op.SrcExpr.isInvalid())
405 return ExprError();
406 }
407
408 BuiltinBitCastExpr *BCE =
409 new (Context) BuiltinBitCastExpr(Op.ResultType, Op.ValueKind, Op.Kind,
410 Op.SrcExpr.get(), TSI, KWLoc, RParenLoc);
411 return Op.complete(BCE);
412}
413
414/// Try to diagnose a failed overloaded cast. Returns true if
415/// diagnostics were emitted.
416static bool tryDiagnoseOverloadedCast(Sema &S, CastType CT,
417 SourceRange range, Expr *src,
418 QualType destType,
419 bool listInitialization) {
420 switch (CT) {
421 // These cast kinds don't consider user-defined conversions.
422 case CT_Const:
423 case CT_Reinterpret:
424 case CT_Dynamic:
425 case CT_Addrspace:
426 return false;
427
428 // These do.
429 case CT_Static:
430 case CT_CStyle:
431 case CT_Functional:
432 break;
433 }
434
435 QualType srcType = src->getType();
436 if (!destType->isRecordType() && !srcType->isRecordType())
437 return false;
438
439 InitializedEntity entity = InitializedEntity::InitializeTemporary(destType);
440 InitializationKind initKind
441 = (CT == CT_CStyle)? InitializationKind::CreateCStyleCast(range.getBegin(),
442 range, listInitialization)
443 : (CT == CT_Functional)? InitializationKind::CreateFunctionalCast(range,
444 listInitialization)
445 : InitializationKind::CreateCast(/*type range?*/ range);
446 InitializationSequence sequence(S, entity, initKind, src);
447
448 assert(sequence.Failed() && "initialization succeeded on second try?")(static_cast <bool> (sequence.Failed() && "initialization succeeded on second try?"
) ? void (0) : __assert_fail ("sequence.Failed() && \"initialization succeeded on second try?\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 448, __extension__ __PRETTY_FUNCTION__))
;
449 switch (sequence.getFailureKind()) {
450 default: return false;
451
452 case InitializationSequence::FK_ConstructorOverloadFailed:
453 case InitializationSequence::FK_UserConversionOverloadFailed:
454 break;
455 }
456
457 OverloadCandidateSet &candidates = sequence.getFailedCandidateSet();
458
459 unsigned msg = 0;
460 OverloadCandidateDisplayKind howManyCandidates = OCD_AllCandidates;
461
462 switch (sequence.getFailedOverloadResult()) {
463 case OR_Success: llvm_unreachable("successful failed overload")::llvm::llvm_unreachable_internal("successful failed overload"
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 463)
;
464 case OR_No_Viable_Function:
465 if (candidates.empty())
466 msg = diag::err_ovl_no_conversion_in_cast;
467 else
468 msg = diag::err_ovl_no_viable_conversion_in_cast;
469 howManyCandidates = OCD_AllCandidates;
470 break;
471
472 case OR_Ambiguous:
473 msg = diag::err_ovl_ambiguous_conversion_in_cast;
474 howManyCandidates = OCD_AmbiguousCandidates;
475 break;
476
477 case OR_Deleted:
478 msg = diag::err_ovl_deleted_conversion_in_cast;
479 howManyCandidates = OCD_ViableCandidates;
480 break;
481 }
482
483 candidates.NoteCandidates(
484 PartialDiagnosticAt(range.getBegin(),
485 S.PDiag(msg) << CT << srcType << destType << range
486 << src->getSourceRange()),
487 S, howManyCandidates, src);
488
489 return true;
490}
491
492/// Diagnose a failed cast.
493static void diagnoseBadCast(Sema &S, unsigned msg, CastType castType,
494 SourceRange opRange, Expr *src, QualType destType,
495 bool listInitialization) {
496 if (msg == diag::err_bad_cxx_cast_generic &&
497 tryDiagnoseOverloadedCast(S, castType, opRange, src, destType,
498 listInitialization))
499 return;
500
501 S.Diag(opRange.getBegin(), msg) << castType
502 << src->getType() << destType << opRange << src->getSourceRange();
503
504 // Detect if both types are (ptr to) class, and note any incompleteness.
505 int DifferentPtrness = 0;
506 QualType From = destType;
507 if (auto Ptr = From->getAs<PointerType>()) {
508 From = Ptr->getPointeeType();
509 DifferentPtrness++;
510 }
511 QualType To = src->getType();
512 if (auto Ptr = To->getAs<PointerType>()) {
513 To = Ptr->getPointeeType();
514 DifferentPtrness--;
515 }
516 if (!DifferentPtrness) {
517 auto RecFrom = From->getAs<RecordType>();
518 auto RecTo = To->getAs<RecordType>();
519 if (RecFrom && RecTo) {
520 auto DeclFrom = RecFrom->getAsCXXRecordDecl();
521 if (!DeclFrom->isCompleteDefinition())
522 S.Diag(DeclFrom->getLocation(), diag::note_type_incomplete) << DeclFrom;
523 auto DeclTo = RecTo->getAsCXXRecordDecl();
524 if (!DeclTo->isCompleteDefinition())
525 S.Diag(DeclTo->getLocation(), diag::note_type_incomplete) << DeclTo;
526 }
527 }
528}
529
530namespace {
531/// The kind of unwrapping we did when determining whether a conversion casts
532/// away constness.
533enum CastAwayConstnessKind {
534 /// The conversion does not cast away constness.
535 CACK_None = 0,
536 /// We unwrapped similar types.
537 CACK_Similar = 1,
538 /// We unwrapped dissimilar types with similar representations (eg, a pointer
539 /// versus an Objective-C object pointer).
540 CACK_SimilarKind = 2,
541 /// We unwrapped representationally-unrelated types, such as a pointer versus
542 /// a pointer-to-member.
543 CACK_Incoherent = 3,
544};
545}
546
547/// Unwrap one level of types for CastsAwayConstness.
548///
549/// Like Sema::UnwrapSimilarTypes, this removes one level of indirection from
550/// both types, provided that they're both pointer-like or array-like. Unlike
551/// the Sema function, doesn't care if the unwrapped pieces are related.
552///
553/// This function may remove additional levels as necessary for correctness:
554/// the resulting T1 is unwrapped sufficiently that it is never an array type,
555/// so that its qualifiers can be directly compared to those of T2 (which will
556/// have the combined set of qualifiers from all indermediate levels of T2),
557/// as (effectively) required by [expr.const.cast]p7 replacing T1's qualifiers
558/// with those from T2.
559static CastAwayConstnessKind
560unwrapCastAwayConstnessLevel(ASTContext &Context, QualType &T1, QualType &T2) {
561 enum { None, Ptr, MemPtr, BlockPtr, Array };
562 auto Classify = [](QualType T) {
563 if (T->isAnyPointerType()) return Ptr;
564 if (T->isMemberPointerType()) return MemPtr;
565 if (T->isBlockPointerType()) return BlockPtr;
566 // We somewhat-arbitrarily don't look through VLA types here. This is at
567 // least consistent with the behavior of UnwrapSimilarTypes.
568 if (T->isConstantArrayType() || T->isIncompleteArrayType()) return Array;
569 return None;
570 };
571
572 auto Unwrap = [&](QualType T) {
573 if (auto *AT = Context.getAsArrayType(T))
574 return AT->getElementType();
575 return T->getPointeeType();
576 };
577
578 CastAwayConstnessKind Kind;
579
580 if (T2->isReferenceType()) {
581 // Special case: if the destination type is a reference type, unwrap it as
582 // the first level. (The source will have been an lvalue expression in this
583 // case, so there is no corresponding "reference to" in T1 to remove.) This
584 // simulates removing a "pointer to" from both sides.
585 T2 = T2->getPointeeType();
586 Kind = CastAwayConstnessKind::CACK_Similar;
587 } else if (Context.UnwrapSimilarTypes(T1, T2)) {
588 Kind = CastAwayConstnessKind::CACK_Similar;
589 } else {
590 // Try unwrapping mismatching levels.
591 int T1Class = Classify(T1);
592 if (T1Class == None)
593 return CastAwayConstnessKind::CACK_None;
594
595 int T2Class = Classify(T2);
596 if (T2Class == None)
597 return CastAwayConstnessKind::CACK_None;
598
599 T1 = Unwrap(T1);
600 T2 = Unwrap(T2);
601 Kind = T1Class == T2Class ? CastAwayConstnessKind::CACK_SimilarKind
602 : CastAwayConstnessKind::CACK_Incoherent;
603 }
604
605 // We've unwrapped at least one level. If the resulting T1 is a (possibly
606 // multidimensional) array type, any qualifier on any matching layer of
607 // T2 is considered to correspond to T1. Decompose down to the element
608 // type of T1 so that we can compare properly.
609 while (true) {
610 Context.UnwrapSimilarArrayTypes(T1, T2);
611
612 if (Classify(T1) != Array)
613 break;
614
615 auto T2Class = Classify(T2);
616 if (T2Class == None)
617 break;
618
619 if (T2Class != Array)
620 Kind = CastAwayConstnessKind::CACK_Incoherent;
621 else if (Kind != CastAwayConstnessKind::CACK_Incoherent)
622 Kind = CastAwayConstnessKind::CACK_SimilarKind;
623
624 T1 = Unwrap(T1);
625 T2 = Unwrap(T2).withCVRQualifiers(T2.getCVRQualifiers());
626 }
627
628 return Kind;
629}
630
631/// Check if the pointer conversion from SrcType to DestType casts away
632/// constness as defined in C++ [expr.const.cast]. This is used by the cast
633/// checkers. Both arguments must denote pointer (possibly to member) types.
634///
635/// \param CheckCVR Whether to check for const/volatile/restrict qualifiers.
636/// \param CheckObjCLifetime Whether to check Objective-C lifetime qualifiers.
637static CastAwayConstnessKind
638CastsAwayConstness(Sema &Self, QualType SrcType, QualType DestType,
639 bool CheckCVR, bool CheckObjCLifetime,
640 QualType *TheOffendingSrcType = nullptr,
641 QualType *TheOffendingDestType = nullptr,
642 Qualifiers *CastAwayQualifiers = nullptr) {
643 // If the only checking we care about is for Objective-C lifetime qualifiers,
644 // and we're not in ObjC mode, there's nothing to check.
645 if (!CheckCVR && CheckObjCLifetime && !Self.Context.getLangOpts().ObjC)
646 return CastAwayConstnessKind::CACK_None;
647
648 if (!DestType->isReferenceType()) {
649 assert((SrcType->isAnyPointerType() || SrcType->isMemberPointerType() ||(static_cast <bool> ((SrcType->isAnyPointerType() ||
SrcType->isMemberPointerType() || SrcType->isBlockPointerType
()) && "Source type is not pointer or pointer to member."
) ? void (0) : __assert_fail ("(SrcType->isAnyPointerType() || SrcType->isMemberPointerType() || SrcType->isBlockPointerType()) && \"Source type is not pointer or pointer to member.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 651, __extension__ __PRETTY_FUNCTION__))
650 SrcType->isBlockPointerType()) &&(static_cast <bool> ((SrcType->isAnyPointerType() ||
SrcType->isMemberPointerType() || SrcType->isBlockPointerType
()) && "Source type is not pointer or pointer to member."
) ? void (0) : __assert_fail ("(SrcType->isAnyPointerType() || SrcType->isMemberPointerType() || SrcType->isBlockPointerType()) && \"Source type is not pointer or pointer to member.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 651, __extension__ __PRETTY_FUNCTION__))
651 "Source type is not pointer or pointer to member.")(static_cast <bool> ((SrcType->isAnyPointerType() ||
SrcType->isMemberPointerType() || SrcType->isBlockPointerType
()) && "Source type is not pointer or pointer to member."
) ? void (0) : __assert_fail ("(SrcType->isAnyPointerType() || SrcType->isMemberPointerType() || SrcType->isBlockPointerType()) && \"Source type is not pointer or pointer to member.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 651, __extension__ __PRETTY_FUNCTION__))
;
652 assert((DestType->isAnyPointerType() || DestType->isMemberPointerType() ||(static_cast <bool> ((DestType->isAnyPointerType() ||
DestType->isMemberPointerType() || DestType->isBlockPointerType
()) && "Destination type is not pointer or pointer to member."
) ? void (0) : __assert_fail ("(DestType->isAnyPointerType() || DestType->isMemberPointerType() || DestType->isBlockPointerType()) && \"Destination type is not pointer or pointer to member.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 654, __extension__ __PRETTY_FUNCTION__))
653 DestType->isBlockPointerType()) &&(static_cast <bool> ((DestType->isAnyPointerType() ||
DestType->isMemberPointerType() || DestType->isBlockPointerType
()) && "Destination type is not pointer or pointer to member."
) ? void (0) : __assert_fail ("(DestType->isAnyPointerType() || DestType->isMemberPointerType() || DestType->isBlockPointerType()) && \"Destination type is not pointer or pointer to member.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 654, __extension__ __PRETTY_FUNCTION__))
654 "Destination type is not pointer or pointer to member.")(static_cast <bool> ((DestType->isAnyPointerType() ||
DestType->isMemberPointerType() || DestType->isBlockPointerType
()) && "Destination type is not pointer or pointer to member."
) ? void (0) : __assert_fail ("(DestType->isAnyPointerType() || DestType->isMemberPointerType() || DestType->isBlockPointerType()) && \"Destination type is not pointer or pointer to member.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 654, __extension__ __PRETTY_FUNCTION__))
;
655 }
656
657 QualType UnwrappedSrcType = Self.Context.getCanonicalType(SrcType),
658 UnwrappedDestType = Self.Context.getCanonicalType(DestType);
659
660 // Find the qualifiers. We only care about cvr-qualifiers for the
661 // purpose of this check, because other qualifiers (address spaces,
662 // Objective-C GC, etc.) are part of the type's identity.
663 QualType PrevUnwrappedSrcType = UnwrappedSrcType;
664 QualType PrevUnwrappedDestType = UnwrappedDestType;
665 auto WorstKind = CastAwayConstnessKind::CACK_Similar;
666 bool AllConstSoFar = true;
667 while (auto Kind = unwrapCastAwayConstnessLevel(
668 Self.Context, UnwrappedSrcType, UnwrappedDestType)) {
669 // Track the worst kind of unwrap we needed to do before we found a
670 // problem.
671 if (Kind > WorstKind)
672 WorstKind = Kind;
673
674 // Determine the relevant qualifiers at this level.
675 Qualifiers SrcQuals, DestQuals;
676 Self.Context.getUnqualifiedArrayType(UnwrappedSrcType, SrcQuals);
677 Self.Context.getUnqualifiedArrayType(UnwrappedDestType, DestQuals);
678
679 // We do not meaningfully track object const-ness of Objective-C object
680 // types. Remove const from the source type if either the source or
681 // the destination is an Objective-C object type.
682 if (UnwrappedSrcType->isObjCObjectType() ||
683 UnwrappedDestType->isObjCObjectType())
684 SrcQuals.removeConst();
685
686 if (CheckCVR) {
687 Qualifiers SrcCvrQuals =
688 Qualifiers::fromCVRMask(SrcQuals.getCVRQualifiers());
689 Qualifiers DestCvrQuals =
690 Qualifiers::fromCVRMask(DestQuals.getCVRQualifiers());
691
692 if (SrcCvrQuals != DestCvrQuals) {
693 if (CastAwayQualifiers)
694 *CastAwayQualifiers = SrcCvrQuals - DestCvrQuals;
695
696 // If we removed a cvr-qualifier, this is casting away 'constness'.
697 if (!DestCvrQuals.compatiblyIncludes(SrcCvrQuals)) {
698 if (TheOffendingSrcType)
699 *TheOffendingSrcType = PrevUnwrappedSrcType;
700 if (TheOffendingDestType)
701 *TheOffendingDestType = PrevUnwrappedDestType;
702 return WorstKind;
703 }
704
705 // If any prior level was not 'const', this is also casting away
706 // 'constness'. We noted the outermost type missing a 'const' already.
707 if (!AllConstSoFar)
708 return WorstKind;
709 }
710 }
711
712 if (CheckObjCLifetime &&
713 !DestQuals.compatiblyIncludesObjCLifetime(SrcQuals))
714 return WorstKind;
715
716 // If we found our first non-const-qualified type, this may be the place
717 // where things start to go wrong.
718 if (AllConstSoFar && !DestQuals.hasConst()) {
719 AllConstSoFar = false;
720 if (TheOffendingSrcType)
721 *TheOffendingSrcType = PrevUnwrappedSrcType;
722 if (TheOffendingDestType)
723 *TheOffendingDestType = PrevUnwrappedDestType;
724 }
725
726 PrevUnwrappedSrcType = UnwrappedSrcType;
727 PrevUnwrappedDestType = UnwrappedDestType;
728 }
729
730 return CastAwayConstnessKind::CACK_None;
731}
732
733static TryCastResult getCastAwayConstnessCastKind(CastAwayConstnessKind CACK,
734 unsigned &DiagID) {
735 switch (CACK) {
736 case CastAwayConstnessKind::CACK_None:
737 llvm_unreachable("did not cast away constness")::llvm::llvm_unreachable_internal("did not cast away constness"
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 737)
;
738
739 case CastAwayConstnessKind::CACK_Similar:
740 // FIXME: Accept these as an extension too?
741 case CastAwayConstnessKind::CACK_SimilarKind:
742 DiagID = diag::err_bad_cxx_cast_qualifiers_away;
743 return TC_Failed;
744
745 case CastAwayConstnessKind::CACK_Incoherent:
746 DiagID = diag::ext_bad_cxx_cast_qualifiers_away_incoherent;
747 return TC_Extension;
748 }
749
750 llvm_unreachable("unexpected cast away constness kind")::llvm::llvm_unreachable_internal("unexpected cast away constness kind"
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 750)
;
751}
752
753/// CheckDynamicCast - Check that a dynamic_cast\<DestType\>(SrcExpr) is valid.
754/// Refer to C++ 5.2.7 for details. Dynamic casts are used mostly for runtime-
755/// checked downcasts in class hierarchies.
756void CastOperation::CheckDynamicCast() {
757 CheckNoDerefRAII NoderefCheck(*this);
758
759 if (ValueKind == VK_PRValue)
760 SrcExpr = Self.DefaultFunctionArrayLvalueConversion(SrcExpr.get());
761 else if (isPlaceholder())
762 SrcExpr = Self.CheckPlaceholderExpr(SrcExpr.get());
763 if (SrcExpr.isInvalid()) // if conversion failed, don't report another error
764 return;
765
766 QualType OrigSrcType = SrcExpr.get()->getType();
767 QualType DestType = Self.Context.getCanonicalType(this->DestType);
768
769 // C++ 5.2.7p1: T shall be a pointer or reference to a complete class type,
770 // or "pointer to cv void".
771
772 QualType DestPointee;
773 const PointerType *DestPointer = DestType->getAs<PointerType>();
774 const ReferenceType *DestReference = nullptr;
775 if (DestPointer) {
776 DestPointee = DestPointer->getPointeeType();
777 } else if ((DestReference = DestType->getAs<ReferenceType>())) {
778 DestPointee = DestReference->getPointeeType();
779 } else {
780 Self.Diag(OpRange.getBegin(), diag::err_bad_dynamic_cast_not_ref_or_ptr)
781 << this->DestType << DestRange;
782 SrcExpr = ExprError();
783 return;
784 }
785
786 const RecordType *DestRecord = DestPointee->getAs<RecordType>();
787 if (DestPointee->isVoidType()) {
788 assert(DestPointer && "Reference to void is not possible")(static_cast <bool> (DestPointer && "Reference to void is not possible"
) ? void (0) : __assert_fail ("DestPointer && \"Reference to void is not possible\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 788, __extension__ __PRETTY_FUNCTION__))
;
789 } else if (DestRecord) {
790 if (Self.RequireCompleteType(OpRange.getBegin(), DestPointee,
791 diag::err_bad_cast_incomplete,
792 DestRange)) {
793 SrcExpr = ExprError();
794 return;
795 }
796 } else {
797 Self.Diag(OpRange.getBegin(), diag::err_bad_dynamic_cast_not_class)
798 << DestPointee.getUnqualifiedType() << DestRange;
799 SrcExpr = ExprError();
800 return;
801 }
802
803 // C++0x 5.2.7p2: If T is a pointer type, v shall be an rvalue of a pointer to
804 // complete class type, [...]. If T is an lvalue reference type, v shall be
805 // an lvalue of a complete class type, [...]. If T is an rvalue reference
806 // type, v shall be an expression having a complete class type, [...]
807 QualType SrcType = Self.Context.getCanonicalType(OrigSrcType);
808 QualType SrcPointee;
809 if (DestPointer) {
810 if (const PointerType *SrcPointer = SrcType->getAs<PointerType>()) {
811 SrcPointee = SrcPointer->getPointeeType();
812 } else {
813 Self.Diag(OpRange.getBegin(), diag::err_bad_dynamic_cast_not_ptr)
814 << OrigSrcType << this->DestType << SrcExpr.get()->getSourceRange();
815 SrcExpr = ExprError();
816 return;
817 }
818 } else if (DestReference->isLValueReferenceType()) {
819 if (!SrcExpr.get()->isLValue()) {
820 Self.Diag(OpRange.getBegin(), diag::err_bad_cxx_cast_rvalue)
821 << CT_Dynamic << OrigSrcType << this->DestType << OpRange;
822 }
823 SrcPointee = SrcType;
824 } else {
825 // If we're dynamic_casting from a prvalue to an rvalue reference, we need
826 // to materialize the prvalue before we bind the reference to it.
827 if (SrcExpr.get()->isPRValue())
828 SrcExpr = Self.CreateMaterializeTemporaryExpr(
829 SrcType, SrcExpr.get(), /*IsLValueReference*/ false);
830 SrcPointee = SrcType;
831 }
832
833 const RecordType *SrcRecord = SrcPointee->getAs<RecordType>();
834 if (SrcRecord) {
835 if (Self.RequireCompleteType(OpRange.getBegin(), SrcPointee,
836 diag::err_bad_cast_incomplete,
837 SrcExpr.get())) {
838 SrcExpr = ExprError();
839 return;
840 }
841 } else {
842 Self.Diag(OpRange.getBegin(), diag::err_bad_dynamic_cast_not_class)
843 << SrcPointee.getUnqualifiedType() << SrcExpr.get()->getSourceRange();
844 SrcExpr = ExprError();
845 return;
846 }
847
848 assert((DestPointer || DestReference) &&(static_cast <bool> ((DestPointer || DestReference) &&
"Bad destination non-ptr/ref slipped through.") ? void (0) :
__assert_fail ("(DestPointer || DestReference) && \"Bad destination non-ptr/ref slipped through.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 849, __extension__ __PRETTY_FUNCTION__))
849 "Bad destination non-ptr/ref slipped through.")(static_cast <bool> ((DestPointer || DestReference) &&
"Bad destination non-ptr/ref slipped through.") ? void (0) :
__assert_fail ("(DestPointer || DestReference) && \"Bad destination non-ptr/ref slipped through.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 849, __extension__ __PRETTY_FUNCTION__))
;
850 assert((DestRecord || DestPointee->isVoidType()) &&(static_cast <bool> ((DestRecord || DestPointee->isVoidType
()) && "Bad destination pointee slipped through.") ? void
(0) : __assert_fail ("(DestRecord || DestPointee->isVoidType()) && \"Bad destination pointee slipped through.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 851, __extension__ __PRETTY_FUNCTION__))
851 "Bad destination pointee slipped through.")(static_cast <bool> ((DestRecord || DestPointee->isVoidType
()) && "Bad destination pointee slipped through.") ? void
(0) : __assert_fail ("(DestRecord || DestPointee->isVoidType()) && \"Bad destination pointee slipped through.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 851, __extension__ __PRETTY_FUNCTION__))
;
852 assert(SrcRecord && "Bad source pointee slipped through.")(static_cast <bool> (SrcRecord && "Bad source pointee slipped through."
) ? void (0) : __assert_fail ("SrcRecord && \"Bad source pointee slipped through.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 852, __extension__ __PRETTY_FUNCTION__))
;
853
854 // C++ 5.2.7p1: The dynamic_cast operator shall not cast away constness.
855 if (!DestPointee.isAtLeastAsQualifiedAs(SrcPointee)) {
856 Self.Diag(OpRange.getBegin(), diag::err_bad_cxx_cast_qualifiers_away)
857 << CT_Dynamic << OrigSrcType << this->DestType << OpRange;
858 SrcExpr = ExprError();
859 return;
860 }
861
862 // C++ 5.2.7p3: If the type of v is the same as the required result type,
863 // [except for cv].
864 if (DestRecord == SrcRecord) {
865 Kind = CK_NoOp;
866 return;
867 }
868
869 // C++ 5.2.7p5
870 // Upcasts are resolved statically.
871 if (DestRecord &&
872 Self.IsDerivedFrom(OpRange.getBegin(), SrcPointee, DestPointee)) {
873 if (Self.CheckDerivedToBaseConversion(SrcPointee, DestPointee,
874 OpRange.getBegin(), OpRange,
875 &BasePath)) {
876 SrcExpr = ExprError();
877 return;
878 }
879
880 Kind = CK_DerivedToBase;
881 return;
882 }
883
884 // C++ 5.2.7p6: Otherwise, v shall be [polymorphic].
885 const RecordDecl *SrcDecl = SrcRecord->getDecl()->getDefinition();
886 assert(SrcDecl && "Definition missing")(static_cast <bool> (SrcDecl && "Definition missing"
) ? void (0) : __assert_fail ("SrcDecl && \"Definition missing\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 886, __extension__ __PRETTY_FUNCTION__))
;
887 if (!cast<CXXRecordDecl>(SrcDecl)->isPolymorphic()) {
888 Self.Diag(OpRange.getBegin(), diag::err_bad_dynamic_cast_not_polymorphic)
889 << SrcPointee.getUnqualifiedType() << SrcExpr.get()->getSourceRange();
890 SrcExpr = ExprError();
891 }
892
893 // dynamic_cast is not available with -fno-rtti.
894 // As an exception, dynamic_cast to void* is available because it doesn't
895 // use RTTI.
896 if (!Self.getLangOpts().RTTI && !DestPointee->isVoidType()) {
897 Self.Diag(OpRange.getBegin(), diag::err_no_dynamic_cast_with_fno_rtti);
898 SrcExpr = ExprError();
899 return;
900 }
901
902 // Warns when dynamic_cast is used with RTTI data disabled.
903 if (!Self.getLangOpts().RTTIData) {
904 bool MicrosoftABI =
905 Self.getASTContext().getTargetInfo().getCXXABI().isMicrosoft();
906 bool isClangCL = Self.getDiagnostics().getDiagnosticOptions().getFormat() ==
907 DiagnosticOptions::MSVC;
908 if (MicrosoftABI || !DestPointee->isVoidType())
909 Self.Diag(OpRange.getBegin(),
910 diag::warn_no_dynamic_cast_with_rtti_disabled)
911 << isClangCL;
912 }
913
914 // Done. Everything else is run-time checks.
915 Kind = CK_Dynamic;
916}
917
918/// CheckConstCast - Check that a const_cast\<DestType\>(SrcExpr) is valid.
919/// Refer to C++ 5.2.11 for details. const_cast is typically used in code
920/// like this:
921/// const char *str = "literal";
922/// legacy_function(const_cast\<char*\>(str));
923void CastOperation::CheckConstCast() {
924 CheckNoDerefRAII NoderefCheck(*this);
925
926 if (ValueKind == VK_PRValue)
927 SrcExpr = Self.DefaultFunctionArrayLvalueConversion(SrcExpr.get());
928 else if (isPlaceholder())
929 SrcExpr = Self.CheckPlaceholderExpr(SrcExpr.get());
930 if (SrcExpr.isInvalid()) // if conversion failed, don't report another error
931 return;
932
933 unsigned msg = diag::err_bad_cxx_cast_generic;
934 auto TCR = TryConstCast(Self, SrcExpr, DestType, /*CStyle*/ false, msg);
935 if (TCR != TC_Success && msg != 0) {
936 Self.Diag(OpRange.getBegin(), msg) << CT_Const
937 << SrcExpr.get()->getType() << DestType << OpRange;
938 }
939 if (!isValidCast(TCR))
940 SrcExpr = ExprError();
941}
942
943void CastOperation::CheckAddrspaceCast() {
944 unsigned msg = diag::err_bad_cxx_cast_generic;
945 auto TCR =
946 TryAddressSpaceCast(Self, SrcExpr, DestType, /*CStyle*/ false, msg, Kind);
947 if (TCR != TC_Success && msg != 0) {
948 Self.Diag(OpRange.getBegin(), msg)
949 << CT_Addrspace << SrcExpr.get()->getType() << DestType << OpRange;
950 }
951 if (!isValidCast(TCR))
952 SrcExpr = ExprError();
953}
954
955/// Check that a reinterpret_cast\<DestType\>(SrcExpr) is not used as upcast
956/// or downcast between respective pointers or references.
957static void DiagnoseReinterpretUpDownCast(Sema &Self, const Expr *SrcExpr,
958 QualType DestType,
959 SourceRange OpRange) {
960 QualType SrcType = SrcExpr->getType();
961 // When casting from pointer or reference, get pointee type; use original
962 // type otherwise.
963 const CXXRecordDecl *SrcPointeeRD = SrcType->getPointeeCXXRecordDecl();
964 const CXXRecordDecl *SrcRD =
965 SrcPointeeRD ? SrcPointeeRD : SrcType->getAsCXXRecordDecl();
966
967 // Examining subobjects for records is only possible if the complete and
968 // valid definition is available. Also, template instantiation is not
969 // allowed here.
970 if (!SrcRD || !SrcRD->isCompleteDefinition() || SrcRD->isInvalidDecl())
971 return;
972
973 const CXXRecordDecl *DestRD = DestType->getPointeeCXXRecordDecl();
974
975 if (!DestRD || !DestRD->isCompleteDefinition() || DestRD->isInvalidDecl())
976 return;
977
978 enum {
979 ReinterpretUpcast,
980 ReinterpretDowncast
981 } ReinterpretKind;
982
983 CXXBasePaths BasePaths;
984
985 if (SrcRD->isDerivedFrom(DestRD, BasePaths))
986 ReinterpretKind = ReinterpretUpcast;
987 else if (DestRD->isDerivedFrom(SrcRD, BasePaths))
988 ReinterpretKind = ReinterpretDowncast;
989 else
990 return;
991
992 bool VirtualBase = true;
993 bool NonZeroOffset = false;
994 for (CXXBasePaths::const_paths_iterator I = BasePaths.begin(),
995 E = BasePaths.end();
996 I != E; ++I) {
997 const CXXBasePath &Path = *I;
998 CharUnits Offset = CharUnits::Zero();
999 bool IsVirtual = false;
1000 for (CXXBasePath::const_iterator IElem = Path.begin(), EElem = Path.end();
1001 IElem != EElem; ++IElem) {
1002 IsVirtual = IElem->Base->isVirtual();
1003 if (IsVirtual)
1004 break;
1005 const CXXRecordDecl *BaseRD = IElem->Base->getType()->getAsCXXRecordDecl();
1006 assert(BaseRD && "Base type should be a valid unqualified class type")(static_cast <bool> (BaseRD && "Base type should be a valid unqualified class type"
) ? void (0) : __assert_fail ("BaseRD && \"Base type should be a valid unqualified class type\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 1006, __extension__ __PRETTY_FUNCTION__))
;
1007 // Don't check if any base has invalid declaration or has no definition
1008 // since it has no layout info.
1009 const CXXRecordDecl *Class = IElem->Class,
1010 *ClassDefinition = Class->getDefinition();
1011 if (Class->isInvalidDecl() || !ClassDefinition ||
1012 !ClassDefinition->isCompleteDefinition())
1013 return;
1014
1015 const ASTRecordLayout &DerivedLayout =
1016 Self.Context.getASTRecordLayout(Class);
1017 Offset += DerivedLayout.getBaseClassOffset(BaseRD);
1018 }
1019 if (!IsVirtual) {
1020 // Don't warn if any path is a non-virtually derived base at offset zero.
1021 if (Offset.isZero())
1022 return;
1023 // Offset makes sense only for non-virtual bases.
1024 else
1025 NonZeroOffset = true;
1026 }
1027 VirtualBase = VirtualBase && IsVirtual;
1028 }
1029
1030 (void) NonZeroOffset; // Silence set but not used warning.
1031 assert((VirtualBase || NonZeroOffset) &&(static_cast <bool> ((VirtualBase || NonZeroOffset) &&
"Should have returned if has non-virtual base with zero offset"
) ? void (0) : __assert_fail ("(VirtualBase || NonZeroOffset) && \"Should have returned if has non-virtual base with zero offset\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 1032, __extension__ __PRETTY_FUNCTION__))
1032 "Should have returned if has non-virtual base with zero offset")(static_cast <bool> ((VirtualBase || NonZeroOffset) &&
"Should have returned if has non-virtual base with zero offset"
) ? void (0) : __assert_fail ("(VirtualBase || NonZeroOffset) && \"Should have returned if has non-virtual base with zero offset\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 1032, __extension__ __PRETTY_FUNCTION__))
;
1033
1034 QualType BaseType =
1035 ReinterpretKind == ReinterpretUpcast? DestType : SrcType;
1036 QualType DerivedType =
1037 ReinterpretKind == ReinterpretUpcast? SrcType : DestType;
1038
1039 SourceLocation BeginLoc = OpRange.getBegin();
1040 Self.Diag(BeginLoc, diag::warn_reinterpret_different_from_static)
1041 << DerivedType << BaseType << !VirtualBase << int(ReinterpretKind)
1042 << OpRange;
1043 Self.Diag(BeginLoc, diag::note_reinterpret_updowncast_use_static)
1044 << int(ReinterpretKind)
1045 << FixItHint::CreateReplacement(BeginLoc, "static_cast");
1046}
1047
1048static bool argTypeIsABIEquivalent(QualType SrcType, QualType DestType,
1049 ASTContext &Context) {
1050 if (SrcType->isPointerType() && DestType->isPointerType())
1051 return true;
1052
1053 // Allow integral type mismatch if their size are equal.
1054 if (SrcType->isIntegralType(Context) && DestType->isIntegralType(Context))
1055 if (Context.getTypeInfoInChars(SrcType).Width ==
1056 Context.getTypeInfoInChars(DestType).Width)
1057 return true;
1058
1059 return Context.hasSameUnqualifiedType(SrcType, DestType);
1060}
1061
1062static bool checkCastFunctionType(Sema &Self, const ExprResult &SrcExpr,
1063 QualType DestType) {
1064 if (Self.Diags.isIgnored(diag::warn_cast_function_type,
1065 SrcExpr.get()->getExprLoc()))
1066 return true;
1067
1068 QualType SrcType = SrcExpr.get()->getType();
1069 const FunctionType *SrcFTy = nullptr;
1070 const FunctionType *DstFTy = nullptr;
1071 if (((SrcType->isBlockPointerType() || SrcType->isFunctionPointerType()) &&
1072 DestType->isFunctionPointerType()) ||
1073 (SrcType->isMemberFunctionPointerType() &&
1074 DestType->isMemberFunctionPointerType())) {
1075 SrcFTy = SrcType->getPointeeType()->castAs<FunctionType>();
1076 DstFTy = DestType->getPointeeType()->castAs<FunctionType>();
1077 } else if (SrcType->isFunctionType() && DestType->isFunctionReferenceType()) {
1078 SrcFTy = SrcType->castAs<FunctionType>();
1079 DstFTy = DestType.getNonReferenceType()->castAs<FunctionType>();
1080 } else {
1081 return true;
1082 }
1083 assert(SrcFTy && DstFTy)(static_cast <bool> (SrcFTy && DstFTy) ? void (
0) : __assert_fail ("SrcFTy && DstFTy", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 1083, __extension__ __PRETTY_FUNCTION__))
;
1084
1085 auto IsVoidVoid = [](const FunctionType *T) {
1086 if (!T->getReturnType()->isVoidType())
1087 return false;
1088 if (const auto *PT = T->getAs<FunctionProtoType>())
1089 return !PT->isVariadic() && PT->getNumParams() == 0;
1090 return false;
1091 };
1092
1093 // Skip if either function type is void(*)(void)
1094 if (IsVoidVoid(SrcFTy) || IsVoidVoid(DstFTy))
1095 return true;
1096
1097 // Check return type.
1098 if (!argTypeIsABIEquivalent(SrcFTy->getReturnType(), DstFTy->getReturnType(),
1099 Self.Context))
1100 return false;
1101
1102 // Check if either has unspecified number of parameters
1103 if (SrcFTy->isFunctionNoProtoType() || DstFTy->isFunctionNoProtoType())
1104 return true;
1105
1106 // Check parameter types.
1107
1108 const auto *SrcFPTy = cast<FunctionProtoType>(SrcFTy);
1109 const auto *DstFPTy = cast<FunctionProtoType>(DstFTy);
1110
1111 // In a cast involving function types with a variable argument list only the
1112 // types of initial arguments that are provided are considered.
1113 unsigned NumParams = SrcFPTy->getNumParams();
1114 unsigned DstNumParams = DstFPTy->getNumParams();
1115 if (NumParams > DstNumParams) {
1116 if (!DstFPTy->isVariadic())
1117 return false;
1118 NumParams = DstNumParams;
1119 } else if (NumParams < DstNumParams) {
1120 if (!SrcFPTy->isVariadic())
1121 return false;
1122 }
1123
1124 for (unsigned i = 0; i < NumParams; ++i)
1125 if (!argTypeIsABIEquivalent(SrcFPTy->getParamType(i),
1126 DstFPTy->getParamType(i), Self.Context))
1127 return false;
1128
1129 return true;
1130}
1131
1132/// CheckReinterpretCast - Check that a reinterpret_cast\<DestType\>(SrcExpr) is
1133/// valid.
1134/// Refer to C++ 5.2.10 for details. reinterpret_cast is typically used in code
1135/// like this:
1136/// char *bytes = reinterpret_cast\<char*\>(int_ptr);
1137void CastOperation::CheckReinterpretCast() {
1138 if (ValueKind == VK_PRValue && !isPlaceholder(BuiltinType::Overload))
1139 SrcExpr = Self.DefaultFunctionArrayLvalueConversion(SrcExpr.get());
1140 else
1141 checkNonOverloadPlaceholders();
1142 if (SrcExpr.isInvalid()) // if conversion failed, don't report another error
1143 return;
1144
1145 unsigned msg = diag::err_bad_cxx_cast_generic;
1146 TryCastResult tcr =
1147 TryReinterpretCast(Self, SrcExpr, DestType,
1148 /*CStyle*/false, OpRange, msg, Kind);
1149 if (tcr != TC_Success && msg != 0) {
1150 if (SrcExpr.isInvalid()) // if conversion failed, don't report another error
1151 return;
1152 if (SrcExpr.get()->getType() == Self.Context.OverloadTy) {
1153 //FIXME: &f<int>; is overloaded and resolvable
1154 Self.Diag(OpRange.getBegin(), diag::err_bad_reinterpret_cast_overload)
1155 << OverloadExpr::find(SrcExpr.get()).Expression->getName()
1156 << DestType << OpRange;
1157 Self.NoteAllOverloadCandidates(SrcExpr.get());
1158
1159 } else {
1160 diagnoseBadCast(Self, msg, CT_Reinterpret, OpRange, SrcExpr.get(),
1161 DestType, /*listInitialization=*/false);
1162 }
1163 }
1164
1165 if (isValidCast(tcr)) {
1166 if (Self.getLangOpts().allowsNonTrivialObjCLifetimeQualifiers())
1167 checkObjCConversion(Sema::CCK_OtherCast);
1168 DiagnoseReinterpretUpDownCast(Self, SrcExpr.get(), DestType, OpRange);
1169
1170 if (!checkCastFunctionType(Self, SrcExpr, DestType))
1171 Self.Diag(OpRange.getBegin(), diag::warn_cast_function_type)
1172 << SrcExpr.get()->getType() << DestType << OpRange;
1173 } else {
1174 SrcExpr = ExprError();
1175 }
1176}
1177
1178
1179/// CheckStaticCast - Check that a static_cast\<DestType\>(SrcExpr) is valid.
1180/// Refer to C++ 5.2.9 for details. Static casts are mostly used for making
1181/// implicit conversions explicit and getting rid of data loss warnings.
1182void CastOperation::CheckStaticCast() {
1183 CheckNoDerefRAII NoderefCheck(*this);
1184
1185 if (isPlaceholder()) {
1
Taking false branch
1186 checkNonOverloadPlaceholders();
1187 if (SrcExpr.isInvalid())
1188 return;
1189 }
1190
1191 // This test is outside everything else because it's the only case where
1192 // a non-lvalue-reference target type does not lead to decay.
1193 // C++ 5.2.9p4: Any expression can be explicitly converted to type "cv void".
1194 if (DestType->isVoidType()) {
1195 Kind = CK_ToVoid;
1196
1197 if (claimPlaceholder(BuiltinType::Overload)) {
1198 Self.ResolveAndFixSingleFunctionTemplateSpecialization(SrcExpr,
1199 false, // Decay Function to ptr
1200 true, // Complain
1201 OpRange, DestType, diag::err_bad_static_cast_overload);
1202 if (SrcExpr.isInvalid())
1203 return;
1204 }
1205
1206 SrcExpr = Self.IgnoredValueConversions(SrcExpr.get());
1207 return;
1208 }
1209
1210 if (ValueKind == VK_PRValue && !DestType->isRecordType() &&
2
Assuming field 'ValueKind' is not equal to VK_PRValue
1211 !isPlaceholder(BuiltinType::Overload)) {
1212 SrcExpr = Self.DefaultFunctionArrayLvalueConversion(SrcExpr.get());
1213 if (SrcExpr.isInvalid()) // if conversion failed, don't report another error
1214 return;
1215 }
1216
1217 unsigned msg = diag::err_bad_cxx_cast_generic;
1218 TryCastResult tcr
1219 = TryStaticCast(Self, SrcExpr, DestType, Sema::CCK_OtherCast, OpRange, msg,
3
Calling 'TryStaticCast'
1220 Kind, BasePath, /*ListInitialization=*/false);
1221 if (tcr != TC_Success && msg != 0) {
1222 if (SrcExpr.isInvalid())
1223 return;
1224 if (SrcExpr.get()->getType() == Self.Context.OverloadTy) {
1225 OverloadExpr* oe = OverloadExpr::find(SrcExpr.get()).Expression;
1226 Self.Diag(OpRange.getBegin(), diag::err_bad_static_cast_overload)
1227 << oe->getName() << DestType << OpRange
1228 << oe->getQualifierLoc().getSourceRange();
1229 Self.NoteAllOverloadCandidates(SrcExpr.get());
1230 } else {
1231 diagnoseBadCast(Self, msg, CT_Static, OpRange, SrcExpr.get(), DestType,
1232 /*listInitialization=*/false);
1233 }
1234 }
1235
1236 if (isValidCast(tcr)) {
1237 if (Kind == CK_BitCast)
1238 checkCastAlign();
1239 if (Self.getLangOpts().allowsNonTrivialObjCLifetimeQualifiers())
1240 checkObjCConversion(Sema::CCK_OtherCast);
1241 } else {
1242 SrcExpr = ExprError();
1243 }
1244}
1245
1246static bool IsAddressSpaceConversion(QualType SrcType, QualType DestType) {
1247 auto *SrcPtrType = SrcType->getAs<PointerType>();
1248 if (!SrcPtrType)
1249 return false;
1250 auto *DestPtrType = DestType->getAs<PointerType>();
1251 if (!DestPtrType)
1252 return false;
1253 return SrcPtrType->getPointeeType().getAddressSpace() !=
1254 DestPtrType->getPointeeType().getAddressSpace();
1255}
1256
1257/// TryStaticCast - Check if a static cast can be performed, and do so if
1258/// possible. If @p CStyle, ignore access restrictions on hierarchy casting
1259/// and casting away constness.
1260static TryCastResult TryStaticCast(Sema &Self, ExprResult &SrcExpr,
1261 QualType DestType,
1262 Sema::CheckedConversionKind CCK,
1263 SourceRange OpRange, unsigned &msg,
1264 CastKind &Kind, CXXCastPath &BasePath,
1265 bool ListInitialization) {
1266 // Determine whether we have the semantics of a C-style cast.
1267 bool CStyle
1268 = (CCK
3.1
'CCK' is not equal to CCK_CStyleCast
3.1
'CCK' is not equal to CCK_CStyleCast
3.1
'CCK' is not equal to CCK_CStyleCast
== Sema::CCK_CStyleCast || CCK == Sema::CCK_FunctionalCast);
1269
1270 // The order the tests is not entirely arbitrary. There is one conversion
1271 // that can be handled in two different ways. Given:
1272 // struct A {};
1273 // struct B : public A {
1274 // B(); B(const A&);
1275 // };
1276 // const A &a = B();
1277 // the cast static_cast<const B&>(a) could be seen as either a static
1278 // reference downcast, or an explicit invocation of the user-defined
1279 // conversion using B's conversion constructor.
1280 // DR 427 specifies that the downcast is to be applied here.
1281
1282 // C++ 5.2.9p4: Any expression can be explicitly converted to type "cv void".
1283 // Done outside this function.
1284
1285 TryCastResult tcr;
1286
1287 // C++ 5.2.9p5, reference downcast.
1288 // See the function for details.
1289 // DR 427 specifies that this is to be applied before paragraph 2.
1290 tcr = TryStaticReferenceDowncast(Self, SrcExpr.get(), DestType, CStyle,
1291 OpRange, msg, Kind, BasePath);
1292 if (tcr
3.2
'tcr' is equal to TC_NotApplicable
3.2
'tcr' is equal to TC_NotApplicable
3.2
'tcr' is equal to TC_NotApplicable
!= TC_NotApplicable)
4
Taking false branch
1293 return tcr;
1294
1295 // C++11 [expr.static.cast]p3:
1296 // A glvalue of type "cv1 T1" can be cast to type "rvalue reference to cv2
1297 // T2" if "cv2 T2" is reference-compatible with "cv1 T1".
1298 tcr = TryLValueToRValueCast(Self, SrcExpr.get(), DestType, CStyle, Kind,
1299 BasePath, msg);
1300 if (tcr
4.1
'tcr' is equal to TC_NotApplicable
4.1
'tcr' is equal to TC_NotApplicable
4.1
'tcr' is equal to TC_NotApplicable
!= TC_NotApplicable)
5
Taking false branch
1301 return tcr;
1302
1303 // C++ 5.2.9p2: An expression e can be explicitly converted to a type T
1304 // [...] if the declaration "T t(e);" is well-formed, [...].
1305 tcr = TryStaticImplicitCast(Self, SrcExpr, DestType, CCK, OpRange, msg,
1306 Kind, ListInitialization);
1307 if (SrcExpr.isInvalid())
6
Assuming the condition is false
7
Taking false branch
1308 return TC_Failed;
1309 if (tcr
7.1
'tcr' is equal to TC_NotApplicable
7.1
'tcr' is equal to TC_NotApplicable
7.1
'tcr' is equal to TC_NotApplicable
!= TC_NotApplicable)
8
Taking false branch
1310 return tcr;
1311
1312 // C++ 5.2.9p6: May apply the reverse of any standard conversion, except
1313 // lvalue-to-rvalue, array-to-pointer, function-to-pointer, and boolean
1314 // conversions, subject to further restrictions.
1315 // Also, C++ 5.2.9p1 forbids casting away constness, which makes reversal
1316 // of qualification conversions impossible.
1317 // In the CStyle case, the earlier attempt to const_cast should have taken
1318 // care of reverse qualification conversions.
1319
1320 QualType SrcType = Self.Context.getCanonicalType(SrcExpr.get()->getType());
1321
1322 // C++0x 5.2.9p9: A value of a scoped enumeration type can be explicitly
1323 // converted to an integral type. [...] A value of a scoped enumeration type
1324 // can also be explicitly converted to a floating-point type [...].
1325 if (const EnumType *Enum
9.1
'Enum' is null
9.1
'Enum' is null
9.1
'Enum' is null
= SrcType->getAs<EnumType>()) {
9
Assuming the object is not a 'EnumType'
10
Taking false branch
1326 if (Enum->getDecl()->isScoped()) {
1327 if (DestType->isBooleanType()) {
1328 Kind = CK_IntegralToBoolean;
1329 return TC_Success;
1330 } else if (DestType->isIntegralType(Self.Context)) {
1331 Kind = CK_IntegralCast;
1332 return TC_Success;
1333 } else if (DestType->isRealFloatingType()) {
1334 Kind = CK_IntegralToFloating;
1335 return TC_Success;
1336 }
1337 }
1338 }
1339
1340 // Reverse integral promotion/conversion. All such conversions are themselves
1341 // again integral promotions or conversions and are thus already handled by
1342 // p2 (TryDirectInitialization above).
1343 // (Note: any data loss warnings should be suppressed.)
1344 // The exception is the reverse of enum->integer, i.e. integer->enum (and
1345 // enum->enum). See also C++ 5.2.9p7.
1346 // The same goes for reverse floating point promotion/conversion and
1347 // floating-integral conversions. Again, only floating->enum is relevant.
1348 if (DestType->isEnumeralType()) {
11
Calling 'Type::isEnumeralType'
14
Returning from 'Type::isEnumeralType'
15
Taking true branch
1349 if (Self.RequireCompleteType(OpRange.getBegin(), DestType,
16
Assuming the condition is false
17
Taking false branch
1350 diag::err_bad_cast_incomplete)) {
1351 SrcExpr = ExprError();
1352 return TC_Failed;
1353 }
1354 if (SrcType->isIntegralOrEnumerationType()) {
18
Calling 'Type::isIntegralOrEnumerationType'
36
Returning from 'Type::isIntegralOrEnumerationType'
37
Taking true branch
1355 // [expr.static.cast]p10 If the enumeration type has a fixed underlying
1356 // type, the value is first converted to that type by integral conversion
1357 const EnumType *Enum = DestType->getAs<EnumType>();
38
Assuming the object is not a 'EnumType'
39
'Enum' initialized to a null pointer value
1358 Kind = Enum->getDecl()->isFixed() &&
40
Called C++ object pointer is null
1359 Enum->getDecl()->getIntegerType()->isBooleanType()
1360 ? CK_IntegralToBoolean
1361 : CK_IntegralCast;
1362 return TC_Success;
1363 } else if (SrcType->isRealFloatingType()) {
1364 Kind = CK_FloatingToIntegral;
1365 return TC_Success;
1366 }
1367 }
1368
1369 // Reverse pointer upcast. C++ 4.10p3 specifies pointer upcast.
1370 // C++ 5.2.9p8 additionally disallows a cast path through virtual inheritance.
1371 tcr = TryStaticPointerDowncast(Self, SrcType, DestType, CStyle, OpRange, msg,
1372 Kind, BasePath);
1373 if (tcr != TC_NotApplicable)
1374 return tcr;
1375
1376 // Reverse member pointer conversion. C++ 4.11 specifies member pointer
1377 // conversion. C++ 5.2.9p9 has additional information.
1378 // DR54's access restrictions apply here also.
1379 tcr = TryStaticMemberPointerUpcast(Self, SrcExpr, SrcType, DestType, CStyle,
1380 OpRange, msg, Kind, BasePath);
1381 if (tcr != TC_NotApplicable)
1382 return tcr;
1383
1384 // Reverse pointer conversion to void*. C++ 4.10.p2 specifies conversion to
1385 // void*. C++ 5.2.9p10 specifies additional restrictions, which really is
1386 // just the usual constness stuff.
1387 if (const PointerType *SrcPointer = SrcType->getAs<PointerType>()) {
1388 QualType SrcPointee = SrcPointer->getPointeeType();
1389 if (SrcPointee->isVoidType()) {
1390 if (const PointerType *DestPointer = DestType->getAs<PointerType>()) {
1391 QualType DestPointee = DestPointer->getPointeeType();
1392 if (DestPointee->isIncompleteOrObjectType()) {
1393 // This is definitely the intended conversion, but it might fail due
1394 // to a qualifier violation. Note that we permit Objective-C lifetime
1395 // and GC qualifier mismatches here.
1396 if (!CStyle) {
1397 Qualifiers DestPointeeQuals = DestPointee.getQualifiers();
1398 Qualifiers SrcPointeeQuals = SrcPointee.getQualifiers();
1399 DestPointeeQuals.removeObjCGCAttr();
1400 DestPointeeQuals.removeObjCLifetime();
1401 SrcPointeeQuals.removeObjCGCAttr();
1402 SrcPointeeQuals.removeObjCLifetime();
1403 if (DestPointeeQuals != SrcPointeeQuals &&
1404 !DestPointeeQuals.compatiblyIncludes(SrcPointeeQuals)) {
1405 msg = diag::err_bad_cxx_cast_qualifiers_away;
1406 return TC_Failed;
1407 }
1408 }
1409 Kind = IsAddressSpaceConversion(SrcType, DestType)
1410 ? CK_AddressSpaceConversion
1411 : CK_BitCast;
1412 return TC_Success;
1413 }
1414
1415 // Microsoft permits static_cast from 'pointer-to-void' to
1416 // 'pointer-to-function'.
1417 if (!CStyle && Self.getLangOpts().MSVCCompat &&
1418 DestPointee->isFunctionType()) {
1419 Self.Diag(OpRange.getBegin(), diag::ext_ms_cast_fn_obj) << OpRange;
1420 Kind = CK_BitCast;
1421 return TC_Success;
1422 }
1423 }
1424 else if (DestType->isObjCObjectPointerType()) {
1425 // allow both c-style cast and static_cast of objective-c pointers as
1426 // they are pervasive.
1427 Kind = CK_CPointerToObjCPointerCast;
1428 return TC_Success;
1429 }
1430 else if (CStyle && DestType->isBlockPointerType()) {
1431 // allow c-style cast of void * to block pointers.
1432 Kind = CK_AnyPointerToBlockPointerCast;
1433 return TC_Success;
1434 }
1435 }
1436 }
1437 // Allow arbitrary objective-c pointer conversion with static casts.
1438 if (SrcType->isObjCObjectPointerType() &&
1439 DestType->isObjCObjectPointerType()) {
1440 Kind = CK_BitCast;
1441 return TC_Success;
1442 }
1443 // Allow ns-pointer to cf-pointer conversion in either direction
1444 // with static casts.
1445 if (!CStyle &&
1446 Self.CheckTollFreeBridgeStaticCast(DestType, SrcExpr.get(), Kind))
1447 return TC_Success;
1448
1449 // See if it looks like the user is trying to convert between
1450 // related record types, and select a better diagnostic if so.
1451 if (auto SrcPointer = SrcType->getAs<PointerType>())
1452 if (auto DestPointer = DestType->getAs<PointerType>())
1453 if (SrcPointer->getPointeeType()->getAs<RecordType>() &&
1454 DestPointer->getPointeeType()->getAs<RecordType>())
1455 msg = diag::err_bad_cxx_cast_unrelated_class;
1456
1457 if (SrcType->isMatrixType() && DestType->isMatrixType()) {
1458 if (Self.CheckMatrixCast(OpRange, DestType, SrcType, Kind)) {
1459 SrcExpr = ExprError();
1460 return TC_Failed;
1461 }
1462 return TC_Success;
1463 }
1464
1465 // We tried everything. Everything! Nothing works! :-(
1466 return TC_NotApplicable;
1467}
1468
1469/// Tests whether a conversion according to N2844 is valid.
1470TryCastResult TryLValueToRValueCast(Sema &Self, Expr *SrcExpr,
1471 QualType DestType, bool CStyle,
1472 CastKind &Kind, CXXCastPath &BasePath,
1473 unsigned &msg) {
1474 // C++11 [expr.static.cast]p3:
1475 // A glvalue of type "cv1 T1" can be cast to type "rvalue reference to
1476 // cv2 T2" if "cv2 T2" is reference-compatible with "cv1 T1".
1477 const RValueReferenceType *R = DestType->getAs<RValueReferenceType>();
1478 if (!R)
1479 return TC_NotApplicable;
1480
1481 if (!SrcExpr->isGLValue())
1482 return TC_NotApplicable;
1483
1484 // Because we try the reference downcast before this function, from now on
1485 // this is the only cast possibility, so we issue an error if we fail now.
1486 // FIXME: Should allow casting away constness if CStyle.
1487 QualType FromType = SrcExpr->getType();
1488 QualType ToType = R->getPointeeType();
1489 if (CStyle) {
1490 FromType = FromType.getUnqualifiedType();
1491 ToType = ToType.getUnqualifiedType();
1492 }
1493
1494 Sema::ReferenceConversions RefConv;
1495 Sema::ReferenceCompareResult RefResult = Self.CompareReferenceRelationship(
1496 SrcExpr->getBeginLoc(), ToType, FromType, &RefConv);
1497 if (RefResult != Sema::Ref_Compatible) {
1498 if (CStyle || RefResult == Sema::Ref_Incompatible)
1499 return TC_NotApplicable;
1500 // Diagnose types which are reference-related but not compatible here since
1501 // we can provide better diagnostics. In these cases forwarding to
1502 // [expr.static.cast]p4 should never result in a well-formed cast.
1503 msg = SrcExpr->isLValue() ? diag::err_bad_lvalue_to_rvalue_cast
1504 : diag::err_bad_rvalue_to_rvalue_cast;
1505 return TC_Failed;
1506 }
1507
1508 if (RefConv & Sema::ReferenceConversions::DerivedToBase) {
1509 Kind = CK_DerivedToBase;
1510 CXXBasePaths Paths(/*FindAmbiguities=*/true, /*RecordPaths=*/true,
1511 /*DetectVirtual=*/true);
1512 if (!Self.IsDerivedFrom(SrcExpr->getBeginLoc(), SrcExpr->getType(),
1513 R->getPointeeType(), Paths))
1514 return TC_NotApplicable;
1515
1516 Self.BuildBasePathArray(Paths, BasePath);
1517 } else
1518 Kind = CK_NoOp;
1519
1520 return TC_Success;
1521}
1522
1523/// Tests whether a conversion according to C++ 5.2.9p5 is valid.
1524TryCastResult
1525TryStaticReferenceDowncast(Sema &Self, Expr *SrcExpr, QualType DestType,
1526 bool CStyle, SourceRange OpRange,
1527 unsigned &msg, CastKind &Kind,
1528 CXXCastPath &BasePath) {
1529 // C++ 5.2.9p5: An lvalue of type "cv1 B", where B is a class type, can be
1530 // cast to type "reference to cv2 D", where D is a class derived from B,
1531 // if a valid standard conversion from "pointer to D" to "pointer to B"
1532 // exists, cv2 >= cv1, and B is not a virtual base class of D.
1533 // In addition, DR54 clarifies that the base must be accessible in the
1534 // current context. Although the wording of DR54 only applies to the pointer
1535 // variant of this rule, the intent is clearly for it to apply to the this
1536 // conversion as well.
1537
1538 const ReferenceType *DestReference = DestType->getAs<ReferenceType>();
1539 if (!DestReference) {
1540 return TC_NotApplicable;
1541 }
1542 bool RValueRef = DestReference->isRValueReferenceType();
1543 if (!RValueRef && !SrcExpr->isLValue()) {
1544 // We know the left side is an lvalue reference, so we can suggest a reason.
1545 msg = diag::err_bad_cxx_cast_rvalue;
1546 return TC_NotApplicable;
1547 }
1548
1549 QualType DestPointee = DestReference->getPointeeType();
1550
1551 // FIXME: If the source is a prvalue, we should issue a warning (because the
1552 // cast always has undefined behavior), and for AST consistency, we should
1553 // materialize a temporary.
1554 return TryStaticDowncast(Self,
1555 Self.Context.getCanonicalType(SrcExpr->getType()),
1556 Self.Context.getCanonicalType(DestPointee), CStyle,
1557 OpRange, SrcExpr->getType(), DestType, msg, Kind,
1558 BasePath);
1559}
1560
1561/// Tests whether a conversion according to C++ 5.2.9p8 is valid.
1562TryCastResult
1563TryStaticPointerDowncast(Sema &Self, QualType SrcType, QualType DestType,
1564 bool CStyle, SourceRange OpRange,
1565 unsigned &msg, CastKind &Kind,
1566 CXXCastPath &BasePath) {
1567 // C++ 5.2.9p8: An rvalue of type "pointer to cv1 B", where B is a class
1568 // type, can be converted to an rvalue of type "pointer to cv2 D", where D
1569 // is a class derived from B, if a valid standard conversion from "pointer
1570 // to D" to "pointer to B" exists, cv2 >= cv1, and B is not a virtual base
1571 // class of D.
1572 // In addition, DR54 clarifies that the base must be accessible in the
1573 // current context.
1574
1575 const PointerType *DestPointer = DestType->getAs<PointerType>();
1576 if (!DestPointer) {
1577 return TC_NotApplicable;
1578 }
1579
1580 const PointerType *SrcPointer = SrcType->getAs<PointerType>();
1581 if (!SrcPointer) {
1582 msg = diag::err_bad_static_cast_pointer_nonpointer;
1583 return TC_NotApplicable;
1584 }
1585
1586 return TryStaticDowncast(Self,
1587 Self.Context.getCanonicalType(SrcPointer->getPointeeType()),
1588 Self.Context.getCanonicalType(DestPointer->getPointeeType()),
1589 CStyle, OpRange, SrcType, DestType, msg, Kind,
1590 BasePath);
1591}
1592
1593/// TryStaticDowncast - Common functionality of TryStaticReferenceDowncast and
1594/// TryStaticPointerDowncast. Tests whether a static downcast from SrcType to
1595/// DestType is possible and allowed.
1596TryCastResult
1597TryStaticDowncast(Sema &Self, CanQualType SrcType, CanQualType DestType,
1598 bool CStyle, SourceRange OpRange, QualType OrigSrcType,
1599 QualType OrigDestType, unsigned &msg,
1600 CastKind &Kind, CXXCastPath &BasePath) {
1601 // We can only work with complete types. But don't complain if it doesn't work
1602 if (!Self.isCompleteType(OpRange.getBegin(), SrcType) ||
1603 !Self.isCompleteType(OpRange.getBegin(), DestType))
1604 return TC_NotApplicable;
1605
1606 // Downcast can only happen in class hierarchies, so we need classes.
1607 if (!DestType->getAs<RecordType>() || !SrcType->getAs<RecordType>()) {
1608 return TC_NotApplicable;
1609 }
1610
1611 CXXBasePaths Paths(/*FindAmbiguities=*/true, /*RecordPaths=*/true,
1612 /*DetectVirtual=*/true);
1613 if (!Self.IsDerivedFrom(OpRange.getBegin(), DestType, SrcType, Paths)) {
1614 return TC_NotApplicable;
1615 }
1616
1617 // Target type does derive from source type. Now we're serious. If an error
1618 // appears now, it's not ignored.
1619 // This may not be entirely in line with the standard. Take for example:
1620 // struct A {};
1621 // struct B : virtual A {
1622 // B(A&);
1623 // };
1624 //
1625 // void f()
1626 // {
1627 // (void)static_cast<const B&>(*((A*)0));
1628 // }
1629 // As far as the standard is concerned, p5 does not apply (A is virtual), so
1630 // p2 should be used instead - "const B& t(*((A*)0));" is perfectly valid.
1631 // However, both GCC and Comeau reject this example, and accepting it would
1632 // mean more complex code if we're to preserve the nice error message.
1633 // FIXME: Being 100% compliant here would be nice to have.
1634
1635 // Must preserve cv, as always, unless we're in C-style mode.
1636 if (!CStyle && !DestType.isAtLeastAsQualifiedAs(SrcType)) {
1637 msg = diag::err_bad_cxx_cast_qualifiers_away;
1638 return TC_Failed;
1639 }
1640
1641 if (Paths.isAmbiguous(SrcType.getUnqualifiedType())) {
1642 // This code is analoguous to that in CheckDerivedToBaseConversion, except
1643 // that it builds the paths in reverse order.
1644 // To sum up: record all paths to the base and build a nice string from
1645 // them. Use it to spice up the error message.
1646 if (!Paths.isRecordingPaths()) {
1647 Paths.clear();
1648 Paths.setRecordingPaths(true);
1649 Self.IsDerivedFrom(OpRange.getBegin(), DestType, SrcType, Paths);
1650 }
1651 std::string PathDisplayStr;
1652 std::set<unsigned> DisplayedPaths;
1653 for (clang::CXXBasePath &Path : Paths) {
1654 if (DisplayedPaths.insert(Path.back().SubobjectNumber).second) {
1655 // We haven't displayed a path to this particular base
1656 // class subobject yet.
1657 PathDisplayStr += "\n ";
1658 for (CXXBasePathElement &PE : llvm::reverse(Path))
1659 PathDisplayStr += PE.Base->getType().getAsString() + " -> ";
1660 PathDisplayStr += QualType(DestType).getAsString();
1661 }
1662 }
1663
1664 Self.Diag(OpRange.getBegin(), diag::err_ambiguous_base_to_derived_cast)
1665 << QualType(SrcType).getUnqualifiedType()
1666 << QualType(DestType).getUnqualifiedType()
1667 << PathDisplayStr << OpRange;
1668 msg = 0;
1669 return TC_Failed;
1670 }
1671
1672 if (Paths.getDetectedVirtual() != nullptr) {
1673 QualType VirtualBase(Paths.getDetectedVirtual(), 0);
1674 Self.Diag(OpRange.getBegin(), diag::err_static_downcast_via_virtual)
1675 << OrigSrcType << OrigDestType << VirtualBase << OpRange;
1676 msg = 0;
1677 return TC_Failed;
1678 }
1679
1680 if (!CStyle) {
1681 switch (Self.CheckBaseClassAccess(OpRange.getBegin(),
1682 SrcType, DestType,
1683 Paths.front(),
1684 diag::err_downcast_from_inaccessible_base)) {
1685 case Sema::AR_accessible:
1686 case Sema::AR_delayed: // be optimistic
1687 case Sema::AR_dependent: // be optimistic
1688 break;
1689
1690 case Sema::AR_inaccessible:
1691 msg = 0;
1692 return TC_Failed;
1693 }
1694 }
1695
1696 Self.BuildBasePathArray(Paths, BasePath);
1697 Kind = CK_BaseToDerived;
1698 return TC_Success;
1699}
1700
1701/// TryStaticMemberPointerUpcast - Tests whether a conversion according to
1702/// C++ 5.2.9p9 is valid:
1703///
1704/// An rvalue of type "pointer to member of D of type cv1 T" can be
1705/// converted to an rvalue of type "pointer to member of B of type cv2 T",
1706/// where B is a base class of D [...].
1707///
1708TryCastResult
1709TryStaticMemberPointerUpcast(Sema &Self, ExprResult &SrcExpr, QualType SrcType,
1710 QualType DestType, bool CStyle,
1711 SourceRange OpRange,
1712 unsigned &msg, CastKind &Kind,
1713 CXXCastPath &BasePath) {
1714 const MemberPointerType *DestMemPtr = DestType->getAs<MemberPointerType>();
1715 if (!DestMemPtr)
1716 return TC_NotApplicable;
1717
1718 bool WasOverloadedFunction = false;
1719 DeclAccessPair FoundOverload;
1720 if (SrcExpr.get()->getType() == Self.Context.OverloadTy) {
1721 if (FunctionDecl *Fn
1722 = Self.ResolveAddressOfOverloadedFunction(SrcExpr.get(), DestType, false,
1723 FoundOverload)) {
1724 CXXMethodDecl *M = cast<CXXMethodDecl>(Fn);
1725 SrcType = Self.Context.getMemberPointerType(Fn->getType(),
1726 Self.Context.getTypeDeclType(M->getParent()).getTypePtr());
1727 WasOverloadedFunction = true;
1728 }
1729 }
1730
1731 const MemberPointerType *SrcMemPtr = SrcType->getAs<MemberPointerType>();
1732 if (!SrcMemPtr) {
1733 msg = diag::err_bad_static_cast_member_pointer_nonmp;
1734 return TC_NotApplicable;
1735 }
1736
1737 // Lock down the inheritance model right now in MS ABI, whether or not the
1738 // pointee types are the same.
1739 if (Self.Context.getTargetInfo().getCXXABI().isMicrosoft()) {
1740 (void)Self.isCompleteType(OpRange.getBegin(), SrcType);
1741 (void)Self.isCompleteType(OpRange.getBegin(), DestType);
1742 }
1743
1744 // T == T, modulo cv
1745 if (!Self.Context.hasSameUnqualifiedType(SrcMemPtr->getPointeeType(),
1746 DestMemPtr->getPointeeType()))
1747 return TC_NotApplicable;
1748
1749 // B base of D
1750 QualType SrcClass(SrcMemPtr->getClass(), 0);
1751 QualType DestClass(DestMemPtr->getClass(), 0);
1752 CXXBasePaths Paths(/*FindAmbiguities=*/true, /*RecordPaths=*/true,
1753 /*DetectVirtual=*/true);
1754 if (!Self.IsDerivedFrom(OpRange.getBegin(), SrcClass, DestClass, Paths))
1755 return TC_NotApplicable;
1756
1757 // B is a base of D. But is it an allowed base? If not, it's a hard error.
1758 if (Paths.isAmbiguous(Self.Context.getCanonicalType(DestClass))) {
1759 Paths.clear();
1760 Paths.setRecordingPaths(true);
1761 bool StillOkay =
1762 Self.IsDerivedFrom(OpRange.getBegin(), SrcClass, DestClass, Paths);
1763 assert(StillOkay)(static_cast <bool> (StillOkay) ? void (0) : __assert_fail
("StillOkay", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 1763, __extension__ __PRETTY_FUNCTION__))
;
1764 (void)StillOkay;
1765 std::string PathDisplayStr = Self.getAmbiguousPathsDisplayString(Paths);
1766 Self.Diag(OpRange.getBegin(), diag::err_ambiguous_memptr_conv)
1767 << 1 << SrcClass << DestClass << PathDisplayStr << OpRange;
1768 msg = 0;
1769 return TC_Failed;
1770 }
1771
1772 if (const RecordType *VBase = Paths.getDetectedVirtual()) {
1773 Self.Diag(OpRange.getBegin(), diag::err_memptr_conv_via_virtual)
1774 << SrcClass << DestClass << QualType(VBase, 0) << OpRange;
1775 msg = 0;
1776 return TC_Failed;
1777 }
1778
1779 if (!CStyle) {
1780 switch (Self.CheckBaseClassAccess(OpRange.getBegin(),
1781 DestClass, SrcClass,
1782 Paths.front(),
1783 diag::err_upcast_to_inaccessible_base)) {
1784 case Sema::AR_accessible:
1785 case Sema::AR_delayed:
1786 case Sema::AR_dependent:
1787 // Optimistically assume that the delayed and dependent cases
1788 // will work out.
1789 break;
1790
1791 case Sema::AR_inaccessible:
1792 msg = 0;
1793 return TC_Failed;
1794 }
1795 }
1796
1797 if (WasOverloadedFunction) {
1798 // Resolve the address of the overloaded function again, this time
1799 // allowing complaints if something goes wrong.
1800 FunctionDecl *Fn = Self.ResolveAddressOfOverloadedFunction(SrcExpr.get(),
1801 DestType,
1802 true,
1803 FoundOverload);
1804 if (!Fn) {
1805 msg = 0;
1806 return TC_Failed;
1807 }
1808
1809 SrcExpr = Self.FixOverloadedFunctionReference(SrcExpr, FoundOverload, Fn);
1810 if (!SrcExpr.isUsable()) {
1811 msg = 0;
1812 return TC_Failed;
1813 }
1814 }
1815
1816 Self.BuildBasePathArray(Paths, BasePath);
1817 Kind = CK_DerivedToBaseMemberPointer;
1818 return TC_Success;
1819}
1820
1821/// TryStaticImplicitCast - Tests whether a conversion according to C++ 5.2.9p2
1822/// is valid:
1823///
1824/// An expression e can be explicitly converted to a type T using a
1825/// @c static_cast if the declaration "T t(e);" is well-formed [...].
1826TryCastResult
1827TryStaticImplicitCast(Sema &Self, ExprResult &SrcExpr, QualType DestType,
1828 Sema::CheckedConversionKind CCK,
1829 SourceRange OpRange, unsigned &msg,
1830 CastKind &Kind, bool ListInitialization) {
1831 if (DestType->isRecordType()) {
1832 if (Self.RequireCompleteType(OpRange.getBegin(), DestType,
1833 diag::err_bad_cast_incomplete) ||
1834 Self.RequireNonAbstractType(OpRange.getBegin(), DestType,
1835 diag::err_allocation_of_abstract_type)) {
1836 msg = 0;
1837 return TC_Failed;
1838 }
1839 }
1840
1841 InitializedEntity Entity = InitializedEntity::InitializeTemporary(DestType);
1842 InitializationKind InitKind
1843 = (CCK == Sema::CCK_CStyleCast)
1844 ? InitializationKind::CreateCStyleCast(OpRange.getBegin(), OpRange,
1845 ListInitialization)
1846 : (CCK == Sema::CCK_FunctionalCast)
1847 ? InitializationKind::CreateFunctionalCast(OpRange, ListInitialization)
1848 : InitializationKind::CreateCast(OpRange);
1849 Expr *SrcExprRaw = SrcExpr.get();
1850 // FIXME: Per DR242, we should check for an implicit conversion sequence
1851 // or for a constructor that could be invoked by direct-initialization
1852 // here, not for an initialization sequence.
1853 InitializationSequence InitSeq(Self, Entity, InitKind, SrcExprRaw);
1854
1855 // At this point of CheckStaticCast, if the destination is a reference,
1856 // or the expression is an overload expression this has to work.
1857 // There is no other way that works.
1858 // On the other hand, if we're checking a C-style cast, we've still got
1859 // the reinterpret_cast way.
1860 bool CStyle
1861 = (CCK == Sema::CCK_CStyleCast || CCK == Sema::CCK_FunctionalCast);
1862 if (InitSeq.Failed() && (CStyle || !DestType->isReferenceType()))
1863 return TC_NotApplicable;
1864
1865 ExprResult Result = InitSeq.Perform(Self, Entity, InitKind, SrcExprRaw);
1866 if (Result.isInvalid()) {
1867 msg = 0;
1868 return TC_Failed;
1869 }
1870
1871 if (InitSeq.isConstructorInitialization())
1872 Kind = CK_ConstructorConversion;
1873 else
1874 Kind = CK_NoOp;
1875
1876 SrcExpr = Result;
1877 return TC_Success;
1878}
1879
1880/// TryConstCast - See if a const_cast from source to destination is allowed,
1881/// and perform it if it is.
1882static TryCastResult TryConstCast(Sema &Self, ExprResult &SrcExpr,
1883 QualType DestType, bool CStyle,
1884 unsigned &msg) {
1885 DestType = Self.Context.getCanonicalType(DestType);
1886 QualType SrcType = SrcExpr.get()->getType();
1887 bool NeedToMaterializeTemporary = false;
1888
1889 if (const ReferenceType *DestTypeTmp =DestType->getAs<ReferenceType>()) {
1890 // C++11 5.2.11p4:
1891 // if a pointer to T1 can be explicitly converted to the type "pointer to
1892 // T2" using a const_cast, then the following conversions can also be
1893 // made:
1894 // -- an lvalue of type T1 can be explicitly converted to an lvalue of
1895 // type T2 using the cast const_cast<T2&>;
1896 // -- a glvalue of type T1 can be explicitly converted to an xvalue of
1897 // type T2 using the cast const_cast<T2&&>; and
1898 // -- if T1 is a class type, a prvalue of type T1 can be explicitly
1899 // converted to an xvalue of type T2 using the cast const_cast<T2&&>.
1900
1901 if (isa<LValueReferenceType>(DestTypeTmp) && !SrcExpr.get()->isLValue()) {
1902 // Cannot const_cast non-lvalue to lvalue reference type. But if this
1903 // is C-style, static_cast might find a way, so we simply suggest a
1904 // message and tell the parent to keep searching.
1905 msg = diag::err_bad_cxx_cast_rvalue;
1906 return TC_NotApplicable;
1907 }
1908
1909 if (isa<RValueReferenceType>(DestTypeTmp) && SrcExpr.get()->isPRValue()) {
1910 if (!SrcType->isRecordType()) {
1911 // Cannot const_cast non-class prvalue to rvalue reference type. But if
1912 // this is C-style, static_cast can do this.
1913 msg = diag::err_bad_cxx_cast_rvalue;
1914 return TC_NotApplicable;
1915 }
1916
1917 // Materialize the class prvalue so that the const_cast can bind a
1918 // reference to it.
1919 NeedToMaterializeTemporary = true;
1920 }
1921
1922 // It's not completely clear under the standard whether we can
1923 // const_cast bit-field gl-values. Doing so would not be
1924 // intrinsically complicated, but for now, we say no for
1925 // consistency with other compilers and await the word of the
1926 // committee.
1927 if (SrcExpr.get()->refersToBitField()) {
1928 msg = diag::err_bad_cxx_cast_bitfield;
1929 return TC_NotApplicable;
1930 }
1931
1932 DestType = Self.Context.getPointerType(DestTypeTmp->getPointeeType());
1933 SrcType = Self.Context.getPointerType(SrcType);
1934 }
1935
1936 // C++ 5.2.11p5: For a const_cast involving pointers to data members [...]
1937 // the rules for const_cast are the same as those used for pointers.
1938
1939 if (!DestType->isPointerType() &&
1940 !DestType->isMemberPointerType() &&
1941 !DestType->isObjCObjectPointerType()) {
1942 // Cannot cast to non-pointer, non-reference type. Note that, if DestType
1943 // was a reference type, we converted it to a pointer above.
1944 // The status of rvalue references isn't entirely clear, but it looks like
1945 // conversion to them is simply invalid.
1946 // C++ 5.2.11p3: For two pointer types [...]
1947 if (!CStyle)
1948 msg = diag::err_bad_const_cast_dest;
1949 return TC_NotApplicable;
1950 }
1951 if (DestType->isFunctionPointerType() ||
1952 DestType->isMemberFunctionPointerType()) {
1953 // Cannot cast direct function pointers.
1954 // C++ 5.2.11p2: [...] where T is any object type or the void type [...]
1955 // T is the ultimate pointee of source and target type.
1956 if (!CStyle)
1957 msg = diag::err_bad_const_cast_dest;
1958 return TC_NotApplicable;
1959 }
1960
1961 // C++ [expr.const.cast]p3:
1962 // "For two similar types T1 and T2, [...]"
1963 //
1964 // We only allow a const_cast to change cvr-qualifiers, not other kinds of
1965 // type qualifiers. (Likewise, we ignore other changes when determining
1966 // whether a cast casts away constness.)
1967 if (!Self.Context.hasCvrSimilarType(SrcType, DestType))
1968 return TC_NotApplicable;
1969
1970 if (NeedToMaterializeTemporary)
1971 // This is a const_cast from a class prvalue to an rvalue reference type.
1972 // Materialize a temporary to store the result of the conversion.
1973 SrcExpr = Self.CreateMaterializeTemporaryExpr(SrcExpr.get()->getType(),
1974 SrcExpr.get(),
1975 /*IsLValueReference*/ false);
1976
1977 return TC_Success;
1978}
1979
1980// Checks for undefined behavior in reinterpret_cast.
1981// The cases that is checked for is:
1982// *reinterpret_cast<T*>(&a)
1983// reinterpret_cast<T&>(a)
1984// where accessing 'a' as type 'T' will result in undefined behavior.
1985void Sema::CheckCompatibleReinterpretCast(QualType SrcType, QualType DestType,
1986 bool IsDereference,
1987 SourceRange Range) {
1988 unsigned DiagID = IsDereference ?
1989 diag::warn_pointer_indirection_from_incompatible_type :
1990 diag::warn_undefined_reinterpret_cast;
1991
1992 if (Diags.isIgnored(DiagID, Range.getBegin()))
1993 return;
1994
1995 QualType SrcTy, DestTy;
1996 if (IsDereference) {
1997 if (!SrcType->getAs<PointerType>() || !DestType->getAs<PointerType>()) {
1998 return;
1999 }
2000 SrcTy = SrcType->getPointeeType();
2001 DestTy = DestType->getPointeeType();
2002 } else {
2003 if (!DestType->getAs<ReferenceType>()) {
2004 return;
2005 }
2006 SrcTy = SrcType;
2007 DestTy = DestType->getPointeeType();
2008 }
2009
2010 // Cast is compatible if the types are the same.
2011 if (Context.hasSameUnqualifiedType(DestTy, SrcTy)) {
2012 return;
2013 }
2014 // or one of the types is a char or void type
2015 if (DestTy->isAnyCharacterType() || DestTy->isVoidType() ||
2016 SrcTy->isAnyCharacterType() || SrcTy->isVoidType()) {
2017 return;
2018 }
2019 // or one of the types is a tag type.
2020 if (SrcTy->getAs<TagType>() || DestTy->getAs<TagType>()) {
2021 return;
2022 }
2023
2024 // FIXME: Scoped enums?
2025 if ((SrcTy->isUnsignedIntegerType() && DestTy->isSignedIntegerType()) ||
2026 (SrcTy->isSignedIntegerType() && DestTy->isUnsignedIntegerType())) {
2027 if (Context.getTypeSize(DestTy) == Context.getTypeSize(SrcTy)) {
2028 return;
2029 }
2030 }
2031
2032 Diag(Range.getBegin(), DiagID) << SrcType << DestType << Range;
2033}
2034
2035static void DiagnoseCastOfObjCSEL(Sema &Self, const ExprResult &SrcExpr,
2036 QualType DestType) {
2037 QualType SrcType = SrcExpr.get()->getType();
2038 if (Self.Context.hasSameType(SrcType, DestType))
2039 return;
2040 if (const PointerType *SrcPtrTy = SrcType->getAs<PointerType>())
2041 if (SrcPtrTy->isObjCSelType()) {
2042 QualType DT = DestType;
2043 if (isa<PointerType>(DestType))
2044 DT = DestType->getPointeeType();
2045 if (!DT.getUnqualifiedType()->isVoidType())
2046 Self.Diag(SrcExpr.get()->getExprLoc(),
2047 diag::warn_cast_pointer_from_sel)
2048 << SrcType << DestType << SrcExpr.get()->getSourceRange();
2049 }
2050}
2051
2052/// Diagnose casts that change the calling convention of a pointer to a function
2053/// defined in the current TU.
2054static void DiagnoseCallingConvCast(Sema &Self, const ExprResult &SrcExpr,
2055 QualType DstType, SourceRange OpRange) {
2056 // Check if this cast would change the calling convention of a function
2057 // pointer type.
2058 QualType SrcType = SrcExpr.get()->getType();
2059 if (Self.Context.hasSameType(SrcType, DstType) ||
2060 !SrcType->isFunctionPointerType() || !DstType->isFunctionPointerType())
2061 return;
2062 const auto *SrcFTy =
2063 SrcType->castAs<PointerType>()->getPointeeType()->castAs<FunctionType>();
2064 const auto *DstFTy =
2065 DstType->castAs<PointerType>()->getPointeeType()->castAs<FunctionType>();
2066 CallingConv SrcCC = SrcFTy->getCallConv();
2067 CallingConv DstCC = DstFTy->getCallConv();
2068 if (SrcCC == DstCC)
2069 return;
2070
2071 // We have a calling convention cast. Check if the source is a pointer to a
2072 // known, specific function that has already been defined.
2073 Expr *Src = SrcExpr.get()->IgnoreParenImpCasts();
2074 if (auto *UO = dyn_cast<UnaryOperator>(Src))
2075 if (UO->getOpcode() == UO_AddrOf)
2076 Src = UO->getSubExpr()->IgnoreParenImpCasts();
2077 auto *DRE = dyn_cast<DeclRefExpr>(Src);
2078 if (!DRE)
2079 return;
2080 auto *FD = dyn_cast<FunctionDecl>(DRE->getDecl());
2081 if (!FD)
2082 return;
2083
2084 // Only warn if we are casting from the default convention to a non-default
2085 // convention. This can happen when the programmer forgot to apply the calling
2086 // convention to the function declaration and then inserted this cast to
2087 // satisfy the type system.
2088 CallingConv DefaultCC = Self.getASTContext().getDefaultCallingConvention(
2089 FD->isVariadic(), FD->isCXXInstanceMember());
2090 if (DstCC == DefaultCC || SrcCC != DefaultCC)
2091 return;
2092
2093 // Diagnose this cast, as it is probably bad.
2094 StringRef SrcCCName = FunctionType::getNameForCallConv(SrcCC);
2095 StringRef DstCCName = FunctionType::getNameForCallConv(DstCC);
2096 Self.Diag(OpRange.getBegin(), diag::warn_cast_calling_conv)
2097 << SrcCCName << DstCCName << OpRange;
2098
2099 // The checks above are cheaper than checking if the diagnostic is enabled.
2100 // However, it's worth checking if the warning is enabled before we construct
2101 // a fixit.
2102 if (Self.Diags.isIgnored(diag::warn_cast_calling_conv, OpRange.getBegin()))
2103 return;
2104
2105 // Try to suggest a fixit to change the calling convention of the function
2106 // whose address was taken. Try to use the latest macro for the convention.
2107 // For example, users probably want to write "WINAPI" instead of "__stdcall"
2108 // to match the Windows header declarations.
2109 SourceLocation NameLoc = FD->getFirstDecl()->getNameInfo().getLoc();
2110 Preprocessor &PP = Self.getPreprocessor();
2111 SmallVector<TokenValue, 6> AttrTokens;
2112 SmallString<64> CCAttrText;
2113 llvm::raw_svector_ostream OS(CCAttrText);
2114 if (Self.getLangOpts().MicrosoftExt) {
2115 // __stdcall or __vectorcall
2116 OS << "__" << DstCCName;
2117 IdentifierInfo *II = PP.getIdentifierInfo(OS.str());
2118 AttrTokens.push_back(II->isKeyword(Self.getLangOpts())
2119 ? TokenValue(II->getTokenID())
2120 : TokenValue(II));
2121 } else {
2122 // __attribute__((stdcall)) or __attribute__((vectorcall))
2123 OS << "__attribute__((" << DstCCName << "))";
2124 AttrTokens.push_back(tok::kw___attribute);
2125 AttrTokens.push_back(tok::l_paren);
2126 AttrTokens.push_back(tok::l_paren);
2127 IdentifierInfo *II = PP.getIdentifierInfo(DstCCName);
2128 AttrTokens.push_back(II->isKeyword(Self.getLangOpts())
2129 ? TokenValue(II->getTokenID())
2130 : TokenValue(II));
2131 AttrTokens.push_back(tok::r_paren);
2132 AttrTokens.push_back(tok::r_paren);
2133 }
2134 StringRef AttrSpelling = PP.getLastMacroWithSpelling(NameLoc, AttrTokens);
2135 if (!AttrSpelling.empty())
2136 CCAttrText = AttrSpelling;
2137 OS << ' ';
2138 Self.Diag(NameLoc, diag::note_change_calling_conv_fixit)
2139 << FD << DstCCName << FixItHint::CreateInsertion(NameLoc, CCAttrText);
2140}
2141
2142static void checkIntToPointerCast(bool CStyle, const SourceRange &OpRange,
2143 const Expr *SrcExpr, QualType DestType,
2144 Sema &Self) {
2145 QualType SrcType = SrcExpr->getType();
2146
2147 // Not warning on reinterpret_cast, boolean, constant expressions, etc
2148 // are not explicit design choices, but consistent with GCC's behavior.
2149 // Feel free to modify them if you've reason/evidence for an alternative.
2150 if (CStyle && SrcType->isIntegralType(Self.Context)
2151 && !SrcType->isBooleanType()
2152 && !SrcType->isEnumeralType()
2153 && !SrcExpr->isIntegerConstantExpr(Self.Context)
2154 && Self.Context.getTypeSize(DestType) >
2155 Self.Context.getTypeSize(SrcType)) {
2156 // Separate between casts to void* and non-void* pointers.
2157 // Some APIs use (abuse) void* for something like a user context,
2158 // and often that value is an integer even if it isn't a pointer itself.
2159 // Having a separate warning flag allows users to control the warning
2160 // for their workflow.
2161 unsigned Diag = DestType->isVoidPointerType() ?
2162 diag::warn_int_to_void_pointer_cast
2163 : diag::warn_int_to_pointer_cast;
2164 Self.Diag(OpRange.getBegin(), Diag) << SrcType << DestType << OpRange;
2165 }
2166}
2167
2168static bool fixOverloadedReinterpretCastExpr(Sema &Self, QualType DestType,
2169 ExprResult &Result) {
2170 // We can only fix an overloaded reinterpret_cast if
2171 // - it is a template with explicit arguments that resolves to an lvalue
2172 // unambiguously, or
2173 // - it is the only function in an overload set that may have its address
2174 // taken.
2175
2176 Expr *E = Result.get();
2177 // TODO: what if this fails because of DiagnoseUseOfDecl or something
2178 // like it?
2179 if (Self.ResolveAndFixSingleFunctionTemplateSpecialization(
2180 Result,
2181 Expr::getValueKindForType(DestType) ==
2182 VK_PRValue // Convert Fun to Ptr
2183 ) &&
2184 Result.isUsable())
2185 return true;
2186
2187 // No guarantees that ResolveAndFixSingleFunctionTemplateSpecialization
2188 // preserves Result.
2189 Result = E;
2190 if (!Self.resolveAndFixAddressOfSingleOverloadCandidate(
2191 Result, /*DoFunctionPointerConversion=*/true))
2192 return false;
2193 return Result.isUsable();
2194}
2195
2196static TryCastResult TryReinterpretCast(Sema &Self, ExprResult &SrcExpr,
2197 QualType DestType, bool CStyle,
2198 SourceRange OpRange,
2199 unsigned &msg,
2200 CastKind &Kind) {
2201 bool IsLValueCast = false;
2202
2203 DestType = Self.Context.getCanonicalType(DestType);
2204 QualType SrcType = SrcExpr.get()->getType();
2205
2206 // Is the source an overloaded name? (i.e. &foo)
2207 // If so, reinterpret_cast generally can not help us here (13.4, p1, bullet 5)
2208 if (SrcType == Self.Context.OverloadTy) {
2209 ExprResult FixedExpr = SrcExpr;
2210 if (!fixOverloadedReinterpretCastExpr(Self, DestType, FixedExpr))
2211 return TC_NotApplicable;
2212
2213 assert(FixedExpr.isUsable() && "Invalid result fixing overloaded expr")(static_cast <bool> (FixedExpr.isUsable() && "Invalid result fixing overloaded expr"
) ? void (0) : __assert_fail ("FixedExpr.isUsable() && \"Invalid result fixing overloaded expr\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 2213, __extension__ __PRETTY_FUNCTION__))
;
2214 SrcExpr = FixedExpr;
2215 SrcType = SrcExpr.get()->getType();
2216 }
2217
2218 if (const ReferenceType *DestTypeTmp = DestType->getAs<ReferenceType>()) {
2219 if (!SrcExpr.get()->isGLValue()) {
2220 // Cannot cast non-glvalue to (lvalue or rvalue) reference type. See the
2221 // similar comment in const_cast.
2222 msg = diag::err_bad_cxx_cast_rvalue;
2223 return TC_NotApplicable;
2224 }
2225
2226 if (!CStyle) {
2227 Self.CheckCompatibleReinterpretCast(SrcType, DestType,
2228 /*IsDereference=*/false, OpRange);
2229 }
2230
2231 // C++ 5.2.10p10: [...] a reference cast reinterpret_cast<T&>(x) has the
2232 // same effect as the conversion *reinterpret_cast<T*>(&x) with the
2233 // built-in & and * operators.
2234
2235 const char *inappropriate = nullptr;
2236 switch (SrcExpr.get()->getObjectKind()) {
2237 case OK_Ordinary:
2238 break;
2239 case OK_BitField:
2240 msg = diag::err_bad_cxx_cast_bitfield;
2241 return TC_NotApplicable;
2242 // FIXME: Use a specific diagnostic for the rest of these cases.
2243 case OK_VectorComponent: inappropriate = "vector element"; break;
2244 case OK_MatrixComponent:
2245 inappropriate = "matrix element";
2246 break;
2247 case OK_ObjCProperty: inappropriate = "property expression"; break;
2248 case OK_ObjCSubscript: inappropriate = "container subscripting expression";
2249 break;
2250 }
2251 if (inappropriate) {
2252 Self.Diag(OpRange.getBegin(), diag::err_bad_reinterpret_cast_reference)
2253 << inappropriate << DestType
2254 << OpRange << SrcExpr.get()->getSourceRange();
2255 msg = 0; SrcExpr = ExprError();
2256 return TC_NotApplicable;
2257 }
2258
2259 // This code does this transformation for the checked types.
2260 DestType = Self.Context.getPointerType(DestTypeTmp->getPointeeType());
2261 SrcType = Self.Context.getPointerType(SrcType);
2262
2263 IsLValueCast = true;
2264 }
2265
2266 // Canonicalize source for comparison.
2267 SrcType = Self.Context.getCanonicalType(SrcType);
2268
2269 const MemberPointerType *DestMemPtr = DestType->getAs<MemberPointerType>(),
2270 *SrcMemPtr = SrcType->getAs<MemberPointerType>();
2271 if (DestMemPtr && SrcMemPtr) {
2272 // C++ 5.2.10p9: An rvalue of type "pointer to member of X of type T1"
2273 // can be explicitly converted to an rvalue of type "pointer to member
2274 // of Y of type T2" if T1 and T2 are both function types or both object
2275 // types.
2276 if (DestMemPtr->isMemberFunctionPointer() !=
2277 SrcMemPtr->isMemberFunctionPointer())
2278 return TC_NotApplicable;
2279
2280 if (Self.Context.getTargetInfo().getCXXABI().isMicrosoft()) {
2281 // We need to determine the inheritance model that the class will use if
2282 // haven't yet.
2283 (void)Self.isCompleteType(OpRange.getBegin(), SrcType);
2284 (void)Self.isCompleteType(OpRange.getBegin(), DestType);
2285 }
2286
2287 // Don't allow casting between member pointers of different sizes.
2288 if (Self.Context.getTypeSize(DestMemPtr) !=
2289 Self.Context.getTypeSize(SrcMemPtr)) {
2290 msg = diag::err_bad_cxx_cast_member_pointer_size;
2291 return TC_Failed;
2292 }
2293
2294 // C++ 5.2.10p2: The reinterpret_cast operator shall not cast away
2295 // constness.
2296 // A reinterpret_cast followed by a const_cast can, though, so in C-style,
2297 // we accept it.
2298 if (auto CACK =
2299 CastsAwayConstness(Self, SrcType, DestType, /*CheckCVR=*/!CStyle,
2300 /*CheckObjCLifetime=*/CStyle))
2301 return getCastAwayConstnessCastKind(CACK, msg);
2302
2303 // A valid member pointer cast.
2304 assert(!IsLValueCast)(static_cast <bool> (!IsLValueCast) ? void (0) : __assert_fail
("!IsLValueCast", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 2304, __extension__ __PRETTY_FUNCTION__))
;
2305 Kind = CK_ReinterpretMemberPointer;
2306 return TC_Success;
2307 }
2308
2309 // See below for the enumeral issue.
2310 if (SrcType->isNullPtrType() && DestType->isIntegralType(Self.Context)) {
2311 // C++0x 5.2.10p4: A pointer can be explicitly converted to any integral
2312 // type large enough to hold it. A value of std::nullptr_t can be
2313 // converted to an integral type; the conversion has the same meaning
2314 // and validity as a conversion of (void*)0 to the integral type.
2315 if (Self.Context.getTypeSize(SrcType) >
2316 Self.Context.getTypeSize(DestType)) {
2317 msg = diag::err_bad_reinterpret_cast_small_int;
2318 return TC_Failed;
2319 }
2320 Kind = CK_PointerToIntegral;
2321 return TC_Success;
2322 }
2323
2324 // Allow reinterpret_casts between vectors of the same size and
2325 // between vectors and integers of the same size.
2326 bool destIsVector = DestType->isVectorType();
2327 bool srcIsVector = SrcType->isVectorType();
2328 if (srcIsVector || destIsVector) {
2329 // Allow bitcasting between SVE VLATs and VLSTs, and vice-versa.
2330 if (Self.isValidSveBitcast(SrcType, DestType)) {
2331 Kind = CK_BitCast;
2332 return TC_Success;
2333 }
2334
2335 // The non-vector type, if any, must have integral type. This is
2336 // the same rule that C vector casts use; note, however, that enum
2337 // types are not integral in C++.
2338 if ((!destIsVector && !DestType->isIntegralType(Self.Context)) ||
2339 (!srcIsVector && !SrcType->isIntegralType(Self.Context)))
2340 return TC_NotApplicable;
2341
2342 // The size we want to consider is eltCount * eltSize.
2343 // That's exactly what the lax-conversion rules will check.
2344 if (Self.areLaxCompatibleVectorTypes(SrcType, DestType)) {
2345 Kind = CK_BitCast;
2346 return TC_Success;
2347 }
2348
2349 if (Self.LangOpts.OpenCL && !CStyle) {
2350 if (DestType->isExtVectorType() || SrcType->isExtVectorType()) {
2351 // FIXME: Allow for reinterpret cast between 3 and 4 element vectors
2352 if (Self.areVectorTypesSameSize(SrcType, DestType)) {
2353 Kind = CK_BitCast;
2354 return TC_Success;
2355 }
2356 }
2357 }
2358
2359 // Otherwise, pick a reasonable diagnostic.
2360 if (!destIsVector)
2361 msg = diag::err_bad_cxx_cast_vector_to_scalar_different_size;
2362 else if (!srcIsVector)
2363 msg = diag::err_bad_cxx_cast_scalar_to_vector_different_size;
2364 else
2365 msg = diag::err_bad_cxx_cast_vector_to_vector_different_size;
2366
2367 return TC_Failed;
2368 }
2369
2370 if (SrcType == DestType) {
2371 // C++ 5.2.10p2 has a note that mentions that, subject to all other
2372 // restrictions, a cast to the same type is allowed so long as it does not
2373 // cast away constness. In C++98, the intent was not entirely clear here,
2374 // since all other paragraphs explicitly forbid casts to the same type.
2375 // C++11 clarifies this case with p2.
2376 //
2377 // The only allowed types are: integral, enumeration, pointer, or
2378 // pointer-to-member types. We also won't restrict Obj-C pointers either.
2379 Kind = CK_NoOp;
2380 TryCastResult Result = TC_NotApplicable;
2381 if (SrcType->isIntegralOrEnumerationType() ||
2382 SrcType->isAnyPointerType() ||
2383 SrcType->isMemberPointerType() ||
2384 SrcType->isBlockPointerType()) {
2385 Result = TC_Success;
2386 }
2387 return Result;
2388 }
2389
2390 bool destIsPtr = DestType->isAnyPointerType() ||
2391 DestType->isBlockPointerType();
2392 bool srcIsPtr = SrcType->isAnyPointerType() ||
2393 SrcType->isBlockPointerType();
2394 if (!destIsPtr && !srcIsPtr) {
2395 // Except for std::nullptr_t->integer and lvalue->reference, which are
2396 // handled above, at least one of the two arguments must be a pointer.
2397 return TC_NotApplicable;
2398 }
2399
2400 if (DestType->isIntegralType(Self.Context)) {
2401 assert(srcIsPtr && "One type must be a pointer")(static_cast <bool> (srcIsPtr && "One type must be a pointer"
) ? void (0) : __assert_fail ("srcIsPtr && \"One type must be a pointer\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 2401, __extension__ __PRETTY_FUNCTION__))
;
2402 // C++ 5.2.10p4: A pointer can be explicitly converted to any integral
2403 // type large enough to hold it; except in Microsoft mode, where the
2404 // integral type size doesn't matter (except we don't allow bool).
2405 if ((Self.Context.getTypeSize(SrcType) >
2406 Self.Context.getTypeSize(DestType))) {
2407 bool MicrosoftException =
2408 Self.getLangOpts().MicrosoftExt && !DestType->isBooleanType();
2409 if (MicrosoftException) {
2410 unsigned Diag = SrcType->isVoidPointerType()
2411 ? diag::warn_void_pointer_to_int_cast
2412 : diag::warn_pointer_to_int_cast;
2413 Self.Diag(OpRange.getBegin(), Diag) << SrcType << DestType << OpRange;
2414 } else {
2415 msg = diag::err_bad_reinterpret_cast_small_int;
2416 return TC_Failed;
2417 }
2418 }
2419 Kind = CK_PointerToIntegral;
2420 return TC_Success;
2421 }
2422
2423 if (SrcType->isIntegralOrEnumerationType()) {
2424 assert(destIsPtr && "One type must be a pointer")(static_cast <bool> (destIsPtr && "One type must be a pointer"
) ? void (0) : __assert_fail ("destIsPtr && \"One type must be a pointer\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 2424, __extension__ __PRETTY_FUNCTION__))
;
2425 checkIntToPointerCast(CStyle, OpRange, SrcExpr.get(), DestType, Self);
2426 // C++ 5.2.10p5: A value of integral or enumeration type can be explicitly
2427 // converted to a pointer.
2428 // C++ 5.2.10p9: [Note: ...a null pointer constant of integral type is not
2429 // necessarily converted to a null pointer value.]
2430 Kind = CK_IntegralToPointer;
2431 return TC_Success;
2432 }
2433
2434 if (!destIsPtr || !srcIsPtr) {
2435 // With the valid non-pointer conversions out of the way, we can be even
2436 // more stringent.
2437 return TC_NotApplicable;
2438 }
2439
2440 // Cannot convert between block pointers and Objective-C object pointers.
2441 if ((SrcType->isBlockPointerType() && DestType->isObjCObjectPointerType()) ||
2442 (DestType->isBlockPointerType() && SrcType->isObjCObjectPointerType()))
2443 return TC_NotApplicable;
2444
2445 // C++ 5.2.10p2: The reinterpret_cast operator shall not cast away constness.
2446 // The C-style cast operator can.
2447 TryCastResult SuccessResult = TC_Success;
2448 if (auto CACK =
2449 CastsAwayConstness(Self, SrcType, DestType, /*CheckCVR=*/!CStyle,
2450 /*CheckObjCLifetime=*/CStyle))
2451 SuccessResult = getCastAwayConstnessCastKind(CACK, msg);
2452
2453 if (IsAddressSpaceConversion(SrcType, DestType)) {
2454 Kind = CK_AddressSpaceConversion;
2455 assert(SrcType->isPointerType() && DestType->isPointerType())(static_cast <bool> (SrcType->isPointerType() &&
DestType->isPointerType()) ? void (0) : __assert_fail ("SrcType->isPointerType() && DestType->isPointerType()"
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 2455, __extension__ __PRETTY_FUNCTION__))
;
2456 if (!CStyle &&
2457 !DestType->getPointeeType().getQualifiers().isAddressSpaceSupersetOf(
2458 SrcType->getPointeeType().getQualifiers())) {
2459 SuccessResult = TC_Failed;
2460 }
2461 } else if (IsLValueCast) {
2462 Kind = CK_LValueBitCast;
2463 } else if (DestType->isObjCObjectPointerType()) {
2464 Kind = Self.PrepareCastToObjCObjectPointer(SrcExpr);
2465 } else if (DestType->isBlockPointerType()) {
2466 if (!SrcType->isBlockPointerType()) {
2467 Kind = CK_AnyPointerToBlockPointerCast;
2468 } else {
2469 Kind = CK_BitCast;
2470 }
2471 } else {
2472 Kind = CK_BitCast;
2473 }
2474
2475 // Any pointer can be cast to an Objective-C pointer type with a C-style
2476 // cast.
2477 if (CStyle && DestType->isObjCObjectPointerType()) {
2478 return SuccessResult;
2479 }
2480 if (CStyle)
2481 DiagnoseCastOfObjCSEL(Self, SrcExpr, DestType);
2482
2483 DiagnoseCallingConvCast(Self, SrcExpr, DestType, OpRange);
2484
2485 // Not casting away constness, so the only remaining check is for compatible
2486 // pointer categories.
2487
2488 if (SrcType->isFunctionPointerType()) {
2489 if (DestType->isFunctionPointerType()) {
2490 // C++ 5.2.10p6: A pointer to a function can be explicitly converted to
2491 // a pointer to a function of a different type.
2492 return SuccessResult;
2493 }
2494
2495 // C++0x 5.2.10p8: Converting a pointer to a function into a pointer to
2496 // an object type or vice versa is conditionally-supported.
2497 // Compilers support it in C++03 too, though, because it's necessary for
2498 // casting the return value of dlsym() and GetProcAddress().
2499 // FIXME: Conditionally-supported behavior should be configurable in the
2500 // TargetInfo or similar.
2501 Self.Diag(OpRange.getBegin(),
2502 Self.getLangOpts().CPlusPlus11 ?
2503 diag::warn_cxx98_compat_cast_fn_obj : diag::ext_cast_fn_obj)
2504 << OpRange;
2505 return SuccessResult;
2506 }
2507
2508 if (DestType->isFunctionPointerType()) {
2509 // See above.
2510 Self.Diag(OpRange.getBegin(),
2511 Self.getLangOpts().CPlusPlus11 ?
2512 diag::warn_cxx98_compat_cast_fn_obj : diag::ext_cast_fn_obj)
2513 << OpRange;
2514 return SuccessResult;
2515 }
2516
2517 // Diagnose address space conversion in nested pointers.
2518 QualType DestPtee = DestType->getPointeeType().isNull()
2519 ? DestType->getPointeeType()
2520 : DestType->getPointeeType()->getPointeeType();
2521 QualType SrcPtee = SrcType->getPointeeType().isNull()
2522 ? SrcType->getPointeeType()
2523 : SrcType->getPointeeType()->getPointeeType();
2524 while (!DestPtee.isNull() && !SrcPtee.isNull()) {
2525 if (DestPtee.getAddressSpace() != SrcPtee.getAddressSpace()) {
2526 Self.Diag(OpRange.getBegin(),
2527 diag::warn_bad_cxx_cast_nested_pointer_addr_space)
2528 << CStyle << SrcType << DestType << SrcExpr.get()->getSourceRange();
2529 break;
2530 }
2531 DestPtee = DestPtee->getPointeeType();
2532 SrcPtee = SrcPtee->getPointeeType();
2533 }
2534
2535 // C++ 5.2.10p7: A pointer to an object can be explicitly converted to
2536 // a pointer to an object of different type.
2537 // Void pointers are not specified, but supported by every compiler out there.
2538 // So we finish by allowing everything that remains - it's got to be two
2539 // object pointers.
2540 return SuccessResult;
2541}
2542
2543static TryCastResult TryAddressSpaceCast(Sema &Self, ExprResult &SrcExpr,
2544 QualType DestType, bool CStyle,
2545 unsigned &msg, CastKind &Kind) {
2546 if (!Self.getLangOpts().OpenCL)
2547 // FIXME: As compiler doesn't have any information about overlapping addr
2548 // spaces at the moment we have to be permissive here.
2549 return TC_NotApplicable;
2550 // Even though the logic below is general enough and can be applied to
2551 // non-OpenCL mode too, we fast-path above because no other languages
2552 // define overlapping address spaces currently.
2553 auto SrcType = SrcExpr.get()->getType();
2554 // FIXME: Should this be generalized to references? The reference parameter
2555 // however becomes a reference pointee type here and therefore rejected.
2556 // Perhaps this is the right behavior though according to C++.
2557 auto SrcPtrType = SrcType->getAs<PointerType>();
2558 if (!SrcPtrType)
2559 return TC_NotApplicable;
2560 auto DestPtrType = DestType->getAs<PointerType>();
2561 if (!DestPtrType)
2562 return TC_NotApplicable;
2563 auto SrcPointeeType = SrcPtrType->getPointeeType();
2564 auto DestPointeeType = DestPtrType->getPointeeType();
2565 if (!DestPointeeType.isAddressSpaceOverlapping(SrcPointeeType)) {
2566 msg = diag::err_bad_cxx_cast_addr_space_mismatch;
2567 return TC_Failed;
2568 }
2569 auto SrcPointeeTypeWithoutAS =
2570 Self.Context.removeAddrSpaceQualType(SrcPointeeType.getCanonicalType());
2571 auto DestPointeeTypeWithoutAS =
2572 Self.Context.removeAddrSpaceQualType(DestPointeeType.getCanonicalType());
2573 if (Self.Context.hasSameType(SrcPointeeTypeWithoutAS,
2574 DestPointeeTypeWithoutAS)) {
2575 Kind = SrcPointeeType.getAddressSpace() == DestPointeeType.getAddressSpace()
2576 ? CK_NoOp
2577 : CK_AddressSpaceConversion;
2578 return TC_Success;
2579 } else {
2580 return TC_NotApplicable;
2581 }
2582}
2583
2584void CastOperation::checkAddressSpaceCast(QualType SrcType, QualType DestType) {
2585 // In OpenCL only conversions between pointers to objects in overlapping
2586 // addr spaces are allowed. v2.0 s6.5.5 - Generic addr space overlaps
2587 // with any named one, except for constant.
2588
2589 // Converting the top level pointee addrspace is permitted for compatible
2590 // addrspaces (such as 'generic int *' to 'local int *' or vice versa), but
2591 // if any of the nested pointee addrspaces differ, we emit a warning
2592 // regardless of addrspace compatibility. This makes
2593 // local int ** p;
2594 // return (generic int **) p;
2595 // warn even though local -> generic is permitted.
2596 if (Self.getLangOpts().OpenCL) {
2597 const Type *DestPtr, *SrcPtr;
2598 bool Nested = false;
2599 unsigned DiagID = diag::err_typecheck_incompatible_address_space;
2600 DestPtr = Self.getASTContext().getCanonicalType(DestType.getTypePtr()),
2601 SrcPtr = Self.getASTContext().getCanonicalType(SrcType.getTypePtr());
2602
2603 while (isa<PointerType>(DestPtr) && isa<PointerType>(SrcPtr)) {
2604 const PointerType *DestPPtr = cast<PointerType>(DestPtr);
2605 const PointerType *SrcPPtr = cast<PointerType>(SrcPtr);
2606 QualType DestPPointee = DestPPtr->getPointeeType();
2607 QualType SrcPPointee = SrcPPtr->getPointeeType();
2608 if (Nested
2609 ? DestPPointee.getAddressSpace() != SrcPPointee.getAddressSpace()
2610 : !DestPPointee.isAddressSpaceOverlapping(SrcPPointee)) {
2611 Self.Diag(OpRange.getBegin(), DiagID)
2612 << SrcType << DestType << Sema::AA_Casting
2613 << SrcExpr.get()->getSourceRange();
2614 if (!Nested)
2615 SrcExpr = ExprError();
2616 return;
2617 }
2618
2619 DestPtr = DestPPtr->getPointeeType().getTypePtr();
2620 SrcPtr = SrcPPtr->getPointeeType().getTypePtr();
2621 Nested = true;
2622 DiagID = diag::ext_nested_pointer_qualifier_mismatch;
2623 }
2624 }
2625}
2626
2627bool Sema::ShouldSplatAltivecScalarInCast(const VectorType *VecTy) {
2628 bool SrcCompatXL = this->getLangOpts().getAltivecSrcCompat() ==
2629 LangOptions::AltivecSrcCompatKind::XL;
2630 VectorType::VectorKind VKind = VecTy->getVectorKind();
2631
2632 if ((VKind == VectorType::AltiVecVector) ||
2633 (SrcCompatXL && ((VKind == VectorType::AltiVecBool) ||
2634 (VKind == VectorType::AltiVecPixel)))) {
2635 return true;
2636 }
2637 return false;
2638}
2639
2640bool Sema::CheckAltivecInitFromScalar(SourceRange R, QualType VecTy,
2641 QualType SrcTy) {
2642 bool SrcCompatGCC = this->getLangOpts().getAltivecSrcCompat() ==
2643 LangOptions::AltivecSrcCompatKind::GCC;
2644 if (this->getLangOpts().AltiVec && SrcCompatGCC) {
2645 this->Diag(R.getBegin(),
2646 diag::err_invalid_conversion_between_vector_and_integer)
2647 << VecTy << SrcTy << R;
2648 return true;
2649 }
2650 return false;
2651}
2652
2653void CastOperation::CheckCXXCStyleCast(bool FunctionalStyle,
2654 bool ListInitialization) {
2655 assert(Self.getLangOpts().CPlusPlus)(static_cast <bool> (Self.getLangOpts().CPlusPlus) ? void
(0) : __assert_fail ("Self.getLangOpts().CPlusPlus", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 2655, __extension__ __PRETTY_FUNCTION__))
;
2656
2657 // Handle placeholders.
2658 if (isPlaceholder()) {
2659 // C-style casts can resolve __unknown_any types.
2660 if (claimPlaceholder(BuiltinType::UnknownAny)) {
2661 SrcExpr = Self.checkUnknownAnyCast(DestRange, DestType,
2662 SrcExpr.get(), Kind,
2663 ValueKind, BasePath);
2664 return;
2665 }
2666
2667 checkNonOverloadPlaceholders();
2668 if (SrcExpr.isInvalid())
2669 return;
2670 }
2671
2672 // C++ 5.2.9p4: Any expression can be explicitly converted to type "cv void".
2673 // This test is outside everything else because it's the only case where
2674 // a non-lvalue-reference target type does not lead to decay.
2675 if (DestType->isVoidType()) {
2676 Kind = CK_ToVoid;
2677
2678 if (claimPlaceholder(BuiltinType::Overload)) {
2679 Self.ResolveAndFixSingleFunctionTemplateSpecialization(
2680 SrcExpr, /* Decay Function to ptr */ false,
2681 /* Complain */ true, DestRange, DestType,
2682 diag::err_bad_cstyle_cast_overload);
2683 if (SrcExpr.isInvalid())
2684 return;
2685 }
2686
2687 SrcExpr = Self.IgnoredValueConversions(SrcExpr.get());
2688 return;
2689 }
2690
2691 // If the type is dependent, we won't do any other semantic analysis now.
2692 if (DestType->isDependentType() || SrcExpr.get()->isTypeDependent() ||
2693 SrcExpr.get()->isValueDependent()) {
2694 assert(Kind == CK_Dependent)(static_cast <bool> (Kind == CK_Dependent) ? void (0) :
__assert_fail ("Kind == CK_Dependent", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 2694, __extension__ __PRETTY_FUNCTION__))
;
2695 return;
2696 }
2697
2698 if (ValueKind == VK_PRValue && !DestType->isRecordType() &&
2699 !isPlaceholder(BuiltinType::Overload)) {
2700 SrcExpr = Self.DefaultFunctionArrayLvalueConversion(SrcExpr.get());
2701 if (SrcExpr.isInvalid())
2702 return;
2703 }
2704
2705 // AltiVec vector initialization with a single literal.
2706 if (const VectorType *vecTy = DestType->getAs<VectorType>()) {
2707 if (Self.CheckAltivecInitFromScalar(OpRange, DestType,
2708 SrcExpr.get()->getType())) {
2709 SrcExpr = ExprError();
2710 return;
2711 }
2712 if (Self.ShouldSplatAltivecScalarInCast(vecTy) &&
2713 (SrcExpr.get()->getType()->isIntegerType() ||
2714 SrcExpr.get()->getType()->isFloatingType())) {
2715 Kind = CK_VectorSplat;
2716 SrcExpr = Self.prepareVectorSplat(DestType, SrcExpr.get());
2717 return;
2718 }
2719 }
2720
2721 // C++ [expr.cast]p5: The conversions performed by
2722 // - a const_cast,
2723 // - a static_cast,
2724 // - a static_cast followed by a const_cast,
2725 // - a reinterpret_cast, or
2726 // - a reinterpret_cast followed by a const_cast,
2727 // can be performed using the cast notation of explicit type conversion.
2728 // [...] If a conversion can be interpreted in more than one of the ways
2729 // listed above, the interpretation that appears first in the list is used,
2730 // even if a cast resulting from that interpretation is ill-formed.
2731 // In plain language, this means trying a const_cast ...
2732 // Note that for address space we check compatibility after const_cast.
2733 unsigned msg = diag::err_bad_cxx_cast_generic;
2734 TryCastResult tcr = TryConstCast(Self, SrcExpr, DestType,
2735 /*CStyle*/ true, msg);
2736 if (SrcExpr.isInvalid())
2737 return;
2738 if (isValidCast(tcr))
2739 Kind = CK_NoOp;
2740
2741 Sema::CheckedConversionKind CCK =
2742 FunctionalStyle ? Sema::CCK_FunctionalCast : Sema::CCK_CStyleCast;
2743 if (tcr == TC_NotApplicable) {
2744 tcr = TryAddressSpaceCast(Self, SrcExpr, DestType, /*CStyle*/ true, msg,
2745 Kind);
2746 if (SrcExpr.isInvalid())
2747 return;
2748
2749 if (tcr == TC_NotApplicable) {
2750 // ... or if that is not possible, a static_cast, ignoring const and
2751 // addr space, ...
2752 tcr = TryStaticCast(Self, SrcExpr, DestType, CCK, OpRange, msg, Kind,
2753 BasePath, ListInitialization);
2754 if (SrcExpr.isInvalid())
2755 return;
2756
2757 if (tcr == TC_NotApplicable) {
2758 // ... and finally a reinterpret_cast, ignoring const and addr space.
2759 tcr = TryReinterpretCast(Self, SrcExpr, DestType, /*CStyle*/ true,
2760 OpRange, msg, Kind);
2761 if (SrcExpr.isInvalid())
2762 return;
2763 }
2764 }
2765 }
2766
2767 if (Self.getLangOpts().allowsNonTrivialObjCLifetimeQualifiers() &&
2768 isValidCast(tcr))
2769 checkObjCConversion(CCK);
2770
2771 if (tcr != TC_Success && msg != 0) {
2772 if (SrcExpr.get()->getType() == Self.Context.OverloadTy) {
2773 DeclAccessPair Found;
2774 FunctionDecl *Fn = Self.ResolveAddressOfOverloadedFunction(SrcExpr.get(),
2775 DestType,
2776 /*Complain*/ true,
2777 Found);
2778 if (Fn) {
2779 // If DestType is a function type (not to be confused with the function
2780 // pointer type), it will be possible to resolve the function address,
2781 // but the type cast should be considered as failure.
2782 OverloadExpr *OE = OverloadExpr::find(SrcExpr.get()).Expression;
2783 Self.Diag(OpRange.getBegin(), diag::err_bad_cstyle_cast_overload)
2784 << OE->getName() << DestType << OpRange
2785 << OE->getQualifierLoc().getSourceRange();
2786 Self.NoteAllOverloadCandidates(SrcExpr.get());
2787 }
2788 } else {
2789 diagnoseBadCast(Self, msg, (FunctionalStyle ? CT_Functional : CT_CStyle),
2790 OpRange, SrcExpr.get(), DestType, ListInitialization);
2791 }
2792 }
2793
2794 if (isValidCast(tcr)) {
2795 if (Kind == CK_BitCast)
2796 checkCastAlign();
2797
2798 if (!checkCastFunctionType(Self, SrcExpr, DestType))
2799 Self.Diag(OpRange.getBegin(), diag::warn_cast_function_type)
2800 << SrcExpr.get()->getType() << DestType << OpRange;
2801
2802 } else {
2803 SrcExpr = ExprError();
2804 }
2805}
2806
2807/// DiagnoseBadFunctionCast - Warn whenever a function call is cast to a
2808/// non-matching type. Such as enum function call to int, int call to
2809/// pointer; etc. Cast to 'void' is an exception.
2810static void DiagnoseBadFunctionCast(Sema &Self, const ExprResult &SrcExpr,
2811 QualType DestType) {
2812 if (Self.Diags.isIgnored(diag::warn_bad_function_cast,
2813 SrcExpr.get()->getExprLoc()))
2814 return;
2815
2816 if (!isa<CallExpr>(SrcExpr.get()))
2817 return;
2818
2819 QualType SrcType = SrcExpr.get()->getType();
2820 if (DestType.getUnqualifiedType()->isVoidType())
2821 return;
2822 if ((SrcType->isAnyPointerType() || SrcType->isBlockPointerType())
2823 && (DestType->isAnyPointerType() || DestType->isBlockPointerType()))
2824 return;
2825 if (SrcType->isIntegerType() && DestType->isIntegerType() &&
2826 (SrcType->isBooleanType() == DestType->isBooleanType()) &&
2827 (SrcType->isEnumeralType() == DestType->isEnumeralType()))
2828 return;
2829 if (SrcType->isRealFloatingType() && DestType->isRealFloatingType())
2830 return;
2831 if (SrcType->isEnumeralType() && DestType->isEnumeralType())
2832 return;
2833 if (SrcType->isComplexType() && DestType->isComplexType())
2834 return;
2835 if (SrcType->isComplexIntegerType() && DestType->isComplexIntegerType())
2836 return;
2837 if (SrcType->isFixedPointType() && DestType->isFixedPointType())
2838 return;
2839
2840 Self.Diag(SrcExpr.get()->getExprLoc(),
2841 diag::warn_bad_function_cast)
2842 << SrcType << DestType << SrcExpr.get()->getSourceRange();
2843}
2844
2845/// Check the semantics of a C-style cast operation, in C.
2846void CastOperation::CheckCStyleCast() {
2847 assert(!Self.getLangOpts().CPlusPlus)(static_cast <bool> (!Self.getLangOpts().CPlusPlus) ? void
(0) : __assert_fail ("!Self.getLangOpts().CPlusPlus", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 2847, __extension__ __PRETTY_FUNCTION__))
;
2848
2849 // C-style casts can resolve __unknown_any types.
2850 if (claimPlaceholder(BuiltinType::UnknownAny)) {
2851 SrcExpr = Self.checkUnknownAnyCast(DestRange, DestType,
2852 SrcExpr.get(), Kind,
2853 ValueKind, BasePath);
2854 return;
2855 }
2856
2857 // C99 6.5.4p2: the cast type needs to be void or scalar and the expression
2858 // type needs to be scalar.
2859 if (DestType->isVoidType()) {
2860 // We don't necessarily do lvalue-to-rvalue conversions on this.
2861 SrcExpr = Self.IgnoredValueConversions(SrcExpr.get());
2862 if (SrcExpr.isInvalid())
2863 return;
2864
2865 // Cast to void allows any expr type.
2866 Kind = CK_ToVoid;
2867 return;
2868 }
2869
2870 // If the type is dependent, we won't do any other semantic analysis now.
2871 if (Self.getASTContext().isDependenceAllowed() &&
2872 (DestType->isDependentType() || SrcExpr.get()->isTypeDependent() ||
2873 SrcExpr.get()->isValueDependent())) {
2874 assert((DestType->containsErrors() || SrcExpr.get()->containsErrors() ||(static_cast <bool> ((DestType->containsErrors() || SrcExpr
.get()->containsErrors() || SrcExpr.get()->containsErrors
()) && "should only occur in error-recovery path.") ?
void (0) : __assert_fail ("(DestType->containsErrors() || SrcExpr.get()->containsErrors() || SrcExpr.get()->containsErrors()) && \"should only occur in error-recovery path.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 2876, __extension__ __PRETTY_FUNCTION__))
2875 SrcExpr.get()->containsErrors()) &&(static_cast <bool> ((DestType->containsErrors() || SrcExpr
.get()->containsErrors() || SrcExpr.get()->containsErrors
()) && "should only occur in error-recovery path.") ?
void (0) : __assert_fail ("(DestType->containsErrors() || SrcExpr.get()->containsErrors() || SrcExpr.get()->containsErrors()) && \"should only occur in error-recovery path.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 2876, __extension__ __PRETTY_FUNCTION__))
2876 "should only occur in error-recovery path.")(static_cast <bool> ((DestType->containsErrors() || SrcExpr
.get()->containsErrors() || SrcExpr.get()->containsErrors
()) && "should only occur in error-recovery path.") ?
void (0) : __assert_fail ("(DestType->containsErrors() || SrcExpr.get()->containsErrors() || SrcExpr.get()->containsErrors()) && \"should only occur in error-recovery path.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 2876, __extension__ __PRETTY_FUNCTION__))
;
2877 assert(Kind == CK_Dependent)(static_cast <bool> (Kind == CK_Dependent) ? void (0) :
__assert_fail ("Kind == CK_Dependent", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 2877, __extension__ __PRETTY_FUNCTION__))
;
2878 return;
2879 }
2880
2881 // Overloads are allowed with C extensions, so we need to support them.
2882 if (SrcExpr.get()->getType() == Self.Context.OverloadTy) {
2883 DeclAccessPair DAP;
2884 if (FunctionDecl *FD = Self.ResolveAddressOfOverloadedFunction(
2885 SrcExpr.get(), DestType, /*Complain=*/true, DAP))
2886 SrcExpr = Self.FixOverloadedFunctionReference(SrcExpr.get(), DAP, FD);
2887 else
2888 return;
2889 assert(SrcExpr.isUsable())(static_cast <bool> (SrcExpr.isUsable()) ? void (0) : __assert_fail
("SrcExpr.isUsable()", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 2889, __extension__ __PRETTY_FUNCTION__))
;
2890 }
2891 SrcExpr = Self.DefaultFunctionArrayLvalueConversion(SrcExpr.get());
2892 if (SrcExpr.isInvalid())
2893 return;
2894 QualType SrcType = SrcExpr.get()->getType();
2895
2896 assert(!SrcType->isPlaceholderType())(static_cast <bool> (!SrcType->isPlaceholderType()) ?
void (0) : __assert_fail ("!SrcType->isPlaceholderType()"
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 2896, __extension__ __PRETTY_FUNCTION__))
;
2897
2898 checkAddressSpaceCast(SrcType, DestType);
2899 if (SrcExpr.isInvalid())
2900 return;
2901
2902 if (Self.RequireCompleteType(OpRange.getBegin(), DestType,
2903 diag::err_typecheck_cast_to_incomplete)) {
2904 SrcExpr = ExprError();
2905 return;
2906 }
2907
2908 // Allow casting a sizeless built-in type to itself.
2909 if (DestType->isSizelessBuiltinType() &&
2910 Self.Context.hasSameUnqualifiedType(DestType, SrcType)) {
2911 Kind = CK_NoOp;
2912 return;
2913 }
2914
2915 // Allow bitcasting between compatible SVE vector types.
2916 if ((SrcType->isVectorType() || DestType->isVectorType()) &&
2917 Self.isValidSveBitcast(SrcType, DestType)) {
2918 Kind = CK_BitCast;
2919 return;
2920 }
2921
2922 if (!DestType->isScalarType() && !DestType->isVectorType() &&
2923 !DestType->isMatrixType()) {
2924 const RecordType *DestRecordTy = DestType->getAs<RecordType>();
2925
2926 if (DestRecordTy && Self.Context.hasSameUnqualifiedType(DestType, SrcType)){
2927 // GCC struct/union extension: allow cast to self.
2928 Self.Diag(OpRange.getBegin(), diag::ext_typecheck_cast_nonscalar)
2929 << DestType << SrcExpr.get()->getSourceRange();
2930 Kind = CK_NoOp;
2931 return;
2932 }
2933
2934 // GCC's cast to union extension.
2935 if (DestRecordTy && DestRecordTy->getDecl()->isUnion()) {
2936 RecordDecl *RD = DestRecordTy->getDecl();
2937 if (CastExpr::getTargetFieldForToUnionCast(RD, SrcType)) {
2938 Self.Diag(OpRange.getBegin(), diag::ext_typecheck_cast_to_union)
2939 << SrcExpr.get()->getSourceRange();
2940 Kind = CK_ToUnion;
2941 return;
2942 } else {
2943 Self.Diag(OpRange.getBegin(), diag::err_typecheck_cast_to_union_no_type)
2944 << SrcType << SrcExpr.get()->getSourceRange();
2945 SrcExpr = ExprError();
2946 return;
2947 }
2948 }
2949
2950 // OpenCL v2.0 s6.13.10 - Allow casts from '0' to event_t type.
2951 if (Self.getLangOpts().OpenCL && DestType->isEventT()) {
2952 Expr::EvalResult Result;
2953 if (SrcExpr.get()->EvaluateAsInt(Result, Self.Context)) {
2954 llvm::APSInt CastInt = Result.Val.getInt();
2955 if (0 == CastInt) {
2956 Kind = CK_ZeroToOCLOpaqueType;
2957 return;
2958 }
2959 Self.Diag(OpRange.getBegin(),
2960 diag::err_opencl_cast_non_zero_to_event_t)
2961 << toString(CastInt, 10) << SrcExpr.get()->getSourceRange();
2962 SrcExpr = ExprError();
2963 return;
2964 }
2965 }
2966
2967 // Reject any other conversions to non-scalar types.
2968 Self.Diag(OpRange.getBegin(), diag::err_typecheck_cond_expect_scalar)
2969 << DestType << SrcExpr.get()->getSourceRange();
2970 SrcExpr = ExprError();
2971 return;
2972 }
2973
2974 // The type we're casting to is known to be a scalar, a vector, or a matrix.
2975
2976 // Require the operand to be a scalar, a vector, or a matrix.
2977 if (!SrcType->isScalarType() && !SrcType->isVectorType() &&
2978 !SrcType->isMatrixType()) {
2979 Self.Diag(SrcExpr.get()->getExprLoc(),
2980 diag::err_typecheck_expect_scalar_operand)
2981 << SrcType << SrcExpr.get()->getSourceRange();
2982 SrcExpr = ExprError();
2983 return;
2984 }
2985
2986 if (DestType->isExtVectorType()) {
2987 SrcExpr = Self.CheckExtVectorCast(OpRange, DestType, SrcExpr.get(), Kind);
2988 return;
2989 }
2990
2991 if (DestType->getAs<MatrixType>() || SrcType->getAs<MatrixType>()) {
2992 if (Self.CheckMatrixCast(OpRange, DestType, SrcType, Kind))
2993 SrcExpr = ExprError();
2994 return;
2995 }
2996
2997 if (const VectorType *DestVecTy = DestType->getAs<VectorType>()) {
2998 if (Self.CheckAltivecInitFromScalar(OpRange, DestType, SrcType)) {
2999 SrcExpr = ExprError();
3000 return;
3001 }
3002 if (Self.ShouldSplatAltivecScalarInCast(DestVecTy) &&
3003 (SrcType->isIntegerType() || SrcType->isFloatingType())) {
3004 Kind = CK_VectorSplat;
3005 SrcExpr = Self.prepareVectorSplat(DestType, SrcExpr.get());
3006 } else if (Self.CheckVectorCast(OpRange, DestType, SrcType, Kind)) {
3007 SrcExpr = ExprError();
3008 }
3009 return;
3010 }
3011
3012 if (SrcType->isVectorType()) {
3013 if (Self.CheckVectorCast(OpRange, SrcType, DestType, Kind))
3014 SrcExpr = ExprError();
3015 return;
3016 }
3017
3018 // The source and target types are both scalars, i.e.
3019 // - arithmetic types (fundamental, enum, and complex)
3020 // - all kinds of pointers
3021 // Note that member pointers were filtered out with C++, above.
3022
3023 if (isa<ObjCSelectorExpr>(SrcExpr.get())) {
3024 Self.Diag(SrcExpr.get()->getExprLoc(), diag::err_cast_selector_expr);
3025 SrcExpr = ExprError();
3026 return;
3027 }
3028
3029 // Can't cast to or from bfloat
3030 if (DestType->isBFloat16Type() && !SrcType->isBFloat16Type()) {
3031 Self.Diag(SrcExpr.get()->getExprLoc(), diag::err_cast_to_bfloat16)
3032 << SrcExpr.get()->getSourceRange();
3033 SrcExpr = ExprError();
3034 return;
3035 }
3036 if (SrcType->isBFloat16Type() && !DestType->isBFloat16Type()) {
3037 Self.Diag(SrcExpr.get()->getExprLoc(), diag::err_cast_from_bfloat16)
3038 << SrcExpr.get()->getSourceRange();
3039 SrcExpr = ExprError();
3040 return;
3041 }
3042
3043 // If either type is a pointer, the other type has to be either an
3044 // integer or a pointer.
3045 if (!DestType->isArithmeticType()) {
3046 if (!SrcType->isIntegralType(Self.Context) && SrcType->isArithmeticType()) {
3047 Self.Diag(SrcExpr.get()->getExprLoc(),
3048 diag::err_cast_pointer_from_non_pointer_int)
3049 << SrcType << SrcExpr.get()->getSourceRange();
3050 SrcExpr = ExprError();
3051 return;
3052 }
3053 checkIntToPointerCast(/* CStyle */ true, OpRange, SrcExpr.get(), DestType,
3054 Self);
3055 } else if (!SrcType->isArithmeticType()) {
3056 if (!DestType->isIntegralType(Self.Context) &&
3057 DestType->isArithmeticType()) {
3058 Self.Diag(SrcExpr.get()->getBeginLoc(),
3059 diag::err_cast_pointer_to_non_pointer_int)
3060 << DestType << SrcExpr.get()->getSourceRange();
3061 SrcExpr = ExprError();
3062 return;
3063 }
3064
3065 if ((Self.Context.getTypeSize(SrcType) >
3066 Self.Context.getTypeSize(DestType)) &&
3067 !DestType->isBooleanType()) {
3068 // C 6.3.2.3p6: Any pointer type may be converted to an integer type.
3069 // Except as previously specified, the result is implementation-defined.
3070 // If the result cannot be represented in the integer type, the behavior
3071 // is undefined. The result need not be in the range of values of any
3072 // integer type.
3073 unsigned Diag;
3074 if (SrcType->isVoidPointerType())
3075 Diag = DestType->isEnumeralType() ? diag::warn_void_pointer_to_enum_cast
3076 : diag::warn_void_pointer_to_int_cast;
3077 else if (DestType->isEnumeralType())
3078 Diag = diag::warn_pointer_to_enum_cast;
3079 else
3080 Diag = diag::warn_pointer_to_int_cast;
3081 Self.Diag(OpRange.getBegin(), Diag) << SrcType << DestType << OpRange;
3082 }
3083 }
3084
3085 if (Self.getLangOpts().OpenCL && !Self.getOpenCLOptions().isAvailableOption(
3086 "cl_khr_fp16", Self.getLangOpts())) {
3087 if (DestType->isHalfType()) {
3088 Self.Diag(SrcExpr.get()->getBeginLoc(), diag::err_opencl_cast_to_half)
3089 << DestType << SrcExpr.get()->getSourceRange();
3090 SrcExpr = ExprError();
3091 return;
3092 }
3093 }
3094
3095 // ARC imposes extra restrictions on casts.
3096 if (Self.getLangOpts().allowsNonTrivialObjCLifetimeQualifiers()) {
3097 checkObjCConversion(Sema::CCK_CStyleCast);
3098 if (SrcExpr.isInvalid())
3099 return;
3100
3101 const PointerType *CastPtr = DestType->getAs<PointerType>();
3102 if (Self.getLangOpts().ObjCAutoRefCount && CastPtr) {
3103 if (const PointerType *ExprPtr = SrcType->getAs<PointerType>()) {
3104 Qualifiers CastQuals = CastPtr->getPointeeType().getQualifiers();
3105 Qualifiers ExprQuals = ExprPtr->getPointeeType().getQualifiers();
3106 if (CastPtr->getPointeeType()->isObjCLifetimeType() &&
3107 ExprPtr->getPointeeType()->isObjCLifetimeType() &&
3108 !CastQuals.compatiblyIncludesObjCLifetime(ExprQuals)) {
3109 Self.Diag(SrcExpr.get()->getBeginLoc(),
3110 diag::err_typecheck_incompatible_ownership)
3111 << SrcType << DestType << Sema::AA_Casting
3112 << SrcExpr.get()->getSourceRange();
3113 return;
3114 }
3115 }
3116 }
3117 else if (!Self.CheckObjCARCUnavailableWeakConversion(DestType, SrcType)) {
3118 Self.Diag(SrcExpr.get()->getBeginLoc(),
3119 diag::err_arc_convesion_of_weak_unavailable)
3120 << 1 << SrcType << DestType << SrcExpr.get()->getSourceRange();
3121 SrcExpr = ExprError();
3122 return;
3123 }
3124 }
3125
3126 if (!checkCastFunctionType(Self, SrcExpr, DestType))
3127 Self.Diag(OpRange.getBegin(), diag::warn_cast_function_type)
3128 << SrcType << DestType << OpRange;
3129
3130 DiagnoseCastOfObjCSEL(Self, SrcExpr, DestType);
3131 DiagnoseCallingConvCast(Self, SrcExpr, DestType, OpRange);
3132 DiagnoseBadFunctionCast(Self, SrcExpr, DestType);
3133 Kind = Self.PrepareScalarCast(SrcExpr, DestType);
3134 if (SrcExpr.isInvalid())
3135 return;
3136
3137 if (Kind == CK_BitCast)
3138 checkCastAlign();
3139}
3140
3141void CastOperation::CheckBuiltinBitCast() {
3142 QualType SrcType = SrcExpr.get()->getType();
3143
3144 if (Self.RequireCompleteType(OpRange.getBegin(), DestType,
3145 diag::err_typecheck_cast_to_incomplete) ||
3146 Self.RequireCompleteType(OpRange.getBegin(), SrcType,
3147 diag::err_incomplete_type)) {
3148 SrcExpr = ExprError();
3149 return;
3150 }
3151
3152 if (SrcExpr.get()->isPRValue())
3153 SrcExpr = Self.CreateMaterializeTemporaryExpr(SrcType, SrcExpr.get(),
3154 /*IsLValueReference=*/false);
3155
3156 CharUnits DestSize = Self.Context.getTypeSizeInChars(DestType);
3157 CharUnits SourceSize = Self.Context.getTypeSizeInChars(SrcType);
3158 if (DestSize != SourceSize) {
3159 Self.Diag(OpRange.getBegin(), diag::err_bit_cast_type_size_mismatch)
3160 << (int)SourceSize.getQuantity() << (int)DestSize.getQuantity();
3161 SrcExpr = ExprError();
3162 return;
3163 }
3164
3165 if (!DestType.isTriviallyCopyableType(Self.Context)) {
3166 Self.Diag(OpRange.getBegin(), diag::err_bit_cast_non_trivially_copyable)
3167 << 1;
3168 SrcExpr = ExprError();
3169 return;
3170 }
3171
3172 if (!SrcType.isTriviallyCopyableType(Self.Context)) {
3173 Self.Diag(OpRange.getBegin(), diag::err_bit_cast_non_trivially_copyable)
3174 << 0;
3175 SrcExpr = ExprError();
3176 return;
3177 }
3178
3179 Kind = CK_LValueToRValueBitCast;
3180}
3181
3182/// DiagnoseCastQual - Warn whenever casts discards a qualifiers, be it either
3183/// const, volatile or both.
3184static void DiagnoseCastQual(Sema &Self, const ExprResult &SrcExpr,
3185 QualType DestType) {
3186 if (SrcExpr.isInvalid())
3187 return;
3188
3189 QualType SrcType = SrcExpr.get()->getType();
3190 if (!((SrcType->isAnyPointerType() && DestType->isAnyPointerType()) ||
3191 DestType->isLValueReferenceType()))
3192 return;
3193
3194 QualType TheOffendingSrcType, TheOffendingDestType;
3195 Qualifiers CastAwayQualifiers;
3196 if (CastsAwayConstness(Self, SrcType, DestType, true, false,
3197 &TheOffendingSrcType, &TheOffendingDestType,
3198 &CastAwayQualifiers) !=
3199 CastAwayConstnessKind::CACK_Similar)
3200 return;
3201
3202 // FIXME: 'restrict' is not properly handled here.
3203 int qualifiers = -1;
3204 if (CastAwayQualifiers.hasConst() && CastAwayQualifiers.hasVolatile()) {
3205 qualifiers = 0;
3206 } else if (CastAwayQualifiers.hasConst()) {
3207 qualifiers = 1;
3208 } else if (CastAwayQualifiers.hasVolatile()) {
3209 qualifiers = 2;
3210 }
3211 // This is a variant of int **x; const int **y = (const int **)x;
3212 if (qualifiers == -1)
3213 Self.Diag(SrcExpr.get()->getBeginLoc(), diag::warn_cast_qual2)
3214 << SrcType << DestType;
3215 else
3216 Self.Diag(SrcExpr.get()->getBeginLoc(), diag::warn_cast_qual)
3217 << TheOffendingSrcType << TheOffendingDestType << qualifiers;
3218}
3219
3220ExprResult Sema::BuildCStyleCastExpr(SourceLocation LPLoc,
3221 TypeSourceInfo *CastTypeInfo,
3222 SourceLocation RPLoc,
3223 Expr *CastExpr) {
3224 CastOperation Op(*this, CastTypeInfo->getType(), CastExpr);
3225 Op.DestRange = CastTypeInfo->getTypeLoc().getSourceRange();
3226 Op.OpRange = SourceRange(LPLoc, CastExpr->getEndLoc());
3227
3228 if (getLangOpts().CPlusPlus) {
3229 Op.CheckCXXCStyleCast(/*FunctionalCast=*/ false,
3230 isa<InitListExpr>(CastExpr));
3231 } else {
3232 Op.CheckCStyleCast();
3233 }
3234
3235 if (Op.SrcExpr.isInvalid())
3236 return ExprError();
3237
3238 // -Wcast-qual
3239 DiagnoseCastQual(Op.Self, Op.SrcExpr, Op.DestType);
3240
3241 return Op.complete(CStyleCastExpr::Create(
3242 Context, Op.ResultType, Op.ValueKind, Op.Kind, Op.SrcExpr.get(),
3243 &Op.BasePath, CurFPFeatureOverrides(), CastTypeInfo, LPLoc, RPLoc));
3244}
3245
3246ExprResult Sema::BuildCXXFunctionalCastExpr(TypeSourceInfo *CastTypeInfo,
3247 QualType Type,
3248 SourceLocation LPLoc,
3249 Expr *CastExpr,
3250 SourceLocation RPLoc) {
3251 assert(LPLoc.isValid() && "List-initialization shouldn't get here.")(static_cast <bool> (LPLoc.isValid() && "List-initialization shouldn't get here."
) ? void (0) : __assert_fail ("LPLoc.isValid() && \"List-initialization shouldn't get here.\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/lib/Sema/SemaCast.cpp"
, 3251, __extension__ __PRETTY_FUNCTION__))
;
3252 CastOperation Op(*this, Type, CastExpr);
3253 Op.DestRange = CastTypeInfo->getTypeLoc().getSourceRange();
3254 Op.OpRange = SourceRange(Op.DestRange.getBegin(), CastExpr->getEndLoc());
3255
3256 Op.CheckCXXCStyleCast(/*FunctionalCast=*/true, /*ListInit=*/false);
3257 if (Op.SrcExpr.isInvalid())
3258 return ExprError();
3259
3260 auto *SubExpr = Op.SrcExpr.get();
3261 if (auto *BindExpr = dyn_cast<CXXBindTemporaryExpr>(SubExpr))
3262 SubExpr = BindExpr->getSubExpr();
3263 if (auto *ConstructExpr = dyn_cast<CXXConstructExpr>(SubExpr))
3264 ConstructExpr->setParenOrBraceRange(SourceRange(LPLoc, RPLoc));
3265
3266 return Op.complete(CXXFunctionalCastExpr::Create(
3267 Context, Op.ResultType, Op.ValueKind, CastTypeInfo, Op.Kind,
3268 Op.SrcExpr.get(), &Op.BasePath, CurFPFeatureOverrides(), LPLoc, RPLoc));
3269}

/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h

1//===- Type.h - C Language Family Type Representation -----------*- 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/// \file
10/// C Language Family Type Representation
11///
12/// This file defines the clang::Type interface and subclasses, used to
13/// represent types for languages in the C family.
14//
15//===----------------------------------------------------------------------===//
16
17#ifndef LLVM_CLANG_AST_TYPE_H
18#define LLVM_CLANG_AST_TYPE_H
19
20#include "clang/AST/DependenceFlags.h"
21#include "clang/AST/NestedNameSpecifier.h"
22#include "clang/AST/TemplateName.h"
23#include "clang/Basic/AddressSpaces.h"
24#include "clang/Basic/AttrKinds.h"
25#include "clang/Basic/Diagnostic.h"
26#include "clang/Basic/ExceptionSpecificationType.h"
27#include "clang/Basic/LLVM.h"
28#include "clang/Basic/Linkage.h"
29#include "clang/Basic/PartialDiagnostic.h"
30#include "clang/Basic/SourceLocation.h"
31#include "clang/Basic/Specifiers.h"
32#include "clang/Basic/Visibility.h"
33#include "llvm/ADT/APInt.h"
34#include "llvm/ADT/APSInt.h"
35#include "llvm/ADT/ArrayRef.h"
36#include "llvm/ADT/FoldingSet.h"
37#include "llvm/ADT/None.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/Twine.h"
43#include "llvm/ADT/iterator_range.h"
44#include "llvm/Support/Casting.h"
45#include "llvm/Support/Compiler.h"
46#include "llvm/Support/ErrorHandling.h"
47#include "llvm/Support/PointerLikeTypeTraits.h"
48#include "llvm/Support/TrailingObjects.h"
49#include "llvm/Support/type_traits.h"
50#include <cassert>
51#include <cstddef>
52#include <cstdint>
53#include <cstring>
54#include <string>
55#include <type_traits>
56#include <utility>
57
58namespace clang {
59
60class ExtQuals;
61class QualType;
62class ConceptDecl;
63class TagDecl;
64class TemplateParameterList;
65class Type;
66
67enum {
68 TypeAlignmentInBits = 4,
69 TypeAlignment = 1 << TypeAlignmentInBits
70};
71
72namespace serialization {
73 template <class T> class AbstractTypeReader;
74 template <class T> class AbstractTypeWriter;
75}
76
77} // namespace clang
78
79namespace llvm {
80
81 template <typename T>
82 struct PointerLikeTypeTraits;
83 template<>
84 struct PointerLikeTypeTraits< ::clang::Type*> {
85 static inline void *getAsVoidPointer(::clang::Type *P) { return P; }
86
87 static inline ::clang::Type *getFromVoidPointer(void *P) {
88 return static_cast< ::clang::Type*>(P);
89 }
90
91 static constexpr int NumLowBitsAvailable = clang::TypeAlignmentInBits;
92 };
93
94 template<>
95 struct PointerLikeTypeTraits< ::clang::ExtQuals*> {
96 static inline void *getAsVoidPointer(::clang::ExtQuals *P) { return P; }
97
98 static inline ::clang::ExtQuals *getFromVoidPointer(void *P) {
99 return static_cast< ::clang::ExtQuals*>(P);
100 }
101
102 static constexpr int NumLowBitsAvailable = clang::TypeAlignmentInBits;
103 };
104
105} // namespace llvm
106
107namespace clang {
108
109class ASTContext;
110template <typename> class CanQual;
111class CXXRecordDecl;
112class DeclContext;
113class EnumDecl;
114class Expr;
115class ExtQualsTypeCommonBase;
116class FunctionDecl;
117class IdentifierInfo;
118class NamedDecl;
119class ObjCInterfaceDecl;
120class ObjCProtocolDecl;
121class ObjCTypeParamDecl;
122struct PrintingPolicy;
123class RecordDecl;
124class Stmt;
125class TagDecl;
126class TemplateArgument;
127class TemplateArgumentListInfo;
128class TemplateArgumentLoc;
129class TemplateTypeParmDecl;
130class TypedefNameDecl;
131class UnresolvedUsingTypenameDecl;
132
133using CanQualType = CanQual<Type>;
134
135// Provide forward declarations for all of the *Type classes.
136#define TYPE(Class, Base) class Class##Type;
137#include "clang/AST/TypeNodes.inc"
138
139/// The collection of all-type qualifiers we support.
140/// Clang supports five independent qualifiers:
141/// * C99: const, volatile, and restrict
142/// * MS: __unaligned
143/// * Embedded C (TR18037): address spaces
144/// * Objective C: the GC attributes (none, weak, or strong)
145class Qualifiers {
146public:
147 enum TQ { // NOTE: These flags must be kept in sync with DeclSpec::TQ.
148 Const = 0x1,
149 Restrict = 0x2,
150 Volatile = 0x4,
151 CVRMask = Const | Volatile | Restrict
152 };
153
154 enum GC {
155 GCNone = 0,
156 Weak,
157 Strong
158 };
159
160 enum ObjCLifetime {
161 /// There is no lifetime qualification on this type.
162 OCL_None,
163
164 /// This object can be modified without requiring retains or
165 /// releases.
166 OCL_ExplicitNone,
167
168 /// Assigning into this object requires the old value to be
169 /// released and the new value to be retained. The timing of the
170 /// release of the old value is inexact: it may be moved to
171 /// immediately after the last known point where the value is
172 /// live.
173 OCL_Strong,
174
175 /// Reading or writing from this object requires a barrier call.
176 OCL_Weak,
177
178 /// Assigning into this object requires a lifetime extension.
179 OCL_Autoreleasing
180 };
181
182 enum {
183 /// The maximum supported address space number.
184 /// 23 bits should be enough for anyone.
185 MaxAddressSpace = 0x7fffffu,
186
187 /// The width of the "fast" qualifier mask.
188 FastWidth = 3,
189
190 /// The fast qualifier mask.
191 FastMask = (1 << FastWidth) - 1
192 };
193
194 /// Returns the common set of qualifiers while removing them from
195 /// the given sets.
196 static Qualifiers removeCommonQualifiers(Qualifiers &L, Qualifiers &R) {
197 // If both are only CVR-qualified, bit operations are sufficient.
198 if (!(L.Mask & ~CVRMask) && !(R.Mask & ~CVRMask)) {
199 Qualifiers Q;
200 Q.Mask = L.Mask & R.Mask;
201 L.Mask &= ~Q.Mask;
202 R.Mask &= ~Q.Mask;
203 return Q;
204 }
205
206 Qualifiers Q;
207 unsigned CommonCRV = L.getCVRQualifiers() & R.getCVRQualifiers();
208 Q.addCVRQualifiers(CommonCRV);
209 L.removeCVRQualifiers(CommonCRV);
210 R.removeCVRQualifiers(CommonCRV);
211
212 if (L.getObjCGCAttr() == R.getObjCGCAttr()) {
213 Q.setObjCGCAttr(L.getObjCGCAttr());
214 L.removeObjCGCAttr();
215 R.removeObjCGCAttr();
216 }
217
218 if (L.getObjCLifetime() == R.getObjCLifetime()) {
219 Q.setObjCLifetime(L.getObjCLifetime());
220 L.removeObjCLifetime();
221 R.removeObjCLifetime();
222 }
223
224 if (L.getAddressSpace() == R.getAddressSpace()) {
225 Q.setAddressSpace(L.getAddressSpace());
226 L.removeAddressSpace();
227 R.removeAddressSpace();
228 }
229 return Q;
230 }
231
232 static Qualifiers fromFastMask(unsigned Mask) {
233 Qualifiers Qs;
234 Qs.addFastQualifiers(Mask);
235 return Qs;
236 }
237
238 static Qualifiers fromCVRMask(unsigned CVR) {
239 Qualifiers Qs;
240 Qs.addCVRQualifiers(CVR);
241 return Qs;
242 }
243
244 static Qualifiers fromCVRUMask(unsigned CVRU) {
245 Qualifiers Qs;
246 Qs.addCVRUQualifiers(CVRU);
247 return Qs;
248 }
249
250 // Deserialize qualifiers from an opaque representation.
251 static Qualifiers fromOpaqueValue(unsigned opaque) {
252 Qualifiers Qs;
253 Qs.Mask = opaque;
254 return Qs;
255 }
256
257 // Serialize these qualifiers into an opaque representation.
258 unsigned getAsOpaqueValue() const {
259 return Mask;
260 }
261
262 bool hasConst() const { return Mask & Const; }
263 bool hasOnlyConst() const { return Mask == Const; }
264 void removeConst() { Mask &= ~Const; }
265 void addConst() { Mask |= Const; }
266
267 bool hasVolatile() const { return Mask & Volatile; }
268 bool hasOnlyVolatile() const { return Mask == Volatile; }
269 void removeVolatile() { Mask &= ~Volatile; }
270 void addVolatile() { Mask |= Volatile; }
271
272 bool hasRestrict() const { return Mask & Restrict; }
273 bool hasOnlyRestrict() const { return Mask == Restrict; }
274 void removeRestrict() { Mask &= ~Restrict; }
275 void addRestrict() { Mask |= Restrict; }
276
277 bool hasCVRQualifiers() const { return getCVRQualifiers(); }
278 unsigned getCVRQualifiers() const { return Mask & CVRMask; }
279 unsigned getCVRUQualifiers() const { return Mask & (CVRMask | UMask); }
280
281 void setCVRQualifiers(unsigned mask) {
282 assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits")(static_cast <bool> (!(mask & ~CVRMask) && "bitmask contains non-CVR bits"
) ? void (0) : __assert_fail ("!(mask & ~CVRMask) && \"bitmask contains non-CVR bits\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 282, __extension__ __PRETTY_FUNCTION__))
;
283 Mask = (Mask & ~CVRMask) | mask;
284 }
285 void removeCVRQualifiers(unsigned mask) {
286 assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits")(static_cast <bool> (!(mask & ~CVRMask) && "bitmask contains non-CVR bits"
) ? void (0) : __assert_fail ("!(mask & ~CVRMask) && \"bitmask contains non-CVR bits\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 286, __extension__ __PRETTY_FUNCTION__))
;
287 Mask &= ~mask;
288 }
289 void removeCVRQualifiers() {
290 removeCVRQualifiers(CVRMask);
291 }
292 void addCVRQualifiers(unsigned mask) {
293 assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits")(static_cast <bool> (!(mask & ~CVRMask) && "bitmask contains non-CVR bits"
) ? void (0) : __assert_fail ("!(mask & ~CVRMask) && \"bitmask contains non-CVR bits\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 293, __extension__ __PRETTY_FUNCTION__))
;
294 Mask |= mask;
295 }
296 void addCVRUQualifiers(unsigned mask) {
297 assert(!(mask & ~CVRMask & ~UMask) && "bitmask contains non-CVRU bits")(static_cast <bool> (!(mask & ~CVRMask & ~UMask
) && "bitmask contains non-CVRU bits") ? void (0) : __assert_fail
("!(mask & ~CVRMask & ~UMask) && \"bitmask contains non-CVRU bits\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 297, __extension__ __PRETTY_FUNCTION__))
;
298 Mask |= mask;
299 }
300
301 bool hasUnaligned() const { return Mask & UMask; }
302 void setUnaligned(bool flag) {
303 Mask = (Mask & ~UMask) | (flag ? UMask : 0);
304 }
305 void removeUnaligned() { Mask &= ~UMask; }
306 void addUnaligned() { Mask |= UMask; }
307
308 bool hasObjCGCAttr() const { return Mask & GCAttrMask; }
309 GC getObjCGCAttr() const { return GC((Mask & GCAttrMask) >> GCAttrShift); }
310 void setObjCGCAttr(GC type) {
311 Mask = (Mask & ~GCAttrMask) | (type << GCAttrShift);
312 }
313 void removeObjCGCAttr() { setObjCGCAttr(GCNone); }
314 void addObjCGCAttr(GC type) {
315 assert(type)(static_cast <bool> (type) ? void (0) : __assert_fail (
"type", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 315, __extension__ __PRETTY_FUNCTION__))
;
316 setObjCGCAttr(type);
317 }
318 Qualifiers withoutObjCGCAttr() const {
319 Qualifiers qs = *this;
320 qs.removeObjCGCAttr();
321 return qs;
322 }
323 Qualifiers withoutObjCLifetime() const {
324 Qualifiers qs = *this;
325 qs.removeObjCLifetime();
326 return qs;
327 }
328 Qualifiers withoutAddressSpace() const {
329 Qualifiers qs = *this;
330 qs.removeAddressSpace();
331 return qs;
332 }
333
334 bool hasObjCLifetime() const { return Mask & LifetimeMask; }
335 ObjCLifetime getObjCLifetime() const {
336 return ObjCLifetime((Mask & LifetimeMask) >> LifetimeShift);
337 }
338 void setObjCLifetime(ObjCLifetime type) {
339 Mask = (Mask & ~LifetimeMask) | (type << LifetimeShift);
340 }
341 void removeObjCLifetime() { setObjCLifetime(OCL_None); }
342 void addObjCLifetime(ObjCLifetime type) {
343 assert(type)(static_cast <bool> (type) ? void (0) : __assert_fail (
"type", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 343, __extension__ __PRETTY_FUNCTION__))
;
344 assert(!hasObjCLifetime())(static_cast <bool> (!hasObjCLifetime()) ? void (0) : __assert_fail
("!hasObjCLifetime()", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 344, __extension__ __PRETTY_FUNCTION__))
;
345 Mask |= (type << LifetimeShift);
346 }
347
348 /// True if the lifetime is neither None or ExplicitNone.
349 bool hasNonTrivialObjCLifetime() const {
350 ObjCLifetime lifetime = getObjCLifetime();
351 return (lifetime > OCL_ExplicitNone);
352 }
353
354 /// True if the lifetime is either strong or weak.
355 bool hasStrongOrWeakObjCLifetime() const {
356 ObjCLifetime lifetime = getObjCLifetime();
357 return (lifetime == OCL_Strong || lifetime == OCL_Weak);
358 }
359
360 bool hasAddressSpace() const { return Mask & AddressSpaceMask; }
361 LangAS getAddressSpace() const {
362 return static_cast<LangAS>(Mask >> AddressSpaceShift);
363 }
364 bool hasTargetSpecificAddressSpace() const {
365 return isTargetAddressSpace(getAddressSpace());
366 }
367 /// Get the address space attribute value to be printed by diagnostics.
368 unsigned getAddressSpaceAttributePrintValue() const {
369 auto Addr = getAddressSpace();
370 // This function is not supposed to be used with language specific
371 // address spaces. If that happens, the diagnostic message should consider
372 // printing the QualType instead of the address space value.
373 assert(Addr == LangAS::Default || hasTargetSpecificAddressSpace())(static_cast <bool> (Addr == LangAS::Default || hasTargetSpecificAddressSpace
()) ? void (0) : __assert_fail ("Addr == LangAS::Default || hasTargetSpecificAddressSpace()"
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 373, __extension__ __PRETTY_FUNCTION__))
;
374 if (Addr != LangAS::Default)
375 return toTargetAddressSpace(Addr);
376 // TODO: The diagnostic messages where Addr may be 0 should be fixed
377 // since it cannot differentiate the situation where 0 denotes the default
378 // address space or user specified __attribute__((address_space(0))).
379 return 0;
380 }
381 void setAddressSpace(LangAS space) {
382 assert((unsigned)space <= MaxAddressSpace)(static_cast <bool> ((unsigned)space <= MaxAddressSpace
) ? void (0) : __assert_fail ("(unsigned)space <= MaxAddressSpace"
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 382, __extension__ __PRETTY_FUNCTION__))
;
383 Mask = (Mask & ~AddressSpaceMask)
384 | (((uint32_t) space) << AddressSpaceShift);
385 }
386 void removeAddressSpace() { setAddressSpace(LangAS::Default); }
387 void addAddressSpace(LangAS space) {
388 assert(space != LangAS::Default)(static_cast <bool> (space != LangAS::Default) ? void (
0) : __assert_fail ("space != LangAS::Default", "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 388, __extension__ __PRETTY_FUNCTION__))
;
389 setAddressSpace(space);
390 }
391
392 // Fast qualifiers are those that can be allocated directly
393 // on a QualType object.
394 bool hasFastQualifiers() const { return getFastQualifiers(); }
395 unsigned getFastQualifiers() const { return Mask & FastMask; }
396 void setFastQualifiers(unsigned mask) {
397 assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits")(static_cast <bool> (!(mask & ~FastMask) &&
"bitmask contains non-fast qualifier bits") ? void (0) : __assert_fail
("!(mask & ~FastMask) && \"bitmask contains non-fast qualifier bits\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 397, __extension__ __PRETTY_FUNCTION__))
;
398 Mask = (Mask & ~FastMask) | mask;
399 }
400 void removeFastQualifiers(unsigned mask) {
401 assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits")(static_cast <bool> (!(mask & ~FastMask) &&
"bitmask contains non-fast qualifier bits") ? void (0) : __assert_fail
("!(mask & ~FastMask) && \"bitmask contains non-fast qualifier bits\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 401, __extension__ __PRETTY_FUNCTION__))
;
402 Mask &= ~mask;
403 }
404 void removeFastQualifiers() {
405 removeFastQualifiers(FastMask);
406 }
407 void addFastQualifiers(unsigned mask) {
408 assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits")(static_cast <bool> (!(mask & ~FastMask) &&
"bitmask contains non-fast qualifier bits") ? void (0) : __assert_fail
("!(mask & ~FastMask) && \"bitmask contains non-fast qualifier bits\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 408, __extension__ __PRETTY_FUNCTION__))
;
409 Mask |= mask;
410 }
411
412 /// Return true if the set contains any qualifiers which require an ExtQuals
413 /// node to be allocated.
414 bool hasNonFastQualifiers() const { return Mask & ~FastMask; }
415 Qualifiers getNonFastQualifiers() const {
416 Qualifiers Quals = *this;
417 Quals.setFastQualifiers(0);
418 return Quals;
419 }
420
421 /// Return true if the set contains any qualifiers.
422 bool hasQualifiers() const { return Mask; }
423 bool empty() const { return !Mask; }
424
425 /// Add the qualifiers from the given set to this set.
426 void addQualifiers(Qualifiers Q) {
427 // If the other set doesn't have any non-boolean qualifiers, just
428 // bit-or it in.
429 if (!(Q.Mask & ~CVRMask))
430 Mask |= Q.Mask;
431 else {
432 Mask |= (Q.Mask & CVRMask);
433 if (Q.hasAddressSpace())
434 addAddressSpace(Q.getAddressSpace());
435 if (Q.hasObjCGCAttr())
436 addObjCGCAttr(Q.getObjCGCAttr());
437 if (Q.hasObjCLifetime())
438 addObjCLifetime(Q.getObjCLifetime());
439 }
440 }
441
442 /// Remove the qualifiers from the given set from this set.
443 void removeQualifiers(Qualifiers Q) {
444 // If the other set doesn't have any non-boolean qualifiers, just
445 // bit-and the inverse in.
446 if (!(Q.Mask & ~CVRMask))
447 Mask &= ~Q.Mask;
448 else {
449 Mask &= ~(Q.Mask & CVRMask);
450 if (getObjCGCAttr() == Q.getObjCGCAttr())
451 removeObjCGCAttr();
452 if (getObjCLifetime() == Q.getObjCLifetime())
453 removeObjCLifetime();
454 if (getAddressSpace() == Q.getAddressSpace())
455 removeAddressSpace();
456 }
457 }
458
459 /// Add the qualifiers from the given set to this set, given that
460 /// they don't conflict.
461 void addConsistentQualifiers(Qualifiers qs) {
462 assert(getAddressSpace() == qs.getAddressSpace() ||(static_cast <bool> (getAddressSpace() == qs.getAddressSpace
() || !hasAddressSpace() || !qs.hasAddressSpace()) ? void (0)
: __assert_fail ("getAddressSpace() == qs.getAddressSpace() || !hasAddressSpace() || !qs.hasAddressSpace()"
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 463, __extension__ __PRETTY_FUNCTION__))
463 !hasAddressSpace() || !qs.hasAddressSpace())(static_cast <bool> (getAddressSpace() == qs.getAddressSpace
() || !hasAddressSpace() || !qs.hasAddressSpace()) ? void (0)
: __assert_fail ("getAddressSpace() == qs.getAddressSpace() || !hasAddressSpace() || !qs.hasAddressSpace()"
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 463, __extension__ __PRETTY_FUNCTION__))
;
464 assert(getObjCGCAttr() == qs.getObjCGCAttr() ||(static_cast <bool> (getObjCGCAttr() == qs.getObjCGCAttr
() || !hasObjCGCAttr() || !qs.hasObjCGCAttr()) ? void (0) : __assert_fail
("getObjCGCAttr() == qs.getObjCGCAttr() || !hasObjCGCAttr() || !qs.hasObjCGCAttr()"
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 465, __extension__ __PRETTY_FUNCTION__))
465 !hasObjCGCAttr() || !qs.hasObjCGCAttr())(static_cast <bool> (getObjCGCAttr() == qs.getObjCGCAttr
() || !hasObjCGCAttr() || !qs.hasObjCGCAttr()) ? void (0) : __assert_fail
("getObjCGCAttr() == qs.getObjCGCAttr() || !hasObjCGCAttr() || !qs.hasObjCGCAttr()"
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 465, __extension__ __PRETTY_FUNCTION__))
;
466 assert(getObjCLifetime() == qs.getObjCLifetime() ||(static_cast <bool> (getObjCLifetime() == qs.getObjCLifetime
() || !hasObjCLifetime() || !qs.hasObjCLifetime()) ? void (0)
: __assert_fail ("getObjCLifetime() == qs.getObjCLifetime() || !hasObjCLifetime() || !qs.hasObjCLifetime()"
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 467, __extension__ __PRETTY_FUNCTION__))
467 !hasObjCLifetime() || !qs.hasObjCLifetime())(static_cast <bool> (getObjCLifetime() == qs.getObjCLifetime
() || !hasObjCLifetime() || !qs.hasObjCLifetime()) ? void (0)
: __assert_fail ("getObjCLifetime() == qs.getObjCLifetime() || !hasObjCLifetime() || !qs.hasObjCLifetime()"
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 467, __extension__ __PRETTY_FUNCTION__))
;
468 Mask |= qs.Mask;
469 }
470
471 /// Returns true if address space A is equal to or a superset of B.
472 /// OpenCL v2.0 defines conversion rules (OpenCLC v2.0 s6.5.5) and notion of
473 /// overlapping address spaces.
474 /// CL1.1 or CL1.2:
475 /// every address space is a superset of itself.
476 /// CL2.0 adds:
477 /// __generic is a superset of any address space except for __constant.
478 static bool isAddressSpaceSupersetOf(LangAS A, LangAS B) {
479 // Address spaces must match exactly.
480 return A == B ||
481 // Otherwise in OpenCLC v2.0 s6.5.5: every address space except
482 // for __constant can be used as __generic.
483 (A == LangAS::opencl_generic && B != LangAS::opencl_constant) ||
484 // We also define global_device and global_host address spaces,
485 // to distinguish global pointers allocated on host from pointers
486 // allocated on device, which are a subset of __global.
487 (A == LangAS::opencl_global && (B == LangAS::opencl_global_device ||
488 B == LangAS::opencl_global_host)) ||
489 (A == LangAS::sycl_global && (B == LangAS::sycl_global_device ||
490 B == LangAS::sycl_global_host)) ||
491 // Consider pointer size address spaces to be equivalent to default.
492 ((isPtrSizeAddressSpace(A) || A == LangAS::Default) &&
493 (isPtrSizeAddressSpace(B) || B == LangAS::Default)) ||
494 // Default is a superset of SYCL address spaces.
495 (A == LangAS::Default &&
496 (B == LangAS::sycl_private || B == LangAS::sycl_local ||
497 B == LangAS::sycl_global || B == LangAS::sycl_global_device ||
498 B == LangAS::sycl_global_host)) ||
499 // In HIP device compilation, any cuda address space is allowed
500 // to implicitly cast into the default address space.
501 (A == LangAS::Default &&
502 (B == LangAS::cuda_constant || B == LangAS::cuda_device ||
503 B == LangAS::cuda_shared));
504 }
505
506 /// Returns true if the address space in these qualifiers is equal to or
507 /// a superset of the address space in the argument qualifiers.
508 bool isAddressSpaceSupersetOf(Qualifiers other) const {
509 return isAddressSpaceSupersetOf(getAddressSpace(), other.getAddressSpace());
510 }
511
512 /// Determines if these qualifiers compatibly include another set.
513 /// Generally this answers the question of whether an object with the other
514 /// qualifiers can be safely used as an object with these qualifiers.
515 bool compatiblyIncludes(Qualifiers other) const {
516 return isAddressSpaceSupersetOf(other) &&
517 // ObjC GC qualifiers can match, be added, or be removed, but can't
518 // be changed.
519 (getObjCGCAttr() == other.getObjCGCAttr() || !hasObjCGCAttr() ||
520 !other.hasObjCGCAttr()) &&
521 // ObjC lifetime qualifiers must match exactly.
522 getObjCLifetime() == other.getObjCLifetime() &&
523 // CVR qualifiers may subset.
524 (((Mask & CVRMask) | (other.Mask & CVRMask)) == (Mask & CVRMask)) &&
525 // U qualifier may superset.
526 (!other.hasUnaligned() || hasUnaligned());
527 }
528
529 /// Determines if these qualifiers compatibly include another set of
530 /// qualifiers from the narrow perspective of Objective-C ARC lifetime.
531 ///
532 /// One set of Objective-C lifetime qualifiers compatibly includes the other
533 /// if the lifetime qualifiers match, or if both are non-__weak and the
534 /// including set also contains the 'const' qualifier, or both are non-__weak
535 /// and one is None (which can only happen in non-ARC modes).
536 bool compatiblyIncludesObjCLifetime(Qualifiers other) const {
537 if (getObjCLifetime() == other.getObjCLifetime())
538 return true;
539
540 if (getObjCLifetime() == OCL_Weak || other.getObjCLifetime() == OCL_Weak)
541 return false;
542
543 if (getObjCLifetime() == OCL_None || other.getObjCLifetime() == OCL_None)
544 return true;
545
546 return hasConst();
547 }
548
549 /// Determine whether this set of qualifiers is a strict superset of
550 /// another set of qualifiers, not considering qualifier compatibility.
551 bool isStrictSupersetOf(Qualifiers Other) const;
552
553 bool operator==(Qualifiers Other) const { return Mask == Other.Mask; }
554 bool operator!=(Qualifiers Other) const { return Mask != Other.Mask; }
555
556 explicit operator bool() const { return hasQualifiers(); }
557
558 Qualifiers &operator+=(Qualifiers R) {
559 addQualifiers(R);
560 return *this;
561 }
562
563 // Union two qualifier sets. If an enumerated qualifier appears
564 // in both sets, use the one from the right.
565 friend Qualifiers operator+(Qualifiers L, Qualifiers R) {
566 L += R;
567 return L;
568 }
569
570 Qualifiers &operator-=(Qualifiers R) {
571 removeQualifiers(R);
572 return *this;
573 }
574
575 /// Compute the difference between two qualifier sets.
576 friend Qualifiers operator-(Qualifiers L, Qualifiers R) {
577 L -= R;
578 return L;
579 }
580
581 std::string getAsString() const;
582 std::string getAsString(const PrintingPolicy &Policy) const;
583
584 static std::string getAddrSpaceAsString(LangAS AS);
585
586 bool isEmptyWhenPrinted(const PrintingPolicy &Policy) const;
587 void print(raw_ostream &OS, const PrintingPolicy &Policy,
588 bool appendSpaceIfNonEmpty = false) const;
589
590 void Profile(llvm::FoldingSetNodeID &ID) const {
591 ID.AddInteger(Mask);
592 }
593
594private:
595 // bits: |0 1 2|3|4 .. 5|6 .. 8|9 ... 31|
596 // |C R V|U|GCAttr|Lifetime|AddressSpace|
597 uint32_t Mask = 0;
598
599 static const uint32_t UMask = 0x8;
600 static const uint32_t UShift = 3;
601 static const uint32_t GCAttrMask = 0x30;
602 static const uint32_t GCAttrShift = 4;
603 static const uint32_t LifetimeMask = 0x1C0;
604 static const uint32_t LifetimeShift = 6;
605 static const uint32_t AddressSpaceMask =
606 ~(CVRMask | UMask | GCAttrMask | LifetimeMask);
607 static const uint32_t AddressSpaceShift = 9;
608};
609
610/// A std::pair-like structure for storing a qualified type split
611/// into its local qualifiers and its locally-unqualified type.
612struct SplitQualType {
613 /// The locally-unqualified type.
614 const Type *Ty = nullptr;
615
616 /// The local qualifiers.
617 Qualifiers Quals;
618
619 SplitQualType() = default;
620 SplitQualType(const Type *ty, Qualifiers qs) : Ty(ty), Quals(qs) {}
621
622 SplitQualType getSingleStepDesugaredType() const; // end of this file
623
624 // Make std::tie work.
625 std::pair<const Type *,Qualifiers> asPair() const {
626 return std::pair<const Type *, Qualifiers>(Ty, Quals);
627 }
628
629 friend bool operator==(SplitQualType a, SplitQualType b) {
630 return a.Ty == b.Ty && a.Quals == b.Quals;
631 }
632 friend bool operator!=(SplitQualType a, SplitQualType b) {
633 return a.Ty != b.Ty || a.Quals != b.Quals;
634 }
635};
636
637/// The kind of type we are substituting Objective-C type arguments into.
638///
639/// The kind of substitution affects the replacement of type parameters when
640/// no concrete type information is provided, e.g., when dealing with an
641/// unspecialized type.
642enum class ObjCSubstitutionContext {
643 /// An ordinary type.
644 Ordinary,
645
646 /// The result type of a method or function.
647 Result,
648
649 /// The parameter type of a method or function.
650 Parameter,
651
652 /// The type of a property.
653 Property,
654
655 /// The superclass of a type.
656 Superclass,
657};
658
659/// A (possibly-)qualified type.
660///
661/// For efficiency, we don't store CV-qualified types as nodes on their
662/// own: instead each reference to a type stores the qualifiers. This
663/// greatly reduces the number of nodes we need to allocate for types (for
664/// example we only need one for 'int', 'const int', 'volatile int',
665/// 'const volatile int', etc).
666///
667/// As an added efficiency bonus, instead of making this a pair, we
668/// just store the two bits we care about in the low bits of the
669/// pointer. To handle the packing/unpacking, we make QualType be a
670/// simple wrapper class that acts like a smart pointer. A third bit
671/// indicates whether there are extended qualifiers present, in which
672/// case the pointer points to a special structure.
673class QualType {
674 friend class QualifierCollector;
675
676 // Thankfully, these are efficiently composable.
677 llvm::PointerIntPair<llvm::PointerUnion<const Type *, const ExtQuals *>,
678 Qualifiers::FastWidth> Value;
679
680 const ExtQuals *getExtQualsUnsafe() const {
681 return Value.getPointer().get<const ExtQuals*>();
682 }
683
684 const Type *getTypePtrUnsafe() const {
685 return Value.getPointer().get<const Type*>();
686 }
687
688 const ExtQualsTypeCommonBase *getCommonPtr() const {
689 assert(!isNull() && "Cannot retrieve a NULL type pointer")(static_cast <bool> (!isNull() && "Cannot retrieve a NULL type pointer"
) ? void (0) : __assert_fail ("!isNull() && \"Cannot retrieve a NULL type pointer\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 689, __extension__ __PRETTY_FUNCTION__))
;
690 auto CommonPtrVal = reinterpret_cast<uintptr_t>(Value.getOpaqueValue());
691 CommonPtrVal &= ~(uintptr_t)((1 << TypeAlignmentInBits) - 1);
692 return reinterpret_cast<ExtQualsTypeCommonBase*>(CommonPtrVal);
693 }
694
695public:
696 QualType() = default;
697 QualType(const Type *Ptr, unsigned Quals) : Value(Ptr, Quals) {}
698 QualType(const ExtQuals *Ptr, unsigned Quals) : Value(Ptr, Quals) {}
699
700 unsigned getLocalFastQualifiers() const { return Value.getInt(); }
701 void setLocalFastQualifiers(unsigned Quals) { Value.setInt(Quals); }
702
703 /// Retrieves a pointer to the underlying (unqualified) type.
704 ///
705 /// This function requires that the type not be NULL. If the type might be
706 /// NULL, use the (slightly less efficient) \c getTypePtrOrNull().
707 const Type *getTypePtr() const;
708
709 const Type *getTypePtrOrNull() const;
710
711 /// Retrieves a pointer to the name of the base type.
712 const IdentifierInfo *getBaseTypeIdentifier() const;
713
714 /// Divides a QualType into its unqualified type and a set of local
715 /// qualifiers.
716 SplitQualType split() const;
717
718 void *getAsOpaquePtr() const { return Value.getOpaqueValue(); }
719
720 static QualType getFromOpaquePtr(const void *Ptr) {
721 QualType T;
722 T.Value.setFromOpaqueValue(const_cast<void*>(Ptr));
723 return T;
724 }
725
726 const Type &operator*() const {
727 return *getTypePtr();
728 }
729
730 const Type *operator->() const {
731 return getTypePtr();
732 }
733
734 bool isCanonical() const;
735 bool isCanonicalAsParam() const;
736
737 /// Return true if this QualType doesn't point to a type yet.
738 bool isNull() const {
739 return Value.getPointer().isNull();
740 }
741
742 /// Determine whether this particular QualType instance has the
743 /// "const" qualifier set, without looking through typedefs that may have
744 /// added "const" at a different level.
745 bool isLocalConstQualified() const {
746 return (getLocalFastQualifiers() & Qualifiers::Const);
747 }
748
749 /// Determine whether this type is const-qualified.
750 bool isConstQualified() const;
751
752 /// Determine whether this particular QualType instance has the
753 /// "restrict" qualifier set, without looking through typedefs that may have
754 /// added "restrict" at a different level.
755 bool isLocalRestrictQualified() const {
756 return (getLocalFastQualifiers() & Qualifiers::Restrict);
757 }
758
759 /// Determine whether this type is restrict-qualified.
760 bool isRestrictQualified() const;
761
762 /// Determine whether this particular QualType instance has the
763 /// "volatile" qualifier set, without looking through typedefs that may have
764 /// added "volatile" at a different level.
765 bool isLocalVolatileQualified() const {
766 return (getLocalFastQualifiers() & Qualifiers::Volatile);
767 }
768
769 /// Determine whether this type is volatile-qualified.
770 bool isVolatileQualified() const;
771
772 /// Determine whether this particular QualType instance has any
773 /// qualifiers, without looking through any typedefs that might add
774 /// qualifiers at a different level.
775 bool hasLocalQualifiers() const {
776 return getLocalFastQualifiers() || hasLocalNonFastQualifiers();
777 }
778
779 /// Determine whether this type has any qualifiers.
780 bool hasQualifiers() const;
781
782 /// Determine whether this particular QualType instance has any
783 /// "non-fast" qualifiers, e.g., those that are stored in an ExtQualType
784 /// instance.
785 bool hasLocalNonFastQualifiers() const {
786 return Value.getPointer().is<const ExtQuals*>();
787 }
788
789 /// Retrieve the set of qualifiers local to this particular QualType
790 /// instance, not including any qualifiers acquired through typedefs or
791 /// other sugar.
792 Qualifiers getLocalQualifiers() const;
793
794 /// Retrieve the set of qualifiers applied to this type.
795 Qualifiers getQualifiers() const;
796
797 /// Retrieve the set of CVR (const-volatile-restrict) qualifiers
798 /// local to this particular QualType instance, not including any qualifiers
799 /// acquired through typedefs or other sugar.
800 unsigned getLocalCVRQualifiers() const {
801 return getLocalFastQualifiers();
802 }
803
804 /// Retrieve the set of CVR (const-volatile-restrict) qualifiers
805 /// applied to this type.
806 unsigned getCVRQualifiers() const;
807
808 bool isConstant(const ASTContext& Ctx) const {
809 return QualType::isConstant(*this, Ctx);
810 }
811
812 /// Determine whether this is a Plain Old Data (POD) type (C++ 3.9p10).
813 bool isPODType(const ASTContext &Context) const;
814
815 /// Return true if this is a POD type according to the rules of the C++98
816 /// standard, regardless of the current compilation's language.
817 bool isCXX98PODType(const ASTContext &Context) const;
818
819 /// Return true if this is a POD type according to the more relaxed rules
820 /// of the C++11 standard, regardless of the current compilation's language.
821 /// (C++0x [basic.types]p9). Note that, unlike
822 /// CXXRecordDecl::isCXX11StandardLayout, this takes DRs into account.
823 bool isCXX11PODType(const ASTContext &Context) const;
824
825 /// Return true if this is a trivial type per (C++0x [basic.types]p9)
826 bool isTrivialType(const ASTContext &Context) const;
827
828 /// Return true if this is a trivially copyable type (C++0x [basic.types]p9)
829 bool isTriviallyCopyableType(const ASTContext &Context) const;
830
831
832 /// Returns true if it is a class and it might be dynamic.
833 bool mayBeDynamicClass() const;
834
835 /// Returns true if it is not a class or if the class might not be dynamic.
836 bool mayBeNotDynamicClass() const;
837
838 // Don't promise in the API that anything besides 'const' can be
839 // easily added.
840
841 /// Add the `const` type qualifier to this QualType.
842 void addConst() {
843 addFastQualifiers(Qualifiers::Const);
844 }
845 QualType withConst() const {
846 return withFastQualifiers(Qualifiers::Const);
847 }
848
849 /// Add the `volatile` type qualifier to this QualType.
850 void addVolatile() {
851 addFastQualifiers(Qualifiers::Volatile);
852 }
853 QualType withVolatile() const {
854 return withFastQualifiers(Qualifiers::Volatile);
855 }
856
857 /// Add the `restrict` qualifier to this QualType.
858 void addRestrict() {
859 addFastQualifiers(Qualifiers::Restrict);
860 }
861 QualType withRestrict() const {
862 return withFastQualifiers(Qualifiers::Restrict);
863 }
864
865 QualType withCVRQualifiers(unsigned CVR) const {
866 return withFastQualifiers(CVR);
867 }
868
869 void addFastQualifiers(unsigned TQs) {
870 assert(!(TQs & ~Qualifiers::FastMask)(static_cast <bool> (!(TQs & ~Qualifiers::FastMask)
&& "non-fast qualifier bits set in mask!") ? void (0
) : __assert_fail ("!(TQs & ~Qualifiers::FastMask) && \"non-fast qualifier bits set in mask!\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 871, __extension__ __PRETTY_FUNCTION__))
871 && "non-fast qualifier bits set in mask!")(static_cast <bool> (!(TQs & ~Qualifiers::FastMask)
&& "non-fast qualifier bits set in mask!") ? void (0
) : __assert_fail ("!(TQs & ~Qualifiers::FastMask) && \"non-fast qualifier bits set in mask!\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 871, __extension__ __PRETTY_FUNCTION__))
;
872 Value.setInt(Value.getInt() | TQs);
873 }
874
875 void removeLocalConst();
876 void removeLocalVolatile();
877 void removeLocalRestrict();
878 void removeLocalCVRQualifiers(unsigned Mask);
879
880 void removeLocalFastQualifiers() { Value.setInt(0); }
881 void removeLocalFastQualifiers(unsigned Mask) {
882 assert(!(Mask & ~Qualifiers::FastMask) && "mask has non-fast qualifiers")(static_cast <bool> (!(Mask & ~Qualifiers::FastMask
) && "mask has non-fast qualifiers") ? void (0) : __assert_fail
("!(Mask & ~Qualifiers::FastMask) && \"mask has non-fast qualifiers\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 882, __extension__ __PRETTY_FUNCTION__))
;
883 Value.setInt(Value.getInt() & ~Mask);
884 }
885
886 // Creates a type with the given qualifiers in addition to any
887 // qualifiers already on this type.
888 QualType withFastQualifiers(unsigned TQs) const {
889 QualType T = *this;
890 T.addFastQualifiers(TQs);
891 return T;
892 }
893
894 // Creates a type with exactly the given fast qualifiers, removing
895 // any existing fast qualifiers.
896 QualType withExactLocalFastQualifiers(unsigned TQs) const {
897 return withoutLocalFastQualifiers().withFastQualifiers(TQs);
898 }
899
900 // Removes fast qualifiers, but leaves any extended qualifiers in place.
901 QualType withoutLocalFastQualifiers() const {
902 QualType T = *this;
903 T.removeLocalFastQualifiers();
904 return T;
905 }
906
907 QualType getCanonicalType() const;
908
909 /// Return this type with all of the instance-specific qualifiers
910 /// removed, but without removing any qualifiers that may have been applied
911 /// through typedefs.
912 QualType getLocalUnqualifiedType() const { return QualType(getTypePtr(), 0); }
913
914 /// Retrieve the unqualified variant of the given type,
915 /// removing as little sugar as possible.
916 ///
917 /// This routine looks through various kinds of sugar to find the
918 /// least-desugared type that is unqualified. For example, given:
919 ///
920 /// \code
921 /// typedef int Integer;
922 /// typedef const Integer CInteger;
923 /// typedef CInteger DifferenceType;
924 /// \endcode
925 ///
926 /// Executing \c getUnqualifiedType() on the type \c DifferenceType will
927 /// desugar until we hit the type \c Integer, which has no qualifiers on it.
928 ///
929 /// The resulting type might still be qualified if it's sugar for an array
930 /// type. To strip qualifiers even from within a sugared array type, use
931 /// ASTContext::getUnqualifiedArrayType.
932 inline QualType getUnqualifiedType() const;
933
934 /// Retrieve the unqualified variant of the given type, removing as little
935 /// sugar as possible.
936 ///
937 /// Like getUnqualifiedType(), but also returns the set of
938 /// qualifiers that were built up.
939 ///
940 /// The resulting type might still be qualified if it's sugar for an array
941 /// type. To strip qualifiers even from within a sugared array type, use
942 /// ASTContext::getUnqualifiedArrayType.
943 inline SplitQualType getSplitUnqualifiedType() const;
944
945 /// Determine whether this type is more qualified than the other
946 /// given type, requiring exact equality for non-CVR qualifiers.
947 bool isMoreQualifiedThan(QualType Other) const;
948
949 /// Determine whether this type is at least as qualified as the other
950 /// given type, requiring exact equality for non-CVR qualifiers.
951 bool isAtLeastAsQualifiedAs(QualType Other) const;
952
953 QualType getNonReferenceType() const;
954
955 /// Determine the type of a (typically non-lvalue) expression with the
956 /// specified result type.
957 ///
958 /// This routine should be used for expressions for which the return type is
959 /// explicitly specified (e.g., in a cast or call) and isn't necessarily
960 /// an lvalue. It removes a top-level reference (since there are no
961 /// expressions of reference type) and deletes top-level cvr-qualifiers
962 /// from non-class types (in C++) or all types (in C).
963 QualType getNonLValueExprType(const ASTContext &Context) const;
964
965 /// Remove an outer pack expansion type (if any) from this type. Used as part
966 /// of converting the type of a declaration to the type of an expression that
967 /// references that expression. It's meaningless for an expression to have a
968 /// pack expansion type.
969 QualType getNonPackExpansionType() const;
970
971 /// Return the specified type with any "sugar" removed from
972 /// the type. This takes off typedefs, typeof's etc. If the outer level of
973 /// the type is already concrete, it returns it unmodified. This is similar
974 /// to getting the canonical type, but it doesn't remove *all* typedefs. For
975 /// example, it returns "T*" as "T*", (not as "int*"), because the pointer is
976 /// concrete.
977 ///
978 /// Qualifiers are left in place.
979 QualType getDesugaredType(const ASTContext &Context) const {
980 return getDesugaredType(*this, Context);
981 }
982
983 SplitQualType getSplitDesugaredType() const {
984 return getSplitDesugaredType(*this);
985 }
986
987 /// Return the specified type with one level of "sugar" removed from
988 /// the type.
989 ///
990 /// This routine takes off the first typedef, typeof, etc. If the outer level
991 /// of the type is already concrete, it returns it unmodified.
992 QualType getSingleStepDesugaredType(const ASTContext &Context) const {
993 return getSingleStepDesugaredTypeImpl(*this, Context);
994 }
995
996 /// Returns the specified type after dropping any
997 /// outer-level parentheses.
998 QualType IgnoreParens() const {
999 if (isa<ParenType>(*this))
1000 return QualType::IgnoreParens(*this);
1001 return *this;
1002 }
1003
1004 /// Indicate whether the specified types and qualifiers are identical.
1005 friend bool operator==(const QualType &LHS, const QualType &RHS) {
1006 return LHS.Value == RHS.Value;
1007 }
1008 friend bool operator!=(const QualType &LHS, const QualType &RHS) {
1009 return LHS.Value != RHS.Value;
1010 }
1011 friend bool operator<(const QualType &LHS, const QualType &RHS) {
1012 return LHS.Value < RHS.Value;
1013 }
1014
1015 static std::string getAsString(SplitQualType split,
1016 const PrintingPolicy &Policy) {
1017 return getAsString(split.Ty, split.Quals, Policy);
1018 }
1019 static std::string getAsString(const Type *ty, Qualifiers qs,
1020 const PrintingPolicy &Policy);
1021
1022 std::string getAsString() const;
1023 std::string getAsString(const PrintingPolicy &Policy) const;
1024
1025 void print(raw_ostream &OS, const PrintingPolicy &Policy,
1026 const Twine &PlaceHolder = Twine(),
1027 unsigned Indentation = 0) const;
1028
1029 static void print(SplitQualType split, raw_ostream &OS,
1030 const PrintingPolicy &policy, const Twine &PlaceHolder,
1031 unsigned Indentation = 0) {
1032 return print(split.Ty, split.Quals, OS, policy, PlaceHolder, Indentation);
1033 }
1034
1035 static void print(const Type *ty, Qualifiers qs,
1036 raw_ostream &OS, const PrintingPolicy &policy,
1037 const Twine &PlaceHolder,
1038 unsigned Indentation = 0);
1039
1040 void getAsStringInternal(std::string &Str,
1041 const PrintingPolicy &Policy) const;
1042
1043 static void getAsStringInternal(SplitQualType split, std::string &out,
1044 const PrintingPolicy &policy) {
1045 return getAsStringInternal(split.Ty, split.Quals, out, policy);
1046 }
1047
1048 static void getAsStringInternal(const Type *ty, Qualifiers qs,
1049 std::string &out,
1050 const PrintingPolicy &policy);
1051
1052 class StreamedQualTypeHelper {
1053 const QualType &T;
1054 const PrintingPolicy &Policy;
1055 const Twine &PlaceHolder;
1056 unsigned Indentation;
1057
1058 public:
1059 StreamedQualTypeHelper(const QualType &T, const PrintingPolicy &Policy,
1060 const Twine &PlaceHolder, unsigned Indentation)
1061 : T(T), Policy(Policy), PlaceHolder(PlaceHolder),
1062 Indentation(Indentation) {}
1063
1064 friend raw_ostream &operator<<(raw_ostream &OS,
1065 const StreamedQualTypeHelper &SQT) {
1066 SQT.T.print(OS, SQT.Policy, SQT.PlaceHolder, SQT.Indentation);
1067 return OS;
1068 }
1069 };
1070
1071 StreamedQualTypeHelper stream(const PrintingPolicy &Policy,
1072 const Twine &PlaceHolder = Twine(),
1073 unsigned Indentation = 0) const {
1074 return StreamedQualTypeHelper(*this, Policy, PlaceHolder, Indentation);
1075 }
1076
1077 void dump(const char *s) const;
1078 void dump() const;
1079 void dump(llvm::raw_ostream &OS, const ASTContext &Context) const;
1080
1081 void Profile(llvm::FoldingSetNodeID &ID) const {
1082 ID.AddPointer(getAsOpaquePtr());
1083 }
1084
1085 /// Check if this type has any address space qualifier.
1086 inline bool hasAddressSpace() const;
1087
1088 /// Return the address space of this type.
1089 inline LangAS getAddressSpace() const;
1090
1091 /// Returns true if address space qualifiers overlap with T address space
1092 /// qualifiers.
1093 /// OpenCL C defines conversion rules for pointers to different address spaces
1094 /// and notion of overlapping address spaces.
1095 /// CL1.1 or CL1.2:
1096 /// address spaces overlap iff they are they same.
1097 /// OpenCL C v2.0 s6.5.5 adds:
1098 /// __generic overlaps with any address space except for __constant.
1099 bool isAddressSpaceOverlapping(QualType T) const {
1100 Qualifiers Q = getQualifiers();
1101 Qualifiers TQ = T.getQualifiers();
1102 // Address spaces overlap if at least one of them is a superset of another
1103 return Q.isAddressSpaceSupersetOf(TQ) || TQ.isAddressSpaceSupersetOf(Q);
1104 }
1105
1106 /// Returns gc attribute of this type.
1107 inline Qualifiers::GC getObjCGCAttr() const;
1108
1109 /// true when Type is objc's weak.
1110 bool isObjCGCWeak() const {
1111 return getObjCGCAttr() == Qualifiers::Weak;
1112 }
1113
1114 /// true when Type is objc's strong.
1115 bool isObjCGCStrong() const {
1116 return getObjCGCAttr() == Qualifiers::Strong;
1117 }
1118
1119 /// Returns lifetime attribute of this type.
1120 Qualifiers::ObjCLifetime getObjCLifetime() const {
1121 return getQualifiers().getObjCLifetime();
1122 }
1123
1124 bool hasNonTrivialObjCLifetime() const {
1125 return getQualifiers().hasNonTrivialObjCLifetime();
1126 }
1127
1128 bool hasStrongOrWeakObjCLifetime() const {
1129 return getQualifiers().hasStrongOrWeakObjCLifetime();
1130 }
1131
1132 // true when Type is objc's weak and weak is enabled but ARC isn't.
1133 bool isNonWeakInMRRWithObjCWeak(const ASTContext &Context) const;
1134
1135 enum PrimitiveDefaultInitializeKind {
1136 /// The type does not fall into any of the following categories. Note that
1137 /// this case is zero-valued so that values of this enum can be used as a
1138 /// boolean condition for non-triviality.
1139 PDIK_Trivial,
1140
1141 /// The type is an Objective-C retainable pointer type that is qualified
1142 /// with the ARC __strong qualifier.
1143 PDIK_ARCStrong,
1144
1145 /// The type is an Objective-C retainable pointer type that is qualified
1146 /// with the ARC __weak qualifier.
1147 PDIK_ARCWeak,
1148
1149 /// The type is a struct containing a field whose type is not PCK_Trivial.
1150 PDIK_Struct
1151 };
1152
1153 /// Functions to query basic properties of non-trivial C struct types.
1154
1155 /// Check if this is a non-trivial type that would cause a C struct
1156 /// transitively containing this type to be non-trivial to default initialize
1157 /// and return the kind.
1158 PrimitiveDefaultInitializeKind
1159 isNonTrivialToPrimitiveDefaultInitialize() const;
1160
1161 enum PrimitiveCopyKind {
1162 /// The type does not fall into any of the following categories. Note that
1163 /// this case is zero-valued so that values of this enum can be used as a
1164 /// boolean condition for non-triviality.
1165 PCK_Trivial,
1166
1167 /// The type would be trivial except that it is volatile-qualified. Types
1168 /// that fall into one of the other non-trivial cases may additionally be
1169 /// volatile-qualified.
1170 PCK_VolatileTrivial,
1171
1172 /// The type is an Objective-C retainable pointer type that is qualified
1173 /// with the ARC __strong qualifier.
1174 PCK_ARCStrong,
1175
1176 /// The type is an Objective-C retainable pointer type that is qualified
1177 /// with the ARC __weak qualifier.
1178 PCK_ARCWeak,
1179
1180 /// The type is a struct containing a field whose type is neither
1181 /// PCK_Trivial nor PCK_VolatileTrivial.
1182 /// Note that a C++ struct type does not necessarily match this; C++ copying
1183 /// semantics are too complex to express here, in part because they depend
1184 /// on the exact constructor or assignment operator that is chosen by
1185 /// overload resolution to do the copy.
1186 PCK_Struct
1187 };
1188
1189 /// Check if this is a non-trivial type that would cause a C struct
1190 /// transitively containing this type to be non-trivial to copy and return the
1191 /// kind.
1192 PrimitiveCopyKind isNonTrivialToPrimitiveCopy() const;
1193
1194 /// Check if this is a non-trivial type that would cause a C struct
1195 /// transitively containing this type to be non-trivial to destructively
1196 /// move and return the kind. Destructive move in this context is a C++-style
1197 /// move in which the source object is placed in a valid but unspecified state
1198 /// after it is moved, as opposed to a truly destructive move in which the
1199 /// source object is placed in an uninitialized state.
1200 PrimitiveCopyKind isNonTrivialToPrimitiveDestructiveMove() const;
1201
1202 enum DestructionKind {
1203 DK_none,
1204 DK_cxx_destructor,
1205 DK_objc_strong_lifetime,
1206 DK_objc_weak_lifetime,
1207 DK_nontrivial_c_struct
1208 };
1209
1210 /// Returns a nonzero value if objects of this type require
1211 /// non-trivial work to clean up after. Non-zero because it's
1212 /// conceivable that qualifiers (objc_gc(weak)?) could make
1213 /// something require destruction.
1214 DestructionKind isDestructedType() const {
1215 return isDestructedTypeImpl(*this);
1216 }
1217
1218 /// Check if this is or contains a C union that is non-trivial to
1219 /// default-initialize, which is a union that has a member that is non-trivial
1220 /// to default-initialize. If this returns true,
1221 /// isNonTrivialToPrimitiveDefaultInitialize returns PDIK_Struct.
1222 bool hasNonTrivialToPrimitiveDefaultInitializeCUnion() const;
1223
1224 /// Check if this is or contains a C union that is non-trivial to destruct,
1225 /// which is a union that has a member that is non-trivial to destruct. If
1226 /// this returns true, isDestructedType returns DK_nontrivial_c_struct.
1227 bool hasNonTrivialToPrimitiveDestructCUnion() const;
1228
1229 /// Check if this is or contains a C union that is non-trivial to copy, which
1230 /// is a union that has a member that is non-trivial to copy. If this returns
1231 /// true, isNonTrivialToPrimitiveCopy returns PCK_Struct.
1232 bool hasNonTrivialToPrimitiveCopyCUnion() const;
1233
1234 /// Determine whether expressions of the given type are forbidden
1235 /// from being lvalues in C.
1236 ///
1237 /// The expression types that are forbidden to be lvalues are:
1238 /// - 'void', but not qualified void
1239 /// - function types
1240 ///
1241 /// The exact rule here is C99 6.3.2.1:
1242 /// An lvalue is an expression with an object type or an incomplete
1243 /// type other than void.
1244 bool isCForbiddenLValueType() const;
1245
1246 /// Substitute type arguments for the Objective-C type parameters used in the
1247 /// subject type.
1248 ///
1249 /// \param ctx ASTContext in which the type exists.
1250 ///
1251 /// \param typeArgs The type arguments that will be substituted for the
1252 /// Objective-C type parameters in the subject type, which are generally
1253 /// computed via \c Type::getObjCSubstitutions. If empty, the type
1254 /// parameters will be replaced with their bounds or id/Class, as appropriate
1255 /// for the context.
1256 ///
1257 /// \param context The context in which the subject type was written.
1258 ///
1259 /// \returns the resulting type.
1260 QualType substObjCTypeArgs(ASTContext &ctx,
1261 ArrayRef<QualType> typeArgs,
1262 ObjCSubstitutionContext context) const;
1263
1264 /// Substitute type arguments from an object type for the Objective-C type
1265 /// parameters used in the subject type.
1266 ///
1267 /// This operation combines the computation of type arguments for
1268 /// substitution (\c Type::getObjCSubstitutions) with the actual process of
1269 /// substitution (\c QualType::substObjCTypeArgs) for the convenience of
1270 /// callers that need to perform a single substitution in isolation.
1271 ///
1272 /// \param objectType The type of the object whose member type we're
1273 /// substituting into. For example, this might be the receiver of a message
1274 /// or the base of a property access.
1275 ///
1276 /// \param dc The declaration context from which the subject type was
1277 /// retrieved, which indicates (for example) which type parameters should
1278 /// be substituted.
1279 ///
1280 /// \param context The context in which the subject type was written.
1281 ///
1282 /// \returns the subject type after replacing all of the Objective-C type
1283 /// parameters with their corresponding arguments.
1284 QualType substObjCMemberType(QualType objectType,
1285 const DeclContext *dc,
1286 ObjCSubstitutionContext context) const;
1287
1288 /// Strip Objective-C "__kindof" types from the given type.
1289 QualType stripObjCKindOfType(const ASTContext &ctx) const;
1290
1291 /// Remove all qualifiers including _Atomic.
1292 QualType getAtomicUnqualifiedType() const;
1293
1294private:
1295 // These methods are implemented in a separate translation unit;
1296 // "static"-ize them to avoid creating temporary QualTypes in the
1297 // caller.
1298 static bool isConstant(QualType T, const ASTContext& Ctx);
1299 static QualType getDesugaredType(QualType T, const ASTContext &Context);
1300 static SplitQualType getSplitDesugaredType(QualType T);
1301 static SplitQualType getSplitUnqualifiedTypeImpl(QualType type);
1302 static QualType getSingleStepDesugaredTypeImpl(QualType type,
1303 const ASTContext &C);
1304 static QualType IgnoreParens(QualType T);
1305 static DestructionKind isDestructedTypeImpl(QualType type);
1306
1307 /// Check if \param RD is or contains a non-trivial C union.
1308 static bool hasNonTrivialToPrimitiveDefaultInitializeCUnion(const RecordDecl *RD);
1309 static bool hasNonTrivialToPrimitiveDestructCUnion(const RecordDecl *RD);
1310 static bool hasNonTrivialToPrimitiveCopyCUnion(const RecordDecl *RD);
1311};
1312
1313} // namespace clang
1314
1315namespace llvm {
1316
1317/// Implement simplify_type for QualType, so that we can dyn_cast from QualType
1318/// to a specific Type class.
1319template<> struct simplify_type< ::clang::QualType> {
1320 using SimpleType = const ::clang::Type *;
1321
1322 static SimpleType getSimplifiedValue(::clang::QualType Val) {
1323 return Val.getTypePtr();
1324 }
1325};
1326
1327// Teach SmallPtrSet that QualType is "basically a pointer".
1328template<>
1329struct PointerLikeTypeTraits<clang::QualType> {
1330 static inline void *getAsVoidPointer(clang::QualType P) {
1331 return P.getAsOpaquePtr();
1332 }
1333
1334 static inline clang::QualType getFromVoidPointer(void *P) {
1335 return clang::QualType::getFromOpaquePtr(P);
1336 }
1337
1338 // Various qualifiers go in low bits.
1339 static constexpr int NumLowBitsAvailable = 0;
1340};
1341
1342} // namespace llvm
1343
1344namespace clang {
1345
1346/// Base class that is common to both the \c ExtQuals and \c Type
1347/// classes, which allows \c QualType to access the common fields between the
1348/// two.
1349class ExtQualsTypeCommonBase {
1350 friend class ExtQuals;
1351 friend class QualType;
1352 friend class Type;
1353
1354 /// The "base" type of an extended qualifiers type (\c ExtQuals) or
1355 /// a self-referential pointer (for \c Type).
1356 ///
1357 /// This pointer allows an efficient mapping from a QualType to its
1358 /// underlying type pointer.
1359 const Type *const BaseType;
1360
1361 /// The canonical type of this type. A QualType.
1362 QualType CanonicalType;
1363
1364 ExtQualsTypeCommonBase(const Type *baseType, QualType canon)
1365 : BaseType(baseType), CanonicalType(canon) {}
1366};
1367
1368/// We can encode up to four bits in the low bits of a
1369/// type pointer, but there are many more type qualifiers that we want
1370/// to be able to apply to an arbitrary type. Therefore we have this
1371/// struct, intended to be heap-allocated and used by QualType to
1372/// store qualifiers.
1373///
1374/// The current design tags the 'const', 'restrict', and 'volatile' qualifiers
1375/// in three low bits on the QualType pointer; a fourth bit records whether
1376/// the pointer is an ExtQuals node. The extended qualifiers (address spaces,
1377/// Objective-C GC attributes) are much more rare.
1378class ExtQuals : public ExtQualsTypeCommonBase, public llvm::FoldingSetNode {
1379 // NOTE: changing the fast qualifiers should be straightforward as
1380 // long as you don't make 'const' non-fast.
1381 // 1. Qualifiers:
1382 // a) Modify the bitmasks (Qualifiers::TQ and DeclSpec::TQ).
1383 // Fast qualifiers must occupy the low-order bits.
1384 // b) Update Qualifiers::FastWidth and FastMask.
1385 // 2. QualType:
1386 // a) Update is{Volatile,Restrict}Qualified(), defined inline.
1387 // b) Update remove{Volatile,Restrict}, defined near the end of
1388 // this header.
1389 // 3. ASTContext:
1390 // a) Update get{Volatile,Restrict}Type.
1391
1392 /// The immutable set of qualifiers applied by this node. Always contains
1393 /// extended qualifiers.
1394 Qualifiers Quals;
1395
1396 ExtQuals *this_() { return this; }
1397
1398public:
1399 ExtQuals(const Type *baseType, QualType canon, Qualifiers quals)
1400 : ExtQualsTypeCommonBase(baseType,
1401 canon.isNull() ? QualType(this_(), 0) : canon),
1402 Quals(quals) {
1403 assert(Quals.hasNonFastQualifiers()(static_cast <bool> (Quals.hasNonFastQualifiers() &&
"ExtQuals created with no fast qualifiers") ? void (0) : __assert_fail
("Quals.hasNonFastQualifiers() && \"ExtQuals created with no fast qualifiers\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 1404, __extension__ __PRETTY_FUNCTION__))
1404 && "ExtQuals created with no fast qualifiers")(static_cast <bool> (Quals.hasNonFastQualifiers() &&
"ExtQuals created with no fast qualifiers") ? void (0) : __assert_fail
("Quals.hasNonFastQualifiers() && \"ExtQuals created with no fast qualifiers\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 1404, __extension__ __PRETTY_FUNCTION__))
;
1405 assert(!Quals.hasFastQualifiers()(static_cast <bool> (!Quals.hasFastQualifiers() &&
"ExtQuals created with fast qualifiers") ? void (0) : __assert_fail
("!Quals.hasFastQualifiers() && \"ExtQuals created with fast qualifiers\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 1406, __extension__ __PRETTY_FUNCTION__))
1406 && "ExtQuals created with fast qualifiers")(static_cast <bool> (!Quals.hasFastQualifiers() &&
"ExtQuals created with fast qualifiers") ? void (0) : __assert_fail
("!Quals.hasFastQualifiers() && \"ExtQuals created with fast qualifiers\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 1406, __extension__ __PRETTY_FUNCTION__))
;
1407 }
1408
1409 Qualifiers getQualifiers() const { return Quals; }
1410
1411 bool hasObjCGCAttr() const { return Quals.hasObjCGCAttr(); }
1412 Qualifiers::GC getObjCGCAttr() const { return Quals.getObjCGCAttr(); }
1413
1414 bool hasObjCLifetime() const { return Quals.hasObjCLifetime(); }
1415 Qualifiers::ObjCLifetime getObjCLifetime() const {
1416 return Quals.getObjCLifetime();
1417 }
1418
1419 bool hasAddressSpace() const { return Quals.hasAddressSpace(); }
1420 LangAS getAddressSpace() const { return Quals.getAddressSpace(); }
1421
1422 const Type *getBaseType() const { return BaseType; }
1423
1424public:
1425 void Profile(llvm::FoldingSetNodeID &ID) const {
1426 Profile(ID, getBaseType(), Quals);
1427 }
1428
1429 static void Profile(llvm::FoldingSetNodeID &ID,
1430 const Type *BaseType,
1431 Qualifiers Quals) {
1432 assert(!Quals.hasFastQualifiers() && "fast qualifiers in ExtQuals hash!")(static_cast <bool> (!Quals.hasFastQualifiers() &&
"fast qualifiers in ExtQuals hash!") ? void (0) : __assert_fail
("!Quals.hasFastQualifiers() && \"fast qualifiers in ExtQuals hash!\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 1432, __extension__ __PRETTY_FUNCTION__))
;
1433 ID.AddPointer(BaseType);
1434 Quals.Profile(ID);
1435 }
1436};
1437
1438/// The kind of C++11 ref-qualifier associated with a function type.
1439/// This determines whether a member function's "this" object can be an
1440/// lvalue, rvalue, or neither.
1441enum RefQualifierKind {
1442 /// No ref-qualifier was provided.
1443 RQ_None = 0,
1444
1445 /// An lvalue ref-qualifier was provided (\c &).
1446 RQ_LValue,
1447
1448 /// An rvalue ref-qualifier was provided (\c &&).
1449 RQ_RValue
1450};
1451
1452/// Which keyword(s) were used to create an AutoType.
1453enum class AutoTypeKeyword {
1454 /// auto
1455 Auto,
1456
1457 /// decltype(auto)
1458 DecltypeAuto,
1459
1460 /// __auto_type (GNU extension)
1461 GNUAutoType
1462};
1463
1464/// The base class of the type hierarchy.
1465///
1466/// A central concept with types is that each type always has a canonical
1467/// type. A canonical type is the type with any typedef names stripped out
1468/// of it or the types it references. For example, consider:
1469///
1470/// typedef int foo;
1471/// typedef foo* bar;
1472/// 'int *' 'foo *' 'bar'
1473///
1474/// There will be a Type object created for 'int'. Since int is canonical, its
1475/// CanonicalType pointer points to itself. There is also a Type for 'foo' (a
1476/// TypedefType). Its CanonicalType pointer points to the 'int' Type. Next
1477/// there is a PointerType that represents 'int*', which, like 'int', is
1478/// canonical. Finally, there is a PointerType type for 'foo*' whose canonical
1479/// type is 'int*', and there is a TypedefType for 'bar', whose canonical type
1480/// is also 'int*'.
1481///
1482/// Non-canonical types are useful for emitting diagnostics, without losing
1483/// information about typedefs being used. Canonical types are useful for type
1484/// comparisons (they allow by-pointer equality tests) and useful for reasoning
1485/// about whether something has a particular form (e.g. is a function type),
1486/// because they implicitly, recursively, strip all typedefs out of a type.
1487///
1488/// Types, once created, are immutable.
1489///
1490class alignas(8) Type : public ExtQualsTypeCommonBase {
1491public:
1492 enum TypeClass {
1493#define TYPE(Class, Base) Class,
1494#define LAST_TYPE(Class) TypeLast = Class
1495#define ABSTRACT_TYPE(Class, Base)
1496#include "clang/AST/TypeNodes.inc"
1497 };
1498
1499private:
1500 /// Bitfields required by the Type class.
1501 class TypeBitfields {
1502 friend class Type;
1503 template <class T> friend class TypePropertyCache;
1504
1505 /// TypeClass bitfield - Enum that specifies what subclass this belongs to.
1506 unsigned TC : 8;
1507
1508 /// Store information on the type dependency.
1509 unsigned Dependence : llvm::BitWidth<TypeDependence>;
1510
1511 /// True if the cache (i.e. the bitfields here starting with
1512 /// 'Cache') is valid.
1513 mutable unsigned CacheValid : 1;
1514
1515 /// Linkage of this type.
1516 mutable unsigned CachedLinkage : 3;
1517
1518 /// Whether this type involves and local or unnamed types.
1519 mutable unsigned CachedLocalOrUnnamed : 1;
1520
1521 /// Whether this type comes from an AST file.
1522 mutable unsigned FromAST : 1;
1523
1524 bool isCacheValid() const {
1525 return CacheValid;
1526 }
1527
1528 Linkage getLinkage() const {
1529 assert(isCacheValid() && "getting linkage from invalid cache")(static_cast <bool> (isCacheValid() && "getting linkage from invalid cache"
) ? void (0) : __assert_fail ("isCacheValid() && \"getting linkage from invalid cache\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 1529, __extension__ __PRETTY_FUNCTION__))
;
1530 return static_cast<Linkage>(CachedLinkage);
1531 }
1532
1533 bool hasLocalOrUnnamedType() const {
1534 assert(isCacheValid() && "getting linkage from invalid cache")(static_cast <bool> (isCacheValid() && "getting linkage from invalid cache"
) ? void (0) : __assert_fail ("isCacheValid() && \"getting linkage from invalid cache\""
, "/build/llvm-toolchain-snapshot-14~++20210926122410+d23fd8ae8906/clang/include/clang/AST/Type.h"
, 1534, __extension__ __PRETTY_FUNCTION__))
;
1535 return CachedLocalOrUnnamed;
1536 }
1537 };
1538 enum { NumTypeBits = 8 + llvm::BitWidth<TypeDependence> + 6 };
1539
1540protected:
1541 // These classes allow subclasses to somewhat cleanly pack bitfields
1542 // into Type.
1543
1544 class ArrayTypeBitfields {
1545 friend class ArrayType;
1546
1547 unsigned : NumTypeBits;
1548
1549 /// CVR qualifiers from declarations like
1550 /// 'int X[static restrict 4]'. For function parameters only.
1551 unsigned IndexTypeQuals : 3;
1552
1553 /// Storage class qualifiers from declarations like
1554 /// 'int X[static restrict 4]'. For function parameters only.
1555 /// Actually an ArrayType::ArraySizeModifier.
1556 unsigned SizeModifier : 3;
1557 };
1558
1559 class ConstantArrayTypeBitfields {
1560 friend class ConstantArrayType;
1561
1562 unsigned : NumTypeBits + 3 + 3;
1563
1564 /// Whether we have a stored size expression.
1565 unsigned HasStoredSizeExpr : 1;
1566 };
1567
1568 class BuiltinTypeBitfields {
1569 friend class BuiltinType;
1570
1571 unsigned : NumTypeBits;
1572
1573 /// The kind (BuiltinType::Kind) of builtin type this is.
1574 unsigned Kind : 8;
1575 };
1576
1577 /// FunctionTypeBitfields store various bits belonging to FunctionProtoType.
1578 /// Only common bits are stored here. Additional uncommon bits are stored
1579 /// in a trailing object after FunctionProtoType.
1580 class FunctionTypeBitfields {
1581 friend class FunctionProtoType;
1582 friend class FunctionType;
1583
1584 unsigned : NumTypeBits;
1585
1586 /// Extra information which affects how the function is called, like
1587 /// regparm and the calling convention.
1588 unsigned ExtInfo : 13;
1589
1590 /// The ref-qualifier associated with a \c FunctionProtoType.
1591 ///
1592 /// This is a value of type \c RefQualifierKind.
1593 unsigned RefQualifier : 2;
1594
1595 /// Used only by FunctionProtoType, put here to pack with the
1596 /// other bitfields.
1597 /// The qualifiers are part of FunctionProtoType because...
1598 ///
1599 /// C++ 8.3.5p4: The return type, the parameter type list and the
1600 /// cv-qualifier-seq, [...], are part of the function type.
1601 unsigned FastTypeQuals : Qualifiers::FastWidth;
1602 /// Whether this function has extended Qualifiers.
1603 unsigned HasExtQuals : 1;
1604
1605 /// The number of parameters this function has, not counting '...'.
1606 /// According to [implimits] 8 bits should be enough here but this is
1607 /// somewhat easy to exceed with metaprogramming and so we would like to
1608 /// keep NumParams as wide as reasonably possible.
1609 unsigned NumParams : 16;
1610
1611 /// The type of exception specification this function has.
1612 unsigned ExceptionSpecType : 4;
1613
1614 /// Whether this function has extended parameter information.
1615 unsigned HasExtParameterInfos : 1;
1616
1617 /// Whether the function is variadic.
1618 unsigned Variadic : 1;
1619
1620 /// Whether this function has a trailing return type.
1621 unsigned HasTrailingReturn : 1;
1622 };
1623
1624 class ObjCObjectTypeBitfields {
1625 friend class ObjCObjectType;
1626
1627 unsigned : NumTypeBits;
1628
1629 /// The number of type arguments stored directly on this object type.
1630 unsigned NumTypeArgs : 7;
1631
1632 /// The number of protocols stored directly on this object type.
1633 unsigned NumProtocols : 6;
1634
1635 /// Whether this is a "kindof" type.
1636 unsigned IsKindOf : 1;
1637 };
1638
1639 class ReferenceTypeBitfields {
1640 friend class ReferenceType;
1641
1642 unsigned : NumTypeBits;
1643
1644 /// True if the type was originally spelled with an lvalue sigil.
1645 /// This is never true of rvalue references but can also be false
1646 /// on lvalue references because of C++0x [dcl.typedef]p9,
1647 /// as follows:
1648 ///
1649 /// typedef int &ref; // lvalue, spelled lvalue
1650 /// typedef int &&rvref; // rvalue
1651 /// ref &a; // lvalue, inner ref, spelled lvalue
1652 /// ref &&a; // lvalue, inner ref
1653 /// rvref &a; // lvalue, inner ref, spelled lvalue
1654 /// rvref &&a; // rvalue, inner ref
1655 unsigned SpelledAsLValue : 1;
1656
1657 /// True if the inner type is a reference type. This only happens
1658 /// in non-canonical forms.
1659 unsigned InnerRef : 1;
1660 };
1661
1662 class TypeWithKeywordBitfields {
1663 friend class TypeWithKeyword;
1664
1665 unsigned : NumTypeBits;
1666
1667 /// An ElaboratedTypeKeyword. 8 bits for efficient access.
1668 unsigned Keyword : 8;
1669 };
1670
1671 enum { NumTypeWithKeywordBits = 8 };
1672
1673 class ElaboratedTypeBitfields {
1674 friend class ElaboratedType;
1675
1676 unsigned : NumTypeBits;
1677 unsigned : NumTypeWithKeywordBits;
1678
1679 /// Whether the ElaboratedType has a trailing OwnedTagDecl.
1680 unsigned HasOwnedTagDecl : 1;
1681 };
1682
1683 class VectorTypeBitfields {
1684 friend class VectorType;
1685 friend class DependentVectorType;
1686
1687 unsigned : NumTypeBits;
1688
1689 /// The kind of vector, either a generic vector type or some
1690 /// target-specific vector type such as for AltiVec or Neon.
1691 unsigned VecKind : 3;
1692 /// The number of elements in the vector.
1693 uint32_t NumElements;
1694 };
1695
1696 class AttributedTypeBitfields {
1697 friend class AttributedType;
1698
1699 unsigned : NumTypeBits;
1700
1701 /// An AttributedType::Kind
1702 unsigned AttrKind : 32 - NumTypeBits;
1703 };
1704
1705 class AutoTypeBitfields {
1706 friend class AutoType;
1707
1708 unsigned : NumTypeBits;
1709
1710 /// Was this placeholder type spelled as 'auto', 'decltype(auto)',
1711 /// or '__auto_type'? AutoTypeKeyword value.
1712 unsigned Keyword : 2;
1713
1714 /// The number of template arguments in the type-constraints, which is
1715 /// expected to be able to hold at least 1024 according to [implimits].
1716 /// However as this limit is somewhat easy to hit with template
1717 /// metaprogramming we'd prefer to keep it as large as possible.
1718 /// At the moment it has been left as a non-bitfield since this type
1719 /// safely fits in 64 bits as an unsigned, so there is no reason to
1720 /// introduce the performance impact of a bitfield.
1721 unsigned NumArgs;
1722 };
1723
1724 class SubstTemplateTypeParmPackTypeBitfields {
1725 friend class SubstTemplateTypeParmPackType;
1726
1727 unsigned : NumTypeBits;
1728
1729 /// The number of template arguments in \c Arguments, which is
1730 /// expected to be able to hold at least 1024 according to [implimits].
1731 /// However as this limit is somewhat easy to hit with template
1732 /// metaprogramming we'd prefer to keep it as large as possible.
1733 /// At the moment it has been left as a non-bitfield since this type
1734 /// safely fits in 64 bits as an unsigned, so there is no reason to
1735 /// introduce the performance impact of a bitfield.
1736 unsigned NumArgs;
1737 };
1738
1739 class TemplateSpecializationTypeBitfields {
1740 friend class TemplateSpecializationType;
1741
1742 unsigned : NumTypeBits;
1743
1744 /// Whether this template specialization type is a substituted type alias.
1745 unsigned TypeAlias : 1;
1746
1747 /// The number of template arguments named in this class template
1748 /// specialization, which is expected to be able to hold at least 1024
1749 /// according to [implimits]. However, as this limit is somewhat easy to
1750 /// hit with template metaprogramming we'd prefer to keep it as large
1751 /// as possible. At the moment it has been left as a non-bitfield since
1752 /// this type safely fits in 64 bits as an unsigned, so there is no reason
1753 /// to introduce the performance impact of a bitfield.
1754 unsigned NumArgs;
1755 };
1756
1757 class DependentTemplateSpecializationTypeBitfields {
1758 friend class DependentTemplateSpecializationType;
1759
1760 unsigned : NumTypeBits;
1761 unsigned : NumTypeWithKeywordBits;
1762
1763 /// The number of template arguments named in this class template
1764 /// specialization, which is expected to be able to hold at least 1024
1765 /// according to [implimits]. However, as this limit is somewhat easy to
1766 /// hit with template metaprogramming we'd prefer to keep it as large
1767 /// as possible. At the moment it has been left as a non-bitfield since
1768 /// this type safely fits in 64 bits as an unsigned, so there is no reason
1769 /// to introduce the performance impact of a bitfield.
1770 unsigned NumArgs;
1771 };
1772
1773 class PackExpansionTypeBitfields {
1774 friend class PackExpansionType;
1775
1776 unsigned : NumTypeBits;
1777
1778 /// The number of expansions that this pack expansion will
1779 /// generate when substituted (+1), which is expected to be able to
1780 /// hold at least 1024 according to [implimits]. However, as this limit
1781 /// is somewhat easy to hit with template metaprogramming we'd prefer to
1782 /// keep it as large as possible. At the moment it has been left as a
1783 /// non-bitfield since this type safely fits in 64 bits as an unsigned, so
1784 /// there is no reason to introduce the performance impact of a bitfield.
1785 ///
1786 /// This field will only have a non-zero value when some of the parameter
1787 /// packs that occur within the pattern have been substituted but others
1788 /// have not.
1789 unsigned NumExpansions;
1790 };
1791
1792 union {
1793 TypeBitfields TypeBits;
1794 ArrayTypeBitfields ArrayTypeBits;
1795 ConstantArrayTypeBitfields ConstantArrayTypeBits;
1796 AttributedTypeBitfields AttributedTypeBits;
1797 AutoTypeBitfields AutoTypeBits;
1798 BuiltinTypeBitfields BuiltinTypeBits;
1799 FunctionTypeBitfields FunctionTypeBits;
1800 ObjCObjectTypeBitfields ObjCObjectTypeBits;
1801 ReferenceTypeBitfields ReferenceTypeBits;
1802 TypeWithKeywordBitfields TypeWithKeywordBits;
1803 ElaboratedTypeBitfields ElaboratedTypeBits;
1804 VectorTypeBitfields VectorTypeBits;
1805 SubstTemplateTypeParmPackTypeBitfields SubstTemplateTypeParmPackTypeBits;
1806 TemplateSpecializationTypeBitfields TemplateSpecializationTypeBits;
1807 DependentTemplateSpecializationTypeBitfields
1808 DependentTemplateSpecializationTypeBits;
1809 PackExpansionTypeBitfields PackExpansionTypeBits;
1810 };
1811
1812private:
1813 template <class T> friend class TypePropertyCache;
1814
1815 /// Set whether this type comes from an AST file.
1816 void setFromAST(bool V = true) const {
1817 TypeBits.FromAST = V;
1818 }
1819
1820protected:
1821 friend class ASTContext;
1822
1823 Type(TypeClass tc, QualType canon, TypeDependence Dependence)
1824 : ExtQualsTypeCommonBase(this,
1825 canon.isNull() ? QualType(this_(), 0) : canon) {
1826 static_assert(sizeof(*this) <= 8 + sizeof(ExtQualsTypeCommonBase),
1827 "changing bitfields changed sizeof(Type)!");
1828 static_assert(alignof(decltype(*this)) % sizeof(void *) == 0,
1829 "Insufficient alignment!");
1830 TypeBits.TC = tc;
1831 TypeBits.Dependence = static_cast<unsigned>(Dependence);
1832 TypeBits.CacheValid = false;
1833 TypeBits.CachedLocalOrUnnamed = false;
1834 TypeBits.CachedLinkage = NoLinkage;
1835 TypeBits.FromAST = false;
1836 }
1837
1838 // silence VC++ warning C4355: 'this' : used in base member initializer list
1839 Type *this_() { return this; }
1840
1841 void setDependence(TypeDependence D) {
1842 TypeBits.Dependence = static_cast<unsigned>(D);
1843 }
1844
1845 void addDependence(TypeDependence D) { setDependence(getDependence() | D); }
1846
1847public:
1848 friend class ASTReader;
1849 friend class ASTWriter;
1850 template <class T> friend class serialization::AbstractTypeReader;
1851 template <class T> friend class serialization::AbstractTypeWriter;
1852
1853 Type(const Type &) = delete;
1854 Type(Type &&) = delete;
1855 Type &operator=(const Type &) = delete;
1856 Type &operator=(Type &&) = delete;
1857
1858 TypeClass getTypeClass() const { return static_cast<TypeClass>(TypeBits.TC); }
1859
1860 /// Whether this type comes from an AST file.
1861 bool isFromAST() const { return TypeBits.FromAST; }
1862
1863 /// Whether this type is or contains an unexpanded parameter
1864 /// pack, used to support C++0x variadic templates.
1865 ///
1866 /// A type that contains a parameter pack shall be expanded by the
1867 /// ellipsis operator at some point. For example, the typedef in the
1868 /// following example contains an unexpanded parameter pack 'T':
1869 ///
1870 /// \code
1871 /// template<typename ...T>
1872 /// struct X {
1873 /// typedef T* pointer_types; // ill-formed; T is a parameter pack.
1874 /// };
1875 /// \endcode
1876 ///
1877 /// Note that this routine does not specify which
1878 bool containsUnexpandedParameterPack() const {
1879 return getDependence() & TypeDependence::UnexpandedPack;
1880 }
1881
1882 /// Determines if this type would be canonical if it had no further
1883 /// qualification.
1884 bool isCanonicalUnqualified() const {
1885 return CanonicalType == QualType(this, 0);
1886 }
1887
1888 /// Pull a single level of sugar off of this locally-unqualified type.
1889 /// Users should generally prefer SplitQualType::getSingleStepDesugaredType()
1890 /// or QualType::getSingleStepDesugaredType(const ASTContext&).
1891 QualType getLocallyUnqualifiedSingleStepDesugaredType() const;
1892
1893 /// As an extension, we classify types as one of "sized" or "sizeless";
1894 /// every type is one or the other. Standard types are all sized;
1895 /// sizeless types are purely an extension.
1896 ///
1897 /// Sizeless types contain data with no specified size, alignment,
1898 /// or layout.
1899 bool isSizelessType() const;
1900 bool isSizelessBuiltinType() const;
1901
1902 /// Determines if this is a sizeless type supported by the
1903 /// 'arm_sve_vector_bits' type attribute, which can be applied to a single
1904 /// SVE vector or predicate, excluding tuple types such as svint32x4_t.
1905 bool isVLSTBuiltinType() const;
1906
1907 /// Returns the representative type for the element of an SVE builtin type.
1908 /// This is used to represent fixed-length SVE vectors created with the
1909 /// 'arm_sve_vector_bits' type attribute as VectorType.
1910 QualType getSveEltType(const ASTContext &Ctx) const;
1911
1912 /// Types are partitioned into 3 broad categories (C99 6.2.5p1):
1913 /// object types, function types, and incomplete types.
1914
1915 /// Return true if this is an incomplete type.
1916 /// A type that can describe objects, but which lacks information needed to
1917 /// determine its size (e.g. void, or a fwd declared struct). Clients of this
1918 /// routine will need to determine if the size is actually required.
1919 ///
1920 /// Def If non-null, and the type refers to some kind of declaration
1921 /// that can be completed (such as a C struct, C++ class, or Objective-C
1922 /// class), will be set to the declaration.
1923 bool isIncompleteType(NamedDecl **Def = nullptr) const;
1924
1925 /// Return true if this is an incomplete or object
1926 /// type, in other words, not a function type.
1927 bool isIncompleteOrObjectType() const {
1928 return !isFunctionType();
1929 }
1930
1931 /// Determine whether this type is an object type.
1932 bool isObjectType() const {
1933 // C++ [basic.types]p8:
1934 // An object type is a (possibly cv-qualified) type that is not a
1935 // function type, not a reference type, and not a void type.
1936 return !isReferenceType() && !isFunctionType() && !isVoidType();
1937 }
1938
1939 /// Return true if this is a literal type
1940 /// (C++11 [basic.types]p10)
1941 bool isLiteralType(const ASTContext &Ctx) const;
1942
1943 /// Determine if this type is a structural type, per C++20 [temp.param]p7.
1944 bool isStructuralType() const;
1945
1946 /// Test if this type is a standard-layout type.
1947 /// (C++0x [basic.type]p9)
1948 bool isStandardLayoutType() const;
1949
1950 /// Helper methods to distinguish type categories. All type predicates
1951 /// operate on the canonical type, ignoring typedefs and qualifiers.
1952
1953 /// Returns true if the type is a builtin type.
1954 bool isBuiltinType() const;
1955
1956 /// Test for a particular builtin type.
1957 bool isSpecificBuiltinType(unsigned K) const;
1958
1959 /// Test for a type which does not represent an actual type-system type but
1960 /// is instead used as a placeholder for various convenient purposes within
1961 /// Clang. All such types are BuiltinTypes.
1962 bool isPlaceholderType() const;
1963 const BuiltinType *getAsPlaceholderType() const;
1964
1965 /// Test for a specific placeholder type.
1966 bool isSpecificPlaceholderType(unsigned K) const;
1967
1968 /// Test for a placeholder type other than Overload; see
1969 /// BuiltinType::isNonOverloadPlaceholderType.
1970 bool isNonOverloadPlaceholderType() const;
1971
1972 /// isIntegerType() does *not* include complex integers (a GCC extension).
1973 /// isComplexIntegerType() can be used to test for complex integers.
1974 bool isIntegerType() const; // C99 6.2.5p17 (int, char, bool, enum)
1975 bool isEnumeralType() const;
1976
1977 /// Determine whether this type is a scoped enumeration type.
1978 bool isScopedEnumeralType() const;
1979 bool isBooleanType() const;
1980 bool isCharType() const;
1981 bool isWideCharType() const;
1982 bool isChar8Type() const;
1983 bool isChar16Type() const;
1984 bool isChar32Type() const;
1985 bool isAnyCharacterType() const;
1986 bool isIntegralType(const ASTContext &Ctx) const;
1987
1988 /// Determine whether this type is an integral or enumeration type.
1989 bool isIntegralOrEnumerationType() const;
1990
1991 /// Determine whether this type is an integral or unscoped enumeration type.
1992 bool isIntegralOrUnscopedEnumerationType() const;
1993 bool isUnscopedEnumerationType() const;
1994
1995 /// Floating point categories.
1996 bool isRealFloatingType() const; // C99 6.2.5p10 (float, double, long double)
1997 /// isComplexType() does *not* include complex integers (a GCC extension).
1998 /// isComplexIntegerType() can be used to test for complex integers.
1999 bool isComplexType() const; // C99 6.2.5p11 (complex)
2000 bool isAnyComplexType() const; // C99 6.2.5p11 (complex) + Complex Int.
2001 bool isFloatingType() const; // C99 6.2.5p11 (real floating + complex)
2002 bool isHalfType() const; // OpenCL 6.1.1.1, NEON (IEEE 754-2008 half)
2003 bool isFloat16Type() const; // C11 extension ISO/IEC TS 18661
2004 bool isBFloat16Type() const;
2005 bool isFloat128Type() const;
2006 bool isIbm128Type() const;
2007 bool isRealType() const; // C99 6.2.5p17 (real floating + integer)
2008 bool isArithmeticType() const; // C99 6.2.5p18 (integer + floating)
2009 bool isVoidType() const; // C99 6.2.5p19
2010 bool isScalarType() const; // C99 6.2.5p21 (arithmetic + pointers)
2011 bool isAggregateType() const;
2012 bool isFundamentalType() const;
2013 bool isCompoundType() const;
2014
2015 // Type Predicates: Check to see if this type is structurally the specified
2016 // type, ignoring typedefs and qualifiers.
2017 bool isFunctionType() const;
2018 bool isFunctionNoProtoType() const { return getAs<FunctionNoProtoType>(); }
2019 bool isFunctionProtoType() const { return getAs<FunctionProtoType>(); }
2020 bool isPointerType() const;
2021 bool isAnyPointerType() const; // Any C pointer or ObjC object pointer
2022 bool isBlockPointerType() const;
2023 bool isVoidPointerType() const;
2024 bool isReferenceType() const;
2025 bool isLValueReferenceType() const;
2026 bool isRValueReferenceType() const;
2027 bool isObjectPointerType() const;
2028 bool isFunctionPointerType() const;
2029 bool isFunctionReferenceType() const;
2030 bool isMemberPointerType() const;
2031 bool isMemberFunctionPointerType() const;
2032 bool isMemberDataPointerType() const;
2033 bool isArrayType() const;
2034 bool isConstantArrayType() const;
2035 bool isIncompleteArrayType() const;
2036 bool isVariableArrayType() const;
2037 bool isDependentSizedArrayType() const;
2038 bool isRecordType() const;
2039 bool isClassType() const;
2040 bool isStructureType() const;
2041 bool isObjCBoxableRecordType() const;
2042 bool isInterfaceType() const;
2043 bool isStructureOrClassType() const;
2044 bool isUnionType() const;
2045 bool isComplexIntegerType() const; // GCC _Complex integer type.
2046 bool isVectorType() const; // GCC vector type.
2047 bool isExtVectorType() const; // Extended vector type.
2048 bool isMatrixType() const; // Matrix type.
2049 bool isConstantMatrixType() const; // Constant matrix type.
2050 bool isDependentAddressSpaceType() const; // value-dependent address space qualifier
2051 bool isObjCObjectPointerType() const; // pointer to ObjC object
2052 bool isObjCRetainableType() const; // ObjC object or block pointer
2053 bool isObjCLifetimeType() const; // (array of)* retainable type
2054 bool isObjCIndirectLifetimeType() const; // (pointer to)* lifetime type
2055 bool isObjCNSObjectType() const; // __attribute__((NSObject))
2056 bool isObjCIndependentClassType() const; // __attribute__((objc_independent_class))
2057 // FIXME: change this to 'raw' interface type, so we can used 'interface' type
2058 // for the common case.
2059 bool isObjCObjectType() const; // NSString or typeof(*(id)0)
2060 bool isObjCQualifiedInterfaceType() const; // NSString<foo>
2061 bool isObjCQualifiedIdType() const; // id<foo>
2062 bool isObjCQualifiedClassType() const; // Class<foo>
2063 bool isObjCObjectOrInterfaceType() const;
2064 bool isObjCIdType() const; // id
2065 bool isDecltypeType() const;
2066 /// Was this type written with the special inert-in-ARC __unsafe_unretained
2067 /// qualifier?
2068 ///
2069 /// This approximates the answer to the following question: if this
2070 /// translation unit were compiled in ARC, would this type be qualified
2071 /// with __unsafe_unretained?
2072 bool isObjCInertUnsafeUnretainedType() const {
2073 return hasAttr(attr::ObjCInertUnsafeUnretained);
2074 }
2075
2076 /// Whether the type is Objective-C 'id' or a __kindof type of an
2077 /// object type, e.g., __kindof NSView * or __kindof id
2078 /// <NSCopying>.
2079 ///
2080 /// \param bound Will be set to the bound on non-id subtype types,
2081 /// which will be (possibly specialized) Objective-C class type, or
2082 /// null for 'id.
2083 bool isObjCIdOrObjectKindOfType(const ASTContext &ctx,
2084 const ObjCObjectType *&bound) const;
2085
2086 bool isObjCClassType() const; // Class
2087
2088 /// Whether the type is Objective-C 'Class' or a __kindof type of an
2089 /// Class type, e.g., __kindof Class <NSCopying>.
2090 ///
2091 /// Unlike \c isObjCIdOrObjectKindOfType, there is no relevant bound
2092 /// here because Objective-C's type system cannot express "a class
2093 /// object for a subclass of NSFoo".
2094 bool isObjCClassOrClassKindOfType() const;
2095
2096 bool isBlockCompatibleObjCPointerType(ASTContext &ctx) const;
2097 bool isObjCSelType() const; // Class
2098 bool isObjCBuiltinType() const; // 'id' or 'Class'
2099 bool isObjCARCBridgableType() const;
2100 bool isCARCBridgableType() const;
2101 bool isTemplateTypeParmType() const; // C++ template type parameter
2102 bool isNullPtrType() const; // C++11 std::nullptr_t
2103 bool isNothrowT() const; // C++ std::nothrow_t
2104 bool isAlignValT() const; // C++17 std::align_val_t
2105 bool isStdByteType() const; // C++17 std::byte
2106 bool isAtomicType() const; // C11 _Atomic()
2107 bool isUndeducedAutoType() const; // C++11 auto or
2108 // C++14 decltype(auto)
2109 bool isTypedefNameType() const; // typedef or alias template
2110
2111#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
2112 bool is##Id##Type() const;
2113#include "clang/Basic/OpenCLImageTypes.def"
2114
2115 bool isImageType() const; // Any OpenCL image type
2116
2117 bool isSamplerT() const; // OpenCL sampler_t
2118 bool isEventT() const; // OpenCL event_t
2119 bool isClkEventT() const; // OpenCL clk_event_t
2120 bool isQueueT() const; // OpenCL queue_t
2121 bool isReserveIDT() const; // OpenCL reserve_id_t
2122
2123#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
2124 bool is##Id##Type() const;
2125#include "clang/Basic/OpenCLExtensionTypes.def"
2126 // Type defined in cl_intel_device_side_avc_motion_estimation OpenCL extension
2127 bool isOCLIntelSubgroupAVCType() const;
2128 bool isOCLExtOpaqueType() const; // Any OpenCL extension type
2129
2130 bool isPipeType() const; // OpenCL pipe type
2131 bool isExtIntType() const; // Extended Int Type
2132 bool isOpenCLSpecificType() const; // Any OpenCL specific type
2133
2134 /// Determines if this type, which must satisfy
2135 /// isObjCLifetimeType(), is implicitly __unsafe_unretained rather
2136 /// than implicitly __strong.
2137 bool isObjCARCImplicitlyUnretainedType() const;
2138
2139 /// Check if the type is the CUDA device builtin surface type.
2140 bool isCUDADeviceBuiltinSurfaceType() const;
2141 /// Check if the type is the CUDA device builtin texture type.
2142 bool isCUDADeviceBuiltinTextureType() const;
2143
2144 /// Return the implicit lifetime for this type, which must not be dependent.
2145 Qualifiers::ObjCLifetime getObjCARCImplicitLifetime() const;
2146
2147 enum ScalarTypeKind {
2148 STK_CPointer,
2149 STK_BlockPointer,
2150 STK_ObjCObjectPointer,
2151 STK_MemberPointer,
2152 STK_Bool,
2153 STK_Integral,
2154 STK_Floating,
2155 STK_IntegralComplex,
2156 STK_FloatingComplex,
2157 STK_FixedPoint
2158 };
2159
2160 /// Given that this is a scalar type, classify it.
2161 ScalarTypeKind getScalarTypeKind() const;
2162
2163 TypeDependence getDependence() const {
2164 return static_cast<TypeDependence>(TypeBits.Dependence);
2165 }
2166
2167 /// Whether this type is an error type.
2168 bool containsErrors() const {
2169 return getDependence() & TypeDependence::Error;
2170 }
2171
2172 /// Whether this type is a dependent type, meaning that its definition
2173 /// somehow depends on a template parameter (C++ [temp.dep.type]).
2174 bool isDependentType() const {
2175 return getDependence() & TypeDependence::Dependent;
2176 }
2177
2178 /// Determine whether this type is an instantiation-dependent type,
2179 /// meaning that the type involves a template parameter (even if the
2180 /// definition does not actually depend on the type substituted for that
2181 /// template parameter).
2182 bool isInstantiationDependentType() const {
2183 return getDependence() & TypeDependence::Instantiation;
2184 }
2185
2186 /// Determine whether this type is an undeduced type, meaning that
2187 /// it somehow involves a C++11 'auto' type or similar which has not yet been
2188 /// deduced.
2189 bool isUndeducedType() const;
2190
2191 /// Whether this type is a variably-modified type (C99 6.7.5).
2192 bool isVariablyModifiedType() const {
2193 return getDependence() & TypeDependence::VariablyModified;
2194 }
2195
2196 /// Whether this type involves a variable-length array type
2197 /// with a definite size.
2198 bool hasSizedVLAType() const;
2199
2200 /// Whether this type is or contains a local or unnamed type.
2201 bool hasUnnamedOrLocalType() const;
2202
2203 bool isOverloadableType() const;
2204
2205 /// Determine wither this type is a C++ elaborated-type-specifier.
2206 bool isElaboratedTypeSpecifier() const;
2207
2208 bool canDecayToPointerType() const;
2209
2210 /// Whether this type is represented natively as a pointer. This includes
2211 /// pointers, references, block pointers, and Objective-C interface,
2212 /// qualified id, and qualified interface types, as well as nullptr_t.
2213 bool hasPointerRepresentation() const;
2214
2215 /// Whether this type can represent an objective pointer type for the
2216 /// purpose of GC'ability
2217 bool hasObjCPointerRepresentation() const;
2218
2219 /// Determine whether this type has an integer representation
2220 /// of some sort, e.g., it is an integer type or a vector.
2221 bool hasIntegerRepresentation() const;
2222
2223 /// Determine whether this type has an signed integer representation
2224 /// of some sort, e.g., it is an signed integer type or a vector.
2225 bool hasSignedIntegerRepresentation() const;
2226
2227 /// Determine whether this type has an unsigned integer representation
2228 /// of some sort, e.g., it is an unsigned integer type or a vector.
2229 bool hasUnsignedIntegerRepresentation() const;
2230
2231 /// Determine whether this type has a floating-point representation
2232 /// of some sort, e.g., it is a floating-point type or a vector thereof.
2233 bool hasFloatingRepresentation() const;
2234
2235 // Type Checking Functions: Check to see if this type is structurally the
2236 // specified type, ignoring typedefs and qualifiers, and return a pointer to
2237 // the best type we can.
2238 const RecordType *getAsStructureType() const;
2239 /// NOTE: getAs*ArrayType are methods on ASTContext.
2240 const RecordType *getAsUnionType() const;
2241 const ComplexType *getAsComplexIntegerType() const; // GCC complex int type.
2242 const ObjCObjectType *getAsObjCInterfaceType() const;
2243
2244 // The following is a convenience method that returns an ObjCObjectPointerType
2245 // for object declared using an interface.
2246 const ObjCObjectPointerType *getAsObjCInterfacePointerType() const;
2247 const ObjCObjectPointerType *getAsObjCQualifiedIdType() const;
2248 const ObjCObjectPointerType *getAsObjCQualifiedClassType() const;
2249 const ObjCObjectType *getAsObjCQualifiedInterfaceType() const;
2250
2251 /// Retrieves the CXXRecordDecl that this type refers to, either
2252 /// because the type is a RecordType or because it is the injected-class-name
2253 /// type of a class template or class template partial specialization.
2254 CXXRecordDecl *getAsCXXRecordDecl() const;
2255
2256 /// Retrieves the RecordDecl this type refers to.
2257 RecordDecl *getAsRecordDecl() const;
2258
2259 /// Retrieves the TagDecl that this type refers to, either
2260 /// because the type is a TagType or because it is the injected-class-name
2261 /// type of a class template or class template partial specialization.
2262 TagDecl *getAsTagDecl() const;
2263
2264 /// If this is a pointer or reference to a RecordType, return the
2265 /// CXXRecordDecl that the type refers to.
2266 ///
2267 /// If this is not a pointer or reference, or the type being pointed to does
2268 /// not refer to a CXXRecordDecl, returns NULL.
2269 const CXXRecordDecl *getPointeeCXXRecordDecl() const;
2270
2271 /// Get the DeducedType whose type will be deduced for a variable with
2272 /// an initializer of this type. This looks through declarators like pointer
2273 /// types, but not through decltype or typedefs.
2274 DeducedType *getContainedDeducedType() const;
2275
2276 /// Get the AutoType whose type will be deduced for a variable with
2277 /// an initializer of this type. This looks through declarators like pointer
2278 /// types, but not through decltype or typedefs.
2279 AutoType *getContainedAutoType() const {
2280 return dyn_cast_or_null<AutoType>(getContainedDeducedType());
2281 }
2282
2283 /// Determine whether this type was written with a leading 'auto'
2284 /// corresponding to a trailing return type (possibly for a nested
2285 /// function type within a pointer to function type or similar).
2286 bool hasAutoForTrailingReturnType() const;
2287
2288 /// Member-template getAs<specific type>'. Look through sugar for
2289 /// an instance of \<specific type>. This scheme will eventually
2290 /// replace the specific getAsXXXX methods above.
2291 ///
2292 /// There are some specializations of this member template listed
2293 /// immediately following this class.
2294 template <typename T> const T *getAs() const;
2295
2296 /// Member-template getAsAdjusted<specific type>. Look through specific kinds
2297 /// of sugar (parens, attributes, etc) for an instance of \<specific type>.
2298 /// This is used when you need to walk over sugar nodes that represent some
2299 /// kind of type adjustment from a type that was written as a \<specific type>
2300 /// to another type that is still canonically a \<specific type>.
2301 template <typename T> const T *getAsAdjusted() const;
2302
2303 /// A variant of getAs<> for array types which silently discards
2304 /// qualifiers from the outermost type.
2305 const ArrayType *getAsArrayTypeUnsafe() const;
2306
2307 /// Member-template castAs<specific type>. Look through sugar for
2308 /// the underlying instance of \<specific type>.
2309 ///
2310 /// This method has the same relationship to getAs<T> as cast<T> has
2311 /// to dyn_cast<T>; which is to say, the underlying type *must*
2312 /// have the intended type, and this method will never return null.
2313 template <typename T> const T *castAs() const;
2314
2315 /// A variant of castAs<> for array type which silently discards
2316 /// qualifiers from the outermost type.
2317 const ArrayType *castAsArrayTypeUnsafe() const;
2318
2319 /// Determine whether this type had the specified attribute applied to it
2320 /// (looking through top-level type sugar).
2321 bool hasAttr(attr::Kind AK) const;
2322
2323 /// Get the base element type of this type, potentially discarding type
2324 /// qualifiers. This should never be used when type qualifiers
2325 /// are meaningful.
2326 const Type *getBaseElementTypeUnsafe() const;
2327
2328 /// If this is an array type, return the element type of the array,
2329 /// potentially with type qualifiers missing.
2330 /// This should never be used when type qualifiers are meaningful.
2331 const Type *getArrayElementTypeNoTypeQual() const;
2332
2333 /// If this is a pointer type, return the pointee type.
2334 /// If this is an array type, return the array element type.
2335 /// This should never be used when type qualifiers are meaningful.
2336 const Type *getPointeeOrArrayElementType() const;
2337
2338 /// If this is a pointer, ObjC object pointer, or block
2339 /// pointer, this returns the respective pointee.
2340 QualType getPointeeType() const;
2341
2342 /// Return the specified type with any "sugar" removed from the type,
2343 /// removing any typedefs, typeofs, etc., as well as any qualifiers.
2344 const Type *getUnqualifiedDesugaredType() const;
2345
2346 /// More type predicates useful for type checking/promotion
2347 bool isPromotableIntegerType() const; // C99 6.3.1.1p2
2348
2349 /// Return true if this is an integer type that is
2350 /// signed, according to C99 6.2.5p4 [char, signed char, short, int, long..],
2351 /// or an enum decl which has a signed representation.
2352 bool isSignedIntegerType() const;
2353
2354 /// Return true if this is an integer type that is
2355 /// unsigned, according to C99 6.2.5p6 [which returns true for _Bool],
2356 /// or an enum decl which has an unsigned representation.
2357 bool isUnsignedIntegerType() const;
2358
2359 /// Determines whether this is an integer type that is signed or an
2360 /// enumeration types whose underlying type is a signed integer type.
2361 bool isSignedIntegerOrEnumerationType() const;
2362
2363 /// Determines whether this is an integer type that is unsigned or an
2364 /// enumeration types whose underlying type is a unsigned integer type.
2365 bool isUnsignedIntegerOrEnumerationType() const;
2366
2367 /// Return true if this is a fixed point type according to
2368 /// ISO/IEC JTC1 SC22 WG14 N1169.
2369 bool isFixedPointType() const;
2370
2371 /// Return true if this is a fixed point or integer type.
2372 bool isFixedPointOrIntegerType() const;
2373
2374 /// Return true if this is a saturated fixed point type according to
2375 /// ISO/IEC JTC1 SC22 WG14 N1169. This type can be signed or unsigned.
2376 bool isSaturatedFixedPointType() const;
2377
2378 /// Return true if this is a saturated fixed point type according to
2379 /// ISO/IEC JTC1 SC22 WG14 N1169. This type can be signed or unsigned.
2380 bool isUnsaturatedFixedPointType() const;
2381
2382 /// Return true if this is a fixed point type that is signed according
2383 /// to ISO/IEC JTC1 SC22 WG14 N1169. This type can also be saturated.
2384 bool isSignedFixedPointType() const;
2385
2386 /// Return true if this is a fixed point type that is unsigned according
2387 /// to ISO/IEC JTC1 SC22 WG14 N1169. This type can also be saturated.
2388 bool isUnsignedFixedPointType() const;
2389
2390 /// Return true if this is not a variable sized type,
2391 /// according to the rules of C99 6.7.5p3. It is not legal to call this on
2392 /// incomplete types.
2393 bool isConstantSizeType() const;
2394
2395 /// Returns true if this type can be represented by some
2396 /// set of type specifiers.
2397 bool isSpecifierType() const;
2398
2399 /// Determine the linkage of this type.
2400 Linkage getLinkage() const;
2401
2402 /// Determine the visibility of this type.
2403 Visibility getVisibility() const {
2404 return getLinkageAndVisibility().getVisibility();
2405 }
2406
2407 /// Return true if the visibility was explicitly set is the code.
2408 bool isVisibilityExplicit() const {
2409 return getLinkageAndVisibility().isVisibilityExplicit();
2410 }
2411
2412 /// Determine the linkage and visibility of this type.
2413 LinkageInfo getLinkageAndVisibility() const;
2414
2415 /// True if the computed linkage is valid. Used for consistency
2416 /// checking. Should always return true.
2417 bool isLinkageValid() const;
2418
2419 /// Determine the nullability of the given type.
2420 ///
2421 /// Note that nullability is only captured as sugar within the type
2422 /// system, not as part of the canonical type, so nullability will
2423 /// be lost by canonicalization and desugaring.
2424 Optional<NullabilityKind> getNullability(const ASTContext &context) const;
2425
2426 /// Determine whether the given type can have a nullability
2427 /// specifier applied to it, i.e., if it is any kind of pointer type.
2428 ///
2429 /// \param ResultIfUnknown The value to return if we don't yet know whether
2430 /// this type can have nullability because it is dependent.
2431 bool canHaveNullability(bool ResultIfUnknown = true) const;
2432
2433 /// Retrieve the set of substitutions required when accessing a member
2434 /// of the Objective-C receiver type that is declared in the given context.
2435 ///
2436 /// \c *this is the type of the object we're operating on, e.g., the
2437 /// receiver for a message send or the base of a property access, and is
2438 /// expected to be of some object or object pointer type.
2439 ///
2440 /// \param dc The declaration context for which we are building up a
2441 /// substitution mapping, which should be an Objective-C class, extension,
2442 /// category, or method within.
2443 ///
2444 /// \returns an array of type arguments that can be substituted for
2445 /// the type parameters of the given declaration context in any type described
2446 /// within that context, or an empty optional to indicate that no
2447 /// substitution is required.
2448 Optional<ArrayRef<QualType>>
2449 getObjCSubstitutions(const DeclContext *dc) const;
2450
2451 /// Determines if this is an ObjC interface type that may accept type
2452 /// parameters.
2453 bool acceptsObjCTypeParams() const;
2454
2455 const char *getTypeClassName() const;
2456
2457 QualType getCanonicalTypeInternal() const {
2458 return CanonicalType;
2459 }
2460
2461 CanQualType getCanonicalTypeUnqualified() const; // in CanonicalType.h
2462 void dump() const;
2463 void dump(llvm::raw_ostream &OS, const ASTContext &Context) const;
2464};
2465
2466/// This will check for a TypedefType by removing any existing sugar
2467/// until it reaches a TypedefType or a non-sugared type.
2468template <> const TypedefType *Type::getAs() const;
2469
2470/// This will check for a TemplateSpecializationType by removing any
2471/// existing sugar until it reaches a TemplateSpecializationType or a
2472/// non-sugared type.
2473template <> const TemplateSpecializationType *Type::getAs() const;
2474
2475/// This will check for an AttributedType by removing any existing sugar
2476/// until it reaches an AttributedType or a non-sugared type.
2477template <> const AttributedType *Type::getAs() const;
2478
2479// We can do canonical leaf types faster, because we don't have to
2480// worry about preserving child type decoration.
2481#define TYPE(Class, Base)
2482#define LEAF_TYPE(Class) \
2483template <> inline const Class##Type *Type::getAs() const { \
2484 return dyn_cast<Class##Type>(CanonicalType); \
2485} \
2486template <> inline const Class##Type *Type::castAs() const { \
2487 return cast<Class##Type>(CanonicalType); \
2488}
2489#include "clang/AST/TypeNodes.inc"
2490
2491/// This class is used for builtin types like 'int'. Builtin
2492/// types are always canonical and have a literal name field.
2493class BuiltinType : public Type {
2494public:
2495 enum Kind {
2496// OpenCL image types
2497#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) Id,
2498#include "clang/Basic/OpenCLImageTypes.def"
2499// OpenCL extension types
2500#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) Id,
2501#include "clang/Basic/OpenCLExtensionTypes.def"
2502// SVE Types
2503#define SVE_TYPE(Name, Id, SingletonId) Id,
2504#include "clang/Basic/AArch64SVEACLETypes.def"
2505// PPC MMA Types
2506#define PPC_VECTOR_TYPE(Name, Id, Size) Id,
2507#include "clang/Basic/PPCTypes.def"
2508// RVV Types
2509#define RVV_TYPE(Name, Id, SingletonId) Id,
2510#include "clang/Basic/RISCVVTypes.def"
2511// All other builtin types
2512#define BUILTIN_TYPE(Id, SingletonId) Id,
2513#define LAST_BUILTIN_TYPE(Id) LastKind = Id
2514#include "clang/AST/BuiltinTypes.def"
2515 };
2516
2517private:
2518 friend class ASTContext; // ASTContext creates these.
2519
2520 BuiltinType(Kind K)
2521 : Type(Builtin, QualType(),
2522 K == Dependent ? TypeDependence::DependentInstantiation
2523 : TypeDependence::None) {
2524 BuiltinTypeBits.Kind = K;
2525 }
2526
2527public:
2528 Kind getKind() const { return static_cast<Kind>(BuiltinTypeBits.Kind); }
2529 StringRef getName(const PrintingPolicy &Policy) const;
2530
2531 const char *getNameAsCString(const PrintingPolicy &Policy