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

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