include/llvm/Analysis/ConstantFolding.h

   1 //===-- ConstantFolding.h - Analyze constant folding possibilities --------===//
   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 determines the possibility of performing constant
  11 // folding.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_ANALYSIS_CONSTANTFOLDING_H
  16 #define LLVM_ANALYSIS_CONSTANTFOLDING_H
  17
  18 namespace llvm {
  19   class Constant;
  20   class ConstantExpr;
  21   class Instruction;
  22   class TargetData;
  23   class Function;
  24   class Type;
  25
  26 /// ConstantFoldInstruction - Attempt to constant fold the specified
  27 /// instruction.  If successful, the constant result is returned, if not, null
  28 /// is returned.  Note that this function can only fail when attempting to fold
  29 /// instructions like loads and stores, which have no constant expression form.
  30 ///
  31 Constant *ConstantFoldInstruction(Instruction *I, const TargetData *TD = 0);
  32
  33 /// ConstantFoldInstOperands - Attempt to constant fold an instruction with the
  34 /// specified operands.  If successful, the constant result is returned, if not,
  35 /// null is returned.  Note that this function can fail when attempting to
  36 /// fold instructions like loads and stores, which have no constant expression
  37 /// form.
  38 ///
  39 Constant *ConstantFoldInstOperands(unsigned Opcode, const Type *DestTy,
  40                                    Constant*const * Ops, unsigned NumOps,
  41                                    const TargetData *TD = 0);
  42
  43 /// ConstantFoldCompareInstOperands - Attempt to constant fold a compare
  44 /// instruction (icmp/fcmp) with the specified operands.  If it fails, it
  45 /// returns a constant expression of the specified operands.
  46 ///
  47 Constant *ConstantFoldCompareInstOperands(unsigned Predicate,
  48                                           Constant*const * Ops, unsigned NumOps,
  49                                           const TargetData *TD = 0);
  50
  51
  52 /// ConstantFoldLoadThroughGEPConstantExpr - Given a constant and a
  53 /// getelementptr constantexpr, return the constant value being addressed by the
  54 /// constant expression, or null if something is funny and we can't decide.
  55 Constant *ConstantFoldLoadThroughGEPConstantExpr(Constant *C, ConstantExpr *CE);
  56
  57 /// canConstantFoldCallTo - Return true if its even possible to fold a call to
  58 /// the specified function.
  59 bool canConstantFoldCallTo(Function *F);
  60
  61 /// ConstantFoldCall - Attempt to constant fold a call to the specified function
  62 /// with the specified arguments, returning null if unsuccessful.
  63 Constant *
  64 ConstantFoldCall(Function *F, Constant* const* Operands, unsigned NumOperands);
  65 }
  66
  67 #endif