Added index -> node map to irgs
[libfirm] / ir / ir / irgraph_t.h
1 /*
2  * Project:     libFIRM
3  * File name:   ir/ir/irgraph.c
4  * Purpose:     Entry point to the representation of procedure code -- internal header.
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 /**
14  * @file irgraph_t.h
15  *
16  * ir graph construction.
17  *
18  * @author Martin Trapp, Christian Schaefer
19  */
20
21
22 #ifndef _IRGRAPH_T_H_
23 #define _IRGRAPH_T_H_
24
25 #include "firm_types.h"
26 #include "irgraph.h"
27
28 #include "firm_common_t.h"
29 #include "irtypeinfo.h"
30 #include "irprog.h"
31 #include "pseudo_irg.h"
32 #include "type_t.h"
33 #include "entity_t.h"
34 #include "typegmod.h"
35 #include "tr_inheritance.h"
36
37 #include "irloop.h"
38 #include "execution_frequency.h"
39
40 #include "obst.h"
41 #include "pset.h"
42 #include "set.h"
43
44 #define FRAME_TP_SUFFIX "frame_tp"
45
46 /**
47  * Edge info to put into an irg.
48  */
49 typedef struct _irg_edge_info_t {
50         set *edges;
51         unsigned activated : 1;
52 } irg_edge_info_t;
53
54 /**
55  * Index constants for nodes that can be accessed through the graph itself.
56  */
57 enum irg_anchors {
58   anchor_start_block = 0, /**< block the start node will belong to */
59   anchor_start,           /**< start node of this ir_graph */
60   anchor_end_block,       /**< block the end node will belong to */
61   anchor_end,             /**< end node of this ir_graph */
62   anchor_end_reg,         /**< end node of this ir_graph */
63   anchor_end_except,      /**< end node of this ir_graph */
64   anchor_frame,           /**< method's frame */
65   anchor_globals,         /**< pointer to the data segment containing all
66                                globals as well as global procedures. */
67   anchor_initial_mem,     /**< initial memory of this graph */
68   anchor_args,            /**< methods arguments */
69   anchor_bad,             /**< bad node of this ir_graph, the one and
70                                only in this graph */
71   anchor_no_mem,          /**< NoMem node of this ir_graph, the one and only in this graph */
72   anchor_max
73 };
74
75 /** ir_graph holds all information for a procedure */
76 struct ir_graph {
77   firm_kind         kind;            /**<  always set to k_ir_graph*/
78   /* --  Basics of the representation -- */
79   entity  *ent;           /**< The entity of this procedure, i.e.,
80                     the type of the procedure and the
81                     class it belongs to. */
82   ir_type *frame_type;           /**< A class type representing the stack frame.
83                                       Can include "inner" methods. */
84   ir_node *anchors[anchor_max];  /**< anchor nodes */
85   ir_node **proj_args;           /**< projs of the methods arguments */
86   struct obstack *obst;          /**< obstack where all of the ir_nodes live */
87   ir_node *current_block;        /**< block for newly gen_*()-erated ir_nodes */
88   struct obstack *extbb_obst;    /**< obstack for extended basic block info */
89
90   unsigned last_node_idx;        /**< last IR node index for this graph */
91
92   /* -- Fields for graph properties -- */
93   irg_inline_property inline_property;     /**< How to handle inlineing. */
94   unsigned additional_properties;          /**< additional graph properties. */
95
96   /* -- Fields indicating different states of irgraph -- */
97   irg_phase_state phase_state;       /**< compiler phase */
98   op_pin_state irg_pinned_state;     /**< Flag for status of nodes */
99   irg_outs_state outs_state;         /**< Out edges. */
100   irg_dom_state dom_state;           /**< Dominator state information */
101   irg_dom_state pdom_state;          /**< Post Dominator state information */
102   ir_typeinfo_state typeinfo_state;        /**< Validity of type information */
103   irg_callee_info_state callee_info_state; /**< Validity of callee information */
104   irg_loopinfo_state loopinfo_state;       /**< state of loop information */
105   exec_freq_state   execfreq_state;        /**< state of execution frequency information */
106   ir_class_cast_state class_cast_state;    /**< kind of cast operations in code. */
107   irg_extblk_info_state extblk_state;      /**< state of extended basic block info */
108
109   /* -- Fields for construction -- */
110 #if USE_EXPLICIT_PHI_IN_STACK
111   struct Phi_in_stack *Phi_in_stack; /**< needed for automatic Phi construction */
112 #endif
113   int n_loc;                         /**< number of local variable in this
114                                           procedure including procedure parameters. */
115   void **loc_descriptions;           /**< storage for local variable descriptions */
116
117   /* -- Fields for optimizations / analysis information -- */
118   pset *value_table;                 /**< hash table for global value numbering (cse)
119                     for optimizing use in iropt.c */
120   ir_node **outs;                    /**< Space for the out arrays. */
121
122   ir_loop *loop;                     /**< The outermost loop */
123   void *link;                        /**< A void* field to link any information to
124                     the node. */
125
126   ir_graph **callers;                /**< For callgraph analysis. */
127   unsigned char *caller_isbe;        /**< For callgraph analysis: set if backedge. */
128   ir_graph **callees;                /**< For callgraph analysis. */
129   unsigned char *callee_isbe;        /**< For callgraph analysis: set if backedge. */
130   int        callgraph_loop_depth;         /**< For callgraph analysis */
131   int        callgraph_recursion_depth;    /**< For callgraph analysis */
132   double     method_execution_frequency;   /**< For callgraph analysis */
133
134   ir_loop   *l;
135
136   /* -- Fields for Walking the graph -- */
137   unsigned long visited;             /**< this flag is an identifier for
138                     ir walk. it will be incremented
139                     every time someone walks through
140                     the graph */
141   unsigned long block_visited;       /**< same as visited, for a complete block */
142   unsigned estimated_node_count;     /**< estimated number of nodes in this graph,
143                                           updated after every walk */
144   irg_edge_info_t edge_info;         /**< edge info for automatic outs */
145   ir_node **idx_irn_map;             /**< Array mapping node indexes to nodes. */
146
147 #ifdef DEBUG_libfirm
148   int             n_outs;            /**< Size wasted for outs */
149   long graph_nr;              /**< a unique graph number for each graph to make output
150                    readable. */
151 #endif
152
153 };
154
155 /**
156  * Initializes the graph construction module
157  */
158 void firm_init_irgraph(void);
159
160 /* Internal constructor that does not add to irp_irgs or the like. */
161 ir_graph *new_r_ir_graph (entity *ent, int n_loc);
162
163 /** Make a rudimentary ir graph for the constant code.
164    Must look like a correct irg, spare everything else. */
165 ir_graph *new_const_code_irg(void);
166
167 /**
168  * Set the op_pin_state_pinned state of a graph.
169  *
170  * @param irg     the IR graph
171  * @param p       new pin state
172  */
173 INLINE void
174 set_irg_pinned (ir_graph *irg, op_pin_state p);
175
176 /** Returns the obstack associated with the graph. */
177 struct obstack *get_irg_obstack(const ir_graph *irg);
178
179 /**
180  * Returns true if the node n is allocated on the storage of graph irg.
181  *
182  * @param irg   the IR graph
183  * @param n the IR node
184  */
185 int node_is_in_irgs_storage(ir_graph *irg, ir_node *n);
186
187 /*-------------------------------------------------------------------*/
188 /* inline functions for graphs                                       */
189 /*-------------------------------------------------------------------*/
190
191 extern int firm_interprocedural_view;
192
193 static INLINE int
194 _get_interprocedural_view(void) {
195   return firm_interprocedural_view;
196 }
197
198 static INLINE int
199 _is_ir_graph(const void *thing) {
200   return (get_kind(thing) == k_ir_graph);
201 }
202
203 /** Returns the start block of a graph. */
204 static INLINE ir_node *
205 _get_irg_start_block(const ir_graph *irg) {
206   return irg->anchors[anchor_start_block];
207 }
208
209 static INLINE void
210 _set_irg_start_block(ir_graph *irg, ir_node *node) {
211   irg->anchors[anchor_start_block] = node;
212 }
213
214 static INLINE ir_node *
215 _get_irg_start(const ir_graph *irg) {
216   return irg->anchors[anchor_start];
217 }
218
219 static INLINE void
220 _set_irg_start(ir_graph *irg, ir_node *node) {
221   irg->anchors[anchor_start] = node;
222 }
223
224 static INLINE ir_node *
225 _get_irg_end_block(const ir_graph *irg) {
226   return irg->anchors[anchor_end_block];
227 }
228
229 static INLINE void
230 _set_irg_end_block(ir_graph *irg, ir_node *node) {
231   irg->anchors[anchor_end_block] = node;
232 }
233
234 static INLINE ir_node *
235 _get_irg_end(const ir_graph *irg) {
236   return irg->anchors[anchor_end];
237 }
238
239 static INLINE void
240 _set_irg_end(ir_graph *irg, ir_node *node) {
241   irg->anchors[anchor_end] = node;
242 }
243
244 static INLINE ir_node *
245 _get_irg_end_reg(const ir_graph *irg) {
246   return irg->anchors[anchor_end_reg];
247 }
248
249 static INLINE ir_node *
250 _get_irg_end_except (const ir_graph *irg) {
251   return irg->anchors[anchor_end_except];
252 }
253
254 static INLINE ir_node *
255 _get_irg_frame(const ir_graph *irg) {
256   return irg->anchors[anchor_frame];
257 }
258
259 static INLINE void
260 _set_irg_frame(ir_graph *irg, ir_node *node) {
261   irg->anchors[anchor_frame] = node;
262 }
263
264 static INLINE ir_node *
265 _get_irg_globals(const ir_graph *irg) {
266   return irg->anchors[anchor_globals];
267 }
268
269 static INLINE void
270 _set_irg_globals(ir_graph *irg, ir_node *node) {
271   irg->anchors[anchor_globals] = node;
272 }
273
274 static INLINE ir_node *
275 _get_irg_initial_mem(const ir_graph *irg) {
276   return irg->anchors[anchor_initial_mem];
277 }
278
279 static INLINE void
280 _set_irg_initial_mem(ir_graph *irg, ir_node *node) {
281   irg->anchors[anchor_initial_mem] = node;
282 }
283
284 static INLINE ir_node *
285 _get_irg_args(const ir_graph *irg) {
286   return irg->anchors[anchor_args];
287 }
288
289 static INLINE void
290 _set_irg_args(ir_graph *irg, ir_node *node) {
291   irg->anchors[anchor_args] = node;
292 }
293
294 static INLINE ir_node **
295 _get_irg_proj_args(const ir_graph *irg) {
296   return irg->proj_args;
297 }
298
299 static INLINE void
300 _set_irg_proj_args(ir_graph *irg, ir_node **nodes) {
301   irg->proj_args = nodes;
302 }
303
304 static INLINE ir_node *
305 _get_irg_bad(const ir_graph *irg) {
306   return irg->anchors[anchor_bad];
307 }
308
309 static INLINE void
310 _set_irg_bad(ir_graph *irg, ir_node *node) {
311   irg->anchors[anchor_bad] = node;
312 }
313
314 static INLINE ir_node *
315 _get_irg_no_mem(const ir_graph *irg) {
316   return irg->anchors[anchor_no_mem];
317 }
318
319 static INLINE void
320 _set_irg_no_mem(ir_graph *irg, ir_node *node) {
321   irg->anchors[anchor_no_mem] = node;
322 }
323 static INLINE ir_node *
324 _get_irg_current_block(const ir_graph *irg) {
325   return irg->current_block;
326 }
327
328 static INLINE void
329 _set_irg_current_block(ir_graph *irg, ir_node *node) {
330   irg->current_block = node;
331 }
332
333 static INLINE entity *
334 _get_irg_entity(const ir_graph *irg) {
335   assert(irg && irg->ent);
336   return irg->ent;
337 }
338
339 static INLINE void
340 _set_irg_entity(ir_graph *irg, entity *ent) {
341   irg->ent = ent;
342 }
343
344 static INLINE ir_type *
345 _get_irg_frame_type(ir_graph *irg) {
346   assert(irg && irg->frame_type);
347   return irg->frame_type = skip_tid(irg->frame_type);
348 }
349
350 static INLINE void
351 _set_irg_frame_type(ir_graph *irg, ir_type *ftp) {
352   assert(is_frame_type(ftp));
353   irg->frame_type = ftp;
354 }
355
356 static INLINE struct obstack *
357 _get_irg_obstack(const ir_graph *irg) {
358   return irg->obst;
359 }
360
361
362 static INLINE irg_phase_state
363 _get_irg_phase_state(const ir_graph *irg) {
364   return irg->phase_state;
365 }
366
367 static INLINE void
368 _set_irg_phase_state(ir_graph *irg, irg_phase_state state) {
369   irg->phase_state = state;
370 }
371
372 static INLINE op_pin_state
373 _get_irg_pinned(const ir_graph *irg) {
374   return irg->irg_pinned_state;
375 }
376
377 static INLINE irg_outs_state
378 _get_irg_outs_state(const ir_graph *irg) {
379   return irg->outs_state;
380 }
381
382 static INLINE void
383 _set_irg_outs_inconsistent(ir_graph *irg) {
384   if (irg->outs_state == outs_consistent)
385     irg->outs_state = outs_inconsistent;
386 }
387
388 static INLINE irg_extblk_state
389 _get_irg_extblk_state(const ir_graph *irg) {
390   return irg->extblk_state;
391 }
392
393 static INLINE void
394 _set_irg_extblk_inconsistent(ir_graph *irg) {
395   if (irg->extblk_state == extblk_valid)
396     irg->extblk_state = extblk_invalid;
397 }
398
399 static INLINE irg_dom_state
400 _get_irg_dom_state(const ir_graph *irg) {
401   return irg->dom_state;
402 }
403
404 static INLINE irg_dom_state
405 _get_irg_postdom_state(const ir_graph *irg) {
406   return irg->pdom_state;
407 }
408
409 static INLINE void
410 _set_irg_doms_inconsistent(ir_graph *irg) {
411   if (irg->dom_state != dom_none)
412     irg->dom_state = dom_inconsistent;
413   if (irg->pdom_state != dom_none)
414     irg->pdom_state = dom_inconsistent;
415 }
416
417 static INLINE irg_loopinfo_state
418 _get_irg_loopinfo_state(const ir_graph *irg) {
419   return irg->loopinfo_state;
420 }
421
422 static INLINE void
423 _set_irg_loopinfo_state(ir_graph *irg, irg_loopinfo_state s) {
424   irg->loopinfo_state = s;
425 }
426
427 static INLINE void
428 _set_irg_loopinfo_inconsistent(ir_graph *irg) {
429   irg->loopinfo_state &= ~loopinfo_valid;
430 }
431
432 static INLINE void
433 _set_irg_pinned(ir_graph *irg, op_pin_state p) {
434   irg->irg_pinned_state = p;
435 }
436
437 static INLINE irg_callee_info_state
438 _get_irg_callee_info_state(const ir_graph *irg) {
439   return irg->callee_info_state;
440 }
441
442 static INLINE void
443 _set_irg_callee_info_state(ir_graph *irg, irg_callee_info_state s) {
444   irg_callee_info_state irp_state = get_irp_callee_info_state();
445
446   irg->callee_info_state = s;
447
448   /* I could compare ... but who knows? */
449   if ((irp_state == irg_callee_info_consistent)  ||
450       ((irp_state == irg_callee_info_inconsistent) && (s == irg_callee_info_none)))
451       set_irp_callee_info_state(s);
452 }
453
454 static INLINE irg_inline_property
455 _get_irg_inline_property(const ir_graph *irg) {
456   return irg->inline_property;
457 }
458
459 static INLINE void
460 _set_irg_inline_property(ir_graph *irg, irg_inline_property s) {
461   irg->inline_property = s;
462 }
463
464 static INLINE unsigned
465 _get_irg_additional_properties(const ir_graph *irg) {
466   if (irg->additional_properties & mtp_property_inherited)
467     return get_method_additional_properties(get_entity_type(irg->ent));
468   return irg->additional_properties;
469 }
470
471 static INLINE void
472 _set_irg_additional_properties(ir_graph *irg, unsigned mask) {
473   /* do not allow to set the mtp_property_inherited flag or
474    * the automatic inheritance of flags will not work */
475   irg->additional_properties = mask & ~mtp_property_inherited;
476 }
477
478 static INLINE void
479 _set_irg_additional_property(ir_graph *irg, mtp_additional_property flag) {
480   unsigned prop = irg->additional_properties;
481
482   if (prop & mtp_property_inherited)
483     prop = get_method_additional_properties(get_entity_type(irg->ent));
484   irg->additional_properties = prop | flag;
485 }
486
487 static INLINE void
488 _set_irg_link(ir_graph *irg, void *thing) {
489   irg->link = thing;
490 }
491
492 static INLINE void *
493 _get_irg_link(const ir_graph *irg) {
494   return irg->link;
495 }
496
497 static INLINE unsigned long
498 _get_irg_visited(const ir_graph *irg) {
499   return irg->visited;
500 }
501
502 static INLINE unsigned long
503 _get_irg_block_visited(const ir_graph *irg) {
504   return irg->block_visited;
505 }
506
507 static INLINE void
508 _set_irg_block_visited(ir_graph *irg, unsigned long visited) {
509   irg->block_visited = visited;
510 }
511
512 static INLINE void
513 _inc_irg_block_visited(ir_graph *irg) {
514   ++irg->block_visited;
515 }
516
517 static INLINE void
518 _dec_irg_block_visited(ir_graph *irg) {
519   --irg->block_visited;
520 }
521
522 static INLINE unsigned
523 _get_irg_estimated_node_cnt(const ir_graph *irg) {
524   return irg->estimated_node_count;
525 }
526
527 /**
528  * Allocates a new idx in the irg for the node and adds the irn to the idx -> irn map.
529  * @param irg The graph.
530  * @param irn The node.
531  * @return    The index allocated for the node.
532  */
533 static INLINE unsigned
534 irg_register_node_idx(ir_graph *irg, ir_node *irn)
535 {
536         unsigned idx = irg->last_node_idx++;
537         if(idx >= (unsigned) ARR_LEN(irg->idx_irn_map))
538                 ARR_RESIZE(ir_node *, irg->idx_irn_map, idx + 1);
539
540         irg->idx_irn_map[idx] = irn;
541         return idx;
542 }
543
544 /**
545  * Kill a node from the irg. BEWARE: this kills
546  * all later created nodes.
547  */
548 static INLINE void
549 irg_kill_node(ir_graph *irg, ir_node *n) {
550         unsigned idx = get_irn_idx(n);
551         if (idx + 1 == irg->last_node_idx)
552                 --irg->last_node_idx;
553         irg->idx_irn_map[idx] = NULL;
554         obstack_free(irg->obst, n);
555 }
556
557 /**
558  * Get the node for an index.
559  * @param irg The graph.
560  * @param idx The index you want the node for.
561  * @return    The node with that index or NULL, if there is no node with that index.
562  * @note      The node you got might be dead.
563  */
564 static INLINE ir_node *
565 get_idx_irn(ir_graph *irg, unsigned idx) {
566         assert(idx < (unsigned) ARR_LEN(irg->idx_irn_map));
567         return irg->idx_irn_map[idx];
568 }
569
570 #define get_interprocedural_view()            _get_interprocedural_view()
571 #define is_ir_graph(thing)                    _is_ir_graph(thing)
572 #define get_irg_start_block(irg)              _get_irg_start_block(irg)
573 #define set_irg_start_block(irg, node)        _set_irg_start_block(irg, node)
574 #define get_irg_start(irg)                    _get_irg_start(irg)
575 #define set_irg_start(irg, node)              _set_irg_start(irg, node)
576 #define get_irg_end_block(irg)                _get_irg_end_block(irg)
577 #define set_irg_end_block(irg, node)          _set_irg_end_block(irg, node)
578 #define get_irg_end(irg)                      _get_irg_end(irg)
579 #define set_irg_end(irg, node)                _set_irg_end(irg, node)
580 #define get_irg_end_reg(irg)                  _get_irg_end_reg(irg)
581 #define get_irg_end_except(irg)               _get_irg_end_except(irg)
582 #define get_irg_frame(irg)                    _get_irg_frame(irg)
583 #define set_irg_frame(irg, node)              _set_irg_frame(irg, node)
584 #define get_irg_globals(irg)                  _get_irg_globals(irg)
585 #define set_irg_globals(irg, node)            _set_irg_globals(irg, node)
586 #define get_irg_initial_mem(irg)              _get_irg_initial_mem(irg)
587 #define set_irg_initial_mem(irg, node)        _set_irg_initial_mem(irg, node)
588 #define get_irg_args(irg)                     _get_irg_args(irg)
589 #define set_irg_args(irg, node)               _set_irg_args(irg, node)
590 #define get_irg_bad(irg)                      _get_irg_bad(irg)
591 #define set_irg_bad(irg, node)                _set_irg_bad(irg, node)
592 #define get_irg_no_mem(irg)                   _get_irg_no_mem(irg)
593 #define set_irg_no_mem(irg, node)             _set_irg_no_mem(irg, node)
594 #define get_irg_current_block(irg)            _get_irg_current_block(irg)
595 #define set_irg_current_block(irg, node)      _set_irg_current_block(irg, node)
596 #define get_irg_entity(irg)                   _get_irg_entity(irg)
597 #define set_irg_entity(irg, ent)              _set_irg_entity(irg, ent)
598 #define get_irg_frame_type(irg)               _get_irg_frame_type(irg)
599 #define set_irg_frame_type(irg, ftp)          _set_irg_frame_type(irg, ftp)
600 #define get_irg_obstack(irg)                  _get_irg_obstack(irg)
601 #define get_irg_phase_state(irg)              _get_irg_phase_state(irg)
602 #define set_irg_phase_state(irg, state)       _set_irg_phase_state(irg, state)
603 #define get_irg_pinned(irg)                   _get_irg_pinned(irg)
604 #define get_irg_outs_state(irg)               _get_irg_outs_state(irg)
605 #define set_irg_outs_inconsistent(irg)        _set_irg_outs_inconsistent(irg)
606 #define get_irg_extblk_state(irg)             _get_irg_extblk_state(irg)
607 #define set_irg_extblk_inconsistent(irg)      _set_irg_extblk_inconsistent(irg)
608 #define get_irg_dom_state(irg)                _get_irg_dom_state(irg)
609 #define get_irg_postdom_state(irg)            _get_irg_postdom_state(irg)
610 #define set_irg_doms_inconsistent(irg)        _set_irg_doms_inconsistent(irg)
611 #define get_irg_loopinfo_state(irg)           _get_irg_loopinfo_state(irg)
612 #define set_irg_loopinfo_state(irg, s)        _set_irg_loopinfo_state(irg, s)
613 #define set_irg_loopinfo_inconsistent(irg)    _set_irg_loopinfo_inconsistent(irg)
614 #define set_irg_pinned(irg, p)                _set_irg_pinned(irg, p)
615 #define get_irg_callee_info_state(irg)        _get_irg_callee_info_state(irg)
616 #define set_irg_callee_info_state(irg, s)     _set_irg_callee_info_state(irg, s)
617 #define get_irg_inline_property(irg)          _get_irg_inline_property(irg)
618 #define set_irg_inline_property(irg, s)       _set_irg_inline_property(irg, s)
619 #define get_irg_additional_properties(irg)    _get_irg_additional_properties(irg)
620 #define set_irg_additional_properties(irg, m) _set_irg_additional_properties(irg, m)
621 #define set_irg_additional_property(irg, f)   _set_irg_additional_property(irg, f)
622 #define set_irg_link(irg, thing)              _set_irg_link(irg, thing)
623 #define get_irg_link(irg)                     _get_irg_link(irg)
624 #define get_irg_visited(irg)                  _get_irg_visited(irg)
625 #define get_irg_block_visited(irg)            _get_irg_block_visited(irg)
626 #define set_irg_block_visited(irg, v)         _set_irg_block_visited(irg, v)
627 #define inc_irg_block_visited(irg)            _inc_irg_block_visited(irg)
628 #define dec_irg_block_visited(irg)            _dec_irg_block_visited(irg)
629 #define get_irg_estimated_node_cnt(irg)       _get_irg_estimated_node_cnt(irg)
630
631 # endif /* _IRGRAPH_T_H_ */