fix bad proj optimisation, fix loads missing the result proj
[libfirm] / ir / be / benode_t.h
index 642e60d..ff0af86 100644 (file)
@@ -1,26 +1,39 @@
-/**
- * @file   benode_t.h
- * @date   17.05.2005
- * @author Sebastian Hack
+/*
+ * 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.
  *
- * Backend node support.
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
  *
- * Copyright (C) 2005 Universitaet Karlsruhe
- * Released under the GPL
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
  */
 
-#ifndef _BENODE_T_H
-#define _BENODE_T_H
-
-#include "firm_config.h"
+/**
+ * @file
+ * @brief       Backend node support for generic backend nodes.
+ * @author      Sebastian Hack
+ * @date        17.05.2005
+ * @version     $Id$
+ *
+ * Backend node support for generic backend nodes.
+ * This file provides Perm, Copy, Spill and Reload nodes.
+ */
+#ifndef FIRM_BE_BENODE_T_H
+#define FIRM_BE_BENODE_T_H
 
 #include <limits.h>
 
-#include "irmode.h"
+#include "firm_types.h"
 #include "irnode.h"
-#include "entity_t.h"
-
-#include "be_t.h"
 #include "bearch.h"
 
 #define BE_OUT_POS(p) (-((p) + 1))
@@ -39,6 +52,7 @@ extern ir_op *op_be_Call;
 extern ir_op *op_be_Return;
 extern ir_op *op_be_IncSP;
 extern ir_op *op_be_AddSP;
+extern ir_op *op_be_SubSP;
 extern ir_op *op_be_SetSP;
 extern ir_op *op_be_RegParams;
 extern ir_op *op_be_StackParam;
@@ -48,7 +62,7 @@ extern ir_op *op_be_FrameStore;
 extern ir_op *op_be_Barrier;
 
 typedef enum {
-       beo_NoBeOp = 0,
+       beo_NoBeOp = -1,
        beo_Spill,
        beo_Reload,
        beo_Perm,
@@ -59,6 +73,7 @@ typedef enum {
        beo_Call,
        beo_Return,
        beo_AddSP,
+       beo_SubSP,
        beo_IncSP,
        beo_SetSP,
        beo_RegParams,
@@ -105,7 +120,8 @@ enum {
 /**
  * Make a new Spill node.
  */
-ir_node *be_new_Spill(const arch_register_class_t *cls, const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *node_to_spill);
+ir_node *be_new_Spill(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
+       ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *to_spill);
 
 /**
  * Position numbers for the be_Reload inputs.
@@ -118,7 +134,8 @@ enum {
 /**
  * Make a new Reload node.
  */
-ir_node *be_new_Reload(const arch_register_class_t *cls, const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *spill_node, ir_mode *mode);
+ir_node *be_new_Reload(const arch_register_class_t *cls, const arch_register_class_t *cls_frame,
+       ir_graph *irg, ir_node *bl, ir_node *frame, ir_node *mem, ir_mode *mode);
 
 /**
  * Position numbers for the be_Copy inputs.
@@ -146,11 +163,39 @@ ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *b
 ir_node *be_new_MemPerm(const arch_env_t *arch_env, ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
 ir_node *be_new_Keep(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
 
+void be_Keep_add_node(ir_node *keep, const arch_register_class_t *cls, ir_node *node);
+
+/**
+ * Position numbers for the be_FrameLoad inputs
+ */
+enum {
+       be_pos_FrameLoad_mem = 0,
+       be_pos_FrameLoad_ptr = 1
+};
+
 ir_node *be_new_FrameLoad(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
-                                                 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, entity *ent);
+                                                 ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_entity *ent);
+
+/**
+ * Position numbers for the be_FrameStore inputs
+ */
+enum {
+       be_pos_FrameStore_mem = 0,
+       be_pos_FrameStore_ptr = 1,
+       be_pos_FrameStore_val = 2
+};
+
 ir_node *be_new_FrameStore(const arch_register_class_t *cls_frame, const arch_register_class_t *cls_data,
-                                                  ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, entity *ent);
-ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, entity *ent);
+                                                  ir_graph *irg, ir_node *bl, ir_node *mem, ir_node *frame, ir_node *data, ir_entity *ent);
+
+/**
+ * Position numbers for the be_FrameAddr inputs
+ */
+enum {
+       be_pos_FrameAddr_ptr = 0
+};
+
+ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_entity *ent);
 
 /**
  * Position numbers for the be_AddSP inputs
@@ -181,6 +226,35 @@ enum {
  */
 ir_node *be_new_AddSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
 
