some typos fixed
[libfirm] / ir / ana / analyze_irg_args.c
1 /*
2  * Project:     libFIRM
3  * File name:   ir/ana/analyze_irg_agrs.c
4  * Purpose:     read/write analyze of graph argument, which have mode reference.
5  * Author:      Beyhan Veliev
6  * Created:
7  * CVS-ID:      $Id$
8  * Copyright:   (c) 1998-2005 Universität Karlsruhe
9  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
10  */
11
12 /**
13  * @file analyze_irg_agrs.c
14  *
15  */
16 #ifdef HAVE_CONFIG_H
17 #include "config.h"
18 #endif
19
20 #ifdef HAVE_MALLOC_H
21 # include <malloc.h>
22 #endif
23 #ifdef HAVE_ALLOCA_H
24 # include <alloca.h>
25 #endif
26 #ifdef HAVE_STDLIB_H
27 # include <stdlib.h>
28 #endif
29
30 #include "irouts.h"
31 #include "irnode_t.h"
32 #include "irmode_t.h"
33 #include "array.h"
34 #include "irprog.h"
35 #include "entity_t.h"
36
37 #include "analyze_irg_args.h"
38
39 static char v;
40 static void *VISITED = &v;
41
42 /**
43  * Walk recursive the successors of a graph argument
44  * with mode reference and mark if it will be read,
45  * written or stored.
46  *
47  * @param arg   The graph argument with mode reference,
48  *             that must be checked.
49  */
50 static unsigned analyze_arg(ir_node *arg, unsigned bits)
51 {
52   int i, p;
53   ir_node *succ;
54
55   /* We must visit a node once to avoid endless recursion.*/
56   set_irn_link(arg, VISITED);
57
58   for (i = get_irn_n_outs(arg) - 1; i >= 0; --i) {
59     succ = get_irn_out(arg, i);
60
61     /* We was here.*/
62     if (get_irn_link(succ) == VISITED)
63       continue;
64
65     /* We should not walk over the memory edge.*/
66     if (get_irn_mode(succ) == mode_M)
67       continue;
68
69     /* If we reach with the recursion a Call node and our reference
70        isn't the address of this Call we accept that the reference will
71        be read and written if the graph of the method represented by
72        "Call" isn't computed else we analyze that graph. If our
73        reference is the address of this
74        Call node that mean the reference will be read.*/
75     switch (get_irn_opcode(succ)) {
76
77     case iro_Call: {
78       ir_node *ptr  = get_Call_ptr(succ);
79
80       if (ptr == arg) {
81         /* Hmm: not sure what this is, most likely a read */
82         bits |= ptr_access_read;
83       }
84       else {
85         ir_op *op = get_irn_op(ptr);
86         entity *meth_ent;
87
88         if (op == op_SymConst && get_SymConst_kind(ptr) == symconst_addr_ent) {
89           meth_ent = get_SymConst_entity(ptr);
90
91           for (p = get_Call_n_params(succ) - 1; p >= 0; --p) {
92             if (get_Call_param(succ, p) == arg) {
93               /* an arg can be used more than once ! */
94               bits |= get_method_param_access(meth_ent, p);
95             }
96           }
97         }
98         else if (op == op_Sel && get_irp_callee_info_state() == irg_callee_info_consistent) {
99           /* is be a polymorphic call but callee information is available */
100           int i, n_params = get_Call_n_params(succ);
101
102           /* simply look into ALL possible callees */
103           for (i = get_Call_n_callees(succ) - 1; i >= 0; --i) {
104             meth_ent = get_Call_callee(succ, i);
105
106             /* unknown_entity is used to signal that we don't know what is called */
107             if (meth_ent == unknown_entity) {
108               bits |= ptr_access_all;
109               break;
110             }
111
112             for (p = n_params - 1; p >= 0; --p) {
113               if (get_Call_param(succ, p) == arg) {
114                 /* an arg can be used more than once ! */
115                 bits |= get_method_param_access(meth_ent, p);
116               }
117             }
118           }
119         }
120         else /* can do anything */
121           bits |= ptr_access_all;
122       }
123
124       /* search stops here anyway */
125       continue;
126     }
127     case iro_Store:
128       /* We have reached a Store node => the reference is written or stored. */
129       if (get_Store_ptr(succ) == arg) {
130         /* written to */
131         bits |= ptr_access_write;
132       }
133       else {
134         /* stored itself */
135         bits |= ptr_access_store;
136       }
137
138       /* search stops here anyway */
139       continue;
140
141     case iro_Load:
142       /* We have reached a Load node => the reference is read. */
143       bits |= ptr_access_read;
144
145       /* search stops here anyway */
146       continue;
147
148     case iro_Conv:
149       /* our address is casted into something unknown. Break our search. */
150       bits = ptr_access_all;
151       break;
152
153     default:
154       break;
155     }
156
157     /* If we know that, the argument will be read, write and stored, we
158        can break the recursion.*/
159     if (bits == ptr_access_all) {
160       bits = ptr_access_all;
161       break;
162     }
163
164     /*
165      * A calculation that do not lead to a reference mode ends our search.
166      * This is dangerous: It would allow to cast into integer and that cast back ...
167      * so, when we detect a Conv we go mad, see the Conv case above.
168      */
169     if (!mode_is_reference(get_irn_mode(succ)))
170       continue;
171
172     /* follow further the address calculation */
173     bits = analyze_arg(succ, bits);
174   }
175   set_irn_link(arg, NULL);
176   return bits;
177 }
178
179 /**
180  * Check if a argument of the ir graph with mode
181  * reference is read, write or both.
182  *
183  * @param irg   The ir graph to analyze.
184  */
185 static void analyze_ent_args(entity *ent)
186 {
187   ir_graph *irg;
188   ir_node *irg_args, *arg;
189   ir_mode *arg_mode;
190   int nparams, i;
191   long proj_nr;
192   type *mtp;
193   ptr_access_kind *rw_info;
194
195   mtp     = get_entity_type(ent);
196   nparams = get_method_n_params(mtp);
197
198   ent->param_access = NEW_ARR_F(ptr_access_kind, nparams);
199
200   /* If the method haven't parameters we have
201    * nothing to do.
202    */
203   if (nparams <= 0)
204     return;
205
206   irg = get_entity_irg(ent);
207
208   /* we have not yet analyzed the graph, set ALL access for pointer args */
209   for (i = nparams - 1; i >= 0; --i)
210     ent->param_access[i] =
211       is_Pointer_type(get_method_param_type(mtp, i)) ? ptr_access_all : ptr_access_none;
212
213   if (! irg) {
214     /* no graph, no better info */
215     return;
216   }
217
218   /* Call algorithm that computes the out edges */
219   if (get_irg_outs_state(irg) != outs_consistent)
220     compute_irg_outs(irg);
221
222   irg_args = get_irg_args(irg);
223
224   /* A array to save the information for each argument with
225      mode reference.*/
226   NEW_ARR_A(ptr_access_kind, rw_info, nparams);
227
228   /* We initialize the element with none state. */
229   for (i = nparams - 1; i >= 0; --i)
230     rw_info[i] = ptr_access_none;
231
232   /* search for arguments with mode reference
233      to analyze them.*/
234   for (i = get_irn_n_outs(irg_args) - 1; i >= 0; --i) {
235     arg      = get_irn_out(irg_args, i);
236     arg_mode = get_irn_mode(arg);
237     proj_nr  = get_Proj_proj(arg);
238
239     if (mode_is_reference(arg_mode))
240       rw_info[proj_nr] |= analyze_arg(arg, rw_info[proj_nr]);
241   }
242
243   /* copy the temporary info */
244   memcpy(ent->param_access, rw_info, nparams * sizeof(ent->param_access[0]));
245
246   printf("\n%s:\n", get_entity_name(ent));
247   for (i = 0; i < nparams; ++i) {
248     if (is_Pointer_type(get_method_param_type(mtp, i)))
249       if (ent->param_access[i] != ptr_access_none) {
250         printf("  Pointer Arg %d access: ", i);
251         if (ent->param_access[i] & ptr_access_read)
252           printf("READ ");
253         if (ent->param_access[i] & ptr_access_write)
254           printf("WRITE ");
255         if (ent->param_access[i] & ptr_access_store)
256           printf("STORE ");
257         printf("\n");
258       }
259   }
260 }
261
262 /**
263  * Analyze how pointer arguments of a given
264  * ir graph are accessed.
265  *
266  * @param irg   The ir graph to analyze.
267  */
268 void analyze_irg_args(ir_graph *irg)
269 {
270   entity *ent;
271
272   if (irg == get_const_code_irg())
273     return;
274
275   ent = get_irg_entity(irg);
276   if (! ent)
277     return;
278
279   if (! ent->param_access)
280     analyze_ent_args(ent);
281 }
282
283 /*
284  * Compute for a method with pointer parameter(s)
285  * if they will be read or written.
286  */
287 ptr_access_kind get_method_param_access(entity *ent, int pos)
288 {
289   type *mtp = get_entity_type(ent);
290   int  is_variadic = get_method_variadicity(mtp) == variadicity_variadic;
291
292   assert(0 <= pos && (is_variadic || pos < get_method_n_params(mtp)));
293
294   if (ent->param_access) {
295     if (pos < ARR_LEN(ent->param_access))
296       return ent->param_access[pos];
297     else
298       return ptr_access_all;
299   }
300
301   analyze_ent_args(ent);
302
303   if (pos < ARR_LEN(ent->param_access))
304     return ent->param_access[pos];
305   else
306     return ptr_access_all;
307 }
308
309 enum args_weight {
310   null_weight        = 0,  /**< If can't be anything optimized. */
311   binop_weight       = 1,  /**< If the argument have mode_weight and take part in binop. */
312   const_binop_weight = 1,  /**< If the argument have mode_weight and take part in binop with a constant.*/
313   cmp_weight         = 4,  /**< If the argument take part in cmp. */
314   const_cmp_weight   = 10  /**< If the argument take part in cmp with a constant. */
315 };
316
317 /**
318  * Compute the weight of a method parameter
319  *
320  * @param arg  The parameter them weight muss be computed.
321  */
322 static float calc_method_param_weight(ir_node *arg)
323 {
324   int i;
325   ir_node *succ, *op;
326   float weight = null_weight;
327
328   /* We mark the nodes to avoid endless recursion */
329   set_irn_link(arg, VISITED);
330
331   for (i = get_irn_n_outs(arg) - 1; i >= 0; i--) {
332     succ = get_irn_out(arg, i);
333
334     /* We was here.*/
335     if (get_irn_link(succ) == VISITED)
336       continue;
337
338     /* We should not walk over the memory edge.*/
339     if (get_irn_mode(succ) == mode_M)
340       continue;
341
342     /* We have reached a cmp and we must increase the
343        weight with the cmp_weight.*/
344     if (get_irn_op(succ) == op_Cmp) {
345
346       if (get_Cmp_left(succ) == arg)
347         op = get_Cmp_right(succ);
348       else
349         op = get_Cmp_left(succ);
350
351       if (is_irn_constlike(op)) {
352         weight += const_cmp_weight;
353       }
354       else
355         weight += cmp_weight;
356     }
357     else if (is_binop(succ)) {
358       /* We have reached a binop and we must increase the
359                weight with the binop_weight. If the other operand of the
360                binop is a constant we increase the weight with const_binop_weight
361                and call the function recursive.
362       */
363       if (get_binop_left(succ) == arg)
364               op = get_binop_right(succ);
365       else
366               op = get_binop_left(succ);
367
368       if (is_irn_constlike(op)) {
369               weight += const_binop_weight;
370               weight += calc_method_param_weight(succ);
371       }
372       else
373         weight += binop_weight;
374     } else if (is_unop(succ)) {
375       /* We have reached a binop and we must increase the
376                weight with the const_binop_weight and call the function recursive.*/
377       weight += const_binop_weight;
378       weight += calc_method_param_weight(succ);
379     }
380   }
381   set_irn_link(arg, NULL);
382   return weight;
383 }
384
385 /**
386  * Set a weight for each argument of a ir_graph.
387  * The args with a greater weight are good for optimize.
388  *
389  * @param ent  The entity of the ir_graph.
390  */
391 static void analyze_method_params_weight(entity *ent)
392 {
393   type *mtp;
394   ir_graph *irg;
395   int nparams, i, proj_nr;
396   ir_node *irg_args, *arg;
397
398   mtp      = get_entity_type(ent);
399   nparams  = get_method_n_params(mtp);
400
401   /* allocate a new array. currently used as 'analysed' flag */
402   ent->param_weight = NEW_ARR_F(float, nparams);
403
404   /* If the method haven't parameters we have
405    * nothing to do.
406    */
407   if (nparams <= 0)
408     return;
409
410   irg = get_entity_irg(ent);
411
412   /* First we initialize the parameter weight with 0. */
413   for (i = nparams - 1; i >= 0; i--)
414     ent->param_weight[i] = null_weight;
415
416   if (! irg) {
417     /* no graph, no better info */
418     return;
419   }
420
421   /* Call algorithm that computes the out edges */
422   if (get_irg_outs_state(irg) != outs_consistent)
423     compute_irg_outs(irg);
424
425   irg_args = get_irg_args(irg);
426
427   for (i = get_irn_n_outs(irg_args) - 1; i >= 0; --i) {
428     arg                          = get_irn_out(irg_args, i);
429     proj_nr                      = get_Proj_proj(arg);
430     ent->param_weight[proj_nr]  += calc_method_param_weight(arg);
431   }
432
433 #if 0
434   printf("\n%s:\n", get_entity_name(ent));
435   for (i = nparams - 1; i >= 0; --i)
436     printf("The weight of argument %i is %f \n", i, ent->param_weight[i]);
437 #endif
438 }
439
440 /*
441  * Compute for a method with pointer parameter(s)
442  * if they will be read or written.
443  */
444 float get_method_param_weight(entity *ent, int pos)
445 {
446   type *mtp = get_entity_type(ent);
447   int  is_variadic = get_method_variadicity(mtp) == variadicity_variadic;
448
449   assert(0 <= pos && (is_variadic || pos < get_method_n_params(mtp)));
450
451   if (ent->param_weight) {
452     if (pos < ARR_LEN(ent->param_weight))
453       return ent->param_weight[pos];
454     else
455       return 0.0f;
456   }
457
458   analyze_method_params_weight(ent);
459
460   if (pos < ARR_LEN(ent->param_weight))
461     return ent->param_weight[pos];
462   else
463     return 0.0f;
464 }
465
466
467 /**
468  * Analyze argument's weight of a given
469  * ir graph.
470  *
471  * @param irg The ir graph to analyze.
472  */
473 void analyze_irg_args_weight(ir_graph *irg)
474 {
475   entity *ent;
476
477   ent = get_irg_entity(irg);
478   if (! ent)
479     return;
480
481   if (! ent->param_weight)
482     analyze_method_params_weight(ent);
483 }