moved get_inverse_op to bearch
[libfirm] / ir / be / bearch.h
index d76a2ea..68db5a2 100644 (file)
@@ -1,54 +1,32 @@
 #ifndef _FIRM_BEARCH_H
 #define _FIRM_BEARCH_H
 
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-
+#include "firm_config.h"
 
 #ifdef WITH_LIBCORE
 #include <libcore/lc_opts.h>
 #endif
 
-#include "type.h"
-
-#include "irnode.h"
-#include "irmode.h"
+#include "firm_types.h"
 
 #include "bitset.h"
-#include "hashptr.h"
-#include "fourcc.h"
-#include "set.h"
-#include "list.h"
-#include "ident.h"
 
 #include "belistsched.h"
 #include "beabi_t.h"
-
-typedef struct _arch_register_class_t     arch_register_class_t;
-typedef struct _arch_register_t           arch_register_t;
-typedef struct _arch_isa_if_t             arch_isa_if_t;
-typedef struct _arch_isa_t                arch_isa_t;
-typedef struct _arch_env_t                arch_env_t;
-typedef struct _arch_irn_ops_if_t         arch_irn_ops_if_t;
-typedef struct _arch_irn_ops_t            arch_irn_ops_t;
-typedef struct _arch_irn_handler_t        arch_irn_handler_t;
-typedef struct _arch_code_generator_t     arch_code_generator_t;
-typedef struct _arch_code_generator_if_t  arch_code_generator_if_t;
+#include "bearch_t.h"
+#include "be_t.h"
 
 struct _be_node_factory_t;
 
 typedef enum _arch_register_type_t {
-  arch_register_type_none = 0,
+  arch_register_type_none         = 0,
   arch_register_type_caller_save  = 1, /**< The register must be saved by the caller
                                             upon a function call. It thus can be overwritten
                                             in the called function. */
   arch_register_type_callee_save  = 2, /**< The register must be saved by the caller
                                             upon a function call. It thus can be overwritten
                                             in the called function. */
-  arch_register_type_ignore = 4,       /**< Do not consider this register when allocating. */
-  arch_register_type_sp = 8,           /**< This register is the stack pointer of the architecture. */
-  arch_register_type_bp = 16,          /**< The register is the base pointer of the architecture. */
+  arch_register_type_ignore       = 4, /**< Do not consider this register when allocating. */
 } arch_register_type_t;
 
 /**
@@ -58,7 +36,7 @@ typedef enum _arch_register_type_t {
  * @return      1, If register is of given kind, 0 if not.
  */
 #define arch_register_type_is(reg, kind) \
-       ((reg)->type == arch_register_type_ ## kind)
+  (((reg)->type & arch_register_type_ ## kind) != 0)
 
 /**
  * A register.
@@ -97,8 +75,12 @@ struct _arch_register_class_t {
   const arch_register_t *regs;    /**< The array of registers. */
 };
 
+/** return the number of registers in this register class */
 #define arch_register_class_n_regs(cls) ((cls)->n_regs)
 
+/** return the largest mode of this register class */
+#define arch_register_class_mode(cls) ((cls)->mode)
+
 /**
  * Put all registers in a class into a bitset.
  * @param cls The class.
@@ -144,6 +126,8 @@ typedef enum _arch_register_req_type_t {
   arch_register_req_type_should_be_different = 8,  /**< The register must be unequal
                                                         to some other at the node. */
 
+  arch_register_req_type_should_be_different_from_all = 16, /**< The register must be different from
+                                                        all in's at the node */
 } arch_register_req_type_t;
 
 /**
@@ -179,6 +163,16 @@ typedef struct _arch_register_req_t {
                                                                                    must be different (case must_be_different). */
 } arch_register_req_t;
 
+/**
+ * Format a register requirements information into a string.
+ * @param buf The string where to put it to.
+ * @param len The size of @p buf.
+ * @param req The requirements structure to format.
+ * @return    A pointer to buf.
+ */
+extern char *arch_register_req_format(char *buf, size_t len, const arch_register_req_t *req);
+
+
 /**
  * Certain node classes which are relevant for the register allocator.
  */
