3 * File name: ir/common/firm.h
4 * Purpose: Central firm header.
5 * Author: Martin Trapp, Christian Schaefer
6 * Modified by: Goetz Lindenmaier
9 * Copyright: (c) 1998-2003 Universität Karlsruhe
10 * Licence: This file protected by GPL - GNU GENERAL PUBLIC LICENSE.
16 This documentation no more maintained since 2001!!!
20 FIRM is a full graph based intermediate representation in SSA Form
21 with a novel concept to model side effects. It allows fast, aggressive
24 This header is the central header of the library implementation of this
27 The internal representation of a program in firm is separated into five
29 - Firm Graphs representing the code of a program. (Subdirectory ir.)
30 Firm Graphs are assembled out of several data structures:
31 irprog: represents a program. Allows access to all types and all
32 FIRM graphs for procedures and other global things.
33 irgraph: represents a procedure. Allows access to the code of the
34 procedure, the actual FIRM graph.
35 irnode: A node of a FIRM graph. Nodes are typed with an opcode and a mode
36 and represent instructions in a program.
37 irop: The opcode of FIRM nodes.
38 irmode: The mode of FIRM nodes. Most modes correspond to machine known
39 data types (int, float, pointer).
40 - Entities representing program known objects. (Subdirectory tr.)
41 All variables and procedures are entities.
42 - Types describing the type system for the program. (Subdirectory tr.)
43 - Target Values representing program known constants. (Subdirectory tv.)
44 - Identifiers representing any Strings used in the program. (Subdirectory ident.)
46 Further this library supplies functionality to build and optimize FIRM graphs
47 and further functionality needed in a compiler. Finally there is more
48 generic functionality to support implementations using firm. (Code generation,
49 further optimizations).
51 ircons: Interface to construct firm graphs, implements automatic Phi node
53 iropt: Optimizations applied to individual nodes.
54 irgopt: Optimizations for ir graphs.
56 irflag: Flags to direct the functionality.
57 common: dynamic typ check for all nodes, configuration of the library,
60 irgwalk: walker for ir graphs.
61 irvrfy: verify the correctness of a firm node.
72 #include "old_fctnames.h"
74 /* The representations */
75 #include "firm_common.h" /* common type tags. */
76 #include "irprog.h" /* control flow and data of a program */
77 #include "type.h" /* type representation */
78 #include "entity.h" /* entity representation */
79 #include "tv.h" /* target values */
80 #include "ident.h" /* source code identificators */
82 #include "ircons.h" /* construct ir */
83 #include "ircgcons.h" /* construct interprocedural graph */
85 #include "irflag.h" /* optimization flags */
86 #include "irgopt.h" /* optimize ir */
87 #include "tailrec.h" /* optimize tail-recursion calls */
88 #include "ircgopt.h" /* Optimizations based on interprocedural graph */
90 #include "irouts.h" /* Graph reversal / out edges. */
91 #include "irdom.h" /* Dominator analysis */
92 #include "cgana.h" /* Analysis to construct interprocedural graph */
93 /* including some optimizations */
94 #include "irloop.h" /* loop and backedge analysis */
96 #include "irgmod.h" /* Support to modify ir */
97 #include "irgwalk.h" /* Support to walk ir */
98 #include "typewalk.h" /* Support to walk type information */
99 #include "typegmod.h" /* Support to modify type graph */
100 #include "type_identify.h" /* Support for type identification */
101 #include "mangle.h" /* Support for mangling ident names. */
103 #include "firmstat.h" /* statistics */
105 /* @@@ temporarily for jni builder until preprocessor works.
106 Then it should be sufficient to include <file.h> instead
107 of firm.h as not all enums are needed in the implementation
114 * libFirm initialization parameters.
116 struct _firm_parameter_t {
118 * The size of this structure. init_firm() will only initialize
119 * this amount of data. This allows to add more fields to this structure
120 * without breaking compatibility to older source.
125 * Statistic options. If statistic function where enabled, these
126 * flags configure it, see enum firmstat_options_t.
128 unsigned enable_statistics;
131 * This function is called, whenever a local variable is
132 * used before definition. The function should either insert a default value,
133 * or raise a compiler error/warning.
135 default_initialize_local_variable_func_t *initialize_local_func;
138 * The compare function is used to identify equal types. If not set
139 * it is initialized with the function compare_strict().
141 compare_types_func_t *compare_types_func;
143 * The hash function is used to identify equal types. It calculates a hash
144 * value of a type. Note, that the hash value for equal types must be identical.
145 * If not set it is initialized with the function hash_name().
147 hash_types_func_t *hash_types_func;
152 typedef struct _firm_parameter_t firm_parameter_t;
157 * Initialize the firm library.
159 * Initializes the firm library. Allocates default data structures.
160 * Initializes configurable behaviour of the library.
162 * @param param This function is called, whenever a local variable is
163 * used before definition. The function should either insert a default value,
164 * or raise a compiler error.
166 * The parameter func may be NULL. In that case, the original FIRM behavior
169 * @see default_initialize_local_variable_func_t
171 void init_firm(const firm_parameter_t *params);
174 * Frees all memory occupied by the firm library.
176 void free_firm(void);
182 #endif /* _FIRM_H_ */