LLVM  12.0.0git
WholeProgramDevirt.cpp
Go to the documentation of this file.
1 //===- WholeProgramDevirt.cpp - Whole program virtual call optimization ---===//
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 pass implements whole program optimization of virtual calls in cases
10 // where we know (via !type metadata) that the list of callees is fixed. This
11 // includes the following:
12 // - Single implementation devirtualization: if a virtual call has a single
13 // possible callee, replace all calls with a direct call to that callee.
14 // - Virtual constant propagation: if the virtual function's return type is an
15 // integer <=64 bits and all possible callees are readnone, for each class and
16 // each list of constant arguments: evaluate the function, store the return
17 // value alongside the virtual table, and rewrite each virtual call as a load
18 // from the virtual table.
19 // - Uniform return value optimization: if the conditions for virtual constant
20 // propagation hold and each function returns the same constant value, replace
21 // each virtual call with that constant.
22 // - Unique return value optimization for i1 return values: if the conditions
23 // for virtual constant propagation hold and a single vtable's function
24 // returns 0, or a single vtable's function returns 1, replace each virtual
25 // call with a comparison of the vptr against that vtable's address.
26 //
27 // This pass is intended to be used during the regular and thin LTO pipelines:
28 //
29 // During regular LTO, the pass determines the best optimization for each
30 // virtual call and applies the resolutions directly to virtual calls that are
31 // eligible for virtual call optimization (i.e. calls that use either of the
32 // llvm.assume(llvm.type.test) or llvm.type.checked.load intrinsics).
33 //
34 // During hybrid Regular/ThinLTO, the pass operates in two phases:
35 // - Export phase: this is run during the thin link over a single merged module
36 // that contains all vtables with !type metadata that participate in the link.
37 // The pass computes a resolution for each virtual call and stores it in the
38 // type identifier summary.
39 // - Import phase: this is run during the thin backends over the individual
40 // modules. The pass applies the resolutions previously computed during the
41 // import phase to each eligible virtual call.
42 //
43 // During ThinLTO, the pass operates in two phases:
44 // - Export phase: this is run during the thin link over the index which
45 // contains a summary of all vtables with !type metadata that participate in
46 // the link. It computes a resolution for each virtual call and stores it in
47 // the type identifier summary. Only single implementation devirtualization
48 // is supported.
49 // - Import phase: (same as with hybrid case above).
50 //
51 //===----------------------------------------------------------------------===//
52 
54 #include "llvm/ADT/ArrayRef.h"
55 #include "llvm/ADT/DenseMap.h"
56 #include "llvm/ADT/DenseMapInfo.h"
57 #include "llvm/ADT/DenseSet.h"
58 #include "llvm/ADT/MapVector.h"
59 #include "llvm/ADT/SmallVector.h"
60 #include "llvm/ADT/Triple.h"
68 #include "llvm/IR/Constants.h"
69 #include "llvm/IR/DataLayout.h"
70 #include "llvm/IR/DebugLoc.h"
71 #include "llvm/IR/DerivedTypes.h"
72 #include "llvm/IR/Dominators.h"
73 #include "llvm/IR/Function.h"
74 #include "llvm/IR/GlobalAlias.h"
75 #include "llvm/IR/GlobalVariable.h"
76 #include "llvm/IR/IRBuilder.h"
77 #include "llvm/IR/InstrTypes.h"
78 #include "llvm/IR/Instruction.h"
79 #include "llvm/IR/Instructions.h"
80 #include "llvm/IR/Intrinsics.h"
81 #include "llvm/IR/LLVMContext.h"
82 #include "llvm/IR/Metadata.h"
83 #include "llvm/IR/Module.h"
85 #include "llvm/InitializePasses.h"
86 #include "llvm/Pass.h"
87 #include "llvm/PassRegistry.h"
88 #include "llvm/Support/Casting.h"
90 #include "llvm/Support/Errc.h"
91 #include "llvm/Support/Error.h"
95 #include "llvm/Transforms/IPO.h"
98 #include <algorithm>
99 #include <cstddef>
100 #include <map>
101 #include <set>
102 #include <string>
103 
104 using namespace llvm;
105 using namespace wholeprogramdevirt;
106 
107 #define DEBUG_TYPE "wholeprogramdevirt"
108 
110  "wholeprogramdevirt-summary-action",
111  cl::desc("What to do with the summary when running this pass"),
112  cl::values(clEnumValN(PassSummaryAction::None, "none", "Do nothing"),
114  "Import typeid resolutions from summary and globals"),
116  "Export typeid resolutions to summary and globals")),
117  cl::Hidden);
118 
120  "wholeprogramdevirt-read-summary",
121  cl::desc(
122  "Read summary from given bitcode or YAML file before running pass"),
123  cl::Hidden);
124 
126  "wholeprogramdevirt-write-summary",
127  cl::desc("Write summary to given bitcode or YAML file after running pass. "
128  "Output file format is deduced from extension: *.bc means writing "
129  "bitcode, otherwise YAML"),
130  cl::Hidden);
131 
132 static cl::opt<unsigned>
133  ClThreshold("wholeprogramdevirt-branch-funnel-threshold", cl::Hidden,
135  cl::desc("Maximum number of call targets per "
136  "call site to enable branch funnels"));
137 
138 static cl::opt<bool>
139  PrintSummaryDevirt("wholeprogramdevirt-print-index-based", cl::Hidden,
140  cl::init(false), cl::ZeroOrMore,
141  cl::desc("Print index-based devirtualization messages"));
142 
143 /// Provide a way to force enable whole program visibility in tests.
144 /// This is needed to support legacy tests that don't contain
145 /// !vcall_visibility metadata (the mere presense of type tests
146 /// previously implied hidden visibility).
148  WholeProgramVisibility("whole-program-visibility", cl::init(false),
150  cl::desc("Enable whole program visibility"));
151 
152 /// Provide a way to force disable whole program for debugging or workarounds,
153 /// when enabled via the linker.
155  "disable-whole-program-visibility", cl::init(false), cl::Hidden,
157  cl::desc("Disable whole program visibility (overrides enabling options)"));
158 
159 /// Provide way to prevent certain function from being devirtualized
161  SkipFunctionNames("wholeprogramdevirt-skip",
162  cl::desc("Prevent function(s) from being devirtualized"),
164 
165 namespace {
166 struct PatternList {
167  std::vector<GlobPattern> Patterns;
168  template <class T> void init(const T &StringList) {
169  for (const auto &S : StringList)
171  Patterns.push_back(std::move(*Pat));
172  }
173  bool match(StringRef S) {
174  for (const GlobPattern &P : Patterns)
175  if (P.match(S))
176  return true;
177  return false;
178  }
179 };
180 } // namespace
181 
182 // Find the minimum offset that we may store a value of size Size bits at. If
183 // IsAfter is set, look for an offset before the object, otherwise look for an
184 // offset after the object.
185 uint64_t
187  bool IsAfter, uint64_t Size) {
188  // Find a minimum offset taking into account only vtable sizes.
189  uint64_t MinByte = 0;
190  for (const VirtualCallTarget &Target : Targets) {
191  if (IsAfter)
192  MinByte = std::max(MinByte, Target.minAfterBytes());
193  else
194  MinByte = std::max(MinByte, Target.minBeforeBytes());
195  }
196 
197  // Build a vector of arrays of bytes covering, for each target, a slice of the
198  // used region (see AccumBitVector::BytesUsed in
199  // llvm/Transforms/IPO/WholeProgramDevirt.h) starting at MinByte. Effectively,
200  // this aligns the used regions to start at MinByte.
201  //
202  // In this example, A, B and C are vtables, # is a byte already allocated for
203  // a virtual function pointer, AAAA... (etc.) are the used regions for the
204  // vtables and Offset(X) is the value computed for the Offset variable below
205  // for X.
206  //
207  // Offset(A)
208  // | |
209  // |MinByte
210  // A: ################AAAAAAAA|AAAAAAAA
211  // B: ########BBBBBBBBBBBBBBBB|BBBB
212  // C: ########################|CCCCCCCCCCCCCCCC
213  // | Offset(B) |
214  //
215  // This code produces the slices of A, B and C that appear after the divider
216  // at MinByte.
217  std::vector<ArrayRef<uint8_t>> Used;
218  for (const VirtualCallTarget &Target : Targets) {
219  ArrayRef<uint8_t> VTUsed = IsAfter ? Target.TM->Bits->After.BytesUsed
220  : Target.TM->Bits->Before.BytesUsed;
221  uint64_t Offset = IsAfter ? MinByte - Target.minAfterBytes()
222  : MinByte - Target.minBeforeBytes();
223 
224  // Disregard used regions that are smaller than Offset. These are
225  // effectively all-free regions that do not need to be checked.
226  if (VTUsed.size() > Offset)
227  Used.push_back(VTUsed.slice(Offset));
228  }
229 
230  if (Size == 1) {
231  // Find a free bit in each member of Used.
232  for (unsigned I = 0;; ++I) {
233  uint8_t BitsUsed = 0;
234  for (auto &&B : Used)
235  if (I < B.size())
236  BitsUsed |= B[I];
237  if (BitsUsed != 0xff)
238  return (MinByte + I) * 8 +
239  countTrailingZeros(uint8_t(~BitsUsed), ZB_Undefined);
240  }
241  } else {
242  // Find a free (Size/8) byte region in each member of Used.
243  // FIXME: see if alignment helps.
244  for (unsigned I = 0;; ++I) {
245  for (auto &&B : Used) {
246  unsigned Byte = 0;
247  while ((I + Byte) < B.size() && Byte < (Size / 8)) {
248  if (B[I + Byte])
249  goto NextI;
250  ++Byte;
251  }
252  }
253  return (MinByte + I) * 8;
254  NextI:;
255  }
256  }
257 }
258 
260  MutableArrayRef<VirtualCallTarget> Targets, uint64_t AllocBefore,
261  unsigned BitWidth, int64_t &OffsetByte, uint64_t &OffsetBit) {
262  if (BitWidth == 1)
263  OffsetByte = -(AllocBefore / 8 + 1);
264  else
265  OffsetByte = -((AllocBefore + 7) / 8 + (BitWidth + 7) / 8);
266  OffsetBit = AllocBefore % 8;
267 
268  for (VirtualCallTarget &Target : Targets) {
269  if (BitWidth == 1)
270  Target.setBeforeBit(AllocBefore);
271  else
272  Target.setBeforeBytes(AllocBefore, (BitWidth + 7) / 8);
273  }
274 }
275 
277  MutableArrayRef<VirtualCallTarget> Targets, uint64_t AllocAfter,
278  unsigned BitWidth, int64_t &OffsetByte, uint64_t &OffsetBit) {
279  if (BitWidth == 1)
280  OffsetByte = AllocAfter / 8;
281  else
282  OffsetByte = (AllocAfter + 7) / 8;
283  OffsetBit = AllocAfter % 8;
284 
285  for (VirtualCallTarget &Target : Targets) {
286  if (BitWidth == 1)
287  Target.setAfterBit(AllocAfter);
288  else
289  Target.setAfterBytes(AllocAfter, (BitWidth + 7) / 8);
290  }
291 }
292 
294  : Fn(Fn), TM(TM),
295  IsBigEndian(Fn->getParent()->getDataLayout().isBigEndian()), WasDevirt(false) {}
296 
297 namespace {
298 
299 // A slot in a set of virtual tables. The TypeID identifies the set of virtual
300 // tables, and the ByteOffset is the offset in bytes from the address point to
301 // the virtual function pointer.
302 struct VTableSlot {
303  Metadata *TypeID;
304  uint64_t ByteOffset;
305 };
306 
307 } // end anonymous namespace
308 
309 namespace llvm {
310 
311 template <> struct DenseMapInfo<VTableSlot> {
312  static VTableSlot getEmptyKey() {
315  }
316  static VTableSlot getTombstoneKey() {
319  }
320  static unsigned getHashValue(const VTableSlot &I) {
321  return DenseMapInfo<Metadata *>::getHashValue(I.TypeID) ^
323  }
324  static bool isEqual(const VTableSlot &LHS,
325  const VTableSlot &RHS) {
326  return LHS.TypeID == RHS.TypeID && LHS.ByteOffset == RHS.ByteOffset;
327  }
328 };
329 
330 template <> struct DenseMapInfo<VTableSlotSummary> {
334  }
338  }
339  static unsigned getHashValue(const VTableSlotSummary &I) {
342  }
343  static bool isEqual(const VTableSlotSummary &LHS,
344  const VTableSlotSummary &RHS) {
345  return LHS.TypeID == RHS.TypeID && LHS.ByteOffset == RHS.ByteOffset;
346  }
347 };
348 
349 } // end namespace llvm
350 
351 namespace {
352 
353 // A virtual call site. VTable is the loaded virtual table pointer, and CS is
354 // the indirect virtual call.
355 struct VirtualCallSite {
356  Value *VTable = nullptr;
357  CallBase &CB;
358 
359  // If non-null, this field points to the associated unsafe use count stored in
360  // the DevirtModule::NumUnsafeUsesForTypeTest map below. See the description
361  // of that field for details.
362  unsigned *NumUnsafeUses = nullptr;
363 
364  void
365  emitRemark(const StringRef OptName, const StringRef TargetName,
367  Function *F = CB.getCaller();
368  DebugLoc DLoc = CB.getDebugLoc();
369  BasicBlock *Block = CB.getParent();
370 
371  using namespace ore;
372  OREGetter(F).emit(OptimizationRemark(DEBUG_TYPE, OptName, DLoc, Block)
373  << NV("Optimization", OptName)
374  << ": devirtualized a call to "
375  << NV("FunctionName", TargetName));
376  }
377 
378  void replaceAndErase(
379  const StringRef OptName, const StringRef TargetName, bool RemarksEnabled,
381  Value *New) {
382  if (RemarksEnabled)
383  emitRemark(OptName, TargetName, OREGetter);
384  CB.replaceAllUsesWith(New);
385  if (auto *II = dyn_cast<InvokeInst>(&CB)) {
386  BranchInst::Create(II->getNormalDest(), &CB);
387  II->getUnwindDest()->removePredecessor(II->getParent());
388  }
389  CB.eraseFromParent();
390  // This use is no longer unsafe.
391  if (NumUnsafeUses)
392  --*NumUnsafeUses;
393  }
394 };
395 
396 // Call site information collected for a specific VTableSlot and possibly a list
397 // of constant integer arguments. The grouping by arguments is handled by the
398 // VTableSlotInfo class.
399 struct CallSiteInfo {
400  /// The set of call sites for this slot. Used during regular LTO and the
401  /// import phase of ThinLTO (as well as the export phase of ThinLTO for any
402  /// call sites that appear in the merged module itself); in each of these
403  /// cases we are directly operating on the call sites at the IR level.
404  std::vector<VirtualCallSite> CallSites;
405 
406  /// Whether all call sites represented by this CallSiteInfo, including those
407  /// in summaries, have been devirtualized. This starts off as true because a
408  /// default constructed CallSiteInfo represents no call sites.
409  bool AllCallSitesDevirted = true;
410 
411  // These fields are used during the export phase of ThinLTO and reflect
412  // information collected from function summaries.
413 
414  /// Whether any function summary contains an llvm.assume(llvm.type.test) for
415  /// this slot.
416  bool SummaryHasTypeTestAssumeUsers = false;
417 
418  /// CFI-specific: a vector containing the list of function summaries that use
419  /// the llvm.type.checked.load intrinsic and therefore will require
420  /// resolutions for llvm.type.test in order to implement CFI checks if
421  /// devirtualization was unsuccessful. If devirtualization was successful, the
422  /// pass will clear this vector by calling markDevirt(). If at the end of the
423  /// pass the vector is non-empty, we will need to add a use of llvm.type.test
424  /// to each of the function summaries in the vector.
425  std::vector<FunctionSummary *> SummaryTypeCheckedLoadUsers;
426  std::vector<FunctionSummary *> SummaryTypeTestAssumeUsers;
427 
428  bool isExported() const {
429  return SummaryHasTypeTestAssumeUsers ||
430  !SummaryTypeCheckedLoadUsers.empty();
431  }
432 
433  void addSummaryTypeCheckedLoadUser(FunctionSummary *FS) {
434  SummaryTypeCheckedLoadUsers.push_back(FS);
435  AllCallSitesDevirted = false;
436  }
437 
438  void addSummaryTypeTestAssumeUser(FunctionSummary *FS) {
439  SummaryTypeTestAssumeUsers.push_back(FS);
440  SummaryHasTypeTestAssumeUsers = true;
441  AllCallSitesDevirted = false;
442  }
443 
444  void markDevirt() {
445  AllCallSitesDevirted = true;
446 
447  // As explained in the comment for SummaryTypeCheckedLoadUsers.
448  SummaryTypeCheckedLoadUsers.clear();
449  }
450 };
451 
452 // Call site information collected for a specific VTableSlot.
453 struct VTableSlotInfo {
454  // The set of call sites which do not have all constant integer arguments
455  // (excluding "this").
456  CallSiteInfo CSInfo;
457 
458  // The set of call sites with all constant integer arguments (excluding
459  // "this"), grouped by argument list.
460  std::map<std::vector<uint64_t>, CallSiteInfo> ConstCSInfo;
461 
462  void addCallSite(Value *VTable, CallBase &CB, unsigned *NumUnsafeUses);
463 
464 private:
465  CallSiteInfo &findCallSiteInfo(CallBase &CB);
466 };
467 
468 CallSiteInfo &VTableSlotInfo::findCallSiteInfo(CallBase &CB) {
469  std::vector<uint64_t> Args;
470  auto *CBType = dyn_cast<IntegerType>(CB.getType());
471  if (!CBType || CBType->getBitWidth() > 64 || CB.arg_empty())
472  return CSInfo;
473  for (auto &&Arg : make_range(CB.arg_begin() + 1, CB.arg_end())) {
474  auto *CI = dyn_cast<ConstantInt>(Arg);
475  if (!CI || CI->getBitWidth() > 64)
476  return CSInfo;
477  Args.push_back(CI->getZExtValue());
478  }
479  return ConstCSInfo[Args];
480 }
481 
482 void VTableSlotInfo::addCallSite(Value *VTable, CallBase &CB,
483  unsigned *NumUnsafeUses) {
484  auto &CSI = findCallSiteInfo(CB);
485  CSI.AllCallSitesDevirted = false;
486  CSI.CallSites.push_back({VTable, CB, NumUnsafeUses});
487 }
488 
489 struct DevirtModule {
490  Module &M;
493 
494  ModuleSummaryIndex *ExportSummary;
495  const ModuleSummaryIndex *ImportSummary;
496 
497  IntegerType *Int8Ty;
498  PointerType *Int8PtrTy;
500  IntegerType *Int64Ty;
501  IntegerType *IntPtrTy;
502  /// Sizeless array type, used for imported vtables. This provides a signal
503  /// to analyzers that these imports may alias, as they do for example
504  /// when multiple unique return values occur in the same vtable.
505  ArrayType *Int8Arr0Ty;
506 
507  bool RemarksEnabled;
509 
511 
512  // This map keeps track of the number of "unsafe" uses of a loaded function
513  // pointer. The key is the associated llvm.type.test intrinsic call generated
514  // by this pass. An unsafe use is one that calls the loaded function pointer
515  // directly. Every time we eliminate an unsafe use (for example, by
516  // devirtualizing it or by applying virtual constant propagation), we
517  // decrement the value stored in this map. If a value reaches zero, we can
518  // eliminate the type check by RAUWing the associated llvm.type.test call with
519  // true.
520  std::map<CallInst *, unsigned> NumUnsafeUsesForTypeTest;
521  PatternList FunctionsToSkip;
522 
523  DevirtModule(Module &M, function_ref<AAResults &(Function &)> AARGetter,
525  function_ref<DominatorTree &(Function &)> LookupDomTree,
526  ModuleSummaryIndex *ExportSummary,
527  const ModuleSummaryIndex *ImportSummary)
528  : M(M), AARGetter(AARGetter), LookupDomTree(LookupDomTree),
529  ExportSummary(ExportSummary), ImportSummary(ImportSummary),
530  Int8Ty(Type::getInt8Ty(M.getContext())),
531  Int8PtrTy(Type::getInt8PtrTy(M.getContext())),
533  Int64Ty(Type::getInt64Ty(M.getContext())),
534  IntPtrTy(M.getDataLayout().getIntPtrType(M.getContext(), 0)),
535  Int8Arr0Ty(ArrayType::get(Type::getInt8Ty(M.getContext()), 0)),
536  RemarksEnabled(areRemarksEnabled()), OREGetter(OREGetter) {
537  assert(!(ExportSummary && ImportSummary));
538  FunctionsToSkip.init(SkipFunctionNames);
539  }
540 
541  bool areRemarksEnabled();
542 
543  void
544  scanTypeTestUsers(Function *TypeTestFunc,
545  DenseMap<Metadata *, std::set<TypeMemberInfo>> &TypeIdMap);
546  void scanTypeCheckedLoadUsers(Function *TypeCheckedLoadFunc);
547 
548  void buildTypeIdentifierMap(
549  std::vector<VTableBits> &Bits,
550  DenseMap<Metadata *, std::set<TypeMemberInfo>> &TypeIdMap);
551  bool
552  tryFindVirtualCallTargets(std::vector<VirtualCallTarget> &TargetsForSlot,
553  const std::set<TypeMemberInfo> &TypeMemberInfos,
554  uint64_t ByteOffset);
555 
556  void applySingleImplDevirt(VTableSlotInfo &SlotInfo, Constant *TheFn,
557  bool &IsExported);
558  bool trySingleImplDevirt(ModuleSummaryIndex *ExportSummary,
559  MutableArrayRef<VirtualCallTarget> TargetsForSlot,
560  VTableSlotInfo &SlotInfo,
562 
563  void applyICallBranchFunnel(VTableSlotInfo &SlotInfo, Constant *JT,
564  bool &IsExported);
565  void tryICallBranchFunnel(MutableArrayRef<VirtualCallTarget> TargetsForSlot,
566  VTableSlotInfo &SlotInfo,
567  WholeProgramDevirtResolution *Res, VTableSlot Slot);
568 
569  bool tryEvaluateFunctionsWithArgs(
570  MutableArrayRef<VirtualCallTarget> TargetsForSlot,
572 
573  void applyUniformRetValOpt(CallSiteInfo &CSInfo, StringRef FnName,
574  uint64_t TheRetVal);
575  bool tryUniformRetValOpt(MutableArrayRef<VirtualCallTarget> TargetsForSlot,
576  CallSiteInfo &CSInfo,
578 
579  // Returns the global symbol name that is used to export information about the
580  // given vtable slot and list of arguments.
581  std::string getGlobalName(VTableSlot Slot, ArrayRef<uint64_t> Args,
582  StringRef Name);
583 
584  bool shouldExportConstantsAsAbsoluteSymbols();
585 
586  // This function is called during the export phase to create a symbol
587  // definition containing information about the given vtable slot and list of
588  // arguments.
589  void exportGlobal(VTableSlot Slot, ArrayRef<uint64_t> Args, StringRef Name,
590  Constant *C);
591  void exportConstant(VTableSlot Slot, ArrayRef<uint64_t> Args, StringRef Name,
592  uint32_t Const, uint32_t &Storage);
593 
594  // This function is called during the import phase to create a reference to
595  // the symbol definition created during the export phase.
596  Constant *importGlobal(VTableSlot Slot, ArrayRef<uint64_t> Args,
597  StringRef Name);
598  Constant *importConstant(VTableSlot Slot, ArrayRef<uint64_t> Args,
599  StringRef Name, IntegerType *IntTy,
600  uint32_t Storage);
601 
602  Constant *getMemberAddr(const TypeMemberInfo *M);
603 
604  void applyUniqueRetValOpt(CallSiteInfo &CSInfo, StringRef FnName, bool IsOne,
605  Constant *UniqueMemberAddr);
606  bool tryUniqueRetValOpt(unsigned BitWidth,
607  MutableArrayRef<VirtualCallTarget> TargetsForSlot,
608  CallSiteInfo &CSInfo,
610  VTableSlot Slot, ArrayRef<uint64_t> Args);
611 
612  void applyVirtualConstProp(CallSiteInfo &CSInfo, StringRef FnName,
613  Constant *Byte, Constant *Bit);
614  bool tryVirtualConstProp(MutableArrayRef<VirtualCallTarget> TargetsForSlot,
615  VTableSlotInfo &SlotInfo,
616  WholeProgramDevirtResolution *Res, VTableSlot Slot);
617 
618  void rebuildGlobal(VTableBits &B);
619 
620  // Apply the summary resolution for Slot to all virtual calls in SlotInfo.
621  void importResolution(VTableSlot Slot, VTableSlotInfo &SlotInfo);
622 
623  // If we were able to eliminate all unsafe uses for a type checked load,
624  // eliminate the associated type tests by replacing them with true.
625  void removeRedundantTypeTests();
626 
627  bool run();
628 
629  // Lower the module using the action and summary passed as command line
630  // arguments. For testing purposes only.
631  static bool
632  runForTesting(Module &M, function_ref<AAResults &(Function &)> AARGetter,
634  function_ref<DominatorTree &(Function &)> LookupDomTree);
635 };
636 
637 struct DevirtIndex {
638  ModuleSummaryIndex &ExportSummary;
639  // The set in which to record GUIDs exported from their module by
640  // devirtualization, used by client to ensure they are not internalized.
641  std::set<GlobalValue::GUID> &ExportedGUIDs;
642  // A map in which to record the information necessary to locate the WPD
643  // resolution for local targets in case they are exported by cross module
644  // importing.
645  std::map<ValueInfo, std::vector<VTableSlotSummary>> &LocalWPDTargetsMap;
646 
648 
649  PatternList FunctionsToSkip;
650 
651  DevirtIndex(
652  ModuleSummaryIndex &ExportSummary,
653  std::set<GlobalValue::GUID> &ExportedGUIDs,
654  std::map<ValueInfo, std::vector<VTableSlotSummary>> &LocalWPDTargetsMap)
655  : ExportSummary(ExportSummary), ExportedGUIDs(ExportedGUIDs),
656  LocalWPDTargetsMap(LocalWPDTargetsMap) {
657  FunctionsToSkip.init(SkipFunctionNames);
658  }
659 
660  bool tryFindVirtualCallTargets(std::vector<ValueInfo> &TargetsForSlot,
661  const TypeIdCompatibleVtableInfo TIdInfo,
662  uint64_t ByteOffset);
663 
664  bool trySingleImplDevirt(MutableArrayRef<ValueInfo> TargetsForSlot,
665  VTableSlotSummary &SlotSummary,
666  VTableSlotInfo &SlotInfo,
668  std::set<ValueInfo> &DevirtTargets);
669 
670  void run();
671 };
672 
673 struct WholeProgramDevirt : public ModulePass {
674  static char ID;
675 
676  bool UseCommandLine = false;
677 
678  ModuleSummaryIndex *ExportSummary = nullptr;
679  const ModuleSummaryIndex *ImportSummary = nullptr;
680 
681  WholeProgramDevirt() : ModulePass(ID), UseCommandLine(true) {
683  }
684 
685  WholeProgramDevirt(ModuleSummaryIndex *ExportSummary,
686  const ModuleSummaryIndex *ImportSummary)
687  : ModulePass(ID), ExportSummary(ExportSummary),
688  ImportSummary(ImportSummary) {
690  }
691 
692  bool runOnModule(Module &M) override {
693  if (skipModule(M))
694  return false;
695 
696  // In the new pass manager, we can request the optimization
697  // remark emitter pass on a per-function-basis, which the
698  // OREGetter will do for us.
699  // In the old pass manager, this is harder, so we just build
700  // an optimization remark emitter on the fly, when we need it.
701  std::unique_ptr<OptimizationRemarkEmitter> ORE;
702  auto OREGetter = [&](Function *F) -> OptimizationRemarkEmitter & {
703  ORE = std::make_unique<OptimizationRemarkEmitter>(F);
704  return *ORE;
705  };
706 
707  auto LookupDomTree = [this](Function &F) -> DominatorTree & {
708  return this->getAnalysis<DominatorTreeWrapperPass>(F).getDomTree();
709  };
710 
711  if (UseCommandLine)
712  return DevirtModule::runForTesting(M, LegacyAARGetter(*this), OREGetter,
713  LookupDomTree);
714 
715  return DevirtModule(M, LegacyAARGetter(*this), OREGetter, LookupDomTree,
716  ExportSummary, ImportSummary)
717  .run();
718  }
719 
720  void getAnalysisUsage(AnalysisUsage &AU) const override {
724  }
725 };
726 
727 } // end anonymous namespace
728 
729 INITIALIZE_PASS_BEGIN(WholeProgramDevirt, "wholeprogramdevirt",
730  "Whole program devirtualization", false, false)
735  "Whole program devirtualization", false, false)
736 char WholeProgramDevirt::ID = 0;
737 
738 ModulePass *
740  const ModuleSummaryIndex *ImportSummary) {
741  return new WholeProgramDevirt(ExportSummary, ImportSummary);
742 }
743 
745  ModuleAnalysisManager &AM) {
746  auto &FAM = AM.getResult<FunctionAnalysisManagerModuleProxy>(M).getManager();
747  auto AARGetter = [&](Function &F) -> AAResults & {
748  return FAM.getResult<AAManager>(F);
749  };
750  auto OREGetter = [&](Function *F) -> OptimizationRemarkEmitter & {
751  return FAM.getResult<OptimizationRemarkEmitterAnalysis>(*F);
752  };
753  auto LookupDomTree = [&FAM](Function &F) -> DominatorTree & {
754  return FAM.getResult<DominatorTreeAnalysis>(F);
755  };
756  if (UseCommandLine) {
757  if (DevirtModule::runForTesting(M, AARGetter, OREGetter, LookupDomTree))
758  return PreservedAnalyses::all();
759  return PreservedAnalyses::none();
760  }
761  if (!DevirtModule(M, AARGetter, OREGetter, LookupDomTree, ExportSummary,
762  ImportSummary)
763  .run())
764  return PreservedAnalyses::all();
765  return PreservedAnalyses::none();
766 }
767 
768 // Enable whole program visibility if enabled by client (e.g. linker) or
769 // internal option, and not force disabled.
770 static bool hasWholeProgramVisibility(bool WholeProgramVisibilityEnabledInLTO) {
771  return (WholeProgramVisibilityEnabledInLTO || WholeProgramVisibility) &&
773 }
774 
775 namespace llvm {
776 
777 /// If whole program visibility asserted, then upgrade all public vcall
778 /// visibility metadata on vtable definitions to linkage unit visibility in
779 /// Module IR (for regular or hybrid LTO).
781  bool WholeProgramVisibilityEnabledInLTO) {
782  if (!hasWholeProgramVisibility(WholeProgramVisibilityEnabledInLTO))
783  return;
784  for (GlobalVariable &GV : M.globals())
785  // Add linkage unit visibility to any variable with type metadata, which are
786  // the vtable definitions. We won't have an existing vcall_visibility
787  // metadata on vtable definitions with public visibility.
788  if (GV.hasMetadata(LLVMContext::MD_type) &&
789  GV.getVCallVisibility() == GlobalObject::VCallVisibilityPublic)
790  GV.setVCallVisibilityMetadata(GlobalObject::VCallVisibilityLinkageUnit);
791 }
792 
793 /// If whole program visibility asserted, then upgrade all public vcall
794 /// visibility metadata on vtable definition summaries to linkage unit
795 /// visibility in Module summary index (for ThinLTO).
797  bool WholeProgramVisibilityEnabledInLTO) {
798  if (!hasWholeProgramVisibility(WholeProgramVisibilityEnabledInLTO))
799  return;
800  for (auto &P : Index) {
801  for (auto &S : P.second.SummaryList) {
802  auto *GVar = dyn_cast<GlobalVarSummary>(S.get());
803  if (!GVar || GVar->vTableFuncs().empty() ||
804  GVar->getVCallVisibility() != GlobalObject::VCallVisibilityPublic)
805  continue;
807  }
808  }
809 }
810 
812  ModuleSummaryIndex &Summary, std::set<GlobalValue::GUID> &ExportedGUIDs,
813  std::map<ValueInfo, std::vector<VTableSlotSummary>> &LocalWPDTargetsMap) {
814  DevirtIndex(Summary, ExportedGUIDs, LocalWPDTargetsMap).run();
815 }
816 
818  ModuleSummaryIndex &Summary,
819  function_ref<bool(StringRef, ValueInfo)> isExported,
820  std::map<ValueInfo, std::vector<VTableSlotSummary>> &LocalWPDTargetsMap) {
821  for (auto &T : LocalWPDTargetsMap) {
822  auto &VI = T.first;
823  // This was enforced earlier during trySingleImplDevirt.
824  assert(VI.getSummaryList().size() == 1 &&
825  "Devirt of local target has more than one copy");
826  auto &S = VI.getSummaryList()[0];
827  if (!isExported(S->modulePath(), VI))
828  continue;
829 
830  // It's been exported by a cross module import.
831  for (auto &SlotSummary : T.second) {
832  auto *TIdSum = Summary.getTypeIdSummary(SlotSummary.TypeID);
833  assert(TIdSum);
834  auto WPDRes = TIdSum->WPDRes.find(SlotSummary.ByteOffset);
835  assert(WPDRes != TIdSum->WPDRes.end());
836  WPDRes->second.SingleImplName = ModuleSummaryIndex::getGlobalNameForLocal(
837  WPDRes->second.SingleImplName,
838  Summary.getModuleHash(S->modulePath()));
839  }
840  }
841 }
842 
843 } // end namespace llvm
844 
846  // Check that summary index contains regular LTO module when performing
847  // export to prevent occasional use of index from pure ThinLTO compilation
848  // (-fno-split-lto-module). This kind of summary index is passed to
849  // DevirtIndex::run, not to DevirtModule::run used by opt/runForTesting.
850  const auto &ModPaths = Summary->modulePaths();
853  ModPaths.end())
854  return createStringError(
856  "combined summary should contain Regular LTO module");
857  return ErrorSuccess();
858 }
859 
860 bool DevirtModule::runForTesting(
861  Module &M, function_ref<AAResults &(Function &)> AARGetter,
863  function_ref<DominatorTree &(Function &)> LookupDomTree) {
864  std::unique_ptr<ModuleSummaryIndex> Summary =
865  std::make_unique<ModuleSummaryIndex>(/*HaveGVs=*/false);
866 
867  // Handle the command-line summary arguments. This code is for testing
868  // purposes only, so we handle errors directly.
869  if (!ClReadSummary.empty()) {
870  ExitOnError ExitOnErr("-wholeprogramdevirt-read-summary: " + ClReadSummary +
871  ": ");
872  auto ReadSummaryFile =
874  if (Expected<std::unique_ptr<ModuleSummaryIndex>> SummaryOrErr =
875  getModuleSummaryIndex(*ReadSummaryFile)) {
876  Summary = std::move(*SummaryOrErr);
877  ExitOnErr(checkCombinedSummaryForTesting(Summary.get()));
878  } else {
879  // Try YAML if we've failed with bitcode.
880  consumeError(SummaryOrErr.takeError());
881  yaml::Input In(ReadSummaryFile->getBuffer());
882  In >> *Summary;
883  ExitOnErr(errorCodeToError(In.error()));
884  }
885  }
886 
887  bool Changed =
888  DevirtModule(M, AARGetter, OREGetter, LookupDomTree,
889  ClSummaryAction == PassSummaryAction::Export ? Summary.get()
890  : nullptr,
891  ClSummaryAction == PassSummaryAction::Import ? Summary.get()
892  : nullptr)
893  .run();
894 
895  if (!ClWriteSummary.empty()) {
896  ExitOnError ExitOnErr(
897  "-wholeprogramdevirt-write-summary: " + ClWriteSummary + ": ");
898  std::error_code EC;
899  if (StringRef(ClWriteSummary).endswith(".bc")) {
901  ExitOnErr(errorCodeToError(EC));
902  WriteIndexToFile(*Summary, OS);
903  } else {
905  ExitOnErr(errorCodeToError(EC));
906  yaml::Output Out(OS);
907  Out << *Summary;
908  }
909  }
910 
911  return Changed;
912 }
913 
914 void DevirtModule::buildTypeIdentifierMap(
915  std::vector<VTableBits> &Bits,
916  DenseMap<Metadata *, std::set<TypeMemberInfo>> &TypeIdMap) {
918  Bits.reserve(M.getGlobalList().size());
920  for (GlobalVariable &GV : M.globals()) {
921  Types.clear();
922  GV.getMetadata(LLVMContext::MD_type, Types);
923  if (GV.isDeclaration() || Types.empty())
924  continue;
925 
926  VTableBits *&BitsPtr = GVToBits[&GV];
927  if (!BitsPtr) {
928  Bits.emplace_back();
929  Bits.back().GV = &GV;
930  Bits.back().ObjectSize =
931  M.getDataLayout().getTypeAllocSize(GV.getInitializer()->getType());
932  BitsPtr = &Bits.back();
933  }
934 
935  for (MDNode *Type : Types) {
936  auto TypeID = Type->getOperand(1).get();
937 
938  uint64_t Offset =
939  cast<ConstantInt>(
940  cast<ConstantAsMetadata>(Type->getOperand(0))->getValue())
941  ->getZExtValue();
942 
943  TypeIdMap[TypeID].insert({BitsPtr, Offset});
944  }
945  }
946 }
947 
948 bool DevirtModule::tryFindVirtualCallTargets(
949  std::vector<VirtualCallTarget> &TargetsForSlot,
950  const std::set<TypeMemberInfo> &TypeMemberInfos, uint64_t ByteOffset) {
951  for (const TypeMemberInfo &TM : TypeMemberInfos) {
952  if (!TM.Bits->GV->isConstant())
953  return false;
954 
955  // We cannot perform whole program devirtualization analysis on a vtable
956  // with public LTO visibility.
957  if (TM.Bits->GV->getVCallVisibility() ==
959  return false;
960 
962  TM.Offset + ByteOffset, M);
963  if (!Ptr)
964  return false;
965 
966  auto Fn = dyn_cast<Function>(Ptr->stripPointerCasts());
967  if (!Fn)
968  return false;
969 
970  if (FunctionsToSkip.match(Fn->getName()))
971  return false;
972 
973  // We can disregard __cxa_pure_virtual as a possible call target, as
974  // calls to pure virtuals are UB.
975  if (Fn->getName() == "__cxa_pure_virtual")
976  continue;
977 
978  TargetsForSlot.push_back({Fn, &TM});
979  }
980 
981  // Give up if we couldn't find any targets.
982  return !TargetsForSlot.empty();
983 }
984 
985 bool DevirtIndex::tryFindVirtualCallTargets(
986  std::vector<ValueInfo> &TargetsForSlot, const TypeIdCompatibleVtableInfo TIdInfo,
987  uint64_t ByteOffset) {
988  for (const TypeIdOffsetVtableInfo &P : TIdInfo) {
989  // Find the first non-available_externally linkage vtable initializer.
990  // We can have multiple available_externally, linkonce_odr and weak_odr
991  // vtable initializers, however we want to skip available_externally as they
992  // do not have type metadata attached, and therefore the summary will not
993  // contain any vtable functions. We can also have multiple external
994  // vtable initializers in the case of comdats, which we cannot check here.
995  // The linker should give an error in this case.
996  //
997  // Also, handle the case of same-named local Vtables with the same path
998  // and therefore the same GUID. This can happen if there isn't enough
999  // distinguishing path when compiling the source file. In that case we
1000  // conservatively return false early.
1001  const GlobalVarSummary *VS = nullptr;
1002  bool LocalFound = false;
1003  for (auto &S : P.VTableVI.getSummaryList()) {
1004  if (GlobalValue::isLocalLinkage(S->linkage())) {
1005  if (LocalFound)
1006  return false;
1007  LocalFound = true;
1008  }
1009  if (!GlobalValue::isAvailableExternallyLinkage(S->linkage())) {
1010  VS = cast<GlobalVarSummary>(S->getBaseObject());
1011  // We cannot perform whole program devirtualization analysis on a vtable
1012  // with public LTO visibility.
1014  return false;
1015  }
1016  }
1017  if (!VS->isLive())
1018  continue;
1019  for (auto VTP : VS->vTableFuncs()) {
1020  if (VTP.VTableOffset != P.AddressPointOffset + ByteOffset)
1021  continue;
1022 
1023  TargetsForSlot.push_back(VTP.FuncVI);
1024  }
1025  }
1026 
1027  // Give up if we couldn't find any targets.
1028  return !TargetsForSlot.empty();
1029 }
1030 
1031 void DevirtModule::applySingleImplDevirt(VTableSlotInfo &SlotInfo,
1032  Constant *TheFn, bool &IsExported) {
1033  auto Apply = [&](CallSiteInfo &CSInfo) {
1034  for (auto &&VCallSite : CSInfo.CallSites) {
1035  if (RemarksEnabled)
1036  VCallSite.emitRemark("single-impl",
1037  TheFn->stripPointerCasts()->getName(), OREGetter);
1038  VCallSite.CB.setCalledOperand(ConstantExpr::getBitCast(
1039  TheFn, VCallSite.CB.getCalledOperand()->getType()));
1040  // This use is no longer unsafe.
1041  if (VCallSite.NumUnsafeUses)
1042  --*VCallSite.NumUnsafeUses;
1043  }
1044  if (CSInfo.isExported())
1045  IsExported = true;
1046  CSInfo.markDevirt();
1047  };
1048  Apply(SlotInfo.CSInfo);
1049  for (auto &P : SlotInfo.ConstCSInfo)
1050  Apply(P.second);
1051 }
1052 
1053 static bool AddCalls(VTableSlotInfo &SlotInfo, const ValueInfo &Callee) {
1054  // We can't add calls if we haven't seen a definition
1055  if (Callee.getSummaryList().empty())
1056  return false;
1057 
1058  // Insert calls into the summary index so that the devirtualized targets
1059  // are eligible for import.
1060  // FIXME: Annotate type tests with hotness. For now, mark these as hot
1061  // to better ensure we have the opportunity to inline them.
1062  bool IsExported = false;
1063  auto &S = Callee.getSummaryList()[0];
1064  CalleeInfo CI(CalleeInfo::HotnessType::Hot, /* RelBF = */ 0);
1065  auto AddCalls = [&](CallSiteInfo &CSInfo) {
1066  for (auto *FS : CSInfo.SummaryTypeCheckedLoadUsers) {
1067  FS->addCall({Callee, CI});
1068  IsExported |= S->modulePath() != FS->modulePath();
1069  }
1070  for (auto *FS : CSInfo.SummaryTypeTestAssumeUsers) {
1071  FS->addCall({Callee, CI});
1072  IsExported |= S->modulePath() != FS->modulePath();
1073  }
1074  };
1075  AddCalls(SlotInfo.CSInfo);
1076  for (auto &P : SlotInfo.ConstCSInfo)
1077  AddCalls(P.second);
1078  return IsExported;
1079 }
1080 
1081 bool DevirtModule::trySingleImplDevirt(
1082  ModuleSummaryIndex *ExportSummary,
1083  MutableArrayRef<VirtualCallTarget> TargetsForSlot, VTableSlotInfo &SlotInfo,
1085  // See if the program contains a single implementation of this virtual
1086  // function.
1087  Function *TheFn = TargetsForSlot[0].Fn;
1088  for (auto &&Target : TargetsForSlot)
1089  if (TheFn != Target.Fn)
1090  return false;
1091 
1092  // If so, update each call site to call that implementation directly.
1093  if (RemarksEnabled)
1094  TargetsForSlot[0].WasDevirt = true;
1095 
1096  bool IsExported = false;
1097  applySingleImplDevirt(SlotInfo, TheFn, IsExported);
1098  if (!IsExported)
1099  return false;
1100 
1101  // If the only implementation has local linkage, we must promote to external
1102  // to make it visible to thin LTO objects. We can only get here during the
1103  // ThinLTO export phase.
1104  if (TheFn->hasLocalLinkage()) {
1105  std::string NewName = (TheFn->getName() + "$merged").str();
1106 
1107  // Since we are renaming the function, any comdats with the same name must
1108  // also be renamed. This is required when targeting COFF, as the comdat name
1109  // must match one of the names of the symbols in the comdat.
1110  if (Comdat *C = TheFn->getComdat()) {
1111  if (C->getName() == TheFn->getName()) {
1112  Comdat *NewC = M.getOrInsertComdat(NewName);
1113  NewC->setSelectionKind(C->getSelectionKind());
1114  for (GlobalObject &GO : M.global_objects())
1115  if (GO.getComdat() == C)
1116  GO.setComdat(NewC);
1117  }
1118  }
1119 
1122  TheFn->setName(NewName);
1123  }
1124  if (ValueInfo TheFnVI = ExportSummary->getValueInfo(TheFn->getGUID()))
1125  // Any needed promotion of 'TheFn' has already been done during
1126  // LTO unit split, so we can ignore return value of AddCalls.
1127  AddCalls(SlotInfo, TheFnVI);
1128 
1130  Res->SingleImplName = std::string(TheFn->getName());
1131 
1132  return true;
1133 }
1134 
1135 bool DevirtIndex::trySingleImplDevirt(MutableArrayRef<ValueInfo> TargetsForSlot,
1136  VTableSlotSummary &SlotSummary,
1137  VTableSlotInfo &SlotInfo,
1139  std::set<ValueInfo> &DevirtTargets) {
1140  // See if the program contains a single implementation of this virtual
1141  // function.
1142  auto TheFn = TargetsForSlot[0];
1143  for (auto &&Target : TargetsForSlot)
1144  if (TheFn != Target)
1145  return false;
1146 
1147  // Don't devirtualize if we don't have target definition.
1148  auto Size = TheFn.getSummaryList().size();
1149  if (!Size)
1150  return false;
1151 
1152  // Don't devirtualize function if we're told to skip it
1153  // in -wholeprogramdevirt-skip.
1154  if (FunctionsToSkip.match(TheFn.name()))
1155  return false;
1156 
1157  // If the summary list contains multiple summaries where at least one is
1158  // a local, give up, as we won't know which (possibly promoted) name to use.
1159  for (auto &S : TheFn.getSummaryList())
1160  if (GlobalValue::isLocalLinkage(S->linkage()) && Size > 1)
1161  return false;
1162 
1163  // Collect functions devirtualized at least for one call site for stats.
1164  if (PrintSummaryDevirt)
1165  DevirtTargets.insert(TheFn);
1166 
1167  auto &S = TheFn.getSummaryList()[0];
1168  bool IsExported = AddCalls(SlotInfo, TheFn);
1169  if (IsExported)
1170  ExportedGUIDs.insert(TheFn.getGUID());
1171 
1172  // Record in summary for use in devirtualization during the ThinLTO import
1173  // step.
1175  if (GlobalValue::isLocalLinkage(S->linkage())) {
1176  if (IsExported)
1177  // If target is a local function and we are exporting it by
1178  // devirtualizing a call in another module, we need to record the
1179  // promoted name.
1181  TheFn.name(), ExportSummary.getModuleHash(S->modulePath()));
1182  else {
1183  LocalWPDTargetsMap[TheFn].push_back(SlotSummary);
1184  Res->SingleImplName = std::string(TheFn.name());
1185  }
1186  } else
1187  Res->SingleImplName = std::string(TheFn.name());
1188 
1189  // Name will be empty if this thin link driven off of serialized combined
1190  // index (e.g. llvm-lto). However, WPD is not supported/invoked for the
1191  // legacy LTO API anyway.
1192  assert(!Res->SingleImplName.empty());
1193 
1194  return true;
1195 }
1196 
1197 void DevirtModule::tryICallBranchFunnel(
1198  MutableArrayRef<VirtualCallTarget> TargetsForSlot, VTableSlotInfo &SlotInfo,
1199  WholeProgramDevirtResolution *Res, VTableSlot Slot) {
1200  Triple T(M.getTargetTriple());
1201  if (T.getArch() != Triple::x86_64)
1202  return;
1203 
1204  if (TargetsForSlot.size() > ClThreshold)
1205  return;
1206 
1207  bool HasNonDevirt = !SlotInfo.CSInfo.AllCallSitesDevirted;
1208  if (!HasNonDevirt)
1209  for (auto &P : SlotInfo.ConstCSInfo)
1210  if (!P.second.AllCallSitesDevirted) {
1211  HasNonDevirt = true;
1212  break;
1213  }
1214 
1215  if (!HasNonDevirt)
1216  return;
1217 
1218  FunctionType *FT =
1219  FunctionType::get(Type::getVoidTy(M.getContext()), {Int8PtrTy}, true);
1220  Function *JT;
1221  if (isa<MDString>(Slot.TypeID)) {
1224  getGlobalName(Slot, {}, "branch_funnel"), &M);
1225  JT->setVisibility(GlobalValue::HiddenVisibility);
1226  } else {
1229  "branch_funnel", &M);
1230  }
1231  JT->addAttribute(1, Attribute::Nest);
1232 
1233  std::vector<Value *> JTArgs;
1234  JTArgs.push_back(JT->arg_begin());
1235  for (auto &T : TargetsForSlot) {
1236  JTArgs.push_back(getMemberAddr(T.TM));
1237  JTArgs.push_back(T.Fn);
1238  }
1239 
1240  BasicBlock *BB = BasicBlock::Create(M.getContext(), "", JT, nullptr);
1241  Function *Intr =
1242  Intrinsic::getDeclaration(&M, llvm::Intrinsic::icall_branch_funnel, {});
1243 
1244  auto *CI = CallInst::Create(Intr, JTArgs, "", BB);
1245  CI->setTailCallKind(CallInst::TCK_MustTail);
1246  ReturnInst::Create(M.getContext(), nullptr, BB);
1247 
1248  bool IsExported = false;
1249  applyICallBranchFunnel(SlotInfo, JT, IsExported);
1250  if (IsExported)
1252 }
1253 
1254 void DevirtModule::applyICallBranchFunnel(VTableSlotInfo &SlotInfo,
1255  Constant *JT, bool &IsExported) {
1256  auto Apply = [&](CallSiteInfo &CSInfo) {
1257  if (CSInfo.isExported())
1258  IsExported = true;
1259  if (CSInfo.AllCallSitesDevirted)
1260  return;
1261  for (auto &&VCallSite : CSInfo.CallSites) {
1262  CallBase &CB = VCallSite.CB;
1263 
1264  // Jump tables are only profitable if the retpoline mitigation is enabled.
1265  Attribute FSAttr = CB.getCaller()->getFnAttribute("target-features");
1266  if (!FSAttr.isValid() ||
1267  !FSAttr.getValueAsString().contains("+retpoline"))
1268  continue;
1269 
1270  if (RemarksEnabled)
1271  VCallSite.emitRemark("branch-funnel",
1272  JT->stripPointerCasts()->getName(), OREGetter);
1273 
1274  // Pass the address of the vtable in the nest register, which is r10 on
1275  // x86_64.
1276  std::vector<Type *> NewArgs;
1277  NewArgs.push_back(Int8PtrTy);
1278  for (Type *T : CB.getFunctionType()->params())
1279  NewArgs.push_back(T);
1280  FunctionType *NewFT =
1282  CB.getFunctionType()->isVarArg());
1283  PointerType *NewFTPtr = PointerType::getUnqual(NewFT);
1284 
1285  IRBuilder<> IRB(&CB);
1286  std::vector<Value *> Args;
1287  Args.push_back(IRB.CreateBitCast(VCallSite.VTable, Int8PtrTy));
1288  Args.insert(Args.end(), CB.arg_begin(), CB.arg_end());
1289 
1290  CallBase *NewCS = nullptr;
1291  if (isa<CallInst>(CB))
1292  NewCS = IRB.CreateCall(NewFT, IRB.CreateBitCast(JT, NewFTPtr), Args);
1293  else
1294  NewCS = IRB.CreateInvoke(NewFT, IRB.CreateBitCast(JT, NewFTPtr),
1295  cast<InvokeInst>(CB).getNormalDest(),
1296  cast<InvokeInst>(CB).getUnwindDest(), Args);
1297  NewCS->setCallingConv(CB.getCallingConv());
1298 
1300  std::vector<AttributeSet> NewArgAttrs;
1301  NewArgAttrs.push_back(AttributeSet::get(
1303  M.getContext(), Attribute::Nest)}));
1304  for (unsigned I = 0; I + 2 < Attrs.getNumAttrSets(); ++I)
1305  NewArgAttrs.push_back(Attrs.getParamAttributes(I));
1306  NewCS->setAttributes(
1308  Attrs.getRetAttributes(), NewArgAttrs));
1309 
1310  CB.replaceAllUsesWith(NewCS);
1311  CB.eraseFromParent();
1312 
1313  // This use is no longer unsafe.
1314  if (VCallSite.NumUnsafeUses)
1315  --*VCallSite.NumUnsafeUses;
1316  }
1317  // Don't mark as devirtualized because there may be callers compiled without
1318  // retpoline mitigation, which would mean that they are lowered to
1319  // llvm.type.test and therefore require an llvm.type.test resolution for the
1320  // type identifier.
1321  };
1322  Apply(SlotInfo.CSInfo);
1323  for (auto &P : SlotInfo.ConstCSInfo)
1324  Apply(P.second);
1325 }
1326 
1327 bool DevirtModule::tryEvaluateFunctionsWithArgs(
1328  MutableArrayRef<VirtualCallTarget> TargetsForSlot,
1330  // Evaluate each function and store the result in each target's RetVal
1331  // field.
1332  for (VirtualCallTarget &Target : TargetsForSlot) {
1333  if (Target.Fn->arg_size() != Args.size() + 1)
1334  return false;
1335 
1336  Evaluator Eval(M.getDataLayout(), nullptr);
1337  SmallVector<Constant *, 2> EvalArgs;
1338  EvalArgs.push_back(
1339  Constant::getNullValue(Target.Fn->getFunctionType()->getParamType(0)));
1340  for (unsigned I = 0; I != Args.size(); ++I) {
1341  auto *ArgTy = dyn_cast<IntegerType>(
1342  Target.Fn->getFunctionType()->getParamType(I + 1));
1343  if (!ArgTy)
1344  return false;
1345  EvalArgs.push_back(ConstantInt::get(ArgTy, Args[I]));
1346  }
1347 
1348  Constant *RetVal;
1349  if (!Eval.EvaluateFunction(Target.Fn, RetVal, EvalArgs) ||
1350  !isa<ConstantInt>(RetVal))
1351  return false;
1352  Target.RetVal = cast<ConstantInt>(RetVal)->getZExtValue();
1353  }
1354  return true;
1355 }
1356 
1357 void DevirtModule::applyUniformRetValOpt(CallSiteInfo &CSInfo, StringRef FnName,
1358  uint64_t TheRetVal) {
1359  for (auto Call : CSInfo.CallSites)
1360  Call.replaceAndErase(
1361  "uniform-ret-val", FnName, RemarksEnabled, OREGetter,
1362  ConstantInt::get(cast<IntegerType>(Call.CB.getType()), TheRetVal));
1363  CSInfo.markDevirt();
1364 }
1365 
1366 bool DevirtModule::tryUniformRetValOpt(
1367  MutableArrayRef<VirtualCallTarget> TargetsForSlot, CallSiteInfo &CSInfo,
1369  // Uniform return value optimization. If all functions return the same
1370  // constant, replace all calls with that constant.
1371  uint64_t TheRetVal = TargetsForSlot[0].RetVal;
1372  for (const VirtualCallTarget &Target : TargetsForSlot)
1373  if (Target.RetVal != TheRetVal)
1374  return false;
1375 
1376  if (CSInfo.isExported()) {
1378  Res->Info = TheRetVal;
1379  }
1380 
1381  applyUniformRetValOpt(CSInfo, TargetsForSlot[0].Fn->getName(), TheRetVal);
1382  if (RemarksEnabled)
1383  for (auto &&Target : TargetsForSlot)
1384  Target.WasDevirt = true;
1385  return true;
1386 }
1387 
1388 std::string DevirtModule::getGlobalName(VTableSlot Slot,
1389  ArrayRef<uint64_t> Args,
1390  StringRef Name) {
1391  std::string FullName = "__typeid_";
1392  raw_string_ostream OS(FullName);
1393  OS << cast<MDString>(Slot.TypeID)->getString() << '_' << Slot.ByteOffset;
1394  for (uint64_t Arg : Args)
1395  OS << '_' << Arg;
1396  OS << '_' << Name;
1397  return OS.str();
1398 }
1399 
1400 bool DevirtModule::shouldExportConstantsAsAbsoluteSymbols() {
1401  Triple T(M.getTargetTriple());
1402  return T.isX86() && T.getObjectFormat() == Triple::ELF;
1403 }
1404 
1405 void DevirtModule::exportGlobal(VTableSlot Slot, ArrayRef<uint64_t> Args,
1406  StringRef Name, Constant *C) {
1408  getGlobalName(Slot, Args, Name), C, &M);
1410 }
1411 
1412 void DevirtModule::exportConstant(VTableSlot Slot, ArrayRef<uint64_t> Args,
1413  StringRef Name, uint32_t Const,
1414  uint32_t &Storage) {
1415  if (shouldExportConstantsAsAbsoluteSymbols()) {
1416  exportGlobal(
1417  Slot, Args, Name,
1418  ConstantExpr::getIntToPtr(ConstantInt::get(Int32Ty, Const), Int8PtrTy));
1419  return;
1420  }
1421 
1422  Storage = Const;
1423 }
1424 
1425 Constant *DevirtModule::importGlobal(VTableSlot Slot, ArrayRef<uint64_t> Args,
1426  StringRef Name) {
1427  Constant *C =
1428  M.getOrInsertGlobal(getGlobalName(Slot, Args, Name), Int8Arr0Ty);
1429  auto *GV = dyn_cast<GlobalVariable>(C);
1430  if (GV)
1432  return C;
1433 }
1434 
1435 Constant *DevirtModule::importConstant(VTableSlot Slot, ArrayRef<uint64_t> Args,
1436  StringRef Name, IntegerType *IntTy,
1437  uint32_t Storage) {
1438  if (!shouldExportConstantsAsAbsoluteSymbols())
1439  return ConstantInt::get(IntTy, Storage);
1440 
1441  Constant *C = importGlobal(Slot, Args, Name);
1442  auto *GV = cast<GlobalVariable>(C->stripPointerCasts());
1443  C = ConstantExpr::getPtrToInt(C, IntTy);
1444 
1445  // We only need to set metadata if the global is newly created, in which
1446  // case it would not have hidden visibility.
1447  if (GV->hasMetadata(LLVMContext::MD_absolute_symbol))
1448  return C;
1449 
1450  auto SetAbsRange = [&](uint64_t Min, uint64_t Max) {
1451  auto *MinC = ConstantAsMetadata::get(ConstantInt::get(IntPtrTy, Min));
1452  auto *MaxC = ConstantAsMetadata::get(ConstantInt::get(IntPtrTy, Max));
1453  GV->setMetadata(LLVMContext::MD_absolute_symbol,
1454  MDNode::get(M.getContext(), {MinC, MaxC}));
1455  };
1456  unsigned AbsWidth = IntTy->getBitWidth();
1457  if (AbsWidth == IntPtrTy->getBitWidth())
1458  SetAbsRange(~0ull, ~0ull); // Full set.
1459  else
1460  SetAbsRange(0, 1ull << AbsWidth);
1461  return C;
1462 }
1463 
1464 void DevirtModule::applyUniqueRetValOpt(CallSiteInfo &CSInfo, StringRef FnName,
1465  bool IsOne,
1466  Constant *UniqueMemberAddr) {
1467  for (auto &&Call : CSInfo.CallSites) {
1468  IRBuilder<> B(&Call.CB);
1469  Value *Cmp =
1470  B.CreateICmp(IsOne ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_NE, Call.VTable,
1471  B.CreateBitCast(UniqueMemberAddr, Call.VTable->getType()));
1472  Cmp = B.CreateZExt(Cmp, Call.CB.getType());
1473  Call.replaceAndErase("unique-ret-val", FnName, RemarksEnabled, OREGetter,
1474  Cmp);
1475  }
1476  CSInfo.markDevirt();
1477 }
1478 
1479 Constant *DevirtModule::getMemberAddr(const TypeMemberInfo *M) {
1480  Constant *C = ConstantExpr::getBitCast(M->Bits->GV, Int8PtrTy);
1481  return ConstantExpr::getGetElementPtr(Int8Ty, C,
1482  ConstantInt::get(Int64Ty, M->Offset));
1483 }
1484 
1485 bool DevirtModule::tryUniqueRetValOpt(
1486  unsigned BitWidth, MutableArrayRef<VirtualCallTarget> TargetsForSlot,
1487  CallSiteInfo &CSInfo, WholeProgramDevirtResolution::ByArg *Res,
1488  VTableSlot Slot, ArrayRef<uint64_t> Args) {
1489  // IsOne controls whether we look for a 0 or a 1.
1490  auto tryUniqueRetValOptFor = [&](bool IsOne) {
1491  const TypeMemberInfo *UniqueMember = nullptr;
1492  for (const VirtualCallTarget &Target : TargetsForSlot) {
1493  if (Target.RetVal == (IsOne ? 1 : 0)) {
1494  if (UniqueMember)
1495  return false;
1496  UniqueMember = Target.TM;
1497  }
1498  }
1499 
1500  // We should have found a unique member or bailed out by now. We already
1501  // checked for a uniform return value in tryUniformRetValOpt.
1502  assert(UniqueMember);
1503 
1504  Constant *UniqueMemberAddr = getMemberAddr(UniqueMember);
1505  if (CSInfo.isExported()) {
1507  Res->Info = IsOne;
1508 
1509  exportGlobal(Slot, Args, "unique_member", UniqueMemberAddr);
1510  }
1511 
1512  // Replace each call with the comparison.
1513  applyUniqueRetValOpt(CSInfo, TargetsForSlot[0].Fn->getName(), IsOne,
1514  UniqueMemberAddr);
1515 
1516  // Update devirtualization statistics for targets.
1517  if (RemarksEnabled)
1518  for (auto &&Target : TargetsForSlot)
1519  Target.WasDevirt = true;
1520 
1521  return true;
1522  };
1523 
1524  if (BitWidth == 1) {
1525  if (tryUniqueRetValOptFor(true))
1526  return true;
1527  if (tryUniqueRetValOptFor(false))
1528  return true;
1529  }
1530  return false;
1531 }
1532 
1533 void DevirtModule::applyVirtualConstProp(CallSiteInfo &CSInfo, StringRef FnName,
1534  Constant *Byte, Constant *Bit) {
1535  for (auto Call : CSInfo.CallSites) {
1536  auto *RetType = cast<IntegerType>(Call.CB.getType());
1537  IRBuilder<> B(&Call.CB);
1538  Value *Addr =
1539  B.CreateGEP(Int8Ty, B.CreateBitCast(Call.VTable, Int8PtrTy), Byte);
1540  if (RetType->getBitWidth() == 1) {
1541  Value *Bits = B.CreateLoad(Int8Ty, Addr);
1542  Value *BitsAndBit = B.CreateAnd(Bits, Bit);
1543  auto IsBitSet = B.CreateICmpNE(BitsAndBit, ConstantInt::get(Int8Ty, 0));
1544  Call.replaceAndErase("virtual-const-prop-1-bit", FnName, RemarksEnabled,
1545  OREGetter, IsBitSet);
1546  } else {
1547  Value *ValAddr = B.CreateBitCast(Addr, RetType->getPointerTo());
1548  Value *Val = B.CreateLoad(RetType, ValAddr);
1549  Call.replaceAndErase("virtual-const-prop", FnName, RemarksEnabled,
1550  OREGetter, Val);
1551  }
1552  }
1553  CSInfo.markDevirt();
1554 }
1555 
1556 bool DevirtModule::tryVirtualConstProp(
1557  MutableArrayRef<VirtualCallTarget> TargetsForSlot, VTableSlotInfo &SlotInfo,
1558  WholeProgramDevirtResolution *Res, VTableSlot Slot) {
1559  // This only works if the function returns an integer.
1560  auto RetType = dyn_cast<IntegerType>(TargetsForSlot[0].Fn->getReturnType());
1561  if (!RetType)
1562  return false;
1563  unsigned BitWidth = RetType->getBitWidth();
1564  if (BitWidth > 64)
1565  return false;
1566 
1567  // Make sure that each function is defined, does not access memory, takes at
1568  // least one argument, does not use its first argument (which we assume is
1569  // 'this'), and has the same return type.
1570  //
1571  // Note that we test whether this copy of the function is readnone, rather
1572  // than testing function attributes, which must hold for any copy of the
1573  // function, even a less optimized version substituted at link time. This is
1574  // sound because the virtual constant propagation optimizations effectively
1575  // inline all implementations of the virtual function into each call site,
1576  // rather than using function attributes to perform local optimization.
1577  for (VirtualCallTarget &Target : TargetsForSlot) {
1578  if (Target.Fn->isDeclaration() ||
1579  computeFunctionBodyMemoryAccess(*Target.Fn, AARGetter(*Target.Fn)) !=
1580  MAK_ReadNone ||
1581  Target.Fn->arg_empty() || !Target.Fn->arg_begin()->use_empty() ||
1582  Target.Fn->getReturnType() != RetType)
1583  return false;
1584  }
1585 
1586  for (auto &&CSByConstantArg : SlotInfo.ConstCSInfo) {
1587  if (!tryEvaluateFunctionsWithArgs(TargetsForSlot, CSByConstantArg.first))
1588  continue;
1589 
1590  WholeProgramDevirtResolution::ByArg *ResByArg = nullptr;
1591  if (Res)
1592  ResByArg = &Res->ResByArg[CSByConstantArg.first];
1593 
1594  if (tryUniformRetValOpt(TargetsForSlot, CSByConstantArg.second, ResByArg))
1595  continue;
1596 
1597  if (tryUniqueRetValOpt(BitWidth, TargetsForSlot, CSByConstantArg.second,
1598  ResByArg, Slot, CSByConstantArg.first))
1599  continue;
1600 
1601  // Find an allocation offset in bits in all vtables associated with the
1602  // type.
1603  uint64_t AllocBefore =
1604  findLowestOffset(TargetsForSlot, /*IsAfter=*/false, BitWidth);
1605  uint64_t AllocAfter =
1606  findLowestOffset(TargetsForSlot, /*IsAfter=*/true, BitWidth);
1607 
1608  // Calculate the total amount of padding needed to store a value at both
1609  // ends of the object.
1610  uint64_t TotalPaddingBefore = 0, TotalPaddingAfter = 0;
1611  for (auto &&Target : TargetsForSlot) {
1612  TotalPaddingBefore += std::max<int64_t>(
1613  (AllocBefore + 7) / 8 - Target.allocatedBeforeBytes() - 1, 0);
1614  TotalPaddingAfter += std::max<int64_t>(
1615  (AllocAfter + 7) / 8 - Target.allocatedAfterBytes() - 1, 0);
1616  }
1617 
1618  // If the amount of padding is too large, give up.
1619  // FIXME: do something smarter here.
1620  if (std::min(TotalPaddingBefore, TotalPaddingAfter) > 128)
1621  continue;
1622 
1623  // Calculate the offset to the value as a (possibly negative) byte offset
1624  // and (if applicable) a bit offset, and store the values in the targets.
1625  int64_t OffsetByte;
1626  uint64_t OffsetBit;
1627  if (TotalPaddingBefore <= TotalPaddingAfter)
1628  setBeforeReturnValues(TargetsForSlot, AllocBefore, BitWidth, OffsetByte,
1629  OffsetBit);
1630  else
1631  setAfterReturnValues(TargetsForSlot, AllocAfter, BitWidth, OffsetByte,
1632  OffsetBit);
1633 
1634  if (RemarksEnabled)
1635  for (auto &&Target : TargetsForSlot)
1636  Target.WasDevirt = true;
1637 
1638 
1639  if (CSByConstantArg.second.isExported()) {
1641  exportConstant(Slot, CSByConstantArg.first, "byte", OffsetByte,
1642  ResByArg->Byte);
1643  exportConstant(Slot, CSByConstantArg.first, "bit", 1ULL << OffsetBit,
1644  ResByArg->Bit);
1645  }
1646 
1647  // Rewrite each call to a load from OffsetByte/OffsetBit.
1648  Constant *ByteConst = ConstantInt::get(Int32Ty, OffsetByte);
1649  Constant *BitConst = ConstantInt::get(Int8Ty, 1ULL << OffsetBit);
1650  applyVirtualConstProp(CSByConstantArg.second,
1651  TargetsForSlot[0].Fn->getName(), ByteConst, BitConst);
1652  }
1653  return true;
1654 }
1655 
1656 void DevirtModule::rebuildGlobal(VTableBits &B) {
1657  if (B.Before.Bytes.empty() && B.After.Bytes.empty())
1658  return;
1659 
1660  // Align the before byte array to the global's minimum alignment so that we
1661  // don't break any alignment requirements on the global.
1662  Align Alignment = M.getDataLayout().getValueOrABITypeAlignment(
1663  B.GV->getAlign(), B.GV->getValueType());
1664  B.Before.Bytes.resize(alignTo(B.Before.Bytes.size(), Alignment));
1665 
1666  // Before was stored in reverse order; flip it now.
1667  for (size_t I = 0, Size = B.Before.Bytes.size(); I != Size / 2; ++I)
1668  std::swap(B.Before.Bytes[I], B.Before.Bytes[Size - 1 - I]);
1669 
1670  // Build an anonymous global containing the before bytes, followed by the
1671  // original initializer, followed by the after bytes.
1672  auto NewInit = ConstantStruct::getAnon(
1673  {ConstantDataArray::get(M.getContext(), B.Before.Bytes),
1674  B.GV->getInitializer(),
1675  ConstantDataArray::get(M.getContext(), B.After.Bytes)});
1676  auto NewGV =
1677  new GlobalVariable(M, NewInit->getType(), B.GV->isConstant(),
1678  GlobalVariable::PrivateLinkage, NewInit, "", B.GV);
1679  NewGV->setSection(B.GV->getSection());
1680  NewGV->setComdat(B.GV->getComdat());
1681  NewGV->setAlignment(MaybeAlign(B.GV->getAlignment()));
1682 
1683  // Copy the original vtable's metadata to the anonymous global, adjusting
1684  // offsets as required.
1685  NewGV->copyMetadata(B.GV, B.Before.Bytes.size());
1686 
1687  // Build an alias named after the original global, pointing at the second
1688  // element (the original initializer).
1689  auto Alias = GlobalAlias::create(
1690  B.GV->getInitializer()->getType(), 0, B.GV->getLinkage(), "",
1692  NewInit->getType(), NewGV,
1694  ConstantInt::get(Int32Ty, 1)}),
1695  &M);
1696  Alias->setVisibility(B.GV->getVisibility());
1697  Alias->takeName(B.GV);
1698 
1699  B.GV->replaceAllUsesWith(Alias);
1700  B.GV->eraseFromParent();
1701 }
1702 
1703 bool DevirtModule::areRemarksEnabled() {
1704  const auto &FL = M.getFunctionList();
1705  for (const Function &Fn : FL) {
1706  const auto &BBL = Fn.getBasicBlockList();
1707  if (BBL.empty())
1708  continue;
1709  auto DI = OptimizationRemark(DEBUG_TYPE, "", DebugLoc(), &BBL.front());
1710  return DI.isEnabled();
1711  }
1712  return false;
1713 }
1714 
1715 void DevirtModule::scanTypeTestUsers(
1716  Function *TypeTestFunc,
1717  DenseMap<Metadata *, std::set<TypeMemberInfo>> &TypeIdMap) {
1718  // Find all virtual calls via a virtual table pointer %p under an assumption
1719  // of the form llvm.assume(llvm.type.test(%p, %md)). This indicates that %p
1720  // points to a member of the type identifier %md. Group calls by (type ID,
1721  // offset) pair (effectively the identity of the virtual function) and store
1722  // to CallSlots.
1723  for (auto I = TypeTestFunc->use_begin(), E = TypeTestFunc->use_end();
1724  I != E;) {
1725  auto CI = dyn_cast<CallInst>(I->getUser());
1726  ++I;
1727  if (!CI)
1728  continue;
1729 
1730  // Search for virtual calls based on %p and add them to DevirtCalls.
1731  SmallVector<DevirtCallSite, 1> DevirtCalls;
1733  auto &DT = LookupDomTree(*CI->getFunction());
1734  findDevirtualizableCallsForTypeTest(DevirtCalls, Assumes, CI, DT);
1735 
1736  Metadata *TypeId =
1737  cast<MetadataAsValue>(CI->getArgOperand(1))->getMetadata();
1738  // If we found any, add them to CallSlots.
1739  if (!Assumes.empty()) {
1740  Value *Ptr = CI->getArgOperand(0)->stripPointerCasts();
1741  for (DevirtCallSite Call : DevirtCalls)
1742  CallSlots[{TypeId, Call.Offset}].addCallSite(Ptr, Call.CB, nullptr);
1743  }
1744 
1745  auto RemoveTypeTestAssumes = [&]() {
1746  // We no longer need the assumes or the type test.
1747  for (auto Assume : Assumes)
1748  Assume->eraseFromParent();
1749  // We can't use RecursivelyDeleteTriviallyDeadInstructions here because we
1750  // may use the vtable argument later.
1751  if (CI->use_empty())
1752  CI->eraseFromParent();
1753  };
1754 
1755  // At this point we could remove all type test assume sequences, as they
1756  // were originally inserted for WPD. However, we can keep these in the
1757  // code stream for later analysis (e.g. to help drive more efficient ICP
1758  // sequences). They will eventually be removed by a second LowerTypeTests
1759  // invocation that cleans them up. In order to do this correctly, the first
1760  // LowerTypeTests invocation needs to know that they have "Unknown" type
1761  // test resolution, so that they aren't treated as Unsat and lowered to
1762  // False, which will break any uses on assumes. Below we remove any type
1763  // test assumes that will not be treated as Unknown by LTT.
1764 
1765  // The type test assumes will be treated by LTT as Unsat if the type id is
1766  // not used on a global (in which case it has no entry in the TypeIdMap).
1767  if (!TypeIdMap.count(TypeId))
1768  RemoveTypeTestAssumes();
1769 
1770  // For ThinLTO importing, we need to remove the type test assumes if this is
1771  // an MDString type id without a corresponding TypeIdSummary. Any
1772  // non-MDString type ids are ignored and treated as Unknown by LTT, so their
1773  // type test assumes can be kept. If the MDString type id is missing a
1774  // TypeIdSummary (e.g. because there was no use on a vcall, preventing the
1775  // exporting phase of WPD from analyzing it), then it would be treated as
1776  // Unsat by LTT and we need to remove its type test assumes here. If not
1777  // used on a vcall we don't need them for later optimization use in any
1778  // case.
1779  else if (ImportSummary && isa<MDString>(TypeId)) {
1780  const TypeIdSummary *TidSummary =
1781  ImportSummary->getTypeIdSummary(cast<MDString>(TypeId)->getString());
1782  if (!TidSummary)
1783  RemoveTypeTestAssumes();
1784  else
1785  // If one was created it should not be Unsat, because if we reached here
1786  // the type id was used on a global.
1788  }
1789  }
1790 }
1791 
1792 void DevirtModule::scanTypeCheckedLoadUsers(Function *TypeCheckedLoadFunc) {
1793  Function *TypeTestFunc = Intrinsic::getDeclaration(&M, Intrinsic::type_test);
1794 
1795  for (auto I = TypeCheckedLoadFunc->use_begin(),
1796  E = TypeCheckedLoadFunc->use_end();
1797  I != E;) {
1798  auto CI = dyn_cast<CallInst>(I->getUser());
1799  ++I;
1800  if (!CI)
1801  continue;
1802 
1803  Value *Ptr = CI->getArgOperand(0);
1804  Value *Offset = CI->getArgOperand(1);
1805  Value *TypeIdValue = CI->getArgOperand(2);
1806  Metadata *TypeId = cast<MetadataAsValue>(TypeIdValue)->getMetadata();
1807 
1808  SmallVector<DevirtCallSite, 1> DevirtCalls;
1809  SmallVector<Instruction *, 1> LoadedPtrs;
1811  bool HasNonCallUses = false;
1812  auto &DT = LookupDomTree(*CI->getFunction());
1813  findDevirtualizableCallsForTypeCheckedLoad(DevirtCalls, LoadedPtrs, Preds,
1814  HasNonCallUses, CI, DT);
1815 
1816  // Start by generating "pessimistic" code that explicitly loads the function
1817  // pointer from the vtable and performs the type check. If possible, we will
1818  // eliminate the load and the type check later.
1819 
1820  // If possible, only generate the load at the point where it is used.
1821  // This helps avoid unnecessary spills.
1822  IRBuilder<> LoadB(
1823  (LoadedPtrs.size() == 1 && !HasNonCallUses) ? LoadedPtrs[0] : CI);
1824  Value *GEP = LoadB.CreateGEP(Int8Ty, Ptr, Offset);
1825  Value *GEPPtr = LoadB.CreateBitCast(GEP, PointerType::getUnqual(Int8PtrTy));
1826  Value *LoadedValue = LoadB.CreateLoad(Int8PtrTy, GEPPtr);
1827 
1828  for (Instruction *LoadedPtr : LoadedPtrs) {
1829  LoadedPtr->replaceAllUsesWith(LoadedValue);
1830  LoadedPtr->eraseFromParent();
1831  }
1832 
1833  // Likewise for the type test.
1834  IRBuilder<> CallB((Preds.size() == 1 && !HasNonCallUses) ? Preds[0] : CI);
1835  CallInst *TypeTestCall = CallB.CreateCall(TypeTestFunc, {Ptr, TypeIdValue});
1836 
1837  for (Instruction *Pred : Preds) {
1838  Pred->replaceAllUsesWith(TypeTestCall);
1839  Pred->eraseFromParent();
1840  }
1841 
1842  // We have already erased any extractvalue instructions that refer to the
1843  // intrinsic call, but the intrinsic may have other non-extractvalue uses
1844  // (although this is unlikely). In that case, explicitly build a pair and
1845  // RAUW it.
1846  if (!CI->use_empty()) {
1847  Value *Pair = UndefValue::get(CI->getType());
1848  IRBuilder<> B(CI);
1849  Pair = B.CreateInsertValue(Pair, LoadedValue, {0});
1850  Pair = B.CreateInsertValue(Pair, TypeTestCall, {1});
1851  CI->replaceAllUsesWith(Pair);
1852  }
1853 
1854  // The number of unsafe uses is initially the number of uses.
1855  auto &NumUnsafeUses = NumUnsafeUsesForTypeTest[TypeTestCall];
1856  NumUnsafeUses = DevirtCalls.size();
1857 
1858  // If the function pointer has a non-call user, we cannot eliminate the type
1859  // check, as one of those users may eventually call the pointer. Increment
1860  // the unsafe use count to make sure it cannot reach zero.
1861  if (HasNonCallUses)
1862  ++NumUnsafeUses;
1863  for (DevirtCallSite Call : DevirtCalls) {
1864  CallSlots[{TypeId, Call.Offset}].addCallSite(Ptr, Call.CB,
1865  &NumUnsafeUses);
1866  }
1867 
1868  CI->eraseFromParent();
1869  }
1870 }
1871 
1872 void DevirtModule::importResolution(VTableSlot Slot, VTableSlotInfo &SlotInfo) {
1873  auto *TypeId = dyn_cast<MDString>(Slot.TypeID);
1874  if (!TypeId)
1875  return;
1876  const TypeIdSummary *TidSummary =
1877  ImportSummary->getTypeIdSummary(TypeId->getString());
1878  if (!TidSummary)
1879  return;
1880  auto ResI = TidSummary->WPDRes.find(Slot.ByteOffset);
1881  if (ResI == TidSummary->WPDRes.end())
1882  return;
1883  const WholeProgramDevirtResolution &Res = ResI->second;
1884 
1886  assert(!Res.SingleImplName.empty());
1887  // The type of the function in the declaration is irrelevant because every
1888  // call site will cast it to the correct type.
1889  Constant *SingleImpl =
1890  cast<Constant>(M.getOrInsertFunction(Res.SingleImplName,
1891  Type::getVoidTy(M.getContext()))
1892  .getCallee());
1893 
1894  // This is the import phase so we should not be exporting anything.
1895  bool IsExported = false;
1896  applySingleImplDevirt(SlotInfo, SingleImpl, IsExported);
1897  assert(!IsExported);
1898  }
1899 
1900  for (auto &CSByConstantArg : SlotInfo.ConstCSInfo) {
1901  auto I = Res.ResByArg.find(CSByConstantArg.first);
1902  if (I == Res.ResByArg.end())
1903  continue;
1904  auto &ResByArg = I->second;
1905  // FIXME: We should figure out what to do about the "function name" argument
1906  // to the apply* functions, as the function names are unavailable during the
1907  // importing phase. For now we just pass the empty string. This does not
1908  // impact correctness because the function names are just used for remarks.
1909  switch (ResByArg.TheKind) {
1911  applyUniformRetValOpt(CSByConstantArg.second, "", ResByArg.Info);
1912  break;
1914  Constant *UniqueMemberAddr =
1915  importGlobal(Slot, CSByConstantArg.first, "unique_member");
1916  applyUniqueRetValOpt(CSByConstantArg.second, "", ResByArg.Info,
1917  UniqueMemberAddr);
1918  break;
1919  }
1921  Constant *Byte = importConstant(Slot, CSByConstantArg.first, "byte",
1922  Int32Ty, ResByArg.Byte);
1923  Constant *Bit = importConstant(Slot, CSByConstantArg.first, "bit", Int8Ty,
1924  ResByArg.Bit);
1925  applyVirtualConstProp(CSByConstantArg.second, "", Byte, Bit);
1926  break;
1927  }
1928  default:
1929  break;
1930  }
1931  }
1932 
1934  // The type of the function is irrelevant, because it's bitcast at calls
1935  // anyhow.
1936  Constant *JT = cast<Constant>(
1937  M.getOrInsertFunction(getGlobalName(Slot, {}, "branch_funnel"),
1938  Type::getVoidTy(M.getContext()))
1939  .getCallee());
1940  bool IsExported = false;
1941  applyICallBranchFunnel(SlotInfo, JT, IsExported);
1942  assert(!IsExported);
1943  }
1944 }
1945 
1946 void DevirtModule::removeRedundantTypeTests() {
1947  auto True = ConstantInt::getTrue(M.getContext());
1948  for (auto &&U : NumUnsafeUsesForTypeTest) {
1949  if (U.second == 0) {
1950  U.first->replaceAllUsesWith(True);
1951  U.first->eraseFromParent();
1952  }
1953  }
1954 }
1955 
1956 bool DevirtModule::run() {
1957  // If only some of the modules were split, we cannot correctly perform
1958  // this transformation. We already checked for the presense of type tests
1959  // with partially split modules during the thin link, and would have emitted
1960  // an error if any were found, so here we can simply return.
1961  if ((ExportSummary && ExportSummary->partiallySplitLTOUnits()) ||
1962  (ImportSummary && ImportSummary->partiallySplitLTOUnits()))
1963  return false;
1964 
1965  Function *TypeTestFunc =
1966  M.getFunction(Intrinsic::getName(Intrinsic::type_test));
1967  Function *TypeCheckedLoadFunc =
1968  M.getFunction(Intrinsic::getName(Intrinsic::type_checked_load));
1969  Function *AssumeFunc = M.getFunction(Intrinsic::getName(Intrinsic::assume));
1970 
1971  // Normally if there are no users of the devirtualization intrinsics in the
1972  // module, this pass has nothing to do. But if we are exporting, we also need
1973  // to handle any users that appear only in the function summaries.
1974  if (!ExportSummary &&
1975  (!TypeTestFunc || TypeTestFunc->use_empty() || !AssumeFunc ||
1976  AssumeFunc->use_empty()) &&
1977  (!TypeCheckedLoadFunc || TypeCheckedLoadFunc->use_empty()))
1978  return false;
1979 
1980  // Rebuild type metadata into a map for easy lookup.
1981  std::vector<VTableBits> Bits;
1983  buildTypeIdentifierMap(Bits, TypeIdMap);
1984 
1985  if (TypeTestFunc && AssumeFunc)
1986  scanTypeTestUsers(TypeTestFunc, TypeIdMap);
1987 
1988  if (TypeCheckedLoadFunc)
1989  scanTypeCheckedLoadUsers(TypeCheckedLoadFunc);
1990 
1991  if (ImportSummary) {
1992  for (auto &S : CallSlots)
1993  importResolution(S.first, S.second);
1994 
1995  removeRedundantTypeTests();
1996 
1997  // We have lowered or deleted the type instrinsics, so we will no
1998  // longer have enough information to reason about the liveness of virtual
1999  // function pointers in GlobalDCE.
2000  for (GlobalVariable &GV : M.globals())
2001  GV.eraseMetadata(LLVMContext::MD_vcall_visibility);
2002 
2003  // The rest of the code is only necessary when exporting or during regular
2004  // LTO, so we are done.
2005  return true;
2006  }
2007 
2008  if (TypeIdMap.empty())
2009  return true;
2010 
2011  // Collect information from summary about which calls to try to devirtualize.
2012  if (ExportSummary) {
2014  for (auto &P : TypeIdMap) {
2015  if (auto *TypeId = dyn_cast<MDString>(P.first))
2016  MetadataByGUID[GlobalValue::getGUID(TypeId->getString())].push_back(
2017  TypeId);
2018  }
2019 
2020  for (auto &P : *ExportSummary) {
2021  for (auto &S : P.second.SummaryList) {
2022  auto *FS = dyn_cast<FunctionSummary>(S.get());
2023  if (!FS)
2024  continue;
2025  // FIXME: Only add live functions.
2026  for (FunctionSummary::VFuncId VF : FS->type_test_assume_vcalls()) {
2027  for (Metadata *MD : MetadataByGUID[VF.GUID]) {
2028  CallSlots[{MD, VF.Offset}].CSInfo.addSummaryTypeTestAssumeUser(FS);
2029  }
2030  }
2031  for (FunctionSummary::VFuncId VF : FS->type_checked_load_vcalls()) {
2032  for (Metadata *MD : MetadataByGUID[VF.GUID]) {
2033  CallSlots[{MD, VF.Offset}].CSInfo.addSummaryTypeCheckedLoadUser(FS);
2034  }
2035  }
2036  for (const FunctionSummary::ConstVCall &VC :
2037  FS->type_test_assume_const_vcalls()) {
2038  for (Metadata *MD : MetadataByGUID[VC.VFunc.GUID]) {
2039  CallSlots[{MD, VC.VFunc.Offset}]
2040  .ConstCSInfo[VC.Args]
2041  .addSummaryTypeTestAssumeUser(FS);
2042  }
2043  }
2044  for (const FunctionSummary::ConstVCall &VC :
2045  FS->type_checked_load_const_vcalls()) {
2046  for (Metadata *MD : MetadataByGUID[VC.VFunc.GUID]) {
2047  CallSlots[{MD, VC.VFunc.Offset}]
2048  .ConstCSInfo[VC.Args]
2049  .addSummaryTypeCheckedLoadUser(FS);
2050  }
2051  }
2052  }
2053  }
2054  }
2055 
2056  // For each (type, offset) pair:
2057  bool DidVirtualConstProp = false;
2058  std::map<std::string, Function*> DevirtTargets;
2059  for (auto &S : CallSlots) {
2060  // Search each of the members of the type identifier for the virtual
2061  // function implementation at offset S.first.ByteOffset, and add to
2062  // TargetsForSlot.
2063  std::vector<VirtualCallTarget> TargetsForSlot;
2064  WholeProgramDevirtResolution *Res = nullptr;
2065  const std::set<TypeMemberInfo> &TypeMemberInfos = TypeIdMap[S.first.TypeID];
2066  if (ExportSummary && isa<MDString>(S.first.TypeID) &&
2067  TypeMemberInfos.size())
2068  // For any type id used on a global's type metadata, create the type id
2069  // summary resolution regardless of whether we can devirtualize, so that
2070  // lower type tests knows the type id is not Unsat. If it was not used on
2071  // a global's type metadata, the TypeIdMap entry set will be empty, and
2072  // we don't want to create an entry (with the default Unknown type
2073  // resolution), which can prevent detection of the Unsat.
2074  Res = &ExportSummary
2075  ->getOrInsertTypeIdSummary(
2076  cast<MDString>(S.first.TypeID)->getString())
2077  .WPDRes[S.first.ByteOffset];
2078  if (tryFindVirtualCallTargets(TargetsForSlot, TypeMemberInfos,
2079  S.first.ByteOffset)) {
2080 
2081  if (!trySingleImplDevirt(ExportSummary, TargetsForSlot, S.second, Res)) {
2082  DidVirtualConstProp |=
2083  tryVirtualConstProp(TargetsForSlot, S.second, Res, S.first);
2084 
2085  tryICallBranchFunnel(TargetsForSlot, S.second, Res, S.first);
2086  }
2087 
2088  // Collect functions devirtualized at least for one call site for stats.
2089  if (RemarksEnabled)
2090  for (const auto &T : TargetsForSlot)
2091  if (T.WasDevirt)
2092  DevirtTargets[std::string(T.Fn->getName())] = T.Fn;
2093  }
2094 
2095  // CFI-specific: if we are exporting and any llvm.type.checked.load
2096  // intrinsics were *not* devirtualized, we need to add the resulting
2097  // llvm.type.test intrinsics to the function summaries so that the
2098  // LowerTypeTests pass will export them.
2099  if (ExportSummary && isa<MDString>(S.first.TypeID)) {
2100  auto GUID =
2101  GlobalValue::getGUID(cast<MDString>(S.first.TypeID)->getString());
2102  for (auto FS : S.second.CSInfo.SummaryTypeCheckedLoadUsers)
2103  FS->addTypeTest(GUID);
2104  for (auto &CCS : S.second.ConstCSInfo)
2105  for (auto FS : CCS.second.SummaryTypeCheckedLoadUsers)
2106  FS->addTypeTest(GUID);
2107  }
2108  }
2109 
2110  if (RemarksEnabled) {
2111  // Generate remarks for each devirtualized function.
2112  for (const auto &DT : DevirtTargets) {
2113  Function *F = DT.second;
2114 
2115  using namespace ore;
2116  OREGetter(F).emit(OptimizationRemark(DEBUG_TYPE, "Devirtualized", F)
2117  << "devirtualized "
2118  << NV("FunctionName", DT.first));
2119  }
2120  }
2121 
2122  removeRedundantTypeTests();
2123 
2124  // Rebuild each global we touched as part of virtual constant propagation to
2125  // include the before and after bytes.
2126  if (DidVirtualConstProp)
2127  for (VTableBits &B : Bits)
2128  rebuildGlobal(B);
2129 
2130  // We have lowered or deleted the type instrinsics, so we will no
2131  // longer have enough information to reason about the liveness of virtual
2132  // function pointers in GlobalDCE.
2133  for (GlobalVariable &GV : M.globals())
2134  GV.eraseMetadata(LLVMContext::MD_vcall_visibility);
2135 
2136  return true;
2137 }
2138 
2139 void DevirtIndex::run() {
2140  if (ExportSummary.typeIdCompatibleVtableMap().empty())
2141  return;
2142 
2144  for (auto &P : ExportSummary.typeIdCompatibleVtableMap()) {
2145  NameByGUID[GlobalValue::getGUID(P.first)].push_back(P.first);
2146  }
2147 
2148  // Collect information from summary about which calls to try to devirtualize.
2149  for (auto &P : ExportSummary) {
2150  for (auto &S : P.second.SummaryList) {
2151  auto *FS = dyn_cast<FunctionSummary>(S.get());
2152  if (!FS)
2153  continue;
2154  // FIXME: Only add live functions.
2155  for (FunctionSummary::VFuncId VF : FS->type_test_assume_vcalls()) {
2156  for (StringRef Name : NameByGUID[VF.GUID]) {
2157  CallSlots[{Name, VF.Offset}].CSInfo.addSummaryTypeTestAssumeUser(FS);
2158  }
2159  }
2160  for (FunctionSummary::VFuncId VF : FS->type_checked_load_vcalls()) {
2161  for (StringRef Name : NameByGUID[VF.GUID]) {
2162  CallSlots[{Name, VF.Offset}].CSInfo.addSummaryTypeCheckedLoadUser(FS);
2163  }
2164  }
2165  for (const FunctionSummary::ConstVCall &VC :
2166  FS->type_test_assume_const_vcalls()) {
2167  for (StringRef Name : NameByGUID[VC.VFunc.GUID]) {
2168  CallSlots[{Name, VC.VFunc.Offset}]
2169  .ConstCSInfo[VC.Args]
2170  .addSummaryTypeTestAssumeUser(FS);
2171  }
2172  }
2173  for (const FunctionSummary::ConstVCall &VC :
2174  FS->type_checked_load_const_vcalls()) {
2175  for (StringRef Name : NameByGUID[VC.VFunc.GUID]) {
2176  CallSlots[{Name, VC.VFunc.Offset}]
2177  .ConstCSInfo[VC.Args]
2178  .addSummaryTypeCheckedLoadUser(FS);
2179  }
2180  }
2181  }
2182  }
2183 
2184  std::set<ValueInfo> DevirtTargets;
2185  // For each (type, offset) pair:
2186  for (auto &S : CallSlots) {
2187  // Search each of the members of the type identifier for the virtual
2188  // function implementation at offset S.first.ByteOffset, and add to
2189  // TargetsForSlot.
2190  std::vector<ValueInfo> TargetsForSlot;
2191  auto TidSummary = ExportSummary.getTypeIdCompatibleVtableSummary(S.first.TypeID);
2192  assert(TidSummary);
2193  // Create the type id summary resolution regardlness of whether we can
2194  // devirtualize, so that lower type tests knows the type id is used on
2195  // a global and not Unsat.
2197  &ExportSummary.getOrInsertTypeIdSummary(S.first.TypeID)
2198  .WPDRes[S.first.ByteOffset];
2199  if (tryFindVirtualCallTargets(TargetsForSlot, *TidSummary,
2200  S.first.ByteOffset)) {
2201 
2202  if (!trySingleImplDevirt(TargetsForSlot, S.first, S.second, Res,
2203  DevirtTargets))
2204  continue;
2205  }
2206  }
2207 
2208  // Optionally have the thin link print message for each devirtualized
2209  // function.
2210  if (PrintSummaryDevirt)
2211  for (const auto &DT : DevirtTargets)
2212  errs() << "Devirtualized call to " << DT << "\n";
2213 
2214  return;
2215 }
void setVisibility(VisibilityTypes V)
Definition: GlobalValue.h:235
uint64_t CallInst * C
StringRef getSection() const
Get the custom section of this global if it has one.
Definition: GlobalObject.h:114
SymbolTableList< Instruction >::iterator eraseFromParent()
This method unlinks &#39;this&#39; from the containing basic block and deletes it.
Definition: Instruction.cpp:77
unsigned getAlignment() const
FIXME: Remove this function once transition to Align is over.
Definition: GlobalObject.h:73
use_iterator use_end()
Definition: Value.h:367
static Error checkCombinedSummaryForTesting(ModuleSummaryIndex *Summary)
const std::string & getTargetTriple() const
Get the target triple which is a string describing the target host.
Definition: Module.h:249
std::vector< TypeIdOffsetVtableInfo > TypeIdCompatibleVtableInfo
List of vtable definitions decorated by a particular type identifier, and their corresponding offsets...
LLVM_NODISCARD std::enable_if_t< !is_simple_type< Y >::value, typename cast_retty< X, const Y >::ret_type > dyn_cast(const Y &Val)
Definition: Casting.h:334
bool empty() const
Definition: Function.h:740
bool hasLocalLinkage() const
Definition: GlobalValue.h:445
static PassRegistry * getPassRegistry()
getPassRegistry - Access the global registry object, which is automatically initialized at applicatio...
DiagnosticInfoOptimizationBase::Argument NV
Whole program devirtualization
static unsigned getHashValue(const VTableSlot &I)
PassT::Result & getResult(IRUnitT &IR, ExtraArgTs... ExtraArgs)
Get the result of an analysis pass for a given IR unit.
Definition: PassManager.h:785
const Constant * getInitializer() const
getInitializer - Return the initializer for this global variable.
This class represents lattice values for constants.
Definition: AllocatorList.h:23
Value * CreateGEP(Value *Ptr, ArrayRef< Value *> IdxList, const Twine &Name="")
Definition: IRBuilder.h:1778
A Module instance is used to store all the information related to an LLVM module. ...
Definition: Module.h:67
static Constant * getGetElementPtr(Type *Ty, Constant *C, ArrayRef< Constant *> IdxList, bool InBounds=false, Optional< unsigned > InRangeIndex=None, Type *OnlyIfReducedTy=nullptr)
Getelementptr form.
Definition: Constants.h:1208
Function * getCaller()
Helper to get the caller (the parent function).
void findDevirtualizableCallsForTypeTest(SmallVectorImpl< DevirtCallSite > &DevirtCalls, SmallVectorImpl< CallInst *> &Assumes, const CallInst *CI, DominatorTree &DT)
Given a call to the intrinsic @llvm.type.test, find all devirtualizable call sites based on the call ...
static CallInst * Create(FunctionType *Ty, Value *F, const Twine &NameStr="", Instruction *InsertBefore=nullptr)
Global variable summary information to aid decisions and implementation of importing.
VirtualCallTarget(Function *Fn, const TypeMemberInfo *TM)
Unsatisfiable type (i.e. no global has this type metadata)
Subclass of Error for the sole purpose of identifying the success path in the type system...
Definition: Error.h:330
void push_back(const T &Elt)
Definition: SmallVector.h:316
This provides a very simple, boring adaptor for a begin and end iterator into a range type...
GlobalObject::VCallVisibility getVCallVisibility() const
Helper for check-and-exit error handling.
Definition: Error.h:1306
void initializeWholeProgramDevirtPass(PassRegistry &)
const auto & typeIdCompatibleVtableMap() const
This class represents a function call, abstracting a target machine&#39;s calling convention.
This file contains the declarations for metadata subclasses.
An immutable pass that tracks lazily created AssumptionCache objects.
An efficient, type-erasing, non-owning reference to a callable.
Definition: STLExtras.h:176
static Constant * getIntToPtr(Constant *C, Type *Ty, bool OnlyIfReduced=false)
Definition: Constants.cpp:2078
uint64_t Info
Additional information for the resolution:
Like Internal, but omit from symbol table.
Definition: GlobalValue.h:56
Externally visible function.
Definition: GlobalValue.h:48
const StringMap< std::pair< uint64_t, ModuleHash > > & modulePaths() const
Table of modules, containing module hash and id.
static cl::opt< unsigned > ClThreshold("wholeprogramdevirt-branch-funnel-threshold", cl::Hidden, cl::init(10), cl::ZeroOrMore, cl::desc("Maximum number of call targets per " "call site to enable branch funnels"))
This class implements a map that also provides access to all stored values in a deterministic order...
Definition: MapVector.h:37
A debug info location.
Definition: DebugLoc.h:33
Metadata node.
Definition: Metadata.h:870
Base class for all callable instructions (InvokeInst and CallInst) Holds everything related to callin...
Definition: InstrTypes.h:1137
Analysis pass which computes a DominatorTree.
Definition: Dominators.h:249
F(f)
User::op_iterator arg_end()
Return the iterator pointing to the end of the argument list.
Definition: InstrTypes.h:1267
const GlobalListType & getGlobalList() const
Get the Module&#39;s list of global variables (constant).
Definition: Module.h:535
static IntegerType * getInt64Ty(LLVMContext &C)
Definition: Type.cpp:187
Hexagon Common GEP
MemoryAccessKind computeFunctionBodyMemoryAccess(Function &F, AAResults &AAR)
Returns the memory access properties of this copy of the function.
const TypeIdSummary * getTypeIdSummary(StringRef TypeId) const
This returns either a pointer to the type id summary (if present in the summary map) or null (if not ...
void setAfterReturnValues(MutableArrayRef< VirtualCallTarget > Targets, uint64_t AllocAfter, unsigned BitWidth, int64_t &OffsetByte, uint64_t &OffsetBit)
std::map< uint64_t, WholeProgramDevirtResolution > WPDRes
Mapping from byte offset to whole-program devirt resolution for that (typeid, byte offset) pair...
VCallVisibility getVCallVisibility() const
Definition: Metadata.cpp:1477
static bool AddCalls(VTableSlotInfo &SlotInfo, const ValueInfo &Callee)
static Optional< bool > isBigEndian(const ArrayRef< int64_t > ByteOffsets, int64_t FirstOffset)
static bool isLocalLinkage(LinkageTypes Linkage)
Definition: GlobalValue.h:329
TypeTestResolution TTRes
static Constant * getNullValue(Type *Ty)
Constructor to create a &#39;0&#39; constant of arbitrary type.
Definition: Constants.cpp:336
Export information to summary.
const char * getName() const
getName - Get the target name.
static ReturnInst * Create(LLVMContext &C, Value *retVal=nullptr, Instruction *InsertBefore=nullptr)
void setBeforeReturnValues(MutableArrayRef< VirtualCallTarget > Targets, uint64_t AllocBefore, unsigned BitWidth, int64_t &OffsetByte, uint64_t &OffsetBit)
unsigned countTrailingZeros(T Val, ZeroBehavior ZB=ZB_Width)
Count number of 0&#39;s from the least significant bit to the most stopping at the first 1...
Definition: MathExtras.h:157
void findDevirtualizableCallsForTypeCheckedLoad(SmallVectorImpl< DevirtCallSite > &DevirtCalls, SmallVectorImpl< Instruction *> &LoadedPtrs, SmallVectorImpl< Instruction *> &Preds, bool &HasNonCallUses, const CallInst *CI, DominatorTree &DT)
Given a call to the intrinsic @llvm.type.checked.load, find all devirtualizable call sites based on t...
bool match(Val *V, const Pattern &P)
Definition: PatternMatch.h:49
AnalysisUsage & addRequired()
StringRef getName(ID id)
Return the LLVM name for an intrinsic, such as "llvm.ppc.altivec.lvx".
Definition: Function.cpp:769
const DataLayout & getDataLayout() const
Get the data layout for the module&#39;s target platform.
Definition: Module.cpp:397
bool arg_empty() const
Definition: InstrTypes.h:1283
When retpoline mitigation is enabled, use a branch funnel that is defined in the merged module...
LLVMContext & getContext() const
Get the global data context.
Definition: Module.h:253
The returned value is undefined.
Definition: MathExtras.h:47
void updateIndexWPDForExports(ModuleSummaryIndex &Summary, function_ref< bool(StringRef, ValueInfo)> isExported, std::map< ValueInfo, std::vector< VTableSlotSummary >> &LocalWPDTargetsMap)
Call after cross-module importing to update the recorded single impl devirt target names for any loca...
bool isConstant() const
If the value is a global constant, its value is immutable throughout the runtime execution of the pro...
static bool isEqual(const VTableSlotSummary &LHS, const VTableSlotSummary &RHS)
static std::string getGlobalNameForLocal(StringRef Name, ModuleHash ModHash)
Convenience method for creating a promoted global name for the given value name of a local...
This class is a functor to be used in legacy module or SCC passes for computing AA results for a func...
static constexpr const char * getRegularLTOModuleName()
TypeID
Definitions of all of the base types for the Type system.
Definition: Type.h:55
AttributeSet getRetAttributes() const
The attributes for the ret value are returned.
unsigned Intr
CallInst * CreateCall(FunctionType *FTy, Value *Callee, ArrayRef< Value *> Args=None, const Twine &Name="", MDNode *FPMathTag=nullptr)
Definition: IRBuilder.h:2353
void setName(const Twine &Name)
Change the name of the value.
Definition: Value.cpp:367
Tagged union holding either a T or a Error.
Definition: APFloat.h:42
static bool isEqual(const VTableSlot &LHS, const VTableSlot &RHS)
enum llvm::WholeProgramDevirtResolution::Kind TheKind
Class to represent function types.
Definition: DerivedTypes.h:108
Type * getType() const
All values are typed, get the type of this value.
Definition: Value.h:246
void updateVCallVisibilityInIndex(ModuleSummaryIndex &Index, bool WholeProgramVisibilityEnabledInLTO)
If whole program visibility asserted, then upgrade all public vcall visibility metadata on vtable def...
InvokeInst * CreateInvoke(FunctionType *Ty, Value *Callee, BasicBlock *NormalDest, BasicBlock *UnwindDest, ArrayRef< Value *> Args, ArrayRef< OperandBundleDef > OpBundles, const Twine &Name="")
Create an invoke instruction.
Definition: IRBuilder.h:1017
Class to represent array types.
Definition: DerivedTypes.h:358
AttributeSet getParamAttributes(unsigned ArgNo) const
The attributes for the argument or parameter at the given index are returned.
bool isVarArg() const
Definition: DerivedTypes.h:128
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory)...
Definition: APInt.h:32
LinkageTypes getLinkage() const
Definition: GlobalValue.h:461
void replaceAllUsesWith(Value *V)
Change all uses of this to point to a new Value.
Definition: Value.cpp:511
constexpr char Attrs[]
Key for Kernel::Metadata::mAttrs.
unsigned getBitWidth() const
Get the number of bits in this IntegerType.
Definition: DerivedTypes.h:71
MaybeAlign getAlign() const
Returns the alignment of the given variable or function.
Definition: GlobalObject.h:82
Class to hold module path string table and global value map, and encapsulate methods for operating on...
static ConstantAsMetadata * get(Constant *C)
Definition: Metadata.h:410
Concrete subclass of DominatorTreeBase that is used to compute a normal dominator tree...
Definition: Dominators.h:151
ArrayRef< std::unique_ptr< GlobalValueSummary > > getSummaryList() const
Function * getDeclaration(Module *M, ID id, ArrayRef< Type *> Tys=None)
Create or insert an LLVM Function declaration for an intrinsic, and return it.
Definition: Function.cpp:1236
The file should be opened in text mode on platforms that make this distinction.
Definition: FileSystem.h:747
Class to represent pointers.
Definition: DerivedTypes.h:657
static PreservedAnalyses none()
Convenience factory function for the empty preserved set.
Definition: PassManager.h:158
static Constant * getBitCast(Constant *C, Type *Ty, bool OnlyIfReduced=false)
Definition: Constants.cpp:2092
bool isValid() const
Return true if the attribute is any kind of attribute.
Definition: Attributes.h:151
IntegerType * getIntPtrType(LLVMContext &C, unsigned AddressSpace=0) const
Returns an integer type with size at least as big as that of a pointer in the given address space...
Definition: DataLayout.cpp:859
static MDTuple * get(LLVMContext &Context, ArrayRef< Metadata *> MDs)
Definition: Metadata.h:1172
#define P(N)
initializer< Ty > init(const Ty &Val)
Definition: CommandLine.h:427
static Function * Create(FunctionType *Ty, LinkageTypes Linkage, unsigned AddrSpace, const Twine &N="", Module *M=nullptr)
Definition: Function.h:137
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
A set of analyses that are preserved following a run of a transformation pass.
Definition: PassManager.h:155
* if(!EatIfPresent(lltok::kw_thread_local)) return false
parseOptionalThreadLocal := /*empty
static AttributeSet get(LLVMContext &C, const AttrBuilder &B)
Definition: Attributes.cpp:657
void setVCallVisibility(GlobalObject::VCallVisibility Vis)
VisibilityTypes getVisibility() const
Definition: GlobalValue.h:229
MutableArrayRef - Represent a mutable reference to an array (0 or more elements consecutively in memo...
Definition: ArrayRef.h:298
void runWholeProgramDevirtOnIndex(ModuleSummaryIndex &Summary, std::set< GlobalValue::GUID > &ExportedGUIDs, std::map< ValueInfo, std::vector< VTableSlotSummary >> &LocalWPDTargetsMap)
Perform index-based whole program devirtualization on the Summary index.
Import information from summary.
LLVM Basic Block Representation.
Definition: BasicBlock.h:58
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:46
A call site that could be devirtualized.
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:156
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
This is an important base class in LLVM.
Definition: Constant.h:41
Error errorCodeToError(std::error_code EC)
Helper for converting an std::error_code to a Error.
Definition: Error.cpp:87
ValuesClass values(OptsTy... Options)
Helper to build a ValuesClass by forwarding a variable number of arguments as an initializer list to ...
Definition: CommandLine.h:683
PreservedAnalyses run(Module &M, ModuleAnalysisManager &)
Value * CreateBitCast(Value *V, Type *DestTy, const Twine &Name="")
Definition: IRBuilder.h:2075
This file contains the declarations for the subclasses of Constant, which represent the different fla...
#define DEBUG_TYPE
TypeSize getTypeAllocSize(Type *Ty) const
Returns the offset in bytes between successive objects of the specified type, including alignment pad...
Definition: DataLayout.h:505
A manager for alias analyses.
FunctionType * getFunctionType() const
Definition: InstrTypes.h:1199
cl::list< std::string > SkipFunctionNames("wholeprogramdevirt-skip", cl::desc("Prevent function(s) from being devirtualized"), cl::Hidden, cl::ZeroOrMore, cl::CommaSeparated)
Provide way to prevent certain function from being devirtualized.
Class to accumulate and hold information about a callee.
Diagnostic information for applied optimization remarks.
void eraseFromParent()
eraseFromParent - This method unlinks &#39;this&#39; from the containing module and deletes it...
Definition: Globals.cpp:385
INITIALIZE_PASS_BEGIN(WholeProgramDevirt, "wholeprogramdevirt", "Whole program devirtualization", false, false) INITIALIZE_PASS_END(WholeProgramDevirt
ArrayRef< Type * > params() const
Definition: DerivedTypes.h:135
Expected< T > errorOrToExpected(ErrorOr< T > &&EO)
Convert an ErrorOr<T> to an Expected<T>.
Definition: Error.h:1142
Represent the analysis usage information of a pass.
void addAttribute(unsigned i, Attribute::AttrKind Kind)
adds the attribute to the list of attributes.
Definition: Function.cpp:484
static Type * getVoidTy(LLVMContext &C)
Definition: Type.cpp:170
Type::TypeID TypeID
Expected< ExpressionValue > min(const ExpressionValue &Lhs, const ExpressionValue &Rhs)
Definition: FileCheck.cpp:339
void setCallingConv(CallingConv::ID CC)
Definition: InstrTypes.h:1412
amdgpu Simplify well known AMD library false FunctionCallee Value * Arg
static FunctionType * get(Type *Result, ArrayRef< Type *> Params, bool isVarArg)
This static method is the primary way of constructing a FunctionType.
Definition: Type.cpp:311
static BasicBlock * Create(LLVMContext &Context, const Twine &Name="", Function *Parent=nullptr, BasicBlock *InsertBefore=nullptr)
Creates a new BasicBlock.
Definition: BasicBlock.h:100
void reserve(size_type NumEntries)
Grow the densemap so that it can contain at least NumEntries items before resizing again...
Definition: DenseMap.h:104
const ModuleHash & getModuleHash(const StringRef ModPath) const
Get the module SHA1 hash recorded for the given module path.
raw_fd_ostream & errs()
This returns a reference to a raw_ostream for standard error.
LLVM_NODISCARD bool contains(StringRef Other) const
Return true if the given string is a substring of *this, and false otherwise.
Definition: StringRef.h:465
Class to represent integer types.
Definition: DerivedTypes.h:40
constexpr unsigned BitWidth
Definition: BitmaskEnum.h:147
enum llvm::WholeProgramDevirtResolution::ByArg::Kind TheKind
static GUID getGUID(StringRef GlobalName)
Return a 64-bit global unique ID constructed from global value name (i.e.
Definition: GlobalValue.h:507
LoadInst * CreateLoad(Type *Ty, Value *Ptr, const char *Name)
Provided to resolve &#39;CreateLoad(Ty, Ptr, "...")&#39; correctly, instead of converting the string to &#39;bool...
Definition: IRBuilder.h:1627
static UndefValue * get(Type *T)
Static factory methods - Return an &#39;undef&#39; object of the specified type.
Definition: Constants.cpp:1684
const Constant * stripPointerCasts() const
Definition: Constant.h:195
Comdat * getOrInsertComdat(StringRef Name)
Return the Comdat in the module with the specified name.
Definition: Module.cpp:526
const Value * stripPointerCasts() const
Strip off pointer casts, all-zero GEPs and address space casts.
Definition: Value.cpp:618
static PreservedAnalyses all()
Construct a special preserved set that preserves all passes.
Definition: PassManager.h:161
void consumeError(Error Err)
Consume a Error without doing anything.
Definition: Error.h:1006
static PointerType * getInt8PtrTy(LLVMContext &C, unsigned AS=0)
Definition: Type.cpp:234
bool isEnabled() const override
std::string & str()
Flushes the stream contents to the target string and returns the string&#39;s reference.
Definition: raw_ostream.h:625
INITIALIZE_PASS_END(RegBankSelect, DEBUG_TYPE, "Assign register bank of generic virtual registers", false, false) RegBankSelect
Value * CreateICmp(CmpInst::Predicate P, Value *LHS, Value *RHS, const Twine &Name="")
Definition: IRBuilder.h:2299
This struct is a compact representation of a valid (non-zero power of two) alignment.
Definition: Alignment.h:39
Triple - Helper class for working with autoconf configuration names.
Definition: Triple.h:45
An "identifier" for a virtual function.
Struct that holds a reference to a particular GUID in a global value summary.
This class evaluates LLVM IR, producing the Constant representing each SSA instruction.
Definition: Evaluator.h:38
Value * CreateZExt(Value *V, Type *DestTy, const Twine &Name="")
Definition: IRBuilder.h:1983
iterator_range< T > make_range(T x, T y)
Convenience function for iterating over sub-ranges.
static PointerType * getUnqual(Type *ElementType)
This constructs a pointer to an object of the specified type in the generic address space (address sp...
Definition: DerivedTypes.h:672
This is the shared class of boolean and integer constants.
Definition: Constants.h:77
void setSelectionKind(SelectionKind Val)
Definition: Comdat.h:45
Align max(MaybeAlign Lhs, Align Rhs)
Definition: Alignment.h:350
This struct is a compact representation of a valid (power of two) or undefined (0) alignment...
Definition: Alignment.h:119
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:960
Module.h This file contains the declarations for the Module class.
Single implementation devirtualization.
static bool isAvailableExternallyLinkage(LinkageTypes Linkage)
Definition: GlobalValue.h:302
Type * getReturnType() const
Definition: DerivedTypes.h:129
static Expected< GlobPattern > create(StringRef Pat)
unsigned getProgramAddressSpace() const
Definition: DataLayout.h:299
static Constant * get(Type *Ty, uint64_t V, bool isSigned=false)
If Ty is a vector type, return a Constant with a splat of the given value.
Definition: Constants.cpp:838
static BranchInst * Create(BasicBlock *IfTrue, Instruction *InsertBefore=nullptr)
ArrayRef< VirtFuncOffset > vTableFuncs() const
AttributeList getAttributes() const
Return the parameter attributes for this call.
Definition: InstrTypes.h:1427
static ConstantInt * getTrue(LLVMContext &Context)
Definition: Constants.cpp:794
void setLinkage(LinkageTypes LT)
Definition: GlobalValue.h:454
enum llvm::TypeTestResolution::Kind TheKind
void swap(llvm::BitVector &LHS, llvm::BitVector &RHS)
Implement std::swap in terms of BitVector swap.
Definition: BitVector.h:944
wholeprogramdevirt
Target - Wrapper for Target specific information.
unsigned getNumAttrSets() const
A specification for a virtual function call with all constant integer arguments.
void WriteIndexToFile(const ModuleSummaryIndex &Index, raw_ostream &Out, const std::map< std::string, GVSummaryMapTy > *ModuleToSummariesForIndex=nullptr)
Write the specified module summary index to the given raw output stream, where it will be written in ...
cl::opt< bool > WholeProgramVisibility("whole-program-visibility", cl::init(false), cl::Hidden, cl::ZeroOrMore, cl::desc("Enable whole program visibility"))
Provide a way to force enable whole program visibility in tests.
GUID getGUID() const
Return a 64-bit global unique ID constructed from global value name (i.e.
Definition: GlobalValue.h:511
ArrayRef< T > slice(size_t N, size_t M) const
slice(n, m) - Chop off the first N elements of the array, and keep M elements in the array...
Definition: ArrayRef.h:186
ValueInfo getValueInfo(const GlobalValueSummaryMapTy::value_type &R) const
Return a ValueInfo for the index value_type (convenient when iterating index).
#define clEnumValN(ENUMVAL, FLAGNAME, DESC)
Definition: CommandLine.h:658
const Comdat * getComdat() const
Definition: GlobalObject.h:125
ModulePass * createWholeProgramDevirtPass(ModuleSummaryIndex *ExportSummary, const ModuleSummaryIndex *ImportSummary)
This pass implements whole-program devirtualization using type metadata.
User::op_iterator arg_begin()
Return the iterator pointing to the beginning of the argument list.
Definition: InstrTypes.h:1261
use_iterator use_begin()
Definition: Value.h:359
static bool hasWholeProgramVisibility(bool WholeProgramVisibilityEnabledInLTO)
uint64_t alignTo(uint64_t Size, Align A)
Returns a multiple of A needed to store Size bytes.
Definition: Alignment.h:158
const DebugLoc & getDebugLoc() const
Return the debug location for this node as a DebugLoc.
Definition: Instruction.h:365
std::map< std::vector< uint64_t >, ByArg > ResByArg
Resolutions for calls with all constant integer arguments (excluding the first argument, "this"), where the key is the argument vector.
Constant * getOrInsertGlobal(StringRef Name, Type *Ty, function_ref< GlobalVariable *()> CreateGlobalCallback)
Look up the specified global in the module symbol table.
Definition: Module.cpp:204
static cl::opt< std::string > ClWriteSummary("wholeprogramdevirt-write-summary", cl::desc("Write summary to given bitcode or YAML file after running pass. " "Output file format is deduced from extension: *.bc means writing " "bitcode, otherwise YAML"), cl::Hidden)
A raw_ostream that writes to a file descriptor.
Definition: raw_ostream.h:425
static IntegerType * getInt32Ty(LLVMContext &C)
Definition: Type.cpp:186
uint64_t findLowestOffset(ArrayRef< VirtualCallTarget > Targets, bool IsAfter, uint64_t Size)
StringRef getValueAsString() const
Return the attribute&#39;s value as a string.
Definition: Attributes.cpp:275
CallingConv::ID getCallingConv() const
Definition: InstrTypes.h:1408
StringRef getName() const
Return a constant reference to the value&#39;s name.
Definition: Value.cpp:295
static Constant * getPtrToInt(Constant *C, Type *Ty, bool OnlyIfReduced=false)
Definition: Constants.cpp:2064
#define I(x, y, z)
Definition: MD5.cpp:59
ModulePass class - This class is used to implement unstructured interprocedural optimizations and ana...
Definition: Pass.h:224
static ArrayType * get(Type *ElementType, uint64_t NumElements)
This static method is the primary way to construct an ArrayType.
Definition: Type.cpp:571
void setAttributes(AttributeList A)
Set the parameter attributes for this call.
Definition: InstrTypes.h:1431
Type * getValueType() const
Definition: GlobalValue.h:273
const BasicBlockListType & getBasicBlockList() const
Get the underlying elements of the Function...
Definition: Function.h:711
uint32_t Size
Definition: Profile.cpp:46
Rename collisions when linking (static functions).
Definition: GlobalValue.h:55
static Attribute get(LLVMContext &Context, AttrKind Kind, uint64_t Val=0)
Return a uniquified Attribute object.
Definition: Attributes.cpp:81
Provides passes for computing function attributes based on interprocedural analyses.
Function summary information to aid decisions and implementation of importing.
static ErrorOr< std::unique_ptr< MemoryBuffer > > getFile(const Twine &Filename, int64_t FileSize=-1, bool RequiresNullTerminator=true, bool IsVolatile=false)
Open the specified file as a MemoryBuffer, returning a new MemoryBuffer if successful, otherwise returning null.
static cl::opt< bool > PrintSummaryDevirt("wholeprogramdevirt-print-index-based", cl::Hidden, cl::init(false), cl::ZeroOrMore, cl::desc("Print index-based devirtualization messages"))
static cl::opt< PassSummaryAction > ClSummaryAction("wholeprogramdevirt-summary-action", cl::desc("What to do with the summary when running this pass"), cl::values(clEnumValN(PassSummaryAction::None, "none", "Do nothing"), clEnumValN(PassSummaryAction::Import, "import", "Import typeid resolutions from summary and globals"), clEnumValN(PassSummaryAction::Export, "export", "Export typeid resolutions to summary and globals")), cl::Hidden)
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
A raw_ostream that writes to an std::string.
Definition: raw_ostream.h:607
aarch64 promote const
LLVM Value Representation.
Definition: Value.h:75
Expected< std::unique_ptr< ModuleSummaryIndex > > getModuleSummaryIndex(MemoryBufferRef Buffer)
Parse the specified bitcode buffer, returning the module summary index.
Lightweight error class with error context and mandatory checking.
Definition: Error.h:157
static const Function * getParent(const Value *V)
AttributeSet getFnAttributes() const
The function attributes are returned.
Attribute getFnAttribute(Attribute::AttrKind Kind) const
Return the attribute for the given attribute kind.
Definition: Function.h:349
static Constant * getAnon(ArrayRef< Constant *> V, bool Packed=false)
Return an anonymous struct that has the specified elements.
Definition: Constants.h:476
cl::opt< bool > DisableWholeProgramVisibility("disable-whole-program-visibility", cl::init(false), cl::Hidden, cl::ZeroOrMore, cl::desc("Disable whole program visibility (overrides enabling options)"))
Provide a way to force disable whole program for debugging or workarounds, when enabled via the linke...
static Constant * get(LLVMContext &Context, ArrayRef< ElementTy > Elts)
get() constructor - Return a constant with array type with an element count and element type matching...
Definition: Constants.h:705
iterator_range< global_iterator > globals()
Definition: Module.h:599
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly...
Definition: STLExtras.h:1556
iterator_range< global_object_iterator > global_objects()
Definition: Module.cpp:412
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:57
This is the interface for LLVM&#39;s primary stateless and local alias analysis.
A single uniqued string.
Definition: Metadata.h:602
A container for analyses that lazily runs them and caches their results.
Legacy analysis pass which computes a DominatorTree.
Definition: Dominators.h:278
static cl::opt< std::string > ClReadSummary("wholeprogramdevirt-read-summary", cl::desc("Read summary from given bitcode or YAML file before running pass"), cl::Hidden)
void updateVCallVisibilityInModule(Module &M, bool WholeProgramVisibilityEnabledInLTO)
If whole program visibility asserted, then upgrade all public vcall visibility metadata on vtable def...
Root of the metadata hierarchy.
Definition: Metadata.h:58
static IntegerType * getInt8Ty(LLVMContext &C)
Definition: Type.cpp:184
void setSection(StringRef S)
Change the section for this global.
Definition: Globals.cpp:212
The optimization diagnostic interface.
static unsigned getHashValue(const VTableSlotSummary &I)
bool use_empty() const
Definition: Value.h:343
Constant * getPointerAtOffset(Constant *I, uint64_t Offset, Module &M)
static GlobalAlias * create(Type *Ty, unsigned AddressSpace, LinkageTypes Linkage, const Twine &Name, Constant *Aliasee, Module *Parent)
If a parent module is specified, the alias is automatically inserted into the end of the specified mo...
Definition: Globals.cpp:485
constexpr char Args[]
Key for Kernel::Metadata::mArgs.
The following data structures summarize type metadata information.
Error createStringError(std::error_code EC, char const *Fmt, const Ts &... Vals)
Create formatted StringError object.
Definition: Error.h:1202
static AttributeList get(LLVMContext &C, ArrayRef< std::pair< unsigned, Attribute >> Attrs)
Create an AttributeList with the specified parameters in it.
IntegerType * Int32Ty
const BasicBlock * getParent() const
Definition: Instruction.h:94
INITIALIZE_PASS_DEPENDENCY(DominatorTreeWrapperPass)
An analysis over an "outer" IR unit that provides access to an analysis manager over an "inner" IR un...
Definition: PassManager.h:969