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 "CGCall.h"
18 #include "CGObjCRuntime.h"
19 #include "Mangle.h"
20 #include "clang/Frontend/CompileOptions.h"
21 #include "clang/AST/ASTContext.h"
22 #include "clang/AST/DeclObjC.h"
23 #include "clang/AST/DeclCXX.h"
24 #include "clang/Basic/Diagnostic.h"
25 #include "clang/Basic/SourceManager.h"
26 #include "clang/Basic/TargetInfo.h"
27 #include "clang/Basic/ConvertUTF.h"
28 #include "llvm/CallingConv.h"
29 #include "llvm/Module.h"
30 #include "llvm/Intrinsics.h"
31 #include "llvm/Target/TargetData.h"
32 using namespace clang;
33 using namespace CodeGen;
34 
35 
36 CodeGenModule::CodeGenModule(ASTContext &C, const CompileOptions &compileOpts,
37                              llvm::Module &M, const llvm::TargetData &TD,
38                              Diagnostic &diags)
39   : BlockModule(C, M, TD, Types, *this), Context(C),
40     Features(C.getLangOptions()), CompileOpts(compileOpts), TheModule(M),
41     TheTargetData(TD), Diags(diags), Types(C, M, TD), Runtime(0),
42     MemCpyFn(0), MemMoveFn(0), MemSetFn(0), CFConstantStringClassRef(0) {
43 
44   if (!Features.ObjC1)
45     Runtime = 0;
46   else if (!Features.NeXTRuntime)
47     Runtime = CreateGNUObjCRuntime(*this);
48   else if (Features.ObjCNonFragileABI)
49     Runtime = CreateMacNonFragileABIObjCRuntime(*this);
50   else
51     Runtime = CreateMacObjCRuntime(*this);
52 
53   // If debug info generation is enabled, create the CGDebugInfo object.
54   DebugInfo = CompileOpts.DebugInfo ? new CGDebugInfo(this) : 0;
55 }
56 
57 CodeGenModule::~CodeGenModule() {
58   delete Runtime;
59   delete DebugInfo;
60 }
61 
62 void CodeGenModule::Release() {
63   EmitDeferred();
64   if (Runtime)
65     if (llvm::Function *ObjCInitFunction = Runtime->ModuleInitFunction())
66       AddGlobalCtor(ObjCInitFunction);
67   EmitCtorList(GlobalCtors, "llvm.global_ctors");
68   EmitCtorList(GlobalDtors, "llvm.global_dtors");
69   EmitAnnotations();
70   EmitLLVMUsed();
71 }
72 
73 /// ErrorUnsupported - Print out an error that codegen doesn't support the
74 /// specified stmt yet.
75 void CodeGenModule::ErrorUnsupported(const Stmt *S, const char *Type,
76                                      bool OmitOnError) {
77   if (OmitOnError && getDiags().hasErrorOccurred())
78     return;
79   unsigned DiagID = getDiags().getCustomDiagID(Diagnostic::Error,
80                                                "cannot compile this %0 yet");
81   std::string Msg = Type;
82   getDiags().Report(Context.getFullLoc(S->getLocStart()), DiagID)
83     << Msg << S->getSourceRange();
84 }
85 
86 /// ErrorUnsupported - Print out an error that codegen doesn't support the
87 /// specified decl yet.
88 void CodeGenModule::ErrorUnsupported(const Decl *D, const char *Type,
89                                      bool OmitOnError) {
90   if (OmitOnError && getDiags().hasErrorOccurred())
91     return;
92   unsigned DiagID = getDiags().getCustomDiagID(Diagnostic::Error,
93                                                "cannot compile this %0 yet");
94   std::string Msg = Type;
95   getDiags().Report(Context.getFullLoc(D->getLocation()), DiagID) << Msg;
96 }
97 
98 LangOptions::VisibilityMode
99 CodeGenModule::getDeclVisibilityMode(const Decl *D) const {
100   if (const VarDecl *VD = dyn_cast<VarDecl>(D))
101     if (VD->getStorageClass() == VarDecl::PrivateExtern)
102       return LangOptions::Hidden;
103 
104   if (const VisibilityAttr *attr = D->getAttr<VisibilityAttr>()) {
105     switch (attr->getVisibility()) {
106     default: assert(0 && "Unknown visibility!");
107     case VisibilityAttr::DefaultVisibility:
108       return LangOptions::Default;
109     case VisibilityAttr::HiddenVisibility:
110       return LangOptions::Hidden;
111     case VisibilityAttr::ProtectedVisibility:
112       return LangOptions::Protected;
113     }
114   }
115 
116   return getLangOptions().getVisibilityMode();
117 }
118 
119 void CodeGenModule::setGlobalVisibility(llvm::GlobalValue *GV,
120                                         const Decl *D) const {
121   // Internal definitions always have default visibility.
122   if (GV->hasLocalLinkage()) {
123     GV->setVisibility(llvm::GlobalValue::DefaultVisibility);
124     return;
125   }
126 
127   switch (getDeclVisibilityMode(D)) {
128   default: assert(0 && "Unknown visibility!");
129   case LangOptions::Default:
130     return GV->setVisibility(llvm::GlobalValue::DefaultVisibility);
131   case LangOptions::Hidden:
132     return GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
133   case LangOptions::Protected:
134     return GV->setVisibility(llvm::GlobalValue::ProtectedVisibility);
135   }
136 }
137 
138 const char *CodeGenModule::getMangledName(const GlobalDecl &GD) {
139   const NamedDecl *ND = GD.getDecl();
140 
141   if (const CXXConstructorDecl *D = dyn_cast<CXXConstructorDecl>(ND))
142     return getMangledCXXCtorName(D, GD.getCtorType());
143   if (const CXXDestructorDecl *D = dyn_cast<CXXDestructorDecl>(ND))
144     return getMangledCXXDtorName(D, GD.getDtorType());
145 
146   return getMangledName(ND);
147 }
148 
149 /// \brief Retrieves the mangled name for the given declaration.
150 ///
151 /// If the given declaration requires a mangled name, returns an
152 /// const char* containing the mangled name.  Otherwise, returns
153 /// the unmangled name.
154 ///
155 const char *CodeGenModule::getMangledName(const NamedDecl *ND) {
156   // In C, functions with no attributes never need to be mangled. Fastpath them.
157   if (!getLangOptions().CPlusPlus && !ND->hasAttrs()) {
158     assert(ND->getIdentifier() && "Attempt to mangle unnamed decl.");
159     return ND->getNameAsCString();
160   }
161 
162   llvm::SmallString<256> Name;
163   llvm::raw_svector_ostream Out(Name);
164   if (!mangleName(ND, Context, Out)) {
165     assert(ND->getIdentifier() && "Attempt to mangle unnamed decl.");
166     return ND->getNameAsCString();
167   }
168 
169   Name += '\0';
170   return UniqueMangledName(Name.begin(), Name.end());
171 }
172 
173 const char *CodeGenModule::UniqueMangledName(const char *NameStart,
174                                              const char *NameEnd) {
175   assert(*(NameEnd - 1) == '\0' && "Mangled name must be null terminated!");
176 
177   return MangledNames.GetOrCreateValue(NameStart, NameEnd).getKeyData();
178 }
179 
180 /// AddGlobalCtor - Add a function to the list that will be called before
181 /// main() runs.
182 void CodeGenModule::AddGlobalCtor(llvm::Function * Ctor, int Priority) {
183   // FIXME: Type coercion of void()* types.
184   GlobalCtors.push_back(std::make_pair(Ctor, Priority));
185 }
186 
187 /// AddGlobalDtor - Add a function to the list that will be called
188 /// when the module is unloaded.
189 void CodeGenModule::AddGlobalDtor(llvm::Function * Dtor, int Priority) {
190   // FIXME: Type coercion of void()* types.
191   GlobalDtors.push_back(std::make_pair(Dtor, Priority));
192 }
193 
194 void CodeGenModule::EmitCtorList(const CtorList &Fns, const char *GlobalName) {
195   // Ctor function type is void()*.
196   llvm::FunctionType* CtorFTy =
197     llvm::FunctionType::get(llvm::Type::VoidTy,
198                             std::vector<const llvm::Type*>(),
199                             false);
200   llvm::Type *CtorPFTy = llvm::PointerType::getUnqual(CtorFTy);
201 
202   // Get the type of a ctor entry, { i32, void ()* }.
203   llvm::StructType* CtorStructTy =
204     llvm::StructType::get(llvm::Type::Int32Ty,
205                           llvm::PointerType::getUnqual(CtorFTy), NULL);
206 
207   // Construct the constructor and destructor arrays.
208   std::vector<llvm::Constant*> Ctors;
209   for (CtorList::const_iterator I = Fns.begin(), E = Fns.end(); I != E; ++I) {
210     std::vector<llvm::Constant*> S;
211     S.push_back(llvm::ConstantInt::get(llvm::Type::Int32Ty, I->second, false));
212     S.push_back(llvm::ConstantExpr::getBitCast(I->first, CtorPFTy));
213     Ctors.push_back(llvm::ConstantStruct::get(CtorStructTy, S));
214   }
215 
216   if (!Ctors.empty()) {
217     llvm::ArrayType *AT = llvm::ArrayType::get(CtorStructTy, Ctors.size());
218     new llvm::GlobalVariable(AT, false,
219                              llvm::GlobalValue::AppendingLinkage,
220                              llvm::ConstantArray::get(AT, Ctors),
221                              GlobalName,
222                              &TheModule);
223   }
224 }
225 
226 void CodeGenModule::EmitAnnotations() {
227   if (Annotations.empty())
228     return;
229 
230   // Create a new global variable for the ConstantStruct in the Module.
231   llvm::Constant *Array =
232   llvm::ConstantArray::get(llvm::ArrayType::get(Annotations[0]->getType(),
233                                                 Annotations.size()),
234                            Annotations);
235   llvm::GlobalValue *gv =
236   new llvm::GlobalVariable(Array->getType(), false,
237                            llvm::GlobalValue::AppendingLinkage, Array,
238                            "llvm.global.annotations", &TheModule);
239   gv->setSection("llvm.metadata");
240 }
241 
242 static CodeGenModule::GVALinkage
243 GetLinkageForFunction(const FunctionDecl *FD, const LangOptions &Features) {
244   // "static" functions get internal linkage.
245   if (FD->getStorageClass() == FunctionDecl::Static)
246     return CodeGenModule::GVA_Internal;
247 
248   if (!FD->isInline())
249     return CodeGenModule::GVA_StrongExternal;
250 
251   // If the inline function explicitly has the GNU inline attribute on it, or if
252   // this is C89 mode, we use to GNU semantics.
253   if (!Features.C99 && !Features.CPlusPlus) {
254     // extern inline in GNU mode is like C99 inline.
255     if (FD->getStorageClass() == FunctionDecl::Extern)
256       return CodeGenModule::GVA_C99Inline;
257     // Normal inline is a strong symbol.
258     return CodeGenModule::GVA_StrongExternal;
259   } else if (FD->hasActiveGNUInlineAttribute()) {
260     // GCC in C99 mode seems to use a different decision-making
261     // process for extern inline, which factors in previous
262     // declarations.
263     if (FD->isExternGNUInline())
264       return CodeGenModule::GVA_C99Inline;
265     // Normal inline is a strong symbol.
266     return CodeGenModule::GVA_StrongExternal;
267   }
268 
269   // The definition of inline changes based on the language.  Note that we
270   // have already handled "static inline" above, with the GVA_Internal case.
271   if (Features.CPlusPlus)  // inline and extern inline.
272     return CodeGenModule::GVA_CXXInline;
273 
274   assert(Features.C99 && "Must be in C99 mode if not in C89 or C++ mode");
275   if (FD->isC99InlineDefinition())
276     return CodeGenModule::GVA_C99Inline;
277 
278   return CodeGenModule::GVA_StrongExternal;
279 }
280 
281 /// SetFunctionDefinitionAttributes - Set attributes for a global.
282 ///
283 /// FIXME: This is currently only done for aliases and functions, but
284 /// not for variables (these details are set in
285 /// EmitGlobalVarDefinition for variables).
286 void CodeGenModule::SetFunctionDefinitionAttributes(const FunctionDecl *D,
287                                                     llvm::GlobalValue *GV) {
288   GVALinkage Linkage = GetLinkageForFunction(D, Features);
289 
290   if (Linkage == GVA_Internal) {
291     GV->setLinkage(llvm::Function::InternalLinkage);
292   } else if (D->hasAttr<DLLExportAttr>()) {
293     GV->setLinkage(llvm::Function::DLLExportLinkage);
294   } else if (D->hasAttr<WeakAttr>() || D->hasAttr<WeakImportAttr>()) {
295     GV->setLinkage(llvm::Function::WeakAnyLinkage);
296   } else if (Linkage == GVA_C99Inline) {
297     // In C99 mode, 'inline' functions are guaranteed to have a strong
298     // definition somewhere else, so we can use available_externally linkage.
299     GV->setLinkage(llvm::Function::AvailableExternallyLinkage);
300   } else if (Linkage == GVA_CXXInline) {
301     // In C++, the compiler has to emit a definition in every translation unit
302     // that references the function.  We should use linkonce_odr because
303     // a) if all references in this translation unit are optimized away, we
304     // don't need to codegen it.  b) if the function persists, it needs to be
305     // merged with other definitions. c) C++ has the ODR, so we know the
306     // definition is dependable.
307     GV->setLinkage(llvm::Function::LinkOnceODRLinkage);
308   } else {
309     assert(Linkage == GVA_StrongExternal);
310     // Otherwise, we have strong external linkage.
311     GV->setLinkage(llvm::Function::ExternalLinkage);
312   }
313 
314   SetCommonAttributes(D, GV);
315 }
316 
317 void CodeGenModule::SetLLVMFunctionAttributes(const Decl *D,
318                                               const CGFunctionInfo &Info,
319                                               llvm::Function *F) {
320   AttributeListType AttributeList;
321   ConstructAttributeList(Info, D, AttributeList);
322 
323   F->setAttributes(llvm::AttrListPtr::get(AttributeList.begin(),
324                                         AttributeList.size()));
325 
326   // Set the appropriate calling convention for the Function.
327   if (D->hasAttr<FastCallAttr>())
328     F->setCallingConv(llvm::CallingConv::X86_FastCall);
329 
330   if (D->hasAttr<StdCallAttr>())
331     F->setCallingConv(llvm::CallingConv::X86_StdCall);
332 }
333 
334 void CodeGenModule::SetLLVMFunctionAttributesForDefinition(const Decl *D,
335                                                            llvm::Function *F) {
336   if (!Features.Exceptions && !Features.ObjCNonFragileABI)
337     F->addFnAttr(llvm::Attribute::NoUnwind);
338 
339   if (D->hasAttr<AlwaysInlineAttr>())
340     F->addFnAttr(llvm::Attribute::AlwaysInline);
341 
342   if (D->hasAttr<NoinlineAttr>())
343     F->addFnAttr(llvm::Attribute::NoInline);
344 }
345 
346 void CodeGenModule::SetCommonAttributes(const Decl *D,
347                                         llvm::GlobalValue *GV) {
348   setGlobalVisibility(GV, D);
349 
350   if (D->hasAttr<UsedAttr>())
351     AddUsedGlobal(GV);
352 
353   if (const SectionAttr *SA = D->getAttr<SectionAttr>())
354     GV->setSection(SA->getName());
355 }
356 
357 void CodeGenModule::SetInternalFunctionAttributes(const Decl *D,
358                                                   llvm::Function *F,
359                                                   const CGFunctionInfo &FI) {
360   SetLLVMFunctionAttributes(D, FI, F);
361   SetLLVMFunctionAttributesForDefinition(D, F);
362 
363   F->setLinkage(llvm::Function::InternalLinkage);
364 
365   SetCommonAttributes(D, F);
366 }
367 
368 void CodeGenModule::SetFunctionAttributes(const FunctionDecl *FD,
369                                           llvm::Function *F) {
370   SetLLVMFunctionAttributes(FD, getTypes().getFunctionInfo(FD), F);
371 
372   // Only a few attributes are set on declarations; these may later be
373   // overridden by a definition.
374 
375   if (FD->hasAttr<DLLImportAttr>()) {
376     F->setLinkage(llvm::Function::DLLImportLinkage);
377   } else if (FD->hasAttr<WeakAttr>() || FD->hasAttr<WeakImportAttr>()) {
378     // "extern_weak" is overloaded in LLVM; we probably should have
379     // separate linkage types for this.
380     F->setLinkage(llvm::Function::ExternalWeakLinkage);
381   } else {
382     F->setLinkage(llvm::Function::ExternalLinkage);
383   }
384 
385   if (const SectionAttr *SA = FD->getAttr<SectionAttr>())
386     F->setSection(SA->getName());
387 }
388 
389 void CodeGenModule::AddUsedGlobal(llvm::GlobalValue *GV) {
390   assert(!GV->isDeclaration() &&
391          "Only globals with definition can force usage.");
392   LLVMUsed.push_back(GV);
393 }
394 
395 void CodeGenModule::EmitLLVMUsed() {
396   // Don't create llvm.used if there is no need.
397   if (LLVMUsed.empty())
398     return;
399 
400   llvm::Type *i8PTy = llvm::PointerType::getUnqual(llvm::Type::Int8Ty);
401   llvm::ArrayType *ATy = llvm::ArrayType::get(i8PTy, LLVMUsed.size());
402 
403   // Convert LLVMUsed to what ConstantArray needs.
404   std::vector<llvm::Constant*> UsedArray;
405   UsedArray.resize(LLVMUsed.size());
406   for (unsigned i = 0, e = LLVMUsed.size(); i != e; ++i) {
407     UsedArray[i] =
408      llvm::ConstantExpr::getBitCast(cast<llvm::Constant>(&*LLVMUsed[i]), i8PTy);
409   }
410 
411   llvm::GlobalVariable *GV =
412     new llvm::GlobalVariable(ATy, false,
413                              llvm::GlobalValue::AppendingLinkage,
414                              llvm::ConstantArray::get(ATy, UsedArray),
415                              "llvm.used", &getModule());
416 
417   GV->setSection("llvm.metadata");
418 }
419 
420 void CodeGenModule::EmitDeferred() {
421   // Emit code for any potentially referenced deferred decls.  Since a
422   // previously unused static decl may become used during the generation of code
423   // for a static function, iterate until no  changes are made.
424   while (!DeferredDeclsToEmit.empty()) {
425     GlobalDecl D = DeferredDeclsToEmit.back();
426     DeferredDeclsToEmit.pop_back();
427 
428     // The mangled name for the decl must have been emitted in GlobalDeclMap.
429     // Look it up to see if it was defined with a stronger definition (e.g. an
430     // extern inline function with a strong function redefinition).  If so,
431     // just ignore the deferred decl.
432     llvm::GlobalValue *CGRef = GlobalDeclMap[getMangledName(D)];
433     assert(CGRef && "Deferred decl wasn't referenced?");
434 
435     if (!CGRef->isDeclaration())
436       continue;
437 
438     // Otherwise, emit the definition and move on to the next one.
439     EmitGlobalDefinition(D);
440   }
441 }
442 
443 /// EmitAnnotateAttr - Generate the llvm::ConstantStruct which contains the
444 /// annotation information for a given GlobalValue.  The annotation struct is
445 /// {i8 *, i8 *, i8 *, i32}.  The first field is a constant expression, the
446 /// GlobalValue being annotated.  The second field is the constant string
447 /// created from the AnnotateAttr's annotation.  The third field is a constant
448 /// string containing the name of the translation unit.  The fourth field is
449 /// the line number in the file of the annotated value declaration.
450 ///
451 /// FIXME: this does not unique the annotation string constants, as llvm-gcc
452 ///        appears to.
453 ///
454 llvm::Constant *CodeGenModule::EmitAnnotateAttr(llvm::GlobalValue *GV,
455                                                 const AnnotateAttr *AA,
456                                                 unsigned LineNo) {
457   llvm::Module *M = &getModule();
458 
459   // get [N x i8] constants for the annotation string, and the filename string
460   // which are the 2nd and 3rd elements of the global annotation structure.
461   const llvm::Type *SBP = llvm::PointerType::getUnqual(llvm::Type::Int8Ty);
462   llvm::Constant *anno = llvm::ConstantArray::get(AA->getAnnotation(), true);
463   llvm::Constant *unit = llvm::ConstantArray::get(M->getModuleIdentifier(),
464                                                   true);
465 
466   // Get the two global values corresponding to the ConstantArrays we just
467   // created to hold the bytes of the strings.
468   const char *StringPrefix = getContext().Target.getStringSymbolPrefix(true);
469   llvm::GlobalValue *annoGV =
470   new llvm::GlobalVariable(anno->getType(), false,
471                            llvm::GlobalValue::InternalLinkage, anno,
472                            GV->getName() + StringPrefix, M);
473   // translation unit name string, emitted into the llvm.metadata section.
474   llvm::GlobalValue *unitGV =
475   new llvm::GlobalVariable(unit->getType(), false,
476                            llvm::GlobalValue::InternalLinkage, unit,
477                            StringPrefix, M);
478 
479   // Create the ConstantStruct for the global annotation.
480   llvm::Constant *Fields[4] = {
481     llvm::ConstantExpr::getBitCast(GV, SBP),
482     llvm::ConstantExpr::getBitCast(annoGV, SBP),
483     llvm::ConstantExpr::getBitCast(unitGV, SBP),
484     llvm::ConstantInt::get(llvm::Type::Int32Ty, LineNo)
485   };
486   return llvm::ConstantStruct::get(Fields, 4, false);
487 }
488 
489 bool CodeGenModule::MayDeferGeneration(const ValueDecl *Global) {
490   // Never defer when EmitAllDecls is specified or the decl has
491   // attribute used.
492   if (Features.EmitAllDecls || Global->hasAttr<UsedAttr>())
493     return false;
494 
495   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(Global)) {
496     // Constructors and destructors should never be deferred.
497     if (FD->hasAttr<ConstructorAttr>() || FD->hasAttr<DestructorAttr>())
498       return false;
499 
500     GVALinkage Linkage = GetLinkageForFunction(FD, Features);
501 
502     // static, static inline, always_inline, and extern inline functions can
503     // always be deferred.  Normal inline functions can be deferred in C99/C++.
504     if (Linkage == GVA_Internal || Linkage == GVA_C99Inline ||
505         Linkage == GVA_CXXInline)
506       return true;
507     return false;
508   }
509 
510   const VarDecl *VD = cast<VarDecl>(Global);
511   assert(VD->isFileVarDecl() && "Invalid decl");
512 
513   return VD->getStorageClass() == VarDecl::Static;
514 }
515 
516 void CodeGenModule::EmitGlobal(const GlobalDecl &GD) {
517   const ValueDecl *Global = GD.getDecl();
518 
519   // If this is an alias definition (which otherwise looks like a declaration)
520   // emit it now.
521   if (Global->hasAttr<AliasAttr>())
522     return EmitAliasDefinition(Global);
523 
524   // Ignore declarations, they will be emitted on their first use.
525   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(Global)) {
526     // Forward declarations are emitted lazily on first use.
527     if (!FD->isThisDeclarationADefinition())
528       return;
529   } else {
530     const VarDecl *VD = cast<VarDecl>(Global);
531     assert(VD->isFileVarDecl() && "Cannot emit local var decl as global.");
532 
533     // In C++, if this is marked "extern", defer code generation.
534     if (getLangOptions().CPlusPlus &&
535         VD->getStorageClass() == VarDecl::Extern && !VD->getInit())
536       return;
537 
538     // In C, if this isn't a definition, defer code generation.
539     if (!getLangOptions().CPlusPlus && !VD->getInit())
540       return;
541   }
542 
543   // Defer code generation when possible if this is a static definition, inline
544   // function etc.  These we only want to emit if they are used.
545   if (MayDeferGeneration(Global)) {
546     // If the value has already been used, add it directly to the
547     // DeferredDeclsToEmit list.
548     const char *MangledName = getMangledName(GD);
549     if (GlobalDeclMap.count(MangledName))
550       DeferredDeclsToEmit.push_back(GD);
551     else {
552       // Otherwise, remember that we saw a deferred decl with this name.  The
553       // first use of the mangled name will cause it to move into
554       // DeferredDeclsToEmit.
555       DeferredDecls[MangledName] = GD;
556     }
557     return;
558   }
559 
560   // Otherwise emit the definition.
561   EmitGlobalDefinition(GD);
562 }
563 
564 void CodeGenModule::EmitGlobalDefinition(const GlobalDecl &GD) {
565   const ValueDecl *D = GD.getDecl();
566 
567   if (const CXXConstructorDecl *CD = dyn_cast<CXXConstructorDecl>(D))
568     EmitCXXConstructor(CD, GD.getCtorType());
569   else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D))
570     EmitGlobalFunctionDefinition(FD);
571   else if (const VarDecl *VD = dyn_cast<VarDecl>(D))
572     EmitGlobalVarDefinition(VD);
573   else {
574     assert(0 && "Invalid argument to EmitGlobalDefinition()");
575   }
576 }
577 
578 /// GetOrCreateLLVMFunction - If the specified mangled name is not in the
579 /// module, create and return an llvm Function with the specified type. If there
580 /// is something in the module with the specified name, return it potentially
581 /// bitcasted to the right type.
582 ///
583 /// If D is non-null, it specifies a decl that correspond to this.  This is used
584 /// to set the attributes on the function when it is first created.
585 llvm::Constant *CodeGenModule::GetOrCreateLLVMFunction(const char *MangledName,
586                                                        const llvm::Type *Ty,
587                                                        const FunctionDecl *D) {
588   // Lookup the entry, lazily creating it if necessary.
589   llvm::GlobalValue *&Entry = GlobalDeclMap[MangledName];
590   if (Entry) {
591     if (Entry->getType()->getElementType() == Ty)
592       return Entry;
593 
594     // Make sure the result is of the correct type.
595     const llvm::Type *PTy = llvm::PointerType::getUnqual(Ty);
596     return llvm::ConstantExpr::getBitCast(Entry, PTy);
597   }
598 
599   // This is the first use or definition of a mangled name.  If there is a
600   // deferred decl with this name, remember that we need to emit it at the end
601   // of the file.
602   llvm::DenseMap<const char*, GlobalDecl>::iterator DDI =
603     DeferredDecls.find(MangledName);
604   if (DDI != DeferredDecls.end()) {
605     // Move the potentially referenced deferred decl to the DeferredDeclsToEmit
606     // list, and remove it from DeferredDecls (since we don't need it anymore).
607     DeferredDeclsToEmit.push_back(DDI->second);
608     DeferredDecls.erase(DDI);
609   } else if (D && D->isThisDeclarationADefinition() && MayDeferGeneration(D)) {
610     // If this the first reference to a C++ inline function in a class, queue up
611     // the deferred function body for emission.  These are not seen as
612     // top-level declarations.
613     // FIXME: Make this work for ctor/dtors.  We need to pass down a full
614     // GlobalDecl instead of just a FunctionDecl.
615     if (!isa<CXXConstructorDecl>(D) &&
616         !isa<CXXDestructorDecl>(D))
617     DeferredDeclsToEmit.push_back(GlobalDecl(D));
618   }
619 
620   // This function doesn't have a complete type (for example, the return
621   // type is an incomplete struct). Use a fake type instead, and make
622   // sure not to try to set attributes.
623   bool ShouldSetAttributes = true;
624   if (!isa<llvm::FunctionType>(Ty)) {
625     Ty = llvm::FunctionType::get(llvm::Type::VoidTy,
626                                  std::vector<const llvm::Type*>(), false);
627     ShouldSetAttributes = false;
628   }
629   llvm::Function *F = llvm::Function::Create(cast<llvm::FunctionType>(Ty),
630                                              llvm::Function::ExternalLinkage,
631                                              "", &getModule());
632   F->setName(MangledName);
633   if (D && ShouldSetAttributes)
634     SetFunctionAttributes(D, F);
635   Entry = F;
636   return F;
637 }
638 
639 /// GetAddrOfFunction - Return the address of the given function.  If Ty is
640 /// non-null, then this function will use the specified type if it has to
641 /// create it (this occurs when we see a definition of the function).
642 llvm::Constant *CodeGenModule::GetAddrOfFunction(const FunctionDecl *D,
643                                                  const llvm::Type *Ty) {
644   // If there was no specific requested type, just convert it now.
645   if (!Ty)
646     Ty = getTypes().ConvertType(D->getType());
647   return GetOrCreateLLVMFunction(getMangledName(D), Ty, D);
648 }
649 
650 /// CreateRuntimeFunction - Create a new runtime function with the specified
651 /// type and name.
652 llvm::Constant *
653 CodeGenModule::CreateRuntimeFunction(const llvm::FunctionType *FTy,
654                                      const char *Name) {
655   // Convert Name to be a uniqued string from the IdentifierInfo table.
656   Name = getContext().Idents.get(Name).getName();
657   return GetOrCreateLLVMFunction(Name, FTy, 0);
658 }
659 
660 /// GetOrCreateLLVMGlobal - If the specified mangled name is not in the module,
661 /// create and return an llvm GlobalVariable with the specified type.  If there
662 /// is something in the module with the specified name, return it potentially
663 /// bitcasted to the right type.
664 ///
665 /// If D is non-null, it specifies a decl that correspond to this.  This is used
666 /// to set the attributes on the global when it is first created.
667 llvm::Constant *CodeGenModule::GetOrCreateLLVMGlobal(const char *MangledName,
668                                                      const llvm::PointerType*Ty,
669                                                      const VarDecl *D) {
670   // Lookup the entry, lazily creating it if necessary.
671   llvm::GlobalValue *&Entry = GlobalDeclMap[MangledName];
672   if (Entry) {
673     if (Entry->getType() == Ty)
674       return Entry;
675 
676     // Make sure the result is of the correct type.
677     return llvm::ConstantExpr::getBitCast(Entry, Ty);
678   }
679 
680   // This is the first use or definition of a mangled name.  If there is a
681   // deferred decl with this name, remember that we need to emit it at the end
682   // of the file.
683   llvm::DenseMap<const char*, GlobalDecl>::iterator DDI =
684     DeferredDecls.find(MangledName);
685   if (DDI != DeferredDecls.end()) {
686     // Move the potentially referenced deferred decl to the DeferredDeclsToEmit
687     // list, and remove it from DeferredDecls (since we don't need it anymore).
688     DeferredDeclsToEmit.push_back(DDI->second);
689     DeferredDecls.erase(DDI);
690   }
691 
692   llvm::GlobalVariable *GV =
693     new llvm::GlobalVariable(Ty->getElementType(), false,
694                              llvm::GlobalValue::ExternalLinkage,
695                              0, "", &getModule(),
696                              false, Ty->getAddressSpace());
697   GV->setName(MangledName);
698 
699   // Handle things which are present even on external declarations.
700   if (D) {
701     // FIXME: This code is overly simple and should be merged with
702     // other global handling.
703     GV->setConstant(D->getType().isConstant(Context));
704 
705     // FIXME: Merge with other attribute handling code.
706     if (D->getStorageClass() == VarDecl::PrivateExtern)
707       GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
708 
709     if (D->hasAttr<WeakAttr>() || D->hasAttr<WeakImportAttr>())
710       GV->setLinkage(llvm::GlobalValue::ExternalWeakLinkage);
711 
712     GV->setThreadLocal(D->isThreadSpecified());
713   }
714 
715   return Entry = GV;
716 }
717 
718 
719 /// GetAddrOfGlobalVar - Return the llvm::Constant for the address of the
720 /// given global variable.  If Ty is non-null and if the global doesn't exist,
721 /// then it will be greated with the specified type instead of whatever the
722 /// normal requested type would be.
723 llvm::Constant *CodeGenModule::GetAddrOfGlobalVar(const VarDecl *D,
724                                                   const llvm::Type *Ty) {
725   assert(D->hasGlobalStorage() && "Not a global variable");
726   QualType ASTTy = D->getType();
727   if (Ty == 0)
728     Ty = getTypes().ConvertTypeForMem(ASTTy);
729 
730   const llvm::PointerType *PTy =
731     llvm::PointerType::get(Ty, ASTTy.getAddressSpace());
732   return GetOrCreateLLVMGlobal(getMangledName(D), PTy, D);
733 }
734 
735 /// CreateRuntimeVariable - Create a new runtime global variable with the
736 /// specified type and name.
737 llvm::Constant *
738 CodeGenModule::CreateRuntimeVariable(const llvm::Type *Ty,
739                                      const char *Name) {
740   // Convert Name to be a uniqued string from the IdentifierInfo table.
741   Name = getContext().Idents.get(Name).getName();
742   return GetOrCreateLLVMGlobal(Name, llvm::PointerType::getUnqual(Ty), 0);
743 }
744 
745 void CodeGenModule::EmitTentativeDefinition(const VarDecl *D) {
746   assert(!D->getInit() && "Cannot emit definite definitions here!");
747 
748   if (MayDeferGeneration(D)) {
749     // If we have not seen a reference to this variable yet, place it
750     // into the deferred declarations table to be emitted if needed
751     // later.
752     const char *MangledName = getMangledName(D);
753     if (GlobalDeclMap.count(MangledName) == 0) {
754       DeferredDecls[MangledName] = GlobalDecl(D);
755       return;
756     }
757   }
758 
759   // The tentative definition is the only definition.
760   EmitGlobalVarDefinition(D);
761 }
762 
763 void CodeGenModule::EmitGlobalVarDefinition(const VarDecl *D) {
764   llvm::Constant *Init = 0;
765   QualType ASTTy = D->getType();
766 
767   if (D->getInit() == 0) {
768     // This is a tentative definition; tentative definitions are
769     // implicitly initialized with { 0 }.
770     //
771     // Note that tentative definitions are only emitted at the end of
772     // a translation unit, so they should never have incomplete
773     // type. In addition, EmitTentativeDefinition makes sure that we
774     // never attempt to emit a tentative definition if a real one
775     // exists. A use may still exists, however, so we still may need
776     // to do a RAUW.
777     assert(!ASTTy->isIncompleteType() && "Unexpected incomplete type");
778     Init = llvm::Constant::getNullValue(getTypes().ConvertTypeForMem(ASTTy));
779   } else {
780     Init = EmitConstantExpr(D->getInit(), D->getType());
781     if (!Init) {
782       ErrorUnsupported(D, "static initializer");
783       QualType T = D->getInit()->getType();
784       Init = llvm::UndefValue::get(getTypes().ConvertType(T));
785     }
786   }
787 
788   const llvm::Type* InitType = Init->getType();
789   llvm::Constant *Entry = GetAddrOfGlobalVar(D, InitType);
790 
791   // Strip off a bitcast if we got one back.
792   if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Entry)) {
793     assert(CE->getOpcode() == llvm::Instruction::BitCast);
794     Entry = CE->getOperand(0);
795   }
796 
797   // Entry is now either a Function or GlobalVariable.
798   llvm::GlobalVariable *GV = dyn_cast<llvm::GlobalVariable>(Entry);
799 
800   // We have a definition after a declaration with the wrong type.
801   // We must make a new GlobalVariable* and update everything that used OldGV
802   // (a declaration or tentative definition) with the new GlobalVariable*
803   // (which will be a definition).
804   //
805   // This happens if there is a prototype for a global (e.g.
806   // "extern int x[];") and then a definition of a different type (e.g.
807   // "int x[10];"). This also happens when an initializer has a different type
808   // from the type of the global (this happens with unions).
809   if (GV == 0 ||
810       GV->getType()->getElementType() != InitType ||
811       GV->getType()->getAddressSpace() != ASTTy.getAddressSpace()) {
812 
813     // Remove the old entry from GlobalDeclMap so that we'll create a new one.
814     GlobalDeclMap.erase(getMangledName(D));
815 
816     // Make a new global with the correct type, this is now guaranteed to work.
817     GV = cast<llvm::GlobalVariable>(GetAddrOfGlobalVar(D, InitType));
818     GV->takeName(cast<llvm::GlobalValue>(Entry));
819 
820     // Replace all uses of the old global with the new global
821     llvm::Constant *NewPtrForOldDecl =
822         llvm::ConstantExpr::getBitCast(GV, Entry->getType());
823     Entry->replaceAllUsesWith(NewPtrForOldDecl);
824 
825     // Erase the old global, since it is no longer used.
826     cast<llvm::GlobalValue>(Entry)->eraseFromParent();
827   }
828 
829   if (const AnnotateAttr *AA = D->getAttr<AnnotateAttr>()) {
830     SourceManager &SM = Context.getSourceManager();
831     AddAnnotation(EmitAnnotateAttr(GV, AA,
832                               SM.getInstantiationLineNumber(D->getLocation())));
833   }
834 
835   GV->setInitializer(Init);
836   GV->setConstant(D->getType().isConstant(Context));
837   GV->setAlignment(getContext().getDeclAlignInBytes(D));
838 
839   // Set the llvm linkage type as appropriate.
840   if (D->getStorageClass() == VarDecl::Static)
841     GV->setLinkage(llvm::Function::InternalLinkage);
842   else if (D->hasAttr<DLLImportAttr>())
843     GV->setLinkage(llvm::Function::DLLImportLinkage);
844   else if (D->hasAttr<DLLExportAttr>())
845     GV->setLinkage(llvm::Function::DLLExportLinkage);
846   else if (D->hasAttr<WeakAttr>() || D->hasAttr<WeakImportAttr>())
847     GV->setLinkage(llvm::GlobalVariable::WeakAnyLinkage);
848   else if (!CompileOpts.NoCommon &&
849            (!D->hasExternalStorage() && !D->getInit()))
850     GV->setLinkage(llvm::GlobalVariable::CommonLinkage);
851   else
852     GV->setLinkage(llvm::GlobalVariable::ExternalLinkage);
853 
854   SetCommonAttributes(D, GV);
855 
856   // Emit global variable debug information.
857   if (CGDebugInfo *DI = getDebugInfo()) {
858     DI->setLocation(D->getLocation());
859     DI->EmitGlobalVariable(GV, D);
860   }
861 }
862 
863 /// ReplaceUsesOfNonProtoTypeWithRealFunction - This function is called when we
864 /// implement a function with no prototype, e.g. "int foo() {}".  If there are
865 /// existing call uses of the old function in the module, this adjusts them to
866 /// call the new function directly.
867 ///
868 /// This is not just a cleanup: the always_inline pass requires direct calls to
869 /// functions to be able to inline them.  If there is a bitcast in the way, it
870 /// won't inline them.  Instcombine normally deletes these calls, but it isn't
871 /// run at -O0.
872 static void ReplaceUsesOfNonProtoTypeWithRealFunction(llvm::GlobalValue *Old,
873                                                       llvm::Function *NewFn) {
874   // If we're redefining a global as a function, don't transform it.
875   llvm::Function *OldFn = dyn_cast<llvm::Function>(Old);
876   if (OldFn == 0) return;
877 
878   const llvm::Type *NewRetTy = NewFn->getReturnType();
879   llvm::SmallVector<llvm::Value*, 4> ArgList;
880 
881   for (llvm::Value::use_iterator UI = OldFn->use_begin(), E = OldFn->use_end();
882        UI != E; ) {
883     // TODO: Do invokes ever occur in C code?  If so, we should handle them too.
884     llvm::CallInst *CI = dyn_cast<llvm::CallInst>(*UI++);
885     if (!CI) continue;
886 
887     // If the return types don't match exactly, and if the call isn't dead, then
888     // we can't transform this call.
889     if (CI->getType() != NewRetTy && !CI->use_empty())
890       continue;
891 
892     // If the function was passed too few arguments, don't transform.  If extra
893     // arguments were passed, we silently drop them.  If any of the types
894     // mismatch, we don't transform.
895     unsigned ArgNo = 0;
896     bool DontTransform = false;
897     for (llvm::Function::arg_iterator AI = NewFn->arg_begin(),
898          E = NewFn->arg_end(); AI != E; ++AI, ++ArgNo) {
899       if (CI->getNumOperands()-1 == ArgNo ||
900           CI->getOperand(ArgNo+1)->getType() != AI->getType()) {
901         DontTransform = true;
902         break;
903       }
904     }
905     if (DontTransform)
906       continue;
907 
908     // Okay, we can transform this.  Create the new call instruction and copy
909     // over the required information.
910     ArgList.append(CI->op_begin()+1, CI->op_begin()+1+ArgNo);
911     llvm::CallInst *NewCall = llvm::CallInst::Create(NewFn, ArgList.begin(),
912                                                      ArgList.end(), "", CI);
913     ArgList.clear();
914     if (NewCall->getType() != llvm::Type::VoidTy)
915       NewCall->takeName(CI);
916     NewCall->setCallingConv(CI->getCallingConv());
917     NewCall->setAttributes(CI->getAttributes());
918 
919     // Finally, remove the old call, replacing any uses with the new one.
920     if (!CI->use_empty())
921       CI->replaceAllUsesWith(NewCall);
922     CI->eraseFromParent();
923   }
924 }
925 
926 
927 void CodeGenModule::EmitGlobalFunctionDefinition(const FunctionDecl *D) {
928   const llvm::FunctionType *Ty;
929 
930   if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(D)) {
931     bool isVariadic = D->getType()->getAsFunctionProtoType()->isVariadic();
932 
933     Ty = getTypes().GetFunctionType(getTypes().getFunctionInfo(MD), isVariadic);
934   } else {
935     Ty = cast<llvm::FunctionType>(getTypes().ConvertType(D->getType()));
936 
937     // As a special case, make sure that definitions of K&R function
938     // "type foo()" aren't declared as varargs (which forces the backend
939     // to do unnecessary work).
940     if (D->getType()->isFunctionNoProtoType()) {
941       assert(Ty->isVarArg() && "Didn't lower type as expected");
942       // Due to stret, the lowered function could have arguments.
943       // Just create the same type as was lowered by ConvertType
944       // but strip off the varargs bit.
945       std::vector<const llvm::Type*> Args(Ty->param_begin(), Ty->param_end());
946       Ty = llvm::FunctionType::get(Ty->getReturnType(), Args, false);
947     }
948   }
949 
950   // Get or create the prototype for the function.
951   llvm::Constant *Entry = GetAddrOfFunction(D, Ty);
952 
953   // Strip off a bitcast if we got one back.
954   if (llvm::ConstantExpr *CE = dyn_cast<llvm::ConstantExpr>(Entry)) {
955     assert(CE->getOpcode() == llvm::Instruction::BitCast);
956     Entry = CE->getOperand(0);
957   }
958 
959 
960   if (cast<llvm::GlobalValue>(Entry)->getType()->getElementType() != Ty) {
961     llvm::GlobalValue *OldFn = cast<llvm::GlobalValue>(Entry);
962 
963     // If the types mismatch then we have to rewrite the definition.
964     assert(OldFn->isDeclaration() &&
965            "Shouldn't replace non-declaration");
966 
967     // F is the Function* for the one with the wrong type, we must make a new
968     // Function* and update everything that used F (a declaration) with the new
969     // Function* (which will be a definition).
970     //
971     // This happens if there is a prototype for a function
972     // (e.g. "int f()") and then a definition of a different type
973     // (e.g. "int f(int x)").  Start by making a new function of the
974     // correct type, RAUW, then steal the name.
975     GlobalDeclMap.erase(getMangledName(D));
976     llvm::Function *NewFn = cast<llvm::Function>(GetAddrOfFunction(D, Ty));
977     NewFn->takeName(OldFn);
978 
979     // If this is an implementation of a function without a prototype, try to
980     // replace any existing uses of the function (which may be calls) with uses
981     // of the new function
982     if (D->getType()->isFunctionNoProtoType()) {
983       ReplaceUsesOfNonProtoTypeWithRealFunction(OldFn, NewFn);
984       OldFn->removeDeadConstantUsers();
985     }
986 
987     // Replace uses of F with the Function we will endow with a body.
988     if (!Entry->use_empty()) {
989       llvm::Constant *NewPtrForOldDecl =
990         llvm::ConstantExpr::getBitCast(NewFn, Entry->getType());
991       Entry->replaceAllUsesWith(NewPtrForOldDecl);
992     }
993 
994     // Ok, delete the old function now, which is dead.
995     OldFn->eraseFromParent();
996 
997     Entry = NewFn;
998   }
999 
1000   llvm::Function *Fn = cast<llvm::Function>(Entry);
1001 
1002   CodeGenFunction(*this).GenerateCode(D, Fn);
1003 
1004   SetFunctionDefinitionAttributes(D, Fn);
1005   SetLLVMFunctionAttributesForDefinition(D, Fn);
1006 
1007   if (const ConstructorAttr *CA = D->getAttr<ConstructorAttr>())
1008     AddGlobalCtor(Fn, CA->getPriority());
1009   if (const DestructorAttr *DA = D->getAttr<DestructorAttr>())
1010     AddGlobalDtor(Fn, DA->getPriority());
1011 }
1012 
1013 void CodeGenModule::EmitAliasDefinition(const ValueDecl *D) {
1014   const AliasAttr *AA = D->getAttr<AliasAttr>();
1015   assert(AA && "Not an alias?");
1016 
1017   const llvm::Type *DeclTy = getTypes().ConvertTypeForMem(D->getType());
1018 
1019   // Unique the name through the identifier table.
1020   const char *AliaseeName = AA->getAliasee().c_str();
1021   AliaseeName = getContext().Idents.get(AliaseeName).getName();
1022 
1023   // Create a reference to the named value.  This ensures that it is emitted
1024   // if a deferred decl.
1025   llvm::Constant *Aliasee;
1026   if (isa<llvm::FunctionType>(DeclTy))
1027     Aliasee = GetOrCreateLLVMFunction(AliaseeName, DeclTy, 0);
1028   else
1029     Aliasee = GetOrCreateLLVMGlobal(AliaseeName,
1030                                     llvm::PointerType::getUnqual(DeclTy), 0);
1031 
1032   // Create the new alias itself, but don't set a name yet.
1033   llvm::GlobalValue *GA =
1034     new llvm::GlobalAlias(Aliasee->getType(),
1035                           llvm::Function::ExternalLinkage,
1036                           "", Aliasee, &getModule());
1037 
1038   // See if there is already something with the alias' name in the module.
1039   const char *MangledName = getMangledName(D);
1040   llvm::GlobalValue *&Entry = GlobalDeclMap[MangledName];
1041 
1042   if (Entry && !Entry->isDeclaration()) {
1043     // If there is a definition in the module, then it wins over the alias.
1044     // This is dubious, but allow it to be safe.  Just ignore the alias.
1045     GA->eraseFromParent();
1046     return;
1047   }
1048 
1049   if (Entry) {
1050     // If there is a declaration in the module, then we had an extern followed
1051     // by the alias, as in:
1052     //   extern int test6();
1053     //   ...
1054     //   int test6() __attribute__((alias("test7")));
1055     //
1056     // Remove it and replace uses of it with the alias.
1057 
1058     Entry->replaceAllUsesWith(llvm::ConstantExpr::getBitCast(GA,
1059                                                           Entry->getType()));
1060     Entry->eraseFromParent();
1061   }
1062 
1063   // Now we know that there is no conflict, set the name.
1064   Entry = GA;
1065   GA->setName(MangledName);
1066 
1067   // Set attributes which are particular to an alias; this is a
1068   // specialization of the attributes which may be set on a global
1069   // variable/function.
1070   if (D->hasAttr<DLLExportAttr>()) {
1071     if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
1072       // The dllexport attribute is ignored for undefined symbols.
1073       if (FD->getBody(getContext()))
1074         GA->setLinkage(llvm::Function::DLLExportLinkage);
1075     } else {
1076       GA->setLinkage(llvm::Function::DLLExportLinkage);
1077     }
1078   } else if (D->hasAttr<WeakAttr>() || D->hasAttr<WeakImportAttr>()) {
1079     GA->setLinkage(llvm::Function::WeakAnyLinkage);
1080   }
1081 
1082   SetCommonAttributes(D, GA);
1083 }
1084 
1085 /// getBuiltinLibFunction - Given a builtin id for a function like
1086 /// "__builtin_fabsf", return a Function* for "fabsf".
1087 llvm::Value *CodeGenModule::getBuiltinLibFunction(unsigned BuiltinID) {
1088   assert((Context.BuiltinInfo.isLibFunction(BuiltinID) ||
1089           Context.BuiltinInfo.isPredefinedLibFunction(BuiltinID)) &&
1090          "isn't a lib fn");
1091 
1092   // Get the name, skip over the __builtin_ prefix (if necessary).
1093   const char *Name = Context.BuiltinInfo.GetName(BuiltinID);
1094   if (Context.BuiltinInfo.isLibFunction(BuiltinID))
1095     Name += 10;
1096 
1097   // Get the type for the builtin.
1098   Builtin::Context::GetBuiltinTypeError Error;
1099   QualType Type = Context.BuiltinInfo.GetBuiltinType(BuiltinID, Context, Error);
1100   assert(Error == Builtin::Context::GE_None && "Can't get builtin type");
1101 
1102   const llvm::FunctionType *Ty =
1103     cast<llvm::FunctionType>(getTypes().ConvertType(Type));
1104 
1105   // Unique the name through the identifier table.
1106   Name = getContext().Idents.get(Name).getName();
1107   // FIXME: param attributes for sext/zext etc.
1108   return GetOrCreateLLVMFunction(Name, Ty, 0);
1109 }
1110 
1111 llvm::Function *CodeGenModule::getIntrinsic(unsigned IID,const llvm::Type **Tys,
1112                                             unsigned NumTys) {
1113   return llvm::Intrinsic::getDeclaration(&getModule(),
1114                                          (llvm::Intrinsic::ID)IID, Tys, NumTys);
1115 }
1116 
1117 llvm::Function *CodeGenModule::getMemCpyFn() {
1118   if (MemCpyFn) return MemCpyFn;
1119   const llvm::Type *IntPtr = TheTargetData.getIntPtrType();
1120   return MemCpyFn = getIntrinsic(llvm::Intrinsic::memcpy, &IntPtr, 1);
1121 }
1122 
1123 llvm::Function *CodeGenModule::getMemMoveFn() {
1124   if (MemMoveFn) return MemMoveFn;
1125   const llvm::Type *IntPtr = TheTargetData.getIntPtrType();
1126   return MemMoveFn = getIntrinsic(llvm::Intrinsic::memmove, &IntPtr, 1);
1127 }
1128 
1129 llvm::Function *CodeGenModule::getMemSetFn() {
1130   if (MemSetFn) return MemSetFn;
1131   const llvm::Type *IntPtr = TheTargetData.getIntPtrType();
1132   return MemSetFn = getIntrinsic(llvm::Intrinsic::memset, &IntPtr, 1);
1133 }
1134 
1135 static void appendFieldAndPadding(CodeGenModule &CGM,
1136                                   std::vector<llvm::Constant*>& Fields,
1137                                   FieldDecl *FieldD, FieldDecl *NextFieldD,
1138                                   llvm::Constant* Field,
1139                                   RecordDecl* RD, const llvm::StructType *STy) {
1140   // Append the field.
1141   Fields.push_back(Field);
1142 
1143   int StructFieldNo = CGM.getTypes().getLLVMFieldNo(FieldD);
1144 
1145   int NextStructFieldNo;
1146   if (!NextFieldD) {
1147     NextStructFieldNo = STy->getNumElements();
1148   } else {
1149     NextStructFieldNo = CGM.getTypes().getLLVMFieldNo(NextFieldD);
1150   }
1151 
1152   // Append padding
1153   for (int i = StructFieldNo + 1; i < NextStructFieldNo; i++) {
1154     llvm::Constant *C =
1155       llvm::Constant::getNullValue(STy->getElementType(StructFieldNo + 1));
1156 
1157     Fields.push_back(C);
1158   }
1159 }
1160 
1161 llvm::Constant *CodeGenModule::
1162 GetAddrOfConstantCFString(const StringLiteral *Literal) {
1163   std::string str;
1164   unsigned StringLength = 0;
1165 
1166   bool isUTF16 = false;
1167   if (Literal->containsNonAsciiOrNull()) {
1168     // Convert from UTF-8 to UTF-16.
1169     llvm::SmallVector<UTF16, 128> ToBuf(Literal->getByteLength());
1170     const UTF8 *FromPtr = (UTF8 *)Literal->getStrData();
1171     UTF16 *ToPtr = &ToBuf[0];
1172 
1173     ConversionResult Result;
1174     Result = ConvertUTF8toUTF16(&FromPtr, FromPtr+Literal->getByteLength(),
1175                                 &ToPtr, ToPtr+Literal->getByteLength(),
1176                                 strictConversion);
1177     if (Result == conversionOK) {
1178       // FIXME: Storing UTF-16 in a C string is a hack to test Unicode strings
1179       // without doing more surgery to this routine. Since we aren't explicitly
1180       // checking for endianness here, it's also a bug (when generating code for
1181       // a target that doesn't match the host endianness). Modeling this as an
1182       // i16 array is likely the cleanest solution.
1183       StringLength = ToPtr-&ToBuf[0];
1184       str.assign((char *)&ToBuf[0], StringLength*2);// Twice as many UTF8 chars.
1185       isUTF16 = true;
1186     } else if (Result == sourceIllegal) {
1187       // FIXME: Have Sema::CheckObjCString() validate the UTF-8 string.
1188       str.assign(Literal->getStrData(), Literal->getByteLength());
1189       StringLength = str.length();
1190     } else
1191       assert(Result == conversionOK && "UTF-8 to UTF-16 conversion failed");
1192 
1193   } else {
1194     str.assign(Literal->getStrData(), Literal->getByteLength());
1195     StringLength = str.length();
1196   }
1197   llvm::StringMapEntry<llvm::Constant *> &Entry =
1198     CFConstantStringMap.GetOrCreateValue(&str[0], &str[str.length()]);
1199 
1200   if (llvm::Constant *C = Entry.getValue())
1201     return C;
1202 
1203   llvm::Constant *Zero = llvm::Constant::getNullValue(llvm::Type::Int32Ty);
1204   llvm::Constant *Zeros[] = { Zero, Zero };
1205 
1206   if (!CFConstantStringClassRef) {
1207     const llvm::Type *Ty = getTypes().ConvertType(getContext().IntTy);
1208     Ty = llvm::ArrayType::get(Ty, 0);
1209 
1210     // FIXME: This is fairly broken if
1211     // __CFConstantStringClassReference is already defined, in that it
1212     // will get renamed and the user will most likely see an opaque
1213     // error message. This is a general issue with relying on
1214     // particular names.
1215     llvm::GlobalVariable *GV =
1216       new llvm::GlobalVariable(Ty, false,
1217                                llvm::GlobalVariable::ExternalLinkage, 0,
1218                                "__CFConstantStringClassReference",
1219                                &getModule());
1220 
1221     // Decay array -> ptr
1222     CFConstantStringClassRef =
1223       llvm::ConstantExpr::getGetElementPtr(GV, Zeros, 2);
1224   }
1225 
1226   QualType CFTy = getContext().getCFConstantStringType();
1227   RecordDecl *CFRD = CFTy->getAsRecordType()->getDecl();
1228 
1229   const llvm::StructType *STy =
1230     cast<llvm::StructType>(getTypes().ConvertType(CFTy));
1231 
1232   std::vector<llvm::Constant*> Fields;
1233   RecordDecl::field_iterator Field = CFRD->field_begin(getContext());
1234 
1235   // Class pointer.
1236   FieldDecl *CurField = *Field++;
1237   FieldDecl *NextField = *Field++;
1238   appendFieldAndPadding(*this, Fields, CurField, NextField,
1239                         CFConstantStringClassRef, CFRD, STy);
1240 
1241   // Flags.
1242   CurField = NextField;
1243   NextField = *Field++;
1244   const llvm::Type *Ty = getTypes().ConvertType(getContext().UnsignedIntTy);
1245   appendFieldAndPadding(*this, Fields, CurField, NextField,
1246                         isUTF16 ? llvm::ConstantInt::get(Ty, 0x07d0)
1247                                 : llvm::ConstantInt::get(Ty, 0x07C8),
1248                         CFRD, STy);
1249 
1250   // String pointer.
1251   CurField = NextField;
1252   NextField = *Field++;
1253   llvm::Constant *C = llvm::ConstantArray::get(str);
1254 
1255   const char *Sect, *Prefix;
1256   bool isConstant;
1257   if (isUTF16) {
1258     Prefix = getContext().Target.getUnicodeStringSymbolPrefix();
1259     Sect = getContext().Target.getUnicodeStringSection();
1260     // FIXME: Why does GCC not set constant here?
1261     isConstant = false;
1262   } else {
1263     Prefix = getContext().Target.getStringSymbolPrefix(true);
1264     Sect = getContext().Target.getCFStringDataSection();
1265     // FIXME: -fwritable-strings should probably affect this, but we
1266     // are following gcc here.
1267     isConstant = true;
1268   }
1269   llvm::GlobalVariable *GV =
1270     new llvm::GlobalVariable(C->getType(), isConstant,
1271                              llvm::GlobalValue::InternalLinkage,
1272                              C, Prefix, &getModule());
1273   if (Sect)
1274     GV->setSection(Sect);
1275   if (isUTF16) {
1276     unsigned Align = getContext().getTypeAlign(getContext().ShortTy)/8;
1277     GV->setAlignment(Align);
1278   }
1279   appendFieldAndPadding(*this, Fields, CurField, NextField,
1280                         llvm::ConstantExpr::getGetElementPtr(GV, Zeros, 2),
1281                         CFRD, STy);
1282 
1283   // String length.
1284   CurField = NextField;
1285   NextField = 0;
1286   Ty = getTypes().ConvertType(getContext().LongTy);
1287   appendFieldAndPadding(*this, Fields, CurField, NextField,
1288                         llvm::ConstantInt::get(Ty, StringLength), CFRD, STy);
1289 
1290   // The struct.
1291   C = llvm::ConstantStruct::get(STy, Fields);
1292   GV = new llvm::GlobalVariable(C->getType(), true,
1293                                 llvm::GlobalVariable::InternalLinkage, C,
1294                                 getContext().Target.getCFStringSymbolPrefix(),
1295                                 &getModule());
1296   if (const char *Sect = getContext().Target.getCFStringSection())
1297     GV->setSection(Sect);
1298   Entry.setValue(GV);
1299 
1300   return GV;
1301 }
1302 
1303 /// GetStringForStringLiteral - Return the appropriate bytes for a
1304 /// string literal, properly padded to match the literal type.
1305 std::string CodeGenModule::GetStringForStringLiteral(const StringLiteral *E) {
1306   const char *StrData = E->getStrData();
1307   unsigned Len = E->getByteLength();
1308 
1309   const ConstantArrayType *CAT =
1310     getContext().getAsConstantArrayType(E->getType());
1311   assert(CAT && "String isn't pointer or array!");
1312 
1313   // Resize the string to the right size.
1314   std::string Str(StrData, StrData+Len);
1315   uint64_t RealLen = CAT->getSize().getZExtValue();
1316 
1317   if (E->isWide())
1318     RealLen *= getContext().Target.getWCharWidth()/8;
1319 
1320   Str.resize(RealLen, '\0');
1321 
1322   return Str;
1323 }
1324 
1325 /// GetAddrOfConstantStringFromLiteral - Return a pointer to a
1326 /// constant array for the given string literal.
1327 llvm::Constant *
1328 CodeGenModule::GetAddrOfConstantStringFromLiteral(const StringLiteral *S) {
1329   // FIXME: This can be more efficient.
1330   return GetAddrOfConstantString(GetStringForStringLiteral(S));
1331 }
1332 
1333 /// GetAddrOfConstantStringFromObjCEncode - Return a pointer to a constant
1334 /// array for the given ObjCEncodeExpr node.
1335 llvm::Constant *
1336 CodeGenModule::GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *E) {
1337   std::string Str;
1338   getContext().getObjCEncodingForType(E->getEncodedType(), Str);
1339 
1340   return GetAddrOfConstantCString(Str);
1341 }
1342 
1343 
1344 /// GenerateWritableString -- Creates storage for a string literal.
1345 static llvm::Constant *GenerateStringLiteral(const std::string &str,
1346                                              bool constant,
1347                                              CodeGenModule &CGM,
1348                                              const char *GlobalName) {
1349   // Create Constant for this string literal. Don't add a '\0'.
1350   llvm::Constant *C = llvm::ConstantArray::get(str, false);
1351 
1352   // Create a global variable for this string
1353   return new llvm::GlobalVariable(C->getType(), constant,
1354                                   llvm::GlobalValue::InternalLinkage,
1355                                   C, GlobalName, &CGM.getModule());
1356 }
1357 
1358 /// GetAddrOfConstantString - Returns a pointer to a character array
1359 /// containing the literal. This contents are exactly that of the
1360 /// given string, i.e. it will not be null terminated automatically;
1361 /// see GetAddrOfConstantCString. Note that whether the result is
1362 /// actually a pointer to an LLVM constant depends on
1363 /// Feature.WriteableStrings.
1364 ///
1365 /// The result has pointer to array type.
1366 llvm::Constant *CodeGenModule::GetAddrOfConstantString(const std::string &str,
1367                                                        const char *GlobalName) {
1368   bool IsConstant = !Features.WritableStrings;
1369 
1370   // Get the default prefix if a name wasn't specified.
1371   if (!GlobalName)
1372     GlobalName = getContext().Target.getStringSymbolPrefix(IsConstant);
1373 
1374   // Don't share any string literals if strings aren't constant.
1375   if (!IsConstant)
1376     return GenerateStringLiteral(str, false, *this, GlobalName);
1377 
1378   llvm::StringMapEntry<llvm::Constant *> &Entry =
1379   ConstantStringMap.GetOrCreateValue(&str[0], &str[str.length()]);
1380 
1381   if (Entry.getValue())
1382     return Entry.getValue();
1383 
1384   // Create a global variable for this.
1385   llvm::Constant *C = GenerateStringLiteral(str, true, *this, GlobalName);
1386   Entry.setValue(C);
1387   return C;
1388 }
1389 
1390 /// GetAddrOfConstantCString - Returns a pointer to a character
1391 /// array containing the literal and a terminating '\-'
1392 /// character. The result has pointer to array type.
1393 llvm::Constant *CodeGenModule::GetAddrOfConstantCString(const std::string &str,
1394                                                         const char *GlobalName){
1395   return GetAddrOfConstantString(str + '\0', GlobalName);
1396 }
1397 
1398 /// EmitObjCPropertyImplementations - Emit information for synthesized
1399 /// properties for an implementation.
1400 void CodeGenModule::EmitObjCPropertyImplementations(const
1401                                                     ObjCImplementationDecl *D) {
1402   for (ObjCImplementationDecl::propimpl_iterator
1403          i = D->propimpl_begin(getContext()),
1404          e = D->propimpl_end(getContext()); i != e; ++i) {
1405     ObjCPropertyImplDecl *PID = *i;
1406 
1407     // Dynamic is just for type-checking.
1408     if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
1409       ObjCPropertyDecl *PD = PID->getPropertyDecl();
1410 
1411       // Determine which methods need to be implemented, some may have
1412       // been overridden. Note that ::isSynthesized is not the method
1413       // we want, that just indicates if the decl came from a
1414       // property. What we want to know is if the method is defined in
1415       // this implementation.
1416       if (!D->getInstanceMethod(getContext(), PD->getGetterName()))
1417         CodeGenFunction(*this).GenerateObjCGetter(
1418                                  const_cast<ObjCImplementationDecl *>(D), PID);
1419       if (!PD->isReadOnly() &&
1420           !D->getInstanceMethod(getContext(), PD->getSetterName()))
1421         CodeGenFunction(*this).GenerateObjCSetter(
1422                                  const_cast<ObjCImplementationDecl *>(D), PID);
1423     }
1424   }
1425 }
1426 
1427 /// EmitNamespace - Emit all declarations in a namespace.
1428 void CodeGenModule::EmitNamespace(const NamespaceDecl *ND) {
1429   for (RecordDecl::decl_iterator I = ND->decls_begin(getContext()),
1430          E = ND->decls_end(getContext());
1431        I != E; ++I)
1432     EmitTopLevelDecl(*I);
1433 }
1434 
1435 // EmitLinkageSpec - Emit all declarations in a linkage spec.
1436 void CodeGenModule::EmitLinkageSpec(const LinkageSpecDecl *LSD) {
1437   if (LSD->getLanguage() != LinkageSpecDecl::lang_c) {
1438     ErrorUnsupported(LSD, "linkage spec");
1439     return;
1440   }
1441 
1442   for (RecordDecl::decl_iterator I = LSD->decls_begin(getContext()),
1443          E = LSD->decls_end(getContext());
1444        I != E; ++I)
1445     EmitTopLevelDecl(*I);
1446 }
1447 
1448 /// EmitTopLevelDecl - Emit code for a single top level declaration.
1449 void CodeGenModule::EmitTopLevelDecl(Decl *D) {
1450   // If an error has occurred, stop code generation, but continue
1451   // parsing and semantic analysis (to ensure all warnings and errors
1452   // are emitted).
1453   if (Diags.hasErrorOccurred())
1454     return;
1455 
1456   switch (D->getKind()) {
1457   case Decl::CXXMethod:
1458   case Decl::Function:
1459   case Decl::Var:
1460     EmitGlobal(GlobalDecl(cast<ValueDecl>(D)));
1461     break;
1462 
1463   // C++ Decls
1464   case Decl::Namespace:
1465     EmitNamespace(cast<NamespaceDecl>(D));
1466     break;
1467   case Decl::CXXConstructor:
1468     EmitCXXConstructors(cast<CXXConstructorDecl>(D));
1469     break;
1470   case Decl::CXXDestructor:
1471     EmitCXXDestructors(cast<CXXDestructorDecl>(D));
1472     break;
1473 
1474   // Objective-C Decls
1475 
1476   // Forward declarations, no (immediate) code generation.
1477   case Decl::ObjCClass:
1478   case Decl::ObjCForwardProtocol:
1479   case Decl::ObjCCategory:
1480   case Decl::ObjCInterface:
1481     break;
1482 
1483   case Decl::ObjCProtocol:
1484     Runtime->GenerateProtocol(cast<ObjCProtocolDecl>(D));
1485     break;
1486 
1487   case Decl::ObjCCategoryImpl:
1488     // Categories have properties but don't support synthesize so we
1489     // can ignore them here.
1490     Runtime->GenerateCategory(cast<ObjCCategoryImplDecl>(D));
1491     break;
1492 
1493   case Decl::ObjCImplementation: {
1494     ObjCImplementationDecl *OMD = cast<ObjCImplementationDecl>(D);
1495     EmitObjCPropertyImplementations(OMD);
1496     Runtime->GenerateClass(OMD);
1497     break;
1498   }
1499   case Decl::ObjCMethod: {
1500     ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(D);
1501     // If this is not a prototype, emit the body.
1502     if (OMD->getBody(getContext()))
1503       CodeGenFunction(*this).GenerateObjCMethod(OMD);
1504     break;
1505   }
1506   case Decl::ObjCCompatibleAlias:
1507     // compatibility-alias is a directive and has no code gen.
1508     break;
1509 
1510   case Decl::LinkageSpec:
1511     EmitLinkageSpec(cast<LinkageSpecDecl>(D));
1512     break;
1513 
1514   case Decl::FileScopeAsm: {
1515     FileScopeAsmDecl *AD = cast<FileScopeAsmDecl>(D);
1516     std::string AsmString(AD->getAsmString()->getStrData(),
1517                           AD->getAsmString()->getByteLength());
1518 
1519     const std::string &S = getModule().getModuleInlineAsm();
1520     if (S.empty())
1521       getModule().setModuleInlineAsm(AsmString);
1522     else
1523       getModule().setModuleInlineAsm(S + '\n' + AsmString);
1524     break;
1525   }
1526 
1527   default:
1528     // Make sure we handled everything we should, every other kind is
1529     // a non-top-level decl.  FIXME: Would be nice to have an
1530     // isTopLevelDeclKind function. Need to recode Decl::Kind to do
1531     // that easily.
1532     assert(isa<TypeDecl>(D) && "Unsupported decl kind");
1533   }
1534 }
1535