merge similar Load von non-null address optimisations and make it a localopt only
[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  * @brief
26  *  This file subsumes optimization code from cgana.
27  */
28 #include "config.h"
29
30 #include "iroptimize.h"
31 #include "irprog_t.h"
32 #include "entity_t.h"
33 #include "type_t.h"
34 #include "irop.h"
35 #include "irnode_t.h"
36 #include "ircons.h"
37
38 #include "iropt_dbg.h"
39 #include "irflag_t.h"
40
41 /**
42  * Checks if a graph allocates new memory and returns the
43  * type of the newly allocated entity.
44  * Returns NULL if the graph did not represent an Allocation.
45  *
46  * The default implementation hecks for Alloc nodes only.
47  */
48 ir_type *default_firm_get_Alloc(ir_node *n)
49 {
50         n = skip_Proj(n);
51         if (is_Alloc(n)) {
52                 return get_Alloc_type(n);
53         }
54         return NULL;
55 }
56
57 /** The get_Alloc function */
58 static get_Alloc_func firm_get_Alloc = default_firm_get_Alloc;
59
60 /** Set a new get_Alloc_func and returns the old one. */
61 get_Alloc_func firm_set_Alloc_func(get_Alloc_func newf)
62 {
63         get_Alloc_func old = firm_get_Alloc;
64         firm_get_Alloc = newf;
65         return old;
66 }
67
68 /** Return dynamic type of ptr.
69  *
70  * If we can deduct the dynamic type from the firm nodes
71  * by a limited test we return the dynamic type.  Else
72  * we return unknown_type.
73  *
74  * If we find a dynamic type this means that the pointer always points
75  * to an object of this type during runtime.   We resolved polymorphy.
76  */
77 static ir_type *get_dynamic_type(ir_node *ptr)
78 {
79         ir_type *tp;
80
81         /* skip Cast and Confirm nodes */
82         for (;;) {
83                 ir_opcode code = get_irn_opcode(ptr);
84
85                 switch (code) {
86                 case iro_Cast:
87                         ptr = get_Cast_op(ptr);
88                         continue;
89                 case iro_Confirm:
90                         ptr = get_Confirm_value(ptr);
91                         continue;
92                 default:
93                         ;
94                 }
95                 break;
96         }
97         tp = (*firm_get_Alloc)(ptr);
98         return tp ? tp : firm_unknown_type;
99 }
100
101 /**
102  * Check, if an entity is final, i.e. is not anymore overridden.
103  */
104 static int is_final_ent(ir_entity *ent)
105 {
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 {
123         ir_node   *new_node, *ptr;
124         ir_type   *dyn_tp;
125         ir_entity *ent = get_Sel_entity(node);
126
127         if (get_irp_phase_state() == phase_building) return node;
128
129         if (!(get_opt_optimize() && get_opt_dyn_meth_dispatch()))
130                 return node;
131
132         if (!is_Method_type(get_entity_type(ent)))
133                 return node;
134
135         /* If the entity is a leave in the inheritance tree,
136            we can replace the Sel by a constant. */
137         if (is_final_ent(ent)) {
138                 /* In dead code, we might call a leave entity that is a description.
139                    Do not turn the Sel to a SymConst. */
140                 if (get_entity_peculiarity(ent) == peculiarity_description) {
141                         /* We could remove the Call depending on this Sel. */
142                         new_node = node;
143                 } else {
144                         ir_node *rem_block = get_cur_block();
145                         set_cur_block(get_nodes_block(node));
146                         new_node = copy_const_value(get_irn_dbg_info(node), get_atomic_ent_value(ent));
147                         set_cur_block(rem_block);
148                         DBG_OPT_POLY(node, new_node);
149                 }
150                 return new_node;
151         }
152
153         /* If we know the dynamic type, we can replace the Sel by a constant. */
154         ptr = get_Sel_ptr(node);      /* The address we select from. */
155         dyn_tp = get_dynamic_type(ptr);  /* The runtime type of ptr. */
156
157         if (dyn_tp != firm_unknown_type) {
158                 ir_entity *called_ent;
159                 ir_node *rem_block;
160
161                 /* We know which method will be called, no dispatch necessary. */
162                 called_ent = resolve_ent_polymorphy(dyn_tp, ent);
163
164                 rem_block = get_cur_block();
165                 set_cur_block(get_nodes_block(node));
166                 new_node = copy_const_value(get_irn_dbg_info(node), get_atomic_ent_value(called_ent));
167                 set_cur_block(rem_block);
168                 DBG_OPT_POLY(node, new_node);
169
170                 return new_node;
171         }
172
173         return node;
174 }
175
176 /* Transform  Load(Sel(Alloc)[constant static entity])
177  *  to Const[constant static entity value].
178  *
179  *  This function returns a node replacing the Proj(Load)[Value].
180  *  If this is actually called in transform_node, we must build
181  *  a tuple, or replace the Projs of the load.
182  *  Therefore we call this optimization in ldstopt().
183  */
184 ir_node *transform_polymorph_Load(ir_node *load)
185 {
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_linkage(ent) & IR_LINKAGE_CONSTANT) )
200                 return load;
201
202         /* If the entity is a leave in the inheritance tree,
203            we can replace the Sel by a constant. */
204         if ((get_irp_phase_state() != phase_building) && is_final_ent(ent)) {
205                 new_node = get_atomic_ent_value(ent);
206         } else {
207                 /* If we know the dynamic type, we can replace the Sel by a constant. */
208                 ptr = get_Sel_ptr(field_ptr);    /* The address we select from. */
209                 dyn_tp = get_dynamic_type(ptr);  /* The runtime type of ptr. */
210
211                 if (dyn_tp != firm_unknown_type) {
212                         ir_entity *loaded_ent;
213
214                         /* We know which method will be called, no dispatch necessary. */
215                         loaded_ent = resolve_ent_polymorphy(dyn_tp, ent);
216                         new_node = get_atomic_ent_value(loaded_ent);
217                 }
218         }
219         if (new_node != NULL) {
220                 new_node = can_replace_load_by_const(load, new_node);
221                 if (new_node != NULL) {
222                         DBG_OPT_POLY(field_ptr, new_node);
223
224                         return new_node;
225                 }
226         }
227         return load;
228 }