Moved to new lpp library
[libfirm] / ir / be / becopyopt.h
1 /**
2  * Author:      Daniel Grund
3  * Date:                12.04.2005
4  * Copyright:   (c) Universitaet Karlsruhe
5  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
6  *
7  * Header for copy optimization problem. Analysis and set up of the problem.
8  */
9
10 #ifndef _BECOPYOPT_H
11 #define _BECOPYOPT_H
12
13 #include "debug.h"
14 #include "obst.h"
15 #include "list.h"
16 #include "set.h"
17 #include "pset.h"
18 #include "bitset.h"
19
20 #include "irgraph.h"
21 #include "irgwalk.h"
22 #include "irnode.h"
23 #include "irdom.h"
24 #include "irouts.h"
25
26 #include "beutil.h"
27 #include "benumb_t.h"
28 #include "belive_t.h"
29 #include "bechordal_t.h"
30 #include "bearch.h"
31
32 #define DEBUG_IRG "NONE spec.c__main__datab"
33 #define DEBUG_LVL_CO   LEVEL_1
34 #define DEBUG_LVL_HEUR LEVEL_1
35 #define DEBUG_LVL_ILP  LEVEL_1
36
37 typedef int(*cost_fct_t)(ir_node*, ir_node*, int);
38
39 /**
40  * Data representing the problem of copy minimization.
41  */
42 typedef struct _copy_opt_t {
43         be_chordal_env_t *chordal_env;
44         char *name;                                             /**< ProgName__IrgName__RegClass */
45         struct list_head units;                 /**< all units to optimize in right order */
46         pset *roots;                                    /**< used only temporary for detecting multiple appends */
47         cost_fct_t get_costs;                   /**< function ptr used to get costs for copies */
48         struct obstack ob;
49 } copy_opt_t;
50
51 /**
52  * A single unit of optimization. Lots of these form a copy-opt problem
53  */
54 typedef struct _unit_t {
55         struct list_head units;         /**< chain for all units */
56         copy_opt_t *co;                         /**< the copy_opt this unit belongs to */
57         int node_count;                         /**< size of the nodes array */
58         ir_node **nodes;                        /**< [0] is the root-node, others are non interfering args of it. */
59         int *costs;                                     /**< costs[i] are arising, if nodes[i] has a different color */
60         int complete_costs;                     /**< sum of all costs[i] */
61         int minimal_costs;                      /**< a lower bound for this ou, considering only ifg (not coloring conflicts) */
62
63         int sort_key;                           /**< maximum costs. controls the order of ou's. */
64
65         /* for heuristic */
66         struct list_head queue;         /**< list of (mis/color) sorted by size of mis */
67 } unit_t;
68
69 /* Helpers */
70 #define set_irn_col(co, irn, col) \
71         arch_set_irn_register(co->chordal_env->arch_env, irn, 0, arch_register_for_index(co->chordal_env->cls, col))
72
73 #define get_irn_col(co, irn) \
74         arch_register_get_index(arch_get_irn_register(co->chordal_env->arch_env, irn, 0))
75
76 #define list_entry_units(lh) list_entry(lh, unit_t, units)
77
78
79 /**
80  * Generate the problem. Collect all infos and optimizable nodes.
81  */
82 copy_opt_t *new_copy_opt(be_chordal_env_t *chordal_env, int (*get_costs)(ir_node*, ir_node*, int));
83
84 /**
85  * Free the space...
86  */
87 void free_copy_opt(copy_opt_t *co);
88
89
90 #define is_Perm(arch_env, irn) (arch_irn_classify(arch_env, irn) == arch_irn_class_perm)
91
92 /**
93  * A copy is a proj haning out of perm node
94  */
95 #define is_Copy(arch_env, irn) (is_Proj(irn) && is_Perm(arch_env, get_Proj_pred(irn)))
96
97 /**
98  * returns the corresponding argument of the perm node for a copy
99  */
100 #define get_Copy_src(irn) (get_irn_n(get_Proj_pred(irn), get_Proj_proj(irn)))
101
102 /**
103  * Checks if a node is optimizable, viz. is a target of a 'copy-op'
104  */
105 #define is_optimizable(arch_env, irn) (is_Phi(irn) || is_Copy(arch_env, irn))
106
107 /**
108  * Checks if the irn is a non-interfering argument of a node which 'is_optimizable'
109  */
110 int is_optimizable_arg(const copy_opt_t *co, ir_node *irn);
111
112 /**
113  * Computes the costs of a copy according to loop depth
114  * @param root, arg: clear.
115  * @param pos:  -1 for perm-copies.
116  *                              Else the argument position of arg in the phi node root.
117  * @return Must be >= 0 in all cases.
118  */
119 int get_costs_loop_depth(ir_node *root, ir_node* arg, int pos);
120
121 /**
122  * All costs equal 1. Using this will reduce the number of copies.
123  * @return Must be >= 0 in all cases.
124  */
125 int get_costs_all_one(ir_node *root, ir_node* arg, int pos);
126
127 /**
128  * Returns the current costs the copies are causing
129  */
130 int co_get_copy_costs(const copy_opt_t *co);
131
132 /**
133  * Returns a lower bound for the costs of copies based on interfering
134  * arguments and the size of a max indep. set (only ifg-edges) of the other args.
135  */
136 int co_get_lower_bound(const copy_opt_t *co);
137
138 /**
139  * Solves the problem using a heuristic approach
140  */
141 void co_heur_opt(copy_opt_t *co);
142
143 /**
144  * Solves the problem using mixed integer programming
145  */
146 void co_ilp_opt(copy_opt_t *co);
147
148 #endif