1 //===- CodeExtractor.cpp - Pull code region into a new function -----------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
14 //===----------------------------------------------------------------------===//
16 #include "llvm/BasicBlock.h"
17 #include "llvm/Constants.h"
18 #include "llvm/DerivedTypes.h"
19 #include "llvm/Instructions.h"
20 #include "llvm/Module.h"
21 #include "llvm/Pass.h"
22 #include "llvm/Analysis/LoopInfo.h"
23 #include "llvm/Analysis/Verifier.h"
24 #include "llvm/Transforms/Utils/BasicBlockUtils.h"
25 #include "llvm/Transforms/Utils/FunctionUtils.h"
26 #include "Support/Debug.h"
27 #include "Support/StringExtras.h"
34 /// getFunctionArg - Return a pointer to F's ARGNOth argument.
36 Argument *getFunctionArg(Function *F, unsigned argno) {
37 Function::aiterator I = F->abegin();
38 std::advance(I, argno);
42 struct CodeExtractor {
43 typedef std::vector<Value*> Values;
44 typedef std::vector<std::pair<unsigned, unsigned> > PhiValChangesTy;
45 typedef std::map<PHINode*, PhiValChangesTy> PhiVal2ArgTy;
46 PhiVal2ArgTy PhiVal2Arg;
47 std::set<BasicBlock*> BlocksToExtract;
49 Function *ExtractCodeRegion(const std::vector<BasicBlock*> &code);
52 void findInputsOutputs(Values &inputs, Values &outputs,
53 BasicBlock *newHeader,
54 BasicBlock *newRootNode);
56 void processPhiNodeInputs(PHINode *Phi,
58 BasicBlock *newHeader,
59 BasicBlock *newRootNode);
61 void rewritePhiNodes(Function *F, BasicBlock *newFuncRoot);
63 Function *constructFunction(const Values &inputs,
64 const Values &outputs,
65 BasicBlock *newRootNode, BasicBlock *newHeader,
66 Function *oldFunction, Module *M);
68 void moveCodeToFunction(Function *newFunction);
70 void emitCallAndSwitchStatement(Function *newFunction,
71 BasicBlock *newHeader,
78 void CodeExtractor::processPhiNodeInputs(PHINode *Phi,
80 BasicBlock *codeReplacer,
81 BasicBlock *newFuncRoot)
83 // Separate incoming values and BasicBlocks as internal/external. We ignore
84 // the case where both the value and BasicBlock are internal, because we don't
85 // need to do a thing.
86 std::vector<unsigned> EValEBB;
87 std::vector<unsigned> EValIBB;
88 std::vector<unsigned> IValEBB;
90 for (unsigned i = 0, e = Phi->getNumIncomingValues(); i != e; ++i) {
91 Value *phiVal = Phi->getIncomingValue(i);
92 if (Instruction *Inst = dyn_cast<Instruction>(phiVal)) {
93 if (BlocksToExtract.count(Inst->getParent())) {
94 if (!BlocksToExtract.count(Phi->getIncomingBlock(i)))
97 if (BlocksToExtract.count(Phi->getIncomingBlock(i)))
100 EValEBB.push_back(i);
102 } else if (Constant *Const = dyn_cast<Constant>(phiVal)) {
103 // Constants are internal, but considered `external' if they are coming
104 // from an external block.
105 if (!BlocksToExtract.count(Phi->getIncomingBlock(i)))
106 EValEBB.push_back(i);
107 } else if (Argument *Arg = dyn_cast<Argument>(phiVal)) {
108 // arguments are external
109 if (BlocksToExtract.count(Phi->getIncomingBlock(i)))
110 EValIBB.push_back(i);
112 EValEBB.push_back(i);
115 assert(0 && "Unhandled input in a Phi node");
119 // Both value and block are external. Need to group all of
120 // these, have an external phi, pass the result as an
121 // argument, and have THIS phi use that result.
122 if (EValEBB.size() > 0) {
123 if (EValEBB.size() == 1) {
124 // Now if it's coming from the newFuncRoot, it's that funky input
125 unsigned phiIdx = EValEBB[0];
126 if (!dyn_cast<Constant>(Phi->getIncomingValue(phiIdx)))
128 PhiVal2Arg[Phi].push_back(std::make_pair(phiIdx, inputs.size()));
129 // We can just pass this value in as argument
130 inputs.push_back(Phi->getIncomingValue(phiIdx));
132 Phi->setIncomingBlock(phiIdx, newFuncRoot);
134 PHINode *externalPhi = new PHINode(Phi->getType(), "extPhi");
135 codeReplacer->getInstList().insert(codeReplacer->begin(), externalPhi);
136 for (std::vector<unsigned>::iterator i = EValEBB.begin(),
137 e = EValEBB.end(); i != e; ++i)
139 externalPhi->addIncoming(Phi->getIncomingValue(*i),
140 Phi->getIncomingBlock(*i));
142 // We make these values invalid instead of deleting them because that
143 // would shift the indices of other values... The fixPhiNodes should
144 // clean these phi nodes up later.
145 Phi->setIncomingValue(*i, 0);
146 Phi->setIncomingBlock(*i, 0);
148 PhiVal2Arg[Phi].push_back(std::make_pair(Phi->getNumIncomingValues(),
150 // We can just pass this value in as argument
151 inputs.push_back(externalPhi);
155 // When the value is external, but block internal...
156 // just pass it in as argument, no change to phi node
157 for (std::vector<unsigned>::iterator i = EValIBB.begin(),
158 e = EValIBB.end(); i != e; ++i)
160 // rewrite the phi input node to be an argument
161 PhiVal2Arg[Phi].push_back(std::make_pair(*i, inputs.size()));
162 inputs.push_back(Phi->getIncomingValue(*i));
165 // Value internal, block external
166 // this can happen if we are extracting a part of a loop
167 for (std::vector<unsigned>::iterator i = IValEBB.begin(),
168 e = IValEBB.end(); i != e; ++i)
170 assert(0 && "Cannot (YET) handle internal values via external blocks");
175 void CodeExtractor::findInputsOutputs(Values &inputs,
177 BasicBlock *newHeader,
178 BasicBlock *newRootNode)
180 for (std::set<BasicBlock*>::const_iterator ci = BlocksToExtract.begin(),
181 ce = BlocksToExtract.end(); ci != ce; ++ci) {
182 BasicBlock *BB = *ci;
183 for (BasicBlock::iterator BBi = BB->begin(), BBe = BB->end();
185 // If a use is defined outside the region, it's an input.
186 // If a def is used outside the region, it's an output.
187 if (Instruction *I = dyn_cast<Instruction>(&*BBi)) {
188 // If it's a phi node
189 if (PHINode *Phi = dyn_cast<PHINode>(I)) {
190 processPhiNodeInputs(Phi, inputs, newHeader, newRootNode);
192 // All other instructions go through the generic input finder
193 // Loop over the operands of each instruction (inputs)
194 for (User::op_iterator op = I->op_begin(), opE = I->op_end();
196 if (Instruction *opI = dyn_cast<Instruction>(op->get())) {
197 // Check if definition of this operand is within the loop
198 if (!BlocksToExtract.count(opI->getParent())) {
199 // add this operand to the inputs
200 inputs.push_back(opI);
206 // Consider uses of this instruction (outputs)
207 for (Value::use_iterator use = I->use_begin(), useE = I->use_end();
208 use != useE; ++use) {
209 if (Instruction* inst = dyn_cast<Instruction>(*use)) {
210 if (!BlocksToExtract.count(inst->getParent())) {
211 // add this op to the outputs
212 outputs.push_back(I);
218 } /* for: basic blocks */
221 void CodeExtractor::rewritePhiNodes(Function *F,
222 BasicBlock *newFuncRoot) {
223 // Write any changes that were saved before: use function arguments as inputs
224 for (PhiVal2ArgTy::iterator i = PhiVal2Arg.begin(), e = PhiVal2Arg.end();
227 PHINode *phi = (*i).first;
228 PhiValChangesTy &values = (*i).second;
229 for (unsigned cIdx = 0, ce = values.size(); cIdx != ce; ++cIdx)
231 unsigned phiValueIdx = values[cIdx].first, argNum = values[cIdx].second;
232 if (phiValueIdx < phi->getNumIncomingValues())
233 phi->setIncomingValue(phiValueIdx, getFunctionArg(F, argNum));
235 phi->addIncoming(getFunctionArg(F, argNum), newFuncRoot);
239 // Delete any invalid Phi node inputs that were marked as NULL previously
240 for (PhiVal2ArgTy::iterator i = PhiVal2Arg.begin(), e = PhiVal2Arg.end();
243 PHINode *phi = (*i).first;
244 for (unsigned idx = 0, end = phi->getNumIncomingValues(); idx != end; ++idx)
246 if (phi->getIncomingValue(idx) == 0 && phi->getIncomingBlock(idx) == 0) {
247 phi->removeIncomingValue(idx);
254 // We are done with the saved values
259 /// constructFunction - make a function based on inputs and outputs, as follows:
260 /// f(in0, ..., inN, out0, ..., outN)
262 Function *CodeExtractor::constructFunction(const Values &inputs,
263 const Values &outputs,
264 BasicBlock *newRootNode,
265 BasicBlock *newHeader,
266 Function *oldFunction, Module *M) {
267 DEBUG(std::cerr << "inputs: " << inputs.size() << "\n");
268 DEBUG(std::cerr << "outputs: " << outputs.size() << "\n");
269 BasicBlock *header = *BlocksToExtract.begin();
271 // This function returns unsigned, outputs will go back by reference.
272 Type *retTy = Type::UShortTy;
273 std::vector<const Type*> paramTy;
275 // Add the types of the input values to the function's argument list
276 for (Values::const_iterator i = inputs.begin(),
277 e = inputs.end(); i != e; ++i) {
278 const Value *value = *i;
279 DEBUG(std::cerr << "value used in func: " << value << "\n");
280 paramTy.push_back(value->getType());
283 // Add the types of the output values to the function's argument list, but
284 // make them pointer types for scalars
285 for (Values::const_iterator i = outputs.begin(),
286 e = outputs.end(); i != e; ++i) {
287 const Value *value = *i;
288 DEBUG(std::cerr << "instr used in func: " << value << "\n");
289 const Type *valueType = value->getType();
290 // Convert scalar types into a pointer of that type
291 if (valueType->isPrimitiveType()) {
292 valueType = PointerType::get(valueType);
294 paramTy.push_back(valueType);
297 DEBUG(std::cerr << "Function type: " << retTy << " f(");
298 for (std::vector<const Type*>::iterator i = paramTy.begin(),
299 e = paramTy.end(); i != e; ++i)
300 DEBUG(std::cerr << (*i) << ", ");
301 DEBUG(std::cerr << ")\n");
303 const FunctionType *funcType = FunctionType::get(retTy, paramTy, false);
305 // Create the new function
306 Function *newFunction = new Function(funcType,
307 GlobalValue::InternalLinkage,
308 oldFunction->getName() + "_code", M);
309 newFunction->getBasicBlockList().push_back(newRootNode);
311 for (unsigned i = 0, e = inputs.size(); i != e; ++i) {
312 std::vector<User*> Users(inputs[i]->use_begin(), inputs[i]->use_end());
313 for (std::vector<User*>::iterator use = Users.begin(), useE = Users.end();
315 if (Instruction* inst = dyn_cast<Instruction>(*use))
316 if (BlocksToExtract.count(inst->getParent()))
317 inst->replaceUsesOfWith(inputs[i], getFunctionArg(newFunction, i));
320 // Rewrite branches to basic blocks outside of the loop to new dummy blocks
321 // within the new function. This must be done before we lose track of which
322 // blocks were originally in the code region.
323 std::vector<User*> Users(header->use_begin(), header->use_end());
324 for (std::vector<User*>::iterator i = Users.begin(), e = Users.end();
326 if (BranchInst *inst = dyn_cast<BranchInst>(*i)) {
327 BasicBlock *BB = inst->getParent();
328 if (!BlocksToExtract.count(BB) && BB->getParent() == oldFunction) {
329 // The BasicBlock which contains the branch is not in the region
330 // modify the branch target to a new block
331 inst->replaceUsesOfWith(header, newHeader);
339 void CodeExtractor::moveCodeToFunction(Function *newFunction) {
340 Function *oldFunc = (*BlocksToExtract.begin())->getParent();
341 Function::BasicBlockListType &oldBlocks = oldFunc->getBasicBlockList();
342 Function::BasicBlockListType &newBlocks = newFunction->getBasicBlockList();
344 for (std::set<BasicBlock*>::const_iterator i = BlocksToExtract.begin(),
345 e = BlocksToExtract.end(); i != e; ++i) {
346 // Delete the basic block from the old function, and the list of blocks
347 oldBlocks.remove(*i);
349 // Insert this basic block into the new function
350 newBlocks.push_back(*i);
355 CodeExtractor::emitCallAndSwitchStatement(Function *newFunction,
356 BasicBlock *codeReplacer,
360 // Emit a call to the new function, passing allocated memory for outputs and
361 // just plain inputs for non-scalars
362 std::vector<Value*> params(inputs);
364 for (Values::const_iterator i = outputs.begin(), e = outputs.end(); i != e;
367 // Create allocas for scalar outputs
368 if (Output->getType()->isPrimitiveType()) {
370 new AllocaInst((*i)->getType(), 0, Output->getName()+".loc",
371 codeReplacer->getParent()->begin()->begin());
372 params.push_back(alloca);
374 LoadInst *load = new LoadInst(alloca, Output->getName()+".reload");
375 codeReplacer->getInstList().push_back(load);
376 std::vector<User*> Users((*i)->use_begin(), (*i)->use_end());
377 for (std::vector<User*>::iterator use = Users.begin(), useE =Users.end();
378 use != useE; ++use) {
379 if (Instruction* inst = dyn_cast<Instruction>(*use)) {
380 if (!BlocksToExtract.count(inst->getParent()))
381 inst->replaceUsesOfWith(*i, load);
385 params.push_back(*i);
389 CallInst *call = new CallInst(newFunction, params, "targetBlock");
390 codeReplacer->getInstList().push_front(call);
392 // Now we can emit a switch statement using the call as a value.
393 SwitchInst *TheSwitch = new SwitchInst(call, codeReplacer, codeReplacer);
395 // Since there may be multiple exits from the original region, make the new
396 // function return an unsigned, switch on that number. This loop iterates
397 // over all of the blocks in the extracted region, updating any terminator
398 // instructions in the to-be-extracted region that branch to blocks that are
399 // not in the region to be extracted.
400 std::map<BasicBlock*, BasicBlock*> ExitBlockMap;
402 unsigned switchVal = 0;
403 for (std::set<BasicBlock*>::const_iterator i = BlocksToExtract.begin(),
404 e = BlocksToExtract.end(); i != e; ++i) {
405 TerminatorInst *TI = (*i)->getTerminator();
406 for (unsigned i = 0, e = TI->getNumSuccessors(); i != e; ++i)
407 if (!BlocksToExtract.count(TI->getSuccessor(i))) {
408 BasicBlock *OldTarget = TI->getSuccessor(i);
409 // add a new basic block which returns the appropriate value
410 BasicBlock *&NewTarget = ExitBlockMap[OldTarget];
412 // If we don't already have an exit stub for this non-extracted
413 // destination, create one now!
414 NewTarget = new BasicBlock(OldTarget->getName() + ".exitStub",
417 ConstantUInt *brVal = ConstantUInt::get(Type::UShortTy, switchVal++);
418 ReturnInst *NTRet = new ReturnInst(brVal, NewTarget);
420 // Update the switch instruction.
421 TheSwitch->addCase(brVal, OldTarget);
423 // Restore values just before we exit
424 // FIXME: Use a GetElementPtr to bunch the outputs in a struct
425 for (unsigned out = 0, e = outputs.size(); out != e; ++out)
426 new StoreInst(outputs[out], getFunctionArg(newFunction, out),NTRet);
429 // rewrite the original branch instruction with this new target
430 TI->setSuccessor(i, NewTarget);
434 // Now that we've done the deed, make the default destination of the switch
435 // instruction be one of the exit blocks of the region.
436 if (TheSwitch->getNumSuccessors() > 1) {
437 // FIXME: this is broken w.r.t. PHI nodes, but the old code was more broken.
438 // This edge is not traversable.
439 TheSwitch->setSuccessor(0, TheSwitch->getSuccessor(1));
444 /// ExtractRegion - Removes a loop from a function, replaces it with a call to
445 /// new function. Returns pointer to the new function.
449 /// find inputs and outputs for the region
451 /// for inputs: add to function as args, map input instr* to arg#
452 /// for outputs: add allocas for scalars,
453 /// add to func as args, map output instr* to arg#
455 /// rewrite func to use argument #s instead of instr*
457 /// for each scalar output in the function: at every exit, store intermediate
458 /// computed result back into memory.
460 Function *CodeExtractor::ExtractCodeRegion(const std::vector<BasicBlock*> &code)
462 // 1) Find inputs, outputs
463 // 2) Construct new function
464 // * Add allocas for defs, pass as args by reference
465 // * Pass in uses as args
466 // 3) Move code region, add call instr to func
468 BlocksToExtract.insert(code.begin(), code.end());
470 Values inputs, outputs;
472 // Assumption: this is a single-entry code region, and the header is the first
473 // block in the region. FIXME: is this true for a list of blocks from a
475 BasicBlock *header = code[0];
476 Function *oldFunction = header->getParent();
477 Module *module = oldFunction->getParent();
479 // This takes place of the original loop
480 BasicBlock *codeReplacer = new BasicBlock("codeRepl", oldFunction);
482 // The new function needs a root node because other nodes can branch to the
483 // head of the loop, and the root cannot have predecessors
484 BasicBlock *newFuncRoot = new BasicBlock("newFuncRoot");
485 newFuncRoot->getInstList().push_back(new BranchInst(header));
487 // Find inputs to, outputs from the code region
489 // If one of the inputs is coming from a different basic block and it's in a
490 // phi node, we need to rewrite the phi node:
492 // * All the inputs which involve basic blocks OUTSIDE of this region go into
493 // a NEW phi node that takes care of finding which value really came in.
494 // The result of this phi is passed to the function as an argument.
496 // * All the other phi values stay.
498 // FIXME: PHI nodes' incoming blocks aren't being rewritten to accomodate for
499 // blocks moving to a new function.
500 // SOLUTION: move Phi nodes out of the loop header into the codeReplacer, pass
501 // the values as parameters to the function
502 findInputsOutputs(inputs, outputs, codeReplacer, newFuncRoot);
504 // Step 2: Construct new function based on inputs/outputs,
505 // Add allocas for all defs
506 Function *newFunction = constructFunction(inputs, outputs, newFuncRoot,
507 codeReplacer, oldFunction, module);
509 rewritePhiNodes(newFunction, newFuncRoot);
511 emitCallAndSwitchStatement(newFunction, codeReplacer, inputs, outputs);
513 moveCodeToFunction(newFunction);
515 DEBUG(if (verifyFunction(*newFunction)) abort());
519 /// ExtractCodeRegion - slurp a sequence of basic blocks into a brand new
522 Function* llvm::ExtractCodeRegion(const std::vector<BasicBlock*> &code) {
523 return CodeExtractor().ExtractCodeRegion(code);
526 /// ExtractBasicBlock - slurp a natural loop into a brand new function
528 Function* llvm::ExtractLoop(Loop *L) {
529 return CodeExtractor().ExtractCodeRegion(L->getBlocks());
532 /// ExtractBasicBlock - slurp a basic block into a brand new function
534 Function* llvm::ExtractBasicBlock(BasicBlock *BB) {
535 std::vector<BasicBlock*> Blocks;
536 Blocks.push_back(BB);
537 return CodeExtractor().ExtractCodeRegion(Blocks);