+/**
+ * Position numbers for the be_SubSP inputs
+ */
+enum {
+       be_pos_SubSP_old_sp = 0,
+       be_pos_SubSP_size   = 1,
+       be_pos_SubSP_last   = 2
+};
+
+enum {
+       pn_be_SubSP_res  = 0,
+       pn_be_SubSP_M    = 1,
+       pn_be_SubSP_last = 2
+};
+
+/**
+ * Make a new SubSP node.
+ * A SubSP node expresses a decrease of the stack pointer in the direction the stack
+ * grows. In contrast to IncSP, the amount of bytes the stack pointer is grown, is not
+ * given by a constant but an ordinary Firm node.
+ * @param sp     The stack pointer register.
+ * @param irg    The graph.
+ * @param bl     The block.
+ * @param old_sp The node representing the old stack pointer value.
+ * @param sz     The node expressing the size by which the stack pointer shall be grown.
+ * @return       A new DecSP node.
+ */
+ir_node *be_new_SubSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *sz);
+
 ir_node *be_new_SetSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *operand, ir_node *mem);
 
 /**
@@ -195,7 +269,7 @@ ir_node *be_new_SetSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_
  * @return       A new stack pointer increment/decrement node.
  * @note         This node sets a register constraint to the @p sp register on its output.
  */
-ir_node *be_new_IncSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, ir_node *mem, int offset);
+ir_node *be_new_IncSP(const arch_register_t *sp, ir_graph *irg, ir_node *bl, ir_node *old_sp, int offset);
 
 /** Returns the previous node that computes the stack pointer. */
 ir_node *be_get_IncSP_pred(ir_node *incsp);
@@ -203,9 +277,6 @@ ir_node *be_get_IncSP_pred(ir_node *incsp);
 /** Sets the previous node that computes the stack pointer. */
 void     be_set_IncSP_pred(ir_node *incsp, ir_node *pred);
 
-/** Returns the memory input of the IncSP. */
-ir_node *be_get_IncSP_mem(ir_node *irn);
-
 /**
  * Sets a new offset to a IncSP node.
  * A positive offset means expanding the stack, a negative offset shrinking
@@ -218,9 +289,9 @@ void     be_set_IncSP_offset(ir_node *irn, int offset);
 int be_get_IncSP_offset(const ir_node *irn);
 
 /** Gets the call entity or NULL if this is no static call. */
-entity  *be_Call_get_entity(const ir_node *call);
+ir_entity  *be_Call_get_entity(const ir_node *call);
 /** Sets the call entity. */
-void     be_Call_set_entity(ir_node *call, entity *ent);
+void     be_Call_set_entity(ir_node *call, ir_entity *ent);
 /** Gets the call type. */
 ir_type *be_Call_get_type(ir_node *call);
 /** Sets the call type. */
