Add TargetLowering::prepareVolatileOrAtomicLoad
[oota-llvm.git] / lib / Target / SystemZ / SystemZISelLowering.h
1 //===-- SystemZISelLowering.h - SystemZ DAG lowering 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 interfaces that SystemZ uses to lower LLVM code into a
11 // selection DAG.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef LLVM_TARGET_SystemZ_ISELLOWERING_H
16 #define LLVM_TARGET_SystemZ_ISELLOWERING_H
17
18 #include "SystemZ.h"
19 #include "llvm/CodeGen/MachineBasicBlock.h"
20 #include "llvm/CodeGen/SelectionDAG.h"
21 #include "llvm/Target/TargetLowering.h"
22
23 namespace llvm {
24 namespace SystemZISD {
25   enum {
26     FIRST_NUMBER = ISD::BUILTIN_OP_END,
27
28     // Return with a flag operand.  Operand 0 is the chain operand.
29     RET_FLAG,
30
31     // Calls a function.  Operand 0 is the chain operand and operand 1
32     // is the target address.  The arguments start at operand 2.
33     // There is an optional glue operand at the end.
34     CALL,
35     SIBCALL,
36
37     // Wraps a TargetGlobalAddress that should be loaded using PC-relative
38     // accesses (LARL).  Operand 0 is the address.
39     PCREL_WRAPPER,
40
41     // Used in cases where an offset is applied to a TargetGlobalAddress.
42     // Operand 0 is the full TargetGlobalAddress and operand 1 is a
43     // PCREL_WRAPPER for an anchor point.  This is used so that we can
44     // cheaply refer to either the full address or the anchor point
45     // as a register base.
46     PCREL_OFFSET,
47
48     // Integer comparisons.  There are three operands: the two values
49     // to compare, and an integer of type SystemZICMP.
50     ICMP,
51
52     // Floating-point comparisons.  The two operands are the values to compare.
53     FCMP,
54
55     // Test under mask.  The first operand is ANDed with the second operand
56     // and the condition codes are set on the result.  The third operand is
57     // a boolean that is true if the condition codes need to distinguish
58     // between CCMASK_TM_MIXED_MSB_0 and CCMASK_TM_MIXED_MSB_1 (which the
59     // register forms do but the memory forms don't).
60     TM,
61
62     // Branches if a condition is true.  Operand 0 is the chain operand;
63     // operand 1 is the 4-bit condition-code mask, with bit N in
64     // big-endian order meaning "branch if CC=N"; operand 2 is the
65     // target block and operand 3 is the flag operand.
66     BR_CCMASK,
67
68     // Selects between operand 0 and operand 1.  Operand 2 is the
69     // mask of condition-code values for which operand 0 should be
70     // chosen over operand 1; it has the same form as BR_CCMASK.
71     // Operand 3 is the flag operand.
72     SELECT_CCMASK,
73
74     // Evaluates to the gap between the stack pointer and the
75     // base of the dynamically-allocatable area.
76     ADJDYNALLOC,
77
78     // Extracts the value of a 32-bit access register.  Operand 0 is
79     // the number of the register.
80     EXTRACT_ACCESS,
81
82     // Wrappers around the ISD opcodes of the same name.  The output and
83     // first input operands are GR128s.  The trailing numbers are the
84     // widths of the second operand in bits.
85     UMUL_LOHI64,
86     SDIVREM32,
87     SDIVREM64,
88     UDIVREM32,
89     UDIVREM64,
90
91     // Use a series of MVCs to copy bytes from one memory location to another.
92     // The operands are:
93     // - the target address
94     // - the source address
95     // - the constant length
96     //
97     // This isn't a memory opcode because we'd need to attach two
98     // MachineMemOperands rather than one.
99     MVC,
100
101     // Like MVC, but implemented as a loop that handles X*256 bytes
102     // followed by straight-line code to handle the rest (if any).
103     // The value of X is passed as an additional operand.
104     MVC_LOOP,
105
106     // Similar to MVC and MVC_LOOP, but for logic operations (AND, OR, XOR).
107     NC,
108     NC_LOOP,
109     OC,
110     OC_LOOP,
111     XC,
112     XC_LOOP,
113
114     // Use CLC to compare two blocks of memory, with the same comments
115     // as for MVC and MVC_LOOP.
116     CLC,
117     CLC_LOOP,
118
119     // Use an MVST-based sequence to implement stpcpy().
120     STPCPY,
121
122     // Use a CLST-based sequence to implement strcmp().  The two input operands
123     // are the addresses of the strings to compare.
124     STRCMP,
125
126     // Use an SRST-based sequence to search a block of memory.  The first
127     // operand is the end address, the second is the start, and the third
128     // is the character to search for.  CC is set to 1 on success and 2
129     // on failure.
130     SEARCH_STRING,
131
132     // Store the CC value in bits 29 and 28 of an integer.
133     IPM,
134
135     // Perform a serialization operation.  (BCR 15,0 or BCR 14,0.)
136     SERIALIZE,
137
138     // Wrappers around the inner loop of an 8- or 16-bit ATOMIC_SWAP or
139     // ATOMIC_LOAD_<op>.
140     //
141     // Operand 0: the address of the containing 32-bit-aligned field
142     // Operand 1: the second operand of <op>, in the high bits of an i32
143     //            for everything except ATOMIC_SWAPW
144     // Operand 2: how many bits to rotate the i32 left to bring the first
145     //            operand into the high bits
146     // Operand 3: the negative of operand 2, for rotating the other way
147     // Operand 4: the width of the field in bits (8 or 16)
148     ATOMIC_SWAPW = ISD::FIRST_TARGET_MEMORY_OPCODE,
149     ATOMIC_LOADW_ADD,
150     ATOMIC_LOADW_SUB,
151     ATOMIC_LOADW_AND,
152     ATOMIC_LOADW_OR,
153     ATOMIC_LOADW_XOR,
154     ATOMIC_LOADW_NAND,
155     ATOMIC_LOADW_MIN,
156     ATOMIC_LOADW_MAX,
157     ATOMIC_LOADW_UMIN,
158     ATOMIC_LOADW_UMAX,
159
160     // A wrapper around the inner loop of an ATOMIC_CMP_SWAP.
161     //
162     // Operand 0: the address of the containing 32-bit-aligned field
163     // Operand 1: the compare value, in the low bits of an i32
164     // Operand 2: the swap value, in the low bits of an i32
165     // Operand 3: how many bits to rotate the i32 left to bring the first
166     //            operand into the high bits
167     // Operand 4: the negative of operand 2, for rotating the other way
168     // Operand 5: the width of the field in bits (8 or 16)
169     ATOMIC_CMP_SWAPW,
170
171     // Prefetch from the second operand using the 4-bit control code in
172     // the first operand.  The code is 1 for a load prefetch and 2 for
173     // a store prefetch.
174     PREFETCH
175   };
176
177   // Return true if OPCODE is some kind of PC-relative address.
178   inline bool isPCREL(unsigned Opcode) {
179     return Opcode == PCREL_WRAPPER || Opcode == PCREL_OFFSET;
180   }
181 }
182
183 namespace SystemZICMP {
184   // Describes whether an integer comparison needs to be signed or unsigned,
185   // or whether either type is OK.
186   enum {
187     Any,
188     UnsignedOnly,
189     SignedOnly
190   };
191 }
192
193 class SystemZSubtarget;
194 class SystemZTargetMachine;
195
196 class SystemZTargetLowering : public TargetLowering {
197 public:
198   explicit SystemZTargetLowering(SystemZTargetMachine &TM);
199
200   // Override TargetLowering.
201   virtual MVT getScalarShiftAmountTy(EVT LHSTy) const LLVM_OVERRIDE {
202     return MVT::i32;
203   }
204   virtual EVT getSetCCResultType(LLVMContext &, EVT) const LLVM_OVERRIDE;
205   virtual bool isFMAFasterThanFMulAndFAdd(EVT VT) const LLVM_OVERRIDE;
206   virtual bool isFPImmLegal(const APFloat &Imm, EVT VT) const LLVM_OVERRIDE;
207   virtual bool isLegalAddressingMode(const AddrMode &AM, Type *Ty) const
208      LLVM_OVERRIDE;
209   virtual bool allowsUnalignedMemoryAccesses(EVT VT, bool *Fast) const
210     LLVM_OVERRIDE;
211   virtual bool isTruncateFree(Type *, Type *) const LLVM_OVERRIDE;
212   virtual bool isTruncateFree(EVT, EVT) const LLVM_OVERRIDE;
213   virtual const char *getTargetNodeName(unsigned Opcode) const LLVM_OVERRIDE;
214   virtual std::pair<unsigned, const TargetRegisterClass *>
215     getRegForInlineAsmConstraint(const std::string &Constraint,
216                                  MVT VT) const LLVM_OVERRIDE;
217   virtual TargetLowering::ConstraintType
218     getConstraintType(const std::string &Constraint) const LLVM_OVERRIDE;
219   virtual TargetLowering::ConstraintWeight
220     getSingleConstraintMatchWeight(AsmOperandInfo &info,
221                                    const char *constraint) const LLVM_OVERRIDE;
222   virtual void
223     LowerAsmOperandForConstraint(SDValue Op,
224                                  std::string &Constraint,
225                                  std::vector<SDValue> &Ops,
226                                  SelectionDAG &DAG) const LLVM_OVERRIDE;
227   virtual MachineBasicBlock *
228     EmitInstrWithCustomInserter(MachineInstr *MI,
229                                 MachineBasicBlock *BB) const LLVM_OVERRIDE;
230   virtual SDValue LowerOperation(SDValue Op,
231                                  SelectionDAG &DAG) const LLVM_OVERRIDE;
232   virtual bool allowTruncateForTailCall(Type *, Type *) const LLVM_OVERRIDE;
233   virtual bool mayBeEmittedAsTailCall(CallInst *CI) const LLVM_OVERRIDE;
234   virtual SDValue
235     LowerFormalArguments(SDValue Chain,
236                          CallingConv::ID CallConv, bool isVarArg,
237                          const SmallVectorImpl<ISD::InputArg> &Ins,
238                          SDLoc DL, SelectionDAG &DAG,
239                          SmallVectorImpl<SDValue> &InVals) const LLVM_OVERRIDE;
240   virtual SDValue
241     LowerCall(CallLoweringInfo &CLI,
242               SmallVectorImpl<SDValue> &InVals) const LLVM_OVERRIDE;
243
244   virtual SDValue
245     LowerReturn(SDValue Chain,
246                 CallingConv::ID CallConv, bool IsVarArg,
247                 const SmallVectorImpl<ISD::OutputArg> &Outs,
248                 const SmallVectorImpl<SDValue> &OutVals,
249                 SDLoc DL, SelectionDAG &DAG) const LLVM_OVERRIDE;
250   virtual SDValue prepareVolatileOrAtomicLoad(SDValue Chain, SDLoc DL,
251                                               SelectionDAG &DAG) const
252     LLVM_OVERRIDE;
253
254 private:
255   const SystemZSubtarget &Subtarget;
256   const SystemZTargetMachine &TM;
257
258   // Implement LowerOperation for individual opcodes.
259   SDValue lowerSETCC(SDValue Op, SelectionDAG &DAG) const;
260   SDValue lowerBR_CC(SDValue Op, SelectionDAG &DAG) const;
261   SDValue lowerSELECT_CC(SDValue Op, SelectionDAG &DAG) const;
262   SDValue lowerGlobalAddress(GlobalAddressSDNode *Node,
263                              SelectionDAG &DAG) const;
264   SDValue lowerGlobalTLSAddress(GlobalAddressSDNode *Node,
265                                 SelectionDAG &DAG) const;
266   SDValue lowerBlockAddress(BlockAddressSDNode *Node,
267                             SelectionDAG &DAG) const;
268   SDValue lowerJumpTable(JumpTableSDNode *JT, SelectionDAG &DAG) const;
269   SDValue lowerConstantPool(ConstantPoolSDNode *CP, SelectionDAG &DAG) const;
270   SDValue lowerVASTART(SDValue Op, SelectionDAG &DAG) const;
271   SDValue lowerVACOPY(SDValue Op, SelectionDAG &DAG) const;
272   SDValue lowerDYNAMIC_STACKALLOC(SDValue Op, SelectionDAG &DAG) const;
273   SDValue lowerSMUL_LOHI(SDValue Op, SelectionDAG &DAG) const;
274   SDValue lowerUMUL_LOHI(SDValue Op, SelectionDAG &DAG) const;
275   SDValue lowerSDIVREM(SDValue Op, SelectionDAG &DAG) const;
276   SDValue lowerUDIVREM(SDValue Op, SelectionDAG &DAG) const;
277   SDValue lowerBITCAST(SDValue Op, SelectionDAG &DAG) const;
278   SDValue lowerOR(SDValue Op, SelectionDAG &DAG) const;
279   SDValue lowerATOMIC_LOAD(SDValue Op, SelectionDAG &DAG,
280                            unsigned Opcode) const;
281   SDValue lowerATOMIC_CMP_SWAP(SDValue Op, SelectionDAG &DAG) const;
282   SDValue lowerLOAD_SEQUENCE_POINT(SDValue Op, SelectionDAG &DAG) const;
283   SDValue lowerSTACKSAVE(SDValue Op, SelectionDAG &DAG) const;
284   SDValue lowerSTACKRESTORE(SDValue Op, SelectionDAG &DAG) const;
285   SDValue lowerPREFETCH(SDValue Op, SelectionDAG &DAG) const;
286
287   // If the last instruction before MBBI in MBB was some form of COMPARE,
288   // try to replace it with a COMPARE AND BRANCH just before MBBI.
289   // CCMask and Target are the BRC-like operands for the branch.
290   // Return true if the change was made.
291   bool convertPrevCompareToBranch(MachineBasicBlock *MBB,
292                                   MachineBasicBlock::iterator MBBI,
293                                   unsigned CCMask,
294                                   MachineBasicBlock *Target) const;
295
296   // Implement EmitInstrWithCustomInserter for individual operation types.
297   MachineBasicBlock *emitSelect(MachineInstr *MI,
298                                 MachineBasicBlock *BB) const;
299   MachineBasicBlock *emitCondStore(MachineInstr *MI,
300                                    MachineBasicBlock *BB,
301                                    unsigned StoreOpcode, unsigned STOCOpcode,
302                                    bool Invert) const;
303   MachineBasicBlock *emitExt128(MachineInstr *MI,
304                                 MachineBasicBlock *MBB,
305                                 bool ClearEven, unsigned SubReg) const;
306   MachineBasicBlock *emitAtomicLoadBinary(MachineInstr *MI,
307                                           MachineBasicBlock *BB,
308                                           unsigned BinOpcode, unsigned BitSize,
309                                           bool Invert = false) const;
310   MachineBasicBlock *emitAtomicLoadMinMax(MachineInstr *MI,
311                                           MachineBasicBlock *MBB,
312                                           unsigned CompareOpcode,
313                                           unsigned KeepOldMask,
314                                           unsigned BitSize) const;
315   MachineBasicBlock *emitAtomicCmpSwapW(MachineInstr *MI,
316                                         MachineBasicBlock *BB) const;
317   MachineBasicBlock *emitMemMemWrapper(MachineInstr *MI,
318                                        MachineBasicBlock *BB,
319                                        unsigned Opcode) const;
320   MachineBasicBlock *emitStringWrapper(MachineInstr *MI,
321                                        MachineBasicBlock *BB,
322                                        unsigned Opcode) const;
323 };
324 } // end namespace llvm
325
326 #endif // LLVM_TARGET_SystemZ_ISELLOWERING_H