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