lib/Transforms/Utils/CodeExtractor.cpp

   1 //===- CodeExtractor.cpp - Pull code region into a new function -----------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements the interface to tear out a code region, such as an
  11 // individual loop or a parallel section, into a new function, replacing it with
  12 // a call to the new function.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #include "llvm/Transforms/Utils/FunctionUtils.h"
  17 #include "llvm/Constants.h"
  18 #include "llvm/DerivedTypes.h"
  19 #include "llvm/Instructions.h"
  20 #include "llvm/Intrinsics.h"
  21 #include "llvm/LLVMContext.h"
  22 #include "llvm/Module.h"
  23 #include "llvm/Pass.h"
  24 #include "llvm/Analysis/Dominators.h"
  25 #include "llvm/Analysis/LoopInfo.h"
  26 #include "llvm/Analysis/Verifier.h"
  27 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
  28 #include "llvm/Support/CommandLine.h"
  29 #include "llvm/Support/Compiler.h"
  30 #include "llvm/Support/Debug.h"
  31 #include "llvm/Support/ErrorHandling.h"
  32 #include "llvm/ADT/StringExtras.h"
  33 #include <algorithm>
  34 #include <set>
  35 using namespace llvm;
  36
  37 // Provide a command-line option to aggregate function arguments into a struct
  38 // for functions produced by the code extractor. This is useful when converting
  39 // extracted functions to pthread-based code, as only one argument (void*) can
  40 // be passed in to pthread_create().
  41 static cl::opt<bool>
  42 AggregateArgsOpt("aggregate-extracted-args", cl::Hidden,
  43                  cl::desc("Aggregate arguments to code-extracted functions"));
  44
  45 namespace {
  46   class VISIBILITY_HIDDEN CodeExtractor {
  47     typedef std::vector<Value*> Values;
  48     std::set<BasicBlock*> BlocksToExtract;
  49     DominatorTree* DT;
  50     bool AggregateArgs;
  51     unsigned NumExitBlocks;
  52     const Type *RetTy;
  53   public:
  54     CodeExtractor(DominatorTree* dt = 0, bool AggArgs = false)
  55       : DT(dt), AggregateArgs(AggArgs||AggregateArgsOpt), NumExitBlocks(~0U) {}
  56
  57     Function *ExtractCodeRegion(const std::vector<BasicBlock*> &code);
  58
  59     bool isEligible(const std::vector<BasicBlock*> &code);
  60
  61   private:
  62     /// definedInRegion - Return true if the specified value is defined in the
  63     /// extracted region.
  64     bool definedInRegion(Value *V) const {
  65       if (Instruction *I = dyn_cast<Instruction>(V))
  66         if (BlocksToExtract.count(I->getParent()))
  67           return true;
  68       return false;
  69     }
  70
  71     /// definedInCaller - Return true if the specified value is defined in the
  72     /// function being code extracted, but not in the region being extracted.
  73     /// These values must be passed in as live-ins to the function.
  74     bool definedInCaller(Value *V) const {
  75       if (isa<Argument>(V)) return true;
  76       if (Instruction *I = dyn_cast<Instruction>(V))
  77         if (!BlocksToExtract.count(I->getParent()))
  78           return true;
  79       return false;
  80     }
  81
  82     void severSplitPHINodes(BasicBlock *&Header);
  83     void splitReturnBlocks();
  84     void findInputsOutputs(Values &inputs, Values &outputs);
  85
  86     Function *constructFunction(const Values &inputs,
  87                                 const Values &outputs,
  88                                 BasicBlock *header,
  89                                 BasicBlock *newRootNode, BasicBlock *newHeader,
  90                                 Function *oldFunction, Module *M);
  91
  92     void moveCodeToFunction(Function *newFunction);
  93
  94     void emitCallAndSwitchStatement(Function *newFunction,
  95                                     BasicBlock *newHeader,
  96                                     Values &inputs,
  97                                     Values &outputs);
  98
  99   };
 100 }
 101
 102 /// severSplitPHINodes - If a PHI node has multiple inputs from outside of the
 103 /// region, we need to split the entry block of the region so that the PHI node
 104 /// is easier to deal with.
 105 void CodeExtractor::severSplitPHINodes(BasicBlock *&Header) {
 106   bool HasPredsFromRegion = false;
 107   unsigned NumPredsOutsideRegion = 0;
 108
 109   if (Header != &Header->getParent()->getEntryBlock()) {
 110     PHINode *PN = dyn_cast<PHINode>(Header->begin());
 111     if (!PN) return;  // No PHI nodes.
 112
 113     // If the header node contains any PHI nodes, check to see if there is more
 114     // than one entry from outside the region.  If so, we need to sever the
 115     // header block into two.
 116     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 117       if (BlocksToExtract.count(PN->getIncomingBlock(i)))
 118         HasPredsFromRegion = true;
 119       else
 120         ++NumPredsOutsideRegion;
 121
 122     // If there is one (or fewer) predecessor from outside the region, we don't
 123     // need to do anything special.
 124     if (NumPredsOutsideRegion <= 1) return;
 125   }
 126
 127   // Otherwise, we need to split the header block into two pieces: one
 128   // containing PHI nodes merging values from outside of the region, and a
 129   // second that contains all of the code for the block and merges back any
 130   // incoming values from inside of the region.
 131   BasicBlock::iterator AfterPHIs = Header->getFirstNonPHI();
 132   BasicBlock *NewBB = Header->splitBasicBlock(AfterPHIs,
 133                                               Header->getName()+".ce");
 134
 135   // We only want to code extract the second block now, and it becomes the new
 136   // header of the region.
 137   BasicBlock *OldPred = Header;
 138   BlocksToExtract.erase(OldPred);
 139   BlocksToExtract.insert(NewBB);
 140   Header = NewBB;
 141
 142   // Okay, update dominator sets. The blocks that dominate the new one are the
 143   // blocks that dominate TIBB plus the new block itself.
 144   if (DT)
 145     DT->splitBlock(NewBB);
 146
 147   // Okay, now we need to adjust the PHI nodes and any branches from within the
 148   // region to go to the new header block instead of the old header block.
 149   if (HasPredsFromRegion) {
 150     PHINode *PN = cast<PHINode>(OldPred->begin());
 151     // Loop over all of the predecessors of OldPred that are in the region,
 152     // changing them to branch to NewBB instead.
 153     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 154       if (BlocksToExtract.count(PN->getIncomingBlock(i))) {
 155         TerminatorInst *TI = PN->getIncomingBlock(i)->getTerminator();
 156         TI->replaceUsesOfWith(OldPred, NewBB);
 157       }
 158
 159     // Okay, everthing within the region is now branching to the right block, we
 160     // just have to update the PHI nodes now, inserting PHI nodes into NewBB.
 161     for (AfterPHIs = OldPred->begin(); isa<PHINode>(AfterPHIs); ++AfterPHIs) {
 162       PHINode *PN = cast<PHINode>(AfterPHIs);
 163       // Create a new PHI node in the new region, which has an incoming value
 164       // from OldPred of PN.
 165       PHINode *NewPN = PHINode::Create(PN->getType(), PN->getName()+".ce",
 166                                        NewBB->begin());
 167       NewPN->addIncoming(PN, OldPred);
 168
 169       // Loop over all of the incoming value in PN, moving them to NewPN if they
 170       // are from the extracted region.
 171       for (unsigned i = 0; i != PN->getNumIncomingValues(); ++i) {
 172         if (BlocksToExtract.count(PN->getIncomingBlock(i))) {
 173           NewPN->addIncoming(PN->getIncomingValue(i), PN->getIncomingBlock(i));
 174           PN->removeIncomingValue(i);
 175           --i;
 176         }
 177       }
 178     }
 179   }
 180 }
 181
 182 void CodeExtractor::splitReturnBlocks() {
 183   for (std::set<BasicBlock*>::iterator I = BlocksToExtract.begin(),
 184          E = BlocksToExtract.end(); I != E; ++I)
 185     if (ReturnInst *RI = dyn_cast<ReturnInst>((*I)->getTerminator()))
 186       (*I)->splitBasicBlock(RI, (*I)->getName()+".ret");
 187 }
 188
 189 // findInputsOutputs - Find inputs to, outputs from the code region.
 190 //
 191 void CodeExtractor::findInputsOutputs(Values &inputs, Values &outputs) {
 192   std::set<BasicBlock*> ExitBlocks;
 193   for (std::set<BasicBlock*>::const_iterator ci = BlocksToExtract.begin(),
 194        ce = BlocksToExtract.end(); ci != ce; ++ci) {
 195     BasicBlock *BB = *ci;
 196
 197     for (BasicBlock::iterator I = BB->begin(), E = BB->end(); I != E; ++I) {
 198       // If a used value is defined outside the region, it's an input.  If an
 199       // instruction is used outside the region, it's an output.
 200       for (User::op_iterator O = I->op_begin(), E = I->op_end(); O != E; ++O)
 201         if (definedInCaller(*O))
 202           inputs.push_back(*O);
 203
 204       // Consider uses of this instruction (outputs).
 205       for (Value::use_iterator UI = I->use_begin(), E = I->use_end();
 206            UI != E; ++UI)
 207         if (!definedInRegion(*UI)) {
 208           outputs.push_back(I);
 209           break;
 210         }
 211     } // for: insts
 212
 213     // Keep track of the exit blocks from the region.
 214     TerminatorInst *TI = BB->getTerminator();
 215     for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i)
 216       if (!BlocksToExtract.count(TI->getSuccessor(i)))
 217         ExitBlocks.insert(TI->getSuccessor(i));
 218   } // for: basic blocks
 219
 220   NumExitBlocks = ExitBlocks.size();
 221
 222   // Eliminate duplicates.
 223   std::sort(inputs.begin(), inputs.end());
 224   inputs.erase(std::unique(inputs.begin(), inputs.end()), inputs.end());
 225   std::sort(outputs.begin(), outputs.end());
 226   outputs.erase(std::unique(outputs.begin(), outputs.end()), outputs.end());
 227 }
 228
 229 /// constructFunction - make a function based on inputs and outputs, as follows:
 230 /// f(in0, ..., inN, out0, ..., outN)
 231 ///
 232 Function *CodeExtractor::constructFunction(const Values &inputs,
 233                                            const Values &outputs,
 234                                            BasicBlock *header,
 235                                            BasicBlock *newRootNode,
 236                                            BasicBlock *newHeader,
 237                                            Function *oldFunction,
 238                                            Module *M) {
 239   DOUT << "inputs: " << inputs.size() << "\n";
 240   DOUT << "outputs: " << outputs.size() << "\n";
 241
 242   // This function returns unsigned, outputs will go back by reference.
 243   switch (NumExitBlocks) {
 244   case 0:
 245   case 1: RetTy = Type::getVoidTy(header->getContext()); break;
 246   case 2: RetTy = Type::getInt1Ty(header->getContext()); break;
 247   default: RetTy = Type::getInt16Ty(header->getContext()); break;
 248   }
 249
 250   std::vector<const Type*> paramTy;
 251
 252   // Add the types of the input values to the function's argument list
 253   for (Values::const_iterator i = inputs.begin(),
 254          e = inputs.end(); i != e; ++i) {
 255     const Value *value = *i;
 256     DOUT << "value used in func: " << *value << "\n";
 257     paramTy.push_back(value->getType());
 258   }
 259
 260   // Add the types of the output values to the function's argument list.
 261   for (Values::const_iterator I = outputs.begin(), E = outputs.end();
 262        I != E; ++I) {
 263     DOUT << "instr used in func: " << **I << "\n";
 264     if (AggregateArgs)
 265       paramTy.push_back((*I)->getType());
 266     else
 267       paramTy.push_back(PointerType::getUnqual((*I)->getType()));
 268   }
 269
 270   DOUT << "Function type: " << *RetTy << " f(";
 271   for (std::vector<const Type*>::iterator i = paramTy.begin(),
 272          e = paramTy.end(); i != e; ++i)
 273     DOUT << **i << ", ";
 274   DOUT << ")\n";
 275
 276   if (AggregateArgs && (inputs.size() + outputs.size() > 0)) {
 277     PointerType *StructPtr =
 278            PointerType::getUnqual(StructType::get(M->getContext(), paramTy));
 279     paramTy.clear();
 280     paramTy.push_back(StructPtr);
 281   }
 282   const FunctionType *funcType =
 283                   FunctionType::get(RetTy, paramTy, false);
 284
 285   // Create the new function
 286   Function *newFunction = Function::Create(funcType,
 287                                            GlobalValue::InternalLinkage,
 288                                            oldFunction->getName() + "_" +
 289                                            header->getName(), M);
 290   // If the old function is no-throw, so is the new one.
 291   if (oldFunction->doesNotThrow())
 292     newFunction->setDoesNotThrow(true);
 293
 294   newFunction->getBasicBlockList().push_back(newRootNode);
 295
 296   // Create an iterator to name all of the arguments we inserted.
 297   Function::arg_iterator AI = newFunction->arg_begin();
 298
 299   // Rewrite all users of the inputs in the extracted region to use the
 300   // arguments (or appropriate addressing into struct) instead.
 301   for (unsigned i = 0, e = inputs.size(); i != e; ++i) {
 302     Value *RewriteVal;
 303     if (AggregateArgs) {
 304       Value *Idx[2];
 305       Idx[0] = Constant::getNullValue(Type::getInt32Ty(header->getContext()));
 306       Idx[1] = ConstantInt::get(Type::getInt32Ty(header->getContext()), i);
 307       TerminatorInst *TI = newFunction->begin()->getTerminator();
 308       GetElementPtrInst *GEP =
 309         GetElementPtrInst::Create(AI, Idx, Idx+2,
 310                                   "gep_" + inputs[i]->getName(), TI);
 311       RewriteVal = new LoadInst(GEP, "loadgep_" + inputs[i]->getName(), TI);
 312     } else
 313       RewriteVal = AI++;
 314
 315     std::vector<User*> Users(inputs[i]->use_begin(), inputs[i]->use_end());
 316     for (std::vector<User*>::iterator use = Users.begin(), useE = Users.end();
 317          use != useE; ++use)
 318       if (Instruction* inst = dyn_cast<Instruction>(*use))
 319         if (BlocksToExtract.count(inst->getParent()))
 320           inst->replaceUsesOfWith(inputs[i], RewriteVal);
 321   }
 322
 323   // Set names for input and output arguments.
 324   if (!AggregateArgs) {
 325     AI = newFunction->arg_begin();
 326     for (unsigned i = 0, e = inputs.size(); i != e; ++i, ++AI)
 327       AI->setName(inputs[i]->getName());
 328     for (unsigned i = 0, e = outputs.size(); i != e; ++i, ++AI)
 329       AI->setName(outputs[i]->getName()+".out");
 330   }
 331
 332   // Rewrite branches to basic blocks outside of the loop to new dummy blocks
 333   // within the new function. This must be done before we lose track of which
 334   // blocks were originally in the code region.
 335   std::vector<User*> Users(header->use_begin(), header->use_end());
 336   for (unsigned i = 0, e = Users.size(); i != e; ++i)
 337     // The BasicBlock which contains the branch is not in the region
 338     // modify the branch target to a new block
 339     if (TerminatorInst *TI = dyn_cast<TerminatorInst>(Users[i]))
 340       if (!BlocksToExtract.count(TI->getParent()) &&
 341           TI->getParent()->getParent() == oldFunction)
 342         TI->replaceUsesOfWith(header, newHeader);
 343
 344   return newFunction;
 345 }
 346
 347 /// emitCallAndSwitchStatement - This method sets up the caller side by adding
 348 /// the call instruction, splitting any PHI nodes in the header block as
 349 /// necessary.
 350 void CodeExtractor::
 351 emitCallAndSwitchStatement(Function *newFunction, BasicBlock *codeReplacer,
 352                            Values &inputs, Values &outputs) {
 353   // Emit a call to the new function, passing in: *pointer to struct (if
 354   // aggregating parameters), or plan inputs and allocated memory for outputs
 355   std::vector<Value*> params, StructValues, ReloadOutputs;
 356
 357   LLVMContext &Context = newFunction->getContext();
 358
 359   // Add inputs as params, or to be filled into the struct
 360   for (Values::iterator i = inputs.begin(), e = inputs.end(); i != e; ++i)
 361     if (AggregateArgs)
 362       StructValues.push_back(*i);
 363     else
 364       params.push_back(*i);
 365
 366   // Create allocas for the outputs
 367   for (Values::iterator i = outputs.begin(), e = outputs.end(); i != e; ++i) {
 368     if (AggregateArgs) {
 369       StructValues.push_back(*i);
 370     } else {
 371       AllocaInst *alloca =
 372         new AllocaInst((*i)->getType(), 0, (*i)->getName()+".loc",
 373                        codeReplacer->getParent()->begin()->begin());
 374       ReloadOutputs.push_back(alloca);
 375       params.push_back(alloca);
 376     }
 377   }
 378
 379   AllocaInst *Struct = 0;
 380   if (AggregateArgs && (inputs.size() + outputs.size() > 0)) {
 381     std::vector<const Type*> ArgTypes;
 382     for (Values::iterator v = StructValues.begin(),
 383            ve = StructValues.end(); v != ve; ++v)
 384       ArgTypes.push_back((*v)->getType());
 385
 386     // Allocate a struct at the beginning of this function
 387     Type *StructArgTy = StructType::get(newFunction->getContext(), ArgTypes);
 388     Struct =
 389       new AllocaInst(StructArgTy, 0, "structArg",
 390                      codeReplacer->getParent()->begin()->begin());
 391     params.push_back(Struct);
 392
 393     for (unsigned i = 0, e = inputs.size(); i != e; ++i) {
 394       Value *Idx[2];
 395       Idx[0] = Constant::getNullValue(Type::getInt32Ty(Context));
 396       Idx[1] = ConstantInt::get(Type::getInt32Ty(Context), i);
 397       GetElementPtrInst *GEP =
 398         GetElementPtrInst::Create(Struct, Idx, Idx + 2,
 399                                   "gep_" + StructValues[i]->getName());
 400       codeReplacer->getInstList().push_back(GEP);
 401       StoreInst *SI = new StoreInst(StructValues[i], GEP);
 402       codeReplacer->getInstList().push_back(SI);
 403     }
 404   }
 405
 406   // Emit the call to the function
 407   CallInst *call = CallInst::Create(newFunction, params.begin(), params.end(),
 408                                     NumExitBlocks > 1 ? "targetBlock" : "");
 409   codeReplacer->getInstList().push_back(call);
 410
 411   Function::arg_iterator OutputArgBegin = newFunction->arg_begin();
 412   unsigned FirstOut = inputs.size();
 413   if (!AggregateArgs)
 414     std::advance(OutputArgBegin, inputs.size());
 415
 416   // Reload the outputs passed in by reference
 417   for (unsigned i = 0, e = outputs.size(); i != e; ++i) {
 418     Value *Output = 0;
 419     if (AggregateArgs) {
 420       Value *Idx[2];
 421       Idx[0] = Constant::getNullValue(Type::getInt32Ty(Context));
 422       Idx[1] = ConstantInt::get(Type::getInt32Ty(Context), FirstOut + i);
 423       GetElementPtrInst *GEP
 424         = GetElementPtrInst::Create(Struct, Idx, Idx + 2,
 425                                     "gep_reload_" + outputs[i]->getName());
 426       codeReplacer->getInstList().push_back(GEP);
 427       Output = GEP;
 428     } else {
 429       Output = ReloadOutputs[i];
 430     }
 431     LoadInst *load = new LoadInst(Output, outputs[i]->getName()+".reload");
 432     codeReplacer->getInstList().push_back(load);
 433     std::vector<User*> Users(outputs[i]->use_begin(), outputs[i]->use_end());
 434     for (unsigned u = 0, e = Users.size(); u != e; ++u) {
 435       Instruction *inst = cast<Instruction>(Users[u]);
 436       if (!BlocksToExtract.count(inst->getParent()))
 437         inst->replaceUsesOfWith(outputs[i], load);
 438     }
 439   }
 440
 441   // Now we can emit a switch statement using the call as a value.
 442   SwitchInst *TheSwitch =
 443       SwitchInst::Create(Constant::getNullValue(Type::getInt16Ty(Context)),
 444                          codeReplacer, 0, codeReplacer);
 445
 446   // Since there may be multiple exits from the original region, make the new
 447   // function return an unsigned, switch on that number.  This loop iterates
 448   // over all of the blocks in the extracted region, updating any terminator
 449   // instructions in the to-be-extracted region that branch to blocks that are
 450   // not in the region to be extracted.
 451   std::map<BasicBlock*, BasicBlock*> ExitBlockMap;
 452
 453   unsigned switchVal = 0;
 454   for (std::set<BasicBlock*>::const_iterator i = BlocksToExtract.begin(),
 455          e = BlocksToExtract.end(); i != e; ++i) {
 456     TerminatorInst *TI = (*i)->getTerminator();
 457     for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i)
 458       if (!BlocksToExtract.count(TI->getSuccessor(i))) {
 459         BasicBlock *OldTarget = TI->getSuccessor(i);
 460         // add a new basic block which returns the appropriate value
 461         BasicBlock *&NewTarget = ExitBlockMap[OldTarget];
 462         if (!NewTarget) {
 463           // If we don't already have an exit stub for this non-extracted
 464           // destination, create one now!
 465           NewTarget = BasicBlock::Create(Context,
 466                                          OldTarget->getName() + ".exitStub",
 467                                          newFunction);
 468           unsigned SuccNum = switchVal++;
 469
 470           Value *brVal = 0;
 471           switch (NumExitBlocks) {
 472           case 0:
 473           case 1: break;  // No value needed.
 474           case 2:         // Conditional branch, return a bool
 475             brVal = ConstantInt::get(Type::getInt1Ty(Context), !SuccNum);
 476             break;
 477           default:
 478             brVal = ConstantInt::get(Type::getInt16Ty(Context), SuccNum);
 479             break;
 480           }
 481
 482           ReturnInst *NTRet = ReturnInst::Create(Context, brVal, NewTarget);
 483
 484           // Update the switch instruction.
 485           TheSwitch->addCase(ConstantInt::get(Type::getInt16Ty(Context),
 486                                               SuccNum),
 487                              OldTarget);
 488
 489           // Restore values just before we exit
 490           Function::arg_iterator OAI = OutputArgBegin;
 491           for (unsigned out = 0, e = outputs.size(); out != e; ++out) {
 492             // For an invoke, the normal destination is the only one that is
 493             // dominated by the result of the invocation
 494             BasicBlock *DefBlock = cast<Instruction>(outputs[out])->getParent();
 495
 496             bool DominatesDef = true;
 497
 498             if (InvokeInst *Invoke = dyn_cast<InvokeInst>(outputs[out])) {
 499               DefBlock = Invoke->getNormalDest();
 500
 501               // Make sure we are looking at the original successor block, not
 502               // at a newly inserted exit block, which won't be in the dominator
 503               // info.
 504               for (std::map<BasicBlock*, BasicBlock*>::iterator I =
 505                      ExitBlockMap.begin(), E = ExitBlockMap.end(); I != E; ++I)
 506                 if (DefBlock == I->second) {
 507                   DefBlock = I->first;
 508                   break;
 509                 }
 510
 511               // In the extract block case, if the block we are extracting ends
 512               // with an invoke instruction, make sure that we don't emit a
 513               // store of the invoke value for the unwind block.
 514               if (!DT && DefBlock != OldTarget)
 515                 DominatesDef = false;
 516             }
 517
 518             if (DT)
 519               DominatesDef = DT->dominates(DefBlock, OldTarget);
 520
 521             if (DominatesDef) {
 522               if (AggregateArgs) {
 523                 Value *Idx[2];
 524                 Idx[0] = Constant::getNullValue(Type::getInt32Ty(Context));
 525                 Idx[1] = ConstantInt::get(Type::getInt32Ty(Context),
 526                                           FirstOut+out);
 527                 GetElementPtrInst *GEP =
 528                   GetElementPtrInst::Create(OAI, Idx, Idx + 2,
 529                                             "gep_" + outputs[out]->getName(),
 530                                             NTRet);
 531                 new StoreInst(outputs[out], GEP, NTRet);
 532               } else {
 533                 new StoreInst(outputs[out], OAI, NTRet);
 534               }
 535             }
 536             // Advance output iterator even if we don't emit a store
 537             if (!AggregateArgs) ++OAI;
 538           }
 539         }
 540
 541         // rewrite the original branch instruction with this new target
 542         TI->setSuccessor(i, NewTarget);
 543       }
 544   }
 545
 546   // Now that we've done the deed, simplify the switch instruction.
 547   const Type *OldFnRetTy = TheSwitch->getParent()->getParent()->getReturnType();
 548   switch (NumExitBlocks) {
 549   case 0:
 550     // There are no successors (the block containing the switch itself), which
 551     // means that previously this was the last part of the function, and hence
 552     // this should be rewritten as a `ret'
 553
 554     // Check if the function should return a value
 555     if (OldFnRetTy == Type::getVoidTy(Context)) {
 556       ReturnInst::Create(Context, 0, TheSwitch);  // Return void
 557     } else if (OldFnRetTy == TheSwitch->getCondition()->getType()) {
 558       // return what we have
 559       ReturnInst::Create(Context, TheSwitch->getCondition(), TheSwitch);
 560     } else {
 561       // Otherwise we must have code extracted an unwind or something, just
 562       // return whatever we want.
 563       ReturnInst::Create(Context,
 564                          Constant::getNullValue(OldFnRetTy), TheSwitch);
 565     }
 566
 567     TheSwitch->eraseFromParent();
 568     break;
 569   case 1:
 570     // Only a single destination, change the switch into an unconditional
 571     // branch.
 572     BranchInst::Create(TheSwitch->getSuccessor(1), TheSwitch);
 573     TheSwitch->eraseFromParent();
 574     break;
 575   case 2:
 576     BranchInst::Create(TheSwitch->getSuccessor(1), TheSwitch->getSuccessor(2),
 577                        call, TheSwitch);
 578     TheSwitch->eraseFromParent();
 579     break;
 580   default:
 581     // Otherwise, make the default destination of the switch instruction be one
 582     // of the other successors.
 583     TheSwitch->setOperand(0, call);
 584     TheSwitch->setSuccessor(0, TheSwitch->getSuccessor(NumExitBlocks));
 585     TheSwitch->removeCase(NumExitBlocks);  // Remove redundant case
 586     break;
 587   }
 588 }
 589
 590 void CodeExtractor::moveCodeToFunction(Function *newFunction) {
 591   Function *oldFunc = (*BlocksToExtract.begin())->getParent();
 592   Function::BasicBlockListType &oldBlocks = oldFunc->getBasicBlockList();
 593   Function::BasicBlockListType &newBlocks = newFunction->getBasicBlockList();
 594
 595   for (std::set<BasicBlock*>::const_iterator i = BlocksToExtract.begin(),
 596          e = BlocksToExtract.end(); i != e; ++i) {
 597     // Delete the basic block from the old function, and the list of blocks
 598     oldBlocks.remove(*i);
 599
 600     // Insert this basic block into the new function
 601     newBlocks.push_back(*i);
 602   }
 603 }
 604
 605 /// ExtractRegion - Removes a loop from a function, replaces it with a call to
 606 /// new function. Returns pointer to the new function.
 607 ///
 608 /// algorithm:
 609 ///
 610 /// find inputs and outputs for the region
 611 ///
 612 /// for inputs: add to function as args, map input instr* to arg#
 613 /// for outputs: add allocas for scalars,
 614 ///             add to func as args, map output instr* to arg#
 615 ///
 616 /// rewrite func to use argument #s instead of instr*
 617 ///
 618 /// for each scalar output in the function: at every exit, store intermediate
 619 /// computed result back into memory.
 620 ///
 621 Function *CodeExtractor::
 622 ExtractCodeRegion(const std::vector<BasicBlock*> &code) {
 623   if (!isEligible(code))
 624     return 0;
 625
 626   // 1) Find inputs, outputs
 627   // 2) Construct new function
 628   //  * Add allocas for defs, pass as args by reference
 629   //  * Pass in uses as args
 630   // 3) Move code region, add call instr to func
 631   //
 632   BlocksToExtract.insert(code.begin(), code.end());
 633
 634   Values inputs, outputs;
 635
 636   // Assumption: this is a single-entry code region, and the header is the first
 637   // block in the region.
 638   BasicBlock *header = code[0];
 639
 640   for (unsigned i = 1, e = code.size(); i != e; ++i)
 641     for (pred_iterator PI = pred_begin(code[i]), E = pred_end(code[i]);
 642          PI != E; ++PI)
 643       assert(BlocksToExtract.count(*PI) &&
 644              "No blocks in this region may have entries from outside the region"
 645              " except for the first block!");
 646
 647   // If we have to split PHI nodes or the entry block, do so now.
 648   severSplitPHINodes(header);
 649
 650   // If we have any return instructions in the region, split those blocks so
 651   // that the return is not in the region.
 652   splitReturnBlocks();
 653
 654   Function *oldFunction = header->getParent();
 655
 656   // This takes place of the original loop
 657   BasicBlock *codeReplacer = BasicBlock::Create(header->getContext(),
 658                                                 "codeRepl", oldFunction,
 659                                                 header);
 660
 661   // The new function needs a root node because other nodes can branch to the
 662   // head of the region, but the entry node of a function cannot have preds.
 663   BasicBlock *newFuncRoot = BasicBlock::Create(header->getContext(),
 664                                                "newFuncRoot");
 665   newFuncRoot->getInstList().push_back(BranchInst::Create(header));
 666
 667   // Find inputs to, outputs from the code region.
 668   findInputsOutputs(inputs, outputs);
 669
 670   // Construct new function based on inputs/outputs & add allocas for all defs.
 671   Function *newFunction = constructFunction(inputs, outputs, header,
 672                                             newFuncRoot,
 673                                             codeReplacer, oldFunction,
 674                                             oldFunction->getParent());
 675
 676   emitCallAndSwitchStatement(newFunction, codeReplacer, inputs, outputs);
 677
 678   moveCodeToFunction(newFunction);
 679
 680   // Loop over all of the PHI nodes in the header block, and change any
 681   // references to the old incoming edge to be the new incoming edge.
 682   for (BasicBlock::iterator I = header->begin(); isa<PHINode>(I); ++I) {
 683     PHINode *PN = cast<PHINode>(I);
 684     for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 685       if (!BlocksToExtract.count(PN->getIncomingBlock(i)))
 686         PN->setIncomingBlock(i, newFuncRoot);
 687   }
 688
 689   // Look at all successors of the codeReplacer block.  If any of these blocks
 690   // had PHI nodes in them, we need to update the "from" block to be the code
 691   // replacer, not the original block in the extracted region.
 692   std::vector<BasicBlock*> Succs(succ_begin(codeReplacer),
 693                                  succ_end(codeReplacer));
 694   for (unsigned i = 0, e = Succs.size(); i != e; ++i)
 695     for (BasicBlock::iterator I = Succs[i]->begin(); isa<PHINode>(I); ++I) {
 696       PHINode *PN = cast<PHINode>(I);
 697       std::set<BasicBlock*> ProcessedPreds;
 698       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i)
 699         if (BlocksToExtract.count(PN->getIncomingBlock(i))) {
 700           if (ProcessedPreds.insert(PN->getIncomingBlock(i)).second)
 701             PN->setIncomingBlock(i, codeReplacer);
 702           else {
 703             // There were multiple entries in the PHI for this block, now there
 704             // is only one, so remove the duplicated entries.
 705             PN->removeIncomingValue(i, false);
 706             --i; --e;
 707           }
 708         }
 709     }
 710
 711   //cerr << "NEW FUNCTION: " << *newFunction;
 712   //  verifyFunction(*newFunction);
 713
 714   //  cerr << "OLD FUNCTION: " << *oldFunction;
 715   //  verifyFunction(*oldFunction);
 716
 717   DEBUG(if (verifyFunction(*newFunction))
 718         llvm_report_error("verifyFunction failed!"));
 719   return newFunction;
 720 }
 721
 722 bool CodeExtractor::isEligible(const std::vector<BasicBlock*> &code) {
 723   // Deny code region if it contains allocas or vastarts.
 724   for (std::vector<BasicBlock*>::const_iterator BB = code.begin(), e=code.end();
 725        BB != e; ++BB)
 726     for (BasicBlock::const_iterator I = (*BB)->begin(), Ie = (*BB)->end();
 727          I != Ie; ++I)
 728       if (isa<AllocaInst>(*I))
 729         return false;
 730       else if (const CallInst *CI = dyn_cast<CallInst>(I))
 731         if (const Function *F = CI->getCalledFunction())
 732           if (F->getIntrinsicID() == Intrinsic::vastart)
 733             return false;
 734   return true;
 735 }
 736
 737
 738 /// ExtractCodeRegion - slurp a sequence of basic blocks into a brand new
 739 /// function
 740 ///
 741 Function* llvm::ExtractCodeRegion(DominatorTree &DT,
 742                                   const std::vector<BasicBlock*> &code,
 743                                   bool AggregateArgs) {
 744   return CodeExtractor(&DT, AggregateArgs).ExtractCodeRegion(code);
 745 }
 746
 747 /// ExtractBasicBlock - slurp a natural loop into a brand new function
 748 ///
 749 Function* llvm::ExtractLoop(DominatorTree &DT, Loop *L, bool AggregateArgs) {
 750   return CodeExtractor(&DT, AggregateArgs).ExtractCodeRegion(L->getBlocks());
 751 }
 752
 753 /// ExtractBasicBlock - slurp a basic block into a brand new function
 754 ///
 755 Function* llvm::ExtractBasicBlock(BasicBlock *BB, bool AggregateArgs) {
 756   std::vector<BasicBlock*> Blocks;
 757   Blocks.push_back(BB);
 758   return CodeExtractor(0, AggregateArgs).ExtractCodeRegion(Blocks);
 759 }