bescripts: Copy all common node attributes into the constructor variants.
[libfirm] / ir / be / becopyopt.h
index 701f00b..67175e2 100644 (file)
-/**
- * Author:      Daniel Grund
- * Date:               12.04.2005
- * Copyright:   (c) Universitaet Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+/*
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
  *
- * Header for copy optimization problem. Analysis and set up of the problem.
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
  */
 
-#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 "!!deflate.c__longest_match__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
-
-#define MIS_HEUR_TRIGGER 8
-
-
-typedef int(*cost_fct_t)(ir_node*, ir_node*, int);
-
 /**
- * Data representing the problem of copy minimization.
+ * @file
+ * @brief       Copy minimization driver.
+ * @author      Daniel Grund
+ * @date        11.04.2005
+ *
+ * Main file for the optimization reducing the copies needed for:
+ * - Phi coalescing
+ * - Register-constrained nodes
+ * - Two-address code instructions
  */
-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 specific order */
-       cost_fct_t get_costs;                   /**< function ptr used to get costs for copies */
-       struct obstack ob;
-} copy_opt_t;
+#ifndef FIRM_BE_BECOPYOPT_H
+#define FIRM_BE_BECOPYOPT_H
 
-/**
- * A single unit of optimization. Lots of these form a copy-opt problem
- */
-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. */
+#include <stdbool.h>
 
-       /* for heuristic */
-       struct list_head queue;         /**< list of qn's sorted by weight of qn-mis */
-} unit_t;
+#include "firm_types.h"
+#include "bechordal.h"
 
-/* Helpers */
-#define get_arch_env(co) ((co)->chordal_env->main_env->arch_env)
-#define get_irg(co)      ((co)->chordal_env->irg)
-#define get_irn_col(co, irn) \
-       arch_register_get_index(arch_get_irn_register(get_arch_env(co), irn))
-#define set_irn_col(co, irn, col) \
-       arch_set_irn_register(get_arch_env(co), irn, arch_register_for_index(co->chordal_env->cls, col))
+typedef int(*cost_fct_t)(const ir_node *node, int input);
 
+typedef struct {
+       int (*copyopt)(copy_opt_t *co); /**< function ptr to run copyopt */
+       bool can_improve_existing;
+} co_algo_info;
 
-#define list_entry_units(lh) list_entry(lh, unit_t, units)
+/**
+ * Register a new copy optimization algorithm.
+ *
+ * @param name     the name of the copy optimazation algorithm,
+ *                 used to select it
+ * @param copyopt  a copy optimazation entry
+ */
+void be_register_copyopt(const char *name, co_algo_info *copyopt);
 
+/** The driver for copy minimization. */
+void co_driver(be_chordal_env_t *cenv);
 
 /**
- * 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 get_Copy_src(irn) (get_irn_n(get_Proj_pred(irn), get_Proj_proj(irn)))
-#define is_Perm(arch_env, irn)                         (arch_irn_classify(arch_env, irn) == arch_irn_class_perm)
-
-#define is_Reg_Phi(irn)                                                (is_Phi(irn) && mode_is_data(get_irn_mode(irn)))
-#define is_Copy(arch_env, irn)                         (is_Proj(irn) && is_Perm(arch_env, get_Proj_pred(irn)))
-#define is_2addr_code(arch_env, irn, req)      (arch_get_register_req(arch_env, req, irn, -1)->type == arch_register_req_type_should_be_same)
+/**
+ * Statistics over a copy optimization module.
+ */
+typedef struct {
+       unsigned long long aff_edges;            /**< number of affinity edges. */
+       unsigned long long aff_nodes;            /**< number of nodes with incident affinity edges. */
+       unsigned long long aff_int;              /**< number of affinity edges whose nodes also interfere. */
+       unsigned long long inevit_costs;         /**< costs which cannot be evited (due to interfering affinities). */
+       unsigned long long max_costs;            /**< all costs of the affinities. */
+       unsigned long long costs;                /**< The costs of the current coloring. */
+       unsigned long long unsatisfied_edges;    /**< The number of unequally colored affinity edges. */
+} co_complete_stats_t;
 
 /**
- * Checks if a node is optimizable, viz. has somthing to do with coalescing
- * @param arch The architecture environment
- * @param irn  The irn to check
- * @param req  A register_requirement structure (used to check for 2-addr-code)
+ * Collect statistics of a copy optimization module.
+ * @param co    The copy optimization environment.
+ * @param stat  Where to put the stats.
+ * @note  This requires the graph info to be computed.
  */
-#define is_optimizable(arch, irn, req) (is_Reg_Phi(irn) || is_Copy(arch, irn) || is_2addr_code(arch, irn, req))
+void co_complete_stats(const copy_opt_t *co, co_complete_stats_t *stat);
+
 
 /**
- * Checks if the irn is a non-interfering argument of a node which 'is_optimizable'
+ * Build internal optimization units structure
  */
-int is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
+void co_build_ou_structure(copy_opt_t *co);
 
 /**
- * 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.
+ * Frees the space used by the opt unit representation.
+ * Does NOT free the whole copyopt structure
  */
-int get_costs_loop_depth(ir_node *root, ir_node* arg, int pos);
+void co_free_ou_structure(copy_opt_t *co);
 
 /**
- * All costs equal 1. Using this will reduce the number of copies.
- * @return Must be >= 0 in all cases.
+ * Solves the problem using a heuristic approach
+ * Uses the OU data structure
  */
-int get_costs_all_one(ir_node *root, ir_node* arg, int pos);
+int co_solve_heuristic(copy_opt_t *co);
 
 /**
  * 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);
 
@@ -142,6 +122,7 @@ 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);
 
@@ -149,18 +130,25 @@ 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_build_graph_structure(copy_opt_t *co);
+
+/**
+ * Frees the space used by the graph representation.
+ * Does NOT free the whole copyopt structure
  */
-void co_heur_opt(copy_opt_t *co);
+void co_free_graph_structure(copy_opt_t *co);
 
 /**
- * Solves the problem using mixed integer programming
- * @returns 1 iff solution state was optimal
+ * Checks if a node is optimizable, viz has something to do with coalescing.
+ * Uses the GRAPH data structure
  */
-int co_ilp_opt(copy_opt_t *co, double time_limit);
+int co_gs_is_optimizable(copy_opt_t *co, ir_node *irn);
 
 #endif