firm.h 3.58 KB
Newer Older
Götz Lindenmaier's avatar
Götz Lindenmaier committed
1
/*
2
 * This file is part of libFirm.
3
 * Copyright (C) 2012 University of Karlsruhe.
Götz Lindenmaier's avatar
Götz Lindenmaier committed
4
 */
Michael Beck's avatar
Michael Beck committed
5
6

/**
7
8
9
 * @file
 * @brief     Central firm header.
 * @author    Martin Trapp, Christian Schaefer, Goetz Lindenmaier
10
11
 * This header includes all other firm headers and can be included conveniently
 * by users of the library.
Matthias Braun's avatar
Matthias Braun committed
12
13
14
 */

/** @mainpage
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 *
 *  FIRM is a full graph based intermediate representation in SSA Form
 *  with a novel concept to model side effects.  It allows fast, aggressive
 *  optimizations.
 *
 *  The internal representation of a program in firm is separated into five
 *  different modules:
 *   - Firm Graphs representing the code of a program. (Subdirectory ir.)
 *     Firm Graphs are assembled out of several data structures:
 *     irprog: represents a program.  Allows access to all types and all
 *       FIRM graphs for procedures and other global things.
 *     irgraph: represents a procedure.  Allows access to the code of the
 *       procedure, the actual FIRM graph.
 *     irnode: A node of a FIRM graph.  Nodes are typed with an opcode and a mode
 *   and represent instructions in a program.
 *     irop: The opcode of FIRM nodes.
 *     irmode: The mode of FIRM nodes.  Most modes correspond to machine known
 *       data types (int, float, pointer).
 *   - Entities representing program known objects. (Subdirectory tr.)
 *     All variables and procedures are entities.
 *   - Types describing the type system for the program. (Subdirectory tr.)
 *   - Target Values representing program known constants. (Subdirectory tv.)
 *   - Identifiers representing any Strings used in the program. (Subdirectory ident.)
 *
 *   Further this library supplies functionality to build and optimize FIRM graphs
 *   and further functionality needed in a compiler.  Finally there is more
Matthias Braun's avatar
Matthias Braun committed
41
42
 *   generic functionality to support implementations using firm.
 *   (Code generation, further optimizations).
43
 */
44
45
46
47

/** @defgroup irana Analyses */

/** @defgroup adt Abstract Data Structures
48
49
50
51
 * This module contains abstract datatypes like lists and hashmaps.
 * They're provided as a convenience, the firm API is fully functionaly without
 * them so you can just as well use a library like glib and libapr or write
 * your own.
52
53
54
 */

/** @defgroup algorithms Algorithms
55
56
57
58
59
 * This module contains generic algorithms like bipartite matching or solvers
 * for linear equation systems.
 * They're provided as a convenience, the firm API is fully functionaly without
 * them so you can just as well use a library like glib and libapr or write
 * your own.
60
 */
61
62
63
64
65

/** @defgroup printing Printing and Visualisation
 * This module contains functions for printing and visualizing libfirm
 * datastructures like programs, graphs and nodes for humans.
 */
66
67
#ifndef FIRM_COMMON_FIRM_H
#define FIRM_COMMON_FIRM_H
Christian Schäfer's avatar
Christian Schäfer committed
68

69
70
71
72
73
74
75
76
77
#include "analyze_irg_args.h"
#include "be.h"
#include "callgraph.h"
#include "cdep.h"
#include "cgana.h"
#include "dbginfo.h"
#include "execfreq.h"
#include "firm_common.h"
#include "firm_types.h"
78
#include "heights.h"
79
80
81
82
83
84
#include "ident.h"
#include "irarch.h"
#include "ircgopt.h"
#include "irconsconfirm.h"
#include "ircons.h"
#include "irdom.h"
85
#include "vrp.h"
86
#include "irdump.h"
87
88
89
90
91
92
93
#include "iredgekinds.h"
#include "iredges.h"
#include "irflag.h"
#include "irgmod.h"
#include "irgopt.h"
#include "irgraph.h"
#include "irgwalk.h"
94
#include "irio.h"
95
96
97
98
99
100
101
102
#include "irloop.h"
#include "irmemory.h"
#include "irmode.h"
#include "irnode.h"
#include "irop.h"
#include "iropt.h"
#include "iroptimize.h"
#include "irouts.h"
Sebastian Hack's avatar
Sebastian Hack committed
103
#include "irprintf.h"
104
#include "irprog.h"
105
#include "irverify.h"
106
107
108
109
#include "lowering.h"
#include "timing.h"
#include "tv.h"
#include "typerep.h"
110

111
#endif