added doxygen comments
[libfirm] / ir / ir / irop.c
index ea0bdaa..b4a9267 100644 (file)
@@ -1,15 +1,28 @@
 /*
- * Project:     libFIRM
- * File name:   ir/ir/irop.c
- * Purpose:     Representation of opcode of intermediate operation.
- * Author:      Christian Schaefer
- * Modified by: Goetz Lindenmaier
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2003 Universität Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
  */
 
+/**
+ * @file
+ * @brief   Representation of opcode of intermediate operation.
+ * @author  Christian Schaefer, Goetz Lindenmaier, Michael Beck
+ * @version $Id$
+ */
 #ifdef HAVE_CONFIG_H
 # include "config.h"
 #endif
 # include <string.h>
 #endif
 
-# include "irop_t.h"
-# include "irnode_t.h"
-# include "irhooks.h"
+#include "irop_t.h"
+#include "irnode_t.h"
+#include "irhooks.h"
+#include "irbackedge_t.h"
 
-# include "iropt_t.h"             /* for firm_set_default_operations */
-# include "irvrfy_t.h"
-# include "reassoc_t.h"
+#include "iropt_t.h"             /* for firm_set_default_operations */
+#include "irvrfy_t.h"
+#include "reassoc_t.h"
 
-# include "xmalloc.h"
+#include "xmalloc.h"
 
 /** the available next opcode */
 static unsigned next_iro = iro_MaxOpcode;
@@ -93,11 +107,14 @@ ir_op *op_EndExcept;   ir_op *get_op_EndExcept (void) { return op_EndExcept; }
 
 ir_op *op_NoMem;       ir_op *get_op_NoMem     (void) { return op_NoMem;     }
 ir_op *op_Mux;         ir_op *get_op_Mux       (void) { return op_Mux;       }
+ir_op *op_Psi;         ir_op *get_op_Psi       (void) { return op_Psi;       }
 ir_op *op_CopyB;       ir_op *get_op_CopyB     (void) { return op_CopyB;     }
 
 ir_op *op_Raise;       ir_op *get_op_Raise     (void) { return op_Raise;     }
 ir_op *op_Bound;       ir_op *get_op_Bound     (void) { return op_Bound;     }
 
+ir_op *op_Pin;         ir_op *get_op_Pin       (void) { return op_Pin;       }
+
 /*
  * Copies all attributes stored in the old node to the new node.
  * Assumes both have the same opcode and sufficient size.
@@ -112,24 +129,50 @@ void default_copy_attr(const ir_node *old_node, ir_node *new_node) {
     /* copy additional node data */
     memcpy(get_irn_data(new_node, void, size), get_irn_data(old_node, void, size), size);
   }
-}
+}  /* default_copy_attr */
 
 /**
- * Copies all attributes stored in the old node to the new node.
- * Assumes both have the same opcode and sufficient size.
+ * Copies all Call attributes stored in the old node to the new node.
  */
 static void
 call_copy_attr(const ir_node *old_node, ir_node *new_node) {
   default_copy_attr(old_node, new_node);
-
   remove_Call_callee_arr(new_node);
-}
+}  /* call_copy_attr */
 
+/**
+ * Copies all Block attributes stored in the old node to the new node.
+ */
 static void
