blob: 937a4420ef7daf800ed8914bd8f2916e6a2a6f3b [file] [log] [blame]
Mike Stumpde050572009-12-02 18:57:08 +00001//===--- CGCXXRTTI.cpp - Emit LLVM Code for C++ RTTI descriptors ----------===//
Anders Carlsson656e4c12009-10-10 20:49:04 +00002//
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 contains code dealing with C++ code generation of RTTI descriptors.
11//
12//===----------------------------------------------------------------------===//
13
Mike Stumpae9b2be2009-11-17 23:45:57 +000014#include "clang/AST/Type.h"
Mike Stumpcbcd4e52009-11-14 23:32:21 +000015#include "clang/AST/RecordLayout.h"
Mike Stump61c38012009-11-17 21:44:24 +000016#include "CodeGenModule.h"
Anders Carlsson656e4c12009-10-10 20:49:04 +000017using namespace clang;
18using namespace CodeGen;
19
Mike Stump92f2fe22009-12-02 19:07:44 +000020namespace {
Mike Stumpde050572009-12-02 18:57:08 +000021class RTTIBuilder {
Mike Stump2b1bf312009-11-14 14:25:18 +000022 CodeGenModule &CGM; // Per-module state.
23 llvm::LLVMContext &VMContext;
24 const llvm::Type *Int8PtrTy;
Mike Stumpa8285a82009-11-15 03:28:10 +000025 llvm::SmallSet<const CXXRecordDecl *, 16> SeenVBase;
26 llvm::SmallSet<const CXXRecordDecl *, 32> SeenBase;
Anders Carlsson8d145152009-12-20 22:30:54 +000027
Anders Carlsson23440772009-12-17 05:06:03 +000028 std::vector<llvm::Constant *> Info;
Anders Carlssond6baec82009-12-11 01:27:37 +000029
Anders Carlsson1d7088d2009-12-17 07:09:17 +000030 /// GetAddrOfExternalRTTIDescriptor - Returns the constant for the RTTI
31 /// descriptor of the given type.
32 llvm::Constant *GetAddrOfExternalRTTIDescriptor(QualType Ty);
33
Anders Carlsson8d145152009-12-20 22:30:54 +000034 /// BuildTypeInfo - Build the RTTI type info struct for the given type.
35 llvm::Constant *BuildTypeInfo(QualType Ty);
36
37 /// BuildVtablePointer - Build the vtable pointer for the given type.
38 void BuildVtablePointer(const Type *Ty);
39
40 /// BuildPointerTypeInfo - Build an abi::__pointer_type_info struct,
41 /// used for pointer types.
42 void BuildPointerTypeInfo(const PointerType *Ty);
43
44 /// BuildPointerToMemberTypeInfo - Build an abi::__pointer_to_member_type_info
45 /// struct, used for member pointer types.
46 void BuildPointerToMemberTypeInfo(const MemberPointerType *Ty);
47
Mike Stump2b1bf312009-11-14 14:25:18 +000048public:
Mike Stumpde050572009-12-02 18:57:08 +000049 RTTIBuilder(CodeGenModule &cgm)
Mike Stump2b1bf312009-11-14 14:25:18 +000050 : CGM(cgm), VMContext(cgm.getModule().getContext()),
51 Int8PtrTy(llvm::Type::getInt8PtrTy(VMContext)) { }
52
Mike Stumpcbcd4e52009-11-14 23:32:21 +000053 /// BuildVtableRef - Build a reference to a vtable.
54 llvm::Constant *BuildVtableRef(const char *Name) {
55 // Build a descriptor for Name
Anders Carlsson8d145152009-12-20 22:30:54 +000056 llvm::Constant *GV = CGM.getModule().getNamedGlobal(Name);
Mike Stumpc7a05bd2009-11-14 15:55:18 +000057 if (GV)
58 GV = llvm::ConstantExpr::getBitCast(GV,
59 llvm::PointerType::get(Int8PtrTy, 0));
60 else {
61 llvm::GlobalVariable::LinkageTypes linktype;
62 linktype = llvm::GlobalValue::ExternalLinkage;
63 GV = new llvm::GlobalVariable(CGM.getModule(), Int8PtrTy,
64 true, linktype, 0, Name);
Mike Stumpcbcd4e52009-11-14 23:32:21 +000065 }
Mike Stumpc7a05bd2009-11-14 15:55:18 +000066 llvm::Constant *C;
67 C = llvm::ConstantInt::get(llvm::Type::getInt64Ty(VMContext), 2);
68 C = llvm::ConstantExpr::getInBoundsGetElementPtr(GV, &C, 1);
69 return llvm::ConstantExpr::getBitCast(C, Int8PtrTy);
70 }
Mike Stumpcbcd4e52009-11-14 23:32:21 +000071
Anders Carlsson31b7f522009-12-11 02:46:30 +000072 // FIXME: This should be removed, and clients should pass in the linkage
73 // directly instead.
74 static inline llvm::GlobalVariable::LinkageTypes
75 GetLinkageFromExternFlag(bool Extern) {
76 if (Extern)
77 return llvm::GlobalValue::WeakODRLinkage;
78
79 return llvm::GlobalValue::InternalLinkage;
80 }
81
82 // FIXME: This should be removed, and clients should pass in the linkage
83 // directly instead.
Mike Stump58588942009-11-19 01:08:19 +000084 llvm::Constant *BuildName(QualType Ty, bool Hidden, bool Extern) {
Anders Carlsson31b7f522009-12-11 02:46:30 +000085 return BuildName(Ty, Hidden, GetLinkageFromExternFlag(Extern));
86 }
87
88 llvm::Constant *BuildName(QualType Ty, bool Hidden,
89 llvm::GlobalVariable::LinkageTypes Linkage) {
Mike Stump2b1bf312009-11-14 14:25:18 +000090 llvm::SmallString<256> OutName;
Mike Stumpde050572009-12-02 18:57:08 +000091 CGM.getMangleContext().mangleCXXRTTIName(Ty, OutName);
Daniel Dunbar94fd26d2009-11-21 09:06:22 +000092 llvm::StringRef Name = OutName.str();
Mike Stumpcbcd4e52009-11-14 23:32:21 +000093
Anders Carlsson8d145152009-12-20 22:30:54 +000094 llvm::GlobalVariable *OGV = CGM.getModule().getNamedGlobal(Name);
Anders Carlsson31b7f522009-12-11 02:46:30 +000095 if (OGV && !OGV->isDeclaration())
96 return llvm::ConstantExpr::getBitCast(OGV, Int8PtrTy);
Mike Stump58588942009-11-19 01:08:19 +000097
Anders Carlsson31b7f522009-12-11 02:46:30 +000098 llvm::Constant *C = llvm::ConstantArray::get(VMContext, Name.substr(4));
Mike Stump2b1bf312009-11-14 14:25:18 +000099
Anders Carlsson31b7f522009-12-11 02:46:30 +0000100 llvm::GlobalVariable *GV =
101 new llvm::GlobalVariable(CGM.getModule(), C->getType(), true, Linkage,
102 C, Name);
Mike Stump58588942009-11-19 01:08:19 +0000103 if (OGV) {
104 GV->takeName(OGV);
105 llvm::Constant *NewPtr = llvm::ConstantExpr::getBitCast(GV,
106 OGV->getType());
107 OGV->replaceAllUsesWith(NewPtr);
108 OGV->eraseFromParent();
109 }
Mike Stump582b0372009-11-18 03:46:51 +0000110 if (Hidden)
111 GV->setVisibility(llvm::GlobalVariable::HiddenVisibility);
112 return llvm::ConstantExpr::getBitCast(GV, Int8PtrTy);
Daniel Dunbar7177dee2009-12-19 17:50:07 +0000113 }
Mike Stumpc7a05bd2009-11-14 15:55:18 +0000114
Mike Stumpcbcd4e52009-11-14 23:32:21 +0000115 /// - BuildFlags - Build a psABI __flags value for __vmi_class_type_info.
116 llvm::Constant *BuildFlags(int f) {
117 return llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), f);
118 }
119
120 /// BuildBaseCount - Build a psABI __base_count value for
121 /// __vmi_class_type_info.
122 llvm::Constant *BuildBaseCount(unsigned c) {
123 return llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), c);
124 }
125
Mike Stumpa8285a82009-11-15 03:28:10 +0000126 /// CalculateFlags - Calculate the flags for the __vmi_class_type_info
127 /// datastructure. 1 for non-diamond repeated inheritance, 2 for a dimond
128 /// shaped class.
Anders Carlsson8d145152009-12-20 22:30:54 +0000129 int CalculateFlags(const CXXRecordDecl *RD) {
Mike Stumpa8285a82009-11-15 03:28:10 +0000130 int flags = 0;
131 if (SeenBase.count(RD))
132 flags |= 1;
133 else
134 SeenBase.insert(RD);
135 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
136 e = RD->bases_end(); i != e; ++i) {
137 const CXXRecordDecl *Base =
138 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
139 if (i->isVirtual()) {
140 if (SeenVBase.count(Base))
141 flags |= 2;
142 else
143 SeenVBase.insert(Base);
144 }
145 flags |= CalculateFlags(Base);
146 }
147 return flags;
148 }
149
150 bool SimpleInheritance(const CXXRecordDecl *RD) {
151 if (RD->getNumBases() != 1)
152 return false;
153 CXXRecordDecl::base_class_const_iterator i = RD->bases_begin();
154 if (i->isVirtual())
155 return false;
156 if (i->getAccessSpecifier() != AS_public)
157 return false;
158
159 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
160 const CXXRecordDecl *Base =
161 cast<CXXRecordDecl>(i->getType()->getAs<RecordType>()->getDecl());
162 if (Layout.getBaseClassOffset(Base) != 0)
163 return false;
164 return true;
165 }
166
Anders Carlssonab6faf32009-12-17 05:10:59 +0000167 llvm::Constant *finish(llvm::GlobalVariable *GV,
Anders Carlsson31b7f522009-12-11 02:46:30 +0000168 llvm::StringRef Name, bool Hidden,
169 llvm::GlobalVariable::LinkageTypes Linkage) {
170 llvm::Constant *C =
Anders Carlssonab6faf32009-12-17 05:10:59 +0000171 llvm::ConstantStruct::get(VMContext, &Info[0], Info.size(),
172 /*Packed=*/false);
Mike Stump64989f02009-11-17 23:11:22 +0000173
Mike Stump58588942009-11-19 01:08:19 +0000174 llvm::GlobalVariable *OGV = GV;
Anders Carlsson31b7f522009-12-11 02:46:30 +0000175 GV = new llvm::GlobalVariable(CGM.getModule(), C->getType(), true, Linkage,
Mike Stump58588942009-11-19 01:08:19 +0000176 C, Name);
177 if (OGV) {
Mike Stump64989f02009-11-17 23:11:22 +0000178 GV->takeName(OGV);
179 llvm::Constant *NewPtr = llvm::ConstantExpr::getBitCast(GV,
180 OGV->getType());
181 OGV->replaceAllUsesWith(NewPtr);
182 OGV->eraseFromParent();
183 }
Mike Stump582b0372009-11-18 03:46:51 +0000184 if (Hidden)
Mike Stump88a4a622009-11-18 03:21:29 +0000185 GV->setVisibility(llvm::GlobalVariable::HiddenVisibility);
Mike Stump64989f02009-11-17 23:11:22 +0000186 return llvm::ConstantExpr::getBitCast(GV, Int8PtrTy);
187 }
188
189
Anders Carlsson31b7f522009-12-11 02:46:30 +0000190 llvm::Constant *
191 Buildclass_type_info(const CXXRecordDecl *RD,
192 llvm::GlobalVariable::LinkageTypes Linkage) {
Anders Carlsson23440772009-12-17 05:06:03 +0000193 assert(Info.empty() && "Info vector must be empty!");
Anders Carlsson44636d12009-12-11 16:41:51 +0000194
Mike Stump64989f02009-11-17 23:11:22 +0000195 llvm::Constant *C;
196
Mike Stumpcbcd4e52009-11-14 23:32:21 +0000197 llvm::SmallString<256> OutName;
Mike Stumpde050572009-12-02 18:57:08 +0000198 CGM.getMangleContext().mangleCXXRTTI(CGM.getContext().getTagDeclType(RD),
Daniel Dunbar94fd26d2009-11-21 09:06:22 +0000199 OutName);
200 llvm::StringRef Name = OutName.str();
Mike Stumpcbcd4e52009-11-14 23:32:21 +0000201
202 llvm::GlobalVariable *GV;
Anders Carlsson8d145152009-12-20 22:30:54 +0000203 GV = CGM.getModule().getNamedGlobal(Name);
Mike Stumpcbcd4e52009-11-14 23:32:21 +0000204 if (GV && !GV->isDeclaration())
205 return llvm::ConstantExpr::getBitCast(GV, Int8PtrTy);
206
Anders Carlsson31b7f522009-12-11 02:46:30 +0000207 // If we're in an anonymous namespace, then we always want internal linkage.
Eli Friedman470fb732009-12-11 20:48:18 +0000208 if (RD->isInAnonymousNamespace() || !RD->hasLinkage())
Anders Carlsson31b7f522009-12-11 02:46:30 +0000209 Linkage = llvm::GlobalVariable::InternalLinkage;
210
Mike Stump582b0372009-11-18 03:46:51 +0000211 bool Hidden = CGM.getDeclVisibilityMode(RD) == LangOptions::Hidden;
212
Mike Stumpa8285a82009-11-15 03:28:10 +0000213 bool simple = false;
Mike Stumpcbcd4e52009-11-14 23:32:21 +0000214 if (RD->getNumBases() == 0)
215 C = BuildVtableRef("_ZTVN10__cxxabiv117__class_type_infoE");
Mike Stumpa8285a82009-11-15 03:28:10 +0000216 else if (SimpleInheritance(RD)) {
217 simple = true;
218 C = BuildVtableRef("_ZTVN10__cxxabiv120__si_class_type_infoE");
219 } else
Mike Stumpcbcd4e52009-11-14 23:32:21 +0000220 C = BuildVtableRef("_ZTVN10__cxxabiv121__vmi_class_type_infoE");
Anders Carlsson23440772009-12-17 05:06:03 +0000221 Info.push_back(C);
222 Info.push_back(BuildName(CGM.getContext().getTagDeclType(RD), Hidden,
Anders Carlsson31b7f522009-12-11 02:46:30 +0000223 Linkage));
Mike Stumpc7a05bd2009-11-14 15:55:18 +0000224
Mike Stumpcbcd4e52009-11-14 23:32:21 +0000225 // If we have no bases, there are no more fields.
226 if (RD->getNumBases()) {
Mike Stumpa8285a82009-11-15 03:28:10 +0000227 if (!simple) {
Anders Carlsson23440772009-12-17 05:06:03 +0000228 Info.push_back(BuildFlags(CalculateFlags(RD)));
229 Info.push_back(BuildBaseCount(RD->getNumBases()));
Mike Stumpa8285a82009-11-15 03:28:10 +0000230 }
Mike Stumpcbcd4e52009-11-14 23:32:21 +0000231
232 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
233 for (CXXRecordDecl::base_class_const_iterator i = RD->bases_begin(),
234 e = RD->bases_end(); i != e; ++i) {
Anders Carlsson1d7088d2009-12-17 07:09:17 +0000235 QualType BaseType = i->getType();
Mike Stumpcbcd4e52009-11-14 23:32:21 +0000236 const CXXRecordDecl *Base =
Anders Carlsson1d7088d2009-12-17 07:09:17 +0000237 cast<CXXRecordDecl>(BaseType->getAs<RecordType>()->getDecl());
238 Info.push_back(CGM.GetAddrOfRTTIDescriptor(BaseType));
Mike Stumpa8285a82009-11-15 03:28:10 +0000239 if (simple)
240 break;
Mike Stumpcbcd4e52009-11-14 23:32:21 +0000241 int64_t offset;
242 if (!i->isVirtual())
Mike Stumpa8285a82009-11-15 03:28:10 +0000243 offset = Layout.getBaseClassOffset(Base)/8;
Mike Stumpcbcd4e52009-11-14 23:32:21 +0000244 else
245 offset = CGM.getVtableInfo().getVirtualBaseOffsetIndex(RD, Base);
246 offset <<= 8;
247 // Now set the flags.
248 offset += i->isVirtual() ? 1 : 0;;
249 offset += i->getAccessSpecifier() == AS_public ? 2 : 0;
250 const llvm::Type *LongTy =
251 CGM.getTypes().ConvertType(CGM.getContext().LongTy);
252 C = llvm::ConstantInt::get(LongTy, offset);
Anders Carlsson23440772009-12-17 05:06:03 +0000253 Info.push_back(C);
Mike Stumpcbcd4e52009-11-14 23:32:21 +0000254 }
255 }
256
Anders Carlssonab6faf32009-12-17 05:10:59 +0000257 return finish(GV, Name, Hidden, Linkage);
Mike Stumpc7a05bd2009-11-14 15:55:18 +0000258 }
Mike Stumpea2c0b52009-11-17 02:16:21 +0000259
Mike Stump61c38012009-11-17 21:44:24 +0000260 /// - BuildFlags - Build a __flags value for __pbase_type_info.
Anders Carlssond6baec82009-12-11 01:27:37 +0000261 llvm::Constant *BuildInt(unsigned n) {
262 return llvm::ConstantInt::get(llvm::Type::getInt32Ty(VMContext), n);
Mike Stump61c38012009-11-17 21:44:24 +0000263 }
264
Mike Stump4e6f8ee2009-12-24 02:33:48 +0000265 // FIXME: unify with getTypeInfoLinkage
Mike Stump58588942009-11-19 01:08:19 +0000266 bool DecideExtern(QualType Ty) {
267 // For this type, see if all components are never in an anonymous namespace.
268 if (const MemberPointerType *MPT = Ty->getAs<MemberPointerType>())
269 return (DecideExtern(MPT->getPointeeType())
270 && DecideExtern(QualType(MPT->getClass(), 0)));
271 if (const PointerType *PT = Ty->getAs<PointerType>())
272 return DecideExtern(PT->getPointeeType());
Mike Stump4e6f8ee2009-12-24 02:33:48 +0000273 if (const FunctionType *FT = Ty->getAs<FunctionType>()) {
274 if (DecideExtern(FT->getResultType()) == false)
275 return false;
276 if (const FunctionProtoType *FPT = Ty->getAs<FunctionProtoType>()) {
277 for (unsigned i = 0; i <FPT->getNumArgs(); ++i)
278 if (DecideExtern(FPT->getArgType(i)) == false)
279 return false;
280 for (unsigned i = 0; i <FPT->getNumExceptions(); ++i)
281 if (DecideExtern(FPT->getExceptionType(i)) == false)
282 return false;
283 return true;
284 }
285 }
Mike Stump58588942009-11-19 01:08:19 +0000286 if (const RecordType *RT = Ty->getAs<RecordType>())
287 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl()))
Eli Friedman470fb732009-12-11 20:48:18 +0000288 return !RD->isInAnonymousNamespace() && RD->hasLinkage();
Mike Stump58588942009-11-19 01:08:19 +0000289 return true;
290 }
291
Mike Stump4e6f8ee2009-12-24 02:33:48 +0000292 // FIXME: unify with DecideExtern
Mike Stump58588942009-11-19 01:08:19 +0000293 bool DecideHidden(QualType Ty) {
294 // For this type, see if all components are never hidden.
295 if (const MemberPointerType *MPT = Ty->getAs<MemberPointerType>())
296 return (DecideHidden(MPT->getPointeeType())
297 && DecideHidden(QualType(MPT->getClass(), 0)));
298 if (const PointerType *PT = Ty->getAs<PointerType>())
299 return DecideHidden(PT->getPointeeType());
Mike Stump4e6f8ee2009-12-24 02:33:48 +0000300 if (const FunctionType *FT = Ty->getAs<FunctionType>()) {
301 if (DecideHidden(FT->getResultType()) == false)
302 return false;
303 if (const FunctionProtoType *FPT = Ty->getAs<FunctionProtoType>()) {
304 for (unsigned i = 0; i <FPT->getNumArgs(); ++i)
305 if (DecideHidden(FPT->getArgType(i)) == false)
306 return false;
307 for (unsigned i = 0; i <FPT->getNumExceptions(); ++i)
308 if (DecideHidden(FPT->getExceptionType(i)) == false)
309 return false;
310 return true;
311 }
312 }
Mike Stump58588942009-11-19 01:08:19 +0000313 if (const RecordType *RT = Ty->getAs<RecordType>())
314 if (const CXXRecordDecl *RD = dyn_cast<CXXRecordDecl>(RT->getDecl()))
315 return CGM.getDeclVisibilityMode(RD) == LangOptions::Hidden;
316 return false;
317 }
318
Mike Stumpae9b2be2009-11-17 23:45:57 +0000319 llvm::Constant *BuildSimpleType(QualType Ty, const char *vtbl) {
Mike Stump64989f02009-11-17 23:11:22 +0000320 llvm::SmallString<256> OutName;
Mike Stumpde050572009-12-02 18:57:08 +0000321 CGM.getMangleContext().mangleCXXRTTI(Ty, OutName);
Daniel Dunbar94fd26d2009-11-21 09:06:22 +0000322 llvm::StringRef Name = OutName.str();
Mike Stump64989f02009-11-17 23:11:22 +0000323
324 llvm::GlobalVariable *GV;
Anders Carlsson8d145152009-12-20 22:30:54 +0000325 GV = CGM.getModule().getNamedGlobal(Name);
Mike Stump64989f02009-11-17 23:11:22 +0000326 if (GV && !GV->isDeclaration())
327 return llvm::ConstantExpr::getBitCast(GV, Int8PtrTy);
328
Mike Stump58588942009-11-19 01:08:19 +0000329 bool Extern = DecideExtern(Ty);
330 bool Hidden = DecideHidden(Ty);
Mike Stump582b0372009-11-18 03:46:51 +0000331
Anders Carlssonab6faf32009-12-17 05:10:59 +0000332 Info.push_back(BuildVtableRef(vtbl));
333 Info.push_back(BuildName(Ty, Hidden, Extern));
Anders Carlsson3bf190e2009-12-13 23:47:29 +0000334
Mike Stump58588942009-11-19 01:08:19 +0000335 // We always generate these as hidden, only the name isn't hidden.
Mike Stump4e6f8ee2009-12-24 02:33:48 +0000336 return finish(GV, Name, /*Hidden=*/Extern ? true : false,
Anders Carlssonab6faf32009-12-17 05:10:59 +0000337 GetLinkageFromExternFlag(Extern));
Mike Stump61c38012009-11-17 21:44:24 +0000338 }
339
Anders Carlsson31b7f522009-12-11 02:46:30 +0000340 /// BuildType - Builds the type info for the given type.
Mike Stumpea2c0b52009-11-17 02:16:21 +0000341 llvm::Constant *BuildType(QualType Ty) {
342 const clang::Type &Type
343 = *CGM.getContext().getCanonicalType(Ty).getTypePtr();
Mike Stump7e1365a2009-11-20 00:31:50 +0000344
Mike Stumpea2c0b52009-11-17 02:16:21 +0000345 switch (Type.getTypeClass()) {
346 default: {
Mike Stumpea2c0b52009-11-17 02:16:21 +0000347 assert(0 && "typeid expression");
Mike Stumpea2c0b52009-11-17 02:16:21 +0000348 return llvm::Constant::getNullValue(Int8PtrTy);
349 }
350
351 case Type::Builtin: {
352 // We expect all type_info objects for builtin types to be in the library.
Anders Carlsson1d7088d2009-12-17 07:09:17 +0000353 return GetAddrOfExternalRTTIDescriptor(Ty);
Mike Stumpea2c0b52009-11-17 02:16:21 +0000354 }
Mike Stump21f5d5d2009-11-17 02:57:13 +0000355
Anders Carlsson625c1ae2009-12-21 00:41:42 +0000356 case Type::Record: {
357 const RecordType *RT = cast<RecordType>(&Type);
358
359 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
360 if (RD->getNumBases())
361 return BuildClassTypeInfo(RD);
362
363 // Fall through.
364 }
365
Anders Carlsson8d145152009-12-20 22:30:54 +0000366 case Type::Pointer:
Mike Stump5fae8562009-11-17 22:33:00 +0000367 case Type::MemberPointer:
Anders Carlsson8d145152009-12-20 22:30:54 +0000368 return BuildTypeInfo(Ty);
Anders Carlsson625c1ae2009-12-21 00:41:42 +0000369
Mike Stump64989f02009-11-17 23:11:22 +0000370 case Type::FunctionProto:
Mike Stumpae9b2be2009-11-17 23:45:57 +0000371 case Type::FunctionNoProto:
372 return BuildSimpleType(Ty, "_ZTVN10__cxxabiv120__function_type_infoE");
373 case Type::ConstantArray:
374 case Type::IncompleteArray:
375 case Type::VariableArray:
376 case Type::Vector:
377 case Type::ExtVector:
378 return BuildSimpleType(Ty, "_ZTVN10__cxxabiv117__array_type_infoE");
379 case Type::Enum:
380 return BuildSimpleType(Ty, "_ZTVN10__cxxabiv116__enum_type_infoE");
Mike Stumpea2c0b52009-11-17 02:16:21 +0000381 }
382 }
Anders Carlsson31b7f522009-12-11 02:46:30 +0000383
384 /// BuildClassTypeInfo - Builds the class type info (or a reference to it)
385 /// for the given record decl.
386 llvm::Constant *BuildClassTypeInfo(const CXXRecordDecl *RD) {
387 const CXXMethodDecl *KeyFunction = 0;
388
389 if (RD->isDynamicClass())
390 KeyFunction = CGM.getContext().getKeyFunction(RD);
391
392 if (KeyFunction) {
393 // If the key function is defined in this translation unit, then the RTTI
394 // related constants should also be emitted here, with external linkage.
395 if (KeyFunction->getBody())
396 return Buildclass_type_info(RD, llvm::GlobalValue::ExternalLinkage);
397
398 // Otherwise, we just want a reference to the type info.
Anders Carlsson1d7088d2009-12-17 07:09:17 +0000399 QualType Ty = CGM.getContext().getTagDeclType(RD);
400 return GetAddrOfExternalRTTIDescriptor(Ty);
Anders Carlsson31b7f522009-12-11 02:46:30 +0000401 }
402
403 // If there is no key function (or if the record doesn't have any virtual
404 // member functions or virtual bases), emit the type info with weak_odr
405 // linkage.
406 return Buildclass_type_info(RD, llvm::GlobalValue::WeakODRLinkage);
407 }
Anders Carlsson8d145152009-12-20 22:30:54 +0000408
409 // Pointer type info flags.
410 enum {
411 /// PTI_Const - Type has const qualifier.
412 PTI_Const = 0x1,
413
414 /// PTI_Volatile - Type has volatile qualifier.
415 PTI_Volatile = 0x2,
416
417 /// PTI_Restrict - Type has restrict qualifier.
418 PTI_Restrict = 0x4,
419
420 /// PTI_Incomplete - Type is incomplete.
421 PTI_Incomplete = 0x8,
422
423 /// PTI_ContainingClassIncomplete - Containing class is incomplete.
424 /// (in pointer to member).
425 PTI_ContainingClassIncomplete = 0x10
426 };
Mike Stump2b1bf312009-11-14 14:25:18 +0000427};
Mike Stump92f2fe22009-12-02 19:07:44 +0000428}
Mike Stump2b1bf312009-11-14 14:25:18 +0000429
Anders Carlsson1d7088d2009-12-17 07:09:17 +0000430llvm::Constant *RTTIBuilder::GetAddrOfExternalRTTIDescriptor(QualType Ty) {
431 // Mangle the RTTI name.
432 llvm::SmallString<256> OutName;
433 CGM.getMangleContext().mangleCXXRTTI(Ty, OutName);
434 llvm::StringRef Name = OutName.str();
435
Anders Carlsson8d145152009-12-20 22:30:54 +0000436 // Look for an existing global.
437 llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name);
Anders Carlsson1d7088d2009-12-17 07:09:17 +0000438
439 if (!GV) {
440 // Create a new global variable.
441 GV = new llvm::GlobalVariable(CGM.getModule(), Int8PtrTy, /*Constant=*/true,
442 llvm::GlobalValue::ExternalLinkage, 0, Name);
Anders Carlsson31b7f522009-12-11 02:46:30 +0000443 }
444
Anders Carlsson1d7088d2009-12-17 07:09:17 +0000445 return llvm::ConstantExpr::getBitCast(GV, Int8PtrTy);
Anders Carlsson31b7f522009-12-11 02:46:30 +0000446}
447
Anders Carlsson8d145152009-12-20 22:30:54 +0000448/// TypeInfoIsInStandardLibrary - Given a builtin type, returns whether the type
449/// info for that type is defined in the standard library.
450static bool TypeInfoIsInStandardLibrary(const BuiltinType *Ty) {
451 // Itanium C++ ABI 2.9.2:
452 // Basic type information (e.g. for "int", "bool", etc.) will be kept in
453 // the run-time support library. Specifically, the run-time support
454 // library should contain type_info objects for the types X, X* and
455 // X const*, for every X in: void, bool, wchar_t, char, unsigned char,
456 // signed char, short, unsigned short, int, unsigned int, long,
457 // unsigned long, long long, unsigned long long, float, double, long double,
458 // char16_t, char32_t, and the IEEE 754r decimal and half-precision
459 // floating point types.
460 switch (Ty->getKind()) {
461 case BuiltinType::Void:
462 case BuiltinType::Bool:
463 case BuiltinType::WChar:
464 case BuiltinType::Char_U:
465 case BuiltinType::Char_S:
466 case BuiltinType::UChar:
467 case BuiltinType::SChar:
468 case BuiltinType::Short:
469 case BuiltinType::UShort:
470 case BuiltinType::Int:
471 case BuiltinType::UInt:
472 case BuiltinType::Long:
473 case BuiltinType::ULong:
474 case BuiltinType::LongLong:
475 case BuiltinType::ULongLong:
476 case BuiltinType::Float:
477 case BuiltinType::Double:
478 case BuiltinType::LongDouble:
479 case BuiltinType::Char16:
480 case BuiltinType::Char32:
481 case BuiltinType::Int128:
482 case BuiltinType::UInt128:
483 return true;
484
485 case BuiltinType::Overload:
486 case BuiltinType::Dependent:
487 case BuiltinType::UndeducedAuto:
488 assert(false && "Should not see this type here!");
489
490 case BuiltinType::NullPtr:
491 assert(false && "FIXME: nullptr_t is not handled!");
492
493 case BuiltinType::ObjCId:
494 case BuiltinType::ObjCClass:
495 case BuiltinType::ObjCSel:
496 assert(false && "FIXME: Objective-C types are unsupported!");
497 }
498
499 // Silent gcc.
500 return false;
501}
502
503static bool TypeInfoIsInStandardLibrary(const PointerType *PointerTy) {
504 QualType PointeeTy = PointerTy->getPointeeType();
505 const BuiltinType *BuiltinTy = dyn_cast<BuiltinType>(PointeeTy);
506 if (!BuiltinTy)
507 return false;
508
509 // Check the qualifiers.
510 Qualifiers Quals = PointeeTy.getQualifiers();
511 Quals.removeConst();
512
513 if (!Quals.empty())
514 return false;
515
516 return TypeInfoIsInStandardLibrary(BuiltinTy);
517}
518
519/// ShouldUseExternalRTTIDescriptor - Returns whether the type information for
520/// the given type exists somewhere else, and that we should not emit the typ
521/// information in this translation unit.
522bool ShouldUseExternalRTTIDescriptor(QualType Ty) {
523 // Type info for builtin types is defined in the standard library.
524 if (const BuiltinType *BuiltinTy = dyn_cast<BuiltinType>(Ty))
525 return TypeInfoIsInStandardLibrary(BuiltinTy);
526
527 // Type info for some pointer types to builtin types is defined in the
528 // standard library.
529 if (const PointerType *PointerTy = dyn_cast<PointerType>(Ty))
530 return TypeInfoIsInStandardLibrary(PointerTy);
531
532 if (const RecordType *RecordTy = dyn_cast<RecordType>(Ty)) {
Anders Carlsson625c1ae2009-12-21 00:41:42 +0000533 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RecordTy->getDecl());
534 if (!RD->isDynamicClass())
535 return false;
536
537 // Get the key function.
538 const CXXMethodDecl *KeyFunction = RD->getASTContext().getKeyFunction(RD);
539 if (KeyFunction && !KeyFunction->getBody()) {
540 // The class has a key function, but it is not defined in this translation
541 // unit, so we should use the external descriptor for it.
542 return true;
543 }
Anders Carlsson8d145152009-12-20 22:30:54 +0000544 }
545
546 return false;
547}
548
549/// IsIncompleteClassType - Returns whether the given record type is incomplete.
550static bool IsIncompleteClassType(const RecordType *RecordTy) {
551 return !RecordTy->getDecl()->isDefinition();
552}
553
Anders Carlsson17fa6f92009-12-20 23:37:55 +0000554/// ContainsIncompleteClassType - Returns whether the given type contains an
555/// incomplete class type. This is true if
556///
557/// * The given type is an incomplete class type.
558/// * The given type is a pointer type whose pointee type contains an
559/// incomplete class type.
560/// * The given type is a member pointer type whose class is an incomplete
561/// class type.
562/// * The given type is a member pointer type whoise pointee type contains an
563/// incomplete class type.
Anders Carlsson8d145152009-12-20 22:30:54 +0000564/// is an indirect or direct pointer to an incomplete class type.
Anders Carlsson17fa6f92009-12-20 23:37:55 +0000565static bool ContainsIncompleteClassType(QualType Ty) {
566 if (const RecordType *RecordTy = dyn_cast<RecordType>(Ty)) {
567 if (IsIncompleteClassType(RecordTy))
568 return true;
569 }
570
571 if (const PointerType *PointerTy = dyn_cast<PointerType>(Ty))
572 return ContainsIncompleteClassType(PointerTy->getPointeeType());
573
574 if (const MemberPointerType *MemberPointerTy =
575 dyn_cast<MemberPointerType>(Ty)) {
576 // Check if the class type is incomplete.
577 const RecordType *ClassType = cast<RecordType>(MemberPointerTy->getClass());
578 if (IsIncompleteClassType(ClassType))
579 return true;
580
581 return ContainsIncompleteClassType(MemberPointerTy->getPointeeType());
Anders Carlsson8d145152009-12-20 22:30:54 +0000582 }
583
584 return false;
585}
586
587/// getTypeInfoLinkage - Return the linkage that the type info and type info
588/// name constants should have for the given type.
589static llvm::GlobalVariable::LinkageTypes getTypeInfoLinkage(QualType Ty) {
Anders Carlsson17fa6f92009-12-20 23:37:55 +0000590 // Itanium C++ ABI 2.9.5p7:
591 // In addition, it and all of the intermediate abi::__pointer_type_info
592 // structs in the chain down to the abi::__class_type_info for the
593 // incomplete class type must be prevented from resolving to the
594 // corresponding type_info structs for the complete class type, possibly
595 // by making them local static objects. Finally, a dummy class RTTI is
596 // generated for the incomplete type that will not resolve to the final
597 // complete class RTTI (because the latter need not exist), possibly by
598 // making it a local static object.
599 if (ContainsIncompleteClassType(Ty))
600 return llvm::GlobalValue::InternalLinkage;
Anders Carlsson625c1ae2009-12-21 00:41:42 +0000601
602 if (const PointerType *PointerTy = dyn_cast<PointerType>(Ty)) {
603 // If the pointee type has internal linkage, then the pointer type needs to
604 // have it as well.
605 if (getTypeInfoLinkage(PointerTy->getPointeeType()) ==
606 llvm::GlobalVariable::InternalLinkage)
607 return llvm::GlobalVariable::InternalLinkage;
608
609 return llvm::GlobalVariable::WeakODRLinkage;
610 }
611
612 if (const RecordType *RecordTy = dyn_cast<RecordType>(Ty)) {
613 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RecordTy->getDecl());
614
615 // If we're in an anonymous namespace, then we always want internal linkage.
616 if (RD->isInAnonymousNamespace() || !RD->hasLinkage())
617 return llvm::GlobalVariable::InternalLinkage;
618
619 if (!RD->isDynamicClass())
620 return llvm::GlobalValue::WeakODRLinkage;
621
622 // Get the key function.
623 const CXXMethodDecl *KeyFunction = RD->getASTContext().getKeyFunction(RD);
624 if (!KeyFunction) {
625 // There is no key function, the RTTI descriptor is emitted with weak_odr
626 // linkage.
627 return llvm::GlobalValue::WeakODRLinkage;
628 }
629
630 // Otherwise, the RTTI descriptor is emitted with external linkage.
631 return llvm::GlobalValue::ExternalLinkage;
632 }
633
Mike Stump8d9fb9b2009-12-23 22:48:20 +0000634 if (Ty->getTypeClass() == Type::Builtin) {
635 return llvm::GlobalValue::WeakODRLinkage;
636 }
637
Mike Stumpc8f76f52009-12-24 01:10:27 +0000638 if (const FunctionType *FT = dyn_cast<FunctionType>(Ty)) {
639 if (getTypeInfoLinkage(FT->getResultType())
640 == llvm::GlobalValue::InternalLinkage)
641 return llvm::GlobalValue::InternalLinkage;
642
643 if (const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(Ty)) {
644 for (unsigned i = 0; i < FPT->getNumArgs(); ++i)
645 if (getTypeInfoLinkage(FPT->getArgType(i))
646 == llvm::GlobalValue::InternalLinkage)
647 return llvm::GlobalValue::InternalLinkage;
648 for (unsigned i = 0; i < FPT->getNumExceptions(); ++i)
649 if (getTypeInfoLinkage(FPT->getExceptionType(i))
650 == llvm::GlobalValue::InternalLinkage)
651 return llvm::GlobalValue::InternalLinkage;
652 }
653
654 return llvm::GlobalValue::WeakODRLinkage;
655 }
656
657 // FIXME: We need to add code to handle all types.
Anders Carlsson625c1ae2009-12-21 00:41:42 +0000658 assert(false && "Unhandled type!");
Anders Carlsson8d145152009-12-20 22:30:54 +0000659 return llvm::GlobalValue::WeakODRLinkage;
660}
661
662void RTTIBuilder::BuildVtablePointer(const Type *Ty) {
663 const char *VtableName;
664
665 switch (Ty->getTypeClass()) {
666 default: assert(0 && "Unhandled type!");
Anders Carlsson625c1ae2009-12-21 00:41:42 +0000667
668 case Type::Record: {
669 const CXXRecordDecl *RD =
670 cast<CXXRecordDecl>(cast<RecordType>(Ty)->getDecl());
671 if (!RD->getNumBases()) {
672 // abi::__class_type_info
673 VtableName = "_ZTVN10__cxxabiv117__class_type_infoE";
674 break;
675 }
676 }
677
Anders Carlsson8d145152009-12-20 22:30:54 +0000678 case Type::Pointer:
679 // abi::__pointer_type_info
680 VtableName = "_ZTVN10__cxxabiv119__pointer_type_infoE";
681 break;
682 case Type::MemberPointer:
683 // abi::__pointer_to_member_type_info
684 VtableName = "_ZTVN10__cxxabiv129__pointer_to_member_type_infoE";
685 break;
686 }
687
688 llvm::Constant *Vtable =
689 CGM.getModule().getOrInsertGlobal(VtableName, Int8PtrTy);
690
691 const llvm::Type *PtrDiffTy =
692 CGM.getTypes().ConvertType(CGM.getContext().getPointerDiffType());
693
694 // The vtable address point is 2.
695 llvm::Constant *Two = llvm::ConstantInt::get(PtrDiffTy, 2);
696 Vtable = llvm::ConstantExpr::getInBoundsGetElementPtr(Vtable, &Two, 1);
697 Vtable = llvm::ConstantExpr::getBitCast(Vtable, Int8PtrTy);
698
699 Info.push_back(Vtable);
700}
701
702llvm::Constant *RTTIBuilder::BuildTypeInfo(QualType Ty) {
703 // We want to operate on the canonical type.
704 Ty = CGM.getContext().getCanonicalType(Ty);
705
706 // Check if we've already emitted an RTTI descriptor for this type.
707 llvm::SmallString<256> OutName;
708 CGM.getMangleContext().mangleCXXRTTI(Ty, OutName);
709 llvm::StringRef Name = OutName.str();
710
711 llvm::GlobalVariable *OldGV = CGM.getModule().getNamedGlobal(Name);
712 if (OldGV && !OldGV->isDeclaration())
713 return llvm::ConstantExpr::getBitCast(OldGV, Int8PtrTy);
714
715 // Check if there is already an external RTTI descriptor for this type.
716 if (ShouldUseExternalRTTIDescriptor(Ty))
717 return GetAddrOfExternalRTTIDescriptor(Ty);
718
719 llvm::GlobalVariable::LinkageTypes Linkage = getTypeInfoLinkage(Ty);
720
721 // Add the vtable pointer.
722 BuildVtablePointer(cast<Type>(Ty));
723
724 // And the name.
725 Info.push_back(BuildName(Ty, DecideHidden(Ty), Linkage));
726
727 switch (Ty->getTypeClass()) {
728 default: assert(false && "Unhandled type class!");
729 case Type::Builtin:
730 assert(false && "Builtin type info must be in the standard library!");
731 break;
732
Anders Carlsson625c1ae2009-12-21 00:41:42 +0000733 case Type::Record: {
734 const CXXRecordDecl *RD =
735 cast<CXXRecordDecl>(cast<RecordType>(Ty)->getDecl());
736 if (!RD->getNumBases()) {
737 // We don't need to emit any fields.
738 break;
739 }
740 }
741
Anders Carlsson8d145152009-12-20 22:30:54 +0000742 case Type::Pointer:
743 BuildPointerTypeInfo(cast<PointerType>(Ty));
744 break;
745
746 case Type::MemberPointer:
747 BuildPointerToMemberTypeInfo(cast<MemberPointerType>(Ty));
748 break;
749 }
750
751 llvm::Constant *Init =
752 llvm::ConstantStruct::get(VMContext, &Info[0], Info.size(),
753 /*Packed=*/false);
754
755 llvm::GlobalVariable *GV =
756 new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
757 /*Constant=*/true, Linkage, Init, Name);
758
759 // If there's already an old global variable, replace it with the new one.
760 if (OldGV) {
761 GV->takeName(OldGV);
762 llvm::Constant *NewPtr =
763 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
764 OldGV->replaceAllUsesWith(NewPtr);
765 OldGV->eraseFromParent();
766 }
767
768 return llvm::ConstantExpr::getBitCast(GV, Int8PtrTy);
769}
770
771/// DetermineQualifierFlags - Deterine the pointer type info flags from the
772/// given qualifier.
773static unsigned DetermineQualifierFlags(Qualifiers Quals) {
774 unsigned Flags = 0;
775
776 if (Quals.hasConst())
777 Flags |= RTTIBuilder::PTI_Const;
778 if (Quals.hasVolatile())
779 Flags |= RTTIBuilder::PTI_Volatile;
780 if (Quals.hasRestrict())
781 Flags |= RTTIBuilder::PTI_Restrict;
782
783 return Flags;
784}
785
786/// BuildPointerTypeInfo - Build an abi::__pointer_type_info struct,
787/// used for pointer types.
788void RTTIBuilder::BuildPointerTypeInfo(const PointerType *Ty) {
Anders Carlsson17fa6f92009-12-20 23:37:55 +0000789 QualType PointeeTy = Ty->getPointeeType();
Anders Carlsson8d145152009-12-20 22:30:54 +0000790
791 // Itanium C++ ABI 2.9.5p7:
792 // __flags is a flag word describing the cv-qualification and other
793 // attributes of the type pointed to
794 unsigned Flags = DetermineQualifierFlags(PointeeTy.getQualifiers());
795
796 // Itanium C++ ABI 2.9.5p7:
797 // When the abi::__pbase_type_info is for a direct or indirect pointer to an
798 // incomplete class type, the incomplete target type flag is set.
Anders Carlsson17fa6f92009-12-20 23:37:55 +0000799 if (ContainsIncompleteClassType(PointeeTy))
Anders Carlsson8d145152009-12-20 22:30:54 +0000800 Flags |= PTI_Incomplete;
801
802 const llvm::Type *UnsignedIntLTy =
803 CGM.getTypes().ConvertType(CGM.getContext().UnsignedIntTy);
804 Info.push_back(llvm::ConstantInt::get(UnsignedIntLTy, Flags));
805
806 // Itanium C++ ABI 2.9.5p7:
807 // __pointee is a pointer to the std::type_info derivation for the
808 // unqualified type being pointed to.
809 Info.push_back(RTTIBuilder(CGM).BuildType(PointeeTy.getUnqualifiedType()));
810}
811
812/// BuildPointerToMemberTypeInfo - Build an abi::__pointer_to_member_type_info
813/// struct, used for member pointer types.
814void RTTIBuilder::BuildPointerToMemberTypeInfo(const MemberPointerType *Ty) {
815 QualType PointeeTy = Ty->getPointeeType();
816
817 // Itanium C++ ABI 2.9.5p7:
818 // __flags is a flag word describing the cv-qualification and other
819 // attributes of the type pointed to.
820 unsigned Flags = DetermineQualifierFlags(PointeeTy.getQualifiers());
821
822 const RecordType *ClassType = cast<RecordType>(Ty->getClass());
Anders Carlsson17fa6f92009-12-20 23:37:55 +0000823
824 // Itanium C++ ABI 2.9.5p7:
825 // When the abi::__pbase_type_info is for a direct or indirect pointer to an
826 // incomplete class type, the incomplete target type flag is set.
827 if (ContainsIncompleteClassType(PointeeTy))
828 Flags |= PTI_Incomplete;
829
Anders Carlsson8d145152009-12-20 22:30:54 +0000830 if (IsIncompleteClassType(ClassType))
831 Flags |= PTI_ContainingClassIncomplete;
832
Anders Carlsson8d145152009-12-20 22:30:54 +0000833 const llvm::Type *UnsignedIntLTy =
834 CGM.getTypes().ConvertType(CGM.getContext().UnsignedIntTy);
835 Info.push_back(llvm::ConstantInt::get(UnsignedIntLTy, Flags));
836
837 // Itanium C++ ABI 2.9.5p7:
838 // __pointee is a pointer to the std::type_info derivation for the
839 // unqualified type being pointed to.
840 Info.push_back(RTTIBuilder(CGM).BuildType(PointeeTy.getUnqualifiedType()));
841
842 // Itanium C++ ABI 2.9.5p9:
843 // __context is a pointer to an abi::__class_type_info corresponding to the
844 // class type containing the member pointed to
845 // (e.g., the "A" in "int A::*").
846 Info.push_back(RTTIBuilder(CGM).BuildType(QualType(ClassType, 0)));
847}
848
Anders Carlsson1d7088d2009-12-17 07:09:17 +0000849llvm::Constant *CodeGenModule::GetAddrOfRTTIDescriptor(QualType Ty) {
Anders Carlsson31b7f522009-12-11 02:46:30 +0000850 if (!getContext().getLangOptions().RTTI) {
851 const llvm::Type *Int8PtrTy = llvm::Type::getInt8PtrTy(VMContext);
852 return llvm::Constant::getNullValue(Int8PtrTy);
853 }
854
855 return RTTIBuilder(*this).BuildType(Ty);
856}