disabled show after showgraph, as it is (or was?) buggy
[libfirm] / ir / common / firm.h
1 /*
2  * Project:     libFIRM
3  * File name:   ir/common/firm.h
4  * Purpose:     Central firm 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 firm.h
15  *
16  *  Central FIRM header.
17  *
18  *  FIRM is a full graph based intermediate representation in SSA Form
19  *  with a novel concept to model side effects.  It allows fast, aggressive
20  *  optimizations.
21  *
22  *  This header is the central header of the library implementation of this
23  *  IR.
24  *
25  *  The internal representation of a program in firm is separated into five
26  *  different modules:
27  *   - Firm Graphs representing the code of a program. (Subdirectory ir.)
28  *     Firm Graphs are assembled out of several data structures:
29  *     irprog: represents a program.  Allows access to all types and all
30  *       FIRM graphs for procedures and other global things.
31  *     irgraph: represents a procedure.  Allows access to the code of the
32  *       procedure, the actual FIRM graph.
33  *     irnode: A node of a FIRM graph.  Nodes are typed with an opcode and a mode
34  *   and represent instructions in a program.
35  *     irop: The opcode of FIRM nodes.
36  *     irmode: The mode of FIRM nodes.  Most modes correspond to machine known
37  *       data types (int, float, pointer).
38  *   - Entities representing program known objects. (Subdirectory tr.)
39  *     All variables and procedures are entities.
40  *   - Types describing the type system for the program. (Subdirectory tr.)
41  *   - Target Values representing program known constants. (Subdirectory tv.)
42  *   - Identifiers representing any Strings used in the program. (Subdirectory ident.)
43  *
44  *   Further this library supplies functionality to build and optimize FIRM graphs
45  *   and further functionality needed in a compiler.  Finally there is more
46  *   generic functionality to support implementations using firm.  (Code generation,
47  *   further optimizations).
48  */
49 #ifndef _FIRM_H_
50 #define _FIRM_H_
51
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55
56 /* The representations */
57 #include "firm_common.h"   /* common type tags. */
58 #include "irprog.h"        /* control flow and data of a program */
59 #include "irgraph.h"       /* graphs */
60 #include "type.h"          /* type representation */
61 #include "entity.h"        /* entity representation */
62 #include "tv.h"            /* target values */
63 #include "ident.h"         /* source code identificators */
64
65 /* Functionality */
66 #include "ircons.h"        /* construct ir */
67 #include "ircgcons.h"      /* construct interprocedural graph */
68
69 /* Optimizations */
70 #include "irflag.h"         /* optimization flags */
71 #include "irgopt.h"         /* optimize ir */
72 #include "reassoc.h"        /* optimize ir by reassociation */
73 #include "ldstopt.h"        /* optimize Load/Store */
74 #include "cfopt.h"          /* optimize control flow */
75 #include "tailrec.h"        /* optimize tail-recursion calls */
76 #include "ircgopt.h"        /* Optimizations based on interprocedural graph */
77 #include "opt_osr.h"        /* Operator Strength Reduction */
78 #include "strength_red.h"   /* Old (and buggy) Strength reduction */
79 #include "loop_unrolling.h" /* Do loop unrolling */
80 #include "ifconv.h"         /* if conversion */
81 #include "funccall.h"       /* real function call optimization */
82 #include "return.h"         /* Return node normalizations */
83 #include "scalar_replace.h" /* Scalar replacement */
84 #include "proc_cloning.h"   /* procedure cloning */
85 #include "opt_confirms.h"   /* Confirm based optimizations */
86 #include "gvn_pre.h"        /* global value numbering and partial redundancy elimination */
87 #include "opt_frame.h"      /* frame type optimization */
88 #include "tropt.h"          /* optimize the type representation */
89 #include "condeval.h"       /* control flow optimization by conditional evaluation */
90
91 /* Lowering */
92 #include "lower_calls.h"      /* lowering of different calls */
93 #include "lower_intrinsics.h" /* lowering of intrinsic calls */
94 #include "lower_dw.h"         /* double word types lowering */
95
96 /* Analyses */
97 #include "irouts.h"           /* Graph reversal / out edges. */
98 #include "trouts.h"           /* Graph reversal / out edges for types. */
99 #include "irdom.h"            /* Dominator analysis */
100 #include "cgana.h"            /* Analysis to construct interprocedural graph */
101                               /* including some optimizations */
102 #include "irloop.h"           /* loop and backedge analysis */
103 #include "callgraph.h"        /* Callgraph construction */
104 #include "irconsconfirm.h"    /* Confirm nodes */
105 #include "analyze_irg_args.h" /* Simple pointer parameter analysis */
106 #include "irtypeinfo.h"       /* type information for nodes */
107 #include "irmemory.h"         /* memory disambiguation */
108 #include "interval_analysis.h"
109 #include "field_temperature.h"
110 #include "execution_frequency.h"
111
112 /* Support */
113 #include "irgmod.h"         /* Support to modify ir */
114 #include "irgwalk.h"        /* Support to walk ir */
115 #include "typewalk.h"       /* Support to walk type information */
116 #include "typegmod.h"       /* Support to modify type graph */
117 #include "type_identify.h"  /* Support for type identification */
118 #include "mangle.h"         /* Support for mangling ident names. */
119 #include "tr_inheritance.h" /* Support to handle inheritance. */
120
121 #include "irarch.h"        /* architecture dependent optimizations */
122 #include "archop.h"        /* architecture dependent opcodes */
123 //#include "modeconv.h"      /* architecture dependent mode conversion */
124
125 #include "firmstat.h"      /* statistics */
126
127 #include "irreflect.h"     /* reflection */
128
129 #include "seqnumbers.h"    /* debug support */
130 #include "firm_ycomp.h"    /* ycomp debugging support */
131
132
133 /* @@@ temporarily for jni builder until preprocessor works.
134    Then it should be sufficient to include <file.h> instead
135    of firm.h as not all enums are needed in the implementation
136    files. */
137 #include "irdump.h"
138 #include "irprintf.h"
139 #include "irvrfy.h"
140 #include "trvrfy.h"
141
142 #include "irarch.h"
143
144 #include "iredges.h"
145
146 /* Macros that define the old function names we decided to rename.
147    Use for compatibility with old implementations. */
148 /*#include "old_fctnames.h"*/
149
150 /**
151  * libFirm initialization parameters.
152  */
153 struct _firm_parameter_t {
154   /**
155    * The size of this structure. init_firm() will only initialize
156    * this amount of data. This allows to add more fields to this structure
157    * without breaking compatibility to older source.
158    */
159   unsigned int size;
160
161   /**
162    * Statistic options. If statistic function where enabled, these
163    * flags configure it, see enum firmstat_options_t.
164    */
165   unsigned enable_statistics;
166
167   /**
168    * This function is called, whenever a local variable is
169    * used before definition. The function should insert a default value,
170    * and/or raise a compiler error/warning. Note that returning
171    * an Unknown is allowed here.
172    */
173   uninitialized_local_variable_func_t *initialize_local_func;
174
175   /**
176    * The interface functions for the type identification module.
177    * If not set, the default implementation with compare_strict() and
178    * firm_hash_name() will be used.
179    */
180   type_identify_if_t *ti_if;
181
182   /**
183    * The interface for the ident module.
184    * If not set, the default libFirm ident module (using hash sets).
185    */
186   ident_if_t *id_if;
187
188   /**
189    * The architecture dependent opcode settings.
190    * If not set, no architecture dependent operations will be used.
191    */
192   const arch_ops_info *arch_op_settings;
193
194   /**
195    * The default calling convention.
196    */
197   unsigned cc_mask;
198
199   /**
200    * The debug info that should be used for "builtin" objects.
201    */
202   dbg_info *builtin_dbg;
203 };
204
205 typedef struct _firm_parameter_t firm_parameter_t;
206
207 #define libFirm_VERSION_MAJOR 1
208 #define libFirm_VERSION_MINOR 4
209
210 /**
211  * The Firm version number.
212  */
213 typedef struct _firm_version_t {
214   unsigned major;
215   unsigned minor;
216 } firm_version_t;
217
218 /**
219  * Initialize the firm library.
220  *
221  * Initializes the firm library.  Allocates default data structures.
222  * Initializes configurable behavior of the library.
223  *
224  * @param params   A structure containing the parameters of the libFirm.
225  *
226  * The parameter struct may be NULL. In that case, the original FIRM behavior
227  * is conserved.
228  */
229 void init_firm(const firm_parameter_t *params);
230
231 /**
232  * Frees all memory occupied by the firm library.
233  */
234 void free_firm(void);
235
236 /**
237  * Returns the libFirm version number.
238  * If statically linked, always libFirm_VERSION_MAJOR, libFirm_VERSION_MINOR
239  */
240 void firm_get_version(firm_version_t *version);
241
242 #ifdef WITH_LIBCORE
243 /**
244  * Read initializations arguments from the .init file.
245  */
246 void firm_init_options(const char *arg_prefix, int argc, const char **argv);
247 #endif
248
249 #ifdef __cplusplus
250 }
251 #endif
252
253 #endif /* _FIRM_H_ */