1 # Firm node specifications
2 # The comments are in (standard python) restructured text format and are used
3 # to generate documentation.
4 from spec_util import abstract, op
11 """Unary nodes have exactly 1 input"""
22 """Binary nodes have exactly 2 inputs"""
25 ( "left", "first operand" ),
26 ( "right", "second operand" ),
33 """returns the sum of its operands"""
34 flags = [ "commutative" ]
38 """allocates a block of memory.
39 It can be specified whether the memory should be allocated to the stack
41 Allocates memory for one or more objects (depending on value on count input).
44 ("mem", "memory dependency" ),
45 ("count", "number of objects to allocate" ),
48 ("M", "memory result"),
49 ("res", "pointer to newly allocated memory"),
50 ("X_regular", "control flow when no exception occurs"),
51 ("X_except", "control flow when exception occured"),
57 comment = "type of the objects to allocate",
61 type = "ir_where_alloc",
62 comment = "whether to allocate the variable on the stack or heap",
65 flags = [ "fragile", "uses_memory" ]
68 pinned_init = "op_pin_state_pinned"
69 attr_struct = "alloc_attr"
73 """utiliy node used to "hold" nodes in a graph that might possibly not be
74 reachable by other means or which should be reachable immediately without
75 searching through the graph.
76 Each firm-graph contains exactly one anchor node whose address is always
77 known. All other well-known graph-nodes like Start, End, NoMem, Bad, ...
78 are found by looking at the respective Anchor operand."""
81 flags = [ "dump_noblock" ]
83 attr_struct = "irg_attr"
87 customSerializer = True
91 """returns the result of a bitwise and operation of its operands"""
92 flags = [ "commutative" ]
96 """executes assembler fragments of the target machine.
98 The node contains a template for an assembler snippet. The compiler will
99 replace occurences of %0 to %9 with input/output registers,
100 %% with a single % char. Some backends allow additional specifiers (for
101 example %w3, %l3, %h3 on x86 to get a 16bit, 8hit low, 8bit high part
103 After the replacements the text is emitted into the final assembly.
105 The clobber list contains names of registers which have an undefined value
106 after the assembler instruction is executed; it may also contain 'memory'
107 or 'cc' if global state/memory changes or the condition code registers
108 (some backends implicitely set cc, memory clobbers on all ASM statements).
110 Example (an i386 instruction)::
112 ASM(text="btsl %1, %0",
113 input_constraints = ["=m", "r"],
116 As there are no output, the %0 references the first input which is just an
117 address which the asm operation writes to. %1 references to an input which
118 is passed as a register. The condition code register has an unknown value
119 after the instruction.
121 (This format is inspired by the gcc extended asm syntax)
125 flags = [ "keep", "uses_memory" ]
127 pinned_init = "op_pin_state_pinned"
128 attr_struct = "asm_attr"
130 customSerializer = True
132 ("mem", "memory dependency"),
136 name = "input_constraints",
137 type = "ir_asm_constraint*",
138 comment = "input constraints",
141 name = "n_output_constraints",
144 comment = "number of output constraints",
147 name = "output_constraints",
148 type = "ir_asm_constraint*",
149 comment = "output constraints",
155 comment = "number of clobbered registers/memory",
160 comment = "list of clobbered registers/memory",
165 comment = "assembler text",
168 # constructor is written manually at the moment, because of the clobbers+
169 # constraints arrays needing special handling (2 arguments for 1 attribute)
174 """Bad nodes indicate invalid input, which is values which should never be
177 The typical use case for the Bad node is removing unreachable code.
178 Frontends should set the current_block to Bad when it is clear that
179 following code must be unreachable (ie. after a goto or return statement).
180 Optimisations also set block predecessors to Bad when it becomes clear,
181 that a control flow edge can never be executed.
183 The gigo optimisations ensures that nodes with Bad as their block, get
184 replaced by Bad themselves. Nodes with at least 1 Bad input get exchanged
185 with Bad too. Exception to this rule are Block, Phi, Tuple and End node;
186 This is because removing inputs from a Block is hairy operation (requiring,
187 Phis to be shortened too for example). So instead of removing block inputs
188 they are set to Bad, and the actual removal is left to the control flow
189 optimisation phase. Block, Phi, Tuple with only Bad inputs however are
190 replaced by Bad right away."""
191 flags = [ "start_block", "dump_noblock" ]
194 block = "get_irg_start_block(irg)"
195 attr_struct = "bad_attr"
197 res->attr.bad.irg.irg = irg;
202 """Internal node which is temporary set to nodes which are already removed
208 customSerializer = True # this has no serializer
219 attr_struct = "block_attr"
224 comment = "entity representing this block",
228 customSerializer = True
231 res->attr.block.irg.irg = irg;
232 res->attr.block.backedge = new_backedge_arr(get_irg_obstack(irg), arity);
233 set_Block_matured(res, 1);
235 /* Create and initialize array for Phi-node construction. */
236 if (irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_CONSTRUCTION)) {
237 res->attr.block.graph_arr = NEW_ARR_DZ(ir_node*, get_irg_obstack(irg), irg->n_loc);
243 """Returns the borrow bit from and implied subtractions of its 2 operands"""
248 """Performs a bounds-check: if lower <= index < upper then return index,
249 otherwise throw an exception."""
251 ("mem", "memory dependency"),
252 ("index", "value to test"),
253 ("lower", "lower bound (inclusive)"),
254 ("upper", "upper bound (exclusive)"),
257 ("M", "memory result"),
258 ("res", "the checked index"),
259 ("X_regular", "control flow when no exception occurs"),
260 ("X_except", "control flow when exception occured"),
262 flags = [ "fragile", "highlevel" ]
264 pinned_init = "op_pin_state_pinned"
265 throws_init = "false"
266 attr_struct = "bound_attr"
270 """performs a backend-specific builtin."""
272 ("mem", "memory dependency"),
276 ("M", "memory result"),
277 # results follow here
279 flags = [ "uses_memory" ]
282 type = "ir_builtin_kind",
284 comment = "kind of builtin",
289 comment = "method type for the builtin call",
293 pinned_init = "op_pin_state_pinned"
294 attr_struct = "builtin_attr"
296 assert((get_unknown_type() == type) || is_Method_type(type));
301 """Calls other code. Control flow is transfered to ptr, additional
302 operands are passed to the called code. Called code usually performs a
303 return operation. The operands of this return operation are the result
306 ("mem", "memory dependency"),
307 ("ptr", "pointer to called code"),
311 ("M", "memory result"),
312 ("T_result", "tuple containing all results"),
313 ("X_regular", "control flow when no exception occurs"),
314 ("X_except", "control flow when exception occured"),
316 flags = [ "fragile", "uses_memory" ]
321 comment = "type of the call (usually type of the called procedure)",
324 attr_struct = "call_attr"
326 pinned_init = "op_pin_state_pinned"
327 throws_init = "false"
329 assert((get_unknown_type() == type) || is_Method_type(type));
334 """Computes the value of the carry-bit that would result when adding the 2
336 flags = [ "commutative" ]
340 """perform a high-level type cast"""
341 mode = "get_irn_mode(irn_op)"
342 flags = [ "highlevel" ]
347 comment = "target type of the case",
350 attr_struct = "cast_attr"
351 init = "assert(is_atomic_type(type));"
355 """Compares its two operands and checks whether a specified
356 relation (like less or equal) is fulfilled."""
361 type = "ir_relation",
363 comment = "Comparison relation"
366 attr_struct = "cmp_attr"
370 """Conditionally change control flow."""
372 ("selector", "condition parameter"),
375 ("false", "control flow if operand is \"false\""),
376 ("true", "control flow if operand is \"true\""),
378 flags = [ "cfopcode", "forking" ]
383 type = "cond_jmp_predicate",
384 init = "COND_JMP_PRED_NONE",
385 comment = "can indicate the most likely jump",
388 attr_struct = "cond_attr"
392 """Change control flow. The destination is choosen based on an integer input value which is looked up in a table.
394 Backends can implement this efficiently using a jump table."""
396 ("selector", "input selector"),
399 ("default", "control flow if no other case matches"),
401 flags = [ "cfopcode", "forking" ]
407 comment = "number of outputs (including pn_Switch_default)",
411 type = "ir_switch_table*",
412 comment = "table describing mapping from input values to Proj numbers",
415 attr_struct = "switch_attr"
416 attrs_name = "switcha"
420 """Specifies constraints for a value. This allows explicit representation
421 of path-sensitive properties. (Example: This value is always >= 0 on 1
422 if-branch then all users within that branch are rerouted to a confirm-node
423 specifying this property).
425 A constraint is specified for the relation between value and bound.
426 value is always returned.
427 Note that this node does NOT check or assert the constraint, it merely
430 ("value", "value to express a constraint for"),
431 ("bound", "value to compare against"),
433 mode = "get_irn_mode(irn_value)"
434 flags = [ "highlevel" ]
439 type = "ir_relation",
440 comment = "relation of value to bound",
443 attr_struct = "confirm_attr"
447 """Returns a constant value."""
448 flags = [ "constlike", "start_block" ]
449 block = "get_irg_start_block(irg)"
450 mode = "get_tarval_mode(tarval)"
457 comment = "constant value (a tarval object)",
460 attr_struct = "const_attr"
465 """Converts values between modes"""
470 """Copies a block of memory with statically known size/type."""
472 ("mem", "memory dependency"),
473 ("dst", "destination address"),
474 ("src", "source address"),
477 ("M", "memory result"),
478 ("X_regular", "control flow when no exception occurs"),
479 ("X_except", "control flow when exception occured"),
481 flags = [ "fragile", "uses_memory" ]
486 comment = "type of copied data",
489 attr_struct = "copyb_attr"
491 pinned_init = "op_pin_state_pinned"
492 throws_init = "false"
496 """returns the quotient of its 2 operands"""
498 ("mem", "memory dependency"),
499 ("left", "first operand"),
500 ("right", "second operand"),
503 ("M", "memory result"),
504 ("res", "result of computation"),
505 ("X_regular", "control flow when no exception occurs"),
506 ("X_except", "control flow when exception occured"),
508 flags = [ "fragile", "uses_memory" ]
513 comment = "mode of the result value",
516 name = "no_remainder",
521 attr_struct = "div_attr"
523 throws_init = "false"
525 arity_override = "oparity_binary"
529 """A placeholder value. This is used when constructing cyclic graphs where
530 you have cases where not all predecessors of a phi-node are known. Dummy
531 nodes are used for the unknown predecessors and replaced later."""
533 flags = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
536 block = "get_irg_start_block(irg)"
540 """Last node of a graph. It references nodes in endless loops (so called
545 flags = [ "cfopcode" ]
547 block = "get_irg_end_block(irg)"
552 """returns the result of a bitwise exclusive or operation of its operands.
554 This is also known as the Xor operation."""
555 flags = [ "commutative" ]
559 """Frees a block of memory previously allocated by an Alloc node"""
561 ("mem", "memory dependency" ),
562 ("ptr", "pointer to the object to free"),
563 ("count", "number of objects to allocate" ),
566 flags = [ "uses_memory" ]
572 comment = "type of the allocated variable",
576 type = "ir_where_alloc",
577 comment = "whether allocation was on the stack or heap",
580 attr_struct = "free_attr"
584 """Returns its operand unchanged.
586 This is mainly used when exchanging nodes. Usually you shouldn't see Id
587 nodes since the getters/setters for node inputs skip them automatically."""
589 ("pred", "the value which is returned unchanged")
596 """Jumps to the code in its argument. The code has to be in the same
597 function and the the destination must be one of the blocks reachable
598 by the tuple results"""
602 ("target", "target address of the jump"),
604 flags = [ "cfopcode", "forking", "keep", "unknown_jump" ]
608 """Tests whether an object is an instance of a class-type"""
610 ("store", "memory dependency"),
611 ("obj", "pointer to object being queried")
614 ("M", "memory result"),
615 ("res", "checked object pointer"),
616 ("X_regular", "control flow when no exception occurs"),
617 ("X_except", "control flow when exception occured"),
619 flags = [ "highlevel" ]
624 comment = "type to check ptr for",
627 attr_struct = "io_attr"
629 pinned_init = "op_pin_state_floats"
633 """Jumps to the block connected through the out-value"""
637 flags = [ "cfopcode" ]
641 """Loads a value from memory (heap or stack)."""
643 ("mem", "memory dependency"),
644 ("ptr", "address to load from"),
647 ("M", "memory result"),
648 ("res", "result of load operation"),
649 ("X_regular", "control flow when no exception occurs"),
650 ("X_except", "control flow when exception occured"),
652 flags = [ "fragile", "uses_memory" ]
658 comment = "mode of the value to be loaded",
661 type = "ir_volatility",
663 comment = "volatile loads are a visible side-effect and may not be optimized",
664 init = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
665 to_flags = "%s == volatility_is_volatile ? cons_volatile : cons_none"
670 comment = "pointers to unaligned loads don't need to respect the load-mode/type alignments",
671 init = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
672 to_flags = "%s == align_non_aligned ? cons_unaligned : cons_none"
675 attr_struct = "load_attr"
678 type = "ir_cons_flags",
680 comment = "specifies alignment, volatility and pin state",
683 pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
684 throws_init = "(flags & cons_throws_exception) != 0"
688 """returns the additive inverse of its operand"""
693 """returns the remainder of its operands from an implied division.
697 * mod(5,3) produces 2
698 * mod(5,-3) produces 2
699 * mod(-5,3) produces -2
700 * mod(-5,-3) produces -2
703 ("mem", "memory dependency"),
704 ("left", "first operand"),
705 ("right", "second operand"),
708 ("M", "memory result"),
709 ("res", "result of computation"),
710 ("X_regular", "control flow when no exception occurs"),
711 ("X_except", "control flow when exception occured"),
713 flags = [ "fragile", "uses_memory" ]
718 comment = "mode of the result",
721 attr_struct = "mod_attr"
723 throws_init = "false"
725 arity_override = "oparity_binary"
728 """returns the product of its operands"""
729 flags = [ "commutative" ]
732 """returns the upper word of the product of its operands (the part which
733 would not fit into the result mode of a normal Mul anymore)"""
734 flags = [ "commutative" ]
738 """returns the false or true operand depending on the value of the sel
741 ("sel", "value making the output selection"),
742 ("false", "selected if sel input is false"),
743 ("true", "selected if sel input is true"),
750 """Placeholder node for cases where you don't need any memory input"""
752 flags = [ "dump_noblock" ]
755 block = "get_irg_start_block(irg)"
760 """returns the bitwise complement of a value. Works for boolean values, too."""
765 """returns the result of a bitwise or operation of its operands"""
766 flags = [ "commutative" ]
770 """Choose a value based on control flow. A phi node has 1 input for each
771 predecessor of its block. If a block is entered from its nth predecessor
772 all phi nodes produce their nth input as result."""
776 attr_struct = "phi_attr"
778 res->attr.phi.u.backedge = new_backedge_arr(get_irg_obstack(irg), arity);'''
779 customSerializer = True
783 """Pin the value of the node node in the current block. No users of the Pin
784 node can float above the Block of the Pin. The node cannot float behind
785 this block. Often used to Pin the NoMem node."""
787 ("op", "value which is pinned"),
789 mode = "get_irn_mode(irn_op)"
790 flags = [ "highlevel" ]
795 """returns an entry of a tuple value"""
797 ("pred", "the tuple value from which a part is extracted"),
803 block = "get_nodes_block(irn_pred)"
804 graph = "get_irn_irg(irn_pred)"
809 comment = "number of tuple component to be extracted",
812 attr_struct = "proj_attr"
816 """Raises an exception. Unconditional change of control flow. Writes an
817 explicit Except variable to memory to pass it to the exception handler.
818 Must be lowered to a Call to a runtime check function."""
820 ("mem", "memory dependency"),
821 ("exo_ptr", "pointer to exception object to be thrown"),
824 ("M", "memory result"),
825 ("X", "control flow to exception handler"),
827 flags = [ "highlevel", "cfopcode" ]
832 """Returns from the current function. Takes memory and return values as
835 ("mem", "memory dependency"),
839 flags = [ "cfopcode" ]
843 """Returns its first operand bits rotated left by the amount in the 2nd
849 """Computes the address of a entity of a compound type given the base
850 address of an instance of the compound type.
852 Optimisations assume that a Sel node can only produce a NULL pointer if the
853 ptr input was NULL."""
855 ("mem", "memory dependency"),
856 ("ptr", "pointer to object to select from"),
860 mode = "is_Method_type(get_entity_type(entity)) ? mode_P_code : mode_P_data"
866 comment = "entity which is selected",
869 attr_struct = "sel_attr"
873 """Returns its first operands bits shifted left by the amount of the 2nd
875 The right input (shift amount) must be an unsigned integer value.
876 If the result mode has modulo_shift!=0, then the effective shift amount is
877 the right input modulo this modulo_shift amount."""
882 """Returns its first operands bits shifted right by the amount of the 2nd
883 operand. No special handling for the sign bit is performed (zero extension).
884 The right input (shift amount) must be an unsigned integer value.
885 If the result mode has modulo_shift!=0, then the effective shift amount is
886 the right input modulo this modulo_shift amount."""
891 """Returns its first operands bits shifted right by the amount of the 2nd
892 operand. The leftmost bit (usually the sign bit) stays the same
894 The right input (shift amount) must be an unsigned integer value.
895 If the result mode has modulo_shift!=0, then the effective shift amount is
896 the right input modulo this modulo_shift amount."""
901 """The first node of a graph. Execution starts with this node."""
903 ("X_initial_exec", "control flow"),
904 ("M", "initial memory"),
905 ("P_frame_base", "frame base pointer"),
906 ("T_args", "function arguments")
910 flags = [ "cfopcode" ]
913 block = "get_irg_start_block(irg)"
917 """Stores a value into memory (heap or stack)."""
919 ("mem", "memory dependency"),
920 ("ptr", "address to store to"),
921 ("value", "value to store"),
924 ("M", "memory result"),
925 ("X_regular", "control flow when no exception occurs"),
926 ("X_except", "control flow when exception occured"),
928 flags = [ "fragile", "uses_memory" ]
930 attr_struct = "store_attr"
931 pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
932 throws_init = "(flags & cons_throws_exception) != 0"
935 type = "ir_volatility",
937 comment = "volatile stores are a visible side-effect and may not be optimized",
938 init = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
939 to_flags = "%s == volatility_is_volatile ? cons_volatile : cons_none"
944 comment = "pointers to unaligned stores don't need to respect the load-mode/type alignments",
945 init = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
946 to_flags = "%s == align_non_aligned ? cons_unaligned : cons_none"
951 type = "ir_cons_flags",
953 comment = "specifies alignment, volatility and pin state",
959 """returns the difference of its operands"""
964 """A symbolic constant.
966 - *symconst_type_size* The symbolic constant represents the size of a type.
967 The type of which the constant represents the size
969 - *symconst_type_align* The symbolic constant represents the alignment of a
970 type. The type of which the constant represents the
971 size is given explicitly.
972 - *symconst_addr_ent* The symbolic constant represents the address of an
973 entity (variable or method). The variable is given
974 explicitly by a firm entity.
975 - *symconst_ofs_ent* The symbolic constant represents the offset of an
976 entity in its owner type.
977 - *symconst_enum_const* The symbolic constant is a enumeration constant of
978 an enumeration type."""
980 flags = [ "constlike", "start_block" ]
988 comment = "entity whose address is returned",
991 attr_struct = "symconst_attr"
992 customSerializer = True
993 # constructor is written manually at the moment, because of the strange
999 """The Sync operation unifies several partial memory blocks. These blocks
1000 have to be pairwise disjunct or the values in common locations have to
1001 be identical. This operation allows to specify all operations that
1002 eventually need several partial memory blocks as input with a single
1003 entrance by unifying the memories with a preceding Sync operation."""
1011 """Builds a Tuple from single values.
1013 This is needed to implement optimizations that remove a node that produced
1014 a tuple. The node can be replaced by the Tuple operation so that the
1015 following Proj nodes have not to be changed. (They are hard to find due to
1016 the implementation with pointers in only one direction.) The Tuple node is
1017 smaller than any other node, so that a node can be changed into a Tuple by
1018 just changing its opcode and giving it a new in array."""
1026 """Returns an unknown (at compile- and runtime) value. It is a valid
1027 optimisation to replace an Unknown by any other constant value."""
1030 block = "get_irg_start_block(irg)"
1031 flags = [ "start_block", "constlike", "dump_noblock" ]