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_labeled     = 0x00000001,   /**< if set, Output edge labels on in-edges in vcg graph */
  40   irop_flag_commutative = 0x00000002,   /**< operation is commutative */
  41   irop_flag_cfopcode    = 0x00000004,   /**< is a control flow operation */
  42   irop_flag_ip_cfopcode = 0x00000008,   /**< operation manipulates interprocedural control flow */
  43   irop_flag_fragile     = 0x00000010,   /**< set if the operation can change the control flow because
  44                                              of an exception */
  45   irop_flag_forking     = 0x00000020,   /**< the operation is a forking control flow */
  46 } irop_flags;
  47
  48
  49 /**
  50  * The compute value operation.
  51  * This operation evaluates an IR node into a tarval if possible,
  52  * returning tarval_bad otherwise.
  53  */
  54 typedef tarval *(*computed_value_func)(ir_node *n);
  55
  56 /**
  57  * The equivalent node operation.
  58  * This operation returns an equivalent node for the input node.
  59  * It does not create new nodes.  It is therefore safe to free n
  60  * if the node returned is not n.
  61  * If a node returns a Tuple we can not just skip it.  If the size of the
  62  * in array fits, we transform n into a tuple (e.g., possible for Div).
  63  */
  64 typedef ir_node *(*equivalent_node_func)(ir_node *n);
  65
  66 /**
  67  * The transform node operation.
  68  * This operation tries several [inplace] [optimizing] transformations
  69  * and returns an equivalent node.
  70  * The difference to equivalent_node() is that these
  71  * transformations _do_ generate new nodes, and thus the old node must
  72  * not be freed even if the equivalent node isn't the old one.
  73  */
  74 typedef ir_node *(*transform_node_func)(ir_node *n);
  75
  76 /**
  77  * The node attribute compare operation.
  78  * Compares the nodes attributes of two nodes of identical opcode
  79  * and returns 0 if the attributes are identical, 1 if they differ.
  80  */
  81 typedef int (*node_cmp_attr_func)(ir_node *a, ir_node *b);
  82
  83 /**
  84  * The reassociation operation.
  85  * Called from a walker.  Returns non-zero if
  86  * a reassociation rule was applied.
  87  * The pointer n is set to the newly created node, if some reassociation
  88  * was applied.
  89  */
  90 typedef int (*reassociate_func)(ir_node **n);
  91
  92 /**
  93  * The copy attribute operation.
  94  * Copy the node attributes from a 'old' node to a 'new' one.
  95  */
  96 typedef void (*copy_attr_func)(const ir_node *old_node, ir_node *new_node);
  97
  98 /** The type of an ir_op. */
  99 struct ir_op {
 100   opcode code;            /**< the unique opcode of the op */
 101   ident *name;            /**< the name of the op */
 102   size_t attr_size;       /**< Space needed in memory for private attributes */
 103   op_pin_state op_pin_state_pinned; /**< How to deal with the node in cse, pre. */
 104   op_arity opar;          /**< arity of operator. */
 105   int op_index;           /**< the index of the first data operand, 0 for most cases, 1 for Div etc. */
 106   unsigned flags;         /**< flags describing the behavior of the ir_op, a bitmaks of irop_flags */
 107
 108   /* CallBacks */
 109   computed_value_func   computed_value;         /**< evaluates a node into a tarval if possible. */
 110   equivalent_node_func  equivalent_node;        /**< optimizes the node by returning an equivalent one. */
 111   transform_node_func   transform_node;         /**< optimizes the node by transforming it. */
 112   node_cmp_attr_func    node_cmp_attr;          /**< compares two node attributes. */
 113   reassociate_func      reassociate;            /**< reassociate a tree */
 114   copy_attr_func        copy_attr;              /**< copy node attributes */
 115 };
 116
 117 /**
 118  * Creates a new ir operation.
 119  *
 120  * @param code      the opcode, one of type \c opcode
 121  * @param name      the printable name of this opcode
 122  * @param p         wheater operations of this opcode are op_pin_state_pinned or floating
 123  * @param flags     a bitmask of irop_flags describing the behavior of the ir operation
 124  * @param opar      the parity of this ir operation
 125  * @param op_index  if the parity is oparity_unary, oparity_binary or oparity_trinary the index
 126  *                  of the left operand
 127  * @param attr_size attribute size for this ir operation
 128  *
 129  * @return The genenerated ir operation.
 130  */
 131 ir_op * new_ir_op(opcode code, const char *name, op_pin_state p,
 132                    unsigned flags, op_arity opar, int op_index, size_t attr_size);
 133
 134 /**
 135  * Frees a newly created ir operation.
 136  */
 137 void free_ir_op(ir_op *code);
 138
 139 /** Initialize the irop module. */
 140 void init_op(void);
 141
 142 /** Free memory used by irop module. */
 143 void finish_op(void);
 144
 145 /**
 146  * Copies simply all attributes stored in the old node to the new node.
 147  * Assumes both have the same opcode and sufficient size.
 148  */
 149 void default_copy_attr(const ir_node *old_node, ir_node *new_node);
 150
 151 /** Returns the attribute size of nodes of this opcode.
 152    @note Use not encouraged, internal feature. */
 153 static INLINE int get_op_attr_size (const ir_op *op) {
 154   return op->attr_size;
 155 }
 156
 157 /** Returns non-zero if op is one of Start, End, Jmp, Cond, Return, Raise or Bad. */
 158 static INLINE int is_cfopcode(const ir_op *op) {
 159   return op->flags & irop_flag_cfopcode;
 160 }
 161
 162 /** Returns true if the operation manipulates interprocedural control flow:
 163    CallBegin, EndReg, EndExcept */
 164 static INLINE int is_ip_cfopcode(const ir_op *op) {
 165   return op->flags & irop_flag_ip_cfopcode;
 166 }
 167
 168 /* Returns non-zero if operation is commutative */
 169 static INLINE int is_op_commutative(const ir_op *op) {
 170   return op->flags & irop_flag_commutative;
 171 }
 172
 173 /* Returns non-zero if operation is fragile */
 174 static INLINE int is_op_fragile(const ir_op *op) {
 175   return op->flags & irop_flag_fragile;
 176 }
 177
 178 /* Returns non-zero if operation is forking control flow */
 179 static INLINE int is_op_forking(const ir_op *op) {
 180   return op->flags & irop_flag_forking;
 181 }
 182
 183 static INLINE opcode __get_op_code(const ir_op *op) {
 184   return op->code;
 185 }
 186
 187 static INLINE ident *__get_op_ident(const ir_op *op){
 188   return op->name;
 189 }
 190
 191 static INLINE op_pin_state __get_op_pinned(const ir_op *op) {
 192   return op->op_pin_state_pinned;
 193 }
 194
 195
 196 #define get_op_code(op)         __get_op_code(op)
 197 #define get_op_ident(op)        __get_op_ident(op)
 198 #define get_op_pinned(op)       __get_op_pinned(op)
 199
 200
 201 #endif /* _IROP_T_H_ */