aboutsummaryrefslogtreecommitdiff
path: root/llvm/include/llvm/IR/IRBuilderFolder.h
blob: e781e8e094af9765b9a3e7830582bf387da09b4a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
//===- IRBuilderFolder.h - Const folder interface for IRBuilder -*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file defines for constant folding interface used by IRBuilder.
// It is implemented by ConstantFolder (default), TargetFolder and NoFoler.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_IR_IRBUILDERFOLDER_H
#define LLVM_IR_IRBUILDERFOLDER_H

#include "llvm/ADT/ArrayRef.h"
#include "llvm/IR/InstrTypes.h"
#include "llvm/IR/Instruction.h"

namespace llvm {

/// IRBuilderFolder - Interface for constant folding in IRBuilder.
class IRBuilderFolder {
public:
  virtual ~IRBuilderFolder();

  //===--------------------------------------------------------------------===//
  // Binary Operators
  //===--------------------------------------------------------------------===//

  virtual Value *CreateAdd(Constant *LHS, Constant *RHS,
                           bool HasNUW = false, bool HasNSW = false) const = 0;
  virtual Value *CreateFAdd(Constant *LHS, Constant *RHS) const = 0;
  virtual Value *CreateSub(Constant *LHS, Constant *RHS,
                           bool HasNUW = false, bool HasNSW = false) const = 0;
  virtual Value *CreateFSub(Constant *LHS, Constant *RHS) const = 0;
  virtual Value *CreateMul(Constant *LHS, Constant *RHS,
                           bool HasNUW = false, bool HasNSW = false) const = 0;
  virtual Value *CreateFMul(Constant *LHS, Constant *RHS) const = 0;
  virtual Value *CreateUDiv(Constant *LHS, Constant *RHS,
                            bool isExact = false) const = 0;
  virtual Value *CreateSDiv(Constant *LHS, Constant *RHS,
                            bool isExact = false) const = 0;
  virtual Value *CreateFDiv(Constant *LHS, Constant *RHS) const = 0;
  virtual Value *CreateURem(Constant *LHS, Constant *RHS) const = 0;
  virtual Value *CreateSRem(Constant *LHS, Constant *RHS) const = 0;
  virtual Value *CreateFRem(Constant *LHS, Constant *RHS) const = 0;
  virtual Value *CreateShl(Constant *LHS, Constant *RHS,
                           bool HasNUW = false, bool HasNSW = false) const = 0;
  virtual Value *CreateLShr(Constant *LHS, Constant *RHS,
                            bool isExact = false) const = 0;
  virtual Value *CreateAShr(Constant *LHS, Constant *RHS,
                            bool isExact = false) const = 0;
  virtual Value *CreateAnd(Constant *LHS, Constant *RHS) const = 0;
  virtual Value *CreateOr(Constant *LHS, Constant *RHS) const = 0;
  virtual Value *CreateXor(Constant *LHS, Constant *RHS) const = 0;
  virtual Value *CreateBinOp(Instruction::BinaryOps Opc,
                             Constant *LHS, Constant *RHS) const = 0;

  //===--------------------------------------------------------------------===//
  // Unary Operators
  //===--------------------------------------------------------------------===//

  virtual Value *CreateNeg(Constant *C,
                           bool HasNUW = false, bool HasNSW = false) const = 0;
  virtual Value *CreateFNeg(Constant *C) const = 0;
  virtual Value *CreateNot(Constant *C) const = 0;
  virtual Value *CreateUnOp(Instruction::UnaryOps Opc, Constant *C) const = 0;

  //===--------------------------------------------------------------------===//
  // Memory Instructions
  //===--------------------------------------------------------------------===//

  virtual Value *CreateGetElementPtr(Type *Ty, Constant *C,
                                     ArrayRef<Constant *> IdxList) const = 0;
  // This form of the function only exists to avoid ambiguous overload
  // warnings about whether to convert Idx to ArrayRef<Constant *> or
  // ArrayRef<Value *>.
  virtual Value *CreateGetElementPtr(Type *Ty, Constant *C,
                                     Constant *Idx) const = 0;
  virtual Value *CreateGetElementPtr(Type *Ty, Constant *C,
                                     ArrayRef<Value *> IdxList) const = 0;
  virtual Value *CreateInBoundsGetElementPtr(
      Type *Ty, Constant *C, ArrayRef<Constant *> IdxList) const = 0;
  // This form of the function only exists to avoid ambiguous overload
  // warnings about whether to convert Idx to ArrayRef<Constant *> or
  // ArrayRef<Value *>.
  virtual Value *CreateInBoundsGetElementPtr(Type *Ty, Constant *C,
                                             Constant *Idx) const = 0;
  virtual Value *CreateInBoundsGetElementPtr(
      Type *Ty, Constant *C, ArrayRef<Value *> IdxList) const = 0;

  //===--------------------------------------------------------------------===//
  // Cast/Conversion Operators
  //===--------------------------------------------------------------------===//

  virtual Value *CreateCast(Instruction::CastOps Op, Constant *C,
                            Type *DestTy) const = 0;
  virtual Value *CreatePointerCast(Constant *C, Type *DestTy) const = 0;
  virtual Value *CreatePointerBitCastOrAddrSpaceCast(Constant *C,
                                                     Type *DestTy) const = 0;
  virtual Value *CreateIntCast(Constant *C, Type *DestTy,
                               bool isSigned) const = 0;
  virtual Value *CreateFPCast(Constant *C, Type *DestTy) const = 0;
  virtual Value *CreateBitCast(Constant *C, Type *DestTy) const = 0;
  virtual Value *CreateIntToPtr(Constant *C, Type *DestTy) const = 0;
  virtual Value *CreatePtrToInt(Constant *C, Type *DestTy) const = 0;
  virtual Value *CreateZExtOrBitCast(Constant *C, Type *DestTy) const = 0;
  virtual Value *CreateSExtOrBitCast(Constant *C, Type *DestTy) const = 0;
  virtual Value *CreateTruncOrBitCast(Constant *C, Type *DestTy) const = 0;

  //===--------------------------------------------------------------------===//
  // Compare Instructions
  //===--------------------------------------------------------------------===//

  virtual Value *CreateICmp(CmpInst::Predicate P, Constant *LHS,
                            Constant *RHS) const = 0;
  virtual Value *CreateFCmp(CmpInst::Predicate P, Constant *LHS,
                            Constant *RHS) const = 0;

  //===--------------------------------------------------------------------===//
  // Other Instructions
  //===--------------------------------------------------------------------===//

  virtual Value *CreateSelect(Constant *C, Constant *True,
                              Constant *False) const = 0;
  virtual Value *CreateExtractElement(Constant *Vec, Constant *Idx) const = 0;
  virtual Value *CreateInsertElement(Constant *Vec, Constant *NewElt,
                                     Constant *Idx) const = 0;
  virtual Value *CreateShuffleVector(Constant *V1, Constant *V2,
                                     ArrayRef<int> Mask) const = 0;
  virtual Value *CreateExtractValue(Constant *Agg,
                                    ArrayRef<unsigned> IdxList) const = 0;
  virtual Value *CreateInsertValue(Constant *Agg, Constant *Val,
                                   ArrayRef<unsigned> IdxList) const = 0;
};

} // end namespace llvm

#endif // LLVM_IR_IRBUILDERFOLDER_H