1 /* 2 * Copyright (C) 1995-2011 University of Karlsruhe. All right reserved. 3 * 4 * This file is part of libFirm. 5 * 6 * This file may be distributed and/or modified under the terms of the 7 * GNU General Public License version 2 as published by the Free Software 8 * Foundation and appearing in the file LICENSE.GPL included in the 9 * packaging of this file. 10 * 11 * Licensees holding valid libFirm Professional Edition licenses may use 12 * this file in accordance with the libFirm Commercial License. 13 * Agreement provided with the Software. 14 * 15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE 16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR 17 * PURPOSE. 18 */ 19 20 /** 21 * @file 22 * @brief Representation of opcode of intermediate operation. 23 * @author Christian Schaefer, Goetz Lindenmaier, Michael Beck 24 * @brief Operators of firm nodes. 25 */ 26 #ifndef FIRM_IR_IROP_H 27 #define FIRM_IR_IROP_H 28 29 #include <stdio.h> 30 #include "firm_types.h" 31 #include "ident.h" 32 #include "begin.h" 33 #include "opcodes.h" 34 35 /** 36 * @ingroup ir_node 37 * @defgroup ir_op Node Opcodes 38 * 39 * This module specifies the opcodes possible for ir nodes. Their 40 * definition is close to the operations specified in UKA Tech-Report 41 * 1999-14 42 * 43 * @{ 44 */ 45 46 /** The allowed arities. */ 47 typedef enum { 48 oparity_invalid = 0, 49 oparity_unary, /**< An unary operator -- considering 'numeric' arguments. */ 50 oparity_binary, /**< A binary operator -- considering 'numeric' arguments.*/ 51 oparity_trinary, /**< A trinary operator -- considering 'numeric' arguments.*/ 52 oparity_zero, /**< A zero arity operator, e.g. a Const. */ 53 oparity_variable, /**< The arity is not fixed by opcode, but statically 54 known. E.g., number of arguments to call. */ 55 oparity_dynamic, /**< The arity depends on state of Firm representation. 56 Can be changed by optimizations... 57 We must allocate a dynamic in array for the node! */ 58 oparity_any /**< Any other arity. */ 59 } op_arity; 60 61 62 /** The irop flags */ 63 typedef enum { 64 irop_flag_none = 0, /**< Nothing. */ 65 irop_flag_commutative = 1U << 0, /**< This operation is commutative. */ 66 irop_flag_cfopcode = 1U << 1, /**< This operation is a control flow operation. */ 67 irop_flag_fragile = 1U << 2, /**< Set if the operation can change the 68 control flow because of an exception. 69 */ 70 irop_flag_forking = 1U << 3, /**< Forking control flow at this operation. */ 71 irop_flag_highlevel = 1U << 4, /**< This operation is a pure high-level one and can be 72 skipped in low-level optimizations. */ 73 irop_flag_constlike = 1U << 5, /**< This operation has no arguments and is some 74 kind of a constant. */ 75 irop_flag_keep = 1U << 6, /**< This operation can be kept in End's keep-alive list. */ 76 irop_flag_start_block = 1U << 7, /**< This operation is always placed in the Start block. */ 77 irop_flag_uses_memory = 1U << 8, /**< This operation has a memory input and may change the memory state. */ 78 irop_flag_dump_noblock = 1U << 9, /**< node should be dumped outside any blocks */ 79 irop_flag_cse_neutral = 1U << 10, /**< This operation is CSE neutral to its users. */ 80 /** This operation jumps to an unknown destination. The CFG is a 81 * conservative aproximation in this case. You cannot change the destination 82 * of an unknown_jump */ 83 irop_flag_unknown_jump = 1U << 11, 84 } irop_flags; 85 ENUM_BITSET(irop_flags) 86 87 /** Returns the ident for the opcode name */ 88 FIRM_API ident *get_op_ident(const ir_op *op); 89 90 /** Returns the string for the opcode. */ 91 FIRM_API const char *get_op_name(const ir_op *op); 92 93 /** Returns the enum for the opcode */ 94 FIRM_API unsigned get_op_code(const ir_op *op); 95 96 /** Returns a human readable name of an op_pin_state. */ 97 FIRM_API const char *get_op_pin_state_name(op_pin_state s); 98 99 /** Returns pinned state of an opcode. */ 100 FIRM_API op_pin_state get_op_pinned(const ir_op *op); 101 102 /** Sets pinned in the opcode. Setting it to floating has no effect 103 for Block, Phi and control flow nodes. */ 104 FIRM_API void set_op_pinned(ir_op *op, op_pin_state pinned); 105 106 /** Returns the next free IR opcode number, allows to register user ops. */ 107 FIRM_API unsigned get_next_ir_opcode(void); 108 109 /** Returns the next free n IR opcode number, allows to register a bunch of user ops. */ 110 FIRM_API unsigned get_next_ir_opcodes(unsigned num); 111 112 /** 113 * A generic function pointer type. 114 */ 115 typedef void (*op_func)(void); 116 117 /** The NULL-function. */ 118 #define NULL_FUNC ((generic_func)(NULL)) 119 120 /** 121 * Returns the generic function pointer from an IR operation. 122 */ 123 FIRM_API op_func get_generic_function_ptr(const ir_op *op); 124 125 /** 126 * Stores a generic function pointer into an IR operation. 127 */ 128 FIRM_API void set_generic_function_ptr(ir_op *op, op_func func); 129 130 /** 131 * Returns the irop flags of an IR opcode. 132 */ 133 FIRM_API irop_flags get_op_flags(const ir_op *op); 134 135 /** 136 * The hash operation. 137 * This operation calculates a hash value for a given IR node. 138 */ 139 typedef unsigned (*hash_func)(const ir_node *self); 140 141 /** 142 * The compute value operation. 143 * This operation evaluates an IR node into a tarval if possible, 144 * returning tarval_bad otherwise. 145 */ 146 typedef ir_tarval *(*computed_value_func)(const ir_node *self); 147 148 /** 149 * The equivalent node operation. 150 * This operation returns an equivalent node for the input node. 151 * It does not create new nodes. It is therefore safe to free self 152 * if the node returned is not self. 153 * If a node returns a Tuple we can not just skip it. If the size of the 154 * in array fits, we transform n into a tuple (e.g., possible for Div). 155 */ 156 typedef ir_node *(*equivalent_node_func)(ir_node *self); 157 158 /** 159 * The transform node operation. 160 * This operation tries several [inplace] [optimizing] transformations 161 * and returns an equivalent node. 162 * The difference to equivalent_node() is that these 163 * transformations _do_ generate new nodes, and thus the old node must 164 * not be freed even if the equivalent node isn't the old one. 165 */ 166 typedef ir_node *(*transform_node_func)(ir_node *self); 167 168 /** 169 * The node attribute compare operation. 170 * Compares the nodes attributes of two nodes of identical opcode 171 * and returns 0 if the attributes are identical, 1 if they differ. 172 */ 173 typedef int (*node_cmp_attr_func)(const ir_node *a, const ir_node *b); 174 175 /** 176 * The reassociation operation. 177 * Called from a walker. Returns non-zero if 178 * a reassociation rule was applied. 179 * The pointer n is set to the newly created node, if some reassociation 180 * was applied. 181 */ 182 typedef int (*reassociate_func)(ir_node **n); 183 184 /** 185 * The copy attribute operation. 186 * Copy the node attributes from an 'old' node to a 'new' one. 187 */ 188 typedef void (*copy_attr_func)(ir_graph *irg, const ir_node *old_node, ir_node *new_node); 189 190 /** 191 * The get_type_attr operation. Used to traverse all types that can be 192 * accessed from an ir_graph. 193 * Returns the type attribute of the node self. 194 */ 195 typedef ir_type *(*get_type_attr_func)(const ir_node *self); 196 197 /** 198 * The get_entity_attr operation. Used to traverse all entities that can be 199 * accessed from an ir_graph. 200 * Returns the entity attribute of the node self. 201 */ 202 typedef ir_entity *(*get_entity_attr_func)(const ir_node *self); 203 204 /** 205 * The verify_node operation. 206 * Returns non-zero if the node verification is ok, else 0. 207 * Depending on the node verification settings, may even assert. 208 * 209 * @see do_node_verification() 210 */ 211 typedef int (*verify_node_func)(const ir_node *node); 212 213 /** 214 * The verify_node operation for Proj(X). 215 * Returns non-zero if the node verification is ok, else 0. 216 * Depending on the node verification settings, may even assert. 217 * 218 * @see do_node_verification() 219 */ 220 typedef int (*verify_proj_node_func)(const ir_node *proj); 221 222 /** 223 * Reasons to call the dump_node operation: 224 */ 225 typedef enum { 226 dump_node_opcode_txt, /**< Dump the opcode. */ 227 dump_node_mode_txt, /**< Dump the mode. */ 228 dump_node_nodeattr_txt, /**< Dump node attributes to be shown in the label. */ 229 dump_node_info_txt /**< Dump node attributes into info1. */ 230 } dump_reason_t; 231 232 /** 233 * The dump_node operation. 234 * Writes several informations requested by reason to 235 * an output file 236 */ 237 typedef void (*dump_node_func)(FILE *out, const ir_node *self, dump_reason_t reason); 238 239 /** 240 * io_op Operations. 241 */ 242 typedef struct { 243 hash_func hash; /**< Calculate a hash value for an IR node. */ 244 computed_value_func computed_value; /**< Evaluates a node into a tarval if possible. */ 245 computed_value_func computed_value_Proj; /**< Evaluates a Proj node into a tarval if possible. */ 246 equivalent_node_func equivalent_node; /**< Optimizes the node by returning an equivalent one. */ 247 equivalent_node_func equivalent_node_Proj; /**< Optimizes the Proj node by returning an equivalent one. */ 248 transform_node_func transform_node; /**< Optimizes the node by transforming it. */ 249 transform_node_func transform_node_Proj; /**< Optimizes the Proj node by transforming it. */ 250 node_cmp_attr_func node_cmp_attr; /**< Compares two node attributes. */ 251 reassociate_func reassociate; /**< Reassociate a tree. */ 252 copy_attr_func copy_attr; /**< Copy node attributes. */ 253 get_type_attr_func get_type_attr; /**< Returns the type attribute of a node. */ 254 get_entity_attr_func get_entity_attr; /**< Returns the entity attribute of a node. */ 255 verify_node_func verify_node; /**< Verify the node. */ 256 verify_proj_node_func verify_proj_node; /**< Verify the Proj node. */ 257 dump_node_func dump_node; /**< Dump a node. */ 258 op_func generic; /**< A generic function pointer. */ 259 op_func generic1; /**< A generic function pointer. */ 260 op_func generic2; /**< A generic function pointer. */ 261 const arch_irn_ops_t *be_ops; /**< callbacks used by the backend. */ 262 } ir_op_ops; 263 264 /** 265 * Creates a new IR operation. 266 * 267 * @param code the opcode, one of type \c opcode 268 * @param name the printable name of this opcode 269 * @param p whether operations of this opcode are op_pin_state_pinned or floating 270 * @param flags a bitmask of irop_flags describing the behavior of the IR operation 271 * @param opar the parity of this IR operation 272 * @param op_index if the parity is oparity_unary, oparity_binary or oparity_trinary the index 273 * of the left operand 274 * @param attr_size attribute size for this IR operation 275 * 276 * @return The generated IR operation. 277 * 278 * This function can create all standard Firm opcode as well as new ones. 279 * The behavior of new opcode depends on the operations \c ops and the \c flags. 280 */ 281 FIRM_API ir_op *new_ir_op(unsigned code, const char *name, op_pin_state p, 282 irop_flags flags, op_arity opar, int op_index, 283 size_t attr_size); 284 285 /** Returns one more than the highest opcode code in use. */ 286 FIRM_API unsigned ir_get_n_opcodes(void); 287 288 /** 289 * Returns the opcode with code @p code. 290 * 291 * @p code has to be smaller than get_irp_n_opcode(), returns NULL if 292 * no opcode with the code exists. 293 */ 294 FIRM_API ir_op *ir_get_opcode(unsigned code); 295 296 /** Sets the generic function pointer of all opcodes to NULL */ 297 FIRM_API void ir_clear_opcodes_generic_func(void); 298 299 /** 300 * Sets memory input of operation using memory 301 */ 302 FIRM_API void ir_op_set_memory_index(ir_op *op, int memory_index); 303 304 /** 305 * Sets proj-number for X_regular and X_except projs of fragile nodes. 306 * Note: should only be used immediately after new_ir_op 307 */ 308 FIRM_API void ir_op_set_fragile_indices(ir_op *op, int pn_x_regular, 309 int pn_x_except); 310 311 /** Returns the ir_op_ops of an ir_op. */ 312 FIRM_API ir_op_ops *get_op_ops(ir_op *op); 313 314 /** @} */ 315 316 #include "end.h" 317 318 #endif 319