class Unop(Op):
"""Unary nodes have exactly 1 input"""
name = "unop"
- ins = [ "op" ]
+ ins = [
+ ("op", "operand"),
+ ]
op_index = 0
pinned = "no"
abstract(Unop)
class Binop(Op):
"""Binary nodes have exactly 2 inputs"""
name = "binop"
- ins = [ "left", "right" ]
+ ins = [
+ ( "left", "first operand" ),
+ ( "right", "second operand" ),
+ ]
op_index = 0
pinned = "no"
abstract(Binop)
class Add(Binop):
"""returns the sum of its operands"""
- flags = ["commutative"]
+ flags = [ "commutative" ]
class Alloc(Op):
"""allocates a block of memory.
It can be specified whether the variable should be allocated to the stack
or to the heap."""
- ins = [ "mem", "count" ]
+ ins = [
+ ("mem", "memory dependency" ),
+ ("count", "number of objects to allocate" ),
+ ]
outs = [
("M", "memory result", "pn_Generic_M"),
("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
("X_except", "control flow when exception occured", "pn_Generic_X_except"),
("res", "pointer to newly allocated memory", "pn_Generic_other"),
]
- flags = [ "fragile", "uses_memory" ]
attrs = [
dict(
- name = "type",
- type = "ir_type*"
+ name = "type",
+ type = "ir_type*",
+ comment = "type of the allocated variable",
),
dict(
- name = "where",
- type = "ir_where_alloc"
+ name = "where",
+ type = "ir_where_alloc",
+ comment = "whether to allocate the variable on the stack or heap",
)
]
+ flags = [ "fragile", "uses_memory" ]
pinned = "yes"
attr_struct = "alloc_attr"
customSerializer = True
attrs = [
dict(
- name = "input_constraints",
- type = "ir_asm_constraint*",
+ name = "input_constraints",
+ type = "ir_asm_constraint*",
+ comment = "input constraints",
),
dict(
- name = "n_output_constraints",
- type = "int",
- noprop = True,
+ name = "n_output_constraints",
+ type = "int",
+ noprop = True,
+ comment = "number of output constraints",
),
dict(
- name = "output_constraints",
- type = "ir_asm_constraint*",
+ name = "output_constraints",
+ type = "ir_asm_constraint*",
+ comment = "output constraints",
),
dict(
- name = "n_clobbers",
- type = "int",
- noprop = True,
+ name = "n_clobbers",
+ type = "int",
+ noprop = True,
+ comment = "number of clobbered registers/memory",
),
dict(
- name = "clobbers",
- type = "ident**",
+ name = "clobbers",
+ type = "ident**",
+ comment = "list of clobbered registers/memory",
),
dict(
- name = "text",
- type = "ident*",
+ name = "text",
+ type = "ident*",
+ comment = "assembler text",
),
]
# constructor is written manually at the moment, because of the clobbers+
class Bound(Op):
"""Performs a bounds-check: if lower <= index < upper then return index,
otherwise throw an exception."""
- ins = [ "mem", "index", "lower", "upper" ]
+ ins = [
+ ("mem", "memory dependency"),
+ ("index", "value to test"),
+ ("lower", "lower bound (inclusive)"),
+ ("upper", "upper bound (exclusive)"),
+ ]
outs = [
("M", "memory result", "pn_Generic_M"),
("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
class Builtin(Op):
"""performs a backend-specific builtin."""
- ins = [ "mem" ]
+ ins = [
+ ("mem", "memory dependency"),
+ ]
arity = "variable"
outs = [
("M", "memory result", "pn_Generic_M"),
flags = [ "uses_memory" ]
attrs = [
dict(
- type = "ir_builtin_kind",
- name = "kind"
+ type = "ir_builtin_kind",
+ name = "kind",
+ comment = "kind of builtin",
),
dict(
- type = "ir_type*",
- name = "type"
+ type = "ir_type*",
+ name = "type",
+ comment = "method type for the builtin call",
)
]
pinned = "memory"
operands are passed to the called code. Called code usually performs a
return operation. The operands of this return operation are the result
of the Call node."""
- ins = [ "mem", "ptr" ]
+ ins = [
+ ("mem", "memory dependency"),
+ ("ptr", "pointer to called code"),
+ ]
arity = "variable"
outs = [
("M", "memory result", "pn_Generic_M"),
("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
("X_except", "control flow when exception occured", "pn_Generic_X_except"),
("T_result", "tuple containing all results", "pn_Generic_other"),
- ("P_value_res_base", "pointer to memory register containing copied results passed by value"),
]
flags = [ "fragile", "uses_memory" ]
attrs = [
dict(
- type = "ir_type*",
- name = "type"
+ type = "ir_type*",
+ name = "type",
+ comment = "type of the call (usually type of the called procedure)",
),
dict(
type = "unsigned",
name = "tail_call",
# the tail call attribute can only be set by analysis
- init = "0"
+ init = "0",
)
]
attr_struct = "call_attr"
flags = [ "highlevel" ]
attrs = [
dict(
- type = "ir_type*",
- name = "type"
+ type = "ir_type*",
+ name = "type",
+ comment = "target type of the case",
)
]
attr_struct = "cast_attr"
init = "assert(is_atomic_type(type));"
class Cmp(Binop):
- """Returns the relation of 2 operands"""
- outs = [
- ("False", "always false", "0"),
- ("Eq", "equal", "1"),
- ("Lt", "less", "2"),
- ("Le", "less or equal", "pn_Cmp_Eq|pn_Cmp_Lt"),
- ("Gt", "greater", "4"),
- ("Ge", "greater or equal", "pn_Cmp_Eq|pn_Cmp_Gt"),
- ("Lg", "less or greater ('not equal' for integer numbers)", "pn_Cmp_Lt|pn_Cmp_Gt"),
- ("Leg", "less, equal or greater ('not unordered')", "pn_Cmp_Lt|pn_Cmp_Eq|pn_Cmp_Gt"),
- ("Uo", "unordered", "8"),
- ("Ue", "unordered or equal", "pn_Cmp_Uo|pn_Cmp_Eq"),
- ("Ul", "unordered or less", "pn_Cmp_Uo|pn_Cmp_Lt"),
- ("Ule", "unordered, less or equal", "pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Eq"),
- ("Ug", "unordered or greater", "pn_Cmp_Uo|pn_Cmp_Gt"),
- ("Uge", "onordered, greater or equal", "pn_Cmp_Uo|pn_Cmp_Gt|pn_Cmp_Eq"),
- ("Ne", "unordered, less or greater ('not equal' for floatingpoint numbers)", "pn_Cmp_Uo|pn_Cmp_Lt|pn_Cmp_Gt"),
- ("True", "always true", "15"),
- ]
+ """Compares its two operands and checks whether a specified
+ relation (like less or equal) is fulfilled."""
flags = []
+ mode = "mode_b"
+ attrs = [
+ dict(
+ type = "ir_relation",
+ name = "relation",
+ comment = "Comparison relation"
+ )
+ ]
+ attr_struct = "cmp_attr"
class Cond(Op):
"""Conditionally change control flow. There are two versions of this node:
will proceed along output i. If the input is >= n control flow proceeds
along output def_proj.
"""
- ins = [ "selector" ]
+ ins = [
+ ("selector", "condition parameter"),
+ ]
outs = [
("false", "control flow if operand is \"false\""),
("true", "control flow if operand is \"true\""),
pinned = "yes"
attrs = [
dict(
- name = "default_proj",
- type = "long",
- init = "0"
+ name = "default_proj",
+ type = "long",
+ init = "0",
+ comment = "Proj-number of default case for switch-Cond",
),
dict(
- name = "jmp_pred",
- type = "cond_jmp_predicate",
- init = "COND_JMP_PRED_NONE"
+ name = "jmp_pred",
+ type = "cond_jmp_predicate",
+ init = "COND_JMP_PRED_NONE",
+ comment = "can indicate the most likely jump",
)
]
attr_struct = "cond_attr"
value is always returned.
Note that this node does NOT check or assert the constraint, it merely
specifies it."""
- ins = [ "value", "bound" ]
+ ins = [
+ ("value", "value to express a constraint for"),
+ ("bound", "value to compare against"),
+ ]
mode = "get_irn_mode(irn_value)"
flags = [ "highlevel" ]
pinned = "yes"
attrs = [
dict(
- name = "cmp",
- type = "pn_Cmp"
+ name = "relation",
+ type = "ir_relation",
+ comment = "relation of value to bound",
),
]
attr_struct = "confirm_attr"
pinned = "no"
attrs = [
dict(
- type = "ir_tarval*",
- name = "tarval",
+ type = "ir_tarval*",
+ name = "tarval",
+ comment = "constant value (a tarval object)",
)
]
attr_struct = "const_attr"
flags = []
attrs = [
dict(
- name = "strict",
- type = "int",
- init = "0",
+ name = "strict",
+ type = "int",
+ init = "0",
+ comment = "force floating point to restrict precision even if backend computes in higher precision (deprecated)",
)
]
attr_struct = "conv_attr"
class CopyB(Op):
"""Copies a block of memory"""
- ins = [ "mem", "dst", "src" ]
+ ins = [
+ ("mem", "memory dependency"),
+ ("dst", "destination address"),
+ ("src", "source address"),
+ ]
outs = [
("M", "memory result", "pn_Generic_M"),
("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
flags = [ "fragile", "uses_memory" ]
attrs = [
dict(
- name = "type",
- type = "ir_type*"
+ name = "type",
+ type = "ir_type*",
+ comment = "type of copied data",
)
]
attr_struct = "copyb_attr"
pinned_init = "op_pin_state_pinned"
class Div(Op):
- """returns the quotient of its 2 operands, integer version"""
- ins = [ "mem", "left", "right" ]
+ """returns the quotient of its 2 operands"""
+ ins = [
+ ("mem", "memory dependency"),
+ ("left", "first operand"),
+ ("right", "second operand"),
+ ]
outs = [
("M", "memory result", "pn_Generic_M"),
("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
("res", "result of computation", "pn_Generic_other"),
]
flags = [ "fragile", "uses_memory" ]
- attrs_name = "divmod"
+ attrs_name = "div"
attrs = [
dict(
- type = "ir_mode*",
- name = "resmode"
+ type = "ir_mode*",
+ name = "resmode",
+ comment = "mode of the result value",
),
dict(
name = "no_remainder",
init = "0",
)
]
- attr_struct = "divmod_attr"
- pinned = "exception"
- op_index = 1
- arity_override = "oparity_binary"
-
-class DivMod(Op):
- """divides its 2 operands and computes the remainder of the division"""
- ins = [ "mem", "left", "right" ]
- outs = [
- ("M", "memory result", "pn_Generic_M"),
- ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
- ("X_except", "control flow when exception occured", "pn_Generic_X_except"),
- ("res_div", "result of computation a/b", "pn_Generic_other"),
- ("res_mod", "result of computation a%b"),
- ]
- flags = [ "fragile", "uses_memory" ]
- attrs_name = "divmod"
- attrs = [
- dict(
- type = "ir_mode*",
- name = "resmode"
- ),
- ]
- attr_struct = "divmod_attr"
+ attr_struct = "div_attr"
pinned = "exception"
op_index = 1
arity_override = "oparity_binary"
class Free(Op):
"""Frees a block of memory previously allocated by an Alloc node"""
- ins = [ "mem", "ptr", "size" ]
+ ins = [
+ ("mem", "memory dependency" ),
+ ("ptr", "pointer to the object to free"),
+ ("size", "number of objects to allocate" ),
+ ]
mode = "mode_M"
flags = [ "uses_memory" ]
pinned = "yes"
attrs = [
dict(
- name = "type",
- type = "ir_type*"
+ name = "type",
+ type = "ir_type*",
+ comment = "type of the allocated variable",
),
dict(
- name = "where",
- type = "ir_where_alloc"
+ name = "where",
+ type = "ir_where_alloc",
+ comment = "whether allocation was on the stack or heap",
)
]
attr_struct = "free_attr"
class Id(Op):
"""Returns its operand unchanged."""
- ins = [ "pred" ]
+ ins = [
+ ("pred", "the value which is returned unchanged")
+ ]
pinned = "no"
flags = []
by the tuple results"""
mode = "mode_X"
pinned = "yes"
- ins = [ "target" ]
+ ins = [
+ ("target", "target address of the jump"),
+ ]
flags = [ "cfopcode", "forking", "keep" ]
class InstOf(Op):
- """Tests wether an object is an instance of a class-type"""
- ins = [ "store", "obj" ]
+ """Tests whether an object is an instance of a class-type"""
+ ins = [
+ ("store", "memory dependency"),
+ ("obj", "pointer to object being queried")
+ ]
outs = [
("M", "memory result", "pn_Generic_M"),
("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
flags = [ "highlevel" ]
attrs = [
dict(
- name = "type",
- type = "ir_type*"
+ name = "type",
+ type = "ir_type*",
+ comment = "type to check ptr for",
)
]
attr_struct = "io_attr"
class Load(Op):
"""Loads a value from memory (heap or stack)."""
- ins = [ "mem", "ptr" ]
+ ins = [
+ ("mem", "memory dependency"),
+ ("ptr", "address to load from"),
+ ]
outs = [
("M", "memory result", "pn_Generic_M"),
("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
]
flags = [ "fragile", "uses_memory" ]
pinned = "exception"
- pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
attrs = [
dict(
- type = "ir_mode*",
- name = "mode",
- java_name = "load_mode"
+ type = "ir_mode*",
+ name = "mode",
+ comment = "mode of the value to be loaded",
+ ),
+ dict(
+ type = "ir_volatility",
+ name = "volatility",
+ comment = "volatile loads are a visible side-effect and may not be optimized",
+ init = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
+ ),
+ dict(
+ type = "ir_align",
+ name = "unaligned",
+ comment = "pointers to unaligned loads don't need to respect the load-mode/type alignments",
+ init = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
),
]
attr_struct = "load_attr"
constructor_args = [
dict(
- type = "ir_cons_flags",
- name = "flags",
+ type = "ir_cons_flags",
+ name = "flags",
+ comment = "specifies alignment, volatility and pin state",
),
]
- init = '''
- res->attr.load.volatility = flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile;
- res->attr.load.aligned = flags & cons_unaligned ? align_non_aligned : align_is_aligned;
- '''
+ pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
class Minus(Unop):
"""returns the difference between its operands"""
* mod(-5,3) produces -2
* mod(-5,-3) produces -2
"""
- ins = [ "mem", "left", "right" ]
+ ins = [
+ ("mem", "memory dependency"),
+ ("left", "first operand"),
+ ("right", "second operand"),
+ ]
outs = [
("M", "memory result", "pn_Generic_M"),
("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
("res", "result of computation", "pn_Generic_other"),
]
flags = [ "fragile", "uses_memory" ]
- attrs_name = "divmod"
+ attrs_name = "mod"
attrs = [
dict(
- type = "ir_mode*",
- name = "resmode"
+ type = "ir_mode*",
+ name = "resmode",
+ comment = "mode of the result",
),
]
- attr_struct = "divmod_attr"
+ attr_struct = "mod_attr"
pinned = "exception"
op_index = 1
arity_override = "oparity_binary"
class Mux(Op):
"""returns the false or true operand depending on the value of the sel
operand"""
- ins = [ "sel", "false", "true" ]
+ ins = [
+ ("sel", "value making the output selection"),
+ ("false", "selected if sel input is false"),
+ ("true", "selected if sel input is true"),
+ ]
flags = []
pinned = "no"
"""Pin the value of the node node in the current block. No users of the Pin
node can float above the Block of the Pin. The node cannot float behind
this block. Often used to Pin the NoMem node."""
- ins = [ "op" ]
+ ins = [
+ ("op", "value which is pinned"),
+ ]
mode = "get_irn_mode(irn_op)"
flags = [ "highlevel" ]
pinned = "yes"
class Proj(Op):
"""returns an entry of a tuple value"""
- ins = [ "pred" ]
+ ins = [
+ ("pred", "the tuple value from which a part is extracted"),
+ ]
flags = []
pinned = "no"
knownBlock = True
customSerializer = True
attrs = [
dict(
- type = "long",
- name = "proj",
+ type = "long",
+ name = "proj",
+ comment = "number of tuple component to be extracted",
),
]
attr_struct = "proj_attr"
-class Quot(Op):
- """returns the quotient of its 2 operands, floatingpoint version"""
- ins = [ "mem", "left", "right" ]
- outs = [
- ("M", "memory result", "pn_Generic_M"),
- ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
- ("X_except", "control flow when exception occured", "pn_Generic_X_except"),
- ("res", "result of computation", "pn_Generic_other"),
- ]
- flags = [ "fragile", "uses_memory" ]
- attrs_name = "divmod"
- attrs = [
- dict(
- type = "ir_mode*",
- name = "resmode"
- ),
- ]
- attr_struct = "divmod_attr"
- pinned = "exception"
- op_index = 1
- arity_override = "oparity_binary"
-
class Raise(Op):
"""Raises an exception. Unconditional change of control flow. Writes an
explicit Except variable to memory to pass it to the exception handler.
Must be lowered to a Call to a runtime check function."""
- ins = [ "mem", "exo_ptr" ]
+ ins = [
+ ("mem", "memory dependency"),
+ ("exo_ptr", "pointer to exception object to be thrown"),
+ ]
outs = [
("M", "memory result", "pn_Generic_M"),
("X", "control flow to exception handler", "pn_Generic_X_regular"),
class Return(Op):
"""Returns from the current function. Takes memory and return values as
operands."""
- ins = [ "mem" ]
+ ins = [
+ ("mem", "memory dependency"),
+ ]
arity = "variable"
mode = "mode_X"
flags = [ "cfopcode" ]
class Sel(Op):
"""Computes the address of a entity of a compound type given the base
address of an instance of the compound type."""
- ins = [ "mem", "ptr" ]
+ ins = [
+ ("mem", "memory dependency"),
+ ("ptr", "pointer to object to select from"),
+ ]
arity = "variable"
flags = []
mode = "is_Method_type(get_entity_type(entity)) ? mode_P_code : mode_P_data"
pinned = "no"
attrs = [
dict(
- type = "ir_entity*",
- name = "entity"
+ type = "ir_entity*",
+ name = "entity",
+ comment = "entity which is selected",
)
]
attr_struct = "sel_attr"
("X_initial_exec", "control flow"),
("M", "initial memory"),
("P_frame_base", "frame base pointer"),
- ("P_tls", "pointer to thread local storage segment"),
("T_args", "function arguments")
]
mode = "mode_T"
class Store(Op):
"""Stores a value into memory (heap or stack)."""
- ins = [ "mem", "ptr", "value" ]
+ ins = [
+ ("mem", "memory dependency"),
+ ("ptr", "address to store to"),
+ ("value", "value to store"),
+ ]
outs = [
("M", "memory result", "pn_Generic_M"),
("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
pinned = "exception"
attr_struct = "store_attr"
pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
+ attrs = [
+ dict(
+ type = "ir_volatility",
+ name = "volatility",
+ comment = "volatile stores are a visible side-effect and may not be optimized",
+ init = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
+ ),
+ dict(
+ type = "ir_align",
+ name = "unaligned",
+ comment = "pointers to unaligned stores don't need to respect the load-mode/type alignments",
+ init = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
+ ),
+ ]
constructor_args = [
dict(
- type = "ir_cons_flags",
- name = "flags",
+ type = "ir_cons_flags",
+ name = "flags",
+ comment = "specifies alignment, volatility and pin state",
),
]
- init = '''
- res->attr.store.volatility = flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile;
- res->attr.store.aligned = flags & cons_unaligned ? align_non_aligned : align_is_aligned;
- '''
class Sub(Binop):
"""returns the difference of its operands"""
pinned = "no"
attrs = [
dict(
- type = "ir_entity*",
- name = "entity",
- noprop = True
+ type = "ir_entity*",
+ name = "entity",
+ noprop = True,
+ comment = "entity whose address is returned",
)
]
attr_struct = "symconst_attr"
following Proj nodes have not to be changed. (They are hard to find due to
the implementation with pointers in only one direction.) The Tuple node is
smaller than any other node, so that a node can be changed into a Tuple by
- just changing it's opcode and giving it a new in array."""
+ just changing its opcode and giving it a new in array."""
arity = "variable"
mode = "mode_T"
pinned = "no"
projects / libfirm / blobdiff