make code a bit more readble
[libfirm] / ir / be / bearch.h
index edb58e7..a084563 100644 (file)
 #include "bitset.h"
 
 #include "belistsched.h"
+#include "beilpsched.h"
 #include "beabi_t.h"
 #include "bearch_t.h"
 #include "be_t.h"
+#include "bemachine.h"
+#include "beirg.h"
 
 struct _be_node_factory_t;
 
 typedef enum _arch_register_type_t {
   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_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_joker        = 8,  /**< The emitter can choose an arbitrary register */
+  arch_register_type_virtual      = 16, /**< This is just a virtual register  */
 } arch_register_type_t;
 
 /**
@@ -42,11 +47,11 @@ typedef enum _arch_register_type_t {
  * A register.
  */
 struct _arch_register_t {
-  const char *name;                         /**< The name of the register. */
+  const char                  *name;        /**< The name of the register. */
   const arch_register_class_t *reg_class;   /**< The class the register belongs to. */
-  int index;                                /**< The index of the register in the class. */
-  arch_register_type_t type;                /**< The type of the register. */
-  void *data;                               /**< Custom data. */
+  int                         index;        /**< The index of the register in the class. */
+  arch_register_type_t        type;         /**< The type of the register. */
+  void                        *data;        /**< Custom data. */
 };
 
 static INLINE const arch_register_class_t *
@@ -60,9 +65,14 @@ static INLINE int _arch_register_get_index(const arch_register_t *reg)
   return reg->index;
 }
 
+static INLINE const char *_arch_register_get_name(const arch_register_t *reg)
+{
+       return reg->name;
+}
+
 #define arch_register_get_class(reg)      _arch_register_get_class(reg)
 #define arch_register_get_index(reg)      _arch_register_get_index(reg)
-#define arch_register_get_name(reg)       ((reg)->name)
+#define arch_register_get_name(reg)       _arch_register_get_name(reg)
 
 /**
  * A class of registers.
@@ -81,6 +91,9 @@ struct _arch_register_class_t {
 /** return the largest mode of this register class */
 #define arch_register_class_mode(cls) ((cls)->mode)
 
+/** return the name of this register class */
+#define arch_register_class_name(cls) ((cls)->name)
+
 /**
  * Put all registers in a class into a bitset.
  * @param cls The class.
@@ -177,14 +190,17 @@ extern char *arch_register_req_format(char *buf, size_t len, const arch_register
  * Certain node classes which are relevant for the register allocator.
  */
 typedef enum _arch_irn_class_t {
-  arch_irn_class_normal,
-  arch_irn_class_spill,
-  arch_irn_class_reload,
-  arch_irn_class_copy,
-  arch_irn_class_perm,
-  arch_irn_class_branch,
-  arch_irn_class_call,
-  arch_irn_class_const,
+  arch_irn_class_normal     = 1 << 0,
+  arch_irn_class_spill      = 1 << 1,
+  arch_irn_class_reload     = 1 << 2,
+  arch_irn_class_copy       = 1 << 3,
+  arch_irn_class_perm       = 1 << 4,
+  arch_irn_class_branch     = 1 << 5,
+  arch_irn_class_call       = 1 << 6,
+  arch_irn_class_const      = 1 << 7,
+  arch_irn_class_load       = 1 << 8,
+  arch_irn_class_store      = 1 << 9,
+  arch_irn_class_stackparam = 1 << 10,
 } arch_irn_class_t;
 
 /**
@@ -206,7 +222,7 @@ typedef struct _arch_inverse_t {
 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_rematerializable = 2, /**< This can 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
@@ -273,9 +289,18 @@ struct _arch_irn_ops_if_t {
    * 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.
+   * @return The entity on the stack frame or NULL, if the node does not have a
+   *         stack frame entity.
    */
-  entity *(*get_frame_entity)(const void *self, const ir_node *irn);
+  ir_entity *(*get_frame_entity)(const void *self, const ir_node *irn);
+
+  /**
+   * Set the entity on the stack frame this node depends on.
+   * @param self The this pointer.
+   * @param irn  The node in question.
+   * @param ent  The entity to set
+   */
+  void (*set_frame_entity)(const void *self, ir_node *irn, ir_entity *ent);
 
   /**
    * Set the offset of a node carrying an entity on the stack frame.
@@ -285,10 +310,25 @@ struct _arch_irn_ops_if_t {
    */
   void (*set_frame_offset)(const void *self, ir_node *irn, int offset);
 
