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
44 irop_flag_forking = 0x00000020, /**< the operation is a forking control flow */
49 * The compute value operation.
50 * This operation evaluates an IR node into a tarval if possible,
51 * returning tarval_bad otherwise.
53 typedef tarval *(*computed_value_func)(ir_node *n);
56 * The equivalent node operation.
57 * This operation returns an equivalent node for the input node.
58 * It does not create new nodes. It is therefore safe to free n
59 * if the node returned is not n.
60 * If a node returns a Tuple we can not just skip it. If the size of the
61 * in array fits, we transform n into a tuple (e.g., possible for Div).
63 typedef ir_node *(*equivalent_node_func)(ir_node *n);
66 * The transform node operation.
67 * This operation tries several [inplace] [optimizing] transformations
68 * and returns an equivalent node.
69 * The difference to equivalent_node() is that these
70 * transformations _do_ generate new nodes, and thus the old node must
71 * not be freed even if the equivalent node isn't the old one.
73 typedef ir_node *(*transform_node_func)(ir_node *n);
76 * The node attribute compare operation.
77 * Compares the nodes attributes of two nodes of identical opcode
78 * and returns 0 if the attributes are identical, 1 if they differ.
80 typedef int (*node_cmp_attr_func)(ir_node *a, ir_node *b);
83 * The reassociation operation.
84 * Called from a walker. Returns non-zero if
85 * a reassociation rule was applied.
87 typedef int (*reassociate_func)(ir_node *n);
90 * The copy attribute operation.
91 * Copy the node attributes from a 'old' node to a 'new' one.
93 typedef void (*copy_attr_func)(const ir_node *old_node, ir_node *new_node);
95 /** The type of an ir_op. */
97 opcode code; /**< the unique opcode of the op */
98 ident *name; /**< the name of the op */
99 size_t attr_size; /**< Space needed in memory for private attributes */
100 op_pin_state op_pin_state_pinned; /**< How to deal with the node in cse, pre. */
101 op_arity opar; /**< arity of operator. */
102 int op_index; /**< the index of the first data operand, 0 for most cases, 1 for Div etc. */
103 unsigned flags; /**< flags describing the behavior of the ir_op, a bitmaks of irop_flags */
106 computed_value_func computed_value; /**< evaluates a node into a tarval if possible. */
107 equivalent_node_func equivalent_node; /**< optimizes the node by returning an equivalent one. */
108 transform_node_func transform_node; /**< optimizes the node by transforming it. */
109 node_cmp_attr_func node_cmp_attr; /**< compares two node attributes. */
110 reassociate_func reassociate; /**< reassociate a tree */
111 copy_attr_func copy_attr; /**< copy node attributes */
115 * Creates a new ir operation.
117 * @param code the opcode, one of type \c opcode
118 * @param name the printable name of this opcode
119 * @param p wheater operations of this opcode are op_pin_state_pinned or floating
120 * @param flags a bitmask of irop_flags describing the behavior of the ir operation
121 * @param opar the parity of this ir operation
122 * @param op_index if the parity is oparity_unary, oparity_binary or oparity_trinary the index
123 * of the left operand
124 * @param attr_size attribute size for this ir operation
126 * @return The genenerated ir operation.
128 ir_op * new_ir_op(opcode code, const char *name, op_pin_state p,
129 unsigned flags, op_arity opar, int op_index, size_t attr_size);
132 * Frees a newly created ir operation.
134 void free_ir_op(ir_op *code);
136 /** Initialize the irop module. */
139 /** Free memory used by irop module. */
140 void finish_op(void);
143 * Copies simply all attributes stored in the old node to the new node.
144 * Assumes both have the same opcode and sufficient size.
146 void default_copy_attr(const ir_node *old_node, ir_node *new_node);
148 /** Returns the attribute size of nodes of this opcode.
149 @note Use not encouraged, internal feature. */
150 static INLINE int get_op_attr_size (const ir_op *op) {
151 return op->attr_size;
154 /** Returns non-zero if op is one of Start, End, Jmp, Cond, Return, Raise or Bad. */
155 static INLINE int is_cfopcode(const ir_op *op) {
156 return op->flags & irop_flag_cfopcode;
159 /** Returns true if the operation manipulates interprocedural control flow:
160 CallBegin, EndReg, EndExcept */
161 static INLINE int is_ip_cfopcode(const ir_op *op) {
162 return op->flags & irop_flag_ip_cfopcode;
165 /* Returns non-zero if operation is commutative */
166 static INLINE int is_op_commutative(const ir_op *op) {
167 return op->flags & irop_flag_commutative;
170 /* Returns non-zero if operation is fragile */
171 static INLINE int is_op_fragile(const ir_op *op) {
172 return op->flags & irop_flag_fragile;
175 /* Returns non-zero if operation is forking control flow */
176 static INLINE int is_op_forking(const ir_op *op) {
177 return op->flags & irop_flag_forking;
180 static INLINE opcode __get_op_code(const ir_op *op) {
184 static INLINE ident *__get_op_ident(const ir_op *op){
188 static INLINE op_pin_state __get_op_pinned(const ir_op *op) {
189 return op->op_pin_state_pinned;
193 #define get_op_code(op) __get_op_code(op)
194 #define get_op_ident(op) __get_op_ident(op)
195 #define get_op_pinned(op) __get_op_pinned(op)
198 #endif /* _IROP_T_H_ */