xref: /llvm-project/llvm/lib/Transforms/Utils/CodeExtractor.cpp (revision 17ce89fa8016758be2ec879c5560e506cad4c362)
1 //===- CodeExtractor.cpp - Pull code region into a new function -----------===//
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 file implements the interface to tear out a code region, such as an
10 // individual loop or a parallel section, into a new function, replacing it with
11 // a call to the new function.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "llvm/Transforms/Utils/CodeExtractor.h"
16 #include "llvm/ADT/ArrayRef.h"
17 #include "llvm/ADT/DenseMap.h"
18 #include "llvm/ADT/Optional.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/SetVector.h"
21 #include "llvm/ADT/SmallPtrSet.h"
22 #include "llvm/ADT/SmallVector.h"
23 #include "llvm/Analysis/AssumptionCache.h"
24 #include "llvm/Analysis/BlockFrequencyInfo.h"
25 #include "llvm/Analysis/BlockFrequencyInfoImpl.h"
26 #include "llvm/Analysis/BranchProbabilityInfo.h"
27 #include "llvm/Analysis/LoopInfo.h"
28 #include "llvm/IR/Argument.h"
29 #include "llvm/IR/Attributes.h"
30 #include "llvm/IR/BasicBlock.h"
31 #include "llvm/IR/CFG.h"
32 #include "llvm/IR/Constant.h"
33 #include "llvm/IR/Constants.h"
34 #include "llvm/IR/DIBuilder.h"
35 #include "llvm/IR/DataLayout.h"
36 #include "llvm/IR/DebugInfo.h"
37 #include "llvm/IR/DebugInfoMetadata.h"
38 #include "llvm/IR/DerivedTypes.h"
39 #include "llvm/IR/Dominators.h"
40 #include "llvm/IR/Function.h"
41 #include "llvm/IR/GlobalValue.h"
42 #include "llvm/IR/InstIterator.h"
43 #include "llvm/IR/InstrTypes.h"
44 #include "llvm/IR/Instruction.h"
45 #include "llvm/IR/Instructions.h"
46 #include "llvm/IR/IntrinsicInst.h"
47 #include "llvm/IR/Intrinsics.h"
48 #include "llvm/IR/LLVMContext.h"
49 #include "llvm/IR/MDBuilder.h"
50 #include "llvm/IR/Module.h"
51 #include "llvm/IR/PatternMatch.h"
52 #include "llvm/IR/Type.h"
53 #include "llvm/IR/User.h"
54 #include "llvm/IR/Value.h"
55 #include "llvm/IR/Verifier.h"
56 #include "llvm/Pass.h"
57 #include "llvm/Support/BlockFrequency.h"
58 #include "llvm/Support/BranchProbability.h"
59 #include "llvm/Support/Casting.h"
60 #include "llvm/Support/CommandLine.h"
61 #include "llvm/Support/Debug.h"
62 #include "llvm/Support/ErrorHandling.h"
63 #include "llvm/Support/raw_ostream.h"
64 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
65 #include "llvm/Transforms/Utils/Local.h"
66 #include <cassert>
67 #include <cstdint>
68 #include <iterator>
69 #include <map>
70 #include <set>
71 #include <utility>
72 #include <vector>
73 
74 using namespace llvm;
75 using namespace llvm::PatternMatch;
76 using ProfileCount = Function::ProfileCount;
77 
78 #define DEBUG_TYPE "code-extractor"
79 
80 // Provide a command-line option to aggregate function arguments into a struct
81 // for functions produced by the code extractor. This is useful when converting
82 // extracted functions to pthread-based code, as only one argument (void*) can
83 // be passed in to pthread_create().
84 static cl::opt<bool>
85 AggregateArgsOpt("aggregate-extracted-args", cl::Hidden,
86                  cl::desc("Aggregate arguments to code-extracted functions"));
87 
88 /// Test whether a block is valid for extraction.
89 static bool isBlockValidForExtraction(const BasicBlock &BB,
90                                       const SetVector<BasicBlock *> &Result,
91                                       bool AllowVarArgs, bool AllowAlloca) {
92   // taking the address of a basic block moved to another function is illegal
93   if (BB.hasAddressTaken())
94     return false;
95 
96   // don't hoist code that uses another basicblock address, as it's likely to
97   // lead to unexpected behavior, like cross-function jumps
98   SmallPtrSet<User const *, 16> Visited;
99   SmallVector<User const *, 16> ToVisit;
100 
101   for (Instruction const &Inst : BB)
102     ToVisit.push_back(&Inst);
103 
104   while (!ToVisit.empty()) {
105     User const *Curr = ToVisit.pop_back_val();
106     if (!Visited.insert(Curr).second)
107       continue;
108     if (isa<BlockAddress const>(Curr))
109       return false; // even a reference to self is likely to be not compatible
110 
111     if (isa<Instruction>(Curr) && cast<Instruction>(Curr)->getParent() != &BB)
112       continue;
113 
114     for (auto const &U : Curr->operands()) {
115       if (auto *UU = dyn_cast<User>(U))
116         ToVisit.push_back(UU);
117     }
118   }
119 
120   // If explicitly requested, allow vastart and alloca. For invoke instructions
121   // verify that extraction is valid.
122   for (BasicBlock::const_iterator I = BB.begin(), E = BB.end(); I != E; ++I) {
123     if (isa<AllocaInst>(I)) {
124        if (!AllowAlloca)
125          return false;
126        continue;
127     }
128 
129     if (const auto *II = dyn_cast<InvokeInst>(I)) {
130       // Unwind destination (either a landingpad, catchswitch, or cleanuppad)
131       // must be a part of the subgraph which is being extracted.
132       if (auto *UBB = II->getUnwindDest())
133         if (!Result.count(UBB))
134           return false;
135       continue;
136     }
137 
138     // All catch handlers of a catchswitch instruction as well as the unwind
139     // destination must be in the subgraph.
140     if (const auto *CSI = dyn_cast<CatchSwitchInst>(I)) {
141       if (auto *UBB = CSI->getUnwindDest())
142         if (!Result.count(UBB))
143           return false;
144       for (auto *HBB : CSI->handlers())
145         if (!Result.count(const_cast<BasicBlock*>(HBB)))
146           return false;
147       continue;
148     }
149 
150     // Make sure that entire catch handler is within subgraph. It is sufficient
151     // to check that catch return's block is in the list.
152     if (const auto *CPI = dyn_cast<CatchPadInst>(I)) {
153       for (const auto *U : CPI->users())
154         if (const auto *CRI = dyn_cast<CatchReturnInst>(U))
155           if (!Result.count(const_cast<BasicBlock*>(CRI->getParent())))
156             return false;
157       continue;
158     }
159 
160     // And do similar checks for cleanup handler - the entire handler must be
161     // in subgraph which is going to be extracted. For cleanup return should
162     // additionally check that the unwind destination is also in the subgraph.
163     if (const auto *CPI = dyn_cast<CleanupPadInst>(I)) {
164       for (const auto *U : CPI->users())
165         if (const auto *CRI = dyn_cast<CleanupReturnInst>(U))
166           if (!Result.count(const_cast<BasicBlock*>(CRI->getParent())))
167             return false;
168       continue;
169     }
170     if (const auto *CRI = dyn_cast<CleanupReturnInst>(I)) {
171       if (auto *UBB = CRI->getUnwindDest())
172         if (!Result.count(UBB))
173           return false;
174       continue;
175     }
176 
177     if (const CallInst *CI = dyn_cast<CallInst>(I)) {
178       if (const Function *F = CI->getCalledFunction()) {
179         auto IID = F->getIntrinsicID();
180         if (IID == Intrinsic::vastart) {
181           if (AllowVarArgs)
182             continue;
183           else
184             return false;
185         }
186 
187         // Currently, we miscompile outlined copies of eh_typid_for. There are
188         // proposals for fixing this in llvm.org/PR39545.
189         if (IID == Intrinsic::eh_typeid_for)
190           return false;
191       }
192     }
193   }
194 
195   return true;
196 }
197 
198 /// Build a set of blocks to extract if the input blocks are viable.
199 static SetVector<BasicBlock *>
200 buildExtractionBlockSet(ArrayRef<BasicBlock *> BBs, DominatorTree *DT,
201                         bool AllowVarArgs, bool AllowAlloca) {
202   assert(!BBs.empty() && "The set of blocks to extract must be non-empty");
203   SetVector<BasicBlock *> Result;
204 
205   // Loop over the blocks, adding them to our set-vector, and aborting with an
206   // empty set if we encounter invalid blocks.
207   for (BasicBlock *BB : BBs) {
208     // If this block is dead, don't process it.
209     if (DT && !DT->isReachableFromEntry(BB))
210       continue;
211 
212     if (!Result.insert(BB))
213       llvm_unreachable("Repeated basic blocks in extraction input");
214   }
215 
216   LLVM_DEBUG(dbgs() << "Region front block: " << Result.front()->getName()
217                     << '\n');
218 
219   for (auto *BB : Result) {
220     if (!isBlockValidForExtraction(*BB, Result, AllowVarArgs, AllowAlloca))
221       return {};
222 
223     // Make sure that the first block is not a landing pad.
224     if (BB == Result.front()) {
225       if (BB->isEHPad()) {
226         LLVM_DEBUG(dbgs() << "The first block cannot be an unwind block\n");
227         return {};
228       }
229       continue;
230     }
231 
232     // All blocks other than the first must not have predecessors outside of
233     // the subgraph which is being extracted.
234     for (auto *PBB : predecessors(BB))
235       if (!Result.count(PBB)) {
236         LLVM_DEBUG(dbgs() << "No blocks in this region may have entries from "
237                              "outside the region except for the first block!\n"
238                           << "Problematic source BB: " << BB->getName() << "\n"
239                           << "Problematic destination BB: " << PBB->getName()
240                           << "\n");
241         return {};
242       }
243   }
244 
245   return Result;
246 }
247 
248 CodeExtractor::CodeExtractor(ArrayRef<BasicBlock *> BBs, DominatorTree *DT,
249                              bool AggregateArgs, BlockFrequencyInfo *BFI,
250                              BranchProbabilityInfo *BPI, AssumptionCache *AC,
251                              bool AllowVarArgs, bool AllowAlloca,
252                              std::string Suffix)
253     : DT(DT), AggregateArgs(AggregateArgs || AggregateArgsOpt), BFI(BFI),
254       BPI(BPI), AC(AC), AllowVarArgs(AllowVarArgs),
255       Blocks(buildExtractionBlockSet(BBs, DT, AllowVarArgs, AllowAlloca)),
256       Suffix(Suffix) {}
257 
258 CodeExtractor::CodeExtractor(DominatorTree &DT, Loop &L, bool AggregateArgs,
259                              BlockFrequencyInfo *BFI,
260                              BranchProbabilityInfo *BPI, AssumptionCache *AC,
261                              std::string Suffix)
262     : DT(&DT), AggregateArgs(AggregateArgs || AggregateArgsOpt), BFI(BFI),
263       BPI(BPI), AC(AC), AllowVarArgs(false),
264       Blocks(buildExtractionBlockSet(L.getBlocks(), &DT,
265                                      /* AllowVarArgs */ false,
266                                      /* AllowAlloca */ false)),
267       Suffix(Suffix) {}
268 
269 /// definedInRegion - Return true if the specified value is defined in the
270 /// extracted region.
271 static bool definedInRegion(const SetVector<BasicBlock *> &Blocks, Value *V) {
272   if (Instruction *I = dyn_cast<Instruction>(V))
273     if (Blocks.count(I->getParent()))
274       return true;
275   return false;
276 }
277 
278 /// definedInCaller - Return true if the specified value is defined in the
279 /// function being code extracted, but not in the region being extracted.
280 /// These values must be passed in as live-ins to the function.
281 static bool definedInCaller(const SetVector<BasicBlock *> &Blocks, Value *V) {
282   if (isa<Argument>(V)) return true;
283   if (Instruction *I = dyn_cast<Instruction>(V))
284     if (!Blocks.count(I->getParent()))
285       return true;
286   return false;
287 }
288 
289 static BasicBlock *getCommonExitBlock(const SetVector<BasicBlock *> &Blocks) {
290   BasicBlock *CommonExitBlock = nullptr;
291   auto hasNonCommonExitSucc = [&](BasicBlock *Block) {
292     for (auto *Succ : successors(Block)) {
293       // Internal edges, ok.
294       if (Blocks.count(Succ))
295         continue;
296       if (!CommonExitBlock) {
297         CommonExitBlock = Succ;
298         continue;
299       }
300       if (CommonExitBlock != Succ)
301         return true;
302     }
303     return false;
304   };
305 
306   if (any_of(Blocks, hasNonCommonExitSucc))
307     return nullptr;
308 
309   return CommonExitBlock;
310 }
311 
312 CodeExtractorAnalysisCache::CodeExtractorAnalysisCache(Function &F) {
313   for (BasicBlock &BB : F) {
314     for (Instruction &II : BB.instructionsWithoutDebug())
315       if (auto *AI = dyn_cast<AllocaInst>(&II))
316         Allocas.push_back(AI);
317 
318     findSideEffectInfoForBlock(BB);
319   }
320 }
321 
322 void CodeExtractorAnalysisCache::findSideEffectInfoForBlock(BasicBlock &BB) {
323   for (Instruction &II : BB.instructionsWithoutDebug()) {
324     unsigned Opcode = II.getOpcode();
325     Value *MemAddr = nullptr;
326     switch (Opcode) {
327     case Instruction::Store:
328     case Instruction::Load: {
329       if (Opcode == Instruction::Store) {
330         StoreInst *SI = cast<StoreInst>(&II);
331         MemAddr = SI->getPointerOperand();
332       } else {
333         LoadInst *LI = cast<LoadInst>(&II);
334         MemAddr = LI->getPointerOperand();
335       }
336       // Global variable can not be aliased with locals.
337       if (isa<Constant>(MemAddr))
338         break;
339       Value *Base = MemAddr->stripInBoundsConstantOffsets();
340       if (!isa<AllocaInst>(Base)) {
341         SideEffectingBlocks.insert(&BB);
342         return;
343       }
344       BaseMemAddrs[&BB].insert(Base);
345       break;
346     }
347     default: {
348       IntrinsicInst *IntrInst = dyn_cast<IntrinsicInst>(&II);
349       if (IntrInst) {
350         if (IntrInst->isLifetimeStartOrEnd())
351           break;
352         SideEffectingBlocks.insert(&BB);
353         return;
354       }
355       // Treat all the other cases conservatively if it has side effects.
356       if (II.mayHaveSideEffects()) {
357         SideEffectingBlocks.insert(&BB);
358         return;
359       }
360     }
361     }
362   }
363 }
364 
365 bool CodeExtractorAnalysisCache::doesBlockContainClobberOfAddr(
366     BasicBlock &BB, AllocaInst *Addr) const {
367   if (SideEffectingBlocks.count(&BB))
368     return true;
369   auto It = BaseMemAddrs.find(&BB);
370   if (It != BaseMemAddrs.end())
371     return It->second.count(Addr);
372   return false;
373 }
374 
375 bool CodeExtractor::isLegalToShrinkwrapLifetimeMarkers(
376     const CodeExtractorAnalysisCache &CEAC, Instruction *Addr) const {
377   AllocaInst *AI = cast<AllocaInst>(Addr->stripInBoundsConstantOffsets());
378   Function *Func = (*Blocks.begin())->getParent();
379   for (BasicBlock &BB : *Func) {
380     if (Blocks.count(&BB))
381       continue;
382     if (CEAC.doesBlockContainClobberOfAddr(BB, AI))
383       return false;
384   }
385   return true;
386 }
387 
388 BasicBlock *
389 CodeExtractor::findOrCreateBlockForHoisting(BasicBlock *CommonExitBlock) {
390   BasicBlock *SinglePredFromOutlineRegion = nullptr;
391   assert(!Blocks.count(CommonExitBlock) &&
392          "Expect a block outside the region!");
393   for (auto *Pred : predecessors(CommonExitBlock)) {
394     if (!Blocks.count(Pred))
395       continue;
396     if (!SinglePredFromOutlineRegion) {
397       SinglePredFromOutlineRegion = Pred;
398     } else if (SinglePredFromOutlineRegion != Pred) {
399       SinglePredFromOutlineRegion = nullptr;
400       break;
401     }
402   }
403 
404   if (SinglePredFromOutlineRegion)
405     return SinglePredFromOutlineRegion;
406 
407 #ifndef NDEBUG
408   auto getFirstPHI = [](BasicBlock *BB) {
409     BasicBlock::iterator I = BB->begin();
410     PHINode *FirstPhi = nullptr;
411     while (I != BB->end()) {
412       PHINode *Phi = dyn_cast<PHINode>(I);
413       if (!Phi)
414         break;
415       if (!FirstPhi) {
416         FirstPhi = Phi;
417         break;
418       }
419     }
420     return FirstPhi;
421   };
422   // If there are any phi nodes, the single pred either exists or has already
423   // be created before code extraction.
424   assert(!getFirstPHI(CommonExitBlock) && "Phi not expected");
425 #endif
426 
427   BasicBlock *NewExitBlock = CommonExitBlock->splitBasicBlock(
428       CommonExitBlock->getFirstNonPHI()->getIterator());
429 
430   for (BasicBlock *Pred :
431        llvm::make_early_inc_range(predecessors(CommonExitBlock))) {
432     if (Blocks.count(Pred))
433       continue;
434     Pred->getTerminator()->replaceUsesOfWith(CommonExitBlock, NewExitBlock);
435   }
436   // Now add the old exit block to the outline region.
437   Blocks.insert(CommonExitBlock);
438   OldTargets.push_back(NewExitBlock);
439   return CommonExitBlock;
440 }
441 
442 // Find the pair of life time markers for address 'Addr' that are either
443 // defined inside the outline region or can legally be shrinkwrapped into the
444 // outline region. If there are not other untracked uses of the address, return
445 // the pair of markers if found; otherwise return a pair of nullptr.
446 CodeExtractor::LifetimeMarkerInfo
447 CodeExtractor::getLifetimeMarkers(const CodeExtractorAnalysisCache &CEAC,
448                                   Instruction *Addr,
449                                   BasicBlock *ExitBlock) const {
450   LifetimeMarkerInfo Info;
451 
452   for (User *U : Addr->users()) {
453     IntrinsicInst *IntrInst = dyn_cast<IntrinsicInst>(U);
454     if (IntrInst) {
455       // We don't model addresses with multiple start/end markers, but the
456       // markers do not need to be in the region.
457       if (IntrInst->getIntrinsicID() == Intrinsic::lifetime_start) {
458         if (Info.LifeStart)
459           return {};
460         Info.LifeStart = IntrInst;
461         continue;
462       }
463       if (IntrInst->getIntrinsicID() == Intrinsic::lifetime_end) {
464         if (Info.LifeEnd)
465           return {};
466         Info.LifeEnd = IntrInst;
467         continue;
468       }
469       // At this point, permit debug uses outside of the region.
470       // This is fixed in a later call to fixupDebugInfoPostExtraction().
471       if (isa<DbgInfoIntrinsic>(IntrInst))
472         continue;
473     }
474     // Find untracked uses of the address, bail.
475     if (!definedInRegion(Blocks, U))
476       return {};
477   }
478 
479   if (!Info.LifeStart || !Info.LifeEnd)
480     return {};
481 
482   Info.SinkLifeStart = !definedInRegion(Blocks, Info.LifeStart);
483   Info.HoistLifeEnd = !definedInRegion(Blocks, Info.LifeEnd);
484   // Do legality check.
485   if ((Info.SinkLifeStart || Info.HoistLifeEnd) &&
486       !isLegalToShrinkwrapLifetimeMarkers(CEAC, Addr))
487     return {};
488 
489   // Check to see if we have a place to do hoisting, if not, bail.
490   if (Info.HoistLifeEnd && !ExitBlock)
491     return {};
492 
493   return Info;
494 }
495 
496 void CodeExtractor::findAllocas(const CodeExtractorAnalysisCache &CEAC,
497                                 ValueSet &SinkCands, ValueSet &HoistCands,
498                                 BasicBlock *&ExitBlock) const {
499   Function *Func = (*Blocks.begin())->getParent();
500   ExitBlock = getCommonExitBlock(Blocks);
501 
502   auto moveOrIgnoreLifetimeMarkers =
503       [&](const LifetimeMarkerInfo &LMI) -> bool {
504     if (!LMI.LifeStart)
505       return false;
506     if (LMI.SinkLifeStart) {
507       LLVM_DEBUG(dbgs() << "Sinking lifetime.start: " << *LMI.LifeStart
508                         << "\n");
509       SinkCands.insert(LMI.LifeStart);
510     }
511     if (LMI.HoistLifeEnd) {
512       LLVM_DEBUG(dbgs() << "Hoisting lifetime.end: " << *LMI.LifeEnd << "\n");
513       HoistCands.insert(LMI.LifeEnd);
514     }
515     return true;
516   };
517 
518   // Look up allocas in the original function in CodeExtractorAnalysisCache, as
519   // this is much faster than walking all the instructions.
520   for (AllocaInst *AI : CEAC.getAllocas()) {
521     BasicBlock *BB = AI->getParent();
522     if (Blocks.count(BB))
523       continue;
524 
525     // As a prior call to extractCodeRegion() may have shrinkwrapped the alloca,
526     // check whether it is actually still in the original function.
527     Function *AIFunc = BB->getParent();
528     if (AIFunc != Func)
529       continue;
530 
531     LifetimeMarkerInfo MarkerInfo = getLifetimeMarkers(CEAC, AI, ExitBlock);
532     bool Moved = moveOrIgnoreLifetimeMarkers(MarkerInfo);
533     if (Moved) {
534       LLVM_DEBUG(dbgs() << "Sinking alloca: " << *AI << "\n");
535       SinkCands.insert(AI);
536       continue;
537     }
538 
539     // Find bitcasts in the outlined region that have lifetime marker users
540     // outside that region. Replace the lifetime marker use with an
541     // outside region bitcast to avoid unnecessary alloca/reload instructions
542     // and extra lifetime markers.
543     SmallVector<Instruction *, 2> LifetimeBitcastUsers;
544     for (User *U : AI->users()) {
545       if (!definedInRegion(Blocks, U))
546         continue;
547 
548       if (U->stripInBoundsConstantOffsets() != AI)
549         continue;
550 
551       Instruction *Bitcast = cast<Instruction>(U);
552       for (User *BU : Bitcast->users()) {
553         IntrinsicInst *IntrInst = dyn_cast<IntrinsicInst>(BU);
554         if (!IntrInst)
555           continue;
556 
557         if (!IntrInst->isLifetimeStartOrEnd())
558           continue;
559 
560         if (definedInRegion(Blocks, IntrInst))
561           continue;
562 
563         LLVM_DEBUG(dbgs() << "Replace use of extracted region bitcast"
564                           << *Bitcast << " in out-of-region lifetime marker "
565                           << *IntrInst << "\n");
566         LifetimeBitcastUsers.push_back(IntrInst);
567       }
568     }
569 
570     for (Instruction *I : LifetimeBitcastUsers) {
571       Module *M = AIFunc->getParent();
572       LLVMContext &Ctx = M->getContext();
573       auto *Int8PtrTy = Type::getInt8PtrTy(Ctx);
574       CastInst *CastI =
575           CastInst::CreatePointerCast(AI, Int8PtrTy, "lt.cast", I);
576       I->replaceUsesOfWith(I->getOperand(1), CastI);
577     }
578 
579     // Follow any bitcasts.
580     SmallVector<Instruction *, 2> Bitcasts;
581     SmallVector<LifetimeMarkerInfo, 2> BitcastLifetimeInfo;
582     for (User *U : AI->users()) {
583       if (U->stripInBoundsConstantOffsets() == AI) {
584         Instruction *Bitcast = cast<Instruction>(U);
585         LifetimeMarkerInfo LMI = getLifetimeMarkers(CEAC, Bitcast, ExitBlock);
586         if (LMI.LifeStart) {
587           Bitcasts.push_back(Bitcast);
588           BitcastLifetimeInfo.push_back(LMI);
589           continue;
590         }
591       }
592 
593       // Found unknown use of AI.
594       if (!definedInRegion(Blocks, U)) {
595         Bitcasts.clear();
596         break;
597       }
598     }
599 
600     // Either no bitcasts reference the alloca or there are unknown uses.
601     if (Bitcasts.empty())
602       continue;
603 
604     LLVM_DEBUG(dbgs() << "Sinking alloca (via bitcast): " << *AI << "\n");
605     SinkCands.insert(AI);
606     for (unsigned I = 0, E = Bitcasts.size(); I != E; ++I) {
607       Instruction *BitcastAddr = Bitcasts[I];
608       const LifetimeMarkerInfo &LMI = BitcastLifetimeInfo[I];
609       assert(LMI.LifeStart &&
610              "Unsafe to sink bitcast without lifetime markers");
611       moveOrIgnoreLifetimeMarkers(LMI);
612       if (!definedInRegion(Blocks, BitcastAddr)) {
613         LLVM_DEBUG(dbgs() << "Sinking bitcast-of-alloca: " << *BitcastAddr
614                           << "\n");
615         SinkCands.insert(BitcastAddr);
616       }
617     }
618   }
619 }
620 
621 bool CodeExtractor::isEligible() const {
622   if (Blocks.empty())
623     return false;
624   BasicBlock *Header = *Blocks.begin();
625   Function *F = Header->getParent();
626 
627   // For functions with varargs, check that varargs handling is only done in the
628   // outlined function, i.e vastart and vaend are only used in outlined blocks.
629   if (AllowVarArgs && F->getFunctionType()->isVarArg()) {
630     auto containsVarArgIntrinsic = [](const Instruction &I) {
631       if (const CallInst *CI = dyn_cast<CallInst>(&I))
632         if (const Function *Callee = CI->getCalledFunction())
633           return Callee->getIntrinsicID() == Intrinsic::vastart ||
634                  Callee->getIntrinsicID() == Intrinsic::vaend;
635       return false;
636     };
637 
638     for (auto &BB : *F) {
639       if (Blocks.count(&BB))
640         continue;
641       if (llvm::any_of(BB, containsVarArgIntrinsic))
642         return false;
643     }
644   }
645   return true;
646 }
647 
648 void CodeExtractor::findInputsOutputs(ValueSet &Inputs, ValueSet &Outputs,
649                                       const ValueSet &SinkCands) const {
650   for (BasicBlock *BB : Blocks) {
651     // If a used value is defined outside the region, it's an input.  If an
652     // instruction is used outside the region, it's an output.
653     for (Instruction &II : *BB) {
654       for (auto &OI : II.operands()) {
655         Value *V = OI;
656         if (!SinkCands.count(V) && definedInCaller(Blocks, V))
657           Inputs.insert(V);
658       }
659 
660       for (User *U : II.users())
661         if (!definedInRegion(Blocks, U)) {
662           Outputs.insert(&II);
663           break;
664         }
665     }
666   }
667 }
668 
669 /// severSplitPHINodesOfEntry - If a PHI node has multiple inputs from outside
670 /// of the region, we need to split the entry block of the region so that the
671 /// PHI node is easier to deal with.
672 void CodeExtractor::severSplitPHINodesOfEntry(BasicBlock *&Header) {
673   unsigned NumPredsFromRegion = 0;
674   unsigned NumPredsOutsideRegion = 0;
675 
676   if (Header != &Header->getParent()->getEntryBlock()) {
677     PHINode *PN = dyn_cast<PHINode>(Header->begin());
678     if (!PN) return;  // No PHI nodes.
679 
680     // If the header node contains any PHI nodes, check to see if there is more
681     // than one entry from outside the region.  If so, we need to sever the
682     // header block into two.
683     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
684       if (Blocks.count(PN->getIncomingBlock(i)))
685         ++NumPredsFromRegion;
686       else
687         ++NumPredsOutsideRegion;
688 
689     // If there is one (or fewer) predecessor from outside the region, we don't
690     // need to do anything special.
691     if (NumPredsOutsideRegion <= 1) return;
692   }
693 
694   // Otherwise, we need to split the header block into two pieces: one
695   // containing PHI nodes merging values from outside of the region, and a
696   // second that contains all of the code for the block and merges back any
697   // incoming values from inside of the region.
698   BasicBlock *NewBB = SplitBlock(Header, Header->getFirstNonPHI(), DT);
699 
700   // We only want to code extract the second block now, and it becomes the new
701   // header of the region.
702   BasicBlock *OldPred = Header;
703   Blocks.remove(OldPred);
704   Blocks.insert(NewBB);
705   Header = NewBB;
706 
707   // Okay, now we need to adjust the PHI nodes and any branches from within the
708   // region to go to the new header block instead of the old header block.
709   if (NumPredsFromRegion) {
710     PHINode *PN = cast<PHINode>(OldPred->begin());
711     // Loop over all of the predecessors of OldPred that are in the region,
712     // changing them to branch to NewBB instead.
713     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
714       if (Blocks.count(PN->getIncomingBlock(i))) {
715         Instruction *TI = PN->getIncomingBlock(i)->getTerminator();
716         TI->replaceUsesOfWith(OldPred, NewBB);
717       }
718 
719     // Okay, everything within the region is now branching to the right block, we
720     // just have to update the PHI nodes now, inserting PHI nodes into NewBB.
721     BasicBlock::iterator AfterPHIs;
722     for (AfterPHIs = OldPred->begin(); isa<PHINode>(AfterPHIs); ++AfterPHIs) {
723       PHINode *PN = cast<PHINode>(AfterPHIs);
724       // Create a new PHI node in the new region, which has an incoming value
725       // from OldPred of PN.
726       PHINode *NewPN = PHINode::Create(PN->getType(), 1 + NumPredsFromRegion,
727                                        PN->getName() + ".ce", &NewBB->front());
728       PN->replaceAllUsesWith(NewPN);
729       NewPN->addIncoming(PN, OldPred);
730 
731       // Loop over all of the incoming value in PN, moving them to NewPN if they
732       // are from the extracted region.
733       for (unsigned i = 0; i != PN->getNumIncomingValues(); ++i) {
734         if (Blocks.count(PN->getIncomingBlock(i))) {
735           NewPN->addIncoming(PN->getIncomingValue(i), PN->getIncomingBlock(i));
736           PN->removeIncomingValue(i);
737           --i;
738         }
739       }
740     }
741   }
742 }
743 
744 /// severSplitPHINodesOfExits - if PHI nodes in exit blocks have inputs from
745 /// outlined region, we split these PHIs on two: one with inputs from region
746 /// and other with remaining incoming blocks; then first PHIs are placed in
747 /// outlined region.
748 void CodeExtractor::severSplitPHINodesOfExits(
749     const SmallPtrSetImpl<BasicBlock *> &Exits) {
750   for (BasicBlock *ExitBB : Exits) {
751     BasicBlock *NewBB = nullptr;
752 
753     for (PHINode &PN : ExitBB->phis()) {
754       // Find all incoming values from the outlining region.
755       SmallVector<unsigned, 2> IncomingVals;
756       for (unsigned i = 0; i < PN.getNumIncomingValues(); ++i)
757         if (Blocks.count(PN.getIncomingBlock(i)))
758           IncomingVals.push_back(i);
759 
760       // Do not process PHI if there is one (or fewer) predecessor from region.
761       // If PHI has exactly one predecessor from region, only this one incoming
762       // will be replaced on codeRepl block, so it should be safe to skip PHI.
763       if (IncomingVals.size() <= 1)
764         continue;
765 
766       // Create block for new PHIs and add it to the list of outlined if it
767       // wasn't done before.
768       if (!NewBB) {
769         NewBB = BasicBlock::Create(ExitBB->getContext(),
770                                    ExitBB->getName() + ".split",
771                                    ExitBB->getParent(), ExitBB);
772         SmallVector<BasicBlock *, 4> Preds(predecessors(ExitBB));
773         for (BasicBlock *PredBB : Preds)
774           if (Blocks.count(PredBB))
775             PredBB->getTerminator()->replaceUsesOfWith(ExitBB, NewBB);
776         BranchInst::Create(ExitBB, NewBB);
777         Blocks.insert(NewBB);
778       }
779 
780       // Split this PHI.
781       PHINode *NewPN =
782           PHINode::Create(PN.getType(), IncomingVals.size(),
783                           PN.getName() + ".ce", NewBB->getFirstNonPHI());
784       for (unsigned i : IncomingVals)
785         NewPN->addIncoming(PN.getIncomingValue(i), PN.getIncomingBlock(i));
786       for (unsigned i : reverse(IncomingVals))
787         PN.removeIncomingValue(i, false);
788       PN.addIncoming(NewPN, NewBB);
789     }
790   }
791 }
792 
793 void CodeExtractor::splitReturnBlocks() {
794   for (BasicBlock *Block : Blocks)
795     if (ReturnInst *RI = dyn_cast<ReturnInst>(Block->getTerminator())) {
796       BasicBlock *New =
797           Block->splitBasicBlock(RI->getIterator(), Block->getName() + ".ret");
798       if (DT) {
799         // Old dominates New. New node dominates all other nodes dominated
800         // by Old.
801         DomTreeNode *OldNode = DT->getNode(Block);
802         SmallVector<DomTreeNode *, 8> Children(OldNode->begin(),
803                                                OldNode->end());
804 
805         DomTreeNode *NewNode = DT->addNewBlock(New, Block);
806 
807         for (DomTreeNode *I : Children)
808           DT->changeImmediateDominator(I, NewNode);
809       }
810     }
811 }
812 
813 /// constructFunction - make a function based on inputs and outputs, as follows:
814 /// f(in0, ..., inN, out0, ..., outN)
815 Function *CodeExtractor::constructFunction(const ValueSet &inputs,
816                                            const ValueSet &outputs,
817                                            BasicBlock *header,
818                                            BasicBlock *newRootNode,
819                                            BasicBlock *newHeader,
820                                            Function *oldFunction,
821                                            Module *M) {
822   LLVM_DEBUG(dbgs() << "inputs: " << inputs.size() << "\n");
823   LLVM_DEBUG(dbgs() << "outputs: " << outputs.size() << "\n");
824 
825   // This function returns unsigned, outputs will go back by reference.
826   switch (NumExitBlocks) {
827   case 0:
828   case 1: RetTy = Type::getVoidTy(header->getContext()); break;
829   case 2: RetTy = Type::getInt1Ty(header->getContext()); break;
830   default: RetTy = Type::getInt16Ty(header->getContext()); break;
831   }
832 
833   std::vector<Type *> ParamTy;
834   std::vector<Type *> AggParamTy;
835   ValueSet StructValues;
836 
837   // Add the types of the input values to the function's argument list
838   for (Value *value : inputs) {
839     LLVM_DEBUG(dbgs() << "value used in func: " << *value << "\n");
840     if (AggregateArgs && !ExcludeArgsFromAggregate.contains(value)) {
841       AggParamTy.push_back(value->getType());
842       StructValues.insert(value);
843     } else
844       ParamTy.push_back(value->getType());
845   }
846 
847   // Add the types of the output values to the function's argument list.
848   for (Value *output : outputs) {
849     LLVM_DEBUG(dbgs() << "instr used in func: " << *output << "\n");
850     if (AggregateArgs && !ExcludeArgsFromAggregate.contains(output)) {
851       AggParamTy.push_back(output->getType());
852       StructValues.insert(output);
853     } else
854       ParamTy.push_back(PointerType::getUnqual(output->getType()));
855   }
856 
857   assert(
858       (ParamTy.size() + AggParamTy.size()) ==
859           (inputs.size() + outputs.size()) &&
860       "Number of scalar and aggregate params does not match inputs, outputs");
861   assert((StructValues.empty() || AggregateArgs) &&
862          "Expeced StructValues only with AggregateArgs set");
863 
864   // Concatenate scalar and aggregate params in ParamTy.
865   size_t NumScalarParams = ParamTy.size();
866   StructType *StructTy = nullptr;
867   if (AggregateArgs && !AggParamTy.empty()) {
868     StructTy = StructType::get(M->getContext(), AggParamTy);
869     ParamTy.push_back(PointerType::getUnqual(StructTy));
870   }
871 
872   LLVM_DEBUG({
873     dbgs() << "Function type: " << *RetTy << " f(";
874     for (Type *i : ParamTy)
875       dbgs() << *i << ", ";
876     dbgs() << ")\n";
877   });
878 
879   FunctionType *funcType = FunctionType::get(
880       RetTy, ParamTy, AllowVarArgs && oldFunction->isVarArg());
881 
882   std::string SuffixToUse =
883       Suffix.empty()
884           ? (header->getName().empty() ? "extracted" : header->getName().str())
885           : Suffix;
886   // Create the new function
887   Function *newFunction = Function::Create(
888       funcType, GlobalValue::InternalLinkage, oldFunction->getAddressSpace(),
889       oldFunction->getName() + "." + SuffixToUse, M);
890 
891   // Inherit all of the target dependent attributes and white-listed
892   // target independent attributes.
893   //  (e.g. If the extracted region contains a call to an x86.sse
894   //  instruction we need to make sure that the extracted region has the
895   //  "target-features" attribute allowing it to be lowered.
896   // FIXME: This should be changed to check to see if a specific
897   //           attribute can not be inherited.
898   for (const auto &Attr : oldFunction->getAttributes().getFnAttrs()) {
899     if (Attr.isStringAttribute()) {
900       if (Attr.getKindAsString() == "thunk")
901         continue;
902     } else
903       switch (Attr.getKindAsEnum()) {
904       // Those attributes cannot be propagated safely. Explicitly list them
905       // here so we get a warning if new attributes are added.
906       case Attribute::AllocSize:
907       case Attribute::ArgMemOnly:
908       case Attribute::Builtin:
909       case Attribute::Convergent:
910       case Attribute::InaccessibleMemOnly:
911       case Attribute::InaccessibleMemOrArgMemOnly:
912       case Attribute::JumpTable:
913       case Attribute::Naked:
914       case Attribute::NoBuiltin:
915       case Attribute::NoMerge:
916       case Attribute::NoReturn:
917       case Attribute::NoSync:
918       case Attribute::ReadNone:
919       case Attribute::ReadOnly:
920       case Attribute::ReturnsTwice:
921       case Attribute::Speculatable:
922       case Attribute::StackAlignment:
923       case Attribute::WillReturn:
924       case Attribute::WriteOnly:
925         continue;
926       // Those attributes should be safe to propagate to the extracted function.
927       case Attribute::AlwaysInline:
928       case Attribute::Cold:
929       case Attribute::DisableSanitizerInstrumentation:
930       case Attribute::Hot:
931       case Attribute::NoRecurse:
932       case Attribute::InlineHint:
933       case Attribute::MinSize:
934       case Attribute::NoCallback:
935       case Attribute::NoDuplicate:
936       case Attribute::NoFree:
937       case Attribute::NoImplicitFloat:
938       case Attribute::NoInline:
939       case Attribute::NonLazyBind:
940       case Attribute::NoRedZone:
941       case Attribute::NoUnwind:
942       case Attribute::NoSanitizeBounds:
943       case Attribute::NoSanitizeCoverage:
944       case Attribute::NullPointerIsValid:
945       case Attribute::OptForFuzzing:
946       case Attribute::OptimizeNone:
947       case Attribute::OptimizeForSize:
948       case Attribute::SafeStack:
949       case Attribute::ShadowCallStack:
950       case Attribute::SanitizeAddress:
951       case Attribute::SanitizeMemory:
952       case Attribute::SanitizeThread:
953       case Attribute::SanitizeHWAddress:
954       case Attribute::SanitizeMemTag:
955       case Attribute::SpeculativeLoadHardening:
956       case Attribute::StackProtect:
957       case Attribute::StackProtectReq:
958       case Attribute::StackProtectStrong:
959       case Attribute::StrictFP:
960       case Attribute::UWTable:
961       case Attribute::VScaleRange:
962       case Attribute::NoCfCheck:
963       case Attribute::MustProgress:
964       case Attribute::NoProfile:
965         break;
966       // These attributes cannot be applied to functions.
967       case Attribute::Alignment:
968       case Attribute::ByVal:
969       case Attribute::Dereferenceable:
970       case Attribute::DereferenceableOrNull:
971       case Attribute::ElementType:
972       case Attribute::InAlloca:
973       case Attribute::InReg:
974       case Attribute::Nest:
975       case Attribute::NoAlias:
976       case Attribute::NoCapture:
977       case Attribute::NoUndef:
978       case Attribute::NonNull:
979       case Attribute::Preallocated:
980       case Attribute::Returned:
981       case Attribute::SExt:
982       case Attribute::StructRet:
983       case Attribute::SwiftError:
984       case Attribute::SwiftSelf:
985       case Attribute::SwiftAsync:
986       case Attribute::ZExt:
987       case Attribute::ImmArg:
988       case Attribute::ByRef:
989       //  These are not really attributes.
990       case Attribute::None:
991       case Attribute::EndAttrKinds:
992       case Attribute::EmptyKey:
993       case Attribute::TombstoneKey:
994         llvm_unreachable("Not a function attribute");
995       }
996 
997     newFunction->addFnAttr(Attr);
998   }
999   newFunction->getBasicBlockList().push_back(newRootNode);
1000 
1001   // Create scalar and aggregate iterators to name all of the arguments we
1002   // inserted.
1003   Function::arg_iterator ScalarAI = newFunction->arg_begin();
1004   Function::arg_iterator AggAI = std::next(ScalarAI, NumScalarParams);
1005 
1006   // Rewrite all users of the inputs in the extracted region to use the
1007   // arguments (or appropriate addressing into struct) instead.
1008   for (unsigned i = 0, e = inputs.size(), aggIdx = 0; i != e; ++i) {
1009     Value *RewriteVal;
1010     if (AggregateArgs && StructValues.contains(inputs[i])) {
1011       Value *Idx[2];
1012       Idx[0] = Constant::getNullValue(Type::getInt32Ty(header->getContext()));
1013       Idx[1] = ConstantInt::get(Type::getInt32Ty(header->getContext()), aggIdx);
1014       Instruction *TI = newFunction->begin()->getTerminator();
1015       GetElementPtrInst *GEP = GetElementPtrInst::Create(
1016           StructTy, &*AggAI, Idx, "gep_" + inputs[i]->getName(), TI);
1017       RewriteVal = new LoadInst(StructTy->getElementType(aggIdx), GEP,
1018                                 "loadgep_" + inputs[i]->getName(), TI);
1019       ++aggIdx;
1020     } else
1021       RewriteVal = &*ScalarAI++;
1022 
1023     std::vector<User *> Users(inputs[i]->user_begin(), inputs[i]->user_end());
1024     for (User *use : Users)
1025       if (Instruction *inst = dyn_cast<Instruction>(use))
1026         if (Blocks.count(inst->getParent()))
1027           inst->replaceUsesOfWith(inputs[i], RewriteVal);
1028   }
1029 
1030   // Set names for input and output arguments.
1031   if (NumScalarParams) {
1032     ScalarAI = newFunction->arg_begin();
1033     for (unsigned i = 0, e = inputs.size(); i != e; ++i, ++ScalarAI)
1034       if (!StructValues.contains(inputs[i]))
1035         ScalarAI->setName(inputs[i]->getName());
1036     for (unsigned i = 0, e = outputs.size(); i != e; ++i, ++ScalarAI)
1037       if (!StructValues.contains(outputs[i]))
1038         ScalarAI->setName(outputs[i]->getName() + ".out");
1039   }
1040 
1041   // Rewrite branches to basic blocks outside of the loop to new dummy blocks
1042   // within the new function. This must be done before we lose track of which
1043   // blocks were originally in the code region.
1044   std::vector<User *> Users(header->user_begin(), header->user_end());
1045   for (auto &U : Users)
1046     // The BasicBlock which contains the branch is not in the region
1047     // modify the branch target to a new block
1048     if (Instruction *I = dyn_cast<Instruction>(U))
1049       if (I->isTerminator() && I->getFunction() == oldFunction &&
1050           !Blocks.count(I->getParent()))
1051         I->replaceUsesOfWith(header, newHeader);
1052 
1053   return newFunction;
1054 }
1055 
1056 /// Erase lifetime.start markers which reference inputs to the extraction
1057 /// region, and insert the referenced memory into \p LifetimesStart.
1058 ///
1059 /// The extraction region is defined by a set of blocks (\p Blocks), and a set
1060 /// of allocas which will be moved from the caller function into the extracted
1061 /// function (\p SunkAllocas).
1062 static void eraseLifetimeMarkersOnInputs(const SetVector<BasicBlock *> &Blocks,
1063                                          const SetVector<Value *> &SunkAllocas,
1064                                          SetVector<Value *> &LifetimesStart) {
1065   for (BasicBlock *BB : Blocks) {
1066     for (Instruction &I : llvm::make_early_inc_range(*BB)) {
1067       auto *II = dyn_cast<IntrinsicInst>(&I);
1068       if (!II || !II->isLifetimeStartOrEnd())
1069         continue;
1070 
1071       // Get the memory operand of the lifetime marker. If the underlying
1072       // object is a sunk alloca, or is otherwise defined in the extraction
1073       // region, the lifetime marker must not be erased.
1074       Value *Mem = II->getOperand(1)->stripInBoundsOffsets();
1075       if (SunkAllocas.count(Mem) || definedInRegion(Blocks, Mem))
1076         continue;
1077 
1078       if (II->getIntrinsicID() == Intrinsic::lifetime_start)
1079         LifetimesStart.insert(Mem);
1080       II->eraseFromParent();
1081     }
1082   }
1083 }
1084 
1085 /// Insert lifetime start/end markers surrounding the call to the new function
1086 /// for objects defined in the caller.
1087 static void insertLifetimeMarkersSurroundingCall(
1088     Module *M, ArrayRef<Value *> LifetimesStart, ArrayRef<Value *> LifetimesEnd,
1089     CallInst *TheCall) {
1090   LLVMContext &Ctx = M->getContext();
1091   auto Int8PtrTy = Type::getInt8PtrTy(Ctx);
1092   auto NegativeOne = ConstantInt::getSigned(Type::getInt64Ty(Ctx), -1);
1093   Instruction *Term = TheCall->getParent()->getTerminator();
1094 
1095   // The memory argument to a lifetime marker must be a i8*. Cache any bitcasts
1096   // needed to satisfy this requirement so they may be reused.
1097   DenseMap<Value *, Value *> Bitcasts;
1098 
1099   // Emit lifetime markers for the pointers given in \p Objects. Insert the
1100   // markers before the call if \p InsertBefore, and after the call otherwise.
1101   auto insertMarkers = [&](Function *MarkerFunc, ArrayRef<Value *> Objects,
1102                            bool InsertBefore) {
1103     for (Value *Mem : Objects) {
1104       assert((!isa<Instruction>(Mem) || cast<Instruction>(Mem)->getFunction() ==
1105                                             TheCall->getFunction()) &&
1106              "Input memory not defined in original function");
1107       Value *&MemAsI8Ptr = Bitcasts[Mem];
1108       if (!MemAsI8Ptr) {
1109         if (Mem->getType() == Int8PtrTy)
1110           MemAsI8Ptr = Mem;
1111         else
1112           MemAsI8Ptr =
1113               CastInst::CreatePointerCast(Mem, Int8PtrTy, "lt.cast", TheCall);
1114       }
1115 
1116       auto Marker = CallInst::Create(MarkerFunc, {NegativeOne, MemAsI8Ptr});
1117       if (InsertBefore)
1118         Marker->insertBefore(TheCall);
1119       else
1120         Marker->insertBefore(Term);
1121     }
1122   };
1123 
1124   if (!LifetimesStart.empty()) {
1125     auto StartFn = llvm::Intrinsic::getDeclaration(
1126         M, llvm::Intrinsic::lifetime_start, Int8PtrTy);
1127     insertMarkers(StartFn, LifetimesStart, /*InsertBefore=*/true);
1128   }
1129 
1130   if (!LifetimesEnd.empty()) {
1131     auto EndFn = llvm::Intrinsic::getDeclaration(
1132         M, llvm::Intrinsic::lifetime_end, Int8PtrTy);
1133     insertMarkers(EndFn, LifetimesEnd, /*InsertBefore=*/false);
1134   }
1135 }
1136 
1137 /// emitCallAndSwitchStatement - This method sets up the caller side by adding
1138 /// the call instruction, splitting any PHI nodes in the header block as
1139 /// necessary.
1140 CallInst *CodeExtractor::emitCallAndSwitchStatement(Function *newFunction,
1141                                                     BasicBlock *codeReplacer,
1142                                                     ValueSet &inputs,
1143                                                     ValueSet &outputs) {
1144   // Emit a call to the new function, passing in: *pointer to struct (if
1145   // aggregating parameters), or plan inputs and allocated memory for outputs
1146   std::vector<Value *> params, ReloadOutputs, Reloads;
1147   ValueSet StructValues;
1148 
1149   Module *M = newFunction->getParent();
1150   LLVMContext &Context = M->getContext();
1151   const DataLayout &DL = M->getDataLayout();
1152   CallInst *call = nullptr;
1153 
1154   // Add inputs as params, or to be filled into the struct
1155   unsigned ScalarInputArgNo = 0;
1156   SmallVector<unsigned, 1> SwiftErrorArgs;
1157   for (Value *input : inputs) {
1158     if (AggregateArgs && !ExcludeArgsFromAggregate.contains(input))
1159       StructValues.insert(input);
1160     else {
1161       params.push_back(input);
1162       if (input->isSwiftError())
1163         SwiftErrorArgs.push_back(ScalarInputArgNo);
1164     }
1165     ++ScalarInputArgNo;
1166   }
1167 
1168   // Create allocas for the outputs
1169   unsigned ScalarOutputArgNo = 0;
1170   for (Value *output : outputs) {
1171     if (AggregateArgs && !ExcludeArgsFromAggregate.contains(output)) {
1172       StructValues.insert(output);
1173     } else {
1174       AllocaInst *alloca =
1175         new AllocaInst(output->getType(), DL.getAllocaAddrSpace(),
1176                        nullptr, output->getName() + ".loc",
1177                        &codeReplacer->getParent()->front().front());
1178       ReloadOutputs.push_back(alloca);
1179       params.push_back(alloca);
1180       ++ScalarOutputArgNo;
1181     }
1182   }
1183 
1184   StructType *StructArgTy = nullptr;
1185   AllocaInst *Struct = nullptr;
1186   unsigned NumAggregatedInputs = 0;
1187   if (AggregateArgs && !StructValues.empty()) {
1188     std::vector<Type *> ArgTypes;
1189     for (Value *V : StructValues)
1190       ArgTypes.push_back(V->getType());
1191 
1192     // Allocate a struct at the beginning of this function
1193     StructArgTy = StructType::get(newFunction->getContext(), ArgTypes);
1194     Struct = new AllocaInst(StructArgTy, DL.getAllocaAddrSpace(), nullptr,
1195                             "structArg",
1196                             &codeReplacer->getParent()->front().front());
1197     params.push_back(Struct);
1198 
1199     // Store aggregated inputs in the struct.
1200     for (unsigned i = 0, e = StructValues.size(); i != e; ++i) {
1201       if (inputs.contains(StructValues[i])) {
1202         Value *Idx[2];
1203         Idx[0] = Constant::getNullValue(Type::getInt32Ty(Context));
1204         Idx[1] = ConstantInt::get(Type::getInt32Ty(Context), i);
1205         GetElementPtrInst *GEP = GetElementPtrInst::Create(
1206             StructArgTy, Struct, Idx, "gep_" + StructValues[i]->getName());
1207         codeReplacer->getInstList().push_back(GEP);
1208         new StoreInst(StructValues[i], GEP, codeReplacer);
1209         NumAggregatedInputs++;
1210       }
1211     }
1212   }
1213 
1214   // Emit the call to the function
1215   call = CallInst::Create(newFunction, params,
1216                           NumExitBlocks > 1 ? "targetBlock" : "");
1217   // Add debug location to the new call, if the original function has debug
1218   // info. In that case, the terminator of the entry block of the extracted
1219   // function contains the first debug location of the extracted function,
1220   // set in extractCodeRegion.
1221   if (codeReplacer->getParent()->getSubprogram()) {
1222     if (auto DL = newFunction->getEntryBlock().getTerminator()->getDebugLoc())
1223       call->setDebugLoc(DL);
1224   }
1225   codeReplacer->getInstList().push_back(call);
1226 
1227   // Set swifterror parameter attributes.
1228   for (unsigned SwiftErrArgNo : SwiftErrorArgs) {
1229     call->addParamAttr(SwiftErrArgNo, Attribute::SwiftError);
1230     newFunction->addParamAttr(SwiftErrArgNo, Attribute::SwiftError);
1231   }
1232 
1233   // Reload the outputs passed in by reference, use the struct if output is in
1234   // the aggregate or reload from the scalar argument.
1235   for (unsigned i = 0, e = outputs.size(), scalarIdx = 0,
1236                 aggIdx = NumAggregatedInputs;
1237        i != e; ++i) {
1238     Value *Output = nullptr;
1239     if (AggregateArgs && StructValues.contains(outputs[i])) {
1240       Value *Idx[2];
1241       Idx[0] = Constant::getNullValue(Type::getInt32Ty(Context));
1242       Idx[1] = ConstantInt::get(Type::getInt32Ty(Context), aggIdx);
1243       GetElementPtrInst *GEP = GetElementPtrInst::Create(
1244           StructArgTy, Struct, Idx, "gep_reload_" + outputs[i]->getName());
1245       codeReplacer->getInstList().push_back(GEP);
1246       Output = GEP;
1247       ++aggIdx;
1248     } else {
1249       Output = ReloadOutputs[scalarIdx];
1250       ++scalarIdx;
1251     }
1252     LoadInst *load = new LoadInst(outputs[i]->getType(), Output,
1253                                   outputs[i]->getName() + ".reload",
1254                                   codeReplacer);
1255     Reloads.push_back(load);
1256     std::vector<User *> Users(outputs[i]->user_begin(), outputs[i]->user_end());
1257     for (unsigned u = 0, e = Users.size(); u != e; ++u) {
1258       Instruction *inst = cast<Instruction>(Users[u]);
1259       if (!Blocks.count(inst->getParent()))
1260         inst->replaceUsesOfWith(outputs[i], load);
1261     }
1262   }
1263 
1264   // Now we can emit a switch statement using the call as a value.
1265   SwitchInst *TheSwitch =
1266       SwitchInst::Create(Constant::getNullValue(Type::getInt16Ty(Context)),
1267                          codeReplacer, 0, codeReplacer);
1268 
1269   // Since there may be multiple exits from the original region, make the new
1270   // function return an unsigned, switch on that number.  This loop iterates
1271   // over all of the blocks in the extracted region, updating any terminator
1272   // instructions in the to-be-extracted region that branch to blocks that are
1273   // not in the region to be extracted.
1274   std::map<BasicBlock *, BasicBlock *> ExitBlockMap;
1275 
1276   // Iterate over the previously collected targets, and create new blocks inside
1277   // the function to branch to.
1278   unsigned switchVal = 0;
1279   for (BasicBlock *OldTarget : OldTargets) {
1280     if (Blocks.count(OldTarget))
1281       continue;
1282     BasicBlock *&NewTarget = ExitBlockMap[OldTarget];
1283     if (NewTarget)
1284       continue;
1285 
1286     // If we don't already have an exit stub for this non-extracted
1287     // destination, create one now!
1288     NewTarget = BasicBlock::Create(Context,
1289                                     OldTarget->getName() + ".exitStub",
1290                                     newFunction);
1291     unsigned SuccNum = switchVal++;
1292 
1293     Value *brVal = nullptr;
1294     assert(NumExitBlocks < 0xffff && "too many exit blocks for switch");
1295     switch (NumExitBlocks) {
1296     case 0:
1297     case 1: break;  // No value needed.
1298     case 2:         // Conditional branch, return a bool
1299       brVal = ConstantInt::get(Type::getInt1Ty(Context), !SuccNum);
1300       break;
1301     default:
1302       brVal = ConstantInt::get(Type::getInt16Ty(Context), SuccNum);
1303       break;
1304     }
1305 
1306     ReturnInst::Create(Context, brVal, NewTarget);
1307 
1308     // Update the switch instruction.
1309     TheSwitch->addCase(ConstantInt::get(Type::getInt16Ty(Context),
1310                                         SuccNum),
1311                         OldTarget);
1312   }
1313 
1314   for (BasicBlock *Block : Blocks) {
1315     Instruction *TI = Block->getTerminator();
1316     for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i) {
1317       if (Blocks.count(TI->getSuccessor(i)))
1318         continue;
1319       BasicBlock *OldTarget = TI->getSuccessor(i);
1320       // add a new basic block which returns the appropriate value
1321       BasicBlock *NewTarget = ExitBlockMap[OldTarget];
1322       assert(NewTarget && "Unknown target block!");
1323 
1324       // rewrite the original branch instruction with this new target
1325       TI->setSuccessor(i, NewTarget);
1326    }
1327   }
1328 
1329   // Store the arguments right after the definition of output value.
1330   // This should be proceeded after creating exit stubs to be ensure that invoke
1331   // result restore will be placed in the outlined function.
1332   Function::arg_iterator ScalarOutputArgBegin = newFunction->arg_begin();
1333   std::advance(ScalarOutputArgBegin, ScalarInputArgNo);
1334   Function::arg_iterator AggOutputArgBegin = newFunction->arg_begin();
1335   std::advance(AggOutputArgBegin, ScalarInputArgNo + ScalarOutputArgNo);
1336 
1337   for (unsigned i = 0, e = outputs.size(), aggIdx = NumAggregatedInputs; i != e;
1338        ++i) {
1339     auto *OutI = dyn_cast<Instruction>(outputs[i]);
1340     if (!OutI)
1341       continue;
1342 
1343     // Find proper insertion point.
1344     BasicBlock::iterator InsertPt;
1345     // In case OutI is an invoke, we insert the store at the beginning in the
1346     // 'normal destination' BB. Otherwise we insert the store right after OutI.
1347     if (auto *InvokeI = dyn_cast<InvokeInst>(OutI))
1348       InsertPt = InvokeI->getNormalDest()->getFirstInsertionPt();
1349     else if (auto *Phi = dyn_cast<PHINode>(OutI))
1350       InsertPt = Phi->getParent()->getFirstInsertionPt();
1351     else
1352       InsertPt = std::next(OutI->getIterator());
1353 
1354     Instruction *InsertBefore = &*InsertPt;
1355     assert((InsertBefore->getFunction() == newFunction ||
1356             Blocks.count(InsertBefore->getParent())) &&
1357            "InsertPt should be in new function");
1358     if (AggregateArgs && StructValues.contains(outputs[i])) {
1359       assert(AggOutputArgBegin != newFunction->arg_end() &&
1360              "Number of aggregate output arguments should match "
1361              "the number of defined values");
1362       Value *Idx[2];
1363       Idx[0] = Constant::getNullValue(Type::getInt32Ty(Context));
1364       Idx[1] = ConstantInt::get(Type::getInt32Ty(Context), aggIdx);
1365       GetElementPtrInst *GEP = GetElementPtrInst::Create(
1366           StructArgTy, &*AggOutputArgBegin, Idx, "gep_" + outputs[i]->getName(),
1367           InsertBefore);
1368       new StoreInst(outputs[i], GEP, InsertBefore);
1369       ++aggIdx;
1370       // Since there should be only one struct argument aggregating
1371       // all the output values, we shouldn't increment AggOutputArgBegin, which
1372       // always points to the struct argument, in this case.
1373     } else {
1374       assert(ScalarOutputArgBegin != newFunction->arg_end() &&
1375              "Number of scalar output arguments should match "
1376              "the number of defined values");
1377       new StoreInst(outputs[i], &*ScalarOutputArgBegin, InsertBefore);
1378       ++ScalarOutputArgBegin;
1379     }
1380   }
1381 
1382   // Now that we've done the deed, simplify the switch instruction.
1383   Type *OldFnRetTy = TheSwitch->getParent()->getParent()->getReturnType();
1384   switch (NumExitBlocks) {
1385   case 0:
1386     // There are no successors (the block containing the switch itself), which
1387     // means that previously this was the last part of the function, and hence
1388     // this should be rewritten as a `ret'
1389 
1390     // Check if the function should return a value
1391     if (OldFnRetTy->isVoidTy()) {
1392       ReturnInst::Create(Context, nullptr, TheSwitch);  // Return void
1393     } else if (OldFnRetTy == TheSwitch->getCondition()->getType()) {
1394       // return what we have
1395       ReturnInst::Create(Context, TheSwitch->getCondition(), TheSwitch);
1396     } else {
1397       // Otherwise we must have code extracted an unwind or something, just
1398       // return whatever we want.
1399       ReturnInst::Create(Context,
1400                          Constant::getNullValue(OldFnRetTy), TheSwitch);
1401     }
1402 
1403     TheSwitch->eraseFromParent();
1404     break;
1405   case 1:
1406     // Only a single destination, change the switch into an unconditional
1407     // branch.
1408     BranchInst::Create(TheSwitch->getSuccessor(1), TheSwitch);
1409     TheSwitch->eraseFromParent();
1410     break;
1411   case 2:
1412     BranchInst::Create(TheSwitch->getSuccessor(1), TheSwitch->getSuccessor(2),
1413                        call, TheSwitch);
1414     TheSwitch->eraseFromParent();
1415     break;
1416   default:
1417     // Otherwise, make the default destination of the switch instruction be one
1418     // of the other successors.
1419     TheSwitch->setCondition(call);
1420     TheSwitch->setDefaultDest(TheSwitch->getSuccessor(NumExitBlocks));
1421     // Remove redundant case
1422     TheSwitch->removeCase(SwitchInst::CaseIt(TheSwitch, NumExitBlocks-1));
1423     break;
1424   }
1425 
1426   // Insert lifetime markers around the reloads of any output values. The
1427   // allocas output values are stored in are only in-use in the codeRepl block.
1428   insertLifetimeMarkersSurroundingCall(M, ReloadOutputs, ReloadOutputs, call);
1429 
1430   return call;
1431 }
1432 
1433 void CodeExtractor::moveCodeToFunction(Function *newFunction) {
1434   Function *oldFunc = (*Blocks.begin())->getParent();
1435   Function::BasicBlockListType &oldBlocks = oldFunc->getBasicBlockList();
1436   Function::BasicBlockListType &newBlocks = newFunction->getBasicBlockList();
1437 
1438   auto newFuncIt = newFunction->front().getIterator();
1439   for (BasicBlock *Block : Blocks) {
1440     // Delete the basic block from the old function, and the list of blocks
1441     oldBlocks.remove(Block);
1442 
1443     // Insert this basic block into the new function
1444     // Insert the original blocks after the entry block created
1445     // for the new function. The entry block may be followed
1446     // by a set of exit blocks at this point, but these exit
1447     // blocks better be placed at the end of the new function.
1448     newFuncIt = newBlocks.insertAfter(newFuncIt, Block);
1449   }
1450 }
1451 
1452 void CodeExtractor::calculateNewCallTerminatorWeights(
1453     BasicBlock *CodeReplacer,
1454     DenseMap<BasicBlock *, BlockFrequency> &ExitWeights,
1455     BranchProbabilityInfo *BPI) {
1456   using Distribution = BlockFrequencyInfoImplBase::Distribution;
1457   using BlockNode = BlockFrequencyInfoImplBase::BlockNode;
1458 
1459   // Update the branch weights for the exit block.
1460   Instruction *TI = CodeReplacer->getTerminator();
1461   SmallVector<unsigned, 8> BranchWeights(TI->getNumSuccessors(), 0);
1462 
1463   // Block Frequency distribution with dummy node.
1464   Distribution BranchDist;
1465 
1466   SmallVector<BranchProbability, 4> EdgeProbabilities(
1467       TI->getNumSuccessors(), BranchProbability::getUnknown());
1468 
1469   // Add each of the frequencies of the successors.
1470   for (unsigned i = 0, e = TI->getNumSuccessors(); i < e; ++i) {
1471     BlockNode ExitNode(i);
1472     uint64_t ExitFreq = ExitWeights[TI->getSuccessor(i)].getFrequency();
1473     if (ExitFreq != 0)
1474       BranchDist.addExit(ExitNode, ExitFreq);
1475     else
1476       EdgeProbabilities[i] = BranchProbability::getZero();
1477   }
1478 
1479   // Check for no total weight.
1480   if (BranchDist.Total == 0) {
1481     BPI->setEdgeProbability(CodeReplacer, EdgeProbabilities);
1482     return;
1483   }
1484 
1485   // Normalize the distribution so that they can fit in unsigned.
1486   BranchDist.normalize();
1487 
1488   // Create normalized branch weights and set the metadata.
1489   for (unsigned I = 0, E = BranchDist.Weights.size(); I < E; ++I) {
1490     const auto &Weight = BranchDist.Weights[I];
1491 
1492     // Get the weight and update the current BFI.
1493     BranchWeights[Weight.TargetNode.Index] = Weight.Amount;
1494     BranchProbability BP(Weight.Amount, BranchDist.Total);
1495     EdgeProbabilities[Weight.TargetNode.Index] = BP;
1496   }
1497   BPI->setEdgeProbability(CodeReplacer, EdgeProbabilities);
1498   TI->setMetadata(
1499       LLVMContext::MD_prof,
1500       MDBuilder(TI->getContext()).createBranchWeights(BranchWeights));
1501 }
1502 
1503 /// Erase debug info intrinsics which refer to values in \p F but aren't in
1504 /// \p F.
1505 static void eraseDebugIntrinsicsWithNonLocalRefs(Function &F) {
1506   for (Instruction &I : instructions(F)) {
1507     SmallVector<DbgVariableIntrinsic *, 4> DbgUsers;
1508     findDbgUsers(DbgUsers, &I);
1509     for (DbgVariableIntrinsic *DVI : DbgUsers)
1510       if (DVI->getFunction() != &F)
1511         DVI->eraseFromParent();
1512   }
1513 }
1514 
1515 /// Fix up the debug info in the old and new functions by pointing line
1516 /// locations and debug intrinsics to the new subprogram scope, and by deleting
1517 /// intrinsics which point to values outside of the new function.
1518 static void fixupDebugInfoPostExtraction(Function &OldFunc, Function &NewFunc,
1519                                          CallInst &TheCall) {
1520   DISubprogram *OldSP = OldFunc.getSubprogram();
1521   LLVMContext &Ctx = OldFunc.getContext();
1522 
1523   if (!OldSP) {
1524     // Erase any debug info the new function contains.
1525     stripDebugInfo(NewFunc);
1526     // Make sure the old function doesn't contain any non-local metadata refs.
1527     eraseDebugIntrinsicsWithNonLocalRefs(NewFunc);
1528     return;
1529   }
1530 
1531   // Create a subprogram for the new function. Leave out a description of the
1532   // function arguments, as the parameters don't correspond to anything at the
1533   // source level.
1534   assert(OldSP->getUnit() && "Missing compile unit for subprogram");
1535   DIBuilder DIB(*OldFunc.getParent(), /*AllowUnresolved=*/false,
1536                 OldSP->getUnit());
1537   auto SPType = DIB.createSubroutineType(DIB.getOrCreateTypeArray(None));
1538   DISubprogram::DISPFlags SPFlags = DISubprogram::SPFlagDefinition |
1539                                     DISubprogram::SPFlagOptimized |
1540                                     DISubprogram::SPFlagLocalToUnit;
1541   auto NewSP = DIB.createFunction(
1542       OldSP->getUnit(), NewFunc.getName(), NewFunc.getName(), OldSP->getFile(),
1543       /*LineNo=*/0, SPType, /*ScopeLine=*/0, DINode::FlagZero, SPFlags);
1544   NewFunc.setSubprogram(NewSP);
1545 
1546   // Debug intrinsics in the new function need to be updated in one of two
1547   // ways:
1548   //  1) They need to be deleted, because they describe a value in the old
1549   //     function.
1550   //  2) They need to point to fresh metadata, e.g. because they currently
1551   //     point to a variable in the wrong scope.
1552   SmallDenseMap<DINode *, DINode *> RemappedMetadata;
1553   SmallVector<Instruction *, 4> DebugIntrinsicsToDelete;
1554   for (Instruction &I : instructions(NewFunc)) {
1555     auto *DII = dyn_cast<DbgInfoIntrinsic>(&I);
1556     if (!DII)
1557       continue;
1558 
1559     // Point the intrinsic to a fresh label within the new function.
1560     if (auto *DLI = dyn_cast<DbgLabelInst>(&I)) {
1561       DILabel *OldLabel = DLI->getLabel();
1562       DINode *&NewLabel = RemappedMetadata[OldLabel];
1563       if (!NewLabel)
1564         NewLabel = DILabel::get(Ctx, NewSP, OldLabel->getName(),
1565                                 OldLabel->getFile(), OldLabel->getLine());
1566       DLI->setArgOperand(0, MetadataAsValue::get(Ctx, NewLabel));
1567       continue;
1568     }
1569 
1570     auto IsInvalidLocation = [&NewFunc](Value *Location) {
1571       // Location is invalid if it isn't a constant or an instruction, or is an
1572       // instruction but isn't in the new function.
1573       if (!Location ||
1574           (!isa<Constant>(Location) && !isa<Instruction>(Location)))
1575         return true;
1576       Instruction *LocationInst = dyn_cast<Instruction>(Location);
1577       return LocationInst && LocationInst->getFunction() != &NewFunc;
1578     };
1579 
1580     auto *DVI = cast<DbgVariableIntrinsic>(DII);
1581     // If any of the used locations are invalid, delete the intrinsic.
1582     if (any_of(DVI->location_ops(), IsInvalidLocation)) {
1583       DebugIntrinsicsToDelete.push_back(DVI);
1584       continue;
1585     }
1586 
1587     // Point the intrinsic to a fresh variable within the new function.
1588     DILocalVariable *OldVar = DVI->getVariable();
1589     DINode *&NewVar = RemappedMetadata[OldVar];
1590     if (!NewVar)
1591       NewVar = DIB.createAutoVariable(
1592           NewSP, OldVar->getName(), OldVar->getFile(), OldVar->getLine(),
1593           OldVar->getType(), /*AlwaysPreserve=*/false, DINode::FlagZero,
1594           OldVar->getAlignInBits());
1595     DVI->setVariable(cast<DILocalVariable>(NewVar));
1596   }
1597   for (auto *DII : DebugIntrinsicsToDelete)
1598     DII->eraseFromParent();
1599   DIB.finalizeSubprogram(NewSP);
1600 
1601   // Fix up the scope information attached to the line locations in the new
1602   // function.
1603   for (Instruction &I : instructions(NewFunc)) {
1604     if (const DebugLoc &DL = I.getDebugLoc())
1605       I.setDebugLoc(DILocation::get(Ctx, DL.getLine(), DL.getCol(), NewSP));
1606 
1607     // Loop info metadata may contain line locations. Fix them up.
1608     auto updateLoopInfoLoc = [&Ctx, NewSP](Metadata *MD) -> Metadata * {
1609       if (auto *Loc = dyn_cast_or_null<DILocation>(MD))
1610         return DILocation::get(Ctx, Loc->getLine(), Loc->getColumn(), NewSP,
1611                                nullptr);
1612       return MD;
1613     };
1614     updateLoopMetadataDebugLocations(I, updateLoopInfoLoc);
1615   }
1616   if (!TheCall.getDebugLoc())
1617     TheCall.setDebugLoc(DILocation::get(Ctx, 0, 0, OldSP));
1618 
1619   eraseDebugIntrinsicsWithNonLocalRefs(NewFunc);
1620 }
1621 
1622 Function *
1623 CodeExtractor::extractCodeRegion(const CodeExtractorAnalysisCache &CEAC) {
1624   ValueSet Inputs, Outputs;
1625   return extractCodeRegion(CEAC, Inputs, Outputs);
1626 }
1627 
1628 Function *
1629 CodeExtractor::extractCodeRegion(const CodeExtractorAnalysisCache &CEAC,
1630                                  ValueSet &inputs, ValueSet &outputs) {
1631   if (!isEligible())
1632     return nullptr;
1633 
1634   // Assumption: this is a single-entry code region, and the header is the first
1635   // block in the region.
1636   BasicBlock *header = *Blocks.begin();
1637   Function *oldFunction = header->getParent();
1638 
1639   // Calculate the entry frequency of the new function before we change the root
1640   //   block.
1641   BlockFrequency EntryFreq;
1642   if (BFI) {
1643     assert(BPI && "Both BPI and BFI are required to preserve profile info");
1644     for (BasicBlock *Pred : predecessors(header)) {
1645       if (Blocks.count(Pred))
1646         continue;
1647       EntryFreq +=
1648           BFI->getBlockFreq(Pred) * BPI->getEdgeProbability(Pred, header);
1649     }
1650   }
1651 
1652   // Remove @llvm.assume calls that will be moved to the new function from the
1653   // old function's assumption cache.
1654   for (BasicBlock *Block : Blocks) {
1655     for (Instruction &I : llvm::make_early_inc_range(*Block)) {
1656       if (auto *AI = dyn_cast<AssumeInst>(&I)) {
1657         if (AC)
1658           AC->unregisterAssumption(AI);
1659         AI->eraseFromParent();
1660       }
1661     }
1662   }
1663 
1664   // If we have any return instructions in the region, split those blocks so
1665   // that the return is not in the region.
1666   splitReturnBlocks();
1667 
1668   // Calculate the exit blocks for the extracted region and the total exit
1669   // weights for each of those blocks.
1670   DenseMap<BasicBlock *, BlockFrequency> ExitWeights;
1671   SmallPtrSet<BasicBlock *, 1> ExitBlocks;
1672   for (BasicBlock *Block : Blocks) {
1673     for (BasicBlock *Succ : successors(Block)) {
1674       if (!Blocks.count(Succ)) {
1675         // Update the branch weight for this successor.
1676         if (BFI) {
1677           BlockFrequency &BF = ExitWeights[Succ];
1678           BF += BFI->getBlockFreq(Block) * BPI->getEdgeProbability(Block, Succ);
1679         }
1680         ExitBlocks.insert(Succ);
1681       }
1682     }
1683   }
1684   NumExitBlocks = ExitBlocks.size();
1685 
1686   for (BasicBlock *Block : Blocks) {
1687     Instruction *TI = Block->getTerminator();
1688     for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i) {
1689       if (Blocks.count(TI->getSuccessor(i)))
1690         continue;
1691       BasicBlock *OldTarget = TI->getSuccessor(i);
1692       OldTargets.push_back(OldTarget);
1693     }
1694   }
1695 
1696   // If we have to split PHI nodes of the entry or exit blocks, do so now.
1697   severSplitPHINodesOfEntry(header);
1698   severSplitPHINodesOfExits(ExitBlocks);
1699 
1700   // This takes place of the original loop
1701   BasicBlock *codeReplacer = BasicBlock::Create(header->getContext(),
1702                                                 "codeRepl", oldFunction,
1703                                                 header);
1704 
1705   // The new function needs a root node because other nodes can branch to the
1706   // head of the region, but the entry node of a function cannot have preds.
1707   BasicBlock *newFuncRoot = BasicBlock::Create(header->getContext(),
1708                                                "newFuncRoot");
1709   auto *BranchI = BranchInst::Create(header);
1710   // If the original function has debug info, we have to add a debug location
1711   // to the new branch instruction from the artificial entry block.
1712   // We use the debug location of the first instruction in the extracted
1713   // blocks, as there is no other equivalent line in the source code.
1714   if (oldFunction->getSubprogram()) {
1715     any_of(Blocks, [&BranchI](const BasicBlock *BB) {
1716       return any_of(*BB, [&BranchI](const Instruction &I) {
1717         if (!I.getDebugLoc())
1718           return false;
1719         BranchI->setDebugLoc(I.getDebugLoc());
1720         return true;
1721       });
1722     });
1723   }
1724   newFuncRoot->getInstList().push_back(BranchI);
1725 
1726   ValueSet SinkingCands, HoistingCands;
1727   BasicBlock *CommonExit = nullptr;
1728   findAllocas(CEAC, SinkingCands, HoistingCands, CommonExit);
1729   assert(HoistingCands.empty() || CommonExit);
1730 
1731   // Find inputs to, outputs from the code region.
1732   findInputsOutputs(inputs, outputs, SinkingCands);
1733 
1734   // Now sink all instructions which only have non-phi uses inside the region.
1735   // Group the allocas at the start of the block, so that any bitcast uses of
1736   // the allocas are well-defined.
1737   AllocaInst *FirstSunkAlloca = nullptr;
1738   for (auto *II : SinkingCands) {
1739     if (auto *AI = dyn_cast<AllocaInst>(II)) {
1740       AI->moveBefore(*newFuncRoot, newFuncRoot->getFirstInsertionPt());
1741       if (!FirstSunkAlloca)
1742         FirstSunkAlloca = AI;
1743     }
1744   }
1745   assert((SinkingCands.empty() || FirstSunkAlloca) &&
1746          "Did not expect a sink candidate without any allocas");
1747   for (auto *II : SinkingCands) {
1748     if (!isa<AllocaInst>(II)) {
1749       cast<Instruction>(II)->moveAfter(FirstSunkAlloca);
1750     }
1751   }
1752 
1753   if (!HoistingCands.empty()) {
1754     auto *HoistToBlock = findOrCreateBlockForHoisting(CommonExit);
1755     Instruction *TI = HoistToBlock->getTerminator();
1756     for (auto *II : HoistingCands)
1757       cast<Instruction>(II)->moveBefore(TI);
1758   }
1759 
1760   // Collect objects which are inputs to the extraction region and also
1761   // referenced by lifetime start markers within it. The effects of these
1762   // markers must be replicated in the calling function to prevent the stack
1763   // coloring pass from merging slots which store input objects.
1764   ValueSet LifetimesStart;
1765   eraseLifetimeMarkersOnInputs(Blocks, SinkingCands, LifetimesStart);
1766 
1767   // Construct new function based on inputs/outputs & add allocas for all defs.
1768   Function *newFunction =
1769       constructFunction(inputs, outputs, header, newFuncRoot, codeReplacer,
1770                         oldFunction, oldFunction->getParent());
1771 
1772   // Update the entry count of the function.
1773   if (BFI) {
1774     auto Count = BFI->getProfileCountFromFreq(EntryFreq.getFrequency());
1775     if (Count.hasValue())
1776       newFunction->setEntryCount(
1777           ProfileCount(Count.getValue(), Function::PCT_Real)); // FIXME
1778     BFI->setBlockFreq(codeReplacer, EntryFreq.getFrequency());
1779   }
1780 
1781   CallInst *TheCall =
1782       emitCallAndSwitchStatement(newFunction, codeReplacer, inputs, outputs);
1783 
1784   moveCodeToFunction(newFunction);
1785 
1786   // Replicate the effects of any lifetime start/end markers which referenced
1787   // input objects in the extraction region by placing markers around the call.
1788   insertLifetimeMarkersSurroundingCall(
1789       oldFunction->getParent(), LifetimesStart.getArrayRef(), {}, TheCall);
1790 
1791   // Propagate personality info to the new function if there is one.
1792   if (oldFunction->hasPersonalityFn())
1793     newFunction->setPersonalityFn(oldFunction->getPersonalityFn());
1794 
1795   // Update the branch weights for the exit block.
1796   if (BFI && NumExitBlocks > 1)
1797     calculateNewCallTerminatorWeights(codeReplacer, ExitWeights, BPI);
1798 
1799   // Loop over all of the PHI nodes in the header and exit blocks, and change
1800   // any references to the old incoming edge to be the new incoming edge.
1801   for (BasicBlock::iterator I = header->begin(); isa<PHINode>(I); ++I) {
1802     PHINode *PN = cast<PHINode>(I);
1803     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
1804       if (!Blocks.count(PN->getIncomingBlock(i)))
1805         PN->setIncomingBlock(i, newFuncRoot);
1806   }
1807 
1808   for (BasicBlock *ExitBB : ExitBlocks)
1809     for (PHINode &PN : ExitBB->phis()) {
1810       Value *IncomingCodeReplacerVal = nullptr;
1811       for (unsigned i = 0, e = PN.getNumIncomingValues(); i != e; ++i) {
1812         // Ignore incoming values from outside of the extracted region.
1813         if (!Blocks.count(PN.getIncomingBlock(i)))
1814           continue;
1815 
1816         // Ensure that there is only one incoming value from codeReplacer.
1817         if (!IncomingCodeReplacerVal) {
1818           PN.setIncomingBlock(i, codeReplacer);
1819           IncomingCodeReplacerVal = PN.getIncomingValue(i);
1820         } else
1821           assert(IncomingCodeReplacerVal == PN.getIncomingValue(i) &&
1822                  "PHI has two incompatbile incoming values from codeRepl");
1823       }
1824     }
1825 
1826   fixupDebugInfoPostExtraction(*oldFunction, *newFunction, *TheCall);
1827 
1828   // Mark the new function `noreturn` if applicable. Terminators which resume
1829   // exception propagation are treated as returning instructions. This is to
1830   // avoid inserting traps after calls to outlined functions which unwind.
1831   bool doesNotReturn = none_of(*newFunction, [](const BasicBlock &BB) {
1832     const Instruction *Term = BB.getTerminator();
1833     return isa<ReturnInst>(Term) || isa<ResumeInst>(Term);
1834   });
1835   if (doesNotReturn)
1836     newFunction->setDoesNotReturn();
1837 
1838   LLVM_DEBUG(if (verifyFunction(*newFunction, &errs())) {
1839     newFunction->dump();
1840     report_fatal_error("verification of newFunction failed!");
1841   });
1842   LLVM_DEBUG(if (verifyFunction(*oldFunction))
1843              report_fatal_error("verification of oldFunction failed!"));
1844   LLVM_DEBUG(if (AC && verifyAssumptionCache(*oldFunction, *newFunction, AC))
1845                  report_fatal_error("Stale Asumption cache for old Function!"));
1846   return newFunction;
1847 }
1848 
1849 bool CodeExtractor::verifyAssumptionCache(const Function &OldFunc,
1850                                           const Function &NewFunc,
1851                                           AssumptionCache *AC) {
1852   for (auto AssumeVH : AC->assumptions()) {
1853     auto *I = dyn_cast_or_null<CallInst>(AssumeVH);
1854     if (!I)
1855       continue;
1856 
1857     // There shouldn't be any llvm.assume intrinsics in the new function.
1858     if (I->getFunction() != &OldFunc)
1859       return true;
1860 
1861     // There shouldn't be any stale affected values in the assumption cache
1862     // that were previously in the old function, but that have now been moved
1863     // to the new function.
1864     for (auto AffectedValVH : AC->assumptionsFor(I->getOperand(0))) {
1865       auto *AffectedCI = dyn_cast_or_null<CallInst>(AffectedValVH);
1866       if (!AffectedCI)
1867         continue;
1868       if (AffectedCI->getFunction() != &OldFunc)
1869         return true;
1870       auto *AssumedInst = cast<Instruction>(AffectedCI->getOperand(0));
1871       if (AssumedInst->getFunction() != &OldFunc)
1872         return true;
1873     }
1874   }
1875   return false;
1876 }
1877 
1878 void CodeExtractor::excludeArgFromAggregate(Value *Arg) {
1879   ExcludeArgsFromAggregate.insert(Arg);
1880 }
1881