+/*
+ * 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.
+ */
+
+/**
+ * @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 "firm_types.h"
+#include "irnode_t.h"
+#include "bearch.h"
+
+#define BE_OUT_POS(p) (-((p) + 1))
+
+/**
+ * The benode op's. Must be available to register emitter function.
+ */
+extern ir_op *op_be_Spill;
+extern ir_op *op_be_Reload;
+extern ir_op *op_be_Perm;
+extern ir_op *op_be_MemPerm;
+extern ir_op *op_be_Copy;
+extern ir_op *op_be_Keep;
+extern ir_op *op_be_CopyKeep;
+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_RegParams;
+extern ir_op *op_be_FrameAddr;
+extern ir_op *op_be_Barrier;
+extern ir_op *op_be_Unwind;
+
+/** Not used yet. */
+typedef enum {
+ be_frame_flag_spill = 1,
+ be_frame_flag_local = 2,
+ be_frame_flag_arg = 4
+} be_frame_flag_t;
+
+/**
+ * A "symbolic constant" for the size of the stack frame to use with IncSP nodes.
+ * It gets back-patched to the real size as soon it is known.
+ */
+#define BE_STACK_FRAME_SIZE_EXPAND INT_MAX
+#define BE_STACK_FRAME_SIZE_SHRINK INT_MIN
+
+/**
+ * Determines if irn is a be_node.
+ */
+int is_be_node(const ir_node *irn);
+
+/**
+ * Create all BE specific opcodes.
+ */
+void be_node_init(void);
+
+/**
+ * Position numbers for the be_Spill inputs.
+ */
+enum {
+ be_pos_Spill_frame = 0,
+ be_pos_Spill_val = 1
+};
+
+/**
+ * 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 *to_spill);
+
+/**
+ * Position numbers for the be_Reload inputs.
+ */
+enum {
+ be_pos_Reload_frame = 0,
+ be_pos_Reload_mem = 1
+};
+
+/**
+ * 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 *mem, ir_mode *mode);
+
+/**
+ * Position numbers for the be_Copy inputs.
+ */
+enum {
+ be_pos_Copy_op = 0
+};
+
+/**
+ * Make a new Copy node.
+ */
+ir_node *be_new_Copy(const arch_register_class_t *cls, ir_graph *irg, ir_node *block, ir_node *in);
+/** Returns the Copy Argument. */
+ir_node *be_get_Copy_op(const ir_node *cpy);
+/** Sets the Copy Argument. */
+void be_set_Copy_op(ir_node *cpy, ir_node *op);
+
+/**
+ * Make a new Perm node.
+ */
+ir_node *be_new_Perm(const arch_register_class_t *cls, ir_graph *irg, ir_node *bl, int arity, ir_node *in[]);
+
+/**
+ * Reduce a Perm.
+ * Basically, we provide a map to remap the Perm's arguments. If an entry in the
+ * map is -1, the argument gets deleted.
+ * This function takes care, that the register data and the input array reflects
+ * the changes described by the map.
+ * This is needed by the Perm optimization/movement in belower.c, see push_through_perm().
+ * @param perm The perm node.
+ * @param new_size The new number of arguments (must be smaller or equal to the current one).
+ * @param map A map assigning each operand a new index (or -1 to indicate deletion).
+ */
+void be_Perm_reduce(ir_node *perm, int new_size, int *map);
+
+/**
+ * Create a new MemPerm node.
+ */
+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_FrameAddr inputs
+ */
+enum {
+ be_pos_FrameAddr_ptr = 0
+};
+
+/** Create a new FrameAddr node. */
+ir_node *be_new_FrameAddr(const arch_register_class_t *cls_frame, ir_graph *irg, ir_node *bl, ir_node *frame, ir_entity *ent);
+
+/** Return the frame input of a FrameAddr node. */
+ir_node *be_get_FrameAddr_frame(const ir_node *node);
+
+ir_entity *be_get_FrameAddr_entity(const ir_node *node);
+
+/**
+ * Position numbers for the be_AddSP inputs
+ */
+enum {
+ be_pos_AddSP_old_sp = 0,
+ be_pos_AddSP_size = 1,
+ be_pos_AddSP_last = 2
+};
+
+enum {
+ pn_be_AddSP_sp = 0,
+ pn_be_AddSP_res = 1,
+ pn_be_AddSP_M = 2,
+ pn_be_AddSP_last = 3
+};
+
+/**
+ * Make a new AddSP node.
+ * An AddSP node expresses an increase 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 AddSP node.
+ */
+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_sp = 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);
+
+/**
+ * Make a stack pointer increase/decrease node.
+ * @param sp The stack pointer register.
+ * @param irg The graph to insert the node to.
+ * @param bl The block to insert the node into.
+ * @param old_sp The node defining the former stack pointer.
+ * @param amount The mount of bytes the stack shall be expanded/shrinked (see set_IncSP_offset)
+ * @param dir The direction in which the stack pointer shall be modified:
+ * Along the stack's growing direction or against.
+ * @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, int offset, int align);
+
+/** Returns the previous node that computes the stack pointer. */
+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);
+
+/**
+ * Sets a new offset to a IncSP node.
+ * A positive offset means expanding the stack, a negative offset shrinking
+ * an offset is == BE_STACK_FRAME_SIZE will be replaced by the real size of the
+ * stackframe in the fix_stack_offsets phase.
+ */
+void be_set_IncSP_offset(ir_node *irn, int offset);
+
+/** Gets the offset from a IncSP node. */
+int be_get_IncSP_offset(const ir_node *irn);
+int be_get_IncSP_align(const ir_node *irn);
+
+/** Gets the call entity or NULL if this is no static call. */
+ir_entity *be_Call_get_entity(const ir_node *call);
+/** Sets the call entity. */
+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. */
+void be_Call_set_type(ir_node *call, ir_type *call_tp);
+
+void be_Call_set_pop(ir_node *call, unsigned pop);
+
+unsigned be_Call_get_pop(const ir_node *call);
+
+/**
+ * Position numbers for the be_Call inputs.
+ */
+enum {
+ be_pos_Call_mem = 0, /**< memory input of a be_Call node */
+ be_pos_Call_sp = 1, /**< stack pointer input of a be_Call node */
+ be_pos_Call_ptr = 2, /**< call pointer input of a be_Call node */
+ be_pos_Call_first_arg = 3 /**< first argument input of a be_Call node */
+};
+
+/**
+ * Projection numbers for result of be_Call node: use for Proj nodes!
+ */
+typedef enum {
+ pn_be_Call_M_regular = pn_Call_M_regular, /**< The memory result of a be_Call. */
+ pn_be_Call_sp = pn_Call_max,
+ pn_be_Call_first_res /**< The first result proj number of a be_Call. */
+} pn_be_Call;
+