1 //===--- CodeGenModule.h - Per-Module state for LLVM CodeGen ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This is the internal per-translation-unit state used for llvm translation.
12 //===----------------------------------------------------------------------===//
14 #ifndef CLANG_CODEGEN_CODEGENMODULE_H
15 #define CLANG_CODEGEN_CODEGENMODULE_H
17 #include "clang/Basic/ABI.h"
18 #include "clang/Basic/LangOptions.h"
19 #include "clang/AST/Attr.h"
20 #include "clang/AST/DeclCXX.h"
21 #include "clang/AST/DeclObjC.h"
22 #include "clang/AST/GlobalDecl.h"
23 #include "clang/AST/Mangle.h"
24 #include "CGVTables.h"
25 #include "CodeGenTypes.h"
26 #include "llvm/Module.h"
27 #include "llvm/ADT/DenseMap.h"
28 #include "llvm/ADT/StringMap.h"
29 #include "llvm/ADT/SmallPtrSet.h"
30 #include "llvm/Support/ValueHandle.h"
44 class TargetCodeGenInfo;
49 class ObjCImplementationDecl;
50 class ObjCCategoryImplDecl;
51 class ObjCProtocolDecl;
65 class DiagnosticsEngine;
67 class CXXDestructorDecl;
73 class CodeGenFunction;
78 class CGOpenCLRuntime;
80 class BlockFieldFlags;
81 class FunctionArgList;
83 struct OrderGlobalInits {
84 unsigned int priority;
85 unsigned int lex_order;
86 OrderGlobalInits(unsigned int p, unsigned int l)
87 : priority(p), lex_order(l) {}
89 bool operator==(const OrderGlobalInits &RHS) const {
90 return priority == RHS.priority &&
91 lex_order == RHS.lex_order;
94 bool operator<(const OrderGlobalInits &RHS) const {
95 if (priority < RHS.priority)
98 return priority == RHS.priority && lex_order < RHS.lex_order;
102 struct CodeGenTypeCache {
106 /// i8, i16, i32, and i64
107 llvm::IntegerType *Int8Ty, *Int16Ty, *Int32Ty, *Int64Ty;
109 llvm::Type *FloatTy, *DoubleTy;
112 llvm::IntegerType *IntTy;
114 /// intptr_t, size_t, and ptrdiff_t, which we assume are the same size.
116 llvm::IntegerType *IntPtrTy;
117 llvm::IntegerType *SizeTy;
118 llvm::IntegerType *PtrDiffTy;
121 /// void* in address space 0
123 llvm::PointerType *VoidPtrTy;
124 llvm::PointerType *Int8PtrTy;
127 /// void** in address space 0
129 llvm::PointerType *VoidPtrPtrTy;
130 llvm::PointerType *Int8PtrPtrTy;
133 /// The width of a pointer into the generic address space.
134 unsigned char PointerWidthInBits;
136 /// The size and alignment of a pointer into the generic address
139 unsigned char PointerAlignInBytes;
140 unsigned char PointerSizeInBytes;
144 struct RREntrypoints {
145 RREntrypoints() { memset(this, 0, sizeof(*this)); }
146 /// void objc_autoreleasePoolPop(void*);
147 llvm::Constant *objc_autoreleasePoolPop;
149 /// void *objc_autoreleasePoolPush(void);
150 llvm::Constant *objc_autoreleasePoolPush;
153 struct ARCEntrypoints {
154 ARCEntrypoints() { memset(this, 0, sizeof(*this)); }
156 /// id objc_autorelease(id);
157 llvm::Constant *objc_autorelease;
159 /// id objc_autoreleaseReturnValue(id);
160 llvm::Constant *objc_autoreleaseReturnValue;
162 /// void objc_copyWeak(id *dest, id *src);
163 llvm::Constant *objc_copyWeak;
165 /// void objc_destroyWeak(id*);
166 llvm::Constant *objc_destroyWeak;
168 /// id objc_initWeak(id*, id);
169 llvm::Constant *objc_initWeak;
171 /// id objc_loadWeak(id*);
172 llvm::Constant *objc_loadWeak;
174 /// id objc_loadWeakRetained(id*);
175 llvm::Constant *objc_loadWeakRetained;
177 /// void objc_moveWeak(id *dest, id *src);
178 llvm::Constant *objc_moveWeak;
180 /// id objc_retain(id);
181 llvm::Constant *objc_retain;
183 /// id objc_retainAutorelease(id);
184 llvm::Constant *objc_retainAutorelease;
186 /// id objc_retainAutoreleaseReturnValue(id);
187 llvm::Constant *objc_retainAutoreleaseReturnValue;
189 /// id objc_retainAutoreleasedReturnValue(id);
190 llvm::Constant *objc_retainAutoreleasedReturnValue;
192 /// id objc_retainBlock(id);
193 llvm::Constant *objc_retainBlock;
195 /// void objc_release(id);
196 llvm::Constant *objc_release;
198 /// id objc_storeStrong(id*, id);
199 llvm::Constant *objc_storeStrong;
201 /// id objc_storeWeak(id*, id);
202 llvm::Constant *objc_storeWeak;
204 /// A void(void) inline asm to use to mark that the return value of
205 /// a call will be immediately retain.
206 llvm::InlineAsm *retainAutoreleasedReturnValueMarker;
209 /// CodeGenModule - This class organizes the cross-function state that is used
210 /// while generating LLVM code.
211 class CodeGenModule : public CodeGenTypeCache {
212 CodeGenModule(const CodeGenModule&); // DO NOT IMPLEMENT
213 void operator=(const CodeGenModule&); // DO NOT IMPLEMENT
215 typedef std::vector<std::pair<llvm::Constant*, int> > CtorList;
218 const LangOptions &LangOpts;
219 const CodeGenOptions &CodeGenOpts;
220 llvm::Module &TheModule;
221 const llvm::TargetData &TheTargetData;
222 mutable const TargetCodeGenInfo *TheTargetCodeGenInfo;
223 DiagnosticsEngine &Diags;
228 /// VTables - Holds information about C++ vtables.
229 CodeGenVTables VTables;
230 friend class CodeGenVTables;
232 CGObjCRuntime* ObjCRuntime;
233 CGOpenCLRuntime* OpenCLRuntime;
234 CGCUDARuntime* CUDARuntime;
235 CGDebugInfo* DebugInfo;
236 ARCEntrypoints *ARCData;
237 llvm::MDNode *NoObjCARCExceptionsMetadata;
238 RREntrypoints *RRData;
240 // WeakRefReferences - A set of references that have only been seen via
241 // a weakref so far. This is used to remove the weak of the reference if we ever
242 // see a direct reference or a definition.
243 llvm::SmallPtrSet<llvm::GlobalValue*, 10> WeakRefReferences;
245 /// DeferredDecls - This contains all the decls which have definitions but
246 /// which are deferred for emission and therefore should only be output if
247 /// they are actually used. If a decl is in this, then it is known to have
248 /// not been referenced yet.
249 llvm::StringMap<GlobalDecl> DeferredDecls;
251 /// DeferredDeclsToEmit - This is a list of deferred decls which we have seen
252 /// that *are* actually referenced. These get code generated when the module
254 std::vector<GlobalDecl> DeferredDeclsToEmit;
256 /// LLVMUsed - List of global values which are required to be
257 /// present in the object file; bitcast to i8*. This is used for
258 /// forcing visibility of symbols which may otherwise be optimized
260 std::vector<llvm::WeakVH> LLVMUsed;
262 /// GlobalCtors - Store the list of global constructors and their respective
263 /// priorities to be emitted when the translation unit is complete.
264 CtorList GlobalCtors;
266 /// GlobalDtors - Store the list of global destructors and their respective
267 /// priorities to be emitted when the translation unit is complete.
268 CtorList GlobalDtors;
270 /// MangledDeclNames - A map of canonical GlobalDecls to their mangled names.
271 llvm::DenseMap<GlobalDecl, StringRef> MangledDeclNames;
272 llvm::BumpPtrAllocator MangledNamesAllocator;
274 /// Global annotations.
275 std::vector<llvm::Constant*> Annotations;
277 /// Map used to get unique annotation strings.
278 llvm::StringMap<llvm::Constant*> AnnotationStrings;
280 llvm::StringMap<llvm::Constant*> CFConstantStringMap;
281 llvm::StringMap<llvm::GlobalVariable*> ConstantStringMap;
282 llvm::DenseMap<const Decl*, llvm::Constant *> StaticLocalDeclMap;
283 llvm::DenseMap<const Decl*, llvm::GlobalVariable*> StaticLocalDeclGuardMap;
285 llvm::DenseMap<QualType, llvm::Constant *> AtomicSetterHelperFnMap;
286 llvm::DenseMap<QualType, llvm::Constant *> AtomicGetterHelperFnMap;
288 /// CXXGlobalInits - Global variables with initializers that need to run
290 std::vector<llvm::Constant*> CXXGlobalInits;
292 /// When a C++ decl with an initializer is deferred, null is
293 /// appended to CXXGlobalInits, and the index of that null is placed
294 /// here so that the initializer will be performed in the correct
296 llvm::DenseMap<const Decl*, unsigned> DelayedCXXInitPosition;
298 /// - Global variables with initializers whose order of initialization
299 /// is set by init_priority attribute.
301 SmallVector<std::pair<OrderGlobalInits, llvm::Function*>, 8>
302 PrioritizedCXXGlobalInits;
304 /// CXXGlobalDtors - Global destructor functions and arguments that need to
305 /// run on termination.
306 std::vector<std::pair<llvm::WeakVH,llvm::Constant*> > CXXGlobalDtors;
308 /// @name Cache for Objective-C runtime types
311 /// CFConstantStringClassRef - Cached reference to the class for constant
312 /// strings. This value has type int * but is actually an Obj-C class pointer.
313 llvm::Constant *CFConstantStringClassRef;
315 /// ConstantStringClassRef - Cached reference to the class for constant
316 /// strings. This value has type int * but is actually an Obj-C class pointer.
317 llvm::Constant *ConstantStringClassRef;
319 /// \brief The LLVM type corresponding to NSConstantString.
320 llvm::StructType *NSConstantStringType;
322 /// \brief The type used to describe the state of a fast enumeration in
323 /// Objective-C's for..in loop.
324 QualType ObjCFastEnumerationStateType;
328 /// Lazily create the Objective-C runtime
329 void createObjCRuntime();
331 void createOpenCLRuntime();
332 void createCUDARuntime();
334 bool isTriviallyRecursive(const FunctionDecl *F);
335 bool shouldEmitFunction(const FunctionDecl *F);
336 llvm::LLVMContext &VMContext;
338 /// @name Cache for Blocks Runtime Globals
341 llvm::Constant *NSConcreteGlobalBlock;
342 llvm::Constant *NSConcreteStackBlock;
344 llvm::Constant *BlockObjectAssign;
345 llvm::Constant *BlockObjectDispose;
347 llvm::Type *BlockDescriptorType;
348 llvm::Type *GenericBlockLiteralType;
351 int GlobalUniqueCount;
356 CodeGenModule(ASTContext &C, const CodeGenOptions &CodeGenOpts,
357 llvm::Module &M, const llvm::TargetData &TD,
358 DiagnosticsEngine &Diags);
362 /// Release - Finalize LLVM code generation.
365 /// getObjCRuntime() - Return a reference to the configured
366 /// Objective-C runtime.
367 CGObjCRuntime &getObjCRuntime() {
368 if (!ObjCRuntime) createObjCRuntime();
372 /// hasObjCRuntime() - Return true iff an Objective-C runtime has
374 bool hasObjCRuntime() { return !!ObjCRuntime; }
376 /// getOpenCLRuntime() - Return a reference to the configured OpenCL runtime.
377 CGOpenCLRuntime &getOpenCLRuntime() {
378 assert(OpenCLRuntime != 0);
379 return *OpenCLRuntime;
382 /// getCUDARuntime() - Return a reference to the configured CUDA runtime.
383 CGCUDARuntime &getCUDARuntime() {
384 assert(CUDARuntime != 0);
388 /// getCXXABI() - Return a reference to the configured C++ ABI.
389 CGCXXABI &getCXXABI() { return ABI; }
391 ARCEntrypoints &getARCEntrypoints() const {
392 assert(getLangOpts().ObjCAutoRefCount && ARCData != 0);
396 RREntrypoints &getRREntrypoints() const {
401 llvm::Constant *getStaticLocalDeclAddress(const VarDecl *D) {
402 return StaticLocalDeclMap[D];
404 void setStaticLocalDeclAddress(const VarDecl *D,
406 StaticLocalDeclMap[D] = C;
409 llvm::GlobalVariable *getStaticLocalDeclGuardAddress(const VarDecl *D) {
410 return StaticLocalDeclGuardMap[D];
412 void setStaticLocalDeclGuardAddress(const VarDecl *D,
413 llvm::GlobalVariable *C) {
414 StaticLocalDeclGuardMap[D] = C;
417 llvm::Constant *getAtomicSetterHelperFnMap(QualType Ty) {
418 return AtomicSetterHelperFnMap[Ty];
420 void setAtomicSetterHelperFnMap(QualType Ty,
421 llvm::Constant *Fn) {
422 AtomicSetterHelperFnMap[Ty] = Fn;
425 llvm::Constant *getAtomicGetterHelperFnMap(QualType Ty) {
426 return AtomicGetterHelperFnMap[Ty];
428 void setAtomicGetterHelperFnMap(QualType Ty,
429 llvm::Constant *Fn) {
430 AtomicGetterHelperFnMap[Ty] = Fn;
433 CGDebugInfo *getModuleDebugInfo() { return DebugInfo; }
435 llvm::MDNode *getNoObjCARCExceptionsMetadata() {
436 if (!NoObjCARCExceptionsMetadata)
437 NoObjCARCExceptionsMetadata =
438 llvm::MDNode::get(getLLVMContext(),
439 SmallVector<llvm::Value*,1>());
440 return NoObjCARCExceptionsMetadata;
443 ASTContext &getContext() const { return Context; }
444 const CodeGenOptions &getCodeGenOpts() const { return CodeGenOpts; }
445 const LangOptions &getLangOpts() const { return LangOpts; }
446 llvm::Module &getModule() const { return TheModule; }
447 CodeGenTypes &getTypes() { return Types; }
448 CodeGenVTables &getVTables() { return VTables; }
449 VTableContext &getVTableContext() { return VTables.getVTableContext(); }
450 DiagnosticsEngine &getDiags() const { return Diags; }
451 const llvm::TargetData &getTargetData() const { return TheTargetData; }
452 const TargetInfo &getTarget() const { return Context.getTargetInfo(); }
453 llvm::LLVMContext &getLLVMContext() { return VMContext; }
454 const TargetCodeGenInfo &getTargetCodeGenInfo();
455 bool isTargetDarwin() const;
457 bool shouldUseTBAA() const { return TBAA != 0; }
459 llvm::MDNode *getTBAAInfo(QualType QTy);
460 llvm::MDNode *getTBAAInfoForVTablePtr();
462 bool isTypeConstant(QualType QTy, bool ExcludeCtorDtor);
464 static void DecorateInstruction(llvm::Instruction *Inst,
465 llvm::MDNode *TBAAInfo);
467 /// getSize - Emit the given number of characters as a value of type size_t.
468 llvm::ConstantInt *getSize(CharUnits numChars);
470 /// setGlobalVisibility - Set the visibility for the given LLVM
472 void setGlobalVisibility(llvm::GlobalValue *GV, const NamedDecl *D) const;
474 /// TypeVisibilityKind - The kind of global variable that is passed to
475 /// setTypeVisibility
476 enum TypeVisibilityKind {
479 TVK_ForConstructionVTable,
484 /// setTypeVisibility - Set the visibility for the given global
485 /// value which holds information about a type.
486 void setTypeVisibility(llvm::GlobalValue *GV, const CXXRecordDecl *D,
487 TypeVisibilityKind TVK) const;
489 static llvm::GlobalValue::VisibilityTypes GetLLVMVisibility(Visibility V) {
491 case DefaultVisibility: return llvm::GlobalValue::DefaultVisibility;
492 case HiddenVisibility: return llvm::GlobalValue::HiddenVisibility;
493 case ProtectedVisibility: return llvm::GlobalValue::ProtectedVisibility;
495 llvm_unreachable("unknown visibility!");
498 llvm::Constant *GetAddrOfGlobal(GlobalDecl GD) {
499 if (isa<CXXConstructorDecl>(GD.getDecl()))
500 return GetAddrOfCXXConstructor(cast<CXXConstructorDecl>(GD.getDecl()),
502 else if (isa<CXXDestructorDecl>(GD.getDecl()))
503 return GetAddrOfCXXDestructor(cast<CXXDestructorDecl>(GD.getDecl()),
505 else if (isa<FunctionDecl>(GD.getDecl()))
506 return GetAddrOfFunction(GD);
508 return GetAddrOfGlobalVar(cast<VarDecl>(GD.getDecl()));
511 /// CreateOrReplaceCXXRuntimeVariable - Will return a global variable of the given
512 /// type. If a variable with a different type already exists then a new
513 /// variable with the right type will be created and all uses of the old
514 /// variable will be replaced with a bitcast to the new variable.
515 llvm::GlobalVariable *
516 CreateOrReplaceCXXRuntimeVariable(StringRef Name, llvm::Type *Ty,
517 llvm::GlobalValue::LinkageTypes Linkage);
519 /// GetAddrOfGlobalVar - Return the llvm::Constant for the address of the
520 /// given global variable. If Ty is non-null and if the global doesn't exist,
521 /// then it will be greated with the specified type instead of whatever the
522 /// normal requested type would be.
523 llvm::Constant *GetAddrOfGlobalVar(const VarDecl *D,
527 /// GetAddrOfFunction - Return the address of the given function. If Ty is
528 /// non-null, then this function will use the specified type if it has to
530 llvm::Constant *GetAddrOfFunction(GlobalDecl GD,
532 bool ForVTable = false);
534 /// GetAddrOfRTTIDescriptor - Get the address of the RTTI descriptor
535 /// for the given type.
536 llvm::Constant *GetAddrOfRTTIDescriptor(QualType Ty, bool ForEH = false);
538 /// GetAddrOfThunk - Get the address of the thunk for the given global decl.
539 llvm::Constant *GetAddrOfThunk(GlobalDecl GD, const ThunkInfo &Thunk);
541 /// GetWeakRefReference - Get a reference to the target of VD.
542 llvm::Constant *GetWeakRefReference(const ValueDecl *VD);
544 /// GetNonVirtualBaseClassOffset - Returns the offset from a derived class to
545 /// a class. Returns null if the offset is 0.
547 GetNonVirtualBaseClassOffset(const CXXRecordDecl *ClassDecl,
548 CastExpr::path_const_iterator PathBegin,
549 CastExpr::path_const_iterator PathEnd);
551 /// A pair of helper functions for a __block variable.
552 class ByrefHelpers : public llvm::FoldingSetNode {
554 llvm::Constant *CopyHelper;
555 llvm::Constant *DisposeHelper;
557 /// The alignment of the field. This is important because
558 /// different offsets to the field within the byref struct need to
559 /// have different helper functions.
562 ByrefHelpers(CharUnits alignment) : Alignment(alignment) {}
563 virtual ~ByrefHelpers();
565 void Profile(llvm::FoldingSetNodeID &id) const {
566 id.AddInteger(Alignment.getQuantity());
569 virtual void profileImpl(llvm::FoldingSetNodeID &id) const = 0;
571 virtual bool needsCopy() const { return true; }
572 virtual void emitCopy(CodeGenFunction &CGF,
573 llvm::Value *dest, llvm::Value *src) = 0;
575 virtual bool needsDispose() const { return true; }
576 virtual void emitDispose(CodeGenFunction &CGF, llvm::Value *field) = 0;
579 llvm::FoldingSet<ByrefHelpers> ByrefHelpersCache;
581 /// getUniqueBlockCount - Fetches the global unique block count.
582 int getUniqueBlockCount() { return ++Block.GlobalUniqueCount; }
584 /// getBlockDescriptorType - Fetches the type of a generic block
586 llvm::Type *getBlockDescriptorType();
588 /// getGenericBlockLiteralType - The type of a generic block literal.
589 llvm::Type *getGenericBlockLiteralType();
591 /// GetAddrOfGlobalBlock - Gets the address of a block which
592 /// requires no captures.
593 llvm::Constant *GetAddrOfGlobalBlock(const BlockExpr *BE, const char *);
595 /// GetAddrOfConstantCFString - Return a pointer to a constant CFString object
596 /// for the given string.
597 llvm::Constant *GetAddrOfConstantCFString(const StringLiteral *Literal);
599 /// GetAddrOfConstantString - Return a pointer to a constant NSString object
600 /// for the given string. Or a user defined String object as defined via
601 /// -fconstant-string-class=class_name option.
602 llvm::Constant *GetAddrOfConstantString(const StringLiteral *Literal);
604 /// GetConstantArrayFromStringLiteral - Return a constant array for the given
606 llvm::Constant *GetConstantArrayFromStringLiteral(const StringLiteral *E);
608 /// GetAddrOfConstantStringFromLiteral - Return a pointer to a constant array
609 /// for the given string literal.
610 llvm::Constant *GetAddrOfConstantStringFromLiteral(const StringLiteral *S);
612 /// GetAddrOfConstantStringFromObjCEncode - Return a pointer to a constant
613 /// array for the given ObjCEncodeExpr node.
614 llvm::Constant *GetAddrOfConstantStringFromObjCEncode(const ObjCEncodeExpr *);
616 /// GetAddrOfConstantString - Returns a pointer to a character array
617 /// containing the literal. This contents are exactly that of the given
618 /// string, i.e. it will not be null terminated automatically; see
619 /// GetAddrOfConstantCString. Note that whether the result is actually a
620 /// pointer to an LLVM constant depends on Feature.WriteableStrings.
622 /// The result has pointer to array type.
624 /// \param GlobalName If provided, the name to use for the global
625 /// (if one is created).
626 llvm::Constant *GetAddrOfConstantString(StringRef Str,
627 const char *GlobalName=0,
628 unsigned Alignment=1);
630 /// GetAddrOfConstantCString - Returns a pointer to a character array
631 /// containing the literal and a terminating '\0' character. The result has
632 /// pointer to array type.
634 /// \param GlobalName If provided, the name to use for the global (if one is
636 llvm::Constant *GetAddrOfConstantCString(const std::string &str,
637 const char *GlobalName=0,
638 unsigned Alignment=1);
640 /// GetAddrOfConstantCompoundLiteral - Returns a pointer to a constant global
641 /// variable for the given file-scope compound literal expression.
642 llvm::Constant *GetAddrOfConstantCompoundLiteral(const CompoundLiteralExpr*E);
644 /// \brief Retrieve the record type that describes the state of an
645 /// Objective-C fast enumeration loop (for..in).
646 QualType getObjCFastEnumerationStateType();
648 /// GetAddrOfCXXConstructor - Return the address of the constructor of the
650 llvm::GlobalValue *GetAddrOfCXXConstructor(const CXXConstructorDecl *ctor,
651 CXXCtorType ctorType,
652 const CGFunctionInfo *fnInfo = 0);
654 /// GetAddrOfCXXDestructor - Return the address of the constructor of the
656 llvm::GlobalValue *GetAddrOfCXXDestructor(const CXXDestructorDecl *dtor,
657 CXXDtorType dtorType,
658 const CGFunctionInfo *fnInfo = 0);
660 /// getBuiltinLibFunction - Given a builtin id for a function like
661 /// "__builtin_fabsf", return a Function* for "fabsf".
662 llvm::Value *getBuiltinLibFunction(const FunctionDecl *FD,
665 llvm::Function *getIntrinsic(unsigned IID, ArrayRef<llvm::Type*> Tys =
666 ArrayRef<llvm::Type*>());
668 /// EmitTopLevelDecl - Emit code for a single top level declaration.
669 void EmitTopLevelDecl(Decl *D);
671 /// HandleCXXStaticMemberVarInstantiation - Tell the consumer that this
672 // variable has been instantiated.
673 void HandleCXXStaticMemberVarInstantiation(VarDecl *VD);
675 /// AddUsedGlobal - Add a global which should be forced to be
676 /// present in the object file; these are emitted to the llvm.used
678 void AddUsedGlobal(llvm::GlobalValue *GV);
680 /// AddCXXDtorEntry - Add a destructor and object to add to the C++ global
681 /// destructor function.
682 void AddCXXDtorEntry(llvm::Constant *DtorFn, llvm::Constant *Object) {
683 CXXGlobalDtors.push_back(std::make_pair(DtorFn, Object));
686 /// CreateRuntimeFunction - Create a new runtime function with the specified
688 llvm::Constant *CreateRuntimeFunction(llvm::FunctionType *Ty,
690 llvm::Attributes ExtraAttrs =
691 llvm::Attribute::None);
692 /// CreateRuntimeVariable - Create a new runtime global variable with the
693 /// specified type and name.
694 llvm::Constant *CreateRuntimeVariable(llvm::Type *Ty,
697 ///@name Custom Blocks Runtime Interfaces
700 llvm::Constant *getNSConcreteGlobalBlock();
701 llvm::Constant *getNSConcreteStackBlock();
702 llvm::Constant *getBlockObjectAssign();
703 llvm::Constant *getBlockObjectDispose();
707 // UpdateCompleteType - Make sure that this type is translated.
708 void UpdateCompletedType(const TagDecl *TD);
710 llvm::Constant *getMemberPointerConstant(const UnaryOperator *e);
712 /// EmitConstantInit - Try to emit the initializer for the given declaration
713 /// as a constant; returns 0 if the expression cannot be emitted as a
715 llvm::Constant *EmitConstantInit(const VarDecl &D, CodeGenFunction *CGF = 0);
717 /// EmitConstantExpr - Try to emit the given expression as a
718 /// constant; returns 0 if the expression cannot be emitted as a
720 llvm::Constant *EmitConstantExpr(const Expr *E, QualType DestType,
721 CodeGenFunction *CGF = 0);
723 /// EmitConstantValue - Emit the given constant value as a constant, in the
724 /// type's scalar representation.
725 llvm::Constant *EmitConstantValue(const APValue &Value, QualType DestType,
726 CodeGenFunction *CGF = 0);
728 /// EmitConstantValueForMemory - Emit the given constant value as a constant,
729 /// in the type's memory representation.
730 llvm::Constant *EmitConstantValueForMemory(const APValue &Value,
732 CodeGenFunction *CGF = 0);
734 /// EmitNullConstant - Return the result of value-initializing the given
735 /// type, i.e. a null expression of the given type. This is usually,
736 /// but not always, an LLVM null constant.
737 llvm::Constant *EmitNullConstant(QualType T);
739 /// EmitNullConstantForBase - Return a null constant appropriate for
740 /// zero-initializing a base class with the given type. This is usually,
741 /// but not always, an LLVM null constant.
742 llvm::Constant *EmitNullConstantForBase(const CXXRecordDecl *Record);
744 /// Error - Emit a general error that something can't be done.
745 void Error(SourceLocation loc, StringRef error);
747 /// ErrorUnsupported - Print out an error that codegen doesn't support the
748 /// specified stmt yet.
749 /// \param OmitOnError - If true, then this error should only be emitted if no
750 /// other errors have been reported.
751 void ErrorUnsupported(const Stmt *S, const char *Type,
752 bool OmitOnError=false);
754 /// ErrorUnsupported - Print out an error that codegen doesn't support the
755 /// specified decl yet.
756 /// \param OmitOnError - If true, then this error should only be emitted if no
757 /// other errors have been reported.
758 void ErrorUnsupported(const Decl *D, const char *Type,
759 bool OmitOnError=false);
761 /// SetInternalFunctionAttributes - Set the attributes on the LLVM
762 /// function for the given decl and function info. This applies
763 /// attributes necessary for handling the ABI as well as user
764 /// specified attributes like section.
765 void SetInternalFunctionAttributes(const Decl *D, llvm::Function *F,
766 const CGFunctionInfo &FI);
768 /// SetLLVMFunctionAttributes - Set the LLVM function attributes
769 /// (sext, zext, etc).
770 void SetLLVMFunctionAttributes(const Decl *D,
771 const CGFunctionInfo &Info,
774 /// SetLLVMFunctionAttributesForDefinition - Set the LLVM function attributes
775 /// which only apply to a function definintion.
776 void SetLLVMFunctionAttributesForDefinition(const Decl *D, llvm::Function *F);
778 /// ReturnTypeUsesSRet - Return true iff the given type uses 'sret' when used
779 /// as a return type.
780 bool ReturnTypeUsesSRet(const CGFunctionInfo &FI);
782 /// ReturnTypeUsesFPRet - Return true iff the given type uses 'fpret' when
783 /// used as a return type.
784 bool ReturnTypeUsesFPRet(QualType ResultType);
786 /// ReturnTypeUsesFP2Ret - Return true iff the given type uses 'fp2ret' when
787 /// used as a return type.
788 bool ReturnTypeUsesFP2Ret(QualType ResultType);
790 /// ConstructAttributeList - Get the LLVM attributes and calling convention to
791 /// use for a particular function type.
793 /// \param Info - The function type information.
794 /// \param TargetDecl - The decl these attributes are being constructed
795 /// for. If supplied the attributes applied to this decl may contribute to the
796 /// function attributes and calling convention.
797 /// \param PAL [out] - On return, the attribute list to use.
798 /// \param CallingConv [out] - On return, the LLVM calling convention to use.
799 void ConstructAttributeList(const CGFunctionInfo &Info,
800 const Decl *TargetDecl,
801 AttributeListType &PAL,
802 unsigned &CallingConv);
804 StringRef getMangledName(GlobalDecl GD);
805 void getBlockMangledName(GlobalDecl GD, MangleBuffer &Buffer,
806 const BlockDecl *BD);
808 void EmitTentativeDefinition(const VarDecl *D);
810 void EmitVTable(CXXRecordDecl *Class, bool DefinitionRequired);
812 llvm::GlobalVariable::LinkageTypes
813 getFunctionLinkage(const FunctionDecl *FD);
815 void setFunctionLinkage(const FunctionDecl *FD, llvm::GlobalValue *V) {
816 V->setLinkage(getFunctionLinkage(FD));
819 /// getVTableLinkage - Return the appropriate linkage for the vtable, VTT,
820 /// and type information of the given class.
821 llvm::GlobalVariable::LinkageTypes getVTableLinkage(const CXXRecordDecl *RD);
823 /// GetTargetTypeStoreSize - Return the store size, in character units, of
824 /// the given LLVM type.
825 CharUnits GetTargetTypeStoreSize(llvm::Type *Ty) const;
827 /// GetLLVMLinkageVarDefinition - Returns LLVM linkage for a global
829 llvm::GlobalValue::LinkageTypes
830 GetLLVMLinkageVarDefinition(const VarDecl *D,
831 llvm::GlobalVariable *GV);
833 std::vector<const CXXRecordDecl*> DeferredVTables;
835 /// Emit all the global annotations.
836 void EmitGlobalAnnotations();
838 /// Emit an annotation string.
839 llvm::Constant *EmitAnnotationString(llvm::StringRef Str);
841 /// Emit the annotation's translation unit.
842 llvm::Constant *EmitAnnotationUnit(SourceLocation Loc);
844 /// Emit the annotation line number.
845 llvm::Constant *EmitAnnotationLineNo(SourceLocation L);
847 /// EmitAnnotateAttr - Generate the llvm::ConstantStruct which contains the
848 /// annotation information for a given GlobalValue. The annotation struct is
849 /// {i8 *, i8 *, i8 *, i32}. The first field is a constant expression, the
850 /// GlobalValue being annotated. The second field is the constant string
851 /// created from the AnnotateAttr's annotation. The third field is a constant
852 /// string containing the name of the translation unit. The fourth field is
853 /// the line number in the file of the annotated value declaration.
854 llvm::Constant *EmitAnnotateAttr(llvm::GlobalValue *GV,
855 const AnnotateAttr *AA,
858 /// Add global annotations that are set on D, for the global GV. Those
859 /// annotations are emitted during finalization of the LLVM code.
860 void AddGlobalAnnotations(const ValueDecl *D, llvm::GlobalValue *GV);
863 llvm::GlobalValue *GetGlobalValue(StringRef Ref);
865 llvm::Constant *GetOrCreateLLVMFunction(StringRef MangledName,
869 llvm::Attributes ExtraAttrs =
870 llvm::Attribute::None);
871 llvm::Constant *GetOrCreateLLVMGlobal(StringRef MangledName,
872 llvm::PointerType *PTy,
874 bool UnnamedAddr = false);
876 /// SetCommonAttributes - Set attributes which are common to any
877 /// form of a global definition (alias, Objective-C method,
878 /// function, global variable).
880 /// NOTE: This should only be called for definitions.
881 void SetCommonAttributes(const Decl *D, llvm::GlobalValue *GV);
883 /// SetFunctionDefinitionAttributes - Set attributes for a global definition.
884 void SetFunctionDefinitionAttributes(const FunctionDecl *D,
885 llvm::GlobalValue *GV);
887 /// SetFunctionAttributes - Set function attributes for a function
889 void SetFunctionAttributes(GlobalDecl GD,
891 bool IsIncompleteFunction);
893 /// EmitGlobal - Emit code for a singal global function or var decl. Forward
894 /// declarations are emitted lazily.
895 void EmitGlobal(GlobalDecl D);
897 void EmitGlobalDefinition(GlobalDecl D);
899 void EmitGlobalFunctionDefinition(GlobalDecl GD);
900 void EmitGlobalVarDefinition(const VarDecl *D);
901 llvm::Constant *MaybeEmitGlobalStdInitializerListInitializer(const VarDecl *D,
903 void EmitAliasDefinition(GlobalDecl GD);
904 void EmitObjCPropertyImplementations(const ObjCImplementationDecl *D);
905 void EmitObjCIvarInitializations(ObjCImplementationDecl *D);
907 // C++ related functions.
909 bool TryEmitDefinitionAsAlias(GlobalDecl Alias, GlobalDecl Target);
910 bool TryEmitBaseDestructorAsAlias(const CXXDestructorDecl *D);
912 void EmitNamespace(const NamespaceDecl *D);
913 void EmitLinkageSpec(const LinkageSpecDecl *D);
915 /// EmitCXXConstructors - Emit constructors (base, complete) from a
916 /// C++ constructor Decl.
917 void EmitCXXConstructors(const CXXConstructorDecl *D);
919 /// EmitCXXConstructor - Emit a single constructor with the given type from
920 /// a C++ constructor Decl.
921 void EmitCXXConstructor(const CXXConstructorDecl *D, CXXCtorType Type);
923 /// EmitCXXDestructors - Emit destructors (base, complete) from a
924 /// C++ destructor Decl.
925 void EmitCXXDestructors(const CXXDestructorDecl *D);
927 /// EmitCXXDestructor - Emit a single destructor with the given type from
928 /// a C++ destructor Decl.
929 void EmitCXXDestructor(const CXXDestructorDecl *D, CXXDtorType Type);
931 /// EmitCXXGlobalInitFunc - Emit the function that initializes C++ globals.
932 void EmitCXXGlobalInitFunc();
934 /// EmitCXXGlobalDtorFunc - Emit the function that destroys C++ globals.
935 void EmitCXXGlobalDtorFunc();
937 /// EmitCXXGlobalVarDeclInitFunc - Emit the function that initializes the
938 /// specified global (if PerformInit is true) and registers its destructor.
939 void EmitCXXGlobalVarDeclInitFunc(const VarDecl *D,
940 llvm::GlobalVariable *Addr,
943 // FIXME: Hardcoding priority here is gross.
944 void AddGlobalCtor(llvm::Function *Ctor, int Priority=65535);
945 void AddGlobalDtor(llvm::Function *Dtor, int Priority=65535);
947 /// EmitCtorList - Generates a global array of functions and priorities using
948 /// the given list and name. This array will have appending linkage and is
949 /// suitable for use as a LLVM constructor or destructor array.
950 void EmitCtorList(const CtorList &Fns, const char *GlobalName);
952 /// EmitFundamentalRTTIDescriptor - Emit the RTTI descriptors for the
954 void EmitFundamentalRTTIDescriptor(QualType Type);
956 /// EmitFundamentalRTTIDescriptors - Emit the RTTI descriptors for the
958 void EmitFundamentalRTTIDescriptors();
960 /// EmitDeferred - Emit any needed decls for which code generation
962 void EmitDeferred(void);
964 /// EmitLLVMUsed - Emit the llvm.used metadata used to force
965 /// references to global which may otherwise be optimized out.
966 void EmitLLVMUsed(void);
968 void EmitDeclMetadata();
970 /// EmitCoverageFile - Emit the llvm.gcov metadata used to tell LLVM where
971 /// to emit the .gcno and .gcda files in a way that persists in .bc files.
972 void EmitCoverageFile();
974 /// MayDeferGeneration - Determine if the given decl can be emitted
975 /// lazily; this is only relevant for definitions. The given decl
976 /// must be either a function or var decl.
977 bool MayDeferGeneration(const ValueDecl *D);
979 /// SimplifyPersonality - Check whether we can use a "simpler", more
980 /// core exceptions personality function.
981 void SimplifyPersonality();
983 } // end namespace CodeGen
984 } // end namespace clang