Merge ia32_am_type_t and ia32_am_arity_t, because (type == ia32_am_None) == (arity...
[libfirm] / ir / be / ia32 / ia32_new_nodes.h
index 7de92b3..0055775 100644 (file)
-#ifndef _IA32_NEW_NODES_H_
-#define _IA32_NEW_NODES_H_
+/*
+ * 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.
+ */
 
 /**
- * Function prototypes for the assembler ir node constructors.
- * @author Christian Wuerdig
- * $Id$
+ * @file
+ * @brief       Handling of ia32 specific firm opcodes.
+ * @author      Christian Wuerdig
+ * @version     $Id$
+ *
+ * This file implements the creation of the achitecture specific firm opcodes
+ * and the coresponding node constructors for the ia32 assembler irg.
  */
+#ifndef FIRM_BE_IA32_IA32_NEW_NODES_H
+#define FIRM_BE_IA32_IA32_NEW_NODES_H
 
+#include "firm_config.h"
 #include "ia32_nodes_attr.h"
 
-asmop_attr *get_ia32_attr(const ir_node *node);
+/** indices for AM inputs */
+enum {
+       n_ia32_base         = 0,
+       n_ia32_index        = 1,
+       n_ia32_mem          = 2,
+       n_ia32_unary_op     = 3,
+       n_ia32_binary_left  = 3,
+       n_ia32_binary_right = 4
+};
 
-ir_node *get_ia32_old_ir(const ir_node *node);
+/** proj numbers for "normal" one-result nodes (for the complicated cases where we not only
+ * need the result) */
+enum {
+       pn_ia32_res   = 0,
+       pn_ia32_flags = 1,
+       pn_ia32_mem   = 2,
+       pn_ia32_add1  = 3,
+       pn_ia32_add2  = 4
+};
 
-const char *get_sc_name(ir_node *symc);
+/***************************************************************************************************
+ *        _   _                   _       __        _                    _   _               _
+ *       | | | |                 | |     / /       | |                  | | | |             | |
+ *   __ _| |_| |_ _ __   ___  ___| |_   / /_ _  ___| |_   _ __ ___   ___| |_| |__   ___   __| |___
+ *  / _` | __| __| '__| / __|/ _ \ __| / / _` |/ _ \ __| | '_ ` _ \ / _ \ __| '_ \ / _ \ / _` / __|
+ * | (_| | |_| |_| |    \__ \  __/ |_ / / (_| |  __/ |_  | | | | | |  __/ |_| | | | (_) | (_| \__ \
+ *  \__,_|\__|\__|_|    |___/\___|\__/_/ \__, |\___|\__| |_| |_| |_|\___|\__|_| |_|\___/ \__,_|___/
+ *                                        __/ |
+ *                                       |___/
+ ***************************************************************************************************/
 
-void    set_ia32_Immop_attr(ir_node *node, ir_node *imm);
-tarval *get_ia32_Immop_tarval(const ir_node *node);
-void    set_ia32_Immop_tarval(ir_node *node, tarval *tv);
+/**
+ * returns true if a node has x87 registers
+ */
+int ia32_has_x87_register(const ir_node *n);
 
-void set_ia32_Const_attr(ir_node *ia32_cnst, ir_node *cnst);
-void set_ia32_Const_type(ir_node *node, int type);
+/**
+ * Returns the attributes of an ia32 node.
+ */
+ia32_attr_t *get_ia32_attr(ir_node *node);
+const ia32_attr_t *get_ia32_attr_const(const ir_node *node);
+
+ia32_x87_attr_t *get_ia32_x87_attr(ir_node *node);
+const ia32_x87_attr_t *get_ia32_x87_attr_const(const ir_node *node);
+
+ia32_immediate_attr_t *get_ia32_immediate_attr(ir_node *node);
+const ia32_immediate_attr_t *get_ia32_immediate_attr_const(const ir_node *node);
+
+/**
+ * Gets the condcode attributes of a node.
+ */
+ia32_condcode_attr_t *get_ia32_condcode_attr(ir_node *node);
+const ia32_condcode_attr_t *get_ia32_condcode_attr_const(const ir_node *node);
+
+/**
+ * Gets the CopyB node attributes.
+ */
+ia32_copyb_attr_t *get_ia32_copyb_attr(ir_node *node);
+const ia32_copyb_attr_t *get_ia32_copyb_attr_const(const ir_node *node);
+
+/**
+ * Gets the type of an ia32 node.
+ */
+ia32_op_type_t get_ia32_op_type(const ir_node *node);
+
+/**
+ * Sets the type of an ia32 node.
+ */
+void set_ia32_op_type(ir_node *node, ia32_op_type_t tp);
+
+/**
+ * Gets the supported address mode of an ia32 node
+ */
+ia32_am_type_t get_ia32_am_support(const ir_node *node);
+
+/**
+ * Sets the supported addrmode of an ia32 node
+ */
+void set_ia32_am_support(ir_node *node, ia32_am_type_t am_arity);
+
+/**
+ * Gets the addressmode offset as long.
+ */
+int get_ia32_am_offs_int(const ir_node *node);
+
+/**
+ * Sets the addressmode offset
+ */
+void set_ia32_am_offs_int(ir_node *node, int offset);
+
+void add_ia32_am_offs_int(ir_node *node, int offset);
+
+/**
+ * Returns the symconst entity associated to addrmode.
+ */
+ir_entity *get_ia32_am_sc(const ir_node *node);
+
+/**
+ * Sets the symconst entity associated to addrmode.
+ */
+void set_ia32_am_sc(ir_node *node, ir_entity *sc);
+
+/**
+ * Sets the sign bit for address mode symconst.
+ */
+void set_ia32_am_sc_sign(ir_node *node);
+
+/**
+ * Clears the sign bit for address mode symconst.
+ */
+void clear_ia32_am_sc_sign(ir_node *node);
+
+/**
+ * Returns the sign bit for address mode symconst.
+ */
+int is_ia32_am_sc_sign(const ir_node *node);
+
+/**
+ * Gets the addr mode const.
+ */
+int get_ia32_am_scale(const ir_node *node);
+
+/**
+ * Sets the const for addr mode.
+ */
+void set_ia32_am_scale(ir_node *node, int scale);
+
+/**
+ * Sets the uses_frame flag.
+ */
+void set_ia32_use_frame(ir_node *node);
+
+/**
+ * Clears the uses_frame flag.
+ */
+void clear_ia32_use_frame(ir_node *node);
+
+/**
+ * Gets the uses_frame flag.
+ */
+int is_ia32_use_frame(const ir_node *node);
+
+/**
+ * copies all address-mode attributes from one node to the other
+ */
+void ia32_copy_am_attrs(ir_node *to, const ir_node *from);
+
+/**
+ * Sets node to commutative.
+ */
+void set_ia32_commutative(ir_node *node);
+
+/**
+ * Sets node to non-commutative.
+ */
+void clear_ia32_commutative(ir_node *node);
+
+/**
+ * Checks if node is commutative.
+ */
+int is_ia32_commutative(const ir_node *node);
+
+/**
+ * Sets node needs_stackent
+ */
+void set_ia32_need_stackent(ir_node *node);
+
+/**
+ * Clears node needs_stackent
+ */
+void clear_ia32_need_stackent(ir_node *node);
+
+/**
+ * Checks if node needs a stack entity assigned
+ */
+int is_ia32_need_stackent(const ir_node *node);
+
+void set_ia32_is_reload(ir_node *node);
+int is_ia32_is_reload(const ir_node *node);
+
+void set_ia32_is_spill(ir_node *node);
+int is_ia32_is_spill(const ir_node *node);
+
+void set_ia32_is_remat(ir_node *node);
+int is_ia32_is_remat(const ir_node *node);
+
+/**
+ * Gets the mode of the stored/loaded value (only set for Store/Load)
+ */
+ir_mode *get_ia32_ls_mode(const ir_node *node);
+
+/**
+ * Sets the mode of the stored/loaded value (only set for Store/Load)
+ */
+void set_ia32_ls_mode(ir_node *node, ir_mode *mode);
+
+/**
+ * Gets the frame entity assigned to this node;
+ */
+ir_entity *get_ia32_frame_ent(const ir_node *node);
+
+/**
+ * Sets the frame entity for this node;
+ */
+void set_ia32_frame_ent(ir_node *node, ir_entity *ent);
+
+/**
+ * Returns the argument register requirements of an ia32 node.
+ */
+const arch_register_req_t **get_ia32_in_req_all(const ir_node *node);
+
+/**
+ * Sets the argument register requirements of an ia32 node.
+ */
+void set_ia32_in_req_all(ir_node *node, const arch_register_req_t **reqs);
 
-void set_ia32_AddrMode(ir_node *node);
-int   is_ia32_AddrMode(ir_node *node);
+/**
+ * Returns the result register requirements of an ia32 node.
+ */
+const arch_register_req_t **get_ia32_out_req_all(const ir_node *node);
 
-void set_ia32_pncode(ir_node *node, long code);
-long get_ia32_pncode(const ir_node *node);
+/**
+ * Sets the result register requirements of an ia32 node.
+ */
+void set_ia32_out_req_all(ir_node *node, const arch_register_req_t **reqs);
 
-void    set_ia32_offs(ir_node *node, tarval *offs);
-tarval *get_ia32_offs(const ir_node *node);
-void    set_ia32_n_res(ir_node *node, int n_res);
-int     get_ia32_n_res(const ir_node *node);
+/**
+ * Returns the argument register requirements of an ia32 node.
+ */
+const arch_register_req_t *get_ia32_in_req(const ir_node *node, int pos);
 
-void set_ia32_DivMod_flavour(ir_node *node, divmod_flavour_t dm_flav);
+/**
+ * Returns the result register requirements of an ia32 node.
+ */
+const arch_register_req_t *get_ia32_out_req(const ir_node *node, int pos);
 
-arch_irn_flags_t            get_ia32_flags(const ir_node *node);
-const arch_register_req_t **get_ia32_in_req(const ir_node *node);
-const arch_register_req_t **get_ia32_out_req(const ir_node *node);
-const arch_register_t     **get_ia32_slots(const ir_node *node);
+/**
+ * Sets the OUT register requirements at position pos.
+ */
+void set_ia32_req_out(ir_node *node, const arch_register_req_t *req, int pos);
 
-void set_ia32_regreq_out(ir_node *node, const arch_register_req_t *req, int pos);
-void set_ia32_regreq_in(ir_node *node, const arch_register_req_t *req, int pos);
+/**
+ * Sets the IN register requirements at position pos.
+ */
+void set_ia32_req_in(ir_node *node, const arch_register_req_t *req, int pos);
 
-const char            *get_ia32_out_reg_name(const ir_node *node, int pos);
-int                    get_ia32_out_regnr(const ir_node *node, int pos);
+/**
+ * Returns the register flag of an ia32 node.
+ */
+arch_irn_flags_t get_ia32_flags(const ir_node *node);
+
+/**
+ * Sets the register flag of an ia32 node.
+ */
+void set_ia32_flags(ir_node *node, arch_irn_flags_t flags);
+
+void add_ia32_flags(ir_node *node, arch_irn_flags_t flags);
+
+/**
+ * Returns the result register slots of an ia32 node.
+ */
+const arch_register_t **get_ia32_slots(const ir_node *node);
+
+/**
+ * Returns the name of the OUT register at position pos.
+ */
+const char *get_ia32_out_reg_name(const ir_node *node, int pos);
+
+/**
+ * Returns the index of the OUT register at position pos within its register class.
+ */
+int get_ia32_out_regnr(const ir_node *node, int pos);
+
+/**
+ * Returns the OUT register at position pos.
+ */
 const arch_register_t *get_ia32_out_reg(const ir_node *node, int pos);
 
-int is_ia32_irn(const ir_node *node);
+/**
+ * Returns the number of results.
+ */
+int get_ia32_n_res(const ir_node *node);
+
+/**
+ * Returns the condition code of a node.
+ */
+long get_ia32_condcode(const ir_node *node);
+
+/**
+ * Sets the condition code of a node
+ */
+void set_ia32_condcode(ir_node *node, long code);
+
+/**
+ * Returns the condition code of a node.
+ */
+unsigned get_ia32_copyb_size(const ir_node *node);
+
+/**
+ * Gets the instruction latency.
+ */
+unsigned get_ia32_latency(const ir_node *node);
+
+
+/**
+ * Sets the flags for the n'th out.
+ */
+void set_ia32_out_flags(ir_node *node, arch_irn_flags_t flags, int pos);
+
+/**
+ * Gets the flags for the n'th out.
+ */
+arch_irn_flags_t get_ia32_out_flags(const ir_node *node, int pos);
+
+/**
+ * Get the list of available execution units.
+ */
+const be_execution_unit_t ***get_ia32_exec_units(const ir_node *node);
+
+/**
+ * Get the exception label attribute.
+ */
+unsigned get_ia32_exc_label(const ir_node *node);
+
+/**
+ * Set the exception label attribute.
+ */
+void set_ia32_exc_label(ir_node *node, unsigned flag);
+
+/**
+ * Return the exception label id.
+ */
+ir_label_t get_ia32_exc_label_id(const ir_node *node);
+
+/**
+ * Assign the exception label id.
+ */
+void set_ia32_exc_label_id(ir_node *node, ir_label_t id);
+
+#ifndef NDEBUG
+
+/**
+ * Returns the name of the original ir node.
+ */
+const char *get_ia32_orig_node(const ir_node *node);
+
+/**
+ * Sets the name of the original ir node.
+ */
+void set_ia32_orig_node(ir_node *node, const char *name);
+
+#endif /* NDEBUG */
+
+/******************************************************************************************************
+ *                      _       _         _   _           __                  _   _
+ *                     (_)     | |       | | | |         / _|                | | (_)
+ *  ___ _ __   ___  ___ _  __ _| |   __ _| |_| |_ _ __  | |_ _   _ _ __   ___| |_ _  ___  _ __    ___
+ * / __| '_ \ / _ \/ __| |/ _` | |  / _` | __| __| '__| |  _| | | | '_ \ / __| __| |/ _ \| '_ \  / __|
+ * \__ \ |_) |  __/ (__| | (_| | | | (_| | |_| |_| |    | | | |_| | | | | (__| |_| | (_) | | | | \__ \
+ * |___/ .__/ \___|\___|_|\__,_|_|  \__,_|\__|\__|_|    |_|  \__,_|_| |_|\___|\__|_|\___/|_| |_| |___/
+ *     | |
+ *     |_|
+ ******************************************************************************************************/
+
+/**
+ * Returns the ident of an entity
+ * @param ent The entity
+ * @return The ident of the entity
+ */
+ident *ia32_get_ent_ident(ir_entity *ent);
+
+/**
+ * Returns the proj of the result value for nodes that have the usual
+ * (res, Mem) result tuple
+ */
+ir_node *get_ia32_result_proj(const ir_node *node);
+
+/**
+ * Copy the attributes from a Const to an ia32_Const
+ */
+void set_ia32_Const_attr(ir_node *ia32_cnst, ir_node *cnst);
+
+void set_ia32_Const_tarval(ir_node *node, tarval *tv);
+
+/**
+ * Returns whether or not the node is an AddrModeS node.
+ */
+int is_ia32_AddrModeS(const ir_node *node);
+
+/**
+ * Returns whether or not the node is an AddrModeD node.
+ */
+int is_ia32_AddrModeD(const ir_node *node);
+
+/**
+ * Checks if node is a Load or fLoad.
+ */
+int is_ia32_Ld(const ir_node *node);
+
+/**
+ * Checks if node is a Store or fStore.
+ */
+int is_ia32_St(const ir_node *node);
+
+/**
+ * Swaps left/right input of a node (and adjusts pnc if needed)
+ */
+void ia32_swap_left_right(ir_node *node);
+
+/**
+ * Initializes the nodes attributes.
+ */
+void init_ia32_attributes(ir_node *node, arch_irn_flags_t flags,
+                          const arch_register_req_t **in_reqs,
+                          const arch_register_req_t **out_reqs,
+                          const be_execution_unit_t ***execution_units,
+                          int n_res);
+
+void init_ia32_x87_attributes(ir_node *node);
+void init_ia32_asm_attributes(ir_node *node);
+void init_ia32_immediate_attributes(ir_node *node, ir_entity *symconst,
+                                    int symconst_sign, long offset);
+void init_ia32_copyb_attributes(ir_node *res, unsigned size);
+void init_ia32_condcode_attributes(ir_node *res, long pnc);
 
 /* Include the generated headers */
 #include "gen_ia32_new_nodes.h"
 
-#endif /* _IA32_NEW_NODES_H_ */
+#endif /* FIRM_BE_IA32_IA32_NEW_NODES_H */