3 * File name: ir/ir/irop_t.h
4 * Purpose: Representation of opcode of intermediate operation -- private header.
5 * Author: Christian Schaefer
6 * Modified by: Goetz Lindenmaier
9 * Copyright: (c) 1998-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
20 /** The allowed parities */
23 oparity_unary, /**< an unary operator -- considering 'numeric' arguments. */
24 oparity_binary, /**< an binary operator -- considering 'numeric' arguments.*/
25 oparity_trinary, /**< an trinary operator -- considering 'numeric' arguments.*/
26 oparity_zero, /**< no operators, as e.g. Const. */
27 oparity_variable, /**< arity not fixed by opcode, but statically
28 known. E.g., number of arguments to call. */
29 oparity_dynamic, /**< arity depends on state of firm representation.
30 Can change by optimizations...
31 We must allocate a dynamic in array for the node! */
32 oparity_any, /**< other arity */
38 irop_flag_labeled = 0x00000001, /**< if set, Output edge labels on in-edges in vcg graph */
39 irop_flag_commutative = 0x00000002, /**< operation is commutative */
40 irop_flag_cfopcode = 0x00000004, /**< is a control flow operation */
41 irop_flag_ip_cfopcode = 0x00000008, /**< operation manipulates interprocedural control flow */
42 irop_flag_fragile = 0x00000010, /**< set if the operation can change the control flow because
48 * The compute value operation.
49 * This operation evaluates an IR node into a tarval if possible,
50 * returning tarval_bad otherwise.
52 typedef tarval *(*computed_value_func)(ir_node *n);
55 * The equivalent node operation.
56 * This operation returns an equivalent node for the input node.
57 * It does not create new nodes. It is therefore safe to free n
58 * if the node returned is not n.
59 * If a node returns a Tuple we can not just skip it. If the size of the
60 * in array fits, we transform n into a tuple (e.g., possible for Div).
62 typedef ir_node *(*equivalent_node_func)(ir_node *n);
65 * The transform node operation.
66 * This operation tries several [inplace] [optimizing] transformations
67 * and returns an equivalent node.
68 * The difference to equivalent_node() is that these
69 * transformations _do_ generate new nodes, and thus the old node must
70 * not be freed even if the equivalent node isn't the old one.
72 typedef ir_node *(*transform_node_func)(ir_node *n);
75 * The node attribute compare operation.
76 * Compares the nodes attributes of two nodes of identical opcode
77 * and returns 0 if the attributes are identical, 1 if they differ.
79 typedef int (*node_cmp_attr_func)(ir_node *a, ir_node *b);
81 /** The type of an ir_op. */
83 opcode code; /**< the unique opcode of the op */
84 ident *name; /**< the name of the op */
85 size_t attr_size; /**< Space needed in memory for private attributes */
86 op_pin_state op_pin_state_pinned; /**< How to deal with the node in cse, pre. */
87 op_arity opar; /**< arity of operator. */
88 int op_index; /**< the index of the first data operand, 0 for most cases, 1 for Div etc. */
89 unsigned flags; /**< flags describing the behavior of the ir_op, a bitmaks of irop_flags */
92 computed_value_func computed_value; /**< evaluates a node into a tarval if possible. */
93 equivalent_node_func equivalent_node; /**< optimizes the node by returning an equivalent one. */
94 transform_node_func transform_node; /**< optimizes the node by transforming it. */
95 node_cmp_attr_func node_cmp_attr; /**< compares two node attributes. */
99 * Creates a new ir operation.
101 * @param code the opcode, one of type \c opcode
102 * @param name the printable name of this opcode
103 * @param p wheater operations of this opcode are op_pin_state_pinned or floating
104 * @param flags a bitmask of irop_flags describing the behavior of the ir operation
105 * @param opar the parity of this ir operation
106 * @param op_index if the parity is oparity_unary, oparity_binary or oparity_trinary the index
107 * of the left operand
108 * @param attr_size attribute size for this ir operation
110 * @return The genenerated ir operation.
112 ir_op * new_ir_op(opcode code, const char *name, op_pin_state p,
113 unsigned flags, op_arity opar, int op_index, size_t attr_size);
116 * Frees a newly created ir operation.
118 void free_ir_op(ir_op *code);
120 /** Initialize the irop module. */
123 /** Free memory used by irop module. */
124 void finish_op(void);
126 /** Returns the attribute size of nodes of this opcode.
127 @note Use not encouraged, internal feature. */
128 static INLINE int get_op_attr_size (const ir_op *op) {
129 return op->attr_size;
132 /** Returns non-zero if op is one of Start, End, Jmp, Cond, Return, Raise or Bad. */
133 static INLINE int is_cfopcode(const ir_op *op) {
134 return op->flags & irop_flag_cfopcode;
137 /** Returns true if the operation manipulates interprocedural control flow:
138 CallBegin, EndReg, EndExcept */
139 static INLINE int is_ip_cfopcode(const ir_op *op) {
140 return op->flags & irop_flag_ip_cfopcode;
143 /* Returns non-zero if operation is commutative */
144 static INLINE int is_op_commutative(const ir_op *op) {
145 return op->flags & irop_flag_commutative;
148 /* Returns non-zero if operation is fragile */
149 static INLINE int is_op_fragile(const ir_op *op) {
150 return op->flags & irop_flag_fragile;
153 #endif /* _IROP_T_H_ */