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