1 //===-- llvm/CodeGen/ISDOpcodes.h - CodeGen opcodes -------------*- 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 declares codegen opcodes and related utilities.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CODEGEN_ISDOPCODES_H
15 #define LLVM_CODEGEN_ISDOPCODES_H
19 /// ISD namespace - This namespace contains an enum which represents all of the
20 /// SelectionDAG node types and value types.
24 //===--------------------------------------------------------------------===//
25 /// ISD::NodeType enum - This enum defines the target-independent operators
26 /// for a SelectionDAG.
28 /// Targets may also define target-dependent operator codes for SDNodes. For
29 /// example, on x86, these are the enum values in the X86ISD namespace.
30 /// Targets should aim to use target-independent operators to model their
31 /// instruction sets as much as possible, and only use target-dependent
32 /// operators when they have special requirements.
34 /// Finally, during and after selection proper, SNodes may use special
35 /// operator codes that correspond directly with MachineInstr opcodes. These
36 /// are used to represent selected instructions. See the isMachineOpcode()
37 /// and getMachineOpcode() member functions of SDNode.
40 /// DELETED_NODE - This is an illegal value that is used to catch
41 /// errors. This opcode is not a legal opcode for any node.
44 /// EntryToken - This is the marker used to indicate the start of a region.
47 /// TokenFactor - This node takes multiple tokens as input and produces a
48 /// single token result. This is used to represent the fact that the operand
49 /// operators are independent of each other.
52 /// AssertSext, AssertZext - These nodes record if a register contains a
53 /// value that has already been zero or sign extended from a narrower type.
54 /// These nodes take two operands. The first is the node that has already
55 /// been extended, and the second is a value type node indicating the width
57 AssertSext, AssertZext,
59 /// Various leaf nodes.
60 BasicBlock, VALUETYPE, CONDCODE, Register, RegisterMask,
62 GlobalAddress, GlobalTLSAddress, FrameIndex,
63 JumpTable, ConstantPool, ExternalSymbol, BlockAddress,
65 /// The address of the GOT
68 /// FRAMEADDR, RETURNADDR - These nodes represent llvm.frameaddress and
69 /// llvm.returnaddress on the DAG. These nodes take one operand, the index
70 /// of the frame or return address to return. An index of zero corresponds
71 /// to the current function's frame or return address, an index of one to
72 /// the parent's frame or return address, and so on.
73 FRAMEADDR, RETURNADDR, ADDROFRETURNADDR,
75 /// LOCAL_RECOVER - Represents the llvm.localrecover intrinsic.
76 /// Materializes the offset from the local object pointer of another
77 /// function to a particular local object passed to llvm.localescape. The
78 /// operand is the MCSymbol label used to represent this offset, since
79 /// typically the offset is not known until after code generation of the
83 /// READ_REGISTER, WRITE_REGISTER - This node represents llvm.register on
84 /// the DAG, which implements the named register global variables extension.
88 /// FRAME_TO_ARGS_OFFSET - This node represents offset from frame pointer to
89 /// first (possible) on-stack argument. This is needed for correct stack
90 /// adjustment during unwind.
93 /// EH_DWARF_CFA - This node represents the pointer to the DWARF Canonical
94 /// Frame Address (CFA), generally the value of the stack pointer at the
95 /// call site in the previous frame.
98 /// OUTCHAIN = EH_RETURN(INCHAIN, OFFSET, HANDLER) - This node represents
99 /// 'eh_return' gcc dwarf builtin, which is used to return from
100 /// exception. The general meaning is: adjust stack by OFFSET and pass
101 /// execution to HANDLER. Many platform-related details also :)
104 /// RESULT, OUTCHAIN = EH_SJLJ_SETJMP(INCHAIN, buffer)
105 /// This corresponds to the eh.sjlj.setjmp intrinsic.
106 /// It takes an input chain and a pointer to the jump buffer as inputs
107 /// and returns an outchain.
110 /// OUTCHAIN = EH_SJLJ_LONGJMP(INCHAIN, buffer)
111 /// This corresponds to the eh.sjlj.longjmp intrinsic.
112 /// It takes an input chain and a pointer to the jump buffer as inputs
113 /// and returns an outchain.
116 /// OUTCHAIN = EH_SJLJ_SETUP_DISPATCH(INCHAIN)
117 /// The target initializes the dispatch table here.
118 EH_SJLJ_SETUP_DISPATCH,
120 /// TargetConstant* - Like Constant*, but the DAG does not do any folding,
121 /// simplification, or lowering of the constant. They are used for constants
122 /// which are known to fit in the immediate fields of their users, or for
123 /// carrying magic numbers which are not values which need to be
124 /// materialized in registers.
128 /// TargetGlobalAddress - Like GlobalAddress, but the DAG does no folding or
129 /// anything else with this node, and this is valid in the target-specific
130 /// dag, turning into a GlobalAddress operand.
132 TargetGlobalTLSAddress,
136 TargetExternalSymbol,
141 /// TargetIndex - Like a constant pool entry, but with completely
142 /// target-dependent semantics. Holds target flags, a 32-bit index, and a
143 /// 64-bit index. Targets can use this however they like.
146 /// RESULT = INTRINSIC_WO_CHAIN(INTRINSICID, arg1, arg2, ...)
147 /// This node represents a target intrinsic function with no side effects.
148 /// The first operand is the ID number of the intrinsic from the
149 /// llvm::Intrinsic namespace. The operands to the intrinsic follow. The
150 /// node returns the result of the intrinsic.
153 /// RESULT,OUTCHAIN = INTRINSIC_W_CHAIN(INCHAIN, INTRINSICID, arg1, ...)
154 /// This node represents a target intrinsic function with side effects that
155 /// returns a result. The first operand is a chain pointer. The second is
156 /// the ID number of the intrinsic from the llvm::Intrinsic namespace. The
157 /// operands to the intrinsic follow. The node has two results, the result
158 /// of the intrinsic and an output chain.
161 /// OUTCHAIN = INTRINSIC_VOID(INCHAIN, INTRINSICID, arg1, arg2, ...)
162 /// This node represents a target intrinsic function with side effects that
163 /// does not return a result. The first operand is a chain pointer. The
164 /// second is the ID number of the intrinsic from the llvm::Intrinsic
165 /// namespace. The operands to the intrinsic follow.
168 /// CopyToReg - This node has three operands: a chain, a register number to
169 /// set to this value, and a value.
172 /// CopyFromReg - This node indicates that the input value is a virtual or
173 /// physical register that is defined outside of the scope of this
174 /// SelectionDAG. The register is available from the RegisterSDNode object.
177 /// UNDEF - An undefined node.
180 /// EXTRACT_ELEMENT - This is used to get the lower or upper (determined by
181 /// a Constant, which is required to be operand #1) half of the integer or
182 /// float value specified as operand #0. This is only for use before
183 /// legalization, for values that will be broken into multiple registers.
186 /// BUILD_PAIR - This is the opposite of EXTRACT_ELEMENT in some ways.
187 /// Given two values of the same integer value type, this produces a value
188 /// twice as big. Like EXTRACT_ELEMENT, this can only be used before
192 /// MERGE_VALUES - This node takes multiple discrete operands and returns
193 /// them all as its individual results. This nodes has exactly the same
194 /// number of inputs and outputs. This node is useful for some pieces of the
195 /// code generator that want to think about a single node with multiple
196 /// results, not multiple nodes.
199 /// Simple integer binary arithmetic operators.
200 ADD, SUB, MUL, SDIV, UDIV, SREM, UREM,
202 /// SMUL_LOHI/UMUL_LOHI - Multiply two integers of type iN, producing
203 /// a signed/unsigned value of type i[2*N], and return the full value as
204 /// two results, each of type iN.
205 SMUL_LOHI, UMUL_LOHI,
207 /// SDIVREM/UDIVREM - Divide two integers and produce both a quotient and
208 /// remainder result.
211 /// CARRY_FALSE - This node is used when folding other nodes,
212 /// like ADDC/SUBC, which indicate the carry result is always false.
215 /// Carry-setting nodes for multiple precision addition and subtraction.
216 /// These nodes take two operands of the same value type, and produce two
217 /// results. The first result is the normal add or sub result, the second
218 /// result is the carry flag result.
221 /// Carry-using nodes for multiple precision addition and subtraction. These
222 /// nodes take three operands: The first two are the normal lhs and rhs to
223 /// the add or sub, and the third is the input carry flag. These nodes
224 /// produce two results; the normal result of the add or sub, and the output
225 /// carry flag. These nodes both read and write a carry flag to allow them
226 /// to them to be chained together for add and sub of arbitrarily large
230 /// RESULT, BOOL = [SU]ADDO(LHS, RHS) - Overflow-aware nodes for addition.
231 /// These nodes take two operands: the normal LHS and RHS to the add. They
232 /// produce two results: the normal result of the add, and a boolean that
233 /// indicates if an overflow occurred (*not* a flag, because it may be store
234 /// to memory, etc.). If the type of the boolean is not i1 then the high
235 /// bits conform to getBooleanContents.
236 /// These nodes are generated from llvm.[su]add.with.overflow intrinsics.
239 /// Same for subtraction.
242 /// Same for multiplication.
245 /// Simple binary floating point operators.
246 FADD, FSUB, FMUL, FDIV, FREM,
248 /// Constrained versions of the binary floating point operators.
249 /// These will be lowered to the simple operators before final selection.
250 /// They are used to limit optimizations while the DAG is being
252 STRICT_FADD, STRICT_FSUB, STRICT_FMUL, STRICT_FDIV, STRICT_FREM,
254 /// FMA - Perform a * b + c with no intermediate rounding step.
257 /// FMAD - Perform a * b + c, while getting the same result as the
258 /// separately rounded operations.
261 /// FCOPYSIGN(X, Y) - Return the value of X with the sign of Y. NOTE: This
262 /// DAG node does not require that X and Y have the same type, just that
263 /// they are both floating point. X and the result must have the same type.
264 /// FCOPYSIGN(f32, f64) is allowed.
267 /// INT = FGETSIGN(FP) - Return the sign bit of the specified floating point
268 /// value as an integer 0/1 value.
271 /// Returns platform specific canonical encoding of a floating point number.
274 /// BUILD_VECTOR(ELT0, ELT1, ELT2, ELT3,...) - Return a vector with the
275 /// specified, possibly variable, elements. The number of elements is
276 /// required to be a power of two. The types of the operands must all be
277 /// the same and must match the vector element type, except that integer
278 /// types are allowed to be larger than the element type, in which case
279 /// the operands are implicitly truncated.
282 /// INSERT_VECTOR_ELT(VECTOR, VAL, IDX) - Returns VECTOR with the element
283 /// at IDX replaced with VAL. If the type of VAL is larger than the vector
284 /// element type then VAL is truncated before replacement.
287 /// EXTRACT_VECTOR_ELT(VECTOR, IDX) - Returns a single element from VECTOR
288 /// identified by the (potentially variable) element number IDX. If the
289 /// return type is an integer type larger than the element type of the
290 /// vector, the result is extended to the width of the return type. In
291 /// that case, the high bits are undefined.
294 /// CONCAT_VECTORS(VECTOR0, VECTOR1, ...) - Given a number of values of
295 /// vector type with the same length and element type, this produces a
296 /// concatenated vector result value, with length equal to the sum of the
297 /// lengths of the input vectors.
300 /// INSERT_SUBVECTOR(VECTOR1, VECTOR2, IDX) - Returns a vector
301 /// with VECTOR2 inserted into VECTOR1 at the (potentially
302 /// variable) element number IDX, which must be a multiple of the
303 /// VECTOR2 vector length. The elements of VECTOR1 starting at
304 /// IDX are overwritten with VECTOR2. Elements IDX through
305 /// vector_length(VECTOR2) must be valid VECTOR1 indices.
308 /// EXTRACT_SUBVECTOR(VECTOR, IDX) - Returns a subvector from VECTOR (an
309 /// vector value) starting with the element number IDX, which must be a
310 /// constant multiple of the result vector length.
313 /// VECTOR_SHUFFLE(VEC1, VEC2) - Returns a vector, of the same type as
314 /// VEC1/VEC2. A VECTOR_SHUFFLE node also contains an array of constant int
315 /// values that indicate which value (or undef) each result element will
316 /// get. These constant ints are accessible through the
317 /// ShuffleVectorSDNode class. This is quite similar to the Altivec
318 /// 'vperm' instruction, except that the indices must be constants and are
319 /// in terms of the element size of VEC1/VEC2, not in terms of bytes.
322 /// SCALAR_TO_VECTOR(VAL) - This represents the operation of loading a
323 /// scalar value into element 0 of the resultant vector type. The top
324 /// elements 1 to N-1 of the N-element vector are undefined. The type
325 /// of the operand must match the vector element type, except when they
326 /// are integer types. In this case the operand is allowed to be wider
327 /// than the vector element type, and is implicitly truncated to it.
330 /// MULHU/MULHS - Multiply high - Multiply two integers of type iN,
331 /// producing an unsigned/signed value of type i[2*N], then return the top
335 /// [US]{MIN/MAX} - Binary minimum or maximum or signed or unsigned
337 SMIN, SMAX, UMIN, UMAX,
339 /// Bitwise operators - logical and, logical or, logical xor.
342 /// ABS - Determine the unsigned absolute value of a signed integer value of
343 /// the same bitwidth.
344 /// Note: A value of INT_MIN will return INT_MIN, no saturation or overflow
348 /// Shift and rotation operations. After legalization, the type of the
349 /// shift amount is known to be TLI.getShiftAmountTy(). Before legalization
350 /// the shift amount can be any type, but care must be taken to ensure it is
351 /// large enough. TLI.getShiftAmountTy() is i8 on some targets, but before
352 /// legalization, types like i1024 can occur and i8 doesn't have enough bits
353 /// to represent the shift amount.
354 /// When the 1st operand is a vector, the shift amount must be in the same
355 /// type. (TLI.getShiftAmountTy() will return the same type when the input
356 /// type is a vector.)
357 SHL, SRA, SRL, ROTL, ROTR,
359 /// Byte Swap and Counting operators.
360 BSWAP, CTTZ, CTLZ, CTPOP, BITREVERSE,
362 /// Bit counting operators with an undefined result for zero inputs.
363 CTTZ_ZERO_UNDEF, CTLZ_ZERO_UNDEF,
365 /// Select(COND, TRUEVAL, FALSEVAL). If the type of the boolean COND is not
366 /// i1 then the high bits must conform to getBooleanContents.
369 /// Select with a vector condition (op #0) and two vector operands (ops #1
370 /// and #2), returning a vector result. All vectors have the same length.
371 /// Much like the scalar select and setcc, each bit in the condition selects
372 /// whether the corresponding result element is taken from op #1 or op #2.
373 /// At first, the VSELECT condition is of vXi1 type. Later, targets may
374 /// change the condition type in order to match the VSELECT node using a
375 /// pattern. The condition follows the BooleanContent format of the target.
378 /// Select with condition operator - This selects between a true value and
379 /// a false value (ops #2 and #3) based on the boolean result of comparing
380 /// the lhs and rhs (ops #0 and #1) of a conditional expression with the
381 /// condition code in op #4, a CondCodeSDNode.
384 /// SetCC operator - This evaluates to a true value iff the condition is
385 /// true. If the result value type is not i1 then the high bits conform
386 /// to getBooleanContents. The operands to this are the left and right
387 /// operands to compare (ops #0, and #1) and the condition code to compare
388 /// them with (op #2) as a CondCodeSDNode. If the operands are vector types
389 /// then the result type must also be a vector type.
392 /// Like SetCC, ops #0 and #1 are the LHS and RHS operands to compare, but
393 /// op #2 is a *carry value*. This operator checks the result of
394 /// "LHS - RHS - Carry", and can be used to compare two wide integers:
395 /// (setcce lhshi rhshi (subc lhslo rhslo) cc). Only valid for integers.
398 /// SHL_PARTS/SRA_PARTS/SRL_PARTS - These operators are used for expanded
399 /// integer shift operations. The operation ordering is:
400 /// [Lo,Hi] = op [LoLHS,HiLHS], Amt
401 SHL_PARTS, SRA_PARTS, SRL_PARTS,
403 /// Conversion operators. These are all single input single output
404 /// operations. For all of these, the result type must be strictly
405 /// wider or narrower (depending on the operation) than the source
408 /// SIGN_EXTEND - Used for integer types, replicating the sign bit
412 /// ZERO_EXTEND - Used for integer types, zeroing the new bits.
415 /// ANY_EXTEND - Used for integer types. The high bits are undefined.
418 /// TRUNCATE - Completely drop the high bits.
421 /// [SU]INT_TO_FP - These operators convert integers (whose interpreted sign
422 /// depends on the first letter) to floating point.
426 /// SIGN_EXTEND_INREG - This operator atomically performs a SHL/SRA pair to
427 /// sign extend a small value in a large integer register (e.g. sign
428 /// extending the low 8 bits of a 32-bit register to fill the top 24 bits
429 /// with the 7th bit). The size of the smaller type is indicated by the 1th
430 /// operand, a ValueType node.
433 /// ANY_EXTEND_VECTOR_INREG(Vector) - This operator represents an
434 /// in-register any-extension of the low lanes of an integer vector. The
435 /// result type must have fewer elements than the operand type, and those
436 /// elements must be larger integer types such that the total size of the
437 /// operand type and the result type match. Each of the low operand
438 /// elements is any-extended into the corresponding, wider result
439 /// elements with the high bits becoming undef.
440 ANY_EXTEND_VECTOR_INREG,
442 /// SIGN_EXTEND_VECTOR_INREG(Vector) - This operator represents an
443 /// in-register sign-extension of the low lanes of an integer vector. The
444 /// result type must have fewer elements than the operand type, and those
445 /// elements must be larger integer types such that the total size of the
446 /// operand type and the result type match. Each of the low operand
447 /// elements is sign-extended into the corresponding, wider result
449 // FIXME: The SIGN_EXTEND_INREG node isn't specifically limited to
450 // scalars, but it also doesn't handle vectors well. Either it should be
451 // restricted to scalars or this node (and its handling) should be merged
453 SIGN_EXTEND_VECTOR_INREG,
455 /// ZERO_EXTEND_VECTOR_INREG(Vector) - This operator represents an
456 /// in-register zero-extension of the low lanes of an integer vector. The
457 /// result type must have fewer elements than the operand type, and those
458 /// elements must be larger integer types such that the total size of the
459 /// operand type and the result type match. Each of the low operand
460 /// elements is zero-extended into the corresponding, wider result
462 ZERO_EXTEND_VECTOR_INREG,
464 /// FP_TO_[US]INT - Convert a floating point value to a signed or unsigned
469 /// X = FP_ROUND(Y, TRUNC) - Rounding 'Y' from a larger floating point type
470 /// down to the precision of the destination VT. TRUNC is a flag, which is
471 /// always an integer that is zero or one. If TRUNC is 0, this is a
472 /// normal rounding, if it is 1, this FP_ROUND is known to not change the
475 /// The TRUNC = 1 case is used in cases where we know that the value will
476 /// not be modified by the node, because Y is not using any of the extra
477 /// precision of source type. This allows certain transformations like
478 /// FP_EXTEND(FP_ROUND(X,1)) -> X which are not safe for
479 /// FP_EXTEND(FP_ROUND(X,0)) because the extra bits aren't removed.
482 /// FLT_ROUNDS_ - Returns current rounding mode:
485 /// 1 Round to nearest
490 /// X = FP_ROUND_INREG(Y, VT) - This operator takes an FP register, and
491 /// rounds it to a floating point value. It then promotes it and returns it
492 /// in a register of the same size. This operation effectively just
493 /// discards excess precision. The type to round down to is specified by
494 /// the VT operand, a VTSDNode.
497 /// X = FP_EXTEND(Y) - Extend a smaller FP type into a larger FP type.
500 /// BITCAST - This operator converts between integer, vector and FP
501 /// values, as if the value was stored to memory with one type and loaded
502 /// from the same address with the other type (or equivalently for vector
503 /// format conversions, etc). The source and result are required to have
504 /// the same bit size (e.g. f32 <-> i32). This can also be used for
505 /// int-to-int or fp-to-fp conversions, but that is a noop, deleted by
508 /// This operator is subtly different from the bitcast instruction from
509 /// LLVM-IR since this node may change the bits in the register. For
510 /// example, this occurs on big-endian NEON and big-endian MSA where the
511 /// layout of the bits in the register depends on the vector type and this
512 /// operator acts as a shuffle operation for some vector type combinations.
515 /// ADDRSPACECAST - This operator converts between pointers of different
519 /// FP16_TO_FP, FP_TO_FP16 - These operators are used to perform promotions
520 /// and truncation for half-precision (16 bit) floating numbers. These nodes
521 /// form a semi-softened interface for dealing with f16 (as an i16), which
522 /// is often a storage-only type but has native conversions.
523 FP16_TO_FP, FP_TO_FP16,
525 /// FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW,
526 /// FLOG, FLOG2, FLOG10, FEXP, FEXP2,
527 /// FCEIL, FTRUNC, FRINT, FNEARBYINT, FROUND, FFLOOR - Perform various unary
528 /// floating point operations. These are inspired by libm.
529 FNEG, FABS, FSQRT, FSIN, FCOS, FPOWI, FPOW,
530 FLOG, FLOG2, FLOG10, FEXP, FEXP2,
531 FCEIL, FTRUNC, FRINT, FNEARBYINT, FROUND, FFLOOR,
532 /// FMINNUM/FMAXNUM - Perform floating-point minimum or maximum on two
534 /// In the case where a single input is NaN, the non-NaN input is returned.
536 /// The return value of (FMINNUM 0.0, -0.0) could be either 0.0 or -0.0.
538 /// FMINNAN/FMAXNAN - Behave identically to FMINNUM/FMAXNUM, except that
539 /// when a single input is NaN, NaN is returned.
542 /// FSINCOS - Compute both fsin and fcos as a single operation.
545 /// LOAD and STORE have token chains as their first operand, then the same
546 /// operands as an LLVM load/store instruction, then an offset node that
547 /// is added / subtracted from the base pointer to form the address (for
548 /// indexed memory ops).
551 /// DYNAMIC_STACKALLOC - Allocate some number of bytes on the stack aligned
552 /// to a specified boundary. This node always has two return values: a new
553 /// stack pointer value and a chain. The first operand is the token chain,
554 /// the second is the number of bytes to allocate, and the third is the
555 /// alignment boundary. The size is guaranteed to be a multiple of the
556 /// stack alignment, and the alignment is guaranteed to be bigger than the
557 /// stack alignment (if required) or 0 to get standard stack alignment.
560 /// Control flow instructions. These all have token chains.
562 /// BR - Unconditional branch. The first operand is the chain
563 /// operand, the second is the MBB to branch to.
566 /// BRIND - Indirect branch. The first operand is the chain, the second
567 /// is the value to branch to, which must be of the same type as the
568 /// target's pointer type.
571 /// BR_JT - Jumptable branch. The first operand is the chain, the second
572 /// is the jumptable index, the last one is the jumptable entry index.
575 /// BRCOND - Conditional branch. The first operand is the chain, the
576 /// second is the condition, the third is the block to branch to if the
577 /// condition is true. If the type of the condition is not i1, then the
578 /// high bits must conform to getBooleanContents.
581 /// BR_CC - Conditional branch. The behavior is like that of SELECT_CC, in
582 /// that the condition is represented as condition code, and two nodes to
583 /// compare, rather than as a combined SetCC node. The operands in order
584 /// are chain, cc, lhs, rhs, block to branch to if condition is true.
587 /// INLINEASM - Represents an inline asm block. This node always has two
588 /// return values: a chain and a flag result. The inputs are as follows:
589 /// Operand #0 : Input chain.
590 /// Operand #1 : a ExternalSymbolSDNode with a pointer to the asm string.
591 /// Operand #2 : a MDNodeSDNode with the !srcloc metadata.
592 /// Operand #3 : HasSideEffect, IsAlignStack bits.
593 /// After this, it is followed by a list of operands with this format:
594 /// ConstantSDNode: Flags that encode whether it is a mem or not, the
595 /// of operands that follow, etc. See InlineAsm.h.
596 /// ... however many operands ...
597 /// Operand #last: Optional, an incoming flag.
599 /// The variable width operands are required to represent target addressing
600 /// modes as a single "operand", even though they may have multiple
604 /// EH_LABEL - Represents a label in mid basic block used to track
605 /// locations needed for debug and exception handling tables. These nodes
606 /// take a chain as input and return a chain.
609 /// CATCHPAD - Represents a catchpad instruction.
612 /// CATCHRET - Represents a return from a catch block funclet. Used for
613 /// MSVC compatible exception handling. Takes a chain operand and a
614 /// destination basic block operand.
617 /// CLEANUPRET - Represents a return from a cleanup block funclet. Used for
618 /// MSVC compatible exception handling. Takes only a chain operand.
621 /// STACKSAVE - STACKSAVE has one operand, an input chain. It produces a
622 /// value, the same type as the pointer type for the system, and an output
626 /// STACKRESTORE has two operands, an input chain and a pointer to restore
627 /// to it returns an output chain.
630 /// CALLSEQ_START/CALLSEQ_END - These operators mark the beginning and end
631 /// of a call sequence, and carry arbitrary information that target might
632 /// want to know. The first operand is a chain, the rest are specified by
633 /// the target and not touched by the DAG optimizers.
634 /// CALLSEQ_START..CALLSEQ_END pairs may not be nested.
635 CALLSEQ_START, // Beginning of a call sequence
636 CALLSEQ_END, // End of a call sequence
638 /// VAARG - VAARG has four operands: an input chain, a pointer, a SRCVALUE,
639 /// and the alignment. It returns a pair of values: the vaarg value and a
643 /// VACOPY - VACOPY has 5 operands: an input chain, a destination pointer,
644 /// a source pointer, a SRCVALUE for the destination, and a SRCVALUE for the
648 /// VAEND, VASTART - VAEND and VASTART have three operands: an input chain,
649 /// pointer, and a SRCVALUE.
652 /// SRCVALUE - This is a node type that holds a Value* that is used to
653 /// make reference to a value in the LLVM IR.
656 /// MDNODE_SDNODE - This is a node that holdes an MDNode*, which is used to
657 /// reference metadata in the IR.
660 /// PCMARKER - This corresponds to the pcmarker intrinsic.
663 /// READCYCLECOUNTER - This corresponds to the readcyclecounter intrinsic.
664 /// It produces a chain and one i64 value. The only operand is a chain.
665 /// If i64 is not legal, the result will be expanded into smaller values.
666 /// Still, it returns an i64, so targets should set legality for i64.
667 /// The result is the content of the architecture-specific cycle
668 /// counter-like register (or other high accuracy low latency clock source).
671 /// HANDLENODE node - Used as a handle for various purposes.
674 /// INIT_TRAMPOLINE - This corresponds to the init_trampoline intrinsic. It
675 /// takes as input a token chain, the pointer to the trampoline, the pointer
676 /// to the nested function, the pointer to pass for the 'nest' parameter, a
677 /// SRCVALUE for the trampoline and another for the nested function
678 /// (allowing targets to access the original Function*).
679 /// It produces a token chain as output.
682 /// ADJUST_TRAMPOLINE - This corresponds to the adjust_trampoline intrinsic.
683 /// It takes a pointer to the trampoline and produces a (possibly) new
684 /// pointer to the same trampoline with platform-specific adjustments
685 /// applied. The pointer it returns points to an executable block of code.
688 /// TRAP - Trapping instruction
691 /// DEBUGTRAP - Trap intended to get the attention of a debugger.
694 /// PREFETCH - This corresponds to a prefetch intrinsic. The first operand
695 /// is the chain. The other operands are the address to prefetch,
696 /// read / write specifier, locality specifier and instruction / data cache
700 /// OUTCHAIN = ATOMIC_FENCE(INCHAIN, ordering, scope)
701 /// This corresponds to the fence instruction. It takes an input chain, and
702 /// two integer constants: an AtomicOrdering and a SynchronizationScope.
705 /// Val, OUTCHAIN = ATOMIC_LOAD(INCHAIN, ptr)
706 /// This corresponds to "load atomic" instruction.
709 /// OUTCHAIN = ATOMIC_STORE(INCHAIN, ptr, val)
710 /// This corresponds to "store atomic" instruction.
713 /// Val, OUTCHAIN = ATOMIC_CMP_SWAP(INCHAIN, ptr, cmp, swap)
714 /// For double-word atomic operations:
715 /// ValLo, ValHi, OUTCHAIN = ATOMIC_CMP_SWAP(INCHAIN, ptr, cmpLo, cmpHi,
717 /// This corresponds to the cmpxchg instruction.
720 /// Val, Success, OUTCHAIN
721 /// = ATOMIC_CMP_SWAP_WITH_SUCCESS(INCHAIN, ptr, cmp, swap)
722 /// N.b. this is still a strong cmpxchg operation, so
723 /// Success == "Val == cmp".
724 ATOMIC_CMP_SWAP_WITH_SUCCESS,
726 /// Val, OUTCHAIN = ATOMIC_SWAP(INCHAIN, ptr, amt)
727 /// Val, OUTCHAIN = ATOMIC_LOAD_[OpName](INCHAIN, ptr, amt)
728 /// For double-word atomic operations:
729 /// ValLo, ValHi, OUTCHAIN = ATOMIC_SWAP(INCHAIN, ptr, amtLo, amtHi)
730 /// ValLo, ValHi, OUTCHAIN = ATOMIC_LOAD_[OpName](INCHAIN, ptr, amtLo, amtHi)
731 /// These correspond to the atomicrmw instruction.
744 // Masked load and store - consecutive vector load and store operations
745 // with additional mask operand that prevents memory accesses to the
749 // Masked gather and scatter - load and store operations for a vector of
750 // random addresses with additional mask operand that prevents memory
751 // accesses to the masked-off lanes.
754 /// This corresponds to the llvm.lifetime.* intrinsics. The first operand
755 /// is the chain and the second operand is the alloca pointer.
756 LIFETIME_START, LIFETIME_END,
758 /// GC_TRANSITION_START/GC_TRANSITION_END - These operators mark the
759 /// beginning and end of GC transition sequence, and carry arbitrary
760 /// information that target might need for lowering. The first operand is
761 /// a chain, the rest are specified by the target and not touched by the DAG
762 /// optimizers. GC_TRANSITION_START..GC_TRANSITION_END pairs may not be
767 /// GET_DYNAMIC_AREA_OFFSET - get offset from native SP to the address of
768 /// the most recent dynamic alloca. For most targets that would be 0, but
769 /// for some others (e.g. PowerPC, PowerPC64) that would be compile-time
770 /// known nonzero constant. The only operand here is the chain.
771 GET_DYNAMIC_AREA_OFFSET,
773 /// BUILTIN_OP_END - This must be the last enum value in this list.
774 /// The target-specific pre-isel opcode values start here.
778 /// FIRST_TARGET_MEMORY_OPCODE - Target-specific pre-isel operations
779 /// which do not reference a specific memory location should be less than
780 /// this value. Those that do must not be less than this value, and can
781 /// be used with SelectionDAG::getMemIntrinsicNode.
782 static const int FIRST_TARGET_MEMORY_OPCODE = BUILTIN_OP_END+300;
784 //===--------------------------------------------------------------------===//
785 /// MemIndexedMode enum - This enum defines the load / store indexed
786 /// addressing modes.
788 /// UNINDEXED "Normal" load / store. The effective address is already
789 /// computed and is available in the base pointer. The offset
790 /// operand is always undefined. In addition to producing a
791 /// chain, an unindexed load produces one value (result of the
792 /// load); an unindexed store does not produce a value.
794 /// PRE_INC Similar to the unindexed mode where the effective address is
795 /// PRE_DEC the value of the base pointer add / subtract the offset.
796 /// It considers the computation as being folded into the load /
797 /// store operation (i.e. the load / store does the address
798 /// computation as well as performing the memory transaction).
799 /// The base operand is always undefined. In addition to
800 /// producing a chain, pre-indexed load produces two values
801 /// (result of the load and the result of the address
802 /// computation); a pre-indexed store produces one value (result
803 /// of the address computation).
805 /// POST_INC The effective address is the value of the base pointer. The
806 /// POST_DEC value of the offset operand is then added to / subtracted
807 /// from the base after memory transaction. In addition to
808 /// producing a chain, post-indexed load produces two values
809 /// (the result of the load and the result of the base +/- offset
810 /// computation); a post-indexed store produces one value (the
811 /// the result of the base +/- offset computation).
812 enum MemIndexedMode {
820 static const int LAST_INDEXED_MODE = POST_DEC + 1;
822 //===--------------------------------------------------------------------===//
823 /// LoadExtType enum - This enum defines the three variants of LOADEXT
824 /// (load with extension).
826 /// SEXTLOAD loads the integer operand and sign extends it to a larger
827 /// integer result type.
828 /// ZEXTLOAD loads the integer operand and zero extends it to a larger
829 /// integer result type.
830 /// EXTLOAD is used for two things: floating point extending loads and
831 /// integer extending loads [the top bits are undefined].
839 static const int LAST_LOADEXT_TYPE = ZEXTLOAD + 1;
841 NodeType getExtForLoadExtType(bool IsFP, LoadExtType);
843 //===--------------------------------------------------------------------===//
844 /// ISD::CondCode enum - These are ordered carefully to make the bitfields
845 /// below work out, when considering SETFALSE (something that never exists
846 /// dynamically) as 0. "U" -> Unsigned (for integer operands) or Unordered
847 /// (for floating point), "L" -> Less than, "G" -> Greater than, "E" -> Equal
848 /// to. If the "N" column is 1, the result of the comparison is undefined if
849 /// the input is a NAN.
851 /// All of these (except for the 'always folded ops') should be handled for
852 /// floating point. For integer, only the SETEQ,SETNE,SETLT,SETLE,SETGT,
853 /// SETGE,SETULT,SETULE,SETUGT, and SETUGE opcodes are used.
855 /// Note that these are laid out in a specific order to allow bit-twiddling
856 /// to transform conditions.
858 // Opcode N U L G E Intuitive operation
859 SETFALSE, // 0 0 0 0 Always false (always folded)
860 SETOEQ, // 0 0 0 1 True if ordered and equal
861 SETOGT, // 0 0 1 0 True if ordered and greater than
862 SETOGE, // 0 0 1 1 True if ordered and greater than or equal
863 SETOLT, // 0 1 0 0 True if ordered and less than
864 SETOLE, // 0 1 0 1 True if ordered and less than or equal
865 SETONE, // 0 1 1 0 True if ordered and operands are unequal
866 SETO, // 0 1 1 1 True if ordered (no nans)
867 SETUO, // 1 0 0 0 True if unordered: isnan(X) | isnan(Y)
868 SETUEQ, // 1 0 0 1 True if unordered or equal
869 SETUGT, // 1 0 1 0 True if unordered or greater than
870 SETUGE, // 1 0 1 1 True if unordered, greater than, or equal
871 SETULT, // 1 1 0 0 True if unordered or less than
872 SETULE, // 1 1 0 1 True if unordered, less than, or equal
873 SETUNE, // 1 1 1 0 True if unordered or not equal
874 SETTRUE, // 1 1 1 1 Always true (always folded)
875 // Don't care operations: undefined if the input is a nan.
876 SETFALSE2, // 1 X 0 0 0 Always false (always folded)
877 SETEQ, // 1 X 0 0 1 True if equal
878 SETGT, // 1 X 0 1 0 True if greater than
879 SETGE, // 1 X 0 1 1 True if greater than or equal
880 SETLT, // 1 X 1 0 0 True if less than
881 SETLE, // 1 X 1 0 1 True if less than or equal
882 SETNE, // 1 X 1 1 0 True if not equal
883 SETTRUE2, // 1 X 1 1 1 Always true (always folded)
885 SETCC_INVALID // Marker value.
888 /// Return true if this is a setcc instruction that performs a signed
889 /// comparison when used with integer operands.
890 inline bool isSignedIntSetCC(CondCode Code) {
891 return Code == SETGT || Code == SETGE || Code == SETLT || Code == SETLE;
894 /// Return true if this is a setcc instruction that performs an unsigned
895 /// comparison when used with integer operands.
896 inline bool isUnsignedIntSetCC(CondCode Code) {
897 return Code == SETUGT || Code == SETUGE || Code == SETULT || Code == SETULE;
900 /// Return true if the specified condition returns true if the two operands to
901 /// the condition are equal. Note that if one of the two operands is a NaN,
902 /// this value is meaningless.
903 inline bool isTrueWhenEqual(CondCode Cond) {
904 return ((int)Cond & 1) != 0;
907 /// This function returns 0 if the condition is always false if an operand is
908 /// a NaN, 1 if the condition is always true if the operand is a NaN, and 2 if
909 /// the condition is undefined if the operand is a NaN.
910 inline unsigned getUnorderedFlavor(CondCode Cond) {
911 return ((int)Cond >> 3) & 3;
914 /// Return the operation corresponding to !(X op Y), where 'op' is a valid
916 CondCode getSetCCInverse(CondCode Operation, bool isInteger);
918 /// Return the operation corresponding to (Y op X) when given the operation
920 CondCode getSetCCSwappedOperands(CondCode Operation);
922 /// Return the result of a logical OR between different comparisons of
923 /// identical values: ((X op1 Y) | (X op2 Y)). This function returns
924 /// SETCC_INVALID if it is not possible to represent the resultant comparison.
925 CondCode getSetCCOrOperation(CondCode Op1, CondCode Op2, bool isInteger);
927 /// Return the result of a logical AND between different comparisons of
928 /// identical values: ((X op1 Y) & (X op2 Y)). This function returns
929 /// SETCC_INVALID if it is not possible to represent the resultant comparison.
930 CondCode getSetCCAndOperation(CondCode Op1, CondCode Op2, bool isInteger);
932 } // end llvm::ISD namespace
934 } // end llvm namespace