xref: /llvm-project/clang/lib/CodeGen/CodeGenModule.cpp (revision 4663a3368d5f562e788573bef6e3a78c46e8d1de)
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 "CGDebugInfo.h"
15 #include "CodeGenModule.h"
16 #include "CodeGenFunction.h"
17 #include "CGCall.h"
18 #include "CGObjCRuntime.h"
19 #include "Mangle.h"
20 #include "clang/AST/ASTContext.h"
21 #include "clang/AST/DeclObjC.h"
22 #include "clang/AST/DeclCXX.h"
23 #include "clang/Basic/Diagnostic.h"
24 #include "clang/Basic/SourceManager.h"
25 #include "clang/Basic/TargetInfo.h"
26 #include "llvm/CallingConv.h"
27 #include "llvm/Module.h"
28 #include "llvm/Intrinsics.h"
29 #include "llvm/Target/TargetData.h"
30 using namespace clang;
31 using namespace CodeGen;
32 
33 
34 CodeGenModule::CodeGenModule(ASTContext &C, const LangOptions &LO,
35                              llvm::Module &M, const llvm::TargetData &TD,
36                              Diagnostic &diags, bool GenerateDebugInfo)
37   : BlockModule(C, M, TD, Types, *this), Context(C), Features(LO), TheModule(M),
38     TheTargetData(TD), Diags(diags), Types(C, M, TD), Runtime(0),
39     MemCpyFn(0), MemMoveFn(0), MemSetFn(0), CFConstantStringClassRef(0) {
40 
41   if (Features.ObjC1) {
42     if (Features.NeXTRuntime) {
43       Runtime = Features.ObjCNonFragileABI ? CreateMacNonFragileABIObjCRuntime(*this)
44                                        : CreateMacObjCRuntime(*this);
45     } else {
46       Runtime = CreateGNUObjCRuntime(*this);
47     }
48   }
49 
50   // If debug info generation is enabled, create the CGDebugInfo object.
51   DebugInfo = GenerateDebugInfo ? new CGDebugInfo(this) : 0;
52 }
53 
54 CodeGenModule::~CodeGenModule() {
55   delete Runtime;
56   delete DebugInfo;
57 }
58 
59 void CodeGenModule::Release() {
60   EmitDeferred();
61   EmitAliases();
62   if (Runtime)
63     if (llvm::Function *ObjCInitFunction = Runtime->ModuleInitFunction())
64       AddGlobalCtor(ObjCInitFunction);
65   EmitCtorList(GlobalCtors, "llvm.global_ctors");
66   EmitCtorList(GlobalDtors, "llvm.global_dtors");
67   EmitAnnotations();
68   EmitLLVMUsed();
69   BindRuntimeGlobals();
70 }
71 
72 void CodeGenModule::BindRuntimeGlobals() {
73   // Deal with protecting runtime function names.
74   for (unsigned i = 0, e = RuntimeGlobals.size(); i < e; ++i) {
75     llvm::GlobalValue *GV = RuntimeGlobals[i].first;
76     const std::string &Name = RuntimeGlobals[i].second;
77 
78     // Discard unused runtime declarations.
79     if (GV->isDeclaration() && GV->use_empty()) {
80       GV->eraseFromParent();
81       continue;
82     }
83 
84     // See if there is a conflict against a function.
85     llvm::GlobalValue *Conflict = TheModule.getNamedValue(Name);
86     if (Conflict) {
87       // Decide which version to take. If the conflict is a definition
88       // we are forced to take that, otherwise assume the runtime
89       // knows best.
90 
91       // FIXME: This will fail phenomenally when the conflict is the
92       // wrong type of value. Just bail on it for now. This should
93       // really reuse something inside the LLVM Linker code.
94       assert(GV->getValueID() == Conflict->getValueID() &&
95              "Unable to resolve conflict between globals of different types.");
96       if (!Conflict->isDeclaration()) {
97         llvm::Value *Casted =
98           llvm::ConstantExpr::getBitCast(Conflict, GV->getType());
99         GV->replaceAllUsesWith(Casted);
100         GV->eraseFromParent();
101       } else {
102         GV->takeName(Conflict);
103         llvm::Value *Casted =
104           llvm::ConstantExpr::getBitCast(GV, Conflict->getType());
105         Conflict->replaceAllUsesWith(Casted);
106         Conflict->eraseFromParent();
107       }
108     } else
109       GV->setName(Name);
110   }
111 }
112 
113 /// ErrorUnsupported - Print out an error that codegen doesn't support the
114 /// specified stmt yet.
115 void CodeGenModule::ErrorUnsupported(const Stmt *S, const char *Type,
116                                      bool OmitOnError) {
117   if (OmitOnError && getDiags().hasErrorOccurred())
118     return;
119   unsigned DiagID = getDiags().getCustomDiagID(Diagnostic::Error,
120                                                "cannot compile this %0 yet");
121   std::string Msg = Type;
122   getDiags().Report(Context.getFullLoc(S->getLocStart()), DiagID)
123     << Msg << S->getSourceRange();
124 }
125 
126 /// ErrorUnsupported - Print out an error that codegen doesn't support the
127 /// specified decl yet.
128 void CodeGenModule::ErrorUnsupported(const Decl *D, const char *Type,
129                                      bool OmitOnError) {
130   if (OmitOnError && getDiags().hasErrorOccurred())
131     return;
132   unsigned DiagID = getDiags().getCustomDiagID(Diagnostic::Error,
133                                                "cannot compile this %0 yet");
134   std::string Msg = Type;
135   getDiags().Report(Context.getFullLoc(D->getLocation()), DiagID) << Msg;
136 }
137 
138 /// setGlobalVisibility - Set the visibility for the given LLVM
139 /// GlobalValue according to the given clang AST visibility value.
140 static void setGlobalVisibility(llvm::GlobalValue *GV,
141                                 VisibilityAttr::VisibilityTypes Vis) {
142   switch (Vis) {
143   default: assert(0 && "Unknown visibility!");
144   case VisibilityAttr::DefaultVisibility:
145     GV->setVisibility(llvm::GlobalValue::DefaultVisibility);
146     break;
147   case VisibilityAttr::HiddenVisibility:
148     GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
149     break;
150   case VisibilityAttr::ProtectedVisibility:
151     GV->setVisibility(llvm::GlobalValue::ProtectedVisibility);
152     break;
153   }
154 }
155 
156 /// \brief Retrieves the mangled name for the given declaration.
157 ///
158 /// If the given declaration requires a mangled name, returns an
159 /// IdentifierInfo* containing the mangled name. Otherwise, returns
160 /// the name of the declaration as an identifier.
161 ///
162 /// FIXME: Returning an IdentifierInfo* here is a total hack. We
163 /// really need some kind of string abstraction that either stores a
164 /// mangled name or stores an IdentifierInfo*. This will require
165 /// changes to the GlobalDeclMap, too. (I disagree, I think what we
166 /// actually need is for Sema to provide some notion of which Decls
167 /// refer to the same semantic decl. We shouldn't need to mangle the
168 /// names and see what comes out the same to figure this out. - DWD)
169 ///
170 /// FIXME: Performance here is going to be terribly until we start
171 /// caching mangled names. However, we should fix the problem above
172 /// first.
173 const char *CodeGenModule::getMangledName(const NamedDecl *ND) {
174   llvm::SmallString<256> Name;
175   llvm::raw_svector_ostream Out(Name);
176   if (!mangleName(ND, Context, Out)) {
177     assert(ND->getIdentifier() && "Attempt to mangle unnamed decl.");
178     return ND->getIdentifier()->getName();
179   }
180 
181   Name += '\0';
182   return MangledNames.GetOrCreateValue(Name.begin(), Name.end())
183            .getKeyData();
184 }
185 
186 /// AddGlobalCtor - Add a function to the list that will be called before
187 /// main() runs.
188 void CodeGenModule::AddGlobalCtor(llvm::Function * Ctor, int Priority) {
189   // FIXME: Type coercion of void()* types.
190   GlobalCtors.push_back(std::make_pair(Ctor, Priority));
191 }
192 
193 /// AddGlobalDtor - Add a function to the list that will be called
194 /// when the module is unloaded.
195 void CodeGenModule::AddGlobalDtor(llvm::Function * Dtor, int Priority) {
196   // FIXME: Type coercion of void()* types.
197   GlobalDtors.push_back(std::make_pair(Dtor, Priority));
198 }
199 
200 void CodeGenModule::EmitCtorList(const CtorList &Fns, const char *GlobalName) {
201   // Ctor function type is void()*.
202   llvm::FunctionType* CtorFTy =
203     llvm::FunctionType::get(llvm::Type::VoidTy,
204                             std::vector<const llvm::Type*>(),
205                             false);
206   llvm::Type *CtorPFTy = llvm::PointerType::getUnqual(CtorFTy);
207 
208   // Get the type of a ctor entry, { i32, void ()* }.
209   llvm::StructType* CtorStructTy =
210     llvm::StructType::get(llvm::Type::Int32Ty,
211                           llvm::PointerType::getUnqual(CtorFTy), NULL);
212 
213   // Construct the constructor and destructor arrays.
214   std::vector<llvm::Constant*> Ctors;
215   for (CtorList::const_iterator I = Fns.begin(), E = Fns.end(); I != E; ++I) {
216     std::vector<llvm::Constant*> S;
217     S.push_back(llvm::ConstantInt::get(llvm::Type::Int32Ty, I->second, false));
218     S.push_back(llvm::ConstantExpr::getBitCast(I->first, CtorPFTy));
219     Ctors.push_back(llvm::ConstantStruct::get(CtorStructTy, S));
220   }
221 
222   if (!Ctors.empty()) {
223     llvm::ArrayType *AT = llvm::ArrayType::get(CtorStructTy, Ctors.size());
224     new llvm::GlobalVariable(AT, false,
225                              llvm::GlobalValue::AppendingLinkage,
226                              llvm::ConstantArray::get(AT, Ctors),
227                              GlobalName,
228                              &TheModule);
229   }
230 }
231 
232 void CodeGenModule::EmitAnnotations() {
233   if (Annotations.empty())
234     return;
235 
236   // Create a new global variable for the ConstantStruct in the Module.
237   llvm::Constant *Array =
238   llvm::ConstantArray::get(llvm::ArrayType::get(Annotations[0]->getType(),
239                                                 Annotations.size()),
240                            Annotations);
241   llvm::GlobalValue *gv =
242   new llvm::GlobalVariable(Array->getType(), false,
243                            llvm::GlobalValue::AppendingLinkage, Array,
244                            "llvm.global.annotations", &TheModule);
245   gv->setSection("llvm.metadata");
246 }
247 
248 void CodeGenModule::SetGlobalValueAttributes(const Decl *D,
249                                              bool IsInternal,
250                                              bool IsInline,
251                                              llvm::GlobalValue *GV,
252                                              bool ForDefinition) {
253   // FIXME: Set up linkage and many other things.  Note, this is a simple
254   // approximation of what we really want.
255   if (!ForDefinition) {
256     // Only a few attributes are set on declarations.
257     if (D->getAttr<DLLImportAttr>()) {
258       // The dllimport attribute is overridden by a subsequent declaration as
259       // dllexport.
260       if (!D->getAttr<DLLExportAttr>()) {
261         // dllimport attribute can be applied only to function decls, not to
262         // definitions.
263         if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
264           if (!FD->getBody())
265             GV->setLinkage(llvm::Function::DLLImportLinkage);
266         } else
267           GV->setLinkage(llvm::Function::DLLImportLinkage);
268       }
269     } else if (D->getAttr<WeakAttr>() ||
270                D->getAttr<WeakImportAttr>()) {
271       // "extern_weak" is overloaded in LLVM; we probably should have
272       // separate linkage types for this.
273       GV->setLinkage(llvm::Function::ExternalWeakAnyLinkage);
274    }
275   } else {
276     if (IsInternal) {
277       GV->setLinkage(llvm::Function::InternalLinkage);
278     } else {
279       if (D->getAttr<DLLExportAttr>()) {
280         if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
281           // The dllexport attribute is ignored for undefined symbols.
282           if (FD->getBody())
283             GV->setLinkage(llvm::Function::DLLExportLinkage);
284         } else
285           GV->setLinkage(llvm::Function::DLLExportLinkage);
286       } else if (D->getAttr<WeakAttr>() || D->getAttr<WeakImportAttr>() ||
287                  IsInline)
288         GV->setLinkage(llvm::Function::WeakAnyLinkage);
289     }
290   }
291 
292   // FIXME: Figure out the relative priority of the attribute,
293   // -fvisibility, and private_extern.
294   if (const VisibilityAttr *attr = D->getAttr<VisibilityAttr>())
295     setGlobalVisibility(GV, attr->getVisibility());
296   // FIXME: else handle -fvisibility
297 
298   // Prefaced with special LLVM marker to indicate that the name
299   // should not be munged.
300   if (const AsmLabelAttr *ALA = D->getAttr<AsmLabelAttr>())
301     GV->setName("\01" + ALA->getLabel());
302 
303   if (const SectionAttr *SA = D->getAttr<SectionAttr>())
304     GV->setSection(SA->getName());
305 
306   // Only add to llvm.used when we see a definition, otherwise we
307   // might add multiple times or risk the value being replaced by a
308   // subsequent RAUW.
309   if (ForDefinition) {
310     if (D->getAttr<UsedAttr>())
311       AddUsedGlobal(GV);
312   }
313 }
314 
315 void CodeGenModule::SetFunctionAttributes(const Decl *D,
316                                           const CGFunctionInfo &Info,
317                                           llvm::Function *F) {
318   AttributeListType AttributeList;
319   ConstructAttributeList(Info, D, AttributeList);
320 
321   F->setAttributes(llvm::AttrListPtr::get(AttributeList.begin(),
322                                         AttributeList.size()));
323 
324   // Set the appropriate calling convention for the Function.
325   if (D->getAttr<FastCallAttr>())
326     F->setCallingConv(llvm::CallingConv::X86_FastCall);
327 
328   if (D->getAttr<StdCallAttr>())
329     F->setCallingConv(llvm::CallingConv::X86_StdCall);
330 }
331 
332 /// SetFunctionAttributesForDefinition - Set function attributes
333 /// specific to a function definition.
334 void CodeGenModule::SetFunctionAttributesForDefinition(const Decl *D,
335                                                        llvm::Function *F) {
336   if (isa<ObjCMethodDecl>(D)) {
337     SetGlobalValueAttributes(D, true, false, F, true);
338   } else {
339     const FunctionDecl *FD = cast<FunctionDecl>(D);
340     SetGlobalValueAttributes(FD, FD->getStorageClass() == FunctionDecl::Static,
341                              FD->isInline(), F, true);
342   }
343 
344   if (!Features.Exceptions && !Features.ObjCNonFragileABI)
345     F->addFnAttr(llvm::Attribute::NoUnwind);
346 
347   if (D->getAttr<AlwaysInlineAttr>())
348     F->addFnAttr(llvm::Attribute::AlwaysInline);
349 
350   if (D->getAttr<NoinlineAttr>())
351     F->addFnAttr(llvm::Attribute::NoInline);
352 }
353 
354 void CodeGenModule::SetMethodAttributes(const ObjCMethodDecl *MD,
355                                         llvm::Function *F) {
356   SetFunctionAttributes(MD, getTypes().getFunctionInfo(MD), F);
357 
358   SetFunctionAttributesForDefinition(MD, F);
359 }
360 
361 void CodeGenModule::SetFunctionAttributes(const FunctionDecl *FD,
362                                           llvm::Function *F) {
363   SetFunctionAttributes(FD, getTypes().getFunctionInfo(FD), F);
364 
365   SetGlobalValueAttributes(FD, FD->getStorageClass() == FunctionDecl::Static,
366                            FD->isInline(), F, false);
367 }
368 
369 
370 void CodeGenModule::EmitAliases() {
371   for (unsigned i = 0, e = Aliases.size(); i != e; ++i) {
372     const FunctionDecl *D = Aliases[i];
373     const AliasAttr *AA = D->getAttr<AliasAttr>();
374 
375     // This is something of a hack, if the FunctionDecl got overridden
376     // then its attributes will be moved to the new declaration. In
377     // this case the current decl has no alias attribute, but we will
378     // eventually see it.
379     if (!AA)
380       continue;
381 
382     const std::string& aliaseeName = AA->getAliasee();
383     llvm::Function *aliasee = getModule().getFunction(aliaseeName);
384     if (!aliasee) {
385       // FIXME: This isn't unsupported, this is just an error, which
386       // sema should catch, but...
387       ErrorUnsupported(D, "alias referencing a missing function");
388       continue;
389     }
390 
391     llvm::GlobalValue *GA =
392       new llvm::GlobalAlias(aliasee->getType(),
393                             llvm::Function::ExternalLinkage,
394                             getMangledName(D), aliasee,
395                             &getModule());
396 
397     llvm::GlobalValue *&Entry = GlobalDeclMap[getMangledName(D)];
398     if (Entry) {
399       // If we created a dummy function for this then replace it.
400       GA->takeName(Entry);
401 
402       llvm::Value *Casted =
403         llvm::ConstantExpr::getBitCast(GA, Entry->getType());
404       Entry->replaceAllUsesWith(Casted);
405       Entry->eraseFromParent();
406 
407       Entry = GA;
408     }
409 
410     // Alias should never be internal or inline.
411     SetGlobalValueAttributes(D, false, false, GA, true);
412   }
413 }
414 
415 void CodeGenModule::AddUsedGlobal(llvm::GlobalValue *GV) {
416   assert(!GV->isDeclaration() &&
417          "Only globals with definition can force usage.");
418   llvm::Type *i8PTy = llvm::PointerType::getUnqual(llvm::Type::Int8Ty);
419   LLVMUsed.push_back(llvm::ConstantExpr::getBitCast(GV, i8PTy));
420 }
421 
422 void CodeGenModule::EmitLLVMUsed() {
423   // Don't create llvm.used if there is no need.
424   if (LLVMUsed.empty())
425     return;
426 
427   llvm::ArrayType *ATy = llvm::ArrayType::get(LLVMUsed[0]->getType(),
428                                               LLVMUsed.size());
429   llvm::GlobalVariable *GV =
430     new llvm::GlobalVariable(ATy, false,
431                              llvm::GlobalValue::AppendingLinkage,
432                              llvm::ConstantArray::get(ATy, LLVMUsed),
433                              "llvm.used", &getModule());
434 
435   GV->setSection("llvm.metadata");
436 }
437 
438 void CodeGenModule::EmitDeferred() {
439   // Emit code for any deferred decl which was used.  Since a
440   // previously unused static decl may become used during the
441   // generation of code for a static function, iterate until no
442   // changes are made.
443   bool Changed;
444   do {
445     Changed = false;
446 
447     for (std::list<const ValueDecl*>::iterator i = DeferredDecls.begin(),
448          e = DeferredDecls.end(); i != e; ) {
449       const ValueDecl *D = *i;
450 
451       // Check if we have used a decl with the same name
452       // FIXME: The AST should have some sort of aggregate decls or
453       // global symbol map.
454       // FIXME: This is missing some important cases. For example, we
455       // need to check for uses in an alias.
456       if (!GlobalDeclMap.count(getMangledName(D))) {
457         ++i;
458         continue;
459       }
460 
461       // Emit the definition.
462       EmitGlobalDefinition(D);
463 
464       // Erase the used decl from the list.
465       i = DeferredDecls.erase(i);
466 
467       // Remember that we made a change.
468       Changed = true;
469     }
470   } while (Changed);
471 }
472 
473 /// EmitAnnotateAttr - Generate the llvm::ConstantStruct which contains the
474 /// annotation information for a given GlobalValue.  The annotation struct is
475 /// {i8 *, i8 *, i8 *, i32}.  The first field is a constant expression, the
476 /// GlobalValue being annotated.  The second field is the constant string
477 /// created from the AnnotateAttr's annotation.  The third field is a constant
478 /// string containing the name of the translation unit.  The fourth field is
479 /// the line number in the file of the annotated value declaration.
480 ///
481 /// FIXME: this does not unique the annotation string constants, as llvm-gcc
482 ///        appears to.
483 ///
484 llvm::Constant *CodeGenModule::EmitAnnotateAttr(llvm::GlobalValue *GV,
485                                                 const AnnotateAttr *AA,
486                                                 unsigned LineNo) {
487   llvm::Module *M = &getModule();
488 
489   // get [N x i8] constants for the annotation string, and the filename string
490   // which are the 2nd and 3rd elements of the global annotation structure.
491   const llvm::Type *SBP = llvm::PointerType::getUnqual(llvm::Type::Int8Ty);
492   llvm::Constant *anno = llvm::ConstantArray::get(AA->getAnnotation(), true);
493   llvm::Constant *unit = llvm::ConstantArray::get(M->getModuleIdentifier(),
494                                                   true);
495 
496   // Get the two global values corresponding to the ConstantArrays we just
497   // created to hold the bytes of the strings.
498   llvm::GlobalValue *annoGV =
499   new llvm::GlobalVariable(anno->getType(), false,
500                            llvm::GlobalValue::InternalLinkage, anno,
501                            GV->getName() + ".str", M);
502   // translation unit name string, emitted into the llvm.metadata section.
503   llvm::GlobalValue *unitGV =
504   new llvm::GlobalVariable(unit->getType(), false,
505                            llvm::GlobalValue::InternalLinkage, unit, ".str", M);
506 
507   // Create the ConstantStruct that is the global annotion.
508   llvm::Constant *Fields[4] = {
509     llvm::ConstantExpr::getBitCast(GV, SBP),
510     llvm::ConstantExpr::getBitCast(annoGV, SBP),
511     llvm::ConstantExpr::getBitCast(unitGV, SBP),
512     llvm::ConstantInt::get(llvm::Type::Int32Ty, LineNo)
513   };
514   return llvm::ConstantStruct::get(Fields, 4, false);
515 }
516 
517 bool CodeGenModule::MayDeferGeneration(const ValueDecl *Global) {
518   // Never defer when EmitAllDecls is specified or the decl has
519   // attribute used.
520   if (Features.EmitAllDecls || Global->getAttr<UsedAttr>())
521     return false;
522 
523   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(Global)) {
524     // Constructors and destructors should never be deferred.
525     if (FD->getAttr<ConstructorAttr>() || FD->getAttr<DestructorAttr>())
526       return false;
527 
528     if (FD->getStorageClass() != FunctionDecl::Static)
529       return false;
530   } else {
531     const VarDecl *VD = cast<VarDecl>(Global);
532     assert(VD->isFileVarDecl() && "Invalid decl.");
533 
534     if (VD->getStorageClass() != VarDecl::Static)
535       return false;
536   }
537 
538   return true;
539 }
540 
541 void CodeGenModule::EmitGlobal(const ValueDecl *Global) {
542   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(Global)) {
543     // Aliases are deferred until code for everything else has been
544     // emitted.
545     if (FD->getAttr<AliasAttr>()) {
546       assert(!FD->isThisDeclarationADefinition() &&
547              "Function alias cannot have a definition!");
548       Aliases.push_back(FD);
549       return;
550     }
551 
552     // Forward declarations are emitted lazily on first use.
553     if (!FD->isThisDeclarationADefinition())
554       return;
555   } else {
556     const VarDecl *VD = cast<VarDecl>(Global);
557     assert(VD->isFileVarDecl() && "Cannot emit local var decl as global.");
558 
559     // Forward declarations are emitted lazily on first use.
560     if (!VD->getInit() && VD->hasExternalStorage())
561       return;
562   }
563 
564   // Defer code generation when possible.
565   if (MayDeferGeneration(Global)) {
566     DeferredDecls.push_back(Global);
567     return;
568   }
569 
570   // Otherwise emit the definition.
571   EmitGlobalDefinition(Global);
572 }
573 
574 void CodeGenModule::EmitGlobalDefinition(const ValueDecl *D) {
575   if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
576     EmitGlobalFunctionDefinition(FD);
577   } else if (const VarDecl *VD = dyn_cast<VarDecl>(D)) {
578     EmitGlobalVarDefinition(VD);
579   } else {
580     assert(0 && "Invalid argument to EmitGlobalDefinition()");
581   }
582 }
583 
584  llvm::Constant *CodeGenModule::GetAddrOfGlobalVar(const VarDecl *D) {
585   assert(D->hasGlobalStorage() && "Not a global variable");
586 
587   QualType ASTTy = D->getType();
588   const llvm::Type *Ty = getTypes().ConvertTypeForMem(ASTTy);
589   const llvm::Type *PTy = llvm::PointerType::get(Ty, ASTTy.getAddressSpace());
590 
591   // Lookup the entry, lazily creating it if necessary.
592   llvm::GlobalValue *&Entry = GlobalDeclMap[getMangledName(D)];
593   if (!Entry) {
594     llvm::GlobalVariable *GV =
595       new llvm::GlobalVariable(Ty, false,
596                                llvm::GlobalValue::ExternalLinkage,
597                                0, getMangledName(D), &getModule(),
598                                0, ASTTy.getAddressSpace());
599     Entry = GV;
600 
601     // Handle things which are present even on external declarations.
602 
603     // FIXME: This code is overly simple and should be merged with
604     // other global handling.
605 
606     GV->setConstant(D->getType().isConstant(Context));
607 
608     // FIXME: Merge with other attribute handling code.
609 
610     if (D->getStorageClass() == VarDecl::PrivateExtern)
611       setGlobalVisibility(GV, VisibilityAttr::HiddenVisibility);
612 
613     if (D->getAttr<WeakAttr>() || D->getAttr<WeakImportAttr>())
614       GV->setLinkage(llvm::GlobalValue::ExternalWeakAnyLinkage);
615 
616     if (const AsmLabelAttr *ALA = D->getAttr<AsmLabelAttr>()) {
617       // Prefaced with special LLVM marker to indicate that the name
618       // should not be munged.
619       GV->setName("\01" + ALA->getLabel());
620     }
621   }
622 
623   // Make sure the result is of the correct type.
624   return llvm::ConstantExpr::getBitCast(Entry, PTy);
625 }
626 
627 void CodeGenModule::EmitGlobalVarDefinition(const VarDecl *D) {
628   llvm::Constant *Init = 0;
629   QualType ASTTy = D->getType();
630   const llvm::Type *VarTy = getTypes().ConvertTypeForMem(ASTTy);
631 
632   if (D->getInit() == 0) {
633     // This is a tentative definition; tentative definitions are
634     // implicitly initialized with { 0 }
635     const llvm::Type* InitTy;
636     if (ASTTy->isIncompleteArrayType()) {
637       // An incomplete array is normally [ TYPE x 0 ], but we need
638       // to fix it to [ TYPE x 1 ].
639       const llvm::ArrayType* ATy = cast<llvm::ArrayType>(VarTy);
640       InitTy = llvm::ArrayType::get(ATy->getElementType(), 1);
641     } else {
642       InitTy = VarTy;
643     }
644     Init = llvm::Constant::getNullValue(InitTy);
645   } else {
646     Init = EmitConstantExpr(D->getInit());
647     if (!Init) {
648       ErrorUnsupported(D, "static initializer");
649       QualType T = D->getInit()->getType();
650       Init = llvm::UndefValue::get(getTypes().ConvertType(T));
651     }
652   }
653   const llvm::Type* InitType = Init->getType();
654 
655   llvm::GlobalValue *&Entry = GlobalDeclMap[getMangledName(D)];
656   llvm::GlobalVariable *GV = cast_or_null<llvm::GlobalVariable>(Entry);
657 
658   if (!GV) {
659     GV = new llvm::GlobalVariable(InitType, false,
660                                   llvm::GlobalValue::ExternalLinkage,
661                                   0, getMangledName(D),
662                                   &getModule(), 0, ASTTy.getAddressSpace());
663 
664   } else if (GV->hasInitializer() && !GV->getInitializer()->isNullValue()) {
665     // If we already have this global and it has an initializer, then
666     // we are in the rare situation where we emitted the defining
667     // declaration of the global and are now being asked to emit a
668     // definition which would be common. This occurs, for example, in
669     // the following situation because statics can be emitted out of
670     // order:
671     //
672     //  static int x;
673     //  static int *y = &x;
674     //  static int x = 10;
675     //  int **z = &y;
676     //
677     // Bail here so we don't blow away the definition. Note that if we
678     // can't distinguish here if we emitted a definition with a null
679     // initializer, but this case is safe.
680     assert(!D->getInit() && "Emitting multiple definitions of a decl!");
681     return;
682 
683   } else if (GV->getType() !=
684              llvm::PointerType::get(InitType, ASTTy.getAddressSpace())) {
685     // We have a definition after a prototype with the wrong type.
686     // We must make a new GlobalVariable* and update everything that used OldGV
687     // (a declaration or tentative definition) with the new GlobalVariable*
688     // (which will be a definition).
689     //
690     // This happens if there is a prototype for a global (e.g. "extern int x[];")
691     // and then a definition of a different type (e.g. "int x[10];"). This also
692     // happens when an initializer has a different type from the type of the
693     // global (this happens with unions).
694     //
695     // FIXME: This also ends up happening if there's a definition followed by
696     // a tentative definition!  (Although Sema rejects that construct
697     // at the moment.)
698 
699     // Save the old global
700     llvm::GlobalVariable *OldGV = GV;
701 
702     // Make a new global with the correct type
703     GV = new llvm::GlobalVariable(InitType, false,
704                                   llvm::GlobalValue::ExternalLinkage,
705                                   0, getMangledName(D),
706                                   &getModule(), 0, ASTTy.getAddressSpace());
707     // Steal the name of the old global
708     GV->takeName(OldGV);
709 
710     // Replace all uses of the old global with the new global
711     llvm::Constant *NewPtrForOldDecl =
712         llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
713     OldGV->replaceAllUsesWith(NewPtrForOldDecl);
714 
715     // Erase the old global, since it is no longer used.
716     OldGV->eraseFromParent();
717   }
718 
719   Entry = GV;
720 
721   if (const AnnotateAttr *AA = D->getAttr<AnnotateAttr>()) {
722     SourceManager &SM = Context.getSourceManager();
723     AddAnnotation(EmitAnnotateAttr(GV, AA,
724                               SM.getInstantiationLineNumber(D->getLocation())));
725   }
726 
727   GV->setInitializer(Init);
728   GV->setConstant(D->getType().isConstant(Context));
729   GV->setAlignment(getContext().getDeclAlignInBytes(D));
730 
731   if (const VisibilityAttr *attr = D->getAttr<VisibilityAttr>())
732     setGlobalVisibility(GV, attr->getVisibility());
733   // FIXME: else handle -fvisibility
734 
735   if (const AsmLabelAttr *ALA = D->getAttr<AsmLabelAttr>()) {
736     // Prefaced with special LLVM marker to indicate that the name
737     // should not be munged.
738     GV->setName("\01" + ALA->getLabel());
739   }
740 
741   // Set the llvm linkage type as appropriate.
742   if (D->getStorageClass() == VarDecl::Static)
743     GV->setLinkage(llvm::Function::InternalLinkage);
744   else if (D->getAttr<DLLImportAttr>())
745     GV->setLinkage(llvm::Function::DLLImportLinkage);
746   else if (D->getAttr<DLLExportAttr>())
747     GV->setLinkage(llvm::Function::DLLExportLinkage);
748   else if (D->getAttr<WeakAttr>() || D->getAttr<WeakImportAttr>())
749     GV->setLinkage(llvm::GlobalVariable::WeakAnyLinkage);
750   else {
751     // FIXME: This isn't right.  This should handle common linkage and other
752     // stuff.
753     switch (D->getStorageClass()) {
754     case VarDecl::Static: assert(0 && "This case handled above");
755     case VarDecl::Auto:
756     case VarDecl::Register:
757       assert(0 && "Can't have auto or register globals");
758     case VarDecl::None:
759       if (!D->getInit())
760         GV->setLinkage(llvm::GlobalVariable::CommonAnyLinkage);
761       else
762         GV->setLinkage(llvm::GlobalVariable::ExternalLinkage);
763       break;
764     case VarDecl::Extern:
765       // FIXME: common
766       break;
767 
768     case VarDecl::PrivateExtern:
769       GV->setVisibility(llvm::GlobalValue::HiddenVisibility);
770       // FIXME: common
771       break;
772     }
773   }
774 
775   if (const SectionAttr *SA = D->getAttr<SectionAttr>())
776     GV->setSection(SA->getName());
777 
778   if (D->getAttr<UsedAttr>())
779     AddUsedGlobal(GV);
780 
781   // Emit global variable debug information.
782   CGDebugInfo *DI = getDebugInfo();
783   if(DI) {
784     DI->setLocation(D->getLocation());
785     DI->EmitGlobalVariable(GV, D);
786   }
787 }
788 
789 llvm::GlobalValue *
790 CodeGenModule::EmitForwardFunctionDefinition(const FunctionDecl *D,
791                                              const llvm::Type *Ty) {
792   bool DoSetAttributes = true;
793   if (!Ty) {
794     Ty = getTypes().ConvertType(D->getType());
795     if (!isa<llvm::FunctionType>(Ty)) {
796       // This function doesn't have a complete type (for example, the return
797       // type is an incomplete struct). Use a fake type instead, and make
798       // sure not to try to set attributes.
799       Ty = llvm::FunctionType::get(llvm::Type::VoidTy,
800                                    std::vector<const llvm::Type*>(), false);
801       DoSetAttributes = false;
802     }
803   }
804   llvm::Function *F = llvm::Function::Create(cast<llvm::FunctionType>(Ty),
805                                              llvm::Function::ExternalLinkage,
806                                              getMangledName(D),
807                                              &getModule());
808   if (DoSetAttributes)
809     SetFunctionAttributes(D, F);
810   return F;
811 }
812 
813 llvm::Constant *CodeGenModule::GetAddrOfFunction(const FunctionDecl *D) {
814   QualType ASTTy = D->getType();
815   const llvm::Type *Ty = getTypes().ConvertTypeForMem(ASTTy);
816   const llvm::Type *PTy = llvm::PointerType::get(Ty, ASTTy.getAddressSpace());
817 
818   // Lookup the entry, lazily creating it if necessary.
819   llvm::GlobalValue *&Entry = GlobalDeclMap[getMangledName(D)];
820   if (!Entry)
821     Entry = EmitForwardFunctionDefinition(D, 0);
822 
823   return llvm::ConstantExpr::getBitCast(Entry, PTy);
824 }
825 
826 void CodeGenModule::EmitGlobalFunctionDefinition(const FunctionDecl *D) {
827   const llvm::FunctionType *Ty =
828     cast<llvm::FunctionType>(getTypes().ConvertType(D->getType()));
829 
830   // As a special case, make sure that definitions of K&R function
831   // "type foo()" aren't declared as varargs (which forces the backend
832   // to do unnecessary work).
833   if (Ty->isVarArg() && Ty->getNumParams() == 0 && Ty->isVarArg())
834     Ty = llvm::FunctionType::get(Ty->getReturnType(),
835                                  std::vector<const llvm::Type*>(),
836                                  false);
837 
838   llvm::GlobalValue *&Entry = GlobalDeclMap[getMangledName(D)];
839   if (!Entry) {
840     Entry = EmitForwardFunctionDefinition(D, Ty);
841   } else {
842     // If the types mismatch then we have to rewrite the definition.
843     if (Entry->getType() != llvm::PointerType::getUnqual(Ty)) {
844       // Otherwise, we have a definition after a prototype with the
845       // wrong type.  F is the Function* for the one with the wrong
846       // type, we must make a new Function* and update everything that
847       // used F (a declaration) with the new Function* (which will be
848       // a definition).
849       //
850       // This happens if there is a prototype for a function
851       // (e.g. "int f()") and then a definition of a different type
852       // (e.g. "int f(int x)").  Start by making a new function of the
853       // correct type, RAUW, then steal the name.
854       llvm::GlobalValue *NewFn = EmitForwardFunctionDefinition(D, Ty);
855       NewFn->takeName(Entry);
856 
857       // Replace uses of F with the Function we will endow with a body.
858       llvm::Constant *NewPtrForOldDecl =
859         llvm::ConstantExpr::getBitCast(NewFn, Entry->getType());
860       Entry->replaceAllUsesWith(NewPtrForOldDecl);
861 
862       // Ok, delete the old function now, which is dead.
863       assert(Entry->isDeclaration() && "Shouldn't replace non-declaration");
864       Entry->eraseFromParent();
865 
866       Entry = NewFn;
867     }
868   }
869 
870   llvm::Function *Fn = cast<llvm::Function>(Entry);
871   CodeGenFunction(*this).GenerateCode(D, Fn);
872 
873   SetFunctionAttributesForDefinition(D, Fn);
874 
875   if (const ConstructorAttr *CA = D->getAttr<ConstructorAttr>()) {
876     AddGlobalCtor(Fn, CA->getPriority());
877   } else if (const DestructorAttr *DA = D->getAttr<DestructorAttr>()) {
878     AddGlobalDtor(Fn, DA->getPriority());
879   }
880 }
881 
882 llvm::Function *
883 CodeGenModule::CreateRuntimeFunction(const llvm::FunctionType *FTy,
884                                      const std::string &Name) {
885   llvm::Function *Fn = llvm::Function::Create(FTy,
886                                               llvm::Function::ExternalLinkage,
887                                               "", &TheModule);
888   RuntimeGlobals.push_back(std::make_pair(Fn, Name));
889   return Fn;
890 }
891 
892 llvm::GlobalVariable *
893 CodeGenModule::CreateRuntimeVariable(const llvm::Type *Ty,
894                                      const std::string &Name) {
895   llvm::GlobalVariable *GV =
896     new llvm::GlobalVariable(Ty, /*Constant=*/false,
897                              llvm::GlobalValue::ExternalLinkage,
898                              0, "", &TheModule);
899   RuntimeGlobals.push_back(std::make_pair(GV, Name));
900   return GV;
901 }
902 
903 void CodeGenModule::UpdateCompletedType(const TagDecl *TD) {
904   // Make sure that this type is translated.
905   Types.UpdateCompletedType(TD);
906 }
907 
908 
909 /// getBuiltinLibFunction
910 llvm::Value *CodeGenModule::getBuiltinLibFunction(unsigned BuiltinID) {
911   if (BuiltinID > BuiltinFunctions.size())
912     BuiltinFunctions.resize(BuiltinID);
913 
914   // Cache looked up functions.  Since builtin id #0 is invalid we don't reserve
915   // a slot for it.
916   assert(BuiltinID && "Invalid Builtin ID");
917   llvm::Value *&FunctionSlot = BuiltinFunctions[BuiltinID-1];
918   if (FunctionSlot)
919     return FunctionSlot;
920 
921   assert((Context.BuiltinInfo.isLibFunction(BuiltinID) ||
922           Context.BuiltinInfo.isPredefinedLibFunction(BuiltinID)) &&
923          "isn't a lib fn");
924 
925   // Get the name, skip over the __builtin_ prefix (if necessary).
926   const char *Name = Context.BuiltinInfo.GetName(BuiltinID);
927   if (Context.BuiltinInfo.isLibFunction(BuiltinID))
928     Name += 10;
929 
930   // Get the type for the builtin.
931   Builtin::Context::GetBuiltinTypeError Error;
932   QualType Type = Context.BuiltinInfo.GetBuiltinType(BuiltinID, Context, Error);
933   assert(Error == Builtin::Context::GE_None && "Can't get builtin type");
934 
935   const llvm::FunctionType *Ty =
936     cast<llvm::FunctionType>(getTypes().ConvertType(Type));
937 
938   // FIXME: This has a serious problem with code like this:
939   //  void abs() {}
940   //    ... __builtin_abs(x);
941   // The two versions of abs will collide.  The fix is for the builtin to win,
942   // and for the existing one to be turned into a constantexpr cast of the
943   // builtin.  In the case where the existing one is a static function, it
944   // should just be renamed.
945   if (llvm::Function *Existing = getModule().getFunction(Name)) {
946     if (Existing->getFunctionType() == Ty && Existing->hasExternalLinkage())
947       return FunctionSlot = Existing;
948     assert(Existing == 0 && "FIXME: Name collision");
949   }
950 
951   llvm::GlobalValue *&ExistingFn =
952     GlobalDeclMap[getContext().Idents.get(Name).getName()];
953   if (ExistingFn)
954     return FunctionSlot = llvm::ConstantExpr::getBitCast(ExistingFn, Ty);
955 
956   // FIXME: param attributes for sext/zext etc.
957   return FunctionSlot = ExistingFn =
958     llvm::Function::Create(Ty, llvm::Function::ExternalLinkage, Name,
959                            &getModule());
960 }
961 
962 llvm::Function *CodeGenModule::getIntrinsic(unsigned IID,const llvm::Type **Tys,
963                                             unsigned NumTys) {
964   return llvm::Intrinsic::getDeclaration(&getModule(),
965                                          (llvm::Intrinsic::ID)IID, Tys, NumTys);
966 }
967 
968 llvm::Function *CodeGenModule::getMemCpyFn() {
969   if (MemCpyFn) return MemCpyFn;
970   const llvm::Type *IntPtr = TheTargetData.getIntPtrType();
971   return MemCpyFn = getIntrinsic(llvm::Intrinsic::memcpy, &IntPtr, 1);
972 }
973 
974 llvm::Function *CodeGenModule::getMemMoveFn() {
975   if (MemMoveFn) return MemMoveFn;
976   const llvm::Type *IntPtr = TheTargetData.getIntPtrType();
977   return MemMoveFn = getIntrinsic(llvm::Intrinsic::memmove, &IntPtr, 1);
978 }
979 
980 llvm::Function *CodeGenModule::getMemSetFn() {
981   if (MemSetFn) return MemSetFn;
982   const llvm::Type *IntPtr = TheTargetData.getIntPtrType();
983   return MemSetFn = getIntrinsic(llvm::Intrinsic::memset, &IntPtr, 1);
984 }
985 
986 static void appendFieldAndPadding(CodeGenModule &CGM,
987                                   std::vector<llvm::Constant*>& Fields,
988                                   FieldDecl *FieldD, FieldDecl *NextFieldD,
989                                   llvm::Constant* Field,
990                                   RecordDecl* RD, const llvm::StructType *STy)
991 {
992   // Append the field.
993   Fields.push_back(Field);
994 
995   int StructFieldNo = CGM.getTypes().getLLVMFieldNo(FieldD);
996 
997   int NextStructFieldNo;
998   if (!NextFieldD) {
999     NextStructFieldNo = STy->getNumElements();
1000   } else {
1001     NextStructFieldNo = CGM.getTypes().getLLVMFieldNo(NextFieldD);
1002   }
1003 
1004   // Append padding
1005   for (int i = StructFieldNo + 1; i < NextStructFieldNo; i++) {
1006     llvm::Constant *C =
1007       llvm::Constant::getNullValue(STy->getElementType(StructFieldNo + 1));
1008 
1009     Fields.push_back(C);
1010   }
1011 }
1012 
1013 // We still need to work out the details of handling UTF-16.
1014 // See: <rdr://2996215>
1015 llvm::Constant *CodeGenModule::
1016 GetAddrOfConstantCFString(const std::string &str) {
1017   llvm::StringMapEntry<llvm::Constant *> &Entry =
1018     CFConstantStringMap.GetOrCreateValue(&str[0], &str[str.length()]);
1019 
1020   if (Entry.getValue())
1021     return Entry.getValue();
1022 
1023   llvm::Constant *Zero = llvm::Constant::getNullValue(llvm::Type::Int32Ty);
1024   llvm::Constant *Zeros[] = { Zero, Zero };
1025 
1026   if (!CFConstantStringClassRef) {
1027     const llvm::Type *Ty = getTypes().ConvertType(getContext().IntTy);
1028     Ty = llvm::ArrayType::get(Ty, 0);
1029 
1030     // FIXME: This is fairly broken if
1031     // __CFConstantStringClassReference is already defined, in that it
1032     // will get renamed and the user will most likely see an opaque
1033     // error message. This is a general issue with relying on
1034     // particular names.
1035     llvm::GlobalVariable *GV =
1036       new llvm::GlobalVariable(Ty, false,
1037                                llvm::GlobalVariable::ExternalLinkage, 0,
1038                                "__CFConstantStringClassReference",
1039                                &getModule());
1040 
1041     // Decay array -> ptr
1042     CFConstantStringClassRef =
1043       llvm::ConstantExpr::getGetElementPtr(GV, Zeros, 2);
1044   }
1045 
1046   QualType CFTy = getContext().getCFConstantStringType();
1047   RecordDecl *CFRD = CFTy->getAsRecordType()->getDecl();
1048 
1049   const llvm::StructType *STy =
1050     cast<llvm::StructType>(getTypes().ConvertType(CFTy));
1051 
1052   std::vector<llvm::Constant*> Fields;
1053   RecordDecl::field_iterator Field = CFRD->field_begin();
1054 
1055   // Class pointer.
1056   FieldDecl *CurField = *Field++;
1057   FieldDecl *NextField = *Field++;
1058   appendFieldAndPadding(*this, Fields, CurField, NextField,
1059                         CFConstantStringClassRef, CFRD, STy);
1060 
1061   // Flags.
1062   CurField = NextField;
1063   NextField = *Field++;
1064   const llvm::Type *Ty = getTypes().ConvertType(getContext().UnsignedIntTy);
1065   appendFieldAndPadding(*this, Fields, CurField, NextField,
1066                         llvm::ConstantInt::get(Ty, 0x07C8), CFRD, STy);
1067 
1068   // String pointer.
1069   CurField = NextField;
1070   NextField = *Field++;
1071   llvm::Constant *C = llvm::ConstantArray::get(str);
1072   C = new llvm::GlobalVariable(C->getType(), true,
1073                                llvm::GlobalValue::InternalLinkage,
1074                                C, ".str", &getModule());
1075   appendFieldAndPadding(*this, Fields, CurField, NextField,
1076                         llvm::ConstantExpr::getGetElementPtr(C, Zeros, 2),
1077                         CFRD, STy);
1078 
1079   // String length.
1080   CurField = NextField;
1081   NextField = 0;
1082   Ty = getTypes().ConvertType(getContext().LongTy);
1083   appendFieldAndPadding(*this, Fields, CurField, NextField,
1084                         llvm::ConstantInt::get(Ty, str.length()), CFRD, STy);
1085 
1086   // The struct.
1087   C = llvm::ConstantStruct::get(STy, Fields);
1088   llvm::GlobalVariable *GV =
1089     new llvm::GlobalVariable(C->getType(), true,
1090                              llvm::GlobalVariable::InternalLinkage,
1091                              C, "", &getModule());
1092 
1093   GV->setSection("__DATA,__cfstring");
1094   Entry.setValue(GV);
1095 
1096   return GV;
1097 }
1098 
1099 /// GetStringForStringLiteral - Return the appropriate bytes for a
1100 /// string literal, properly padded to match the literal type.
1101 std::string CodeGenModule::GetStringForStringLiteral(const StringLiteral *E) {
1102   const char *StrData = E->getStrData();
1103   unsigned Len = E->getByteLength();
1104 
1105   const ConstantArrayType *CAT =
1106     getContext().getAsConstantArrayType(E->getType());
1107   assert(CAT && "String isn't pointer or array!");
1108 
1109   // Resize the string to the right size.
1110   std::string Str(StrData, StrData+Len);
1111   uint64_t RealLen = CAT->getSize().getZExtValue();
1112 
1113   if (E->isWide())
1114     RealLen *= getContext().Target.getWCharWidth()/8;
1115 
1116   Str.resize(RealLen, '\0');
1117 
1118   return Str;
1119 }
1120 
1121 /// GetAddrOfConstantStringFromLiteral - Return a pointer to a
1122 /// constant array for the given string literal.
1123 llvm::Constant *
1124 CodeGenModule::GetAddrOfConstantStringFromLiteral(const StringLiteral *S) {
1125   // FIXME: This can be more efficient.
1126   return GetAddrOfConstantString(GetStringForStringLiteral(S));
1127 }
1128 
1129 /// GetAddrOfConstantStringFromObjCEncode - Return a pointer to a constant
1130 /// array for the given ObjCEncodeExpr node.
1131 llvm::Constant *
1132 CodeGenModule::GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *E) {
1133   std::string Str;
1134   getContext().getObjCEncodingForType(E->getEncodedType(), Str);
1135 
1136   return GetAddrOfConstantCString(Str);
1137 }
1138 
1139 
1140 /// GenerateWritableString -- Creates storage for a string literal.
1141 static llvm::Constant *GenerateStringLiteral(const std::string &str,
1142                                              bool constant,
1143                                              CodeGenModule &CGM,
1144                                              const char *GlobalName) {
1145   // Create Constant for this string literal. Don't add a '\0'.
1146   llvm::Constant *C = llvm::ConstantArray::get(str, false);
1147 
1148   // Create a global variable for this string
1149   return new llvm::GlobalVariable(C->getType(), constant,
1150                                   llvm::GlobalValue::InternalLinkage,
1151                                   C, GlobalName ? GlobalName : ".str",
1152                                   &CGM.getModule());
1153 }
1154 
1155 /// GetAddrOfConstantString - Returns a pointer to a character array
1156 /// containing the literal. This contents are exactly that of the
1157 /// given string, i.e. it will not be null terminated automatically;
1158 /// see GetAddrOfConstantCString. Note that whether the result is
1159 /// actually a pointer to an LLVM constant depends on
1160 /// Feature.WriteableStrings.
1161 ///
1162 /// The result has pointer to array type.
1163 llvm::Constant *CodeGenModule::GetAddrOfConstantString(const std::string &str,
1164                                                        const char *GlobalName) {
1165   // Don't share any string literals if writable-strings is turned on.
1166   if (Features.WritableStrings)
1167     return GenerateStringLiteral(str, false, *this, GlobalName);
1168 
1169   llvm::StringMapEntry<llvm::Constant *> &Entry =
1170   ConstantStringMap.GetOrCreateValue(&str[0], &str[str.length()]);
1171 
1172   if (Entry.getValue())
1173     return Entry.getValue();
1174 
1175   // Create a global variable for this.
1176   llvm::Constant *C = GenerateStringLiteral(str, true, *this, GlobalName);
1177   Entry.setValue(C);
1178   return C;
1179 }
1180 
1181 /// GetAddrOfConstantCString - Returns a pointer to a character
1182 /// array containing the literal and a terminating '\-'
1183 /// character. The result has pointer to array type.
1184 llvm::Constant *CodeGenModule::GetAddrOfConstantCString(const std::string &str,
1185                                                         const char *GlobalName){
1186   return GetAddrOfConstantString(str + '\0', GlobalName);
1187 }
1188 
1189 /// EmitObjCPropertyImplementations - Emit information for synthesized
1190 /// properties for an implementation.
1191 void CodeGenModule::EmitObjCPropertyImplementations(const
1192                                                     ObjCImplementationDecl *D) {
1193   for (ObjCImplementationDecl::propimpl_iterator i = D->propimpl_begin(),
1194          e = D->propimpl_end(); i != e; ++i) {
1195     ObjCPropertyImplDecl *PID = *i;
1196 
1197     // Dynamic is just for type-checking.
1198     if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Synthesize) {
1199       ObjCPropertyDecl *PD = PID->getPropertyDecl();
1200 
1201       // Determine which methods need to be implemented, some may have
1202       // been overridden. Note that ::isSynthesized is not the method
1203       // we want, that just indicates if the decl came from a
1204       // property. What we want to know is if the method is defined in
1205       // this implementation.
1206       if (!D->getInstanceMethod(PD->getGetterName()))
1207         CodeGenFunction(*this).GenerateObjCGetter(
1208                                  const_cast<ObjCImplementationDecl *>(D), PID);
1209       if (!PD->isReadOnly() &&
1210           !D->getInstanceMethod(PD->getSetterName()))
1211         CodeGenFunction(*this).GenerateObjCSetter(
1212                                  const_cast<ObjCImplementationDecl *>(D), PID);
1213     }
1214   }
1215 }
1216 
1217 /// EmitTopLevelDecl - Emit code for a single top level declaration.
1218 void CodeGenModule::EmitTopLevelDecl(Decl *D) {
1219   // If an error has occurred, stop code generation, but continue
1220   // parsing and semantic analysis (to ensure all warnings and errors
1221   // are emitted).
1222   if (Diags.hasErrorOccurred())
1223     return;
1224 
1225   switch (D->getKind()) {
1226   case Decl::Function:
1227   case Decl::Var:
1228     EmitGlobal(cast<ValueDecl>(D));
1229     break;
1230 
1231   case Decl::Namespace:
1232     ErrorUnsupported(D, "namespace");
1233     break;
1234 
1235     // Objective-C Decls
1236 
1237     // Forward declarations, no (immediate) code generation.
1238   case Decl::ObjCClass:
1239   case Decl::ObjCCategory:
1240   case Decl::ObjCForwardProtocol:
1241   case Decl::ObjCInterface:
1242     break;
1243 
1244   case Decl::ObjCProtocol:
1245     Runtime->GenerateProtocol(cast<ObjCProtocolDecl>(D));
1246     break;
1247 
1248   case Decl::ObjCCategoryImpl:
1249     // Categories have properties but don't support synthesize so we
1250     // can ignore them here.
1251 
1252     Runtime->GenerateCategory(cast<ObjCCategoryImplDecl>(D));
1253     break;
1254 
1255   case Decl::ObjCImplementation: {
1256     ObjCImplementationDecl *OMD = cast<ObjCImplementationDecl>(D);
1257     EmitObjCPropertyImplementations(OMD);
1258     Runtime->GenerateClass(OMD);
1259     break;
1260   }
1261   case Decl::ObjCMethod: {
1262     ObjCMethodDecl *OMD = cast<ObjCMethodDecl>(D);
1263     // If this is not a prototype, emit the body.
1264     if (OMD->getBody())
1265       CodeGenFunction(*this).GenerateObjCMethod(OMD);
1266     break;
1267   }
1268   case Decl::ObjCCompatibleAlias:
1269     // compatibility-alias is a directive and has no code gen.
1270     break;
1271 
1272   case Decl::LinkageSpec: {
1273     LinkageSpecDecl *LSD = cast<LinkageSpecDecl>(D);
1274     if (LSD->getLanguage() == LinkageSpecDecl::lang_cxx)
1275       ErrorUnsupported(LSD, "linkage spec");
1276     // FIXME: implement C++ linkage, C linkage works mostly by C
1277     // language reuse already.
1278     break;
1279   }
1280 
1281   case Decl::FileScopeAsm: {
1282     FileScopeAsmDecl *AD = cast<FileScopeAsmDecl>(D);
1283     std::string AsmString(AD->getAsmString()->getStrData(),
1284                           AD->getAsmString()->getByteLength());
1285 
1286     const std::string &S = getModule().getModuleInlineAsm();
1287     if (S.empty())
1288       getModule().setModuleInlineAsm(AsmString);
1289     else
1290       getModule().setModuleInlineAsm(S + '\n' + AsmString);
1291     break;
1292   }
1293 
1294   default:
1295     // Make sure we handled everything we should, every other kind is
1296     // a non-top-level decl.  FIXME: Would be nice to have an
1297     // isTopLevelDeclKind function. Need to recode Decl::Kind to do
1298     // that easily.
1299     assert(isa<TypeDecl>(D) && "Unsupported decl kind");
1300   }
1301 }
1302