More refactoring:
[libfirm] / ir / opt / opt_polymorphy.c
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief   Optimize polymorphic Sel and Load nodes.
23  * @author  Goetz Lindenmaier, Michael Beck
24  * @version $Id$
25  * @summary
26  *  This file subsumes optimization code from cgana.
27  */
28 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 #include "iroptimize.h"
33 #include "irprog_t.h"
34 #include "entity_t.h"
35 #include "type_t.h"
36 #include "irop.h"
37 #include "irnode_t.h"
38 #include "ircons.h"
39
40 #include "iropt_dbg.h"
41 #include "irflag_t.h"
42
43 /**
44  * Checks if a graph allocates new memory and returns the
45  * type of the newly allocated entity.
46  * Returns NULL if the graph did not represent an Allocation.
47  *
48  * The default implementation hecks for Alloc nodes only.
49  */
50 ir_type *default_firm_get_Alloc(ir_node *n) {
51         n = skip_Proj(n);
52         if (is_Alloc(n)) {
53                 return get_Alloc_type(n);
54         }
55         return NULL;
56 }
57
58 typedef ir_type *(*get_Alloc_func)(ir_node *n);
59
60 /** The get_Alloc function */
61 static get_Alloc_func firm_get_Alloc = default_firm_get_Alloc;
62
63 /** Set a new get_Alloc_func and returns the old one. */
64 get_Alloc_func firm_set_Alloc_func(get_Alloc_func newf) {
65         get_Alloc_func old = firm_get_Alloc;
66         firm_get_Alloc = newf;
67         return old;
68 }
69
70 /** Return dynamic type of ptr.
71  *
72  * If we can deduct the dynamic type from the firm nodes
73  * by a limited test we return the dynamic type.  Else
74  * we return unknown_type.
75  *
76  * If we find a dynamic type this means that the pointer always points
77  * to an object of this type during runtime.   We resolved polymorphy.
78  */
79 static ir_type *get_dynamic_type(ir_node *ptr) {
80         ir_type *tp;
81
82         /* skip Cast and Confirm nodes */
83         for (;;) {
84                 ir_opcode code = get_irn_opcode(ptr);
85
86                 switch (code) {
87                 case iro_Cast:
88                         ptr = get_Cast_op(ptr);
89                         continue;
90                 case iro_Confirm:
91                         ptr = get_Confirm_value(ptr);
92                         continue;
93                 default:
94                         ;
95                 }
96                 break;
97         }
98         tp = (*firm_get_Alloc)(ptr);
99         return tp ? tp : firm_unknown_type;
100 }
101
102 /**
103  * Check, if an entity is final, i.e. is not anymore overridden.
104  */
105 static int is_final_ent(ir_entity *ent) {
106         if (is_entity_final(ent)) {
107                 /* not possible to override this entity. */
108                 return 1;
109         }
110         if (get_opt_closed_world() && get_entity_n_overwrittenby(ent) == 0) {
111                 /* we have a closed world, so simply check how often it was
112                 overridden. */
113                 return 1;
114         }
115         return 0;
116 }
117
118 /*
119  * Transform Sel[method] to SymC[method] if possible.
120  */
121 ir_node *transform_node_Sel(ir_node *node) {
122         ir_node   *new_node, *ptr;
123         ir_type   *dyn_tp;
124         ir_entity *ent = get_Sel_entity(node);
125
126         if (get_irp_phase_state() == phase_building) return node;
127
128         if (!(get_opt_optimize() && get_opt_dyn_meth_dispatch()))
129                 return node;
130
131         if (!is_Method_type(get_entity_type(ent)))
132                 return node;
133
134         /* If the entity is a leave in the inheritance tree,
135            we can replace the Sel by a constant. */
136         if (is_final_ent(ent)) {
137                 /* In dead code, we might call a leave entity that is a description.
138                    Do not turn the Sel to a SymConst. */
139                 if (get_entity_peculiarity(ent) == peculiarity_description) {
140                         /* We could remove the Call depending on this Sel. */
141                         new_node = node;
142                 } else {
143                         ir_node *rem_block = get_cur_block();
144                         set_cur_block(get_nodes_block(node));
145                         new_node = copy_const_value(get_irn_dbg_info(node), get_atomic_ent_value(ent));
146                         set_cur_block(rem_block);
147                         DBG_OPT_POLY(node, new_node);
148                 }
149                 return new_node;
150         }
151
152         /* If we know the dynamic type, we can replace the Sel by a constant. */
153         ptr = get_Sel_ptr(node);      /* The address we select from. */
154         dyn_tp = get_dynamic_type(ptr);  /* The runtime type of ptr. */
155
156         if (dyn_tp != firm_unknown_type) {
157                 ir_entity *called_ent;
158                 ir_node *rem_block;
159
160                 /* We know which method will be called, no dispatch necessary. */
161                 called_ent = resolve_ent_polymorphy(dyn_tp, ent);
162                 /* called_ent may not be description: has no Address/Const to Call! */
163                 assert(get_entity_peculiarity(called_ent) != peculiarity_description);
164
165                 rem_block = get_cur_block();
166                 set_cur_block(get_nodes_block(node));
167                 new_node = copy_const_value(get_irn_dbg_info(node), get_atomic_ent_value(called_ent));
168                 set_cur_block(rem_block);
169                 DBG_OPT_POLY(node, new_node);
170
171                 return new_node;
172         }
173
174         return node;
175 }
176
177 /* Transform  Load(Sel(Alloc)[constant static entity])
178  *  to Const[constant static entity value].
179  *
180  *  This function returns a node replacing the Proj(Load)[Value].
181  *  If this is actually called in transform_node, we must build
182  *  a tuple, or replace the Projs of the load.
183  *  Therefore we call this optimization in ldstopt().
184  */
185 ir_node *transform_polymorph_Load(ir_node *load) {
186         ir_node *new_node = NULL;
187         ir_node *field_ptr, *ptr;
188         ir_entity *ent;
189         ir_type *dyn_tp;
190
191         if (!(get_opt_optimize() && get_opt_dyn_meth_dispatch()))
192                 return load;
193
194         field_ptr = get_Load_ptr(load);
195
196         if (! is_Sel(field_ptr)) return load;
197
198         ent = get_Sel_entity(field_ptr);
199         if ((get_entity_allocation(ent) != allocation_static)    ||
200                 (get_entity_variability(ent) != variability_constant)  )
201                 return load;
202
203         /* If the entity is a leave in the inheritance tree,
204            we can replace the Sel by a constant. */
205         if ((get_irp_phase_state() != phase_building) && is_final_ent(ent)) {
206                 new_node = get_atomic_ent_value(ent);
207         } else {
208                 /* If we know the dynamic type, we can replace the Sel by a constant. */
209                 ptr = get_Sel_ptr(field_ptr);    /* The address we select from. */
210                 dyn_tp = get_dynamic_type(ptr);  /* The runtime type of ptr. */
211
212                 if (dyn_tp != firm_unknown_type) {
213                         ir_entity *loaded_ent;
214
215                         /* We know which method will be called, no dispatch necessary. */
216                         loaded_ent = resolve_ent_polymorphy(dyn_tp, ent);
217                         /* called_ent may not be description: has no Address/Const to Call! */
218                         assert(get_entity_peculiarity(loaded_ent) != peculiarity_description);
219                         new_node = get_atomic_ent_value(loaded_ent);
220                 }
221         }
222         if (new_node != NULL) {
223                 new_node = can_replace_load_by_const(load, new_node);
224                 if (new_node != NULL) {
225                         DBG_OPT_POLY(field_ptr, new_node);
226
227                         return new_node;
228                 }
229         }
230         return load;
231 }