@@ -189,9 +183,23 @@ typedef enum _arch_irn_class_t {
   arch_irn_class_copy,
   arch_irn_class_perm,
   arch_irn_class_branch,
-  arch_irn_class_call
+  arch_irn_class_call,
+  arch_irn_class_const,
 } arch_irn_class_t;
 
+/**
+ * An inverse operation returned by the backend
+ */
+typedef struct _arch_inverse_t {
+  int        n; /**< count of nodes returned in nodes array */
+  int        costs; /**< costs of this remat */
+
+  /**> nodes for this inverse operation. shall be in
+   *  schedule order. last element is the target value
+   */
+  ir_node  **nodes;
+} arch_inverse_t;
+
 /**
  * Some flags describing a node in more detail.
  */
@@ -199,9 +207,19 @@ typedef enum _arch_irn_flags_t {
        arch_irn_flags_none             = 0, /**< Node flags. */
        arch_irn_flags_dont_spill       = 1, /**< This must not be spilled. */
        arch_irn_flags_rematerializable = 2, /**< This should be replicated instead of spilled/reloaded. */
-       arch_irn_flags_ignore           = 4, /**< Do not consider the node during register allocation. */
+       arch_irn_flags_ignore           = 4, /**< Ignore node during register allocation. */
+       arch_irn_flags_modify_sp        = 8, /**< I modify the stack pointer. */
+       arch_irn_flags_last             = arch_irn_flags_modify_sp
 } arch_irn_flags_t;
 
+/**
+ * Get the string representation of a flag.
+ * This functions does not handle or'ed bitmasks of flags.
+ * @param flag The flag.
+ * @return The flag as a string.
+ */
+extern const char *arch_irn_flag_str(arch_irn_flags_t flag);
+
 struct _arch_irn_ops_if_t {
 
   /**
@@ -251,6 +269,34 @@ struct _arch_irn_ops_if_t {
    */
   arch_irn_flags_t (*get_flags)(const void *self, const ir_node *irn);
 
+  /**
+   * Get the entity on the stack frame this node depends on.
+   * @param self The this pointer.
+   * @param irn  The node in question.
+   * @return The entity on the stack frame or NULL, if the node does not has a stack frame entity.
+   */
+  entity *(*get_frame_entity)(const void *self, const ir_node *irn);
+
+  /**
+   * Set the offset of a node carrying an entity on the stack frame.
+   * @param self The this pointer.
+   * @param irn  The node.
+   * @param offset The offset of the node's stack frame entity.
+   */
+  void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
+
+  /**
+   * Returns an inverse operation which yields the i-th argument
+   * of the given node as result.
+   *
+   * @param irn       The original operation
+   * @param i         Index of the argument we want the inverse oparation to yield
+   * @param inverse   struct to be filled with the resulting inverse op
+   * @param obstack   The obstack to use for allocation of the returned nodes array
+   * @return          The inverse operation or NULL if operation invertible
+   */
+  arch_inverse_t *(*get_inverse)(const void *self, const ir_node * irn, int i, arch_inverse_t * inverse, struct obstack * obstack);
+
 };
 
 /**
@@ -260,6 +306,12 @@ struct _arch_irn_ops_t {
        const arch_irn_ops_if_t *impl;
 };
 
+extern void arch_set_frame_offset(const arch_env_t *env, ir_node *irn, int bias);
+
+extern entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn);
+
+extern arch_inverse_t *arch_get_inverse(const arch_env_t *env, const ir_node * irn, int i, arch_inverse_t * inverse, struct obstack * obstack);
+
 /**
  * Get the register requirements for a node.
  * @param env The architecture environment.
@@ -324,7 +376,7 @@ extern int arch_reg_is_allocatable(const arch_env_t *env,
  * Get the register class of an operand of a node.
  * @param env The architecture environment.
  * @param irn The node.
- * @param pos The position of the operand.
+ * @param pos The position of the operand, -1 for the output.
  * @return    The register class of the operand or NULL, if
  *            operand is a non-register operand.
  */
