2 * Copyright (C) 1995-2010 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
24 * This header includes all other firm headers and can be included conveniently
25 * by users of the library.
30 * FIRM is a full graph based intermediate representation in SSA Form
31 * with a novel concept to model side effects. It allows fast, aggressive
34 * The internal representation of a program in firm is separated into five
36 * - Firm Graphs representing the code of a program. (Subdirectory ir.)
37 * Firm Graphs are assembled out of several data structures:
38 * irprog: represents a program. Allows access to all types and all
39 * FIRM graphs for procedures and other global things.
40 * irgraph: represents a procedure. Allows access to the code of the
41 * procedure, the actual FIRM graph.
42 * irnode: A node of a FIRM graph. Nodes are typed with an opcode and a mode
43 * and represent instructions in a program.
44 * irop: The opcode of FIRM nodes.
45 * irmode: The mode of FIRM nodes. Most modes correspond to machine known
46 * data types (int, float, pointer).
47 * - Entities representing program known objects. (Subdirectory tr.)
48 * All variables and procedures are entities.
49 * - Types describing the type system for the program. (Subdirectory tr.)
50 * - Target Values representing program known constants. (Subdirectory tv.)
51 * - Identifiers representing any Strings used in the program. (Subdirectory ident.)
53 * Further this library supplies functionality to build and optimize FIRM graphs
54 * and further functionality needed in a compiler. Finally there is more
55 * generic functionality to support implementations using firm.
56 * (Code generation, further optimizations).
59 /** @defgroup irana Analyses */
61 /** @defgroup adt Abstract Data Structures
62 * This module contains abstract datatypes. The firm API is fully functional
63 * without these abstract datatypes. They're provided as a convenience.
66 /** @defgroup algorithms Algorithms
67 * This module contains generic algorithms. The firm API is fully functional
68 * without them. They're provided as a convenience.
70 #ifndef FIRM_COMMON_FIRM_H
71 #define FIRM_COMMON_FIRM_H
73 #include "analyze_irg_args.h"
75 #include "callgraph.h"
80 #include "firm_common.h"
82 #include "firm_types.h"
87 #include "irconsconfirm.h"
92 #include "iredgekinds.h"
103 #include "irmemory.h"
108 #include "iroptimize.h"
111 #include "irprintf.h"
113 #include "irtypeinfo.h"
114 #include "irverify.h"
115 #include "lowering.h"