1 //===- ASTContext.cpp - Context to hold long-lived AST nodes --------------===//
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 the ASTContext interface.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "clang/AST/ASTContext.h"
14 #include "CXXABI.h"
15 #include "Interp/Context.h"
16 #include "clang/AST/APValue.h"
17 #include "clang/AST/ASTConcept.h"
18 #include "clang/AST/ASTMutationListener.h"
19 #include "clang/AST/ASTTypeTraits.h"
20 #include "clang/AST/Attr.h"
21 #include "clang/AST/AttrIterator.h"
22 #include "clang/AST/CharUnits.h"
23 #include "clang/AST/Comment.h"
24 #include "clang/AST/Decl.h"
25 #include "clang/AST/DeclBase.h"
26 #include "clang/AST/DeclCXX.h"
27 #include "clang/AST/DeclContextInternals.h"
28 #include "clang/AST/DeclObjC.h"
29 #include "clang/AST/DeclOpenMP.h"
30 #include "clang/AST/DeclTemplate.h"
31 #include "clang/AST/DeclarationName.h"
32 #include "clang/AST/DependenceFlags.h"
33 #include "clang/AST/Expr.h"
34 #include "clang/AST/ExprCXX.h"
35 #include "clang/AST/ExprConcepts.h"
36 #include "clang/AST/ExternalASTSource.h"
37 #include "clang/AST/Mangle.h"
38 #include "clang/AST/MangleNumberingContext.h"
39 #include "clang/AST/NestedNameSpecifier.h"
40 #include "clang/AST/ParentMapContext.h"
41 #include "clang/AST/RawCommentList.h"
42 #include "clang/AST/RecordLayout.h"
43 #include "clang/AST/Stmt.h"
44 #include "clang/AST/TemplateBase.h"
45 #include "clang/AST/TemplateName.h"
46 #include "clang/AST/Type.h"
47 #include "clang/AST/TypeLoc.h"
48 #include "clang/AST/UnresolvedSet.h"
49 #include "clang/AST/VTableBuilder.h"
50 #include "clang/Basic/AddressSpaces.h"
51 #include "clang/Basic/Builtins.h"
52 #include "clang/Basic/CommentOptions.h"
53 #include "clang/Basic/ExceptionSpecificationType.h"
54 #include "clang/Basic/IdentifierTable.h"
55 #include "clang/Basic/LLVM.h"
56 #include "clang/Basic/LangOptions.h"
57 #include "clang/Basic/Linkage.h"
58 #include "clang/Basic/Module.h"
59 #include "clang/Basic/NoSanitizeList.h"
60 #include "clang/Basic/ObjCRuntime.h"
61 #include "clang/Basic/SourceLocation.h"
62 #include "clang/Basic/SourceManager.h"
63 #include "clang/Basic/Specifiers.h"
64 #include "clang/Basic/TargetCXXABI.h"
65 #include "clang/Basic/TargetInfo.h"
66 #include "clang/Basic/XRayLists.h"
67 #include "llvm/ADT/APFixedPoint.h"
68 #include "llvm/ADT/APInt.h"
69 #include "llvm/ADT/APSInt.h"
70 #include "llvm/ADT/ArrayRef.h"
71 #include "llvm/ADT/DenseMap.h"
72 #include "llvm/ADT/DenseSet.h"
73 #include "llvm/ADT/FoldingSet.h"
74 #include "llvm/ADT/None.h"
75 #include "llvm/ADT/Optional.h"
76 #include "llvm/ADT/PointerUnion.h"
77 #include "llvm/ADT/STLExtras.h"
78 #include "llvm/ADT/SmallPtrSet.h"
79 #include "llvm/ADT/SmallVector.h"
80 #include "llvm/ADT/StringExtras.h"
81 #include "llvm/ADT/StringRef.h"
82 #include "llvm/ADT/Triple.h"
83 #include "llvm/Support/Capacity.h"
84 #include "llvm/Support/Casting.h"
85 #include "llvm/Support/Compiler.h"
86 #include "llvm/Support/ErrorHandling.h"
87 #include "llvm/Support/MD5.h"
88 #include "llvm/Support/MathExtras.h"
89 #include "llvm/Support/raw_ostream.h"
90 #include <algorithm>
91 #include <cassert>
92 #include <cstddef>
93 #include <cstdint>
94 #include <cstdlib>
95 #include <map>
96 #include <memory>
97 #include <string>
98 #include <tuple>
99 #include <utility>
100 
101 using namespace clang;
102 
103 enum FloatingRank {
104   BFloat16Rank,
105   Float16Rank,
106   HalfRank,
107   FloatRank,
108   DoubleRank,
109   LongDoubleRank,
110   Float128Rank,
111   Ibm128Rank
112 };
113 
114 /// \returns location that is relevant when searching for Doc comments related
115 /// to \p D.
116 static SourceLocation getDeclLocForCommentSearch(const Decl *D,
117                                                  SourceManager &SourceMgr) {
118   assert(D);
119 
120   // User can not attach documentation to implicit declarations.
121   if (D->isImplicit())
122     return {};
123 
124   // User can not attach documentation to implicit instantiations.
125   if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
126     if (FD->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
127       return {};
128   }
129 
130   if (const auto *VD = dyn_cast<VarDecl>(D)) {
131     if (VD->isStaticDataMember() &&
132         VD->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
133       return {};
134   }
135 
136   if (const auto *CRD = dyn_cast<CXXRecordDecl>(D)) {
137     if (CRD->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
138       return {};
139   }
140 
141   if (const auto *CTSD = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
142     TemplateSpecializationKind TSK = CTSD->getSpecializationKind();
143     if (TSK == TSK_ImplicitInstantiation ||
144         TSK == TSK_Undeclared)
145       return {};
146   }
147 
148   if (const auto *ED = dyn_cast<EnumDecl>(D)) {
149     if (ED->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
150       return {};
151   }
152   if (const auto *TD = dyn_cast<TagDecl>(D)) {
153     // When tag declaration (but not definition!) is part of the
154     // decl-specifier-seq of some other declaration, it doesn't get comment
155     if (TD->isEmbeddedInDeclarator() && !TD->isCompleteDefinition())
156       return {};
157   }
158   // TODO: handle comments for function parameters properly.
159   if (isa<ParmVarDecl>(D))
160     return {};
161 
162   // TODO: we could look up template parameter documentation in the template
163   // documentation.
164   if (isa<TemplateTypeParmDecl>(D) ||
165       isa<NonTypeTemplateParmDecl>(D) ||
166       isa<TemplateTemplateParmDecl>(D))
167     return {};
168 
169   // Find declaration location.
170   // For Objective-C declarations we generally don't expect to have multiple
171   // declarators, thus use declaration starting location as the "declaration
172   // location".
173   // For all other declarations multiple declarators are used quite frequently,
174   // so we use the location of the identifier as the "declaration location".
175   if (isa<ObjCMethodDecl>(D) || isa<ObjCContainerDecl>(D) ||
176       isa<ObjCPropertyDecl>(D) ||
177       isa<RedeclarableTemplateDecl>(D) ||
178       isa<ClassTemplateSpecializationDecl>(D) ||
179       // Allow association with Y across {} in `typedef struct X {} Y`.
180       isa<TypedefDecl>(D))
181     return D->getBeginLoc();
182 
183   const SourceLocation DeclLoc = D->getLocation();
184   if (DeclLoc.isMacroID()) {
185     if (isa<TypedefDecl>(D)) {
186       // If location of the typedef name is in a macro, it is because being
187       // declared via a macro. Try using declaration's starting location as
188       // the "declaration location".
189       return D->getBeginLoc();
190     }
191 
192     if (const auto *TD = dyn_cast<TagDecl>(D)) {
193       // If location of the tag decl is inside a macro, but the spelling of
194       // the tag name comes from a macro argument, it looks like a special
195       // macro like NS_ENUM is being used to define the tag decl.  In that
196       // case, adjust the source location to the expansion loc so that we can
197       // attach the comment to the tag decl.
198       if (SourceMgr.isMacroArgExpansion(DeclLoc) && TD->isCompleteDefinition())
199         return SourceMgr.getExpansionLoc(DeclLoc);
200     }
201   }
202 
203   return DeclLoc;
204 }
205 
206 RawComment *ASTContext::getRawCommentForDeclNoCacheImpl(
207     const Decl *D, const SourceLocation RepresentativeLocForDecl,
208     const std::map<unsigned, RawComment *> &CommentsInTheFile) const {
209   // If the declaration doesn't map directly to a location in a file, we
210   // can't find the comment.
211   if (RepresentativeLocForDecl.isInvalid() ||
212       !RepresentativeLocForDecl.isFileID())
213     return nullptr;
214 
215   // If there are no comments anywhere, we won't find anything.
216   if (CommentsInTheFile.empty())
217     return nullptr;
218 
219   // Decompose the location for the declaration and find the beginning of the
220   // file buffer.
221   const std::pair<FileID, unsigned> DeclLocDecomp =
222       SourceMgr.getDecomposedLoc(RepresentativeLocForDecl);
223 
224   // Slow path.
225   auto OffsetCommentBehindDecl =
226       CommentsInTheFile.lower_bound(DeclLocDecomp.second);
227 
228   // First check whether we have a trailing comment.
229   if (OffsetCommentBehindDecl != CommentsInTheFile.end()) {
230     RawComment *CommentBehindDecl = OffsetCommentBehindDecl->second;
231     if ((CommentBehindDecl->isDocumentation() ||
232          LangOpts.CommentOpts.ParseAllComments) &&
233         CommentBehindDecl->isTrailingComment() &&
234         (isa<FieldDecl>(D) || isa<EnumConstantDecl>(D) || isa<VarDecl>(D) ||
235          isa<ObjCMethodDecl>(D) || isa<ObjCPropertyDecl>(D))) {
236 
237       // Check that Doxygen trailing comment comes after the declaration, starts
238       // on the same line and in the same file as the declaration.
239       if (SourceMgr.getLineNumber(DeclLocDecomp.first, DeclLocDecomp.second) ==
240           Comments.getCommentBeginLine(CommentBehindDecl, DeclLocDecomp.first,
241                                        OffsetCommentBehindDecl->first)) {
242         return CommentBehindDecl;
243       }
244     }
245   }
246 
247   // The comment just after the declaration was not a trailing comment.
248   // Let's look at the previous comment.
249   if (OffsetCommentBehindDecl == CommentsInTheFile.begin())
250     return nullptr;
251 
252   auto OffsetCommentBeforeDecl = --OffsetCommentBehindDecl;
253   RawComment *CommentBeforeDecl = OffsetCommentBeforeDecl->second;
254 
255   // Check that we actually have a non-member Doxygen comment.
256   if (!(CommentBeforeDecl->isDocumentation() ||
257         LangOpts.CommentOpts.ParseAllComments) ||
258       CommentBeforeDecl->isTrailingComment())
259     return nullptr;
260 
261   // Decompose the end of the comment.
262   const unsigned CommentEndOffset =
263       Comments.getCommentEndOffset(CommentBeforeDecl);
264 
265   // Get the corresponding buffer.
266   bool Invalid = false;
267   const char *Buffer = SourceMgr.getBufferData(DeclLocDecomp.first,
268                                                &Invalid).data();
269   if (Invalid)
270     return nullptr;
271 
272   // Extract text between the comment and declaration.
273   StringRef Text(Buffer + CommentEndOffset,
274                  DeclLocDecomp.second - CommentEndOffset);
275 
276   // There should be no other declarations or preprocessor directives between
277   // comment and declaration.
278   if (Text.find_first_of(";{}#@") != StringRef::npos)
279     return nullptr;
280 
281   return CommentBeforeDecl;
282 }
283 
284 RawComment *ASTContext::getRawCommentForDeclNoCache(const Decl *D) const {
285   const SourceLocation DeclLoc = getDeclLocForCommentSearch(D, SourceMgr);
286 
287   // If the declaration doesn't map directly to a location in a file, we
288   // can't find the comment.
289   if (DeclLoc.isInvalid() || !DeclLoc.isFileID())
290     return nullptr;
291 
292   if (ExternalSource && !CommentsLoaded) {
293     ExternalSource->ReadComments();
294     CommentsLoaded = true;
295   }
296 
297   if (Comments.empty())
298     return nullptr;
299 
300   const FileID File = SourceMgr.getDecomposedLoc(DeclLoc).first;
301   const auto CommentsInThisFile = Comments.getCommentsInFile(File);
302   if (!CommentsInThisFile || CommentsInThisFile->empty())
303     return nullptr;
304 
305   return getRawCommentForDeclNoCacheImpl(D, DeclLoc, *CommentsInThisFile);
306 }
307 
308 void ASTContext::addComment(const RawComment &RC) {
309   assert(LangOpts.RetainCommentsFromSystemHeaders ||
310          !SourceMgr.isInSystemHeader(RC.getSourceRange().getBegin()));
311   Comments.addComment(RC, LangOpts.CommentOpts, BumpAlloc);
312 }
313 
314 /// If we have a 'templated' declaration for a template, adjust 'D' to
315 /// refer to the actual template.
316 /// If we have an implicit instantiation, adjust 'D' to refer to template.
317 static const Decl &adjustDeclToTemplate(const Decl &D) {
318   if (const auto *FD = dyn_cast<FunctionDecl>(&D)) {
319     // Is this function declaration part of a function template?
320     if (const FunctionTemplateDecl *FTD = FD->getDescribedFunctionTemplate())
321       return *FTD;
322 
323     // Nothing to do if function is not an implicit instantiation.
324     if (FD->getTemplateSpecializationKind() != TSK_ImplicitInstantiation)
325       return D;
326 
327     // Function is an implicit instantiation of a function template?
328     if (const FunctionTemplateDecl *FTD = FD->getPrimaryTemplate())
329       return *FTD;
330 
331     // Function is instantiated from a member definition of a class template?
332     if (const FunctionDecl *MemberDecl =
333             FD->getInstantiatedFromMemberFunction())
334       return *MemberDecl;
335 
336     return D;
337   }
338   if (const auto *VD = dyn_cast<VarDecl>(&D)) {
339     // Static data member is instantiated from a member definition of a class
340     // template?
341     if (VD->isStaticDataMember())
342       if (const VarDecl *MemberDecl = VD->getInstantiatedFromStaticDataMember())
343         return *MemberDecl;
344 
345     return D;
346   }
347   if (const auto *CRD = dyn_cast<CXXRecordDecl>(&D)) {
348     // Is this class declaration part of a class template?
349     if (const ClassTemplateDecl *CTD = CRD->getDescribedClassTemplate())
350       return *CTD;
351 
352     // Class is an implicit instantiation of a class template or partial
353     // specialization?
354     if (const auto *CTSD = dyn_cast<ClassTemplateSpecializationDecl>(CRD)) {
355       if (CTSD->getSpecializationKind() != TSK_ImplicitInstantiation)
356         return D;
357       llvm::PointerUnion<ClassTemplateDecl *,
358                          ClassTemplatePartialSpecializationDecl *>
359           PU = CTSD->getSpecializedTemplateOrPartial();
360       return PU.is<ClassTemplateDecl *>()
361                  ? *static_cast<const Decl *>(PU.get<ClassTemplateDecl *>())
362                  : *static_cast<const Decl *>(
363                        PU.get<ClassTemplatePartialSpecializationDecl *>());
364     }
365 
366     // Class is instantiated from a member definition of a class template?
367     if (const MemberSpecializationInfo *Info =
368             CRD->getMemberSpecializationInfo())
369       return *Info->getInstantiatedFrom();
370 
371     return D;
372   }
373   if (const auto *ED = dyn_cast<EnumDecl>(&D)) {
374     // Enum is instantiated from a member definition of a class template?
375     if (const EnumDecl *MemberDecl = ED->getInstantiatedFromMemberEnum())
376       return *MemberDecl;
377 
378     return D;
379   }
380   // FIXME: Adjust alias templates?
381   return D;
382 }
383 
384 const RawComment *ASTContext::getRawCommentForAnyRedecl(
385                                                 const Decl *D,
386                                                 const Decl **OriginalDecl) const {
387   if (!D) {
388     if (OriginalDecl)
389       OriginalDecl = nullptr;
390     return nullptr;
391   }
392 
393   D = &adjustDeclToTemplate(*D);
394 
395   // Any comment directly attached to D?
396   {
397     auto DeclComment = DeclRawComments.find(D);
398     if (DeclComment != DeclRawComments.end()) {
399       if (OriginalDecl)
400         *OriginalDecl = D;
401       return DeclComment->second;
402     }
403   }
404 
405   // Any comment attached to any redeclaration of D?
406   const Decl *CanonicalD = D->getCanonicalDecl();
407   if (!CanonicalD)
408     return nullptr;
409 
410   {
411     auto RedeclComment = RedeclChainComments.find(CanonicalD);
412     if (RedeclComment != RedeclChainComments.end()) {
413       if (OriginalDecl)
414         *OriginalDecl = RedeclComment->second;
415       auto CommentAtRedecl = DeclRawComments.find(RedeclComment->second);
416       assert(CommentAtRedecl != DeclRawComments.end() &&
417              "This decl is supposed to have comment attached.");
418       return CommentAtRedecl->second;
419     }
420   }
421 
422   // Any redeclarations of D that we haven't checked for comments yet?
423   // We can't use DenseMap::iterator directly since it'd get invalid.
424   auto LastCheckedRedecl = [this, CanonicalD]() -> const Decl * {
425     auto LookupRes = CommentlessRedeclChains.find(CanonicalD);
426     if (LookupRes != CommentlessRedeclChains.end())
427       return LookupRes->second;
428     return nullptr;
429   }();
430 
431   for (const auto Redecl : D->redecls()) {
432     assert(Redecl);
433     // Skip all redeclarations that have been checked previously.
434     if (LastCheckedRedecl) {
435       if (LastCheckedRedecl == Redecl) {
436         LastCheckedRedecl = nullptr;
437       }
438       continue;
439     }
440     const RawComment *RedeclComment = getRawCommentForDeclNoCache(Redecl);
441     if (RedeclComment) {
442       cacheRawCommentForDecl(*Redecl, *RedeclComment);
443       if (OriginalDecl)
444         *OriginalDecl = Redecl;
445       return RedeclComment;
446     }
447     CommentlessRedeclChains[CanonicalD] = Redecl;
448   }
449 
450   if (OriginalDecl)
451     *OriginalDecl = nullptr;
452   return nullptr;
453 }
454 
455 void ASTContext::cacheRawCommentForDecl(const Decl &OriginalD,
456                                         const RawComment &Comment) const {
457   assert(Comment.isDocumentation() || LangOpts.CommentOpts.ParseAllComments);
458   DeclRawComments.try_emplace(&OriginalD, &Comment);
459   const Decl *const CanonicalDecl = OriginalD.getCanonicalDecl();
460   RedeclChainComments.try_emplace(CanonicalDecl, &OriginalD);
461   CommentlessRedeclChains.erase(CanonicalDecl);
462 }
463 
464 static void addRedeclaredMethods(const ObjCMethodDecl *ObjCMethod,
465                    SmallVectorImpl<const NamedDecl *> &Redeclared) {
466   const DeclContext *DC = ObjCMethod->getDeclContext();
467   if (const auto *IMD = dyn_cast<ObjCImplDecl>(DC)) {
468     const ObjCInterfaceDecl *ID = IMD->getClassInterface();
469     if (!ID)
470       return;
471     // Add redeclared method here.
472     for (const auto *Ext : ID->known_extensions()) {
473       if (ObjCMethodDecl *RedeclaredMethod =
474             Ext->getMethod(ObjCMethod->getSelector(),
475                                   ObjCMethod->isInstanceMethod()))
476         Redeclared.push_back(RedeclaredMethod);
477     }
478   }
479 }
480 
481 void ASTContext::attachCommentsToJustParsedDecls(ArrayRef<Decl *> Decls,
482                                                  const Preprocessor *PP) {
483   if (Comments.empty() || Decls.empty())
484     return;
485 
486   FileID File;
487   for (Decl *D : Decls) {
488     SourceLocation Loc = D->getLocation();
489     if (Loc.isValid()) {
490       // See if there are any new comments that are not attached to a decl.
491       // The location doesn't have to be precise - we care only about the file.
492       File = SourceMgr.getDecomposedLoc(Loc).first;
493       break;
494     }
495   }
496 
497   if (File.isInvalid())
498     return;
499 
500   auto CommentsInThisFile = Comments.getCommentsInFile(File);
501   if (!CommentsInThisFile || CommentsInThisFile->empty() ||
502       CommentsInThisFile->rbegin()->second->isAttached())
503     return;
504 
505   // There is at least one comment not attached to a decl.
506   // Maybe it should be attached to one of Decls?
507   //
508   // Note that this way we pick up not only comments that precede the
509   // declaration, but also comments that *follow* the declaration -- thanks to
510   // the lookahead in the lexer: we've consumed the semicolon and looked
511   // ahead through comments.
512 
513   for (const Decl *D : Decls) {
514     assert(D);
515     if (D->isInvalidDecl())
516       continue;
517 
518     D = &adjustDeclToTemplate(*D);
519 
520     const SourceLocation DeclLoc = getDeclLocForCommentSearch(D, SourceMgr);
521 
522     if (DeclLoc.isInvalid() || !DeclLoc.isFileID())
523       continue;
524 
525     if (DeclRawComments.count(D) > 0)
526       continue;
527 
528     if (RawComment *const DocComment =
529             getRawCommentForDeclNoCacheImpl(D, DeclLoc, *CommentsInThisFile)) {
530       cacheRawCommentForDecl(*D, *DocComment);
531       comments::FullComment *FC = DocComment->parse(*this, PP, D);
532       ParsedComments[D->getCanonicalDecl()] = FC;
533     }
534   }
535 }
536 
537 comments::FullComment *ASTContext::cloneFullComment(comments::FullComment *FC,
538                                                     const Decl *D) const {
539   auto *ThisDeclInfo = new (*this) comments::DeclInfo;
540   ThisDeclInfo->CommentDecl = D;
541   ThisDeclInfo->IsFilled = false;
542   ThisDeclInfo->fill();
543   ThisDeclInfo->CommentDecl = FC->getDecl();
544   if (!ThisDeclInfo->TemplateParameters)
545     ThisDeclInfo->TemplateParameters = FC->getDeclInfo()->TemplateParameters;
546   comments::FullComment *CFC =
547     new (*this) comments::FullComment(FC->getBlocks(),
548                                       ThisDeclInfo);
549   return CFC;
550 }
551 
552 comments::FullComment *ASTContext::getLocalCommentForDeclUncached(const Decl *D) const {
553   const RawComment *RC = getRawCommentForDeclNoCache(D);
554   return RC ? RC->parse(*this, nullptr, D) : nullptr;
555 }
556 
557 comments::FullComment *ASTContext::getCommentForDecl(
558                                               const Decl *D,
559                                               const Preprocessor *PP) const {
560   if (!D || D->isInvalidDecl())
561     return nullptr;
562   D = &adjustDeclToTemplate(*D);
563 
564   const Decl *Canonical = D->getCanonicalDecl();
565   llvm::DenseMap<const Decl *, comments::FullComment *>::iterator Pos =
566       ParsedComments.find(Canonical);
567 
568   if (Pos != ParsedComments.end()) {
569     if (Canonical != D) {
570       comments::FullComment *FC = Pos->second;
571       comments::FullComment *CFC = cloneFullComment(FC, D);
572       return CFC;
573     }
574     return Pos->second;
575   }
576 
577   const Decl *OriginalDecl = nullptr;
578 
579   const RawComment *RC = getRawCommentForAnyRedecl(D, &OriginalDecl);
580   if (!RC) {
581     if (isa<ObjCMethodDecl>(D) || isa<FunctionDecl>(D)) {
582       SmallVector<const NamedDecl*, 8> Overridden;
583       const auto *OMD = dyn_cast<ObjCMethodDecl>(D);
584       if (OMD && OMD->isPropertyAccessor())
585         if (const ObjCPropertyDecl *PDecl = OMD->findPropertyDecl())
586           if (comments::FullComment *FC = getCommentForDecl(PDecl, PP))
587             return cloneFullComment(FC, D);
588       if (OMD)
589         addRedeclaredMethods(OMD, Overridden);
590       getOverriddenMethods(dyn_cast<NamedDecl>(D), Overridden);
591       for (unsigned i = 0, e = Overridden.size(); i < e; i++)
592         if (comments::FullComment *FC = getCommentForDecl(Overridden[i], PP))
593           return cloneFullComment(FC, D);
594     }
595     else if (const auto *TD = dyn_cast<TypedefNameDecl>(D)) {
596       // Attach any tag type's documentation to its typedef if latter
597       // does not have one of its own.
598       QualType QT = TD->getUnderlyingType();
599       if (const auto *TT = QT->getAs<TagType>())
600         if (const Decl *TD = TT->getDecl())
601           if (comments::FullComment *FC = getCommentForDecl(TD, PP))
602             return cloneFullComment(FC, D);
603     }
604     else if (const auto *IC = dyn_cast<ObjCInterfaceDecl>(D)) {
605       while (IC->getSuperClass()) {
606         IC = IC->getSuperClass();
607         if (comments::FullComment *FC = getCommentForDecl(IC, PP))
608           return cloneFullComment(FC, D);
609       }
610     }
611     else if (const auto *CD = dyn_cast<ObjCCategoryDecl>(D)) {
612       if (const ObjCInterfaceDecl *IC = CD->getClassInterface())
613         if (comments::FullComment *FC = getCommentForDecl(IC, PP))
614           return cloneFullComment(FC, D);
615     }
616     else if (const auto *RD = dyn_cast<CXXRecordDecl>(D)) {
617       if (!(RD = RD->getDefinition()))
618         return nullptr;
619       // Check non-virtual bases.
620       for (const auto &I : RD->bases()) {
621         if (I.isVirtual() || (I.getAccessSpecifier() != AS_public))
622           continue;
623         QualType Ty = I.getType();
624         if (Ty.isNull())
625           continue;
626         if (const CXXRecordDecl *NonVirtualBase = Ty->getAsCXXRecordDecl()) {
627           if (!(NonVirtualBase= NonVirtualBase->getDefinition()))
628             continue;
629 
630           if (comments::FullComment *FC = getCommentForDecl((NonVirtualBase), PP))
631             return cloneFullComment(FC, D);
632         }
633       }
634       // Check virtual bases.
635       for (const auto &I : RD->vbases()) {
636         if (I.getAccessSpecifier() != AS_public)
637           continue;
638         QualType Ty = I.getType();
639         if (Ty.isNull())
640           continue;
641         if (const CXXRecordDecl *VirtualBase = Ty->getAsCXXRecordDecl()) {
642           if (!(VirtualBase= VirtualBase->getDefinition()))
643             continue;
644           if (comments::FullComment *FC = getCommentForDecl((VirtualBase), PP))
645             return cloneFullComment(FC, D);
646         }
647       }
648     }
649     return nullptr;
650   }
651 
652   // If the RawComment was attached to other redeclaration of this Decl, we
653   // should parse the comment in context of that other Decl.  This is important
654   // because comments can contain references to parameter names which can be
655   // different across redeclarations.
656   if (D != OriginalDecl && OriginalDecl)
657     return getCommentForDecl(OriginalDecl, PP);
658 
659   comments::FullComment *FC = RC->parse(*this, PP, D);
660   ParsedComments[Canonical] = FC;
661   return FC;
662 }
663 
664 void
665 ASTContext::CanonicalTemplateTemplateParm::Profile(llvm::FoldingSetNodeID &ID,
666                                                    const ASTContext &C,
667                                                TemplateTemplateParmDecl *Parm) {
668   ID.AddInteger(Parm->getDepth());
669   ID.AddInteger(Parm->getPosition());
670   ID.AddBoolean(Parm->isParameterPack());
671 
672   TemplateParameterList *Params = Parm->getTemplateParameters();
673   ID.AddInteger(Params->size());
674   for (TemplateParameterList::const_iterator P = Params->begin(),
675                                           PEnd = Params->end();
676        P != PEnd; ++P) {
677     if (const auto *TTP = dyn_cast<TemplateTypeParmDecl>(*P)) {
678       ID.AddInteger(0);
679       ID.AddBoolean(TTP->isParameterPack());
680       const TypeConstraint *TC = TTP->getTypeConstraint();
681       ID.AddBoolean(TC != nullptr);
682       if (TC)
683         TC->getImmediatelyDeclaredConstraint()->Profile(ID, C,
684                                                         /*Canonical=*/true);
685       if (TTP->isExpandedParameterPack()) {
686         ID.AddBoolean(true);
687         ID.AddInteger(TTP->getNumExpansionParameters());
688       } else
689         ID.AddBoolean(false);
690       continue;
691     }
692 
693     if (const auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(*P)) {
694       ID.AddInteger(1);
695       ID.AddBoolean(NTTP->isParameterPack());
696       ID.AddPointer(NTTP->getType().getCanonicalType().getAsOpaquePtr());
697       if (NTTP->isExpandedParameterPack()) {
698         ID.AddBoolean(true);
699         ID.AddInteger(NTTP->getNumExpansionTypes());
700         for (unsigned I = 0, N = NTTP->getNumExpansionTypes(); I != N; ++I) {
701           QualType T = NTTP->getExpansionType(I);
702           ID.AddPointer(T.getCanonicalType().getAsOpaquePtr());
703         }
704       } else
705         ID.AddBoolean(false);
706       continue;
707     }
708 
709     auto *TTP = cast<TemplateTemplateParmDecl>(*P);
710     ID.AddInteger(2);
711     Profile(ID, C, TTP);
712   }
713   Expr *RequiresClause = Parm->getTemplateParameters()->getRequiresClause();
714   ID.AddBoolean(RequiresClause != nullptr);
715   if (RequiresClause)
716     RequiresClause->Profile(ID, C, /*Canonical=*/true);
717 }
718 
719 static Expr *
720 canonicalizeImmediatelyDeclaredConstraint(const ASTContext &C, Expr *IDC,
721                                           QualType ConstrainedType) {
722   // This is a bit ugly - we need to form a new immediately-declared
723   // constraint that references the new parameter; this would ideally
724   // require semantic analysis (e.g. template<C T> struct S {}; - the
725   // converted arguments of C<T> could be an argument pack if C is
726   // declared as template<typename... T> concept C = ...).
727   // We don't have semantic analysis here so we dig deep into the
728   // ready-made constraint expr and change the thing manually.
729   ConceptSpecializationExpr *CSE;
730   if (const auto *Fold = dyn_cast<CXXFoldExpr>(IDC))
731     CSE = cast<ConceptSpecializationExpr>(Fold->getLHS());
732   else
733     CSE = cast<ConceptSpecializationExpr>(IDC);
734   ArrayRef<TemplateArgument> OldConverted = CSE->getTemplateArguments();
735   SmallVector<TemplateArgument, 3> NewConverted;
736   NewConverted.reserve(OldConverted.size());
737   if (OldConverted.front().getKind() == TemplateArgument::Pack) {
738     // The case:
739     // template<typename... T> concept C = true;
740     // template<C<int> T> struct S; -> constraint is C<{T, int}>
741     NewConverted.push_back(ConstrainedType);
742     for (auto &Arg : OldConverted.front().pack_elements().drop_front(1))
743       NewConverted.push_back(Arg);
744     TemplateArgument NewPack(NewConverted);
745 
746     NewConverted.clear();
747     NewConverted.push_back(NewPack);
748     assert(OldConverted.size() == 1 &&
749            "Template parameter pack should be the last parameter");
750   } else {
751     assert(OldConverted.front().getKind() == TemplateArgument::Type &&
752            "Unexpected first argument kind for immediately-declared "
753            "constraint");
754     NewConverted.push_back(ConstrainedType);
755     for (auto &Arg : OldConverted.drop_front(1))
756       NewConverted.push_back(Arg);
757   }
758   Expr *NewIDC = ConceptSpecializationExpr::Create(
759       C, CSE->getNamedConcept(), NewConverted, nullptr,
760       CSE->isInstantiationDependent(), CSE->containsUnexpandedParameterPack());
761 
762   if (auto *OrigFold = dyn_cast<CXXFoldExpr>(IDC))
763     NewIDC = new (C) CXXFoldExpr(
764         OrigFold->getType(), /*Callee*/nullptr, SourceLocation(), NewIDC,
765         BinaryOperatorKind::BO_LAnd, SourceLocation(), /*RHS=*/nullptr,
766         SourceLocation(), /*NumExpansions=*/None);
767   return NewIDC;
768 }
769 
770 TemplateTemplateParmDecl *
771 ASTContext::getCanonicalTemplateTemplateParmDecl(
772                                           TemplateTemplateParmDecl *TTP) const {
773   // Check if we already have a canonical template template parameter.
774   llvm::FoldingSetNodeID ID;
775   CanonicalTemplateTemplateParm::Profile(ID, *this, TTP);
776   void *InsertPos = nullptr;
777   CanonicalTemplateTemplateParm *Canonical
778     = CanonTemplateTemplateParms.FindNodeOrInsertPos(ID, InsertPos);
779   if (Canonical)
780     return Canonical->getParam();
781 
782   // Build a canonical template parameter list.
783   TemplateParameterList *Params = TTP->getTemplateParameters();
784   SmallVector<NamedDecl *, 4> CanonParams;
785   CanonParams.reserve(Params->size());
786   for (TemplateParameterList::const_iterator P = Params->begin(),
787                                           PEnd = Params->end();
788        P != PEnd; ++P) {
789     if (const auto *TTP = dyn_cast<TemplateTypeParmDecl>(*P)) {
790       TemplateTypeParmDecl *NewTTP = TemplateTypeParmDecl::Create(*this,
791           getTranslationUnitDecl(), SourceLocation(), SourceLocation(),
792           TTP->getDepth(), TTP->getIndex(), nullptr, false,
793           TTP->isParameterPack(), TTP->hasTypeConstraint(),
794           TTP->isExpandedParameterPack() ?
795           llvm::Optional<unsigned>(TTP->getNumExpansionParameters()) : None);
796       if (const auto *TC = TTP->getTypeConstraint()) {
797         QualType ParamAsArgument(NewTTP->getTypeForDecl(), 0);
798         Expr *NewIDC = canonicalizeImmediatelyDeclaredConstraint(
799                 *this, TC->getImmediatelyDeclaredConstraint(),
800                 ParamAsArgument);
801         TemplateArgumentListInfo CanonArgsAsWritten;
802         if (auto *Args = TC->getTemplateArgsAsWritten())
803           for (const auto &ArgLoc : Args->arguments())
804             CanonArgsAsWritten.addArgument(
805                 TemplateArgumentLoc(ArgLoc.getArgument(),
806                                     TemplateArgumentLocInfo()));
807         NewTTP->setTypeConstraint(
808             NestedNameSpecifierLoc(),
809             DeclarationNameInfo(TC->getNamedConcept()->getDeclName(),
810                                 SourceLocation()), /*FoundDecl=*/nullptr,
811             // Actually canonicalizing a TemplateArgumentLoc is difficult so we
812             // simply omit the ArgsAsWritten
813             TC->getNamedConcept(), /*ArgsAsWritten=*/nullptr, NewIDC);
814       }
815       CanonParams.push_back(NewTTP);
816     } else if (const auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(*P)) {
817       QualType T = getCanonicalType(NTTP->getType());
818       TypeSourceInfo *TInfo = getTrivialTypeSourceInfo(T);
819       NonTypeTemplateParmDecl *Param;
820       if (NTTP->isExpandedParameterPack()) {
821         SmallVector<QualType, 2> ExpandedTypes;
822         SmallVector<TypeSourceInfo *, 2> ExpandedTInfos;
823         for (unsigned I = 0, N = NTTP->getNumExpansionTypes(); I != N; ++I) {
824           ExpandedTypes.push_back(getCanonicalType(NTTP->getExpansionType(I)));
825           ExpandedTInfos.push_back(
826                                 getTrivialTypeSourceInfo(ExpandedTypes.back()));
827         }
828 
829         Param = NonTypeTemplateParmDecl::Create(*this, getTranslationUnitDecl(),
830                                                 SourceLocation(),
831                                                 SourceLocation(),
832                                                 NTTP->getDepth(),
833                                                 NTTP->getPosition(), nullptr,
834                                                 T,
835                                                 TInfo,
836                                                 ExpandedTypes,
837                                                 ExpandedTInfos);
838       } else {
839         Param = NonTypeTemplateParmDecl::Create(*this, getTranslationUnitDecl(),
840                                                 SourceLocation(),
841                                                 SourceLocation(),
842                                                 NTTP->getDepth(),
843                                                 NTTP->getPosition(), nullptr,
844                                                 T,
845                                                 NTTP->isParameterPack(),
846                                                 TInfo);
847       }
848       if (AutoType *AT = T->getContainedAutoType()) {
849         if (AT->isConstrained()) {
850           Param->setPlaceholderTypeConstraint(
851               canonicalizeImmediatelyDeclaredConstraint(
852                   *this, NTTP->getPlaceholderTypeConstraint(), T));
853         }
854       }
855       CanonParams.push_back(Param);
856 
857     } else
858       CanonParams.push_back(getCanonicalTemplateTemplateParmDecl(
859                                            cast<TemplateTemplateParmDecl>(*P)));
860   }
861 
862   Expr *CanonRequiresClause = nullptr;
863   if (Expr *RequiresClause = TTP->getTemplateParameters()->getRequiresClause())
864     CanonRequiresClause = RequiresClause;
865 
866   TemplateTemplateParmDecl *CanonTTP
867     = TemplateTemplateParmDecl::Create(*this, getTranslationUnitDecl(),
868                                        SourceLocation(), TTP->getDepth(),
869                                        TTP->getPosition(),
870                                        TTP->isParameterPack(),
871                                        nullptr,
872                          TemplateParameterList::Create(*this, SourceLocation(),
873                                                        SourceLocation(),
874                                                        CanonParams,
875                                                        SourceLocation(),
876                                                        CanonRequiresClause));
877 
878   // Get the new insert position for the node we care about.
879   Canonical = CanonTemplateTemplateParms.FindNodeOrInsertPos(ID, InsertPos);
880   assert(!Canonical && "Shouldn't be in the map!");
881   (void)Canonical;
882 
883   // Create the canonical template template parameter entry.
884   Canonical = new (*this) CanonicalTemplateTemplateParm(CanonTTP);
885   CanonTemplateTemplateParms.InsertNode(Canonical, InsertPos);
886   return CanonTTP;
887 }
888 
889 TargetCXXABI::Kind ASTContext::getCXXABIKind() const {
890   auto Kind = getTargetInfo().getCXXABI().getKind();
891   return getLangOpts().CXXABI.getValueOr(Kind);
892 }
893 
894 CXXABI *ASTContext::createCXXABI(const TargetInfo &T) {
895   if (!LangOpts.CPlusPlus) return nullptr;
896 
897   switch (getCXXABIKind()) {
898   case TargetCXXABI::AppleARM64:
899   case TargetCXXABI::Fuchsia:
900   case TargetCXXABI::GenericARM: // Same as Itanium at this level
901   case TargetCXXABI::iOS:
902   case TargetCXXABI::WatchOS:
903   case TargetCXXABI::GenericAArch64:
904   case TargetCXXABI::GenericMIPS:
905   case TargetCXXABI::GenericItanium:
906   case TargetCXXABI::WebAssembly:
907   case TargetCXXABI::XL:
908     return CreateItaniumCXXABI(*this);
909   case TargetCXXABI::Microsoft:
910     return CreateMicrosoftCXXABI(*this);
911   }
912   llvm_unreachable("Invalid CXXABI type!");
913 }
914 
915 interp::Context &ASTContext::getInterpContext() {
916   if (!InterpContext) {
917     InterpContext.reset(new interp::Context(*this));
918   }
919   return *InterpContext.get();
920 }
921 
922 ParentMapContext &ASTContext::getParentMapContext() {
923   if (!ParentMapCtx)
924     ParentMapCtx.reset(new ParentMapContext(*this));
925   return *ParentMapCtx.get();
926 }
927 
928 static const LangASMap *getAddressSpaceMap(const TargetInfo &T,
929                                            const LangOptions &LOpts) {
930   if (LOpts.FakeAddressSpaceMap) {
931     // The fake address space map must have a distinct entry for each
932     // language-specific address space.
933     static const unsigned FakeAddrSpaceMap[] = {
934         0,  // Default
935         1,  // opencl_global
936         3,  // opencl_local
937         2,  // opencl_constant
938         0,  // opencl_private
939         4,  // opencl_generic
940         5,  // opencl_global_device
941         6,  // opencl_global_host
942         7,  // cuda_device
943         8,  // cuda_constant
944         9,  // cuda_shared
945         1,  // sycl_global
946         5,  // sycl_global_device
947         6,  // sycl_global_host
948         3,  // sycl_local
949         0,  // sycl_private
950         10, // ptr32_sptr
951         11, // ptr32_uptr
952         12  // ptr64
953     };
954     return &FakeAddrSpaceMap;
955   } else {
956     return &T.getAddressSpaceMap();
957   }
958 }
959 
960 static bool isAddrSpaceMapManglingEnabled(const TargetInfo &TI,
961                                           const LangOptions &LangOpts) {
962   switch (LangOpts.getAddressSpaceMapMangling()) {
963   case LangOptions::ASMM_Target:
964     return TI.useAddressSpaceMapMangling();
965   case LangOptions::ASMM_On:
966     return true;
967   case LangOptions::ASMM_Off:
968     return false;
969   }
970   llvm_unreachable("getAddressSpaceMapMangling() doesn't cover anything.");
971 }
972 
973 ASTContext::ASTContext(LangOptions &LOpts, SourceManager &SM,
974                        IdentifierTable &idents, SelectorTable &sels,
975                        Builtin::Context &builtins, TranslationUnitKind TUKind)
976     : ConstantArrayTypes(this_()), FunctionProtoTypes(this_()),
977       TemplateSpecializationTypes(this_()),
978       DependentTemplateSpecializationTypes(this_()), AutoTypes(this_()),
979       SubstTemplateTemplateParmPacks(this_()),
980       CanonTemplateTemplateParms(this_()), SourceMgr(SM), LangOpts(LOpts),
981       NoSanitizeL(new NoSanitizeList(LangOpts.NoSanitizeFiles, SM)),
982       XRayFilter(new XRayFunctionFilter(LangOpts.XRayAlwaysInstrumentFiles,
983                                         LangOpts.XRayNeverInstrumentFiles,
984                                         LangOpts.XRayAttrListFiles, SM)),
985       ProfList(new ProfileList(LangOpts.ProfileListFiles, SM)),
986       PrintingPolicy(LOpts), Idents(idents), Selectors(sels),
987       BuiltinInfo(builtins), TUKind(TUKind), DeclarationNames(*this),
988       Comments(SM), CommentCommandTraits(BumpAlloc, LOpts.CommentOpts),
989       CompCategories(this_()), LastSDM(nullptr, 0) {
990   addTranslationUnitDecl();
991 }
992 
993 void ASTContext::cleanup() {
994   // Release the DenseMaps associated with DeclContext objects.
995   // FIXME: Is this the ideal solution?
996   ReleaseDeclContextMaps();
997 
998   // Call all of the deallocation functions on all of their targets.
999   for (auto &Pair : Deallocations)
1000     (Pair.first)(Pair.second);
1001   Deallocations.clear();
1002 
1003   // ASTRecordLayout objects in ASTRecordLayouts must always be destroyed
1004   // because they can contain DenseMaps.
1005   for (llvm::DenseMap<const ObjCContainerDecl*,
1006        const ASTRecordLayout*>::iterator
1007        I = ObjCLayouts.begin(), E = ObjCLayouts.end(); I != E; )
1008     // Increment in loop to prevent using deallocated memory.
1009     if (auto *R = const_cast<ASTRecordLayout *>((I++)->second))
1010       R->Destroy(*this);
1011   ObjCLayouts.clear();
1012 
1013   for (llvm::DenseMap<const RecordDecl*, const ASTRecordLayout*>::iterator
1014        I = ASTRecordLayouts.begin(), E = ASTRecordLayouts.end(); I != E; ) {
1015     // Increment in loop to prevent using deallocated memory.
1016     if (auto *R = const_cast<ASTRecordLayout *>((I++)->second))
1017       R->Destroy(*this);
1018   }
1019   ASTRecordLayouts.clear();
1020 
1021   for (llvm::DenseMap<const Decl*, AttrVec*>::iterator A = DeclAttrs.begin(),
1022                                                     AEnd = DeclAttrs.end();
1023        A != AEnd; ++A)
1024     A->second->~AttrVec();
1025   DeclAttrs.clear();
1026 
1027   for (const auto &Value : ModuleInitializers)
1028     Value.second->~PerModuleInitializers();
1029   ModuleInitializers.clear();
1030 }
1031 
1032 ASTContext::~ASTContext() { cleanup(); }
1033 
1034 void ASTContext::setTraversalScope(const std::vector<Decl *> &TopLevelDecls) {
1035   TraversalScope = TopLevelDecls;
1036   getParentMapContext().clear();
1037 }
1038 
1039 void ASTContext::AddDeallocation(void (*Callback)(void *), void *Data) const {
1040   Deallocations.push_back({Callback, Data});
1041 }
1042 
1043 void
1044 ASTContext::setExternalSource(IntrusiveRefCntPtr<ExternalASTSource> Source) {
1045   ExternalSource = std::move(Source);
1046 }
1047 
1048 void ASTContext::PrintStats() const {
1049   llvm::errs() << "\n*** AST Context Stats:\n";
1050   llvm::errs() << "  " << Types.size() << " types total.\n";
1051 
1052   unsigned counts[] = {
1053 #define TYPE(Name, Parent) 0,
1054 #define ABSTRACT_TYPE(Name, Parent)
1055 #include "clang/AST/TypeNodes.inc"
1056     0 // Extra
1057   };
1058 
1059   for (unsigned i = 0, e = Types.size(); i != e; ++i) {
1060     Type *T = Types[i];
1061     counts[(unsigned)T->getTypeClass()]++;
1062   }
1063 
1064   unsigned Idx = 0;
1065   unsigned TotalBytes = 0;
1066 #define TYPE(Name, Parent)                                              \
1067   if (counts[Idx])                                                      \
1068     llvm::errs() << "    " << counts[Idx] << " " << #Name               \
1069                  << " types, " << sizeof(Name##Type) << " each "        \
1070                  << "(" << counts[Idx] * sizeof(Name##Type)             \
1071                  << " bytes)\n";                                        \
1072   TotalBytes += counts[Idx] * sizeof(Name##Type);                       \
1073   ++Idx;
1074 #define ABSTRACT_TYPE(Name, Parent)
1075 #include "clang/AST/TypeNodes.inc"
1076 
1077   llvm::errs() << "Total bytes = " << TotalBytes << "\n";
1078 
1079   // Implicit special member functions.
1080   llvm::errs() << NumImplicitDefaultConstructorsDeclared << "/"
1081                << NumImplicitDefaultConstructors
1082                << " implicit default constructors created\n";
1083   llvm::errs() << NumImplicitCopyConstructorsDeclared << "/"
1084                << NumImplicitCopyConstructors
1085                << " implicit copy constructors created\n";
1086   if (getLangOpts().CPlusPlus)
1087     llvm::errs() << NumImplicitMoveConstructorsDeclared << "/"
1088                  << NumImplicitMoveConstructors
1089                  << " implicit move constructors created\n";
1090   llvm::errs() << NumImplicitCopyAssignmentOperatorsDeclared << "/"
1091                << NumImplicitCopyAssignmentOperators
1092                << " implicit copy assignment operators created\n";
1093   if (getLangOpts().CPlusPlus)
1094     llvm::errs() << NumImplicitMoveAssignmentOperatorsDeclared << "/"
1095                  << NumImplicitMoveAssignmentOperators
1096                  << " implicit move assignment operators created\n";
1097   llvm::errs() << NumImplicitDestructorsDeclared << "/"
1098                << NumImplicitDestructors
1099                << " implicit destructors created\n";
1100 
1101   if (ExternalSource) {
1102     llvm::errs() << "\n";
1103     ExternalSource->PrintStats();
1104   }
1105 
1106   BumpAlloc.PrintStats();
1107 }
1108 
1109 void ASTContext::mergeDefinitionIntoModule(NamedDecl *ND, Module *M,
1110                                            bool NotifyListeners) {
1111   if (NotifyListeners)
1112     if (auto *Listener = getASTMutationListener())
1113       Listener->RedefinedHiddenDefinition(ND, M);
1114 
1115   MergedDefModules[cast<NamedDecl>(ND->getCanonicalDecl())].push_back(M);
1116 }
1117 
1118 void ASTContext::deduplicateMergedDefinitonsFor(NamedDecl *ND) {
1119   auto It = MergedDefModules.find(cast<NamedDecl>(ND->getCanonicalDecl()));
1120   if (It == MergedDefModules.end())
1121     return;
1122 
1123   auto &Merged = It->second;
1124   llvm::DenseSet<Module*> Found;
1125   for (Module *&M : Merged)
1126     if (!Found.insert(M).second)
1127       M = nullptr;
1128   Merged.erase(std::remove(Merged.begin(), Merged.end(), nullptr), Merged.end());
1129 }
1130 
1131 ArrayRef<Module *>
1132 ASTContext::getModulesWithMergedDefinition(const NamedDecl *Def) {
1133   auto MergedIt =
1134       MergedDefModules.find(cast<NamedDecl>(Def->getCanonicalDecl()));
1135   if (MergedIt == MergedDefModules.end())
1136     return None;
1137   return MergedIt->second;
1138 }
1139 
1140 void ASTContext::PerModuleInitializers::resolve(ASTContext &Ctx) {
1141   if (LazyInitializers.empty())
1142     return;
1143 
1144   auto *Source = Ctx.getExternalSource();
1145   assert(Source && "lazy initializers but no external source");
1146 
1147   auto LazyInits = std::move(LazyInitializers);
1148   LazyInitializers.clear();
1149 
1150   for (auto ID : LazyInits)
1151     Initializers.push_back(Source->GetExternalDecl(ID));
1152 
1153   assert(LazyInitializers.empty() &&
1154          "GetExternalDecl for lazy module initializer added more inits");
1155 }
1156 
1157 void ASTContext::addModuleInitializer(Module *M, Decl *D) {
1158   // One special case: if we add a module initializer that imports another
1159   // module, and that module's only initializer is an ImportDecl, simplify.
1160   if (const auto *ID = dyn_cast<ImportDecl>(D)) {
1161     auto It = ModuleInitializers.find(ID->getImportedModule());
1162 
1163     // Maybe the ImportDecl does nothing at all. (Common case.)
1164     if (It == ModuleInitializers.end())
1165       return;
1166 
1167     // Maybe the ImportDecl only imports another ImportDecl.
1168     auto &Imported = *It->second;
1169     if (Imported.Initializers.size() + Imported.LazyInitializers.size() == 1) {
1170       Imported.resolve(*this);
1171       auto *OnlyDecl = Imported.Initializers.front();
1172       if (isa<ImportDecl>(OnlyDecl))
1173         D = OnlyDecl;
1174     }
1175   }
1176 
1177   auto *&Inits = ModuleInitializers[M];
1178   if (!Inits)
1179     Inits = new (*this) PerModuleInitializers;
1180   Inits->Initializers.push_back(D);
1181 }
1182 
1183 void ASTContext::addLazyModuleInitializers(Module *M, ArrayRef<uint32_t> IDs) {
1184   auto *&Inits = ModuleInitializers[M];
1185   if (!Inits)
1186     Inits = new (*this) PerModuleInitializers;
1187   Inits->LazyInitializers.insert(Inits->LazyInitializers.end(),
1188                                  IDs.begin(), IDs.end());
1189 }
1190 
1191 ArrayRef<Decl *> ASTContext::getModuleInitializers(Module *M) {
1192   auto It = ModuleInitializers.find(M);
1193   if (It == ModuleInitializers.end())
1194     return None;
1195 
1196   auto *Inits = It->second;
1197   Inits->resolve(*this);
1198   return Inits->Initializers;
1199 }
1200 
1201 ExternCContextDecl *ASTContext::getExternCContextDecl() const {
1202   if (!ExternCContext)
1203     ExternCContext = ExternCContextDecl::Create(*this, getTranslationUnitDecl());
1204 
1205   return ExternCContext;
1206 }
1207 
1208 BuiltinTemplateDecl *
1209 ASTContext::buildBuiltinTemplateDecl(BuiltinTemplateKind BTK,
1210                                      const IdentifierInfo *II) const {
1211   auto *BuiltinTemplate =
1212       BuiltinTemplateDecl::Create(*this, getTranslationUnitDecl(), II, BTK);
1213   BuiltinTemplate->setImplicit();
1214   getTranslationUnitDecl()->addDecl(BuiltinTemplate);
1215 
1216   return BuiltinTemplate;
1217 }
1218 
1219 BuiltinTemplateDecl *
1220 ASTContext::getMakeIntegerSeqDecl() const {
1221   if (!MakeIntegerSeqDecl)
1222     MakeIntegerSeqDecl = buildBuiltinTemplateDecl(BTK__make_integer_seq,
1223                                                   getMakeIntegerSeqName());
1224   return MakeIntegerSeqDecl;
1225 }
1226 
1227 BuiltinTemplateDecl *
1228 ASTContext::getTypePackElementDecl() const {
1229   if (!TypePackElementDecl)
1230     TypePackElementDecl = buildBuiltinTemplateDecl(BTK__type_pack_element,
1231                                                    getTypePackElementName());
1232   return TypePackElementDecl;
1233 }
1234 
1235 RecordDecl *ASTContext::buildImplicitRecord(StringRef Name,
1236                                             RecordDecl::TagKind TK) const {
1237   SourceLocation Loc;
1238   RecordDecl *NewDecl;
1239   if (getLangOpts().CPlusPlus)
1240     NewDecl = CXXRecordDecl::Create(*this, TK, getTranslationUnitDecl(), Loc,
1241                                     Loc, &Idents.get(Name));
1242   else
1243     NewDecl = RecordDecl::Create(*this, TK, getTranslationUnitDecl(), Loc, Loc,
1244                                  &Idents.get(Name));
1245   NewDecl->setImplicit();
1246   NewDecl->addAttr(TypeVisibilityAttr::CreateImplicit(
1247       const_cast<ASTContext &>(*this), TypeVisibilityAttr::Default));
1248   return NewDecl;
1249 }
1250 
1251 TypedefDecl *ASTContext::buildImplicitTypedef(QualType T,
1252                                               StringRef Name) const {
1253   TypeSourceInfo *TInfo = getTrivialTypeSourceInfo(T);
1254   TypedefDecl *NewDecl = TypedefDecl::Create(
1255       const_cast<ASTContext &>(*this), getTranslationUnitDecl(),
1256       SourceLocation(), SourceLocation(), &Idents.get(Name), TInfo);
1257   NewDecl->setImplicit();
1258   return NewDecl;
1259 }
1260 
1261 TypedefDecl *ASTContext::getInt128Decl() const {
1262   if (!Int128Decl)
1263     Int128Decl = buildImplicitTypedef(Int128Ty, "__int128_t");
1264   return Int128Decl;
1265 }
1266 
1267 TypedefDecl *ASTContext::getUInt128Decl() const {
1268   if (!UInt128Decl)
1269     UInt128Decl = buildImplicitTypedef(UnsignedInt128Ty, "__uint128_t");
1270   return UInt128Decl;
1271 }
1272 
1273 void ASTContext::InitBuiltinType(CanQualType &R, BuiltinType::Kind K) {
1274   auto *Ty = new (*this, TypeAlignment) BuiltinType(K);
1275   R = CanQualType::CreateUnsafe(QualType(Ty, 0));
1276   Types.push_back(Ty);
1277 }
1278 
1279 void ASTContext::InitBuiltinTypes(const TargetInfo &Target,
1280                                   const TargetInfo *AuxTarget) {
1281   assert((!this->Target || this->Target == &Target) &&
1282          "Incorrect target reinitialization");
1283   assert(VoidTy.isNull() && "Context reinitialized?");
1284 
1285   this->Target = &Target;
1286   this->AuxTarget = AuxTarget;
1287 
1288   ABI.reset(createCXXABI(Target));
1289   AddrSpaceMap = getAddressSpaceMap(Target, LangOpts);
1290   AddrSpaceMapMangling = isAddrSpaceMapManglingEnabled(Target, LangOpts);
1291 
1292   // C99 6.2.5p19.
1293   InitBuiltinType(VoidTy,              BuiltinType::Void);
1294 
1295   // C99 6.2.5p2.
1296   InitBuiltinType(BoolTy,              BuiltinType::Bool);
1297   // C99 6.2.5p3.
1298   if (LangOpts.CharIsSigned)
1299     InitBuiltinType(CharTy,            BuiltinType::Char_S);
1300   else
1301     InitBuiltinType(CharTy,            BuiltinType::Char_U);
1302   // C99 6.2.5p4.
1303   InitBuiltinType(SignedCharTy,        BuiltinType::SChar);
1304   InitBuiltinType(ShortTy,             BuiltinType::Short);
1305   InitBuiltinType(IntTy,               BuiltinType::Int);
1306   InitBuiltinType(LongTy,              BuiltinType::Long);
1307   InitBuiltinType(LongLongTy,          BuiltinType::LongLong);
1308 
1309   // C99 6.2.5p6.
1310   InitBuiltinType(UnsignedCharTy,      BuiltinType::UChar);
1311   InitBuiltinType(UnsignedShortTy,     BuiltinType::UShort);
1312   InitBuiltinType(UnsignedIntTy,       BuiltinType::UInt);
1313   InitBuiltinType(UnsignedLongTy,      BuiltinType::ULong);
1314   InitBuiltinType(UnsignedLongLongTy,  BuiltinType::ULongLong);
1315 
1316   // C99 6.2.5p10.
1317   InitBuiltinType(FloatTy,             BuiltinType::Float);
1318   InitBuiltinType(DoubleTy,            BuiltinType::Double);
1319   InitBuiltinType(LongDoubleTy,        BuiltinType::LongDouble);
1320 
1321   // GNU extension, __float128 for IEEE quadruple precision
1322   InitBuiltinType(Float128Ty,          BuiltinType::Float128);
1323 
1324   // __ibm128 for IBM extended precision
1325   InitBuiltinType(Ibm128Ty, BuiltinType::Ibm128);
1326 
1327   // C11 extension ISO/IEC TS 18661-3
1328   InitBuiltinType(Float16Ty,           BuiltinType::Float16);
1329 
1330   // ISO/IEC JTC1 SC22 WG14 N1169 Extension
1331   InitBuiltinType(ShortAccumTy,            BuiltinType::ShortAccum);
1332   InitBuiltinType(AccumTy,                 BuiltinType::Accum);
1333   InitBuiltinType(LongAccumTy,             BuiltinType::LongAccum);
1334   InitBuiltinType(UnsignedShortAccumTy,    BuiltinType::UShortAccum);
1335   InitBuiltinType(UnsignedAccumTy,         BuiltinType::UAccum);
1336   InitBuiltinType(UnsignedLongAccumTy,     BuiltinType::ULongAccum);
1337   InitBuiltinType(ShortFractTy,            BuiltinType::ShortFract);
1338   InitBuiltinType(FractTy,                 BuiltinType::Fract);
1339   InitBuiltinType(LongFractTy,             BuiltinType::LongFract);
1340   InitBuiltinType(UnsignedShortFractTy,    BuiltinType::UShortFract);
1341   InitBuiltinType(UnsignedFractTy,         BuiltinType::UFract);
1342   InitBuiltinType(UnsignedLongFractTy,     BuiltinType::ULongFract);
1343   InitBuiltinType(SatShortAccumTy,         BuiltinType::SatShortAccum);
1344   InitBuiltinType(SatAccumTy,              BuiltinType::SatAccum);
1345   InitBuiltinType(SatLongAccumTy,          BuiltinType::SatLongAccum);
1346   InitBuiltinType(SatUnsignedShortAccumTy, BuiltinType::SatUShortAccum);
1347   InitBuiltinType(SatUnsignedAccumTy,      BuiltinType::SatUAccum);
1348   InitBuiltinType(SatUnsignedLongAccumTy,  BuiltinType::SatULongAccum);
1349   InitBuiltinType(SatShortFractTy,         BuiltinType::SatShortFract);
1350   InitBuiltinType(SatFractTy,              BuiltinType::SatFract);
1351   InitBuiltinType(SatLongFractTy,          BuiltinType::SatLongFract);
1352   InitBuiltinType(SatUnsignedShortFractTy, BuiltinType::SatUShortFract);
1353   InitBuiltinType(SatUnsignedFractTy,      BuiltinType::SatUFract);
1354   InitBuiltinType(SatUnsignedLongFractTy,  BuiltinType::SatULongFract);
1355 
1356   // GNU extension, 128-bit integers.
1357   InitBuiltinType(Int128Ty,            BuiltinType::Int128);
1358   InitBuiltinType(UnsignedInt128Ty,    BuiltinType::UInt128);
1359 
1360   // C++ 3.9.1p5
1361   if (TargetInfo::isTypeSigned(Target.getWCharType()))
1362     InitBuiltinType(WCharTy,           BuiltinType::WChar_S);
1363   else  // -fshort-wchar makes wchar_t be unsigned.
1364     InitBuiltinType(WCharTy,           BuiltinType::WChar_U);
1365   if (LangOpts.CPlusPlus && LangOpts.WChar)
1366     WideCharTy = WCharTy;
1367   else {
1368     // C99 (or C++ using -fno-wchar).
1369     WideCharTy = getFromTargetType(Target.getWCharType());
1370   }
1371 
1372   WIntTy = getFromTargetType(Target.getWIntType());
1373 
1374   // C++20 (proposed)
1375   InitBuiltinType(Char8Ty,              BuiltinType::Char8);
1376 
1377   if (LangOpts.CPlusPlus) // C++0x 3.9.1p5, extension for C++
1378     InitBuiltinType(Char16Ty,           BuiltinType::Char16);
1379   else // C99
1380     Char16Ty = getFromTargetType(Target.getChar16Type());
1381 
1382   if (LangOpts.CPlusPlus) // C++0x 3.9.1p5, extension for C++
1383     InitBuiltinType(Char32Ty,           BuiltinType::Char32);
1384   else // C99
1385     Char32Ty = getFromTargetType(Target.getChar32Type());
1386 
1387   // Placeholder type for type-dependent expressions whose type is
1388   // completely unknown. No code should ever check a type against
1389   // DependentTy and users should never see it; however, it is here to
1390   // help diagnose failures to properly check for type-dependent
1391   // expressions.
1392   InitBuiltinType(DependentTy,         BuiltinType::Dependent);
1393 
1394   // Placeholder type for functions.
1395   InitBuiltinType(OverloadTy,          BuiltinType::Overload);
1396 
1397   // Placeholder type for bound members.
1398   InitBuiltinType(BoundMemberTy,       BuiltinType::BoundMember);
1399 
1400   // Placeholder type for pseudo-objects.
1401   InitBuiltinType(PseudoObjectTy,      BuiltinType::PseudoObject);
1402 
1403   // "any" type; useful for debugger-like clients.
1404   InitBuiltinType(UnknownAnyTy,        BuiltinType::UnknownAny);
1405 
1406   // Placeholder type for unbridged ARC casts.
1407   InitBuiltinType(ARCUnbridgedCastTy,  BuiltinType::ARCUnbridgedCast);
1408 
1409   // Placeholder type for builtin functions.
1410   InitBuiltinType(BuiltinFnTy,  BuiltinType::BuiltinFn);
1411 
1412   // Placeholder type for OMP array sections.
1413   if (LangOpts.OpenMP) {
1414     InitBuiltinType(OMPArraySectionTy, BuiltinType::OMPArraySection);
1415     InitBuiltinType(OMPArrayShapingTy, BuiltinType::OMPArrayShaping);
1416     InitBuiltinType(OMPIteratorTy, BuiltinType::OMPIterator);
1417   }
1418   if (LangOpts.MatrixTypes)
1419     InitBuiltinType(IncompleteMatrixIdxTy, BuiltinType::IncompleteMatrixIdx);
1420 
1421   // Builtin types for 'id', 'Class', and 'SEL'.
1422   InitBuiltinType(ObjCBuiltinIdTy, BuiltinType::ObjCId);
1423   InitBuiltinType(ObjCBuiltinClassTy, BuiltinType::ObjCClass);
1424   InitBuiltinType(ObjCBuiltinSelTy, BuiltinType::ObjCSel);
1425 
1426   if (LangOpts.OpenCL) {
1427 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
1428     InitBuiltinType(SingletonId, BuiltinType::Id);
1429 #include "clang/Basic/OpenCLImageTypes.def"
1430 
1431     InitBuiltinType(OCLSamplerTy, BuiltinType::OCLSampler);
1432     InitBuiltinType(OCLEventTy, BuiltinType::OCLEvent);
1433     InitBuiltinType(OCLClkEventTy, BuiltinType::OCLClkEvent);
1434     InitBuiltinType(OCLQueueTy, BuiltinType::OCLQueue);
1435     InitBuiltinType(OCLReserveIDTy, BuiltinType::OCLReserveID);
1436 
1437 #define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
1438     InitBuiltinType(Id##Ty, BuiltinType::Id);
1439 #include "clang/Basic/OpenCLExtensionTypes.def"
1440   }
1441 
1442   if (Target.hasAArch64SVETypes()) {
1443 #define SVE_TYPE(Name, Id, SingletonId) \
1444     InitBuiltinType(SingletonId, BuiltinType::Id);
1445 #include "clang/Basic/AArch64SVEACLETypes.def"
1446   }
1447 
1448   if (Target.getTriple().isPPC64()) {
1449 #define PPC_VECTOR_MMA_TYPE(Name, Id, Size) \
1450       InitBuiltinType(Id##Ty, BuiltinType::Id);
1451 #include "clang/Basic/PPCTypes.def"
1452 #define PPC_VECTOR_VSX_TYPE(Name, Id, Size) \
1453     InitBuiltinType(Id##Ty, BuiltinType::Id);
1454 #include "clang/Basic/PPCTypes.def"
1455   }
1456 
1457   if (Target.hasRISCVVTypes()) {
1458 #define RVV_TYPE(Name, Id, SingletonId)                                        \
1459   InitBuiltinType(SingletonId, BuiltinType::Id);
1460 #include "clang/Basic/RISCVVTypes.def"
1461   }
1462 
1463   // Builtin type for __objc_yes and __objc_no
1464   ObjCBuiltinBoolTy = (Target.useSignedCharForObjCBool() ?
1465                        SignedCharTy : BoolTy);
1466 
1467   ObjCConstantStringType = QualType();
1468 
1469   ObjCSuperType = QualType();
1470 
1471   // void * type
1472   if (LangOpts.OpenCLGenericAddressSpace) {
1473     auto Q = VoidTy.getQualifiers();
1474     Q.setAddressSpace(LangAS::opencl_generic);
1475     VoidPtrTy = getPointerType(getCanonicalType(
1476         getQualifiedType(VoidTy.getUnqualifiedType(), Q)));
1477   } else {
1478     VoidPtrTy = getPointerType(VoidTy);
1479   }
1480 
1481   // nullptr type (C++0x 2.14.7)
1482   InitBuiltinType(NullPtrTy,           BuiltinType::NullPtr);
1483 
1484   // half type (OpenCL 6.1.1.1) / ARM NEON __fp16
1485   InitBuiltinType(HalfTy, BuiltinType::Half);
1486 
1487   InitBuiltinType(BFloat16Ty, BuiltinType::BFloat16);
1488 
1489   // Builtin type used to help define __builtin_va_list.
1490   VaListTagDecl = nullptr;
1491 
1492   // MSVC predeclares struct _GUID, and we need it to create MSGuidDecls.
1493   if (LangOpts.MicrosoftExt || LangOpts.Borland) {
1494     MSGuidTagDecl = buildImplicitRecord("_GUID");
1495     getTranslationUnitDecl()->addDecl(MSGuidTagDecl);
1496   }
1497 }
1498 
1499 DiagnosticsEngine &ASTContext::getDiagnostics() const {
1500   return SourceMgr.getDiagnostics();
1501 }
1502 
1503 AttrVec& ASTContext::getDeclAttrs(const Decl *D) {
1504   AttrVec *&Result = DeclAttrs[D];
1505   if (!Result) {
1506     void *Mem = Allocate(sizeof(AttrVec));
1507     Result = new (Mem) AttrVec;
1508   }
1509 
1510   return *Result;
1511 }
1512 
1513 /// Erase the attributes corresponding to the given declaration.
1514 void ASTContext::eraseDeclAttrs(const Decl *D) {
1515   llvm::DenseMap<const Decl*, AttrVec*>::iterator Pos = DeclAttrs.find(D);
1516   if (Pos != DeclAttrs.end()) {
1517     Pos->second->~AttrVec();
1518     DeclAttrs.erase(Pos);
1519   }
1520 }
1521 
1522 // FIXME: Remove ?
1523 MemberSpecializationInfo *
1524 ASTContext::getInstantiatedFromStaticDataMember(const VarDecl *Var) {
1525   assert(Var->isStaticDataMember() && "Not a static data member");
1526   return getTemplateOrSpecializationInfo(Var)
1527       .dyn_cast<MemberSpecializationInfo *>();
1528 }
1529 
1530 ASTContext::TemplateOrSpecializationInfo
1531 ASTContext::getTemplateOrSpecializationInfo(const VarDecl *Var) {
1532   llvm::DenseMap<const VarDecl *, TemplateOrSpecializationInfo>::iterator Pos =
1533       TemplateOrInstantiation.find(Var);
1534   if (Pos == TemplateOrInstantiation.end())
1535     return {};
1536 
1537   return Pos->second;
1538 }
1539 
1540 void
1541 ASTContext::setInstantiatedFromStaticDataMember(VarDecl *Inst, VarDecl *Tmpl,
1542                                                 TemplateSpecializationKind TSK,
1543                                           SourceLocation PointOfInstantiation) {
1544   assert(Inst->isStaticDataMember() && "Not a static data member");
1545   assert(Tmpl->isStaticDataMember() && "Not a static data member");
1546   setTemplateOrSpecializationInfo(Inst, new (*this) MemberSpecializationInfo(
1547                                             Tmpl, TSK, PointOfInstantiation));
1548 }
1549 
1550 void
1551 ASTContext::setTemplateOrSpecializationInfo(VarDecl *Inst,
1552                                             TemplateOrSpecializationInfo TSI) {
1553   assert(!TemplateOrInstantiation[Inst] &&
1554          "Already noted what the variable was instantiated from");
1555   TemplateOrInstantiation[Inst] = TSI;
1556 }
1557 
1558 NamedDecl *
1559 ASTContext::getInstantiatedFromUsingDecl(NamedDecl *UUD) {
1560   auto Pos = InstantiatedFromUsingDecl.find(UUD);
1561   if (Pos == InstantiatedFromUsingDecl.end())
1562     return nullptr;
1563 
1564   return Pos->second;
1565 }
1566 
1567 void
1568 ASTContext::setInstantiatedFromUsingDecl(NamedDecl *Inst, NamedDecl *Pattern) {
1569   assert((isa<UsingDecl>(Pattern) ||
1570           isa<UnresolvedUsingValueDecl>(Pattern) ||
1571           isa<UnresolvedUsingTypenameDecl>(Pattern)) &&
1572          "pattern decl is not a using decl");
1573   assert((isa<UsingDecl>(Inst) ||
1574           isa<UnresolvedUsingValueDecl>(Inst) ||
1575           isa<UnresolvedUsingTypenameDecl>(Inst)) &&
1576          "instantiation did not produce a using decl");
1577   assert(!InstantiatedFromUsingDecl[Inst] && "pattern already exists");
1578   InstantiatedFromUsingDecl[Inst] = Pattern;
1579 }
1580 
1581 UsingEnumDecl *
1582 ASTContext::getInstantiatedFromUsingEnumDecl(UsingEnumDecl *UUD) {
1583   auto Pos = InstantiatedFromUsingEnumDecl.find(UUD);
1584   if (Pos == InstantiatedFromUsingEnumDecl.end())
1585     return nullptr;
1586 
1587   return Pos->second;
1588 }
1589 
1590 void ASTContext::setInstantiatedFromUsingEnumDecl(UsingEnumDecl *Inst,
1591                                                   UsingEnumDecl *Pattern) {
1592   assert(!InstantiatedFromUsingEnumDecl[Inst] && "pattern already exists");
1593   InstantiatedFromUsingEnumDecl[Inst] = Pattern;
1594 }
1595 
1596 UsingShadowDecl *
1597 ASTContext::getInstantiatedFromUsingShadowDecl(UsingShadowDecl *Inst) {
1598   llvm::DenseMap<UsingShadowDecl*, UsingShadowDecl*>::const_iterator Pos
1599     = InstantiatedFromUsingShadowDecl.find(Inst);
1600   if (Pos == InstantiatedFromUsingShadowDecl.end())
1601     return nullptr;
1602 
1603   return Pos->second;
1604 }
1605 
1606 void
1607 ASTContext::setInstantiatedFromUsingShadowDecl(UsingShadowDecl *Inst,
1608                                                UsingShadowDecl *Pattern) {
1609   assert(!InstantiatedFromUsingShadowDecl[Inst] && "pattern already exists");
1610   InstantiatedFromUsingShadowDecl[Inst] = Pattern;
1611 }
1612 
1613 FieldDecl *ASTContext::getInstantiatedFromUnnamedFieldDecl(FieldDecl *Field) {
1614   llvm::DenseMap<FieldDecl *, FieldDecl *>::iterator Pos
1615     = InstantiatedFromUnnamedFieldDecl.find(Field);
1616   if (Pos == InstantiatedFromUnnamedFieldDecl.end())
1617     return nullptr;
1618 
1619   return Pos->second;
1620 }
1621 
1622 void ASTContext::setInstantiatedFromUnnamedFieldDecl(FieldDecl *Inst,
1623                                                      FieldDecl *Tmpl) {
1624   assert(!Inst->getDeclName() && "Instantiated field decl is not unnamed");
1625   assert(!Tmpl->getDeclName() && "Template field decl is not unnamed");
1626   assert(!InstantiatedFromUnnamedFieldDecl[Inst] &&
1627          "Already noted what unnamed field was instantiated from");
1628 
1629   InstantiatedFromUnnamedFieldDecl[Inst] = Tmpl;
1630 }
1631 
1632 ASTContext::overridden_cxx_method_iterator
1633 ASTContext::overridden_methods_begin(const CXXMethodDecl *Method) const {
1634   return overridden_methods(Method).begin();
1635 }
1636 
1637 ASTContext::overridden_cxx_method_iterator
1638 ASTContext::overridden_methods_end(const CXXMethodDecl *Method) const {
1639   return overridden_methods(Method).end();
1640 }
1641 
1642 unsigned
1643 ASTContext::overridden_methods_size(const CXXMethodDecl *Method) const {
1644   auto Range = overridden_methods(Method);
1645   return Range.end() - Range.begin();
1646 }
1647 
1648 ASTContext::overridden_method_range
1649 ASTContext::overridden_methods(const CXXMethodDecl *Method) const {
1650   llvm::DenseMap<const CXXMethodDecl *, CXXMethodVector>::const_iterator Pos =
1651       OverriddenMethods.find(Method->getCanonicalDecl());
1652   if (Pos == OverriddenMethods.end())
1653     return overridden_method_range(nullptr, nullptr);
1654   return overridden_method_range(Pos->second.begin(), Pos->second.end());
1655 }
1656 
1657 void ASTContext::addOverriddenMethod(const CXXMethodDecl *Method,
1658                                      const CXXMethodDecl *Overridden) {
1659   assert(Method->isCanonicalDecl() && Overridden->isCanonicalDecl());
1660   OverriddenMethods[Method].push_back(Overridden);
1661 }
1662 
1663 void ASTContext::getOverriddenMethods(
1664                       const NamedDecl *D,
1665                       SmallVectorImpl<const NamedDecl *> &Overridden) const {
1666   assert(D);
1667 
1668   if (const auto *CXXMethod = dyn_cast<CXXMethodDecl>(D)) {
1669     Overridden.append(overridden_methods_begin(CXXMethod),
1670                       overridden_methods_end(CXXMethod));
1671     return;
1672   }
1673 
1674   const auto *Method = dyn_cast<ObjCMethodDecl>(D);
1675   if (!Method)
1676     return;
1677 
1678   SmallVector<const ObjCMethodDecl *, 8> OverDecls;
1679   Method->getOverriddenMethods(OverDecls);
1680   Overridden.append(OverDecls.begin(), OverDecls.end());
1681 }
1682 
1683 void ASTContext::addedLocalImportDecl(ImportDecl *Import) {
1684   assert(!Import->getNextLocalImport() &&
1685          "Import declaration already in the chain");
1686   assert(!Import->isFromASTFile() && "Non-local import declaration");
1687   if (!FirstLocalImport) {
1688     FirstLocalImport = Import;
1689     LastLocalImport = Import;
1690     return;
1691   }
1692 
1693   LastLocalImport->setNextLocalImport(Import);
1694   LastLocalImport = Import;
1695 }
1696 
1697 //===----------------------------------------------------------------------===//
1698 //                         Type Sizing and Analysis
1699 //===----------------------------------------------------------------------===//
1700 
1701 /// getFloatTypeSemantics - Return the APFloat 'semantics' for the specified
1702 /// scalar floating point type.
1703 const llvm::fltSemantics &ASTContext::getFloatTypeSemantics(QualType T) const {
1704   switch (T->castAs<BuiltinType>()->getKind()) {
1705   default:
1706     llvm_unreachable("Not a floating point type!");
1707   case BuiltinType::BFloat16:
1708     return Target->getBFloat16Format();
1709   case BuiltinType::Float16:
1710   case BuiltinType::Half:
1711     return Target->getHalfFormat();
1712   case BuiltinType::Float:      return Target->getFloatFormat();
1713   case BuiltinType::Double:     return Target->getDoubleFormat();
1714   case BuiltinType::Ibm128:
1715     return Target->getIbm128Format();
1716   case BuiltinType::LongDouble:
1717     if (getLangOpts().OpenMP && getLangOpts().OpenMPIsDevice)
1718       return AuxTarget->getLongDoubleFormat();
1719     return Target->getLongDoubleFormat();
1720   case BuiltinType::Float128:
1721     if (getLangOpts().OpenMP && getLangOpts().OpenMPIsDevice)
1722       return AuxTarget->getFloat128Format();
1723     return Target->getFloat128Format();
1724   }
1725 }
1726 
1727 CharUnits ASTContext::getDeclAlign(const Decl *D, bool ForAlignof) const {
1728   unsigned Align = Target->getCharWidth();
1729 
1730   bool UseAlignAttrOnly = false;
1731   if (unsigned AlignFromAttr = D->getMaxAlignment()) {
1732     Align = AlignFromAttr;
1733 
1734     // __attribute__((aligned)) can increase or decrease alignment
1735     // *except* on a struct or struct member, where it only increases
1736     // alignment unless 'packed' is also specified.
1737     //
1738     // It is an error for alignas to decrease alignment, so we can
1739     // ignore that possibility;  Sema should diagnose it.
1740     if (isa<FieldDecl>(D)) {
1741       UseAlignAttrOnly = D->hasAttr<PackedAttr>() ||
1742         cast<FieldDecl>(D)->getParent()->hasAttr<PackedAttr>();
1743     } else {
1744       UseAlignAttrOnly = true;
1745     }
1746   }
1747   else if (isa<FieldDecl>(D))
1748       UseAlignAttrOnly =
1749         D->hasAttr<PackedAttr>() ||
1750         cast<FieldDecl>(D)->getParent()->hasAttr<PackedAttr>();
1751 
1752   // If we're using the align attribute only, just ignore everything
1753   // else about the declaration and its type.
1754   if (UseAlignAttrOnly) {
1755     // do nothing
1756   } else if (const auto *VD = dyn_cast<ValueDecl>(D)) {
1757     QualType T = VD->getType();
1758     if (const auto *RT = T->getAs<ReferenceType>()) {
1759       if (ForAlignof)
1760         T = RT->getPointeeType();
1761       else
1762         T = getPointerType(RT->getPointeeType());
1763     }
1764     QualType BaseT = getBaseElementType(T);
1765     if (T->isFunctionType())
1766       Align = getTypeInfoImpl(T.getTypePtr()).Align;
1767     else if (!BaseT->isIncompleteType()) {
1768       // Adjust alignments of declarations with array type by the
1769       // large-array alignment on the target.
1770       if (const ArrayType *arrayType = getAsArrayType(T)) {
1771         unsigned MinWidth = Target->getLargeArrayMinWidth();
1772         if (!ForAlignof && MinWidth) {
1773           if (isa<VariableArrayType>(arrayType))
1774             Align = std::max(Align, Target->getLargeArrayAlign());
1775           else if (isa<ConstantArrayType>(arrayType) &&
1776                    MinWidth <= getTypeSize(cast<ConstantArrayType>(arrayType)))
1777             Align = std::max(Align, Target->getLargeArrayAlign());
1778         }
1779       }
1780       Align = std::max(Align, getPreferredTypeAlign(T.getTypePtr()));
1781       if (BaseT.getQualifiers().hasUnaligned())
1782         Align = Target->getCharWidth();
1783       if (const auto *VD = dyn_cast<VarDecl>(D)) {
1784         if (VD->hasGlobalStorage() && !ForAlignof) {
1785           uint64_t TypeSize = getTypeSize(T.getTypePtr());
1786           Align = std::max(Align, getTargetInfo().getMinGlobalAlign(TypeSize));
1787         }
1788       }
1789     }
1790 
1791     // Fields can be subject to extra alignment constraints, like if
1792     // the field is packed, the struct is packed, or the struct has a
1793     // a max-field-alignment constraint (#pragma pack).  So calculate
1794     // the actual alignment of the field within the struct, and then
1795     // (as we're expected to) constrain that by the alignment of the type.
1796     if (const auto *Field = dyn_cast<FieldDecl>(VD)) {
1797       const RecordDecl *Parent = Field->getParent();
1798       // We can only produce a sensible answer if the record is valid.
1799       if (!Parent->isInvalidDecl()) {
1800         const ASTRecordLayout &Layout = getASTRecordLayout(Parent);
1801 
1802         // Start with the record's overall alignment.
1803         unsigned FieldAlign = toBits(Layout.getAlignment());
1804 
1805         // Use the GCD of that and the offset within the record.
1806         uint64_t Offset = Layout.getFieldOffset(Field->getFieldIndex());
1807         if (Offset > 0) {
1808           // Alignment is always a power of 2, so the GCD will be a power of 2,
1809           // which means we get to do this crazy thing instead of Euclid's.
1810           uint64_t LowBitOfOffset = Offset & (~Offset + 1);
1811           if (LowBitOfOffset < FieldAlign)
1812             FieldAlign = static_cast<unsigned>(LowBitOfOffset);
1813         }
1814 
1815         Align = std::min(Align, FieldAlign);
1816       }
1817     }
1818   }
1819 
1820   // Some targets have hard limitation on the maximum requestable alignment in
1821   // aligned attribute for static variables.
1822   const unsigned MaxAlignedAttr = getTargetInfo().getMaxAlignedAttribute();
1823   const auto *VD = dyn_cast<VarDecl>(D);
1824   if (MaxAlignedAttr && VD && VD->getStorageClass() == SC_Static)
1825     Align = std::min(Align, MaxAlignedAttr);
1826 
1827   return toCharUnitsFromBits(Align);
1828 }
1829 
1830 CharUnits ASTContext::getExnObjectAlignment() const {
1831   return toCharUnitsFromBits(Target->getExnObjectAlignment());
1832 }
1833 
1834 // getTypeInfoDataSizeInChars - Return the size of a type, in
1835 // chars. If the type is a record, its data size is returned.  This is
1836 // the size of the memcpy that's performed when assigning this type
1837 // using a trivial copy/move assignment operator.
1838 TypeInfoChars ASTContext::getTypeInfoDataSizeInChars(QualType T) const {
1839   TypeInfoChars Info = getTypeInfoInChars(T);
1840 
1841   // In C++, objects can sometimes be allocated into the tail padding
1842   // of a base-class subobject.  We decide whether that's possible
1843   // during class layout, so here we can just trust the layout results.
1844   if (getLangOpts().CPlusPlus) {
1845     if (const auto *RT = T->getAs<RecordType>()) {
1846       const ASTRecordLayout &layout = getASTRecordLayout(RT->getDecl());
1847       Info.Width = layout.getDataSize();
1848     }
1849   }
1850 
1851   return Info;
1852 }
1853 
1854 /// getConstantArrayInfoInChars - Performing the computation in CharUnits
1855 /// instead of in bits prevents overflowing the uint64_t for some large arrays.
1856 TypeInfoChars
1857 static getConstantArrayInfoInChars(const ASTContext &Context,
1858                                    const ConstantArrayType *CAT) {
1859   TypeInfoChars EltInfo = Context.getTypeInfoInChars(CAT->getElementType());
1860   uint64_t Size = CAT->getSize().getZExtValue();
1861   assert((Size == 0 || static_cast<uint64_t>(EltInfo.Width.getQuantity()) <=
1862               (uint64_t)(-1)/Size) &&
1863          "Overflow in array type char size evaluation");
1864   uint64_t Width = EltInfo.Width.getQuantity() * Size;
1865   unsigned Align = EltInfo.Align.getQuantity();
1866   if (!Context.getTargetInfo().getCXXABI().isMicrosoft() ||
1867       Context.getTargetInfo().getPointerWidth(0) == 64)
1868     Width = llvm::alignTo(Width, Align);
1869   return TypeInfoChars(CharUnits::fromQuantity(Width),
1870                        CharUnits::fromQuantity(Align),
1871                        EltInfo.AlignRequirement);
1872 }
1873 
1874 TypeInfoChars ASTContext::getTypeInfoInChars(const Type *T) const {
1875   if (const auto *CAT = dyn_cast<ConstantArrayType>(T))
1876     return getConstantArrayInfoInChars(*this, CAT);
1877   TypeInfo Info = getTypeInfo(T);
1878   return TypeInfoChars(toCharUnitsFromBits(Info.Width),
1879                        toCharUnitsFromBits(Info.Align), Info.AlignRequirement);
1880 }
1881 
1882 TypeInfoChars ASTContext::getTypeInfoInChars(QualType T) const {
1883   return getTypeInfoInChars(T.getTypePtr());
1884 }
1885 
1886 bool ASTContext::isAlignmentRequired(const Type *T) const {
1887   return getTypeInfo(T).AlignRequirement != AlignRequirementKind::None;
1888 }
1889 
1890 bool ASTContext::isAlignmentRequired(QualType T) const {
1891   return isAlignmentRequired(T.getTypePtr());
1892 }
1893 
1894 unsigned ASTContext::getTypeAlignIfKnown(QualType T,
1895                                          bool NeedsPreferredAlignment) const {
1896   // An alignment on a typedef overrides anything else.
1897   if (const auto *TT = T->getAs<TypedefType>())
1898     if (unsigned Align = TT->getDecl()->getMaxAlignment())
1899       return Align;
1900 
1901   // If we have an (array of) complete type, we're done.
1902   T = getBaseElementType(T);
1903   if (!T->isIncompleteType())
1904     return NeedsPreferredAlignment ? getPreferredTypeAlign(T) : getTypeAlign(T);
1905 
1906   // If we had an array type, its element type might be a typedef
1907   // type with an alignment attribute.
1908   if (const auto *TT = T->getAs<TypedefType>())
1909     if (unsigned Align = TT->getDecl()->getMaxAlignment())
1910       return Align;
1911 
1912   // Otherwise, see if the declaration of the type had an attribute.
1913   if (const auto *TT = T->getAs<TagType>())
1914     return TT->getDecl()->getMaxAlignment();
1915 
1916   return 0;
1917 }
1918 
1919 TypeInfo ASTContext::getTypeInfo(const Type *T) const {
1920   TypeInfoMap::iterator I = MemoizedTypeInfo.find(T);
1921   if (I != MemoizedTypeInfo.end())
1922     return I->second;
1923 
1924   // This call can invalidate MemoizedTypeInfo[T], so we need a second lookup.
1925   TypeInfo TI = getTypeInfoImpl(T);
1926   MemoizedTypeInfo[T] = TI;
1927   return TI;
1928 }
1929 
1930 /// getTypeInfoImpl - Return the size of the specified type, in bits.  This
1931 /// method does not work on incomplete types.
1932 ///
1933 /// FIXME: Pointers into different addr spaces could have different sizes and
1934 /// alignment requirements: getPointerInfo should take an AddrSpace, this
1935 /// should take a QualType, &c.
1936 TypeInfo ASTContext::getTypeInfoImpl(const Type *T) const {
1937   uint64_t Width = 0;
1938   unsigned Align = 8;
1939   AlignRequirementKind AlignRequirement = AlignRequirementKind::None;
1940   unsigned AS = 0;
1941   switch (T->getTypeClass()) {
1942 #define TYPE(Class, Base)
1943 #define ABSTRACT_TYPE(Class, Base)
1944 #define NON_CANONICAL_TYPE(Class, Base)
1945 #define DEPENDENT_TYPE(Class, Base) case Type::Class:
1946 #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base)                       \
1947   case Type::Class:                                                            \
1948   assert(!T->isDependentType() && "should not see dependent types here");      \
1949   return getTypeInfo(cast<Class##Type>(T)->desugar().getTypePtr());
1950 #include "clang/AST/TypeNodes.inc"
1951     llvm_unreachable("Should not see dependent types");
1952 
1953   case Type::FunctionNoProto:
1954   case Type::FunctionProto:
1955     // GCC extension: alignof(function) = 32 bits
1956     Width = 0;
1957     Align = 32;
1958     break;
1959 
1960   case Type::IncompleteArray:
1961   case Type::VariableArray:
1962   case Type::ConstantArray: {
1963     // Model non-constant sized arrays as size zero, but track the alignment.
1964     uint64_t Size = 0;
1965     if (const auto *CAT = dyn_cast<ConstantArrayType>(T))
1966       Size = CAT->getSize().getZExtValue();
1967 
1968     TypeInfo EltInfo = getTypeInfo(cast<ArrayType>(T)->getElementType());
1969     assert((Size == 0 || EltInfo.Width <= (uint64_t)(-1) / Size) &&
1970            "Overflow in array type bit size evaluation");
1971     Width = EltInfo.Width * Size;
1972     Align = EltInfo.Align;
1973     AlignRequirement = EltInfo.AlignRequirement;
1974     if (!getTargetInfo().getCXXABI().isMicrosoft() ||
1975         getTargetInfo().getPointerWidth(0) == 64)
1976       Width = llvm::alignTo(Width, Align);
1977     break;
1978   }
1979 
1980   case Type::ExtVector:
1981   case Type::Vector: {
1982     const auto *VT = cast<VectorType>(T);
1983     TypeInfo EltInfo = getTypeInfo(VT->getElementType());
1984     Width = EltInfo.Width * VT->getNumElements();
1985     Align = Width;
1986     // If the alignment is not a power of 2, round up to the next power of 2.
1987     // This happens for non-power-of-2 length vectors.
1988     if (Align & (Align-1)) {
1989       Align = llvm::NextPowerOf2(Align);
1990       Width = llvm::alignTo(Width, Align);
1991     }
1992     // Adjust the alignment based on the target max.
1993     uint64_t TargetVectorAlign = Target->getMaxVectorAlign();
1994     if (TargetVectorAlign && TargetVectorAlign < Align)
1995       Align = TargetVectorAlign;
1996     if (VT->getVectorKind() == VectorType::SveFixedLengthDataVector)
1997       // Adjust the alignment for fixed-length SVE vectors. This is important
1998       // for non-power-of-2 vector lengths.
1999       Align = 128;
2000     else if (VT->getVectorKind() == VectorType::SveFixedLengthPredicateVector)
2001       // Adjust the alignment for fixed-length SVE predicates.
2002       Align = 16;
2003     break;
2004   }
2005 
2006   case Type::ConstantMatrix: {
2007     const auto *MT = cast<ConstantMatrixType>(T);
2008     TypeInfo ElementInfo = getTypeInfo(MT->getElementType());
2009     // The internal layout of a matrix value is implementation defined.
2010     // Initially be ABI compatible with arrays with respect to alignment and
2011     // size.
2012     Width = ElementInfo.Width * MT->getNumRows() * MT->getNumColumns();
2013     Align = ElementInfo.Align;
2014     break;
2015   }
2016 
2017   case Type::Builtin:
2018     switch (cast<BuiltinType>(T)->getKind()) {
2019     default: llvm_unreachable("Unknown builtin type!");
2020     case BuiltinType::Void:
2021       // GCC extension: alignof(void) = 8 bits.
2022       Width = 0;
2023       Align = 8;
2024       break;
2025     case BuiltinType::Bool:
2026       Width = Target->getBoolWidth();
2027       Align = Target->getBoolAlign();
2028       break;
2029     case BuiltinType::Char_S:
2030     case BuiltinType::Char_U:
2031     case BuiltinType::UChar:
2032     case BuiltinType::SChar:
2033     case BuiltinType::Char8:
2034       Width = Target->getCharWidth();
2035       Align = Target->getCharAlign();
2036       break;
2037     case BuiltinType::WChar_S:
2038     case BuiltinType::WChar_U:
2039       Width = Target->getWCharWidth();
2040       Align = Target->getWCharAlign();
2041       break;
2042     case BuiltinType::Char16:
2043       Width = Target->getChar16Width();
2044       Align = Target->getChar16Align();
2045       break;
2046     case BuiltinType::Char32:
2047       Width = Target->getChar32Width();
2048       Align = Target->getChar32Align();
2049       break;
2050     case BuiltinType::UShort:
2051     case BuiltinType::Short:
2052       Width = Target->getShortWidth();
2053       Align = Target->getShortAlign();
2054       break;
2055     case BuiltinType::UInt:
2056     case BuiltinType::Int:
2057       Width = Target->getIntWidth();
2058       Align = Target->getIntAlign();
2059       break;
2060     case BuiltinType::ULong:
2061     case BuiltinType::Long:
2062       Width = Target->getLongWidth();
2063       Align = Target->getLongAlign();
2064       break;
2065     case BuiltinType::ULongLong:
2066     case BuiltinType::LongLong:
2067       Width = Target->getLongLongWidth();
2068       Align = Target->getLongLongAlign();
2069       break;
2070     case BuiltinType::Int128:
2071     case BuiltinType::UInt128:
2072       Width = 128;
2073       Align = 128; // int128_t is 128-bit aligned on all targets.
2074       break;
2075     case BuiltinType::ShortAccum:
2076     case BuiltinType::UShortAccum:
2077     case BuiltinType::SatShortAccum:
2078     case BuiltinType::SatUShortAccum:
2079       Width = Target->getShortAccumWidth();
2080       Align = Target->getShortAccumAlign();
2081       break;
2082     case BuiltinType::Accum:
2083     case BuiltinType::UAccum:
2084     case BuiltinType::SatAccum:
2085     case BuiltinType::SatUAccum:
2086       Width = Target->getAccumWidth();
2087       Align = Target->getAccumAlign();
2088       break;
2089     case BuiltinType::LongAccum:
2090     case BuiltinType::ULongAccum:
2091     case BuiltinType::SatLongAccum:
2092     case BuiltinType::SatULongAccum:
2093       Width = Target->getLongAccumWidth();
2094       Align = Target->getLongAccumAlign();
2095       break;
2096     case BuiltinType::ShortFract:
2097     case BuiltinType::UShortFract:
2098     case BuiltinType::SatShortFract:
2099     case BuiltinType::SatUShortFract:
2100       Width = Target->getShortFractWidth();
2101       Align = Target->getShortFractAlign();
2102       break;
2103     case BuiltinType::Fract:
2104     case BuiltinType::UFract:
2105     case BuiltinType::SatFract:
2106     case BuiltinType::SatUFract:
2107       Width = Target->getFractWidth();
2108       Align = Target->getFractAlign();
2109       break;
2110     case BuiltinType::LongFract:
2111     case BuiltinType::ULongFract:
2112     case BuiltinType::SatLongFract:
2113     case BuiltinType::SatULongFract:
2114       Width = Target->getLongFractWidth();
2115       Align = Target->getLongFractAlign();
2116       break;
2117     case BuiltinType::BFloat16:
2118       Width = Target->getBFloat16Width();
2119       Align = Target->getBFloat16Align();
2120       break;
2121     case BuiltinType::Float16:
2122     case BuiltinType::Half:
2123       if (Target->hasFloat16Type() || !getLangOpts().OpenMP ||
2124           !getLangOpts().OpenMPIsDevice) {
2125         Width = Target->getHalfWidth();
2126         Align = Target->getHalfAlign();
2127       } else {
2128         assert(getLangOpts().OpenMP && getLangOpts().OpenMPIsDevice &&
2129                "Expected OpenMP device compilation.");
2130         Width = AuxTarget->getHalfWidth();
2131         Align = AuxTarget->getHalfAlign();
2132       }
2133       break;
2134     case BuiltinType::Float:
2135       Width = Target->getFloatWidth();
2136       Align = Target->getFloatAlign();
2137       break;
2138     case BuiltinType::Double:
2139       Width = Target->getDoubleWidth();
2140       Align = Target->getDoubleAlign();
2141       break;
2142     case BuiltinType::Ibm128:
2143       Width = Target->getIbm128Width();
2144       Align = Target->getIbm128Align();
2145       break;
2146     case BuiltinType::LongDouble:
2147       if (getLangOpts().OpenMP && getLangOpts().OpenMPIsDevice &&
2148           (Target->getLongDoubleWidth() != AuxTarget->getLongDoubleWidth() ||
2149            Target->getLongDoubleAlign() != AuxTarget->getLongDoubleAlign())) {
2150         Width = AuxTarget->getLongDoubleWidth();
2151         Align = AuxTarget->getLongDoubleAlign();
2152       } else {
2153         Width = Target->getLongDoubleWidth();
2154         Align = Target->getLongDoubleAlign();
2155       }
2156       break;
2157     case BuiltinType::Float128:
2158       if (Target->hasFloat128Type() || !getLangOpts().OpenMP ||
2159           !getLangOpts().OpenMPIsDevice) {
2160         Width = Target->getFloat128Width();
2161         Align = Target->getFloat128Align();
2162       } else {
2163         assert(getLangOpts().OpenMP && getLangOpts().OpenMPIsDevice &&
2164                "Expected OpenMP device compilation.");
2165         Width = AuxTarget->getFloat128Width();
2166         Align = AuxTarget->getFloat128Align();
2167       }
2168       break;
2169     case BuiltinType::NullPtr:
2170       Width = Target->getPointerWidth(0); // C++ 3.9.1p11: sizeof(nullptr_t)
2171       Align = Target->getPointerAlign(0); //   == sizeof(void*)
2172       break;
2173     case BuiltinType::ObjCId:
2174     case BuiltinType::ObjCClass:
2175     case BuiltinType::ObjCSel:
2176       Width = Target->getPointerWidth(0);
2177       Align = Target->getPointerAlign(0);
2178       break;
2179     case BuiltinType::OCLSampler:
2180     case BuiltinType::OCLEvent:
2181     case BuiltinType::OCLClkEvent:
2182     case BuiltinType::OCLQueue:
2183     case BuiltinType::OCLReserveID:
2184 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
2185     case BuiltinType::Id:
2186 #include "clang/Basic/OpenCLImageTypes.def"
2187 #define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
2188   case BuiltinType::Id:
2189 #include "clang/Basic/OpenCLExtensionTypes.def"
2190       AS = getTargetAddressSpace(
2191           Target->getOpenCLTypeAddrSpace(getOpenCLTypeKind(T)));
2192       Width = Target->getPointerWidth(AS);
2193       Align = Target->getPointerAlign(AS);
2194       break;
2195     // The SVE types are effectively target-specific.  The length of an
2196     // SVE_VECTOR_TYPE is only known at runtime, but it is always a multiple
2197     // of 128 bits.  There is one predicate bit for each vector byte, so the
2198     // length of an SVE_PREDICATE_TYPE is always a multiple of 16 bits.
2199     //
2200     // Because the length is only known at runtime, we use a dummy value
2201     // of 0 for the static length.  The alignment values are those defined
2202     // by the Procedure Call Standard for the Arm Architecture.
2203 #define SVE_VECTOR_TYPE(Name, MangledName, Id, SingletonId, NumEls, ElBits,    \
2204                         IsSigned, IsFP, IsBF)                                  \
2205   case BuiltinType::Id:                                                        \
2206     Width = 0;                                                                 \
2207     Align = 128;                                                               \
2208     break;
2209 #define SVE_PREDICATE_TYPE(Name, MangledName, Id, SingletonId, NumEls)         \
2210   case BuiltinType::Id:                                                        \
2211     Width = 0;                                                                 \
2212     Align = 16;                                                                \
2213     break;
2214 #include "clang/Basic/AArch64SVEACLETypes.def"
2215 #define PPC_VECTOR_TYPE(Name, Id, Size)                                        \
2216   case BuiltinType::Id:                                                        \
2217     Width = Size;                                                              \
2218     Align = Size;                                                              \
2219     break;
2220 #include "clang/Basic/PPCTypes.def"
2221 #define RVV_VECTOR_TYPE(Name, Id, SingletonId, ElKind, ElBits, NF, IsSigned,   \
2222                         IsFP)                                                  \
2223   case BuiltinType::Id:                                                        \
2224     Width = 0;                                                                 \
2225     Align = ElBits;                                                            \
2226     break;
2227 #define RVV_PREDICATE_TYPE(Name, Id, SingletonId, ElKind)                      \
2228   case BuiltinType::Id:                                                        \
2229     Width = 0;                                                                 \
2230     Align = 8;                                                                 \
2231     break;
2232 #include "clang/Basic/RISCVVTypes.def"
2233     }
2234     break;
2235   case Type::ObjCObjectPointer:
2236     Width = Target->getPointerWidth(0);
2237     Align = Target->getPointerAlign(0);
2238     break;
2239   case Type::BlockPointer:
2240     AS = getTargetAddressSpace(cast<BlockPointerType>(T)->getPointeeType());
2241     Width = Target->getPointerWidth(AS);
2242     Align = Target->getPointerAlign(AS);
2243     break;
2244   case Type::LValueReference:
2245   case Type::RValueReference:
2246     // alignof and sizeof should never enter this code path here, so we go
2247     // the pointer route.
2248     AS = getTargetAddressSpace(cast<ReferenceType>(T)->getPointeeType());
2249     Width = Target->getPointerWidth(AS);
2250     Align = Target->getPointerAlign(AS);
2251     break;
2252   case Type::Pointer:
2253     AS = getTargetAddressSpace(cast<PointerType>(T)->getPointeeType());
2254     Width = Target->getPointerWidth(AS);
2255     Align = Target->getPointerAlign(AS);
2256     break;
2257   case Type::MemberPointer: {
2258     const auto *MPT = cast<MemberPointerType>(T);
2259     CXXABI::MemberPointerInfo MPI = ABI->getMemberPointerInfo(MPT);
2260     Width = MPI.Width;
2261     Align = MPI.Align;
2262     break;
2263   }
2264   case Type::Complex: {
2265     // Complex types have the same alignment as their elements, but twice the
2266     // size.
2267     TypeInfo EltInfo = getTypeInfo(cast<ComplexType>(T)->getElementType());
2268     Width = EltInfo.Width * 2;
2269     Align = EltInfo.Align;
2270     break;
2271   }
2272   case Type::ObjCObject:
2273     return getTypeInfo(cast<ObjCObjectType>(T)->getBaseType().getTypePtr());
2274   case Type::Adjusted:
2275   case Type::Decayed:
2276     return getTypeInfo(cast<AdjustedType>(T)->getAdjustedType().getTypePtr());
2277   case Type::ObjCInterface: {
2278     const auto *ObjCI = cast<ObjCInterfaceType>(T);
2279     if (ObjCI->getDecl()->isInvalidDecl()) {
2280       Width = 8;
2281       Align = 8;
2282       break;
2283     }
2284     const ASTRecordLayout &Layout = getASTObjCInterfaceLayout(ObjCI->getDecl());
2285     Width = toBits(Layout.getSize());
2286     Align = toBits(Layout.getAlignment());
2287     break;
2288   }
2289   case Type::ExtInt: {
2290     const auto *EIT = cast<ExtIntType>(T);
2291     Align =
2292         std::min(static_cast<unsigned>(std::max(
2293                      getCharWidth(), llvm::PowerOf2Ceil(EIT->getNumBits()))),
2294                  Target->getLongLongAlign());
2295     Width = llvm::alignTo(EIT->getNumBits(), Align);
2296     break;
2297   }
2298   case Type::Record:
2299   case Type::Enum: {
2300     const auto *TT = cast<TagType>(T);
2301 
2302     if (TT->getDecl()->isInvalidDecl()) {
2303       Width = 8;
2304       Align = 8;
2305       break;
2306     }
2307 
2308     if (const auto *ET = dyn_cast<EnumType>(TT)) {
2309       const EnumDecl *ED = ET->getDecl();
2310       TypeInfo Info =
2311           getTypeInfo(ED->getIntegerType()->getUnqualifiedDesugaredType());
2312       if (unsigned AttrAlign = ED->getMaxAlignment()) {
2313         Info.Align = AttrAlign;
2314         Info.AlignRequirement = AlignRequirementKind::RequiredByEnum;
2315       }
2316       return Info;
2317     }
2318 
2319     const auto *RT = cast<RecordType>(TT);
2320     const RecordDecl *RD = RT->getDecl();
2321     const ASTRecordLayout &Layout = getASTRecordLayout(RD);
2322     Width = toBits(Layout.getSize());
2323     Align = toBits(Layout.getAlignment());
2324     AlignRequirement = RD->hasAttr<AlignedAttr>()
2325                            ? AlignRequirementKind::RequiredByRecord
2326                            : AlignRequirementKind::None;
2327     break;
2328   }
2329 
2330   case Type::SubstTemplateTypeParm:
2331     return getTypeInfo(cast<SubstTemplateTypeParmType>(T)->
2332                        getReplacementType().getTypePtr());
2333 
2334   case Type::Auto:
2335   case Type::DeducedTemplateSpecialization: {
2336     const auto *A = cast<DeducedType>(T);
2337     assert(!A->getDeducedType().isNull() &&
2338            "cannot request the size of an undeduced or dependent auto type");
2339     return getTypeInfo(A->getDeducedType().getTypePtr());
2340   }
2341 
2342   case Type::Paren:
2343     return getTypeInfo(cast<ParenType>(T)->getInnerType().getTypePtr());
2344 
2345   case Type::MacroQualified:
2346     return getTypeInfo(
2347         cast<MacroQualifiedType>(T)->getUnderlyingType().getTypePtr());
2348 
2349   case Type::ObjCTypeParam:
2350     return getTypeInfo(cast<ObjCTypeParamType>(T)->desugar().getTypePtr());
2351 
2352   case Type::Typedef: {
2353     const TypedefNameDecl *Typedef = cast<TypedefType>(T)->getDecl();
2354     TypeInfo Info = getTypeInfo(Typedef->getUnderlyingType().getTypePtr());
2355     // If the typedef has an aligned attribute on it, it overrides any computed
2356     // alignment we have.  This violates the GCC documentation (which says that
2357     // attribute(aligned) can only round up) but matches its implementation.
2358     if (unsigned AttrAlign = Typedef->getMaxAlignment()) {
2359       Align = AttrAlign;
2360       AlignRequirement = AlignRequirementKind::RequiredByTypedef;
2361     } else {
2362       Align = Info.Align;
2363       AlignRequirement = Info.AlignRequirement;
2364     }
2365     Width = Info.Width;
2366     break;
2367   }
2368 
2369   case Type::Elaborated:
2370     return getTypeInfo(cast<ElaboratedType>(T)->getNamedType().getTypePtr());
2371 
2372   case Type::Attributed:
2373     return getTypeInfo(
2374                   cast<AttributedType>(T)->getEquivalentType().getTypePtr());
2375 
2376   case Type::Atomic: {
2377     // Start with the base type information.
2378     TypeInfo Info = getTypeInfo(cast<AtomicType>(T)->getValueType());
2379     Width = Info.Width;
2380     Align = Info.Align;
2381 
2382     if (!Width) {
2383       // An otherwise zero-sized type should still generate an
2384       // atomic operation.
2385       Width = Target->getCharWidth();
2386       assert(Align);
2387     } else if (Width <= Target->getMaxAtomicPromoteWidth()) {
2388       // If the size of the type doesn't exceed the platform's max
2389       // atomic promotion width, make the size and alignment more
2390       // favorable to atomic operations:
2391 
2392       // Round the size up to a power of 2.
2393       if (!llvm::isPowerOf2_64(Width))
2394         Width = llvm::NextPowerOf2(Width);
2395 
2396       // Set the alignment equal to the size.
2397       Align = static_cast<unsigned>(Width);
2398     }
2399   }
2400   break;
2401 
2402   case Type::Pipe:
2403     Width = Target->getPointerWidth(getTargetAddressSpace(LangAS::opencl_global));
2404     Align = Target->getPointerAlign(getTargetAddressSpace(LangAS::opencl_global));
2405     break;
2406   }
2407 
2408   assert(llvm::isPowerOf2_32(Align) && "Alignment must be power of 2");
2409   return TypeInfo(Width, Align, AlignRequirement);
2410 }
2411 
2412 unsigned ASTContext::getTypeUnadjustedAlign(const Type *T) const {
2413   UnadjustedAlignMap::iterator I = MemoizedUnadjustedAlign.find(T);
2414   if (I != MemoizedUnadjustedAlign.end())
2415     return I->second;
2416 
2417   unsigned UnadjustedAlign;
2418   if (const auto *RT = T->getAs<RecordType>()) {
2419     const RecordDecl *RD = RT->getDecl();
2420     const ASTRecordLayout &Layout = getASTRecordLayout(RD);
2421     UnadjustedAlign = toBits(Layout.getUnadjustedAlignment());
2422   } else if (const auto *ObjCI = T->getAs<ObjCInterfaceType>()) {
2423     const ASTRecordLayout &Layout = getASTObjCInterfaceLayout(ObjCI->getDecl());
2424     UnadjustedAlign = toBits(Layout.getUnadjustedAlignment());
2425   } else {
2426     UnadjustedAlign = getTypeAlign(T->getUnqualifiedDesugaredType());
2427   }
2428 
2429   MemoizedUnadjustedAlign[T] = UnadjustedAlign;
2430   return UnadjustedAlign;
2431 }
2432 
2433 unsigned ASTContext::getOpenMPDefaultSimdAlign(QualType T) const {
2434   unsigned SimdAlign = getTargetInfo().getSimdDefaultAlign();
2435   return SimdAlign;
2436 }
2437 
2438 /// toCharUnitsFromBits - Convert a size in bits to a size in characters.
2439 CharUnits ASTContext::toCharUnitsFromBits(int64_t BitSize) const {
2440   return CharUnits::fromQuantity(BitSize / getCharWidth());
2441 }
2442 
2443 /// toBits - Convert a size in characters to a size in characters.
2444 int64_t ASTContext::toBits(CharUnits CharSize) const {
2445   return CharSize.getQuantity() * getCharWidth();
2446 }
2447 
2448 /// getTypeSizeInChars - Return the size of the specified type, in characters.
2449 /// This method does not work on incomplete types.
2450 CharUnits ASTContext::getTypeSizeInChars(QualType T) const {
2451   return getTypeInfoInChars(T).Width;
2452 }
2453 CharUnits ASTContext::getTypeSizeInChars(const Type *T) const {
2454   return getTypeInfoInChars(T).Width;
2455 }
2456 
2457 /// getTypeAlignInChars - Return the ABI-specified alignment of a type, in
2458 /// characters. This method does not work on incomplete types.
2459 CharUnits ASTContext::getTypeAlignInChars(QualType T) const {
2460   return toCharUnitsFromBits(getTypeAlign(T));
2461 }
2462 CharUnits ASTContext::getTypeAlignInChars(const Type *T) const {
2463   return toCharUnitsFromBits(getTypeAlign(T));
2464 }
2465 
2466 /// getTypeUnadjustedAlignInChars - Return the ABI-specified alignment of a
2467 /// type, in characters, before alignment adustments. This method does
2468 /// not work on incomplete types.
2469 CharUnits ASTContext::getTypeUnadjustedAlignInChars(QualType T) const {
2470   return toCharUnitsFromBits(getTypeUnadjustedAlign(T));
2471 }
2472 CharUnits ASTContext::getTypeUnadjustedAlignInChars(const Type *T) const {
2473   return toCharUnitsFromBits(getTypeUnadjustedAlign(T));
2474 }
2475 
2476 /// getPreferredTypeAlign - Return the "preferred" alignment of the specified
2477 /// type for the current target in bits.  This can be different than the ABI
2478 /// alignment in cases where it is beneficial for performance or backwards
2479 /// compatibility preserving to overalign a data type. (Note: despite the name,
2480 /// the preferred alignment is ABI-impacting, and not an optimization.)
2481 unsigned ASTContext::getPreferredTypeAlign(const Type *T) const {
2482   TypeInfo TI = getTypeInfo(T);
2483   unsigned ABIAlign = TI.Align;
2484 
2485   T = T->getBaseElementTypeUnsafe();
2486 
2487   // The preferred alignment of member pointers is that of a pointer.
2488   if (T->isMemberPointerType())
2489     return getPreferredTypeAlign(getPointerDiffType().getTypePtr());
2490 
2491   if (!Target->allowsLargerPreferedTypeAlignment())
2492     return ABIAlign;
2493 
2494   if (const auto *RT = T->getAs<RecordType>()) {
2495     const RecordDecl *RD = RT->getDecl();
2496 
2497     // When used as part of a typedef, or together with a 'packed' attribute,
2498     // the 'aligned' attribute can be used to decrease alignment. Note that the
2499     // 'packed' case is already taken into consideration when computing the
2500     // alignment, we only need to handle the typedef case here.
2501     if (TI.AlignRequirement == AlignRequirementKind::RequiredByTypedef ||
2502         RD->isInvalidDecl())
2503       return ABIAlign;
2504 
2505     unsigned PreferredAlign = static_cast<unsigned>(
2506         toBits(getASTRecordLayout(RD).PreferredAlignment));
2507     assert(PreferredAlign >= ABIAlign &&
2508            "PreferredAlign should be at least as large as ABIAlign.");
2509     return PreferredAlign;
2510   }
2511 
2512   // Double (and, for targets supporting AIX `power` alignment, long double) and
2513   // long long should be naturally aligned (despite requiring less alignment) if
2514   // possible.
2515   if (const auto *CT = T->getAs<ComplexType>())
2516     T = CT->getElementType().getTypePtr();
2517   if (const auto *ET = T->getAs<EnumType>())
2518     T = ET->getDecl()->getIntegerType().getTypePtr();
2519   if (T->isSpecificBuiltinType(BuiltinType::Double) ||
2520       T->isSpecificBuiltinType(BuiltinType::LongLong) ||
2521       T->isSpecificBuiltinType(BuiltinType::ULongLong) ||
2522       (T->isSpecificBuiltinType(BuiltinType::LongDouble) &&
2523        Target->defaultsToAIXPowerAlignment()))
2524     // Don't increase the alignment if an alignment attribute was specified on a
2525     // typedef declaration.
2526     if (!TI.isAlignRequired())
2527       return std::max(ABIAlign, (unsigned)getTypeSize(T));
2528 
2529   return ABIAlign;
2530 }
2531 
2532 /// getTargetDefaultAlignForAttributeAligned - Return the default alignment
2533 /// for __attribute__((aligned)) on this target, to be used if no alignment
2534 /// value is specified.
2535 unsigned ASTContext::getTargetDefaultAlignForAttributeAligned() const {
2536   return getTargetInfo().getDefaultAlignForAttributeAligned();
2537 }
2538 
2539 /// getAlignOfGlobalVar - Return the alignment in bits that should be given
2540 /// to a global variable of the specified type.
2541 unsigned ASTContext::getAlignOfGlobalVar(QualType T) const {
2542   uint64_t TypeSize = getTypeSize(T.getTypePtr());
2543   return std::max(getPreferredTypeAlign(T),
2544                   getTargetInfo().getMinGlobalAlign(TypeSize));
2545 }
2546 
2547 /// getAlignOfGlobalVarInChars - Return the alignment in characters that
2548 /// should be given to a global variable of the specified type.
2549 CharUnits ASTContext::getAlignOfGlobalVarInChars(QualType T) const {
2550   return toCharUnitsFromBits(getAlignOfGlobalVar(T));
2551 }
2552 
2553 CharUnits ASTContext::getOffsetOfBaseWithVBPtr(const CXXRecordDecl *RD) const {
2554   CharUnits Offset = CharUnits::Zero();
2555   const ASTRecordLayout *Layout = &getASTRecordLayout(RD);
2556   while (const CXXRecordDecl *Base = Layout->getBaseSharingVBPtr()) {
2557     Offset += Layout->getBaseClassOffset(Base);
2558     Layout = &getASTRecordLayout(Base);
2559   }
2560   return Offset;
2561 }
2562 
2563 CharUnits ASTContext::getMemberPointerPathAdjustment(const APValue &MP) const {
2564   const ValueDecl *MPD = MP.getMemberPointerDecl();
2565   CharUnits ThisAdjustment = CharUnits::Zero();
2566   ArrayRef<const CXXRecordDecl*> Path = MP.getMemberPointerPath();
2567   bool DerivedMember = MP.isMemberPointerToDerivedMember();
2568   const CXXRecordDecl *RD = cast<CXXRecordDecl>(MPD->getDeclContext());
2569   for (unsigned I = 0, N = Path.size(); I != N; ++I) {
2570     const CXXRecordDecl *Base = RD;
2571     const CXXRecordDecl *Derived = Path[I];
2572     if (DerivedMember)
2573       std::swap(Base, Derived);
2574     ThisAdjustment += getASTRecordLayout(Derived).getBaseClassOffset(Base);
2575     RD = Path[I];
2576   }
2577   if (DerivedMember)
2578     ThisAdjustment = -ThisAdjustment;
2579   return ThisAdjustment;
2580 }
2581 
2582 /// DeepCollectObjCIvars -
2583 /// This routine first collects all declared, but not synthesized, ivars in
2584 /// super class and then collects all ivars, including those synthesized for
2585 /// current class. This routine is used for implementation of current class
2586 /// when all ivars, declared and synthesized are known.
2587 void ASTContext::DeepCollectObjCIvars(const ObjCInterfaceDecl *OI,
2588                                       bool leafClass,
2589                             SmallVectorImpl<const ObjCIvarDecl*> &Ivars) const {
2590   if (const ObjCInterfaceDecl *SuperClass = OI->getSuperClass())
2591     DeepCollectObjCIvars(SuperClass, false, Ivars);
2592   if (!leafClass) {
2593     for (const auto *I : OI->ivars())
2594       Ivars.push_back(I);
2595   } else {
2596     auto *IDecl = const_cast<ObjCInterfaceDecl *>(OI);
2597     for (const ObjCIvarDecl *Iv = IDecl->all_declared_ivar_begin(); Iv;
2598          Iv= Iv->getNextIvar())
2599       Ivars.push_back(Iv);
2600   }
2601 }
2602 
2603 /// CollectInheritedProtocols - Collect all protocols in current class and
2604 /// those inherited by it.
2605 void ASTContext::CollectInheritedProtocols(const Decl *CDecl,
2606                           llvm::SmallPtrSet<ObjCProtocolDecl*, 8> &Protocols) {
2607   if (const auto *OI = dyn_cast<ObjCInterfaceDecl>(CDecl)) {
2608     // We can use protocol_iterator here instead of
2609     // all_referenced_protocol_iterator since we are walking all categories.
2610     for (auto *Proto : OI->all_referenced_protocols()) {
2611       CollectInheritedProtocols(Proto, Protocols);
2612     }
2613 
2614     // Categories of this Interface.
2615     for (const auto *Cat : OI->visible_categories())
2616       CollectInheritedProtocols(Cat, Protocols);
2617 
2618     if (ObjCInterfaceDecl *SD = OI->getSuperClass())
2619       while (SD) {
2620         CollectInheritedProtocols(SD, Protocols);
2621         SD = SD->getSuperClass();
2622       }
2623   } else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(CDecl)) {
2624     for (auto *Proto : OC->protocols()) {
2625       CollectInheritedProtocols(Proto, Protocols);
2626     }
2627   } else if (const auto *OP = dyn_cast<ObjCProtocolDecl>(CDecl)) {
2628     // Insert the protocol.
2629     if (!Protocols.insert(
2630           const_cast<ObjCProtocolDecl *>(OP->getCanonicalDecl())).second)
2631       return;
2632 
2633     for (auto *Proto : OP->protocols())
2634       CollectInheritedProtocols(Proto, Protocols);
2635   }
2636 }
2637 
2638 static bool unionHasUniqueObjectRepresentations(const ASTContext &Context,
2639                                                 const RecordDecl *RD) {
2640   assert(RD->isUnion() && "Must be union type");
2641   CharUnits UnionSize = Context.getTypeSizeInChars(RD->getTypeForDecl());
2642 
2643   for (const auto *Field : RD->fields()) {
2644     if (!Context.hasUniqueObjectRepresentations(Field->getType()))
2645       return false;
2646     CharUnits FieldSize = Context.getTypeSizeInChars(Field->getType());
2647     if (FieldSize != UnionSize)
2648       return false;
2649   }
2650   return !RD->field_empty();
2651 }
2652 
2653 static int64_t getSubobjectOffset(const FieldDecl *Field,
2654                                   const ASTContext &Context,
2655                                   const clang::ASTRecordLayout & /*Layout*/) {
2656   return Context.getFieldOffset(Field);
2657 }
2658 
2659 static int64_t getSubobjectOffset(const CXXRecordDecl *RD,
2660                                   const ASTContext &Context,
2661                                   const clang::ASTRecordLayout &Layout) {
2662   return Context.toBits(Layout.getBaseClassOffset(RD));
2663 }
2664 
2665 static llvm::Optional<int64_t>
2666 structHasUniqueObjectRepresentations(const ASTContext &Context,
2667                                      const RecordDecl *RD);
2668 
2669 static llvm::Optional<int64_t>
2670 getSubobjectSizeInBits(const FieldDecl *Field, const ASTContext &Context) {
2671   if (Field->getType()->isRecordType()) {
2672     const RecordDecl *RD = Field->getType()->getAsRecordDecl();
2673     if (!RD->isUnion())
2674       return structHasUniqueObjectRepresentations(Context, RD);
2675   }
2676   if (!Field->getType()->isReferenceType() &&
2677       !Context.hasUniqueObjectRepresentations(Field->getType()))
2678     return llvm::None;
2679 
2680   int64_t FieldSizeInBits =
2681       Context.toBits(Context.getTypeSizeInChars(Field->getType()));
2682   if (Field->isBitField()) {
2683     int64_t BitfieldSize = Field->getBitWidthValue(Context);
2684     if (BitfieldSize > FieldSizeInBits)
2685       return llvm::None;
2686     FieldSizeInBits = BitfieldSize;
2687   }
2688   return FieldSizeInBits;
2689 }
2690 
2691 static llvm::Optional<int64_t>
2692 getSubobjectSizeInBits(const CXXRecordDecl *RD, const ASTContext &Context) {
2693   return structHasUniqueObjectRepresentations(Context, RD);
2694 }
2695 
2696 template <typename RangeT>
2697 static llvm::Optional<int64_t> structSubobjectsHaveUniqueObjectRepresentations(
2698     const RangeT &Subobjects, int64_t CurOffsetInBits,
2699     const ASTContext &Context, const clang::ASTRecordLayout &Layout) {
2700   for (const auto *Subobject : Subobjects) {
2701     llvm::Optional<int64_t> SizeInBits =
2702         getSubobjectSizeInBits(Subobject, Context);
2703     if (!SizeInBits)
2704       return llvm::None;
2705     if (*SizeInBits != 0) {
2706       int64_t Offset = getSubobjectOffset(Subobject, Context, Layout);
2707       if (Offset != CurOffsetInBits)
2708         return llvm::None;
2709       CurOffsetInBits += *SizeInBits;
2710     }
2711   }
2712   return CurOffsetInBits;
2713 }
2714 
2715 static llvm::Optional<int64_t>
2716 structHasUniqueObjectRepresentations(const ASTContext &Context,
2717                                      const RecordDecl *RD) {
2718   assert(!RD->isUnion() && "Must be struct/class type");
2719   const auto &Layout = Context.getASTRecordLayout(RD);
2720 
2721   int64_t CurOffsetInBits = 0;
2722   if (const auto *ClassDecl = dyn_cast<CXXRecordDecl>(RD)) {
2723     if (ClassDecl->isDynamicClass())
2724       return llvm::None;
2725 
2726     SmallVector<CXXRecordDecl *, 4> Bases;
2727     for (const auto &Base : ClassDecl->bases()) {
2728       // Empty types can be inherited from, and non-empty types can potentially
2729       // have tail padding, so just make sure there isn't an error.
2730       Bases.emplace_back(Base.getType()->getAsCXXRecordDecl());
2731     }
2732 
2733     llvm::sort(Bases, [&](const CXXRecordDecl *L, const CXXRecordDecl *R) {
2734       return Layout.getBaseClassOffset(L) < Layout.getBaseClassOffset(R);
2735     });
2736 
2737     llvm::Optional<int64_t> OffsetAfterBases =
2738         structSubobjectsHaveUniqueObjectRepresentations(Bases, CurOffsetInBits,
2739                                                         Context, Layout);
2740     if (!OffsetAfterBases)
2741       return llvm::None;
2742     CurOffsetInBits = *OffsetAfterBases;
2743   }
2744 
2745   llvm::Optional<int64_t> OffsetAfterFields =
2746       structSubobjectsHaveUniqueObjectRepresentations(
2747           RD->fields(), CurOffsetInBits, Context, Layout);
2748   if (!OffsetAfterFields)
2749     return llvm::None;
2750   CurOffsetInBits = *OffsetAfterFields;
2751 
2752   return CurOffsetInBits;
2753 }
2754 
2755 bool ASTContext::hasUniqueObjectRepresentations(QualType Ty) const {
2756   // C++17 [meta.unary.prop]:
2757   //   The predicate condition for a template specialization
2758   //   has_unique_object_representations<T> shall be
2759   //   satisfied if and only if:
2760   //     (9.1) - T is trivially copyable, and
2761   //     (9.2) - any two objects of type T with the same value have the same
2762   //     object representation, where two objects
2763   //   of array or non-union class type are considered to have the same value
2764   //   if their respective sequences of
2765   //   direct subobjects have the same values, and two objects of union type
2766   //   are considered to have the same
2767   //   value if they have the same active member and the corresponding members
2768   //   have the same value.
2769   //   The set of scalar types for which this condition holds is
2770   //   implementation-defined. [ Note: If a type has padding
2771   //   bits, the condition does not hold; otherwise, the condition holds true
2772   //   for unsigned integral types. -- end note ]
2773   assert(!Ty.isNull() && "Null QualType sent to unique object rep check");
2774 
2775   // Arrays are unique only if their element type is unique.
2776   if (Ty->isArrayType())
2777     return hasUniqueObjectRepresentations(getBaseElementType(Ty));
2778 
2779   // (9.1) - T is trivially copyable...
2780   if (!Ty.isTriviallyCopyableType(*this))
2781     return false;
2782 
2783   // All integrals and enums are unique.
2784   if (Ty->isIntegralOrEnumerationType())
2785     return true;
2786 
2787   // All other pointers are unique.
2788   if (Ty->isPointerType())
2789     return true;
2790 
2791   if (Ty->isMemberPointerType()) {
2792     const auto *MPT = Ty->getAs<MemberPointerType>();
2793     return !ABI->getMemberPointerInfo(MPT).HasPadding;
2794   }
2795 
2796   if (Ty->isRecordType()) {
2797     const RecordDecl *Record = Ty->castAs<RecordType>()->getDecl();
2798 
2799     if (Record->isInvalidDecl())
2800       return false;
2801 
2802     if (Record->isUnion())
2803       return unionHasUniqueObjectRepresentations(*this, Record);
2804 
2805     Optional<int64_t> StructSize =
2806         structHasUniqueObjectRepresentations(*this, Record);
2807 
2808     return StructSize &&
2809            StructSize.getValue() == static_cast<int64_t>(getTypeSize(Ty));
2810   }
2811 
2812   // FIXME: More cases to handle here (list by rsmith):
2813   // vectors (careful about, eg, vector of 3 foo)
2814   // _Complex int and friends
2815   // _Atomic T
2816   // Obj-C block pointers
2817   // Obj-C object pointers
2818   // and perhaps OpenCL's various builtin types (pipe, sampler_t, event_t,
2819   // clk_event_t, queue_t, reserve_id_t)
2820   // There're also Obj-C class types and the Obj-C selector type, but I think it
2821   // makes sense for those to return false here.
2822 
2823   return false;
2824 }
2825 
2826 unsigned ASTContext::CountNonClassIvars(const ObjCInterfaceDecl *OI) const {
2827   unsigned count = 0;
2828   // Count ivars declared in class extension.
2829   for (const auto *Ext : OI->known_extensions())
2830     count += Ext->ivar_size();
2831 
2832   // Count ivar defined in this class's implementation.  This
2833   // includes synthesized ivars.
2834   if (ObjCImplementationDecl *ImplDecl = OI->getImplementation())
2835     count += ImplDecl->ivar_size();
2836 
2837   return count;
2838 }
2839 
2840 bool ASTContext::isSentinelNullExpr(const Expr *E) {
2841   if (!E)
2842     return false;
2843 
2844   // nullptr_t is always treated as null.
2845   if (E->getType()->isNullPtrType()) return true;
2846 
2847   if (E->getType()->isAnyPointerType() &&
2848       E->IgnoreParenCasts()->isNullPointerConstant(*this,
2849                                                 Expr::NPC_ValueDependentIsNull))
2850     return true;
2851 
2852   // Unfortunately, __null has type 'int'.
2853   if (isa<GNUNullExpr>(E)) return true;
2854 
2855   return false;
2856 }
2857 
2858 /// Get the implementation of ObjCInterfaceDecl, or nullptr if none
2859 /// exists.
2860 ObjCImplementationDecl *ASTContext::getObjCImplementation(ObjCInterfaceDecl *D) {
2861   llvm::DenseMap<ObjCContainerDecl*, ObjCImplDecl*>::iterator
2862     I = ObjCImpls.find(D);
2863   if (I != ObjCImpls.end())
2864     return cast<ObjCImplementationDecl>(I->second);
2865   return nullptr;
2866 }
2867 
2868 /// Get the implementation of ObjCCategoryDecl, or nullptr if none
2869 /// exists.
2870 ObjCCategoryImplDecl *ASTContext::getObjCImplementation(ObjCCategoryDecl *D) {
2871   llvm::DenseMap<ObjCContainerDecl*, ObjCImplDecl*>::iterator
2872     I = ObjCImpls.find(D);
2873   if (I != ObjCImpls.end())
2874     return cast<ObjCCategoryImplDecl>(I->second);
2875   return nullptr;
2876 }
2877 
2878 /// Set the implementation of ObjCInterfaceDecl.
2879 void ASTContext::setObjCImplementation(ObjCInterfaceDecl *IFaceD,
2880                            ObjCImplementationDecl *ImplD) {
2881   assert(IFaceD && ImplD && "Passed null params");
2882   ObjCImpls[IFaceD] = ImplD;
2883 }
2884 
2885 /// Set the implementation of ObjCCategoryDecl.
2886 void ASTContext::setObjCImplementation(ObjCCategoryDecl *CatD,
2887                            ObjCCategoryImplDecl *ImplD) {
2888   assert(CatD && ImplD && "Passed null params");
2889   ObjCImpls[CatD] = ImplD;
2890 }
2891 
2892 const ObjCMethodDecl *
2893 ASTContext::getObjCMethodRedeclaration(const ObjCMethodDecl *MD) const {
2894   return ObjCMethodRedecls.lookup(MD);
2895 }
2896 
2897 void ASTContext::setObjCMethodRedeclaration(const ObjCMethodDecl *MD,
2898                                             const ObjCMethodDecl *Redecl) {
2899   assert(!getObjCMethodRedeclaration(MD) && "MD already has a redeclaration");
2900   ObjCMethodRedecls[MD] = Redecl;
2901 }
2902 
2903 const ObjCInterfaceDecl *ASTContext::getObjContainingInterface(
2904                                               const NamedDecl *ND) const {
2905   if (const auto *ID = dyn_cast<ObjCInterfaceDecl>(ND->getDeclContext()))
2906     return ID;
2907   if (const auto *CD = dyn_cast<ObjCCategoryDecl>(ND->getDeclContext()))
2908     return CD->getClassInterface();
2909   if (const auto *IMD = dyn_cast<ObjCImplDecl>(ND->getDeclContext()))
2910     return IMD->getClassInterface();
2911 
2912   return nullptr;
2913 }
2914 
2915 /// Get the copy initialization expression of VarDecl, or nullptr if
2916 /// none exists.
2917 BlockVarCopyInit ASTContext::getBlockVarCopyInit(const VarDecl *VD) const {
2918   assert(VD && "Passed null params");
2919   assert(VD->hasAttr<BlocksAttr>() &&
2920          "getBlockVarCopyInits - not __block var");
2921   auto I = BlockVarCopyInits.find(VD);
2922   if (I != BlockVarCopyInits.end())
2923     return I->second;
2924   return {nullptr, false};
2925 }
2926 
2927 /// Set the copy initialization expression of a block var decl.
2928 void ASTContext::setBlockVarCopyInit(const VarDecl*VD, Expr *CopyExpr,
2929                                      bool CanThrow) {
2930   assert(VD && CopyExpr && "Passed null params");
2931   assert(VD->hasAttr<BlocksAttr>() &&
2932          "setBlockVarCopyInits - not __block var");
2933   BlockVarCopyInits[VD].setExprAndFlag(CopyExpr, CanThrow);
2934 }
2935 
2936 TypeSourceInfo *ASTContext::CreateTypeSourceInfo(QualType T,
2937                                                  unsigned DataSize) const {
2938   if (!DataSize)
2939     DataSize = TypeLoc::getFullDataSizeForType(T);
2940   else
2941     assert(DataSize == TypeLoc::getFullDataSizeForType(T) &&
2942            "incorrect data size provided to CreateTypeSourceInfo!");
2943 
2944   auto *TInfo =
2945     (TypeSourceInfo*)BumpAlloc.Allocate(sizeof(TypeSourceInfo) + DataSize, 8);
2946   new (TInfo) TypeSourceInfo(T);
2947   return TInfo;
2948 }
2949 
2950 TypeSourceInfo *ASTContext::getTrivialTypeSourceInfo(QualType T,
2951                                                      SourceLocation L) const {
2952   TypeSourceInfo *DI = CreateTypeSourceInfo(T);
2953   DI->getTypeLoc().initialize(const_cast<ASTContext &>(*this), L);
2954   return DI;
2955 }
2956 
2957 const ASTRecordLayout &
2958 ASTContext::getASTObjCInterfaceLayout(const ObjCInterfaceDecl *D) const {
2959   return getObjCLayout(D, nullptr);
2960 }
2961 
2962 const ASTRecordLayout &
2963 ASTContext::getASTObjCImplementationLayout(
2964                                         const ObjCImplementationDecl *D) const {
2965   return getObjCLayout(D->getClassInterface(), D);
2966 }
2967 
2968 //===----------------------------------------------------------------------===//
2969 //                   Type creation/memoization methods
2970 //===----------------------------------------------------------------------===//
2971 
2972 QualType
2973 ASTContext::getExtQualType(const Type *baseType, Qualifiers quals) const {
2974   unsigned fastQuals = quals.getFastQualifiers();
2975   quals.removeFastQualifiers();
2976 
2977   // Check if we've already instantiated this type.
2978   llvm::FoldingSetNodeID ID;
2979   ExtQuals::Profile(ID, baseType, quals);
2980   void *insertPos = nullptr;
2981   if (ExtQuals *eq = ExtQualNodes.FindNodeOrInsertPos(ID, insertPos)) {
2982     assert(eq->getQualifiers() == quals);
2983     return QualType(eq, fastQuals);
2984   }
2985 
2986   // If the base type is not canonical, make the appropriate canonical type.
2987   QualType canon;
2988   if (!baseType->isCanonicalUnqualified()) {
2989     SplitQualType canonSplit = baseType->getCanonicalTypeInternal().split();
2990     canonSplit.Quals.addConsistentQualifiers(quals);
2991     canon = getExtQualType(canonSplit.Ty, canonSplit.Quals);
2992 
2993     // Re-find the insert position.
2994     (void) ExtQualNodes.FindNodeOrInsertPos(ID, insertPos);
2995   }
2996 
2997   auto *eq = new (*this, TypeAlignment) ExtQuals(baseType, canon, quals);
2998   ExtQualNodes.InsertNode(eq, insertPos);
2999   return QualType(eq, fastQuals);
3000 }
3001 
3002 QualType ASTContext::getAddrSpaceQualType(QualType T,
3003                                           LangAS AddressSpace) const {
3004   QualType CanT = getCanonicalType(T);
3005   if (CanT.getAddressSpace() == AddressSpace)
3006     return T;
3007 
3008   // If we are composing extended qualifiers together, merge together
3009   // into one ExtQuals node.
3010   QualifierCollector Quals;
3011   const Type *TypeNode = Quals.strip(T);
3012 
3013   // If this type already has an address space specified, it cannot get
3014   // another one.
3015   assert(!Quals.hasAddressSpace() &&
3016          "Type cannot be in multiple addr spaces!");
3017   Quals.addAddressSpace(AddressSpace);
3018 
3019   return getExtQualType(TypeNode, Quals);
3020 }
3021 
3022 QualType ASTContext::removeAddrSpaceQualType(QualType T) const {
3023   // If the type is not qualified with an address space, just return it
3024   // immediately.
3025   if (!T.hasAddressSpace())
3026     return T;
3027 
3028   // If we are composing extended qualifiers together, merge together
3029   // into one ExtQuals node.
3030   QualifierCollector Quals;
3031   const Type *TypeNode;
3032 
3033   while (T.hasAddressSpace()) {
3034     TypeNode = Quals.strip(T);
3035 
3036     // If the type no longer has an address space after stripping qualifiers,
3037     // jump out.
3038     if (!QualType(TypeNode, 0).hasAddressSpace())
3039       break;
3040 
3041     // There might be sugar in the way. Strip it and try again.
3042     T = T.getSingleStepDesugaredType(*this);
3043   }
3044 
3045   Quals.removeAddressSpace();
3046 
3047   // Removal of the address space can mean there are no longer any
3048   // non-fast qualifiers, so creating an ExtQualType isn't possible (asserts)
3049   // or required.
3050   if (Quals.hasNonFastQualifiers())
3051     return getExtQualType(TypeNode, Quals);
3052   else
3053     return QualType(TypeNode, Quals.getFastQualifiers());
3054 }
3055 
3056 QualType ASTContext::getObjCGCQualType(QualType T,
3057                                        Qualifiers::GC GCAttr) const {
3058   QualType CanT = getCanonicalType(T);
3059   if (CanT.getObjCGCAttr() == GCAttr)
3060     return T;
3061 
3062   if (const auto *ptr = T->getAs<PointerType>()) {
3063     QualType Pointee = ptr->getPointeeType();
3064     if (Pointee->isAnyPointerType()) {
3065       QualType ResultType = getObjCGCQualType(Pointee, GCAttr);
3066       return getPointerType(ResultType);
3067     }
3068   }
3069 
3070   // If we are composing extended qualifiers together, merge together
3071   // into one ExtQuals node.
3072   QualifierCollector Quals;
3073   const Type *TypeNode = Quals.strip(T);
3074 
3075   // If this type already has an ObjCGC specified, it cannot get
3076   // another one.
3077   assert(!Quals.hasObjCGCAttr() &&
3078          "Type cannot have multiple ObjCGCs!");
3079   Quals.addObjCGCAttr(GCAttr);
3080 
3081   return getExtQualType(TypeNode, Quals);
3082 }
3083 
3084 QualType ASTContext::removePtrSizeAddrSpace(QualType T) const {
3085   if (const PointerType *Ptr = T->getAs<PointerType>()) {
3086     QualType Pointee = Ptr->getPointeeType();
3087     if (isPtrSizeAddressSpace(Pointee.getAddressSpace())) {
3088       return getPointerType(removeAddrSpaceQualType(Pointee));
3089     }
3090   }
3091   return T;
3092 }
3093 
3094 const FunctionType *ASTContext::adjustFunctionType(const FunctionType *T,
3095                                                    FunctionType::ExtInfo Info) {
3096   if (T->getExtInfo() == Info)
3097     return T;
3098 
3099   QualType Result;
3100   if (const auto *FNPT = dyn_cast<FunctionNoProtoType>(T)) {
3101     Result = getFunctionNoProtoType(FNPT->getReturnType(), Info);
3102   } else {
3103     const auto *FPT = cast<FunctionProtoType>(T);
3104     FunctionProtoType::ExtProtoInfo EPI = FPT->getExtProtoInfo();
3105     EPI.ExtInfo = Info;
3106     Result = getFunctionType(FPT->getReturnType(), FPT->getParamTypes(), EPI);
3107   }
3108 
3109   return cast<FunctionType>(Result.getTypePtr());
3110 }
3111 
3112 void ASTContext::adjustDeducedFunctionResultType(FunctionDecl *FD,
3113                                                  QualType ResultType) {
3114   FD = FD->getMostRecentDecl();
3115   while (true) {
3116     const auto *FPT = FD->getType()->castAs<FunctionProtoType>();
3117     FunctionProtoType::ExtProtoInfo EPI = FPT->getExtProtoInfo();
3118     FD->setType(getFunctionType(ResultType, FPT->getParamTypes(), EPI));
3119     if (FunctionDecl *Next = FD->getPreviousDecl())
3120       FD = Next;
3121     else
3122       break;
3123   }
3124   if (ASTMutationListener *L = getASTMutationListener())
3125     L->DeducedReturnType(FD, ResultType);
3126 }
3127 
3128 /// Get a function type and produce the equivalent function type with the
3129 /// specified exception specification. Type sugar that can be present on a
3130 /// declaration of a function with an exception specification is permitted
3131 /// and preserved. Other type sugar (for instance, typedefs) is not.
3132 QualType ASTContext::getFunctionTypeWithExceptionSpec(
3133     QualType Orig, const FunctionProtoType::ExceptionSpecInfo &ESI) {
3134   // Might have some parens.
3135   if (const auto *PT = dyn_cast<ParenType>(Orig))
3136     return getParenType(
3137         getFunctionTypeWithExceptionSpec(PT->getInnerType(), ESI));
3138 
3139   // Might be wrapped in a macro qualified type.
3140   if (const auto *MQT = dyn_cast<MacroQualifiedType>(Orig))
3141     return getMacroQualifiedType(
3142         getFunctionTypeWithExceptionSpec(MQT->getUnderlyingType(), ESI),
3143         MQT->getMacroIdentifier());
3144 
3145   // Might have a calling-convention attribute.
3146   if (const auto *AT = dyn_cast<AttributedType>(Orig))
3147     return getAttributedType(
3148         AT->getAttrKind(),
3149         getFunctionTypeWithExceptionSpec(AT->getModifiedType(), ESI),
3150         getFunctionTypeWithExceptionSpec(AT->getEquivalentType(), ESI));
3151 
3152   // Anything else must be a function type. Rebuild it with the new exception
3153   // specification.
3154   const auto *Proto = Orig->castAs<FunctionProtoType>();
3155   return getFunctionType(
3156       Proto->getReturnType(), Proto->getParamTypes(),
3157       Proto->getExtProtoInfo().withExceptionSpec(ESI));
3158 }
3159 
3160 bool ASTContext::hasSameFunctionTypeIgnoringExceptionSpec(QualType T,
3161                                                           QualType U) {
3162   return hasSameType(T, U) ||
3163          (getLangOpts().CPlusPlus17 &&
3164           hasSameType(getFunctionTypeWithExceptionSpec(T, EST_None),
3165                       getFunctionTypeWithExceptionSpec(U, EST_None)));
3166 }
3167 
3168 QualType ASTContext::getFunctionTypeWithoutPtrSizes(QualType T) {
3169   if (const auto *Proto = T->getAs<FunctionProtoType>()) {
3170     QualType RetTy = removePtrSizeAddrSpace(Proto->getReturnType());
3171     SmallVector<QualType, 16> Args(Proto->param_types());
3172     for (unsigned i = 0, n = Args.size(); i != n; ++i)
3173       Args[i] = removePtrSizeAddrSpace(Args[i]);
3174     return getFunctionType(RetTy, Args, Proto->getExtProtoInfo());
3175   }
3176 
3177   if (const FunctionNoProtoType *Proto = T->getAs<FunctionNoProtoType>()) {
3178     QualType RetTy = removePtrSizeAddrSpace(Proto->getReturnType());
3179     return getFunctionNoProtoType(RetTy, Proto->getExtInfo());
3180   }
3181 
3182   return T;
3183 }
3184 
3185 bool ASTContext::hasSameFunctionTypeIgnoringPtrSizes(QualType T, QualType U) {
3186   return hasSameType(T, U) ||
3187          hasSameType(getFunctionTypeWithoutPtrSizes(T),
3188                      getFunctionTypeWithoutPtrSizes(U));
3189 }
3190 
3191 void ASTContext::adjustExceptionSpec(
3192     FunctionDecl *FD, const FunctionProtoType::ExceptionSpecInfo &ESI,
3193     bool AsWritten) {
3194   // Update the type.
3195   QualType Updated =
3196       getFunctionTypeWithExceptionSpec(FD->getType(), ESI);
3197   FD->setType(Updated);
3198 
3199   if (!AsWritten)
3200     return;
3201 
3202   // Update the type in the type source information too.
3203   if (TypeSourceInfo *TSInfo = FD->getTypeSourceInfo()) {
3204     // If the type and the type-as-written differ, we may need to update
3205     // the type-as-written too.
3206     if (TSInfo->getType() != FD->getType())
3207       Updated = getFunctionTypeWithExceptionSpec(TSInfo->getType(), ESI);
3208 
3209     // FIXME: When we get proper type location information for exceptions,
3210     // we'll also have to rebuild the TypeSourceInfo. For now, we just patch
3211     // up the TypeSourceInfo;
3212     assert(TypeLoc::getFullDataSizeForType(Updated) ==
3213                TypeLoc::getFullDataSizeForType(TSInfo->getType()) &&
3214            "TypeLoc size mismatch from updating exception specification");
3215     TSInfo->overrideType(Updated);
3216   }
3217 }
3218 
3219 /// getComplexType - Return the uniqued reference to the type for a complex
3220 /// number with the specified element type.
3221 QualType ASTContext::getComplexType(QualType T) const {
3222   // Unique pointers, to guarantee there is only one pointer of a particular
3223   // structure.
3224   llvm::FoldingSetNodeID ID;
3225   ComplexType::Profile(ID, T);
3226 
3227   void *InsertPos = nullptr;
3228   if (ComplexType *CT = ComplexTypes.FindNodeOrInsertPos(ID, InsertPos))
3229     return QualType(CT, 0);
3230 
3231   // If the pointee type isn't canonical, this won't be a canonical type either,
3232   // so fill in the canonical type field.
3233   QualType Canonical;
3234   if (!T.isCanonical()) {
3235     Canonical = getComplexType(getCanonicalType(T));
3236 
3237     // Get the new insert position for the node we care about.
3238     ComplexType *NewIP = ComplexTypes.FindNodeOrInsertPos(ID, InsertPos);
3239     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
3240   }
3241   auto *New = new (*this, TypeAlignment) ComplexType(T, Canonical);
3242   Types.push_back(New);
3243   ComplexTypes.InsertNode(New, InsertPos);
3244   return QualType(New, 0);
3245 }
3246 
3247 /// getPointerType - Return the uniqued reference to the type for a pointer to
3248 /// the specified type.
3249 QualType ASTContext::getPointerType(QualType T) const {
3250   // Unique pointers, to guarantee there is only one pointer of a particular
3251   // structure.
3252   llvm::FoldingSetNodeID ID;
3253   PointerType::Profile(ID, T);
3254 
3255   void *InsertPos = nullptr;
3256   if (PointerType *PT = PointerTypes.FindNodeOrInsertPos(ID, InsertPos))
3257     return QualType(PT, 0);
3258 
3259   // If the pointee type isn't canonical, this won't be a canonical type either,
3260   // so fill in the canonical type field.
3261   QualType Canonical;
3262   if (!T.isCanonical()) {
3263     Canonical = getPointerType(getCanonicalType(T));
3264 
3265     // Get the new insert position for the node we care about.
3266     PointerType *NewIP = PointerTypes.FindNodeOrInsertPos(ID, InsertPos);
3267     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
3268   }
3269   auto *New = new (*this, TypeAlignment) PointerType(T, Canonical);
3270   Types.push_back(New);
3271   PointerTypes.InsertNode(New, InsertPos);
3272   return QualType(New, 0);
3273 }
3274 
3275 QualType ASTContext::getAdjustedType(QualType Orig, QualType New) const {
3276   llvm::FoldingSetNodeID ID;
3277   AdjustedType::Profile(ID, Orig, New);
3278   void *InsertPos = nullptr;
3279   AdjustedType *AT = AdjustedTypes.FindNodeOrInsertPos(ID, InsertPos);
3280   if (AT)
3281     return QualType(AT, 0);
3282 
3283   QualType Canonical = getCanonicalType(New);
3284 
3285   // Get the new insert position for the node we care about.
3286   AT = AdjustedTypes.FindNodeOrInsertPos(ID, InsertPos);
3287   assert(!AT && "Shouldn't be in the map!");
3288 
3289   AT = new (*this, TypeAlignment)
3290       AdjustedType(Type::Adjusted, Orig, New, Canonical);
3291   Types.push_back(AT);
3292   AdjustedTypes.InsertNode(AT, InsertPos);
3293   return QualType(AT, 0);
3294 }
3295 
3296 QualType ASTContext::getDecayedType(QualType T) const {
3297   assert((T->isArrayType() || T->isFunctionType()) && "T does not decay");
3298 
3299   QualType Decayed;
3300 
3301   // C99 6.7.5.3p7:
3302   //   A declaration of a parameter as "array of type" shall be
3303   //   adjusted to "qualified pointer to type", where the type
3304   //   qualifiers (if any) are those specified within the [ and ] of
3305   //   the array type derivation.
3306   if (T->isArrayType())
3307     Decayed = getArrayDecayedType(T);
3308 
3309   // C99 6.7.5.3p8:
3310   //   A declaration of a parameter as "function returning type"
3311   //   shall be adjusted to "pointer to function returning type", as
3312   //   in 6.3.2.1.
3313   if (T->isFunctionType())
3314     Decayed = getPointerType(T);
3315 
3316   llvm::FoldingSetNodeID ID;
3317   AdjustedType::Profile(ID, T, Decayed);
3318   void *InsertPos = nullptr;
3319   AdjustedType *AT = AdjustedTypes.FindNodeOrInsertPos(ID, InsertPos);
3320   if (AT)
3321     return QualType(AT, 0);
3322 
3323   QualType Canonical = getCanonicalType(Decayed);
3324 
3325   // Get the new insert position for the node we care about.
3326   AT = AdjustedTypes.FindNodeOrInsertPos(ID, InsertPos);
3327   assert(!AT && "Shouldn't be in the map!");
3328 
3329   AT = new (*this, TypeAlignment) DecayedType(T, Decayed, Canonical);
3330   Types.push_back(AT);
3331   AdjustedTypes.InsertNode(AT, InsertPos);
3332   return QualType(AT, 0);
3333 }
3334 
3335 /// getBlockPointerType - Return the uniqued reference to the type for
3336 /// a pointer to the specified block.
3337 QualType ASTContext::getBlockPointerType(QualType T) const {
3338   assert(T->isFunctionType() && "block of function types only");
3339   // Unique pointers, to guarantee there is only one block of a particular
3340   // structure.
3341   llvm::FoldingSetNodeID ID;
3342   BlockPointerType::Profile(ID, T);
3343 
3344   void *InsertPos = nullptr;
3345   if (BlockPointerType *PT =
3346         BlockPointerTypes.FindNodeOrInsertPos(ID, InsertPos))
3347     return QualType(PT, 0);
3348 
3349   // If the block pointee type isn't canonical, this won't be a canonical
3350   // type either so fill in the canonical type field.
3351   QualType Canonical;
3352   if (!T.isCanonical()) {
3353     Canonical = getBlockPointerType(getCanonicalType(T));
3354 
3355     // Get the new insert position for the node we care about.
3356     BlockPointerType *NewIP =
3357       BlockPointerTypes.FindNodeOrInsertPos(ID, InsertPos);
3358     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
3359   }
3360   auto *New = new (*this, TypeAlignment) BlockPointerType(T, Canonical);
3361   Types.push_back(New);
3362   BlockPointerTypes.InsertNode(New, InsertPos);
3363   return QualType(New, 0);
3364 }
3365 
3366 /// getLValueReferenceType - Return the uniqued reference to the type for an
3367 /// lvalue reference to the specified type.
3368 QualType
3369 ASTContext::getLValueReferenceType(QualType T, bool SpelledAsLValue) const {
3370   assert(getCanonicalType(T) != OverloadTy &&
3371          "Unresolved overloaded function type");
3372 
3373   // Unique pointers, to guarantee there is only one pointer of a particular
3374   // structure.
3375   llvm::FoldingSetNodeID ID;
3376   ReferenceType::Profile(ID, T, SpelledAsLValue);
3377 
3378   void *InsertPos = nullptr;
3379   if (LValueReferenceType *RT =
3380         LValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos))
3381     return QualType(RT, 0);
3382 
3383   const auto *InnerRef = T->getAs<ReferenceType>();
3384 
3385   // If the referencee type isn't canonical, this won't be a canonical type
3386   // either, so fill in the canonical type field.
3387   QualType Canonical;
3388   if (!SpelledAsLValue || InnerRef || !T.isCanonical()) {
3389     QualType PointeeType = (InnerRef ? InnerRef->getPointeeType() : T);
3390     Canonical = getLValueReferenceType(getCanonicalType(PointeeType));
3391 
3392     // Get the new insert position for the node we care about.
3393     LValueReferenceType *NewIP =
3394       LValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos);
3395     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
3396   }
3397 
3398   auto *New = new (*this, TypeAlignment) LValueReferenceType(T, Canonical,
3399                                                              SpelledAsLValue);
3400   Types.push_back(New);
3401   LValueReferenceTypes.InsertNode(New, InsertPos);
3402 
3403   return QualType(New, 0);
3404 }
3405 
3406 /// getRValueReferenceType - Return the uniqued reference to the type for an
3407 /// rvalue reference to the specified type.
3408 QualType ASTContext::getRValueReferenceType(QualType T) const {
3409   // Unique pointers, to guarantee there is only one pointer of a particular
3410   // structure.
3411   llvm::FoldingSetNodeID ID;
3412   ReferenceType::Profile(ID, T, false);
3413 
3414   void *InsertPos = nullptr;
3415   if (RValueReferenceType *RT =
3416         RValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos))
3417     return QualType(RT, 0);
3418 
3419   const auto *InnerRef = T->getAs<ReferenceType>();
3420 
3421   // If the referencee type isn't canonical, this won't be a canonical type
3422   // either, so fill in the canonical type field.
3423   QualType Canonical;
3424   if (InnerRef || !T.isCanonical()) {
3425     QualType PointeeType = (InnerRef ? InnerRef->getPointeeType() : T);
3426     Canonical = getRValueReferenceType(getCanonicalType(PointeeType));
3427 
3428     // Get the new insert position for the node we care about.
3429     RValueReferenceType *NewIP =
3430       RValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos);
3431     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
3432   }
3433 
3434   auto *New = new (*this, TypeAlignment) RValueReferenceType(T, Canonical);
3435   Types.push_back(New);
3436   RValueReferenceTypes.InsertNode(New, InsertPos);
3437   return QualType(New, 0);
3438 }
3439 
3440 /// getMemberPointerType - Return the uniqued reference to the type for a
3441 /// member pointer to the specified type, in the specified class.
3442 QualType ASTContext::getMemberPointerType(QualType T, const Type *Cls) const {
3443   // Unique pointers, to guarantee there is only one pointer of a particular
3444   // structure.
3445   llvm::FoldingSetNodeID ID;
3446   MemberPointerType::Profile(ID, T, Cls);
3447 
3448   void *InsertPos = nullptr;
3449   if (MemberPointerType *PT =
3450       MemberPointerTypes.FindNodeOrInsertPos(ID, InsertPos))
3451     return QualType(PT, 0);
3452 
3453   // If the pointee or class type isn't canonical, this won't be a canonical
3454   // type either, so fill in the canonical type field.
3455   QualType Canonical;
3456   if (!T.isCanonical() || !Cls->isCanonicalUnqualified()) {
3457     Canonical = getMemberPointerType(getCanonicalType(T),getCanonicalType(Cls));
3458 
3459     // Get the new insert position for the node we care about.
3460     MemberPointerType *NewIP =
3461       MemberPointerTypes.FindNodeOrInsertPos(ID, InsertPos);
3462     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
3463   }
3464   auto *New = new (*this, TypeAlignment) MemberPointerType(T, Cls, Canonical);
3465   Types.push_back(New);
3466   MemberPointerTypes.InsertNode(New, InsertPos);
3467   return QualType(New, 0);
3468 }
3469 
3470 /// getConstantArrayType - Return the unique reference to the type for an
3471 /// array of the specified element type.
3472 QualType ASTContext::getConstantArrayType(QualType EltTy,
3473                                           const llvm::APInt &ArySizeIn,
3474                                           const Expr *SizeExpr,
3475                                           ArrayType::ArraySizeModifier ASM,
3476                                           unsigned IndexTypeQuals) const {
3477   assert((EltTy->isDependentType() ||
3478           EltTy->isIncompleteType() || EltTy->isConstantSizeType()) &&
3479          "Constant array of VLAs is illegal!");
3480 
3481   // We only need the size as part of the type if it's instantiation-dependent.
3482   if (SizeExpr && !SizeExpr->isInstantiationDependent())
3483     SizeExpr = nullptr;
3484 
3485   // Convert the array size into a canonical width matching the pointer size for
3486   // the target.
3487   llvm::APInt ArySize(ArySizeIn);
3488   ArySize = ArySize.zextOrTrunc(Target->getMaxPointerWidth());
3489 
3490   llvm::FoldingSetNodeID ID;
3491   ConstantArrayType::Profile(ID, *this, EltTy, ArySize, SizeExpr, ASM,
3492                              IndexTypeQuals);
3493 
3494   void *InsertPos = nullptr;
3495   if (ConstantArrayType *ATP =
3496       ConstantArrayTypes.FindNodeOrInsertPos(ID, InsertPos))
3497     return QualType(ATP, 0);
3498 
3499   // If the element type isn't canonical or has qualifiers, or the array bound
3500   // is instantiation-dependent, this won't be a canonical type either, so fill
3501   // in the canonical type field.
3502   QualType Canon;
3503   if (!EltTy.isCanonical() || EltTy.hasLocalQualifiers() || SizeExpr) {
3504     SplitQualType canonSplit = getCanonicalType(EltTy).split();
3505     Canon = getConstantArrayType(QualType(canonSplit.Ty, 0), ArySize, nullptr,
3506                                  ASM, IndexTypeQuals);
3507     Canon = getQualifiedType(Canon, canonSplit.Quals);
3508 
3509     // Get the new insert position for the node we care about.
3510     ConstantArrayType *NewIP =
3511       ConstantArrayTypes.FindNodeOrInsertPos(ID, InsertPos);
3512     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
3513   }
3514 
3515   void *Mem = Allocate(
3516       ConstantArrayType::totalSizeToAlloc<const Expr *>(SizeExpr ? 1 : 0),
3517       TypeAlignment);
3518   auto *New = new (Mem)
3519     ConstantArrayType(EltTy, Canon, ArySize, SizeExpr, ASM, IndexTypeQuals);
3520   ConstantArrayTypes.InsertNode(New, InsertPos);
3521   Types.push_back(New);
3522   return QualType(New, 0);
3523 }
3524 
3525 /// getVariableArrayDecayedType - Turns the given type, which may be
3526 /// variably-modified, into the corresponding type with all the known
3527 /// sizes replaced with [*].
3528 QualType ASTContext::getVariableArrayDecayedType(QualType type) const {
3529   // Vastly most common case.
3530   if (!type->isVariablyModifiedType()) return type;
3531 
3532   QualType result;
3533 
3534   SplitQualType split = type.getSplitDesugaredType();
3535   const Type *ty = split.Ty;
3536   switch (ty->getTypeClass()) {
3537 #define TYPE(Class, Base)
3538 #define ABSTRACT_TYPE(Class, Base)
3539 #define NON_CANONICAL_TYPE(Class, Base) case Type::Class:
3540 #include "clang/AST/TypeNodes.inc"
3541     llvm_unreachable("didn't desugar past all non-canonical types?");
3542 
3543   // These types should never be variably-modified.
3544   case Type::Builtin:
3545   case Type::Complex:
3546   case Type::Vector:
3547   case Type::DependentVector:
3548   case Type::ExtVector:
3549   case Type::DependentSizedExtVector:
3550   case Type::ConstantMatrix:
3551   case Type::DependentSizedMatrix:
3552   case Type::DependentAddressSpace:
3553   case Type::ObjCObject:
3554   case Type::ObjCInterface:
3555   case Type::ObjCObjectPointer:
3556   case Type::Record:
3557   case Type::Enum:
3558   case Type::UnresolvedUsing:
3559   case Type::TypeOfExpr:
3560   case Type::TypeOf:
3561   case Type::Decltype:
3562   case Type::UnaryTransform:
3563   case Type::DependentName:
3564   case Type::InjectedClassName:
3565   case Type::TemplateSpecialization:
3566   case Type::DependentTemplateSpecialization:
3567   case Type::TemplateTypeParm:
3568   case Type::SubstTemplateTypeParmPack:
3569   case Type::Auto:
3570   case Type::DeducedTemplateSpecialization:
3571   case Type::PackExpansion:
3572   case Type::ExtInt:
3573   case Type::DependentExtInt:
3574     llvm_unreachable("type should never be variably-modified");
3575 
3576   // These types can be variably-modified but should never need to
3577   // further decay.
3578   case Type::FunctionNoProto:
3579   case Type::FunctionProto:
3580   case Type::BlockPointer:
3581   case Type::MemberPointer:
3582   case Type::Pipe:
3583     return type;
3584 
3585   // These types can be variably-modified.  All these modifications
3586   // preserve structure except as noted by comments.
3587   // TODO: if we ever care about optimizing VLAs, there are no-op
3588   // optimizations available here.
3589   case Type::Pointer:
3590     result = getPointerType(getVariableArrayDecayedType(
3591                               cast<PointerType>(ty)->getPointeeType()));
3592     break;
3593 
3594   case Type::LValueReference: {
3595     const auto *lv = cast<LValueReferenceType>(ty);
3596     result = getLValueReferenceType(
3597                  getVariableArrayDecayedType(lv->getPointeeType()),
3598                                     lv->isSpelledAsLValue());
3599     break;
3600   }
3601 
3602   case Type::RValueReference: {
3603     const auto *lv = cast<RValueReferenceType>(ty);
3604     result = getRValueReferenceType(
3605                  getVariableArrayDecayedType(lv->getPointeeType()));
3606     break;
3607   }
3608 
3609   case Type::Atomic: {
3610     const auto *at = cast<AtomicType>(ty);
3611     result = getAtomicType(getVariableArrayDecayedType(at->getValueType()));
3612     break;
3613   }
3614 
3615   case Type::ConstantArray: {
3616     const auto *cat = cast<ConstantArrayType>(ty);
3617     result = getConstantArrayType(
3618                  getVariableArrayDecayedType(cat->getElementType()),
3619                                   cat->getSize(),
3620                                   cat->getSizeExpr(),
3621                                   cat->getSizeModifier(),
3622                                   cat->getIndexTypeCVRQualifiers());
3623     break;
3624   }
3625 
3626   case Type::DependentSizedArray: {
3627     const auto *dat = cast<DependentSizedArrayType>(ty);
3628     result = getDependentSizedArrayType(
3629                  getVariableArrayDecayedType(dat->getElementType()),
3630                                         dat->getSizeExpr(),
3631                                         dat->getSizeModifier(),
3632                                         dat->getIndexTypeCVRQualifiers(),
3633                                         dat->getBracketsRange());
3634     break;
3635   }
3636 
3637   // Turn incomplete types into [*] types.
3638   case Type::IncompleteArray: {
3639     const auto *iat = cast<IncompleteArrayType>(ty);
3640     result = getVariableArrayType(
3641                  getVariableArrayDecayedType(iat->getElementType()),
3642                                   /*size*/ nullptr,
3643                                   ArrayType::Normal,
3644                                   iat->getIndexTypeCVRQualifiers(),
3645                                   SourceRange());
3646     break;
3647   }
3648 
3649   // Turn VLA types into [*] types.
3650   case Type::VariableArray: {
3651     const auto *vat = cast<VariableArrayType>(ty);
3652     result = getVariableArrayType(
3653                  getVariableArrayDecayedType(vat->getElementType()),
3654                                   /*size*/ nullptr,
3655                                   ArrayType::Star,
3656                                   vat->getIndexTypeCVRQualifiers(),
3657                                   vat->getBracketsRange());
3658     break;
3659   }
3660   }
3661 
3662   // Apply the top-level qualifiers from the original.
3663   return getQualifiedType(result, split.Quals);
3664 }
3665 
3666 /// getVariableArrayType - Returns a non-unique reference to the type for a
3667 /// variable array of the specified element type.
3668 QualType ASTContext::getVariableArrayType(QualType EltTy,
3669                                           Expr *NumElts,
3670                                           ArrayType::ArraySizeModifier ASM,
3671                                           unsigned IndexTypeQuals,
3672                                           SourceRange Brackets) const {
3673   // Since we don't unique expressions, it isn't possible to unique VLA's
3674   // that have an expression provided for their size.
3675   QualType Canon;
3676 
3677   // Be sure to pull qualifiers off the element type.
3678   if (!EltTy.isCanonical() || EltTy.hasLocalQualifiers()) {
3679     SplitQualType canonSplit = getCanonicalType(EltTy).split();
3680     Canon = getVariableArrayType(QualType(canonSplit.Ty, 0), NumElts, ASM,
3681                                  IndexTypeQuals, Brackets);
3682     Canon = getQualifiedType(Canon, canonSplit.Quals);
3683   }
3684 
3685   auto *New = new (*this, TypeAlignment)
3686     VariableArrayType(EltTy, Canon, NumElts, ASM, IndexTypeQuals, Brackets);
3687 
3688   VariableArrayTypes.push_back(New);
3689   Types.push_back(New);
3690   return QualType(New, 0);
3691 }
3692 
3693 /// getDependentSizedArrayType - Returns a non-unique reference to
3694 /// the type for a dependently-sized array of the specified element
3695 /// type.
3696 QualType ASTContext::getDependentSizedArrayType(QualType elementType,
3697                                                 Expr *numElements,
3698                                                 ArrayType::ArraySizeModifier ASM,
3699                                                 unsigned elementTypeQuals,
3700                                                 SourceRange brackets) const {
3701   assert((!numElements || numElements->isTypeDependent() ||
3702           numElements->isValueDependent()) &&
3703          "Size must be type- or value-dependent!");
3704 
3705   // Dependently-sized array types that do not have a specified number
3706   // of elements will have their sizes deduced from a dependent
3707   // initializer.  We do no canonicalization here at all, which is okay
3708   // because they can't be used in most locations.
3709   if (!numElements) {
3710     auto *newType
3711       = new (*this, TypeAlignment)
3712           DependentSizedArrayType(*this, elementType, QualType(),
3713                                   numElements, ASM, elementTypeQuals,
3714                                   brackets);
3715     Types.push_back(newType);
3716     return QualType(newType, 0);
3717   }
3718 
3719   // Otherwise, we actually build a new type every time, but we
3720   // also build a canonical type.
3721 
3722   SplitQualType canonElementType = getCanonicalType(elementType).split();
3723 
3724   void *insertPos = nullptr;
3725   llvm::FoldingSetNodeID ID;
3726   DependentSizedArrayType::Profile(ID, *this,
3727                                    QualType(canonElementType.Ty, 0),
3728                                    ASM, elementTypeQuals, numElements);
3729 
3730   // Look for an existing type with these properties.
3731   DependentSizedArrayType *canonTy =
3732     DependentSizedArrayTypes.FindNodeOrInsertPos(ID, insertPos);
3733 
3734   // If we don't have one, build one.
3735   if (!canonTy) {
3736     canonTy = new (*this, TypeAlignment)
3737       DependentSizedArrayType(*this, QualType(canonElementType.Ty, 0),
3738                               QualType(), numElements, ASM, elementTypeQuals,
3739                               brackets);
3740     DependentSizedArrayTypes.InsertNode(canonTy, insertPos);
3741     Types.push_back(canonTy);
3742   }
3743 
3744   // Apply qualifiers from the element type to the array.
3745   QualType canon = getQualifiedType(QualType(canonTy,0),
3746                                     canonElementType.Quals);
3747 
3748   // If we didn't need extra canonicalization for the element type or the size
3749   // expression, then just use that as our result.
3750   if (QualType(canonElementType.Ty, 0) == elementType &&
3751       canonTy->getSizeExpr() == numElements)
3752     return canon;
3753 
3754   // Otherwise, we need to build a type which follows the spelling
3755   // of the element type.
3756   auto *sugaredType
3757     = new (*this, TypeAlignment)
3758         DependentSizedArrayType(*this, elementType, canon, numElements,
3759                                 ASM, elementTypeQuals, brackets);
3760   Types.push_back(sugaredType);
3761   return QualType(sugaredType, 0);
3762 }
3763 
3764 QualType ASTContext::getIncompleteArrayType(QualType elementType,
3765                                             ArrayType::ArraySizeModifier ASM,
3766                                             unsigned elementTypeQuals) const {
3767   llvm::FoldingSetNodeID ID;
3768   IncompleteArrayType::Profile(ID, elementType, ASM, elementTypeQuals);
3769 
3770   void *insertPos = nullptr;
3771   if (IncompleteArrayType *iat =
3772        IncompleteArrayTypes.FindNodeOrInsertPos(ID, insertPos))
3773     return QualType(iat, 0);
3774 
3775   // If the element type isn't canonical, this won't be a canonical type
3776   // either, so fill in the canonical type field.  We also have to pull
3777   // qualifiers off the element type.
3778   QualType canon;
3779 
3780   if (!elementType.isCanonical() || elementType.hasLocalQualifiers()) {
3781     SplitQualType canonSplit = getCanonicalType(elementType).split();
3782     canon = getIncompleteArrayType(QualType(canonSplit.Ty, 0),
3783                                    ASM, elementTypeQuals);
3784     canon = getQualifiedType(canon, canonSplit.Quals);
3785 
3786     // Get the new insert position for the node we care about.
3787     IncompleteArrayType *existing =
3788       IncompleteArrayTypes.FindNodeOrInsertPos(ID, insertPos);
3789     assert(!existing && "Shouldn't be in the map!"); (void) existing;
3790   }
3791 
3792   auto *newType = new (*this, TypeAlignment)
3793     IncompleteArrayType(elementType, canon, ASM, elementTypeQuals);
3794 
3795   IncompleteArrayTypes.InsertNode(newType, insertPos);
3796   Types.push_back(newType);
3797   return QualType(newType, 0);
3798 }
3799 
3800 ASTContext::BuiltinVectorTypeInfo
3801 ASTContext::getBuiltinVectorTypeInfo(const BuiltinType *Ty) const {
3802 #define SVE_INT_ELTTY(BITS, ELTS, SIGNED, NUMVECTORS)                          \
3803   {getIntTypeForBitwidth(BITS, SIGNED), llvm::ElementCount::getScalable(ELTS), \
3804    NUMVECTORS};
3805 
3806 #define SVE_ELTTY(ELTTY, ELTS, NUMVECTORS)                                     \
3807   {ELTTY, llvm::ElementCount::getScalable(ELTS), NUMVECTORS};
3808 
3809   switch (Ty->getKind()) {
3810   default:
3811     llvm_unreachable("Unsupported builtin vector type");
3812   case BuiltinType::SveInt8:
3813     return SVE_INT_ELTTY(8, 16, true, 1);
3814   case BuiltinType::SveUint8:
3815     return SVE_INT_ELTTY(8, 16, false, 1);
3816   case BuiltinType::SveInt8x2:
3817     return SVE_INT_ELTTY(8, 16, true, 2);
3818   case BuiltinType::SveUint8x2:
3819     return SVE_INT_ELTTY(8, 16, false, 2);
3820   case BuiltinType::SveInt8x3:
3821     return SVE_INT_ELTTY(8, 16, true, 3);
3822   case BuiltinType::SveUint8x3:
3823     return SVE_INT_ELTTY(8, 16, false, 3);
3824   case BuiltinType::SveInt8x4:
3825     return SVE_INT_ELTTY(8, 16, true, 4);
3826   case BuiltinType::SveUint8x4:
3827     return SVE_INT_ELTTY(8, 16, false, 4);
3828   case BuiltinType::SveInt16:
3829     return SVE_INT_ELTTY(16, 8, true, 1);
3830   case BuiltinType::SveUint16:
3831     return SVE_INT_ELTTY(16, 8, false, 1);
3832   case BuiltinType::SveInt16x2:
3833     return SVE_INT_ELTTY(16, 8, true, 2);
3834   case BuiltinType::SveUint16x2:
3835     return SVE_INT_ELTTY(16, 8, false, 2);
3836   case BuiltinType::SveInt16x3:
3837     return SVE_INT_ELTTY(16, 8, true, 3);
3838   case BuiltinType::SveUint16x3:
3839     return SVE_INT_ELTTY(16, 8, false, 3);
3840   case BuiltinType::SveInt16x4:
3841     return SVE_INT_ELTTY(16, 8, true, 4);
3842   case BuiltinType::SveUint16x4:
3843     return SVE_INT_ELTTY(16, 8, false, 4);
3844   case BuiltinType::SveInt32:
3845     return SVE_INT_ELTTY(32, 4, true, 1);
3846   case BuiltinType::SveUint32:
3847     return SVE_INT_ELTTY(32, 4, false, 1);
3848   case BuiltinType::SveInt32x2:
3849     return SVE_INT_ELTTY(32, 4, true, 2);
3850   case BuiltinType::SveUint32x2:
3851     return SVE_INT_ELTTY(32, 4, false, 2);
3852   case BuiltinType::SveInt32x3:
3853     return SVE_INT_ELTTY(32, 4, true, 3);
3854   case BuiltinType::SveUint32x3:
3855     return SVE_INT_ELTTY(32, 4, false, 3);
3856   case BuiltinType::SveInt32x4:
3857     return SVE_INT_ELTTY(32, 4, true, 4);
3858   case BuiltinType::SveUint32x4:
3859     return SVE_INT_ELTTY(32, 4, false, 4);
3860   case BuiltinType::SveInt64:
3861     return SVE_INT_ELTTY(64, 2, true, 1);
3862   case BuiltinType::SveUint64:
3863     return SVE_INT_ELTTY(64, 2, false, 1);
3864   case BuiltinType::SveInt64x2:
3865     return SVE_INT_ELTTY(64, 2, true, 2);
3866   case BuiltinType::SveUint64x2:
3867     return SVE_INT_ELTTY(64, 2, false, 2);
3868   case BuiltinType::SveInt64x3:
3869     return SVE_INT_ELTTY(64, 2, true, 3);
3870   case BuiltinType::SveUint64x3:
3871     return SVE_INT_ELTTY(64, 2, false, 3);
3872   case BuiltinType::SveInt64x4:
3873     return SVE_INT_ELTTY(64, 2, true, 4);
3874   case BuiltinType::SveUint64x4:
3875     return SVE_INT_ELTTY(64, 2, false, 4);
3876   case BuiltinType::SveBool:
3877     return SVE_ELTTY(BoolTy, 16, 1);
3878   case BuiltinType::SveFloat16:
3879     return SVE_ELTTY(HalfTy, 8, 1);
3880   case BuiltinType::SveFloat16x2:
3881     return SVE_ELTTY(HalfTy, 8, 2);
3882   case BuiltinType::SveFloat16x3:
3883     return SVE_ELTTY(HalfTy, 8, 3);
3884   case BuiltinType::SveFloat16x4:
3885     return SVE_ELTTY(HalfTy, 8, 4);
3886   case BuiltinType::SveFloat32:
3887     return SVE_ELTTY(FloatTy, 4, 1);
3888   case BuiltinType::SveFloat32x2:
3889     return SVE_ELTTY(FloatTy, 4, 2);
3890   case BuiltinType::SveFloat32x3:
3891     return SVE_ELTTY(FloatTy, 4, 3);
3892   case BuiltinType::SveFloat32x4:
3893     return SVE_ELTTY(FloatTy, 4, 4);
3894   case BuiltinType::SveFloat64:
3895     return SVE_ELTTY(DoubleTy, 2, 1);
3896   case BuiltinType::SveFloat64x2:
3897     return SVE_ELTTY(DoubleTy, 2, 2);
3898   case BuiltinType::SveFloat64x3:
3899     return SVE_ELTTY(DoubleTy, 2, 3);
3900   case BuiltinType::SveFloat64x4:
3901     return SVE_ELTTY(DoubleTy, 2, 4);
3902   case BuiltinType::SveBFloat16:
3903     return SVE_ELTTY(BFloat16Ty, 8, 1);
3904   case BuiltinType::SveBFloat16x2:
3905     return SVE_ELTTY(BFloat16Ty, 8, 2);
3906   case BuiltinType::SveBFloat16x3:
3907     return SVE_ELTTY(BFloat16Ty, 8, 3);
3908   case BuiltinType::SveBFloat16x4:
3909     return SVE_ELTTY(BFloat16Ty, 8, 4);
3910 #define RVV_VECTOR_TYPE_INT(Name, Id, SingletonId, NumEls, ElBits, NF,         \
3911                             IsSigned)                                          \
3912   case BuiltinType::Id:                                                        \
3913     return {getIntTypeForBitwidth(ElBits, IsSigned),                           \
3914             llvm::ElementCount::getScalable(NumEls), NF};
3915 #define RVV_VECTOR_TYPE_FLOAT(Name, Id, SingletonId, NumEls, ElBits, NF)       \
3916   case BuiltinType::Id:                                                        \
3917     return {ElBits == 16 ? Float16Ty : (ElBits == 32 ? FloatTy : DoubleTy),    \
3918             llvm::ElementCount::getScalable(NumEls), NF};
3919 #define RVV_PREDICATE_TYPE(Name, Id, SingletonId, NumEls)                      \
3920   case BuiltinType::Id:                                                        \
3921     return {BoolTy, llvm::ElementCount::getScalable(NumEls), 1};
3922 #include "clang/Basic/RISCVVTypes.def"
3923   }
3924 }
3925 
3926 /// getScalableVectorType - Return the unique reference to a scalable vector
3927 /// type of the specified element type and size. VectorType must be a built-in
3928 /// type.
3929 QualType ASTContext::getScalableVectorType(QualType EltTy,
3930                                            unsigned NumElts) const {
3931   if (Target->hasAArch64SVETypes()) {
3932     uint64_t EltTySize = getTypeSize(EltTy);
3933 #define SVE_VECTOR_TYPE(Name, MangledName, Id, SingletonId, NumEls, ElBits,    \
3934                         IsSigned, IsFP, IsBF)                                  \
3935   if (!EltTy->isBooleanType() &&                                               \
3936       ((EltTy->hasIntegerRepresentation() &&                                   \
3937         EltTy->hasSignedIntegerRepresentation() == IsSigned) ||                \
3938        (EltTy->hasFloatingRepresentation() && !EltTy->isBFloat16Type() &&      \
3939         IsFP && !IsBF) ||                                                      \
3940        (EltTy->hasFloatingRepresentation() && EltTy->isBFloat16Type() &&       \
3941         IsBF && !IsFP)) &&                                                     \
3942       EltTySize == ElBits && NumElts == NumEls) {                              \
3943     return SingletonId;                                                        \
3944   }
3945 #define SVE_PREDICATE_TYPE(Name, MangledName, Id, SingletonId, NumEls)         \
3946   if (EltTy->isBooleanType() && NumElts == NumEls)                             \
3947     return SingletonId;
3948 #include "clang/Basic/AArch64SVEACLETypes.def"
3949   } else if (Target->hasRISCVVTypes()) {
3950     uint64_t EltTySize = getTypeSize(EltTy);
3951 #define RVV_VECTOR_TYPE(Name, Id, SingletonId, NumEls, ElBits, NF, IsSigned,   \
3952                         IsFP)                                                  \
3953     if (!EltTy->isBooleanType() &&                                             \
3954         ((EltTy->hasIntegerRepresentation() &&                                 \
3955           EltTy->hasSignedIntegerRepresentation() == IsSigned) ||              \
3956          (EltTy->hasFloatingRepresentation() && IsFP)) &&                      \
3957         EltTySize == ElBits && NumElts == NumEls)                              \
3958       return SingletonId;
3959 #define RVV_PREDICATE_TYPE(Name, Id, SingletonId, NumEls)                      \
3960     if (EltTy->isBooleanType() && NumElts == NumEls)                           \
3961       return SingletonId;
3962 #include "clang/Basic/RISCVVTypes.def"
3963   }
3964   return QualType();
3965 }
3966 
3967 /// getVectorType - Return the unique reference to a vector type of
3968 /// the specified element type and size. VectorType must be a built-in type.
3969 QualType ASTContext::getVectorType(QualType vecType, unsigned NumElts,
3970                                    VectorType::VectorKind VecKind) const {
3971   assert(vecType->isBuiltinType());
3972 
3973   // Check if we've already instantiated a vector of this type.
3974   llvm::FoldingSetNodeID ID;
3975   VectorType::Profile(ID, vecType, NumElts, Type::Vector, VecKind);
3976 
3977   void *InsertPos = nullptr;
3978   if (VectorType *VTP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos))
3979     return QualType(VTP, 0);
3980 
3981   // If the element type isn't canonical, this won't be a canonical type either,
3982   // so fill in the canonical type field.
3983   QualType Canonical;
3984   if (!vecType.isCanonical()) {
3985     Canonical = getVectorType(getCanonicalType(vecType), NumElts, VecKind);
3986 
3987     // Get the new insert position for the node we care about.
3988     VectorType *NewIP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos);
3989     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
3990   }
3991   auto *New = new (*this, TypeAlignment)
3992     VectorType(vecType, NumElts, Canonical, VecKind);
3993   VectorTypes.InsertNode(New, InsertPos);
3994   Types.push_back(New);
3995   return QualType(New, 0);
3996 }
3997 
3998 QualType
3999 ASTContext::getDependentVectorType(QualType VecType, Expr *SizeExpr,
4000                                    SourceLocation AttrLoc,
4001                                    VectorType::VectorKind VecKind) const {
4002   llvm::FoldingSetNodeID ID;
4003   DependentVectorType::Profile(ID, *this, getCanonicalType(VecType), SizeExpr,
4004                                VecKind);
4005   void *InsertPos = nullptr;
4006   DependentVectorType *Canon =
4007       DependentVectorTypes.FindNodeOrInsertPos(ID, InsertPos);
4008   DependentVectorType *New;
4009 
4010   if (Canon) {
4011     New = new (*this, TypeAlignment) DependentVectorType(
4012         *this, VecType, QualType(Canon, 0), SizeExpr, AttrLoc, VecKind);
4013   } else {
4014     QualType CanonVecTy = getCanonicalType(VecType);
4015     if (CanonVecTy == VecType) {
4016       New = new (*this, TypeAlignment) DependentVectorType(
4017           *this, VecType, QualType(), SizeExpr, AttrLoc, VecKind);
4018 
4019       DependentVectorType *CanonCheck =
4020           DependentVectorTypes.FindNodeOrInsertPos(ID, InsertPos);
4021       assert(!CanonCheck &&
4022              "Dependent-sized vector_size canonical type broken");
4023       (void)CanonCheck;
4024       DependentVectorTypes.InsertNode(New, InsertPos);
4025     } else {
4026       QualType CanonTy = getDependentVectorType(CanonVecTy, SizeExpr,
4027                                                 SourceLocation(), VecKind);
4028       New = new (*this, TypeAlignment) DependentVectorType(
4029           *this, VecType, CanonTy, SizeExpr, AttrLoc, VecKind);
4030     }
4031   }
4032 
4033   Types.push_back(New);
4034   return QualType(New, 0);
4035 }
4036 
4037 /// getExtVectorType - Return the unique reference to an extended vector type of
4038 /// the specified element type and size. VectorType must be a built-in type.
4039 QualType
4040 ASTContext::getExtVectorType(QualType vecType, unsigned NumElts) const {
4041   assert(vecType->isBuiltinType() || vecType->isDependentType());
4042 
4043   // Check if we've already instantiated a vector of this type.
4044   llvm::FoldingSetNodeID ID;
4045   VectorType::Profile(ID, vecType, NumElts, Type::ExtVector,
4046                       VectorType::GenericVector);
4047   void *InsertPos = nullptr;
4048   if (VectorType *VTP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos))
4049     return QualType(VTP, 0);
4050 
4051   // If the element type isn't canonical, this won't be a canonical type either,
4052   // so fill in the canonical type field.
4053   QualType Canonical;
4054   if (!vecType.isCanonical()) {
4055     Canonical = getExtVectorType(getCanonicalType(vecType), NumElts);
4056 
4057     // Get the new insert position for the node we care about.
4058     VectorType *NewIP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos);
4059     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
4060   }
4061   auto *New = new (*this, TypeAlignment)
4062     ExtVectorType(vecType, NumElts, Canonical);
4063   VectorTypes.InsertNode(New, InsertPos);
4064   Types.push_back(New);
4065   return QualType(New, 0);
4066 }
4067 
4068 QualType
4069 ASTContext::getDependentSizedExtVectorType(QualType vecType,
4070                                            Expr *SizeExpr,
4071                                            SourceLocation AttrLoc) const {
4072   llvm::FoldingSetNodeID ID;
4073   DependentSizedExtVectorType::Profile(ID, *this, getCanonicalType(vecType),
4074                                        SizeExpr);
4075 
4076   void *InsertPos = nullptr;
4077   DependentSizedExtVectorType *Canon
4078     = DependentSizedExtVectorTypes.FindNodeOrInsertPos(ID, InsertPos);
4079   DependentSizedExtVectorType *New;
4080   if (Canon) {
4081     // We already have a canonical version of this array type; use it as
4082     // the canonical type for a newly-built type.
4083     New = new (*this, TypeAlignment)
4084       DependentSizedExtVectorType(*this, vecType, QualType(Canon, 0),
4085                                   SizeExpr, AttrLoc);
4086   } else {
4087     QualType CanonVecTy = getCanonicalType(vecType);
4088     if (CanonVecTy == vecType) {
4089       New = new (*this, TypeAlignment)
4090         DependentSizedExtVectorType(*this, vecType, QualType(), SizeExpr,
4091                                     AttrLoc);
4092 
4093       DependentSizedExtVectorType *CanonCheck
4094         = DependentSizedExtVectorTypes.FindNodeOrInsertPos(ID, InsertPos);
4095       assert(!CanonCheck && "Dependent-sized ext_vector canonical type broken");
4096       (void)CanonCheck;
4097       DependentSizedExtVectorTypes.InsertNode(New, InsertPos);
4098     } else {
4099       QualType CanonExtTy = getDependentSizedExtVectorType(CanonVecTy, SizeExpr,
4100                                                            SourceLocation());
4101       New = new (*this, TypeAlignment) DependentSizedExtVectorType(
4102           *this, vecType, CanonExtTy, SizeExpr, AttrLoc);
4103     }
4104   }
4105 
4106   Types.push_back(New);
4107   return QualType(New, 0);
4108 }
4109 
4110 QualType ASTContext::getConstantMatrixType(QualType ElementTy, unsigned NumRows,
4111                                            unsigned NumColumns) const {
4112   llvm::FoldingSetNodeID ID;
4113   ConstantMatrixType::Profile(ID, ElementTy, NumRows, NumColumns,
4114                               Type::ConstantMatrix);
4115 
4116   assert(MatrixType::isValidElementType(ElementTy) &&
4117          "need a valid element type");
4118   assert(ConstantMatrixType::isDimensionValid(NumRows) &&
4119          ConstantMatrixType::isDimensionValid(NumColumns) &&
4120          "need valid matrix dimensions");
4121   void *InsertPos = nullptr;
4122   if (ConstantMatrixType *MTP = MatrixTypes.FindNodeOrInsertPos(ID, InsertPos))
4123     return QualType(MTP, 0);
4124 
4125   QualType Canonical;
4126   if (!ElementTy.isCanonical()) {
4127     Canonical =
4128         getConstantMatrixType(getCanonicalType(ElementTy), NumRows, NumColumns);
4129 
4130     ConstantMatrixType *NewIP = MatrixTypes.FindNodeOrInsertPos(ID, InsertPos);
4131     assert(!NewIP && "Matrix type shouldn't already exist in the map");
4132     (void)NewIP;
4133   }
4134 
4135   auto *New = new (*this, TypeAlignment)
4136       ConstantMatrixType(ElementTy, NumRows, NumColumns, Canonical);
4137   MatrixTypes.InsertNode(New, InsertPos);
4138   Types.push_back(New);
4139   return QualType(New, 0);
4140 }
4141 
4142 QualType ASTContext::getDependentSizedMatrixType(QualType ElementTy,
4143                                                  Expr *RowExpr,
4144                                                  Expr *ColumnExpr,
4145                                                  SourceLocation AttrLoc) const {
4146   QualType CanonElementTy = getCanonicalType(ElementTy);
4147   llvm::FoldingSetNodeID ID;
4148   DependentSizedMatrixType::Profile(ID, *this, CanonElementTy, RowExpr,
4149                                     ColumnExpr);
4150 
4151   void *InsertPos = nullptr;
4152   DependentSizedMatrixType *Canon =
4153       DependentSizedMatrixTypes.FindNodeOrInsertPos(ID, InsertPos);
4154 
4155   if (!Canon) {
4156     Canon = new (*this, TypeAlignment) DependentSizedMatrixType(
4157         *this, CanonElementTy, QualType(), RowExpr, ColumnExpr, AttrLoc);
4158 #ifndef NDEBUG
4159     DependentSizedMatrixType *CanonCheck =
4160         DependentSizedMatrixTypes.FindNodeOrInsertPos(ID, InsertPos);
4161     assert(!CanonCheck && "Dependent-sized matrix canonical type broken");
4162 #endif
4163     DependentSizedMatrixTypes.InsertNode(Canon, InsertPos);
4164     Types.push_back(Canon);
4165   }
4166 
4167   // Already have a canonical version of the matrix type
4168   //
4169   // If it exactly matches the requested type, use it directly.
4170   if (Canon->getElementType() == ElementTy && Canon->getRowExpr() == RowExpr &&
4171       Canon->getRowExpr() == ColumnExpr)
4172     return QualType(Canon, 0);
4173 
4174   // Use Canon as the canonical type for newly-built type.
4175   DependentSizedMatrixType *New = new (*this, TypeAlignment)
4176       DependentSizedMatrixType(*this, ElementTy, QualType(Canon, 0), RowExpr,
4177                                ColumnExpr, AttrLoc);
4178   Types.push_back(New);
4179   return QualType(New, 0);
4180 }
4181 
4182 QualType ASTContext::getDependentAddressSpaceType(QualType PointeeType,
4183                                                   Expr *AddrSpaceExpr,
4184                                                   SourceLocation AttrLoc) const {
4185   assert(AddrSpaceExpr->isInstantiationDependent());
4186 
4187   QualType canonPointeeType = getCanonicalType(PointeeType);
4188 
4189   void *insertPos = nullptr;
4190   llvm::FoldingSetNodeID ID;
4191   DependentAddressSpaceType::Profile(ID, *this, canonPointeeType,
4192                                      AddrSpaceExpr);
4193 
4194   DependentAddressSpaceType *canonTy =
4195     DependentAddressSpaceTypes.FindNodeOrInsertPos(ID, insertPos);
4196 
4197   if (!canonTy) {
4198     canonTy = new (*this, TypeAlignment)
4199       DependentAddressSpaceType(*this, canonPointeeType,
4200                                 QualType(), AddrSpaceExpr, AttrLoc);
4201     DependentAddressSpaceTypes.InsertNode(canonTy, insertPos);
4202     Types.push_back(canonTy);
4203   }
4204 
4205   if (canonPointeeType == PointeeType &&
4206       canonTy->getAddrSpaceExpr() == AddrSpaceExpr)
4207     return QualType(canonTy, 0);
4208 
4209   auto *sugaredType
4210     = new (*this, TypeAlignment)
4211         DependentAddressSpaceType(*this, PointeeType, QualType(canonTy, 0),
4212                                   AddrSpaceExpr, AttrLoc);
4213   Types.push_back(sugaredType);
4214   return QualType(sugaredType, 0);
4215 }
4216 
4217 /// Determine whether \p T is canonical as the result type of a function.
4218 static bool isCanonicalResultType(QualType T) {
4219   return T.isCanonical() &&
4220          (T.getObjCLifetime() == Qualifiers::OCL_None ||
4221           T.getObjCLifetime() == Qualifiers::OCL_ExplicitNone);
4222 }
4223 
4224 /// getFunctionNoProtoType - Return a K&R style C function type like 'int()'.
4225 QualType
4226 ASTContext::getFunctionNoProtoType(QualType ResultTy,
4227                                    const FunctionType::ExtInfo &Info) const {
4228   // Unique functions, to guarantee there is only one function of a particular
4229   // structure.
4230   llvm::FoldingSetNodeID ID;
4231   FunctionNoProtoType::Profile(ID, ResultTy, Info);
4232 
4233   void *InsertPos = nullptr;
4234   if (FunctionNoProtoType *FT =
4235         FunctionNoProtoTypes.FindNodeOrInsertPos(ID, InsertPos))
4236     return QualType(FT, 0);
4237 
4238   QualType Canonical;
4239   if (!isCanonicalResultType(ResultTy)) {
4240     Canonical =
4241       getFunctionNoProtoType(getCanonicalFunctionResultType(ResultTy), Info);
4242 
4243     // Get the new insert position for the node we care about.
4244     FunctionNoProtoType *NewIP =
4245       FunctionNoProtoTypes.FindNodeOrInsertPos(ID, InsertPos);
4246     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
4247   }
4248 
4249   auto *New = new (*this, TypeAlignment)
4250     FunctionNoProtoType(ResultTy, Canonical, Info);
4251   Types.push_back(New);
4252   FunctionNoProtoTypes.InsertNode(New, InsertPos);
4253   return QualType(New, 0);
4254 }
4255 
4256 CanQualType
4257 ASTContext::getCanonicalFunctionResultType(QualType ResultType) const {
4258   CanQualType CanResultType = getCanonicalType(ResultType);
4259 
4260   // Canonical result types do not have ARC lifetime qualifiers.
4261   if (CanResultType.getQualifiers().hasObjCLifetime()) {
4262     Qualifiers Qs = CanResultType.getQualifiers();
4263     Qs.removeObjCLifetime();
4264     return CanQualType::CreateUnsafe(
4265              getQualifiedType(CanResultType.getUnqualifiedType(), Qs));
4266   }
4267 
4268   return CanResultType;
4269 }
4270 
4271 static bool isCanonicalExceptionSpecification(
4272     const FunctionProtoType::ExceptionSpecInfo &ESI, bool NoexceptInType) {
4273   if (ESI.Type == EST_None)
4274     return true;
4275   if (!NoexceptInType)
4276     return false;
4277 
4278   // C++17 onwards: exception specification is part of the type, as a simple
4279   // boolean "can this function type throw".
4280   if (ESI.Type == EST_BasicNoexcept)
4281     return true;
4282 
4283   // A noexcept(expr) specification is (possibly) canonical if expr is
4284   // value-dependent.
4285   if (ESI.Type == EST_DependentNoexcept)
4286     return true;
4287 
4288   // A dynamic exception specification is canonical if it only contains pack
4289   // expansions (so we can't tell whether it's non-throwing) and all its
4290   // contained types are canonical.
4291   if (ESI.Type == EST_Dynamic) {
4292     bool AnyPackExpansions = false;
4293     for (QualType ET : ESI.Exceptions) {
4294       if (!ET.isCanonical())
4295         return false;
4296       if (ET->getAs<PackExpansionType>())
4297         AnyPackExpansions = true;
4298     }
4299     return AnyPackExpansions;
4300   }
4301 
4302   return false;
4303 }
4304 
4305 QualType ASTContext::getFunctionTypeInternal(
4306     QualType ResultTy, ArrayRef<QualType> ArgArray,
4307     const FunctionProtoType::ExtProtoInfo &EPI, bool OnlyWantCanonical) const {
4308   size_t NumArgs = ArgArray.size();
4309 
4310   // Unique functions, to guarantee there is only one function of a particular
4311   // structure.
4312   llvm::FoldingSetNodeID ID;
4313   FunctionProtoType::Profile(ID, ResultTy, ArgArray.begin(), NumArgs, EPI,
4314                              *this, true);
4315 
4316   QualType Canonical;
4317   bool Unique = false;
4318 
4319   void *InsertPos = nullptr;
4320   if (FunctionProtoType *FPT =
4321         FunctionProtoTypes.FindNodeOrInsertPos(ID, InsertPos)) {
4322     QualType Existing = QualType(FPT, 0);
4323 
4324     // If we find a pre-existing equivalent FunctionProtoType, we can just reuse
4325     // it so long as our exception specification doesn't contain a dependent
4326     // noexcept expression, or we're just looking for a canonical type.
4327     // Otherwise, we're going to need to create a type
4328     // sugar node to hold the concrete expression.
4329     if (OnlyWantCanonical || !isComputedNoexcept(EPI.ExceptionSpec.Type) ||
4330         EPI.ExceptionSpec.NoexceptExpr == FPT->getNoexceptExpr())
4331       return Existing;
4332 
4333     // We need a new type sugar node for this one, to hold the new noexcept
4334     // expression. We do no canonicalization here, but that's OK since we don't
4335     // expect to see the same noexcept expression much more than once.
4336     Canonical = getCanonicalType(Existing);
4337     Unique = true;
4338   }
4339 
4340   bool NoexceptInType = getLangOpts().CPlusPlus17;
4341   bool IsCanonicalExceptionSpec =
4342       isCanonicalExceptionSpecification(EPI.ExceptionSpec, NoexceptInType);
4343 
4344   // Determine whether the type being created is already canonical or not.
4345   bool isCanonical = !Unique && IsCanonicalExceptionSpec &&
4346                      isCanonicalResultType(ResultTy) && !EPI.HasTrailingReturn;
4347   for (unsigned i = 0; i != NumArgs && isCanonical; ++i)
4348     if (!ArgArray[i].isCanonicalAsParam())
4349       isCanonical = false;
4350 
4351   if (OnlyWantCanonical)
4352     assert(isCanonical &&
4353            "given non-canonical parameters constructing canonical type");
4354 
4355   // If this type isn't canonical, get the canonical version of it if we don't
4356   // already have it. The exception spec is only partially part of the
4357   // canonical type, and only in C++17 onwards.
4358   if (!isCanonical && Canonical.isNull()) {
4359     SmallVector<QualType, 16> CanonicalArgs;
4360     CanonicalArgs.reserve(NumArgs);
4361     for (unsigned i = 0; i != NumArgs; ++i)
4362       CanonicalArgs.push_back(getCanonicalParamType(ArgArray[i]));
4363 
4364     llvm::SmallVector<QualType, 8> ExceptionTypeStorage;
4365     FunctionProtoType::ExtProtoInfo CanonicalEPI = EPI;
4366     CanonicalEPI.HasTrailingReturn = false;
4367 
4368     if (IsCanonicalExceptionSpec) {
4369       // Exception spec is already OK.
4370     } else if (NoexceptInType) {
4371       switch (EPI.ExceptionSpec.Type) {
4372       case EST_Unparsed: case EST_Unevaluated: case EST_Uninstantiated:
4373         // We don't know yet. It shouldn't matter what we pick here; no-one
4374         // should ever look at this.
4375         LLVM_FALLTHROUGH;
4376       case EST_None: case EST_MSAny: case EST_NoexceptFalse:
4377         CanonicalEPI.ExceptionSpec.Type = EST_None;
4378         break;
4379 
4380         // A dynamic exception specification is almost always "not noexcept",
4381         // with the exception that a pack expansion might expand to no types.
4382       case EST_Dynamic: {
4383         bool AnyPacks = false;
4384         for (QualType ET : EPI.ExceptionSpec.Exceptions) {
4385           if (ET->getAs<PackExpansionType>())
4386             AnyPacks = true;
4387           ExceptionTypeStorage.push_back(getCanonicalType(ET));
4388         }
4389         if (!AnyPacks)
4390           CanonicalEPI.ExceptionSpec.Type = EST_None;
4391         else {
4392           CanonicalEPI.ExceptionSpec.Type = EST_Dynamic;
4393           CanonicalEPI.ExceptionSpec.Exceptions = ExceptionTypeStorage;
4394         }
4395         break;
4396       }
4397 
4398       case EST_DynamicNone:
4399       case EST_BasicNoexcept:
4400       case EST_NoexceptTrue:
4401       case EST_NoThrow:
4402         CanonicalEPI.ExceptionSpec.Type = EST_BasicNoexcept;
4403         break;
4404 
4405       case EST_DependentNoexcept:
4406         llvm_unreachable("dependent noexcept is already canonical");
4407       }
4408     } else {
4409       CanonicalEPI.ExceptionSpec = FunctionProtoType::ExceptionSpecInfo();
4410     }
4411 
4412     // Adjust the canonical function result type.
4413     CanQualType CanResultTy = getCanonicalFunctionResultType(ResultTy);
4414     Canonical =
4415         getFunctionTypeInternal(CanResultTy, CanonicalArgs, CanonicalEPI, true);
4416 
4417     // Get the new insert position for the node we care about.
4418     FunctionProtoType *NewIP =
4419       FunctionProtoTypes.FindNodeOrInsertPos(ID, InsertPos);
4420     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
4421   }
4422 
4423   // Compute the needed size to hold this FunctionProtoType and the
4424   // various trailing objects.
4425   auto ESH = FunctionProtoType::getExceptionSpecSize(
4426       EPI.ExceptionSpec.Type, EPI.ExceptionSpec.Exceptions.size());
4427   size_t Size = FunctionProtoType::totalSizeToAlloc<
4428       QualType, SourceLocation, FunctionType::FunctionTypeExtraBitfields,
4429       FunctionType::ExceptionType, Expr *, FunctionDecl *,
4430       FunctionProtoType::ExtParameterInfo, Qualifiers>(
4431       NumArgs, EPI.Variadic,
4432       FunctionProtoType::hasExtraBitfields(EPI.ExceptionSpec.Type),
4433       ESH.NumExceptionType, ESH.NumExprPtr, ESH.NumFunctionDeclPtr,
4434       EPI.ExtParameterInfos ? NumArgs : 0,
4435       EPI.TypeQuals.hasNonFastQualifiers() ? 1 : 0);
4436 
4437   auto *FTP = (FunctionProtoType *)Allocate(Size, TypeAlignment);
4438   FunctionProtoType::ExtProtoInfo newEPI = EPI;
4439   new (FTP) FunctionProtoType(ResultTy, ArgArray, Canonical, newEPI);
4440   Types.push_back(FTP);
4441   if (!Unique)
4442     FunctionProtoTypes.InsertNode(FTP, InsertPos);
4443   return QualType(FTP, 0);
4444 }
4445 
4446 QualType ASTContext::getPipeType(QualType T, bool ReadOnly) const {
4447   llvm::FoldingSetNodeID ID;
4448   PipeType::Profile(ID, T, ReadOnly);
4449 
4450   void *InsertPos = nullptr;
4451   if (PipeType *PT = PipeTypes.FindNodeOrInsertPos(ID, InsertPos))
4452     return QualType(PT, 0);
4453 
4454   // If the pipe element type isn't canonical, this won't be a canonical type
4455   // either, so fill in the canonical type field.
4456   QualType Canonical;
4457   if (!T.isCanonical()) {
4458     Canonical = getPipeType(getCanonicalType(T), ReadOnly);
4459 
4460     // Get the new insert position for the node we care about.
4461     PipeType *NewIP = PipeTypes.FindNodeOrInsertPos(ID, InsertPos);
4462     assert(!NewIP && "Shouldn't be in the map!");
4463     (void)NewIP;
4464   }
4465   auto *New = new (*this, TypeAlignment) PipeType(T, Canonical, ReadOnly);
4466   Types.push_back(New);
4467   PipeTypes.InsertNode(New, InsertPos);
4468   return QualType(New, 0);
4469 }
4470 
4471 QualType ASTContext::adjustStringLiteralBaseType(QualType Ty) const {
4472   // OpenCL v1.1 s6.5.3: a string literal is in the constant address space.
4473   return LangOpts.OpenCL ? getAddrSpaceQualType(Ty, LangAS::opencl_constant)
4474                          : Ty;
4475 }
4476 
4477 QualType ASTContext::getReadPipeType(QualType T) const {
4478   return getPipeType(T, true);
4479 }
4480 
4481 QualType ASTContext::getWritePipeType(QualType T) const {
4482   return getPipeType(T, false);
4483 }
4484 
4485 QualType ASTContext::getExtIntType(bool IsUnsigned, unsigned NumBits) const {
4486   llvm::FoldingSetNodeID ID;
4487   ExtIntType::Profile(ID, IsUnsigned, NumBits);
4488 
4489   void *InsertPos = nullptr;
4490   if (ExtIntType *EIT = ExtIntTypes.FindNodeOrInsertPos(ID, InsertPos))
4491     return QualType(EIT, 0);
4492 
4493   auto *New = new (*this, TypeAlignment) ExtIntType(IsUnsigned, NumBits);
4494   ExtIntTypes.InsertNode(New, InsertPos);
4495   Types.push_back(New);
4496   return QualType(New, 0);
4497 }
4498 
4499 QualType ASTContext::getDependentExtIntType(bool IsUnsigned,
4500                                             Expr *NumBitsExpr) const {
4501   assert(NumBitsExpr->isInstantiationDependent() && "Only good for dependent");
4502   llvm::FoldingSetNodeID ID;
4503   DependentExtIntType::Profile(ID, *this, IsUnsigned, NumBitsExpr);
4504 
4505   void *InsertPos = nullptr;
4506   if (DependentExtIntType *Existing =
4507           DependentExtIntTypes.FindNodeOrInsertPos(ID, InsertPos))
4508     return QualType(Existing, 0);
4509 
4510   auto *New = new (*this, TypeAlignment)
4511       DependentExtIntType(*this, IsUnsigned, NumBitsExpr);
4512   DependentExtIntTypes.InsertNode(New, InsertPos);
4513 
4514   Types.push_back(New);
4515   return QualType(New, 0);
4516 }
4517 
4518 #ifndef NDEBUG
4519 static bool NeedsInjectedClassNameType(const RecordDecl *D) {
4520   if (!isa<CXXRecordDecl>(D)) return false;
4521   const auto *RD = cast<CXXRecordDecl>(D);
4522   if (isa<ClassTemplatePartialSpecializationDecl>(RD))
4523     return true;
4524   if (RD->getDescribedClassTemplate() &&
4525       !isa<ClassTemplateSpecializationDecl>(RD))
4526     return true;
4527   return false;
4528 }
4529 #endif
4530 
4531 /// getInjectedClassNameType - Return the unique reference to the
4532 /// injected class name type for the specified templated declaration.
4533 QualType ASTContext::getInjectedClassNameType(CXXRecordDecl *Decl,
4534                                               QualType TST) const {
4535   assert(NeedsInjectedClassNameType(Decl));
4536   if (Decl->TypeForDecl) {
4537     assert(isa<InjectedClassNameType>(Decl->TypeForDecl));
4538   } else if (CXXRecordDecl *PrevDecl = Decl->getPreviousDecl()) {
4539     assert(PrevDecl->TypeForDecl && "previous declaration has no type");
4540     Decl->TypeForDecl = PrevDecl->TypeForDecl;
4541     assert(isa<InjectedClassNameType>(Decl->TypeForDecl));
4542   } else {
4543     Type *newType =
4544       new (*this, TypeAlignment) InjectedClassNameType(Decl, TST);
4545     Decl->TypeForDecl = newType;
4546     Types.push_back(newType);
4547   }
4548   return QualType(Decl->TypeForDecl, 0);
4549 }
4550 
4551 /// getTypeDeclType - Return the unique reference to the type for the
4552 /// specified type declaration.
4553 QualType ASTContext::getTypeDeclTypeSlow(const TypeDecl *Decl) const {
4554   assert(Decl && "Passed null for Decl param");
4555   assert(!Decl->TypeForDecl && "TypeForDecl present in slow case");
4556 
4557   if (const auto *Typedef = dyn_cast<TypedefNameDecl>(Decl))
4558     return getTypedefType(Typedef);
4559 
4560   assert(!isa<TemplateTypeParmDecl>(Decl) &&
4561          "Template type parameter types are always available.");
4562 
4563   if (const auto *Record = dyn_cast<RecordDecl>(Decl)) {
4564     assert(Record->isFirstDecl() && "struct/union has previous declaration");
4565     assert(!NeedsInjectedClassNameType(Record));
4566     return getRecordType(Record);
4567   } else if (const auto *Enum = dyn_cast<EnumDecl>(Decl)) {
4568     assert(Enum->isFirstDecl() && "enum has previous declaration");
4569     return getEnumType(Enum);
4570   } else if (const auto *Using = dyn_cast<UnresolvedUsingTypenameDecl>(Decl)) {
4571     Type *newType = new (*this, TypeAlignment) UnresolvedUsingType(Using);
4572     Decl->TypeForDecl = newType;
4573     Types.push_back(newType);
4574   } else
4575     llvm_unreachable("TypeDecl without a type?");
4576 
4577   return QualType(Decl->TypeForDecl, 0);
4578 }
4579 
4580 /// getTypedefType - Return the unique reference to the type for the
4581 /// specified typedef name decl.
4582 QualType ASTContext::getTypedefType(const TypedefNameDecl *Decl,
4583                                     QualType Underlying) const {
4584   if (Decl->TypeForDecl) return QualType(Decl->TypeForDecl, 0);
4585 
4586   if (Underlying.isNull())
4587     Underlying = Decl->getUnderlyingType();
4588   QualType Canonical = getCanonicalType(Underlying);
4589   auto *newType = new (*this, TypeAlignment)
4590       TypedefType(Type::Typedef, Decl, Underlying, Canonical);
4591   Decl->TypeForDecl = newType;
4592   Types.push_back(newType);
4593   return QualType(newType, 0);
4594 }
4595 
4596 QualType ASTContext::getRecordType(const RecordDecl *Decl) const {
4597   if (Decl->TypeForDecl) return QualType(Decl->TypeForDecl, 0);
4598 
4599   if (const RecordDecl *PrevDecl = Decl->getPreviousDecl())
4600     if (PrevDecl->TypeForDecl)
4601       return QualType(Decl->TypeForDecl = PrevDecl->TypeForDecl, 0);
4602 
4603   auto *newType = new (*this, TypeAlignment) RecordType(Decl);
4604   Decl->TypeForDecl = newType;
4605   Types.push_back(newType);
4606   return QualType(newType, 0);
4607 }
4608 
4609 QualType ASTContext::getEnumType(const EnumDecl *Decl) const {
4610   if (Decl->TypeForDecl) return QualType(Decl->TypeForDecl, 0);
4611 
4612   if (const EnumDecl *PrevDecl = Decl->getPreviousDecl())
4613     if (PrevDecl->TypeForDecl)
4614       return QualType(Decl->TypeForDecl = PrevDecl->TypeForDecl, 0);
4615 
4616   auto *newType = new (*this, TypeAlignment) EnumType(Decl);
4617   Decl->TypeForDecl = newType;
4618   Types.push_back(newType);
4619   return QualType(newType, 0);
4620 }
4621 
4622 QualType ASTContext::getAttributedType(attr::Kind attrKind,
4623                                        QualType modifiedType,
4624                                        QualType equivalentType) {
4625   llvm::FoldingSetNodeID id;
4626   AttributedType::Profile(id, attrKind, modifiedType, equivalentType);
4627 
4628   void *insertPos = nullptr;
4629   AttributedType *type = AttributedTypes.FindNodeOrInsertPos(id, insertPos);
4630   if (type) return QualType(type, 0);
4631 
4632   QualType canon = getCanonicalType(equivalentType);
4633   type = new (*this, TypeAlignment)
4634       AttributedType(canon, attrKind, modifiedType, equivalentType);
4635 
4636   Types.push_back(type);
4637   AttributedTypes.InsertNode(type, insertPos);
4638 
4639   return QualType(type, 0);
4640 }
4641 
4642 /// Retrieve a substitution-result type.
4643 QualType
4644 ASTContext::getSubstTemplateTypeParmType(const TemplateTypeParmType *Parm,
4645                                          QualType Replacement) const {
4646   assert(Replacement.isCanonical()
4647          && "replacement types must always be canonical");
4648 
4649   llvm::FoldingSetNodeID ID;
4650   SubstTemplateTypeParmType::Profile(ID, Parm, Replacement);
4651   void *InsertPos = nullptr;
4652   SubstTemplateTypeParmType *SubstParm
4653     = SubstTemplateTypeParmTypes.FindNodeOrInsertPos(ID, InsertPos);
4654 
4655   if (!SubstParm) {
4656     SubstParm = new (*this, TypeAlignment)
4657       SubstTemplateTypeParmType(Parm, Replacement);
4658     Types.push_back(SubstParm);
4659     SubstTemplateTypeParmTypes.InsertNode(SubstParm, InsertPos);
4660   }
4661 
4662   return QualType(SubstParm, 0);
4663 }
4664 
4665 /// Retrieve a
4666 QualType ASTContext::getSubstTemplateTypeParmPackType(
4667                                           const TemplateTypeParmType *Parm,
4668                                               const TemplateArgument &ArgPack) {
4669 #ifndef NDEBUG
4670   for (const auto &P : ArgPack.pack_elements()) {
4671     assert(P.getKind() == TemplateArgument::Type &&"Pack contains a non-type");
4672     assert(P.getAsType().isCanonical() && "Pack contains non-canonical type");
4673   }
4674 #endif
4675 
4676   llvm::FoldingSetNodeID ID;
4677   SubstTemplateTypeParmPackType::Profile(ID, Parm, ArgPack);
4678   void *InsertPos = nullptr;
4679   if (SubstTemplateTypeParmPackType *SubstParm
4680         = SubstTemplateTypeParmPackTypes.FindNodeOrInsertPos(ID, InsertPos))
4681     return QualType(SubstParm, 0);
4682 
4683   QualType Canon;
4684   if (!Parm->isCanonicalUnqualified()) {
4685     Canon = getCanonicalType(QualType(Parm, 0));
4686     Canon = getSubstTemplateTypeParmPackType(cast<TemplateTypeParmType>(Canon),
4687                                              ArgPack);
4688     SubstTemplateTypeParmPackTypes.FindNodeOrInsertPos(ID, InsertPos);
4689   }
4690 
4691   auto *SubstParm
4692     = new (*this, TypeAlignment) SubstTemplateTypeParmPackType(Parm, Canon,
4693                                                                ArgPack);
4694   Types.push_back(SubstParm);
4695   SubstTemplateTypeParmPackTypes.InsertNode(SubstParm, InsertPos);
4696   return QualType(SubstParm, 0);
4697 }
4698 
4699 /// Retrieve the template type parameter type for a template
4700 /// parameter or parameter pack with the given depth, index, and (optionally)
4701 /// name.
4702 QualType ASTContext::getTemplateTypeParmType(unsigned Depth, unsigned Index,
4703                                              bool ParameterPack,
4704                                              TemplateTypeParmDecl *TTPDecl) const {
4705   llvm::FoldingSetNodeID ID;
4706   TemplateTypeParmType::Profile(ID, Depth, Index, ParameterPack, TTPDecl);
4707   void *InsertPos = nullptr;
4708   TemplateTypeParmType *TypeParm
4709     = TemplateTypeParmTypes.FindNodeOrInsertPos(ID, InsertPos);
4710 
4711   if (TypeParm)
4712     return QualType(TypeParm, 0);
4713 
4714   if (TTPDecl) {
4715     QualType Canon = getTemplateTypeParmType(Depth, Index, ParameterPack);
4716     TypeParm = new (*this, TypeAlignment) TemplateTypeParmType(TTPDecl, Canon);
4717 
4718     TemplateTypeParmType *TypeCheck
4719       = TemplateTypeParmTypes.FindNodeOrInsertPos(ID, InsertPos);
4720     assert(!TypeCheck && "Template type parameter canonical type broken");
4721     (void)TypeCheck;
4722   } else
4723     TypeParm = new (*this, TypeAlignment)
4724       TemplateTypeParmType(Depth, Index, ParameterPack);
4725 
4726   Types.push_back(TypeParm);
4727   TemplateTypeParmTypes.InsertNode(TypeParm, InsertPos);
4728 
4729   return QualType(TypeParm, 0);
4730 }
4731 
4732 TypeSourceInfo *
4733 ASTContext::getTemplateSpecializationTypeInfo(TemplateName Name,
4734                                               SourceLocation NameLoc,
4735                                         const TemplateArgumentListInfo &Args,
4736                                               QualType Underlying) const {
4737   assert(!Name.getAsDependentTemplateName() &&
4738          "No dependent template names here!");
4739   QualType TST = getTemplateSpecializationType(Name, Args, Underlying);
4740 
4741   TypeSourceInfo *DI = CreateTypeSourceInfo(TST);
4742   TemplateSpecializationTypeLoc TL =
4743       DI->getTypeLoc().castAs<TemplateSpecializationTypeLoc>();
4744   TL.setTemplateKeywordLoc(SourceLocation());
4745   TL.setTemplateNameLoc(NameLoc);
4746   TL.setLAngleLoc(Args.getLAngleLoc());
4747   TL.setRAngleLoc(Args.getRAngleLoc());
4748   for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
4749     TL.setArgLocInfo(i, Args[i].getLocInfo());
4750   return DI;
4751 }
4752 
4753 QualType
4754 ASTContext::getTemplateSpecializationType(TemplateName Template,
4755                                           const TemplateArgumentListInfo &Args,
4756                                           QualType Underlying) const {
4757   assert(!Template.getAsDependentTemplateName() &&
4758          "No dependent template names here!");
4759 
4760   SmallVector<TemplateArgument, 4> ArgVec;
4761   ArgVec.reserve(Args.size());
4762   for (const TemplateArgumentLoc &Arg : Args.arguments())
4763     ArgVec.push_back(Arg.getArgument());
4764 
4765   return getTemplateSpecializationType(Template, ArgVec, Underlying);
4766 }
4767 
4768 #ifndef NDEBUG
4769 static bool hasAnyPackExpansions(ArrayRef<TemplateArgument> Args) {
4770   for (const TemplateArgument &Arg : Args)
4771     if (Arg.isPackExpansion())
4772       return true;
4773 
4774   return true;
4775 }
4776 #endif
4777 
4778 QualType
4779 ASTContext::getTemplateSpecializationType(TemplateName Template,
4780                                           ArrayRef<TemplateArgument> Args,
4781                                           QualType Underlying) const {
4782   assert(!Template.getAsDependentTemplateName() &&
4783          "No dependent template names here!");
4784   // Look through qualified template names.
4785   if (QualifiedTemplateName *QTN = Template.getAsQualifiedTemplateName())
4786     Template = TemplateName(QTN->getTemplateDecl());
4787 
4788   bool IsTypeAlias =
4789     Template.getAsTemplateDecl() &&
4790     isa<TypeAliasTemplateDecl>(Template.getAsTemplateDecl());
4791   QualType CanonType;
4792   if (!Underlying.isNull())
4793     CanonType = getCanonicalType(Underlying);
4794   else {
4795     // We can get here with an alias template when the specialization contains
4796     // a pack expansion that does not match up with a parameter pack.
4797     assert((!IsTypeAlias || hasAnyPackExpansions(Args)) &&
4798            "Caller must compute aliased type");
4799     IsTypeAlias = false;
4800     CanonType = getCanonicalTemplateSpecializationType(Template, Args);
4801   }
4802 
4803   // Allocate the (non-canonical) template specialization type, but don't
4804   // try to unique it: these types typically have location information that
4805   // we don't unique and don't want to lose.
4806   void *Mem = Allocate(sizeof(TemplateSpecializationType) +
4807                        sizeof(TemplateArgument) * Args.size() +
4808                        (IsTypeAlias? sizeof(QualType) : 0),
4809                        TypeAlignment);
4810   auto *Spec
4811     = new (Mem) TemplateSpecializationType(Template, Args, CanonType,
4812                                          IsTypeAlias ? Underlying : QualType());
4813 
4814   Types.push_back(Spec);
4815   return QualType(Spec, 0);
4816 }
4817 
4818 QualType ASTContext::getCanonicalTemplateSpecializationType(
4819     TemplateName Template, ArrayRef<TemplateArgument> Args) const {
4820   assert(!Template.getAsDependentTemplateName() &&
4821          "No dependent template names here!");
4822 
4823   // Look through qualified template names.
4824   if (QualifiedTemplateName *QTN = Template.getAsQualifiedTemplateName())
4825     Template = TemplateName(QTN->getTemplateDecl());
4826 
4827   // Build the canonical template specialization type.
4828   TemplateName CanonTemplate = getCanonicalTemplateName(Template);
4829   SmallVector<TemplateArgument, 4> CanonArgs;
4830   unsigned NumArgs = Args.size();
4831   CanonArgs.reserve(NumArgs);
4832   for (const TemplateArgument &Arg : Args)
4833     CanonArgs.push_back(getCanonicalTemplateArgument(Arg));
4834 
4835   // Determine whether this canonical template specialization type already
4836   // exists.
4837   llvm::FoldingSetNodeID ID;
4838   TemplateSpecializationType::Profile(ID, CanonTemplate,
4839                                       CanonArgs, *this);
4840 
4841   void *InsertPos = nullptr;
4842   TemplateSpecializationType *Spec
4843     = TemplateSpecializationTypes.FindNodeOrInsertPos(ID, InsertPos);
4844 
4845   if (!Spec) {
4846     // Allocate a new canonical template specialization type.
4847     void *Mem = Allocate((sizeof(TemplateSpecializationType) +
4848                           sizeof(TemplateArgument) * NumArgs),
4849                          TypeAlignment);
4850     Spec = new (Mem) TemplateSpecializationType(CanonTemplate,
4851                                                 CanonArgs,
4852                                                 QualType(), QualType());
4853     Types.push_back(Spec);
4854     TemplateSpecializationTypes.InsertNode(Spec, InsertPos);
4855   }
4856 
4857   assert(Spec->isDependentType() &&
4858          "Non-dependent template-id type must have a canonical type");
4859   return QualType(Spec, 0);
4860 }
4861 
4862 QualType ASTContext::getElaboratedType(ElaboratedTypeKeyword Keyword,
4863                                        NestedNameSpecifier *NNS,
4864                                        QualType NamedType,
4865                                        TagDecl *OwnedTagDecl) const {
4866   llvm::FoldingSetNodeID ID;
4867   ElaboratedType::Profile(ID, Keyword, NNS, NamedType, OwnedTagDecl);
4868 
4869   void *InsertPos = nullptr;
4870   ElaboratedType *T = ElaboratedTypes.FindNodeOrInsertPos(ID, InsertPos);
4871   if (T)
4872     return QualType(T, 0);
4873 
4874   QualType Canon = NamedType;
4875   if (!Canon.isCanonical()) {
4876     Canon = getCanonicalType(NamedType);
4877     ElaboratedType *CheckT = ElaboratedTypes.FindNodeOrInsertPos(ID, InsertPos);
4878     assert(!CheckT && "Elaborated canonical type broken");
4879     (void)CheckT;
4880   }
4881 
4882   void *Mem = Allocate(ElaboratedType::totalSizeToAlloc<TagDecl *>(!!OwnedTagDecl),
4883                        TypeAlignment);
4884   T = new (Mem) ElaboratedType(Keyword, NNS, NamedType, Canon, OwnedTagDecl);
4885 
4886   Types.push_back(T);
4887   ElaboratedTypes.InsertNode(T, InsertPos);
4888   return QualType(T, 0);
4889 }
4890 
4891 QualType
4892 ASTContext::getParenType(QualType InnerType) const {
4893   llvm::FoldingSetNodeID ID;
4894   ParenType::Profile(ID, InnerType);
4895 
4896   void *InsertPos = nullptr;
4897   ParenType *T = ParenTypes.FindNodeOrInsertPos(ID, InsertPos);
4898   if (T)
4899     return QualType(T, 0);
4900 
4901   QualType Canon = InnerType;
4902   if (!Canon.isCanonical()) {
4903     Canon = getCanonicalType(InnerType);
4904     ParenType *CheckT = ParenTypes.FindNodeOrInsertPos(ID, InsertPos);
4905     assert(!CheckT && "Paren canonical type broken");
4906     (void)CheckT;
4907   }
4908 
4909   T = new (*this, TypeAlignment) ParenType(InnerType, Canon);
4910   Types.push_back(T);
4911   ParenTypes.InsertNode(T, InsertPos);
4912   return QualType(T, 0);
4913 }
4914 
4915 QualType
4916 ASTContext::getMacroQualifiedType(QualType UnderlyingTy,
4917                                   const IdentifierInfo *MacroII) const {
4918   QualType Canon = UnderlyingTy;
4919   if (!Canon.isCanonical())
4920     Canon = getCanonicalType(UnderlyingTy);
4921 
4922   auto *newType = new (*this, TypeAlignment)
4923       MacroQualifiedType(UnderlyingTy, Canon, MacroII);
4924   Types.push_back(newType);
4925   return QualType(newType, 0);
4926 }
4927 
4928 QualType ASTContext::getDependentNameType(ElaboratedTypeKeyword Keyword,
4929                                           NestedNameSpecifier *NNS,
4930                                           const IdentifierInfo *Name,
4931                                           QualType Canon) const {
4932   if (Canon.isNull()) {
4933     NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
4934     if (CanonNNS != NNS)
4935       Canon = getDependentNameType(Keyword, CanonNNS, Name);
4936   }
4937 
4938   llvm::FoldingSetNodeID ID;
4939   DependentNameType::Profile(ID, Keyword, NNS, Name);
4940 
4941   void *InsertPos = nullptr;
4942   DependentNameType *T
4943     = DependentNameTypes.FindNodeOrInsertPos(ID, InsertPos);
4944   if (T)
4945     return QualType(T, 0);
4946 
4947   T = new (*this, TypeAlignment) DependentNameType(Keyword, NNS, Name, Canon);
4948   Types.push_back(T);
4949   DependentNameTypes.InsertNode(T, InsertPos);
4950   return QualType(T, 0);
4951 }
4952 
4953 QualType
4954 ASTContext::getDependentTemplateSpecializationType(
4955                                  ElaboratedTypeKeyword Keyword,
4956                                  NestedNameSpecifier *NNS,
4957                                  const IdentifierInfo *Name,
4958                                  const TemplateArgumentListInfo &Args) const {
4959   // TODO: avoid this copy
4960   SmallVector<TemplateArgument, 16> ArgCopy;
4961   for (unsigned I = 0, E = Args.size(); I != E; ++I)
4962     ArgCopy.push_back(Args[I].getArgument());
4963   return getDependentTemplateSpecializationType(Keyword, NNS, Name, ArgCopy);
4964 }
4965 
4966 QualType
4967 ASTContext::getDependentTemplateSpecializationType(
4968                                  ElaboratedTypeKeyword Keyword,
4969                                  NestedNameSpecifier *NNS,
4970                                  const IdentifierInfo *Name,
4971                                  ArrayRef<TemplateArgument> Args) const {
4972   assert((!NNS || NNS->isDependent()) &&
4973          "nested-name-specifier must be dependent");
4974 
4975   llvm::FoldingSetNodeID ID;
4976   DependentTemplateSpecializationType::Profile(ID, *this, Keyword, NNS,
4977                                                Name, Args);
4978 
4979   void *InsertPos = nullptr;
4980   DependentTemplateSpecializationType *T
4981     = DependentTemplateSpecializationTypes.FindNodeOrInsertPos(ID, InsertPos);
4982   if (T)
4983     return QualType(T, 0);
4984 
4985   NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
4986 
4987   ElaboratedTypeKeyword CanonKeyword = Keyword;
4988   if (Keyword == ETK_None) CanonKeyword = ETK_Typename;
4989 
4990   bool AnyNonCanonArgs = false;
4991   unsigned NumArgs = Args.size();
4992   SmallVector<TemplateArgument, 16> CanonArgs(NumArgs);
4993   for (unsigned I = 0; I != NumArgs; ++I) {
4994     CanonArgs[I] = getCanonicalTemplateArgument(Args[I]);
4995     if (!CanonArgs[I].structurallyEquals(Args[I]))
4996       AnyNonCanonArgs = true;
4997   }
4998 
4999   QualType Canon;
5000   if (AnyNonCanonArgs || CanonNNS != NNS || CanonKeyword != Keyword) {
5001     Canon = getDependentTemplateSpecializationType(CanonKeyword, CanonNNS,
5002                                                    Name,
5003                                                    CanonArgs);
5004 
5005     // Find the insert position again.
5006     DependentTemplateSpecializationTypes.FindNodeOrInsertPos(ID, InsertPos);
5007   }
5008 
5009   void *Mem = Allocate((sizeof(DependentTemplateSpecializationType) +
5010                         sizeof(TemplateArgument) * NumArgs),
5011                        TypeAlignment);
5012   T = new (Mem) DependentTemplateSpecializationType(Keyword, NNS,
5013                                                     Name, Args, Canon);
5014   Types.push_back(T);
5015   DependentTemplateSpecializationTypes.InsertNode(T, InsertPos);
5016   return QualType(T, 0);
5017 }
5018 
5019 TemplateArgument ASTContext::getInjectedTemplateArg(NamedDecl *Param) {
5020   TemplateArgument Arg;
5021   if (const auto *TTP = dyn_cast<TemplateTypeParmDecl>(Param)) {
5022     QualType ArgType = getTypeDeclType(TTP);
5023     if (TTP->isParameterPack())
5024       ArgType = getPackExpansionType(ArgType, None);
5025 
5026     Arg = TemplateArgument(ArgType);
5027   } else if (auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(Param)) {
5028     QualType T =
5029         NTTP->getType().getNonPackExpansionType().getNonLValueExprType(*this);
5030     // For class NTTPs, ensure we include the 'const' so the type matches that
5031     // of a real template argument.
5032     // FIXME: It would be more faithful to model this as something like an
5033     // lvalue-to-rvalue conversion applied to a const-qualified lvalue.
5034     if (T->isRecordType())
5035       T.addConst();
5036     Expr *E = new (*this) DeclRefExpr(
5037         *this, NTTP, /*enclosing*/ false, T,
5038         Expr::getValueKindForType(NTTP->getType()), NTTP->getLocation());
5039 
5040     if (NTTP->isParameterPack())
5041       E = new (*this) PackExpansionExpr(DependentTy, E, NTTP->getLocation(),
5042                                         None);
5043     Arg = TemplateArgument(E);
5044   } else {
5045     auto *TTP = cast<TemplateTemplateParmDecl>(Param);
5046     if (TTP->isParameterPack())
5047       Arg = TemplateArgument(TemplateName(TTP), Optional<unsigned>());
5048     else
5049       Arg = TemplateArgument(TemplateName(TTP));
5050   }
5051 
5052   if (Param->isTemplateParameterPack())
5053     Arg = TemplateArgument::CreatePackCopy(*this, Arg);
5054 
5055   return Arg;
5056 }
5057 
5058 void
5059 ASTContext::getInjectedTemplateArgs(const TemplateParameterList *Params,
5060                                     SmallVectorImpl<TemplateArgument> &Args) {
5061   Args.reserve(Args.size() + Params->size());
5062 
5063   for (NamedDecl *Param : *Params)
5064     Args.push_back(getInjectedTemplateArg(Param));
5065 }
5066 
5067 QualType ASTContext::getPackExpansionType(QualType Pattern,
5068                                           Optional<unsigned> NumExpansions,
5069                                           bool ExpectPackInType) {
5070   assert((!ExpectPackInType || Pattern->containsUnexpandedParameterPack()) &&
5071          "Pack expansions must expand one or more parameter packs");
5072 
5073   llvm::FoldingSetNodeID ID;
5074   PackExpansionType::Profile(ID, Pattern, NumExpansions);
5075 
5076   void *InsertPos = nullptr;
5077   PackExpansionType *T = PackExpansionTypes.FindNodeOrInsertPos(ID, InsertPos);
5078   if (T)
5079     return QualType(T, 0);
5080 
5081   QualType Canon;
5082   if (!Pattern.isCanonical()) {
5083     Canon = getPackExpansionType(getCanonicalType(Pattern), NumExpansions,
5084                                  /*ExpectPackInType=*/false);
5085 
5086     // Find the insert position again, in case we inserted an element into
5087     // PackExpansionTypes and invalidated our insert position.
5088     PackExpansionTypes.FindNodeOrInsertPos(ID, InsertPos);
5089   }
5090 
5091   T = new (*this, TypeAlignment)
5092       PackExpansionType(Pattern, Canon, NumExpansions);
5093   Types.push_back(T);
5094   PackExpansionTypes.InsertNode(T, InsertPos);
5095   return QualType(T, 0);
5096 }
5097 
5098 /// CmpProtocolNames - Comparison predicate for sorting protocols
5099 /// alphabetically.
5100 static int CmpProtocolNames(ObjCProtocolDecl *const *LHS,
5101                             ObjCProtocolDecl *const *RHS) {
5102   return DeclarationName::compare((*LHS)->getDeclName(), (*RHS)->getDeclName());
5103 }
5104 
5105 static bool areSortedAndUniqued(ArrayRef<ObjCProtocolDecl *> Protocols) {
5106   if (Protocols.empty()) return true;
5107 
5108   if (Protocols[0]->getCanonicalDecl() != Protocols[0])
5109     return false;
5110 
5111   for (unsigned i = 1; i != Protocols.size(); ++i)
5112     if (CmpProtocolNames(&Protocols[i - 1], &Protocols[i]) >= 0 ||
5113         Protocols[i]->getCanonicalDecl() != Protocols[i])
5114       return false;
5115   return true;
5116 }
5117 
5118 static void
5119 SortAndUniqueProtocols(SmallVectorImpl<ObjCProtocolDecl *> &Protocols) {
5120   // Sort protocols, keyed by name.
5121   llvm::array_pod_sort(Protocols.begin(), Protocols.end(), CmpProtocolNames);
5122 
5123   // Canonicalize.
5124   for (ObjCProtocolDecl *&P : Protocols)
5125     P = P->getCanonicalDecl();
5126 
5127   // Remove duplicates.
5128   auto ProtocolsEnd = std::unique(Protocols.begin(), Protocols.end());
5129   Protocols.erase(ProtocolsEnd, Protocols.end());
5130 }
5131 
5132 QualType ASTContext::getObjCObjectType(QualType BaseType,
5133                                        ObjCProtocolDecl * const *Protocols,
5134                                        unsigned NumProtocols) const {
5135   return getObjCObjectType(BaseType, {},
5136                            llvm::makeArrayRef(Protocols, NumProtocols),
5137                            /*isKindOf=*/false);
5138 }
5139 
5140 QualType ASTContext::getObjCObjectType(
5141            QualType baseType,
5142            ArrayRef<QualType> typeArgs,
5143            ArrayRef<ObjCProtocolDecl *> protocols,
5144            bool isKindOf) const {
5145   // If the base type is an interface and there aren't any protocols or
5146   // type arguments to add, then the interface type will do just fine.
5147   if (typeArgs.empty() && protocols.empty() && !isKindOf &&
5148       isa<ObjCInterfaceType>(baseType))
5149     return baseType;
5150 
5151   // Look in the folding set for an existing type.
5152   llvm::FoldingSetNodeID ID;
5153   ObjCObjectTypeImpl::Profile(ID, baseType, typeArgs, protocols, isKindOf);
5154   void *InsertPos = nullptr;
5155   if (ObjCObjectType *QT = ObjCObjectTypes.FindNodeOrInsertPos(ID, InsertPos))
5156     return QualType(QT, 0);
5157 
5158   // Determine the type arguments to be used for canonicalization,
5159   // which may be explicitly specified here or written on the base
5160   // type.
5161   ArrayRef<QualType> effectiveTypeArgs = typeArgs;
5162   if (effectiveTypeArgs.empty()) {
5163     if (const auto *baseObject = baseType->getAs<ObjCObjectType>())
5164       effectiveTypeArgs = baseObject->getTypeArgs();
5165   }
5166 
5167   // Build the canonical type, which has the canonical base type and a
5168   // sorted-and-uniqued list of protocols and the type arguments
5169   // canonicalized.
5170   QualType canonical;
5171   bool typeArgsAreCanonical = std::all_of(effectiveTypeArgs.begin(),
5172                                           effectiveTypeArgs.end(),
5173                                           [&](QualType type) {
5174                                             return type.isCanonical();
5175                                           });
5176   bool protocolsSorted = areSortedAndUniqued(protocols);
5177   if (!typeArgsAreCanonical || !protocolsSorted || !baseType.isCanonical()) {
5178     // Determine the canonical type arguments.
5179     ArrayRef<QualType> canonTypeArgs;
5180     SmallVector<QualType, 4> canonTypeArgsVec;
5181     if (!typeArgsAreCanonical) {
5182       canonTypeArgsVec.reserve(effectiveTypeArgs.size());
5183       for (auto typeArg : effectiveTypeArgs)
5184         canonTypeArgsVec.push_back(getCanonicalType(typeArg));
5185       canonTypeArgs = canonTypeArgsVec;
5186     } else {
5187       canonTypeArgs = effectiveTypeArgs;
5188     }
5189 
5190     ArrayRef<ObjCProtocolDecl *> canonProtocols;
5191     SmallVector<ObjCProtocolDecl*, 8> canonProtocolsVec;
5192     if (!protocolsSorted) {
5193       canonProtocolsVec.append(protocols.begin(), protocols.end());
5194       SortAndUniqueProtocols(canonProtocolsVec);
5195       canonProtocols = canonProtocolsVec;
5196     } else {
5197       canonProtocols = protocols;
5198     }
5199 
5200     canonical = getObjCObjectType(getCanonicalType(baseType), canonTypeArgs,
5201                                   canonProtocols, isKindOf);
5202 
5203     // Regenerate InsertPos.
5204     ObjCObjectTypes.FindNodeOrInsertPos(ID, InsertPos);
5205   }
5206 
5207   unsigned size = sizeof(ObjCObjectTypeImpl);
5208   size += typeArgs.size() * sizeof(QualType);
5209   size += protocols.size() * sizeof(ObjCProtocolDecl *);
5210   void *mem = Allocate(size, TypeAlignment);
5211   auto *T =
5212     new (mem) ObjCObjectTypeImpl(canonical, baseType, typeArgs, protocols,
5213                                  isKindOf);
5214 
5215   Types.push_back(T);
5216   ObjCObjectTypes.InsertNode(T, InsertPos);
5217   return QualType(T, 0);
5218 }
5219 
5220 /// Apply Objective-C protocol qualifiers to the given type.
5221 /// If this is for the canonical type of a type parameter, we can apply
5222 /// protocol qualifiers on the ObjCObjectPointerType.
5223 QualType
5224 ASTContext::applyObjCProtocolQualifiers(QualType type,
5225                   ArrayRef<ObjCProtocolDecl *> protocols, bool &hasError,
5226                   bool allowOnPointerType) const {
5227   hasError = false;
5228 
5229   if (const auto *objT = dyn_cast<ObjCTypeParamType>(type.getTypePtr())) {
5230     return getObjCTypeParamType(objT->getDecl(), protocols);
5231   }
5232 
5233   // Apply protocol qualifiers to ObjCObjectPointerType.
5234   if (allowOnPointerType) {
5235     if (const auto *objPtr =
5236             dyn_cast<ObjCObjectPointerType>(type.getTypePtr())) {
5237       const ObjCObjectType *objT = objPtr->getObjectType();
5238       // Merge protocol lists and construct ObjCObjectType.
5239       SmallVector<ObjCProtocolDecl*, 8> protocolsVec;
5240       protocolsVec.append(objT->qual_begin(),
5241                           objT->qual_end());
5242       protocolsVec.append(protocols.begin(), protocols.end());
5243       ArrayRef<ObjCProtocolDecl *> protocols = protocolsVec;
5244       type = getObjCObjectType(
5245              objT->getBaseType(),
5246              objT->getTypeArgsAsWritten(),
5247              protocols,
5248              objT->isKindOfTypeAsWritten());
5249       return getObjCObjectPointerType(type);
5250     }
5251   }
5252 
5253   // Apply protocol qualifiers to ObjCObjectType.
5254   if (const auto *objT = dyn_cast<ObjCObjectType>(type.getTypePtr())){
5255     // FIXME: Check for protocols to which the class type is already
5256     // known to conform.
5257 
5258     return getObjCObjectType(objT->getBaseType(),
5259                              objT->getTypeArgsAsWritten(),
5260                              protocols,
5261                              objT->isKindOfTypeAsWritten());
5262   }
5263 
5264   // If the canonical type is ObjCObjectType, ...
5265   if (type->isObjCObjectType()) {
5266     // Silently overwrite any existing protocol qualifiers.
5267     // TODO: determine whether that's the right thing to do.
5268 
5269     // FIXME: Check for protocols to which the class type is already
5270     // known to conform.
5271     return getObjCObjectType(type, {}, protocols, false);
5272   }
5273 
5274   // id<protocol-list>
5275   if (type->isObjCIdType()) {
5276     const auto *objPtr = type->castAs<ObjCObjectPointerType>();
5277     type = getObjCObjectType(ObjCBuiltinIdTy, {}, protocols,
5278                                  objPtr->isKindOfType());
5279     return getObjCObjectPointerType(type);
5280   }
5281 
5282   // Class<protocol-list>
5283   if (type->isObjCClassType()) {
5284     const auto *objPtr = type->castAs<ObjCObjectPointerType>();
5285     type = getObjCObjectType(ObjCBuiltinClassTy, {}, protocols,
5286                                  objPtr->isKindOfType());
5287     return getObjCObjectPointerType(type);
5288   }
5289 
5290   hasError = true;
5291   return type;
5292 }
5293 
5294 QualType
5295 ASTContext::getObjCTypeParamType(const ObjCTypeParamDecl *Decl,
5296                                  ArrayRef<ObjCProtocolDecl *> protocols) const {
5297   // Look in the folding set for an existing type.
5298   llvm::FoldingSetNodeID ID;
5299   ObjCTypeParamType::Profile(ID, Decl, Decl->getUnderlyingType(), protocols);
5300   void *InsertPos = nullptr;
5301   if (ObjCTypeParamType *TypeParam =
5302       ObjCTypeParamTypes.FindNodeOrInsertPos(ID, InsertPos))
5303     return QualType(TypeParam, 0);
5304 
5305   // We canonicalize to the underlying type.
5306   QualType Canonical = getCanonicalType(Decl->getUnderlyingType());
5307   if (!protocols.empty()) {
5308     // Apply the protocol qualifers.
5309     bool hasError;
5310     Canonical = getCanonicalType(applyObjCProtocolQualifiers(
5311         Canonical, protocols, hasError, true /*allowOnPointerType*/));
5312     assert(!hasError && "Error when apply protocol qualifier to bound type");
5313   }
5314 
5315   unsigned size = sizeof(ObjCTypeParamType);
5316   size += protocols.size() * sizeof(ObjCProtocolDecl *);
5317   void *mem = Allocate(size, TypeAlignment);
5318   auto *newType = new (mem) ObjCTypeParamType(Decl, Canonical, protocols);
5319 
5320   Types.push_back(newType);
5321   ObjCTypeParamTypes.InsertNode(newType, InsertPos);
5322   return QualType(newType, 0);
5323 }
5324 
5325 void ASTContext::adjustObjCTypeParamBoundType(const ObjCTypeParamDecl *Orig,
5326                                               ObjCTypeParamDecl *New) const {
5327   New->setTypeSourceInfo(getTrivialTypeSourceInfo(Orig->getUnderlyingType()));
5328   // Update TypeForDecl after updating TypeSourceInfo.
5329   auto NewTypeParamTy = cast<ObjCTypeParamType>(New->getTypeForDecl());
5330   SmallVector<ObjCProtocolDecl *, 8> protocols;
5331   protocols.append(NewTypeParamTy->qual_begin(), NewTypeParamTy->qual_end());
5332   QualType UpdatedTy = getObjCTypeParamType(New, protocols);
5333   New->setTypeForDecl(UpdatedTy.getTypePtr());
5334 }
5335 
5336 /// ObjCObjectAdoptsQTypeProtocols - Checks that protocols in IC's
5337 /// protocol list adopt all protocols in QT's qualified-id protocol
5338 /// list.
5339 bool ASTContext::ObjCObjectAdoptsQTypeProtocols(QualType QT,
5340                                                 ObjCInterfaceDecl *IC) {
5341   if (!QT->isObjCQualifiedIdType())
5342     return false;
5343 
5344   if (const auto *OPT = QT->getAs<ObjCObjectPointerType>()) {
5345     // If both the right and left sides have qualifiers.
5346     for (auto *Proto : OPT->quals()) {
5347       if (!IC->ClassImplementsProtocol(Proto, false))
5348         return false;
5349     }
5350     return true;
5351   }
5352   return false;
5353 }
5354 
5355 /// QIdProtocolsAdoptObjCObjectProtocols - Checks that protocols in
5356 /// QT's qualified-id protocol list adopt all protocols in IDecl's list
5357 /// of protocols.
5358 bool ASTContext::QIdProtocolsAdoptObjCObjectProtocols(QualType QT,
5359                                                 ObjCInterfaceDecl *IDecl) {
5360   if (!QT->isObjCQualifiedIdType())
5361     return false;
5362   const auto *OPT = QT->getAs<ObjCObjectPointerType>();
5363   if (!OPT)
5364     return false;
5365   if (!IDecl->hasDefinition())
5366     return false;
5367   llvm::SmallPtrSet<ObjCProtocolDecl *, 8> InheritedProtocols;
5368   CollectInheritedProtocols(IDecl, InheritedProtocols);
5369   if (InheritedProtocols.empty())
5370     return false;
5371   // Check that if every protocol in list of id<plist> conforms to a protocol
5372   // of IDecl's, then bridge casting is ok.
5373   bool Conforms = false;
5374   for (auto *Proto : OPT->quals()) {
5375     Conforms = false;
5376     for (auto *PI : InheritedProtocols) {
5377       if (ProtocolCompatibleWithProtocol(Proto, PI)) {
5378         Conforms = true;
5379         break;
5380       }
5381     }
5382     if (!Conforms)
5383       break;
5384   }
5385   if (Conforms)
5386     return true;
5387 
5388   for (auto *PI : InheritedProtocols) {
5389     // If both the right and left sides have qualifiers.
5390     bool Adopts = false;
5391     for (auto *Proto : OPT->quals()) {
5392       // return 'true' if 'PI' is in the inheritance hierarchy of Proto
5393       if ((Adopts = ProtocolCompatibleWithProtocol(PI, Proto)))
5394         break;
5395     }
5396     if (!Adopts)
5397       return false;
5398   }
5399   return true;
5400 }
5401 
5402 /// getObjCObjectPointerType - Return a ObjCObjectPointerType type for
5403 /// the given object type.
5404 QualType ASTContext::getObjCObjectPointerType(QualType ObjectT) const {
5405   llvm::FoldingSetNodeID ID;
5406   ObjCObjectPointerType::Profile(ID, ObjectT);
5407 
5408   void *InsertPos = nullptr;
5409   if (ObjCObjectPointerType *QT =
5410               ObjCObjectPointerTypes.FindNodeOrInsertPos(ID, InsertPos))
5411     return QualType(QT, 0);
5412 
5413   // Find the canonical object type.
5414   QualType Canonical;
5415   if (!ObjectT.isCanonical()) {
5416     Canonical = getObjCObjectPointerType(getCanonicalType(ObjectT));
5417 
5418     // Regenerate InsertPos.
5419     ObjCObjectPointerTypes.FindNodeOrInsertPos(ID, InsertPos);
5420   }
5421 
5422   // No match.
5423   void *Mem = Allocate(sizeof(ObjCObjectPointerType), TypeAlignment);
5424   auto *QType =
5425     new (Mem) ObjCObjectPointerType(Canonical, ObjectT);
5426 
5427   Types.push_back(QType);
5428   ObjCObjectPointerTypes.InsertNode(QType, InsertPos);
5429   return QualType(QType, 0);
5430 }
5431 
5432 /// getObjCInterfaceType - Return the unique reference to the type for the
5433 /// specified ObjC interface decl. The list of protocols is optional.
5434 QualType ASTContext::getObjCInterfaceType(const ObjCInterfaceDecl *Decl,
5435                                           ObjCInterfaceDecl *PrevDecl) const {
5436   if (Decl->TypeForDecl)
5437     return QualType(Decl->TypeForDecl, 0);
5438 
5439   if (PrevDecl) {
5440     assert(PrevDecl->TypeForDecl && "previous decl has no TypeForDecl");
5441     Decl->TypeForDecl = PrevDecl->TypeForDecl;
5442     return QualType(PrevDecl->TypeForDecl, 0);
5443   }
5444 
5445   // Prefer the definition, if there is one.
5446   if (const ObjCInterfaceDecl *Def = Decl->getDefinition())
5447     Decl = Def;
5448 
5449   void *Mem = Allocate(sizeof(ObjCInterfaceType), TypeAlignment);
5450   auto *T = new (Mem) ObjCInterfaceType(Decl);
5451   Decl->TypeForDecl = T;
5452   Types.push_back(T);
5453   return QualType(T, 0);
5454 }
5455 
5456 /// getTypeOfExprType - Unlike many "get<Type>" functions, we can't unique
5457 /// TypeOfExprType AST's (since expression's are never shared). For example,
5458 /// multiple declarations that refer to "typeof(x)" all contain different
5459 /// DeclRefExpr's. This doesn't effect the type checker, since it operates
5460 /// on canonical type's (which are always unique).
5461 QualType ASTContext::getTypeOfExprType(Expr *tofExpr) const {
5462   TypeOfExprType *toe;
5463   if (tofExpr->isTypeDependent()) {
5464     llvm::FoldingSetNodeID ID;
5465     DependentTypeOfExprType::Profile(ID, *this, tofExpr);
5466 
5467     void *InsertPos = nullptr;
5468     DependentTypeOfExprType *Canon
5469       = DependentTypeOfExprTypes.FindNodeOrInsertPos(ID, InsertPos);
5470     if (Canon) {
5471       // We already have a "canonical" version of an identical, dependent
5472       // typeof(expr) type. Use that as our canonical type.
5473       toe = new (*this, TypeAlignment) TypeOfExprType(tofExpr,
5474                                           QualType((TypeOfExprType*)Canon, 0));
5475     } else {
5476       // Build a new, canonical typeof(expr) type.
5477       Canon
5478         = new (*this, TypeAlignment) DependentTypeOfExprType(*this, tofExpr);
5479       DependentTypeOfExprTypes.InsertNode(Canon, InsertPos);
5480       toe = Canon;
5481     }
5482   } else {
5483     QualType Canonical = getCanonicalType(tofExpr->getType());
5484     toe = new (*this, TypeAlignment) TypeOfExprType(tofExpr, Canonical);
5485   }
5486   Types.push_back(toe);
5487   return QualType(toe, 0);
5488 }
5489 
5490 /// getTypeOfType -  Unlike many "get<Type>" functions, we don't unique
5491 /// TypeOfType nodes. The only motivation to unique these nodes would be
5492 /// memory savings. Since typeof(t) is fairly uncommon, space shouldn't be
5493 /// an issue. This doesn't affect the type checker, since it operates
5494 /// on canonical types (which are always unique).
5495 QualType ASTContext::getTypeOfType(QualType tofType) const {
5496   QualType Canonical = getCanonicalType(tofType);
5497   auto *tot = new (*this, TypeAlignment) TypeOfType(tofType, Canonical);
5498   Types.push_back(tot);
5499   return QualType(tot, 0);
5500 }
5501 
5502 /// getReferenceQualifiedType - Given an expr, will return the type for
5503 /// that expression, as in [dcl.type.simple]p4 but without taking id-expressions
5504 /// and class member access into account.
5505 QualType ASTContext::getReferenceQualifiedType(const Expr *E) const {
5506   // C++11 [dcl.type.simple]p4:
5507   //   [...]
5508   QualType T = E->getType();
5509   switch (E->getValueKind()) {
5510   //     - otherwise, if e is an xvalue, decltype(e) is T&&, where T is the
5511   //       type of e;
5512   case VK_XValue:
5513     return getRValueReferenceType(T);
5514   //     - otherwise, if e is an lvalue, decltype(e) is T&, where T is the
5515   //       type of e;
5516   case VK_LValue:
5517     return getLValueReferenceType(T);
5518   //  - otherwise, decltype(e) is the type of e.
5519   case VK_PRValue:
5520     return T;
5521   }
5522   llvm_unreachable("Unknown value kind");
5523 }
5524 
5525 /// Unlike many "get<Type>" functions, we don't unique DecltypeType
5526 /// nodes. This would never be helpful, since each such type has its own
5527 /// expression, and would not give a significant memory saving, since there
5528 /// is an Expr tree under each such type.
5529 QualType ASTContext::getDecltypeType(Expr *e, QualType UnderlyingType) const {
5530   DecltypeType *dt;
5531 
5532   // C++11 [temp.type]p2:
5533   //   If an expression e involves a template parameter, decltype(e) denotes a
5534   //   unique dependent type. Two such decltype-specifiers refer to the same
5535   //   type only if their expressions are equivalent (14.5.6.1).
5536   if (e->isInstantiationDependent()) {
5537     llvm::FoldingSetNodeID ID;
5538     DependentDecltypeType::Profile(ID, *this, e);
5539 
5540     void *InsertPos = nullptr;
5541     DependentDecltypeType *Canon
5542       = DependentDecltypeTypes.FindNodeOrInsertPos(ID, InsertPos);
5543     if (!Canon) {
5544       // Build a new, canonical decltype(expr) type.
5545       Canon = new (*this, TypeAlignment) DependentDecltypeType(*this, e);
5546       DependentDecltypeTypes.InsertNode(Canon, InsertPos);
5547     }
5548     dt = new (*this, TypeAlignment)
5549         DecltypeType(e, UnderlyingType, QualType((DecltypeType *)Canon, 0));
5550   } else {
5551     dt = new (*this, TypeAlignment)
5552         DecltypeType(e, UnderlyingType, getCanonicalType(UnderlyingType));
5553   }
5554   Types.push_back(dt);
5555   return QualType(dt, 0);
5556 }
5557 
5558 /// getUnaryTransformationType - We don't unique these, since the memory
5559 /// savings are minimal and these are rare.
5560 QualType ASTContext::getUnaryTransformType(QualType BaseType,
5561                                            QualType UnderlyingType,
5562                                            UnaryTransformType::UTTKind Kind)
5563     const {
5564   UnaryTransformType *ut = nullptr;
5565 
5566   if (BaseType->isDependentType()) {
5567     // Look in the folding set for an existing type.
5568     llvm::FoldingSetNodeID ID;
5569     DependentUnaryTransformType::Profile(ID, getCanonicalType(BaseType), Kind);
5570 
5571     void *InsertPos = nullptr;
5572     DependentUnaryTransformType *Canon
5573       = DependentUnaryTransformTypes.FindNodeOrInsertPos(ID, InsertPos);
5574 
5575     if (!Canon) {
5576       // Build a new, canonical __underlying_type(type) type.
5577       Canon = new (*this, TypeAlignment)
5578              DependentUnaryTransformType(*this, getCanonicalType(BaseType),
5579                                          Kind);
5580       DependentUnaryTransformTypes.InsertNode(Canon, InsertPos);
5581     }
5582     ut = new (*this, TypeAlignment) UnaryTransformType (BaseType,
5583                                                         QualType(), Kind,
5584                                                         QualType(Canon, 0));
5585   } else {
5586     QualType CanonType = getCanonicalType(UnderlyingType);
5587     ut = new (*this, TypeAlignment) UnaryTransformType (BaseType,
5588                                                         UnderlyingType, Kind,
5589                                                         CanonType);
5590   }
5591   Types.push_back(ut);
5592   return QualType(ut, 0);
5593 }
5594 
5595 /// getAutoType - Return the uniqued reference to the 'auto' type which has been
5596 /// deduced to the given type, or to the canonical undeduced 'auto' type, or the
5597 /// canonical deduced-but-dependent 'auto' type.
5598 QualType
5599 ASTContext::getAutoType(QualType DeducedType, AutoTypeKeyword Keyword,
5600                         bool IsDependent, bool IsPack,
5601                         ConceptDecl *TypeConstraintConcept,
5602                         ArrayRef<TemplateArgument> TypeConstraintArgs) const {
5603   assert((!IsPack || IsDependent) && "only use IsPack for a dependent pack");
5604   if (DeducedType.isNull() && Keyword == AutoTypeKeyword::Auto &&
5605       !TypeConstraintConcept && !IsDependent)
5606     return getAutoDeductType();
5607 
5608   // Look in the folding set for an existing type.
5609   void *InsertPos = nullptr;
5610   llvm::FoldingSetNodeID ID;
5611   AutoType::Profile(ID, *this, DeducedType, Keyword, IsDependent,
5612                     TypeConstraintConcept, TypeConstraintArgs);
5613   if (AutoType *AT = AutoTypes.FindNodeOrInsertPos(ID, InsertPos))
5614     return QualType(AT, 0);
5615 
5616   void *Mem = Allocate(sizeof(AutoType) +
5617                        sizeof(TemplateArgument) * TypeConstraintArgs.size(),
5618                        TypeAlignment);
5619   auto *AT = new (Mem) AutoType(
5620       DeducedType, Keyword,
5621       (IsDependent ? TypeDependence::DependentInstantiation
5622                    : TypeDependence::None) |
5623           (IsPack ? TypeDependence::UnexpandedPack : TypeDependence::None),
5624       TypeConstraintConcept, TypeConstraintArgs);
5625   Types.push_back(AT);
5626   if (InsertPos)
5627     AutoTypes.InsertNode(AT, InsertPos);
5628   return QualType(AT, 0);
5629 }
5630 
5631 /// Return the uniqued reference to the deduced template specialization type
5632 /// which has been deduced to the given type, or to the canonical undeduced
5633 /// such type, or the canonical deduced-but-dependent such type.
5634 QualType ASTContext::getDeducedTemplateSpecializationType(
5635     TemplateName Template, QualType DeducedType, bool IsDependent) const {
5636   // Look in the folding set for an existing type.
5637   void *InsertPos = nullptr;
5638   llvm::FoldingSetNodeID ID;
5639   DeducedTemplateSpecializationType::Profile(ID, Template, DeducedType,
5640                                              IsDependent);
5641   if (DeducedTemplateSpecializationType *DTST =
5642           DeducedTemplateSpecializationTypes.FindNodeOrInsertPos(ID, InsertPos))
5643     return QualType(DTST, 0);
5644 
5645   auto *DTST = new (*this, TypeAlignment)
5646       DeducedTemplateSpecializationType(Template, DeducedType, IsDependent);
5647   Types.push_back(DTST);
5648   if (InsertPos)
5649     DeducedTemplateSpecializationTypes.InsertNode(DTST, InsertPos);
5650   return QualType(DTST, 0);
5651 }
5652 
5653 /// getAtomicType - Return the uniqued reference to the atomic type for
5654 /// the given value type.
5655 QualType ASTContext::getAtomicType(QualType T) const {
5656   // Unique pointers, to guarantee there is only one pointer of a particular
5657   // structure.
5658   llvm::FoldingSetNodeID ID;
5659   AtomicType::Profile(ID, T);
5660 
5661   void *InsertPos = nullptr;
5662   if (AtomicType *AT = AtomicTypes.FindNodeOrInsertPos(ID, InsertPos))
5663     return QualType(AT, 0);
5664 
5665   // If the atomic value type isn't canonical, this won't be a canonical type
5666   // either, so fill in the canonical type field.
5667   QualType Canonical;
5668   if (!T.isCanonical()) {
5669     Canonical = getAtomicType(getCanonicalType(T));
5670 
5671     // Get the new insert position for the node we care about.
5672     AtomicType *NewIP = AtomicTypes.FindNodeOrInsertPos(ID, InsertPos);
5673     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
5674   }
5675   auto *New = new (*this, TypeAlignment) AtomicType(T, Canonical);
5676   Types.push_back(New);
5677   AtomicTypes.InsertNode(New, InsertPos);
5678   return QualType(New, 0);
5679 }
5680 
5681 /// getAutoDeductType - Get type pattern for deducing against 'auto'.
5682 QualType ASTContext::getAutoDeductType() const {
5683   if (AutoDeductTy.isNull())
5684     AutoDeductTy = QualType(new (*this, TypeAlignment)
5685                                 AutoType(QualType(), AutoTypeKeyword::Auto,
5686                                          TypeDependence::None,
5687                                          /*concept*/ nullptr, /*args*/ {}),
5688                             0);
5689   return AutoDeductTy;
5690 }
5691 
5692 /// getAutoRRefDeductType - Get type pattern for deducing against 'auto &&'.
5693 QualType ASTContext::getAutoRRefDeductType() const {
5694   if (AutoRRefDeductTy.isNull())
5695     AutoRRefDeductTy = getRValueReferenceType(getAutoDeductType());
5696   assert(!AutoRRefDeductTy.isNull() && "can't build 'auto &&' pattern");
5697   return AutoRRefDeductTy;
5698 }
5699 
5700 /// getTagDeclType - Return the unique reference to the type for the
5701 /// specified TagDecl (struct/union/class/enum) decl.
5702 QualType ASTContext::getTagDeclType(const TagDecl *Decl) const {
5703   assert(Decl);
5704   // FIXME: What is the design on getTagDeclType when it requires casting
5705   // away const?  mutable?
5706   return getTypeDeclType(const_cast<TagDecl*>(Decl));
5707 }
5708 
5709 /// getSizeType - Return the unique type for "size_t" (C99 7.17), the result
5710 /// of the sizeof operator (C99 6.5.3.4p4). The value is target dependent and
5711 /// needs to agree with the definition in <stddef.h>.
5712 CanQualType ASTContext::getSizeType() const {
5713   return getFromTargetType(Target->getSizeType());
5714 }
5715 
5716 /// Return the unique signed counterpart of the integer type
5717 /// corresponding to size_t.
5718 CanQualType ASTContext::getSignedSizeType() const {
5719   return getFromTargetType(Target->getSignedSizeType());
5720 }
5721 
5722 /// getIntMaxType - Return the unique type for "intmax_t" (C99 7.18.1.5).
5723 CanQualType ASTContext::getIntMaxType() const {
5724   return getFromTargetType(Target->getIntMaxType());
5725 }
5726 
5727 /// getUIntMaxType - Return the unique type for "uintmax_t" (C99 7.18.1.5).
5728 CanQualType ASTContext::getUIntMaxType() const {
5729   return getFromTargetType(Target->getUIntMaxType());
5730 }
5731 
5732 /// getSignedWCharType - Return the type of "signed wchar_t".
5733 /// Used when in C++, as a GCC extension.
5734 QualType ASTContext::getSignedWCharType() const {
5735   // FIXME: derive from "Target" ?
5736   return WCharTy;
5737 }
5738 
5739 /// getUnsignedWCharType - Return the type of "unsigned wchar_t".
5740 /// Used when in C++, as a GCC extension.
5741 QualType ASTContext::getUnsignedWCharType() const {
5742   // FIXME: derive from "Target" ?
5743   return UnsignedIntTy;
5744 }
5745 
5746 QualType ASTContext::getIntPtrType() const {
5747   return getFromTargetType(Target->getIntPtrType());
5748 }
5749 
5750 QualType ASTContext::getUIntPtrType() const {
5751   return getCorrespondingUnsignedType(getIntPtrType());
5752 }
5753 
5754 /// getPointerDiffType - Return the unique type for "ptrdiff_t" (C99 7.17)
5755 /// defined in <stddef.h>. Pointer - pointer requires this (C99 6.5.6p9).
5756 QualType ASTContext::getPointerDiffType() const {
5757   return getFromTargetType(Target->getPtrDiffType(0));
5758 }
5759 
5760 /// Return the unique unsigned counterpart of "ptrdiff_t"
5761 /// integer type. The standard (C11 7.21.6.1p7) refers to this type
5762 /// in the definition of %tu format specifier.
5763 QualType ASTContext::getUnsignedPointerDiffType() const {
5764   return getFromTargetType(Target->getUnsignedPtrDiffType(0));
5765 }
5766 
5767 /// Return the unique type for "pid_t" defined in
5768 /// <sys/types.h>. We need this to compute the correct type for vfork().
5769 QualType ASTContext::getProcessIDType() const {
5770   return getFromTargetType(Target->getProcessIDType());
5771 }
5772 
5773 //===----------------------------------------------------------------------===//
5774 //                              Type Operators
5775 //===----------------------------------------------------------------------===//
5776 
5777 CanQualType ASTContext::getCanonicalParamType(QualType T) const {
5778   // Push qualifiers into arrays, and then discard any remaining
5779   // qualifiers.
5780   T = getCanonicalType(T);
5781   T = getVariableArrayDecayedType(T);
5782   const Type *Ty = T.getTypePtr();
5783   QualType Result;
5784   if (isa<ArrayType>(Ty)) {
5785     Result = getArrayDecayedType(QualType(Ty,0));
5786   } else if (isa<FunctionType>(Ty)) {
5787     Result = getPointerType(QualType(Ty, 0));
5788   } else {
5789     Result = QualType(Ty, 0);
5790   }
5791 
5792   return CanQualType::CreateUnsafe(Result);
5793 }
5794 
5795 QualType ASTContext::getUnqualifiedArrayType(QualType type,
5796                                              Qualifiers &quals) {
5797   SplitQualType splitType = type.getSplitUnqualifiedType();
5798 
5799   // FIXME: getSplitUnqualifiedType() actually walks all the way to
5800   // the unqualified desugared type and then drops it on the floor.
5801   // We then have to strip that sugar back off with
5802   // getUnqualifiedDesugaredType(), which is silly.
5803   const auto *AT =
5804       dyn_cast<ArrayType>(splitType.Ty->getUnqualifiedDesugaredType());
5805 
5806   // If we don't have an array, just use the results in splitType.
5807   if (!AT) {
5808     quals = splitType.Quals;
5809     return QualType(splitType.Ty, 0);
5810   }
5811 
5812   // Otherwise, recurse on the array's element type.
5813   QualType elementType = AT->getElementType();
5814   QualType unqualElementType = getUnqualifiedArrayType(elementType, quals);
5815 
5816   // If that didn't change the element type, AT has no qualifiers, so we
5817   // can just use the results in splitType.
5818   if (elementType == unqualElementType) {
5819     assert(quals.empty()); // from the recursive call
5820     quals = splitType.Quals;
5821     return QualType(splitType.Ty, 0);
5822   }
5823 
5824   // Otherwise, add in the qualifiers from the outermost type, then
5825   // build the type back up.
5826   quals.addConsistentQualifiers(splitType.Quals);
5827 
5828   if (const auto *CAT = dyn_cast<ConstantArrayType>(AT)) {
5829     return getConstantArrayType(unqualElementType, CAT->getSize(),
5830                                 CAT->getSizeExpr(), CAT->getSizeModifier(), 0);
5831   }
5832 
5833   if (const auto *IAT = dyn_cast<IncompleteArrayType>(AT)) {
5834     return getIncompleteArrayType(unqualElementType, IAT->getSizeModifier(), 0);
5835   }
5836 
5837   if (const auto *VAT = dyn_cast<VariableArrayType>(AT)) {
5838     return getVariableArrayType(unqualElementType,
5839                                 VAT->getSizeExpr(),
5840                                 VAT->getSizeModifier(),
5841                                 VAT->getIndexTypeCVRQualifiers(),
5842                                 VAT->getBracketsRange());
5843   }
5844 
5845   const auto *DSAT = cast<DependentSizedArrayType>(AT);
5846   return getDependentSizedArrayType(unqualElementType, DSAT->getSizeExpr(),
5847                                     DSAT->getSizeModifier(), 0,
5848                                     SourceRange());
5849 }
5850 
5851 /// Attempt to unwrap two types that may both be array types with the same bound
5852 /// (or both be array types of unknown bound) for the purpose of comparing the
5853 /// cv-decomposition of two types per C++ [conv.qual].
5854 ///
5855 /// \param AllowPiMismatch Allow the Pi1 and Pi2 to differ as described in
5856 ///        C++20 [conv.qual], if permitted by the current language mode.
5857 void ASTContext::UnwrapSimilarArrayTypes(QualType &T1, QualType &T2,
5858                                          bool AllowPiMismatch) {
5859   while (true) {
5860     auto *AT1 = getAsArrayType(T1);
5861     if (!AT1)
5862       return;
5863 
5864     auto *AT2 = getAsArrayType(T2);
5865     if (!AT2)
5866       return;
5867 
5868     // If we don't have two array types with the same constant bound nor two
5869     // incomplete array types, we've unwrapped everything we can.
5870     // C++20 also permits one type to be a constant array type and the other
5871     // to be an incomplete array type.
5872     // FIXME: Consider also unwrapping array of unknown bound and VLA.
5873     if (auto *CAT1 = dyn_cast<ConstantArrayType>(AT1)) {
5874       auto *CAT2 = dyn_cast<ConstantArrayType>(AT2);
5875       if (!((CAT2 && CAT1->getSize() == CAT2->getSize()) ||
5876             (AllowPiMismatch && getLangOpts().CPlusPlus20 &&
5877              isa<IncompleteArrayType>(AT2))))
5878         return;
5879     } else if (isa<IncompleteArrayType>(AT1)) {
5880       if (!(isa<IncompleteArrayType>(AT2) ||
5881             (AllowPiMismatch && getLangOpts().CPlusPlus20 &&
5882              isa<ConstantArrayType>(AT2))))
5883         return;
5884     } else {
5885       return;
5886     }
5887 
5888     T1 = AT1->getElementType();
5889     T2 = AT2->getElementType();
5890   }
5891 }
5892 
5893 /// Attempt to unwrap two types that may be similar (C++ [conv.qual]).
5894 ///
5895 /// If T1 and T2 are both pointer types of the same kind, or both array types
5896 /// with the same bound, unwraps layers from T1 and T2 until a pointer type is
5897 /// unwrapped. Top-level qualifiers on T1 and T2 are ignored.
5898 ///
5899 /// This function will typically be called in a loop that successively
5900 /// "unwraps" pointer and pointer-to-member types to compare them at each
5901 /// level.
5902 ///
5903 /// \param AllowPiMismatch Allow the Pi1 and Pi2 to differ as described in
5904 ///        C++20 [conv.qual], if permitted by the current language mode.
5905 ///
5906 /// \return \c true if a pointer type was unwrapped, \c false if we reached a
5907 /// pair of types that can't be unwrapped further.
5908 bool ASTContext::UnwrapSimilarTypes(QualType &T1, QualType &T2,
5909                                     bool AllowPiMismatch) {
5910   UnwrapSimilarArrayTypes(T1, T2, AllowPiMismatch);
5911 
5912   const auto *T1PtrType = T1->getAs<PointerType>();
5913   const auto *T2PtrType = T2->getAs<PointerType>();
5914   if (T1PtrType && T2PtrType) {
5915     T1 = T1PtrType->getPointeeType();
5916     T2 = T2PtrType->getPointeeType();
5917     return true;
5918   }
5919 
5920   const auto *T1MPType = T1->getAs<MemberPointerType>();
5921   const auto *T2MPType = T2->getAs<MemberPointerType>();
5922   if (T1MPType && T2MPType &&
5923       hasSameUnqualifiedType(QualType(T1MPType->getClass(), 0),
5924                              QualType(T2MPType->getClass(), 0))) {
5925     T1 = T1MPType->getPointeeType();
5926     T2 = T2MPType->getPointeeType();
5927     return true;
5928   }
5929 
5930   if (getLangOpts().ObjC) {
5931     const auto *T1OPType = T1->getAs<ObjCObjectPointerType>();
5932     const auto *T2OPType = T2->getAs<ObjCObjectPointerType>();
5933     if (T1OPType && T2OPType) {
5934       T1 = T1OPType->getPointeeType();
5935       T2 = T2OPType->getPointeeType();
5936       return true;
5937     }
5938   }
5939 
5940   // FIXME: Block pointers, too?
5941 
5942   return false;
5943 }
5944 
5945 bool ASTContext::hasSimilarType(QualType T1, QualType T2) {
5946   while (true) {
5947     Qualifiers Quals;
5948     T1 = getUnqualifiedArrayType(T1, Quals);
5949     T2 = getUnqualifiedArrayType(T2, Quals);
5950     if (hasSameType(T1, T2))
5951       return true;
5952     if (!UnwrapSimilarTypes(T1, T2))
5953       return false;
5954   }
5955 }
5956 
5957 bool ASTContext::hasCvrSimilarType(QualType T1, QualType T2) {
5958   while (true) {
5959     Qualifiers Quals1, Quals2;
5960     T1 = getUnqualifiedArrayType(T1, Quals1);
5961     T2 = getUnqualifiedArrayType(T2, Quals2);
5962 
5963     Quals1.removeCVRQualifiers();
5964     Quals2.removeCVRQualifiers();
5965     if (Quals1 != Quals2)
5966       return false;
5967 
5968     if (hasSameType(T1, T2))
5969       return true;
5970 
5971     if (!UnwrapSimilarTypes(T1, T2, /*AllowPiMismatch*/ false))
5972       return false;
5973   }
5974 }
5975 
5976 DeclarationNameInfo
5977 ASTContext::getNameForTemplate(TemplateName Name,
5978                                SourceLocation NameLoc) const {
5979   switch (Name.getKind()) {
5980   case TemplateName::QualifiedTemplate:
5981   case TemplateName::Template:
5982     // DNInfo work in progress: CHECKME: what about DNLoc?
5983     return DeclarationNameInfo(Name.getAsTemplateDecl()->getDeclName(),
5984                                NameLoc);
5985 
5986   case TemplateName::OverloadedTemplate: {
5987     OverloadedTemplateStorage *Storage = Name.getAsOverloadedTemplate();
5988     // DNInfo work in progress: CHECKME: what about DNLoc?
5989     return DeclarationNameInfo((*Storage->begin())->getDeclName(), NameLoc);
5990   }
5991 
5992   case TemplateName::AssumedTemplate: {
5993     AssumedTemplateStorage *Storage = Name.getAsAssumedTemplateName();
5994     return DeclarationNameInfo(Storage->getDeclName(), NameLoc);
5995   }
5996 
5997   case TemplateName::DependentTemplate: {
5998     DependentTemplateName *DTN = Name.getAsDependentTemplateName();
5999     DeclarationName DName;
6000     if (DTN->isIdentifier()) {
6001       DName = DeclarationNames.getIdentifier(DTN->getIdentifier());
6002       return DeclarationNameInfo(DName, NameLoc);
6003     } else {
6004       DName = DeclarationNames.getCXXOperatorName(DTN->getOperator());
6005       // DNInfo work in progress: FIXME: source locations?
6006       DeclarationNameLoc DNLoc =
6007           DeclarationNameLoc::makeCXXOperatorNameLoc(SourceRange());
6008       return DeclarationNameInfo(DName, NameLoc, DNLoc);
6009     }
6010   }
6011 
6012   case TemplateName::SubstTemplateTemplateParm: {
6013     SubstTemplateTemplateParmStorage *subst
6014       = Name.getAsSubstTemplateTemplateParm();
6015     return DeclarationNameInfo(subst->getParameter()->getDeclName(),
6016                                NameLoc);
6017   }
6018 
6019   case TemplateName::SubstTemplateTemplateParmPack: {
6020     SubstTemplateTemplateParmPackStorage *subst
6021       = Name.getAsSubstTemplateTemplateParmPack();
6022     return DeclarationNameInfo(subst->getParameterPack()->getDeclName(),
6023                                NameLoc);
6024   }
6025   }
6026 
6027   llvm_unreachable("bad template name kind!");
6028 }
6029 
6030 TemplateName ASTContext::getCanonicalTemplateName(TemplateName Name) const {
6031   switch (Name.getKind()) {
6032   case TemplateName::QualifiedTemplate:
6033   case TemplateName::Template: {
6034     TemplateDecl *Template = Name.getAsTemplateDecl();
6035     if (auto *TTP  = dyn_cast<TemplateTemplateParmDecl>(Template))
6036       Template = getCanonicalTemplateTemplateParmDecl(TTP);
6037 
6038     // The canonical template name is the canonical template declaration.
6039     return TemplateName(cast<TemplateDecl>(Template->getCanonicalDecl()));
6040   }
6041 
6042   case TemplateName::OverloadedTemplate:
6043   case TemplateName::AssumedTemplate:
6044     llvm_unreachable("cannot canonicalize unresolved template");
6045 
6046   case TemplateName::DependentTemplate: {
6047     DependentTemplateName *DTN = Name.getAsDependentTemplateName();
6048     assert(DTN && "Non-dependent template names must refer to template decls.");
6049     return DTN->CanonicalTemplateName;
6050   }
6051 
6052   case TemplateName::SubstTemplateTemplateParm: {
6053     SubstTemplateTemplateParmStorage *subst
6054       = Name.getAsSubstTemplateTemplateParm();
6055     return getCanonicalTemplateName(subst->getReplacement());
6056   }
6057 
6058   case TemplateName::SubstTemplateTemplateParmPack: {
6059     SubstTemplateTemplateParmPackStorage *subst
6060                                   = Name.getAsSubstTemplateTemplateParmPack();
6061     TemplateTemplateParmDecl *canonParameter
6062       = getCanonicalTemplateTemplateParmDecl(subst->getParameterPack());
6063     TemplateArgument canonArgPack
6064       = getCanonicalTemplateArgument(subst->getArgumentPack());
6065     return getSubstTemplateTemplateParmPack(canonParameter, canonArgPack);
6066   }
6067   }
6068 
6069   llvm_unreachable("bad template name!");
6070 }
6071 
6072 bool ASTContext::hasSameTemplateName(TemplateName X, TemplateName Y) {
6073   X = getCanonicalTemplateName(X);
6074   Y = getCanonicalTemplateName(Y);
6075   return X.getAsVoidPointer() == Y.getAsVoidPointer();
6076 }
6077 
6078 TemplateArgument
6079 ASTContext::getCanonicalTemplateArgument(const TemplateArgument &Arg) const {
6080   switch (Arg.getKind()) {
6081     case TemplateArgument::Null:
6082       return Arg;
6083 
6084     case TemplateArgument::Expression:
6085       return Arg;
6086 
6087     case TemplateArgument::Declaration: {
6088       auto *D = cast<ValueDecl>(Arg.getAsDecl()->getCanonicalDecl());
6089       return TemplateArgument(D, Arg.getParamTypeForDecl());
6090     }
6091 
6092     case TemplateArgument::NullPtr:
6093       return TemplateArgument(getCanonicalType(Arg.getNullPtrType()),
6094                               /*isNullPtr*/true);
6095 
6096     case TemplateArgument::Template:
6097       return TemplateArgument(getCanonicalTemplateName(Arg.getAsTemplate()));
6098 
6099     case TemplateArgument::TemplateExpansion:
6100       return TemplateArgument(getCanonicalTemplateName(
6101                                          Arg.getAsTemplateOrTemplatePattern()),
6102                               Arg.getNumTemplateExpansions());
6103 
6104     case TemplateArgument::Integral:
6105       return TemplateArgument(Arg, getCanonicalType(Arg.getIntegralType()));
6106 
6107     case TemplateArgument::Type:
6108       return TemplateArgument(getCanonicalType(Arg.getAsType()));
6109 
6110     case TemplateArgument::Pack: {
6111       if (Arg.pack_size() == 0)
6112         return Arg;
6113 
6114       auto *CanonArgs = new (*this) TemplateArgument[Arg.pack_size()];
6115       unsigned Idx = 0;
6116       for (TemplateArgument::pack_iterator A = Arg.pack_begin(),
6117                                         AEnd = Arg.pack_end();
6118            A != AEnd; (void)++A, ++Idx)
6119         CanonArgs[Idx] = getCanonicalTemplateArgument(*A);
6120 
6121       return TemplateArgument(llvm::makeArrayRef(CanonArgs, Arg.pack_size()));
6122     }
6123   }
6124 
6125   // Silence GCC warning
6126   llvm_unreachable("Unhandled template argument kind");
6127 }
6128 
6129 NestedNameSpecifier *
6130 ASTContext::getCanonicalNestedNameSpecifier(NestedNameSpecifier *NNS) const {
6131   if (!NNS)
6132     return nullptr;
6133 
6134   switch (NNS->getKind()) {
6135   case NestedNameSpecifier::Identifier:
6136     // Canonicalize the prefix but keep the identifier the same.
6137     return NestedNameSpecifier::Create(*this,
6138                          getCanonicalNestedNameSpecifier(NNS->getPrefix()),
6139                                        NNS->getAsIdentifier());
6140 
6141   case NestedNameSpecifier::Namespace:
6142     // A namespace is canonical; build a nested-name-specifier with
6143     // this namespace and no prefix.
6144     return NestedNameSpecifier::Create(*this, nullptr,
6145                                  NNS->getAsNamespace()->getOriginalNamespace());
6146 
6147   case NestedNameSpecifier::NamespaceAlias:
6148     // A namespace is canonical; build a nested-name-specifier with
6149     // this namespace and no prefix.
6150     return NestedNameSpecifier::Create(*this, nullptr,
6151                                     NNS->getAsNamespaceAlias()->getNamespace()
6152                                                       ->getOriginalNamespace());
6153 
6154   // The difference between TypeSpec and TypeSpecWithTemplate is that the
6155   // latter will have the 'template' keyword when printed.
6156   case NestedNameSpecifier::TypeSpec:
6157   case NestedNameSpecifier::TypeSpecWithTemplate: {
6158     const Type *T = getCanonicalType(NNS->getAsType());
6159 
6160     // If we have some kind of dependent-named type (e.g., "typename T::type"),
6161     // break it apart into its prefix and identifier, then reconsititute those
6162     // as the canonical nested-name-specifier. This is required to canonicalize
6163     // a dependent nested-name-specifier involving typedefs of dependent-name
6164     // types, e.g.,
6165     //   typedef typename T::type T1;
6166     //   typedef typename T1::type T2;
6167     if (const auto *DNT = T->getAs<DependentNameType>())
6168       return NestedNameSpecifier::Create(
6169           *this, DNT->getQualifier(),
6170           const_cast<IdentifierInfo *>(DNT->getIdentifier()));
6171     if (const auto *DTST = T->getAs<DependentTemplateSpecializationType>())
6172       return NestedNameSpecifier::Create(*this, DTST->getQualifier(), true,
6173                                          const_cast<Type *>(T));
6174 
6175     // TODO: Set 'Template' parameter to true for other template types.
6176     return NestedNameSpecifier::Create(*this, nullptr, false,
6177                                        const_cast<Type *>(T));
6178   }
6179 
6180   case NestedNameSpecifier::Global:
6181   case NestedNameSpecifier::Super:
6182     // The global specifier and __super specifer are canonical and unique.
6183     return NNS;
6184   }
6185 
6186   llvm_unreachable("Invalid NestedNameSpecifier::Kind!");
6187 }
6188 
6189 const ArrayType *ASTContext::getAsArrayType(QualType T) const {
6190   // Handle the non-qualified case efficiently.
6191   if (!T.hasLocalQualifiers()) {
6192     // Handle the common positive case fast.
6193     if (const auto *AT = dyn_cast<ArrayType>(T))
6194       return AT;
6195   }
6196 
6197   // Handle the common negative case fast.
6198   if (!isa<ArrayType>(T.getCanonicalType()))
6199     return nullptr;
6200 
6201   // Apply any qualifiers from the array type to the element type.  This
6202   // implements C99 6.7.3p8: "If the specification of an array type includes
6203   // any type qualifiers, the element type is so qualified, not the array type."
6204 
6205   // If we get here, we either have type qualifiers on the type, or we have
6206   // sugar such as a typedef in the way.  If we have type qualifiers on the type
6207   // we must propagate them down into the element type.
6208 
6209   SplitQualType split = T.getSplitDesugaredType();
6210   Qualifiers qs = split.Quals;
6211 
6212   // If we have a simple case, just return now.
6213   const auto *ATy = dyn_cast<ArrayType>(split.Ty);
6214   if (!ATy || qs.empty())
6215     return ATy;
6216 
6217   // Otherwise, we have an array and we have qualifiers on it.  Push the
6218   // qualifiers into the array element type and return a new array type.
6219   QualType NewEltTy = getQualifiedType(ATy->getElementType(), qs);
6220 
6221   if (const auto *CAT = dyn_cast<ConstantArrayType>(ATy))
6222     return cast<ArrayType>(getConstantArrayType(NewEltTy, CAT->getSize(),
6223                                                 CAT->getSizeExpr(),
6224                                                 CAT->getSizeModifier(),
6225                                            CAT->getIndexTypeCVRQualifiers()));
6226   if (const auto *IAT = dyn_cast<IncompleteArrayType>(ATy))
6227     return cast<ArrayType>(getIncompleteArrayType(NewEltTy,
6228                                                   IAT->getSizeModifier(),
6229                                            IAT->getIndexTypeCVRQualifiers()));
6230 
6231   if (const auto *DSAT = dyn_cast<DependentSizedArrayType>(ATy))
6232     return cast<ArrayType>(
6233                      getDependentSizedArrayType(NewEltTy,
6234                                                 DSAT->getSizeExpr(),
6235                                                 DSAT->getSizeModifier(),
6236                                               DSAT->getIndexTypeCVRQualifiers(),
6237                                                 DSAT->getBracketsRange()));
6238 
6239   const auto *VAT = cast<VariableArrayType>(ATy);
6240   return cast<ArrayType>(getVariableArrayType(NewEltTy,
6241                                               VAT->getSizeExpr(),
6242                                               VAT->getSizeModifier(),
6243                                               VAT->getIndexTypeCVRQualifiers(),
6244                                               VAT->getBracketsRange()));
6245 }
6246 
6247 QualType ASTContext::getAdjustedParameterType(QualType T) const {
6248   if (T->isArrayType() || T->isFunctionType())
6249     return getDecayedType(T);
6250   return T;
6251 }
6252 
6253 QualType ASTContext::getSignatureParameterType(QualType T) const {
6254   T = getVariableArrayDecayedType(T);
6255   T = getAdjustedParameterType(T);
6256   return T.getUnqualifiedType();
6257 }
6258 
6259 QualType ASTContext::getExceptionObjectType(QualType T) const {
6260   // C++ [except.throw]p3:
6261   //   A throw-expression initializes a temporary object, called the exception
6262   //   object, the type of which is determined by removing any top-level
6263   //   cv-qualifiers from the static type of the operand of throw and adjusting
6264   //   the type from "array of T" or "function returning T" to "pointer to T"
6265   //   or "pointer to function returning T", [...]
6266   T = getVariableArrayDecayedType(T);
6267   if (T->isArrayType() || T->isFunctionType())
6268     T = getDecayedType(T);
6269   return T.getUnqualifiedType();
6270 }
6271 
6272 /// getArrayDecayedType - Return the properly qualified result of decaying the
6273 /// specified array type to a pointer.  This operation is non-trivial when
6274 /// handling typedefs etc.  The canonical type of "T" must be an array type,
6275 /// this returns a pointer to a properly qualified element of the array.
6276 ///
6277 /// See C99 6.7.5.3p7 and C99 6.3.2.1p3.
6278 QualType ASTContext::getArrayDecayedType(QualType Ty) const {
6279   // Get the element type with 'getAsArrayType' so that we don't lose any
6280   // typedefs in the element type of the array.  This also handles propagation
6281   // of type qualifiers from the array type into the element type if present
6282   // (C99 6.7.3p8).
6283   const ArrayType *PrettyArrayType = getAsArrayType(Ty);
6284   assert(PrettyArrayType && "Not an array type!");
6285 
6286   QualType PtrTy = getPointerType(PrettyArrayType->getElementType());
6287 
6288   // int x[restrict 4] ->  int *restrict
6289   QualType Result = getQualifiedType(PtrTy,
6290                                      PrettyArrayType->getIndexTypeQualifiers());
6291 
6292   // int x[_Nullable] -> int * _Nullable
6293   if (auto Nullability = Ty->getNullability(*this)) {
6294     Result = const_cast<ASTContext *>(this)->getAttributedType(
6295         AttributedType::getNullabilityAttrKind(*Nullability), Result, Result);
6296   }
6297   return Result;
6298 }
6299 
6300 QualType ASTContext::getBaseElementType(const ArrayType *array) const {
6301   return getBaseElementType(array->getElementType());
6302 }
6303 
6304 QualType ASTContext::getBaseElementType(QualType type) const {
6305   Qualifiers qs;
6306   while (true) {
6307     SplitQualType split = type.getSplitDesugaredType();
6308     const ArrayType *array = split.Ty->getAsArrayTypeUnsafe();
6309     if (!array) break;
6310 
6311     type = array->getElementType();
6312     qs.addConsistentQualifiers(split.Quals);
6313   }
6314 
6315   return getQualifiedType(type, qs);
6316 }
6317 
6318 /// getConstantArrayElementCount - Returns number of constant array elements.
6319 uint64_t
6320 ASTContext::getConstantArrayElementCount(const ConstantArrayType *CA)  const {
6321   uint64_t ElementCount = 1;
6322   do {
6323     ElementCount *= CA->getSize().getZExtValue();
6324     CA = dyn_cast_or_null<ConstantArrayType>(
6325       CA->getElementType()->getAsArrayTypeUnsafe());
6326   } while (CA);
6327   return ElementCount;
6328 }
6329 
6330 /// getFloatingRank - Return a relative rank for floating point types.
6331 /// This routine will assert if passed a built-in type that isn't a float.
6332 static FloatingRank getFloatingRank(QualType T) {
6333   if (const auto *CT = T->getAs<ComplexType>())
6334     return getFloatingRank(CT->getElementType());
6335 
6336   switch (T->castAs<BuiltinType>()->getKind()) {
6337   default: llvm_unreachable("getFloatingRank(): not a floating type");
6338   case BuiltinType::Float16:    return Float16Rank;
6339   case BuiltinType::Half:       return HalfRank;
6340   case BuiltinType::Float:      return FloatRank;
6341   case BuiltinType::Double:     return DoubleRank;
6342   case BuiltinType::LongDouble: return LongDoubleRank;
6343   case BuiltinType::Float128:   return Float128Rank;
6344   case BuiltinType::BFloat16:   return BFloat16Rank;
6345   case BuiltinType::Ibm128:     return Ibm128Rank;
6346   }
6347 }
6348 
6349 /// getFloatingTypeOfSizeWithinDomain - Returns a real floating
6350 /// point or a complex type (based on typeDomain/typeSize).
6351 /// 'typeDomain' is a real floating point or complex type.
6352 /// 'typeSize' is a real floating point or complex type.
6353 QualType ASTContext::getFloatingTypeOfSizeWithinDomain(QualType Size,
6354                                                        QualType Domain) const {
6355   FloatingRank EltRank = getFloatingRank(Size);
6356   if (Domain->isComplexType()) {
6357     switch (EltRank) {
6358     case BFloat16Rank: llvm_unreachable("Complex bfloat16 is not supported");
6359     case Float16Rank:
6360     case HalfRank: llvm_unreachable("Complex half is not supported");
6361     case Ibm128Rank:     return getComplexType(Ibm128Ty);
6362     case FloatRank:      return getComplexType(FloatTy);
6363     case DoubleRank:     return getComplexType(DoubleTy);
6364     case LongDoubleRank: return getComplexType(LongDoubleTy);
6365     case Float128Rank:   return getComplexType(Float128Ty);
6366     }
6367   }
6368 
6369   assert(Domain->isRealFloatingType() && "Unknown domain!");
6370   switch (EltRank) {
6371   case Float16Rank:    return HalfTy;
6372   case BFloat16Rank:   return BFloat16Ty;
6373   case HalfRank:       return HalfTy;
6374   case FloatRank:      return FloatTy;
6375   case DoubleRank:     return DoubleTy;
6376   case LongDoubleRank: return LongDoubleTy;
6377   case Float128Rank:   return Float128Ty;
6378   case Ibm128Rank:
6379     return Ibm128Ty;
6380   }
6381   llvm_unreachable("getFloatingRank(): illegal value for rank");
6382 }
6383 
6384 /// getFloatingTypeOrder - Compare the rank of the two specified floating
6385 /// point types, ignoring the domain of the type (i.e. 'double' ==
6386 /// '_Complex double').  If LHS > RHS, return 1.  If LHS == RHS, return 0. If
6387 /// LHS < RHS, return -1.
6388 int ASTContext::getFloatingTypeOrder(QualType LHS, QualType RHS) const {
6389   FloatingRank LHSR = getFloatingRank(LHS);
6390   FloatingRank RHSR = getFloatingRank(RHS);
6391 
6392   if (LHSR == RHSR)
6393     return 0;
6394   if (LHSR > RHSR)
6395     return 1;
6396   return -1;
6397 }
6398 
6399 int ASTContext::getFloatingTypeSemanticOrder(QualType LHS, QualType RHS) const {
6400   if (&getFloatTypeSemantics(LHS) == &getFloatTypeSemantics(RHS))
6401     return 0;
6402   return getFloatingTypeOrder(LHS, RHS);
6403 }
6404 
6405 /// getIntegerRank - Return an integer conversion rank (C99 6.3.1.1p1). This
6406 /// routine will assert if passed a built-in type that isn't an integer or enum,
6407 /// or if it is not canonicalized.
6408 unsigned ASTContext::getIntegerRank(const Type *T) const {
6409   assert(T->isCanonicalUnqualified() && "T should be canonicalized");
6410 
6411   // Results in this 'losing' to any type of the same size, but winning if
6412   // larger.
6413   if (const auto *EIT = dyn_cast<ExtIntType>(T))
6414     return 0 + (EIT->getNumBits() << 3);
6415 
6416   switch (cast<BuiltinType>(T)->getKind()) {
6417   default: llvm_unreachable("getIntegerRank(): not a built-in integer");
6418   case BuiltinType::Bool:
6419     return 1 + (getIntWidth(BoolTy) << 3);
6420   case BuiltinType::Char_S:
6421   case BuiltinType::Char_U:
6422   case BuiltinType::SChar:
6423   case BuiltinType::UChar:
6424     return 2 + (getIntWidth(CharTy) << 3);
6425   case BuiltinType::Short:
6426   case BuiltinType::UShort:
6427     return 3 + (getIntWidth(ShortTy) << 3);
6428   case BuiltinType::Int:
6429   case BuiltinType::UInt:
6430     return 4 + (getIntWidth(IntTy) << 3);
6431   case BuiltinType::Long:
6432   case BuiltinType::ULong:
6433     return 5 + (getIntWidth(LongTy) << 3);
6434   case BuiltinType::LongLong:
6435   case BuiltinType::ULongLong:
6436     return 6 + (getIntWidth(LongLongTy) << 3);
6437   case BuiltinType::Int128:
6438   case BuiltinType::UInt128:
6439     return 7 + (getIntWidth(Int128Ty) << 3);
6440   }
6441 }
6442 
6443 /// Whether this is a promotable bitfield reference according
6444 /// to C99 6.3.1.1p2, bullet 2 (and GCC extensions).
6445 ///
6446 /// \returns the type this bit-field will promote to, or NULL if no
6447 /// promotion occurs.
6448 QualType ASTContext::isPromotableBitField(Expr *E) const {
6449   if (E->isTypeDependent() || E->isValueDependent())
6450     return {};
6451 
6452   // C++ [conv.prom]p5:
6453   //    If the bit-field has an enumerated type, it is treated as any other
6454   //    value of that type for promotion purposes.
6455   if (getLangOpts().CPlusPlus && E->getType()->isEnumeralType())
6456     return {};
6457 
6458   // FIXME: We should not do this unless E->refersToBitField() is true. This
6459   // matters in C where getSourceBitField() will find bit-fields for various
6460   // cases where the source expression is not a bit-field designator.
6461 
6462   FieldDecl *Field = E->getSourceBitField(); // FIXME: conditional bit-fields?
6463   if (!Field)
6464     return {};
6465 
6466   QualType FT = Field->getType();
6467 
6468   uint64_t BitWidth = Field->getBitWidthValue(*this);
6469   uint64_t IntSize = getTypeSize(IntTy);
6470   // C++ [conv.prom]p5:
6471   //   A prvalue for an integral bit-field can be converted to a prvalue of type
6472   //   int if int can represent all the values of the bit-field; otherwise, it
6473   //   can be converted to unsigned int if unsigned int can represent all the
6474   //   values of the bit-field. If the bit-field is larger yet, no integral
6475   //   promotion applies to it.
6476   // C11 6.3.1.1/2:
6477   //   [For a bit-field of type _Bool, int, signed int, or unsigned int:]
6478   //   If an int can represent all values of the original type (as restricted by
6479   //   the width, for a bit-field), the value is converted to an int; otherwise,
6480   //   it is converted to an unsigned int.
6481   //
6482   // FIXME: C does not permit promotion of a 'long : 3' bitfield to int.
6483   //        We perform that promotion here to match GCC and C++.
6484   // FIXME: C does not permit promotion of an enum bit-field whose rank is
6485   //        greater than that of 'int'. We perform that promotion to match GCC.
6486   if (BitWidth < IntSize)
6487     return IntTy;
6488 
6489   if (BitWidth == IntSize)
6490     return FT->isSignedIntegerType() ? IntTy : UnsignedIntTy;
6491 
6492   // Bit-fields wider than int are not subject to promotions, and therefore act
6493   // like the base type. GCC has some weird bugs in this area that we
6494   // deliberately do not follow (GCC follows a pre-standard resolution to
6495   // C's DR315 which treats bit-width as being part of the type, and this leaks
6496   // into their semantics in some cases).
6497   return {};
6498 }
6499 
6500 /// getPromotedIntegerType - Returns the type that Promotable will
6501 /// promote to: C99 6.3.1.1p2, assuming that Promotable is a promotable
6502 /// integer type.
6503 QualType ASTContext::getPromotedIntegerType(QualType Promotable) const {
6504   assert(!Promotable.isNull());
6505   assert(Promotable->isPromotableIntegerType());
6506   if (const auto *ET = Promotable->getAs<EnumType>())
6507     return ET->getDecl()->getPromotionType();
6508 
6509   if (const auto *BT = Promotable->getAs<BuiltinType>()) {
6510     // C++ [conv.prom]: A prvalue of type char16_t, char32_t, or wchar_t
6511     // (3.9.1) can be converted to a prvalue of the first of the following
6512     // types that can represent all the values of its underlying type:
6513     // int, unsigned int, long int, unsigned long int, long long int, or
6514     // unsigned long long int [...]
6515     // FIXME: Is there some better way to compute this?
6516     if (BT->getKind() == BuiltinType::WChar_S ||
6517         BT->getKind() == BuiltinType::WChar_U ||
6518         BT->getKind() == BuiltinType::Char8 ||
6519         BT->getKind() == BuiltinType::Char16 ||
6520         BT->getKind() == BuiltinType::Char32) {
6521       bool FromIsSigned = BT->getKind() == BuiltinType::WChar_S;
6522       uint64_t FromSize = getTypeSize(BT);
6523       QualType PromoteTypes[] = { IntTy, UnsignedIntTy, LongTy, UnsignedLongTy,
6524                                   LongLongTy, UnsignedLongLongTy };
6525       for (size_t Idx = 0; Idx < llvm::array_lengthof(PromoteTypes); ++Idx) {
6526         uint64_t ToSize = getTypeSize(PromoteTypes[Idx]);
6527         if (FromSize < ToSize ||
6528             (FromSize == ToSize &&
6529              FromIsSigned == PromoteTypes[Idx]->isSignedIntegerType()))
6530           return PromoteTypes[Idx];
6531       }
6532       llvm_unreachable("char type should fit into long long");
6533     }
6534   }
6535 
6536   // At this point, we should have a signed or unsigned integer type.
6537   if (Promotable->isSignedIntegerType())
6538     return IntTy;
6539   uint64_t PromotableSize = getIntWidth(Promotable);
6540   uint64_t IntSize = getIntWidth(IntTy);
6541   assert(Promotable->isUnsignedIntegerType() && PromotableSize <= IntSize);
6542   return (PromotableSize != IntSize) ? IntTy : UnsignedIntTy;
6543 }
6544 
6545 /// Recurses in pointer/array types until it finds an objc retainable
6546 /// type and returns its ownership.
6547 Qualifiers::ObjCLifetime ASTContext::getInnerObjCOwnership(QualType T) const {
6548   while (!T.isNull()) {
6549     if (T.getObjCLifetime() != Qualifiers::OCL_None)
6550       return T.getObjCLifetime();
6551     if (T->isArrayType())
6552       T = getBaseElementType(T);
6553     else if (const auto *PT = T->getAs<PointerType>())
6554       T = PT->getPointeeType();
6555     else if (const auto *RT = T->getAs<ReferenceType>())
6556       T = RT->getPointeeType();
6557     else
6558       break;
6559   }
6560 
6561   return Qualifiers::OCL_None;
6562 }
6563 
6564 static const Type *getIntegerTypeForEnum(const EnumType *ET) {
6565   // Incomplete enum types are not treated as integer types.
6566   // FIXME: In C++, enum types are never integer types.
6567   if (ET->getDecl()->isComplete() && !ET->getDecl()->isScoped())
6568     return ET->getDecl()->getIntegerType().getTypePtr();
6569   return nullptr;
6570 }
6571 
6572 /// getIntegerTypeOrder - Returns the highest ranked integer type:
6573 /// C99 6.3.1.8p1.  If LHS > RHS, return 1.  If LHS == RHS, return 0. If
6574 /// LHS < RHS, return -1.
6575 int ASTContext::getIntegerTypeOrder(QualType LHS, QualType RHS) const {
6576   const Type *LHSC = getCanonicalType(LHS).getTypePtr();
6577   const Type *RHSC = getCanonicalType(RHS).getTypePtr();
6578 
6579   // Unwrap enums to their underlying type.
6580   if (const auto *ET = dyn_cast<EnumType>(LHSC))
6581     LHSC = getIntegerTypeForEnum(ET);
6582   if (const auto *ET = dyn_cast<EnumType>(RHSC))
6583     RHSC = getIntegerTypeForEnum(ET);
6584 
6585   if (LHSC == RHSC) return 0;
6586 
6587   bool LHSUnsigned = LHSC->isUnsignedIntegerType();
6588   bool RHSUnsigned = RHSC->isUnsignedIntegerType();
6589 
6590   unsigned LHSRank = getIntegerRank(LHSC);
6591   unsigned RHSRank = getIntegerRank(RHSC);
6592 
6593   if (LHSUnsigned == RHSUnsigned) {  // Both signed or both unsigned.
6594     if (LHSRank == RHSRank) return 0;
6595     return LHSRank > RHSRank ? 1 : -1;
6596   }
6597 
6598   // Otherwise, the LHS is signed and the RHS is unsigned or visa versa.
6599   if (LHSUnsigned) {
6600     // If the unsigned [LHS] type is larger, return it.
6601     if (LHSRank >= RHSRank)
6602       return 1;
6603 
6604     // If the signed type can represent all values of the unsigned type, it
6605     // wins.  Because we are dealing with 2's complement and types that are
6606     // powers of two larger than each other, this is always safe.
6607     return -1;
6608   }
6609 
6610   // If the unsigned [RHS] type is larger, return it.
6611   if (RHSRank >= LHSRank)
6612     return -1;
6613 
6614   // If the signed type can represent all values of the unsigned type, it
6615   // wins.  Because we are dealing with 2's complement and types that are
6616   // powers of two larger than each other, this is always safe.
6617   return 1;
6618 }
6619 
6620 TypedefDecl *ASTContext::getCFConstantStringDecl() const {
6621   if (CFConstantStringTypeDecl)
6622     return CFConstantStringTypeDecl;
6623 
6624   assert(!CFConstantStringTagDecl &&
6625          "tag and typedef should be initialized together");
6626   CFConstantStringTagDecl = buildImplicitRecord("__NSConstantString_tag");
6627   CFConstantStringTagDecl->startDefinition();
6628 
6629   struct {
6630     QualType Type;
6631     const char *Name;
6632   } Fields[5];
6633   unsigned Count = 0;
6634 
6635   /// Objective-C ABI
6636   ///
6637   ///    typedef struct __NSConstantString_tag {
6638   ///      const int *isa;
6639   ///      int flags;
6640   ///      const char *str;
6641   ///      long length;
6642   ///    } __NSConstantString;
6643   ///
6644   /// Swift ABI (4.1, 4.2)
6645   ///
6646   ///    typedef struct __NSConstantString_tag {
6647   ///      uintptr_t _cfisa;
6648   ///      uintptr_t _swift_rc;
6649   ///      _Atomic(uint64_t) _cfinfoa;
6650   ///      const char *_ptr;
6651   ///      uint32_t _length;
6652   ///    } __NSConstantString;
6653   ///
6654   /// Swift ABI (5.0)
6655   ///
6656   ///    typedef struct __NSConstantString_tag {
6657   ///      uintptr_t _cfisa;
6658   ///      uintptr_t _swift_rc;
6659   ///      _Atomic(uint64_t) _cfinfoa;
6660   ///      const char *_ptr;
6661   ///      uintptr_t _length;
6662   ///    } __NSConstantString;
6663 
6664   const auto CFRuntime = getLangOpts().CFRuntime;
6665   if (static_cast<unsigned>(CFRuntime) <
6666       static_cast<unsigned>(LangOptions::CoreFoundationABI::Swift)) {
6667     Fields[Count++] = { getPointerType(IntTy.withConst()), "isa" };
6668     Fields[Count++] = { IntTy, "flags" };
6669     Fields[Count++] = { getPointerType(CharTy.withConst()), "str" };
6670     Fields[Count++] = { LongTy, "length" };
6671   } else {
6672     Fields[Count++] = { getUIntPtrType(), "_cfisa" };
6673     Fields[Count++] = { getUIntPtrType(), "_swift_rc" };
6674     Fields[Count++] = { getFromTargetType(Target->getUInt64Type()), "_swift_rc" };
6675     Fields[Count++] = { getPointerType(CharTy.withConst()), "_ptr" };
6676     if (CFRuntime == LangOptions::CoreFoundationABI::Swift4_1 ||
6677         CFRuntime == LangOptions::CoreFoundationABI::Swift4_2)
6678       Fields[Count++] = { IntTy, "_ptr" };
6679     else
6680       Fields[Count++] = { getUIntPtrType(), "_ptr" };
6681   }
6682 
6683   // Create fields
6684   for (unsigned i = 0; i < Count; ++i) {
6685     FieldDecl *Field =
6686         FieldDecl::Create(*this, CFConstantStringTagDecl, SourceLocation(),
6687                           SourceLocation(), &Idents.get(Fields[i].Name),
6688                           Fields[i].Type, /*TInfo=*/nullptr,
6689                           /*BitWidth=*/nullptr, /*Mutable=*/false, ICIS_NoInit);
6690     Field->setAccess(AS_public);
6691     CFConstantStringTagDecl->addDecl(Field);
6692   }
6693 
6694   CFConstantStringTagDecl->completeDefinition();
6695   // This type is designed to be compatible with NSConstantString, but cannot
6696   // use the same name, since NSConstantString is an interface.
6697   auto tagType = getTagDeclType(CFConstantStringTagDecl);
6698   CFConstantStringTypeDecl =
6699       buildImplicitTypedef(tagType, "__NSConstantString");
6700 
6701   return CFConstantStringTypeDecl;
6702 }
6703 
6704 RecordDecl *ASTContext::getCFConstantStringTagDecl() const {
6705   if (!CFConstantStringTagDecl)
6706     getCFConstantStringDecl(); // Build the tag and the typedef.
6707   return CFConstantStringTagDecl;
6708 }
6709 
6710 // getCFConstantStringType - Return the type used for constant CFStrings.
6711 QualType ASTContext::getCFConstantStringType() const {
6712   return getTypedefType(getCFConstantStringDecl());
6713 }
6714 
6715 QualType ASTContext::getObjCSuperType() const {
6716   if (ObjCSuperType.isNull()) {
6717     RecordDecl *ObjCSuperTypeDecl = buildImplicitRecord("objc_super");
6718     getTranslationUnitDecl()->addDecl(ObjCSuperTypeDecl);
6719     ObjCSuperType = getTagDeclType(ObjCSuperTypeDecl);
6720   }
6721   return ObjCSuperType;
6722 }
6723 
6724 void ASTContext::setCFConstantStringType(QualType T) {
6725   const auto *TD = T->castAs<TypedefType>();
6726   CFConstantStringTypeDecl = cast<TypedefDecl>(TD->getDecl());
6727   const auto *TagType =
6728       CFConstantStringTypeDecl->getUnderlyingType()->castAs<RecordType>();
6729   CFConstantStringTagDecl = TagType->getDecl();
6730 }
6731 
6732 QualType ASTContext::getBlockDescriptorType() const {
6733   if (BlockDescriptorType)
6734     return getTagDeclType(BlockDescriptorType);
6735 
6736   RecordDecl *RD;
6737   // FIXME: Needs the FlagAppleBlock bit.
6738   RD = buildImplicitRecord("__block_descriptor");
6739   RD->startDefinition();
6740 
6741   QualType FieldTypes[] = {
6742     UnsignedLongTy,
6743     UnsignedLongTy,
6744   };
6745 
6746   static const char *const FieldNames[] = {
6747     "reserved",
6748     "Size"
6749   };
6750 
6751   for (size_t i = 0; i < 2; ++i) {
6752     FieldDecl *Field = FieldDecl::Create(
6753         *this, RD, SourceLocation(), SourceLocation(),
6754         &Idents.get(FieldNames[i]), FieldTypes[i], /*TInfo=*/nullptr,
6755         /*BitWidth=*/nullptr, /*Mutable=*/false, ICIS_NoInit);
6756     Field->setAccess(AS_public);
6757     RD->addDecl(Field);
6758   }
6759 
6760   RD->completeDefinition();
6761 
6762   BlockDescriptorType = RD;
6763 
6764   return getTagDeclType(BlockDescriptorType);
6765 }
6766 
6767 QualType ASTContext::getBlockDescriptorExtendedType() const {
6768   if (BlockDescriptorExtendedType)
6769     return getTagDeclType(BlockDescriptorExtendedType);
6770 
6771   RecordDecl *RD;
6772   // FIXME: Needs the FlagAppleBlock bit.
6773   RD = buildImplicitRecord("__block_descriptor_withcopydispose");
6774   RD->startDefinition();
6775 
6776   QualType FieldTypes[] = {
6777     UnsignedLongTy,
6778     UnsignedLongTy,
6779     getPointerType(VoidPtrTy),
6780     getPointerType(VoidPtrTy)
6781   };
6782 
6783   static const char *const FieldNames[] = {
6784     "reserved",
6785     "Size",
6786     "CopyFuncPtr",
6787     "DestroyFuncPtr"
6788   };
6789 
6790   for (size_t i = 0; i < 4; ++i) {
6791     FieldDecl *Field = FieldDecl::Create(
6792         *this, RD, SourceLocation(), SourceLocation(),
6793         &Idents.get(FieldNames[i]), FieldTypes[i], /*TInfo=*/nullptr,
6794         /*BitWidth=*/nullptr,
6795         /*Mutable=*/false, ICIS_NoInit);
6796     Field->setAccess(AS_public);
6797     RD->addDecl(Field);
6798   }
6799 
6800   RD->completeDefinition();
6801 
6802   BlockDescriptorExtendedType = RD;
6803   return getTagDeclType(BlockDescriptorExtendedType);
6804 }
6805 
6806 OpenCLTypeKind ASTContext::getOpenCLTypeKind(const Type *T) const {
6807   const auto *BT = dyn_cast<BuiltinType>(T);
6808 
6809   if (!BT) {
6810     if (isa<PipeType>(T))
6811       return OCLTK_Pipe;
6812 
6813     return OCLTK_Default;
6814   }
6815 
6816   switch (BT->getKind()) {
6817 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix)                   \
6818   case BuiltinType::Id:                                                        \
6819     return OCLTK_Image;
6820 #include "clang/Basic/OpenCLImageTypes.def"
6821 
6822   case BuiltinType::OCLClkEvent:
6823     return OCLTK_ClkEvent;
6824 
6825   case BuiltinType::OCLEvent:
6826     return OCLTK_Event;
6827 
6828   case BuiltinType::OCLQueue:
6829     return OCLTK_Queue;
6830 
6831   case BuiltinType::OCLReserveID:
6832     return OCLTK_ReserveID;
6833 
6834   case BuiltinType::OCLSampler:
6835     return OCLTK_Sampler;
6836 
6837   default:
6838     return OCLTK_Default;
6839   }
6840 }
6841 
6842 LangAS ASTContext::getOpenCLTypeAddrSpace(const Type *T) const {
6843   return Target->getOpenCLTypeAddrSpace(getOpenCLTypeKind(T));
6844 }
6845 
6846 /// BlockRequiresCopying - Returns true if byref variable "D" of type "Ty"
6847 /// requires copy/dispose. Note that this must match the logic
6848 /// in buildByrefHelpers.
6849 bool ASTContext::BlockRequiresCopying(QualType Ty,
6850                                       const VarDecl *D) {
6851   if (const CXXRecordDecl *record = Ty->getAsCXXRecordDecl()) {
6852     const Expr *copyExpr = getBlockVarCopyInit(D).getCopyExpr();
6853     if (!copyExpr && record->hasTrivialDestructor()) return false;
6854 
6855     return true;
6856   }
6857 
6858   // The block needs copy/destroy helpers if Ty is non-trivial to destructively
6859   // move or destroy.
6860   if (Ty.isNonTrivialToPrimitiveDestructiveMove() || Ty.isDestructedType())
6861     return true;
6862 
6863   if (!Ty->isObjCRetainableType()) return false;
6864 
6865   Qualifiers qs = Ty.getQualifiers();
6866 
6867   // If we have lifetime, that dominates.
6868   if (Qualifiers::ObjCLifetime lifetime = qs.getObjCLifetime()) {
6869     switch (lifetime) {
6870       case Qualifiers::OCL_None: llvm_unreachable("impossible");
6871 
6872       // These are just bits as far as the runtime is concerned.
6873       case Qualifiers::OCL_ExplicitNone:
6874       case Qualifiers::OCL_Autoreleasing:
6875         return false;
6876 
6877       // These cases should have been taken care of when checking the type's
6878       // non-triviality.
6879       case Qualifiers::OCL_Weak:
6880       case Qualifiers::OCL_Strong:
6881         llvm_unreachable("impossible");
6882     }
6883     llvm_unreachable("fell out of lifetime switch!");
6884   }
6885   return (Ty->isBlockPointerType() || isObjCNSObjectType(Ty) ||
6886           Ty->isObjCObjectPointerType());
6887 }
6888 
6889 bool ASTContext::getByrefLifetime(QualType Ty,
6890                               Qualifiers::ObjCLifetime &LifeTime,
6891                               bool &HasByrefExtendedLayout) const {
6892   if (!getLangOpts().ObjC ||
6893       getLangOpts().getGC() != LangOptions::NonGC)
6894     return false;
6895 
6896   HasByrefExtendedLayout = false;
6897   if (Ty->isRecordType()) {
6898     HasByrefExtendedLayout = true;
6899     LifeTime = Qualifiers::OCL_None;
6900   } else if ((LifeTime = Ty.getObjCLifetime())) {
6901     // Honor the ARC qualifiers.
6902   } else if (Ty->isObjCObjectPointerType() || Ty->isBlockPointerType()) {
6903     // The MRR rule.
6904     LifeTime = Qualifiers::OCL_ExplicitNone;
6905   } else {
6906     LifeTime = Qualifiers::OCL_None;
6907   }
6908   return true;
6909 }
6910 
6911 CanQualType ASTContext::getNSUIntegerType() const {
6912   assert(Target && "Expected target to be initialized");
6913   const llvm::Triple &T = Target->getTriple();
6914   // Windows is LLP64 rather than LP64
6915   if (T.isOSWindows() && T.isArch64Bit())
6916     return UnsignedLongLongTy;
6917   return UnsignedLongTy;
6918 }
6919 
6920 CanQualType ASTContext::getNSIntegerType() const {
6921   assert(Target && "Expected target to be initialized");
6922   const llvm::Triple &T = Target->getTriple();
6923   // Windows is LLP64 rather than LP64
6924   if (T.isOSWindows() && T.isArch64Bit())
6925     return LongLongTy;
6926   return LongTy;
6927 }
6928 
6929 TypedefDecl *ASTContext::getObjCInstanceTypeDecl() {
6930   if (!ObjCInstanceTypeDecl)
6931     ObjCInstanceTypeDecl =
6932         buildImplicitTypedef(getObjCIdType(), "instancetype");
6933   return ObjCInstanceTypeDecl;
6934 }
6935 
6936 // This returns true if a type has been typedefed to BOOL:
6937 // typedef <type> BOOL;
6938 static bool isTypeTypedefedAsBOOL(QualType T) {
6939   if (const auto *TT = dyn_cast<TypedefType>(T))
6940     if (IdentifierInfo *II = TT->getDecl()->getIdentifier())
6941       return II->isStr("BOOL");
6942 
6943   return false;
6944 }
6945 
6946 /// getObjCEncodingTypeSize returns size of type for objective-c encoding
6947 /// purpose.
6948 CharUnits ASTContext::getObjCEncodingTypeSize(QualType type) const {
6949   if (!type->isIncompleteArrayType() && type->isIncompleteType())
6950     return CharUnits::Zero();
6951 
6952   CharUnits sz = getTypeSizeInChars(type);
6953 
6954   // Make all integer and enum types at least as large as an int
6955   if (sz.isPositive() && type->isIntegralOrEnumerationType())
6956     sz = std::max(sz, getTypeSizeInChars(IntTy));
6957   // Treat arrays as pointers, since that's how they're passed in.
6958   else if (type->isArrayType())
6959     sz = getTypeSizeInChars(VoidPtrTy);
6960   return sz;
6961 }
6962 
6963 bool ASTContext::isMSStaticDataMemberInlineDefinition(const VarDecl *VD) const {
6964   return getTargetInfo().getCXXABI().isMicrosoft() &&
6965          VD->isStaticDataMember() &&
6966          VD->getType()->isIntegralOrEnumerationType() &&
6967          !VD->getFirstDecl()->isOutOfLine() && VD->getFirstDecl()->hasInit();
6968 }
6969 
6970 ASTContext::InlineVariableDefinitionKind
6971 ASTContext::getInlineVariableDefinitionKind(const VarDecl *VD) const {
6972   if (!VD->isInline())
6973     return InlineVariableDefinitionKind::None;
6974 
6975   // In almost all cases, it's a weak definition.
6976   auto *First = VD->getFirstDecl();
6977   if (First->isInlineSpecified() || !First->isStaticDataMember())
6978     return InlineVariableDefinitionKind::Weak;
6979 
6980   // If there's a file-context declaration in this translation unit, it's a
6981   // non-discardable definition.
6982   for (auto *D : VD->redecls())
6983     if (D->getLexicalDeclContext()->isFileContext() &&
6984         !D->isInlineSpecified() && (D->isConstexpr() || First->isConstexpr()))
6985       return InlineVariableDefinitionKind::Strong;
6986 
6987   // If we've not seen one yet, we don't know.
6988   return InlineVariableDefinitionKind::WeakUnknown;
6989 }
6990 
6991 static std::string charUnitsToString(const CharUnits &CU) {
6992   return llvm::itostr(CU.getQuantity());
6993 }
6994 
6995 /// getObjCEncodingForBlock - Return the encoded type for this block
6996 /// declaration.
6997 std::string ASTContext::getObjCEncodingForBlock(const BlockExpr *Expr) const {
6998   std::string S;
6999 
7000   const BlockDecl *Decl = Expr->getBlockDecl();
7001   QualType BlockTy =
7002       Expr->getType()->castAs<BlockPointerType>()->getPointeeType();
7003   QualType BlockReturnTy = BlockTy->castAs<FunctionType>()->getReturnType();
7004   // Encode result type.
7005   if (getLangOpts().EncodeExtendedBlockSig)
7006     getObjCEncodingForMethodParameter(Decl::OBJC_TQ_None, BlockReturnTy, S,
7007                                       true /*Extended*/);
7008   else
7009     getObjCEncodingForType(BlockReturnTy, S);
7010   // Compute size of all parameters.
7011   // Start with computing size of a pointer in number of bytes.
7012   // FIXME: There might(should) be a better way of doing this computation!
7013   CharUnits PtrSize = getTypeSizeInChars(VoidPtrTy);
7014   CharUnits ParmOffset = PtrSize;
7015   for (auto PI : Decl->parameters()) {
7016     QualType PType = PI->getType();
7017     CharUnits sz = getObjCEncodingTypeSize(PType);
7018     if (sz.isZero())
7019       continue;
7020     assert(sz.isPositive() && "BlockExpr - Incomplete param type");
7021     ParmOffset += sz;
7022   }
7023   // Size of the argument frame
7024   S += charUnitsToString(ParmOffset);
7025   // Block pointer and offset.
7026   S += "@?0";
7027 
7028   // Argument types.
7029   ParmOffset = PtrSize;
7030   for (auto PVDecl : Decl->parameters()) {
7031     QualType PType = PVDecl->getOriginalType();
7032     if (const auto *AT =
7033             dyn_cast<ArrayType>(PType->getCanonicalTypeInternal())) {
7034       // Use array's original type only if it has known number of
7035       // elements.
7036       if (!isa<ConstantArrayType>(AT))
7037         PType = PVDecl->getType();
7038     } else if (PType->isFunctionType())
7039       PType = PVDecl->getType();
7040     if (getLangOpts().EncodeExtendedBlockSig)
7041       getObjCEncodingForMethodParameter(Decl::OBJC_TQ_None, PType,
7042                                       S, true /*Extended*/);
7043     else
7044       getObjCEncodingForType(PType, S);
7045     S += charUnitsToString(ParmOffset);
7046     ParmOffset += getObjCEncodingTypeSize(PType);
7047   }
7048 
7049   return S;
7050 }
7051 
7052 std::string
7053 ASTContext::getObjCEncodingForFunctionDecl(const FunctionDecl *Decl) const {
7054   std::string S;
7055   // Encode result type.
7056   getObjCEncodingForType(Decl->getReturnType(), S);
7057   CharUnits ParmOffset;
7058   // Compute size of all parameters.
7059   for (auto PI : Decl->parameters()) {
7060     QualType PType = PI->getType();
7061     CharUnits sz = getObjCEncodingTypeSize(PType);
7062     if (sz.isZero())
7063       continue;
7064 
7065     assert(sz.isPositive() &&
7066            "getObjCEncodingForFunctionDecl - Incomplete param type");
7067     ParmOffset += sz;
7068   }
7069   S += charUnitsToString(ParmOffset);
7070   ParmOffset = CharUnits::Zero();
7071 
7072   // Argument types.
7073   for (auto PVDecl : Decl->parameters()) {
7074     QualType PType = PVDecl->getOriginalType();
7075     if (const auto *AT =
7076             dyn_cast<ArrayType>(PType->getCanonicalTypeInternal())) {
7077       // Use array's original type only if it has known number of
7078       // elements.
7079       if (!isa<ConstantArrayType>(AT))
7080         PType = PVDecl->getType();
7081     } else if (PType->isFunctionType())
7082       PType = PVDecl->getType();
7083     getObjCEncodingForType(PType, S);
7084     S += charUnitsToString(ParmOffset);
7085     ParmOffset += getObjCEncodingTypeSize(PType);
7086   }
7087 
7088   return S;
7089 }
7090 
7091 /// getObjCEncodingForMethodParameter - Return the encoded type for a single
7092 /// method parameter or return type. If Extended, include class names and
7093 /// block object types.
7094 void ASTContext::getObjCEncodingForMethodParameter(Decl::ObjCDeclQualifier QT,
7095                                                    QualType T, std::string& S,
7096                                                    bool Extended) const {
7097   // Encode type qualifier, 'in', 'inout', etc. for the parameter.
7098   getObjCEncodingForTypeQualifier(QT, S);
7099   // Encode parameter type.
7100   ObjCEncOptions Options = ObjCEncOptions()
7101                                .setExpandPointedToStructures()
7102                                .setExpandStructures()
7103                                .setIsOutermostType();
7104   if (Extended)
7105     Options.setEncodeBlockParameters().setEncodeClassNames();
7106   getObjCEncodingForTypeImpl(T, S, Options, /*Field=*/nullptr);
7107 }
7108 
7109 /// getObjCEncodingForMethodDecl - Return the encoded type for this method
7110 /// declaration.
7111 std::string ASTContext::getObjCEncodingForMethodDecl(const ObjCMethodDecl *Decl,
7112                                                      bool Extended) const {
7113   // FIXME: This is not very efficient.
7114   // Encode return type.
7115   std::string S;
7116   getObjCEncodingForMethodParameter(Decl->getObjCDeclQualifier(),
7117                                     Decl->getReturnType(), S, Extended);
7118   // Compute size of all parameters.
7119   // Start with computing size of a pointer in number of bytes.
7120   // FIXME: There might(should) be a better way of doing this computation!
7121   CharUnits PtrSize = getTypeSizeInChars(VoidPtrTy);
7122   // The first two arguments (self and _cmd) are pointers; account for
7123   // their size.
7124   CharUnits ParmOffset = 2 * PtrSize;
7125   for (ObjCMethodDecl::param_const_iterator PI = Decl->param_begin(),
7126        E = Decl->sel_param_end(); PI != E; ++PI) {
7127     QualType PType = (*PI)->getType();
7128     CharUnits sz = getObjCEncodingTypeSize(PType);
7129     if (sz.isZero())
7130       continue;
7131 
7132     assert(sz.isPositive() &&
7133            "getObjCEncodingForMethodDecl - Incomplete param type");
7134     ParmOffset += sz;
7135   }
7136   S += charUnitsToString(ParmOffset);
7137   S += "@0:";
7138   S += charUnitsToString(PtrSize);
7139 
7140   // Argument types.
7141   ParmOffset = 2 * PtrSize;
7142   for (ObjCMethodDecl::param_const_iterator PI = Decl->param_begin(),
7143        E = Decl->sel_param_end(); PI != E; ++PI) {
7144     const ParmVarDecl *PVDecl = *PI;
7145     QualType PType = PVDecl->getOriginalType();
7146     if (const auto *AT =
7147             dyn_cast<ArrayType>(PType->getCanonicalTypeInternal())) {
7148       // Use array's original type only if it has known number of
7149       // elements.
7150       if (!isa<ConstantArrayType>(AT))
7151         PType = PVDecl->getType();
7152     } else if (PType->isFunctionType())
7153       PType = PVDecl->getType();
7154     getObjCEncodingForMethodParameter(PVDecl->getObjCDeclQualifier(),
7155                                       PType, S, Extended);
7156     S += charUnitsToString(ParmOffset);
7157     ParmOffset += getObjCEncodingTypeSize(PType);
7158   }
7159 
7160   return S;
7161 }
7162 
7163 ObjCPropertyImplDecl *
7164 ASTContext::getObjCPropertyImplDeclForPropertyDecl(
7165                                       const ObjCPropertyDecl *PD,
7166                                       const Decl *Container) const {
7167   if (!Container)
7168     return nullptr;
7169   if (const auto *CID = dyn_cast<ObjCCategoryImplDecl>(Container)) {
7170     for (auto *PID : CID->property_impls())
7171       if (PID->getPropertyDecl() == PD)
7172         return PID;
7173   } else {
7174     const auto *OID = cast<ObjCImplementationDecl>(Container);
7175     for (auto *PID : OID->property_impls())
7176       if (PID->getPropertyDecl() == PD)
7177         return PID;
7178   }
7179   return nullptr;
7180 }
7181 
7182 /// getObjCEncodingForPropertyDecl - Return the encoded type for this
7183 /// property declaration. If non-NULL, Container must be either an
7184 /// ObjCCategoryImplDecl or ObjCImplementationDecl; it should only be
7185 /// NULL when getting encodings for protocol properties.
7186 /// Property attributes are stored as a comma-delimited C string. The simple
7187 /// attributes readonly and bycopy are encoded as single characters. The
7188 /// parametrized attributes, getter=name, setter=name, and ivar=name, are
7189 /// encoded as single characters, followed by an identifier. Property types
7190 /// are also encoded as a parametrized attribute. The characters used to encode
7191 /// these attributes are defined by the following enumeration:
7192 /// @code
7193 /// enum PropertyAttributes {
7194 /// kPropertyReadOnly = 'R',   // property is read-only.
7195 /// kPropertyBycopy = 'C',     // property is a copy of the value last assigned
7196 /// kPropertyByref = '&',  // property is a reference to the value last assigned
7197 /// kPropertyDynamic = 'D',    // property is dynamic
7198 /// kPropertyGetter = 'G',     // followed by getter selector name
7199 /// kPropertySetter = 'S',     // followed by setter selector name
7200 /// kPropertyInstanceVariable = 'V'  // followed by instance variable  name
7201 /// kPropertyType = 'T'              // followed by old-style type encoding.
7202 /// kPropertyWeak = 'W'              // 'weak' property
7203 /// kPropertyStrong = 'P'            // property GC'able
7204 /// kPropertyNonAtomic = 'N'         // property non-atomic
7205 /// };
7206 /// @endcode
7207 std::string
7208 ASTContext::getObjCEncodingForPropertyDecl(const ObjCPropertyDecl *PD,
7209                                            const Decl *Container) const {
7210   // Collect information from the property implementation decl(s).
7211   bool Dynamic = false;
7212   ObjCPropertyImplDecl *SynthesizePID = nullptr;
7213 
7214   if (ObjCPropertyImplDecl *PropertyImpDecl =
7215       getObjCPropertyImplDeclForPropertyDecl(PD, Container)) {
7216     if (PropertyImpDecl->getPropertyImplementation() == ObjCPropertyImplDecl::Dynamic)
7217       Dynamic = true;
7218     else
7219       SynthesizePID = PropertyImpDecl;
7220   }
7221 
7222   // FIXME: This is not very efficient.
7223   std::string S = "T";
7224 
7225   // Encode result type.
7226   // GCC has some special rules regarding encoding of properties which
7227   // closely resembles encoding of ivars.
7228   getObjCEncodingForPropertyType(PD->getType(), S);
7229 
7230   if (PD->isReadOnly()) {
7231     S += ",R";
7232     if (PD->getPropertyAttributes() & ObjCPropertyAttribute::kind_copy)
7233       S += ",C";
7234     if (PD->getPropertyAttributes() & ObjCPropertyAttribute::kind_retain)
7235       S += ",&";
7236     if (PD->getPropertyAttributes() & ObjCPropertyAttribute::kind_weak)
7237       S += ",W";
7238   } else {
7239     switch (PD->getSetterKind()) {
7240     case ObjCPropertyDecl::Assign: break;
7241     case ObjCPropertyDecl::Copy:   S += ",C"; break;
7242     case ObjCPropertyDecl::Retain: S += ",&"; break;
7243     case ObjCPropertyDecl::Weak:   S += ",W"; break;
7244     }
7245   }
7246 
7247   // It really isn't clear at all what this means, since properties
7248   // are "dynamic by default".
7249   if (Dynamic)
7250     S += ",D";
7251 
7252   if (PD->getPropertyAttributes() & ObjCPropertyAttribute::kind_nonatomic)
7253     S += ",N";
7254 
7255   if (PD->getPropertyAttributes() & ObjCPropertyAttribute::kind_getter) {
7256     S += ",G";
7257     S += PD->getGetterName().getAsString();
7258   }
7259 
7260   if (PD->getPropertyAttributes() & ObjCPropertyAttribute::kind_setter) {
7261     S += ",S";
7262     S += PD->getSetterName().getAsString();
7263   }
7264 
7265   if (SynthesizePID) {
7266     const ObjCIvarDecl *OID = SynthesizePID->getPropertyIvarDecl();
7267     S += ",V";
7268     S += OID->getNameAsString();
7269   }
7270 
7271   // FIXME: OBJCGC: weak & strong
7272   return S;
7273 }
7274 
7275 /// getLegacyIntegralTypeEncoding -
7276 /// Another legacy compatibility encoding: 32-bit longs are encoded as
7277 /// 'l' or 'L' , but not always.  For typedefs, we need to use
7278 /// 'i' or 'I' instead if encoding a struct field, or a pointer!
7279 void ASTContext::getLegacyIntegralTypeEncoding (QualType &PointeeTy) const {
7280   if (isa<TypedefType>(PointeeTy.getTypePtr())) {
7281     if (const auto *BT = PointeeTy->getAs<BuiltinType>()) {
7282       if (BT->getKind() == BuiltinType::ULong && getIntWidth(PointeeTy) == 32)
7283         PointeeTy = UnsignedIntTy;
7284       else
7285         if (BT->getKind() == BuiltinType::Long && getIntWidth(PointeeTy) == 32)
7286           PointeeTy = IntTy;
7287     }
7288   }
7289 }
7290 
7291 void ASTContext::getObjCEncodingForType(QualType T, std::string& S,
7292                                         const FieldDecl *Field,
7293                                         QualType *NotEncodedT) const {
7294   // We follow the behavior of gcc, expanding structures which are
7295   // directly pointed to, and expanding embedded structures. Note that
7296   // these rules are sufficient to prevent recursive encoding of the
7297   // same type.
7298   getObjCEncodingForTypeImpl(T, S,
7299                              ObjCEncOptions()
7300                                  .setExpandPointedToStructures()
7301                                  .setExpandStructures()
7302                                  .setIsOutermostType(),
7303                              Field, NotEncodedT);
7304 }
7305 
7306 void ASTContext::getObjCEncodingForPropertyType(QualType T,
7307                                                 std::string& S) const {
7308   // Encode result type.
7309   // GCC has some special rules regarding encoding of properties which
7310   // closely resembles encoding of ivars.
7311   getObjCEncodingForTypeImpl(T, S,
7312                              ObjCEncOptions()
7313                                  .setExpandPointedToStructures()
7314                                  .setExpandStructures()
7315                                  .setIsOutermostType()
7316                                  .setEncodingProperty(),
7317                              /*Field=*/nullptr);
7318 }
7319 
7320 static char getObjCEncodingForPrimitiveType(const ASTContext *C,
7321                                             const BuiltinType *BT) {
7322     BuiltinType::Kind kind = BT->getKind();
7323     switch (kind) {
7324     case BuiltinType::Void:       return 'v';
7325     case BuiltinType::Bool:       return 'B';
7326     case BuiltinType::Char8:
7327     case BuiltinType::Char_U:
7328     case BuiltinType::UChar:      return 'C';
7329     case BuiltinType::Char16:
7330     case BuiltinType::UShort:     return 'S';
7331     case BuiltinType::Char32:
7332     case BuiltinType::UInt:       return 'I';
7333     case BuiltinType::ULong:
7334         return C->getTargetInfo().getLongWidth() == 32 ? 'L' : 'Q';
7335     case BuiltinType::UInt128:    return 'T';
7336     case BuiltinType::ULongLong:  return 'Q';
7337     case BuiltinType::Char_S:
7338     case BuiltinType::SChar:      return 'c';
7339     case BuiltinType::Short:      return 's';
7340     case BuiltinType::WChar_S:
7341     case BuiltinType::WChar_U:
7342     case BuiltinType::Int:        return 'i';
7343     case BuiltinType::Long:
7344       return C->getTargetInfo().getLongWidth() == 32 ? 'l' : 'q';
7345     case BuiltinType::LongLong:   return 'q';
7346     case BuiltinType::Int128:     return 't';
7347     case BuiltinType::Float:      return 'f';
7348     case BuiltinType::Double:     return 'd';
7349     case BuiltinType::LongDouble: return 'D';
7350     case BuiltinType::NullPtr:    return '*'; // like char*
7351 
7352     case BuiltinType::BFloat16:
7353     case BuiltinType::Float16:
7354     case BuiltinType::Float128:
7355     case BuiltinType::Ibm128:
7356     case BuiltinType::Half:
7357     case BuiltinType::ShortAccum:
7358     case BuiltinType::Accum:
7359     case BuiltinType::LongAccum:
7360     case BuiltinType::UShortAccum:
7361     case BuiltinType::UAccum:
7362     case BuiltinType::ULongAccum:
7363     case BuiltinType::ShortFract:
7364     case BuiltinType::Fract:
7365     case BuiltinType::LongFract:
7366     case BuiltinType::UShortFract:
7367     case BuiltinType::UFract:
7368     case BuiltinType::ULongFract:
7369     case BuiltinType::SatShortAccum:
7370     case BuiltinType::SatAccum:
7371     case BuiltinType::SatLongAccum:
7372     case BuiltinType::SatUShortAccum:
7373     case BuiltinType::SatUAccum:
7374     case BuiltinType::SatULongAccum:
7375     case BuiltinType::SatShortFract:
7376     case BuiltinType::SatFract:
7377     case BuiltinType::SatLongFract:
7378     case BuiltinType::SatUShortFract:
7379     case BuiltinType::SatUFract:
7380     case BuiltinType::SatULongFract:
7381       // FIXME: potentially need @encodes for these!
7382       return ' ';
7383 
7384 #define SVE_TYPE(Name, Id, SingletonId) \
7385     case BuiltinType::Id:
7386 #include "clang/Basic/AArch64SVEACLETypes.def"
7387 #define RVV_TYPE(Name, Id, SingletonId) case BuiltinType::Id:
7388 #include "clang/Basic/RISCVVTypes.def"
7389       {
7390         DiagnosticsEngine &Diags = C->getDiagnostics();
7391         unsigned DiagID = Diags.getCustomDiagID(DiagnosticsEngine::Error,
7392                                                 "cannot yet @encode type %0");
7393         Diags.Report(DiagID) << BT->getName(C->getPrintingPolicy());
7394         return ' ';
7395       }
7396 
7397     case BuiltinType::ObjCId:
7398     case BuiltinType::ObjCClass:
7399     case BuiltinType::ObjCSel:
7400       llvm_unreachable("@encoding ObjC primitive type");
7401 
7402     // OpenCL and placeholder types don't need @encodings.
7403 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
7404     case BuiltinType::Id:
7405 #include "clang/Basic/OpenCLImageTypes.def"
7406 #define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
7407     case BuiltinType::Id:
7408 #include "clang/Basic/OpenCLExtensionTypes.def"
7409     case BuiltinType::OCLEvent:
7410     case BuiltinType::OCLClkEvent:
7411     case BuiltinType::OCLQueue:
7412     case BuiltinType::OCLReserveID:
7413     case BuiltinType::OCLSampler:
7414     case BuiltinType::Dependent:
7415 #define PPC_VECTOR_TYPE(Name, Id, Size) \
7416     case BuiltinType::Id:
7417 #include "clang/Basic/PPCTypes.def"
7418 #define BUILTIN_TYPE(KIND, ID)
7419 #define PLACEHOLDER_TYPE(KIND, ID) \
7420     case BuiltinType::KIND:
7421 #include "clang/AST/BuiltinTypes.def"
7422       llvm_unreachable("invalid builtin type for @encode");
7423     }
7424     llvm_unreachable("invalid BuiltinType::Kind value");
7425 }
7426 
7427 static char ObjCEncodingForEnumType(const ASTContext *C, const EnumType *ET) {
7428   EnumDecl *Enum = ET->getDecl();
7429 
7430   // The encoding of an non-fixed enum type is always 'i', regardless of size.
7431   if (!Enum->isFixed())
7432     return 'i';
7433 
7434   // The encoding of a fixed enum type matches its fixed underlying type.
7435   const auto *BT = Enum->getIntegerType()->castAs<BuiltinType>();
7436   return getObjCEncodingForPrimitiveType(C, BT);
7437 }
7438 
7439 static void EncodeBitField(const ASTContext *Ctx, std::string& S,
7440                            QualType T, const FieldDecl *FD) {
7441   assert(FD->isBitField() && "not a bitfield - getObjCEncodingForTypeImpl");
7442   S += 'b';
7443   // The NeXT runtime encodes bit fields as b followed by the number of bits.
7444   // The GNU runtime requires more information; bitfields are encoded as b,
7445   // then the offset (in bits) of the first element, then the type of the
7446   // bitfield, then the size in bits.  For example, in this structure:
7447   //
7448   // struct
7449   // {
7450   //    int integer;
7451   //    int flags:2;
7452   // };
7453   // On a 32-bit system, the encoding for flags would be b2 for the NeXT
7454   // runtime, but b32i2 for the GNU runtime.  The reason for this extra
7455   // information is not especially sensible, but we're stuck with it for
7456   // compatibility with GCC, although providing it breaks anything that
7457   // actually uses runtime introspection and wants to work on both runtimes...
7458   if (Ctx->getLangOpts().ObjCRuntime.isGNUFamily()) {
7459     uint64_t Offset;
7460 
7461     if (const auto *IVD = dyn_cast<ObjCIvarDecl>(FD)) {
7462       Offset = Ctx->lookupFieldBitOffset(IVD->getContainingInterface(), nullptr,
7463                                          IVD);
7464     } else {
7465       const RecordDecl *RD = FD->getParent();
7466       const ASTRecordLayout &RL = Ctx->getASTRecordLayout(RD);
7467       Offset = RL.getFieldOffset(FD->getFieldIndex());
7468     }
7469 
7470     S += llvm::utostr(Offset);
7471 
7472     if (const auto *ET = T->getAs<EnumType>())
7473       S += ObjCEncodingForEnumType(Ctx, ET);
7474     else {
7475       const auto *BT = T->castAs<BuiltinType>();
7476       S += getObjCEncodingForPrimitiveType(Ctx, BT);
7477     }
7478   }
7479   S += llvm::utostr(FD->getBitWidthValue(*Ctx));
7480 }
7481 
7482 // Helper function for determining whether the encoded type string would include
7483 // a template specialization type.
7484 static bool hasTemplateSpecializationInEncodedString(const Type *T,
7485                                                      bool VisitBasesAndFields) {
7486   T = T->getBaseElementTypeUnsafe();
7487 
7488   if (auto *PT = T->getAs<PointerType>())
7489     return hasTemplateSpecializationInEncodedString(
7490         PT->getPointeeType().getTypePtr(), false);
7491 
7492   auto *CXXRD = T->getAsCXXRecordDecl();
7493 
7494   if (!CXXRD)
7495     return false;
7496 
7497   if (isa<ClassTemplateSpecializationDecl>(CXXRD))
7498     return true;
7499 
7500   if (!CXXRD->hasDefinition() || !VisitBasesAndFields)
7501     return false;
7502 
7503   for (auto B : CXXRD->bases())
7504     if (hasTemplateSpecializationInEncodedString(B.getType().getTypePtr(),
7505                                                  true))
7506       return true;
7507 
7508   for (auto *FD : CXXRD->fields())
7509     if (hasTemplateSpecializationInEncodedString(FD->getType().getTypePtr(),
7510                                                  true))
7511       return true;
7512 
7513   return false;
7514 }
7515 
7516 // FIXME: Use SmallString for accumulating string.
7517 void ASTContext::getObjCEncodingForTypeImpl(QualType T, std::string &S,
7518                                             const ObjCEncOptions Options,
7519                                             const FieldDecl *FD,
7520                                             QualType *NotEncodedT) const {
7521   CanQualType CT = getCanonicalType(T);
7522   switch (CT->getTypeClass()) {
7523   case Type::Builtin:
7524   case Type::Enum:
7525     if (FD && FD->isBitField())
7526       return EncodeBitField(this, S, T, FD);
7527     if (const auto *BT = dyn_cast<BuiltinType>(CT))
7528       S += getObjCEncodingForPrimitiveType(this, BT);
7529     else
7530       S += ObjCEncodingForEnumType(this, cast<EnumType>(CT));
7531     return;
7532 
7533   case Type::Complex:
7534     S += 'j';
7535     getObjCEncodingForTypeImpl(T->castAs<ComplexType>()->getElementType(), S,
7536                                ObjCEncOptions(),
7537                                /*Field=*/nullptr);
7538     return;
7539 
7540   case Type::Atomic:
7541     S += 'A';
7542     getObjCEncodingForTypeImpl(T->castAs<AtomicType>()->getValueType(), S,
7543                                ObjCEncOptions(),
7544                                /*Field=*/nullptr);
7545     return;
7546 
7547   // encoding for pointer or reference types.
7548   case Type::Pointer:
7549   case Type::LValueReference:
7550   case Type::RValueReference: {
7551     QualType PointeeTy;
7552     if (isa<PointerType>(CT)) {
7553       const auto *PT = T->castAs<PointerType>();
7554       if (PT->isObjCSelType()) {
7555         S += ':';
7556         return;
7557       }
7558       PointeeTy = PT->getPointeeType();
7559     } else {
7560       PointeeTy = T->castAs<ReferenceType>()->getPointeeType();
7561     }
7562 
7563     bool isReadOnly = false;
7564     // For historical/compatibility reasons, the read-only qualifier of the
7565     // pointee gets emitted _before_ the '^'.  The read-only qualifier of
7566     // the pointer itself gets ignored, _unless_ we are looking at a typedef!
7567     // Also, do not emit the 'r' for anything but the outermost type!
7568     if (isa<TypedefType>(T.getTypePtr())) {
7569       if (Options.IsOutermostType() && T.isConstQualified()) {
7570         isReadOnly = true;
7571         S += 'r';
7572       }
7573     } else if (Options.IsOutermostType()) {
7574       QualType P = PointeeTy;
7575       while (auto PT = P->getAs<PointerType>())
7576         P = PT->getPointeeType();
7577       if (P.isConstQualified()) {
7578         isReadOnly = true;
7579         S += 'r';
7580       }
7581     }
7582     if (isReadOnly) {
7583       // Another legacy compatibility encoding. Some ObjC qualifier and type
7584       // combinations need to be rearranged.
7585       // Rewrite "in const" from "nr" to "rn"
7586       if (StringRef(S).endswith("nr"))
7587         S.replace(S.end()-2, S.end(), "rn");
7588     }
7589 
7590     if (PointeeTy->isCharType()) {
7591       // char pointer types should be encoded as '*' unless it is a
7592       // type that has been typedef'd to 'BOOL'.
7593       if (!isTypeTypedefedAsBOOL(PointeeTy)) {
7594         S += '*';
7595         return;
7596       }
7597     } else if (const auto *RTy = PointeeTy->getAs<RecordType>()) {
7598       // GCC binary compat: Need to convert "struct objc_class *" to "#".
7599       if (RTy->getDecl()->getIdentifier() == &Idents.get("objc_class")) {
7600         S += '#';
7601         return;
7602       }
7603       // GCC binary compat: Need to convert "struct objc_object *" to "@".
7604       if (RTy->getDecl()->getIdentifier() == &Idents.get("objc_object")) {
7605         S += '@';
7606         return;
7607       }
7608       // If the encoded string for the class includes template names, just emit
7609       // "^v" for pointers to the class.
7610       if (getLangOpts().CPlusPlus &&
7611           (!getLangOpts().EncodeCXXClassTemplateSpec &&
7612            hasTemplateSpecializationInEncodedString(
7613                RTy, Options.ExpandPointedToStructures()))) {
7614         S += "^v";
7615         return;
7616       }
7617       // fall through...
7618     }
7619     S += '^';
7620     getLegacyIntegralTypeEncoding(PointeeTy);
7621 
7622     ObjCEncOptions NewOptions;
7623     if (Options.ExpandPointedToStructures())
7624       NewOptions.setExpandStructures();
7625     getObjCEncodingForTypeImpl(PointeeTy, S, NewOptions,
7626                                /*Field=*/nullptr, NotEncodedT);
7627     return;
7628   }
7629 
7630   case Type::ConstantArray:
7631   case Type::IncompleteArray:
7632   case Type::VariableArray: {
7633     const auto *AT = cast<ArrayType>(CT);
7634 
7635     if (isa<IncompleteArrayType>(AT) && !Options.IsStructField()) {
7636       // Incomplete arrays are encoded as a pointer to the array element.
7637       S += '^';
7638 
7639       getObjCEncodingForTypeImpl(
7640           AT->getElementType(), S,
7641           Options.keepingOnly(ObjCEncOptions().setExpandStructures()), FD);
7642     } else {
7643       S += '[';
7644 
7645       if (const auto *CAT = dyn_cast<ConstantArrayType>(AT))
7646         S += llvm::utostr(CAT->getSize().getZExtValue());
7647       else {
7648         //Variable length arrays are encoded as a regular array with 0 elements.
7649         assert((isa<VariableArrayType>(AT) || isa<IncompleteArrayType>(AT)) &&
7650                "Unknown array type!");
7651         S += '0';
7652       }
7653 
7654       getObjCEncodingForTypeImpl(
7655           AT->getElementType(), S,
7656           Options.keepingOnly(ObjCEncOptions().setExpandStructures()), FD,
7657           NotEncodedT);
7658       S += ']';
7659     }
7660     return;
7661   }
7662 
7663   case Type::FunctionNoProto:
7664   case Type::FunctionProto:
7665     S += '?';
7666     return;
7667 
7668   case Type::Record: {
7669     RecordDecl *RDecl = cast<RecordType>(CT)->getDecl();
7670     S += RDecl->isUnion() ? '(' : '{';
7671     // Anonymous structures print as '?'
7672     if (const IdentifierInfo *II = RDecl->getIdentifier()) {
7673       S += II->getName();
7674       if (const auto *Spec = dyn_cast<ClassTemplateSpecializationDecl>(RDecl)) {
7675         const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
7676         llvm::raw_string_ostream OS(S);
7677         printTemplateArgumentList(OS, TemplateArgs.asArray(),
7678                                   getPrintingPolicy());
7679       }
7680     } else {
7681       S += '?';
7682     }
7683     if (Options.ExpandStructures()) {
7684       S += '=';
7685       if (!RDecl->isUnion()) {
7686         getObjCEncodingForStructureImpl(RDecl, S, FD, true, NotEncodedT);
7687       } else {
7688         for (const auto *Field : RDecl->fields()) {
7689           if (FD) {
7690             S += '"';
7691             S += Field->getNameAsString();
7692             S += '"';
7693           }
7694 
7695           // Special case bit-fields.
7696           if (Field->isBitField()) {
7697             getObjCEncodingForTypeImpl(Field->getType(), S,
7698                                        ObjCEncOptions().setExpandStructures(),
7699                                        Field);
7700           } else {
7701             QualType qt = Field->getType();
7702             getLegacyIntegralTypeEncoding(qt);
7703             getObjCEncodingForTypeImpl(
7704                 qt, S,
7705                 ObjCEncOptions().setExpandStructures().setIsStructField(), FD,
7706                 NotEncodedT);
7707           }
7708         }
7709       }
7710     }
7711     S += RDecl->isUnion() ? ')' : '}';
7712     return;
7713   }
7714 
7715   case Type::BlockPointer: {
7716     const auto *BT = T->castAs<BlockPointerType>();
7717     S += "@?"; // Unlike a pointer-to-function, which is "^?".
7718     if (Options.EncodeBlockParameters()) {
7719       const auto *FT = BT->getPointeeType()->castAs<FunctionType>();
7720 
7721       S += '<';
7722       // Block return type
7723       getObjCEncodingForTypeImpl(FT->getReturnType(), S,
7724                                  Options.forComponentType(), FD, NotEncodedT);
7725       // Block self
7726       S += "@?";
7727       // Block parameters
7728       if (const auto *FPT = dyn_cast<FunctionProtoType>(FT)) {
7729         for (const auto &I : FPT->param_types())
7730           getObjCEncodingForTypeImpl(I, S, Options.forComponentType(), FD,
7731                                      NotEncodedT);
7732       }
7733       S += '>';
7734     }
7735     return;
7736   }
7737 
7738   case Type::ObjCObject: {
7739     // hack to match legacy encoding of *id and *Class
7740     QualType Ty = getObjCObjectPointerType(CT);
7741     if (Ty->isObjCIdType()) {
7742       S += "{objc_object=}";
7743       return;
7744     }
7745     else if (Ty->isObjCClassType()) {
7746       S += "{objc_class=}";
7747       return;
7748     }
7749     // TODO: Double check to make sure this intentionally falls through.
7750     LLVM_FALLTHROUGH;
7751   }
7752 
7753   case Type::ObjCInterface: {
7754     // Ignore protocol qualifiers when mangling at this level.
7755     // @encode(class_name)
7756     ObjCInterfaceDecl *OI = T->castAs<ObjCObjectType>()->getInterface();
7757     S += '{';
7758     S += OI->getObjCRuntimeNameAsString();
7759     if (Options.ExpandStructures()) {
7760       S += '=';
7761       SmallVector<const ObjCIvarDecl*, 32> Ivars;
7762       DeepCollectObjCIvars(OI, true, Ivars);
7763       for (unsigned i = 0, e = Ivars.size(); i != e; ++i) {
7764         const FieldDecl *Field = Ivars[i];
7765         if (Field->isBitField())
7766           getObjCEncodingForTypeImpl(Field->getType(), S,
7767                                      ObjCEncOptions().setExpandStructures(),
7768                                      Field);
7769         else
7770           getObjCEncodingForTypeImpl(Field->getType(), S,
7771                                      ObjCEncOptions().setExpandStructures(), FD,
7772                                      NotEncodedT);
7773       }
7774     }
7775     S += '}';
7776     return;
7777   }
7778 
7779   case Type::ObjCObjectPointer: {
7780     const auto *OPT = T->castAs<ObjCObjectPointerType>();
7781     if (OPT->isObjCIdType()) {
7782       S += '@';
7783       return;
7784     }
7785 
7786     if (OPT->isObjCClassType() || OPT->isObjCQualifiedClassType()) {
7787       // FIXME: Consider if we need to output qualifiers for 'Class<p>'.
7788       // Since this is a binary compatibility issue, need to consult with
7789       // runtime folks. Fortunately, this is a *very* obscure construct.
7790       S += '#';
7791       return;
7792     }
7793 
7794     if (OPT->isObjCQualifiedIdType()) {
7795       getObjCEncodingForTypeImpl(
7796           getObjCIdType(), S,
7797           Options.keepingOnly(ObjCEncOptions()
7798                                   .setExpandPointedToStructures()
7799                                   .setExpandStructures()),
7800           FD);
7801       if (FD || Options.EncodingProperty() || Options.EncodeClassNames()) {
7802         // Note that we do extended encoding of protocol qualifier list
7803         // Only when doing ivar or property encoding.
7804         S += '"';
7805         for (const auto *I : OPT->quals()) {
7806           S += '<';
7807           S += I->getObjCRuntimeNameAsString();
7808           S += '>';
7809         }
7810         S += '"';
7811       }
7812       return;
7813     }
7814 
7815     S += '@';
7816     if (OPT->getInterfaceDecl() &&
7817         (FD || Options.EncodingProperty() || Options.EncodeClassNames())) {
7818       S += '"';
7819       S += OPT->getInterfaceDecl()->getObjCRuntimeNameAsString();
7820       for (const auto *I : OPT->quals()) {
7821         S += '<';
7822         S += I->getObjCRuntimeNameAsString();
7823         S += '>';
7824       }
7825       S += '"';
7826     }
7827     return;
7828   }
7829 
7830   // gcc just blithely ignores member pointers.
7831   // FIXME: we should do better than that.  'M' is available.
7832   case Type::MemberPointer:
7833   // This matches gcc's encoding, even though technically it is insufficient.
7834   //FIXME. We should do a better job than gcc.
7835   case Type::Vector:
7836   case Type::ExtVector:
7837   // Until we have a coherent encoding of these three types, issue warning.
7838     if (NotEncodedT)
7839       *NotEncodedT = T;
7840     return;
7841 
7842   case Type::ConstantMatrix:
7843     if (NotEncodedT)
7844       *NotEncodedT = T;
7845     return;
7846 
7847   // We could see an undeduced auto type here during error recovery.
7848   // Just ignore it.
7849   case Type::Auto:
7850   case Type::DeducedTemplateSpecialization:
7851     return;
7852 
7853   case Type::Pipe:
7854   case Type::ExtInt:
7855 #define ABSTRACT_TYPE(KIND, BASE)
7856 #define TYPE(KIND, BASE)
7857 #define DEPENDENT_TYPE(KIND, BASE) \
7858   case Type::KIND:
7859 #define NON_CANONICAL_TYPE(KIND, BASE) \
7860   case Type::KIND:
7861 #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(KIND, BASE) \
7862   case Type::KIND:
7863 #include "clang/AST/TypeNodes.inc"
7864     llvm_unreachable("@encode for dependent type!");
7865   }
7866   llvm_unreachable("bad type kind!");
7867 }
7868 
7869 void ASTContext::getObjCEncodingForStructureImpl(RecordDecl *RDecl,
7870                                                  std::string &S,
7871                                                  const FieldDecl *FD,
7872                                                  bool includeVBases,
7873                                                  QualType *NotEncodedT) const {
7874   assert(RDecl && "Expected non-null RecordDecl");
7875   assert(!RDecl->isUnion() && "Should not be called for unions");
7876   if (!RDecl->getDefinition() || RDecl->getDefinition()->isInvalidDecl())
7877     return;
7878 
7879   const auto *CXXRec = dyn_cast<CXXRecordDecl>(RDecl);
7880   std::multimap<uint64_t, NamedDecl *> FieldOrBaseOffsets;
7881   const ASTRecordLayout &layout = getASTRecordLayout(RDecl);
7882 
7883   if (CXXRec) {
7884     for (const auto &BI : CXXRec->bases()) {
7885       if (!BI.isVirtual()) {
7886         CXXRecordDecl *base = BI.getType()->getAsCXXRecordDecl();
7887         if (base->isEmpty())
7888           continue;
7889         uint64_t offs = toBits(layout.getBaseClassOffset(base));
7890         FieldOrBaseOffsets.insert(FieldOrBaseOffsets.upper_bound(offs),
7891                                   std::make_pair(offs, base));
7892       }
7893     }
7894   }
7895 
7896   unsigned i = 0;
7897   for (FieldDecl *Field : RDecl->fields()) {
7898     if (!Field->isZeroLengthBitField(*this) && Field->isZeroSize(*this))
7899       continue;
7900     uint64_t offs = layout.getFieldOffset(i);
7901     FieldOrBaseOffsets.insert(FieldOrBaseOffsets.upper_bound(offs),
7902                               std::make_pair(offs, Field));
7903     ++i;
7904   }
7905 
7906   if (CXXRec && includeVBases) {
7907     for (const auto &BI : CXXRec->vbases()) {
7908       CXXRecordDecl *base = BI.getType()->getAsCXXRecordDecl();
7909       if (base->isEmpty())
7910         continue;
7911       uint64_t offs = toBits(layout.getVBaseClassOffset(base));
7912       if (offs >= uint64_t(toBits(layout.getNonVirtualSize())) &&
7913           FieldOrBaseOffsets.find(offs) == FieldOrBaseOffsets.end())
7914         FieldOrBaseOffsets.insert(FieldOrBaseOffsets.end(),
7915                                   std::make_pair(offs, base));
7916     }
7917   }
7918 
7919   CharUnits size;
7920   if (CXXRec) {
7921     size = includeVBases ? layout.getSize() : layout.getNonVirtualSize();
7922   } else {
7923     size = layout.getSize();
7924   }
7925 
7926 #ifndef NDEBUG
7927   uint64_t CurOffs = 0;
7928 #endif
7929   std::multimap<uint64_t, NamedDecl *>::iterator
7930     CurLayObj = FieldOrBaseOffsets.begin();
7931 
7932   if (CXXRec && CXXRec->isDynamicClass() &&
7933       (CurLayObj == FieldOrBaseOffsets.end() || CurLayObj->first != 0)) {
7934     if (FD) {
7935       S += "\"_vptr$";
7936       std::string recname = CXXRec->getNameAsString();
7937       if (recname.empty()) recname = "?";
7938       S += recname;
7939       S += '"';
7940     }
7941     S += "^^?";
7942 #ifndef NDEBUG
7943     CurOffs += getTypeSize(VoidPtrTy);
7944 #endif
7945   }
7946 
7947   if (!RDecl->hasFlexibleArrayMember()) {
7948     // Mark the end of the structure.
7949     uint64_t offs = toBits(size);
7950     FieldOrBaseOffsets.insert(FieldOrBaseOffsets.upper_bound(offs),
7951                               std::make_pair(offs, nullptr));
7952   }
7953 
7954   for (; CurLayObj != FieldOrBaseOffsets.end(); ++CurLayObj) {
7955 #ifndef NDEBUG
7956     assert(CurOffs <= CurLayObj->first);
7957     if (CurOffs < CurLayObj->first) {
7958       uint64_t padding = CurLayObj->first - CurOffs;
7959       // FIXME: There doesn't seem to be a way to indicate in the encoding that
7960       // packing/alignment of members is different that normal, in which case
7961       // the encoding will be out-of-sync with the real layout.
7962       // If the runtime switches to just consider the size of types without
7963       // taking into account alignment, we could make padding explicit in the
7964       // encoding (e.g. using arrays of chars). The encoding strings would be
7965       // longer then though.
7966       CurOffs += padding;
7967     }
7968 #endif
7969 
7970     NamedDecl *dcl = CurLayObj->second;
7971     if (!dcl)
7972       break; // reached end of structure.
7973 
7974     if (auto *base = dyn_cast<CXXRecordDecl>(dcl)) {
7975       // We expand the bases without their virtual bases since those are going
7976       // in the initial structure. Note that this differs from gcc which
7977       // expands virtual bases each time one is encountered in the hierarchy,
7978       // making the encoding type bigger than it really is.
7979       getObjCEncodingForStructureImpl(base, S, FD, /*includeVBases*/false,
7980                                       NotEncodedT);
7981       assert(!base->isEmpty());
7982 #ifndef NDEBUG
7983       CurOffs += toBits(getASTRecordLayout(base).getNonVirtualSize());
7984 #endif
7985     } else {
7986       const auto *field = cast<FieldDecl>(dcl);
7987       if (FD) {
7988         S += '"';
7989         S += field->getNameAsString();
7990         S += '"';
7991       }
7992 
7993       if (field->isBitField()) {
7994         EncodeBitField(this, S, field->getType(), field);
7995 #ifndef NDEBUG
7996         CurOffs += field->getBitWidthValue(*this);
7997 #endif
7998       } else {
7999         QualType qt = field->getType();
8000         getLegacyIntegralTypeEncoding(qt);
8001         getObjCEncodingForTypeImpl(
8002             qt, S, ObjCEncOptions().setExpandStructures().setIsStructField(),
8003             FD, NotEncodedT);
8004 #ifndef NDEBUG
8005         CurOffs += getTypeSize(field->getType());
8006 #endif
8007       }
8008     }
8009   }
8010 }
8011 
8012 void ASTContext::getObjCEncodingForTypeQualifier(Decl::ObjCDeclQualifier QT,
8013                                                  std::string& S) const {
8014   if (QT & Decl::OBJC_TQ_In)
8015     S += 'n';
8016   if (QT & Decl::OBJC_TQ_Inout)
8017     S += 'N';
8018   if (QT & Decl::OBJC_TQ_Out)
8019     S += 'o';
8020   if (QT & Decl::OBJC_TQ_Bycopy)
8021     S += 'O';
8022   if (QT & Decl::OBJC_TQ_Byref)
8023     S += 'R';
8024   if (QT & Decl::OBJC_TQ_Oneway)
8025     S += 'V';
8026 }
8027 
8028 TypedefDecl *ASTContext::getObjCIdDecl() const {
8029   if (!ObjCIdDecl) {
8030     QualType T = getObjCObjectType(ObjCBuiltinIdTy, {}, {});
8031     T = getObjCObjectPointerType(T);
8032     ObjCIdDecl = buildImplicitTypedef(T, "id");
8033   }
8034   return ObjCIdDecl;
8035 }
8036 
8037 TypedefDecl *ASTContext::getObjCSelDecl() const {
8038   if (!ObjCSelDecl) {
8039     QualType T = getPointerType(ObjCBuiltinSelTy);
8040     ObjCSelDecl = buildImplicitTypedef(T, "SEL");
8041   }
8042   return ObjCSelDecl;
8043 }
8044 
8045 TypedefDecl *ASTContext::getObjCClassDecl() const {
8046   if (!ObjCClassDecl) {
8047     QualType T = getObjCObjectType(ObjCBuiltinClassTy, {}, {});
8048     T = getObjCObjectPointerType(T);
8049     ObjCClassDecl = buildImplicitTypedef(T, "Class");
8050   }
8051   return ObjCClassDecl;
8052 }
8053 
8054 ObjCInterfaceDecl *ASTContext::getObjCProtocolDecl() const {
8055   if (!ObjCProtocolClassDecl) {
8056     ObjCProtocolClassDecl
8057       = ObjCInterfaceDecl::Create(*this, getTranslationUnitDecl(),
8058                                   SourceLocation(),
8059                                   &Idents.get("Protocol"),
8060                                   /*typeParamList=*/nullptr,
8061                                   /*PrevDecl=*/nullptr,
8062                                   SourceLocation(), true);
8063   }
8064 
8065   return ObjCProtocolClassDecl;
8066 }
8067 
8068 //===----------------------------------------------------------------------===//
8069 // __builtin_va_list Construction Functions
8070 //===----------------------------------------------------------------------===//
8071 
8072 static TypedefDecl *CreateCharPtrNamedVaListDecl(const ASTContext *Context,
8073                                                  StringRef Name) {
8074   // typedef char* __builtin[_ms]_va_list;
8075   QualType T = Context->getPointerType(Context->CharTy);
8076   return Context->buildImplicitTypedef(T, Name);
8077 }
8078 
8079 static TypedefDecl *CreateMSVaListDecl(const ASTContext *Context) {
8080   return CreateCharPtrNamedVaListDecl(Context, "__builtin_ms_va_list");
8081 }
8082 
8083 static TypedefDecl *CreateCharPtrBuiltinVaListDecl(const ASTContext *Context) {
8084   return CreateCharPtrNamedVaListDecl(Context, "__builtin_va_list");
8085 }
8086 
8087 static TypedefDecl *CreateVoidPtrBuiltinVaListDecl(const ASTContext *Context) {
8088   // typedef void* __builtin_va_list;
8089   QualType T = Context->getPointerType(Context->VoidTy);
8090   return Context->buildImplicitTypedef(T, "__builtin_va_list");
8091 }
8092 
8093 static TypedefDecl *
8094 CreateAArch64ABIBuiltinVaListDecl(const ASTContext *Context) {
8095   RecordDecl *VaListTagDecl = Context->buildImplicitRecord("__va_list");
8096   // namespace std { struct __va_list {
8097   // Note that we create the namespace even in C. This is intentional so that
8098   // the type is consistent between C and C++, which is important in cases where
8099   // the types need to match between translation units (e.g. with
8100   // -fsanitize=cfi-icall). Ideally we wouldn't have created this namespace at
8101   // all, but it's now part of the ABI (e.g. in mangled names), so we can't
8102   // change it.
8103   auto *NS = NamespaceDecl::Create(
8104       const_cast<ASTContext &>(*Context), Context->getTranslationUnitDecl(),
8105       /*Inline*/ false, SourceLocation(), SourceLocation(),
8106       &Context->Idents.get("std"),
8107       /*PrevDecl*/ nullptr);
8108   NS->setImplicit();
8109   VaListTagDecl->setDeclContext(NS);
8110 
8111   VaListTagDecl->startDefinition();
8112 
8113   const size_t NumFields = 5;
8114   QualType FieldTypes[NumFields];
8115   const char *FieldNames[NumFields];
8116 
8117   // void *__stack;
8118   FieldTypes[0] = Context->getPointerType(Context->VoidTy);
8119   FieldNames[0] = "__stack";
8120 
8121   // void *__gr_top;
8122   FieldTypes[1] = Context->getPointerType(Context->VoidTy);
8123   FieldNames[1] = "__gr_top";
8124 
8125   // void *__vr_top;
8126   FieldTypes[2] = Context->getPointerType(Context->VoidTy);
8127   FieldNames[2] = "__vr_top";
8128 
8129   // int __gr_offs;
8130   FieldTypes[3] = Context->IntTy;
8131   FieldNames[3] = "__gr_offs";
8132 
8133   // int __vr_offs;
8134   FieldTypes[4] = Context->IntTy;
8135   FieldNames[4] = "__vr_offs";
8136 
8137   // Create fields
8138   for (unsigned i = 0; i < NumFields; ++i) {
8139     FieldDecl *Field = FieldDecl::Create(const_cast<ASTContext &>(*Context),
8140                                          VaListTagDecl,
8141                                          SourceLocation(),
8142                                          SourceLocation(),
8143                                          &Context->Idents.get(FieldNames[i]),
8144                                          FieldTypes[i], /*TInfo=*/nullptr,
8145                                          /*BitWidth=*/nullptr,
8146                                          /*Mutable=*/false,
8147                                          ICIS_NoInit);
8148     Field->setAccess(AS_public);
8149     VaListTagDecl->addDecl(Field);
8150   }
8151   VaListTagDecl->completeDefinition();
8152   Context->VaListTagDecl = VaListTagDecl;
8153   QualType VaListTagType = Context->getRecordType(VaListTagDecl);
8154 
8155   // } __builtin_va_list;
8156   return Context->buildImplicitTypedef(VaListTagType, "__builtin_va_list");
8157 }
8158 
8159 static TypedefDecl *CreatePowerABIBuiltinVaListDecl(const ASTContext *Context) {
8160   // typedef struct __va_list_tag {
8161   RecordDecl *VaListTagDecl;
8162 
8163   VaListTagDecl = Context->buildImplicitRecord("__va_list_tag");
8164   VaListTagDecl->startDefinition();
8165 
8166   const size_t NumFields = 5;
8167   QualType FieldTypes[NumFields];
8168   const char *FieldNames[NumFields];
8169 
8170   //   unsigned char gpr;
8171   FieldTypes[0] = Context->UnsignedCharTy;
8172   FieldNames[0] = "gpr";
8173 
8174   //   unsigned char fpr;
8175   FieldTypes[1] = Context->UnsignedCharTy;
8176   FieldNames[1] = "fpr";
8177 
8178   //   unsigned short reserved;
8179   FieldTypes[2] = Context->UnsignedShortTy;
8180   FieldNames[2] = "reserved";
8181 
8182   //   void* overflow_arg_area;
8183   FieldTypes[3] = Context->getPointerType(Context->VoidTy);
8184   FieldNames[3] = "overflow_arg_area";
8185 
8186   //   void* reg_save_area;
8187   FieldTypes[4] = Context->getPointerType(Context->VoidTy);
8188   FieldNames[4] = "reg_save_area";
8189 
8190   // Create fields
8191   for (unsigned i = 0; i < NumFields; ++i) {
8192     FieldDecl *Field = FieldDecl::Create(*Context, VaListTagDecl,
8193                                          SourceLocation(),
8194                                          SourceLocation(),
8195                                          &Context->Idents.get(FieldNames[i]),
8196                                          FieldTypes[i], /*TInfo=*/nullptr,
8197                                          /*BitWidth=*/nullptr,
8198                                          /*Mutable=*/false,
8199                                          ICIS_NoInit);
8200     Field->setAccess(AS_public);
8201     VaListTagDecl->addDecl(Field);
8202   }
8203   VaListTagDecl->completeDefinition();
8204   Context->VaListTagDecl = VaListTagDecl;
8205   QualType VaListTagType = Context->getRecordType(VaListTagDecl);
8206 
8207   // } __va_list_tag;
8208   TypedefDecl *VaListTagTypedefDecl =
8209       Context->buildImplicitTypedef(VaListTagType, "__va_list_tag");
8210 
8211   QualType VaListTagTypedefType =
8212     Context->getTypedefType(VaListTagTypedefDecl);
8213 
8214   // typedef __va_list_tag __builtin_va_list[1];
8215   llvm::APInt Size(Context->getTypeSize(Context->getSizeType()), 1);
8216   QualType VaListTagArrayType
8217     = Context->getConstantArrayType(VaListTagTypedefType,
8218                                     Size, nullptr, ArrayType::Normal, 0);
8219   return Context->buildImplicitTypedef(VaListTagArrayType, "__builtin_va_list");
8220 }
8221 
8222 static TypedefDecl *
8223 CreateX86_64ABIBuiltinVaListDecl(const ASTContext *Context) {
8224   // struct __va_list_tag {
8225   RecordDecl *VaListTagDecl;
8226   VaListTagDecl = Context->buildImplicitRecord("__va_list_tag");
8227   VaListTagDecl->startDefinition();
8228 
8229   const size_t NumFields = 4;
8230   QualType FieldTypes[NumFields];
8231   const char *FieldNames[NumFields];
8232 
8233   //   unsigned gp_offset;
8234   FieldTypes[0] = Context->UnsignedIntTy;
8235   FieldNames[0] = "gp_offset";
8236 
8237   //   unsigned fp_offset;
8238   FieldTypes[1] = Context->UnsignedIntTy;
8239   FieldNames[1] = "fp_offset";
8240 
8241   //   void* overflow_arg_area;
8242   FieldTypes[2] = Context->getPointerType(Context->VoidTy);
8243   FieldNames[2] = "overflow_arg_area";
8244 
8245   //   void* reg_save_area;
8246   FieldTypes[3] = Context->getPointerType(Context->VoidTy);
8247   FieldNames[3] = "reg_save_area";
8248 
8249   // Create fields
8250   for (unsigned i = 0; i < NumFields; ++i) {
8251     FieldDecl *Field = FieldDecl::Create(const_cast<ASTContext &>(*Context),
8252                                          VaListTagDecl,
8253                                          SourceLocation(),
8254                                          SourceLocation(),
8255                                          &Context->Idents.get(FieldNames[i]),
8256                                          FieldTypes[i], /*TInfo=*/nullptr,
8257                                          /*BitWidth=*/nullptr,
8258                                          /*Mutable=*/false,
8259                                          ICIS_NoInit);
8260     Field->setAccess(AS_public);
8261     VaListTagDecl->addDecl(Field);
8262   }
8263   VaListTagDecl->completeDefinition();
8264   Context->VaListTagDecl = VaListTagDecl;
8265   QualType VaListTagType = Context->getRecordType(VaListTagDecl);
8266 
8267   // };
8268 
8269   // typedef struct __va_list_tag __builtin_va_list[1];
8270   llvm::APInt Size(Context->getTypeSize(Context->getSizeType()), 1);
8271   QualType VaListTagArrayType = Context->getConstantArrayType(
8272       VaListTagType, Size, nullptr, ArrayType::Normal, 0);
8273   return Context->buildImplicitTypedef(VaListTagArrayType, "__builtin_va_list");
8274 }
8275 
8276 static TypedefDecl *CreatePNaClABIBuiltinVaListDecl(const ASTContext *Context) {
8277   // typedef int __builtin_va_list[4];
8278   llvm::APInt Size(Context->getTypeSize(Context->getSizeType()), 4);
8279   QualType IntArrayType = Context->getConstantArrayType(
8280       Context->IntTy, Size, nullptr, ArrayType::Normal, 0);
8281   return Context->buildImplicitTypedef(IntArrayType, "__builtin_va_list");
8282 }
8283 
8284 static TypedefDecl *
8285 CreateAAPCSABIBuiltinVaListDecl(const ASTContext *Context) {
8286   // struct __va_list
8287   RecordDecl *VaListDecl = Context->buildImplicitRecord("__va_list");
8288   if (Context->getLangOpts().CPlusPlus) {
8289     // namespace std { struct __va_list {
8290     NamespaceDecl *NS;
8291     NS = NamespaceDecl::Create(const_cast<ASTContext &>(*Context),
8292                                Context->getTranslationUnitDecl(),
8293                                /*Inline*/false, SourceLocation(),
8294                                SourceLocation(), &Context->Idents.get("std"),
8295                                /*PrevDecl*/ nullptr);
8296     NS->setImplicit();
8297     VaListDecl->setDeclContext(NS);
8298   }
8299 
8300   VaListDecl->startDefinition();
8301 
8302   // void * __ap;
8303   FieldDecl *Field = FieldDecl::Create(const_cast<ASTContext &>(*Context),
8304                                        VaListDecl,
8305                                        SourceLocation(),
8306                                        SourceLocation(),
8307                                        &Context->Idents.get("__ap"),
8308                                        Context->getPointerType(Context->VoidTy),
8309                                        /*TInfo=*/nullptr,
8310                                        /*BitWidth=*/nullptr,
8311                                        /*Mutable=*/false,
8312                                        ICIS_NoInit);
8313   Field->setAccess(AS_public);
8314   VaListDecl->addDecl(Field);
8315 
8316   // };
8317   VaListDecl->completeDefinition();
8318   Context->VaListTagDecl = VaListDecl;
8319 
8320   // typedef struct __va_list __builtin_va_list;
8321   QualType T = Context->getRecordType(VaListDecl);
8322   return Context->buildImplicitTypedef(T, "__builtin_va_list");
8323 }
8324 
8325 static TypedefDecl *
8326 CreateSystemZBuiltinVaListDecl(const ASTContext *Context) {
8327   // struct __va_list_tag {
8328   RecordDecl *VaListTagDecl;
8329   VaListTagDecl = Context->buildImplicitRecord("__va_list_tag");
8330   VaListTagDecl->startDefinition();
8331 
8332   const size_t NumFields = 4;
8333   QualType FieldTypes[NumFields];
8334   const char *FieldNames[NumFields];
8335 
8336   //   long __gpr;
8337   FieldTypes[0] = Context->LongTy;
8338   FieldNames[0] = "__gpr";
8339 
8340   //   long __fpr;
8341   FieldTypes[1] = Context->LongTy;
8342   FieldNames[1] = "__fpr";
8343 
8344   //   void *__overflow_arg_area;
8345   FieldTypes[2] = Context->getPointerType(Context->VoidTy);
8346   FieldNames[2] = "__overflow_arg_area";
8347 
8348   //   void *__reg_save_area;
8349   FieldTypes[3] = Context->getPointerType(Context->VoidTy);
8350   FieldNames[3] = "__reg_save_area";
8351 
8352   // Create fields
8353   for (unsigned i = 0; i < NumFields; ++i) {
8354     FieldDecl *Field = FieldDecl::Create(const_cast<ASTContext &>(*Context),
8355                                          VaListTagDecl,
8356                                          SourceLocation(),
8357                                          SourceLocation(),
8358                                          &Context->Idents.get(FieldNames[i]),
8359                                          FieldTypes[i], /*TInfo=*/nullptr,
8360                                          /*BitWidth=*/nullptr,
8361                                          /*Mutable=*/false,
8362                                          ICIS_NoInit);
8363     Field->setAccess(AS_public);
8364     VaListTagDecl->addDecl(Field);
8365   }
8366   VaListTagDecl->completeDefinition();
8367   Context->VaListTagDecl = VaListTagDecl;
8368   QualType VaListTagType = Context->getRecordType(VaListTagDecl);
8369 
8370   // };
8371 
8372   // typedef __va_list_tag __builtin_va_list[1];
8373   llvm::APInt Size(Context->getTypeSize(Context->getSizeType()), 1);
8374   QualType VaListTagArrayType = Context->getConstantArrayType(
8375       VaListTagType, Size, nullptr, ArrayType::Normal, 0);
8376 
8377   return Context->buildImplicitTypedef(VaListTagArrayType, "__builtin_va_list");
8378 }
8379 
8380 static TypedefDecl *CreateHexagonBuiltinVaListDecl(const ASTContext *Context) {
8381   // typedef struct __va_list_tag {
8382   RecordDecl *VaListTagDecl;
8383   VaListTagDecl = Context->buildImplicitRecord("__va_list_tag");
8384   VaListTagDecl->startDefinition();
8385 
8386   const size_t NumFields = 3;
8387   QualType FieldTypes[NumFields];
8388   const char *FieldNames[NumFields];
8389 
8390   //   void *CurrentSavedRegisterArea;
8391   FieldTypes[0] = Context->getPointerType(Context->VoidTy);
8392   FieldNames[0] = "__current_saved_reg_area_pointer";
8393 
8394   //   void *SavedRegAreaEnd;
8395   FieldTypes[1] = Context->getPointerType(Context->VoidTy);
8396   FieldNames[1] = "__saved_reg_area_end_pointer";
8397 
8398   //   void *OverflowArea;
8399   FieldTypes[2] = Context->getPointerType(Context->VoidTy);
8400   FieldNames[2] = "__overflow_area_pointer";
8401 
8402   // Create fields
8403   for (unsigned i = 0; i < NumFields; ++i) {
8404     FieldDecl *Field = FieldDecl::Create(
8405         const_cast<ASTContext &>(*Context), VaListTagDecl, SourceLocation(),
8406         SourceLocation(), &Context->Idents.get(FieldNames[i]), FieldTypes[i],
8407         /*TInfo=*/0,
8408         /*BitWidth=*/0,
8409         /*Mutable=*/false, ICIS_NoInit);
8410     Field->setAccess(AS_public);
8411     VaListTagDecl->addDecl(Field);
8412   }
8413   VaListTagDecl->completeDefinition();
8414   Context->VaListTagDecl = VaListTagDecl;
8415   QualType VaListTagType = Context->getRecordType(VaListTagDecl);
8416 
8417   // } __va_list_tag;
8418   TypedefDecl *VaListTagTypedefDecl =
8419       Context->buildImplicitTypedef(VaListTagType, "__va_list_tag");
8420 
8421   QualType VaListTagTypedefType = Context->getTypedefType(VaListTagTypedefDecl);
8422 
8423   // typedef __va_list_tag __builtin_va_list[1];
8424   llvm::APInt Size(Context->getTypeSize(Context->getSizeType()), 1);
8425   QualType VaListTagArrayType = Context->getConstantArrayType(
8426       VaListTagTypedefType, Size, nullptr, ArrayType::Normal, 0);
8427 
8428   return Context->buildImplicitTypedef(VaListTagArrayType, "__builtin_va_list");
8429 }
8430 
8431 static TypedefDecl *CreateVaListDecl(const ASTContext *Context,
8432                                      TargetInfo::BuiltinVaListKind Kind) {
8433   switch (Kind) {
8434   case TargetInfo::CharPtrBuiltinVaList:
8435     return CreateCharPtrBuiltinVaListDecl(Context);
8436   case TargetInfo::VoidPtrBuiltinVaList:
8437     return CreateVoidPtrBuiltinVaListDecl(Context);
8438   case TargetInfo::AArch64ABIBuiltinVaList:
8439     return CreateAArch64ABIBuiltinVaListDecl(Context);
8440   case TargetInfo::PowerABIBuiltinVaList:
8441     return CreatePowerABIBuiltinVaListDecl(Context);
8442   case TargetInfo::X86_64ABIBuiltinVaList:
8443     return CreateX86_64ABIBuiltinVaListDecl(Context);
8444   case TargetInfo::PNaClABIBuiltinVaList:
8445     return CreatePNaClABIBuiltinVaListDecl(Context);
8446   case TargetInfo::AAPCSABIBuiltinVaList:
8447     return CreateAAPCSABIBuiltinVaListDecl(Context);
8448   case TargetInfo::SystemZBuiltinVaList:
8449     return CreateSystemZBuiltinVaListDecl(Context);
8450   case TargetInfo::HexagonBuiltinVaList:
8451     return CreateHexagonBuiltinVaListDecl(Context);
8452   }
8453 
8454   llvm_unreachable("Unhandled __builtin_va_list type kind");
8455 }
8456 
8457 TypedefDecl *ASTContext::getBuiltinVaListDecl() const {
8458   if (!BuiltinVaListDecl) {
8459     BuiltinVaListDecl = CreateVaListDecl(this, Target->getBuiltinVaListKind());
8460     assert(BuiltinVaListDecl->isImplicit());
8461   }
8462 
8463   return BuiltinVaListDecl;
8464 }
8465 
8466 Decl *ASTContext::getVaListTagDecl() const {
8467   // Force the creation of VaListTagDecl by building the __builtin_va_list
8468   // declaration.
8469   if (!VaListTagDecl)
8470     (void)getBuiltinVaListDecl();
8471 
8472   return VaListTagDecl;
8473 }
8474 
8475 TypedefDecl *ASTContext::getBuiltinMSVaListDecl() const {
8476   if (!BuiltinMSVaListDecl)
8477     BuiltinMSVaListDecl = CreateMSVaListDecl(this);
8478 
8479   return BuiltinMSVaListDecl;
8480 }
8481 
8482 bool ASTContext::canBuiltinBeRedeclared(const FunctionDecl *FD) const {
8483   return BuiltinInfo.canBeRedeclared(FD->getBuiltinID());
8484 }
8485 
8486 void ASTContext::setObjCConstantStringInterface(ObjCInterfaceDecl *Decl) {
8487   assert(ObjCConstantStringType.isNull() &&
8488          "'NSConstantString' type already set!");
8489 
8490   ObjCConstantStringType = getObjCInterfaceType(Decl);
8491 }
8492 
8493 /// Retrieve the template name that corresponds to a non-empty
8494 /// lookup.
8495 TemplateName
8496 ASTContext::getOverloadedTemplateName(UnresolvedSetIterator Begin,
8497                                       UnresolvedSetIterator End) const {
8498   unsigned size = End - Begin;
8499   assert(size > 1 && "set is not overloaded!");
8500 
8501   void *memory = Allocate(sizeof(OverloadedTemplateStorage) +
8502                           size * sizeof(FunctionTemplateDecl*));
8503   auto *OT = new (memory) OverloadedTemplateStorage(size);
8504 
8505   NamedDecl **Storage = OT->getStorage();
8506   for (UnresolvedSetIterator I = Begin; I != End; ++I) {
8507     NamedDecl *D = *I;
8508     assert(isa<FunctionTemplateDecl>(D) ||
8509            isa<UnresolvedUsingValueDecl>(D) ||
8510            (isa<UsingShadowDecl>(D) &&
8511             isa<FunctionTemplateDecl>(D->getUnderlyingDecl())));
8512     *Storage++ = D;
8513   }
8514 
8515   return TemplateName(OT);
8516 }
8517 
8518 /// Retrieve a template name representing an unqualified-id that has been
8519 /// assumed to name a template for ADL purposes.
8520 TemplateName ASTContext::getAssumedTemplateName(DeclarationName Name) const {
8521   auto *OT = new (*this) AssumedTemplateStorage(Name);
8522   return TemplateName(OT);
8523 }
8524 
8525 /// Retrieve the template name that represents a qualified
8526 /// template name such as \c std::vector.
8527 TemplateName
8528 ASTContext::getQualifiedTemplateName(NestedNameSpecifier *NNS,
8529                                      bool TemplateKeyword,
8530                                      TemplateDecl *Template) const {
8531   assert(NNS && "Missing nested-name-specifier in qualified template name");
8532 
8533   // FIXME: Canonicalization?
8534   llvm::FoldingSetNodeID ID;
8535   QualifiedTemplateName::Profile(ID, NNS, TemplateKeyword, Template);
8536 
8537   void *InsertPos = nullptr;
8538   QualifiedTemplateName *QTN =
8539     QualifiedTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
8540   if (!QTN) {
8541     QTN = new (*this, alignof(QualifiedTemplateName))
8542         QualifiedTemplateName(NNS, TemplateKeyword, Template);
8543     QualifiedTemplateNames.InsertNode(QTN, InsertPos);
8544   }
8545 
8546   return TemplateName(QTN);
8547 }
8548 
8549 /// Retrieve the template name that represents a dependent
8550 /// template name such as \c MetaFun::template apply.
8551 TemplateName
8552 ASTContext::getDependentTemplateName(NestedNameSpecifier *NNS,
8553                                      const IdentifierInfo *Name) const {
8554   assert((!NNS || NNS->isDependent()) &&
8555          "Nested name specifier must be dependent");
8556 
8557   llvm::FoldingSetNodeID ID;
8558   DependentTemplateName::Profile(ID, NNS, Name);
8559 
8560   void *InsertPos = nullptr;
8561   DependentTemplateName *QTN =
8562     DependentTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
8563 
8564   if (QTN)
8565     return TemplateName(QTN);
8566 
8567   NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
8568   if (CanonNNS == NNS) {
8569     QTN = new (*this, alignof(DependentTemplateName))
8570         DependentTemplateName(NNS, Name);
8571   } else {
8572     TemplateName Canon = getDependentTemplateName(CanonNNS, Name);
8573     QTN = new (*this, alignof(DependentTemplateName))
8574         DependentTemplateName(NNS, Name, Canon);
8575     DependentTemplateName *CheckQTN =
8576       DependentTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
8577     assert(!CheckQTN && "Dependent type name canonicalization broken");
8578     (void)CheckQTN;
8579   }
8580 
8581   DependentTemplateNames.InsertNode(QTN, InsertPos);
8582   return TemplateName(QTN);
8583 }
8584 
8585 /// Retrieve the template name that represents a dependent
8586 /// template name such as \c MetaFun::template operator+.
8587 TemplateName
8588 ASTContext::getDependentTemplateName(NestedNameSpecifier *NNS,
8589                                      OverloadedOperatorKind Operator) const {
8590   assert((!NNS || NNS->isDependent()) &&
8591          "Nested name specifier must be dependent");
8592 
8593   llvm::FoldingSetNodeID ID;
8594   DependentTemplateName::Profile(ID, NNS, Operator);
8595 
8596   void *InsertPos = nullptr;
8597   DependentTemplateName *QTN
8598     = DependentTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
8599 
8600   if (QTN)
8601     return TemplateName(QTN);
8602 
8603   NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
8604   if (CanonNNS == NNS) {
8605     QTN = new (*this, alignof(DependentTemplateName))
8606         DependentTemplateName(NNS, Operator);
8607   } else {
8608     TemplateName Canon = getDependentTemplateName(CanonNNS, Operator);
8609     QTN = new (*this, alignof(DependentTemplateName))
8610         DependentTemplateName(NNS, Operator, Canon);
8611 
8612     DependentTemplateName *CheckQTN
8613       = DependentTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
8614     assert(!CheckQTN && "Dependent template name canonicalization broken");
8615     (void)CheckQTN;
8616   }
8617 
8618   DependentTemplateNames.InsertNode(QTN, InsertPos);
8619   return TemplateName(QTN);
8620 }
8621 
8622 TemplateName
8623 ASTContext::getSubstTemplateTemplateParm(TemplateTemplateParmDecl *param,
8624                                          TemplateName replacement) const {
8625   llvm::FoldingSetNodeID ID;
8626   SubstTemplateTemplateParmStorage::Profile(ID, param, replacement);
8627 
8628   void *insertPos = nullptr;
8629   SubstTemplateTemplateParmStorage *subst
8630     = SubstTemplateTemplateParms.FindNodeOrInsertPos(ID, insertPos);
8631 
8632   if (!subst) {
8633     subst = new (*this) SubstTemplateTemplateParmStorage(param, replacement);
8634     SubstTemplateTemplateParms.InsertNode(subst, insertPos);
8635   }
8636 
8637   return TemplateName(subst);
8638 }
8639 
8640 TemplateName
8641 ASTContext::getSubstTemplateTemplateParmPack(TemplateTemplateParmDecl *Param,
8642                                        const TemplateArgument &ArgPack) const {
8643   auto &Self = const_cast<ASTContext &>(*this);
8644   llvm::FoldingSetNodeID ID;
8645   SubstTemplateTemplateParmPackStorage::Profile(ID, Self, Param, ArgPack);
8646 
8647   void *InsertPos = nullptr;
8648   SubstTemplateTemplateParmPackStorage *Subst
8649     = SubstTemplateTemplateParmPacks.FindNodeOrInsertPos(ID, InsertPos);
8650 
8651   if (!Subst) {
8652     Subst = new (*this) SubstTemplateTemplateParmPackStorage(Param,
8653                                                            ArgPack.pack_size(),
8654                                                          ArgPack.pack_begin());
8655     SubstTemplateTemplateParmPacks.InsertNode(Subst, InsertPos);
8656   }
8657 
8658   return TemplateName(Subst);
8659 }
8660 
8661 /// getFromTargetType - Given one of the integer types provided by
8662 /// TargetInfo, produce the corresponding type. The unsigned @p Type
8663 /// is actually a value of type @c TargetInfo::IntType.
8664 CanQualType ASTContext::getFromTargetType(unsigned Type) const {
8665   switch (Type) {
8666   case TargetInfo::NoInt: return {};
8667   case TargetInfo::SignedChar: return SignedCharTy;
8668   case TargetInfo::UnsignedChar: return UnsignedCharTy;
8669   case TargetInfo::SignedShort: return ShortTy;
8670   case TargetInfo::UnsignedShort: return UnsignedShortTy;
8671   case TargetInfo::SignedInt: return IntTy;
8672   case TargetInfo::UnsignedInt: return UnsignedIntTy;
8673   case TargetInfo::SignedLong: return LongTy;
8674   case TargetInfo::UnsignedLong: return UnsignedLongTy;
8675   case TargetInfo::SignedLongLong: return LongLongTy;
8676   case TargetInfo::UnsignedLongLong: return UnsignedLongLongTy;
8677   }
8678 
8679   llvm_unreachable("Unhandled TargetInfo::IntType value");
8680 }
8681 
8682 //===----------------------------------------------------------------------===//
8683 //                        Type Predicates.
8684 //===----------------------------------------------------------------------===//
8685 
8686 /// getObjCGCAttr - Returns one of GCNone, Weak or Strong objc's
8687 /// garbage collection attribute.
8688 ///
8689 Qualifiers::GC ASTContext::getObjCGCAttrKind(QualType Ty) const {
8690   if (getLangOpts().getGC() == LangOptions::NonGC)
8691     return Qualifiers::GCNone;
8692 
8693   assert(getLangOpts().ObjC);
8694   Qualifiers::GC GCAttrs = Ty.getObjCGCAttr();
8695 
8696   // Default behaviour under objective-C's gc is for ObjC pointers
8697   // (or pointers to them) be treated as though they were declared
8698   // as __strong.
8699   if (GCAttrs == Qualifiers::GCNone) {
8700     if (Ty->isObjCObjectPointerType() || Ty->isBlockPointerType())
8701       return Qualifiers::Strong;
8702     else if (Ty->isPointerType())
8703       return getObjCGCAttrKind(Ty->castAs<PointerType>()->getPointeeType());
8704   } else {
8705     // It's not valid to set GC attributes on anything that isn't a
8706     // pointer.
8707 #ifndef NDEBUG
8708     QualType CT = Ty->getCanonicalTypeInternal();
8709     while (const auto *AT = dyn_cast<ArrayType>(CT))
8710       CT = AT->getElementType();
8711     assert(CT->isAnyPointerType() || CT->isBlockPointerType());
8712 #endif
8713   }
8714   return GCAttrs;
8715 }
8716 
8717 //===----------------------------------------------------------------------===//
8718 //                        Type Compatibility Testing
8719 //===----------------------------------------------------------------------===//
8720 
8721 /// areCompatVectorTypes - Return true if the two specified vector types are
8722 /// compatible.
8723 static bool areCompatVectorTypes(const VectorType *LHS,
8724                                  const VectorType *RHS) {
8725   assert(LHS->isCanonicalUnqualified() && RHS->isCanonicalUnqualified());
8726   return LHS->getElementType() == RHS->getElementType() &&
8727          LHS->getNumElements() == RHS->getNumElements();
8728 }
8729 
8730 /// areCompatMatrixTypes - Return true if the two specified matrix types are
8731 /// compatible.
8732 static bool areCompatMatrixTypes(const ConstantMatrixType *LHS,
8733                                  const ConstantMatrixType *RHS) {
8734   assert(LHS->isCanonicalUnqualified() && RHS->isCanonicalUnqualified());
8735   return LHS->getElementType() == RHS->getElementType() &&
8736          LHS->getNumRows() == RHS->getNumRows() &&
8737          LHS->getNumColumns() == RHS->getNumColumns();
8738 }
8739 
8740 bool ASTContext::areCompatibleVectorTypes(QualType FirstVec,
8741                                           QualType SecondVec) {
8742   assert(FirstVec->isVectorType() && "FirstVec should be a vector type");
8743   assert(SecondVec->isVectorType() && "SecondVec should be a vector type");
8744 
8745   if (hasSameUnqualifiedType(FirstVec, SecondVec))
8746     return true;
8747 
8748   // Treat Neon vector types and most AltiVec vector types as if they are the
8749   // equivalent GCC vector types.
8750   const auto *First = FirstVec->castAs<VectorType>();
8751   const auto *Second = SecondVec->castAs<VectorType>();
8752   if (First->getNumElements() == Second->getNumElements() &&
8753       hasSameType(First->getElementType(), Second->getElementType()) &&
8754       First->getVectorKind() != VectorType::AltiVecPixel &&
8755       First->getVectorKind() != VectorType::AltiVecBool &&
8756       Second->getVectorKind() != VectorType::AltiVecPixel &&
8757       Second->getVectorKind() != VectorType::AltiVecBool &&
8758       First->getVectorKind() != VectorType::SveFixedLengthDataVector &&
8759       First->getVectorKind() != VectorType::SveFixedLengthPredicateVector &&
8760       Second->getVectorKind() != VectorType::SveFixedLengthDataVector &&
8761       Second->getVectorKind() != VectorType::SveFixedLengthPredicateVector)
8762     return true;
8763 
8764   return false;
8765 }
8766 
8767 /// getSVETypeSize - Return SVE vector or predicate register size.
8768 static uint64_t getSVETypeSize(ASTContext &Context, const BuiltinType *Ty) {
8769   assert(Ty->isVLSTBuiltinType() && "Invalid SVE Type");
8770   return Ty->getKind() == BuiltinType::SveBool
8771              ? Context.getLangOpts().ArmSveVectorBits / Context.getCharWidth()
8772              : Context.getLangOpts().ArmSveVectorBits;
8773 }
8774 
8775 bool ASTContext::areCompatibleSveTypes(QualType FirstType,
8776                                        QualType SecondType) {
8777   assert(((FirstType->isSizelessBuiltinType() && SecondType->isVectorType()) ||
8778           (FirstType->isVectorType() && SecondType->isSizelessBuiltinType())) &&
8779          "Expected SVE builtin type and vector type!");
8780 
8781   auto IsValidCast = [this](QualType FirstType, QualType SecondType) {
8782     if (const auto *BT = FirstType->getAs<BuiltinType>()) {
8783       if (const auto *VT = SecondType->getAs<VectorType>()) {
8784         // Predicates have the same representation as uint8 so we also have to
8785         // check the kind to make these types incompatible.
8786         if (VT->getVectorKind() == VectorType::SveFixedLengthPredicateVector)
8787           return BT->getKind() == BuiltinType::SveBool;
8788         else if (VT->getVectorKind() == VectorType::SveFixedLengthDataVector)
8789           return VT->getElementType().getCanonicalType() ==
8790                  FirstType->getSveEltType(*this);
8791         else if (VT->getVectorKind() == VectorType::GenericVector)
8792           return getTypeSize(SecondType) == getSVETypeSize(*this, BT) &&
8793                  hasSameType(VT->getElementType(),
8794                              getBuiltinVectorTypeInfo(BT).ElementType);
8795       }
8796     }
8797     return false;
8798   };
8799 
8800   return IsValidCast(FirstType, SecondType) ||
8801          IsValidCast(SecondType, FirstType);
8802 }
8803 
8804 bool ASTContext::areLaxCompatibleSveTypes(QualType FirstType,
8805                                           QualType SecondType) {
8806   assert(((FirstType->isSizelessBuiltinType() && SecondType->isVectorType()) ||
8807           (FirstType->isVectorType() && SecondType->isSizelessBuiltinType())) &&
8808          "Expected SVE builtin type and vector type!");
8809 
8810   auto IsLaxCompatible = [this](QualType FirstType, QualType SecondType) {
8811     const auto *BT = FirstType->getAs<BuiltinType>();
8812     if (!BT)
8813       return false;
8814 
8815     const auto *VecTy = SecondType->getAs<VectorType>();
8816     if (VecTy &&
8817         (VecTy->getVectorKind() == VectorType::SveFixedLengthDataVector ||
8818          VecTy->getVectorKind() == VectorType::GenericVector)) {
8819       const LangOptions::LaxVectorConversionKind LVCKind =
8820           getLangOpts().getLaxVectorConversions();
8821 
8822       // Can not convert between sve predicates and sve vectors because of
8823       // different size.
8824       if (BT->getKind() == BuiltinType::SveBool &&
8825           VecTy->getVectorKind() == VectorType::SveFixedLengthDataVector)
8826         return false;
8827 
8828       // If __ARM_FEATURE_SVE_BITS != N do not allow GNU vector lax conversion.
8829       // "Whenever __ARM_FEATURE_SVE_BITS==N, GNUT implicitly
8830       // converts to VLAT and VLAT implicitly converts to GNUT."
8831       // ACLE Spec Version 00bet6, 3.7.3.2. Behavior common to vectors and
8832       // predicates.
8833       if (VecTy->getVectorKind() == VectorType::GenericVector &&
8834           getTypeSize(SecondType) != getSVETypeSize(*this, BT))
8835         return false;
8836 
8837       // If -flax-vector-conversions=all is specified, the types are
8838       // certainly compatible.
8839       if (LVCKind == LangOptions::LaxVectorConversionKind::All)
8840         return true;
8841 
8842       // If -flax-vector-conversions=integer is specified, the types are
8843       // compatible if the elements are integer types.
8844       if (LVCKind == LangOptions::LaxVectorConversionKind::Integer)
8845         return VecTy->getElementType().getCanonicalType()->isIntegerType() &&
8846                FirstType->getSveEltType(*this)->isIntegerType();
8847     }
8848 
8849     return false;
8850   };
8851 
8852   return IsLaxCompatible(FirstType, SecondType) ||
8853          IsLaxCompatible(SecondType, FirstType);
8854 }
8855 
8856 bool ASTContext::hasDirectOwnershipQualifier(QualType Ty) const {
8857   while (true) {
8858     // __strong id
8859     if (const AttributedType *Attr = dyn_cast<AttributedType>(Ty)) {
8860       if (Attr->getAttrKind() == attr::ObjCOwnership)
8861         return true;
8862 
8863       Ty = Attr->getModifiedType();
8864 
8865     // X *__strong (...)
8866     } else if (const ParenType *Paren = dyn_cast<ParenType>(Ty)) {
8867       Ty = Paren->getInnerType();
8868 
8869     // We do not want to look through typedefs, typeof(expr),
8870     // typeof(type), or any other way that the type is somehow
8871     // abstracted.
8872     } else {
8873       return false;
8874     }
8875   }
8876 }
8877 
8878 //===----------------------------------------------------------------------===//
8879 // ObjCQualifiedIdTypesAreCompatible - Compatibility testing for qualified id's.
8880 //===----------------------------------------------------------------------===//
8881 
8882 /// ProtocolCompatibleWithProtocol - return 'true' if 'lProto' is in the
8883 /// inheritance hierarchy of 'rProto'.
8884 bool
8885 ASTContext::ProtocolCompatibleWithProtocol(ObjCProtocolDecl *lProto,
8886                                            ObjCProtocolDecl *rProto) const {
8887   if (declaresSameEntity(lProto, rProto))
8888     return true;
8889   for (auto *PI : rProto->protocols())
8890     if (ProtocolCompatibleWithProtocol(lProto, PI))
8891       return true;
8892   return false;
8893 }
8894 
8895 /// ObjCQualifiedClassTypesAreCompatible - compare  Class<pr,...> and
8896 /// Class<pr1, ...>.
8897 bool ASTContext::ObjCQualifiedClassTypesAreCompatible(
8898     const ObjCObjectPointerType *lhs, const ObjCObjectPointerType *rhs) {
8899   for (auto *lhsProto : lhs->quals()) {
8900     bool match = false;
8901     for (auto *rhsProto : rhs->quals()) {
8902       if (ProtocolCompatibleWithProtocol(lhsProto, rhsProto)) {
8903         match = true;
8904         break;
8905       }
8906     }
8907     if (!match)
8908       return false;
8909   }
8910   return true;
8911 }
8912 
8913 /// ObjCQualifiedIdTypesAreCompatible - We know that one of lhs/rhs is an
8914 /// ObjCQualifiedIDType.
8915 bool ASTContext::ObjCQualifiedIdTypesAreCompatible(
8916     const ObjCObjectPointerType *lhs, const ObjCObjectPointerType *rhs,
8917     bool compare) {
8918   // Allow id<P..> and an 'id' in all cases.
8919   if (lhs->isObjCIdType() || rhs->isObjCIdType())
8920     return true;
8921 
8922   // Don't allow id<P..> to convert to Class or Class<P..> in either direction.
8923   if (lhs->isObjCClassType() || lhs->isObjCQualifiedClassType() ||
8924       rhs->isObjCClassType() || rhs->isObjCQualifiedClassType())
8925     return false;
8926 
8927   if (lhs->isObjCQualifiedIdType()) {
8928     if (rhs->qual_empty()) {
8929       // If the RHS is a unqualified interface pointer "NSString*",
8930       // make sure we check the class hierarchy.
8931       if (ObjCInterfaceDecl *rhsID = rhs->getInterfaceDecl()) {
8932         for (auto *I : lhs->quals()) {
8933           // when comparing an id<P> on lhs with a static type on rhs,
8934           // see if static class implements all of id's protocols, directly or
8935           // through its super class and categories.
8936           if (!rhsID->ClassImplementsProtocol(I, true))
8937             return false;
8938         }
8939       }
8940       // If there are no qualifiers and no interface, we have an 'id'.
8941       return true;
8942     }
8943     // Both the right and left sides have qualifiers.
8944     for (auto *lhsProto : lhs->quals()) {
8945       bool match = false;
8946 
8947       // when comparing an id<P> on lhs with a static type on rhs,
8948       // see if static class implements all of id's protocols, directly or
8949       // through its super class and categories.
8950       for (auto *rhsProto : rhs->quals()) {
8951         if (ProtocolCompatibleWithProtocol(lhsProto, rhsProto) ||
8952             (compare && ProtocolCompatibleWithProtocol(rhsProto, lhsProto))) {
8953           match = true;
8954           break;
8955         }
8956       }
8957       // If the RHS is a qualified interface pointer "NSString<P>*",
8958       // make sure we check the class hierarchy.
8959       if (ObjCInterfaceDecl *rhsID = rhs->getInterfaceDecl()) {
8960         for (auto *I : lhs->quals()) {
8961           // when comparing an id<P> on lhs with a static type on rhs,
8962           // see if static class implements all of id's protocols, directly or
8963           // through its super class and categories.
8964           if (rhsID->ClassImplementsProtocol(I, true)) {
8965             match = true;
8966             break;
8967           }
8968         }
8969       }
8970       if (!match)
8971         return false;
8972     }
8973 
8974     return true;
8975   }
8976 
8977   assert(rhs->isObjCQualifiedIdType() && "One of the LHS/RHS should be id<x>");
8978 
8979   if (lhs->getInterfaceType()) {
8980     // If both the right and left sides have qualifiers.
8981     for (auto *lhsProto : lhs->quals()) {
8982       bool match = false;
8983 
8984       // when comparing an id<P> on rhs with a static type on lhs,
8985       // see if static class implements all of id's protocols, directly or
8986       // through its super class and categories.
8987       // First, lhs protocols in the qualifier list must be found, direct
8988       // or indirect in rhs's qualifier list or it is a mismatch.
8989       for (auto *rhsProto : rhs->quals()) {
8990         if (ProtocolCompatibleWithProtocol(lhsProto, rhsProto) ||
8991             (compare && ProtocolCompatibleWithProtocol(rhsProto, lhsProto))) {
8992           match = true;
8993           break;
8994         }
8995       }
8996       if (!match)
8997         return false;
8998     }
8999 
9000     // Static class's protocols, or its super class or category protocols
9001     // must be found, direct or indirect in rhs's qualifier list or it is a mismatch.
9002     if (ObjCInterfaceDecl *lhsID = lhs->getInterfaceDecl()) {
9003       llvm::SmallPtrSet<ObjCProtocolDecl *, 8> LHSInheritedProtocols;
9004       CollectInheritedProtocols(lhsID, LHSInheritedProtocols);
9005       // This is rather dubious but matches gcc's behavior. If lhs has
9006       // no type qualifier and its class has no static protocol(s)
9007       // assume that it is mismatch.
9008       if (LHSInheritedProtocols.empty() && lhs->qual_empty())
9009         return false;
9010       for (auto *lhsProto : LHSInheritedProtocols) {
9011         bool match = false;
9012         for (auto *rhsProto : rhs->quals()) {
9013           if (ProtocolCompatibleWithProtocol(lhsProto, rhsProto) ||
9014               (compare && ProtocolCompatibleWithProtocol(rhsProto, lhsProto))) {
9015             match = true;
9016             break;
9017           }
9018         }
9019         if (!match)
9020           return false;
9021       }
9022     }
9023     return true;
9024   }
9025   return false;
9026 }
9027 
9028 /// canAssignObjCInterfaces - Return true if the two interface types are
9029 /// compatible for assignment from RHS to LHS.  This handles validation of any
9030 /// protocol qualifiers on the LHS or RHS.
9031 bool ASTContext::canAssignObjCInterfaces(const ObjCObjectPointerType *LHSOPT,
9032                                          const ObjCObjectPointerType *RHSOPT) {
9033   const ObjCObjectType* LHS = LHSOPT->getObjectType();
9034   const ObjCObjectType* RHS = RHSOPT->getObjectType();
9035 
9036   // If either type represents the built-in 'id' type, return true.
9037   if (LHS->isObjCUnqualifiedId() || RHS->isObjCUnqualifiedId())
9038     return true;
9039 
9040   // Function object that propagates a successful result or handles
9041   // __kindof types.
9042   auto finish = [&](bool succeeded) -> bool {
9043     if (succeeded)
9044       return true;
9045 
9046     if (!RHS->isKindOfType())
9047       return false;
9048 
9049     // Strip off __kindof and protocol qualifiers, then check whether
9050     // we can assign the other way.
9051     return canAssignObjCInterfaces(RHSOPT->stripObjCKindOfTypeAndQuals(*this),
9052                                    LHSOPT->stripObjCKindOfTypeAndQuals(*this));
9053   };
9054 
9055   // Casts from or to id<P> are allowed when the other side has compatible
9056   // protocols.
9057   if (LHS->isObjCQualifiedId() || RHS->isObjCQualifiedId()) {
9058     return finish(ObjCQualifiedIdTypesAreCompatible(LHSOPT, RHSOPT, false));
9059   }
9060 
9061   // Verify protocol compatibility for casts from Class<P1> to Class<P2>.
9062   if (LHS->isObjCQualifiedClass() && RHS->isObjCQualifiedClass()) {
9063     return finish(ObjCQualifiedClassTypesAreCompatible(LHSOPT, RHSOPT));
9064   }
9065 
9066   // Casts from Class to Class<Foo>, or vice-versa, are allowed.
9067   if (LHS->isObjCClass() && RHS->isObjCClass()) {
9068     return true;
9069   }
9070 
9071   // If we have 2 user-defined types, fall into that path.
9072   if (LHS->getInterface() && RHS->getInterface()) {
9073     return finish(canAssignObjCInterfaces(LHS, RHS));
9074   }
9075 
9076   return false;
9077 }
9078 
9079 /// canAssignObjCInterfacesInBlockPointer - This routine is specifically written
9080 /// for providing type-safety for objective-c pointers used to pass/return
9081 /// arguments in block literals. When passed as arguments, passing 'A*' where
9082 /// 'id' is expected is not OK. Passing 'Sub *" where 'Super *" is expected is
9083 /// not OK. For the return type, the opposite is not OK.
9084 bool ASTContext::canAssignObjCInterfacesInBlockPointer(
9085                                          const ObjCObjectPointerType *LHSOPT,
9086                                          const ObjCObjectPointerType *RHSOPT,
9087                                          bool BlockReturnType) {
9088 
9089   // Function object that propagates a successful result or handles
9090   // __kindof types.
9091   auto finish = [&](bool succeeded) -> bool {
9092     if (succeeded)
9093       return true;
9094 
9095     const ObjCObjectPointerType *Expected = BlockReturnType ? RHSOPT : LHSOPT;
9096     if (!Expected->isKindOfType())
9097       return false;
9098 
9099     // Strip off __kindof and protocol qualifiers, then check whether
9100     // we can assign the other way.
9101     return canAssignObjCInterfacesInBlockPointer(
9102              RHSOPT->stripObjCKindOfTypeAndQuals(*this),
9103              LHSOPT->stripObjCKindOfTypeAndQuals(*this),
9104              BlockReturnType);
9105   };
9106 
9107   if (RHSOPT->isObjCBuiltinType() || LHSOPT->isObjCIdType())
9108     return true;
9109 
9110   if (LHSOPT->isObjCBuiltinType()) {
9111     return finish(RHSOPT->isObjCBuiltinType() ||
9112                   RHSOPT->isObjCQualifiedIdType());
9113   }
9114 
9115   if (LHSOPT->isObjCQualifiedIdType() || RHSOPT->isObjCQualifiedIdType()) {
9116     if (getLangOpts().CompatibilityQualifiedIdBlockParamTypeChecking)
9117       // Use for block parameters previous type checking for compatibility.
9118       return finish(ObjCQualifiedIdTypesAreCompatible(LHSOPT, RHSOPT, false) ||
9119                     // Or corrected type checking as in non-compat mode.
9120                     (!BlockReturnType &&
9121                      ObjCQualifiedIdTypesAreCompatible(RHSOPT, LHSOPT, false)));
9122     else
9123       return finish(ObjCQualifiedIdTypesAreCompatible(
9124           (BlockReturnType ? LHSOPT : RHSOPT),
9125           (BlockReturnType ? RHSOPT : LHSOPT), false));
9126   }
9127 
9128   const ObjCInterfaceType* LHS = LHSOPT->getInterfaceType();
9129   const ObjCInterfaceType* RHS = RHSOPT->getInterfaceType();
9130   if (LHS && RHS)  { // We have 2 user-defined types.
9131     if (LHS != RHS) {
9132       if (LHS->getDecl()->isSuperClassOf(RHS->getDecl()))
9133         return finish(BlockReturnType);
9134       if (RHS->getDecl()->isSuperClassOf(LHS->getDecl()))
9135         return finish(!BlockReturnType);
9136     }
9137     else
9138       return true;
9139   }
9140   return false;
9141 }
9142 
9143 /// Comparison routine for Objective-C protocols to be used with
9144 /// llvm::array_pod_sort.
9145 static int compareObjCProtocolsByName(ObjCProtocolDecl * const *lhs,
9146                                       ObjCProtocolDecl * const *rhs) {
9147   return (*lhs)->getName().compare((*rhs)->getName());
9148 }
9149 
9150 /// getIntersectionOfProtocols - This routine finds the intersection of set
9151 /// of protocols inherited from two distinct objective-c pointer objects with
9152 /// the given common base.
9153 /// It is used to build composite qualifier list of the composite type of
9154 /// the conditional expression involving two objective-c pointer objects.
9155 static
9156 void getIntersectionOfProtocols(ASTContext &Context,
9157                                 const ObjCInterfaceDecl *CommonBase,
9158                                 const ObjCObjectPointerType *LHSOPT,
9159                                 const ObjCObjectPointerType *RHSOPT,
9160       SmallVectorImpl<ObjCProtocolDecl *> &IntersectionSet) {
9161 
9162   const ObjCObjectType* LHS = LHSOPT->getObjectType();
9163   const ObjCObjectType* RHS = RHSOPT->getObjectType();
9164   assert(LHS->getInterface() && "LHS must have an interface base");
9165   assert(RHS->getInterface() && "RHS must have an interface base");
9166 
9167   // Add all of the protocols for the LHS.
9168   llvm::SmallPtrSet<ObjCProtocolDecl *, 8> LHSProtocolSet;
9169 
9170   // Start with the protocol qualifiers.
9171   for (auto proto : LHS->quals()) {
9172     Context.CollectInheritedProtocols(proto, LHSProtocolSet);
9173   }
9174 
9175   // Also add the protocols associated with the LHS interface.
9176   Context.CollectInheritedProtocols(LHS->getInterface(), LHSProtocolSet);
9177 
9178   // Add all of the protocols for the RHS.
9179   llvm::SmallPtrSet<ObjCProtocolDecl *, 8> RHSProtocolSet;
9180 
9181   // Start with the protocol qualifiers.
9182   for (auto proto : RHS->quals()) {
9183     Context.CollectInheritedProtocols(proto, RHSProtocolSet);
9184   }
9185 
9186   // Also add the protocols associated with the RHS interface.
9187   Context.CollectInheritedProtocols(RHS->getInterface(), RHSProtocolSet);
9188 
9189   // Compute the intersection of the collected protocol sets.
9190   for (auto proto : LHSProtocolSet) {
9191     if (RHSProtocolSet.count(proto))
9192       IntersectionSet.push_back(proto);
9193   }
9194 
9195   // Compute the set of protocols that is implied by either the common type or
9196   // the protocols within the intersection.
9197   llvm::SmallPtrSet<ObjCProtocolDecl *, 8> ImpliedProtocols;
9198   Context.CollectInheritedProtocols(CommonBase, ImpliedProtocols);
9199 
9200   // Remove any implied protocols from the list of inherited protocols.
9201   if (!ImpliedProtocols.empty()) {
9202     IntersectionSet.erase(
9203       std::remove_if(IntersectionSet.begin(),
9204                      IntersectionSet.end(),
9205                      [&](ObjCProtocolDecl *proto) -> bool {
9206                        return ImpliedProtocols.count(proto) > 0;
9207                      }),
9208       IntersectionSet.end());
9209   }
9210 
9211   // Sort the remaining protocols by name.
9212   llvm::array_pod_sort(IntersectionSet.begin(), IntersectionSet.end(),
9213                        compareObjCProtocolsByName);
9214 }
9215 
9216 /// Determine whether the first type is a subtype of the second.
9217 static bool canAssignObjCObjectTypes(ASTContext &ctx, QualType lhs,
9218                                      QualType rhs) {
9219   // Common case: two object pointers.
9220   const auto *lhsOPT = lhs->getAs<ObjCObjectPointerType>();
9221   const auto *rhsOPT = rhs->getAs<ObjCObjectPointerType>();
9222   if (lhsOPT && rhsOPT)
9223     return ctx.canAssignObjCInterfaces(lhsOPT, rhsOPT);
9224 
9225   // Two block pointers.
9226   const auto *lhsBlock = lhs->getAs<BlockPointerType>();
9227   const auto *rhsBlock = rhs->getAs<BlockPointerType>();
9228   if (lhsBlock && rhsBlock)
9229     return ctx.typesAreBlockPointerCompatible(lhs, rhs);
9230 
9231   // If either is an unqualified 'id' and the other is a block, it's
9232   // acceptable.
9233   if ((lhsOPT && lhsOPT->isObjCIdType() && rhsBlock) ||
9234       (rhsOPT && rhsOPT->isObjCIdType() && lhsBlock))
9235     return true;
9236 
9237   return false;
9238 }
9239 
9240 // Check that the given Objective-C type argument lists are equivalent.
9241 static bool sameObjCTypeArgs(ASTContext &ctx,
9242                              const ObjCInterfaceDecl *iface,
9243                              ArrayRef<QualType> lhsArgs,
9244                              ArrayRef<QualType> rhsArgs,
9245                              bool stripKindOf) {
9246   if (lhsArgs.size() != rhsArgs.size())
9247     return false;
9248 
9249   ObjCTypeParamList *typeParams = iface->getTypeParamList();
9250   for (unsigned i = 0, n = lhsArgs.size(); i != n; ++i) {
9251     if (ctx.hasSameType(lhsArgs[i], rhsArgs[i]))
9252       continue;
9253 
9254     switch (typeParams->begin()[i]->getVariance()) {
9255     case ObjCTypeParamVariance::Invariant:
9256       if (!stripKindOf ||
9257           !ctx.hasSameType(lhsArgs[i].stripObjCKindOfType(ctx),
9258                            rhsArgs[i].stripObjCKindOfType(ctx))) {
9259         return false;
9260       }
9261       break;
9262 
9263     case ObjCTypeParamVariance::Covariant:
9264       if (!canAssignObjCObjectTypes(ctx, lhsArgs[i], rhsArgs[i]))
9265         return false;
9266       break;
9267 
9268     case ObjCTypeParamVariance::Contravariant:
9269       if (!canAssignObjCObjectTypes(ctx, rhsArgs[i], lhsArgs[i]))
9270         return false;
9271       break;
9272     }
9273   }
9274 
9275   return true;
9276 }
9277 
9278 QualType ASTContext::areCommonBaseCompatible(
9279            const ObjCObjectPointerType *Lptr,
9280            const ObjCObjectPointerType *Rptr) {
9281   const ObjCObjectType *LHS = Lptr->getObjectType();
9282   const ObjCObjectType *RHS = Rptr->getObjectType();
9283   const ObjCInterfaceDecl* LDecl = LHS->getInterface();
9284   const ObjCInterfaceDecl* RDecl = RHS->getInterface();
9285 
9286   if (!LDecl || !RDecl)
9287     return {};
9288 
9289   // When either LHS or RHS is a kindof type, we should return a kindof type.
9290   // For example, for common base of kindof(ASub1) and kindof(ASub2), we return
9291   // kindof(A).
9292   bool anyKindOf = LHS->isKindOfType() || RHS->isKindOfType();
9293 
9294   // Follow the left-hand side up the class hierarchy until we either hit a
9295   // root or find the RHS. Record the ancestors in case we don't find it.
9296   llvm::SmallDenseMap<const ObjCInterfaceDecl *, const ObjCObjectType *, 4>
9297     LHSAncestors;
9298   while (true) {
9299     // Record this ancestor. We'll need this if the common type isn't in the
9300     // path from the LHS to the root.
9301     LHSAncestors[LHS->getInterface()->getCanonicalDecl()] = LHS;
9302 
9303     if (declaresSameEntity(LHS->getInterface(), RDecl)) {
9304       // Get the type arguments.
9305       ArrayRef<QualType> LHSTypeArgs = LHS->getTypeArgsAsWritten();
9306       bool anyChanges = false;
9307       if (LHS->isSpecialized() && RHS->isSpecialized()) {
9308         // Both have type arguments, compare them.
9309         if (!sameObjCTypeArgs(*this, LHS->getInterface(),
9310                               LHS->getTypeArgs(), RHS->getTypeArgs(),
9311                               /*stripKindOf=*/true))
9312           return {};
9313       } else if (LHS->isSpecialized() != RHS->isSpecialized()) {
9314         // If only one has type arguments, the result will not have type
9315         // arguments.
9316         LHSTypeArgs = {};
9317         anyChanges = true;
9318       }
9319 
9320       // Compute the intersection of protocols.
9321       SmallVector<ObjCProtocolDecl *, 8> Protocols;
9322       getIntersectionOfProtocols(*this, LHS->getInterface(), Lptr, Rptr,
9323                                  Protocols);
9324       if (!Protocols.empty())
9325         anyChanges = true;
9326 
9327       // If anything in the LHS will have changed, build a new result type.
9328       // If we need to return a kindof type but LHS is not a kindof type, we
9329       // build a new result type.
9330       if (anyChanges || LHS->isKindOfType() != anyKindOf) {
9331         QualType Result = getObjCInterfaceType(LHS->getInterface());
9332         Result = getObjCObjectType(Result, LHSTypeArgs, Protocols,
9333                                    anyKindOf || LHS->isKindOfType());
9334         return getObjCObjectPointerType(Result);
9335       }
9336 
9337       return getObjCObjectPointerType(QualType(LHS, 0));
9338     }
9339 
9340     // Find the superclass.
9341     QualType LHSSuperType = LHS->getSuperClassType();
9342     if (LHSSuperType.isNull())
9343       break;
9344 
9345     LHS = LHSSuperType->castAs<ObjCObjectType>();
9346   }
9347 
9348   // We didn't find anything by following the LHS to its root; now check
9349   // the RHS against the cached set of ancestors.
9350   while (true) {
9351     auto KnownLHS = LHSAncestors.find(RHS->getInterface()->getCanonicalDecl());
9352     if (KnownLHS != LHSAncestors.end()) {
9353       LHS = KnownLHS->second;
9354 
9355       // Get the type arguments.
9356       ArrayRef<QualType> RHSTypeArgs = RHS->getTypeArgsAsWritten();
9357       bool anyChanges = false;
9358       if (LHS->isSpecialized() && RHS->isSpecialized()) {
9359         // Both have type arguments, compare them.
9360         if (!sameObjCTypeArgs(*this, LHS->getInterface(),
9361                               LHS->getTypeArgs(), RHS->getTypeArgs(),
9362                               /*stripKindOf=*/true))
9363           return {};
9364       } else if (LHS->isSpecialized() != RHS->isSpecialized()) {
9365         // If only one has type arguments, the result will not have type
9366         // arguments.
9367         RHSTypeArgs = {};
9368         anyChanges = true;
9369       }
9370 
9371       // Compute the intersection of protocols.
9372       SmallVector<ObjCProtocolDecl *, 8> Protocols;
9373       getIntersectionOfProtocols(*this, RHS->getInterface(), Lptr, Rptr,
9374                                  Protocols);
9375       if (!Protocols.empty())
9376         anyChanges = true;
9377 
9378       // If we need to return a kindof type but RHS is not a kindof type, we
9379       // build a new result type.
9380       if (anyChanges || RHS->isKindOfType() != anyKindOf) {
9381         QualType Result = getObjCInterfaceType(RHS->getInterface());
9382         Result = getObjCObjectType(Result, RHSTypeArgs, Protocols,
9383                                    anyKindOf || RHS->isKindOfType());
9384         return getObjCObjectPointerType(Result);
9385       }
9386 
9387       return getObjCObjectPointerType(QualType(RHS, 0));
9388     }
9389 
9390     // Find the superclass of the RHS.
9391     QualType RHSSuperType = RHS->getSuperClassType();
9392     if (RHSSuperType.isNull())
9393       break;
9394 
9395     RHS = RHSSuperType->castAs<ObjCObjectType>();
9396   }
9397 
9398   return {};
9399 }
9400 
9401 bool ASTContext::canAssignObjCInterfaces(const ObjCObjectType *LHS,
9402                                          const ObjCObjectType *RHS) {
9403   assert(LHS->getInterface() && "LHS is not an interface type");
9404   assert(RHS->getInterface() && "RHS is not an interface type");
9405 
9406   // Verify that the base decls are compatible: the RHS must be a subclass of
9407   // the LHS.
9408   ObjCInterfaceDecl *LHSInterface = LHS->getInterface();
9409   bool IsSuperClass = LHSInterface->isSuperClassOf(RHS->getInterface());
9410   if (!IsSuperClass)
9411     return false;
9412 
9413   // If the LHS has protocol qualifiers, determine whether all of them are
9414   // satisfied by the RHS (i.e., the RHS has a superset of the protocols in the
9415   // LHS).
9416   if (LHS->getNumProtocols() > 0) {
9417     // OK if conversion of LHS to SuperClass results in narrowing of types
9418     // ; i.e., SuperClass may implement at least one of the protocols
9419     // in LHS's protocol list. Example, SuperObj<P1> = lhs<P1,P2> is ok.
9420     // But not SuperObj<P1,P2,P3> = lhs<P1,P2>.
9421     llvm::SmallPtrSet<ObjCProtocolDecl *, 8> SuperClassInheritedProtocols;
9422     CollectInheritedProtocols(RHS->getInterface(), SuperClassInheritedProtocols);
9423     // Also, if RHS has explicit quelifiers, include them for comparing with LHS's
9424     // qualifiers.
9425     for (auto *RHSPI : RHS->quals())
9426       CollectInheritedProtocols(RHSPI, SuperClassInheritedProtocols);
9427     // If there is no protocols associated with RHS, it is not a match.
9428     if (SuperClassInheritedProtocols.empty())
9429       return false;
9430 
9431     for (const auto *LHSProto : LHS->quals()) {
9432       bool SuperImplementsProtocol = false;
9433       for (auto *SuperClassProto : SuperClassInheritedProtocols)
9434         if (SuperClassProto->lookupProtocolNamed(LHSProto->getIdentifier())) {
9435           SuperImplementsProtocol = true;
9436           break;
9437         }
9438       if (!SuperImplementsProtocol)
9439         return false;
9440     }
9441   }
9442 
9443   // If the LHS is specialized, we may need to check type arguments.
9444   if (LHS->isSpecialized()) {
9445     // Follow the superclass chain until we've matched the LHS class in the
9446     // hierarchy. This substitutes type arguments through.
9447     const ObjCObjectType *RHSSuper = RHS;
9448     while (!declaresSameEntity(RHSSuper->getInterface(), LHSInterface))
9449       RHSSuper = RHSSuper->getSuperClassType()->castAs<ObjCObjectType>();
9450 
9451     // If the RHS is specializd, compare type arguments.
9452     if (RHSSuper->isSpecialized() &&
9453         !sameObjCTypeArgs(*this, LHS->getInterface(),
9454                           LHS->getTypeArgs(), RHSSuper->getTypeArgs(),
9455                           /*stripKindOf=*/true)) {
9456       return false;
9457     }
9458   }
9459 
9460   return true;
9461 }
9462 
9463 bool ASTContext::areComparableObjCPointerTypes(QualType LHS, QualType RHS) {
9464   // get the "pointed to" types
9465   const auto *LHSOPT = LHS->getAs<ObjCObjectPointerType>();
9466   const auto *RHSOPT = RHS->getAs<ObjCObjectPointerType>();
9467 
9468   if (!LHSOPT || !RHSOPT)
9469     return false;
9470 
9471   return canAssignObjCInterfaces(LHSOPT, RHSOPT) ||
9472          canAssignObjCInterfaces(RHSOPT, LHSOPT);
9473 }
9474 
9475 bool ASTContext::canBindObjCObjectType(QualType To, QualType From) {
9476   return canAssignObjCInterfaces(
9477       getObjCObjectPointerType(To)->castAs<ObjCObjectPointerType>(),
9478       getObjCObjectPointerType(From)->castAs<ObjCObjectPointerType>());
9479 }
9480 
9481 /// typesAreCompatible - C99 6.7.3p9: For two qualified types to be compatible,
9482 /// both shall have the identically qualified version of a compatible type.
9483 /// C99 6.2.7p1: Two types have compatible types if their types are the
9484 /// same. See 6.7.[2,3,5] for additional rules.
9485 bool ASTContext::typesAreCompatible(QualType LHS, QualType RHS,
9486                                     bool CompareUnqualified) {
9487   if (getLangOpts().CPlusPlus)
9488     return hasSameType(LHS, RHS);
9489 
9490   return !mergeTypes(LHS, RHS, false, CompareUnqualified).isNull();
9491 }
9492 
9493 bool ASTContext::propertyTypesAreCompatible(QualType LHS, QualType RHS) {
9494   return typesAreCompatible(LHS, RHS);
9495 }
9496 
9497 bool ASTContext::typesAreBlockPointerCompatible(QualType LHS, QualType RHS) {
9498   return !mergeTypes(LHS, RHS, true).isNull();
9499 }
9500 
9501 /// mergeTransparentUnionType - if T is a transparent union type and a member
9502 /// of T is compatible with SubType, return the merged type, else return
9503 /// QualType()
9504 QualType ASTContext::mergeTransparentUnionType(QualType T, QualType SubType,
9505                                                bool OfBlockPointer,
9506                                                bool Unqualified) {
9507   if (const RecordType *UT = T->getAsUnionType()) {
9508     RecordDecl *UD = UT->getDecl();
9509     if (UD->hasAttr<TransparentUnionAttr>()) {
9510       for (const auto *I : UD->fields()) {
9511         QualType ET = I->getType().getUnqualifiedType();
9512         QualType MT = mergeTypes(ET, SubType, OfBlockPointer, Unqualified);
9513         if (!MT.isNull())
9514           return MT;
9515       }
9516     }
9517   }
9518 
9519   return {};
9520 }
9521 
9522 /// mergeFunctionParameterTypes - merge two types which appear as function
9523 /// parameter types
9524 QualType ASTContext::mergeFunctionParameterTypes(QualType lhs, QualType rhs,
9525                                                  bool OfBlockPointer,
9526                                                  bool Unqualified) {
9527   // GNU extension: two types are compatible if they appear as a function
9528   // argument, one of the types is a transparent union type and the other
9529   // type is compatible with a union member
9530   QualType lmerge = mergeTransparentUnionType(lhs, rhs, OfBlockPointer,
9531                                               Unqualified);
9532   if (!lmerge.isNull())
9533     return lmerge;
9534 
9535   QualType rmerge = mergeTransparentUnionType(rhs, lhs, OfBlockPointer,
9536                                               Unqualified);
9537   if (!rmerge.isNull())
9538     return rmerge;
9539 
9540   return mergeTypes(lhs, rhs, OfBlockPointer, Unqualified);
9541 }
9542 
9543 QualType ASTContext::mergeFunctionTypes(QualType lhs, QualType rhs,
9544                                         bool OfBlockPointer, bool Unqualified,
9545                                         bool AllowCXX) {
9546   const auto *lbase = lhs->castAs<FunctionType>();
9547   const auto *rbase = rhs->castAs<FunctionType>();
9548   const auto *lproto = dyn_cast<FunctionProtoType>(lbase);
9549   const auto *rproto = dyn_cast<FunctionProtoType>(rbase);
9550   bool allLTypes = true;
9551   bool allRTypes = true;
9552 
9553   // Check return type
9554   QualType retType;
9555   if (OfBlockPointer) {
9556     QualType RHS = rbase->getReturnType();
9557     QualType LHS = lbase->getReturnType();
9558     bool UnqualifiedResult = Unqualified;
9559     if (!UnqualifiedResult)
9560       UnqualifiedResult = (!RHS.hasQualifiers() && LHS.hasQualifiers());
9561     retType = mergeTypes(LHS, RHS, true, UnqualifiedResult, true);
9562   }
9563   else
9564     retType = mergeTypes(lbase->getReturnType(), rbase->getReturnType(), false,
9565                          Unqualified);
9566   if (retType.isNull())
9567     return {};
9568 
9569   if (Unqualified)
9570     retType = retType.getUnqualifiedType();
9571 
9572   CanQualType LRetType = getCanonicalType(lbase->getReturnType());
9573   CanQualType RRetType = getCanonicalType(rbase->getReturnType());
9574   if (Unqualified) {
9575     LRetType = LRetType.getUnqualifiedType();
9576     RRetType = RRetType.getUnqualifiedType();
9577   }
9578 
9579   if (getCanonicalType(retType) != LRetType)
9580     allLTypes = false;
9581   if (getCanonicalType(retType) != RRetType)
9582     allRTypes = false;
9583 
9584   // FIXME: double check this
9585   // FIXME: should we error if lbase->getRegParmAttr() != 0 &&
9586   //                           rbase->getRegParmAttr() != 0 &&
9587   //                           lbase->getRegParmAttr() != rbase->getRegParmAttr()?
9588   FunctionType::ExtInfo lbaseInfo = lbase->getExtInfo();
9589   FunctionType::ExtInfo rbaseInfo = rbase->getExtInfo();
9590 
9591   // Compatible functions must have compatible calling conventions
9592   if (lbaseInfo.getCC() != rbaseInfo.getCC())
9593     return {};
9594 
9595   // Regparm is part of the calling convention.
9596   if (lbaseInfo.getHasRegParm() != rbaseInfo.getHasRegParm())
9597     return {};
9598   if (lbaseInfo.getRegParm() != rbaseInfo.getRegParm())
9599     return {};
9600 
9601   if (lbaseInfo.getProducesResult() != rbaseInfo.getProducesResult())
9602     return {};
9603   if (lbaseInfo.getNoCallerSavedRegs() != rbaseInfo.getNoCallerSavedRegs())
9604     return {};
9605   if (lbaseInfo.getNoCfCheck() != rbaseInfo.getNoCfCheck())
9606     return {};
9607 
9608   // FIXME: some uses, e.g. conditional exprs, really want this to be 'both'.
9609   bool NoReturn = lbaseInfo.getNoReturn() || rbaseInfo.getNoReturn();
9610 
9611   if (lbaseInfo.getNoReturn() != NoReturn)
9612     allLTypes = false;
9613   if (rbaseInfo.getNoReturn() != NoReturn)
9614     allRTypes = false;
9615 
9616   FunctionType::ExtInfo einfo = lbaseInfo.withNoReturn(NoReturn);
9617 
9618   if (lproto && rproto) { // two C99 style function prototypes
9619     assert((AllowCXX ||
9620             (!lproto->hasExceptionSpec() && !rproto->hasExceptionSpec())) &&
9621            "C++ shouldn't be here");
9622     // Compatible functions must have the same number of parameters
9623     if (lproto->getNumParams() != rproto->getNumParams())
9624       return {};
9625 
9626     // Variadic and non-variadic functions aren't compatible
9627     if (lproto->isVariadic() != rproto->isVariadic())
9628       return {};
9629 
9630     if (lproto->getMethodQuals() != rproto->getMethodQuals())
9631       return {};
9632 
9633     SmallVector<FunctionProtoType::ExtParameterInfo, 4> newParamInfos;
9634     bool canUseLeft, canUseRight;
9635     if (!mergeExtParameterInfo(lproto, rproto, canUseLeft, canUseRight,
9636                                newParamInfos))
9637       return {};
9638 
9639     if (!canUseLeft)
9640       allLTypes = false;
9641     if (!canUseRight)
9642       allRTypes = false;
9643 
9644     // Check parameter type compatibility
9645     SmallVector<QualType, 10> types;
9646     for (unsigned i = 0, n = lproto->getNumParams(); i < n; i++) {
9647       QualType lParamType = lproto->getParamType(i).getUnqualifiedType();
9648       QualType rParamType = rproto->getParamType(i).getUnqualifiedType();
9649       QualType paramType = mergeFunctionParameterTypes(
9650           lParamType, rParamType, OfBlockPointer, Unqualified);
9651       if (paramType.isNull())
9652         return {};
9653 
9654       if (Unqualified)
9655         paramType = paramType.getUnqualifiedType();
9656 
9657       types.push_back(paramType);
9658       if (Unqualified) {
9659         lParamType = lParamType.getUnqualifiedType();
9660         rParamType = rParamType.getUnqualifiedType();
9661       }
9662 
9663       if (getCanonicalType(paramType) != getCanonicalType(lParamType))
9664         allLTypes = false;
9665       if (getCanonicalType(paramType) != getCanonicalType(rParamType))
9666         allRTypes = false;
9667     }
9668 
9669     if (allLTypes) return lhs;
9670     if (allRTypes) return rhs;
9671 
9672     FunctionProtoType::ExtProtoInfo EPI = lproto->getExtProtoInfo();
9673     EPI.ExtInfo = einfo;
9674     EPI.ExtParameterInfos =
9675         newParamInfos.empty() ? nullptr : newParamInfos.data();
9676     return getFunctionType(retType, types, EPI);
9677   }
9678 
9679   if (lproto) allRTypes = false;
9680   if (rproto) allLTypes = false;
9681 
9682   const FunctionProtoType *proto = lproto ? lproto : rproto;
9683   if (proto) {
9684     assert((AllowCXX || !proto->hasExceptionSpec()) && "C++ shouldn't be here");
9685     if (proto->isVariadic())
9686       return {};
9687     // Check that the types are compatible with the types that
9688     // would result from default argument promotions (C99 6.7.5.3p15).
9689     // The only types actually affected are promotable integer
9690     // types and floats, which would be passed as a different
9691     // type depending on whether the prototype is visible.
9692     for (unsigned i = 0, n = proto->getNumParams(); i < n; ++i) {
9693       QualType paramTy = proto->getParamType(i);
9694 
9695       // Look at the converted type of enum types, since that is the type used
9696       // to pass enum values.
9697       if (const auto *Enum = paramTy->getAs<EnumType>()) {
9698         paramTy = Enum->getDecl()->getIntegerType();
9699         if (paramTy.isNull())
9700           return {};
9701       }
9702 
9703       if (paramTy->isPromotableIntegerType() ||
9704           getCanonicalType(paramTy).getUnqualifiedType() == FloatTy)
9705         return {};
9706     }
9707 
9708     if (allLTypes) return lhs;
9709     if (allRTypes) return rhs;
9710 
9711     FunctionProtoType::ExtProtoInfo EPI = proto->getExtProtoInfo();
9712     EPI.ExtInfo = einfo;
9713     return getFunctionType(retType, proto->getParamTypes(), EPI);
9714   }
9715 
9716   if (allLTypes) return lhs;
9717   if (allRTypes) return rhs;
9718   return getFunctionNoProtoType(retType, einfo);
9719 }
9720 
9721 /// Given that we have an enum type and a non-enum type, try to merge them.
9722 static QualType mergeEnumWithInteger(ASTContext &Context, const EnumType *ET,
9723                                      QualType other, bool isBlockReturnType) {
9724   // C99 6.7.2.2p4: Each enumerated type shall be compatible with char,
9725   // a signed integer type, or an unsigned integer type.
9726   // Compatibility is based on the underlying type, not the promotion
9727   // type.
9728   QualType underlyingType = ET->getDecl()->getIntegerType();
9729   if (underlyingType.isNull())
9730     return {};
9731   if (Context.hasSameType(underlyingType, other))
9732     return other;
9733 
9734   // In block return types, we're more permissive and accept any
9735   // integral type of the same size.
9736   if (isBlockReturnType && other->isIntegerType() &&
9737       Context.getTypeSize(underlyingType) == Context.getTypeSize(other))
9738     return other;
9739 
9740   return {};
9741 }
9742 
9743 QualType ASTContext::mergeTypes(QualType LHS, QualType RHS,
9744                                 bool OfBlockPointer,
9745                                 bool Unqualified, bool BlockReturnType) {
9746   // For C++ we will not reach this code with reference types (see below),
9747   // for OpenMP variant call overloading we might.
9748   //
9749   // C++ [expr]: If an expression initially has the type "reference to T", the
9750   // type is adjusted to "T" prior to any further analysis, the expression
9751   // designates the object or function denoted by the reference, and the
9752   // expression is an lvalue unless the reference is an rvalue reference and
9753   // the expression is a function call (possibly inside parentheses).
9754   if (LangOpts.OpenMP && LHS->getAs<ReferenceType>() &&
9755       RHS->getAs<ReferenceType>() && LHS->getTypeClass() == RHS->getTypeClass())
9756     return mergeTypes(LHS->getAs<ReferenceType>()->getPointeeType(),
9757                       RHS->getAs<ReferenceType>()->getPointeeType(),
9758                       OfBlockPointer, Unqualified, BlockReturnType);
9759   if (LHS->getAs<ReferenceType>() || RHS->getAs<ReferenceType>())
9760     return {};
9761 
9762   if (Unqualified) {
9763     LHS = LHS.getUnqualifiedType();
9764     RHS = RHS.getUnqualifiedType();
9765   }
9766 
9767   QualType LHSCan = getCanonicalType(LHS),
9768            RHSCan = getCanonicalType(RHS);
9769 
9770   // If two types are identical, they are compatible.
9771   if (LHSCan == RHSCan)
9772     return LHS;
9773 
9774   // If the qualifiers are different, the types aren't compatible... mostly.
9775   Qualifiers LQuals = LHSCan.getLocalQualifiers();
9776   Qualifiers RQuals = RHSCan.getLocalQualifiers();
9777   if (LQuals != RQuals) {
9778     // If any of these qualifiers are different, we have a type
9779     // mismatch.
9780     if (LQuals.getCVRQualifiers() != RQuals.getCVRQualifiers() ||
9781         LQuals.getAddressSpace() != RQuals.getAddressSpace() ||
9782         LQuals.getObjCLifetime() != RQuals.getObjCLifetime() ||
9783         LQuals.hasUnaligned() != RQuals.hasUnaligned())
9784       return {};
9785 
9786     // Exactly one GC qualifier difference is allowed: __strong is
9787     // okay if the other type has no GC qualifier but is an Objective
9788     // C object pointer (i.e. implicitly strong by default).  We fix
9789     // this by pretending that the unqualified type was actually
9790     // qualified __strong.
9791     Qualifiers::GC GC_L = LQuals.getObjCGCAttr();
9792     Qualifiers::GC GC_R = RQuals.getObjCGCAttr();
9793     assert((GC_L != GC_R) && "unequal qualifier sets had only equal elements");
9794 
9795     if (GC_L == Qualifiers::Weak || GC_R == Qualifiers::Weak)
9796       return {};
9797 
9798     if (GC_L == Qualifiers::Strong && RHSCan->isObjCObjectPointerType()) {
9799       return mergeTypes(LHS, getObjCGCQualType(RHS, Qualifiers::Strong));
9800     }
9801     if (GC_R == Qualifiers::Strong && LHSCan->isObjCObjectPointerType()) {
9802       return mergeTypes(getObjCGCQualType(LHS, Qualifiers::Strong), RHS);
9803     }
9804     return {};
9805   }
9806 
9807   // Okay, qualifiers are equal.
9808 
9809   Type::TypeClass LHSClass = LHSCan->getTypeClass();
9810   Type::TypeClass RHSClass = RHSCan->getTypeClass();
9811 
9812   // We want to consider the two function types to be the same for these
9813   // comparisons, just force one to the other.
9814   if (LHSClass == Type::FunctionProto) LHSClass = Type::FunctionNoProto;
9815   if (RHSClass == Type::FunctionProto) RHSClass = Type::FunctionNoProto;
9816 
9817   // Same as above for arrays
9818   if (LHSClass == Type::VariableArray || LHSClass == Type::IncompleteArray)
9819     LHSClass = Type::ConstantArray;
9820   if (RHSClass == Type::VariableArray || RHSClass == Type::IncompleteArray)
9821     RHSClass = Type::ConstantArray;
9822 
9823   // ObjCInterfaces are just specialized ObjCObjects.
9824   if (LHSClass == Type::ObjCInterface) LHSClass = Type::ObjCObject;
9825   if (RHSClass == Type::ObjCInterface) RHSClass = Type::ObjCObject;
9826 
9827   // Canonicalize ExtVector -> Vector.
9828   if (LHSClass == Type::ExtVector) LHSClass = Type::Vector;
9829   if (RHSClass == Type::ExtVector) RHSClass = Type::Vector;
9830 
9831   // If the canonical type classes don't match.
9832   if (LHSClass != RHSClass) {
9833     // Note that we only have special rules for turning block enum
9834     // returns into block int returns, not vice-versa.
9835     if (const auto *ETy = LHS->getAs<EnumType>()) {
9836       return mergeEnumWithInteger(*this, ETy, RHS, false);
9837     }
9838     if (const EnumType* ETy = RHS->getAs<EnumType>()) {
9839       return mergeEnumWithInteger(*this, ETy, LHS, BlockReturnType);
9840     }
9841     // allow block pointer type to match an 'id' type.
9842     if (OfBlockPointer && !BlockReturnType) {
9843        if (LHS->isObjCIdType() && RHS->isBlockPointerType())
9844          return LHS;
9845       if (RHS->isObjCIdType() && LHS->isBlockPointerType())
9846         return RHS;
9847     }
9848 
9849     return {};
9850   }
9851 
9852   // The canonical type classes match.
9853   switch (LHSClass) {
9854 #define TYPE(Class, Base)
9855 #define ABSTRACT_TYPE(Class, Base)
9856 #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base) case Type::Class:
9857 #define NON_CANONICAL_TYPE(Class, Base) case Type::Class:
9858 #define DEPENDENT_TYPE(Class, Base) case Type::Class:
9859 #include "clang/AST/TypeNodes.inc"
9860     llvm_unreachable("Non-canonical and dependent types shouldn't get here");
9861 
9862   case Type::Auto:
9863   case Type::DeducedTemplateSpecialization:
9864   case Type::LValueReference:
9865   case Type::RValueReference:
9866   case Type::MemberPointer:
9867     llvm_unreachable("C++ should never be in mergeTypes");
9868 
9869   case Type::ObjCInterface:
9870   case Type::IncompleteArray:
9871   case Type::VariableArray:
9872   case Type::FunctionProto:
9873   case Type::ExtVector:
9874     llvm_unreachable("Types are eliminated above");
9875 
9876   case Type::Pointer:
9877   {
9878     // Merge two pointer types, while trying to preserve typedef info
9879     QualType LHSPointee = LHS->castAs<PointerType>()->getPointeeType();
9880     QualType RHSPointee = RHS->castAs<PointerType>()->getPointeeType();
9881     if (Unqualified) {
9882       LHSPointee = LHSPointee.getUnqualifiedType();
9883       RHSPointee = RHSPointee.getUnqualifiedType();
9884     }
9885     QualType ResultType = mergeTypes(LHSPointee, RHSPointee, false,
9886                                      Unqualified);
9887     if (ResultType.isNull())
9888       return {};
9889     if (getCanonicalType(LHSPointee) == getCanonicalType(ResultType))
9890       return LHS;
9891     if (getCanonicalType(RHSPointee) == getCanonicalType(ResultType))
9892       return RHS;
9893     return getPointerType(ResultType);
9894   }
9895   case Type::BlockPointer:
9896   {
9897     // Merge two block pointer types, while trying to preserve typedef info
9898     QualType LHSPointee = LHS->castAs<BlockPointerType>()->getPointeeType();
9899     QualType RHSPointee = RHS->castAs<BlockPointerType>()->getPointeeType();
9900     if (Unqualified) {
9901       LHSPointee = LHSPointee.getUnqualifiedType();
9902       RHSPointee = RHSPointee.getUnqualifiedType();
9903     }
9904     if (getLangOpts().OpenCL) {
9905       Qualifiers LHSPteeQual = LHSPointee.getQualifiers();
9906       Qualifiers RHSPteeQual = RHSPointee.getQualifiers();
9907       // Blocks can't be an expression in a ternary operator (OpenCL v2.0
9908       // 6.12.5) thus the following check is asymmetric.
9909       if (!LHSPteeQual.isAddressSpaceSupersetOf(RHSPteeQual))
9910         return {};
9911       LHSPteeQual.removeAddressSpace();
9912       RHSPteeQual.removeAddressSpace();
9913       LHSPointee =
9914           QualType(LHSPointee.getTypePtr(), LHSPteeQual.getAsOpaqueValue());
9915       RHSPointee =
9916           QualType(RHSPointee.getTypePtr(), RHSPteeQual.getAsOpaqueValue());
9917     }
9918     QualType ResultType = mergeTypes(LHSPointee, RHSPointee, OfBlockPointer,
9919                                      Unqualified);
9920     if (ResultType.isNull())
9921       return {};
9922     if (getCanonicalType(LHSPointee) == getCanonicalType(ResultType))
9923       return LHS;
9924     if (getCanonicalType(RHSPointee) == getCanonicalType(ResultType))
9925       return RHS;
9926     return getBlockPointerType(ResultType);
9927   }
9928   case Type::Atomic:
9929   {
9930     // Merge two pointer types, while trying to preserve typedef info
9931     QualType LHSValue = LHS->castAs<AtomicType>()->getValueType();
9932     QualType RHSValue = RHS->castAs<AtomicType>()->getValueType();
9933     if (Unqualified) {
9934       LHSValue = LHSValue.getUnqualifiedType();
9935       RHSValue = RHSValue.getUnqualifiedType();
9936     }
9937     QualType ResultType = mergeTypes(LHSValue, RHSValue, false,
9938                                      Unqualified);
9939     if (ResultType.isNull())
9940       return {};
9941     if (getCanonicalType(LHSValue) == getCanonicalType(ResultType))
9942       return LHS;
9943     if (getCanonicalType(RHSValue) == getCanonicalType(ResultType))
9944       return RHS;
9945     return getAtomicType(ResultType);
9946   }
9947   case Type::ConstantArray:
9948   {
9949     const ConstantArrayType* LCAT = getAsConstantArrayType(LHS);
9950     const ConstantArrayType* RCAT = getAsConstantArrayType(RHS);
9951     if (LCAT && RCAT && RCAT->getSize() != LCAT->getSize())
9952       return {};
9953 
9954     QualType LHSElem = getAsArrayType(LHS)->getElementType();
9955     QualType RHSElem = getAsArrayType(RHS)->getElementType();
9956     if (Unqualified) {
9957       LHSElem = LHSElem.getUnqualifiedType();
9958       RHSElem = RHSElem.getUnqualifiedType();
9959     }
9960 
9961     QualType ResultType = mergeTypes(LHSElem, RHSElem, false, Unqualified);
9962     if (ResultType.isNull())
9963       return {};
9964 
9965     const VariableArrayType* LVAT = getAsVariableArrayType(LHS);
9966     const VariableArrayType* RVAT = getAsVariableArrayType(RHS);
9967 
9968     // If either side is a variable array, and both are complete, check whether
9969     // the current dimension is definite.
9970     if (LVAT || RVAT) {
9971       auto SizeFetch = [this](const VariableArrayType* VAT,
9972           const ConstantArrayType* CAT)
9973           -> std::pair<bool,llvm::APInt> {
9974         if (VAT) {
9975           Optional<llvm::APSInt> TheInt;
9976           Expr *E = VAT->getSizeExpr();
9977           if (E && (TheInt = E->getIntegerConstantExpr(*this)))
9978             return std::make_pair(true, *TheInt);
9979           return std::make_pair(false, llvm::APSInt());
9980         }
9981         if (CAT)
9982           return std::make_pair(true, CAT->getSize());
9983         return std::make_pair(false, llvm::APInt());
9984       };
9985 
9986       bool HaveLSize, HaveRSize;
9987       llvm::APInt LSize, RSize;
9988       std::tie(HaveLSize, LSize) = SizeFetch(LVAT, LCAT);
9989       std::tie(HaveRSize, RSize) = SizeFetch(RVAT, RCAT);
9990       if (HaveLSize && HaveRSize && !llvm::APInt::isSameValue(LSize, RSize))
9991         return {}; // Definite, but unequal, array dimension
9992     }
9993 
9994     if (LCAT && getCanonicalType(LHSElem) == getCanonicalType(ResultType))
9995       return LHS;
9996     if (RCAT && getCanonicalType(RHSElem) == getCanonicalType(ResultType))
9997       return RHS;
9998     if (LCAT)
9999       return getConstantArrayType(ResultType, LCAT->getSize(),
10000                                   LCAT->getSizeExpr(),
10001                                   ArrayType::ArraySizeModifier(), 0);
10002     if (RCAT)
10003       return getConstantArrayType(ResultType, RCAT->getSize(),
10004                                   RCAT->getSizeExpr(),
10005                                   ArrayType::ArraySizeModifier(), 0);
10006     if (LVAT && getCanonicalType(LHSElem) == getCanonicalType(ResultType))
10007       return LHS;
10008     if (RVAT && getCanonicalType(RHSElem) == getCanonicalType(ResultType))
10009       return RHS;
10010     if (LVAT) {
10011       // FIXME: This isn't correct! But tricky to implement because
10012       // the array's size has to be the size of LHS, but the type
10013       // has to be different.
10014       return LHS;
10015     }
10016     if (RVAT) {
10017       // FIXME: This isn't correct! But tricky to implement because
10018       // the array's size has to be the size of RHS, but the type
10019       // has to be different.
10020       return RHS;
10021     }
10022     if (getCanonicalType(LHSElem) == getCanonicalType(ResultType)) return LHS;
10023     if (getCanonicalType(RHSElem) == getCanonicalType(ResultType)) return RHS;
10024     return getIncompleteArrayType(ResultType,
10025                                   ArrayType::ArraySizeModifier(), 0);
10026   }
10027   case Type::FunctionNoProto:
10028     return mergeFunctionTypes(LHS, RHS, OfBlockPointer, Unqualified);
10029   case Type::Record:
10030   case Type::Enum:
10031     return {};
10032   case Type::Builtin:
10033     // Only exactly equal builtin types are compatible, which is tested above.
10034     return {};
10035   case Type::Complex:
10036     // Distinct complex types are incompatible.
10037     return {};
10038   case Type::Vector:
10039     // FIXME: The merged type should be an ExtVector!
10040     if (areCompatVectorTypes(LHSCan->castAs<VectorType>(),
10041                              RHSCan->castAs<VectorType>()))
10042       return LHS;
10043     return {};
10044   case Type::ConstantMatrix:
10045     if (areCompatMatrixTypes(LHSCan->castAs<ConstantMatrixType>(),
10046                              RHSCan->castAs<ConstantMatrixType>()))
10047       return LHS;
10048     return {};
10049   case Type::ObjCObject: {
10050     // Check if the types are assignment compatible.
10051     // FIXME: This should be type compatibility, e.g. whether
10052     // "LHS x; RHS x;" at global scope is legal.
10053     if (canAssignObjCInterfaces(LHS->castAs<ObjCObjectType>(),
10054                                 RHS->castAs<ObjCObjectType>()))
10055       return LHS;
10056     return {};
10057   }
10058   case Type::ObjCObjectPointer:
10059     if (OfBlockPointer) {
10060       if (canAssignObjCInterfacesInBlockPointer(
10061               LHS->castAs<ObjCObjectPointerType>(),
10062               RHS->castAs<ObjCObjectPointerType>(), BlockReturnType))
10063         return LHS;
10064       return {};
10065     }
10066     if (canAssignObjCInterfaces(LHS->castAs<ObjCObjectPointerType>(),
10067                                 RHS->castAs<ObjCObjectPointerType>()))
10068       return LHS;
10069     return {};
10070   case Type::Pipe:
10071     assert(LHS != RHS &&
10072            "Equivalent pipe types should have already been handled!");
10073     return {};
10074   case Type::ExtInt: {
10075     // Merge two ext-int types, while trying to preserve typedef info.
10076     bool LHSUnsigned  = LHS->castAs<ExtIntType>()->isUnsigned();
10077     bool RHSUnsigned = RHS->castAs<ExtIntType>()->isUnsigned();
10078     unsigned LHSBits = LHS->castAs<ExtIntType>()->getNumBits();
10079     unsigned RHSBits = RHS->castAs<ExtIntType>()->getNumBits();
10080 
10081     // Like unsigned/int, shouldn't have a type if they don't match.
10082     if (LHSUnsigned != RHSUnsigned)
10083       return {};
10084 
10085     if (LHSBits != RHSBits)
10086       return {};
10087     return LHS;
10088   }
10089   }
10090 
10091   llvm_unreachable("Invalid Type::Class!");
10092 }
10093 
10094 bool ASTContext::mergeExtParameterInfo(
10095     const FunctionProtoType *FirstFnType, const FunctionProtoType *SecondFnType,
10096     bool &CanUseFirst, bool &CanUseSecond,
10097     SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &NewParamInfos) {
10098   assert(NewParamInfos.empty() && "param info list not empty");
10099   CanUseFirst = CanUseSecond = true;
10100   bool FirstHasInfo = FirstFnType->hasExtParameterInfos();
10101   bool SecondHasInfo = SecondFnType->hasExtParameterInfos();
10102 
10103   // Fast path: if the first type doesn't have ext parameter infos,
10104   // we match if and only if the second type also doesn't have them.
10105   if (!FirstHasInfo && !SecondHasInfo)
10106     return true;
10107 
10108   bool NeedParamInfo = false;
10109   size_t E = FirstHasInfo ? FirstFnType->getExtParameterInfos().size()
10110                           : SecondFnType->getExtParameterInfos().size();
10111 
10112   for (size_t I = 0; I < E; ++I) {
10113     FunctionProtoType::ExtParameterInfo FirstParam, SecondParam;
10114     if (FirstHasInfo)
10115       FirstParam = FirstFnType->getExtParameterInfo(I);
10116     if (SecondHasInfo)
10117       SecondParam = SecondFnType->getExtParameterInfo(I);
10118 
10119     // Cannot merge unless everything except the noescape flag matches.
10120     if (FirstParam.withIsNoEscape(false) != SecondParam.withIsNoEscape(false))
10121       return false;
10122 
10123     bool FirstNoEscape = FirstParam.isNoEscape();
10124     bool SecondNoEscape = SecondParam.isNoEscape();
10125     bool IsNoEscape = FirstNoEscape && SecondNoEscape;
10126     NewParamInfos.push_back(FirstParam.withIsNoEscape(IsNoEscape));
10127     if (NewParamInfos.back().getOpaqueValue())
10128       NeedParamInfo = true;
10129     if (FirstNoEscape != IsNoEscape)
10130       CanUseFirst = false;
10131     if (SecondNoEscape != IsNoEscape)
10132       CanUseSecond = false;
10133   }
10134 
10135   if (!NeedParamInfo)
10136     NewParamInfos.clear();
10137 
10138   return true;
10139 }
10140 
10141 void ASTContext::ResetObjCLayout(const ObjCContainerDecl *CD) {
10142   ObjCLayouts[CD] = nullptr;
10143 }
10144 
10145 /// mergeObjCGCQualifiers - This routine merges ObjC's GC attribute of 'LHS' and
10146 /// 'RHS' attributes and returns the merged version; including for function
10147 /// return types.
10148 QualType ASTContext::mergeObjCGCQualifiers(QualType LHS, QualType RHS) {
10149   QualType LHSCan = getCanonicalType(LHS),
10150   RHSCan = getCanonicalType(RHS);
10151   // If two types are identical, they are compatible.
10152   if (LHSCan == RHSCan)
10153     return LHS;
10154   if (RHSCan->isFunctionType()) {
10155     if (!LHSCan->isFunctionType())
10156       return {};
10157     QualType OldReturnType =
10158         cast<FunctionType>(RHSCan.getTypePtr())->getReturnType();
10159     QualType NewReturnType =
10160         cast<FunctionType>(LHSCan.getTypePtr())->getReturnType();
10161     QualType ResReturnType =
10162       mergeObjCGCQualifiers(NewReturnType, OldReturnType);
10163     if (ResReturnType.isNull())
10164       return {};
10165     if (ResReturnType == NewReturnType || ResReturnType == OldReturnType) {
10166       // id foo(); ... __strong id foo(); or: __strong id foo(); ... id foo();
10167       // In either case, use OldReturnType to build the new function type.
10168       const auto *F = LHS->castAs<FunctionType>();
10169       if (const auto *FPT = cast<FunctionProtoType>(F)) {
10170         FunctionProtoType::ExtProtoInfo EPI = FPT->getExtProtoInfo();
10171         EPI.ExtInfo = getFunctionExtInfo(LHS);
10172         QualType ResultType =
10173             getFunctionType(OldReturnType, FPT->getParamTypes(), EPI);
10174         return ResultType;
10175       }
10176     }
10177     return {};
10178   }
10179 
10180   // If the qualifiers are different, the types can still be merged.
10181   Qualifiers LQuals = LHSCan.getLocalQualifiers();
10182   Qualifiers RQuals = RHSCan.getLocalQualifiers();
10183   if (LQuals != RQuals) {
10184     // If any of these qualifiers are different, we have a type mismatch.
10185     if (LQuals.getCVRQualifiers() != RQuals.getCVRQualifiers() ||
10186         LQuals.getAddressSpace() != RQuals.getAddressSpace())
10187       return {};
10188 
10189     // Exactly one GC qualifier difference is allowed: __strong is
10190     // okay if the other type has no GC qualifier but is an Objective
10191     // C object pointer (i.e. implicitly strong by default).  We fix
10192     // this by pretending that the unqualified type was actually
10193     // qualified __strong.
10194     Qualifiers::GC GC_L = LQuals.getObjCGCAttr();
10195     Qualifiers::GC GC_R = RQuals.getObjCGCAttr();
10196     assert((GC_L != GC_R) && "unequal qualifier sets had only equal elements");
10197 
10198     if (GC_L == Qualifiers::Weak || GC_R == Qualifiers::Weak)
10199       return {};
10200 
10201     if (GC_L == Qualifiers::Strong)
10202       return LHS;
10203     if (GC_R == Qualifiers::Strong)
10204       return RHS;
10205     return {};
10206   }
10207 
10208   if (LHSCan->isObjCObjectPointerType() && RHSCan->isObjCObjectPointerType()) {
10209     QualType LHSBaseQT = LHS->castAs<ObjCObjectPointerType>()->getPointeeType();
10210     QualType RHSBaseQT = RHS->castAs<ObjCObjectPointerType>()->getPointeeType();
10211     QualType ResQT = mergeObjCGCQualifiers(LHSBaseQT, RHSBaseQT);
10212     if (ResQT == LHSBaseQT)
10213       return LHS;
10214     if (ResQT == RHSBaseQT)
10215       return RHS;
10216   }
10217   return {};
10218 }
10219 
10220 //===----------------------------------------------------------------------===//
10221 //                         Integer Predicates
10222 //===----------------------------------------------------------------------===//
10223 
10224 unsigned ASTContext::getIntWidth(QualType T) const {
10225   if (const auto *ET = T->getAs<EnumType>())
10226     T = ET->getDecl()->getIntegerType();
10227   if (T->isBooleanType())
10228     return 1;
10229   if(const auto *EIT = T->getAs<ExtIntType>())
10230     return EIT->getNumBits();
10231   // For builtin types, just use the standard type sizing method
10232   return (unsigned)getTypeSize(T);
10233 }
10234 
10235 QualType ASTContext::getCorrespondingUnsignedType(QualType T) const {
10236   assert((T->hasSignedIntegerRepresentation() || T->isSignedFixedPointType()) &&
10237          "Unexpected type");
10238 
10239   // Turn <4 x signed int> -> <4 x unsigned int>
10240   if (const auto *VTy = T->getAs<VectorType>())
10241     return getVectorType(getCorrespondingUnsignedType(VTy->getElementType()),
10242                          VTy->getNumElements(), VTy->getVectorKind());
10243 
10244   // For _ExtInt, return an unsigned _ExtInt with same width.
10245   if (const auto *EITy = T->getAs<ExtIntType>())
10246     return getExtIntType(/*IsUnsigned=*/true, EITy->getNumBits());
10247 
10248   // For enums, get the underlying integer type of the enum, and let the general
10249   // integer type signchanging code handle it.
10250   if (const auto *ETy = T->getAs<EnumType>())
10251     T = ETy->getDecl()->getIntegerType();
10252 
10253   switch (T->castAs<BuiltinType>()->getKind()) {
10254   case BuiltinType::Char_S:
10255   case BuiltinType::SChar:
10256     return UnsignedCharTy;
10257   case BuiltinType::Short:
10258     return UnsignedShortTy;
10259   case BuiltinType::Int:
10260     return UnsignedIntTy;
10261   case BuiltinType::Long:
10262     return UnsignedLongTy;
10263   case BuiltinType::LongLong:
10264     return UnsignedLongLongTy;
10265   case BuiltinType::Int128:
10266     return UnsignedInt128Ty;
10267   // wchar_t is special. It is either signed or not, but when it's signed,
10268   // there's no matching "unsigned wchar_t". Therefore we return the unsigned
10269   // version of it's underlying type instead.
10270   case BuiltinType::WChar_S:
10271     return getUnsignedWCharType();
10272 
10273   case BuiltinType::ShortAccum:
10274     return UnsignedShortAccumTy;
10275   case BuiltinType::Accum:
10276     return UnsignedAccumTy;
10277   case BuiltinType::LongAccum:
10278     return UnsignedLongAccumTy;
10279   case BuiltinType::SatShortAccum:
10280     return SatUnsignedShortAccumTy;
10281   case BuiltinType::SatAccum:
10282     return SatUnsignedAccumTy;
10283   case BuiltinType::SatLongAccum:
10284     return SatUnsignedLongAccumTy;
10285   case BuiltinType::ShortFract:
10286     return UnsignedShortFractTy;
10287   case BuiltinType::Fract:
10288     return UnsignedFractTy;
10289   case BuiltinType::LongFract:
10290     return UnsignedLongFractTy;
10291   case BuiltinType::SatShortFract:
10292     return SatUnsignedShortFractTy;
10293   case BuiltinType::SatFract:
10294     return SatUnsignedFractTy;
10295   case BuiltinType::SatLongFract:
10296     return SatUnsignedLongFractTy;
10297   default:
10298     llvm_unreachable("Unexpected signed integer or fixed point type");
10299   }
10300 }
10301 
10302 QualType ASTContext::getCorrespondingSignedType(QualType T) const {
10303   assert((T->hasUnsignedIntegerRepresentation() ||
10304           T->isUnsignedFixedPointType()) &&
10305          "Unexpected type");
10306 
10307   // Turn <4 x unsigned int> -> <4 x signed int>
10308   if (const auto *VTy = T->getAs<VectorType>())
10309     return getVectorType(getCorrespondingSignedType(VTy->getElementType()),
10310                          VTy->getNumElements(), VTy->getVectorKind());
10311 
10312   // For _ExtInt, return a signed _ExtInt with same width.
10313   if (const auto *EITy = T->getAs<ExtIntType>())
10314     return getExtIntType(/*IsUnsigned=*/false, EITy->getNumBits());
10315 
10316   // For enums, get the underlying integer type of the enum, and let the general
10317   // integer type signchanging code handle it.
10318   if (const auto *ETy = T->getAs<EnumType>())
10319     T = ETy->getDecl()->getIntegerType();
10320 
10321   switch (T->castAs<BuiltinType>()->getKind()) {
10322   case BuiltinType::Char_U:
10323   case BuiltinType::UChar:
10324     return SignedCharTy;
10325   case BuiltinType::UShort:
10326     return ShortTy;
10327   case BuiltinType::UInt:
10328     return IntTy;
10329   case BuiltinType::ULong:
10330     return LongTy;
10331   case BuiltinType::ULongLong:
10332     return LongLongTy;
10333   case BuiltinType::UInt128:
10334     return Int128Ty;
10335   // wchar_t is special. It is either unsigned or not, but when it's unsigned,
10336   // there's no matching "signed wchar_t". Therefore we return the signed
10337   // version of it's underlying type instead.
10338   case BuiltinType::WChar_U:
10339     return getSignedWCharType();
10340 
10341   case BuiltinType::UShortAccum:
10342     return ShortAccumTy;
10343   case BuiltinType::UAccum:
10344     return AccumTy;
10345   case BuiltinType::ULongAccum:
10346     return LongAccumTy;
10347   case BuiltinType::SatUShortAccum:
10348     return SatShortAccumTy;
10349   case BuiltinType::SatUAccum:
10350     return SatAccumTy;
10351   case BuiltinType::SatULongAccum:
10352     return SatLongAccumTy;
10353   case BuiltinType::UShortFract:
10354     return ShortFractTy;
10355   case BuiltinType::UFract:
10356     return FractTy;
10357   case BuiltinType::ULongFract:
10358     return LongFractTy;
10359   case BuiltinType::SatUShortFract:
10360     return SatShortFractTy;
10361   case BuiltinType::SatUFract:
10362     return SatFractTy;
10363   case BuiltinType::SatULongFract:
10364     return SatLongFractTy;
10365   default:
10366     llvm_unreachable("Unexpected unsigned integer or fixed point type");
10367   }
10368 }
10369 
10370 ASTMutationListener::~ASTMutationListener() = default;
10371 
10372 void ASTMutationListener::DeducedReturnType(const FunctionDecl *FD,
10373                                             QualType ReturnType) {}
10374 
10375 //===----------------------------------------------------------------------===//
10376 //                          Builtin Type Computation
10377 //===----------------------------------------------------------------------===//
10378 
10379 /// DecodeTypeFromStr - This decodes one type descriptor from Str, advancing the
10380 /// pointer over the consumed characters.  This returns the resultant type.  If
10381 /// AllowTypeModifiers is false then modifier like * are not parsed, just basic
10382 /// types.  This allows "v2i*" to be parsed as a pointer to a v2i instead of
10383 /// a vector of "i*".
10384 ///
10385 /// RequiresICE is filled in on return to indicate whether the value is required
10386 /// to be an Integer Constant Expression.
10387 static QualType DecodeTypeFromStr(const char *&Str, const ASTContext &Context,
10388                                   ASTContext::GetBuiltinTypeError &Error,
10389                                   bool &RequiresICE,
10390                                   bool AllowTypeModifiers) {
10391   // Modifiers.
10392   int HowLong = 0;
10393   bool Signed = false, Unsigned = false;
10394   RequiresICE = false;
10395 
10396   // Read the prefixed modifiers first.
10397   bool Done = false;
10398   #ifndef NDEBUG
10399   bool IsSpecial = false;
10400   #endif
10401   while (!Done) {
10402     switch (*Str++) {
10403     default: Done = true; --Str; break;
10404     case 'I':
10405       RequiresICE = true;
10406       break;
10407     case 'S':
10408       assert(!Unsigned && "Can't use both 'S' and 'U' modifiers!");
10409       assert(!Signed && "Can't use 'S' modifier multiple times!");
10410       Signed = true;
10411       break;
10412     case 'U':
10413       assert(!Signed && "Can't use both 'S' and 'U' modifiers!");
10414       assert(!Unsigned && "Can't use 'U' modifier multiple times!");
10415       Unsigned = true;
10416       break;
10417     case 'L':
10418       assert(!IsSpecial && "Can't use 'L' with 'W', 'N', 'Z' or 'O' modifiers");
10419       assert(HowLong <= 2 && "Can't have LLLL modifier");
10420       ++HowLong;
10421       break;
10422     case 'N':
10423       // 'N' behaves like 'L' for all non LP64 targets and 'int' otherwise.
10424       assert(!IsSpecial && "Can't use two 'N', 'W', 'Z' or 'O' modifiers!");
10425       assert(HowLong == 0 && "Can't use both 'L' and 'N' modifiers!");
10426       #ifndef NDEBUG
10427       IsSpecial = true;
10428       #endif
10429       if (Context.getTargetInfo().getLongWidth() == 32)
10430         ++HowLong;
10431       break;
10432     case 'W':
10433       // This modifier represents int64 type.
10434       assert(!IsSpecial && "Can't use two 'N', 'W', 'Z' or 'O' modifiers!");
10435       assert(HowLong == 0 && "Can't use both 'L' and 'W' modifiers!");
10436       #ifndef NDEBUG
10437       IsSpecial = true;
10438       #endif
10439       switch (Context.getTargetInfo().getInt64Type()) {
10440       default:
10441         llvm_unreachable("Unexpected integer type");
10442       case TargetInfo::SignedLong:
10443         HowLong = 1;
10444         break;
10445       case TargetInfo::SignedLongLong:
10446         HowLong = 2;
10447         break;
10448       }
10449       break;
10450     case 'Z':
10451       // This modifier represents int32 type.
10452       assert(!IsSpecial && "Can't use two 'N', 'W', 'Z' or 'O' modifiers!");
10453       assert(HowLong == 0 && "Can't use both 'L' and 'Z' modifiers!");
10454       #ifndef NDEBUG
10455       IsSpecial = true;
10456       #endif
10457       switch (Context.getTargetInfo().getIntTypeByWidth(32, true)) {
10458       default:
10459         llvm_unreachable("Unexpected integer type");
10460       case TargetInfo::SignedInt:
10461         HowLong = 0;
10462         break;
10463       case TargetInfo::SignedLong:
10464         HowLong = 1;
10465         break;
10466       case TargetInfo::SignedLongLong:
10467         HowLong = 2;
10468         break;
10469       }
10470       break;
10471     case 'O':
10472       assert(!IsSpecial && "Can't use two 'N', 'W', 'Z' or 'O' modifiers!");
10473       assert(HowLong == 0 && "Can't use both 'L' and 'O' modifiers!");
10474       #ifndef NDEBUG
10475       IsSpecial = true;
10476       #endif
10477       if (Context.getLangOpts().OpenCL)
10478         HowLong = 1;
10479       else
10480         HowLong = 2;
10481       break;
10482     }
10483   }
10484 
10485   QualType Type;
10486 
10487   // Read the base type.
10488   switch (*Str++) {
10489   default: llvm_unreachable("Unknown builtin type letter!");
10490   case 'x':
10491     assert(HowLong == 0 && !Signed && !Unsigned &&
10492            "Bad modifiers used with 'x'!");
10493     Type = Context.Float16Ty;
10494     break;
10495   case 'y':
10496     assert(HowLong == 0 && !Signed && !Unsigned &&
10497            "Bad modifiers used with 'y'!");
10498     Type = Context.BFloat16Ty;
10499     break;
10500   case 'v':
10501     assert(HowLong == 0 && !Signed && !Unsigned &&
10502            "Bad modifiers used with 'v'!");
10503     Type = Context.VoidTy;
10504     break;
10505   case 'h':
10506     assert(HowLong == 0 && !Signed && !Unsigned &&
10507            "Bad modifiers used with 'h'!");
10508     Type = Context.HalfTy;
10509     break;
10510   case 'f':
10511     assert(HowLong == 0 && !Signed && !Unsigned &&
10512            "Bad modifiers used with 'f'!");
10513     Type = Context.FloatTy;
10514     break;
10515   case 'd':
10516     assert(HowLong < 3 && !Signed && !Unsigned &&
10517            "Bad modifiers used with 'd'!");
10518     if (HowLong == 1)
10519       Type = Context.LongDoubleTy;
10520     else if (HowLong == 2)
10521       Type = Context.Float128Ty;
10522     else
10523       Type = Context.DoubleTy;
10524     break;
10525   case 's':
10526     assert(HowLong == 0 && "Bad modifiers used with 's'!");
10527     if (Unsigned)
10528       Type = Context.UnsignedShortTy;
10529     else
10530       Type = Context.ShortTy;
10531     break;
10532   case 'i':
10533     if (HowLong == 3)
10534       Type = Unsigned ? Context.UnsignedInt128Ty : Context.Int128Ty;
10535     else if (HowLong == 2)
10536       Type = Unsigned ? Context.UnsignedLongLongTy : Context.LongLongTy;
10537     else if (HowLong == 1)
10538       Type = Unsigned ? Context.UnsignedLongTy : Context.LongTy;
10539     else
10540       Type = Unsigned ? Context.UnsignedIntTy : Context.IntTy;
10541     break;
10542   case 'c':
10543     assert(HowLong == 0 && "Bad modifiers used with 'c'!");
10544     if (Signed)
10545       Type = Context.SignedCharTy;
10546     else if (Unsigned)
10547       Type = Context.UnsignedCharTy;
10548     else
10549       Type = Context.CharTy;
10550     break;
10551   case 'b': // boolean
10552     assert(HowLong == 0 && !Signed && !Unsigned && "Bad modifiers for 'b'!");
10553     Type = Context.BoolTy;
10554     break;
10555   case 'z':  // size_t.
10556     assert(HowLong == 0 && !Signed && !Unsigned && "Bad modifiers for 'z'!");
10557     Type = Context.getSizeType();
10558     break;
10559   case 'w':  // wchar_t.
10560     assert(HowLong == 0 && !Signed && !Unsigned && "Bad modifiers for 'w'!");
10561     Type = Context.getWideCharType();
10562     break;
10563   case 'F':
10564     Type = Context.getCFConstantStringType();
10565     break;
10566   case 'G':
10567     Type = Context.getObjCIdType();
10568     break;
10569   case 'H':
10570     Type = Context.getObjCSelType();
10571     break;
10572   case 'M':
10573     Type = Context.getObjCSuperType();
10574     break;
10575   case 'a':
10576     Type = Context.getBuiltinVaListType();
10577     assert(!Type.isNull() && "builtin va list type not initialized!");
10578     break;
10579   case 'A':
10580     // This is a "reference" to a va_list; however, what exactly
10581     // this means depends on how va_list is defined. There are two
10582     // different kinds of va_list: ones passed by value, and ones
10583     // passed by reference.  An example of a by-value va_list is
10584     // x86, where va_list is a char*. An example of by-ref va_list
10585     // is x86-64, where va_list is a __va_list_tag[1]. For x86,
10586     // we want this argument to be a char*&; for x86-64, we want
10587     // it to be a __va_list_tag*.
10588     Type = Context.getBuiltinVaListType();
10589     assert(!Type.isNull() && "builtin va list type not initialized!");
10590     if (Type->isArrayType())
10591       Type = Context.getArrayDecayedType(Type);
10592     else
10593       Type = Context.getLValueReferenceType(Type);
10594     break;
10595   case 'q': {
10596     char *End;
10597     unsigned NumElements = strtoul(Str, &End, 10);
10598     assert(End != Str && "Missing vector size");
10599     Str = End;
10600 
10601     QualType ElementType = DecodeTypeFromStr(Str, Context, Error,
10602                                              RequiresICE, false);
10603     assert(!RequiresICE && "Can't require vector ICE");
10604 
10605     Type = Context.getScalableVectorType(ElementType, NumElements);
10606     break;
10607   }
10608   case 'V': {
10609     char *End;
10610     unsigned NumElements = strtoul(Str, &End, 10);
10611     assert(End != Str && "Missing vector size");
10612     Str = End;
10613 
10614     QualType ElementType = DecodeTypeFromStr(Str, Context, Error,
10615                                              RequiresICE, false);
10616     assert(!RequiresICE && "Can't require vector ICE");
10617 
10618     // TODO: No way to make AltiVec vectors in builtins yet.
10619     Type = Context.getVectorType(ElementType, NumElements,
10620                                  VectorType::GenericVector);
10621     break;
10622   }
10623   case 'E': {
10624     char *End;
10625 
10626     unsigned NumElements = strtoul(Str, &End, 10);
10627     assert(End != Str && "Missing vector size");
10628 
10629     Str = End;
10630 
10631     QualType ElementType = DecodeTypeFromStr(Str, Context, Error, RequiresICE,
10632                                              false);
10633     Type = Context.getExtVectorType(ElementType, NumElements);
10634     break;
10635   }
10636   case 'X': {
10637     QualType ElementType = DecodeTypeFromStr(Str, Context, Error, RequiresICE,
10638                                              false);
10639     assert(!RequiresICE && "Can't require complex ICE");
10640     Type = Context.getComplexType(ElementType);
10641     break;
10642   }
10643   case 'Y':
10644     Type = Context.getPointerDiffType();
10645     break;
10646   case 'P':
10647     Type = Context.getFILEType();
10648     if (Type.isNull()) {
10649       Error = ASTContext::GE_Missing_stdio;
10650       return {};
10651     }
10652     break;
10653   case 'J':
10654     if (Signed)
10655       Type = Context.getsigjmp_bufType();
10656     else
10657       Type = Context.getjmp_bufType();
10658 
10659     if (Type.isNull()) {
10660       Error = ASTContext::GE_Missing_setjmp;
10661       return {};
10662     }
10663     break;
10664   case 'K':
10665     assert(HowLong == 0 && !Signed && !Unsigned && "Bad modifiers for 'K'!");
10666     Type = Context.getucontext_tType();
10667 
10668     if (Type.isNull()) {
10669       Error = ASTContext::GE_Missing_ucontext;
10670       return {};
10671     }
10672     break;
10673   case 'p':
10674     Type = Context.getProcessIDType();
10675     break;
10676   }
10677 
10678   // If there are modifiers and if we're allowed to parse them, go for it.
10679   Done = !AllowTypeModifiers;
10680   while (!Done) {
10681     switch (char c = *Str++) {
10682     default: Done = true; --Str; break;
10683     case '*':
10684     case '&': {
10685       // Both pointers and references can have their pointee types
10686       // qualified with an address space.
10687       char *End;
10688       unsigned AddrSpace = strtoul(Str, &End, 10);
10689       if (End != Str) {
10690         // Note AddrSpace == 0 is not the same as an unspecified address space.
10691         Type = Context.getAddrSpaceQualType(
10692           Type,
10693           Context.getLangASForBuiltinAddressSpace(AddrSpace));
10694         Str = End;
10695       }
10696       if (c == '*')
10697         Type = Context.getPointerType(Type);
10698       else
10699         Type = Context.getLValueReferenceType(Type);
10700       break;
10701     }
10702     // FIXME: There's no way to have a built-in with an rvalue ref arg.
10703     case 'C':
10704       Type = Type.withConst();
10705       break;
10706     case 'D':
10707       Type = Context.getVolatileType(Type);
10708       break;
10709     case 'R':
10710       Type = Type.withRestrict();
10711       break;
10712     }
10713   }
10714 
10715   assert((!RequiresICE || Type->isIntegralOrEnumerationType()) &&
10716          "Integer constant 'I' type must be an integer");
10717 
10718   return Type;
10719 }
10720 
10721 // On some targets such as PowerPC, some of the builtins are defined with custom
10722 // type descriptors for target-dependent types. These descriptors are decoded in
10723 // other functions, but it may be useful to be able to fall back to default
10724 // descriptor decoding to define builtins mixing target-dependent and target-
10725 // independent types. This function allows decoding one type descriptor with
10726 // default decoding.
10727 QualType ASTContext::DecodeTypeStr(const char *&Str, const ASTContext &Context,
10728                                    GetBuiltinTypeError &Error, bool &RequireICE,
10729                                    bool AllowTypeModifiers) const {
10730   return DecodeTypeFromStr(Str, Context, Error, RequireICE, AllowTypeModifiers);
10731 }
10732 
10733 /// GetBuiltinType - Return the type for the specified builtin.
10734 QualType ASTContext::GetBuiltinType(unsigned Id,
10735                                     GetBuiltinTypeError &Error,
10736                                     unsigned *IntegerConstantArgs) const {
10737   const char *TypeStr = BuiltinInfo.getTypeString(Id);
10738   if (TypeStr[0] == '\0') {
10739     Error = GE_Missing_type;
10740     return {};
10741   }
10742 
10743   SmallVector<QualType, 8> ArgTypes;
10744 
10745   bool RequiresICE = false;
10746   Error = GE_None;
10747   QualType ResType = DecodeTypeFromStr(TypeStr, *this, Error,
10748                                        RequiresICE, true);
10749   if (Error != GE_None)
10750     return {};
10751 
10752   assert(!RequiresICE && "Result of intrinsic cannot be required to be an ICE");
10753 
10754   while (TypeStr[0] && TypeStr[0] != '.') {
10755     QualType Ty = DecodeTypeFromStr(TypeStr, *this, Error, RequiresICE, true);
10756     if (Error != GE_None)
10757       return {};
10758 
10759     // If this argument is required to be an IntegerConstantExpression and the
10760     // caller cares, fill in the bitmask we return.
10761     if (RequiresICE && IntegerConstantArgs)
10762       *IntegerConstantArgs |= 1 << ArgTypes.size();
10763 
10764     // Do array -> pointer decay.  The builtin should use the decayed type.
10765     if (Ty->isArrayType())
10766       Ty = getArrayDecayedType(Ty);
10767 
10768     ArgTypes.push_back(Ty);
10769   }
10770 
10771   if (Id == Builtin::BI__GetExceptionInfo)
10772     return {};
10773 
10774   assert((TypeStr[0] != '.' || TypeStr[1] == 0) &&
10775          "'.' should only occur at end of builtin type list!");
10776 
10777   bool Variadic = (TypeStr[0] == '.');
10778 
10779   FunctionType::ExtInfo EI(getDefaultCallingConvention(
10780       Variadic, /*IsCXXMethod=*/false, /*IsBuiltin=*/true));
10781   if (BuiltinInfo.isNoReturn(Id)) EI = EI.withNoReturn(true);
10782 
10783 
10784   // We really shouldn't be making a no-proto type here.
10785   if (ArgTypes.empty() && Variadic && !getLangOpts().CPlusPlus)
10786     return getFunctionNoProtoType(ResType, EI);
10787 
10788   FunctionProtoType::ExtProtoInfo EPI;
10789   EPI.ExtInfo = EI;
10790   EPI.Variadic = Variadic;
10791   if (getLangOpts().CPlusPlus && BuiltinInfo.isNoThrow(Id))
10792     EPI.ExceptionSpec.Type =
10793         getLangOpts().CPlusPlus11 ? EST_BasicNoexcept : EST_DynamicNone;
10794 
10795   return getFunctionType(ResType, ArgTypes, EPI);
10796 }
10797 
10798 static GVALinkage basicGVALinkageForFunction(const ASTContext &Context,
10799                                              const FunctionDecl *FD) {
10800   if (!FD->isExternallyVisible())
10801     return GVA_Internal;
10802 
10803   // Non-user-provided functions get emitted as weak definitions with every
10804   // use, no matter whether they've been explicitly instantiated etc.
10805   if (const auto *MD = dyn_cast<CXXMethodDecl>(FD))
10806     if (!MD->isUserProvided())
10807       return GVA_DiscardableODR;
10808 
10809   GVALinkage External;
10810   switch (FD->getTemplateSpecializationKind()) {
10811   case TSK_Undeclared:
10812   case TSK_ExplicitSpecialization:
10813     External = GVA_StrongExternal;
10814     break;
10815 
10816   case TSK_ExplicitInstantiationDefinition:
10817     return GVA_StrongODR;
10818 
10819   // C++11 [temp.explicit]p10:
10820   //   [ Note: The intent is that an inline function that is the subject of
10821   //   an explicit instantiation declaration will still be implicitly
10822   //   instantiated when used so that the body can be considered for
10823   //   inlining, but that no out-of-line copy of the inline function would be
10824   //   generated in the translation unit. -- end note ]
10825   case TSK_ExplicitInstantiationDeclaration:
10826     return GVA_AvailableExternally;
10827 
10828   case TSK_ImplicitInstantiation:
10829     External = GVA_DiscardableODR;
10830     break;
10831   }
10832 
10833   if (!FD->isInlined())
10834     return External;
10835 
10836   if ((!Context.getLangOpts().CPlusPlus &&
10837        !Context.getTargetInfo().getCXXABI().isMicrosoft() &&
10838        !FD->hasAttr<DLLExportAttr>()) ||
10839       FD->hasAttr<GNUInlineAttr>()) {
10840     // FIXME: This doesn't match gcc's behavior for dllexport inline functions.
10841 
10842     // GNU or C99 inline semantics. Determine whether this symbol should be
10843     // externally visible.
10844     if (FD->isInlineDefinitionExternallyVisible())
10845       return External;
10846 
10847     // C99 inline semantics, where the symbol is not externally visible.
10848     return GVA_AvailableExternally;
10849   }
10850 
10851   // Functions specified with extern and inline in -fms-compatibility mode
10852   // forcibly get emitted.  While the body of the function cannot be later
10853   // replaced, the function definition cannot be discarded.
10854   if (FD->isMSExternInline())
10855     return GVA_StrongODR;
10856 
10857   return GVA_DiscardableODR;
10858 }
10859 
10860 static GVALinkage adjustGVALinkageForAttributes(const ASTContext &Context,
10861                                                 const Decl *D, GVALinkage L) {
10862   // See http://msdn.microsoft.com/en-us/library/xa0d9ste.aspx
10863   // dllexport/dllimport on inline functions.
10864   if (D->hasAttr<DLLImportAttr>()) {
10865     if (L == GVA_DiscardableODR || L == GVA_StrongODR)
10866       return GVA_AvailableExternally;
10867   } else if (D->hasAttr<DLLExportAttr>()) {
10868     if (L == GVA_DiscardableODR)
10869       return GVA_StrongODR;
10870   } else if (Context.getLangOpts().CUDA && Context.getLangOpts().CUDAIsDevice) {
10871     // Device-side functions with __global__ attribute must always be
10872     // visible externally so they can be launched from host.
10873     if (D->hasAttr<CUDAGlobalAttr>() &&
10874         (L == GVA_DiscardableODR || L == GVA_Internal))
10875       return GVA_StrongODR;
10876     // Single source offloading languages like CUDA/HIP need to be able to
10877     // access static device variables from host code of the same compilation
10878     // unit. This is done by externalizing the static variable with a shared
10879     // name between the host and device compilation which is the same for the
10880     // same compilation unit whereas different among different compilation
10881     // units.
10882     if (Context.shouldExternalizeStaticVar(D))
10883       return GVA_StrongExternal;
10884   }
10885   return L;
10886 }
10887 
10888 /// Adjust the GVALinkage for a declaration based on what an external AST source
10889 /// knows about whether there can be other definitions of this declaration.
10890 static GVALinkage
10891 adjustGVALinkageForExternalDefinitionKind(const ASTContext &Ctx, const Decl *D,
10892                                           GVALinkage L) {
10893   ExternalASTSource *Source = Ctx.getExternalSource();
10894   if (!Source)
10895     return L;
10896 
10897   switch (Source->hasExternalDefinitions(D)) {
10898   case ExternalASTSource::EK_Never:
10899     // Other translation units rely on us to provide the definition.
10900     if (L == GVA_DiscardableODR)
10901       return GVA_StrongODR;
10902     break;
10903 
10904   case ExternalASTSource::EK_Always:
10905     return GVA_AvailableExternally;
10906 
10907   case ExternalASTSource::EK_ReplyHazy:
10908     break;
10909   }
10910   return L;
10911 }
10912 
10913 GVALinkage ASTContext::GetGVALinkageForFunction(const FunctionDecl *FD) const {
10914   return adjustGVALinkageForExternalDefinitionKind(*this, FD,
10915            adjustGVALinkageForAttributes(*this, FD,
10916              basicGVALinkageForFunction(*this, FD)));
10917 }
10918 
10919 static GVALinkage basicGVALinkageForVariable(const ASTContext &Context,
10920                                              const VarDecl *VD) {
10921   if (!VD->isExternallyVisible())
10922     return GVA_Internal;
10923 
10924   if (VD->isStaticLocal()) {
10925     const DeclContext *LexicalContext = VD->getParentFunctionOrMethod();
10926     while (LexicalContext && !isa<FunctionDecl>(LexicalContext))
10927       LexicalContext = LexicalContext->getLexicalParent();
10928 
10929     // ObjC Blocks can create local variables that don't have a FunctionDecl
10930     // LexicalContext.
10931     if (!LexicalContext)
10932       return GVA_DiscardableODR;
10933 
10934     // Otherwise, let the static local variable inherit its linkage from the
10935     // nearest enclosing function.
10936     auto StaticLocalLinkage =
10937         Context.GetGVALinkageForFunction(cast<FunctionDecl>(LexicalContext));
10938 
10939     // Itanium ABI 5.2.2: "Each COMDAT group [for a static local variable] must
10940     // be emitted in any object with references to the symbol for the object it
10941     // contains, whether inline or out-of-line."
10942     // Similar behavior is observed with MSVC. An alternative ABI could use
10943     // StrongODR/AvailableExternally to match the function, but none are
10944     // known/supported currently.
10945     if (StaticLocalLinkage == GVA_StrongODR ||
10946         StaticLocalLinkage == GVA_AvailableExternally)
10947       return GVA_DiscardableODR;
10948     return StaticLocalLinkage;
10949   }
10950 
10951   // MSVC treats in-class initialized static data members as definitions.
10952   // By giving them non-strong linkage, out-of-line definitions won't
10953   // cause link errors.
10954   if (Context.isMSStaticDataMemberInlineDefinition(VD))
10955     return GVA_DiscardableODR;
10956 
10957   // Most non-template variables have strong linkage; inline variables are
10958   // linkonce_odr or (occasionally, for compatibility) weak_odr.
10959   GVALinkage StrongLinkage;
10960   switch (Context.getInlineVariableDefinitionKind(VD)) {
10961   case ASTContext::InlineVariableDefinitionKind::None:
10962     StrongLinkage = GVA_StrongExternal;
10963     break;
10964   case ASTContext::InlineVariableDefinitionKind::Weak:
10965   case ASTContext::InlineVariableDefinitionKind::WeakUnknown:
10966     StrongLinkage = GVA_DiscardableODR;
10967     break;
10968   case ASTContext::InlineVariableDefinitionKind::Strong:
10969     StrongLinkage = GVA_StrongODR;
10970     break;
10971   }
10972 
10973   switch (VD->getTemplateSpecializationKind()) {
10974   case TSK_Undeclared:
10975     return StrongLinkage;
10976 
10977   case TSK_ExplicitSpecialization:
10978     return Context.getTargetInfo().getCXXABI().isMicrosoft() &&
10979                    VD->isStaticDataMember()
10980                ? GVA_StrongODR
10981                : StrongLinkage;
10982 
10983   case TSK_ExplicitInstantiationDefinition:
10984     return GVA_StrongODR;
10985 
10986   case TSK_ExplicitInstantiationDeclaration:
10987     return GVA_AvailableExternally;
10988 
10989   case TSK_ImplicitInstantiation:
10990     return GVA_DiscardableODR;
10991   }
10992 
10993   llvm_unreachable("Invalid Linkage!");
10994 }
10995 
10996 GVALinkage ASTContext::GetGVALinkageForVariable(const VarDecl *VD) {
10997   return adjustGVALinkageForExternalDefinitionKind(*this, VD,
10998            adjustGVALinkageForAttributes(*this, VD,
10999              basicGVALinkageForVariable(*this, VD)));
11000 }
11001 
11002 bool ASTContext::DeclMustBeEmitted(const Decl *D) {
11003   if (const auto *VD = dyn_cast<VarDecl>(D)) {
11004     if (!VD->isFileVarDecl())
11005       return false;
11006     // Global named register variables (GNU extension) are never emitted.
11007     if (VD->getStorageClass() == SC_Register)
11008       return false;
11009     if (VD->getDescribedVarTemplate() ||
11010         isa<VarTemplatePartialSpecializationDecl>(VD))
11011       return false;
11012   } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
11013     // We never need to emit an uninstantiated function template.
11014     if (FD->getTemplatedKind() == FunctionDecl::TK_FunctionTemplate)
11015       return false;
11016   } else if (isa<PragmaCommentDecl>(D))
11017     return true;
11018   else if (isa<PragmaDetectMismatchDecl>(D))
11019     return true;
11020   else if (isa<OMPRequiresDecl>(D))
11021     return true;
11022   else if (isa<OMPThreadPrivateDecl>(D))
11023     return !D->getDeclContext()->isDependentContext();
11024   else if (isa<OMPAllocateDecl>(D))
11025     return !D->getDeclContext()->isDependentContext();
11026   else if (isa<OMPDeclareReductionDecl>(D) || isa<OMPDeclareMapperDecl>(D))
11027     return !D->getDeclContext()->isDependentContext();
11028   else if (isa<ImportDecl>(D))
11029     return true;
11030   else
11031     return false;
11032 
11033   // If this is a member of a class template, we do not need to emit it.
11034   if (D->getDeclContext()->isDependentContext())
11035     return false;
11036 
11037   // Weak references don't produce any output by themselves.
11038   if (D->hasAttr<WeakRefAttr>())
11039     return false;
11040 
11041   // Aliases and used decls are required.
11042   if (D->hasAttr<AliasAttr>() || D->hasAttr<UsedAttr>())
11043     return true;
11044 
11045   if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
11046     // Forward declarations aren't required.
11047     if (!FD->doesThisDeclarationHaveABody())
11048       return FD->doesDeclarationForceExternallyVisibleDefinition();
11049 
11050     // Constructors and destructors are required.
11051     if (FD->hasAttr<ConstructorAttr>() || FD->hasAttr<DestructorAttr>())
11052       return true;
11053 
11054     // The key function for a class is required.  This rule only comes
11055     // into play when inline functions can be key functions, though.
11056     if (getTargetInfo().getCXXABI().canKeyFunctionBeInline()) {
11057       if (const auto *MD = dyn_cast<CXXMethodDecl>(FD)) {
11058         const CXXRecordDecl *RD = MD->getParent();
11059         if (MD->isOutOfLine() && RD->isDynamicClass()) {
11060           const CXXMethodDecl *KeyFunc = getCurrentKeyFunction(RD);
11061           if (KeyFunc && KeyFunc->getCanonicalDecl() == MD->getCanonicalDecl())
11062             return true;
11063         }
11064       }
11065     }
11066 
11067     GVALinkage Linkage = GetGVALinkageForFunction(FD);
11068 
11069     // static, static inline, always_inline, and extern inline functions can
11070     // always be deferred.  Normal inline functions can be deferred in C99/C++.
11071     // Implicit template instantiations can also be deferred in C++.
11072     return !isDiscardableGVALinkage(Linkage);
11073   }
11074 
11075   const auto *VD = cast<VarDecl>(D);
11076   assert(VD->isFileVarDecl() && "Expected file scoped var");
11077 
11078   // If the decl is marked as `declare target to`, it should be emitted for the
11079   // host and for the device.
11080   if (LangOpts.OpenMP &&
11081       OMPDeclareTargetDeclAttr::isDeclareTargetDeclaration(VD))
11082     return true;
11083 
11084   if (VD->isThisDeclarationADefinition() == VarDecl::DeclarationOnly &&
11085       !isMSStaticDataMemberInlineDefinition(VD))
11086     return false;
11087 
11088   // Variables that can be needed in other TUs are required.
11089   auto Linkage = GetGVALinkageForVariable(VD);
11090   if (!isDiscardableGVALinkage(Linkage))
11091     return true;
11092 
11093   // We never need to emit a variable that is available in another TU.
11094   if (Linkage == GVA_AvailableExternally)
11095     return false;
11096 
11097   // Variables that have destruction with side-effects are required.
11098   if (VD->needsDestruction(*this))
11099     return true;
11100 
11101   // Variables that have initialization with side-effects are required.
11102   if (VD->getInit() && VD->getInit()->HasSideEffects(*this) &&
11103       // We can get a value-dependent initializer during error recovery.
11104       (VD->getInit()->isValueDependent() || !VD->evaluateValue()))
11105     return true;
11106 
11107   // Likewise, variables with tuple-like bindings are required if their
11108   // bindings have side-effects.
11109   if (const auto *DD = dyn_cast<DecompositionDecl>(VD))
11110     for (const auto *BD : DD->bindings())
11111       if (const auto *BindingVD = BD->getHoldingVar())
11112         if (DeclMustBeEmitted(BindingVD))
11113           return true;
11114 
11115   return false;
11116 }
11117 
11118 void ASTContext::forEachMultiversionedFunctionVersion(
11119     const FunctionDecl *FD,
11120     llvm::function_ref<void(FunctionDecl *)> Pred) const {
11121   assert(FD->isMultiVersion() && "Only valid for multiversioned functions");
11122   llvm::SmallDenseSet<const FunctionDecl*, 4> SeenDecls;
11123   FD = FD->getMostRecentDecl();
11124   // FIXME: The order of traversal here matters and depends on the order of
11125   // lookup results, which happens to be (mostly) oldest-to-newest, but we
11126   // shouldn't rely on that.
11127   for (auto *CurDecl :
11128        FD->getDeclContext()->getRedeclContext()->lookup(FD->getDeclName())) {
11129     FunctionDecl *CurFD = CurDecl->getAsFunction()->getMostRecentDecl();
11130     if (CurFD && hasSameType(CurFD->getType(), FD->getType()) &&
11131         std::end(SeenDecls) == llvm::find(SeenDecls, CurFD)) {
11132       SeenDecls.insert(CurFD);
11133       Pred(CurFD);
11134     }
11135   }
11136 }
11137 
11138 CallingConv ASTContext::getDefaultCallingConvention(bool IsVariadic,
11139                                                     bool IsCXXMethod,
11140                                                     bool IsBuiltin) const {
11141   // Pass through to the C++ ABI object
11142   if (IsCXXMethod)
11143     return ABI->getDefaultMethodCallConv(IsVariadic);
11144 
11145   // Builtins ignore user-specified default calling convention and remain the
11146   // Target's default calling convention.
11147   if (!IsBuiltin) {
11148     switch (LangOpts.getDefaultCallingConv()) {
11149     case LangOptions::DCC_None:
11150       break;
11151     case LangOptions::DCC_CDecl:
11152       return CC_C;
11153     case LangOptions::DCC_FastCall:
11154       if (getTargetInfo().hasFeature("sse2") && !IsVariadic)
11155         return CC_X86FastCall;
11156       break;
11157     case LangOptions::DCC_StdCall:
11158       if (!IsVariadic)
11159         return CC_X86StdCall;
11160       break;
11161     case LangOptions::DCC_VectorCall:
11162       // __vectorcall cannot be applied to variadic functions.
11163       if (!IsVariadic)
11164         return CC_X86VectorCall;
11165       break;
11166     case LangOptions::DCC_RegCall:
11167       // __regcall cannot be applied to variadic functions.
11168       if (!IsVariadic)
11169         return CC_X86RegCall;
11170       break;
11171     }
11172   }
11173   return Target->getDefaultCallingConv();
11174 }
11175 
11176 bool ASTContext::isNearlyEmpty(const CXXRecordDecl *RD) const {
11177   // Pass through to the C++ ABI object
11178   return ABI->isNearlyEmpty(RD);
11179 }
11180 
11181 VTableContextBase *ASTContext::getVTableContext() {
11182   if (!VTContext.get()) {
11183     auto ABI = Target->getCXXABI();
11184     if (ABI.isMicrosoft())
11185       VTContext.reset(new MicrosoftVTableContext(*this));
11186     else {
11187       auto ComponentLayout = getLangOpts().RelativeCXXABIVTables
11188                                  ? ItaniumVTableContext::Relative
11189                                  : ItaniumVTableContext::Pointer;
11190       VTContext.reset(new ItaniumVTableContext(*this, ComponentLayout));
11191     }
11192   }
11193   return VTContext.get();
11194 }
11195 
11196 MangleContext *ASTContext::createMangleContext(const TargetInfo *T) {
11197   if (!T)
11198     T = Target;
11199   switch (T->getCXXABI().getKind()) {
11200   case TargetCXXABI::AppleARM64:
11201   case TargetCXXABI::Fuchsia:
11202   case TargetCXXABI::GenericAArch64:
11203   case TargetCXXABI::GenericItanium:
11204   case TargetCXXABI::GenericARM:
11205   case TargetCXXABI::GenericMIPS:
11206   case TargetCXXABI::iOS:
11207   case TargetCXXABI::WebAssembly:
11208   case TargetCXXABI::WatchOS:
11209   case TargetCXXABI::XL:
11210     return ItaniumMangleContext::create(*this, getDiagnostics());
11211   case TargetCXXABI::Microsoft:
11212     return MicrosoftMangleContext::create(*this, getDiagnostics());
11213   }
11214   llvm_unreachable("Unsupported ABI");
11215 }
11216 
11217 MangleContext *ASTContext::createDeviceMangleContext(const TargetInfo &T) {
11218   assert(T.getCXXABI().getKind() != TargetCXXABI::Microsoft &&
11219          "Device mangle context does not support Microsoft mangling.");
11220   switch (T.getCXXABI().getKind()) {
11221   case TargetCXXABI::AppleARM64:
11222   case TargetCXXABI::Fuchsia:
11223   case TargetCXXABI::GenericAArch64:
11224   case TargetCXXABI::GenericItanium:
11225   case TargetCXXABI::GenericARM:
11226   case TargetCXXABI::GenericMIPS:
11227   case TargetCXXABI::iOS:
11228   case TargetCXXABI::WebAssembly:
11229   case TargetCXXABI::WatchOS:
11230   case TargetCXXABI::XL:
11231     return ItaniumMangleContext::create(
11232         *this, getDiagnostics(),
11233         [](ASTContext &, const NamedDecl *ND) -> llvm::Optional<unsigned> {
11234           if (const auto *RD = dyn_cast<CXXRecordDecl>(ND))
11235             return RD->getDeviceLambdaManglingNumber();
11236           return llvm::None;
11237         });
11238   case TargetCXXABI::Microsoft:
11239     return MicrosoftMangleContext::create(*this, getDiagnostics());
11240   }
11241   llvm_unreachable("Unsupported ABI");
11242 }
11243 
11244 CXXABI::~CXXABI() = default;
11245 
11246 size_t ASTContext::getSideTableAllocatedMemory() const {
11247   return ASTRecordLayouts.getMemorySize() +
11248          llvm::capacity_in_bytes(ObjCLayouts) +
11249          llvm::capacity_in_bytes(KeyFunctions) +
11250          llvm::capacity_in_bytes(ObjCImpls) +
11251          llvm::capacity_in_bytes(BlockVarCopyInits) +
11252          llvm::capacity_in_bytes(DeclAttrs) +
11253          llvm::capacity_in_bytes(TemplateOrInstantiation) +
11254          llvm::capacity_in_bytes(InstantiatedFromUsingDecl) +
11255          llvm::capacity_in_bytes(InstantiatedFromUsingShadowDecl) +
11256          llvm::capacity_in_bytes(InstantiatedFromUnnamedFieldDecl) +
11257          llvm::capacity_in_bytes(OverriddenMethods) +
11258          llvm::capacity_in_bytes(Types) +
11259          llvm::capacity_in_bytes(VariableArrayTypes);
11260 }
11261 
11262 /// getIntTypeForBitwidth -
11263 /// sets integer QualTy according to specified details:
11264 /// bitwidth, signed/unsigned.
11265 /// Returns empty type if there is no appropriate target types.
11266 QualType ASTContext::getIntTypeForBitwidth(unsigned DestWidth,
11267                                            unsigned Signed) const {
11268   TargetInfo::IntType Ty = getTargetInfo().getIntTypeByWidth(DestWidth, Signed);
11269   CanQualType QualTy = getFromTargetType(Ty);
11270   if (!QualTy && DestWidth == 128)
11271     return Signed ? Int128Ty : UnsignedInt128Ty;
11272   return QualTy;
11273 }
11274 
11275 /// getRealTypeForBitwidth -
11276 /// sets floating point QualTy according to specified bitwidth.
11277 /// Returns empty type if there is no appropriate target types.
11278 QualType ASTContext::getRealTypeForBitwidth(unsigned DestWidth,
11279                                             FloatModeKind ExplicitType) const {
11280   FloatModeKind Ty =
11281       getTargetInfo().getRealTypeByWidth(DestWidth, ExplicitType);
11282   switch (Ty) {
11283   case FloatModeKind::Float:
11284     return FloatTy;
11285   case FloatModeKind::Double:
11286     return DoubleTy;
11287   case FloatModeKind::LongDouble:
11288     return LongDoubleTy;
11289   case FloatModeKind::Float128:
11290     return Float128Ty;
11291   case FloatModeKind::Ibm128:
11292     return Ibm128Ty;
11293   case FloatModeKind::NoFloat:
11294     return {};
11295   }
11296 
11297   llvm_unreachable("Unhandled TargetInfo::RealType value");
11298 }
11299 
11300 void ASTContext::setManglingNumber(const NamedDecl *ND, unsigned Number) {
11301   if (Number > 1)
11302     MangleNumbers[ND] = Number;
11303 }
11304 
11305 unsigned ASTContext::getManglingNumber(const NamedDecl *ND) const {
11306   auto I = MangleNumbers.find(ND);
11307   return I != MangleNumbers.end() ? I->second : 1;
11308 }
11309 
11310 void ASTContext::setStaticLocalNumber(const VarDecl *VD, unsigned Number) {
11311   if (Number > 1)
11312     StaticLocalNumbers[VD] = Number;
11313 }
11314 
11315 unsigned ASTContext::getStaticLocalNumber(const VarDecl *VD) const {
11316   auto I = StaticLocalNumbers.find(VD);
11317   return I != StaticLocalNumbers.end() ? I->second : 1;
11318 }
11319 
11320 MangleNumberingContext &
11321 ASTContext::getManglingNumberContext(const DeclContext *DC) {
11322   assert(LangOpts.CPlusPlus);  // We don't need mangling numbers for plain C.
11323   std::unique_ptr<MangleNumberingContext> &MCtx = MangleNumberingContexts[DC];
11324   if (!MCtx)
11325     MCtx = createMangleNumberingContext();
11326   return *MCtx;
11327 }
11328 
11329 MangleNumberingContext &
11330 ASTContext::getManglingNumberContext(NeedExtraManglingDecl_t, const Decl *D) {
11331   assert(LangOpts.CPlusPlus); // We don't need mangling numbers for plain C.
11332   std::unique_ptr<MangleNumberingContext> &MCtx =
11333       ExtraMangleNumberingContexts[D];
11334   if (!MCtx)
11335     MCtx = createMangleNumberingContext();
11336   return *MCtx;
11337 }
11338 
11339 std::unique_ptr<MangleNumberingContext>
11340 ASTContext::createMangleNumberingContext() const {
11341   return ABI->createMangleNumberingContext();
11342 }
11343 
11344 const CXXConstructorDecl *
11345 ASTContext::getCopyConstructorForExceptionObject(CXXRecordDecl *RD) {
11346   return ABI->getCopyConstructorForExceptionObject(
11347       cast<CXXRecordDecl>(RD->getFirstDecl()));
11348 }
11349 
11350 void ASTContext::addCopyConstructorForExceptionObject(CXXRecordDecl *RD,
11351                                                       CXXConstructorDecl *CD) {
11352   return ABI->addCopyConstructorForExceptionObject(
11353       cast<CXXRecordDecl>(RD->getFirstDecl()),
11354       cast<CXXConstructorDecl>(CD->getFirstDecl()));
11355 }
11356 
11357 void ASTContext::addTypedefNameForUnnamedTagDecl(TagDecl *TD,
11358                                                  TypedefNameDecl *DD) {
11359   return ABI->addTypedefNameForUnnamedTagDecl(TD, DD);
11360 }
11361 
11362 TypedefNameDecl *
11363 ASTContext::getTypedefNameForUnnamedTagDecl(const TagDecl *TD) {
11364   return ABI->getTypedefNameForUnnamedTagDecl(TD);
11365 }
11366 
11367 void ASTContext::addDeclaratorForUnnamedTagDecl(TagDecl *TD,
11368                                                 DeclaratorDecl *DD) {
11369   return ABI->addDeclaratorForUnnamedTagDecl(TD, DD);
11370 }
11371 
11372 DeclaratorDecl *ASTContext::getDeclaratorForUnnamedTagDecl(const TagDecl *TD) {
11373   return ABI->getDeclaratorForUnnamedTagDecl(TD);
11374 }
11375 
11376 void ASTContext::setParameterIndex(const ParmVarDecl *D, unsigned int index) {
11377   ParamIndices[D] = index;
11378 }
11379 
11380 unsigned ASTContext::getParameterIndex(const ParmVarDecl *D) const {
11381   ParameterIndexTable::const_iterator I = ParamIndices.find(D);
11382   assert(I != ParamIndices.end() &&
11383          "ParmIndices lacks entry set by ParmVarDecl");
11384   return I->second;
11385 }
11386 
11387 QualType ASTContext::getStringLiteralArrayType(QualType EltTy,
11388                                                unsigned Length) const {
11389   // A C++ string literal has a const-qualified element type (C++ 2.13.4p1).
11390   if (getLangOpts().CPlusPlus || getLangOpts().ConstStrings)
11391     EltTy = EltTy.withConst();
11392 
11393   EltTy = adjustStringLiteralBaseType(EltTy);
11394 
11395   // Get an array type for the string, according to C99 6.4.5. This includes
11396   // the null terminator character.
11397   return getConstantArrayType(EltTy, llvm::APInt(32, Length + 1), nullptr,
11398                               ArrayType::Normal, /*IndexTypeQuals*/ 0);
11399 }
11400 
11401 StringLiteral *
11402 ASTContext::getPredefinedStringLiteralFromCache(StringRef Key) const {
11403   StringLiteral *&Result = StringLiteralCache[Key];
11404   if (!Result)
11405     Result = StringLiteral::Create(
11406         *this, Key, StringLiteral::Ascii,
11407         /*Pascal*/ false, getStringLiteralArrayType(CharTy, Key.size()),
11408         SourceLocation());
11409   return Result;
11410 }
11411 
11412 MSGuidDecl *
11413 ASTContext::getMSGuidDecl(MSGuidDecl::Parts Parts) const {
11414   assert(MSGuidTagDecl && "building MS GUID without MS extensions?");
11415 
11416   llvm::FoldingSetNodeID ID;
11417   MSGuidDecl::Profile(ID, Parts);
11418 
11419   void *InsertPos;
11420   if (MSGuidDecl *Existing = MSGuidDecls.FindNodeOrInsertPos(ID, InsertPos))
11421     return Existing;
11422 
11423   QualType GUIDType = getMSGuidType().withConst();
11424   MSGuidDecl *New = MSGuidDecl::Create(*this, GUIDType, Parts);
11425   MSGuidDecls.InsertNode(New, InsertPos);
11426   return New;
11427 }
11428 
11429 TemplateParamObjectDecl *
11430 ASTContext::getTemplateParamObjectDecl(QualType T, const APValue &V) const {
11431   assert(T->isRecordType() && "template param object of unexpected type");
11432 
11433   // C++ [temp.param]p8:
11434   //   [...] a static storage duration object of type 'const T' [...]
11435   T.addConst();
11436 
11437   llvm::FoldingSetNodeID ID;
11438   TemplateParamObjectDecl::Profile(ID, T, V);
11439 
11440   void *InsertPos;
11441   if (TemplateParamObjectDecl *Existing =
11442           TemplateParamObjectDecls.FindNodeOrInsertPos(ID, InsertPos))
11443     return Existing;
11444 
11445   TemplateParamObjectDecl *New = TemplateParamObjectDecl::Create(*this, T, V);
11446   TemplateParamObjectDecls.InsertNode(New, InsertPos);
11447   return New;
11448 }
11449 
11450 bool ASTContext::AtomicUsesUnsupportedLibcall(const AtomicExpr *E) const {
11451   const llvm::Triple &T = getTargetInfo().getTriple();
11452   if (!T.isOSDarwin())
11453     return false;
11454 
11455   if (!(T.isiOS() && T.isOSVersionLT(7)) &&
11456       !(T.isMacOSX() && T.isOSVersionLT(10, 9)))
11457     return false;
11458 
11459   QualType AtomicTy = E->getPtr()->getType()->getPointeeType();
11460   CharUnits sizeChars = getTypeSizeInChars(AtomicTy);
11461   uint64_t Size = sizeChars.getQuantity();
11462   CharUnits alignChars = getTypeAlignInChars(AtomicTy);
11463   unsigned Align = alignChars.getQuantity();
11464   unsigned MaxInlineWidthInBits = getTargetInfo().getMaxAtomicInlineWidth();
11465   return (Size != Align || toBits(sizeChars) > MaxInlineWidthInBits);
11466 }
11467 
11468 bool
11469 ASTContext::ObjCMethodsAreEqual(const ObjCMethodDecl *MethodDecl,
11470                                 const ObjCMethodDecl *MethodImpl) {
11471   // No point trying to match an unavailable/deprecated mothod.
11472   if (MethodDecl->hasAttr<UnavailableAttr>()
11473       || MethodDecl->hasAttr<DeprecatedAttr>())
11474     return false;
11475   if (MethodDecl->getObjCDeclQualifier() !=
11476       MethodImpl->getObjCDeclQualifier())
11477     return false;
11478   if (!hasSameType(MethodDecl->getReturnType(), MethodImpl->getReturnType()))
11479     return false;
11480 
11481   if (MethodDecl->param_size() != MethodImpl->param_size())
11482     return false;
11483 
11484   for (ObjCMethodDecl::param_const_iterator IM = MethodImpl->param_begin(),
11485        IF = MethodDecl->param_begin(), EM = MethodImpl->param_end(),
11486        EF = MethodDecl->param_end();
11487        IM != EM && IF != EF; ++IM, ++IF) {
11488     const ParmVarDecl *DeclVar = (*IF);
11489     const ParmVarDecl *ImplVar = (*IM);
11490     if (ImplVar->getObjCDeclQualifier() != DeclVar->getObjCDeclQualifier())
11491       return false;
11492     if (!hasSameType(DeclVar->getType(), ImplVar->getType()))
11493       return false;
11494   }
11495 
11496   return (MethodDecl->isVariadic() == MethodImpl->isVariadic());
11497 }
11498 
11499 uint64_t ASTContext::getTargetNullPointerValue(QualType QT) const {
11500   LangAS AS;
11501   if (QT->getUnqualifiedDesugaredType()->isNullPtrType())
11502     AS = LangAS::Default;
11503   else
11504     AS = QT->getPointeeType().getAddressSpace();
11505 
11506   return getTargetInfo().getNullPointerValue(AS);
11507 }
11508 
11509 unsigned ASTContext::getTargetAddressSpace(LangAS AS) const {
11510   if (isTargetAddressSpace(AS))
11511     return toTargetAddressSpace(AS);
11512   else
11513     return (*AddrSpaceMap)[(unsigned)AS];
11514 }
11515 
11516 QualType ASTContext::getCorrespondingSaturatedType(QualType Ty) const {
11517   assert(Ty->isFixedPointType());
11518 
11519   if (Ty->isSaturatedFixedPointType()) return Ty;
11520 
11521   switch (Ty->castAs<BuiltinType>()->getKind()) {
11522     default:
11523       llvm_unreachable("Not a fixed point type!");
11524     case BuiltinType::ShortAccum:
11525       return SatShortAccumTy;
11526     case BuiltinType::Accum:
11527       return SatAccumTy;
11528     case BuiltinType::LongAccum:
11529       return SatLongAccumTy;
11530     case BuiltinType::UShortAccum:
11531       return SatUnsignedShortAccumTy;
11532     case BuiltinType::UAccum:
11533       return SatUnsignedAccumTy;
11534     case BuiltinType::ULongAccum:
11535       return SatUnsignedLongAccumTy;
11536     case BuiltinType::ShortFract:
11537       return SatShortFractTy;
11538     case BuiltinType::Fract:
11539       return SatFractTy;
11540     case BuiltinType::LongFract:
11541       return SatLongFractTy;
11542     case BuiltinType::UShortFract:
11543       return SatUnsignedShortFractTy;
11544     case BuiltinType::UFract:
11545       return SatUnsignedFractTy;
11546     case BuiltinType::ULongFract:
11547       return SatUnsignedLongFractTy;
11548   }
11549 }
11550 
11551 LangAS ASTContext::getLangASForBuiltinAddressSpace(unsigned AS) const {
11552   if (LangOpts.OpenCL)
11553     return getTargetInfo().getOpenCLBuiltinAddressSpace(AS);
11554 
11555   if (LangOpts.CUDA)
11556     return getTargetInfo().getCUDABuiltinAddressSpace(AS);
11557 
11558   return getLangASFromTargetAS(AS);
11559 }
11560 
11561 // Explicitly instantiate this in case a Redeclarable<T> is used from a TU that
11562 // doesn't include ASTContext.h
11563 template
11564 clang::LazyGenerationalUpdatePtr<
11565     const Decl *, Decl *, &ExternalASTSource::CompleteRedeclChain>::ValueType
11566 clang::LazyGenerationalUpdatePtr<
11567     const Decl *, Decl *, &ExternalASTSource::CompleteRedeclChain>::makeValue(
11568         const clang::ASTContext &Ctx, Decl *Value);
11569 
11570 unsigned char ASTContext::getFixedPointScale(QualType Ty) const {
11571   assert(Ty->isFixedPointType());
11572 
11573   const TargetInfo &Target = getTargetInfo();
11574   switch (Ty->castAs<BuiltinType>()->getKind()) {
11575     default:
11576       llvm_unreachable("Not a fixed point type!");
11577     case BuiltinType::ShortAccum:
11578     case BuiltinType::SatShortAccum:
11579       return Target.getShortAccumScale();
11580     case BuiltinType::Accum:
11581     case BuiltinType::SatAccum:
11582       return Target.getAccumScale();
11583     case BuiltinType::LongAccum:
11584     case BuiltinType::SatLongAccum:
11585       return Target.getLongAccumScale();
11586     case BuiltinType::UShortAccum:
11587     case BuiltinType::SatUShortAccum:
11588       return Target.getUnsignedShortAccumScale();
11589     case BuiltinType::UAccum:
11590     case BuiltinType::SatUAccum:
11591       return Target.getUnsignedAccumScale();
11592     case BuiltinType::ULongAccum:
11593     case BuiltinType::SatULongAccum:
11594       return Target.getUnsignedLongAccumScale();
11595     case BuiltinType::ShortFract:
11596     case BuiltinType::SatShortFract:
11597       return Target.getShortFractScale();
11598     case BuiltinType::Fract:
11599     case BuiltinType::SatFract:
11600       return Target.getFractScale();
11601     case BuiltinType::LongFract:
11602     case BuiltinType::SatLongFract:
11603       return Target.getLongFractScale();
11604     case BuiltinType::UShortFract:
11605     case BuiltinType::SatUShortFract:
11606       return Target.getUnsignedShortFractScale();
11607     case BuiltinType::UFract:
11608     case BuiltinType::SatUFract:
11609       return Target.getUnsignedFractScale();
11610     case BuiltinType::ULongFract:
11611     case BuiltinType::SatULongFract:
11612       return Target.getUnsignedLongFractScale();
11613   }
11614 }
11615 
11616 unsigned char ASTContext::getFixedPointIBits(QualType Ty) const {
11617   assert(Ty->isFixedPointType());
11618 
11619   const TargetInfo &Target = getTargetInfo();
11620   switch (Ty->castAs<BuiltinType>()->getKind()) {
11621     default:
11622       llvm_unreachable("Not a fixed point type!");
11623     case BuiltinType::ShortAccum:
11624     case BuiltinType::SatShortAccum:
11625       return Target.getShortAccumIBits();
11626     case BuiltinType::Accum:
11627     case BuiltinType::SatAccum:
11628       return Target.getAccumIBits();
11629     case BuiltinType::LongAccum:
11630     case BuiltinType::SatLongAccum:
11631       return Target.getLongAccumIBits();
11632     case BuiltinType::UShortAccum:
11633     case BuiltinType::SatUShortAccum:
11634       return Target.getUnsignedShortAccumIBits();
11635     case BuiltinType::UAccum:
11636     case BuiltinType::SatUAccum:
11637       return Target.getUnsignedAccumIBits();
11638     case BuiltinType::ULongAccum:
11639     case BuiltinType::SatULongAccum:
11640       return Target.getUnsignedLongAccumIBits();
11641     case BuiltinType::ShortFract:
11642     case BuiltinType::SatShortFract:
11643     case BuiltinType::Fract:
11644     case BuiltinType::SatFract:
11645     case BuiltinType::LongFract:
11646     case BuiltinType::SatLongFract:
11647     case BuiltinType::UShortFract:
11648     case BuiltinType::SatUShortFract:
11649     case BuiltinType::UFract:
11650     case BuiltinType::SatUFract:
11651     case BuiltinType::ULongFract:
11652     case BuiltinType::SatULongFract:
11653       return 0;
11654   }
11655 }
11656 
11657 llvm::FixedPointSemantics
11658 ASTContext::getFixedPointSemantics(QualType Ty) const {
11659   assert((Ty->isFixedPointType() || Ty->isIntegerType()) &&
11660          "Can only get the fixed point semantics for a "
11661          "fixed point or integer type.");
11662   if (Ty->isIntegerType())
11663     return llvm::FixedPointSemantics::GetIntegerSemantics(
11664         getIntWidth(Ty), Ty->isSignedIntegerType());
11665 
11666   bool isSigned = Ty->isSignedFixedPointType();
11667   return llvm::FixedPointSemantics(
11668       static_cast<unsigned>(getTypeSize(Ty)), getFixedPointScale(Ty), isSigned,
11669       Ty->isSaturatedFixedPointType(),
11670       !isSigned && getTargetInfo().doUnsignedFixedPointTypesHavePadding());
11671 }
11672 
11673 llvm::APFixedPoint ASTContext::getFixedPointMax(QualType Ty) const {
11674   assert(Ty->isFixedPointType());
11675   return llvm::APFixedPoint::getMax(getFixedPointSemantics(Ty));
11676 }
11677 
11678 llvm::APFixedPoint ASTContext::getFixedPointMin(QualType Ty) const {
11679   assert(Ty->isFixedPointType());
11680   return llvm::APFixedPoint::getMin(getFixedPointSemantics(Ty));
11681 }
11682 
11683 QualType ASTContext::getCorrespondingSignedFixedPointType(QualType Ty) const {
11684   assert(Ty->isUnsignedFixedPointType() &&
11685          "Expected unsigned fixed point type");
11686 
11687   switch (Ty->castAs<BuiltinType>()->getKind()) {
11688   case BuiltinType::UShortAccum:
11689     return ShortAccumTy;
11690   case BuiltinType::UAccum:
11691     return AccumTy;
11692   case BuiltinType::ULongAccum:
11693     return LongAccumTy;
11694   case BuiltinType::SatUShortAccum:
11695     return SatShortAccumTy;
11696   case BuiltinType::SatUAccum:
11697     return SatAccumTy;
11698   case BuiltinType::SatULongAccum:
11699     return SatLongAccumTy;
11700   case BuiltinType::UShortFract:
11701     return ShortFractTy;
11702   case BuiltinType::UFract:
11703     return FractTy;
11704   case BuiltinType::ULongFract:
11705     return LongFractTy;
11706   case BuiltinType::SatUShortFract:
11707     return SatShortFractTy;
11708   case BuiltinType::SatUFract:
11709     return SatFractTy;
11710   case BuiltinType::SatULongFract:
11711     return SatLongFractTy;
11712   default:
11713     llvm_unreachable("Unexpected unsigned fixed point type");
11714   }
11715 }
11716 
11717 ParsedTargetAttr
11718 ASTContext::filterFunctionTargetAttrs(const TargetAttr *TD) const {
11719   assert(TD != nullptr);
11720   ParsedTargetAttr ParsedAttr = TD->parse();
11721 
11722   ParsedAttr.Features.erase(
11723       llvm::remove_if(ParsedAttr.Features,
11724                       [&](const std::string &Feat) {
11725                         return !Target->isValidFeatureName(
11726                             StringRef{Feat}.substr(1));
11727                       }),
11728       ParsedAttr.Features.end());
11729   return ParsedAttr;
11730 }
11731 
11732 void ASTContext::getFunctionFeatureMap(llvm::StringMap<bool> &FeatureMap,
11733                                        const FunctionDecl *FD) const {
11734   if (FD)
11735     getFunctionFeatureMap(FeatureMap, GlobalDecl().getWithDecl(FD));
11736   else
11737     Target->initFeatureMap(FeatureMap, getDiagnostics(),
11738                            Target->getTargetOpts().CPU,
11739                            Target->getTargetOpts().Features);
11740 }
11741 
11742 // Fills in the supplied string map with the set of target features for the
11743 // passed in function.
11744 void ASTContext::getFunctionFeatureMap(llvm::StringMap<bool> &FeatureMap,
11745                                        GlobalDecl GD) const {
11746   StringRef TargetCPU = Target->getTargetOpts().CPU;
11747   const FunctionDecl *FD = GD.getDecl()->getAsFunction();
11748   if (const auto *TD = FD->getAttr<TargetAttr>()) {
11749     ParsedTargetAttr ParsedAttr = filterFunctionTargetAttrs(TD);
11750 
11751     // Make a copy of the features as passed on the command line into the
11752     // beginning of the additional features from the function to override.
11753     ParsedAttr.Features.insert(
11754         ParsedAttr.Features.begin(),
11755         Target->getTargetOpts().FeaturesAsWritten.begin(),
11756         Target->getTargetOpts().FeaturesAsWritten.end());
11757 
11758     if (ParsedAttr.Architecture != "" &&
11759         Target->isValidCPUName(ParsedAttr.Architecture))
11760       TargetCPU = ParsedAttr.Architecture;
11761 
11762     // Now populate the feature map, first with the TargetCPU which is either
11763     // the default or a new one from the target attribute string. Then we'll use
11764     // the passed in features (FeaturesAsWritten) along with the new ones from
11765     // the attribute.
11766     Target->initFeatureMap(FeatureMap, getDiagnostics(), TargetCPU,
11767                            ParsedAttr.Features);
11768   } else if (const auto *SD = FD->getAttr<CPUSpecificAttr>()) {
11769     llvm::SmallVector<StringRef, 32> FeaturesTmp;
11770     Target->getCPUSpecificCPUDispatchFeatures(
11771         SD->getCPUName(GD.getMultiVersionIndex())->getName(), FeaturesTmp);
11772     std::vector<std::string> Features(FeaturesTmp.begin(), FeaturesTmp.end());
11773     Target->initFeatureMap(FeatureMap, getDiagnostics(), TargetCPU, Features);
11774   } else {
11775     FeatureMap = Target->getTargetOpts().FeatureMap;
11776   }
11777 }
11778 
11779 OMPTraitInfo &ASTContext::getNewOMPTraitInfo() {
11780   OMPTraitInfoVector.emplace_back(new OMPTraitInfo());
11781   return *OMPTraitInfoVector.back();
11782 }
11783 
11784 const StreamingDiagnostic &clang::
11785 operator<<(const StreamingDiagnostic &DB,
11786            const ASTContext::SectionInfo &Section) {
11787   if (Section.Decl)
11788     return DB << Section.Decl;
11789   return DB << "a prior #pragma section";
11790 }
11791 
11792 bool ASTContext::mayExternalizeStaticVar(const Decl *D) const {
11793   bool IsStaticVar =
11794       isa<VarDecl>(D) && cast<VarDecl>(D)->getStorageClass() == SC_Static;
11795   bool IsExplicitDeviceVar = (D->hasAttr<CUDADeviceAttr>() &&
11796                               !D->getAttr<CUDADeviceAttr>()->isImplicit()) ||
11797                              (D->hasAttr<CUDAConstantAttr>() &&
11798                               !D->getAttr<CUDAConstantAttr>()->isImplicit());
11799   // CUDA/HIP: static managed variables need to be externalized since it is
11800   // a declaration in IR, therefore cannot have internal linkage.
11801   return IsStaticVar &&
11802          (D->hasAttr<HIPManagedAttr>() || IsExplicitDeviceVar);
11803 }
11804 
11805 bool ASTContext::shouldExternalizeStaticVar(const Decl *D) const {
11806   return mayExternalizeStaticVar(D) &&
11807          (D->hasAttr<HIPManagedAttr>() ||
11808           CUDADeviceVarODRUsedByHost.count(cast<VarDecl>(D)));
11809 }
11810 
11811 StringRef ASTContext::getCUIDHash() const {
11812   if (!CUIDHash.empty())
11813     return CUIDHash;
11814   if (LangOpts.CUID.empty())
11815     return StringRef();
11816   CUIDHash = llvm::utohexstr(llvm::MD5Hash(LangOpts.CUID), /*LowerCase=*/true);
11817   return CUIDHash;
11818 }
11819