automatically generate most getter/setter functions of firm nodes
[libfirm] / ir / ir / irop.c
index 79a0730..5f98506 100644 (file)
 /*
- * 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-2008 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.
  */
 
-#ifdef HAVE_CONFIG_H
-# include <config.h>
-#endif
-
-# include <string.h>
-
-# include "irop_t.h"
-# include "irnode_t.h"
-# include "misc.h"
-
-ir_op *op_Block;           ir_op *get_op_Block     () { return op_Block;     }
-
-ir_op *op_Start;          ir_op *get_op_Start     () { return op_Start;     }
-ir_op *op_End;            ir_op *get_op_End       () { return op_End;       }
-ir_op *op_Jmp;            ir_op *get_op_Jmp       () { return op_Jmp;       }
-ir_op *op_Cond;                   ir_op *get_op_Cond      () { return op_Cond;      }
-ir_op *op_Return;         ir_op *get_op_Return    () { return op_Return;    }
-ir_op *op_Raise;          ir_op *get_op_Raise     () { return op_Raise;     }
-
-ir_op *op_Sel;            ir_op *get_op_Sel       () { return op_Sel;       }
-ir_op *op_InstOf;         ir_op *get_op_InstOf    () { return op_InstOf;    }
-
-ir_op *op_Const;          ir_op *get_op_Const     () { return op_Const;     }
-ir_op *op_SymConst;       ir_op *get_op_SymConst  () { return op_SymConst;  }
-
-ir_op *op_Call;                   ir_op *get_op_Call      () { return op_Call;      }
-ir_op *op_Add;            ir_op *get_op_Add       () { return op_Add;       }
-ir_op *op_Sub;            ir_op *get_op_Sub       () { return op_Sub;       }
-ir_op *op_Minus;          ir_op *get_op_Minus     () { return op_Minus;     }
-ir_op *op_Mul;            ir_op *get_op_Mul       () { return op_Mul;       }
-ir_op *op_Quot;                   ir_op *get_op_Quot      () { return op_Quot;      }
-ir_op *op_DivMod;         ir_op *get_op_DivMod    () { return op_DivMod;    }
-ir_op *op_Div;            ir_op *get_op_Div       () { return op_Div;       }
-ir_op *op_Mod;            ir_op *get_op_Mod       () { return op_Mod;       }
-ir_op *op_Abs;            ir_op *get_op_Abs       () { return op_Abs;       }
-ir_op *op_And;            ir_op *get_op_And       () { return op_And;       }
-ir_op *op_Or;             ir_op *get_op_Or        () { return op_Or;        }
-ir_op *op_Eor;            ir_op *get_op_Eor       () { return op_Eor;       }
-ir_op *op_Not;            ir_op *get_op_Not       () { return op_Not;       }
-ir_op *op_Cmp;            ir_op *get_op_Cmp       () { return op_Cmp;       }
-ir_op *op_Shl;            ir_op *get_op_Shl       () { return op_Shl;       }
-ir_op *op_Shr;            ir_op *get_op_Shr       () { return op_Shr;       }
-ir_op *op_Shrs;                   ir_op *get_op_Shrs      () { return op_Shrs;      }
-ir_op *op_Rot;            ir_op *get_op_Rot       () { return op_Rot;       }
-ir_op *op_Conv;                   ir_op *get_op_Conv      () { return op_Conv;      }
-ir_op *op_Cast;            ir_op *get_op_Cast      () { return op_Cast;      }
-
-ir_op *op_Phi;            ir_op *get_op_Phi       () { return op_Phi;       }
-
-ir_op *op_Load;                   ir_op *get_op_Load      () { return op_Load;      }
-ir_op *op_Store;          ir_op *get_op_Store     () { return op_Store;     }
-ir_op *op_Alloc;          ir_op *get_op_Alloc     () { return op_Alloc;     }
-ir_op *op_Free;                   ir_op *get_op_Free      () { return op_Free;      }
-ir_op *op_Sync;                   ir_op *get_op_Sync      () { return op_Sync;      }
-
-ir_op *op_Tuple;          ir_op *get_op_Tuple     () { return op_Tuple;     }
-ir_op *op_Proj;                   ir_op *get_op_Proj      () { return op_Proj;      }
-ir_op *op_Id;             ir_op *get_op_Id        () { return op_Id;        }
-ir_op *op_Bad;            ir_op *get_op_Bad       () { return op_Bad;       }
-
-ir_op *op_Unknown;        ir_op *get_op_Unknown   () { return op_Unknown;   }
-ir_op *op_Filter;         ir_op *get_op_Filter    () { return op_Filter;    }
-ir_op *op_Break;          ir_op *get_op_Break     () { return op_Break;     }
-ir_op *op_CallBegin;      ir_op *get_op_CallBegin () { return op_CallBegin; }
-ir_op *op_EndReg;         ir_op *get_op_EndReg    () { return op_EndReg;    }
-ir_op *op_EndExcept;      ir_op *get_op_EndExcept () { return op_EndExcept; }
-
-
-ir_op *
-new_ir_op (opcode code, char *name, op_pinned p, int labeled, size_t attr_size)
-{
-  ir_op *res;
-
-  res = (ir_op *) xmalloc (sizeof (ir_op));
-  res->code = code;
-  res->name = id_from_str(name, strlen(name));
-  res->pinned = p;
-  res->attr_size = attr_size;
-  res->labeled = labeled;   /* For vcg dumping.
-                               Set labeled = 1 if the edges should be
-                              enumarated in vcg output, otherwise set
-                              labeled = 0. */
-  return res;
-}
+/**
+ * @file
+ * @brief   Representation of opcode of intermediate operation.
+ * @author  Christian Schaefer, Goetz Lindenmaier, Michael Beck
+ * @version $Id$
+ */
+#include "config.h"
+
+#include <string.h>
+
+#include "irop_t.h"
+#include "irnode_t.h"
+#include "irhooks.h"
+#include "irbackedge_t.h"
+
+#include "iropt_t.h"
+#include "irvrfy_t.h"
+#include "reassoc_t.h"
+
+#include "xmalloc.h"
+
+void be_init_op(void);
 
