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 /* The representations */
73 # include "firm_common.h"/* common type tags. */
74 # include "irprog.h" /* control flow and data of a program */
75 # include "type.h" /* type representation */
76 # include "entity.h" /* entity representation */
77 # include "tv.h" /* target values */
78 # include "ident.h" /* source code identificators */
80 # include "ircons.h" /* construct ir */
81 # include "ircgcons.h" /* construct interprocedural graph */
83 # include "irflag.h" /* optimization flags */
84 # include "irgopt.h" /* optimize ir */
85 # include "tailrec.h" /* optimize tail-recursion calls */
86 # include "ircgopt.h" /* Optimizations based on interprocedural graph */
88 # include "irouts.h" /* Graph reversal / out edges. */
89 # include "irdom.h" /* Dominator analysis */
90 # include "cgana.h" /* Analysis to construct interprocedural graph */
91 /* including some optimizations */
92 # include "irloop.h" /* loop and backedge analysis */
94 # include "irgmod.h" /* Support to modify ir */
95 # include "irgwalk.h" /* Support to walk ir */
96 # include "typewalk.h" /* Support to walk type information */
97 # include "typegmod.h" /* Support to modify type graph */
98 # include "mangle.h" /* Support for mangling ident names. */
100 # include "firmstat.h" /* statistics */
102 /* @@@ temporarily for jni builder until preprocessor works.
103 Then it should be sufficient to include <file.h> instead
104 of firm.h as not all enums are needed in the implementation
111 * Initialize the firm library.
113 * Initializes the firm library. Allocates default data structures.
114 * Initializes configurable behaviour of the library.
116 * @param func This function is called, whenever a local variable is
117 * used before definition. The function should either insert a default value,
118 * or raise a compiler error.
120 * The parameter func may be NULL. In that case, the original FIRM behavior
123 * @see default_initialize_local_variable_func_t
125 void init_firm (default_initialize_local_variable_func_t *func);
128 * Frees all memory occupied by the firm library.
130 void free_firm (void);
136 # endif /* _FIRM_H_ */