xref: /llvm-project/clang/lib/CodeGen/CodeGenModule.cpp (revision a729c62b81df17a1630de6b8f0709960bee9bc70)
1 //===--- CodeGenModule.cpp - Emit LLVM Code from ASTs for a Module --------===//
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 coordinates the per-module state used while generating code.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "CodeGenModule.h"
15 #include "CGDebugInfo.h"
16 #include "CodeGenFunction.h"
17 #include "CodeGenTBAA.h"
18 #include "CGCall.h"
19 #include "CGCUDARuntime.h"
20 #include "CGCXXABI.h"
21 #include "CGObjCRuntime.h"
22 #include "CGOpenCLRuntime.h"
23 #include "TargetInfo.h"
24 #include "clang/Frontend/CodeGenOptions.h"
25 #include "clang/AST/ASTContext.h"
26 #include "clang/AST/CharUnits.h"
27 #include "clang/AST/DeclObjC.h"
28 #include "clang/AST/DeclCXX.h"
29 #include "clang/AST/DeclTemplate.h"
30 #include "clang/AST/Mangle.h"
31 #include "clang/AST/RecordLayout.h"
32 #include "clang/AST/RecursiveASTVisitor.h"
33 #include "clang/Basic/Builtins.h"
34 #include "clang/Basic/Diagnostic.h"
35 #include "clang/Basic/SourceManager.h"
36 #include "clang/Basic/TargetInfo.h"
37 #include "clang/Basic/ConvertUTF.h"
38 #include "llvm/CallingConv.h"
39 #include "llvm/Module.h"
40 #include "llvm/Intrinsics.h"
41 #include "llvm/LLVMContext.h"
42 #include "llvm/ADT/Triple.h"
43 #include "llvm/Target/Mangler.h"
44 #include "llvm/Target/TargetData.h"
45 #include "llvm/Support/CallSite.h"
46 #include "llvm/Support/ErrorHandling.h"
47 using namespace clang;
48 using namespace CodeGen;
49 
50 static const char AnnotationSection[] = "llvm.metadata";
51 
52 static CGCXXABI &createCXXABI(CodeGenModule &CGM) {
53   switch (CGM.getContext().getTargetInfo().getCXXABI()) {
54   case CXXABI_ARM: return *CreateARMCXXABI(CGM);
55   case CXXABI_Itanium: return *CreateItaniumCXXABI(CGM);
56   case CXXABI_Microsoft: return *CreateMicrosoftCXXABI(CGM);
57   }
58 
59   llvm_unreachable("invalid C++ ABI kind");
60 }
61 
62 
63 CodeGenModule::CodeGenModule(ASTContext &C, const CodeGenOptions &CGO,
64                              llvm::Module &M, const llvm::TargetData &TD,
65                              DiagnosticsEngine &diags)
66   : Context(C), Features(C.getLangOptions()), CodeGenOpts(CGO), TheModule(M),
67     TheTargetData(TD), TheTargetCodeGenInfo(0), Diags(diags),
68     ABI(createCXXABI(*this)),
69     Types(*this),
70     TBAA(0),
71     VTables(*this), ObjCRuntime(0), OpenCLRuntime(0), CUDARuntime(0),
72     DebugInfo(0), ARCData(0), NoObjCARCExceptionsMetadata(0),
73     RRData(0), CFConstantStringClassRef(0),
74     ConstantStringClassRef(0), NSConstantStringType(0),
75     VMContext(M.getContext()),
76     NSConcreteGlobalBlock(0), NSConcreteStackBlock(0),
77     BlockObjectAssign(0), BlockObjectDispose(0),
78     BlockDescriptorType(0), GenericBlockLiteralType(0) {
79 
80   // Initialize the type cache.
81   llvm::LLVMContext &LLVMContext = M.getContext();
82   VoidTy = llvm::Type::getVoidTy(LLVMContext);
83   Int8Ty = llvm::Type::getInt8Ty(LLVMContext);
84   Int16Ty = llvm::Type::getInt16Ty(LLVMContext);
85   Int32Ty = llvm::Type::getInt32Ty(LLVMContext);
86   Int64Ty = llvm::Type::getInt64Ty(LLVMContext);
87   FloatTy = llvm::Type::getFloatTy(LLVMContext);
88   DoubleTy = llvm::Type::getDoubleTy(LLVMContext);
89   PointerWidthInBits = C.getTargetInfo().getPointerWidth(0);
90   PointerAlignInBytes =
91   C.toCharUnitsFromBits(C.getTargetInfo().getPointerAlign(0)).getQuantity();
92   IntTy = llvm::IntegerType::get(LLVMContext, C.getTargetInfo().getIntWidth());
93   IntPtrTy = llvm::IntegerType::get(LLVMContext, PointerWidthInBits);
94   Int8PtrTy = Int8Ty->getPointerTo(0);
95   Int8PtrPtrTy = Int8PtrTy->getPointerTo(0);
96 
97   if (Features.ObjC1)
98     createObjCRuntime();
99   if (Features.OpenCL)
100     createOpenCLRuntime();
101   if (Features.CUDA)
102     createCUDARuntime();
103 
104   // Enable TBAA unless it's suppressed.
105   if (!CodeGenOpts.RelaxedAliasing && CodeGenOpts.OptimizationLevel > 0)
106     TBAA = new CodeGenTBAA(Context, VMContext, getLangOptions(),
107                            ABI.getMangleContext());
108 
109   // If debug info or coverage generation is enabled, create the CGDebugInfo
110   // object.
111   if (CodeGenOpts.DebugInfo || CodeGenOpts.EmitGcovArcs ||
112       CodeGenOpts.EmitGcovNotes)
113     DebugInfo = new CGDebugInfo(*this);
114 
115   Block.GlobalUniqueCount = 0;
116 
117   if (C.getLangOptions().ObjCAutoRefCount)
118     ARCData = new ARCEntrypoints();
119   RRData = new RREntrypoints();
120 }
121 
122 CodeGenModule::~CodeGenModule() {
123   delete ObjCRuntime;
124   delete OpenCLRuntime;
125   delete CUDARuntime;
126   delete TheTargetCodeGenInfo;
127   delete &ABI;
128   delete TBAA;
129   delete DebugInfo;
130   delete ARCData;
131   delete RRData;
132 }
133 
134 void CodeGenModule::createObjCRuntime() {
135   if (!Features.NeXTRuntime)
136     ObjCRuntime = CreateGNUObjCRuntime(*this);
137   else
138     ObjCRuntime = CreateMacObjCRuntime(*this);
139 }
140 
141 void CodeGenModule::createOpenCLRuntime() {
142   OpenCLRuntime = new CGOpenCLRuntime(*this);
143 }
144 
145 void CodeGenModule::createCUDARuntime() {
146   CUDARuntime = CreateNVCUDARuntime(*this);
147 }
148 
149 void CodeGenModule::Release() {
150   EmitDeferred();
151   EmitCXXGlobalInitFunc();
152   EmitCXXGlobalDtorFunc();
153   if (ObjCRuntime)
154     if (llvm::Function *ObjCInitFunction = ObjCRuntime->ModuleInitFunction())
155       AddGlobalCtor(ObjCInitFunction);
156   EmitCtorList(GlobalCtors, "llvm.global_ctors");
157   EmitCtorList(GlobalDtors, "llvm.global_dtors");
158   EmitGlobalAnnotations();
159   EmitLLVMUsed();
160 
161   SimplifyPersonality();
162 
163   if (getCodeGenOpts().EmitDeclMetadata)
164     EmitDeclMetadata();
165 
166   if (getCodeGenOpts().EmitGcovArcs || getCodeGenOpts().EmitGcovNotes)
167     EmitCoverageFile();
168 
169   if (DebugInfo)
170     DebugInfo->finalize();
171 }
172 
173 void CodeGenModule::UpdateCompletedType(const TagDecl *TD) {
174   // Make sure that this type is translated.
175   Types.UpdateCompletedType(TD);
176   if (DebugInfo)
177     DebugInfo->UpdateCompletedType(TD);
178 }
179 
180 llvm::MDNode *CodeGenModule::getTBAAInfo(QualType QTy) {
181   if (!TBAA)
182     return 0;
183   return TBAA->getTBAAInfo(QTy);
184 }
185 
186 void CodeGenModule::DecorateInstruction(llvm::Instruction *Inst,
187                                         llvm::MDNode *TBAAInfo) {
188   Inst->setMetadata(llvm::LLVMContext::MD_tbaa, TBAAInfo);
189 }
190 
191 bool CodeGenModule::isTargetDarwin() const {
192   return getContext().getTargetInfo().getTriple().isOSDarwin();
193 }
194 
195 void CodeGenModule::Error(SourceLocation loc, StringRef error) {
196   unsigned diagID = getDiags().getCustomDiagID(DiagnosticsEngine::Error, error);
197   getDiags().Report(Context.getFullLoc(loc), diagID);
198 }
199 
200 /// ErrorUnsupported - Print out an error that codegen doesn't support the
201 /// specified stmt yet.
202 void CodeGenModule::ErrorUnsupported(const Stmt *S, const char *Type,
203                                      bool OmitOnError) {
204   if (OmitOnError && getDiags().hasErrorOccurred())
205     return;
206   unsigned DiagID = getDiags().getCustomDiagID(DiagnosticsEngine::Error,
207                                                "cannot compile this %0 yet");
208   std::string Msg = Type;
209   getDiags().Report(Context.getFullLoc(S->getLocStart()), DiagID)
210     << Msg << S->getSourceRange();
211 }
212 
213 /// ErrorUnsupported - Print out an error that codegen doesn't support the
214 /// specified decl yet.
215 void CodeGenModule::ErrorUnsupported(const Decl *D, const char *Type,
216                                      bool OmitOnError) {
217   if (OmitOnError && getDiags().hasErrorOccurred())
218     return;
219   unsigned DiagID = getDiags().getCustomDiagID(DiagnosticsEngine::Error,
220                                                "cannot compile this %0 yet");
221   std::string Msg = Type;
222   getDiags().Report(Context.getFullLoc(D->getLocation()), DiagID) << Msg;
223 }
224 
225 llvm::ConstantInt *CodeGenModule::getSize(CharUnits size) {
226   return llvm::ConstantInt::get(SizeTy, size.getQuantity());
227 }
228 
229 void CodeGenModule::setGlobalVisibility(llvm::GlobalValue *GV,
230                                         const NamedDecl *D) const {
231   // Internal definitions always have default visibility.
232   if (GV->hasLocalLinkage()) {
233     GV->setVisibility(llvm::GlobalValue::DefaultVisibility);
234     return;
235   }
236 
237   // Set visibility for definitions.
238   NamedDecl::LinkageInfo LV = D->getLinkageAndVisibility();
239   if (LV.visibilityExplicit() || !GV->hasAvailableExternallyLinkage())
240     GV->setVisibility(GetLLVMVisibility(LV.visibility()));
241 }
242 
243 /// Set the symbol visibility of type information (vtable and RTTI)
244 /// associated with the given type.
245 void CodeGenModule::setTypeVisibility(llvm::GlobalValue *GV,
246                                       const CXXRecordDecl *RD,
247                                       TypeVisibilityKind TVK) const {
248   setGlobalVisibility(GV, RD);
249 
250   if (!CodeGenOpts.HiddenWeakVTables)
251     return;
252 
253   // We never want to drop the visibility for RTTI names.
254   if (TVK == TVK_ForRTTIName)
255     return;
256 
257   // We want to drop the visibility to hidden for weak type symbols.
258   // This isn't possible if there might be unresolved references
259   // elsewhere that rely on this symbol being visible.
260 
261   // This should be kept roughly in sync with setThunkVisibility
262   // in CGVTables.cpp.
263 
264   // Preconditions.
265   if (GV->getLinkage() != llvm::GlobalVariable::LinkOnceODRLinkage ||
266       GV->getVisibility() != llvm::GlobalVariable::DefaultVisibility)
267     return;
268 
269   // Don't override an explicit visibility attribute.
270   if (RD->getExplicitVisibility())
271     return;
272 
273   switch (RD->getTemplateSpecializationKind()) {
274   // We have to disable the optimization if this is an EI definition
275   // because there might be EI declarations in other shared objects.
276   case TSK_ExplicitInstantiationDefinition:
277   case TSK_ExplicitInstantiationDeclaration:
278     return;
279 
280   // Every use of a non-template class's type information has to emit it.
281   case TSK_Undeclared:
282     break;
283 
284   // In theory, implicit instantiations can ignore the possibility of
285   // an explicit instantiation declaration because there necessarily
286   // must be an EI definition somewhere with default visibility.  In
287   // practice, it's possible to have an explicit instantiation for
288   // an arbitrary template class, and linkers aren't necessarily able
289   // to deal with mixed-visibility symbols.
290   case TSK_ExplicitSpecialization:
291   case TSK_ImplicitInstantiation:
292     if (!CodeGenOpts.HiddenWeakTemplateVTables)
293       return;
294     break;
295   }
296 
297   // If there's a key function, there may be translation units
298   // that don't have the key function's definition.  But ignore
299   // this if we're emitting RTTI under -fno-rtti.
300   if (!(TVK != TVK_ForRTTI) || Features.RTTI) {
301     if (Context.getKeyFunction(RD))
302       return;
303   }
304 
305   // Otherwise, drop the visibility to hidden.
306   GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
307   GV->setUnnamedAddr(true);
308 }
309 
310 StringRef CodeGenModule::getMangledName(GlobalDecl GD) {
311   const NamedDecl *ND = cast<NamedDecl>(GD.getDecl());
312 
313   StringRef &Str = MangledDeclNames[GD.getCanonicalDecl()];
314   if (!Str.empty())
315     return Str;
316 
317   if (!getCXXABI().getMangleContext().shouldMangleDeclName(ND)) {
318     IdentifierInfo *II = ND->getIdentifier();
319     assert(II && "Attempt to mangle unnamed decl.");
320 
321     Str = II->getName();
322     return Str;
323   }
324 
325   SmallString<256> Buffer;
326   llvm::raw_svector_ostream Out(Buffer);
327   if (const CXXConstructorDecl *D = dyn_cast<CXXConstructorDecl>(ND))
328     getCXXABI().getMangleContext().mangleCXXCtor(D, GD.getCtorType(), Out);
329   else if (const CXXDestructorDecl *D = dyn_cast<CXXDestructorDecl>(ND))
330     getCXXABI().getMangleContext().mangleCXXDtor(D, GD.getDtorType(), Out);
331   else if (const BlockDecl *BD = dyn_cast<BlockDecl>(ND))
332     getCXXABI().getMangleContext().mangleBlock(BD, Out);
333   else
334     getCXXABI().getMangleContext().mangleName(ND, Out);
335 
336   // Allocate space for the mangled name.
337   Out.flush();
338   size_t Length = Buffer.size();
339   char *Name = MangledNamesAllocator.Allocate<char>(Length);
340   std::copy(Buffer.begin(), Buffer.end(), Name);
341 
342   Str = StringRef(Name, Length);
343 
344   return Str;
345 }
346 
347 void CodeGenModule::getBlockMangledName(GlobalDecl GD, MangleBuffer &Buffer,
348                                         const BlockDecl *BD) {
349   MangleContext &MangleCtx = getCXXABI().getMangleContext();
350   const Decl *D = GD.getDecl();
351   llvm::raw_svector_ostream Out(Buffer.getBuffer());
352   if (D == 0)
353     MangleCtx.mangleGlobalBlock(BD, Out);
354   else if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(D))
355     MangleCtx.mangleCtorBlock(CD, GD.getCtorType(), BD, Out);
356   else if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(D))
357     MangleCtx.mangleDtorBlock(DD, GD.getDtorType(), BD, Out);
358   else
359     MangleCtx.mangleBlock(cast<DeclContext>(D), BD, Out);
360 }
361 
362 llvm::GlobalValue *CodeGenModule::GetGlobalValue(StringRef Name) {
363   return getModule().getNamedValue(Name);
364 }
365 
366 /// AddGlobalCtor - Add a function to the list that will be called before
367 /// main() runs.
368 void CodeGenModule::AddGlobalCtor(llvm::Function * Ctor, int Priority) {
369   // FIXME: Type coercion of void()* types.
370   GlobalCtors.push_back(std::make_pair(Ctor, Priority));
371 }
372 
373 /// AddGlobalDtor - Add a function to the list that will be called
374 /// when the module is unloaded.
375 void CodeGenModule::AddGlobalDtor(llvm::Function * Dtor, int Priority) {
376   // FIXME: Type coercion of void()* types.
377   GlobalDtors.push_back(std::make_pair(Dtor, Priority));
378 }
379 
380 void CodeGenModule::EmitCtorList(const CtorList &Fns, const char *GlobalName) {
381   // Ctor function type is void()*.
382   llvm::FunctionType* CtorFTy = llvm::FunctionType::get(VoidTy, false);
383   llvm::Type *CtorPFTy = llvm::PointerType::getUnqual(CtorFTy);
384 
385   // Get the type of a ctor entry, { i32, void ()* }.
386   llvm::StructType *CtorStructTy =
387     llvm::StructType::get(Int32Ty, llvm::PointerType::getUnqual(CtorFTy), NULL);
388 
389   // Construct the constructor and destructor arrays.
390   SmallVector<llvm::Constant*, 8> Ctors;
391   for (CtorList::const_iterator I = Fns.begin(), E = Fns.end(); I != E; ++I) {
392     llvm::Constant *S[] = {
393       llvm::ConstantInt::get(Int32Ty, I->second, false),
394       llvm::ConstantExpr::getBitCast(I->first, CtorPFTy)
395     };
396     Ctors.push_back(llvm::ConstantStruct::get(CtorStructTy, S));
397   }
398 
399   if (!Ctors.empty()) {
400     llvm::ArrayType *AT = llvm::ArrayType::get(CtorStructTy, Ctors.size());
401     new llvm::GlobalVariable(TheModule, AT, false,
402                              llvm::GlobalValue::AppendingLinkage,
403                              llvm::ConstantArray::get(AT, Ctors),
404                              GlobalName);
405   }
406 }
407 
408 llvm::GlobalValue::LinkageTypes
409 CodeGenModule::getFunctionLinkage(const FunctionDecl *D) {
410   GVALinkage Linkage = getContext().GetGVALinkageForFunction(D);
411 
412   if (Linkage == GVA_Internal)
413     return llvm::Function::InternalLinkage;
414 
415   if (D->hasAttr<DLLExportAttr>())
416     return llvm::Function::DLLExportLinkage;
417 
418   if (D->hasAttr<WeakAttr>())
419     return llvm::Function::WeakAnyLinkage;
420 
421   // In C99 mode, 'inline' functions are guaranteed to have a strong
422   // definition somewhere else, so we can use available_externally linkage.
423   if (Linkage == GVA_C99Inline)
424     return llvm::Function::AvailableExternallyLinkage;
425 
426   // Note that Apple's kernel linker doesn't support symbol
427   // coalescing, so we need to avoid linkonce and weak linkages there.
428   // Normally, this means we just map to internal, but for explicit
429   // instantiations we'll map to external.
430 
431   // In C++, the compiler has to emit a definition in every translation unit
432   // that references the function.  We should use linkonce_odr because
433   // a) if all references in this translation unit are optimized away, we
434   // don't need to codegen it.  b) if the function persists, it needs to be
435   // merged with other definitions. c) C++ has the ODR, so we know the
436   // definition is dependable.
437   if (Linkage == GVA_CXXInline || Linkage == GVA_TemplateInstantiation)
438     return !Context.getLangOptions().AppleKext
439              ? llvm::Function::LinkOnceODRLinkage
440              : llvm::Function::InternalLinkage;
441 
442   // An explicit instantiation of a template has weak linkage, since
443   // explicit instantiations can occur in multiple translation units
444   // and must all be equivalent. However, we are not allowed to
445   // throw away these explicit instantiations.
446   if (Linkage == GVA_ExplicitTemplateInstantiation)
447     return !Context.getLangOptions().AppleKext
448              ? llvm::Function::WeakODRLinkage
449              : llvm::Function::ExternalLinkage;
450 
451   // Otherwise, we have strong external linkage.
452   assert(Linkage == GVA_StrongExternal);
453   return llvm::Function::ExternalLinkage;
454 }
455 
456 
457 /// SetFunctionDefinitionAttributes - Set attributes for a global.
458 ///
459 /// FIXME: This is currently only done for aliases and functions, but not for
460 /// variables (these details are set in EmitGlobalVarDefinition for variables).
461 void CodeGenModule::SetFunctionDefinitionAttributes(const FunctionDecl *D,
462                                                     llvm::GlobalValue *GV) {
463   SetCommonAttributes(D, GV);
464 }
465 
466 void CodeGenModule::SetLLVMFunctionAttributes(const Decl *D,
467                                               const CGFunctionInfo &Info,
468                                               llvm::Function *F) {
469   unsigned CallingConv;
470   AttributeListType AttributeList;
471   ConstructAttributeList(Info, D, AttributeList, CallingConv);
472   F->setAttributes(llvm::AttrListPtr::get(AttributeList.begin(),
473                                           AttributeList.size()));
474   F->setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
475 }
476 
477 /// Determines whether the language options require us to model
478 /// unwind exceptions.  We treat -fexceptions as mandating this
479 /// except under the fragile ObjC ABI with only ObjC exceptions
480 /// enabled.  This means, for example, that C with -fexceptions
481 /// enables this.
482 static bool hasUnwindExceptions(const LangOptions &Features) {
483   // If exceptions are completely disabled, obviously this is false.
484   if (!Features.Exceptions) return false;
485 
486   // If C++ exceptions are enabled, this is true.
487   if (Features.CXXExceptions) return true;
488 
489   // If ObjC exceptions are enabled, this depends on the ABI.
490   if (Features.ObjCExceptions) {
491     if (!Features.ObjCNonFragileABI) return false;
492   }
493 
494   return true;
495 }
496 
497 void CodeGenModule::SetLLVMFunctionAttributesForDefinition(const Decl *D,
498                                                            llvm::Function *F) {
499   if (CodeGenOpts.UnwindTables)
500     F->setHasUWTable();
501 
502   if (!hasUnwindExceptions(Features))
503     F->addFnAttr(llvm::Attribute::NoUnwind);
504 
505   if (D->hasAttr<NakedAttr>()) {
506     // Naked implies noinline: we should not be inlining such functions.
507     F->addFnAttr(llvm::Attribute::Naked);
508     F->addFnAttr(llvm::Attribute::NoInline);
509   }
510 
511   if (D->hasAttr<NoInlineAttr>())
512     F->addFnAttr(llvm::Attribute::NoInline);
513 
514   // (noinline wins over always_inline, and we can't specify both in IR)
515   if (D->hasAttr<AlwaysInlineAttr>() &&
516       !F->hasFnAttr(llvm::Attribute::NoInline))
517     F->addFnAttr(llvm::Attribute::AlwaysInline);
518 
519   if (isa<CXXConstructorDecl>(D) || isa<CXXDestructorDecl>(D))
520     F->setUnnamedAddr(true);
521 
522   if (Features.getStackProtector() == LangOptions::SSPOn)
523     F->addFnAttr(llvm::Attribute::StackProtect);
524   else if (Features.getStackProtector() == LangOptions::SSPReq)
525     F->addFnAttr(llvm::Attribute::StackProtectReq);
526 
527   if (Features.AddressSanitizer) {
528     // When AddressSanitizer is enabled, set AddressSafety attribute
529     // unless __attribute__((no_address_safety_analysis)) is used.
530     if (!D->hasAttr<NoAddressSafetyAnalysisAttr>())
531       F->addFnAttr(llvm::Attribute::AddressSafety);
532   }
533 
534   unsigned alignment = D->getMaxAlignment() / Context.getCharWidth();
535   if (alignment)
536     F->setAlignment(alignment);
537 
538   // C++ ABI requires 2-byte alignment for member functions.
539   if (F->getAlignment() < 2 && isa<CXXMethodDecl>(D))
540     F->setAlignment(2);
541 }
542 
543 void CodeGenModule::SetCommonAttributes(const Decl *D,
544                                         llvm::GlobalValue *GV) {
545   if (const NamedDecl *ND = dyn_cast<NamedDecl>(D))
546     setGlobalVisibility(GV, ND);
547   else
548     GV->setVisibility(llvm::GlobalValue::DefaultVisibility);
549 
550   if (D->hasAttr<UsedAttr>())
551     AddUsedGlobal(GV);
552 
553   if (const SectionAttr *SA = D->getAttr<SectionAttr>())
554     GV->setSection(SA->getName());
555 
556   getTargetCodeGenInfo().SetTargetAttributes(D, GV, *this);
557 }
558 
559 void CodeGenModule::SetInternalFunctionAttributes(const Decl *D,
560                                                   llvm::Function *F,
561                                                   const CGFunctionInfo &FI) {
562   SetLLVMFunctionAttributes(D, FI, F);
563   SetLLVMFunctionAttributesForDefinition(D, F);
564 
565   F->setLinkage(llvm::Function::InternalLinkage);
566 
567   SetCommonAttributes(D, F);
568 }
569 
570 void CodeGenModule::SetFunctionAttributes(GlobalDecl GD,
571                                           llvm::Function *F,
572                                           bool IsIncompleteFunction) {
573   if (unsigned IID = F->getIntrinsicID()) {
574     // If this is an intrinsic function, set the function's attributes
575     // to the intrinsic's attributes.
576     F->setAttributes(llvm::Intrinsic::getAttributes((llvm::Intrinsic::ID)IID));
577     return;
578   }
579 
580   const FunctionDecl *FD = cast<FunctionDecl>(GD.getDecl());
581 
582   if (!IsIncompleteFunction)
583     SetLLVMFunctionAttributes(FD, getTypes().arrangeGlobalDeclaration(GD), F);
584 
585   // Only a few attributes are set on declarations; these may later be
586   // overridden by a definition.
587 
588   if (FD->hasAttr<DLLImportAttr>()) {
589     F->setLinkage(llvm::Function::DLLImportLinkage);
590   } else if (FD->hasAttr<WeakAttr>() ||
591              FD->isWeakImported()) {
592     // "extern_weak" is overloaded in LLVM; we probably should have
593     // separate linkage types for this.
594     F->setLinkage(llvm::Function::ExternalWeakLinkage);
595   } else {
596     F->setLinkage(llvm::Function::ExternalLinkage);
597 
598     NamedDecl::LinkageInfo LV = FD->getLinkageAndVisibility();
599     if (LV.linkage() == ExternalLinkage && LV.visibilityExplicit()) {
600       F->setVisibility(GetLLVMVisibility(LV.visibility()));
601     }
602   }
603 
604   if (const SectionAttr *SA = FD->getAttr<SectionAttr>())
605     F->setSection(SA->getName());
606 }
607 
608 void CodeGenModule::AddUsedGlobal(llvm::GlobalValue *GV) {
609   assert(!GV->isDeclaration() &&
610          "Only globals with definition can force usage.");
611   LLVMUsed.push_back(GV);
612 }
613 
614 void CodeGenModule::EmitLLVMUsed() {
615   // Don't create llvm.used if there is no need.
616   if (LLVMUsed.empty())
617     return;
618 
619   // Convert LLVMUsed to what ConstantArray needs.
620   SmallVector<llvm::Constant*, 8> UsedArray;
621   UsedArray.resize(LLVMUsed.size());
622   for (unsigned i = 0, e = LLVMUsed.size(); i != e; ++i) {
623     UsedArray[i] =
624      llvm::ConstantExpr::getBitCast(cast<llvm::Constant>(&*LLVMUsed[i]),
625                                     Int8PtrTy);
626   }
627 
628   if (UsedArray.empty())
629     return;
630   llvm::ArrayType *ATy = llvm::ArrayType::get(Int8PtrTy, UsedArray.size());
631 
632   llvm::GlobalVariable *GV =
633     new llvm::GlobalVariable(getModule(), ATy, false,
634                              llvm::GlobalValue::AppendingLinkage,
635                              llvm::ConstantArray::get(ATy, UsedArray),
636                              "llvm.used");
637 
638   GV->setSection("llvm.metadata");
639 }
640 
641 void CodeGenModule::EmitDeferred() {
642   // Emit code for any potentially referenced deferred decls.  Since a
643   // previously unused static decl may become used during the generation of code
644   // for a static function, iterate until no changes are made.
645 
646   while (!DeferredDeclsToEmit.empty() || !DeferredVTables.empty()) {
647     if (!DeferredVTables.empty()) {
648       const CXXRecordDecl *RD = DeferredVTables.back();
649       DeferredVTables.pop_back();
650       getVTables().GenerateClassData(getVTableLinkage(RD), RD);
651       continue;
652     }
653 
654     GlobalDecl D = DeferredDeclsToEmit.back();
655     DeferredDeclsToEmit.pop_back();
656 
657     // Check to see if we've already emitted this.  This is necessary
658     // for a couple of reasons: first, decls can end up in the
659     // deferred-decls queue multiple times, and second, decls can end
660     // up with definitions in unusual ways (e.g. by an extern inline
661     // function acquiring a strong function redefinition).  Just
662     // ignore these cases.
663     //
664     // TODO: That said, looking this up multiple times is very wasteful.
665     StringRef Name = getMangledName(D);
666     llvm::GlobalValue *CGRef = GetGlobalValue(Name);
667     assert(CGRef && "Deferred decl wasn't referenced?");
668 
669     if (!CGRef->isDeclaration())
670       continue;
671 
672     // GlobalAlias::isDeclaration() defers to the aliasee, but for our
673     // purposes an alias counts as a definition.
674     if (isa<llvm::GlobalAlias>(CGRef))
675       continue;
676 
677     // Otherwise, emit the definition and move on to the next one.
678     EmitGlobalDefinition(D);
679   }
680 }
681 
682 void CodeGenModule::EmitGlobalAnnotations() {
683   if (Annotations.empty())
684     return;
685 
686   // Create a new global variable for the ConstantStruct in the Module.
687   llvm::Constant *Array = llvm::ConstantArray::get(llvm::ArrayType::get(
688     Annotations[0]->getType(), Annotations.size()), Annotations);
689   llvm::GlobalValue *gv = new llvm::GlobalVariable(getModule(),
690     Array->getType(), false, llvm::GlobalValue::AppendingLinkage, Array,
691     "llvm.global.annotations");
692   gv->setSection(AnnotationSection);
693 }
694 
695 llvm::Constant *CodeGenModule::EmitAnnotationString(llvm::StringRef Str) {
696   llvm::StringMap<llvm::Constant*>::iterator i = AnnotationStrings.find(Str);
697   if (i != AnnotationStrings.end())
698     return i->second;
699 
700   // Not found yet, create a new global.
701   llvm::Constant *s = llvm::ConstantDataArray::getString(getLLVMContext(), Str);
702   llvm::GlobalValue *gv = new llvm::GlobalVariable(getModule(), s->getType(),
703     true, llvm::GlobalValue::PrivateLinkage, s, ".str");
704   gv->setSection(AnnotationSection);
705   gv->setUnnamedAddr(true);
706   AnnotationStrings[Str] = gv;
707   return gv;
708 }
709 
710 llvm::Constant *CodeGenModule::EmitAnnotationUnit(SourceLocation Loc) {
711   SourceManager &SM = getContext().getSourceManager();
712   PresumedLoc PLoc = SM.getPresumedLoc(Loc);
713   if (PLoc.isValid())
714     return EmitAnnotationString(PLoc.getFilename());
715   return EmitAnnotationString(SM.getBufferName(Loc));
716 }
717 
718 llvm::Constant *CodeGenModule::EmitAnnotationLineNo(SourceLocation L) {
719   SourceManager &SM = getContext().getSourceManager();
720   PresumedLoc PLoc = SM.getPresumedLoc(L);
721   unsigned LineNo = PLoc.isValid() ? PLoc.getLine() :
722     SM.getExpansionLineNumber(L);
723   return llvm::ConstantInt::get(Int32Ty, LineNo);
724 }
725 
726 llvm::Constant *CodeGenModule::EmitAnnotateAttr(llvm::GlobalValue *GV,
727                                                 const AnnotateAttr *AA,
728                                                 SourceLocation L) {
729   // Get the globals for file name, annotation, and the line number.
730   llvm::Constant *AnnoGV = EmitAnnotationString(AA->getAnnotation()),
731                  *UnitGV = EmitAnnotationUnit(L),
732                  *LineNoCst = EmitAnnotationLineNo(L);
733 
734   // Create the ConstantStruct for the global annotation.
735   llvm::Constant *Fields[4] = {
736     llvm::ConstantExpr::getBitCast(GV, Int8PtrTy),
737     llvm::ConstantExpr::getBitCast(AnnoGV, Int8PtrTy),
738     llvm::ConstantExpr::getBitCast(UnitGV, Int8PtrTy),
739     LineNoCst
740   };
741   return llvm::ConstantStruct::getAnon(Fields);
742 }
743 
744 void CodeGenModule::AddGlobalAnnotations(const ValueDecl *D,
745                                          llvm::GlobalValue *GV) {
746   assert(D->hasAttr<AnnotateAttr>() && "no annotate attribute");
747   // Get the struct elements for these annotations.
748   for (specific_attr_iterator<AnnotateAttr>
749        ai = D->specific_attr_begin<AnnotateAttr>(),
750        ae = D->specific_attr_end<AnnotateAttr>(); ai != ae; ++ai)
751     Annotations.push_back(EmitAnnotateAttr(GV, *ai, D->getLocation()));
752 }
753 
754 bool CodeGenModule::MayDeferGeneration(const ValueDecl *Global) {
755   // Never defer when EmitAllDecls is specified.
756   if (Features.EmitAllDecls)
757     return false;
758 
759   return !getContext().DeclMustBeEmitted(Global);
760 }
761 
762 llvm::Constant *CodeGenModule::GetWeakRefReference(const ValueDecl *VD) {
763   const AliasAttr *AA = VD->getAttr<AliasAttr>();
764   assert(AA && "No alias?");
765 
766   llvm::Type *DeclTy = getTypes().ConvertTypeForMem(VD->getType());
767 
768   // See if there is already something with the target's name in the module.
769   llvm::GlobalValue *Entry = GetGlobalValue(AA->getAliasee());
770 
771   llvm::Constant *Aliasee;
772   if (isa<llvm::FunctionType>(DeclTy))
773     Aliasee = GetOrCreateLLVMFunction(AA->getAliasee(), DeclTy, GlobalDecl(),
774                                       /*ForVTable=*/false);
775   else
776     Aliasee = GetOrCreateLLVMGlobal(AA->getAliasee(),
777                                     llvm::PointerType::getUnqual(DeclTy), 0);
778   if (!Entry) {
779     llvm::GlobalValue* F = cast<llvm::GlobalValue>(Aliasee);
780     F->setLinkage(llvm::Function::ExternalWeakLinkage);
781     WeakRefReferences.insert(F);
782   }
783 
784   return Aliasee;
785 }
786 
787 void CodeGenModule::EmitGlobal(GlobalDecl GD) {
788   const ValueDecl *Global = cast<ValueDecl>(GD.getDecl());
789 
790   // Weak references don't produce any output by themselves.
791   if (Global->hasAttr<WeakRefAttr>())
792     return;
793 
794   // If this is an alias definition (which otherwise looks like a declaration)
795   // emit it now.
796   if (Global->hasAttr<AliasAttr>())
797     return EmitAliasDefinition(GD);
798 
799   // If this is CUDA, be selective about which declarations we emit.
800   if (Features.CUDA) {
801     if (CodeGenOpts.CUDAIsDevice) {
802       if (!Global->hasAttr<CUDADeviceAttr>() &&
803           !Global->hasAttr<CUDAGlobalAttr>() &&
804           !Global->hasAttr<CUDAConstantAttr>() &&
805           !Global->hasAttr<CUDASharedAttr>())
806         return;
807     } else {
808       if (!Global->hasAttr<CUDAHostAttr>() && (
809             Global->hasAttr<CUDADeviceAttr>() ||
810             Global->hasAttr<CUDAConstantAttr>() ||
811             Global->hasAttr<CUDASharedAttr>()))
812         return;
813     }
814   }
815 
816   // Ignore declarations, they will be emitted on their first use.
817   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(Global)) {
818     // Forward declarations are emitted lazily on first use.
819     if (!FD->doesThisDeclarationHaveABody()) {
820       if (!FD->doesDeclarationForceExternallyVisibleDefinition())
821         return;
822 
823       const FunctionDecl *InlineDefinition = 0;
824       FD->getBody(InlineDefinition);
825 
826       StringRef MangledName = getMangledName(GD);
827       llvm::StringMap<GlobalDecl>::iterator DDI =
828           DeferredDecls.find(MangledName);
829       if (DDI != DeferredDecls.end())
830         DeferredDecls.erase(DDI);
831       EmitGlobalDefinition(InlineDefinition);
832       return;
833     }
834   } else {
835     const VarDecl *VD = cast<VarDecl>(Global);
836     assert(VD->isFileVarDecl() && "Cannot emit local var decl as global.");
837 
838     if (VD->isThisDeclarationADefinition() != VarDecl::Definition)
839       return;
840   }
841 
842   // Defer code generation when possible if this is a static definition, inline
843   // function etc.  These we only want to emit if they are used.
844   if (!MayDeferGeneration(Global)) {
845     // Emit the definition if it can't be deferred.
846     EmitGlobalDefinition(GD);
847     return;
848   }
849 
850   // If we're deferring emission of a C++ variable with an
851   // initializer, remember the order in which it appeared in the file.
852   if (getLangOptions().CPlusPlus && isa<VarDecl>(Global) &&
853       cast<VarDecl>(Global)->hasInit()) {
854     DelayedCXXInitPosition[Global] = CXXGlobalInits.size();
855     CXXGlobalInits.push_back(0);
856   }
857 
858   // If the value has already been used, add it directly to the
859   // DeferredDeclsToEmit list.
860   StringRef MangledName = getMangledName(GD);
861   if (GetGlobalValue(MangledName))
862     DeferredDeclsToEmit.push_back(GD);
863   else {
864     // Otherwise, remember that we saw a deferred decl with this name.  The
865     // first use of the mangled name will cause it to move into
866     // DeferredDeclsToEmit.
867     DeferredDecls[MangledName] = GD;
868   }
869 }
870 
871 namespace {
872   struct FunctionIsDirectlyRecursive :
873     public RecursiveASTVisitor<FunctionIsDirectlyRecursive> {
874     const StringRef Name;
875     const Builtin::Context &BI;
876     bool Result;
877     FunctionIsDirectlyRecursive(StringRef N, const Builtin::Context &C) :
878       Name(N), BI(C), Result(false) {
879     }
880     typedef RecursiveASTVisitor<FunctionIsDirectlyRecursive> Base;
881 
882     bool TraverseCallExpr(CallExpr *E) {
883       const FunctionDecl *FD = E->getDirectCallee();
884       if (!FD)
885         return true;
886       AsmLabelAttr *Attr = FD->getAttr<AsmLabelAttr>();
887       if (Attr && Name == Attr->getLabel()) {
888         Result = true;
889         return false;
890       }
891       unsigned BuiltinID = FD->getBuiltinID();
892       if (!BuiltinID)
893         return true;
894       StringRef BuiltinName = BI.GetName(BuiltinID);
895       if (BuiltinName.startswith("__builtin_") &&
896           Name == BuiltinName.slice(strlen("__builtin_"), StringRef::npos)) {
897         Result = true;
898         return false;
899       }
900       return true;
901     }
902   };
903 }
904 
905 // isTriviallyRecursive - Check if this function calls another
906 // decl that, because of the asm attribute or the other decl being a builtin,
907 // ends up pointing to itself.
908 bool
909 CodeGenModule::isTriviallyRecursive(const FunctionDecl *FD) {
910   StringRef Name;
911   if (getCXXABI().getMangleContext().shouldMangleDeclName(FD)) {
912     // asm labels are a special kind of mangling we have to support.
913     AsmLabelAttr *Attr = FD->getAttr<AsmLabelAttr>();
914     if (!Attr)
915       return false;
916     Name = Attr->getLabel();
917   } else {
918     Name = FD->getName();
919   }
920 
921   FunctionIsDirectlyRecursive Walker(Name, Context.BuiltinInfo);
922   Walker.TraverseFunctionDecl(const_cast<FunctionDecl*>(FD));
923   return Walker.Result;
924 }
925 
926 bool
927 CodeGenModule::shouldEmitFunction(const FunctionDecl *F) {
928   if (getFunctionLinkage(F) != llvm::Function::AvailableExternallyLinkage)
929     return true;
930   if (CodeGenOpts.OptimizationLevel == 0 &&
931       !F->hasAttr<AlwaysInlineAttr>())
932     return false;
933   // PR9614. Avoid cases where the source code is lying to us. An available
934   // externally function should have an equivalent function somewhere else,
935   // but a function that calls itself is clearly not equivalent to the real
936   // implementation.
937   // This happens in glibc's btowc and in some configure checks.
938   return !isTriviallyRecursive(F);
939 }
940 
941 void CodeGenModule::EmitGlobalDefinition(GlobalDecl GD) {
942   const ValueDecl *D = cast<ValueDecl>(GD.getDecl());
943 
944   PrettyStackTraceDecl CrashInfo(const_cast<ValueDecl *>(D), D->getLocation(),
945                                  Context.getSourceManager(),
946                                  "Generating code for declaration");
947 
948   if (const FunctionDecl *Function = dyn_cast<FunctionDecl>(D)) {
949     // At -O0, don't generate IR for functions with available_externally
950     // linkage.
951     if (!shouldEmitFunction(Function))
952       return;
953 
954     if (const CXXMethodDecl *Method = dyn_cast<CXXMethodDecl>(D)) {
955       // Make sure to emit the definition(s) before we emit the thunks.
956       // This is necessary for the generation of certain thunks.
957       if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(Method))
958         EmitCXXConstructor(CD, GD.getCtorType());
959       else if (const CXXDestructorDecl *DD =dyn_cast<CXXDestructorDecl>(Method))
960         EmitCXXDestructor(DD, GD.getDtorType());
961       else
962         EmitGlobalFunctionDefinition(GD);
963 
964       if (Method->isVirtual())
965         getVTables().EmitThunks(GD);
966 
967       return;
968     }
969 
970     return EmitGlobalFunctionDefinition(GD);
971   }
972 
973   if (const VarDecl *VD = dyn_cast<VarDecl>(D))
974     return EmitGlobalVarDefinition(VD);
975 
976   llvm_unreachable("Invalid argument to EmitGlobalDefinition()");
977 }
978 
979 /// GetOrCreateLLVMFunction - If the specified mangled name is not in the
980 /// module, create and return an llvm Function with the specified type. If there
981 /// is something in the module with the specified name, return it potentially
982 /// bitcasted to the right type.
983 ///
984 /// If D is non-null, it specifies a decl that correspond to this.  This is used
985 /// to set the attributes on the function when it is first created.
986 llvm::Constant *
987 CodeGenModule::GetOrCreateLLVMFunction(StringRef MangledName,
988                                        llvm::Type *Ty,
989                                        GlobalDecl D, bool ForVTable,
990                                        llvm::Attributes ExtraAttrs) {
991   // Lookup the entry, lazily creating it if necessary.
992   llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
993   if (Entry) {
994     if (WeakRefReferences.count(Entry)) {
995       const FunctionDecl *FD = cast_or_null<FunctionDecl>(D.getDecl());
996       if (FD && !FD->hasAttr<WeakAttr>())
997         Entry->setLinkage(llvm::Function::ExternalLinkage);
998 
999       WeakRefReferences.erase(Entry);
1000     }
1001 
1002     if (Entry->getType()->getElementType() == Ty)
1003       return Entry;
1004 
1005     // Make sure the result is of the correct type.
1006     return llvm::ConstantExpr::getBitCast(Entry, Ty->getPointerTo());
1007   }
1008 
1009   // This function doesn't have a complete type (for example, the return
1010   // type is an incomplete struct). Use a fake type instead, and make
1011   // sure not to try to set attributes.
1012   bool IsIncompleteFunction = false;
1013 
1014   llvm::FunctionType *FTy;
1015   if (isa<llvm::FunctionType>(Ty)) {
1016     FTy = cast<llvm::FunctionType>(Ty);
1017   } else {
1018     FTy = llvm::FunctionType::get(VoidTy, false);
1019     IsIncompleteFunction = true;
1020   }
1021 
1022   llvm::Function *F = llvm::Function::Create(FTy,
1023                                              llvm::Function::ExternalLinkage,
1024                                              MangledName, &getModule());
1025   assert(F->getName() == MangledName && "name was uniqued!");
1026   if (D.getDecl())
1027     SetFunctionAttributes(D, F, IsIncompleteFunction);
1028   if (ExtraAttrs != llvm::Attribute::None)
1029     F->addFnAttr(ExtraAttrs);
1030 
1031   // This is the first use or definition of a mangled name.  If there is a
1032   // deferred decl with this name, remember that we need to emit it at the end
1033   // of the file.
1034   llvm::StringMap<GlobalDecl>::iterator DDI = DeferredDecls.find(MangledName);
1035   if (DDI != DeferredDecls.end()) {
1036     // Move the potentially referenced deferred decl to the DeferredDeclsToEmit
1037     // list, and remove it from DeferredDecls (since we don't need it anymore).
1038     DeferredDeclsToEmit.push_back(DDI->second);
1039     DeferredDecls.erase(DDI);
1040 
1041   // Otherwise, there are cases we have to worry about where we're
1042   // using a declaration for which we must emit a definition but where
1043   // we might not find a top-level definition:
1044   //   - member functions defined inline in their classes
1045   //   - friend functions defined inline in some class
1046   //   - special member functions with implicit definitions
1047   // If we ever change our AST traversal to walk into class methods,
1048   // this will be unnecessary.
1049   //
1050   // We also don't emit a definition for a function if it's going to be an entry
1051   // in a vtable, unless it's already marked as used.
1052   } else if (getLangOptions().CPlusPlus && D.getDecl()) {
1053     // Look for a declaration that's lexically in a record.
1054     const FunctionDecl *FD = cast<FunctionDecl>(D.getDecl());
1055     do {
1056       if (isa<CXXRecordDecl>(FD->getLexicalDeclContext())) {
1057         if (FD->isImplicit() && !ForVTable) {
1058           assert(FD->isUsed() && "Sema didn't mark implicit function as used!");
1059           DeferredDeclsToEmit.push_back(D.getWithDecl(FD));
1060           break;
1061         } else if (FD->doesThisDeclarationHaveABody()) {
1062           DeferredDeclsToEmit.push_back(D.getWithDecl(FD));
1063           break;
1064         }
1065       }
1066       FD = FD->getPreviousDecl();
1067     } while (FD);
1068   }
1069 
1070   // Make sure the result is of the requested type.
1071   if (!IsIncompleteFunction) {
1072     assert(F->getType()->getElementType() == Ty);
1073     return F;
1074   }
1075 
1076   llvm::Type *PTy = llvm::PointerType::getUnqual(Ty);
1077   return llvm::ConstantExpr::getBitCast(F, PTy);
1078 }
1079 
1080 /// GetAddrOfFunction - Return the address of the given function.  If Ty is
1081 /// non-null, then this function will use the specified type if it has to
1082 /// create it (this occurs when we see a definition of the function).
1083 llvm::Constant *CodeGenModule::GetAddrOfFunction(GlobalDecl GD,
1084                                                  llvm::Type *Ty,
1085                                                  bool ForVTable) {
1086   // If there was no specific requested type, just convert it now.
1087   if (!Ty)
1088     Ty = getTypes().ConvertType(cast<ValueDecl>(GD.getDecl())->getType());
1089 
1090   StringRef MangledName = getMangledName(GD);
1091   return GetOrCreateLLVMFunction(MangledName, Ty, GD, ForVTable);
1092 }
1093 
1094 /// CreateRuntimeFunction - Create a new runtime function with the specified
1095 /// type and name.
1096 llvm::Constant *
1097 CodeGenModule::CreateRuntimeFunction(llvm::FunctionType *FTy,
1098                                      StringRef Name,
1099                                      llvm::Attributes ExtraAttrs) {
1100   return GetOrCreateLLVMFunction(Name, FTy, GlobalDecl(), /*ForVTable=*/false,
1101                                  ExtraAttrs);
1102 }
1103 
1104 static bool DeclIsConstantGlobal(ASTContext &Context, const VarDecl *D,
1105                                  bool ConstantInit) {
1106   if (!D->getType().isConstant(Context) && !D->getType()->isReferenceType())
1107     return false;
1108 
1109   if (Context.getLangOptions().CPlusPlus) {
1110     if (const RecordType *Record
1111           = Context.getBaseElementType(D->getType())->getAs<RecordType>())
1112       return ConstantInit &&
1113              cast<CXXRecordDecl>(Record->getDecl())->isPOD() &&
1114              !cast<CXXRecordDecl>(Record->getDecl())->hasMutableFields();
1115   }
1116 
1117   return true;
1118 }
1119 
1120 /// GetOrCreateLLVMGlobal - If the specified mangled name is not in the module,
1121 /// create and return an llvm GlobalVariable with the specified type.  If there
1122 /// is something in the module with the specified name, return it potentially
1123 /// bitcasted to the right type.
1124 ///
1125 /// If D is non-null, it specifies a decl that correspond to this.  This is used
1126 /// to set the attributes on the global when it is first created.
1127 llvm::Constant *
1128 CodeGenModule::GetOrCreateLLVMGlobal(StringRef MangledName,
1129                                      llvm::PointerType *Ty,
1130                                      const VarDecl *D,
1131                                      bool UnnamedAddr) {
1132   // Lookup the entry, lazily creating it if necessary.
1133   llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
1134   if (Entry) {
1135     if (WeakRefReferences.count(Entry)) {
1136       if (D && !D->hasAttr<WeakAttr>())
1137         Entry->setLinkage(llvm::Function::ExternalLinkage);
1138 
1139       WeakRefReferences.erase(Entry);
1140     }
1141 
1142     if (UnnamedAddr)
1143       Entry->setUnnamedAddr(true);
1144 
1145     if (Entry->getType() == Ty)
1146       return Entry;
1147 
1148     // Make sure the result is of the correct type.
1149     return llvm::ConstantExpr::getBitCast(Entry, Ty);
1150   }
1151 
1152   // This is the first use or definition of a mangled name.  If there is a
1153   // deferred decl with this name, remember that we need to emit it at the end
1154   // of the file.
1155   llvm::StringMap<GlobalDecl>::iterator DDI = DeferredDecls.find(MangledName);
1156   if (DDI != DeferredDecls.end()) {
1157     // Move the potentially referenced deferred decl to the DeferredDeclsToEmit
1158     // list, and remove it from DeferredDecls (since we don't need it anymore).
1159     DeferredDeclsToEmit.push_back(DDI->second);
1160     DeferredDecls.erase(DDI);
1161   }
1162 
1163   llvm::GlobalVariable *GV =
1164     new llvm::GlobalVariable(getModule(), Ty->getElementType(), false,
1165                              llvm::GlobalValue::ExternalLinkage,
1166                              0, MangledName, 0,
1167                              false, Ty->getAddressSpace());
1168 
1169   // Handle things which are present even on external declarations.
1170   if (D) {
1171     // FIXME: This code is overly simple and should be merged with other global
1172     // handling.
1173     GV->setConstant(DeclIsConstantGlobal(Context, D, false));
1174 
1175     // Set linkage and visibility in case we never see a definition.
1176     NamedDecl::LinkageInfo LV = D->getLinkageAndVisibility();
1177     if (LV.linkage() != ExternalLinkage) {
1178       // Don't set internal linkage on declarations.
1179     } else {
1180       if (D->hasAttr<DLLImportAttr>())
1181         GV->setLinkage(llvm::GlobalValue::DLLImportLinkage);
1182       else if (D->hasAttr<WeakAttr>() || D->isWeakImported())
1183         GV->setLinkage(llvm::GlobalValue::ExternalWeakLinkage);
1184 
1185       // Set visibility on a declaration only if it's explicit.
1186       if (LV.visibilityExplicit())
1187         GV->setVisibility(GetLLVMVisibility(LV.visibility()));
1188     }
1189 
1190     GV->setThreadLocal(D->isThreadSpecified());
1191   }
1192 
1193   return GV;
1194 }
1195 
1196 
1197 llvm::GlobalVariable *
1198 CodeGenModule::CreateOrReplaceCXXRuntimeVariable(StringRef Name,
1199                                       llvm::Type *Ty,
1200                                       llvm::GlobalValue::LinkageTypes Linkage) {
1201   llvm::GlobalVariable *GV = getModule().getNamedGlobal(Name);
1202   llvm::GlobalVariable *OldGV = 0;
1203 
1204 
1205   if (GV) {
1206     // Check if the variable has the right type.
1207     if (GV->getType()->getElementType() == Ty)
1208       return GV;
1209 
1210     // Because C++ name mangling, the only way we can end up with an already
1211     // existing global with the same name is if it has been declared extern "C".
1212       assert(GV->isDeclaration() && "Declaration has wrong type!");
1213     OldGV = GV;
1214   }
1215 
1216   // Create a new variable.
1217   GV = new llvm::GlobalVariable(getModule(), Ty, /*isConstant=*/true,
1218                                 Linkage, 0, Name);
1219 
1220   if (OldGV) {
1221     // Replace occurrences of the old variable if needed.
1222     GV->takeName(OldGV);
1223 
1224     if (!OldGV->use_empty()) {
1225       llvm::Constant *NewPtrForOldDecl =
1226       llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
1227       OldGV->replaceAllUsesWith(NewPtrForOldDecl);
1228     }
1229 
1230     OldGV->eraseFromParent();
1231   }
1232 
1233   return GV;
1234 }
1235 
1236 /// GetAddrOfGlobalVar - Return the llvm::Constant for the address of the
1237 /// given global variable.  If Ty is non-null and if the global doesn't exist,
1238 /// then it will be greated with the specified type instead of whatever the
1239 /// normal requested type would be.
1240 llvm::Constant *CodeGenModule::GetAddrOfGlobalVar(const VarDecl *D,
1241                                                   llvm::Type *Ty) {
1242   assert(D->hasGlobalStorage() && "Not a global variable");
1243   QualType ASTTy = D->getType();
1244   if (Ty == 0)
1245     Ty = getTypes().ConvertTypeForMem(ASTTy);
1246 
1247   llvm::PointerType *PTy =
1248     llvm::PointerType::get(Ty, getContext().getTargetAddressSpace(ASTTy));
1249 
1250   StringRef MangledName = getMangledName(D);
1251   return GetOrCreateLLVMGlobal(MangledName, PTy, D);
1252 }
1253 
1254 /// CreateRuntimeVariable - Create a new runtime global variable with the
1255 /// specified type and name.
1256 llvm::Constant *
1257 CodeGenModule::CreateRuntimeVariable(llvm::Type *Ty,
1258                                      StringRef Name) {
1259   return GetOrCreateLLVMGlobal(Name, llvm::PointerType::getUnqual(Ty), 0,
1260                                true);
1261 }
1262 
1263 void CodeGenModule::EmitTentativeDefinition(const VarDecl *D) {
1264   assert(!D->getInit() && "Cannot emit definite definitions here!");
1265 
1266   if (MayDeferGeneration(D)) {
1267     // If we have not seen a reference to this variable yet, place it
1268     // into the deferred declarations table to be emitted if needed
1269     // later.
1270     StringRef MangledName = getMangledName(D);
1271     if (!GetGlobalValue(MangledName)) {
1272       DeferredDecls[MangledName] = D;
1273       return;
1274     }
1275   }
1276 
1277   // The tentative definition is the only definition.
1278   EmitGlobalVarDefinition(D);
1279 }
1280 
1281 void CodeGenModule::EmitVTable(CXXRecordDecl *Class, bool DefinitionRequired) {
1282   if (DefinitionRequired)
1283     getVTables().GenerateClassData(getVTableLinkage(Class), Class);
1284 }
1285 
1286 llvm::GlobalVariable::LinkageTypes
1287 CodeGenModule::getVTableLinkage(const CXXRecordDecl *RD) {
1288   if (RD->getLinkage() != ExternalLinkage)
1289     return llvm::GlobalVariable::InternalLinkage;
1290 
1291   if (const CXXMethodDecl *KeyFunction
1292                                     = RD->getASTContext().getKeyFunction(RD)) {
1293     // If this class has a key function, use that to determine the linkage of
1294     // the vtable.
1295     const FunctionDecl *Def = 0;
1296     if (KeyFunction->hasBody(Def))
1297       KeyFunction = cast<CXXMethodDecl>(Def);
1298 
1299     switch (KeyFunction->getTemplateSpecializationKind()) {
1300       case TSK_Undeclared:
1301       case TSK_ExplicitSpecialization:
1302         // When compiling with optimizations turned on, we emit all vtables,
1303         // even if the key function is not defined in the current translation
1304         // unit. If this is the case, use available_externally linkage.
1305         if (!Def && CodeGenOpts.OptimizationLevel)
1306           return llvm::GlobalVariable::AvailableExternallyLinkage;
1307 
1308         if (KeyFunction->isInlined())
1309           return !Context.getLangOptions().AppleKext ?
1310                    llvm::GlobalVariable::LinkOnceODRLinkage :
1311                    llvm::Function::InternalLinkage;
1312 
1313         return llvm::GlobalVariable::ExternalLinkage;
1314 
1315       case TSK_ImplicitInstantiation:
1316         return !Context.getLangOptions().AppleKext ?
1317                  llvm::GlobalVariable::LinkOnceODRLinkage :
1318                  llvm::Function::InternalLinkage;
1319 
1320       case TSK_ExplicitInstantiationDefinition:
1321         return !Context.getLangOptions().AppleKext ?
1322                  llvm::GlobalVariable::WeakODRLinkage :
1323                  llvm::Function::InternalLinkage;
1324 
1325       case TSK_ExplicitInstantiationDeclaration:
1326         // FIXME: Use available_externally linkage. However, this currently
1327         // breaks LLVM's build due to undefined symbols.
1328         //      return llvm::GlobalVariable::AvailableExternallyLinkage;
1329         return !Context.getLangOptions().AppleKext ?
1330                  llvm::GlobalVariable::LinkOnceODRLinkage :
1331                  llvm::Function::InternalLinkage;
1332     }
1333   }
1334 
1335   if (Context.getLangOptions().AppleKext)
1336     return llvm::Function::InternalLinkage;
1337 
1338   switch (RD->getTemplateSpecializationKind()) {
1339   case TSK_Undeclared:
1340   case TSK_ExplicitSpecialization:
1341   case TSK_ImplicitInstantiation:
1342     // FIXME: Use available_externally linkage. However, this currently
1343     // breaks LLVM's build due to undefined symbols.
1344     //   return llvm::GlobalVariable::AvailableExternallyLinkage;
1345   case TSK_ExplicitInstantiationDeclaration:
1346     return llvm::GlobalVariable::LinkOnceODRLinkage;
1347 
1348   case TSK_ExplicitInstantiationDefinition:
1349       return llvm::GlobalVariable::WeakODRLinkage;
1350   }
1351 
1352   llvm_unreachable("Invalid TemplateSpecializationKind!");
1353 }
1354 
1355 CharUnits CodeGenModule::GetTargetTypeStoreSize(llvm::Type *Ty) const {
1356     return Context.toCharUnitsFromBits(
1357       TheTargetData.getTypeStoreSizeInBits(Ty));
1358 }
1359 
1360 void CodeGenModule::EmitGlobalVarDefinition(const VarDecl *D) {
1361   llvm::Constant *Init = 0;
1362   QualType ASTTy = D->getType();
1363   CXXRecordDecl *RD = ASTTy->getBaseElementTypeUnsafe()->getAsCXXRecordDecl();
1364   bool NeedsGlobalCtor = false;
1365   bool NeedsGlobalDtor = RD && !RD->hasTrivialDestructor();
1366 
1367   const VarDecl *InitDecl;
1368   const Expr *InitExpr = D->getAnyInitializer(InitDecl);
1369 
1370   if (!InitExpr) {
1371     // This is a tentative definition; tentative definitions are
1372     // implicitly initialized with { 0 }.
1373     //
1374     // Note that tentative definitions are only emitted at the end of
1375     // a translation unit, so they should never have incomplete
1376     // type. In addition, EmitTentativeDefinition makes sure that we
1377     // never attempt to emit a tentative definition if a real one
1378     // exists. A use may still exists, however, so we still may need
1379     // to do a RAUW.
1380     assert(!ASTTy->isIncompleteType() && "Unexpected incomplete type");
1381     Init = EmitNullConstant(D->getType());
1382   } else {
1383     Init = EmitConstantInit(*InitDecl);
1384     if (!Init) {
1385       QualType T = InitExpr->getType();
1386       if (D->getType()->isReferenceType())
1387         T = D->getType();
1388 
1389       if (getLangOptions().CPlusPlus) {
1390         Init = EmitNullConstant(T);
1391         NeedsGlobalCtor = true;
1392       } else {
1393         ErrorUnsupported(D, "static initializer");
1394         Init = llvm::UndefValue::get(getTypes().ConvertType(T));
1395       }
1396     } else {
1397       // We don't need an initializer, so remove the entry for the delayed
1398       // initializer position (just in case this entry was delayed) if we
1399       // also don't need to register a destructor.
1400       if (getLangOptions().CPlusPlus && !NeedsGlobalDtor)
1401         DelayedCXXInitPosition.erase(D);
1402     }
1403   }
1404 
1405   llvm::Type* InitType = Init->getType();
1406   llvm::Constant *Entry = GetAddrOfGlobalVar(D, InitType);
1407 
1408   // Strip off a bitcast if we got one back.
1409   if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Entry)) {
1410     assert(CE->getOpcode() == llvm::Instruction::BitCast ||
1411            // all zero index gep.
1412            CE->getOpcode() == llvm::Instruction::GetElementPtr);
1413     Entry = CE->getOperand(0);
1414   }
1415 
1416   // Entry is now either a Function or GlobalVariable.
1417   llvm::GlobalVariable *GV = dyn_cast<llvm::GlobalVariable>(Entry);
1418 
1419   // We have a definition after a declaration with the wrong type.
1420   // We must make a new GlobalVariable* and update everything that used OldGV
1421   // (a declaration or tentative definition) with the new GlobalVariable*
1422   // (which will be a definition).
1423   //
1424   // This happens if there is a prototype for a global (e.g.
1425   // "extern int x[];") and then a definition of a different type (e.g.
1426   // "int x[10];"). This also happens when an initializer has a different type
1427   // from the type of the global (this happens with unions).
1428   if (GV == 0 ||
1429       GV->getType()->getElementType() != InitType ||
1430       GV->getType()->getAddressSpace() !=
1431         getContext().getTargetAddressSpace(ASTTy)) {
1432 
1433     // Move the old entry aside so that we'll create a new one.
1434     Entry->setName(StringRef());
1435 
1436     // Make a new global with the correct type, this is now guaranteed to work.
1437     GV = cast<llvm::GlobalVariable>(GetAddrOfGlobalVar(D, InitType));
1438 
1439     // Replace all uses of the old global with the new global
1440     llvm::Constant *NewPtrForOldDecl =
1441         llvm::ConstantExpr::getBitCast(GV, Entry->getType());
1442     Entry->replaceAllUsesWith(NewPtrForOldDecl);
1443 
1444     // Erase the old global, since it is no longer used.
1445     cast<llvm::GlobalValue>(Entry)->eraseFromParent();
1446   }
1447 
1448   if (D->hasAttr<AnnotateAttr>())
1449     AddGlobalAnnotations(D, GV);
1450 
1451   GV->setInitializer(Init);
1452 
1453   // If it is safe to mark the global 'constant', do so now.
1454   GV->setConstant(false);
1455   if (!NeedsGlobalCtor && !NeedsGlobalDtor &&
1456       DeclIsConstantGlobal(Context, D, true))
1457     GV->setConstant(true);
1458 
1459   GV->setAlignment(getContext().getDeclAlign(D).getQuantity());
1460 
1461   // Set the llvm linkage type as appropriate.
1462   llvm::GlobalValue::LinkageTypes Linkage =
1463     GetLLVMLinkageVarDefinition(D, GV);
1464   GV->setLinkage(Linkage);
1465   if (Linkage == llvm::GlobalVariable::CommonLinkage)
1466     // common vars aren't constant even if declared const.
1467     GV->setConstant(false);
1468 
1469   SetCommonAttributes(D, GV);
1470 
1471   // Emit the initializer function if necessary.
1472   if (NeedsGlobalCtor || NeedsGlobalDtor)
1473     EmitCXXGlobalVarDeclInitFunc(D, GV, NeedsGlobalCtor);
1474 
1475   // Emit global variable debug information.
1476   if (CGDebugInfo *DI = getModuleDebugInfo())
1477     DI->EmitGlobalVariable(GV, D);
1478 }
1479 
1480 llvm::GlobalValue::LinkageTypes
1481 CodeGenModule::GetLLVMLinkageVarDefinition(const VarDecl *D,
1482                                            llvm::GlobalVariable *GV) {
1483   GVALinkage Linkage = getContext().GetGVALinkageForVariable(D);
1484   if (Linkage == GVA_Internal)
1485     return llvm::Function::InternalLinkage;
1486   else if (D->hasAttr<DLLImportAttr>())
1487     return llvm::Function::DLLImportLinkage;
1488   else if (D->hasAttr<DLLExportAttr>())
1489     return llvm::Function::DLLExportLinkage;
1490   else if (D->hasAttr<WeakAttr>()) {
1491     if (GV->isConstant())
1492       return llvm::GlobalVariable::WeakODRLinkage;
1493     else
1494       return llvm::GlobalVariable::WeakAnyLinkage;
1495   } else if (Linkage == GVA_TemplateInstantiation ||
1496              Linkage == GVA_ExplicitTemplateInstantiation)
1497     return llvm::GlobalVariable::WeakODRLinkage;
1498   else if (!getLangOptions().CPlusPlus &&
1499            ((!CodeGenOpts.NoCommon && !D->getAttr<NoCommonAttr>()) ||
1500              D->getAttr<CommonAttr>()) &&
1501            !D->hasExternalStorage() && !D->getInit() &&
1502            !D->getAttr<SectionAttr>() && !D->isThreadSpecified() &&
1503            !D->getAttr<WeakImportAttr>()) {
1504     // Thread local vars aren't considered common linkage.
1505     return llvm::GlobalVariable::CommonLinkage;
1506   }
1507   return llvm::GlobalVariable::ExternalLinkage;
1508 }
1509 
1510 /// ReplaceUsesOfNonProtoTypeWithRealFunction - This function is called when we
1511 /// implement a function with no prototype, e.g. "int foo() {}".  If there are
1512 /// existing call uses of the old function in the module, this adjusts them to
1513 /// call the new function directly.
1514 ///
1515 /// This is not just a cleanup: the always_inline pass requires direct calls to
1516 /// functions to be able to inline them.  If there is a bitcast in the way, it
1517 /// won't inline them.  Instcombine normally deletes these calls, but it isn't
1518 /// run at -O0.
1519 static void ReplaceUsesOfNonProtoTypeWithRealFunction(llvm::GlobalValue *Old,
1520                                                       llvm::Function *NewFn) {
1521   // If we're redefining a global as a function, don't transform it.
1522   llvm::Function *OldFn = dyn_cast<llvm::Function>(Old);
1523   if (OldFn == 0) return;
1524 
1525   llvm::Type *NewRetTy = NewFn->getReturnType();
1526   SmallVector<llvm::Value*, 4> ArgList;
1527 
1528   for (llvm::Value::use_iterator UI = OldFn->use_begin(), E = OldFn->use_end();
1529        UI != E; ) {
1530     // TODO: Do invokes ever occur in C code?  If so, we should handle them too.
1531     llvm::Value::use_iterator I = UI++; // Increment before the CI is erased.
1532     llvm::CallInst *CI = dyn_cast<llvm::CallInst>(*I);
1533     if (!CI) continue; // FIXME: when we allow Invoke, just do CallSite CS(*I)
1534     llvm::CallSite CS(CI);
1535     if (!CI || !CS.isCallee(I)) continue;
1536 
1537     // If the return types don't match exactly, and if the call isn't dead, then
1538     // we can't transform this call.
1539     if (CI->getType() != NewRetTy && !CI->use_empty())
1540       continue;
1541 
1542     // Get the attribute list.
1543     llvm::SmallVector<llvm::AttributeWithIndex, 8> AttrVec;
1544     llvm::AttrListPtr AttrList = CI->getAttributes();
1545 
1546     // Get any return attributes.
1547     llvm::Attributes RAttrs = AttrList.getRetAttributes();
1548 
1549     // Add the return attributes.
1550     if (RAttrs)
1551       AttrVec.push_back(llvm::AttributeWithIndex::get(0, RAttrs));
1552 
1553     // If the function was passed too few arguments, don't transform.  If extra
1554     // arguments were passed, we silently drop them.  If any of the types
1555     // mismatch, we don't transform.
1556     unsigned ArgNo = 0;
1557     bool DontTransform = false;
1558     for (llvm::Function::arg_iterator AI = NewFn->arg_begin(),
1559          E = NewFn->arg_end(); AI != E; ++AI, ++ArgNo) {
1560       if (CS.arg_size() == ArgNo ||
1561           CS.getArgument(ArgNo)->getType() != AI->getType()) {
1562         DontTransform = true;
1563         break;
1564       }
1565 
1566       // Add any parameter attributes.
1567       if (llvm::Attributes PAttrs = AttrList.getParamAttributes(ArgNo + 1))
1568         AttrVec.push_back(llvm::AttributeWithIndex::get(ArgNo + 1, PAttrs));
1569     }
1570     if (DontTransform)
1571       continue;
1572 
1573     if (llvm::Attributes FnAttrs =  AttrList.getFnAttributes())
1574       AttrVec.push_back(llvm::AttributeWithIndex::get(~0, FnAttrs));
1575 
1576     // Okay, we can transform this.  Create the new call instruction and copy
1577     // over the required information.
1578     ArgList.append(CS.arg_begin(), CS.arg_begin() + ArgNo);
1579     llvm::CallInst *NewCall = llvm::CallInst::Create(NewFn, ArgList, "", CI);
1580     ArgList.clear();
1581     if (!NewCall->getType()->isVoidTy())
1582       NewCall->takeName(CI);
1583     NewCall->setAttributes(llvm::AttrListPtr::get(AttrVec.begin(),
1584                                                   AttrVec.end()));
1585     NewCall->setCallingConv(CI->getCallingConv());
1586 
1587     // Finally, remove the old call, replacing any uses with the new one.
1588     if (!CI->use_empty())
1589       CI->replaceAllUsesWith(NewCall);
1590 
1591     // Copy debug location attached to CI.
1592     if (!CI->getDebugLoc().isUnknown())
1593       NewCall->setDebugLoc(CI->getDebugLoc());
1594     CI->eraseFromParent();
1595   }
1596 }
1597 
1598 
1599 void CodeGenModule::EmitGlobalFunctionDefinition(GlobalDecl GD) {
1600   const FunctionDecl *D = cast<FunctionDecl>(GD.getDecl());
1601 
1602   // Compute the function info and LLVM type.
1603   const CGFunctionInfo &FI = getTypes().arrangeGlobalDeclaration(GD);
1604   llvm::FunctionType *Ty = getTypes().GetFunctionType(FI);
1605 
1606   // Get or create the prototype for the function.
1607   llvm::Constant *Entry = GetAddrOfFunction(GD, Ty);
1608 
1609   // Strip off a bitcast if we got one back.
1610   if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Entry)) {
1611     assert(CE->getOpcode() == llvm::Instruction::BitCast);
1612     Entry = CE->getOperand(0);
1613   }
1614 
1615 
1616   if (cast<llvm::GlobalValue>(Entry)->getType()->getElementType() != Ty) {
1617     llvm::GlobalValue *OldFn = cast<llvm::GlobalValue>(Entry);
1618 
1619     // If the types mismatch then we have to rewrite the definition.
1620     assert(OldFn->isDeclaration() &&
1621            "Shouldn't replace non-declaration");
1622 
1623     // F is the Function* for the one with the wrong type, we must make a new
1624     // Function* and update everything that used F (a declaration) with the new
1625     // Function* (which will be a definition).
1626     //
1627     // This happens if there is a prototype for a function
1628     // (e.g. "int f()") and then a definition of a different type
1629     // (e.g. "int f(int x)").  Move the old function aside so that it
1630     // doesn't interfere with GetAddrOfFunction.
1631     OldFn->setName(StringRef());
1632     llvm::Function *NewFn = cast<llvm::Function>(GetAddrOfFunction(GD, Ty));
1633 
1634     // If this is an implementation of a function without a prototype, try to
1635     // replace any existing uses of the function (which may be calls) with uses
1636     // of the new function
1637     if (D->getType()->isFunctionNoProtoType()) {
1638       ReplaceUsesOfNonProtoTypeWithRealFunction(OldFn, NewFn);
1639       OldFn->removeDeadConstantUsers();
1640     }
1641 
1642     // Replace uses of F with the Function we will endow with a body.
1643     if (!Entry->use_empty()) {
1644       llvm::Constant *NewPtrForOldDecl =
1645         llvm::ConstantExpr::getBitCast(NewFn, Entry->getType());
1646       Entry->replaceAllUsesWith(NewPtrForOldDecl);
1647     }
1648 
1649     // Ok, delete the old function now, which is dead.
1650     OldFn->eraseFromParent();
1651 
1652     Entry = NewFn;
1653   }
1654 
1655   // We need to set linkage and visibility on the function before
1656   // generating code for it because various parts of IR generation
1657   // want to propagate this information down (e.g. to local static
1658   // declarations).
1659   llvm::Function *Fn = cast<llvm::Function>(Entry);
1660   setFunctionLinkage(D, Fn);
1661 
1662   // FIXME: this is redundant with part of SetFunctionDefinitionAttributes
1663   setGlobalVisibility(Fn, D);
1664 
1665   CodeGenFunction(*this).GenerateCode(D, Fn, FI);
1666 
1667   SetFunctionDefinitionAttributes(D, Fn);
1668   SetLLVMFunctionAttributesForDefinition(D, Fn);
1669 
1670   if (const ConstructorAttr *CA = D->getAttr<ConstructorAttr>())
1671     AddGlobalCtor(Fn, CA->getPriority());
1672   if (const DestructorAttr *DA = D->getAttr<DestructorAttr>())
1673     AddGlobalDtor(Fn, DA->getPriority());
1674   if (D->hasAttr<AnnotateAttr>())
1675     AddGlobalAnnotations(D, Fn);
1676 }
1677 
1678 void CodeGenModule::EmitAliasDefinition(GlobalDecl GD) {
1679   const ValueDecl *D = cast<ValueDecl>(GD.getDecl());
1680   const AliasAttr *AA = D->getAttr<AliasAttr>();
1681   assert(AA && "Not an alias?");
1682 
1683   StringRef MangledName = getMangledName(GD);
1684 
1685   // If there is a definition in the module, then it wins over the alias.
1686   // This is dubious, but allow it to be safe.  Just ignore the alias.
1687   llvm::GlobalValue *Entry = GetGlobalValue(MangledName);
1688   if (Entry && !Entry->isDeclaration())
1689     return;
1690 
1691   llvm::Type *DeclTy = getTypes().ConvertTypeForMem(D->getType());
1692 
1693   // Create a reference to the named value.  This ensures that it is emitted
1694   // if a deferred decl.
1695   llvm::Constant *Aliasee;
1696   if (isa<llvm::FunctionType>(DeclTy))
1697     Aliasee = GetOrCreateLLVMFunction(AA->getAliasee(), DeclTy, GlobalDecl(),
1698                                       /*ForVTable=*/false);
1699   else
1700     Aliasee = GetOrCreateLLVMGlobal(AA->getAliasee(),
1701                                     llvm::PointerType::getUnqual(DeclTy), 0);
1702 
1703   // Create the new alias itself, but don't set a name yet.
1704   llvm::GlobalValue *GA =
1705     new llvm::GlobalAlias(Aliasee->getType(),
1706                           llvm::Function::ExternalLinkage,
1707                           "", Aliasee, &getModule());
1708 
1709   if (Entry) {
1710     assert(Entry->isDeclaration());
1711 
1712     // If there is a declaration in the module, then we had an extern followed
1713     // by the alias, as in:
1714     //   extern int test6();
1715     //   ...
1716     //   int test6() __attribute__((alias("test7")));
1717     //
1718     // Remove it and replace uses of it with the alias.
1719     GA->takeName(Entry);
1720 
1721     Entry->replaceAllUsesWith(llvm::ConstantExpr::getBitCast(GA,
1722                                                           Entry->getType()));
1723     Entry->eraseFromParent();
1724   } else {
1725     GA->setName(MangledName);
1726   }
1727 
1728   // Set attributes which are particular to an alias; this is a
1729   // specialization of the attributes which may be set on a global
1730   // variable/function.
1731   if (D->hasAttr<DLLExportAttr>()) {
1732     if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
1733       // The dllexport attribute is ignored for undefined symbols.
1734       if (FD->hasBody())
1735         GA->setLinkage(llvm::Function::DLLExportLinkage);
1736     } else {
1737       GA->setLinkage(llvm::Function::DLLExportLinkage);
1738     }
1739   } else if (D->hasAttr<WeakAttr>() ||
1740              D->hasAttr<WeakRefAttr>() ||
1741              D->isWeakImported()) {
1742     GA->setLinkage(llvm::Function::WeakAnyLinkage);
1743   }
1744 
1745   SetCommonAttributes(D, GA);
1746 }
1747 
1748 llvm::Function *CodeGenModule::getIntrinsic(unsigned IID,
1749                                             ArrayRef<llvm::Type*> Tys) {
1750   return llvm::Intrinsic::getDeclaration(&getModule(), (llvm::Intrinsic::ID)IID,
1751                                          Tys);
1752 }
1753 
1754 static llvm::StringMapEntry<llvm::Constant*> &
1755 GetConstantCFStringEntry(llvm::StringMap<llvm::Constant*> &Map,
1756                          const StringLiteral *Literal,
1757                          bool TargetIsLSB,
1758                          bool &IsUTF16,
1759                          unsigned &StringLength) {
1760   StringRef String = Literal->getString();
1761   unsigned NumBytes = String.size();
1762 
1763   // Check for simple case.
1764   if (!Literal->containsNonAsciiOrNull()) {
1765     StringLength = NumBytes;
1766     return Map.GetOrCreateValue(String);
1767   }
1768 
1769   // Otherwise, convert the UTF8 literals into a byte string.
1770   SmallVector<UTF16, 128> ToBuf(NumBytes);
1771   const UTF8 *FromPtr = (UTF8 *)String.data();
1772   UTF16 *ToPtr = &ToBuf[0];
1773 
1774   (void)ConvertUTF8toUTF16(&FromPtr, FromPtr + NumBytes,
1775                            &ToPtr, ToPtr + NumBytes,
1776                            strictConversion);
1777 
1778   // ConvertUTF8toUTF16 returns the length in ToPtr.
1779   StringLength = ToPtr - &ToBuf[0];
1780 
1781   // Render the UTF-16 string into a byte array and convert to the target byte
1782   // order.
1783   //
1784   // FIXME: This isn't something we should need to do here.
1785   SmallString<128> AsBytes;
1786   AsBytes.reserve(StringLength * 2);
1787   for (unsigned i = 0; i != StringLength; ++i) {
1788     unsigned short Val = ToBuf[i];
1789     if (TargetIsLSB) {
1790       AsBytes.push_back(Val & 0xFF);
1791       AsBytes.push_back(Val >> 8);
1792     } else {
1793       AsBytes.push_back(Val >> 8);
1794       AsBytes.push_back(Val & 0xFF);
1795     }
1796   }
1797   // Append one extra null character, the second is automatically added by our
1798   // caller.
1799   AsBytes.push_back(0);
1800 
1801   IsUTF16 = true;
1802   return Map.GetOrCreateValue(StringRef(AsBytes.data(), AsBytes.size()));
1803 }
1804 
1805 static llvm::StringMapEntry<llvm::Constant*> &
1806 GetConstantStringEntry(llvm::StringMap<llvm::Constant*> &Map,
1807 		       const StringLiteral *Literal,
1808 		       unsigned &StringLength)
1809 {
1810 	StringRef String = Literal->getString();
1811 	StringLength = String.size();
1812 	return Map.GetOrCreateValue(String);
1813 }
1814 
1815 llvm::Constant *
1816 CodeGenModule::GetAddrOfConstantCFString(const StringLiteral *Literal) {
1817   unsigned StringLength = 0;
1818   bool isUTF16 = false;
1819   llvm::StringMapEntry<llvm::Constant*> &Entry =
1820     GetConstantCFStringEntry(CFConstantStringMap, Literal,
1821                              getTargetData().isLittleEndian(),
1822                              isUTF16, StringLength);
1823 
1824   if (llvm::Constant *C = Entry.getValue())
1825     return C;
1826 
1827   llvm::Constant *Zero = llvm::Constant::getNullValue(Int32Ty);
1828   llvm::Constant *Zeros[] = { Zero, Zero };
1829 
1830   // If we don't already have it, get __CFConstantStringClassReference.
1831   if (!CFConstantStringClassRef) {
1832     llvm::Type *Ty = getTypes().ConvertType(getContext().IntTy);
1833     Ty = llvm::ArrayType::get(Ty, 0);
1834     llvm::Constant *GV = CreateRuntimeVariable(Ty,
1835                                            "__CFConstantStringClassReference");
1836     // Decay array -> ptr
1837     CFConstantStringClassRef =
1838       llvm::ConstantExpr::getGetElementPtr(GV, Zeros);
1839   }
1840 
1841   QualType CFTy = getContext().getCFConstantStringType();
1842 
1843   llvm::StructType *STy =
1844     cast<llvm::StructType>(getTypes().ConvertType(CFTy));
1845 
1846   llvm::Constant *Fields[4];
1847 
1848   // Class pointer.
1849   Fields[0] = CFConstantStringClassRef;
1850 
1851   // Flags.
1852   llvm::Type *Ty = getTypes().ConvertType(getContext().UnsignedIntTy);
1853   Fields[1] = isUTF16 ? llvm::ConstantInt::get(Ty, 0x07d0) :
1854     llvm::ConstantInt::get(Ty, 0x07C8);
1855 
1856   // String pointer.
1857   llvm::Constant *C = llvm::ConstantDataArray::getString(VMContext,
1858                                                          Entry.getKey());
1859 
1860   llvm::GlobalValue::LinkageTypes Linkage;
1861   if (isUTF16)
1862     // FIXME: why do utf strings get "_" labels instead of "L" labels?
1863     Linkage = llvm::GlobalValue::InternalLinkage;
1864   else
1865     // FIXME: With OS X ld 123.2 (xcode 4) and LTO we would get a linker error
1866     // when using private linkage. It is not clear if this is a bug in ld
1867     // or a reasonable new restriction.
1868     Linkage = llvm::GlobalValue::LinkerPrivateLinkage;
1869 
1870   // Note: -fwritable-strings doesn't make the backing store strings of
1871   // CFStrings writable. (See <rdar://problem/10657500>)
1872   llvm::GlobalVariable *GV =
1873     new llvm::GlobalVariable(getModule(), C->getType(), /*isConstant=*/true,
1874                              Linkage, C, ".str");
1875   GV->setUnnamedAddr(true);
1876   if (isUTF16) {
1877     CharUnits Align = getContext().getTypeAlignInChars(getContext().ShortTy);
1878     GV->setAlignment(Align.getQuantity());
1879   } else {
1880     CharUnits Align = getContext().getTypeAlignInChars(getContext().CharTy);
1881     GV->setAlignment(Align.getQuantity());
1882   }
1883   Fields[2] = llvm::ConstantExpr::getGetElementPtr(GV, Zeros);
1884 
1885   // String length.
1886   Ty = getTypes().ConvertType(getContext().LongTy);
1887   Fields[3] = llvm::ConstantInt::get(Ty, StringLength);
1888 
1889   // The struct.
1890   C = llvm::ConstantStruct::get(STy, Fields);
1891   GV = new llvm::GlobalVariable(getModule(), C->getType(), true,
1892                                 llvm::GlobalVariable::PrivateLinkage, C,
1893                                 "_unnamed_cfstring_");
1894   if (const char *Sect = getContext().getTargetInfo().getCFStringSection())
1895     GV->setSection(Sect);
1896   Entry.setValue(GV);
1897 
1898   return GV;
1899 }
1900 
1901 static RecordDecl *
1902 CreateRecordDecl(const ASTContext &Ctx, RecordDecl::TagKind TK,
1903                  DeclContext *DC, IdentifierInfo *Id) {
1904   SourceLocation Loc;
1905   if (Ctx.getLangOptions().CPlusPlus)
1906     return CXXRecordDecl::Create(Ctx, TK, DC, Loc, Loc, Id);
1907   else
1908     return RecordDecl::Create(Ctx, TK, DC, Loc, Loc, Id);
1909 }
1910 
1911 llvm::Constant *
1912 CodeGenModule::GetAddrOfConstantString(const StringLiteral *Literal) {
1913   unsigned StringLength = 0;
1914   llvm::StringMapEntry<llvm::Constant*> &Entry =
1915     GetConstantStringEntry(CFConstantStringMap, Literal, StringLength);
1916 
1917   if (llvm::Constant *C = Entry.getValue())
1918     return C;
1919 
1920   llvm::Constant *Zero = llvm::Constant::getNullValue(Int32Ty);
1921   llvm::Constant *Zeros[] = { Zero, Zero };
1922 
1923   // If we don't already have it, get _NSConstantStringClassReference.
1924   if (!ConstantStringClassRef) {
1925     std::string StringClass(getLangOptions().ObjCConstantStringClass);
1926     llvm::Type *Ty = getTypes().ConvertType(getContext().IntTy);
1927     llvm::Constant *GV;
1928     if (Features.ObjCNonFragileABI) {
1929       std::string str =
1930         StringClass.empty() ? "OBJC_CLASS_$_NSConstantString"
1931                             : "OBJC_CLASS_$_" + StringClass;
1932       GV = getObjCRuntime().GetClassGlobal(str);
1933       // Make sure the result is of the correct type.
1934       llvm::Type *PTy = llvm::PointerType::getUnqual(Ty);
1935       ConstantStringClassRef =
1936         llvm::ConstantExpr::getBitCast(GV, PTy);
1937     } else {
1938       std::string str =
1939         StringClass.empty() ? "_NSConstantStringClassReference"
1940                             : "_" + StringClass + "ClassReference";
1941       llvm::Type *PTy = llvm::ArrayType::get(Ty, 0);
1942       GV = CreateRuntimeVariable(PTy, str);
1943       // Decay array -> ptr
1944       ConstantStringClassRef =
1945         llvm::ConstantExpr::getGetElementPtr(GV, Zeros);
1946     }
1947   }
1948 
1949   if (!NSConstantStringType) {
1950     // Construct the type for a constant NSString.
1951     RecordDecl *D = CreateRecordDecl(Context, TTK_Struct,
1952                                      Context.getTranslationUnitDecl(),
1953                                    &Context.Idents.get("__builtin_NSString"));
1954     D->startDefinition();
1955 
1956     QualType FieldTypes[3];
1957 
1958     // const int *isa;
1959     FieldTypes[0] = Context.getPointerType(Context.IntTy.withConst());
1960     // const char *str;
1961     FieldTypes[1] = Context.getPointerType(Context.CharTy.withConst());
1962     // unsigned int length;
1963     FieldTypes[2] = Context.UnsignedIntTy;
1964 
1965     // Create fields
1966     for (unsigned i = 0; i < 3; ++i) {
1967       FieldDecl *Field = FieldDecl::Create(Context, D,
1968                                            SourceLocation(),
1969                                            SourceLocation(), 0,
1970                                            FieldTypes[i], /*TInfo=*/0,
1971                                            /*BitWidth=*/0,
1972                                            /*Mutable=*/false,
1973                                            /*HasInit=*/false);
1974       Field->setAccess(AS_public);
1975       D->addDecl(Field);
1976     }
1977 
1978     D->completeDefinition();
1979     QualType NSTy = Context.getTagDeclType(D);
1980     NSConstantStringType = cast<llvm::StructType>(getTypes().ConvertType(NSTy));
1981   }
1982 
1983   llvm::Constant *Fields[3];
1984 
1985   // Class pointer.
1986   Fields[0] = ConstantStringClassRef;
1987 
1988   // String pointer.
1989   llvm::Constant *C =
1990     llvm::ConstantDataArray::getString(VMContext, Entry.getKey());
1991 
1992   llvm::GlobalValue::LinkageTypes Linkage;
1993   bool isConstant;
1994   Linkage = llvm::GlobalValue::PrivateLinkage;
1995   isConstant = !Features.WritableStrings;
1996 
1997   llvm::GlobalVariable *GV =
1998   new llvm::GlobalVariable(getModule(), C->getType(), isConstant, Linkage, C,
1999                            ".str");
2000   GV->setUnnamedAddr(true);
2001   CharUnits Align = getContext().getTypeAlignInChars(getContext().CharTy);
2002   GV->setAlignment(Align.getQuantity());
2003   Fields[1] = llvm::ConstantExpr::getGetElementPtr(GV, Zeros);
2004 
2005   // String length.
2006   llvm::Type *Ty = getTypes().ConvertType(getContext().UnsignedIntTy);
2007   Fields[2] = llvm::ConstantInt::get(Ty, StringLength);
2008 
2009   // The struct.
2010   C = llvm::ConstantStruct::get(NSConstantStringType, Fields);
2011   GV = new llvm::GlobalVariable(getModule(), C->getType(), true,
2012                                 llvm::GlobalVariable::PrivateLinkage, C,
2013                                 "_unnamed_nsstring_");
2014   // FIXME. Fix section.
2015   if (const char *Sect =
2016         Features.ObjCNonFragileABI
2017           ? getContext().getTargetInfo().getNSStringNonFragileABISection()
2018           : getContext().getTargetInfo().getNSStringSection())
2019     GV->setSection(Sect);
2020   Entry.setValue(GV);
2021 
2022   return GV;
2023 }
2024 
2025 QualType CodeGenModule::getObjCFastEnumerationStateType() {
2026   if (ObjCFastEnumerationStateType.isNull()) {
2027     RecordDecl *D = CreateRecordDecl(Context, TTK_Struct,
2028                                      Context.getTranslationUnitDecl(),
2029                       &Context.Idents.get("__objcFastEnumerationState"));
2030     D->startDefinition();
2031 
2032     QualType FieldTypes[] = {
2033       Context.UnsignedLongTy,
2034       Context.getPointerType(Context.getObjCIdType()),
2035       Context.getPointerType(Context.UnsignedLongTy),
2036       Context.getConstantArrayType(Context.UnsignedLongTy,
2037                            llvm::APInt(32, 5), ArrayType::Normal, 0)
2038     };
2039 
2040     for (size_t i = 0; i < 4; ++i) {
2041       FieldDecl *Field = FieldDecl::Create(Context,
2042                                            D,
2043                                            SourceLocation(),
2044                                            SourceLocation(), 0,
2045                                            FieldTypes[i], /*TInfo=*/0,
2046                                            /*BitWidth=*/0,
2047                                            /*Mutable=*/false,
2048                                            /*HasInit=*/false);
2049       Field->setAccess(AS_public);
2050       D->addDecl(Field);
2051     }
2052 
2053     D->completeDefinition();
2054     ObjCFastEnumerationStateType = Context.getTagDeclType(D);
2055   }
2056 
2057   return ObjCFastEnumerationStateType;
2058 }
2059 
2060 llvm::Constant *
2061 CodeGenModule::GetConstantArrayFromStringLiteral(const StringLiteral *E) {
2062   assert(!E->getType()->isPointerType() && "Strings are always arrays");
2063 
2064   // Don't emit it as the address of the string, emit the string data itself
2065   // as an inline array.
2066   if (E->getCharByteWidth() == 1) {
2067     SmallString<64> Str(E->getString());
2068 
2069     // Resize the string to the right size, which is indicated by its type.
2070     const ConstantArrayType *CAT = Context.getAsConstantArrayType(E->getType());
2071     Str.resize(CAT->getSize().getZExtValue());
2072     return llvm::ConstantDataArray::getString(VMContext, Str, false);
2073   }
2074 
2075   llvm::ArrayType *AType =
2076     cast<llvm::ArrayType>(getTypes().ConvertType(E->getType()));
2077   llvm::Type *ElemTy = AType->getElementType();
2078   unsigned NumElements = AType->getNumElements();
2079 
2080   // Wide strings have either 2-byte or 4-byte elements.
2081   if (ElemTy->getPrimitiveSizeInBits() == 16) {
2082     SmallVector<uint16_t, 32> Elements;
2083     Elements.reserve(NumElements);
2084 
2085     for(unsigned i = 0, e = E->getLength(); i != e; ++i)
2086       Elements.push_back(E->getCodeUnit(i));
2087     Elements.resize(NumElements);
2088     return llvm::ConstantDataArray::get(VMContext, Elements);
2089   }
2090 
2091   assert(ElemTy->getPrimitiveSizeInBits() == 32);
2092   SmallVector<uint32_t, 32> Elements;
2093   Elements.reserve(NumElements);
2094 
2095   for(unsigned i = 0, e = E->getLength(); i != e; ++i)
2096     Elements.push_back(E->getCodeUnit(i));
2097   Elements.resize(NumElements);
2098   return llvm::ConstantDataArray::get(VMContext, Elements);
2099 }
2100 
2101 /// GetAddrOfConstantStringFromLiteral - Return a pointer to a
2102 /// constant array for the given string literal.
2103 llvm::Constant *
2104 CodeGenModule::GetAddrOfConstantStringFromLiteral(const StringLiteral *S) {
2105   CharUnits Align = getContext().getTypeAlignInChars(S->getType());
2106   if (S->isAscii() || S->isUTF8()) {
2107     SmallString<64> Str(S->getString());
2108 
2109     // Resize the string to the right size, which is indicated by its type.
2110     const ConstantArrayType *CAT = Context.getAsConstantArrayType(S->getType());
2111     Str.resize(CAT->getSize().getZExtValue());
2112     return GetAddrOfConstantString(Str, /*GlobalName*/ 0, Align.getQuantity());
2113   }
2114 
2115   // FIXME: the following does not memoize wide strings.
2116   llvm::Constant *C = GetConstantArrayFromStringLiteral(S);
2117   llvm::GlobalVariable *GV =
2118     new llvm::GlobalVariable(getModule(),C->getType(),
2119                              !Features.WritableStrings,
2120                              llvm::GlobalValue::PrivateLinkage,
2121                              C,".str");
2122 
2123   GV->setAlignment(Align.getQuantity());
2124   GV->setUnnamedAddr(true);
2125   return GV;
2126 }
2127 
2128 /// GetAddrOfConstantStringFromObjCEncode - Return a pointer to a constant
2129 /// array for the given ObjCEncodeExpr node.
2130 llvm::Constant *
2131 CodeGenModule::GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *E) {
2132   std::string Str;
2133   getContext().getObjCEncodingForType(E->getEncodedType(), Str);
2134 
2135   return GetAddrOfConstantCString(Str);
2136 }
2137 
2138 
2139 /// GenerateWritableString -- Creates storage for a string literal.
2140 static llvm::GlobalVariable *GenerateStringLiteral(StringRef str,
2141                                              bool constant,
2142                                              CodeGenModule &CGM,
2143                                              const char *GlobalName,
2144                                              unsigned Alignment) {
2145   // Create Constant for this string literal. Don't add a '\0'.
2146   llvm::Constant *C =
2147       llvm::ConstantDataArray::getString(CGM.getLLVMContext(), str, false);
2148 
2149   // Create a global variable for this string
2150   llvm::GlobalVariable *GV =
2151     new llvm::GlobalVariable(CGM.getModule(), C->getType(), constant,
2152                              llvm::GlobalValue::PrivateLinkage,
2153                              C, GlobalName);
2154   GV->setAlignment(Alignment);
2155   GV->setUnnamedAddr(true);
2156   return GV;
2157 }
2158 
2159 /// GetAddrOfConstantString - Returns a pointer to a character array
2160 /// containing the literal. This contents are exactly that of the
2161 /// given string, i.e. it will not be null terminated automatically;
2162 /// see GetAddrOfConstantCString. Note that whether the result is
2163 /// actually a pointer to an LLVM constant depends on
2164 /// Feature.WriteableStrings.
2165 ///
2166 /// The result has pointer to array type.
2167 llvm::Constant *CodeGenModule::GetAddrOfConstantString(StringRef Str,
2168                                                        const char *GlobalName,
2169                                                        unsigned Alignment) {
2170   // Get the default prefix if a name wasn't specified.
2171   if (!GlobalName)
2172     GlobalName = ".str";
2173 
2174   // Don't share any string literals if strings aren't constant.
2175   if (Features.WritableStrings)
2176     return GenerateStringLiteral(Str, false, *this, GlobalName, Alignment);
2177 
2178   llvm::StringMapEntry<llvm::GlobalVariable *> &Entry =
2179     ConstantStringMap.GetOrCreateValue(Str);
2180 
2181   if (llvm::GlobalVariable *GV = Entry.getValue()) {
2182     if (Alignment > GV->getAlignment()) {
2183       GV->setAlignment(Alignment);
2184     }
2185     return GV;
2186   }
2187 
2188   // Create a global variable for this.
2189   llvm::GlobalVariable *GV = GenerateStringLiteral(Str, true, *this, GlobalName,
2190                                                    Alignment);
2191   Entry.setValue(GV);
2192   return GV;
2193 }
2194 
2195 /// GetAddrOfConstantCString - Returns a pointer to a character
2196 /// array containing the literal and a terminating '\0'
2197 /// character. The result has pointer to array type.
2198 llvm::Constant *CodeGenModule::GetAddrOfConstantCString(const std::string &Str,
2199                                                         const char *GlobalName,
2200                                                         unsigned Alignment) {
2201   StringRef StrWithNull(Str.c_str(), Str.size() + 1);
2202   return GetAddrOfConstantString(StrWithNull, GlobalName, Alignment);
2203 }
2204 
2205 /// EmitObjCPropertyImplementations - Emit information for synthesized
2206 /// properties for an implementation.
2207 void CodeGenModule::EmitObjCPropertyImplementations(const
2208                                                     ObjCImplementationDecl *D) {
2209   for (ObjCImplementationDecl::propimpl_iterator
2210          i = D->propimpl_begin(), e = D->propimpl_end(); i != e; ++i) {
2211     ObjCPropertyImplDecl *PID = *i;
2212 
2213     // Dynamic is just for type-checking.
2214     if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
2215       ObjCPropertyDecl *PD = PID->getPropertyDecl();
2216 
2217       // Determine which methods need to be implemented, some may have
2218       // been overridden. Note that ::isSynthesized is not the method
2219       // we want, that just indicates if the decl came from a
2220       // property. What we want to know is if the method is defined in
2221       // this implementation.
2222       if (!D->getInstanceMethod(PD->getGetterName()))
2223         CodeGenFunction(*this).GenerateObjCGetter(
2224                                  const_cast<ObjCImplementationDecl *>(D), PID);
2225       if (!PD->isReadOnly() &&
2226           !D->getInstanceMethod(PD->getSetterName()))
2227         CodeGenFunction(*this).GenerateObjCSetter(
2228                                  const_cast<ObjCImplementationDecl *>(D), PID);
2229     }
2230   }
2231 }
2232 
2233 static bool needsDestructMethod(ObjCImplementationDecl *impl) {
2234   const ObjCInterfaceDecl *iface = impl->getClassInterface();
2235   for (const ObjCIvarDecl *ivar = iface->all_declared_ivar_begin();
2236        ivar; ivar = ivar->getNextIvar())
2237     if (ivar->getType().isDestructedType())
2238       return true;
2239 
2240   return false;
2241 }
2242 
2243 /// EmitObjCIvarInitializations - Emit information for ivar initialization
2244 /// for an implementation.
2245 void CodeGenModule::EmitObjCIvarInitializations(ObjCImplementationDecl *D) {
2246   // We might need a .cxx_destruct even if we don't have any ivar initializers.
2247   if (needsDestructMethod(D)) {
2248     IdentifierInfo *II = &getContext().Idents.get(".cxx_destruct");
2249     Selector cxxSelector = getContext().Selectors.getSelector(0, &II);
2250     ObjCMethodDecl *DTORMethod =
2251       ObjCMethodDecl::Create(getContext(), D->getLocation(), D->getLocation(),
2252                              cxxSelector, getContext().VoidTy, 0, D,
2253                              /*isInstance=*/true, /*isVariadic=*/false,
2254                           /*isSynthesized=*/true, /*isImplicitlyDeclared=*/true,
2255                              /*isDefined=*/false, ObjCMethodDecl::Required);
2256     D->addInstanceMethod(DTORMethod);
2257     CodeGenFunction(*this).GenerateObjCCtorDtorMethod(D, DTORMethod, false);
2258     D->setHasCXXStructors(true);
2259   }
2260 
2261   // If the implementation doesn't have any ivar initializers, we don't need
2262   // a .cxx_construct.
2263   if (D->getNumIvarInitializers() == 0)
2264     return;
2265 
2266   IdentifierInfo *II = &getContext().Idents.get(".cxx_construct");
2267   Selector cxxSelector = getContext().Selectors.getSelector(0, &II);
2268   // The constructor returns 'self'.
2269   ObjCMethodDecl *CTORMethod = ObjCMethodDecl::Create(getContext(),
2270                                                 D->getLocation(),
2271                                                 D->getLocation(),
2272                                                 cxxSelector,
2273                                                 getContext().getObjCIdType(), 0,
2274                                                 D, /*isInstance=*/true,
2275                                                 /*isVariadic=*/false,
2276                                                 /*isSynthesized=*/true,
2277                                                 /*isImplicitlyDeclared=*/true,
2278                                                 /*isDefined=*/false,
2279                                                 ObjCMethodDecl::Required);
2280   D->addInstanceMethod(CTORMethod);
2281   CodeGenFunction(*this).GenerateObjCCtorDtorMethod(D, CTORMethod, true);
2282   D->setHasCXXStructors(true);
2283 }
2284 
2285 /// EmitNamespace - Emit all declarations in a namespace.
2286 void CodeGenModule::EmitNamespace(const NamespaceDecl *ND) {
2287   for (RecordDecl::decl_iterator I = ND->decls_begin(), E = ND->decls_end();
2288        I != E; ++I)
2289     EmitTopLevelDecl(*I);
2290 }
2291 
2292 // EmitLinkageSpec - Emit all declarations in a linkage spec.
2293 void CodeGenModule::EmitLinkageSpec(const LinkageSpecDecl *LSD) {
2294   if (LSD->getLanguage() != LinkageSpecDecl::lang_c &&
2295       LSD->getLanguage() != LinkageSpecDecl::lang_cxx) {
2296     ErrorUnsupported(LSD, "linkage spec");
2297     return;
2298   }
2299 
2300   for (RecordDecl::decl_iterator I = LSD->decls_begin(), E = LSD->decls_end();
2301        I != E; ++I)
2302     EmitTopLevelDecl(*I);
2303 }
2304 
2305 /// EmitTopLevelDecl - Emit code for a single top level declaration.
2306 void CodeGenModule::EmitTopLevelDecl(Decl *D) {
2307   // If an error has occurred, stop code generation, but continue
2308   // parsing and semantic analysis (to ensure all warnings and errors
2309   // are emitted).
2310   if (Diags.hasErrorOccurred())
2311     return;
2312 
2313   // Ignore dependent declarations.
2314   if (D->getDeclContext() && D->getDeclContext()->isDependentContext())
2315     return;
2316 
2317   switch (D->getKind()) {
2318   case Decl::CXXConversion:
2319   case Decl::CXXMethod:
2320   case Decl::Function:
2321     // Skip function templates
2322     if (cast<FunctionDecl>(D)->getDescribedFunctionTemplate() ||
2323         cast<FunctionDecl>(D)->isLateTemplateParsed())
2324       return;
2325 
2326     EmitGlobal(cast<FunctionDecl>(D));
2327     break;
2328 
2329   case Decl::Var:
2330     EmitGlobal(cast<VarDecl>(D));
2331     break;
2332 
2333   // Indirect fields from global anonymous structs and unions can be
2334   // ignored; only the actual variable requires IR gen support.
2335   case Decl::IndirectField:
2336     break;
2337 
2338   // C++ Decls
2339   case Decl::Namespace:
2340     EmitNamespace(cast<NamespaceDecl>(D));
2341     break;
2342     // No code generation needed.
2343   case Decl::UsingShadow:
2344   case Decl::Using:
2345   case Decl::UsingDirective:
2346   case Decl::ClassTemplate:
2347   case Decl::FunctionTemplate:
2348   case Decl::TypeAliasTemplate:
2349   case Decl::NamespaceAlias:
2350   case Decl::Block:
2351   case Decl::Import:
2352     break;
2353   case Decl::CXXConstructor:
2354     // Skip function templates
2355     if (cast<FunctionDecl>(D)->getDescribedFunctionTemplate() ||
2356         cast<FunctionDecl>(D)->isLateTemplateParsed())
2357       return;
2358 
2359     EmitCXXConstructors(cast<CXXConstructorDecl>(D));
2360     break;
2361   case Decl::CXXDestructor:
2362     if (cast<FunctionDecl>(D)->isLateTemplateParsed())
2363       return;
2364     EmitCXXDestructors(cast<CXXDestructorDecl>(D));
2365     break;
2366 
2367   case Decl::StaticAssert:
2368     // Nothing to do.
2369     break;
2370 
2371   // Objective-C Decls
2372 
2373   // Forward declarations, no (immediate) code generation.
2374   case Decl::ObjCInterface:
2375     break;
2376 
2377   case Decl::ObjCCategory: {
2378     ObjCCategoryDecl *CD = cast<ObjCCategoryDecl>(D);
2379     if (CD->IsClassExtension() && CD->hasSynthBitfield())
2380       Context.ResetObjCLayout(CD->getClassInterface());
2381     break;
2382   }
2383 
2384   case Decl::ObjCProtocol: {
2385     ObjCProtocolDecl *Proto = cast<ObjCProtocolDecl>(D);
2386     if (Proto->isThisDeclarationADefinition())
2387       ObjCRuntime->GenerateProtocol(Proto);
2388     break;
2389   }
2390 
2391   case Decl::ObjCCategoryImpl:
2392     // Categories have properties but don't support synthesize so we
2393     // can ignore them here.
2394     ObjCRuntime->GenerateCategory(cast<ObjCCategoryImplDecl>(D));
2395     break;
2396 
2397   case Decl::ObjCImplementation: {
2398     ObjCImplementationDecl *OMD = cast<ObjCImplementationDecl>(D);
2399     if (Features.ObjCNonFragileABI2 && OMD->hasSynthBitfield())
2400       Context.ResetObjCLayout(OMD->getClassInterface());
2401     EmitObjCPropertyImplementations(OMD);
2402     EmitObjCIvarInitializations(OMD);
2403     ObjCRuntime->GenerateClass(OMD);
2404     break;
2405   }
2406   case Decl::ObjCMethod: {
2407     ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(D);
2408     // If this is not a prototype, emit the body.
2409     if (OMD->getBody())
2410       CodeGenFunction(*this).GenerateObjCMethod(OMD);
2411     break;
2412   }
2413   case Decl::ObjCCompatibleAlias:
2414     ObjCRuntime->RegisterAlias(cast<ObjCCompatibleAliasDecl>(D));
2415     break;
2416 
2417   case Decl::LinkageSpec:
2418     EmitLinkageSpec(cast<LinkageSpecDecl>(D));
2419     break;
2420 
2421   case Decl::FileScopeAsm: {
2422     FileScopeAsmDecl *AD = cast<FileScopeAsmDecl>(D);
2423     StringRef AsmString = AD->getAsmString()->getString();
2424 
2425     const std::string &S = getModule().getModuleInlineAsm();
2426     if (S.empty())
2427       getModule().setModuleInlineAsm(AsmString);
2428     else if (*--S.end() == '\n')
2429       getModule().setModuleInlineAsm(S + AsmString.str());
2430     else
2431       getModule().setModuleInlineAsm(S + '\n' + AsmString.str());
2432     break;
2433   }
2434 
2435   default:
2436     // Make sure we handled everything we should, every other kind is a
2437     // non-top-level decl.  FIXME: Would be nice to have an isTopLevelDeclKind
2438     // function. Need to recode Decl::Kind to do that easily.
2439     assert(isa<TypeDecl>(D) && "Unsupported decl kind");
2440   }
2441 }
2442 
2443 /// Turns the given pointer into a constant.
2444 static llvm::Constant *GetPointerConstant(llvm::LLVMContext &Context,
2445                                           const void *Ptr) {
2446   uintptr_t PtrInt = reinterpret_cast<uintptr_t>(Ptr);
2447   llvm::Type *i64 = llvm::Type::getInt64Ty(Context);
2448   return llvm::ConstantInt::get(i64, PtrInt);
2449 }
2450 
2451 static void EmitGlobalDeclMetadata(CodeGenModule &CGM,
2452                                    llvm::NamedMDNode *&GlobalMetadata,
2453                                    GlobalDecl D,
2454                                    llvm::GlobalValue *Addr) {
2455   if (!GlobalMetadata)
2456     GlobalMetadata =
2457       CGM.getModule().getOrInsertNamedMetadata("clang.global.decl.ptrs");
2458 
2459   // TODO: should we report variant information for ctors/dtors?
2460   llvm::Value *Ops[] = {
2461     Addr,
2462     GetPointerConstant(CGM.getLLVMContext(), D.getDecl())
2463   };
2464   GlobalMetadata->addOperand(llvm::MDNode::get(CGM.getLLVMContext(), Ops));
2465 }
2466 
2467 /// Emits metadata nodes associating all the global values in the
2468 /// current module with the Decls they came from.  This is useful for
2469 /// projects using IR gen as a subroutine.
2470 ///
2471 /// Since there's currently no way to associate an MDNode directly
2472 /// with an llvm::GlobalValue, we create a global named metadata
2473 /// with the name 'clang.global.decl.ptrs'.
2474 void CodeGenModule::EmitDeclMetadata() {
2475   llvm::NamedMDNode *GlobalMetadata = 0;
2476 
2477   // StaticLocalDeclMap
2478   for (llvm::DenseMap<GlobalDecl,StringRef>::iterator
2479          I = MangledDeclNames.begin(), E = MangledDeclNames.end();
2480        I != E; ++I) {
2481     llvm::GlobalValue *Addr = getModule().getNamedValue(I->second);
2482     EmitGlobalDeclMetadata(*this, GlobalMetadata, I->first, Addr);
2483   }
2484 }
2485 
2486 /// Emits metadata nodes for all the local variables in the current
2487 /// function.
2488 void CodeGenFunction::EmitDeclMetadata() {
2489   if (LocalDeclMap.empty()) return;
2490 
2491   llvm::LLVMContext &Context = getLLVMContext();
2492 
2493   // Find the unique metadata ID for this name.
2494   unsigned DeclPtrKind = Context.getMDKindID("clang.decl.ptr");
2495 
2496   llvm::NamedMDNode *GlobalMetadata = 0;
2497 
2498   for (llvm::DenseMap<const Decl*, llvm::Value*>::iterator
2499          I = LocalDeclMap.begin(), E = LocalDeclMap.end(); I != E; ++I) {
2500     const Decl *D = I->first;
2501     llvm::Value *Addr = I->second;
2502 
2503     if (llvm::AllocaInst *Alloca = dyn_cast<llvm::AllocaInst>(Addr)) {
2504       llvm::Value *DAddr = GetPointerConstant(getLLVMContext(), D);
2505       Alloca->setMetadata(DeclPtrKind, llvm::MDNode::get(Context, DAddr));
2506     } else if (llvm::GlobalValue *GV = dyn_cast<llvm::GlobalValue>(Addr)) {
2507       GlobalDecl GD = GlobalDecl(cast<VarDecl>(D));
2508       EmitGlobalDeclMetadata(CGM, GlobalMetadata, GD, GV);
2509     }
2510   }
2511 }
2512 
2513 void CodeGenModule::EmitCoverageFile() {
2514   if (!getCodeGenOpts().CoverageFile.empty()) {
2515     if (llvm::NamedMDNode *CUNode = TheModule.getNamedMetadata("llvm.dbg.cu")) {
2516       llvm::NamedMDNode *GCov = TheModule.getOrInsertNamedMetadata("llvm.gcov");
2517       llvm::LLVMContext &Ctx = TheModule.getContext();
2518       llvm::MDString *CoverageFile =
2519           llvm::MDString::get(Ctx, getCodeGenOpts().CoverageFile);
2520       for (int i = 0, e = CUNode->getNumOperands(); i != e; ++i) {
2521         llvm::MDNode *CU = CUNode->getOperand(i);
2522         llvm::Value *node[] = { CoverageFile, CU };
2523         llvm::MDNode *N = llvm::MDNode::get(Ctx, node);
2524         GCov->addOperand(N);
2525       }
2526     }
2527   }
2528 }
2529