lib/IR/ConstantFold.h

   1 //===-- ConstantFolding.h - Internal Constant Folding Interface -*- C++ -*-===//
   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 defines the (internal) constant folding interfaces for LLVM.  These
  11 // interfaces are used by the ConstantExpr::get* methods to automatically fold
  12 // constants when possible.
  13 //
  14 // These operators may return a null object if they don't know how to perform
  15 // the specified operation on the specified constant types.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #ifndef LLVM_LIB_IR_CONSTANTFOLD_H
  20 #define LLVM_LIB_IR_CONSTANTFOLD_H
  21
  22 #include "llvm/ADT/Optional.h"
  23
  24 namespace llvm {
  25 template <typename T> class ArrayRef;
  26   class Value;
  27   class Constant;
  28   class Type;
  29
  30   // Constant fold various types of instruction...
  31   Constant *ConstantFoldCastInstruction(
  32     unsigned opcode,     ///< The opcode of the cast
  33     Constant *V,         ///< The source constant
  34     Type *DestTy   ///< The destination type
  35   );
  36   Constant *ConstantFoldSelectInstruction(Constant *Cond,
  37                                           Constant *V1, Constant *V2);
  38   Constant *ConstantFoldExtractElementInstruction(Constant *Val, Constant *Idx);
  39   Constant *ConstantFoldInsertElementInstruction(Constant *Val, Constant *Elt,
  40                                                  Constant *Idx);
  41   Constant *ConstantFoldShuffleVectorInstruction(Constant *V1, Constant *V2,
  42                                                  Constant *Mask);
  43   Constant *ConstantFoldExtractValueInstruction(Constant *Agg,
  44                                                 ArrayRef<unsigned> Idxs);
  45   Constant *ConstantFoldInsertValueInstruction(Constant *Agg, Constant *Val,
  46                                                ArrayRef<unsigned> Idxs);
  47   Constant *ConstantFoldBinaryInstruction(unsigned Opcode, Constant *V1,
  48                                           Constant *V2);
  49   Constant *ConstantFoldCompareInstruction(unsigned short predicate,
  50                                            Constant *C1, Constant *C2);
  51   Constant *ConstantFoldGetElementPtr(Type *Ty, Constant *C, bool InBounds,
  52                                       Optional<unsigned> InRangeIndex,
  53                                       ArrayRef<Value *> Idxs);
  54 } // End llvm namespace
  55
  56 #endif