2 * Copyright (C) 1995-2008 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 #include "analyze_irg_args.h"
68 #include "callgraph.h"
73 #include "execution_frequency.h"
74 #include "field_temperature.h"
75 #include "firm_common.h"
77 #include "firm_types.h"
80 #include "interval_analysis.h"
84 #include "irconsconfirm.h"
88 #include "iredgekinds.h"
104 #include "iroptimize.h"
107 #include "irprintf.h"
109 #include "irsimpletype.h"
110 #include "irtypeinfo.h"
112 #include "lowering.h"
113 #include "pseudo_irg.h"
115 #include "seqnumbers.h"
116 #include "structure.h"