Skip to content

Commit c878cf4

Browse files
authored
[SelectionDAG] Consistently use doxygen comments in the NodeType enum. NFC (#172178)
1 parent 61908c5 commit c878cf4

File tree

1 file changed

+63
-63
lines changed

1 file changed

+63
-63
lines changed

llvm/include/llvm/CodeGen/ISDOpcodes.h

Lines changed: 63 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1498,102 +1498,102 @@ enum NodeType {
14981498
VECREDUCE_UMAX,
14991499
VECREDUCE_UMIN,
15001500

1501-
// PARTIAL_REDUCE_[U|S]MLA(Accumulator, Input1, Input2)
1502-
// The partial reduction nodes sign or zero extend Input1 and Input2
1503-
// (with the extension kind noted below) to the element type of
1504-
// Accumulator before multiplying their results.
1505-
// This result is concatenated to the Accumulator, and this is then reduced,
1506-
// using addition, to the result type.
1507-
// The output is only expected to either be given to another partial reduction
1508-
// operation or an equivalent vector reduce operation, so the order in which
1509-
// the elements are reduced is deliberately not specified.
1510-
// Input1 and Input2 must be the same type. Accumulator and the output must be
1511-
// the same type.
1512-
// The number of elements in Input1 and Input2 must be a positive integer
1513-
// multiple of the number of elements in the Accumulator / output type.
1514-
// Input1 and Input2 must have an element type which is the same as or smaller
1515-
// than the element type of the Accumulator and output.
1501+
/// PARTIAL_REDUCE_[U|S]MLA(Accumulator, Input1, Input2)
1502+
/// The partial reduction nodes sign or zero extend Input1 and Input2
1503+
/// (with the extension kind noted below) to the element type of
1504+
/// Accumulator before multiplying their results.
1505+
/// This result is concatenated to the Accumulator, and this is then reduced,
1506+
/// using addition, to the result type.
1507+
/// The output is only expected to either be given to another partial
1508+
/// reduction operation or an equivalent vector reduce operation, so the order
1509+
/// in which the elements are reduced is deliberately not specified.
1510+
/// Input1 and Input2 must be the same type. Accumulator and the output must
1511+
/// be the same type.
1512+
/// The number of elements in Input1 and Input2 must be a positive integer
1513+
/// multiple of the number of elements in the Accumulator / output type.
1514+
/// Input1 and Input2 must have an element type which is the same as or
1515+
/// smaller than the element type of the Accumulator and output.
15161516
PARTIAL_REDUCE_SMLA, // sext, sext
15171517
PARTIAL_REDUCE_UMLA, // zext, zext
15181518
PARTIAL_REDUCE_SUMLA, // sext, zext
15191519
PARTIAL_REDUCE_FMLA, // fpext, fpext
15201520

1521-
// The `llvm.experimental.stackmap` intrinsic.
1522-
// Operands: input chain, glue, <id>, <numShadowBytes>, [live0[, live1...]]
1523-
// Outputs: output chain, glue
1521+
/// The `llvm.experimental.stackmap` intrinsic.
1522+
/// Operands: input chain, glue, <id>, <numShadowBytes>, [live0[, live1...]]
1523+
/// Outputs: output chain, glue
15241524
STACKMAP,
15251525

1526-
// The `llvm.experimental.patchpoint.*` intrinsic.
1527-
// Operands: input chain, [glue], reg-mask, <id>, <numShadowBytes>, callee,
1528-
// <numArgs>, cc, ...
1529-
// Outputs: [rv], output chain, glue
1526+
/// The `llvm.experimental.patchpoint.*` intrinsic.
1527+
/// Operands: input chain, [glue], reg-mask, <id>, <numShadowBytes>, callee,
1528+
/// <numArgs>, cc, ...
1529+
/// Outputs: [rv], output chain, glue
15301530
PATCHPOINT,
15311531

1532-
// PTRADD represents pointer arithmetic semantics, for targets that opt in
1533-
// using shouldPreservePtrArith().
1534-
// ptr = PTRADD ptr, offset
1532+
/// PTRADD represents pointer arithmetic semantics, for targets that opt in
1533+
/// using shouldPreservePtrArith().
1534+
/// ptr = PTRADD ptr, offset
15351535
PTRADD,
15361536

15371537
// Vector Predication
15381538
#define BEGIN_REGISTER_VP_SDNODE(VPSDID, ...) VPSDID,
15391539
#include "llvm/IR/VPIntrinsics.def"
15401540

1541-
// Issue a no-op relocation against a given symbol at the current location.
1541+
/// Issue a no-op relocation against a given symbol at the current location.
15421542
RELOC_NONE,
15431543

1544-
// The `llvm.experimental.convergence.*` intrinsics.
1544+
/// The `llvm.experimental.convergence.*` intrinsics.
15451545
CONVERGENCECTRL_ANCHOR,
15461546
CONVERGENCECTRL_ENTRY,
15471547
CONVERGENCECTRL_LOOP,
1548-
// This does not correspond to any convergence control intrinsic. It is used
1549-
// to glue a convergence control token to a convergent operation in the DAG,
1550-
// which is later translated to an implicit use in the MIR.
1548+
/// This does not correspond to any convergence control intrinsic. It is used
1549+
/// to glue a convergence control token to a convergent operation in the DAG,
1550+
/// which is later translated to an implicit use in the MIR.
15511551
CONVERGENCECTRL_GLUE,
15521552

1553-
// Experimental vector histogram intrinsic
1554-
// Operands: Input Chain, Inc, Mask, Base, Index, Scale, ID
1555-
// Output: Output Chain
1553+
/// Experimental vector histogram intrinsic
1554+
/// Operands: Input Chain, Inc, Mask, Base, Index, Scale, ID
1555+
/// Output: Output Chain
15561556
EXPERIMENTAL_VECTOR_HISTOGRAM,
15571557

1558-
// Finds the index of the last active mask element
1559-
// Operands: Mask
1558+
/// Finds the index of the last active mask element
1559+
/// Operands: Mask
15601560
VECTOR_FIND_LAST_ACTIVE,
15611561

1562-
// GET_ACTIVE_LANE_MASK - this corrosponds to the llvm.get.active.lane.mask
1563-
// intrinsic. It creates a mask representing active and inactive vector
1564-
// lanes, active while Base + index < Trip Count. As with the intrinsic,
1565-
// the operands Base and Trip Count have the same scalar integer type and
1566-
// the internal addition of Base + index cannot overflow. However, the ISD
1567-
// node supports result types which are wider than i1, where the high
1568-
// bits conform to getBooleanContents similar to the SETCC operator.
1562+
/// GET_ACTIVE_LANE_MASK - this corrosponds to the llvm.get.active.lane.mask
1563+
/// intrinsic. It creates a mask representing active and inactive vector
1564+
/// lanes, active while Base + index < Trip Count. As with the intrinsic,
1565+
/// the operands Base and Trip Count have the same scalar integer type and
1566+
/// the internal addition of Base + index cannot overflow. However, the ISD
1567+
/// node supports result types which are wider than i1, where the high
1568+
/// bits conform to getBooleanContents similar to the SETCC operator.
15691569
GET_ACTIVE_LANE_MASK,
15701570

1571-
// The `llvm.loop.dependence.{war, raw}.mask` intrinsics
1572-
// Operands: Load pointer, Store pointer, Element size, Lane offset
1573-
// Output: Mask
1574-
//
1575-
// Note: The semantics of these opcodes differ slightly from the intrinsics.
1576-
// Wherever "lane" (meaning lane index) occurs in the intrinsic definition, it
1577-
// is replaced with (lane + lane_offset) for the ISD opcode.
1578-
//
1579-
// E.g., for LOOP_DEPENDENCE_WAR_MASK:
1580-
// `elementSize * lane < (ptrB - ptrA)`
1581-
// Becomes:
1582-
// `elementSize * (lane + lane_offset) < (ptrB - ptrA)`
1583-
//
1584-
// This is done to allow for trivial splitting of the operation. Note: The
1585-
// lane offset is always a constant, for scalable masks, it is implicitly
1586-
// multiplied by vscale.
1571+
/// The `llvm.loop.dependence.{war, raw}.mask` intrinsics
1572+
/// Operands: Load pointer, Store pointer, Element size, Lane offset
1573+
/// Output: Mask
1574+
///
1575+
/// Note: The semantics of these opcodes differ slightly from the intrinsics.
1576+
/// Wherever "lane" (meaning lane index) occurs in the intrinsic definition,
1577+
/// it is replaced with (lane + lane_offset) for the ISD opcode.
1578+
///
1579+
/// E.g., for LOOP_DEPENDENCE_WAR_MASK:
1580+
/// `elementSize * lane < (ptrB - ptrA)`
1581+
/// Becomes:
1582+
/// `elementSize * (lane + lane_offset) < (ptrB - ptrA)`
1583+
///
1584+
/// This is done to allow for trivial splitting of the operation. Note: The
1585+
/// lane offset is always a constant, for scalable masks, it is implicitly
1586+
/// multiplied by vscale.
15871587
LOOP_DEPENDENCE_WAR_MASK,
15881588
LOOP_DEPENDENCE_RAW_MASK,
15891589

1590-
// llvm.clear_cache intrinsic
1591-
// Operands: Input Chain, Start Addres, End Address
1592-
// Outputs: Output Chain
1590+
/// llvm.clear_cache intrinsic
1591+
/// Operands: Input Chain, Start Addres, End Address
1592+
/// Outputs: Output Chain
15931593
CLEAR_CACHE,
15941594

1595-
// Untyped node storing deactivation symbol reference
1596-
// (DeactivationSymbolSDNode).
1595+
/// Untyped node storing deactivation symbol reference
1596+
/// (DeactivationSymbolSDNode).
15971597
DEACTIVATION_SYMBOL,
15981598

15991599
/// BUILTIN_OP_END - This must be the last enum value in this list.

0 commit comments

Comments
 (0)