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)
126 flags = [ "keep", "uses_memory" ]
128 pinned_init = "op_pin_state_pinned"
129 attr_struct = "asm_attr"
131 customSerializer = True
133 ("mem", "memory dependency"),
137 name = "input_constraints",
138 type = "ir_asm_constraint*",
139 comment = "input constraints",
142 name = "n_output_constraints",
145 comment = "number of output constraints",
148 name = "output_constraints",
149 type = "ir_asm_constraint*",
150 comment = "output constraints",
156 comment = "number of clobbered registers/memory",
161 comment = "list of clobbered registers/memory",
166 comment = "assembler text",
169 # constructor is written manually at the moment, because of the clobbers+
170 # constraints arrays needing special handling (2 arguments for 1 attribute)
175 """Bad nodes indicate invalid input, which is values which should never be
178 The typical use case for the Bad node is removing unreachable code.
179 Frontends should set the current_block to Bad when it is clear that
180 following code must be unreachable (ie. after a goto or return statement).
181 Optimisations also set block predecessors to Bad when it becomes clear,
182 that a control flow edge can never be executed.
184 The gigo optimisations ensures that nodes with Bad as their block, get
185 replaced by Bad themselves. Nodes with at least 1 Bad input get exchanged
186 with Bad too. Exception to this rule are Block, Phi, Tuple and End node;
187 This is because removing inputs from a Block is hairy operation (requiring,
188 Phis to be shortened too for example). So instead of removing block inputs
189 they are set to Bad, and the actual removal is left to the control flow
190 optimisation phase. Block, Phi, Tuple with only Bad inputs however are
191 replaced by Bad right away."""
192 flags = [ "start_block", "dump_noblock" ]
195 block = "get_irg_start_block(irg)"
196 attr_struct = "bad_attr"
198 res->attr.bad.irg.irg = irg;
203 """Internal node which is temporary set to nodes which are already removed
209 customSerializer = True # this has no serializer
219 input_name = "cfgpred"
221 attr_struct = "block_attr"
226 comment = "entity representing this block",
230 customSerializer = True
233 res->attr.block.irg.irg = irg;
234 res->attr.block.backedge = new_backedge_arr(get_irg_obstack(irg), arity);
235 set_Block_matured(res, 1);
237 /* Create and initialize array for Phi-node construction. */
238 if (irg_is_constrained(irg, IR_GRAPH_CONSTRAINT_CONSTRUCTION)) {
239 res->attr.block.graph_arr = NEW_ARR_DZ(ir_node*, get_irg_obstack(irg), irg->n_loc);
245 """performs a backend-specific builtin."""
247 ("mem", "memory dependency"),
252 ("M", "memory result"),
253 # results follow here
255 flags = [ "uses_memory" ]
258 type = "ir_builtin_kind",
260 comment = "kind of builtin",
265 comment = "method type for the builtin call",
269 pinned_init = "op_pin_state_pinned"
270 attr_struct = "builtin_attr"
272 assert((get_unknown_type() == type) || is_Method_type(type));
277 """Calls other code. Control flow is transfered to ptr, additional
278 operands are passed to the called code. Called code usually performs a
279 return operation. The operands of this return operation are the result
282 ("mem", "memory dependency"),
283 ("ptr", "pointer to called code"),
288 ("M", "memory result"),
289 ("T_result", "tuple containing all results"),
290 ("X_regular", "control flow when no exception occurs"),
291 ("X_except", "control flow when exception occured"),
293 flags = [ "fragile", "uses_memory" ]
298 comment = "type of the call (usually type of the called procedure)",
301 attr_struct = "call_attr"
303 pinned_init = "op_pin_state_pinned"
304 throws_init = "false"
306 assert((get_unknown_type() == type) || is_Method_type(type));
311 """Compares its two operands and checks whether a specified
312 relation (like less or equal) is fulfilled."""
317 type = "ir_relation",
319 comment = "Comparison relation"
322 attr_struct = "cmp_attr"
326 """Conditionally change control flow."""
328 ("selector", "condition parameter"),
331 ("false", "control flow if operand is \"false\""),
332 ("true", "control flow if operand is \"true\""),
334 flags = [ "cfopcode", "forking" ]
339 type = "cond_jmp_predicate",
340 init = "COND_JMP_PRED_NONE",
341 comment = "can indicate the most likely jump",
344 attr_struct = "cond_attr"
348 """Change control flow. The destination is choosen based on an integer input value which is looked up in a table.
350 Backends can implement this efficiently using a jump table."""
352 ("selector", "input selector"),
355 ("default", "control flow if no other case matches"),
357 flags = [ "cfopcode", "forking" ]
363 comment = "number of outputs (including pn_Switch_default)",
367 type = "ir_switch_table*",
368 comment = "table describing mapping from input values to Proj numbers",
371 attr_struct = "switch_attr"
372 attrs_name = "switcha"
376 """Specifies constraints for a value. This allows explicit representation
377 of path-sensitive properties. (Example: This value is always >= 0 on 1
378 if-branch then all users within that branch are rerouted to a confirm-node
379 specifying this property).
381 A constraint is specified for the relation between value and bound.
382 value is always returned.
383 Note that this node does NOT check or assert the constraint, it merely
386 ("value", "value to express a constraint for"),
387 ("bound", "value to compare against"),
389 mode = "get_irn_mode(irn_value)"
390 flags = [ "highlevel" ]
395 type = "ir_relation",
396 comment = "relation of value to bound",
399 attr_struct = "confirm_attr"
403 """Returns a constant value."""
404 flags = [ "constlike", "start_block" ]
405 block = "get_irg_start_block(irg)"
406 mode = "get_tarval_mode(tarval)"
413 comment = "constant value (a tarval object)",
416 attr_struct = "const_attr"
421 """Converts values between modes"""
426 """Copies a block of memory with statically known size/type."""
428 ("mem", "memory dependency"),
429 ("dst", "destination address"),
430 ("src", "source address"),
433 ("M", "memory result"),
434 ("X_regular", "control flow when no exception occurs"),
435 ("X_except", "control flow when exception occured"),
437 flags = [ "fragile", "uses_memory" ]
442 comment = "type of copied data",
445 attr_struct = "copyb_attr"
447 pinned_init = "op_pin_state_pinned"
448 throws_init = "false"
452 """returns the quotient of its 2 operands"""
454 ("mem", "memory dependency"),
455 ("left", "first operand"),
456 ("right", "second operand"),
459 ("M", "memory result"),
460 ("res", "result of computation"),
461 ("X_regular", "control flow when no exception occurs"),
462 ("X_except", "control flow when exception occured"),
464 flags = [ "fragile", "uses_memory" ]
469 comment = "mode of the result value",
472 name = "no_remainder",
477 attr_struct = "div_attr"
479 throws_init = "false"
481 arity_override = "oparity_binary"
485 """A placeholder value. This is used when constructing cyclic graphs where
486 you have cases where not all predecessors of a phi-node are known. Dummy
487 nodes are used for the unknown predecessors and replaced later."""
489 flags = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
492 block = "get_irg_start_block(irg)"
496 """Last node of a graph. It references nodes in endless loops (so called
501 input_name = "keepalive"
502 flags = [ "cfopcode" ]
504 block = "get_irg_end_block(irg)"
509 """returns the result of a bitwise exclusive or operation of its operands.
511 This is also known as the Xor operation."""
512 flags = [ "commutative" ]
516 """Frees a block of memory previously allocated by an Alloc node"""
518 ("mem", "memory dependency" ),
519 ("ptr", "pointer to the object to free"),
520 ("count", "number of objects to allocate" ),
523 flags = [ "uses_memory" ]
529 comment = "type of the allocated variable",
533 type = "ir_where_alloc",
534 comment = "whether allocation was on the stack or heap",
537 attr_struct = "free_attr"
541 """Returns its operand unchanged.
543 This is mainly used when exchanging nodes. Usually you shouldn't see Id
544 nodes since the getters/setters for node inputs skip them automatically."""
546 ("pred", "the value which is returned unchanged")
553 """Jumps to the code in its argument. The code has to be in the same
554 function and the the destination must be one of the blocks reachable
555 by the tuple results"""
559 ("target", "target address of the jump"),
561 flags = [ "cfopcode", "forking", "keep", "unknown_jump" ]
565 """Tests whether an object is an instance of a class-type"""
567 ("store", "memory dependency"),
568 ("obj", "pointer to object being queried")
571 ("M", "memory result"),
572 ("res", "checked object pointer"),
573 ("X_regular", "control flow when no exception occurs"),
574 ("X_except", "control flow when exception occured"),
576 flags = [ "highlevel" ]
581 comment = "type to check ptr for",
584 attr_struct = "io_attr"
586 pinned_init = "op_pin_state_floats"
590 """Jumps to the block connected through the out-value"""
594 flags = [ "cfopcode" ]
598 """Loads a value from memory (heap or stack)."""
600 ("mem", "memory dependency"),
601 ("ptr", "address to load from"),
604 ("M", "memory result"),
605 ("res", "result of load operation"),
606 ("X_regular", "control flow when no exception occurs"),
607 ("X_except", "control flow when exception occured"),
609 flags = [ "fragile", "uses_memory" ]
615 comment = "mode of the value to be loaded",
618 type = "ir_volatility",
620 comment = "volatile loads are a visible side-effect and may not be optimized",
621 init = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
622 to_flags = "%s == volatility_is_volatile ? cons_volatile : cons_none"
627 comment = "pointers to unaligned loads don't need to respect the load-mode/type alignments",
628 init = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
629 to_flags = "%s == align_non_aligned ? cons_unaligned : cons_none"
632 attr_struct = "load_attr"
635 type = "ir_cons_flags",
637 comment = "specifies alignment, volatility and pin state",
640 pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
641 throws_init = "(flags & cons_throws_exception) != 0"
645 """returns the additive inverse of its operand"""
650 """returns the remainder of its operands from an implied division.
654 * mod(5,3) produces 2
655 * mod(5,-3) produces 2
656 * mod(-5,3) produces -2
657 * mod(-5,-3) produces -2
660 ("mem", "memory dependency"),
661 ("left", "first operand"),
662 ("right", "second operand"),
665 ("M", "memory result"),
666 ("res", "result of computation"),
667 ("X_regular", "control flow when no exception occurs"),
668 ("X_except", "control flow when exception occured"),
670 flags = [ "fragile", "uses_memory" ]
675 comment = "mode of the result",
678 attr_struct = "mod_attr"
680 throws_init = "false"
682 arity_override = "oparity_binary"
685 """returns the product of its operands"""
686 flags = [ "commutative" ]
689 """returns the upper word of the product of its operands (the part which
690 would not fit into the result mode of a normal Mul anymore)"""
691 flags = [ "commutative" ]
695 """returns the false or true operand depending on the value of the sel
698 ("sel", "value making the output selection"),
699 ("false", "selected if sel input is false"),
700 ("true", "selected if sel input is true"),
707 """Placeholder node for cases where you don't need any memory input"""
709 flags = [ "dump_noblock" ]
712 block = "get_irg_start_block(irg)"
717 """returns the bitwise complement of a value. Works for boolean values, too."""
722 """returns the result of a bitwise or operation of its operands"""
723 flags = [ "commutative" ]
727 """Choose a value based on control flow. A phi node has 1 input for each
728 predecessor of its block. If a block is entered from its nth predecessor
729 all phi nodes produce their nth input as result."""
734 attr_struct = "phi_attr"
736 res->attr.phi.u.backedge = new_backedge_arr(get_irg_obstack(irg), arity);'''
737 customSerializer = True
741 """Pin the value of the node node in the current block. No users of the Pin
742 node can float above the Block of the Pin. The node cannot float behind
743 this block. Often used to Pin the NoMem node."""
745 ("op", "value which is pinned"),
747 mode = "get_irn_mode(irn_op)"
748 flags = [ "highlevel" ]
753 """returns an entry of a tuple value"""
755 ("pred", "the tuple value from which a part is extracted"),
761 block = "get_nodes_block(irn_pred)"
762 graph = "get_irn_irg(irn_pred)"
767 comment = "number of tuple component to be extracted",
770 attr_struct = "proj_attr"
774 """Raises an exception. Unconditional change of control flow. Writes an
775 explicit Except variable to memory to pass it to the exception handler.
776 Must be lowered to a Call to a runtime check function."""
778 ("mem", "memory dependency"),
779 ("exo_ptr", "pointer to exception object to be thrown"),
782 ("M", "memory result"),
783 ("X", "control flow to exception handler"),
785 flags = [ "highlevel", "cfopcode" ]
790 """Returns from the current function. Takes memory and return values as
793 ("mem", "memory dependency"),
798 flags = [ "cfopcode" ]
802 """Returns its first operand bits rotated left by the amount in the 2nd
808 """Computes the address of a entity of a compound type given the base
809 address of an instance of the compound type.
811 Optimisations assume that a Sel node can only produce a NULL pointer if the
812 ptr input was NULL."""
814 ("mem", "memory dependency"),
815 ("ptr", "pointer to object to select from"),
820 mode = "is_Method_type(get_entity_type(entity)) ? mode_P_code : mode_P_data"
826 comment = "entity which is selected",
829 attr_struct = "sel_attr"
833 """Returns its first operands bits shifted left by the amount of the 2nd
835 The right input (shift amount) must be an unsigned integer value.
836 If the result mode has modulo_shift!=0, then the effective shift amount is
837 the right input modulo this modulo_shift amount."""
842 """Returns its first operands bits shifted right by the amount of the 2nd
843 operand. No special handling for the sign bit is performed (zero extension).
844 The right input (shift amount) must be an unsigned integer value.
845 If the result mode has modulo_shift!=0, then the effective shift amount is
846 the right input modulo this modulo_shift amount."""
851 """Returns its first operands bits shifted right by the amount of the 2nd
852 operand. The leftmost bit (usually the sign bit) stays the same
854 The right input (shift amount) must be an unsigned integer value.
855 If the result mode has modulo_shift!=0, then the effective shift amount is
856 the right input modulo this modulo_shift amount."""
861 """The first node of a graph. Execution starts with this node."""
863 ("X_initial_exec", "control flow"),
864 ("M", "initial memory"),
865 ("P_frame_base", "frame base pointer"),
866 ("T_args", "function arguments")
870 flags = [ "cfopcode" ]
873 block = "get_irg_start_block(irg)"
877 """Stores a value into memory (heap or stack)."""
879 ("mem", "memory dependency"),
880 ("ptr", "address to store to"),
881 ("value", "value to store"),
884 ("M", "memory result"),
885 ("X_regular", "control flow when no exception occurs"),
886 ("X_except", "control flow when exception occured"),
888 flags = [ "fragile", "uses_memory" ]
890 attr_struct = "store_attr"
891 pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
892 throws_init = "(flags & cons_throws_exception) != 0"
895 type = "ir_volatility",
897 comment = "volatile stores are a visible side-effect and may not be optimized",
898 init = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
899 to_flags = "%s == volatility_is_volatile ? cons_volatile : cons_none"
904 comment = "pointers to unaligned stores don't need to respect the load-mode/type alignments",
905 init = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
906 to_flags = "%s == align_non_aligned ? cons_unaligned : cons_none"
911 type = "ir_cons_flags",
913 comment = "specifies alignment, volatility and pin state",
919 """returns the difference of its operands"""
924 """A symbolic constant.
926 - *symconst_type_size* The symbolic constant represents the size of a type.
927 The type of which the constant represents the size
929 - *symconst_type_align* The symbolic constant represents the alignment of a
930 type. The type of which the constant represents the
931 size is given explicitly.
932 - *symconst_addr_ent* The symbolic constant represents the address of an
933 entity (variable or method). The variable is given
934 explicitly by a firm entity.
935 - *symconst_ofs_ent* The symbolic constant represents the offset of an
936 entity in its owner type.
937 - *symconst_enum_const* The symbolic constant is a enumeration constant of
938 an enumeration type."""
940 flags = [ "constlike", "start_block" ]
948 comment = "entity whose address is returned",
951 attr_struct = "symconst_attr"
952 customSerializer = True
953 # constructor is written manually at the moment, because of the strange
959 """The Sync operation unifies several partial memory blocks. These blocks
960 have to be pairwise disjunct or the values in common locations have to
961 be identical. This operation allows to specify all operations that
962 eventually need several partial memory blocks as input with a single
963 entrance by unifying the memories with a preceding Sync operation."""
972 """Builds a Tuple from single values.
974 This is needed to implement optimizations that remove a node that produced
975 a tuple. The node can be replaced by the Tuple operation so that the
976 following Proj nodes have not to be changed. (They are hard to find due to
977 the implementation with pointers in only one direction.) The Tuple node is
978 smaller than any other node, so that a node can be changed into a Tuple by
979 just changing its opcode and giving it a new in array."""
988 """Returns an unknown (at compile- and runtime) value. It is a valid
989 optimisation to replace an Unknown by any other constant value."""
992 block = "get_irg_start_block(irg)"
993 flags = [ "start_block", "constlike", "dump_noblock" ]