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