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