1 //===-- X86ISelLowering.h - X86 DAG Lowering Interface ----------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the interfaces that X86 uses to lower LLVM code into a
13 //===----------------------------------------------------------------------===//
15 #ifndef X86ISELLOWERING_H
16 #define X86ISELLOWERING_H
18 #include "X86Subtarget.h"
19 #include "X86RegisterInfo.h"
20 #include "X86MachineFunctionInfo.h"
21 #include "llvm/Target/TargetLowering.h"
22 #include "llvm/CodeGen/SelectionDAG.h"
23 #include "llvm/CodeGen/CallingConvLower.h"
27 // X86 Specific DAG Nodes
29 // Start the numbering where the builtin ops leave off.
30 FIRST_NUMBER = ISD::BUILTIN_OP_END+X86::INSTRUCTION_LIST_END,
32 /// BSF - Bit scan forward.
33 /// BSR - Bit scan reverse.
37 /// SHLD, SHRD - Double shift instructions. These correspond to
38 /// X86::SHLDxx and X86::SHRDxx instructions.
42 /// FAND - Bitwise logical AND of floating point values. This corresponds
43 /// to X86::ANDPS or X86::ANDPD.
46 /// FOR - Bitwise logical OR of floating point values. This corresponds
47 /// to X86::ORPS or X86::ORPD.
50 /// FXOR - Bitwise logical XOR of floating point values. This corresponds
51 /// to X86::XORPS or X86::XORPD.
54 /// FSRL - Bitwise logical right shift of floating point values. These
55 /// corresponds to X86::PSRLDQ.
58 /// FILD, FILD_FLAG - This instruction implements SINT_TO_FP with the
59 /// integer source in memory and FP reg result. This corresponds to the
60 /// X86::FILD*m instructions. It has three inputs (token chain, address,
61 /// and source type) and two outputs (FP value and token chain). FILD_FLAG
62 /// also produces a flag).
66 /// FP_TO_INT*_IN_MEM - This instruction implements FP_TO_SINT with the
67 /// integer destination in memory and a FP reg source. This corresponds
68 /// to the X86::FIST*m instructions and the rounding mode change stuff. It
69 /// has two inputs (token chain and address) and two outputs (int value
75 /// FLD - This instruction implements an extending load to FP stack slots.
76 /// This corresponds to the X86::FLD32m / X86::FLD64m. It takes a chain
77 /// operand, ptr to load from, and a ValueType node indicating the type
81 /// FST - This instruction implements a truncating store to FP stack
82 /// slots. This corresponds to the X86::FST32m / X86::FST64m. It takes a
83 /// chain operand, value to store, address, and a ValueType to store it
87 /// FP_GET_RESULT - This corresponds to FpGETRESULT pseudo instruction
88 /// which copies from ST(0) to the destination. It takes a chain and
89 /// writes a RFP result and a chain.
92 /// FP_GET_RESULT2 - Same as FP_GET_RESULT except it copies two values
96 /// FP_SET_RESULT - This corresponds to FpSETRESULT pseudo instruction
97 /// which copies the source operand to ST(0). It takes a chain+value and
98 /// returns a chain and a flag.
101 /// CALL/TAILCALL - These operations represent an abstract X86 call
102 /// instruction, which includes a bunch of information. In particular the
103 /// operands of these node are:
105 /// #0 - The incoming token chain
107 /// #2 - The number of arg bytes the caller pushes on the stack.
108 /// #3 - The number of arg bytes the callee pops off the stack.
109 /// #4 - The value to pass in AL/AX/EAX (optional)
110 /// #5 - The value to pass in DL/DX/EDX (optional)
112 /// The result values of these nodes are:
114 /// #0 - The outgoing token chain
115 /// #1 - The first register result value (optional)
116 /// #2 - The second register result value (optional)
118 /// The CALL vs TAILCALL distinction boils down to whether the callee is
119 /// known not to modify the caller's stack frame, as is standard with
124 /// RDTSC_DAG - This operation implements the lowering for
128 /// X86 compare and logical compare instructions.
131 /// X86 SetCC. Operand 1 is condition code, and operand 2 is the flag
132 /// operand produced by a CMP instruction.
135 /// X86 conditional moves. Operand 1 and operand 2 are the two values
136 /// to select from (operand 1 is a R/W operand). Operand 3 is the
137 /// condition code, and operand 4 is the flag operand produced by a CMP
138 /// or TEST instruction. It also writes a flag result.
141 /// X86 conditional branches. Operand 1 is the chain operand, operand 2
142 /// is the block to branch if condition is true, operand 3 is the
143 /// condition code, and operand 4 is the flag operand produced by a CMP
144 /// or TEST instruction.
147 /// Return with a flag operand. Operand 1 is the chain operand, operand
148 /// 2 is the number of bytes of stack to pop.
151 /// REP_STOS - Repeat fill, corresponds to X86::REP_STOSx.
154 /// REP_MOVS - Repeat move, corresponds to X86::REP_MOVSx.
157 /// GlobalBaseReg - On Darwin, this node represents the result of the popl
158 /// at function entry, used for PIC code.
161 /// Wrapper - A wrapper node for TargetConstantPool,
162 /// TargetExternalSymbol, and TargetGlobalAddress.
165 /// WrapperRIP - Special wrapper used under X86-64 PIC mode for RIP
166 /// relative displacements.
169 /// S2VEC - X86 version of SCALAR_TO_VECTOR. The destination base does not
170 /// have to match the operand type.
173 /// PEXTRB - Extract an 8-bit value from a vector and zero extend it to
174 /// i32, corresponds to X86::PEXTRB.
177 /// PEXTRW - Extract a 16-bit value from a vector and zero extend it to
178 /// i32, corresponds to X86::PEXTRW.
181 /// INSERTPS - Insert any element of a 4 x float vector into any element
182 /// of a destination 4 x floatvector.
185 /// PINSRB - Insert the lower 8-bits of a 32-bit value to a vector,
186 /// corresponds to X86::PINSRB.
189 /// PINSRW - Insert the lower 16-bits of a 32-bit value to a vector,
190 /// corresponds to X86::PINSRW.
193 /// FMAX, FMIN - Floating point max and min.
197 /// FRSQRT, FRCP - Floating point reciprocal-sqrt and reciprocal
198 /// approximation. Note that these typically require refinement
199 /// in order to obtain suitable precision.
202 // Thread Local Storage
203 TLSADDR, THREAD_POINTER,
205 // Exception Handling helpers
210 // operand #1 callee (register or absolute)
211 // operand #2 stack adjustment
212 // operand #3 optional in flag
215 // Store FP control world into i16 memory
220 /// Define some predicates that are used for node matching.
222 /// isPSHUFDMask - Return true if the specified VECTOR_SHUFFLE operand
223 /// specifies a shuffle of elements that is suitable for input to PSHUFD.
224 bool isPSHUFDMask(SDNode *N);
226 /// isPSHUFHWMask - Return true if the specified VECTOR_SHUFFLE operand
227 /// specifies a shuffle of elements that is suitable for input to PSHUFD.
228 bool isPSHUFHWMask(SDNode *N);
230 /// isPSHUFLWMask - Return true if the specified VECTOR_SHUFFLE operand
231 /// specifies a shuffle of elements that is suitable for input to PSHUFD.
232 bool isPSHUFLWMask(SDNode *N);
234 /// isSHUFPMask - Return true if the specified VECTOR_SHUFFLE operand
235 /// specifies a shuffle of elements that is suitable for input to SHUFP*.
236 bool isSHUFPMask(SDNode *N);
238 /// isMOVHLPSMask - Return true if the specified VECTOR_SHUFFLE operand
239 /// specifies a shuffle of elements that is suitable for input to MOVHLPS.
240 bool isMOVHLPSMask(SDNode *N);
242 /// isMOVHLPS_v_undef_Mask - Special case of isMOVHLPSMask for canonical form
243 /// of vector_shuffle v, v, <2, 3, 2, 3>, i.e. vector_shuffle v, undef,
245 bool isMOVHLPS_v_undef_Mask(SDNode *N);
247 /// isMOVLPMask - Return true if the specified VECTOR_SHUFFLE operand
248 /// specifies a shuffle of elements that is suitable for input to MOVLP{S|D}.
249 bool isMOVLPMask(SDNode *N);
251 /// isMOVHPMask - Return true if the specified VECTOR_SHUFFLE operand
252 /// specifies a shuffle of elements that is suitable for input to MOVHP{S|D}
253 /// as well as MOVLHPS.
254 bool isMOVHPMask(SDNode *N);
256 /// isUNPCKLMask - Return true if the specified VECTOR_SHUFFLE operand
257 /// specifies a shuffle of elements that is suitable for input to UNPCKL.
258 bool isUNPCKLMask(SDNode *N, bool V2IsSplat = false);
260 /// isUNPCKHMask - Return true if the specified VECTOR_SHUFFLE operand
261 /// specifies a shuffle of elements that is suitable for input to UNPCKH.
262 bool isUNPCKHMask(SDNode *N, bool V2IsSplat = false);
264 /// isUNPCKL_v_undef_Mask - Special case of isUNPCKLMask for canonical form
265 /// of vector_shuffle v, v, <0, 4, 1, 5>, i.e. vector_shuffle v, undef,
267 bool isUNPCKL_v_undef_Mask(SDNode *N);
269 /// isUNPCKH_v_undef_Mask - Special case of isUNPCKHMask for canonical form
270 /// of vector_shuffle v, v, <2, 6, 3, 7>, i.e. vector_shuffle v, undef,
272 bool isUNPCKH_v_undef_Mask(SDNode *N);
274 /// isMOVLMask - Return true if the specified VECTOR_SHUFFLE operand
275 /// specifies a shuffle of elements that is suitable for input to MOVSS,
276 /// MOVSD, and MOVD, i.e. setting the lowest element.
277 bool isMOVLMask(SDNode *N);
279 /// isMOVSHDUPMask - Return true if the specified VECTOR_SHUFFLE operand
280 /// specifies a shuffle of elements that is suitable for input to MOVSHDUP.
281 bool isMOVSHDUPMask(SDNode *N);
283 /// isMOVSLDUPMask - Return true if the specified VECTOR_SHUFFLE operand
284 /// specifies a shuffle of elements that is suitable for input to MOVSLDUP.
285 bool isMOVSLDUPMask(SDNode *N);
287 /// isSplatMask - Return true if the specified VECTOR_SHUFFLE operand
288 /// specifies a splat of a single element.
289 bool isSplatMask(SDNode *N);
291 /// isSplatLoMask - Return true if the specified VECTOR_SHUFFLE operand
292 /// specifies a splat of zero element.
293 bool isSplatLoMask(SDNode *N);
295 /// getShuffleSHUFImmediate - Return the appropriate immediate to shuffle
296 /// the specified isShuffleMask VECTOR_SHUFFLE mask with PSHUF* and SHUFP*
298 unsigned getShuffleSHUFImmediate(SDNode *N);
300 /// getShufflePSHUFHWImmediate - Return the appropriate immediate to shuffle
301 /// the specified isShuffleMask VECTOR_SHUFFLE mask with PSHUFHW
303 unsigned getShufflePSHUFHWImmediate(SDNode *N);
305 /// getShufflePSHUFKWImmediate - Return the appropriate immediate to shuffle
306 /// the specified isShuffleMask VECTOR_SHUFFLE mask with PSHUFLW
308 unsigned getShufflePSHUFLWImmediate(SDNode *N);
312 /// X86_64SRet - These represent different ways to implement x86_64 struct
313 /// returns call results.
315 InMemory, // Really is sret, returns in memory.
316 InGPR64, // Returns in a pair of 64-bit integer registers.
317 InSSE, // Returns in a pair of SSE registers.
318 InX87 // Returns in a pair of f80 X87 registers.
322 //===--------------------------------------------------------------------===//
323 // X86TargetLowering - X86 Implementation of the TargetLowering interface
324 class X86TargetLowering : public TargetLowering {
325 int VarArgsFrameIndex; // FrameIndex for start of varargs area.
326 int RegSaveFrameIndex; // X86-64 vararg func register save area.
327 unsigned VarArgsGPOffset; // X86-64 vararg func int reg offset.
328 unsigned VarArgsFPOffset; // X86-64 vararg func fp reg offset.
329 int BytesToPopOnReturn; // Number of arg bytes ret should pop.
330 int BytesCallerReserves; // Number of arg bytes caller makes.
333 explicit X86TargetLowering(TargetMachine &TM);
335 /// getPICJumpTableRelocaBase - Returns relocation base for the given PIC
337 SDOperand getPICJumpTableRelocBase(SDOperand Table,
338 SelectionDAG &DAG) const;
340 // Return the number of bytes that a function should pop when it returns (in
341 // addition to the space used by the return address).
343 unsigned getBytesToPopOnReturn() const { return BytesToPopOnReturn; }
345 // Return the number of bytes that the caller reserves for arguments passed
347 unsigned getBytesCallerReserves() const { return BytesCallerReserves; }
349 /// getStackPtrReg - Return the stack pointer register we are using: either
351 unsigned getStackPtrReg() const { return X86StackPtr; }
353 /// getByValTypeAlignment - Return the desired alignment for ByVal aggregate
354 /// function arguments in the caller parameter area. For X86, aggregates
355 /// that contains are placed at 16-byte boundaries while the rest are at
356 /// 4-byte boundaries.
357 virtual unsigned getByValTypeAlignment(const Type *Ty) const;
359 /// LowerOperation - Provide custom lowering hooks for some operations.
361 virtual SDOperand LowerOperation(SDOperand Op, SelectionDAG &DAG);
363 /// ExpandOperation - Custom lower the specified operation, splitting the
364 /// value into two pieces.
366 virtual SDNode *ExpandOperationResult(SDNode *N, SelectionDAG &DAG);
369 virtual SDOperand PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
371 virtual MachineBasicBlock *EmitInstrWithCustomInserter(MachineInstr *MI,
372 MachineBasicBlock *MBB);
374 /// getTargetNodeName - This method returns the name of a target specific
376 virtual const char *getTargetNodeName(unsigned Opcode) const;
378 /// computeMaskedBitsForTargetNode - Determine which of the bits specified
379 /// in Mask are known to be either zero or one and return them in the
380 /// KnownZero/KnownOne bitsets.
381 virtual void computeMaskedBitsForTargetNode(const SDOperand Op,
385 const SelectionDAG &DAG,
386 unsigned Depth = 0) const;
388 SDOperand getReturnAddressFrameIndex(SelectionDAG &DAG);
390 ConstraintType getConstraintType(const std::string &Constraint) const;
392 std::vector<unsigned>
393 getRegClassForInlineAsmConstraint(const std::string &Constraint,
394 MVT::ValueType VT) const;
396 virtual void lowerXConstraint(MVT::ValueType ConstraintVT,
399 /// LowerAsmOperandForConstraint - Lower the specified operand into the Ops
400 /// vector. If it is invalid, don't add anything to Ops.
401 virtual void LowerAsmOperandForConstraint(SDOperand Op,
402 char ConstraintLetter,
403 std::vector<SDOperand> &Ops,
406 /// getRegForInlineAsmConstraint - Given a physical register constraint
407 /// (e.g. {edx}), return the register number and the register class for the
408 /// register. This should only be used for C_Register constraints. On
409 /// error, this returns a register number of 0.
410 std::pair<unsigned, const TargetRegisterClass*>
411 getRegForInlineAsmConstraint(const std::string &Constraint,
412 MVT::ValueType VT) const;
414 /// isLegalAddressingMode - Return true if the addressing mode represented
415 /// by AM is legal for this target, for a load/store of the specified type.
416 virtual bool isLegalAddressingMode(const AddrMode &AM, const Type *Ty)const;
418 /// isTruncateFree - Return true if it's free to truncate a value of
419 /// type Ty1 to type Ty2. e.g. On x86 it's free to truncate a i32 value in
420 /// register EAX to i16 by referencing its sub-register AX.
421 virtual bool isTruncateFree(const Type *Ty1, const Type *Ty2) const;
422 virtual bool isTruncateFree(MVT::ValueType VT1, MVT::ValueType VT2) const;
424 /// isShuffleMaskLegal - Targets can use this to indicate that they only
425 /// support *some* VECTOR_SHUFFLE operations, those with specific masks.
426 /// By default, if a target supports the VECTOR_SHUFFLE node, all mask
427 /// values are assumed to be legal.
428 virtual bool isShuffleMaskLegal(SDOperand Mask, MVT::ValueType VT) const;
430 /// isVectorClearMaskLegal - Similar to isShuffleMaskLegal. This is
431 /// used by Targets can use this to indicate if there is a suitable
432 /// VECTOR_SHUFFLE that can be used to replace a VAND with a constant
434 virtual bool isVectorClearMaskLegal(std::vector<SDOperand> &BVOps,
436 SelectionDAG &DAG) const;
438 /// IsEligibleForTailCallOptimization - Check whether the call is eligible
439 /// for tail call optimization. Target which want to do tail call
440 /// optimization should implement this function.
441 virtual bool IsEligibleForTailCallOptimization(SDOperand Call,
443 SelectionDAG &DAG) const;
445 virtual const TargetSubtarget* getSubtarget() {
446 return static_cast<const TargetSubtarget*>(Subtarget);
449 /// isScalarFPTypeInSSEReg - Return true if the specified scalar FP type is
450 /// computed in an SSE register, not on the X87 floating point stack.
451 bool isScalarFPTypeInSSEReg(MVT::ValueType VT) const {
452 return (VT == MVT::f64 && X86ScalarSSEf64) || // f64 is when SSE2
453 (VT == MVT::f32 && X86ScalarSSEf32); // f32 is when SSE1
457 /// Subtarget - Keep a pointer to the X86Subtarget around so that we can
458 /// make the right decision when generating code for different targets.
459 const X86Subtarget *Subtarget;
460 const TargetRegisterInfo *RegInfo;
462 /// X86StackPtr - X86 physical register used as stack ptr.
463 unsigned X86StackPtr;
465 /// X86ScalarSSEf32, X86ScalarSSEf64 - Select between SSE or x87
466 /// floating point ops.
467 /// When SSE is available, use it for f32 operations.
468 /// When SSE2 is available, use it for f64 operations.
469 bool X86ScalarSSEf32;
470 bool X86ScalarSSEf64;
472 X86::X86_64SRet ClassifyX86_64SRetCallReturn(const Function *Fn);
474 void X86_64AnalyzeSRetCallOperands(SDNode*, CCAssignFn*, CCState&);
476 SDNode *LowerCallResult(SDOperand Chain, SDOperand InFlag, SDNode*TheCall,
477 unsigned CallingConv, SelectionDAG &DAG);
479 SDNode *LowerCallResultToTwo64BitRegs(SDOperand Chain, SDOperand InFlag,
480 SDNode *TheCall, unsigned Reg1,
481 unsigned Reg2, MVT::ValueType VT,
484 SDNode *LowerCallResultToTwoX87Regs(SDOperand Chain, SDOperand InFlag,
485 SDNode *TheCall, SelectionDAG &DAG);
487 SDOperand LowerMemArgument(SDOperand Op, SelectionDAG &DAG,
488 const CCValAssign &VA, MachineFrameInfo *MFI,
489 SDOperand Root, unsigned i);
491 SDOperand LowerMemOpCallTo(SDOperand Op, SelectionDAG &DAG,
492 const SDOperand &StackPtr,
493 const CCValAssign &VA, SDOperand Chain,
496 // Call lowering helpers.
497 bool IsCalleePop(SDOperand Op);
498 CCAssignFn *CCAssignFnForNode(SDOperand Op) const;
499 NameDecorationStyle NameDecorationForFORMAL_ARGUMENTS(SDOperand Op);
500 unsigned GetAlignedArgumentStackSize(unsigned StackSize, SelectionDAG &DAG);
502 std::pair<SDOperand,SDOperand> FP_TO_SINTHelper(SDOperand Op,
505 SDOperand LowerBUILD_VECTOR(SDOperand Op, SelectionDAG &DAG);
506 SDOperand LowerVECTOR_SHUFFLE(SDOperand Op, SelectionDAG &DAG);
507 SDOperand LowerEXTRACT_VECTOR_ELT(SDOperand Op, SelectionDAG &DAG);
508 SDOperand LowerEXTRACT_VECTOR_ELT_SSE4(SDOperand Op, SelectionDAG &DAG);
509 SDOperand LowerINSERT_VECTOR_ELT(SDOperand Op, SelectionDAG &DAG);
510 SDOperand LowerINSERT_VECTOR_ELT_SSE4(SDOperand Op, SelectionDAG &DAG);
511 SDOperand LowerSCALAR_TO_VECTOR(SDOperand Op, SelectionDAG &DAG);
512 SDOperand LowerConstantPool(SDOperand Op, SelectionDAG &DAG);
513 SDOperand LowerGlobalAddress(SDOperand Op, SelectionDAG &DAG);
514 SDOperand LowerGlobalTLSAddress(SDOperand Op, SelectionDAG &DAG);
515 SDOperand LowerExternalSymbol(SDOperand Op, SelectionDAG &DAG);
516 SDOperand LowerShift(SDOperand Op, SelectionDAG &DAG);
517 SDOperand LowerSINT_TO_FP(SDOperand Op, SelectionDAG &DAG);
518 SDOperand LowerFP_TO_SINT(SDOperand Op, SelectionDAG &DAG);
519 SDOperand LowerFABS(SDOperand Op, SelectionDAG &DAG);
520 SDOperand LowerFNEG(SDOperand Op, SelectionDAG &DAG);
521 SDOperand LowerFCOPYSIGN(SDOperand Op, SelectionDAG &DAG);
522 SDOperand LowerSETCC(SDOperand Op, SelectionDAG &DAG);
523 SDOperand LowerSELECT(SDOperand Op, SelectionDAG &DAG);
524 SDOperand LowerBRCOND(SDOperand Op, SelectionDAG &DAG);
525 SDOperand LowerMEMSET(SDOperand Op, SelectionDAG &DAG);
526 SDOperand LowerMEMCPYInline(SDOperand Dest, SDOperand Source,
527 SDOperand Chain, unsigned Size, unsigned Align,
529 SDOperand LowerJumpTable(SDOperand Op, SelectionDAG &DAG);
530 SDOperand LowerCALL(SDOperand Op, SelectionDAG &DAG);
531 SDOperand LowerRET(SDOperand Op, SelectionDAG &DAG);
532 SDOperand LowerDYNAMIC_STACKALLOC(SDOperand Op, SelectionDAG &DAG);
533 SDOperand LowerFORMAL_ARGUMENTS(SDOperand Op, SelectionDAG &DAG);
534 SDOperand LowerVASTART(SDOperand Op, SelectionDAG &DAG);
535 SDOperand LowerVACOPY(SDOperand Op, SelectionDAG &DAG);
536 SDOperand LowerINTRINSIC_WO_CHAIN(SDOperand Op, SelectionDAG &DAG);
537 SDOperand LowerRETURNADDR(SDOperand Op, SelectionDAG &DAG);
538 SDOperand LowerFRAMEADDR(SDOperand Op, SelectionDAG &DAG);
539 SDOperand LowerFRAME_TO_ARGS_OFFSET(SDOperand Op, SelectionDAG &DAG);
540 SDOperand LowerEH_RETURN(SDOperand Op, SelectionDAG &DAG);
541 SDOperand LowerTRAMPOLINE(SDOperand Op, SelectionDAG &DAG);
542 SDOperand LowerFLT_ROUNDS_(SDOperand Op, SelectionDAG &DAG);
543 SDOperand LowerCTLZ(SDOperand Op, SelectionDAG &DAG);
544 SDOperand LowerCTTZ(SDOperand Op, SelectionDAG &DAG);
545 SDNode *ExpandFP_TO_SINT(SDNode *N, SelectionDAG &DAG);
546 SDNode *ExpandREADCYCLECOUNTER(SDNode *N, SelectionDAG &DAG);
550 #endif // X86ISELLOWERING_H