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"),
42 ("res", "pointer to newly allocated memory"),
43 ("X_regular", "control flow when no exception occurs"),
44 ("X_except", "control flow when exception occured"),
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" ]
61 pinned_init = "op_pin_state_pinned"
62 attr_struct = "alloc_attr"
65 """utiliy node used to "hold" nodes in a graph that might possibly not be
66 reachable by other means or which should be reachable immediately without
67 searching through the graph.
68 Each firm-graph contains exactly one anchor node whose address is always
69 known. All other well-known graph-nodes like Start, End, NoMem, Bad, ...
70 are found by looking at the respective Anchor operand."""
73 flags = [ "dump_noblock" ]
75 attr_struct = "irg_attr"
79 customSerializer = True
82 """returns the result of a bitwise and operation of its operands"""
83 flags = [ "commutative" ]
86 """executes assembler fragments of the target machine"""
89 flags = [ "keep", "uses_memory" ]
91 pinned_init = "op_pin_state_pinned"
92 attr_struct = "asm_attr"
94 customSerializer = True
97 name = "input_constraints",
98 type = "ir_asm_constraint*",
99 comment = "input constraints",
102 name = "n_output_constraints",
105 comment = "number of output constraints",
108 name = "output_constraints",
109 type = "ir_asm_constraint*",
110 comment = "output constraints",
116 comment = "number of clobbered registers/memory",
121 comment = "list of clobbered registers/memory",
126 comment = "assembler text",
129 # constructor is written manually at the moment, because of the clobbers+
130 # constraints arrays needing special handling (2 arguments for 1 attribute)
134 """Bad nodes indicate invalid input, which is values which should never be
137 The typical use case for the Bad node is removing unreachable code.
138 Frontends should set the current_block to Bad when it is clear that
139 following code must be unreachable (ie. after a goto or return statement).
140 Optimisations also set block predecessors to Bad when it becomes clear,
141 that a control flow edge can never be executed.
143 The gigo optimisations ensures that nodes with Bad as their block, get
144 replaced by Bad themselfes. Nodes with at least 1 Bad input get exchanged
145 with Bad too. Exception to this rule are Block, Phi, Tuple and End node;
146 This is because removing inputs from a Block is hairy operation (requiring,
147 Phis to be shortened too for example). So instead of removing block inputs
148 they are set to Bad, and the actual removal is left to the control flow
149 optimisation phase. Block, Phi, Tuple with only Bad inputs however are
150 replaced by Bad right away."""
151 flags = [ "start_block", "dump_noblock" ]
154 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"),
207 ("res", "the checked index"),
208 ("X_regular", "control flow when no exception occurs"),
209 ("X_except", "control flow when exception occured"),
211 flags = [ "fragile", "highlevel" ]
213 pinned_init = "op_pin_state_pinned"
214 throws_init = "false"
215 attr_struct = "bound_attr"
218 """performs a backend-specific builtin."""
220 ("mem", "memory dependency"),
224 ("M", "memory result"),
225 # results follow here
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"),
259 ("T_result", "tuple containing all results"),
260 ("X_regular", "control flow when no exception occurs"),
261 ("X_except", "control flow when exception occured"),
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"
280 throws_init = "false"
282 assert((get_unknown_type() == type) || is_Method_type(type));
286 """Computes the value of the carry-bit that would result when adding the 2
288 flags = [ "commutative" ]
291 """perform a high-level type cast"""
292 mode = "get_irn_mode(irn_op)"
293 flags = [ "highlevel" ]
298 comment = "target type of the case",
301 attr_struct = "cast_attr"
302 init = "assert(is_atomic_type(type));"
305 """Compares its two operands and checks whether a specified
306 relation (like less or equal) is fulfilled."""
311 type = "ir_relation",
313 comment = "Comparison relation"
316 attr_struct = "cmp_attr"
319 """Conditionally change control flow.
320 Input: A value of mode_b
321 Output: A tuple of two control flows. The first is taken if the input is
322 false, the second if it is true.
325 ("selector", "condition parameter"),
328 ("false", "control flow if operand is \"false\""),
329 ("true", "control flow if operand is \"true\""),
331 flags = [ "cfopcode", "forking" ]
336 type = "cond_jmp_predicate",
337 init = "COND_JMP_PRED_NONE",
338 comment = "can indicate the most likely jump",
341 attr_struct = "cond_attr"
344 """Change control flow. The destination is choosen based on an integer input value which is looked up in a table.
346 Backends can implement this efficiently using a jump table."""
348 ("selector", "input selector"),
351 ("default", "control flow if no other case matches"),
353 flags = [ "cfopcode", "forking" ]
359 comment = "number of outputs (including pn_Switch_default)",
363 type = "ir_switch_table*",
364 comment = "table describing mapping from input values to Proj numbers",
367 attr_struct = "switch_attr"
368 attrs_name = "switcha"
371 """Specifies constraints for a value. This allows explicit representation
372 of path-sensitive properties. (Example: This value is always >= 0 on 1
373 if-branch then all users within that branch are rerouted to a confirm-node
374 specifying this property).
376 A constraint is specified for the relation between value and bound.
377 value is always returned.
378 Note that this node does NOT check or assert the constraint, it merely
381 ("value", "value to express a constraint for"),
382 ("bound", "value to compare against"),
384 mode = "get_irn_mode(irn_value)"
385 flags = [ "highlevel" ]
390 type = "ir_relation",
391 comment = "relation of value to bound",
394 attr_struct = "confirm_attr"
397 """Returns a constant value."""
398 flags = [ "constlike", "start_block" ]
399 block = "get_irg_start_block(irg)"
400 mode = "get_tarval_mode(tarval)"
407 comment = "constant value (a tarval object)",
410 attr_struct = "const_attr"
414 """Converts values between modes"""
421 comment = "force floating point to restrict precision even if backend computes in higher precision (deprecated)",
424 attr_struct = "conv_attr"
427 """Copies a block of memory"""
429 ("mem", "memory dependency"),
430 ("dst", "destination address"),
431 ("src", "source address"),
434 ("M", "memory result"),
435 ("X_regular", "control flow when no exception occurs"),
436 ("X_except", "control flow when exception occured"),
438 flags = [ "fragile", "uses_memory" ]
443 comment = "type of copied data",
446 attr_struct = "copyb_attr"
448 pinned_init = "op_pin_state_pinned"
449 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"
484 """A placeholder value. This is used when constructing cyclic graphs where
485 you have cases where not all predecessors of a phi-node are known. Dummy
486 nodes are used for the unknown predecessors and replaced later."""
488 flags = [ "cfopcode", "start_block", "constlike", "dump_noblock" ]
491 block = "get_irg_start_block(irg)"
494 """Last node of a graph. It references nodes in endless loops (so called
499 flags = [ "cfopcode" ]
501 block = "get_irg_end_block(irg)"
503 customSerializer = True
506 """returns the result of a bitwise exclusive or operation of its operands"""
507 flags = [ "commutative" ]
510 """Frees a block of memory previously allocated by an Alloc node"""
512 ("mem", "memory dependency" ),
513 ("ptr", "pointer to the object to free"),
514 ("count", "number of objects to allocate" ),
517 flags = [ "uses_memory" ]
523 comment = "type of the allocated variable",
527 type = "ir_where_alloc",
528 comment = "whether allocation was on the stack or heap",
531 attr_struct = "free_attr"
534 """Returns its operand unchanged."""
536 ("pred", "the value which is returned unchanged")
542 """Jumps to the code in its argument. The code has to be in the same
543 function and the the destination must be one of the blocks reachable
544 by the tuple results"""
548 ("target", "target address of the jump"),
550 flags = [ "cfopcode", "forking", "keep", "unknown_jump" ]
553 """Tests whether an object is an instance of a class-type"""
555 ("store", "memory dependency"),
556 ("obj", "pointer to object being queried")
559 ("M", "memory result"),
560 ("res", "checked object pointer"),
561 ("X_regular", "control flow when no exception occurs"),
562 ("X_except", "control flow when exception occured"),
564 flags = [ "highlevel" ]
569 comment = "type to check ptr for",
572 attr_struct = "io_attr"
574 pinned_init = "op_pin_state_floats"
577 """Jumps to the block connected through the out-value"""
581 flags = [ "cfopcode" ]
584 """Loads a value from memory (heap or stack)."""
586 ("mem", "memory dependency"),
587 ("ptr", "address to load from"),
590 ("M", "memory result"),
591 ("res", "result of load operation"),
592 ("X_regular", "control flow when no exception occurs"),
593 ("X_except", "control flow when exception occured"),
595 flags = [ "fragile", "uses_memory" ]
601 comment = "mode of the value to be loaded",
604 type = "ir_volatility",
606 comment = "volatile loads are a visible side-effect and may not be optimized",
607 init = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
612 comment = "pointers to unaligned loads don't need to respect the load-mode/type alignments",
613 init = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
616 attr_struct = "load_attr"
619 type = "ir_cons_flags",
621 comment = "specifies alignment, volatility and pin state",
624 pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
625 throws_init = "(flags & cons_throws_exception) != 0"
628 """returns the difference between its operands"""
632 """returns the remainder of its operands from an implied division.
635 * mod(5,3) produces 2
636 * mod(5,-3) produces 2
637 * mod(-5,3) produces -2
638 * mod(-5,-3) produces -2
641 ("mem", "memory dependency"),
642 ("left", "first operand"),
643 ("right", "second operand"),
646 ("M", "memory result"),
647 ("res", "result of computation"),
648 ("X_regular", "control flow when no exception occurs"),
649 ("X_except", "control flow when exception occured"),
651 flags = [ "fragile", "uses_memory" ]
656 comment = "mode of the result",
659 attr_struct = "mod_attr"
661 throws_init = "false"
663 arity_override = "oparity_binary"
666 """returns the product of its operands"""
667 flags = [ "commutative" ]
670 """returns the upper word of the product of its operands (the part which
671 would not fit into the result mode of a normal Mul anymore)"""
672 flags = [ "commutative" ]
675 """returns the false or true operand depending on the value of the sel
678 ("sel", "value making the output selection"),
679 ("false", "selected if sel input is false"),
680 ("true", "selected if sel input is true"),
686 """Placeholder node for cases where you don't need any memory input"""
688 flags = [ "dump_noblock", "dump_noinput" ]
691 block = "get_irg_start_block(irg)"
695 """returns the logical complement of a value. Works for integer values too.
696 If the input is false/zero then true/one is returned, otherwise false/zero
701 """returns the result of a bitwise or operation of its operands"""
702 flags = [ "commutative" ]
705 """Choose a value based on control flow. A phi node has 1 input for each
706 predecessor of its block. If a block is entered from its nth predecessor
707 all phi nodes produce their nth input as result."""
711 attr_struct = "phi_attr"
713 res->attr.phi.u.backedge = new_backedge_arr(irg->obst, arity);'''
715 /* Memory Phis in endless loops must be kept alive.
716 As we can't distinguish these easily we keep all of them alive. */
717 if (is_Phi(res) && mode == mode_M)
718 add_End_keepalive(get_irg_end(irg), res);'''
721 """Pin the value of the node node in the current block. No users of the Pin
722 node can float above the Block of the Pin. The node cannot float behind
723 this block. Often used to Pin the NoMem node."""
725 ("op", "value which is pinned"),
727 mode = "get_irn_mode(irn_op)"
728 flags = [ "highlevel" ]
732 """returns an entry of a tuple value"""
734 ("pred", "the tuple value from which a part is extracted"),
740 block = "get_nodes_block(irn_pred)"
741 graph = "get_irn_irg(irn_pred)"
742 customSerializer = True
747 comment = "number of tuple component to be extracted",
750 attr_struct = "proj_attr"
753 """Raises an exception. Unconditional change of control flow. Writes an
754 explicit Except variable to memory to pass it to the exception handler.
755 Must be lowered to a Call to a runtime check function."""
757 ("mem", "memory dependency"),
758 ("exo_ptr", "pointer to exception object to be thrown"),
761 ("M", "memory result"),
762 ("X", "control flow to exception handler"),
764 flags = [ "highlevel", "cfopcode" ]
768 """Returns from the current function. Takes memory and return values as
771 ("mem", "memory dependency"),
775 flags = [ "cfopcode" ]
779 """Returns its first operand bits rotated left by the amount in the 2nd
784 """Computes the address of a entity of a compound type given the base
785 address of an instance of the compound type."""
787 ("mem", "memory dependency"),
788 ("ptr", "pointer to object to select from"),
792 mode = "is_Method_type(get_entity_type(entity)) ? mode_P_code : mode_P_data"
798 comment = "entity which is selected",
801 attr_struct = "sel_attr"
804 """Returns its first operands bits shifted left by the amount of the 2nd
809 """Returns its first operands bits shifted right by the amount of the 2nd
810 operand. No special handling for the sign bit (zero extension)"""
814 """Returns its first operands bits shifted right by the amount of the 2nd
815 operand. The leftmost bit (usually the sign bit) stays the same
820 """The first node of a graph. Execution starts with this node."""
822 ("X_initial_exec", "control flow"),
823 ("M", "initial memory"),
824 ("P_frame_base", "frame base pointer"),
825 ("T_args", "function arguments")
829 flags = [ "cfopcode" ]
832 customSerializer = True
833 block = "get_irg_start_block(irg)"
836 """Stores a value into memory (heap or stack)."""
838 ("mem", "memory dependency"),
839 ("ptr", "address to store to"),
840 ("value", "value to store"),
843 ("M", "memory result"),
844 ("X_regular", "control flow when no exception occurs"),
845 ("X_except", "control flow when exception occured"),
847 flags = [ "fragile", "uses_memory" ]
849 attr_struct = "store_attr"
850 pinned_init = "flags & cons_floats ? op_pin_state_floats : op_pin_state_pinned"
851 throws_init = "(flags & cons_throws_exception) != 0"
854 type = "ir_volatility",
856 comment = "volatile stores are a visible side-effect and may not be optimized",
857 init = "flags & cons_volatile ? volatility_is_volatile : volatility_non_volatile",
862 comment = "pointers to unaligned stores don't need to respect the load-mode/type alignments",
863 init = "flags & cons_unaligned ? align_non_aligned : align_is_aligned",
868 type = "ir_cons_flags",
870 comment = "specifies alignment, volatility and pin state",
875 """returns the difference of its operands"""
879 """A symbolic constant.
881 - symconst_type_tag The symbolic constant represents a type tag. The
882 type the tag stands for is given explicitly.
883 - symconst_type_size The symbolic constant represents the size of a type.
884 The type of which the constant represents the size
886 - symconst_type_align The symbolic constant represents the alignment of a
887 type. The type of which the constant represents the
888 size is given explicitly.
889 - symconst_addr_ent The symbolic constant represents the address of an
890 entity (variable or method). The variable is given
891 explicitly by a firm entity.
892 - symconst_ofs_ent The symbolic constant represents the offset of an
893 entity in its owner type.
894 - symconst_enum_const The symbolic constant is a enumeration constant of
895 an enumeration type."""
897 flags = [ "constlike", "start_block" ]
905 comment = "entity whose address is returned",
908 attr_struct = "symconst_attr"
909 customSerializer = True
910 # constructor is written manually at the moment, because of the strange
915 """The Sync operation unifies several partial memory blocks. These blocks
916 have to be pairwise disjunct or the values in common locations have to
917 be identical. This operation allows to specify all operations that
918 eventually need several partial memory blocks as input with a single
919 entrance by unifying the memories with a preceding Sync operation."""
926 """Builds a Tuple from single values.
928 This is needed to implement optimizations that remove a node that produced
929 a tuple. The node can be replaced by the Tuple operation so that the
930 following Proj nodes have not to be changed. (They are hard to find due to
931 the implementation with pointers in only one direction.) The Tuple node is
932 smaller than any other node, so that a node can be changed into a Tuple by
933 just changing its opcode and giving it a new in array."""
937 flags = [ "labeled" ]
940 """Returns an unknown (at compile- and runtime) value. It is a valid
941 optimisation to replace an Unknown by any other constant value."""
944 block = "get_irg_start_block(irg)"
945 flags = [ "start_block", "constlike", "dump_noblock" ]
949 def getOpList(namespace):
951 for t in namespace.values():
955 if issubclass(t, Op):
960 nodes = getOpList(globals())
961 nodes = sorted(nodes, lambda x,y: cmp(x.name, y.name))