-block_copy_attr(const ir_node *old_node, ir_node *new_node)
-{
+block_copy_attr(const ir_node *old_node, ir_node *new_node) {
+  ir_graph *irg = current_ir_graph;
+
   default_copy_attr(old_node, new_node);
+  new_node->attr.block.cg_backedge = NULL;
+  new_node->attr.block.backedge = new_backedge_arr(irg->obst, get_irn_arity(new_node));
   INIT_LIST_HEAD(&new_node->attr.block.succ_head);
+}  /* block_copy_attr */
+
+/**
+ * Copies all phi attributes stored in old node to the new node
+ */
+static void
+phi_copy_attr(const ir_node *old_node, ir_node *new_node) {
+  ir_graph *irg = current_ir_graph;
+
+  default_copy_attr(old_node, new_node);
+  new_node->attr.phi_backedge = new_backedge_arr(irg->obst, get_irn_arity(new_node));
+}
+
+/**
+ * Copies all filter attributes stored in old node to the new node
+ */
+static void
+filter_copy_attr(const ir_node *old_node, ir_node *new_node) {
+  ir_graph *irg = current_ir_graph;
+
+  default_copy_attr(old_node, new_node);
+  new_node->attr.filter.backedge = new_backedge_arr(irg->obst, get_irn_arity(new_node));
 }
 
 /**
@@ -141,23 +184,26 @@ block_copy_attr(const ir_node *old_node, ir_node *new_node)
  * @return
  *    The operations.
  */
-static ir_op_ops *firm_set_default_copy_attr(opcode code, ir_op_ops *ops) {
+static ir_op_ops *firm_set_default_copy_attr(ir_opcode code, ir_op_ops *ops) {
   if (code == iro_Call)
     ops->copy_attr = call_copy_attr;
   else if (code == iro_Block)
     ops->copy_attr = block_copy_attr;
+  else if (code == iro_Phi)
+    ops->copy_attr = phi_copy_attr;
+  else if (code == iro_Filter)
+    ops->copy_attr = filter_copy_attr;
   else {
     /* not allowed to be NULL */
     if (! ops->copy_attr)
       ops->copy_attr = default_copy_attr;
   }
-
   return ops;
-}
+}  /* firm_set_default_copy_attr */
 
 /* Creates a new ir operation. */
 ir_op *
-new_ir_op(opcode code, const char *name, op_pin_state p,
+new_ir_op(ir_opcode code, const char *name, op_pin_state p,
           unsigned flags, op_arity opar, int op_index, size_t attr_size,
           const ir_op_ops *ops)
 {
@@ -189,14 +235,14 @@ new_ir_op(opcode code, const char *name, op_pin_state p,
 
   hook_new_ir_op(res);
   return res;
-}
+}  /* new_ir_op */
 
 void free_ir_op(ir_op *code) {
   hook_free_ir_op(code);
 
   remove_irp_opcode(code);
   free(code);
-}
+}  /* free_ir_op */
 
 void
 init_op(void)
@@ -211,18 +257,20 @@ init_op(void)
 #define H   irop_flag_highlevel
 #define c   irop_flag_constlike
 #define K   irop_flag_keep
+#define S   irop_flag_start_block
 
+  /* Caution: A great deal of Firm optimizations depend an right operations flags. */
   op_Block     = new_ir_op(iro_Block,     "Block",     op_pin_state_pinned, L,       oparity_variable, -1, sizeof(block_attr), NULL);
 
-  op_Start     = new_ir_op(iro_Start,     "Start",     op_pin_state_pinned, X,       oparity_zero,     -1, sizeof(start_attr), NULL);
+  op_Start     = new_ir_op(iro_Start,     "Start",     op_pin_state_pinned, X,       oparity_zero,     -1, 0, NULL);
   op_End       = new_ir_op(iro_End,       "End",       op_pin_state_pinned, X,       oparity_dynamic,  -1, 0, NULL);
   op_Jmp       = new_ir_op(iro_Jmp,       "Jmp",       op_pin_state_pinned, X,       oparity_zero,     -1, 0, NULL);
   op_IJmp      = new_ir_op(iro_IJmp,      "IJmp",      op_pin_state_pinned, X|K,     oparity_unary,    -1, 0, NULL);
   op_Cond      = new_ir_op(iro_Cond,      "Cond",      op_pin_state_pinned, X|Y,     oparity_any,      -1, sizeof(cond_attr), NULL);
-  op_Return    = new_ir_op(iro_Return,    "Return",    op_pin_state_pinned, X,       oparity_zero,     -1, 0, NULL);
+  op_Return    = new_ir_op(iro_Return,    "Return",    op_pin_state_pinned, X,       oparity_variable, -1, 0, NULL);
 
-  op_Const     = new_ir_op(iro_Const,     "Const",     op_pin_state_floats, c,       oparity_zero,     -1, sizeof(const_attr), NULL);
-  op_SymConst  = new_ir_op(iro_SymConst,  "SymConst",  op_pin_state_floats, c,       oparity_zero,     -1, sizeof(symconst_attr), NULL);
+  op_Const     = new_ir_op(iro_Const,     "Const",     op_pin_state_floats, c|S,     oparity_zero,     -1, sizeof(const_attr), NULL);
+  op_SymConst  = new_ir_op(iro_SymConst,  "SymConst",  op_pin_state_floats, c|S,     oparity_zero,     -1, sizeof(symconst_attr), NULL);
 
   op_Sel       = new_ir_op(iro_Sel,       "Sel",       op_pin_state_floats, H,       oparity_any,      -1, sizeof(sel_attr), NULL);
 
@@ -245,7 +293,7 @@ init_op(void)
   op_Shr       = new_ir_op(iro_Shr,       "Shr",       op_pin_state_floats, N,       oparity_binary,    0, 0, NULL);
   op_Shrs      = new_ir_op(iro_Shrs,      "Shrs",      op_pin_state_floats, N,       oparity_binary,    0, 0, NULL);
   op_Rot       = new_ir_op(iro_Rot,       "Rot",       op_pin_state_floats, N,       oparity_binary,    0, 0, NULL);
-  op_Conv      = new_ir_op(iro_Conv,      "Conv",      op_pin_state_floats, N,       oparity_unary,     0, 0, NULL);
+  op_Conv      = new_ir_op(iro_Conv,      "Conv",      op_pin_state_floats, N,       oparity_unary,     0, sizeof(conv_attr), NULL);
   op_Cast      = new_ir_op(iro_Cast,      "Cast",      op_pin_state_floats, N|H,     oparity_unary,     0, sizeof(cast_attr), NULL);
   op_Carry     = new_ir_op(iro_Carry,     "Carry",     op_pin_state_floats, C,       oparity_binary,    0, 0, NULL);
   op_Borrow    = new_ir_op(iro_Borrow,    "Borrow",    op_pin_state_floats, N,       oparity_binary,    0, 0, NULL);
@@ -256,29 +304,33 @@ init_op(void)
   op_Store     = new_ir_op(iro_Store,     "Store",     op_pin_state_exc_pinned, F,   oparity_any,      -1, sizeof(store_attr), NULL);
   op_Alloc     = new_ir_op(iro_Alloc,     "Alloc",     op_pin_state_pinned, F,       oparity_any,      -1, sizeof(alloc_attr), NULL);
   op_Free      = new_ir_op(iro_Free,      "Free",      op_pin_state_pinned, N,       oparity_any,      -1, sizeof(free_attr), NULL);
-  op_Sync      = new_ir_op(iro_Sync,      "Sync",      op_pin_state_pinned, N,       oparity_any,      -1, 0, NULL);
+  op_Sync      = new_ir_op(iro_Sync,      "Sync",      op_pin_state_pinned, N,       oparity_dynamic,  -1, 0, NULL);
 
-  op_Proj      = new_ir_op(iro_Proj,      "Proj",      op_pin_state_floats, N,       oparity_any,      -1, sizeof(long), NULL);
+  op_Proj      = new_ir_op(iro_Proj,      "Proj",      op_pin_state_floats, N,       oparity_unary,    -1, sizeof(long), NULL);
   op_Tuple     = new_ir_op(iro_Tuple,     "Tuple",     op_pin_state_floats, L,       oparity_variable, -1, 0, NULL);
   op_Id        = new_ir_op(iro_Id,        "Id",        op_pin_state_floats, N,       oparity_any,      -1, 0, NULL);
-  op_Bad       = new_ir_op(iro_Bad,       "Bad",       op_pin_state_pinned, X|F,     oparity_zero,     -1, 0, NULL);
-  op_Confirm   = new_ir_op(iro_Confirm,   "Confirm",   op_pin_state_floats, H,       oparity_any,      -1, sizeof(confirm_attr), NULL);
+  op_Bad       = new_ir_op(iro_Bad,       "Bad",       op_pin_state_pinned, X|F|S,   oparity_zero,     -1, 0, NULL);
+  op_Confirm   = new_ir_op(iro_Confirm,   "Confirm",   op_pin_state_pinned, H,       oparity_any,      -1, sizeof(confirm_attr), NULL);
 
-  op_Unknown   = new_ir_op(iro_Unknown,   "Unknown",   op_pin_state_pinned, X|F,     oparity_zero,     -1, 0, NULL);
+  op_Unknown   = new_ir_op(iro_Unknown,   "Unknown",   op_pin_state_pinned, X|F|S,   oparity_zero,     -1, 0, NULL);
   op_Filter    = new_ir_op(iro_Filter,    "Filter",    op_pin_state_pinned, N,       oparity_variable, -1, sizeof(filter_attr), NULL);
   op_Break     = new_ir_op(iro_Break,     "Break",     op_pin_state_pinned, X,       oparity_zero,     -1, 0, NULL);
   op_CallBegin = new_ir_op(iro_CallBegin, "CallBegin", op_pin_state_pinned, X|I,     oparity_any,      -1, sizeof(callbegin_attr), NULL);
-  op_EndReg    = new_ir_op(iro_EndReg,    "EndReg",    op_pin_state_pinned, X|I,     oparity_any,      -1, sizeof(end_attr), NULL);
-  op_EndExcept = new_ir_op(iro_EndExcept, "EndExcept", op_pin_state_pinned, X|I,     oparity_any,      -1, sizeof(end_attr), NULL);
+  op_EndReg    = new_ir_op(iro_EndReg,    "EndReg",    op_pin_state_pinned, X|I,     oparity_dynamic,  -1, sizeof(end_attr), NULL);
+  op_EndExcept = new_ir_op(iro_EndExcept, "EndExcept", op_pin_state_pinned, X|I,     oparity_dynamic,  -1, sizeof(end_attr), NULL);
 
   op_NoMem     = new_ir_op(iro_NoMem,     "NoMem",     op_pin_state_pinned, N,       oparity_zero,     -1, 0, NULL);
   op_Mux       = new_ir_op(iro_Mux,       "Mux",       op_pin_state_floats, N,       oparity_trinary,  -1, 0, NULL);
+  op_Psi       = new_ir_op(iro_Psi,       "Psi",       op_pin_state_floats, N,       oparity_variable, -1, 0, NULL);
   op_CopyB     = new_ir_op(iro_CopyB,     "CopyB",     op_pin_state_mem_pinned, F|H, oparity_trinary,  -1, sizeof(copyb_attr), NULL);
 
   op_InstOf    = new_ir_op(iro_InstOf,    "InstOf",    op_pin_state_mem_pinned, H,   oparity_unary,    -1, sizeof(io_attr), NULL);
   op_Raise     = new_ir_op(iro_Raise,     "Raise",     op_pin_state_pinned,     H|X, oparity_any,      -1, 0, NULL);
   op_Bound     = new_ir_op(iro_Bound,     "Bound",     op_pin_state_exc_pinned, F|H, oparity_trinary,  -1, sizeof(bound_attr), NULL);
 
+  op_Pin       = new_ir_op(iro_Pin,       "Pin",       op_pin_state_pinned, H,       oparity_unary,    -1, 0, NULL);
+
+#undef S
 #undef H
 #undef Y
 #undef F
@@ -286,7 +338,7 @@ init_op(void)
 #undef X
 #undef C
 #undef L
-}
+}  /* init_op */
 
 
 /* free memory used by irop module. */
