1 //===--- CGVTables.cpp - Emit LLVM Code for C++ vtables -------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This contains code dealing with C++ code generation of virtual tables.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "CGCXXABI.h"
14 #include "CodeGenFunction.h"
15 #include "CodeGenModule.h"
16 #include "clang/AST/Attr.h"
17 #include "clang/AST/CXXInheritance.h"
18 #include "clang/AST/RecordLayout.h"
19 #include "clang/Basic/CodeGenOptions.h"
20 #include "clang/CodeGen/CGFunctionInfo.h"
21 #include "clang/CodeGen/ConstantInitBuilder.h"
22 #include "llvm/IR/IntrinsicInst.h"
23 #include "llvm/Support/Format.h"
24 #include "llvm/Transforms/Utils/Cloning.h"
25 #include <algorithm>
26 #include <cstdio>
27 
28 using namespace clang;
29 using namespace CodeGen;
30 
31 CodeGenVTables::CodeGenVTables(CodeGenModule &CGM)
32     : CGM(CGM), VTContext(CGM.getContext().getVTableContext()) {}
33 
34 llvm::Constant *CodeGenModule::GetAddrOfThunk(StringRef Name, llvm::Type *FnTy,
35                                               GlobalDecl GD) {
36   return GetOrCreateLLVMFunction(Name, FnTy, GD, /*ForVTable=*/true,
37                                  /*DontDefer=*/true, /*IsThunk=*/true);
38 }
39 
40 static void setThunkProperties(CodeGenModule &CGM, const ThunkInfo &Thunk,
41                                llvm::Function *ThunkFn, bool ForVTable,
42                                GlobalDecl GD) {
43   CGM.setFunctionLinkage(GD, ThunkFn);
44   CGM.getCXXABI().setThunkLinkage(ThunkFn, ForVTable, GD,
45                                   !Thunk.Return.isEmpty());
46 
47   // Set the right visibility.
48   CGM.setGVProperties(ThunkFn, GD);
49 
50   if (!CGM.getCXXABI().exportThunk()) {
51     ThunkFn->setDLLStorageClass(llvm::GlobalValue::DefaultStorageClass);
52     ThunkFn->setDSOLocal(true);
53   }
54 
55   if (CGM.supportsCOMDAT() && ThunkFn->isWeakForLinker())
56     ThunkFn->setComdat(CGM.getModule().getOrInsertComdat(ThunkFn->getName()));
57 }
58 
59 #ifndef NDEBUG
60 static bool similar(const ABIArgInfo &infoL, CanQualType typeL,
61                     const ABIArgInfo &infoR, CanQualType typeR) {
62   return (infoL.getKind() == infoR.getKind() &&
63           (typeL == typeR ||
64            (isa<PointerType>(typeL) && isa<PointerType>(typeR)) ||
65            (isa<ReferenceType>(typeL) && isa<ReferenceType>(typeR))));
66 }
67 #endif
68 
69 static RValue PerformReturnAdjustment(CodeGenFunction &CGF,
70                                       QualType ResultType, RValue RV,
71                                       const ThunkInfo &Thunk) {
72   // Emit the return adjustment.
73   bool NullCheckValue = !ResultType->isReferenceType();
74 
75   llvm::BasicBlock *AdjustNull = nullptr;
76   llvm::BasicBlock *AdjustNotNull = nullptr;
77   llvm::BasicBlock *AdjustEnd = nullptr;
78 
79   llvm::Value *ReturnValue = RV.getScalarVal();
80 
81   if (NullCheckValue) {
82     AdjustNull = CGF.createBasicBlock("adjust.null");
83     AdjustNotNull = CGF.createBasicBlock("adjust.notnull");
84     AdjustEnd = CGF.createBasicBlock("adjust.end");
85 
86     llvm::Value *IsNull = CGF.Builder.CreateIsNull(ReturnValue);
87     CGF.Builder.CreateCondBr(IsNull, AdjustNull, AdjustNotNull);
88     CGF.EmitBlock(AdjustNotNull);
89   }
90 
91   auto ClassDecl = ResultType->getPointeeType()->getAsCXXRecordDecl();
92   auto ClassAlign = CGF.CGM.getClassPointerAlignment(ClassDecl);
93   ReturnValue = CGF.CGM.getCXXABI().performReturnAdjustment(CGF,
94                                             Address(ReturnValue, ClassAlign),
95                                             Thunk.Return);
96 
97   if (NullCheckValue) {
98     CGF.Builder.CreateBr(AdjustEnd);
99     CGF.EmitBlock(AdjustNull);
100     CGF.Builder.CreateBr(AdjustEnd);
101     CGF.EmitBlock(AdjustEnd);
102 
103     llvm::PHINode *PHI = CGF.Builder.CreatePHI(ReturnValue->getType(), 2);
104     PHI->addIncoming(ReturnValue, AdjustNotNull);
105     PHI->addIncoming(llvm::Constant::getNullValue(ReturnValue->getType()),
106                      AdjustNull);
107     ReturnValue = PHI;
108   }
109 
110   return RValue::get(ReturnValue);
111 }
112 
113 /// This function clones a function's DISubprogram node and enters it into
114 /// a value map with the intent that the map can be utilized by the cloner
115 /// to short-circuit Metadata node mapping.
116 /// Furthermore, the function resolves any DILocalVariable nodes referenced
117 /// by dbg.value intrinsics so they can be properly mapped during cloning.
118 static void resolveTopLevelMetadata(llvm::Function *Fn,
119                                     llvm::ValueToValueMapTy &VMap) {
120   // Clone the DISubprogram node and put it into the Value map.
121   auto *DIS = Fn->getSubprogram();
122   if (!DIS)
123     return;
124   auto *NewDIS = DIS->replaceWithDistinct(DIS->clone());
125   VMap.MD()[DIS].reset(NewDIS);
126 
127   // Find all llvm.dbg.declare intrinsics and resolve the DILocalVariable nodes
128   // they are referencing.
129   for (auto &BB : Fn->getBasicBlockList()) {
130     for (auto &I : BB) {
131       if (auto *DII = dyn_cast<llvm::DbgVariableIntrinsic>(&I)) {
132         auto *DILocal = DII->getVariable();
133         if (!DILocal->isResolved())
134           DILocal->resolve();
135       }
136     }
137   }
138 }
139 
140 // This function does roughly the same thing as GenerateThunk, but in a
141 // very different way, so that va_start and va_end work correctly.
142 // FIXME: This function assumes "this" is the first non-sret LLVM argument of
143 //        a function, and that there is an alloca built in the entry block
144 //        for all accesses to "this".
145 // FIXME: This function assumes there is only one "ret" statement per function.
146 // FIXME: Cloning isn't correct in the presence of indirect goto!
147 // FIXME: This implementation of thunks bloats codesize by duplicating the
148 //        function definition.  There are alternatives:
149 //        1. Add some sort of stub support to LLVM for cases where we can
150 //           do a this adjustment, then a sibcall.
151 //        2. We could transform the definition to take a va_list instead of an
152 //           actual variable argument list, then have the thunks (including a
153 //           no-op thunk for the regular definition) call va_start/va_end.
154 //           There's a bit of per-call overhead for this solution, but it's
155 //           better for codesize if the definition is long.
156 llvm::Function *
157 CodeGenFunction::GenerateVarArgsThunk(llvm::Function *Fn,
158                                       const CGFunctionInfo &FnInfo,
159                                       GlobalDecl GD, const ThunkInfo &Thunk) {
160   const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
161   const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
162   QualType ResultType = FPT->getReturnType();
163 
164   // Get the original function
165   assert(FnInfo.isVariadic());
166   llvm::Type *Ty = CGM.getTypes().GetFunctionType(FnInfo);
167   llvm::Value *Callee = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
168   llvm::Function *BaseFn = cast<llvm::Function>(Callee);
169 
170   // Cloning can't work if we don't have a definition. The Microsoft ABI may
171   // require thunks when a definition is not available. Emit an error in these
172   // cases.
173   if (!MD->isDefined()) {
174     CGM.ErrorUnsupported(MD, "return-adjusting thunk with variadic arguments");
175     return Fn;
176   }
177   assert(!BaseFn->isDeclaration() && "cannot clone undefined variadic method");
178 
179   // Clone to thunk.
180   llvm::ValueToValueMapTy VMap;
181 
182   // We are cloning a function while some Metadata nodes are still unresolved.
183   // Ensure that the value mapper does not encounter any of them.
184   resolveTopLevelMetadata(BaseFn, VMap);
185   llvm::Function *NewFn = llvm::CloneFunction(BaseFn, VMap);
186   Fn->replaceAllUsesWith(NewFn);
187   NewFn->takeName(Fn);
188   Fn->eraseFromParent();
189   Fn = NewFn;
190 
191   // "Initialize" CGF (minimally).
192   CurFn = Fn;
193 
194   // Get the "this" value
195   llvm::Function::arg_iterator AI = Fn->arg_begin();
196   if (CGM.ReturnTypeUsesSRet(FnInfo))
197     ++AI;
198 
199   // Find the first store of "this", which will be to the alloca associated
200   // with "this".
201   Address ThisPtr(&*AI, CGM.getClassPointerAlignment(MD->getParent()));
202   llvm::BasicBlock *EntryBB = &Fn->front();
203   llvm::BasicBlock::iterator ThisStore =
204       std::find_if(EntryBB->begin(), EntryBB->end(), [&](llvm::Instruction &I) {
205         return isa<llvm::StoreInst>(I) &&
206                I.getOperand(0) == ThisPtr.getPointer();
207       });
208   assert(ThisStore != EntryBB->end() &&
209          "Store of this should be in entry block?");
210   // Adjust "this", if necessary.
211   Builder.SetInsertPoint(&*ThisStore);
212   llvm::Value *AdjustedThisPtr =
213       CGM.getCXXABI().performThisAdjustment(*this, ThisPtr, Thunk.This);
214   AdjustedThisPtr = Builder.CreateBitCast(AdjustedThisPtr,
215                                           ThisStore->getOperand(0)->getType());
216   ThisStore->setOperand(0, AdjustedThisPtr);
217 
218   if (!Thunk.Return.isEmpty()) {
219     // Fix up the returned value, if necessary.
220     for (llvm::BasicBlock &BB : *Fn) {
221       llvm::Instruction *T = BB.getTerminator();
222       if (isa<llvm::ReturnInst>(T)) {
223         RValue RV = RValue::get(T->getOperand(0));
224         T->eraseFromParent();
225         Builder.SetInsertPoint(&BB);
226         RV = PerformReturnAdjustment(*this, ResultType, RV, Thunk);
227         Builder.CreateRet(RV.getScalarVal());
228         break;
229       }
230     }
231   }
232 
233   return Fn;
234 }
235 
236 void CodeGenFunction::StartThunk(llvm::Function *Fn, GlobalDecl GD,
237                                  const CGFunctionInfo &FnInfo,
238                                  bool IsUnprototyped) {
239   assert(!CurGD.getDecl() && "CurGD was already set!");
240   CurGD = GD;
241   CurFuncIsThunk = true;
242 
243   // Build FunctionArgs.
244   const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
245   QualType ThisType = MD->getThisType();
246   QualType ResultType;
247   if (IsUnprototyped)
248     ResultType = CGM.getContext().VoidTy;
249   else if (CGM.getCXXABI().HasThisReturn(GD))
250     ResultType = ThisType;
251   else if (CGM.getCXXABI().hasMostDerivedReturn(GD))
252     ResultType = CGM.getContext().VoidPtrTy;
253   else
254     ResultType = MD->getType()->castAs<FunctionProtoType>()->getReturnType();
255   FunctionArgList FunctionArgs;
256 
257   // Create the implicit 'this' parameter declaration.
258   CGM.getCXXABI().buildThisParam(*this, FunctionArgs);
259 
260   // Add the rest of the parameters, if we have a prototype to work with.
261   if (!IsUnprototyped) {
262     FunctionArgs.append(MD->param_begin(), MD->param_end());
263 
264     if (isa<CXXDestructorDecl>(MD))
265       CGM.getCXXABI().addImplicitStructorParams(*this, ResultType,
266                                                 FunctionArgs);
267   }
268 
269   // Start defining the function.
270   auto NL = ApplyDebugLocation::CreateEmpty(*this);
271   StartFunction(GlobalDecl(), ResultType, Fn, FnInfo, FunctionArgs,
272                 MD->getLocation());
273   // Create a scope with an artificial location for the body of this function.
274   auto AL = ApplyDebugLocation::CreateArtificial(*this);
275 
276   // Since we didn't pass a GlobalDecl to StartFunction, do this ourselves.
277   CGM.getCXXABI().EmitInstanceFunctionProlog(*this);
278   CXXThisValue = CXXABIThisValue;
279   CurCodeDecl = MD;
280   CurFuncDecl = MD;
281 }
282 
283 void CodeGenFunction::FinishThunk() {
284   // Clear these to restore the invariants expected by
285   // StartFunction/FinishFunction.
286   CurCodeDecl = nullptr;
287   CurFuncDecl = nullptr;
288 
289   FinishFunction();
290 }
291 
292 void CodeGenFunction::EmitCallAndReturnForThunk(llvm::FunctionCallee Callee,
293                                                 const ThunkInfo *Thunk,
294                                                 bool IsUnprototyped) {
295   assert(isa<CXXMethodDecl>(CurGD.getDecl()) &&
296          "Please use a new CGF for this thunk");
297   const CXXMethodDecl *MD = cast<CXXMethodDecl>(CurGD.getDecl());
298 
299   // Adjust the 'this' pointer if necessary
300   llvm::Value *AdjustedThisPtr =
301     Thunk ? CGM.getCXXABI().performThisAdjustment(
302                           *this, LoadCXXThisAddress(), Thunk->This)
303           : LoadCXXThis();
304 
305   // If perfect forwarding is required a variadic method, a method using
306   // inalloca, or an unprototyped thunk, use musttail. Emit an error if this
307   // thunk requires a return adjustment, since that is impossible with musttail.
308   if (CurFnInfo->usesInAlloca() || CurFnInfo->isVariadic() || IsUnprototyped) {
309     if (Thunk && !Thunk->Return.isEmpty()) {
310       if (IsUnprototyped)
311         CGM.ErrorUnsupported(
312             MD, "return-adjusting thunk with incomplete parameter type");
313       else if (CurFnInfo->isVariadic())
314         llvm_unreachable("shouldn't try to emit musttail return-adjusting "
315                          "thunks for variadic functions");
316       else
317         CGM.ErrorUnsupported(
318             MD, "non-trivial argument copy for return-adjusting thunk");
319     }
320     EmitMustTailThunk(CurGD, AdjustedThisPtr, Callee);
321     return;
322   }
323 
324   // Start building CallArgs.
325   CallArgList CallArgs;
326   QualType ThisType = MD->getThisType();
327   CallArgs.add(RValue::get(AdjustedThisPtr), ThisType);
328 
329   if (isa<CXXDestructorDecl>(MD))
330     CGM.getCXXABI().adjustCallArgsForDestructorThunk(*this, CurGD, CallArgs);
331 
332 #ifndef NDEBUG
333   unsigned PrefixArgs = CallArgs.size() - 1;
334 #endif
335   // Add the rest of the arguments.
336   for (const ParmVarDecl *PD : MD->parameters())
337     EmitDelegateCallArg(CallArgs, PD, SourceLocation());
338 
339   const FunctionProtoType *FPT = MD->getType()->castAs<FunctionProtoType>();
340 
341 #ifndef NDEBUG
342   const CGFunctionInfo &CallFnInfo = CGM.getTypes().arrangeCXXMethodCall(
343       CallArgs, FPT, RequiredArgs::forPrototypePlus(FPT, 1), PrefixArgs);
344   assert(CallFnInfo.getRegParm() == CurFnInfo->getRegParm() &&
345          CallFnInfo.isNoReturn() == CurFnInfo->isNoReturn() &&
346          CallFnInfo.getCallingConvention() == CurFnInfo->getCallingConvention());
347   assert(isa<CXXDestructorDecl>(MD) || // ignore dtor return types
348          similar(CallFnInfo.getReturnInfo(), CallFnInfo.getReturnType(),
349                  CurFnInfo->getReturnInfo(), CurFnInfo->getReturnType()));
350   assert(CallFnInfo.arg_size() == CurFnInfo->arg_size());
351   for (unsigned i = 0, e = CurFnInfo->arg_size(); i != e; ++i)
352     assert(similar(CallFnInfo.arg_begin()[i].info,
353                    CallFnInfo.arg_begin()[i].type,
354                    CurFnInfo->arg_begin()[i].info,
355                    CurFnInfo->arg_begin()[i].type));
356 #endif
357 
358   // Determine whether we have a return value slot to use.
359   QualType ResultType = CGM.getCXXABI().HasThisReturn(CurGD)
360                             ? ThisType
361                             : CGM.getCXXABI().hasMostDerivedReturn(CurGD)
362                                   ? CGM.getContext().VoidPtrTy
363                                   : FPT->getReturnType();
364   ReturnValueSlot Slot;
365   if (!ResultType->isVoidType() &&
366       CurFnInfo->getReturnInfo().getKind() == ABIArgInfo::Indirect)
367     Slot = ReturnValueSlot(ReturnValue, ResultType.isVolatileQualified(),
368                            /*IsUnused=*/false, /*IsExternallyDestructed=*/true);
369 
370   // Now emit our call.
371   llvm::CallBase *CallOrInvoke;
372   RValue RV = EmitCall(*CurFnInfo, CGCallee::forDirect(Callee, CurGD), Slot,
373                        CallArgs, &CallOrInvoke);
374 
375   // Consider return adjustment if we have ThunkInfo.
376   if (Thunk && !Thunk->Return.isEmpty())
377     RV = PerformReturnAdjustment(*this, ResultType, RV, *Thunk);
378   else if (llvm::CallInst* Call = dyn_cast<llvm::CallInst>(CallOrInvoke))
379     Call->setTailCallKind(llvm::CallInst::TCK_Tail);
380 
381   // Emit return.
382   if (!ResultType->isVoidType() && Slot.isNull())
383     CGM.getCXXABI().EmitReturnFromThunk(*this, RV, ResultType);
384 
385   // Disable the final ARC autorelease.
386   AutoreleaseResult = false;
387 
388   FinishThunk();
389 }
390 
391 void CodeGenFunction::EmitMustTailThunk(GlobalDecl GD,
392                                         llvm::Value *AdjustedThisPtr,
393                                         llvm::FunctionCallee Callee) {
394   // Emitting a musttail call thunk doesn't use any of the CGCall.cpp machinery
395   // to translate AST arguments into LLVM IR arguments.  For thunks, we know
396   // that the caller prototype more or less matches the callee prototype with
397   // the exception of 'this'.
398   SmallVector<llvm::Value *, 8> Args;
399   for (llvm::Argument &A : CurFn->args())
400     Args.push_back(&A);
401 
402   // Set the adjusted 'this' pointer.
403   const ABIArgInfo &ThisAI = CurFnInfo->arg_begin()->info;
404   if (ThisAI.isDirect()) {
405     const ABIArgInfo &RetAI = CurFnInfo->getReturnInfo();
406     int ThisArgNo = RetAI.isIndirect() && !RetAI.isSRetAfterThis() ? 1 : 0;
407     llvm::Type *ThisType = Args[ThisArgNo]->getType();
408     if (ThisType != AdjustedThisPtr->getType())
409       AdjustedThisPtr = Builder.CreateBitCast(AdjustedThisPtr, ThisType);
410     Args[ThisArgNo] = AdjustedThisPtr;
411   } else {
412     assert(ThisAI.isInAlloca() && "this is passed directly or inalloca");
413     Address ThisAddr = GetAddrOfLocalVar(CXXABIThisDecl);
414     llvm::Type *ThisType = ThisAddr.getElementType();
415     if (ThisType != AdjustedThisPtr->getType())
416       AdjustedThisPtr = Builder.CreateBitCast(AdjustedThisPtr, ThisType);
417     Builder.CreateStore(AdjustedThisPtr, ThisAddr);
418   }
419 
420   // Emit the musttail call manually.  Even if the prologue pushed cleanups, we
421   // don't actually want to run them.
422   llvm::CallInst *Call = Builder.CreateCall(Callee, Args);
423   Call->setTailCallKind(llvm::CallInst::TCK_MustTail);
424 
425   // Apply the standard set of call attributes.
426   unsigned CallingConv;
427   llvm::AttributeList Attrs;
428   CGM.ConstructAttributeList(Callee.getCallee()->getName(), *CurFnInfo, GD,
429                              Attrs, CallingConv, /*AttrOnCallSite=*/true);
430   Call->setAttributes(Attrs);
431   Call->setCallingConv(static_cast<llvm::CallingConv::ID>(CallingConv));
432 
433   if (Call->getType()->isVoidTy())
434     Builder.CreateRetVoid();
435   else
436     Builder.CreateRet(Call);
437 
438   // Finish the function to maintain CodeGenFunction invariants.
439   // FIXME: Don't emit unreachable code.
440   EmitBlock(createBasicBlock());
441 
442   FinishThunk();
443 }
444 
445 void CodeGenFunction::generateThunk(llvm::Function *Fn,
446                                     const CGFunctionInfo &FnInfo, GlobalDecl GD,
447                                     const ThunkInfo &Thunk,
448                                     bool IsUnprototyped) {
449   StartThunk(Fn, GD, FnInfo, IsUnprototyped);
450   // Create a scope with an artificial location for the body of this function.
451   auto AL = ApplyDebugLocation::CreateArtificial(*this);
452 
453   // Get our callee. Use a placeholder type if this method is unprototyped so
454   // that CodeGenModule doesn't try to set attributes.
455   llvm::Type *Ty;
456   if (IsUnprototyped)
457     Ty = llvm::StructType::get(getLLVMContext());
458   else
459     Ty = CGM.getTypes().GetFunctionType(FnInfo);
460 
461   llvm::Constant *Callee = CGM.GetAddrOfFunction(GD, Ty, /*ForVTable=*/true);
462 
463   // Fix up the function type for an unprototyped musttail call.
464   if (IsUnprototyped)
465     Callee = llvm::ConstantExpr::getBitCast(Callee, Fn->getType());
466 
467   // Make the call and return the result.
468   EmitCallAndReturnForThunk(llvm::FunctionCallee(Fn->getFunctionType(), Callee),
469                             &Thunk, IsUnprototyped);
470 }
471 
472 static bool shouldEmitVTableThunk(CodeGenModule &CGM, const CXXMethodDecl *MD,
473                                   bool IsUnprototyped, bool ForVTable) {
474   // Always emit thunks in the MS C++ ABI. We cannot rely on other TUs to
475   // provide thunks for us.
476   if (CGM.getTarget().getCXXABI().isMicrosoft())
477     return true;
478 
479   // In the Itanium C++ ABI, vtable thunks are provided by TUs that provide
480   // definitions of the main method. Therefore, emitting thunks with the vtable
481   // is purely an optimization. Emit the thunk if optimizations are enabled and
482   // all of the parameter types are complete.
483   if (ForVTable)
484     return CGM.getCodeGenOpts().OptimizationLevel && !IsUnprototyped;
485 
486   // Always emit thunks along with the method definition.
487   return true;
488 }
489 
490 llvm::Constant *CodeGenVTables::maybeEmitThunk(GlobalDecl GD,
491                                                const ThunkInfo &TI,
492                                                bool ForVTable) {
493   const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
494 
495   // First, get a declaration. Compute the mangled name. Don't worry about
496   // getting the function prototype right, since we may only need this
497   // declaration to fill in a vtable slot.
498   SmallString<256> Name;
499   MangleContext &MCtx = CGM.getCXXABI().getMangleContext();
500   llvm::raw_svector_ostream Out(Name);
501   if (const CXXDestructorDecl *DD = dyn_cast<CXXDestructorDecl>(MD))
502     MCtx.mangleCXXDtorThunk(DD, GD.getDtorType(), TI.This, Out);
503   else
504     MCtx.mangleThunk(MD, TI, Out);
505   llvm::Type *ThunkVTableTy = CGM.getTypes().GetFunctionTypeForVTable(GD);
506   llvm::Constant *Thunk = CGM.GetAddrOfThunk(Name, ThunkVTableTy, GD);
507 
508   // If we don't need to emit a definition, return this declaration as is.
509   bool IsUnprototyped = !CGM.getTypes().isFuncTypeConvertible(
510       MD->getType()->castAs<FunctionType>());
511   if (!shouldEmitVTableThunk(CGM, MD, IsUnprototyped, ForVTable))
512     return Thunk;
513 
514   // Arrange a function prototype appropriate for a function definition. In some
515   // cases in the MS ABI, we may need to build an unprototyped musttail thunk.
516   const CGFunctionInfo &FnInfo =
517       IsUnprototyped ? CGM.getTypes().arrangeUnprototypedMustTailThunk(MD)
518                      : CGM.getTypes().arrangeGlobalDeclaration(GD);
519   llvm::FunctionType *ThunkFnTy = CGM.getTypes().GetFunctionType(FnInfo);
520 
521   // If the type of the underlying GlobalValue is wrong, we'll have to replace
522   // it. It should be a declaration.
523   llvm::Function *ThunkFn = cast<llvm::Function>(Thunk->stripPointerCasts());
524   if (ThunkFn->getFunctionType() != ThunkFnTy) {
525     llvm::GlobalValue *OldThunkFn = ThunkFn;
526 
527     assert(OldThunkFn->isDeclaration() && "Shouldn't replace non-declaration");
528 
529     // Remove the name from the old thunk function and get a new thunk.
530     OldThunkFn->setName(StringRef());
531     ThunkFn = llvm::Function::Create(ThunkFnTy, llvm::Function::ExternalLinkage,
532                                      Name.str(), &CGM.getModule());
533     CGM.SetLLVMFunctionAttributes(MD, FnInfo, ThunkFn);
534 
535     // If needed, replace the old thunk with a bitcast.
536     if (!OldThunkFn->use_empty()) {
537       llvm::Constant *NewPtrForOldDecl =
538           llvm::ConstantExpr::getBitCast(ThunkFn, OldThunkFn->getType());
539       OldThunkFn->replaceAllUsesWith(NewPtrForOldDecl);
540     }
541 
542     // Remove the old thunk.
543     OldThunkFn->eraseFromParent();
544   }
545 
546   bool ABIHasKeyFunctions = CGM.getTarget().getCXXABI().hasKeyFunctions();
547   bool UseAvailableExternallyLinkage = ForVTable && ABIHasKeyFunctions;
548 
549   if (!ThunkFn->isDeclaration()) {
550     if (!ABIHasKeyFunctions || UseAvailableExternallyLinkage) {
551       // There is already a thunk emitted for this function, do nothing.
552       return ThunkFn;
553     }
554 
555     setThunkProperties(CGM, TI, ThunkFn, ForVTable, GD);
556     return ThunkFn;
557   }
558 
559   // If this will be unprototyped, add the "thunk" attribute so that LLVM knows
560   // that the return type is meaningless. These thunks can be used to call
561   // functions with differing return types, and the caller is required to cast
562   // the prototype appropriately to extract the correct value.
563   if (IsUnprototyped)
564     ThunkFn->addFnAttr("thunk");
565 
566   CGM.SetLLVMFunctionAttributesForDefinition(GD.getDecl(), ThunkFn);
567 
568   // Thunks for variadic methods are special because in general variadic
569   // arguments cannot be perfectly forwarded. In the general case, clang
570   // implements such thunks by cloning the original function body. However, for
571   // thunks with no return adjustment on targets that support musttail, we can
572   // use musttail to perfectly forward the variadic arguments.
573   bool ShouldCloneVarArgs = false;
574   if (!IsUnprototyped && ThunkFn->isVarArg()) {
575     ShouldCloneVarArgs = true;
576     if (TI.Return.isEmpty()) {
577       switch (CGM.getTriple().getArch()) {
578       case llvm::Triple::x86_64:
579       case llvm::Triple::x86:
580       case llvm::Triple::aarch64:
581         ShouldCloneVarArgs = false;
582         break;
583       default:
584         break;
585       }
586     }
587   }
588 
589   if (ShouldCloneVarArgs) {
590     if (UseAvailableExternallyLinkage)
591       return ThunkFn;
592     ThunkFn =
593         CodeGenFunction(CGM).GenerateVarArgsThunk(ThunkFn, FnInfo, GD, TI);
594   } else {
595     // Normal thunk body generation.
596     CodeGenFunction(CGM).generateThunk(ThunkFn, FnInfo, GD, TI, IsUnprototyped);
597   }
598 
599   setThunkProperties(CGM, TI, ThunkFn, ForVTable, GD);
600   return ThunkFn;
601 }
602 
603 void CodeGenVTables::EmitThunks(GlobalDecl GD) {
604   const CXXMethodDecl *MD =
605     cast<CXXMethodDecl>(GD.getDecl())->getCanonicalDecl();
606 
607   // We don't need to generate thunks for the base destructor.
608   if (isa<CXXDestructorDecl>(MD) && GD.getDtorType() == Dtor_Base)
609     return;
610 
611   const VTableContextBase::ThunkInfoVectorTy *ThunkInfoVector =
612       VTContext->getThunkInfo(GD);
613 
614   if (!ThunkInfoVector)
615     return;
616 
617   for (const ThunkInfo& Thunk : *ThunkInfoVector)
618     maybeEmitThunk(GD, Thunk, /*ForVTable=*/false);
619 }
620 
621 void CodeGenVTables::addVTableComponent(
622     ConstantArrayBuilder &builder, const VTableLayout &layout,
623     unsigned idx, llvm::Constant *rtti, unsigned &nextVTableThunkIndex) {
624   auto &component = layout.vtable_components()[idx];
625 
626   auto addOffsetConstant = [&](CharUnits offset) {
627     builder.add(llvm::ConstantExpr::getIntToPtr(
628         llvm::ConstantInt::get(CGM.PtrDiffTy, offset.getQuantity()),
629         CGM.Int8PtrTy));
630   };
631 
632   switch (component.getKind()) {
633   case VTableComponent::CK_VCallOffset:
634     return addOffsetConstant(component.getVCallOffset());
635 
636   case VTableComponent::CK_VBaseOffset:
637     return addOffsetConstant(component.getVBaseOffset());
638 
639   case VTableComponent::CK_OffsetToTop:
640     return addOffsetConstant(component.getOffsetToTop());
641 
642   case VTableComponent::CK_RTTI:
643     return builder.add(llvm::ConstantExpr::getBitCast(rtti, CGM.Int8PtrTy));
644 
645   case VTableComponent::CK_FunctionPointer:
646   case VTableComponent::CK_CompleteDtorPointer:
647   case VTableComponent::CK_DeletingDtorPointer: {
648     GlobalDecl GD;
649 
650     // Get the right global decl.
651     switch (component.getKind()) {
652     default:
653       llvm_unreachable("Unexpected vtable component kind");
654     case VTableComponent::CK_FunctionPointer:
655       GD = component.getFunctionDecl();
656       break;
657     case VTableComponent::CK_CompleteDtorPointer:
658       GD = GlobalDecl(component.getDestructorDecl(), Dtor_Complete);
659       break;
660     case VTableComponent::CK_DeletingDtorPointer:
661       GD = GlobalDecl(component.getDestructorDecl(), Dtor_Deleting);
662       break;
663     }
664 
665     if (CGM.getLangOpts().CUDA) {
666       // Emit NULL for methods we can't codegen on this
667       // side. Otherwise we'd end up with vtable with unresolved
668       // references.
669       const CXXMethodDecl *MD = cast<CXXMethodDecl>(GD.getDecl());
670       // OK on device side: functions w/ __device__ attribute
671       // OK on host side: anything except __device__-only functions.
672       bool CanEmitMethod =
673           CGM.getLangOpts().CUDAIsDevice
674               ? MD->hasAttr<CUDADeviceAttr>()
675               : (MD->hasAttr<CUDAHostAttr>() || !MD->hasAttr<CUDADeviceAttr>());
676       if (!CanEmitMethod)
677         return builder.addNullPointer(CGM.Int8PtrTy);
678       // Method is acceptable, continue processing as usual.
679     }
680 
681     auto getSpecialVirtualFn = [&](StringRef name) -> llvm::Constant * {
682       // For NVPTX devices in OpenMP emit special functon as null pointers,
683       // otherwise linking ends up with unresolved references.
684       if (CGM.getLangOpts().OpenMP && CGM.getLangOpts().OpenMPIsDevice &&
685           CGM.getTriple().isNVPTX())
686         return llvm::ConstantPointerNull::get(CGM.Int8PtrTy);
687       llvm::FunctionType *fnTy =
688           llvm::FunctionType::get(CGM.VoidTy, /*isVarArg=*/false);
689       llvm::Constant *fn = cast<llvm::Constant>(
690           CGM.CreateRuntimeFunction(fnTy, name).getCallee());
691       if (auto f = dyn_cast<llvm::Function>(fn))
692         f->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
693       return llvm::ConstantExpr::getBitCast(fn, CGM.Int8PtrTy);
694     };
695 
696     llvm::Constant *fnPtr;
697 
698     // Pure virtual member functions.
699     if (cast<CXXMethodDecl>(GD.getDecl())->isPure()) {
700       if (!PureVirtualFn)
701         PureVirtualFn =
702           getSpecialVirtualFn(CGM.getCXXABI().GetPureVirtualCallName());
703       fnPtr = PureVirtualFn;
704 
705     // Deleted virtual member functions.
706     } else if (cast<CXXMethodDecl>(GD.getDecl())->isDeleted()) {
707       if (!DeletedVirtualFn)
708         DeletedVirtualFn =
709           getSpecialVirtualFn(CGM.getCXXABI().GetDeletedVirtualCallName());
710       fnPtr = DeletedVirtualFn;
711 
712     // Thunks.
713     } else if (nextVTableThunkIndex < layout.vtable_thunks().size() &&
714                layout.vtable_thunks()[nextVTableThunkIndex].first == idx) {
715       auto &thunkInfo = layout.vtable_thunks()[nextVTableThunkIndex].second;
716 
717       nextVTableThunkIndex++;
718       fnPtr = maybeEmitThunk(GD, thunkInfo, /*ForVTable=*/true);
719 
720     // Otherwise we can use the method definition directly.
721     } else {
722       llvm::Type *fnTy = CGM.getTypes().GetFunctionTypeForVTable(GD);
723       fnPtr = CGM.GetAddrOfFunction(GD, fnTy, /*ForVTable=*/true);
724     }
725 
726     fnPtr = llvm::ConstantExpr::getBitCast(fnPtr, CGM.Int8PtrTy);
727     builder.add(fnPtr);
728     return;
729   }
730 
731   case VTableComponent::CK_UnusedFunctionPointer:
732     return builder.addNullPointer(CGM.Int8PtrTy);
733   }
734 
735   llvm_unreachable("Unexpected vtable component kind");
736 }
737 
738 llvm::Type *CodeGenVTables::getVTableType(const VTableLayout &layout) {
739   SmallVector<llvm::Type *, 4> tys;
740   for (unsigned i = 0, e = layout.getNumVTables(); i != e; ++i) {
741     tys.push_back(llvm::ArrayType::get(CGM.Int8PtrTy, layout.getVTableSize(i)));
742   }
743 
744   return llvm::StructType::get(CGM.getLLVMContext(), tys);
745 }
746 
747 void CodeGenVTables::createVTableInitializer(ConstantStructBuilder &builder,
748                                              const VTableLayout &layout,
749                                              llvm::Constant *rtti) {
750   unsigned nextVTableThunkIndex = 0;
751   for (unsigned i = 0, e = layout.getNumVTables(); i != e; ++i) {
752     auto vtableElem = builder.beginArray(CGM.Int8PtrTy);
753     size_t thisIndex = layout.getVTableOffset(i);
754     size_t nextIndex = thisIndex + layout.getVTableSize(i);
755     for (unsigned i = thisIndex; i != nextIndex; ++i) {
756       addVTableComponent(vtableElem, layout, i, rtti, nextVTableThunkIndex);
757     }
758     vtableElem.finishAndAddTo(builder);
759   }
760 }
761 
762 llvm::GlobalVariable *
763 CodeGenVTables::GenerateConstructionVTable(const CXXRecordDecl *RD,
764                                       const BaseSubobject &Base,
765                                       bool BaseIsVirtual,
766                                    llvm::GlobalVariable::LinkageTypes Linkage,
767                                       VTableAddressPointsMapTy& AddressPoints) {
768   if (CGDebugInfo *DI = CGM.getModuleDebugInfo())
769     DI->completeClassData(Base.getBase());
770 
771   std::unique_ptr<VTableLayout> VTLayout(
772       getItaniumVTableContext().createConstructionVTableLayout(
773           Base.getBase(), Base.getBaseOffset(), BaseIsVirtual, RD));
774 
775   // Add the address points.
776   AddressPoints = VTLayout->getAddressPoints();
777 
778   // Get the mangled construction vtable name.
779   SmallString<256> OutName;
780   llvm::raw_svector_ostream Out(OutName);
781   cast<ItaniumMangleContext>(CGM.getCXXABI().getMangleContext())
782       .mangleCXXCtorVTable(RD, Base.getBaseOffset().getQuantity(),
783                            Base.getBase(), Out);
784   StringRef Name = OutName.str();
785 
786   llvm::Type *VTType = getVTableType(*VTLayout);
787 
788   // Construction vtable symbols are not part of the Itanium ABI, so we cannot
789   // guarantee that they actually will be available externally. Instead, when
790   // emitting an available_externally VTT, we provide references to an internal
791   // linkage construction vtable. The ABI only requires complete-object vtables
792   // to be the same for all instances of a type, not construction vtables.
793   if (Linkage == llvm::GlobalVariable::AvailableExternallyLinkage)
794     Linkage = llvm::GlobalVariable::InternalLinkage;
795 
796   unsigned Align = CGM.getDataLayout().getABITypeAlignment(VTType);
797 
798   // Create the variable that will hold the construction vtable.
799   llvm::GlobalVariable *VTable =
800       CGM.CreateOrReplaceCXXRuntimeVariable(Name, VTType, Linkage, Align);
801 
802   // V-tables are always unnamed_addr.
803   VTable->setUnnamedAddr(llvm::GlobalValue::UnnamedAddr::Global);
804 
805   llvm::Constant *RTTI = CGM.GetAddrOfRTTIDescriptor(
806       CGM.getContext().getTagDeclType(Base.getBase()));
807 
808   // Create and set the initializer.
809   ConstantInitBuilder builder(CGM);
810   auto components = builder.beginStruct();
811   createVTableInitializer(components, *VTLayout, RTTI);
812   components.finishAndSetAsInitializer(VTable);
813 
814   // Set properties only after the initializer has been set to ensure that the
815   // GV is treated as definition and not declaration.
816   assert(!VTable->isDeclaration() && "Shouldn't set properties on declaration");
817   CGM.setGVProperties(VTable, RD);
818 
819   CGM.EmitVTableTypeMetadata(RD, VTable, *VTLayout.get());
820 
821   return VTable;
822 }
823 
824 static bool shouldEmitAvailableExternallyVTable(const CodeGenModule &CGM,
825                                                 const CXXRecordDecl *RD) {
826   return CGM.getCodeGenOpts().OptimizationLevel > 0 &&
827          CGM.getCXXABI().canSpeculativelyEmitVTable(RD);
828 }
829 
830 /// Compute the required linkage of the vtable for the given class.
831 ///
832 /// Note that we only call this at the end of the translation unit.
833 llvm::GlobalVariable::LinkageTypes
834 CodeGenModule::getVTableLinkage(const CXXRecordDecl *RD) {
835   if (!RD->isExternallyVisible())
836     return llvm::GlobalVariable::InternalLinkage;
837 
838   // We're at the end of the translation unit, so the current key
839   // function is fully correct.
840   const CXXMethodDecl *keyFunction = Context.getCurrentKeyFunction(RD);
841   if (keyFunction && !RD->hasAttr<DLLImportAttr>()) {
842     // If this class has a key function, use that to determine the
843     // linkage of the vtable.
844     const FunctionDecl *def = nullptr;
845     if (keyFunction->hasBody(def))
846       keyFunction = cast<CXXMethodDecl>(def);
847 
848     switch (keyFunction->getTemplateSpecializationKind()) {
849       case TSK_Undeclared:
850       case TSK_ExplicitSpecialization:
851         assert((def || CodeGenOpts.OptimizationLevel > 0 ||
852                 CodeGenOpts.getDebugInfo() != codegenoptions::NoDebugInfo) &&
853                "Shouldn't query vtable linkage without key function, "
854                "optimizations, or debug info");
855         if (!def && CodeGenOpts.OptimizationLevel > 0)
856           return llvm::GlobalVariable::AvailableExternallyLinkage;
857 
858         if (keyFunction->isInlined())
859           return !Context.getLangOpts().AppleKext ?
860                    llvm::GlobalVariable::LinkOnceODRLinkage :
861                    llvm::Function::InternalLinkage;
862 
863         return llvm::GlobalVariable::ExternalLinkage;
864 
865       case TSK_ImplicitInstantiation:
866         return !Context.getLangOpts().AppleKext ?
867                  llvm::GlobalVariable::LinkOnceODRLinkage :
868                  llvm::Function::InternalLinkage;
869 
870       case TSK_ExplicitInstantiationDefinition:
871         return !Context.getLangOpts().AppleKext ?
872                  llvm::GlobalVariable::WeakODRLinkage :
873                  llvm::Function::InternalLinkage;
874 
875       case TSK_ExplicitInstantiationDeclaration:
876         llvm_unreachable("Should not have been asked to emit this");
877     }
878   }
879 
880   // -fapple-kext mode does not support weak linkage, so we must use
881   // internal linkage.
882   if (Context.getLangOpts().AppleKext)
883     return llvm::Function::InternalLinkage;
884 
885   llvm::GlobalVariable::LinkageTypes DiscardableODRLinkage =
886       llvm::GlobalValue::LinkOnceODRLinkage;
887   llvm::GlobalVariable::LinkageTypes NonDiscardableODRLinkage =
888       llvm::GlobalValue::WeakODRLinkage;
889   if (RD->hasAttr<DLLExportAttr>()) {
890     // Cannot discard exported vtables.
891     DiscardableODRLinkage = NonDiscardableODRLinkage;
892   } else if (RD->hasAttr<DLLImportAttr>()) {
893     // Imported vtables are available externally.
894     DiscardableODRLinkage = llvm::GlobalVariable::AvailableExternallyLinkage;
895     NonDiscardableODRLinkage = llvm::GlobalVariable::AvailableExternallyLinkage;
896   }
897 
898   switch (RD->getTemplateSpecializationKind()) {
899     case TSK_Undeclared:
900     case TSK_ExplicitSpecialization:
901     case TSK_ImplicitInstantiation:
902       return DiscardableODRLinkage;
903 
904     case TSK_ExplicitInstantiationDeclaration:
905       // Explicit instantiations in MSVC do not provide vtables, so we must emit
906       // our own.
907       if (getTarget().getCXXABI().isMicrosoft())
908         return DiscardableODRLinkage;
909       return shouldEmitAvailableExternallyVTable(*this, RD)
910                  ? llvm::GlobalVariable::AvailableExternallyLinkage
911                  : llvm::GlobalVariable::ExternalLinkage;
912 
913     case TSK_ExplicitInstantiationDefinition:
914       return NonDiscardableODRLinkage;
915   }
916 
917   llvm_unreachable("Invalid TemplateSpecializationKind!");
918 }
919 
920 /// This is a callback from Sema to tell us that a particular vtable is
921 /// required to be emitted in this translation unit.
922 ///
923 /// This is only called for vtables that _must_ be emitted (mainly due to key
924 /// functions).  For weak vtables, CodeGen tracks when they are needed and
925 /// emits them as-needed.
926 void CodeGenModule::EmitVTable(CXXRecordDecl *theClass) {
927   VTables.GenerateClassData(theClass);
928 }
929 
930 void
931 CodeGenVTables::GenerateClassData(const CXXRecordDecl *RD) {
932   if (CGDebugInfo *DI = CGM.getModuleDebugInfo())
933     DI->completeClassData(RD);
934 
935   if (RD->getNumVBases())
936     CGM.getCXXABI().emitVirtualInheritanceTables(RD);
937 
938   CGM.getCXXABI().emitVTableDefinitions(*this, RD);
939 }
940 
941 /// At this point in the translation unit, does it appear that can we
942 /// rely on the vtable being defined elsewhere in the program?
943 ///
944 /// The response is really only definitive when called at the end of
945 /// the translation unit.
946 ///
947 /// The only semantic restriction here is that the object file should
948 /// not contain a vtable definition when that vtable is defined
949 /// strongly elsewhere.  Otherwise, we'd just like to avoid emitting
950 /// vtables when unnecessary.
951 bool CodeGenVTables::isVTableExternal(const CXXRecordDecl *RD) {
952   assert(RD->isDynamicClass() && "Non-dynamic classes have no VTable.");
953 
954   // We always synthesize vtables if they are needed in the MS ABI. MSVC doesn't
955   // emit them even if there is an explicit template instantiation.
956   if (CGM.getTarget().getCXXABI().isMicrosoft())
957     return false;
958 
959   // If we have an explicit instantiation declaration (and not a
960   // definition), the vtable is defined elsewhere.
961   TemplateSpecializationKind TSK = RD->getTemplateSpecializationKind();
962   if (TSK == TSK_ExplicitInstantiationDeclaration)
963     return true;
964 
965   // Otherwise, if the class is an instantiated template, the
966   // vtable must be defined here.
967   if (TSK == TSK_ImplicitInstantiation ||
968       TSK == TSK_ExplicitInstantiationDefinition)
969     return false;
970 
971   // Otherwise, if the class doesn't have a key function (possibly
972   // anymore), the vtable must be defined here.
973   const CXXMethodDecl *keyFunction = CGM.getContext().getCurrentKeyFunction(RD);
974   if (!keyFunction)
975     return false;
976 
977   // Otherwise, if we don't have a definition of the key function, the
978   // vtable must be defined somewhere else.
979   return !keyFunction->hasBody();
980 }
981 
982 /// Given that we're currently at the end of the translation unit, and
983 /// we've emitted a reference to the vtable for this class, should
984 /// we define that vtable?
985 static bool shouldEmitVTableAtEndOfTranslationUnit(CodeGenModule &CGM,
986                                                    const CXXRecordDecl *RD) {
987   // If vtable is internal then it has to be done.
988   if (!CGM.getVTables().isVTableExternal(RD))
989     return true;
990 
991   // If it's external then maybe we will need it as available_externally.
992   return shouldEmitAvailableExternallyVTable(CGM, RD);
993 }
994 
995 /// Given that at some point we emitted a reference to one or more
996 /// vtables, and that we are now at the end of the translation unit,
997 /// decide whether we should emit them.
998 void CodeGenModule::EmitDeferredVTables() {
999 #ifndef NDEBUG
1000   // Remember the size of DeferredVTables, because we're going to assume
1001   // that this entire operation doesn't modify it.
1002   size_t savedSize = DeferredVTables.size();
1003 #endif
1004 
1005   for (const CXXRecordDecl *RD : DeferredVTables)
1006     if (shouldEmitVTableAtEndOfTranslationUnit(*this, RD))
1007       VTables.GenerateClassData(RD);
1008     else if (shouldOpportunisticallyEmitVTables())
1009       OpportunisticVTables.push_back(RD);
1010 
1011   assert(savedSize == DeferredVTables.size() &&
1012          "deferred extra vtables during vtable emission?");
1013   DeferredVTables.clear();
1014 }
1015 
1016 bool CodeGenModule::HasLTOVisibilityPublicStd(const CXXRecordDecl *RD) {
1017   if (!getCodeGenOpts().LTOVisibilityPublicStd)
1018     return false;
1019 
1020   const DeclContext *DC = RD;
1021   while (1) {
1022     auto *D = cast<Decl>(DC);
1023     DC = DC->getParent();
1024     if (isa<TranslationUnitDecl>(DC->getRedeclContext())) {
1025       if (auto *ND = dyn_cast<NamespaceDecl>(D))
1026         if (const IdentifierInfo *II = ND->getIdentifier())
1027           if (II->isStr("std") || II->isStr("stdext"))
1028             return true;
1029       break;
1030     }
1031   }
1032 
1033   return false;
1034 }
1035 
1036 bool CodeGenModule::HasHiddenLTOVisibility(const CXXRecordDecl *RD) {
1037   LinkageInfo LV = RD->getLinkageAndVisibility();
1038   if (!isExternallyVisible(LV.getLinkage()))
1039     return true;
1040 
1041   if (RD->hasAttr<LTOVisibilityPublicAttr>() || RD->hasAttr<UuidAttr>())
1042     return false;
1043 
1044   if (getTriple().isOSBinFormatCOFF()) {
1045     if (RD->hasAttr<DLLExportAttr>() || RD->hasAttr<DLLImportAttr>())
1046       return false;
1047   } else {
1048     if (LV.getVisibility() != HiddenVisibility)
1049       return false;
1050   }
1051 
1052   return !HasLTOVisibilityPublicStd(RD);
1053 }
1054 
1055 llvm::GlobalObject::VCallVisibility
1056 CodeGenModule::GetVCallVisibilityLevel(const CXXRecordDecl *RD) {
1057   LinkageInfo LV = RD->getLinkageAndVisibility();
1058   llvm::GlobalObject::VCallVisibility TypeVis;
1059   if (!isExternallyVisible(LV.getLinkage()))
1060     TypeVis = llvm::GlobalObject::VCallVisibilityTranslationUnit;
1061   else if (HasHiddenLTOVisibility(RD))
1062     TypeVis = llvm::GlobalObject::VCallVisibilityLinkageUnit;
1063   else
1064     TypeVis = llvm::GlobalObject::VCallVisibilityPublic;
1065 
1066   for (auto B : RD->bases())
1067     if (B.getType()->getAsCXXRecordDecl()->isDynamicClass())
1068       TypeVis = std::min(TypeVis,
1069                     GetVCallVisibilityLevel(B.getType()->getAsCXXRecordDecl()));
1070 
1071   for (auto B : RD->vbases())
1072     if (B.getType()->getAsCXXRecordDecl()->isDynamicClass())
1073       TypeVis = std::min(TypeVis,
1074                     GetVCallVisibilityLevel(B.getType()->getAsCXXRecordDecl()));
1075 
1076   return TypeVis;
1077 }
1078 
1079 void CodeGenModule::EmitVTableTypeMetadata(const CXXRecordDecl *RD,
1080                                            llvm::GlobalVariable *VTable,
1081                                            const VTableLayout &VTLayout) {
1082   if (!getCodeGenOpts().LTOUnit)
1083     return;
1084 
1085   CharUnits PointerWidth =
1086       Context.toCharUnitsFromBits(Context.getTargetInfo().getPointerWidth(0));
1087 
1088   typedef std::pair<const CXXRecordDecl *, unsigned> AddressPoint;
1089   std::vector<AddressPoint> AddressPoints;
1090   for (auto &&AP : VTLayout.getAddressPoints())
1091     AddressPoints.push_back(std::make_pair(
1092         AP.first.getBase(), VTLayout.getVTableOffset(AP.second.VTableIndex) +
1093                                 AP.second.AddressPointIndex));
1094 
1095   // Sort the address points for determinism.
1096   llvm::sort(AddressPoints, [this](const AddressPoint &AP1,
1097                                    const AddressPoint &AP2) {
1098     if (&AP1 == &AP2)
1099       return false;
1100 
1101     std::string S1;
1102     llvm::raw_string_ostream O1(S1);
1103     getCXXABI().getMangleContext().mangleTypeName(
1104         QualType(AP1.first->getTypeForDecl(), 0), O1);
1105     O1.flush();
1106 
1107     std::string S2;
1108     llvm::raw_string_ostream O2(S2);
1109     getCXXABI().getMangleContext().mangleTypeName(
1110         QualType(AP2.first->getTypeForDecl(), 0), O2);
1111     O2.flush();
1112 
1113     if (S1 < S2)
1114       return true;
1115     if (S1 != S2)
1116       return false;
1117 
1118     return AP1.second < AP2.second;
1119   });
1120 
1121   ArrayRef<VTableComponent> Comps = VTLayout.vtable_components();
1122   for (auto AP : AddressPoints) {
1123     // Create type metadata for the address point.
1124     AddVTableTypeMetadata(VTable, PointerWidth * AP.second, AP.first);
1125 
1126     // The class associated with each address point could also potentially be
1127     // used for indirect calls via a member function pointer, so we need to
1128     // annotate the address of each function pointer with the appropriate member
1129     // function pointer type.
1130     for (unsigned I = 0; I != Comps.size(); ++I) {
1131       if (Comps[I].getKind() != VTableComponent::CK_FunctionPointer)
1132         continue;
1133       llvm::Metadata *MD = CreateMetadataIdentifierForVirtualMemPtrType(
1134           Context.getMemberPointerType(
1135               Comps[I].getFunctionDecl()->getType(),
1136               Context.getRecordType(AP.first).getTypePtr()));
1137       VTable->addTypeMetadata((PointerWidth * I).getQuantity(), MD);
1138     }
1139   }
1140 
1141   if (getCodeGenOpts().VirtualFunctionElimination ||
1142       getCodeGenOpts().WholeProgramVTables) {
1143     llvm::GlobalObject::VCallVisibility TypeVis = GetVCallVisibilityLevel(RD);
1144     if (TypeVis != llvm::GlobalObject::VCallVisibilityPublic)
1145       VTable->setVCallVisibilityMetadata(TypeVis);
1146   }
1147 }
1148