blob: 95654a33a125f9dc5e7172c405cdf8f059822a95 [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//
10// This provides C++ code generation targetting the Itanium C++ ABI. The class
11// 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 McCall0bab0cd2010-08-23 01:21:21 +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);
285 llvm::PHINode *Callee = Builder.CreatePHI(FTy->getPointerTo());
286 Callee->reserveOperandSpace(2);
287 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.
Douglas Gregoreede61a2010-09-02 17:38:50 +0000312 const llvm::Type *PType
313 = CGF.ConvertTypeForMem(MPT->getPointeeType())->getPointerTo(AS);
John McCall6c2ab1d2010-08-31 21:07:20 +0000314 return Builder.CreateBitCast(Addr, PType);
315}
316
John McCall3023def2010-08-22 03:04:22 +0000317/// Perform a derived-to-base or base-to-derived member pointer conversion.
John McCall0bab0cd2010-08-23 01:21:21 +0000318///
319/// Obligatory offset/adjustment diagram:
320/// <-- offset --> <-- adjustment -->
321/// |--------------------------|----------------------|--------------------|
322/// ^Derived address point ^Base address point ^Member address point
323///
324/// So when converting a base member pointer to a derived member pointer,
325/// we add the offset to the adjustment because the address point has
326/// decreased; and conversely, when converting a derived MP to a base MP
327/// we subtract the offset from the adjustment because the address point
328/// has increased.
329///
330/// The standard forbids (at compile time) conversion to and from
331/// virtual bases, which is why we don't have to consider them here.
332///
333/// The standard forbids (at run time) casting a derived MP to a base
334/// MP when the derived MP does not point to a member of the base.
335/// This is why -1 is a reasonable choice for null data member
336/// pointers.
John McCalld608cdb2010-08-22 10:59:02 +0000337llvm::Value *
John McCall0bab0cd2010-08-23 01:21:21 +0000338ItaniumCXXABI::EmitMemberPointerConversion(CodeGenFunction &CGF,
339 const CastExpr *E,
340 llvm::Value *Src) {
John McCall2de56d12010-08-25 11:45:40 +0000341 assert(E->getCastKind() == CK_DerivedToBaseMemberPointer ||
342 E->getCastKind() == CK_BaseToDerivedMemberPointer);
John McCall3023def2010-08-22 03:04:22 +0000343
John McCalld608cdb2010-08-22 10:59:02 +0000344 if (isa<llvm::Constant>(Src))
John McCall0bab0cd2010-08-23 01:21:21 +0000345 return EmitMemberPointerConversion(cast<llvm::Constant>(Src), E);
John McCalld608cdb2010-08-22 10:59:02 +0000346
John McCall3023def2010-08-22 03:04:22 +0000347 CGBuilderTy &Builder = CGF.Builder;
348
349 const MemberPointerType *SrcTy =
350 E->getSubExpr()->getType()->getAs<MemberPointerType>();
351 const MemberPointerType *DestTy = E->getType()->getAs<MemberPointerType>();
352
353 const CXXRecordDecl *SrcDecl = SrcTy->getClass()->getAsCXXRecordDecl();
354 const CXXRecordDecl *DestDecl = DestTy->getClass()->getAsCXXRecordDecl();
355
John McCall3023def2010-08-22 03:04:22 +0000356 bool DerivedToBase =
John McCall2de56d12010-08-25 11:45:40 +0000357 E->getCastKind() == CK_DerivedToBaseMemberPointer;
John McCall3023def2010-08-22 03:04:22 +0000358
Jeffrey Yasskindec09842011-01-18 02:00:16 +0000359 const CXXRecordDecl *DerivedDecl;
John McCall3023def2010-08-22 03:04:22 +0000360 if (DerivedToBase)
Jeffrey Yasskindec09842011-01-18 02:00:16 +0000361 DerivedDecl = SrcDecl;
John McCall3023def2010-08-22 03:04:22 +0000362 else
Jeffrey Yasskindec09842011-01-18 02:00:16 +0000363 DerivedDecl = DestDecl;
John McCall3023def2010-08-22 03:04:22 +0000364
John McCalld608cdb2010-08-22 10:59:02 +0000365 llvm::Constant *Adj =
366 CGF.CGM.GetNonVirtualBaseClassOffset(DerivedDecl,
367 E->path_begin(),
368 E->path_end());
369 if (!Adj) return Src;
John McCall875ab102010-08-22 06:43:33 +0000370
John McCall0bab0cd2010-08-23 01:21:21 +0000371 // For member data pointers, this is just a matter of adding the
372 // offset if the source is non-null.
373 if (SrcTy->isMemberDataPointer()) {
374 llvm::Value *Dst;
375 if (DerivedToBase)
376 Dst = Builder.CreateNSWSub(Src, Adj, "adj");
377 else
378 Dst = Builder.CreateNSWAdd(Src, Adj, "adj");
379
380 // Null check.
381 llvm::Value *Null = llvm::Constant::getAllOnesValue(Src->getType());
382 llvm::Value *IsNull = Builder.CreateICmpEQ(Src, Null, "memptr.isnull");
383 return Builder.CreateSelect(IsNull, Src, Dst);
384 }
385
John McCalld608cdb2010-08-22 10:59:02 +0000386 // The this-adjustment is left-shifted by 1 on ARM.
387 if (IsARM) {
388 uint64_t Offset = cast<llvm::ConstantInt>(Adj)->getZExtValue();
389 Offset <<= 1;
390 Adj = llvm::ConstantInt::get(Adj->getType(), Offset);
391 }
392
John McCalle14add42010-08-22 11:04:31 +0000393 llvm::Value *SrcAdj = Builder.CreateExtractValue(Src, 1, "src.adj");
John McCalld608cdb2010-08-22 10:59:02 +0000394 llvm::Value *DstAdj;
395 if (DerivedToBase)
John McCall0bab0cd2010-08-23 01:21:21 +0000396 DstAdj = Builder.CreateNSWSub(SrcAdj, Adj, "adj");
John McCalld608cdb2010-08-22 10:59:02 +0000397 else
John McCall0bab0cd2010-08-23 01:21:21 +0000398 DstAdj = Builder.CreateNSWAdd(SrcAdj, Adj, "adj");
John McCalld608cdb2010-08-22 10:59:02 +0000399
John McCalle14add42010-08-22 11:04:31 +0000400 return Builder.CreateInsertValue(Src, DstAdj, 1);
John McCall3023def2010-08-22 03:04:22 +0000401}
John McCallcf2c85e2010-08-22 04:16:24 +0000402
403llvm::Constant *
John McCall0bab0cd2010-08-23 01:21:21 +0000404ItaniumCXXABI::EmitMemberPointerConversion(llvm::Constant *C,
405 const CastExpr *E) {
John McCallcf2c85e2010-08-22 04:16:24 +0000406 const MemberPointerType *SrcTy =
407 E->getSubExpr()->getType()->getAs<MemberPointerType>();
408 const MemberPointerType *DestTy =
409 E->getType()->getAs<MemberPointerType>();
410
411 bool DerivedToBase =
John McCall2de56d12010-08-25 11:45:40 +0000412 E->getCastKind() == CK_DerivedToBaseMemberPointer;
John McCallcf2c85e2010-08-22 04:16:24 +0000413
414 const CXXRecordDecl *DerivedDecl;
415 if (DerivedToBase)
416 DerivedDecl = SrcTy->getClass()->getAsCXXRecordDecl();
417 else
418 DerivedDecl = DestTy->getClass()->getAsCXXRecordDecl();
419
420 // Calculate the offset to the base class.
421 llvm::Constant *Offset =
422 CGM.GetNonVirtualBaseClassOffset(DerivedDecl,
423 E->path_begin(),
424 E->path_end());
425 // If there's no offset, we're done.
426 if (!Offset) return C;
427
John McCall0bab0cd2010-08-23 01:21:21 +0000428 // If the source is a member data pointer, we have to do a null
429 // check and then add the offset. In the common case, we can fold
430 // away the offset.
431 if (SrcTy->isMemberDataPointer()) {
432 assert(C->getType() == getPtrDiffTy());
433
434 // If it's a constant int, just create a new constant int.
435 if (llvm::ConstantInt *CI = dyn_cast<llvm::ConstantInt>(C)) {
436 int64_t Src = CI->getSExtValue();
437
438 // Null converts to null.
439 if (Src == -1) return CI;
440
441 // Otherwise, just add the offset.
442 int64_t OffsetV = cast<llvm::ConstantInt>(Offset)->getSExtValue();
443 int64_t Dst = (DerivedToBase ? Src - OffsetV : Src + OffsetV);
444 return llvm::ConstantInt::get(CI->getType(), Dst, /*signed*/ true);
445 }
446
447 // Otherwise, we have to form a constant select expression.
448 llvm::Constant *Null = llvm::Constant::getAllOnesValue(C->getType());
449
450 llvm::Constant *IsNull =
451 llvm::ConstantExpr::getICmp(llvm::ICmpInst::ICMP_EQ, C, Null);
452
453 llvm::Constant *Dst;
454 if (DerivedToBase)
455 Dst = llvm::ConstantExpr::getNSWSub(C, Offset);
456 else
457 Dst = llvm::ConstantExpr::getNSWAdd(C, Offset);
458
459 return llvm::ConstantExpr::getSelect(IsNull, Null, Dst);
460 }
461
John McCall875ab102010-08-22 06:43:33 +0000462 // The this-adjustment is left-shifted by 1 on ARM.
463 if (IsARM) {
John McCall0bab0cd2010-08-23 01:21:21 +0000464 int64_t OffsetV = cast<llvm::ConstantInt>(Offset)->getSExtValue();
John McCall875ab102010-08-22 06:43:33 +0000465 OffsetV <<= 1;
466 Offset = llvm::ConstantInt::get(Offset->getType(), OffsetV);
467 }
468
John McCallcf2c85e2010-08-22 04:16:24 +0000469 llvm::ConstantStruct *CS = cast<llvm::ConstantStruct>(C);
470
John McCall0bab0cd2010-08-23 01:21:21 +0000471 llvm::Constant *Values[2] = { CS->getOperand(0), 0 };
472 if (DerivedToBase)
473 Values[1] = llvm::ConstantExpr::getSub(CS->getOperand(1), Offset);
474 else
475 Values[1] = llvm::ConstantExpr::getAdd(CS->getOperand(1), Offset);
476
John McCallcf2c85e2010-08-22 04:16:24 +0000477 return llvm::ConstantStruct::get(CGM.getLLVMContext(), Values, 2,
478 /*Packed=*/false);
479}
480
481
John McCallcf2c85e2010-08-22 04:16:24 +0000482llvm::Constant *
John McCall0bab0cd2010-08-23 01:21:21 +0000483ItaniumCXXABI::EmitNullMemberPointer(const MemberPointerType *MPT) {
484 const llvm::Type *ptrdiff_t = getPtrDiffTy();
485
486 // Itanium C++ ABI 2.3:
487 // A NULL pointer is represented as -1.
488 if (MPT->isMemberDataPointer())
489 return llvm::ConstantInt::get(ptrdiff_t, -1ULL, /*isSigned=*/true);
John McCalld608cdb2010-08-22 10:59:02 +0000490
491 llvm::Constant *Zero = llvm::ConstantInt::get(ptrdiff_t, 0);
492 llvm::Constant *Values[2] = { Zero, Zero };
493 return llvm::ConstantStruct::get(CGM.getLLVMContext(), Values, 2,
494 /*Packed=*/false);
John McCallcf2c85e2010-08-22 04:16:24 +0000495}
496
John McCall5808ce42011-02-03 08:15:49 +0000497llvm::Constant *
498ItaniumCXXABI::EmitMemberDataPointer(const MemberPointerType *MPT,
499 CharUnits offset) {
John McCall0bab0cd2010-08-23 01:21:21 +0000500 // Itanium C++ ABI 2.3:
501 // A pointer to data member is an offset from the base address of
502 // the class object containing it, represented as a ptrdiff_t
John McCall5808ce42011-02-03 08:15:49 +0000503 return llvm::ConstantInt::get(getPtrDiffTy(), offset.getQuantity());
John McCall0bab0cd2010-08-23 01:21:21 +0000504}
505
506llvm::Constant *ItaniumCXXABI::EmitMemberPointer(const CXXMethodDecl *MD) {
John McCalld608cdb2010-08-22 10:59:02 +0000507 assert(MD->isInstance() && "Member function must not be static!");
508 MD = MD->getCanonicalDecl();
509
510 CodeGenTypes &Types = CGM.getTypes();
John McCall0bab0cd2010-08-23 01:21:21 +0000511 const llvm::Type *ptrdiff_t = getPtrDiffTy();
John McCalld608cdb2010-08-22 10:59:02 +0000512
513 // Get the function pointer (or index if this is a virtual function).
514 llvm::Constant *MemPtr[2];
515 if (MD->isVirtual()) {
516 uint64_t Index = CGM.getVTables().getMethodVTableIndex(MD);
517
518 // FIXME: We shouldn't use / 8 here.
519 uint64_t PointerWidthInBytes =
John McCall9cb2cee2010-09-02 10:25:57 +0000520 getContext().Target.getPointerWidth(0) / 8;
John McCalld608cdb2010-08-22 10:59:02 +0000521 uint64_t VTableOffset = (Index * PointerWidthInBytes);
522
523 if (IsARM) {
524 // ARM C++ ABI 3.2.1:
525 // This ABI specifies that adj contains twice the this
526 // adjustment, plus 1 if the member function is virtual. The
527 // least significant bit of adj then makes exactly the same
528 // discrimination as the least significant bit of ptr does for
529 // Itanium.
530 MemPtr[0] = llvm::ConstantInt::get(ptrdiff_t, VTableOffset);
531 MemPtr[1] = llvm::ConstantInt::get(ptrdiff_t, 1);
532 } else {
533 // Itanium C++ ABI 2.3:
534 // For a virtual function, [the pointer field] is 1 plus the
535 // virtual table offset (in bytes) of the function,
536 // represented as a ptrdiff_t.
537 MemPtr[0] = llvm::ConstantInt::get(ptrdiff_t, VTableOffset + 1);
538 MemPtr[1] = llvm::ConstantInt::get(ptrdiff_t, 0);
539 }
540 } else {
541 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
542 const llvm::Type *Ty;
543 // Check whether the function has a computable LLVM signature.
544 if (!CodeGenTypes::VerifyFuncTypeComplete(FPT)) {
545 // The function has a computable LLVM signature; use the correct type.
546 Ty = Types.GetFunctionType(Types.getFunctionInfo(MD), FPT->isVariadic());
547 } else {
548 // Use an arbitrary non-function type to tell GetAddrOfFunction that the
549 // function type is incomplete.
550 Ty = ptrdiff_t;
551 }
552
553 llvm::Constant *Addr = CGM.GetAddrOfFunction(MD, Ty);
554 MemPtr[0] = llvm::ConstantExpr::getPtrToInt(Addr, ptrdiff_t);
555 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
654 // In Itanium, a member function pointer is null if 'ptr' is 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
660 // In ARM, it's that, plus the low bit of 'adj' must be zero.
661 if (IsARM) {
662 llvm::Constant *One = llvm::ConstantInt::get(Ptr->getType(), 1);
John McCalld608cdb2010-08-22 10:59:02 +0000663 llvm::Value *Adj = Builder.CreateExtractValue(MemPtr, 1, "memptr.adj");
John McCalle9fd7eb2010-08-22 08:30:07 +0000664 llvm::Value *VirtualBit = Builder.CreateAnd(Adj, One, "memptr.virtualbit");
665 llvm::Value *IsNotVirtual = Builder.CreateICmpEQ(VirtualBit, Zero,
666 "memptr.notvirtual");
667 Result = Builder.CreateAnd(Result, IsNotVirtual);
668 }
669
670 return Result;
671}
John McCall875ab102010-08-22 06:43:33 +0000672
John McCallf16aa102010-08-22 21:01:12 +0000673/// The Itanium ABI requires non-zero initialization only for data
674/// member pointers, for which '0' is a valid offset.
675bool ItaniumCXXABI::isZeroInitializable(const MemberPointerType *MPT) {
676 return MPT->getPointeeType()->isFunctionType();
John McCallcf2c85e2010-08-22 04:16:24 +0000677}
John McCall4c40d982010-08-31 07:33:07 +0000678
679/// The generic ABI passes 'this', plus a VTT if it's initializing a
680/// base subobject.
681void ItaniumCXXABI::BuildConstructorSignature(const CXXConstructorDecl *Ctor,
682 CXXCtorType Type,
683 CanQualType &ResTy,
684 llvm::SmallVectorImpl<CanQualType> &ArgTys) {
John McCall9cb2cee2010-09-02 10:25:57 +0000685 ASTContext &Context = getContext();
John McCall4c40d982010-08-31 07:33:07 +0000686
687 // 'this' is already there.
688
689 // Check if we need to add a VTT parameter (which has type void **).
690 if (Type == Ctor_Base && Ctor->getParent()->getNumVBases() != 0)
691 ArgTys.push_back(Context.getPointerType(Context.VoidPtrTy));
692}
693
694/// The ARM ABI does the same as the Itanium ABI, but returns 'this'.
695void ARMCXXABI::BuildConstructorSignature(const CXXConstructorDecl *Ctor,
696 CXXCtorType Type,
697 CanQualType &ResTy,
698 llvm::SmallVectorImpl<CanQualType> &ArgTys) {
699 ItaniumCXXABI::BuildConstructorSignature(Ctor, Type, ResTy, ArgTys);
700 ResTy = ArgTys[0];
701}
702
703/// The generic ABI passes 'this', plus a VTT if it's destroying a
704/// base subobject.
705void ItaniumCXXABI::BuildDestructorSignature(const CXXDestructorDecl *Dtor,
706 CXXDtorType Type,
707 CanQualType &ResTy,
708 llvm::SmallVectorImpl<CanQualType> &ArgTys) {
John McCall9cb2cee2010-09-02 10:25:57 +0000709 ASTContext &Context = getContext();
John McCall4c40d982010-08-31 07:33:07 +0000710
711 // 'this' is already there.
712
713 // Check if we need to add a VTT parameter (which has type void **).
714 if (Type == Dtor_Base && Dtor->getParent()->getNumVBases() != 0)
715 ArgTys.push_back(Context.getPointerType(Context.VoidPtrTy));
716}
717
718/// The ARM ABI does the same as the Itanium ABI, but returns 'this'
719/// for non-deleting destructors.
720void ARMCXXABI::BuildDestructorSignature(const CXXDestructorDecl *Dtor,
721 CXXDtorType Type,
722 CanQualType &ResTy,
723 llvm::SmallVectorImpl<CanQualType> &ArgTys) {
724 ItaniumCXXABI::BuildDestructorSignature(Dtor, Type, ResTy, ArgTys);
725
726 if (Type != Dtor_Deleting)
727 ResTy = ArgTys[0];
728}
729
730void ItaniumCXXABI::BuildInstanceFunctionParams(CodeGenFunction &CGF,
731 QualType &ResTy,
732 FunctionArgList &Params) {
733 /// Create the 'this' variable.
734 BuildThisParam(CGF, Params);
735
736 const CXXMethodDecl *MD = cast<CXXMethodDecl>(CGF.CurGD.getDecl());
737 assert(MD->isInstance());
738
739 // Check if we need a VTT parameter as well.
740 if (CodeGenVTables::needsVTTParameter(CGF.CurGD)) {
John McCall9cb2cee2010-09-02 10:25:57 +0000741 ASTContext &Context = getContext();
John McCall4c40d982010-08-31 07:33:07 +0000742
743 // FIXME: avoid the fake decl
744 QualType T = Context.getPointerType(Context.VoidPtrTy);
745 ImplicitParamDecl *VTTDecl
746 = ImplicitParamDecl::Create(Context, 0, MD->getLocation(),
747 &Context.Idents.get("vtt"), T);
748 Params.push_back(std::make_pair(VTTDecl, VTTDecl->getType()));
749 getVTTDecl(CGF) = VTTDecl;
750 }
751}
752
753void ARMCXXABI::BuildInstanceFunctionParams(CodeGenFunction &CGF,
754 QualType &ResTy,
755 FunctionArgList &Params) {
756 ItaniumCXXABI::BuildInstanceFunctionParams(CGF, ResTy, Params);
757
758 // Return 'this' from certain constructors and destructors.
759 if (HasThisReturn(CGF.CurGD))
760 ResTy = Params[0].second;
761}
762
763void ItaniumCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
764 /// Initialize the 'this' slot.
765 EmitThisParam(CGF);
766
767 /// Initialize the 'vtt' slot if needed.
768 if (getVTTDecl(CGF)) {
769 getVTTValue(CGF)
770 = CGF.Builder.CreateLoad(CGF.GetAddrOfLocalVar(getVTTDecl(CGF)),
771 "vtt");
772 }
773}
774
775void ARMCXXABI::EmitInstanceFunctionProlog(CodeGenFunction &CGF) {
776 ItaniumCXXABI::EmitInstanceFunctionProlog(CGF);
777
778 /// Initialize the return slot to 'this' at the start of the
779 /// function.
780 if (HasThisReturn(CGF.CurGD))
781 CGF.Builder.CreateStore(CGF.LoadCXXThis(), CGF.ReturnValue);
782}
783
784void ARMCXXABI::EmitReturnFromThunk(CodeGenFunction &CGF,
785 RValue RV, QualType ResultType) {
786 if (!isa<CXXDestructorDecl>(CGF.CurGD.getDecl()))
787 return ItaniumCXXABI::EmitReturnFromThunk(CGF, RV, ResultType);
788
789 // Destructor thunks in the ARM ABI have indeterminate results.
790 const llvm::Type *T =
791 cast<llvm::PointerType>(CGF.ReturnValue->getType())->getElementType();
792 RValue Undef = RValue::get(llvm::UndefValue::get(T));
793 return ItaniumCXXABI::EmitReturnFromThunk(CGF, Undef, ResultType);
794}
John McCall1e7fe752010-09-02 09:58:18 +0000795
796/************************** Array allocation cookies **************************/
797
John McCall6ec278d2011-01-27 09:37:56 +0000798bool ItaniumCXXABI::NeedsArrayCookie(const CXXNewExpr *expr) {
John McCall1e7fe752010-09-02 09:58:18 +0000799 // If the class's usual deallocation function takes two arguments,
John McCall6ec278d2011-01-27 09:37:56 +0000800 // it needs a cookie.
801 if (expr->doesUsualArrayDeleteWantSize())
802 return true;
John McCall1e7fe752010-09-02 09:58:18 +0000803
John McCall6ec278d2011-01-27 09:37:56 +0000804 // Otherwise, if the class has a non-trivial destructor, it always
805 // needs a cookie.
806 const CXXRecordDecl *record =
807 expr->getAllocatedType()->getBaseElementTypeUnsafe()->getAsCXXRecordDecl();
808 return (record && !record->hasTrivialDestructor());
John McCall1e7fe752010-09-02 09:58:18 +0000809}
810
John McCall6ec278d2011-01-27 09:37:56 +0000811bool ItaniumCXXABI::NeedsArrayCookie(const CXXDeleteExpr *expr,
812 QualType elementType) {
813 // If the class's usual deallocation function takes two arguments,
814 // it needs a cookie.
815 if (expr->doesUsualArrayDeleteWantSize())
816 return true;
817
818 // Otherwise, if the class has a non-trivial destructor, it always
819 // needs a cookie.
820 const CXXRecordDecl *record =
821 elementType->getBaseElementTypeUnsafe()->getAsCXXRecordDecl();
822 return (record && !record->hasTrivialDestructor());
823}
824
825CharUnits ItaniumCXXABI::GetArrayCookieSize(const CXXNewExpr *expr) {
826 if (!NeedsArrayCookie(expr))
John McCall1e7fe752010-09-02 09:58:18 +0000827 return CharUnits::Zero();
828
John McCall6ec278d2011-01-27 09:37:56 +0000829 // Padding is the maximum of sizeof(size_t) and alignof(elementType)
John McCall9cb2cee2010-09-02 10:25:57 +0000830 ASTContext &Ctx = getContext();
John McCall1e7fe752010-09-02 09:58:18 +0000831 return std::max(Ctx.getTypeSizeInChars(Ctx.getSizeType()),
John McCall6ec278d2011-01-27 09:37:56 +0000832 Ctx.getTypeAlignInChars(expr->getAllocatedType()));
John McCall1e7fe752010-09-02 09:58:18 +0000833}
834
835llvm::Value *ItaniumCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
836 llvm::Value *NewPtr,
837 llvm::Value *NumElements,
John McCall6ec278d2011-01-27 09:37:56 +0000838 const CXXNewExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000839 QualType ElementType) {
John McCall6ec278d2011-01-27 09:37:56 +0000840 assert(NeedsArrayCookie(expr));
John McCall1e7fe752010-09-02 09:58:18 +0000841
842 unsigned AS = cast<llvm::PointerType>(NewPtr->getType())->getAddressSpace();
843
John McCall9cb2cee2010-09-02 10:25:57 +0000844 ASTContext &Ctx = getContext();
John McCall1e7fe752010-09-02 09:58:18 +0000845 QualType SizeTy = Ctx.getSizeType();
846 CharUnits SizeSize = Ctx.getTypeSizeInChars(SizeTy);
847
848 // The size of the cookie.
849 CharUnits CookieSize =
850 std::max(SizeSize, Ctx.getTypeAlignInChars(ElementType));
851
852 // Compute an offset to the cookie.
853 llvm::Value *CookiePtr = NewPtr;
854 CharUnits CookieOffset = CookieSize - SizeSize;
855 if (!CookieOffset.isZero())
856 CookiePtr = CGF.Builder.CreateConstInBoundsGEP1_64(CookiePtr,
857 CookieOffset.getQuantity());
858
859 // Write the number of elements into the appropriate slot.
860 llvm::Value *NumElementsPtr
861 = CGF.Builder.CreateBitCast(CookiePtr,
862 CGF.ConvertType(SizeTy)->getPointerTo(AS));
863 CGF.Builder.CreateStore(NumElements, NumElementsPtr);
864
865 // Finally, compute a pointer to the actual data buffer by skipping
866 // over the cookie completely.
867 return CGF.Builder.CreateConstInBoundsGEP1_64(NewPtr,
868 CookieSize.getQuantity());
869}
870
871void ItaniumCXXABI::ReadArrayCookie(CodeGenFunction &CGF,
872 llvm::Value *Ptr,
John McCall6ec278d2011-01-27 09:37:56 +0000873 const CXXDeleteExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000874 QualType ElementType,
875 llvm::Value *&NumElements,
876 llvm::Value *&AllocPtr,
877 CharUnits &CookieSize) {
878 // Derive a char* in the same address space as the pointer.
879 unsigned AS = cast<llvm::PointerType>(Ptr->getType())->getAddressSpace();
880 const llvm::Type *CharPtrTy = CGF.Builder.getInt8Ty()->getPointerTo(AS);
881
882 // If we don't need an array cookie, bail out early.
John McCall6ec278d2011-01-27 09:37:56 +0000883 if (!NeedsArrayCookie(expr, ElementType)) {
John McCall1e7fe752010-09-02 09:58:18 +0000884 AllocPtr = CGF.Builder.CreateBitCast(Ptr, CharPtrTy);
885 NumElements = 0;
886 CookieSize = CharUnits::Zero();
887 return;
888 }
889
John McCall9cb2cee2010-09-02 10:25:57 +0000890 QualType SizeTy = getContext().getSizeType();
891 CharUnits SizeSize = getContext().getTypeSizeInChars(SizeTy);
John McCall1e7fe752010-09-02 09:58:18 +0000892 const llvm::Type *SizeLTy = CGF.ConvertType(SizeTy);
893
894 CookieSize
John McCall9cb2cee2010-09-02 10:25:57 +0000895 = std::max(SizeSize, getContext().getTypeAlignInChars(ElementType));
John McCall1e7fe752010-09-02 09:58:18 +0000896
897 CharUnits NumElementsOffset = CookieSize - SizeSize;
898
899 // Compute the allocated pointer.
900 AllocPtr = CGF.Builder.CreateBitCast(Ptr, CharPtrTy);
901 AllocPtr = CGF.Builder.CreateConstInBoundsGEP1_64(AllocPtr,
902 -CookieSize.getQuantity());
903
904 llvm::Value *NumElementsPtr = AllocPtr;
905 if (!NumElementsOffset.isZero())
906 NumElementsPtr =
907 CGF.Builder.CreateConstInBoundsGEP1_64(NumElementsPtr,
908 NumElementsOffset.getQuantity());
909 NumElementsPtr =
910 CGF.Builder.CreateBitCast(NumElementsPtr, SizeLTy->getPointerTo(AS));
911 NumElements = CGF.Builder.CreateLoad(NumElementsPtr);
912}
913
John McCall6ec278d2011-01-27 09:37:56 +0000914CharUnits ARMCXXABI::GetArrayCookieSize(const CXXNewExpr *expr) {
915 if (!NeedsArrayCookie(expr))
John McCall1e7fe752010-09-02 09:58:18 +0000916 return CharUnits::Zero();
917
918 // On ARM, the cookie is always:
919 // struct array_cookie {
920 // std::size_t element_size; // element_size != 0
921 // std::size_t element_count;
922 // };
923 // TODO: what should we do if the allocated type actually wants
924 // greater alignment?
925 return getContext().getTypeSizeInChars(getContext().getSizeType()) * 2;
926}
927
928llvm::Value *ARMCXXABI::InitializeArrayCookie(CodeGenFunction &CGF,
929 llvm::Value *NewPtr,
930 llvm::Value *NumElements,
John McCall6ec278d2011-01-27 09:37:56 +0000931 const CXXNewExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000932 QualType ElementType) {
John McCall6ec278d2011-01-27 09:37:56 +0000933 assert(NeedsArrayCookie(expr));
John McCall1e7fe752010-09-02 09:58:18 +0000934
935 // NewPtr is a char*.
936
937 unsigned AS = cast<llvm::PointerType>(NewPtr->getType())->getAddressSpace();
938
John McCall9cb2cee2010-09-02 10:25:57 +0000939 ASTContext &Ctx = getContext();
John McCall1e7fe752010-09-02 09:58:18 +0000940 CharUnits SizeSize = Ctx.getTypeSizeInChars(Ctx.getSizeType());
941 const llvm::IntegerType *SizeTy =
942 cast<llvm::IntegerType>(CGF.ConvertType(Ctx.getSizeType()));
943
944 // The cookie is always at the start of the buffer.
945 llvm::Value *CookiePtr = NewPtr;
946
947 // The first element is the element size.
948 CookiePtr = CGF.Builder.CreateBitCast(CookiePtr, SizeTy->getPointerTo(AS));
949 llvm::Value *ElementSize = llvm::ConstantInt::get(SizeTy,
950 Ctx.getTypeSizeInChars(ElementType).getQuantity());
951 CGF.Builder.CreateStore(ElementSize, CookiePtr);
952
953 // The second element is the element count.
954 CookiePtr = CGF.Builder.CreateConstInBoundsGEP1_32(CookiePtr, 1);
955 CGF.Builder.CreateStore(NumElements, CookiePtr);
956
957 // Finally, compute a pointer to the actual data buffer by skipping
958 // over the cookie completely.
959 CharUnits CookieSize = 2 * SizeSize;
960 return CGF.Builder.CreateConstInBoundsGEP1_64(NewPtr,
961 CookieSize.getQuantity());
962}
963
964void ARMCXXABI::ReadArrayCookie(CodeGenFunction &CGF,
965 llvm::Value *Ptr,
John McCall6ec278d2011-01-27 09:37:56 +0000966 const CXXDeleteExpr *expr,
John McCall1e7fe752010-09-02 09:58:18 +0000967 QualType ElementType,
968 llvm::Value *&NumElements,
969 llvm::Value *&AllocPtr,
970 CharUnits &CookieSize) {
971 // Derive a char* in the same address space as the pointer.
972 unsigned AS = cast<llvm::PointerType>(Ptr->getType())->getAddressSpace();
973 const llvm::Type *CharPtrTy = CGF.Builder.getInt8Ty()->getPointerTo(AS);
974
975 // If we don't need an array cookie, bail out early.
John McCall6ec278d2011-01-27 09:37:56 +0000976 if (!NeedsArrayCookie(expr, ElementType)) {
John McCall1e7fe752010-09-02 09:58:18 +0000977 AllocPtr = CGF.Builder.CreateBitCast(Ptr, CharPtrTy);
978 NumElements = 0;
979 CookieSize = CharUnits::Zero();
980 return;
981 }
982
John McCall9cb2cee2010-09-02 10:25:57 +0000983 QualType SizeTy = getContext().getSizeType();
984 CharUnits SizeSize = getContext().getTypeSizeInChars(SizeTy);
John McCall1e7fe752010-09-02 09:58:18 +0000985 const llvm::Type *SizeLTy = CGF.ConvertType(SizeTy);
986
987 // The cookie size is always 2 * sizeof(size_t).
988 CookieSize = 2 * SizeSize;
John McCall1e7fe752010-09-02 09:58:18 +0000989
990 // The allocated pointer is the input ptr, minus that amount.
991 AllocPtr = CGF.Builder.CreateBitCast(Ptr, CharPtrTy);
992 AllocPtr = CGF.Builder.CreateConstInBoundsGEP1_64(AllocPtr,
993 -CookieSize.getQuantity());
994
995 // The number of elements is at offset sizeof(size_t) relative to that.
996 llvm::Value *NumElementsPtr
997 = CGF.Builder.CreateConstInBoundsGEP1_64(AllocPtr,
998 SizeSize.getQuantity());
999 NumElementsPtr =
1000 CGF.Builder.CreateBitCast(NumElementsPtr, SizeLTy->getPointerTo(AS));
1001 NumElements = CGF.Builder.CreateLoad(NumElementsPtr);
1002}
1003
John McCall5cd91b52010-09-08 01:44:27 +00001004/*********************** Static local initialization **************************/
1005
1006static llvm::Constant *getGuardAcquireFn(CodeGenModule &CGM,
1007 const llvm::PointerType *GuardPtrTy) {
1008 // int __cxa_guard_acquire(__guard *guard_object);
1009
1010 std::vector<const llvm::Type*> Args(1, GuardPtrTy);
1011 const llvm::FunctionType *FTy =
1012 llvm::FunctionType::get(CGM.getTypes().ConvertType(CGM.getContext().IntTy),
1013 Args, /*isVarArg=*/false);
1014
1015 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_acquire");
1016}
1017
1018static llvm::Constant *getGuardReleaseFn(CodeGenModule &CGM,
1019 const llvm::PointerType *GuardPtrTy) {
1020 // void __cxa_guard_release(__guard *guard_object);
1021
1022 std::vector<const llvm::Type*> Args(1, GuardPtrTy);
1023
1024 const llvm::FunctionType *FTy =
1025 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
1026 Args, /*isVarArg=*/false);
1027
1028 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_release");
1029}
1030
1031static llvm::Constant *getGuardAbortFn(CodeGenModule &CGM,
1032 const llvm::PointerType *GuardPtrTy) {
1033 // void __cxa_guard_abort(__guard *guard_object);
1034
1035 std::vector<const llvm::Type*> Args(1, GuardPtrTy);
1036
1037 const llvm::FunctionType *FTy =
1038 llvm::FunctionType::get(llvm::Type::getVoidTy(CGM.getLLVMContext()),
1039 Args, /*isVarArg=*/false);
1040
1041 return CGM.CreateRuntimeFunction(FTy, "__cxa_guard_abort");
1042}
1043
1044namespace {
1045 struct CallGuardAbort : EHScopeStack::Cleanup {
1046 llvm::GlobalVariable *Guard;
1047 CallGuardAbort(llvm::GlobalVariable *Guard) : Guard(Guard) {}
1048
1049 void Emit(CodeGenFunction &CGF, bool IsForEH) {
1050 CGF.Builder.CreateCall(getGuardAbortFn(CGF.CGM, Guard->getType()), Guard)
1051 ->setDoesNotThrow();
1052 }
1053 };
1054}
1055
1056/// The ARM code here follows the Itanium code closely enough that we
1057/// just special-case it at particular places.
John McCall3030eb82010-11-06 09:44:32 +00001058void ItaniumCXXABI::EmitGuardedInit(CodeGenFunction &CGF,
1059 const VarDecl &D,
1060 llvm::GlobalVariable *GV) {
John McCall5cd91b52010-09-08 01:44:27 +00001061 CGBuilderTy &Builder = CGF.Builder;
John McCall3030eb82010-11-06 09:44:32 +00001062
1063 // We only need to use thread-safe statics for local variables;
1064 // global initialization is always single-threaded.
1065 bool ThreadsafeStatics = (getContext().getLangOptions().ThreadsafeStatics &&
1066 D.isLocalVarDecl());
John McCall5cd91b52010-09-08 01:44:27 +00001067
1068 // Guard variables are 64 bits in the generic ABI and 32 bits on ARM.
1069 const llvm::IntegerType *GuardTy
1070 = (IsARM ? Builder.getInt32Ty() : Builder.getInt64Ty());
1071 const llvm::PointerType *GuardPtrTy = GuardTy->getPointerTo();
1072
1073 // Create the guard variable.
1074 llvm::SmallString<256> GuardVName;
Rafael Espindolaf0be9792011-02-11 02:52:17 +00001075 llvm::raw_svector_ostream Out(GuardVName);
1076 getMangleContext().mangleItaniumGuardVariable(&D, Out);
1077 Out.flush();
John McCall112c9672010-11-02 21:04:24 +00001078
John McCall3030eb82010-11-06 09:44:32 +00001079 // Just absorb linkage and visibility from the variable.
John McCall5cd91b52010-09-08 01:44:27 +00001080 llvm::GlobalVariable *GuardVariable =
1081 new llvm::GlobalVariable(CGM.getModule(), GuardTy,
John McCall3030eb82010-11-06 09:44:32 +00001082 false, GV->getLinkage(),
John McCall5cd91b52010-09-08 01:44:27 +00001083 llvm::ConstantInt::get(GuardTy, 0),
1084 GuardVName.str());
John McCall112c9672010-11-02 21:04:24 +00001085 GuardVariable->setVisibility(GV->getVisibility());
John McCall5cd91b52010-09-08 01:44:27 +00001086
1087 // Test whether the variable has completed initialization.
1088 llvm::Value *IsInitialized;
1089
1090 // ARM C++ ABI 3.2.3.1:
1091 // To support the potential use of initialization guard variables
1092 // as semaphores that are the target of ARM SWP and LDREX/STREX
1093 // synchronizing instructions we define a static initialization
1094 // guard variable to be a 4-byte aligned, 4- byte word with the
1095 // following inline access protocol.
1096 // #define INITIALIZED 1
1097 // if ((obj_guard & INITIALIZED) != INITIALIZED) {
1098 // if (__cxa_guard_acquire(&obj_guard))
1099 // ...
1100 // }
1101 if (IsARM) {
1102 llvm::Value *V = Builder.CreateLoad(GuardVariable);
1103 V = Builder.CreateAnd(V, Builder.getInt32(1));
1104 IsInitialized = Builder.CreateIsNull(V, "guard.uninitialized");
1105
1106 // Itanium C++ ABI 3.3.2:
1107 // The following is pseudo-code showing how these functions can be used:
1108 // if (obj_guard.first_byte == 0) {
1109 // if ( __cxa_guard_acquire (&obj_guard) ) {
1110 // try {
1111 // ... initialize the object ...;
1112 // } catch (...) {
1113 // __cxa_guard_abort (&obj_guard);
1114 // throw;
1115 // }
1116 // ... queue object destructor with __cxa_atexit() ...;
1117 // __cxa_guard_release (&obj_guard);
1118 // }
1119 // }
1120 } else {
1121 // Load the first byte of the guard variable.
1122 const llvm::Type *PtrTy = Builder.getInt8PtrTy();
1123 llvm::Value *V =
1124 Builder.CreateLoad(Builder.CreateBitCast(GuardVariable, PtrTy), "tmp");
1125
1126 IsInitialized = Builder.CreateIsNull(V, "guard.uninitialized");
1127 }
1128
1129 llvm::BasicBlock *InitCheckBlock = CGF.createBasicBlock("init.check");
1130 llvm::BasicBlock *EndBlock = CGF.createBasicBlock("init.end");
1131
1132 // Check if the first byte of the guard variable is zero.
1133 Builder.CreateCondBr(IsInitialized, InitCheckBlock, EndBlock);
1134
1135 CGF.EmitBlock(InitCheckBlock);
1136
1137 // Variables used when coping with thread-safe statics and exceptions.
1138 if (ThreadsafeStatics) {
1139 // Call __cxa_guard_acquire.
1140 llvm::Value *V
1141 = Builder.CreateCall(getGuardAcquireFn(CGM, GuardPtrTy), GuardVariable);
1142
1143 llvm::BasicBlock *InitBlock = CGF.createBasicBlock("init");
1144
1145 Builder.CreateCondBr(Builder.CreateIsNotNull(V, "tobool"),
1146 InitBlock, EndBlock);
1147
1148 // Call __cxa_guard_abort along the exceptional edge.
1149 CGF.EHStack.pushCleanup<CallGuardAbort>(EHCleanup, GuardVariable);
1150
1151 CGF.EmitBlock(InitBlock);
1152 }
1153
1154 // Emit the initializer and add a global destructor if appropriate.
1155 CGF.EmitCXXGlobalVarDeclInit(D, GV);
1156
1157 if (ThreadsafeStatics) {
1158 // Pop the guard-abort cleanup if we pushed one.
1159 CGF.PopCleanupBlock();
1160
1161 // Call __cxa_guard_release. This cannot throw.
1162 Builder.CreateCall(getGuardReleaseFn(CGM, GuardPtrTy), GuardVariable);
1163 } else {
1164 Builder.CreateStore(llvm::ConstantInt::get(GuardTy, 1), GuardVariable);
1165 }
1166
1167 CGF.EmitBlock(EndBlock);
1168}