comments
[libfirm] / ir / ir / irgraph.c
1 /*
2  * Project:     libFIRM
3  * File name:   ir/ir/irgraph.c
4  * Purpose:     Entry point to the representation of procedure code.
5  * Author:      Martin Trapp, Christian Schaefer
6  * Modified by: Goetz Lindenmaier
7  * Created:
8  * CVS-ID:      $Id$
9  * Copyright:   (c) 1998-2003 Universität Karlsruhe
10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
11  */
12
13 #ifdef HAVE_CONFIG_H
14 # include <config.h>
15 #endif
16
17 # include <string.h>
18
19 # include "ircons.h"
20 # include "irgraph_t.h"
21 # include "irprog_t.h"
22 # include "iropt_t.h"
23 # include "irflag_t.h"
24 # include "array.h"
25 # include "irgmod.h"
26 # include "mangle.h"
27 # include "irouts.h"
28 # include "firmstat.h"
29
30 ir_graph *current_ir_graph;
31 INLINE ir_graph *get_current_ir_graph(void) {
32   return current_ir_graph;
33 }
34 INLINE void set_current_ir_graph(ir_graph *graph) {
35   current_ir_graph = graph;
36 }
37
38
39 bool interprocedural_view = false;
40 INLINE bool get_interprocedural_view(void) {
41   return interprocedural_view;
42 }
43 INLINE void set_interprocedural_view(bool state) {
44   interprocedural_view = state;
45 }
46
47 static ident* frame_type_suffix = NULL;
48 void init_irgraph(void) {
49   frame_type_suffix = id_from_str(FRAME_TP_SUFFIX, strlen(FRAME_TP_SUFFIX));
50 }
51
52 #if USE_EXPLICIT_PHI_IN_STACK
53 /* really defined in ircons.c */
54 typedef struct Phi_in_stack Phi_in_stack;
55 Phi_in_stack *new_Phi_in_stack();
56 void free_Phi_in_stack(Phi_in_stack *s);
57 #endif
58
59 /* Allocates a list of nodes:
60     - The start block containing a start node and Proj nodes for it's four
61       results (X, M, P, Tuple).
62     - The end block containing an end node. This block is not matured after
63       new_ir_graph as predecessors need to be added to it.
64     - The current block, which is empty and also not matured.
65    Further it allocates several datastructures needed for graph construction
66    and optimization.
67 */
68 ir_graph *
69 new_ir_graph (entity *ent, int n_loc)
70 {
71   ir_graph *res;
72   ir_node *first_block;
73   ir_node *projX;
74
75   res = (ir_graph *) malloc (sizeof (ir_graph));
76   memset(res, 0, sizeof (ir_graph));
77   res->kind = k_ir_graph;
78
79   /* inform statistics here, as blocks will be already build on this graph */
80   stat_new_graph(res, ent);
81
82   current_ir_graph = res;
83   add_irp_irg(res);          /* remember this graph global. */
84
85   /*-- initialized for each graph. --*/
86   if (get_opt_precise_exc_context()) {
87     res->n_loc = n_loc + 1 + 1; /* number of local variables that are never
88                    dereferenced in this graph plus one for
89                    the store plus one for links to fragile
90                    operations.  n_loc is not the number of
91                    parameters to the procedure!  */
92   }
93   else {
94     res->n_loc = n_loc + 1;  /* number of local variables that are never
95                 dereferenced in this graph plus one for
96                 the store. This is not the number of parameters
97                 to the procedure!  */
98   }
99
100   res->visited = 0;     /* visited flag, for the ir walker */
101   res->block_visited = 0; /* visited flag, for the 'block'-walker */
102
103 #if USE_EXPLICIT_PHI_IN_STACK
104   res->Phi_in_stack = new_Phi_in_stack();  /* A stack needed for automatic Phi
105                                 generation */
106 #endif
107   res->kind = k_ir_graph;
108   res->obst      = (struct obstack *) xmalloc (sizeof (struct obstack));
109   obstack_init (res->obst);
110   res->value_table = new_identities (); /* value table for global value
111                        numbering for optimizing use in
112                        iropt.c */
113   res->outs = NULL;
114
115   res->phase_state    = phase_building;
116   res->pinned         = pinned;
117   res->outs_state     = no_outs;
118   res->dom_state      = no_dom;
119   res->typeinfo_state = irg_typeinfo_none;
120   res->loopinfo_state = loopinfo_none;
121
122   /*-- Type information for the procedure of the graph --*/
123   res->ent = ent;
124   set_entity_irg(ent, res);
125
126   /*--  a class type so that it can contain "inner" methods as in Pascal. --*/
127   res->frame_type = new_type_class(mangle(get_entity_ident(ent), frame_type_suffix));
128
129   /* Remove type from type list.  Must be treated differently than other types. */
130   remove_irp_type_from_list(res->frame_type);
131
132   /*-- Nodes needed in every graph --*/
133   res->end_block  = new_immBlock();
134   res->end        = new_End();
135   res->end_reg    = res->end;
136   res->end_except = res->end;
137
138   res->start_block = new_immBlock();
139   res->start   = new_Start();
140   res->bad     = new_ir_node(NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
141   /* res->unknown = new_ir_node (NULL, res, res->start_block, op_Unknown, mode_T, 0, NULL); */
142
143   /* Proj results of start node */
144   projX            = new_Proj (res->start, mode_X, pns_initial_exec);
145   res->frame       = new_Proj (res->start, mode_P_mach, pns_frame_base);
146   res->globals     = new_Proj (res->start, mode_P_mach, pns_globals);
147   res->initial_mem = new_Proj (res->start, mode_M, pns_global_store);
148   res->args        = new_Proj (res->start, mode_T, pns_args);
149 #ifdef DEBUG_libfirm
150   res->graph_nr    = get_irp_new_node_nr();
151 #endif
152
153   set_store(res->initial_mem);
154
155   add_in_edge(res->start_block, projX);
156   /*
157    * The code generation needs it. leave it in now.
158    * Use of this edge is matter of discussion, unresolved. Also possible:
159    * add_in_edge(res->start_block, res->start_block), but invalid typed.
160    */
161   mature_block (res->current_block);
162
163   /*-- Make a block to start with --*/
164   first_block = new_immBlock();
165   add_in_edge (first_block, projX);
166
167   return res;
168 }
169
170
171 /* Make a rudimentary ir graph for the constant code.
172    Must look like a correct irg, spare everything else. */
173 ir_graph *new_const_code_irg(void) {
174   ir_graph *res;
175   ir_node *projX;
176
177   res = (ir_graph *) malloc (sizeof(*res));
178   memset(res, 0, sizeof(*res));
179
180   /* inform statistics here, as blocks will be already build on this graph */
181   stat_new_graph(res, NULL);
182
183   current_ir_graph = res;
184   res->n_loc = 1;      /* Only the memory. */
185   res->visited = 0;     /* visited flag, for the ir walker */
186   res->block_visited=0; /* visited flag, for the 'block'-walker */
187 #if USE_EXPLICIT_PHI_IN_STACK
188   res->Phi_in_stack = NULL;
189 #endif
190   res->kind = k_ir_graph;
191   res->obst      = (struct obstack *) xmalloc (sizeof (struct obstack));
192   obstack_init (res->obst);
193   res->phase_state = phase_building;
194   res->pinned = pinned;
195   res->value_table = new_identities (); /* value table for global value
196                        numbering for optimizing use in
197                        iropt.c */
198   res->ent = NULL;
199   res->frame_type = NULL;
200   res->start_block = new_immBlock ();
201   res->end_block  = new_immBlock ();
202   res->end        = new_End ();
203   res->end_reg    = res->end;
204   res->end_except = res->end;
205   mature_block(get_cur_block());
206   res->bad = new_ir_node (NULL, res, res->start_block, op_Bad, mode_T, 0, NULL);
207   /* res->unknown = new_ir_node (NULL, res, res->start_block, op_Unknown, mode_T, 0, NULL); */
208   res->start   = new_Start ();
209
210   /* Proj results of start node */
211   projX        = new_Proj (res->start, mode_X, pns_initial_exec);
212   add_in_edge(res->start_block, projX);
213   mature_block (res->current_block);
214   add_in_edge (new_immBlock (), projX);
215   mature_block(get_cur_block());
216   /* Set the visited flag high enough that the block will never be visited. */
217   set_irn_visited(get_cur_block(), -1);
218   set_Block_block_visited(get_cur_block(), -1);
219   set_Block_block_visited(res->start_block, -1);
220   set_irn_visited(res->start_block, -1);
221   set_irn_visited(res->bad, -1);
222   return res;
223 }
224
225 /* Defined in iropt.c */
226 void  del_identities (pset *value_table);
227
228 /* Frees the passed irgraph.
229    Deallocates all nodes in this graph and the ir_graph structure.
230    Sets the field irgraph in the corresponding entity to NULL.
231    Does not remove the irgraph from the list in irprog (requires
232    inefficient search, call remove_irp_irg by hand).
233    Does not free types, entities or modes that are used only by this
234    graph, nor the entity standing for this graph. */
235 void free_ir_graph (ir_graph *irg) {
236   stat_free_graph(irg);
237   if (irg->outs_state != no_outs) free_outs(irg);
238   if (irg->frame_type)  free_type(irg->frame_type);
239   if (irg->value_table) del_identities(irg->value_table);
240   if (irg->ent) {
241     peculiarity pec = get_entity_peculiarity (irg->ent);
242     set_entity_peculiarity (irg->ent, peculiarity_description);
243     set_entity_irg(irg->ent, NULL);  /* not set in const code irg */
244     set_entity_peculiarity (irg->ent, pec);
245   }
246
247   free_End(irg->end);
248   obstack_free(irg->obst,NULL);
249   free(irg->obst);
250 #if USE_EXPLICIT_PHI_IN_STACK
251   free_Phi_in_stack(irg->Phi_in_stack);
252 #endif
253   irg->kind = k_BAD;
254   free(irg);
255 }
256
257 /* access routines for all ir_graph attributes:
258    templates:
259    {attr type} get_irg_{attribute name} (ir_graph *irg);
260    void set_irg_{attr name} (ir_graph *irg, {attr type} {attr}); */
261
262 int
263 (is_ir_graph)(void *thing) {
264   return __is_ir_graph(thing);
265 }
266
267 /* Outputs a unique number for this node */
268
269 INLINE long
270 get_irg_graph_nr(ir_graph *irg) {
271   assert(irg);
272 #ifdef DEBUG_libfirm
273   return irg->graph_nr;
274 #else
275   return (long)irg;
276 #endif
277 }
278
279 ir_node *
280 (get_irg_start_block)(ir_graph *irg) {
281   return __get_irg_start_block(irg);
282 }
283
284 void
285 (set_irg_start_block)(ir_graph *irg, ir_node *node) {
286   __set_irg_start_block(irg, node);
287 }
288
289 ir_node *
290 (get_irg_start)(ir_graph *irg) {
291   return __get_irg_start(irg);
292 }
293
294 void
295 (set_irg_start)(ir_graph *irg, ir_node *node) {
296   __set_irg_start(irg, node);
297 }
298
299 ir_node *
300 (get_irg_end_block)(ir_graph *irg) {
301   return __get_irg_end_block(irg);
302 }
303
304 void
305 (set_irg_end_block)(ir_graph *irg, ir_node *node) {
306   __set_irg_end_block(irg, node);
307 }
308
309 ir_node *
310 (get_irg_end)(ir_graph *irg) {
311   return __get_irg_end(irg);
312 }
313
314 void
315 (set_irg_end)(ir_graph *irg, ir_node *node) {
316   __set_irg_end(irg, node);
317 }
318
319 ir_node *
320 (get_irg_end_reg)(ir_graph *irg) {
321   return __get_irg_end_reg(irg);
322 }
323
324 void     set_irg_end_reg (ir_graph *irg, ir_node *node) {
325   assert(get_irn_op(node) == op_EndReg || get_irn_op(node) == op_End);
326   irg->end_reg = node;
327 }
328
329 ir_node *
330 (get_irg_end_except)(ir_graph *irg) {
331   return __get_irg_end_except(irg);
332 }
333
334 void     set_irg_end_except (ir_graph *irg, ir_node *node) {
335   assert(get_irn_op(node) == op_EndExcept || get_irn_op(node) == op_End);
336   irg->end_except = node;
337 }
338
339 ir_node *
340 (get_irg_cstore)(ir_graph *irg) {
341   return __get_irg_cstore(irg);
342 }
343
344 void
345 (set_irg_cstore)(ir_graph *irg, ir_node *node) {
346   __set_irg_cstore(irg, node);
347 }
348
349 ir_node *
350 (get_irg_frame)(ir_graph *irg) {
351   return __get_irg_frame(irg);
352 }
353
354 void
355 (set_irg_frame)(ir_graph *irg, ir_node *node) {
356   __set_irg_frame(irg, node);
357 }
358
359 ir_node *
360 (get_irg_globals)(ir_graph *irg) {
361   return __get_irg_globals(irg);
362 }
363
364 void
365 (set_irg_globals)(ir_graph *irg, ir_node *node) {
366   __set_irg_globals(irg, node);
367 }
368
369 ir_node *
370 (get_irg_initial_mem)(ir_graph *irg)
371 {
372   return __get_irg_initial_mem(irg);
373 }
374
375 void
376 (set_irg_initial_mem)(ir_graph *irg, ir_node *node) {
377   __set_irg_initial_mem(irg, node);
378 }
379
380 ir_node *
381 (get_irg_args)(ir_graph *irg) {
382   return __get_irg_args(irg);
383 }
384
385 void
386 (set_irg_args)(ir_graph *irg, ir_node *node) {
387   __set_irg_args(irg, node);
388 }
389
390 ir_node *
391 (get_irg_bad)(ir_graph *irg) {
392   return __get_irg_bad(irg);
393 }
394
395 void
396 (set_irg_bad)(ir_graph *irg, ir_node *node) {
397   __set_irg_bad(irg, node);
398 }
399
400 /* GL removed: we need unknown with mode for analyses.
401 ir_node *
402 get_irg_unknown (ir_graph *irg)
403 {
404   return irg->unknown;
405 }
406
407 void
408 set_irg_unknown (ir_graph *irg, ir_node *node)
409 {
410   irg->unknown = node;
411 }
412 */
413
414 ir_node *
415 (get_irg_current_block)(ir_graph *irg) {
416   return __get_irg_current_block(irg);
417 }
418
419 void
420 (set_irg_current_block)(ir_graph *irg, ir_node *node) {
421   __set_irg_current_block(irg, node);
422 }
423
424 entity *
425 (get_irg_ent)(ir_graph *irg) {
426   return __get_irg_ent(irg);
427 }
428
429 void
430 (set_irg_ent)(ir_graph *irg, entity *ent) {
431   __set_irg_ent(irg, ent);
432 }
433
434 type *
435 (get_irg_frame_type)(ir_graph *irg) {
436   return __get_irg_frame_type(irg);
437 }
438
439 void
440 (set_irg_frame_type)(ir_graph *irg, type *ftp) {
441   __set_irg_frame_type(irg, ftp);
442 }
443
444
445 /* To test for a frame type */
446 int
447 is_frame_type(type *ftp) {
448   int i;
449   if (is_class_type(ftp)) {
450     for (i = 0; i < get_irp_n_irgs(); i++) {
451       type *frame_tp = get_irg_frame_type(get_irp_irg(i));
452       if (ftp == frame_tp) return true;
453     }
454   }
455   return false;
456 }
457
458 int
459 get_irg_n_locs (ir_graph *irg)
460 {
461   if (get_opt_precise_exc_context())
462     return irg->n_loc - 1 - 1;
463   else
464     return irg->n_loc - 1;
465 }
466
467 void
468 set_irg_n_loc (ir_graph *irg, int n_loc)
469 {
470   if (get_opt_precise_exc_context())
471     irg->n_loc = n_loc + 1 + 1;
472   else
473     irg->n_loc = n_loc + 1;
474 }
475
476
477
478 /* Returns the obstack associated with the graph. */
479 struct obstack *
480 (get_irg_obstack)(ir_graph *irg) {
481   return __get_irg_obstack(irg);
482 }
483
484 /*
485  * Returns true if the node n is allocated on the storage of graph irg.
486  *
487  * Implementation is GLIBC specific as is uses the internal _obstack_chunk implementation.
488  */
489 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n)
490 {
491   struct _obstack_chunk *p;
492
493   /*
494    * checks wheater the ir_node pointer i on the obstack.
495    * A more sophisticated check would test the "whole" ir_node
496    */
497   for (p = irg->obst->chunk; p; p = p->prev) {
498     if (((char *)p->contents <= (char *)n) && ((char *)n < (char *)p->limit))
499       return 1;
500   }
501
502   return 0;
503 }
504
505 irg_phase_state
506 (get_irg_phase_state)(ir_graph *irg) {
507   return __get_irg_phase_state(irg);
508 }
509
510 void
511 (set_irg_phase_low)(ir_graph *irg) {
512   __set_irg_phase_low(irg);
513 }
514
515 op_pinned
516 (get_irg_pinned)(ir_graph *irg) {
517   return __get_irg_pinned(irg);
518 }
519
520 irg_outs_state
521 (get_irg_outs_state)(ir_graph *irg) {
522   return __get_irg_outs_state(irg);
523 }
524
525 void
526 (set_irg_outs_inconsistent)(ir_graph *irg) {
527   __set_irg_outs_inconsistent(irg);
528 }
529
530 irg_dom_state
531 (get_irg_dom_state)(ir_graph *irg) {
532   return __get_irg_dom_state(irg);
533 }
534
535 void
536 (set_irg_dom_inconsistent)(ir_graph *irg) {
537   __set_irg_dom_inconsistent(irg);
538 }
539
540 irg_loopinfo_state
541 (get_irg_loopinfo_state)(ir_graph *irg) {
542   return __get_irg_loopinfo_state(irg);
543 }
544
545 void
546 (set_irg_loopinfo_state)(ir_graph *irg, irg_loopinfo_state s) {
547   __set_irg_loopinfo_state(irg, s);
548 }
549
550 void
551 set_irg_loopinfo_inconsistent(ir_graph *irg) {
552   if (irg->loopinfo_state == loopinfo_ip_consistent)
553     irg->loopinfo_state = loopinfo_ip_inconsistent;
554
555   else if (irg->loopinfo_state == loopinfo_consistent)
556     irg->loopinfo_state = loopinfo_inconsistent;
557
558   else if (irg->loopinfo_state == loopinfo_cf_ip_consistent)
559     irg->loopinfo_state = loopinfo_cf_ip_inconsistent;
560
561   else if (irg->loopinfo_state == loopinfo_cf_consistent)
562     irg->loopinfo_state = loopinfo_cf_inconsistent;
563 }
564
565 void
566 (set_irg_pinned)(ir_graph *irg, op_pinned p) {
567   __set_irg_pinned(irg, p);
568 }
569
570 irg_callee_info_state
571 (get_irg_callee_info_state)(ir_graph *irg) {
572   return __get_irg_callee_info_state(irg);
573 }
574
575 void
576 (set_irg_callee_info_state)(ir_graph *irg, irg_callee_info_state s) {
577   __set_irg_callee_info_state(irg, s);
578 }
579
580 irg_inline_property
581 (get_irg_inline_property)(ir_graph *irg) {
582   return __get_irg_inline_property(irg);
583 }
584
585 void
586 (set_irg_inline_property)(ir_graph *irg, irg_inline_property s) {
587   __set_irg_inline_property(irg, s);
588 }
589
590 void
591 (set_irg_link)(ir_graph *irg, void *thing) {
592   __set_irg_link(irg, thing);
593 }
594
595 void *
596 (get_irg_link)(ir_graph *irg) {
597   return __get_irg_link(irg);
598 }
599
600 /* maximum visited flag content of all ir_graph visited fields. */
601 static int max_irg_visited = 0;
602
603 unsigned long
604 (get_irg_visited)(ir_graph *irg) {
605   return __get_irg_visited(irg);
606 }
607
608 void
609 set_irg_visited (ir_graph *irg, unsigned long visited)
610 {
611   irg->visited = visited;
612   if (irg->visited > max_irg_visited) {
613     max_irg_visited = irg->visited;
614   }
615 }
616
617 void
618 inc_irg_visited (ir_graph *irg)
619 {
620   if (++irg->visited > max_irg_visited) {
621     max_irg_visited = irg->visited;
622   }
623 }
624
625 unsigned long
626 get_max_irg_visited(void)
627 {
628   /*
629   int i;
630   for(i = 0; i < get_irp_n_irgs(); i++)
631   assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
632    */
633   return max_irg_visited;
634 }
635
636 void set_max_irg_visited(int val) {
637   max_irg_visited = val;
638 }
639
640 unsigned long
641 inc_max_irg_visited(void)
642 {
643   /*
644   int i;
645   for(i = 0; i < get_irp_n_irgs(); i++)
646   assert(max_irg_visited >= get_irg_visited(get_irp_irg(i)));
647   */
648   max_irg_visited++;
649   return max_irg_visited;
650 }
651
652 unsigned long
653 (get_irg_block_visited)(ir_graph *irg) {
654   return __get_irg_block_visited(irg);
655 }
656
657 void
658 (set_irg_block_visited)(ir_graph *irg, unsigned long visited) {
659   __set_irg_block_visited(irg, visited);
660 }
661
662 void
663 (inc_irg_block_visited)(ir_graph *irg) {
664   __inc_irg_block_visited(irg);
665 }