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

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/ir/irop.h
   4  * Purpose:     Representation of opcode of intermediate operation.
   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  * @file irop.h
  15  *
  16  * Operators of firm nodes.
  17  *
  18  * @author Christian Schaefer
  19  *
  20  *  This module specifies the opcodes possible for ir nodes.  Their
  21  *  definition is close to the operations specified in UKA Tech-Report
  22  *  1999-14
  23  */
  24 #ifndef _IROP_H_
  25 #define _IROP_H_
  26
  27 #include "firm_types.h"
  28
  29 #include <stdio.h>
  30 #include "ident.h"
  31
  32 /** The allowed parities */
  33 typedef enum {
  34   oparity_invalid = 0,
  35   oparity_unary,              /**< an unary operator -- considering 'numeric' arguments. */
  36   oparity_binary,             /**< an binary operator  -- considering 'numeric' arguments.*/
  37   oparity_trinary,            /**< an trinary operator  -- considering 'numeric' arguments.*/
  38   oparity_zero,               /**< no operators, as e.g. Const. */
  39   oparity_variable,           /**< arity not fixed by opcode, but statically
  40                                                            known.  E.g., number of arguments to call. */
  41   oparity_dynamic,            /**< arity depends on state of firm representation.
  42                                                      Can change by optimizations...
  43                                                      We must allocate a dynamic in array for the node! */
  44   oparity_any                 /**< other arity */
  45 } op_arity;
  46
  47
  48 /** The irop flags */
  49 typedef enum {
  50   irop_flag_none        = 0x00000000, /**< nothing */
  51   irop_flag_labeled     = 0x00000001,   /**< if set, Output edge labels on in-edges in vcg graph */
  52   irop_flag_commutative = 0x00000002,   /**< operation is commutative */
  53   irop_flag_cfopcode    = 0x00000004, /**< is a control flow operation */
  54   irop_flag_ip_cfopcode = 0x00000008,   /**< operation manipulates interprocedural control flow */
  55   irop_flag_fragile     = 0x00000010,   /**< set if the operation can change the control flow because
  56                                              of an exception */
  57   irop_flag_forking     = 0x00000020, /**< the operation is a forking control flow */
  58   irop_flag_highlevel   = 0x00000040, /**< the operation is a pure high-level one and can be
  59                                            skipped in low-level optimizations */
  60   irop_flag_constlike   = 0x00000080  /**< the operation has no arguments and is some
  61                                            kind of a constant */
  62 } irop_flags;
  63
  64 /** The opcodes of the libFirm predefined operations. */
  65 typedef enum {
  66   iro_Block,
  67   iro_Start, iro_End, iro_Jmp, iro_IJmp, iro_Cond, iro_Return, iro_Raise,
  68   iro_Const, iro_SymConst,
  69   iro_Sel,  iro_InstOf,
  70   iro_Call, iro_Add, iro_Sub, iro_Minus, iro_Mul, iro_Quot, iro_DivMod,
  71   iro_Div,  iro_Mod, iro_Abs, iro_And, iro_Or, iro_Eor, iro_Not,
  72   iro_Cmp,  iro_Shl, iro_Shr, iro_Shrs, iro_Rot, iro_Conv, iro_Cast,
  73   iro_Phi,
  74   iro_Load, iro_Store, iro_Alloc, iro_Free, iro_Sync,
  75   iro_Proj, iro_Tuple, iro_Id, iro_Bad, iro_Confirm,
  76   iro_Unknown, iro_Filter, iro_Break, iro_CallBegin, iro_EndReg, iro_EndExcept,
  77   iro_NoMem, iro_Mux, iro_CopyB, iro_Bound,
  78   iro_MaxOpcode
  79 } opcode;
  80
  81 typedef struct ir_op ir_op;
  82
  83 extern ir_op *op_Block;           ir_op *get_op_Block     (void);
  84
  85 extern ir_op *op_Start;           ir_op *get_op_Start     (void);
  86 extern ir_op *op_End;             ir_op *get_op_End       (void);
  87 extern ir_op *op_Jmp;             ir_op *get_op_Jmp       (void);
  88 extern ir_op *op_IJmp;            ir_op *get_op_IJmp      (void);
  89 extern ir_op *op_Cond;            ir_op *get_op_Cond      (void);
  90 extern ir_op *op_Return;          ir_op *get_op_Return    (void);
  91 extern ir_op *op_Raise;           ir_op *get_op_Raise     (void);
  92 extern ir_op *op_Sel;             ir_op *get_op_Sel       (void);
  93 extern ir_op *op_InstOf;          ir_op *get_op_InstOf    (void);
  94
  95 extern ir_op *op_Const;           ir_op *get_op_Const     (void);
  96 extern ir_op *op_SymConst;        ir_op *get_op_SymConst  (void);
  97
  98 extern ir_op *op_Call;            ir_op *get_op_Call      (void);
  99 extern ir_op *op_Add;             ir_op *get_op_Add       (void);
 100 extern ir_op *op_Sub;             ir_op *get_op_Sub       (void);
 101 extern ir_op *op_Minus;           ir_op *get_op_Minus     (void);
 102 extern ir_op *op_Mul;             ir_op *get_op_Mul       (void);
 103 extern ir_op *op_Quot;            ir_op *get_op_Quot      (void);
 104 extern ir_op *op_DivMod;          ir_op *get_op_DivMod    (void);
 105 extern ir_op *op_Div;             ir_op *get_op_Div       (void);
 106 extern ir_op *op_Mod;             ir_op *get_op_Mod       (void);
 107 extern ir_op *op_Abs;             ir_op *get_op_Abs       (void);
 108 extern ir_op *op_And;             ir_op *get_op_And       (void);
 109 extern ir_op *op_Or;              ir_op *get_op_Or        (void);
 110 extern ir_op *op_Eor;             ir_op *get_op_Eor       (void);
 111 extern ir_op *op_Not;             ir_op *get_op_Not       (void);
 112 extern ir_op *op_Cmp;             ir_op *get_op_Cmp       (void);
 113 extern ir_op *op_Shl;             ir_op *get_op_Shl       (void);
 114 extern ir_op *op_Shr;             ir_op *get_op_Shr       (void);
 115 extern ir_op *op_Shrs;            ir_op *get_op_Shrs      (void);
 116 extern ir_op *op_Rot;             ir_op *get_op_Rot       (void);
 117 extern ir_op *op_Conv;            ir_op *get_op_Conv      (void);
 118 extern ir_op *op_Cast;            ir_op *get_op_Cast      (void);
 119
 120 extern ir_op *op_Phi;             ir_op *get_op_Phi       (void);
 121
 122 extern ir_op *op_Load;            ir_op *get_op_Load      (void);
 123 extern ir_op *op_Store;           ir_op *get_op_Store     (void);
 124 extern ir_op *op_Alloc;           ir_op *get_op_Alloc     (void);
 125 extern ir_op *op_Free;            ir_op *get_op_Free      (void);
 126
 127 extern ir_op *op_Sync;            ir_op *get_op_Sync      (void);
 128
 129 extern ir_op *op_Tuple;           ir_op *get_op_Tuple     (void);
 130 extern ir_op *op_Proj;            ir_op *get_op_Proj      (void);
 131 extern ir_op *op_Id;              ir_op *get_op_Id        (void);
 132 extern ir_op *op_Bad;             ir_op *get_op_Bad       (void);
 133 extern ir_op *op_Confirm;         ir_op *get_op_Confirm   (void);
 134
 135 extern ir_op *op_Unknown;         ir_op *get_op_Unknown   (void);
 136 extern ir_op *op_Filter;          ir_op *get_op_Filter    (void);
 137 extern ir_op *op_Break;           ir_op *get_op_Break     (void);
 138 extern ir_op *op_CallBegin;       ir_op *get_op_CallBegin (void);
 139 extern ir_op *op_EndReg;          ir_op *get_op_EndReg    (void);
 140 extern ir_op *op_EndExcept;       ir_op *get_op_EndExcept (void);
 141
 142 extern ir_op *op_NoMem;           ir_op *get_op_NoMem     (void);
 143 extern ir_op *op_Mux;             ir_op *get_op_Mux       (void);
 144 extern ir_op *op_CopyB;           ir_op *get_op_CopyB     (void);
 145 extern ir_op *op_Bound;           ir_op *get_op_Bound     (void);
 146
 147 /** Returns the ident for the opcode name */
 148 ident *get_op_ident(const ir_op *op);
 149
 150 /** Returns the string for the opcode. */
 151 const char *get_op_name(const ir_op *op);
 152
 153 /** Returns the enum for the opcode */
 154 opcode get_op_code(const ir_op *op);
 155
 156 /** op_pin_state_pinned states */
 157 typedef enum {
 158   op_pin_state_floats = 0,    /**< Nodes of this opcode can be placed in any basic block. */
 159   op_pin_state_pinned,        /**< Nodes must remain in this basic block. */
 160   op_pin_state_exc_pinned,    /**< Node must be remain in this basic block if it can throw an
 161                                    exception, else can float. Used internally. */
 162   op_pin_state_mem_pinned     /**< Node must be remain in this basic block if it can throw an
 163                                    exception or uses memory, else can float. Used internally. */
 164 } op_pin_state;
 165
 166 const char *get_op_pin_state_name(op_pin_state s);
 167
 168 /** gets pinned state of an opcode */
 169 op_pin_state get_op_pinned(const ir_op *op);
 170
 171 /** Sets pinned in the opcode.  Setting it to floating has no effect
 172    for Block, Phi and control flow nodes. */
 173 void set_op_pinned(ir_op *op, op_pin_state pinned);
 174
 175 /** Returns the next free IR opcode number, allows to register user ops */
 176 unsigned get_next_ir_opcode(void);
 177
 178 /**
 179  * A generic function pointer.
 180  */
 181 typedef void (*op_func)(void);
 182
 183 /** The NULL-function. */
 184 #define NULL_FUNC       ((generic_func)(NULL))
 185
 186 /**
 187  * Returns the generic function pointer from an ir operation.
 188  */
 189 op_func get_generic_function_ptr(const ir_op *op);
 190
 191 /**
 192  * Store a generic function pointer into an ir operation.
 193  */
 194 void set_generic_function_ptr(ir_op *op, op_func func);
 195
 196 /**
 197  * The compute value operation.
 198  * This operation evaluates an IR node into a tarval if possible,
 199  * returning tarval_bad otherwise.
 200  */
 201 typedef tarval *(*computed_value_func)(ir_node *self);
 202
 203 /**
 204  * The equivalent node operation.
 205  * This operation returns an equivalent node for the input node.
 206  * It does not create new nodes.  It is therefore safe to free self
 207  * if the node returned is not self.
 208  * If a node returns a Tuple we can not just skip it.  If the size of the
 209  * in array fits, we transform n into a tuple (e.g., possible for Div).
 210  */
 211 typedef ir_node *(*equivalent_node_func)(ir_node *self);
 212
 213 /**
 214  * The transform node operation.
 215  * This operation tries several [inplace] [optimizing] transformations
 216  * and returns an equivalent node.
 217  * The difference to equivalent_node() is that these
 218  * transformations _do_ generate new nodes, and thus the old node must
 219  * not be freed even if the equivalent node isn't the old one.
 220  */
 221 typedef ir_node *(*transform_node_func)(ir_node *self);
 222
 223 /**
 224  * The node attribute compare operation.
 225  * Compares the nodes attributes of two nodes of identical opcode
 226  * and returns 0 if the attributes are identical, 1 if they differ.
 227  */
 228 typedef int (*node_cmp_attr_func)(ir_node *a, ir_node *b);
 229
 230 /**
 231  * The reassociation operation.
 232  * Called from a walker.  Returns non-zero if
 233  * a reassociation rule was applied.
 234  * The pointer n is set to the newly created node, if some reassociation
 235  * was applied.
 236  */
 237 typedef int (*reassociate_func)(ir_node **n);
 238
 239 /**
 240  * The copy attribute operation.
 241  * Copy the node attributes from a 'old' node to a 'new' one.
 242  */
 243 typedef void (*copy_attr_func)(const ir_node *old_node, ir_node *new_node);
 244
 245 /**
 246  * The get_type operation.
 247  * Return the type of the node self.
 248  */
 249 typedef ir_type *(*get_type_func)(ir_node *self);
 250
 251 /**
 252  * The get_type_attr operation. Used to traverse all types that can be
 253  * accessed from an ir_graph.
 254  * Return the type attribute of the node self.
 255  */
 256 typedef ir_type *(*get_type_attr_func)(ir_node *self);
 257
 258 /**
 259  * The get_entity_attr operation. Used to traverse all entities that can be
 260  * accessed from an ir_graph.
 261  * Return the entity attribute of the node self.
 262  */
 263 typedef entity *(*get_entity_attr_func)(ir_node *self);
 264
 265 /**
 266  * The verify_node operation.
 267  * Return non-zero if the node verification is ok, else 0.
 268  * Depending on the node verification settings, may even assert.
 269  *
 270  * @see do_node_verification()
 271  */
 272 typedef int (*verify_node_func)(ir_node *self, ir_graph *irg);
 273
 274 /**
 275  * The verify_node operation for Proj(X).
 276  * Return non-zero if the node verification is ok, else 0.
 277  * Depending on the node verification settings, may even assert.
 278  *
 279  * @see do_node_verification()
 280  */
 281 typedef int (*verify_proj_node_func)(ir_node *self, ir_node *proj);
 282
 283 /**
 284  * Reasons to call the dump_node operation:
 285  */
 286 typedef enum {
 287   dump_node_opcode_txt,   /**< dump the opcode */
 288   dump_node_mode_txt,     /**< dump the mode */
 289   dump_node_nodeattr_txt, /**< dump node attributes to be shown in the label */
 290   dump_node_info_txt      /**< dump node attributes into info1 */
 291 } dump_reason_t;
 292
 293 /**
 294  * The dump_node operation.
 295  * Writes several informations requested by reason to
 296  * an output file
 297  */
 298 typedef int (*dump_node_func)(ir_node *self, FILE *F, dump_reason_t reason);
 299
 300 /**
 301  * io_op Operations.
 302  */
 303 typedef struct {
 304   computed_value_func     computed_value;   /**< evaluates a node into a tarval if possible. */
 305   equivalent_node_func  equivalent_node;  /**< optimizes the node by returning an equivalent one. */
 306   transform_node_func   transform_node;   /**< optimizes the node by transforming it. */
 307   node_cmp_attr_func    node_cmp_attr;    /**< compares two node attributes. */
 308   reassociate_func      reassociate;      /**< reassociate a tree */
 309   copy_attr_func        copy_attr;        /**< copy node attributes */
 310   get_type_func         get_type;         /**< return the type of a node */
 311   get_type_attr_func    get_type_attr;    /**< return the type attribute of a node */
 312   get_entity_attr_func  get_entity_attr;  /**< return the entity attribute of a node */
 313   verify_node_func      verify_node;      /**< verify the node */
 314   verify_proj_node_func verify_proj_node; /**< verify the Proj node */
 315   dump_node_func        dump_node;        /**< dump a node */
 316   op_func               generic;          /**< a generic function */
 317 } ir_op_ops;
 318
 319 /**
 320  * Creates a new ir operation.
 321  *
 322  * @param code      the opcode, one of type \c opcode
 323  * @param name      the printable name of this opcode
 324  * @param p         whether operations of this opcode are op_pin_state_pinned or floating
 325  * @param flags     a bitmask of irop_flags describing the behavior of the ir operation
 326  * @param opar      the parity of this ir operation
 327  * @param op_index  if the parity is oparity_unary, oparity_binary or oparity_trinary the index
 328  *                  of the left operand
 329  * @param ops       operations for this opcode, iff NULL default operations are used
 330  * @param attr_size attribute size for this ir operation
 331  *
 332  * @return The generated ir operation.
 333  *
 334  * This function can create all standard Firm opcode as well as new ones.
 335  * The behavior of new opcode depends on the operations \c ops and the \c flags.
 336  */
 337 ir_op * new_ir_op(opcode code, const char *name, op_pin_state p,
 338                    unsigned flags, op_arity opar, int op_index, size_t attr_size,
 339        const ir_op_ops *ops);
 340
 341 /** Returns the ir_op_ops of an ir_op. */
 342 const ir_op_ops *get_op_ops(const ir_op *op);
 343
 344 #endif /* _IROP_H_ */