blob: 6fcf83d5ace19b8aba990b46eb3b7c58842ec179 [file] [log] [blame]
Charles Davis3a811f12010-05-25 19:52:27 +00001//===------- ItaniumCXXABI.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//
Chris Lattnerfc8f0e12011-04-15 05:22:18 +000010// This provides C++ code generation targeting the Itanium C++ ABI. The class
Charles Davis3a811f12010-05-25 19:52:27 +000011// in this file generates structures that follow the Itanium C++ ABI, which is
12// documented at:
13// http://www.codesourcery.com/public/cxx-abi/abi.html
14// http://www.codesourcery.com/public/cxx-abi/abi-eh.html
John McCallee79a4c2010-08-21 22:46:04 +000015//
16// It also supports the closely-related ARM ABI, documented at:
17// http://infocenter.arm.com/help/topic/com.arm.doc.ihi0041c/IHI0041C_cppabi.pdf
18//
Charles Davis3a811f12010-05-25 19:52:27 +000019//===----------------------------------------------------------------------===//
20
21#include "CGCXXABI.h"
John McCall0bab0cd2010-08-23 01:21:21 +000022#include "CGRecordLayout.h"
John McCall93d557b2010-08-22 00:05:51 +000023#include "CodeGenFunction.h"
Charles Davis3a811f12010-05-25 19:52:27 +000024#include "CodeGenModule.h"
Peter Collingbourne14110472011-01-13 18:57:25 +000025#include <clang/AST/Mangle.h>
John McCall93d557b2010-08-22 00:05:51 +000026#include <clang/AST/Type.h>
John McCall0502a222011-06-17 07:33:57 +000027#include <llvm/Intrinsics.h>
John McCall0bab0cd2010-08-23 01:21:21 +000028#include <llvm/Target/TargetData.h>
John McCall93d557b2010-08-22 00:05:51 +000029#include <llvm/Value.h>
Charles Davis3a811f12010-05-25 19:52:27 +000030
31using namespace clang;
John McCall93d557b2010-08-22 00:05:51 +000032using namespace CodeGen;
Charles Davis3a811f12010-05-25 19:52:27 +000033
34namespace {
Charles Davis071cc7d2010-08-16 03:33:14 +000035class ItaniumCXXABI : public CodeGen::CGCXXABI {
John McCall0bab0cd2010-08-23 01:21:21 +000036private:
Chris Lattner9cbe4f02011-07-09 17:41:47 +000037 llvm::IntegerType *PtrDiffTy;
John McCall93d557b2010-08-22 00:05:51 +000038protected:
John McCallbabc9a92010-08-22 00:59:17 +000039 bool IsARM;
John McCall0bab0cd2010-08-23 01:21:21 +000040
41 // It's a little silly for us to cache this.
Chris Lattner9cbe4f02011-07-09 17:41:47 +000042 llvm::IntegerType *getPtrDiffTy() {
John McCall0bab0cd2010-08-23 01:21:21 +000043 if (!PtrDiffTy) {
John McCall9cb2cee2010-09-02 10:25:57 +000044 QualType T = getContext().getPointerDiffType();
Chris Lattner9cbe4f02011-07-09 17:41:47 +000045 llvm::Type *Ty = CGM.getTypes().ConvertType(T);
John McCall0bab0cd2010-08-23 01:21:21 +000046 PtrDiffTy = cast<llvm::IntegerType>(Ty);
47 }
48 return PtrDiffTy;
49 }
50
John McCall6ec278d2011-01-27 09:37:56 +000051 bool NeedsArrayCookie(const CXXNewExpr *expr);
52 bool NeedsArrayCookie(const CXXDeleteExpr *expr,
53 QualType elementType);
John McCall1e7fe752010-09-02 09:58:18 +000054
Charles Davis3a811f12010-05-25 19:52:27 +000055public:
John McCallbabc9a92010-08-22 00:59:17 +000056 ItaniumCXXABI(CodeGen::CodeGenModule &CGM, bool IsARM = false) :
Peter Collingbourne14110472011-01-13 18:57:25 +000057 CGCXXABI(CGM), PtrDiffTy(0), IsARM(IsARM) { }
John McCall93d557b2010-08-22 00:05:51 +000058
John McCallf16aa102010-08-22 21:01:12 +000059 bool isZeroInitializable(const MemberPointerType *MPT);
John McCallcf2c85e2010-08-22 04:16:24 +000060
Chris Lattner9cbe4f02011-07-09 17:41:47 +000061 llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT);
John McCall0bab0cd2010-08-23 01:21:21 +000062
John McCall93d557b2010-08-22 00:05:51 +000063 llvm::Value *EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF,
64 llvm::Value *&This,
65 llvm::Value *MemFnPtr,
66 const MemberPointerType *MPT);
John McCall3023def2010-08-22 03:04:22 +000067
John McCall6c2ab1d2010-08-31 21:07:20 +000068 llvm::Value *EmitMemberDataPointerAddress(CodeGenFunction &CGF,
69 llvm::Value *Base,
70 llvm::Value *MemPtr,
71 const MemberPointerType *MPT);
72
John McCall0bab0cd2010-08-23 01:21:21 +000073 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
74 const CastExpr *E,
75 llvm::Value *Src);
John McCall4d4e5c12012-02-15 01:22:51 +000076 llvm::Constant *EmitMemberPointerConversion(const CastExpr *E,
77 llvm::Constant *Src);
John McCallcf2c85e2010-08-22 04:16:24 +000078
John McCall0bab0cd2010-08-23 01:21:21 +000079 llvm::Constant *EmitNullMemberPointer(const MemberPointerType *MPT);
John McCallcf2c85e2010-08-22 04:16:24 +000080
John McCall755d8492011-04-12 00:42:48 +000081 llvm::Constant *EmitMemberPointer(const CXXMethodDecl *MD);
John McCall5808ce42011-02-03 08:15:49 +000082 llvm::Constant *EmitMemberDataPointer(const MemberPointerType *MPT,
83 CharUnits offset);
Richard Smith2d6a5672012-01-14 04:30:29 +000084 llvm::Constant *EmitMemberPointer(const APValue &MP, QualType MPT);
85 llvm::Constant *BuildMemberPointer(const CXXMethodDecl *MD,
86 CharUnits ThisAdjustment);
John McCall875ab102010-08-22 06:43:33 +000087
John McCall0bab0cd2010-08-23 01:21:21 +000088 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
89 llvm::Value *L,
90 llvm::Value *R,
91 const MemberPointerType *MPT,
92 bool Inequality);
John McCalle9fd7eb2010-08-22 08:30:07 +000093
John McCall0bab0cd2010-08-23 01:21:21 +000094 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
95 llvm::Value *Addr,
96 const MemberPointerType *MPT);
John McCall4c40d982010-08-31 07:33:07 +000097
98 void BuildConstructorSignature(const CXXConstructorDecl *Ctor,
99 CXXCtorType T,
100 CanQualType &ResTy,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000101 SmallVectorImpl<CanQualType> &ArgTys);
John McCall4c40d982010-08-31 07:33:07 +0000102
103 void BuildDestructorSignature(const CXXDestructorDecl *Dtor,
104 CXXDtorType T,
105 CanQualType &ResTy,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000106 SmallVectorImpl<CanQualType> &ArgTys);
John McCall4c40d982010-08-31 07:33:07 +0000107
108 void BuildInstanceFunctionParams(CodeGenFunction &CGF,
109 QualType &ResTy,
110 FunctionArgList &Params);
111
112 void EmitInstanceFunctionProlog(CodeGenFunction &CGF);
John McCall1e7fe752010-09-02 09:58:18 +0000113
John McCall6ec278d2011-01-27 09:37:56 +0000114 CharUnits GetArrayCookieSize(const CXXNewExpr *expr);
John McCall1e7fe752010-09-02 09:58:18 +0000115 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
116 llvm::Value *NewPtr,
117 llvm::Value *NumElements,
John McCall6ec278d2011-01-27 09:37:56 +0000118 const CXXNewExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000119 QualType ElementType);
120 void ReadArrayCookie(CodeGenFunction &CGF, llvm::Value *Ptr,
John McCall6ec278d2011-01-27 09:37:56 +0000121 const CXXDeleteExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000122 QualType ElementType, llvm::Value *&NumElements,
123 llvm::Value *&AllocPtr, CharUnits &CookieSize);
John McCall5cd91b52010-09-08 01:44:27 +0000124
John McCall3030eb82010-11-06 09:44:32 +0000125 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
Richard Smith7ca48502012-02-13 22:16:19 +0000126 llvm::GlobalVariable *DeclPtr, bool PerformInit);
Charles Davis3a811f12010-05-25 19:52:27 +0000127};
John McCallee79a4c2010-08-21 22:46:04 +0000128
129class ARMCXXABI : public ItaniumCXXABI {
130public:
John McCallbabc9a92010-08-22 00:59:17 +0000131 ARMCXXABI(CodeGen::CodeGenModule &CGM) : ItaniumCXXABI(CGM, /*ARM*/ true) {}
John McCall4c40d982010-08-31 07:33:07 +0000132
133 void BuildConstructorSignature(const CXXConstructorDecl *Ctor,
134 CXXCtorType T,
135 CanQualType &ResTy,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000136 SmallVectorImpl<CanQualType> &ArgTys);
John McCall4c40d982010-08-31 07:33:07 +0000137
138 void BuildDestructorSignature(const CXXDestructorDecl *Dtor,
139 CXXDtorType T,
140 CanQualType &ResTy,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000141 SmallVectorImpl<CanQualType> &ArgTys);
John McCall4c40d982010-08-31 07:33:07 +0000142
143 void BuildInstanceFunctionParams(CodeGenFunction &CGF,
144 QualType &ResTy,
145 FunctionArgList &Params);
146
147 void EmitInstanceFunctionProlog(CodeGenFunction &CGF);
148
149 void EmitReturnFromThunk(CodeGenFunction &CGF, RValue RV, QualType ResTy);
150
John McCall6ec278d2011-01-27 09:37:56 +0000151 CharUnits GetArrayCookieSize(const CXXNewExpr *expr);
John McCall1e7fe752010-09-02 09:58:18 +0000152 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
153 llvm::Value *NewPtr,
154 llvm::Value *NumElements,
John McCall6ec278d2011-01-27 09:37:56 +0000155 const CXXNewExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000156 QualType ElementType);
157 void ReadArrayCookie(CodeGenFunction &CGF, llvm::Value *Ptr,
John McCall6ec278d2011-01-27 09:37:56 +0000158 const CXXDeleteExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000159 QualType ElementType, llvm::Value *&NumElements,
160 llvm::Value *&AllocPtr, CharUnits &CookieSize);
John McCall4c40d982010-08-31 07:33:07 +0000161
162private:
163 /// \brief Returns true if the given instance method is one of the
164 /// kinds that the ARM ABI says returns 'this'.
165 static bool HasThisReturn(GlobalDecl GD) {
166 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
167 return ((isa<CXXDestructorDecl>(MD) && GD.getDtorType() != Dtor_Deleting) ||
168 (isa<CXXConstructorDecl>(MD)));
169 }
John McCallee79a4c2010-08-21 22:46:04 +0000170};
Charles Davis3a811f12010-05-25 19:52:27 +0000171}
172
Charles Davis071cc7d2010-08-16 03:33:14 +0000173CodeGen::CGCXXABI *CodeGen::CreateItaniumCXXABI(CodeGenModule &CGM) {
Charles Davis3a811f12010-05-25 19:52:27 +0000174 return new ItaniumCXXABI(CGM);
175}
176
John McCallee79a4c2010-08-21 22:46:04 +0000177CodeGen::CGCXXABI *CodeGen::CreateARMCXXABI(CodeGenModule &CGM) {
178 return new ARMCXXABI(CGM);
179}
180
Chris Lattner9cbe4f02011-07-09 17:41:47 +0000181llvm::Type *
John McCall0bab0cd2010-08-23 01:21:21 +0000182ItaniumCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
183 if (MPT->isMemberDataPointer())
184 return getPtrDiffTy();
Chris Lattner7650d952011-06-18 22:49:11 +0000185 return llvm::StructType::get(getPtrDiffTy(), getPtrDiffTy(), NULL);
John McCall875ab102010-08-22 06:43:33 +0000186}
187
John McCallbabc9a92010-08-22 00:59:17 +0000188/// In the Itanium and ARM ABIs, method pointers have the form:
189/// struct { ptrdiff_t ptr; ptrdiff_t adj; } memptr;
190///
191/// In the Itanium ABI:
192/// - method pointers are virtual if (memptr.ptr & 1) is nonzero
193/// - the this-adjustment is (memptr.adj)
194/// - the virtual offset is (memptr.ptr - 1)
195///
196/// In the ARM ABI:
197/// - method pointers are virtual if (memptr.adj & 1) is nonzero
198/// - the this-adjustment is (memptr.adj >> 1)
199/// - the virtual offset is (memptr.ptr)
200/// ARM uses 'adj' for the virtual flag because Thumb functions
201/// may be only single-byte aligned.
202///
203/// If the member is virtual, the adjusted 'this' pointer points
204/// to a vtable pointer from which the virtual offset is applied.
205///
206/// If the member is non-virtual, memptr.ptr is the address of
207/// the function to call.
John McCall93d557b2010-08-22 00:05:51 +0000208llvm::Value *
209ItaniumCXXABI::EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF,
210 llvm::Value *&This,
211 llvm::Value *MemFnPtr,
212 const MemberPointerType *MPT) {
213 CGBuilderTy &Builder = CGF.Builder;
214
215 const FunctionProtoType *FPT =
216 MPT->getPointeeType()->getAs<FunctionProtoType>();
217 const CXXRecordDecl *RD =
218 cast<CXXRecordDecl>(MPT->getClass()->getAs<RecordType>()->getDecl());
219
Chris Lattner2acc6e32011-07-18 04:24:23 +0000220 llvm::FunctionType *FTy =
John McCallde5d3c72012-02-17 03:33:10 +0000221 CGM.getTypes().GetFunctionType(
222 CGM.getTypes().arrangeCXXMethodType(RD, FPT));
John McCall93d557b2010-08-22 00:05:51 +0000223
Chris Lattner2acc6e32011-07-18 04:24:23 +0000224 llvm::IntegerType *ptrdiff = getPtrDiffTy();
John McCallbabc9a92010-08-22 00:59:17 +0000225 llvm::Constant *ptrdiff_1 = llvm::ConstantInt::get(ptrdiff, 1);
John McCall93d557b2010-08-22 00:05:51 +0000226
John McCallbabc9a92010-08-22 00:59:17 +0000227 llvm::BasicBlock *FnVirtual = CGF.createBasicBlock("memptr.virtual");
228 llvm::BasicBlock *FnNonVirtual = CGF.createBasicBlock("memptr.nonvirtual");
229 llvm::BasicBlock *FnEnd = CGF.createBasicBlock("memptr.end");
230
John McCalld608cdb2010-08-22 10:59:02 +0000231 // Extract memptr.adj, which is in the second field.
232 llvm::Value *RawAdj = Builder.CreateExtractValue(MemFnPtr, 1, "memptr.adj");
John McCallbabc9a92010-08-22 00:59:17 +0000233
234 // Compute the true adjustment.
235 llvm::Value *Adj = RawAdj;
236 if (IsARM)
237 Adj = Builder.CreateAShr(Adj, ptrdiff_1, "memptr.adj.shifted");
John McCall93d557b2010-08-22 00:05:51 +0000238
239 // Apply the adjustment and cast back to the original struct type
240 // for consistency.
John McCallbabc9a92010-08-22 00:59:17 +0000241 llvm::Value *Ptr = Builder.CreateBitCast(This, Builder.getInt8PtrTy());
242 Ptr = Builder.CreateInBoundsGEP(Ptr, Adj);
243 This = Builder.CreateBitCast(Ptr, This->getType(), "this.adjusted");
John McCall93d557b2010-08-22 00:05:51 +0000244
245 // Load the function pointer.
John McCalld608cdb2010-08-22 10:59:02 +0000246 llvm::Value *FnAsInt = Builder.CreateExtractValue(MemFnPtr, 0, "memptr.ptr");
John McCall93d557b2010-08-22 00:05:51 +0000247
248 // If the LSB in the function pointer is 1, the function pointer points to
249 // a virtual function.
John McCallbabc9a92010-08-22 00:59:17 +0000250 llvm::Value *IsVirtual;
251 if (IsARM)
252 IsVirtual = Builder.CreateAnd(RawAdj, ptrdiff_1);
253 else
254 IsVirtual = Builder.CreateAnd(FnAsInt, ptrdiff_1);
255 IsVirtual = Builder.CreateIsNotNull(IsVirtual, "memptr.isvirtual");
John McCall93d557b2010-08-22 00:05:51 +0000256 Builder.CreateCondBr(IsVirtual, FnVirtual, FnNonVirtual);
257
258 // In the virtual path, the adjustment left 'This' pointing to the
259 // vtable of the correct base subobject. The "function pointer" is an
John McCallbabc9a92010-08-22 00:59:17 +0000260 // offset within the vtable (+1 for the virtual flag on non-ARM).
John McCall93d557b2010-08-22 00:05:51 +0000261 CGF.EmitBlock(FnVirtual);
262
263 // Cast the adjusted this to a pointer to vtable pointer and load.
Chris Lattner2acc6e32011-07-18 04:24:23 +0000264 llvm::Type *VTableTy = Builder.getInt8PtrTy();
John McCall93d557b2010-08-22 00:05:51 +0000265 llvm::Value *VTable = Builder.CreateBitCast(This, VTableTy->getPointerTo());
John McCallbabc9a92010-08-22 00:59:17 +0000266 VTable = Builder.CreateLoad(VTable, "memptr.vtable");
John McCall93d557b2010-08-22 00:05:51 +0000267
268 // Apply the offset.
John McCallbabc9a92010-08-22 00:59:17 +0000269 llvm::Value *VTableOffset = FnAsInt;
270 if (!IsARM) VTableOffset = Builder.CreateSub(VTableOffset, ptrdiff_1);
271 VTable = Builder.CreateGEP(VTable, VTableOffset);
John McCall93d557b2010-08-22 00:05:51 +0000272
273 // Load the virtual function to call.
274 VTable = Builder.CreateBitCast(VTable, FTy->getPointerTo()->getPointerTo());
John McCallbabc9a92010-08-22 00:59:17 +0000275 llvm::Value *VirtualFn = Builder.CreateLoad(VTable, "memptr.virtualfn");
John McCall93d557b2010-08-22 00:05:51 +0000276 CGF.EmitBranch(FnEnd);
277
278 // In the non-virtual path, the function pointer is actually a
279 // function pointer.
280 CGF.EmitBlock(FnNonVirtual);
281 llvm::Value *NonVirtualFn =
John McCallbabc9a92010-08-22 00:59:17 +0000282 Builder.CreateIntToPtr(FnAsInt, FTy->getPointerTo(), "memptr.nonvirtualfn");
John McCall93d557b2010-08-22 00:05:51 +0000283
284 // We're done.
285 CGF.EmitBlock(FnEnd);
Jay Foadbbf3bac2011-03-30 11:28:58 +0000286 llvm::PHINode *Callee = Builder.CreatePHI(FTy->getPointerTo(), 2);
John McCall93d557b2010-08-22 00:05:51 +0000287 Callee->addIncoming(VirtualFn, FnVirtual);
288 Callee->addIncoming(NonVirtualFn, FnNonVirtual);
289 return Callee;
290}
John McCall3023def2010-08-22 03:04:22 +0000291
John McCall6c2ab1d2010-08-31 21:07:20 +0000292/// Compute an l-value by applying the given pointer-to-member to a
293/// base object.
294llvm::Value *ItaniumCXXABI::EmitMemberDataPointerAddress(CodeGenFunction &CGF,
295 llvm::Value *Base,
296 llvm::Value *MemPtr,
297 const MemberPointerType *MPT) {
298 assert(MemPtr->getType() == getPtrDiffTy());
299
300 CGBuilderTy &Builder = CGF.Builder;
301
302 unsigned AS = cast<llvm::PointerType>(Base->getType())->getAddressSpace();
303
304 // Cast to char*.
305 Base = Builder.CreateBitCast(Base, Builder.getInt8Ty()->getPointerTo(AS));
306
307 // Apply the offset, which we assume is non-null.
308 llvm::Value *Addr = Builder.CreateInBoundsGEP(Base, MemPtr, "memptr.offset");
309
310 // Cast the address to the appropriate pointer type, adopting the
311 // address space of the base pointer.
Chris Lattner2acc6e32011-07-18 04:24:23 +0000312 llvm::Type *PType
Douglas Gregoreede61a2010-09-02 17:38:50 +0000313 = CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
John McCall6c2ab1d2010-08-31 21:07:20 +0000314 return Builder.CreateBitCast(Addr, PType);
315}
316
John McCall4d4e5c12012-02-15 01:22:51 +0000317/// Perform a bitcast, derived-to-base, or base-to-derived member pointer
318/// conversion.
319///
320/// Bitcast conversions are always a no-op under Itanium.
John McCall0bab0cd2010-08-23 01:21:21 +0000321///
322/// Obligatory offset/adjustment diagram:
323/// <-- offset --> <-- adjustment -->
324/// |--------------------------|----------------------|--------------------|
325/// ^Derived address point ^Base address point ^Member address point
326///
327/// So when converting a base member pointer to a derived member pointer,
328/// we add the offset to the adjustment because the address point has
329/// decreased; and conversely, when converting a derived MP to a base MP
330/// we subtract the offset from the adjustment because the address point
331/// has increased.
332///
333/// The standard forbids (at compile time) conversion to and from
334/// virtual bases, which is why we don't have to consider them here.
335///
336/// The standard forbids (at run time) casting a derived MP to a base
337/// MP when the derived MP does not point to a member of the base.
338/// This is why -1 is a reasonable choice for null data member
339/// pointers.
John McCalld608cdb2010-08-22 10:59:02 +0000340llvm::Value *
John McCall0bab0cd2010-08-23 01:21:21 +0000341ItaniumCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
342 const CastExpr *E,
John McCall4d4e5c12012-02-15 01:22:51 +0000343 llvm::Value *src) {
John McCall2de56d12010-08-25 11:45:40 +0000344 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
John McCall4d4e5c12012-02-15 01:22:51 +0000345 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
346 E->getCastKind() == CK_ReinterpretMemberPointer);
347
348 // Under Itanium, reinterprets don't require any additional processing.
349 if (E->getCastKind() == CK_ReinterpretMemberPointer) return src;
350
351 // Use constant emission if we can.
352 if (isa<llvm::Constant>(src))
353 return EmitMemberPointerConversion(E, cast<llvm::Constant>(src));
354
355 llvm::Constant *adj = getMemberPointerAdjustment(E);
356 if (!adj) return src;
John McCall3023def2010-08-22 03:04:22 +0000357
358 CGBuilderTy &Builder = CGF.Builder;
John McCall4d4e5c12012-02-15 01:22:51 +0000359 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
John McCall3023def2010-08-22 03:04:22 +0000360
John McCall4d4e5c12012-02-15 01:22:51 +0000361 const MemberPointerType *destTy =
362 E->getType()->castAs<MemberPointerType>();
John McCall875ab102010-08-22 06:43:33 +0000363
John McCall0bab0cd2010-08-23 01:21:21 +0000364 // For member data pointers, this is just a matter of adding the
365 // offset if the source is non-null.
John McCall4d4e5c12012-02-15 01:22:51 +0000366 if (destTy->isMemberDataPointer()) {
367 llvm::Value *dst;
368 if (isDerivedToBase)
369 dst = Builder.CreateNSWSub(src, adj, "adj");
John McCall0bab0cd2010-08-23 01:21:21 +0000370 else
John McCall4d4e5c12012-02-15 01:22:51 +0000371 dst = Builder.CreateNSWAdd(src, adj, "adj");
John McCall0bab0cd2010-08-23 01:21:21 +0000372
373 // Null check.
John McCall4d4e5c12012-02-15 01:22:51 +0000374 llvm::Value *null = llvm::Constant::getAllOnesValue(src->getType());
375 llvm::Value *isNull = Builder.CreateICmpEQ(src, null, "memptr.isnull");
376 return Builder.CreateSelect(isNull, src, dst);
John McCall0bab0cd2010-08-23 01:21:21 +0000377 }
378
John McCalld608cdb2010-08-22 10:59:02 +0000379 // The this-adjustment is left-shifted by 1 on ARM.
380 if (IsARM) {
John McCall4d4e5c12012-02-15 01:22:51 +0000381 uint64_t offset = cast<llvm::ConstantInt>(adj)->getZExtValue();
382 offset <<= 1;
383 adj = llvm::ConstantInt::get(adj->getType(), offset);
John McCalld608cdb2010-08-22 10:59:02 +0000384 }
385
John McCall4d4e5c12012-02-15 01:22:51 +0000386 llvm::Value *srcAdj = Builder.CreateExtractValue(src, 1, "src.adj");
387 llvm::Value *dstAdj;
388 if (isDerivedToBase)
389 dstAdj = Builder.CreateNSWSub(srcAdj, adj, "adj");
John McCalld608cdb2010-08-22 10:59:02 +0000390 else
John McCall4d4e5c12012-02-15 01:22:51 +0000391 dstAdj = Builder.CreateNSWAdd(srcAdj, adj, "adj");
John McCalld608cdb2010-08-22 10:59:02 +0000392
John McCall4d4e5c12012-02-15 01:22:51 +0000393 return Builder.CreateInsertValue(src, dstAdj, 1);
394}
395
396llvm::Constant *
397ItaniumCXXABI::EmitMemberPointerConversion(const CastExpr *E,
398 llvm::Constant *src) {
399 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
400 E->getCastKind() == CK_BaseToDerivedMemberPointer ||
401 E->getCastKind() == CK_ReinterpretMemberPointer);
402
403 // Under Itanium, reinterprets don't require any additional processing.
404 if (E->getCastKind() == CK_ReinterpretMemberPointer) return src;
405
406 // If the adjustment is trivial, we don't need to do anything.
407 llvm::Constant *adj = getMemberPointerAdjustment(E);
408 if (!adj) return src;
409
410 bool isDerivedToBase = (E->getCastKind() == CK_DerivedToBaseMemberPointer);
411
412 const MemberPointerType *destTy =
413 E->getType()->castAs<MemberPointerType>();
414
415 // For member data pointers, this is just a matter of adding the
416 // offset if the source is non-null.
417 if (destTy->isMemberDataPointer()) {
418 // null maps to null.
419 if (src->isAllOnesValue()) return src;
420
421 if (isDerivedToBase)
422 return llvm::ConstantExpr::getNSWSub(src, adj);
423 else
424 return llvm::ConstantExpr::getNSWAdd(src, adj);
425 }
426
427 // The this-adjustment is left-shifted by 1 on ARM.
428 if (IsARM) {
429 uint64_t offset = cast<llvm::ConstantInt>(adj)->getZExtValue();
430 offset <<= 1;
431 adj = llvm::ConstantInt::get(adj->getType(), offset);
432 }
433
434 llvm::Constant *srcAdj = llvm::ConstantExpr::getExtractValue(src, 1);
435 llvm::Constant *dstAdj;
436 if (isDerivedToBase)
437 dstAdj = llvm::ConstantExpr::getNSWSub(srcAdj, adj);
438 else
439 dstAdj = llvm::ConstantExpr::getNSWAdd(srcAdj, adj);
440
441 return llvm::ConstantExpr::getInsertValue(src, dstAdj, 1);
John McCall3023def2010-08-22 03:04:22 +0000442}
John McCallcf2c85e2010-08-22 04:16:24 +0000443
444llvm::Constant *
John McCall0bab0cd2010-08-23 01:21:21 +0000445ItaniumCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
Chris Lattner2acc6e32011-07-18 04:24:23 +0000446 llvm::Type *ptrdiff_t = getPtrDiffTy();
John McCall0bab0cd2010-08-23 01:21:21 +0000447
448 // Itanium C++ ABI 2.3:
449 // A NULL pointer is represented as -1.
450 if (MPT->isMemberDataPointer())
451 return llvm::ConstantInt::get(ptrdiff_t, -1ULL, /*isSigned=*/true);
John McCalld608cdb2010-08-22 10:59:02 +0000452
453 llvm::Constant *Zero = llvm::ConstantInt::get(ptrdiff_t, 0);
454 llvm::Constant *Values[2] = { Zero, Zero };
Chris Lattnerc5cbb902011-06-20 04:01:35 +0000455 return llvm::ConstantStruct::getAnon(Values);
John McCallcf2c85e2010-08-22 04:16:24 +0000456}
457
John McCall5808ce42011-02-03 08:15:49 +0000458llvm::Constant *
459ItaniumCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
460 CharUnits offset) {
John McCall0bab0cd2010-08-23 01:21:21 +0000461 // Itanium C++ ABI 2.3:
462 // A pointer to data member is an offset from the base address of
463 // the class object containing it, represented as a ptrdiff_t
John McCall5808ce42011-02-03 08:15:49 +0000464 return llvm::ConstantInt::get(getPtrDiffTy(), offset.getQuantity());
John McCall0bab0cd2010-08-23 01:21:21 +0000465}
466
John McCall755d8492011-04-12 00:42:48 +0000467llvm::Constant *ItaniumCXXABI::EmitMemberPointer(const CXXMethodDecl *MD) {
Richard Smith2d6a5672012-01-14 04:30:29 +0000468 return BuildMemberPointer(MD, CharUnits::Zero());
469}
470
471llvm::Constant *ItaniumCXXABI::BuildMemberPointer(const CXXMethodDecl *MD,
472 CharUnits ThisAdjustment) {
John McCalld608cdb2010-08-22 10:59:02 +0000473 assert(MD->isInstance() && "Member function must not be static!");
474 MD = MD->getCanonicalDecl();
475
476 CodeGenTypes &Types = CGM.getTypes();
Chris Lattner2acc6e32011-07-18 04:24:23 +0000477 llvm::Type *ptrdiff_t = getPtrDiffTy();
John McCalld608cdb2010-08-22 10:59:02 +0000478
479 // Get the function pointer (or index if this is a virtual function).
480 llvm::Constant *MemPtr[2];
481 if (MD->isVirtual()) {
Peter Collingbourne1d2b3172011-09-26 01:56:30 +0000482 uint64_t Index = CGM.getVTableContext().getMethodVTableIndex(MD);
John McCalld608cdb2010-08-22 10:59:02 +0000483
Ken Dyck1246ba62011-04-09 01:30:02 +0000484 const ASTContext &Context = getContext();
485 CharUnits PointerWidth =
Douglas Gregorbcfd1f52011-09-02 00:18:52 +0000486 Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
Ken Dyck1246ba62011-04-09 01:30:02 +0000487 uint64_t VTableOffset = (Index * PointerWidth.getQuantity());
John McCalld608cdb2010-08-22 10:59:02 +0000488
489 if (IsARM) {
490 // ARM C++ ABI 3.2.1:
491 // This ABI specifies that adj contains twice the this
492 // adjustment, plus 1 if the member function is virtual. The
493 // least significant bit of adj then makes exactly the same
494 // discrimination as the least significant bit of ptr does for
495 // Itanium.
496 MemPtr[0] = llvm::ConstantInt::get(ptrdiff_t, VTableOffset);
Richard Smith2d6a5672012-01-14 04:30:29 +0000497 MemPtr[1] = llvm::ConstantInt::get(ptrdiff_t,
498 2 * ThisAdjustment.getQuantity() + 1);
John McCalld608cdb2010-08-22 10:59:02 +0000499 } else {
500 // Itanium C++ ABI 2.3:
501 // For a virtual function, [the pointer field] is 1 plus the
502 // virtual table offset (in bytes) of the function,
503 // represented as a ptrdiff_t.
504 MemPtr[0] = llvm::ConstantInt::get(ptrdiff_t, VTableOffset + 1);
Richard Smith2d6a5672012-01-14 04:30:29 +0000505 MemPtr[1] = llvm::ConstantInt::get(ptrdiff_t,
506 ThisAdjustment.getQuantity());
John McCalld608cdb2010-08-22 10:59:02 +0000507 }
508 } else {
John McCall755d8492011-04-12 00:42:48 +0000509 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
Chris Lattner2acc6e32011-07-18 04:24:23 +0000510 llvm::Type *Ty;
John McCall755d8492011-04-12 00:42:48 +0000511 // Check whether the function has a computable LLVM signature.
Chris Lattnerf742eb02011-07-10 00:18:59 +0000512 if (Types.isFuncTypeConvertible(FPT)) {
John McCall755d8492011-04-12 00:42:48 +0000513 // The function has a computable LLVM signature; use the correct type.
John McCallde5d3c72012-02-17 03:33:10 +0000514 Ty = Types.GetFunctionType(Types.arrangeCXXMethodDeclaration(MD));
John McCalld608cdb2010-08-22 10:59:02 +0000515 } else {
John McCall755d8492011-04-12 00:42:48 +0000516 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
517 // function type is incomplete.
518 Ty = ptrdiff_t;
John McCalld608cdb2010-08-22 10:59:02 +0000519 }
John McCall755d8492011-04-12 00:42:48 +0000520 llvm::Constant *addr = CGM.GetAddrOfFunction(MD, Ty);
John McCalld608cdb2010-08-22 10:59:02 +0000521
John McCall379b5152011-04-11 07:02:50 +0000522 MemPtr[0] = llvm::ConstantExpr::getPtrToInt(addr, ptrdiff_t);
Richard Smith2d6a5672012-01-14 04:30:29 +0000523 MemPtr[1] = llvm::ConstantInt::get(ptrdiff_t, (IsARM ? 2 : 1) *
524 ThisAdjustment.getQuantity());
John McCalld608cdb2010-08-22 10:59:02 +0000525 }
John McCall875ab102010-08-22 06:43:33 +0000526
Chris Lattnerc5cbb902011-06-20 04:01:35 +0000527 return llvm::ConstantStruct::getAnon(MemPtr);
John McCall875ab102010-08-22 06:43:33 +0000528}
529
Richard Smith2d6a5672012-01-14 04:30:29 +0000530llvm::Constant *ItaniumCXXABI::EmitMemberPointer(const APValue &MP,
531 QualType MPType) {
532 const MemberPointerType *MPT = MPType->castAs<MemberPointerType>();
533 const ValueDecl *MPD = MP.getMemberPointerDecl();
534 if (!MPD)
535 return EmitNullMemberPointer(MPT);
536
537 // Compute the this-adjustment.
538 CharUnits ThisAdjustment = CharUnits::Zero();
539 ArrayRef<const CXXRecordDecl*> Path = MP.getMemberPointerPath();
540 bool DerivedMember = MP.isMemberPointerToDerivedMember();
541 const CXXRecordDecl *RD = cast<CXXRecordDecl>(MPD->getDeclContext());
542 for (unsigned I = 0, N = Path.size(); I != N; ++I) {
543 const CXXRecordDecl *Base = RD;
544 const CXXRecordDecl *Derived = Path[I];
545 if (DerivedMember)
546 std::swap(Base, Derived);
547 ThisAdjustment +=
548 getContext().getASTRecordLayout(Derived).getBaseClassOffset(Base);
549 RD = Path[I];
550 }
551 if (DerivedMember)
552 ThisAdjustment = -ThisAdjustment;
553
554 if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(MPD))
555 return BuildMemberPointer(MD, ThisAdjustment);
556
557 CharUnits FieldOffset =
558 getContext().toCharUnitsFromBits(getContext().getFieldOffset(MPD));
559 return EmitMemberDataPointer(MPT, ThisAdjustment + FieldOffset);
560}
561
John McCalle9fd7eb2010-08-22 08:30:07 +0000562/// The comparison algorithm is pretty easy: the member pointers are
563/// the same if they're either bitwise identical *or* both null.
564///
565/// ARM is different here only because null-ness is more complicated.
566llvm::Value *
John McCall0bab0cd2010-08-23 01:21:21 +0000567ItaniumCXXABI::EmitMemberPointerComparison(CodeGenFunction &CGF,
568 llvm::Value *L,
569 llvm::Value *R,
570 const MemberPointerType *MPT,
571 bool Inequality) {
John McCalle9fd7eb2010-08-22 08:30:07 +0000572 CGBuilderTy &Builder = CGF.Builder;
573
John McCalle9fd7eb2010-08-22 08:30:07 +0000574 llvm::ICmpInst::Predicate Eq;
575 llvm::Instruction::BinaryOps And, Or;
576 if (Inequality) {
577 Eq = llvm::ICmpInst::ICMP_NE;
578 And = llvm::Instruction::Or;
579 Or = llvm::Instruction::And;
580 } else {
581 Eq = llvm::ICmpInst::ICMP_EQ;
582 And = llvm::Instruction::And;
583 Or = llvm::Instruction::Or;
584 }
585
John McCall0bab0cd2010-08-23 01:21:21 +0000586 // Member data pointers are easy because there's a unique null
587 // value, so it just comes down to bitwise equality.
588 if (MPT->isMemberDataPointer())
589 return Builder.CreateICmp(Eq, L, R);
590
591 // For member function pointers, the tautologies are more complex.
592 // The Itanium tautology is:
John McCallde719f72010-08-23 06:56:36 +0000593 // (L == R) <==> (L.ptr == R.ptr && (L.ptr == 0 || L.adj == R.adj))
John McCall0bab0cd2010-08-23 01:21:21 +0000594 // The ARM tautology is:
John McCallde719f72010-08-23 06:56:36 +0000595 // (L == R) <==> (L.ptr == R.ptr &&
596 // (L.adj == R.adj ||
597 // (L.ptr == 0 && ((L.adj|R.adj) & 1) == 0)))
John McCall0bab0cd2010-08-23 01:21:21 +0000598 // The inequality tautologies have exactly the same structure, except
599 // applying De Morgan's laws.
600
601 llvm::Value *LPtr = Builder.CreateExtractValue(L, 0, "lhs.memptr.ptr");
602 llvm::Value *RPtr = Builder.CreateExtractValue(R, 0, "rhs.memptr.ptr");
603
John McCalle9fd7eb2010-08-22 08:30:07 +0000604 // This condition tests whether L.ptr == R.ptr. This must always be
605 // true for equality to hold.
606 llvm::Value *PtrEq = Builder.CreateICmp(Eq, LPtr, RPtr, "cmp.ptr");
607
608 // This condition, together with the assumption that L.ptr == R.ptr,
609 // tests whether the pointers are both null. ARM imposes an extra
610 // condition.
611 llvm::Value *Zero = llvm::Constant::getNullValue(LPtr->getType());
612 llvm::Value *EqZero = Builder.CreateICmp(Eq, LPtr, Zero, "cmp.ptr.null");
613
614 // This condition tests whether L.adj == R.adj. If this isn't
615 // true, the pointers are unequal unless they're both null.
John McCalld608cdb2010-08-22 10:59:02 +0000616 llvm::Value *LAdj = Builder.CreateExtractValue(L, 1, "lhs.memptr.adj");
617 llvm::Value *RAdj = Builder.CreateExtractValue(R, 1, "rhs.memptr.adj");
John McCalle9fd7eb2010-08-22 08:30:07 +0000618 llvm::Value *AdjEq = Builder.CreateICmp(Eq, LAdj, RAdj, "cmp.adj");
619
620 // Null member function pointers on ARM clear the low bit of Adj,
621 // so the zero condition has to check that neither low bit is set.
622 if (IsARM) {
623 llvm::Value *One = llvm::ConstantInt::get(LPtr->getType(), 1);
624
625 // Compute (l.adj | r.adj) & 1 and test it against zero.
626 llvm::Value *OrAdj = Builder.CreateOr(LAdj, RAdj, "or.adj");
627 llvm::Value *OrAdjAnd1 = Builder.CreateAnd(OrAdj, One);
628 llvm::Value *OrAdjAnd1EqZero = Builder.CreateICmp(Eq, OrAdjAnd1, Zero,
629 "cmp.or.adj");
630 EqZero = Builder.CreateBinOp(And, EqZero, OrAdjAnd1EqZero);
631 }
632
633 // Tie together all our conditions.
634 llvm::Value *Result = Builder.CreateBinOp(Or, EqZero, AdjEq);
635 Result = Builder.CreateBinOp(And, PtrEq, Result,
636 Inequality ? "memptr.ne" : "memptr.eq");
637 return Result;
638}
639
640llvm::Value *
John McCall0bab0cd2010-08-23 01:21:21 +0000641ItaniumCXXABI::EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
642 llvm::Value *MemPtr,
643 const MemberPointerType *MPT) {
John McCalle9fd7eb2010-08-22 08:30:07 +0000644 CGBuilderTy &Builder = CGF.Builder;
John McCall0bab0cd2010-08-23 01:21:21 +0000645
646 /// For member data pointers, this is just a check against -1.
647 if (MPT->isMemberDataPointer()) {
648 assert(MemPtr->getType() == getPtrDiffTy());
649 llvm::Value *NegativeOne =
650 llvm::Constant::getAllOnesValue(MemPtr->getType());
651 return Builder.CreateICmpNE(MemPtr, NegativeOne, "memptr.tobool");
652 }
John McCalle9fd7eb2010-08-22 08:30:07 +0000653
Daniel Dunbardb27b5f2011-04-19 23:10:47 +0000654 // In Itanium, a member function pointer is not null if 'ptr' is not null.
John McCalld608cdb2010-08-22 10:59:02 +0000655 llvm::Value *Ptr = Builder.CreateExtractValue(MemPtr, 0, "memptr.ptr");
John McCalle9fd7eb2010-08-22 08:30:07 +0000656
657 llvm::Constant *Zero = llvm::ConstantInt::get(Ptr->getType(), 0);
658 llvm::Value *Result = Builder.CreateICmpNE(Ptr, Zero, "memptr.tobool");
659
Daniel Dunbardb27b5f2011-04-19 23:10:47 +0000660 // On ARM, a member function pointer is also non-null if the low bit of 'adj'
661 // (the virtual bit) is set.
John McCalle9fd7eb2010-08-22 08:30:07 +0000662 if (IsARM) {
663 llvm::Constant *One = llvm::ConstantInt::get(Ptr->getType(), 1);
John McCalld608cdb2010-08-22 10:59:02 +0000664 llvm::Value *Adj = Builder.CreateExtractValue(MemPtr, 1, "memptr.adj");
John McCalle9fd7eb2010-08-22 08:30:07 +0000665 llvm::Value *VirtualBit = Builder.CreateAnd(Adj, One, "memptr.virtualbit");
Daniel Dunbardb27b5f2011-04-19 23:10:47 +0000666 llvm::Value *IsVirtual = Builder.CreateICmpNE(VirtualBit, Zero,
667 "memptr.isvirtual");
668 Result = Builder.CreateOr(Result, IsVirtual);
John McCalle9fd7eb2010-08-22 08:30:07 +0000669 }
670
671 return Result;
672}
John McCall875ab102010-08-22 06:43:33 +0000673
John McCallf16aa102010-08-22 21:01:12 +0000674/// The Itanium ABI requires non-zero initialization only for data
675/// member pointers, for which '0' is a valid offset.
676bool ItaniumCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
677 return MPT->getPointeeType()->isFunctionType();
John McCallcf2c85e2010-08-22 04:16:24 +0000678}
John McCall4c40d982010-08-31 07:33:07 +0000679
680/// The generic ABI passes 'this', plus a VTT if it's initializing a
681/// base subobject.
682void ItaniumCXXABI::BuildConstructorSignature(const CXXConstructorDecl *Ctor,
683 CXXCtorType Type,
684 CanQualType &ResTy,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000685 SmallVectorImpl<CanQualType> &ArgTys) {
John McCall9cb2cee2010-09-02 10:25:57 +0000686 ASTContext &Context = getContext();
John McCall4c40d982010-08-31 07:33:07 +0000687
688 // 'this' is already there.
689
690 // Check if we need to add a VTT parameter (which has type void **).
691 if (Type == Ctor_Base && Ctor->getParent()->getNumVBases() != 0)
692 ArgTys.push_back(Context.getPointerType(Context.VoidPtrTy));
693}
694
695/// The ARM ABI does the same as the Itanium ABI, but returns 'this'.
696void ARMCXXABI::BuildConstructorSignature(const CXXConstructorDecl *Ctor,
697 CXXCtorType Type,
698 CanQualType &ResTy,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000699 SmallVectorImpl<CanQualType> &ArgTys) {
John McCall4c40d982010-08-31 07:33:07 +0000700 ItaniumCXXABI::BuildConstructorSignature(Ctor, Type, ResTy, ArgTys);
701 ResTy = ArgTys[0];
702}
703
704/// The generic ABI passes 'this', plus a VTT if it's destroying a
705/// base subobject.
706void ItaniumCXXABI::BuildDestructorSignature(const CXXDestructorDecl *Dtor,
707 CXXDtorType Type,
708 CanQualType &ResTy,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000709 SmallVectorImpl<CanQualType> &ArgTys) {
John McCall9cb2cee2010-09-02 10:25:57 +0000710 ASTContext &Context = getContext();
John McCall4c40d982010-08-31 07:33:07 +0000711
712 // 'this' is already there.
713
714 // Check if we need to add a VTT parameter (which has type void **).
715 if (Type == Dtor_Base && Dtor->getParent()->getNumVBases() != 0)
716 ArgTys.push_back(Context.getPointerType(Context.VoidPtrTy));
717}
718
719/// The ARM ABI does the same as the Itanium ABI, but returns 'this'
720/// for non-deleting destructors.
721void ARMCXXABI::BuildDestructorSignature(const CXXDestructorDecl *Dtor,
722 CXXDtorType Type,
723 CanQualType &ResTy,
Chris Lattner5f9e2722011-07-23 10:55:15 +0000724 SmallVectorImpl<CanQualType> &ArgTys) {
John McCall4c40d982010-08-31 07:33:07 +0000725 ItaniumCXXABI::BuildDestructorSignature(Dtor, Type, ResTy, ArgTys);
726
727 if (Type != Dtor_Deleting)
728 ResTy = ArgTys[0];
729}
730
731void ItaniumCXXABI::BuildInstanceFunctionParams(CodeGenFunction &CGF,
732 QualType &ResTy,
733 FunctionArgList &Params) {
734 /// Create the 'this' variable.
735 BuildThisParam(CGF, Params);
736
737 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
738 assert(MD->isInstance());
739
740 // Check if we need a VTT parameter as well.
741 if (CodeGenVTables::needsVTTParameter(CGF.CurGD)) {
John McCall9cb2cee2010-09-02 10:25:57 +0000742 ASTContext &Context = getContext();
John McCall4c40d982010-08-31 07:33:07 +0000743
744 // FIXME: avoid the fake decl
745 QualType T = Context.getPointerType(Context.VoidPtrTy);
746 ImplicitParamDecl *VTTDecl
747 = ImplicitParamDecl::Create(Context, 0, MD->getLocation(),
748 &Context.Idents.get("vtt"), T);
John McCalld26bc762011-03-09 04:27:21 +0000749 Params.push_back(VTTDecl);
John McCall4c40d982010-08-31 07:33:07 +0000750 getVTTDecl(CGF) = VTTDecl;
751 }
752}
753
754void ARMCXXABI::BuildInstanceFunctionParams(CodeGenFunction &CGF,
755 QualType &ResTy,
756 FunctionArgList &Params) {
757 ItaniumCXXABI::BuildInstanceFunctionParams(CGF, ResTy, Params);
758
759 // Return 'this' from certain constructors and destructors.
760 if (HasThisReturn(CGF.CurGD))
John McCalld26bc762011-03-09 04:27:21 +0000761 ResTy = Params[0]->getType();
John McCall4c40d982010-08-31 07:33:07 +0000762}
763
764void ItaniumCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
765 /// Initialize the 'this' slot.
766 EmitThisParam(CGF);
767
768 /// Initialize the 'vtt' slot if needed.
769 if (getVTTDecl(CGF)) {
770 getVTTValue(CGF)
771 = CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(getVTTDecl(CGF)),
772 "vtt");
773 }
774}
775
776void ARMCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
777 ItaniumCXXABI::EmitInstanceFunctionProlog(CGF);
778
779 /// Initialize the return slot to 'this' at the start of the
780 /// function.
781 if (HasThisReturn(CGF.CurGD))
Eli Friedmancec5ebd2012-02-11 02:57:39 +0000782 CGF.Builder.CreateStore(getThisValue(CGF), CGF.ReturnValue);
John McCall4c40d982010-08-31 07:33:07 +0000783}
784
785void ARMCXXABI::EmitReturnFromThunk(CodeGenFunction &CGF,
786 RValue RV, QualType ResultType) {
787 if (!isa<CXXDestructorDecl>(CGF.CurGD.getDecl()))
788 return ItaniumCXXABI::EmitReturnFromThunk(CGF, RV, ResultType);
789
790 // Destructor thunks in the ARM ABI have indeterminate results.
Chris Lattner2acc6e32011-07-18 04:24:23 +0000791 llvm::Type *T =
John McCall4c40d982010-08-31 07:33:07 +0000792 cast<llvm::PointerType>(CGF.ReturnValue->getType())->getElementType();
793 RValue Undef = RValue::get(llvm::UndefValue::get(T));
794 return ItaniumCXXABI::EmitReturnFromThunk(CGF, Undef, ResultType);
795}
John McCall1e7fe752010-09-02 09:58:18 +0000796
797/************************** Array allocation cookies **************************/
798
John McCall6ec278d2011-01-27 09:37:56 +0000799bool ItaniumCXXABI::NeedsArrayCookie(const CXXNewExpr *expr) {
John McCall1e7fe752010-09-02 09:58:18 +0000800 // If the class's usual deallocation function takes two arguments,
John McCall6ec278d2011-01-27 09:37:56 +0000801 // it needs a cookie.
802 if (expr->doesUsualArrayDeleteWantSize())
803 return true;
John McCall1e7fe752010-09-02 09:58:18 +0000804
John McCallf85e1932011-06-15 23:02:42 +0000805 // Automatic Reference Counting:
806 // We need an array cookie for pointers with strong or weak lifetime.
807 QualType AllocatedType = expr->getAllocatedType();
David Blaikie4e4d0842012-03-11 07:00:24 +0000808 if (getContext().getLangOpts().ObjCAutoRefCount &&
John McCallf85e1932011-06-15 23:02:42 +0000809 AllocatedType->isObjCLifetimeType()) {
810 switch (AllocatedType.getObjCLifetime()) {
811 case Qualifiers::OCL_None:
812 case Qualifiers::OCL_ExplicitNone:
813 case Qualifiers::OCL_Autoreleasing:
814 return false;
815
816 case Qualifiers::OCL_Strong:
817 case Qualifiers::OCL_Weak:
818 return true;
819 }
820 }
821
John McCall6ec278d2011-01-27 09:37:56 +0000822 // Otherwise, if the class has a non-trivial destructor, it always
823 // needs a cookie.
824 const CXXRecordDecl *record =
John McCallf85e1932011-06-15 23:02:42 +0000825 AllocatedType->getBaseElementTypeUnsafe()->getAsCXXRecordDecl();
John McCall6ec278d2011-01-27 09:37:56 +0000826 return (record && !record->hasTrivialDestructor());
John McCall1e7fe752010-09-02 09:58:18 +0000827}
828
John McCall6ec278d2011-01-27 09:37:56 +0000829bool ItaniumCXXABI::NeedsArrayCookie(const CXXDeleteExpr *expr,
830 QualType elementType) {
831 // If the class's usual deallocation function takes two arguments,
832 // it needs a cookie.
833 if (expr->doesUsualArrayDeleteWantSize())
834 return true;
835
Eli Friedman91873b72011-07-27 18:54:57 +0000836 return elementType.isDestructedType();
John McCall6ec278d2011-01-27 09:37:56 +0000837}
838
839CharUnits ItaniumCXXABI::GetArrayCookieSize(const CXXNewExpr *expr) {
840 if (!NeedsArrayCookie(expr))
John McCall1e7fe752010-09-02 09:58:18 +0000841 return CharUnits::Zero();
842
John McCall6ec278d2011-01-27 09:37:56 +0000843 // Padding is the maximum of sizeof(size_t) and alignof(elementType)
John McCall9cb2cee2010-09-02 10:25:57 +0000844 ASTContext &Ctx = getContext();
John McCall1e7fe752010-09-02 09:58:18 +0000845 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
John McCall6ec278d2011-01-27 09:37:56 +0000846 Ctx.getTypeAlignInChars(expr->getAllocatedType()));
John McCall1e7fe752010-09-02 09:58:18 +0000847}
848
849llvm::Value *ItaniumCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
850 llvm::Value *NewPtr,
851 llvm::Value *NumElements,
John McCall6ec278d2011-01-27 09:37:56 +0000852 const CXXNewExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000853 QualType ElementType) {
John McCall6ec278d2011-01-27 09:37:56 +0000854 assert(NeedsArrayCookie(expr));
John McCall1e7fe752010-09-02 09:58:18 +0000855
856 unsigned AS = cast<llvm::PointerType>(NewPtr->getType())->getAddressSpace();
857
John McCall9cb2cee2010-09-02 10:25:57 +0000858 ASTContext &Ctx = getContext();
John McCall1e7fe752010-09-02 09:58:18 +0000859 QualType SizeTy = Ctx.getSizeType();
860 CharUnits SizeSize = Ctx.getTypeSizeInChars(SizeTy);
861
862 // The size of the cookie.
863 CharUnits CookieSize =
864 std::max(SizeSize, Ctx.getTypeAlignInChars(ElementType));
865
866 // Compute an offset to the cookie.
867 llvm::Value *CookiePtr = NewPtr;
868 CharUnits CookieOffset = CookieSize - SizeSize;
869 if (!CookieOffset.isZero())
870 CookiePtr = CGF.Builder.CreateConstInBoundsGEP1_64(CookiePtr,
871 CookieOffset.getQuantity());
872
873 // Write the number of elements into the appropriate slot.
874 llvm::Value *NumElementsPtr
875 = CGF.Builder.CreateBitCast(CookiePtr,
876 CGF.ConvertType(SizeTy)->getPointerTo(AS));
877 CGF.Builder.CreateStore(NumElements, NumElementsPtr);
878
879 // Finally, compute a pointer to the actual data buffer by skipping
880 // over the cookie completely.
881 return CGF.Builder.CreateConstInBoundsGEP1_64(NewPtr,
882 CookieSize.getQuantity());
883}
884
885void ItaniumCXXABI::ReadArrayCookie(CodeGenFunction &CGF,
886 llvm::Value *Ptr,
John McCall6ec278d2011-01-27 09:37:56 +0000887 const CXXDeleteExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000888 QualType ElementType,
889 llvm::Value *&NumElements,
890 llvm::Value *&AllocPtr,
891 CharUnits &CookieSize) {
892 // Derive a char* in the same address space as the pointer.
893 unsigned AS = cast<llvm::PointerType>(Ptr->getType())->getAddressSpace();
Chris Lattner2acc6e32011-07-18 04:24:23 +0000894 llvm::Type *CharPtrTy = CGF.Builder.getInt8Ty()->getPointerTo(AS);
John McCall1e7fe752010-09-02 09:58:18 +0000895
896 // If we don't need an array cookie, bail out early.
John McCall6ec278d2011-01-27 09:37:56 +0000897 if (!NeedsArrayCookie(expr, ElementType)) {
John McCall1e7fe752010-09-02 09:58:18 +0000898 AllocPtr = CGF.Builder.CreateBitCast(Ptr, CharPtrTy);
899 NumElements = 0;
900 CookieSize = CharUnits::Zero();
901 return;
902 }
903
John McCall9cb2cee2010-09-02 10:25:57 +0000904 QualType SizeTy = getContext().getSizeType();
905 CharUnits SizeSize = getContext().getTypeSizeInChars(SizeTy);
Chris Lattner2acc6e32011-07-18 04:24:23 +0000906 llvm::Type *SizeLTy = CGF.ConvertType(SizeTy);
John McCall1e7fe752010-09-02 09:58:18 +0000907
908 CookieSize
John McCall9cb2cee2010-09-02 10:25:57 +0000909 = std::max(SizeSize, getContext().getTypeAlignInChars(ElementType));
John McCall1e7fe752010-09-02 09:58:18 +0000910
911 CharUnits NumElementsOffset = CookieSize - SizeSize;
912
913 // Compute the allocated pointer.
914 AllocPtr = CGF.Builder.CreateBitCast(Ptr, CharPtrTy);
915 AllocPtr = CGF.Builder.CreateConstInBoundsGEP1_64(AllocPtr,
916 -CookieSize.getQuantity());
917
918 llvm::Value *NumElementsPtr = AllocPtr;
919 if (!NumElementsOffset.isZero())
920 NumElementsPtr =
921 CGF.Builder.CreateConstInBoundsGEP1_64(NumElementsPtr,
922 NumElementsOffset.getQuantity());
923 NumElementsPtr =
924 CGF.Builder.CreateBitCast(NumElementsPtr, SizeLTy->getPointerTo(AS));
925 NumElements = CGF.Builder.CreateLoad(NumElementsPtr);
926}
927
John McCall6ec278d2011-01-27 09:37:56 +0000928CharUnits ARMCXXABI::GetArrayCookieSize(const CXXNewExpr *expr) {
929 if (!NeedsArrayCookie(expr))
John McCall1e7fe752010-09-02 09:58:18 +0000930 return CharUnits::Zero();
931
932 // On ARM, the cookie is always:
933 // struct array_cookie {
934 // std::size_t element_size; // element_size != 0
935 // std::size_t element_count;
936 // };
937 // TODO: what should we do if the allocated type actually wants
938 // greater alignment?
939 return getContext().getTypeSizeInChars(getContext().getSizeType()) * 2;
940}
941
942llvm::Value *ARMCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
943 llvm::Value *NewPtr,
944 llvm::Value *NumElements,
John McCall6ec278d2011-01-27 09:37:56 +0000945 const CXXNewExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000946 QualType ElementType) {
John McCall6ec278d2011-01-27 09:37:56 +0000947 assert(NeedsArrayCookie(expr));
John McCall1e7fe752010-09-02 09:58:18 +0000948
949 // NewPtr is a char*.
950
951 unsigned AS = cast<llvm::PointerType>(NewPtr->getType())->getAddressSpace();
952
John McCall9cb2cee2010-09-02 10:25:57 +0000953 ASTContext &Ctx = getContext();
John McCall1e7fe752010-09-02 09:58:18 +0000954 CharUnits SizeSize = Ctx.getTypeSizeInChars(Ctx.getSizeType());
Chris Lattner2acc6e32011-07-18 04:24:23 +0000955 llvm::IntegerType *SizeTy =
John McCall1e7fe752010-09-02 09:58:18 +0000956 cast<llvm::IntegerType>(CGF.ConvertType(Ctx.getSizeType()));
957
958 // The cookie is always at the start of the buffer.
959 llvm::Value *CookiePtr = NewPtr;
960
961 // The first element is the element size.
962 CookiePtr = CGF.Builder.CreateBitCast(CookiePtr, SizeTy->getPointerTo(AS));
963 llvm::Value *ElementSize = llvm::ConstantInt::get(SizeTy,
964 Ctx.getTypeSizeInChars(ElementType).getQuantity());
965 CGF.Builder.CreateStore(ElementSize, CookiePtr);
966
967 // The second element is the element count.
968 CookiePtr = CGF.Builder.CreateConstInBoundsGEP1_32(CookiePtr, 1);
969 CGF.Builder.CreateStore(NumElements, CookiePtr);
970
971 // Finally, compute a pointer to the actual data buffer by skipping
972 // over the cookie completely.
973 CharUnits CookieSize = 2 * SizeSize;
974 return CGF.Builder.CreateConstInBoundsGEP1_64(NewPtr,
975 CookieSize.getQuantity());
976}
977
978void ARMCXXABI::ReadArrayCookie(CodeGenFunction &CGF,
979 llvm::Value *Ptr,
John McCall6ec278d2011-01-27 09:37:56 +0000980 const CXXDeleteExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000981 QualType ElementType,
982 llvm::Value *&NumElements,
983 llvm::Value *&AllocPtr,
984 CharUnits &CookieSize) {
985 // Derive a char* in the same address space as the pointer.
986 unsigned AS = cast<llvm::PointerType>(Ptr->getType())->getAddressSpace();
Chris Lattner2acc6e32011-07-18 04:24:23 +0000987 llvm::Type *CharPtrTy = CGF.Builder.getInt8Ty()->getPointerTo(AS);
John McCall1e7fe752010-09-02 09:58:18 +0000988
989 // If we don't need an array cookie, bail out early.
John McCall6ec278d2011-01-27 09:37:56 +0000990 if (!NeedsArrayCookie(expr, ElementType)) {
John McCall1e7fe752010-09-02 09:58:18 +0000991 AllocPtr = CGF.Builder.CreateBitCast(Ptr, CharPtrTy);
992 NumElements = 0;
993 CookieSize = CharUnits::Zero();
994 return;
995 }
996
John McCall9cb2cee2010-09-02 10:25:57 +0000997 QualType SizeTy = getContext().getSizeType();
998 CharUnits SizeSize = getContext().getTypeSizeInChars(SizeTy);
Chris Lattner2acc6e32011-07-18 04:24:23 +0000999 llvm::Type *SizeLTy = CGF.ConvertType(SizeTy);
John McCall1e7fe752010-09-02 09:58:18 +00001000
1001 // The cookie size is always 2 * sizeof(size_t).
1002 CookieSize = 2 * SizeSize;
John McCall1e7fe752010-09-02 09:58:18 +00001003
1004 // The allocated pointer is the input ptr, minus that amount.
1005 AllocPtr = CGF.Builder.CreateBitCast(Ptr, CharPtrTy);
1006 AllocPtr = CGF.Builder.CreateConstInBoundsGEP1_64(AllocPtr,
1007 -CookieSize.getQuantity());
1008
1009 // The number of elements is at offset sizeof(size_t) relative to that.
1010 llvm::Value *NumElementsPtr
1011 = CGF.Builder.CreateConstInBoundsGEP1_64(AllocPtr,
1012 SizeSize.getQuantity());
1013 NumElementsPtr =
1014 CGF.Builder.CreateBitCast(NumElementsPtr, SizeLTy->getPointerTo(AS));
1015 NumElements = CGF.Builder.CreateLoad(NumElementsPtr);
1016}
1017
John McCall5cd91b52010-09-08 01:44:27 +00001018/*********************** Static local initialization **************************/
1019
1020static llvm::Constant *getGuardAcquireFn(CodeGenModule &CGM,
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001021 llvm::PointerType *GuardPtrTy) {
John McCall5cd91b52010-09-08 01:44:27 +00001022 // int __cxa_guard_acquire(__guard *guard_object);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001023 llvm::FunctionType *FTy =
John McCall5cd91b52010-09-08 01:44:27 +00001024 llvm::FunctionType::get(CGM.getTypes().ConvertType(CGM.getContext().IntTy),
Jay Foadda549e82011-07-29 13:56:53 +00001025 GuardPtrTy, /*isVarArg=*/false);
John McCall5cd91b52010-09-08 01:44:27 +00001026
Nick Lewyckye76872e2012-02-13 23:45:02 +00001027 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_acquire",
1028 llvm::Attribute::NoUnwind);
John McCall5cd91b52010-09-08 01:44:27 +00001029}
1030
1031static llvm::Constant *getGuardReleaseFn(CodeGenModule &CGM,
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001032 llvm::PointerType *GuardPtrTy) {
John McCall5cd91b52010-09-08 01:44:27 +00001033 // void __cxa_guard_release(__guard *guard_object);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001034 llvm::FunctionType *FTy =
Chris Lattner8b418682012-02-07 00:39:47 +00001035 llvm::FunctionType::get(CGM.VoidTy, GuardPtrTy, /*isVarArg=*/false);
John McCall5cd91b52010-09-08 01:44:27 +00001036
Nick Lewyckye76872e2012-02-13 23:45:02 +00001037 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_release",
1038 llvm::Attribute::NoUnwind);
John McCall5cd91b52010-09-08 01:44:27 +00001039}
1040
1041static llvm::Constant *getGuardAbortFn(CodeGenModule &CGM,
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001042 llvm::PointerType *GuardPtrTy) {
John McCall5cd91b52010-09-08 01:44:27 +00001043 // void __cxa_guard_abort(__guard *guard_object);
Chris Lattner2acc6e32011-07-18 04:24:23 +00001044 llvm::FunctionType *FTy =
Chris Lattner8b418682012-02-07 00:39:47 +00001045 llvm::FunctionType::get(CGM.VoidTy, GuardPtrTy, /*isVarArg=*/false);
John McCall5cd91b52010-09-08 01:44:27 +00001046
Nick Lewyckye76872e2012-02-13 23:45:02 +00001047 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_abort",
1048 llvm::Attribute::NoUnwind);
John McCall5cd91b52010-09-08 01:44:27 +00001049}
1050
1051namespace {
1052 struct CallGuardAbort : EHScopeStack::Cleanup {
1053 llvm::GlobalVariable *Guard;
1054 CallGuardAbort(llvm::GlobalVariable *Guard) : Guard(Guard) {}
1055
John McCallad346f42011-07-12 20:27:29 +00001056 void Emit(CodeGenFunction &CGF, Flags flags) {
John McCall5cd91b52010-09-08 01:44:27 +00001057 CGF.Builder.CreateCall(getGuardAbortFn(CGF.CGM, Guard->getType()), Guard)
1058 ->setDoesNotThrow();
1059 }
1060 };
1061}
1062
1063/// The ARM code here follows the Itanium code closely enough that we
1064/// just special-case it at particular places.
John McCall3030eb82010-11-06 09:44:32 +00001065void ItaniumCXXABI::EmitGuardedInit(CodeGenFunction &CGF,
1066 const VarDecl &D,
Richard Smith7ca48502012-02-13 22:16:19 +00001067 llvm::GlobalVariable *GV,
1068 bool PerformInit) {
John McCall5cd91b52010-09-08 01:44:27 +00001069 CGBuilderTy &Builder = CGF.Builder;
John McCall3030eb82010-11-06 09:44:32 +00001070
1071 // We only need to use thread-safe statics for local variables;
1072 // global initialization is always single-threaded.
John McCall0502a222011-06-17 07:33:57 +00001073 bool threadsafe =
David Blaikie4e4d0842012-03-11 07:00:24 +00001074 (getContext().getLangOpts().ThreadsafeStatics && D.isLocalVarDecl());
Anders Carlsson173d5122011-04-27 04:37:08 +00001075
Chris Lattner2acc6e32011-07-18 04:24:23 +00001076 llvm::IntegerType *GuardTy;
Anders Carlsson173d5122011-04-27 04:37:08 +00001077
1078 // If we have a global variable with internal linkage and thread-safe statics
1079 // are disabled, we can just let the guard variable be of type i8.
John McCall0502a222011-06-17 07:33:57 +00001080 bool useInt8GuardVariable = !threadsafe && GV->hasInternalLinkage();
1081 if (useInt8GuardVariable) {
1082 GuardTy = CGF.Int8Ty;
1083 } else {
Anders Carlsson173d5122011-04-27 04:37:08 +00001084 // Guard variables are 64 bits in the generic ABI and 32 bits on ARM.
John McCall0502a222011-06-17 07:33:57 +00001085 GuardTy = (IsARM ? CGF.Int32Ty : CGF.Int64Ty);
Anders Carlsson173d5122011-04-27 04:37:08 +00001086 }
Chris Lattner9cbe4f02011-07-09 17:41:47 +00001087 llvm::PointerType *GuardPtrTy = GuardTy->getPointerTo();
John McCall5cd91b52010-09-08 01:44:27 +00001088
1089 // Create the guard variable.
Dylan Noblesmithf7ccbad2012-02-05 02:13:05 +00001090 SmallString<256> GuardVName;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00001091 llvm::raw_svector_ostream Out(GuardVName);
1092 getMangleContext().mangleItaniumGuardVariable(&D, Out);
1093 Out.flush();
John McCall112c9672010-11-02 21:04:24 +00001094
John McCall3030eb82010-11-06 09:44:32 +00001095 // Just absorb linkage and visibility from the variable.
John McCall5cd91b52010-09-08 01:44:27 +00001096 llvm::GlobalVariable *GuardVariable =
1097 new llvm::GlobalVariable(CGM.getModule(), GuardTy,
John McCall3030eb82010-11-06 09:44:32 +00001098 false, GV->getLinkage(),
John McCall5cd91b52010-09-08 01:44:27 +00001099 llvm::ConstantInt::get(GuardTy, 0),
1100 GuardVName.str());
John McCall112c9672010-11-02 21:04:24 +00001101 GuardVariable->setVisibility(GV->getVisibility());
John McCall5cd91b52010-09-08 01:44:27 +00001102
1103 // Test whether the variable has completed initialization.
1104 llvm::Value *IsInitialized;
1105
1106 // ARM C++ ABI 3.2.3.1:
1107 // To support the potential use of initialization guard variables
1108 // as semaphores that are the target of ARM SWP and LDREX/STREX
1109 // synchronizing instructions we define a static initialization
1110 // guard variable to be a 4-byte aligned, 4- byte word with the
1111 // following inline access protocol.
1112 // #define INITIALIZED 1
1113 // if ((obj_guard & INITIALIZED) != INITIALIZED) {
1114 // if (__cxa_guard_acquire(&obj_guard))
1115 // ...
1116 // }
John McCall0502a222011-06-17 07:33:57 +00001117 if (IsARM && !useInt8GuardVariable) {
John McCall5cd91b52010-09-08 01:44:27 +00001118 llvm::Value *V = Builder.CreateLoad(GuardVariable);
1119 V = Builder.CreateAnd(V, Builder.getInt32(1));
1120 IsInitialized = Builder.CreateIsNull(V, "guard.uninitialized");
1121
1122 // Itanium C++ ABI 3.3.2:
1123 // The following is pseudo-code showing how these functions can be used:
1124 // if (obj_guard.first_byte == 0) {
1125 // if ( __cxa_guard_acquire (&obj_guard) ) {
1126 // try {
1127 // ... initialize the object ...;
1128 // } catch (...) {
1129 // __cxa_guard_abort (&obj_guard);
1130 // throw;
1131 // }
1132 // ... queue object destructor with __cxa_atexit() ...;
1133 // __cxa_guard_release (&obj_guard);
1134 // }
1135 // }
1136 } else {
1137 // Load the first byte of the guard variable.
Chris Lattner2acc6e32011-07-18 04:24:23 +00001138 llvm::Type *PtrTy = Builder.getInt8PtrTy();
Eli Friedmaneb43f4a2011-09-13 22:21:56 +00001139 llvm::LoadInst *LI =
Benjamin Kramer578faa82011-09-27 21:06:10 +00001140 Builder.CreateLoad(Builder.CreateBitCast(GuardVariable, PtrTy));
Eli Friedmaneb43f4a2011-09-13 22:21:56 +00001141 LI->setAlignment(1);
John McCall5cd91b52010-09-08 01:44:27 +00001142
Eli Friedmaneb43f4a2011-09-13 22:21:56 +00001143 // Itanium ABI:
1144 // An implementation supporting thread-safety on multiprocessor
1145 // systems must also guarantee that references to the initialized
1146 // object do not occur before the load of the initialization flag.
1147 //
1148 // In LLVM, we do this by marking the load Acquire.
1149 if (threadsafe)
1150 LI->setAtomic(llvm::Acquire);
1151
1152 IsInitialized = Builder.CreateIsNull(LI, "guard.uninitialized");
John McCall5cd91b52010-09-08 01:44:27 +00001153 }
1154
1155 llvm::BasicBlock *InitCheckBlock = CGF.createBasicBlock("init.check");
1156 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
1157
1158 // Check if the first byte of the guard variable is zero.
Eli Friedmaneb43f4a2011-09-13 22:21:56 +00001159 Builder.CreateCondBr(IsInitialized, InitCheckBlock, EndBlock);
John McCall5cd91b52010-09-08 01:44:27 +00001160
1161 CGF.EmitBlock(InitCheckBlock);
1162
1163 // Variables used when coping with thread-safe statics and exceptions.
John McCall0502a222011-06-17 07:33:57 +00001164 if (threadsafe) {
John McCall5cd91b52010-09-08 01:44:27 +00001165 // Call __cxa_guard_acquire.
1166 llvm::Value *V
1167 = Builder.CreateCall(getGuardAcquireFn(CGM, GuardPtrTy), GuardVariable);
1168
1169 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
1170
1171 Builder.CreateCondBr(Builder.CreateIsNotNull(V, "tobool"),
1172 InitBlock, EndBlock);
1173
1174 // Call __cxa_guard_abort along the exceptional edge.
1175 CGF.EHStack.pushCleanup<CallGuardAbort>(EHCleanup, GuardVariable);
1176
1177 CGF.EmitBlock(InitBlock);
1178 }
1179
1180 // Emit the initializer and add a global destructor if appropriate.
Richard Smith7ca48502012-02-13 22:16:19 +00001181 CGF.EmitCXXGlobalVarDeclInit(D, GV, PerformInit);
John McCall5cd91b52010-09-08 01:44:27 +00001182
John McCall0502a222011-06-17 07:33:57 +00001183 if (threadsafe) {
John McCall5cd91b52010-09-08 01:44:27 +00001184 // Pop the guard-abort cleanup if we pushed one.
1185 CGF.PopCleanupBlock();
1186
1187 // Call __cxa_guard_release. This cannot throw.
1188 Builder.CreateCall(getGuardReleaseFn(CGM, GuardPtrTy), GuardVariable);
1189 } else {
1190 Builder.CreateStore(llvm::ConstantInt::get(GuardTy, 1), GuardVariable);
1191 }
1192
1193 CGF.EmitBlock(EndBlock);
1194}