Changed comments,
[libfirm] / ir / ir / irprog_t.h
1 /*
2  * Project:     libFIRM
3  * File name:   ir/ir/irprog_t.h
4  * Purpose:     Entry point to the representation of a whole program 0-- private header.
5  * Author:      Goetz Lindenmaier
6  * Modified by:
7  * Created:     2000
8  * CVS-ID:      $Id$
9  * Copyright:   (c) 2000-2003 Universität Karlsruhe
10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
11  */
12
13 /**
14  * @file irprog_t.h
15  */
16
17 #ifndef _IRPROG_T_H_
18 #define _IRPROG_T_H_
19
20 #ifdef HAVE_CONFIG_H
21 #include "firm_config.h"
22 #endif
23
24 #include "irprog.h"
25 #include "irgraph.h"
26 #include "pseudo_irg.h"
27 #include "ircgcons.h"
28 #include "firm_common_t.h"
29 #include "typegmod.h"
30 #include "irtypeinfo.h"
31 #include "tr_inheritance.h"
32
33 #include "callgraph.h"
34 #include "field_temperature.h"
35 #include "execution_frequency.h"
36
37 #include "array.h"
38
39 /** ir_prog */
40 struct ir_prog {
41   firm_kind kind;
42   ident     *name;                /**< A file name or the like. */
43   ir_graph  *main_irg;            /**< entry point to the compiled program
44                                        @@@ or a list, in case we compile a library or the like? */
45   ir_graph **graphs;              /**< all graphs in the ir */
46   ir_graph **pseudo_graphs;       /**< all pseudo graphs in the ir. See pseudo_irg.c */
47   ir_graph  *const_code_irg;      /**< This ir graph gives the proper environment
48                                        to allocate nodes the represent values
49                                        of constant entities. It is not meant as
50                                        a procedure.  */
51   type      *glob_type;           /**< global type.  Must be a class as it can
52                                        have fields and procedures.  */
53   type     **types;               /**< all types in the ir */
54
55   /* -- states of and access to generated information -- */
56   irg_phase_state phase_state;    /**< State of construction. */
57
58   ip_view_state ip_view;          /**< State of interprocedural view. */
59
60   irg_outs_state outs_state;      /**< State of out edges of ir nodes. */
61   ir_node **ip_outedges;          /**< Huge Array that contains all out edges
62                                        in interprocedural view. */
63   irg_outs_state trouts_state;    /**< State of out edges of type information. */
64
65   irg_callee_info_state callee_info_state; /**< Validity of callee information.
66                                               Contains the lowest value or all irgs.  */
67   ir_typeinfo_state typeinfo_state;    /**< Validity of type information. */
68   inh_transitive_closure_state inh_trans_closure_state;  /**< trans closure of inh relations. */
69
70   irp_callgraph_state callgraph_state; /**< State of the callgraph. */
71   struct ir_loop *outermost_cg_loop;   /**< For callgraph analysis: entry point
72                                             to looptree over callgraph. */
73   int max_callgraph_loop_depth;        /**< needed in callgraph. */
74   int max_callgraph_recursion_depth;   /**< needed in callgraph. */
75   int max_method_execution_frequency;  /**< needed in callgraph. */
76   irp_temperature_state temperature_state; /**< accumulated temperatures computed? */
77   exec_freq_state execfreq_state;        /**< State of execution freqency information */
78   loop_nesting_depth_state lnd_state;  /**< State of loop nesting depth information. */
79 #ifdef DEBUG_libfirm
80   long max_node_nr;                /**< to generate unique numbers for nodes. */
81 #endif
82 };
83
84 void remove_irp_type_from_list (type *typ);
85
86 static INLINE type *
87 __get_glob_type(void) {
88   assert(irp);
89   return irp->glob_type = skip_tid(irp->glob_type);
90 }
91
92 static INLINE int
93 __get_irp_n_irgs(void) {
94   assert (irp && irp->graphs);
95   if (get_visit_pseudo_irgs()) return get_irp_n_allirgs();
96   return (ARR_LEN((irp)->graphs));
97 }
98
99 static INLINE ir_graph *
100 __get_irp_irg(int pos){
101   if (get_visit_pseudo_irgs()) return get_irp_allirg(pos);
102   assert(0 <= pos && pos <= get_irp_n_irgs());
103   return irp->graphs[pos];
104 }
105
106
107 static INLINE int
108 __get_irp_n_types (void) {
109   assert (irp && irp->types);
110   return (ARR_LEN((irp)->types));
111 }
112
113 static INLINE type *
114 __get_irp_type(int pos) {
115   assert (irp && irp->types);
116   /* Don't set the skip_tid result so that no double entries are generated. */
117   return skip_tid(irp->types[pos]);
118 }
119
120 #ifdef DEBUG_libfirm
121 /** Returns a new, unique number to number nodes or the like. */
122 int get_irp_new_node_nr(void);
123 #endif
124
125 static INLINE ir_graph *
126 __get_const_code_irg(void)
127 {
128   return irp->const_code_irg;
129 }
130
131 void           set_irp_ip_outedges(ir_node ** ip_outedges);
132 ir_node**      get_irp_ip_outedges(void);
133
134 /** initializes ir_prog. Calls the constructor for an ir_prog. */
135 void init_irprog(void);
136
137 #define get_irp_n_irgs()       __get_irp_n_irgs()
138 #define get_irp_irg(pos)       __get_irp_irg(pos)
139 #define get_irp_n_types()      __get_irp_n_types()
140 #define get_irp_type(pos)      __get_irp_type(pos)
141 #define get_const_code_irg()   __get_const_code_irg()
142 #define get_glob_type()        __get_glob_type()
143
144 #endif /* ifndef _IRPROG_T_H_ */