Next step of refactoring
[libfirm] / ir / be / becopyopt.h
index 5dd61ec..1cd7cdd 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"
+#include "bechordal.h"
 
-#define DEBUG_IRG "NONE spec.c__main__datab"
-#define DEBUG_LVL_CO   LEVEL_1
-#define DEBUG_LVL_HEUR LEVEL_1
-#define DEBUG_LVL_ILP  LEVEL_1
 
 typedef int(*cost_fct_t)(ir_node*, ir_node*, int);
 
-/**
- * Data representing the problem of copy minimization.
- */
-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;
+typedef struct _copy_opt_t copy_opt_t;
 
 /**
- * A single unit of optimization. Lots of these form a copy-opt problem
+ * Has to be called during the firm init phase
  */
-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 complete_costs;                     /**< sum of all costs[i] */
-       int minimal_costs;                      /**< a lower bound for this ou, considering only ifg (not coloring conflicts) */
-
-       int sort_key;                           /**< maximum costs. controls the order of ou's. */
-
-       /* for heuristic */
-       struct list_head queue;         /**< list of (mis/color) sorted by size of 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))
-
-#define list_entry_units(lh) list_entry(lh, unit_t, units)
-
+void be_copy_opt_init(void);
 
 /**
- * Generate the problem. Collect all infos and optimizable nodes.
+ * Generate the problem. Collect all information and optimizable nodes.
  */
-copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, int (*get_costs)(ir_node*, ir_node*, int));
+copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
 
 /**
- * Free the space...
+ * Free the space used...
  */
 void free_copy_opt(copy_opt_t *co);
 
-
-#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
- */
-#define get_Copy_src(irn) (get_irn_n(get_Proj_pred(irn), get_Proj_proj(irn)))
-
-/**
- * Checks if a node is optimizable, viz. is a target of a 'copy-op'
- */
-#define is_optimizable(arch_env, irn) (is_Phi(irn) || is_Copy(arch_env, irn))
-
-/**
- * Checks if the irn is a non-interfering argument of a node which 'is_optimizable'
- */
-int is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
-
 /**
  * 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.
+ * @param pos: the argument position of arg in the root arguments
  * @return Must be >= 0 in all cases.
  */
-int get_costs_loop_depth(ir_node *root, ir_node* arg, int pos);
+int co_get_costs_loop_depth(ir_node *root, ir_node* arg, int pos);
 
 /**
- * All costs equal 1. Using this will reduce the number of copies.
+ * All costs equal 1. Using this will reduce the _number_ of copies.
  * @return Must be >= 0 in all cases.
  */
-int get_costs_all_one(ir_node *root, ir_node* arg, int pos);
+int co_get_costs_all_one(ir_node *root, ir_node* arg, int pos);
 
 /**
- * Returns the current costs the copies are causing
+ * Solves the problem using a heuristic approach
  */
-int co_get_copy_costs(const copy_opt_t *co);
+int co_solve_heuristic(copy_opt_t *co);
 
 /**
- * Returns a lower bound for the costs of copies based on interfering
- * arguments and the size of a max indep. set (only ifg-edges) of the other args.
+ * Solves the problem using mixed integer programming
+ * @returns 1 iff solution state was optimal
  */
-int co_get_lower_bound(const copy_opt_t *co);
+int co_solve_ilp1(copy_opt_t *co, double time_limit);
 
 /**
- * Solves the problem using a heuristic approach
+ * Solves the problem using mixed integer programming
+ * @returns 1 iff solution state was optimal
  */
-void co_heur_opt(copy_opt_t *co);
+int co_solve_ilp2(copy_opt_t *co, double time_limit);
 
 /**
- * Solves the problem using mixed integer programming
+ * Compares different solutions of the same problem
  */
-void co_ilp_opt(copy_opt_t *co);
+void co_compare_solvers(be_chordal_env_t *chordal_env);
 
 #endif