1 //===--- CGCXX.cpp - Emit LLVM Code for declarations ----------------------===// 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. 11 // 12 //===----------------------------------------------------------------------===// 13 14 // We might split this into multiple files if it gets too unwieldy 15 16 #include "CGCXXABI.h" 17 #include "CodeGenFunction.h" 18 #include "CodeGenModule.h" 19 #include "clang/AST/ASTContext.h" 20 #include "clang/AST/RecordLayout.h" 21 #include "clang/AST/Decl.h" 22 #include "clang/AST/DeclCXX.h" 23 #include "clang/AST/DeclObjC.h" 24 #include "clang/AST/Mangle.h" 25 #include "clang/AST/StmtCXX.h" 26 #include "clang/Frontend/CodeGenOptions.h" 27 #include "llvm/ADT/StringExtras.h" 28 using namespace clang; 29 using namespace CodeGen; 30 31 /// Try to emit a base destructor as an alias to its primary 32 /// base-class destructor. 33 bool CodeGenModule::TryEmitBaseDestructorAsAlias(const CXXDestructorDecl *D) { 34 if (!getCodeGenOpts().CXXCtorDtorAliases) 35 return true; 36 37 // If the destructor doesn't have a trivial body, we have to emit it 38 // separately. 39 if (!D->hasTrivialBody()) 40 return true; 41 42 const CXXRecordDecl *Class = D->getParent(); 43 44 // If we need to manipulate a VTT parameter, give up. 45 if (Class->getNumVBases()) { 46 // Extra Credit: passing extra parameters is perfectly safe 47 // in many calling conventions, so only bail out if the ctor's 48 // calling convention is nonstandard. 49 return true; 50 } 51 52 // If any field has a non-trivial destructor, we have to emit the 53 // destructor separately. 54 for (CXXRecordDecl::field_iterator I = Class->field_begin(), 55 E = Class->field_end(); I != E; ++I) 56 if ((*I)->getType().isDestructedType()) 57 return true; 58 59 // Try to find a unique base class with a non-trivial destructor. 60 const CXXRecordDecl *UniqueBase = 0; 61 for (CXXRecordDecl::base_class_const_iterator I = Class->bases_begin(), 62 E = Class->bases_end(); I != E; ++I) { 63 64 // We're in the base destructor, so skip virtual bases. 65 if (I->isVirtual()) continue; 66 67 // Skip base classes with trivial destructors. 68 const CXXRecordDecl *Base 69 = cast<CXXRecordDecl>(I->getType()->getAs<RecordType>()->getDecl()); 70 if (Base->hasTrivialDestructor()) continue; 71 72 // If we've already found a base class with a non-trivial 73 // destructor, give up. 74 if (UniqueBase) return true; 75 UniqueBase = Base; 76 } 77 78 // If we didn't find any bases with a non-trivial destructor, then 79 // the base destructor is actually effectively trivial, which can 80 // happen if it was needlessly user-defined or if there are virtual 81 // bases with non-trivial destructors. 82 if (!UniqueBase) 83 return true; 84 85 /// If we don't have a definition for the destructor yet, don't 86 /// emit. We can't emit aliases to declarations; that's just not 87 /// how aliases work. 88 const CXXDestructorDecl *BaseD = UniqueBase->getDestructor(); 89 if (!BaseD->isImplicit() && !BaseD->hasBody()) 90 return true; 91 92 // If the base is at a non-zero offset, give up. 93 const ASTRecordLayout &ClassLayout = Context.getASTRecordLayout(Class); 94 if (ClassLayout.getBaseClassOffsetInBits(UniqueBase) != 0) 95 return true; 96 97 return TryEmitDefinitionAsAlias(GlobalDecl(D, Dtor_Base), 98 GlobalDecl(BaseD, Dtor_Base)); 99 } 100 101 /// Try to emit a definition as a global alias for another definition. 102 bool CodeGenModule::TryEmitDefinitionAsAlias(GlobalDecl AliasDecl, 103 GlobalDecl TargetDecl) { 104 if (!getCodeGenOpts().CXXCtorDtorAliases) 105 return true; 106 107 // The alias will use the linkage of the referrent. If we can't 108 // support aliases with that linkage, fail. 109 llvm::GlobalValue::LinkageTypes Linkage 110 = getFunctionLinkage(cast<FunctionDecl>(AliasDecl.getDecl())); 111 112 switch (Linkage) { 113 // We can definitely emit aliases to definitions with external linkage. 114 case llvm::GlobalValue::ExternalLinkage: 115 case llvm::GlobalValue::ExternalWeakLinkage: 116 break; 117 118 // Same with local linkage. 119 case llvm::GlobalValue::InternalLinkage: 120 case llvm::GlobalValue::PrivateLinkage: 121 case llvm::GlobalValue::LinkerPrivateLinkage: 122 break; 123 124 // We should try to support linkonce linkages. 125 case llvm::GlobalValue::LinkOnceAnyLinkage: 126 case llvm::GlobalValue::LinkOnceODRLinkage: 127 return true; 128 129 // Other linkages will probably never be supported. 130 default: 131 return true; 132 } 133 134 llvm::GlobalValue::LinkageTypes TargetLinkage 135 = getFunctionLinkage(cast<FunctionDecl>(TargetDecl.getDecl())); 136 137 if (llvm::GlobalValue::isWeakForLinker(TargetLinkage)) 138 return true; 139 140 // Derive the type for the alias. 141 llvm::PointerType *AliasType 142 = getTypes().GetFunctionType(AliasDecl)->getPointerTo(); 143 144 // Find the referrent. Some aliases might require a bitcast, in 145 // which case the caller is responsible for ensuring the soundness 146 // of these semantics. 147 llvm::GlobalValue *Ref = cast<llvm::GlobalValue>(GetAddrOfGlobal(TargetDecl)); 148 llvm::Constant *Aliasee = Ref; 149 if (Ref->getType() != AliasType) 150 Aliasee = llvm::ConstantExpr::getBitCast(Ref, AliasType); 151 152 // Create the alias with no name. 153 llvm::GlobalAlias *Alias = 154 new llvm::GlobalAlias(AliasType, Linkage, "", Aliasee, &getModule()); 155 156 // Switch any previous uses to the alias. 157 llvm::StringRef MangledName = getMangledName(AliasDecl); 158 llvm::GlobalValue *Entry = GetGlobalValue(MangledName); 159 if (Entry) { 160 assert(Entry->isDeclaration() && "definition already exists for alias"); 161 assert(Entry->getType() == AliasType && 162 "declaration exists with different type"); 163 Alias->takeName(Entry); 164 Entry->replaceAllUsesWith(Alias); 165 Entry->eraseFromParent(); 166 } else { 167 Alias->setName(MangledName); 168 } 169 170 // Finally, set up the alias with its proper name and attributes. 171 SetCommonAttributes(cast<NamedDecl>(AliasDecl.getDecl()), Alias); 172 173 return false; 174 } 175 176 void CodeGenModule::EmitCXXConstructors(const CXXConstructorDecl *D) { 177 // The constructor used for constructing this as a complete class; 178 // constucts the virtual bases, then calls the base constructor. 179 if (!D->getParent()->isAbstract()) { 180 // We don't need to emit the complete ctor if the class is abstract. 181 EmitGlobal(GlobalDecl(D, Ctor_Complete)); 182 } 183 184 // The constructor used for constructing this as a base class; 185 // ignores virtual bases. 186 EmitGlobal(GlobalDecl(D, Ctor_Base)); 187 } 188 189 void CodeGenModule::EmitCXXConstructor(const CXXConstructorDecl *ctor, 190 CXXCtorType ctorType) { 191 // The complete constructor is equivalent to the base constructor 192 // for classes with no virtual bases. Try to emit it as an alias. 193 if (ctorType == Ctor_Complete && 194 !ctor->getParent()->getNumVBases() && 195 !TryEmitDefinitionAsAlias(GlobalDecl(ctor, Ctor_Complete), 196 GlobalDecl(ctor, Ctor_Base))) 197 return; 198 199 const CGFunctionInfo &fnInfo = getTypes().getFunctionInfo(ctor, ctorType); 200 201 llvm::Function *fn = 202 cast<llvm::Function>(GetAddrOfCXXConstructor(ctor, ctorType, &fnInfo)); 203 setFunctionLinkage(ctor, fn); 204 205 CodeGenFunction(*this).GenerateCode(GlobalDecl(ctor, ctorType), fn, fnInfo); 206 207 SetFunctionDefinitionAttributes(ctor, fn); 208 SetLLVMFunctionAttributesForDefinition(ctor, fn); 209 } 210 211 llvm::GlobalValue * 212 CodeGenModule::GetAddrOfCXXConstructor(const CXXConstructorDecl *ctor, 213 CXXCtorType ctorType, 214 const CGFunctionInfo *fnInfo) { 215 GlobalDecl GD(ctor, ctorType); 216 217 llvm::StringRef name = getMangledName(GD); 218 if (llvm::GlobalValue *existing = GetGlobalValue(name)) 219 return existing; 220 221 if (!fnInfo) fnInfo = &getTypes().getFunctionInfo(ctor, ctorType); 222 223 const FunctionProtoType *proto = ctor->getType()->castAs<FunctionProtoType>(); 224 llvm::FunctionType *fnType = 225 getTypes().GetFunctionType(*fnInfo, proto->isVariadic()); 226 return cast<llvm::Function>(GetOrCreateLLVMFunction(name, fnType, GD, 227 /*ForVTable=*/false)); 228 } 229 230 void CodeGenModule::EmitCXXDestructors(const CXXDestructorDecl *D) { 231 // The destructor in a virtual table is always a 'deleting' 232 // destructor, which calls the complete destructor and then uses the 233 // appropriate operator delete. 234 if (D->isVirtual()) 235 EmitGlobal(GlobalDecl(D, Dtor_Deleting)); 236 237 // The destructor used for destructing this as a most-derived class; 238 // call the base destructor and then destructs any virtual bases. 239 if (!D->getParent()->isAbstract() || D->isVirtual()) { 240 // We don't need to emit the complete ctor if the class is abstract, 241 // unless the destructor is virtual and needs to be in the vtable. 242 EmitGlobal(GlobalDecl(D, Dtor_Complete)); 243 } 244 245 // The destructor used for destructing this as a base class; ignores 246 // virtual bases. 247 EmitGlobal(GlobalDecl(D, Dtor_Base)); 248 } 249 250 void CodeGenModule::EmitCXXDestructor(const CXXDestructorDecl *dtor, 251 CXXDtorType dtorType) { 252 // The complete destructor is equivalent to the base destructor for 253 // classes with no virtual bases, so try to emit it as an alias. 254 if (dtorType == Dtor_Complete && 255 !dtor->getParent()->getNumVBases() && 256 !TryEmitDefinitionAsAlias(GlobalDecl(dtor, Dtor_Complete), 257 GlobalDecl(dtor, Dtor_Base))) 258 return; 259 260 // The base destructor is equivalent to the base destructor of its 261 // base class if there is exactly one non-virtual base class with a 262 // non-trivial destructor, there are no fields with a non-trivial 263 // destructor, and the body of the destructor is trivial. 264 if (dtorType == Dtor_Base && !TryEmitBaseDestructorAsAlias(dtor)) 265 return; 266 267 const CGFunctionInfo &fnInfo = getTypes().getFunctionInfo(dtor, dtorType); 268 269 llvm::Function *fn = 270 cast<llvm::Function>(GetAddrOfCXXDestructor(dtor, dtorType, &fnInfo)); 271 setFunctionLinkage(dtor, fn); 272 273 CodeGenFunction(*this).GenerateCode(GlobalDecl(dtor, dtorType), fn, fnInfo); 274 275 SetFunctionDefinitionAttributes(dtor, fn); 276 SetLLVMFunctionAttributesForDefinition(dtor, fn); 277 } 278 279 llvm::GlobalValue * 280 CodeGenModule::GetAddrOfCXXDestructor(const CXXDestructorDecl *dtor, 281 CXXDtorType dtorType, 282 const CGFunctionInfo *fnInfo) { 283 GlobalDecl GD(dtor, dtorType); 284 285 llvm::StringRef name = getMangledName(GD); 286 if (llvm::GlobalValue *existing = GetGlobalValue(name)) 287 return existing; 288 289 if (!fnInfo) fnInfo = &getTypes().getFunctionInfo(dtor, dtorType); 290 291 llvm::FunctionType *fnType = 292 getTypes().GetFunctionType(*fnInfo, false); 293 294 return cast<llvm::Function>(GetOrCreateLLVMFunction(name, fnType, GD, 295 /*ForVTable=*/false)); 296 } 297 298 static llvm::Value *BuildVirtualCall(CodeGenFunction &CGF, uint64_t VTableIndex, 299 llvm::Value *This, llvm::Type *Ty) { 300 Ty = Ty->getPointerTo()->getPointerTo(); 301 302 llvm::Value *VTable = CGF.GetVTablePtr(This, Ty); 303 llvm::Value *VFuncPtr = 304 CGF.Builder.CreateConstInBoundsGEP1_64(VTable, VTableIndex, "vfn"); 305 return CGF.Builder.CreateLoad(VFuncPtr); 306 } 307 308 llvm::Value * 309 CodeGenFunction::BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This, 310 llvm::Type *Ty) { 311 MD = MD->getCanonicalDecl(); 312 uint64_t VTableIndex = CGM.getVTables().getMethodVTableIndex(MD); 313 314 return ::BuildVirtualCall(*this, VTableIndex, This, Ty); 315 } 316 317 /// BuildVirtualCall - This routine is to support gcc's kext ABI making 318 /// indirect call to virtual functions. It makes the call through indexing 319 /// into the vtable. 320 llvm::Value * 321 CodeGenFunction::BuildAppleKextVirtualCall(const CXXMethodDecl *MD, 322 NestedNameSpecifier *Qual, 323 llvm::Type *Ty) { 324 llvm::Value *VTable = 0; 325 assert((Qual->getKind() == NestedNameSpecifier::TypeSpec) && 326 "BuildAppleKextVirtualCall - bad Qual kind"); 327 328 const Type *QTy = Qual->getAsType(); 329 QualType T = QualType(QTy, 0); 330 const RecordType *RT = T->getAs<RecordType>(); 331 assert(RT && "BuildAppleKextVirtualCall - Qual type must be record"); 332 const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl()); 333 334 if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD)) 335 return BuildAppleKextVirtualDestructorCall(DD, Dtor_Complete, RD); 336 337 VTable = CGM.getVTables().GetAddrOfVTable(RD); 338 Ty = Ty->getPointerTo()->getPointerTo(); 339 VTable = Builder.CreateBitCast(VTable, Ty); 340 assert(VTable && "BuildVirtualCall = kext vtbl pointer is null"); 341 MD = MD->getCanonicalDecl(); 342 uint64_t VTableIndex = CGM.getVTables().getMethodVTableIndex(MD); 343 uint64_t AddressPoint = 344 CGM.getVTables().getAddressPoint(BaseSubobject(RD, CharUnits::Zero()), RD); 345 VTableIndex += AddressPoint; 346 llvm::Value *VFuncPtr = 347 Builder.CreateConstInBoundsGEP1_64(VTable, VTableIndex, "vfnkxt"); 348 return Builder.CreateLoad(VFuncPtr); 349 } 350 351 /// BuildVirtualCall - This routine makes indirect vtable call for 352 /// call to virtual destructors. It returns 0 if it could not do it. 353 llvm::Value * 354 CodeGenFunction::BuildAppleKextVirtualDestructorCall( 355 const CXXDestructorDecl *DD, 356 CXXDtorType Type, 357 const CXXRecordDecl *RD) { 358 llvm::Value * Callee = 0; 359 const CXXMethodDecl *MD = cast<CXXMethodDecl>(DD); 360 // FIXME. Dtor_Base dtor is always direct!! 361 // It need be somehow inline expanded into the caller. 362 // -O does that. But need to support -O0 as well. 363 if (MD->isVirtual() && Type != Dtor_Base) { 364 // Compute the function type we're calling. 365 const CGFunctionInfo *FInfo = 366 &CGM.getTypes().getFunctionInfo(cast<CXXDestructorDecl>(MD), 367 Dtor_Complete); 368 const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>(); 369 llvm::Type *Ty 370 = CGM.getTypes().GetFunctionType(*FInfo, FPT->isVariadic()); 371 372 llvm::Value *VTable = CGM.getVTables().GetAddrOfVTable(RD); 373 Ty = Ty->getPointerTo()->getPointerTo(); 374 VTable = Builder.CreateBitCast(VTable, Ty); 375 DD = cast<CXXDestructorDecl>(DD->getCanonicalDecl()); 376 uint64_t VTableIndex = 377 CGM.getVTables().getMethodVTableIndex(GlobalDecl(DD, Type)); 378 uint64_t AddressPoint = 379 CGM.getVTables().getAddressPoint(BaseSubobject(RD, CharUnits::Zero()), RD); 380 VTableIndex += AddressPoint; 381 llvm::Value *VFuncPtr = 382 Builder.CreateConstInBoundsGEP1_64(VTable, VTableIndex, "vfnkxt"); 383 Callee = Builder.CreateLoad(VFuncPtr); 384 } 385 return Callee; 386 } 387 388 llvm::Value * 389 CodeGenFunction::BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type, 390 llvm::Value *This, llvm::Type *Ty) { 391 DD = cast<CXXDestructorDecl>(DD->getCanonicalDecl()); 392 uint64_t VTableIndex = 393 CGM.getVTables().getMethodVTableIndex(GlobalDecl(DD, Type)); 394 395 return ::BuildVirtualCall(*this, VTableIndex, This, Ty); 396 } 397 398
