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

   1 /*
   2  * Copyright (C) 1995-2011 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  * @brief
  25  *  Operators of firm nodes.
  26  *
  27  *  This module specifies the opcodes possible for ir nodes.  Their
  28  *  definition is close to the operations specified in UKA Tech-Report
  29  *  1999-14
  30  */
  31 #ifndef FIRM_IR_IROP_H
  32 #define FIRM_IR_IROP_H
  33
  34 #include <stdio.h>
  35 #include "firm_types.h"
  36 #include "ident.h"
  37 #include "begin.h"
  38 #include "opcodes.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
  63                                                control flow because of an exception.
  64                                            */
  65         irop_flag_forking      = 1U << 4, /**< Forking control flow at this operation. */
  66         irop_flag_highlevel    = 1U << 5, /**< This operation is a pure high-level one and can be
  67                                               skipped in low-level optimizations. */
  68         irop_flag_constlike    = 1U << 6, /**< This operation has no arguments and is some
  69                                                kind of a constant. */
  70         irop_flag_always_opt   = 1U << 7, /**< This operation must always be optimized .*/
  71         irop_flag_keep         = 1U << 8, /**< This operation can be kept in End's keep-alive list. */
  72         irop_flag_start_block  = 1U << 9, /**< This operation is always placed in the Start block. */
  73         irop_flag_uses_memory  = 1U << 10, /**< This operation has a memory input and may change the memory state. */
  74         irop_flag_dump_noblock = 1U << 11, /**< node should be dumped outside any blocks */
  75         irop_flag_dump_noinput = 1U << 12, /**< node is a placeholder for "no input" */
  76         irop_flag_cse_neutral  = 1U << 13, /**< This operation is CSE neutral to its users. */
  77         /** This operation jumps to an unknown destination. The CFG is a
  78          * conservative aproximation in this case. You cannot change the destination
  79          * of an unknown_jump */
  80         irop_flag_unknown_jump = 1U << 14,
  81 } irop_flags;
  82
  83 /** Returns the ident for the opcode name */
  84 FIRM_API ident *get_op_ident(const ir_op *op);
  85
  86 /** Returns the string for the opcode. */
  87 FIRM_API const char *get_op_name(const ir_op *op);
  88
  89 /** Returns the enum for the opcode */
  90 FIRM_API unsigned get_op_code(const ir_op *op);
  91
  92 /** Returns a human readable name of an op_pin_state. */
  93 FIRM_API const char *get_op_pin_state_name(op_pin_state s);
  94
  95 /** Gets pinned state of an opcode. */
  96 FIRM_API op_pin_state get_op_pinned(const ir_op *op);
  97
  98 /** Sets pinned in the opcode.  Setting it to floating has no effect
  99     for Block, Phi and control flow nodes. */
 100 FIRM_API void set_op_pinned(ir_op *op, op_pin_state pinned);
 101
 102 /** Returns the next free IR opcode number, allows to register user ops. */
 103 FIRM_API unsigned get_next_ir_opcode(void);
 104
 105 /** Returns the next free n IR opcode number, allows to register a bunch of user ops. */
 106 FIRM_API unsigned get_next_ir_opcodes(unsigned num);
 107
 108 /**
 109  * A generic function pointer type.
 110  */
 111 typedef void (*op_func)(void);
 112
 113 /** The NULL-function. */
 114 #define NULL_FUNC       ((generic_func)(NULL))
 115
 116 /**
 117  * Returns the generic function pointer from an IR operation.
 118  */
 119 FIRM_API op_func get_generic_function_ptr(const ir_op *op);
 120
 121 /**
 122  * Store a generic function pointer into an IR operation.
 123  */
 124 FIRM_API void set_generic_function_ptr(ir_op *op, op_func func);
 125
 126 /**
 127  * Return the irop flags of an IR opcode.
 128  */
 129 FIRM_API irop_flags get_op_flags(const ir_op *op);
 130
 131 /**
 132  * The hash operation.
 133  * This operation calculates a hash value for a given IR node.
 134  */
 135 typedef unsigned (*hash_func)(const ir_node *self);
 136
 137 /**
 138  * The compute value operation.
 139  * This operation evaluates an IR node into a tarval if possible,
 140  * returning tarval_bad otherwise.
 141  */
 142 typedef ir_tarval *(*computed_value_func)(const ir_node *self);
 143
 144 /**
 145  * The equivalent node operation.
 146  * This operation returns an equivalent node for the input node.
 147  * It does not create new nodes.  It is therefore safe to free self
 148  * if the node returned is not self.
 149  * If a node returns a Tuple we can not just skip it.  If the size of the
 150  * in array fits, we transform n into a tuple (e.g., possible for Div).
 151  */
 152 typedef ir_node *(*equivalent_node_func)(ir_node *self);
 153
 154 /**
 155  * The transform node operation.
 156  * This operation tries several [inplace] [optimizing] transformations
 157  * and returns an equivalent node.
 158  * The difference to equivalent_node() is that these
 159  * transformations _do_ generate new nodes, and thus the old node must
 160  * not be freed even if the equivalent node isn't the old one.
 161  */
 162 typedef ir_node *(*transform_node_func)(ir_node *self);
 163
 164 /**
 165  * The node attribute compare operation.
 166  * Compares the nodes attributes of two nodes of identical opcode
 167  * and returns 0 if the attributes are identical, 1 if they differ.
 168  */
 169 typedef int (*node_cmp_attr_func)(const ir_node *a, const ir_node *b);
 170
 171 /**
 172  * The reassociation operation.
 173  * Called from a walker.  Returns non-zero if
 174  * a reassociation rule was applied.
 175  * The pointer n is set to the newly created node, if some reassociation
 176  * was applied.
 177  */
 178 typedef int (*reassociate_func)(ir_node **n);
 179
 180 /**
 181  * The copy attribute operation.
 182  * Copy the node attributes from an 'old' node to a 'new' one.
 183  */
 184 typedef void (*copy_attr_func)(ir_graph *irg, const ir_node *old_node, ir_node *new_node);
 185
 186 /**
 187  * The get_type_attr operation. Used to traverse all types that can be
 188  * accessed from an ir_graph.
 189  * Return the type attribute of the node self.
 190  */
 191 typedef ir_type *(*get_type_attr_func)(const ir_node *self);
 192
 193 /**
 194  * The get_entity_attr operation. Used to traverse all entities that can be
 195  * accessed from an ir_graph.
 196  * Return the entity attribute of the node self.
 197  */
 198 typedef ir_entity *(*get_entity_attr_func)(const ir_node *self);
 199
 200 /**
 201  * The verify_node operation.
 202  * Return non-zero if the node verification is ok, else 0.
 203  * Depending on the node verification settings, may even assert.
 204  *
 205  * @see do_node_verification()
 206  */
 207 typedef int (*verify_node_func)(const ir_node *node);
 208
 209 /**
 210  * The verify_node operation for Proj(X).
 211  * Return non-zero if the node verification is ok, else 0.
 212  * Depending on the node verification settings, may even assert.
 213  *
 214  * @see do_node_verification()
 215  */
 216 typedef int (*verify_proj_node_func)(const ir_node *proj);
 217
 218 /**
 219  * Reasons to call the dump_node operation:
 220  */
 221 typedef enum {
 222         dump_node_opcode_txt,   /**< Dump the opcode. */
 223         dump_node_mode_txt,     /**< Dump the mode. */
 224         dump_node_nodeattr_txt, /**< Dump node attributes to be shown in the label. */
 225         dump_node_info_txt      /**< Dump node attributes into info1. */
 226 } dump_reason_t;
 227
 228 /**
 229  * The dump_node operation.
 230  * Writes several informations requested by reason to
 231  * an output file
 232  */
 233 typedef void (*dump_node_func)(FILE *out, ir_node *self, dump_reason_t reason);
 234
 235 /**
 236  * io_op Operations.
 237  */
 238 typedef struct {
 239         hash_func             hash;                 /**< Calculate a hash value for an IR node. */
 240         computed_value_func   computed_value;       /**< Evaluates a node into a tarval if possible. */
 241         computed_value_func   computed_value_Proj;  /**< Evaluates a Proj node into a tarval if possible. */
 242         equivalent_node_func  equivalent_node;      /**< Optimizes the node by returning an equivalent one. */
 243         equivalent_node_func  equivalent_node_Proj; /**< Optimizes the Proj node by returning an equivalent one. */
 244         transform_node_func   transform_node;       /**< Optimizes the node by transforming it. */
 245         equivalent_node_func  transform_node_Proj;  /**< Optimizes the Proj node by transforming it. */
 246         node_cmp_attr_func    node_cmp_attr;        /**< Compares two node attributes. */
 247         reassociate_func      reassociate;          /**< Reassociate a tree. */
 248         copy_attr_func        copy_attr;            /**< Copy node attributes. */
 249         get_type_attr_func    get_type_attr;        /**< Return the type attribute of a node. */
 250         get_entity_attr_func  get_entity_attr;      /**< Return the entity attribute of a node. */
 251         verify_node_func      verify_node;          /**< Verify the node. */
 252         verify_proj_node_func verify_proj_node;     /**< Verify the Proj node. */
 253         dump_node_func        dump_node;            /**< Dump a node. */
 254         op_func               generic;              /**< A generic function pointer. */
 255         const arch_irn_ops_t *be_ops;               /**< callbacks used by the backend. */
 256 } ir_op_ops;
 257
 258 /**
 259  * Creates a new IR operation.
 260  *
 261  * @param code      the opcode, one of type \c opcode
 262  * @param name      the printable name of this opcode
 263  * @param p         whether operations of this opcode are op_pin_state_pinned or floating
 264  * @param flags     a bitmask of irop_flags describing the behavior of the IR operation
 265  * @param opar      the parity of this IR operation
 266  * @param op_index  if the parity is oparity_unary, oparity_binary or oparity_trinary the index
 267  *                  of the left operand
 268  * @param ops       operations for this opcode, iff NULL default operations are used
 269  * @param attr_size attribute size for this IR operation
 270  *
 271  * @return The generated IR operation.
 272  *
 273  * This function can create all standard Firm opcode as well as new ones.
 274  * The behavior of new opcode depends on the operations \c ops and the \c flags.
 275  */
 276 FIRM_API ir_op *new_ir_op(unsigned code, const char *name, op_pin_state p,
 277                           unsigned flags, op_arity opar, int op_index,
 278                           size_t attr_size, const ir_op_ops *ops);
 279
 280 /**
 281  * Set proj-number for X_regular and X_except projs of fragile nodes.
 282  * Note: should only be used immediately after new_ir_op
 283  */
 284 FIRM_API void ir_op_set_fragile_indices(ir_op *op, int fragile_mem_index,
 285                                         int pn_x_regular, int pn_x_except);
 286
 287 /** Returns the ir_op_ops of an ir_op. */
 288 FIRM_API const ir_op_ops *get_op_ops(const ir_op *op);
 289
 290 #include "end.h"
 291
 292 #endif