blob: 7e71df1268ae6a6962c377db17c47b987504da9a [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 McCall0bab0cd2010-08-23 01:21:21 +000027#include <llvm/Target/TargetData.h>
John McCall93d557b2010-08-22 00:05:51 +000028#include <llvm/Value.h>
Charles Davis3a811f12010-05-25 19:52:27 +000029
30using namespace clang;
John McCall93d557b2010-08-22 00:05:51 +000031using namespace CodeGen;
Charles Davis3a811f12010-05-25 19:52:27 +000032
33namespace {
Charles Davis071cc7d2010-08-16 03:33:14 +000034class ItaniumCXXABI : public CodeGen::CGCXXABI {
John McCall0bab0cd2010-08-23 01:21:21 +000035private:
36 const llvm::IntegerType *PtrDiffTy;
John McCall93d557b2010-08-22 00:05:51 +000037protected:
John McCallbabc9a92010-08-22 00:59:17 +000038 bool IsARM;
John McCall0bab0cd2010-08-23 01:21:21 +000039
40 // It's a little silly for us to cache this.
41 const llvm::IntegerType *getPtrDiffTy() {
42 if (!PtrDiffTy) {
John McCall9cb2cee2010-09-02 10:25:57 +000043 QualType T = getContext().getPointerDiffType();
John McCall0bab0cd2010-08-23 01:21:21 +000044 const llvm::Type *Ty = CGM.getTypes().ConvertTypeRecursive(T);
45 PtrDiffTy = cast<llvm::IntegerType>(Ty);
46 }
47 return PtrDiffTy;
48 }
49
John McCall6ec278d2011-01-27 09:37:56 +000050 bool NeedsArrayCookie(const CXXNewExpr *expr);
51 bool NeedsArrayCookie(const CXXDeleteExpr *expr,
52 QualType elementType);
John McCall1e7fe752010-09-02 09:58:18 +000053
Charles Davis3a811f12010-05-25 19:52:27 +000054public:
John McCallbabc9a92010-08-22 00:59:17 +000055 ItaniumCXXABI(CodeGen::CodeGenModule &CGM, bool IsARM = false) :
Peter Collingbourne14110472011-01-13 18:57:25 +000056 CGCXXABI(CGM), PtrDiffTy(0), IsARM(IsARM) { }
John McCall93d557b2010-08-22 00:05:51 +000057
John McCallf16aa102010-08-22 21:01:12 +000058 bool isZeroInitializable(const MemberPointerType *MPT);
John McCallcf2c85e2010-08-22 04:16:24 +000059
John McCall0bab0cd2010-08-23 01:21:21 +000060 const llvm::Type *ConvertMemberPointerType(const MemberPointerType *MPT);
61
John McCall93d557b2010-08-22 00:05:51 +000062 llvm::Value *EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF,
63 llvm::Value *&This,
64 llvm::Value *MemFnPtr,
65 const MemberPointerType *MPT);
John McCall3023def2010-08-22 03:04:22 +000066
John McCall6c2ab1d2010-08-31 21:07:20 +000067 llvm::Value *EmitMemberDataPointerAddress(CodeGenFunction &CGF,
68 llvm::Value *Base,
69 llvm::Value *MemPtr,
70 const MemberPointerType *MPT);
71
John McCall0bab0cd2010-08-23 01:21:21 +000072 llvm::Value *EmitMemberPointerConversion(CodeGenFunction &CGF,
73 const CastExpr *E,
74 llvm::Value *Src);
John McCallcf2c85e2010-08-22 04:16:24 +000075
John McCall0bab0cd2010-08-23 01:21:21 +000076 llvm::Constant *EmitMemberPointerConversion(llvm::Constant *C,
77 const CastExpr *E);
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);
John McCall875ab102010-08-22 06:43:33 +000084
John McCall0bab0cd2010-08-23 01:21:21 +000085 llvm::Value *EmitMemberPointerComparison(CodeGenFunction &CGF,
86 llvm::Value *L,
87 llvm::Value *R,
88 const MemberPointerType *MPT,
89 bool Inequality);
John McCalle9fd7eb2010-08-22 08:30:07 +000090
John McCall0bab0cd2010-08-23 01:21:21 +000091 llvm::Value *EmitMemberPointerIsNotNull(CodeGenFunction &CGF,
92 llvm::Value *Addr,
93 const MemberPointerType *MPT);
John McCall4c40d982010-08-31 07:33:07 +000094
95 void BuildConstructorSignature(const CXXConstructorDecl *Ctor,
96 CXXCtorType T,
97 CanQualType &ResTy,
98 llvm::SmallVectorImpl<CanQualType> &ArgTys);
99
100 void BuildDestructorSignature(const CXXDestructorDecl *Dtor,
101 CXXDtorType T,
102 CanQualType &ResTy,
103 llvm::SmallVectorImpl<CanQualType> &ArgTys);
104
105 void BuildInstanceFunctionParams(CodeGenFunction &CGF,
106 QualType &ResTy,
107 FunctionArgList &Params);
108
109 void EmitInstanceFunctionProlog(CodeGenFunction &CGF);
John McCall1e7fe752010-09-02 09:58:18 +0000110
John McCall6ec278d2011-01-27 09:37:56 +0000111 CharUnits GetArrayCookieSize(const CXXNewExpr *expr);
John McCall1e7fe752010-09-02 09:58:18 +0000112 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
113 llvm::Value *NewPtr,
114 llvm::Value *NumElements,
John McCall6ec278d2011-01-27 09:37:56 +0000115 const CXXNewExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000116 QualType ElementType);
117 void ReadArrayCookie(CodeGenFunction &CGF, llvm::Value *Ptr,
John McCall6ec278d2011-01-27 09:37:56 +0000118 const CXXDeleteExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000119 QualType ElementType, llvm::Value *&NumElements,
120 llvm::Value *&AllocPtr, CharUnits &CookieSize);
John McCall5cd91b52010-09-08 01:44:27 +0000121
John McCall3030eb82010-11-06 09:44:32 +0000122 void EmitGuardedInit(CodeGenFunction &CGF, const VarDecl &D,
123 llvm::GlobalVariable *DeclPtr);
Charles Davis3a811f12010-05-25 19:52:27 +0000124};
John McCallee79a4c2010-08-21 22:46:04 +0000125
126class ARMCXXABI : public ItaniumCXXABI {
127public:
John McCallbabc9a92010-08-22 00:59:17 +0000128 ARMCXXABI(CodeGen::CodeGenModule &CGM) : ItaniumCXXABI(CGM, /*ARM*/ true) {}
John McCall4c40d982010-08-31 07:33:07 +0000129
130 void BuildConstructorSignature(const CXXConstructorDecl *Ctor,
131 CXXCtorType T,
132 CanQualType &ResTy,
133 llvm::SmallVectorImpl<CanQualType> &ArgTys);
134
135 void BuildDestructorSignature(const CXXDestructorDecl *Dtor,
136 CXXDtorType T,
137 CanQualType &ResTy,
138 llvm::SmallVectorImpl<CanQualType> &ArgTys);
139
140 void BuildInstanceFunctionParams(CodeGenFunction &CGF,
141 QualType &ResTy,
142 FunctionArgList &Params);
143
144 void EmitInstanceFunctionProlog(CodeGenFunction &CGF);
145
146 void EmitReturnFromThunk(CodeGenFunction &CGF, RValue RV, QualType ResTy);
147
John McCall6ec278d2011-01-27 09:37:56 +0000148 CharUnits GetArrayCookieSize(const CXXNewExpr *expr);
John McCall1e7fe752010-09-02 09:58:18 +0000149 llvm::Value *InitializeArrayCookie(CodeGenFunction &CGF,
150 llvm::Value *NewPtr,
151 llvm::Value *NumElements,
John McCall6ec278d2011-01-27 09:37:56 +0000152 const CXXNewExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000153 QualType ElementType);
154 void ReadArrayCookie(CodeGenFunction &CGF, llvm::Value *Ptr,
John McCall6ec278d2011-01-27 09:37:56 +0000155 const CXXDeleteExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000156 QualType ElementType, llvm::Value *&NumElements,
157 llvm::Value *&AllocPtr, CharUnits &CookieSize);
John McCall4c40d982010-08-31 07:33:07 +0000158
159private:
160 /// \brief Returns true if the given instance method is one of the
161 /// kinds that the ARM ABI says returns 'this'.
162 static bool HasThisReturn(GlobalDecl GD) {
163 const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
164 return ((isa<CXXDestructorDecl>(MD) && GD.getDtorType() != Dtor_Deleting) ||
165 (isa<CXXConstructorDecl>(MD)));
166 }
John McCallee79a4c2010-08-21 22:46:04 +0000167};
Charles Davis3a811f12010-05-25 19:52:27 +0000168}
169
Charles Davis071cc7d2010-08-16 03:33:14 +0000170CodeGen::CGCXXABI *CodeGen::CreateItaniumCXXABI(CodeGenModule &CGM) {
Charles Davis3a811f12010-05-25 19:52:27 +0000171 return new ItaniumCXXABI(CGM);
172}
173
John McCallee79a4c2010-08-21 22:46:04 +0000174CodeGen::CGCXXABI *CodeGen::CreateARMCXXABI(CodeGenModule &CGM) {
175 return new ARMCXXABI(CGM);
176}
177
John McCall0bab0cd2010-08-23 01:21:21 +0000178const llvm::Type *
179ItaniumCXXABI::ConvertMemberPointerType(const MemberPointerType *MPT) {
180 if (MPT->isMemberDataPointer())
181 return getPtrDiffTy();
182 else
183 return llvm::StructType::get(CGM.getLLVMContext(),
184 getPtrDiffTy(), getPtrDiffTy(), NULL);
John McCall875ab102010-08-22 06:43:33 +0000185}
186
John McCallbabc9a92010-08-22 00:59:17 +0000187/// In the Itanium and ARM ABIs, method pointers have the form:
188/// struct { ptrdiff_t ptr; ptrdiff_t adj; } memptr;
189///
190/// In the Itanium ABI:
191/// - method pointers are virtual if (memptr.ptr & 1) is nonzero
192/// - the this-adjustment is (memptr.adj)
193/// - the virtual offset is (memptr.ptr - 1)
194///
195/// In the ARM ABI:
196/// - method pointers are virtual if (memptr.adj & 1) is nonzero
197/// - the this-adjustment is (memptr.adj >> 1)
198/// - the virtual offset is (memptr.ptr)
199/// ARM uses 'adj' for the virtual flag because Thumb functions
200/// may be only single-byte aligned.
201///
202/// If the member is virtual, the adjusted 'this' pointer points
203/// to a vtable pointer from which the virtual offset is applied.
204///
205/// If the member is non-virtual, memptr.ptr is the address of
206/// the function to call.
John McCall93d557b2010-08-22 00:05:51 +0000207llvm::Value *
208ItaniumCXXABI::EmitLoadOfMemberFunctionPointer(CodeGenFunction &CGF,
209 llvm::Value *&This,
210 llvm::Value *MemFnPtr,
211 const MemberPointerType *MPT) {
212 CGBuilderTy &Builder = CGF.Builder;
213
214 const FunctionProtoType *FPT =
215 MPT->getPointeeType()->getAs<FunctionProtoType>();
216 const CXXRecordDecl *RD =
217 cast<CXXRecordDecl>(MPT->getClass()->getAs<RecordType>()->getDecl());
218
219 const llvm::FunctionType *FTy =
220 CGM.getTypes().GetFunctionType(CGM.getTypes().getFunctionInfo(RD, FPT),
221 FPT->isVariadic());
222
John McCall0bab0cd2010-08-23 01:21:21 +0000223 const llvm::IntegerType *ptrdiff = getPtrDiffTy();
John McCallbabc9a92010-08-22 00:59:17 +0000224 llvm::Constant *ptrdiff_1 = llvm::ConstantInt::get(ptrdiff, 1);
John McCall93d557b2010-08-22 00:05:51 +0000225
John McCallbabc9a92010-08-22 00:59:17 +0000226 llvm::BasicBlock *FnVirtual = CGF.createBasicBlock("memptr.virtual");
227 llvm::BasicBlock *FnNonVirtual = CGF.createBasicBlock("memptr.nonvirtual");
228 llvm::BasicBlock *FnEnd = CGF.createBasicBlock("memptr.end");
229
John McCalld608cdb2010-08-22 10:59:02 +0000230 // Extract memptr.adj, which is in the second field.
231 llvm::Value *RawAdj = Builder.CreateExtractValue(MemFnPtr, 1, "memptr.adj");
John McCallbabc9a92010-08-22 00:59:17 +0000232
233 // Compute the true adjustment.
234 llvm::Value *Adj = RawAdj;
235 if (IsARM)
236 Adj = Builder.CreateAShr(Adj, ptrdiff_1, "memptr.adj.shifted");
John McCall93d557b2010-08-22 00:05:51 +0000237
238 // Apply the adjustment and cast back to the original struct type
239 // for consistency.
John McCallbabc9a92010-08-22 00:59:17 +0000240 llvm::Value *Ptr = Builder.CreateBitCast(This, Builder.getInt8PtrTy());
241 Ptr = Builder.CreateInBoundsGEP(Ptr, Adj);
242 This = Builder.CreateBitCast(Ptr, This->getType(), "this.adjusted");
John McCall93d557b2010-08-22 00:05:51 +0000243
244 // Load the function pointer.
John McCalld608cdb2010-08-22 10:59:02 +0000245 llvm::Value *FnAsInt = Builder.CreateExtractValue(MemFnPtr, 0, "memptr.ptr");
John McCall93d557b2010-08-22 00:05:51 +0000246
247 // If the LSB in the function pointer is 1, the function pointer points to
248 // a virtual function.
John McCallbabc9a92010-08-22 00:59:17 +0000249 llvm::Value *IsVirtual;
250 if (IsARM)
251 IsVirtual = Builder.CreateAnd(RawAdj, ptrdiff_1);
252 else
253 IsVirtual = Builder.CreateAnd(FnAsInt, ptrdiff_1);
254 IsVirtual = Builder.CreateIsNotNull(IsVirtual, "memptr.isvirtual");
John McCall93d557b2010-08-22 00:05:51 +0000255 Builder.CreateCondBr(IsVirtual, FnVirtual, FnNonVirtual);
256
257 // In the virtual path, the adjustment left 'This' pointing to the
258 // vtable of the correct base subobject. The "function pointer" is an
John McCallbabc9a92010-08-22 00:59:17 +0000259 // offset within the vtable (+1 for the virtual flag on non-ARM).
John McCall93d557b2010-08-22 00:05:51 +0000260 CGF.EmitBlock(FnVirtual);
261
262 // Cast the adjusted this to a pointer to vtable pointer and load.
263 const llvm::Type *VTableTy = Builder.getInt8PtrTy();
264 llvm::Value *VTable = Builder.CreateBitCast(This, VTableTy->getPointerTo());
John McCallbabc9a92010-08-22 00:59:17 +0000265 VTable = Builder.CreateLoad(VTable, "memptr.vtable");
John McCall93d557b2010-08-22 00:05:51 +0000266
267 // Apply the offset.
John McCallbabc9a92010-08-22 00:59:17 +0000268 llvm::Value *VTableOffset = FnAsInt;
269 if (!IsARM) VTableOffset = Builder.CreateSub(VTableOffset, ptrdiff_1);
270 VTable = Builder.CreateGEP(VTable, VTableOffset);
John McCall93d557b2010-08-22 00:05:51 +0000271
272 // Load the virtual function to call.
273 VTable = Builder.CreateBitCast(VTable, FTy->getPointerTo()->getPointerTo());
John McCallbabc9a92010-08-22 00:59:17 +0000274 llvm::Value *VirtualFn = Builder.CreateLoad(VTable, "memptr.virtualfn");
John McCall93d557b2010-08-22 00:05:51 +0000275 CGF.EmitBranch(FnEnd);
276
277 // In the non-virtual path, the function pointer is actually a
278 // function pointer.
279 CGF.EmitBlock(FnNonVirtual);
280 llvm::Value *NonVirtualFn =
John McCallbabc9a92010-08-22 00:59:17 +0000281 Builder.CreateIntToPtr(FnAsInt, FTy->getPointerTo(), "memptr.nonvirtualfn");
John McCall93d557b2010-08-22 00:05:51 +0000282
283 // We're done.
284 CGF.EmitBlock(FnEnd);
Jay Foadbbf3bac2011-03-30 11:28:58 +0000285 llvm::PHINode *Callee = Builder.CreatePHI(FTy->getPointerTo(), 2);
John McCall93d557b2010-08-22 00:05:51 +0000286 Callee->addIncoming(VirtualFn, FnVirtual);
287 Callee->addIncoming(NonVirtualFn, FnNonVirtual);
288 return Callee;
289}
John McCall3023def2010-08-22 03:04:22 +0000290
John McCall6c2ab1d2010-08-31 21:07:20 +0000291/// Compute an l-value by applying the given pointer-to-member to a
292/// base object.
293llvm::Value *ItaniumCXXABI::EmitMemberDataPointerAddress(CodeGenFunction &CGF,
294 llvm::Value *Base,
295 llvm::Value *MemPtr,
296 const MemberPointerType *MPT) {
297 assert(MemPtr->getType() == getPtrDiffTy());
298
299 CGBuilderTy &Builder = CGF.Builder;
300
301 unsigned AS = cast<llvm::PointerType>(Base->getType())->getAddressSpace();
302
303 // Cast to char*.
304 Base = Builder.CreateBitCast(Base, Builder.getInt8Ty()->getPointerTo(AS));
305
306 // Apply the offset, which we assume is non-null.
307 llvm::Value *Addr = Builder.CreateInBoundsGEP(Base, MemPtr, "memptr.offset");
308
309 // Cast the address to the appropriate pointer type, adopting the
310 // address space of the base pointer.
Douglas Gregoreede61a2010-09-02 17:38:50 +0000311 const llvm::Type *PType
312 = CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
John McCall6c2ab1d2010-08-31 21:07:20 +0000313 return Builder.CreateBitCast(Addr, PType);
314}
315
John McCall3023def2010-08-22 03:04:22 +0000316/// Perform a derived-to-base or base-to-derived member pointer conversion.
John McCall0bab0cd2010-08-23 01:21:21 +0000317///
318/// Obligatory offset/adjustment diagram:
319/// <-- offset --> <-- adjustment -->
320/// |--------------------------|----------------------|--------------------|
321/// ^Derived address point ^Base address point ^Member address point
322///
323/// So when converting a base member pointer to a derived member pointer,
324/// we add the offset to the adjustment because the address point has
325/// decreased; and conversely, when converting a derived MP to a base MP
326/// we subtract the offset from the adjustment because the address point
327/// has increased.
328///
329/// The standard forbids (at compile time) conversion to and from
330/// virtual bases, which is why we don't have to consider them here.
331///
332/// The standard forbids (at run time) casting a derived MP to a base
333/// MP when the derived MP does not point to a member of the base.
334/// This is why -1 is a reasonable choice for null data member
335/// pointers.
John McCalld608cdb2010-08-22 10:59:02 +0000336llvm::Value *
John McCall0bab0cd2010-08-23 01:21:21 +0000337ItaniumCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
338 const CastExpr *E,
339 llvm::Value *Src) {
John McCall2de56d12010-08-25 11:45:40 +0000340 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
341 E->getCastKind() == CK_BaseToDerivedMemberPointer);
John McCall3023def2010-08-22 03:04:22 +0000342
John McCalld608cdb2010-08-22 10:59:02 +0000343 if (isa<llvm::Constant>(Src))
John McCall0bab0cd2010-08-23 01:21:21 +0000344 return EmitMemberPointerConversion(cast<llvm::Constant>(Src), E);
John McCalld608cdb2010-08-22 10:59:02 +0000345
John McCall3023def2010-08-22 03:04:22 +0000346 CGBuilderTy &Builder = CGF.Builder;
347
348 const MemberPointerType *SrcTy =
349 E->getSubExpr()->getType()->getAs<MemberPointerType>();
350 const MemberPointerType *DestTy = E->getType()->getAs<MemberPointerType>();
351
352 const CXXRecordDecl *SrcDecl = SrcTy->getClass()->getAsCXXRecordDecl();
353 const CXXRecordDecl *DestDecl = DestTy->getClass()->getAsCXXRecordDecl();
354
John McCall3023def2010-08-22 03:04:22 +0000355 bool DerivedToBase =
John McCall2de56d12010-08-25 11:45:40 +0000356 E->getCastKind() == CK_DerivedToBaseMemberPointer;
John McCall3023def2010-08-22 03:04:22 +0000357
Jeffrey Yasskindec09842011-01-18 02:00:16 +0000358 const CXXRecordDecl *DerivedDecl;
John McCall3023def2010-08-22 03:04:22 +0000359 if (DerivedToBase)
Jeffrey Yasskindec09842011-01-18 02:00:16 +0000360 DerivedDecl = SrcDecl;
John McCall3023def2010-08-22 03:04:22 +0000361 else
Jeffrey Yasskindec09842011-01-18 02:00:16 +0000362 DerivedDecl = DestDecl;
John McCall3023def2010-08-22 03:04:22 +0000363
John McCalld608cdb2010-08-22 10:59:02 +0000364 llvm::Constant *Adj =
365 CGF.CGM.GetNonVirtualBaseClassOffset(DerivedDecl,
366 E->path_begin(),
367 E->path_end());
368 if (!Adj) return Src;
John McCall875ab102010-08-22 06:43:33 +0000369
John McCall0bab0cd2010-08-23 01:21:21 +0000370 // For member data pointers, this is just a matter of adding the
371 // offset if the source is non-null.
372 if (SrcTy->isMemberDataPointer()) {
373 llvm::Value *Dst;
374 if (DerivedToBase)
375 Dst = Builder.CreateNSWSub(Src, Adj, "adj");
376 else
377 Dst = Builder.CreateNSWAdd(Src, Adj, "adj");
378
379 // Null check.
380 llvm::Value *Null = llvm::Constant::getAllOnesValue(Src->getType());
381 llvm::Value *IsNull = Builder.CreateICmpEQ(Src, Null, "memptr.isnull");
382 return Builder.CreateSelect(IsNull, Src, Dst);
383 }
384
John McCalld608cdb2010-08-22 10:59:02 +0000385 // The this-adjustment is left-shifted by 1 on ARM.
386 if (IsARM) {
387 uint64_t Offset = cast<llvm::ConstantInt>(Adj)->getZExtValue();
388 Offset <<= 1;
389 Adj = llvm::ConstantInt::get(Adj->getType(), Offset);
390 }
391
John McCalle14add42010-08-22 11:04:31 +0000392 llvm::Value *SrcAdj = Builder.CreateExtractValue(Src, 1, "src.adj");
John McCalld608cdb2010-08-22 10:59:02 +0000393 llvm::Value *DstAdj;
394 if (DerivedToBase)
John McCall0bab0cd2010-08-23 01:21:21 +0000395 DstAdj = Builder.CreateNSWSub(SrcAdj, Adj, "adj");
John McCalld608cdb2010-08-22 10:59:02 +0000396 else
John McCall0bab0cd2010-08-23 01:21:21 +0000397 DstAdj = Builder.CreateNSWAdd(SrcAdj, Adj, "adj");
John McCalld608cdb2010-08-22 10:59:02 +0000398
John McCalle14add42010-08-22 11:04:31 +0000399 return Builder.CreateInsertValue(Src, DstAdj, 1);
John McCall3023def2010-08-22 03:04:22 +0000400}
John McCallcf2c85e2010-08-22 04:16:24 +0000401
402llvm::Constant *
John McCall0bab0cd2010-08-23 01:21:21 +0000403ItaniumCXXABI::EmitMemberPointerConversion(llvm::Constant *C,
404 const CastExpr *E) {
John McCallcf2c85e2010-08-22 04:16:24 +0000405 const MemberPointerType *SrcTy =
406 E->getSubExpr()->getType()->getAs<MemberPointerType>();
407 const MemberPointerType *DestTy =
408 E->getType()->getAs<MemberPointerType>();
409
410 bool DerivedToBase =
John McCall2de56d12010-08-25 11:45:40 +0000411 E->getCastKind() == CK_DerivedToBaseMemberPointer;
John McCallcf2c85e2010-08-22 04:16:24 +0000412
413 const CXXRecordDecl *DerivedDecl;
414 if (DerivedToBase)
415 DerivedDecl = SrcTy->getClass()->getAsCXXRecordDecl();
416 else
417 DerivedDecl = DestTy->getClass()->getAsCXXRecordDecl();
418
419 // Calculate the offset to the base class.
420 llvm::Constant *Offset =
421 CGM.GetNonVirtualBaseClassOffset(DerivedDecl,
422 E->path_begin(),
423 E->path_end());
424 // If there's no offset, we're done.
425 if (!Offset) return C;
426
John McCall0bab0cd2010-08-23 01:21:21 +0000427 // If the source is a member data pointer, we have to do a null
428 // check and then add the offset. In the common case, we can fold
429 // away the offset.
430 if (SrcTy->isMemberDataPointer()) {
431 assert(C->getType() == getPtrDiffTy());
432
433 // If it's a constant int, just create a new constant int.
434 if (llvm::ConstantInt *CI = dyn_cast<llvm::ConstantInt>(C)) {
435 int64_t Src = CI->getSExtValue();
436
437 // Null converts to null.
438 if (Src == -1) return CI;
439
440 // Otherwise, just add the offset.
441 int64_t OffsetV = cast<llvm::ConstantInt>(Offset)->getSExtValue();
442 int64_t Dst = (DerivedToBase ? Src - OffsetV : Src + OffsetV);
443 return llvm::ConstantInt::get(CI->getType(), Dst, /*signed*/ true);
444 }
445
446 // Otherwise, we have to form a constant select expression.
447 llvm::Constant *Null = llvm::Constant::getAllOnesValue(C->getType());
448
449 llvm::Constant *IsNull =
450 llvm::ConstantExpr::getICmp(llvm::ICmpInst::ICMP_EQ, C, Null);
451
452 llvm::Constant *Dst;
453 if (DerivedToBase)
454 Dst = llvm::ConstantExpr::getNSWSub(C, Offset);
455 else
456 Dst = llvm::ConstantExpr::getNSWAdd(C, Offset);
457
458 return llvm::ConstantExpr::getSelect(IsNull, Null, Dst);
459 }
460
John McCall875ab102010-08-22 06:43:33 +0000461 // The this-adjustment is left-shifted by 1 on ARM.
462 if (IsARM) {
John McCall0bab0cd2010-08-23 01:21:21 +0000463 int64_t OffsetV = cast<llvm::ConstantInt>(Offset)->getSExtValue();
John McCall875ab102010-08-22 06:43:33 +0000464 OffsetV <<= 1;
465 Offset = llvm::ConstantInt::get(Offset->getType(), OffsetV);
466 }
467
John McCallcf2c85e2010-08-22 04:16:24 +0000468 llvm::ConstantStruct *CS = cast<llvm::ConstantStruct>(C);
469
John McCall0bab0cd2010-08-23 01:21:21 +0000470 llvm::Constant *Values[2] = { CS->getOperand(0), 0 };
471 if (DerivedToBase)
472 Values[1] = llvm::ConstantExpr::getSub(CS->getOperand(1), Offset);
473 else
474 Values[1] = llvm::ConstantExpr::getAdd(CS->getOperand(1), Offset);
475
John McCallcf2c85e2010-08-22 04:16:24 +0000476 return llvm::ConstantStruct::get(CGM.getLLVMContext(), Values, 2,
477 /*Packed=*/false);
478}
479
480
John McCallcf2c85e2010-08-22 04:16:24 +0000481llvm::Constant *
John McCall0bab0cd2010-08-23 01:21:21 +0000482ItaniumCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
483 const llvm::Type *ptrdiff_t = getPtrDiffTy();
484
485 // Itanium C++ ABI 2.3:
486 // A NULL pointer is represented as -1.
487 if (MPT->isMemberDataPointer())
488 return llvm::ConstantInt::get(ptrdiff_t, -1ULL, /*isSigned=*/true);
John McCalld608cdb2010-08-22 10:59:02 +0000489
490 llvm::Constant *Zero = llvm::ConstantInt::get(ptrdiff_t, 0);
491 llvm::Constant *Values[2] = { Zero, Zero };
492 return llvm::ConstantStruct::get(CGM.getLLVMContext(), Values, 2,
493 /*Packed=*/false);
John McCallcf2c85e2010-08-22 04:16:24 +0000494}
495
John McCall5808ce42011-02-03 08:15:49 +0000496llvm::Constant *
497ItaniumCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
498 CharUnits offset) {
John McCall0bab0cd2010-08-23 01:21:21 +0000499 // Itanium C++ ABI 2.3:
500 // A pointer to data member is an offset from the base address of
501 // the class object containing it, represented as a ptrdiff_t
John McCall5808ce42011-02-03 08:15:49 +0000502 return llvm::ConstantInt::get(getPtrDiffTy(), offset.getQuantity());
John McCall0bab0cd2010-08-23 01:21:21 +0000503}
504
John McCall755d8492011-04-12 00:42:48 +0000505llvm::Constant *ItaniumCXXABI::EmitMemberPointer(const CXXMethodDecl *MD) {
John McCalld608cdb2010-08-22 10:59:02 +0000506 assert(MD->isInstance() && "Member function must not be static!");
507 MD = MD->getCanonicalDecl();
508
509 CodeGenTypes &Types = CGM.getTypes();
John McCall0bab0cd2010-08-23 01:21:21 +0000510 const llvm::Type *ptrdiff_t = getPtrDiffTy();
John McCalld608cdb2010-08-22 10:59:02 +0000511
512 // Get the function pointer (or index if this is a virtual function).
513 llvm::Constant *MemPtr[2];
514 if (MD->isVirtual()) {
515 uint64_t Index = CGM.getVTables().getMethodVTableIndex(MD);
516
Ken Dyck1246ba62011-04-09 01:30:02 +0000517 const ASTContext &Context = getContext();
518 CharUnits PointerWidth =
519 Context.toCharUnitsFromBits(Context.Target.getPointerWidth(0));
520 uint64_t VTableOffset = (Index * PointerWidth.getQuantity());
John McCalld608cdb2010-08-22 10:59:02 +0000521
522 if (IsARM) {
523 // ARM C++ ABI 3.2.1:
524 // This ABI specifies that adj contains twice the this
525 // adjustment, plus 1 if the member function is virtual. The
526 // least significant bit of adj then makes exactly the same
527 // discrimination as the least significant bit of ptr does for
528 // Itanium.
529 MemPtr[0] = llvm::ConstantInt::get(ptrdiff_t, VTableOffset);
530 MemPtr[1] = llvm::ConstantInt::get(ptrdiff_t, 1);
531 } else {
532 // Itanium C++ ABI 2.3:
533 // For a virtual function, [the pointer field] is 1 plus the
534 // virtual table offset (in bytes) of the function,
535 // represented as a ptrdiff_t.
536 MemPtr[0] = llvm::ConstantInt::get(ptrdiff_t, VTableOffset + 1);
537 MemPtr[1] = llvm::ConstantInt::get(ptrdiff_t, 0);
538 }
539 } else {
John McCall755d8492011-04-12 00:42:48 +0000540 const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
541 const llvm::Type *Ty;
542 // Check whether the function has a computable LLVM signature.
543 if (!CodeGenTypes::VerifyFuncTypeComplete(FPT)) {
544 // The function has a computable LLVM signature; use the correct type.
545 Ty = Types.GetFunctionType(Types.getFunctionInfo(MD),
546 FPT->isVariadic());
John McCalld608cdb2010-08-22 10:59:02 +0000547 } else {
John McCall755d8492011-04-12 00:42:48 +0000548 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
549 // function type is incomplete.
550 Ty = ptrdiff_t;
John McCalld608cdb2010-08-22 10:59:02 +0000551 }
John McCall755d8492011-04-12 00:42:48 +0000552 llvm::Constant *addr = CGM.GetAddrOfFunction(MD, Ty);
John McCalld608cdb2010-08-22 10:59:02 +0000553
John McCall379b5152011-04-11 07:02:50 +0000554 MemPtr[0] = llvm::ConstantExpr::getPtrToInt(addr, ptrdiff_t);
John McCalld608cdb2010-08-22 10:59:02 +0000555 MemPtr[1] = llvm::ConstantInt::get(ptrdiff_t, 0);
556 }
John McCall875ab102010-08-22 06:43:33 +0000557
558 return llvm::ConstantStruct::get(CGM.getLLVMContext(),
John McCalld608cdb2010-08-22 10:59:02 +0000559 MemPtr, 2, /*Packed=*/false);
John McCall875ab102010-08-22 06:43:33 +0000560}
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,
685 llvm::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,
699 llvm::SmallVectorImpl<CanQualType> &ArgTys) {
700 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,
709 llvm::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,
724 llvm::SmallVectorImpl<CanQualType> &ArgTys) {
725 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))
782 CGF.Builder.CreateStore(CGF.LoadCXXThis(), CGF.ReturnValue);
783}
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.
791 const llvm::Type *T =
792 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();
808 if (getContext().getLangOptions().ObjCAutoRefCount &&
809 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
John McCallf85e1932011-06-15 23:02:42 +0000836 // Automatic Reference Counting:
837 // We need an array cookie for pointers with strong or weak lifetime.
838 if (getContext().getLangOptions().ObjCAutoRefCount &&
839 elementType->isObjCLifetimeType()) {
840 switch (elementType.getObjCLifetime()) {
841 case Qualifiers::OCL_None:
842 case Qualifiers::OCL_ExplicitNone:
843 case Qualifiers::OCL_Autoreleasing:
844 return false;
845
846 case Qualifiers::OCL_Strong:
847 case Qualifiers::OCL_Weak:
848 return true;
849 }
850 }
851
John McCall6ec278d2011-01-27 09:37:56 +0000852 // Otherwise, if the class has a non-trivial destructor, it always
853 // needs a cookie.
854 const CXXRecordDecl *record =
855 elementType->getBaseElementTypeUnsafe()->getAsCXXRecordDecl();
856 return (record && !record->hasTrivialDestructor());
857}
858
859CharUnits ItaniumCXXABI::GetArrayCookieSize(const CXXNewExpr *expr) {
860 if (!NeedsArrayCookie(expr))
John McCall1e7fe752010-09-02 09:58:18 +0000861 return CharUnits::Zero();
862
John McCall6ec278d2011-01-27 09:37:56 +0000863 // Padding is the maximum of sizeof(size_t) and alignof(elementType)
John McCall9cb2cee2010-09-02 10:25:57 +0000864 ASTContext &Ctx = getContext();
John McCall1e7fe752010-09-02 09:58:18 +0000865 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
John McCall6ec278d2011-01-27 09:37:56 +0000866 Ctx.getTypeAlignInChars(expr->getAllocatedType()));
John McCall1e7fe752010-09-02 09:58:18 +0000867}
868
869llvm::Value *ItaniumCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
870 llvm::Value *NewPtr,
871 llvm::Value *NumElements,
John McCall6ec278d2011-01-27 09:37:56 +0000872 const CXXNewExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000873 QualType ElementType) {
John McCall6ec278d2011-01-27 09:37:56 +0000874 assert(NeedsArrayCookie(expr));
John McCall1e7fe752010-09-02 09:58:18 +0000875
876 unsigned AS = cast<llvm::PointerType>(NewPtr->getType())->getAddressSpace();
877
John McCall9cb2cee2010-09-02 10:25:57 +0000878 ASTContext &Ctx = getContext();
John McCall1e7fe752010-09-02 09:58:18 +0000879 QualType SizeTy = Ctx.getSizeType();
880 CharUnits SizeSize = Ctx.getTypeSizeInChars(SizeTy);
881
882 // The size of the cookie.
883 CharUnits CookieSize =
884 std::max(SizeSize, Ctx.getTypeAlignInChars(ElementType));
885
886 // Compute an offset to the cookie.
887 llvm::Value *CookiePtr = NewPtr;
888 CharUnits CookieOffset = CookieSize - SizeSize;
889 if (!CookieOffset.isZero())
890 CookiePtr = CGF.Builder.CreateConstInBoundsGEP1_64(CookiePtr,
891 CookieOffset.getQuantity());
892
893 // Write the number of elements into the appropriate slot.
894 llvm::Value *NumElementsPtr
895 = CGF.Builder.CreateBitCast(CookiePtr,
896 CGF.ConvertType(SizeTy)->getPointerTo(AS));
897 CGF.Builder.CreateStore(NumElements, NumElementsPtr);
898
899 // Finally, compute a pointer to the actual data buffer by skipping
900 // over the cookie completely.
901 return CGF.Builder.CreateConstInBoundsGEP1_64(NewPtr,
902 CookieSize.getQuantity());
903}
904
905void ItaniumCXXABI::ReadArrayCookie(CodeGenFunction &CGF,
906 llvm::Value *Ptr,
John McCall6ec278d2011-01-27 09:37:56 +0000907 const CXXDeleteExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000908 QualType ElementType,
909 llvm::Value *&NumElements,
910 llvm::Value *&AllocPtr,
911 CharUnits &CookieSize) {
912 // Derive a char* in the same address space as the pointer.
913 unsigned AS = cast<llvm::PointerType>(Ptr->getType())->getAddressSpace();
914 const llvm::Type *CharPtrTy = CGF.Builder.getInt8Ty()->getPointerTo(AS);
915
916 // If we don't need an array cookie, bail out early.
John McCall6ec278d2011-01-27 09:37:56 +0000917 if (!NeedsArrayCookie(expr, ElementType)) {
John McCall1e7fe752010-09-02 09:58:18 +0000918 AllocPtr = CGF.Builder.CreateBitCast(Ptr, CharPtrTy);
919 NumElements = 0;
920 CookieSize = CharUnits::Zero();
921 return;
922 }
923
John McCall9cb2cee2010-09-02 10:25:57 +0000924 QualType SizeTy = getContext().getSizeType();
925 CharUnits SizeSize = getContext().getTypeSizeInChars(SizeTy);
John McCall1e7fe752010-09-02 09:58:18 +0000926 const llvm::Type *SizeLTy = CGF.ConvertType(SizeTy);
927
928 CookieSize
John McCall9cb2cee2010-09-02 10:25:57 +0000929 = std::max(SizeSize, getContext().getTypeAlignInChars(ElementType));
John McCall1e7fe752010-09-02 09:58:18 +0000930
931 CharUnits NumElementsOffset = CookieSize - SizeSize;
932
933 // Compute the allocated pointer.
934 AllocPtr = CGF.Builder.CreateBitCast(Ptr, CharPtrTy);
935 AllocPtr = CGF.Builder.CreateConstInBoundsGEP1_64(AllocPtr,
936 -CookieSize.getQuantity());
937
938 llvm::Value *NumElementsPtr = AllocPtr;
939 if (!NumElementsOffset.isZero())
940 NumElementsPtr =
941 CGF.Builder.CreateConstInBoundsGEP1_64(NumElementsPtr,
942 NumElementsOffset.getQuantity());
943 NumElementsPtr =
944 CGF.Builder.CreateBitCast(NumElementsPtr, SizeLTy->getPointerTo(AS));
945 NumElements = CGF.Builder.CreateLoad(NumElementsPtr);
946}
947
John McCall6ec278d2011-01-27 09:37:56 +0000948CharUnits ARMCXXABI::GetArrayCookieSize(const CXXNewExpr *expr) {
949 if (!NeedsArrayCookie(expr))
John McCall1e7fe752010-09-02 09:58:18 +0000950 return CharUnits::Zero();
951
952 // On ARM, the cookie is always:
953 // struct array_cookie {
954 // std::size_t element_size; // element_size != 0
955 // std::size_t element_count;
956 // };
957 // TODO: what should we do if the allocated type actually wants
958 // greater alignment?
959 return getContext().getTypeSizeInChars(getContext().getSizeType()) * 2;
960}
961
962llvm::Value *ARMCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
963 llvm::Value *NewPtr,
964 llvm::Value *NumElements,
John McCall6ec278d2011-01-27 09:37:56 +0000965 const CXXNewExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000966 QualType ElementType) {
John McCall6ec278d2011-01-27 09:37:56 +0000967 assert(NeedsArrayCookie(expr));
John McCall1e7fe752010-09-02 09:58:18 +0000968
969 // NewPtr is a char*.
970
971 unsigned AS = cast<llvm::PointerType>(NewPtr->getType())->getAddressSpace();
972
John McCall9cb2cee2010-09-02 10:25:57 +0000973 ASTContext &Ctx = getContext();
John McCall1e7fe752010-09-02 09:58:18 +0000974 CharUnits SizeSize = Ctx.getTypeSizeInChars(Ctx.getSizeType());
975 const llvm::IntegerType *SizeTy =
976 cast<llvm::IntegerType>(CGF.ConvertType(Ctx.getSizeType()));
977
978 // The cookie is always at the start of the buffer.
979 llvm::Value *CookiePtr = NewPtr;
980
981 // The first element is the element size.
982 CookiePtr = CGF.Builder.CreateBitCast(CookiePtr, SizeTy->getPointerTo(AS));
983 llvm::Value *ElementSize = llvm::ConstantInt::get(SizeTy,
984 Ctx.getTypeSizeInChars(ElementType).getQuantity());
985 CGF.Builder.CreateStore(ElementSize, CookiePtr);
986
987 // The second element is the element count.
988 CookiePtr = CGF.Builder.CreateConstInBoundsGEP1_32(CookiePtr, 1);
989 CGF.Builder.CreateStore(NumElements, CookiePtr);
990
991 // Finally, compute a pointer to the actual data buffer by skipping
992 // over the cookie completely.
993 CharUnits CookieSize = 2 * SizeSize;
994 return CGF.Builder.CreateConstInBoundsGEP1_64(NewPtr,
995 CookieSize.getQuantity());
996}
997
998void ARMCXXABI::ReadArrayCookie(CodeGenFunction &CGF,
999 llvm::Value *Ptr,
John McCall6ec278d2011-01-27 09:37:56 +00001000 const CXXDeleteExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +00001001 QualType ElementType,
1002 llvm::Value *&NumElements,
1003 llvm::Value *&AllocPtr,
1004 CharUnits &CookieSize) {
1005 // Derive a char* in the same address space as the pointer.
1006 unsigned AS = cast<llvm::PointerType>(Ptr->getType())->getAddressSpace();
1007 const llvm::Type *CharPtrTy = CGF.Builder.getInt8Ty()->getPointerTo(AS);
1008
1009 // If we don't need an array cookie, bail out early.
John McCall6ec278d2011-01-27 09:37:56 +00001010 if (!NeedsArrayCookie(expr, ElementType)) {
John McCall1e7fe752010-09-02 09:58:18 +00001011 AllocPtr = CGF.Builder.CreateBitCast(Ptr, CharPtrTy);
1012 NumElements = 0;
1013 CookieSize = CharUnits::Zero();
1014 return;
1015 }
1016
John McCall9cb2cee2010-09-02 10:25:57 +00001017 QualType SizeTy = getContext().getSizeType();
1018 CharUnits SizeSize = getContext().getTypeSizeInChars(SizeTy);
John McCall1e7fe752010-09-02 09:58:18 +00001019 const llvm::Type *SizeLTy = CGF.ConvertType(SizeTy);
1020
1021 // The cookie size is always 2 * sizeof(size_t).
1022 CookieSize = 2 * SizeSize;
John McCall1e7fe752010-09-02 09:58:18 +00001023
1024 // The allocated pointer is the input ptr, minus that amount.
1025 AllocPtr = CGF.Builder.CreateBitCast(Ptr, CharPtrTy);
1026 AllocPtr = CGF.Builder.CreateConstInBoundsGEP1_64(AllocPtr,
1027 -CookieSize.getQuantity());
1028
1029 // The number of elements is at offset sizeof(size_t) relative to that.
1030 llvm::Value *NumElementsPtr
1031 = CGF.Builder.CreateConstInBoundsGEP1_64(AllocPtr,
1032 SizeSize.getQuantity());
1033 NumElementsPtr =
1034 CGF.Builder.CreateBitCast(NumElementsPtr, SizeLTy->getPointerTo(AS));
1035 NumElements = CGF.Builder.CreateLoad(NumElementsPtr);
1036}
1037
John McCall5cd91b52010-09-08 01:44:27 +00001038/*********************** Static local initialization **************************/
1039
1040static llvm::Constant *getGuardAcquireFn(CodeGenModule &CGM,
1041 const llvm::PointerType *GuardPtrTy) {
1042 // int __cxa_guard_acquire(__guard *guard_object);
John McCall5cd91b52010-09-08 01:44:27 +00001043 const llvm::FunctionType *FTy =
1044 llvm::FunctionType::get(CGM.getTypes().ConvertType(CGM.getContext().IntTy),
Benjamin Kramer95d318c2011-05-28 14:26:31 +00001045 GuardPtrTy, /*isVarArg=*/false);
John McCall5cd91b52010-09-08 01:44:27 +00001046
1047 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_acquire");
1048}
1049
1050static llvm::Constant *getGuardReleaseFn(CodeGenModule &CGM,
1051 const llvm::PointerType *GuardPtrTy) {
1052 // void __cxa_guard_release(__guard *guard_object);
John McCall5cd91b52010-09-08 01:44:27 +00001053 const llvm::FunctionType *FTy =
1054 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
Benjamin Kramer95d318c2011-05-28 14:26:31 +00001055 GuardPtrTy, /*isVarArg=*/false);
John McCall5cd91b52010-09-08 01:44:27 +00001056
1057 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_release");
1058}
1059
1060static llvm::Constant *getGuardAbortFn(CodeGenModule &CGM,
1061 const llvm::PointerType *GuardPtrTy) {
1062 // void __cxa_guard_abort(__guard *guard_object);
John McCall5cd91b52010-09-08 01:44:27 +00001063 const llvm::FunctionType *FTy =
1064 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
Benjamin Kramer95d318c2011-05-28 14:26:31 +00001065 GuardPtrTy, /*isVarArg=*/false);
John McCall5cd91b52010-09-08 01:44:27 +00001066
1067 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_abort");
1068}
1069
1070namespace {
1071 struct CallGuardAbort : EHScopeStack::Cleanup {
1072 llvm::GlobalVariable *Guard;
1073 CallGuardAbort(llvm::GlobalVariable *Guard) : Guard(Guard) {}
1074
1075 void Emit(CodeGenFunction &CGF, bool IsForEH) {
1076 CGF.Builder.CreateCall(getGuardAbortFn(CGF.CGM, Guard->getType()), Guard)
1077 ->setDoesNotThrow();
1078 }
1079 };
1080}
1081
1082/// The ARM code here follows the Itanium code closely enough that we
1083/// just special-case it at particular places.
John McCall3030eb82010-11-06 09:44:32 +00001084void ItaniumCXXABI::EmitGuardedInit(CodeGenFunction &CGF,
1085 const VarDecl &D,
1086 llvm::GlobalVariable *GV) {
John McCall5cd91b52010-09-08 01:44:27 +00001087 CGBuilderTy &Builder = CGF.Builder;
John McCall3030eb82010-11-06 09:44:32 +00001088
1089 // We only need to use thread-safe statics for local variables;
1090 // global initialization is always single-threaded.
1091 bool ThreadsafeStatics = (getContext().getLangOptions().ThreadsafeStatics &&
1092 D.isLocalVarDecl());
Anders Carlsson173d5122011-04-27 04:37:08 +00001093
1094 const llvm::IntegerType *GuardTy;
1095
1096 // If we have a global variable with internal linkage and thread-safe statics
1097 // are disabled, we can just let the guard variable be of type i8.
1098 bool UseInt8GuardVariable = !ThreadsafeStatics && GV->hasInternalLinkage();
1099 if (UseInt8GuardVariable)
1100 GuardTy = Builder.getInt8Ty();
1101 else {
1102 // Guard variables are 64 bits in the generic ABI and 32 bits on ARM.
1103 GuardTy = (IsARM ? Builder.getInt32Ty() : Builder.getInt64Ty());
1104 }
John McCall5cd91b52010-09-08 01:44:27 +00001105 const llvm::PointerType *GuardPtrTy = GuardTy->getPointerTo();
1106
1107 // Create the guard variable.
1108 llvm::SmallString<256> GuardVName;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00001109 llvm::raw_svector_ostream Out(GuardVName);
1110 getMangleContext().mangleItaniumGuardVariable(&D, Out);
1111 Out.flush();
John McCall112c9672010-11-02 21:04:24 +00001112
John McCall3030eb82010-11-06 09:44:32 +00001113 // Just absorb linkage and visibility from the variable.
John McCall5cd91b52010-09-08 01:44:27 +00001114 llvm::GlobalVariable *GuardVariable =
1115 new llvm::GlobalVariable(CGM.getModule(), GuardTy,
John McCall3030eb82010-11-06 09:44:32 +00001116 false, GV->getLinkage(),
John McCall5cd91b52010-09-08 01:44:27 +00001117 llvm::ConstantInt::get(GuardTy, 0),
1118 GuardVName.str());
John McCall112c9672010-11-02 21:04:24 +00001119 GuardVariable->setVisibility(GV->getVisibility());
John McCall5cd91b52010-09-08 01:44:27 +00001120
1121 // Test whether the variable has completed initialization.
1122 llvm::Value *IsInitialized;
1123
1124 // ARM C++ ABI 3.2.3.1:
1125 // To support the potential use of initialization guard variables
1126 // as semaphores that are the target of ARM SWP and LDREX/STREX
1127 // synchronizing instructions we define a static initialization
1128 // guard variable to be a 4-byte aligned, 4- byte word with the
1129 // following inline access protocol.
1130 // #define INITIALIZED 1
1131 // if ((obj_guard & INITIALIZED) != INITIALIZED) {
1132 // if (__cxa_guard_acquire(&obj_guard))
1133 // ...
1134 // }
Anders Carlsson173d5122011-04-27 04:37:08 +00001135 if (IsARM && !UseInt8GuardVariable) {
John McCall5cd91b52010-09-08 01:44:27 +00001136 llvm::Value *V = Builder.CreateLoad(GuardVariable);
1137 V = Builder.CreateAnd(V, Builder.getInt32(1));
1138 IsInitialized = Builder.CreateIsNull(V, "guard.uninitialized");
1139
1140 // Itanium C++ ABI 3.3.2:
1141 // The following is pseudo-code showing how these functions can be used:
1142 // if (obj_guard.first_byte == 0) {
1143 // if ( __cxa_guard_acquire (&obj_guard) ) {
1144 // try {
1145 // ... initialize the object ...;
1146 // } catch (...) {
1147 // __cxa_guard_abort (&obj_guard);
1148 // throw;
1149 // }
1150 // ... queue object destructor with __cxa_atexit() ...;
1151 // __cxa_guard_release (&obj_guard);
1152 // }
1153 // }
1154 } else {
1155 // Load the first byte of the guard variable.
1156 const llvm::Type *PtrTy = Builder.getInt8PtrTy();
1157 llvm::Value *V =
1158 Builder.CreateLoad(Builder.CreateBitCast(GuardVariable, PtrTy), "tmp");
1159
1160 IsInitialized = Builder.CreateIsNull(V, "guard.uninitialized");
1161 }
1162
1163 llvm::BasicBlock *InitCheckBlock = CGF.createBasicBlock("init.check");
1164 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
1165
1166 // Check if the first byte of the guard variable is zero.
1167 Builder.CreateCondBr(IsInitialized, InitCheckBlock, EndBlock);
1168
1169 CGF.EmitBlock(InitCheckBlock);
1170
1171 // Variables used when coping with thread-safe statics and exceptions.
1172 if (ThreadsafeStatics) {
1173 // Call __cxa_guard_acquire.
1174 llvm::Value *V
1175 = Builder.CreateCall(getGuardAcquireFn(CGM, GuardPtrTy), GuardVariable);
1176
1177 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
1178
1179 Builder.CreateCondBr(Builder.CreateIsNotNull(V, "tobool"),
1180 InitBlock, EndBlock);
1181
1182 // Call __cxa_guard_abort along the exceptional edge.
1183 CGF.EHStack.pushCleanup<CallGuardAbort>(EHCleanup, GuardVariable);
1184
1185 CGF.EmitBlock(InitBlock);
1186 }
1187
1188 // Emit the initializer and add a global destructor if appropriate.
1189 CGF.EmitCXXGlobalVarDeclInit(D, GV);
1190
1191 if (ThreadsafeStatics) {
1192 // Pop the guard-abort cleanup if we pushed one.
1193 CGF.PopCleanupBlock();
1194
1195 // Call __cxa_guard_release. This cannot throw.
1196 Builder.CreateCall(getGuardReleaseFn(CGM, GuardPtrTy), GuardVariable);
1197 } else {
1198 Builder.CreateStore(llvm::ConstantInt::get(GuardTy, 1), GuardVariable);
1199 }
1200
1201 CGF.EmitBlock(EndBlock);
1202}