@@ -366,16 +418,16 @@ extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *
  */
 extern arch_irn_flags_t arch_irn_get_flags(const arch_env_t *env, const ir_node *irn);
 
-#define arch_irn_is_ignore(env, irn) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ignore) != 0)
+#define arch_irn_is(env, irn, flag) ((arch_irn_get_flags(env, irn) & arch_irn_flags_ ## flag) != 0)
 
 #define arch_irn_has_reg_class(env, irn, pos, cls) \
   ((cls) == arch_get_irn_reg_class(env, irn, pos))
 
 #define arch_irn_consider_in_reg_alloc(env, cls, irn) \
-       (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is_ignore(env, irn))
+       (arch_irn_has_reg_class(env, irn, -1, cls) && !arch_irn_is(env, irn, ignore))
 
 /**
- * Somebody who can be asked about nodes.
+ * Somebody who can be asked about IR nodes.
  */
 struct _arch_irn_handler_t {
 
@@ -387,23 +439,23 @@ struct _arch_irn_handler_t {
     */
   const void *(*get_irn_ops)(const arch_irn_handler_t *handler,
       const ir_node *irn);
-
 };
 
 /**
- * The code generator.
+ * The code generator interface.
  */
 struct _arch_code_generator_if_t {
-
-
        /**
         * Initialize the code generator.
-        * @param file The file to dump to.
-        * @param irg  The function to generate code for.
-        * @param env  The architecture environment.
+        * @param birg A backend IRG session.
         * @return     A newly created code generator.
         */
-       void *(*init)(FILE *file, ir_graph *irg, const arch_env_t *env);
+       void *(*init)(const be_irg_t *birg);
+
+       /**
+        * Called before abi introduce.
+        */
+       void (*before_abi)(void *self);
 
        /**
         * Called, when the graph is being normalized.
@@ -421,46 +473,32 @@ struct _arch_code_generator_if_t {
        void (*before_ra)(void *self);
 
        /**
-        * Called after register allocation to lower Spills to Stores
-        * @param self  The code generator
-        * @param spill The spill node to lower
-        * @return      The new backend node which substitutes the spill
-        */
-       ir_node *(*lower_spill)(void *self, ir_node *spill);
-
-       /**
-        * Called after register allocation to lower Reloads to Loads
-        * @param self   The code generator
-        * @param reload The reload node to lower
-        * @return       The new backend node which substitutes the reload
-        */
-       ir_node *(*lower_reload)(void *self, ir_node *reload);
-
-       /**
-        * Called in lowering (e.g. alloca lowering) to set the
-        * correct stack register.
-        * @param self The code generator
-        * @return     The stack register for the current irg
+        * Called after register allocation.
         */
-       const arch_register_t *(*get_stack_register)(void *self);
+       void (*after_ra)(void *self);
 
        /**
         * Called after everything happened.
         * The code generator must also be de-allocated here.
         */
        void (*done)(void *self);
-
 };
 
+/**
+ * helper macro: call function func from the code generator
+ * if it's implemented.
+ */
 #define _arch_cg_call(cg, func) \
 do { \
        if((cg)->impl->func) \
                (cg)->impl->func(cg); \
 } while(0)
 
+#define arch_code_generator_before_abi(cg)      _arch_cg_call(cg, before_abi)
 #define arch_code_generator_prepare_graph(cg)   _arch_cg_call(cg, prepare_graph)
 #define arch_code_generator_before_sched(cg)    _arch_cg_call(cg, before_sched)
 #define arch_code_generator_before_ra(cg)       _arch_cg_call(cg, before_ra)
+#define arch_code_generator_after_ra(cg)        _arch_cg_call(cg, after_ra)
 #define arch_code_generator_done(cg)            _arch_cg_call(cg, done)
 
 /**
@@ -489,14 +527,12 @@ struct _arch_isa_t {
  */
 struct _arch_isa_if_t {
 
-#ifdef WITH_LIBCORE
-  void (*register_options)(lc_opt_entry_t *grp);
-#endif
-
   /**
    * Initialize the isa interface.
+        * @param file_handle  the file handle to write the output to
+        * @return a new isa instance
    */
-  void *(*init)(void);
+  void *(*init)(FILE *file_handle);
 
   /**
    * Free the isa instance.
@@ -555,21 +591,29 @@ struct _arch_isa_if_t {
   const list_sched_selector_t *(*get_list_sched_selector)(const void *self);
 
   /**
-   * Take a proj from a call, set the correct register and projnum for this proj
-   * @param self    The isa object.
-   * @param proj    The proj
-   * @param is_keep Non-zero if proj is a Keep argument
-   * @return        The backend proj number assigned to this proj
+   * Get the necessary alignment for storing a register of given class.
+   * @param self  The isa object.
+   * @param cls   The register class.
+   * @return      The alignment in bytes.
    */
-  long (*handle_call_proj)(const void *self, ir_node *proj, int is_keep);
+  int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
+
+#ifdef WITH_LIBCORE
+       /**
+        * Register command line options for this backend.
+        * @param grp  The root group.
+        */
+  void (*register_options)(lc_opt_entry_t *grp);
+#endif
 };
 
-#define arch_isa_get_n_reg_class(isa)                       ((isa)->impl->get_n_reg_class(isa))
-#define arch_isa_get_reg_class(isa,i)                       ((isa)->impl->get_reg_class(isa, i))
-#define arch_isa_get_irn_handler(isa)                              ((isa)->impl->get_irn_handler(isa))
-#define arch_isa_get_call_abi(isa,tp,abi)                   ((isa)->impl->get_call_abi((isa), (tp), (abi)))
-#define arch_isa_get_reg_class_for_mode(isa,mode)           ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
-#define arch_isa_make_code_generator(isa,irg)               ((isa)->impl->make_code_generator(isa, irg))
+#define arch_isa_get_n_reg_class(isa)                ((isa)->impl->get_n_reg_class(isa))
+#define arch_isa_get_reg_class(isa,i)                ((isa)->impl->get_reg_class(isa, i))
+#define arch_isa_get_irn_handler(isa)                ((isa)->impl->get_irn_handler(isa))
+#define arch_isa_get_call_abi(isa,tp,abi)            ((isa)->impl->get_call_abi((isa), (tp), (abi)))
+#define arch_isa_get_reg_class_for_mode(isa,mode)    ((isa)->impl->get_reg_class_for_mode((isa), (mode)))
+#define arch_isa_make_code_generator(isa,irg)        ((isa)->impl->make_code_generator((isa), (irg)))
+#define arch_isa_get_reg_class_alignment(isa, cls)   ((isa)->impl->get_reg_class_alignment((isa), (cls)))
 
 #define ARCH_MAX_HANDLERS         8
 
@@ -597,10 +641,11 @@ struct _arch_env_t {
 
 /**
  * Initialize the architecture environment struct.
- * @param isa The isa which shall be put into the environment.
+ * @param isa           The isa which shall be put into the environment.
+ * @param file_handle   The file handle
  * @return The environment.
  */
-extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa);
+extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa, FILE *file_handle);
 
 /**
  * Add a node handler to the environment.
@@ -608,6 +653,13 @@ extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa);
  * @param handler A node handler.
  * @return The environment itself.
  */
-extern arch_env_t *arch_env_add_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
+extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_handler_t *handler);
+
+/**
+ * Remove a node handler from the handler stack.
+ * @param env The architecture environment.
+ * @return The popped handler.
+ */
+extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
 
 #endif /* _FIRM_BEARCH_H */