@@ -272,14 +343,38 @@ ir_node *be_new_Return(dbg_info *dbg, ir_graph *irg, ir_node *bl, int n_res, int
 /** Returns the number of real returns values */
 int be_Return_get_n_rets(ir_node *ret);
 
+/** appends a node to the return node, returns the position of the node */
+int be_Return_append_node(ir_node *ret, ir_node *node);
+
+/**
+ * StackParam input positions
+ */
+enum {
+       be_pos_StackParam_ptr = 0
+};
+
 /**
  * Construct a new Stack Parameter node.
  */
-ir_node *be_new_StackParam(const arch_register_class_t *cls, const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_mode *mode, ir_node *frame_pointer, entity *ent);
+ir_node *be_new_StackParam(const arch_register_class_t *cls, const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_mode *mode, ir_node *frame_pointer, ir_entity *ent);
 ir_node *be_new_RegParams(ir_graph *irg, ir_node *bl, int n_out);
 
 ir_node *be_new_Barrier(ir_graph *irg, ir_node *bl, int n, ir_node *in[]);
 
+/**
+ * Appends a node to a barrier, returns the result proj of the node
+ */
+ir_node *be_Barrier_append_node(ir_node *barrier, ir_node *node);
+
+/**
+ * Appends a register out requirement to a RegParams node
+ *
+ * @returns the proj node for the new register
+ */
+ir_node *be_RegParams_append_out_reg(ir_node *regparams,
+                                     const arch_env_t *arch_env,
+                                     const arch_register_t *reg);
+
 /**
  * Make a spill node.
  *
@@ -329,6 +424,7 @@ int be_is_Return(const ir_node *irn);
 int be_is_IncSP(const ir_node *irn);
 int be_is_SetSP(const ir_node *irn);
 int be_is_AddSP(const ir_node *irn);
+int be_is_SubSP(const ir_node *irn);
 int be_is_RegParams(const ir_node *irn);
 int be_is_StackParam(const ir_node *irn);
 int be_is_FrameAddr(const ir_node *irn);
@@ -341,16 +437,23 @@ int be_is_Barrier(const ir_node *irn);
  *
  * Returns the frame entity used by the be node
  */
-entity* be_get_frame_entity(const ir_node *irn);
+ir_entity *be_get_frame_entity(const ir_node *irn);
+
+/**
+ * Returns the frame offset of this node.
+ */
+int be_get_frame_offset(const ir_node *irn);
 
 ir_node* be_get_Reload_mem(const ir_node *irn);
-ir_node* be_get_Reload_frame(const ir_node* irn);
+ir_node *be_get_Reload_frame(const ir_node *irn);
+ir_node* be_get_Spill_val(const ir_node *irn);
+ir_node *be_get_Spill_frame(const ir_node *irn);
 
-void be_set_MemPerm_in_entity(const ir_node *irn, int n, entity* ent);
-entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
+void be_set_MemPerm_in_entity(const ir_node *irn, int n, ir_entity* ent);
+ir_entity *be_get_MemPerm_in_entity(const ir_node *irn, int n);
 
-void be_set_MemPerm_out_entity(const ir_node *irn, int n, entity* ent);
-entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
+void be_set_MemPerm_out_entity(const ir_node *irn, int n, ir_entity* ent);
+ir_entity *be_get_MemPerm_out_entity(const ir_node *irn, int n);
 
 int be_get_MemPerm_entity_arity(const ir_node *irn);
 
@@ -388,6 +491,14 @@ void be_node_set_flags(ir_node *irn, int pos, arch_irn_flags_t flags);
  */
 void be_node_set_reg_class(ir_node *irn, int pos, const arch_register_class_t *cls);
 
+/**
+ * Set the register requirement type of a node.
+ * @param irn The node itself.
+ * @param pos The position (0..n) for arguments, (-1..-m) for results.
+ * @param flags The register requirement type to set for that node and position.
+ */
+void be_node_set_req_type(ir_node *irn, int pos, arch_register_req_type_t type);
+
 /**
  * Make a new phi handler.
  * @param env The architecture environment.
@@ -407,9 +518,21 @@ void be_phi_handler_free(arch_irn_handler_t *handler);
  */
 void be_phi_handler_reset(arch_irn_handler_t *handler);
 
+/**
+ * Set the register requirements for a phi node.
+ */
+void be_set_phi_reg_req(const arch_env_t *arch_env, ir_node *phi,
+                        const arch_register_req_t *req);
+
+/*
+ * Set flags for a phi node
+ */
+void be_set_phi_flags(const arch_env_t *arch_env, ir_node *phi,
+                      arch_irn_flags_t flags);
+
 /**
  * irn handler for common be nodes.
  */
 extern const arch_irn_handler_t be_node_irn_handler;
 
-#endif /* _BENODE_T_H */
+#endif /* FIRM_BE_BENODE_T_H */