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