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