blob: 8851209d08b39eacf37166357b0bf7fd655ed1a8 [file] [log] [blame]
Guy Benyei11169dd2012-12-18 14:30:41 +00001//===--- CGCXXRTTI.cpp - Emit LLVM Code for C++ RTTI descriptors ----------===//
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 contains code dealing with C++ code generation of RTTI descriptors.
11//
12//===----------------------------------------------------------------------===//
13
14#include "CodeGenModule.h"
15#include "CGCXXABI.h"
16#include "CGObjCRuntime.h"
17#include "clang/AST/RecordLayout.h"
18#include "clang/AST/Type.h"
19#include "clang/Frontend/CodeGenOptions.h"
20
21using namespace clang;
22using namespace CodeGen;
23
24namespace {
25class RTTIBuilder {
26 CodeGenModule &CGM; // Per-module state.
27 llvm::LLVMContext &VMContext;
28
29 /// Fields - The fields of the RTTI descriptor currently being built.
30 SmallVector<llvm::Constant *, 16> Fields;
31
32 /// GetAddrOfTypeName - Returns the mangled type name of the given type.
33 llvm::GlobalVariable *
34 GetAddrOfTypeName(QualType Ty, llvm::GlobalVariable::LinkageTypes Linkage);
35
36 /// GetAddrOfExternalRTTIDescriptor - Returns the constant for the RTTI
37 /// descriptor of the given type.
38 llvm::Constant *GetAddrOfExternalRTTIDescriptor(QualType Ty);
39
40 /// BuildVTablePointer - Build the vtable pointer for the given type.
41 void BuildVTablePointer(const Type *Ty);
42
43 /// BuildSIClassTypeInfo - Build an abi::__si_class_type_info, used for single
44 /// inheritance, according to the Itanium C++ ABI, 2.9.5p6b.
45 void BuildSIClassTypeInfo(const CXXRecordDecl *RD);
46
47 /// BuildVMIClassTypeInfo - Build an abi::__vmi_class_type_info, used for
48 /// classes with bases that do not satisfy the abi::__si_class_type_info
49 /// constraints, according ti the Itanium C++ ABI, 2.9.5p5c.
50 void BuildVMIClassTypeInfo(const CXXRecordDecl *RD);
51
52 /// BuildPointerTypeInfo - Build an abi::__pointer_type_info struct, used
53 /// for pointer types.
54 void BuildPointerTypeInfo(QualType PointeeTy);
55
56 /// BuildObjCObjectTypeInfo - Build the appropriate kind of
57 /// type_info for an object type.
58 void BuildObjCObjectTypeInfo(const ObjCObjectType *Ty);
59
60 /// BuildPointerToMemberTypeInfo - Build an abi::__pointer_to_member_type_info
61 /// struct, used for member pointer types.
62 void BuildPointerToMemberTypeInfo(const MemberPointerType *Ty);
63
64public:
65 RTTIBuilder(CodeGenModule &CGM) : CGM(CGM),
66 VMContext(CGM.getModule().getContext()) { }
67
68 // Pointer type info flags.
69 enum {
70 /// PTI_Const - Type has const qualifier.
71 PTI_Const = 0x1,
72
73 /// PTI_Volatile - Type has volatile qualifier.
74 PTI_Volatile = 0x2,
75
76 /// PTI_Restrict - Type has restrict qualifier.
77 PTI_Restrict = 0x4,
78
79 /// PTI_Incomplete - Type is incomplete.
80 PTI_Incomplete = 0x8,
81
82 /// PTI_ContainingClassIncomplete - Containing class is incomplete.
83 /// (in pointer to member).
84 PTI_ContainingClassIncomplete = 0x10
85 };
86
87 // VMI type info flags.
88 enum {
89 /// VMI_NonDiamondRepeat - Class has non-diamond repeated inheritance.
90 VMI_NonDiamondRepeat = 0x1,
91
92 /// VMI_DiamondShaped - Class is diamond shaped.
93 VMI_DiamondShaped = 0x2
94 };
95
96 // Base class type info flags.
97 enum {
98 /// BCTI_Virtual - Base class is virtual.
99 BCTI_Virtual = 0x1,
100
101 /// BCTI_Public - Base class is public.
102 BCTI_Public = 0x2
103 };
104
105 /// BuildTypeInfo - Build the RTTI type info struct for the given type.
106 ///
107 /// \param Force - true to force the creation of this RTTI value
108 llvm::Constant *BuildTypeInfo(QualType Ty, bool Force = false);
109};
110}
111
112llvm::GlobalVariable *
113RTTIBuilder::GetAddrOfTypeName(QualType Ty,
114 llvm::GlobalVariable::LinkageTypes Linkage) {
115 SmallString<256> OutName;
116 llvm::raw_svector_ostream Out(OutName);
117 CGM.getCXXABI().getMangleContext().mangleCXXRTTIName(Ty, Out);
118 Out.flush();
119 StringRef Name = OutName.str();
120
121 // We know that the mangled name of the type starts at index 4 of the
122 // mangled name of the typename, so we can just index into it in order to
123 // get the mangled name of the type.
124 llvm::Constant *Init = llvm::ConstantDataArray::getString(VMContext,
125 Name.substr(4));
126
127 llvm::GlobalVariable *GV =
128 CGM.CreateOrReplaceCXXRuntimeVariable(Name, Init->getType(), Linkage);
129
130 GV->setInitializer(Init);
131
132 return GV;
133}
134
135llvm::Constant *RTTIBuilder::GetAddrOfExternalRTTIDescriptor(QualType Ty) {
136 // Mangle the RTTI name.
137 SmallString<256> OutName;
138 llvm::raw_svector_ostream Out(OutName);
139 CGM.getCXXABI().getMangleContext().mangleCXXRTTI(Ty, Out);
140 Out.flush();
141 StringRef Name = OutName.str();
142
143 // Look for an existing global.
144 llvm::GlobalVariable *GV = CGM.getModule().getNamedGlobal(Name);
145
146 if (!GV) {
147 // Create a new global variable.
148 GV = new llvm::GlobalVariable(CGM.getModule(), CGM.Int8PtrTy,
149 /*Constant=*/true,
150 llvm::GlobalValue::ExternalLinkage, 0, Name);
151 }
152
153 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
154}
155
156/// TypeInfoIsInStandardLibrary - Given a builtin type, returns whether the type
157/// info for that type is defined in the standard library.
158static bool TypeInfoIsInStandardLibrary(const BuiltinType *Ty) {
159 // Itanium C++ ABI 2.9.2:
160 // Basic type information (e.g. for "int", "bool", etc.) will be kept in
161 // the run-time support library. Specifically, the run-time support
162 // library should contain type_info objects for the types X, X* and
163 // X const*, for every X in: void, std::nullptr_t, bool, wchar_t, char,
164 // unsigned char, signed char, short, unsigned short, int, unsigned int,
165 // long, unsigned long, long long, unsigned long long, float, double,
166 // long double, char16_t, char32_t, and the IEEE 754r decimal and
167 // half-precision floating point types.
168 switch (Ty->getKind()) {
169 case BuiltinType::Void:
170 case BuiltinType::NullPtr:
171 case BuiltinType::Bool:
172 case BuiltinType::WChar_S:
173 case BuiltinType::WChar_U:
174 case BuiltinType::Char_U:
175 case BuiltinType::Char_S:
176 case BuiltinType::UChar:
177 case BuiltinType::SChar:
178 case BuiltinType::Short:
179 case BuiltinType::UShort:
180 case BuiltinType::Int:
181 case BuiltinType::UInt:
182 case BuiltinType::Long:
183 case BuiltinType::ULong:
184 case BuiltinType::LongLong:
185 case BuiltinType::ULongLong:
186 case BuiltinType::Half:
187 case BuiltinType::Float:
188 case BuiltinType::Double:
189 case BuiltinType::LongDouble:
190 case BuiltinType::Char16:
191 case BuiltinType::Char32:
192 case BuiltinType::Int128:
193 case BuiltinType::UInt128:
Guy Benyeid8a08ea2012-12-18 14:38:23 +0000194 case BuiltinType::OCLImage1d:
195 case BuiltinType::OCLImage1dArray:
196 case BuiltinType::OCLImage1dBuffer:
197 case BuiltinType::OCLImage2d:
198 case BuiltinType::OCLImage2dArray:
199 case BuiltinType::OCLImage3d:
Guy Benyei61054192013-02-07 10:55:47 +0000200 case BuiltinType::OCLSampler:
Guy Benyei1b4fb3e2013-01-20 12:31:11 +0000201 case BuiltinType::OCLEvent:
Guy Benyei11169dd2012-12-18 14:30:41 +0000202 return true;
203
204 case BuiltinType::Dependent:
205#define BUILTIN_TYPE(Id, SingletonId)
206#define PLACEHOLDER_TYPE(Id, SingletonId) \
207 case BuiltinType::Id:
208#include "clang/AST/BuiltinTypes.def"
209 llvm_unreachable("asking for RRTI for a placeholder type!");
210
211 case BuiltinType::ObjCId:
212 case BuiltinType::ObjCClass:
213 case BuiltinType::ObjCSel:
214 llvm_unreachable("FIXME: Objective-C types are unsupported!");
215 }
216
217 llvm_unreachable("Invalid BuiltinType Kind!");
218}
219
220static bool TypeInfoIsInStandardLibrary(const PointerType *PointerTy) {
221 QualType PointeeTy = PointerTy->getPointeeType();
222 const BuiltinType *BuiltinTy = dyn_cast<BuiltinType>(PointeeTy);
223 if (!BuiltinTy)
224 return false;
225
226 // Check the qualifiers.
227 Qualifiers Quals = PointeeTy.getQualifiers();
228 Quals.removeConst();
229
230 if (!Quals.empty())
231 return false;
232
233 return TypeInfoIsInStandardLibrary(BuiltinTy);
234}
235
236/// IsStandardLibraryRTTIDescriptor - Returns whether the type
237/// information for the given type exists in the standard library.
238static bool IsStandardLibraryRTTIDescriptor(QualType Ty) {
239 // Type info for builtin types is defined in the standard library.
240 if (const BuiltinType *BuiltinTy = dyn_cast<BuiltinType>(Ty))
241 return TypeInfoIsInStandardLibrary(BuiltinTy);
242
243 // Type info for some pointer types to builtin types is defined in the
244 // standard library.
245 if (const PointerType *PointerTy = dyn_cast<PointerType>(Ty))
246 return TypeInfoIsInStandardLibrary(PointerTy);
247
248 return false;
249}
250
251/// ShouldUseExternalRTTIDescriptor - Returns whether the type information for
252/// the given type exists somewhere else, and that we should not emit the type
253/// information in this translation unit. Assumes that it is not a
254/// standard-library type.
John McCall6bd2a892013-01-25 22:31:03 +0000255static bool ShouldUseExternalRTTIDescriptor(CodeGenModule &CGM,
256 QualType Ty) {
Guy Benyei11169dd2012-12-18 14:30:41 +0000257 ASTContext &Context = CGM.getContext();
258
John McCall6bd2a892013-01-25 22:31:03 +0000259 // If RTTI is disabled, assume it might be disabled in the
260 // translation unit that defines any potential key function, too.
Guy Benyei11169dd2012-12-18 14:30:41 +0000261 if (!Context.getLangOpts().RTTI) return false;
262
263 if (const RecordType *RecordTy = dyn_cast<RecordType>(Ty)) {
264 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RecordTy->getDecl());
265 if (!RD->hasDefinition())
266 return false;
267
268 if (!RD->isDynamicClass())
269 return false;
270
John McCall6bd2a892013-01-25 22:31:03 +0000271 // FIXME: this may need to be reconsidered if the key function
272 // changes.
273 return CGM.getVTables().isVTableExternal(RD);
Guy Benyei11169dd2012-12-18 14:30:41 +0000274 }
275
276 return false;
277}
278
279/// IsIncompleteClassType - Returns whether the given record type is incomplete.
280static bool IsIncompleteClassType(const RecordType *RecordTy) {
281 return !RecordTy->getDecl()->isCompleteDefinition();
282}
283
284/// ContainsIncompleteClassType - Returns whether the given type contains an
285/// incomplete class type. This is true if
286///
287/// * The given type is an incomplete class type.
288/// * The given type is a pointer type whose pointee type contains an
289/// incomplete class type.
290/// * The given type is a member pointer type whose class is an incomplete
291/// class type.
292/// * The given type is a member pointer type whoise pointee type contains an
293/// incomplete class type.
294/// is an indirect or direct pointer to an incomplete class type.
295static bool ContainsIncompleteClassType(QualType Ty) {
296 if (const RecordType *RecordTy = dyn_cast<RecordType>(Ty)) {
297 if (IsIncompleteClassType(RecordTy))
298 return true;
299 }
300
301 if (const PointerType *PointerTy = dyn_cast<PointerType>(Ty))
302 return ContainsIncompleteClassType(PointerTy->getPointeeType());
303
304 if (const MemberPointerType *MemberPointerTy =
305 dyn_cast<MemberPointerType>(Ty)) {
306 // Check if the class type is incomplete.
307 const RecordType *ClassType = cast<RecordType>(MemberPointerTy->getClass());
308 if (IsIncompleteClassType(ClassType))
309 return true;
310
311 return ContainsIncompleteClassType(MemberPointerTy->getPointeeType());
312 }
313
314 return false;
315}
316
317/// getTypeInfoLinkage - Return the linkage that the type info and type info
318/// name constants should have for the given type.
319static llvm::GlobalVariable::LinkageTypes
320getTypeInfoLinkage(CodeGenModule &CGM, QualType Ty) {
321 // Itanium C++ ABI 2.9.5p7:
322 // In addition, it and all of the intermediate abi::__pointer_type_info
323 // structs in the chain down to the abi::__class_type_info for the
324 // incomplete class type must be prevented from resolving to the
325 // corresponding type_info structs for the complete class type, possibly
326 // by making them local static objects. Finally, a dummy class RTTI is
327 // generated for the incomplete type that will not resolve to the final
328 // complete class RTTI (because the latter need not exist), possibly by
329 // making it a local static object.
330 if (ContainsIncompleteClassType(Ty))
331 return llvm::GlobalValue::InternalLinkage;
332
333 switch (Ty->getLinkage()) {
334 case NoLinkage:
335 case InternalLinkage:
336 case UniqueExternalLinkage:
337 return llvm::GlobalValue::InternalLinkage;
338
John McCalle54d92b2014-03-10 22:27:33 +0000339 case VisibleNoLinkage:
Guy Benyei11169dd2012-12-18 14:30:41 +0000340 case ExternalLinkage:
341 if (!CGM.getLangOpts().RTTI) {
342 // RTTI is not enabled, which means that this type info struct is going
343 // to be used for exception handling. Give it linkonce_odr linkage.
344 return llvm::GlobalValue::LinkOnceODRLinkage;
345 }
346
347 if (const RecordType *Record = dyn_cast<RecordType>(Ty)) {
348 const CXXRecordDecl *RD = cast<CXXRecordDecl>(Record->getDecl());
349 if (RD->hasAttr<WeakAttr>())
350 return llvm::GlobalValue::WeakODRLinkage;
351 if (RD->isDynamicClass())
352 return CGM.getVTableLinkage(RD);
353 }
354
355 return llvm::GlobalValue::LinkOnceODRLinkage;
356 }
357
358 llvm_unreachable("Invalid linkage!");
359}
360
361// CanUseSingleInheritance - Return whether the given record decl has a "single,
362// public, non-virtual base at offset zero (i.e. the derived class is dynamic
363// iff the base is)", according to Itanium C++ ABI, 2.95p6b.
364static bool CanUseSingleInheritance(const CXXRecordDecl *RD) {
365 // Check the number of bases.
366 if (RD->getNumBases() != 1)
367 return false;
368
369 // Get the base.
370 CXXRecordDecl::base_class_const_iterator Base = RD->bases_begin();
371
372 // Check that the base is not virtual.
373 if (Base->isVirtual())
374 return false;
375
376 // Check that the base is public.
377 if (Base->getAccessSpecifier() != AS_public)
378 return false;
379
380 // Check that the class is dynamic iff the base is.
381 const CXXRecordDecl *BaseDecl =
382 cast<CXXRecordDecl>(Base->getType()->getAs<RecordType>()->getDecl());
383 if (!BaseDecl->isEmpty() &&
384 BaseDecl->isDynamicClass() != RD->isDynamicClass())
385 return false;
386
387 return true;
388}
389
390void RTTIBuilder::BuildVTablePointer(const Type *Ty) {
391 // abi::__class_type_info.
392 static const char * const ClassTypeInfo =
393 "_ZTVN10__cxxabiv117__class_type_infoE";
394 // abi::__si_class_type_info.
395 static const char * const SIClassTypeInfo =
396 "_ZTVN10__cxxabiv120__si_class_type_infoE";
397 // abi::__vmi_class_type_info.
398 static const char * const VMIClassTypeInfo =
399 "_ZTVN10__cxxabiv121__vmi_class_type_infoE";
400
401 const char *VTableName = 0;
402
403 switch (Ty->getTypeClass()) {
404#define TYPE(Class, Base)
405#define ABSTRACT_TYPE(Class, Base)
406#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base) case Type::Class:
407#define NON_CANONICAL_TYPE(Class, Base) case Type::Class:
408#define DEPENDENT_TYPE(Class, Base) case Type::Class:
409#include "clang/AST/TypeNodes.def"
410 llvm_unreachable("Non-canonical and dependent types shouldn't get here");
411
412 case Type::LValueReference:
413 case Type::RValueReference:
414 llvm_unreachable("References shouldn't get here");
415
Richard Smith27d807c2013-04-30 13:56:41 +0000416 case Type::Auto:
417 llvm_unreachable("Undeduced auto type shouldn't get here");
418
Guy Benyei11169dd2012-12-18 14:30:41 +0000419 case Type::Builtin:
420 // GCC treats vector and complex types as fundamental types.
421 case Type::Vector:
422 case Type::ExtVector:
423 case Type::Complex:
424 case Type::Atomic:
425 // FIXME: GCC treats block pointers as fundamental types?!
426 case Type::BlockPointer:
427 // abi::__fundamental_type_info.
428 VTableName = "_ZTVN10__cxxabiv123__fundamental_type_infoE";
429 break;
430
431 case Type::ConstantArray:
432 case Type::IncompleteArray:
433 case Type::VariableArray:
434 // abi::__array_type_info.
435 VTableName = "_ZTVN10__cxxabiv117__array_type_infoE";
436 break;
437
438 case Type::FunctionNoProto:
439 case Type::FunctionProto:
440 // abi::__function_type_info.
441 VTableName = "_ZTVN10__cxxabiv120__function_type_infoE";
442 break;
443
444 case Type::Enum:
445 // abi::__enum_type_info.
446 VTableName = "_ZTVN10__cxxabiv116__enum_type_infoE";
447 break;
448
449 case Type::Record: {
450 const CXXRecordDecl *RD =
451 cast<CXXRecordDecl>(cast<RecordType>(Ty)->getDecl());
452
453 if (!RD->hasDefinition() || !RD->getNumBases()) {
454 VTableName = ClassTypeInfo;
455 } else if (CanUseSingleInheritance(RD)) {
456 VTableName = SIClassTypeInfo;
457 } else {
458 VTableName = VMIClassTypeInfo;
459 }
460
461 break;
462 }
463
464 case Type::ObjCObject:
465 // Ignore protocol qualifiers.
466 Ty = cast<ObjCObjectType>(Ty)->getBaseType().getTypePtr();
467
468 // Handle id and Class.
469 if (isa<BuiltinType>(Ty)) {
470 VTableName = ClassTypeInfo;
471 break;
472 }
473
474 assert(isa<ObjCInterfaceType>(Ty));
475 // Fall through.
476
477 case Type::ObjCInterface:
478 if (cast<ObjCInterfaceType>(Ty)->getDecl()->getSuperClass()) {
479 VTableName = SIClassTypeInfo;
480 } else {
481 VTableName = ClassTypeInfo;
482 }
483 break;
484
485 case Type::ObjCObjectPointer:
486 case Type::Pointer:
487 // abi::__pointer_type_info.
488 VTableName = "_ZTVN10__cxxabiv119__pointer_type_infoE";
489 break;
490
491 case Type::MemberPointer:
492 // abi::__pointer_to_member_type_info.
493 VTableName = "_ZTVN10__cxxabiv129__pointer_to_member_type_infoE";
494 break;
495 }
496
497 llvm::Constant *VTable =
498 CGM.getModule().getOrInsertGlobal(VTableName, CGM.Int8PtrTy);
499
500 llvm::Type *PtrDiffTy =
501 CGM.getTypes().ConvertType(CGM.getContext().getPointerDiffType());
502
503 // The vtable address point is 2.
504 llvm::Constant *Two = llvm::ConstantInt::get(PtrDiffTy, 2);
505 VTable = llvm::ConstantExpr::getInBoundsGetElementPtr(VTable, Two);
506 VTable = llvm::ConstantExpr::getBitCast(VTable, CGM.Int8PtrTy);
507
508 Fields.push_back(VTable);
509}
510
Guy Benyei11169dd2012-12-18 14:30:41 +0000511llvm::Constant *RTTIBuilder::BuildTypeInfo(QualType Ty, bool Force) {
512 // We want to operate on the canonical type.
513 Ty = CGM.getContext().getCanonicalType(Ty);
514
515 // Check if we've already emitted an RTTI descriptor for this type.
516 SmallString<256> OutName;
517 llvm::raw_svector_ostream Out(OutName);
518 CGM.getCXXABI().getMangleContext().mangleCXXRTTI(Ty, Out);
519 Out.flush();
520 StringRef Name = OutName.str();
521
522 llvm::GlobalVariable *OldGV = CGM.getModule().getNamedGlobal(Name);
523 if (OldGV && !OldGV->isDeclaration()) {
Eli Friedmanba2778f2013-06-28 22:13:27 +0000524 assert(!OldGV->hasAvailableExternallyLinkage() &&
525 "available_externally typeinfos not yet implemented");
Guy Benyei11169dd2012-12-18 14:30:41 +0000526
527 return llvm::ConstantExpr::getBitCast(OldGV, CGM.Int8PtrTy);
528 }
529
530 // Check if there is already an external RTTI descriptor for this type.
531 bool IsStdLib = IsStandardLibraryRTTIDescriptor(Ty);
532 if (!Force && (IsStdLib || ShouldUseExternalRTTIDescriptor(CGM, Ty)))
533 return GetAddrOfExternalRTTIDescriptor(Ty);
534
535 // Emit the standard library with external linkage.
536 llvm::GlobalVariable::LinkageTypes Linkage;
537 if (IsStdLib)
538 Linkage = llvm::GlobalValue::ExternalLinkage;
539 else
540 Linkage = getTypeInfoLinkage(CGM, Ty);
541
542 // Add the vtable pointer.
543 BuildVTablePointer(cast<Type>(Ty));
544
545 // And the name.
546 llvm::GlobalVariable *TypeName = GetAddrOfTypeName(Ty, Linkage);
547
548 Fields.push_back(llvm::ConstantExpr::getBitCast(TypeName, CGM.Int8PtrTy));
549
550 switch (Ty->getTypeClass()) {
551#define TYPE(Class, Base)
552#define ABSTRACT_TYPE(Class, Base)
553#define NON_CANONICAL_UNLESS_DEPENDENT_TYPE(Class, Base) case Type::Class:
554#define NON_CANONICAL_TYPE(Class, Base) case Type::Class:
555#define DEPENDENT_TYPE(Class, Base) case Type::Class:
556#include "clang/AST/TypeNodes.def"
557 llvm_unreachable("Non-canonical and dependent types shouldn't get here");
558
559 // GCC treats vector types as fundamental types.
560 case Type::Builtin:
561 case Type::Vector:
562 case Type::ExtVector:
563 case Type::Complex:
564 case Type::BlockPointer:
565 // Itanium C++ ABI 2.9.5p4:
566 // abi::__fundamental_type_info adds no data members to std::type_info.
567 break;
568
569 case Type::LValueReference:
570 case Type::RValueReference:
571 llvm_unreachable("References shouldn't get here");
572
Richard Smith27d807c2013-04-30 13:56:41 +0000573 case Type::Auto:
574 llvm_unreachable("Undeduced auto type shouldn't get here");
575
Guy Benyei11169dd2012-12-18 14:30:41 +0000576 case Type::ConstantArray:
577 case Type::IncompleteArray:
578 case Type::VariableArray:
579 // Itanium C++ ABI 2.9.5p5:
580 // abi::__array_type_info adds no data members to std::type_info.
581 break;
582
583 case Type::FunctionNoProto:
584 case Type::FunctionProto:
585 // Itanium C++ ABI 2.9.5p5:
586 // abi::__function_type_info adds no data members to std::type_info.
587 break;
588
589 case Type::Enum:
590 // Itanium C++ ABI 2.9.5p5:
591 // abi::__enum_type_info adds no data members to std::type_info.
592 break;
593
594 case Type::Record: {
595 const CXXRecordDecl *RD =
596 cast<CXXRecordDecl>(cast<RecordType>(Ty)->getDecl());
597 if (!RD->hasDefinition() || !RD->getNumBases()) {
598 // We don't need to emit any fields.
599 break;
600 }
601
602 if (CanUseSingleInheritance(RD))
603 BuildSIClassTypeInfo(RD);
604 else
605 BuildVMIClassTypeInfo(RD);
606
607 break;
608 }
609
610 case Type::ObjCObject:
611 case Type::ObjCInterface:
612 BuildObjCObjectTypeInfo(cast<ObjCObjectType>(Ty));
613 break;
614
615 case Type::ObjCObjectPointer:
616 BuildPointerTypeInfo(cast<ObjCObjectPointerType>(Ty)->getPointeeType());
617 break;
618
619 case Type::Pointer:
620 BuildPointerTypeInfo(cast<PointerType>(Ty)->getPointeeType());
621 break;
622
623 case Type::MemberPointer:
624 BuildPointerToMemberTypeInfo(cast<MemberPointerType>(Ty));
625 break;
626
627 case Type::Atomic:
628 // No fields, at least for the moment.
629 break;
630 }
631
632 llvm::Constant *Init = llvm::ConstantStruct::getAnon(Fields);
633
634 llvm::GlobalVariable *GV =
635 new llvm::GlobalVariable(CGM.getModule(), Init->getType(),
636 /*Constant=*/true, Linkage, Init, Name);
637
638 // If there's already an old global variable, replace it with the new one.
639 if (OldGV) {
640 GV->takeName(OldGV);
641 llvm::Constant *NewPtr =
642 llvm::ConstantExpr::getBitCast(GV, OldGV->getType());
643 OldGV->replaceAllUsesWith(NewPtr);
644 OldGV->eraseFromParent();
645 }
646
John McCall57420b32014-02-08 03:26:05 +0000647 // The Itanium ABI specifies that type_info objects must be globally
648 // unique, with one exception: if the type is an incomplete class
649 // type or a (possibly indirect) pointer to one. That exception
650 // affects the general case of comparing type_info objects produced
651 // by the typeid operator, which is why the comparison operators on
652 // std::type_info generally use the type_info name pointers instead
653 // of the object addresses. However, the language's built-in uses
654 // of RTTI generally require class types to be complete, even when
655 // manipulating pointers to those class types. This allows the
656 // implementation of dynamic_cast to rely on address equality tests,
657 // which is much faster.
658
659 // All of this is to say that it's important that both the type_info
660 // object and the type_info name be uniqued when weakly emitted.
661
John McCall8f80a612014-02-08 00:41:16 +0000662 // Give the type_info object and name the formal visibility of the
663 // type itself.
664 Visibility formalVisibility = Ty->getVisibility();
665 llvm::GlobalValue::VisibilityTypes llvmVisibility =
666 CodeGenModule::GetLLVMVisibility(formalVisibility);
667 TypeName->setVisibility(llvmVisibility);
668 GV->setVisibility(llvmVisibility);
Guy Benyei11169dd2012-12-18 14:30:41 +0000669
Guy Benyei11169dd2012-12-18 14:30:41 +0000670 return llvm::ConstantExpr::getBitCast(GV, CGM.Int8PtrTy);
671}
672
673/// ComputeQualifierFlags - Compute the pointer type info flags from the
674/// given qualifier.
675static unsigned ComputeQualifierFlags(Qualifiers Quals) {
676 unsigned Flags = 0;
677
678 if (Quals.hasConst())
679 Flags |= RTTIBuilder::PTI_Const;
680 if (Quals.hasVolatile())
681 Flags |= RTTIBuilder::PTI_Volatile;
682 if (Quals.hasRestrict())
683 Flags |= RTTIBuilder::PTI_Restrict;
684
685 return Flags;
686}
687
688/// BuildObjCObjectTypeInfo - Build the appropriate kind of type_info
689/// for the given Objective-C object type.
690void RTTIBuilder::BuildObjCObjectTypeInfo(const ObjCObjectType *OT) {
691 // Drop qualifiers.
692 const Type *T = OT->getBaseType().getTypePtr();
693 assert(isa<BuiltinType>(T) || isa<ObjCInterfaceType>(T));
694
695 // The builtin types are abi::__class_type_infos and don't require
696 // extra fields.
697 if (isa<BuiltinType>(T)) return;
698
699 ObjCInterfaceDecl *Class = cast<ObjCInterfaceType>(T)->getDecl();
700 ObjCInterfaceDecl *Super = Class->getSuperClass();
701
702 // Root classes are also __class_type_info.
703 if (!Super) return;
704
705 QualType SuperTy = CGM.getContext().getObjCInterfaceType(Super);
706
707 // Everything else is single inheritance.
708 llvm::Constant *BaseTypeInfo = RTTIBuilder(CGM).BuildTypeInfo(SuperTy);
709 Fields.push_back(BaseTypeInfo);
710}
711
712/// BuildSIClassTypeInfo - Build an abi::__si_class_type_info, used for single
713/// inheritance, according to the Itanium C++ ABI, 2.95p6b.
714void RTTIBuilder::BuildSIClassTypeInfo(const CXXRecordDecl *RD) {
715 // Itanium C++ ABI 2.9.5p6b:
716 // It adds to abi::__class_type_info a single member pointing to the
717 // type_info structure for the base type,
718 llvm::Constant *BaseTypeInfo =
719 RTTIBuilder(CGM).BuildTypeInfo(RD->bases_begin()->getType());
720 Fields.push_back(BaseTypeInfo);
721}
722
723namespace {
724 /// SeenBases - Contains virtual and non-virtual bases seen when traversing
725 /// a class hierarchy.
726 struct SeenBases {
727 llvm::SmallPtrSet<const CXXRecordDecl *, 16> NonVirtualBases;
728 llvm::SmallPtrSet<const CXXRecordDecl *, 16> VirtualBases;
729 };
730}
731
732/// ComputeVMIClassTypeInfoFlags - Compute the value of the flags member in
733/// abi::__vmi_class_type_info.
734///
735static unsigned ComputeVMIClassTypeInfoFlags(const CXXBaseSpecifier *Base,
736 SeenBases &Bases) {
737
738 unsigned Flags = 0;
739
740 const CXXRecordDecl *BaseDecl =
741 cast<CXXRecordDecl>(Base->getType()->getAs<RecordType>()->getDecl());
742
743 if (Base->isVirtual()) {
744 // Mark the virtual base as seen.
745 if (!Bases.VirtualBases.insert(BaseDecl)) {
746 // If this virtual base has been seen before, then the class is diamond
747 // shaped.
748 Flags |= RTTIBuilder::VMI_DiamondShaped;
749 } else {
750 if (Bases.NonVirtualBases.count(BaseDecl))
751 Flags |= RTTIBuilder::VMI_NonDiamondRepeat;
752 }
753 } else {
754 // Mark the non-virtual base as seen.
755 if (!Bases.NonVirtualBases.insert(BaseDecl)) {
756 // If this non-virtual base has been seen before, then the class has non-
757 // diamond shaped repeated inheritance.
758 Flags |= RTTIBuilder::VMI_NonDiamondRepeat;
759 } else {
760 if (Bases.VirtualBases.count(BaseDecl))
761 Flags |= RTTIBuilder::VMI_NonDiamondRepeat;
762 }
763 }
764
765 // Walk all bases.
766 for (CXXRecordDecl::base_class_const_iterator I = BaseDecl->bases_begin(),
767 E = BaseDecl->bases_end(); I != E; ++I)
768 Flags |= ComputeVMIClassTypeInfoFlags(I, Bases);
769
770 return Flags;
771}
772
773static unsigned ComputeVMIClassTypeInfoFlags(const CXXRecordDecl *RD) {
774 unsigned Flags = 0;
775 SeenBases Bases;
776
777 // Walk all bases.
778 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
779 E = RD->bases_end(); I != E; ++I)
780 Flags |= ComputeVMIClassTypeInfoFlags(I, Bases);
781
782 return Flags;
783}
784
785/// BuildVMIClassTypeInfo - Build an abi::__vmi_class_type_info, used for
786/// classes with bases that do not satisfy the abi::__si_class_type_info
787/// constraints, according ti the Itanium C++ ABI, 2.9.5p5c.
788void RTTIBuilder::BuildVMIClassTypeInfo(const CXXRecordDecl *RD) {
789 llvm::Type *UnsignedIntLTy =
790 CGM.getTypes().ConvertType(CGM.getContext().UnsignedIntTy);
791
792 // Itanium C++ ABI 2.9.5p6c:
793 // __flags is a word with flags describing details about the class
794 // structure, which may be referenced by using the __flags_masks
795 // enumeration. These flags refer to both direct and indirect bases.
796 unsigned Flags = ComputeVMIClassTypeInfoFlags(RD);
797 Fields.push_back(llvm::ConstantInt::get(UnsignedIntLTy, Flags));
798
799 // Itanium C++ ABI 2.9.5p6c:
800 // __base_count is a word with the number of direct proper base class
801 // descriptions that follow.
802 Fields.push_back(llvm::ConstantInt::get(UnsignedIntLTy, RD->getNumBases()));
803
804 if (!RD->getNumBases())
805 return;
806
807 llvm::Type *LongLTy =
808 CGM.getTypes().ConvertType(CGM.getContext().LongTy);
809
810 // Now add the base class descriptions.
811
812 // Itanium C++ ABI 2.9.5p6c:
813 // __base_info[] is an array of base class descriptions -- one for every
814 // direct proper base. Each description is of the type:
815 //
816 // struct abi::__base_class_type_info {
817 // public:
818 // const __class_type_info *__base_type;
819 // long __offset_flags;
820 //
821 // enum __offset_flags_masks {
822 // __virtual_mask = 0x1,
823 // __public_mask = 0x2,
824 // __offset_shift = 8
825 // };
826 // };
827 for (CXXRecordDecl::base_class_const_iterator I = RD->bases_begin(),
828 E = RD->bases_end(); I != E; ++I) {
829 const CXXBaseSpecifier *Base = I;
830
831 // The __base_type member points to the RTTI for the base type.
832 Fields.push_back(RTTIBuilder(CGM).BuildTypeInfo(Base->getType()));
833
834 const CXXRecordDecl *BaseDecl =
835 cast<CXXRecordDecl>(Base->getType()->getAs<RecordType>()->getDecl());
836
837 int64_t OffsetFlags = 0;
838
839 // All but the lower 8 bits of __offset_flags are a signed offset.
840 // For a non-virtual base, this is the offset in the object of the base
841 // subobject. For a virtual base, this is the offset in the virtual table of
842 // the virtual base offset for the virtual base referenced (negative).
843 CharUnits Offset;
844 if (Base->isVirtual())
845 Offset =
Timur Iskhodzhanov58776632013-11-05 15:54:58 +0000846 CGM.getItaniumVTableContext().getVirtualBaseOffsetOffset(RD, BaseDecl);
Guy Benyei11169dd2012-12-18 14:30:41 +0000847 else {
848 const ASTRecordLayout &Layout = CGM.getContext().getASTRecordLayout(RD);
849 Offset = Layout.getBaseClassOffset(BaseDecl);
850 };
851
852 OffsetFlags = uint64_t(Offset.getQuantity()) << 8;
853
854 // The low-order byte of __offset_flags contains flags, as given by the
855 // masks from the enumeration __offset_flags_masks.
856 if (Base->isVirtual())
857 OffsetFlags |= BCTI_Virtual;
858 if (Base->getAccessSpecifier() == AS_public)
859 OffsetFlags |= BCTI_Public;
860
861 Fields.push_back(llvm::ConstantInt::get(LongLTy, OffsetFlags));
862 }
863}
864
865/// BuildPointerTypeInfo - Build an abi::__pointer_type_info struct,
866/// used for pointer types.
867void RTTIBuilder::BuildPointerTypeInfo(QualType PointeeTy) {
868 Qualifiers Quals;
869 QualType UnqualifiedPointeeTy =
870 CGM.getContext().getUnqualifiedArrayType(PointeeTy, Quals);
871
872 // Itanium C++ ABI 2.9.5p7:
873 // __flags is a flag word describing the cv-qualification and other
874 // attributes of the type pointed to
875 unsigned Flags = ComputeQualifierFlags(Quals);
876
877 // Itanium C++ ABI 2.9.5p7:
878 // When the abi::__pbase_type_info is for a direct or indirect pointer to an
879 // incomplete class type, the incomplete target type flag is set.
880 if (ContainsIncompleteClassType(UnqualifiedPointeeTy))
881 Flags |= PTI_Incomplete;
882
883 llvm::Type *UnsignedIntLTy =
884 CGM.getTypes().ConvertType(CGM.getContext().UnsignedIntTy);
885 Fields.push_back(llvm::ConstantInt::get(UnsignedIntLTy, Flags));
886
887 // Itanium C++ ABI 2.9.5p7:
888 // __pointee is a pointer to the std::type_info derivation for the
889 // unqualified type being pointed to.
890 llvm::Constant *PointeeTypeInfo =
891 RTTIBuilder(CGM).BuildTypeInfo(UnqualifiedPointeeTy);
892 Fields.push_back(PointeeTypeInfo);
893}
894
895/// BuildPointerToMemberTypeInfo - Build an abi::__pointer_to_member_type_info
896/// struct, used for member pointer types.
897void RTTIBuilder::BuildPointerToMemberTypeInfo(const MemberPointerType *Ty) {
898 QualType PointeeTy = Ty->getPointeeType();
899
900 Qualifiers Quals;
901 QualType UnqualifiedPointeeTy =
902 CGM.getContext().getUnqualifiedArrayType(PointeeTy, Quals);
903
904 // Itanium C++ ABI 2.9.5p7:
905 // __flags is a flag word describing the cv-qualification and other
906 // attributes of the type pointed to.
907 unsigned Flags = ComputeQualifierFlags(Quals);
908
909 const RecordType *ClassType = cast<RecordType>(Ty->getClass());
910
911 // Itanium C++ ABI 2.9.5p7:
912 // When the abi::__pbase_type_info is for a direct or indirect pointer to an
913 // incomplete class type, the incomplete target type flag is set.
914 if (ContainsIncompleteClassType(UnqualifiedPointeeTy))
915 Flags |= PTI_Incomplete;
916
917 if (IsIncompleteClassType(ClassType))
918 Flags |= PTI_ContainingClassIncomplete;
919
920 llvm::Type *UnsignedIntLTy =
921 CGM.getTypes().ConvertType(CGM.getContext().UnsignedIntTy);
922 Fields.push_back(llvm::ConstantInt::get(UnsignedIntLTy, Flags));
923
924 // Itanium C++ ABI 2.9.5p7:
925 // __pointee is a pointer to the std::type_info derivation for the
926 // unqualified type being pointed to.
927 llvm::Constant *PointeeTypeInfo =
928 RTTIBuilder(CGM).BuildTypeInfo(UnqualifiedPointeeTy);
929 Fields.push_back(PointeeTypeInfo);
930
931 // Itanium C++ ABI 2.9.5p9:
932 // __context is a pointer to an abi::__class_type_info corresponding to the
933 // class type containing the member pointed to
934 // (e.g., the "A" in "int A::*").
935 Fields.push_back(RTTIBuilder(CGM).BuildTypeInfo(QualType(ClassType, 0)));
936}
937
938llvm::Constant *CodeGenModule::GetAddrOfRTTIDescriptor(QualType Ty,
939 bool ForEH) {
940 // Return a bogus pointer if RTTI is disabled, unless it's for EH.
941 // FIXME: should we even be calling this method if RTTI is disabled
942 // and it's not for EH?
943 if (!ForEH && !getLangOpts().RTTI)
944 return llvm::Constant::getNullValue(Int8PtrTy);
945
946 if (ForEH && Ty->isObjCObjectPointerType() &&
947 LangOpts.ObjCRuntime.isGNUFamily())
948 return ObjCRuntime->GetEHType(Ty);
949
950 return RTTIBuilder(*this).BuildTypeInfo(Ty);
951}
952
953void CodeGenModule::EmitFundamentalRTTIDescriptor(QualType Type) {
954 QualType PointerType = Context.getPointerType(Type);
955 QualType PointerTypeConst = Context.getPointerType(Type.withConst());
956 RTTIBuilder(*this).BuildTypeInfo(Type, true);
957 RTTIBuilder(*this).BuildTypeInfo(PointerType, true);
958 RTTIBuilder(*this).BuildTypeInfo(PointerTypeConst, true);
959}
960
961void CodeGenModule::EmitFundamentalRTTIDescriptors() {
962 QualType FundamentalTypes[] = { Context.VoidTy, Context.NullPtrTy,
963 Context.BoolTy, Context.WCharTy,
964 Context.CharTy, Context.UnsignedCharTy,
965 Context.SignedCharTy, Context.ShortTy,
966 Context.UnsignedShortTy, Context.IntTy,
967 Context.UnsignedIntTy, Context.LongTy,
968 Context.UnsignedLongTy, Context.LongLongTy,
969 Context.UnsignedLongLongTy, Context.FloatTy,
970 Context.DoubleTy, Context.LongDoubleTy,
971 Context.Char16Ty, Context.Char32Ty };
Craig Toppere5ce8312013-07-15 03:38:40 +0000972 for (unsigned i = 0; i < llvm::array_lengthof(FundamentalTypes); ++i)
Guy Benyei11169dd2012-12-18 14:30:41 +0000973 EmitFundamentalRTTIDescriptor(FundamentalTypes[i]);
974}