include/llvm/Transforms/Utils/Local.h

   1 //===-- Local.h - Functions to perform local transformations ----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   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.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This family of functions perform various local transformations to the
  11 // program.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_TRANSFORMS_UTILS_LOCAL_H
  16 #define LLVM_TRANSFORMS_UTILS_LOCAL_H
  17
  18 #include "llvm/Function.h"
  19 #include "llvm/Analysis/ConstantFolding.h"
  20
  21 namespace llvm {
  22
  23 class Pass;
  24 class PHINode;
  25 class AllocaInst;
  26 class ConstantExpr;
  27
  28 //===----------------------------------------------------------------------===//
  29 //  Local constant propagation...
  30 //
  31
  32 /// doConstantPropagation - Constant prop a specific instruction.  Returns true
  33 /// and potentially moves the iterator if constant propagation was performed.
  34 ///
  35 bool doConstantPropagation(BasicBlock::iterator &I);
  36
  37 /// ConstantFoldTerminator - If a terminator instruction is predicated on a
  38 /// constant value, convert it into an unconditional branch to the constant
  39 /// destination.  This is a nontrivial operation because the successors of this
  40 /// basic block must have their PHI nodes updated.
  41 ///
  42 bool ConstantFoldTerminator(BasicBlock *BB);
  43
  44 /// ConstantFoldInstruction - Attempt to constant fold the specified
  45 /// instruction.  If successful, the constant result is returned, if not, null
  46 /// is returned.  Note that this function can only fail when attempting to fold
  47 /// instructions like loads and stores, which have no constant expression form.
  48 ///
  49 Constant *ConstantFoldInstruction(Instruction *I);
  50
  51 /// ConstantFoldInstOperands - Attempt to constant fold an instruction with the
  52 /// specified opcode and operands.  If successful, the constant result is
  53 /// returned, if not, null is returned.  Note that this function can fail when
  54 /// attempting to fold instructions like loads and stores, which have no
  55 /// constant expression form.
  56 ///
  57 Constant *ConstantFoldInstOperands(unsigned Opc, const Type *DestTy,
  58                                    const std::vector<Constant*> &Ops);
  59
  60
  61 /// ConstantFoldLoadThroughGEPConstantExpr - Given a constant and a
  62 /// getelementptr constantexpr, return the constant value being addressed by the
  63 /// constant expression, or null if something is funny and we can't decide.
  64 Constant *ConstantFoldLoadThroughGEPConstantExpr(Constant *C, ConstantExpr *CE);
  65
  66 //===----------------------------------------------------------------------===//
  67 //  Local dead code elimination...
  68 //
  69
  70 /// isInstructionTriviallyDead - Return true if the result produced by the
  71 /// instruction is not used, and the instruction has no side effects.
  72 ///
  73 bool isInstructionTriviallyDead(Instruction *I);
  74
  75
  76 /// dceInstruction - Inspect the instruction at *BBI and figure out if it
  77 /// isTriviallyDead.  If so, remove the instruction and update the iterator to
  78 /// point to the instruction that immediately succeeded the original
  79 /// instruction.
  80 ///
  81 bool dceInstruction(BasicBlock::iterator &BBI);
  82
  83 //===----------------------------------------------------------------------===//
  84 //  Control Flow Graph Restructuring...
  85 //
  86
  87 /// SimplifyCFG - This function is used to do simplification of a CFG.  For
  88 /// example, it adjusts branches to branches to eliminate the extra hop, it
  89 /// eliminates unreachable basic blocks, and does other "peephole" optimization
  90 /// of the CFG.  It returns true if a modification was made, possibly deleting
  91 /// the basic block that was pointed to.
  92 ///
  93 /// WARNING:  The entry node of a method may not be simplified.
  94 ///
  95 bool SimplifyCFG(BasicBlock *BB);
  96
  97 /// DemoteRegToStack - This function takes a virtual register computed by an
  98 /// Instruction and replaces it with a slot in the stack frame, allocated via
  99 /// alloca.  This allows the CFG to be changed around without fear of
 100 /// invalidating the SSA information for the value.  It returns the pointer to
 101 /// the alloca inserted to create a stack slot for X.
 102 ///
 103 AllocaInst *DemoteRegToStack(Instruction &X, bool VolatileLoads = false);
 104
 105 } // End llvm namespace
 106
 107 #endif