Cosmetic
[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
31 #include "callgraph.h"
32
33 #include "array.h"
34
35 /** ir_prog */
36 struct ir_prog {
37   firm_kind kind;
38   ident     *name;                /**< A file name or the like. */
39   ir_graph  *main_irg;            /**< entry point to the compiled program
40                                        @@@ or a list, in case we compile a library or the like? */
41   ir_graph **graphs;              /**< all graphs in the ir */
42   ir_graph **pseudo_graphs;       /**< all pseudo graphs in the ir. See pseudo_irg.c */
43   ir_graph  *const_code_irg;      /**< This ir graph gives the proper environment
44                                        to allocate nodes the represent values
45                                        of constant entities. It is not meant as
46                                        a procedure.  */
47   type      *glob_type;           /**< global type.  Must be a class as it can
48                                        have fields and procedures.  */
49   type     **types;               /**< all types in the ir */
50
51   /* -- states of and access to generated information -- */
52
53   ip_view_state ip_view;          /**< State of interprocedural view. */
54
55   irg_outs_state outs_state;      /**< Out edges. */
56   ir_node **ip_outedges;          /**< Huge Array that contains all out edges
57                                        in interprocedural view. */
58
59   irg_callee_info_state callee_info_state; /**< Validity of callee information.
60                                             Contains the lowest value or all irgs.  */
61
62
63   irp_callgraph_state callgraph_state; /**< State of the callgraph. */
64   struct ir_loop *outermost_cg_loop;   /**< For callgraph analysis: entry point
65                                             to looptree over callgraph. */
66   int max_callgraph_loop_depth;        /**< needed in callgraph. */
67   int max_callgraph_recursion_depth;   /**< needed in callgraph. */
68   int max_method_execution_frequency;  /**< needed in callgraph. */
69
70 #ifdef DEBUG_libfirm
71   long max_node_nr;                /**< to generate unique numbers for nodes. */
72 #endif
73 };
74
75 void remove_irp_type_from_list (type *typ);
76
77 static INLINE type *
78 __get_glob_type(void) {
79   assert(irp);
80   return irp->glob_type = skip_tid(irp->glob_type);
81 }
82
83 static INLINE int
84 __get_irp_n_irgs(void) {
85   assert (irp && irp->graphs);
86   if (get_visit_pseudo_irgs()) return get_irp_n_allirgs();
87   return (ARR_LEN((irp)->graphs));
88 }
89
90 static INLINE ir_graph *
91 __get_irp_irg(int pos){
92   if (get_visit_pseudo_irgs()) return get_irp_allirg(pos);
93   assert(0 <= pos && pos <= get_irp_n_irgs());
94   return irp->graphs[pos];
95 }
96
97
98 static INLINE int
99 __get_irp_n_types (void) {
100   assert (irp && irp->types);
101   return (ARR_LEN((irp)->types));
102 }
103
104 static INLINE type *
105 __get_irp_type(int pos) {
106   assert (irp && irp->types);
107   /* Don't set the skip_tid result so that no double entries are generated. */
108   return skip_tid(irp->types[pos]);
109 }
110
111 #ifdef DEBUG_libfirm
112 /** Returns a new, unique number to number nodes or the like. */
113 int get_irp_new_node_nr(void);
114 #endif
115
116 static INLINE ir_graph *
117 __get_const_code_irg(void)
118 {
119   return irp->const_code_irg;
120 }
121
122 void           set_irp_ip_outedges(ir_node ** ip_outedges);
123 ir_node**      get_irp_ip_outedges(void);
124
125 /** initializes ir_prog. Calls the constructor for an ir_prog. */
126 void init_irprog(void);
127
128 #define get_irp_n_irgs()       __get_irp_n_irgs()
129 #define get_irp_irg(pos)       __get_irp_irg(pos)
130 #define get_irp_n_types()      __get_irp_n_types()
131 #define get_irp_type(pos)      __get_irp_type(pos)
132 #define get_const_code_irg()   __get_const_code_irg()
133 #define get_glob_type()        __get_glob_type()
134
135 #endif /* ifndef _IRPROG_T_H_ */