bescripts: Copy all common node attributes into the constructor variants.
[libfirm] / ir / be / becopyopt.h
index c2ee3aa..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.
  *
- * Header for copy optimization problem. Analysis and set up of the problem.
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * 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
+/**
+ * @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
+ */
+#ifndef FIRM_BE_BECOPYOPT_H
+#define FIRM_BE_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 <stdbool.h>
 
-#include "irgraph.h"
-#include "irgwalk.h"
-#include "irnode.h"
-#include "irdom.h"
-#include "irouts.h"
+#include "firm_types.h"
+#include "bechordal.h"
 
-#include "beutil.h"
-#include "benumb_t.h"
-#include "belive_t.h"
-#include "bera_t.h"
-#include "bechordal_t.h"
-#include "bearch.h"
+typedef int(*cost_fct_t)(const ir_node *node, int input);
 
-/* TODO is_Copy */
-#define is_Copy(irn) 0
-#define DEBUG_IRG "-scanner.c__init_td__gp"
+typedef struct {
+       int (*copyopt)(copy_opt_t *co); /**< function ptr to run copyopt */
+       bool can_improve_existing;
+} co_algo_info;
 
 /**
- * Data representing the problem of copy minimization.
+ * 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
  */
-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;
+void be_register_copyopt(const char *name, co_algo_info *copyopt);
+
+/** The driver for copy minimization. */
+void co_driver(be_chordal_env_t *cenv);
 
 /**
- * A single unit of optimization. Lots of these form a copy-opt problem
+ * Generate the problem. Collect all information and optimizable nodes.
  */
-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. */
+copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, cost_fct_t get_costs);
 
-       /* 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;
+/**
+ * Free the space used...
+ */
+void free_copy_opt(copy_opt_t *co);
 
-/* Helpers */
-#define set_irn_col(co, irn, col) \
-       arch_set_irn_register(co->env, irn, 0, arch_register_for_index(co->cls, col))
+/**
+ * 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;
 
-#define get_irn_col(co, irn) \
-       arch_register_get_index(arch_get_irn_register(co->env, irn, 0))
+/**
+ * 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.
+ */
+void co_complete_stats(const copy_opt_t *co, co_complete_stats_t *stat);
 
 
 /**
- * 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 is_optimizable_arg(ir_node *irn);
+int co_get_max_copy_costs(const copy_opt_t *co);
 
 /**
- * Returns the current number of copies needed
+ * Returns the inevitable costs, i.e. the costs of
+ * all copy pairs which interfere.
+ * Uses the OU data structure
  */
-int co_get_copy_count(copy_opt_t *co);
+int co_get_inevit_copy_costs(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.
+ * 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_lower_bound(copy_opt_t *co);
+int co_get_copy_costs(const 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.
+ * 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_interferer_count(copy_opt_t *co);
+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);
 
 /**
- * Solves the problem using mixed integer programming
+ * Frees the space used by the graph representation.
+ * Does NOT free the whole copyopt structure
  */
-void co_ilp_opt(copy_opt_t *co);
+void co_free_graph_structure(copy_opt_t *co);
 
 /**
- * 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