Renaming of a type.
[libfirm] / ir / be / becopyopt.h
index c2ee3aa..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 "sp_matrix.h"
+#include "firm_types.h"
+#include "bechordal.h"
 
-#include "irgraph.h"
-#include "irgwalk.h"
-#include "irnode.h"
-#include "irdom.h"
-#include "irouts.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;
 
-#include "beutil.h"
-#include "benumb_t.h"
-#include "belive_t.h"
-#include "bera_t.h"
-#include "bechordal_t.h"
-#include "bearch.h"
+/**
+ * Generate the problem. Collect all information and optimizable nodes.
+ */
+copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
+
+/**
+ * Free the space used...
+ */
+void free_copy_opt(copy_opt_t *co);
 
-/* TODO is_Copy */
-#define is_Copy(irn) 0
-#define DEBUG_IRG "-scanner.c__init_td__gp"
+/**
+ * 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);
 
 /**
- * Data representing the problem of copy minimization.
+ * Checks if the irn is a non-interfering argument of a node which 'is_optimizable'
  */
-typedef struct _copy_opt_t {
-       ir_graph *irg;                                          /**< the irg to process */
-       char *name;                                                     /**< ProgName__IrgName__RegClass */
-       const arch_env_t *env;                          /**< Environment (isa + handlers) */
-       const arch_register_class_t *cls;       /**< the registerclass all nodes belong to (in this pass) */
-       struct list_head units;                         /**< all units to optimize in right order */
-       pset *roots;                                            /**< used only temporary for detecting multiple appends */
-       struct obstack ob;
-} copy_opt_t;
+int co_is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
 
 /**
- * A single unit of optimization. Lots of these form a copy-opt problem
+ * 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.
  */
-typedef struct _unit_t {
-       struct list_head units;         /**< chain for all units */
-       copy_opt_t *co;                         /**< the copy_opt this unit belongs to */
-       int interf;                                     /**< number of nodes dropped due to interference */
-       int node_count;                         /**< size of the nodes array */
-       ir_node **nodes;                        /**< [0] is the root-node, others are non interfering args of it. */
+int co_get_costs_loop_depth(ir_node *root, ir_node* arg, int pos);
 
-       /* for heuristic */
-       int mis_size;                           /**< size of a mis considering only ifg (not coloring conflicts) */
-       struct list_head queue;         /**< list of (mis/color) sorted by size of mis */
-} unit_t;
+/**
+ * All costs equal 1. Using this will reduce the _number_ of copies.
+ * @return Must be >= 0 in all cases.
+ */
+int co_get_costs_all_one(ir_node *root, ir_node* arg, int pos);
 
-/* Helpers */
-#define set_irn_col(co, irn, col) \
-       arch_set_irn_register(co->env, irn, 0, arch_register_for_index(co->cls, col))
 
-#define get_irn_col(co, irn) \
-       arch_register_get_index(arch_get_irn_register(co->env, irn, 0))
 
 
 /**
- * Generate the problem. Collect all infos and optimizable nodes.
+ * Build internal optimization units structure
  */
-copy_opt_t *new_copy_opt(ir_graph *irg, const arch_env_t *env, const arch_register_class_t *cls);
+void co_build_ou_structure(copy_opt_t *co);
 
 /**
- * Free the space...
+ * Frees the space used by the opt unit representation.
+ * Does NOT free the whole copyopt structure
  */
-void free_copy_opt(copy_opt_t *co);
+void co_free_ou_structure(copy_opt_t *co);
 
-#define is_optimizable(irn) (is_Phi(irn) || is_Copy(irn))
+/**
+ * Solves the problem using a heuristic approach
+ * Uses the OU data structure
+ */
+int co_solve_heuristic(copy_opt_t *co);
 
 /**
- * Checks if the irn is a non-interfering argument of a node which 'is_optimizable'
+ * Returns the maximal costs possible, i.e. the costs if all
+ * pairs would be assigned different registers.
+ * Uses the OU data structure
+ */
+int co_get_max_copy_costs(const copy_opt_t *co);
+
+/**
+ * Returns the inevitable costs, i.e. the costs of
+ * all copy pairs which interfere.
+ * Uses the OU data structure
+ */
+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 is_optimizable_arg(ir_node *irn);
+int co_get_copy_costs(const copy_opt_t *co);
 
 /**
- * Returns the current number of copies needed
+ * 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_copy_count(copy_opt_t *co);
+int co_get_lower_bound(const copy_opt_t *co);
+
+
+
+
 
 /**
- * IMPORTANT: Available only iff heuristic has run!
- * Returns a lower bound for the number of copies needed based on interfering
- * arguments and the size of a max indep. set (only ifg-edges) of the other args.
+ * Constructs another internal representation of the affinity edges
  */
-int co_get_lower_bound(copy_opt_t *co);
+void co_build_graph_structure(copy_opt_t *co);
 
 /**
- * Returns the number of arguments interfering with their root node. This also
- * is a (worse) lower bound for the number of copies needed.
+ * Frees the space used by the graph representation.
+ * Does NOT free the whole copyopt structure
  */
-int co_get_interferer_count(copy_opt_t *co);
+void co_free_graph_structure(copy_opt_t *co);
 
 /**
- * Solves the problem using a heuristic approach
+ * Solves the problem using mixed integer programming
+ * @returns 1 iff solution state was optimal
+ * NYI
  */
-void co_heur_opt(copy_opt_t *co);
+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
  */
-void co_ilp_opt(copy_opt_t *co);
+int co_solve_ilp2(copy_opt_t *co, double time_limit);
 
 /**
- * Checks the register allocation for correctness
+ * Checks if a node is optimizable, viz has something to do with coalescing.
+ * Uses the GRAPH data structure
  */
-void co_check_allocation(copy_opt_t *co);
+int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
 
-#endif
+#endif /* _BECOPYOPT_H */