+  /**
+   * Returns the delta of the stackpointer for nodes that increment or
+   * decrement the stackpointer with a constant value. (push, pop
+   * nodes on most architectures).
+   * A positive value stands for an expanding stack area, a negative value for
+   * a shrinking one.
+   *
+   * @param self      The this pointer
+   * @param irn       The node
+   * @return          0 if the stackpointer is not modified with a constant
+   *                  value, otherwise the increment/decrement value
+   */
+  int (*get_sp_bias)(const void *self, const ir_node *irn);
+
   /**
    * 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
@@ -297,6 +337,36 @@ struct _arch_irn_ops_if_t {
    */
   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);
+
+  /**
+   * Ask the backend to assimilate @p reload of operand @p i into @p irn.
+   *
+   * @param self   The this pointer.
+   * @param irn    The node.
+   * @param spill  The spill.
+   * @param i      The position of the reload.
+   */
+  void (*perform_memory_operand)(const void *self, ir_node *irn, ir_node *spill, unsigned int i);
 };
 
 /**
@@ -306,11 +376,18 @@ struct _arch_irn_ops_t {
        const arch_irn_ops_if_t *impl;
 };
 
+extern const arch_irn_ops_t *arch_get_irn_ops(const arch_env_t *env, const ir_node *irn);
+
 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 ir_entity *arch_get_frame_entity(const arch_env_t *env, ir_node *irn);
+extern void arch_set_frame_entity(const arch_env_t *env, ir_node *irn, ir_entity *ent);
+extern int arch_get_sp_bias(const arch_env_t *env, ir_node *irn);
 
+extern int arch_get_op_estimated_cost(const arch_env_t *env, const 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);
+extern int arch_possible_memory_operand(const arch_env_t *env, const ir_node *irn, unsigned int i);
+extern void arch_perform_memory_operand(const arch_env_t *env, ir_node *irn, ir_node *spill, unsigned int i);
 
 /**
  * Get the register requirements for a node.
@@ -410,6 +487,8 @@ extern void arch_set_irn_register(const arch_env_t *env, ir_node *irn,
  */
 extern arch_irn_class_t arch_irn_classify(const arch_env_t *env, const ir_node *irn);
 
+#define arch_irn_class_is(env, irn, irn_class) ((arch_irn_classify(env, irn) & arch_irn_class_ ## irn_class) != 0)
+
 /**
  * Get the flags of a node.
  * @param env The architecture environment.
@@ -450,7 +529,7 @@ struct _arch_code_generator_if_t {
         * @param birg A backend IRG session.
         * @return     A newly created code generator.
         */
-       void *(*init)(const be_irg_t *birg);
+       void *(*init)(be_irg_t *birg);
 
        /**
         * Called before abi introduce.
@@ -462,6 +541,12 @@ struct _arch_code_generator_if_t {
         */
        void (*prepare_graph)(void *self);
 
+       /**
+        * Backend may provide an own spiller.
+        * This spiller needs to spill all register classes.
+        */
+       void (*spill)(void *self, be_irg_t *birg);
+
        /**
         * Called before scheduling.
         */
@@ -478,7 +563,14 @@ struct _arch_code_generator_if_t {
        void (*after_ra)(void *self);
 
        /**
-        * Called after everything happened.
+        * Called directly before done is called. This should be the last place
+        * where the irg is modified.
+        */
+       void (*finish)(void *self);
+
+       /**
+        * Called after everything happened. This call should emit the final
+        * assembly code but avoid changing the irg.
         * The code generator must also be de-allocated here.
         */
        void (*done)(void *self);
@@ -494,12 +586,21 @@ do { \
                (cg)->impl->func(cg); \
 } while(0)
 
+#define _arch_cg_call_env(cg, env, func) \
+do { \
+       if((cg)->impl->func) \
+               (cg)->impl->func(cg, env); \
+} 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_finish(cg)          _arch_cg_call(cg, finish)
 #define arch_code_generator_done(cg)            _arch_cg_call(cg, done)
+#define arch_code_generator_spill(cg, birg)     _arch_cg_call_env(cg, birg, spill)
+#define arch_code_generator_has_spiller(cg)     ((cg)->impl->spill != NULL)
 
 /**
  * Code generator base class.
@@ -512,10 +613,11 @@ struct _arch_code_generator_t {
  * ISA base class.
  */
 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. */
+       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. */
+       const be_main_env_t   *main_env;  /** the be main environment */
 };
 
 #define arch_isa_stack_dir(isa)  ((isa)->stack_dir)
