nsz Git - libfirm/blob - ir/ir/irop_t.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 -- private header.
  23  * @author   Christian Schaefer, Goetz Lindenmaier, Michael Beck
  24  * @version  $Id$
  25  */
  26 #ifndef FIRM_IR_IROP_T_H
  27 #define FIRM_IR_IROP_T_H
  28
  29 #include "firm_config.h"
  30 #include "irop.h"
  31 #include "tv.h"
  32 #include "irnode.h"
  33
  34
  35 /** The type of an ir_op. */
  36 struct ir_op {
  37   unsigned code;          /**< The unique opcode of the op. */
  38   ident *name;            /**< The name of the op. */
  39   size_t attr_size;       /**< Space needed in memory for private attributes. */
  40   op_pin_state op_pin_state_pinned; /**< How to deal with the node in CSE, PRE. */
  41   op_arity opar;          /**< The arity of operator. */
  42   int op_index;           /**< The index of the first data operand, 0 for most cases, 1 for Div etc. */
  43   unsigned flags;         /**< Flags describing the behavior of the ir_op, a bitmasks of irop_flags. */
  44   void *tag;              /**< Some custom pointer the op's creator can attach stuff to. */
  45
  46   ir_op_ops ops;          /**< The operations of the this op. */
  47 };
  48
  49 /**
  50  * Frees a newly created ir operation.
  51  */
  52 void free_ir_op(ir_op *code);
  53
  54 /** Initialize the irop module. */
  55 void init_op(void);
  56
  57 /** Free memory used by irop module. */
  58 void finish_op(void);
  59
  60 /**
  61  * Copies simply all attributes stored in the old node to the new node.
  62  * Assumes both have the same opcode and sufficient size.
  63  *
  64  * @param old_node  the old node from which the attributes are read
  65  * @param new_node  the new node to which the attributes are written
  66  */
  67 void default_copy_attr(const ir_node *old_node, ir_node *new_node);
  68
  69 /**
  70  * Returns the attribute size of nodes of this opcode.
  71  * @note Use not encouraged, internal feature.
  72  */
  73 static INLINE size_t get_op_attr_size (const ir_op *op) {
  74   return op->attr_size;
  75 }
  76
  77 /**
  78  * Returns non-zero if op is a control flow opcode,
  79  * like Start, End, Jmp, Cond, Return, Raise or Bad.
  80  */
  81 static INLINE int is_cfopcode(const ir_op *op) {
  82   return op->flags & irop_flag_cfopcode;
  83 }
  84
  85 /**
  86  * Returns non-zero if the operation manipulates interprocedural control flow:
  87  * CallBegin, EndReg, EndExcept
  88  */
  89 static INLINE int is_ip_cfopcode(const ir_op *op) {
  90   return op->flags & irop_flag_ip_cfopcode;
  91 }
  92
  93 /** Returns non-zero if operation is commutative */
  94 static INLINE int is_op_commutative(const ir_op *op) {
  95   return op->flags & irop_flag_commutative;
  96 }
  97
  98 /** Returns non-zero if operation is fragile */
  99 static INLINE int is_op_fragile(const ir_op *op) {
 100   return op->flags & irop_flag_fragile;
 101 }
 102
 103 /** Returns non-zero if operation is forking control flow */
 104 static INLINE int is_op_forking(const ir_op *op) {
 105   return op->flags & irop_flag_forking;
 106 }
 107
 108 /** Returns non-zero if operation is a high-level op */
 109 static INLINE int is_op_highlevel(const ir_op *op) {
 110   return op->flags & irop_flag_highlevel;
 111 }
 112
 113 /** Returns non-zero if operation is a const-like op */
 114 static INLINE int is_op_constlike(const ir_op *op) {
 115   return op->flags & irop_flag_constlike;
 116 }
 117
 118 /** Returns non-zero if operation must always be optimized */
 119 static INLINE int is_op_always_opt(const ir_op *op) {
 120   return op->flags & irop_flag_always_opt;
 121 }
 122
 123 /** Returns non-zero if operation is a keep-like op */
 124 static INLINE int is_op_keep(const ir_op *op) {
 125   return op->flags & irop_flag_keep;
 126 }
 127
 128 /** Returns non-zero if operation must always be placed in the start block. */
 129 static INLINE int is_op_start_block_placed(const ir_op *op) {
 130   return op->flags & irop_flag_start_block;
 131 }
 132
 133 /** Returns non-zero if operation is a machine operation */
 134 static INLINE int is_op_machine(const ir_op *op) {
 135   return op->flags & irop_flag_machine;
 136 }
 137
 138 /** Returns non-zero if operation is a machine operand */
 139 static INLINE int is_op_machine_operand(const ir_op *op) {
 140   return op->flags & irop_flag_machine_op;
 141 }
 142
 143 /** Returns non-zero if operation is a machine user op number n */
 144 static INLINE int is_op_machine_user(const ir_op *op, unsigned n) {
 145   return op->flags & (irop_flag_user << n);
 146 }
 147
 148 static INLINE unsigned _get_op_code(const ir_op *op) {
 149   return op->code;
 150 }
 151
 152 static INLINE ident *_get_op_ident(const ir_op *op){
 153   return op->name;
 154 }
 155
 156 static INLINE op_pin_state _get_op_pinned(const ir_op *op) {
 157   return op->op_pin_state_pinned;
 158 }
 159
 160 static INLINE void _set_generic_function_ptr(ir_op *op, op_func func) {
 161   op->ops.generic = func;
 162 }
 163
 164 static INLINE op_func _get_generic_function_ptr(const ir_op *op) {
 165   return op->ops.generic;
 166 }
 167
 168 static INLINE const ir_op_ops *_get_op_ops(const ir_op *op) {
 169   return &op->ops;
 170 }
 171
 172 static INLINE void _set_op_tag(ir_op *op, void *tag) {
 173         op->tag = tag;
 174 }
 175
 176 static INLINE void *_get_op_tag(const ir_op *op) {
 177         return op->tag;
 178 }
 179
 180 #define get_op_code(op)         _get_op_code(op)
 181 #define get_op_ident(op)        _get_op_ident(op)
 182 #define get_op_pinned(op)       _get_op_pinned(op)
 183 #define get_op_ops(op)          _get_op_ops(op)
 184 #define set_op_tag(op, tag)     _set_op_tag((op), (tag))
 185 #define get_op_tag(op)          _get_op_tag(op)
 186
 187 #endif