Renaming of a type.
[libfirm] / ir / be / becopyopt.h
index 525d27c..c245e10 100644 (file)
 /**
  * Author:      Daniel Grund
- * Date:               12.04.2005
+ * Date:               11.04.2005
  * Copyright:   (c) Universitaet Karlsruhe
  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  *
- * Header for copy optimization problem. Analysis and set up of the problem.
+ * Main file for the optimization reducing the copies needed for:
+ * - Phi coalescing
+ * - Register-constrained nodes
+ * - Two-address code instructions
  */
 
 #ifndef _BECOPYOPT_H
 #define _BECOPYOPT_H
 
-#include "debug.h"
-#include "obst.h"
-#include "list.h"
-#include "set.h"
-#include "pset.h"
-#include "bitset.h"
-
-#include "irgraph.h"
-#include "irgwalk.h"
-#include "irnode.h"
-#include "irdom.h"
-#include "irouts.h"
-
-#include "beutil.h"
-#include "benumb_t.h"
-#include "belive_t.h"
-#include "bechordal_t.h"
-#include "bearch.h"
-
-#define DEBUG_IRG "MergeSort.c__merge__datab"
-#define DEBUG_IRG_LVL_CO   SET_LEVEL_1
-#define DEBUG_IRG_LVL_HEUR SET_LEVEL_1
-#define DEBUG_IRG_LVL_ILP  SET_LEVEL_1
-#define DEBUG_LVL_CO   SET_LEVEL_0
-#define DEBUG_LVL_HEUR SET_LEVEL_0
-#define DEBUG_LVL_ILP  SET_LEVEL_0
+#include "firm_types.h"
+#include "bechordal.h"
+
+/**
+ * Has to be called during the firm init phase
+ */
+void be_copy_opt_init(void);
 
 typedef int(*cost_fct_t)(ir_node*, ir_node*, int);
 
+typedef struct _copy_opt_t copy_opt_t;
+
 /**
- * Data representing the problem of copy minimization.
+ * Generate the problem. Collect all information and optimizable nodes.
  */
-typedef struct _copy_opt_t {
-       be_chordal_env_t *chordal_env;
-       char *name;                                             /**< ProgName__IrgName__RegClass */
-       struct list_head units;                 /**< all units to optimize in right order */
-       pset *roots;                                    /**< used only temporary for detecting multiple appends */
-       cost_fct_t get_costs;                   /**< function ptr used to get costs for copies */
-       struct obstack ob;
-} copy_opt_t;
+copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
 
 /**
- * A single unit of optimization. Lots of these form a copy-opt problem
+ * Free the space used...
  */
-typedef struct _unit_t {
-       struct list_head units;         /**< chain for all units */
-       copy_opt_t *co;                         /**< the copy_opt this unit belongs to */
-       int node_count;                         /**< size of the nodes array */
-       ir_node **nodes;                        /**< [0] is the root-node, others are non interfering args of it. */
-       int *costs;                                     /**< costs[i] are arising, if nodes[i] has a different color */
-       int inevitable_costs;           /**< sum of costs of all args interfering with root */
-       int all_nodes_costs;            /**< sum of all costs[i] */
-       int min_nodes_costs;            /**< a lower bound for the costs in costs[], determined by a max indep. set */
-       int sort_key;                           /**< maximum costs. controls the order of ou's in the struct list_head units. */
-
-       /* for heuristic */
-       struct list_head queue;         /**< list of qn's sorted by weight of qn-mis */
-} unit_t;
-
-/* Helpers */
-#define set_irn_col(co, irn, col) \
-       arch_set_irn_register(co->chordal_env->arch_env, irn, 0, arch_register_for_index(co->chordal_env->cls, col))
-
-#define get_irn_col(co, irn) \
-       arch_register_get_index(arch_get_irn_register(co->chordal_env->arch_env, irn, 0))
+void free_copy_opt(copy_opt_t *co);
 
-#define list_entry_units(lh) list_entry(lh, unit_t, units)
+/**
+ * Checks if a node is optimizable, viz. has something to do with coalescing
+ * @param arch The architecture environment
+ * @param irn  The irn to check
+ */
+int co_is_optimizable_root(const copy_opt_t *co, ir_node *irn);
 
+/**
+ * Checks if the irn is a non-interfering argument of a node which 'is_optimizable'
+ */
+int co_is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
 
 /**
- * Generate the problem. Collect all infos and optimizable nodes.
+ * Computes the costs of a copy according to loop depth
+ * @param pos: the argument position of arg in the root arguments
+ * @return Must be >= 0 in all cases.
  */
-copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, int (*get_costs)(ir_node*, ir_node*, int));
+int co_get_costs_loop_depth(ir_node *root, ir_node* arg, int pos);
 
 /**
- * Free the space...
+ * All costs equal 1. Using this will reduce the _number_ of copies.
+ * @return Must be >= 0 in all cases.
  */
-void free_copy_opt(copy_opt_t *co);
+int co_get_costs_all_one(ir_node *root, ir_node* arg, int pos);
 
 
-#define is_Perm(arch_env, irn) (arch_irn_classify(arch_env, irn) == arch_irn_class_perm)
 
-/**
- * A copy is a proj haning out of perm node
- */
-#define is_Copy(arch_env, irn) (is_Proj(irn) && is_Perm(arch_env, get_Proj_pred(irn)))
 
 /**
- * returns the corresponding argument of the perm node for a copy
+ * Build internal optimization units structure
  */
-#define get_Copy_src(irn) (get_irn_n(get_Proj_pred(irn), get_Proj_proj(irn)))
+void co_build_ou_structure(copy_opt_t *co);
 
 /**
- * Checks if a node is optimizable, viz. is a target of a 'copy-op'
+ * Frees the space used by the opt unit representation.
+ * Does NOT free the whole copyopt structure
  */
-#define is_optimizable(arch_env, irn) (is_Phi(irn) || is_Copy(arch_env, irn))
+void co_free_ou_structure(copy_opt_t *co);
 
 /**
- * Checks if the irn is a non-interfering argument of a node which 'is_optimizable'
+ * Solves the problem using a heuristic approach
+ * Uses the OU data structure
  */
-int is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
+int co_solve_heuristic(copy_opt_t *co);
 
 /**
- * Computes the costs of a copy according to loop depth
- * @param root, arg: clear.
- * @param pos: -1 for perm-copies.
- *                             Else the argument position of arg in the phi node root.
- * @return Must be >= 0 in all cases.
+ * Returns the maximal costs possible, i.e. the costs if all
+ * pairs would be assigned different registers.
+ * Uses the OU data structure
  */
-int get_costs_loop_depth(ir_node *root, ir_node* arg, int pos);
+int co_get_max_copy_costs(const copy_opt_t *co);
 
 /**
- * All costs equal 1. Using this will reduce the number of copies.
- * @return Must be >= 0 in all cases.
+ * Returns the inevitable costs, i.e. the costs of
+ * all copy pairs which interfere.
+ * Uses the OU data structure
  */
-int get_costs_all_one(ir_node *root, ir_node* arg, int pos);
+int co_get_inevit_copy_costs(const copy_opt_t *co);
 
 /**
  * Returns the current costs the copies are causing.
  * The result includes inevitable costs and the costs
  * of the copies regarding the current register allocation
+ * Uses the OU data structure
  */
 int co_get_copy_costs(const copy_opt_t *co);
 
@@ -138,17 +106,44 @@ int co_get_copy_costs(const copy_opt_t *co);
  * Returns a lower bound for the costs of copies in this ou.
  * The result includes inevitable costs and the costs of a
  * minimal costs caused by the nodes of the ou.
+ * Uses the OU data structure
  */
 int co_get_lower_bound(const copy_opt_t *co);
 
+
+
+
+
 /**
- * Solves the problem using a heuristic approach
+ * Constructs another internal representation of the affinity edges
  */
-void co_heur_opt(copy_opt_t *co);
+void co_build_graph_structure(copy_opt_t *co);
+
+/**
+ * Frees the space used by the graph representation.
+ * Does NOT free the whole copyopt structure
+ */
+void co_free_graph_structure(copy_opt_t *co);
 
 /**
  * Solves the problem using mixed integer programming
+ * @returns 1 iff solution state was optimal
+ * NYI
+ */
+int co_solve_ilp1(copy_opt_t *co, double time_limit);
+
+/**
+ * Solves the problem using mixed integer programming
+ * @returns 1 iff solution state was optimal
+ * Uses the OU and the GRAPH data structure
+ * Dependency of the OU structure can be removed
+ */
+int co_solve_ilp2(copy_opt_t *co, double time_limit);
+
+/**
+ * Checks if a node is optimizable, viz has something to do with coalescing.
+ * Uses the GRAPH data structure
  */
-void co_ilp_opt(copy_opt_t *co);
+int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
 
-#endif
+#endif /* _BECOPYOPT_H */