@@ -526,94 +628,126 @@ struct _arch_isa_t {
  * Architecture interface.
  */
 struct _arch_isa_if_t {
-
-  /**
-   * Initialize the isa interface.
+       /**
+        * Initialize the isa interface.
         * @param file_handle  the file handle to write the output to
+        * @param main_env     the be main environment
         * @return a new isa instance
-   */
-  void *(*init)(FILE *file_handle);
+        */
+       void *(*init)(FILE *file_handle);
 
-  /**
-   * Free the isa instance.
-   */
-  void (*done)(void *self);
+       /**
+        * Free the isa instance.
+        */
+       void (*done)(void *self);
 
-  /**
-   * Get the the number of register classes in the isa.
-   * @return The number of register classes.
-   */
-  int (*get_n_reg_class)(const void *self);
+       /**
+        * Get the the number of register classes in the isa.
+        * @return The number of register classes.
+        */
+       int (*get_n_reg_class)(const void *self);
 
-  /**
-   * Get the i-th register class.
-   * @param i The number of the register class.
-   * @return The register class.
-   */
-  const arch_register_class_t *(*get_reg_class)(const void *self, int i);
+       /**
+        * Get the i-th register class.
+        * @param i The number of the register class.
+        * @return The register class.
+        */
+       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 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);
+       /**
+        * 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
-   * when the architecture is initialized.
-   * (May be NULL).
-   */
-  const arch_irn_handler_t *(*get_irn_handler)(const void *self);
+       /**
+        * The irn handler for this architecture.
+        * The irn handler is registered by the Firm back end
+        * when the architecture is initialized.
+        * (May be NULL).
+        */
+       const arch_irn_handler_t *(*get_irn_handler)(const void *self);
 
-  /**
-   * Get the code generator interface.
-   * @param self The this pointer.
-   * @return     Some code generator interface.
-   */
-  const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
+       /**
+        * Get the code generator interface.
+        * @param self The this pointer.
+        * @return     Some code generator interface.
+        */
+       const arch_code_generator_if_t *(*get_code_generator_if)(void *self);
 
-  /**
-   * Get the list scheduler to use.
-   * @param self  The isa object.
-   * @return      The list scheduler selector.
-   */
-  const list_sched_selector_t *(*get_list_sched_selector)(const void *self);
+       /**
+        * Get the list scheduler to use. There is already a selector given, the
+        * backend is free to modify and/or ignore it.
+        *
+        * @param self     The isa object.
+        * @param selector The selector given by options.
+        * @return         The list scheduler selector.
+        */
+       const list_sched_selector_t *(*get_list_sched_selector)(const void *self, list_sched_selector_t *selector);
 
-  /**
-   * 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);
+       /**
+        * Get the ILP scheduler to use.
+        * @param self  The isa object.
+        * @return      The ILP scheduler selector
+        */
+       const ilp_sched_selector_t *(*get_ilp_sched_selector)(const void *self);
 
-#ifdef WITH_LIBCORE
        /**
-        * Register command line options for this backend.
-        * @param grp  The root group.
+        * 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.
         */
-  void (*register_options)(lc_opt_entry_t *grp);
-#endif
+       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);
+
+       /**
+        * Returns an 2-dim array of execution units, @p irn can be executed on.
+        * The first dimension is the type, the second the allowed units of this type.
+        * Each dimension is a NULL terminated list.
+        * @param self  The isa object.
+        * @param irn   The node.
+        * @return An array of allowed execution units.
+        *         exec_unit = {
+        *                       { unit1_of_tp1, ..., unitX1_of_tp1, NULL },
+        *                       ...,
+        *                       { unit1_of_tpY, ..., unitXn_of_tpY, NULL },
+        *                       NULL
+        *                     };
+        */
+       const be_execution_unit_t ***(*get_allowed_execution_units)(const void *self, const ir_node *irn);
+
+       /**
+        * Return the abstract machine for this isa.
+        * @param self  The isa object.
+        */
+       const be_machine_t *(*get_machine)(const void *self);
 };
 
-#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_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_isa_get_allowed_execution_units(isa, irn) ((isa)->impl->get_allowed_execution_units((isa), (irn)))
+#define arch_isa_get_machine(isa)                      ((isa)->impl->get_machine((isa)))
 
 #define ARCH_MAX_HANDLERS         8
 
@@ -645,7 +779,7 @@ struct _arch_env_t {
  * @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, FILE *file_handle);
+extern arch_env_t *arch_env_init(arch_env_t *env, const arch_isa_if_t *isa, FILE *file_handle, be_main_env_t *main_env);
 
 /**
  * Add a node handler to the environment.
@@ -662,4 +796,9 @@ extern arch_env_t *arch_env_push_irn_handler(arch_env_t *env, const arch_irn_han
  */
 extern const arch_irn_handler_t *arch_env_pop_irn_handler(arch_env_t *env);
 
+/**
+ * Register an instruction set architecture
+ */
+void be_register_isa_if(const char *name, const arch_isa_if_t *isa);
+
 #endif /* _FIRM_BEARCH_H */