make code a bit more readble
[libfirm] / ir / be / bearch.h
index 2743f63..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.
@@ -279,9 +289,10 @@ 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.
@@ -289,7 +300,7 @@ struct _arch_irn_ops_if_t {
    * @param irn  The node in question.
    * @param ent  The entity to set
    */
-  void (*set_frame_entity)(const void *self, ir_node *irn, entity *ent);
+  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.
@@ -369,8 +380,8 @@ extern const arch_irn_ops_t *arch_get_irn_ops(const arch_env_t *env, const ir_no
 
 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 void arch_set_frame_entity(const arch_env_t *env, ir_node *irn, entity *ent);
+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);
@@ -518,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.
@@ -530,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.
         */
@@ -569,6 +586,12 @@ 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)
@@ -576,6 +599,8 @@ do { \
 #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.
@@ -589,10 +614,10 @@ 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. */
-       const be_main_env_t   *main_env; /** the be main environment */
+       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)
@@ -603,104 +628,126 @@ struct _arch_isa_t {
  * Architecture interface.
  */
 struct _arch_isa_if_t {
+       /**
+        * 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);
 
-  /**
-   * 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);
+       /**
+        * 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. 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 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 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);
 
-  /**
-   * 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 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);
+       /**
+        * 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
+       /**
+        * 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
 
@@ -749,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 */