1 from spec_util import abstract, setnodedefaults
4 """Base class for firm nodes"""
8 """Unary nodes have exactly 1 input"""
18 """Binary nodes have exactly 2 inputs"""
21 ( "left", "first operand" ),
22 ( "right", "second operand" ),
29 """returns the sum of its operands"""
30 flags = [ "commutative" ]
33 """allocates a block of memory.
34 It can be specified whether the variable should be allocated to the stack
37 ("mem", "memory dependency" ),
38 ("count", "number of objects to allocate" ),
41 ("M", "memory result", "pn_Generic_M"),
42 ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
43 ("X_except", "control flow when exception occured", "pn_Generic_X_except"),
44 ("res", "pointer to newly allocated memory", "pn_Generic_other"),
50 comment = "type of the allocated variable",
54 type = "ir_where_alloc",
55 comment = "whether to allocate the variable on the stack or heap",
58 flags = [ "fragile", "uses_memory" ]
60 attr_struct = "alloc_attr"
63 """utiliy node used to "hold" nodes in a graph that might possibly not be
64 reachable by other means or which should be reachable immediately without
65 searching through the graph.
66 Each firm-graph contains exactly one anchor node whose address is always
67 known. All other well-known graph-nodes like Start, End, NoMem, Bad, ...
68 are found by looking at the respective Anchor operand."""
71 flags = [ "dump_noblock" ]
73 attr_struct = "irg_attr"
77 customSerializer = True
80 """returns the result of a bitwise and operation of its operands"""
81 flags = [ "commutative" ]
84 """executes assembler fragments of the target machine"""
87 flags = [ "keep", "uses_memory" ]
89 pinned_init = "op_pin_state_pinned"
90 attr_struct = "asm_attr"
92 customSerializer = True
95 name = "input_constraints",
96 type = "ir_asm_constraint*",
97 comment = "input constraints",
100 name = "n_output_constraints",
103 comment = "number of output constraints",
106 name = "output_constraints",
107 type = "ir_asm_constraint*",
108 comment = "output constraints",
114 comment = "number of clobbered registers/memory",
119 comment = "list of clobbered registers/memory",
124 comment = "assembler text",
127 # constructor is written manually at the moment, because of the clobbers+
128 # constraints arrays needing special handling (2 arguments for 1 attribute)
132 """Bad nodes indicate invalid input, which is values which should never be
135 The typical use case for the Bad node is removing unreachable code.
136 Frontends should set the current_block to Bad when it is clear that
137 following code must be unreachable (ie. after a goto or return statement).
138 Optimisations also set block predecessors to Bad when it becomes clear,
139 that a control flow edge can never be executed.
141 The gigo optimisations ensures that nodes with Bad as their block, get
142 replaced by Bad themselfes. Nodes with at least 1 Bad input get exchanged
143 with Bad too. Exception to this rule are Block, Phi, Tuple and End node;
144 This is because removing inputs from a Block is hairy operation (requiring,
145 Phis to be shortened too for example). So instead of removing block inputs
146 they are set to Bad, and the actual removal is left to the control flow
147 optimisation phase. Block, Phi, Tuple with only Bad inputs however are
148 replaced by Bad right away."""
150 flags = [ "cfopcode", "start_block", "dump_noblock" ]
153 block = "get_irg_start_block(irg)"
155 attr_struct = "bad_attr"
157 res->attr.bad.irg.irg = irg;
161 """Internal node which is temporary set to nodes which are already removed
167 customSerializer = True
176 flags = [ "labeled" ]
177 attr_struct = "block_attr"
178 customSerializer = True
181 res->attr.block.irg.irg = irg;
182 res->attr.block.backedge = new_backedge_arr(irg->obst, arity);
183 set_Block_matured(res, 1);
185 /* Create and initialize array for Phi-node construction. */
186 if (get_irg_phase_state(irg) == phase_building) {
187 res->attr.block.graph_arr = NEW_ARR_D(ir_node *, irg->obst, irg->n_loc);
188 memset(res->attr.block.graph_arr, 0, irg->n_loc * sizeof(ir_node*));
193 """Returns the borrow bit from and implied subtractions of its 2 operands"""
197 """Performs a bounds-check: if lower <= index < upper then return index,
198 otherwise throw an exception."""
200 ("mem", "memory dependency"),
201 ("index", "value to test"),
202 ("lower", "lower bound (inclusive)"),
203 ("upper", "upper bound (exclusive)"),
206 ("M", "memory result", "pn_Generic_M"),
207 ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
208 ("X_except", "control flow when exception occured", "pn_Generic_X_except"),
209 ("res", "the checked index", "pn_Generic_other"),
211 flags = [ "fragile", "highlevel" ]
213 pinned_init = "op_pin_state_pinned"
214 attr_struct = "bound_attr"
218 """performs a backend-specific builtin."""
220 ("mem", "memory dependency"),
224 ("M", "memory result", "pn_Generic_M"),
225 ("1_result", "first result", "pn_Generic_other"),
227 flags = [ "uses_memory" ]
230 type = "ir_builtin_kind",
232 comment = "kind of builtin",
237 comment = "method type for the builtin call",
241 pinned_init = "op_pin_state_pinned"
242 attr_struct = "builtin_attr"
244 assert((get_unknown_type() == type) || is_Method_type(type));
248 """Calls other code. Control flow is transfered to ptr, additional
249 operands are passed to the called code. Called code usually performs a
250 return operation. The operands of this return operation are the result
253 ("mem", "memory dependency"),
254 ("ptr", "pointer to called code"),
258 ("M", "memory result", "pn_Generic_M"),
259 ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
260 ("X_except", "control flow when exception occured", "pn_Generic_X_except"),
261 ("T_result", "tuple containing all results", "pn_Generic_other"),
263 flags = [ "fragile", "uses_memory" ]
268 comment = "type of the call (usually type of the called procedure)",
273 # the tail call attribute can only be set by analysis
277 attr_struct = "call_attr"
279 pinned_init = "op_pin_state_pinned"
281 assert((get_unknown_type() == type) || is_Method_type(type));
285 """Computes the value of the carry-bit that would result when adding the 2
287 flags = [ "commutative" ]
290 """perform a high-level type cast"""
291 mode = "get_irn_mode(irn_op)"
292 flags = [ "highlevel" ]
297 comment = "target type of the case",
300 attr_struct = "cast_attr"
301 init = "assert(is_atomic_type(type));"
304 """Compares its two operands and checks whether a specified
305 relation (like less or equal) is fulfilled."""
310 type = "ir_relation",
312 comment = "Comparison relation"
315 attr_struct = "cmp_attr"
318 """Conditionally change control flow. There are two versions of this node:
321 Input: A value of mode_b
322 Output: A tuple of two control flows. The first is taken if the input is
323 false, the second if it is true.
326 Input: A value of mode_Iu
327 Output: A tuple of n control flows. If the Cond's input is i, control flow
328 will proceed along output i. If the input is >= n control flow proceeds
329 along output def_proj.
332 ("selector", "condition parameter"),
335 ("false", "control flow if operand is \"false\""),
336 ("true", "control flow if operand is \"true\""),
338 flags = [ "cfopcode", "forking" ]
342 name = "default_proj",
345 comment = "Proj-number of default case for switch-Cond",
349 type = "cond_jmp_predicate",
350 init = "COND_JMP_PRED_NONE",
351 comment = "can indicate the most likely jump",
354 attr_struct = "cond_attr"
357 """Specifies constraints for a value. This allows explicit representation
358 of path-sensitive properties. (Example: This value is always >= 0 on 1
359 if-branch then all users within that branch are rerouted to a confirm-node
360 specifying this property).
362 A constraint is specified for the relation between value and bound.
363 value is always returned.
364 Note that this node does NOT check or assert the constraint, it merely
367 ("value", "value to express a constraint for"),
368 ("bound", "value to compare against"),
370 mode = "get_irn_mode(irn_value)"
371 flags = [ "highlevel" ]
376 type = "ir_relation",
377 comment = "relation of value to bound",
380 attr_struct = "confirm_attr"
381 attrs_name = "confirm"
384 """Returns a constant value."""
385 flags = [ "constlike", "start_block" ]
386 block = "get_irg_start_block(irg)"
387 mode = "get_tarval_mode(tarval)"
394 comment = "constant value (a tarval object)",
397 attr_struct = "const_attr"
401 """Converts values between modes"""
408 comment = "force floating point to restrict precision even if backend computes in higher precision (deprecated)",
411 attr_struct = "conv_attr"
415 """Copies a block of memory"""
417 ("mem", "memory dependency"),
418 ("dst", "destination address"),
419 ("src", "source address"),
422 ("M", "memory result", "pn_Generic_M"),
423 ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
424 ("X_except", "control flow when exception occured", "pn_Generic_X_except"),
426 flags = [ "fragile", "uses_memory" ]
431 comment = "type of copied data",
434 attr_struct = "copyb_attr"
437 pinned_init = "op_pin_state_pinned"
440 """returns the quotient of its 2 operands"""
442 ("mem", "memory dependency"),
443 ("left", "first operand"),
444 ("right", "second operand"),
447 ("M", "memory result", "pn_Generic_M"),
448 ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
449 ("X_except", "control flow when exception occured", "pn_Generic_X_except"),
450 ("res", "result of computation", "pn_Generic_other"),
452 flags = [ "fragile", "uses_memory" ]
458 comment = "mode of the result value",
461 name = "no_remainder",
466 attr_struct = "div_attr"
469 arity_override = "oparity_binary"
472 """A placeholder value. This is used when constructing cyclic graphs where
473 you have cases where not all predecessors of a phi-node are known. Dummy
474 nodes are used for the unknown predecessors and replaced later."""
476 flags = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
479 block = "get_irg_start_block(irg)"
482 """Last node of a graph. It references nodes in endless loops (so called
487 flags = [ "cfopcode" ]
489 block = "get_irg_end_block(irg)"
491 customSerializer = True
494 """returns the result of a bitwise exclusive or operation of its operands"""
495 flags = [ "commutative" ]
498 """Frees a block of memory previously allocated by an Alloc node"""
500 ("mem", "memory dependency" ),
501 ("ptr", "pointer to the object to free"),
502 ("size", "number of objects to allocate" ),
505 flags = [ "uses_memory" ]
511 comment = "type of the allocated variable",
515 type = "ir_where_alloc",
516 comment = "whether allocation was on the stack or heap",
519 attr_struct = "free_attr"
522 """Returns its operand unchanged."""
524 ("pred", "the value which is returned unchanged")
530 """Jumps to the code in its argument. The code has to be in the same
531 function and the the destination must be one of the blocks reachable
532 by the tuple results"""
536 ("target", "target address of the jump"),
538 flags = [ "cfopcode", "forking", "keep", "unknown_jump" ]
541 """Tests whether an object is an instance of a class-type"""
543 ("store", "memory dependency"),
544 ("obj", "pointer to object being queried")
547 ("M", "memory result", "pn_Generic_M"),
548 ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
549 ("X_except", "control flow when exception occured", "pn_Generic_X_except"),
550 ("res", "checked object pointer", "pn_Generic_other"),
552 flags = [ "highlevel" ]
557 comment = "type to check ptr for",
560 attr_struct = "io_attr"
562 pinned_init = "op_pin_state_floats"
565 """Jumps to the block connected through the out-value"""
569 flags = [ "cfopcode" ]
572 """Loads a value from memory (heap or stack)."""
574 ("mem", "memory dependency"),
575 ("ptr", "address to load from"),
578 ("M", "memory result", "pn_Generic_M"),
579 ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
580 ("X_except", "control flow when exception occured", "pn_Generic_X_except"),
581 ("res", "result of load operation", "pn_Generic_other"),
583 flags = [ "fragile", "uses_memory" ]
589 comment = "mode of the value to be loaded",
592 type = "ir_volatility",
594 comment = "volatile loads are a visible side-effect and may not be optimized",
595 init = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
600 comment = "pointers to unaligned loads don't need to respect the load-mode/type alignments",
601 init = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
604 attr_struct = "load_attr"
607 type = "ir_cons_flags",
609 comment = "specifies alignment, volatility and pin state",
612 pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
615 """returns the difference between its operands"""
619 """returns the remainder of its operands from an implied division.
622 * mod(5,3) produces 2
623 * mod(5,-3) produces 2
624 * mod(-5,3) produces -2
625 * mod(-5,-3) produces -2
628 ("mem", "memory dependency"),
629 ("left", "first operand"),
630 ("right", "second operand"),
633 ("M", "memory result", "pn_Generic_M"),
634 ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
635 ("X_except", "control flow when exception occured", "pn_Generic_X_except"),
636 ("res", "result of computation", "pn_Generic_other"),
638 flags = [ "fragile", "uses_memory" ]
644 comment = "mode of the result",
647 attr_struct = "mod_attr"
650 arity_override = "oparity_binary"
653 """returns the product of its operands"""
654 flags = [ "commutative" ]
657 """returns the upper word of the product of its operands (the part which
658 would not fit into the result mode of a normal Mul anymore)"""
659 flags = [ "commutative" ]
662 """returns the false or true operand depending on the value of the sel
665 ("sel", "value making the output selection"),
666 ("false", "selected if sel input is false"),
667 ("true", "selected if sel input is true"),
673 """Placeholder node for cases where you don't need any memory input"""
675 flags = [ "dump_noblock", "dump_noinput" ]
678 block = "get_irg_start_block(irg)"
682 """returns the logical complement of a value. Works for integer values too.
683 If the input is false/zero then true/one is returned, otherwise false/zero
688 """returns the result of a bitwise or operation of its operands"""
689 flags = [ "commutative" ]
692 """Choose a value based on control flow. A phi node has 1 input for each
693 predecessor of its block. If a block is entered from its nth predecessor
694 all phi nodes produce their nth input as result."""
698 attr_struct = "phi_attr"
700 res->attr.phi.u.backedge = new_backedge_arr(irg->obst, arity);'''
702 /* Memory Phis in endless loops must be kept alive.
703 As we can't distinguish these easily we keep all of them alive. */
704 if (is_Phi(res) && mode == mode_M)
705 add_End_keepalive(get_irg_end(irg), res);'''
708 """Pin the value of the node node in the current block. No users of the Pin
709 node can float above the Block of the Pin. The node cannot float behind
710 this block. Often used to Pin the NoMem node."""
712 ("op", "value which is pinned"),
714 mode = "get_irn_mode(irn_op)"
715 flags = [ "highlevel" ]
719 """returns an entry of a tuple value"""
721 ("pred", "the tuple value from which a part is extracted"),
727 block = "get_nodes_block(irn_pred)"
728 graph = "get_irn_irg(irn_pred)"
729 customSerializer = True
734 comment = "number of tuple component to be extracted",
737 attr_struct = "proj_attr"
740 """Raises an exception. Unconditional change of control flow. Writes an
741 explicit Except variable to memory to pass it to the exception handler.
742 Must be lowered to a Call to a runtime check function."""
744 ("mem", "memory dependency"),
745 ("exo_ptr", "pointer to exception object to be thrown"),
748 ("M", "memory result", "pn_Generic_M"),
749 ("X", "control flow to exception handler", "pn_Generic_X_regular"),
751 flags = [ "highlevel", "cfopcode" ]
755 """Returns from the current function. Takes memory and return values as
758 ("mem", "memory dependency"),
762 flags = [ "cfopcode" ]
766 """Returns its first operand bits rotated left by the amount in the 2nd
771 """Computes the address of a entity of a compound type given the base
772 address of an instance of the compound type."""
774 ("mem", "memory dependency"),
775 ("ptr", "pointer to object to select from"),
779 mode = "is_Method_type(get_entity_type(entity)) ? mode_P_code : mode_P_data"
785 comment = "entity which is selected",
788 attr_struct = "sel_attr"
791 """Returns its first operands bits shifted left by the amount of the 2nd
796 """Returns its first operands bits shifted right by the amount of the 2nd
797 operand. No special handling for the sign bit (zero extension)"""
801 """Returns its first operands bits shifted right by the amount of the 2nd
802 operand. The leftmost bit (usually the sign bit) stays the same
807 """The first node of a graph. Execution starts with this node."""
809 ("X_initial_exec", "control flow"),
810 ("M", "initial memory"),
811 ("P_frame_base", "frame base pointer"),
812 ("T_args", "function arguments")
816 flags = [ "cfopcode" ]
819 customSerializer = True
820 block = "get_irg_start_block(irg)"
823 """Stores a value into memory (heap or stack)."""
825 ("mem", "memory dependency"),
826 ("ptr", "address to store to"),
827 ("value", "value to store"),
830 ("M", "memory result", "pn_Generic_M"),
831 ("X_regular", "control flow when no exception occurs", "pn_Generic_X_regular"),
832 ("X_except", "control flow when exception occured", "pn_Generic_X_except"),
834 flags = [ "fragile", "uses_memory" ]
836 attr_struct = "store_attr"
837 pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
840 type = "ir_volatility",
842 comment = "volatile stores are a visible side-effect and may not be optimized",
843 init = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
848 comment = "pointers to unaligned stores don't need to respect the load-mode/type alignments",
849 init = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
854 type = "ir_cons_flags",
856 comment = "specifies alignment, volatility and pin state",
861 """returns the difference of its operands"""
865 """A symbolic constant.
867 - symconst_type_tag The symbolic constant represents a type tag. The
868 type the tag stands for is given explicitly.
869 - symconst_type_size The symbolic constant represents the size of a type.
870 The type of which the constant represents the size
872 - symconst_type_align The symbolic constant represents the alignment of a
873 type. The type of which the constant represents the
874 size is given explicitly.
875 - symconst_addr_ent The symbolic constant represents the address of an
876 entity (variable or method). The variable is given
877 explicitly by a firm entity.
878 - symconst_ofs_ent The symbolic constant represents the offset of an
879 entity in its owner type.
880 - symconst_enum_const The symbolic constant is a enumeration constant of
881 an enumeration type."""
883 flags = [ "constlike", "start_block" ]
891 comment = "entity whose address is returned",
894 attr_struct = "symconst_attr"
895 customSerializer = True
896 # constructor is written manually at the moment, because of the strange
901 """The Sync operation unifies several partial memory blocks. These blocks
902 have to be pairwise disjunct or the values in common locations have to
903 be identical. This operation allows to specify all operations that
904 eventually need several partial memory blocks as input with a single
905 entrance by unifying the memories with a preceding Sync operation."""
912 """Builds a Tuple from single values.
914 This is needed to implement optimizations that remove a node that produced
915 a tuple. The node can be replaced by the Tuple operation so that the
916 following Proj nodes have not to be changed. (They are hard to find due to
917 the implementation with pointers in only one direction.) The Tuple node is
918 smaller than any other node, so that a node can be changed into a Tuple by
919 just changing its opcode and giving it a new in array."""
923 flags = [ "labeled" ]
926 """Returns an unknown (at compile- and runtime) value. It is a valid
927 optimisation to replace an Unknown by any other constant value."""
930 block = "get_irg_start_block(irg)"
931 flags = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
935 def getOpList(namespace):
937 for t in namespace.values():
941 if issubclass(t, Op):
946 nodes = getOpList(globals())
947 nodes = sorted(nodes, lambda x,y: cmp(x.name, y.name))