+/** the available next opcode */
+static unsigned next_iro = iro_MaxOpcode;
 
-void
-init_op(void)
-{
-  op_Block = new_ir_op (iro_Block, "Block",  pinned, 1, sizeof (block_attr));
-
-  op_Start = new_ir_op (iro_Start, "Start",  pinned, 0, sizeof (start_attr));
-  op_End   = new_ir_op (iro_End,   "End",    pinned, 0, 0);
-  op_Jmp   = new_ir_op (iro_Jmp,   "Jmp",    pinned, 0, 0);
-  op_Cond  = new_ir_op (iro_Cond,  "Cond",   pinned, 1, sizeof(cond_attr));
-  op_Return= new_ir_op (iro_Return,"Return", pinned, 1, 0);
-  op_Raise = new_ir_op (iro_Raise, "Raise",  pinned, 1, 0);
-
-  op_Const = new_ir_op (iro_Const, "Const",  floats, 0, sizeof (struct tarval *));
-  op_SymConst = new_ir_op (iro_SymConst, "SymConst",
-                                            floats, 0, sizeof (symconst_attr));
-
-  op_Sel   = new_ir_op (iro_Sel,   "Sel",    floats, 1, sizeof (sel_attr));
-  op_InstOf= new_ir_op (iro_InstOf,"InstOf", floats, 1, sizeof (sel_attr));
-
-  op_Call  = new_ir_op (iro_Call,  "Call",   pinned, 1, sizeof (call_attr));
-  op_Add   = new_ir_op (iro_Add,   "Add",    floats, 0, 0);
-  op_Minus = new_ir_op (iro_Minus, "Minus",  floats, 0, 0);
-  op_Sub   = new_ir_op (iro_Sub,   "Sub",    floats, 1, 0);
-  op_Mul   = new_ir_op (iro_Mul,   "Mul",    floats, 0, 0);
-  op_Quot  = new_ir_op (iro_Quot,  "Quot",   pinned, 1, sizeof(struct irnode **));
-  op_DivMod= new_ir_op (iro_DivMod,"DivMod", pinned, 1, sizeof(struct irnode **));
-  op_Div   = new_ir_op (iro_Div,   "Div",    pinned, 1, sizeof(struct irnode **));
-  op_Mod   = new_ir_op (iro_Mod,   "Mod",    pinned, 1, sizeof(struct irnode **));
-  op_Abs   = new_ir_op (iro_Abs,   "Abs",    floats, 0, 0);
-  op_And   = new_ir_op (iro_And,   "And",    floats, 0, 0);
-  op_Or    = new_ir_op (iro_Or,    "Or",     floats, 0, 0);
-  op_Eor   = new_ir_op (iro_Eor,   "Eor",    floats, 0, 0);
-  op_Not   = new_ir_op (iro_Not,   "Not",    floats, 0, 0);
-  op_Cmp   = new_ir_op (iro_Cmp,   "Cmp",    floats, 1, 0);
-  op_Shl   = new_ir_op (iro_Shl,   "Shl",    floats, 1, 0);
-  op_Shr   = new_ir_op (iro_Shr,   "Shr",    floats, 1, 0);
-  op_Shrs  = new_ir_op (iro_Shrs,  "Shrs",   floats, 1, 0);
-  op_Rot   = new_ir_op (iro_Rot,   "Rot",    floats, 1, 0);
-  op_Conv  = new_ir_op (iro_Conv,  "Conv",   floats, 0, 0);
-  op_Cast  = new_ir_op (iro_Cast,  "Cast",   floats, 0, sizeof (cast_attr));
-
-  op_Phi   = new_ir_op (iro_Phi,   "Phi",    pinned, 1, sizeof (int));
-
-  op_Load  = new_ir_op (iro_Load,  "Load",   pinned, 1, sizeof(struct irnode **));
-  op_Store = new_ir_op (iro_Store, "Store",  pinned, 1, sizeof(struct irnode **));
-  op_Alloc = new_ir_op (iro_Alloc, "Alloc",  pinned, 1, sizeof (alloc_attr));
-  op_Free  = new_ir_op (iro_Free,  "Free",   pinned, 1, sizeof (type *));
-  op_Sync  = new_ir_op (iro_Sync,  "Sync",   pinned, 0, 0);
-
-  op_Proj  = new_ir_op (iro_Proj,  "Proj",   floats, 0, sizeof (long));
-  op_Tuple = new_ir_op (iro_Tuple, "Tuple",  floats, 1, 0);
-  op_Id    = new_ir_op (iro_Id,    "Id",     floats, 0, 0);
-  op_Bad   = new_ir_op (iro_Bad,   "Bad",    floats, 0, 0);
-
-  op_Unknown   = new_ir_op (iro_Unknown,   "Unknown",   floats, 0, 0);
-  op_Filter    = new_ir_op (iro_Filter,    "Filter",    pinned, 0, sizeof(filter_attr));
-  op_Break     = new_ir_op (iro_Break,     "Break",     pinned, 0, 0);
-  op_CallBegin = new_ir_op (iro_CallBegin, "CallBegin", pinned, 0, sizeof(callbegin_attr));
-  op_EndReg    = new_ir_op (iro_EndReg,    "EndReg",    pinned, 0, sizeof(end_attr));
-  op_EndExcept = new_ir_op (iro_EndExcept, "EndExcept", pinned, 0, sizeof(end_attr));
+/*
+ * Copies all attributes stored in the old node to the new node.
+ * Assumes both have the same opcode and sufficient size.
+ */
+void default_copy_attr(ir_graph *irg, const ir_node *old_node,
+                       ir_node *new_node)
+{
+       unsigned size = firm_add_node_size;
+       (void) irg;
+
+       assert(get_irn_op(old_node) == get_irn_op(new_node));
+       memcpy(&new_node->attr, &old_node->attr, get_op_attr_size(get_irn_op(old_node)));
+
+       if (size > 0) {
+               /* copy additional node data */
+               memcpy(get_irn_data(new_node, void, size), get_irn_data(old_node, void, size), size);
+       }
 }
 
-/* Returns the string for the opcode. */
-const char  *get_op_name      (ir_op *op) {
-  return get_id_str(op->name);
+/**
+ * Copies all Call attributes stored in the old node to the new node.
+ */
+static void call_copy_attr(ir_graph *irg, const ir_node *old_node,
+                           ir_node *new_node)
+{
+       default_copy_attr(irg, old_node, new_node);
+       remove_Call_callee_arr(new_node);
 }
 
-opcode get_op_code (ir_op *op){
-  return op->code;
+/**
+ * Copies all Block attributes stored in the old node to the new node.
+ */
+static void block_copy_attr(ir_graph *irg, const ir_node *old_node,
+                            ir_node *new_node)
+{
+       default_copy_attr(irg, old_node, new_node);
+       new_node->attr.block.irg.irg       = irg;
+       new_node->attr.block.phis          = NULL;
+       new_node->attr.block.cg_backedge   = NULL;
+       new_node->attr.block.backedge      = new_backedge_arr(irg->obst, get_irn_arity(new_node));
+       new_node->attr.block.block_visited = 0;
+       memset(&new_node->attr.block.dom, 0, sizeof(new_node->attr.block.dom));
+       memset(&new_node->attr.block.pdom, 0, sizeof(new_node->attr.block.pdom));
+       /* TODO: we should probably create a new entity. But we somehow have to
+        * patch the stuff at the same time */
+       new_node->attr.block.entity            = NULL;
+       new_node->attr.block.phis              = NULL;
+       INIT_LIST_HEAD(&new_node->attr.block.succ_head);
 }
 
-ident *get_op_ident(ir_op *op){
-  return op->name;
+/**
+ * Copies all phi attributes stored in old node to the new node
+ */
+static void phi_copy_attr(ir_graph *irg, const ir_node *old_node,
+                          ir_node *new_node)
+{
+       default_copy_attr(irg, old_node, new_node);
+       new_node->attr.phi.next       = NULL;
+       new_node->attr.phi.u.backedge = new_backedge_arr(irg->obst, get_irn_arity(new_node));
 }
 
-op_pinned get_op_pinned (ir_op *op){
-  return op->pinned;
+/**
+ * Copies all filter attributes stored in old node to the new node
+ */
+static void filter_copy_attr(ir_graph *irg, const ir_node *old_node,
+                             ir_node *new_node)
+{
+       default_copy_attr(irg, old_node, new_node);
+       new_node->attr.filter.backedge = new_backedge_arr(irg->obst, get_irn_arity(new_node));
 }
 
-/* Sets 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_pinned pinned) {
-  if (op == op_Block || op == op_Phi || is_cfopcode(op)) return;
-  op->pinned = pinned;
+/**
+ * Copies all ASM attributes stored in old node to the new node
+ */
+static void ASM_copy_attr(ir_graph *irg, const ir_node *old_node,
+                          ir_node *new_node)
+{
+       default_copy_attr(irg, old_node, new_node);
+       new_node->attr.assem.input_constraints  = DUP_ARR_D(ir_asm_constraint, irg->obst, old_node->attr.assem.input_constraints);
+       new_node->attr.assem.output_constraints = DUP_ARR_D(ir_asm_constraint, irg->obst, old_node->attr.assem.output_constraints);
+       new_node->attr.assem.clobbers = DUP_ARR_D(ir_asm_constraint, irg->obst, old_node->attr.assem.clobbers);
 }
 
+/**
+ * Sets the default copy_attr operation for an ir_ops
+ *
+ * @param code   the opcode for the default operation
+ * @param ops    the operations initialized
+ *
+ * @return
+ *    The operations.
+ */
+static ir_op_ops *firm_set_default_copy_attr(ir_opcode code, ir_op_ops *ops)
+{
+       switch (code) {
+       case iro_Call:
+               ops->copy_attr = call_copy_attr;
+               break;
+       case iro_Block:
+               ops->copy_attr = block_copy_attr;
+               break;
+       case iro_Phi:
+               ops->copy_attr = phi_copy_attr;
+               break;
+       case iro_Filter:
+               ops->copy_attr = filter_copy_attr;
+               break;
+       case iro_ASM:
+               ops->copy_attr = ASM_copy_attr;
+               break;
+       default:
+               /* 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(unsigned 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)
+{
+       ir_op *res = XMALLOCZ(ir_op);
+
+       res->code      = code;
+       res->name      = new_id_from_chars(name, strlen(name));
+       res->pin_state = p;
+       res->attr_size = attr_size;
+       res->flags     = flags;
+       res->opar      = opar;
+       res->op_index  = op_index;
+       res->tag       = 0;
+
+       if (ops)
+               memcpy(&res->ops, ops, sizeof(res->ops));
+       else /* no given ops, set all operations to NULL */
+               memset(&res->ops, 0, sizeof(res->ops));
+
+       firm_set_default_operations(code, &res->ops);
+       firm_set_default_copy_attr(code, &res->ops);
+       firm_set_default_verifyer(code, &res->ops);
+       firm_set_default_reassoc(code, &res->ops);
+
+       add_irp_opcode(res);
+
+       hook_new_ir_op(res);
+       return res;
+}  /* new_ir_op */
+
+void free_ir_op(ir_op *code)
+{
+       hook_free_ir_op(code);
 
-/* returns the attribute size of the operator. */
-int get_op_attr_size (ir_op *op) {
-  return op->attr_size;
-}
+       remove_irp_opcode(code);
+       free(code);
+}  /* free_ir_op */
 
-int is_cfopcode(ir_op *op) {
-  return ((op == op_Start)
-          || (op == op_Jmp)
-          || (op == op_Cond)
-          || (op == op_Return)
-          || (op == op_Raise)
-          || (op == op_Bad)
-         || (op == op_End)
-          || (op == op_Unknown)
-          || (op == op_Break)
-         || (op == op_CallBegin)
-         || (op == op_EndReg)
-         || (op == op_EndExcept));
-}
+/* Returns the string for the opcode. */
+const char *get_op_name (const ir_op *op)
+{
+       return get_id_str(op->name);
+}  /* get_op_name */
+
+unsigned (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) {
+#define XXX(s) case s: return #s
+       XXX(op_pin_state_floats);
+       XXX(op_pin_state_pinned);
+       XXX(op_pin_state_exc_pinned);
+       XXX(op_pin_state_mem_pinned);
+#undef XXX
+       }
+       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 pinned)
+{
+       if (op == op_Block || op == op_Phi || is_op_cfopcode(op)) return;
+       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 true if the operation manipulates interprocedural control flow:
-   CallBegin, EndReg, EndExcept */
-int is_ip_cfopcode(ir_op *op) {
-  return ((op == op_CallBegin)
-         || (op == op_EndReg)
-         || (op == op_EndExcept));
+/* 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 */
+
+irop_flags get_op_flags(const ir_op *op)
+{
+       return op->flags;
 }
+
+#include "gen_irop.c.inl"