nsz Git - libfirm/blob - include/libfirm/irop.h

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