contrib/llvm/tools/clang/lib/CodeGen/CGCXX.cpp

   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   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   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   EmitGlobal(GlobalDecl(D, Dtor_Complete));
 240
 241   // The destructor used for destructing this as a base class; ignores
 242   // virtual bases.
 243   EmitGlobal(GlobalDecl(D, Dtor_Base));
 244 }
 245
 246 void CodeGenModule::EmitCXXDestructor(const CXXDestructorDecl *dtor,
 247                                       CXXDtorType dtorType) {
 248   // The complete destructor is equivalent to the base destructor for
 249   // classes with no virtual bases, so try to emit it as an alias.
 250   if (dtorType == Dtor_Complete &&
 251       !dtor->getParent()->getNumVBases() &&
 252       !TryEmitDefinitionAsAlias(GlobalDecl(dtor, Dtor_Complete),
 253                                 GlobalDecl(dtor, Dtor_Base)))
 254     return;
 255
 256   // The base destructor is equivalent to the base destructor of its
 257   // base class if there is exactly one non-virtual base class with a
 258   // non-trivial destructor, there are no fields with a non-trivial
 259   // destructor, and the body of the destructor is trivial.
 260   if (dtorType == Dtor_Base && !TryEmitBaseDestructorAsAlias(dtor))
 261     return;
 262
 263   const CGFunctionInfo &fnInfo = getTypes().getFunctionInfo(dtor, dtorType);
 264
 265   llvm::Function *fn =
 266     cast<llvm::Function>(GetAddrOfCXXDestructor(dtor, dtorType, &fnInfo));
 267   setFunctionLinkage(dtor, fn);
 268
 269   CodeGenFunction(*this).GenerateCode(GlobalDecl(dtor, dtorType), fn, fnInfo);
 270
 271   SetFunctionDefinitionAttributes(dtor, fn);
 272   SetLLVMFunctionAttributesForDefinition(dtor, fn);
 273 }
 274
 275 llvm::GlobalValue *
 276 CodeGenModule::GetAddrOfCXXDestructor(const CXXDestructorDecl *dtor,
 277                                       CXXDtorType dtorType,
 278                                       const CGFunctionInfo *fnInfo) {
 279   GlobalDecl GD(dtor, dtorType);
 280
 281   StringRef name = getMangledName(GD);
 282   if (llvm::GlobalValue *existing = GetGlobalValue(name))
 283     return existing;
 284
 285   if (!fnInfo) fnInfo = &getTypes().getFunctionInfo(dtor, dtorType);
 286
 287   llvm::FunctionType *fnType =
 288     getTypes().GetFunctionType(*fnInfo, false);
 289
 290   return cast<llvm::Function>(GetOrCreateLLVMFunction(name, fnType, GD,
 291                                                       /*ForVTable=*/false));
 292 }
 293
 294 static llvm::Value *BuildVirtualCall(CodeGenFunction &CGF, uint64_t VTableIndex,
 295                                      llvm::Value *This, llvm::Type *Ty) {
 296   Ty = Ty->getPointerTo()->getPointerTo();
 297
 298   llvm::Value *VTable = CGF.GetVTablePtr(This, Ty);
 299   llvm::Value *VFuncPtr =
 300     CGF.Builder.CreateConstInBoundsGEP1_64(VTable, VTableIndex, "vfn");
 301   return CGF.Builder.CreateLoad(VFuncPtr);
 302 }
 303
 304 llvm::Value *
 305 CodeGenFunction::BuildVirtualCall(const CXXMethodDecl *MD, llvm::Value *This,
 306                                   llvm::Type *Ty) {
 307   MD = MD->getCanonicalDecl();
 308   uint64_t VTableIndex = CGM.getVTableContext().getMethodVTableIndex(MD);
 309
 310   return ::BuildVirtualCall(*this, VTableIndex, This, Ty);
 311 }
 312
 313 /// BuildVirtualCall - This routine is to support gcc's kext ABI making
 314 /// indirect call to virtual functions. It makes the call through indexing
 315 /// into the vtable.
 316 llvm::Value *
 317 CodeGenFunction::BuildAppleKextVirtualCall(const CXXMethodDecl *MD,
 318                                   NestedNameSpecifier *Qual,
 319                                   llvm::Type *Ty) {
 320   llvm::Value *VTable = 0;
 321   assert((Qual->getKind() == NestedNameSpecifier::TypeSpec) &&
 322          "BuildAppleKextVirtualCall - bad Qual kind");
 323
 324   const Type *QTy = Qual->getAsType();
 325   QualType T = QualType(QTy, 0);
 326   const RecordType *RT = T->getAs<RecordType>();
 327   assert(RT && "BuildAppleKextVirtualCall - Qual type must be record");
 328   const CXXRecordDecl *RD = cast<CXXRecordDecl>(RT->getDecl());
 329
 330   if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD))
 331     return BuildAppleKextVirtualDestructorCall(DD, Dtor_Complete, RD);
 332
 333   VTable = CGM.getVTables().GetAddrOfVTable(RD);
 334   Ty = Ty->getPointerTo()->getPointerTo();
 335   VTable = Builder.CreateBitCast(VTable, Ty);
 336   assert(VTable && "BuildVirtualCall = kext vtbl pointer is null");
 337   MD = MD->getCanonicalDecl();
 338   uint64_t VTableIndex = CGM.getVTableContext().getMethodVTableIndex(MD);
 339   uint64_t AddressPoint =
 340     CGM.getVTableContext().getVTableLayout(RD)
 341        .getAddressPoint(BaseSubobject(RD, CharUnits::Zero()));
 342   VTableIndex += AddressPoint;
 343   llvm::Value *VFuncPtr =
 344     Builder.CreateConstInBoundsGEP1_64(VTable, VTableIndex, "vfnkxt");
 345   return Builder.CreateLoad(VFuncPtr);
 346 }
 347
 348 /// BuildVirtualCall - This routine makes indirect vtable call for
 349 /// call to virtual destructors. It returns 0 if it could not do it.
 350 llvm::Value *
 351 CodeGenFunction::BuildAppleKextVirtualDestructorCall(
 352                                             const CXXDestructorDecl *DD,
 353                                             CXXDtorType Type,
 354                                             const CXXRecordDecl *RD) {
 355   llvm::Value * Callee = 0;
 356   const CXXMethodDecl *MD = cast<CXXMethodDecl>(DD);
 357   // FIXME. Dtor_Base dtor is always direct!!
 358   // It need be somehow inline expanded into the caller.
 359   // -O does that. But need to support -O0 as well.
 360   if (MD->isVirtual() && Type != Dtor_Base) {
 361     // Compute the function type we're calling.
 362     const CGFunctionInfo *FInfo =
 363     &CGM.getTypes().getFunctionInfo(cast<CXXDestructorDecl>(MD),
 364                                     Dtor_Complete);
 365     const FunctionProtoType *FPT = MD->getType()->getAs<FunctionProtoType>();
 366     llvm::Type *Ty
 367       = CGM.getTypes().GetFunctionType(*FInfo, FPT->isVariadic());
 368
 369     llvm::Value *VTable = CGM.getVTables().GetAddrOfVTable(RD);
 370     Ty = Ty->getPointerTo()->getPointerTo();
 371     VTable = Builder.CreateBitCast(VTable, Ty);
 372     DD = cast<CXXDestructorDecl>(DD->getCanonicalDecl());
 373     uint64_t VTableIndex =
 374       CGM.getVTableContext().getMethodVTableIndex(GlobalDecl(DD, Type));
 375     uint64_t AddressPoint =
 376       CGM.getVTableContext().getVTableLayout(RD)
 377          .getAddressPoint(BaseSubobject(RD, CharUnits::Zero()));
 378     VTableIndex += AddressPoint;
 379     llvm::Value *VFuncPtr =
 380       Builder.CreateConstInBoundsGEP1_64(VTable, VTableIndex, "vfnkxt");
 381     Callee = Builder.CreateLoad(VFuncPtr);
 382   }
 383   return Callee;
 384 }
 385
 386 llvm::Value *
 387 CodeGenFunction::BuildVirtualCall(const CXXDestructorDecl *DD, CXXDtorType Type,
 388                                   llvm::Value *This, llvm::Type *Ty) {
 389   DD = cast<CXXDestructorDecl>(DD->getCanonicalDecl());
 390   uint64_t VTableIndex =
 391     CGM.getVTableContext().getMethodVTableIndex(GlobalDecl(DD, Type));
 392
 393   return ::BuildVirtualCall(*this, VTableIndex, This, Ty);
 394 }
 395