@@ -350,26 +402,29 @@ void finish_op(void) {
   free_ir_op (op_EndExcept); op_EndExcept = NULL;
 
   free_ir_op (op_NoMem    ); op_NoMem     = NULL;
+  free_ir_op (op_Psi      ); op_Psi       = NULL;
   free_ir_op (op_Mux      ); op_Mux       = NULL;
   free_ir_op (op_CopyB    ); op_CopyB     = NULL;
 
   free_ir_op (op_InstOf   ); op_InstOf    = NULL;
   free_ir_op (op_Raise    ); op_Raise     = NULL;
   free_ir_op (op_Bound    ); op_Bound     = NULL;
+
+  free_ir_op (op_Pin      ); op_Pin       = NULL;
 }
 
 /* Returns the string for the opcode. */
 const char *get_op_name (const ir_op *op) {
   return get_id_str(op->name);
-}
+}  /* get_op_name */
 
-opcode (get_op_code)(const ir_op *op){
+ir_opcode (get_op_code)(const ir_op *op){
   return _get_op_code(op);
-}
+}  /* get_op_code */
 
 ident *(get_op_ident)(const ir_op *op){
   return _get_op_ident(op);
-}
+}  /* get_op_ident */
 
 const char *get_op_pin_state_name(op_pin_state s) {
   switch(s) {
@@ -380,43 +435,43 @@ const char *get_op_pin_state_name(op_pin_state s) {
   XXX(op_pin_state_mem_pinned);
 #undef XXX
   }
-       return "<none>";
-}
+  return "<none>";
+}  /* get_op_pin_state_name */
 
 op_pin_state (get_op_pinned)(const ir_op *op) {
   return _get_op_pinned(op);
-}
+}  /* get_op_pinned */
 
 /* Sets op_pin_state_pinned in the opcode.  Setting it to floating has no effect
    for Phi, Block and control flow nodes. */
