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