nsz Git - libfirm/blob - ir/ir/irop_t.h

   1 /*
   2  * Project:     libFIRM
   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
   7  * Created:
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 1998-2003 Universität Karlsruhe
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12
  13
  14 # ifndef _IROP_T_H_
  15 # define _IROP_T_H_
  16
  17 # include "irop.h"
  18 # include "tv.h"
  19 # include "irnode.h"
  20
  21 /** The allowed parities */
  22 typedef enum {
  23   oparity_invalid = 0,
  24   oparity_unary,              /**< an unary operator -- considering 'numeric' arguments. */
  25   oparity_binary,             /**< an binary operator  -- considering 'numeric' arguments.*/
  26   oparity_trinary,            /**< an trinary operator  -- considering 'numeric' arguments.*/
  27   oparity_zero,               /**< no operators, as e.g. Const. */
  28   oparity_variable,           /**< arity not fixed by opcode, but statically
  29                                  known.  E.g., number of arguments to call. */
  30   oparity_dynamic,            /**< arity depends on state of firm representation.
  31                                  Can change by optimizations...
  32                                  We must allocate a dynamic in array for the node! */
  33   oparity_any,                /**< other arity */
  34 } op_arity;
  35
  36
  37 /** The irop flags */
  38 typedef enum {
  39   irop_flag_none        = 0x00000000,   /**< nothing */
  40   irop_flag_labeled     = 0x00000001,   /**< if set, Output edge labels on in-edges in vcg graph */
  41   irop_flag_commutative = 0x00000002,   /**< operation is commutative */
  42   irop_flag_cfopcode    = 0x00000004,   /**< is a control flow operation */
  43   irop_flag_ip_cfopcode = 0x00000008,   /**< operation manipulates interprocedural control flow */
  44   irop_flag_fragile     = 0x00000010,   /**< set if the operation can change the control flow because
  45                                              of an exception */
  46   irop_flag_forking     = 0x00000020,   /**< the operation is a forking control flow */
  47 } irop_flags;
  48
  49
  50 /**
  51  * The compute value operation.
  52  * This operation evaluates an IR node into a tarval if possible,
  53  * returning tarval_bad otherwise.
  54  */
  55 typedef tarval *(*computed_value_func)(ir_node *self);
  56
  57 /**
  58  * The equivalent node operation.
  59  * This operation returns an equivalent node for the input node.
  60  * It does not create new nodes.  It is therefore safe to free self
  61  * if the node returned is not self.
  62  * If a node returns a Tuple we can not just skip it.  If the size of the
  63  * in array fits, we transform n into a tuple (e.g., possible for Div).
  64  */
  65 typedef ir_node *(*equivalent_node_func)(ir_node *self);
  66
  67 /**
  68  * The transform node operation.
  69  * This operation tries several [inplace] [optimizing] transformations
  70  * and returns an equivalent node.
  71  * The difference to equivalent_node() is that these
  72  * transformations _do_ generate new nodes, and thus the old node must
  73  * not be freed even if the equivalent node isn't the old one.
  74  */
  75 typedef ir_node *(*transform_node_func)(ir_node *self);
  76
  77 /**
  78  * The node attribute compare operation.
  79  * Compares the nodes attributes of two nodes of identical opcode
  80  * and returns 0 if the attributes are identical, 1 if they differ.
  81  */
  82 typedef int (*node_cmp_attr_func)(ir_node *a, ir_node *b);
  83
  84 /**
  85  * The reassociation operation.
  86  * Called from a walker.  Returns non-zero if
  87  * a reassociation rule was applied.
  88  * The pointer n is set to the newly created node, if some reassociation
  89  * was applied.
  90  */
  91 typedef int (*reassociate_func)(ir_node **n);
  92
  93 /**
  94  * The copy attribute operation.
  95  * Copy the node attributes from a 'old' node to a 'new' one.
  96  */
  97 typedef void (*copy_attr_func)(const ir_node *old_node, ir_node *new_node);
  98
  99 /**
 100  * The get_type operation.
 101  * Return the type of the node self.
 102  */
 103 typedef type *(*get_type_func)(ir_node *self);
 104
 105 /**
 106  * The verify_node operation.
 107  * Return non-zero if the node verification is ok, else 0.
 108  * Depending on the node verification settings, may even assert.
 109  *
 110  * @see do_node_verification()
 111  */
 112 typedef int (*verify_node_func)(ir_node *self, ir_graph *irg);
 113
 114 /**
 115  * The verify_node operation for Proj(X).
 116  * Return non-zero if the node verification is ok, else 0.
 117  * Depending on the node verification settings, may even assert.
 118  *
 119  * @see do_node_verification()
 120  */
 121 typedef int (*verify_proj_node_func)(ir_node *self, ir_node *proj);
 122
 123 /** The type of an ir_op. */
 124 struct ir_op {
 125   opcode code;            /**< the unique opcode of the op */
 126   ident *name;            /**< the name of the op */
 127   size_t attr_size;       /**< Space needed in memory for private attributes */
 128   op_pin_state op_pin_state_pinned; /**< How to deal with the node in cse, pre. */
 129   op_arity opar;          /**< arity of operator. */
 130   int op_index;           /**< the index of the first data operand, 0 for most cases, 1 for Div etc. */
 131   unsigned flags;         /**< flags describing the behavior of the ir_op, a bitmaks of irop_flags */
 132
 133   /* CallBacks */
 134   computed_value_func   computed_value;         /**< evaluates a node into a tarval if possible. */
 135   equivalent_node_func  equivalent_node;        /**< optimizes the node by returning an equivalent one. */
 136   transform_node_func   transform_node;         /**< optimizes the node by transforming it. */
 137   node_cmp_attr_func    node_cmp_attr;          /**< compares two node attributes. */
 138   reassociate_func      reassociate;            /**< reassociate a tree */
 139   copy_attr_func        copy_attr;              /**< copy node attributes */
 140   get_type_func         get_type;               /**< return the type of a node */
 141   verify_node_func      verify_node;            /**< verify the node */
 142   verify_proj_node_func verify_proj_node;       /**< verify the Proj node */
 143 };
 144
 145 /**
 146  * Creates a new ir operation.
 147  *
 148  * @param code      the opcode, one of type \c opcode
 149  * @param name      the printable name of this opcode
 150  * @param p         wheater operations of this opcode are op_pin_state_pinned or floating
 151  * @param flags     a bitmask of irop_flags describing the behavior of the ir operation
 152  * @param opar      the parity of this ir operation
 153  * @param op_index  if the parity is oparity_unary, oparity_binary or oparity_trinary the index
 154  *                  of the left operand
 155  * @param attr_size attribute size for this ir operation
 156  *
 157  * @return The genenerated ir operation.
 158  */
 159 ir_op * new_ir_op(opcode code, const char *name, op_pin_state p,
 160                    unsigned flags, op_arity opar, int op_index, size_t attr_size);
 161
 162 /**
 163  * Frees a newly created ir operation.
 164  */
 165 void free_ir_op(ir_op *code);
 166
 167 /** Initialize the irop module. */
 168 void init_op(void);
 169
 170 /** Free memory used by irop module. */
 171 void finish_op(void);
 172
 173 /**
 174  * Copies simply all attributes stored in the old node to the new node.
 175  * Assumes both have the same opcode and sufficient size.
 176  */
 177 void default_copy_attr(const ir_node *old_node, ir_node *new_node);
 178
 179 /** Returns the attribute size of nodes of this opcode.
 180    @note Use not encouraged, internal feature. */
 181 static INLINE int get_op_attr_size (const ir_op *op) {
 182   return op->attr_size;
 183 }
 184
 185 /** Returns non-zero if op is one of Start, End, Jmp, Cond, Return, Raise or Bad. */
 186 static INLINE int is_cfopcode(const ir_op *op) {
 187   return op->flags & irop_flag_cfopcode;
 188 }
 189
 190 /** Returns true if the operation manipulates interprocedural control flow:
 191    CallBegin, EndReg, EndExcept */
 192 static INLINE int is_ip_cfopcode(const ir_op *op) {
 193   return op->flags & irop_flag_ip_cfopcode;
 194 }
 195
 196 /* Returns non-zero if operation is commutative */
 197 static INLINE int is_op_commutative(const ir_op *op) {
 198   return op->flags & irop_flag_commutative;
 199 }
 200
 201 /* Returns non-zero if operation is fragile */
 202 static INLINE int is_op_fragile(const ir_op *op) {
 203   return op->flags & irop_flag_fragile;
 204 }
 205
 206 /* Returns non-zero if operation is forking control flow */
 207 static INLINE int is_op_forking(const ir_op *op) {
 208   return op->flags & irop_flag_forking;
 209 }
 210
 211 static INLINE opcode __get_op_code(const ir_op *op) {
 212   return op->code;
 213 }
 214
 215 static INLINE ident *__get_op_ident(const ir_op *op){
 216   return op->name;
 217 }
 218
 219 static INLINE op_pin_state __get_op_pinned(const ir_op *op) {
 220   return op->op_pin_state_pinned;
 221 }
 222
 223
 224 #define get_op_code(op)         __get_op_code(op)
 225 #define get_op_ident(op)        __get_op_ident(op)
 226 #define get_op_pinned(op)       __get_op_pinned(op)
 227
 228
 229 #endif /* _IROP_T_H_ */