Initial commit of morgans spilling algorithm (spill unused values that live through
[libfirm] / ir / be / bearch.h
index bcad960..86005f4 100644 (file)
@@ -1,51 +1,43 @@
 #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 "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"
-
-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_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 "beabi_t.h"
+#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_write_invariant,
-  arch_register_type_caller_saved,    /**< 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_saved,    /**< The register must be saved by the called function,
-                                           it thus survives a function call. */
-  arch_register_type_ignore           /**< Do not consider this register when allocating. */
+  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_t;
 
+/**
+ * Convenience macro to check for register type.
+ * @param req   A pointer to register.
+ * @param kind  The kind of type to check for (see 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) != 0)
+
 /**
  * A register.
  */
@@ -79,11 +71,16 @@ static INLINE int _arch_register_get_index(const arch_register_t *reg)
 struct _arch_register_class_t {
   const char *name;               /**< The name of the register class. */
   int n_regs;                     /**< Number of registers in this class. */
+  ir_mode *mode;                  /**< The mode of the register class. */
   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.
@@ -102,13 +99,6 @@ _arch_register_for_index(const arch_register_class_t *cls, int idx)
 #define arch_register_for_index(cls, idx) \
   _arch_register_for_index(cls, idx)
 
-/**
- * Get the register set for a register class.
- * @param cls The register class.
- * @return The set containing all registers in the class.
- */
-#define arch_get_register_set_for_class(cls) ((cls)->set)
-
 typedef enum _arch_operand_type_t {
   arch_operand_type_invalid,
   arch_operand_type_memory,
@@ -136,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;
 
 /**
@@ -154,7 +146,7 @@ typedef struct _arch_register_req_t {
        arch_register_req_type_t type;          /**< The type of the constraint. */
        const arch_register_class_t *cls;       /**< The register class this constraint belongs to. */
 
-       int (*limited)(const ir_node *irn, int pos, bitset_t *bs);
+       void (*limited)(void *limited_env, bitset_t *bs);
                                           /**< In case of the 'limited'
                                             constraint, this function
                                             must put all allowable
@@ -162,12 +154,25 @@ typedef struct _arch_register_req_t {
                                             return the number of registers
                                             in the bitset. */
 
-       ir_node *other;                                           /**< In case of "should be equal"
-                                                                                   or should be different, this gives
-                                                                                       the node to whose register this
-                                                                                       one's should be the same/different. */
+       void *limited_env;                    /**< This must passed to limited. */
+
+       ir_node *other_same;                      /**< The other which shall have the same reg
+                                                                                   as this one. (for case should_be_same). */
+
+       ir_node *other_different;             /**< The other node from which this one's register
+                                                                                   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.
  */
@@ -177,18 +182,48 @@ typedef enum _arch_irn_class_t {
   arch_irn_class_reload,
   arch_irn_class_copy,
   arch_irn_class_perm,
-  arch_irn_class_branch
+  arch_irn_class_branch,
+  arch_irn_class_call,
+  arch_irn_class_const,
+  arch_irn_class_load,
+  arch_irn_class_store,
+  arch_irn_class_stackparam,
 } 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.
  */
 typedef enum _arch_irn_flags_t {
-  arch_irn_flags_spillable = 1,
-  arch_irn_flags_rematerializable = 2
+       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, /**< 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;
 
-struct _arch_irn_ops_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 {
 
   /**
    * Get the register requirements for a given operand.
@@ -200,7 +235,7 @@ struct _arch_irn_ops_t {
    * @return    The register requirements for the selected operand.
    *            The pointer returned is never NULL.
    */
-  const arch_register_req_t *(*get_irn_reg_req)(const arch_irn_ops_t *self,
+  const arch_register_req_t *(*get_irn_reg_req)(const void *self,
       arch_register_req_t *req, const ir_node *irn, int pos);
 
   /**
@@ -210,7 +245,7 @@ struct _arch_irn_ops_t {
    * @note      If the operand is not a register operand,
    *            the call is ignored.
    */
-  void (*set_irn_reg)(const arch_irn_ops_t *self, ir_node *irn, const arch_register_t *reg);
+  void (*set_irn_reg)(const void *self, ir_node *irn, const arch_register_t *reg);
 
   /**
    * Get the register allocated for an output operand.
@@ -220,14 +255,14 @@ struct _arch_irn_ops_t {
    *            @c arch_register_invalid, if no register has yet been
    *            allocated for this node.
    */
-  const arch_register_t *(*get_irn_reg)(const arch_irn_ops_t *self, const ir_node *irn);
+  const arch_register_t *(*get_irn_reg)(const void *self, const ir_node *irn);
 
   /**
    * Classify the node.
    * @param irn The node.
    * @return A classification.
    */
-  arch_irn_class_t (*classify)(const arch_irn_ops_t *self, const ir_node *irn);
+  arch_irn_class_t (*classify)(const void *self, const ir_node *irn);
 
   /**
    * Get the flags of a node.
@@ -235,10 +270,73 @@ struct _arch_irn_ops_t {
    * @param irn The node.
    * @return A set of flags.
    */
-  arch_irn_flags_t (*get_flags)(const arch_irn_ops_t *self, const ir_node *irn);
+  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 self      The this pointer.
+   * @param irn       The original operation
+   * @param i         Index of the argument we want the inverse operation 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);
+
+  /**
+   * Get the estimated cycle count for @p irn.
+   *
+   * @param self The this pointer.
+   * @param irn  The node.
+   *
+   * @return     The estimated cycle count for this operation
+   */
+  int (*get_op_estimated_cost)(const void *self, const ir_node *irn);
+
+  /**
+   * Asks the backend whether operand @p i of @p irn can be loaded form memory internally
+   *
+   * @param self The this pointer.
+   * @param irn  The node.
+   * @param i    Index of the argument we would like to know whether @p irn can load it form memory internally
+   *
+   * @return     nonzero if argument can be loaded or zero otherwise
+   */
+  int (*possible_memory_operand)(const void *self, const ir_node *irn, unsigned int i);
 
 };
 
+/**
+ * irn_ops base class.
+ */
+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.
@@ -271,15 +369,31 @@ extern int arch_is_register_operand(const arch_env_t *env,
  * @param env The environment.
  * @param irn The node.
  * @param pos The postition of the node's operand.
- * @param cls The register class.
  * @param bs  The bitset all allocatable registers shall be put into.
  *            Note, that you can also pass NULL here. If you don't,
  *            make sure, the bitset is as large as the register class
  *            has registers.
  * @return    The amount of registers allocatable for that operand.
  */
-extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn,
-    int pos, const arch_register_class_t *cls, bitset_t *bs);
+extern int arch_get_allocatable_regs(const arch_env_t *env, const ir_node *irn, int pos, bitset_t *bs);
+
+/**
+ * Put all registers which shall not be ignored by the register
+ * allocator in a bit set.
+ * @param env The arch env.
+ * @param cls The register class to consider.
+ * @param bs  The bit set to put the registers to.
+ */
+extern void arch_put_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls, bitset_t *bs);
+
+/**
+ * Return the number of registers in a register class which should not be
+ * ignored by the register allocator.
+ * @param env The architecture environment.
+ * @param cls The register class to consider
+ * @return       The number of non-ignore registers in the register class
+ */
+extern int arch_count_non_ignore_regs(const arch_env_t *env, const arch_register_class_t *cls);
 
 /**
  * Check, if a register is assignable to an operand of a node.
@@ -296,7 +410,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.
  */
@@ -338,11 +452,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(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(env, irn, ignore))
+
 /**
- * Somebody who can be asked about nodes.
+ * Somebody who can be asked about IR nodes.
  */
 struct _arch_irn_handler_t {
 
@@ -352,25 +471,25 @@ struct _arch_irn_handler_t {
     * @param irn Some node.
     * @return Operations for that irn.
     */
-  const arch_irn_ops_t *(*get_irn_ops)(const arch_irn_handler_t *handler,
+  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.
@@ -387,23 +506,33 @@ struct _arch_code_generator_if_t {
         */
        void (*before_ra)(void *self);
 
+       /**
+        * Called after register allocation.
+        */
+       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)
 
 /**
@@ -418,21 +547,26 @@ struct _arch_code_generator_t {
  */
 struct _arch_isa_t {
        const arch_isa_if_t *impl;
+       const arch_register_t *sp;  /** The stack pointer register. */
+       const arch_register_t *bp;  /** The base pointer register. */
+       const int stack_dir;        /** -1 for decreasing, 1 for increasing. */
 };
 
+#define arch_isa_stack_dir(isa)  ((isa)->stack_dir)
+#define arch_isa_sp(isa)         ((isa)->sp)
+#define arch_isa_bp(isa)         ((isa)->bp)
+
 /**
  * Architecture interface.
  */
 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.
@@ -452,6 +586,22 @@ struct _arch_isa_if_t {
    */
   const arch_register_class_t *(*get_reg_class)(const void *self, int i);
 
+  /**
+   * Get the register class which shall be used to store a value of a given mode.
+   * @param self The this pointer.
+   * @param mode The mode in question.
+   * @return A register class which can hold values of the given mode.
+   */
+  const arch_register_class_t *(*get_reg_class_for_mode)(const void *self, const ir_mode *mode);
+
+  /**
+   * Get the ABI restrictions for procedure calls.
+   * @param self        The this pointer.
+   * @param method_type The type of the method (procedure) in question.
+   * @param p           The array of parameter locations to be filled.
+   */
+  void (*get_call_abi)(const void *self, ir_type *method_type, be_abi_call_t *abi);
+
   /**
    * The irn handler for this architecture.
    * The irn handler is registered by the Firm back end
@@ -465,7 +615,7 @@ struct _arch_isa_if_t {
    * @param self The this pointer.
    * @return     Some code generator interface.
    */
-  const arch_code_generator_if_t *(*get_code_generator)(void *self);
+  const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
 
   /**
    * Get the list scheduler to use.
@@ -473,12 +623,37 @@ struct _arch_isa_if_t {
    * @return      The list scheduler selector.
    */
   const list_sched_selector_t *(*get_list_sched_selector)(const void *self);
+
+  /**
+   * 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.
+   */
+  int (*get_reg_class_alignment)(const void *self, const arch_register_class_t *cls);
+
+  /**
+   * A "static" function, returns the frontend settings
+   * needed for this backend.
+   */
+  const backend_params *(*get_params)(void);
+
+#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_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
 
@@ -506,10 +681,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.
@@ -517,7 +693,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 */