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 """perform a high-level type cast"""
312 mode = "get_irn_mode(irn_op)"
313 flags = [ "highlevel" ]
318 comment = "target type of the case",
321 attr_struct = "cast_attr"
322 init = "assert(is_atomic_type(type));"
326 """Compares its two operands and checks whether a specified
327 relation (like less or equal) is fulfilled."""
332 type = "ir_relation",
334 comment = "Comparison relation"
337 attr_struct = "cmp_attr"
341 """Conditionally change control flow."""
343 ("selector", "condition parameter"),
346 ("false", "control flow if operand is \"false\""),
347 ("true", "control flow if operand is \"true\""),
349 flags = [ "cfopcode", "forking" ]
354 type = "cond_jmp_predicate",
355 init = "COND_JMP_PRED_NONE",
356 comment = "can indicate the most likely jump",
359 attr_struct = "cond_attr"
363 """Change control flow. The destination is choosen based on an integer input value which is looked up in a table.
365 Backends can implement this efficiently using a jump table."""
367 ("selector", "input selector"),
370 ("default", "control flow if no other case matches"),
372 flags = [ "cfopcode", "forking" ]
378 comment = "number of outputs (including pn_Switch_default)",
382 type = "ir_switch_table*",
383 comment = "table describing mapping from input values to Proj numbers",
386 attr_struct = "switch_attr"
387 attrs_name = "switcha"
391 """Specifies constraints for a value. This allows explicit representation
392 of path-sensitive properties. (Example: This value is always >= 0 on 1
393 if-branch then all users within that branch are rerouted to a confirm-node
394 specifying this property).
396 A constraint is specified for the relation between value and bound.
397 value is always returned.
398 Note that this node does NOT check or assert the constraint, it merely
401 ("value", "value to express a constraint for"),
402 ("bound", "value to compare against"),
404 mode = "get_irn_mode(irn_value)"
405 flags = [ "highlevel" ]
410 type = "ir_relation",
411 comment = "relation of value to bound",
414 attr_struct = "confirm_attr"
418 """Returns a constant value."""
419 flags = [ "constlike", "start_block" ]
420 block = "get_irg_start_block(irg)"
421 mode = "get_tarval_mode(tarval)"
428 comment = "constant value (a tarval object)",
431 attr_struct = "const_attr"
436 """Converts values between modes"""
441 """Copies a block of memory with statically known size/type."""
443 ("mem", "memory dependency"),
444 ("dst", "destination address"),
445 ("src", "source address"),
448 ("M", "memory result"),
449 ("X_regular", "control flow when no exception occurs"),
450 ("X_except", "control flow when exception occured"),
452 flags = [ "fragile", "uses_memory" ]
457 comment = "type of copied data",
460 attr_struct = "copyb_attr"
462 pinned_init = "op_pin_state_pinned"
463 throws_init = "false"
467 """returns the quotient of its 2 operands"""
469 ("mem", "memory dependency"),
470 ("left", "first operand"),
471 ("right", "second operand"),
474 ("M", "memory result"),
475 ("res", "result of computation"),
476 ("X_regular", "control flow when no exception occurs"),
477 ("X_except", "control flow when exception occured"),
479 flags = [ "fragile", "uses_memory" ]
484 comment = "mode of the result value",
487 name = "no_remainder",
492 attr_struct = "div_attr"
494 throws_init = "false"
496 arity_override = "oparity_binary"
500 """A placeholder value. This is used when constructing cyclic graphs where
501 you have cases where not all predecessors of a phi-node are known. Dummy
502 nodes are used for the unknown predecessors and replaced later."""
504 flags = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
507 block = "get_irg_start_block(irg)"
511 """Last node of a graph. It references nodes in endless loops (so called
516 input_name = "keepalive"
517 flags = [ "cfopcode" ]
519 block = "get_irg_end_block(irg)"
524 """returns the result of a bitwise exclusive or operation of its operands.
526 This is also known as the Xor operation."""
527 flags = [ "commutative" ]
531 """Frees a block of memory previously allocated by an Alloc node"""
533 ("mem", "memory dependency" ),
534 ("ptr", "pointer to the object to free"),
535 ("count", "number of objects to allocate" ),
538 flags = [ "uses_memory" ]
544 comment = "type of the allocated variable",
548 type = "ir_where_alloc",
549 comment = "whether allocation was on the stack or heap",
552 attr_struct = "free_attr"
556 """Returns its operand unchanged.
558 This is mainly used when exchanging nodes. Usually you shouldn't see Id
559 nodes since the getters/setters for node inputs skip them automatically."""
561 ("pred", "the value which is returned unchanged")
568 """Jumps to the code in its argument. The code has to be in the same
569 function and the the destination must be one of the blocks reachable
570 by the tuple results"""
574 ("target", "target address of the jump"),
576 flags = [ "cfopcode", "forking", "keep", "unknown_jump" ]
580 """Tests whether an object is an instance of a class-type"""
582 ("store", "memory dependency"),
583 ("obj", "pointer to object being queried")
586 ("M", "memory result"),
587 ("res", "checked object pointer"),
588 ("X_regular", "control flow when no exception occurs"),
589 ("X_except", "control flow when exception occured"),
591 flags = [ "highlevel" ]
596 comment = "type to check ptr for",
599 attr_struct = "io_attr"
601 pinned_init = "op_pin_state_floats"
605 """Jumps to the block connected through the out-value"""
609 flags = [ "cfopcode" ]
613 """Loads a value from memory (heap or stack)."""
615 ("mem", "memory dependency"),
616 ("ptr", "address to load from"),
619 ("M", "memory result"),
620 ("res", "result of load operation"),
621 ("X_regular", "control flow when no exception occurs"),
622 ("X_except", "control flow when exception occured"),
624 flags = [ "fragile", "uses_memory" ]
630 comment = "mode of the value to be loaded",
633 type = "ir_volatility",
635 comment = "volatile loads are a visible side-effect and may not be optimized",
636 init = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
637 to_flags = "%s == volatility_is_volatile ? cons_volatile : cons_none"
642 comment = "pointers to unaligned loads don't need to respect the load-mode/type alignments",
643 init = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
644 to_flags = "%s == align_non_aligned ? cons_unaligned : cons_none"
647 attr_struct = "load_attr"
650 type = "ir_cons_flags",
652 comment = "specifies alignment, volatility and pin state",
655 pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
656 throws_init = "(flags & cons_throws_exception) != 0"
660 """returns the additive inverse of its operand"""
665 """returns the remainder of its operands from an implied division.
669 * mod(5,3) produces 2
670 * mod(5,-3) produces 2
671 * mod(-5,3) produces -2
672 * mod(-5,-3) produces -2
675 ("mem", "memory dependency"),
676 ("left", "first operand"),
677 ("right", "second operand"),
680 ("M", "memory result"),
681 ("res", "result of computation"),
682 ("X_regular", "control flow when no exception occurs"),
683 ("X_except", "control flow when exception occured"),
685 flags = [ "fragile", "uses_memory" ]
690 comment = "mode of the result",
693 attr_struct = "mod_attr"
695 throws_init = "false"
697 arity_override = "oparity_binary"
700 """returns the product of its operands"""
701 flags = [ "commutative" ]
704 """returns the upper word of the product of its operands (the part which
705 would not fit into the result mode of a normal Mul anymore)"""
706 flags = [ "commutative" ]
710 """returns the false or true operand depending on the value of the sel
713 ("sel", "value making the output selection"),
714 ("false", "selected if sel input is false"),
715 ("true", "selected if sel input is true"),
722 """Placeholder node for cases where you don't need any memory input"""
724 flags = [ "dump_noblock" ]
727 block = "get_irg_start_block(irg)"
732 """returns the bitwise complement of a value. Works for boolean values, too."""
737 """returns the result of a bitwise or operation of its operands"""
738 flags = [ "commutative" ]
742 """Choose a value based on control flow. A phi node has 1 input for each
743 predecessor of its block. If a block is entered from its nth predecessor
744 all phi nodes produce their nth input as result."""
749 attr_struct = "phi_attr"
751 res->attr.phi.u.backedge = new_backedge_arr(get_irg_obstack(irg), arity);'''
752 customSerializer = True
756 """Pin the value of the node node in the current block. No users of the Pin
757 node can float above the Block of the Pin. The node cannot float behind
758 this block. Often used to Pin the NoMem node."""
760 ("op", "value which is pinned"),
762 mode = "get_irn_mode(irn_op)"
763 flags = [ "highlevel" ]
768 """returns an entry of a tuple value"""
770 ("pred", "the tuple value from which a part is extracted"),
776 block = "get_nodes_block(irn_pred)"
777 graph = "get_irn_irg(irn_pred)"
782 comment = "number of tuple component to be extracted",
785 attr_struct = "proj_attr"
789 """Raises an exception. Unconditional change of control flow. Writes an
790 explicit Except variable to memory to pass it to the exception handler.
791 Must be lowered to a Call to a runtime check function."""
793 ("mem", "memory dependency"),
794 ("exo_ptr", "pointer to exception object to be thrown"),
797 ("M", "memory result"),
798 ("X", "control flow to exception handler"),
800 flags = [ "highlevel", "cfopcode" ]
805 """Returns from the current function. Takes memory and return values as
808 ("mem", "memory dependency"),
813 flags = [ "cfopcode" ]
817 """Returns its first operand bits rotated left by the amount in the 2nd
823 """Computes the address of a entity of a compound type given the base
824 address of an instance of the compound type.
826 Optimisations assume that a Sel node can only produce a NULL pointer if the
827 ptr input was NULL."""
829 ("mem", "memory dependency"),
830 ("ptr", "pointer to object to select from"),
835 mode = "is_Method_type(get_entity_type(entity)) ? mode_P_code : mode_P_data"
841 comment = "entity which is selected",
844 attr_struct = "sel_attr"
848 """Returns its first operands bits shifted left by the amount of the 2nd
850 The right input (shift amount) must be an unsigned integer value.
851 If the result mode has modulo_shift!=0, then the effective shift amount is
852 the right input modulo this modulo_shift amount."""
857 """Returns its first operands bits shifted right by the amount of the 2nd
858 operand. No special handling for the sign bit is performed (zero extension).
859 The right input (shift amount) must be an unsigned integer value.
860 If the result mode has modulo_shift!=0, then the effective shift amount is
861 the right input modulo this modulo_shift amount."""
866 """Returns its first operands bits shifted right by the amount of the 2nd
867 operand. The leftmost bit (usually the sign bit) stays the same
869 The right input (shift amount) must be an unsigned integer value.
870 If the result mode has modulo_shift!=0, then the effective shift amount is
871 the right input modulo this modulo_shift amount."""
876 """The first node of a graph. Execution starts with this node."""
878 ("X_initial_exec", "control flow"),
879 ("M", "initial memory"),
880 ("P_frame_base", "frame base pointer"),
881 ("T_args", "function arguments")
885 flags = [ "cfopcode" ]
888 block = "get_irg_start_block(irg)"
892 """Stores a value into memory (heap or stack)."""
894 ("mem", "memory dependency"),
895 ("ptr", "address to store to"),
896 ("value", "value to store"),
899 ("M", "memory result"),
900 ("X_regular", "control flow when no exception occurs"),
901 ("X_except", "control flow when exception occured"),
903 flags = [ "fragile", "uses_memory" ]
905 attr_struct = "store_attr"
906 pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
907 throws_init = "(flags & cons_throws_exception) != 0"
910 type = "ir_volatility",
912 comment = "volatile stores are a visible side-effect and may not be optimized",
913 init = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
914 to_flags = "%s == volatility_is_volatile ? cons_volatile : cons_none"
919 comment = "pointers to unaligned stores don't need to respect the load-mode/type alignments",
920 init = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
921 to_flags = "%s == align_non_aligned ? cons_unaligned : cons_none"
926 type = "ir_cons_flags",
928 comment = "specifies alignment, volatility and pin state",
934 """returns the difference of its operands"""
939 """A symbolic constant.
941 - *symconst_type_size* The symbolic constant represents the size of a type.
942 The type of which the constant represents the size
944 - *symconst_type_align* The symbolic constant represents the alignment of a
945 type. The type of which the constant represents the
946 size is given explicitly.
947 - *symconst_addr_ent* The symbolic constant represents the address of an
948 entity (variable or method). The variable is given
949 explicitly by a firm entity.
950 - *symconst_ofs_ent* The symbolic constant represents the offset of an
951 entity in its owner type.
952 - *symconst_enum_const* The symbolic constant is a enumeration constant of
953 an enumeration type."""
955 flags = [ "constlike", "start_block" ]
963 comment = "entity whose address is returned",
966 attr_struct = "symconst_attr"
967 customSerializer = True
968 # constructor is written manually at the moment, because of the strange
974 """The Sync operation unifies several partial memory blocks. These blocks
975 have to be pairwise disjunct or the values in common locations have to
976 be identical. This operation allows to specify all operations that
977 eventually need several partial memory blocks as input with a single
978 entrance by unifying the memories with a preceding Sync operation."""
987 """Builds a Tuple from single values.
989 This is needed to implement optimizations that remove a node that produced
990 a tuple. The node can be replaced by the Tuple operation so that the
991 following Proj nodes have not to be changed. (They are hard to find due to
992 the implementation with pointers in only one direction.) The Tuple node is
993 smaller than any other node, so that a node can be changed into a Tuple by
994 just changing its opcode and giving it a new in array."""
1003 """Returns an unknown (at compile- and runtime) value. It is a valid
1004 optimisation to replace an Unknown by any other constant value."""
1007 block = "get_irg_start_block(irg)"
1008 flags = [ "start_block", "constlike", "dump_noblock" ]