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

   1 /*
   2  * Copyright (C) 1995-2008 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 arities. */
  41 typedef enum {
  42         oparity_invalid = 0,
  43         oparity_unary,              /**< An unary operator -- considering 'numeric' arguments. */
  44         oparity_binary,             /**< A binary operator  -- considering 'numeric' arguments.*/
  45         oparity_trinary,            /**< A trinary operator  -- considering 'numeric' arguments.*/
  46         oparity_zero,               /**< A zero arity operator, e.g. a Const. */
  47         oparity_variable,           /**< The arity is not fixed by opcode, but statically
  48                                          known.  E.g., number of arguments to call. */
  49         oparity_dynamic,            /**< The arity depends on state of Firm representation.
  50                                          Can be changed by optimizations...
  51                                          We must allocate a dynamic in array for the node! */
  52         oparity_any                 /**< 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_uses_memory = 0x00000800, /**< This operation has a memory input and may change the memory state. */
  74         irop_flag_dump_noblock = 0x00001000, /**< node should be dumped outside any blocks */
  75         irop_flag_dump_noinput = 0x00002000, /**< node is a placeholder for "no input" */
  76         irop_flag_machine     = 0x00010000, /**< This operation is a machine operation. */
  77         irop_flag_machine_op  = 0x00020000, /**< This operation is a machine operand. */
  78         irop_flag_user        = 0x00040000  /**< This flag and all higher ones are free for machine user. */
  79 } irop_flags;
  80
  81 /** The opcodes of the libFirm predefined operations. */
  82 typedef enum {
  83         iro_Block,
  84         iro_Start, iro_End, iro_Jmp, iro_IJmp, iro_Cond, iro_Return,
  85         iro_Const, iro_SymConst,
  86         iro_Sel,
  87         iro_Call, iro_Add, iro_Sub, iro_Minus, iro_Mul, iro_Mulh, iro_Quot, iro_DivMod,
  88         iro_Div,  iro_Mod, iro_Abs, iro_And, iro_Or, iro_Eor, iro_Not,
  89         iro_Cmp,  iro_Shl, iro_Shr, iro_Shrs, iro_Rotl, iro_Conv, iro_Cast,
  90         iro_Carry, iro_Borrow,
  91         iro_Phi,
  92         iro_Load, iro_Store, iro_Alloc, iro_Free, iro_Sync,
  93         iro_Proj, iro_Tuple, iro_Id, iro_Bad, iro_Confirm,
  94         iro_Unknown, iro_Filter, iro_Break, iro_CallBegin, iro_EndReg, iro_EndExcept,
  95         iro_NoMem, iro_Mux, iro_Psi, iro_CopyB,
  96         iro_InstOf, iro_Raise, iro_Bound,
  97         iro_Pin,
  98         iro_ASM,
  99         iro_Anchor,
 100         /* first not middleend node number */
 101         iro_Last = iro_Anchor,
 102         /* first backend node number */
 103         beo_First,
 104         /* backend specific nodes */
 105         beo_Spill = beo_First,
 106         beo_Reload,
 107         beo_Perm,
 108         beo_MemPerm,
 109         beo_Copy,
 110         beo_Keep,
 111         beo_CopyKeep,
 112         beo_Call,
 113         beo_Return,
 114         beo_AddSP,
 115         beo_SubSP,
 116         beo_IncSP,
 117         beo_RegParams,
 118         beo_FrameAddr,
 119         beo_Barrier,
 120         beo_Unwind,
 121         /* last backend node number */
 122         beo_Last = beo_Unwind,
 123         /* first unfixed number. Dynamic node numbers start here */
 124         iro_MaxOpcode
 125 } ir_opcode;
 126
 127 extern ir_op *op_Block;           ir_op *get_op_Block     (void);
 128
 129 extern ir_op *op_Start;           ir_op *get_op_Start     (void);
 130 extern ir_op *op_End;             ir_op *get_op_End       (void);
 131 extern ir_op *op_Jmp;             ir_op *get_op_Jmp       (void);
 132 extern ir_op *op_IJmp;            ir_op *get_op_IJmp      (void);
 133 extern ir_op *op_Cond;            ir_op *get_op_Cond      (void);
 134 extern ir_op *op_Return;          ir_op *get_op_Return    (void);
 135 extern ir_op *op_Sel;             ir_op *get_op_Sel       (void);
 136
 137 extern ir_op *op_Const;           ir_op *get_op_Const     (void);
 138 extern ir_op *op_SymConst;        ir_op *get_op_SymConst  (void);
 139
 140 extern ir_op *op_Call;            ir_op *get_op_Call      (void);
 141 extern ir_op *op_Add;             ir_op *get_op_Add       (void);
 142 extern ir_op *op_Sub;             ir_op *get_op_Sub       (void);
 143 extern ir_op *op_Minus;           ir_op *get_op_Minus     (void);
 144 extern ir_op *op_Mul;             ir_op *get_op_Mul       (void);
 145 extern ir_op *op_Mulh;            ir_op *get_op_Mulh      (void);
 146 extern ir_op *op_Quot;            ir_op *get_op_Quot      (void);
 147 extern ir_op *op_DivMod;          ir_op *get_op_DivMod    (void);
 148 extern ir_op *op_Div;             ir_op *get_op_Div       (void);
 149 extern ir_op *op_Mod;             ir_op *get_op_Mod       (void);
 150 extern ir_op *op_Abs;             ir_op *get_op_Abs       (void);
 151 extern ir_op *op_And;             ir_op *get_op_And       (void);
 152 extern ir_op *op_Or;              ir_op *get_op_Or        (void);
 153 extern ir_op *op_Eor;             ir_op *get_op_Eor       (void);
 154 extern ir_op *op_Not;             ir_op *get_op_Not       (void);
 155 extern ir_op *op_Cmp;             ir_op *get_op_Cmp       (void);
 156 extern ir_op *op_Shl;             ir_op *get_op_Shl       (void);
 157 extern ir_op *op_Shr;             ir_op *get_op_Shr       (void);
 158 extern ir_op *op_Shrs;            ir_op *get_op_Shrs      (void);
 159 extern ir_op *op_Rotl;            ir_op *get_op_Rotl      (void);
 160 extern ir_op *op_Conv;            ir_op *get_op_Conv      (void);
 161 extern ir_op *op_Cast;            ir_op *get_op_Cast      (void);
 162 extern ir_op *op_Carry;           ir_op *get_op_Carry     (void);
 163 extern ir_op *op_Borrow;          ir_op *get_op_Borrow    (void);
 164
 165 extern ir_op *op_Phi;             ir_op *get_op_Phi       (void);
 166
 167 extern ir_op *op_Load;            ir_op *get_op_Load      (void);
 168 extern ir_op *op_Store;           ir_op *get_op_Store     (void);
 169 extern ir_op *op_Alloc;           ir_op *get_op_Alloc     (void);
 170 extern ir_op *op_Free;            ir_op *get_op_Free      (void);
 171
 172 extern ir_op *op_Sync;            ir_op *get_op_Sync      (void);
 173
 174 extern ir_op *op_Tuple;           ir_op *get_op_Tuple     (void);
 175 extern ir_op *op_Proj;            ir_op *get_op_Proj      (void);
 176 extern ir_op *op_Id;              ir_op *get_op_Id        (void);
 177 extern ir_op *op_Bad;             ir_op *get_op_Bad       (void);
 178 extern ir_op *op_Confirm;         ir_op *get_op_Confirm   (void);
 179
 180 extern ir_op *op_Unknown;         ir_op *get_op_Unknown   (void);
 181 extern ir_op *op_Filter;          ir_op *get_op_Filter    (void);
 182 extern ir_op *op_Break;           ir_op *get_op_Break     (void);
 183 extern ir_op *op_CallBegin;       ir_op *get_op_CallBegin (void);
 184 extern ir_op *op_EndReg;          ir_op *get_op_EndReg    (void);
 185 extern ir_op *op_EndExcept;       ir_op *get_op_EndExcept (void);
 186
 187 extern ir_op *op_NoMem;           ir_op *get_op_NoMem     (void);
 188 extern ir_op *op_Mux;             ir_op *get_op_Mux       (void);
 189 extern ir_op *op_Psi;             ir_op *get_op_Psi       (void);
 190 extern ir_op *op_CopyB;           ir_op *get_op_CopyB     (void);
 191
 192 extern ir_op *op_InstOf;          ir_op *get_op_InstOf    (void);
 193 extern ir_op *op_Raise;           ir_op *get_op_Raise     (void);
 194 extern ir_op *op_Bound;           ir_op *get_op_Bound     (void);
 195
 196 extern ir_op *op_Pin;             ir_op *get_op_Pin       (void);
 197
 198 extern ir_op *op_ASM;             ir_op *get_op_ASM       (void);
 199
 200 extern ir_op *op_Anchor;          ir_op *get_op_Anchor    (void);
 201
 202 /** Returns the ident for the opcode name */
 203 ident *get_op_ident(const ir_op *op);
 204
 205 /** Returns the string for the opcode. */
 206 const char *get_op_name(const ir_op *op);
 207
 208 /** Returns the enum for the opcode */
 209 unsigned get_op_code(const ir_op *op);
 210
 211 /** op_pin_state_pinned states. */
 212 typedef enum {
 213         op_pin_state_floats = 0,    /**< Nodes of this opcode can be placed in any basic block. */
 214         op_pin_state_pinned = 1,    /**< Nodes must remain in this basic block. */
 215         op_pin_state_exc_pinned,    /**< Node must be remain in this basic block if it can throw an
 216                                          exception, else can float. Used internally. */
 217         op_pin_state_mem_pinned     /**< Node must be remain in this basic block if it can throw an
 218                                          exception or uses memory, else can float. Used internally. */
 219 } op_pin_state;
 220
 221 /** Returns a human readable name of an op_pin_state. */
 222 const char *get_op_pin_state_name(op_pin_state s);
 223
 224 /** Gets pinned state of an opcode. */
 225 op_pin_state get_op_pinned(const ir_op *op);
 226
 227 /** Sets pinned in the opcode.  Setting it to floating has no effect
 228     for Block, Phi and control flow nodes. */
 229 void set_op_pinned(ir_op *op, op_pin_state pinned);
 230
 231 /** Returns the next free IR opcode number, allows to register user ops. */
 232 unsigned get_next_ir_opcode(void);
 233
 234 /** Returns the next free n IR opcode number, allows to register a bunch of user ops. */
 235 unsigned get_next_ir_opcodes(unsigned num);
 236
 237 /**
 238  * A generic function pointer type.
 239  */
 240 typedef void (*op_func)(void);
 241
 242 /** The NULL-function. */
 243 #define NULL_FUNC       ((generic_func)(NULL))
 244
 245 /**
 246  * Returns the generic function pointer from an IR operation.
 247  */
 248 op_func get_generic_function_ptr(const ir_op *op);
 249
 250 /**
 251  * Store a generic function pointer into an IR operation.
 252  */
 253 void set_generic_function_ptr(ir_op *op, op_func func);
 254
 255 /**
 256  * Return the irop flags of an IR opcode.
 257  */
 258 irop_flags get_op_flags(const ir_op *op);
 259
 260 /**
 261  * The hash operation.
 262  * This operation calculates a hash value for a given IR node.
 263  */
 264 typedef unsigned (*hash_func)(const ir_node *self);
 265
 266 /**
 267  * The compute value operation.
 268  * This operation evaluates an IR node into a tarval if possible,
 269  * returning tarval_bad otherwise.
 270  */
 271 typedef tarval *(*computed_value_func)(const ir_node *self);
 272
 273 /**
 274  * The equivalent node operation.
 275  * This operation returns an equivalent node for the input node.
 276  * It does not create new nodes.  It is therefore safe to free self
 277  * if the node returned is not self.
 278  * If a node returns a Tuple we can not just skip it.  If the size of the
 279  * in array fits, we transform n into a tuple (e.g., possible for Div).
 280  */
 281 typedef ir_node *(*equivalent_node_func)(ir_node *self);
 282
 283 /**
 284  * The transform node operation.
 285  * This operation tries several [inplace] [optimizing] transformations
 286  * and returns an equivalent node.
 287  * The difference to equivalent_node() is that these
 288  * transformations _do_ generate new nodes, and thus the old node must
 289  * not be freed even if the equivalent node isn't the old one.
 290  */
 291 typedef ir_node *(*transform_node_func)(ir_node *self);
 292
 293 /**
 294  * The node attribute compare operation.
 295  * Compares the nodes attributes of two nodes of identical opcode
 296  * and returns 0 if the attributes are identical, 1 if they differ.
 297  */
 298 typedef int (*node_cmp_attr_func)(ir_node *a, ir_node *b);
 299
 300 /**
 301  * The reassociation operation.
 302  * Called from a walker.  Returns non-zero if
 303  * a reassociation rule was applied.
 304  * The pointer n is set to the newly created node, if some reassociation
 305  * was applied.
 306  */
 307 typedef int (*reassociate_func)(ir_node **n);
 308
 309 /**
 310  * The copy attribute operation.
 311  * Copy the node attributes from an 'old' node to a 'new' one.
 312  */
 313 typedef void (*copy_attr_func)(const ir_node *old_node, ir_node *new_node);
 314
 315 /**
 316  * The get_type operation.
 317  * Return the type of the node self.
 318  */
 319 typedef ir_type *(*get_type_func)(ir_node *self);
 320
 321 /**
 322  * The get_type_attr operation. Used to traverse all types that can be
 323  * accessed from an ir_graph.
 324  * Return the type attribute of the node self.
 325  */
 326 typedef ir_type *(*get_type_attr_func)(ir_node *self);
 327
 328 /**
 329  * The get_entity_attr operation. Used to traverse all entities that can be
 330  * accessed from an ir_graph.
 331  * Return the entity attribute of the node self.
 332  */
 333 typedef ir_entity *(*get_entity_attr_func)(ir_node *self);
 334
 335 /**
 336  * The verify_node operation.
 337  * Return non-zero if the node verification is ok, else 0.
 338  * Depending on the node verification settings, may even assert.
 339  *
 340  * @see do_node_verification()
 341  */
 342 typedef int (*verify_node_func)(ir_node *self, ir_graph *irg);
 343
 344 /**
 345  * The verify_node operation for Proj(X).
 346  * Return non-zero if the node verification is ok, else 0.
 347  * Depending on the node verification settings, may even assert.
 348  *
 349  * @see do_node_verification()
 350  */
 351 typedef int (*verify_proj_node_func)(ir_node *self, ir_node *proj);
 352
 353 /**
 354  * Reasons to call the dump_node operation:
 355  */
 356 typedef enum {
 357         dump_node_opcode_txt,   /**< Dump the opcode. */
 358         dump_node_mode_txt,     /**< Dump the mode. */
 359         dump_node_nodeattr_txt, /**< Dump node attributes to be shown in the label. */
 360         dump_node_info_txt      /**< Dump node attributes into info1. */
 361 } dump_reason_t;
 362
 363 /**
 364  * The dump_node operation.
 365  * Writes several informations requested by reason to
 366  * an output file
 367  */
 368 typedef int (*dump_node_func)(ir_node *self, FILE *F, dump_reason_t reason);
 369
 370 /**
 371  * io_op Operations.
 372  */
 373 typedef struct {
 374         hash_func             hash;                 /**< Calculate a hash value for an IR node. */
 375         computed_value_func   computed_value;       /**< Evaluates a node into a tarval if possible. */
 376         computed_value_func   computed_value_Proj;  /**< Evaluates a Proj node into a tarval if possible. */
 377         equivalent_node_func  equivalent_node;      /**< Optimizes the node by returning an equivalent one. */
 378         equivalent_node_func  equivalent_node_Proj; /**< Optimizes the Proj node by returning an equivalent one. */
 379         transform_node_func   transform_node;       /**< Optimizes the node by transforming it. */
 380         equivalent_node_func  transform_node_Proj;  /**< Optimizes the Proj node by transforming it. */
 381         node_cmp_attr_func    node_cmp_attr;        /**< Compares two node attributes. */
 382         reassociate_func      reassociate;          /**< Reassociate a tree. */
 383         copy_attr_func        copy_attr;            /**< Copy node attributes. */
 384         get_type_func         get_type;             /**< Return the type of a node. */
 385         get_type_attr_func    get_type_attr;        /**< Return the type attribute of a node. */
 386         get_entity_attr_func  get_entity_attr;      /**< Return the entity attribute of a node. */
 387         verify_node_func      verify_node;          /**< Verify the node. */
 388         verify_proj_node_func verify_proj_node;     /**< Verify the Proj node. */
 389         dump_node_func        dump_node;            /**< Dump a node. */
 390         op_func               generic;              /**< A generic function pointer. */
 391         const arch_irn_ops_t *be_ops;               /**< callbacks used by the backend. */
 392 } ir_op_ops;
 393
 394 /**
 395  * Creates a new IR operation.
 396  *
 397  * @param code      the opcode, one of type \c opcode
 398  * @param name      the printable name of this opcode
 399  * @param p         whether operations of this opcode are op_pin_state_pinned or floating
 400  * @param flags     a bitmask of irop_flags describing the behavior of the IR operation
 401  * @param opar      the parity of this IR operation
 402  * @param op_index  if the parity is oparity_unary, oparity_binary or oparity_trinary the index
 403  *                  of the left operand
 404  * @param ops       operations for this opcode, iff NULL default operations are used
 405  * @param attr_size attribute size for this IR operation
 406  *
 407  * @return The generated IR operation.
 408  *
 409  * This function can create all standard Firm opcode as well as new ones.
 410  * The behavior of new opcode depends on the operations \c ops and the \c flags.
 411  */
 412 ir_op *new_ir_op(unsigned code, const char *name, op_pin_state p,
 413        unsigned flags, op_arity opar, int op_index, size_t attr_size,
 414        const ir_op_ops *ops);
 415
 416 /** Returns the ir_op_ops of an ir_op. */
 417 const ir_op_ops *get_op_ops(const ir_op *op);
 418
 419 #endif