1 //===- ASTContext.cpp - Context to hold long-lived AST nodes --------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 //  This file implements the ASTContext interface.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "clang/AST/ASTContext.h"
15 #include "CXXABI.h"
16 #include "clang/AST/APValue.h"
17 #include "clang/AST/ASTMutationListener.h"
18 #include "clang/AST/ASTTypeTraits.h"
19 #include "clang/AST/Attr.h"
20 #include "clang/AST/AttrIterator.h"
21 #include "clang/AST/CharUnits.h"
22 #include "clang/AST/Comment.h"
23 #include "clang/AST/Decl.h"
24 #include "clang/AST/DeclBase.h"
25 #include "clang/AST/DeclCXX.h"
26 #include "clang/AST/DeclContextInternals.h"
27 #include "clang/AST/DeclObjC.h"
28 #include "clang/AST/DeclOpenMP.h"
29 #include "clang/AST/DeclTemplate.h"
30 #include "clang/AST/DeclarationName.h"
31 #include "clang/AST/Expr.h"
32 #include "clang/AST/ExprCXX.h"
33 #include "clang/AST/ExternalASTSource.h"
34 #include "clang/AST/Mangle.h"
35 #include "clang/AST/MangleNumberingContext.h"
36 #include "clang/AST/NestedNameSpecifier.h"
37 #include "clang/AST/RawCommentList.h"
38 #include "clang/AST/RecordLayout.h"
39 #include "clang/AST/RecursiveASTVisitor.h"
40 #include "clang/AST/Stmt.h"
41 #include "clang/AST/TemplateBase.h"
42 #include "clang/AST/TemplateName.h"
43 #include "clang/AST/Type.h"
44 #include "clang/AST/TypeLoc.h"
45 #include "clang/AST/UnresolvedSet.h"
46 #include "clang/AST/VTableBuilder.h"
47 #include "clang/Basic/AddressSpaces.h"
48 #include "clang/Basic/Builtins.h"
49 #include "clang/Basic/CommentOptions.h"
50 #include "clang/Basic/ExceptionSpecificationType.h"
51 #include "clang/Basic/IdentifierTable.h"
52 #include "clang/Basic/LLVM.h"
53 #include "clang/Basic/LangOptions.h"
54 #include "clang/Basic/Linkage.h"
55 #include "clang/Basic/ObjCRuntime.h"
56 #include "clang/Basic/SanitizerBlacklist.h"
57 #include "clang/Basic/SourceLocation.h"
58 #include "clang/Basic/SourceManager.h"
59 #include "clang/Basic/Specifiers.h"
60 #include "clang/Basic/TargetCXXABI.h"
61 #include "clang/Basic/TargetInfo.h"
62 #include "clang/Basic/XRayLists.h"
63 #include "llvm/ADT/APInt.h"
64 #include "llvm/ADT/APSInt.h"
65 #include "llvm/ADT/ArrayRef.h"
66 #include "llvm/ADT/DenseMap.h"
67 #include "llvm/ADT/DenseSet.h"
68 #include "llvm/ADT/FoldingSet.h"
69 #include "llvm/ADT/None.h"
70 #include "llvm/ADT/Optional.h"
71 #include "llvm/ADT/PointerUnion.h"
72 #include "llvm/ADT/STLExtras.h"
73 #include "llvm/ADT/SmallPtrSet.h"
74 #include "llvm/ADT/SmallVector.h"
75 #include "llvm/ADT/StringExtras.h"
76 #include "llvm/ADT/StringRef.h"
77 #include "llvm/ADT/Triple.h"
78 #include "llvm/Support/Capacity.h"
79 #include "llvm/Support/Casting.h"
80 #include "llvm/Support/Compiler.h"
81 #include "llvm/Support/ErrorHandling.h"
82 #include "llvm/Support/MathExtras.h"
83 #include "llvm/Support/raw_ostream.h"
84 #include <algorithm>
85 #include <cassert>
86 #include <cstddef>
87 #include <cstdint>
88 #include <cstdlib>
89 #include <map>
90 #include <memory>
91 #include <string>
92 #include <tuple>
93 #include <utility>
94 
95 using namespace clang;
96 
97 unsigned ASTContext::NumImplicitDefaultConstructors;
98 unsigned ASTContext::NumImplicitDefaultConstructorsDeclared;
99 unsigned ASTContext::NumImplicitCopyConstructors;
100 unsigned ASTContext::NumImplicitCopyConstructorsDeclared;
101 unsigned ASTContext::NumImplicitMoveConstructors;
102 unsigned ASTContext::NumImplicitMoveConstructorsDeclared;
103 unsigned ASTContext::NumImplicitCopyAssignmentOperators;
104 unsigned ASTContext::NumImplicitCopyAssignmentOperatorsDeclared;
105 unsigned ASTContext::NumImplicitMoveAssignmentOperators;
106 unsigned ASTContext::NumImplicitMoveAssignmentOperatorsDeclared;
107 unsigned ASTContext::NumImplicitDestructors;
108 unsigned ASTContext::NumImplicitDestructorsDeclared;
109 
110 enum FloatingRank {
111   Float16Rank, HalfRank, FloatRank, DoubleRank, LongDoubleRank, Float128Rank
112 };
113 
114 RawComment *ASTContext::getRawCommentForDeclNoCache(const Decl *D) const {
115   if (!CommentsLoaded && ExternalSource) {
116     ExternalSource->ReadComments();
117 
118 #ifndef NDEBUG
119     ArrayRef<RawComment *> RawComments = Comments.getComments();
120     assert(std::is_sorted(RawComments.begin(), RawComments.end(),
121                           BeforeThanCompare<RawComment>(SourceMgr)));
122 #endif
123 
124     CommentsLoaded = true;
125   }
126 
127   assert(D);
128 
129   // User can not attach documentation to implicit declarations.
130   if (D->isImplicit())
131     return nullptr;
132 
133   // User can not attach documentation to implicit instantiations.
134   if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
135     if (FD->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
136       return nullptr;
137   }
138 
139   if (const auto *VD = dyn_cast<VarDecl>(D)) {
140     if (VD->isStaticDataMember() &&
141         VD->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
142       return nullptr;
143   }
144 
145   if (const auto *CRD = dyn_cast<CXXRecordDecl>(D)) {
146     if (CRD->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
147       return nullptr;
148   }
149 
150   if (const auto *CTSD = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
151     TemplateSpecializationKind TSK = CTSD->getSpecializationKind();
152     if (TSK == TSK_ImplicitInstantiation ||
153         TSK == TSK_Undeclared)
154       return nullptr;
155   }
156 
157   if (const auto *ED = dyn_cast<EnumDecl>(D)) {
158     if (ED->getTemplateSpecializationKind() == TSK_ImplicitInstantiation)
159       return nullptr;
160   }
161   if (const auto *TD = dyn_cast<TagDecl>(D)) {
162     // When tag declaration (but not definition!) is part of the
163     // decl-specifier-seq of some other declaration, it doesn't get comment
164     if (TD->isEmbeddedInDeclarator() && !TD->isCompleteDefinition())
165       return nullptr;
166   }
167   // TODO: handle comments for function parameters properly.
168   if (isa<ParmVarDecl>(D))
169     return nullptr;
170 
171   // TODO: we could look up template parameter documentation in the template
172   // documentation.
173   if (isa<TemplateTypeParmDecl>(D) ||
174       isa<NonTypeTemplateParmDecl>(D) ||
175       isa<TemplateTemplateParmDecl>(D))
176     return nullptr;
177 
178   ArrayRef<RawComment *> RawComments = Comments.getComments();
179 
180   // If there are no comments anywhere, we won't find anything.
181   if (RawComments.empty())
182     return nullptr;
183 
184   // Find declaration location.
185   // For Objective-C declarations we generally don't expect to have multiple
186   // declarators, thus use declaration starting location as the "declaration
187   // location".
188   // For all other declarations multiple declarators are used quite frequently,
189   // so we use the location of the identifier as the "declaration location".
190   SourceLocation DeclLoc;
191   if (isa<ObjCMethodDecl>(D) || isa<ObjCContainerDecl>(D) ||
192       isa<ObjCPropertyDecl>(D) ||
193       isa<RedeclarableTemplateDecl>(D) ||
194       isa<ClassTemplateSpecializationDecl>(D))
195     DeclLoc = D->getLocStart();
196   else {
197     DeclLoc = D->getLocation();
198     if (DeclLoc.isMacroID()) {
199       if (isa<TypedefDecl>(D)) {
200         // If location of the typedef name is in a macro, it is because being
201         // declared via a macro. Try using declaration's starting location as
202         // the "declaration location".
203         DeclLoc = D->getLocStart();
204       } else if (const auto *TD = dyn_cast<TagDecl>(D)) {
205         // If location of the tag decl is inside a macro, but the spelling of
206         // the tag name comes from a macro argument, it looks like a special
207         // macro like NS_ENUM is being used to define the tag decl.  In that
208         // case, adjust the source location to the expansion loc so that we can
209         // attach the comment to the tag decl.
210         if (SourceMgr.isMacroArgExpansion(DeclLoc) &&
211             TD->isCompleteDefinition())
212           DeclLoc = SourceMgr.getExpansionLoc(DeclLoc);
213       }
214     }
215   }
216 
217   // If the declaration doesn't map directly to a location in a file, we
218   // can't find the comment.
219   if (DeclLoc.isInvalid() || !DeclLoc.isFileID())
220     return nullptr;
221 
222   // Find the comment that occurs just after this declaration.
223   ArrayRef<RawComment *>::iterator Comment;
224   {
225     // When searching for comments during parsing, the comment we are looking
226     // for is usually among the last two comments we parsed -- check them
227     // first.
228     RawComment CommentAtDeclLoc(
229         SourceMgr, SourceRange(DeclLoc), LangOpts.CommentOpts, false);
230     BeforeThanCompare<RawComment> Compare(SourceMgr);
231     ArrayRef<RawComment *>::iterator MaybeBeforeDecl = RawComments.end() - 1;
232     bool Found = Compare(*MaybeBeforeDecl, &CommentAtDeclLoc);
233     if (!Found && RawComments.size() >= 2) {
234       MaybeBeforeDecl--;
235       Found = Compare(*MaybeBeforeDecl, &CommentAtDeclLoc);
236     }
237 
238     if (Found) {
239       Comment = MaybeBeforeDecl + 1;
240       assert(Comment == std::lower_bound(RawComments.begin(), RawComments.end(),
241                                          &CommentAtDeclLoc, Compare));
242     } else {
243       // Slow path.
244       Comment = std::lower_bound(RawComments.begin(), RawComments.end(),
245                                  &CommentAtDeclLoc, Compare);
246     }
247   }
248 
249   // Decompose the location for the declaration and find the beginning of the
250   // file buffer.
251   std::pair<FileID, unsigned> DeclLocDecomp = SourceMgr.getDecomposedLoc(DeclLoc);
252 
253   // First check whether we have a trailing comment.
254   if (Comment != RawComments.end() &&
255       ((*Comment)->isDocumentation() || LangOpts.CommentOpts.ParseAllComments)
256       && (*Comment)->isTrailingComment() &&
257       (isa<FieldDecl>(D) || isa<EnumConstantDecl>(D) || isa<VarDecl>(D) ||
258        isa<ObjCMethodDecl>(D) || isa<ObjCPropertyDecl>(D))) {
259     std::pair<FileID, unsigned> CommentBeginDecomp
260       = SourceMgr.getDecomposedLoc((*Comment)->getSourceRange().getBegin());
261     // Check that Doxygen trailing comment comes after the declaration, starts
262     // on the same line and in the same file as the declaration.
263     if (DeclLocDecomp.first == CommentBeginDecomp.first &&
264         SourceMgr.getLineNumber(DeclLocDecomp.first, DeclLocDecomp.second)
265           == SourceMgr.getLineNumber(CommentBeginDecomp.first,
266                                      CommentBeginDecomp.second)) {
267       return *Comment;
268     }
269   }
270 
271   // The comment just after the declaration was not a trailing comment.
272   // Let's look at the previous comment.
273   if (Comment == RawComments.begin())
274     return nullptr;
275   --Comment;
276 
277   // Check that we actually have a non-member Doxygen comment.
278   if (!((*Comment)->isDocumentation() ||
279         LangOpts.CommentOpts.ParseAllComments) ||
280       (*Comment)->isTrailingComment())
281     return nullptr;
282 
283   // Decompose the end of the comment.
284   std::pair<FileID, unsigned> CommentEndDecomp
285     = SourceMgr.getDecomposedLoc((*Comment)->getSourceRange().getEnd());
286 
287   // If the comment and the declaration aren't in the same file, then they
288   // aren't related.
289   if (DeclLocDecomp.first != CommentEndDecomp.first)
290     return nullptr;
291 
292   // Get the corresponding buffer.
293   bool Invalid = false;
294   const char *Buffer = SourceMgr.getBufferData(DeclLocDecomp.first,
295                                                &Invalid).data();
296   if (Invalid)
297     return nullptr;
298 
299   // Extract text between the comment and declaration.
300   StringRef Text(Buffer + CommentEndDecomp.second,
301                  DeclLocDecomp.second - CommentEndDecomp.second);
302 
303   // There should be no other declarations or preprocessor directives between
304   // comment and declaration.
305   if (Text.find_first_of(";{}#@") != StringRef::npos)
306     return nullptr;
307 
308   return *Comment;
309 }
310 
311 /// If we have a 'templated' declaration for a template, adjust 'D' to
312 /// refer to the actual template.
313 /// If we have an implicit instantiation, adjust 'D' to refer to template.
314 static const Decl *adjustDeclToTemplate(const Decl *D) {
315   if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
316     // Is this function declaration part of a function template?
317     if (const FunctionTemplateDecl *FTD = FD->getDescribedFunctionTemplate())
318       return FTD;
319 
320     // Nothing to do if function is not an implicit instantiation.
321     if (FD->getTemplateSpecializationKind() != TSK_ImplicitInstantiation)
322       return D;
323 
324     // Function is an implicit instantiation of a function template?
325     if (const FunctionTemplateDecl *FTD = FD->getPrimaryTemplate())
326       return FTD;
327 
328     // Function is instantiated from a member definition of a class template?
329     if (const FunctionDecl *MemberDecl =
330             FD->getInstantiatedFromMemberFunction())
331       return MemberDecl;
332 
333     return D;
334   }
335   if (const auto *VD = dyn_cast<VarDecl>(D)) {
336     // Static data member is instantiated from a member definition of a class
337     // template?
338     if (VD->isStaticDataMember())
339       if (const VarDecl *MemberDecl = VD->getInstantiatedFromStaticDataMember())
340         return MemberDecl;
341 
342     return D;
343   }
344   if (const auto *CRD = dyn_cast<CXXRecordDecl>(D)) {
345     // Is this class declaration part of a class template?
346     if (const ClassTemplateDecl *CTD = CRD->getDescribedClassTemplate())
347       return CTD;
348 
349     // Class is an implicit instantiation of a class template or partial
350     // specialization?
351     if (const auto *CTSD = dyn_cast<ClassTemplateSpecializationDecl>(CRD)) {
352       if (CTSD->getSpecializationKind() != TSK_ImplicitInstantiation)
353         return D;
354       llvm::PointerUnion<ClassTemplateDecl *,
355                          ClassTemplatePartialSpecializationDecl *>
356           PU = CTSD->getSpecializedTemplateOrPartial();
357       return PU.is<ClassTemplateDecl*>() ?
358           static_cast<const Decl*>(PU.get<ClassTemplateDecl *>()) :
359           static_cast<const Decl*>(
360               PU.get<ClassTemplatePartialSpecializationDecl *>());
361     }
362 
363     // Class is instantiated from a member definition of a class template?
364     if (const MemberSpecializationInfo *Info =
365                    CRD->getMemberSpecializationInfo())
366       return Info->getInstantiatedFrom();
367 
368     return D;
369   }
370   if (const auto *ED = dyn_cast<EnumDecl>(D)) {
371     // Enum is instantiated from a member definition of a class template?
372     if (const EnumDecl *MemberDecl = ED->getInstantiatedFromMemberEnum())
373       return MemberDecl;
374 
375     return D;
376   }
377   // FIXME: Adjust alias templates?
378   return D;
379 }
380 
381 const RawComment *ASTContext::getRawCommentForAnyRedecl(
382                                                 const Decl *D,
383                                                 const Decl **OriginalDecl) const {
384   D = adjustDeclToTemplate(D);
385 
386   // Check whether we have cached a comment for this declaration already.
387   {
388     llvm::DenseMap<const Decl *, RawCommentAndCacheFlags>::iterator Pos =
389         RedeclComments.find(D);
390     if (Pos != RedeclComments.end()) {
391       const RawCommentAndCacheFlags &Raw = Pos->second;
392       if (Raw.getKind() != RawCommentAndCacheFlags::NoCommentInDecl) {
393         if (OriginalDecl)
394           *OriginalDecl = Raw.getOriginalDecl();
395         return Raw.getRaw();
396       }
397     }
398   }
399 
400   // Search for comments attached to declarations in the redeclaration chain.
401   const RawComment *RC = nullptr;
402   const Decl *OriginalDeclForRC = nullptr;
403   for (auto I : D->redecls()) {
404     llvm::DenseMap<const Decl *, RawCommentAndCacheFlags>::iterator Pos =
405         RedeclComments.find(I);
406     if (Pos != RedeclComments.end()) {
407       const RawCommentAndCacheFlags &Raw = Pos->second;
408       if (Raw.getKind() != RawCommentAndCacheFlags::NoCommentInDecl) {
409         RC = Raw.getRaw();
410         OriginalDeclForRC = Raw.getOriginalDecl();
411         break;
412       }
413     } else {
414       RC = getRawCommentForDeclNoCache(I);
415       OriginalDeclForRC = I;
416       RawCommentAndCacheFlags Raw;
417       if (RC) {
418         // Call order swapped to work around ICE in VS2015 RTM (Release Win32)
419         // https://connect.microsoft.com/VisualStudio/feedback/details/1741530
420         Raw.setKind(RawCommentAndCacheFlags::FromDecl);
421         Raw.setRaw(RC);
422       } else
423         Raw.setKind(RawCommentAndCacheFlags::NoCommentInDecl);
424       Raw.setOriginalDecl(I);
425       RedeclComments[I] = Raw;
426       if (RC)
427         break;
428     }
429   }
430 
431   // If we found a comment, it should be a documentation comment.
432   assert(!RC || RC->isDocumentation() || LangOpts.CommentOpts.ParseAllComments);
433 
434   if (OriginalDecl)
435     *OriginalDecl = OriginalDeclForRC;
436 
437   // Update cache for every declaration in the redeclaration chain.
438   RawCommentAndCacheFlags Raw;
439   Raw.setRaw(RC);
440   Raw.setKind(RawCommentAndCacheFlags::FromRedecl);
441   Raw.setOriginalDecl(OriginalDeclForRC);
442 
443   for (auto I : D->redecls()) {
444     RawCommentAndCacheFlags &R = RedeclComments[I];
445     if (R.getKind() == RawCommentAndCacheFlags::NoCommentInDecl)
446       R = Raw;
447   }
448 
449   return RC;
450 }
451 
452 static void addRedeclaredMethods(const ObjCMethodDecl *ObjCMethod,
453                    SmallVectorImpl<const NamedDecl *> &Redeclared) {
454   const DeclContext *DC = ObjCMethod->getDeclContext();
455   if (const auto *IMD = dyn_cast<ObjCImplDecl>(DC)) {
456     const ObjCInterfaceDecl *ID = IMD->getClassInterface();
457     if (!ID)
458       return;
459     // Add redeclared method here.
460     for (const auto *Ext : ID->known_extensions()) {
461       if (ObjCMethodDecl *RedeclaredMethod =
462             Ext->getMethod(ObjCMethod->getSelector(),
463                                   ObjCMethod->isInstanceMethod()))
464         Redeclared.push_back(RedeclaredMethod);
465     }
466   }
467 }
468 
469 comments::FullComment *ASTContext::cloneFullComment(comments::FullComment *FC,
470                                                     const Decl *D) const {
471   auto *ThisDeclInfo = new (*this) comments::DeclInfo;
472   ThisDeclInfo->CommentDecl = D;
473   ThisDeclInfo->IsFilled = false;
474   ThisDeclInfo->fill();
475   ThisDeclInfo->CommentDecl = FC->getDecl();
476   if (!ThisDeclInfo->TemplateParameters)
477     ThisDeclInfo->TemplateParameters = FC->getDeclInfo()->TemplateParameters;
478   comments::FullComment *CFC =
479     new (*this) comments::FullComment(FC->getBlocks(),
480                                       ThisDeclInfo);
481   return CFC;
482 }
483 
484 comments::FullComment *ASTContext::getLocalCommentForDeclUncached(const Decl *D) const {
485   const RawComment *RC = getRawCommentForDeclNoCache(D);
486   return RC ? RC->parse(*this, nullptr, D) : nullptr;
487 }
488 
489 comments::FullComment *ASTContext::getCommentForDecl(
490                                               const Decl *D,
491                                               const Preprocessor *PP) const {
492   if (D->isInvalidDecl())
493     return nullptr;
494   D = adjustDeclToTemplate(D);
495 
496   const Decl *Canonical = D->getCanonicalDecl();
497   llvm::DenseMap<const Decl *, comments::FullComment *>::iterator Pos =
498       ParsedComments.find(Canonical);
499 
500   if (Pos != ParsedComments.end()) {
501     if (Canonical != D) {
502       comments::FullComment *FC = Pos->second;
503       comments::FullComment *CFC = cloneFullComment(FC, D);
504       return CFC;
505     }
506     return Pos->second;
507   }
508 
509   const Decl *OriginalDecl;
510 
511   const RawComment *RC = getRawCommentForAnyRedecl(D, &OriginalDecl);
512   if (!RC) {
513     if (isa<ObjCMethodDecl>(D) || isa<FunctionDecl>(D)) {
514       SmallVector<const NamedDecl*, 8> Overridden;
515       const auto *OMD = dyn_cast<ObjCMethodDecl>(D);
516       if (OMD && OMD->isPropertyAccessor())
517         if (const ObjCPropertyDecl *PDecl = OMD->findPropertyDecl())
518           if (comments::FullComment *FC = getCommentForDecl(PDecl, PP))
519             return cloneFullComment(FC, D);
520       if (OMD)
521         addRedeclaredMethods(OMD, Overridden);
522       getOverriddenMethods(dyn_cast<NamedDecl>(D), Overridden);
523       for (unsigned i = 0, e = Overridden.size(); i < e; i++)
524         if (comments::FullComment *FC = getCommentForDecl(Overridden[i], PP))
525           return cloneFullComment(FC, D);
526     }
527     else if (const auto *TD = dyn_cast<TypedefNameDecl>(D)) {
528       // Attach any tag type's documentation to its typedef if latter
529       // does not have one of its own.
530       QualType QT = TD->getUnderlyingType();
531       if (const auto *TT = QT->getAs<TagType>())
532         if (const Decl *TD = TT->getDecl())
533           if (comments::FullComment *FC = getCommentForDecl(TD, PP))
534             return cloneFullComment(FC, D);
535     }
536     else if (const auto *IC = dyn_cast<ObjCInterfaceDecl>(D)) {
537       while (IC->getSuperClass()) {
538         IC = IC->getSuperClass();
539         if (comments::FullComment *FC = getCommentForDecl(IC, PP))
540           return cloneFullComment(FC, D);
541       }
542     }
543     else if (const auto *CD = dyn_cast<ObjCCategoryDecl>(D)) {
544       if (const ObjCInterfaceDecl *IC = CD->getClassInterface())
545         if (comments::FullComment *FC = getCommentForDecl(IC, PP))
546           return cloneFullComment(FC, D);
547     }
548     else if (const auto *RD = dyn_cast<CXXRecordDecl>(D)) {
549       if (!(RD = RD->getDefinition()))
550         return nullptr;
551       // Check non-virtual bases.
552       for (const auto &I : RD->bases()) {
553         if (I.isVirtual() || (I.getAccessSpecifier() != AS_public))
554           continue;
555         QualType Ty = I.getType();
556         if (Ty.isNull())
557           continue;
558         if (const CXXRecordDecl *NonVirtualBase = Ty->getAsCXXRecordDecl()) {
559           if (!(NonVirtualBase= NonVirtualBase->getDefinition()))
560             continue;
561 
562           if (comments::FullComment *FC = getCommentForDecl((NonVirtualBase), PP))
563             return cloneFullComment(FC, D);
564         }
565       }
566       // Check virtual bases.
567       for (const auto &I : RD->vbases()) {
568         if (I.getAccessSpecifier() != AS_public)
569           continue;
570         QualType Ty = I.getType();
571         if (Ty.isNull())
572           continue;
573         if (const CXXRecordDecl *VirtualBase = Ty->getAsCXXRecordDecl()) {
574           if (!(VirtualBase= VirtualBase->getDefinition()))
575             continue;
576           if (comments::FullComment *FC = getCommentForDecl((VirtualBase), PP))
577             return cloneFullComment(FC, D);
578         }
579       }
580     }
581     return nullptr;
582   }
583 
584   // If the RawComment was attached to other redeclaration of this Decl, we
585   // should parse the comment in context of that other Decl.  This is important
586   // because comments can contain references to parameter names which can be
587   // different across redeclarations.
588   if (D != OriginalDecl)
589     return getCommentForDecl(OriginalDecl, PP);
590 
591   comments::FullComment *FC = RC->parse(*this, PP, D);
592   ParsedComments[Canonical] = FC;
593   return FC;
594 }
595 
596 void
597 ASTContext::CanonicalTemplateTemplateParm::Profile(llvm::FoldingSetNodeID &ID,
598                                                TemplateTemplateParmDecl *Parm) {
599   ID.AddInteger(Parm->getDepth());
600   ID.AddInteger(Parm->getPosition());
601   ID.AddBoolean(Parm->isParameterPack());
602 
603   TemplateParameterList *Params = Parm->getTemplateParameters();
604   ID.AddInteger(Params->size());
605   for (TemplateParameterList::const_iterator P = Params->begin(),
606                                           PEnd = Params->end();
607        P != PEnd; ++P) {
608     if (const auto *TTP = dyn_cast<TemplateTypeParmDecl>(*P)) {
609       ID.AddInteger(0);
610       ID.AddBoolean(TTP->isParameterPack());
611       continue;
612     }
613 
614     if (const auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(*P)) {
615       ID.AddInteger(1);
616       ID.AddBoolean(NTTP->isParameterPack());
617       ID.AddPointer(NTTP->getType().getCanonicalType().getAsOpaquePtr());
618       if (NTTP->isExpandedParameterPack()) {
619         ID.AddBoolean(true);
620         ID.AddInteger(NTTP->getNumExpansionTypes());
621         for (unsigned I = 0, N = NTTP->getNumExpansionTypes(); I != N; ++I) {
622           QualType T = NTTP->getExpansionType(I);
623           ID.AddPointer(T.getCanonicalType().getAsOpaquePtr());
624         }
625       } else
626         ID.AddBoolean(false);
627       continue;
628     }
629 
630     auto *TTP = cast<TemplateTemplateParmDecl>(*P);
631     ID.AddInteger(2);
632     Profile(ID, TTP);
633   }
634 }
635 
636 TemplateTemplateParmDecl *
637 ASTContext::getCanonicalTemplateTemplateParmDecl(
638                                           TemplateTemplateParmDecl *TTP) const {
639   // Check if we already have a canonical template template parameter.
640   llvm::FoldingSetNodeID ID;
641   CanonicalTemplateTemplateParm::Profile(ID, TTP);
642   void *InsertPos = nullptr;
643   CanonicalTemplateTemplateParm *Canonical
644     = CanonTemplateTemplateParms.FindNodeOrInsertPos(ID, InsertPos);
645   if (Canonical)
646     return Canonical->getParam();
647 
648   // Build a canonical template parameter list.
649   TemplateParameterList *Params = TTP->getTemplateParameters();
650   SmallVector<NamedDecl *, 4> CanonParams;
651   CanonParams.reserve(Params->size());
652   for (TemplateParameterList::const_iterator P = Params->begin(),
653                                           PEnd = Params->end();
654        P != PEnd; ++P) {
655     if (const auto *TTP = dyn_cast<TemplateTypeParmDecl>(*P))
656       CanonParams.push_back(
657                   TemplateTypeParmDecl::Create(*this, getTranslationUnitDecl(),
658                                                SourceLocation(),
659                                                SourceLocation(),
660                                                TTP->getDepth(),
661                                                TTP->getIndex(), nullptr, false,
662                                                TTP->isParameterPack()));
663     else if (const auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(*P)) {
664       QualType T = getCanonicalType(NTTP->getType());
665       TypeSourceInfo *TInfo = getTrivialTypeSourceInfo(T);
666       NonTypeTemplateParmDecl *Param;
667       if (NTTP->isExpandedParameterPack()) {
668         SmallVector<QualType, 2> ExpandedTypes;
669         SmallVector<TypeSourceInfo *, 2> ExpandedTInfos;
670         for (unsigned I = 0, N = NTTP->getNumExpansionTypes(); I != N; ++I) {
671           ExpandedTypes.push_back(getCanonicalType(NTTP->getExpansionType(I)));
672           ExpandedTInfos.push_back(
673                                 getTrivialTypeSourceInfo(ExpandedTypes.back()));
674         }
675 
676         Param = NonTypeTemplateParmDecl::Create(*this, getTranslationUnitDecl(),
677                                                 SourceLocation(),
678                                                 SourceLocation(),
679                                                 NTTP->getDepth(),
680                                                 NTTP->getPosition(), nullptr,
681                                                 T,
682                                                 TInfo,
683                                                 ExpandedTypes,
684                                                 ExpandedTInfos);
685       } else {
686         Param = NonTypeTemplateParmDecl::Create(*this, getTranslationUnitDecl(),
687                                                 SourceLocation(),
688                                                 SourceLocation(),
689                                                 NTTP->getDepth(),
690                                                 NTTP->getPosition(), nullptr,
691                                                 T,
692                                                 NTTP->isParameterPack(),
693                                                 TInfo);
694       }
695       CanonParams.push_back(Param);
696 
697     } else
698       CanonParams.push_back(getCanonicalTemplateTemplateParmDecl(
699                                            cast<TemplateTemplateParmDecl>(*P)));
700   }
701 
702   assert(!TTP->getRequiresClause() &&
703          "Unexpected requires-clause on template template-parameter");
704   Expr *const CanonRequiresClause = nullptr;
705 
706   TemplateTemplateParmDecl *CanonTTP
707     = TemplateTemplateParmDecl::Create(*this, getTranslationUnitDecl(),
708                                        SourceLocation(), TTP->getDepth(),
709                                        TTP->getPosition(),
710                                        TTP->isParameterPack(),
711                                        nullptr,
712                          TemplateParameterList::Create(*this, SourceLocation(),
713                                                        SourceLocation(),
714                                                        CanonParams,
715                                                        SourceLocation(),
716                                                        CanonRequiresClause));
717 
718   // Get the new insert position for the node we care about.
719   Canonical = CanonTemplateTemplateParms.FindNodeOrInsertPos(ID, InsertPos);
720   assert(!Canonical && "Shouldn't be in the map!");
721   (void)Canonical;
722 
723   // Create the canonical template template parameter entry.
724   Canonical = new (*this) CanonicalTemplateTemplateParm(CanonTTP);
725   CanonTemplateTemplateParms.InsertNode(Canonical, InsertPos);
726   return CanonTTP;
727 }
728 
729 CXXABI *ASTContext::createCXXABI(const TargetInfo &T) {
730   if (!LangOpts.CPlusPlus) return nullptr;
731 
732   switch (T.getCXXABI().getKind()) {
733   case TargetCXXABI::GenericARM: // Same as Itanium at this level
734   case TargetCXXABI::iOS:
735   case TargetCXXABI::iOS64:
736   case TargetCXXABI::WatchOS:
737   case TargetCXXABI::GenericAArch64:
738   case TargetCXXABI::GenericMIPS:
739   case TargetCXXABI::GenericItanium:
740   case TargetCXXABI::WebAssembly:
741     return CreateItaniumCXXABI(*this);
742   case TargetCXXABI::Microsoft:
743     return CreateMicrosoftCXXABI(*this);
744   }
745   llvm_unreachable("Invalid CXXABI type!");
746 }
747 
748 static const LangASMap *getAddressSpaceMap(const TargetInfo &T,
749                                            const LangOptions &LOpts) {
750   if (LOpts.FakeAddressSpaceMap) {
751     // The fake address space map must have a distinct entry for each
752     // language-specific address space.
753     static const unsigned FakeAddrSpaceMap[] = {
754       0, // Default
755       1, // opencl_global
756       3, // opencl_local
757       2, // opencl_constant
758       0, // opencl_private
759       4, // opencl_generic
760       5, // cuda_device
761       6, // cuda_constant
762       7  // cuda_shared
763     };
764     return &FakeAddrSpaceMap;
765   } else {
766     return &T.getAddressSpaceMap();
767   }
768 }
769 
770 static bool isAddrSpaceMapManglingEnabled(const TargetInfo &TI,
771                                           const LangOptions &LangOpts) {
772   switch (LangOpts.getAddressSpaceMapMangling()) {
773   case LangOptions::ASMM_Target:
774     return TI.useAddressSpaceMapMangling();
775   case LangOptions::ASMM_On:
776     return true;
777   case LangOptions::ASMM_Off:
778     return false;
779   }
780   llvm_unreachable("getAddressSpaceMapMangling() doesn't cover anything.");
781 }
782 
783 ASTContext::ASTContext(LangOptions &LOpts, SourceManager &SM,
784                        IdentifierTable &idents, SelectorTable &sels,
785                        Builtin::Context &builtins)
786     : FunctionProtoTypes(this_()), TemplateSpecializationTypes(this_()),
787       DependentTemplateSpecializationTypes(this_()),
788       SubstTemplateTemplateParmPacks(this_()), SourceMgr(SM), LangOpts(LOpts),
789       SanitizerBL(new SanitizerBlacklist(LangOpts.SanitizerBlacklistFiles, SM)),
790       XRayFilter(new XRayFunctionFilter(LangOpts.XRayAlwaysInstrumentFiles,
791                                         LangOpts.XRayNeverInstrumentFiles,
792                                         LangOpts.XRayAttrListFiles, SM)),
793       PrintingPolicy(LOpts), Idents(idents), Selectors(sels),
794       BuiltinInfo(builtins), DeclarationNames(*this), Comments(SM),
795       CommentCommandTraits(BumpAlloc, LOpts.CommentOpts),
796       CompCategories(this_()), LastSDM(nullptr, 0) {
797   TUDecl = TranslationUnitDecl::Create(*this);
798 }
799 
800 ASTContext::~ASTContext() {
801   ReleaseParentMapEntries();
802 
803   // Release the DenseMaps associated with DeclContext objects.
804   // FIXME: Is this the ideal solution?
805   ReleaseDeclContextMaps();
806 
807   // Call all of the deallocation functions on all of their targets.
808   for (auto &Pair : Deallocations)
809     (Pair.first)(Pair.second);
810 
811   // ASTRecordLayout objects in ASTRecordLayouts must always be destroyed
812   // because they can contain DenseMaps.
813   for (llvm::DenseMap<const ObjCContainerDecl*,
814        const ASTRecordLayout*>::iterator
815        I = ObjCLayouts.begin(), E = ObjCLayouts.end(); I != E; )
816     // Increment in loop to prevent using deallocated memory.
817     if (auto *R = const_cast<ASTRecordLayout *>((I++)->second))
818       R->Destroy(*this);
819 
820   for (llvm::DenseMap<const RecordDecl*, const ASTRecordLayout*>::iterator
821        I = ASTRecordLayouts.begin(), E = ASTRecordLayouts.end(); I != E; ) {
822     // Increment in loop to prevent using deallocated memory.
823     if (auto *R = const_cast<ASTRecordLayout *>((I++)->second))
824       R->Destroy(*this);
825   }
826 
827   for (llvm::DenseMap<const Decl*, AttrVec*>::iterator A = DeclAttrs.begin(),
828                                                     AEnd = DeclAttrs.end();
829        A != AEnd; ++A)
830     A->second->~AttrVec();
831 
832   for (std::pair<const MaterializeTemporaryExpr *, APValue *> &MTVPair :
833        MaterializedTemporaryValues)
834     MTVPair.second->~APValue();
835 
836   for (const auto &Value : ModuleInitializers)
837     Value.second->~PerModuleInitializers();
838 }
839 
840 void ASTContext::ReleaseParentMapEntries() {
841   if (!PointerParents) return;
842   for (const auto &Entry : *PointerParents) {
843     if (Entry.second.is<ast_type_traits::DynTypedNode *>()) {
844       delete Entry.second.get<ast_type_traits::DynTypedNode *>();
845     } else if (Entry.second.is<ParentVector *>()) {
846       delete Entry.second.get<ParentVector *>();
847     }
848   }
849   for (const auto &Entry : *OtherParents) {
850     if (Entry.second.is<ast_type_traits::DynTypedNode *>()) {
851       delete Entry.second.get<ast_type_traits::DynTypedNode *>();
852     } else if (Entry.second.is<ParentVector *>()) {
853       delete Entry.second.get<ParentVector *>();
854     }
855   }
856 }
857 
858 void ASTContext::AddDeallocation(void (*Callback)(void*), void *Data) {
859   Deallocations.push_back({Callback, Data});
860 }
861 
862 void
863 ASTContext::setExternalSource(IntrusiveRefCntPtr<ExternalASTSource> Source) {
864   ExternalSource = std::move(Source);
865 }
866 
867 void ASTContext::PrintStats() const {
868   llvm::errs() << "\n*** AST Context Stats:\n";
869   llvm::errs() << "  " << Types.size() << " types total.\n";
870 
871   unsigned counts[] = {
872 #define TYPE(Name, Parent) 0,
873 #define ABSTRACT_TYPE(Name, Parent)
874 #include "clang/AST/TypeNodes.def"
875     0 // Extra
876   };
877 
878   for (unsigned i = 0, e = Types.size(); i != e; ++i) {
879     Type *T = Types[i];
880     counts[(unsigned)T->getTypeClass()]++;
881   }
882 
883   unsigned Idx = 0;
884   unsigned TotalBytes = 0;
885 #define TYPE(Name, Parent)                                              \
886   if (counts[Idx])                                                      \
887     llvm::errs() << "    " << counts[Idx] << " " << #Name               \
888                  << " types\n";                                         \
889   TotalBytes += counts[Idx] * sizeof(Name##Type);                       \
890   ++Idx;
891 #define ABSTRACT_TYPE(Name, Parent)
892 #include "clang/AST/TypeNodes.def"
893 
894   llvm::errs() << "Total bytes = " << TotalBytes << "\n";
895 
896   // Implicit special member functions.
897   llvm::errs() << NumImplicitDefaultConstructorsDeclared << "/"
898                << NumImplicitDefaultConstructors
899                << " implicit default constructors created\n";
900   llvm::errs() << NumImplicitCopyConstructorsDeclared << "/"
901                << NumImplicitCopyConstructors
902                << " implicit copy constructors created\n";
903   if (getLangOpts().CPlusPlus)
904     llvm::errs() << NumImplicitMoveConstructorsDeclared << "/"
905                  << NumImplicitMoveConstructors
906                  << " implicit move constructors created\n";
907   llvm::errs() << NumImplicitCopyAssignmentOperatorsDeclared << "/"
908                << NumImplicitCopyAssignmentOperators
909                << " implicit copy assignment operators created\n";
910   if (getLangOpts().CPlusPlus)
911     llvm::errs() << NumImplicitMoveAssignmentOperatorsDeclared << "/"
912                  << NumImplicitMoveAssignmentOperators
913                  << " implicit move assignment operators created\n";
914   llvm::errs() << NumImplicitDestructorsDeclared << "/"
915                << NumImplicitDestructors
916                << " implicit destructors created\n";
917 
918   if (ExternalSource) {
919     llvm::errs() << "\n";
920     ExternalSource->PrintStats();
921   }
922 
923   BumpAlloc.PrintStats();
924 }
925 
926 void ASTContext::mergeDefinitionIntoModule(NamedDecl *ND, Module *M,
927                                            bool NotifyListeners) {
928   if (NotifyListeners)
929     if (auto *Listener = getASTMutationListener())
930       Listener->RedefinedHiddenDefinition(ND, M);
931 
932   if (getLangOpts().ModulesLocalVisibility)
933     MergedDefModules[ND].push_back(M);
934   else
935     ND->setVisibleDespiteOwningModule();
936 }
937 
938 void ASTContext::deduplicateMergedDefinitonsFor(NamedDecl *ND) {
939   auto It = MergedDefModules.find(ND);
940   if (It == MergedDefModules.end())
941     return;
942 
943   auto &Merged = It->second;
944   llvm::DenseSet<Module*> Found;
945   for (Module *&M : Merged)
946     if (!Found.insert(M).second)
947       M = nullptr;
948   Merged.erase(std::remove(Merged.begin(), Merged.end(), nullptr), Merged.end());
949 }
950 
951 void ASTContext::PerModuleInitializers::resolve(ASTContext &Ctx) {
952   if (LazyInitializers.empty())
953     return;
954 
955   auto *Source = Ctx.getExternalSource();
956   assert(Source && "lazy initializers but no external source");
957 
958   auto LazyInits = std::move(LazyInitializers);
959   LazyInitializers.clear();
960 
961   for (auto ID : LazyInits)
962     Initializers.push_back(Source->GetExternalDecl(ID));
963 
964   assert(LazyInitializers.empty() &&
965          "GetExternalDecl for lazy module initializer added more inits");
966 }
967 
968 void ASTContext::addModuleInitializer(Module *M, Decl *D) {
969   // One special case: if we add a module initializer that imports another
970   // module, and that module's only initializer is an ImportDecl, simplify.
971   if (const auto *ID = dyn_cast<ImportDecl>(D)) {
972     auto It = ModuleInitializers.find(ID->getImportedModule());
973 
974     // Maybe the ImportDecl does nothing at all. (Common case.)
975     if (It == ModuleInitializers.end())
976       return;
977 
978     // Maybe the ImportDecl only imports another ImportDecl.
979     auto &Imported = *It->second;
980     if (Imported.Initializers.size() + Imported.LazyInitializers.size() == 1) {
981       Imported.resolve(*this);
982       auto *OnlyDecl = Imported.Initializers.front();
983       if (isa<ImportDecl>(OnlyDecl))
984         D = OnlyDecl;
985     }
986   }
987 
988   auto *&Inits = ModuleInitializers[M];
989   if (!Inits)
990     Inits = new (*this) PerModuleInitializers;
991   Inits->Initializers.push_back(D);
992 }
993 
994 void ASTContext::addLazyModuleInitializers(Module *M, ArrayRef<uint32_t> IDs) {
995   auto *&Inits = ModuleInitializers[M];
996   if (!Inits)
997     Inits = new (*this) PerModuleInitializers;
998   Inits->LazyInitializers.insert(Inits->LazyInitializers.end(),
999                                  IDs.begin(), IDs.end());
1000 }
1001 
1002 ArrayRef<Decl *> ASTContext::getModuleInitializers(Module *M) {
1003   auto It = ModuleInitializers.find(M);
1004   if (It == ModuleInitializers.end())
1005     return None;
1006 
1007   auto *Inits = It->second;
1008   Inits->resolve(*this);
1009   return Inits->Initializers;
1010 }
1011 
1012 ExternCContextDecl *ASTContext::getExternCContextDecl() const {
1013   if (!ExternCContext)
1014     ExternCContext = ExternCContextDecl::Create(*this, getTranslationUnitDecl());
1015 
1016   return ExternCContext;
1017 }
1018 
1019 BuiltinTemplateDecl *
1020 ASTContext::buildBuiltinTemplateDecl(BuiltinTemplateKind BTK,
1021                                      const IdentifierInfo *II) const {
1022   auto *BuiltinTemplate = BuiltinTemplateDecl::Create(*this, TUDecl, II, BTK);
1023   BuiltinTemplate->setImplicit();
1024   TUDecl->addDecl(BuiltinTemplate);
1025 
1026   return BuiltinTemplate;
1027 }
1028 
1029 BuiltinTemplateDecl *
1030 ASTContext::getMakeIntegerSeqDecl() const {
1031   if (!MakeIntegerSeqDecl)
1032     MakeIntegerSeqDecl = buildBuiltinTemplateDecl(BTK__make_integer_seq,
1033                                                   getMakeIntegerSeqName());
1034   return MakeIntegerSeqDecl;
1035 }
1036 
1037 BuiltinTemplateDecl *
1038 ASTContext::getTypePackElementDecl() const {
1039   if (!TypePackElementDecl)
1040     TypePackElementDecl = buildBuiltinTemplateDecl(BTK__type_pack_element,
1041                                                    getTypePackElementName());
1042   return TypePackElementDecl;
1043 }
1044 
1045 RecordDecl *ASTContext::buildImplicitRecord(StringRef Name,
1046                                             RecordDecl::TagKind TK) const {
1047   SourceLocation Loc;
1048   RecordDecl *NewDecl;
1049   if (getLangOpts().CPlusPlus)
1050     NewDecl = CXXRecordDecl::Create(*this, TK, getTranslationUnitDecl(), Loc,
1051                                     Loc, &Idents.get(Name));
1052   else
1053     NewDecl = RecordDecl::Create(*this, TK, getTranslationUnitDecl(), Loc, Loc,
1054                                  &Idents.get(Name));
1055   NewDecl->setImplicit();
1056   NewDecl->addAttr(TypeVisibilityAttr::CreateImplicit(
1057       const_cast<ASTContext &>(*this), TypeVisibilityAttr::Default));
1058   return NewDecl;
1059 }
1060 
1061 TypedefDecl *ASTContext::buildImplicitTypedef(QualType T,
1062                                               StringRef Name) const {
1063   TypeSourceInfo *TInfo = getTrivialTypeSourceInfo(T);
1064   TypedefDecl *NewDecl = TypedefDecl::Create(
1065       const_cast<ASTContext &>(*this), getTranslationUnitDecl(),
1066       SourceLocation(), SourceLocation(), &Idents.get(Name), TInfo);
1067   NewDecl->setImplicit();
1068   return NewDecl;
1069 }
1070 
1071 TypedefDecl *ASTContext::getInt128Decl() const {
1072   if (!Int128Decl)
1073     Int128Decl = buildImplicitTypedef(Int128Ty, "__int128_t");
1074   return Int128Decl;
1075 }
1076 
1077 TypedefDecl *ASTContext::getUInt128Decl() const {
1078   if (!UInt128Decl)
1079     UInt128Decl = buildImplicitTypedef(UnsignedInt128Ty, "__uint128_t");
1080   return UInt128Decl;
1081 }
1082 
1083 void ASTContext::InitBuiltinType(CanQualType &R, BuiltinType::Kind K) {
1084   auto *Ty = new (*this, TypeAlignment) BuiltinType(K);
1085   R = CanQualType::CreateUnsafe(QualType(Ty, 0));
1086   Types.push_back(Ty);
1087 }
1088 
1089 void ASTContext::InitBuiltinTypes(const TargetInfo &Target,
1090                                   const TargetInfo *AuxTarget) {
1091   assert((!this->Target || this->Target == &Target) &&
1092          "Incorrect target reinitialization");
1093   assert(VoidTy.isNull() && "Context reinitialized?");
1094 
1095   this->Target = &Target;
1096   this->AuxTarget = AuxTarget;
1097 
1098   ABI.reset(createCXXABI(Target));
1099   AddrSpaceMap = getAddressSpaceMap(Target, LangOpts);
1100   AddrSpaceMapMangling = isAddrSpaceMapManglingEnabled(Target, LangOpts);
1101 
1102   // C99 6.2.5p19.
1103   InitBuiltinType(VoidTy,              BuiltinType::Void);
1104 
1105   // C99 6.2.5p2.
1106   InitBuiltinType(BoolTy,              BuiltinType::Bool);
1107   // C99 6.2.5p3.
1108   if (LangOpts.CharIsSigned)
1109     InitBuiltinType(CharTy,            BuiltinType::Char_S);
1110   else
1111     InitBuiltinType(CharTy,            BuiltinType::Char_U);
1112   // C99 6.2.5p4.
1113   InitBuiltinType(SignedCharTy,        BuiltinType::SChar);
1114   InitBuiltinType(ShortTy,             BuiltinType::Short);
1115   InitBuiltinType(IntTy,               BuiltinType::Int);
1116   InitBuiltinType(LongTy,              BuiltinType::Long);
1117   InitBuiltinType(LongLongTy,          BuiltinType::LongLong);
1118 
1119   // C99 6.2.5p6.
1120   InitBuiltinType(UnsignedCharTy,      BuiltinType::UChar);
1121   InitBuiltinType(UnsignedShortTy,     BuiltinType::UShort);
1122   InitBuiltinType(UnsignedIntTy,       BuiltinType::UInt);
1123   InitBuiltinType(UnsignedLongTy,      BuiltinType::ULong);
1124   InitBuiltinType(UnsignedLongLongTy,  BuiltinType::ULongLong);
1125 
1126   // C99 6.2.5p10.
1127   InitBuiltinType(FloatTy,             BuiltinType::Float);
1128   InitBuiltinType(DoubleTy,            BuiltinType::Double);
1129   InitBuiltinType(LongDoubleTy,        BuiltinType::LongDouble);
1130 
1131   // GNU extension, __float128 for IEEE quadruple precision
1132   InitBuiltinType(Float128Ty,          BuiltinType::Float128);
1133 
1134   // C11 extension ISO/IEC TS 18661-3
1135   InitBuiltinType(Float16Ty,           BuiltinType::Float16);
1136 
1137   // ISO/IEC JTC1 SC22 WG14 N1169 Extension
1138   InitBuiltinType(ShortAccumTy,            BuiltinType::ShortAccum);
1139   InitBuiltinType(AccumTy,                 BuiltinType::Accum);
1140   InitBuiltinType(LongAccumTy,             BuiltinType::LongAccum);
1141   InitBuiltinType(UnsignedShortAccumTy,    BuiltinType::UShortAccum);
1142   InitBuiltinType(UnsignedAccumTy,         BuiltinType::UAccum);
1143   InitBuiltinType(UnsignedLongAccumTy,     BuiltinType::ULongAccum);
1144   InitBuiltinType(ShortFractTy,            BuiltinType::ShortFract);
1145   InitBuiltinType(FractTy,                 BuiltinType::Fract);
1146   InitBuiltinType(LongFractTy,             BuiltinType::LongFract);
1147   InitBuiltinType(UnsignedShortFractTy,    BuiltinType::UShortFract);
1148   InitBuiltinType(UnsignedFractTy,         BuiltinType::UFract);
1149   InitBuiltinType(UnsignedLongFractTy,     BuiltinType::ULongFract);
1150   InitBuiltinType(SatShortAccumTy,         BuiltinType::SatShortAccum);
1151   InitBuiltinType(SatAccumTy,              BuiltinType::SatAccum);
1152   InitBuiltinType(SatLongAccumTy,          BuiltinType::SatLongAccum);
1153   InitBuiltinType(SatUnsignedShortAccumTy, BuiltinType::SatUShortAccum);
1154   InitBuiltinType(SatUnsignedAccumTy,      BuiltinType::SatUAccum);
1155   InitBuiltinType(SatUnsignedLongAccumTy,  BuiltinType::SatULongAccum);
1156   InitBuiltinType(SatShortFractTy,         BuiltinType::SatShortFract);
1157   InitBuiltinType(SatFractTy,              BuiltinType::SatFract);
1158   InitBuiltinType(SatLongFractTy,          BuiltinType::SatLongFract);
1159   InitBuiltinType(SatUnsignedShortFractTy, BuiltinType::SatUShortFract);
1160   InitBuiltinType(SatUnsignedFractTy,      BuiltinType::SatUFract);
1161   InitBuiltinType(SatUnsignedLongFractTy,  BuiltinType::SatULongFract);
1162 
1163   // GNU extension, 128-bit integers.
1164   InitBuiltinType(Int128Ty,            BuiltinType::Int128);
1165   InitBuiltinType(UnsignedInt128Ty,    BuiltinType::UInt128);
1166 
1167   // C++ 3.9.1p5
1168   if (TargetInfo::isTypeSigned(Target.getWCharType()))
1169     InitBuiltinType(WCharTy,           BuiltinType::WChar_S);
1170   else  // -fshort-wchar makes wchar_t be unsigned.
1171     InitBuiltinType(WCharTy,           BuiltinType::WChar_U);
1172   if (LangOpts.CPlusPlus && LangOpts.WChar)
1173     WideCharTy = WCharTy;
1174   else {
1175     // C99 (or C++ using -fno-wchar).
1176     WideCharTy = getFromTargetType(Target.getWCharType());
1177   }
1178 
1179   WIntTy = getFromTargetType(Target.getWIntType());
1180 
1181   // C++20 (proposed)
1182   InitBuiltinType(Char8Ty,              BuiltinType::Char8);
1183 
1184   if (LangOpts.CPlusPlus) // C++0x 3.9.1p5, extension for C++
1185     InitBuiltinType(Char16Ty,           BuiltinType::Char16);
1186   else // C99
1187     Char16Ty = getFromTargetType(Target.getChar16Type());
1188 
1189   if (LangOpts.CPlusPlus) // C++0x 3.9.1p5, extension for C++
1190     InitBuiltinType(Char32Ty,           BuiltinType::Char32);
1191   else // C99
1192     Char32Ty = getFromTargetType(Target.getChar32Type());
1193 
1194   // Placeholder type for type-dependent expressions whose type is
1195   // completely unknown. No code should ever check a type against
1196   // DependentTy and users should never see it; however, it is here to
1197   // help diagnose failures to properly check for type-dependent
1198   // expressions.
1199   InitBuiltinType(DependentTy,         BuiltinType::Dependent);
1200 
1201   // Placeholder type for functions.
1202   InitBuiltinType(OverloadTy,          BuiltinType::Overload);
1203 
1204   // Placeholder type for bound members.
1205   InitBuiltinType(BoundMemberTy,       BuiltinType::BoundMember);
1206 
1207   // Placeholder type for pseudo-objects.
1208   InitBuiltinType(PseudoObjectTy,      BuiltinType::PseudoObject);
1209 
1210   // "any" type; useful for debugger-like clients.
1211   InitBuiltinType(UnknownAnyTy,        BuiltinType::UnknownAny);
1212 
1213   // Placeholder type for unbridged ARC casts.
1214   InitBuiltinType(ARCUnbridgedCastTy,  BuiltinType::ARCUnbridgedCast);
1215 
1216   // Placeholder type for builtin functions.
1217   InitBuiltinType(BuiltinFnTy,  BuiltinType::BuiltinFn);
1218 
1219   // Placeholder type for OMP array sections.
1220   if (LangOpts.OpenMP)
1221     InitBuiltinType(OMPArraySectionTy, BuiltinType::OMPArraySection);
1222 
1223   // C99 6.2.5p11.
1224   FloatComplexTy      = getComplexType(FloatTy);
1225   DoubleComplexTy     = getComplexType(DoubleTy);
1226   LongDoubleComplexTy = getComplexType(LongDoubleTy);
1227   Float128ComplexTy   = getComplexType(Float128Ty);
1228 
1229   // Builtin types for 'id', 'Class', and 'SEL'.
1230   InitBuiltinType(ObjCBuiltinIdTy, BuiltinType::ObjCId);
1231   InitBuiltinType(ObjCBuiltinClassTy, BuiltinType::ObjCClass);
1232   InitBuiltinType(ObjCBuiltinSelTy, BuiltinType::ObjCSel);
1233 
1234   if (LangOpts.OpenCL) {
1235 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
1236     InitBuiltinType(SingletonId, BuiltinType::Id);
1237 #include "clang/Basic/OpenCLImageTypes.def"
1238 
1239     InitBuiltinType(OCLSamplerTy, BuiltinType::OCLSampler);
1240     InitBuiltinType(OCLEventTy, BuiltinType::OCLEvent);
1241     InitBuiltinType(OCLClkEventTy, BuiltinType::OCLClkEvent);
1242     InitBuiltinType(OCLQueueTy, BuiltinType::OCLQueue);
1243     InitBuiltinType(OCLReserveIDTy, BuiltinType::OCLReserveID);
1244   }
1245 
1246   // Builtin type for __objc_yes and __objc_no
1247   ObjCBuiltinBoolTy = (Target.useSignedCharForObjCBool() ?
1248                        SignedCharTy : BoolTy);
1249 
1250   ObjCConstantStringType = QualType();
1251 
1252   ObjCSuperType = QualType();
1253 
1254   // void * type
1255   if (LangOpts.OpenCLVersion >= 200) {
1256     auto Q = VoidTy.getQualifiers();
1257     Q.setAddressSpace(LangAS::opencl_generic);
1258     VoidPtrTy = getPointerType(getCanonicalType(
1259         getQualifiedType(VoidTy.getUnqualifiedType(), Q)));
1260   } else {
1261     VoidPtrTy = getPointerType(VoidTy);
1262   }
1263 
1264   // nullptr type (C++0x 2.14.7)
1265   InitBuiltinType(NullPtrTy,           BuiltinType::NullPtr);
1266 
1267   // half type (OpenCL 6.1.1.1) / ARM NEON __fp16
1268   InitBuiltinType(HalfTy, BuiltinType::Half);
1269 
1270   // Builtin type used to help define __builtin_va_list.
1271   VaListTagDecl = nullptr;
1272 }
1273 
1274 DiagnosticsEngine &ASTContext::getDiagnostics() const {
1275   return SourceMgr.getDiagnostics();
1276 }
1277 
1278 AttrVec& ASTContext::getDeclAttrs(const Decl *D) {
1279   AttrVec *&Result = DeclAttrs[D];
1280   if (!Result) {
1281     void *Mem = Allocate(sizeof(AttrVec));
1282     Result = new (Mem) AttrVec;
1283   }
1284 
1285   return *Result;
1286 }
1287 
1288 /// Erase the attributes corresponding to the given declaration.
1289 void ASTContext::eraseDeclAttrs(const Decl *D) {
1290   llvm::DenseMap<const Decl*, AttrVec*>::iterator Pos = DeclAttrs.find(D);
1291   if (Pos != DeclAttrs.end()) {
1292     Pos->second->~AttrVec();
1293     DeclAttrs.erase(Pos);
1294   }
1295 }
1296 
1297 // FIXME: Remove ?
1298 MemberSpecializationInfo *
1299 ASTContext::getInstantiatedFromStaticDataMember(const VarDecl *Var) {
1300   assert(Var->isStaticDataMember() && "Not a static data member");
1301   return getTemplateOrSpecializationInfo(Var)
1302       .dyn_cast<MemberSpecializationInfo *>();
1303 }
1304 
1305 ASTContext::TemplateOrSpecializationInfo
1306 ASTContext::getTemplateOrSpecializationInfo(const VarDecl *Var) {
1307   llvm::DenseMap<const VarDecl *, TemplateOrSpecializationInfo>::iterator Pos =
1308       TemplateOrInstantiation.find(Var);
1309   if (Pos == TemplateOrInstantiation.end())
1310     return {};
1311 
1312   return Pos->second;
1313 }
1314 
1315 void
1316 ASTContext::setInstantiatedFromStaticDataMember(VarDecl *Inst, VarDecl *Tmpl,
1317                                                 TemplateSpecializationKind TSK,
1318                                           SourceLocation PointOfInstantiation) {
1319   assert(Inst->isStaticDataMember() && "Not a static data member");
1320   assert(Tmpl->isStaticDataMember() && "Not a static data member");
1321   setTemplateOrSpecializationInfo(Inst, new (*this) MemberSpecializationInfo(
1322                                             Tmpl, TSK, PointOfInstantiation));
1323 }
1324 
1325 void
1326 ASTContext::setTemplateOrSpecializationInfo(VarDecl *Inst,
1327                                             TemplateOrSpecializationInfo TSI) {
1328   assert(!TemplateOrInstantiation[Inst] &&
1329          "Already noted what the variable was instantiated from");
1330   TemplateOrInstantiation[Inst] = TSI;
1331 }
1332 
1333 FunctionDecl *ASTContext::getClassScopeSpecializationPattern(
1334                                                      const FunctionDecl *FD){
1335   assert(FD && "Specialization is 0");
1336   llvm::DenseMap<const FunctionDecl*, FunctionDecl *>::const_iterator Pos
1337     = ClassScopeSpecializationPattern.find(FD);
1338   if (Pos == ClassScopeSpecializationPattern.end())
1339     return nullptr;
1340 
1341   return Pos->second;
1342 }
1343 
1344 void ASTContext::setClassScopeSpecializationPattern(FunctionDecl *FD,
1345                                         FunctionDecl *Pattern) {
1346   assert(FD && "Specialization is 0");
1347   assert(Pattern && "Class scope specialization pattern is 0");
1348   ClassScopeSpecializationPattern[FD] = Pattern;
1349 }
1350 
1351 NamedDecl *
1352 ASTContext::getInstantiatedFromUsingDecl(NamedDecl *UUD) {
1353   auto Pos = InstantiatedFromUsingDecl.find(UUD);
1354   if (Pos == InstantiatedFromUsingDecl.end())
1355     return nullptr;
1356 
1357   return Pos->second;
1358 }
1359 
1360 void
1361 ASTContext::setInstantiatedFromUsingDecl(NamedDecl *Inst, NamedDecl *Pattern) {
1362   assert((isa<UsingDecl>(Pattern) ||
1363           isa<UnresolvedUsingValueDecl>(Pattern) ||
1364           isa<UnresolvedUsingTypenameDecl>(Pattern)) &&
1365          "pattern decl is not a using decl");
1366   assert((isa<UsingDecl>(Inst) ||
1367           isa<UnresolvedUsingValueDecl>(Inst) ||
1368           isa<UnresolvedUsingTypenameDecl>(Inst)) &&
1369          "instantiation did not produce a using decl");
1370   assert(!InstantiatedFromUsingDecl[Inst] && "pattern already exists");
1371   InstantiatedFromUsingDecl[Inst] = Pattern;
1372 }
1373 
1374 UsingShadowDecl *
1375 ASTContext::getInstantiatedFromUsingShadowDecl(UsingShadowDecl *Inst) {
1376   llvm::DenseMap<UsingShadowDecl*, UsingShadowDecl*>::const_iterator Pos
1377     = InstantiatedFromUsingShadowDecl.find(Inst);
1378   if (Pos == InstantiatedFromUsingShadowDecl.end())
1379     return nullptr;
1380 
1381   return Pos->second;
1382 }
1383 
1384 void
1385 ASTContext::setInstantiatedFromUsingShadowDecl(UsingShadowDecl *Inst,
1386                                                UsingShadowDecl *Pattern) {
1387   assert(!InstantiatedFromUsingShadowDecl[Inst] && "pattern already exists");
1388   InstantiatedFromUsingShadowDecl[Inst] = Pattern;
1389 }
1390 
1391 FieldDecl *ASTContext::getInstantiatedFromUnnamedFieldDecl(FieldDecl *Field) {
1392   llvm::DenseMap<FieldDecl *, FieldDecl *>::iterator Pos
1393     = InstantiatedFromUnnamedFieldDecl.find(Field);
1394   if (Pos == InstantiatedFromUnnamedFieldDecl.end())
1395     return nullptr;
1396 
1397   return Pos->second;
1398 }
1399 
1400 void ASTContext::setInstantiatedFromUnnamedFieldDecl(FieldDecl *Inst,
1401                                                      FieldDecl *Tmpl) {
1402   assert(!Inst->getDeclName() && "Instantiated field decl is not unnamed");
1403   assert(!Tmpl->getDeclName() && "Template field decl is not unnamed");
1404   assert(!InstantiatedFromUnnamedFieldDecl[Inst] &&
1405          "Already noted what unnamed field was instantiated from");
1406 
1407   InstantiatedFromUnnamedFieldDecl[Inst] = Tmpl;
1408 }
1409 
1410 ASTContext::overridden_cxx_method_iterator
1411 ASTContext::overridden_methods_begin(const CXXMethodDecl *Method) const {
1412   return overridden_methods(Method).begin();
1413 }
1414 
1415 ASTContext::overridden_cxx_method_iterator
1416 ASTContext::overridden_methods_end(const CXXMethodDecl *Method) const {
1417   return overridden_methods(Method).end();
1418 }
1419 
1420 unsigned
1421 ASTContext::overridden_methods_size(const CXXMethodDecl *Method) const {
1422   auto Range = overridden_methods(Method);
1423   return Range.end() - Range.begin();
1424 }
1425 
1426 ASTContext::overridden_method_range
1427 ASTContext::overridden_methods(const CXXMethodDecl *Method) const {
1428   llvm::DenseMap<const CXXMethodDecl *, CXXMethodVector>::const_iterator Pos =
1429       OverriddenMethods.find(Method->getCanonicalDecl());
1430   if (Pos == OverriddenMethods.end())
1431     return overridden_method_range(nullptr, nullptr);
1432   return overridden_method_range(Pos->second.begin(), Pos->second.end());
1433 }
1434 
1435 void ASTContext::addOverriddenMethod(const CXXMethodDecl *Method,
1436                                      const CXXMethodDecl *Overridden) {
1437   assert(Method->isCanonicalDecl() && Overridden->isCanonicalDecl());
1438   OverriddenMethods[Method].push_back(Overridden);
1439 }
1440 
1441 void ASTContext::getOverriddenMethods(
1442                       const NamedDecl *D,
1443                       SmallVectorImpl<const NamedDecl *> &Overridden) const {
1444   assert(D);
1445 
1446   if (const auto *CXXMethod = dyn_cast<CXXMethodDecl>(D)) {
1447     Overridden.append(overridden_methods_begin(CXXMethod),
1448                       overridden_methods_end(CXXMethod));
1449     return;
1450   }
1451 
1452   const auto *Method = dyn_cast<ObjCMethodDecl>(D);
1453   if (!Method)
1454     return;
1455 
1456   SmallVector<const ObjCMethodDecl *, 8> OverDecls;
1457   Method->getOverriddenMethods(OverDecls);
1458   Overridden.append(OverDecls.begin(), OverDecls.end());
1459 }
1460 
1461 void ASTContext::addedLocalImportDecl(ImportDecl *Import) {
1462   assert(!Import->NextLocalImport && "Import declaration already in the chain");
1463   assert(!Import->isFromASTFile() && "Non-local import declaration");
1464   if (!FirstLocalImport) {
1465     FirstLocalImport = Import;
1466     LastLocalImport = Import;
1467     return;
1468   }
1469 
1470   LastLocalImport->NextLocalImport = Import;
1471   LastLocalImport = Import;
1472 }
1473 
1474 //===----------------------------------------------------------------------===//
1475 //                         Type Sizing and Analysis
1476 //===----------------------------------------------------------------------===//
1477 
1478 /// getFloatTypeSemantics - Return the APFloat 'semantics' for the specified
1479 /// scalar floating point type.
1480 const llvm::fltSemantics &ASTContext::getFloatTypeSemantics(QualType T) const {
1481   const auto *BT = T->getAs<BuiltinType>();
1482   assert(BT && "Not a floating point type!");
1483   switch (BT->getKind()) {
1484   default: llvm_unreachable("Not a floating point type!");
1485   case BuiltinType::Float16:
1486   case BuiltinType::Half:
1487     return Target->getHalfFormat();
1488   case BuiltinType::Float:      return Target->getFloatFormat();
1489   case BuiltinType::Double:     return Target->getDoubleFormat();
1490   case BuiltinType::LongDouble: return Target->getLongDoubleFormat();
1491   case BuiltinType::Float128:   return Target->getFloat128Format();
1492   }
1493 }
1494 
1495 CharUnits ASTContext::getDeclAlign(const Decl *D, bool ForAlignof) const {
1496   unsigned Align = Target->getCharWidth();
1497 
1498   bool UseAlignAttrOnly = false;
1499   if (unsigned AlignFromAttr = D->getMaxAlignment()) {
1500     Align = AlignFromAttr;
1501 
1502     // __attribute__((aligned)) can increase or decrease alignment
1503     // *except* on a struct or struct member, where it only increases
1504     // alignment unless 'packed' is also specified.
1505     //
1506     // It is an error for alignas to decrease alignment, so we can
1507     // ignore that possibility;  Sema should diagnose it.
1508     if (isa<FieldDecl>(D)) {
1509       UseAlignAttrOnly = D->hasAttr<PackedAttr>() ||
1510         cast<FieldDecl>(D)->getParent()->hasAttr<PackedAttr>();
1511     } else {
1512       UseAlignAttrOnly = true;
1513     }
1514   }
1515   else if (isa<FieldDecl>(D))
1516       UseAlignAttrOnly =
1517         D->hasAttr<PackedAttr>() ||
1518         cast<FieldDecl>(D)->getParent()->hasAttr<PackedAttr>();
1519 
1520   // If we're using the align attribute only, just ignore everything
1521   // else about the declaration and its type.
1522   if (UseAlignAttrOnly) {
1523     // do nothing
1524   } else if (const auto *VD = dyn_cast<ValueDecl>(D)) {
1525     QualType T = VD->getType();
1526     if (const auto *RT = T->getAs<ReferenceType>()) {
1527       if (ForAlignof)
1528         T = RT->getPointeeType();
1529       else
1530         T = getPointerType(RT->getPointeeType());
1531     }
1532     QualType BaseT = getBaseElementType(T);
1533     if (T->isFunctionType())
1534       Align = getTypeInfoImpl(T.getTypePtr()).Align;
1535     else if (!BaseT->isIncompleteType()) {
1536       // Adjust alignments of declarations with array type by the
1537       // large-array alignment on the target.
1538       if (const ArrayType *arrayType = getAsArrayType(T)) {
1539         unsigned MinWidth = Target->getLargeArrayMinWidth();
1540         if (!ForAlignof && MinWidth) {
1541           if (isa<VariableArrayType>(arrayType))
1542             Align = std::max(Align, Target->getLargeArrayAlign());
1543           else if (isa<ConstantArrayType>(arrayType) &&
1544                    MinWidth <= getTypeSize(cast<ConstantArrayType>(arrayType)))
1545             Align = std::max(Align, Target->getLargeArrayAlign());
1546         }
1547       }
1548       Align = std::max(Align, getPreferredTypeAlign(T.getTypePtr()));
1549       if (BaseT.getQualifiers().hasUnaligned())
1550         Align = Target->getCharWidth();
1551       if (const auto *VD = dyn_cast<VarDecl>(D)) {
1552         if (VD->hasGlobalStorage() && !ForAlignof)
1553           Align = std::max(Align, getTargetInfo().getMinGlobalAlign());
1554       }
1555     }
1556 
1557     // Fields can be subject to extra alignment constraints, like if
1558     // the field is packed, the struct is packed, or the struct has a
1559     // a max-field-alignment constraint (#pragma pack).  So calculate
1560     // the actual alignment of the field within the struct, and then
1561     // (as we're expected to) constrain that by the alignment of the type.
1562     if (const auto *Field = dyn_cast<FieldDecl>(VD)) {
1563       const RecordDecl *Parent = Field->getParent();
1564       // We can only produce a sensible answer if the record is valid.
1565       if (!Parent->isInvalidDecl()) {
1566         const ASTRecordLayout &Layout = getASTRecordLayout(Parent);
1567 
1568         // Start with the record's overall alignment.
1569         unsigned FieldAlign = toBits(Layout.getAlignment());
1570 
1571         // Use the GCD of that and the offset within the record.
1572         uint64_t Offset = Layout.getFieldOffset(Field->getFieldIndex());
1573         if (Offset > 0) {
1574           // Alignment is always a power of 2, so the GCD will be a power of 2,
1575           // which means we get to do this crazy thing instead of Euclid's.
1576           uint64_t LowBitOfOffset = Offset & (~Offset + 1);
1577           if (LowBitOfOffset < FieldAlign)
1578             FieldAlign = static_cast<unsigned>(LowBitOfOffset);
1579         }
1580 
1581         Align = std::min(Align, FieldAlign);
1582       }
1583     }
1584   }
1585 
1586   return toCharUnitsFromBits(Align);
1587 }
1588 
1589 // getTypeInfoDataSizeInChars - Return the size of a type, in
1590 // chars. If the type is a record, its data size is returned.  This is
1591 // the size of the memcpy that's performed when assigning this type
1592 // using a trivial copy/move assignment operator.
1593 std::pair<CharUnits, CharUnits>
1594 ASTContext::getTypeInfoDataSizeInChars(QualType T) const {
1595   std::pair<CharUnits, CharUnits> sizeAndAlign = getTypeInfoInChars(T);
1596 
1597   // In C++, objects can sometimes be allocated into the tail padding
1598   // of a base-class subobject.  We decide whether that's possible
1599   // during class layout, so here we can just trust the layout results.
1600   if (getLangOpts().CPlusPlus) {
1601     if (const auto *RT = T->getAs<RecordType>()) {
1602       const ASTRecordLayout &layout = getASTRecordLayout(RT->getDecl());
1603       sizeAndAlign.first = layout.getDataSize();
1604     }
1605   }
1606 
1607   return sizeAndAlign;
1608 }
1609 
1610 /// getConstantArrayInfoInChars - Performing the computation in CharUnits
1611 /// instead of in bits prevents overflowing the uint64_t for some large arrays.
1612 std::pair<CharUnits, CharUnits>
1613 static getConstantArrayInfoInChars(const ASTContext &Context,
1614                                    const ConstantArrayType *CAT) {
1615   std::pair<CharUnits, CharUnits> EltInfo =
1616       Context.getTypeInfoInChars(CAT->getElementType());
1617   uint64_t Size = CAT->getSize().getZExtValue();
1618   assert((Size == 0 || static_cast<uint64_t>(EltInfo.first.getQuantity()) <=
1619               (uint64_t)(-1)/Size) &&
1620          "Overflow in array type char size evaluation");
1621   uint64_t Width = EltInfo.first.getQuantity() * Size;
1622   unsigned Align = EltInfo.second.getQuantity();
1623   if (!Context.getTargetInfo().getCXXABI().isMicrosoft() ||
1624       Context.getTargetInfo().getPointerWidth(0) == 64)
1625     Width = llvm::alignTo(Width, Align);
1626   return std::make_pair(CharUnits::fromQuantity(Width),
1627                         CharUnits::fromQuantity(Align));
1628 }
1629 
1630 std::pair<CharUnits, CharUnits>
1631 ASTContext::getTypeInfoInChars(const Type *T) const {
1632   if (const auto *CAT = dyn_cast<ConstantArrayType>(T))
1633     return getConstantArrayInfoInChars(*this, CAT);
1634   TypeInfo Info = getTypeInfo(T);
1635   return std::make_pair(toCharUnitsFromBits(Info.Width),
1636                         toCharUnitsFromBits(Info.Align));
1637 }
1638 
1639 std::pair<CharUnits, CharUnits>
1640 ASTContext::getTypeInfoInChars(QualType T) const {
1641   return getTypeInfoInChars(T.getTypePtr());
1642 }
1643 
1644 bool ASTContext::isAlignmentRequired(const Type *T) const {
1645   return getTypeInfo(T).AlignIsRequired;
1646 }
1647 
1648 bool ASTContext::isAlignmentRequired(QualType T) const {
1649   return isAlignmentRequired(T.getTypePtr());
1650 }
1651 
1652 unsigned ASTContext::getTypeAlignIfKnown(QualType T) const {
1653   // An alignment on a typedef overrides anything else.
1654   if (const auto *TT = T->getAs<TypedefType>())
1655     if (unsigned Align = TT->getDecl()->getMaxAlignment())
1656       return Align;
1657 
1658   // If we have an (array of) complete type, we're done.
1659   T = getBaseElementType(T);
1660   if (!T->isIncompleteType())
1661     return getTypeAlign(T);
1662 
1663   // If we had an array type, its element type might be a typedef
1664   // type with an alignment attribute.
1665   if (const auto *TT = T->getAs<TypedefType>())
1666     if (unsigned Align = TT->getDecl()->getMaxAlignment())
1667       return Align;
1668 
1669   // Otherwise, see if the declaration of the type had an attribute.
1670   if (const auto *TT = T->getAs<TagType>())
1671     return TT->getDecl()->getMaxAlignment();
1672 
1673   return 0;
1674 }
1675 
1676 TypeInfo ASTContext::getTypeInfo(const Type *T) const {
1677   TypeInfoMap::iterator I = MemoizedTypeInfo.find(T);
1678   if (I != MemoizedTypeInfo.end())
1679     return I->second;
1680 
1681   // This call can invalidate MemoizedTypeInfo[T], so we need a second lookup.
1682   TypeInfo TI = getTypeInfoImpl(T);
1683   MemoizedTypeInfo[T] = TI;
1684   return TI;
1685 }
1686 
1687 /// getTypeInfoImpl - Return the size of the specified type, in bits.  This
1688 /// method does not work on incomplete types.
1689 ///
1690 /// FIXME: Pointers into different addr spaces could have different sizes and
1691 /// alignment requirements: getPointerInfo should take an AddrSpace, this
1692 /// should take a QualType, &c.
1693 TypeInfo ASTContext::getTypeInfoImpl(const Type *T) const {
1694   uint64_t Width = 0;
1695   unsigned Align = 8;
1696   bool AlignIsRequired = false;
1697   unsigned AS = 0;
1698   switch (T->getTypeClass()) {
1699 #define TYPE(Class, Base)
1700 #define ABSTRACT_TYPE(Class, Base)
1701 #define NON_CANONICAL_TYPE(Class, Base)
1702 #define DEPENDENT_TYPE(Class, Base) case Type::Class:
1703 #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base)                       \
1704   case Type::Class:                                                            \
1705   assert(!T->isDependentType() && "should not see dependent types here");      \
1706   return getTypeInfo(cast<Class##Type>(T)->desugar().getTypePtr());
1707 #include "clang/AST/TypeNodes.def"
1708     llvm_unreachable("Should not see dependent types");
1709 
1710   case Type::FunctionNoProto:
1711   case Type::FunctionProto:
1712     // GCC extension: alignof(function) = 32 bits
1713     Width = 0;
1714     Align = 32;
1715     break;
1716 
1717   case Type::IncompleteArray:
1718   case Type::VariableArray:
1719     Width = 0;
1720     Align = getTypeAlign(cast<ArrayType>(T)->getElementType());
1721     break;
1722 
1723   case Type::ConstantArray: {
1724     const auto *CAT = cast<ConstantArrayType>(T);
1725 
1726     TypeInfo EltInfo = getTypeInfo(CAT->getElementType());
1727     uint64_t Size = CAT->getSize().getZExtValue();
1728     assert((Size == 0 || EltInfo.Width <= (uint64_t)(-1) / Size) &&
1729            "Overflow in array type bit size evaluation");
1730     Width = EltInfo.Width * Size;
1731     Align = EltInfo.Align;
1732     if (!getTargetInfo().getCXXABI().isMicrosoft() ||
1733         getTargetInfo().getPointerWidth(0) == 64)
1734       Width = llvm::alignTo(Width, Align);
1735     break;
1736   }
1737   case Type::ExtVector:
1738   case Type::Vector: {
1739     const auto *VT = cast<VectorType>(T);
1740     TypeInfo EltInfo = getTypeInfo(VT->getElementType());
1741     Width = EltInfo.Width * VT->getNumElements();
1742     Align = Width;
1743     // If the alignment is not a power of 2, round up to the next power of 2.
1744     // This happens for non-power-of-2 length vectors.
1745     if (Align & (Align-1)) {
1746       Align = llvm::NextPowerOf2(Align);
1747       Width = llvm::alignTo(Width, Align);
1748     }
1749     // Adjust the alignment based on the target max.
1750     uint64_t TargetVectorAlign = Target->getMaxVectorAlign();
1751     if (TargetVectorAlign && TargetVectorAlign < Align)
1752       Align = TargetVectorAlign;
1753     break;
1754   }
1755 
1756   case Type::Builtin:
1757     switch (cast<BuiltinType>(T)->getKind()) {
1758     default: llvm_unreachable("Unknown builtin type!");
1759     case BuiltinType::Void:
1760       // GCC extension: alignof(void) = 8 bits.
1761       Width = 0;
1762       Align = 8;
1763       break;
1764     case BuiltinType::Bool:
1765       Width = Target->getBoolWidth();
1766       Align = Target->getBoolAlign();
1767       break;
1768     case BuiltinType::Char_S:
1769     case BuiltinType::Char_U:
1770     case BuiltinType::UChar:
1771     case BuiltinType::SChar:
1772     case BuiltinType::Char8:
1773       Width = Target->getCharWidth();
1774       Align = Target->getCharAlign();
1775       break;
1776     case BuiltinType::WChar_S:
1777     case BuiltinType::WChar_U:
1778       Width = Target->getWCharWidth();
1779       Align = Target->getWCharAlign();
1780       break;
1781     case BuiltinType::Char16:
1782       Width = Target->getChar16Width();
1783       Align = Target->getChar16Align();
1784       break;
1785     case BuiltinType::Char32:
1786       Width = Target->getChar32Width();
1787       Align = Target->getChar32Align();
1788       break;
1789     case BuiltinType::UShort:
1790     case BuiltinType::Short:
1791       Width = Target->getShortWidth();
1792       Align = Target->getShortAlign();
1793       break;
1794     case BuiltinType::UInt:
1795     case BuiltinType::Int:
1796       Width = Target->getIntWidth();
1797       Align = Target->getIntAlign();
1798       break;
1799     case BuiltinType::ULong:
1800     case BuiltinType::Long:
1801       Width = Target->getLongWidth();
1802       Align = Target->getLongAlign();
1803       break;
1804     case BuiltinType::ULongLong:
1805     case BuiltinType::LongLong:
1806       Width = Target->getLongLongWidth();
1807       Align = Target->getLongLongAlign();
1808       break;
1809     case BuiltinType::Int128:
1810     case BuiltinType::UInt128:
1811       Width = 128;
1812       Align = 128; // int128_t is 128-bit aligned on all targets.
1813       break;
1814     case BuiltinType::ShortAccum:
1815     case BuiltinType::UShortAccum:
1816     case BuiltinType::SatShortAccum:
1817     case BuiltinType::SatUShortAccum:
1818       Width = Target->getShortAccumWidth();
1819       Align = Target->getShortAccumAlign();
1820       break;
1821     case BuiltinType::Accum:
1822     case BuiltinType::UAccum:
1823     case BuiltinType::SatAccum:
1824     case BuiltinType::SatUAccum:
1825       Width = Target->getAccumWidth();
1826       Align = Target->getAccumAlign();
1827       break;
1828     case BuiltinType::LongAccum:
1829     case BuiltinType::ULongAccum:
1830     case BuiltinType::SatLongAccum:
1831     case BuiltinType::SatULongAccum:
1832       Width = Target->getLongAccumWidth();
1833       Align = Target->getLongAccumAlign();
1834       break;
1835     case BuiltinType::ShortFract:
1836     case BuiltinType::UShortFract:
1837     case BuiltinType::SatShortFract:
1838     case BuiltinType::SatUShortFract:
1839       Width = Target->getShortFractWidth();
1840       Align = Target->getShortFractAlign();
1841       break;
1842     case BuiltinType::Fract:
1843     case BuiltinType::UFract:
1844     case BuiltinType::SatFract:
1845     case BuiltinType::SatUFract:
1846       Width = Target->getFractWidth();
1847       Align = Target->getFractAlign();
1848       break;
1849     case BuiltinType::LongFract:
1850     case BuiltinType::ULongFract:
1851     case BuiltinType::SatLongFract:
1852     case BuiltinType::SatULongFract:
1853       Width = Target->getLongFractWidth();
1854       Align = Target->getLongFractAlign();
1855       break;
1856     case BuiltinType::Float16:
1857     case BuiltinType::Half:
1858       Width = Target->getHalfWidth();
1859       Align = Target->getHalfAlign();
1860       break;
1861     case BuiltinType::Float:
1862       Width = Target->getFloatWidth();
1863       Align = Target->getFloatAlign();
1864       break;
1865     case BuiltinType::Double:
1866       Width = Target->getDoubleWidth();
1867       Align = Target->getDoubleAlign();
1868       break;
1869     case BuiltinType::LongDouble:
1870       Width = Target->getLongDoubleWidth();
1871       Align = Target->getLongDoubleAlign();
1872       break;
1873     case BuiltinType::Float128:
1874       Width = Target->getFloat128Width();
1875       Align = Target->getFloat128Align();
1876       break;
1877     case BuiltinType::NullPtr:
1878       Width = Target->getPointerWidth(0); // C++ 3.9.1p11: sizeof(nullptr_t)
1879       Align = Target->getPointerAlign(0); //   == sizeof(void*)
1880       break;
1881     case BuiltinType::ObjCId:
1882     case BuiltinType::ObjCClass:
1883     case BuiltinType::ObjCSel:
1884       Width = Target->getPointerWidth(0);
1885       Align = Target->getPointerAlign(0);
1886       break;
1887     case BuiltinType::OCLSampler:
1888     case BuiltinType::OCLEvent:
1889     case BuiltinType::OCLClkEvent:
1890     case BuiltinType::OCLQueue:
1891     case BuiltinType::OCLReserveID:
1892 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
1893     case BuiltinType::Id:
1894 #include "clang/Basic/OpenCLImageTypes.def"
1895       AS = getTargetAddressSpace(
1896           Target->getOpenCLTypeAddrSpace(getOpenCLTypeKind(T)));
1897       Width = Target->getPointerWidth(AS);
1898       Align = Target->getPointerAlign(AS);
1899       break;
1900     }
1901     break;
1902   case Type::ObjCObjectPointer:
1903     Width = Target->getPointerWidth(0);
1904     Align = Target->getPointerAlign(0);
1905     break;
1906   case Type::BlockPointer:
1907     AS = getTargetAddressSpace(cast<BlockPointerType>(T)->getPointeeType());
1908     Width = Target->getPointerWidth(AS);
1909     Align = Target->getPointerAlign(AS);
1910     break;
1911   case Type::LValueReference:
1912   case Type::RValueReference:
1913     // alignof and sizeof should never enter this code path here, so we go
1914     // the pointer route.
1915     AS = getTargetAddressSpace(cast<ReferenceType>(T)->getPointeeType());
1916     Width = Target->getPointerWidth(AS);
1917     Align = Target->getPointerAlign(AS);
1918     break;
1919   case Type::Pointer:
1920     AS = getTargetAddressSpace(cast<PointerType>(T)->getPointeeType());
1921     Width = Target->getPointerWidth(AS);
1922     Align = Target->getPointerAlign(AS);
1923     break;
1924   case Type::MemberPointer: {
1925     const auto *MPT = cast<MemberPointerType>(T);
1926     CXXABI::MemberPointerInfo MPI = ABI->getMemberPointerInfo(MPT);
1927     Width = MPI.Width;
1928     Align = MPI.Align;
1929     break;
1930   }
1931   case Type::Complex: {
1932     // Complex types have the same alignment as their elements, but twice the
1933     // size.
1934     TypeInfo EltInfo = getTypeInfo(cast<ComplexType>(T)->getElementType());
1935     Width = EltInfo.Width * 2;
1936     Align = EltInfo.Align;
1937     break;
1938   }
1939   case Type::ObjCObject:
1940     return getTypeInfo(cast<ObjCObjectType>(T)->getBaseType().getTypePtr());
1941   case Type::Adjusted:
1942   case Type::Decayed:
1943     return getTypeInfo(cast<AdjustedType>(T)->getAdjustedType().getTypePtr());
1944   case Type::ObjCInterface: {
1945     const auto *ObjCI = cast<ObjCInterfaceType>(T);
1946     const ASTRecordLayout &Layout = getASTObjCInterfaceLayout(ObjCI->getDecl());
1947     Width = toBits(Layout.getSize());
1948     Align = toBits(Layout.getAlignment());
1949     break;
1950   }
1951   case Type::Record:
1952   case Type::Enum: {
1953     const auto *TT = cast<TagType>(T);
1954 
1955     if (TT->getDecl()->isInvalidDecl()) {
1956       Width = 8;
1957       Align = 8;
1958       break;
1959     }
1960 
1961     if (const auto *ET = dyn_cast<EnumType>(TT)) {
1962       const EnumDecl *ED = ET->getDecl();
1963       TypeInfo Info =
1964           getTypeInfo(ED->getIntegerType()->getUnqualifiedDesugaredType());
1965       if (unsigned AttrAlign = ED->getMaxAlignment()) {
1966         Info.Align = AttrAlign;
1967         Info.AlignIsRequired = true;
1968       }
1969       return Info;
1970     }
1971 
1972     const auto *RT = cast<RecordType>(TT);
1973     const RecordDecl *RD = RT->getDecl();
1974     const ASTRecordLayout &Layout = getASTRecordLayout(RD);
1975     Width = toBits(Layout.getSize());
1976     Align = toBits(Layout.getAlignment());
1977     AlignIsRequired = RD->hasAttr<AlignedAttr>();
1978     break;
1979   }
1980 
1981   case Type::SubstTemplateTypeParm:
1982     return getTypeInfo(cast<SubstTemplateTypeParmType>(T)->
1983                        getReplacementType().getTypePtr());
1984 
1985   case Type::Auto:
1986   case Type::DeducedTemplateSpecialization: {
1987     const auto *A = cast<DeducedType>(T);
1988     assert(!A->getDeducedType().isNull() &&
1989            "cannot request the size of an undeduced or dependent auto type");
1990     return getTypeInfo(A->getDeducedType().getTypePtr());
1991   }
1992 
1993   case Type::Paren:
1994     return getTypeInfo(cast<ParenType>(T)->getInnerType().getTypePtr());
1995 
1996   case Type::ObjCTypeParam:
1997     return getTypeInfo(cast<ObjCTypeParamType>(T)->desugar().getTypePtr());
1998 
1999   case Type::Typedef: {
2000     const TypedefNameDecl *Typedef = cast<TypedefType>(T)->getDecl();
2001     TypeInfo Info = getTypeInfo(Typedef->getUnderlyingType().getTypePtr());
2002     // If the typedef has an aligned attribute on it, it overrides any computed
2003     // alignment we have.  This violates the GCC documentation (which says that
2004     // attribute(aligned) can only round up) but matches its implementation.
2005     if (unsigned AttrAlign = Typedef->getMaxAlignment()) {
2006       Align = AttrAlign;
2007       AlignIsRequired = true;
2008     } else {
2009       Align = Info.Align;
2010       AlignIsRequired = Info.AlignIsRequired;
2011     }
2012     Width = Info.Width;
2013     break;
2014   }
2015 
2016   case Type::Elaborated:
2017     return getTypeInfo(cast<ElaboratedType>(T)->getNamedType().getTypePtr());
2018 
2019   case Type::Attributed:
2020     return getTypeInfo(
2021                   cast<AttributedType>(T)->getEquivalentType().getTypePtr());
2022 
2023   case Type::Atomic: {
2024     // Start with the base type information.
2025     TypeInfo Info = getTypeInfo(cast<AtomicType>(T)->getValueType());
2026     Width = Info.Width;
2027     Align = Info.Align;
2028 
2029     if (!Width) {
2030       // An otherwise zero-sized type should still generate an
2031       // atomic operation.
2032       Width = Target->getCharWidth();
2033       assert(Align);
2034     } else if (Width <= Target->getMaxAtomicPromoteWidth()) {
2035       // If the size of the type doesn't exceed the platform's max
2036       // atomic promotion width, make the size and alignment more
2037       // favorable to atomic operations:
2038 
2039       // Round the size up to a power of 2.
2040       if (!llvm::isPowerOf2_64(Width))
2041         Width = llvm::NextPowerOf2(Width);
2042 
2043       // Set the alignment equal to the size.
2044       Align = static_cast<unsigned>(Width);
2045     }
2046   }
2047   break;
2048 
2049   case Type::Pipe:
2050     Width = Target->getPointerWidth(getTargetAddressSpace(LangAS::opencl_global));
2051     Align = Target->getPointerAlign(getTargetAddressSpace(LangAS::opencl_global));
2052     break;
2053   }
2054 
2055   assert(llvm::isPowerOf2_32(Align) && "Alignment must be power of 2");
2056   return TypeInfo(Width, Align, AlignIsRequired);
2057 }
2058 
2059 unsigned ASTContext::getOpenMPDefaultSimdAlign(QualType T) const {
2060   unsigned SimdAlign = getTargetInfo().getSimdDefaultAlign();
2061   // Target ppc64 with QPX: simd default alignment for pointer to double is 32.
2062   if ((getTargetInfo().getTriple().getArch() == llvm::Triple::ppc64 ||
2063        getTargetInfo().getTriple().getArch() == llvm::Triple::ppc64le) &&
2064       getTargetInfo().getABI() == "elfv1-qpx" &&
2065       T->isSpecificBuiltinType(BuiltinType::Double))
2066     SimdAlign = 256;
2067   return SimdAlign;
2068 }
2069 
2070 /// toCharUnitsFromBits - Convert a size in bits to a size in characters.
2071 CharUnits ASTContext::toCharUnitsFromBits(int64_t BitSize) const {
2072   return CharUnits::fromQuantity(BitSize / getCharWidth());
2073 }
2074 
2075 /// toBits - Convert a size in characters to a size in characters.
2076 int64_t ASTContext::toBits(CharUnits CharSize) const {
2077   return CharSize.getQuantity() * getCharWidth();
2078 }
2079 
2080 /// getTypeSizeInChars - Return the size of the specified type, in characters.
2081 /// This method does not work on incomplete types.
2082 CharUnits ASTContext::getTypeSizeInChars(QualType T) const {
2083   return getTypeInfoInChars(T).first;
2084 }
2085 CharUnits ASTContext::getTypeSizeInChars(const Type *T) const {
2086   return getTypeInfoInChars(T).first;
2087 }
2088 
2089 /// getTypeAlignInChars - Return the ABI-specified alignment of a type, in
2090 /// characters. This method does not work on incomplete types.
2091 CharUnits ASTContext::getTypeAlignInChars(QualType T) const {
2092   return toCharUnitsFromBits(getTypeAlign(T));
2093 }
2094 CharUnits ASTContext::getTypeAlignInChars(const Type *T) const {
2095   return toCharUnitsFromBits(getTypeAlign(T));
2096 }
2097 
2098 /// getPreferredTypeAlign - Return the "preferred" alignment of the specified
2099 /// type for the current target in bits.  This can be different than the ABI
2100 /// alignment in cases where it is beneficial for performance to overalign
2101 /// a data type.
2102 unsigned ASTContext::getPreferredTypeAlign(const Type *T) const {
2103   TypeInfo TI = getTypeInfo(T);
2104   unsigned ABIAlign = TI.Align;
2105 
2106   T = T->getBaseElementTypeUnsafe();
2107 
2108   // The preferred alignment of member pointers is that of a pointer.
2109   if (T->isMemberPointerType())
2110     return getPreferredTypeAlign(getPointerDiffType().getTypePtr());
2111 
2112   if (!Target->allowsLargerPreferedTypeAlignment())
2113     return ABIAlign;
2114 
2115   // Double and long long should be naturally aligned if possible.
2116   if (const auto *CT = T->getAs<ComplexType>())
2117     T = CT->getElementType().getTypePtr();
2118   if (const auto *ET = T->getAs<EnumType>())
2119     T = ET->getDecl()->getIntegerType().getTypePtr();
2120   if (T->isSpecificBuiltinType(BuiltinType::Double) ||
2121       T->isSpecificBuiltinType(BuiltinType::LongLong) ||
2122       T->isSpecificBuiltinType(BuiltinType::ULongLong))
2123     // Don't increase the alignment if an alignment attribute was specified on a
2124     // typedef declaration.
2125     if (!TI.AlignIsRequired)
2126       return std::max(ABIAlign, (unsigned)getTypeSize(T));
2127 
2128   return ABIAlign;
2129 }
2130 
2131 /// getTargetDefaultAlignForAttributeAligned - Return the default alignment
2132 /// for __attribute__((aligned)) on this target, to be used if no alignment
2133 /// value is specified.
2134 unsigned ASTContext::getTargetDefaultAlignForAttributeAligned() const {
2135   return getTargetInfo().getDefaultAlignForAttributeAligned();
2136 }
2137 
2138 /// getAlignOfGlobalVar - Return the alignment in bits that should be given
2139 /// to a global variable of the specified type.
2140 unsigned ASTContext::getAlignOfGlobalVar(QualType T) const {
2141   return std::max(getTypeAlign(T), getTargetInfo().getMinGlobalAlign());
2142 }
2143 
2144 /// getAlignOfGlobalVarInChars - Return the alignment in characters that
2145 /// should be given to a global variable of the specified type.
2146 CharUnits ASTContext::getAlignOfGlobalVarInChars(QualType T) const {
2147   return toCharUnitsFromBits(getAlignOfGlobalVar(T));
2148 }
2149 
2150 CharUnits ASTContext::getOffsetOfBaseWithVBPtr(const CXXRecordDecl *RD) const {
2151   CharUnits Offset = CharUnits::Zero();
2152   const ASTRecordLayout *Layout = &getASTRecordLayout(RD);
2153   while (const CXXRecordDecl *Base = Layout->getBaseSharingVBPtr()) {
2154     Offset += Layout->getBaseClassOffset(Base);
2155     Layout = &getASTRecordLayout(Base);
2156   }
2157   return Offset;
2158 }
2159 
2160 /// DeepCollectObjCIvars -
2161 /// This routine first collects all declared, but not synthesized, ivars in
2162 /// super class and then collects all ivars, including those synthesized for
2163 /// current class. This routine is used for implementation of current class
2164 /// when all ivars, declared and synthesized are known.
2165 void ASTContext::DeepCollectObjCIvars(const ObjCInterfaceDecl *OI,
2166                                       bool leafClass,
2167                             SmallVectorImpl<const ObjCIvarDecl*> &Ivars) const {
2168   if (const ObjCInterfaceDecl *SuperClass = OI->getSuperClass())
2169     DeepCollectObjCIvars(SuperClass, false, Ivars);
2170   if (!leafClass) {
2171     for (const auto *I : OI->ivars())
2172       Ivars.push_back(I);
2173   } else {
2174     auto *IDecl = const_cast<ObjCInterfaceDecl *>(OI);
2175     for (const ObjCIvarDecl *Iv = IDecl->all_declared_ivar_begin(); Iv;
2176          Iv= Iv->getNextIvar())
2177       Ivars.push_back(Iv);
2178   }
2179 }
2180 
2181 /// CollectInheritedProtocols - Collect all protocols in current class and
2182 /// those inherited by it.
2183 void ASTContext::CollectInheritedProtocols(const Decl *CDecl,
2184                           llvm::SmallPtrSet<ObjCProtocolDecl*, 8> &Protocols) {
2185   if (const auto *OI = dyn_cast<ObjCInterfaceDecl>(CDecl)) {
2186     // We can use protocol_iterator here instead of
2187     // all_referenced_protocol_iterator since we are walking all categories.
2188     for (auto *Proto : OI->all_referenced_protocols()) {
2189       CollectInheritedProtocols(Proto, Protocols);
2190     }
2191 
2192     // Categories of this Interface.
2193     for (const auto *Cat : OI->visible_categories())
2194       CollectInheritedProtocols(Cat, Protocols);
2195 
2196     if (ObjCInterfaceDecl *SD = OI->getSuperClass())
2197       while (SD) {
2198         CollectInheritedProtocols(SD, Protocols);
2199         SD = SD->getSuperClass();
2200       }
2201   } else if (const auto *OC = dyn_cast<ObjCCategoryDecl>(CDecl)) {
2202     for (auto *Proto : OC->protocols()) {
2203       CollectInheritedProtocols(Proto, Protocols);
2204     }
2205   } else if (const auto *OP = dyn_cast<ObjCProtocolDecl>(CDecl)) {
2206     // Insert the protocol.
2207     if (!Protocols.insert(
2208           const_cast<ObjCProtocolDecl *>(OP->getCanonicalDecl())).second)
2209       return;
2210 
2211     for (auto *Proto : OP->protocols())
2212       CollectInheritedProtocols(Proto, Protocols);
2213   }
2214 }
2215 
2216 static bool unionHasUniqueObjectRepresentations(const ASTContext &Context,
2217                                                 const RecordDecl *RD) {
2218   assert(RD->isUnion() && "Must be union type");
2219   CharUnits UnionSize = Context.getTypeSizeInChars(RD->getTypeForDecl());
2220 
2221   for (const auto *Field : RD->fields()) {
2222     if (!Context.hasUniqueObjectRepresentations(Field->getType()))
2223       return false;
2224     CharUnits FieldSize = Context.getTypeSizeInChars(Field->getType());
2225     if (FieldSize != UnionSize)
2226       return false;
2227   }
2228   return !RD->field_empty();
2229 }
2230 
2231 static bool isStructEmpty(QualType Ty) {
2232   const RecordDecl *RD = Ty->castAs<RecordType>()->getDecl();
2233 
2234   if (!RD->field_empty())
2235     return false;
2236 
2237   if (const auto *ClassDecl = dyn_cast<CXXRecordDecl>(RD))
2238     return ClassDecl->isEmpty();
2239 
2240   return true;
2241 }
2242 
2243 static llvm::Optional<int64_t>
2244 structHasUniqueObjectRepresentations(const ASTContext &Context,
2245                                      const RecordDecl *RD) {
2246   assert(!RD->isUnion() && "Must be struct/class type");
2247   const auto &Layout = Context.getASTRecordLayout(RD);
2248 
2249   int64_t CurOffsetInBits = 0;
2250   if (const auto *ClassDecl = dyn_cast<CXXRecordDecl>(RD)) {
2251     if (ClassDecl->isDynamicClass())
2252       return llvm::None;
2253 
2254     SmallVector<std::pair<QualType, int64_t>, 4> Bases;
2255     for (const auto Base : ClassDecl->bases()) {
2256       // Empty types can be inherited from, and non-empty types can potentially
2257       // have tail padding, so just make sure there isn't an error.
2258       if (!isStructEmpty(Base.getType())) {
2259         llvm::Optional<int64_t> Size = structHasUniqueObjectRepresentations(
2260             Context, Base.getType()->getAs<RecordType>()->getDecl());
2261         if (!Size)
2262           return llvm::None;
2263         Bases.emplace_back(Base.getType(), Size.getValue());
2264       }
2265     }
2266 
2267     llvm::sort(
2268         Bases.begin(), Bases.end(), [&](const std::pair<QualType, int64_t> &L,
2269                                         const std::pair<QualType, int64_t> &R) {
2270           return Layout.getBaseClassOffset(L.first->getAsCXXRecordDecl()) <
2271                  Layout.getBaseClassOffset(R.first->getAsCXXRecordDecl());
2272         });
2273 
2274     for (const auto Base : Bases) {
2275       int64_t BaseOffset = Context.toBits(
2276           Layout.getBaseClassOffset(Base.first->getAsCXXRecordDecl()));
2277       int64_t BaseSize = Base.second;
2278       if (BaseOffset != CurOffsetInBits)
2279         return llvm::None;
2280       CurOffsetInBits = BaseOffset + BaseSize;
2281     }
2282   }
2283 
2284   for (const auto *Field : RD->fields()) {
2285     if (!Field->getType()->isReferenceType() &&
2286         !Context.hasUniqueObjectRepresentations(Field->getType()))
2287       return llvm::None;
2288 
2289     int64_t FieldSizeInBits =
2290         Context.toBits(Context.getTypeSizeInChars(Field->getType()));
2291     if (Field->isBitField()) {
2292       int64_t BitfieldSize = Field->getBitWidthValue(Context);
2293 
2294       if (BitfieldSize > FieldSizeInBits)
2295         return llvm::None;
2296       FieldSizeInBits = BitfieldSize;
2297     }
2298 
2299     int64_t FieldOffsetInBits = Context.getFieldOffset(Field);
2300 
2301     if (FieldOffsetInBits != CurOffsetInBits)
2302       return llvm::None;
2303 
2304     CurOffsetInBits = FieldSizeInBits + FieldOffsetInBits;
2305   }
2306 
2307   return CurOffsetInBits;
2308 }
2309 
2310 bool ASTContext::hasUniqueObjectRepresentations(QualType Ty) const {
2311   // C++17 [meta.unary.prop]:
2312   //   The predicate condition for a template specialization
2313   //   has_unique_object_representations<T> shall be
2314   //   satisfied if and only if:
2315   //     (9.1) - T is trivially copyable, and
2316   //     (9.2) - any two objects of type T with the same value have the same
2317   //     object representation, where two objects
2318   //   of array or non-union class type are considered to have the same value
2319   //   if their respective sequences of
2320   //   direct subobjects have the same values, and two objects of union type
2321   //   are considered to have the same
2322   //   value if they have the same active member and the corresponding members
2323   //   have the same value.
2324   //   The set of scalar types for which this condition holds is
2325   //   implementation-defined. [ Note: If a type has padding
2326   //   bits, the condition does not hold; otherwise, the condition holds true
2327   //   for unsigned integral types. -- end note ]
2328   assert(!Ty.isNull() && "Null QualType sent to unique object rep check");
2329 
2330   // Arrays are unique only if their element type is unique.
2331   if (Ty->isArrayType())
2332     return hasUniqueObjectRepresentations(getBaseElementType(Ty));
2333 
2334   // (9.1) - T is trivially copyable...
2335   if (!Ty.isTriviallyCopyableType(*this))
2336     return false;
2337 
2338   // All integrals and enums are unique.
2339   if (Ty->isIntegralOrEnumerationType())
2340     return true;
2341 
2342   // All other pointers are unique.
2343   if (Ty->isPointerType())
2344     return true;
2345 
2346   if (Ty->isMemberPointerType()) {
2347     const auto *MPT = Ty->getAs<MemberPointerType>();
2348     return !ABI->getMemberPointerInfo(MPT).HasPadding;
2349   }
2350 
2351   if (Ty->isRecordType()) {
2352     const RecordDecl *Record = Ty->getAs<RecordType>()->getDecl();
2353 
2354     if (Record->isInvalidDecl())
2355       return false;
2356 
2357     if (Record->isUnion())
2358       return unionHasUniqueObjectRepresentations(*this, Record);
2359 
2360     Optional<int64_t> StructSize =
2361         structHasUniqueObjectRepresentations(*this, Record);
2362 
2363     return StructSize &&
2364            StructSize.getValue() == static_cast<int64_t>(getTypeSize(Ty));
2365   }
2366 
2367   // FIXME: More cases to handle here (list by rsmith):
2368   // vectors (careful about, eg, vector of 3 foo)
2369   // _Complex int and friends
2370   // _Atomic T
2371   // Obj-C block pointers
2372   // Obj-C object pointers
2373   // and perhaps OpenCL's various builtin types (pipe, sampler_t, event_t,
2374   // clk_event_t, queue_t, reserve_id_t)
2375   // There're also Obj-C class types and the Obj-C selector type, but I think it
2376   // makes sense for those to return false here.
2377 
2378   return false;
2379 }
2380 
2381 unsigned ASTContext::CountNonClassIvars(const ObjCInterfaceDecl *OI) const {
2382   unsigned count = 0;
2383   // Count ivars declared in class extension.
2384   for (const auto *Ext : OI->known_extensions())
2385     count += Ext->ivar_size();
2386 
2387   // Count ivar defined in this class's implementation.  This
2388   // includes synthesized ivars.
2389   if (ObjCImplementationDecl *ImplDecl = OI->getImplementation())
2390     count += ImplDecl->ivar_size();
2391 
2392   return count;
2393 }
2394 
2395 bool ASTContext::isSentinelNullExpr(const Expr *E) {
2396   if (!E)
2397     return false;
2398 
2399   // nullptr_t is always treated as null.
2400   if (E->getType()->isNullPtrType()) return true;
2401 
2402   if (E->getType()->isAnyPointerType() &&
2403       E->IgnoreParenCasts()->isNullPointerConstant(*this,
2404                                                 Expr::NPC_ValueDependentIsNull))
2405     return true;
2406 
2407   // Unfortunately, __null has type 'int'.
2408   if (isa<GNUNullExpr>(E)) return true;
2409 
2410   return false;
2411 }
2412 
2413 /// Get the implementation of ObjCInterfaceDecl, or nullptr if none
2414 /// exists.
2415 ObjCImplementationDecl *ASTContext::getObjCImplementation(ObjCInterfaceDecl *D) {
2416   llvm::DenseMap<ObjCContainerDecl*, ObjCImplDecl*>::iterator
2417     I = ObjCImpls.find(D);
2418   if (I != ObjCImpls.end())
2419     return cast<ObjCImplementationDecl>(I->second);
2420   return nullptr;
2421 }
2422 
2423 /// Get the implementation of ObjCCategoryDecl, or nullptr if none
2424 /// exists.
2425 ObjCCategoryImplDecl *ASTContext::getObjCImplementation(ObjCCategoryDecl *D) {
2426   llvm::DenseMap<ObjCContainerDecl*, ObjCImplDecl*>::iterator
2427     I = ObjCImpls.find(D);
2428   if (I != ObjCImpls.end())
2429     return cast<ObjCCategoryImplDecl>(I->second);
2430   return nullptr;
2431 }
2432 
2433 /// Set the implementation of ObjCInterfaceDecl.
2434 void ASTContext::setObjCImplementation(ObjCInterfaceDecl *IFaceD,
2435                            ObjCImplementationDecl *ImplD) {
2436   assert(IFaceD && ImplD && "Passed null params");
2437   ObjCImpls[IFaceD] = ImplD;
2438 }
2439 
2440 /// Set the implementation of ObjCCategoryDecl.
2441 void ASTContext::setObjCImplementation(ObjCCategoryDecl *CatD,
2442                            ObjCCategoryImplDecl *ImplD) {
2443   assert(CatD && ImplD && "Passed null params");
2444   ObjCImpls[CatD] = ImplD;
2445 }
2446 
2447 const ObjCMethodDecl *
2448 ASTContext::getObjCMethodRedeclaration(const ObjCMethodDecl *MD) const {
2449   return ObjCMethodRedecls.lookup(MD);
2450 }
2451 
2452 void ASTContext::setObjCMethodRedeclaration(const ObjCMethodDecl *MD,
2453                                             const ObjCMethodDecl *Redecl) {
2454   assert(!getObjCMethodRedeclaration(MD) && "MD already has a redeclaration");
2455   ObjCMethodRedecls[MD] = Redecl;
2456 }
2457 
2458 const ObjCInterfaceDecl *ASTContext::getObjContainingInterface(
2459                                               const NamedDecl *ND) const {
2460   if (const auto *ID = dyn_cast<ObjCInterfaceDecl>(ND->getDeclContext()))
2461     return ID;
2462   if (const auto *CD = dyn_cast<ObjCCategoryDecl>(ND->getDeclContext()))
2463     return CD->getClassInterface();
2464   if (const auto *IMD = dyn_cast<ObjCImplDecl>(ND->getDeclContext()))
2465     return IMD->getClassInterface();
2466 
2467   return nullptr;
2468 }
2469 
2470 /// Get the copy initialization expression of VarDecl, or nullptr if
2471 /// none exists.
2472 Expr *ASTContext::getBlockVarCopyInits(const VarDecl*VD) {
2473   assert(VD && "Passed null params");
2474   assert(VD->hasAttr<BlocksAttr>() &&
2475          "getBlockVarCopyInits - not __block var");
2476   llvm::DenseMap<const VarDecl*, Expr*>::iterator
2477     I = BlockVarCopyInits.find(VD);
2478   return (I != BlockVarCopyInits.end()) ? I->second : nullptr;
2479 }
2480 
2481 /// Set the copy inialization expression of a block var decl.
2482 void ASTContext::setBlockVarCopyInits(VarDecl*VD, Expr* Init) {
2483   assert(VD && Init && "Passed null params");
2484   assert(VD->hasAttr<BlocksAttr>() &&
2485          "setBlockVarCopyInits - not __block var");
2486   BlockVarCopyInits[VD] = Init;
2487 }
2488 
2489 TypeSourceInfo *ASTContext::CreateTypeSourceInfo(QualType T,
2490                                                  unsigned DataSize) const {
2491   if (!DataSize)
2492     DataSize = TypeLoc::getFullDataSizeForType(T);
2493   else
2494     assert(DataSize == TypeLoc::getFullDataSizeForType(T) &&
2495            "incorrect data size provided to CreateTypeSourceInfo!");
2496 
2497   auto *TInfo =
2498     (TypeSourceInfo*)BumpAlloc.Allocate(sizeof(TypeSourceInfo) + DataSize, 8);
2499   new (TInfo) TypeSourceInfo(T);
2500   return TInfo;
2501 }
2502 
2503 TypeSourceInfo *ASTContext::getTrivialTypeSourceInfo(QualType T,
2504                                                      SourceLocation L) const {
2505   TypeSourceInfo *DI = CreateTypeSourceInfo(T);
2506   DI->getTypeLoc().initialize(const_cast<ASTContext &>(*this), L);
2507   return DI;
2508 }
2509 
2510 const ASTRecordLayout &
2511 ASTContext::getASTObjCInterfaceLayout(const ObjCInterfaceDecl *D) const {
2512   return getObjCLayout(D, nullptr);
2513 }
2514 
2515 const ASTRecordLayout &
2516 ASTContext::getASTObjCImplementationLayout(
2517                                         const ObjCImplementationDecl *D) const {
2518   return getObjCLayout(D->getClassInterface(), D);
2519 }
2520 
2521 //===----------------------------------------------------------------------===//
2522 //                   Type creation/memoization methods
2523 //===----------------------------------------------------------------------===//
2524 
2525 QualType
2526 ASTContext::getExtQualType(const Type *baseType, Qualifiers quals) const {
2527   unsigned fastQuals = quals.getFastQualifiers();
2528   quals.removeFastQualifiers();
2529 
2530   // Check if we've already instantiated this type.
2531   llvm::FoldingSetNodeID ID;
2532   ExtQuals::Profile(ID, baseType, quals);
2533   void *insertPos = nullptr;
2534   if (ExtQuals *eq = ExtQualNodes.FindNodeOrInsertPos(ID, insertPos)) {
2535     assert(eq->getQualifiers() == quals);
2536     return QualType(eq, fastQuals);
2537   }
2538 
2539   // If the base type is not canonical, make the appropriate canonical type.
2540   QualType canon;
2541   if (!baseType->isCanonicalUnqualified()) {
2542     SplitQualType canonSplit = baseType->getCanonicalTypeInternal().split();
2543     canonSplit.Quals.addConsistentQualifiers(quals);
2544     canon = getExtQualType(canonSplit.Ty, canonSplit.Quals);
2545 
2546     // Re-find the insert position.
2547     (void) ExtQualNodes.FindNodeOrInsertPos(ID, insertPos);
2548   }
2549 
2550   auto *eq = new (*this, TypeAlignment) ExtQuals(baseType, canon, quals);
2551   ExtQualNodes.InsertNode(eq, insertPos);
2552   return QualType(eq, fastQuals);
2553 }
2554 
2555 QualType ASTContext::getAddrSpaceQualType(QualType T,
2556                                           LangAS AddressSpace) const {
2557   QualType CanT = getCanonicalType(T);
2558   if (CanT.getAddressSpace() == AddressSpace)
2559     return T;
2560 
2561   // If we are composing extended qualifiers together, merge together
2562   // into one ExtQuals node.
2563   QualifierCollector Quals;
2564   const Type *TypeNode = Quals.strip(T);
2565 
2566   // If this type already has an address space specified, it cannot get
2567   // another one.
2568   assert(!Quals.hasAddressSpace() &&
2569          "Type cannot be in multiple addr spaces!");
2570   Quals.addAddressSpace(AddressSpace);
2571 
2572   return getExtQualType(TypeNode, Quals);
2573 }
2574 
2575 QualType ASTContext::removeAddrSpaceQualType(QualType T) const {
2576   // If we are composing extended qualifiers together, merge together
2577   // into one ExtQuals node.
2578   QualifierCollector Quals;
2579   const Type *TypeNode = Quals.strip(T);
2580 
2581   // If the qualifier doesn't have an address space just return it.
2582   if (!Quals.hasAddressSpace())
2583     return T;
2584 
2585   Quals.removeAddressSpace();
2586 
2587   // Removal of the address space can mean there are no longer any
2588   // non-fast qualifiers, so creating an ExtQualType isn't possible (asserts)
2589   // or required.
2590   if (Quals.hasNonFastQualifiers())
2591     return getExtQualType(TypeNode, Quals);
2592   else
2593     return QualType(TypeNode, Quals.getFastQualifiers());
2594 }
2595 
2596 QualType ASTContext::getObjCGCQualType(QualType T,
2597                                        Qualifiers::GC GCAttr) const {
2598   QualType CanT = getCanonicalType(T);
2599   if (CanT.getObjCGCAttr() == GCAttr)
2600     return T;
2601 
2602   if (const auto *ptr = T->getAs<PointerType>()) {
2603     QualType Pointee = ptr->getPointeeType();
2604     if (Pointee->isAnyPointerType()) {
2605       QualType ResultType = getObjCGCQualType(Pointee, GCAttr);
2606       return getPointerType(ResultType);
2607     }
2608   }
2609 
2610   // If we are composing extended qualifiers together, merge together
2611   // into one ExtQuals node.
2612   QualifierCollector Quals;
2613   const Type *TypeNode = Quals.strip(T);
2614 
2615   // If this type already has an ObjCGC specified, it cannot get
2616   // another one.
2617   assert(!Quals.hasObjCGCAttr() &&
2618          "Type cannot have multiple ObjCGCs!");
2619   Quals.addObjCGCAttr(GCAttr);
2620 
2621   return getExtQualType(TypeNode, Quals);
2622 }
2623 
2624 const FunctionType *ASTContext::adjustFunctionType(const FunctionType *T,
2625                                                    FunctionType::ExtInfo Info) {
2626   if (T->getExtInfo() == Info)
2627     return T;
2628 
2629   QualType Result;
2630   if (const auto *FNPT = dyn_cast<FunctionNoProtoType>(T)) {
2631     Result = getFunctionNoProtoType(FNPT->getReturnType(), Info);
2632   } else {
2633     const auto *FPT = cast<FunctionProtoType>(T);
2634     FunctionProtoType::ExtProtoInfo EPI = FPT->getExtProtoInfo();
2635     EPI.ExtInfo = Info;
2636     Result = getFunctionType(FPT->getReturnType(), FPT->getParamTypes(), EPI);
2637   }
2638 
2639   return cast<FunctionType>(Result.getTypePtr());
2640 }
2641 
2642 void ASTContext::adjustDeducedFunctionResultType(FunctionDecl *FD,
2643                                                  QualType ResultType) {
2644   FD = FD->getMostRecentDecl();
2645   while (true) {
2646     const auto *FPT = FD->getType()->castAs<FunctionProtoType>();
2647     FunctionProtoType::ExtProtoInfo EPI = FPT->getExtProtoInfo();
2648     FD->setType(getFunctionType(ResultType, FPT->getParamTypes(), EPI));
2649     if (FunctionDecl *Next = FD->getPreviousDecl())
2650       FD = Next;
2651     else
2652       break;
2653   }
2654   if (ASTMutationListener *L = getASTMutationListener())
2655     L->DeducedReturnType(FD, ResultType);
2656 }
2657 
2658 /// Get a function type and produce the equivalent function type with the
2659 /// specified exception specification. Type sugar that can be present on a
2660 /// declaration of a function with an exception specification is permitted
2661 /// and preserved. Other type sugar (for instance, typedefs) is not.
2662 QualType ASTContext::getFunctionTypeWithExceptionSpec(
2663     QualType Orig, const FunctionProtoType::ExceptionSpecInfo &ESI) {
2664   // Might have some parens.
2665   if (const auto *PT = dyn_cast<ParenType>(Orig))
2666     return getParenType(
2667         getFunctionTypeWithExceptionSpec(PT->getInnerType(), ESI));
2668 
2669   // Might have a calling-convention attribute.
2670   if (const auto *AT = dyn_cast<AttributedType>(Orig))
2671     return getAttributedType(
2672         AT->getAttrKind(),
2673         getFunctionTypeWithExceptionSpec(AT->getModifiedType(), ESI),
2674         getFunctionTypeWithExceptionSpec(AT->getEquivalentType(), ESI));
2675 
2676   // Anything else must be a function type. Rebuild it with the new exception
2677   // specification.
2678   const auto *Proto = cast<FunctionProtoType>(Orig);
2679   return getFunctionType(
2680       Proto->getReturnType(), Proto->getParamTypes(),
2681       Proto->getExtProtoInfo().withExceptionSpec(ESI));
2682 }
2683 
2684 bool ASTContext::hasSameFunctionTypeIgnoringExceptionSpec(QualType T,
2685                                                           QualType U) {
2686   return hasSameType(T, U) ||
2687          (getLangOpts().CPlusPlus17 &&
2688           hasSameType(getFunctionTypeWithExceptionSpec(T, EST_None),
2689                       getFunctionTypeWithExceptionSpec(U, EST_None)));
2690 }
2691 
2692 void ASTContext::adjustExceptionSpec(
2693     FunctionDecl *FD, const FunctionProtoType::ExceptionSpecInfo &ESI,
2694     bool AsWritten) {
2695   // Update the type.
2696   QualType Updated =
2697       getFunctionTypeWithExceptionSpec(FD->getType(), ESI);
2698   FD->setType(Updated);
2699 
2700   if (!AsWritten)
2701     return;
2702 
2703   // Update the type in the type source information too.
2704   if (TypeSourceInfo *TSInfo = FD->getTypeSourceInfo()) {
2705     // If the type and the type-as-written differ, we may need to update
2706     // the type-as-written too.
2707     if (TSInfo->getType() != FD->getType())
2708       Updated = getFunctionTypeWithExceptionSpec(TSInfo->getType(), ESI);
2709 
2710     // FIXME: When we get proper type location information for exceptions,
2711     // we'll also have to rebuild the TypeSourceInfo. For now, we just patch
2712     // up the TypeSourceInfo;
2713     assert(TypeLoc::getFullDataSizeForType(Updated) ==
2714                TypeLoc::getFullDataSizeForType(TSInfo->getType()) &&
2715            "TypeLoc size mismatch from updating exception specification");
2716     TSInfo->overrideType(Updated);
2717   }
2718 }
2719 
2720 /// getComplexType - Return the uniqued reference to the type for a complex
2721 /// number with the specified element type.
2722 QualType ASTContext::getComplexType(QualType T) const {
2723   // Unique pointers, to guarantee there is only one pointer of a particular
2724   // structure.
2725   llvm::FoldingSetNodeID ID;
2726   ComplexType::Profile(ID, T);
2727 
2728   void *InsertPos = nullptr;
2729   if (ComplexType *CT = ComplexTypes.FindNodeOrInsertPos(ID, InsertPos))
2730     return QualType(CT, 0);
2731 
2732   // If the pointee type isn't canonical, this won't be a canonical type either,
2733   // so fill in the canonical type field.
2734   QualType Canonical;
2735   if (!T.isCanonical()) {
2736     Canonical = getComplexType(getCanonicalType(T));
2737 
2738     // Get the new insert position for the node we care about.
2739     ComplexType *NewIP = ComplexTypes.FindNodeOrInsertPos(ID, InsertPos);
2740     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
2741   }
2742   auto *New = new (*this, TypeAlignment) ComplexType(T, Canonical);
2743   Types.push_back(New);
2744   ComplexTypes.InsertNode(New, InsertPos);
2745   return QualType(New, 0);
2746 }
2747 
2748 /// getPointerType - Return the uniqued reference to the type for a pointer to
2749 /// the specified type.
2750 QualType ASTContext::getPointerType(QualType T) const {
2751   // Unique pointers, to guarantee there is only one pointer of a particular
2752   // structure.
2753   llvm::FoldingSetNodeID ID;
2754   PointerType::Profile(ID, T);
2755 
2756   void *InsertPos = nullptr;
2757   if (PointerType *PT = PointerTypes.FindNodeOrInsertPos(ID, InsertPos))
2758     return QualType(PT, 0);
2759 
2760   // If the pointee type isn't canonical, this won't be a canonical type either,
2761   // so fill in the canonical type field.
2762   QualType Canonical;
2763   if (!T.isCanonical()) {
2764     Canonical = getPointerType(getCanonicalType(T));
2765 
2766     // Get the new insert position for the node we care about.
2767     PointerType *NewIP = PointerTypes.FindNodeOrInsertPos(ID, InsertPos);
2768     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
2769   }
2770   auto *New = new (*this, TypeAlignment) PointerType(T, Canonical);
2771   Types.push_back(New);
2772   PointerTypes.InsertNode(New, InsertPos);
2773   return QualType(New, 0);
2774 }
2775 
2776 QualType ASTContext::getAdjustedType(QualType Orig, QualType New) const {
2777   llvm::FoldingSetNodeID ID;
2778   AdjustedType::Profile(ID, Orig, New);
2779   void *InsertPos = nullptr;
2780   AdjustedType *AT = AdjustedTypes.FindNodeOrInsertPos(ID, InsertPos);
2781   if (AT)
2782     return QualType(AT, 0);
2783 
2784   QualType Canonical = getCanonicalType(New);
2785 
2786   // Get the new insert position for the node we care about.
2787   AT = AdjustedTypes.FindNodeOrInsertPos(ID, InsertPos);
2788   assert(!AT && "Shouldn't be in the map!");
2789 
2790   AT = new (*this, TypeAlignment)
2791       AdjustedType(Type::Adjusted, Orig, New, Canonical);
2792   Types.push_back(AT);
2793   AdjustedTypes.InsertNode(AT, InsertPos);
2794   return QualType(AT, 0);
2795 }
2796 
2797 QualType ASTContext::getDecayedType(QualType T) const {
2798   assert((T->isArrayType() || T->isFunctionType()) && "T does not decay");
2799 
2800   QualType Decayed;
2801 
2802   // C99 6.7.5.3p7:
2803   //   A declaration of a parameter as "array of type" shall be
2804   //   adjusted to "qualified pointer to type", where the type
2805   //   qualifiers (if any) are those specified within the [ and ] of
2806   //   the array type derivation.
2807   if (T->isArrayType())
2808     Decayed = getArrayDecayedType(T);
2809 
2810   // C99 6.7.5.3p8:
2811   //   A declaration of a parameter as "function returning type"
2812   //   shall be adjusted to "pointer to function returning type", as
2813   //   in 6.3.2.1.
2814   if (T->isFunctionType())
2815     Decayed = getPointerType(T);
2816 
2817   llvm::FoldingSetNodeID ID;
2818   AdjustedType::Profile(ID, T, Decayed);
2819   void *InsertPos = nullptr;
2820   AdjustedType *AT = AdjustedTypes.FindNodeOrInsertPos(ID, InsertPos);
2821   if (AT)
2822     return QualType(AT, 0);
2823 
2824   QualType Canonical = getCanonicalType(Decayed);
2825 
2826   // Get the new insert position for the node we care about.
2827   AT = AdjustedTypes.FindNodeOrInsertPos(ID, InsertPos);
2828   assert(!AT && "Shouldn't be in the map!");
2829 
2830   AT = new (*this, TypeAlignment) DecayedType(T, Decayed, Canonical);
2831   Types.push_back(AT);
2832   AdjustedTypes.InsertNode(AT, InsertPos);
2833   return QualType(AT, 0);
2834 }
2835 
2836 /// getBlockPointerType - Return the uniqued reference to the type for
2837 /// a pointer to the specified block.
2838 QualType ASTContext::getBlockPointerType(QualType T) const {
2839   assert(T->isFunctionType() && "block of function types only");
2840   // Unique pointers, to guarantee there is only one block of a particular
2841   // structure.
2842   llvm::FoldingSetNodeID ID;
2843   BlockPointerType::Profile(ID, T);
2844 
2845   void *InsertPos = nullptr;
2846   if (BlockPointerType *PT =
2847         BlockPointerTypes.FindNodeOrInsertPos(ID, InsertPos))
2848     return QualType(PT, 0);
2849 
2850   // If the block pointee type isn't canonical, this won't be a canonical
2851   // type either so fill in the canonical type field.
2852   QualType Canonical;
2853   if (!T.isCanonical()) {
2854     Canonical = getBlockPointerType(getCanonicalType(T));
2855 
2856     // Get the new insert position for the node we care about.
2857     BlockPointerType *NewIP =
2858       BlockPointerTypes.FindNodeOrInsertPos(ID, InsertPos);
2859     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
2860   }
2861   auto *New = new (*this, TypeAlignment) BlockPointerType(T, Canonical);
2862   Types.push_back(New);
2863   BlockPointerTypes.InsertNode(New, InsertPos);
2864   return QualType(New, 0);
2865 }
2866 
2867 /// getLValueReferenceType - Return the uniqued reference to the type for an
2868 /// lvalue reference to the specified type.
2869 QualType
2870 ASTContext::getLValueReferenceType(QualType T, bool SpelledAsLValue) const {
2871   assert(getCanonicalType(T) != OverloadTy &&
2872          "Unresolved overloaded function type");
2873 
2874   // Unique pointers, to guarantee there is only one pointer of a particular
2875   // structure.
2876   llvm::FoldingSetNodeID ID;
2877   ReferenceType::Profile(ID, T, SpelledAsLValue);
2878 
2879   void *InsertPos = nullptr;
2880   if (LValueReferenceType *RT =
2881         LValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos))
2882     return QualType(RT, 0);
2883 
2884   const auto *InnerRef = T->getAs<ReferenceType>();
2885 
2886   // If the referencee type isn't canonical, this won't be a canonical type
2887   // either, so fill in the canonical type field.
2888   QualType Canonical;
2889   if (!SpelledAsLValue || InnerRef || !T.isCanonical()) {
2890     QualType PointeeType = (InnerRef ? InnerRef->getPointeeType() : T);
2891     Canonical = getLValueReferenceType(getCanonicalType(PointeeType));
2892 
2893     // Get the new insert position for the node we care about.
2894     LValueReferenceType *NewIP =
2895       LValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos);
2896     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
2897   }
2898 
2899   auto *New = new (*this, TypeAlignment) LValueReferenceType(T, Canonical,
2900                                                              SpelledAsLValue);
2901   Types.push_back(New);
2902   LValueReferenceTypes.InsertNode(New, InsertPos);
2903 
2904   return QualType(New, 0);
2905 }
2906 
2907 /// getRValueReferenceType - Return the uniqued reference to the type for an
2908 /// rvalue reference to the specified type.
2909 QualType ASTContext::getRValueReferenceType(QualType T) const {
2910   // Unique pointers, to guarantee there is only one pointer of a particular
2911   // structure.
2912   llvm::FoldingSetNodeID ID;
2913   ReferenceType::Profile(ID, T, false);
2914 
2915   void *InsertPos = nullptr;
2916   if (RValueReferenceType *RT =
2917         RValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos))
2918     return QualType(RT, 0);
2919 
2920   const auto *InnerRef = T->getAs<ReferenceType>();
2921 
2922   // If the referencee type isn't canonical, this won't be a canonical type
2923   // either, so fill in the canonical type field.
2924   QualType Canonical;
2925   if (InnerRef || !T.isCanonical()) {
2926     QualType PointeeType = (InnerRef ? InnerRef->getPointeeType() : T);
2927     Canonical = getRValueReferenceType(getCanonicalType(PointeeType));
2928 
2929     // Get the new insert position for the node we care about.
2930     RValueReferenceType *NewIP =
2931       RValueReferenceTypes.FindNodeOrInsertPos(ID, InsertPos);
2932     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
2933   }
2934 
2935   auto *New = new (*this, TypeAlignment) RValueReferenceType(T, Canonical);
2936   Types.push_back(New);
2937   RValueReferenceTypes.InsertNode(New, InsertPos);
2938   return QualType(New, 0);
2939 }
2940 
2941 /// getMemberPointerType - Return the uniqued reference to the type for a
2942 /// member pointer to the specified type, in the specified class.
2943 QualType ASTContext::getMemberPointerType(QualType T, const Type *Cls) const {
2944   // Unique pointers, to guarantee there is only one pointer of a particular
2945   // structure.
2946   llvm::FoldingSetNodeID ID;
2947   MemberPointerType::Profile(ID, T, Cls);
2948 
2949   void *InsertPos = nullptr;
2950   if (MemberPointerType *PT =
2951       MemberPointerTypes.FindNodeOrInsertPos(ID, InsertPos))
2952     return QualType(PT, 0);
2953 
2954   // If the pointee or class type isn't canonical, this won't be a canonical
2955   // type either, so fill in the canonical type field.
2956   QualType Canonical;
2957   if (!T.isCanonical() || !Cls->isCanonicalUnqualified()) {
2958     Canonical = getMemberPointerType(getCanonicalType(T),getCanonicalType(Cls));
2959 
2960     // Get the new insert position for the node we care about.
2961     MemberPointerType *NewIP =
2962       MemberPointerTypes.FindNodeOrInsertPos(ID, InsertPos);
2963     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
2964   }
2965   auto *New = new (*this, TypeAlignment) MemberPointerType(T, Cls, Canonical);
2966   Types.push_back(New);
2967   MemberPointerTypes.InsertNode(New, InsertPos);
2968   return QualType(New, 0);
2969 }
2970 
2971 /// getConstantArrayType - Return the unique reference to the type for an
2972 /// array of the specified element type.
2973 QualType ASTContext::getConstantArrayType(QualType EltTy,
2974                                           const llvm::APInt &ArySizeIn,
2975                                           ArrayType::ArraySizeModifier ASM,
2976                                           unsigned IndexTypeQuals) const {
2977   assert((EltTy->isDependentType() ||
2978           EltTy->isIncompleteType() || EltTy->isConstantSizeType()) &&
2979          "Constant array of VLAs is illegal!");
2980 
2981   // Convert the array size into a canonical width matching the pointer size for
2982   // the target.
2983   llvm::APInt ArySize(ArySizeIn);
2984   ArySize = ArySize.zextOrTrunc(Target->getMaxPointerWidth());
2985 
2986   llvm::FoldingSetNodeID ID;
2987   ConstantArrayType::Profile(ID, EltTy, ArySize, ASM, IndexTypeQuals);
2988 
2989   void *InsertPos = nullptr;
2990   if (ConstantArrayType *ATP =
2991       ConstantArrayTypes.FindNodeOrInsertPos(ID, InsertPos))
2992     return QualType(ATP, 0);
2993 
2994   // If the element type isn't canonical or has qualifiers, this won't
2995   // be a canonical type either, so fill in the canonical type field.
2996   QualType Canon;
2997   if (!EltTy.isCanonical() || EltTy.hasLocalQualifiers()) {
2998     SplitQualType canonSplit = getCanonicalType(EltTy).split();
2999     Canon = getConstantArrayType(QualType(canonSplit.Ty, 0), ArySize,
3000                                  ASM, IndexTypeQuals);
3001     Canon = getQualifiedType(Canon, canonSplit.Quals);
3002 
3003     // Get the new insert position for the node we care about.
3004     ConstantArrayType *NewIP =
3005       ConstantArrayTypes.FindNodeOrInsertPos(ID, InsertPos);
3006     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
3007   }
3008 
3009   auto *New = new (*this,TypeAlignment)
3010     ConstantArrayType(EltTy, Canon, ArySize, ASM, IndexTypeQuals);
3011   ConstantArrayTypes.InsertNode(New, InsertPos);
3012   Types.push_back(New);
3013   return QualType(New, 0);
3014 }
3015 
3016 /// getVariableArrayDecayedType - Turns the given type, which may be
3017 /// variably-modified, into the corresponding type with all the known
3018 /// sizes replaced with [*].
3019 QualType ASTContext::getVariableArrayDecayedType(QualType type) const {
3020   // Vastly most common case.
3021   if (!type->isVariablyModifiedType()) return type;
3022 
3023   QualType result;
3024 
3025   SplitQualType split = type.getSplitDesugaredType();
3026   const Type *ty = split.Ty;
3027   switch (ty->getTypeClass()) {
3028 #define TYPE(Class, Base)
3029 #define ABSTRACT_TYPE(Class, Base)
3030 #define NON_CANONICAL_TYPE(Class, Base) case Type::Class:
3031 #include "clang/AST/TypeNodes.def"
3032     llvm_unreachable("didn't desugar past all non-canonical types?");
3033 
3034   // These types should never be variably-modified.
3035   case Type::Builtin:
3036   case Type::Complex:
3037   case Type::Vector:
3038   case Type::ExtVector:
3039   case Type::DependentSizedExtVector:
3040   case Type::DependentAddressSpace:
3041   case Type::ObjCObject:
3042   case Type::ObjCInterface:
3043   case Type::ObjCObjectPointer:
3044   case Type::Record:
3045   case Type::Enum:
3046   case Type::UnresolvedUsing:
3047   case Type::TypeOfExpr:
3048   case Type::TypeOf:
3049   case Type::Decltype:
3050   case Type::UnaryTransform:
3051   case Type::DependentName:
3052   case Type::InjectedClassName:
3053   case Type::TemplateSpecialization:
3054   case Type::DependentTemplateSpecialization:
3055   case Type::TemplateTypeParm:
3056   case Type::SubstTemplateTypeParmPack:
3057   case Type::Auto:
3058   case Type::DeducedTemplateSpecialization:
3059   case Type::PackExpansion:
3060     llvm_unreachable("type should never be variably-modified");
3061 
3062   // These types can be variably-modified but should never need to
3063   // further decay.
3064   case Type::FunctionNoProto:
3065   case Type::FunctionProto:
3066   case Type::BlockPointer:
3067   case Type::MemberPointer:
3068   case Type::Pipe:
3069     return type;
3070 
3071   // These types can be variably-modified.  All these modifications
3072   // preserve structure except as noted by comments.
3073   // TODO: if we ever care about optimizing VLAs, there are no-op
3074   // optimizations available here.
3075   case Type::Pointer:
3076     result = getPointerType(getVariableArrayDecayedType(
3077                               cast<PointerType>(ty)->getPointeeType()));
3078     break;
3079 
3080   case Type::LValueReference: {
3081     const auto *lv = cast<LValueReferenceType>(ty);
3082     result = getLValueReferenceType(
3083                  getVariableArrayDecayedType(lv->getPointeeType()),
3084                                     lv->isSpelledAsLValue());
3085     break;
3086   }
3087 
3088   case Type::RValueReference: {
3089     const auto *lv = cast<RValueReferenceType>(ty);
3090     result = getRValueReferenceType(
3091                  getVariableArrayDecayedType(lv->getPointeeType()));
3092     break;
3093   }
3094 
3095   case Type::Atomic: {
3096     const auto *at = cast<AtomicType>(ty);
3097     result = getAtomicType(getVariableArrayDecayedType(at->getValueType()));
3098     break;
3099   }
3100 
3101   case Type::ConstantArray: {
3102     const auto *cat = cast<ConstantArrayType>(ty);
3103     result = getConstantArrayType(
3104                  getVariableArrayDecayedType(cat->getElementType()),
3105                                   cat->getSize(),
3106                                   cat->getSizeModifier(),
3107                                   cat->getIndexTypeCVRQualifiers());
3108     break;
3109   }
3110 
3111   case Type::DependentSizedArray: {
3112     const auto *dat = cast<DependentSizedArrayType>(ty);
3113     result = getDependentSizedArrayType(
3114                  getVariableArrayDecayedType(dat->getElementType()),
3115                                         dat->getSizeExpr(),
3116                                         dat->getSizeModifier(),
3117                                         dat->getIndexTypeCVRQualifiers(),
3118                                         dat->getBracketsRange());
3119     break;
3120   }
3121 
3122   // Turn incomplete types into [*] types.
3123   case Type::IncompleteArray: {
3124     const auto *iat = cast<IncompleteArrayType>(ty);
3125     result = getVariableArrayType(
3126                  getVariableArrayDecayedType(iat->getElementType()),
3127                                   /*size*/ nullptr,
3128                                   ArrayType::Normal,
3129                                   iat->getIndexTypeCVRQualifiers(),
3130                                   SourceRange());
3131     break;
3132   }
3133 
3134   // Turn VLA types into [*] types.
3135   case Type::VariableArray: {
3136     const auto *vat = cast<VariableArrayType>(ty);
3137     result = getVariableArrayType(
3138                  getVariableArrayDecayedType(vat->getElementType()),
3139                                   /*size*/ nullptr,
3140                                   ArrayType::Star,
3141                                   vat->getIndexTypeCVRQualifiers(),
3142                                   vat->getBracketsRange());
3143     break;
3144   }
3145   }
3146 
3147   // Apply the top-level qualifiers from the original.
3148   return getQualifiedType(result, split.Quals);
3149 }
3150 
3151 /// getVariableArrayType - Returns a non-unique reference to the type for a
3152 /// variable array of the specified element type.
3153 QualType ASTContext::getVariableArrayType(QualType EltTy,
3154                                           Expr *NumElts,
3155                                           ArrayType::ArraySizeModifier ASM,
3156                                           unsigned IndexTypeQuals,
3157                                           SourceRange Brackets) const {
3158   // Since we don't unique expressions, it isn't possible to unique VLA's
3159   // that have an expression provided for their size.
3160   QualType Canon;
3161 
3162   // Be sure to pull qualifiers off the element type.
3163   if (!EltTy.isCanonical() || EltTy.hasLocalQualifiers()) {
3164     SplitQualType canonSplit = getCanonicalType(EltTy).split();
3165     Canon = getVariableArrayType(QualType(canonSplit.Ty, 0), NumElts, ASM,
3166                                  IndexTypeQuals, Brackets);
3167     Canon = getQualifiedType(Canon, canonSplit.Quals);
3168   }
3169 
3170   auto *New = new (*this, TypeAlignment)
3171     VariableArrayType(EltTy, Canon, NumElts, ASM, IndexTypeQuals, Brackets);
3172 
3173   VariableArrayTypes.push_back(New);
3174   Types.push_back(New);
3175   return QualType(New, 0);
3176 }
3177 
3178 /// getDependentSizedArrayType - Returns a non-unique reference to
3179 /// the type for a dependently-sized array of the specified element
3180 /// type.
3181 QualType ASTContext::getDependentSizedArrayType(QualType elementType,
3182                                                 Expr *numElements,
3183                                                 ArrayType::ArraySizeModifier ASM,
3184                                                 unsigned elementTypeQuals,
3185                                                 SourceRange brackets) const {
3186   assert((!numElements || numElements->isTypeDependent() ||
3187           numElements->isValueDependent()) &&
3188          "Size must be type- or value-dependent!");
3189 
3190   // Dependently-sized array types that do not have a specified number
3191   // of elements will have their sizes deduced from a dependent
3192   // initializer.  We do no canonicalization here at all, which is okay
3193   // because they can't be used in most locations.
3194   if (!numElements) {
3195     auto *newType
3196       = new (*this, TypeAlignment)
3197           DependentSizedArrayType(*this, elementType, QualType(),
3198                                   numElements, ASM, elementTypeQuals,
3199                                   brackets);
3200     Types.push_back(newType);
3201     return QualType(newType, 0);
3202   }
3203 
3204   // Otherwise, we actually build a new type every time, but we
3205   // also build a canonical type.
3206 
3207   SplitQualType canonElementType = getCanonicalType(elementType).split();
3208 
3209   void *insertPos = nullptr;
3210   llvm::FoldingSetNodeID ID;
3211   DependentSizedArrayType::Profile(ID, *this,
3212                                    QualType(canonElementType.Ty, 0),
3213                                    ASM, elementTypeQuals, numElements);
3214 
3215   // Look for an existing type with these properties.
3216   DependentSizedArrayType *canonTy =
3217     DependentSizedArrayTypes.FindNodeOrInsertPos(ID, insertPos);
3218 
3219   // If we don't have one, build one.
3220   if (!canonTy) {
3221     canonTy = new (*this, TypeAlignment)
3222       DependentSizedArrayType(*this, QualType(canonElementType.Ty, 0),
3223                               QualType(), numElements, ASM, elementTypeQuals,
3224                               brackets);
3225     DependentSizedArrayTypes.InsertNode(canonTy, insertPos);
3226     Types.push_back(canonTy);
3227   }
3228 
3229   // Apply qualifiers from the element type to the array.
3230   QualType canon = getQualifiedType(QualType(canonTy,0),
3231                                     canonElementType.Quals);
3232 
3233   // If we didn't need extra canonicalization for the element type or the size
3234   // expression, then just use that as our result.
3235   if (QualType(canonElementType.Ty, 0) == elementType &&
3236       canonTy->getSizeExpr() == numElements)
3237     return canon;
3238 
3239   // Otherwise, we need to build a type which follows the spelling
3240   // of the element type.
3241   auto *sugaredType
3242     = new (*this, TypeAlignment)
3243         DependentSizedArrayType(*this, elementType, canon, numElements,
3244                                 ASM, elementTypeQuals, brackets);
3245   Types.push_back(sugaredType);
3246   return QualType(sugaredType, 0);
3247 }
3248 
3249 QualType ASTContext::getIncompleteArrayType(QualType elementType,
3250                                             ArrayType::ArraySizeModifier ASM,
3251                                             unsigned elementTypeQuals) const {
3252   llvm::FoldingSetNodeID ID;
3253   IncompleteArrayType::Profile(ID, elementType, ASM, elementTypeQuals);
3254 
3255   void *insertPos = nullptr;
3256   if (IncompleteArrayType *iat =
3257        IncompleteArrayTypes.FindNodeOrInsertPos(ID, insertPos))
3258     return QualType(iat, 0);
3259 
3260   // If the element type isn't canonical, this won't be a canonical type
3261   // either, so fill in the canonical type field.  We also have to pull
3262   // qualifiers off the element type.
3263   QualType canon;
3264 
3265   if (!elementType.isCanonical() || elementType.hasLocalQualifiers()) {
3266     SplitQualType canonSplit = getCanonicalType(elementType).split();
3267     canon = getIncompleteArrayType(QualType(canonSplit.Ty, 0),
3268                                    ASM, elementTypeQuals);
3269     canon = getQualifiedType(canon, canonSplit.Quals);
3270 
3271     // Get the new insert position for the node we care about.
3272     IncompleteArrayType *existing =
3273       IncompleteArrayTypes.FindNodeOrInsertPos(ID, insertPos);
3274     assert(!existing && "Shouldn't be in the map!"); (void) existing;
3275   }
3276 
3277   auto *newType = new (*this, TypeAlignment)
3278     IncompleteArrayType(elementType, canon, ASM, elementTypeQuals);
3279 
3280   IncompleteArrayTypes.InsertNode(newType, insertPos);
3281   Types.push_back(newType);
3282   return QualType(newType, 0);
3283 }
3284 
3285 /// getVectorType - Return the unique reference to a vector type of
3286 /// the specified element type and size. VectorType must be a built-in type.
3287 QualType ASTContext::getVectorType(QualType vecType, unsigned NumElts,
3288                                    VectorType::VectorKind VecKind) const {
3289   assert(vecType->isBuiltinType());
3290 
3291   // Check if we've already instantiated a vector of this type.
3292   llvm::FoldingSetNodeID ID;
3293   VectorType::Profile(ID, vecType, NumElts, Type::Vector, VecKind);
3294 
3295   void *InsertPos = nullptr;
3296   if (VectorType *VTP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos))
3297     return QualType(VTP, 0);
3298 
3299   // If the element type isn't canonical, this won't be a canonical type either,
3300   // so fill in the canonical type field.
3301   QualType Canonical;
3302   if (!vecType.isCanonical()) {
3303     Canonical = getVectorType(getCanonicalType(vecType), NumElts, VecKind);
3304 
3305     // Get the new insert position for the node we care about.
3306     VectorType *NewIP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos);
3307     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
3308   }
3309   auto *New = new (*this, TypeAlignment)
3310     VectorType(vecType, NumElts, Canonical, VecKind);
3311   VectorTypes.InsertNode(New, InsertPos);
3312   Types.push_back(New);
3313   return QualType(New, 0);
3314 }
3315 
3316 /// getExtVectorType - Return the unique reference to an extended vector type of
3317 /// the specified element type and size. VectorType must be a built-in type.
3318 QualType
3319 ASTContext::getExtVectorType(QualType vecType, unsigned NumElts) const {
3320   assert(vecType->isBuiltinType() || vecType->isDependentType());
3321 
3322   // Check if we've already instantiated a vector of this type.
3323   llvm::FoldingSetNodeID ID;
3324   VectorType::Profile(ID, vecType, NumElts, Type::ExtVector,
3325                       VectorType::GenericVector);
3326   void *InsertPos = nullptr;
3327   if (VectorType *VTP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos))
3328     return QualType(VTP, 0);
3329 
3330   // If the element type isn't canonical, this won't be a canonical type either,
3331   // so fill in the canonical type field.
3332   QualType Canonical;
3333   if (!vecType.isCanonical()) {
3334     Canonical = getExtVectorType(getCanonicalType(vecType), NumElts);
3335 
3336     // Get the new insert position for the node we care about.
3337     VectorType *NewIP = VectorTypes.FindNodeOrInsertPos(ID, InsertPos);
3338     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
3339   }
3340   auto *New = new (*this, TypeAlignment)
3341     ExtVectorType(vecType, NumElts, Canonical);
3342   VectorTypes.InsertNode(New, InsertPos);
3343   Types.push_back(New);
3344   return QualType(New, 0);
3345 }
3346 
3347 QualType
3348 ASTContext::getDependentSizedExtVectorType(QualType vecType,
3349                                            Expr *SizeExpr,
3350                                            SourceLocation AttrLoc) const {
3351   llvm::FoldingSetNodeID ID;
3352   DependentSizedExtVectorType::Profile(ID, *this, getCanonicalType(vecType),
3353                                        SizeExpr);
3354 
3355   void *InsertPos = nullptr;
3356   DependentSizedExtVectorType *Canon
3357     = DependentSizedExtVectorTypes.FindNodeOrInsertPos(ID, InsertPos);
3358   DependentSizedExtVectorType *New;
3359   if (Canon) {
3360     // We already have a canonical version of this array type; use it as
3361     // the canonical type for a newly-built type.
3362     New = new (*this, TypeAlignment)
3363       DependentSizedExtVectorType(*this, vecType, QualType(Canon, 0),
3364                                   SizeExpr, AttrLoc);
3365   } else {
3366     QualType CanonVecTy = getCanonicalType(vecType);
3367     if (CanonVecTy == vecType) {
3368       New = new (*this, TypeAlignment)
3369         DependentSizedExtVectorType(*this, vecType, QualType(), SizeExpr,
3370                                     AttrLoc);
3371 
3372       DependentSizedExtVectorType *CanonCheck
3373         = DependentSizedExtVectorTypes.FindNodeOrInsertPos(ID, InsertPos);
3374       assert(!CanonCheck && "Dependent-sized ext_vector canonical type broken");
3375       (void)CanonCheck;
3376       DependentSizedExtVectorTypes.InsertNode(New, InsertPos);
3377     } else {
3378       QualType Canon = getDependentSizedExtVectorType(CanonVecTy, SizeExpr,
3379                                                       SourceLocation());
3380       New = new (*this, TypeAlignment)
3381         DependentSizedExtVectorType(*this, vecType, Canon, SizeExpr, AttrLoc);
3382     }
3383   }
3384 
3385   Types.push_back(New);
3386   return QualType(New, 0);
3387 }
3388 
3389 QualType ASTContext::getDependentAddressSpaceType(QualType PointeeType,
3390                                                   Expr *AddrSpaceExpr,
3391                                                   SourceLocation AttrLoc) const {
3392   assert(AddrSpaceExpr->isInstantiationDependent());
3393 
3394   QualType canonPointeeType = getCanonicalType(PointeeType);
3395 
3396   void *insertPos = nullptr;
3397   llvm::FoldingSetNodeID ID;
3398   DependentAddressSpaceType::Profile(ID, *this, canonPointeeType,
3399                                      AddrSpaceExpr);
3400 
3401   DependentAddressSpaceType *canonTy =
3402     DependentAddressSpaceTypes.FindNodeOrInsertPos(ID, insertPos);
3403 
3404   if (!canonTy) {
3405     canonTy = new (*this, TypeAlignment)
3406       DependentAddressSpaceType(*this, canonPointeeType,
3407                                 QualType(), AddrSpaceExpr, AttrLoc);
3408     DependentAddressSpaceTypes.InsertNode(canonTy, insertPos);
3409     Types.push_back(canonTy);
3410   }
3411 
3412   if (canonPointeeType == PointeeType &&
3413       canonTy->getAddrSpaceExpr() == AddrSpaceExpr)
3414     return QualType(canonTy, 0);
3415 
3416   auto *sugaredType
3417     = new (*this, TypeAlignment)
3418         DependentAddressSpaceType(*this, PointeeType, QualType(canonTy, 0),
3419                                   AddrSpaceExpr, AttrLoc);
3420   Types.push_back(sugaredType);
3421   return QualType(sugaredType, 0);
3422 }
3423 
3424 /// Determine whether \p T is canonical as the result type of a function.
3425 static bool isCanonicalResultType(QualType T) {
3426   return T.isCanonical() &&
3427          (T.getObjCLifetime() == Qualifiers::OCL_None ||
3428           T.getObjCLifetime() == Qualifiers::OCL_ExplicitNone);
3429 }
3430 
3431 /// getFunctionNoProtoType - Return a K&R style C function type like 'int()'.
3432 QualType
3433 ASTContext::getFunctionNoProtoType(QualType ResultTy,
3434                                    const FunctionType::ExtInfo &Info) const {
3435   // Unique functions, to guarantee there is only one function of a particular
3436   // structure.
3437   llvm::FoldingSetNodeID ID;
3438   FunctionNoProtoType::Profile(ID, ResultTy, Info);
3439 
3440   void *InsertPos = nullptr;
3441   if (FunctionNoProtoType *FT =
3442         FunctionNoProtoTypes.FindNodeOrInsertPos(ID, InsertPos))
3443     return QualType(FT, 0);
3444 
3445   QualType Canonical;
3446   if (!isCanonicalResultType(ResultTy)) {
3447     Canonical =
3448       getFunctionNoProtoType(getCanonicalFunctionResultType(ResultTy), Info);
3449 
3450     // Get the new insert position for the node we care about.
3451     FunctionNoProtoType *NewIP =
3452       FunctionNoProtoTypes.FindNodeOrInsertPos(ID, InsertPos);
3453     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
3454   }
3455 
3456   auto *New = new (*this, TypeAlignment)
3457     FunctionNoProtoType(ResultTy, Canonical, Info);
3458   Types.push_back(New);
3459   FunctionNoProtoTypes.InsertNode(New, InsertPos);
3460   return QualType(New, 0);
3461 }
3462 
3463 CanQualType
3464 ASTContext::getCanonicalFunctionResultType(QualType ResultType) const {
3465   CanQualType CanResultType = getCanonicalType(ResultType);
3466 
3467   // Canonical result types do not have ARC lifetime qualifiers.
3468   if (CanResultType.getQualifiers().hasObjCLifetime()) {
3469     Qualifiers Qs = CanResultType.getQualifiers();
3470     Qs.removeObjCLifetime();
3471     return CanQualType::CreateUnsafe(
3472              getQualifiedType(CanResultType.getUnqualifiedType(), Qs));
3473   }
3474 
3475   return CanResultType;
3476 }
3477 
3478 static bool isCanonicalExceptionSpecification(
3479     const FunctionProtoType::ExceptionSpecInfo &ESI, bool NoexceptInType) {
3480   if (ESI.Type == EST_None)
3481     return true;
3482   if (!NoexceptInType)
3483     return false;
3484 
3485   // C++17 onwards: exception specification is part of the type, as a simple
3486   // boolean "can this function type throw".
3487   if (ESI.Type == EST_BasicNoexcept)
3488     return true;
3489 
3490   // A noexcept(expr) specification is (possibly) canonical if expr is
3491   // value-dependent.
3492   if (ESI.Type == EST_DependentNoexcept)
3493     return true;
3494 
3495   // A dynamic exception specification is canonical if it only contains pack
3496   // expansions (so we can't tell whether it's non-throwing) and all its
3497   // contained types are canonical.
3498   if (ESI.Type == EST_Dynamic) {
3499     bool AnyPackExpansions = false;
3500     for (QualType ET : ESI.Exceptions) {
3501       if (!ET.isCanonical())
3502         return false;
3503       if (ET->getAs<PackExpansionType>())
3504         AnyPackExpansions = true;
3505     }
3506     return AnyPackExpansions;
3507   }
3508 
3509   return false;
3510 }
3511 
3512 QualType ASTContext::getFunctionTypeInternal(
3513     QualType ResultTy, ArrayRef<QualType> ArgArray,
3514     const FunctionProtoType::ExtProtoInfo &EPI, bool OnlyWantCanonical) const {
3515   size_t NumArgs = ArgArray.size();
3516 
3517   // Unique functions, to guarantee there is only one function of a particular
3518   // structure.
3519   llvm::FoldingSetNodeID ID;
3520   FunctionProtoType::Profile(ID, ResultTy, ArgArray.begin(), NumArgs, EPI,
3521                              *this, true);
3522 
3523   QualType Canonical;
3524   bool Unique = false;
3525 
3526   void *InsertPos = nullptr;
3527   if (FunctionProtoType *FPT =
3528         FunctionProtoTypes.FindNodeOrInsertPos(ID, InsertPos)) {
3529     QualType Existing = QualType(FPT, 0);
3530 
3531     // If we find a pre-existing equivalent FunctionProtoType, we can just reuse
3532     // it so long as our exception specification doesn't contain a dependent
3533     // noexcept expression, or we're just looking for a canonical type.
3534     // Otherwise, we're going to need to create a type
3535     // sugar node to hold the concrete expression.
3536     if (OnlyWantCanonical || !isComputedNoexcept(EPI.ExceptionSpec.Type) ||
3537         EPI.ExceptionSpec.NoexceptExpr == FPT->getNoexceptExpr())
3538       return Existing;
3539 
3540     // We need a new type sugar node for this one, to hold the new noexcept
3541     // expression. We do no canonicalization here, but that's OK since we don't
3542     // expect to see the same noexcept expression much more than once.
3543     Canonical = getCanonicalType(Existing);
3544     Unique = true;
3545   }
3546 
3547   bool NoexceptInType = getLangOpts().CPlusPlus17;
3548   bool IsCanonicalExceptionSpec =
3549       isCanonicalExceptionSpecification(EPI.ExceptionSpec, NoexceptInType);
3550 
3551   // Determine whether the type being created is already canonical or not.
3552   bool isCanonical = !Unique && IsCanonicalExceptionSpec &&
3553                      isCanonicalResultType(ResultTy) && !EPI.HasTrailingReturn;
3554   for (unsigned i = 0; i != NumArgs && isCanonical; ++i)
3555     if (!ArgArray[i].isCanonicalAsParam())
3556       isCanonical = false;
3557 
3558   if (OnlyWantCanonical)
3559     assert(isCanonical &&
3560            "given non-canonical parameters constructing canonical type");
3561 
3562   // If this type isn't canonical, get the canonical version of it if we don't
3563   // already have it. The exception spec is only partially part of the
3564   // canonical type, and only in C++17 onwards.
3565   if (!isCanonical && Canonical.isNull()) {
3566     SmallVector<QualType, 16> CanonicalArgs;
3567     CanonicalArgs.reserve(NumArgs);
3568     for (unsigned i = 0; i != NumArgs; ++i)
3569       CanonicalArgs.push_back(getCanonicalParamType(ArgArray[i]));
3570 
3571     llvm::SmallVector<QualType, 8> ExceptionTypeStorage;
3572     FunctionProtoType::ExtProtoInfo CanonicalEPI = EPI;
3573     CanonicalEPI.HasTrailingReturn = false;
3574 
3575     if (IsCanonicalExceptionSpec) {
3576       // Exception spec is already OK.
3577     } else if (NoexceptInType) {
3578       switch (EPI.ExceptionSpec.Type) {
3579       case EST_Unparsed: case EST_Unevaluated: case EST_Uninstantiated:
3580         // We don't know yet. It shouldn't matter what we pick here; no-one
3581         // should ever look at this.
3582         LLVM_FALLTHROUGH;
3583       case EST_None: case EST_MSAny: case EST_NoexceptFalse:
3584         CanonicalEPI.ExceptionSpec.Type = EST_None;
3585         break;
3586 
3587         // A dynamic exception specification is almost always "not noexcept",
3588         // with the exception that a pack expansion might expand to no types.
3589       case EST_Dynamic: {
3590         bool AnyPacks = false;
3591         for (QualType ET : EPI.ExceptionSpec.Exceptions) {
3592           if (ET->getAs<PackExpansionType>())
3593             AnyPacks = true;
3594           ExceptionTypeStorage.push_back(getCanonicalType(ET));
3595         }
3596         if (!AnyPacks)
3597           CanonicalEPI.ExceptionSpec.Type = EST_None;
3598         else {
3599           CanonicalEPI.ExceptionSpec.Type = EST_Dynamic;
3600           CanonicalEPI.ExceptionSpec.Exceptions = ExceptionTypeStorage;
3601         }
3602         break;
3603       }
3604 
3605       case EST_DynamicNone: case EST_BasicNoexcept: case EST_NoexceptTrue:
3606         CanonicalEPI.ExceptionSpec.Type = EST_BasicNoexcept;
3607         break;
3608 
3609       case EST_DependentNoexcept:
3610         llvm_unreachable("dependent noexcept is already canonical");
3611       }
3612     } else {
3613       CanonicalEPI.ExceptionSpec = FunctionProtoType::ExceptionSpecInfo();
3614     }
3615 
3616     // Adjust the canonical function result type.
3617     CanQualType CanResultTy = getCanonicalFunctionResultType(ResultTy);
3618     Canonical =
3619         getFunctionTypeInternal(CanResultTy, CanonicalArgs, CanonicalEPI, true);
3620 
3621     // Get the new insert position for the node we care about.
3622     FunctionProtoType *NewIP =
3623       FunctionProtoTypes.FindNodeOrInsertPos(ID, InsertPos);
3624     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
3625   }
3626 
3627   // FunctionProtoType objects are allocated with extra bytes after
3628   // them for three variable size arrays at the end:
3629   //  - parameter types
3630   //  - exception types
3631   //  - extended parameter information
3632   // Instead of the exception types, there could be a noexcept
3633   // expression, or information used to resolve the exception
3634   // specification.
3635   size_t Size =
3636       sizeof(FunctionProtoType) + NumArgs * sizeof(QualType) +
3637       FunctionProtoType::getExceptionSpecSize(
3638           EPI.ExceptionSpec.Type, EPI.ExceptionSpec.Exceptions.size());
3639 
3640   // Put the ExtParameterInfos last.  If all were equal, it would make
3641   // more sense to put these before the exception specification, because
3642   // it's much easier to skip past them compared to the elaborate switch
3643   // required to skip the exception specification.  However, all is not
3644   // equal; ExtParameterInfos are used to model very uncommon features,
3645   // and it's better not to burden the more common paths.
3646   if (EPI.ExtParameterInfos) {
3647     Size += NumArgs * sizeof(FunctionProtoType::ExtParameterInfo);
3648   }
3649 
3650   auto *FTP = (FunctionProtoType *) Allocate(Size, TypeAlignment);
3651   FunctionProtoType::ExtProtoInfo newEPI = EPI;
3652   new (FTP) FunctionProtoType(ResultTy, ArgArray, Canonical, newEPI);
3653   Types.push_back(FTP);
3654   if (!Unique)
3655     FunctionProtoTypes.InsertNode(FTP, InsertPos);
3656   return QualType(FTP, 0);
3657 }
3658 
3659 QualType ASTContext::getPipeType(QualType T, bool ReadOnly) const {
3660   llvm::FoldingSetNodeID ID;
3661   PipeType::Profile(ID, T, ReadOnly);
3662 
3663   void *InsertPos = nullptr;
3664   if (PipeType *PT = PipeTypes.FindNodeOrInsertPos(ID, InsertPos))
3665     return QualType(PT, 0);
3666 
3667   // If the pipe element type isn't canonical, this won't be a canonical type
3668   // either, so fill in the canonical type field.
3669   QualType Canonical;
3670   if (!T.isCanonical()) {
3671     Canonical = getPipeType(getCanonicalType(T), ReadOnly);
3672 
3673     // Get the new insert position for the node we care about.
3674     PipeType *NewIP = PipeTypes.FindNodeOrInsertPos(ID, InsertPos);
3675     assert(!NewIP && "Shouldn't be in the map!");
3676     (void)NewIP;
3677   }
3678   auto *New = new (*this, TypeAlignment) PipeType(T, Canonical, ReadOnly);
3679   Types.push_back(New);
3680   PipeTypes.InsertNode(New, InsertPos);
3681   return QualType(New, 0);
3682 }
3683 
3684 QualType ASTContext::adjustStringLiteralBaseType(QualType Ty) const {
3685   // OpenCL v1.1 s6.5.3: a string literal is in the constant address space.
3686   return LangOpts.OpenCL ? getAddrSpaceQualType(Ty, LangAS::opencl_constant)
3687                          : Ty;
3688 }
3689 
3690 QualType ASTContext::getReadPipeType(QualType T) const {
3691   return getPipeType(T, true);
3692 }
3693 
3694 QualType ASTContext::getWritePipeType(QualType T) const {
3695   return getPipeType(T, false);
3696 }
3697 
3698 #ifndef NDEBUG
3699 static bool NeedsInjectedClassNameType(const RecordDecl *D) {
3700   if (!isa<CXXRecordDecl>(D)) return false;
3701   const auto *RD = cast<CXXRecordDecl>(D);
3702   if (isa<ClassTemplatePartialSpecializationDecl>(RD))
3703     return true;
3704   if (RD->getDescribedClassTemplate() &&
3705       !isa<ClassTemplateSpecializationDecl>(RD))
3706     return true;
3707   return false;
3708 }
3709 #endif
3710 
3711 /// getInjectedClassNameType - Return the unique reference to the
3712 /// injected class name type for the specified templated declaration.
3713 QualType ASTContext::getInjectedClassNameType(CXXRecordDecl *Decl,
3714                                               QualType TST) const {
3715   assert(NeedsInjectedClassNameType(Decl));
3716   if (Decl->TypeForDecl) {
3717     assert(isa<InjectedClassNameType>(Decl->TypeForDecl));
3718   } else if (CXXRecordDecl *PrevDecl = Decl->getPreviousDecl()) {
3719     assert(PrevDecl->TypeForDecl && "previous declaration has no type");
3720     Decl->TypeForDecl = PrevDecl->TypeForDecl;
3721     assert(isa<InjectedClassNameType>(Decl->TypeForDecl));
3722   } else {
3723     Type *newType =
3724       new (*this, TypeAlignment) InjectedClassNameType(Decl, TST);
3725     Decl->TypeForDecl = newType;
3726     Types.push_back(newType);
3727   }
3728   return QualType(Decl->TypeForDecl, 0);
3729 }
3730 
3731 /// getTypeDeclType - Return the unique reference to the type for the
3732 /// specified type declaration.
3733 QualType ASTContext::getTypeDeclTypeSlow(const TypeDecl *Decl) const {
3734   assert(Decl && "Passed null for Decl param");
3735   assert(!Decl->TypeForDecl && "TypeForDecl present in slow case");
3736 
3737   if (const auto *Typedef = dyn_cast<TypedefNameDecl>(Decl))
3738     return getTypedefType(Typedef);
3739 
3740   assert(!isa<TemplateTypeParmDecl>(Decl) &&
3741          "Template type parameter types are always available.");
3742 
3743   if (const auto *Record = dyn_cast<RecordDecl>(Decl)) {
3744     assert(Record->isFirstDecl() && "struct/union has previous declaration");
3745     assert(!NeedsInjectedClassNameType(Record));
3746     return getRecordType(Record);
3747   } else if (const auto *Enum = dyn_cast<EnumDecl>(Decl)) {
3748     assert(Enum->isFirstDecl() && "enum has previous declaration");
3749     return getEnumType(Enum);
3750   } else if (const auto *Using = dyn_cast<UnresolvedUsingTypenameDecl>(Decl)) {
3751     Type *newType = new (*this, TypeAlignment) UnresolvedUsingType(Using);
3752     Decl->TypeForDecl = newType;
3753     Types.push_back(newType);
3754   } else
3755     llvm_unreachable("TypeDecl without a type?");
3756 
3757   return QualType(Decl->TypeForDecl, 0);
3758 }
3759 
3760 /// getTypedefType - Return the unique reference to the type for the
3761 /// specified typedef name decl.
3762 QualType
3763 ASTContext::getTypedefType(const TypedefNameDecl *Decl,
3764                            QualType Canonical) const {
3765   if (Decl->TypeForDecl) return QualType(Decl->TypeForDecl, 0);
3766 
3767   if (Canonical.isNull())
3768     Canonical = getCanonicalType(Decl->getUnderlyingType());
3769   auto *newType = new (*this, TypeAlignment)
3770     TypedefType(Type::Typedef, Decl, Canonical);
3771   Decl->TypeForDecl = newType;
3772   Types.push_back(newType);
3773   return QualType(newType, 0);
3774 }
3775 
3776 QualType ASTContext::getRecordType(const RecordDecl *Decl) const {
3777   if (Decl->TypeForDecl) return QualType(Decl->TypeForDecl, 0);
3778 
3779   if (const RecordDecl *PrevDecl = Decl->getPreviousDecl())
3780     if (PrevDecl->TypeForDecl)
3781       return QualType(Decl->TypeForDecl = PrevDecl->TypeForDecl, 0);
3782 
3783   auto *newType = new (*this, TypeAlignment) RecordType(Decl);
3784   Decl->TypeForDecl = newType;
3785   Types.push_back(newType);
3786   return QualType(newType, 0);
3787 }
3788 
3789 QualType ASTContext::getEnumType(const EnumDecl *Decl) const {
3790   if (Decl->TypeForDecl) return QualType(Decl->TypeForDecl, 0);
3791 
3792   if (const EnumDecl *PrevDecl = Decl->getPreviousDecl())
3793     if (PrevDecl->TypeForDecl)
3794       return QualType(Decl->TypeForDecl = PrevDecl->TypeForDecl, 0);
3795 
3796   auto *newType = new (*this, TypeAlignment) EnumType(Decl);
3797   Decl->TypeForDecl = newType;
3798   Types.push_back(newType);
3799   return QualType(newType, 0);
3800 }
3801 
3802 QualType ASTContext::getAttributedType(AttributedType::Kind attrKind,
3803                                        QualType modifiedType,
3804                                        QualType equivalentType) {
3805   llvm::FoldingSetNodeID id;
3806   AttributedType::Profile(id, attrKind, modifiedType, equivalentType);
3807 
3808   void *insertPos = nullptr;
3809   AttributedType *type = AttributedTypes.FindNodeOrInsertPos(id, insertPos);
3810   if (type) return QualType(type, 0);
3811 
3812   QualType canon = getCanonicalType(equivalentType);
3813   type = new (*this, TypeAlignment)
3814            AttributedType(canon, attrKind, modifiedType, equivalentType);
3815 
3816   Types.push_back(type);
3817   AttributedTypes.InsertNode(type, insertPos);
3818 
3819   return QualType(type, 0);
3820 }
3821 
3822 /// Retrieve a substitution-result type.
3823 QualType
3824 ASTContext::getSubstTemplateTypeParmType(const TemplateTypeParmType *Parm,
3825                                          QualType Replacement) const {
3826   assert(Replacement.isCanonical()
3827          && "replacement types must always be canonical");
3828 
3829   llvm::FoldingSetNodeID ID;
3830   SubstTemplateTypeParmType::Profile(ID, Parm, Replacement);
3831   void *InsertPos = nullptr;
3832   SubstTemplateTypeParmType *SubstParm
3833     = SubstTemplateTypeParmTypes.FindNodeOrInsertPos(ID, InsertPos);
3834 
3835   if (!SubstParm) {
3836     SubstParm = new (*this, TypeAlignment)
3837       SubstTemplateTypeParmType(Parm, Replacement);
3838     Types.push_back(SubstParm);
3839     SubstTemplateTypeParmTypes.InsertNode(SubstParm, InsertPos);
3840   }
3841 
3842   return QualType(SubstParm, 0);
3843 }
3844 
3845 /// Retrieve a
3846 QualType ASTContext::getSubstTemplateTypeParmPackType(
3847                                           const TemplateTypeParmType *Parm,
3848                                               const TemplateArgument &ArgPack) {
3849 #ifndef NDEBUG
3850   for (const auto &P : ArgPack.pack_elements()) {
3851     assert(P.getKind() == TemplateArgument::Type &&"Pack contains a non-type");
3852     assert(P.getAsType().isCanonical() && "Pack contains non-canonical type");
3853   }
3854 #endif
3855 
3856   llvm::FoldingSetNodeID ID;
3857   SubstTemplateTypeParmPackType::Profile(ID, Parm, ArgPack);
3858   void *InsertPos = nullptr;
3859   if (SubstTemplateTypeParmPackType *SubstParm
3860         = SubstTemplateTypeParmPackTypes.FindNodeOrInsertPos(ID, InsertPos))
3861     return QualType(SubstParm, 0);
3862 
3863   QualType Canon;
3864   if (!Parm->isCanonicalUnqualified()) {
3865     Canon = getCanonicalType(QualType(Parm, 0));
3866     Canon = getSubstTemplateTypeParmPackType(cast<TemplateTypeParmType>(Canon),
3867                                              ArgPack);
3868     SubstTemplateTypeParmPackTypes.FindNodeOrInsertPos(ID, InsertPos);
3869   }
3870 
3871   auto *SubstParm
3872     = new (*this, TypeAlignment) SubstTemplateTypeParmPackType(Parm, Canon,
3873                                                                ArgPack);
3874   Types.push_back(SubstParm);
3875   SubstTemplateTypeParmPackTypes.InsertNode(SubstParm, InsertPos);
3876   return QualType(SubstParm, 0);
3877 }
3878 
3879 /// Retrieve the template type parameter type for a template
3880 /// parameter or parameter pack with the given depth, index, and (optionally)
3881 /// name.
3882 QualType ASTContext::getTemplateTypeParmType(unsigned Depth, unsigned Index,
3883                                              bool ParameterPack,
3884                                              TemplateTypeParmDecl *TTPDecl) const {
3885   llvm::FoldingSetNodeID ID;
3886   TemplateTypeParmType::Profile(ID, Depth, Index, ParameterPack, TTPDecl);
3887   void *InsertPos = nullptr;
3888   TemplateTypeParmType *TypeParm
3889     = TemplateTypeParmTypes.FindNodeOrInsertPos(ID, InsertPos);
3890 
3891   if (TypeParm)
3892     return QualType(TypeParm, 0);
3893 
3894   if (TTPDecl) {
3895     QualType Canon = getTemplateTypeParmType(Depth, Index, ParameterPack);
3896     TypeParm = new (*this, TypeAlignment) TemplateTypeParmType(TTPDecl, Canon);
3897 
3898     TemplateTypeParmType *TypeCheck
3899       = TemplateTypeParmTypes.FindNodeOrInsertPos(ID, InsertPos);
3900     assert(!TypeCheck && "Template type parameter canonical type broken");
3901     (void)TypeCheck;
3902   } else
3903     TypeParm = new (*this, TypeAlignment)
3904       TemplateTypeParmType(Depth, Index, ParameterPack);
3905 
3906   Types.push_back(TypeParm);
3907   TemplateTypeParmTypes.InsertNode(TypeParm, InsertPos);
3908 
3909   return QualType(TypeParm, 0);
3910 }
3911 
3912 TypeSourceInfo *
3913 ASTContext::getTemplateSpecializationTypeInfo(TemplateName Name,
3914                                               SourceLocation NameLoc,
3915                                         const TemplateArgumentListInfo &Args,
3916                                               QualType Underlying) const {
3917   assert(!Name.getAsDependentTemplateName() &&
3918          "No dependent template names here!");
3919   QualType TST = getTemplateSpecializationType(Name, Args, Underlying);
3920 
3921   TypeSourceInfo *DI = CreateTypeSourceInfo(TST);
3922   TemplateSpecializationTypeLoc TL =
3923       DI->getTypeLoc().castAs<TemplateSpecializationTypeLoc>();
3924   TL.setTemplateKeywordLoc(SourceLocation());
3925   TL.setTemplateNameLoc(NameLoc);
3926   TL.setLAngleLoc(Args.getLAngleLoc());
3927   TL.setRAngleLoc(Args.getRAngleLoc());
3928   for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
3929     TL.setArgLocInfo(i, Args[i].getLocInfo());
3930   return DI;
3931 }
3932 
3933 QualType
3934 ASTContext::getTemplateSpecializationType(TemplateName Template,
3935                                           const TemplateArgumentListInfo &Args,
3936                                           QualType Underlying) const {
3937   assert(!Template.getAsDependentTemplateName() &&
3938          "No dependent template names here!");
3939 
3940   SmallVector<TemplateArgument, 4> ArgVec;
3941   ArgVec.reserve(Args.size());
3942   for (const TemplateArgumentLoc &Arg : Args.arguments())
3943     ArgVec.push_back(Arg.getArgument());
3944 
3945   return getTemplateSpecializationType(Template, ArgVec, Underlying);
3946 }
3947 
3948 #ifndef NDEBUG
3949 static bool hasAnyPackExpansions(ArrayRef<TemplateArgument> Args) {
3950   for (const TemplateArgument &Arg : Args)
3951     if (Arg.isPackExpansion())
3952       return true;
3953 
3954   return true;
3955 }
3956 #endif
3957 
3958 QualType
3959 ASTContext::getTemplateSpecializationType(TemplateName Template,
3960                                           ArrayRef<TemplateArgument> Args,
3961                                           QualType Underlying) const {
3962   assert(!Template.getAsDependentTemplateName() &&
3963          "No dependent template names here!");
3964   // Look through qualified template names.
3965   if (QualifiedTemplateName *QTN = Template.getAsQualifiedTemplateName())
3966     Template = TemplateName(QTN->getTemplateDecl());
3967 
3968   bool IsTypeAlias =
3969     Template.getAsTemplateDecl() &&
3970     isa<TypeAliasTemplateDecl>(Template.getAsTemplateDecl());
3971   QualType CanonType;
3972   if (!Underlying.isNull())
3973     CanonType = getCanonicalType(Underlying);
3974   else {
3975     // We can get here with an alias template when the specialization contains
3976     // a pack expansion that does not match up with a parameter pack.
3977     assert((!IsTypeAlias || hasAnyPackExpansions(Args)) &&
3978            "Caller must compute aliased type");
3979     IsTypeAlias = false;
3980     CanonType = getCanonicalTemplateSpecializationType(Template, Args);
3981   }
3982 
3983   // Allocate the (non-canonical) template specialization type, but don't
3984   // try to unique it: these types typically have location information that
3985   // we don't unique and don't want to lose.
3986   void *Mem = Allocate(sizeof(TemplateSpecializationType) +
3987                        sizeof(TemplateArgument) * Args.size() +
3988                        (IsTypeAlias? sizeof(QualType) : 0),
3989                        TypeAlignment);
3990   auto *Spec
3991     = new (Mem) TemplateSpecializationType(Template, Args, CanonType,
3992                                          IsTypeAlias ? Underlying : QualType());
3993 
3994   Types.push_back(Spec);
3995   return QualType(Spec, 0);
3996 }
3997 
3998 QualType ASTContext::getCanonicalTemplateSpecializationType(
3999     TemplateName Template, ArrayRef<TemplateArgument> Args) const {
4000   assert(!Template.getAsDependentTemplateName() &&
4001          "No dependent template names here!");
4002 
4003   // Look through qualified template names.
4004   if (QualifiedTemplateName *QTN = Template.getAsQualifiedTemplateName())
4005     Template = TemplateName(QTN->getTemplateDecl());
4006 
4007   // Build the canonical template specialization type.
4008   TemplateName CanonTemplate = getCanonicalTemplateName(Template);
4009   SmallVector<TemplateArgument, 4> CanonArgs;
4010   unsigned NumArgs = Args.size();
4011   CanonArgs.reserve(NumArgs);
4012   for (const TemplateArgument &Arg : Args)
4013     CanonArgs.push_back(getCanonicalTemplateArgument(Arg));
4014 
4015   // Determine whether this canonical template specialization type already
4016   // exists.
4017   llvm::FoldingSetNodeID ID;
4018   TemplateSpecializationType::Profile(ID, CanonTemplate,
4019                                       CanonArgs, *this);
4020 
4021   void *InsertPos = nullptr;
4022   TemplateSpecializationType *Spec
4023     = TemplateSpecializationTypes.FindNodeOrInsertPos(ID, InsertPos);
4024 
4025   if (!Spec) {
4026     // Allocate a new canonical template specialization type.
4027     void *Mem = Allocate((sizeof(TemplateSpecializationType) +
4028                           sizeof(TemplateArgument) * NumArgs),
4029                          TypeAlignment);
4030     Spec = new (Mem) TemplateSpecializationType(CanonTemplate,
4031                                                 CanonArgs,
4032                                                 QualType(), QualType());
4033     Types.push_back(Spec);
4034     TemplateSpecializationTypes.InsertNode(Spec, InsertPos);
4035   }
4036 
4037   assert(Spec->isDependentType() &&
4038          "Non-dependent template-id type must have a canonical type");
4039   return QualType(Spec, 0);
4040 }
4041 
4042 QualType ASTContext::getElaboratedType(ElaboratedTypeKeyword Keyword,
4043                                        NestedNameSpecifier *NNS,
4044                                        QualType NamedType,
4045                                        TagDecl *OwnedTagDecl) const {
4046   llvm::FoldingSetNodeID ID;
4047   ElaboratedType::Profile(ID, Keyword, NNS, NamedType, OwnedTagDecl);
4048 
4049   void *InsertPos = nullptr;
4050   ElaboratedType *T = ElaboratedTypes.FindNodeOrInsertPos(ID, InsertPos);
4051   if (T)
4052     return QualType(T, 0);
4053 
4054   QualType Canon = NamedType;
4055   if (!Canon.isCanonical()) {
4056     Canon = getCanonicalType(NamedType);
4057     ElaboratedType *CheckT = ElaboratedTypes.FindNodeOrInsertPos(ID, InsertPos);
4058     assert(!CheckT && "Elaborated canonical type broken");
4059     (void)CheckT;
4060   }
4061 
4062   T = new (*this, TypeAlignment)
4063       ElaboratedType(Keyword, NNS, NamedType, Canon, OwnedTagDecl);
4064   Types.push_back(T);
4065   ElaboratedTypes.InsertNode(T, InsertPos);
4066   return QualType(T, 0);
4067 }
4068 
4069 QualType
4070 ASTContext::getParenType(QualType InnerType) const {
4071   llvm::FoldingSetNodeID ID;
4072   ParenType::Profile(ID, InnerType);
4073 
4074   void *InsertPos = nullptr;
4075   ParenType *T = ParenTypes.FindNodeOrInsertPos(ID, InsertPos);
4076   if (T)
4077     return QualType(T, 0);
4078 
4079   QualType Canon = InnerType;
4080   if (!Canon.isCanonical()) {
4081     Canon = getCanonicalType(InnerType);
4082     ParenType *CheckT = ParenTypes.FindNodeOrInsertPos(ID, InsertPos);
4083     assert(!CheckT && "Paren canonical type broken");
4084     (void)CheckT;
4085   }
4086 
4087   T = new (*this, TypeAlignment) ParenType(InnerType, Canon);
4088   Types.push_back(T);
4089   ParenTypes.InsertNode(T, InsertPos);
4090   return QualType(T, 0);
4091 }
4092 
4093 QualType ASTContext::getDependentNameType(ElaboratedTypeKeyword Keyword,
4094                                           NestedNameSpecifier *NNS,
4095                                           const IdentifierInfo *Name,
4096                                           QualType Canon) const {
4097   if (Canon.isNull()) {
4098     NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
4099     if (CanonNNS != NNS)
4100       Canon = getDependentNameType(Keyword, CanonNNS, Name);
4101   }
4102 
4103   llvm::FoldingSetNodeID ID;
4104   DependentNameType::Profile(ID, Keyword, NNS, Name);
4105 
4106   void *InsertPos = nullptr;
4107   DependentNameType *T
4108     = DependentNameTypes.FindNodeOrInsertPos(ID, InsertPos);
4109   if (T)
4110     return QualType(T, 0);
4111 
4112   T = new (*this, TypeAlignment) DependentNameType(Keyword, NNS, Name, Canon);
4113   Types.push_back(T);
4114   DependentNameTypes.InsertNode(T, InsertPos);
4115   return QualType(T, 0);
4116 }
4117 
4118 QualType
4119 ASTContext::getDependentTemplateSpecializationType(
4120                                  ElaboratedTypeKeyword Keyword,
4121                                  NestedNameSpecifier *NNS,
4122                                  const IdentifierInfo *Name,
4123                                  const TemplateArgumentListInfo &Args) const {
4124   // TODO: avoid this copy
4125   SmallVector<TemplateArgument, 16> ArgCopy;
4126   for (unsigned I = 0, E = Args.size(); I != E; ++I)
4127     ArgCopy.push_back(Args[I].getArgument());
4128   return getDependentTemplateSpecializationType(Keyword, NNS, Name, ArgCopy);
4129 }
4130 
4131 QualType
4132 ASTContext::getDependentTemplateSpecializationType(
4133                                  ElaboratedTypeKeyword Keyword,
4134                                  NestedNameSpecifier *NNS,
4135                                  const IdentifierInfo *Name,
4136                                  ArrayRef<TemplateArgument> Args) const {
4137   assert((!NNS || NNS->isDependent()) &&
4138          "nested-name-specifier must be dependent");
4139 
4140   llvm::FoldingSetNodeID ID;
4141   DependentTemplateSpecializationType::Profile(ID, *this, Keyword, NNS,
4142                                                Name, Args);
4143 
4144   void *InsertPos = nullptr;
4145   DependentTemplateSpecializationType *T
4146     = DependentTemplateSpecializationTypes.FindNodeOrInsertPos(ID, InsertPos);
4147   if (T)
4148     return QualType(T, 0);
4149 
4150   NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
4151 
4152   ElaboratedTypeKeyword CanonKeyword = Keyword;
4153   if (Keyword == ETK_None) CanonKeyword = ETK_Typename;
4154 
4155   bool AnyNonCanonArgs = false;
4156   unsigned NumArgs = Args.size();
4157   SmallVector<TemplateArgument, 16> CanonArgs(NumArgs);
4158   for (unsigned I = 0; I != NumArgs; ++I) {
4159     CanonArgs[I] = getCanonicalTemplateArgument(Args[I]);
4160     if (!CanonArgs[I].structurallyEquals(Args[I]))
4161       AnyNonCanonArgs = true;
4162   }
4163 
4164   QualType Canon;
4165   if (AnyNonCanonArgs || CanonNNS != NNS || CanonKeyword != Keyword) {
4166     Canon = getDependentTemplateSpecializationType(CanonKeyword, CanonNNS,
4167                                                    Name,
4168                                                    CanonArgs);
4169 
4170     // Find the insert position again.
4171     DependentTemplateSpecializationTypes.FindNodeOrInsertPos(ID, InsertPos);
4172   }
4173 
4174   void *Mem = Allocate((sizeof(DependentTemplateSpecializationType) +
4175                         sizeof(TemplateArgument) * NumArgs),
4176                        TypeAlignment);
4177   T = new (Mem) DependentTemplateSpecializationType(Keyword, NNS,
4178                                                     Name, Args, Canon);
4179   Types.push_back(T);
4180   DependentTemplateSpecializationTypes.InsertNode(T, InsertPos);
4181   return QualType(T, 0);
4182 }
4183 
4184 TemplateArgument ASTContext::getInjectedTemplateArg(NamedDecl *Param) {
4185   TemplateArgument Arg;
4186   if (const auto *TTP = dyn_cast<TemplateTypeParmDecl>(Param)) {
4187     QualType ArgType = getTypeDeclType(TTP);
4188     if (TTP->isParameterPack())
4189       ArgType = getPackExpansionType(ArgType, None);
4190 
4191     Arg = TemplateArgument(ArgType);
4192   } else if (auto *NTTP = dyn_cast<NonTypeTemplateParmDecl>(Param)) {
4193     Expr *E = new (*this) DeclRefExpr(
4194         NTTP, /*enclosing*/false,
4195         NTTP->getType().getNonLValueExprType(*this),
4196         Expr::getValueKindForType(NTTP->getType()), NTTP->getLocation());
4197 
4198     if (NTTP->isParameterPack())
4199       E = new (*this) PackExpansionExpr(DependentTy, E, NTTP->getLocation(),
4200                                         None);
4201     Arg = TemplateArgument(E);
4202   } else {
4203     auto *TTP = cast<TemplateTemplateParmDecl>(Param);
4204     if (TTP->isParameterPack())
4205       Arg = TemplateArgument(TemplateName(TTP), Optional<unsigned>());
4206     else
4207       Arg = TemplateArgument(TemplateName(TTP));
4208   }
4209 
4210   if (Param->isTemplateParameterPack())
4211     Arg = TemplateArgument::CreatePackCopy(*this, Arg);
4212 
4213   return Arg;
4214 }
4215 
4216 void
4217 ASTContext::getInjectedTemplateArgs(const TemplateParameterList *Params,
4218                                     SmallVectorImpl<TemplateArgument> &Args) {
4219   Args.reserve(Args.size() + Params->size());
4220 
4221   for (NamedDecl *Param : *Params)
4222     Args.push_back(getInjectedTemplateArg(Param));
4223 }
4224 
4225 QualType ASTContext::getPackExpansionType(QualType Pattern,
4226                                           Optional<unsigned> NumExpansions) {
4227   llvm::FoldingSetNodeID ID;
4228   PackExpansionType::Profile(ID, Pattern, NumExpansions);
4229 
4230   assert(Pattern->containsUnexpandedParameterPack() &&
4231          "Pack expansions must expand one or more parameter packs");
4232   void *InsertPos = nullptr;
4233   PackExpansionType *T
4234     = PackExpansionTypes.FindNodeOrInsertPos(ID, InsertPos);
4235   if (T)
4236     return QualType(T, 0);
4237 
4238   QualType Canon;
4239   if (!Pattern.isCanonical()) {
4240     Canon = getCanonicalType(Pattern);
4241     // The canonical type might not contain an unexpanded parameter pack, if it
4242     // contains an alias template specialization which ignores one of its
4243     // parameters.
4244     if (Canon->containsUnexpandedParameterPack()) {
4245       Canon = getPackExpansionType(Canon, NumExpansions);
4246 
4247       // Find the insert position again, in case we inserted an element into
4248       // PackExpansionTypes and invalidated our insert position.
4249       PackExpansionTypes.FindNodeOrInsertPos(ID, InsertPos);
4250     }
4251   }
4252 
4253   T = new (*this, TypeAlignment)
4254       PackExpansionType(Pattern, Canon, NumExpansions);
4255   Types.push_back(T);
4256   PackExpansionTypes.InsertNode(T, InsertPos);
4257   return QualType(T, 0);
4258 }
4259 
4260 /// CmpProtocolNames - Comparison predicate for sorting protocols
4261 /// alphabetically.
4262 static int CmpProtocolNames(ObjCProtocolDecl *const *LHS,
4263                             ObjCProtocolDecl *const *RHS) {
4264   return DeclarationName::compare((*LHS)->getDeclName(), (*RHS)->getDeclName());
4265 }
4266 
4267 static bool areSortedAndUniqued(ArrayRef<ObjCProtocolDecl *> Protocols) {
4268   if (Protocols.empty()) return true;
4269 
4270   if (Protocols[0]->getCanonicalDecl() != Protocols[0])
4271     return false;
4272 
4273   for (unsigned i = 1; i != Protocols.size(); ++i)
4274     if (CmpProtocolNames(&Protocols[i - 1], &Protocols[i]) >= 0 ||
4275         Protocols[i]->getCanonicalDecl() != Protocols[i])
4276       return false;
4277   return true;
4278 }
4279 
4280 static void
4281 SortAndUniqueProtocols(SmallVectorImpl<ObjCProtocolDecl *> &Protocols) {
4282   // Sort protocols, keyed by name.
4283   llvm::array_pod_sort(Protocols.begin(), Protocols.end(), CmpProtocolNames);
4284 
4285   // Canonicalize.
4286   for (ObjCProtocolDecl *&P : Protocols)
4287     P = P->getCanonicalDecl();
4288 
4289   // Remove duplicates.
4290   auto ProtocolsEnd = std::unique(Protocols.begin(), Protocols.end());
4291   Protocols.erase(ProtocolsEnd, Protocols.end());
4292 }
4293 
4294 QualType ASTContext::getObjCObjectType(QualType BaseType,
4295                                        ObjCProtocolDecl * const *Protocols,
4296                                        unsigned NumProtocols) const {
4297   return getObjCObjectType(BaseType, {},
4298                            llvm::makeArrayRef(Protocols, NumProtocols),
4299                            /*isKindOf=*/false);
4300 }
4301 
4302 QualType ASTContext::getObjCObjectType(
4303            QualType baseType,
4304            ArrayRef<QualType> typeArgs,
4305            ArrayRef<ObjCProtocolDecl *> protocols,
4306            bool isKindOf) const {
4307   // If the base type is an interface and there aren't any protocols or
4308   // type arguments to add, then the interface type will do just fine.
4309   if (typeArgs.empty() && protocols.empty() && !isKindOf &&
4310       isa<ObjCInterfaceType>(baseType))
4311     return baseType;
4312 
4313   // Look in the folding set for an existing type.
4314   llvm::FoldingSetNodeID ID;
4315   ObjCObjectTypeImpl::Profile(ID, baseType, typeArgs, protocols, isKindOf);
4316   void *InsertPos = nullptr;
4317   if (ObjCObjectType *QT = ObjCObjectTypes.FindNodeOrInsertPos(ID, InsertPos))
4318     return QualType(QT, 0);
4319 
4320   // Determine the type arguments to be used for canonicalization,
4321   // which may be explicitly specified here or written on the base
4322   // type.
4323   ArrayRef<QualType> effectiveTypeArgs = typeArgs;
4324   if (effectiveTypeArgs.empty()) {
4325     if (const auto *baseObject = baseType->getAs<ObjCObjectType>())
4326       effectiveTypeArgs = baseObject->getTypeArgs();
4327   }
4328 
4329   // Build the canonical type, which has the canonical base type and a
4330   // sorted-and-uniqued list of protocols and the type arguments
4331   // canonicalized.
4332   QualType canonical;
4333   bool typeArgsAreCanonical = std::all_of(effectiveTypeArgs.begin(),
4334                                           effectiveTypeArgs.end(),
4335                                           [&](QualType type) {
4336                                             return type.isCanonical();
4337                                           });
4338   bool protocolsSorted = areSortedAndUniqued(protocols);
4339   if (!typeArgsAreCanonical || !protocolsSorted || !baseType.isCanonical()) {
4340     // Determine the canonical type arguments.
4341     ArrayRef<QualType> canonTypeArgs;
4342     SmallVector<QualType, 4> canonTypeArgsVec;
4343     if (!typeArgsAreCanonical) {
4344       canonTypeArgsVec.reserve(effectiveTypeArgs.size());
4345       for (auto typeArg : effectiveTypeArgs)
4346         canonTypeArgsVec.push_back(getCanonicalType(typeArg));
4347       canonTypeArgs = canonTypeArgsVec;
4348     } else {
4349       canonTypeArgs = effectiveTypeArgs;
4350     }
4351 
4352     ArrayRef<ObjCProtocolDecl *> canonProtocols;
4353     SmallVector<ObjCProtocolDecl*, 8> canonProtocolsVec;
4354     if (!protocolsSorted) {
4355       canonProtocolsVec.append(protocols.begin(), protocols.end());
4356       SortAndUniqueProtocols(canonProtocolsVec);
4357       canonProtocols = canonProtocolsVec;
4358     } else {
4359       canonProtocols = protocols;
4360     }
4361 
4362     canonical = getObjCObjectType(getCanonicalType(baseType), canonTypeArgs,
4363                                   canonProtocols, isKindOf);
4364 
4365     // Regenerate InsertPos.
4366     ObjCObjectTypes.FindNodeOrInsertPos(ID, InsertPos);
4367   }
4368 
4369   unsigned size = sizeof(ObjCObjectTypeImpl);
4370   size += typeArgs.size() * sizeof(QualType);
4371   size += protocols.size() * sizeof(ObjCProtocolDecl *);
4372   void *mem = Allocate(size, TypeAlignment);
4373   auto *T =
4374     new (mem) ObjCObjectTypeImpl(canonical, baseType, typeArgs, protocols,
4375                                  isKindOf);
4376 
4377   Types.push_back(T);
4378   ObjCObjectTypes.InsertNode(T, InsertPos);
4379   return QualType(T, 0);
4380 }
4381 
4382 /// Apply Objective-C protocol qualifiers to the given type.
4383 /// If this is for the canonical type of a type parameter, we can apply
4384 /// protocol qualifiers on the ObjCObjectPointerType.
4385 QualType
4386 ASTContext::applyObjCProtocolQualifiers(QualType type,
4387                   ArrayRef<ObjCProtocolDecl *> protocols, bool &hasError,
4388                   bool allowOnPointerType) const {
4389   hasError = false;
4390 
4391   if (const auto *objT = dyn_cast<ObjCTypeParamType>(type.getTypePtr())) {
4392     return getObjCTypeParamType(objT->getDecl(), protocols);
4393   }
4394 
4395   // Apply protocol qualifiers to ObjCObjectPointerType.
4396   if (allowOnPointerType) {
4397     if (const auto *objPtr =
4398             dyn_cast<ObjCObjectPointerType>(type.getTypePtr())) {
4399       const ObjCObjectType *objT = objPtr->getObjectType();
4400       // Merge protocol lists and construct ObjCObjectType.
4401       SmallVector<ObjCProtocolDecl*, 8> protocolsVec;
4402       protocolsVec.append(objT->qual_begin(),
4403                           objT->qual_end());
4404       protocolsVec.append(protocols.begin(), protocols.end());
4405       ArrayRef<ObjCProtocolDecl *> protocols = protocolsVec;
4406       type = getObjCObjectType(
4407              objT->getBaseType(),
4408              objT->getTypeArgsAsWritten(),
4409              protocols,
4410              objT->isKindOfTypeAsWritten());
4411       return getObjCObjectPointerType(type);
4412     }
4413   }
4414 
4415   // Apply protocol qualifiers to ObjCObjectType.
4416   if (const auto *objT = dyn_cast<ObjCObjectType>(type.getTypePtr())){
4417     // FIXME: Check for protocols to which the class type is already
4418     // known to conform.
4419 
4420     return getObjCObjectType(objT->getBaseType(),
4421                              objT->getTypeArgsAsWritten(),
4422                              protocols,
4423                              objT->isKindOfTypeAsWritten());
4424   }
4425 
4426   // If the canonical type is ObjCObjectType, ...
4427   if (type->isObjCObjectType()) {
4428     // Silently overwrite any existing protocol qualifiers.
4429     // TODO: determine whether that's the right thing to do.
4430 
4431     // FIXME: Check for protocols to which the class type is already
4432     // known to conform.
4433     return getObjCObjectType(type, {}, protocols, false);
4434   }
4435 
4436   // id<protocol-list>
4437   if (type->isObjCIdType()) {
4438     const auto *objPtr = type->castAs<ObjCObjectPointerType>();
4439     type = getObjCObjectType(ObjCBuiltinIdTy, {}, protocols,
4440                                  objPtr->isKindOfType());
4441     return getObjCObjectPointerType(type);
4442   }
4443 
4444   // Class<protocol-list>
4445   if (type->isObjCClassType()) {
4446     const auto *objPtr = type->castAs<ObjCObjectPointerType>();
4447     type = getObjCObjectType(ObjCBuiltinClassTy, {}, protocols,
4448                                  objPtr->isKindOfType());
4449     return getObjCObjectPointerType(type);
4450   }
4451 
4452   hasError = true;
4453   return type;
4454 }
4455 
4456 QualType
4457 ASTContext::getObjCTypeParamType(const ObjCTypeParamDecl *Decl,
4458                            ArrayRef<ObjCProtocolDecl *> protocols,
4459                            QualType Canonical) const {
4460   // Look in the folding set for an existing type.
4461   llvm::FoldingSetNodeID ID;
4462   ObjCTypeParamType::Profile(ID, Decl, protocols);
4463   void *InsertPos = nullptr;
4464   if (ObjCTypeParamType *TypeParam =
4465       ObjCTypeParamTypes.FindNodeOrInsertPos(ID, InsertPos))
4466     return QualType(TypeParam, 0);
4467 
4468   if (Canonical.isNull()) {
4469     // We canonicalize to the underlying type.
4470     Canonical = getCanonicalType(Decl->getUnderlyingType());
4471     if (!protocols.empty()) {
4472       // Apply the protocol qualifers.
4473       bool hasError;
4474       Canonical = applyObjCProtocolQualifiers(Canonical, protocols, hasError,
4475           true/*allowOnPointerType*/);
4476       assert(!hasError && "Error when apply protocol qualifier to bound type");
4477     }
4478   }
4479 
4480   unsigned size = sizeof(ObjCTypeParamType);
4481   size += protocols.size() * sizeof(ObjCProtocolDecl *);
4482   void *mem = Allocate(size, TypeAlignment);
4483   auto *newType = new (mem) ObjCTypeParamType(Decl, Canonical, protocols);
4484 
4485   Types.push_back(newType);
4486   ObjCTypeParamTypes.InsertNode(newType, InsertPos);
4487   return QualType(newType, 0);
4488 }
4489 
4490 /// ObjCObjectAdoptsQTypeProtocols - Checks that protocols in IC's
4491 /// protocol list adopt all protocols in QT's qualified-id protocol
4492 /// list.
4493 bool ASTContext::ObjCObjectAdoptsQTypeProtocols(QualType QT,
4494                                                 ObjCInterfaceDecl *IC) {
4495   if (!QT->isObjCQualifiedIdType())
4496     return false;
4497 
4498   if (const auto *OPT = QT->getAs<ObjCObjectPointerType>()) {
4499     // If both the right and left sides have qualifiers.
4500     for (auto *Proto : OPT->quals()) {
4501       if (!IC->ClassImplementsProtocol(Proto, false))
4502         return false;
4503     }
4504     return true;
4505   }
4506   return false;
4507 }
4508 
4509 /// QIdProtocolsAdoptObjCObjectProtocols - Checks that protocols in
4510 /// QT's qualified-id protocol list adopt all protocols in IDecl's list
4511 /// of protocols.
4512 bool ASTContext::QIdProtocolsAdoptObjCObjectProtocols(QualType QT,
4513                                                 ObjCInterfaceDecl *IDecl) {
4514   if (!QT->isObjCQualifiedIdType())
4515     return false;
4516   const auto *OPT = QT->getAs<ObjCObjectPointerType>();
4517   if (!OPT)
4518     return false;
4519   if (!IDecl->hasDefinition())
4520     return false;
4521   llvm::SmallPtrSet<ObjCProtocolDecl *, 8> InheritedProtocols;
4522   CollectInheritedProtocols(IDecl, InheritedProtocols);
4523   if (InheritedProtocols.empty())
4524     return false;
4525   // Check that if every protocol in list of id<plist> conforms to a protocol
4526   // of IDecl's, then bridge casting is ok.
4527   bool Conforms = false;
4528   for (auto *Proto : OPT->quals()) {
4529     Conforms = false;
4530     for (auto *PI : InheritedProtocols) {
4531       if (ProtocolCompatibleWithProtocol(Proto, PI)) {
4532         Conforms = true;
4533         break;
4534       }
4535     }
4536     if (!Conforms)
4537       break;
4538   }
4539   if (Conforms)
4540     return true;
4541 
4542   for (auto *PI : InheritedProtocols) {
4543     // If both the right and left sides have qualifiers.
4544     bool Adopts = false;
4545     for (auto *Proto : OPT->quals()) {
4546       // return 'true' if 'PI' is in the inheritance hierarchy of Proto
4547       if ((Adopts = ProtocolCompatibleWithProtocol(PI, Proto)))
4548         break;
4549     }
4550     if (!Adopts)
4551       return false;
4552   }
4553   return true;
4554 }
4555 
4556 /// getObjCObjectPointerType - Return a ObjCObjectPointerType type for
4557 /// the given object type.
4558 QualType ASTContext::getObjCObjectPointerType(QualType ObjectT) const {
4559   llvm::FoldingSetNodeID ID;
4560   ObjCObjectPointerType::Profile(ID, ObjectT);
4561 
4562   void *InsertPos = nullptr;
4563   if (ObjCObjectPointerType *QT =
4564               ObjCObjectPointerTypes.FindNodeOrInsertPos(ID, InsertPos))
4565     return QualType(QT, 0);
4566 
4567   // Find the canonical object type.
4568   QualType Canonical;
4569   if (!ObjectT.isCanonical()) {
4570     Canonical = getObjCObjectPointerType(getCanonicalType(ObjectT));
4571 
4572     // Regenerate InsertPos.
4573     ObjCObjectPointerTypes.FindNodeOrInsertPos(ID, InsertPos);
4574   }
4575 
4576   // No match.
4577   void *Mem = Allocate(sizeof(ObjCObjectPointerType), TypeAlignment);
4578   auto *QType =
4579     new (Mem) ObjCObjectPointerType(Canonical, ObjectT);
4580 
4581   Types.push_back(QType);
4582   ObjCObjectPointerTypes.InsertNode(QType, InsertPos);
4583   return QualType(QType, 0);
4584 }
4585 
4586 /// getObjCInterfaceType - Return the unique reference to the type for the
4587 /// specified ObjC interface decl. The list of protocols is optional.
4588 QualType ASTContext::getObjCInterfaceType(const ObjCInterfaceDecl *Decl,
4589                                           ObjCInterfaceDecl *PrevDecl) const {
4590   if (Decl->TypeForDecl)
4591     return QualType(Decl->TypeForDecl, 0);
4592 
4593   if (PrevDecl) {
4594     assert(PrevDecl->TypeForDecl && "previous decl has no TypeForDecl");
4595     Decl->TypeForDecl = PrevDecl->TypeForDecl;
4596     return QualType(PrevDecl->TypeForDecl, 0);
4597   }
4598 
4599   // Prefer the definition, if there is one.
4600   if (const ObjCInterfaceDecl *Def = Decl->getDefinition())
4601     Decl = Def;
4602 
4603   void *Mem = Allocate(sizeof(ObjCInterfaceType), TypeAlignment);
4604   auto *T = new (Mem) ObjCInterfaceType(Decl);
4605   Decl->TypeForDecl = T;
4606   Types.push_back(T);
4607   return QualType(T, 0);
4608 }
4609 
4610 /// getTypeOfExprType - Unlike many "get<Type>" functions, we can't unique
4611 /// TypeOfExprType AST's (since expression's are never shared). For example,
4612 /// multiple declarations that refer to "typeof(x)" all contain different
4613 /// DeclRefExpr's. This doesn't effect the type checker, since it operates
4614 /// on canonical type's (which are always unique).
4615 QualType ASTContext::getTypeOfExprType(Expr *tofExpr) const {
4616   TypeOfExprType *toe;
4617   if (tofExpr->isTypeDependent()) {
4618     llvm::FoldingSetNodeID ID;
4619     DependentTypeOfExprType::Profile(ID, *this, tofExpr);
4620 
4621     void *InsertPos = nullptr;
4622     DependentTypeOfExprType *Canon
4623       = DependentTypeOfExprTypes.FindNodeOrInsertPos(ID, InsertPos);
4624     if (Canon) {
4625       // We already have a "canonical" version of an identical, dependent
4626       // typeof(expr) type. Use that as our canonical type.
4627       toe = new (*this, TypeAlignment) TypeOfExprType(tofExpr,
4628                                           QualType((TypeOfExprType*)Canon, 0));
4629     } else {
4630       // Build a new, canonical typeof(expr) type.
4631       Canon
4632         = new (*this, TypeAlignment) DependentTypeOfExprType(*this, tofExpr);
4633       DependentTypeOfExprTypes.InsertNode(Canon, InsertPos);
4634       toe = Canon;
4635     }
4636   } else {
4637     QualType Canonical = getCanonicalType(tofExpr->getType());
4638     toe = new (*this, TypeAlignment) TypeOfExprType(tofExpr, Canonical);
4639   }
4640   Types.push_back(toe);
4641   return QualType(toe, 0);
4642 }
4643 
4644 /// getTypeOfType -  Unlike many "get<Type>" functions, we don't unique
4645 /// TypeOfType nodes. The only motivation to unique these nodes would be
4646 /// memory savings. Since typeof(t) is fairly uncommon, space shouldn't be
4647 /// an issue. This doesn't affect the type checker, since it operates
4648 /// on canonical types (which are always unique).
4649 QualType ASTContext::getTypeOfType(QualType tofType) const {
4650   QualType Canonical = getCanonicalType(tofType);
4651   auto *tot = new (*this, TypeAlignment) TypeOfType(tofType, Canonical);
4652   Types.push_back(tot);
4653   return QualType(tot, 0);
4654 }
4655 
4656 /// Unlike many "get<Type>" functions, we don't unique DecltypeType
4657 /// nodes. This would never be helpful, since each such type has its own
4658 /// expression, and would not give a significant memory saving, since there
4659 /// is an Expr tree under each such type.
4660 QualType ASTContext::getDecltypeType(Expr *e, QualType UnderlyingType) const {
4661   DecltypeType *dt;
4662 
4663   // C++11 [temp.type]p2:
4664   //   If an expression e involves a template parameter, decltype(e) denotes a
4665   //   unique dependent type. Two such decltype-specifiers refer to the same
4666   //   type only if their expressions are equivalent (14.5.6.1).
4667   if (e->isInstantiationDependent()) {
4668     llvm::FoldingSetNodeID ID;
4669     DependentDecltypeType::Profile(ID, *this, e);
4670 
4671     void *InsertPos = nullptr;
4672     DependentDecltypeType *Canon
4673       = DependentDecltypeTypes.FindNodeOrInsertPos(ID, InsertPos);
4674     if (!Canon) {
4675       // Build a new, canonical decltype(expr) type.
4676       Canon = new (*this, TypeAlignment) DependentDecltypeType(*this, e);
4677       DependentDecltypeTypes.InsertNode(Canon, InsertPos);
4678     }
4679     dt = new (*this, TypeAlignment)
4680         DecltypeType(e, UnderlyingType, QualType((DecltypeType *)Canon, 0));
4681   } else {
4682     dt = new (*this, TypeAlignment)
4683         DecltypeType(e, UnderlyingType, getCanonicalType(UnderlyingType));
4684   }
4685   Types.push_back(dt);
4686   return QualType(dt, 0);
4687 }
4688 
4689 /// getUnaryTransformationType - We don't unique these, since the memory
4690 /// savings are minimal and these are rare.
4691 QualType ASTContext::getUnaryTransformType(QualType BaseType,
4692                                            QualType UnderlyingType,
4693                                            UnaryTransformType::UTTKind Kind)
4694     const {
4695   UnaryTransformType *ut = nullptr;
4696 
4697   if (BaseType->isDependentType()) {
4698     // Look in the folding set for an existing type.
4699     llvm::FoldingSetNodeID ID;
4700     DependentUnaryTransformType::Profile(ID, getCanonicalType(BaseType), Kind);
4701 
4702     void *InsertPos = nullptr;
4703     DependentUnaryTransformType *Canon
4704       = DependentUnaryTransformTypes.FindNodeOrInsertPos(ID, InsertPos);
4705 
4706     if (!Canon) {
4707       // Build a new, canonical __underlying_type(type) type.
4708       Canon = new (*this, TypeAlignment)
4709              DependentUnaryTransformType(*this, getCanonicalType(BaseType),
4710                                          Kind);
4711       DependentUnaryTransformTypes.InsertNode(Canon, InsertPos);
4712     }
4713     ut = new (*this, TypeAlignment) UnaryTransformType (BaseType,
4714                                                         QualType(), Kind,
4715                                                         QualType(Canon, 0));
4716   } else {
4717     QualType CanonType = getCanonicalType(UnderlyingType);
4718     ut = new (*this, TypeAlignment) UnaryTransformType (BaseType,
4719                                                         UnderlyingType, Kind,
4720                                                         CanonType);
4721   }
4722   Types.push_back(ut);
4723   return QualType(ut, 0);
4724 }
4725 
4726 /// getAutoType - Return the uniqued reference to the 'auto' type which has been
4727 /// deduced to the given type, or to the canonical undeduced 'auto' type, or the
4728 /// canonical deduced-but-dependent 'auto' type.
4729 QualType ASTContext::getAutoType(QualType DeducedType, AutoTypeKeyword Keyword,
4730                                  bool IsDependent) const {
4731   if (DeducedType.isNull() && Keyword == AutoTypeKeyword::Auto && !IsDependent)
4732     return getAutoDeductType();
4733 
4734   // Look in the folding set for an existing type.
4735   void *InsertPos = nullptr;
4736   llvm::FoldingSetNodeID ID;
4737   AutoType::Profile(ID, DeducedType, Keyword, IsDependent);
4738   if (AutoType *AT = AutoTypes.FindNodeOrInsertPos(ID, InsertPos))
4739     return QualType(AT, 0);
4740 
4741   auto *AT = new (*this, TypeAlignment)
4742       AutoType(DeducedType, Keyword, IsDependent);
4743   Types.push_back(AT);
4744   if (InsertPos)
4745     AutoTypes.InsertNode(AT, InsertPos);
4746   return QualType(AT, 0);
4747 }
4748 
4749 /// Return the uniqued reference to the deduced template specialization type
4750 /// which has been deduced to the given type, or to the canonical undeduced
4751 /// such type, or the canonical deduced-but-dependent such type.
4752 QualType ASTContext::getDeducedTemplateSpecializationType(
4753     TemplateName Template, QualType DeducedType, bool IsDependent) const {
4754   // Look in the folding set for an existing type.
4755   void *InsertPos = nullptr;
4756   llvm::FoldingSetNodeID ID;
4757   DeducedTemplateSpecializationType::Profile(ID, Template, DeducedType,
4758                                              IsDependent);
4759   if (DeducedTemplateSpecializationType *DTST =
4760           DeducedTemplateSpecializationTypes.FindNodeOrInsertPos(ID, InsertPos))
4761     return QualType(DTST, 0);
4762 
4763   auto *DTST = new (*this, TypeAlignment)
4764       DeducedTemplateSpecializationType(Template, DeducedType, IsDependent);
4765   Types.push_back(DTST);
4766   if (InsertPos)
4767     DeducedTemplateSpecializationTypes.InsertNode(DTST, InsertPos);
4768   return QualType(DTST, 0);
4769 }
4770 
4771 /// getAtomicType - Return the uniqued reference to the atomic type for
4772 /// the given value type.
4773 QualType ASTContext::getAtomicType(QualType T) const {
4774   // Unique pointers, to guarantee there is only one pointer of a particular
4775   // structure.
4776   llvm::FoldingSetNodeID ID;
4777   AtomicType::Profile(ID, T);
4778 
4779   void *InsertPos = nullptr;
4780   if (AtomicType *AT = AtomicTypes.FindNodeOrInsertPos(ID, InsertPos))
4781     return QualType(AT, 0);
4782 
4783   // If the atomic value type isn't canonical, this won't be a canonical type
4784   // either, so fill in the canonical type field.
4785   QualType Canonical;
4786   if (!T.isCanonical()) {
4787     Canonical = getAtomicType(getCanonicalType(T));
4788 
4789     // Get the new insert position for the node we care about.
4790     AtomicType *NewIP = AtomicTypes.FindNodeOrInsertPos(ID, InsertPos);
4791     assert(!NewIP && "Shouldn't be in the map!"); (void)NewIP;
4792   }
4793   auto *New = new (*this, TypeAlignment) AtomicType(T, Canonical);
4794   Types.push_back(New);
4795   AtomicTypes.InsertNode(New, InsertPos);
4796   return QualType(New, 0);
4797 }
4798 
4799 /// getAutoDeductType - Get type pattern for deducing against 'auto'.
4800 QualType ASTContext::getAutoDeductType() const {
4801   if (AutoDeductTy.isNull())
4802     AutoDeductTy = QualType(
4803       new (*this, TypeAlignment) AutoType(QualType(), AutoTypeKeyword::Auto,
4804                                           /*dependent*/false),
4805       0);
4806   return AutoDeductTy;
4807 }
4808 
4809 /// getAutoRRefDeductType - Get type pattern for deducing against 'auto &&'.
4810 QualType ASTContext::getAutoRRefDeductType() const {
4811   if (AutoRRefDeductTy.isNull())
4812     AutoRRefDeductTy = getRValueReferenceType(getAutoDeductType());
4813   assert(!AutoRRefDeductTy.isNull() && "can't build 'auto &&' pattern");
4814   return AutoRRefDeductTy;
4815 }
4816 
4817 /// getTagDeclType - Return the unique reference to the type for the
4818 /// specified TagDecl (struct/union/class/enum) decl.
4819 QualType ASTContext::getTagDeclType(const TagDecl *Decl) const {
4820   assert(Decl);
4821   // FIXME: What is the design on getTagDeclType when it requires casting
4822   // away const?  mutable?
4823   return getTypeDeclType(const_cast<TagDecl*>(Decl));
4824 }
4825 
4826 /// getSizeType - Return the unique type for "size_t" (C99 7.17), the result
4827 /// of the sizeof operator (C99 6.5.3.4p4). The value is target dependent and
4828 /// needs to agree with the definition in <stddef.h>.
4829 CanQualType ASTContext::getSizeType() const {
4830   return getFromTargetType(Target->getSizeType());
4831 }
4832 
4833 /// Return the unique signed counterpart of the integer type
4834 /// corresponding to size_t.
4835 CanQualType ASTContext::getSignedSizeType() const {
4836   return getFromTargetType(Target->getSignedSizeType());
4837 }
4838 
4839 /// getIntMaxType - Return the unique type for "intmax_t" (C99 7.18.1.5).
4840 CanQualType ASTContext::getIntMaxType() const {
4841   return getFromTargetType(Target->getIntMaxType());
4842 }
4843 
4844 /// getUIntMaxType - Return the unique type for "uintmax_t" (C99 7.18.1.5).
4845 CanQualType ASTContext::getUIntMaxType() const {
4846   return getFromTargetType(Target->getUIntMaxType());
4847 }
4848 
4849 /// getSignedWCharType - Return the type of "signed wchar_t".
4850 /// Used when in C++, as a GCC extension.
4851 QualType ASTContext::getSignedWCharType() const {
4852   // FIXME: derive from "Target" ?
4853   return WCharTy;
4854 }
4855 
4856 /// getUnsignedWCharType - Return the type of "unsigned wchar_t".
4857 /// Used when in C++, as a GCC extension.
4858 QualType ASTContext::getUnsignedWCharType() const {
4859   // FIXME: derive from "Target" ?
4860   return UnsignedIntTy;
4861 }
4862 
4863 QualType ASTContext::getIntPtrType() const {
4864   return getFromTargetType(Target->getIntPtrType());
4865 }
4866 
4867 QualType ASTContext::getUIntPtrType() const {
4868   return getCorrespondingUnsignedType(getIntPtrType());
4869 }
4870 
4871 /// getPointerDiffType - Return the unique type for "ptrdiff_t" (C99 7.17)
4872 /// defined in <stddef.h>. Pointer - pointer requires this (C99 6.5.6p9).
4873 QualType ASTContext::getPointerDiffType() const {
4874   return getFromTargetType(Target->getPtrDiffType(0));
4875 }
4876 
4877 /// Return the unique unsigned counterpart of "ptrdiff_t"
4878 /// integer type. The standard (C11 7.21.6.1p7) refers to this type
4879 /// in the definition of %tu format specifier.
4880 QualType ASTContext::getUnsignedPointerDiffType() const {
4881   return getFromTargetType(Target->getUnsignedPtrDiffType(0));
4882 }
4883 
4884 /// Return the unique type for "pid_t" defined in
4885 /// <sys/types.h>. We need this to compute the correct type for vfork().
4886 QualType ASTContext::getProcessIDType() const {
4887   return getFromTargetType(Target->getProcessIDType());
4888 }
4889 
4890 //===----------------------------------------------------------------------===//
4891 //                              Type Operators
4892 //===----------------------------------------------------------------------===//
4893 
4894 CanQualType ASTContext::getCanonicalParamType(QualType T) const {
4895   // Push qualifiers into arrays, and then discard any remaining
4896   // qualifiers.
4897   T = getCanonicalType(T);
4898   T = getVariableArrayDecayedType(T);
4899   const Type *Ty = T.getTypePtr();
4900   QualType Result;
4901   if (isa<ArrayType>(Ty)) {
4902     Result = getArrayDecayedType(QualType(Ty,0));
4903   } else if (isa<FunctionType>(Ty)) {
4904     Result = getPointerType(QualType(Ty, 0));
4905   } else {
4906     Result = QualType(Ty, 0);
4907   }
4908 
4909   return CanQualType::CreateUnsafe(Result);
4910 }
4911 
4912 QualType ASTContext::getUnqualifiedArrayType(QualType type,
4913                                              Qualifiers &quals) {
4914   SplitQualType splitType = type.getSplitUnqualifiedType();
4915 
4916   // FIXME: getSplitUnqualifiedType() actually walks all the way to
4917   // the unqualified desugared type and then drops it on the floor.
4918   // We then have to strip that sugar back off with
4919   // getUnqualifiedDesugaredType(), which is silly.
4920   const auto *AT =
4921       dyn_cast<ArrayType>(splitType.Ty->getUnqualifiedDesugaredType());
4922 
4923   // If we don't have an array, just use the results in splitType.
4924   if (!AT) {
4925     quals = splitType.Quals;
4926     return QualType(splitType.Ty, 0);
4927   }
4928 
4929   // Otherwise, recurse on the array's element type.
4930   QualType elementType = AT->getElementType();
4931   QualType unqualElementType = getUnqualifiedArrayType(elementType, quals);
4932 
4933   // If that didn't change the element type, AT has no qualifiers, so we
4934   // can just use the results in splitType.
4935   if (elementType == unqualElementType) {
4936     assert(quals.empty()); // from the recursive call
4937     quals = splitType.Quals;
4938     return QualType(splitType.Ty, 0);
4939   }
4940 
4941   // Otherwise, add in the qualifiers from the outermost type, then
4942   // build the type back up.
4943   quals.addConsistentQualifiers(splitType.Quals);
4944 
4945   if (const auto *CAT = dyn_cast<ConstantArrayType>(AT)) {
4946     return getConstantArrayType(unqualElementType, CAT->getSize(),
4947                                 CAT->getSizeModifier(), 0);
4948   }
4949 
4950   if (const auto *IAT = dyn_cast<IncompleteArrayType>(AT)) {
4951     return getIncompleteArrayType(unqualElementType, IAT->getSizeModifier(), 0);
4952   }
4953 
4954   if (const auto *VAT = dyn_cast<VariableArrayType>(AT)) {
4955     return getVariableArrayType(unqualElementType,
4956                                 VAT->getSizeExpr(),
4957                                 VAT->getSizeModifier(),
4958                                 VAT->getIndexTypeCVRQualifiers(),
4959                                 VAT->getBracketsRange());
4960   }
4961 
4962   const auto *DSAT = cast<DependentSizedArrayType>(AT);
4963   return getDependentSizedArrayType(unqualElementType, DSAT->getSizeExpr(),
4964                                     DSAT->getSizeModifier(), 0,
4965                                     SourceRange());
4966 }
4967 
4968 /// UnwrapSimilarPointerTypes - If T1 and T2 are pointer types  that
4969 /// may be similar (C++ 4.4), replaces T1 and T2 with the type that
4970 /// they point to and return true. If T1 and T2 aren't pointer types
4971 /// or pointer-to-member types, or if they are not similar at this
4972 /// level, returns false and leaves T1 and T2 unchanged. Top-level
4973 /// qualifiers on T1 and T2 are ignored. This function will typically
4974 /// be called in a loop that successively "unwraps" pointer and
4975 /// pointer-to-member types to compare them at each level.
4976 bool ASTContext::UnwrapSimilarPointerTypes(QualType &T1, QualType &T2) {
4977   const auto *T1PtrType = T1->getAs<PointerType>();
4978   const auto *T2PtrType = T2->getAs<PointerType>();
4979   if (T1PtrType && T2PtrType) {
4980     T1 = T1PtrType->getPointeeType();
4981     T2 = T2PtrType->getPointeeType();
4982     return true;
4983   }
4984 
4985   const auto *T1MPType = T1->getAs<MemberPointerType>();
4986   const auto *T2MPType = T2->getAs<MemberPointerType>();
4987   if (T1MPType && T2MPType &&
4988       hasSameUnqualifiedType(QualType(T1MPType->getClass(), 0),
4989                              QualType(T2MPType->getClass(), 0))) {
4990     T1 = T1MPType->getPointeeType();
4991     T2 = T2MPType->getPointeeType();
4992     return true;
4993   }
4994 
4995   if (getLangOpts().ObjC1) {
4996     const auto *T1OPType = T1->getAs<ObjCObjectPointerType>();
4997     const auto *T2OPType = T2->getAs<ObjCObjectPointerType>();
4998     if (T1OPType && T2OPType) {
4999       T1 = T1OPType->getPointeeType();
5000       T2 = T2OPType->getPointeeType();
5001       return true;
5002     }
5003   }
5004 
5005   // FIXME: Block pointers, too?
5006 
5007   return false;
5008 }
5009 
5010 DeclarationNameInfo
5011 ASTContext::getNameForTemplate(TemplateName Name,
5012                                SourceLocation NameLoc) const {
5013   switch (Name.getKind()) {
5014   case TemplateName::QualifiedTemplate:
5015   case TemplateName::Template:
5016     // DNInfo work in progress: CHECKME: what about DNLoc?
5017     return DeclarationNameInfo(Name.getAsTemplateDecl()->getDeclName(),
5018                                NameLoc);
5019 
5020   case TemplateName::OverloadedTemplate: {
5021     OverloadedTemplateStorage *Storage = Name.getAsOverloadedTemplate();
5022     // DNInfo work in progress: CHECKME: what about DNLoc?
5023     return DeclarationNameInfo((*Storage->begin())->getDeclName(), NameLoc);
5024   }
5025 
5026   case TemplateName::DependentTemplate: {
5027     DependentTemplateName *DTN = Name.getAsDependentTemplateName();
5028     DeclarationName DName;
5029     if (DTN->isIdentifier()) {
5030       DName = DeclarationNames.getIdentifier(DTN->getIdentifier());
5031       return DeclarationNameInfo(DName, NameLoc);
5032     } else {
5033       DName = DeclarationNames.getCXXOperatorName(DTN->getOperator());
5034       // DNInfo work in progress: FIXME: source locations?
5035       DeclarationNameLoc DNLoc;
5036       DNLoc.CXXOperatorName.BeginOpNameLoc = SourceLocation().getRawEncoding();
5037       DNLoc.CXXOperatorName.EndOpNameLoc = SourceLocation().getRawEncoding();
5038       return DeclarationNameInfo(DName, NameLoc, DNLoc);
5039     }
5040   }
5041 
5042   case TemplateName::SubstTemplateTemplateParm: {
5043     SubstTemplateTemplateParmStorage *subst
5044       = Name.getAsSubstTemplateTemplateParm();
5045     return DeclarationNameInfo(subst->getParameter()->getDeclName(),
5046                                NameLoc);
5047   }
5048 
5049   case TemplateName::SubstTemplateTemplateParmPack: {
5050     SubstTemplateTemplateParmPackStorage *subst
5051       = Name.getAsSubstTemplateTemplateParmPack();
5052     return DeclarationNameInfo(subst->getParameterPack()->getDeclName(),
5053                                NameLoc);
5054   }
5055   }
5056 
5057   llvm_unreachable("bad template name kind!");
5058 }
5059 
5060 TemplateName ASTContext::getCanonicalTemplateName(TemplateName Name) const {
5061   switch (Name.getKind()) {
5062   case TemplateName::QualifiedTemplate:
5063   case TemplateName::Template: {
5064     TemplateDecl *Template = Name.getAsTemplateDecl();
5065     if (auto *TTP  = dyn_cast<TemplateTemplateParmDecl>(Template))
5066       Template = getCanonicalTemplateTemplateParmDecl(TTP);
5067 
5068     // The canonical template name is the canonical template declaration.
5069     return TemplateName(cast<TemplateDecl>(Template->getCanonicalDecl()));
5070   }
5071 
5072   case TemplateName::OverloadedTemplate:
5073     llvm_unreachable("cannot canonicalize overloaded template");
5074 
5075   case TemplateName::DependentTemplate: {
5076     DependentTemplateName *DTN = Name.getAsDependentTemplateName();
5077     assert(DTN && "Non-dependent template names must refer to template decls.");
5078     return DTN->CanonicalTemplateName;
5079   }
5080 
5081   case TemplateName::SubstTemplateTemplateParm: {
5082     SubstTemplateTemplateParmStorage *subst
5083       = Name.getAsSubstTemplateTemplateParm();
5084     return getCanonicalTemplateName(subst->getReplacement());
5085   }
5086 
5087   case TemplateName::SubstTemplateTemplateParmPack: {
5088     SubstTemplateTemplateParmPackStorage *subst
5089                                   = Name.getAsSubstTemplateTemplateParmPack();
5090     TemplateTemplateParmDecl *canonParameter
5091       = getCanonicalTemplateTemplateParmDecl(subst->getParameterPack());
5092     TemplateArgument canonArgPack
5093       = getCanonicalTemplateArgument(subst->getArgumentPack());
5094     return getSubstTemplateTemplateParmPack(canonParameter, canonArgPack);
5095   }
5096   }
5097 
5098   llvm_unreachable("bad template name!");
5099 }
5100 
5101 bool ASTContext::hasSameTemplateName(TemplateName X, TemplateName Y) {
5102   X = getCanonicalTemplateName(X);
5103   Y = getCanonicalTemplateName(Y);
5104   return X.getAsVoidPointer() == Y.getAsVoidPointer();
5105 }
5106 
5107 TemplateArgument
5108 ASTContext::getCanonicalTemplateArgument(const TemplateArgument &Arg) const {
5109   switch (Arg.getKind()) {
5110     case TemplateArgument::Null:
5111       return Arg;
5112 
5113     case TemplateArgument::Expression:
5114       return Arg;
5115 
5116     case TemplateArgument::Declaration: {
5117       auto *D = cast<ValueDecl>(Arg.getAsDecl()->getCanonicalDecl());
5118       return TemplateArgument(D, Arg.getParamTypeForDecl());
5119     }
5120 
5121     case TemplateArgument::NullPtr:
5122       return TemplateArgument(getCanonicalType(Arg.getNullPtrType()),
5123                               /*isNullPtr*/true);
5124 
5125     case TemplateArgument::Template:
5126       return TemplateArgument(getCanonicalTemplateName(Arg.getAsTemplate()));
5127 
5128     case TemplateArgument::TemplateExpansion:
5129       return TemplateArgument(getCanonicalTemplateName(
5130                                          Arg.getAsTemplateOrTemplatePattern()),
5131                               Arg.getNumTemplateExpansions());
5132 
5133     case TemplateArgument::Integral:
5134       return TemplateArgument(Arg, getCanonicalType(Arg.getIntegralType()));
5135 
5136     case TemplateArgument::Type:
5137       return TemplateArgument(getCanonicalType(Arg.getAsType()));
5138 
5139     case TemplateArgument::Pack: {
5140       if (Arg.pack_size() == 0)
5141         return Arg;
5142 
5143       auto *CanonArgs = new (*this) TemplateArgument[Arg.pack_size()];
5144       unsigned Idx = 0;
5145       for (TemplateArgument::pack_iterator A = Arg.pack_begin(),
5146                                         AEnd = Arg.pack_end();
5147            A != AEnd; (void)++A, ++Idx)
5148         CanonArgs[Idx] = getCanonicalTemplateArgument(*A);
5149 
5150       return TemplateArgument(llvm::makeArrayRef(CanonArgs, Arg.pack_size()));
5151     }
5152   }
5153 
5154   // Silence GCC warning
5155   llvm_unreachable("Unhandled template argument kind");
5156 }
5157 
5158 NestedNameSpecifier *
5159 ASTContext::getCanonicalNestedNameSpecifier(NestedNameSpecifier *NNS) const {
5160   if (!NNS)
5161     return nullptr;
5162 
5163   switch (NNS->getKind()) {
5164   case NestedNameSpecifier::Identifier:
5165     // Canonicalize the prefix but keep the identifier the same.
5166     return NestedNameSpecifier::Create(*this,
5167                          getCanonicalNestedNameSpecifier(NNS->getPrefix()),
5168                                        NNS->getAsIdentifier());
5169 
5170   case NestedNameSpecifier::Namespace:
5171     // A namespace is canonical; build a nested-name-specifier with
5172     // this namespace and no prefix.
5173     return NestedNameSpecifier::Create(*this, nullptr,
5174                                  NNS->getAsNamespace()->getOriginalNamespace());
5175 
5176   case NestedNameSpecifier::NamespaceAlias:
5177     // A namespace is canonical; build a nested-name-specifier with
5178     // this namespace and no prefix.
5179     return NestedNameSpecifier::Create(*this, nullptr,
5180                                     NNS->getAsNamespaceAlias()->getNamespace()
5181                                                       ->getOriginalNamespace());
5182 
5183   case NestedNameSpecifier::TypeSpec:
5184   case NestedNameSpecifier::TypeSpecWithTemplate: {
5185     QualType T = getCanonicalType(QualType(NNS->getAsType(), 0));
5186 
5187     // If we have some kind of dependent-named type (e.g., "typename T::type"),
5188     // break it apart into its prefix and identifier, then reconsititute those
5189     // as the canonical nested-name-specifier. This is required to canonicalize
5190     // a dependent nested-name-specifier involving typedefs of dependent-name
5191     // types, e.g.,
5192     //   typedef typename T::type T1;
5193     //   typedef typename T1::type T2;
5194     if (const auto *DNT = T->getAs<DependentNameType>())
5195       return NestedNameSpecifier::Create(*this, DNT->getQualifier(),
5196                            const_cast<IdentifierInfo *>(DNT->getIdentifier()));
5197 
5198     // Otherwise, just canonicalize the type, and force it to be a TypeSpec.
5199     // FIXME: Why are TypeSpec and TypeSpecWithTemplate distinct in the
5200     // first place?
5201     return NestedNameSpecifier::Create(*this, nullptr, false,
5202                                        const_cast<Type *>(T.getTypePtr()));
5203   }
5204 
5205   case NestedNameSpecifier::Global:
5206   case NestedNameSpecifier::Super:
5207     // The global specifier and __super specifer are canonical and unique.
5208     return NNS;
5209   }
5210 
5211   llvm_unreachable("Invalid NestedNameSpecifier::Kind!");
5212 }
5213 
5214 const ArrayType *ASTContext::getAsArrayType(QualType T) const {
5215   // Handle the non-qualified case efficiently.
5216   if (!T.hasLocalQualifiers()) {
5217     // Handle the common positive case fast.
5218     if (const auto *AT = dyn_cast<ArrayType>(T))
5219       return AT;
5220   }
5221 
5222   // Handle the common negative case fast.
5223   if (!isa<ArrayType>(T.getCanonicalType()))
5224     return nullptr;
5225 
5226   // Apply any qualifiers from the array type to the element type.  This
5227   // implements C99 6.7.3p8: "If the specification of an array type includes
5228   // any type qualifiers, the element type is so qualified, not the array type."
5229 
5230   // If we get here, we either have type qualifiers on the type, or we have
5231   // sugar such as a typedef in the way.  If we have type qualifiers on the type
5232   // we must propagate them down into the element type.
5233 
5234   SplitQualType split = T.getSplitDesugaredType();
5235   Qualifiers qs = split.Quals;
5236 
5237   // If we have a simple case, just return now.
5238   const auto *ATy = dyn_cast<ArrayType>(split.Ty);
5239   if (!ATy || qs.empty())
5240     return ATy;
5241 
5242   // Otherwise, we have an array and we have qualifiers on it.  Push the
5243   // qualifiers into the array element type and return a new array type.
5244   QualType NewEltTy = getQualifiedType(ATy->getElementType(), qs);
5245 
5246   if (const auto *CAT = dyn_cast<ConstantArrayType>(ATy))
5247     return cast<ArrayType>(getConstantArrayType(NewEltTy, CAT->getSize(),
5248                                                 CAT->getSizeModifier(),
5249                                            CAT->getIndexTypeCVRQualifiers()));
5250   if (const auto *IAT = dyn_cast<IncompleteArrayType>(ATy))
5251     return cast<ArrayType>(getIncompleteArrayType(NewEltTy,
5252                                                   IAT->getSizeModifier(),
5253                                            IAT->getIndexTypeCVRQualifiers()));
5254 
5255   if (const auto *DSAT = dyn_cast<DependentSizedArrayType>(ATy))
5256     return cast<ArrayType>(
5257                      getDependentSizedArrayType(NewEltTy,
5258                                                 DSAT->getSizeExpr(),
5259                                                 DSAT->getSizeModifier(),
5260                                               DSAT->getIndexTypeCVRQualifiers(),
5261                                                 DSAT->getBracketsRange()));
5262 
5263   const auto *VAT = cast<VariableArrayType>(ATy);
5264   return cast<ArrayType>(getVariableArrayType(NewEltTy,
5265                                               VAT->getSizeExpr(),
5266                                               VAT->getSizeModifier(),
5267                                               VAT->getIndexTypeCVRQualifiers(),
5268                                               VAT->getBracketsRange()));
5269 }
5270 
5271 QualType ASTContext::getAdjustedParameterType(QualType T) const {
5272   if (T->isArrayType() || T->isFunctionType())
5273     return getDecayedType(T);
5274   return T;
5275 }
5276 
5277 QualType ASTContext::getSignatureParameterType(QualType T) const {
5278   T = getVariableArrayDecayedType(T);
5279   T = getAdjustedParameterType(T);
5280   return T.getUnqualifiedType();
5281 }
5282 
5283 QualType ASTContext::getExceptionObjectType(QualType T) const {
5284   // C++ [except.throw]p3:
5285   //   A throw-expression initializes a temporary object, called the exception
5286   //   object, the type of which is determined by removing any top-level
5287   //   cv-qualifiers from the static type of the operand of throw and adjusting
5288   //   the type from "array of T" or "function returning T" to "pointer to T"
5289   //   or "pointer to function returning T", [...]
5290   T = getVariableArrayDecayedType(T);
5291   if (T->isArrayType() || T->isFunctionType())
5292     T = getDecayedType(T);
5293   return T.getUnqualifiedType();
5294 }
5295 
5296 /// getArrayDecayedType - Return the properly qualified result of decaying the
5297 /// specified array type to a pointer.  This operation is non-trivial when
5298 /// handling typedefs etc.  The canonical type of "T" must be an array type,
5299 /// this returns a pointer to a properly qualified element of the array.
5300 ///
5301 /// See C99 6.7.5.3p7 and C99 6.3.2.1p3.
5302 QualType ASTContext::getArrayDecayedType(QualType Ty) const {
5303   // Get the element type with 'getAsArrayType' so that we don't lose any
5304   // typedefs in the element type of the array.  This also handles propagation
5305   // of type qualifiers from the array type into the element type if present
5306   // (C99 6.7.3p8).
5307   const ArrayType *PrettyArrayType = getAsArrayType(Ty);
5308   assert(PrettyArrayType && "Not an array type!");
5309 
5310   QualType PtrTy = getPointerType(PrettyArrayType->getElementType());
5311 
5312   // int x[restrict 4] ->  int *restrict
5313   QualType Result = getQualifiedType(PtrTy,
5314                                      PrettyArrayType->getIndexTypeQualifiers());
5315 
5316   // int x[_Nullable] -> int * _Nullable
5317   if (auto Nullability = Ty->getNullability(*this)) {
5318     Result = const_cast<ASTContext *>(this)->getAttributedType(
5319         AttributedType::getNullabilityAttrKind(*Nullability), Result, Result);
5320   }
5321   return Result;
5322 }
5323 
5324 QualType ASTContext::getBaseElementType(const ArrayType *array) const {
5325   return getBaseElementType(array->getElementType());
5326 }
5327 
5328 QualType ASTContext::getBaseElementType(QualType type) const {
5329   Qualifiers qs;
5330   while (true) {
5331     SplitQualType split = type.getSplitDesugaredType();
5332     const ArrayType *array = split.Ty->getAsArrayTypeUnsafe();
5333     if (!array) break;
5334 
5335     type = array->getElementType();
5336     qs.addConsistentQualifiers(split.Quals);
5337   }
5338 
5339   return getQualifiedType(type, qs);
5340 }
5341 
5342 /// getConstantArrayElementCount - Returns number of constant array elements.
5343 uint64_t
5344 ASTContext::getConstantArrayElementCount(const ConstantArrayType *CA)  const {
5345   uint64_t ElementCount = 1;
5346   do {
5347     ElementCount *= CA->getSize().getZExtValue();
5348     CA = dyn_cast_or_null<ConstantArrayType>(
5349       CA->getElementType()->getAsArrayTypeUnsafe());
5350   } while (CA);
5351   return ElementCount;
5352 }
5353 
5354 /// getFloatingRank - Return a relative rank for floating point types.
5355 /// This routine will assert if passed a built-in type that isn't a float.
5356 static FloatingRank getFloatingRank(QualType T) {
5357   if (const auto *CT = T->getAs<ComplexType>())
5358     return getFloatingRank(CT->getElementType());
5359 
5360   assert(T->getAs<BuiltinType>() && "getFloatingRank(): not a floating type");
5361   switch (T->getAs<BuiltinType>()->getKind()) {
5362   default: llvm_unreachable("getFloatingRank(): not a floating type");
5363   case BuiltinType::Float16:    return Float16Rank;
5364   case BuiltinType::Half:       return HalfRank;
5365   case BuiltinType::Float:      return FloatRank;
5366   case BuiltinType::Double:     return DoubleRank;
5367   case BuiltinType::LongDouble: return LongDoubleRank;
5368   case BuiltinType::Float128:   return Float128Rank;
5369   }
5370 }
5371 
5372 /// getFloatingTypeOfSizeWithinDomain - Returns a real floating
5373 /// point or a complex type (based on typeDomain/typeSize).
5374 /// 'typeDomain' is a real floating point or complex type.
5375 /// 'typeSize' is a real floating point or complex type.
5376 QualType ASTContext::getFloatingTypeOfSizeWithinDomain(QualType Size,
5377                                                        QualType Domain) const {
5378   FloatingRank EltRank = getFloatingRank(Size);
5379   if (Domain->isComplexType()) {
5380     switch (EltRank) {
5381     case Float16Rank:
5382     case HalfRank: llvm_unreachable("Complex half is not supported");
5383     case FloatRank:      return FloatComplexTy;
5384     case DoubleRank:     return DoubleComplexTy;
5385     case LongDoubleRank: return LongDoubleComplexTy;
5386     case Float128Rank:   return Float128ComplexTy;
5387     }
5388   }
5389 
5390   assert(Domain->isRealFloatingType() && "Unknown domain!");
5391   switch (EltRank) {
5392   case Float16Rank:    return HalfTy;
5393   case HalfRank:       return HalfTy;
5394   case FloatRank:      return FloatTy;
5395   case DoubleRank:     return DoubleTy;
5396   case LongDoubleRank: return LongDoubleTy;
5397   case Float128Rank:   return Float128Ty;
5398   }
5399   llvm_unreachable("getFloatingRank(): illegal value for rank");
5400 }
5401 
5402 /// getFloatingTypeOrder - Compare the rank of the two specified floating
5403 /// point types, ignoring the domain of the type (i.e. 'double' ==
5404 /// '_Complex double').  If LHS > RHS, return 1.  If LHS == RHS, return 0. If
5405 /// LHS < RHS, return -1.
5406 int ASTContext::getFloatingTypeOrder(QualType LHS, QualType RHS) const {
5407   FloatingRank LHSR = getFloatingRank(LHS);
5408   FloatingRank RHSR = getFloatingRank(RHS);
5409 
5410   if (LHSR == RHSR)
5411     return 0;
5412   if (LHSR > RHSR)
5413     return 1;
5414   return -1;
5415 }
5416 
5417 /// getIntegerRank - Return an integer conversion rank (C99 6.3.1.1p1). This
5418 /// routine will assert if passed a built-in type that isn't an integer or enum,
5419 /// or if it is not canonicalized.
5420 unsigned ASTContext::getIntegerRank(const Type *T) const {
5421   assert(T->isCanonicalUnqualified() && "T should be canonicalized");
5422 
5423   switch (cast<BuiltinType>(T)->getKind()) {
5424   default: llvm_unreachable("getIntegerRank(): not a built-in integer");
5425   case BuiltinType::Bool:
5426     return 1 + (getIntWidth(BoolTy) << 3);
5427   case BuiltinType::Char_S:
5428   case BuiltinType::Char_U:
5429   case BuiltinType::SChar:
5430   case BuiltinType::UChar:
5431     return 2 + (getIntWidth(CharTy) << 3);
5432   case BuiltinType::Short:
5433   case BuiltinType::UShort:
5434     return 3 + (getIntWidth(ShortTy) << 3);
5435   case BuiltinType::Int:
5436   case BuiltinType::UInt:
5437     return 4 + (getIntWidth(IntTy) << 3);
5438   case BuiltinType::Long:
5439   case BuiltinType::ULong:
5440     return 5 + (getIntWidth(LongTy) << 3);
5441   case BuiltinType::LongLong:
5442   case BuiltinType::ULongLong:
5443     return 6 + (getIntWidth(LongLongTy) << 3);
5444   case BuiltinType::Int128:
5445   case BuiltinType::UInt128:
5446     return 7 + (getIntWidth(Int128Ty) << 3);
5447   }
5448 }
5449 
5450 /// Whether this is a promotable bitfield reference according
5451 /// to C99 6.3.1.1p2, bullet 2 (and GCC extensions).
5452 ///
5453 /// \returns the type this bit-field will promote to, or NULL if no
5454 /// promotion occurs.
5455 QualType ASTContext::isPromotableBitField(Expr *E) const {
5456   if (E->isTypeDependent() || E->isValueDependent())
5457     return {};
5458 
5459   // C++ [conv.prom]p5:
5460   //    If the bit-field has an enumerated type, it is treated as any other
5461   //    value of that type for promotion purposes.
5462   if (getLangOpts().CPlusPlus && E->getType()->isEnumeralType())
5463     return {};
5464 
5465   // FIXME: We should not do this unless E->refersToBitField() is true. This
5466   // matters in C where getSourceBitField() will find bit-fields for various
5467   // cases where the source expression is not a bit-field designator.
5468 
5469   FieldDecl *Field = E->getSourceBitField(); // FIXME: conditional bit-fields?
5470   if (!Field)
5471     return {};
5472 
5473   QualType FT = Field->getType();
5474 
5475   uint64_t BitWidth = Field->getBitWidthValue(*this);
5476   uint64_t IntSize = getTypeSize(IntTy);
5477   // C++ [conv.prom]p5:
5478   //   A prvalue for an integral bit-field can be converted to a prvalue of type
5479   //   int if int can represent all the values of the bit-field; otherwise, it
5480   //   can be converted to unsigned int if unsigned int can represent all the
5481   //   values of the bit-field. If the bit-field is larger yet, no integral
5482   //   promotion applies to it.
5483   // C11 6.3.1.1/2:
5484   //   [For a bit-field of type _Bool, int, signed int, or unsigned int:]
5485   //   If an int can represent all values of the original type (as restricted by
5486   //   the width, for a bit-field), the value is converted to an int; otherwise,
5487   //   it is converted to an unsigned int.
5488   //
5489   // FIXME: C does not permit promotion of a 'long : 3' bitfield to int.
5490   //        We perform that promotion here to match GCC and C++.
5491   // FIXME: C does not permit promotion of an enum bit-field whose rank is
5492   //        greater than that of 'int'. We perform that promotion to match GCC.
5493   if (BitWidth < IntSize)
5494     return IntTy;
5495 
5496   if (BitWidth == IntSize)
5497     return FT->isSignedIntegerType() ? IntTy : UnsignedIntTy;
5498 
5499   // Bit-fields wider than int are not subject to promotions, and therefore act
5500   // like the base type. GCC has some weird bugs in this area that we
5501   // deliberately do not follow (GCC follows a pre-standard resolution to
5502   // C's DR315 which treats bit-width as being part of the type, and this leaks
5503   // into their semantics in some cases).
5504   return {};
5505 }
5506 
5507 /// getPromotedIntegerType - Returns the type that Promotable will
5508 /// promote to: C99 6.3.1.1p2, assuming that Promotable is a promotable
5509 /// integer type.
5510 QualType ASTContext::getPromotedIntegerType(QualType Promotable) const {
5511   assert(!Promotable.isNull());
5512   assert(Promotable->isPromotableIntegerType());
5513   if (const auto *ET = Promotable->getAs<EnumType>())
5514     return ET->getDecl()->getPromotionType();
5515 
5516   if (const auto *BT = Promotable->getAs<BuiltinType>()) {
5517     // C++ [conv.prom]: A prvalue of type char16_t, char32_t, or wchar_t
5518     // (3.9.1) can be converted to a prvalue of the first of the following
5519     // types that can represent all the values of its underlying type:
5520     // int, unsigned int, long int, unsigned long int, long long int, or
5521     // unsigned long long int [...]
5522     // FIXME: Is there some better way to compute this?
5523     if (BT->getKind() == BuiltinType::WChar_S ||
5524         BT->getKind() == BuiltinType::WChar_U ||
5525         BT->getKind() == BuiltinType::Char8 ||
5526         BT->getKind() == BuiltinType::Char16 ||
5527         BT->getKind() == BuiltinType::Char32) {
5528       bool FromIsSigned = BT->getKind() == BuiltinType::WChar_S;
5529       uint64_t FromSize = getTypeSize(BT);
5530       QualType PromoteTypes[] = { IntTy, UnsignedIntTy, LongTy, UnsignedLongTy,
5531                                   LongLongTy, UnsignedLongLongTy };
5532       for (size_t Idx = 0; Idx < llvm::array_lengthof(PromoteTypes); ++Idx) {
5533         uint64_t ToSize = getTypeSize(PromoteTypes[Idx]);
5534         if (FromSize < ToSize ||
5535             (FromSize == ToSize &&
5536              FromIsSigned == PromoteTypes[Idx]->isSignedIntegerType()))
5537           return PromoteTypes[Idx];
5538       }
5539       llvm_unreachable("char type should fit into long long");
5540     }
5541   }
5542 
5543   // At this point, we should have a signed or unsigned integer type.
5544   if (Promotable->isSignedIntegerType())
5545     return IntTy;
5546   uint64_t PromotableSize = getIntWidth(Promotable);
5547   uint64_t IntSize = getIntWidth(IntTy);
5548   assert(Promotable->isUnsignedIntegerType() && PromotableSize <= IntSize);
5549   return (PromotableSize != IntSize) ? IntTy : UnsignedIntTy;
5550 }
5551 
5552 /// Recurses in pointer/array types until it finds an objc retainable
5553 /// type and returns its ownership.
5554 Qualifiers::ObjCLifetime ASTContext::getInnerObjCOwnership(QualType T) const {
5555   while (!T.isNull()) {
5556     if (T.getObjCLifetime() != Qualifiers::OCL_None)
5557       return T.getObjCLifetime();
5558     if (T->isArrayType())
5559       T = getBaseElementType(T);
5560     else if (const auto *PT = T->getAs<PointerType>())
5561       T = PT->getPointeeType();
5562     else if (const auto *RT = T->getAs<ReferenceType>())
5563       T = RT->getPointeeType();
5564     else
5565       break;
5566   }
5567 
5568   return Qualifiers::OCL_None;
5569 }
5570 
5571 static const Type *getIntegerTypeForEnum(const EnumType *ET) {
5572   // Incomplete enum types are not treated as integer types.
5573   // FIXME: In C++, enum types are never integer types.
5574   if (ET->getDecl()->isComplete() && !ET->getDecl()->isScoped())
5575     return ET->getDecl()->getIntegerType().getTypePtr();
5576   return nullptr;
5577 }
5578 
5579 /// getIntegerTypeOrder - Returns the highest ranked integer type:
5580 /// C99 6.3.1.8p1.  If LHS > RHS, return 1.  If LHS == RHS, return 0. If
5581 /// LHS < RHS, return -1.
5582 int ASTContext::getIntegerTypeOrder(QualType LHS, QualType RHS) const {
5583   const Type *LHSC = getCanonicalType(LHS).getTypePtr();
5584   const Type *RHSC = getCanonicalType(RHS).getTypePtr();
5585 
5586   // Unwrap enums to their underlying type.
5587   if (const auto *ET = dyn_cast<EnumType>(LHSC))
5588     LHSC = getIntegerTypeForEnum(ET);
5589   if (const auto *ET = dyn_cast<EnumType>(RHSC))
5590     RHSC = getIntegerTypeForEnum(ET);
5591 
5592   if (LHSC == RHSC) return 0;
5593 
5594   bool LHSUnsigned = LHSC->isUnsignedIntegerType();
5595   bool RHSUnsigned = RHSC->isUnsignedIntegerType();
5596 
5597   unsigned LHSRank = getIntegerRank(LHSC);
5598   unsigned RHSRank = getIntegerRank(RHSC);
5599 
5600   if (LHSUnsigned == RHSUnsigned) {  // Both signed or both unsigned.
5601     if (LHSRank == RHSRank) return 0;
5602     return LHSRank > RHSRank ? 1 : -1;
5603   }
5604 
5605   // Otherwise, the LHS is signed and the RHS is unsigned or visa versa.
5606   if (LHSUnsigned) {
5607     // If the unsigned [LHS] type is larger, return it.
5608     if (LHSRank >= RHSRank)
5609       return 1;
5610 
5611     // If the signed type can represent all values of the unsigned type, it
5612     // wins.  Because we are dealing with 2's complement and types that are
5613     // powers of two larger than each other, this is always safe.
5614     return -1;
5615   }
5616 
5617   // If the unsigned [RHS] type is larger, return it.
5618   if (RHSRank >= LHSRank)
5619     return -1;
5620 
5621   // If the signed type can represent all values of the unsigned type, it
5622   // wins.  Because we are dealing with 2's complement and types that are
5623   // powers of two larger than each other, this is always safe.
5624   return 1;
5625 }
5626 
5627 TypedefDecl *ASTContext::getCFConstantStringDecl() const {
5628   if (!CFConstantStringTypeDecl) {
5629     assert(!CFConstantStringTagDecl &&
5630            "tag and typedef should be initialized together");
5631     CFConstantStringTagDecl = buildImplicitRecord("__NSConstantString_tag");
5632     CFConstantStringTagDecl->startDefinition();
5633 
5634     QualType FieldTypes[4];
5635     const char *FieldNames[4];
5636 
5637     // const int *isa;
5638     FieldTypes[0] = getPointerType(IntTy.withConst());
5639     FieldNames[0] = "isa";
5640     // int flags;
5641     FieldTypes[1] = IntTy;
5642     FieldNames[1] = "flags";
5643     // const char *str;
5644     FieldTypes[2] = getPointerType(CharTy.withConst());
5645     FieldNames[2] = "str";
5646     // long length;
5647     FieldTypes[3] = LongTy;
5648     FieldNames[3] = "length";
5649 
5650     // Create fields
5651     for (unsigned i = 0; i < 4; ++i) {
5652       FieldDecl *Field = FieldDecl::Create(*this, CFConstantStringTagDecl,
5653                                            SourceLocation(),
5654                                            SourceLocation(),
5655                                            &Idents.get(FieldNames[i]),
5656                                            FieldTypes[i], /*TInfo=*/nullptr,
5657                                            /*BitWidth=*/nullptr,
5658                                            /*Mutable=*/false,
5659                                            ICIS_NoInit);
5660       Field->setAccess(AS_public);
5661       CFConstantStringTagDecl->addDecl(Field);
5662     }
5663 
5664     CFConstantStringTagDecl->completeDefinition();
5665     // This type is designed to be compatible with NSConstantString, but cannot
5666     // use the same name, since NSConstantString is an interface.
5667     auto tagType = getTagDeclType(CFConstantStringTagDecl);
5668     CFConstantStringTypeDecl =
5669         buildImplicitTypedef(tagType, "__NSConstantString");
5670   }
5671 
5672   return CFConstantStringTypeDecl;
5673 }
5674 
5675 RecordDecl *ASTContext::getCFConstantStringTagDecl() const {
5676   if (!CFConstantStringTagDecl)
5677     getCFConstantStringDecl(); // Build the tag and the typedef.
5678   return CFConstantStringTagDecl;
5679 }
5680 
5681 // getCFConstantStringType - Return the type used for constant CFStrings.
5682 QualType ASTContext::getCFConstantStringType() const {
5683   return getTypedefType(getCFConstantStringDecl());
5684 }
5685 
5686 QualType ASTContext::getObjCSuperType() const {
5687   if (ObjCSuperType.isNull()) {
5688     RecordDecl *ObjCSuperTypeDecl = buildImplicitRecord("objc_super");
5689     TUDecl->addDecl(ObjCSuperTypeDecl);
5690     ObjCSuperType = getTagDeclType(ObjCSuperTypeDecl);
5691   }
5692   return ObjCSuperType;
5693 }
5694 
5695 void ASTContext::setCFConstantStringType(QualType T) {
5696   const auto *TD = T->getAs<TypedefType>();
5697   assert(TD && "Invalid CFConstantStringType");
5698   CFConstantStringTypeDecl = cast<TypedefDecl>(TD->getDecl());
5699   const auto *TagType =
5700       CFConstantStringTypeDecl->getUnderlyingType()->getAs<RecordType>();
5701   assert(TagType && "Invalid CFConstantStringType");
5702   CFConstantStringTagDecl = TagType->getDecl();
5703 }
5704 
5705 QualType ASTContext::getBlockDescriptorType() const {
5706   if (BlockDescriptorType)
5707     return getTagDeclType(BlockDescriptorType);
5708 
5709   RecordDecl *RD;
5710   // FIXME: Needs the FlagAppleBlock bit.
5711   RD = buildImplicitRecord("__block_descriptor");
5712   RD->startDefinition();
5713 
5714   QualType FieldTypes[] = {
5715     UnsignedLongTy,
5716     UnsignedLongTy,
5717   };
5718 
5719   static const char *const FieldNames[] = {
5720     "reserved",
5721     "Size"
5722   };
5723 
5724   for (size_t i = 0; i < 2; ++i) {
5725     FieldDecl *Field = FieldDecl::Create(
5726         *this, RD, SourceLocation(), SourceLocation(),
5727         &Idents.get(FieldNames[i]), FieldTypes[i], /*TInfo=*/nullptr,
5728         /*BitWidth=*/nullptr, /*Mutable=*/false, ICIS_NoInit);
5729     Field->setAccess(AS_public);
5730     RD->addDecl(Field);
5731   }
5732 
5733   RD->completeDefinition();
5734 
5735   BlockDescriptorType = RD;
5736 
5737   return getTagDeclType(BlockDescriptorType);
5738 }
5739 
5740 QualType ASTContext::getBlockDescriptorExtendedType() const {
5741   if (BlockDescriptorExtendedType)
5742     return getTagDeclType(BlockDescriptorExtendedType);
5743 
5744   RecordDecl *RD;
5745   // FIXME: Needs the FlagAppleBlock bit.
5746   RD = buildImplicitRecord("__block_descriptor_withcopydispose");
5747   RD->startDefinition();
5748 
5749   QualType FieldTypes[] = {
5750     UnsignedLongTy,
5751     UnsignedLongTy,
5752     getPointerType(VoidPtrTy),
5753     getPointerType(VoidPtrTy)
5754   };
5755 
5756   static const char *const FieldNames[] = {
5757     "reserved",
5758     "Size",
5759     "CopyFuncPtr",
5760     "DestroyFuncPtr"
5761   };
5762 
5763   for (size_t i = 0; i < 4; ++i) {
5764     FieldDecl *Field = FieldDecl::Create(
5765         *this, RD, SourceLocation(), SourceLocation(),
5766         &Idents.get(FieldNames[i]), FieldTypes[i], /*TInfo=*/nullptr,
5767         /*BitWidth=*/nullptr,
5768         /*Mutable=*/false, ICIS_NoInit);
5769     Field->setAccess(AS_public);
5770     RD->addDecl(Field);
5771   }
5772 
5773   RD->completeDefinition();
5774 
5775   BlockDescriptorExtendedType = RD;
5776   return getTagDeclType(BlockDescriptorExtendedType);
5777 }
5778 
5779 TargetInfo::OpenCLTypeKind ASTContext::getOpenCLTypeKind(const Type *T) const {
5780   const auto *BT = dyn_cast<BuiltinType>(T);
5781 
5782   if (!BT) {
5783     if (isa<PipeType>(T))
5784       return TargetInfo::OCLTK_Pipe;
5785 
5786     return TargetInfo::OCLTK_Default;
5787   }
5788 
5789   switch (BT->getKind()) {
5790 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix)                   \
5791   case BuiltinType::Id:                                                        \
5792     return TargetInfo::OCLTK_Image;
5793 #include "clang/Basic/OpenCLImageTypes.def"
5794 
5795   case BuiltinType::OCLClkEvent:
5796     return TargetInfo::OCLTK_ClkEvent;
5797 
5798   case BuiltinType::OCLEvent:
5799     return TargetInfo::OCLTK_Event;
5800 
5801   case BuiltinType::OCLQueue:
5802     return TargetInfo::OCLTK_Queue;
5803 
5804   case BuiltinType::OCLReserveID:
5805     return TargetInfo::OCLTK_ReserveID;
5806 
5807   case BuiltinType::OCLSampler:
5808     return TargetInfo::OCLTK_Sampler;
5809 
5810   default:
5811     return TargetInfo::OCLTK_Default;
5812   }
5813 }
5814 
5815 LangAS ASTContext::getOpenCLTypeAddrSpace(const Type *T) const {
5816   return Target->getOpenCLTypeAddrSpace(getOpenCLTypeKind(T));
5817 }
5818 
5819 /// BlockRequiresCopying - Returns true if byref variable "D" of type "Ty"
5820 /// requires copy/dispose. Note that this must match the logic
5821 /// in buildByrefHelpers.
5822 bool ASTContext::BlockRequiresCopying(QualType Ty,
5823                                       const VarDecl *D) {
5824   if (const CXXRecordDecl *record = Ty->getAsCXXRecordDecl()) {
5825     const Expr *copyExpr = getBlockVarCopyInits(D);
5826     if (!copyExpr && record->hasTrivialDestructor()) return false;
5827 
5828     return true;
5829   }
5830 
5831   // The block needs copy/destroy helpers if Ty is non-trivial to destructively
5832   // move or destroy.
5833   if (Ty.isNonTrivialToPrimitiveDestructiveMove() || Ty.isDestructedType())
5834     return true;
5835 
5836   if (!Ty->isObjCRetainableType()) return false;
5837 
5838   Qualifiers qs = Ty.getQualifiers();
5839 
5840   // If we have lifetime, that dominates.
5841   if (Qualifiers::ObjCLifetime lifetime = qs.getObjCLifetime()) {
5842     switch (lifetime) {
5843       case Qualifiers::OCL_None: llvm_unreachable("impossible");
5844 
5845       // These are just bits as far as the runtime is concerned.
5846       case Qualifiers::OCL_ExplicitNone:
5847       case Qualifiers::OCL_Autoreleasing:
5848         return false;
5849 
5850       // These cases should have been taken care of when checking the type's
5851       // non-triviality.
5852       case Qualifiers::OCL_Weak:
5853       case Qualifiers::OCL_Strong:
5854         llvm_unreachable("impossible");
5855     }
5856     llvm_unreachable("fell out of lifetime switch!");
5857   }
5858   return (Ty->isBlockPointerType() || isObjCNSObjectType(Ty) ||
5859           Ty->isObjCObjectPointerType());
5860 }
5861 
5862 bool ASTContext::getByrefLifetime(QualType Ty,
5863                               Qualifiers::ObjCLifetime &LifeTime,
5864                               bool &HasByrefExtendedLayout) const {
5865   if (!getLangOpts().ObjC1 ||
5866       getLangOpts().getGC() != LangOptions::NonGC)
5867     return false;
5868 
5869   HasByrefExtendedLayout = false;
5870   if (Ty->isRecordType()) {
5871     HasByrefExtendedLayout = true;
5872     LifeTime = Qualifiers::OCL_None;
5873   } else if ((LifeTime = Ty.getObjCLifetime())) {
5874     // Honor the ARC qualifiers.
5875   } else if (Ty->isObjCObjectPointerType() || Ty->isBlockPointerType()) {
5876     // The MRR rule.
5877     LifeTime = Qualifiers::OCL_ExplicitNone;
5878   } else {
5879     LifeTime = Qualifiers::OCL_None;
5880   }
5881   return true;
5882 }
5883 
5884 TypedefDecl *ASTContext::getObjCInstanceTypeDecl() {
5885   if (!ObjCInstanceTypeDecl)
5886     ObjCInstanceTypeDecl =
5887         buildImplicitTypedef(getObjCIdType(), "instancetype");
5888   return ObjCInstanceTypeDecl;
5889 }
5890 
5891 // This returns true if a type has been typedefed to BOOL:
5892 // typedef <type> BOOL;
5893 static bool isTypeTypedefedAsBOOL(QualType T) {
5894   if (const auto *TT = dyn_cast<TypedefType>(T))
5895     if (IdentifierInfo *II = TT->getDecl()->getIdentifier())
5896       return II->isStr("BOOL");
5897 
5898   return false;
5899 }
5900 
5901 /// getObjCEncodingTypeSize returns size of type for objective-c encoding
5902 /// purpose.
5903 CharUnits ASTContext::getObjCEncodingTypeSize(QualType type) const {
5904   if (!type->isIncompleteArrayType() && type->isIncompleteType())
5905     return CharUnits::Zero();
5906 
5907   CharUnits sz = getTypeSizeInChars(type);
5908 
5909   // Make all integer and enum types at least as large as an int
5910   if (sz.isPositive() && type->isIntegralOrEnumerationType())
5911     sz = std::max(sz, getTypeSizeInChars(IntTy));
5912   // Treat arrays as pointers, since that's how they're passed in.
5913   else if (type->isArrayType())
5914     sz = getTypeSizeInChars(VoidPtrTy);
5915   return sz;
5916 }
5917 
5918 bool ASTContext::isMSStaticDataMemberInlineDefinition(const VarDecl *VD) const {
5919   return getTargetInfo().getCXXABI().isMicrosoft() &&
5920          VD->isStaticDataMember() &&
5921          VD->getType()->isIntegralOrEnumerationType() &&
5922          !VD->getFirstDecl()->isOutOfLine() && VD->getFirstDecl()->hasInit();
5923 }
5924 
5925 ASTContext::InlineVariableDefinitionKind
5926 ASTContext::getInlineVariableDefinitionKind(const VarDecl *VD) const {
5927   if (!VD->isInline())
5928     return InlineVariableDefinitionKind::None;
5929 
5930   // In almost all cases, it's a weak definition.
5931   auto *First = VD->getFirstDecl();
5932   if (First->isInlineSpecified() || !First->isStaticDataMember())
5933     return InlineVariableDefinitionKind::Weak;
5934 
5935   // If there's a file-context declaration in this translation unit, it's a
5936   // non-discardable definition.
5937   for (auto *D : VD->redecls())
5938     if (D->getLexicalDeclContext()->isFileContext() &&
5939         !D->isInlineSpecified() && (D->isConstexpr() || First->isConstexpr()))
5940       return InlineVariableDefinitionKind::Strong;
5941 
5942   // If we've not seen one yet, we don't know.
5943   return InlineVariableDefinitionKind::WeakUnknown;
5944 }
5945 
5946 static std::string charUnitsToString(const CharUnits &CU) {
5947   return llvm::itostr(CU.getQuantity());
5948 }
5949 
5950 /// getObjCEncodingForBlock - Return the encoded type for this block
5951 /// declaration.
5952 std::string ASTContext::getObjCEncodingForBlock(const BlockExpr *Expr) const {
5953   std::string S;
5954 
5955   const BlockDecl *Decl = Expr->getBlockDecl();
5956   QualType BlockTy =
5957       Expr->getType()->getAs<BlockPointerType>()->getPointeeType();
5958   // Encode result type.
5959   if (getLangOpts().EncodeExtendedBlockSig)
5960     getObjCEncodingForMethodParameter(
5961         Decl::OBJC_TQ_None, BlockTy->getAs<FunctionType>()->getReturnType(), S,
5962         true /*Extended*/);
5963   else
5964     getObjCEncodingForType(BlockTy->getAs<FunctionType>()->getReturnType(), S);
5965   // Compute size of all parameters.
5966   // Start with computing size of a pointer in number of bytes.
5967   // FIXME: There might(should) be a better way of doing this computation!
5968   CharUnits PtrSize = getTypeSizeInChars(VoidPtrTy);
5969   CharUnits ParmOffset = PtrSize;
5970   for (auto PI : Decl->parameters()) {
5971     QualType PType = PI->getType();
5972     CharUnits sz = getObjCEncodingTypeSize(PType);
5973     if (sz.isZero())
5974       continue;
5975     assert(sz.isPositive() && "BlockExpr - Incomplete param type");
5976     ParmOffset += sz;
5977   }
5978   // Size of the argument frame
5979   S += charUnitsToString(ParmOffset);
5980   // Block pointer and offset.
5981   S += "@?0";
5982 
5983   // Argument types.
5984   ParmOffset = PtrSize;
5985   for (auto PVDecl : Decl->parameters()) {
5986     QualType PType = PVDecl->getOriginalType();
5987     if (const auto *AT =
5988             dyn_cast<ArrayType>(PType->getCanonicalTypeInternal())) {
5989       // Use array's original type only if it has known number of
5990       // elements.
5991       if (!isa<ConstantArrayType>(AT))
5992         PType = PVDecl->getType();
5993     } else if (PType->isFunctionType())
5994       PType = PVDecl->getType();
5995     if (getLangOpts().EncodeExtendedBlockSig)
5996       getObjCEncodingForMethodParameter(Decl::OBJC_TQ_None, PType,
5997                                       S, true /*Extended*/);
5998     else
5999       getObjCEncodingForType(PType, S);
6000     S += charUnitsToString(ParmOffset);
6001     ParmOffset += getObjCEncodingTypeSize(PType);
6002   }
6003 
6004   return S;
6005 }
6006 
6007 std::string
6008 ASTContext::getObjCEncodingForFunctionDecl(const FunctionDecl *Decl) const {
6009   std::string S;
6010   // Encode result type.
6011   getObjCEncodingForType(Decl->getReturnType(), S);
6012   CharUnits ParmOffset;
6013   // Compute size of all parameters.
6014   for (auto PI : Decl->parameters()) {
6015     QualType PType = PI->getType();
6016     CharUnits sz = getObjCEncodingTypeSize(PType);
6017     if (sz.isZero())
6018       continue;
6019 
6020     assert(sz.isPositive() &&
6021            "getObjCEncodingForFunctionDecl - Incomplete param type");
6022     ParmOffset += sz;
6023   }
6024   S += charUnitsToString(ParmOffset);
6025   ParmOffset = CharUnits::Zero();
6026 
6027   // Argument types.
6028   for (auto PVDecl : Decl->parameters()) {
6029     QualType PType = PVDecl->getOriginalType();
6030     if (const auto *AT =
6031             dyn_cast<ArrayType>(PType->getCanonicalTypeInternal())) {
6032       // Use array's original type only if it has known number of
6033       // elements.
6034       if (!isa<ConstantArrayType>(AT))
6035         PType = PVDecl->getType();
6036     } else if (PType->isFunctionType())
6037       PType = PVDecl->getType();
6038     getObjCEncodingForType(PType, S);
6039     S += charUnitsToString(ParmOffset);
6040     ParmOffset += getObjCEncodingTypeSize(PType);
6041   }
6042 
6043   return S;
6044 }
6045 
6046 /// getObjCEncodingForMethodParameter - Return the encoded type for a single
6047 /// method parameter or return type. If Extended, include class names and
6048 /// block object types.
6049 void ASTContext::getObjCEncodingForMethodParameter(Decl::ObjCDeclQualifier QT,
6050                                                    QualType T, std::string& S,
6051                                                    bool Extended) const {
6052   // Encode type qualifer, 'in', 'inout', etc. for the parameter.
6053   getObjCEncodingForTypeQualifier(QT, S);
6054   // Encode parameter type.
6055   getObjCEncodingForTypeImpl(T, S, true, true, nullptr,
6056                              true     /*OutermostType*/,
6057                              false    /*EncodingProperty*/,
6058                              false    /*StructField*/,
6059                              Extended /*EncodeBlockParameters*/,
6060                              Extended /*EncodeClassNames*/);
6061 }
6062 
6063 /// getObjCEncodingForMethodDecl - Return the encoded type for this method
6064 /// declaration.
6065 std::string ASTContext::getObjCEncodingForMethodDecl(const ObjCMethodDecl *Decl,
6066                                                      bool Extended) const {
6067   // FIXME: This is not very efficient.
6068   // Encode return type.
6069   std::string S;
6070   getObjCEncodingForMethodParameter(Decl->getObjCDeclQualifier(),
6071                                     Decl->getReturnType(), S, Extended);
6072   // Compute size of all parameters.
6073   // Start with computing size of a pointer in number of bytes.
6074   // FIXME: There might(should) be a better way of doing this computation!
6075   CharUnits PtrSize = getTypeSizeInChars(VoidPtrTy);
6076   // The first two arguments (self and _cmd) are pointers; account for
6077   // their size.
6078   CharUnits ParmOffset = 2 * PtrSize;
6079   for (ObjCMethodDecl::param_const_iterator PI = Decl->param_begin(),
6080        E = Decl->sel_param_end(); PI != E; ++PI) {
6081     QualType PType = (*PI)->getType();
6082     CharUnits sz = getObjCEncodingTypeSize(PType);
6083     if (sz.isZero())
6084       continue;
6085 
6086     assert(sz.isPositive() &&
6087            "getObjCEncodingForMethodDecl - Incomplete param type");
6088     ParmOffset += sz;
6089   }
6090   S += charUnitsToString(ParmOffset);
6091   S += "@0:";
6092   S += charUnitsToString(PtrSize);
6093 
6094   // Argument types.
6095   ParmOffset = 2 * PtrSize;
6096   for (ObjCMethodDecl::param_const_iterator PI = Decl->param_begin(),
6097        E = Decl->sel_param_end(); PI != E; ++PI) {
6098     const ParmVarDecl *PVDecl = *PI;
6099     QualType PType = PVDecl->getOriginalType();
6100     if (const auto *AT =
6101             dyn_cast<ArrayType>(PType->getCanonicalTypeInternal())) {
6102       // Use array's original type only if it has known number of
6103       // elements.
6104       if (!isa<ConstantArrayType>(AT))
6105         PType = PVDecl->getType();
6106     } else if (PType->isFunctionType())
6107       PType = PVDecl->getType();
6108     getObjCEncodingForMethodParameter(PVDecl->getObjCDeclQualifier(),
6109                                       PType, S, Extended);
6110     S += charUnitsToString(ParmOffset);
6111     ParmOffset += getObjCEncodingTypeSize(PType);
6112   }
6113 
6114   return S;
6115 }
6116 
6117 ObjCPropertyImplDecl *
6118 ASTContext::getObjCPropertyImplDeclForPropertyDecl(
6119                                       const ObjCPropertyDecl *PD,
6120                                       const Decl *Container) const {
6121   if (!Container)
6122     return nullptr;
6123   if (const auto *CID = dyn_cast<ObjCCategoryImplDecl>(Container)) {
6124     for (auto *PID : CID->property_impls())
6125       if (PID->getPropertyDecl() == PD)
6126         return PID;
6127   } else {
6128     const auto *OID = cast<ObjCImplementationDecl>(Container);
6129     for (auto *PID : OID->property_impls())
6130       if (PID->getPropertyDecl() == PD)
6131         return PID;
6132   }
6133   return nullptr;
6134 }
6135 
6136 /// getObjCEncodingForPropertyDecl - Return the encoded type for this
6137 /// property declaration. If non-NULL, Container must be either an
6138 /// ObjCCategoryImplDecl or ObjCImplementationDecl; it should only be
6139 /// NULL when getting encodings for protocol properties.
6140 /// Property attributes are stored as a comma-delimited C string. The simple
6141 /// attributes readonly and bycopy are encoded as single characters. The
6142 /// parametrized attributes, getter=name, setter=name, and ivar=name, are
6143 /// encoded as single characters, followed by an identifier. Property types
6144 /// are also encoded as a parametrized attribute. The characters used to encode
6145 /// these attributes are defined by the following enumeration:
6146 /// @code
6147 /// enum PropertyAttributes {
6148 /// kPropertyReadOnly = 'R',   // property is read-only.
6149 /// kPropertyBycopy = 'C',     // property is a copy of the value last assigned
6150 /// kPropertyByref = '&',  // property is a reference to the value last assigned
6151 /// kPropertyDynamic = 'D',    // property is dynamic
6152 /// kPropertyGetter = 'G',     // followed by getter selector name
6153 /// kPropertySetter = 'S',     // followed by setter selector name
6154 /// kPropertyInstanceVariable = 'V'  // followed by instance variable  name
6155 /// kPropertyType = 'T'              // followed by old-style type encoding.
6156 /// kPropertyWeak = 'W'              // 'weak' property
6157 /// kPropertyStrong = 'P'            // property GC'able
6158 /// kPropertyNonAtomic = 'N'         // property non-atomic
6159 /// };
6160 /// @endcode
6161 std::string
6162 ASTContext::getObjCEncodingForPropertyDecl(const ObjCPropertyDecl *PD,
6163                                            const Decl *Container) const {
6164   // Collect information from the property implementation decl(s).
6165   bool Dynamic = false;
6166   ObjCPropertyImplDecl *SynthesizePID = nullptr;
6167 
6168   if (ObjCPropertyImplDecl *PropertyImpDecl =
6169       getObjCPropertyImplDeclForPropertyDecl(PD, Container)) {
6170     if (PropertyImpDecl->getPropertyImplementation() == ObjCPropertyImplDecl::Dynamic)
6171       Dynamic = true;
6172     else
6173       SynthesizePID = PropertyImpDecl;
6174   }
6175 
6176   // FIXME: This is not very efficient.
6177   std::string S = "T";
6178 
6179   // Encode result type.
6180   // GCC has some special rules regarding encoding of properties which
6181   // closely resembles encoding of ivars.
6182   getObjCEncodingForPropertyType(PD->getType(), S);
6183 
6184   if (PD->isReadOnly()) {
6185     S += ",R";
6186     if (PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_copy)
6187       S += ",C";
6188     if (PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_retain)
6189       S += ",&";
6190     if (PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_weak)
6191       S += ",W";
6192   } else {
6193     switch (PD->getSetterKind()) {
6194     case ObjCPropertyDecl::Assign: break;
6195     case ObjCPropertyDecl::Copy:   S += ",C"; break;
6196     case ObjCPropertyDecl::Retain: S += ",&"; break;
6197     case ObjCPropertyDecl::Weak:   S += ",W"; break;
6198     }
6199   }
6200 
6201   // It really isn't clear at all what this means, since properties
6202   // are "dynamic by default".
6203   if (Dynamic)
6204     S += ",D";
6205 
6206   if (PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_nonatomic)
6207     S += ",N";
6208 
6209   if (PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_getter) {
6210     S += ",G";
6211     S += PD->getGetterName().getAsString();
6212   }
6213 
6214   if (PD->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_setter) {
6215     S += ",S";
6216     S += PD->getSetterName().getAsString();
6217   }
6218 
6219   if (SynthesizePID) {
6220     const ObjCIvarDecl *OID = SynthesizePID->getPropertyIvarDecl();
6221     S += ",V";
6222     S += OID->getNameAsString();
6223   }
6224 
6225   // FIXME: OBJCGC: weak & strong
6226   return S;
6227 }
6228 
6229 /// getLegacyIntegralTypeEncoding -
6230 /// Another legacy compatibility encoding: 32-bit longs are encoded as
6231 /// 'l' or 'L' , but not always.  For typedefs, we need to use
6232 /// 'i' or 'I' instead if encoding a struct field, or a pointer!
6233 void ASTContext::getLegacyIntegralTypeEncoding (QualType &PointeeTy) const {
6234   if (isa<TypedefType>(PointeeTy.getTypePtr())) {
6235     if (const auto *BT = PointeeTy->getAs<BuiltinType>()) {
6236       if (BT->getKind() == BuiltinType::ULong && getIntWidth(PointeeTy) == 32)
6237         PointeeTy = UnsignedIntTy;
6238       else
6239         if (BT->getKind() == BuiltinType::Long && getIntWidth(PointeeTy) == 32)
6240           PointeeTy = IntTy;
6241     }
6242   }
6243 }
6244 
6245 void ASTContext::getObjCEncodingForType(QualType T, std::string& S,
6246                                         const FieldDecl *Field,
6247                                         QualType *NotEncodedT) const {
6248   // We follow the behavior of gcc, expanding structures which are
6249   // directly pointed to, and expanding embedded structures. Note that
6250   // these rules are sufficient to prevent recursive encoding of the
6251   // same type.
6252   getObjCEncodingForTypeImpl(T, S, true, true, Field,
6253                              true /* outermost type */, false, false,
6254                              false, false, false, NotEncodedT);
6255 }
6256 
6257 void ASTContext::getObjCEncodingForPropertyType(QualType T,
6258                                                 std::string& S) const {
6259   // Encode result type.
6260   // GCC has some special rules regarding encoding of properties which
6261   // closely resembles encoding of ivars.
6262   getObjCEncodingForTypeImpl(T, S, true, true, nullptr,
6263                              true /* outermost type */,
6264                              true /* encoding property */);
6265 }
6266 
6267 static char getObjCEncodingForPrimitiveKind(const ASTContext *C,
6268                                             BuiltinType::Kind kind) {
6269     switch (kind) {
6270     case BuiltinType::Void:       return 'v';
6271     case BuiltinType::Bool:       return 'B';
6272     case BuiltinType::Char8:
6273     case BuiltinType::Char_U:
6274     case BuiltinType::UChar:      return 'C';
6275     case BuiltinType::Char16:
6276     case BuiltinType::UShort:     return 'S';
6277     case BuiltinType::Char32:
6278     case BuiltinType::UInt:       return 'I';
6279     case BuiltinType::ULong:
6280         return C->getTargetInfo().getLongWidth() == 32 ? 'L' : 'Q';
6281     case BuiltinType::UInt128:    return 'T';
6282     case BuiltinType::ULongLong:  return 'Q';
6283     case BuiltinType::Char_S:
6284     case BuiltinType::SChar:      return 'c';
6285     case BuiltinType::Short:      return 's';
6286     case BuiltinType::WChar_S:
6287     case BuiltinType::WChar_U:
6288     case BuiltinType::Int:        return 'i';
6289     case BuiltinType::Long:
6290       return C->getTargetInfo().getLongWidth() == 32 ? 'l' : 'q';
6291     case BuiltinType::LongLong:   return 'q';
6292     case BuiltinType::Int128:     return 't';
6293     case BuiltinType::Float:      return 'f';
6294     case BuiltinType::Double:     return 'd';
6295     case BuiltinType::LongDouble: return 'D';
6296     case BuiltinType::NullPtr:    return '*'; // like char*
6297 
6298     case BuiltinType::Float16:
6299     case BuiltinType::Float128:
6300     case BuiltinType::Half:
6301     case BuiltinType::ShortAccum:
6302     case BuiltinType::Accum:
6303     case BuiltinType::LongAccum:
6304     case BuiltinType::UShortAccum:
6305     case BuiltinType::UAccum:
6306     case BuiltinType::ULongAccum:
6307     case BuiltinType::ShortFract:
6308     case BuiltinType::Fract:
6309     case BuiltinType::LongFract:
6310     case BuiltinType::UShortFract:
6311     case BuiltinType::UFract:
6312     case BuiltinType::ULongFract:
6313     case BuiltinType::SatShortAccum:
6314     case BuiltinType::SatAccum:
6315     case BuiltinType::SatLongAccum:
6316     case BuiltinType::SatUShortAccum:
6317     case BuiltinType::SatUAccum:
6318     case BuiltinType::SatULongAccum:
6319     case BuiltinType::SatShortFract:
6320     case BuiltinType::SatFract:
6321     case BuiltinType::SatLongFract:
6322     case BuiltinType::SatUShortFract:
6323     case BuiltinType::SatUFract:
6324     case BuiltinType::SatULongFract:
6325       // FIXME: potentially need @encodes for these!
6326       return ' ';
6327 
6328     case BuiltinType::ObjCId:
6329     case BuiltinType::ObjCClass:
6330     case BuiltinType::ObjCSel:
6331       llvm_unreachable("@encoding ObjC primitive type");
6332 
6333     // OpenCL and placeholder types don't need @encodings.
6334 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
6335     case BuiltinType::Id:
6336 #include "clang/Basic/OpenCLImageTypes.def"
6337     case BuiltinType::OCLEvent:
6338     case BuiltinType::OCLClkEvent:
6339     case BuiltinType::OCLQueue:
6340     case BuiltinType::OCLReserveID:
6341     case BuiltinType::OCLSampler:
6342     case BuiltinType::Dependent:
6343 #define BUILTIN_TYPE(KIND, ID)
6344 #define PLACEHOLDER_TYPE(KIND, ID) \
6345     case BuiltinType::KIND:
6346 #include "clang/AST/BuiltinTypes.def"
6347       llvm_unreachable("invalid builtin type for @encode");
6348     }
6349     llvm_unreachable("invalid BuiltinType::Kind value");
6350 }
6351 
6352 static char ObjCEncodingForEnumType(const ASTContext *C, const EnumType *ET) {
6353   EnumDecl *Enum = ET->getDecl();
6354 
6355   // The encoding of an non-fixed enum type is always 'i', regardless of size.
6356   if (!Enum->isFixed())
6357     return 'i';
6358 
6359   // The encoding of a fixed enum type matches its fixed underlying type.
6360   const auto *BT = Enum->getIntegerType()->castAs<BuiltinType>();
6361   return getObjCEncodingForPrimitiveKind(C, BT->getKind());
6362 }
6363 
6364 static void EncodeBitField(const ASTContext *Ctx, std::string& S,
6365                            QualType T, const FieldDecl *FD) {
6366   assert(FD->isBitField() && "not a bitfield - getObjCEncodingForTypeImpl");
6367   S += 'b';
6368   // The NeXT runtime encodes bit fields as b followed by the number of bits.
6369   // The GNU runtime requires more information; bitfields are encoded as b,
6370   // then the offset (in bits) of the first element, then the type of the
6371   // bitfield, then the size in bits.  For example, in this structure:
6372   //
6373   // struct
6374   // {
6375   //    int integer;
6376   //    int flags:2;
6377   // };
6378   // On a 32-bit system, the encoding for flags would be b2 for the NeXT
6379   // runtime, but b32i2 for the GNU runtime.  The reason for this extra
6380   // information is not especially sensible, but we're stuck with it for
6381   // compatibility with GCC, although providing it breaks anything that
6382   // actually uses runtime introspection and wants to work on both runtimes...
6383   if (Ctx->getLangOpts().ObjCRuntime.isGNUFamily()) {
6384     uint64_t Offset;
6385 
6386     if (const auto *IVD = dyn_cast<ObjCIvarDecl>(FD)) {
6387       Offset = Ctx->lookupFieldBitOffset(IVD->getContainingInterface(), nullptr,
6388                                          IVD);
6389     } else {
6390       const RecordDecl *RD = FD->getParent();
6391       const ASTRecordLayout &RL = Ctx->getASTRecordLayout(RD);
6392       Offset = RL.getFieldOffset(FD->getFieldIndex());
6393     }
6394 
6395     S += llvm::utostr(Offset);
6396 
6397     if (const auto *ET = T->getAs<EnumType>())
6398       S += ObjCEncodingForEnumType(Ctx, ET);
6399     else {
6400       const auto *BT = T->castAs<BuiltinType>();
6401       S += getObjCEncodingForPrimitiveKind(Ctx, BT->getKind());
6402     }
6403   }
6404   S += llvm::utostr(FD->getBitWidthValue(*Ctx));
6405 }
6406 
6407 // FIXME: Use SmallString for accumulating string.
6408 void ASTContext::getObjCEncodingForTypeImpl(QualType T, std::string& S,
6409                                             bool ExpandPointedToStructures,
6410                                             bool ExpandStructures,
6411                                             const FieldDecl *FD,
6412                                             bool OutermostType,
6413                                             bool EncodingProperty,
6414                                             bool StructField,
6415                                             bool EncodeBlockParameters,
6416                                             bool EncodeClassNames,
6417                                             bool EncodePointerToObjCTypedef,
6418                                             QualType *NotEncodedT) const {
6419   CanQualType CT = getCanonicalType(T);
6420   switch (CT->getTypeClass()) {
6421   case Type::Builtin:
6422   case Type::Enum:
6423     if (FD && FD->isBitField())
6424       return EncodeBitField(this, S, T, FD);
6425     if (const auto *BT = dyn_cast<BuiltinType>(CT))
6426       S += getObjCEncodingForPrimitiveKind(this, BT->getKind());
6427     else
6428       S += ObjCEncodingForEnumType(this, cast<EnumType>(CT));
6429     return;
6430 
6431   case Type::Complex: {
6432     const auto *CT = T->castAs<ComplexType>();
6433     S += 'j';
6434     getObjCEncodingForTypeImpl(CT->getElementType(), S, false, false, nullptr);
6435     return;
6436   }
6437 
6438   case Type::Atomic: {
6439     const auto *AT = T->castAs<AtomicType>();
6440     S += 'A';
6441     getObjCEncodingForTypeImpl(AT->getValueType(), S, false, false, nullptr);
6442     return;
6443   }
6444 
6445   // encoding for pointer or reference types.
6446   case Type::Pointer:
6447   case Type::LValueReference:
6448   case Type::RValueReference: {
6449     QualType PointeeTy;
6450     if (isa<PointerType>(CT)) {
6451       const auto *PT = T->castAs<PointerType>();
6452       if (PT->isObjCSelType()) {
6453         S += ':';
6454         return;
6455       }
6456       PointeeTy = PT->getPointeeType();
6457     } else {
6458       PointeeTy = T->castAs<ReferenceType>()->getPointeeType();
6459     }
6460 
6461     bool isReadOnly = false;
6462     // For historical/compatibility reasons, the read-only qualifier of the
6463     // pointee gets emitted _before_ the '^'.  The read-only qualifier of
6464     // the pointer itself gets ignored, _unless_ we are looking at a typedef!
6465     // Also, do not emit the 'r' for anything but the outermost type!
6466     if (isa<TypedefType>(T.getTypePtr())) {
6467       if (OutermostType && T.isConstQualified()) {
6468         isReadOnly = true;
6469         S += 'r';
6470       }
6471     } else if (OutermostType) {
6472       QualType P = PointeeTy;
6473       while (P->getAs<PointerType>())
6474         P = P->getAs<PointerType>()->getPointeeType();
6475       if (P.isConstQualified()) {
6476         isReadOnly = true;
6477         S += 'r';
6478       }
6479     }
6480     if (isReadOnly) {
6481       // Another legacy compatibility encoding. Some ObjC qualifier and type
6482       // combinations need to be rearranged.
6483       // Rewrite "in const" from "nr" to "rn"
6484       if (StringRef(S).endswith("nr"))
6485         S.replace(S.end()-2, S.end(), "rn");
6486     }
6487 
6488     if (PointeeTy->isCharType()) {
6489       // char pointer types should be encoded as '*' unless it is a
6490       // type that has been typedef'd to 'BOOL'.
6491       if (!isTypeTypedefedAsBOOL(PointeeTy)) {
6492         S += '*';
6493         return;
6494       }
6495     } else if (const auto *RTy = PointeeTy->getAs<RecordType>()) {
6496       // GCC binary compat: Need to convert "struct objc_class *" to "#".
6497       if (RTy->getDecl()->getIdentifier() == &Idents.get("objc_class")) {
6498         S += '#';
6499         return;
6500       }
6501       // GCC binary compat: Need to convert "struct objc_object *" to "@".
6502       if (RTy->getDecl()->getIdentifier() == &Idents.get("objc_object")) {
6503         S += '@';
6504         return;
6505       }
6506       // fall through...
6507     }
6508     S += '^';
6509     getLegacyIntegralTypeEncoding(PointeeTy);
6510 
6511     getObjCEncodingForTypeImpl(PointeeTy, S, false, ExpandPointedToStructures,
6512                                nullptr, false, false, false, false, false, false,
6513                                NotEncodedT);
6514     return;
6515   }
6516 
6517   case Type::ConstantArray:
6518   case Type::IncompleteArray:
6519   case Type::VariableArray: {
6520     const auto *AT = cast<ArrayType>(CT);
6521 
6522     if (isa<IncompleteArrayType>(AT) && !StructField) {
6523       // Incomplete arrays are encoded as a pointer to the array element.
6524       S += '^';
6525 
6526       getObjCEncodingForTypeImpl(AT->getElementType(), S,
6527                                  false, ExpandStructures, FD);
6528     } else {
6529       S += '[';
6530 
6531       if (const auto *CAT = dyn_cast<ConstantArrayType>(AT))
6532         S += llvm::utostr(CAT->getSize().getZExtValue());
6533       else {
6534         //Variable length arrays are encoded as a regular array with 0 elements.
6535         assert((isa<VariableArrayType>(AT) || isa<IncompleteArrayType>(AT)) &&
6536                "Unknown array type!");
6537         S += '0';
6538       }
6539 
6540       getObjCEncodingForTypeImpl(AT->getElementType(), S,
6541                                  false, ExpandStructures, FD,
6542                                  false, false, false, false, false, false,
6543                                  NotEncodedT);
6544       S += ']';
6545     }
6546     return;
6547   }
6548 
6549   case Type::FunctionNoProto:
6550   case Type::FunctionProto:
6551     S += '?';
6552     return;
6553 
6554   case Type::Record: {
6555     RecordDecl *RDecl = cast<RecordType>(CT)->getDecl();
6556     S += RDecl->isUnion() ? '(' : '{';
6557     // Anonymous structures print as '?'
6558     if (const IdentifierInfo *II = RDecl->getIdentifier()) {
6559       S += II->getName();
6560       if (const auto *Spec = dyn_cast<ClassTemplateSpecializationDecl>(RDecl)) {
6561         const TemplateArgumentList &TemplateArgs = Spec->getTemplateArgs();
6562         llvm::raw_string_ostream OS(S);
6563         printTemplateArgumentList(OS, TemplateArgs.asArray(),
6564                                   getPrintingPolicy());
6565       }
6566     } else {
6567       S += '?';
6568     }
6569     if (ExpandStructures) {
6570       S += '=';
6571       if (!RDecl->isUnion()) {
6572         getObjCEncodingForStructureImpl(RDecl, S, FD, true, NotEncodedT);
6573       } else {
6574         for (const auto *Field : RDecl->fields()) {
6575           if (FD) {
6576             S += '"';
6577             S += Field->getNameAsString();
6578             S += '"';
6579           }
6580 
6581           // Special case bit-fields.
6582           if (Field->isBitField()) {
6583             getObjCEncodingForTypeImpl(Field->getType(), S, false, true,
6584                                        Field);
6585           } else {
6586             QualType qt = Field->getType();
6587             getLegacyIntegralTypeEncoding(qt);
6588             getObjCEncodingForTypeImpl(qt, S, false, true,
6589                                        FD, /*OutermostType*/false,
6590                                        /*EncodingProperty*/false,
6591                                        /*StructField*/true,
6592                                        false, false, false, NotEncodedT);
6593           }
6594         }
6595       }
6596     }
6597     S += RDecl->isUnion() ? ')' : '}';
6598     return;
6599   }
6600 
6601   case Type::BlockPointer: {
6602     const auto *BT = T->castAs<BlockPointerType>();
6603     S += "@?"; // Unlike a pointer-to-function, which is "^?".
6604     if (EncodeBlockParameters) {
6605       const auto *FT = BT->getPointeeType()->castAs<FunctionType>();
6606 
6607       S += '<';
6608       // Block return type
6609       getObjCEncodingForTypeImpl(
6610           FT->getReturnType(), S, ExpandPointedToStructures, ExpandStructures,
6611           FD, false /* OutermostType */, EncodingProperty,
6612           false /* StructField */, EncodeBlockParameters, EncodeClassNames, false,
6613                                  NotEncodedT);
6614       // Block self
6615       S += "@?";
6616       // Block parameters
6617       if (const auto *FPT = dyn_cast<FunctionProtoType>(FT)) {
6618         for (const auto &I : FPT->param_types())
6619           getObjCEncodingForTypeImpl(
6620               I, S, ExpandPointedToStructures, ExpandStructures, FD,
6621               false /* OutermostType */, EncodingProperty,
6622               false /* StructField */, EncodeBlockParameters, EncodeClassNames,
6623                                      false, NotEncodedT);
6624       }
6625       S += '>';
6626     }
6627     return;
6628   }
6629 
6630   case Type::ObjCObject: {
6631     // hack to match legacy encoding of *id and *Class
6632     QualType Ty = getObjCObjectPointerType(CT);
6633     if (Ty->isObjCIdType()) {
6634       S += "{objc_object=}";
6635       return;
6636     }
6637     else if (Ty->isObjCClassType()) {
6638       S += "{objc_class=}";
6639       return;
6640     }
6641     // TODO: Double check to make sure this intentionally falls through.
6642     LLVM_FALLTHROUGH;
6643   }
6644 
6645   case Type::ObjCInterface: {
6646     // Ignore protocol qualifiers when mangling at this level.
6647     // @encode(class_name)
6648     ObjCInterfaceDecl *OI = T->castAs<ObjCObjectType>()->getInterface();
6649     S += '{';
6650     S += OI->getObjCRuntimeNameAsString();
6651     if (ExpandStructures) {
6652       S += '=';
6653       SmallVector<const ObjCIvarDecl*, 32> Ivars;
6654       DeepCollectObjCIvars(OI, true, Ivars);
6655       for (unsigned i = 0, e = Ivars.size(); i != e; ++i) {
6656         const FieldDecl *Field = Ivars[i];
6657         if (Field->isBitField())
6658           getObjCEncodingForTypeImpl(Field->getType(), S, false, true, Field);
6659         else
6660           getObjCEncodingForTypeImpl(Field->getType(), S, false, true, FD,
6661                                      false, false, false, false, false,
6662                                      EncodePointerToObjCTypedef,
6663                                      NotEncodedT);
6664       }
6665     }
6666     S += '}';
6667     return;
6668   }
6669 
6670   case Type::ObjCObjectPointer: {
6671     const auto *OPT = T->castAs<ObjCObjectPointerType>();
6672     if (OPT->isObjCIdType()) {
6673       S += '@';
6674       return;
6675     }
6676 
6677     if (OPT->isObjCClassType() || OPT->isObjCQualifiedClassType()) {
6678       // FIXME: Consider if we need to output qualifiers for 'Class<p>'.
6679       // Since this is a binary compatibility issue, need to consult with runtime
6680       // folks. Fortunately, this is a *very* obscure construct.
6681       S += '#';
6682       return;
6683     }
6684 
6685     if (OPT->isObjCQualifiedIdType()) {
6686       getObjCEncodingForTypeImpl(getObjCIdType(), S,
6687                                  ExpandPointedToStructures,
6688                                  ExpandStructures, FD);
6689       if (FD || EncodingProperty || EncodeClassNames) {
6690         // Note that we do extended encoding of protocol qualifer list
6691         // Only when doing ivar or property encoding.
6692         S += '"';
6693         for (const auto *I : OPT->quals()) {
6694           S += '<';
6695           S += I->getObjCRuntimeNameAsString();
6696           S += '>';
6697         }
6698         S += '"';
6699       }
6700       return;
6701     }
6702 
6703     QualType PointeeTy = OPT->getPointeeType();
6704     if (!EncodingProperty &&
6705         isa<TypedefType>(PointeeTy.getTypePtr()) &&
6706         !EncodePointerToObjCTypedef) {
6707       // Another historical/compatibility reason.
6708       // We encode the underlying type which comes out as
6709       // {...};
6710       S += '^';
6711       if (FD && OPT->getInterfaceDecl()) {
6712         // Prevent recursive encoding of fields in some rare cases.
6713         ObjCInterfaceDecl *OI = OPT->getInterfaceDecl();
6714         SmallVector<const ObjCIvarDecl*, 32> Ivars;
6715         DeepCollectObjCIvars(OI, true, Ivars);
6716         for (unsigned i = 0, e = Ivars.size(); i != e; ++i) {
6717           if (Ivars[i] == FD) {
6718             S += '{';
6719             S += OI->getObjCRuntimeNameAsString();
6720             S += '}';
6721             return;
6722           }
6723         }
6724       }
6725       getObjCEncodingForTypeImpl(PointeeTy, S,
6726                                  false, ExpandPointedToStructures,
6727                                  nullptr,
6728                                  false, false, false, false, false,
6729                                  /*EncodePointerToObjCTypedef*/true);
6730       return;
6731     }
6732 
6733     S += '@';
6734     if (OPT->getInterfaceDecl() &&
6735         (FD || EncodingProperty || EncodeClassNames)) {
6736       S += '"';
6737       S += OPT->getInterfaceDecl()->getObjCRuntimeNameAsString();
6738       for (const auto *I : OPT->quals()) {
6739         S += '<';
6740         S += I->getObjCRuntimeNameAsString();
6741         S += '>';
6742       }
6743       S += '"';
6744     }
6745     return;
6746   }
6747 
6748   // gcc just blithely ignores member pointers.
6749   // FIXME: we shoul do better than that.  'M' is available.
6750   case Type::MemberPointer:
6751   // This matches gcc's encoding, even though technically it is insufficient.
6752   //FIXME. We should do a better job than gcc.
6753   case Type::Vector:
6754   case Type::ExtVector:
6755   // Until we have a coherent encoding of these three types, issue warning.
6756     if (NotEncodedT)
6757       *NotEncodedT = T;
6758     return;
6759 
6760   // We could see an undeduced auto type here during error recovery.
6761   // Just ignore it.
6762   case Type::Auto:
6763   case Type::DeducedTemplateSpecialization:
6764     return;
6765 
6766   case Type::Pipe:
6767 #define ABSTRACT_TYPE(KIND, BASE)
6768 #define TYPE(KIND, BASE)
6769 #define DEPENDENT_TYPE(KIND, BASE) \
6770   case Type::KIND:
6771 #define NON_CANONICAL_TYPE(KIND, BASE) \
6772   case Type::KIND:
6773 #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(KIND, BASE) \
6774   case Type::KIND:
6775 #include "clang/AST/TypeNodes.def"
6776     llvm_unreachable("@encode for dependent type!");
6777   }
6778   llvm_unreachable("bad type kind!");
6779 }
6780 
6781 void ASTContext::getObjCEncodingForStructureImpl(RecordDecl *RDecl,
6782                                                  std::string &S,
6783                                                  const FieldDecl *FD,
6784                                                  bool includeVBases,
6785                                                  QualType *NotEncodedT) const {
6786   assert(RDecl && "Expected non-null RecordDecl");
6787   assert(!RDecl->isUnion() && "Should not be called for unions");
6788   if (!RDecl->getDefinition() || RDecl->getDefinition()->isInvalidDecl())
6789     return;
6790 
6791   const auto *CXXRec = dyn_cast<CXXRecordDecl>(RDecl);
6792   std::multimap<uint64_t, NamedDecl *> FieldOrBaseOffsets;
6793   const ASTRecordLayout &layout = getASTRecordLayout(RDecl);
6794 
6795   if (CXXRec) {
6796     for (const auto &BI : CXXRec->bases()) {
6797       if (!BI.isVirtual()) {
6798         CXXRecordDecl *base = BI.getType()->getAsCXXRecordDecl();
6799         if (base->isEmpty())
6800           continue;
6801         uint64_t offs = toBits(layout.getBaseClassOffset(base));
6802         FieldOrBaseOffsets.insert(FieldOrBaseOffsets.upper_bound(offs),
6803                                   std::make_pair(offs, base));
6804       }
6805     }
6806   }
6807 
6808   unsigned i = 0;
6809   for (auto *Field : RDecl->fields()) {
6810     uint64_t offs = layout.getFieldOffset(i);
6811     FieldOrBaseOffsets.insert(FieldOrBaseOffsets.upper_bound(offs),
6812                               std::make_pair(offs, Field));
6813     ++i;
6814   }
6815 
6816   if (CXXRec && includeVBases) {
6817     for (const auto &BI : CXXRec->vbases()) {
6818       CXXRecordDecl *base = BI.getType()->getAsCXXRecordDecl();
6819       if (base->isEmpty())
6820         continue;
6821       uint64_t offs = toBits(layout.getVBaseClassOffset(base));
6822       if (offs >= uint64_t(toBits(layout.getNonVirtualSize())) &&
6823           FieldOrBaseOffsets.find(offs) == FieldOrBaseOffsets.end())
6824         FieldOrBaseOffsets.insert(FieldOrBaseOffsets.end(),
6825                                   std::make_pair(offs, base));
6826     }
6827   }
6828 
6829   CharUnits size;
6830   if (CXXRec) {
6831     size = includeVBases ? layout.getSize() : layout.getNonVirtualSize();
6832   } else {
6833     size = layout.getSize();
6834   }
6835 
6836 #ifndef NDEBUG
6837   uint64_t CurOffs = 0;
6838 #endif
6839   std::multimap<uint64_t, NamedDecl *>::iterator
6840     CurLayObj = FieldOrBaseOffsets.begin();
6841 
6842   if (CXXRec && CXXRec->isDynamicClass() &&
6843       (CurLayObj == FieldOrBaseOffsets.end() || CurLayObj->first != 0)) {
6844     if (FD) {
6845       S += "\"_vptr$";
6846       std::string recname = CXXRec->getNameAsString();
6847       if (recname.empty()) recname = "?";
6848       S += recname;
6849       S += '"';
6850     }
6851     S += "^^?";
6852 #ifndef NDEBUG
6853     CurOffs += getTypeSize(VoidPtrTy);
6854 #endif
6855   }
6856 
6857   if (!RDecl->hasFlexibleArrayMember()) {
6858     // Mark the end of the structure.
6859     uint64_t offs = toBits(size);
6860     FieldOrBaseOffsets.insert(FieldOrBaseOffsets.upper_bound(offs),
6861                               std::make_pair(offs, nullptr));
6862   }
6863 
6864   for (; CurLayObj != FieldOrBaseOffsets.end(); ++CurLayObj) {
6865 #ifndef NDEBUG
6866     assert(CurOffs <= CurLayObj->first);
6867     if (CurOffs < CurLayObj->first) {
6868       uint64_t padding = CurLayObj->first - CurOffs;
6869       // FIXME: There doesn't seem to be a way to indicate in the encoding that
6870       // packing/alignment of members is different that normal, in which case
6871       // the encoding will be out-of-sync with the real layout.
6872       // If the runtime switches to just consider the size of types without
6873       // taking into account alignment, we could make padding explicit in the
6874       // encoding (e.g. using arrays of chars). The encoding strings would be
6875       // longer then though.
6876       CurOffs += padding;
6877     }
6878 #endif
6879 
6880     NamedDecl *dcl = CurLayObj->second;
6881     if (!dcl)
6882       break; // reached end of structure.
6883 
6884     if (auto *base = dyn_cast<CXXRecordDecl>(dcl)) {
6885       // We expand the bases without their virtual bases since those are going
6886       // in the initial structure. Note that this differs from gcc which
6887       // expands virtual bases each time one is encountered in the hierarchy,
6888       // making the encoding type bigger than it really is.
6889       getObjCEncodingForStructureImpl(base, S, FD, /*includeVBases*/false,
6890                                       NotEncodedT);
6891       assert(!base->isEmpty());
6892 #ifndef NDEBUG
6893       CurOffs += toBits(getASTRecordLayout(base).getNonVirtualSize());
6894 #endif
6895     } else {
6896       const auto *field = cast<FieldDecl>(dcl);
6897       if (FD) {
6898         S += '"';
6899         S += field->getNameAsString();
6900         S += '"';
6901       }
6902 
6903       if (field->isBitField()) {
6904         EncodeBitField(this, S, field->getType(), field);
6905 #ifndef NDEBUG
6906         CurOffs += field->getBitWidthValue(*this);
6907 #endif
6908       } else {
6909         QualType qt = field->getType();
6910         getLegacyIntegralTypeEncoding(qt);
6911         getObjCEncodingForTypeImpl(qt, S, false, true, FD,
6912                                    /*OutermostType*/false,
6913                                    /*EncodingProperty*/false,
6914                                    /*StructField*/true,
6915                                    false, false, false, NotEncodedT);
6916 #ifndef NDEBUG
6917         CurOffs += getTypeSize(field->getType());
6918 #endif
6919       }
6920     }
6921   }
6922 }
6923 
6924 void ASTContext::getObjCEncodingForTypeQualifier(Decl::ObjCDeclQualifier QT,
6925                                                  std::string& S) const {
6926   if (QT & Decl::OBJC_TQ_In)
6927     S += 'n';
6928   if (QT & Decl::OBJC_TQ_Inout)
6929     S += 'N';
6930   if (QT & Decl::OBJC_TQ_Out)
6931     S += 'o';
6932   if (QT & Decl::OBJC_TQ_Bycopy)
6933     S += 'O';
6934   if (QT & Decl::OBJC_TQ_Byref)
6935     S += 'R';
6936   if (QT & Decl::OBJC_TQ_Oneway)
6937     S += 'V';
6938 }
6939 
6940 TypedefDecl *ASTContext::getObjCIdDecl() const {
6941   if (!ObjCIdDecl) {
6942     QualType T = getObjCObjectType(ObjCBuiltinIdTy, {}, {});
6943     T = getObjCObjectPointerType(T);
6944     ObjCIdDecl = buildImplicitTypedef(T, "id");
6945   }
6946   return ObjCIdDecl;
6947 }
6948 
6949 TypedefDecl *ASTContext::getObjCSelDecl() const {
6950   if (!ObjCSelDecl) {
6951     QualType T = getPointerType(ObjCBuiltinSelTy);
6952     ObjCSelDecl = buildImplicitTypedef(T, "SEL");
6953   }
6954   return ObjCSelDecl;
6955 }
6956 
6957 TypedefDecl *ASTContext::getObjCClassDecl() const {
6958   if (!ObjCClassDecl) {
6959     QualType T = getObjCObjectType(ObjCBuiltinClassTy, {}, {});
6960     T = getObjCObjectPointerType(T);
6961     ObjCClassDecl = buildImplicitTypedef(T, "Class");
6962   }
6963   return ObjCClassDecl;
6964 }
6965 
6966 ObjCInterfaceDecl *ASTContext::getObjCProtocolDecl() const {
6967   if (!ObjCProtocolClassDecl) {
6968     ObjCProtocolClassDecl
6969       = ObjCInterfaceDecl::Create(*this, getTranslationUnitDecl(),
6970                                   SourceLocation(),
6971                                   &Idents.get("Protocol"),
6972                                   /*typeParamList=*/nullptr,
6973                                   /*PrevDecl=*/nullptr,
6974                                   SourceLocation(), true);
6975   }
6976 
6977   return ObjCProtocolClassDecl;
6978 }
6979 
6980 //===----------------------------------------------------------------------===//
6981 // __builtin_va_list Construction Functions
6982 //===----------------------------------------------------------------------===//
6983 
6984 static TypedefDecl *CreateCharPtrNamedVaListDecl(const ASTContext *Context,
6985                                                  StringRef Name) {
6986   // typedef char* __builtin[_ms]_va_list;
6987   QualType T = Context->getPointerType(Context->CharTy);
6988   return Context->buildImplicitTypedef(T, Name);
6989 }
6990 
6991 static TypedefDecl *CreateMSVaListDecl(const ASTContext *Context) {
6992   return CreateCharPtrNamedVaListDecl(Context, "__builtin_ms_va_list");
6993 }
6994 
6995 static TypedefDecl *CreateCharPtrBuiltinVaListDecl(const ASTContext *Context) {
6996   return CreateCharPtrNamedVaListDecl(Context, "__builtin_va_list");
6997 }
6998 
6999 static TypedefDecl *CreateVoidPtrBuiltinVaListDecl(const ASTContext *Context) {
7000   // typedef void* __builtin_va_list;
7001   QualType T = Context->getPointerType(Context->VoidTy);
7002   return Context->buildImplicitTypedef(T, "__builtin_va_list");
7003 }
7004 
7005 static TypedefDecl *
7006 CreateAArch64ABIBuiltinVaListDecl(const ASTContext *Context) {
7007   // struct __va_list
7008   RecordDecl *VaListTagDecl = Context->buildImplicitRecord("__va_list");
7009   if (Context->getLangOpts().CPlusPlus) {
7010     // namespace std { struct __va_list {
7011     NamespaceDecl *NS;
7012     NS = NamespaceDecl::Create(const_cast<ASTContext &>(*Context),
7013                                Context->getTranslationUnitDecl(),
7014                                /*Inline*/ false, SourceLocation(),
7015                                SourceLocation(), &Context->Idents.get("std"),
7016                                /*PrevDecl*/ nullptr);
7017     NS->setImplicit();
7018     VaListTagDecl->setDeclContext(NS);
7019   }
7020 
7021   VaListTagDecl->startDefinition();
7022 
7023   const size_t NumFields = 5;
7024   QualType FieldTypes[NumFields];
7025   const char *FieldNames[NumFields];
7026 
7027   // void *__stack;
7028   FieldTypes[0] = Context->getPointerType(Context->VoidTy);
7029   FieldNames[0] = "__stack";
7030 
7031   // void *__gr_top;
7032   FieldTypes[1] = Context->getPointerType(Context->VoidTy);
7033   FieldNames[1] = "__gr_top";
7034 
7035   // void *__vr_top;
7036   FieldTypes[2] = Context->getPointerType(Context->VoidTy);
7037   FieldNames[2] = "__vr_top";
7038 
7039   // int __gr_offs;
7040   FieldTypes[3] = Context->IntTy;
7041   FieldNames[3] = "__gr_offs";
7042 
7043   // int __vr_offs;
7044   FieldTypes[4] = Context->IntTy;
7045   FieldNames[4] = "__vr_offs";
7046 
7047   // Create fields
7048   for (unsigned i = 0; i < NumFields; ++i) {
7049     FieldDecl *Field = FieldDecl::Create(const_cast<ASTContext &>(*Context),
7050                                          VaListTagDecl,
7051                                          SourceLocation(),
7052                                          SourceLocation(),
7053                                          &Context->Idents.get(FieldNames[i]),
7054                                          FieldTypes[i], /*TInfo=*/nullptr,
7055                                          /*BitWidth=*/nullptr,
7056                                          /*Mutable=*/false,
7057                                          ICIS_NoInit);
7058     Field->setAccess(AS_public);
7059     VaListTagDecl->addDecl(Field);
7060   }
7061   VaListTagDecl->completeDefinition();
7062   Context->VaListTagDecl = VaListTagDecl;
7063   QualType VaListTagType = Context->getRecordType(VaListTagDecl);
7064 
7065   // } __builtin_va_list;
7066   return Context->buildImplicitTypedef(VaListTagType, "__builtin_va_list");
7067 }
7068 
7069 static TypedefDecl *CreatePowerABIBuiltinVaListDecl(const ASTContext *Context) {
7070   // typedef struct __va_list_tag {
7071   RecordDecl *VaListTagDecl;
7072 
7073   VaListTagDecl = Context->buildImplicitRecord("__va_list_tag");
7074   VaListTagDecl->startDefinition();
7075 
7076   const size_t NumFields = 5;
7077   QualType FieldTypes[NumFields];
7078   const char *FieldNames[NumFields];
7079 
7080   //   unsigned char gpr;
7081   FieldTypes[0] = Context->UnsignedCharTy;
7082   FieldNames[0] = "gpr";
7083 
7084   //   unsigned char fpr;
7085   FieldTypes[1] = Context->UnsignedCharTy;
7086   FieldNames[1] = "fpr";
7087 
7088   //   unsigned short reserved;
7089   FieldTypes[2] = Context->UnsignedShortTy;
7090   FieldNames[2] = "reserved";
7091 
7092   //   void* overflow_arg_area;
7093   FieldTypes[3] = Context->getPointerType(Context->VoidTy);
7094   FieldNames[3] = "overflow_arg_area";
7095 
7096   //   void* reg_save_area;
7097   FieldTypes[4] = Context->getPointerType(Context->VoidTy);
7098   FieldNames[4] = "reg_save_area";
7099 
7100   // Create fields
7101   for (unsigned i = 0; i < NumFields; ++i) {
7102     FieldDecl *Field = FieldDecl::Create(*Context, VaListTagDecl,
7103                                          SourceLocation(),
7104                                          SourceLocation(),
7105                                          &Context->Idents.get(FieldNames[i]),
7106                                          FieldTypes[i], /*TInfo=*/nullptr,
7107                                          /*BitWidth=*/nullptr,
7108                                          /*Mutable=*/false,
7109                                          ICIS_NoInit);
7110     Field->setAccess(AS_public);
7111     VaListTagDecl->addDecl(Field);
7112   }
7113   VaListTagDecl->completeDefinition();
7114   Context->VaListTagDecl = VaListTagDecl;
7115   QualType VaListTagType = Context->getRecordType(VaListTagDecl);
7116 
7117   // } __va_list_tag;
7118   TypedefDecl *VaListTagTypedefDecl =
7119       Context->buildImplicitTypedef(VaListTagType, "__va_list_tag");
7120 
7121   QualType VaListTagTypedefType =
7122     Context->getTypedefType(VaListTagTypedefDecl);
7123 
7124   // typedef __va_list_tag __builtin_va_list[1];
7125   llvm::APInt Size(Context->getTypeSize(Context->getSizeType()), 1);
7126   QualType VaListTagArrayType
7127     = Context->getConstantArrayType(VaListTagTypedefType,
7128                                     Size, ArrayType::Normal, 0);
7129   return Context->buildImplicitTypedef(VaListTagArrayType, "__builtin_va_list");
7130 }
7131 
7132 static TypedefDecl *
7133 CreateX86_64ABIBuiltinVaListDecl(const ASTContext *Context) {
7134   // struct __va_list_tag {
7135   RecordDecl *VaListTagDecl;
7136   VaListTagDecl = Context->buildImplicitRecord("__va_list_tag");
7137   VaListTagDecl->startDefinition();
7138 
7139   const size_t NumFields = 4;
7140   QualType FieldTypes[NumFields];
7141   const char *FieldNames[NumFields];
7142 
7143   //   unsigned gp_offset;
7144   FieldTypes[0] = Context->UnsignedIntTy;
7145   FieldNames[0] = "gp_offset";
7146 
7147   //   unsigned fp_offset;
7148   FieldTypes[1] = Context->UnsignedIntTy;
7149   FieldNames[1] = "fp_offset";
7150 
7151   //   void* overflow_arg_area;
7152   FieldTypes[2] = Context->getPointerType(Context->VoidTy);
7153   FieldNames[2] = "overflow_arg_area";
7154 
7155   //   void* reg_save_area;
7156   FieldTypes[3] = Context->getPointerType(Context->VoidTy);
7157   FieldNames[3] = "reg_save_area";
7158 
7159   // Create fields
7160   for (unsigned i = 0; i < NumFields; ++i) {
7161     FieldDecl *Field = FieldDecl::Create(const_cast<ASTContext &>(*Context),
7162                                          VaListTagDecl,
7163                                          SourceLocation(),
7164                                          SourceLocation(),
7165                                          &Context->Idents.get(FieldNames[i]),
7166                                          FieldTypes[i], /*TInfo=*/nullptr,
7167                                          /*BitWidth=*/nullptr,
7168                                          /*Mutable=*/false,
7169                                          ICIS_NoInit);
7170     Field->setAccess(AS_public);
7171     VaListTagDecl->addDecl(Field);
7172   }
7173   VaListTagDecl->completeDefinition();
7174   Context->VaListTagDecl = VaListTagDecl;
7175   QualType VaListTagType = Context->getRecordType(VaListTagDecl);
7176 
7177   // };
7178 
7179   // typedef struct __va_list_tag __builtin_va_list[1];
7180   llvm::APInt Size(Context->getTypeSize(Context->getSizeType()), 1);
7181   QualType VaListTagArrayType =
7182       Context->getConstantArrayType(VaListTagType, Size, ArrayType::Normal, 0);
7183   return Context->buildImplicitTypedef(VaListTagArrayType, "__builtin_va_list");
7184 }
7185 
7186 static TypedefDecl *CreatePNaClABIBuiltinVaListDecl(const ASTContext *Context) {
7187   // typedef int __builtin_va_list[4];
7188   llvm::APInt Size(Context->getTypeSize(Context->getSizeType()), 4);
7189   QualType IntArrayType =
7190       Context->getConstantArrayType(Context->IntTy, Size, ArrayType::Normal, 0);
7191   return Context->buildImplicitTypedef(IntArrayType, "__builtin_va_list");
7192 }
7193 
7194 static TypedefDecl *
7195 CreateAAPCSABIBuiltinVaListDecl(const ASTContext *Context) {
7196   // struct __va_list
7197   RecordDecl *VaListDecl = Context->buildImplicitRecord("__va_list");
7198   if (Context->getLangOpts().CPlusPlus) {
7199     // namespace std { struct __va_list {
7200     NamespaceDecl *NS;
7201     NS = NamespaceDecl::Create(const_cast<ASTContext &>(*Context),
7202                                Context->getTranslationUnitDecl(),
7203                                /*Inline*/false, SourceLocation(),
7204                                SourceLocation(), &Context->Idents.get("std"),
7205                                /*PrevDecl*/ nullptr);
7206     NS->setImplicit();
7207     VaListDecl->setDeclContext(NS);
7208   }
7209 
7210   VaListDecl->startDefinition();
7211 
7212   // void * __ap;
7213   FieldDecl *Field = FieldDecl::Create(const_cast<ASTContext &>(*Context),
7214                                        VaListDecl,
7215                                        SourceLocation(),
7216                                        SourceLocation(),
7217                                        &Context->Idents.get("__ap"),
7218                                        Context->getPointerType(Context->VoidTy),
7219                                        /*TInfo=*/nullptr,
7220                                        /*BitWidth=*/nullptr,
7221                                        /*Mutable=*/false,
7222                                        ICIS_NoInit);
7223   Field->setAccess(AS_public);
7224   VaListDecl->addDecl(Field);
7225 
7226   // };
7227   VaListDecl->completeDefinition();
7228   Context->VaListTagDecl = VaListDecl;
7229 
7230   // typedef struct __va_list __builtin_va_list;
7231   QualType T = Context->getRecordType(VaListDecl);
7232   return Context->buildImplicitTypedef(T, "__builtin_va_list");
7233 }
7234 
7235 static TypedefDecl *
7236 CreateSystemZBuiltinVaListDecl(const ASTContext *Context) {
7237   // struct __va_list_tag {
7238   RecordDecl *VaListTagDecl;
7239   VaListTagDecl = Context->buildImplicitRecord("__va_list_tag");
7240   VaListTagDecl->startDefinition();
7241 
7242   const size_t NumFields = 4;
7243   QualType FieldTypes[NumFields];
7244   const char *FieldNames[NumFields];
7245 
7246   //   long __gpr;
7247   FieldTypes[0] = Context->LongTy;
7248   FieldNames[0] = "__gpr";
7249 
7250   //   long __fpr;
7251   FieldTypes[1] = Context->LongTy;
7252   FieldNames[1] = "__fpr";
7253 
7254   //   void *__overflow_arg_area;
7255   FieldTypes[2] = Context->getPointerType(Context->VoidTy);
7256   FieldNames[2] = "__overflow_arg_area";
7257 
7258   //   void *__reg_save_area;
7259   FieldTypes[3] = Context->getPointerType(Context->VoidTy);
7260   FieldNames[3] = "__reg_save_area";
7261 
7262   // Create fields
7263   for (unsigned i = 0; i < NumFields; ++i) {
7264     FieldDecl *Field = FieldDecl::Create(const_cast<ASTContext &>(*Context),
7265                                          VaListTagDecl,
7266                                          SourceLocation(),
7267                                          SourceLocation(),
7268                                          &Context->Idents.get(FieldNames[i]),
7269                                          FieldTypes[i], /*TInfo=*/nullptr,
7270                                          /*BitWidth=*/nullptr,
7271                                          /*Mutable=*/false,
7272                                          ICIS_NoInit);
7273     Field->setAccess(AS_public);
7274     VaListTagDecl->addDecl(Field);
7275   }
7276   VaListTagDecl->completeDefinition();
7277   Context->VaListTagDecl = VaListTagDecl;
7278   QualType VaListTagType = Context->getRecordType(VaListTagDecl);
7279 
7280   // };
7281 
7282   // typedef __va_list_tag __builtin_va_list[1];
7283   llvm::APInt Size(Context->getTypeSize(Context->getSizeType()), 1);
7284   QualType VaListTagArrayType =
7285       Context->getConstantArrayType(VaListTagType, Size, ArrayType::Normal, 0);
7286 
7287   return Context->buildImplicitTypedef(VaListTagArrayType, "__builtin_va_list");
7288 }
7289 
7290 static TypedefDecl *CreateVaListDecl(const ASTContext *Context,
7291                                      TargetInfo::BuiltinVaListKind Kind) {
7292   switch (Kind) {
7293   case TargetInfo::CharPtrBuiltinVaList:
7294     return CreateCharPtrBuiltinVaListDecl(Context);
7295   case TargetInfo::VoidPtrBuiltinVaList:
7296     return CreateVoidPtrBuiltinVaListDecl(Context);
7297   case TargetInfo::AArch64ABIBuiltinVaList:
7298     return CreateAArch64ABIBuiltinVaListDecl(Context);
7299   case TargetInfo::PowerABIBuiltinVaList:
7300     return CreatePowerABIBuiltinVaListDecl(Context);
7301   case TargetInfo::X86_64ABIBuiltinVaList:
7302     return CreateX86_64ABIBuiltinVaListDecl(Context);
7303   case TargetInfo::PNaClABIBuiltinVaList:
7304     return CreatePNaClABIBuiltinVaListDecl(Context);
7305   case TargetInfo::AAPCSABIBuiltinVaList:
7306     return CreateAAPCSABIBuiltinVaListDecl(Context);
7307   case TargetInfo::SystemZBuiltinVaList:
7308     return CreateSystemZBuiltinVaListDecl(Context);
7309   }
7310 
7311   llvm_unreachable("Unhandled __builtin_va_list type kind");
7312 }
7313 
7314 TypedefDecl *ASTContext::getBuiltinVaListDecl() const {
7315   if (!BuiltinVaListDecl) {
7316     BuiltinVaListDecl = CreateVaListDecl(this, Target->getBuiltinVaListKind());
7317     assert(BuiltinVaListDecl->isImplicit());
7318   }
7319 
7320   return BuiltinVaListDecl;
7321 }
7322 
7323 Decl *ASTContext::getVaListTagDecl() const {
7324   // Force the creation of VaListTagDecl by building the __builtin_va_list
7325   // declaration.
7326   if (!VaListTagDecl)
7327     (void)getBuiltinVaListDecl();
7328 
7329   return VaListTagDecl;
7330 }
7331 
7332 TypedefDecl *ASTContext::getBuiltinMSVaListDecl() const {
7333   if (!BuiltinMSVaListDecl)
7334     BuiltinMSVaListDecl = CreateMSVaListDecl(this);
7335 
7336   return BuiltinMSVaListDecl;
7337 }
7338 
7339 bool ASTContext::canBuiltinBeRedeclared(const FunctionDecl *FD) const {
7340   return BuiltinInfo.canBeRedeclared(FD->getBuiltinID());
7341 }
7342 
7343 void ASTContext::setObjCConstantStringInterface(ObjCInterfaceDecl *Decl) {
7344   assert(ObjCConstantStringType.isNull() &&
7345          "'NSConstantString' type already set!");
7346 
7347   ObjCConstantStringType = getObjCInterfaceType(Decl);
7348 }
7349 
7350 /// Retrieve the template name that corresponds to a non-empty
7351 /// lookup.
7352 TemplateName
7353 ASTContext::getOverloadedTemplateName(UnresolvedSetIterator Begin,
7354                                       UnresolvedSetIterator End) const {
7355   unsigned size = End - Begin;
7356   assert(size > 1 && "set is not overloaded!");
7357 
7358   void *memory = Allocate(sizeof(OverloadedTemplateStorage) +
7359                           size * sizeof(FunctionTemplateDecl*));
7360   auto *OT = new (memory) OverloadedTemplateStorage(size);
7361 
7362   NamedDecl **Storage = OT->getStorage();
7363   for (UnresolvedSetIterator I = Begin; I != End; ++I) {
7364     NamedDecl *D = *I;
7365     assert(isa<FunctionTemplateDecl>(D) ||
7366            isa<UnresolvedUsingValueDecl>(D) ||
7367            (isa<UsingShadowDecl>(D) &&
7368             isa<FunctionTemplateDecl>(D->getUnderlyingDecl())));
7369     *Storage++ = D;
7370   }
7371 
7372   return TemplateName(OT);
7373 }
7374 
7375 /// Retrieve the template name that represents a qualified
7376 /// template name such as \c std::vector.
7377 TemplateName
7378 ASTContext::getQualifiedTemplateName(NestedNameSpecifier *NNS,
7379                                      bool TemplateKeyword,
7380                                      TemplateDecl *Template) const {
7381   assert(NNS && "Missing nested-name-specifier in qualified template name");
7382 
7383   // FIXME: Canonicalization?
7384   llvm::FoldingSetNodeID ID;
7385   QualifiedTemplateName::Profile(ID, NNS, TemplateKeyword, Template);
7386 
7387   void *InsertPos = nullptr;
7388   QualifiedTemplateName *QTN =
7389     QualifiedTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
7390   if (!QTN) {
7391     QTN = new (*this, alignof(QualifiedTemplateName))
7392         QualifiedTemplateName(NNS, TemplateKeyword, Template);
7393     QualifiedTemplateNames.InsertNode(QTN, InsertPos);
7394   }
7395 
7396   return TemplateName(QTN);
7397 }
7398 
7399 /// Retrieve the template name that represents a dependent
7400 /// template name such as \c MetaFun::template apply.
7401 TemplateName
7402 ASTContext::getDependentTemplateName(NestedNameSpecifier *NNS,
7403                                      const IdentifierInfo *Name) const {
7404   assert((!NNS || NNS->isDependent()) &&
7405          "Nested name specifier must be dependent");
7406 
7407   llvm::FoldingSetNodeID ID;
7408   DependentTemplateName::Profile(ID, NNS, Name);
7409 
7410   void *InsertPos = nullptr;
7411   DependentTemplateName *QTN =
7412     DependentTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
7413 
7414   if (QTN)
7415     return TemplateName(QTN);
7416 
7417   NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
7418   if (CanonNNS == NNS) {
7419     QTN = new (*this, alignof(DependentTemplateName))
7420         DependentTemplateName(NNS, Name);
7421   } else {
7422     TemplateName Canon = getDependentTemplateName(CanonNNS, Name);
7423     QTN = new (*this, alignof(DependentTemplateName))
7424         DependentTemplateName(NNS, Name, Canon);
7425     DependentTemplateName *CheckQTN =
7426       DependentTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
7427     assert(!CheckQTN && "Dependent type name canonicalization broken");
7428     (void)CheckQTN;
7429   }
7430 
7431   DependentTemplateNames.InsertNode(QTN, InsertPos);
7432   return TemplateName(QTN);
7433 }
7434 
7435 /// Retrieve the template name that represents a dependent
7436 /// template name such as \c MetaFun::template operator+.
7437 TemplateName
7438 ASTContext::getDependentTemplateName(NestedNameSpecifier *NNS,
7439                                      OverloadedOperatorKind Operator) const {
7440   assert((!NNS || NNS->isDependent()) &&
7441          "Nested name specifier must be dependent");
7442 
7443   llvm::FoldingSetNodeID ID;
7444   DependentTemplateName::Profile(ID, NNS, Operator);
7445 
7446   void *InsertPos = nullptr;
7447   DependentTemplateName *QTN
7448     = DependentTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
7449 
7450   if (QTN)
7451     return TemplateName(QTN);
7452 
7453   NestedNameSpecifier *CanonNNS = getCanonicalNestedNameSpecifier(NNS);
7454   if (CanonNNS == NNS) {
7455     QTN = new (*this, alignof(DependentTemplateName))
7456         DependentTemplateName(NNS, Operator);
7457   } else {
7458     TemplateName Canon = getDependentTemplateName(CanonNNS, Operator);
7459     QTN = new (*this, alignof(DependentTemplateName))
7460         DependentTemplateName(NNS, Operator, Canon);
7461 
7462     DependentTemplateName *CheckQTN
7463       = DependentTemplateNames.FindNodeOrInsertPos(ID, InsertPos);
7464     assert(!CheckQTN && "Dependent template name canonicalization broken");
7465     (void)CheckQTN;
7466   }
7467 
7468   DependentTemplateNames.InsertNode(QTN, InsertPos);
7469   return TemplateName(QTN);
7470 }
7471 
7472 TemplateName
7473 ASTContext::getSubstTemplateTemplateParm(TemplateTemplateParmDecl *param,
7474                                          TemplateName replacement) const {
7475   llvm::FoldingSetNodeID ID;
7476   SubstTemplateTemplateParmStorage::Profile(ID, param, replacement);
7477 
7478   void *insertPos = nullptr;
7479   SubstTemplateTemplateParmStorage *subst
7480     = SubstTemplateTemplateParms.FindNodeOrInsertPos(ID, insertPos);
7481 
7482   if (!subst) {
7483     subst = new (*this) SubstTemplateTemplateParmStorage(param, replacement);
7484     SubstTemplateTemplateParms.InsertNode(subst, insertPos);
7485   }
7486 
7487   return TemplateName(subst);
7488 }
7489 
7490 TemplateName
7491 ASTContext::getSubstTemplateTemplateParmPack(TemplateTemplateParmDecl *Param,
7492                                        const TemplateArgument &ArgPack) const {
7493   auto &Self = const_cast<ASTContext &>(*this);
7494   llvm::FoldingSetNodeID ID;
7495   SubstTemplateTemplateParmPackStorage::Profile(ID, Self, Param, ArgPack);
7496 
7497   void *InsertPos = nullptr;
7498   SubstTemplateTemplateParmPackStorage *Subst
7499     = SubstTemplateTemplateParmPacks.FindNodeOrInsertPos(ID, InsertPos);
7500 
7501   if (!Subst) {
7502     Subst = new (*this) SubstTemplateTemplateParmPackStorage(Param,
7503                                                            ArgPack.pack_size(),
7504                                                          ArgPack.pack_begin());
7505     SubstTemplateTemplateParmPacks.InsertNode(Subst, InsertPos);
7506   }
7507 
7508   return TemplateName(Subst);
7509 }
7510 
7511 /// getFromTargetType - Given one of the integer types provided by
7512 /// TargetInfo, produce the corresponding type. The unsigned @p Type
7513 /// is actually a value of type @c TargetInfo::IntType.
7514 CanQualType ASTContext::getFromTargetType(unsigned Type) const {
7515   switch (Type) {
7516   case TargetInfo::NoInt: return {};
7517   case TargetInfo::SignedChar: return SignedCharTy;
7518   case TargetInfo::UnsignedChar: return UnsignedCharTy;
7519   case TargetInfo::SignedShort: return ShortTy;
7520   case TargetInfo::UnsignedShort: return UnsignedShortTy;
7521   case TargetInfo::SignedInt: return IntTy;
7522   case TargetInfo::UnsignedInt: return UnsignedIntTy;
7523   case TargetInfo::SignedLong: return LongTy;
7524   case TargetInfo::UnsignedLong: return UnsignedLongTy;
7525   case TargetInfo::SignedLongLong: return LongLongTy;
7526   case TargetInfo::UnsignedLongLong: return UnsignedLongLongTy;
7527   }
7528 
7529   llvm_unreachable("Unhandled TargetInfo::IntType value");
7530 }
7531 
7532 //===----------------------------------------------------------------------===//
7533 //                        Type Predicates.
7534 //===----------------------------------------------------------------------===//
7535 
7536 /// getObjCGCAttr - Returns one of GCNone, Weak or Strong objc's
7537 /// garbage collection attribute.
7538 ///
7539 Qualifiers::GC ASTContext::getObjCGCAttrKind(QualType Ty) const {
7540   if (getLangOpts().getGC() == LangOptions::NonGC)
7541     return Qualifiers::GCNone;
7542 
7543   assert(getLangOpts().ObjC1);
7544   Qualifiers::GC GCAttrs = Ty.getObjCGCAttr();
7545 
7546   // Default behaviour under objective-C's gc is for ObjC pointers
7547   // (or pointers to them) be treated as though they were declared
7548   // as __strong.
7549   if (GCAttrs == Qualifiers::GCNone) {
7550     if (Ty->isObjCObjectPointerType() || Ty->isBlockPointerType())
7551       return Qualifiers::Strong;
7552     else if (Ty->isPointerType())
7553       return getObjCGCAttrKind(Ty->getAs<PointerType>()->getPointeeType());
7554   } else {
7555     // It's not valid to set GC attributes on anything that isn't a
7556     // pointer.
7557 #ifndef NDEBUG
7558     QualType CT = Ty->getCanonicalTypeInternal();
7559     while (const auto *AT = dyn_cast<ArrayType>(CT))
7560       CT = AT->getElementType();
7561     assert(CT->isAnyPointerType() || CT->isBlockPointerType());
7562 #endif
7563   }
7564   return GCAttrs;
7565 }
7566 
7567 //===----------------------------------------------------------------------===//
7568 //                        Type Compatibility Testing
7569 //===----------------------------------------------------------------------===//
7570 
7571 /// areCompatVectorTypes - Return true if the two specified vector types are
7572 /// compatible.
7573 static bool areCompatVectorTypes(const VectorType *LHS,
7574                                  const VectorType *RHS) {
7575   assert(LHS->isCanonicalUnqualified() && RHS->isCanonicalUnqualified());
7576   return LHS->getElementType() == RHS->getElementType() &&
7577          LHS->getNumElements() == RHS->getNumElements();
7578 }
7579 
7580 bool ASTContext::areCompatibleVectorTypes(QualType FirstVec,
7581                                           QualType SecondVec) {
7582   assert(FirstVec->isVectorType() && "FirstVec should be a vector type");
7583   assert(SecondVec->isVectorType() && "SecondVec should be a vector type");
7584 
7585   if (hasSameUnqualifiedType(FirstVec, SecondVec))
7586     return true;
7587 
7588   // Treat Neon vector types and most AltiVec vector types as if they are the
7589   // equivalent GCC vector types.
7590   const auto *First = FirstVec->getAs<VectorType>();
7591   const auto *Second = SecondVec->getAs<VectorType>();
7592   if (First->getNumElements() == Second->getNumElements() &&
7593       hasSameType(First->getElementType(), Second->getElementType()) &&
7594       First->getVectorKind() != VectorType::AltiVecPixel &&
7595       First->getVectorKind() != VectorType::AltiVecBool &&
7596       Second->getVectorKind() != VectorType::AltiVecPixel &&
7597       Second->getVectorKind() != VectorType::AltiVecBool)
7598     return true;
7599 
7600   return false;
7601 }
7602 
7603 //===----------------------------------------------------------------------===//
7604 // ObjCQualifiedIdTypesAreCompatible - Compatibility testing for qualified id's.
7605 //===----------------------------------------------------------------------===//
7606 
7607 /// ProtocolCompatibleWithProtocol - return 'true' if 'lProto' is in the
7608 /// inheritance hierarchy of 'rProto'.
7609 bool
7610 ASTContext::ProtocolCompatibleWithProtocol(ObjCProtocolDecl *lProto,
7611                                            ObjCProtocolDecl *rProto) const {
7612   if (declaresSameEntity(lProto, rProto))
7613     return true;
7614   for (auto *PI : rProto->protocols())
7615     if (ProtocolCompatibleWithProtocol(lProto, PI))
7616       return true;
7617   return false;
7618 }
7619 
7620 /// ObjCQualifiedClassTypesAreCompatible - compare  Class<pr,...> and
7621 /// Class<pr1, ...>.
7622 bool ASTContext::ObjCQualifiedClassTypesAreCompatible(QualType lhs,
7623                                                       QualType rhs) {
7624   const auto *lhsQID = lhs->getAs<ObjCObjectPointerType>();
7625   const auto *rhsOPT = rhs->getAs<ObjCObjectPointerType>();
7626   assert((lhsQID && rhsOPT) && "ObjCQualifiedClassTypesAreCompatible");
7627 
7628   for (auto *lhsProto : lhsQID->quals()) {
7629     bool match = false;
7630     for (auto *rhsProto : rhsOPT->quals()) {
7631       if (ProtocolCompatibleWithProtocol(lhsProto, rhsProto)) {
7632         match = true;
7633         break;
7634       }
7635     }
7636     if (!match)
7637       return false;
7638   }
7639   return true;
7640 }
7641 
7642 /// ObjCQualifiedIdTypesAreCompatible - We know that one of lhs/rhs is an
7643 /// ObjCQualifiedIDType.
7644 bool ASTContext::ObjCQualifiedIdTypesAreCompatible(QualType lhs, QualType rhs,
7645                                                    bool compare) {
7646   // Allow id<P..> and an 'id' or void* type in all cases.
7647   if (lhs->isVoidPointerType() ||
7648       lhs->isObjCIdType() || lhs->isObjCClassType())
7649     return true;
7650   else if (rhs->isVoidPointerType() ||
7651            rhs->isObjCIdType() || rhs->isObjCClassType())
7652     return true;
7653 
7654   if (const ObjCObjectPointerType *lhsQID = lhs->getAsObjCQualifiedIdType()) {
7655     const auto *rhsOPT = rhs->getAs<ObjCObjectPointerType>();
7656 
7657     if (!rhsOPT) return false;
7658 
7659     if (rhsOPT->qual_empty()) {
7660       // If the RHS is a unqualified interface pointer "NSString*",
7661       // make sure we check the class hierarchy.
7662       if (ObjCInterfaceDecl *rhsID = rhsOPT->getInterfaceDecl()) {
7663         for (auto *I : lhsQID->quals()) {
7664           // when comparing an id<P> on lhs with a static type on rhs,
7665           // see if static class implements all of id's protocols, directly or
7666           // through its super class and categories.
7667           if (!rhsID->ClassImplementsProtocol(I, true))
7668             return false;
7669         }
7670       }
7671       // If there are no qualifiers and no interface, we have an 'id'.
7672       return true;
7673     }
7674     // Both the right and left sides have qualifiers.
7675     for (auto *lhsProto : lhsQID->quals()) {
7676       bool match = false;
7677 
7678       // when comparing an id<P> on lhs with a static type on rhs,
7679       // see if static class implements all of id's protocols, directly or
7680       // through its super class and categories.
7681       for (auto *rhsProto : rhsOPT->quals()) {
7682         if (ProtocolCompatibleWithProtocol(lhsProto, rhsProto) ||
7683             (compare && ProtocolCompatibleWithProtocol(rhsProto, lhsProto))) {
7684           match = true;
7685           break;
7686         }
7687       }
7688       // If the RHS is a qualified interface pointer "NSString<P>*",
7689       // make sure we check the class hierarchy.
7690       if (ObjCInterfaceDecl *rhsID = rhsOPT->getInterfaceDecl()) {
7691         for (auto *I : lhsQID->quals()) {
7692           // when comparing an id<P> on lhs with a static type on rhs,
7693           // see if static class implements all of id's protocols, directly or
7694           // through its super class and categories.
7695           if (rhsID->ClassImplementsProtocol(I, true)) {
7696             match = true;
7697             break;
7698           }
7699         }
7700       }
7701       if (!match)
7702         return false;
7703     }
7704 
7705     return true;
7706   }
7707 
7708   const ObjCObjectPointerType *rhsQID = rhs->getAsObjCQualifiedIdType();
7709   assert(rhsQID && "One of the LHS/RHS should be id<x>");
7710 
7711   if (const ObjCObjectPointerType *lhsOPT =
7712         lhs->getAsObjCInterfacePointerType()) {
7713     // If both the right and left sides have qualifiers.
7714     for (auto *lhsProto : lhsOPT->quals()) {
7715       bool match = false;
7716 
7717       // when comparing an id<P> on rhs with a static type on lhs,
7718       // see if static class implements all of id's protocols, directly or
7719       // through its super class and categories.
7720       // First, lhs protocols in the qualifier list must be found, direct
7721       // or indirect in rhs's qualifier list or it is a mismatch.
7722       for (auto *rhsProto : rhsQID->quals()) {
7723         if (ProtocolCompatibleWithProtocol(lhsProto, rhsProto) ||
7724             (compare && ProtocolCompatibleWithProtocol(rhsProto, lhsProto))) {
7725           match = true;
7726           break;
7727         }
7728       }
7729       if (!match)
7730         return false;
7731     }
7732 
7733     // Static class's protocols, or its super class or category protocols
7734     // must be found, direct or indirect in rhs's qualifier list or it is a mismatch.
7735     if (ObjCInterfaceDecl *lhsID = lhsOPT->getInterfaceDecl()) {
7736       llvm::SmallPtrSet<ObjCProtocolDecl *, 8> LHSInheritedProtocols;
7737       CollectInheritedProtocols(lhsID, LHSInheritedProtocols);
7738       // This is rather dubious but matches gcc's behavior. If lhs has
7739       // no type qualifier and its class has no static protocol(s)
7740       // assume that it is mismatch.
7741       if (LHSInheritedProtocols.empty() && lhsOPT->qual_empty())
7742         return false;
7743       for (auto *lhsProto : LHSInheritedProtocols) {
7744         bool match = false;
7745         for (auto *rhsProto : rhsQID->quals()) {
7746           if (ProtocolCompatibleWithProtocol(lhsProto, rhsProto) ||
7747               (compare && ProtocolCompatibleWithProtocol(rhsProto, lhsProto))) {
7748             match = true;
7749             break;
7750           }
7751         }
7752         if (!match)
7753           return false;
7754       }
7755     }
7756     return true;
7757   }
7758   return false;
7759 }
7760 
7761 /// canAssignObjCInterfaces - Return true if the two interface types are
7762 /// compatible for assignment from RHS to LHS.  This handles validation of any
7763 /// protocol qualifiers on the LHS or RHS.
7764 bool ASTContext::canAssignObjCInterfaces(const ObjCObjectPointerType *LHSOPT,
7765                                          const ObjCObjectPointerType *RHSOPT) {
7766   const ObjCObjectType* LHS = LHSOPT->getObjectType();
7767   const ObjCObjectType* RHS = RHSOPT->getObjectType();
7768 
7769   // If either type represents the built-in 'id' or 'Class' types, return true.
7770   if (LHS->isObjCUnqualifiedIdOrClass() ||
7771       RHS->isObjCUnqualifiedIdOrClass())
7772     return true;
7773 
7774   // Function object that propagates a successful result or handles
7775   // __kindof types.
7776   auto finish = [&](bool succeeded) -> bool {
7777     if (succeeded)
7778       return true;
7779 
7780     if (!RHS->isKindOfType())
7781       return false;
7782 
7783     // Strip off __kindof and protocol qualifiers, then check whether
7784     // we can assign the other way.
7785     return canAssignObjCInterfaces(RHSOPT->stripObjCKindOfTypeAndQuals(*this),
7786                                    LHSOPT->stripObjCKindOfTypeAndQuals(*this));
7787   };
7788 
7789   if (LHS->isObjCQualifiedId() || RHS->isObjCQualifiedId()) {
7790     return finish(ObjCQualifiedIdTypesAreCompatible(QualType(LHSOPT,0),
7791                                                     QualType(RHSOPT,0),
7792                                                     false));
7793   }
7794 
7795   if (LHS->isObjCQualifiedClass() && RHS->isObjCQualifiedClass()) {
7796     return finish(ObjCQualifiedClassTypesAreCompatible(QualType(LHSOPT,0),
7797                                                        QualType(RHSOPT,0)));
7798   }
7799 
7800   // If we have 2 user-defined types, fall into that path.
7801   if (LHS->getInterface() && RHS->getInterface()) {
7802     return finish(canAssignObjCInterfaces(LHS, RHS));
7803   }
7804 
7805   return false;
7806 }
7807 
7808 /// canAssignObjCInterfacesInBlockPointer - This routine is specifically written
7809 /// for providing type-safety for objective-c pointers used to pass/return
7810 /// arguments in block literals. When passed as arguments, passing 'A*' where
7811 /// 'id' is expected is not OK. Passing 'Sub *" where 'Super *" is expected is
7812 /// not OK. For the return type, the opposite is not OK.
7813 bool ASTContext::canAssignObjCInterfacesInBlockPointer(
7814                                          const ObjCObjectPointerType *LHSOPT,
7815                                          const ObjCObjectPointerType *RHSOPT,
7816                                          bool BlockReturnType) {
7817 
7818   // Function object that propagates a successful result or handles
7819   // __kindof types.
7820   auto finish = [&](bool succeeded) -> bool {
7821     if (succeeded)
7822       return true;
7823 
7824     const ObjCObjectPointerType *Expected = BlockReturnType ? RHSOPT : LHSOPT;
7825     if (!Expected->isKindOfType())
7826       return false;
7827 
7828     // Strip off __kindof and protocol qualifiers, then check whether
7829     // we can assign the other way.
7830     return canAssignObjCInterfacesInBlockPointer(
7831              RHSOPT->stripObjCKindOfTypeAndQuals(*this),
7832              LHSOPT->stripObjCKindOfTypeAndQuals(*this),
7833              BlockReturnType);
7834   };
7835 
7836   if (RHSOPT->isObjCBuiltinType() || LHSOPT->isObjCIdType())
7837     return true;
7838 
7839   if (LHSOPT->isObjCBuiltinType()) {
7840     return finish(RHSOPT->isObjCBuiltinType() ||
7841                   RHSOPT->isObjCQualifiedIdType());
7842   }
7843 
7844   if (LHSOPT->isObjCQualifiedIdType() || RHSOPT->isObjCQualifiedIdType())
7845     return finish(ObjCQualifiedIdTypesAreCompatible(QualType(LHSOPT,0),
7846                                                     QualType(RHSOPT,0),
7847                                                     false));
7848 
7849   const ObjCInterfaceType* LHS = LHSOPT->getInterfaceType();
7850   const ObjCInterfaceType* RHS = RHSOPT->getInterfaceType();
7851   if (LHS && RHS)  { // We have 2 user-defined types.
7852     if (LHS != RHS) {
7853       if (LHS->getDecl()->isSuperClassOf(RHS->getDecl()))
7854         return finish(BlockReturnType);
7855       if (RHS->getDecl()->isSuperClassOf(LHS->getDecl()))
7856         return finish(!BlockReturnType);
7857     }
7858     else
7859       return true;
7860   }
7861   return false;
7862 }
7863 
7864 /// Comparison routine for Objective-C protocols to be used with
7865 /// llvm::array_pod_sort.
7866 static int compareObjCProtocolsByName(ObjCProtocolDecl * const *lhs,
7867                                       ObjCProtocolDecl * const *rhs) {
7868   return (*lhs)->getName().compare((*rhs)->getName());
7869 }
7870 
7871 /// getIntersectionOfProtocols - This routine finds the intersection of set
7872 /// of protocols inherited from two distinct objective-c pointer objects with
7873 /// the given common base.
7874 /// It is used to build composite qualifier list of the composite type of
7875 /// the conditional expression involving two objective-c pointer objects.
7876 static
7877 void getIntersectionOfProtocols(ASTContext &Context,
7878                                 const ObjCInterfaceDecl *CommonBase,
7879                                 const ObjCObjectPointerType *LHSOPT,
7880                                 const ObjCObjectPointerType *RHSOPT,
7881       SmallVectorImpl<ObjCProtocolDecl *> &IntersectionSet) {
7882 
7883   const ObjCObjectType* LHS = LHSOPT->getObjectType();
7884   const ObjCObjectType* RHS = RHSOPT->getObjectType();
7885   assert(LHS->getInterface() && "LHS must have an interface base");
7886   assert(RHS->getInterface() && "RHS must have an interface base");
7887 
7888   // Add all of the protocols for the LHS.
7889   llvm::SmallPtrSet<ObjCProtocolDecl *, 8> LHSProtocolSet;
7890 
7891   // Start with the protocol qualifiers.
7892   for (auto proto : LHS->quals()) {
7893     Context.CollectInheritedProtocols(proto, LHSProtocolSet);
7894   }
7895 
7896   // Also add the protocols associated with the LHS interface.
7897   Context.CollectInheritedProtocols(LHS->getInterface(), LHSProtocolSet);
7898 
7899   // Add all of the protocls for the RHS.
7900   llvm::SmallPtrSet<ObjCProtocolDecl *, 8> RHSProtocolSet;
7901 
7902   // Start with the protocol qualifiers.
7903   for (auto proto : RHS->quals()) {
7904     Context.CollectInheritedProtocols(proto, RHSProtocolSet);
7905   }
7906 
7907   // Also add the protocols associated with the RHS interface.
7908   Context.CollectInheritedProtocols(RHS->getInterface(), RHSProtocolSet);
7909 
7910   // Compute the intersection of the collected protocol sets.
7911   for (auto proto : LHSProtocolSet) {
7912     if (RHSProtocolSet.count(proto))
7913       IntersectionSet.push_back(proto);
7914   }
7915 
7916   // Compute the set of protocols that is implied by either the common type or
7917   // the protocols within the intersection.
7918   llvm::SmallPtrSet<ObjCProtocolDecl *, 8> ImpliedProtocols;
7919   Context.CollectInheritedProtocols(CommonBase, ImpliedProtocols);
7920 
7921   // Remove any implied protocols from the list of inherited protocols.
7922   if (!ImpliedProtocols.empty()) {
7923     IntersectionSet.erase(
7924       std::remove_if(IntersectionSet.begin(),
7925                      IntersectionSet.end(),
7926                      [&](ObjCProtocolDecl *proto) -> bool {
7927                        return ImpliedProtocols.count(proto) > 0;
7928                      }),
7929       IntersectionSet.end());
7930   }
7931 
7932   // Sort the remaining protocols by name.
7933   llvm::array_pod_sort(IntersectionSet.begin(), IntersectionSet.end(),
7934                        compareObjCProtocolsByName);
7935 }
7936 
7937 /// Determine whether the first type is a subtype of the second.
7938 static bool canAssignObjCObjectTypes(ASTContext &ctx, QualType lhs,
7939                                      QualType rhs) {
7940   // Common case: two object pointers.
7941   const auto *lhsOPT = lhs->getAs<ObjCObjectPointerType>();
7942   const auto *rhsOPT = rhs->getAs<ObjCObjectPointerType>();
7943   if (lhsOPT && rhsOPT)
7944     return ctx.canAssignObjCInterfaces(lhsOPT, rhsOPT);
7945 
7946   // Two block pointers.
7947   const auto *lhsBlock = lhs->getAs<BlockPointerType>();
7948   const auto *rhsBlock = rhs->getAs<BlockPointerType>();
7949   if (lhsBlock && rhsBlock)
7950     return ctx.typesAreBlockPointerCompatible(lhs, rhs);
7951 
7952   // If either is an unqualified 'id' and the other is a block, it's
7953   // acceptable.
7954   if ((lhsOPT && lhsOPT->isObjCIdType() && rhsBlock) ||
7955       (rhsOPT && rhsOPT->isObjCIdType() && lhsBlock))
7956     return true;
7957 
7958   return false;
7959 }
7960 
7961 // Check that the given Objective-C type argument lists are equivalent.
7962 static bool sameObjCTypeArgs(ASTContext &ctx,
7963                              const ObjCInterfaceDecl *iface,
7964                              ArrayRef<QualType> lhsArgs,
7965                              ArrayRef<QualType> rhsArgs,
7966                              bool stripKindOf) {
7967   if (lhsArgs.size() != rhsArgs.size())
7968     return false;
7969 
7970   ObjCTypeParamList *typeParams = iface->getTypeParamList();
7971   for (unsigned i = 0, n = lhsArgs.size(); i != n; ++i) {
7972     if (ctx.hasSameType(lhsArgs[i], rhsArgs[i]))
7973       continue;
7974 
7975     switch (typeParams->begin()[i]->getVariance()) {
7976     case ObjCTypeParamVariance::Invariant:
7977       if (!stripKindOf ||
7978           !ctx.hasSameType(lhsArgs[i].stripObjCKindOfType(ctx),
7979                            rhsArgs[i].stripObjCKindOfType(ctx))) {
7980         return false;
7981       }
7982       break;
7983 
7984     case ObjCTypeParamVariance::Covariant:
7985       if (!canAssignObjCObjectTypes(ctx, lhsArgs[i], rhsArgs[i]))
7986         return false;
7987       break;
7988 
7989     case ObjCTypeParamVariance::Contravariant:
7990       if (!canAssignObjCObjectTypes(ctx, rhsArgs[i], lhsArgs[i]))
7991         return false;
7992       break;
7993     }
7994   }
7995 
7996   return true;
7997 }
7998 
7999 QualType ASTContext::areCommonBaseCompatible(
8000            const ObjCObjectPointerType *Lptr,
8001            const ObjCObjectPointerType *Rptr) {
8002   const ObjCObjectType *LHS = Lptr->getObjectType();
8003   const ObjCObjectType *RHS = Rptr->getObjectType();
8004   const ObjCInterfaceDecl* LDecl = LHS->getInterface();
8005   const ObjCInterfaceDecl* RDecl = RHS->getInterface();
8006 
8007   if (!LDecl || !RDecl)
8008     return {};
8009 
8010   // When either LHS or RHS is a kindof type, we should return a kindof type.
8011   // For example, for common base of kindof(ASub1) and kindof(ASub2), we return
8012   // kindof(A).
8013   bool anyKindOf = LHS->isKindOfType() || RHS->isKindOfType();
8014 
8015   // Follow the left-hand side up the class hierarchy until we either hit a
8016   // root or find the RHS. Record the ancestors in case we don't find it.
8017   llvm::SmallDenseMap<const ObjCInterfaceDecl *, const ObjCObjectType *, 4>
8018     LHSAncestors;
8019   while (true) {
8020     // Record this ancestor. We'll need this if the common type isn't in the
8021     // path from the LHS to the root.
8022     LHSAncestors[LHS->getInterface()->getCanonicalDecl()] = LHS;
8023 
8024     if (declaresSameEntity(LHS->getInterface(), RDecl)) {
8025       // Get the type arguments.
8026       ArrayRef<QualType> LHSTypeArgs = LHS->getTypeArgsAsWritten();
8027       bool anyChanges = false;
8028       if (LHS->isSpecialized() && RHS->isSpecialized()) {
8029         // Both have type arguments, compare them.
8030         if (!sameObjCTypeArgs(*this, LHS->getInterface(),
8031                               LHS->getTypeArgs(), RHS->getTypeArgs(),
8032                               /*stripKindOf=*/true))
8033           return {};
8034       } else if (LHS->isSpecialized() != RHS->isSpecialized()) {
8035         // If only one has type arguments, the result will not have type
8036         // arguments.
8037         LHSTypeArgs = {};
8038         anyChanges = true;
8039       }
8040 
8041       // Compute the intersection of protocols.
8042       SmallVector<ObjCProtocolDecl *, 8> Protocols;
8043       getIntersectionOfProtocols(*this, LHS->getInterface(), Lptr, Rptr,
8044                                  Protocols);
8045       if (!Protocols.empty())
8046         anyChanges = true;
8047 
8048       // If anything in the LHS will have changed, build a new result type.
8049       // If we need to return a kindof type but LHS is not a kindof type, we
8050       // build a new result type.
8051       if (anyChanges || LHS->isKindOfType() != anyKindOf) {
8052         QualType Result = getObjCInterfaceType(LHS->getInterface());
8053         Result = getObjCObjectType(Result, LHSTypeArgs, Protocols,
8054                                    anyKindOf || LHS->isKindOfType());
8055         return getObjCObjectPointerType(Result);
8056       }
8057 
8058       return getObjCObjectPointerType(QualType(LHS, 0));
8059     }
8060 
8061     // Find the superclass.
8062     QualType LHSSuperType = LHS->getSuperClassType();
8063     if (LHSSuperType.isNull())
8064       break;
8065 
8066     LHS = LHSSuperType->castAs<ObjCObjectType>();
8067   }
8068 
8069   // We didn't find anything by following the LHS to its root; now check
8070   // the RHS against the cached set of ancestors.
8071   while (true) {
8072     auto KnownLHS = LHSAncestors.find(RHS->getInterface()->getCanonicalDecl());
8073     if (KnownLHS != LHSAncestors.end()) {
8074       LHS = KnownLHS->second;
8075 
8076       // Get the type arguments.
8077       ArrayRef<QualType> RHSTypeArgs = RHS->getTypeArgsAsWritten();
8078       bool anyChanges = false;
8079       if (LHS->isSpecialized() && RHS->isSpecialized()) {
8080         // Both have type arguments, compare them.
8081         if (!sameObjCTypeArgs(*this, LHS->getInterface(),
8082                               LHS->getTypeArgs(), RHS->getTypeArgs(),
8083                               /*stripKindOf=*/true))
8084           return {};
8085       } else if (LHS->isSpecialized() != RHS->isSpecialized()) {
8086         // If only one has type arguments, the result will not have type
8087         // arguments.
8088         RHSTypeArgs = {};
8089         anyChanges = true;
8090       }
8091 
8092       // Compute the intersection of protocols.
8093       SmallVector<ObjCProtocolDecl *, 8> Protocols;
8094       getIntersectionOfProtocols(*this, RHS->getInterface(), Lptr, Rptr,
8095                                  Protocols);
8096       if (!Protocols.empty())
8097         anyChanges = true;
8098 
8099       // If we need to return a kindof type but RHS is not a kindof type, we
8100       // build a new result type.
8101       if (anyChanges || RHS->isKindOfType() != anyKindOf) {
8102         QualType Result = getObjCInterfaceType(RHS->getInterface());
8103         Result = getObjCObjectType(Result, RHSTypeArgs, Protocols,
8104                                    anyKindOf || RHS->isKindOfType());
8105         return getObjCObjectPointerType(Result);
8106       }
8107 
8108       return getObjCObjectPointerType(QualType(RHS, 0));
8109     }
8110 
8111     // Find the superclass of the RHS.
8112     QualType RHSSuperType = RHS->getSuperClassType();
8113     if (RHSSuperType.isNull())
8114       break;
8115 
8116     RHS = RHSSuperType->castAs<ObjCObjectType>();
8117   }
8118 
8119   return {};
8120 }
8121 
8122 bool ASTContext::canAssignObjCInterfaces(const ObjCObjectType *LHS,
8123                                          const ObjCObjectType *RHS) {
8124   assert(LHS->getInterface() && "LHS is not an interface type");
8125   assert(RHS->getInterface() && "RHS is not an interface type");
8126 
8127   // Verify that the base decls are compatible: the RHS must be a subclass of
8128   // the LHS.
8129   ObjCInterfaceDecl *LHSInterface = LHS->getInterface();
8130   bool IsSuperClass = LHSInterface->isSuperClassOf(RHS->getInterface());
8131   if (!IsSuperClass)
8132     return false;
8133 
8134   // If the LHS has protocol qualifiers, determine whether all of them are
8135   // satisfied by the RHS (i.e., the RHS has a superset of the protocols in the
8136   // LHS).
8137   if (LHS->getNumProtocols() > 0) {
8138     // OK if conversion of LHS to SuperClass results in narrowing of types
8139     // ; i.e., SuperClass may implement at least one of the protocols
8140     // in LHS's protocol list. Example, SuperObj<P1> = lhs<P1,P2> is ok.
8141     // But not SuperObj<P1,P2,P3> = lhs<P1,P2>.
8142     llvm::SmallPtrSet<ObjCProtocolDecl *, 8> SuperClassInheritedProtocols;
8143     CollectInheritedProtocols(RHS->getInterface(), SuperClassInheritedProtocols);
8144     // Also, if RHS has explicit quelifiers, include them for comparing with LHS's
8145     // qualifiers.
8146     for (auto *RHSPI : RHS->quals())
8147       CollectInheritedProtocols(RHSPI, SuperClassInheritedProtocols);
8148     // If there is no protocols associated with RHS, it is not a match.
8149     if (SuperClassInheritedProtocols.empty())
8150       return false;
8151 
8152     for (const auto *LHSProto : LHS->quals()) {
8153       bool SuperImplementsProtocol = false;
8154       for (auto *SuperClassProto : SuperClassInheritedProtocols)
8155         if (SuperClassProto->lookupProtocolNamed(LHSProto->getIdentifier())) {
8156           SuperImplementsProtocol = true;
8157           break;
8158         }
8159       if (!SuperImplementsProtocol)
8160         return false;
8161     }
8162   }
8163 
8164   // If the LHS is specialized, we may need to check type arguments.
8165   if (LHS->isSpecialized()) {
8166     // Follow the superclass chain until we've matched the LHS class in the
8167     // hierarchy. This substitutes type arguments through.
8168     const ObjCObjectType *RHSSuper = RHS;
8169     while (!declaresSameEntity(RHSSuper->getInterface(), LHSInterface))
8170       RHSSuper = RHSSuper->getSuperClassType()->castAs<ObjCObjectType>();
8171 
8172     // If the RHS is specializd, compare type arguments.
8173     if (RHSSuper->isSpecialized() &&
8174         !sameObjCTypeArgs(*this, LHS->getInterface(),
8175                           LHS->getTypeArgs(), RHSSuper->getTypeArgs(),
8176                           /*stripKindOf=*/true)) {
8177       return false;
8178     }
8179   }
8180 
8181   return true;
8182 }
8183 
8184 bool ASTContext::areComparableObjCPointerTypes(QualType LHS, QualType RHS) {
8185   // get the "pointed to" types
8186   const auto *LHSOPT = LHS->getAs<ObjCObjectPointerType>();
8187   const auto *RHSOPT = RHS->getAs<ObjCObjectPointerType>();
8188 
8189   if (!LHSOPT || !RHSOPT)
8190     return false;
8191 
8192   return canAssignObjCInterfaces(LHSOPT, RHSOPT) ||
8193          canAssignObjCInterfaces(RHSOPT, LHSOPT);
8194 }
8195 
8196 bool ASTContext::canBindObjCObjectType(QualType To, QualType From) {
8197   return canAssignObjCInterfaces(
8198                 getObjCObjectPointerType(To)->getAs<ObjCObjectPointerType>(),
8199                 getObjCObjectPointerType(From)->getAs<ObjCObjectPointerType>());
8200 }
8201 
8202 /// typesAreCompatible - C99 6.7.3p9: For two qualified types to be compatible,
8203 /// both shall have the identically qualified version of a compatible type.
8204 /// C99 6.2.7p1: Two types have compatible types if their types are the
8205 /// same. See 6.7.[2,3,5] for additional rules.
8206 bool ASTContext::typesAreCompatible(QualType LHS, QualType RHS,
8207                                     bool CompareUnqualified) {
8208   if (getLangOpts().CPlusPlus)
8209     return hasSameType(LHS, RHS);
8210 
8211   return !mergeTypes(LHS, RHS, false, CompareUnqualified).isNull();
8212 }
8213 
8214 bool ASTContext::propertyTypesAreCompatible(QualType LHS, QualType RHS) {
8215   return typesAreCompatible(LHS, RHS);
8216 }
8217 
8218 bool ASTContext::typesAreBlockPointerCompatible(QualType LHS, QualType RHS) {
8219   return !mergeTypes(LHS, RHS, true).isNull();
8220 }
8221 
8222 /// mergeTransparentUnionType - if T is a transparent union type and a member
8223 /// of T is compatible with SubType, return the merged type, else return
8224 /// QualType()
8225 QualType ASTContext::mergeTransparentUnionType(QualType T, QualType SubType,
8226                                                bool OfBlockPointer,
8227                                                bool Unqualified) {
8228   if (const RecordType *UT = T->getAsUnionType()) {
8229     RecordDecl *UD = UT->getDecl();
8230     if (UD->hasAttr<TransparentUnionAttr>()) {
8231       for (const auto *I : UD->fields()) {
8232         QualType ET = I->getType().getUnqualifiedType();
8233         QualType MT = mergeTypes(ET, SubType, OfBlockPointer, Unqualified);
8234         if (!MT.isNull())
8235           return MT;
8236       }
8237     }
8238   }
8239 
8240   return {};
8241 }
8242 
8243 /// mergeFunctionParameterTypes - merge two types which appear as function
8244 /// parameter types
8245 QualType ASTContext::mergeFunctionParameterTypes(QualType lhs, QualType rhs,
8246                                                  bool OfBlockPointer,
8247                                                  bool Unqualified) {
8248   // GNU extension: two types are compatible if they appear as a function
8249   // argument, one of the types is a transparent union type and the other
8250   // type is compatible with a union member
8251   QualType lmerge = mergeTransparentUnionType(lhs, rhs, OfBlockPointer,
8252                                               Unqualified);
8253   if (!lmerge.isNull())
8254     return lmerge;
8255 
8256   QualType rmerge = mergeTransparentUnionType(rhs, lhs, OfBlockPointer,
8257                                               Unqualified);
8258   if (!rmerge.isNull())
8259     return rmerge;
8260 
8261   return mergeTypes(lhs, rhs, OfBlockPointer, Unqualified);
8262 }
8263 
8264 QualType ASTContext::mergeFunctionTypes(QualType lhs, QualType rhs,
8265                                         bool OfBlockPointer,
8266                                         bool Unqualified) {
8267   const auto *lbase = lhs->getAs<FunctionType>();
8268   const auto *rbase = rhs->getAs<FunctionType>();
8269   const auto *lproto = dyn_cast<FunctionProtoType>(lbase);
8270   const auto *rproto = dyn_cast<FunctionProtoType>(rbase);
8271   bool allLTypes = true;
8272   bool allRTypes = true;
8273 
8274   // Check return type
8275   QualType retType;
8276   if (OfBlockPointer) {
8277     QualType RHS = rbase->getReturnType();
8278     QualType LHS = lbase->getReturnType();
8279     bool UnqualifiedResult = Unqualified;
8280     if (!UnqualifiedResult)
8281       UnqualifiedResult = (!RHS.hasQualifiers() && LHS.hasQualifiers());
8282     retType = mergeTypes(LHS, RHS, true, UnqualifiedResult, true);
8283   }
8284   else
8285     retType = mergeTypes(lbase->getReturnType(), rbase->getReturnType(), false,
8286                          Unqualified);
8287   if (retType.isNull())
8288     return {};
8289 
8290   if (Unqualified)
8291     retType = retType.getUnqualifiedType();
8292 
8293   CanQualType LRetType = getCanonicalType(lbase->getReturnType());
8294   CanQualType RRetType = getCanonicalType(rbase->getReturnType());
8295   if (Unqualified) {
8296     LRetType = LRetType.getUnqualifiedType();
8297     RRetType = RRetType.getUnqualifiedType();
8298   }
8299 
8300   if (getCanonicalType(retType) != LRetType)
8301     allLTypes = false;
8302   if (getCanonicalType(retType) != RRetType)
8303     allRTypes = false;
8304 
8305   // FIXME: double check this
8306   // FIXME: should we error if lbase->getRegParmAttr() != 0 &&
8307   //                           rbase->getRegParmAttr() != 0 &&
8308   //                           lbase->getRegParmAttr() != rbase->getRegParmAttr()?
8309   FunctionType::ExtInfo lbaseInfo = lbase->getExtInfo();
8310   FunctionType::ExtInfo rbaseInfo = rbase->getExtInfo();
8311 
8312   // Compatible functions must have compatible calling conventions
8313   if (lbaseInfo.getCC() != rbaseInfo.getCC())
8314     return {};
8315 
8316   // Regparm is part of the calling convention.
8317   if (lbaseInfo.getHasRegParm() != rbaseInfo.getHasRegParm())
8318     return {};
8319   if (lbaseInfo.getRegParm() != rbaseInfo.getRegParm())
8320     return {};
8321 
8322   if (lbaseInfo.getProducesResult() != rbaseInfo.getProducesResult())
8323     return {};
8324   if (lbaseInfo.getNoCallerSavedRegs() != rbaseInfo.getNoCallerSavedRegs())
8325     return {};
8326   if (lbaseInfo.getNoCfCheck() != rbaseInfo.getNoCfCheck())
8327     return {};
8328 
8329   // FIXME: some uses, e.g. conditional exprs, really want this to be 'both'.
8330   bool NoReturn = lbaseInfo.getNoReturn() || rbaseInfo.getNoReturn();
8331 
8332   if (lbaseInfo.getNoReturn() != NoReturn)
8333     allLTypes = false;
8334   if (rbaseInfo.getNoReturn() != NoReturn)
8335     allRTypes = false;
8336 
8337   FunctionType::ExtInfo einfo = lbaseInfo.withNoReturn(NoReturn);
8338 
8339   if (lproto && rproto) { // two C99 style function prototypes
8340     assert(!lproto->hasExceptionSpec() && !rproto->hasExceptionSpec() &&
8341            "C++ shouldn't be here");
8342     // Compatible functions must have the same number of parameters
8343     if (lproto->getNumParams() != rproto->getNumParams())
8344       return {};
8345 
8346     // Variadic and non-variadic functions aren't compatible
8347     if (lproto->isVariadic() != rproto->isVariadic())
8348       return {};
8349 
8350     if (lproto->getTypeQuals() != rproto->getTypeQuals())
8351       return {};
8352 
8353     SmallVector<FunctionProtoType::ExtParameterInfo, 4> newParamInfos;
8354     bool canUseLeft, canUseRight;
8355     if (!mergeExtParameterInfo(lproto, rproto, canUseLeft, canUseRight,
8356                                newParamInfos))
8357       return {};
8358 
8359     if (!canUseLeft)
8360       allLTypes = false;
8361     if (!canUseRight)
8362       allRTypes = false;
8363 
8364     // Check parameter type compatibility
8365     SmallVector<QualType, 10> types;
8366     for (unsigned i = 0, n = lproto->getNumParams(); i < n; i++) {
8367       QualType lParamType = lproto->getParamType(i).getUnqualifiedType();
8368       QualType rParamType = rproto->getParamType(i).getUnqualifiedType();
8369       QualType paramType = mergeFunctionParameterTypes(
8370           lParamType, rParamType, OfBlockPointer, Unqualified);
8371       if (paramType.isNull())
8372         return {};
8373 
8374       if (Unqualified)
8375         paramType = paramType.getUnqualifiedType();
8376 
8377       types.push_back(paramType);
8378       if (Unqualified) {
8379         lParamType = lParamType.getUnqualifiedType();
8380         rParamType = rParamType.getUnqualifiedType();
8381       }
8382 
8383       if (getCanonicalType(paramType) != getCanonicalType(lParamType))
8384         allLTypes = false;
8385       if (getCanonicalType(paramType) != getCanonicalType(rParamType))
8386         allRTypes = false;
8387     }
8388 
8389     if (allLTypes) return lhs;
8390     if (allRTypes) return rhs;
8391 
8392     FunctionProtoType::ExtProtoInfo EPI = lproto->getExtProtoInfo();
8393     EPI.ExtInfo = einfo;
8394     EPI.ExtParameterInfos =
8395         newParamInfos.empty() ? nullptr : newParamInfos.data();
8396     return getFunctionType(retType, types, EPI);
8397   }
8398 
8399   if (lproto) allRTypes = false;
8400   if (rproto) allLTypes = false;
8401 
8402   const FunctionProtoType *proto = lproto ? lproto : rproto;
8403   if (proto) {
8404     assert(!proto->hasExceptionSpec() && "C++ shouldn't be here");
8405     if (proto->isVariadic())
8406       return {};
8407     // Check that the types are compatible with the types that
8408     // would result from default argument promotions (C99 6.7.5.3p15).
8409     // The only types actually affected are promotable integer
8410     // types and floats, which would be passed as a different
8411     // type depending on whether the prototype is visible.
8412     for (unsigned i = 0, n = proto->getNumParams(); i < n; ++i) {
8413       QualType paramTy = proto->getParamType(i);
8414 
8415       // Look at the converted type of enum types, since that is the type used
8416       // to pass enum values.
8417       if (const auto *Enum = paramTy->getAs<EnumType>()) {
8418         paramTy = Enum->getDecl()->getIntegerType();
8419         if (paramTy.isNull())
8420           return {};
8421       }
8422 
8423       if (paramTy->isPromotableIntegerType() ||
8424           getCanonicalType(paramTy).getUnqualifiedType() == FloatTy)
8425         return {};
8426     }
8427 
8428     if (allLTypes) return lhs;
8429     if (allRTypes) return rhs;
8430 
8431     FunctionProtoType::ExtProtoInfo EPI = proto->getExtProtoInfo();
8432     EPI.ExtInfo = einfo;
8433     return getFunctionType(retType, proto->getParamTypes(), EPI);
8434   }
8435 
8436   if (allLTypes) return lhs;
8437   if (allRTypes) return rhs;
8438   return getFunctionNoProtoType(retType, einfo);
8439 }
8440 
8441 /// Given that we have an enum type and a non-enum type, try to merge them.
8442 static QualType mergeEnumWithInteger(ASTContext &Context, const EnumType *ET,
8443                                      QualType other, bool isBlockReturnType) {
8444   // C99 6.7.2.2p4: Each enumerated type shall be compatible with char,
8445   // a signed integer type, or an unsigned integer type.
8446   // Compatibility is based on the underlying type, not the promotion
8447   // type.
8448   QualType underlyingType = ET->getDecl()->getIntegerType();
8449   if (underlyingType.isNull())
8450     return {};
8451   if (Context.hasSameType(underlyingType, other))
8452     return other;
8453 
8454   // In block return types, we're more permissive and accept any
8455   // integral type of the same size.
8456   if (isBlockReturnType && other->isIntegerType() &&
8457       Context.getTypeSize(underlyingType) == Context.getTypeSize(other))
8458     return other;
8459 
8460   return {};
8461 }
8462 
8463 QualType ASTContext::mergeTypes(QualType LHS, QualType RHS,
8464                                 bool OfBlockPointer,
8465                                 bool Unqualified, bool BlockReturnType) {
8466   // C++ [expr]: If an expression initially has the type "reference to T", the
8467   // type is adjusted to "T" prior to any further analysis, the expression
8468   // designates the object or function denoted by the reference, and the
8469   // expression is an lvalue unless the reference is an rvalue reference and
8470   // the expression is a function call (possibly inside parentheses).
8471   assert(!LHS->getAs<ReferenceType>() && "LHS is a reference type?");
8472   assert(!RHS->getAs<ReferenceType>() && "RHS is a reference type?");
8473 
8474   if (Unqualified) {
8475     LHS = LHS.getUnqualifiedType();
8476     RHS = RHS.getUnqualifiedType();
8477   }
8478 
8479   QualType LHSCan = getCanonicalType(LHS),
8480            RHSCan = getCanonicalType(RHS);
8481 
8482   // If two types are identical, they are compatible.
8483   if (LHSCan == RHSCan)
8484     return LHS;
8485 
8486   // If the qualifiers are different, the types aren't compatible... mostly.
8487   Qualifiers LQuals = LHSCan.getLocalQualifiers();
8488   Qualifiers RQuals = RHSCan.getLocalQualifiers();
8489   if (LQuals != RQuals) {
8490     // If any of these qualifiers are different, we have a type
8491     // mismatch.
8492     if (LQuals.getCVRQualifiers() != RQuals.getCVRQualifiers() ||
8493         LQuals.getAddressSpace() != RQuals.getAddressSpace() ||
8494         LQuals.getObjCLifetime() != RQuals.getObjCLifetime() ||
8495         LQuals.hasUnaligned() != RQuals.hasUnaligned())
8496       return {};
8497 
8498     // Exactly one GC qualifier difference is allowed: __strong is
8499     // okay if the other type has no GC qualifier but is an Objective
8500     // C object pointer (i.e. implicitly strong by default).  We fix
8501     // this by pretending that the unqualified type was actually
8502     // qualified __strong.
8503     Qualifiers::GC GC_L = LQuals.getObjCGCAttr();
8504     Qualifiers::GC GC_R = RQuals.getObjCGCAttr();
8505     assert((GC_L != GC_R) && "unequal qualifier sets had only equal elements");
8506 
8507     if (GC_L == Qualifiers::Weak || GC_R == Qualifiers::Weak)
8508       return {};
8509 
8510     if (GC_L == Qualifiers::Strong && RHSCan->isObjCObjectPointerType()) {
8511       return mergeTypes(LHS, getObjCGCQualType(RHS, Qualifiers::Strong));
8512     }
8513     if (GC_R == Qualifiers::Strong && LHSCan->isObjCObjectPointerType()) {
8514       return mergeTypes(getObjCGCQualType(LHS, Qualifiers::Strong), RHS);
8515     }
8516     return {};
8517   }
8518 
8519   // Okay, qualifiers are equal.
8520 
8521   Type::TypeClass LHSClass = LHSCan->getTypeClass();
8522   Type::TypeClass RHSClass = RHSCan->getTypeClass();
8523 
8524   // We want to consider the two function types to be the same for these
8525   // comparisons, just force one to the other.
8526   if (LHSClass == Type::FunctionProto) LHSClass = Type::FunctionNoProto;
8527   if (RHSClass == Type::FunctionProto) RHSClass = Type::FunctionNoProto;
8528 
8529   // Same as above for arrays
8530   if (LHSClass == Type::VariableArray || LHSClass == Type::IncompleteArray)
8531     LHSClass = Type::ConstantArray;
8532   if (RHSClass == Type::VariableArray || RHSClass == Type::IncompleteArray)
8533     RHSClass = Type::ConstantArray;
8534 
8535   // ObjCInterfaces are just specialized ObjCObjects.
8536   if (LHSClass == Type::ObjCInterface) LHSClass = Type::ObjCObject;
8537   if (RHSClass == Type::ObjCInterface) RHSClass = Type::ObjCObject;
8538 
8539   // Canonicalize ExtVector -> Vector.
8540   if (LHSClass == Type::ExtVector) LHSClass = Type::Vector;
8541   if (RHSClass == Type::ExtVector) RHSClass = Type::Vector;
8542 
8543   // If the canonical type classes don't match.
8544   if (LHSClass != RHSClass) {
8545     // Note that we only have special rules for turning block enum
8546     // returns into block int returns, not vice-versa.
8547     if (const auto *ETy = LHS->getAs<EnumType>()) {
8548       return mergeEnumWithInteger(*this, ETy, RHS, false);
8549     }
8550     if (const EnumType* ETy = RHS->getAs<EnumType>()) {
8551       return mergeEnumWithInteger(*this, ETy, LHS, BlockReturnType);
8552     }
8553     // allow block pointer type to match an 'id' type.
8554     if (OfBlockPointer && !BlockReturnType) {
8555        if (LHS->isObjCIdType() && RHS->isBlockPointerType())
8556          return LHS;
8557       if (RHS->isObjCIdType() && LHS->isBlockPointerType())
8558         return RHS;
8559     }
8560 
8561     return {};
8562   }
8563 
8564   // The canonical type classes match.
8565   switch (LHSClass) {
8566 #define TYPE(Class, Base)
8567 #define ABSTRACT_TYPE(Class, Base)
8568 #define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base) case Type::Class:
8569 #define NON_CANONICAL_TYPE(Class, Base) case Type::Class:
8570 #define DEPENDENT_TYPE(Class, Base) case Type::Class:
8571 #include "clang/AST/TypeNodes.def"
8572     llvm_unreachable("Non-canonical and dependent types shouldn't get here");
8573 
8574   case Type::Auto:
8575   case Type::DeducedTemplateSpecialization:
8576   case Type::LValueReference:
8577   case Type::RValueReference:
8578   case Type::MemberPointer:
8579     llvm_unreachable("C++ should never be in mergeTypes");
8580 
8581   case Type::ObjCInterface:
8582   case Type::IncompleteArray:
8583   case Type::VariableArray:
8584   case Type::FunctionProto:
8585   case Type::ExtVector:
8586     llvm_unreachable("Types are eliminated above");
8587 
8588   case Type::Pointer:
8589   {
8590     // Merge two pointer types, while trying to preserve typedef info
8591     QualType LHSPointee = LHS->getAs<PointerType>()->getPointeeType();
8592     QualType RHSPointee = RHS->getAs<PointerType>()->getPointeeType();
8593     if (Unqualified) {
8594       LHSPointee = LHSPointee.getUnqualifiedType();
8595       RHSPointee = RHSPointee.getUnqualifiedType();
8596     }
8597     QualType ResultType = mergeTypes(LHSPointee, RHSPointee, false,
8598                                      Unqualified);
8599     if (ResultType.isNull())
8600       return {};
8601     if (getCanonicalType(LHSPointee) == getCanonicalType(ResultType))
8602       return LHS;
8603     if (getCanonicalType(RHSPointee) == getCanonicalType(ResultType))
8604       return RHS;
8605     return getPointerType(ResultType);
8606   }
8607   case Type::BlockPointer:
8608   {
8609     // Merge two block pointer types, while trying to preserve typedef info
8610     QualType LHSPointee = LHS->getAs<BlockPointerType>()->getPointeeType();
8611     QualType RHSPointee = RHS->getAs<BlockPointerType>()->getPointeeType();
8612     if (Unqualified) {
8613       LHSPointee = LHSPointee.getUnqualifiedType();
8614       RHSPointee = RHSPointee.getUnqualifiedType();
8615     }
8616     if (getLangOpts().OpenCL) {
8617       Qualifiers LHSPteeQual = LHSPointee.getQualifiers();
8618       Qualifiers RHSPteeQual = RHSPointee.getQualifiers();
8619       // Blocks can't be an expression in a ternary operator (OpenCL v2.0
8620       // 6.12.5) thus the following check is asymmetric.
8621       if (!LHSPteeQual.isAddressSpaceSupersetOf(RHSPteeQual))
8622         return {};
8623       LHSPteeQual.removeAddressSpace();
8624       RHSPteeQual.removeAddressSpace();
8625       LHSPointee =
8626           QualType(LHSPointee.getTypePtr(), LHSPteeQual.getAsOpaqueValue());
8627       RHSPointee =
8628           QualType(RHSPointee.getTypePtr(), RHSPteeQual.getAsOpaqueValue());
8629     }
8630     QualType ResultType = mergeTypes(LHSPointee, RHSPointee, OfBlockPointer,
8631                                      Unqualified);
8632     if (ResultType.isNull())
8633       return {};
8634     if (getCanonicalType(LHSPointee) == getCanonicalType(ResultType))
8635       return LHS;
8636     if (getCanonicalType(RHSPointee) == getCanonicalType(ResultType))
8637       return RHS;
8638     return getBlockPointerType(ResultType);
8639   }
8640   case Type::Atomic:
8641   {
8642     // Merge two pointer types, while trying to preserve typedef info
8643     QualType LHSValue = LHS->getAs<AtomicType>()->getValueType();
8644     QualType RHSValue = RHS->getAs<AtomicType>()->getValueType();
8645     if (Unqualified) {
8646       LHSValue = LHSValue.getUnqualifiedType();
8647       RHSValue = RHSValue.getUnqualifiedType();
8648     }
8649     QualType ResultType = mergeTypes(LHSValue, RHSValue, false,
8650                                      Unqualified);
8651     if (ResultType.isNull())
8652       return {};
8653     if (getCanonicalType(LHSValue) == getCanonicalType(ResultType))
8654       return LHS;
8655     if (getCanonicalType(RHSValue) == getCanonicalType(ResultType))
8656       return RHS;
8657     return getAtomicType(ResultType);
8658   }
8659   case Type::ConstantArray:
8660   {
8661     const ConstantArrayType* LCAT = getAsConstantArrayType(LHS);
8662     const ConstantArrayType* RCAT = getAsConstantArrayType(RHS);
8663     if (LCAT && RCAT && RCAT->getSize() != LCAT->getSize())
8664       return {};
8665 
8666     QualType LHSElem = getAsArrayType(LHS)->getElementType();
8667     QualType RHSElem = getAsArrayType(RHS)->getElementType();
8668     if (Unqualified) {
8669       LHSElem = LHSElem.getUnqualifiedType();
8670       RHSElem = RHSElem.getUnqualifiedType();
8671     }
8672 
8673     QualType ResultType = mergeTypes(LHSElem, RHSElem, false, Unqualified);
8674     if (ResultType.isNull())
8675       return {};
8676 
8677     const VariableArrayType* LVAT = getAsVariableArrayType(LHS);
8678     const VariableArrayType* RVAT = getAsVariableArrayType(RHS);
8679 
8680     // If either side is a variable array, and both are complete, check whether
8681     // the current dimension is definite.
8682     if (LVAT || RVAT) {
8683       auto SizeFetch = [this](const VariableArrayType* VAT,
8684           const ConstantArrayType* CAT)
8685           -> std::pair<bool,llvm::APInt> {
8686         if (VAT) {
8687           llvm::APSInt TheInt;
8688           Expr *E = VAT->getSizeExpr();
8689           if (E && E->isIntegerConstantExpr(TheInt, *this))
8690             return std::make_pair(true, TheInt);
8691           else
8692             return std::make_pair(false, TheInt);
8693         } else if (CAT) {
8694             return std::make_pair(true, CAT->getSize());
8695         } else {
8696             return std::make_pair(false, llvm::APInt());
8697         }
8698       };
8699 
8700       bool HaveLSize, HaveRSize;
8701       llvm::APInt LSize, RSize;
8702       std::tie(HaveLSize, LSize) = SizeFetch(LVAT, LCAT);
8703       std::tie(HaveRSize, RSize) = SizeFetch(RVAT, RCAT);
8704       if (HaveLSize && HaveRSize && !llvm::APInt::isSameValue(LSize, RSize))
8705         return {}; // Definite, but unequal, array dimension
8706     }
8707 
8708     if (LCAT && getCanonicalType(LHSElem) == getCanonicalType(ResultType))
8709       return LHS;
8710     if (RCAT && getCanonicalType(RHSElem) == getCanonicalType(ResultType))
8711       return RHS;
8712     if (LCAT) return getConstantArrayType(ResultType, LCAT->getSize(),
8713                                           ArrayType::ArraySizeModifier(), 0);
8714     if (RCAT) return getConstantArrayType(ResultType, RCAT->getSize(),
8715                                           ArrayType::ArraySizeModifier(), 0);
8716     if (LVAT && getCanonicalType(LHSElem) == getCanonicalType(ResultType))
8717       return LHS;
8718     if (RVAT && getCanonicalType(RHSElem) == getCanonicalType(ResultType))
8719       return RHS;
8720     if (LVAT) {
8721       // FIXME: This isn't correct! But tricky to implement because
8722       // the array's size has to be the size of LHS, but the type
8723       // has to be different.
8724       return LHS;
8725     }
8726     if (RVAT) {
8727       // FIXME: This isn't correct! But tricky to implement because
8728       // the array's size has to be the size of RHS, but the type
8729       // has to be different.
8730       return RHS;
8731     }
8732     if (getCanonicalType(LHSElem) == getCanonicalType(ResultType)) return LHS;
8733     if (getCanonicalType(RHSElem) == getCanonicalType(ResultType)) return RHS;
8734     return getIncompleteArrayType(ResultType,
8735                                   ArrayType::ArraySizeModifier(), 0);
8736   }
8737   case Type::FunctionNoProto:
8738     return mergeFunctionTypes(LHS, RHS, OfBlockPointer, Unqualified);
8739   case Type::Record:
8740   case Type::Enum:
8741     return {};
8742   case Type::Builtin:
8743     // Only exactly equal builtin types are compatible, which is tested above.
8744     return {};
8745   case Type::Complex:
8746     // Distinct complex types are incompatible.
8747     return {};
8748   case Type::Vector:
8749     // FIXME: The merged type should be an ExtVector!
8750     if (areCompatVectorTypes(LHSCan->getAs<VectorType>(),
8751                              RHSCan->getAs<VectorType>()))
8752       return LHS;
8753     return {};
8754   case Type::ObjCObject: {
8755     // Check if the types are assignment compatible.
8756     // FIXME: This should be type compatibility, e.g. whether
8757     // "LHS x; RHS x;" at global scope is legal.
8758     const auto *LHSIface = LHS->getAs<ObjCObjectType>();
8759     const auto *RHSIface = RHS->getAs<ObjCObjectType>();
8760     if (canAssignObjCInterfaces(LHSIface, RHSIface))
8761       return LHS;
8762 
8763     return {};
8764   }
8765   case Type::ObjCObjectPointer:
8766     if (OfBlockPointer) {
8767       if (canAssignObjCInterfacesInBlockPointer(
8768                                           LHS->getAs<ObjCObjectPointerType>(),
8769                                           RHS->getAs<ObjCObjectPointerType>(),
8770                                           BlockReturnType))
8771         return LHS;
8772       return {};
8773     }
8774     if (canAssignObjCInterfaces(LHS->getAs<ObjCObjectPointerType>(),
8775                                 RHS->getAs<ObjCObjectPointerType>()))
8776       return LHS;
8777 
8778     return {};
8779   case Type::Pipe:
8780     assert(LHS != RHS &&
8781            "Equivalent pipe types should have already been handled!");
8782     return {};
8783   }
8784 
8785   llvm_unreachable("Invalid Type::Class!");
8786 }
8787 
8788 bool ASTContext::mergeExtParameterInfo(
8789     const FunctionProtoType *FirstFnType, const FunctionProtoType *SecondFnType,
8790     bool &CanUseFirst, bool &CanUseSecond,
8791     SmallVectorImpl<FunctionProtoType::ExtParameterInfo> &NewParamInfos) {
8792   assert(NewParamInfos.empty() && "param info list not empty");
8793   CanUseFirst = CanUseSecond = true;
8794   bool FirstHasInfo = FirstFnType->hasExtParameterInfos();
8795   bool SecondHasInfo = SecondFnType->hasExtParameterInfos();
8796 
8797   // Fast path: if the first type doesn't have ext parameter infos,
8798   // we match if and only if the second type also doesn't have them.
8799   if (!FirstHasInfo && !SecondHasInfo)
8800     return true;
8801 
8802   bool NeedParamInfo = false;
8803   size_t E = FirstHasInfo ? FirstFnType->getExtParameterInfos().size()
8804                           : SecondFnType->getExtParameterInfos().size();
8805 
8806   for (size_t I = 0; I < E; ++I) {
8807     FunctionProtoType::ExtParameterInfo FirstParam, SecondParam;
8808     if (FirstHasInfo)
8809       FirstParam = FirstFnType->getExtParameterInfo(I);
8810     if (SecondHasInfo)
8811       SecondParam = SecondFnType->getExtParameterInfo(I);
8812 
8813     // Cannot merge unless everything except the noescape flag matches.
8814     if (FirstParam.withIsNoEscape(false) != SecondParam.withIsNoEscape(false))
8815       return false;
8816 
8817     bool FirstNoEscape = FirstParam.isNoEscape();
8818     bool SecondNoEscape = SecondParam.isNoEscape();
8819     bool IsNoEscape = FirstNoEscape && SecondNoEscape;
8820     NewParamInfos.push_back(FirstParam.withIsNoEscape(IsNoEscape));
8821     if (NewParamInfos.back().getOpaqueValue())
8822       NeedParamInfo = true;
8823     if (FirstNoEscape != IsNoEscape)
8824       CanUseFirst = false;
8825     if (SecondNoEscape != IsNoEscape)
8826       CanUseSecond = false;
8827   }
8828 
8829   if (!NeedParamInfo)
8830     NewParamInfos.clear();
8831 
8832   return true;
8833 }
8834 
8835 void ASTContext::ResetObjCLayout(const ObjCContainerDecl *CD) {
8836   ObjCLayouts[CD] = nullptr;
8837 }
8838 
8839 /// mergeObjCGCQualifiers - This routine merges ObjC's GC attribute of 'LHS' and
8840 /// 'RHS' attributes and returns the merged version; including for function
8841 /// return types.
8842 QualType ASTContext::mergeObjCGCQualifiers(QualType LHS, QualType RHS) {
8843   QualType LHSCan = getCanonicalType(LHS),
8844   RHSCan = getCanonicalType(RHS);
8845   // If two types are identical, they are compatible.
8846   if (LHSCan == RHSCan)
8847     return LHS;
8848   if (RHSCan->isFunctionType()) {
8849     if (!LHSCan->isFunctionType())
8850       return {};
8851     QualType OldReturnType =
8852         cast<FunctionType>(RHSCan.getTypePtr())->getReturnType();
8853     QualType NewReturnType =
8854         cast<FunctionType>(LHSCan.getTypePtr())->getReturnType();
8855     QualType ResReturnType =
8856       mergeObjCGCQualifiers(NewReturnType, OldReturnType);
8857     if (ResReturnType.isNull())
8858       return {};
8859     if (ResReturnType == NewReturnType || ResReturnType == OldReturnType) {
8860       // id foo(); ... __strong id foo(); or: __strong id foo(); ... id foo();
8861       // In either case, use OldReturnType to build the new function type.
8862       const auto *F = LHS->getAs<FunctionType>();
8863       if (const auto *FPT = cast<FunctionProtoType>(F)) {
8864         FunctionProtoType::ExtProtoInfo EPI = FPT->getExtProtoInfo();
8865         EPI.ExtInfo = getFunctionExtInfo(LHS);
8866         QualType ResultType =
8867             getFunctionType(OldReturnType, FPT->getParamTypes(), EPI);
8868         return ResultType;
8869       }
8870     }
8871     return {};
8872   }
8873 
8874   // If the qualifiers are different, the types can still be merged.
8875   Qualifiers LQuals = LHSCan.getLocalQualifiers();
8876   Qualifiers RQuals = RHSCan.getLocalQualifiers();
8877   if (LQuals != RQuals) {
8878     // If any of these qualifiers are different, we have a type mismatch.
8879     if (LQuals.getCVRQualifiers() != RQuals.getCVRQualifiers() ||
8880         LQuals.getAddressSpace() != RQuals.getAddressSpace())
8881       return {};
8882 
8883     // Exactly one GC qualifier difference is allowed: __strong is
8884     // okay if the other type has no GC qualifier but is an Objective
8885     // C object pointer (i.e. implicitly strong by default).  We fix
8886     // this by pretending that the unqualified type was actually
8887     // qualified __strong.
8888     Qualifiers::GC GC_L = LQuals.getObjCGCAttr();
8889     Qualifiers::GC GC_R = RQuals.getObjCGCAttr();
8890     assert((GC_L != GC_R) && "unequal qualifier sets had only equal elements");
8891 
8892     if (GC_L == Qualifiers::Weak || GC_R == Qualifiers::Weak)
8893       return {};
8894 
8895     if (GC_L == Qualifiers::Strong)
8896       return LHS;
8897     if (GC_R == Qualifiers::Strong)
8898       return RHS;
8899     return {};
8900   }
8901 
8902   if (LHSCan->isObjCObjectPointerType() && RHSCan->isObjCObjectPointerType()) {
8903     QualType LHSBaseQT = LHS->getAs<ObjCObjectPointerType>()->getPointeeType();
8904     QualType RHSBaseQT = RHS->getAs<ObjCObjectPointerType>()->getPointeeType();
8905     QualType ResQT = mergeObjCGCQualifiers(LHSBaseQT, RHSBaseQT);
8906     if (ResQT == LHSBaseQT)
8907       return LHS;
8908     if (ResQT == RHSBaseQT)
8909       return RHS;
8910   }
8911   return {};
8912 }
8913 
8914 //===----------------------------------------------------------------------===//
8915 //                         Integer Predicates
8916 //===----------------------------------------------------------------------===//
8917 
8918 unsigned ASTContext::getIntWidth(QualType T) const {
8919   if (const auto *ET = T->getAs<EnumType>())
8920     T = ET->getDecl()->getIntegerType();
8921   if (T->isBooleanType())
8922     return 1;
8923   // For builtin types, just use the standard type sizing method
8924   return (unsigned)getTypeSize(T);
8925 }
8926 
8927 QualType ASTContext::getCorrespondingUnsignedType(QualType T) const {
8928   assert((T->hasSignedIntegerRepresentation() || T->isSignedFixedPointType()) &&
8929          "Unexpected type");
8930 
8931   // Turn <4 x signed int> -> <4 x unsigned int>
8932   if (const auto *VTy = T->getAs<VectorType>())
8933     return getVectorType(getCorrespondingUnsignedType(VTy->getElementType()),
8934                          VTy->getNumElements(), VTy->getVectorKind());
8935 
8936   // For enums, we return the unsigned version of the base type.
8937   if (const auto *ETy = T->getAs<EnumType>())
8938     T = ETy->getDecl()->getIntegerType();
8939 
8940   const auto *BTy = T->getAs<BuiltinType>();
8941   assert(BTy && "Unexpected signed integer or fixed point type");
8942   switch (BTy->getKind()) {
8943   case BuiltinType::Char_S:
8944   case BuiltinType::SChar:
8945     return UnsignedCharTy;
8946   case BuiltinType::Short:
8947     return UnsignedShortTy;
8948   case BuiltinType::Int:
8949     return UnsignedIntTy;
8950   case BuiltinType::Long:
8951     return UnsignedLongTy;
8952   case BuiltinType::LongLong:
8953     return UnsignedLongLongTy;
8954   case BuiltinType::Int128:
8955     return UnsignedInt128Ty;
8956 
8957   case BuiltinType::ShortAccum:
8958     return UnsignedShortAccumTy;
8959   case BuiltinType::Accum:
8960     return UnsignedAccumTy;
8961   case BuiltinType::LongAccum:
8962     return UnsignedLongAccumTy;
8963   case BuiltinType::SatShortAccum:
8964     return SatUnsignedShortAccumTy;
8965   case BuiltinType::SatAccum:
8966     return SatUnsignedAccumTy;
8967   case BuiltinType::SatLongAccum:
8968     return SatUnsignedLongAccumTy;
8969   case BuiltinType::ShortFract:
8970     return UnsignedShortFractTy;
8971   case BuiltinType::Fract:
8972     return UnsignedFractTy;
8973   case BuiltinType::LongFract:
8974     return UnsignedLongFractTy;
8975   case BuiltinType::SatShortFract:
8976     return SatUnsignedShortFractTy;
8977   case BuiltinType::SatFract:
8978     return SatUnsignedFractTy;
8979   case BuiltinType::SatLongFract:
8980     return SatUnsignedLongFractTy;
8981   default:
8982     llvm_unreachable("Unexpected signed integer or fixed point type");
8983   }
8984 }
8985 
8986 ASTMutationListener::~ASTMutationListener() = default;
8987 
8988 void ASTMutationListener::DeducedReturnType(const FunctionDecl *FD,
8989                                             QualType ReturnType) {}
8990 
8991 //===----------------------------------------------------------------------===//
8992 //                          Builtin Type Computation
8993 //===----------------------------------------------------------------------===//
8994 
8995 /// DecodeTypeFromStr - This decodes one type descriptor from Str, advancing the
8996 /// pointer over the consumed characters.  This returns the resultant type.  If
8997 /// AllowTypeModifiers is false then modifier like * are not parsed, just basic
8998 /// types.  This allows "v2i*" to be parsed as a pointer to a v2i instead of
8999 /// a vector of "i*".
9000 ///
9001 /// RequiresICE is filled in on return to indicate whether the value is required
9002 /// to be an Integer Constant Expression.
9003 static QualType DecodeTypeFromStr(const char *&Str, const ASTContext &Context,
9004                                   ASTContext::GetBuiltinTypeError &Error,
9005                                   bool &RequiresICE,
9006                                   bool AllowTypeModifiers) {
9007   // Modifiers.
9008   int HowLong = 0;
9009   bool Signed = false, Unsigned = false;
9010   RequiresICE = false;
9011 
9012   // Read the prefixed modifiers first.
9013   bool Done = false;
9014   #ifndef NDEBUG
9015   bool IsSpecialLong = false;
9016   #endif
9017   while (!Done) {
9018     switch (*Str++) {
9019     default: Done = true; --Str; break;
9020     case 'I':
9021       RequiresICE = true;
9022       break;
9023     case 'S':
9024       assert(!Unsigned && "Can't use both 'S' and 'U' modifiers!");
9025       assert(!Signed && "Can't use 'S' modifier multiple times!");
9026       Signed = true;
9027       break;
9028     case 'U':
9029       assert(!Signed && "Can't use both 'S' and 'U' modifiers!");
9030       assert(!Unsigned && "Can't use 'U' modifier multiple times!");
9031       Unsigned = true;
9032       break;
9033     case 'L':
9034       assert(!IsSpecialLong && "Can't use 'L' with 'W' or 'N' modifiers");
9035       assert(HowLong <= 2 && "Can't have LLLL modifier");
9036       ++HowLong;
9037       break;
9038     case 'N':
9039       // 'N' behaves like 'L' for all non LP64 targets and 'int' otherwise.
9040       assert(!IsSpecialLong && "Can't use two 'N' or 'W' modifiers!");
9041       assert(HowLong == 0 && "Can't use both 'L' and 'N' modifiers!");
9042       #ifndef NDEBUG
9043       IsSpecialLong = true;
9044       #endif
9045       if (Context.getTargetInfo().getLongWidth() == 32)
9046         ++HowLong;
9047       break;
9048     case 'W':
9049       // This modifier represents int64 type.
9050       assert(!IsSpecialLong && "Can't use two 'N' or 'W' modifiers!");
9051       assert(HowLong == 0 && "Can't use both 'L' and 'W' modifiers!");
9052       #ifndef NDEBUG
9053       IsSpecialLong = true;
9054       #endif
9055       switch (Context.getTargetInfo().getInt64Type()) {
9056       default:
9057         llvm_unreachable("Unexpected integer type");
9058       case TargetInfo::SignedLong:
9059         HowLong = 1;
9060         break;
9061       case TargetInfo::SignedLongLong:
9062         HowLong = 2;
9063         break;
9064       }
9065       break;
9066     }
9067   }
9068 
9069   QualType Type;
9070 
9071   // Read the base type.
9072   switch (*Str++) {
9073   default: llvm_unreachable("Unknown builtin type letter!");
9074   case 'v':
9075     assert(HowLong == 0 && !Signed && !Unsigned &&
9076            "Bad modifiers used with 'v'!");
9077     Type = Context.VoidTy;
9078     break;
9079   case 'h':
9080     assert(HowLong == 0 && !Signed && !Unsigned &&
9081            "Bad modifiers used with 'h'!");
9082     Type = Context.HalfTy;
9083     break;
9084   case 'f':
9085     assert(HowLong == 0 && !Signed && !Unsigned &&
9086            "Bad modifiers used with 'f'!");
9087     Type = Context.FloatTy;
9088     break;
9089   case 'd':
9090     assert(HowLong < 3 && !Signed && !Unsigned &&
9091            "Bad modifiers used with 'd'!");
9092     if (HowLong == 1)
9093       Type = Context.LongDoubleTy;
9094     else if (HowLong == 2)
9095       Type = Context.Float128Ty;
9096     else
9097       Type = Context.DoubleTy;
9098     break;
9099   case 's':
9100     assert(HowLong == 0 && "Bad modifiers used with 's'!");
9101     if (Unsigned)
9102       Type = Context.UnsignedShortTy;
9103     else
9104       Type = Context.ShortTy;
9105     break;
9106   case 'i':
9107     if (HowLong == 3)
9108       Type = Unsigned ? Context.UnsignedInt128Ty : Context.Int128Ty;
9109     else if (HowLong == 2)
9110       Type = Unsigned ? Context.UnsignedLongLongTy : Context.LongLongTy;
9111     else if (HowLong == 1)
9112       Type = Unsigned ? Context.UnsignedLongTy : Context.LongTy;
9113     else
9114       Type = Unsigned ? Context.UnsignedIntTy : Context.IntTy;
9115     break;
9116   case 'c':
9117     assert(HowLong == 0 && "Bad modifiers used with 'c'!");
9118     if (Signed)
9119       Type = Context.SignedCharTy;
9120     else if (Unsigned)
9121       Type = Context.UnsignedCharTy;
9122     else
9123       Type = Context.CharTy;
9124     break;
9125   case 'b': // boolean
9126     assert(HowLong == 0 && !Signed && !Unsigned && "Bad modifiers for 'b'!");
9127     Type = Context.BoolTy;
9128     break;
9129   case 'z':  // size_t.
9130     assert(HowLong == 0 && !Signed && !Unsigned && "Bad modifiers for 'z'!");
9131     Type = Context.getSizeType();
9132     break;
9133   case 'w':  // wchar_t.
9134     assert(HowLong == 0 && !Signed && !Unsigned && "Bad modifiers for 'w'!");
9135     Type = Context.getWideCharType();
9136     break;
9137   case 'F':
9138     Type = Context.getCFConstantStringType();
9139     break;
9140   case 'G':
9141     Type = Context.getObjCIdType();
9142     break;
9143   case 'H':
9144     Type = Context.getObjCSelType();
9145     break;
9146   case 'M':
9147     Type = Context.getObjCSuperType();
9148     break;
9149   case 'a':
9150     Type = Context.getBuiltinVaListType();
9151     assert(!Type.isNull() && "builtin va list type not initialized!");
9152     break;
9153   case 'A':
9154     // This is a "reference" to a va_list; however, what exactly
9155     // this means depends on how va_list is defined. There are two
9156     // different kinds of va_list: ones passed by value, and ones
9157     // passed by reference.  An example of a by-value va_list is
9158     // x86, where va_list is a char*. An example of by-ref va_list
9159     // is x86-64, where va_list is a __va_list_tag[1]. For x86,
9160     // we want this argument to be a char*&; for x86-64, we want
9161     // it to be a __va_list_tag*.
9162     Type = Context.getBuiltinVaListType();
9163     assert(!Type.isNull() && "builtin va list type not initialized!");
9164     if (Type->isArrayType())
9165       Type = Context.getArrayDecayedType(Type);
9166     else
9167       Type = Context.getLValueReferenceType(Type);
9168     break;
9169   case 'V': {
9170     char *End;
9171     unsigned NumElements = strtoul(Str, &End, 10);
9172     assert(End != Str && "Missing vector size");
9173     Str = End;
9174 
9175     QualType ElementType = DecodeTypeFromStr(Str, Context, Error,
9176                                              RequiresICE, false);
9177     assert(!RequiresICE && "Can't require vector ICE");
9178 
9179     // TODO: No way to make AltiVec vectors in builtins yet.
9180     Type = Context.getVectorType(ElementType, NumElements,
9181                                  VectorType::GenericVector);
9182     break;
9183   }
9184   case 'E': {
9185     char *End;
9186 
9187     unsigned NumElements = strtoul(Str, &End, 10);
9188     assert(End != Str && "Missing vector size");
9189 
9190     Str = End;
9191 
9192     QualType ElementType = DecodeTypeFromStr(Str, Context, Error, RequiresICE,
9193                                              false);
9194     Type = Context.getExtVectorType(ElementType, NumElements);
9195     break;
9196   }
9197   case 'X': {
9198     QualType ElementType = DecodeTypeFromStr(Str, Context, Error, RequiresICE,
9199                                              false);
9200     assert(!RequiresICE && "Can't require complex ICE");
9201     Type = Context.getComplexType(ElementType);
9202     break;
9203   }
9204   case 'Y':
9205     Type = Context.getPointerDiffType();
9206     break;
9207   case 'P':
9208     Type = Context.getFILEType();
9209     if (Type.isNull()) {
9210       Error = ASTContext::GE_Missing_stdio;
9211       return {};
9212     }
9213     break;
9214   case 'J':
9215     if (Signed)
9216       Type = Context.getsigjmp_bufType();
9217     else
9218       Type = Context.getjmp_bufType();
9219 
9220     if (Type.isNull()) {
9221       Error = ASTContext::GE_Missing_setjmp;
9222       return {};
9223     }
9224     break;
9225   case 'K':
9226     assert(HowLong == 0 && !Signed && !Unsigned && "Bad modifiers for 'K'!");
9227     Type = Context.getucontext_tType();
9228 
9229     if (Type.isNull()) {
9230       Error = ASTContext::GE_Missing_ucontext;
9231       return {};
9232     }
9233     break;
9234   case 'p':
9235     Type = Context.getProcessIDType();
9236     break;
9237   }
9238 
9239   // If there are modifiers and if we're allowed to parse them, go for it.
9240   Done = !AllowTypeModifiers;
9241   while (!Done) {
9242     switch (char c = *Str++) {
9243     default: Done = true; --Str; break;
9244     case '*':
9245     case '&': {
9246       // Both pointers and references can have their pointee types
9247       // qualified with an address space.
9248       char *End;
9249       unsigned AddrSpace = strtoul(Str, &End, 10);
9250       if (End != Str && AddrSpace != 0) {
9251         Type = Context.getAddrSpaceQualType(Type,
9252                                             getLangASFromTargetAS(AddrSpace));
9253         Str = End;
9254       }
9255       if (c == '*')
9256         Type = Context.getPointerType(Type);
9257       else
9258         Type = Context.getLValueReferenceType(Type);
9259       break;
9260     }
9261     // FIXME: There's no way to have a built-in with an rvalue ref arg.
9262     case 'C':
9263       Type = Type.withConst();
9264       break;
9265     case 'D':
9266       Type = Context.getVolatileType(Type);
9267       break;
9268     case 'R':
9269       Type = Type.withRestrict();
9270       break;
9271     }
9272   }
9273 
9274   assert((!RequiresICE || Type->isIntegralOrEnumerationType()) &&
9275          "Integer constant 'I' type must be an integer");
9276 
9277   return Type;
9278 }
9279 
9280 /// GetBuiltinType - Return the type for the specified builtin.
9281 QualType ASTContext::GetBuiltinType(unsigned Id,
9282                                     GetBuiltinTypeError &Error,
9283                                     unsigned *IntegerConstantArgs) const {
9284   const char *TypeStr = BuiltinInfo.getTypeString(Id);
9285 
9286   SmallVector<QualType, 8> ArgTypes;
9287 
9288   bool RequiresICE = false;
9289   Error = GE_None;
9290   QualType ResType = DecodeTypeFromStr(TypeStr, *this, Error,
9291                                        RequiresICE, true);
9292   if (Error != GE_None)
9293     return {};
9294 
9295   assert(!RequiresICE && "Result of intrinsic cannot be required to be an ICE");
9296 
9297   while (TypeStr[0] && TypeStr[0] != '.') {
9298     QualType Ty = DecodeTypeFromStr(TypeStr, *this, Error, RequiresICE, true);
9299     if (Error != GE_None)
9300       return {};
9301 
9302     // If this argument is required to be an IntegerConstantExpression and the
9303     // caller cares, fill in the bitmask we return.
9304     if (RequiresICE && IntegerConstantArgs)
9305       *IntegerConstantArgs |= 1 << ArgTypes.size();
9306 
9307     // Do array -> pointer decay.  The builtin should use the decayed type.
9308     if (Ty->isArrayType())
9309       Ty = getArrayDecayedType(Ty);
9310 
9311     ArgTypes.push_back(Ty);
9312   }
9313 
9314   if (Id == Builtin::BI__GetExceptionInfo)
9315     return {};
9316 
9317   assert((TypeStr[0] != '.' || TypeStr[1] == 0) &&
9318          "'.' should only occur at end of builtin type list!");
9319 
9320   FunctionType::ExtInfo EI(CC_C);
9321   if (BuiltinInfo.isNoReturn(Id)) EI = EI.withNoReturn(true);
9322 
9323   bool Variadic = (TypeStr[0] == '.');
9324 
9325   // We really shouldn't be making a no-proto type here.
9326   if (ArgTypes.empty() && Variadic && !getLangOpts().CPlusPlus)
9327     return getFunctionNoProtoType(ResType, EI);
9328 
9329   FunctionProtoType::ExtProtoInfo EPI;
9330   EPI.ExtInfo = EI;
9331   EPI.Variadic = Variadic;
9332   if (getLangOpts().CPlusPlus && BuiltinInfo.isNoThrow(Id))
9333     EPI.ExceptionSpec.Type =
9334         getLangOpts().CPlusPlus11 ? EST_BasicNoexcept : EST_DynamicNone;
9335 
9336   return getFunctionType(ResType, ArgTypes, EPI);
9337 }
9338 
9339 static GVALinkage basicGVALinkageForFunction(const ASTContext &Context,
9340                                              const FunctionDecl *FD) {
9341   if (!FD->isExternallyVisible())
9342     return GVA_Internal;
9343 
9344   // Non-user-provided functions get emitted as weak definitions with every
9345   // use, no matter whether they've been explicitly instantiated etc.
9346   if (const auto *MD = dyn_cast<CXXMethodDecl>(FD))
9347     if (!MD->isUserProvided())
9348       return GVA_DiscardableODR;
9349 
9350   GVALinkage External;
9351   switch (FD->getTemplateSpecializationKind()) {
9352   case TSK_Undeclared:
9353   case TSK_ExplicitSpecialization:
9354     External = GVA_StrongExternal;
9355     break;
9356 
9357   case TSK_ExplicitInstantiationDefinition:
9358     return GVA_StrongODR;
9359 
9360   // C++11 [temp.explicit]p10:
9361   //   [ Note: The intent is that an inline function that is the subject of
9362   //   an explicit instantiation declaration will still be implicitly
9363   //   instantiated when used so that the body can be considered for
9364   //   inlining, but that no out-of-line copy of the inline function would be
9365   //   generated in the translation unit. -- end note ]
9366   case TSK_ExplicitInstantiationDeclaration:
9367     return GVA_AvailableExternally;
9368 
9369   case TSK_ImplicitInstantiation:
9370     External = GVA_DiscardableODR;
9371     break;
9372   }
9373 
9374   if (!FD->isInlined())
9375     return External;
9376 
9377   if ((!Context.getLangOpts().CPlusPlus &&
9378        !Context.getTargetInfo().getCXXABI().isMicrosoft() &&
9379        !FD->hasAttr<DLLExportAttr>()) ||
9380       FD->hasAttr<GNUInlineAttr>()) {
9381     // FIXME: This doesn't match gcc's behavior for dllexport inline functions.
9382 
9383     // GNU or C99 inline semantics. Determine whether this symbol should be
9384     // externally visible.
9385     if (FD->isInlineDefinitionExternallyVisible())
9386       return External;
9387 
9388     // C99 inline semantics, where the symbol is not externally visible.
9389     return GVA_AvailableExternally;
9390   }
9391 
9392   // Functions specified with extern and inline in -fms-compatibility mode
9393   // forcibly get emitted.  While the body of the function cannot be later
9394   // replaced, the function definition cannot be discarded.
9395   if (FD->isMSExternInline())
9396     return GVA_StrongODR;
9397 
9398   return GVA_DiscardableODR;
9399 }
9400 
9401 static GVALinkage adjustGVALinkageForAttributes(const ASTContext &Context,
9402                                                 const Decl *D, GVALinkage L) {
9403   // See http://msdn.microsoft.com/en-us/library/xa0d9ste.aspx
9404   // dllexport/dllimport on inline functions.
9405   if (D->hasAttr<DLLImportAttr>()) {
9406     if (L == GVA_DiscardableODR || L == GVA_StrongODR)
9407       return GVA_AvailableExternally;
9408   } else if (D->hasAttr<DLLExportAttr>()) {
9409     if (L == GVA_DiscardableODR)
9410       return GVA_StrongODR;
9411   } else if (Context.getLangOpts().CUDA && Context.getLangOpts().CUDAIsDevice &&
9412              D->hasAttr<CUDAGlobalAttr>()) {
9413     // Device-side functions with __global__ attribute must always be
9414     // visible externally so they can be launched from host.
9415     if (L == GVA_DiscardableODR || L == GVA_Internal)
9416       return GVA_StrongODR;
9417   }
9418   return L;
9419 }
9420 
9421 /// Adjust the GVALinkage for a declaration based on what an external AST source
9422 /// knows about whether there can be other definitions of this declaration.
9423 static GVALinkage
9424 adjustGVALinkageForExternalDefinitionKind(const ASTContext &Ctx, const Decl *D,
9425                                           GVALinkage L) {
9426   ExternalASTSource *Source = Ctx.getExternalSource();
9427   if (!Source)
9428     return L;
9429 
9430   switch (Source->hasExternalDefinitions(D)) {
9431   case ExternalASTSource::EK_Never:
9432     // Other translation units rely on us to provide the definition.
9433     if (L == GVA_DiscardableODR)
9434       return GVA_StrongODR;
9435     break;
9436 
9437   case ExternalASTSource::EK_Always:
9438     return GVA_AvailableExternally;
9439 
9440   case ExternalASTSource::EK_ReplyHazy:
9441     break;
9442   }
9443   return L;
9444 }
9445 
9446 GVALinkage ASTContext::GetGVALinkageForFunction(const FunctionDecl *FD) const {
9447   return adjustGVALinkageForExternalDefinitionKind(*this, FD,
9448            adjustGVALinkageForAttributes(*this, FD,
9449              basicGVALinkageForFunction(*this, FD)));
9450 }
9451 
9452 static GVALinkage basicGVALinkageForVariable(const ASTContext &Context,
9453                                              const VarDecl *VD) {
9454   if (!VD->isExternallyVisible())
9455     return GVA_Internal;
9456 
9457   if (VD->isStaticLocal()) {
9458     const DeclContext *LexicalContext = VD->getParentFunctionOrMethod();
9459     while (LexicalContext && !isa<FunctionDecl>(LexicalContext))
9460       LexicalContext = LexicalContext->getLexicalParent();
9461 
9462     // ObjC Blocks can create local variables that don't have a FunctionDecl
9463     // LexicalContext.
9464     if (!LexicalContext)
9465       return GVA_DiscardableODR;
9466 
9467     // Otherwise, let the static local variable inherit its linkage from the
9468     // nearest enclosing function.
9469     auto StaticLocalLinkage =
9470         Context.GetGVALinkageForFunction(cast<FunctionDecl>(LexicalContext));
9471 
9472     // Itanium ABI 5.2.2: "Each COMDAT group [for a static local variable] must
9473     // be emitted in any object with references to the symbol for the object it
9474     // contains, whether inline or out-of-line."
9475     // Similar behavior is observed with MSVC. An alternative ABI could use
9476     // StrongODR/AvailableExternally to match the function, but none are
9477     // known/supported currently.
9478     if (StaticLocalLinkage == GVA_StrongODR ||
9479         StaticLocalLinkage == GVA_AvailableExternally)
9480       return GVA_DiscardableODR;
9481     return StaticLocalLinkage;
9482   }
9483 
9484   // MSVC treats in-class initialized static data members as definitions.
9485   // By giving them non-strong linkage, out-of-line definitions won't
9486   // cause link errors.
9487   if (Context.isMSStaticDataMemberInlineDefinition(VD))
9488     return GVA_DiscardableODR;
9489 
9490   // Most non-template variables have strong linkage; inline variables are
9491   // linkonce_odr or (occasionally, for compatibility) weak_odr.
9492   GVALinkage StrongLinkage;
9493   switch (Context.getInlineVariableDefinitionKind(VD)) {
9494   case ASTContext::InlineVariableDefinitionKind::None:
9495     StrongLinkage = GVA_StrongExternal;
9496     break;
9497   case ASTContext::InlineVariableDefinitionKind::Weak:
9498   case ASTContext::InlineVariableDefinitionKind::WeakUnknown:
9499     StrongLinkage = GVA_DiscardableODR;
9500     break;
9501   case ASTContext::InlineVariableDefinitionKind::Strong:
9502     StrongLinkage = GVA_StrongODR;
9503     break;
9504   }
9505 
9506   switch (VD->getTemplateSpecializationKind()) {
9507   case TSK_Undeclared:
9508     return StrongLinkage;
9509 
9510   case TSK_ExplicitSpecialization:
9511     return Context.getTargetInfo().getCXXABI().isMicrosoft() &&
9512                    VD->isStaticDataMember()
9513                ? GVA_StrongODR
9514                : StrongLinkage;
9515 
9516   case TSK_ExplicitInstantiationDefinition:
9517     return GVA_StrongODR;
9518 
9519   case TSK_ExplicitInstantiationDeclaration:
9520     return GVA_AvailableExternally;
9521 
9522   case TSK_ImplicitInstantiation:
9523     return GVA_DiscardableODR;
9524   }
9525 
9526   llvm_unreachable("Invalid Linkage!");
9527 }
9528 
9529 GVALinkage ASTContext::GetGVALinkageForVariable(const VarDecl *VD) {
9530   return adjustGVALinkageForExternalDefinitionKind(*this, VD,
9531            adjustGVALinkageForAttributes(*this, VD,
9532              basicGVALinkageForVariable(*this, VD)));
9533 }
9534 
9535 bool ASTContext::DeclMustBeEmitted(const Decl *D) {
9536   if (const auto *VD = dyn_cast<VarDecl>(D)) {
9537     if (!VD->isFileVarDecl())
9538       return false;
9539     // Global named register variables (GNU extension) are never emitted.
9540     if (VD->getStorageClass() == SC_Register)
9541       return false;
9542     if (VD->getDescribedVarTemplate() ||
9543         isa<VarTemplatePartialSpecializationDecl>(VD))
9544       return false;
9545   } else if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
9546     // We never need to emit an uninstantiated function template.
9547     if (FD->getTemplatedKind() == FunctionDecl::TK_FunctionTemplate)
9548       return false;
9549   } else if (isa<PragmaCommentDecl>(D))
9550     return true;
9551   else if (isa<OMPThreadPrivateDecl>(D))
9552     return true;
9553   else if (isa<PragmaDetectMismatchDecl>(D))
9554     return true;
9555   else if (isa<OMPThreadPrivateDecl>(D))
9556     return !D->getDeclContext()->isDependentContext();
9557   else if (isa<OMPDeclareReductionDecl>(D))
9558     return !D->getDeclContext()->isDependentContext();
9559   else if (isa<ImportDecl>(D))
9560     return true;
9561   else
9562     return false;
9563 
9564   if (D->isFromASTFile() && !LangOpts.BuildingPCHWithObjectFile) {
9565     assert(getExternalSource() && "It's from an AST file; must have a source.");
9566     // On Windows, PCH files are built together with an object file. If this
9567     // declaration comes from such a PCH and DeclMustBeEmitted would return
9568     // true, it would have returned true and the decl would have been emitted
9569     // into that object file, so it doesn't need to be emitted here.
9570     // Note that decls are still emitted if they're referenced, as usual;
9571     // DeclMustBeEmitted is used to decide whether a decl must be emitted even
9572     // if it's not referenced.
9573     //
9574     // Explicit template instantiation definitions are tricky. If there was an
9575     // explicit template instantiation decl in the PCH before, it will look like
9576     // the definition comes from there, even if that was just the declaration.
9577     // (Explicit instantiation defs of variable templates always get emitted.)
9578     bool IsExpInstDef =
9579         isa<FunctionDecl>(D) &&
9580         cast<FunctionDecl>(D)->getTemplateSpecializationKind() ==
9581             TSK_ExplicitInstantiationDefinition;
9582 
9583     if (getExternalSource()->DeclIsFromPCHWithObjectFile(D) && !IsExpInstDef)
9584       return false;
9585   }
9586 
9587   // If this is a member of a class template, we do not need to emit it.
9588   if (D->getDeclContext()->isDependentContext())
9589     return false;
9590 
9591   // Weak references don't produce any output by themselves.
9592   if (D->hasAttr<WeakRefAttr>())
9593     return false;
9594 
9595   // Aliases and used decls are required.
9596   if (D->hasAttr<AliasAttr>() || D->hasAttr<UsedAttr>())
9597     return true;
9598 
9599   if (const auto *FD = dyn_cast<FunctionDecl>(D)) {
9600     // Forward declarations aren't required.
9601     if (!FD->doesThisDeclarationHaveABody())
9602       return FD->doesDeclarationForceExternallyVisibleDefinition();
9603 
9604     // Constructors and destructors are required.
9605     if (FD->hasAttr<ConstructorAttr>() || FD->hasAttr<DestructorAttr>())
9606       return true;
9607 
9608     // The key function for a class is required.  This rule only comes
9609     // into play when inline functions can be key functions, though.
9610     if (getTargetInfo().getCXXABI().canKeyFunctionBeInline()) {
9611       if (const auto *MD = dyn_cast<CXXMethodDecl>(FD)) {
9612         const CXXRecordDecl *RD = MD->getParent();
9613         if (MD->isOutOfLine() && RD->isDynamicClass()) {
9614           const CXXMethodDecl *KeyFunc = getCurrentKeyFunction(RD);
9615           if (KeyFunc && KeyFunc->getCanonicalDecl() == MD->getCanonicalDecl())
9616             return true;
9617         }
9618       }
9619     }
9620 
9621     GVALinkage Linkage = GetGVALinkageForFunction(FD);
9622 
9623     // static, static inline, always_inline, and extern inline functions can
9624     // always be deferred.  Normal inline functions can be deferred in C99/C++.
9625     // Implicit template instantiations can also be deferred in C++.
9626     return !isDiscardableGVALinkage(Linkage);
9627   }
9628 
9629   const auto *VD = cast<VarDecl>(D);
9630   assert(VD->isFileVarDecl() && "Expected file scoped var");
9631 
9632   if (VD->isThisDeclarationADefinition() == VarDecl::DeclarationOnly &&
9633       !isMSStaticDataMemberInlineDefinition(VD))
9634     return false;
9635 
9636   // Variables that can be needed in other TUs are required.
9637   auto Linkage = GetGVALinkageForVariable(VD);
9638   if (!isDiscardableGVALinkage(Linkage))
9639     return true;
9640 
9641   // We never need to emit a variable that is available in another TU.
9642   if (Linkage == GVA_AvailableExternally)
9643     return false;
9644 
9645   // Variables that have destruction with side-effects are required.
9646   if (VD->getType().isDestructedType())
9647     return true;
9648 
9649   // Variables that have initialization with side-effects are required.
9650   if (VD->getInit() && VD->getInit()->HasSideEffects(*this) &&
9651       // We can get a value-dependent initializer during error recovery.
9652       (VD->getInit()->isValueDependent() || !VD->evaluateValue()))
9653     return true;
9654 
9655   // Likewise, variables with tuple-like bindings are required if their
9656   // bindings have side-effects.
9657   if (const auto *DD = dyn_cast<DecompositionDecl>(VD))
9658     for (const auto *BD : DD->bindings())
9659       if (const auto *BindingVD = BD->getHoldingVar())
9660         if (DeclMustBeEmitted(BindingVD))
9661           return true;
9662 
9663   // If the decl is marked as `declare target`, it should be emitted.
9664   for (const auto *Decl : D->redecls()) {
9665     if (!Decl->hasAttrs())
9666       continue;
9667     if (const auto *Attr = Decl->getAttr<OMPDeclareTargetDeclAttr>())
9668       if (Attr->getMapType() != OMPDeclareTargetDeclAttr::MT_Link)
9669         return true;
9670   }
9671 
9672   return false;
9673 }
9674 
9675 void ASTContext::forEachMultiversionedFunctionVersion(
9676     const FunctionDecl *FD,
9677     llvm::function_ref<void(const FunctionDecl *)> Pred) const {
9678   assert(FD->isMultiVersion() && "Only valid for multiversioned functions");
9679   llvm::SmallDenseSet<const FunctionDecl*, 4> SeenDecls;
9680   FD = FD->getCanonicalDecl();
9681   for (auto *CurDecl :
9682        FD->getDeclContext()->getRedeclContext()->lookup(FD->getDeclName())) {
9683     FunctionDecl *CurFD = CurDecl->getAsFunction()->getCanonicalDecl();
9684     if (CurFD && hasSameType(CurFD->getType(), FD->getType()) &&
9685         std::end(SeenDecls) == llvm::find(SeenDecls, CurFD)) {
9686       SeenDecls.insert(CurFD);
9687       Pred(CurFD);
9688     }
9689   }
9690 }
9691 
9692 CallingConv ASTContext::getDefaultCallingConvention(bool IsVariadic,
9693                                                     bool IsCXXMethod) const {
9694   // Pass through to the C++ ABI object
9695   if (IsCXXMethod)
9696     return ABI->getDefaultMethodCallConv(IsVariadic);
9697 
9698   switch (LangOpts.getDefaultCallingConv()) {
9699   case LangOptions::DCC_None:
9700     break;
9701   case LangOptions::DCC_CDecl:
9702     return CC_C;
9703   case LangOptions::DCC_FastCall:
9704     if (getTargetInfo().hasFeature("sse2") && !IsVariadic)
9705       return CC_X86FastCall;
9706     break;
9707   case LangOptions::DCC_StdCall:
9708     if (!IsVariadic)
9709       return CC_X86StdCall;
9710     break;
9711   case LangOptions::DCC_VectorCall:
9712     // __vectorcall cannot be applied to variadic functions.
9713     if (!IsVariadic)
9714       return CC_X86VectorCall;
9715     break;
9716   case LangOptions::DCC_RegCall:
9717     // __regcall cannot be applied to variadic functions.
9718     if (!IsVariadic)
9719       return CC_X86RegCall;
9720     break;
9721   }
9722   return Target->getDefaultCallingConv(TargetInfo::CCMT_Unknown);
9723 }
9724 
9725 bool ASTContext::isNearlyEmpty(const CXXRecordDecl *RD) const {
9726   // Pass through to the C++ ABI object
9727   return ABI->isNearlyEmpty(RD);
9728 }
9729 
9730 VTableContextBase *ASTContext::getVTableContext() {
9731   if (!VTContext.get()) {
9732     if (Target->getCXXABI().isMicrosoft())
9733       VTContext.reset(new MicrosoftVTableContext(*this));
9734     else
9735       VTContext.reset(new ItaniumVTableContext(*this));
9736   }
9737   return VTContext.get();
9738 }
9739 
9740 MangleContext *ASTContext::createMangleContext() {
9741   switch (Target->getCXXABI().getKind()) {
9742   case TargetCXXABI::GenericAArch64:
9743   case TargetCXXABI::GenericItanium:
9744   case TargetCXXABI::GenericARM:
9745   case TargetCXXABI::GenericMIPS:
9746   case TargetCXXABI::iOS:
9747   case TargetCXXABI::iOS64:
9748   case TargetCXXABI::WebAssembly:
9749   case TargetCXXABI::WatchOS:
9750     return ItaniumMangleContext::create(*this, getDiagnostics());
9751   case TargetCXXABI::Microsoft:
9752     return MicrosoftMangleContext::create(*this, getDiagnostics());
9753   }
9754   llvm_unreachable("Unsupported ABI");
9755 }
9756 
9757 CXXABI::~CXXABI() = default;
9758 
9759 size_t ASTContext::getSideTableAllocatedMemory() const {
9760   return ASTRecordLayouts.getMemorySize() +
9761          llvm::capacity_in_bytes(ObjCLayouts) +
9762          llvm::capacity_in_bytes(KeyFunctions) +
9763          llvm::capacity_in_bytes(ObjCImpls) +
9764          llvm::capacity_in_bytes(BlockVarCopyInits) +
9765          llvm::capacity_in_bytes(DeclAttrs) +
9766          llvm::capacity_in_bytes(TemplateOrInstantiation) +
9767          llvm::capacity_in_bytes(InstantiatedFromUsingDecl) +
9768          llvm::capacity_in_bytes(InstantiatedFromUsingShadowDecl) +
9769          llvm::capacity_in_bytes(InstantiatedFromUnnamedFieldDecl) +
9770          llvm::capacity_in_bytes(OverriddenMethods) +
9771          llvm::capacity_in_bytes(Types) +
9772          llvm::capacity_in_bytes(VariableArrayTypes) +
9773          llvm::capacity_in_bytes(ClassScopeSpecializationPattern);
9774 }
9775 
9776 /// getIntTypeForBitwidth -
9777 /// sets integer QualTy according to specified details:
9778 /// bitwidth, signed/unsigned.
9779 /// Returns empty type if there is no appropriate target types.
9780 QualType ASTContext::getIntTypeForBitwidth(unsigned DestWidth,
9781                                            unsigned Signed) const {
9782   TargetInfo::IntType Ty = getTargetInfo().getIntTypeByWidth(DestWidth, Signed);
9783   CanQualType QualTy = getFromTargetType(Ty);
9784   if (!QualTy && DestWidth == 128)
9785     return Signed ? Int128Ty : UnsignedInt128Ty;
9786   return QualTy;
9787 }
9788 
9789 /// getRealTypeForBitwidth -
9790 /// sets floating point QualTy according to specified bitwidth.
9791 /// Returns empty type if there is no appropriate target types.
9792 QualType ASTContext::getRealTypeForBitwidth(unsigned DestWidth) const {
9793   TargetInfo::RealType Ty = getTargetInfo().getRealTypeByWidth(DestWidth);
9794   switch (Ty) {
9795   case TargetInfo::Float:
9796     return FloatTy;
9797   case TargetInfo::Double:
9798     return DoubleTy;
9799   case TargetInfo::LongDouble:
9800     return LongDoubleTy;
9801   case TargetInfo::Float128:
9802     return Float128Ty;
9803   case TargetInfo::NoFloat:
9804     return {};
9805   }
9806 
9807   llvm_unreachable("Unhandled TargetInfo::RealType value");
9808 }
9809 
9810 void ASTContext::setManglingNumber(const NamedDecl *ND, unsigned Number) {
9811   if (Number > 1)
9812     MangleNumbers[ND] = Number;
9813 }
9814 
9815 unsigned ASTContext::getManglingNumber(const NamedDecl *ND) const {
9816   auto I = MangleNumbers.find(ND);
9817   return I != MangleNumbers.end() ? I->second : 1;
9818 }
9819 
9820 void ASTContext::setStaticLocalNumber(const VarDecl *VD, unsigned Number) {
9821   if (Number > 1)
9822     StaticLocalNumbers[VD] = Number;
9823 }
9824 
9825 unsigned ASTContext::getStaticLocalNumber(const VarDecl *VD) const {
9826   auto I = StaticLocalNumbers.find(VD);
9827   return I != StaticLocalNumbers.end() ? I->second : 1;
9828 }
9829 
9830 MangleNumberingContext &
9831 ASTContext::getManglingNumberContext(const DeclContext *DC) {
9832   assert(LangOpts.CPlusPlus);  // We don't need mangling numbers for plain C.
9833   std::unique_ptr<MangleNumberingContext> &MCtx = MangleNumberingContexts[DC];
9834   if (!MCtx)
9835     MCtx = createMangleNumberingContext();
9836   return *MCtx;
9837 }
9838 
9839 std::unique_ptr<MangleNumberingContext>
9840 ASTContext::createMangleNumberingContext() const {
9841   return ABI->createMangleNumberingContext();
9842 }
9843 
9844 const CXXConstructorDecl *
9845 ASTContext::getCopyConstructorForExceptionObject(CXXRecordDecl *RD) {
9846   return ABI->getCopyConstructorForExceptionObject(
9847       cast<CXXRecordDecl>(RD->getFirstDecl()));
9848 }
9849 
9850 void ASTContext::addCopyConstructorForExceptionObject(CXXRecordDecl *RD,
9851                                                       CXXConstructorDecl *CD) {
9852   return ABI->addCopyConstructorForExceptionObject(
9853       cast<CXXRecordDecl>(RD->getFirstDecl()),
9854       cast<CXXConstructorDecl>(CD->getFirstDecl()));
9855 }
9856 
9857 void ASTContext::addTypedefNameForUnnamedTagDecl(TagDecl *TD,
9858                                                  TypedefNameDecl *DD) {
9859   return ABI->addTypedefNameForUnnamedTagDecl(TD, DD);
9860 }
9861 
9862 TypedefNameDecl *
9863 ASTContext::getTypedefNameForUnnamedTagDecl(const TagDecl *TD) {
9864   return ABI->getTypedefNameForUnnamedTagDecl(TD);
9865 }
9866 
9867 void ASTContext::addDeclaratorForUnnamedTagDecl(TagDecl *TD,
9868                                                 DeclaratorDecl *DD) {
9869   return ABI->addDeclaratorForUnnamedTagDecl(TD, DD);
9870 }
9871 
9872 DeclaratorDecl *ASTContext::getDeclaratorForUnnamedTagDecl(const TagDecl *TD) {
9873   return ABI->getDeclaratorForUnnamedTagDecl(TD);
9874 }
9875 
9876 void ASTContext::setParameterIndex(const ParmVarDecl *D, unsigned int index) {
9877   ParamIndices[D] = index;
9878 }
9879 
9880 unsigned ASTContext::getParameterIndex(const ParmVarDecl *D) const {
9881   ParameterIndexTable::const_iterator I = ParamIndices.find(D);
9882   assert(I != ParamIndices.end() &&
9883          "ParmIndices lacks entry set by ParmVarDecl");
9884   return I->second;
9885 }
9886 
9887 APValue *
9888 ASTContext::getMaterializedTemporaryValue(const MaterializeTemporaryExpr *E,
9889                                           bool MayCreate) {
9890   assert(E && E->getStorageDuration() == SD_Static &&
9891          "don't need to cache the computed value for this temporary");
9892   if (MayCreate) {
9893     APValue *&MTVI = MaterializedTemporaryValues[E];
9894     if (!MTVI)
9895       MTVI = new (*this) APValue;
9896     return MTVI;
9897   }
9898 
9899   return MaterializedTemporaryValues.lookup(E);
9900 }
9901 
9902 bool ASTContext::AtomicUsesUnsupportedLibcall(const AtomicExpr *E) const {
9903   const llvm::Triple &T = getTargetInfo().getTriple();
9904   if (!T.isOSDarwin())
9905     return false;
9906 
9907   if (!(T.isiOS() && T.isOSVersionLT(7)) &&
9908       !(T.isMacOSX() && T.isOSVersionLT(10, 9)))
9909     return false;
9910 
9911   QualType AtomicTy = E->getPtr()->getType()->getPointeeType();
9912   CharUnits sizeChars = getTypeSizeInChars(AtomicTy);
9913   uint64_t Size = sizeChars.getQuantity();
9914   CharUnits alignChars = getTypeAlignInChars(AtomicTy);
9915   unsigned Align = alignChars.getQuantity();
9916   unsigned MaxInlineWidthInBits = getTargetInfo().getMaxAtomicInlineWidth();
9917   return (Size != Align || toBits(sizeChars) > MaxInlineWidthInBits);
9918 }
9919 
9920 static ast_type_traits::DynTypedNode getSingleDynTypedNodeFromParentMap(
9921     ASTContext::ParentMapPointers::mapped_type U) {
9922   if (const auto *D = U.dyn_cast<const Decl *>())
9923     return ast_type_traits::DynTypedNode::create(*D);
9924   if (const auto *S = U.dyn_cast<const Stmt *>())
9925     return ast_type_traits::DynTypedNode::create(*S);
9926   return *U.get<ast_type_traits::DynTypedNode *>();
9927 }
9928 
9929 namespace {
9930 
9931 /// Template specializations to abstract away from pointers and TypeLocs.
9932 /// @{
9933 template <typename T>
9934 ast_type_traits::DynTypedNode createDynTypedNode(const T &Node) {
9935   return ast_type_traits::DynTypedNode::create(*Node);
9936 }
9937 template <>
9938 ast_type_traits::DynTypedNode createDynTypedNode(const TypeLoc &Node) {
9939   return ast_type_traits::DynTypedNode::create(Node);
9940 }
9941 template <>
9942 ast_type_traits::DynTypedNode
9943 createDynTypedNode(const NestedNameSpecifierLoc &Node) {
9944   return ast_type_traits::DynTypedNode::create(Node);
9945 }
9946 /// @}
9947 
9948   /// A \c RecursiveASTVisitor that builds a map from nodes to their
9949   /// parents as defined by the \c RecursiveASTVisitor.
9950   ///
9951   /// Note that the relationship described here is purely in terms of AST
9952   /// traversal - there are other relationships (for example declaration context)
9953   /// in the AST that are better modeled by special matchers.
9954   ///
9955   /// FIXME: Currently only builds up the map using \c Stmt and \c Decl nodes.
9956   class ParentMapASTVisitor : public RecursiveASTVisitor<ParentMapASTVisitor> {
9957   public:
9958     /// Builds and returns the translation unit's parent map.
9959     ///
9960     ///  The caller takes ownership of the returned \c ParentMap.
9961     static std::pair<ASTContext::ParentMapPointers *,
9962                      ASTContext::ParentMapOtherNodes *>
9963     buildMap(TranslationUnitDecl &TU) {
9964       ParentMapASTVisitor Visitor(new ASTContext::ParentMapPointers,
9965                                   new ASTContext::ParentMapOtherNodes);
9966       Visitor.TraverseDecl(&TU);
9967       return std::make_pair(Visitor.Parents, Visitor.OtherParents);
9968     }
9969 
9970   private:
9971     friend class RecursiveASTVisitor<ParentMapASTVisitor>;
9972 
9973     using VisitorBase = RecursiveASTVisitor<ParentMapASTVisitor>;
9974 
9975     ParentMapASTVisitor(ASTContext::ParentMapPointers *Parents,
9976                         ASTContext::ParentMapOtherNodes *OtherParents)
9977         : Parents(Parents), OtherParents(OtherParents) {}
9978 
9979     bool shouldVisitTemplateInstantiations() const {
9980       return true;
9981     }
9982 
9983     bool shouldVisitImplicitCode() const {
9984       return true;
9985     }
9986 
9987     template <typename T, typename MapNodeTy, typename BaseTraverseFn,
9988               typename MapTy>
9989     bool TraverseNode(T Node, MapNodeTy MapNode,
9990                       BaseTraverseFn BaseTraverse, MapTy *Parents) {
9991       if (!Node)
9992         return true;
9993       if (ParentStack.size() > 0) {
9994         // FIXME: Currently we add the same parent multiple times, but only
9995         // when no memoization data is available for the type.
9996         // For example when we visit all subexpressions of template
9997         // instantiations; this is suboptimal, but benign: the only way to
9998         // visit those is with hasAncestor / hasParent, and those do not create
9999         // new matches.
10000         // The plan is to enable DynTypedNode to be storable in a map or hash
10001         // map. The main problem there is to implement hash functions /
10002         // comparison operators for all types that DynTypedNode supports that
10003         // do not have pointer identity.
10004         auto &NodeOrVector = (*Parents)[MapNode];
10005         if (NodeOrVector.isNull()) {
10006           if (const auto *D = ParentStack.back().get<Decl>())
10007             NodeOrVector = D;
10008           else if (const auto *S = ParentStack.back().get<Stmt>())
10009             NodeOrVector = S;
10010           else
10011             NodeOrVector =
10012                 new ast_type_traits::DynTypedNode(ParentStack.back());
10013         } else {
10014           if (!NodeOrVector.template is<ASTContext::ParentVector *>()) {
10015             auto *Vector = new ASTContext::ParentVector(
10016                 1, getSingleDynTypedNodeFromParentMap(NodeOrVector));
10017             delete NodeOrVector
10018                     .template dyn_cast<ast_type_traits::DynTypedNode *>();
10019             NodeOrVector = Vector;
10020           }
10021 
10022           auto *Vector =
10023               NodeOrVector.template get<ASTContext::ParentVector *>();
10024           // Skip duplicates for types that have memoization data.
10025           // We must check that the type has memoization data before calling
10026           // std::find() because DynTypedNode::operator== can't compare all
10027           // types.
10028           bool Found = ParentStack.back().getMemoizationData() &&
10029                        std::find(Vector->begin(), Vector->end(),
10030                                  ParentStack.back()) != Vector->end();
10031           if (!Found)
10032             Vector->push_back(ParentStack.back());
10033         }
10034       }
10035       ParentStack.push_back(createDynTypedNode(Node));
10036       bool Result = BaseTraverse();
10037       ParentStack.pop_back();
10038       return Result;
10039     }
10040 
10041     bool TraverseDecl(Decl *DeclNode) {
10042       return TraverseNode(DeclNode, DeclNode,
10043                           [&] { return VisitorBase::TraverseDecl(DeclNode); },
10044                           Parents);
10045     }
10046 
10047     bool TraverseStmt(Stmt *StmtNode) {
10048       return TraverseNode(StmtNode, StmtNode,
10049                           [&] { return VisitorBase::TraverseStmt(StmtNode); },
10050                           Parents);
10051     }
10052 
10053     bool TraverseTypeLoc(TypeLoc TypeLocNode) {
10054       return TraverseNode(
10055           TypeLocNode, ast_type_traits::DynTypedNode::create(TypeLocNode),
10056           [&] { return VisitorBase::TraverseTypeLoc(TypeLocNode); },
10057           OtherParents);
10058     }
10059 
10060     bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNSLocNode) {
10061       return TraverseNode(
10062           NNSLocNode, ast_type_traits::DynTypedNode::create(NNSLocNode),
10063           [&] {
10064             return VisitorBase::TraverseNestedNameSpecifierLoc(NNSLocNode);
10065           },
10066           OtherParents);
10067     }
10068 
10069     ASTContext::ParentMapPointers *Parents;
10070     ASTContext::ParentMapOtherNodes *OtherParents;
10071     llvm::SmallVector<ast_type_traits::DynTypedNode, 16> ParentStack;
10072   };
10073 
10074 } // namespace
10075 
10076 template <typename NodeTy, typename MapTy>
10077 static ASTContext::DynTypedNodeList getDynNodeFromMap(const NodeTy &Node,
10078                                                       const MapTy &Map) {
10079   auto I = Map.find(Node);
10080   if (I == Map.end()) {
10081     return llvm::ArrayRef<ast_type_traits::DynTypedNode>();
10082   }
10083   if (const auto *V =
10084           I->second.template dyn_cast<ASTContext::ParentVector *>()) {
10085     return llvm::makeArrayRef(*V);
10086   }
10087   return getSingleDynTypedNodeFromParentMap(I->second);
10088 }
10089 
10090 ASTContext::DynTypedNodeList
10091 ASTContext::getParents(const ast_type_traits::DynTypedNode &Node) {
10092   if (!PointerParents) {
10093     // We always need to run over the whole translation unit, as
10094     // hasAncestor can escape any subtree.
10095     auto Maps = ParentMapASTVisitor::buildMap(*getTranslationUnitDecl());
10096     PointerParents.reset(Maps.first);
10097     OtherParents.reset(Maps.second);
10098   }
10099   if (Node.getNodeKind().hasPointerIdentity())
10100     return getDynNodeFromMap(Node.getMemoizationData(), *PointerParents);
10101   return getDynNodeFromMap(Node, *OtherParents);
10102 }
10103 
10104 bool
10105 ASTContext::ObjCMethodsAreEqual(const ObjCMethodDecl *MethodDecl,
10106                                 const ObjCMethodDecl *MethodImpl) {
10107   // No point trying to match an unavailable/deprecated mothod.
10108   if (MethodDecl->hasAttr<UnavailableAttr>()
10109       || MethodDecl->hasAttr<DeprecatedAttr>())
10110     return false;
10111   if (MethodDecl->getObjCDeclQualifier() !=
10112       MethodImpl->getObjCDeclQualifier())
10113     return false;
10114   if (!hasSameType(MethodDecl->getReturnType(), MethodImpl->getReturnType()))
10115     return false;
10116 
10117   if (MethodDecl->param_size() != MethodImpl->param_size())
10118     return false;
10119 
10120   for (ObjCMethodDecl::param_const_iterator IM = MethodImpl->param_begin(),
10121        IF = MethodDecl->param_begin(), EM = MethodImpl->param_end(),
10122        EF = MethodDecl->param_end();
10123        IM != EM && IF != EF; ++IM, ++IF) {
10124     const ParmVarDecl *DeclVar = (*IF);
10125     const ParmVarDecl *ImplVar = (*IM);
10126     if (ImplVar->getObjCDeclQualifier() != DeclVar->getObjCDeclQualifier())
10127       return false;
10128     if (!hasSameType(DeclVar->getType(), ImplVar->getType()))
10129       return false;
10130   }
10131 
10132   return (MethodDecl->isVariadic() == MethodImpl->isVariadic());
10133 }
10134 
10135 uint64_t ASTContext::getTargetNullPointerValue(QualType QT) const {
10136   LangAS AS;
10137   if (QT->getUnqualifiedDesugaredType()->isNullPtrType())
10138     AS = LangAS::Default;
10139   else
10140     AS = QT->getPointeeType().getAddressSpace();
10141 
10142   return getTargetInfo().getNullPointerValue(AS);
10143 }
10144 
10145 unsigned ASTContext::getTargetAddressSpace(LangAS AS) const {
10146   if (isTargetAddressSpace(AS))
10147     return toTargetAddressSpace(AS);
10148   else
10149     return (*AddrSpaceMap)[(unsigned)AS];
10150 }
10151 
10152 QualType ASTContext::getCorrespondingSaturatedType(QualType Ty) const {
10153   assert(Ty->isFixedPointType());
10154 
10155   if (Ty->isSaturatedFixedPointType()) return Ty;
10156 
10157   const auto &BT = Ty->getAs<BuiltinType>();
10158   switch (BT->getKind()) {
10159     default:
10160       llvm_unreachable("Not a fixed point type!");
10161     case BuiltinType::ShortAccum:
10162       return SatShortAccumTy;
10163     case BuiltinType::Accum:
10164       return SatAccumTy;
10165     case BuiltinType::LongAccum:
10166       return SatLongAccumTy;
10167     case BuiltinType::UShortAccum:
10168       return SatUnsignedShortAccumTy;
10169     case BuiltinType::UAccum:
10170       return SatUnsignedAccumTy;
10171     case BuiltinType::ULongAccum:
10172       return SatUnsignedLongAccumTy;
10173     case BuiltinType::ShortFract:
10174       return SatShortFractTy;
10175     case BuiltinType::Fract:
10176       return SatFractTy;
10177     case BuiltinType::LongFract:
10178       return SatLongFractTy;
10179     case BuiltinType::UShortFract:
10180       return SatUnsignedShortFractTy;
10181     case BuiltinType::UFract:
10182       return SatUnsignedFractTy;
10183     case BuiltinType::ULongFract:
10184       return SatUnsignedLongFractTy;
10185   }
10186 }
10187 
10188 // Explicitly instantiate this in case a Redeclarable<T> is used from a TU that
10189 // doesn't include ASTContext.h
10190 template
10191 clang::LazyGenerationalUpdatePtr<
10192     const Decl *, Decl *, &ExternalASTSource::CompleteRedeclChain>::ValueType
10193 clang::LazyGenerationalUpdatePtr<
10194     const Decl *, Decl *, &ExternalASTSource::CompleteRedeclChain>::makeValue(
10195         const clang::ASTContext &Ctx, Decl *Value);
10196 
10197 unsigned char ASTContext::getFixedPointScale(QualType Ty) const {
10198   assert(Ty->isFixedPointType());
10199 
10200   const auto *BT = Ty->getAs<BuiltinType>();
10201   const TargetInfo &Target = getTargetInfo();
10202   switch (BT->getKind()) {
10203     default:
10204       llvm_unreachable("Not a fixed point type!");
10205     case BuiltinType::ShortAccum:
10206     case BuiltinType::SatShortAccum:
10207       return Target.getShortAccumScale();
10208     case BuiltinType::Accum:
10209     case BuiltinType::SatAccum:
10210       return Target.getAccumScale();
10211     case BuiltinType::LongAccum:
10212     case BuiltinType::SatLongAccum:
10213       return Target.getLongAccumScale();
10214     case BuiltinType::UShortAccum:
10215     case BuiltinType::SatUShortAccum:
10216       return Target.getUnsignedShortAccumScale();
10217     case BuiltinType::UAccum:
10218     case BuiltinType::SatUAccum:
10219       return Target.getUnsignedAccumScale();
10220     case BuiltinType::ULongAccum:
10221     case BuiltinType::SatULongAccum:
10222       return Target.getUnsignedLongAccumScale();
10223     case BuiltinType::ShortFract:
10224     case BuiltinType::SatShortFract:
10225       return Target.getShortFractScale();
10226     case BuiltinType::Fract:
10227     case BuiltinType::SatFract:
10228       return Target.getFractScale();
10229     case BuiltinType::LongFract:
10230     case BuiltinType::SatLongFract:
10231       return Target.getLongFractScale();
10232     case BuiltinType::UShortFract:
10233     case BuiltinType::SatUShortFract:
10234       return Target.getUnsignedShortFractScale();
10235     case BuiltinType::UFract:
10236     case BuiltinType::SatUFract:
10237       return Target.getUnsignedFractScale();
10238     case BuiltinType::ULongFract:
10239     case BuiltinType::SatULongFract:
10240       return Target.getUnsignedLongFractScale();
10241   }
10242 }
10243 
10244 unsigned char ASTContext::getFixedPointIBits(QualType Ty) const {
10245   assert(Ty->isFixedPointType());
10246 
10247   const auto *BT = Ty->getAs<BuiltinType>();
10248   const TargetInfo &Target = getTargetInfo();
10249   switch (BT->getKind()) {
10250     default:
10251       llvm_unreachable("Not a fixed point type!");
10252     case BuiltinType::ShortAccum:
10253     case BuiltinType::SatShortAccum:
10254       return Target.getShortAccumIBits();
10255     case BuiltinType::Accum:
10256     case BuiltinType::SatAccum:
10257       return Target.getAccumIBits();
10258     case BuiltinType::LongAccum:
10259     case BuiltinType::SatLongAccum:
10260       return Target.getLongAccumIBits();
10261     case BuiltinType::UShortAccum:
10262     case BuiltinType::SatUShortAccum:
10263       return Target.getUnsignedShortAccumIBits();
10264     case BuiltinType::UAccum:
10265     case BuiltinType::SatUAccum:
10266       return Target.getUnsignedAccumIBits();
10267     case BuiltinType::ULongAccum:
10268     case BuiltinType::SatULongAccum:
10269       return Target.getUnsignedLongAccumIBits();
10270     case BuiltinType::ShortFract:
10271     case BuiltinType::SatShortFract:
10272     case BuiltinType::Fract:
10273     case BuiltinType::SatFract:
10274     case BuiltinType::LongFract:
10275     case BuiltinType::SatLongFract:
10276     case BuiltinType::UShortFract:
10277     case BuiltinType::SatUShortFract:
10278     case BuiltinType::UFract:
10279     case BuiltinType::SatUFract:
10280     case BuiltinType::ULongFract:
10281     case BuiltinType::SatULongFract:
10282       return 0;
10283   }
10284 }
10285