-void      set_op_pinned(ir_op *op, op_pin_state op_pin_state_pinned) {
+void set_op_pinned(ir_op *op, op_pin_state op_pin_state_pinned) {
   if (op == op_Block || op == op_Phi || is_cfopcode(op)) return;
   op->op_pin_state_pinned = op_pin_state_pinned;
-}
+}  /* set_op_pinned */
 
 /* retrieve the next free opcode */
 unsigned get_next_ir_opcode(void) {
   return next_iro++;
-}
+}  /* get_next_ir_opcode */
 
 /* Returns the next free n IR opcode number, allows to register a bunch of user ops */
 unsigned get_next_ir_opcodes(unsigned num) {
   unsigned base = next_iro;
   next_iro += num;
   return base;
-}
+}  /* get_next_ir_opcodes */
 
 /* Returns the generic function pointer from an ir operation. */
 op_func (get_generic_function_ptr)(const ir_op *op) {
   return _get_generic_function_ptr(op);
-}
+}  /* get_generic_function_ptr */
 
 /* Store a generic function pointer into an ir operation. */
 void (set_generic_function_ptr)(ir_op *op, op_func func) {
   _set_generic_function_ptr(op, func);
-}
+}  /* set_generic_function_ptr */
 
 /* Returns the ir_op_ops of an ir_op. */
 const ir_op_ops *(get_op_ops)(const ir_op *op) {
   return _get_op_ops(op);
-}
+}  /* get_op_ops */