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