2 * Copyright (C) 1995-2007 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
6 * This file may be distributed and/or modified under the terms of the
7 * GNU General Public License version 2 as published by the Free Software
8 * Foundation and appearing in the file LICENSE.GPL included in the
9 * packaging of this file.
11 * Licensees holding valid libFirm Professional Edition licenses may use
12 * this file in accordance with the libFirm Commercial License.
13 * Agreement provided with the Software.
15 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * @brief Central firm header.
23 * @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier
26 * Central FIRM header.
28 * FIRM is a full graph based intermediate representation in SSA Form
29 * with a novel concept to model side effects. It allows fast, aggressive
32 * This header is the central header of the library implementation of this
35 * The internal representation of a program in firm is separated into five
37 * - Firm Graphs representing the code of a program. (Subdirectory ir.)
38 * Firm Graphs are assembled out of several data structures:
39 * irprog: represents a program. Allows access to all types and all
40 * FIRM graphs for procedures and other global things.
41 * irgraph: represents a procedure. Allows access to the code of the
42 * procedure, the actual FIRM graph.
43 * irnode: A node of a FIRM graph. Nodes are typed with an opcode and a mode
44 * and represent instructions in a program.
45 * irop: The opcode of FIRM nodes.
46 * irmode: The mode of FIRM nodes. Most modes correspond to machine known
47 * data types (int, float, pointer).
48 * - Entities representing program known objects. (Subdirectory tr.)
49 * All variables and procedures are entities.
50 * - Types describing the type system for the program. (Subdirectory tr.)
51 * - Target Values representing program known constants. (Subdirectory tv.)
52 * - Identifiers representing any Strings used in the program. (Subdirectory ident.)
54 * Further this library supplies functionality to build and optimize FIRM graphs
55 * and further functionality needed in a compiler. Finally there is more
56 * generic functionality to support implementations using firm. (Code generation,
57 * further optimizations).
59 #ifndef FIRM_COMMON_FIRM_H
60 #define FIRM_COMMON_FIRM_H
66 /* The representations */
67 #include "firm_common.h" /* common type tags. */
68 #include "irprog.h" /* control flow and data of a program */
69 #include "irgraph.h" /* graphs */
70 #include "typerep.h" /* type representation */
71 #include "tv.h" /* target values */
72 #include "ident.h" /* source code identificators */
75 #include "ircons.h" /* construct ir */
76 #include "ircgcons.h" /* construct interprocedural graph */
79 #include "irflag.h" /* optimization flags */
80 #include "irgopt.h" /* optimize ir */
81 #include "iroptimize.h" /* optimize ir by reassociation */
82 #include "ircgopt.h" /* Optimizations based on interprocedural graph */
85 #include "lowering.h" /* lowering of different calls parameters, intrinsic calls, double word types, high-level constructs */
88 #include "irouts.h" /* Graph reversal / out edges. */
89 #include "trouts.h" /* Graph reversal / out edges for types. */
90 #include "irdom.h" /* Dominator analysis */
91 #include "cgana.h" /* Analysis to construct interprocedural graph */
92 /* including some optimizations */
93 #include "irloop.h" /* loop and backedge analysis */
94 #include "callgraph.h" /* Callgraph construction */
95 #include "irconsconfirm.h" /* Confirm nodes */
96 #include "analyze_irg_args.h" /* Simple pointer parameter analysis */
97 #include "irtypeinfo.h" /* type information for nodes */
98 #include "irmemory.h" /* memory disambiguation */
99 #include "interval_analysis.h"
100 #include "field_temperature.h"
101 #include "execution_frequency.h"
104 #include "irgmod.h" /* Support to modify ir */
105 #include "irgwalk.h" /* Support to walk ir */
107 #include "irarch.h" /* architecture dependent optimizations */
108 #include "archop.h" /* architecture dependent opcodes */
110 #include "firmstat.h" /* statistics */
112 #include "dbginfo.h" /* debug support */
113 #include "seqnumbers.h" /* debug support */
114 #include "firm_ycomp.h" /* ycomp debugging support */
117 /* @@@ temporarily for jni builder until preprocessor works.
118 Then it should be sufficient to include <file.h> instead
119 of firm.h as not all enums are needed in the implementation
122 #include "irprintf.h"
129 /* Macros that define the old function names we decided to rename.
130 Use for compatibility with old implementations. */
131 /*#include "old_fctnames.h"*/
134 * libFirm initialization parameters.
136 struct _firm_parameter_t {
138 * The size of this structure. init_firm() will only initialize
139 * this amount of data. This allows to add more fields to this structure
140 * without breaking compatibility to older source.
145 * Statistic options. If statistic function where enabled, these
146 * flags configure it, see enum firmstat_options_t.
148 unsigned enable_statistics;
151 * This function is called, whenever a local variable is
152 * used before definition. The function should insert a default value,
153 * and/or raise a compiler error/warning. Note that returning
154 * an Unknown is allowed here.
156 uninitialized_local_variable_func_t *initialize_local_func;
159 * The interface functions for the type identification module.
160 * If not set, the default implementation with compare_strict() and
161 * firm_hash_name() will be used.
163 type_identify_if_t *ti_if;
166 * The interface for the ident module.
167 * If not set, the default libFirm ident module (using hash sets).
172 * The architecture dependent opcode settings.
173 * If not set, no architecture dependent operations will be used.
175 const arch_ops_info *arch_op_settings;
178 * The default calling convention.
183 * The debug info that should be used for "builtin" objects.
185 dbg_info *builtin_dbg;
188 typedef struct _firm_parameter_t firm_parameter_t;
190 /* Set a version number if it has not been set in environment */
191 #ifndef libfirm_VERSION_MAJOR
192 #define libfirm_VERSION_MAJOR 1
195 #ifndef libfirm_VERSION_MINOR
196 #define libfirm_VERSION_MINOR 4
200 * The Firm version number.
202 typedef struct _firm_version_t {
205 const char *revision;
210 * Initialize the firm library.
212 * Initializes the firm library. Allocates default data structures.
213 * Initializes configurable behavior of the library.
215 * @param params A structure containing the parameters of the libFirm.
217 * The parameter struct may be NULL. In that case, the original FIRM behavior
220 void init_firm(const firm_parameter_t *params);
223 * Frees all memory occupied by the firm library.
225 void free_firm(void);
228 * Returns the libFirm version number.
229 * If statically linked, always libFirm_VERSION_MAJOR, libFirm_VERSION_MINOR
231 void firm_get_version(firm_version_t *version);
235 * Read initializations arguments from the .init file.
237 void firm_init_options(const char *arg_prefix, int argc, const char **argv);